Xmega Application Note


usb_descriptors.h File Reference


Detailed Description

This file contains the usb parameters that uniquely identify the CDC application through descriptor tables.

Application note:
AVR1907: Xplain Evaluation Board
Documentation
For comprehensive code documentation, supported compilers, compiler settings and supported devices see readme.html
Author:
Atmel Corporation: http://www.atmel.com
Support email: avr@atmel.com
Revision
3122
Date
2010-01-13 13:26:22 +0100 (on, 13 jan 2010)

Copyright (c) 2010, 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.

THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 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.

Definition in file usb_descriptors.h.

#include "config.h"
#include "usb_standard_request.h"
#include "conf_usb.h"

Include dependency graph for usb_descriptors.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  S_usb_configuration_descriptor
struct  S_usb_device_descriptor
struct  S_usb_device_qualifier_descriptor
struct  S_usb_endpoint_descriptor
struct  S_usb_if0_descript
struct  S_usb_interface_association_descriptor
struct  S_usb_interface_descriptor
struct  S_usb_language_id
struct  S_usb_manufacturer_string_descriptor
struct  S_usb_product_string_descriptor
struct  S_usb_serial_number
struct  S_usb_user_configuration_descriptor
struct  S_UsbRequest

Defines

#define ALTERNATE0   0
#define ALTERNATE1   0
#define CONF_ATTRIBUTES   USB_CONFIG_BUSPOWERED
#define CONF_INDEX   0
#define CONF_NB   1
#define DEVICE_CLASS   0x02
#define DEVICE_PROTOCOL   0x00
#define DEVICE_STATUS   0x00
#define DEVICE_SUB_CLASS   0x00
#define ENDPOINT_NB_1   EP_DIR_IN | TX_EP
#define ENDPOINT_NB_2   EP_DIR_OUT | RX_EP
#define ENDPOINT_NB_3   EP_DIR_IN | INT_EP
#define EP_ATTRIBUTES_1   EP_ATTR_BULK
#define EP_ATTRIBUTES_2   EP_ATTR_BULK
#define EP_ATTRIBUTES_3   EP_ATTR_INTERUPT
#define EP_CONTROL_LENGTH   64
#define EP_INTERVAL_1   0x00
#define EP_INTERVAL_2   0x00
#define EP_INTERVAL_3   0xFF
#define EP_SIZE_1   0x20
#define EP_SIZE_2   0x20
#define EP_SIZE_3   TX_EP_SIZE
#define IF0_INDEX   0x04
#define INTERFACE0_CLASS   0x02
#define INTERFACE0_INDEX   IF0_INDEX
#define INTERFACE0_NB   0
#define INTERFACE0_PROTOCOL   0x01
#define INTERFACE0_SUB_CLASS   0x02
#define INTERFACE1_CLASS   0x0A
#define INTERFACE1_INDEX   IF0_INDEX
#define INTERFACE1_NB   1
#define INTERFACE1_PROTOCOL   0
#define INTERFACE1_SUB_CLASS   0
#define INTERFACE_STATUS   0x00
#define LANG_INDEX   0x00
#define LANGUAGE_ID   0x0409
#define MAN_INDEX   0x01
#define MAX_POWER   250
#define NB_CONFIGURATION   1
#define NB_ENDPOINT0   1
#define NB_ENDPOINT1   2
#define NB_INTERFACE   2
#define PROD_INDEX   0x02
#define PRODUCT_ID   0x210D
#define RELEASE_NUMBER   0x0102
#define SN_INDEX   0x03
#define TX_EP_SIZE   0x20
#define Usb_get_conf_desc_length()   (sizeof (usb_conf_desc))
#define Usb_get_conf_desc_pointer()   (&(usb_conf_desc.cfg.bLength))
#define Usb_get_dev_desc_length()   (sizeof (usb_dev_desc))
#define Usb_get_dev_desc_pointer()   (&(usb_dev_desc.bLength))
#define USB_IF0_DESCRIPT   {'S','e','r','i','a','l',' ','P','o','r','t'}
#define USB_IF0_LENGTH   11
#define USB_MANUFACTURER_NAME   {'A','T','M','E','L'}
#define USB_MN_LENGTH   5
#define USB_PN_LENGTH   18
#define USB_PRODUCT_NAME   {'X','p','l','a','i','n',' ','U','S','B',' ','G','a','t','e','w','a','y'}
#define USB_SERIAL_NUMBER   {'0','0','0','0','0','0','0','0'}
#define USB_SN_LENGTH   8
#define USB_SPECIFICATION   0x0200
#define VENDOR_ID   0x03EB


Define Documentation

#define ALTERNATE0   0

Definition at line 91 of file usb_descriptors.h.

#define ALTERNATE1   0

Definition at line 100 of file usb_descriptors.h.

#define CONF_ATTRIBUTES   USB_CONFIG_BUSPOWERED

Definition at line 86 of file usb_descriptors.h.

#define CONF_INDEX   0

Definition at line 85 of file usb_descriptors.h.

#define CONF_NB   1

Definition at line 84 of file usb_descriptors.h.

#define DEVICE_CLASS   0x02

CDC class

Definition at line 67 of file usb_descriptors.h.

#define DEVICE_PROTOCOL   0x00

Each configuration has its own protocol.

Definition at line 69 of file usb_descriptors.h.

#define DEVICE_STATUS   0x00

Definition at line 127 of file usb_descriptors.h.

Referenced by usb_get_status().

#define DEVICE_SUB_CLASS   0x00

Each configuration has its own sub-class.

Definition at line 68 of file usb_descriptors.h.

#define ENDPOINT_NB_1   EP_DIR_IN | TX_EP

Definition at line 115 of file usb_descriptors.h.

#define ENDPOINT_NB_2   EP_DIR_OUT | RX_EP

Definition at line 121 of file usb_descriptors.h.

#define ENDPOINT_NB_3   EP_DIR_IN | INT_EP

Interrupt IN

Definition at line 109 of file usb_descriptors.h.

#define EP_ATTRIBUTES_1   EP_ATTR_BULK

Definition at line 116 of file usb_descriptors.h.

#define EP_ATTRIBUTES_2   EP_ATTR_BULK

Definition at line 122 of file usb_descriptors.h.

#define EP_ATTRIBUTES_3   EP_ATTR_INTERUPT

Definition at line 110 of file usb_descriptors.h.

#define EP_CONTROL_LENGTH   64

Definition at line 70 of file usb_descriptors.h.

Referenced by usb_get_descriptor().

#define EP_INTERVAL_1   0x00

Definition at line 118 of file usb_descriptors.h.

#define EP_INTERVAL_2   0x00

Definition at line 124 of file usb_descriptors.h.

#define EP_INTERVAL_3   0xFF

Definition at line 112 of file usb_descriptors.h.

#define EP_SIZE_1   0x20

Definition at line 117 of file usb_descriptors.h.

#define EP_SIZE_2   0x20

Definition at line 123 of file usb_descriptors.h.

#define EP_SIZE_3   TX_EP_SIZE

Definition at line 111 of file usb_descriptors.h.

#define IF0_INDEX   0x04

Definition at line 78 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define INTERFACE0_CLASS   0x02

Definition at line 93 of file usb_descriptors.h.

#define INTERFACE0_INDEX   IF0_INDEX

Definition at line 96 of file usb_descriptors.h.

#define INTERFACE0_NB   0

Definition at line 90 of file usb_descriptors.h.

#define INTERFACE0_PROTOCOL   0x01

Definition at line 95 of file usb_descriptors.h.

#define INTERFACE0_SUB_CLASS   0x02

Definition at line 94 of file usb_descriptors.h.

#define INTERFACE1_CLASS   0x0A

Definition at line 102 of file usb_descriptors.h.

#define INTERFACE1_INDEX   IF0_INDEX

Definition at line 105 of file usb_descriptors.h.

#define INTERFACE1_NB   1

Definition at line 99 of file usb_descriptors.h.

#define INTERFACE1_PROTOCOL   0

Definition at line 104 of file usb_descriptors.h.

#define INTERFACE1_SUB_CLASS   0

Definition at line 103 of file usb_descriptors.h.

#define INTERFACE_STATUS   0x00

Definition at line 128 of file usb_descriptors.h.

Referenced by usb_get_status().

#define LANG_INDEX   0x00

Definition at line 74 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define LANGUAGE_ID   0x0409

Definition at line 145 of file usb_descriptors.h.

#define MAN_INDEX   0x01

Definition at line 75 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define MAX_POWER   250

Definition at line 87 of file usb_descriptors.h.

#define NB_CONFIGURATION   1

Definition at line 79 of file usb_descriptors.h.

Referenced by usb_set_configuration().

#define NB_ENDPOINT0   1

Definition at line 92 of file usb_descriptors.h.

#define NB_ENDPOINT1   2

Definition at line 101 of file usb_descriptors.h.

#define NB_INTERFACE   2

Definition at line 83 of file usb_descriptors.h.

#define PROD_INDEX   0x02

Definition at line 76 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define PRODUCT_ID   0x210D

Xplain Product ID = 210Dh

Definition at line 72 of file usb_descriptors.h.

#define RELEASE_NUMBER   0x0102

Definition at line 73 of file usb_descriptors.h.

#define SN_INDEX   0x03

Definition at line 77 of file usb_descriptors.h.

#define TX_EP_SIZE   0x20

Definition at line 108 of file usb_descriptors.h.

 
#define Usb_get_conf_desc_length (  )     (sizeof (usb_conf_desc))

Definition at line 61 of file usb_descriptors.h.

Referenced by usb_get_descriptor().

 
#define Usb_get_conf_desc_pointer (  )     (&(usb_conf_desc.cfg.bLength))

Definition at line 60 of file usb_descriptors.h.

Referenced by usb_get_descriptor().

 
#define Usb_get_dev_desc_length (  )     (sizeof (usb_dev_desc))

Definition at line 59 of file usb_descriptors.h.

Referenced by usb_get_descriptor().

 
#define Usb_get_dev_desc_pointer (  )     (&(usb_dev_desc.bLength))

Definition at line 58 of file usb_descriptors.h.

Referenced by usb_get_descriptor().

#define USB_IF0_DESCRIPT   {'S','e','r','i','a','l',' ','P','o','r','t'}

Definition at line 143 of file usb_descriptors.h.

#define USB_IF0_LENGTH   11

Definition at line 142 of file usb_descriptors.h.

#define USB_MANUFACTURER_NAME   {'A','T','M','E','L'}

Definition at line 134 of file usb_descriptors.h.

#define USB_MN_LENGTH   5

Definition at line 133 of file usb_descriptors.h.

#define USB_PN_LENGTH   18

Definition at line 136 of file usb_descriptors.h.

#define USB_PRODUCT_NAME   {'X','p','l','a','i','n',' ','U','S','B',' ','G','a','t','e','w','a','y'}

Definition at line 137 of file usb_descriptors.h.

#define USB_SERIAL_NUMBER   {'0','0','0','0','0','0','0','0'}

Definition at line 140 of file usb_descriptors.h.

#define USB_SN_LENGTH   8

Definition at line 139 of file usb_descriptors.h.

#define USB_SPECIFICATION   0x0200

Definition at line 66 of file usb_descriptors.h.

#define VENDOR_ID   0x03EB

Atmel vendor ID = 03EBh

Definition at line 71 of file usb_descriptors.h.

@DOC_TITLE@
Generated on Mon Jan 18 09:26:11 2010 for AVR1907 Xplain USB Gateway by doxygen 1.5.5