Kiibohd Controller
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.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

usb_keyboard.c 6.7KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279
  1. /* Teensyduino Core Library
  2. * http://www.pjrc.com/teensy/
  3. * Copyright (c) 2013 PJRC.COM, LLC.
  4. * Modifications by Jacob Alexander 2013-2015
  5. *
  6. * Permission is hereby granted, free of charge, to any person obtaining
  7. * a copy of this software and associated documentation files (the
  8. * "Software"), to deal in the Software without restriction, including
  9. * without limitation the rights to use, copy, modify, merge, publish,
  10. * distribute, sublicense, and/or sell copies of the Software, and to
  11. * permit persons to whom the Software is furnished to do so, subject to
  12. * the following conditions:
  13. *
  14. * 1. The above copyright notice and this permission notice shall be
  15. * included in all copies or substantial portions of the Software.
  16. *
  17. * 2. If the Software is incorporated into a build system that allows
  18. * selection among a list of target devices, then similar target
  19. * devices manufactured by PJRC.COM must be included in the list of
  20. * target devices and selectable in the same manner.
  21. *
  22. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23. * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25. * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  26. * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  27. * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  28. * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  29. * SOFTWARE.
  30. */
  31. // ----- Includes -----
  32. // Compiler Includes
  33. #include <string.h> // for memcpy()
  34. // Project Includes
  35. #include <Lib/OutputLib.h>
  36. #include <print.h>
  37. // Local Includes
  38. #include "usb_dev.h"
  39. #include "usb_keyboard.h"
  40. // ----- Defines -----
  41. // Maximum number of transmit packets to queue so we don't starve other endpoints for memory
  42. #define TX_PACKET_LIMIT 4
  43. // When the PC isn't listening, how long do we wait before discarding data?
  44. #define TX_TIMEOUT_MSEC 50
  45. #if F_CPU == 168000000
  46. #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 1100)
  47. #elif F_CPU == 144000000
  48. #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 932)
  49. #elif F_CPU == 120000000
  50. #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 764)
  51. #elif F_CPU == 96000000
  52. #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 596)
  53. #elif F_CPU == 72000000
  54. #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 512)
  55. #elif F_CPU == 48000000
  56. #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 428)
  57. #elif F_CPU == 24000000
  58. #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 262)
  59. #endif
  60. // ----- Variables -----
  61. static uint8_t transmit_previous_timeout = 0;
  62. // ----- Functions -----
  63. // send the contents of keyboard_keys and keyboard_modifier_keys
  64. void usb_keyboard_send()
  65. {
  66. uint32_t wait_count = 0;
  67. usb_packet_t *tx_packet;
  68. // Wait till ready
  69. while ( 1 )
  70. {
  71. if ( !usb_configuration )
  72. {
  73. erro_print("USB not configured...");
  74. return;
  75. }
  76. if ( USBKeys_Protocol == 0 ) // Boot Mode
  77. {
  78. if ( usb_tx_packet_count( KEYBOARD_ENDPOINT ) < TX_PACKET_LIMIT )
  79. {
  80. tx_packet = usb_malloc();
  81. if ( tx_packet )
  82. break;
  83. }
  84. }
  85. else if ( USBKeys_Protocol == 1 ) // NKRO Mode
  86. {
  87. if ( usb_tx_packet_count( NKRO_KEYBOARD_ENDPOINT ) < TX_PACKET_LIMIT )
  88. {
  89. tx_packet = usb_malloc();
  90. if ( tx_packet )
  91. break;
  92. }
  93. }
  94. else if ( USBKeys_Changed &
  95. ( USBKeyChangeState_System | USBKeyChangeState_Consumer )
  96. )
  97. {
  98. if ( usb_tx_packet_count( SYS_CTRL_ENDPOINT ) < TX_PACKET_LIMIT )
  99. {
  100. tx_packet = usb_malloc();
  101. if ( tx_packet )
  102. break;
  103. }
  104. }
  105. if ( ++wait_count > TX_TIMEOUT || transmit_previous_timeout )
  106. {
  107. transmit_previous_timeout = 1;
  108. warn_print("USB Transmit Timeout...restarting device");
  109. USBKeys_Changed = USBKeyChangeState_None; // Indicate packet lost
  110. usb_device_software_reset();
  111. return;
  112. }
  113. yield();
  114. }
  115. transmit_previous_timeout = 0;
  116. // Pointer to USB tx packet buffer
  117. uint8_t *tx_buf = tx_packet->buf;
  118. // Check system control keys
  119. if ( USBKeys_Changed & USBKeyChangeState_System )
  120. {
  121. if ( Output_DebugMode )
  122. {
  123. print("SysCtrl[");
  124. printHex_op( USBKeys_SysCtrl, 2 );
  125. print( "] " NL );
  126. }
  127. *tx_buf++ = 0x02; // ID
  128. *tx_buf = USBKeys_SysCtrl;
  129. tx_packet->len = 2;
  130. // Send USB Packet
  131. usb_tx( SYS_CTRL_ENDPOINT, tx_packet );
  132. USBKeys_Changed &= ~USBKeyChangeState_System; // Mark sent
  133. return;
  134. }
  135. // Check consumer control keys
  136. if ( USBKeys_Changed & USBKeyChangeState_Consumer )
  137. {
  138. if ( Output_DebugMode )
  139. {
  140. print("ConsCtrl[");
  141. printHex_op( USBKeys_ConsCtrl, 2 );
  142. print( "] " NL );
  143. }
  144. *tx_buf++ = 0x03; // ID
  145. *tx_buf++ = (uint8_t)(USBKeys_ConsCtrl & 0x00FF);
  146. *tx_buf = (uint8_t)(USBKeys_ConsCtrl >> 8);
  147. tx_packet->len = 3;
  148. // Send USB Packet
  149. usb_tx( SYS_CTRL_ENDPOINT, tx_packet );
  150. USBKeys_Changed &= ~USBKeyChangeState_Consumer; // Mark sent
  151. return;
  152. }
  153. switch ( USBKeys_Protocol )
  154. {
  155. // Send boot keyboard interrupt packet(s)
  156. case 0:
  157. // USB Boot Mode debug output
  158. if ( Output_DebugMode )
  159. {
  160. dbug_msg("Boot USB: ");
  161. printHex_op( USBKeys_Modifiers, 2 );
  162. print(" ");
  163. printHex( 0 );
  164. print(" ");
  165. printHex_op( USBKeys_Keys[0], 2 );
  166. printHex_op( USBKeys_Keys[1], 2 );
  167. printHex_op( USBKeys_Keys[2], 2 );
  168. printHex_op( USBKeys_Keys[3], 2 );
  169. printHex_op( USBKeys_Keys[4], 2 );
  170. printHex_op( USBKeys_Keys[5], 2 );
  171. print( NL );
  172. }
  173. // Boot Mode
  174. *tx_buf++ = USBKeys_Modifiers;
  175. *tx_buf++ = 0;
  176. memcpy( tx_buf, USBKeys_Keys, USB_BOOT_MAX_KEYS );
  177. tx_packet->len = 8;
  178. // Send USB Packet
  179. usb_tx( KEYBOARD_ENDPOINT, tx_packet );
  180. USBKeys_Changed = USBKeyChangeState_None;
  181. break;
  182. // Send NKRO keyboard interrupts packet(s)
  183. case 1:
  184. if ( Output_DebugMode )
  185. {
  186. dbug_msg("NKRO USB: ");
  187. }
  188. // Standard HID Keyboard
  189. if ( USBKeys_Changed )
  190. {
  191. // USB NKRO Debug output
  192. if ( Output_DebugMode )
  193. {
  194. printHex_op( USBKeys_Modifiers, 2 );
  195. print(" ");
  196. for ( uint8_t c = 0; c < 6; c++ )
  197. printHex_op( USBKeys_Keys[ c ], 2 );
  198. print(" ");
  199. for ( uint8_t c = 6; c < 20; c++ )
  200. printHex_op( USBKeys_Keys[ c ], 2 );
  201. print(" ");
  202. printHex_op( USBKeys_Keys[20], 2 );
  203. print(" ");
  204. for ( uint8_t c = 21; c < 27; c++ )
  205. printHex_op( USBKeys_Keys[ c ], 2 );
  206. print( NL );
  207. }
  208. tx_packet->len = 0;
  209. // Modifiers
  210. *tx_buf++ = 0x01; // ID
  211. *tx_buf++ = USBKeys_Modifiers;
  212. tx_packet->len += 2;
  213. // 4-49 (first 6 bytes)
  214. memcpy( tx_buf, USBKeys_Keys, 6 );
  215. tx_buf += 6;
  216. tx_packet->len += 6;
  217. // 51-155 (Middle 14 bytes)
  218. memcpy( tx_buf, USBKeys_Keys + 6, 14 );
  219. tx_buf += 14;
  220. tx_packet->len += 14;
  221. // 157-164 (Next byte)
  222. memcpy( tx_buf, USBKeys_Keys + 20, 1 );
  223. tx_buf += 1;
  224. tx_packet->len += 1;
  225. // 176-221 (last 6 bytes)
  226. memcpy( tx_buf, USBKeys_Keys + 21, 6 );
  227. tx_packet->len += 6;
  228. // Send USB Packet
  229. usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
  230. USBKeys_Changed = USBKeyChangeState_None; // Mark sent
  231. }
  232. break;
  233. }
  234. return;
  235. }