usb_descriptors.h

Go to the documentation of this file.
00001 /*This file is prepared for Doxygen automatic documentation generation.*/
00016 
00017 /* Copyright (c) 2009 Atmel Corporation. All rights reserved.
00018  *
00019  * Redistribution and use in source and binary forms, with or without
00020  * modification, are permitted provided that the following conditions are met:
00021  *
00022  * 1. Redistributions of source code must retain the above copyright notice,
00023  * this list of conditions and the following disclaimer.
00024  *
00025  * 2. Redistributions in binary form must reproduce the above copyright notice,
00026  * this list of conditions and the following disclaimer in the documentation
00027  * and/or other materials provided with the distribution.
00028  *
00029  * 3. The name of Atmel may not be used to endorse or promote products derived
00030  * from this software without specific prior written permission.
00031  *
00032  * 4. This software may only be redistributed and used in connection with an Atmel
00033  * AVR product.
00034  *
00035  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00037  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE EXPRESSLY AND
00038  * SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT,
00039  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00040  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00041  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00042  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00043  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00044  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00045  */
00046 
00047 #ifndef _USB_DESCRIPTORS_H_
00048 #define _USB_DESCRIPTORS_H_
00049 
00050 //_____ I N C L U D E S ____________________________________________________
00051 
00052 #include "config.h"
00053 #include "modules/usb/device_chap9/usb_standard_request.h"
00054 #include "conf_usb.h"
00055 
00056 //_____ M A C R O S ________________________________________________________
00057 
00058 #define Usb_get_dev_desc_pointer()        (&(usb_dev_desc.bLength))
00059 #define Usb_get_dev_desc_length()         (sizeof (usb_dev_desc))
00060 #define Usb_get_conf_desc_pointer()       (&(usb_conf_desc.cfg.bLength))
00061 #define Usb_get_conf_desc_length()        (sizeof (usb_conf_desc))
00062 
00063 //_____ U S B    D E F I N E _______________________________________________
00064 
00065                   // USB Device descriptor
00066 #define USB_SPECIFICATION     0x0200
00067 #define DEVICE_CLASS          CDC_GLOB_CLASS  // CDC class
00068 #define DEVICE_SUB_CLASS      0      // each configuration has its own sub-class
00069 #define DEVICE_PROTOCOL       0      // each configuration has its own protocol
00070 #define EP_CONTROL_LENGTH     32
00071 #define VENDOR_ID             VID_ATMEL
00072 #define PRODUCT_ID            PID_MegaCDC
00073 #define RELEASE_NUMBER        0x1000
00074 #define MAN_INDEX             0x00
00075 #define PROD_INDEX            0x00
00076 #if (USB_DEVICE_SN_USE==ENABLE)
00077 #define SN_INDEX              0x03
00078 #else
00079 #define SN_INDEX              0x00  // No serial number field
00080 #endif
00081 #define NB_CONFIGURATION      1
00082 
00083                // CDC CONFIGURATION
00084 #define NB_INTERFACE       2           // Number of interfaces
00085 #define CONF_NB            1
00086 #define CONF_INDEX         0
00087 #define CONF_ATTRIBUTES    USB_CONFIG_BUSPOWERED
00088 #define MAX_POWER          50          // 100 mA
00089 
00090              // Interface 0 descriptor
00091 #define INTERFACE0_NB        0
00092 #define ALTERNATE0           0
00093 #define NB_ENDPOINT0         1
00094 #define INTERFACE0_CLASS     CDC_COMM_CLASS    // CDC ACM Com
00095 #define INTERFACE0_SUB_CLASS CDC_COMM_SUBCLASS
00096 #define INTERFACE0_PROTOCOL  CDC_COMM_PROTOCOL
00097 #define INTERFACE0_INDEX     0
00098 
00099              // Interface 1 descriptor
00100 #define INTERFACE1_NB        1
00101 #define ALTERNATE1           0
00102 #define NB_ENDPOINT1         2
00103 #define INTERFACE1_CLASS     CDC_DATA_CLASS    // CDC ACM Data
00104 #define INTERFACE1_SUB_CLASS CDC_DATA_SUBCLASS
00105 #define INTERFACE1_PROTOCOL  CDC_DATA_PROTOCOL
00106 #define INTERFACE1_INDEX     0
00107 
00108              // USB Endpoint 3 descriptor
00109              // Interrupt IN
00110 #define INT_EP_SIZE          0x20
00111 #define ENDPOINT_NB_3       USB_ENDPOINT_IN | INT_EP
00112 #define EP_ATTRIBUTES_3     0x03          // BULK = 0x02, INTERUPT = 0x03
00113 #define EP_SIZE_3           INT_EP_SIZE
00114 #define EP_INTERVAL_3       0xFF //ms interrupt pooling from host
00115 
00116              // USB Endpoint 1 descriptor
00117              // Bulk IN
00118 #define TX_EP_SIZE          0x20
00119 #define ENDPOINT_NB_1       USB_ENDPOINT_IN | TX_EP
00120 #define EP_ATTRIBUTES_1     0x02          // BULK = 0x02, INTERUPT = 0x03
00121 #define EP_SIZE_1           TX_EP_SIZE
00122 #define EP_INTERVAL_1       0x00
00123 
00124              // USB Endpoint 2 descriptor
00125              //Bulk OUT  RX endpoint
00126 #define RX_EP_SIZE           0x20
00127 #define ENDPOINT_NB_2       RX_EP
00128 #define EP_ATTRIBUTES_2     0x02          // BULK = 0x02, INTERUPT = 0x03
00129 #define EP_SIZE_2           RX_EP_SIZE
00130 #define EP_INTERVAL_2       0x00
00131 
00132 #define DEVICE_STATUS         USB_DEVICE_STATUS_BUS_POWERED
00133 
00134 #define LANG_ID               0x00
00135 
00136 
00137 #define USB_MN_LENGTH         5
00138 #define USB_MANUFACTURER_NAME \
00139 { Usb_unicode('A') \
00140 , Usb_unicode('T') \
00141 , Usb_unicode('M') \
00142 , Usb_unicode('E') \
00143 , Usb_unicode('L') \
00144 }
00145 
00146 #define USB_PN_LENGTH         16
00147 #define USB_PRODUCT_NAME \
00148 { Usb_unicode('A') \
00149  ,Usb_unicode('V') \
00150  ,Usb_unicode('R') \
00151  ,Usb_unicode(' ') \
00152  ,Usb_unicode('U') \
00153  ,Usb_unicode('S') \
00154  ,Usb_unicode('B') \
00155  ,Usb_unicode(' ') \
00156  ,Usb_unicode('C') \
00157  ,Usb_unicode('D') \
00158  ,Usb_unicode('C') \
00159  ,Usb_unicode(' ') \
00160  ,Usb_unicode('D') \
00161  ,Usb_unicode('E') \
00162  ,Usb_unicode('M') \
00163  ,Usb_unicode('O') \
00164 }
00165 
00166 #define USB_SN_LENGTH         0x05
00167 #define USB_SERIAL_NUMBER \
00168 { Usb_unicode('0') \
00169  ,Usb_unicode('0') \
00170  ,Usb_unicode('0') \
00171  ,Usb_unicode('0') \
00172  ,Usb_unicode('0') \
00173 }
00174 
00175 #define LANGUAGE_ID           0x0409
00176 
00177 
00179 typedef struct
00180 {
00181    U8      bmRequestType;        
00182    U8      bRequest;             
00183    U16     wValue;               
00184    U16     wIndex;               
00185    U16     wLength;              
00186 }  S_UsbRequest;
00187 
00189 typedef struct {
00190    U8      bLength;              
00191    U8      bDescriptorType;      
00192    U16     bscUSB;               
00193    U8      bDeviceClass;         
00194    U8      bDeviceSubClass;      
00195    U8      bDeviceProtocol;      
00196    U8      bMaxPacketSize0;      
00197    U16     idVendor;             
00198    U16     idProduct;            
00199    U16     bcdDevice;            
00200    U8      iManufacturer;        
00201    U8      iProduct;             
00202    U8      iSerialNumber;        
00203    U8      bNumConfigurations;   
00204 }  S_usb_device_descriptor;
00205 
00206 
00208 typedef struct {
00209    U8      bLength;              
00210    U8      bDescriptorType;      
00211    U16     wTotalLength;         
00212    U8      bNumInterfaces;       
00213    U8      bConfigurationValue;  
00214    U8      iConfiguration;       
00215    U8      bmAttibutes;          
00216    U8      MaxPower;             
00217 }  S_usb_configuration_descriptor;
00218 
00219 
00221 typedef struct {
00222    U8      bLength;               
00223    U8      bDescriptorType;       
00224    U8      bInterfaceNumber;      
00225    U8      bAlternateSetting;     
00226    U8      bNumEndpoints;         
00227    U8      bInterfaceClass;       
00228    U8      bInterfaceSubClass;    
00229    U8      bInterfaceProtocol;    
00230    U8      iInterface;            
00231 }  S_usb_interface_descriptor;
00232 
00233 
00235 typedef struct {
00236    U8      bLength;               
00237    U8      bDescriptorType;       
00238    U8      bEndpointAddress;      
00239    U8      bmAttributes;          
00240    U16     wMaxPacketSize;        
00241    U8      bInterval;             
00242 } S_usb_endpoint_descriptor;
00243 
00244 
00246 typedef struct {
00247    U8      bLength;               
00248    U8      bDescriptorType;       
00249    U16     wlangid;               
00250 }  S_usb_language_id;
00251 
00252 
00253 //_____ 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 _______________
00254 
00255 
00256 //struct usb_st_manufacturer
00257 typedef struct {
00258    U8  bLength;               // size of this descriptor in bytes
00259    U8  bDescriptorType;       // STRING descriptor type
00260    U16 wstring[USB_MN_LENGTH];// unicode characters
00261 } S_usb_manufacturer_string_descriptor;
00262 
00263 
00264 //_____ U S B   P R O D U C T   D E S C R I P T O R _________________________
00265 
00266 
00267 //struct usb_st_product
00268 typedef struct {
00269    U8  bLength;               // size of this descriptor in bytes
00270    U8  bDescriptorType;       // STRING descriptor type
00271    U16 wstring[USB_PN_LENGTH];// unicode characters
00272 } S_usb_product_string_descriptor;
00273 
00274 
00275 //_____ 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 _____________
00276 
00277 
00278 #if (USB_DEVICE_SN_USE==ENABLE)
00279 //struct usb_st_serial_number
00280 typedef struct {
00281    U8  bLength;               // size of this descriptor in bytes
00282    U8  bDescriptorType;       // STRING descriptor type
00283 #if (USE_DEVICE_SN_UNIQUE==ENABLE)
00284 
00285 #else   
00286    U16 wstring[USB_SN_LENGTH];// unicode characters
00287 #endif
00288 } S_usb_serial_number;
00289 #endif
00290 
00291 
00292 /*_____ U S B   C D C  D E S C R I P T O R __________________________________*/
00293 
00294 typedef struct
00295 {
00296    S_usb_configuration_descriptor cfg;
00297    S_usb_interface_descriptor     ifc0;
00298    U8 CS_INTERFACE[19];
00299    S_usb_endpoint_descriptor      ep3;
00300    S_usb_interface_descriptor     ifc1;
00301    S_usb_endpoint_descriptor      ep1;
00302    S_usb_endpoint_descriptor      ep2;
00303 } S_usb_user_configuration_descriptor;
00304 
00305 
00306 
00307 
00308 
00309 
00310 
00311 #endif
00312 

Generated on Fri Sep 11 14:46:05 2009 for ATMEL by  doxygen 1.5.3