ATMEL: usb_descriptors.h File Reference

- Main Page
- Modules
- Data Structures
- Files
- Related Pages

# usb_descriptors.h File Reference

`#include "config.h"`
`#include "modules/usb/device_chap9/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_UsbRequest
| Usb Request. More...
struct | S_usb_device_descriptor
| Usb Device Descriptor. More...
struct | S_usb_configuration_descriptor
| Usb Configuration Descriptor. More...
struct | S_usb_interface_descriptor
| Usb Interface Descriptor. More...
struct | S_usb_endpoint_descriptor
| Usb Endpoint Descriptor. More...
struct | S_usb_language_id
| Usb Language Descriptor. More...
struct | S_usb_manufacturer_string_descriptor
struct | S_usb_product_string_descriptor
struct | S_usb_serial_number
struct | S_usb_hid_descriptor
struct | S_usb_user_configuration_descriptor

## Defines

#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))
#define | USB_SPECIFICATION 0x0200
#define | DEVICE_CLASS 0
#define | DEVICE_SUB_CLASS 0
#define | DEVICE_PROTOCOL 0
#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
#define | SN_INDEX 0x03
#define | NB_CONFIGURATION 1
#define | NB_INTERFACE 3
#define | CONF_NB 1
#define | CONF_INDEX 0
#define | CONF_ATTRIBUTES USB_CONFIG_BUSPOWERED
#define | MAX_POWER 50
#define | INTERFACE_NB_MOUSE 0
#define | ALTERNATE_MOUSE 0
#define | NB_ENDPOINT_MOUSE 1
#define | INTERFACE_CLASS_MOUSE HID_CLASS
#define | INTERFACE_SUB_CLASS_MOUSE NO_SUBCLASS
#define | INTERFACE_PROTOCOL_MOUSE HID_PROTOCOL_MOUSE
#define | INTERFACE_INDEX_MOUSE 0
#define | ENDPOINT_NB_1 (EP_MOUSE_IN | USB_ENDPOINT_IN)
#define | EP_ATTRIBUTES_1 0x03
#define | EP_IN_LENGTH_1 8
#define | EP_SIZE_1 EP_IN_LENGTH_1
#define | EP_INTERVAL_1 0x25
#define | INTERFACE_NB 1
#define | ALTERNATE 0
#define | NB_ENDPOINT 2
#define | INTERFACE_CLASS MS_CLASS
#define | INTERFACE_SUB_CLASS MS_SUB_CLASS6
#define | INTERFACE_PROTOCOL MS_PROTOCOL
#define | INTERFACE_INDEX 0
#define | ENDPOINT_NB_2 (EP_MS_IN | USB_ENDPOINT_IN)
#define | EP_ATTRIBUTES_2 0x02
#define | EP_IN_LENGTH 64
#define | EP_SIZE_2 EP_IN_LENGTH
#define | EP_INTERVAL_2 0x00
#define | ENDPOINT_NB_3 EP_MS_OUT
#define | EP_ATTRIBUTES_3 0x02
#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
#define | INTERFACE_NB_HID 2
#define | ALTERNATE 0
#define | NB_ENDPOINT 2
#define | INTERFACE_CLASS_HID HID_CLASS
#define | INTERFACE_SUB_CLASS_HID NO_SUBCLASS
#define | INTERFACE_PROTOCOL_HID NO_PROTOCOL
#define | INTERFACE_INDEX 0
#define | ENDPOINT_NB_4 (EP_HID_IN | USB_ENDPOINT_IN)
#define | EP_ATTRIBUTES_4 0x03
#define | EP_IN_LENGTH_4 8
#define | EP_SIZE_4 EP_IN_LENGTH_4
#define | EP_INTERVAL_4 20
#define | ENDPOINT_NB_5 (EP_HID_OUT)
#define | EP_ATTRIBUTES_5 0x03
#define | EP_OUT_LENGTH_5 8
#define | EP_SIZE_5 EP_OUT_LENGTH_5
#define | EP_INTERVAL_5 20
#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
#define | USB_PN_LENGTH 28
#define | USB_PRODUCT_NAME
#define | USB_SN_LENGTH 0x0D
#define | USB_SERIAL_NUMBER
#define | LANGUAGE_ID 0x0409

## Detailed Description

USB Identifers.

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

- Compiler: IAR EWAVR and GNU GCC for AVR
- Supported devices: AT90USB1287, AT90USB1286, AT90USB647, AT90USB646

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

Definition in file usb_descriptors.h.

## Define Documentation

#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_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_conf_desc_pointer | ( |  | ) | (&(usb_conf_desc.cfg_mouse.bLength))

Definition at line 60 of file usb_descriptors.h.

Referenced by usb_get_descriptor().

#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_SPECIFICATION 0x0200

Definition at line 66 of file usb_descriptors.h.

#define DEVICE_CLASS 0

Definition at line 67 of file usb_descriptors.h.

#define DEVICE_SUB_CLASS 0

Definition at line 68 of file usb_descriptors.h.

#define DEVICE_PROTOCOL 0

Definition at line 69 of file usb_descriptors.h.

#define EP_CONTROL_LENGTH 64

Definition at line 70 of file usb_descriptors.h.

Referenced by hid_get_hid_descriptor(), hid_get_report_descriptor(), and usb_get_descriptor().

#define VENDOR_ID VID_ATMEL

Definition at line 71 of file usb_descriptors.h.

#define PRODUCT_ID PID_AT90USB128_64_MS_HIDMS_HID_STK525

Definition at line 72 of file usb_descriptors.h.

#define RELEASE_NUMBER 0x1000

Definition at line 73 of file usb_descriptors.h.

#define MAN_INDEX 0x01

Definition at line 74 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define PROD_INDEX 0x02

Definition at line 75 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define SN_INDEX 0x03

Definition at line 77 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define NB_CONFIGURATION 1

Definition at line 81 of file usb_descriptors.h.

Referenced by usb_set_configuration().

#define NB_INTERFACE 3

Definition at line 84 of file usb_descriptors.h.

#define CONF_NB 1

Definition at line 85 of file usb_descriptors.h.

#define CONF_INDEX 0

Definition at line 86 of file usb_descriptors.h.

#define CONF_ATTRIBUTES USB_CONFIG_BUSPOWERED

Definition at line 87 of file usb_descriptors.h.

#define MAX_POWER 50

Definition at line 88 of file usb_descriptors.h.

#define INTERFACE_NB_MOUSE 0

Definition at line 91 of file usb_descriptors.h.

Referenced by hid_get_hid_descriptor(), hid_get_report_descriptor(), and usb_user_interface_reset().

#define ALTERNATE_MOUSE 0

Definition at line 92 of file usb_descriptors.h.

#define NB_ENDPOINT_MOUSE 1

Definition at line 93 of file usb_descriptors.h.

#define INTERFACE_CLASS_MOUSE HID_CLASS

Definition at line 94 of file usb_descriptors.h.

#define INTERFACE_SUB_CLASS_MOUSE NO_SUBCLASS

Definition at line 95 of file usb_descriptors.h.

#define INTERFACE_PROTOCOL_MOUSE HID_PROTOCOL_MOUSE

Definition at line 96 of file usb_descriptors.h.

#define INTERFACE_INDEX_MOUSE 0

Definition at line 97 of file usb_descriptors.h.

#define ENDPOINT_NB_1 (EP_MOUSE_IN | USB_ENDPOINT_IN)

Definition at line 100 of file usb_descriptors.h.

#define EP_ATTRIBUTES_1 0x03

Definition at line 101 of file usb_descriptors.h.

#define EP_IN_LENGTH_1 8

Definition at line 102 of file usb_descriptors.h.

#define EP_SIZE_1 EP_IN_LENGTH_1

Definition at line 103 of file usb_descriptors.h.

#define EP_INTERVAL_1 0x25

Definition at line 104 of file usb_descriptors.h.

#define INTERFACE_NB 1

Definition at line 108 of file usb_descriptors.h.

Referenced by usb_user_interface_reset(), and usb_user_read_request().

#define ALTERNATE 0

Definition at line 135 of file usb_descriptors.h.

#define NB_ENDPOINT 2

Definition at line 136 of file usb_descriptors.h.

#define INTERFACE_CLASS MS_CLASS

Definition at line 111 of file usb_descriptors.h.

#define INTERFACE_SUB_CLASS MS_SUB_CLASS6

Definition at line 112 of file usb_descriptors.h.

#define INTERFACE_PROTOCOL MS_PROTOCOL

Definition at line 113 of file usb_descriptors.h.

#define INTERFACE_INDEX 0

Definition at line 140 of file usb_descriptors.h.

#define ENDPOINT_NB_2 (EP_MS_IN | USB_ENDPOINT_IN)

Definition at line 117 of file usb_descriptors.h.

#define EP_ATTRIBUTES_2 0x02

Definition at line 118 of file usb_descriptors.h.

#define EP_IN_LENGTH 64

Definition at line 127 of file usb_descriptors.h.

#define EP_SIZE_2 EP_IN_LENGTH

Definition at line 120 of file usb_descriptors.h.

#define EP_INTERVAL_2 0x00

Definition at line 121 of file usb_descriptors.h.

#define ENDPOINT_NB_3 EP_MS_OUT

Definition at line 125 of file usb_descriptors.h.

#define EP_ATTRIBUTES_3 0x02

Definition at line 126 of file usb_descriptors.h.

#define EP_IN_LENGTH 64

Definition at line 127 of file usb_descriptors.h.

#define EP_SIZE_3 EP_IN_LENGTH

Definition at line 128 of file usb_descriptors.h.

#define EP_INTERVAL_3 0x00

Definition at line 129 of file usb_descriptors.h.

#define DEVICE_STATUS USB_DEVICE_STATUS_BUS_POWERED

Definition at line 131 of file usb_descriptors.h.

#define INTERFACE_NB_HID 2

Definition at line 134 of file usb_descriptors.h.

Referenced by usb_user_interface_reset().

#define ALTERNATE 0

Definition at line 135 of file usb_descriptors.h.

#define NB_ENDPOINT 2

Definition at line 136 of file usb_descriptors.h.

#define INTERFACE_CLASS_HID HID_CLASS

Definition at line 137 of file usb_descriptors.h.

#define INTERFACE_SUB_CLASS_HID NO_SUBCLASS

Definition at line 138 of file usb_descriptors.h.

#define INTERFACE_PROTOCOL_HID NO_PROTOCOL

Definition at line 139 of file usb_descriptors.h.

#define INTERFACE_INDEX 0

Definition at line 140 of file usb_descriptors.h.

#define ENDPOINT_NB_4 (EP_HID_IN | USB_ENDPOINT_IN)

Definition at line 143 of file usb_descriptors.h.

#define EP_ATTRIBUTES_4 0x03

Definition at line 144 of file usb_descriptors.h.

#define EP_IN_LENGTH_4 8

Definition at line 145 of file usb_descriptors.h.

#define EP_SIZE_4 EP_IN_LENGTH_4

Definition at line 146 of file usb_descriptors.h.

#define EP_INTERVAL_4 20

Definition at line 147 of file usb_descriptors.h.

#define ENDPOINT_NB_5 (EP_HID_OUT)

Definition at line 150 of file usb_descriptors.h.

#define EP_ATTRIBUTES_5 0x03

Definition at line 151 of file usb_descriptors.h.

#define EP_OUT_LENGTH_5 8

Definition at line 152 of file usb_descriptors.h.

#define EP_SIZE_5 EP_OUT_LENGTH_5

Definition at line 153 of file usb_descriptors.h.

#define EP_INTERVAL_5 20

Definition at line 154 of file usb_descriptors.h.

#define SIZE_OF_REPORT_HID 0x35

Definition at line 156 of file usb_descriptors.h.

#define LENGTH_OF_REPORT_IN 0x08

Definition at line 157 of file usb_descriptors.h.

#define LENGTH_OF_REPORT_OUT 0x08

Definition at line 158 of file usb_descriptors.h.

#define LANG_ID 0x00

Definition at line 160 of file usb_descriptors.h.

Referenced by usb_user_get_descriptor().

#define USB_MN_LENGTH 5

Definition at line 162 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 163 of file usb_descriptors.h.

#define USB_PN_LENGTH 28

Definition at line 171 of file usb_descriptors.h.

#define USB_PRODUCT_NAME

Value:

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

Definition at line 172 of file usb_descriptors.h.

#define USB_SN_LENGTH 0x0D

Definition at line 203 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('0') \
    }

Definition at line 205 of file usb_descriptors.h.

#define LANGUAGE_ID 0x0409

Definition at line 221 of file usb_descriptors.h.