Definitions for using the keyboard device. More...

#include <sys/cdefs.h>
#include <arch/types.h>
#include <dc/maple.h>

Data Structures
struct	kbd_keymap
	Keyboard keymap. More...

struct	kbd_cond_t
	Keyboard raw condition structure. More...

struct	kbd_state
	Keyboard status structure. More...

Macros
#define	KBD_MOD_LCTRL (1<<0)

#define	KBD_MOD_LSHIFT (1<<1)

#define	KBD_MOD_LALT (1<<2)

#define	KBD_MOD_S1 (1<<3)

#define	KBD_MOD_RCTRL (1<<4)

#define	KBD_MOD_RSHIFT (1<<5)

#define	KBD_MOD_RALT (1<<6)

#define	KBD_MOD_S2 (1<<7)

#define	KBD_LED_NUMLOCK (1<<0)

#define	KBD_LED_CAPSLOCK (1<<1)

#define	KBD_LED_SCRLOCK (1<<2)

#define	KBD_KEY_NONE 0x00

#define	KBD_KEY_ERROR 0x01

#define	KBD_KEY_A 0x04

#define	KBD_KEY_B 0x05

#define	KBD_KEY_C 0x06

#define	KBD_KEY_D 0x07

#define	KBD_KEY_E 0x08

#define	KBD_KEY_F 0x09

#define	KBD_KEY_G 0x0a

#define	KBD_KEY_H 0x0b

#define	KBD_KEY_I 0x0c

#define	KBD_KEY_J 0x0d

#define	KBD_KEY_K 0x0e

#define	KBD_KEY_L 0x0f

#define	KBD_KEY_M 0x10

#define	KBD_KEY_N 0x11

#define	KBD_KEY_O 0x12

#define	KBD_KEY_P 0x13

#define	KBD_KEY_Q 0x14

#define	KBD_KEY_R 0x15

#define	KBD_KEY_S 0x16

#define	KBD_KEY_T 0x17

#define	KBD_KEY_U 0x18

#define	KBD_KEY_V 0x19

#define	KBD_KEY_W 0x1a

#define	KBD_KEY_X 0x1b

#define	KBD_KEY_Y 0x1c

#define	KBD_KEY_Z 0x1d

#define	KBD_KEY_1 0x1e

#define	KBD_KEY_2 0x1f

#define	KBD_KEY_3 0x20

#define	KBD_KEY_4 0x21

#define	KBD_KEY_5 0x22

#define	KBD_KEY_6 0x23

#define	KBD_KEY_7 0x24

#define	KBD_KEY_8 0x25

#define	KBD_KEY_9 0x26

#define	KBD_KEY_0 0x27

#define	KBD_KEY_ENTER 0x28

#define	KBD_KEY_ESCAPE 0x29

#define	KBD_KEY_BACKSPACE 0x2a

#define	KBD_KEY_TAB 0x2b

#define	KBD_KEY_SPACE 0x2c

#define	KBD_KEY_MINUS 0x2d

#define	KBD_KEY_PLUS 0x2e

#define	KBD_KEY_LBRACKET 0x2f

#define	KBD_KEY_RBRACKET 0x30

#define	KBD_KEY_BACKSLASH 0x31

#define	KBD_KEY_SEMICOLON 0x33

#define	KBD_KEY_QUOTE 0x34

#define	KBD_KEY_TILDE 0x35

#define	KBD_KEY_COMMA 0x36

#define	KBD_KEY_PERIOD 0x37

#define	KBD_KEY_SLASH 0x38

#define	KBD_KEY_CAPSLOCK 0x39

#define	KBD_KEY_F1 0x3a

#define	KBD_KEY_F2 0x3b

#define	KBD_KEY_F3 0x3c

#define	KBD_KEY_F4 0x3d

#define	KBD_KEY_F5 0x3e

#define	KBD_KEY_F6 0x3f

#define	KBD_KEY_F7 0x40

#define	KBD_KEY_F8 0x41

#define	KBD_KEY_F9 0x42

#define	KBD_KEY_F10 0x43

#define	KBD_KEY_F11 0x44

#define	KBD_KEY_F12 0x45

#define	KBD_KEY_PRINT 0x46

#define	KBD_KEY_SCRLOCK 0x47

#define	KBD_KEY_PAUSE 0x48

#define	KBD_KEY_INSERT 0x49

#define	KBD_KEY_HOME 0x4a

#define	KBD_KEY_PGUP 0x4b

#define	KBD_KEY_DEL 0x4c

#define	KBD_KEY_END 0x4d

#define	KBD_KEY_PGDOWN 0x4e

#define	KBD_KEY_RIGHT 0x4f

#define	KBD_KEY_LEFT 0x50

#define	KBD_KEY_DOWN 0x51

#define	KBD_KEY_UP 0x52

#define	KBD_KEY_PAD_NUMLOCK 0x53

#define	KBD_KEY_PAD_DIVIDE 0x54

#define	KBD_KEY_PAD_MULTIPLY 0x55

#define	KBD_KEY_PAD_MINUS 0x56

#define	KBD_KEY_PAD_PLUS 0x57

#define	KBD_KEY_PAD_ENTER 0x58

#define	KBD_KEY_PAD_1 0x59

#define	KBD_KEY_PAD_2 0x5a

#define	KBD_KEY_PAD_3 0x5b

#define	KBD_KEY_PAD_4 0x5c

#define	KBD_KEY_PAD_5 0x5d

#define	KBD_KEY_PAD_6 0x5e

#define	KBD_KEY_PAD_7 0x5f

#define	KBD_KEY_PAD_8 0x60

#define	KBD_KEY_PAD_9 0x61

#define	KBD_KEY_PAD_0 0x62

#define	KBD_KEY_PAD_PERIOD 0x63

#define	KBD_KEY_S3 0x65

#define	KBD_REGION_JP 1
	Japanese keyboard. More...

#define	KBD_REGION_US 2
	US keyboard. More...

#define	KBD_QUEUE_SIZE 16
	Size of a keyboard queue. More...

Typedefs
typedef struct kbd_keymap	kbd_keymap_t
	Keyboard keymap. More...

typedef struct kbd_state	kbd_state_t
	Keyboard status structure. More...

Functions
void	kbd_set_queue (int active) __attribute__((deprecated))
	Activate or deactivate global key queueing. More...

int	kbd_get_key () __attribute__((deprecated))
	Pop a key off the global keyboard queue. More...

int	kbd_queue_pop (maple_device_t *dev, int xlat)
	Pop a key off a specific keyboard's queue. More...

Detailed Description

Definitions for using the keyboard device.

This file contains the definitions needed to access the Maple keyboard device. Obviously, this corresponds to the MAPLE_FUNC_KEYBOARD function code.

Author: Jordan DeLong; Dan Potter; Lawrence Sebald

Macro Definition Documentation

#define KBD_QUEUE_SIZE 16

Size of a keyboard queue.

Each keyboard queue will hold this many elements. Once the queue fills, no new elements will be placed on the queue. As long as you check the queue relatively frequently, the default of 16 should be plenty.

Note: This MUST be a power of two.

Typedef Documentation

typedef struct kbd_keymap kbd_keymap_t

Keyboard keymap.

This structure represents a mapping from raw key values to ASCII values, if appropriate. This handles base values as well as shifted values.

typedef struct kbd_state kbd_state_t

Keyboard status structure.

This structure holds information about the current status of the keyboard device. This is what maple_dev_status() will return.

Function Documentation

int kbd_get_key ( )

Pop a key off the global keyboard queue.

This function pops the front off of the keyboard queue, and returns the value to the caller. The value returned will be the ASCII value of the key pressed (accounting for the shift keys being pressed).

If a key does not have an ASCII value associated with it, the raw key code will be returned, shifted up by 8 bits.

Returns: The value at the front of the queue, or -1 if there are no keys in the queue or queueing is off.

Note: This function does not account for non-US keyboard layouts properly (for compatibility with old code), and is deprecated. Use the individual keyboard queues instead to properly account for non-US keyboards.

See also: kbd_queue_pop()

int kbd_queue_pop	(	maple_device_t *	dev,
		int	xlat
	)

Pop a key off a specific keyboard's queue.

This function pops the front element off of the specified keyboard queue, and returns the value of that key to the caller.

If the xlat parameter is non-zero and the key represents an ISO-8859-1 character, that is the value that will be returned from this function. Otherwise if xlat is non-zero, it will be the raw key code, shifted up by 8 bits.

If the xlat parameter is zero, the lower 8 bits of the returned value will be the raw key code. The next 8 bits will be the modifier keys that were down when the key was pressed (a bitfield of KBD_MOD_* values). The next 3 bits will be the lock key status (a bitfield of KBD_LED_* values).

Parameters

dev	The keyboard device to read from.
xlat	Set to non-zero to do key translation. Otherwise, you'll simply get the raw key value. Raw key values are not mapped at all, so you are responsible for figuring out what it is by the region.

Returns: The value at the front of the queue, or -1 if there are no keys in the queue.

void kbd_set_queue ( int active )

Activate or deactivate global key queueing.

This function will turn the internal keyboard queueing on or off. Note that there is only one queue for the whole system, no matter how many keyboards are attached, and the queue is of fairly limited length. Turning queueing off is useful (for instance) in a game where individual keypresses don't mean as much as having the keys up or down does.

You can clear the queue (without popping all the keys off) by setting the active value to a different value than it was.

The queue is by default on, unless you turn it off.

Parameters

active Set to non-zero to activate the queue.

Note: The global queue does not account for non-US keyboard layouts and is deprecated. Please use the individual queues instead for future code.

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Function Documentation