Fork of https://developer.mbed.org/users/bscott/code/STM32_USBDevice/
Fork of STM32_USBDevice by
USBDevice/USBDescriptor.h@79:d28244984385, 2018-07-25 (annotated)
- Committer:
- Troels Nilsson
- Date:
- Wed Jul 25 14:04:48 2018 +0200
- Revision:
- 79:d28244984385
- Parent:
- 76:eef92651f52f
Merge feature_WebUSB into default
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
samux | 1:80ab0d068708 | 1 | /* Copyright (c) 2010-2011 mbed.org, MIT License |
samux | 1:80ab0d068708 | 2 | * |
samux | 1:80ab0d068708 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
samux | 1:80ab0d068708 | 4 | * and associated documentation files (the "Software"), to deal in the Software without |
samux | 1:80ab0d068708 | 5 | * restriction, including without limitation the rights to use, copy, modify, merge, publish, |
samux | 1:80ab0d068708 | 6 | * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the |
samux | 1:80ab0d068708 | 7 | * Software is furnished to do so, subject to the following conditions: |
samux | 1:80ab0d068708 | 8 | * |
samux | 1:80ab0d068708 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
samux | 1:80ab0d068708 | 10 | * substantial portions of the Software. |
samux | 1:80ab0d068708 | 11 | * |
samux | 1:80ab0d068708 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
samux | 1:80ab0d068708 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
samux | 1:80ab0d068708 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
samux | 1:80ab0d068708 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
samux | 1:80ab0d068708 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
samux | 1:80ab0d068708 | 17 | */ |
samux | 1:80ab0d068708 | 18 | |
samux | 1:80ab0d068708 | 19 | /* Standard descriptor types */ |
samux | 1:80ab0d068708 | 20 | #define DEVICE_DESCRIPTOR (1) |
samux | 1:80ab0d068708 | 21 | #define CONFIGURATION_DESCRIPTOR (2) |
samux | 1:80ab0d068708 | 22 | #define STRING_DESCRIPTOR (3) |
samux | 1:80ab0d068708 | 23 | #define INTERFACE_DESCRIPTOR (4) |
samux | 1:80ab0d068708 | 24 | #define ENDPOINT_DESCRIPTOR (5) |
samux | 1:80ab0d068708 | 25 | #define QUALIFIER_DESCRIPTOR (6) |
Troels Nilsson |
76:eef92651f52f | 26 | #define INTERFACE_ASSOCIATION_DESCRIPTOR (11) |
Troels Nilsson |
76:eef92651f52f | 27 | #define BOS_DESCRIPTOR (15) |
Troels Nilsson |
76:eef92651f52f | 28 | #define DEVICE_CAPABILITY_DESCRIPTOR (16) |
samux | 1:80ab0d068708 | 29 | |
samux | 1:80ab0d068708 | 30 | /* Standard descriptor lengths */ |
samux | 1:80ab0d068708 | 31 | #define DEVICE_DESCRIPTOR_LENGTH (0x12) |
samux | 1:80ab0d068708 | 32 | #define CONFIGURATION_DESCRIPTOR_LENGTH (0x09) |
samux | 1:80ab0d068708 | 33 | #define INTERFACE_DESCRIPTOR_LENGTH (0x09) |
samux | 1:80ab0d068708 | 34 | #define ENDPOINT_DESCRIPTOR_LENGTH (0x07) |
Troels Nilsson |
76:eef92651f52f | 35 | #define INTERFACE_ASSOCIATION_DESCRIPTOR_LENGTH (0x08) |
Troels Nilsson |
76:eef92651f52f | 36 | #define BOS_DESCRIPTOR_LENGTH (0x05) |
samux | 1:80ab0d068708 | 37 | |
samux | 1:80ab0d068708 | 38 | /*string offset*/ |
mbed_official | 25:7c72828865f3 | 39 | #define STRING_OFFSET_LANGID (0) |
samux | 1:80ab0d068708 | 40 | #define STRING_OFFSET_IMANUFACTURER (1) |
samux | 1:80ab0d068708 | 41 | #define STRING_OFFSET_IPRODUCT (2) |
samux | 1:80ab0d068708 | 42 | #define STRING_OFFSET_ISERIAL (3) |
samux | 1:80ab0d068708 | 43 | #define STRING_OFFSET_ICONFIGURATION (4) |
samux | 1:80ab0d068708 | 44 | #define STRING_OFFSET_IINTERFACE (5) |
samux | 1:80ab0d068708 | 45 | |
samux | 1:80ab0d068708 | 46 | /* USB Specification Release Number */ |
samux | 1:80ab0d068708 | 47 | #define USB_VERSION_2_0 (0x0200) |
samux | 1:80ab0d068708 | 48 | |
samux | 1:80ab0d068708 | 49 | /* Least/Most significant byte of short integer */ |
samux | 1:80ab0d068708 | 50 | #define LSB(n) ((n)&0xff) |
samux | 1:80ab0d068708 | 51 | #define MSB(n) (((n)&0xff00)>>8) |
samux | 1:80ab0d068708 | 52 | |
samux | 1:80ab0d068708 | 53 | /* Convert physical endpoint number to descriptor endpoint number */ |
samux | 1:80ab0d068708 | 54 | #define PHY_TO_DESC(endpoint) (((endpoint)>>1) | (((endpoint) & 1) ? 0x80:0)) |
samux | 1:80ab0d068708 | 55 | |
samux | 1:80ab0d068708 | 56 | /* bmAttributes in configuration descriptor */ |
samux | 1:80ab0d068708 | 57 | /* C_RESERVED must always be set */ |
samux | 1:80ab0d068708 | 58 | #define C_RESERVED (1U<<7) |
samux | 1:80ab0d068708 | 59 | #define C_SELF_POWERED (1U<<6) |
samux | 1:80ab0d068708 | 60 | #define C_REMOTE_WAKEUP (1U<<5) |
samux | 1:80ab0d068708 | 61 | |
samux | 1:80ab0d068708 | 62 | /* bMaxPower in configuration descriptor */ |
samux | 1:80ab0d068708 | 63 | #define C_POWER(mA) ((mA)/2) |
samux | 1:80ab0d068708 | 64 | |
samux | 1:80ab0d068708 | 65 | /* bmAttributes in endpoint descriptor */ |
samux | 1:80ab0d068708 | 66 | #define E_CONTROL (0x00) |
samux | 1:80ab0d068708 | 67 | #define E_ISOCHRONOUS (0x01) |
samux | 1:80ab0d068708 | 68 | #define E_BULK (0x02) |
samux | 1:80ab0d068708 | 69 | #define E_INTERRUPT (0x03) |
samux | 1:80ab0d068708 | 70 | |
samux | 1:80ab0d068708 | 71 | /* For isochronous endpoints only: */ |
samux | 1:80ab0d068708 | 72 | #define E_NO_SYNCHRONIZATION (0x00) |
samux | 1:80ab0d068708 | 73 | #define E_ASYNCHRONOUS (0x04) |
samux | 1:80ab0d068708 | 74 | #define E_ADAPTIVE (0x08) |
samux | 1:80ab0d068708 | 75 | #define E_SYNCHRONOUS (0x0C) |
samux | 1:80ab0d068708 | 76 | #define E_DATA (0x00) |
samux | 1:80ab0d068708 | 77 | #define E_FEEDBACK (0x10) |
samux | 1:80ab0d068708 | 78 | #define E_IMPLICIT_FEEDBACK (0x20) |