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