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.

output_com.c 22KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855
  1. /* Copyright (C) 2011-2016 by Jacob Alexander
  2. *
  3. * Permission is hereby granted, free of charge, to any person obtaining a copy
  4. * of this software and associated documentation files (the "Software"), to deal
  5. * in the Software without restriction, including without limitation the rights
  6. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  7. * copies of the Software, and to permit persons to whom the Software is
  8. * furnished to do so, subject to the following conditions:
  9. *
  10. * The above copyright notice and this permission notice shall be included in
  11. * all copies or substantial portions of the Software.
  12. *
  13. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19. * THE SOFTWARE.
  20. */
  21. // ----- Includes -----
  22. // Compiler Includes
  23. #include <Lib/OutputLib.h>
  24. // Project Includes
  25. #include <cli.h>
  26. #include <led.h>
  27. #include <print.h>
  28. #include <scan_loop.h>
  29. // USB Includes
  30. #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
  31. #include "avr/usb_keyboard_serial.h"
  32. #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_)
  33. #include "arm/usb_dev.h"
  34. #include "arm/usb_keyboard.h"
  35. #include "arm/usb_serial.h"
  36. #include "arm/usb_mouse.h"
  37. #endif
  38. // KLL
  39. #include <kll_defs.h>
  40. // Local Includes
  41. #include "output_com.h"
  42. // ----- Macros -----
  43. // Used to build a bitmap lookup table from a byte addressable array
  44. #define byteLookup( byte ) \
  45. case (( byte ) * ( 8 )): bytePosition = byte; byteShift = 0; break; \
  46. case (( byte ) * ( 8 ) + ( 1 )): bytePosition = byte; byteShift = 1; break; \
  47. case (( byte ) * ( 8 ) + ( 2 )): bytePosition = byte; byteShift = 2; break; \
  48. case (( byte ) * ( 8 ) + ( 3 )): bytePosition = byte; byteShift = 3; break; \
  49. case (( byte ) * ( 8 ) + ( 4 )): bytePosition = byte; byteShift = 4; break; \
  50. case (( byte ) * ( 8 ) + ( 5 )): bytePosition = byte; byteShift = 5; break; \
  51. case (( byte ) * ( 8 ) + ( 6 )): bytePosition = byte; byteShift = 6; break; \
  52. case (( byte ) * ( 8 ) + ( 7 )): bytePosition = byte; byteShift = 7; break
  53. // ----- Function Declarations -----
  54. void cliFunc_kbdProtocol( char* args );
  55. void cliFunc_outputDebug( char* args );
  56. void cliFunc_readLEDs ( char* args );
  57. void cliFunc_sendKeys ( char* args );
  58. void cliFunc_setKeys ( char* args );
  59. void cliFunc_setMod ( char* args );
  60. // ----- Variables -----
  61. // Output Module command dictionary
  62. CLIDict_Entry( kbdProtocol, "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode" );
  63. CLIDict_Entry( outputDebug, "Toggle Output Debug mode." );
  64. CLIDict_Entry( readLEDs, "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc." );
  65. CLIDict_Entry( sendKeys, "Send the prepared list of USB codes and modifier byte." );
  66. CLIDict_Entry( setKeys, "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m." );
  67. CLIDict_Entry( setMod, "Set the modfier byte:" NL "\t\t1 LCtrl, 2 LShft, 4 LAlt, 8 LGUI, 16 RCtrl, 32 RShft, 64 RAlt, 128 RGUI" );
  68. CLIDict_Def( outputCLIDict, "USB Module Commands" ) = {
  69. CLIDict_Item( kbdProtocol ),
  70. CLIDict_Item( outputDebug ),
  71. CLIDict_Item( readLEDs ),
  72. CLIDict_Item( sendKeys ),
  73. CLIDict_Item( setKeys ),
  74. CLIDict_Item( setMod ),
  75. { 0, 0, 0 } // Null entry for dictionary end
  76. };
  77. // Which modifier keys are currently pressed
  78. // 1=left ctrl, 2=left shift, 4=left alt, 8=left gui
  79. // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
  80. uint8_t USBKeys_Modifiers = 0;
  81. uint8_t USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
  82. // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
  83. uint8_t USBKeys_Keys [USB_NKRO_BITFIELD_SIZE_KEYS];
  84. uint8_t USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
  85. // System Control and Consumer Control 1KRO containers
  86. uint8_t USBKeys_SysCtrl;
  87. uint16_t USBKeys_ConsCtrl;
  88. // The number of keys sent to the usb in the array
  89. uint8_t USBKeys_Sent = 0;
  90. uint8_t USBKeys_SentCLI = 0;
  91. // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
  92. volatile uint8_t USBKeys_LEDs = 0;
  93. // Currently pressed mouse buttons, bitmask, 0 represents no buttons pressed
  94. volatile uint16_t USBMouse_Buttons = 0;
  95. // Relative mouse axis movement, stores pending movement
  96. volatile uint16_t USBMouse_Relative_x = 0;
  97. volatile uint16_t USBMouse_Relative_y = 0;
  98. // Protocol setting from the host.
  99. // 0 - Boot Mode
  100. // 1 - NKRO Mode (Default, unless set by a BIOS or boot interface)
  101. volatile uint8_t USBKeys_Protocol = USBProtocol_define;
  102. // Indicate if USB should send update
  103. // OS only needs update if there has been a change in state
  104. USBKeyChangeState USBKeys_Changed = USBKeyChangeState_None;
  105. // Indicate if USB should send update
  106. USBMouseChangeState USBMouse_Changed = 0;
  107. // the idle configuration, how often we send the report to the
  108. // host (ms * 4) even when it hasn't changed
  109. uint8_t USBKeys_Idle_Config = 125;
  110. // count until idle timeout
  111. uint8_t USBKeys_Idle_Count = 0;
  112. // Indicates whether the Output module is fully functional
  113. // 0 - Not fully functional, 1 - Fully functional
  114. // 0 is often used to show that a USB cable is not plugged in (but has power)
  115. volatile uint8_t Output_Available = 0;
  116. // Debug control variable for Output modules
  117. // 0 - Debug disabled (default)
  118. // 1 - Debug enabled
  119. uint8_t Output_DebugMode = 0;
  120. // mA - Set by outside module if not using USB (i.e. Interconnect)
  121. // Generally set to 100 mA (low power) or 500 mA (high power)
  122. uint16_t Output_ExtCurrent_Available = 0;
  123. // mA - Set by USB module (if exists)
  124. // Initially 100 mA, but may be negotiated higher (e.g. 500 mA)
  125. uint16_t Output_USBCurrent_Available = 0;
  126. // ----- Capabilities -----
  127. // Set Boot Keyboard Protocol
  128. void Output_kbdProtocolBoot_capability( uint8_t state, uint8_t stateType, uint8_t *args )
  129. {
  130. // Display capability name
  131. if ( stateType == 0xFF && state == 0xFF )
  132. {
  133. print("Output_kbdProtocolBoot()");
  134. return;
  135. }
  136. // Only set if necessary
  137. if ( USBKeys_Protocol == 0 )
  138. return;
  139. // TODO Analog inputs
  140. // Only set on key press
  141. if ( stateType != 0x01 )
  142. return;
  143. // Flush the key buffers
  144. Output_flushBuffers();
  145. // Set the keyboard protocol to Boot Mode
  146. USBKeys_Protocol = 0;
  147. }
  148. // Set NKRO Keyboard Protocol
  149. void Output_kbdProtocolNKRO_capability( uint8_t state, uint8_t stateType, uint8_t *args )
  150. {
  151. // Display capability name
  152. if ( stateType == 0xFF && state == 0xFF )
  153. {
  154. print("Output_kbdProtocolNKRO()");
  155. return;
  156. }
  157. // Only set if necessary
  158. if ( USBKeys_Protocol == 1 )
  159. return;
  160. // TODO Analog inputs
  161. // Only set on key press
  162. if ( stateType != 0x01 )
  163. return;
  164. // Flush the key buffers
  165. Output_flushBuffers();
  166. // Set the keyboard protocol to NKRO Mode
  167. USBKeys_Protocol = 1;
  168. }
  169. // Sends a Consumer Control code to the USB Output buffer
  170. void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
  171. {
  172. // Display capability name
  173. if ( stateType == 0xFF && state == 0xFF )
  174. {
  175. print("Output_consCtrlSend(consCode)");
  176. return;
  177. }
  178. // Not implemented in Boot Mode
  179. if ( USBKeys_Protocol == 0 )
  180. {
  181. warn_print("Consumer Control is not implemented for Boot Mode");
  182. return;
  183. }
  184. // TODO Analog inputs
  185. // Only indicate USB has changed if either a press or release has occured
  186. if ( state == 0x01 || state == 0x03 )
  187. USBKeys_Changed |= USBKeyChangeState_Consumer;
  188. // Only send keypresses if press or hold state
  189. if ( stateType == 0x00 && state == 0x03 ) // Release state
  190. {
  191. USBKeys_ConsCtrl = 0;
  192. return;
  193. }
  194. // Set consumer control code
  195. USBKeys_ConsCtrl = *(uint16_t*)(&args[0]);
  196. }
  197. // Ignores the given key status update
  198. // Used to prevent fall-through, this is the None keyword in KLL
  199. void Output_noneSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
  200. {
  201. // Display capability name
  202. if ( stateType == 0xFF && state == 0xFF )
  203. {
  204. print("Output_noneSend()");
  205. return;
  206. }
  207. // Nothing to do, because that's the point :P
  208. }
  209. // Sends a System Control code to the USB Output buffer
  210. void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
  211. {
  212. // Display capability name
  213. if ( stateType == 0xFF && state == 0xFF )
  214. {
  215. print("Output_sysCtrlSend(sysCode)");
  216. return;
  217. }
  218. // Not implemented in Boot Mode
  219. if ( USBKeys_Protocol == 0 )
  220. {
  221. warn_print("System Control is not implemented for Boot Mode");
  222. return;
  223. }
  224. // TODO Analog inputs
  225. // Only indicate USB has changed if either a press or release has occured
  226. if ( state == 0x01 || state == 0x03 )
  227. USBKeys_Changed |= USBKeyChangeState_System;
  228. // Only send keypresses if press or hold state
  229. if ( stateType == 0x00 && state == 0x03 ) // Release state
  230. {
  231. USBKeys_SysCtrl = 0;
  232. return;
  233. }
  234. // Set system control code
  235. USBKeys_SysCtrl = args[0];
  236. }
  237. // Adds a single USB Code to the USB Output buffer
  238. // Argument #1: USB Code
  239. void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
  240. {
  241. // Display capability name
  242. if ( stateType == 0xFF && state == 0xFF )
  243. {
  244. print("Output_usbCodeSend(usbCode)");
  245. return;
  246. }
  247. // Depending on which mode the keyboard is in the USB needs Press/Hold/Release events
  248. uint8_t keyPress = 0; // Default to key release, only used for NKRO
  249. switch ( USBKeys_Protocol )
  250. {
  251. case 0: // Boot Mode
  252. // TODO Analog inputs
  253. // Only indicate USB has changed if either a press or release has occured
  254. if ( state == 0x01 || state == 0x03 )
  255. USBKeys_Changed = USBKeyChangeState_MainKeys;
  256. // Only send keypresses if press or hold state
  257. if ( stateType == 0x00 && state == 0x03 ) // Release state
  258. return;
  259. break;
  260. case 1: // NKRO Mode
  261. // Only send press and release events
  262. if ( stateType == 0x00 && state == 0x02 ) // Hold state
  263. return;
  264. // Determine if setting or unsetting the bitfield (press == set)
  265. if ( stateType == 0x00 && state == 0x01 ) // Press state
  266. keyPress = 1;
  267. break;
  268. }
  269. // Get the keycode from arguments
  270. uint8_t key = args[0];
  271. // Depending on which mode the keyboard is in, USBKeys_Keys array is used differently
  272. // Boot mode - Maximum of 6 byte codes
  273. // NKRO mode - Each bit of the 26 byte corresponds to a key
  274. // Bits 0 - 45 (bytes 0 - 5) correspond to USB Codes 4 - 49 (Main)
  275. // Bits 48 - 161 (bytes 6 - 20) correspond to USB Codes 51 - 164 (Secondary)
  276. // Bits 168 - 213 (bytes 21 - 26) correspond to USB Codes 176 - 221 (Tertiary)
  277. // Bits 214 - 216 unused
  278. uint8_t bytePosition = 0;
  279. uint8_t byteShift = 0;
  280. switch ( USBKeys_Protocol )
  281. {
  282. case 0: // Boot Mode
  283. // Set the modifier bit if this key is a modifier
  284. if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
  285. {
  286. USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
  287. }
  288. // Normal USB Code
  289. else
  290. {
  291. // USB Key limit reached
  292. if ( USBKeys_Sent >= USB_BOOT_MAX_KEYS )
  293. {
  294. warn_print("USB Key limit reached");
  295. return;
  296. }
  297. // Make sure key is within the USB HID range
  298. if ( key <= 104 )
  299. {
  300. USBKeys_Keys[USBKeys_Sent++] = key;
  301. }
  302. // Invalid key
  303. else
  304. {
  305. warn_msg("USB Code above 104/0x68 in Boot Mode: ");
  306. printHex( key );
  307. print( NL );
  308. }
  309. }
  310. break;
  311. case 1: // NKRO Mode
  312. // Set the modifier bit if this key is a modifier
  313. if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
  314. {
  315. if ( keyPress )
  316. {
  317. USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
  318. }
  319. else // Release
  320. {
  321. USBKeys_Modifiers &= ~(1 << (key ^ 0xE0)); // Left shift 1 by key XOR 0xE0
  322. }
  323. USBKeys_Changed |= USBKeyChangeState_Modifiers;
  324. break;
  325. }
  326. // First 6 bytes
  327. else if ( key >= 4 && key <= 49 )
  328. {
  329. // Lookup (otherwise division or multiple checks are needed to do alignment)
  330. // Starting at 0th position, each byte has 8 bits, starting at 4th bit
  331. uint8_t keyPos = key + (0 * 8 - 4); // Starting position in array, Ignoring 4 keys
  332. switch ( keyPos )
  333. {
  334. byteLookup( 0 );
  335. byteLookup( 1 );
  336. byteLookup( 2 );
  337. byteLookup( 3 );
  338. byteLookup( 4 );
  339. byteLookup( 5 );
  340. }
  341. USBKeys_Changed |= USBKeyChangeState_MainKeys;
  342. }
  343. // Next 14 bytes
  344. else if ( key >= 51 && key <= 155 )
  345. {
  346. // Lookup (otherwise division or multiple checks are needed to do alignment)
  347. // Starting at 6th byte position, each byte has 8 bits, starting at 51st bit
  348. uint8_t keyPos = key + (6 * 8 - 51); // Starting position in array
  349. switch ( keyPos )
  350. {
  351. byteLookup( 6 );
  352. byteLookup( 7 );
  353. byteLookup( 8 );
  354. byteLookup( 9 );
  355. byteLookup( 10 );
  356. byteLookup( 11 );
  357. byteLookup( 12 );
  358. byteLookup( 13 );
  359. byteLookup( 14 );
  360. byteLookup( 15 );
  361. byteLookup( 16 );
  362. byteLookup( 17 );
  363. byteLookup( 18 );
  364. byteLookup( 19 );
  365. }
  366. USBKeys_Changed |= USBKeyChangeState_SecondaryKeys;
  367. }
  368. // Next byte
  369. else if ( key >= 157 && key <= 164 )
  370. {
  371. // Lookup (otherwise division or multiple checks are needed to do alignment)
  372. uint8_t keyPos = key + (20 * 8 - 157); // Starting position in array, Ignoring 6 keys
  373. switch ( keyPos )
  374. {
  375. byteLookup( 20 );
  376. }
  377. USBKeys_Changed |= USBKeyChangeState_TertiaryKeys;
  378. }
  379. // Last 6 bytes
  380. else if ( key >= 176 && key <= 221 )
  381. {
  382. // Lookup (otherwise division or multiple checks are needed to do alignment)
  383. uint8_t keyPos = key + (21 * 8 - 176); // Starting position in array
  384. switch ( keyPos )
  385. {
  386. byteLookup( 21 );
  387. byteLookup( 22 );
  388. byteLookup( 23 );
  389. byteLookup( 24 );
  390. byteLookup( 25 );
  391. byteLookup( 26 );
  392. }
  393. USBKeys_Changed |= USBKeyChangeState_QuartiaryKeys;
  394. }
  395. // Received 0x00
  396. // This is a special USB Code that internally indicates a "break"
  397. // It is used to send "nothing" in order to break up sequences of USB Codes
  398. else if ( key == 0x00 )
  399. {
  400. USBKeys_Changed |= USBKeyChangeState_MainKeys;
  401. // Also flush out buffers just in case
  402. Output_flushBuffers();
  403. break;
  404. }
  405. // Invalid key
  406. else
  407. {
  408. warn_msg("USB Code not within 4-49 (0x4-0x31), 51-155 (0x33-0x9B), 157-164 (0x9D-0xA4), 176-221 (0xB0-0xDD) or 224-231 (0xE0-0xE7) NKRO Mode: ");
  409. printHex( key );
  410. print( NL );
  411. break;
  412. }
  413. // Set/Unset
  414. if ( keyPress )
  415. {
  416. USBKeys_Keys[bytePosition] |= (1 << byteShift);
  417. USBKeys_Sent++;
  418. }
  419. else // Release
  420. {
  421. USBKeys_Keys[bytePosition] &= ~(1 << byteShift);
  422. USBKeys_Sent++;
  423. }
  424. break;
  425. }
  426. }
  427. void Output_flashMode_capability( uint8_t state, uint8_t stateType, uint8_t *args )
  428. {
  429. // Display capability name
  430. if ( stateType == 0xFF && state == 0xFF )
  431. {
  432. print("Output_flashMode()");
  433. return;
  434. }
  435. // Start flash mode
  436. Output_firmwareReload();
  437. }
  438. // Sends a mouse command over the USB Output buffer
  439. // XXX This function *will* be changing in the future
  440. // If you use it, be prepared that your .kll files will break in the future (post KLL 0.5)
  441. // Argument #1: USB Mouse Button (16 bit)
  442. // Argument #2: USB X Axis (16 bit) relative
  443. // Argument #3: USB Y Axis (16 bit) relative
  444. void Output_usbMouse_capability( uint8_t state, uint8_t stateType, uint8_t *args )
  445. {
  446. // Display capability name
  447. if ( stateType == 0xFF && state == 0xFF )
  448. {
  449. print("Output_usbMouse(mouseButton,relX,relY)");
  450. return;
  451. }
  452. // Determine which mouse button was sent
  453. // The USB spec defines up to a max of 0xFFFF buttons
  454. // The usual are:
  455. // 1 - Button 1 - (Primary)
  456. // 2 - Button 2 - (Secondary)
  457. // 3 - Button 3 - (Tertiary)
  458. uint16_t mouse_button = *(uint16_t*)(&args[0]);
  459. // X/Y Relative Axis
  460. uint16_t mouse_x = *(uint16_t*)(&args[2]);
  461. uint16_t mouse_y = *(uint16_t*)(&args[4]);
  462. // Adjust for bit shift
  463. uint16_t mouse_button_shift = mouse_button - 1;
  464. // Only send mouse button if in press or hold state
  465. if ( stateType == 0x00 && state == 0x03 ) // Release state
  466. {
  467. // Release
  468. if ( mouse_button )
  469. USBMouse_Buttons &= ~(1 << mouse_button_shift);
  470. }
  471. else
  472. {
  473. // Press or hold
  474. if ( mouse_button )
  475. USBMouse_Buttons |= (1 << mouse_button_shift);
  476. if ( mouse_x )
  477. USBMouse_Relative_x = mouse_x;
  478. if ( mouse_y )
  479. USBMouse_Relative_y = mouse_y;
  480. }
  481. // Trigger updates
  482. if ( mouse_button )
  483. USBMouse_Changed |= USBMouseChangeState_Buttons;
  484. if ( mouse_x || mouse_y )
  485. USBMouse_Changed |= USBMouseChangeState_Relative;
  486. }
  487. // ----- Functions -----
  488. // Flush Key buffers
  489. void Output_flushBuffers()
  490. {
  491. // Zero out USBKeys_Keys array
  492. for ( uint8_t c = 0; c < USB_NKRO_BITFIELD_SIZE_KEYS; c++ )
  493. USBKeys_Keys[ c ] = 0;
  494. // Zero out other key buffers
  495. USBKeys_ConsCtrl = 0;
  496. USBKeys_Modifiers = 0;
  497. USBKeys_SysCtrl = 0;
  498. }
  499. // USB Module Setup
  500. inline void Output_setup()
  501. {
  502. // Initialize the USB
  503. // If a USB connection does not exist, just ignore it
  504. // All usb related functions will non-fatally fail if called
  505. // If the USB initialization is delayed, then functionality will just be delayed
  506. usb_init();
  507. // Register USB Output CLI dictionary
  508. CLI_registerDictionary( outputCLIDict, outputCLIDictName );
  509. // Flush key buffers
  510. Output_flushBuffers();
  511. }
  512. // USB Data Send
  513. inline void Output_send()
  514. {
  515. // USB status checks
  516. // Non-standard USB state manipulation, usually does nothing
  517. usb_device_check();
  518. // Boot Mode Only, unset stale keys
  519. if ( USBKeys_Protocol == 0 )
  520. for ( uint8_t c = USBKeys_Sent; c < USB_BOOT_MAX_KEYS; c++ )
  521. USBKeys_Keys[c] = 0;
  522. // Process mouse actions
  523. while ( USBMouse_Changed )
  524. usb_mouse_send();
  525. // Send keypresses while there are pending changes
  526. while ( USBKeys_Changed )
  527. usb_keyboard_send();
  528. // Clear keys sent
  529. USBKeys_Sent = 0;
  530. // Signal Scan Module we are finished
  531. switch ( USBKeys_Protocol )
  532. {
  533. case 0: // Boot Mode
  534. // Clear modifiers only in boot mode
  535. USBKeys_Modifiers = 0;
  536. Scan_finishedWithOutput( USBKeys_Sent <= USB_BOOT_MAX_KEYS ? USBKeys_Sent : USB_BOOT_MAX_KEYS );
  537. break;
  538. case 1: // NKRO Mode
  539. Scan_finishedWithOutput( USBKeys_Sent );
  540. break;
  541. }
  542. }
  543. // Sets the device into firmware reload mode
  544. inline void Output_firmwareReload()
  545. {
  546. usb_device_reload();
  547. }
  548. // USB Input buffer available
  549. inline unsigned int Output_availablechar()
  550. {
  551. return usb_serial_available();
  552. }
  553. // USB Get Character from input buffer
  554. inline int Output_getchar()
  555. {
  556. // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes) (AVR)
  557. return (int)usb_serial_getchar();
  558. }
  559. // USB Send Character to output buffer
  560. inline int Output_putchar( char c )
  561. {
  562. return usb_serial_putchar( c );
  563. }
  564. // USB Send String to output buffer, null terminated
  565. inline int Output_putstr( char* str )
  566. {
  567. #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
  568. uint16_t count = 0;
  569. #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_) // ARM
  570. uint32_t count = 0;
  571. #endif
  572. // Count characters until NULL character, then send the amount counted
  573. while ( str[count] != '\0' )
  574. count++;
  575. return usb_serial_write( str, count );
  576. }
  577. // Soft Chip Reset
  578. inline void Output_softReset()
  579. {
  580. usb_device_software_reset();
  581. }
  582. // Update USB current (mA)
  583. // Triggers power change event
  584. void Output_update_usb_current( unsigned int current )
  585. {
  586. // Only signal if changed
  587. if ( current == Output_USBCurrent_Available )
  588. return;
  589. // Update USB current
  590. Output_USBCurrent_Available = current;
  591. unsigned int total_current = Output_current_available();
  592. info_msg("USB Available Current Changed. Total Available: ");
  593. printInt32( total_current );
  594. print(" mA" NL);
  595. // Send new total current to the Scan Modules
  596. Scan_currentChange( Output_current_available() );
  597. }
  598. // Update external current (mA)
  599. // Triggers power change event
  600. void Output_update_external_current( unsigned int current )
  601. {
  602. // Only signal if changed
  603. if ( current == Output_ExtCurrent_Available )
  604. return;
  605. // Update external current
  606. Output_ExtCurrent_Available = current;
  607. unsigned int total_current = Output_current_available();
  608. info_msg("External Available Current Changed. Total Available: ");
  609. printInt32( total_current );
  610. print(" mA" NL);
  611. // Send new total current to the Scan Modules
  612. Scan_currentChange( Output_current_available() );
  613. }
  614. // Power/Current Available
  615. unsigned int Output_current_available()
  616. {
  617. unsigned int total_current = 0;
  618. // Check for USB current source
  619. total_current += Output_USBCurrent_Available;
  620. // Check for external current source
  621. total_current += Output_ExtCurrent_Available;
  622. // XXX If the total available current is still 0
  623. // Set to 100 mA, which is generally a safe assumption at startup
  624. // before we've been able to determine actual available current
  625. if ( total_current == 0 )
  626. {
  627. total_current = 100;
  628. }
  629. return total_current;
  630. }
  631. // ----- CLI Command Functions -----
  632. void cliFunc_kbdProtocol( char* args )
  633. {
  634. print( NL );
  635. info_msg("Keyboard Protocol: ");
  636. printInt8( USBKeys_Protocol );
  637. }
  638. void cliFunc_outputDebug( char* args )
  639. {
  640. // Parse number from argument
  641. // NOTE: Only first argument is used
  642. char* arg1Ptr;
  643. char* arg2Ptr;
  644. CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
  645. // Default to 1 if no argument is given
  646. Output_DebugMode = 1;
  647. if ( arg1Ptr[0] != '\0' )
  648. {
  649. Output_DebugMode = (uint16_t)numToInt( arg1Ptr );
  650. }
  651. }
  652. void cliFunc_readLEDs( char* args )
  653. {
  654. print( NL );
  655. info_msg("LED State: ");
  656. printInt8( USBKeys_LEDs );
  657. }
  658. void cliFunc_sendKeys( char* args )
  659. {
  660. // Copy USBKeys_KeysCLI to USBKeys_Keys
  661. for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
  662. {
  663. // TODO
  664. //USBKeys_Keys[key] = USBKeys_KeysCLI[key];
  665. }
  666. USBKeys_Sent = USBKeys_SentCLI;
  667. // Set modifier byte
  668. USBKeys_Modifiers = USBKeys_ModifiersCLI;
  669. }
  670. void cliFunc_setKeys( char* args )
  671. {
  672. char* curArgs;
  673. char* arg1Ptr;
  674. char* arg2Ptr = args;
  675. // Parse up to USBKeys_MaxSize args (whichever is least)
  676. for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
  677. {
  678. curArgs = arg2Ptr;
  679. CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
  680. // Stop processing args if no more are found
  681. if ( *arg1Ptr == '\0' )
  682. break;
  683. // Add the USB code to be sent
  684. // TODO
  685. //USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
  686. }
  687. }
  688. void cliFunc_setMod( char* args )
  689. {
  690. // Parse number from argument
  691. // NOTE: Only first argument is used
  692. char* arg1Ptr;
  693. char* arg2Ptr;
  694. CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
  695. USBKeys_ModifiersCLI = numToInt( arg1Ptr );
  696. }