tmk_core/tool/mbed/mbed-sdk/libraries/USBDevice/USBDevice/USBDescriptor.h

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