usb_descriptors.h

Go to the documentation of this file.

/*This file is prepared for Doxygen automatic documentation generation.*/

/* Copyright (c) 2009 Atmel Corporation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. The name of Atmel may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * 4. This software may only be redistributed and used in connection with an Atmel
 * AVR product.
 *
 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE EXPRESSLY AND
 * SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _USB_DESCRIPTORS_H_
#define _USB_DESCRIPTORS_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     64
#define VENDOR_ID             VID_ATMEL
#define PRODUCT_ID            PID_AT90USB128_64_MS_HIDMS_HID_STK525
#define RELEASE_NUMBER        0x1000
#define MAN_INDEX             0x01
#define PROD_INDEX            0x02   
#if (USB_DEVICE_SN_USE==ENABLE)
#define SN_INDEX              0x03
#else
#define SN_INDEX              0x00  // No serial number field
#endif
#define NB_CONFIGURATION      1

               // CONFIGURATION
#define NB_INTERFACE       3           // Number of interfaces
#define CONF_NB            1
#define CONF_INDEX         0
#define CONF_ATTRIBUTES    USB_CONFIG_BUSPOWERED
#define MAX_POWER          50          // 100 mA

             // USB Interface descriptor Mouse
#define INTERFACE_NB_MOUSE        0           // Interface's number
#define ALTERNATE_MOUSE           0
#define NB_ENDPOINT_MOUSE         1
#define INTERFACE_CLASS_MOUSE     HID_CLASS
#define INTERFACE_SUB_CLASS_MOUSE NO_SUBCLASS // no Sub Class
#define INTERFACE_PROTOCOL_MOUSE  HID_PROTOCOL_MOUSE  // Mouse
#define INTERFACE_INDEX_MOUSE     0

            // USB Endpoint 1 descriptor FS
#define ENDPOINT_NB_1       (EP_MOUSE_IN | USB_ENDPOINT_IN)
#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       0x25              // Interrupt polling interval from host


             // USB Mass Storage Interface descriptor
#define INTERFACE_NB        1           // Interface's number
#define ALTERNATE           0
#define NB_ENDPOINT         2
#define INTERFACE_CLASS     MS_CLASS     // Mass Storage Class
#define INTERFACE_SUB_CLASS MS_SUB_CLASS6 // SCSI transparent Command Set
#define INTERFACE_PROTOCOL  MS_PROTOCOL  // Bulk-Only Transport
#define INTERFACE_INDEX     0

             // USB Endpoint 2 descriptor FS
#define ENDPOINT_NB_2       (EP_MS_IN | USB_ENDPOINT_IN)
#define EP_ATTRIBUTES_2     0x02          // BULK = 0x02, INTERUPT = 0x03
#define EP_IN_LENGTH        64
#define EP_SIZE_2           EP_IN_LENGTH
#define EP_INTERVAL_2       0x00          


             // USB Endpoint 3 descriptor FS
#define ENDPOINT_NB_3       EP_MS_OUT
#define EP_ATTRIBUTES_3     0x02          // BULK = 0x02, INTERUPT = 0x03
#define EP_IN_LENGTH        64
#define EP_SIZE_3           EP_IN_LENGTH
#define EP_INTERVAL_3       0x00          

#define DEVICE_STATUS         USB_DEVICE_STATUS_BUS_POWERED

             // USB HID generic Interface descriptor
#define INTERFACE_NB_HID    2           // Interface's number
#define ALTERNATE           0
#define NB_ENDPOINT         2
#define INTERFACE_CLASS_HID     HID_CLASS // HID Class
#define INTERFACE_SUB_CLASS_HID NO_SUBCLASS
#define INTERFACE_PROTOCOL_HID  NO_PROTOCOL
#define INTERFACE_INDEX     0

             // USB Endpoint 1 descriptor FS
#define ENDPOINT_NB_4       (EP_HID_IN | USB_ENDPOINT_IN)
#define EP_ATTRIBUTES_4     0x03          // BULK = 0x02, INTERUPT = 0x03
#define EP_IN_LENGTH_4      8
#define EP_SIZE_4           EP_IN_LENGTH_4
#define EP_INTERVAL_4       20 //interrupt pooling from host

             // USB Endpoint 1 descriptor FS
#define ENDPOINT_NB_5       (EP_HID_OUT)
#define EP_ATTRIBUTES_5     0x03          // BULK = 0x02, INTERUPT = 0x03
#define EP_OUT_LENGTH_5     8
#define EP_SIZE_5           EP_OUT_LENGTH_5
#define EP_INTERVAL_5       20 //interrupt pooling from host

#define SIZE_OF_REPORT_HID       0x35
#define LENGTH_OF_REPORT_IN      0x08
#define LENGTH_OF_REPORT_OUT     0x08

#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         28
#define USB_PRODUCT_NAME \
{ Usb_unicode('A') \
 ,Usb_unicode('V') \
 ,Usb_unicode('R') \
 ,Usb_unicode(' ') \
 ,Usb_unicode('U') \
 ,Usb_unicode('S') \
 ,Usb_unicode('B') \
 ,Usb_unicode(' ') \
 ,Usb_unicode('K') \
 ,Usb_unicode('E') \
 ,Usb_unicode('Y') \
 ,Usb_unicode(' ') \
 ,Usb_unicode('C') \
 ,Usb_unicode('O') \
 ,Usb_unicode('M') \
 ,Usb_unicode('P') \
 ,Usb_unicode('O') \
 ,Usb_unicode('S') \
 ,Usb_unicode('I') \
 ,Usb_unicode('T') \
 ,Usb_unicode('E') \
 ,Usb_unicode(' ') \
 ,Usb_unicode('D') \
 ,Usb_unicode('E') \
 ,Usb_unicode('V') \
 ,Usb_unicode('I') \
 ,Usb_unicode('C') \
 ,Usb_unicode('E') \
}

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

#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      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     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 _____________

#if (USB_DEVICE_SN_USE==ENABLE)
//struct usb_st_serial_number
typedef struct {
   U8  bLength;               // size of this descriptor in bytes
   U8  bDescriptorType;       // STRING descriptor type
#if (USE_DEVICE_SN_UNIQUE==ENABLE)

#else   
   U16 wstring[USB_SN_LENGTH];// unicode characters
#endif
} S_usb_serial_number;
#endif


/*_____ 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_interface_descriptor     ifc_mouse;
   S_usb_hid_descriptor           hid_mouse;
   S_usb_endpoint_descriptor      ep1_mouse;
   S_usb_interface_descriptor     ifc_ms;
   S_usb_endpoint_descriptor      ep1_ms;
   S_usb_endpoint_descriptor      ep2_ms;
   S_usb_interface_descriptor     ifc_hid;
   S_usb_hid_descriptor           hid;
   S_usb_endpoint_descriptor      ep1_hid;
   S_usb_endpoint_descriptor      ep2_hid;
} S_usb_user_configuration_descriptor;




#endif

---