visus
/
teensy-cores
Bevaka 1
Stjärnmärk 0
Förgrening 0
Kod Ärenden 0 Pull-förfrågningar 0 Släpp 0 Wiki Aktiviteter
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
380 Incheckningar
1 Gren
Träd: 0d394a6e76
Grenar Taggar
${ item.name }
Skapa branchen ${ searchTerm }
från '0d394a6e76'
${ noResults }
teensy-cores/usb_hid/usb.c

956 lines
39KB
Rå Blame Historik 

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

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

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

  4.  * 

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

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

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

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

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

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

  11.  * 

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

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

  14.  * 

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

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

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

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

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

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

  21.  * THE SOFTWARE.

  22.  */

  23. 

  24. 

  25. #include "usb_common.h"

  26. #include "usb_private.h"

  27. 

  28. 

  29. 

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

  31.  *

  32.  *  Endpoint Buffer Configuration

  33.  *

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

  35. 

  36. 

  37. static const uint8_t PROGMEM endpoint_config_table[] = {

  38. 	EP_TYPE_INTERRUPT_IN,  EP_SIZE(DEBUG_TX_SIZE) | DEBUG_TX_BUFFER,

  39. 	EP_TYPE_INTERRUPT_OUT, EP_SIZE(DEBUG_RX_SIZE) | DEBUG_RX_BUFFER,

  40. 	EP_TYPE_INTERRUPT_IN,  EP_SIZE(KEYBOARD_SIZE) | KEYBOARD_BUFFER,

  41. 	EP_TYPE_INTERRUPT_IN,  EP_SIZE(MOUSE_SIZE) | MOUSE_BUFFER,

  42. 	EP_TYPE_INTERRUPT_IN,  EP_SIZE(JOYSTICK_SIZE) | JOYSTICK_BUFFER,

  43. 	EP_TYPE_INTERRUPT_IN,  EP_SIZE(KEYMEDIA_SIZE) | KEYMEDIA_BUFFER,

  44. };

  45. 

  46. 

  47. /**************************************************************************

  48.  *

  49.  *  Descriptor Data

  50.  *

  51.  **************************************************************************/

  52. 

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

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

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

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

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

  58. 

  59. static const uint8_t PROGMEM device_descriptor[] = {

  60. 	18,					// bLength

  61. 	1,					// bDescriptorType

  62. 	0x00, 0x02,				// bcdUSB

  63. 	0,					// bDeviceClass

  64. 	0,					// bDeviceSubClass

  65. 	0,					// bDeviceProtocol

  66. 	ENDPOINT0_SIZE,				// bMaxPacketSize0

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

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

  69. 	0x05, 0x01,				// bcdDevice

  70. 	0,					// iManufacturer

  71. 	1,					// iProduct

  72. 	0,					// iSerialNumber

  73. 	1					// bNumConfigurations

  74. };

  75. 

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

  77. static const uint8_t PROGMEM keyboard_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

  91.         0x81, 0x03,             //   Input (Constant),                 ;Reserved byte

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  109.         0xc0			// End Collection

  110. };

  111. 

  112. static const uint8_t PROGMEM keymedia_hid_report_desc[] = {

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

  114.         0x09, 0x01,             //  Usage (Consumer Controls)

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

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

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

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

  119.         0x2A, 0x9C, 0x02,       //  Usage Maximum (0x29C)

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

  121.         0x26, 0x9C, 0x02,       //  Logical Maximum (0x29C)

  122.         0x81, 0x00,             //  Input (Data, Array)

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

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

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

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

  127.         0x29, 0xB7,             //  Usage Maximum (0xB7)

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

  129.         0x26, 0xB7, 0x00,       //  Logical Maximum (0xB7)

  130.         0x81, 0x00,             //  Input (Data, Array)

  131.         0xC0                    //  End Collection

  132. };

  133. 

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

  135. static const uint8_t PROGMEM mouse_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  163.         0xC0                            // End Collection

  164. };

  165. 

  166. #ifdef JOYSTICK_INTERFACE

  167. static const uint8_t PROGMEM joystick_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  201.         0xC0,                           // End Collection

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

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

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

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

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

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

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

  209.         0xC0                            // End Collection

  210. };

  211. #endif

  212. 

  213. 

  214. 

  215. 

  216. 

  217. 

  218. 

  219. static const uint8_t PROGMEM debug_hid_report_desc[] = {

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

  221.         0x09, 0x04,                             // Usage 0x04

  222.         0xA1, 0x5C,                             // Collection 0x5C

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

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

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

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

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

  228.         0x81, 0x02,                             // Input

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

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

  231.         0x91, 0x02,                             // Output

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

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

  234.         0xB1, 0x02,                             // Feature

  235.         0xC0                                    // end collection

  236. };

  237. 

  238. 

  239. 

  240. #define KEYBOARD_HID_DESC_OFFSET	( 9 + 9 )

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

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

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

  244. #define KEYMEDIA_HID_DESC_OFFSET	( 9 + 9+9+7 + 9+9+7 + 9+9+7+7 + 9+9+7 + 9 )

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

  246. 

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

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

  249. 	9, 					// bLength;

  250. 	2,					// bDescriptorType;

  251. 	LSB(CONFIG1_DESC_SIZE),			// wTotalLength

  252. 	MSB(CONFIG1_DESC_SIZE),

  253. 	NUM_INTERFACE,				// bNumInterfaces

  254. 	1,					// bConfigurationValue

  255. 	0,					// iConfiguration

  256. 	0xC0,					// bmAttributes

  257. 	50,					// bMaxPower

  258. 

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

  260.         9,                                      // bLength

  261.         4,                                      // bDescriptorType

  262.         KEYBOARD_INTERFACE,                     // bInterfaceNumber

  263.         0,                                      // bAlternateSetting

  264.         1,                                      // bNumEndpoints

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

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

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

  268.         0,                                      // iInterface

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

  270.         9,                                      // bLength

  271.         0x21,                                   // bDescriptorType

  272.         0x11, 0x01,                             // bcdHID

  273.         0,                                      // bCountryCode

  274.         1,                                      // bNumDescriptors

  275.         0x22,                                   // bDescriptorType

  276.         sizeof(keyboard_hid_report_desc),       // wDescriptorLength

  277.         0,

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

  279.         7,                                      // bLength

  280.         5,                                      // bDescriptorType

  281.         KEYBOARD_ENDPOINT | 0x80,               // bEndpointAddress

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

  283.         KEYBOARD_SIZE, 0,                       // wMaxPacketSize

  284.         KEYBOARD_INTERVAL,                      // bInterval

  285. 

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

  287.         9,                                      // bLength

  288.         4,                                      // bDescriptorType

  289.         MOUSE_INTERFACE,                        // bInterfaceNumber

  290.         0,                                      // bAlternateSetting

  291.         1,                                      // bNumEndpoints

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

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

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

  295.         0,                                      // iInterface

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

  297.         9,                                      // bLength

  298.         0x21,                                   // bDescriptorType

  299.         0x11, 0x01,                             // bcdHID

  300.         0,                                      // bCountryCode

  301.         1,                                      // bNumDescriptors

  302.         0x22,                                   // bDescriptorType

  303.         sizeof(mouse_hid_report_desc),          // wDescriptorLength

  304.         0,

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

  306.         7,                                      // bLength

  307.         5,                                      // bDescriptorType

  308.         MOUSE_ENDPOINT | 0x80,                  // bEndpointAddress

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

  310.         MOUSE_SIZE, 0,                          // wMaxPacketSize

  311.         MOUSE_INTERVAL,                         // bInterval

  312. 

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

  314.         9,                                      // bLength

  315.         4,                                      // bDescriptorType

  316.         DEBUG_INTERFACE,                        // bInterfaceNumber

  317.         0,                                      // bAlternateSetting

  318.         2,                                      // bNumEndpoints

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

  320.         0x00,                                   // bInterfaceSubClass

  321.         0x00,                                   // bInterfaceProtocol

  322.         0,                                      // iInterface

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

  324.         9,                                      // bLength

  325.         0x21,                                   // bDescriptorType

  326.         0x11, 0x01,                             // bcdHID

  327.         0,                                      // bCountryCode

  328.         1,                                      // bNumDescriptors

  329.         0x22,                                   // bDescriptorType

  330.         sizeof(debug_hid_report_desc),          // wDescriptorLength

  331.         0,

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

  333.         7,                                      // bLength

  334.         5,                                      // bDescriptorType

  335.         DEBUG_TX_ENDPOINT | 0x80,               // bEndpointAddress

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

  337.         DEBUG_TX_SIZE, 0,                       // wMaxPacketSize

  338.         DEBUG_TX_INTERVAL,                      // bInterval

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

  340.         7,                                      // bLength

  341.         5,                                      // bDescriptorType

  342.         DEBUG_RX_ENDPOINT,                      // bEndpointAddress

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

  344.         DEBUG_RX_SIZE, 0,                       // wMaxPacketSize

  345.         DEBUG_RX_INTERVAL,                      // bInterval

  346. 

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

  348.         9,                                      // bLength

  349.         4,                                      // bDescriptorType

  350.         JOYSTICK_INTERFACE,                     // bInterfaceNumber

  351.         0,                                      // bAlternateSetting

  352.         1,                                      // bNumEndpoints

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

  354.         0x00,                                   // bInterfaceSubClass

  355.         0x00,                                   // bInterfaceProtocol

  356.         0,                                      // iInterface

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

  358.         9,                                      // bLength

  359.         0x21,                                   // bDescriptorType

  360.         0x11, 0x01,                             // bcdHID

  361.         0,                                      // bCountryCode

  362.         1,                                      // bNumDescriptors

  363.         0x22,                                   // bDescriptorType

  364.         sizeof(joystick_hid_report_desc),       // wDescriptorLength

  365.         0,

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

  367.         7,                                      // bLength

  368.         5,                                      // bDescriptorType

  369.         JOYSTICK_ENDPOINT | 0x80,               // bEndpointAddress

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

  371.         12, 0,					// wMaxPacketSize

  372.         JOYSTICK_INTERVAL,                      // bInterval

  373. 

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

  375.         9,                                      // bLength

  376.         4,                                      // bDescriptorType

  377.         KEYMEDIA_INTERFACE,                     // bInterfaceNumber

  378.         0,                                      // bAlternateSetting

  379.         1,                                      // bNumEndpoints

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

  381.         0x00,                                   // bInterfaceSubClass

  382.         0x00,                                   // bInterfaceProtocol

  383.         0,                                      // iInterface

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

  385.         9,                                      // bLength

  386.         0x21,                                   // bDescriptorType

  387.         0x11, 0x01,                             // bcdHID

  388.         0,                                      // bCountryCode

  389.         1,                                      // bNumDescriptors

  390.         0x22,                                   // bDescriptorType

  391.         LSB(sizeof(keymedia_hid_report_desc)),  // wDescriptorLength

  392.         MSB(sizeof(keymedia_hid_report_desc)),

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

  394.         7,                                      // bLength

  395.         5,                                      // bDescriptorType

  396.         KEYMEDIA_ENDPOINT | 0x80,               // bEndpointAddress

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

  398.         KEYMEDIA_SIZE, 0,                       // wMaxPacketSize

  399.         KEYMEDIA_INTERVAL,                      // bInterval

  400. };

  401. 

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

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

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

  405. struct usb_string_descriptor_struct {

  406. 	uint8_t bLength;

  407. 	uint8_t bDescriptorType;

  408. 	int16_t wString[];

  409. };

  410. static const struct usb_string_descriptor_struct PROGMEM string0 = {

  411. 	4,

  412. 	3,

  413. 	{0x0409}

  414. };

  415. static const struct usb_string_descriptor_struct PROGMEM string1 = {

  416. 	sizeof(STR_PRODUCT),

  417. 	3,

  418. 	STR_PRODUCT

  419. };

  420. 

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

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

  423. static const struct descriptor_list_struct {

  424. 	uint16_t	wValue;

  425. 	uint16_t	wIndex;

  426. 	const uint8_t	*addr;

  427. 	uint8_t		length;

  428. } PROGMEM descriptor_list[] = {

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

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

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

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

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

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

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

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

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

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

  439.         {0x2200, KEYMEDIA_INTERFACE, keymedia_hid_report_desc, sizeof(keymedia_hid_report_desc)},

  440.         {0x2100, KEYMEDIA_INTERFACE, config1_descriptor+KEYMEDIA_HID_DESC_OFFSET, 9},

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

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

  443. };

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

  445. 

  446. 

  447. /**************************************************************************

  448.  *

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

  450.  *

  451.  **************************************************************************/

  452. 

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

  454. volatile uint8_t usb_configuration USBSTATE;

  455. volatile uint8_t usb_suspended USBSTATE;

  456. 

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

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

  459. volatile uint8_t debug_flush_timer USBSTATE;

  460. 

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

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

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

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

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

  466. uint8_t keyboard_report_data[8] USBSTATE;

  467. 

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

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

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

  471. static uint8_t keyboard_protocol USBSTATE;

  472. 

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

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

  475. static uint8_t keyboard_idle_config USBSTATE;

  476. 

  477. // count until idle timeout

  478. uint8_t keyboard_idle_count USBSTATE;

  479. 

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

  481. volatile uint8_t keyboard_leds USBSTATE;

  482. 

  483. // which buttons are currently pressed

  484. uint8_t mouse_buttons USBSTATE;

  485. 

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

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

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

  489. static uint8_t mouse_protocol USBSTATE;

  490. 

  491. // joystick data

  492. uint8_t joystick_report_data[12] USBSTATE;

  493. 

  494. // keyboard media keys data

  495. uint8_t keymedia_report_data[8] USBSTATE;

  496. uint16_t keymedia_consumer_keys[4] USBSTATE;

  497. uint8_t keymedia_system_keys[3] USBSTATE;

  498. 

  499. 

  500. 

  501. /**************************************************************************

  502.  *

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

  504.  *

  505.  **************************************************************************/

  506. 

  507. 

  508. 

  509. // initialize USB serial

  510. void usb_init(void)

  511. {

  512. 	uint8_t u;

  513. 

  514. 	u = USBCON;

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

  516. 	HW_CONFIG();

  517.         USB_FREEZE();				// enable USB

  518.         PLL_CONFIG();				// config PLL

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

  520.         USB_CONFIG();				// start USB clock

  521.         UDCON = 0;				// enable attach resistor

  522. 	usb_configuration = 0;

  523. 	usb_suspended = 0;

  524. 	debug_flush_timer = 0;

  525. 	keyboard_report_data[0] = 0;

  526. 	keyboard_report_data[1] = 0;

  527. 	keyboard_report_data[2] = 0;

  528. 	keyboard_report_data[3] = 0;

  529. 	keyboard_report_data[4] = 0;

  530. 	keyboard_report_data[5] = 0;

  531. 	keyboard_report_data[6] = 0;

  532. 	keyboard_report_data[7] = 0;

  533. 	keyboard_protocol = 1;

  534. 	keyboard_idle_config = 125;

  535. 	keyboard_idle_count = 0;

  536. 	keyboard_leds = 0;

  537. 	mouse_buttons = 0;

  538. 	mouse_protocol = 1;

  539. 	joystick_report_data[0] = 0;

  540. 	joystick_report_data[1] = 0;

  541. 	joystick_report_data[2] = 0;

  542. 	joystick_report_data[3] = 0;

  543. 	joystick_report_data[4] =  0x0F;

  544. 	joystick_report_data[5] =  0x20;

  545. 	joystick_report_data[6] =  0x80;

  546. 	joystick_report_data[7] =  0x00;

  547. 	joystick_report_data[8] =  0x02;

  548. 	joystick_report_data[9] =  0x08;

  549. 	joystick_report_data[10] = 0x20;

  550. 	joystick_report_data[11] = 0x80;

  551. 	keymedia_report_data[0] = 0;

  552. 	keymedia_report_data[1] = 0;

  553. 	keymedia_report_data[2] = 0;

  554. 	keymedia_report_data[3] = 0;

  555. 	keymedia_report_data[4] = 0;

  556. 	keymedia_report_data[5] = 0;

  557. 	keymedia_report_data[6] = 0;

  558. 	keymedia_report_data[7] = 0;

  559. 	keymedia_consumer_keys[0] = 0;

  560. 	keymedia_consumer_keys[1] = 0;

  561. 	keymedia_consumer_keys[2] = 0;

  562. 	keymedia_consumer_keys[3] = 0;

  563. 	keymedia_system_keys[0] = 0;

  564. 	keymedia_system_keys[1] = 0;

  565. 	keymedia_system_keys[2] = 0;

  566. 	UDINT = 0;

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

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

  569. }

  570. 

  571. void usb_shutdown(void)

  572. {

  573. 	UDIEN = 0;		// disable interrupts

  574. 	UDCON = 1;		// disconnect attach resistor

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

  576. 	PLLCSR = 0;		// shut off PLL

  577. 	usb_configuration = 0;

  578. 	usb_suspended = 1;

  579. }

  580. 

  581. 

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

  583. 

  584. /**************************************************************************

  585.  *

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

  587.  *

  588.  **************************************************************************/

  589. 

  590. 

  591. 

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

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

  594. //

  595. ISR(USB_GEN_vect)

  596. {

  597. 	uint8_t intbits, t, i;

  598. 	static uint8_t div4=0;

  599. 

  600.         intbits = UDINT;

  601.         UDINT = 0;

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

  603. 		UENUM = 0;

  604. 		UECONX = 1;

  605. 		UECFG0X = EP_TYPE_CONTROL;

  606. 		UECFG1X = EP_SIZE(ENDPOINT0_SIZE) | EP_SINGLE_BUFFER;

  607. 		UEIENX = (1<<RXSTPE);

  608. 		usb_configuration = 0;

  609.         }

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

  611.                 t = debug_flush_timer;

  612.                 if (t) {

  613.                         debug_flush_timer = -- t;

  614.                         if (!t) {

  615.                                 UENUM = DEBUG_TX_ENDPOINT;

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

  617.                                         UEDATX = 0;

  618.                                 }

  619.                                 UEINTX = 0x3A;

  620.                         }

  621.                 }

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

  623.                         UENUM = KEYBOARD_ENDPOINT;

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

  625.                                 keyboard_idle_count++;

  626.                                 if (keyboard_idle_count == keyboard_idle_config) {

  627.                                         keyboard_idle_count = 0;

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

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

  630.                                                 UEDATX = keyboard_report_data[i];

  631.                                         }

  632.                                         UEINTX = 0x3A;

  633.                                 }

  634.                         }

  635.                 }

  636.         }

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

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

  639. 		UDIEN = (1<<WAKEUPE);

  640. 		usb_configuration = 0;

  641. 		usb_suspended = 1;

  642. 		#if (F_CPU >= 8000000L)

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

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

  645. 		// Is this a hardware bug?

  646. 		USB_FREEZE();			// shut off USB

  647. 		PLLCSR = 0;			// shut off PLL

  648. 		#endif

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

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

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

  652. 		// user's paradigm....

  653. 	}

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

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

  656. 		#if (F_CPU >= 8000000L)

  657. 		PLL_CONFIG();

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

  659. 		USB_CONFIG();

  660. 		#endif

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

  662. 		usb_suspended = 0;

  663. 		return;

  664. 	}

  665. }

  666. 

  667. 

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

  669. static inline void usb_wait_in_ready(void)

  670. {

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

  672. }

  673. static inline void usb_send_in(void)

  674. {

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

  676. }

  677. static inline void usb_wait_receive_out(void)

  678. {

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

  680. }

  681. static inline void usb_ack_out(void)

  682. {

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

  684. }

  685. 

  686. 

  687. 

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

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

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

  691. //

  692. ISR(USB_COM_vect)

  693. {

  694.         uint8_t intbits;

  695. 	const uint8_t *list;

  696.         const uint8_t *cfg;

  697. 	uint8_t i, n, len;

  698. 	uint8_t bmRequestType;

  699. 	uint8_t bRequest;

  700. 	uint16_t wValue;

  701. 	uint16_t wIndex;

  702. 	uint16_t wLength;

  703. 	uint16_t desc_val;

  704. 	const uint8_t *desc_addr;

  705. 	uint8_t	desc_length;

  706. 

  707. 	UENUM = 0;

  708. 	intbits = UEINTX;

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

  710. 		bmRequestType = UEDATX;

  711. 		bRequest = UEDATX;

  712. 		read_word_lsbfirst(wValue, UEDATX);

  713. 		read_word_lsbfirst(wIndex, UEDATX);

  714. 		read_word_lsbfirst(wLength, UEDATX);

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

  716. 		if (bRequest == GET_DESCRIPTOR) {

  717. 			list = (const uint8_t *)descriptor_list;

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

  719. 				if (i >= NUM_DESC_LIST) {

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

  721. 					return;

  722. 				}

  723. 				pgm_read_word_postinc(desc_val, list);

  724. 				if (desc_val != wValue) {

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

  726. 					continue;

  727. 				}

  728. 				pgm_read_word_postinc(desc_val, list);

  729. 				if (desc_val != wIndex) {

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

  731. 					continue;

  732. 				}

  733. 				pgm_read_word_postinc(desc_addr, list);

  734. 				desc_length = pgm_read_byte(list);

  735. 				break;

  736. 			}

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

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

  739. 			list = desc_addr;

  740. 			do {

  741. 				// wait for host ready for IN packet

  742. 				do {

  743. 					i = UEINTX;

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

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

  746. 				// send IN packet

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

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

  749. 					pgm_read_byte_postinc(UEDATX, list);

  750. 				}

  751. 				len -= n;

  752. 				usb_send_in();

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

  754. 			return;

  755.                 }

  756. 		if (bRequest == SET_ADDRESS) {

  757. 			usb_send_in();

  758. 			usb_wait_in_ready();

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

  760. 			return;

  761. 		}

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

  763. 			usb_configuration = wValue;

  764. 			debug_flush_timer = 0;

  765. 			usb_send_in();

  766. 			cfg = endpoint_config_table;

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

  768. 				UENUM = i;

  769. 				UECONX = 1;

  770. 				pgm_read_byte_postinc(UECFG0X, cfg);

  771. 				pgm_read_byte_postinc(UECFG1X, cfg);

  772. 			}

  773.         		UERST = 0x1E;

  774.         		UERST = 0;

  775. 			return;

  776. 		}

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

  778. 			usb_wait_in_ready();

  779. 			UEDATX = usb_configuration;

  780. 			usb_send_in();

  781. 			return;

  782. 		}

  783. 		if (bRequest == GET_STATUS) {

  784. 			usb_wait_in_ready();

  785. 			i = 0;

  786. 			if (bmRequestType == 0x82) {

  787. 				UENUM = wIndex;

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

  789. 				UENUM = 0;

  790. 			}

  791. 			UEDATX = i;

  792. 			UEDATX = 0;

  793. 			usb_send_in();

  794. 			return;

  795. 		}

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

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

  798. 			i = wIndex & 0x7F;

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

  800. 				usb_send_in();

  801. 				UENUM = i;

  802. 				if (bRequest == SET_FEATURE) {

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

  804. 				} else {

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

  806. 					UERST = (1 << i);

  807. 					UERST = 0;

  808. 				}

  809. 				return;

  810. 			}

  811. 		}

  812.                 if (wIndex == KEYBOARD_INTERFACE) {

  813.                         if (bmRequestType == 0xA1) {

  814.                                 if (bRequest == HID_GET_REPORT) {

  815.                                         usb_wait_in_ready();

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

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

  818.                                                 UEDATX = keyboard_report_data[i];

  819.                                         }

  820.                                         usb_send_in();

  821.                                         return;

  822.                                 }

  823.                                 if (bRequest == HID_GET_IDLE) {

  824.                                         usb_wait_in_ready();

  825.                                         UEDATX = keyboard_idle_config;

  826.                                         usb_send_in();

  827.                                         return;

  828.                                 }

  829.                                 if (bRequest == HID_GET_PROTOCOL) {

  830.                                         usb_wait_in_ready();

  831.                                         UEDATX = keyboard_protocol;

  832.                                         usb_send_in();

  833.                                         return;

  834.                                 }

  835.                         }

  836.                         if (bmRequestType == 0x21) {

  837.                                 if (bRequest == HID_SET_REPORT) {

  838.                                         usb_wait_receive_out();

  839.                                         keyboard_leds = UEDATX;

  840.                                         usb_ack_out();

  841.                                         usb_send_in();

  842.                                         return;

  843.                                 }

  844.                                 if (bRequest == HID_SET_IDLE) {

  845.                                         keyboard_idle_config = (wValue >> 8);

  846.                                         keyboard_idle_count = 0;

  847.                                         //usb_wait_in_ready();

  848.                                         usb_send_in();

  849.                                         return;

  850.                                 }

  851.                                 if (bRequest == HID_SET_PROTOCOL) {

  852.                                         keyboard_protocol = wValue;

  853.                                         //usb_wait_in_ready();

  854.                                         usb_send_in();

  855.                                         return;

  856.                                 }

  857.                         }

  858.                 }

  859.                 if (wIndex == MOUSE_INTERFACE) {

  860.                         if (bmRequestType == 0xA1) {

  861.                                 if (bRequest == HID_GET_REPORT) {

  862.                                         usb_wait_in_ready();

  863.                                         UEDATX = mouse_buttons;

  864.                                         UEDATX = 0;

  865.                                         UEDATX = 0;

  866.                                         UEDATX = 0;

  867.                                         UEDATX = 0;

  868.                                         usb_send_in();

  869.                                         return;

  870.                                 }

  871.                                 if (bRequest == HID_GET_PROTOCOL) {

  872.                                         usb_wait_in_ready();

  873.                                         UEDATX = mouse_protocol;

  874.                                         usb_send_in();

  875.                                         return;

  876.                                 }

  877.                         }

  878.                         if (bmRequestType == 0x21) {

  879.                                 if (bRequest == HID_SET_PROTOCOL) {

  880.                                         mouse_protocol = wValue;

  881.                                         usb_send_in();

  882.                                         return;

  883.                                 }

  884.                         }

  885.                 }

  886.                 if (wIndex == JOYSTICK_INTERFACE) {

  887.                         if (bmRequestType == 0xA1) {

  888.                                 if (bRequest == HID_GET_REPORT) {

  889.                                         usb_wait_in_ready();

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

  891. 						UEDATX = joystick_report_data[i];

  892. 					}

  893.                                         usb_send_in();

  894.                                         return;

  895. 				}

  896. 			}

  897. 		}

  898.                 if (wIndex == KEYMEDIA_INTERFACE) {

  899.                         if (bmRequestType == 0xA1) {

  900.                                 if (bRequest == HID_GET_REPORT) {

  901.                                         usb_wait_in_ready();

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

  903. 						UEDATX = keymedia_report_data[i];

  904. 					}

  905.                                         usb_send_in();

  906.                                         return;

  907. 				}

  908. 			}

  909. 		}

  910.                 if (wIndex == DEBUG_INTERFACE) {

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

  912.                                 len = wLength;

  913.                                 do {

  914.                                         // wait for host ready for IN packet

  915.                                         do {

  916.                                                 i = UEINTX;

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

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

  919.                                         // send IN packet

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

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

  922.                                                 UEDATX = 0;

  923.                                         }

  924.                                         len -= n;

  925.                                         usb_send_in();

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

  927.                                 return;

  928.                         }

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

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

  931. 					uint8_t b1, b2, b3, b4;

  932.                                         usb_wait_receive_out();

  933. 					b1 = UEDATX;

  934. 					b2 = UEDATX;

  935. 					b3 = UEDATX;

  936. 					b4 = UEDATX;

  937.                                         usb_ack_out();

  938.                                         usb_send_in();

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

  940. 						_reboot_Teensyduino_();

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

  942. 						_restart_Teensyduino_();

  943. 				}

  944. 			}

  945.                 }

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

  947. 			usb_send_in();

  948. 			usb_wait_in_ready();

  949. 			_restart_Teensyduino_();

  950. 		}

  951.         }

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

  953. }

  954.