usb_descriptors.h

Go to the documentation of this file.

#ifndef _USB_USERCONFIG_H_
#define _USB_USERCONFIG_H_

//_____ I N C L U D E S ____________________________________________________

#include "config.h"
#include "modules/usb/device_chap9/usb_standard_request.h"
#include "conf_usb.h"

//_____ M A C R O S ________________________________________________________

#define Usb_get_dev_desc_pointer()        (&(usb_dev_desc.bLength))
#define Usb_get_dev_desc_length()         (sizeof (usb_dev_desc))
#define Usb_get_conf_desc_pointer()       (&(usb_conf_desc.cfg_mouse.bLength))
#define Usb_get_conf_desc_length()        (sizeof (usb_conf_desc))

//_____ U S B    D E F I N E _______________________________________________

                  // USB Device descriptor
#define USB_SPECIFICATION     0x0200
#define DEVICE_CLASS          0      // each configuration has its own class
#define DEVICE_SUB_CLASS      0      // each configuration has its own sub-class
#define DEVICE_PROTOCOL       0      // each configuration has its own protocol
#define EP_CONTROL_LENGTH     8
#define VENDOR_ID             0x03EB // Atmel vendor ID = 03EBh
#define PRODUCT_ID            0x2031 // PID of HID application : toggle LED
#define RELEASE_NUMBER        0x1000
#define MAN_INDEX             0x01
#define PROD_INDEX            0x02
#define SN_INDEX              0x03
#define NB_CONFIGURATION      1

               // CONFIGURATION
#define NB_INTERFACE       1
#define CONF_NB            1
#define CONF_INDEX         0
#define CONF_ATTRIBUTES    (USB_CONFIG_SELFPOWERED)
#define MAX_POWER          50          // 100 mA

             // OTG Descriptor  : set feature to "1" if used, "0" otherwise
#define OTG_BMATTRIBUTES  (HNP_SUPPORT | SRP_SUPPORT)

             // USB Interface descriptor Spider Basic
#define INTERFACE_NB_SPIDER         0
#define ALTERNATE_SPIDER            0
#define NB_ENDPOINT_SPIDER          1
#define INTERFACE_CLASS_SPIDER      HID_CLASS         // HID Class
#define INTERFACE_SUB_CLASS_SPIDER  NO_SUBCLASS       // No Sub Class
#define INTERFACE_PROTOCOL_SPIDER   MOUSE_PROTOCOL    // Mouse Protocol
#define INTERFACE_INDEX_SPIDER      0

#define SELF_POWERED          1
#define DEVICE_STATUS         SELF_POWERED
#define INTERFACE_STATUS      0x00 // TBD

            // USB Endpoint 1 descriptor FS
#define ENDPOINT_NB_1       (EP_SPIDER_IN | 0x80)
#define EP_ATTRIBUTES_1     0x03              // BULK = 0x02, INTERUPT = 0x03
#define EP_IN_LENGTH_1      8
#define EP_SIZE_1           EP_IN_LENGTH_1
#define EP_INTERVAL_1       50             // Interrupt polling interval from host, in ms


            // HID specific
#define HID                   0x21
#define REPORT                0x22
#define SET_REPORT                0x02

#define HID_DESCRIPTOR        0x21
#define HID_BDC               0x1001
#define HID_COUNTRY_CODE      0x00
#define HID_CLASS_DESC_NB     0x01
#define HID_DESCRIPTOR_TYPE   0x22

#define LANG_ID               0x00


#define USB_MN_LENGTH         5
#define USB_MANUFACTURER_NAME \
{ Usb_unicode('A') \
, Usb_unicode('T') \
, Usb_unicode('M') \
, Usb_unicode('E') \
, Usb_unicode('L') \
}

#define USB_PN_LENGTH         21
#define USB_PRODUCT_NAME \
{ Usb_unicode('A') \
 ,Usb_unicode('V') \
 ,Usb_unicode('R') \
 ,Usb_unicode('U') \
 ,Usb_unicode('S') \
 ,Usb_unicode('B') \
 ,Usb_unicode(' ') \
 ,Usb_unicode('O') \
 ,Usb_unicode('T') \
 ,Usb_unicode('G') \
 ,Usb_unicode(' ') \
 ,Usb_unicode('M') \
 ,Usb_unicode('O') \
 ,Usb_unicode('U') \
 ,Usb_unicode('S') \
 ,Usb_unicode('E') \
 ,Usb_unicode(' ') \
 ,Usb_unicode('D') \
 ,Usb_unicode('E') \
 ,Usb_unicode('M') \
 ,Usb_unicode('O') \
}

#define USB_SN_LENGTH         0x0D
              // Serial Number should be at least 12 characters long
#define USB_SERIAL_NUMBER \
{ Usb_unicode('1') \
 ,Usb_unicode('.') \
 ,Usb_unicode('0') \
 ,Usb_unicode('.') \
 ,Usb_unicode('0') \
 ,Usb_unicode('.') \
 ,Usb_unicode('0') \
 ,Usb_unicode('.') \
 ,Usb_unicode('0') \
 ,Usb_unicode('.') \
 ,Usb_unicode('0') \
 ,Usb_unicode('.') \
 ,Usb_unicode('A') \
}

#define LANGUAGE_ID           0x0409


typedef struct
{
   U8      bmRequestType;        
   U8      bRequest;             
   U16     wValue;               
   U16     wIndex;               
   U16     wLength;              
}  S_UsbRequest;

typedef struct {
   U8      bLength;              
   U8      bDescriptorType;      
   U16     bscUSB;               
   U8      bDeviceClass;         
   U8      bDeviceSubClass;      
   U8      bDeviceProtocol;      
   U8      bMaxPacketSize0;      
   U16     idVendor;             
   U16     idProduct;            
   U16     bcdDevice;            
   U8      iManufacturer;        
   U8      iProduct;             
   U8      iSerialNumber;        
   U8      bNumConfigurations;   
}  S_usb_device_descriptor;


typedef struct {
   U8      bLength;              
   U8      bDescriptorType;      
   U16     wTotalLength;         
   U8      bNumInterfaces;       
   U8      bConfigurationValue;  
   U8      iConfiguration;       
   U8      bmAttibutes;          
   U8      MaxPower;             
}  S_usb_configuration_descriptor;

typedef struct {
   U8      bLength;               
   U8      bDescriptorType;       
   U8      bmAttributes;          
}  S_usb_otg_descriptor;

typedef struct {
   U8      bLength;               
   U8      bDescriptorType;       
   U8      bInterfaceNumber;      
   U8      bAlternateSetting;     
   U8      bNumEndpoints;         
   U8      bInterfaceClass;       
   U8      bInterfaceSubClass;    
   U8      bInterfaceProtocol;    
   U8      iInterface;            
}  S_usb_interface_descriptor;


typedef struct {
   U8      bLength;               
   U8      bDescriptorType;       
   U8      bEndpointAddress;      
   U8      bmAttributes;          
   U16     wMaxPacketSize;        
   U8      bInterval;             
} S_usb_endpoint_descriptor;


typedef struct {
   U8      bLength;               
   U8      bDescriptorType;       
   U16     bscUSB;                
   U8      bDeviceClass;          
   U8      bDeviceSubClass;       
   U8      bDeviceProtocol;       
   U8      bMaxPacketSize0;       
   U8      bNumConfigurations;    
   U8      bReserved;             
}  S_usb_device_qualifier_descriptor;


typedef struct {
   U8      bLength;               
   U8      bDescriptorType;       
   U16     wlangid;               
}  S_usb_language_id;


//_____ U S B   M A N U F A C T U R E R   D E S C R I P T O R _______________


//struct usb_st_manufacturer
typedef struct {
   U8  bLength;               // size of this descriptor in bytes
   U8  bDescriptorType;       // STRING descriptor type
   U16 wstring[USB_MN_LENGTH];// unicode characters
} S_usb_manufacturer_string_descriptor;


//_____ U S B   P R O D U C T   D E S C R I P T O R _________________________


//struct usb_st_product
typedef struct {
   U8  bLength;               // size of this descriptor in bytes
   U8  bDescriptorType;       // STRING descriptor type
   U16 wstring[USB_PN_LENGTH];// unicode characters
} S_usb_product_string_descriptor;


//_____ U S B   S E R I A L   N U M B E R   D E S C R I P T O R _____________


//struct usb_st_serial_number
typedef struct {
   U8  bLength;               // size of this descriptor in bytes
   U8  bDescriptorType;       // STRING descriptor type
   U16 wstring[USB_SN_LENGTH];// unicode characters
} S_usb_serial_number;


/*_____ U S B   H I D   D E S C R I P T O R __________________________________*/

typedef struct {
  U8  bLength;               // Size of this descriptor in bytes
  U8  bDescriptorType;       // HID descriptor type
  U16 bscHID;                // Binay Coded Decimal Spec. release
  U8  bCountryCode;          // Hardware target country
  U8  bNumDescriptors;       // Number of HID class descriptors to follow
  U8  bRDescriptorType;      // Report descriptor type
  U16 wDescriptorLength;     // Total length of Report descriptor
} S_usb_hid_descriptor;


typedef struct
{
   S_usb_configuration_descriptor cfg_mouse;
   S_usb_otg_descriptor           otg_dsc;
   S_usb_interface_descriptor     ifc_mouse;
   S_usb_hid_descriptor           hid_mouse;
   S_usb_endpoint_descriptor      ep1_spider;
} S_usb_user_configuration_descriptor;



#endif

---