hid_usage.h

/*
    This file is part of the AdNW keyboard firmware.

    Copyright 2010-2020 Stefan Fröbe, <frobiac /at/ gmail [d0t] com>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

// *INDENT-OFF*

#pragma once

/**
 * This file defines relevant ids for HID and ASCII mappings.
 *
 * Certain characters require associated modifiers to be sent along with their HID keycode,
 * and this mapping is dependant on the selected keyboard layout on the host.
 * An example is '@', which is composed of 'q' plus AltGr modifier on quertz.
 *
 * Information about additional Shift and AltGr requirements must therefore be stored along
 * with the HID code so these characters can be mapped to different layers.
 *
 * A keymap is thus composed of one pair of HID keycode and associated modifier for composing
 * a character per key per layer.
 *
 * Additional keyboard modifiers (shift, alt, ctrl and gui) and firmware specific modifiers
 * for layer switching or custom usage (dual use / tapping, internal control) can then be also
 * encoded in the additional field.
 *
 * HID modifiers are encoded into a 8 bit mask in USB keyboard report, but since operating systems
 * tend to handle left and right side modifiers the same with exception of R_Alt = AltGr
 * 3 bits are unused
 *
 * Right               Left
 * 7    6    5    4    3    2    1     0
 * Gui  Alt  Shft Ctrl Gui  Alt  Shft Ctrl
 *      (*)
 *
 * Firmware specific modifiers are
 * - Layer switches
 * - Dual use / tapping
 * - Mouse key
 *
 */

#include <stdint.h>

// see also ../LUFA/LUFA/Drivers/USB/Class/Common/HIDClassCommon.h
// or http://www.freebsddiary.org/APC/usb_hid_usages

#define HID_NO_KEY          0
#define HID_ERROR_ROLLOVER  1
#define HID_POST_FAIL       2
#define HID_ERROR_UNDEFINED 3
#define HID_A               4
#define HID_B               5
#define HID_C               6
#define HID_D               7
#define HID_E               8
#define HID_F               9
#define HID_G               10
#define HID_H               11
#define HID_I               12
#define HID_J               13
#define HID_K               14
#define HID_L               15
#define HID_M               16
#define HID_N               17
#define HID_O               18
#define HID_P               19
#define HID_Q               20
#define HID_R               21
#define HID_S               22
#define HID_T               23
#define HID_U               24
#define HID_V               25
#define HID_W               26
#define HID_X               27
#define HID_Y               28
#define HID_Z               29
#define HID_1               30
#define HID_2               31
#define HID_3               32
#define HID_4               33
#define HID_5               34
#define HID_6               35
#define HID_7               36
#define HID_8               37
#define HID_9               38
#define HID_0               39
#define HID_ENTER           40
#define HID_ESC             41
#define HID_BACKSPACE       42
#define HID_TAB             43
#define HID_SPACE           44
#define HID_MINUS           45
#define HID_EQUAL           46
#define HID_L_BRACKET       47
#define HID_R_BRACKET       48
#define HID_BSLASH          49
#define HID_NON_US_1        50
#define HID_SEMICOLON       51
#define HID_QUOTE           52
#define HID_GRAVE           53
#define HID_COMMA           54
#define HID_PERIOD          55
#define HID_SLASH           56
#define HID_CAPS_LOCK       57
#define HID_F1              58
#define HID_F2              59
#define HID_F3              60
#define HID_F4              61
#define HID_F5              62
#define HID_F6              63
#define HID_F7              64
#define HID_F8              65
#define HID_F9              66
#define HID_F10             67
#define HID_F11             68
#define HID_F12             69 //0x45
#define HID_PRINTSCREEN     70
#define HID_SCROLL_LOCK     71
#define HID_PAUSE           72
#define HID_INSERT          73
#define HID_HOME            74
#define HID_PAGE_UP         75
#define HID_DELETE          76
#define HID_END             77
#define HID_PAGE_DOWN       78
#define HID_RIGHT           79
#define HID_LEFT            80
#define HID_DOWN            81
#define HID_UP              82
#define HID_NUM_LOCK        83
#define HID_KEYPAD_SLASH    84
#define HID_KEYPAD_ASTERIX  85
#define HID_KEYPAD_MINUS    86
#define HID_KEYPAD_PLUS     87
#define HID_KEYPAD_ENTER    88
#define HID_KEYPAD_1        89
#define HID_KEYPAD_2        90
#define HID_KEYPAD_3        91
#define HID_KEYPAD_4        92
#define HID_KEYPAD_5        93
#define HID_KEYPAD_6        94
#define HID_KEYPAD_7        95
#define HID_KEYPAD_8        96
#define HID_KEYPAD_9        97
#define HID_KEYPAD_0        98
#define HID_KEYPAD_PERIOD   99
#define HID_NON_US_2        100
#define HID_APPLICATION     101
#define HID_MAC_POWER       102
#define HID_KEYPAD_EQUAL    103
#define HID_F13             104
#define HID_F14             105
#define HID_F15             106
#define HID_F16             107
#define HID_F17             108
#define HID_F18             109
#define HID_F19             110
#define HID_F20             111
#define HID_F21             112
#define HID_F22             113
#define HID_F23             114
#define HID_F24             115 // 0x73

#define HID_EXEC	0x74 //	Keyboard Execute
#define HID_HELP	0x75 //	Keyboard Help
#define HID_MENU	0x76 //	Keyboard Menu
#define HID_SEL 	0x77 //	Keyboard Select
#define HID_STOP	0x78 //	Keyboard Stop
#define HID_AGAI	0x79 //	Keyboard Again
#define HID_UNDO	0x7a //	Keyboard Undo
#define HID_CUT 	0x7b //	Keyboard Cut
#define HID_COPY	0x7c //	Keyboard Copy
#define HID_PAST	0x7d //	Keyboard Paste

#define HID_INT1    0x87 //	Keyboard International1
#define HID_INT2    0x88 //	Keyboard International1
#define HID_INT3    0x89 //	Keyboard International1
#define HID_INT4    0x8a //	Keyboard International1
#define HID_CMDMODE 0x8b // HID_INT5
// #define HID_INT5    0x8b //	Keyboard International5
#define HID_INT6    0x8c //	Keyboard International6
#define HID_INT7    0x8d //	Keyboard International7
/*
	0x74	Keyboard Execute
	0x75	Keyboard Help
	0x76	Keyboard Menu
	0x77	Keyboard Select
	0x78	Keyboard Stop
	0x79	Keyboard Again
	0x7A	Keyboard Undo
	0x7B	Keyboard Cut
	0x7C	Keyboard Copy
	0x7D	Keyboard Paste
	0x7E	Keyboard Find
	0x7F	Keyboard Mute
	0x80	Keyboard Volume Up
	0x81	Keyboard Volume Down
	0x82	Keyboard Locking Caps Lock
	0x83	Keyboard Locking Num Lock
	0x84	Keyboard Locking Scroll Lock
	0x85	Keypad Comma
	0x86	Keypad Equal Sign
	0x87	Keyboard International1
	0x88	Keyboard International2
	0x89	Keyboard International3
	0x8A	Keyboard International4
	0x8B	Keyboard International5
	0x8C	Keyboard International6
	0x8D	Keyboard International7
	0x8E	Keyboard International8
	0x8F	Keyboard International9
	0x90	Keyboard LANG1
	0x91	Keyboard LANG2
	0x92	Keyboard LANG3
	0x93	Keyboard LANG4
	0x94	Keyboard LANG5
	0x95	Keyboard LANG6
	0x96	Keyboard LANG7
	0x97	Keyboard LANG8
	0x98	Keyboard LANG9
	0x99	Keyboard Alternate Erase
	0x9A	Keyboard SysReq/Attention
	0x9B	Keyboard Cancel
	0x9C	Keyboard Clear
	0x9D	Keyboard Prior
	0x9E	Keyboard Return
	0x9F	Keyboard Separator
	0xA0	Keyboard Out
	0xA1	Keyboard Oper
	0xA2	Keyboard Clear/Again
	0xA3	Keyboard CrSel/Props
	0xA4	Keyboard ExSel
*/

#define HID_L_CONTROL       0xE0
#define HID_L_SHIFT         0xE1
#define HID_L_ALT           0xE2
#define HID_L_GUI           0xE3
#define HID_R_CONTROL       0xE4
#define HID_R_SHIFT         0xE5
#define HID_R_ALT           0xE6
#define HID_R_GUI           0xE7
#define HID_L_HYPER         HID_INT1

#define HID_SYSRQ           0x9A

/* mouse buttons hid codes */
#define HID_BTN_L (1<<0) // left
#define HID_BTN_R (1<<1) // right
#define HID_BTN_M (1<<2) // middle
#define HID_BTN_S (1<<3) // scroll
#define HID_BTN_5 (1<<4) // 5th

// since multiple modifiers per defined key do not make sense so far,
// we can use upper nibble for special key type encoding instead
#define MODKEY_MASK   0x10
#define MODHID_MASK   0x20
#define TAPPING_MASK  0x40
#define LAYER_MASK    0x80
// encode actual modifier bit in lower nibble.
#define HID_MOD_MASK(mod) (mod & (MODKEY_MASK|MODHID_MASK) ? 1<<(mod&0x0F) : 0)


/**
 * Any keys or modifiers that need further processing are stored here.
 * Their actual value has no meaning and must be mapped to something
 * reasonable later on.
 */
typedef enum {
    // ##########################################
    // modifiers needed for keycode on host layout (e.g "@" = HID_Q + ALTGR on qwertz)

    // Mousekey movement, buttons, wheel and acceleration
    MS_BEGIN=0x20,
    MS_U=MS_BEGIN,
    MS_D,
    MS_L,
    MS_R,
    MS_BTN1,
    MS_BTN2,
    MS_BTN3,
    MS_BTN4,
    MS_BTN5,
    MS_W_U,
    MS_W_D,
    MS_W_L,
    MS_W_R,
    MS_ACC0,
    MS_ACC1,
    MS_ACC2,

    // modifier bits to use, actual HID-modifier is (1<<(modbit-MOD_FIRST))
    MOD_FIRST   = MODKEY_MASK,
    MOD_L_CTRL  = MOD_FIRST,
    MOD_L_SHIFT,
    MOD_L_ALT,
    MOD_L_GUI,
    MOD_R_CTRL,
    MOD_R_SHIFT,
    MOD_R_ALT,
    MOD_R_GUI, 
    MOD_LAST = MOD_R_GUI,
    MOD_L_HYPER,

    ADD_FIRST   = MODHID_MASK,
     SHIFT,
     ALTGR   = MODHID_MASK + 6,

    // layer modifiers
    MOD_LAYER_0=LAYER_MASK,
    MOD_LAYER_1,
    MOD_LAYER_2,
    MOD_LAYER_3,
    MOD_MOUSEKEY,
    MOD_COMPOSE,
    MOD_LAYER_LAST
} modbits;

#define _MS_U       { MS_U, 0 /*,    ' ' */ }
#define _MS_D       { MS_D, 0 /*,    ' ' */ }
#define _MS_L       { MS_L, 0 /*,    ' ' */ }
#define _MS_R       { MS_R, 0 /*,    ' ' */ }
#define _MS_W_U     { MS_W_U, 0 /*,    ' ' */ }
#define _MS_W_D     { MS_W_D, 0 /*,    ' ' */ }
#define _MS_W_L     { MS_W_L, 0 /*,    ' ' */ }
#define _MS_W_R     { MS_W_R, 0 /*,    ' ' */ }
#define _MS_ACC0    { MS_ACC0, 0 /*,    ' ' */ }
#define _MS_ACC1    { MS_ACC1, 0 /*,    ' ' */ }
#define _MS_ACC2    { MS_ACC2, 0 /*,    ' ' */ }
#define _MS_BTN1    { MS_BTN1, 0 /*,    ' ' */ }
#define _MS_BTN2    { MS_BTN2, 0 /*,    ' ' */ }
#define _MS_BTN3    { MS_BTN3, 0 /*,    ' ' */ }
#define _MS_BTN4    { MS_BTN4, 0 /*,    ' ' */ }
#define _MS_BTN5    { MS_BTN5, 0 /*,    ' ' */ }

/// @todo : cleanup modifiers everywhere
/*
#define NONE  0
#define CTRL  (1<<0)
#define SHIFT (1<<1)
#define ALT   (1<<2)
#define GUI   (1<<3)
#define ALTGR (1<<6)
*/

// *************************************************************
// mapping of characters and HID codes
// differences between qwert_Y and qwert_Z are separate at the bottom
// **************************************************************

/*
QWERTY US                                QWERTZ DE
---------                                ---------
                                AltGr      ¹ ² ³ ¼ ½   { [ ] } \ ¸
~ ! @ # $ % ^ & * ( ) - +       shift    ° ! " § $ % & / ( ) = ? `
` 1 2 3 4 5 6 7 8 9 0 _ =       ROW1     ^ 1 2 3 4 5 6 7 8 9 0 ß ´
-----                                    -----
                                           @   €
  Q W E R T Y U I O P { } |     shift      Q W E R T Z U I O P Ü *
            y         [ ] \     ROW2                 z         ü +
-----                                    -----

  A S D F G H J K L : "         shift    A S D F G H J K L Ö Ä '
                    ; '         ROW3                         ö ä #
-----                                    -----
                                         |             µ
  Z X C V B N M < > ?           shift    > Y X C V B N M ; : _
  z             , . /           ROW4     < y             , . -
-----                                    -----

-> Different keys in QWERTZ DE :
Normal : ^                 ß ´     z ü + ö ä # < y , . -
Shifted: ^ 2 3 4 6 7 8 9 0 ß ´     z ü + ö ä # < y , . -
AltGr  :           7 8 9 0 ß   q e     +       <

*/

#define _no         { 0,     0 /*,      ' ' */ } // No key defined

#define _1          { HID_1, 0 /*,      '1' */ }
#define _EXCLAM     { HID_1, SHIFT  /*, '!' */ }
#define _2          { HID_2, 0 /*,      '2' */ }
#define _3          { HID_3, 0 /*,      '3' */ }
#define _4          { HID_4, 0 /*,      '4' */ }
#define _DOLLAR     { HID_4, SHIFT  /*, '$' */ }
#define _5          { HID_5, 0 /*,      '5' */ }
#define _PERCENT    { HID_5, SHIFT  /*, '%' */ }
#define _6          { HID_6, 0 /*,      '6' */ }
#define _7          { HID_7, 0 /*,      '7' */ }
#define _8          { HID_8, 0 /*,      '8' */ }
#define _9          { HID_9, 0 /*,      '9' */ }
#define _0          { HID_0, 0 /*,      '0' */ }

#define _q          { HID_Q, 0 /*,      'q' */ }
#define _Q          { HID_Q, SHIFT  /*, 'Q' */ }
#define _w          { HID_W, 0 /*,      'w' */ }
#define _W          { HID_W, SHIFT  /*, 'W' */ }
#define _e          { HID_E, 0 /*,      'e' */ }
#define _E          { HID_E, SHIFT  /*, 'E' */ }
#define _r          { HID_R, 0 /*,      'r' */ }
#define _R          { HID_R, SHIFT  /*, 'R' */ }
#define _t          { HID_T, 0 /*,      't' */ }
#define _T          { HID_T, SHIFT  /*, 'T' */ }
#define _u          { HID_U, 0 /*,      'u' */ }
#define _U          { HID_U, SHIFT  /*, 'U' */ }
#define _i          { HID_I, 0 /*,      'i' */ }
#define _I          { HID_I, SHIFT  /*, 'I' */ }
#define _o          { HID_O, 0 /*,      'o' */ }
#define _O          { HID_O, SHIFT  /*, 'O' */ }
#define _p          { HID_P, 0 /*,      'p' */ }
#define _P          { HID_P, SHIFT  /*, 'P' */ }

#define _a          { HID_A, 0 /*,      'a' */ }
#define _A          { HID_A, SHIFT  /*, 'A' */ }
#define _s          { HID_S, 0 /*,      's' */ }
#define _S          { HID_S, SHIFT  /*, 'S' */ }
#define _d          { HID_D, 0 /*,      'd' */ }
#define _D          { HID_D, SHIFT  /*, 'D' */ }
#define _f          { HID_F, 0 /*,      'f' */ }
#define _F          { HID_F, SHIFT  /*, 'F' */ }
#define _g          { HID_G, 0 /*,      'g' */ }
#define _G          { HID_G, SHIFT  /*, 'G' */ }
#define _h          { HID_H, 0 /*,      'h' */ }
#define _H          { HID_H, SHIFT  /*, 'H' */ }
#define _j          { HID_J, 0 /*,      'j' */ }
#define _J          { HID_J, SHIFT  /*, 'J' */ }
#define _k          { HID_K, 0 /*,      'k' */ }
#define _K          { HID_K, SHIFT  /*, 'K' */ }
#define _l          { HID_L, 0 /*,      'l' */ }
#define _L          { HID_L, SHIFT  /*, 'L' */ }

#define _x          { HID_X, 0 /*,      'x' */ }
#define _X          { HID_X, SHIFT  /*, 'X' */ }
#define _c          { HID_C, 0 /*,      'c' */ }
#define _C          { HID_C, SHIFT  /*, 'C' */ }
#define _v          { HID_V, 0 /*,      'v' */ }
#define _V          { HID_V, SHIFT  /*, 'V' */ }
#define _b          { HID_B, 0 /*,      'b' */ }
#define _B          { HID_B, SHIFT  /*, 'B' */ }
#define _n          { HID_N, 0 /*,      'n' */ }
#define _N          { HID_N, SHIFT  /*, 'N' */ }
#define _m          { HID_M, 0 /*,      'm' */ }
#define _M          { HID_M, SHIFT  /*, 'M' */ }

#define _CAPS       { HID_CAPS_LOCK,0      /*, ' ' */ }  //  CapsLock
#define _BSPACE     { HID_BACKSPACE,0      /*, 171 */ }  //  Backspace
#define _TAB        { HID_TAB,      0      /*, 187 */ }  //  Tab

#define _NON_US_1   { HID_NON_US_1, 0      /*, ' ' */ }  //  non-US-1
#define _NON_US_2   { HID_NON_US_2, 0      /*, ' ' */ }  //  non-US-1
#define _ENTER      { HID_ENTER,    0      /*, 182 */ }  //  Enter

#define _COMMA      { HID_COMMA,    0      /*, ',' */ }
#define _PERIOD     { HID_PERIOD,   0      /*, '.' */ }
#define _SPACE      { HID_SPACE,    0      /*, ' ' */ }

//L/R 4 modifiers
#define _L_SHIFT    { HID_L_SHIFT,      MOD_L_SHIFT  /*, ' ' */ }  //  LShift
#define _R_SHIFT    { HID_R_SHIFT,      MOD_R_SHIFT  /*, ' ' */ }  //  RShift
#define _L_CTRL     { HID_L_CONTROL,    MOD_L_CTRL   /*, ' ' */ }  //  LCtrl
#define _R_CTRL     { HID_R_CONTROL,    MOD_R_CTRL   /*, ' ' */ }  //  RCtrl
#define _L_ALT      { HID_L_ALT,        MOD_L_ALT    /*, ' ' */ }  //  LAlt
#define _R_ALT      { HID_R_ALT,        MOD_R_ALT    /*, ' ' */ }  //  RAlt
#define _L_GUI      { HID_L_GUI,        MOD_L_GUI    /*, ' ' */ }  //  LWin
#define _R_GUI      { HID_R_GUI,        MOD_R_GUI    /*, ' ' */ }  //  RWin
#define _L_HYPER    { HID_L_HYPER,      MOD_L_HYPER  /*, ' ' */ }  //  Hyper dummy to be mapped on linux
//
#define _MOD_0      { HID_NO_KEY,       MOD_LAYER_0  /*, ' ' */ }
#define _MOD_1      { HID_NO_KEY,       MOD_LAYER_1  /*, ' ' */ }
#define _MOD_2      { HID_NO_KEY,       MOD_LAYER_2  /*, ' ' */ }
#define _MOD_3      { HID_NO_KEY,       MOD_LAYER_3  /*, ' ' */ }
#define _MOD_MOUSEKEY { HID_NO_KEY,     MOD_MOUSEKEY /*, ' ' */ }
#define _COMPOSE    { HID_NO_KEY,       MOD_COMPOSE  /*, ' ' */ }

#define _MS_SCROLL   { MS_SCROLL,0 /*,    ' ' */ }
#define _MS_BTN_1    { MS_BTN_1, 0 /*,    ' ' */ }
#define _MS_BTN_2    { MS_BTN_2, 0 /*,    ' ' */ }
#define _MS_BTN_3    { MS_BTN_3, 0 /*,    ' ' */ }

#define _INS        { HID_INSERT,       0      /*, ' ' */ }  //  Insert
#define _DEL        { HID_DELETE,       0      /*, ' ' */ }  //  Delete
#define _LEFT       { HID_LEFT,         0      /*, ' ' */ }  //  Left
#define _HOME       { HID_HOME,         0      /*, ' ' */ }  //  Home
#define _END        { HID_END,          0      /*, ' ' */ }  //  End
#define _UP         { HID_UP,           0      /*, ' ' */ }  //  Up
#define _DOWN       { HID_DOWN,         0      /*, ' ' */ }  //  Down
#define _PGUP       { HID_PAGE_UP,      0      /*, ' ' */ }  //  PgUp
#define _PGDN       { HID_PAGE_DOWN,    0      /*, ' ' */ }  //  PgDn
#define _RIGHT      { HID_RIGHT,        0      /*, ' ' */ }  //  Right
#define _NUMLOCK    { HID_NUM_LOCK,   NUMLOCK  /*, ' ' */ }  //  NumLock

#define _ESC        { HID_ESC, 0 /*,    ' ' */ }  //  Esc
#define _F1         { HID_F1,  0 /*,    ' ' */ }  //  F1
#define _F2         { HID_F2,  0 /*,    ' ' */ }  //  F2
#define _F3         { HID_F3,  0 /*,    ' ' */ }  //  F3
#define _F4         { HID_F4,  0 /*,    ' ' */ }  //  F4
#define _F5         { HID_F5,  0 /*,    ' ' */ }  //  F5
#define _F6         { HID_F6,  0 /*,    ' ' */ }  //  F6
#define _F7         { HID_F7,  0 /*,    ' ' */ }  //  F7
#define _F8         { HID_F8,  0 /*,    ' ' */ }  //  F8
#define _F9         { HID_F9,  0 /*,    ' ' */ }  //  F9
#define _F10        { HID_F10, 0 /*,    ' ' */ }  //  F10
#define _F11        { HID_F11, 0 /*,    ' ' */ }  //  F11
#define _F12        { HID_F12, 0 /*,    ' ' */ }  //  F12
#define _F13        { HID_F13, 0 /*,    ' ' */ }  //  F13
#define _F14        { HID_F14, 0 /*,    ' ' */ }  //  F14
#define _F15        { HID_F15, 0 /*,    ' ' */ }  //  F15
#define _F16        { HID_F16, 0 /*,    ' ' */ }  //  F16
#define _F17        { HID_F17, 0 /*,    ' ' */ }  //  F17
#define _F18        { HID_F18, 0 /*,    ' ' */ }  //  F18
#define _F19        { HID_F19, 0 /*,    ' ' */ }  //  F19
#define _F20        { HID_F20, 0 /*,    ' ' */ }  //  F20
#define _F21        { HID_F21, 0 /*,    ' ' */ }  //  F21
#define _F22        { HID_F22, 0 /*,    ' ' */ }  //  F22
#define _F23        { HID_F23, 0 /*,    ' ' */ }  //  F23
#define _F24        { HID_F24, 0 /*,    ' ' */ }  //  F24

#define _EXEC    { HID_EXEC	    , 0 } // 0x74 -> 142 XF86Open
#define _HELP 	 { HID_HELP	    , 0 } // 0x75 -> 146 Help
#define _MENU    { HID_MENU	    , 0 } // 0x76 -> 138 SunProps
#define _SEL 	 { HID_SEL  	, 0 } // 0x77 -> 140 SunFront
#define _STOP 	 { HID_STOP	    , 0 } // 0x78 -> 136 Cancel

#define _X1 	 { HID_PRINTSCREEN    , 0 } // 0x46 70
#define _X2 	 { HID_SCROLL_LOCK    , 0 } // 0x47 71 WIN ok
#define _X3 	 { HID_PAUSE          , 0 } // 0x48 72 WIN ok
//#define _X4 	 { HID_NUM_LOCK       , 0 } // 0x53 83
//#define _X4 	 { HID_NUM_LOCK       , 0 } // 0x53 83
//#define _X5 	 { HID_KEYPAD_SLASH   , 0 } // 0x54 84
//#define _X9 	 { HID_KEYPAD_EQUAL   , 0 } // 0x67 103
#define _X5 	 { HID_AGAI, 0 }
#define _X6 	 { HID_UNDO, 0 } // nowin
#define _X7 	 { HID_CUT , 0 } // nowin
#define _X8 	 { HID_COPY, 0 } // nowin
#define _X9 	 { HID_PAST, 0 } // nowin

#define _X10	 { HID_APPLICATION    , 0 } // 0x65 101 WIN ok Menu
//#define _X_POWER { HID_MAC_POWER      , 0 } // 0x66 102
//#define _X8 	 { HID_KEYPAD_EQUAL   , 0 } // 0x67 103

#define _X11 	 { HID_INT1           , 0 } // 0x87
#define _X12 	 { HID_INT2           , 0 } // 0x88
#define _X13 	 { HID_INT3           , 0 } // 0x89
#define _X14 	 { HID_INT4           , 0 } // 0x8a
#define _CMDMODE { HID_CMDMODE  , 0 } // 0x8b -> International5
#define _X15 	 { HID_INT7           , 0 } // 0x8ca //nowin



#ifdef QWERTY
    /*---------                                ---------
    AltGr      ¹ ² ³ ¼ ½   { [ ] } \ ¸
    ~ ! @ # $ % ^ & * ( ) - +       shift    ° ! " § $ % & / ( ) = ? `
    ` 1 2 3 4 5 6 7 8 9 0 _ =       ROW1     ^ 1 2 3 4 5 6 7 8 9 0 ß ´
    -----                                    -----
    @   €
    Q W E R T Y U I O P { } |     shift      Q W E R T Z U I O P Ü *
    y         [ ] \     ROW2                 z         ü +
    -----                                    -----

    A S D F G H J K L : "         shift    A S D F G H J K L Ö Ä '
    ; '         ROW3                         ö ä #
    -----                                    -----
    |             µ
    Z X C V B N M < > ?           shift    > Y X C V B N M ; : _
    z             , . /           ROW4     < y             , . -
    -----                                    -----
    */

    #define _AMPERSAND { HID_7,         SHIFT  /*, '&' */ }
    #define _ASTERIX   { HID_8,         SHIFT  /*, '*' */ }
    #define _AT        { HID_2,         SHIFT  /*, '@' */ }
    #define _BSLASH    { HID_BSLASH,    0 /*,      '\\'*/ }
    #define _CARET     { HID_6,         SHIFT  /*, '&' */ }
    #define _COLON     { HID_SEMICOLON, SHIFT  /*, 'Ö' */ }
    #define _DQUOTE    { HID_QUOTE,     SHIFT  /*, '"' */ }
    #define _EQUAL     { HID_EQUAL,     0 /*,      '=' */ }
    #define _GREATER   { HID_PERIOD,    SHIFT  /*, '>' */ }
    #define _HASH      { HID_3,         SHIFT  /*, '#' */ }
    #define _L_BRACE   { HID_L_BRACKET, SHIFT  /*, '[' */ }
    #define _L_BRACKET { HID_L_BRACKET, 0 /*,      '{' */ }
    #define _LESS      { HID_COMMA ,    SHIFT  /*, '<' */ }
    #define _L_PAREN   { HID_9,         SHIFT  /*, '(' */ }
    #define _MINUS     { HID_MINUS,     0 /*,      '-' */ }
    #define _PLUS      { HID_EQUAL,     SHIFT  /*, '+' */ }
    #define _QUESTION  { HID_SLASH,     SHIFT  /*, '?' */ }
    #define _SQUOTE    { HID_QUOTE,     0 /*,      '\''*/ }
    #define _R_BRACE   { HID_R_BRACKET, SHIFT  /*, ']' */ }
    #define _R_BRACKET { HID_R_BRACKET, 0 /*,      '}' */ }
    #define _R_PAREN   { HID_0,         SHIFT  /*, ')' */ }
    #define _SCOLON    { HID_SEMICOLON, 0 /*,      ';' */ }
    #define _SLASH     { HID_SLASH,     0 /*,      '/' */ }
    #define _USCORE    { HID_MINUS,     SHIFT  /*, '_' */ }
    #define _y         { HID_Y,         0 /*,      'y' */ }
    #define _Y         { HID_Y,         SHIFT  /*, 'Y' */ }
    #define _z         { HID_Z,         0 /*,      'z' */ }
    #define _Z         { HID_Z,         SHIFT  /*, 'Z' */ }

    #define _DEGREE     _no
    #define _GRAVE      { HID_GRAVE,    0 /*,      '^' */ }
    #define _TILDE      { HID_GRAVE,    SHIFT  /*, '~' */ }
    #define _PIPE       { HID_BSLASH,   SHIFT  /*, '|' */ }

    // Umlauts not available
    #define _SSHARP     _no
    #define _a_UML      _no
    #define _A_UML      _no
    #define _O_UML      _no
    #define _o_UML      _no
    #define _U_UML      _no
    #define _u_UML      _no


#else //qwert_Z_

    #define _AMPERSAND  { HID_6,            SHIFT  /*, '&' */ }
    #define _ASTERIX    { HID_R_BRACKET,    SHIFT  /*, '*' */ }
    #define _AT         { HID_Q,            ALTGR  /*, '@' */ }
    #define _CARET      { HID_GRAVE,        0 /*,      '`' */ }
    #define _COLON      { HID_PERIOD,       SHIFT  /*, ':' */ }
    #define _DQUOTE     { HID_2,            SHIFT  /*, '"' */ }
    #define _EQUAL      { HID_0,            SHIFT  /*, '=' */ }
    #define _EURO       { HID_E,            ALTGR  /*, '€' */ }
    #define _GREATER    { HID_NON_US_2,     SHIFT  /*, '>' */ }
    #define _HASH       { HID_BSLASH,       0 /*,      '#' */ }
    #define _L_BRACE    { HID_7,            ALTGR  /*, '{' */ }
    #define _L_BRACKET  { HID_8,            ALTGR  /*, '[' */ }
    #define _LESS       { HID_NON_US_2,     0 /*,      '<' */ }
    #define _L_PAREN    { HID_8,            SHIFT  /*, '(' */ }
    #define _MINUS      { HID_SLASH,        0 /*,      '-' */ }
    #define _PLUS       { HID_R_BRACKET,    0 /*,      '+' */ }
    #define _QUESTION   { HID_MINUS,        SHIFT  /*, '?' */ }
    #define _R_BRACE    { HID_0,            ALTGR  /*, '}' */ }
    #define _R_BRACKET  { HID_9,            ALTGR  /*, ']' */ }
    #define _R_PAREN    { HID_9,            SHIFT  /*, ')' */ }
    #define _SCOLON     { HID_COMMA,        SHIFT  /*, ';' */ }
    #define _SLASH      { HID_7,            SHIFT  /*, '/' */ }
    #define _SQUOTE     { HID_NON_US_1,     SHIFT  /*, '\''*/ }
    #define _USCORE     { HID_SLASH,        SHIFT  /*, '_' */ }
    #define _y          { HID_Z,            0 /*,      'y' */ }
    #define _Y          { HID_Z,            SHIFT  /*, 'Y' */ }
    #define _z          { HID_Y,            0 /*,      'z' */ }
    #define _Z          { HID_Y,            SHIFT  /*, 'Z' */ }

    #define _BSLASH     { HID_MINUS,        ALTGR  /*, '\\'*/ }
    #define _TILDE      { HID_R_BRACKET,    ALTGR  /*, '~' */ }
    #define _PIPE       { HID_NON_US_2,     ALTGR  /*, '|' */ }
    #define _DEGREE     { HID_GRAVE,        SHIFT  /*, ' ' */ }
    #define _GRAVE      { HID_EQUAL,        SHIFT  /*, '^' */ }

    #define _SSHARP     { HID_MINUS,        0 /*,      'S' */ }
    #define _a_UML      { HID_QUOTE,        0 /*,      228 */ }
    #define _A_UML      { HID_QUOTE,        SHIFT  /*, 196 */ }
    #define _o_UML      { HID_SEMICOLON,    0 /*,      246 */ }
    #define _O_UML      { HID_SEMICOLON,    SHIFT  /*, 214 */ }
    #define _u_UML      { HID_L_BRACKET,    0 /*,      252 */ }
    #define _U_UML      { HID_L_BRACKET,    SHIFT  /*, 220 */ }

#endif // QWERTY or QWERTZ


typedef struct {
    uint8_t Button;
    int8_t X;
    int8_t Y;
    int8_t V; /// vertical wheel
    int8_t H; /// horizontal wheel
} __attribute__((packed)) USB_WheelMouseReport_Data_t;