Newer
Older
minerva / Kernel / Devices / Input / HID / KeyboardKeymap.h
@minerva minerva on 13 Jul 10 KB Initial commit
/*
 * Copyright (c) 2025, Sönke Holz <sholz8530@gmail.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/Array.h>
#include <Kernel/Devices/Input/Definitions.h>

namespace Kernel::HID {

// Keyboard/Keypad Page keymap
// https://usb.org/sites/default/files/hut1_6.pdf#chapter.10

// clang-format off
static constexpr auto unshifted_keyboard_keypad_page_keymap = to_array<KeyCodeEntry const>({
    // 0x00-0x0f
    // Reserved                      ErrorRollOver                    POSTFail                         ErrorUndefined
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_A, 0x1e },                 { Key_B, 0x30 },                 { Key_C, 0x2e },                 { Key_D, 0x20 },
    { Key_E, 0x12 },                 { Key_F, 0x21 },                 { Key_G, 0x22 },                 { Key_H, 0x23 },
    { Key_I, 0x17 },                 { Key_J, 0x24 },                 { Key_K, 0x25 },                 { Key_L, 0x26 },

    // 0x10-0x1f
    { Key_M, 0x32 },                 { Key_N, 0x31 },                 { Key_O, 0x18 },                 { Key_P, 0x19 },
    { Key_Q, 0x10 },                 { Key_R, 0x13 },                 { Key_S, 0x1f },                 { Key_T, 0x14 },
    { Key_U, 0x16 },                 { Key_V, 0x2f },                 { Key_W, 0x11 },                 { Key_X, 0x2d },
    { Key_Y, 0x15 },                 { Key_Z, 0x2c },                 { Key_1, 0x02 },                 { Key_2, 0x03 },

    // 0x20-0x2f
    { Key_3, 0x04 },                 { Key_4, 0x05 },                 { Key_5, 0x06 },                 { Key_6, 0x07 },
    { Key_7, 0x08 },                 { Key_8, 0x09 },                 { Key_9, 0x0a },                 { Key_0, 0x0b },
    { Key_Return, 0x1c },            { Key_Escape, 0x01 },            { Key_Backspace, 0x0e },         { Key_Tab, 0x0f },
    { Key_Space, 0x39 },             { Key_Minus, 0x0c },             { Key_Equal, 0x0d },             { Key_LeftBracket, 0x1a },

    // 0x30-0x3f
    // Some non-US keyboards seem to use the "Keyboard Non-US # and ˜" (0x32) Usage for the key that is mapped to "\" on US layouts,
    // while others just use the "Keyboard \ and |" (0x31) Usage.
    { Key_RightBracket, 0x1b },      { Key_Backslash, 0x2b },         { Key_Backslash, 0x2b },         { Key_Semicolon, 0x27 },
    { Key_Apostrophe, 0x28 },        { Key_Backtick, 0x29 },          { Key_Comma, 0x33 },             { Key_Period, 0x34 },
    { Key_Slash, 0x35 },             { Key_CapsLock, 0xff },          { Key_F1, 0xff },                { Key_F2, 0xff },
    { Key_F3, 0xff },                { Key_F4, 0xff },                { Key_F5, 0xff },                { Key_F6, 0xff },

    // 0x40-0x4f
    { Key_F7, 0xff },                { Key_F8, 0xff },                { Key_F9, 0xff },                { Key_F10, 0xff },
    { Key_F11, 0xff },               { Key_F12, 0xff },               { Key_PrintScreen, 0xff },       { Key_ScrollLock, 0xff },
    { Key_PauseBreak, 0xff },        { Key_Insert, 0xff },            { Key_Home, 0xff },              { Key_PageUp, 0xff },
    { Key_Delete, 0xff },            { Key_End, 0xff },               { Key_PageDown, 0xff },          { Key_Right, 0xff },

    // 0x50-0x5f
    // FIXME: Add Numpad "/" key to character map for Usage ID 0x54
    { Key_Left, 0xff },              { Key_Down, 0xff },              { Key_Up, 0xff },                { Key_NumLock, 0xff },
    { Key_Slash, 0xff },             { Key_Asterisk, 0x37 },          { Key_Minus, 0x4a },             { Key_Plus, 0x4e },
    { Key_Return, 0x1c },            { Key_End, 0xff },               { Key_Down, 0xff },              { Key_PageDown, 0xff },
    { Key_Left, 0xff },              { Key_Invalid, 0xff },           { Key_Right, 0xff },             { Key_Home, 0xff },

    // 0x60-0x6f
    { Key_Up, 0xff },                { Key_PageUp, 0xff },            { Key_Insert, 0xff },            { Key_Delete, 0xff },
    { Key_Backslash, 0x56 },         { Key_Menu, 0xff },              { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },

    // 0x70-0x7f
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },

    // 0x80-0x8f
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },

    // 0x90-0x9f
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },

    // 0xa0-0xaf
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },

    // 0xb0-0xbf
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },

    // 0xc0-0xcf
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },

    // 0xd0-0xdf
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },

    // 0xe0-0xe7
    { Key_LeftControl, 0xff },       { Key_LeftShift, 0xff },         { Key_LeftAlt, 0xff },           { Key_LeftSuper, 0xff },
    { Key_RightControl, 0xff },      { Key_RightShift, 0xff },        { Key_RightAlt, 0xff },          { Key_RightSuper, 0xff },
});
// clang-format on

// clang-format off
static constexpr auto shifted_keyboard_keypad_page_keymap = to_array<KeyCodeEntry const>({
    // 0x00-0x0f
    // Reserved                      ErrorRollOver                    POSTFail                         ErrorUndefined
    { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },           { Key_Invalid, 0xff },
    { Key_A, 0x1e },                 { Key_B, 0x30 },                 { Key_C, 0x2e },                 { Key_D, 0x20 },
    { Key_E, 0x12 },                 { Key_F, 0x21 },                 { Key_G, 0x22 },                 { Key_H, 0x23 },
    { Key_I, 0x17 },                 { Key_J, 0x24 },                 { Key_K, 0x25 },                 { Key_L, 0x26 },

    // 0x10-0x1f
    { Key_M, 0x32 },                 { Key_N, 0x31 },                 { Key_O, 0x18 },                 { Key_P, 0x19 },
    { Key_Q, 0x10 },                 { Key_R, 0x13 },                 { Key_S, 0x1f },                 { Key_T, 0x14 },
    { Key_U, 0x16 },                 { Key_V, 0x2f },                 { Key_W, 0x11 },                 { Key_X, 0x2d },
    { Key_Y, 0x15 },                 { Key_Z, 0x2c },                 { Key_ExclamationPoint, 0x02 },  { Key_AtSign, 0x03 },

    // 0x20-0x2f
    { Key_Hashtag, 0x04 },           { Key_Dollar, 0x05 },            { Key_Percent, 0x06 },           { Key_Circumflex, 0x07 },
    { Key_Ampersand, 0x08 },         { Key_Asterisk, 0x09 },          { Key_LeftParen, 0x0a },         { Key_RightParen, 0x0b },
    { Key_Return, 0x1c },            { Key_Escape, 0x01 },            { Key_Backspace, 0x0e },         { Key_Tab, 0x0f },
    { Key_Space, 0x39 },             { Key_Underscore, 0x0c },        { Key_Plus, 0x0d },              { Key_LeftBrace, 0x1a },

    // 0x30-0x38
    { Key_RightBrace, 0x1b },        { Key_Pipe, 0x2b },              { Key_Pipe, 0x2b },              { Key_Colon, 0x27 },
    { Key_DoubleQuote, 0x28 },       { Key_Tilde, 0x29 },             { Key_LessThan, 0x33 },          { Key_GreaterThan, 0x34 },
    { Key_QuestionMark, 0x35 },
});
// clang-format on

}