kb.h

Go to the documentation of this file.

#pragma once

#include <ppu-types.h>

#ifdef __cplusplus
extern "C" {
#endif

#define MAX_KEYBOARDS   127
#define MAX_KB_PORT_NUM 7
#define MAX_KEYCODES    62

/* Raw Data Code and Keypad Code Data definition */
#define KB_RAWDAT   0x8000U
#define KB_KEYPAD   0x4000U
 
/* Keyboard RAWDAT Key code (can't be converted to ASCII codes) */
#define KB_RAWKEY_NO_EVENT              0x00
#define KB_RAWKEY_E_ROLLOVER            0x01
#define KB_RAWKEY_E_POSTFAIL            0x02
#define KB_RAWKEY_E_UNDEF               0x03
#define KB_RAWKEY_ESCAPE                0x29
#define KB_RAWKEY_106_KANJI             0x35    /* The half-width/full width Kanji key code */
#define KB_RAWKEY_CAPS_LOCK             0x39
#define KB_RAWKEY_F1                    0x3a
#define KB_RAWKEY_F2                    0x3b
#define KB_RAWKEY_F3                    0x3c
#define KB_RAWKEY_F4                    0x3d
#define KB_RAWKEY_F5                    0x3e
#define KB_RAWKEY_F6                    0x3f
#define KB_RAWKEY_F7                    0x40
#define KB_RAWKEY_F8                    0x41
#define KB_RAWKEY_F9                    0x42
#define KB_RAWKEY_F10                   0x43
#define KB_RAWKEY_F11                   0x44
#define KB_RAWKEY_F12                   0x45
#define KB_RAWKEY_PRINTSCREEN           0x46
#define KB_RAWKEY_SCROLL_LOCK           0x47
#define KB_RAWKEY_PAUSE                 0x48
#define KB_RAWKEY_INSERT                0x49
#define KB_RAWKEY_HOME                  0x4a
#define KB_RAWKEY_PAGE_UP               0x4b
#define KB_RAWKEY_DELETE                0x4c
#define KB_RAWKEY_END                   0x4d
#define KB_RAWKEY_PAGE_DOWN             0x4e
#define KB_RAWKEY_RIGHT_ARROW           0x4f
#define KB_RAWKEY_LEFT_ARROW            0x50
#define KB_RAWKEY_DOWN_ARROW            0x51
#define KB_RAWKEY_UP_ARROW              0x52
#define KB_RAWKEY_NUM_LOCK              0x53
#define KB_RAWKEY_APPLICATION           0x65    /* Application key code */
#define KB_RAWKEY_KANA                  0x88    /* Katakana/Hiragana/Romaji key code */
#define KB_RAWKEY_HENKAN                0x8a    /* Conversion key code */
#define KB_RAWKEY_MUHENKAN              0x8b    /* No Conversion key code */

/* Keyboard RAW Key Code definition */
#define KB_RAWKEY_A                     0x04
#define KB_RAWKEY_B                     0x05
#define KB_RAWKEY_C                     0x06
#define KB_RAWKEY_D                     0x07
#define KB_RAWKEY_E                     0x08
#define KB_RAWKEY_F                     0x09
#define KB_RAWKEY_G                     0x0A
#define KB_RAWKEY_H                     0x0B
#define KB_RAWKEY_I                     0x0C
#define KB_RAWKEY_J                     0x0D
#define KB_RAWKEY_K                     0x0E
#define KB_RAWKEY_L                     0x0F
#define KB_RAWKEY_M                     0x10
#define KB_RAWKEY_N                     0x11
#define KB_RAWKEY_O                     0x12
#define KB_RAWKEY_P                     0x13
#define KB_RAWKEY_Q                     0x14
#define KB_RAWKEY_R                     0x15
#define KB_RAWKEY_S                     0x16
#define KB_RAWKEY_T                     0x17
#define KB_RAWKEY_U                     0x18
#define KB_RAWKEY_V                     0x19
#define KB_RAWKEY_W                     0x1A
#define KB_RAWKEY_X                     0x1B
#define KB_RAWKEY_Y                     0x1C
#define KB_RAWKEY_Z                     0x1D
#define KB_RAWKEY_1                     0x1E
#define KB_RAWKEY_2                     0x1F
#define KB_RAWKEY_3                     0x20
#define KB_RAWKEY_4                     0x21
#define KB_RAWKEY_5                     0x22
#define KB_RAWKEY_6                     0x23
#define KB_RAWKEY_7                     0x24
#define KB_RAWKEY_8                     0x25
#define KB_RAWKEY_9                     0x26
#define KB_RAWKEY_0                     0x27
#define KB_RAWKEY_ENTER                 0x28
#define KB_RAWKEY_ESC                   0x29
#define KB_RAWKEY_BS                    0x2A
#define KB_RAWKEY_TAB                   0x2B
#define KB_RAWKEY_SPACE                 0x2C
#define KB_RAWKEY_MINUS                 0x2D
#define KB_RAWKEY_EQUAL_101             0x2E    /* = and + */
#define KB_RAWKEY_ACCENT_CIRCONFLEX_106 0x2E    /* ^ and ~ */
#define KB_RAWKEY_LEFT_BRACKET_101      0x2F    /* [ */
#define KB_RAWKEY_ATMARK_106            0x2F    /* @ */
#define KB_RAWKEY_RIGHT_BRACKET_101     0x30    /* ] */
#define KB_RAWKEY_LEFT_BRACKET_106      0x30    /* [ */
#define KB_RAWKEY_BACKSLASH_101         0x31    /* \ and | */
#define KB_RAWKEY_RIGHT_BRACKET_106     0x32    /* ] */
#define KB_RAWKEY_SEMICOLON             0x33    /* ; */
#define KB_RAWKEY_QUOTATION_101         0x34    /* ' and " */
#define KB_RAWKEY_COLON_106             0x34    /* : and * */
#define KB_RAWKEY_COMMA                 0x36
#define KB_RAWKEY_PERIOD                0x37
#define KB_RAWKEY_SLASH                 0x38
#define KB_RAWKEY_CAPS_LOCK             0x39
#define KB_RAWKEY_KPAD_NUMLOCK          0x53
#define KB_RAWKEY_KPAD_SLASH            0x54
#define KB_RAWKEY_KPAD_ASTERISK         0x55
#define KB_RAWKEY_KPAD_MINUS            0x56
#define KB_RAWKEY_KPAD_PLUS             0x57
#define KB_RAWKEY_KPAD_ENTER            0x58
#define KB_RAWKEY_KPAD_1                0x59
#define KB_RAWKEY_KPAD_2                0x5A
#define KB_RAWKEY_KPAD_3                0x5B
#define KB_RAWKEY_KPAD_4                0x5C
#define KB_RAWKEY_KPAD_5                0x5D
#define KB_RAWKEY_KPAD_6                0x5E
#define KB_RAWKEY_KPAD_7                0x5F
#define KB_RAWKEY_KPAD_8                0x60
#define KB_RAWKEY_KPAD_9                0x61
#define KB_RAWKEY_KPAD_0                0x62
#define KB_RAWKEY_KPAD_PERIOD           0x63
#define KB_RAWKEY_BACKSLASH_106         0x87
#define KB_RAWKEY_YEN_106               0x89

typedef struct KbLed {
    union {
        u32 leds;
        struct {
        u32 reserved    : 27;   
        u32 kana        : 1;    
        u32 compose     : 1;    
        u32 scroll_lock : 1;    
        u32 caps_lock   : 1;    
        u32 num_lock    : 1;    
        }_KbLedS;
    }_KbLedU;
} KbLed;

typedef struct KbMkey {
    union {
        u32 mkeys;
        struct {
        u32 reserved    : 24;   
        u32 r_win       : 1;    
        u32 r_alt       : 1;    
        u32 r_shift     : 1;    
        u32 r_ctrl      : 1;    
        u32 l_win       : 1;    
        u32 l_alt       : 1;    
        u32 l_shift     : 1;    
        u32 l_ctrl      : 1;    
        /* For Macintosh Keyboard ALT & WIN correspond respectively to OPTION & APPLE keys */
        }_KbMkeyS;
    }_KbMkeyU;
} KbMkey;

typedef struct KbData {
    KbLed led;                  
    KbMkey mkey;                
    s32 nb_keycode;             
    u16 keycode[MAX_KEYCODES];  
} KbData;

typedef enum KbRmode {
    KB_RMODE_INPUTCHAR  = 0,    
    KB_RMODE_PACKET     = 1     
} KbRmode;

typedef enum KbCodeType {
    KB_CODETYPE_RAW     = 0,    
    KB_CODETYPE_ASCII   = 1     
} KbCodeType;

typedef enum KbMapping {
    KB_MAPPING_101                      = 0,
    KB_MAPPING_106                      = 1,
    KB_MAPPING_106_KANA                 = 2,
    KB_MAPPING_GERMAN_GERMANY           = 3,
    KB_MAPPING_SPANISH_SPAIN            = 4,
    KB_MAPPING_FRENCH_FRANCE            = 5,
    KB_MAPPING_ITALIAN_ITALY            = 6,
    KB_MAPPING_DUTCH_NETHERLANDS        = 7,
    KB_MAPPING_PORTUGUESE_PORTUGAL      = 8,
    KB_MAPPING_RUSSIAN_RUSSIA           = 9,
    KB_MAPPING_ENGLISH_UK               = 10,
    KB_MAPPING_KOREAN_KOREA             = 11,
    KB_MAPPING_NORWEGIAN_NORWAY         = 12,
    KB_MAPPING_FINNISH_FINLAND          = 13,
    KB_MAPPING_DANISH_DENMARK           = 14,
    KB_MAPPING_SWEDISH_SWEDEN           = 15,
    KB_MAPPING_CHINESE_TRADITIONAL      = 16,
    KB_MAPPING_CHINESE_SIMPLIFIED       = 17,
    KB_MAPPING_SWISS_FRENCH_SWITZERLAND = 18,
    KB_MAPPING_SWISS_GERMAN_SWITZERLAND = 19,
    KB_MAPPING_CANADIAN_FRENCH_CANADA   = 20
} KbMapping;

typedef struct KbInfo {
    u32 max;                    
    u32 connected;              
    u32 info;                   
    u8 status[MAX_KEYBOARDS];   
} KbInfo;

typedef struct KbConfig {
    u32 mapping;    
    u32 rmode;      
    u32 codetype;   
} KbConfig;

s32 ioKbInit(const u32 max);

s32 ioKbEnd(void);

s32 ioKbRead(const u32 kb_no, KbData* data);

s32 ioKbSetReadMode(const u32 kb_no, const KbRmode kb_rmode);

s32 ioKbSetCodeType(const u32 kb_no, const KbCodeType kb_codetype);

u16 ioKbCnvRawCode(const KbMapping mapping, const KbMkey mkey, const KbLed led, const u16 rawcode);

s32 ioKbSetLEDStatus(const u32 kb_no, const KbLed led_state);

s32 ioKbGetInfo(KbInfo* kb_info);

s32 ioKbGetConfiguration(const u32 kb_no, KbConfig* kb_config);

s32 ioKbClearBuf(const u32 kb_no);

#ifdef __cplusplus
    }
#endif