1 /* Teensyduino Core Library
2 * http://www.pjrc.com/teensy/
3 * Copyright (c) 2013 PJRC.COM, LLC.
4 * Modifications by Jacob Alexander (2013-2015)
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:
14 * 1. The above copyright notice and this permission notice shall be
15 * included in all copies or substantial portions of the Software.
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.
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
32 // ----- Includes -----
35 #include <Lib/OutputLib.h>
45 // ----- Defines -----
48 // XXX - Only use when using usbMuxUart Module
49 // Delay causes issues initializing more than 1 hid device (i.e. NKRO keyboard)
50 //#define UART_DEBUG 1
51 // Debug Unknown USB requests, usually what you want to debug USB issues
52 //#define UART_DEBUG_UNKNOWN 1
55 #define TX_STATE_BOTH_FREE_EVEN_FIRST 0
56 #define TX_STATE_BOTH_FREE_ODD_FIRST 1
57 #define TX_STATE_EVEN_FREE 2
58 #define TX_STATE_ODD_FREE 3
59 #define TX_STATE_NONE_FREE_EVEN_FIRST 4
60 #define TX_STATE_NONE_FREE_ODD_FIRST 5
63 #define BDT_DATA1 0x40
64 #define BDT_DATA0 0x00
66 #define BDT_STALL 0x04
77 #define CLEAR_FEATURE 1
80 #define GET_DESCRIPTOR 6
81 #define SET_DESCRIPTOR 7
82 #define GET_CONFIGURATION 8
83 #define SET_CONFIGURATION 9
84 #define GET_INTERFACE 10
85 #define SET_INTERFACE 11
86 #define SYNCH_FRAME 12
88 #define TX_STATE_BOTH_FREE_EVEN_FIRST 0
89 #define TX_STATE_BOTH_FREE_ODD_FIRST 1
90 #define TX_STATE_EVEN_FREE 2
91 #define TX_STATE_ODD_FREE 3
92 #define TX_STATE_NONE_FREE 4
100 #define BDT_PID(n) (((n) >> 2) & 15)
102 #define BDT_DESC(count, data) (BDT_OWN | BDT_DTS \
103 | ((data) ? BDT_DATA1 : BDT_DATA0) \
106 #define index(endpoint, tx, odd) (((endpoint) << 2) | ((tx) << 1) | (odd))
107 #define stat2bufferdescriptor(stat) (table + ((stat) >> 2))
111 // ----- Structs -----
113 // buffer descriptor table
124 uint8_t bmRequestType;
127 uint16_t wRequestAndType;
141 // ----- Variables -----
143 __attribute__ ((section(".usbdescriptortable"), used))
144 static bdt_t table[ (NUM_ENDPOINTS + 1) * 4 ];
146 static usb_packet_t *rx_first [ NUM_ENDPOINTS ];
147 static usb_packet_t *rx_last [ NUM_ENDPOINTS ];
148 static usb_packet_t *tx_first [ NUM_ENDPOINTS ];
149 static usb_packet_t *tx_last [ NUM_ENDPOINTS ];
150 uint16_t usb_rx_byte_count_data[ NUM_ENDPOINTS ];
152 static uint8_t tx_state[NUM_ENDPOINTS];
154 // SETUP always uses a DATA0 PID for the data field of the SETUP transaction.
155 // transactions in the data phase start with DATA1 and toggle (figure 8-12, USB1.1)
156 // Status stage uses a DATA1 PID.
158 static uint8_t ep0_rx0_buf[EP0_SIZE] __attribute__ ((aligned (4)));
159 static uint8_t ep0_rx1_buf[EP0_SIZE] __attribute__ ((aligned (4)));
160 static const uint8_t *ep0_tx_ptr = NULL;
161 static uint16_t ep0_tx_len;
162 static uint8_t ep0_tx_bdt_bank = 0;
163 static uint8_t ep0_tx_data_toggle = 0;
164 uint8_t usb_rx_memory_needed = 0;
166 volatile uint8_t usb_configuration = 0;
167 volatile uint8_t usb_reboot_timer = 0;
169 static uint8_t reply_buffer[8];
173 // ----- Functions -----
175 static void endpoint0_stall()
177 #ifdef UART_DEBUG_UNKNOWN
180 USB0_ENDPT0 = USB_ENDPT_EPSTALL | USB_ENDPT_EPRXEN | USB_ENDPT_EPTXEN | USB_ENDPT_EPHSHK;
183 static void endpoint0_transmit( const void *data, uint32_t len )
185 table[index(0, TX, ep0_tx_bdt_bank)].addr = (void *)data;
186 table[index(0, TX, ep0_tx_bdt_bank)].desc = BDT_DESC(len, ep0_tx_data_toggle);
187 ep0_tx_data_toggle ^= 1;
188 ep0_tx_bdt_bank ^= 1;
191 static void usb_setup()
193 const uint8_t *data = NULL;
194 uint32_t datalen = 0;
195 const usb_descriptor_list_t *list;
197 volatile uint8_t *reg;
202 switch ( setup.wRequestAndType )
204 case 0x0500: // SET_ADDRESS
207 case 0x0900: // SET_CONFIGURATION
209 print("CONFIGURE - ");
211 usb_configuration = setup.wValue;
212 Output_Available = usb_configuration;
214 cfg = usb_endpoint_config_table;
215 // clear all BDT entries, free any allocated memory...
216 for ( i = 4; i < ( NUM_ENDPOINTS + 1) * 4; i++ )
218 if ( table[i].desc & BDT_OWN )
220 usb_free( (usb_packet_t *)((uint8_t *)(table[ i ].addr) - 8) );
223 // free all queued packets
224 for ( i = 0; i < NUM_ENDPOINTS; i++ )
234 rx_first[ i ] = NULL;
243 tx_first[ i ] = NULL;
245 usb_rx_byte_count_data[i] = 0;
247 switch ( tx_state[ i ] )
249 case TX_STATE_EVEN_FREE:
250 case TX_STATE_NONE_FREE_EVEN_FIRST:
251 tx_state[ i ] = TX_STATE_BOTH_FREE_EVEN_FIRST;
253 case TX_STATE_ODD_FREE:
254 case TX_STATE_NONE_FREE_ODD_FIRST:
255 tx_state[ i ] = TX_STATE_BOTH_FREE_ODD_FIRST;
261 usb_rx_memory_needed = 0;
262 for ( i = 1; i <= NUM_ENDPOINTS; i++ )
267 if ( epconf & USB_ENDPT_EPRXEN )
273 table[ index( i, RX, EVEN ) ].addr = p->buf;
274 table[ index( i, RX, EVEN ) ].desc = BDT_DESC( 64, 0 );
278 table[ index( i, RX, EVEN ) ].desc = 0;
279 usb_rx_memory_needed++;
284 table[ index( i, RX, ODD ) ].addr = p->buf;
285 table[ index( i, RX, ODD ) ].desc = BDT_DESC( 64, 1 );
289 table[ index( i, RX, ODD ) ].desc = 0;
290 usb_rx_memory_needed++;
293 table[ index( i, TX, EVEN ) ].desc = 0;
294 table[ index( i, TX, ODD ) ].desc = 0;
298 case 0x0880: // GET_CONFIGURATION
299 reply_buffer[0] = usb_configuration;
304 case 0x0080: // GET_STATUS (device)
311 case 0x0082: // GET_STATUS (endpoint)
312 if ( setup.wIndex > NUM_ENDPOINTS )
314 // TODO: do we need to handle IN vs OUT here?
320 if ( *(uint8_t *)(&USB0_ENDPT0 + setup.wIndex * 4) & 0x02 )
326 case 0x0100: // CLEAR_FEATURE (device)
327 case 0x0101: // CLEAR_FEATURE (interface)
328 // TODO: Currently ignoring, perhaps useful? -HaaTa
329 warn_print("CLEAR_FEATURE - Device/Interface");
333 case 0x0102: // CLEAR_FEATURE (endpoint)
334 i = setup.wIndex & 0x7F;
335 if ( i > NUM_ENDPOINTS || setup.wValue != 0 )
340 (*(uint8_t *)(&USB0_ENDPT0 + setup.wIndex * 4)) &= ~0x02;
341 // TODO: do we need to clear the data toggle here?
344 case 0x0300: // SET_FEATURE (device)
345 case 0x0301: // SET_FEATURE (interface)
346 // TODO: Currently ignoring, perhaps useful? -HaaTa
347 warn_print("SET_FEATURE - Device/Interface");
351 case 0x0302: // SET_FEATURE (endpoint)
352 i = setup.wIndex & 0x7F;
353 if ( i > NUM_ENDPOINTS || setup.wValue != 0 )
355 // TODO: do we need to handle IN vs OUT here?
359 (*(uint8_t *)(&USB0_ENDPT0 + setup.wIndex * 4)) |= 0x02;
360 // TODO: do we need to clear the data toggle here?
363 case 0x0680: // GET_DESCRIPTOR
367 printHex( setup.wValue );
370 for ( list = usb_descriptor_list; 1; list++ )
372 if ( list->addr == NULL )
374 if ( setup.wValue == list->wValue && setup.wIndex == list->wIndex )
377 if ( (setup.wValue >> 8) == 3 )
379 // for string descriptors, use the descriptor's
380 // length field, allowing runtime configured
382 datalen = *(list->addr);
386 datalen = list->length;
389 print("Desc found, ");
390 printHex32( (uint32_t)data );
394 printHex_op( data[0], 2 );
395 printHex_op( data[1], 2 );
396 printHex_op( data[2], 2 );
397 printHex_op( data[3], 2 );
398 printHex_op( data[4], 2 );
399 printHex_op( data[5], 2 );
406 print( "desc: not found" NL );
411 case 0x2221: // CDC_SET_CONTROL_LINE_STATE
412 usb_cdc_line_rtsdtr = setup.wValue;
413 //serial_print("set control line state\n");
416 case 0x21A1: // CDC_GET_LINE_CODING
417 data = (uint8_t*)usb_cdc_line_coding;
418 datalen = sizeof( usb_cdc_line_coding );
421 case 0x2021: // CDC_SET_LINE_CODING
423 //serial_print("set coding, waiting...\n");
426 case 0x0921: // HID SET_REPORT
428 warn_msg("SET_REPORT - ");
429 printHex( setup.wValue );
431 printHex( setup.wValue & 0xFF );
434 USBKeys_LEDs = setup.wValue & 0xFF;
436 // Must be stall for some reason... -HaaTa
440 case 0x01A1: // HID GET_REPORT
442 print("GET_REPORT - ");
443 printHex( setup.wIndex );
446 // Search through descriptors returning necessary info
447 for ( list = usb_descriptor_list; 1; list++ )
449 if ( list->addr == NULL )
451 if ( list->wValue != 0x2200 )
453 if ( setup.wIndex == list->wIndex )
456 datalen = list->length;
463 case 0x0A21: // HID SET_IDLE
465 print("SET_IDLE - ");
466 printHex( setup.wValue );
469 USBKeys_Idle_Config = (setup.wValue >> 8);
470 USBKeys_Idle_Count = 0;
473 case 0x0B21: // HID SET_PROTOCOL
475 print("SET_PROTOCOL - ");
476 printHex( setup.wValue );
478 printHex( setup.wValue & 0xFF );
481 USBKeys_Protocol = setup.wValue & 0xFF; // 0 - Boot Mode, 1 - NKRO Mode
486 #ifdef UART_DEBUG_UNKNOWN
495 print("setup send ");
496 printHex32( (uint32_t)data );
498 for ( uint8_t c = 0; c < datalen; c++ )
508 if ( datalen > setup.wLength )
509 datalen = setup.wLength;
512 if ( size > EP0_SIZE )
515 endpoint0_transmit(data, size);
519 // See if transmit has finished
520 if ( datalen == 0 && size < EP0_SIZE )
524 if ( size > EP0_SIZE )
526 endpoint0_transmit(data, size);
530 // See if transmit has finished
531 if ( datalen == 0 && size < EP0_SIZE )
534 // Save rest of transfer for later? XXX
536 ep0_tx_len = datalen;
540 //A bulk endpoint's toggle sequence is initialized to DATA0 when the endpoint
541 //experiences any configuration event (configuration events are explained in
542 //Sections 9.1.1.5 and 9.4.5).
544 //Configuring a device or changing an alternate setting causes all of the status
545 //and configuration values associated with endpoints in the affected interfaces
546 //to be set to their default values. This includes setting the data toggle of
547 //any endpoint using data toggles to the value DATA0.
549 //For endpoints using data toggle, regardless of whether an endpoint has the
550 //Halt feature set, a ClearFeature(ENDPOINT_HALT) request always results in the
551 //data toggle being reinitialized to DATA0.
553 static void usb_control( uint32_t stat )
563 b = stat2bufferdescriptor( stat );
564 pid = BDT_PID( b->desc );
576 case 0x0D: // Setup received from host
577 //serial_print("PID=Setup\n");
578 //if (count != 8) ; // panic?
579 // grab the 8 byte setup info
580 setup.word1 = *(uint32_t *)(buf);
581 setup.word2 = *(uint32_t *)(buf + 4);
583 // give the buffer back
584 b->desc = BDT_DESC( EP0_SIZE, DATA1 );
585 //table[index(0, RX, EVEN)].desc = BDT_DESC(EP0_SIZE, 1);
586 //table[index(0, RX, ODD)].desc = BDT_DESC(EP0_SIZE, 1);
588 // clear any leftover pending IN transactions
590 if ( ep0_tx_data_toggle )
593 //if (table[index(0, TX, EVEN)].desc & 0x80) {
594 //serial_print("leftover tx even\n");
596 //if (table[index(0, TX, ODD)].desc & 0x80) {
597 //serial_print("leftover tx odd\n");
599 table[index(0, TX, EVEN)].desc = 0;
600 table[index(0, TX, ODD)].desc = 0;
601 // first IN after Setup is always DATA1
602 ep0_tx_data_toggle = 1;
604 #ifdef UART_DEBUG_UNKNOWN
605 print("bmRequestType:");
606 printHex(setup.bmRequestType);
607 print(", bRequest:");
608 printHex(setup.bRequest);
610 printHex(setup.wValue);
612 printHex(setup.wIndex);
614 printHex(setup.wLength);
617 // actually "do" the setup request
619 // unfreeze the USB, now that we're ready
620 USB0_CTL = USB_CTL_USBENSOFEN; // clear TXSUSPENDTOKENBUSY bit
623 case 0x01: // OUT transaction received from host
629 if ( setup.wRequestAndType == 0x2021 /*CDC_SET_LINE_CODING*/ )
632 uint8_t *dst = (uint8_t *)usb_cdc_line_coding;
633 //serial_print("set line coding ");
634 for ( i = 0; i < 7; i++ )
639 //serial_phex32(usb_cdc_line_coding[0]);
640 //serial_print("\n");
641 if ( usb_cdc_line_coding[0] == 134 )
642 usb_reboot_timer = 15;
643 endpoint0_transmit( NULL, 0 );
646 // Keyboard Interface
647 if ( setup.word1 == 0x02000921 && setup.word2 == ( (1<<16) | KEYBOARD_INTERFACE ) )
649 USBKeys_LEDs = buf[0];
650 endpoint0_transmit( NULL, 0 );
652 // NKRO Keyboard Interface
653 if ( setup.word1 == 0x02000921 && setup.word2 == ( (1<<16) | NKRO_KEYBOARD_INTERFACE ) )
655 USBKeys_LEDs = buf[0];
656 endpoint0_transmit( NULL, 0 );
659 // give the buffer back
660 b->desc = BDT_DESC( EP0_SIZE, DATA1 );
663 case 0x09: // IN transaction completed to host
670 // send remaining data, if any...
675 if (size > EP0_SIZE) size = EP0_SIZE;
676 endpoint0_transmit(data, size);
679 ep0_tx_ptr = (ep0_tx_len > 0 || size == EP0_SIZE) ? data : NULL;
682 if ( setup.bRequest == 5 && setup.bmRequestType == 0 )
686 print("set address: ");
687 printHex(setup.wValue);
690 USB0_ADDR = setup.wValue;
697 print("PID=unknown:");
703 USB0_CTL = USB_CTL_USBENSOFEN; // clear TXSUSPENDTOKENBUSY bit
706 usb_packet_t *usb_rx( uint32_t endpoint )
711 if ( endpoint >= NUM_ENDPOINTS )
714 ret = rx_first[endpoint];
716 rx_first[ endpoint ] = ret->next;
717 usb_rx_byte_count_data[ endpoint ] -= ret->len;
719 //serial_print("rx, epidx=");
720 //serial_phex(endpoint);
721 //serial_print(", packet=");
722 //serial_phex32(ret);
723 //serial_print("\n");
727 static uint32_t usb_queue_byte_count( const usb_packet_t *p )
732 for ( ; p; p = p->next )
740 uint32_t usb_tx_byte_count( uint32_t endpoint )
743 if ( endpoint >= NUM_ENDPOINTS )
745 return usb_queue_byte_count( tx_first[ endpoint ] );
748 uint32_t usb_tx_packet_count( uint32_t endpoint )
750 const usb_packet_t *p;
754 if ( endpoint >= NUM_ENDPOINTS )
757 for ( p = tx_first[ endpoint ]; p; p = p->next )
764 // Called from usb_free, but only when usb_rx_memory_needed > 0, indicating
765 // receive endpoints are starving for memory. The intention is to give
766 // endpoints needing receive memory priority over the user's code, which is
767 // likely calling usb_malloc to obtain memory for transmitting. When the
768 // user is creating data very quickly, their consumption could starve reception
769 // without this prioritization. The packet buffer (input) is assigned to the
770 // first endpoint needing memory.
772 void usb_rx_memory( usb_packet_t *packet )
774 //print("USB RX MEMORY");
778 cfg = usb_endpoint_config_table;
779 //serial_print("rx_mem:");
781 for ( i = 1; i <= NUM_ENDPOINTS; i++ )
783 if ( *cfg++ & USB_ENDPT_EPRXEN )
785 if ( table[ index( i, RX, EVEN ) ].desc == 0 )
787 table[ index( i, RX, EVEN ) ].addr = packet->buf;
788 table[ index( i, RX, EVEN ) ].desc = BDT_DESC( 64, 0 );
789 usb_rx_memory_needed--;
792 //serial_print(",even\n");
795 if ( table[ index( i, RX, ODD ) ].desc == 0 )
797 table[ index( i, RX, ODD ) ].addr = packet->buf;
798 table[ index( i, RX, ODD ) ].desc = BDT_DESC( 64, 1 );
799 usb_rx_memory_needed--;
802 //serial_print(",odd\n");
808 // we should never reach this point. If we get here, it means
809 // usb_rx_memory_needed was set greater than zero, but no memory
810 // was actually needed.
811 usb_rx_memory_needed = 0;
816 //#define index(endpoint, tx, odd) (((endpoint) << 2) | ((tx) << 1) | (odd))
817 //#define stat2bufferdescriptor(stat) (table + ((stat) >> 2))
819 void usb_tx( uint32_t endpoint, usb_packet_t *packet )
821 bdt_t *b = &table[ index( endpoint, TX, EVEN ) ];
825 if ( endpoint >= NUM_ENDPOINTS )
828 //serial_print("txstate=");
829 //serial_phex(tx_state[ endpoint ]);
830 //serial_print("\n");
831 switch ( tx_state[ endpoint ] )
833 case TX_STATE_BOTH_FREE_EVEN_FIRST:
834 next = TX_STATE_ODD_FREE;
836 case TX_STATE_BOTH_FREE_ODD_FIRST:
838 next = TX_STATE_EVEN_FREE;
840 case TX_STATE_EVEN_FREE:
841 next = TX_STATE_NONE_FREE_ODD_FIRST;
843 case TX_STATE_ODD_FREE:
845 next = TX_STATE_NONE_FREE_EVEN_FIRST;
848 if (tx_first[ endpoint ] == NULL)
850 tx_first[ endpoint ] = packet;
854 tx_last[ endpoint ]->next = packet;
856 tx_last[ endpoint ] = packet;
861 tx_state[ endpoint ] = next;
862 b->addr = packet->buf;
863 b->desc = BDT_DESC( packet->len, ((uint32_t)b & 8) ? DATA1 : DATA0 );
868 void usb_device_reload()
870 if ( flashModeEnabled_define == 0 )
873 warn_print("flashModeEnabled not set, cancelling firmware reload...");
874 info_msg("Set flashModeEnabled to 1 in your kll configuration.");
879 #if defined(_mk20dx128vlf5_)
881 // MCHCK Kiibohd Variant
882 // Check to see if PTA3 (has a pull-up) is connected to GND (usually via jumper)
883 // Only allow reload if the jumper is present (security)
884 GPIOA_PDDR &= ~(1<<3); // Input
885 PORTA_PCR3 = PORT_PCR_PFE | PORT_PCR_MUX(1); // Internal pull-up
888 if ( GPIOA_PDIR & (1<<3) && flashModeEnabled_define != 0 )
891 warn_print("Security jumper not present, cancelling firmware reload...");
892 info_msg("Replace jumper on middle 2 pins, or manually press the firmware reload button.");
896 // Copies variable into the VBAT register, must be identical to the variable in the bootloader to jump to the bootloader flash mode
897 for ( int pos = 0; pos < sizeof(sys_reset_to_loader_magic); pos++ )
898 (&VBAT)[ pos ] = sys_reset_to_loader_magic[ pos ];
902 // Kiibohd mk20dx256vlh7
903 #elif defined(_mk20dx256vlh7_)
904 // Copies variable into the VBAT register, must be identical to the variable in the bootloader to jump to the bootloader flash mode
905 for ( int pos = 0; pos < sizeof(sys_reset_to_loader_magic); pos++ )
906 (&VBAT)[ pos ] = sys_reset_to_loader_magic[ pos ];
909 // Teensy 3.0 and 3.1
911 asm volatile("bkpt");
918 uint8_t status, stat, t;
920 //serial_print("isr");
921 //status = USB0_ISTAT;
922 //serial_phex(status);
923 //serial_print("\n");
927 print("USB ISR STATUS: ");
932 if ( (status & USB_INTEN_SOFTOKEN /* 04 */ ) )
934 if ( usb_configuration )
936 t = usb_reboot_timer;
939 usb_reboot_timer = --t;
945 t = usb_cdc_transmit_flush_timer;
948 usb_cdc_transmit_flush_timer = --t;
950 usb_serial_flush_callback();
954 USB0_ISTAT = USB_INTEN_SOFTOKEN;
957 if ( (status & USB_ISTAT_TOKDNE /* 08 */ ) )
961 //serial_print("token: ep=");
962 //serial_phex(stat >> 4);
963 //serial_print(stat & 0x08 ? ",tx" : ",rx");
964 //serial_print(stat & 0x04 ? ",odd\n" : ",even\n");
965 endpoint = stat >> 4;
972 bdt_t *b = stat2bufferdescriptor(stat);
973 usb_packet_t *packet = (usb_packet_t *)((uint8_t *)(b->addr) - 8);
976 serial_phex(endpoint);
977 serial_print(", pid:");
978 serial_phex(BDT_PID(b->desc));
979 serial_print(((uint32_t)b & 8) ? ", odd" : ", even");
980 serial_print(", count:");
981 serial_phex(b->desc >> 16);
984 endpoint--; // endpoint is index to zero-based arrays
989 packet = tx_first[ endpoint ];
992 //serial_print("tx packet\n");
993 tx_first[endpoint] = packet->next;
994 b->addr = packet->buf;
995 switch ( tx_state[ endpoint ] )
997 case TX_STATE_BOTH_FREE_EVEN_FIRST:
998 tx_state[ endpoint ] = TX_STATE_ODD_FREE;
1000 case TX_STATE_BOTH_FREE_ODD_FIRST:
1001 tx_state[ endpoint ] = TX_STATE_EVEN_FREE;
1003 case TX_STATE_EVEN_FREE:
1004 tx_state[ endpoint ] = TX_STATE_NONE_FREE_ODD_FIRST;
1006 case TX_STATE_ODD_FREE:
1007 tx_state[ endpoint ] = TX_STATE_NONE_FREE_EVEN_FIRST;
1012 b->desc = BDT_DESC( packet->len, ((uint32_t)b & 8) ? DATA1 : DATA0 );
1014 //serial_print("tx no packet\n");
1015 switch ( tx_state[ endpoint ] )
1017 case TX_STATE_BOTH_FREE_EVEN_FIRST:
1018 case TX_STATE_BOTH_FREE_ODD_FIRST:
1020 case TX_STATE_EVEN_FREE:
1021 tx_state[ endpoint ] = TX_STATE_BOTH_FREE_EVEN_FIRST;
1023 case TX_STATE_ODD_FREE:
1024 tx_state[ endpoint ] = TX_STATE_BOTH_FREE_ODD_FIRST;
1027 tx_state[ endpoint ] = ((uint32_t)b & 8)
1029 : TX_STATE_EVEN_FREE;
1036 packet->len = b->desc >> 16;
1037 if ( packet->len > 0 )
1040 packet->next = NULL;
1041 if ( rx_first[ endpoint ] == NULL )
1043 //serial_print("rx 1st, epidx=");
1044 //serial_phex(endpoint);
1045 //serial_print(", packet=");
1046 //serial_phex32((uint32_t)packet);
1047 //serial_print("\n");
1048 rx_first[ endpoint ] = packet;
1052 //serial_print("rx Nth, epidx=");
1053 //serial_phex(endpoint);
1054 //serial_print(", packet=");
1055 //serial_phex32((uint32_t)packet);
1056 //serial_print("\n");
1057 rx_last[ endpoint ]->next = packet;
1059 rx_last[ endpoint ] = packet;
1060 usb_rx_byte_count_data[ endpoint ] += packet->len;
1061 // TODO: implement a per-endpoint maximum # of allocated packets
1062 // so a flood of incoming data on 1 endpoint doesn't starve
1063 // the others if the user isn't reading it regularly
1064 packet = usb_malloc();
1067 b->addr = packet->buf;
1068 b->desc = BDT_DESC( 64, ((uint32_t)b & 8) ? DATA1 : DATA0 );
1072 //serial_print("starving ");
1073 //serial_phex(endpoint + 1);
1074 //serial_print(((uint32_t)b & 8) ? ",odd\n" : ",even\n");
1076 usb_rx_memory_needed++;
1081 b->desc = BDT_DESC( 64, ((uint32_t)b & 8) ? DATA1 : DATA0 );
1089 USB0_ISTAT = USB_ISTAT_TOKDNE;
1094 if ( status & USB_ISTAT_USBRST /* 01 */ )
1096 //serial_print("reset\n");
1098 // initialize BDT toggle bits
1099 USB0_CTL = USB_CTL_ODDRST;
1100 ep0_tx_bdt_bank = 0;
1102 // set up buffers to receive Setup and OUT packets
1103 table[index( 0, RX, EVEN ) ].desc = BDT_DESC( EP0_SIZE, 0 );
1104 table[index( 0, RX, EVEN ) ].addr = ep0_rx0_buf;
1105 table[index( 0, RX, ODD ) ].desc = BDT_DESC( EP0_SIZE, 0 );
1106 table[index( 0, RX, ODD ) ].addr = ep0_rx1_buf;
1107 table[index( 0, TX, EVEN ) ].desc = 0;
1108 table[index( 0, TX, ODD ) ].desc = 0;
1110 // activate endpoint 0
1111 USB0_ENDPT0 = USB_ENDPT_EPRXEN | USB_ENDPT_EPTXEN | USB_ENDPT_EPHSHK;
1113 // clear all ending interrupts
1114 USB0_ERRSTAT = 0xFF;
1117 // set the address to zero during enumeration
1120 // enable other interrupts
1122 USB0_INTEN = USB_INTEN_TOKDNEEN |
1123 USB_INTEN_SOFTOKEN |
1126 USB_INTEN_USBRSTEN |
1129 // is this necessary?
1130 USB0_CTL = USB_CTL_USBENSOFEN;
1135 if ( (status & USB_ISTAT_STALL /* 80 */ ) )
1137 //serial_print("stall:\n");
1138 USB0_ENDPT0 = USB_ENDPT_EPRXEN | USB_ENDPT_EPTXEN | USB_ENDPT_EPHSHK;
1139 USB0_ISTAT = USB_ISTAT_STALL;
1141 if ( (status & USB_ISTAT_ERROR /* 02 */ ) )
1143 uint8_t err = USB0_ERRSTAT;
1145 //serial_print("err:");
1147 //serial_print("\n");
1148 USB0_ISTAT = USB_ISTAT_ERROR;
1151 if ( (status & USB_ISTAT_SLEEP /* 10 */ ) )
1153 //serial_print("sleep\n");
1154 USB0_ISTAT = USB_ISTAT_SLEEP;
1163 print("USB INIT"NL);
1166 // Clear out endpoints table
1167 for ( int i = 0; i <= NUM_ENDPOINTS * 4; i++ )
1173 // this basically follows the flowchart in the Kinetis
1174 // Quick Reference User Guide, Rev. 1, 03/2012, page 141
1176 // assume 48 MHz clock already running
1177 // SIM - enable clock
1178 SIM_SCGC4 |= SIM_SCGC4_USBOTG;
1181 USB0_USBTRC0 = USB_USBTRC_USBRESET;
1182 while ( (USB0_USBTRC0 & USB_USBTRC_USBRESET) != 0 ); // wait for reset to end
1184 // set desc table base addr
1185 USB0_BDTPAGE1 = ((uint32_t)table) >> 8;
1186 USB0_BDTPAGE2 = ((uint32_t)table) >> 16;
1187 USB0_BDTPAGE3 = ((uint32_t)table) >> 24;
1189 // clear all ISR flags
1191 USB0_ERRSTAT = 0xFF;
1192 USB0_OTGISTAT = 0xFF;
1194 USB0_USBTRC0 |= 0x40; // undocumented bit
1197 USB0_CTL = USB_CTL_USBENSOFEN;
1200 // enable reset interrupt
1201 USB0_INTEN = USB_INTEN_USBRSTEN;
1203 // enable interrupt in NVIC...
1204 NVIC_SET_PRIORITY( IRQ_USBOTG, 112 );
1205 NVIC_ENABLE_IRQ( IRQ_USBOTG );
1208 USB0_CONTROL = USB_CONTROL_DPPULLUPNONOTG;
1213 // return 0 if the USB is not configured, or the configuration
1214 // number selected by the HOST
1215 uint8_t usb_configured()
1217 return usb_configuration;