1 /* USB Keyboard and CDC Serial Device for Teensy USB Development Board
2 * Copyright (c) 2009 PJRC.COM, LLC
3 * Modifications by Jacob Alexander (2011-2014)
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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
24 #ifndef usb_keyboard_serial_h__
25 #define usb_keyboard_serial_h__
27 // ----- Includes -----
34 #include <avr/pgmspace.h>
35 #include <avr/interrupt.h>
39 #include <util/delay.h>
42 #include "output_com.h"
46 // ----- Function Declarations -----
48 // Basic USB Configuration
49 void usb_init(); // initialize everything
50 uint8_t usb_configured(); // is the USB port configured
52 // Keyboard HID Functions
53 void usb_keyboard_send();
55 // Chip Level Functions
56 void usb_device_reload(); // Enable firmware reflash mode
58 // USB Serial CDC Functions
59 int16_t usb_serial_getchar(); // receive a character (-1 if timeout/error)
60 uint8_t usb_serial_available(); // number of bytes in receive buffer
61 void usb_serial_flush_input(); // discard any buffered input
64 int8_t usb_serial_putchar(uint8_t c); // transmit a character
65 int8_t usb_serial_putchar_nowait(uint8_t c); // transmit a character, do not wait
66 int8_t usb_serial_write(const char *buffer, uint16_t size); // transmit a buffer
67 void usb_serial_flush_output(); // immediately transmit any buffered output
70 uint32_t usb_serial_get_baud(); // get the baud rate
71 uint8_t usb_serial_get_stopbits(); // get the number of stop bits
72 uint8_t usb_serial_get_paritytype(); // get the parity type
73 uint8_t usb_serial_get_numbits(); // get the number of data bits
74 uint8_t usb_serial_get_control(); // get the RTS and DTR signal state
75 int8_t usb_serial_set_control(uint8_t signals); // set DSR, DCD, RI, etc
81 // Software reset the chip
82 #define usb_device_software_reset() do { wdt_enable( WDTO_15MS ); for(;;); } while(0)
84 // See EPSIZE -> UECFG1X - 128 and 256 bytes are for endpoint 1 only
85 #define EP_SIZE(s) ((s) == 256 ? 0x50 : \
86 ((s) == 128 ? 0x40 : \
92 #define LSB(n) (n & 255)
93 #define MSB(n) ((n >> 8) & 255)
97 // ----- Defines -----
99 // constants corresponding to the various serial parameters
100 #define USB_SERIAL_DTR 0x01
101 #define USB_SERIAL_RTS 0x02
102 #define USB_SERIAL_1_STOP 0
103 #define USB_SERIAL_1_5_STOP 1
104 #define USB_SERIAL_2_STOP 2
105 #define USB_SERIAL_PARITY_NONE 0
106 #define USB_SERIAL_PARITY_ODD 1
107 #define USB_SERIAL_PARITY_EVEN 2
108 #define USB_SERIAL_PARITY_MARK 3
109 #define USB_SERIAL_PARITY_SPACE 4
110 #define USB_SERIAL_DCD 0x01
111 #define USB_SERIAL_DSR 0x02
112 #define USB_SERIAL_BREAK 0x04
113 #define USB_SERIAL_RI 0x08
114 #define USB_SERIAL_FRAME_ERR 0x10
115 #define USB_SERIAL_PARITY_ERR 0x20
116 #define USB_SERIAL_OVERRUN_ERR 0x40
118 #define EP_TYPE_CONTROL 0x00
119 #define EP_TYPE_BULK_IN 0x81
120 #define EP_TYPE_BULK_OUT 0x80
121 #define EP_TYPE_INTERRUPT_IN 0xC1
122 #define EP_TYPE_INTERRUPT_OUT 0xC0
123 #define EP_TYPE_ISOCHRONOUS_IN 0x41
124 #define EP_TYPE_ISOCHRONOUS_OUT 0x40
126 #define EP_SINGLE_BUFFER 0x02
127 #define EP_DOUBLE_BUFFER 0x06
129 #define MAX_ENDPOINT 4
131 #if defined(__AVR_AT90USB162__)
133 #define PLL_CONFIG() (PLLCSR = ((1<<PLLE)|(1<<PLLP0)))
134 #define USB_CONFIG() (USBCON = (1<<USBE))
135 #define USB_FREEZE() (USBCON = ((1<<USBE)|(1<<FRZCLK)))
137 #elif defined(__AVR_ATmega32U4__)
138 #define HW_CONFIG() (UHWCON = 0x01)
139 #define PLL_CONFIG() (PLLCSR = 0x12)
140 #define USB_CONFIG() (USBCON = ((1<<USBE)|(1<<OTGPADE)))
141 #define USB_FREEZE() (USBCON = ((1<<USBE)|(1<<FRZCLK)))
143 #elif defined(__AVR_AT90USB646__)
144 #define HW_CONFIG() (UHWCON = 0x81)
145 #define PLL_CONFIG() (PLLCSR = 0x1A)
146 #define USB_CONFIG() (USBCON = ((1<<USBE)|(1<<OTGPADE)))
147 #define USB_FREEZE() (USBCON = ((1<<USBE)|(1<<FRZCLK)))
149 #elif defined(__AVR_AT90USB1286__)
150 #define HW_CONFIG() (UHWCON = 0x81)
151 #define PLL_CONFIG() (PLLCSR = 0x16)
152 #define USB_CONFIG() (USBCON = ((1<<USBE)|(1<<OTGPADE)))
153 #define USB_FREEZE() (USBCON = ((1<<USBE)|(1<<FRZCLK)))
156 // standard control endpoint request types
158 #define CLEAR_FEATURE 1
159 #define SET_FEATURE 3
160 #define SET_ADDRESS 5
161 #define GET_DESCRIPTOR 6
162 #define GET_CONFIGURATION 8
163 #define SET_CONFIGURATION 9
164 #define GET_INTERFACE 10
165 #define SET_INTERFACE 11
167 // HID (human interface device)
168 #define HID_GET_REPORT 1
169 #define HID_GET_IDLE 2
170 #define HID_GET_PROTOCOL 3
171 #define HID_SET_REPORT 9
172 #define HID_SET_IDLE 10
173 #define HID_SET_PROTOCOL 11
175 // CDC (communication class device)
176 #define CDC_SET_LINE_CODING 0x20
177 #define CDC_GET_LINE_CODING 0x21
178 #define CDC_SET_CONTROL_LINE_STATE 0x22
181 // When you write data, it goes into a USB endpoint buffer, which
182 // is transmitted to the PC when it becomes full, or after a timeout
183 // with no more writes. Even if you write in exactly packet-size
184 // increments, this timeout is used to send a "zero length packet"
185 // that tells the PC no more data is expected and it should pass
186 // any buffered data to the application that may be waiting. If
187 // you want data sent immediately, call usb_serial_flush_output().
188 #define TRANSMIT_FLUSH_TIMEOUT 5 /* in milliseconds */
190 // If the PC is connected but not "listening", this is the length
191 // of time before usb_serial_getchar() returns with an error. This
192 // is roughly equivilant to a real UART simply transmitting the
193 // bits on a wire where nobody is listening, except you get an error
194 // code which you can ignore for serial-like discard of data, or
195 // use to know your data wasn't sent.
196 #define TRANSMIT_TIMEOUT 25 /* in milliseconds */
200 // ----- Endpoint Configuration -----
202 #define ENDPOINT0_SIZE 32
204 #define KEYBOARD_NKRO_INTERFACE 0
205 #define KEYBOARD_NKRO_ENDPOINT 1
206 #define KEYBOARD_NKRO_SIZE 64
207 #define KEYBOARD_NKRO_HID_BUFFER EP_DOUBLE_BUFFER
209 #define KEYBOARD_INTERFACE 1
210 #define KEYBOARD_ENDPOINT 2
211 #define KEYBOARD_SIZE 8
212 #define KEYBOARD_HID_BUFFER EP_DOUBLE_BUFFER
214 #define CDC_IAD_DESCRIPTOR 1
215 #define CDC_STATUS_INTERFACE 2
216 #define CDC_DATA_INTERFACE 3
217 #define CDC_ACM_ENDPOINT 3
218 #define CDC_RX_ENDPOINT 4
219 #define CDC_TX_ENDPOINT 5
220 #if defined(__AVR_AT90USB162__)
221 #define CDC_ACM_SIZE 16
222 #define CDC_ACM_BUFFER EP_SINGLE_BUFFER
223 #define CDC_RX_SIZE 32
224 #define CDC_RX_BUFFER EP_DOUBLE_BUFFER
225 #define CDC_TX_SIZE 32
226 #define CDC_TX_BUFFER EP_DOUBLE_BUFFER
228 #define CDC_ACM_SIZE 16
229 #define CDC_ACM_BUFFER EP_SINGLE_BUFFER
230 #define CDC_RX_SIZE 64
231 #define CDC_RX_BUFFER EP_DOUBLE_BUFFER
232 #define CDC_TX_SIZE 64
233 #define CDC_TX_BUFFER EP_DOUBLE_BUFFER
236 // Endpoint 0 is reserved for the control endpoint
237 // Endpoint 1 has a 256 byte buffer
238 // Endpoints 2-6 have 64 byte buffers
239 static const uint8_t PROGMEM endpoint_config_table[] = {
240 1, EP_TYPE_INTERRUPT_IN, EP_SIZE(KEYBOARD_NKRO_SIZE) | KEYBOARD_NKRO_HID_BUFFER, // 256 byte
241 1, EP_TYPE_INTERRUPT_IN, EP_SIZE(KEYBOARD_SIZE) | KEYBOARD_HID_BUFFER, // 64 byte
242 1, EP_TYPE_INTERRUPT_IN, EP_SIZE(CDC_ACM_SIZE) | CDC_ACM_BUFFER, // 64 byte
243 1, EP_TYPE_BULK_OUT, EP_SIZE(CDC_RX_SIZE) | CDC_RX_BUFFER, // 64 byte
244 1, EP_TYPE_BULK_IN, EP_SIZE(CDC_TX_SIZE) | CDC_TX_BUFFER, // 64 byte
250 // ----- Descriptor Configuration -----
252 // Descriptors are the data that your computer reads when it auto-detects
253 // this USB device (called "enumeration" in USB lingo). The most commonly
254 // changed items are editable at the top of this file. Changing things
255 // in here should only be done by those who've read chapter 9 of the USB
256 // spec and relevant portions of any USB class specifications!
259 static const uint8_t PROGMEM device_descriptor[] = {
261 1, // bDescriptorType
262 0x00, 0x02, // bcdUSB
263 0x00, // bDeviceClass - Composite device, 0x00 is required for Windows
264 0, // bDeviceSubClass
265 0, // bDeviceProtocol
266 ENDPOINT0_SIZE, // bMaxPacketSize0
267 LSB(VENDOR_ID), MSB(VENDOR_ID), // idVendor
268 LSB(PRODUCT_ID), MSB(PRODUCT_ID), // idProduct
269 0x00, 0x01, // bcdDevice
273 1 // bNumConfigurations
276 // Specify only a single USB speed
277 static const uint8_t PROGMEM device_qualifier_descriptor[] = {
281 // Disable USB debug descriptor
282 static const uint8_t PROGMEM usb_debug_descriptor[] = {
286 // Keyboard Protocol 1, HID 1.11 spec, Appendix B, page 59-60
287 static const uint8_t PROGMEM keyboard_hid_report_desc[] = {
288 // Keyboard Collection
289 0x05, 0x01, // Usage Page (Generic Desktop),
290 0x09, 0x06, // Usage (Keyboard),
291 0xA1, 0x01, // Collection (Application) - Keyboard,
294 0x75, 0x01, // Report Size (1),
295 0x95, 0x08, // Report Count (8),
296 0x05, 0x07, // Usage Page (Key Codes),
297 0x19, 0xE0, // Usage Minimum (224),
298 0x29, 0xE7, // Usage Maximum (231),
299 0x15, 0x00, // Logical Minimum (0),
300 0x25, 0x01, // Logical Maximum (1),
301 0x81, 0x02, // Input (Data, Variable, Absolute),
304 0x75, 0x08, // Report Size (8),
305 0x95, 0x01, // Report Count (1),
306 0x81, 0x03, // Output (Constant),
309 0x75, 0x01, // Report Size (1),
310 0x95, 0x05, // Report Count (5),
311 0x05, 0x08, // Usage Page (LEDs),
312 0x19, 0x01, // Usage Minimum (1),
313 0x29, 0x05, // Usage Maximum (5),
314 0x91, 0x02, // Output (Data, Variable, Absolute),
316 // LED Report Padding
317 0x75, 0x03, // Report Size (3),
318 0x95, 0x01, // Report Count (1),
319 0x91, 0x03, // Output (Constant),
322 0x75, 0x08, // Report Size (8),
323 0x95, 0x06, // Report Count (6),
324 0x15, 0x00, // Logical Minimum (0),
325 0x25, 0x7F, // Logical Maximum(104),
326 0x05, 0x07, // Usage Page (Key Codes),
327 0x19, 0x00, // Usage Minimum (0),
328 0x29, 0x7F, // Usage Maximum (104),
329 0x81, 0x00, // Input (Data, Array),
330 0xc0, // End Collection - Keyboard
333 // Keyboard Protocol 1, HID 1.11 spec, Appendix B, page 59-60
334 static const uint8_t PROGMEM keyboard_nkro_hid_report_desc[] = {
335 // Keyboard Collection
336 0x05, 0x01, // Usage Page (Generic Desktop),
337 0x09, 0x06, // Usage (Keyboard),
338 0xA1, 0x01, // Collection (Application) - Keyboard,
341 0x85, 0x01, // Report ID (1),
342 0x75, 0x01, // Report Size (1),
343 0x95, 0x08, // Report Count (8),
344 0x15, 0x00, // Logical Minimum (0),
345 0x25, 0x01, // Logical Maximum (1),
346 0x05, 0x07, // Usage Page (Key Codes),
347 0x19, 0xE0, // Usage Minimum (224),
348 0x29, 0xE7, // Usage Maximum (231),
349 0x81, 0x02, // Input (Data, Variable, Absolute),
352 0x85, 0x02, // Report ID (2),
353 0x75, 0x01, // Report Size (1),
354 0x95, 0x05, // Report Count (5),
355 0x05, 0x08, // Usage Page (LEDs),
356 0x19, 0x01, // Usage Minimum (1),
357 0x29, 0x05, // Usage Maximum (5),
358 0x91, 0x02, // Output (Data, Variable, Absolute),
360 // LED Report Padding
361 0x75, 0x03, // Report Size (3),
362 0x95, 0x01, // Report Count (1),
363 0x91, 0x03, // Output (Constant),
365 // Normal Keys - Using an NKRO Bitmap
368 // Supports all keys defined by the spec, except 1-3 which define error events
369 // and 0 which is "no keys pressed"
370 // See http://www.usb.org/developers/hidpage/Hut1_12v2.pdf Chapter 10
371 // Or Macros/PartialMap/usb_hid.h
373 // 50 (ISO \ due to \ bug) and 156 (Clear due to Delete bug) must be excluded
374 // due to a Linux bug with bitmaps (not useful anyways)
375 // 165-175 are reserved/unused as well as 222-223 and 232-65535
376 // 224-231 are used for modifiers (see above)
378 // Compatibility Notes:
379 // - Using a second endpoint for a boot mode device helps with compatibility
380 // - DO NOT use Padding in the descriptor for bitfields
381 // (Mac OSX silently fails... Windows/Linux work correctly)
383 // Packing of bitmaps are as follows:
384 // 4-49 : 6 bytes + 1 Report ID byte (0x04-0x31) ( 46 bits + 2 padding bits for 6 bytes total)
385 // 51-155 : 14 bytes + 1 Report ID byte (0x33-0x9B) (105 bits + 6 padding bits for 15 bytes total)
386 // 157-164 : 1 byte + 1 Report ID byte (0x9D-0xA4) ( 8 bits)
387 // 176-221 : 6 bytes + 1 Report ID byte (0xB0-0xDD) ( 46 bits + 2 padding bits for 6 bytes total)
389 // 4-49 (6 bytes/46 bits) - MainKeys
390 0x85, 0x03, // Report ID (3),
391 0x75, 0x01, // Report Size (1),
392 0x95, 0x2E, // Report Count (46),
393 0x15, 0x00, // Logical Minimum (0),
394 0x25, 0x01, // Logical Maximum (1),
395 0x05, 0x07, // Usage Page (Key Codes),
396 0x19, 0x04, // Usage Minimum (4),
397 0x29, 0x31, // Usage Maximum (49),
398 0x81, 0x02, // Input (Data, Variable, Absolute, Bitfield),
400 // Should pad 2 bits according to the spec, but OSX doesn't like this -HaaTa
402 // 51-155 (14 bytes/105 bits) - SecondaryKeys
403 0x85, 0x04, // Report ID (4),
404 0x75, 0x01, // Report Size (1),
405 0x95, 0x69, // Report Count (105),
406 0x15, 0x00, // Logical Minimum (0),
407 0x25, 0x01, // Logical Maximum (1),
408 0x05, 0x07, // Usage Page (Key Codes),
409 0x19, 0x33, // Usage Minimum (51),
410 0x29, 0x9B, // Usage Maximum (155),
411 0x81, 0x02, // Input (Data, Variable, Absolute, Bitfield),
413 // Should pad 6 bits according to the spec, but OSX doesn't like this -HaaTa
415 // 157-164 (1 byte/8 bits) - TertiaryKeys
416 0x85, 0x05, // Report ID (5),
417 0x75, 0x01, // Report Size (1),
418 0x95, 0x08, // Report Count (8),
419 0x15, 0x00, // Logical Minimum (0),
420 0x25, 0x01, // Logical Maximum (1),
421 0x05, 0x07, // Usage Page (Key Codes),
422 0x19, 0x9D, // Usage Minimum (157),
423 0x29, 0xA4, // Usage Maximum (164),
424 0x81, 0x02, // Input (Data, Variable, Absolute, Bitfield),
426 // 176-221 (6 bytes/46 bits) - QuartiaryKeys
427 0x85, 0x06, // Report ID (6),
428 0x75, 0x01, // Report Size (1),
429 0x95, 0x2D, // Report Count (45),
430 0x15, 0x00, // Logical Minimum (0),
431 0x25, 0x01, // Logical Maximum (1),
432 0x05, 0x07, // Usage Page (Key Codes),
433 0x19, 0xB0, // Usage Minimum (176),
434 0x29, 0xDD, // Usage Maximum (221),
435 0x81, 0x02, // Input (Data, Variable, Absolute, Bitfield),
437 // Should pad 2 bits according to the spec, but OSX doesn't like this -HaaTa
439 0xc0, // End Collection - Keyboard
441 // System Control Collection
444 // Not bothering with NKRO for this table. If there's need, I can implement it. -HaaTa
445 // Using a 1KRO scheme
446 0x05, 0x01, // Usage Page (Generic Desktop),
447 0x09, 0x80, // Usage (System Control),
448 0xA1, 0x01, // Collection (Application),
449 0x85, 0x07, // Report ID (7),
450 0x75, 0x08, // Report Size (8),
451 0x95, 0x01, // Report Count (1),
452 0x16, 0x81, 0x00, // Logical Minimum (129),
453 0x26, 0xB7, 0x00, // Logical Maximum (183),
454 0x19, 0x81, // Usage Minimum (129),
455 0x29, 0xB7, // Usage Maximum (183),
456 0x81, 0x00, // Input (Data, Array),
457 0xc0, // End Collection - System Control
459 // Consumer Control Collection - Media Keys
462 // Not bothering with NKRO for this table. If there's a need, I can implement it. -HaaTa
463 // Using a 1KRO scheme
464 0x05, 0x0c, // Usage Page (Consumer),
465 0x09, 0x01, // Usage (Consumer Control),
466 0xA1, 0x01, // Collection (Application),
467 0x85, 0x08, // Report ID (8),
468 0x75, 0x10, // Report Size (16),
469 0x95, 0x01, // Report Count (1),
470 0x16, 0x20, 0x00, // Logical Minimum (32),
471 0x26, 0x9C, 0x02, // Logical Maximum (668),
472 0x05, 0x0C, // Usage Page (Consumer),
473 0x19, 0x20, // Usage Minimum (32),
474 0x2A, 0x9C, 0x02, // Usage Maximum (668),
475 0x81, 0x00, // Input (Data, Array),
476 0xc0, // End Collection - Consumer Control
479 // <Configuration> + <Keyboard HID> + <NKRO Keyboard HID> + <Serial CDC>
480 #define CONFIG1_DESC_SIZE (9 + 9+9+7 + 9+9+7 + 8+9+5+5+4+5+7+9+7+7)
481 #define KEYBOARD_HID_DESC_OFFSET (9 + 9)
482 #define KEYBOARD_NKRO_HID_DESC_OFFSET (9 + 9+9+7 + 9)
483 #define SERIAL_CDC_DESC_OFFSET (9 + 9+9+7 + 9+9+7)
484 static const uint8_t PROGMEM config1_descriptor[CONFIG1_DESC_SIZE] = {
485 // --- Configuration ---
487 // configuration descriptor, USB spec 9.6.3, page 264-266, Table 9-10
489 2, // bDescriptorType;
490 LSB(CONFIG1_DESC_SIZE), // wTotalLength
491 MSB(CONFIG1_DESC_SIZE),
493 1, // bConfigurationValue
495 0x80, // bmAttributes
498 // --- Keyboard HID ---
500 // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
502 4, // bDescriptorType
503 KEYBOARD_INTERFACE, // bInterfaceNumber
504 0, // bAlternateSetting
506 0x03, // bInterfaceClass (0x03 = HID)
507 0x01, // bInterfaceSubClass (0x00 = Non-Boot, 0x01 = Boot)
508 0x01, // bInterfaceProtocol (0x01 = Keyboard)
511 // HID interface descriptor, HID 1.11 spec, section 6.2.1
513 0x21, // bDescriptorType
514 0x11, 0x01, // bcdHID
515 0, // bCountryCode - Setting to 0/Undefined
516 1, // bNumDescriptors
517 0x22, // bDescriptorType
518 LSB(sizeof(keyboard_hid_report_desc)), // wDescriptorLength
519 MSB(sizeof(keyboard_hid_report_desc)),
521 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
523 5, // bDescriptorType
524 KEYBOARD_ENDPOINT | 0x80, // bEndpointAddress
525 0x03, // bmAttributes (0x03=intr)
526 KEYBOARD_SIZE, 0, // wMaxPacketSize
529 // --- NKRO Keyboard HID ---
531 // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
533 4, // bDescriptorType
534 KEYBOARD_NKRO_INTERFACE, // bInterfaceNumber
535 0, // bAlternateSetting
537 0x03, // bInterfaceClass (0x03 = HID)
538 0x00, // bInterfaceSubClass (0x00 = Non-Boot, 0x01 = Boot)
539 0x01, // bInterfaceProtocol (0x01 = Keyboard)
542 // HID interface descriptor, HID 1.11 spec, section 6.2.1
544 0x21, // bDescriptorType
545 0x11, 0x01, // bcdHID
546 0, // bCountryCode - Setting to 0/Undefined
547 1, // bNumDescriptors
548 0x22, // bDescriptorType
550 LSB(sizeof(keyboard_nkro_hid_report_desc)),
551 MSB(sizeof(keyboard_nkro_hid_report_desc)),
553 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
555 5, // bDescriptorType
556 KEYBOARD_NKRO_ENDPOINT | 0x80, // bEndpointAddress
557 0x03, // bmAttributes (0x03=intr)
558 KEYBOARD_NKRO_SIZE, 0, // wMaxPacketSize
561 // --- Serial CDC ---
563 // interface association descriptor, USB ECN, Table 9-Z
565 11, // bDescriptorType
566 CDC_STATUS_INTERFACE, // bFirstInterface
567 2, // bInterfaceCount
568 0x02, // bFunctionClass
569 0x02, // bFunctionSubClass
570 0x01, // bFunctionProtocol
573 // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
575 4, // bDescriptorType
576 CDC_STATUS_INTERFACE, // bInterfaceNumber
577 0, // bAlternateSetting
579 0x02, // bInterfaceClass
580 0x02, // bInterfaceSubClass
581 0x01, // bInterfaceProtocol
584 // CDC Header Functional Descriptor, CDC Spec 5.2.3.1, Table 26
585 5, // bFunctionLength
586 0x24, // bDescriptorType
587 0x00, // bDescriptorSubtype
588 0x10, 0x01, // bcdCDC
590 // Call Management Functional Descriptor, CDC Spec 5.2.3.2, Table 27
591 5, // bFunctionLength
592 0x24, // bDescriptorType
593 0x01, // bDescriptorSubtype
594 0x01, // bmCapabilities
597 // Abstract Control Management Functional Descriptor, CDC Spec 5.2.3.3, Table 28
598 4, // bFunctionLength
599 0x24, // bDescriptorType
600 0x02, // bDescriptorSubtype
601 0x06, // bmCapabilities
603 // Union Functional Descriptor, CDC Spec 5.2.3.8, Table 33
604 5, // bFunctionLength
605 0x24, // bDescriptorType
606 0x06, // bDescriptorSubtype
607 CDC_STATUS_INTERFACE, // bMasterInterface
608 CDC_DATA_INTERFACE, // bSlaveInterface0
610 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
612 5, // bDescriptorType
613 CDC_ACM_ENDPOINT | 0x80, // bEndpointAddress
614 0x03, // bmAttributes (0x03=intr)
615 CDC_ACM_SIZE, 0, // wMaxPacketSize
618 // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12
620 4, // bDescriptorType
621 CDC_DATA_INTERFACE, // bInterfaceNumber
622 0, // bAlternateSetting
624 0x0A, // bInterfaceClass
625 0x00, // bInterfaceSubClass
626 0x00, // bInterfaceProtocol
629 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
631 5, // bDescriptorType
632 CDC_RX_ENDPOINT, // bEndpointAddress
633 0x02, // bmAttributes (0x02=bulk)
634 CDC_RX_SIZE, 0, // wMaxPacketSize
637 // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13
639 5, // bDescriptorType
640 CDC_TX_ENDPOINT | 0x80, // bEndpointAddress
641 0x02, // bmAttributes (0x02=bulk)
642 CDC_TX_SIZE, 0, // wMaxPacketSize
647 // Configuration Endpoint (0) Descriptor
648 struct usb_string_descriptor_struct {
650 uint8_t bDescriptorType;
653 static const struct usb_string_descriptor_struct PROGMEM string0 = {
658 static const struct usb_string_descriptor_struct PROGMEM string1 = {
659 sizeof(STR_MANUFACTURER),
663 static const struct usb_string_descriptor_struct PROGMEM string2 = {
668 static const struct usb_string_descriptor_struct PROGMEM string3 = {
674 // This table defines which descriptor data is sent for each specific
675 // request from the host (in wValue and wIndex).
676 static const struct descriptor_list_struct {
681 } PROGMEM descriptor_list[] = {
682 {0x0100, 0x0000, device_descriptor, sizeof(device_descriptor)},
683 {0x0200, 0x0000, config1_descriptor, sizeof(config1_descriptor)},
684 {0x0600, 0x0000, device_qualifier_descriptor, sizeof(device_qualifier_descriptor)},
685 {0x0A00, 0x0000, usb_debug_descriptor, sizeof(usb_debug_descriptor)},
686 {0x2200, KEYBOARD_INTERFACE, keyboard_hid_report_desc, sizeof(keyboard_hid_report_desc)},
687 {0x2100, KEYBOARD_INTERFACE, config1_descriptor + KEYBOARD_HID_DESC_OFFSET, 9},
688 {0x2200, KEYBOARD_NKRO_INTERFACE, keyboard_nkro_hid_report_desc, sizeof(keyboard_nkro_hid_report_desc)},
689 {0x2100, KEYBOARD_NKRO_INTERFACE, config1_descriptor + KEYBOARD_NKRO_HID_DESC_OFFSET, 9},
690 {0x0300, 0x0000, (const uint8_t *)&string0, 4},
691 {0x0301, 0x0409, (const uint8_t *)&string1, sizeof(STR_MANUFACTURER)},
692 {0x0302, 0x0409, (const uint8_t *)&string2, sizeof(STR_PRODUCT)},
693 {0x0303, 0x0409, (const uint8_t *)&string3, sizeof(STR_SERIAL)}
695 #define NUM_DESC_LIST (sizeof(descriptor_list)/sizeof(struct descriptor_list_struct))
699 #endif // usb_keyboard_serial_h__