visus
/
teensy-core-4.1
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Teensy 4.1 core updated for C++20
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
608 Commits
2 Branches
Tree: 5c064702ba
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '5c064702ba'
${ noResults }
teensy-core-4.1/usb_serial_hid/usb.c

925 lines
36KB
Raw Blame History 

  1. /* USB Serial for Teensy USB Development Board

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

  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.  *  Endpoint Buffer Configuration

  32.  *

  33.  **************************************************************************/

  34. 

  35. 

  36. static const uint8_t PROGMEM endpoint_config_table[] = {

  37. 	EP_TYPE_INTERRUPT_IN,  EP_SIZE(KEYBOARD_SIZE) | KEYBOARD_BUFFER,

  38. 	EP_TYPE_INTERRUPT_IN,  EP_SIZE(CDC_ACM_SIZE) | CDC_ACM_BUFFER,

  39. 	EP_TYPE_BULK_OUT,      EP_SIZE(CDC_RX_SIZE) | CDC_RX_BUFFER,

  40. 	EP_TYPE_BULK_IN,       EP_SIZE(CDC_TX_SIZE) | CDC_TX_BUFFER,

  41. 	EP_TYPE_INTERRUPT_IN,  EP_SIZE(MOUSE_SIZE) | MOUSE_BUFFER,

  42. 	EP_TYPE_INTERRUPT_IN,  EP_SIZE(JOYSTICK_SIZE) | JOYSTICK_BUFFER,

  43. };

  44. 

  45. 

  46. /**************************************************************************

  47.  *

  48.  *  Descriptor Data

  49.  *

  50.  **************************************************************************/

  51. 

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

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

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

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

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

  57. 

  58. static const uint8_t PROGMEM device_descriptor[] = {

  59. 	18,					// bLength

  60. 	1,					// bDescriptorType

  61. 	0x00, 0x02,				// bcdUSB

  62. 	0xEF,					// bDeviceClass

  63. 	0x02,					// bDeviceSubClass

  64. 	0x01,					// bDeviceProtocol

  65. 	ENDPOINT0_SIZE,				// bMaxPacketSize0

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

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

  68. 	0x02, 0x01,				// bcdDevice

  69. 	1,					// iManufacturer

  70. 	2,					// iProduct

  71. 	3,					// iSerialNumber

  72. 	1					// bNumConfigurations

  73. };

  74. 

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

  76. static const uint8_t PROGMEM keyboard_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  119.         0xc0                    // End Collection

  120. };

  121. 

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

  123. static const uint8_t PROGMEM mouse_hid_report_desc[] = {

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

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

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

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

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

  129.         0x29, 0x08,                     //   Usage Maximum (Button #8)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  145.         0x0A, 0x38, 0x02,               //   Usage (AC Pan)

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

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

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

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

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

  151.         0xC0                            // End Collection

  152. };

  153. 

  154. static const uint8_t PROGMEM joystick_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  188.         0xC0,                           // End Collection

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

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

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

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

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

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

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

  196.         0xC0                            // End Collection

  197. };

  198. 

  199. #define KEYBOARD_HID_DESC_OFFSET        ( 9+8 + 9+5+5+4+5+7+9+7+7 + 9 )

  200. #define MOUSE_HID_DESC_OFFSET           ( 9+8 + 9+5+5+4+5+7+9+7+7 + 9+9+7 + 9 )

  201. #define JOYSTICK_HID_DESC_OFFSET	( 9+8 + 9+5+5+4+5+7+9+7+7 + 9+9+7 + 9+9+7 + 9 )

  202. #define CONFIG1_DESC_SIZE		( 9+8 + 9+5+5+4+5+7+9+7+7 + 9+9+7 + 9+9+7 + 9+9+7 )

  203. 

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

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

  206. 	9, 					// bLength;

  207. 	2,					// bDescriptorType;

  208. 	LSB(CONFIG1_DESC_SIZE),			// wTotalLength

  209. 	MSB(CONFIG1_DESC_SIZE),

  210. 	5,					// bNumInterfaces

  211. 	1,					// bConfigurationValue

  212. 	0,					// iConfiguration

  213. 	0xC0,					// bmAttributes

  214. 	50,					// bMaxPower

  215.         // interface association descriptor, USB ECN, Table 9-Z

  216.         8,                                      // bLength

  217.         11,                                     // bDescriptorType

  218.         0,                                      // bFirstInterface

  219.         2,                                      // bInterfaceCount

  220.         0x02,                                   // bFunctionClass

  221.         0x02,                                   // bFunctionSubClass

  222.         0x01,                                   // bFunctionProtocol

  223.         4,                                      // iFunction

  224. 

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

  226. 	9,					// bLength

  227. 	4,					// bDescriptorType

  228. 	0,					// bInterfaceNumber

  229. 	0,					// bAlternateSetting

  230. 	1,					// bNumEndpoints

  231. 	0x02,					// bInterfaceClass

  232. 	0x02,					// bInterfaceSubClass

  233. 	0x01,					// bInterfaceProtocol

  234. 	0,					// iInterface

  235. 	// CDC Header Functional Descriptor, CDC Spec 5.2.3.1, Table 26

  236. 	5,					// bFunctionLength

  237. 	0x24,					// bDescriptorType

  238. 	0x00,					// bDescriptorSubtype

  239. 	0x10, 0x01,				// bcdCDC

  240. 	// Call Management Functional Descriptor, CDC Spec 5.2.3.2, Table 27

  241. 	5,					// bFunctionLength

  242. 	0x24,					// bDescriptorType

  243. 	0x01,					// bDescriptorSubtype

  244. 	0x00,					// bmCapabilities

  245. 	1,					// bDataInterface

  246. 	// Abstract Control Management Functional Descriptor, CDC Spec 5.2.3.3, Table 28

  247. 	4,					// bFunctionLength

  248. 	0x24,					// bDescriptorType

  249. 	0x02,					// bDescriptorSubtype

  250. 	0x06,					// bmCapabilities

  251. 	// Union Functional Descriptor, CDC Spec 5.2.3.8, Table 33

  252. 	5,					// bFunctionLength

  253. 	0x24,					// bDescriptorType

  254. 	0x06,					// bDescriptorSubtype

  255. 	0,					// bMasterInterface

  256. 	1,					// bSlaveInterface0

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

  258. 	7,					// bLength

  259. 	5,					// bDescriptorType

  260. 	CDC_ACM_ENDPOINT | 0x80,		// bEndpointAddress

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

  262. 	CDC_ACM_SIZE, 0,			// wMaxPacketSize

  263. 	64,					// bInterval

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

  265. 	9,					// bLength

  266. 	4,					// bDescriptorType

  267. 	1,					// bInterfaceNumber

  268. 	0,					// bAlternateSetting

  269. 	2,					// bNumEndpoints

  270. 	0x0A,					// bInterfaceClass

  271. 	0x00,					// bInterfaceSubClass

  272. 	0x00,					// bInterfaceProtocol

  273. 	0,					// iInterface

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

  275. 	7,					// bLength

  276. 	5,					// bDescriptorType

  277. 	CDC_RX_ENDPOINT,			// bEndpointAddress

  278. 	0x02,					// bmAttributes (0x02=bulk)

  279. 	CDC_RX_SIZE, 0,				// wMaxPacketSize

  280. 	0,					// bInterval

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

  282. 	7,					// bLength

  283. 	5,					// bDescriptorType

  284. 	CDC_TX_ENDPOINT | 0x80,			// bEndpointAddress

  285. 	0x02,					// bmAttributes (0x02=bulk)

  286. 	CDC_TX_SIZE, 0,				// wMaxPacketSize

  287. 	0,					// bInterval

  288. 

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

  290.         9,                                      // bLength

  291.         4,                                      // bDescriptorType

  292.         KEYBOARD_INTERFACE,                     // bInterfaceNumber

  293.         0,                                      // bAlternateSetting

  294.         1,                                      // bNumEndpoints

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

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

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

  298.         0,                                      // iInterface

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

  300.         9,                                      // bLength

  301.         0x21,                                   // bDescriptorType

  302.         0x11, 0x01,                             // bcdHID

  303.         0,                                      // bCountryCode

  304.         1,                                      // bNumDescriptors

  305.         0x22,                                   // bDescriptorType

  306.         sizeof(keyboard_hid_report_desc),       // wDescriptorLength

  307.         0,

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

  309.         7,                                      // bLength

  310.         5,                                      // bDescriptorType

  311.         KEYBOARD_ENDPOINT | 0x80,               // bEndpointAddress

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

  313.         KEYBOARD_SIZE, 0,                       // wMaxPacketSize

  314.         KEYBOARD_INTERVAL,                      // bInterval

  315. 

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

  317.         9,                                      // bLength

  318.         4,                                      // bDescriptorType

  319.         MOUSE_INTERFACE,                        // bInterfaceNumber

  320.         0,                                      // bAlternateSetting

  321.         1,                                      // bNumEndpoints

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

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

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

  325.         0,                                      // iInterface

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

  327.         9,                                      // bLength

  328.         0x21,                                   // bDescriptorType

  329.         0x11, 0x01,                             // bcdHID

  330.         0,                                      // bCountryCode

  331.         1,                                      // bNumDescriptors

  332.         0x22,                                   // bDescriptorType

  333.         sizeof(mouse_hid_report_desc),          // wDescriptorLength

  334.         0,

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

  336.         7,                                      // bLength

  337.         5,                                      // bDescriptorType

  338.         MOUSE_ENDPOINT | 0x80,                  // bEndpointAddress

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

  340.         MOUSE_SIZE, 0,                          // wMaxPacketSize

  341.         MOUSE_INTERVAL,                         // bInterval

  342. 

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

  344.         9,                                      // bLength

  345.         4,                                      // bDescriptorType

  346.         JOYSTICK_INTERFACE,                     // bInterfaceNumber

  347.         0,                                      // bAlternateSetting

  348.         1,                                      // bNumEndpoints

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

  350.         0x00,                                   // bInterfaceSubClass

  351.         0x00,                                   // bInterfaceProtocol

  352.         0,                                      // iInterface

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

  354.         9,                                      // bLength

  355.         0x21,                                   // bDescriptorType

  356.         0x11, 0x01,                             // bcdHID

  357.         0,                                      // bCountryCode

  358.         1,                                      // bNumDescriptors

  359.         0x22,                                   // bDescriptorType

  360.         sizeof(joystick_hid_report_desc),       // wDescriptorLength

  361.         0,

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

  363.         7,                                      // bLength

  364.         5,                                      // bDescriptorType

  365.         JOYSTICK_ENDPOINT | 0x80,               // bEndpointAddress

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

  367.         12, 0,                                  // wMaxPacketSize

  368.         JOYSTICK_INTERVAL                       // bInterval

  369. };

  370. 

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

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

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

  374. struct usb_string_descriptor_struct {

  375. 	uint8_t bLength;

  376. 	uint8_t bDescriptorType;

  377. 	int16_t wString[];

  378. };

  379. static const struct usb_string_descriptor_struct PROGMEM string0 = {

  380. 	4,

  381. 	3,

  382. 	{0x0409}

  383. };

  384. static const struct usb_string_descriptor_struct PROGMEM string1 = {

  385. 	sizeof(STR_MANUFACTURER),

  386. 	3,

  387. 	STR_MANUFACTURER

  388. };

  389. static const struct usb_string_descriptor_struct PROGMEM string2 = {

  390. 	sizeof(STR_PRODUCT),

  391. 	3,

  392. 	STR_PRODUCT

  393. };

  394. static const struct usb_string_descriptor_struct PROGMEM string3 = {

  395. 	sizeof(STR_SERIAL_NUMBER),

  396. 	3,

  397. 	STR_SERIAL_NUMBER

  398. };

  399. static const struct usb_string_descriptor_struct PROGMEM string4 = {

  400. 	sizeof(STR_SERIAL),

  401. 	3,

  402. 	STR_SERIAL

  403. };

  404. 

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

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

  407. static const struct descriptor_list_struct {

  408. 	uint16_t	wValue;

  409. 	uint16_t	wIndex;

  410. 	const uint8_t	*addr;

  411. 	uint8_t		length;

  412. } PROGMEM descriptor_list[] = {

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

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

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

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

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

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

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

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

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

  422. 	{0x0301, 0x0409, (const uint8_t *)&string1, sizeof(STR_MANUFACTURER)},

  423. 	{0x0302, 0x0409, (const uint8_t *)&string2, sizeof(STR_PRODUCT)},

  424. 	{0x0303, 0x0409, (const uint8_t *)&string3, sizeof(STR_SERIAL_NUMBER)},

  425. 	{0x0304, 0x0409, (const uint8_t *)&string4, sizeof(STR_SERIAL)},

  426. };

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

  428. 

  429. 

  430. /**************************************************************************

  431.  *

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

  433.  *

  434.  **************************************************************************/

  435. 

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

  437. volatile uint8_t usb_configuration USBSTATE;

  438. volatile uint8_t usb_suspended USBSTATE;

  439. 

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

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

  442. volatile uint8_t transmit_flush_timer=0;

  443. volatile uint8_t reboot_timer=0;

  444. uint8_t transmit_previous_timeout=0;

  445. 

  446. // serial port settings (baud rate, control signals, etc) set

  447. // by the PC.  These are ignored, but kept in RAM because the

  448. // CDC spec requires a read that returns the current settings.

  449. volatile uint8_t cdc_line_coding[7]={0x00, 0xE1, 0x00, 0x00, 0x00, 0x00, 0x08};

  450. volatile uint8_t cdc_line_rtsdtr USBSTATE;

  451. 

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

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

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

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

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

  457. uint8_t keyboard_report_data[8] USBSTATE;

  458. 

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

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

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

  462. static uint8_t keyboard_protocol USBSTATE;

  463. 

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

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

  466. static uint8_t keyboard_idle_config USBSTATE;

  467. 

  468. // count until idle timeout

  469. uint8_t keyboard_idle_count USBSTATE;

  470. 

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

  472. volatile uint8_t keyboard_leds USBSTATE;

  473. 

  474. // which buttons are currently pressed

  475. uint8_t mouse_buttons USBSTATE;

  476. 

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

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

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

  480. static uint8_t mouse_protocol USBSTATE;

  481. 

  482. // joystick data

  483. uint8_t joystick_report_data[12] USBSTATE;

  484. 

  485. 

  486. 

  487. /**************************************************************************

  488.  *

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

  490.  *

  491.  **************************************************************************/

  492. 

  493. 

  494. // initialize USB serial

  495. void usb_init(void)

  496. {

  497. 	uint8_t u;

  498. 

  499. 	u = USBCON;

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

  501. 	HW_CONFIG();

  502.         USB_FREEZE();				// enable USB

  503.         PLL_CONFIG();				// config PLL

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

  505.         USB_CONFIG();				// start USB clock

  506.         UDCON = 0;				// enable attach resistor

  507. 	usb_configuration = 0;

  508. 	usb_suspended = 0;

  509. 	cdc_line_rtsdtr = 0;

  510.         keyboard_report_data[0] = 0;

  511.         keyboard_report_data[1] = 0;

  512.         keyboard_report_data[2] = 0;

  513.         keyboard_report_data[3] = 0;

  514.         keyboard_report_data[4] = 0;

  515.         keyboard_report_data[5] = 0;

  516.         keyboard_report_data[6] = 0;

  517.         keyboard_report_data[7] = 0;

  518.         keyboard_protocol = 1;

  519.         keyboard_idle_config = 125;

  520.         keyboard_idle_count = 0;

  521.         keyboard_leds = 0;

  522.         mouse_buttons = 0;

  523.         mouse_protocol = 1;

  524.         joystick_report_data[0] = 0;

  525.         joystick_report_data[1] = 0;

  526.         joystick_report_data[2] = 0;

  527.         joystick_report_data[3] = 0;

  528.         joystick_report_data[4] =  0x0F;

  529.         joystick_report_data[5] =  0x20;

  530.         joystick_report_data[6] =  0x80;

  531.         joystick_report_data[7] =  0x00;

  532.         joystick_report_data[8] =  0x02;

  533.         joystick_report_data[9] =  0x08;

  534.         joystick_report_data[10] = 0x20;

  535.         joystick_report_data[11] = 0x80;

  536. 	UDINT = 0;

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

  538. }

  539. 

  540. 

  541. void usb_shutdown(void)

  542. {

  543. 	UDIEN = 0;	// disable interrupts

  544. 	UDCON = 1;	// disconnect attach resistor

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

  546. 	PLLCSR = 0;	// shut off PLL

  547. 	usb_configuration = 0;

  548. 	usb_suspended = 1;

  549. }

  550. 

  551. 

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

  553. 

  554. /**************************************************************************

  555.  *

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

  557.  *

  558.  **************************************************************************/

  559. 

  560. 

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

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

  563. //

  564. ISR(USB_GEN_vect)

  565. {

  566. 	uint8_t intbits, t, i;

  567. 	static uint8_t div4=0;

  568. 

  569.         intbits = UDINT;

  570.         UDINT = 0;

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

  572. 		// USB Reset

  573. 		UENUM = 0;

  574. 		UECONX = 1;

  575. 		UECFG0X = EP_TYPE_CONTROL;

  576. 		UECFG1X = EP_SIZE(ENDPOINT0_SIZE) | EP_SINGLE_BUFFER;

  577. 		UEIENX = (1<<RXSTPE);

  578. 		usb_configuration = 0;

  579. 		cdc_line_rtsdtr = 0;

  580. 	}

  581. 	if (intbits & (1<<SOFI)) {

  582. 		// Start Of Frame

  583. 		if (usb_configuration) {

  584. 			t = transmit_flush_timer;

  585. 			if (t) {

  586. 				transmit_flush_timer = --t;

  587. 				if (!t) {

  588. 					UENUM = CDC_TX_ENDPOINT;

  589. 					UEINTX = 0x3A;

  590. 				}

  591. 			}

  592. 			t = reboot_timer;

  593. 			if (t) {

  594. 				reboot_timer = --t;

  595. 				if (!t) _reboot_Teensyduino_();

  596. 			}

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

  598.                         	UENUM = KEYBOARD_ENDPOINT;

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

  600.                                 	keyboard_idle_count++;

  601.                                 	if (keyboard_idle_count == keyboard_idle_config) {

  602.                                         	keyboard_idle_count = 0;

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

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

  605.                                                 	UEDATX = keyboard_report_data[i];

  606.                                         	}

  607.                                         	UEINTX = 0x3A;

  608.                                 	}

  609.                         	}

  610.                 	}

  611. 		}

  612. 	}

  613. 	// in active state

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

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

  616. 		UDIEN = (1<<WAKEUPE);

  617. 		usb_configuration = 0;

  618. 		usb_suspended = 1;

  619. 		#if (F_CPU >= 8000000L)

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

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

  622. 		// Is this a hardware bug?

  623. 		USB_FREEZE();			// shut off USB

  624. 		PLLCSR = 0;			// shut off PLL

  625. 		#endif

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

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

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

  629. 		// user's paradigm....

  630. 	}

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

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

  633. 		#if (F_CPU >= 8000000L)

  634. 		PLL_CONFIG();

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

  636. 		USB_CONFIG();

  637. 		#endif

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

  639. 		usb_suspended = 0;

  640. 		return;

  641. 	}

  642. }

  643. 

  644. 

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

  646. static inline void usb_wait_in_ready(void)

  647. {

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

  649. }

  650. static inline void usb_send_in(void)

  651. {

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

  653. }

  654. static inline void usb_wait_receive_out(void)

  655. {

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

  657. }

  658. static inline void usb_ack_out(void)

  659. {

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

  661. }

  662. 

  663. 

  664. 

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

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

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

  668. //

  669. ISR(USB_COM_vect)

  670. {

  671.         uint8_t intbits;

  672. 	const uint8_t *list;

  673.         const uint8_t *cfg;

  674. 	uint8_t i, n, len, en;

  675. 	volatile uint8_t *p;

  676. 	uint8_t bmRequestType;

  677. 	uint8_t bRequest;

  678. 	uint16_t wValue;

  679. 	uint16_t wIndex;

  680. 	uint16_t wLength;

  681. 	uint16_t desc_val;

  682. 	const uint8_t *desc_addr;

  683. 	uint8_t	desc_length;

  684. 

  685. 	UENUM = 0;

  686. 	intbits = UEINTX;

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

  688. 		bmRequestType = UEDATX;

  689. 		bRequest = UEDATX;

  690. 		read_word_lsbfirst(wValue, UEDATX);

  691. 		read_word_lsbfirst(wIndex, UEDATX);

  692. 		read_word_lsbfirst(wLength, UEDATX);

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

  694.                 if (bRequest == GET_DESCRIPTOR) {

  695. 			list = (const uint8_t *)descriptor_list;

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

  697. 				if (i >= NUM_DESC_LIST) {

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

  699. 					return;

  700. 				}

  701. 				pgm_read_word_postinc(desc_val, list);

  702. 				if (desc_val != wValue) {

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

  704. 					continue;

  705. 				}

  706. 				pgm_read_word_postinc(desc_val, list);

  707. 				if (desc_val != wIndex) {

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

  709. 					continue;

  710. 				}

  711. 				pgm_read_word_postinc(desc_addr, list);

  712. 				desc_length = pgm_read_byte(list);

  713. 				break;

  714. 			}

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

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

  717. 			list = desc_addr;

  718. 			do {

  719. 				// wait for host ready for IN packet

  720. 				do {

  721. 					i = UEINTX;

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

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

  724. 				// send IN packet

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

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

  727. 					pgm_read_byte_postinc(UEDATX, list);

  728. 				}

  729. 				len -= n;

  730. 				usb_send_in();

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

  732. 			return;

  733.                 }

  734. 		if (bRequest == SET_ADDRESS) {

  735. 			usb_send_in();

  736. 			usb_wait_in_ready();

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

  738. 			return;

  739. 		}

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

  741. 			usb_configuration = wValue;

  742. 			cdc_line_rtsdtr = 0;

  743. 			transmit_flush_timer = 0;

  744. 			usb_send_in();

  745. 			cfg = endpoint_config_table;

  746. 			for (i=1; i<7; i++) {

  747. 				UENUM = i;

  748. 				//pgm_read_byte_postinc(en, cfg);

  749. 				//UECONX = en;

  750. 				UECONX = 1;

  751. 				//if (en) {

  752. 				pgm_read_byte_postinc(UECFG0X, cfg);

  753. 				pgm_read_byte_postinc(UECFG1X, cfg);

  754. 				//}

  755. 			}

  756.         		UERST = 0x1E;

  757.         		UERST = 0;

  758. 			return;

  759. 		}

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

  761. 			usb_wait_in_ready();

  762. 			UEDATX = usb_configuration;

  763. 			usb_send_in();

  764. 			return;

  765. 		}

  766. 		if (bRequest == CDC_GET_LINE_CODING /* 0x21 */ && bmRequestType == 0xA1) {

  767. 			usb_wait_in_ready();

  768. 			p = cdc_line_coding;

  769. 			for (i=0; i<7; i++) {

  770. 				UEDATX = *p++;

  771. 			}

  772. 			usb_send_in();

  773. 			return;

  774. 		}

  775. 		if (bRequest == CDC_SET_LINE_CODING /* 0x20 */ && bmRequestType == 0x21) {

  776. 			usb_wait_receive_out();

  777. 			p = cdc_line_coding;

  778. 			for (i=0; i<7; i++) {

  779. 				*p++ = UEDATX;

  780. 			}

  781. 			usb_ack_out();

  782. 			usb_send_in();

  783. 			if (*(long *)cdc_line_coding == 134L) reboot_timer = 15;

  784. 			if (*(long *)cdc_line_coding == 150L) {

  785. 				UENUM = CDC_TX_ENDPOINT;

  786. 				while (UESTA0X & 0x03) {

  787. 					UEINTX = 0xFF;

  788. 					while (UEINTX & 0x04) /* TODO: timeout? */ ;

  789. 				}

  790. 				_restart_Teensyduino_();

  791. 			}

  792. 			return;

  793. 		}

  794. 		if (bRequest == CDC_SET_CONTROL_LINE_STATE /* 0x22 */ && bmRequestType == 0x21) {

  795. 			cdc_line_rtsdtr = wValue;

  796. 			usb_wait_in_ready();

  797. 			usb_send_in();

  798. 			return;

  799. 		}

  800. 		if (bRequest == CDC_SEND_BREAK /* 0x23 */ && bmRequestType == 0x21) {

  801. 			usb_wait_in_ready();

  802. 			usb_send_in();

  803. 			return;

  804. 		}

  805. 		if (bRequest == GET_STATUS) {

  806. 			usb_wait_in_ready();

  807. 			i = 0;

  808. 			if (bmRequestType == 0x82) {

  809. 				UENUM = wIndex;

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

  811. 				UENUM = 0;

  812. 			}

  813. 			UEDATX = i;

  814. 			UEDATX = 0;

  815. 			usb_send_in();

  816. 			return;

  817. 		}

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

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

  820. 			i = wIndex & 0x7F;

  821. 			if (i >= 1 && i <= MAX_ENDPOINT) {

  822. 				usb_send_in();

  823. 				UENUM = i;

  824. 				if (bRequest == SET_FEATURE) {

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

  826. 				} else {

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

  828. 					UERST = (1 << i);

  829. 					UERST = 0;

  830. 				}

  831. 				return;

  832. 			}

  833. 		}

  834.                 if (wIndex == KEYBOARD_INTERFACE) {

  835.                         if (bmRequestType == 0xA1) {

  836.                                 if (bRequest == HID_GET_REPORT) {

  837.                                         usb_wait_in_ready();

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

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

  840.                                                 UEDATX = keyboard_report_data[i];

  841.                                         }

  842.                                         usb_send_in();

  843.                                         return;

  844.                                 }

  845.                                 if (bRequest == HID_GET_IDLE) {

  846.                                         usb_wait_in_ready();

  847.                                         UEDATX = keyboard_idle_config;

  848.                                         usb_send_in();

  849.                                         return;

  850.                                 }

  851.                                 if (bRequest == HID_GET_PROTOCOL) {

  852.                                         usb_wait_in_ready();

  853.                                         UEDATX = keyboard_protocol;

  854.                                         usb_send_in();

  855.                                         return;

  856.                                 }

  857.                         }

  858.                         if (bmRequestType == 0x21) {

  859.                                 if (bRequest == HID_SET_REPORT) {

  860.                                         usb_wait_receive_out();

  861.                                         keyboard_leds = UEDATX;

  862.                                         usb_ack_out();

  863.                                         usb_send_in();

  864.                                         return;

  865.                                 }

  866.                                 if (bRequest == HID_SET_IDLE) {

  867.                                         keyboard_idle_config = (wValue >> 8);

  868.                                         keyboard_idle_count = 0;

  869.                                         //usb_wait_in_ready();

  870.                                         usb_send_in();

  871.                                         return;

  872.                                 }

  873.                                 if (bRequest == HID_SET_PROTOCOL) {

  874.                                         keyboard_protocol = wValue;

  875.                                         //usb_wait_in_ready();

  876.                                         usb_send_in();

  877.                                         return;

  878.                                 }

  879.                         }

  880.                 }

  881.                 if (wIndex == MOUSE_INTERFACE) {

  882.                         if (bmRequestType == 0xA1) {

  883.                                 if (bRequest == HID_GET_REPORT) {

  884.                                         usb_wait_in_ready();

  885.                                         UEDATX = mouse_buttons;

  886.                                         UEDATX = 0;

  887.                                         UEDATX = 0;

  888.                                         UEDATX = 0;

  889.                                         UEDATX = 0;

  890.                                         usb_send_in();

  891.                                         return;

  892.                                 }

  893.                                 if (bRequest == HID_GET_PROTOCOL) {

  894.                                         usb_wait_in_ready();

  895.                                         UEDATX = mouse_protocol;

  896.                                         usb_send_in();

  897.                                         return;

  898.                                 }

  899.                         }

  900.                         if (bmRequestType == 0x21) {

  901.                                 if (bRequest == HID_SET_PROTOCOL) {

  902.                                         mouse_protocol = wValue;

  903.                                         usb_send_in();

  904.                                         return;

  905.                                 }

  906.                         }

  907.                 }

  908.                 if (wIndex == JOYSTICK_INTERFACE) {

  909.                         if (bmRequestType == 0xA1) {

  910.                                 if (bRequest == HID_GET_REPORT) {

  911.                                         usb_wait_in_ready();

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

  913.                                                 UEDATX = joystick_report_data[i];

  914.                                         }

  915.                                         usb_send_in();

  916.                                         return;

  917.                                 }

  918.                         }

  919.                 }

  920.         }

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

  922. }

  923.