]> git.donarmstrong.com Git - kiibohd-controller.git/blobdiff - Output/pjrcUSB/arm/usb_dev.c
Fixing long-standing SET_REPORT bug
[kiibohd-controller.git] / Output / pjrcUSB / arm / usb_dev.c
index 138d2c258d5acea68336a8b7c4ea5ca3b4058e38..e913006e615d06970ed8e5408f0ced007a2b7af9 100644 (file)
@@ -1,7 +1,7 @@
 /* Teensyduino Core Library
  * http://www.pjrc.com/teensy/
  * Copyright (c) 2013 PJRC.COM, LLC.
- * Modifications by Jacob Alexander (2013-2014)
+ * Modifications by Jacob Alexander (2013-2015)
  *
  * Permission is hereby granted, free of charge, to any person obtaining
  * a copy of this software and associated documentation files (the
@@ -34,6 +34,7 @@
 // Project Includes
 #include <Lib/OutputLib.h>
 #include <print.h>
+#include <kll_defs.h>
 
 // Local Includes
 #include "usb_dev.h"
 //#define UART_DEBUG_UNKNOWN 1
 
 
-#define TX_STATE_BOTH_FREE_EVEN_FIRST  0
-#define TX_STATE_BOTH_FREE_ODD_FIRST   1
-#define TX_STATE_EVEN_FREE             2
-#define TX_STATE_ODD_FREE              3
-#define TX_STATE_NONE_FREE_EVEN_FIRST  4
-#define TX_STATE_NONE_FREE_ODD_FIRST   5
+#define TX_STATE_BOTH_FREE_EVEN_FIRST   0
+#define TX_STATE_BOTH_FREE_ODD_FIRST    1
+#define TX_STATE_EVEN_FREE              2
+#define TX_STATE_ODD_FREE               3
+#define TX_STATE_NONE_FREE_EVEN_FIRST   4
+#define TX_STATE_NONE_FREE_ODD_FIRST    5
 
-#define BDT_OWN                0x80
-#define BDT_DATA1      0x40
-#define BDT_DATA0      0x00
-#define BDT_DTS                0x08
-#define BDT_STALL      0x04
+#define BDT_OWN         0x80
+#define BDT_DATA1       0x40
+#define BDT_DATA0       0x00
+#define BDT_DTS         0x08
+#define BDT_STALL       0x04
 
 #define TX    1
 #define RX    0
 #define DATA1 1
 
 
-#define GET_STATUS             0
-#define CLEAR_FEATURE          1
-#define SET_FEATURE            3
-#define SET_ADDRESS            5
-#define GET_DESCRIPTOR         6
-#define SET_DESCRIPTOR         7
-#define GET_CONFIGURATION      8
-#define SET_CONFIGURATION      9
-#define GET_INTERFACE          10
-#define SET_INTERFACE          11
-#define SYNCH_FRAME            12
+#define GET_STATUS              0
+#define CLEAR_FEATURE           1
+#define SET_FEATURE             3
+#define SET_ADDRESS             5
+#define GET_DESCRIPTOR          6
+#define SET_DESCRIPTOR          7
+#define GET_CONFIGURATION       8
+#define SET_CONFIGURATION       9
+#define GET_INTERFACE           10
+#define SET_INTERFACE           11
+#define SYNCH_FRAME             12
 
-#define TX_STATE_BOTH_FREE_EVEN_FIRST  0
-#define TX_STATE_BOTH_FREE_ODD_FIRST   1
-#define TX_STATE_EVEN_FREE             2
-#define TX_STATE_ODD_FREE              3
-#define TX_STATE_NONE_FREE             4
+#define TX_STATE_BOTH_FREE_EVEN_FIRST   0
+#define TX_STATE_BOTH_FREE_ODD_FIRST    1
+#define TX_STATE_EVEN_FREE              2
+#define TX_STATE_ODD_FREE               3
+#define TX_STATE_NONE_FREE              4
 
 
 
@@ -96,9 +97,9 @@
 
 // ----- Macros -----
 
-#define BDT_PID(n)     (((n) >> 2) & 15)
+#define BDT_PID(n)      (((n) >> 2) & 15)
 
-#define BDT_DESC(count, data)  (BDT_OWN | BDT_DTS \
+#define BDT_DESC(count, data)   (BDT_OWN | BDT_DTS \
                                | ((data) ? BDT_DATA1 : BDT_DATA0) \
                                | ((count) << 16))
 
@@ -173,6 +174,9 @@ static uint8_t reply_buffer[8];
 
 static void endpoint0_stall()
 {
+       #ifdef UART_DEBUG_UNKNOWN
+       print("STALL" NL );
+       #endif
        USB0_ENDPT0 = USB_ENDPT_EPSTALL | USB_ENDPT_EPRXEN | USB_ENDPT_EPTXEN | USB_ENDPT_EPHSHK;
 }
 
@@ -198,12 +202,14 @@ static void usb_setup()
        switch ( setup.wRequestAndType )
        {
        case 0x0500: // SET_ADDRESS
-               break;
+               goto send;
+
        case 0x0900: // SET_CONFIGURATION
                #ifdef UART_DEBUG
                print("CONFIGURE - ");
                #endif
                usb_configuration = setup.wValue;
+               Output_Available = usb_configuration;
                reg = &USB0_ENDPT1;
                cfg = usb_endpoint_config_table;
                // clear all BDT entries, free any allocated memory...
@@ -287,18 +293,21 @@ static void usb_setup()
                        table[ index( i, TX, EVEN ) ].desc = 0;
                        table[ index( i, TX, ODD ) ].desc = 0;
                }
-               break;
+               goto send;
+
        case 0x0880: // GET_CONFIGURATION
                reply_buffer[0] = usb_configuration;
                datalen = 1;
                data = reply_buffer;
-               break;
+               goto send;
+
        case 0x0080: // GET_STATUS (device)
                reply_buffer[0] = 0;
                reply_buffer[1] = 0;
                datalen = 2;
                data = reply_buffer;
-               break;
+               goto send;
+
        case 0x0082: // GET_STATUS (endpoint)
                if ( setup.wIndex > NUM_ENDPOINTS )
                {
@@ -312,32 +321,33 @@ static void usb_setup()
                        reply_buffer[0] = 1;
                data = reply_buffer;
                datalen = 2;
-               break;
+               goto send;
+
        case 0x0100: // CLEAR_FEATURE (device)
        case 0x0101: // CLEAR_FEATURE (interface)
                // TODO: Currently ignoring, perhaps useful? -HaaTa
+               warn_print("CLEAR_FEATURE - Device/Interface");
                endpoint0_stall();
                return;
-       case 0x0102: // CLEAR_FEATURE (interface)
+
+       case 0x0102: // CLEAR_FEATURE (endpoint)
                i = setup.wIndex & 0x7F;
                if ( i > NUM_ENDPOINTS || setup.wValue != 0 )
                {
                        endpoint0_stall();
                        return;
                }
-               //(*(uint8_t *)(&USB0_ENDPT0 + setup.wIndex * 4)) &= ~0x02;
+               (*(uint8_t *)(&USB0_ENDPT0 + setup.wIndex * 4)) &= ~0x02;
                // TODO: do we need to clear the data toggle here?
-               //break;
+               goto send;
 
-               // FIXME: Clearing causes keyboard to freeze, likely an invalid clear
-               // XXX: Ignoring seems to work, though this may not be the ideal behaviour -HaaTa
-               endpoint0_stall();
-               return;
        case 0x0300: // SET_FEATURE (device)
        case 0x0301: // SET_FEATURE (interface)
                // TODO: Currently ignoring, perhaps useful? -HaaTa
+               warn_print("SET_FEATURE - Device/Interface");
                endpoint0_stall();
                return;
+
        case 0x0302: // SET_FEATURE (endpoint)
                i = setup.wIndex & 0x7F;
                if ( i > NUM_ENDPOINTS || setup.wValue != 0 )
@@ -348,7 +358,8 @@ static void usb_setup()
                }
                (*(uint8_t *)(&USB0_ENDPT0 + setup.wIndex * 4)) |= 0x02;
                // TODO: do we need to clear the data toggle here?
-               break;
+               goto send;
+
        case 0x0680: // GET_DESCRIPTOR
        case 0x0681:
                #ifdef UART_DEBUG
@@ -400,8 +411,7 @@ static void usb_setup()
        case 0x2221: // CDC_SET_CONTROL_LINE_STATE
                usb_cdc_line_rtsdtr = setup.wValue;
                //serial_print("set control line state\n");
-               endpoint0_stall();
-               return;
+               goto send;
 
        case 0x21A1: // CDC_GET_LINE_CODING
                data = (uint8_t*)usb_cdc_line_coding;
@@ -411,30 +421,50 @@ static void usb_setup()
        case 0x2021: // CDC_SET_LINE_CODING
                // XXX Needed?
                //serial_print("set coding, waiting...\n");
-               endpoint0_stall();
-               return; // Cannot stall here (causes issues)
+               return;
 
        case 0x0921: // HID SET_REPORT
-               #ifdef UART_DEBUG
-               print("SET_REPORT - ");
-               printHex( setup.wValue );
-               print(" - ");
-               printHex( setup.wValue & 0xFF );
-               print( NL );
-               #endif
-               USBKeys_LEDs = setup.wValue & 0xFF;
-               endpoint0_stall();
+               // Interface
+               switch ( setup.wIndex & 0xFF )
+               {
+               // Keyboard Interface
+               case KEYBOARD_INTERFACE:
+                       break;
+               // NKRO Keyboard Interface
+               case NKRO_KEYBOARD_INTERFACE:
+                       break;
+               default:
+                       warn_msg("Unknown interface - ");
+                       printHex( setup.wIndex );
+                       print( NL );
+                       endpoint0_stall();
+                       break;
+               }
+
                return;
 
        case 0x01A1: // HID GET_REPORT
                #ifdef UART_DEBUG
                print("GET_REPORT - ");
-               printHex( USBKeys_LEDs );
+               printHex( setup.wIndex );
                print(NL);
                #endif
-               data = (uint8_t*)&USBKeys_LEDs;
-               datalen = 1;
-               goto send;
+               // Search through descriptors returning necessary info
+               for ( list = usb_descriptor_list; 1; list++ )
+               {
+                       if ( list->addr == NULL )
+                               break;
+                       if ( list->wValue != 0x2200 )
+                               continue;
+                       if ( setup.wIndex == list->wIndex )
+                       {
+                               data = list->addr;
+                               datalen = list->length;
+                               goto send;
+                       }
+                }
+                endpoint0_stall();
+                return;
 
        case 0x0A21: // HID SET_IDLE
                #ifdef UART_DEBUG
@@ -444,8 +474,7 @@ static void usb_setup()
                #endif
                USBKeys_Idle_Config = (setup.wValue >> 8);
                USBKeys_Idle_Count = 0;
-               endpoint0_stall();
-               return;
+               goto send;
 
        case 0x0B21: // HID SET_PROTOCOL
                #ifdef UART_DEBUG
@@ -456,8 +485,7 @@ static void usb_setup()
                print(NL);
                #endif
                USBKeys_Protocol = setup.wValue & 0xFF; // 0 - Boot Mode, 1 - NKRO Mode
-               endpoint0_stall();
-               return;
+               goto send;
 
        // case 0xC940:
        default:
@@ -471,10 +499,16 @@ static void usb_setup()
 send:
        #ifdef UART_DEBUG
        print("setup send ");
-       printHex32((uint32_t)data);
+       printHex32( (uint32_t)data );
+       print(",");
+       for ( uint8_t c = 0; c < datalen; c++ )
+       {
+               printHex( data[c] );
+               print(" ");
+       }
        print(",");
-       printHex(datalen);
-       print(NL);
+       printHex( datalen );
+       print( NL );
        #endif
 
        if ( datalen > setup.wLength )
@@ -584,6 +618,10 @@ static void usb_control( uint32_t stat )
                printHex(setup.wIndex);
                print(", len:");
                printHex(setup.wLength);
+               print(" -- ");
+               printHex32(setup.word1);
+               print(" ");
+               printHex32(setup.word2);
                print(NL);
                #endif
                // actually "do" the setup request
@@ -591,11 +629,25 @@ static void usb_control( uint32_t stat )
                // unfreeze the USB, now that we're ready
                USB0_CTL = USB_CTL_USBENSOFEN; // clear TXSUSPENDTOKENBUSY bit
                break;
+
        case 0x01:  // OUT transaction received from host
        case 0x02:
-               #ifdef UART_DEBUG
-               print("PID=OUT"NL);
+               #ifdef UART_DEBUG_UNKNOWN
+               print("PID=OUT wRequestAndType:");
+               printHex(setup.wRequestAndType);
+               print(", wValue:");
+               printHex(setup.wValue);
+               print(", wIndex:");
+               printHex(setup.wIndex);
+               print(", len:");
+               printHex(setup.wLength);
+               print(" -- ");
+               printHex32(setup.word1);
+               print(" ");
+               printHex32(setup.word2);
+               print(NL);
                #endif
+
                // CDC Interface
                if ( setup.wRequestAndType == 0x2021 /*CDC_SET_LINE_CODING*/ )
                {
@@ -614,17 +666,38 @@ static void usb_control( uint32_t stat )
                        endpoint0_transmit( NULL, 0 );
                }
 
-               // Keyboard Interface
-               if ( setup.word1 == 0x02000921 && setup.word2 == ( (1<<16) | KEYBOARD_INTERFACE ) )
+               // Keyboard SET_REPORT
+               if ( setup.wRequestAndType == 0x921 && setup.wValue & 0x200 )
                {
-                       USBKeys_LEDs = buf[0];
-                       endpoint0_transmit( NULL, 0 );
-               }
-               // NKRO Keyboard Interface
-               if ( setup.word1 == 0x02000921 && setup.word2 == ( (1<<16) | NKRO_KEYBOARD_INTERFACE ) )
-               {
-                       USBKeys_LEDs = buf[0];
-                       endpoint0_transmit( NULL, 0 );
+                       // Interface
+                       switch ( setup.wIndex & 0xFF )
+                       {
+                       // Keyboard Interface
+                       case KEYBOARD_INTERFACE:
+                               USBKeys_LEDs = buf[0];
+                               endpoint0_transmit( NULL, 0 );
+                               break;
+                       // NKRO Keyboard Interface
+                       case NKRO_KEYBOARD_INTERFACE:
+                               // Only use 2nd byte, first byte is the report id
+                               USBKeys_LEDs = buf[1];
+                               endpoint0_transmit( NULL, 0 );
+                               break;
+                       default:
+                               warn_msg("Unknown interface - ");
+                               printHex( setup.wIndex );
+                               print( NL );
+                               break;
+                       }
+
+                       #ifdef UART_DEBUG
+                       for ( size_t len = 0; len < setup.wLength; len++ )
+                       {
+                               printHex( buf[ len ] );
+                               print(" ");
+                       }
+                       print( NL );
+                       #endif
                }
 
                // give the buffer back
@@ -662,6 +735,7 @@ static void usb_control( uint32_t stat )
                }
 
                break;
+
        default:
                #ifdef UART_DEBUG
                print("PID=unknown:");
@@ -837,6 +911,14 @@ void usb_tx( uint32_t endpoint, usb_packet_t *packet )
 
 void usb_device_reload()
 {
+       if ( flashModeEnabled_define == 0 )
+       {
+               print( NL );
+               warn_print("flashModeEnabled not set, cancelling firmware reload...");
+               info_msg("Set flashModeEnabled to 1 in your kll configuration.");
+               return;
+       }
+
 // MCHCK
 #if defined(_mk20dx128vlf5_)
 
@@ -847,7 +929,7 @@ void usb_device_reload()
        PORTA_PCR3 = PORT_PCR_PFE | PORT_PCR_MUX(1); // Internal pull-up
 
        // Check for jumper
-       if ( GPIOA_PDIR & (1<<3) )
+       if ( GPIOA_PDIR & (1<<3) && flashModeEnabled_define != 0 )
        {
                print( NL );
                warn_print("Security jumper not present, cancelling firmware reload...");
@@ -861,6 +943,13 @@ void usb_device_reload()
                SOFTWARE_RESET();
        }
 
+// Kiibohd mk20dx256vlh7
+#elif defined(_mk20dx256vlh7_)
+       // Copies variable into the VBAT register, must be identical to the variable in the bootloader to jump to the bootloader flash mode
+       for ( int pos = 0; pos < sizeof(sys_reset_to_loader_magic); pos++ )
+               (&VBAT)[ pos ] = sys_reset_to_loader_magic[ pos ];
+       SOFTWARE_RESET();
+
 // Teensy 3.0 and 3.1
 #else
        asm volatile("bkpt");
@@ -936,7 +1025,7 @@ restart:
                        serial_phex(b->desc >> 16);
                        serial_print("\n");
 #endif
-                       endpoint--;     // endpoint is index to zero-based arrays
+                       endpoint--;     // endpoint is index to zero-based arrays
 
                        if ( stat & 0x08 )
                        { // transmit
@@ -980,8 +1069,8 @@ restart:
                                                break;
                                        default:
                                                tx_state[ endpoint ] = ((uint32_t)b & 8)
-                                                 ? TX_STATE_ODD_FREE
-                                                 : TX_STATE_EVEN_FREE;
+                                                       ? TX_STATE_ODD_FREE
+                                                       : TX_STATE_EVEN_FREE;
                                                break;
                                        }
                                }
@@ -1118,11 +1207,6 @@ uint8_t usb_init()
        print("USB INIT"NL);
        #endif
 
-       // If no USB cable is attached, do not initialize usb
-       // XXX Test -HaaTa
-       //if ( USB0_OTGISTAT & USB_OTGSTAT_ID )
-       //      return 0;
-
        // Clear out endpoints table
        for ( int i = 0; i <= NUM_ENDPOINTS * 4; i++ )
        {