/* Copyright 2011,2012 Jun Wako 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 2 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 . */ #ifndef REPORT_H #define REPORT_H #include #include "keycode.h" /* report id */ #define REPORT_ID_MOUSE 1 #define REPORT_ID_SYSTEM 2 #define REPORT_ID_CONSUMER 3 /* mouse buttons */ #define MOUSE_BTN1 (1<<0) #define MOUSE_BTN2 (1<<1) #define MOUSE_BTN3 (1<<2) #define MOUSE_BTN4 (1<<3) #define MOUSE_BTN5 (1<<4) /* Consumer Page(0x0C) * following are supported by Windows: http://msdn.microsoft.com/en-us/windows/hardware/gg463372.aspx */ #define AUDIO_MUTE 0x00E2 #define AUDIO_VOL_UP 0x00E9 #define AUDIO_VOL_DOWN 0x00EA #define TRANSPORT_NEXT_TRACK 0x00B5 #define TRANSPORT_PREV_TRACK 0x00B6 #define TRANSPORT_STOP 0x00B7 #define TRANSPORT_STOP_EJECT 0x00CC #define TRANSPORT_PLAY_PAUSE 0x00CD /* application launch */ #define APPLAUNCH_CC_CONFIG 0x0183 #define APPLAUNCH_EMAIL 0x018A #define APPLAUNCH_CALCULATOR 0x0192 #define APPLAUNCH_LOCAL_BROWSER 0x0194 /* application control */ #define APPCONTROL_SEARCH 0x0221 #define APPCONTROL_HOME 0x0223 #define APPCONTROL_BACK 0x0224 #define APPCONTROL_FORWARD 0x0225 #define APPCONTROL_STOP 0x0226 #define APPCONTROL_REFRESH 0x0227 #define APPCONTROL_BOOKMARKS 0x022A /* supplement for Bluegiga iWRAP HID(not supported by Windows?) */ #define APPLAUNCH_LOCK 0x019E #define TRANSPORT_RECORD 0x00B2 #define TRANSPORT_FAST_FORWARD 0x00B3 #define TRANSPORT_REWIND 0x00B4 #define TRANSPORT_EJECT 0x00B8 #define APPCONTROL_MINIMIZE 0x0206 /* Generic Desktop Page(0x01) - system power control */ #define SYSTEM_POWER_DOWN 0x0081 #define SYSTEM_SLEEP 0x0082 #define SYSTEM_WAKE_UP 0x0083 /* key report size(NKRO or boot mode) */ #if defined(PROTOCOL_PJRC) && defined(NKRO_ENABLE) # include "usb.h" # define KEYBOARD_REPORT_SIZE KBD2_SIZE # define KEYBOARD_REPORT_KEYS (KBD2_SIZE - 2) # define KEYBOARD_REPORT_BITS (KBD2_SIZE - 1) #elif defined(PROTOCOL_LUFA) && defined(NKRO_ENABLE) # include "protocol/lufa/descriptor.h" # define KEYBOARD_REPORT_SIZE NKRO_EPSIZE # define KEYBOARD_REPORT_KEYS (NKRO_EPSIZE - 2) # define KEYBOARD_REPORT_BITS (NKRO_EPSIZE - 1) #elif defined(PROTOCOL_CHIBIOS) && defined(NKRO_ENABLE) # include "protocol/chibios/usb_main.h" # define KEYBOARD_REPORT_SIZE NKRO_EPSIZE # define KEYBOARD_REPORT_KEYS (NKRO_EPSIZE - 2) # define KEYBOARD_REPORT_BITS (NKRO_EPSIZE - 1) #else # define KEYBOARD_REPORT_SIZE 8 # define KEYBOARD_REPORT_KEYS 6 #endif #ifdef __cplusplus extern "C" { #endif /* * keyboard report is 8-byte array retains state of 8 modifiers and 6 keys. * * byte |0 |1 |2 |3 |4 |5 |6 |7 * -----+--------+--------+--------+--------+--------+--------+--------+-------- * desc |mods |reserved|keys[0] |keys[1] |keys[2] |keys[3] |keys[4] |keys[5] * * It is exended to 16 bytes to retain 120keys+8mods when NKRO mode. * * byte |0 |1 |2 |3 |4 |5 |6 |7 ... |15 * -----+--------+--------+--------+--------+--------+--------+--------+-------- +-------- * desc |mods |bits[0] |bits[1] |bits[2] |bits[3] |bits[4] |bits[5] |bits[6] ... |bit[14] * * mods retains state of 8 modifiers. * * bit |0 |1 |2 |3 |4 |5 |6 |7 * -----+--------+--------+--------+--------+--------+--------+--------+-------- * desc |Lcontrol|Lshift |Lalt |Lgui |Rcontrol|Rshift |Ralt |Rgui * */ typedef union { uint8_t raw[KEYBOARD_REPORT_SIZE]; struct { uint8_t mods; uint8_t reserved; uint8_t keys[KEYBOARD_REPORT_KEYS]; }; #ifdef NKRO_ENABLE struct { uint8_t mods; uint8_t bits[KEYBOARD_REPORT_BITS]; } nkro; #endif } __attribute__ ((packed)) report_keyboard_t; /* typedef struct { uint8_t mods; uint8_t reserved; uint8_t keys[REPORT_KEYS]; } __attribute__ ((packed)) report_keyboard_t; */ typedef struct { uint8_t buttons; int8_t x; int8_t y; int8_t v; int8_t h; } __attribute__ ((packed)) report_mouse_t; /* keycode to system usage */ #define KEYCODE2SYSTEM(key) \ (key == KC_SYSTEM_POWER ? SYSTEM_POWER_DOWN : \ (key == KC_SYSTEM_SLEEP ? SYSTEM_SLEEP : \ (key == KC_SYSTEM_WAKE ? SYSTEM_WAKE_UP : 0))) /* keycode to consumer usage */ #define KEYCODE2CONSUMER(key) \ (key == KC_AUDIO_MUTE ? AUDIO_MUTE : \ (key == KC_AUDIO_VOL_UP ? AUDIO_VOL_UP : \ (key == KC_AUDIO_VOL_DOWN ? AUDIO_VOL_DOWN : \ (key == KC_MEDIA_NEXT_TRACK ? TRANSPORT_NEXT_TRACK : \ (key == KC_MEDIA_PREV_TRACK ? TRANSPORT_PREV_TRACK : \ (key == KC_MEDIA_FAST_FORWARD ? TRANSPORT_FAST_FORWARD : \ (key == KC_MEDIA_REWIND ? TRANSPORT_REWIND : \ (key == KC_MEDIA_STOP ? TRANSPORT_STOP : \ (key == KC_MEDIA_EJECT ? TRANSPORT_STOP_EJECT : \ (key == KC_MEDIA_PLAY_PAUSE ? TRANSPORT_PLAY_PAUSE : \ (key == KC_MEDIA_SELECT ? APPLAUNCH_CC_CONFIG : \ (key == KC_MAIL ? APPLAUNCH_EMAIL : \ (key == KC_CALCULATOR ? APPLAUNCH_CALCULATOR : \ (key == KC_MY_COMPUTER ? APPLAUNCH_LOCAL_BROWSER : \ (key == KC_WWW_SEARCH ? APPCONTROL_SEARCH : \ (key == KC_WWW_HOME ? APPCONTROL_HOME : \ (key == KC_WWW_BACK ? APPCONTROL_BACK : \ (key == KC_WWW_FORWARD ? APPCONTROL_FORWARD : \ (key == KC_WWW_STOP ? APPCONTROL_STOP : \ (key == KC_WWW_REFRESH ? APPCONTROL_REFRESH : \ (key == KC_WWW_FAVORITES ? APPCONTROL_BOOKMARKS : 0))))))))))))))))))))) #ifdef __cplusplus } #endif #endif