visus
/
teensy-cores
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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.
231 Commits
1 Branch
Tree: 9fbebb5145
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '9fbebb5145'
${ noResults }
teensy-cores/usb_serial_hid/usb.c

922 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, 0x03,                     //   Usage Maximum (Button #3)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  149.         0xC0                            // End Collection

  150. };

  151. 

  152. static const uint8_t PROGMEM joystick_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  186.         0xC0,                           // End Collection

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

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

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

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

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

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

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

  194.         0xC0                            // End Collection

  195. };

  196. 

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

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

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

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

  201. 

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

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

  204. 	9, 					// bLength;

  205. 	2,					// bDescriptorType;

  206. 	LSB(CONFIG1_DESC_SIZE),			// wTotalLength

  207. 	MSB(CONFIG1_DESC_SIZE),

  208. 	5,					// bNumInterfaces

  209. 	1,					// bConfigurationValue

  210. 	0,					// iConfiguration

  211. 	0xC0,					// bmAttributes

  212. 	50,					// bMaxPower

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

  214.         8,                                      // bLength

  215.         11,                                     // bDescriptorType

  216.         0,                                      // bFirstInterface

  217.         2,                                      // bInterfaceCount

  218.         0x02,                                   // bFunctionClass

  219.         0x02,                                   // bFunctionSubClass

  220.         0x01,                                   // bFunctionProtocol

  221.         4,                                      // iFunction

  222. 

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

  224. 	9,					// bLength

  225. 	4,					// bDescriptorType

  226. 	0,					// bInterfaceNumber

  227. 	0,					// bAlternateSetting

  228. 	1,					// bNumEndpoints

  229. 	0x02,					// bInterfaceClass

  230. 	0x02,					// bInterfaceSubClass

  231. 	0x01,					// bInterfaceProtocol

  232. 	0,					// iInterface

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

  234. 	5,					// bFunctionLength

  235. 	0x24,					// bDescriptorType

  236. 	0x00,					// bDescriptorSubtype

  237. 	0x10, 0x01,				// bcdCDC

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

  239. 	5,					// bFunctionLength

  240. 	0x24,					// bDescriptorType

  241. 	0x01,					// bDescriptorSubtype

  242. 	0x00,					// bmCapabilities

  243. 	1,					// bDataInterface

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

  245. 	4,					// bFunctionLength

  246. 	0x24,					// bDescriptorType

  247. 	0x02,					// bDescriptorSubtype

  248. 	0x06,					// bmCapabilities

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

  250. 	5,					// bFunctionLength

  251. 	0x24,					// bDescriptorType

  252. 	0x06,					// bDescriptorSubtype

  253. 	0,					// bMasterInterface

  254. 	1,					// bSlaveInterface0

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

  256. 	7,					// bLength

  257. 	5,					// bDescriptorType

  258. 	CDC_ACM_ENDPOINT | 0x80,		// bEndpointAddress

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

  260. 	CDC_ACM_SIZE, 0,			// wMaxPacketSize

  261. 	64,					// bInterval

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

  263. 	9,					// bLength

  264. 	4,					// bDescriptorType

  265. 	1,					// bInterfaceNumber

  266. 	0,					// bAlternateSetting

  267. 	2,					// bNumEndpoints

  268. 	0x0A,					// bInterfaceClass

  269. 	0x00,					// bInterfaceSubClass

  270. 	0x00,					// bInterfaceProtocol

  271. 	0,					// iInterface

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

  273. 	7,					// bLength

  274. 	5,					// bDescriptorType

  275. 	CDC_RX_ENDPOINT,			// bEndpointAddress

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

  277. 	CDC_RX_SIZE, 0,				// wMaxPacketSize

  278. 	0,					// bInterval

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

  280. 	7,					// bLength

  281. 	5,					// bDescriptorType

  282. 	CDC_TX_ENDPOINT | 0x80,			// bEndpointAddress

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

  284. 	CDC_TX_SIZE, 0,				// wMaxPacketSize

  285. 	0,					// bInterval

  286. 

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

  288.         9,                                      // bLength

  289.         4,                                      // bDescriptorType

  290.         KEYBOARD_INTERFACE,                     // bInterfaceNumber

  291.         0,                                      // bAlternateSetting

  292.         1,                                      // bNumEndpoints

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

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

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

  296.         0,                                      // iInterface

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

  298.         9,                                      // bLength

  299.         0x21,                                   // bDescriptorType

  300.         0x11, 0x01,                             // bcdHID

  301.         0,                                      // bCountryCode

  302.         1,                                      // bNumDescriptors

  303.         0x22,                                   // bDescriptorType

  304.         sizeof(keyboard_hid_report_desc),       // wDescriptorLength

  305.         0,

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

  307.         7,                                      // bLength

  308.         5,                                      // bDescriptorType

  309.         KEYBOARD_ENDPOINT | 0x80,               // bEndpointAddress

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

  311.         KEYBOARD_SIZE, 0,                       // wMaxPacketSize

  312.         KEYBOARD_INTERVAL,                      // bInterval

  313. 

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

  315.         9,                                      // bLength

  316.         4,                                      // bDescriptorType

  317.         MOUSE_INTERFACE,                        // bInterfaceNumber

  318.         0,                                      // bAlternateSetting

  319.         1,                                      // bNumEndpoints

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

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

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

  323.         0,                                      // iInterface

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

  325.         9,                                      // bLength

  326.         0x21,                                   // bDescriptorType

  327.         0x11, 0x01,                             // bcdHID

  328.         0,                                      // bCountryCode

  329.         1,                                      // bNumDescriptors

  330.         0x22,                                   // bDescriptorType

  331.         sizeof(mouse_hid_report_desc),          // wDescriptorLength

  332.         0,

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

  334.         7,                                      // bLength

  335.         5,                                      // bDescriptorType

  336.         MOUSE_ENDPOINT | 0x80,                  // bEndpointAddress

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

  338.         MOUSE_SIZE, 0,                          // wMaxPacketSize

  339.         MOUSE_INTERVAL,                         // bInterval

  340. 

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

  342.         9,                                      // bLength

  343.         4,                                      // bDescriptorType

  344.         JOYSTICK_INTERFACE,                     // bInterfaceNumber

  345.         0,                                      // bAlternateSetting

  346.         1,                                      // bNumEndpoints

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

  348.         0x00,                                   // bInterfaceSubClass

  349.         0x00,                                   // bInterfaceProtocol

  350.         0,                                      // iInterface

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

  352.         9,                                      // bLength

  353.         0x21,                                   // bDescriptorType

  354.         0x11, 0x01,                             // bcdHID

  355.         0,                                      // bCountryCode

  356.         1,                                      // bNumDescriptors

  357.         0x22,                                   // bDescriptorType

  358.         sizeof(joystick_hid_report_desc),       // wDescriptorLength

  359.         0,

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

  361.         7,                                      // bLength

  362.         5,                                      // bDescriptorType

  363.         JOYSTICK_ENDPOINT | 0x80,               // bEndpointAddress

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

  365.         12, 0,                                  // wMaxPacketSize

  366.         JOYSTICK_INTERVAL                       // bInterval

  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_MANUFACTURER),

  384. 	3,

  385. 	STR_MANUFACTURER

  386. };

  387. static const struct usb_string_descriptor_struct PROGMEM string2 = {

  388. 	sizeof(STR_PRODUCT),

  389. 	3,

  390. 	STR_PRODUCT

  391. };

  392. static const struct usb_string_descriptor_struct PROGMEM string3 = {

  393. 	sizeof(STR_SERIAL_NUMBER),

  394. 	3,

  395. 	STR_SERIAL_NUMBER

  396. };

  397. static const struct usb_string_descriptor_struct PROGMEM string4 = {

  398. 	sizeof(STR_SERIAL),

  399. 	3,

  400. 	STR_SERIAL

  401. };

  402. 

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

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

  405. static const struct descriptor_list_struct {

  406. 	uint16_t	wValue;

  407. 	uint16_t	wIndex;

  408. 	const uint8_t	*addr;

  409. 	uint8_t		length;

  410. } PROGMEM descriptor_list[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

  424. };

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

  426. 

  427. 

  428. /**************************************************************************

  429.  *

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

  431.  *

  432.  **************************************************************************/

  433. 

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

  435. volatile uint8_t usb_configuration USBSTATE;

  436. volatile uint8_t usb_suspended USBSTATE;

  437. 

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

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

  440. volatile uint8_t transmit_flush_timer=0;

  441. volatile uint8_t reboot_timer=0;

  442. uint8_t transmit_previous_timeout=0;

  443. 

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

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

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

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

  448. volatile uint8_t cdc_line_rtsdtr USBSTATE;

  449. 

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

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

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

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

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

  455. uint8_t keyboard_report_data[8] USBSTATE;

  456. 

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

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

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

  460. static uint8_t keyboard_protocol USBSTATE;

  461. 

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

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

  464. static uint8_t keyboard_idle_config USBSTATE;

  465. 

  466. // count until idle timeout

  467. uint8_t keyboard_idle_count USBSTATE;

  468. 

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

  470. volatile uint8_t keyboard_leds USBSTATE;

  471. 

  472. // which buttons are currently pressed

  473. uint8_t mouse_buttons USBSTATE;

  474. 

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

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

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

  478. static uint8_t mouse_protocol USBSTATE;

  479. 

  480. // joystick data

  481. uint8_t joystick_report_data[12] USBSTATE;

  482. 

  483. 

  484. 

  485. /**************************************************************************

  486.  *

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

  488.  *

  489.  **************************************************************************/

  490. 

  491. 

  492. // initialize USB serial

  493. void usb_init(void)

  494. {

  495. 	uint8_t u;

  496. 

  497. 	u = USBCON;

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

  499. 	HW_CONFIG();

  500.         USB_FREEZE();				// enable USB

  501.         PLL_CONFIG();				// config PLL

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

  503.         USB_CONFIG();				// start USB clock

  504.         UDCON = 0;				// enable attach resistor

  505. 	usb_configuration = 0;

  506. 	usb_suspended = 0;

  507. 	cdc_line_rtsdtr = 0;

  508.         keyboard_report_data[0] = 0;

  509.         keyboard_report_data[1] = 0;

  510.         keyboard_report_data[2] = 0;

  511.         keyboard_report_data[3] = 0;

  512.         keyboard_report_data[4] = 0;

  513.         keyboard_report_data[5] = 0;

  514.         keyboard_report_data[6] = 0;

  515.         keyboard_report_data[7] = 0;

  516.         keyboard_protocol = 1;

  517.         keyboard_idle_config = 125;

  518.         keyboard_idle_count = 0;

  519.         keyboard_leds = 0;

  520.         mouse_buttons = 0;

  521.         mouse_protocol = 1;

  522.         joystick_report_data[0] = 0;

  523.         joystick_report_data[1] = 0;

  524.         joystick_report_data[2] = 0;

  525.         joystick_report_data[3] = 0;

  526.         joystick_report_data[4] =  0x0F;

  527.         joystick_report_data[5] =  0x20;

  528.         joystick_report_data[6] =  0x80;

  529.         joystick_report_data[7] =  0x00;

  530.         joystick_report_data[8] =  0x02;

  531.         joystick_report_data[9] =  0x08;

  532.         joystick_report_data[10] = 0x20;

  533.         joystick_report_data[11] = 0x80;

  534. 	UDINT = 0;

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

  536. }

  537. 

  538. 

  539. void usb_shutdown(void)

  540. {

  541. 	UDIEN = 0;	// disable interrupts

  542. 	UDCON = 1;	// disconnect attach resistor

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

  544. 	PLLCSR = 0;	// shut off PLL

  545. 	usb_configuration = 0;

  546. 	usb_suspended = 1;

  547. }

  548. 

  549. 

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

  551. 

  552. /**************************************************************************

  553.  *

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

  555.  *

  556.  **************************************************************************/

  557. 

  558. 

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

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

  561. //

  562. ISR(USB_GEN_vect)

  563. {

  564. 	uint8_t intbits, t, i;

  565. 	static uint8_t div4=0;

  566. 

  567.         intbits = UDINT;

  568.         UDINT = 0;

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

  570. 		// USB Reset

  571. 		UENUM = 0;

  572. 		UECONX = 1;

  573. 		UECFG0X = EP_TYPE_CONTROL;

  574. 		UECFG1X = EP_SIZE(ENDPOINT0_SIZE) | EP_SINGLE_BUFFER;

  575. 		UEIENX = (1<<RXSTPE);

  576. 		usb_configuration = 0;

  577. 		cdc_line_rtsdtr = 0;

  578. 	}

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

  580. 		// Start Of Frame

  581. 		if (usb_configuration) {

  582. 			t = transmit_flush_timer;

  583. 			if (t) {

  584. 				transmit_flush_timer = --t;

  585. 				if (!t) {

  586. 					UENUM = CDC_TX_ENDPOINT;

  587. 					UEINTX = 0x3A;

  588. 				}

  589. 			}

  590. 			t = reboot_timer;

  591. 			if (t) {

  592. 				reboot_timer = --t;

  593. 				if (!t) _reboot_Teensyduino_();

  594. 			}

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

  596.                         	UENUM = KEYBOARD_ENDPOINT;

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

  598.                                 	keyboard_idle_count++;

  599.                                 	if (keyboard_idle_count == keyboard_idle_config) {

  600.                                         	keyboard_idle_count = 0;

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

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

  603.                                                 	UEDATX = keyboard_report_data[i];

  604.                                         	}

  605.                                         	UEINTX = 0x3A;

  606.                                 	}

  607.                         	}

  608.                 	}

  609. 		}

  610. 	}

  611. 	// in active state

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

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

  614. 		UDIEN = (1<<WAKEUPE);

  615. 		usb_configuration = 0;

  616. 		usb_suspended = 1;

  617. 		#if (F_CPU >= 8000000L)

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

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

  620. 		// Is this a hardware bug?

  621. 		USB_FREEZE();			// shut off USB

  622. 		PLLCSR = 0;			// shut off PLL

  623. 		#endif

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

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

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

  627. 		// user's paradigm....

  628. 	}

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

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

  631. 		#if (F_CPU >= 8000000L)

  632. 		PLL_CONFIG();

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

  634. 		USB_CONFIG();

  635. 		#endif

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

  637. 		usb_suspended = 0;

  638. 		return;

  639. 	}

  640. }

  641. 

  642. 

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

  644. static inline void usb_wait_in_ready(void)

  645. {

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

  647. }

  648. static inline void usb_send_in(void)

  649. {

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

  651. }

  652. static inline void usb_wait_receive_out(void)

  653. {

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

  655. }

  656. static inline void usb_ack_out(void)

  657. {

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

  659. }

  660. 

  661. 

  662. 

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

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

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

  666. //

  667. ISR(USB_COM_vect)

  668. {

  669.         uint8_t intbits;

  670. 	const uint8_t *list;

  671.         const uint8_t *cfg;

  672. 	uint8_t i, n, len, en;

  673. 	volatile uint8_t *p;

  674. 	uint8_t bmRequestType;

  675. 	uint8_t bRequest;

  676. 	uint16_t wValue;

  677. 	uint16_t wIndex;

  678. 	uint16_t wLength;

  679. 	uint16_t desc_val;

  680. 	const uint8_t *desc_addr;

  681. 	uint8_t	desc_length;

  682. 

  683. 	UENUM = 0;

  684. 	intbits = UEINTX;

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

  686. 		bmRequestType = UEDATX;

  687. 		bRequest = UEDATX;

  688. 		read_word_lsbfirst(wValue, UEDATX);

  689. 		read_word_lsbfirst(wIndex, UEDATX);

  690. 		read_word_lsbfirst(wLength, UEDATX);

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

  692.                 if (bRequest == GET_DESCRIPTOR) {

  693. 			list = (const uint8_t *)descriptor_list;

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

  695. 				if (i >= NUM_DESC_LIST) {

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

  697. 					return;

  698. 				}

  699. 				pgm_read_word_postinc(desc_val, list);

  700. 				if (desc_val != wValue) {

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

  702. 					continue;

  703. 				}

  704. 				pgm_read_word_postinc(desc_val, list);

  705. 				if (desc_val != wIndex) {

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

  707. 					continue;

  708. 				}

  709. 				pgm_read_word_postinc(desc_addr, list);

  710. 				desc_length = pgm_read_byte(list);

  711. 				break;

  712. 			}

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

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

  715. 			list = desc_addr;

  716. 			do {

  717. 				// wait for host ready for IN packet

  718. 				do {

  719. 					i = UEINTX;

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

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

  722. 				// send IN packet

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

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

  725. 					pgm_read_byte_postinc(UEDATX, list);

  726. 				}

  727. 				len -= n;

  728. 				usb_send_in();

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

  730. 			return;

  731.                 }

  732. 		if (bRequest == SET_ADDRESS) {

  733. 			usb_send_in();

  734. 			usb_wait_in_ready();

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

  736. 			return;

  737. 		}

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

  739. 			usb_configuration = wValue;

  740. 			cdc_line_rtsdtr = 0;

  741. 			transmit_flush_timer = 0;

  742. 			usb_send_in();

  743. 			cfg = endpoint_config_table;

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

  745. 				UENUM = i;

  746. 				//pgm_read_byte_postinc(en, cfg);

  747. 				//UECONX = en;

  748. 				UECONX = 1;

  749. 				//if (en) {

  750. 				pgm_read_byte_postinc(UECFG0X, cfg);

  751. 				pgm_read_byte_postinc(UECFG1X, cfg);

  752. 				//}

  753. 			}

  754.         		UERST = 0x1E;

  755.         		UERST = 0;

  756. 			return;

  757. 		}

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

  759. 			usb_wait_in_ready();

  760. 			UEDATX = usb_configuration;

  761. 			usb_send_in();

  762. 			return;

  763. 		}

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

  765. 			usb_wait_in_ready();

  766. 			p = cdc_line_coding;

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

  768. 				UEDATX = *p++;

  769. 			}

  770. 			usb_send_in();

  771. 			return;

  772. 		}

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

  774. 			usb_wait_receive_out();

  775. 			p = cdc_line_coding;

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

  777. 				*p++ = UEDATX;

  778. 			}

  779. 			usb_ack_out();

  780. 			usb_send_in();

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

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

  783. 				UENUM = CDC_TX_ENDPOINT;

  784. 				while (UESTA0X & 0x03) {

  785. 					UEINTX = 0xFF;

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

  787. 				}

  788. 				_restart_Teensyduino_();

  789. 			}

  790. 			return;

  791. 		}

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

  793. 			cdc_line_rtsdtr = wValue;

  794. 			usb_wait_in_ready();

  795. 			usb_send_in();

  796. 			return;

  797. 		}

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

  799. 			usb_wait_in_ready();

  800. 			usb_send_in();

  801. 			return;

  802. 		}

  803. 		if (bRequest == GET_STATUS) {

  804. 			usb_wait_in_ready();

  805. 			i = 0;

  806. 			if (bmRequestType == 0x82) {

  807. 				UENUM = wIndex;

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

  809. 				UENUM = 0;

  810. 			}

  811. 			UEDATX = i;

  812. 			UEDATX = 0;

  813. 			usb_send_in();

  814. 			return;

  815. 		}

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

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

  818. 			i = wIndex & 0x7F;

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

  820. 				usb_send_in();

  821. 				UENUM = i;

  822. 				if (bRequest == SET_FEATURE) {

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

  824. 				} else {

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

  826. 					UERST = (1 << i);

  827. 					UERST = 0;

  828. 				}

  829. 				return;

  830. 			}

  831. 		}

  832.                 if (wIndex == KEYBOARD_INTERFACE) {

  833.                         if (bmRequestType == 0xA1) {

  834.                                 if (bRequest == HID_GET_REPORT) {

  835.                                         usb_wait_in_ready();

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

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

  838.                                                 UEDATX = keyboard_report_data[i];

  839.                                         }

  840.                                         usb_send_in();

  841.                                         return;

  842.                                 }

  843.                                 if (bRequest == HID_GET_IDLE) {

  844.                                         usb_wait_in_ready();

  845.                                         UEDATX = keyboard_idle_config;

  846.                                         usb_send_in();

  847.                                         return;

  848.                                 }

  849.                                 if (bRequest == HID_GET_PROTOCOL) {

  850.                                         usb_wait_in_ready();

  851.                                         UEDATX = keyboard_protocol;

  852.                                         usb_send_in();

  853.                                         return;

  854.                                 }

  855.                         }

  856.                         if (bmRequestType == 0x21) {

  857.                                 if (bRequest == HID_SET_REPORT) {

  858.                                         usb_wait_receive_out();

  859.                                         keyboard_leds = UEDATX;

  860.                                         usb_ack_out();

  861.                                         usb_send_in();

  862.                                         return;

  863.                                 }

  864.                                 if (bRequest == HID_SET_IDLE) {

  865.                                         keyboard_idle_config = (wValue >> 8);

  866.                                         keyboard_idle_count = 0;

  867.                                         //usb_wait_in_ready();

  868.                                         usb_send_in();

  869.                                         return;

  870.                                 }

  871.                                 if (bRequest == HID_SET_PROTOCOL) {

  872.                                         keyboard_protocol = wValue;

  873.                                         //usb_wait_in_ready();

  874.                                         usb_send_in();

  875.                                         return;

  876.                                 }

  877.                         }

  878.                 }

  879.                 if (wIndex == MOUSE_INTERFACE) {

  880.                         if (bmRequestType == 0xA1) {

  881.                                 if (bRequest == HID_GET_REPORT) {

  882.                                         usb_wait_in_ready();

  883.                                         UEDATX = mouse_buttons;

  884.                                         UEDATX = 0;

  885.                                         UEDATX = 0;

  886.                                         UEDATX = 0;

  887.                                         usb_send_in();

  888.                                         return;

  889.                                 }

  890.                                 if (bRequest == HID_GET_PROTOCOL) {

  891.                                         usb_wait_in_ready();

  892.                                         UEDATX = mouse_protocol;

  893.                                         usb_send_in();

  894.                                         return;

  895.                                 }

  896.                         }

  897.                         if (bmRequestType == 0x21) {

  898.                                 if (bRequest == HID_SET_PROTOCOL) {

  899.                                         mouse_protocol = wValue;

  900.                                         usb_send_in();

  901.                                         return;

  902.                                 }

  903.                         }

  904.                 }

  905.                 if (wIndex == JOYSTICK_INTERFACE) {

  906.                         if (bmRequestType == 0xA1) {

  907.                                 if (bRequest == HID_GET_REPORT) {

  908.                                         usb_wait_in_ready();

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

  910.                                                 UEDATX = joystick_report_data[i];

  911.                                         }

  912.                                         usb_send_in();

  913.                                         return;

  914.                                 }

  915.                         }

  916.                 }

  917.         }

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

  919. }

  920.