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

962 lines
39KB
Raw Blame History 

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

  70. 	0x71, 0x02,

  71. #elif defined(__AVR_AT90USB1286__)

  72. 	0x72, 0x02,

  73. #else

  74. 	0x05, 0x01,				// bcdDevice

  75. #endif

  76. 	0,					// iManufacturer

  77. 	1,					// iProduct

  78. 	0,					// iSerialNumber

  79. 	1					// bNumConfigurations

  80. };

  81. 

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

  83. static const uint8_t PROGMEM keyboard_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  115.         0xc0			// End Collection

  116. };

  117. 

  118. static const uint8_t PROGMEM keymedia_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  137.         0xC0                    //  End Collection

  138. };

  139. 

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

  141. static const uint8_t PROGMEM mouse_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  169.         0xC0                            // End Collection

  170. };

  171. 

  172. #ifdef JOYSTICK_INTERFACE

  173. static const uint8_t PROGMEM joystick_hid_report_desc[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  207.         0xC0,                           // End Collection

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

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

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

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

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

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

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

  215.         0xC0                            // End Collection

  216. };

  217. #endif

  218. 

  219. 

  220. 

  221. 

  222. 

  223. 

  224. 

  225. static const uint8_t PROGMEM debug_hid_report_desc[] = {

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

  227.         0x09, 0x04,                             // Usage 0x04

  228.         0xA1, 0x5C,                             // Collection 0x5C

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

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

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

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

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

  234.         0x81, 0x02,                             // Input

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

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

  237.         0x91, 0x02,                             // Output

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

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

  240.         0xB1, 0x02,                             // Feature

  241.         0xC0                                    // end collection

  242. };

  243. 

  244. 

  245. 

  246. #define KEYBOARD_HID_DESC_OFFSET	( 9 + 9 )

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

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

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

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

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

  252. 

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

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

  255. 	9, 					// bLength;

  256. 	2,					// bDescriptorType;

  257. 	LSB(CONFIG1_DESC_SIZE),			// wTotalLength

  258. 	MSB(CONFIG1_DESC_SIZE),

  259. 	NUM_INTERFACE,				// bNumInterfaces

  260. 	1,					// bConfigurationValue

  261. 	0,					// iConfiguration

  262. 	0xC0,					// bmAttributes

  263. 	50,					// bMaxPower

  264. 

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

  266.         9,                                      // bLength

  267.         4,                                      // bDescriptorType

  268.         KEYBOARD_INTERFACE,                     // bInterfaceNumber

  269.         0,                                      // bAlternateSetting

  270.         1,                                      // bNumEndpoints

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

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

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

  274.         0,                                      // iInterface

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

  276.         9,                                      // bLength

  277.         0x21,                                   // bDescriptorType

  278.         0x11, 0x01,                             // bcdHID

  279.         0,                                      // bCountryCode

  280.         1,                                      // bNumDescriptors

  281.         0x22,                                   // bDescriptorType

  282.         sizeof(keyboard_hid_report_desc),       // wDescriptorLength

  283.         0,

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

  285.         7,                                      // bLength

  286.         5,                                      // bDescriptorType

  287.         KEYBOARD_ENDPOINT | 0x80,               // bEndpointAddress

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

  289.         KEYBOARD_SIZE, 0,                       // wMaxPacketSize

  290.         KEYBOARD_INTERVAL,                      // bInterval

  291. 

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

  293.         9,                                      // bLength

  294.         4,                                      // bDescriptorType

  295.         MOUSE_INTERFACE,                        // bInterfaceNumber

  296.         0,                                      // bAlternateSetting

  297.         1,                                      // bNumEndpoints

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

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

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

  301.         0,                                      // iInterface

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

  303.         9,                                      // bLength

  304.         0x21,                                   // bDescriptorType

  305.         0x11, 0x01,                             // bcdHID

  306.         0,                                      // bCountryCode

  307.         1,                                      // bNumDescriptors

  308.         0x22,                                   // bDescriptorType

  309.         sizeof(mouse_hid_report_desc),          // wDescriptorLength

  310.         0,

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

  312.         7,                                      // bLength

  313.         5,                                      // bDescriptorType

  314.         MOUSE_ENDPOINT | 0x80,                  // bEndpointAddress

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

  316.         MOUSE_SIZE, 0,                          // wMaxPacketSize

  317.         MOUSE_INTERVAL,                         // bInterval

  318. 

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

  320.         9,                                      // bLength

  321.         4,                                      // bDescriptorType

  322.         DEBUG_INTERFACE,                        // bInterfaceNumber

  323.         0,                                      // bAlternateSetting

  324.         2,                                      // bNumEndpoints

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

  326.         0x00,                                   // bInterfaceSubClass

  327.         0x00,                                   // bInterfaceProtocol

  328.         0,                                      // iInterface

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

  330.         9,                                      // bLength

  331.         0x21,                                   // bDescriptorType

  332.         0x11, 0x01,                             // bcdHID

  333.         0,                                      // bCountryCode

  334.         1,                                      // bNumDescriptors

  335.         0x22,                                   // bDescriptorType

  336.         sizeof(debug_hid_report_desc),          // wDescriptorLength

  337.         0,

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

  339.         7,                                      // bLength

  340.         5,                                      // bDescriptorType

  341.         DEBUG_TX_ENDPOINT | 0x80,               // bEndpointAddress

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

  343.         DEBUG_TX_SIZE, 0,                       // wMaxPacketSize

  344.         DEBUG_TX_INTERVAL,                      // bInterval

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

  346.         7,                                      // bLength

  347.         5,                                      // bDescriptorType

  348.         DEBUG_RX_ENDPOINT,                      // bEndpointAddress

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

  350.         DEBUG_RX_SIZE, 0,                       // wMaxPacketSize

  351.         DEBUG_RX_INTERVAL,                      // bInterval

  352. 

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

  354.         9,                                      // bLength

  355.         4,                                      // bDescriptorType

  356.         JOYSTICK_INTERFACE,                     // bInterfaceNumber

  357.         0,                                      // bAlternateSetting

  358.         1,                                      // bNumEndpoints

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

  360.         0x00,                                   // bInterfaceSubClass

  361.         0x00,                                   // bInterfaceProtocol

  362.         0,                                      // iInterface

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

  364.         9,                                      // bLength

  365.         0x21,                                   // bDescriptorType

  366.         0x11, 0x01,                             // bcdHID

  367.         0,                                      // bCountryCode

  368.         1,                                      // bNumDescriptors

  369.         0x22,                                   // bDescriptorType

  370.         sizeof(joystick_hid_report_desc),       // wDescriptorLength

  371.         0,

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

  373.         7,                                      // bLength

  374.         5,                                      // bDescriptorType

  375.         JOYSTICK_ENDPOINT | 0x80,               // bEndpointAddress

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

  377.         12, 0,					// wMaxPacketSize

  378.         JOYSTICK_INTERVAL,                      // bInterval

  379. 

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

  381.         9,                                      // bLength

  382.         4,                                      // bDescriptorType

  383.         KEYMEDIA_INTERFACE,                     // bInterfaceNumber

  384.         0,                                      // bAlternateSetting

  385.         1,                                      // bNumEndpoints

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

  387.         0x00,                                   // bInterfaceSubClass

  388.         0x00,                                   // bInterfaceProtocol

  389.         0,                                      // iInterface

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

  391.         9,                                      // bLength

  392.         0x21,                                   // bDescriptorType

  393.         0x11, 0x01,                             // bcdHID

  394.         0,                                      // bCountryCode

  395.         1,                                      // bNumDescriptors

  396.         0x22,                                   // bDescriptorType

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

  398.         MSB(sizeof(keymedia_hid_report_desc)),

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

  400.         7,                                      // bLength

  401.         5,                                      // bDescriptorType

  402.         KEYMEDIA_ENDPOINT | 0x80,               // bEndpointAddress

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

  404.         KEYMEDIA_SIZE, 0,                       // wMaxPacketSize

  405.         KEYMEDIA_INTERVAL,                      // bInterval

  406. };

  407. 

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

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

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

  411. struct usb_string_descriptor_struct {

  412. 	uint8_t bLength;

  413. 	uint8_t bDescriptorType;

  414. 	int16_t wString[];

  415. };

  416. static const struct usb_string_descriptor_struct PROGMEM string0 = {

  417. 	4,

  418. 	3,

  419. 	{0x0409}

  420. };

  421. static const struct usb_string_descriptor_struct PROGMEM string1 = {

  422. 	sizeof(STR_PRODUCT),

  423. 	3,

  424. 	STR_PRODUCT

  425. };

  426. 

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

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

  429. static const struct descriptor_list_struct {

  430. 	uint16_t	wValue;

  431. 	uint16_t	wIndex;

  432. 	const uint8_t	*addr;

  433. 	uint8_t		length;

  434. } PROGMEM descriptor_list[] = {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  449. };

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

  451. 

  452. 

  453. /**************************************************************************

  454.  *

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

  456.  *

  457.  **************************************************************************/

  458. 

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

  460. volatile uint8_t usb_configuration USBSTATE;

  461. volatile uint8_t usb_suspended USBSTATE;

  462. 

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

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

  465. volatile uint8_t debug_flush_timer USBSTATE;

  466. 

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

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

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

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

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

  472. uint8_t keyboard_report_data[8] USBSTATE;

  473. 

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

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

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

  477. static uint8_t keyboard_protocol USBSTATE;

  478. 

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

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

  481. static uint8_t keyboard_idle_config USBSTATE;

  482. 

  483. // count until idle timeout

  484. uint8_t keyboard_idle_count USBSTATE;

  485. 

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

  487. volatile uint8_t keyboard_leds USBSTATE;

  488. 

  489. // which buttons are currently pressed

  490. uint8_t mouse_buttons USBSTATE;

  491. 

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

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

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

  495. static uint8_t mouse_protocol USBSTATE;

  496. 

  497. // joystick data

  498. uint8_t joystick_report_data[12] USBSTATE;

  499. 

  500. // keyboard media keys data

  501. uint8_t keymedia_report_data[8] USBSTATE;

  502. uint16_t keymedia_consumer_keys[4] USBSTATE;

  503. uint8_t keymedia_system_keys[3] USBSTATE;

  504. 

  505. 

  506. 

  507. /**************************************************************************

  508.  *

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

  510.  *

  511.  **************************************************************************/

  512. 

  513. 

  514. 

  515. // initialize USB serial

  516. void usb_init(void)

  517. {

  518. 	uint8_t u;

  519. 

  520. 	u = USBCON;

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

  522. 	HW_CONFIG();

  523.         USB_FREEZE();				// enable USB

  524.         PLL_CONFIG();				// config PLL

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

  526.         USB_CONFIG();				// start USB clock

  527.         UDCON = 0;				// enable attach resistor

  528. 	usb_configuration = 0;

  529. 	usb_suspended = 0;

  530. 	debug_flush_timer = 0;

  531. 	keyboard_report_data[0] = 0;

  532. 	keyboard_report_data[1] = 0;

  533. 	keyboard_report_data[2] = 0;

  534. 	keyboard_report_data[3] = 0;

  535. 	keyboard_report_data[4] = 0;

  536. 	keyboard_report_data[5] = 0;

  537. 	keyboard_report_data[6] = 0;

  538. 	keyboard_report_data[7] = 0;

  539. 	keyboard_protocol = 1;

  540. 	keyboard_idle_config = 125;

  541. 	keyboard_idle_count = 0;

  542. 	keyboard_leds = 0;

  543. 	mouse_buttons = 0;

  544. 	mouse_protocol = 1;

  545. 	joystick_report_data[0] = 0;

  546. 	joystick_report_data[1] = 0;

  547. 	joystick_report_data[2] = 0;

  548. 	joystick_report_data[3] = 0;

  549. 	joystick_report_data[4] =  0x0F;

  550. 	joystick_report_data[5] =  0x20;

  551. 	joystick_report_data[6] =  0x80;

  552. 	joystick_report_data[7] =  0x00;

  553. 	joystick_report_data[8] =  0x02;

  554. 	joystick_report_data[9] =  0x08;

  555. 	joystick_report_data[10] = 0x20;

  556. 	joystick_report_data[11] = 0x80;

  557. 	keymedia_report_data[0] = 0;

  558. 	keymedia_report_data[1] = 0;

  559. 	keymedia_report_data[2] = 0;

  560. 	keymedia_report_data[3] = 0;

  561. 	keymedia_report_data[4] = 0;

  562. 	keymedia_report_data[5] = 0;

  563. 	keymedia_report_data[6] = 0;

  564. 	keymedia_report_data[7] = 0;

  565. 	keymedia_consumer_keys[0] = 0;

  566. 	keymedia_consumer_keys[1] = 0;

  567. 	keymedia_consumer_keys[2] = 0;

  568. 	keymedia_consumer_keys[3] = 0;

  569. 	keymedia_system_keys[0] = 0;

  570. 	keymedia_system_keys[1] = 0;

  571. 	keymedia_system_keys[2] = 0;

  572. 	UDINT = 0;

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

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

  575. }

  576. 

  577. void usb_shutdown(void)

  578. {

  579. 	UDIEN = 0;		// disable interrupts

  580. 	UDCON = 1;		// disconnect attach resistor

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

  582. 	PLLCSR = 0;		// shut off PLL

  583. 	usb_configuration = 0;

  584. 	usb_suspended = 1;

  585. }

  586. 

  587. 

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

  589. 

  590. /**************************************************************************

  591.  *

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

  593.  *

  594.  **************************************************************************/

  595. 

  596. 

  597. 

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

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

  600. //

  601. ISR(USB_GEN_vect)

  602. {

  603. 	uint8_t intbits, t, i;

  604. 	static uint8_t div4=0;

  605. 

  606.         intbits = UDINT;

  607.         UDINT = 0;

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

  609. 		UENUM = 0;

  610. 		UECONX = 1;

  611. 		UECFG0X = EP_TYPE_CONTROL;

  612. 		UECFG1X = EP_SIZE(ENDPOINT0_SIZE) | EP_SINGLE_BUFFER;

  613. 		UEIENX = (1<<RXSTPE);

  614. 		usb_configuration = 0;

  615.         }

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

  617.                 t = debug_flush_timer;

  618.                 if (t) {

  619.                         debug_flush_timer = -- t;

  620.                         if (!t) {

  621.                                 UENUM = DEBUG_TX_ENDPOINT;

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

  623.                                         UEDATX = 0;

  624.                                 }

  625.                                 UEINTX = 0x3A;

  626.                         }

  627.                 }

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

  629.                         UENUM = KEYBOARD_ENDPOINT;

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

  631.                                 keyboard_idle_count++;

  632.                                 if (keyboard_idle_count == keyboard_idle_config) {

  633.                                         keyboard_idle_count = 0;

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

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

  636.                                                 UEDATX = keyboard_report_data[i];

  637.                                         }

  638.                                         UEINTX = 0x3A;

  639.                                 }

  640.                         }

  641.                 }

  642.         }

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

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

  645. 		UDIEN = (1<<WAKEUPE);

  646. 		usb_configuration = 0;

  647. 		usb_suspended = 1;

  648. 		#if (F_CPU >= 8000000L)

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

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

  651. 		// Is this a hardware bug?

  652. 		USB_FREEZE();			// shut off USB

  653. 		PLLCSR = 0;			// shut off PLL

  654. 		#endif

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

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

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

  658. 		// user's paradigm....

  659. 	}

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

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

  662. 		#if (F_CPU >= 8000000L)

  663. 		PLL_CONFIG();

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

  665. 		USB_CONFIG();

  666. 		#endif

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

  668. 		usb_suspended = 0;

  669. 		return;

  670. 	}

  671. }

  672. 

  673. 

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

  675. static inline void usb_wait_in_ready(void)

  676. {

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

  678. }

  679. static inline void usb_send_in(void)

  680. {

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

  682. }

  683. static inline void usb_wait_receive_out(void)

  684. {

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

  686. }

  687. static inline void usb_ack_out(void)

  688. {

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

  690. }

  691. 

  692. 

  693. 

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

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

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

  697. //

  698. ISR(USB_COM_vect)

  699. {

  700.         uint8_t intbits;

  701. 	const uint8_t *list;

  702.         const uint8_t *cfg;

  703. 	uint8_t i, n, len;

  704. 	uint8_t bmRequestType;

  705. 	uint8_t bRequest;

  706. 	uint16_t wValue;

  707. 	uint16_t wIndex;

  708. 	uint16_t wLength;

  709. 	uint16_t desc_val;

  710. 	const uint8_t *desc_addr;

  711. 	uint8_t	desc_length;

  712. 

  713. 	UENUM = 0;

  714. 	intbits = UEINTX;

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

  716. 		bmRequestType = UEDATX;

  717. 		bRequest = UEDATX;

  718. 		read_word_lsbfirst(wValue, UEDATX);

  719. 		read_word_lsbfirst(wIndex, UEDATX);

  720. 		read_word_lsbfirst(wLength, UEDATX);

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

  722. 		if (bRequest == GET_DESCRIPTOR) {

  723. 			list = (const uint8_t *)descriptor_list;

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

  725. 				if (i >= NUM_DESC_LIST) {

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

  727. 					return;

  728. 				}

  729. 				pgm_read_word_postinc(desc_val, list);

  730. 				if (desc_val != wValue) {

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

  732. 					continue;

  733. 				}

  734. 				pgm_read_word_postinc(desc_val, list);

  735. 				if (desc_val != wIndex) {

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

  737. 					continue;

  738. 				}

  739. 				pgm_read_word_postinc(desc_addr, list);

  740. 				desc_length = pgm_read_byte(list);

  741. 				break;

  742. 			}

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

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

  745. 			list = desc_addr;

  746. 			do {

  747. 				// wait for host ready for IN packet

  748. 				do {

  749. 					i = UEINTX;

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

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

  752. 				// send IN packet

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

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

  755. 					pgm_read_byte_postinc(UEDATX, list);

  756. 				}

  757. 				len -= n;

  758. 				usb_send_in();

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

  760. 			return;

  761.                 }

  762. 		if (bRequest == SET_ADDRESS) {

  763. 			usb_send_in();

  764. 			usb_wait_in_ready();

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

  766. 			return;

  767. 		}

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

  769. 			usb_configuration = wValue;

  770. 			debug_flush_timer = 0;

  771. 			usb_send_in();

  772. 			cfg = endpoint_config_table;

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

  774. 				UENUM = i;

  775. 				UECONX = 1;

  776. 				pgm_read_byte_postinc(UECFG0X, cfg);

  777. 				pgm_read_byte_postinc(UECFG1X, cfg);

  778. 			}

  779.         		UERST = 0x1E;

  780.         		UERST = 0;

  781. 			return;

  782. 		}

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

  784. 			usb_wait_in_ready();

  785. 			UEDATX = usb_configuration;

  786. 			usb_send_in();

  787. 			return;

  788. 		}

  789. 		if (bRequest == GET_STATUS) {

  790. 			usb_wait_in_ready();

  791. 			i = 0;

  792. 			if (bmRequestType == 0x82) {

  793. 				UENUM = wIndex;

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

  795. 				UENUM = 0;

  796. 			}

  797. 			UEDATX = i;

  798. 			UEDATX = 0;

  799. 			usb_send_in();

  800. 			return;

  801. 		}

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

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

  804. 			i = wIndex & 0x7F;

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

  806. 				usb_send_in();

  807. 				UENUM = i;

  808. 				if (bRequest == SET_FEATURE) {

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

  810. 				} else {

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

  812. 					UERST = (1 << i);

  813. 					UERST = 0;

  814. 				}

  815. 				return;

  816. 			}

  817. 		}

  818.                 if (wIndex == KEYBOARD_INTERFACE) {

  819.                         if (bmRequestType == 0xA1) {

  820.                                 if (bRequest == HID_GET_REPORT) {

  821.                                         usb_wait_in_ready();

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

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

  824.                                                 UEDATX = keyboard_report_data[i];

  825.                                         }

  826.                                         usb_send_in();

  827.                                         return;

  828.                                 }

  829.                                 if (bRequest == HID_GET_IDLE) {

  830.                                         usb_wait_in_ready();

  831.                                         UEDATX = keyboard_idle_config;

  832.                                         usb_send_in();

  833.                                         return;

  834.                                 }

  835.                                 if (bRequest == HID_GET_PROTOCOL) {

  836.                                         usb_wait_in_ready();

  837.                                         UEDATX = keyboard_protocol;

  838.                                         usb_send_in();

  839.                                         return;

  840.                                 }

  841.                         }

  842.                         if (bmRequestType == 0x21) {

  843.                                 if (bRequest == HID_SET_REPORT) {

  844.                                         usb_wait_receive_out();

  845.                                         keyboard_leds = UEDATX;

  846.                                         usb_ack_out();

  847.                                         usb_send_in();

  848.                                         return;

  849.                                 }

  850.                                 if (bRequest == HID_SET_IDLE) {

  851.                                         keyboard_idle_config = (wValue >> 8);

  852.                                         keyboard_idle_count = 0;

  853.                                         //usb_wait_in_ready();

  854.                                         usb_send_in();

  855.                                         return;

  856.                                 }

  857.                                 if (bRequest == HID_SET_PROTOCOL) {

  858.                                         keyboard_protocol = wValue;

  859.                                         //usb_wait_in_ready();

  860.                                         usb_send_in();

  861.                                         return;

  862.                                 }

  863.                         }

  864.                 }

  865.                 if (wIndex == MOUSE_INTERFACE) {

  866.                         if (bmRequestType == 0xA1) {

  867.                                 if (bRequest == HID_GET_REPORT) {

  868.                                         usb_wait_in_ready();

  869.                                         UEDATX = mouse_buttons;

  870.                                         UEDATX = 0;

  871.                                         UEDATX = 0;

  872.                                         UEDATX = 0;

  873.                                         UEDATX = 0;

  874.                                         usb_send_in();

  875.                                         return;

  876.                                 }

  877.                                 if (bRequest == HID_GET_PROTOCOL) {

  878.                                         usb_wait_in_ready();

  879.                                         UEDATX = mouse_protocol;

  880.                                         usb_send_in();

  881.                                         return;

  882.                                 }

  883.                         }

  884.                         if (bmRequestType == 0x21) {

  885.                                 if (bRequest == HID_SET_PROTOCOL) {

  886.                                         mouse_protocol = wValue;

  887.                                         usb_send_in();

  888.                                         return;

  889.                                 }

  890.                         }

  891.                 }

  892.                 if (wIndex == JOYSTICK_INTERFACE) {

  893.                         if (bmRequestType == 0xA1) {

  894.                                 if (bRequest == HID_GET_REPORT) {

  895.                                         usb_wait_in_ready();

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

  897. 						UEDATX = joystick_report_data[i];

  898. 					}

  899.                                         usb_send_in();

  900.                                         return;

  901. 				}

  902. 			}

  903. 		}

  904.                 if (wIndex == KEYMEDIA_INTERFACE) {

  905.                         if (bmRequestType == 0xA1) {

  906.                                 if (bRequest == HID_GET_REPORT) {

  907.                                         usb_wait_in_ready();

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

  909. 						UEDATX = keymedia_report_data[i];

  910. 					}

  911.                                         usb_send_in();

  912.                                         return;

  913. 				}

  914. 			}

  915. 		}

  916.                 if (wIndex == DEBUG_INTERFACE) {

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

  918.                                 len = wLength;

  919.                                 do {

  920.                                         // wait for host ready for IN packet

  921.                                         do {

  922.                                                 i = UEINTX;

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

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

  925.                                         // send IN packet

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

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

  928.                                                 UEDATX = 0;

  929.                                         }

  930.                                         len -= n;

  931.                                         usb_send_in();

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

  933.                                 return;

  934.                         }

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

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

  937. 					uint8_t b1, b2, b3, b4;

  938.                                         usb_wait_receive_out();

  939. 					b1 = UEDATX;

  940. 					b2 = UEDATX;

  941. 					b3 = UEDATX;

  942. 					b4 = UEDATX;

  943.                                         usb_ack_out();

  944.                                         usb_send_in();

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

  946. 						_reboot_Teensyduino_();

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

  948. 						_restart_Teensyduino_();

  949. 				}

  950. 			}

  951.                 }

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

  953. 			usb_send_in();

  954. 			usb_wait_in_ready();

  955. 			_restart_Teensyduino_();

  956. 		}

  957.         }

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

  959. }

  960.