hid_tables.h

Go to the documentation of this file.

 
#ifndef HID_TABLES_H
#define HID_TABLES_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "../typedef.h"
 
// Helper macros
#ifndef HIDAPI
#   define HIDAPI static
#endif

#define HID_USAGE_MAX (0xFF)
#define HID_BITMASK_LEFT_SHIFT (0x02)
#define HID_BITMASK_RIGHT_SHIFT (0x20)

enum HID_TABLES_KEY_CODES {
    HID_KEY_NONE        = 0x00, 
    HID_KEY_ERROR_ROLLOVER  = 0x01, 
    HID_KEY_POST_FAIL   = 0x02, 
    HID_KEY_ERROR_UNDEFINED = 0x03, 
 
    //  Letters
    HID_KEY_A = 0x04,
    HID_KEY_B = 0x05,
    HID_KEY_C = 0x06,
    HID_KEY_D = 0x07,
    HID_KEY_E = 0x08,
    HID_KEY_F = 0x09,
    HID_KEY_G = 0x0A,
    HID_KEY_H = 0x0B,
    HID_KEY_I = 0x0C,
    HID_KEY_J = 0x0D,
    HID_KEY_K = 0x0E,
    HID_KEY_L = 0x0F,
    HID_KEY_M = 0x10,
    HID_KEY_N = 0x11,
    HID_KEY_O = 0x12,
    HID_KEY_P = 0x13,
    HID_KEY_Q = 0x14,
    HID_KEY_R = 0x15,
    HID_KEY_S = 0x16,
    HID_KEY_T = 0x17,
    HID_KEY_U = 0x18,
    HID_KEY_V = 0x19,
    HID_KEY_W = 0x1A,
    HID_KEY_X = 0x1B,
    HID_KEY_Y = 0x1C,
    HID_KEY_Z = 0x1D,
 
    //  Numbers (Top Row)
    HID_KEY_1 = 0x1E,
    HID_KEY_2 = 0x1F,
    HID_KEY_3 = 0x20,
    HID_KEY_4 = 0x21,
    HID_KEY_5 = 0x22,
    HID_KEY_6 = 0x23,
    HID_KEY_7 = 0x24,
    HID_KEY_8 = 0x25,
    HID_KEY_9 = 0x26,
    HID_KEY_0 = 0x27,
 
    //  Controls & Symbols
    HID_KEY_ENTER         = 0x28,
    HID_KEY_ESCAPE        = 0x29,
    HID_KEY_BACKSPACE     = 0x2A,
    HID_KEY_TAB       = 0x2B,
    HID_KEY_SPACE         = 0x2C,
    HID_KEY_MINUS         = 0x2D,
    HID_KEY_EQUAL         = 0x2E,
    HID_KEY_BRACKET_LEFT  = 0x2F,
    HID_KEY_BRACKET_RIGHT = 0x30,
    HID_KEY_BACKSLASH     = 0x31,
    HID_KEY_SEMICOLON     = 0x33,
    HID_KEY_APOSTROPHE    = 0x34,
    HID_KEY_GRAVE         = 0x35,
    HID_KEY_COMMA         = 0x36,
    HID_KEY_PERIOD        = 0x37,
    HID_KEY_SLASH         = 0x38,
 
    HID_KEY_CAPS_LOCK = 0x39,
 
    //  Function Keys
    HID_KEY_F1  = 0x3A,
    HID_KEY_F2  = 0x3B,
    HID_KEY_F3  = 0x3C,
    HID_KEY_F4  = 0x3D,
    HID_KEY_F5  = 0x3E,
    HID_KEY_F6  = 0x3F,
    HID_KEY_F7  = 0x40,
    HID_KEY_F8  = 0x41,
    HID_KEY_F9  = 0x42,
    HID_KEY_F10 = 0x43,
    HID_KEY_F11 = 0x44,
    HID_KEY_F12 = 0x45,
 
    //  Navigation
    HID_KEY_PRINT_SCREEN = 0x46,
    HID_KEY_SCROLL_LOCK  = 0x47,
    HID_KEY_PAUSE        = 0x48,
    HID_KEY_INSERT       = 0x49,
    HID_KEY_HOME         = 0x4A,
    HID_KEY_PAGE_UP      = 0x4B,
    HID_KEY_DELETE       = 0x4C,
    HID_KEY_END      = 0x4D,
    HID_KEY_PAGE_DOWN    = 0x4E,
    HID_KEY_RIGHT        = 0x4F,
    HID_KEY_LEFT         = 0x50,
    HID_KEY_DOWN         = 0x51,
    HID_KEY_UP       = 0x52,
 
    //  Modifiers
    HID_KEY_LEFT_CTRL   = 0xE0,
    HID_KEY_LEFT_SHIFT  = 0xE1,
    HID_KEY_LEFT_ALT    = 0xE2,
    HID_KEY_LEFT_GUI    = 0xE3,
    HID_KEY_RIGHT_CTRL  = 0xE4,
    HID_KEY_RIGHT_SHIFT = 0xE5,
    HID_KEY_RIGHT_ALT   = 0xE6,
    HID_KEY_RIGHT_GUI   = 0xE7
};

HIDAPI const char HID_TO_ASCII_LOWER[HID_USAGE_MAX] = {
    // 0x00 - 0x03 (Reserved/Error)
    [0x00] = 0,
    [0x01] = 0,
    [0x02] = 0,
    [0x03] = 0,
 
    // 0x04 - 0x1D (Letters a-z)
    [HID_KEY_A] = 'a',
    [HID_KEY_B] = 'b',
    [HID_KEY_C] = 'c',
    [HID_KEY_D] = 'd',
    [HID_KEY_E] = 'e',
    [HID_KEY_F] = 'f',
    [HID_KEY_G] = 'g',
    [HID_KEY_H] = 'h',
    [HID_KEY_I] = 'i',
    [HID_KEY_J] = 'j',
    [HID_KEY_K] = 'k',
    [HID_KEY_L] = 'l',
    [HID_KEY_M] = 'm',
    [HID_KEY_N] = 'n',
    [HID_KEY_O] = 'o',
    [HID_KEY_P] = 'p',
    [HID_KEY_Q] = 'q',
    [HID_KEY_R] = 'r',
    [HID_KEY_S] = 's',
    [HID_KEY_T] = 't',
    [HID_KEY_U] = 'u',
    [HID_KEY_V] = 'v',
    [HID_KEY_W] = 'w',
    [HID_KEY_X] = 'x',
    [HID_KEY_Y] = 'y',
    [HID_KEY_Z] = 'z',
 
    // 0x1E - 0x27 (Numbers 1-0)
    [HID_KEY_1] = '1',
    [HID_KEY_2] = '2',
    [HID_KEY_3] = '3',
    [HID_KEY_4] = '4',
    [HID_KEY_5] = '5',
    [HID_KEY_6] = '6',
    [HID_KEY_7] = '7',
    [HID_KEY_8] = '8',
    [HID_KEY_9] = '9',
    [HID_KEY_0] = '0',
 
    // 0x28 - 0x38 (Symbols & Controls)
    [HID_KEY_ENTER]     = '\n',
    [HID_KEY_ESCAPE]    = 0x1B,
    [HID_KEY_BACKSPACE] = '\b',
    [HID_KEY_TAB]       = '\t',
    [HID_KEY_SPACE]     = ' ',
    [HID_KEY_MINUS]     = '-',
    [HID_KEY_EQUAL]     = '=',
    [HID_KEY_BRACKET_LEFT]  = '[',
    [HID_KEY_BRACKET_RIGHT] = ']',
    [HID_KEY_BACKSLASH] = '\\',
    [HID_KEY_SEMICOLON] = ';',
    [HID_KEY_APOSTROPHE]    = '\'',
    [HID_KEY_GRAVE]     = '`',
    [HID_KEY_COMMA]     = ',',
    [HID_KEY_PERIOD]    = '.',
    [HID_KEY_SLASH]     = '/',
 
    // Keypad (Subset)
    [0x59] = '1',
    [0x5A] = '2',
    [0x5B] = '3',
    [0x5C] = '4',
    [0x5D] = '5',
    [0x5E] = '6',
    [0x5F] = '7',
    [0x60] = '8',
    [0x61] = '9',
    [0x62] = '0',
    [0x54] = '/',
    [0x55] = '*',
    [0x56] = '-',
    [0x57] = '+',
    [0x58] = '\n',
    [0x63] = '.'};

HIDAPI const char HID_TO_ASCII_UPPER[HID_USAGE_MAX] = {
    // 0x00 - 0x03
    [0x00] = 0,
 
    // 0x04 - 0x1D (Letters A-Z)
    [HID_KEY_A] = 'A',
    [HID_KEY_B] = 'B',
    [HID_KEY_C] = 'C',
    [HID_KEY_D] = 'D',
    [HID_KEY_E] = 'E',
    [HID_KEY_F] = 'F',
    [HID_KEY_G] = 'G',
    [HID_KEY_H] = 'H',
    [HID_KEY_I] = 'I',
    [HID_KEY_J] = 'J',
    [HID_KEY_K] = 'K',
    [HID_KEY_L] = 'L',
    [HID_KEY_M] = 'M',
    [HID_KEY_N] = 'N',
    [HID_KEY_O] = 'O',
    [HID_KEY_P] = 'P',
    [HID_KEY_Q] = 'Q',
    [HID_KEY_R] = 'R',
    [HID_KEY_S] = 'S',
    [HID_KEY_T] = 'T',
    [HID_KEY_U] = 'U',
    [HID_KEY_V] = 'V',
    [HID_KEY_W] = 'W',
    [HID_KEY_X] = 'X',
    [HID_KEY_Y] = 'Y',
    [HID_KEY_Z] = 'Z',
 
    // 0x1E - 0x27 (Numbers -> Symbols)
    [HID_KEY_1] = '!',
    [HID_KEY_2] = '@',
    [HID_KEY_3] = '#',
    [HID_KEY_4] = '$',
    [HID_KEY_5] = '%',
    [HID_KEY_6] = '^',
    [HID_KEY_7] = '&',
    [HID_KEY_8] = '*',
    [HID_KEY_9] = '(',
    [HID_KEY_0] = ')',
 
    // 0x28 - 0x38 (Symbols & Controls)
    [HID_KEY_ENTER]     = '\n',
    [HID_KEY_ESCAPE]    = 0x1B,
    [HID_KEY_BACKSPACE] = '\b',
    [HID_KEY_TAB]       = '\t',
    [HID_KEY_SPACE]     = ' ',
    [HID_KEY_MINUS]     = '_',
    [HID_KEY_EQUAL]     = '+',
    [HID_KEY_BRACKET_LEFT]  = '{',
    [HID_KEY_BRACKET_RIGHT] = '}',
    [HID_KEY_BACKSLASH] = '|',
    [HID_KEY_SEMICOLON] = ':',
    [HID_KEY_APOSTROPHE]    = '"',
    [HID_KEY_GRAVE]     = '~',
    [HID_KEY_COMMA]     = '<',
    [HID_KEY_PERIOD]    = '>',
    [HID_KEY_SLASH]     = '?',
};

typedef enum HID_TABLES_KEY_CODES HidKeyCodes;

HIDAPI inline char
hid_parse_key(u8 modifier, u8 usage_id)
{
    if (usage_id >= HID_USAGE_MAX) {
        return 0;
    }
 
    // Check for Left Shift (Bit 1) or Right Shift (Bit 5)
    u8 is_shifted = (modifier & HID_BITMASK_LEFT_SHIFT) || (modifier & HID_BITMASK_RIGHT_SHIFT);
 
    // Caps Lock handling requires state tracking external to this function.
    // This function purely handles Shift-based mapping.
 
    return is_shifted ? HID_TO_ASCII_UPPER[usage_id] : HID_TO_ASCII_LOWER[usage_id];
}
 
#ifdef __cplusplus
}
#endif
#endif // HID_TABLES_H