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