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