Output/pjrcUSB/arm/usb_keyboard.c

   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
  32 // ----- Includes -----
  33
  34 // Compiler Includes
  35 #include <string.h> // for memcpy()
  36
  37 // Project Includes
  38 #include <Lib/OutputLib.h>
  39 #include <print.h>
  40
  41 // Local Includes
  42 #include "usb_dev.h"
  43 #include "usb_keyboard.h"
  44
  45
  46
  47 // ----- Defines -----
  48
  49 // Maximum number of transmit packets to queue so we don't starve other endpoints for memory
  50 #define TX_PACKET_LIMIT 4
  51
  52 // When the PC isn't listening, how long do we wait before discarding data?
  53 #define TX_TIMEOUT_MSEC 50
  54
  55 #if F_CPU == 96000000
  56         #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 596)
  57 #elif F_CPU == 72000000
  58         #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 512) // XXX Correct?
  59 #elif F_CPU == 48000000
  60         #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 428)
  61 #elif F_CPU == 24000000
  62         #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 262)
  63 #endif
  64
  65
  66
  67 // ----- Variables -----
  68
  69 static uint8_t transmit_previous_timeout = 0;
  70
  71
  72
  73 // ----- Functions -----
  74
  75 // send the contents of keyboard_keys and keyboard_modifier_keys
  76 void usb_keyboard_send()
  77 {
  78         uint32_t wait_count = 0;
  79         usb_packet_t *tx_packet;
  80
  81         // Wait till ready
  82         while ( 1 )
  83         {
  84                 if ( !usb_configuration )
  85                 {
  86                         erro_print("USB not configured...");
  87                         return;
  88                 }
  89
  90                 if ( USBKeys_Protocol == 0 ) // Boot Mode
  91                 {
  92                         if ( usb_tx_packet_count( NKRO_KEYBOARD_ENDPOINT ) < TX_PACKET_LIMIT )
  93                         {
  94                                 tx_packet = usb_malloc();
  95                                 if ( tx_packet )
  96                                         break;
  97                         }
  98                 }
  99                 else if ( USBKeys_Protocol == 1 ) // NKRO Mode
 100                 {
 101                         if ( usb_tx_packet_count( KEYBOARD_ENDPOINT ) < TX_PACKET_LIMIT )
 102                         {
 103                                 tx_packet = usb_malloc();
 104                                 if ( tx_packet )
 105                                         break;
 106                         }
 107                 }
 108
 109                 if ( ++wait_count > TX_TIMEOUT || transmit_previous_timeout )
 110                 {
 111                         transmit_previous_timeout = 1;
 112                         warn_print("USB Transmit Timeout...");
 113                         return;
 114                 }
 115                 yield();
 116         }
 117
 118         // Pointer to USB tx packet buffer
 119         uint8_t *tx_buf = tx_packet->buf;
 120
 121         switch ( USBKeys_Protocol )
 122         {
 123         // Send boot keyboard interrupt packet(s)
 124         case 0:
 125                 // USB Boot Mode debug output
 126                 if ( Output_DebugMode )
 127                 {
 128                         dbug_msg("Boot USB: ");
 129                         printHex_op( USBKeys_Modifiers, 2 );
 130                         print(" ");
 131                         printHex( 0 );
 132                         print(" ");
 133                         printHex_op( USBKeys_Keys[0], 2 );
 134                         printHex_op( USBKeys_Keys[1], 2 );
 135                         printHex_op( USBKeys_Keys[2], 2 );
 136                         printHex_op( USBKeys_Keys[3], 2 );
 137                         printHex_op( USBKeys_Keys[4], 2 );
 138                         printHex_op( USBKeys_Keys[5], 2 );
 139                         print( NL );
 140                 }
 141
 142                 // Boot Mode
 143                 *tx_buf++ = USBKeys_Modifiers;
 144                 *tx_buf++ = 0;
 145                 memcpy( tx_buf, USBKeys_Keys, USB_BOOT_MAX_KEYS );
 146                 tx_packet->len = 8;
 147
 148                 // Send USB Packet
 149                 usb_tx( KEYBOARD_ENDPOINT, tx_packet );
 150                 USBKeys_Changed = USBKeyChangeState_None;
 151                 break;
 152
 153         // Send NKRO keyboard interrupts packet(s)
 154         case 1:
 155                 if ( Output_DebugMode )
 156                 {
 157                         dbug_msg("NKRO USB: ");
 158                 }
 159
 160                 // Check system control keys
 161                 if ( USBKeys_Changed & USBKeyChangeState_System )
 162                 {
 163                         if ( Output_DebugMode )
 164                         {
 165                                 print("SysCtrl[");
 166                                 printHex_op( USBKeys_SysCtrl, 2 );
 167                                 print( "] " NL );
 168                         }
 169
 170                         *tx_buf++ = 0x02; // ID
 171                         *tx_buf   = USBKeys_SysCtrl;
 172                         tx_packet->len = 2;
 173
 174                         // Send USB Packet
 175                         usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
 176                         USBKeys_Changed &= ~USBKeyChangeState_System; // Mark sent
 177                 }
 178
 179                 // Check consumer control keys
 180                 if ( USBKeys_Changed & USBKeyChangeState_Consumer )
 181                 {
 182                         if ( Output_DebugMode )
 183                         {
 184                                 print("ConsCtrl[");
 185                                 printHex_op( USBKeys_ConsCtrl, 2 );
 186                                 print( "] " NL );
 187                         }
 188
 189                         *tx_buf++ = 0x03; // ID
 190                         *tx_buf++ = (uint8_t)(USBKeys_ConsCtrl & 0x00FF);
 191                         *tx_buf   = (uint8_t)(USBKeys_ConsCtrl >> 8);
 192                         tx_packet->len = 3;
 193
 194                         // Send USB Packet
 195                         usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
 196                         USBKeys_Changed &= ~USBKeyChangeState_Consumer; // Mark sent
 197                 }
 198
 199                 // Standard HID Keyboard
 200                 if ( USBKeys_Changed )
 201                 {
 202                         // USB NKRO Debug output
 203                         if ( Output_DebugMode )
 204                         {
 205                                 printHex_op( USBKeys_Modifiers, 2 );
 206                                 print(" ");
 207                                 for ( uint8_t c = 0; c < 6; c++ )
 208                                         printHex_op( USBKeys_Keys[ c ], 2 );
 209                                 print(" ");
 210                                 for ( uint8_t c = 6; c < 20; c++ )
 211                                         printHex_op( USBKeys_Keys[ c ], 2 );
 212                                 print(" ");
 213                                 printHex_op( USBKeys_Keys[20], 2 );
 214                                 print(" ");
 215                                 for ( uint8_t c = 21; c < 27; c++ )
 216                                         printHex_op( USBKeys_Keys[ c ], 2 );
 217                                 print( NL );
 218                         }
 219
 220                         tx_packet->len = 0;
 221
 222                         // Modifiers
 223                         *tx_buf++ = 0x01; // ID
 224                         *tx_buf++ = USBKeys_Modifiers;
 225                         tx_packet->len += 2;
 226
 227                         // 4-49 (first 6 bytes)
 228                         memcpy( tx_buf, USBKeys_Keys, 6 );
 229                         tx_buf += 6;
 230                         tx_packet->len += 6;
 231
 232                         // 51-155 (Middle 14 bytes)
 233                         memcpy( tx_buf, USBKeys_Keys + 6, 14 );
 234                         tx_buf += 14;
 235                         tx_packet->len += 14;
 236
 237                         // 157-164 (Next byte)
 238                         memcpy( tx_buf, USBKeys_Keys + 20, 1 );
 239                         tx_buf += 1;
 240                         tx_packet->len += 1;
 241
 242                         // 176-221 (last 6 bytes)
 243                         memcpy( tx_buf, USBKeys_Keys + 21, 6 );
 244                         tx_packet->len += 6;
 245
 246                         // Send USB Packet
 247                         usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
 248                         USBKeys_Changed = USBKeyChangeState_None; // Mark sent
 249                 }
 250
 251                 break;
 252         }
 253
 254         return;
 255 }
 256