tmk_core/protocol/chibios/usb_main.h

   1 /*
   2  * (c) 2015 flabberast <s3+flabbergast@sdfeu.org>
   3  *
   4  * Based on the following work:
   5  *  - Guillaume Duc's raw hid example (MIT License)
   6  *    https://github.com/guiduc/usb-hid-chibios-example
   7  *  - PJRC Teensy examples (MIT License)
   8  *    https://www.pjrc.com/teensy/usb_keyboard.html
   9  *  - hasu's TMK keyboard code (GPL v2 and some code Modified BSD)
  10  *    https://github.com/tmk/tmk_keyboard/
  11  *  - ChibiOS demo code (Apache 2.0 License)
  12  *    http://www.chibios.org
  13  *
  14  * Since some GPL'd code is used, this work is licensed under
  15  * GPL v2 or later.
  16  */
  17
  18
  19 #ifndef _USB_MAIN_H_
  20 #define _USB_MAIN_H_
  21
  22 // TESTING
  23 // extern uint8_t blinkLed;
  24
  25 #include "ch.h"
  26 #include "hal.h"
  27
  28 /* -------------------------
  29  * General USB driver header
  30  * -------------------------
  31  */
  32
  33 /* The USB driver to use */
  34 #define USB_DRIVER USBD1
  35
  36 /* Initialize the USB driver and bus */
  37 void init_usb_driver(USBDriver *usbp);
  38
  39 /* Send remote wakeup packet */
  40 void send_remote_wakeup(USBDriver *usbp);
  41
  42 /* ---------------
  43  * Keyboard header
  44  * ---------------
  45  */
  46
  47 /* main keyboard (6kro) */
  48 #define KBD_INTERFACE   0
  49 #define KBD_ENDPOINT    1
  50 #define KBD_EPSIZE      8
  51 #define KBD_REPORT_KEYS (KBD_EPSIZE - 2)
  52
  53 /* secondary keyboard */
  54 #ifdef NKRO_ENABLE
  55 #define NKRO_INTERFACE    4
  56 #define NKRO_ENDPOINT     5
  57 #define NKRO_EPSIZE       16
  58 #define NKRO_REPORT_KEYS  (NKRO_EPSIZE - 1)
  59 #endif
  60
  61 /* extern report_keyboard_t keyboard_report_sent; */
  62
  63 /* keyboard IN request callback handler */
  64 void kbd_in_cb(USBDriver *usbp, usbep_t ep);
  65
  66 /* start-of-frame handler */
  67 void kbd_sof_cb(USBDriver *usbp);
  68
  69 #ifdef NKRO_ENABLE
  70 /* nkro IN callback hander */
  71 void nkro_in_cb(USBDriver *usbp, usbep_t ep);
  72 #endif /* NKRO_ENABLE */
  73
  74 /* ------------
  75  * Mouse header
  76  * ------------
  77  */
  78
  79 #ifdef MOUSE_ENABLE
  80
  81 #define MOUSE_INTERFACE         1
  82 #define MOUSE_ENDPOINT          2
  83 #define MOUSE_EPSIZE            8
  84
  85 /* mouse IN request callback handler */
  86 void mouse_in_cb(USBDriver *usbp, usbep_t ep);
  87 #endif /* MOUSE_ENABLE */
  88
  89 /* ---------------
  90  * Extrakey header
  91  * ---------------
  92  */
  93
  94 #ifdef EXTRAKEY_ENABLE
  95
  96 #define EXTRA_INTERFACE         3
  97 #define EXTRA_ENDPOINT          4
  98 #define EXTRA_EPSIZE            8
  99
 100 /* extrakey IN request callback handler */
 101 void extra_in_cb(USBDriver *usbp, usbep_t ep);
 102
 103 /* extra report structure */
 104 typedef struct {
 105   uint8_t report_id;
 106   uint16_t usage;
 107 } __attribute__ ((packed)) report_extra_t;
 108 #endif /* EXTRAKEY_ENABLE */
 109
 110 /* --------------
 111  * Console header
 112  * --------------
 113  */
 114
 115 #ifdef CONSOLE_ENABLE
 116
 117 #define CONSOLE_INTERFACE      2
 118 #define CONSOLE_ENDPOINT       3
 119 #define CONSOLE_EPSIZE         16
 120
 121 /* Number of IN reports that can be stored inside the output queue */
 122 #define CONSOLE_QUEUE_CAPACITY 4
 123
 124 /* Console flush time */
 125 #define CONSOLE_FLUSH_MS 50
 126
 127 /* Putchar over the USB console */
 128 int8_t sendchar(uint8_t c);
 129
 130 /* Flush output (send everything immediately) */
 131 void console_flush_output(void);
 132
 133 /* console IN request callback handler */
 134 void console_in_cb(USBDriver *usbp, usbep_t ep);
 135 #endif /* CONSOLE_ENABLE */
 136
 137 void sendchar_pf(void *p, char c);
 138
 139 #endif /* _USB_MAIN_H_ */