usb_descriptors.h File Reference

Detailed Description

USB identifiers.

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

Compiler: IAR EWAVR32 and GNU GCC for AVR32
Supported devices: All AVR32 devices with a USB module can be used.
AppNote:

Author:: Atmel Corporation: http://www.atmel.com
Support and FAQ: http://support.atmel.no/

#include "conf_usb.h"
#include "usb_standard_request.h"
#include "usb_task.h"

Go to the source code of this file.

Data Structures

struct S_usb_configuration_descriptor

USB Configuration Descriptor. More...

struct S_usb_device_descriptor

USB Device Descriptor. More...

struct S_usb_device_qualifier_descriptor

USB Device Qualifier Descriptor. More...

struct S_usb_endpoint_descriptor

USB Endpoint Descriptor. More...

struct S_usb_interface_descriptor

USB Interface Descriptor. More...

struct S_usb_language_id

USB Language Descriptor. More...

struct S_usb_manufacturer_string_descriptor

struct usb_st_manufacturer More...

struct S_usb_product_string_descriptor

struct usb_st_product More...

struct S_usb_serial_number

struct usb_st_serial_number More...

struct S_usb_user_configuration_descriptor

struct S_UsbRequest

USB Request. More...

Defines

#define ALTERNATE   0

#define CONF_ATTRIBUTES   USB_CONFIG_SELFPOWERED

#define CONF_INDEX   0

#define CONF_NB   1

#define DEVICE_CLASS   0

#define DEVICE_PROTOCOL   0

#define DEVICE_STATUS   SELF_POWERED

#define DEVICE_SUB_CLASS   0

#define ENDPOINT_NB_1   (EP_MS_IN | MSK_EP_DIR)

#define ENDPOINT_NB_2   EP_MS_OUT

#define EP_ATTRIBUTES_1   TYPE_BULK

#define EP_ATTRIBUTES_2   TYPE_BULK

#define EP_CONTROL_LENGTH   64

#define EP_IN_LENGTH_1_FS   64

#define EP_IN_LENGTH_1_HS   512

#define EP_INTERVAL_1   0x00

#define EP_INTERVAL_2   0x00

#define EP_OUT_LENGTH_2_FS   64

#define EP_OUT_LENGTH_2_HS   512

#define EP_SIZE_1_FS   EP_IN_LENGTH_1_FS

#define EP_SIZE_1_HS   EP_IN_LENGTH_1_HS

#define EP_SIZE_2_FS   EP_OUT_LENGTH_2_FS

#define EP_SIZE_2_HS   EP_OUT_LENGTH_2_HS

#define INTERFACE_CLASS   MS_CLASS

#define INTERFACE_INDEX   0

#define INTERFACE_NB   0

#define INTERFACE_PROTOCOL   BULK_PROTOCOL

#define INTERFACE_STATUS   0x00

#define INTERFACE_SUB_CLASS   SCSI_SUBCLASS

#define LANG_ID   0x00

#define LANGUAGE_ID   0x0409

#define MAN_INDEX   0x01

#define MAX_POWER   50

#define NB_CONFIGURATION   1

#define NB_ENDPOINT   2

#define NB_INTERFACE   1

#define PROD_INDEX   0x02

#define PRODUCT_ID   MS_EXAMPLE_PID

#define RELEASE_NUMBER   0x1000

#define SN_INDEX   0x03

#define Usb_get_conf_desc_fs_length()   (sizeof(usb_conf_desc_fs))

#define Usb_get_conf_desc_fs_pointer()   (&(usb_conf_desc_fs.cfg.bLength))

#define Usb_get_conf_desc_hs_length()   (sizeof(usb_conf_desc_hs))

#define Usb_get_conf_desc_hs_pointer()   (&(usb_conf_desc_hs.cfg.bLength))

#define Usb_get_conf_desc_length()   Usb_get_conf_desc_fs_length()

#define Usb_get_conf_desc_pointer()   Usb_get_conf_desc_fs_pointer()

#define Usb_get_dev_desc_length()   (sizeof(usb_dev_desc))

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

#define Usb_get_qualifier_desc_length()   (sizeof(usb_qualifier_desc))

#define Usb_get_qualifier_desc_pointer()   (&(usb_qualifier_desc.bLength))

#define USB_MANUFACTURER_NAME

#define USB_MN_LENGTH   5

#define USB_PN_LENGTH   22

#define USB_PRODUCT_NAME

#define USB_SERIAL_NUMBER

#define USB_SN_LENGTH   13

#define USB_SPECIFICATION   0x0200

#define Usb_unicode(c)   (Usb_format_mcu_to_usb_data(16, (U16)(c)))

#define VENDOR_ID   ATMEL_VID

Define Documentation

#define ALTERNATE 0

Definition at line 106 of file usb_descriptors.h.

#define CONF_ATTRIBUTES USB_CONFIG_SELFPOWERED

Definition at line 101 of file usb_descriptors.h.

#define CONF_INDEX 0

Definition at line 100 of file usb_descriptors.h.

#define CONF_NB 1

Definition at line 99 of file usb_descriptors.h.

#define DEVICE_CLASS 0

Definition at line 85 of file usb_descriptors.h.

#define DEVICE_PROTOCOL 0

Definition at line 87 of file usb_descriptors.h.

#define DEVICE_STATUS SELF_POWERED

Definition at line 131 of file usb_descriptors.h.

#define DEVICE_SUB_CLASS 0

Definition at line 86 of file usb_descriptors.h.

#define ENDPOINT_NB_1 (EP_MS_IN | MSK_EP_DIR)

Definition at line 114 of file usb_descriptors.h.

#define ENDPOINT_NB_2 EP_MS_OUT

Definition at line 123 of file usb_descriptors.h.

#define EP_ATTRIBUTES_1 TYPE_BULK

Definition at line 115 of file usb_descriptors.h.

Referenced by usb_user_endpoint_init().

#define EP_ATTRIBUTES_2 TYPE_BULK

Definition at line 124 of file usb_descriptors.h.

Referenced by usb_user_endpoint_init().

#define EP_CONTROL_LENGTH 64

Definition at line 88 of file usb_descriptors.h.

#define EP_IN_LENGTH_1_FS 64

Definition at line 116 of file usb_descriptors.h.

#define EP_IN_LENGTH_1_HS 512

Definition at line 118 of file usb_descriptors.h.

#define EP_INTERVAL_1 0x00

Definition at line 120 of file usb_descriptors.h.

#define EP_INTERVAL_2 0x00

Definition at line 129 of file usb_descriptors.h.

#define EP_OUT_LENGTH_2_FS 64

Definition at line 125 of file usb_descriptors.h.

#define EP_OUT_LENGTH_2_HS 512

Definition at line 127 of file usb_descriptors.h.

#define EP_SIZE_1_FS EP_IN_LENGTH_1_FS

Definition at line 117 of file usb_descriptors.h.

Referenced by usb_user_endpoint_init().

#define EP_SIZE_1_HS EP_IN_LENGTH_1_HS

Definition at line 119 of file usb_descriptors.h.

Referenced by usb_user_endpoint_init().

#define EP_SIZE_2_FS EP_OUT_LENGTH_2_FS

Definition at line 126 of file usb_descriptors.h.

Referenced by usb_user_endpoint_init().

#define EP_SIZE_2_HS EP_OUT_LENGTH_2_HS

Definition at line 128 of file usb_descriptors.h.

Referenced by usb_user_endpoint_init().

#define INTERFACE_CLASS MS_CLASS

Definition at line 108 of file usb_descriptors.h.

#define INTERFACE_INDEX 0

Definition at line 111 of file usb_descriptors.h.

#define INTERFACE_NB 0

Definition at line 105 of file usb_descriptors.h.

Referenced by usb_user_read_request().

#define INTERFACE_PROTOCOL BULK_PROTOCOL

Definition at line 110 of file usb_descriptors.h.

#define INTERFACE_STATUS 0x00

Definition at line 132 of file usb_descriptors.h.

#define INTERFACE_SUB_CLASS SCSI_SUBCLASS

Definition at line 109 of file usb_descriptors.h.

#define LANG_ID 0x00

Definition at line 134 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define LANGUAGE_ID 0x0409

Definition at line 191 of file usb_descriptors.h.

#define MAN_INDEX 0x01

Definition at line 92 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define MAX_POWER 50

Definition at line 102 of file usb_descriptors.h.

#define NB_CONFIGURATION 1

Definition at line 95 of file usb_descriptors.h.

#define NB_ENDPOINT 2

Definition at line 107 of file usb_descriptors.h.

#define NB_INTERFACE 1

Definition at line 98 of file usb_descriptors.h.

#define PROD_INDEX 0x02

Definition at line 93 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define PRODUCT_ID MS_EXAMPLE_PID

Definition at line 90 of file usb_descriptors.h.

#define RELEASE_NUMBER 0x1000

Definition at line 91 of file usb_descriptors.h.

#define SN_INDEX 0x03

Definition at line 94 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define Usb_get_conf_desc_fs_length ( ) (sizeof(usb_conf_desc_fs))

Definition at line 76 of file usb_descriptors.h.

#define Usb_get_conf_desc_fs_pointer ( ) (&(usb_conf_desc_fs.cfg.bLength))

Definition at line 75 of file usb_descriptors.h.

#define Usb_get_conf_desc_hs_length ( ) (sizeof(usb_conf_desc_hs))

Definition at line 74 of file usb_descriptors.h.

#define Usb_get_conf_desc_hs_pointer ( ) (&(usb_conf_desc_hs.cfg.bLength))

Definition at line 73 of file usb_descriptors.h.

#define Usb_get_conf_desc_length ( ) Usb_get_conf_desc_fs_length()

Definition at line 72 of file usb_descriptors.h.

#define Usb_get_conf_desc_pointer ( ) Usb_get_conf_desc_fs_pointer()

Definition at line 71 of file usb_descriptors.h.

#define Usb_get_dev_desc_length ( ) (sizeof(usb_dev_desc))

Definition at line 70 of file usb_descriptors.h.

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

Definition at line 69 of file usb_descriptors.h.

#define Usb_get_qualifier_desc_length ( ) (sizeof(usb_qualifier_desc))

Definition at line 78 of file usb_descriptors.h.

#define Usb_get_qualifier_desc_pointer ( ) (&(usb_qualifier_desc.bLength))

Definition at line 77 of file usb_descriptors.h.

#define USB_MANUFACTURER_NAME

Value:

{\
  Usb_unicode('A'),\
  Usb_unicode('T'),\
  Usb_unicode('M'),\
  Usb_unicode('E'),\
  Usb_unicode('L') \
}

Definition at line 137 of file usb_descriptors.h.

#define USB_MN_LENGTH 5

Definition at line 136 of file usb_descriptors.h.

#define USB_PN_LENGTH 22

Definition at line 146 of file usb_descriptors.h.

#define USB_PRODUCT_NAME

Value:

{\
  Usb_unicode('A'),\
  Usb_unicode('V'),\
  Usb_unicode('R'),\
  Usb_unicode('3'),\
  Usb_unicode('2'),\
  Usb_unicode(' '),\
  Usb_unicode('U'),\
  Usb_unicode('C'),\
  Usb_unicode('3'),\
  Usb_unicode(' '),\
  Usb_unicode('M'),\
  Usb_unicode('A'),\
  Usb_unicode('S'),\
  Usb_unicode('S'),\
  Usb_unicode(' '),\
  Usb_unicode('S'),\
  Usb_unicode('T'),\
  Usb_unicode('O'),\
  Usb_unicode('R'),\
  Usb_unicode('A'),\
  Usb_unicode('G'),\
  Usb_unicode('E') \
}

Definition at line 147 of file usb_descriptors.h.

#define USB_SERIAL_NUMBER

Value:

{\
  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('1') \
}

Definition at line 174 of file usb_descriptors.h.

#define USB_SN_LENGTH 13

Definition at line 173 of file usb_descriptors.h.

#define USB_SPECIFICATION 0x0200

Definition at line 84 of file usb_descriptors.h.

#define Usb_unicode ( c ) (Usb_format_mcu_to_usb_data(16, (U16)(c)))

Definition at line 68 of file usb_descriptors.h.

#define VENDOR_ID ATMEL_VID

Definition at line 89 of file usb_descriptors.h.


Data Structures
struct	S_usb_configuration_descriptor
	USB Configuration Descriptor. More...
struct	S_usb_device_descriptor
	USB Device Descriptor. More...
struct	S_usb_device_qualifier_descriptor
	USB Device Qualifier Descriptor. More...
struct	S_usb_endpoint_descriptor
	USB Endpoint Descriptor. More...
struct	S_usb_interface_descriptor
	USB Interface Descriptor. More...
struct	S_usb_language_id
	USB Language Descriptor. More...
struct	S_usb_manufacturer_string_descriptor
	struct usb_st_manufacturer More...
struct	S_usb_product_string_descriptor
	struct usb_st_product More...
struct	S_usb_serial_number
	struct usb_st_serial_number More...
struct	S_usb_user_configuration_descriptor
struct	S_UsbRequest
	USB Request. More...
Defines
#define	ALTERNATE 0
#define	CONF_ATTRIBUTES USB_CONFIG_SELFPOWERED
#define	CONF_INDEX 0
#define	CONF_NB 1
#define	DEVICE_CLASS 0
#define	DEVICE_PROTOCOL 0
#define	DEVICE_STATUS SELF_POWERED
#define	DEVICE_SUB_CLASS 0
#define	ENDPOINT_NB_1 (EP_MS_IN \| MSK_EP_DIR)
#define	ENDPOINT_NB_2 EP_MS_OUT
#define	EP_ATTRIBUTES_1 TYPE_BULK
#define	EP_ATTRIBUTES_2 TYPE_BULK
#define	EP_CONTROL_LENGTH 64
#define	EP_IN_LENGTH_1_FS 64
#define	EP_IN_LENGTH_1_HS 512
#define	EP_INTERVAL_1 0x00
#define	EP_INTERVAL_2 0x00
#define	EP_OUT_LENGTH_2_FS 64
#define	EP_OUT_LENGTH_2_HS 512
#define	EP_SIZE_1_FS EP_IN_LENGTH_1_FS
#define	EP_SIZE_1_HS EP_IN_LENGTH_1_HS
#define	EP_SIZE_2_FS EP_OUT_LENGTH_2_FS
#define	EP_SIZE_2_HS EP_OUT_LENGTH_2_HS
#define	INTERFACE_CLASS MS_CLASS
#define	INTERFACE_INDEX 0
#define	INTERFACE_NB 0
#define	INTERFACE_PROTOCOL BULK_PROTOCOL
#define	INTERFACE_STATUS 0x00
#define	INTERFACE_SUB_CLASS SCSI_SUBCLASS
#define	LANG_ID 0x00
#define	LANGUAGE_ID 0x0409
#define	MAN_INDEX 0x01
#define	MAX_POWER 50
#define	NB_CONFIGURATION 1
#define	NB_ENDPOINT 2
#define	NB_INTERFACE 1
#define	PROD_INDEX 0x02
#define	PRODUCT_ID MS_EXAMPLE_PID
#define	RELEASE_NUMBER 0x1000
#define	SN_INDEX 0x03
#define	Usb_get_conf_desc_fs_length() (sizeof(usb_conf_desc_fs))
#define	Usb_get_conf_desc_fs_pointer() (&(usb_conf_desc_fs.cfg.bLength))
#define	Usb_get_conf_desc_hs_length() (sizeof(usb_conf_desc_hs))
#define	Usb_get_conf_desc_hs_pointer() (&(usb_conf_desc_hs.cfg.bLength))
#define	Usb_get_conf_desc_length() Usb_get_conf_desc_fs_length()
#define	Usb_get_conf_desc_pointer() Usb_get_conf_desc_fs_pointer()
#define	Usb_get_dev_desc_length() (sizeof(usb_dev_desc))
#define	Usb_get_dev_desc_pointer() (&(usb_dev_desc.bLength))
#define	Usb_get_qualifier_desc_length() (sizeof(usb_qualifier_desc))
#define	Usb_get_qualifier_desc_pointer() (&(usb_qualifier_desc.bLength))
#define	USB_MANUFACTURER_NAME
#define	USB_MN_LENGTH 5
#define	USB_PN_LENGTH 22
#define	USB_PRODUCT_NAME
#define	USB_SERIAL_NUMBER
#define	USB_SN_LENGTH 13
#define	USB_SPECIFICATION 0x0200
#define	Usb_unicode(c) (Usb_format_mcu_to_usb_data(16, (U16)(c)))
#define	VENDOR_ID ATMEL_VID