usbd.h

Go to the documentation of this file.

/*
 * @brief Common definitions and declarations for the USB ROM based stack
 *
 * @note
 * Copyright(C) NXP Semiconductors, 2012
  * All rights reserved.
 *
 * @par
 * Software that is described herein is for illustrative purposes only
 * which provides customers with programming information regarding the
 * LPC products.  This software is supplied "AS IS" without any warranties of
 * any kind, and NXP Semiconductors and its licensor disclaim any and
 * all warranties, express or implied, including all implied warranties of
 * merchantability, fitness for a particular purpose and non-infringement of
 * intellectual property rights.  NXP Semiconductors assumes no responsibility
 * or liability for the use of the software, conveys no license or rights under any
 * patent, copyright, mask work right, or any other intellectual property rights in
 * or to any products. NXP Semiconductors reserves the right to make changes
 * in the software without notification. NXP Semiconductors also makes no
 * representation or warranty that such application will be suitable for the
 * specified use without further testing or modification.
 *
 * @par
 * Permission to use, copy, modify, and distribute this software and its
 * documentation is hereby granted, under NXP Semiconductors' and its
 * licensor's relevant copyrights in the software, without fee, provided that it
 * is used in conjunction with NXP Semiconductors microcontrollers.  This
 * copyright, permission, and disclaimer notice must appear in all copies of
 * this code.
 */

#ifndef __USBD_H__
#define __USBD_H__

#include <stdint.h>

#if defined(__GNUC__)
/* As per http://gcc.gnu.org/onlinedocs/gcc/Attribute-Syntax.html#Attribute-Syntax,
6.29 Attributes Syntax
"An attribute specifier list may appear as part of a struct, union or
enum specifier. It may go either immediately after the struct, union
or enum keyword, or after the closing brace. The former syntax is
preferred. Where attribute specifiers follow the closing brace, they
are considered to relate to the structure, union or enumerated type
defined, not to any enclosing declaration the type specifier appears
in, and the type defined is not complete until after the attribute
specifiers."
So use POST_PACK immediately after struct keyword
*/
#define PRE_PACK
#define POST_PACK __attribute__((__packed__))
#define ALIGNED(n)  __attribute__((aligned (n)))
#elif defined(__arm)
#define PRE_PACK __packed
#define POST_PACK
#define ALIGNED(n)  __align(n)
#elif defined(__ICCARM__)
#define PRE_PACK __packed
#define POST_PACK
#endif

PRE_PACK struct POST_PACK _WB_T
{
  uint8_t L; 
  uint8_t H; 
};
typedef struct _WB_T WB_T;

union __WORD_BYTE
{
  PRE_PACK uint16_t POST_PACK W; 
  WB_T WB; 
} ;
typedef union __WORD_BYTE WORD_BYTE;

#define REQUEST_HOST_TO_DEVICE     0

#define REQUEST_DEVICE_TO_HOST     1

#define REQUEST_STANDARD           0

#define REQUEST_CLASS              1

#define REQUEST_VENDOR             2

#define REQUEST_RESERVED           3

#define REQUEST_TO_DEVICE          0

#define REQUEST_TO_INTERFACE       1

#define REQUEST_TO_ENDPOINT        2

#define REQUEST_TO_OTHER           3

PRE_PACK struct POST_PACK _BM_T
{
  uint8_t Recipient :  5; 
  uint8_t Type      :  2; 
  uint8_t Dir       :  1; 
};
typedef struct _BM_T BM_T;

union _REQUEST_TYPE
{
//  PRE_PACK uint8_t POST_PACK B; /**< byte wide access memeber */
  uint8_t B;
  BM_T BM;   
} ;
typedef union _REQUEST_TYPE REQUEST_TYPE;

#define USB_REQUEST_GET_STATUS                 0

#define USB_REQUEST_CLEAR_FEATURE              1

#define USB_REQUEST_SET_FEATURE                3

#define USB_REQUEST_SET_ADDRESS                5

#define USB_REQUEST_GET_DESCRIPTOR             6

#define USB_REQUEST_SET_DESCRIPTOR             7

#define USB_REQUEST_GET_CONFIGURATION          8

#define USB_REQUEST_SET_CONFIGURATION          9

#define USB_REQUEST_GET_INTERFACE              10

#define USB_REQUEST_SET_INTERFACE              11

#define USB_REQUEST_SYNC_FRAME                 12

#define USB_GETSTATUS_SELF_POWERED             0x01

#define USB_GETSTATUS_REMOTE_WAKEUP            0x02

#define USB_GETSTATUS_ENDPOINT_STALL           0x01

#define USB_FEATURE_ENDPOINT_STALL             0

#define USB_FEATURE_REMOTE_WAKEUP              1

#define USB_FEATURE_TEST_MODE                  2

PRE_PACK struct POST_PACK _USB_SETUP_PACKET
{
  REQUEST_TYPE bmRequestType; 
  uint8_t      bRequest; 
  WORD_BYTE    wValue; 
  WORD_BYTE    wIndex; 
  uint16_t     wLength; 
} ;
typedef struct _USB_SETUP_PACKET USB_SETUP_PACKET;


#define USB_DEVICE_DESCRIPTOR_TYPE             1

#define USB_CONFIGURATION_DESCRIPTOR_TYPE      2

#define USB_STRING_DESCRIPTOR_TYPE             3

#define USB_INTERFACE_DESCRIPTOR_TYPE          4

#define USB_ENDPOINT_DESCRIPTOR_TYPE           5

#define USB_DEVICE_QUALIFIER_DESCRIPTOR_TYPE   6

#define USB_OTHER_SPEED_CONFIG_DESCRIPTOR_TYPE 7

#define USB_INTERFACE_POWER_DESCRIPTOR_TYPE    8

#define USB_OTG_DESCRIPTOR_TYPE                     9

#define USB_DEBUG_DESCRIPTOR_TYPE                  10

#define USB_INTERFACE_ASSOCIATION_DESCRIPTOR_TYPE  11

#define USB_DEVICE_CLASS_RESERVED              0x00

#define USB_DEVICE_CLASS_AUDIO                 0x01

#define USB_DEVICE_CLASS_COMMUNICATIONS        0x02

#define USB_DEVICE_CLASS_HUMAN_INTERFACE       0x03

#define USB_DEVICE_CLASS_MONITOR               0x04

#define USB_DEVICE_CLASS_PHYSICAL_INTERFACE    0x05

#define USB_DEVICE_CLASS_POWER                 0x06

#define USB_DEVICE_CLASS_PRINTER               0x07

#define USB_DEVICE_CLASS_STORAGE               0x08

#define USB_DEVICE_CLASS_HUB                   0x09

#define USB_DEVICE_CLASS_MISCELLANEOUS         0xEF

#define USB_DEVICE_CLASS_APP                   0xFE

#define USB_DEVICE_CLASS_VENDOR_SPECIFIC       0xFF

#define USB_CONFIG_POWERED_MASK                0x40

#define USB_CONFIG_BUS_POWERED                 0x80

#define USB_CONFIG_SELF_POWERED                0xC0

#define USB_CONFIG_REMOTE_WAKEUP               0x20

//#define USB_CONFIG_POWER_MA(mA)                ((mA)/2)

#define USB_ENDPOINT_DIRECTION_MASK            0x80

#define USB_ENDPOINT_OUT(addr)                 ((addr) | 0x00)

#define USB_ENDPOINT_IN(addr)                  ((addr) | 0x80)

#define USB_ENDPOINT_TYPE_MASK                 0x03

#define USB_ENDPOINT_TYPE_CONTROL              0x00

#define USB_ENDPOINT_TYPE_ISOCHRONOUS          0x01

#define USB_ENDPOINT_TYPE_BULK                 0x02

#define USB_ENDPOINT_TYPE_INTERRUPT            0x03

#define USB_ENDPOINT_SYNC_MASK                 0x0C

#define USB_ENDPOINT_SYNC_NO_SYNCHRONIZATION   0x00

#define USB_ENDPOINT_SYNC_ASYNCHRONOUS         0x04

#define USB_ENDPOINT_SYNC_ADAPTIVE             0x08

#define USB_ENDPOINT_SYNC_SYNCHRONOUS          0x0C

#define USB_ENDPOINT_USAGE_MASK                0x30

#define USB_ENDPOINT_USAGE_DATA                0x00

#define USB_ENDPOINT_USAGE_FEEDBACK            0x10

#define USB_ENDPOINT_USAGE_IMPLICIT_FEEDBACK   0x20

#define USB_ENDPOINT_USAGE_RESERVED            0x30

#define USB_ENDPOINT_0_HS_MAXP                 64

#define USB_ENDPOINT_0_LS_MAXP                 8

#define USB_ENDPOINT_BULK_HS_MAXP              512

PRE_PACK struct POST_PACK _USB_DEVICE_DESCRIPTOR
{
  uint8_t  bLength;     
  uint8_t  bDescriptorType; 
  uint16_t bcdUSB; 
  uint8_t  bDeviceClass; 
  uint8_t  bDeviceSubClass; 
  uint8_t  bDeviceProtocol; 
  uint8_t  bMaxPacketSize0; 
  uint16_t idVendor; 
  uint16_t idProduct; 
  uint16_t bcdDevice; 
  uint8_t  iManufacturer; 
  uint8_t  iProduct; 
  uint8_t  iSerialNumber; 
  uint8_t  bNumConfigurations; 
} ;
typedef struct _USB_DEVICE_DESCRIPTOR USB_DEVICE_DESCRIPTOR;

PRE_PACK struct POST_PACK _USB_DEVICE_QUALIFIER_DESCRIPTOR
{
  uint8_t  bLength; 
  uint8_t  bDescriptorType; 
  uint16_t bcdUSB; 
  uint8_t  bDeviceClass; 
  uint8_t  bDeviceSubClass; 
  uint8_t  bDeviceProtocol; 
  uint8_t  bMaxPacketSize0; 
  uint8_t  bNumConfigurations; 
  uint8_t  bReserved; 
} ;
typedef struct _USB_DEVICE_QUALIFIER_DESCRIPTOR USB_DEVICE_QUALIFIER_DESCRIPTOR;

PRE_PACK struct POST_PACK _USB_CONFIGURATION_DESCRIPTOR
{
  uint8_t  bLength; 
  uint8_t  bDescriptorType; 
  uint16_t wTotalLength; 
  uint8_t  bNumInterfaces; 
  uint8_t  bConfigurationValue; 
  uint8_t  iConfiguration; 
  uint8_t  bmAttributes; 
  uint8_t  bMaxPower; 
} ;
typedef struct _USB_CONFIGURATION_DESCRIPTOR USB_CONFIGURATION_DESCRIPTOR;

PRE_PACK struct POST_PACK _USB_INTERFACE_DESCRIPTOR
{
  uint8_t  bLength; 
  uint8_t  bDescriptorType; 
  uint8_t  bInterfaceNumber; 
  uint8_t  bAlternateSetting; 
  uint8_t  bNumEndpoints; 
  uint8_t  bInterfaceClass; 
  uint8_t  bInterfaceSubClass; 
  uint8_t  bInterfaceProtocol; 
  uint8_t  iInterface; 
} ;
typedef struct _USB_INTERFACE_DESCRIPTOR USB_INTERFACE_DESCRIPTOR;

PRE_PACK struct POST_PACK _USB_ENDPOINT_DESCRIPTOR
{
  uint8_t  bLength; 
  uint8_t  bDescriptorType; 
  uint8_t  bEndpointAddress; 
  uint8_t  bmAttributes; 
  uint16_t wMaxPacketSize; 
  uint8_t  bInterval; 
} ;
typedef struct _USB_ENDPOINT_DESCRIPTOR USB_ENDPOINT_DESCRIPTOR;

PRE_PACK struct POST_PACK _USB_STRING_DESCRIPTOR
{
  uint8_t  bLength; 
  uint8_t  bDescriptorType; 
  uint16_t bString/*[]*/; 
}  ;
typedef struct _USB_STRING_DESCRIPTOR USB_STRING_DESCRIPTOR;

PRE_PACK struct POST_PACK _USB_COMMON_DESCRIPTOR
{
  uint8_t  bLength; 
  uint8_t  bDescriptorType; 
} ;
typedef struct _USB_COMMON_DESCRIPTOR USB_COMMON_DESCRIPTOR;

PRE_PACK struct POST_PACK _USB_OTHER_SPEED_CONFIGURATION
{
  uint8_t  bLength; 
  uint8_t  bDescriptorType; 
  uint16_t wTotalLength; 
  uint8_t  bNumInterfaces; 
  uint8_t  bConfigurationValue; 
  uint8_t  IConfiguration; 
  uint8_t  bmAttributes; 
  uint8_t  bMaxPower; 
} ;
typedef struct _USB_OTHER_SPEED_CONFIGURATION USB_OTHER_SPEED_CONFIGURATION;

typedef void* USBD_HANDLE_T;

#define WBVAL(x) ((x) & 0xFF),(((x) >> 8) & 0xFF)
#define B3VAL(x) ((x) & 0xFF),(((x) >> 8) & 0xFF),(((x) >> 16) & 0xFF)

#define USB_DEVICE_DESC_SIZE        (sizeof(USB_DEVICE_DESCRIPTOR))
#define USB_CONFIGUARTION_DESC_SIZE (sizeof(USB_CONFIGURATION_DESCRIPTOR))
#define USB_INTERFACE_DESC_SIZE     (sizeof(USB_INTERFACE_DESCRIPTOR))
#define USB_ENDPOINT_DESC_SIZE      (sizeof(USB_ENDPOINT_DESCRIPTOR))
#define USB_DEVICE_QUALI_SIZE       (sizeof(USB_DEVICE_QUALIFIER_DESCRIPTOR))
#define USB_OTHER_SPEED_CONF_SIZE   (sizeof(USB_OTHER_SPEED_CONFIGURATION))

uint32_t CALLBACK_UsbdRom_Register_DeviceDescriptor(void);
uint32_t CALLBACK_UsbdRom_Register_ConfigurationDescriptor(void);
uint32_t CALLBACK_UsbdRom_Register_StringDescriptor(void);
uint32_t CALLBACK_UsbdRom_Register_DeviceQualifierDescriptor(void);
uint8_t CALLBACK_UsbdRom_Register_ConfigureEndpoint(void);
#endif  /* __USB_H__ */