visus
/
teensy-cores
Obserwuj 1
Polub 0
Forkuj 0
Kod Zgłoszenia 0 Oczekujące zmiany 0 Wydania 0 Wiki Aktywność
Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
235 Commity
1 Gałąź
Drzewo: 13dd541650
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z '13dd541650'
${ noResults }
teensy-cores/usb_hid/usb.c

898 lines
36KB
Czysty Wina Historia 

  1. /* USB Serial Example for Teensy USB Development Board

  2.  * http://www.pjrc.com/teensy/usb_serial.html

  3.  * Copyright (c) 2008 PJRC.COM, LLC

  4.  * 

  5.  * Permission is hereby granted, free of charge, to any person obtaining a copy

  6.  * of this software and associated documentation files (the "Software"), to deal

  7.  * in the Software without restriction, including without limitation the rights

  8.  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

  9.  * copies of the Software, and to permit persons to whom the Software is

  10.  * furnished to do so, subject to the following conditions:

  11.  * 

  12.  * The above copyright notice and this permission notice shall be included in

  13.  * all copies or substantial portions of the Software.

  14.  * 

  15.  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

  16.  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

  17.  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

  18.  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

  19.  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

  20.  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

  21.  * THE SOFTWARE.

  22.  */

  23. 

  24. 

  25. #include "usb_common.h"

  26. #include "usb_private.h"

  27. 

  28. 

  29. 

  30. /**************************************************************************

  31.  *

  32.  *  Endpoint Buffer Configuration

  33.  *

  34.  **************************************************************************/

  35. 

  36. 

  37. static const uint8_t PROGMEM endpoint_config_table[] = {

  38. 	1, EP_TYPE_INTERRUPT_IN,  EP_SIZE(DEBUG_TX_SIZE) | DEBUG_TX_BUFFER,

  39. 	1, EP_TYPE_INTERRUPT_OUT, EP_SIZE(DEBUG_RX_SIZE) | DEBUG_RX_BUFFER,

  40. 	1, EP_TYPE_INTERRUPT_IN,  EP_SIZE(KEYBOARD_SIZE) | KEYBOARD_BUFFER,

  41. 	1, EP_TYPE_INTERRUPT_IN,  EP_SIZE(MOUSE_SIZE) | MOUSE_BUFFER,

  42. #ifdef JOYSTICK_INTERFACE

  43. 	1, EP_TYPE_INTERRUPT_IN,  EP_SIZE(JOYSTICK_SIZE) | JOYSTICK_BUFFER,

  44. 	0

  45. #endif

  46. };

  47. 

  48. 

  49. /**************************************************************************

  50.  *

  51.  *  Descriptor Data

  52.  *

  53.  **************************************************************************/

  54. 

  55. // Descriptors are the data that your computer reads when it auto-detects

  56. // this USB device (called "enumeration" in USB lingo).  The most commonly

  57. // changed items are editable at the top of this file.  Changing things

  58. // in here should only be done by those who've read chapter 9 of the USB

  59. // spec and relevant portions of any USB class specifications!

  60. 

  61. static const uint8_t PROGMEM device_descriptor[] = {

  62. 	18,					// bLength

  63. 	1,					// bDescriptorType

  64. 	0x00, 0x02,				// bcdUSB

  65. 	0,					// bDeviceClass

  66. 	0,					// bDeviceSubClass

  67. 	0,					// bDeviceProtocol

  68. 	ENDPOINT0_SIZE,				// bMaxPacketSize0

  69. 	LSB(VENDOR_ID), MSB(VENDOR_ID),		// idVendor

  70. 	LSB(PRODUCT_ID), MSB(PRODUCT_ID),	// idProduct

  71. 	0x05, 0x01,				// bcdDevice

  72. 	0,					// iManufacturer

  73. 	1,					// iProduct

  74. 	0,					// iSerialNumber

  75. 	1					// bNumConfigurations

  76. };

  77. 

  78. // Keyboard Protocol 1, HID 1.11 spec, Appendix B, page 59-60

  79. static const uint8_t PROGMEM keyboard_hid_report_desc[] = {

  80.         0x05, 0x01,             //  Usage Page (Generic Desktop),

  81.         0x09, 0x06,             //  Usage (Keyboard),

  82.         0xA1, 0x01,             //  Collection (Application),

  83.         0x75, 0x01,             //  Report Size (1),

  84.         0x95, 0x08,             //  Report Count (8),

  85.         0x05, 0x07,             //  Usage Page (Key Codes),

  86.         0x19, 0xE0,             //  Usage Minimum (224),

  87.         0x29, 0xE7,             //  Usage Maximum (231),

  88.         0x15, 0x00,             //  Logical Minimum (0),

  89.         0x25, 0x01,             //  Logical Maximum (1),

  90.         0x81, 0x02,             //  Input (Data, Variable, Absolute), ;Modifier byte

  91.         0x95, 0x08,             //  Report Count (8),

  92.         0x75, 0x01,             //  Report Size (1),

  93.         0x15, 0x00,		//  Logical Minimum (0),

  94.         0x25, 0x01,             //  Logical Maximum (1),

  95.         0x05, 0x0C,             //  Usage Page (Consumer),

  96. 	0x09, 0xE9,		//  Usage (Volume Increment),

  97. 	0x09, 0xEA,		//  Usage (Volume Decrement),

  98. 	0x09, 0xE2,		//  Usage (Mute),

  99. 	0x09, 0xCD,		//  Usage (Play/Pause),

  100. 	0x09, 0xB5,		//  Usage (Scan Next Track),

  101. 	0x09, 0xB6,		//  Usage (Scan Previous Track),

  102. 	0x09, 0xB7,		//  Usage (Stop),

  103. 	0x09, 0xB8,		//  Usage (Eject),

  104.         0x81, 0x02,             //  Input (Data, Variable, Absolute), ;Media keys

  105.         0x95, 0x05,             //  Report Count (5),

  106.         0x75, 0x01,             //  Report Size (1),

  107.         0x05, 0x08,             //  Usage Page (LEDs),

  108.         0x19, 0x01,             //  Usage Minimum (1),

  109.         0x29, 0x05,             //  Usage Maximum (5),

  110.         0x91, 0x02,             //  Output (Data, Variable, Absolute), ;LED report

  111.         0x95, 0x01,             //  Report Count (1),

  112.         0x75, 0x03,             //  Report Size (3),

  113.         0x91, 0x03,             //  Output (Constant),                 ;LED report padding

  114.         0x95, 0x06,             //  Report Count (6),

  115.         0x75, 0x08,             //  Report Size (8),

  116.         0x15, 0x00,             //  Logical Minimum (0),

  117.         0x25, 0x7F,             //  Logical Maximum(104),

  118.         0x05, 0x07,             //  Usage Page (Key Codes),

  119.         0x19, 0x00,             //  Usage Minimum (0),

  120.         0x29, 0x7F,             //  Usage Maximum (104),

  121.         0x81, 0x00,             //  Input (Data, Array),		;Normal keys

  122.         0xc0			// End Collection

  123. };

  124. 

  125. // Mouse Protocol 1, HID 1.11 spec, Appendix B, page 59-60, with wheel extension

  126. static const uint8_t PROGMEM mouse_hid_report_desc[] = {

  127.         0x05, 0x01,                     // Usage Page (Generic Desktop)

  128.         0x09, 0x02,                     // Usage (Mouse)

  129.         0xA1, 0x01,                     // Collection (Application)

  130.         0x05, 0x09,                     //   Usage Page (Button)

  131.         0x19, 0x01,                     //   Usage Minimum (Button #1)

  132.         0x29, 0x03,                     //   Usage Maximum (Button #3)

  133.         0x15, 0x00,                     //   Logical Minimum (0)

  134.         0x25, 0x01,                     //   Logical Maximum (1)

  135.         0x95, 0x03,                     //   Report Count (3)

  136.         0x75, 0x01,                     //   Report Size (1)

  137.         0x81, 0x02,                     //   Input (Data, Variable, Absolute)

  138.         0x95, 0x01,                     //   Report Count (1)

  139.         0x75, 0x05,                     //   Report Size (5)

  140.         0x81, 0x03,                     //   Input (Constant)

  141.         0x05, 0x01,                     //   Usage Page (Generic Desktop)

  142.         0x09, 0x30,                     //   Usage (X)

  143.         0x09, 0x31,                     //   Usage (Y)

  144.         0x15, 0x81,                     //   Logical Minimum (-127)

  145.         0x25, 0x7F,                     //   Logical Maximum (127)

  146.         0x75, 0x08,                     //   Report Size (8),

  147.         0x95, 0x02,                     //   Report Count (2),

  148.         0x81, 0x06,                     //   Input (Data, Variable, Relative)

  149.         0x09, 0x38,                     //   Usage (Wheel)

  150.         0x95, 0x01,                     //   Report Count (1),

  151.         0x81, 0x06,                     //   Input (Data, Variable, Relative)

  152.         0xC0                            // End Collection

  153. };

  154. 

  155. #ifdef JOYSTICK_INTERFACE

  156. static const uint8_t PROGMEM joystick_hid_report_desc[] = {

  157.         0x05, 0x01,                     // Usage Page (Generic Desktop)

  158.         0x09, 0x04,                     // Usage (Joystick)

  159.         0xA1, 0x01,                     // Collection (Application)

  160. 	0x15, 0x00,			// Logical Minimum (0)

  161. 	0x25, 0x01,			// Logical Maximum (1)

  162. 	0x75, 0x01,			// Report Size (1)

  163. 	0x95, 0x20,			// Report Count (32)

  164. 	0x05, 0x09,			// Usage Page (Button)

  165. 	0x19, 0x01,			// Usage Minimum (Button #1)

  166. 	0x29, 0x20,			// Usage Maximum (Button #32)

  167. 	0x81, 0x02,			// Input (variable,absolute)

  168. 	0x15, 0x00,			// Logical Minimum (0)

  169. 	0x25, 0x07,			// Logical Maximum (7)

  170. 	0x35, 0x00,			// Physical Minimum (0)

  171. 	0x46, 0x3B, 0x01,		// Physical Maximum (315)

  172. 	0x75, 0x04,			// Report Size (4)

  173. 	0x95, 0x01,			// Report Count (1)

  174. 	0x65, 0x14,			// Unit (20)

  175.         0x05, 0x01,                     // Usage Page (Generic Desktop)

  176. 	0x09, 0x39,			// Usage (Hat switch)

  177. 	0x81, 0x42,			// Input (variable,absolute,null_state)

  178.         0x05, 0x01,                     // Usage Page (Generic Desktop)

  179. 	0x09, 0x01,			// Usage (Pointer)

  180.         0xA1, 0x00,                     // Collection ()

  181. 	0x15, 0x00,			//   Logical Minimum (0)

  182. 	0x26, 0xFF, 0x03,		//   Logical Maximum (1023)

  183. 	0x75, 0x0A,			//   Report Size (10)

  184. 	0x95, 0x04,			//   Report Count (4)

  185. 	0x09, 0x30,			//   Usage (X)

  186. 	0x09, 0x31,			//   Usage (Y)

  187. 	0x09, 0x32,			//   Usage (Z)

  188. 	0x09, 0x35,			//   Usage (Rz)

  189. 	0x81, 0x02,			//   Input (variable,absolute)

  190.         0xC0,                           // End Collection

  191. 	0x15, 0x00,			// Logical Minimum (0)

  192. 	0x26, 0xFF, 0x03,		// Logical Maximum (1023)

  193. 	0x75, 0x0A,			// Report Size (10)

  194. 	0x95, 0x02,			// Report Count (2)

  195. 	0x09, 0x36,			// Usage (Slider)

  196. 	0x09, 0x36,			// Usage (Slider)

  197. 	0x81, 0x02,			// Input (variable,absolute)

  198.         0xC0                            // End Collection

  199. };

  200. #endif

  201. 

  202. 

  203. 

  204. 

  205. 

  206. 

  207. 

  208. static const uint8_t PROGMEM debug_hid_report_desc[] = {

  209.         0x06, 0xC9, 0xFF,                       // Usage Page 0xFFC9 (vendor defined)

  210.         0x09, 0x04,                             // Usage 0x04

  211.         0xA1, 0x5C,                             // Collection 0x5C

  212.         0x75, 0x08,                             // report size = 8 bits (global)

  213.         0x15, 0x00,                             // logical minimum = 0 (global)

  214.         0x26, 0xFF, 0x00,                       // logical maximum = 255 (global)

  215.         0x95, DEBUG_TX_SIZE,                    // report count (global)

  216.         0x09, 0x75,                             // usage (local)

  217.         0x81, 0x02,                             // Input

  218.         0x95, DEBUG_RX_SIZE,                    // report count (global)

  219.         0x09, 0x76,                             // usage (local)

  220.         0x91, 0x02,                             // Output

  221.         0x95, 0x04,                             // report count (global)

  222.         0x09, 0x76,                             // usage (local)

  223.         0xB1, 0x02,                             // Feature

  224.         0xC0                                    // end collection

  225. };

  226. 

  227. 

  228. 

  229. #define KEYBOARD_HID_DESC_OFFSET	( 9 + 9 )

  230. #define MOUSE_HID_DESC_OFFSET		( 9 + 9+9+7 + 9 )

  231. #define DEBUG_HID_DESC_OFFSET		( 9 + 9+9+7 + 9+9+7 + 9 )

  232. #ifdef JOYSTICK_INTERFACE

  233. #define JOYSTICK_HID_DESC_OFFSET	( 9 + 9+9+7 + 9+9+7 + 9+9+7+7 + 9 )

  234. #define CONFIG1_DESC_SIZE		( 9 + 9+9+7 + 9+9+7 + 9+9+7+7 + 9+9+7)

  235. #else

  236. #define CONFIG1_DESC_SIZE		( 9 + 9+9+7 + 9+9+7 + 9+9+7+7 )

  237. #endif

  238. 

  239. static const uint8_t PROGMEM config1_descriptor[CONFIG1_DESC_SIZE] = {

  240. 	// configuration descriptor, USB spec 9.6.3, page 264-266, Table 9-10

  241. 	9, 					// bLength;

  242. 	2,					// bDescriptorType;

  243. 	LSB(CONFIG1_DESC_SIZE),			// wTotalLength

  244. 	MSB(CONFIG1_DESC_SIZE),

  245. 	NUM_INTERFACE,				// bNumInterfaces

  246. 	1,					// bConfigurationValue

  247. 	0,					// iConfiguration

  248. 	0xC0,					// bmAttributes

  249. 	50,					// bMaxPower

  250. 

  251.         // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12

  252.         9,                                      // bLength

  253.         4,                                      // bDescriptorType

  254.         KEYBOARD_INTERFACE,                     // bInterfaceNumber

  255.         0,                                      // bAlternateSetting

  256.         1,                                      // bNumEndpoints

  257.         0x03,                                   // bInterfaceClass (0x03 = HID)

  258.         0x01,                                   // bInterfaceSubClass (0x01 = Boot)

  259.         0x01,                                   // bInterfaceProtocol (0x01 = Keyboard)

  260.         0,                                      // iInterface

  261.         // HID interface descriptor, HID 1.11 spec, section 6.2.1

  262.         9,                                      // bLength

  263.         0x21,                                   // bDescriptorType

  264.         0x11, 0x01,                             // bcdHID

  265.         0,                                      // bCountryCode

  266.         1,                                      // bNumDescriptors

  267.         0x22,                                   // bDescriptorType

  268.         sizeof(keyboard_hid_report_desc),       // wDescriptorLength

  269.         0,

  270.         // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13

  271.         7,                                      // bLength

  272.         5,                                      // bDescriptorType

  273.         KEYBOARD_ENDPOINT | 0x80,               // bEndpointAddress

  274.         0x03,                                   // bmAttributes (0x03=intr)

  275.         KEYBOARD_SIZE, 0,                       // wMaxPacketSize

  276.         KEYBOARD_INTERVAL,                      // bInterval

  277. 

  278.         // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12

  279.         9,                                      // bLength

  280.         4,                                      // bDescriptorType

  281.         MOUSE_INTERFACE,                        // bInterfaceNumber

  282.         0,                                      // bAlternateSetting

  283.         1,                                      // bNumEndpoints

  284.         0x03,                                   // bInterfaceClass (0x03 = HID)

  285.         0x01,                                   // bInterfaceSubClass (0x01 = Boot)

  286.         0x02,                                   // bInterfaceProtocol (0x02 = Mouse)

  287.         0,                                      // iInterface

  288.         // HID interface descriptor, HID 1.11 spec, section 6.2.1

  289.         9,                                      // bLength

  290.         0x21,                                   // bDescriptorType

  291.         0x11, 0x01,                             // bcdHID

  292.         0,                                      // bCountryCode

  293.         1,                                      // bNumDescriptors

  294.         0x22,                                   // bDescriptorType

  295.         sizeof(mouse_hid_report_desc),          // wDescriptorLength

  296.         0,

  297.         // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13

  298.         7,                                      // bLength

  299.         5,                                      // bDescriptorType

  300.         MOUSE_ENDPOINT | 0x80,                  // bEndpointAddress

  301.         0x03,                                   // bmAttributes (0x03=intr)

  302.         MOUSE_SIZE, 0,                          // wMaxPacketSize

  303.         MOUSE_INTERVAL,                         // bInterval

  304. 

  305.         // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12

  306.         9,                                      // bLength

  307.         4,                                      // bDescriptorType

  308.         DEBUG_INTERFACE,                        // bInterfaceNumber

  309.         0,                                      // bAlternateSetting

  310.         2,                                      // bNumEndpoints

  311.         0x03,                                   // bInterfaceClass (0x03 = HID)

  312.         0x00,                                   // bInterfaceSubClass

  313.         0x00,                                   // bInterfaceProtocol

  314.         0,                                      // iInterface

  315.         // HID interface descriptor, HID 1.11 spec, section 6.2.1

  316.         9,                                      // bLength

  317.         0x21,                                   // bDescriptorType

  318.         0x11, 0x01,                             // bcdHID

  319.         0,                                      // bCountryCode

  320.         1,                                      // bNumDescriptors

  321.         0x22,                                   // bDescriptorType

  322.         sizeof(debug_hid_report_desc),          // wDescriptorLength

  323.         0,

  324.         // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13

  325.         7,                                      // bLength

  326.         5,                                      // bDescriptorType

  327.         DEBUG_TX_ENDPOINT | 0x80,               // bEndpointAddress

  328.         0x03,                                   // bmAttributes (0x03=intr)

  329.         DEBUG_TX_SIZE, 0,                       // wMaxPacketSize

  330.         DEBUG_TX_INTERVAL,                      // bInterval

  331.         // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13

  332.         7,                                      // bLength

  333.         5,                                      // bDescriptorType

  334.         DEBUG_RX_ENDPOINT,                      // bEndpointAddress

  335.         0x03,                                   // bmAttributes (0x03=intr)

  336.         DEBUG_RX_SIZE, 0,                       // wMaxPacketSize

  337.         DEBUG_RX_INTERVAL,                      // bInterval

  338. 

  339. #ifdef JOYSTICK_INTERFACE

  340.         // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12

  341.         9,                                      // bLength

  342.         4,                                      // bDescriptorType

  343.         JOYSTICK_INTERFACE,                     // bInterfaceNumber

  344.         0,                                      // bAlternateSetting

  345.         1,                                      // bNumEndpoints

  346.         0x03,                                   // bInterfaceClass (0x03 = HID)

  347.         0x00,                                   // bInterfaceSubClass

  348.         0x00,                                   // bInterfaceProtocol

  349.         0,                                      // iInterface

  350.         // HID interface descriptor, HID 1.11 spec, section 6.2.1

  351.         9,                                      // bLength

  352.         0x21,                                   // bDescriptorType

  353.         0x11, 0x01,                             // bcdHID

  354.         0,                                      // bCountryCode

  355.         1,                                      // bNumDescriptors

  356.         0x22,                                   // bDescriptorType

  357.         sizeof(joystick_hid_report_desc),       // wDescriptorLength

  358.         0,

  359.         // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13

  360.         7,                                      // bLength

  361.         5,                                      // bDescriptorType

  362.         JOYSTICK_ENDPOINT | 0x80,               // bEndpointAddress

  363.         0x03,                                   // bmAttributes (0x03=intr)

  364.         12, 0,					// wMaxPacketSize

  365.         JOYSTICK_INTERVAL,                      // bInterval

  366. #endif

  367. };

  368. 

  369. // If you're desperate for a little extra code memory, these strings

  370. // can be completely removed if iManufacturer, iProduct, iSerialNumber

  371. // in the device desciptor are changed to zeros.

  372. struct usb_string_descriptor_struct {

  373. 	uint8_t bLength;

  374. 	uint8_t bDescriptorType;

  375. 	int16_t wString[];

  376. };

  377. static const struct usb_string_descriptor_struct PROGMEM string0 = {

  378. 	4,

  379. 	3,

  380. 	{0x0409}

  381. };

  382. static const struct usb_string_descriptor_struct PROGMEM string1 = {

  383. 	sizeof(STR_PRODUCT),

  384. 	3,

  385. 	STR_PRODUCT

  386. };

  387. 

  388. // This table defines which descriptor data is sent for each specific

  389. // request from the host (in wValue and wIndex).

  390. static const struct descriptor_list_struct {

  391. 	uint16_t	wValue;

  392. 	uint16_t	wIndex;

  393. 	const uint8_t	*addr;

  394. 	uint8_t		length;

  395. } PROGMEM descriptor_list[] = {

  396. 	{0x0100, 0x0000, device_descriptor, sizeof(device_descriptor)},

  397. 	{0x0200, 0x0000, config1_descriptor, sizeof(config1_descriptor)},

  398.         {0x2200, KEYBOARD_INTERFACE, keyboard_hid_report_desc, sizeof(keyboard_hid_report_desc)},

  399.         {0x2100, KEYBOARD_INTERFACE, config1_descriptor+KEYBOARD_HID_DESC_OFFSET, 9},

  400.         {0x2200, MOUSE_INTERFACE, mouse_hid_report_desc, sizeof(mouse_hid_report_desc)},

  401.         {0x2100, MOUSE_INTERFACE, config1_descriptor+MOUSE_HID_DESC_OFFSET, 9},

  402.         {0x2200, DEBUG_INTERFACE, debug_hid_report_desc, sizeof(debug_hid_report_desc)},

  403.         {0x2100, DEBUG_INTERFACE, config1_descriptor+DEBUG_HID_DESC_OFFSET, 9},

  404. #ifdef JOYSTICK_INTERFACE

  405.         {0x2200, JOYSTICK_INTERFACE, joystick_hid_report_desc, sizeof(joystick_hid_report_desc)},

  406.         {0x2100, JOYSTICK_INTERFACE, config1_descriptor+JOYSTICK_HID_DESC_OFFSET, 9},

  407. #endif

  408. 	{0x0300, 0x0000, (const uint8_t *)&string0, 4},

  409. 	{0x0301, 0x0409, (const uint8_t *)&string1, sizeof(STR_PRODUCT)},

  410. };

  411. #define NUM_DESC_LIST (sizeof(descriptor_list)/sizeof(struct descriptor_list_struct))

  412. 

  413. 

  414. /**************************************************************************

  415.  *

  416.  *  Variables - these are the only non-stack RAM usage

  417.  *

  418.  **************************************************************************/

  419. 

  420. // zero when we are not configured, non-zero when enumerated

  421. volatile uint8_t usb_configuration USBSTATE;

  422. volatile uint8_t usb_suspended USBSTATE;

  423. 

  424. // the time remaining before we transmit any partially full

  425. // packet, or send a zero length packet.

  426. volatile uint8_t debug_flush_timer USBSTATE;

  427. 

  428. // byte0: which modifier keys are currently pressed

  429. //  1=left ctrl,    2=left shift,   4=left alt,    8=left gui

  430. //  16=right ctrl, 32=right shift, 64=right alt, 128=right gui

  431. // byte1: media keys (TODO: document these)

  432. // bytes2-7: which keys are currently pressed, up to 6 keys may be down at once

  433. uint8_t keyboard_report_data[8] USBSTATE;

  434. 

  435. // protocol setting from the host.  We use exactly the same report

  436. // either way, so this variable only stores the setting since we

  437. // are required to be able to report which setting is in use.

  438. static uint8_t keyboard_protocol USBSTATE;

  439. 

  440. // the idle configuration, how often we send the report to the

  441. // host (ms * 4) even when it hasn't changed

  442. static uint8_t keyboard_idle_config USBSTATE;

  443. 

  444. // count until idle timeout

  445. uint8_t keyboard_idle_count USBSTATE;

  446. 

  447. // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana

  448. volatile uint8_t keyboard_leds USBSTATE;

  449. 

  450. // which buttons are currently pressed

  451. uint8_t mouse_buttons USBSTATE;

  452. 

  453. // protocol setting from the host.  We use exactly the same report

  454. // either way, so this variable only stores the setting since we

  455. // are required to be able to report which setting is in use.

  456. static uint8_t mouse_protocol USBSTATE;

  457. 

  458. // joystick data

  459. #ifdef JOYSTICK_INTERFACE

  460. uint8_t joystick_report_data[12] USBSTATE;

  461. #endif

  462. 

  463. 

  464. /**************************************************************************

  465.  *

  466.  *  Public Functions - these are the API intended for the user

  467.  *

  468.  **************************************************************************/

  469. 

  470. 

  471. 

  472. // initialize USB serial

  473. void usb_init(void)

  474. {

  475. 	uint8_t u;

  476. 

  477. 	u = USBCON;

  478. 	if ((u & (1<<USBE)) && !(u & (1<<FRZCLK))) return;

  479. 	HW_CONFIG();

  480.         USB_FREEZE();				// enable USB

  481.         PLL_CONFIG();				// config PLL

  482.         while (!(PLLCSR & (1<<PLOCK))) ;	// wait for PLL lock

  483.         USB_CONFIG();				// start USB clock

  484.         UDCON = 0;				// enable attach resistor

  485. 	usb_configuration = 0;

  486. 	usb_suspended = 0;

  487. 	debug_flush_timer = 0;

  488. 	keyboard_report_data[0] = 0;

  489. 	keyboard_report_data[1] = 0;

  490. 	keyboard_report_data[2] = 0;

  491. 	keyboard_report_data[3] = 0;

  492. 	keyboard_report_data[4] = 0;

  493. 	keyboard_report_data[5] = 0;

  494. 	keyboard_report_data[6] = 0;

  495. 	keyboard_report_data[7] = 0;

  496. 	keyboard_protocol = 1;

  497. 	keyboard_idle_config = 125;

  498. 	keyboard_idle_count = 0;

  499. 	keyboard_leds = 0;

  500. 	mouse_buttons = 0;

  501. 	mouse_protocol = 1;

  502. #ifdef JOYSTICK_INTERFACE

  503. 	joystick_report_data[0] = 0;

  504. 	joystick_report_data[1] = 0;

  505. 	joystick_report_data[2] = 0;

  506. 	joystick_report_data[3] = 0;

  507. 	joystick_report_data[4] =  0x0F;

  508. 	joystick_report_data[5] =  0x20;

  509. 	joystick_report_data[6] =  0x80;

  510. 	joystick_report_data[7] =  0x00;

  511. 	joystick_report_data[8] =  0x02;

  512. 	joystick_report_data[9] =  0x08;

  513. 	joystick_report_data[10] = 0x20;

  514. 	joystick_report_data[11] = 0x80;

  515. #endif

  516. 	UDINT = 0;

  517.         UDIEN = (1<<EORSTE)|(1<<SOFE);

  518. 	//sei();  // init() in wiring.c does this

  519. }

  520. 

  521. void usb_shutdown(void)

  522. {

  523. 	UDIEN = 0;		// disable interrupts

  524. 	UDCON = 1;		// disconnect attach resistor

  525. 	USBCON = 0;		// shut off USB periperal

  526. 	PLLCSR = 0;		// shut off PLL

  527. 	usb_configuration = 0;

  528. 	usb_suspended = 1;

  529. }

  530. 

  531. 

  532. // Public API functions moved to usb_api.cpp

  533. 

  534. /**************************************************************************

  535.  *

  536.  *  Private Functions - not intended for general user consumption....

  537.  *

  538.  **************************************************************************/

  539. 

  540. 

  541. 

  542. // USB Device Interrupt - handle all device-level events

  543. // the transmit buffer flushing is triggered by the start of frame

  544. //

  545. ISR(USB_GEN_vect)

  546. {

  547. 	uint8_t intbits, t, i;

  548. 	static uint8_t div4=0;

  549. 

  550.         intbits = UDINT;

  551.         UDINT = 0;

  552.         if (intbits & (1<<EORSTI)) {

  553. 		UENUM = 0;

  554. 		UECONX = 1;

  555. 		UECFG0X = EP_TYPE_CONTROL;

  556. 		UECFG1X = EP_SIZE(ENDPOINT0_SIZE) | EP_SINGLE_BUFFER;

  557. 		UEIENX = (1<<RXSTPE);

  558. 		usb_configuration = 0;

  559.         }

  560.         if ((intbits & (1<<SOFI)) && usb_configuration) {

  561.                 t = debug_flush_timer;

  562.                 if (t) {

  563.                         debug_flush_timer = -- t;

  564.                         if (!t) {

  565.                                 UENUM = DEBUG_TX_ENDPOINT;

  566.                                 while ((UEINTX & (1<<RWAL))) {

  567.                                         UEDATX = 0;

  568.                                 }

  569.                                 UEINTX = 0x3A;

  570.                         }

  571.                 }

  572.                 if (keyboard_idle_config && (++div4 & 3) == 0) {

  573.                         UENUM = KEYBOARD_ENDPOINT;

  574.                         if (UEINTX & (1<<RWAL)) {

  575.                                 keyboard_idle_count++;

  576.                                 if (keyboard_idle_count == keyboard_idle_config) {

  577.                                         keyboard_idle_count = 0;

  578. 					//len = keyboard_protocol ? sizeof(keyboard_keys) : 8;

  579.                                         for (i=0; i < 8; i++) {

  580.                                                 UEDATX = keyboard_report_data[i];

  581.                                         }

  582.                                         UEINTX = 0x3A;

  583.                                 }

  584.                         }

  585.                 }

  586.         }

  587. 	if (intbits & (1<<SUSPI)) {

  588. 		// USB Suspend (inactivity for 3ms)

  589. 		UDIEN = (1<<WAKEUPE);

  590. 		usb_configuration = 0;

  591. 		usb_suspended = 1;

  592. 		#if (F_CPU >= 8000000L)

  593. 		// WAKEUPI does not work with USB clock freeze 

  594. 		// when CPU is running less than 8 MHz.

  595. 		// Is this a hardware bug?

  596. 		USB_FREEZE();			// shut off USB

  597. 		PLLCSR = 0;			// shut off PLL

  598. 		#endif

  599. 		// to properly meet the USB spec, current must

  600. 		// reduce to less than 2.5 mA, which means using

  601. 		// powerdown mode, but that breaks the Arduino

  602. 		// user's paradigm....

  603. 	}

  604. 	if (usb_suspended && (intbits & (1<<WAKEUPI))) {

  605. 		// USB Resume (pretty much any activity)

  606. 		#if (F_CPU >= 8000000L)

  607. 		PLL_CONFIG();

  608. 		while (!(PLLCSR & (1<<PLOCK))) ;

  609. 		USB_CONFIG();

  610. 		#endif

  611. 		UDIEN = (1<<EORSTE)|(1<<SOFE)|(1<<SUSPE);

  612. 		usb_suspended = 0;

  613. 		return;

  614. 	}

  615. }

  616. 

  617. 

  618. // Misc functions to wait for ready and send/receive packets

  619. static inline void usb_wait_in_ready(void)

  620. {

  621. 	while (!(UEINTX & (1<<TXINI))) ;

  622. }

  623. static inline void usb_send_in(void)

  624. {

  625. 	UEINTX = ~(1<<TXINI);

  626. }

  627. static inline void usb_wait_receive_out(void)

  628. {

  629. 	while (!(UEINTX & (1<<RXOUTI))) ;

  630. }

  631. static inline void usb_ack_out(void)

  632. {

  633. 	UEINTX = ~(1<<RXOUTI);

  634. }

  635. 

  636. 

  637. 

  638. // USB Endpoint Interrupt - endpoint 0 is handled here.  The

  639. // other endpoints are manipulated by the user-callable

  640. // functions, and the start-of-frame interrupt.

  641. //

  642. ISR(USB_COM_vect)

  643. {

  644.         uint8_t intbits;

  645. 	const uint8_t *list;

  646.         const uint8_t *cfg;

  647. 	uint8_t i, n, len, en;

  648. 	uint8_t bmRequestType;

  649. 	uint8_t bRequest;

  650. 	uint16_t wValue;

  651. 	uint16_t wIndex;

  652. 	uint16_t wLength;

  653. 	uint16_t desc_val;

  654. 	const uint8_t *desc_addr;

  655. 	uint8_t	desc_length;

  656. 

  657. 	UENUM = 0;

  658. 	intbits = UEINTX;

  659. 	if (intbits & (1<<RXSTPI)) {

  660. 		bmRequestType = UEDATX;

  661. 		bRequest = UEDATX;

  662. 		read_word_lsbfirst(wValue, UEDATX);

  663. 		read_word_lsbfirst(wIndex, UEDATX);

  664. 		read_word_lsbfirst(wLength, UEDATX);

  665. 		UEINTX = ~((1<<RXSTPI) | (1<<RXOUTI) | (1<<TXINI));

  666. 		if (bRequest == GET_DESCRIPTOR) {

  667. 			list = (const uint8_t *)descriptor_list;

  668. 			for (i=0; ; i++) {

  669. 				if (i >= NUM_DESC_LIST) {

  670. 					UECONX = (1<<STALLRQ)|(1<<EPEN);  //stall

  671. 					return;

  672. 				}

  673. 				pgm_read_word_postinc(desc_val, list);

  674. 				if (desc_val != wValue) {

  675. 					list += sizeof(struct descriptor_list_struct)-2;

  676. 					continue;

  677. 				}

  678. 				pgm_read_word_postinc(desc_val, list);

  679. 				if (desc_val != wIndex) {

  680. 					list += sizeof(struct descriptor_list_struct)-4;

  681. 					continue;

  682. 				}

  683. 				pgm_read_word_postinc(desc_addr, list);

  684. 				desc_length = pgm_read_byte(list);

  685. 				break;

  686. 			}

  687. 			len = (wLength < 256) ? wLength : 255;

  688. 			if (len > desc_length) len = desc_length;

  689. 			list = desc_addr;

  690. 			do {

  691. 				// wait for host ready for IN packet

  692. 				do {

  693. 					i = UEINTX;

  694. 				} while (!(i & ((1<<TXINI)|(1<<RXOUTI))));

  695. 				if (i & (1<<RXOUTI)) return;	// abort

  696. 				// send IN packet

  697. 				n = len < ENDPOINT0_SIZE ? len : ENDPOINT0_SIZE;

  698. 				for (i = n; i; i--) {

  699. 					pgm_read_byte_postinc(UEDATX, list);

  700. 				}

  701. 				len -= n;

  702. 				usb_send_in();

  703. 			} while (len || n == ENDPOINT0_SIZE);

  704. 			return;

  705.                 }

  706. 		if (bRequest == SET_ADDRESS) {

  707. 			usb_send_in();

  708. 			usb_wait_in_ready();

  709. 			UDADDR = wValue | (1<<ADDEN);

  710. 			return;

  711. 		}

  712. 		if (bRequest == SET_CONFIGURATION && bmRequestType == 0) {

  713. 			usb_configuration = wValue;

  714. 			debug_flush_timer = 0;

  715. 			usb_send_in();

  716. 			cfg = endpoint_config_table;

  717. 			for (i=1; i<NUM_ENDPOINTS; i++) {

  718. 				UENUM = i;

  719. 				pgm_read_byte_postinc(en, cfg);

  720. 				UECONX = en;

  721. 				if (en) {

  722. 					pgm_read_byte_postinc(UECFG0X, cfg);

  723. 					pgm_read_byte_postinc(UECFG1X, cfg);

  724. 				}

  725. 			}

  726.         		UERST = 0x1E;

  727.         		UERST = 0;

  728. 			return;

  729. 		}

  730. 		if (bRequest == GET_CONFIGURATION && bmRequestType == 0x80) {

  731. 			usb_wait_in_ready();

  732. 			UEDATX = usb_configuration;

  733. 			usb_send_in();

  734. 			return;

  735. 		}

  736. 		if (bRequest == GET_STATUS) {

  737. 			usb_wait_in_ready();

  738. 			i = 0;

  739. 			if (bmRequestType == 0x82) {

  740. 				UENUM = wIndex;

  741. 				if (UECONX & (1<<STALLRQ)) i = 1;

  742. 				UENUM = 0;

  743. 			}

  744. 			UEDATX = i;

  745. 			UEDATX = 0;

  746. 			usb_send_in();

  747. 			return;

  748. 		}

  749. 		if ((bRequest == CLEAR_FEATURE || bRequest == SET_FEATURE)

  750. 		  && bmRequestType == 0x02 && wValue == 0) {

  751. 			i = wIndex & 0x7F;

  752. 			if (i >= 1 && i <= NUM_ENDPOINTS) {

  753. 				usb_send_in();

  754. 				UENUM = i;

  755. 				if (bRequest == SET_FEATURE) {

  756. 					UECONX = (1<<STALLRQ)|(1<<EPEN);

  757. 				} else {

  758. 					UECONX = (1<<STALLRQC)|(1<<RSTDT)|(1<<EPEN);

  759. 					UERST = (1 << i);

  760. 					UERST = 0;

  761. 				}

  762. 				return;

  763. 			}

  764. 		}

  765.                 if (wIndex == KEYBOARD_INTERFACE) {

  766.                         if (bmRequestType == 0xA1) {

  767.                                 if (bRequest == HID_GET_REPORT) {

  768.                                         usb_wait_in_ready();

  769. 					//len = keyboard_protocol ? sizeof(keyboard_keys) : 8;

  770.                                         for (i=0; i < 8; i++) {

  771.                                                 UEDATX = keyboard_report_data[i];

  772.                                         }

  773.                                         usb_send_in();

  774.                                         return;

  775.                                 }

  776.                                 if (bRequest == HID_GET_IDLE) {

  777.                                         usb_wait_in_ready();

  778.                                         UEDATX = keyboard_idle_config;

  779.                                         usb_send_in();

  780.                                         return;

  781.                                 }

  782.                                 if (bRequest == HID_GET_PROTOCOL) {

  783.                                         usb_wait_in_ready();

  784.                                         UEDATX = keyboard_protocol;

  785.                                         usb_send_in();

  786.                                         return;

  787.                                 }

  788.                         }

  789.                         if (bmRequestType == 0x21) {

  790.                                 if (bRequest == HID_SET_REPORT) {

  791.                                         usb_wait_receive_out();

  792.                                         keyboard_leds = UEDATX;

  793.                                         usb_ack_out();

  794.                                         usb_send_in();

  795.                                         return;

  796.                                 }

  797.                                 if (bRequest == HID_SET_IDLE) {

  798.                                         keyboard_idle_config = (wValue >> 8);

  799.                                         keyboard_idle_count = 0;

  800.                                         //usb_wait_in_ready();

  801.                                         usb_send_in();

  802.                                         return;

  803.                                 }

  804.                                 if (bRequest == HID_SET_PROTOCOL) {

  805.                                         keyboard_protocol = wValue;

  806.                                         //usb_wait_in_ready();

  807.                                         usb_send_in();

  808.                                         return;

  809.                                 }

  810.                         }

  811.                 }

  812.                 if (wIndex == MOUSE_INTERFACE) {

  813.                         if (bmRequestType == 0xA1) {

  814.                                 if (bRequest == HID_GET_REPORT) {

  815.                                         usb_wait_in_ready();

  816.                                         UEDATX = mouse_buttons;

  817.                                         UEDATX = 0;

  818.                                         UEDATX = 0;

  819.                                         UEDATX = 0;

  820.                                         usb_send_in();

  821.                                         return;

  822.                                 }

  823.                                 if (bRequest == HID_GET_PROTOCOL) {

  824.                                         usb_wait_in_ready();

  825.                                         UEDATX = mouse_protocol;

  826.                                         usb_send_in();

  827.                                         return;

  828.                                 }

  829.                         }

  830.                         if (bmRequestType == 0x21) {

  831.                                 if (bRequest == HID_SET_PROTOCOL) {

  832.                                         mouse_protocol = wValue;

  833.                                         usb_send_in();

  834.                                         return;

  835.                                 }

  836.                         }

  837.                 }

  838. #ifdef JOYSTICK_INTERFACE

  839.                 if (wIndex == JOYSTICK_INTERFACE) {

  840.                         if (bmRequestType == 0xA1) {

  841.                                 if (bRequest == HID_GET_REPORT) {

  842.                                         usb_wait_in_ready();

  843. 					for (i=0; i<12; i++) {

  844. 						UEDATX = joystick_report_data[i];

  845. 					}

  846.                                         usb_send_in();

  847.                                         return;

  848. 				}

  849. 			}

  850. 		}

  851. #endif

  852.                 if (wIndex == DEBUG_INTERFACE) {

  853.                         if (bRequest == HID_GET_REPORT && bmRequestType == 0xA1) {

  854.                                 len = wLength;

  855.                                 do {

  856.                                         // wait for host ready for IN packet

  857.                                         do {

  858.                                                 i = UEINTX;

  859.                                         } while (!(i & ((1<<TXINI)|(1<<RXOUTI))));

  860.                                         if (i & (1<<RXOUTI)) return;    // abort

  861.                                         // send IN packet

  862.                                         n = len < ENDPOINT0_SIZE ? len : ENDPOINT0_SIZE;

  863.                                         for (i = n; i; i--) {

  864.                                                 UEDATX = 0;

  865.                                         }

  866.                                         len -= n;

  867.                                         usb_send_in();

  868.                                 } while (len || n == ENDPOINT0_SIZE);

  869.                                 return;

  870.                         }

  871.                         if (bRequest == HID_SET_REPORT && bmRequestType == 0x21) {

  872. 				if (wValue == 0x0300 && wLength == 0x0004) {

  873. 					uint8_t b1, b2, b3, b4;

  874.                                         usb_wait_receive_out();

  875. 					b1 = UEDATX;

  876. 					b2 = UEDATX;

  877. 					b3 = UEDATX;

  878. 					b4 = UEDATX;

  879.                                         usb_ack_out();

  880.                                         usb_send_in();

  881. 					if (b1 == 0xA9 && b2 == 0x45 && b3 == 0xC2 && b4 == 0x6B)

  882. 						_reboot_Teensyduino_();

  883. 					if (b1 == 0x8B && b2 == 0xC5 && b3 == 0x1D && b4 == 0x70)

  884. 						_restart_Teensyduino_();

  885. 				}

  886. 			}

  887.                 }

  888. 		if (bRequest == 0xC9 && bmRequestType == 0x40) {

  889. 			usb_send_in();

  890. 			usb_wait_in_ready();

  891. 			_restart_Teensyduino_();

  892. 		}

  893.         }

  894. 	UECONX = (1<<STALLRQ) | (1<<EPEN);	// stall

  895. }

  896.