Keyboard firmwares for Atmel AVR and Cortex-M
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

usb_main.h 3.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. /*
  2. * (c) 2015 flabberast <[email protected]>
  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. #ifndef _USB_MAIN_H_
  18. #define _USB_MAIN_H_
  19. // TESTING
  20. // extern uint8_t blinkLed;
  21. #include "ch.h"
  22. #include "hal.h"
  23. /* -------------------------
  24. * General USB driver header
  25. * -------------------------
  26. */
  27. /* The USB driver to use */
  28. #define USB_DRIVER USBD1
  29. /* Initialize the USB driver and bus */
  30. void init_usb_driver(USBDriver *usbp);
  31. /* Send remote wakeup packet */
  32. void send_remote_wakeup(USBDriver *usbp);
  33. /* ---------------
  34. * Keyboard header
  35. * ---------------
  36. */
  37. /* main keyboard (6kro) */
  38. #define KBD_INTERFACE 0
  39. #define KBD_ENDPOINT 1
  40. #define KBD_EPSIZE 8
  41. #define KBD_REPORT_KEYS (KBD_EPSIZE - 2)
  42. /* secondary keyboard */
  43. #ifdef NKRO_ENABLE
  44. #define NKRO_INTERFACE 4
  45. #define NKRO_ENDPOINT 5
  46. #define NKRO_EPSIZE 16
  47. #define NKRO_REPORT_KEYS (NKRO_EPSIZE - 1)
  48. #endif
  49. /* this defines report_keyboard_t and computes REPORT_SIZE defines */
  50. // #include "report.h"
  51. /* extern report_keyboard_t keyboard_report_sent; */
  52. /* keyboard IN request callback handler */
  53. void kbd_in_cb(USBDriver *usbp, usbep_t ep);
  54. /* start-of-frame handler */
  55. void kbd_sof_cb(USBDriver *usbp);
  56. #ifdef NKRO_ENABLE
  57. /* nkro IN callback hander */
  58. void nkro_in_cb(USBDriver *usbp, usbep_t ep);
  59. #endif /* NKRO_ENABLE */
  60. /* ------------
  61. * Mouse header
  62. * ------------
  63. */
  64. #ifdef MOUSE_ENABLE
  65. #define MOUSE_INTERFACE 1
  66. #define MOUSE_ENDPOINT 2
  67. #define MOUSE_EPSIZE 8
  68. /* mouse IN request callback handler */
  69. void mouse_in_cb(USBDriver *usbp, usbep_t ep);
  70. #endif /* MOUSE_ENABLE */
  71. /* ---------------
  72. * Extrakey header
  73. * ---------------
  74. */
  75. #ifdef EXTRAKEY_ENABLE
  76. #define EXTRA_INTERFACE 3
  77. #define EXTRA_ENDPOINT 4
  78. #define EXTRA_EPSIZE 8
  79. /* extrakey IN request callback handler */
  80. void extra_in_cb(USBDriver *usbp, usbep_t ep);
  81. /* extra report structure */
  82. typedef struct {
  83. uint8_t report_id;
  84. uint16_t usage;
  85. } __attribute__ ((packed)) report_extra_t;
  86. #endif /* EXTRAKEY_ENABLE */
  87. /* --------------
  88. * Console header
  89. * --------------
  90. */
  91. #ifdef CONSOLE_ENABLE
  92. #define CONSOLE_INTERFACE 2
  93. #define CONSOLE_ENDPOINT 3
  94. #define CONSOLE_EPSIZE 16
  95. /* Number of IN reports that can be stored inside the output queue */
  96. #define CONSOLE_QUEUE_CAPACITY 2
  97. #define CONSOLE_QUEUE_BUFFER_SIZE (CONSOLE_QUEUE_CAPACITY * CONSOLE_EPSIZE)
  98. /* Console flush time */
  99. #define CONSOLE_FLUSH_MS 50
  100. /* Putchar over the USB console */
  101. int8_t sendchar(uint8_t c);
  102. /* Flush output (send everything immediately) */
  103. void console_flush_output(void);
  104. /* console IN request callback handler */
  105. void console_in_cb(USBDriver *usbp, usbep_t ep);
  106. #endif /* CONSOLE_ENABLE */
  107. void sendchar_pf(void *p, char c);
  108. #endif /* _USB_MAIN_H_ */