123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280 |
- /*
- * Based on Obdev's AVRUSB code and under the same license.
- *
- * TODO: Make a proper file header. :-)
- */
- #ifndef __UsbKeyboard_h__
- #define __UsbKeyboard_h__
- #include <avr/pgmspace.h>
- #include <avr/interrupt.h>
- #include <string.h>
- #include "usbdrv.h"
- // TODO: Work around Arduino 12 issues better.
- //#include <WConstants.h>
- //#undef int()
- typedef uint8_t byte;
- #define BUFFER_SIZE 7 // Minimum of 2: 1 for modifiers + 1 for keystroke
- static uchar idleRate; // in 4 ms units
- /* We use a simplifed keyboard report descriptor which does not support the
- * boot protocol. We don't allow setting status LEDs and but we do allow
- * simultaneous key presses.
- * The report descriptor has been created with usb.org's "HID Descriptor Tool"
- * which can be downloaded from http://www.usb.org/developers/hidpage/.
- * Redundant entries (such as LOGICAL_MINIMUM and USAGE_PAGE) have been omitted
- * for the second INPUT item.
- */
- const PROGMEM char usbHidReportDescriptor[35] = { /* USB report descriptor */
- 0x05, 0x01, // USAGE_PAGE (Generic Desktop)
- 0x09, 0x06, // USAGE (Keyboard)
- 0xa1, 0x01, // COLLECTION (Application)
- 0x05, 0x07, // USAGE_PAGE (Keyboard)
- 0x19, 0xe0, // USAGE_MINIMUM (Keyboard LeftControl)
- 0x29, 0xe7, // USAGE_MAXIMUM (Keyboard Right GUI)
- 0x15, 0x00, // LOGICAL_MINIMUM (0)
- 0x25, 0x01, // LOGICAL_MAXIMUM (1)
- 0x75, 0x01, // REPORT_SIZE (1)
- 0x95, 0x08, // REPORT_COUNT (8)
- 0x81, 0x02, // INPUT (Data,Var,Abs)
- 0x95, BUFFER_SIZE-1, // REPORT_COUNT (simultaneous keystrokes)
- 0x75, 0x08, // REPORT_SIZE (8)
- 0x25, 0x65, // LOGICAL_MAXIMUM (101)
- 0x19, 0x00, // USAGE_MINIMUM (Reserved (no event indicated))
- 0x29, 0x65, // USAGE_MAXIMUM (Keyboard Application)
- 0x81, 0x00, // INPUT (Data,Ary,Abs)
- 0xc0 // END_COLLECTION
- };
- typedef struct
- {
- uint8_t modifiers;
- uint8_t keys[6];
- } KeyReport;
- /* Keyboard usage values, see usb.org's HID-usage-tables document, chapter
- * 10 Keyboard/Keypad Page for more codes.
- */
- #define MOD_CONTROL_LEFT (1<<0)
- #define MOD_SHIFT_LEFT (1<<1)
- #define MOD_ALT_LEFT (1<<2)
- #define MOD_GUI_LEFT (1<<3)
- #define MOD_CONTROL_RIGHT (1<<4)
- #define MOD_SHIFT_RIGHT (1<<5)
- #define MOD_ALT_RIGHT (1<<6)
- #define MOD_GUI_RIGHT (1<<7)
- #define KEY_A 4
- #define KEY_B 5
- #define KEY_C 6
- #define KEY_D 7
- #define KEY_E 8
- #define KEY_F 9
- #define KEY_G 10
- #define KEY_H 11
- #define KEY_I 12
- #define KEY_J 13
- #define KEY_K 14
- #define KEY_L 15
- #define KEY_M 16
- #define KEY_N 17
- #define KEY_O 18
- #define KEY_P 19
- #define KEY_Q 20
- #define KEY_R 21
- #define KEY_S 22
- #define KEY_T 23
- #define KEY_U 24
- #define KEY_V 25
- #define KEY_W 26
- #define KEY_X 27
- #define KEY_Y 28
- #define KEY_Z 29
- #define KEY_1 30
- #define KEY_2 31
- #define KEY_3 32
- #define KEY_4 33
- #define KEY_5 34
- #define KEY_6 35
- #define KEY_7 36
- #define KEY_8 37
- #define KEY_9 38
- #define KEY_0 39
- #define KEY_ENTER 40
- #define KEY_SPACE 44
- #define KEY_F1 58
- #define KEY_F2 59
- #define KEY_F3 60
- #define KEY_F4 61
- #define KEY_F5 62
- #define KEY_F6 63
- #define KEY_F7 64
- #define KEY_F8 65
- #define KEY_F9 66
- #define KEY_F10 67
- #define KEY_F11 68
- #define KEY_F12 69
- #define KEY_ARROW_LEFT 0x50
- class UsbKeyboardDevice {
- public:
- UsbKeyboardDevice () {
- PORTD = 0; // TODO: Only for USB pins?
- DDRD |= ~USBMASK;
- cli();
- usbDeviceDisconnect();
- _delay_ms(250);
- usbDeviceConnect();
- usbInit();
-
- sei();
- // TODO: Remove the next two lines once we fix
- // missing first keystroke bug properly.
- memset(reportBuffer, 0, sizeof(reportBuffer));
- usbSetInterrupt(reportBuffer, sizeof(reportBuffer));
- }
-
- void update() {
- usbPoll();
- }
-
- void sendKeyStroke(byte keyStroke) {
- sendKeyStroke(keyStroke, 0);
- }
- void sendKeyStroke(byte keyStroke, byte modifiers) {
-
- while (!usbInterruptIsReady()) {
- // Note: We wait until we can send keystroke
- // so we know the previous keystroke was
- // sent.
- }
-
- memset(reportBuffer, 0, sizeof(reportBuffer));
- reportBuffer[0] = modifiers;
- reportBuffer[1] = keyStroke;
-
- usbSetInterrupt(reportBuffer, sizeof(reportBuffer));
- while (!usbInterruptIsReady()) {
- // Note: We wait until we can send keystroke
- // so we know the previous keystroke was
- // sent.
- }
-
- // This stops endlessly repeating keystrokes:
- memset(reportBuffer, 0, sizeof(reportBuffer));
- usbSetInterrupt(reportBuffer, sizeof(reportBuffer));
- }
-
- size_t press(uint8_t k)
- {
- uint8_t i, j;
- // Add k to the key report only if it's not already present
- // and if there is an empty slot.
- for(j = 0; j < sizeof(_keyReport.keys); j++) {
- if(_keyReport.keys[j] == k) {
- break;
- }
- }
- if (j == sizeof(_keyReport.keys)) {
- for (i = 0; i < sizeof(_keyReport.keys); i++) {
- if (_keyReport.keys[i] == 0x00) {
- _keyReport.keys[i] = k;
- break;
- }
- }
- if (i == sizeof(_keyReport.keys)) {
- return 0;
- }
- }
- usbSetInterrupt((uint8_t*)&_keyReport, sizeof(_keyReport));
- return 1;
- }
- size_t release(uint8_t k)
- {
- uint8_t i;
- // Test the key report to see if k is present. Clear it if it exists.
- // Check all positions in case the key is present more than once (which it shouldn't be)
- for (i = 0; i < sizeof(_keyReport.keys); i++) {
- if (0 != k && _keyReport.keys[i] == k) {
- _keyReport.keys[i] = 0x00;
- }
- }
- usbSetInterrupt((uint8_t*)&_keyReport, sizeof(_keyReport));
- return 1;
- }
- KeyReport _keyReport;
- //private: TODO: Make friend?
- uchar reportBuffer[4]; // buffer for HID reports [ 1 modifier byte + (len-1) key strokes]
- };
- UsbKeyboardDevice UsbKeyboard = UsbKeyboardDevice();
- #ifdef __cplusplus
- extern "C"{
- #endif
- // USB_PUBLIC uchar usbFunctionSetup
- uchar usbFunctionSetup(uchar data[8])
- {
- usbRequest_t *rq = (usbRequest_t *)((void *)data);
- usbMsgPtr = UsbKeyboard.reportBuffer; //
- if((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS){
- /* class request type */
- if(rq->bRequest == USBRQ_HID_GET_REPORT){
- /* wValue: ReportType (highbyte), ReportID (lowbyte) */
- /* we only have one report type, so don't look at wValue */
- // TODO: Ensure it's okay not to return anything here?
- return 0;
- }else if(rq->bRequest == USBRQ_HID_GET_IDLE){
- // usbMsgPtr = &idleRate;
- // return 1;
- return 0;
- }else if(rq->bRequest == USBRQ_HID_SET_IDLE){
- idleRate = rq->wValue.bytes[1];
- }
- }else{
- /* no vendor specific requests implemented */
- }
- return 0;
- }
- #ifdef __cplusplus
- } // extern "C"
- #endif
- #endif // __UsbKeyboard_h__
|