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.
1372 Commits
1 Branch
Tree: f6cb39e135
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'f6cb39e135'
${ noResults }
teensy-cores/usb_serial_hid/usb.c

931 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. #if defined(__AVR_ATmega32U4__)

  69. 	0x71, 0x02,

  70. #elif defined(__AVR_AT90USB1286__)

  71. 	0x72, 0x02,

  72. #else

  73. 	0x02, 0x01,				// bcdDevice

  74. #endif

  75. 	1,					// iManufacturer

  76. 	2,					// iProduct

  77. 	3,					// iSerialNumber

  78. 	1					// bNumConfigurations

  79. };

  80. 

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

  82. static const uint8_t PROGMEM keyboard_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  125.         0xc0                    // End Collection

  126. };

  127. 

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

  129. static const uint8_t PROGMEM mouse_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  157.         0xC0                            // End Collection

  158. };

  159. 

  160. static const uint8_t PROGMEM joystick_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  194.         0xC0,                           // End Collection

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

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

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

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

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

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

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

  202.         0xC0                            // End Collection

  203. };

  204. 

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

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

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

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

  209. 

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

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

  212. 	9, 					// bLength;

  213. 	2,					// bDescriptorType;

  214. 	LSB(CONFIG1_DESC_SIZE),			// wTotalLength

  215. 	MSB(CONFIG1_DESC_SIZE),

  216. 	5,					// bNumInterfaces

  217. 	1,					// bConfigurationValue

  218. 	0,					// iConfiguration

  219. 	0xC0,					// bmAttributes

  220. 	50,					// bMaxPower

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

  222.         8,                                      // bLength

  223.         11,                                     // bDescriptorType

  224.         0,                                      // bFirstInterface

  225.         2,                                      // bInterfaceCount

  226.         0x02,                                   // bFunctionClass

  227.         0x02,                                   // bFunctionSubClass

  228.         0x01,                                   // bFunctionProtocol

  229.         4,                                      // iFunction

  230. 

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

  232. 	9,					// bLength

  233. 	4,					// bDescriptorType

  234. 	0,					// bInterfaceNumber

  235. 	0,					// bAlternateSetting

  236. 	1,					// bNumEndpoints

  237. 	0x02,					// bInterfaceClass

  238. 	0x02,					// bInterfaceSubClass

  239. 	0x01,					// bInterfaceProtocol

  240. 	0,					// iInterface

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

  242. 	5,					// bFunctionLength

  243. 	0x24,					// bDescriptorType

  244. 	0x00,					// bDescriptorSubtype

  245. 	0x10, 0x01,				// bcdCDC

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

  247. 	5,					// bFunctionLength

  248. 	0x24,					// bDescriptorType

  249. 	0x01,					// bDescriptorSubtype

  250. 	0x00,					// bmCapabilities

  251. 	1,					// bDataInterface

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

  253. 	4,					// bFunctionLength

  254. 	0x24,					// bDescriptorType

  255. 	0x02,					// bDescriptorSubtype

  256. 	0x06,					// bmCapabilities

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

  258. 	5,					// bFunctionLength

  259. 	0x24,					// bDescriptorType

  260. 	0x06,					// bDescriptorSubtype

  261. 	0,					// bMasterInterface

  262. 	1,					// bSlaveInterface0

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

  264. 	7,					// bLength

  265. 	5,					// bDescriptorType

  266. 	CDC_ACM_ENDPOINT | 0x80,		// bEndpointAddress

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

  268. 	CDC_ACM_SIZE, 0,			// wMaxPacketSize

  269. 	64,					// bInterval

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

  271. 	9,					// bLength

  272. 	4,					// bDescriptorType

  273. 	1,					// bInterfaceNumber

  274. 	0,					// bAlternateSetting

  275. 	2,					// bNumEndpoints

  276. 	0x0A,					// bInterfaceClass

  277. 	0x00,					// bInterfaceSubClass

  278. 	0x00,					// bInterfaceProtocol

  279. 	0,					// iInterface

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

  281. 	7,					// bLength

  282. 	5,					// bDescriptorType

  283. 	CDC_RX_ENDPOINT,			// bEndpointAddress

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

  285. 	CDC_RX_SIZE, 0,				// wMaxPacketSize

  286. 	0,					// bInterval

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

  288. 	7,					// bLength

  289. 	5,					// bDescriptorType

  290. 	CDC_TX_ENDPOINT | 0x80,			// bEndpointAddress

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

  292. 	CDC_TX_SIZE, 0,				// wMaxPacketSize

  293. 	0,					// bInterval

  294. 

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

  296.         9,                                      // bLength

  297.         4,                                      // bDescriptorType

  298.         KEYBOARD_INTERFACE,                     // bInterfaceNumber

  299.         0,                                      // bAlternateSetting

  300.         1,                                      // bNumEndpoints

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

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

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

  304.         0,                                      // iInterface

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

  306.         9,                                      // bLength

  307.         0x21,                                   // bDescriptorType

  308.         0x11, 0x01,                             // bcdHID

  309.         0,                                      // bCountryCode

  310.         1,                                      // bNumDescriptors

  311.         0x22,                                   // bDescriptorType

  312.         sizeof(keyboard_hid_report_desc),       // wDescriptorLength

  313.         0,

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

  315.         7,                                      // bLength

  316.         5,                                      // bDescriptorType

  317.         KEYBOARD_ENDPOINT | 0x80,               // bEndpointAddress

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

  319.         KEYBOARD_SIZE, 0,                       // wMaxPacketSize

  320.         KEYBOARD_INTERVAL,                      // bInterval

  321. 

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

  323.         9,                                      // bLength

  324.         4,                                      // bDescriptorType

  325.         MOUSE_INTERFACE,                        // bInterfaceNumber

  326.         0,                                      // bAlternateSetting

  327.         1,                                      // bNumEndpoints

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

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

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

  331.         0,                                      // iInterface

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

  333.         9,                                      // bLength

  334.         0x21,                                   // bDescriptorType

  335.         0x11, 0x01,                             // bcdHID

  336.         0,                                      // bCountryCode

  337.         1,                                      // bNumDescriptors

  338.         0x22,                                   // bDescriptorType

  339.         sizeof(mouse_hid_report_desc),          // wDescriptorLength

  340.         0,

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

  342.         7,                                      // bLength

  343.         5,                                      // bDescriptorType

  344.         MOUSE_ENDPOINT | 0x80,                  // bEndpointAddress

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

  346.         MOUSE_SIZE, 0,                          // wMaxPacketSize

  347.         MOUSE_INTERVAL,                         // bInterval

  348. 

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

  350.         9,                                      // bLength

  351.         4,                                      // bDescriptorType

  352.         JOYSTICK_INTERFACE,                     // bInterfaceNumber

  353.         0,                                      // bAlternateSetting

  354.         1,                                      // bNumEndpoints

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

  356.         0x00,                                   // bInterfaceSubClass

  357.         0x00,                                   // bInterfaceProtocol

  358.         0,                                      // iInterface

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

  360.         9,                                      // bLength

  361.         0x21,                                   // bDescriptorType

  362.         0x11, 0x01,                             // bcdHID

  363.         0,                                      // bCountryCode

  364.         1,                                      // bNumDescriptors

  365.         0x22,                                   // bDescriptorType

  366.         sizeof(joystick_hid_report_desc),       // wDescriptorLength

  367.         0,

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

  369.         7,                                      // bLength

  370.         5,                                      // bDescriptorType

  371.         JOYSTICK_ENDPOINT | 0x80,               // bEndpointAddress

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

  373.         12, 0,                                  // wMaxPacketSize

  374.         JOYSTICK_INTERVAL                       // bInterval

  375. };

  376. 

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

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

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

  380. struct usb_string_descriptor_struct {

  381. 	uint8_t bLength;

  382. 	uint8_t bDescriptorType;

  383. 	int16_t wString[];

  384. };

  385. static const struct usb_string_descriptor_struct PROGMEM string0 = {

  386. 	4,

  387. 	3,

  388. 	{0x0409}

  389. };

  390. static const struct usb_string_descriptor_struct PROGMEM string1 = {

  391. 	sizeof(STR_MANUFACTURER),

  392. 	3,

  393. 	STR_MANUFACTURER

  394. };

  395. static const struct usb_string_descriptor_struct PROGMEM string2 = {

  396. 	sizeof(STR_PRODUCT),

  397. 	3,

  398. 	STR_PRODUCT

  399. };

  400. static const struct usb_string_descriptor_struct PROGMEM string3 = {

  401. 	sizeof(STR_SERIAL_NUMBER),

  402. 	3,

  403. 	STR_SERIAL_NUMBER

  404. };

  405. static const struct usb_string_descriptor_struct PROGMEM string4 = {

  406. 	sizeof(STR_SERIAL),

  407. 	3,

  408. 	STR_SERIAL

  409. };

  410. 

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

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

  413. static const struct descriptor_list_struct {

  414. 	uint16_t	wValue;

  415. 	uint16_t	wIndex;

  416. 	const uint8_t	*addr;

  417. 	uint8_t		length;

  418. } PROGMEM descriptor_list[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

  432. };

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

  434. 

  435. 

  436. /**************************************************************************

  437.  *

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

  439.  *

  440.  **************************************************************************/

  441. 

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

  443. volatile uint8_t usb_configuration USBSTATE;

  444. volatile uint8_t usb_suspended USBSTATE;

  445. 

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

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

  448. volatile uint8_t transmit_flush_timer=0;

  449. volatile uint8_t reboot_timer=0;

  450. uint8_t transmit_previous_timeout=0;

  451. 

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

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

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

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

  456. volatile uint8_t cdc_line_rtsdtr USBSTATE;

  457. 

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

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

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

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

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

  463. uint8_t keyboard_report_data[8] USBSTATE;

  464. 

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

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

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

  468. static uint8_t keyboard_protocol USBSTATE;

  469. 

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

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

  472. static uint8_t keyboard_idle_config USBSTATE;

  473. 

  474. // count until idle timeout

  475. uint8_t keyboard_idle_count USBSTATE;

  476. 

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

  478. volatile uint8_t keyboard_leds USBSTATE;

  479. 

  480. // which buttons are currently pressed

  481. uint8_t mouse_buttons USBSTATE;

  482. 

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

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

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

  486. static uint8_t mouse_protocol USBSTATE;

  487. 

  488. // joystick data

  489. uint8_t joystick_report_data[12] USBSTATE;

  490. 

  491. 

  492. 

  493. /**************************************************************************

  494.  *

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

  496.  *

  497.  **************************************************************************/

  498. 

  499. 

  500. // initialize USB serial

  501. void usb_init(void)

  502. {

  503. 	uint8_t u;

  504. 

  505. 	u = USBCON;

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

  507. 	HW_CONFIG();

  508.         USB_FREEZE();				// enable USB

  509.         PLL_CONFIG();				// config PLL

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

  511.         USB_CONFIG();				// start USB clock

  512.         UDCON = 0;				// enable attach resistor

  513. 	usb_configuration = 0;

  514. 	usb_suspended = 0;

  515. 	cdc_line_rtsdtr = 0;

  516.         keyboard_report_data[0] = 0;

  517.         keyboard_report_data[1] = 0;

  518.         keyboard_report_data[2] = 0;

  519.         keyboard_report_data[3] = 0;

  520.         keyboard_report_data[4] = 0;

  521.         keyboard_report_data[5] = 0;

  522.         keyboard_report_data[6] = 0;

  523.         keyboard_report_data[7] = 0;

  524.         keyboard_protocol = 1;

  525.         keyboard_idle_config = 125;

  526.         keyboard_idle_count = 0;

  527.         keyboard_leds = 0;

  528.         mouse_buttons = 0;

  529.         mouse_protocol = 1;

  530.         joystick_report_data[0] = 0;

  531.         joystick_report_data[1] = 0;

  532.         joystick_report_data[2] = 0;

  533.         joystick_report_data[3] = 0;

  534.         joystick_report_data[4] =  0x0F;

  535.         joystick_report_data[5] =  0x20;

  536.         joystick_report_data[6] =  0x80;

  537.         joystick_report_data[7] =  0x00;

  538.         joystick_report_data[8] =  0x02;

  539.         joystick_report_data[9] =  0x08;

  540.         joystick_report_data[10] = 0x20;

  541.         joystick_report_data[11] = 0x80;

  542. 	UDINT = 0;

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

  544. }

  545. 

  546. 

  547. void usb_shutdown(void)

  548. {

  549. 	UDIEN = 0;	// disable interrupts

  550. 	UDCON = 1;	// disconnect attach resistor

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

  552. 	PLLCSR = 0;	// shut off PLL

  553. 	usb_configuration = 0;

  554. 	usb_suspended = 1;

  555. }

  556. 

  557. 

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

  559. 

  560. /**************************************************************************

  561.  *

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

  563.  *

  564.  **************************************************************************/

  565. 

  566. 

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

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

  569. //

  570. ISR(USB_GEN_vect)

  571. {

  572. 	uint8_t intbits, t, i;

  573. 	static uint8_t div4=0;

  574. 

  575.         intbits = UDINT;

  576.         UDINT = 0;

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

  578. 		// USB Reset

  579. 		UENUM = 0;

  580. 		UECONX = 1;

  581. 		UECFG0X = EP_TYPE_CONTROL;

  582. 		UECFG1X = EP_SIZE(ENDPOINT0_SIZE) | EP_SINGLE_BUFFER;

  583. 		UEIENX = (1<<RXSTPE);

  584. 		usb_configuration = 0;

  585. 		cdc_line_rtsdtr = 0;

  586. 	}

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

  588. 		// Start Of Frame

  589. 		if (usb_configuration) {

  590. 			t = transmit_flush_timer;

  591. 			if (t) {

  592. 				transmit_flush_timer = --t;

  593. 				if (!t) {

  594. 					UENUM = CDC_TX_ENDPOINT;

  595. 					UEINTX = 0x3A;

  596. 				}

  597. 			}

  598. 			t = reboot_timer;

  599. 			if (t) {

  600. 				reboot_timer = --t;

  601. 				if (!t) _reboot_Teensyduino_();

  602. 			}

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

  604.                         	UENUM = KEYBOARD_ENDPOINT;

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

  606.                                 	keyboard_idle_count++;

  607.                                 	if (keyboard_idle_count == keyboard_idle_config) {

  608.                                         	keyboard_idle_count = 0;

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

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

  611.                                                 	UEDATX = keyboard_report_data[i];

  612.                                         	}

  613.                                         	UEINTX = 0x3A;

  614.                                 	}

  615.                         	}

  616.                 	}

  617. 		}

  618. 	}

  619. 	// in active state

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

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

  622. 		UDIEN = (1<<WAKEUPE);

  623. 		usb_configuration = 0;

  624. 		usb_suspended = 1;

  625. 		#if (F_CPU >= 8000000L)

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

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

  628. 		// Is this a hardware bug?

  629. 		USB_FREEZE();			// shut off USB

  630. 		PLLCSR = 0;			// shut off PLL

  631. 		#endif

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

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

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

  635. 		// user's paradigm....

  636. 	}

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

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

  639. 		#if (F_CPU >= 8000000L)

  640. 		PLL_CONFIG();

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

  642. 		USB_CONFIG();

  643. 		#endif

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

  645. 		usb_suspended = 0;

  646. 		return;

  647. 	}

  648. }

  649. 

  650. 

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

  652. static inline void usb_wait_in_ready(void)

  653. {

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

  655. }

  656. static inline void usb_send_in(void)

  657. {

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

  659. }

  660. static inline void usb_wait_receive_out(void)

  661. {

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

  663. }

  664. static inline void usb_ack_out(void)

  665. {

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

  667. }

  668. 

  669. 

  670. 

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

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

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

  674. //

  675. ISR(USB_COM_vect)

  676. {

  677.         uint8_t intbits;

  678. 	const uint8_t *list;

  679.         const uint8_t *cfg;

  680. 	uint8_t i, n, len;

  681. 	volatile uint8_t *p;

  682. 	uint8_t bmRequestType;

  683. 	uint8_t bRequest;

  684. 	uint16_t wValue;

  685. 	uint16_t wIndex;

  686. 	uint16_t wLength;

  687. 	uint16_t desc_val;

  688. 	const uint8_t *desc_addr;

  689. 	uint8_t	desc_length;

  690. 

  691. 	UENUM = 0;

  692. 	intbits = UEINTX;

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

  694. 		bmRequestType = UEDATX;

  695. 		bRequest = UEDATX;

  696. 		read_word_lsbfirst(wValue, UEDATX);

  697. 		read_word_lsbfirst(wIndex, UEDATX);

  698. 		read_word_lsbfirst(wLength, UEDATX);

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

  700.                 if (bRequest == GET_DESCRIPTOR) {

  701. 			list = (const uint8_t *)descriptor_list;

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

  703. 				if (i >= NUM_DESC_LIST) {

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

  705. 					return;

  706. 				}

  707. 				pgm_read_word_postinc(desc_val, list);

  708. 				if (desc_val != wValue) {

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

  710. 					continue;

  711. 				}

  712. 				pgm_read_word_postinc(desc_val, list);

  713. 				if (desc_val != wIndex) {

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

  715. 					continue;

  716. 				}

  717. 				pgm_read_word_postinc(desc_addr, list);

  718. 				desc_length = pgm_read_byte(list);

  719. 				break;

  720. 			}

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

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

  723. 			list = desc_addr;

  724. 			do {

  725. 				// wait for host ready for IN packet

  726. 				do {

  727. 					i = UEINTX;

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

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

  730. 				// send IN packet

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

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

  733. 					pgm_read_byte_postinc(UEDATX, list);

  734. 				}

  735. 				len -= n;

  736. 				usb_send_in();

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

  738. 			return;

  739.                 }

  740. 		if (bRequest == SET_ADDRESS) {

  741. 			usb_send_in();

  742. 			usb_wait_in_ready();

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

  744. 			return;

  745. 		}

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

  747. 			usb_configuration = wValue;

  748. 			cdc_line_rtsdtr = 0;

  749. 			transmit_flush_timer = 0;

  750. 			usb_send_in();

  751. 			cfg = endpoint_config_table;

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

  753. 				UENUM = i;

  754. 				//pgm_read_byte_postinc(en, cfg);

  755. 				//UECONX = en;

  756. 				UECONX = 1;

  757. 				//if (en) {

  758. 				pgm_read_byte_postinc(UECFG0X, cfg);

  759. 				pgm_read_byte_postinc(UECFG1X, cfg);

  760. 				//}

  761. 			}

  762.         		UERST = 0x1E;

  763.         		UERST = 0;

  764. 			return;

  765. 		}

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

  767. 			usb_wait_in_ready();

  768. 			UEDATX = usb_configuration;

  769. 			usb_send_in();

  770. 			return;

  771. 		}

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

  773. 			usb_wait_in_ready();

  774. 			p = cdc_line_coding;

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

  776. 				UEDATX = *p++;

  777. 			}

  778. 			usb_send_in();

  779. 			return;

  780. 		}

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

  782. 			usb_wait_receive_out();

  783. 			p = cdc_line_coding;

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

  785. 				*p++ = UEDATX;

  786. 			}

  787. 			usb_ack_out();

  788. 			usb_send_in();

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

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

  791. 				UENUM = CDC_TX_ENDPOINT;

  792. 				while (UESTA0X & 0x03) {

  793. 					UEINTX = 0xFF;

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

  795. 				}

  796. 				_restart_Teensyduino_();

  797. 			}

  798. 			return;

  799. 		}

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

  801. 			cdc_line_rtsdtr = wValue;

  802. 			usb_wait_in_ready();

  803. 			usb_send_in();

  804. 			return;

  805. 		}

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

  807. 			usb_wait_in_ready();

  808. 			usb_send_in();

  809. 			return;

  810. 		}

  811. 		if (bRequest == GET_STATUS) {

  812. 			usb_wait_in_ready();

  813. 			i = 0;

  814. 			if (bmRequestType == 0x82) {

  815. 				UENUM = wIndex;

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

  817. 				UENUM = 0;

  818. 			}

  819. 			UEDATX = i;

  820. 			UEDATX = 0;

  821. 			usb_send_in();

  822. 			return;

  823. 		}

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

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

  826. 			i = wIndex & 0x7F;

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

  828. 				usb_send_in();

  829. 				UENUM = i;

  830. 				if (bRequest == SET_FEATURE) {

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

  832. 				} else {

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

  834. 					UERST = (1 << i);

  835. 					UERST = 0;

  836. 				}

  837. 				return;

  838. 			}

  839. 		}

  840.                 if (wIndex == KEYBOARD_INTERFACE) {

  841.                         if (bmRequestType == 0xA1) {

  842.                                 if (bRequest == HID_GET_REPORT) {

  843.                                         usb_wait_in_ready();

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

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

  846.                                                 UEDATX = keyboard_report_data[i];

  847.                                         }

  848.                                         usb_send_in();

  849.                                         return;

  850.                                 }

  851.                                 if (bRequest == HID_GET_IDLE) {

  852.                                         usb_wait_in_ready();

  853.                                         UEDATX = keyboard_idle_config;

  854.                                         usb_send_in();

  855.                                         return;

  856.                                 }

  857.                                 if (bRequest == HID_GET_PROTOCOL) {

  858.                                         usb_wait_in_ready();

  859.                                         UEDATX = keyboard_protocol;

  860.                                         usb_send_in();

  861.                                         return;

  862.                                 }

  863.                         }

  864.                         if (bmRequestType == 0x21) {

  865.                                 if (bRequest == HID_SET_REPORT) {

  866.                                         usb_wait_receive_out();

  867.                                         keyboard_leds = UEDATX;

  868.                                         usb_ack_out();

  869.                                         usb_send_in();

  870.                                         return;

  871.                                 }

  872.                                 if (bRequest == HID_SET_IDLE) {

  873.                                         keyboard_idle_config = (wValue >> 8);

  874.                                         keyboard_idle_count = 0;

  875.                                         //usb_wait_in_ready();

  876.                                         usb_send_in();

  877.                                         return;

  878.                                 }

  879.                                 if (bRequest == HID_SET_PROTOCOL) {

  880.                                         keyboard_protocol = wValue;

  881.                                         //usb_wait_in_ready();

  882.                                         usb_send_in();

  883.                                         return;

  884.                                 }

  885.                         }

  886.                 }

  887.                 if (wIndex == MOUSE_INTERFACE) {

  888.                         if (bmRequestType == 0xA1) {

  889.                                 if (bRequest == HID_GET_REPORT) {

  890.                                         usb_wait_in_ready();

  891.                                         UEDATX = mouse_buttons;

  892.                                         UEDATX = 0;

  893.                                         UEDATX = 0;

  894.                                         UEDATX = 0;

  895.                                         UEDATX = 0;

  896.                                         usb_send_in();

  897.                                         return;

  898.                                 }

  899.                                 if (bRequest == HID_GET_PROTOCOL) {

  900.                                         usb_wait_in_ready();

  901.                                         UEDATX = mouse_protocol;

  902.                                         usb_send_in();

  903.                                         return;

  904.                                 }

  905.                         }

  906.                         if (bmRequestType == 0x21) {

  907.                                 if (bRequest == HID_SET_PROTOCOL) {

  908.                                         mouse_protocol = wValue;

  909.                                         usb_send_in();

  910.                                         return;

  911.                                 }

  912.                         }

  913.                 }

  914.                 if (wIndex == JOYSTICK_INTERFACE) {

  915.                         if (bmRequestType == 0xA1) {

  916.                                 if (bRequest == HID_GET_REPORT) {

  917.                                         usb_wait_in_ready();

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

  919.                                                 UEDATX = joystick_report_data[i];

  920.                                         }

  921.                                         usb_send_in();

  922.                                         return;

  923.                                 }

  924.                         }

  925.                 }

  926.         }

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

  928. }

  929.