2021-10-13 16:38:24 +00:00
|
|
|
#pragma once
|
|
|
|
|
|
|
|
|
|
/** HID keyboard key codes */
|
|
|
|
|
enum HidKeyboardKeys {
|
|
|
|
|
KEY_NONE = 0x00,
|
|
|
|
|
KEY_ERROR_ROLLOVER = 0x01,
|
|
|
|
|
KEY_POST_FAIL = 0x02,
|
|
|
|
|
KEY_ERROR_UNDEFINED = 0x03,
|
|
|
|
|
KEY_A = 0x04,
|
|
|
|
|
KEY_B = 0x05,
|
|
|
|
|
KEY_C = 0x06,
|
|
|
|
|
KEY_D = 0x07,
|
|
|
|
|
KEY_E = 0x08,
|
|
|
|
|
KEY_F = 0x09,
|
|
|
|
|
KEY_G = 0x0A,
|
|
|
|
|
KEY_H = 0x0B,
|
|
|
|
|
KEY_I = 0x0C,
|
|
|
|
|
KEY_J = 0x0D,
|
|
|
|
|
KEY_K = 0x0E,
|
|
|
|
|
KEY_L = 0x0F,
|
|
|
|
|
KEY_M = 0x10,
|
|
|
|
|
KEY_N = 0x11,
|
|
|
|
|
KEY_O = 0x12,
|
|
|
|
|
KEY_P = 0x13,
|
|
|
|
|
KEY_Q = 0x14,
|
|
|
|
|
KEY_R = 0x15,
|
|
|
|
|
KEY_S = 0x16,
|
|
|
|
|
KEY_T = 0x17,
|
|
|
|
|
KEY_U = 0x18,
|
|
|
|
|
KEY_V = 0x19,
|
|
|
|
|
KEY_W = 0x1A,
|
|
|
|
|
KEY_X = 0x1B,
|
|
|
|
|
KEY_Y = 0x1C,
|
|
|
|
|
KEY_Z = 0x1D,
|
|
|
|
|
KEY_1 = 0x1E,
|
|
|
|
|
KEY_2 = 0x1F,
|
|
|
|
|
KEY_3 = 0x20,
|
|
|
|
|
KEY_4 = 0x21,
|
|
|
|
|
KEY_5 = 0x22,
|
|
|
|
|
KEY_6 = 0x23,
|
|
|
|
|
KEY_7 = 0x24,
|
|
|
|
|
KEY_8 = 0x25,
|
|
|
|
|
KEY_9 = 0x26,
|
|
|
|
|
KEY_0 = 0x27,
|
|
|
|
|
KEY_ENTER = 0x28,
|
|
|
|
|
KEY_ESC = 0x29,
|
|
|
|
|
KEY_BACKSPACE = 0x2A,
|
|
|
|
|
KEY_TAB = 0x2B,
|
|
|
|
|
KEY_SPACE = 0x2C,
|
|
|
|
|
KEY_MINUS = 0x2D,
|
|
|
|
|
KEY_EQUAL = 0x2E,
|
|
|
|
|
KEY_LEFT_BRACE = 0x2F,
|
|
|
|
|
KEY_RIGHT_BRACE = 0x30,
|
|
|
|
|
KEY_BACKSLASH = 0x31,
|
|
|
|
|
KEY_NON_US_NUM = 0x32,
|
|
|
|
|
KEY_SEMICOLON = 0x33,
|
|
|
|
|
KEY_QUOTE = 0x34,
|
|
|
|
|
KEY_TILDE = 0x35,
|
|
|
|
|
KEY_COMMA = 0x36,
|
|
|
|
|
KEY_PERIOD = 0x37,
|
|
|
|
|
KEY_SLASH = 0x38,
|
|
|
|
|
KEY_CAPS_LOCK = 0x39,
|
|
|
|
|
KEY_F1 = 0x3A,
|
|
|
|
|
KEY_F2 = 0x3B,
|
|
|
|
|
KEY_F3 = 0x3C,
|
|
|
|
|
KEY_F4 = 0x3D,
|
|
|
|
|
KEY_F5 = 0x3E,
|
|
|
|
|
KEY_F6 = 0x3F,
|
|
|
|
|
KEY_F7 = 0x40,
|
|
|
|
|
KEY_F8 = 0x41,
|
|
|
|
|
KEY_F9 = 0x42,
|
|
|
|
|
KEY_F10 = 0x43,
|
|
|
|
|
KEY_F11 = 0x44,
|
|
|
|
|
KEY_F12 = 0x45,
|
|
|
|
|
KEY_PRINT = 0x46,
|
|
|
|
|
KEY_SCROLL_LOCK = 0x47,
|
|
|
|
|
KEY_PAUSE = 0x48,
|
|
|
|
|
KEY_INSERT = 0x49,
|
|
|
|
|
KEY_HOME = 0x4A,
|
|
|
|
|
KEY_PAGE_UP = 0x4B,
|
|
|
|
|
KEY_DELETE = 0x4C,
|
|
|
|
|
KEY_END = 0x4D,
|
|
|
|
|
KEY_PAGE_DOWN = 0x4E,
|
|
|
|
|
KEY_RIGHT_ARROW = 0x4F,
|
|
|
|
|
KEY_LEFT_ARROW = 0x50,
|
|
|
|
|
KEY_DOWN_ARROW = 0x51,
|
|
|
|
|
KEY_UP_ARROW = 0x52,
|
|
|
|
|
KEY_NUM_LOCK = 0x53,
|
|
|
|
|
KEYPAD_DIVIDE = 0x54,
|
|
|
|
|
KEYPAD_MULTIPLY = 0x55,
|
|
|
|
|
KEYPAD_SUBTRACT = 0x56,
|
|
|
|
|
KEYPAD_ADD = 0x57,
|
|
|
|
|
KEYPAD_ENTER = 0x58,
|
|
|
|
|
KEYPAD_1 = 0x59,
|
|
|
|
|
KEYPAD_2 = 0x5A,
|
|
|
|
|
KEYPAD_3 = 0x5B,
|
|
|
|
|
KEYPAD_4 = 0x5C,
|
|
|
|
|
KEYPAD_5 = 0x5D,
|
|
|
|
|
KEYPAD_6 = 0x5E,
|
|
|
|
|
KEYPAD_7 = 0x5F,
|
|
|
|
|
KEYPAD_8 = 0x60,
|
|
|
|
|
KEYPAD_9 = 0x61,
|
|
|
|
|
KEYPAD_0 = 0x62,
|
|
|
|
|
KEYPAD_DOT = 0x63,
|
|
|
|
|
KEY_NON_US = 0x64,
|
|
|
|
|
KEY_APPLICATION = 0x65,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/** HID keyboard modifier keys */
|
|
|
|
|
enum HidKeyboardMods {
|
|
|
|
|
KEY_MOD_LEFT_CTRL = (1 << 8),
|
|
|
|
|
KEY_MOD_LEFT_SHIFT = (1 << 9),
|
|
|
|
|
KEY_MOD_LEFT_ALT = (1 << 10),
|
|
|
|
|
KEY_MOD_LEFT_GUI = (1 << 11),
|
|
|
|
|
KEY_MOD_RIGHT_CTRL = (1 << 12),
|
|
|
|
|
KEY_MOD_RIGHT_SHIFT = (1 << 13),
|
|
|
|
|
KEY_MOD_RIGHT_ALT = (1 << 14),
|
|
|
|
|
KEY_MOD_RIGHT_GUI = (1 << 15),
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/** ASCII to keycode conversion table */
|
|
|
|
|
static const uint16_t hid_asciimap[] = {
|
|
|
|
|
KEY_NONE, // NUL
|
|
|
|
|
KEY_NONE, // SOH
|
|
|
|
|
KEY_NONE, // STX
|
|
|
|
|
KEY_NONE, // ETX
|
|
|
|
|
KEY_NONE, // EOT
|
|
|
|
|
KEY_NONE, // ENQ
|
|
|
|
|
KEY_NONE, // ACK
|
|
|
|
|
KEY_NONE, // BEL
|
|
|
|
|
KEY_BACKSPACE, // BS Backspace
|
|
|
|
|
KEY_TAB, // TAB Tab
|
|
|
|
|
KEY_ENTER, // LF Enter
|
|
|
|
|
KEY_NONE, // VT
|
|
|
|
|
KEY_NONE, // FF
|
|
|
|
|
KEY_NONE, // CR
|
|
|
|
|
KEY_NONE, // SO
|
|
|
|
|
KEY_NONE, // SI
|
|
|
|
|
KEY_NONE, // DEL
|
|
|
|
|
KEY_NONE, // DC1
|
|
|
|
|
KEY_NONE, // DC2
|
|
|
|
|
KEY_NONE, // DC3
|
|
|
|
|
KEY_NONE, // DC4
|
|
|
|
|
KEY_NONE, // NAK
|
|
|
|
|
KEY_NONE, // SYN
|
|
|
|
|
KEY_NONE, // ETB
|
|
|
|
|
KEY_NONE, // CAN
|
|
|
|
|
KEY_NONE, // EM
|
|
|
|
|
KEY_NONE, // SUB
|
|
|
|
|
KEY_NONE, // ESC
|
|
|
|
|
KEY_NONE, // FS
|
|
|
|
|
KEY_NONE, // GS
|
|
|
|
|
KEY_NONE, // RS
|
|
|
|
|
KEY_NONE, // US
|
|
|
|
|
KEY_SPACE, // ' ' Space
|
|
|
|
|
KEY_1 | KEY_MOD_LEFT_SHIFT, // !
|
|
|
|
|
KEY_QUOTE | KEY_MOD_LEFT_SHIFT, // "
|
|
|
|
|
KEY_3 | KEY_MOD_LEFT_SHIFT, // #
|
|
|
|
|
KEY_4 | KEY_MOD_LEFT_SHIFT, // $
|
|
|
|
|
KEY_5 | KEY_MOD_LEFT_SHIFT, // %
|
|
|
|
|
KEY_7 | KEY_MOD_LEFT_SHIFT, // &
|
|
|
|
|
KEY_QUOTE, // '
|
|
|
|
|
KEY_9 | KEY_MOD_LEFT_SHIFT, // (
|
|
|
|
|
KEY_0 | KEY_MOD_LEFT_SHIFT, // )
|
|
|
|
|
KEY_8 | KEY_MOD_LEFT_SHIFT, // *
|
|
|
|
|
KEY_EQUAL | KEY_MOD_LEFT_SHIFT, // +
|
|
|
|
|
KEY_COMMA, // ,
|
|
|
|
|
KEY_MINUS, // -
|
|
|
|
|
KEY_PERIOD, // .
|
|
|
|
|
KEY_SLASH, // /
|
|
|
|
|
KEY_0, // 0
|
|
|
|
|
KEY_1, // 1
|
|
|
|
|
KEY_2, // 2
|
|
|
|
|
KEY_3, // 3
|
|
|
|
|
KEY_4, // 4
|
|
|
|
|
KEY_5, // 5
|
|
|
|
|
KEY_6, // 6
|
|
|
|
|
KEY_7, // 7
|
|
|
|
|
KEY_8, // 8
|
|
|
|
|
KEY_9, // 9
|
|
|
|
|
KEY_SEMICOLON | KEY_MOD_LEFT_SHIFT, // :
|
|
|
|
|
KEY_SEMICOLON, // ;
|
|
|
|
|
KEY_COMMA | KEY_MOD_LEFT_SHIFT, // <
|
|
|
|
|
KEY_EQUAL, // =
|
|
|
|
|
KEY_PERIOD | KEY_MOD_LEFT_SHIFT, // >
|
|
|
|
|
KEY_SLASH | KEY_MOD_LEFT_SHIFT, // ?
|
|
|
|
|
KEY_2 | KEY_MOD_LEFT_SHIFT, // @
|
|
|
|
|
KEY_A | KEY_MOD_LEFT_SHIFT, // A
|
|
|
|
|
KEY_B | KEY_MOD_LEFT_SHIFT, // B
|
|
|
|
|
KEY_C | KEY_MOD_LEFT_SHIFT, // C
|
|
|
|
|
KEY_D | KEY_MOD_LEFT_SHIFT, // D
|
|
|
|
|
KEY_E | KEY_MOD_LEFT_SHIFT, // E
|
|
|
|
|
KEY_F | KEY_MOD_LEFT_SHIFT, // F
|
|
|
|
|
KEY_G | KEY_MOD_LEFT_SHIFT, // G
|
|
|
|
|
KEY_H | KEY_MOD_LEFT_SHIFT, // H
|
|
|
|
|
KEY_I | KEY_MOD_LEFT_SHIFT, // I
|
|
|
|
|
KEY_J | KEY_MOD_LEFT_SHIFT, // J
|
|
|
|
|
KEY_K | KEY_MOD_LEFT_SHIFT, // K
|
|
|
|
|
KEY_L | KEY_MOD_LEFT_SHIFT, // L
|
|
|
|
|
KEY_M | KEY_MOD_LEFT_SHIFT, // M
|
|
|
|
|
KEY_N | KEY_MOD_LEFT_SHIFT, // N
|
|
|
|
|
KEY_O | KEY_MOD_LEFT_SHIFT, // O
|
|
|
|
|
KEY_P | KEY_MOD_LEFT_SHIFT, // P
|
|
|
|
|
KEY_Q | KEY_MOD_LEFT_SHIFT, // Q
|
|
|
|
|
KEY_R | KEY_MOD_LEFT_SHIFT, // R
|
|
|
|
|
KEY_S | KEY_MOD_LEFT_SHIFT, // S
|
|
|
|
|
KEY_T | KEY_MOD_LEFT_SHIFT, // T
|
|
|
|
|
KEY_U | KEY_MOD_LEFT_SHIFT, // U
|
|
|
|
|
KEY_V | KEY_MOD_LEFT_SHIFT, // V
|
|
|
|
|
KEY_W | KEY_MOD_LEFT_SHIFT, // W
|
|
|
|
|
KEY_X | KEY_MOD_LEFT_SHIFT, // X
|
|
|
|
|
KEY_Y | KEY_MOD_LEFT_SHIFT, // Y
|
|
|
|
|
KEY_Z | KEY_MOD_LEFT_SHIFT, // Z
|
|
|
|
|
KEY_LEFT_BRACE, // [
|
|
|
|
|
KEY_BACKSLASH, // bslash
|
|
|
|
|
KEY_RIGHT_BRACE, // ]
|
|
|
|
|
KEY_6 | KEY_MOD_LEFT_SHIFT, // ^
|
|
|
|
|
KEY_MINUS | KEY_MOD_LEFT_SHIFT, // _
|
|
|
|
|
KEY_TILDE, // `
|
|
|
|
|
KEY_A, // a
|
|
|
|
|
KEY_B, // b
|
|
|
|
|
KEY_C, // c
|
|
|
|
|
KEY_D, // d
|
|
|
|
|
KEY_E, // e
|
|
|
|
|
KEY_F, // f
|
|
|
|
|
KEY_G, // g
|
|
|
|
|
KEY_H, // h
|
|
|
|
|
KEY_I, // i
|
|
|
|
|
KEY_J, // j
|
|
|
|
|
KEY_K, // k
|
|
|
|
|
KEY_L, // l
|
|
|
|
|
KEY_M, // m
|
|
|
|
|
KEY_N, // n
|
|
|
|
|
KEY_O, // o
|
|
|
|
|
KEY_P, // p
|
|
|
|
|
KEY_Q, // q
|
|
|
|
|
KEY_R, // r
|
|
|
|
|
KEY_S, // s
|
|
|
|
|
KEY_T, // t
|
|
|
|
|
KEY_U, // u
|
|
|
|
|
KEY_V, // v
|
|
|
|
|
KEY_W, // w
|
|
|
|
|
KEY_X, // x
|
|
|
|
|
KEY_Y, // y
|
|
|
|
|
KEY_Z, // z
|
|
|
|
|
KEY_LEFT_BRACE | KEY_MOD_LEFT_SHIFT, // {
|
|
|
|
|
KEY_BACKSLASH | KEY_MOD_LEFT_SHIFT, // |
|
|
|
|
|
KEY_RIGHT_BRACE | KEY_MOD_LEFT_SHIFT, // }
|
|
|
|
|
KEY_TILDE | KEY_MOD_LEFT_SHIFT, // ~
|
|
|
|
|
KEY_NONE, // DEL
|
|
|
|
|
};
|
|
|
|
|
|
2021-11-26 13:53:51 +00:00
|
|
|
typedef void (*HidStateCallback)(bool state, void* context);
|
|
|
|
|
|
2021-10-13 16:38:24 +00:00
|
|
|
/** ASCII to keycode conversion macro */
|
|
|
|
|
#define HID_ASCII_TO_KEY(x) (((uint8_t)x < 128) ? (hid_asciimap[(uint8_t)x]) : KEY_NONE)
|
|
|
|
|
|
|
|
|
|
/** HID mouse buttons */
|
|
|
|
|
enum HidMouseButtons {
|
|
|
|
|
HID_MOUSE_BTN_LEFT = (1 << 0),
|
|
|
|
|
HID_MOUSE_BTN_RIGHT = (1 << 1),
|
|
|
|
|
HID_MOUSE_BTN_WHEEL = (1 << 2),
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/** Get USB HID connection state
|
|
|
|
|
*
|
|
|
|
|
* @return true / false
|
|
|
|
|
*/
|
|
|
|
|
bool furi_hal_hid_is_connected();
|
|
|
|
|
|
2021-11-26 13:53:51 +00:00
|
|
|
/** Set USB HID connect/disconnect callback
|
|
|
|
|
*
|
|
|
|
|
* @param cb callback
|
|
|
|
|
* @param ctx callback context
|
|
|
|
|
*/
|
|
|
|
|
void furi_hal_hid_set_state_callback(HidStateCallback cb, void* ctx);
|
|
|
|
|
|
2021-10-13 16:38:24 +00:00
|
|
|
/** Set the following key to pressed state and send HID report
|
|
|
|
|
*
|
|
|
|
|
* @param button key code
|
|
|
|
|
*/
|
|
|
|
|
bool furi_hal_hid_kb_press(uint16_t button);
|
|
|
|
|
|
|
|
|
|
/** Set the following key to released state and send HID report
|
|
|
|
|
*
|
|
|
|
|
* @param button key code
|
|
|
|
|
*/
|
|
|
|
|
bool furi_hal_hid_kb_release(uint16_t button);
|
|
|
|
|
|
|
|
|
|
/** Clear all pressed keys and send HID report
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
bool furi_hal_hid_kb_release_all();
|
|
|
|
|
|
|
|
|
|
/** Set mouse movement and send HID report
|
|
|
|
|
*
|
|
|
|
|
* @param dx x coordinate delta
|
|
|
|
|
* @param dy y coordinate delta
|
|
|
|
|
*/
|
|
|
|
|
bool furi_hal_hid_mouse_move(int8_t dx, int8_t dy);
|
|
|
|
|
|
|
|
|
|
/** Set mouse button to pressed state and send HID report
|
|
|
|
|
*
|
|
|
|
|
* @param button key code
|
|
|
|
|
*/
|
|
|
|
|
bool furi_hal_hid_mouse_press(uint8_t button);
|
|
|
|
|
|
|
|
|
|
/** Set mouse button to released state and send HID report
|
|
|
|
|
*
|
|
|
|
|
* @param button key code
|
|
|
|
|
*/
|
|
|
|
|
bool furi_hal_hid_mouse_release(uint8_t button);
|
|
|
|
|
|
|
|
|
|
/** Set mouse wheel position and send HID report
|
|
|
|
|
*
|
|
|
|
|
* @param delta number of scroll steps
|
|
|
|
|
*/
|
|
|
|
|
bool furi_hal_hid_mouse_scroll(int8_t delta);
|
