Classes | Macros | Variables
USB device descriptors for a single interface

Classes

struct  udc_desc_t
 Structure for USB Device Configuration Descriptor. More...
 

Macros

#define USB_DEVICE_EP_CTRL_SIZE   64
 Control endpoint size (Endpoint 0) More...
 
#define USB_DEVICE_NB_INTERFACE   (2*UDI_CDC_PORT_NB)
 Two interfaces for a CDC device. More...
 
#define USB_VERSION   USB_V2_0
 

Variables

COMPILER_WORD_ALIGNED UDC_DESC_STORAGE udc_desc_t udc_desc_fs
 USB Device Configuration Descriptor filled for full and high speed. More...
 
COMPILER_WORD_ALIGNED UDC_DESC_STORAGE usb_dev_desc_t udc_device_desc
 USB Device Descriptor. More...
 

Default endpoint configuration

The USBB, UDP, UDPHS and UOTGHS interfaces can support up to 2 CDC interfaces.

#define UDI_CDC_DATA_EP_IN_0   (1 | USB_EP_DIR_IN)
 
#define UDI_CDC_DATA_EP_OUT_0   (2 | USB_EP_DIR_OUT)
 
#define UDI_CDC_COMM_EP_0   (3 | USB_EP_DIR_IN)
 
#define UDI_CDC_DATA_EP_IN_1   (4 | USB_EP_DIR_IN)
 
#define UDI_CDC_DATA_EP_OUT_1   (5 | USB_EP_DIR_OUT)
 
#define UDI_CDC_COMM_EP_1   (6 | USB_EP_DIR_IN)
 
#define USB_DEVICE_MAX_EP   (3*UDI_CDC_PORT_NB)
 3 endpoints used per CDC interface More...
 

Default Interface numbers

#define UDI_CDC_COMM_IFACE_NUMBER_0   0
 
#define UDI_CDC_DATA_IFACE_NUMBER_0   1
 
#define UDI_CDC_COMM_IFACE_NUMBER_1   2
 
#define UDI_CDC_DATA_IFACE_NUMBER_1   3
 
#define UDI_CDC_COMM_IFACE_NUMBER_2   4
 
#define UDI_CDC_DATA_IFACE_NUMBER_2   5
 
#define UDI_CDC_COMM_IFACE_NUMBER_3   6
 
#define UDI_CDC_DATA_IFACE_NUMBER_3   7
 
#define UDI_CDC_COMM_IFACE_NUMBER_4   8
 
#define UDI_CDC_DATA_IFACE_NUMBER_4   9
 
#define UDI_CDC_COMM_IFACE_NUMBER_5   10
 
#define UDI_CDC_DATA_IFACE_NUMBER_5   11
 
#define UDI_CDC_COMM_IFACE_NUMBER_6   12
 
#define UDI_CDC_DATA_IFACE_NUMBER_6   13
 

UDC structures which content all USB Device definitions

UDC_DESC_STORAGE udi_api_t * udi_apis [USB_DEVICE_NB_INTERFACE]
 Associate an UDI for each USB interface. More...
 
UDC_DESC_STORAGE udc_config_speed_t udc_config_fs [1]
 Add UDI with USB Descriptors FS & HS. More...
 
UDC_DESC_STORAGE udc_config_t udc_config
 Add all information about USB Device in global structure for UDC. More...
 

Detailed Description

The following structures provide the USB device descriptors required for USB Device with a single interface CDC.

It is ready to use and do not require more definition.

Macro Definition Documentation

◆ UDI_CDC_COMM_EP_0

#define UDI_CDC_COMM_EP_0   (3 | USB_EP_DIR_IN)

Definition at line 103 of file udi_cdc_conf.h.

◆ UDI_CDC_COMM_EP_1

#define UDI_CDC_COMM_EP_1   (6 | USB_EP_DIR_IN)

Definition at line 112 of file udi_cdc_conf.h.

◆ UDI_CDC_COMM_IFACE_NUMBER_0

#define UDI_CDC_COMM_IFACE_NUMBER_0   0

Definition at line 125 of file udi_cdc_conf.h.

◆ UDI_CDC_COMM_IFACE_NUMBER_1

#define UDI_CDC_COMM_IFACE_NUMBER_1   2

Definition at line 127 of file udi_cdc_conf.h.

◆ UDI_CDC_COMM_IFACE_NUMBER_2

#define UDI_CDC_COMM_IFACE_NUMBER_2   4

Definition at line 129 of file udi_cdc_conf.h.

◆ UDI_CDC_COMM_IFACE_NUMBER_3

#define UDI_CDC_COMM_IFACE_NUMBER_3   6

Definition at line 131 of file udi_cdc_conf.h.

◆ UDI_CDC_COMM_IFACE_NUMBER_4

#define UDI_CDC_COMM_IFACE_NUMBER_4   8

Definition at line 133 of file udi_cdc_conf.h.

◆ UDI_CDC_COMM_IFACE_NUMBER_5

#define UDI_CDC_COMM_IFACE_NUMBER_5   10

Definition at line 135 of file udi_cdc_conf.h.

◆ UDI_CDC_COMM_IFACE_NUMBER_6

#define UDI_CDC_COMM_IFACE_NUMBER_6   12

Definition at line 137 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_EP_IN_0

#define UDI_CDC_DATA_EP_IN_0   (1 | USB_EP_DIR_IN)

Definition at line 101 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_EP_IN_1

#define UDI_CDC_DATA_EP_IN_1   (4 | USB_EP_DIR_IN)

Definition at line 110 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_EP_OUT_0

#define UDI_CDC_DATA_EP_OUT_0   (2 | USB_EP_DIR_OUT)

Definition at line 102 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_EP_OUT_1

#define UDI_CDC_DATA_EP_OUT_1   (5 | USB_EP_DIR_OUT)

Definition at line 111 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_IFACE_NUMBER_0

#define UDI_CDC_DATA_IFACE_NUMBER_0   1

Definition at line 126 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_IFACE_NUMBER_1

#define UDI_CDC_DATA_IFACE_NUMBER_1   3

Definition at line 128 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_IFACE_NUMBER_2

#define UDI_CDC_DATA_IFACE_NUMBER_2   5

Definition at line 130 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_IFACE_NUMBER_3

#define UDI_CDC_DATA_IFACE_NUMBER_3   7

Definition at line 132 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_IFACE_NUMBER_4

#define UDI_CDC_DATA_IFACE_NUMBER_4   9

Definition at line 134 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_IFACE_NUMBER_5

#define UDI_CDC_DATA_IFACE_NUMBER_5   11

Definition at line 136 of file udi_cdc_conf.h.

◆ UDI_CDC_DATA_IFACE_NUMBER_6

#define UDI_CDC_DATA_IFACE_NUMBER_6   13

Definition at line 138 of file udi_cdc_conf.h.

◆ USB_DEVICE_EP_CTRL_SIZE

#define USB_DEVICE_EP_CTRL_SIZE   64

Control endpoint size (Endpoint 0)

Definition at line 57 of file udi_cdc_conf.h.

◆ USB_DEVICE_MAX_EP

#define USB_DEVICE_MAX_EP   (3*UDI_CDC_PORT_NB)

3 endpoints used per CDC interface

Definition at line 116 of file udi_cdc_conf.h.

◆ USB_DEVICE_NB_INTERFACE

#define USB_DEVICE_NB_INTERFACE   (2*UDI_CDC_PORT_NB)

Two interfaces for a CDC device.

Definition at line 55 of file udi_cdc_desc.c.

◆ USB_VERSION

#define USB_VERSION   USB_V2_0

Definition at line 60 of file udi_cdc_desc.c.

Variable Documentation

◆ udc_config

UDC_DESC_STORAGE udc_config_t udc_config
Initial value:
= {
.confdev_lsfs = &udc_device_desc,
.conf_lsfs = udc_config_fs,
.conf_bos = NULL,
}
udc_config_fs
UDC_DESC_STORAGE udc_config_speed_t udc_config_fs[1]
Add UDI with USB Descriptors FS & HS.
Definition: udi_cdc_desc.c:216
udc_device_desc
COMPILER_WORD_ALIGNED UDC_DESC_STORAGE usb_dev_desc_t udc_device_desc
USB Device Descriptor.
Definition: udi_cdc_desc.c:65
NULL
#define NULL
Definition: nm_bsp.h:52

Add all information about USB Device in global structure for UDC.

Global variables of USB Device Descriptor and UDI links.

Definition at line 228 of file udi_cdc_desc.c.

◆ udc_config_fs

UDC_DESC_STORAGE udc_config_speed_t udc_config_fs[1]
Initial value:
= { {
.desc = (usb_conf_desc_t UDC_DESC_STORAGE*)&udc_desc_fs,
.udi_apis = udi_apis,
}}
usb_conf_desc_t
Standard USB configuration descriptor structure.
Definition: usb_protocol.h:410
udi_apis
UDC_DESC_STORAGE udi_api_t * udi_apis[USB_DEVICE_NB_INTERFACE]
Associate an UDI for each USB interface.
Definition: udi_cdc_desc.c:207
UDC_DESC_STORAGE
#define UDC_DESC_STORAGE
Defines the memory's location of USB descriptors.
Definition: udc_desc.h:70
udc_desc_fs
COMPILER_WORD_ALIGNED UDC_DESC_STORAGE udc_desc_t udc_desc_fs
USB Device Configuration Descriptor filled for full and high speed.
Definition: udi_cdc_desc.c:154

Add UDI with USB Descriptors FS & HS.

Definition at line 216 of file udi_cdc_desc.c.

◆ udc_desc_fs

COMPILER_WORD_ALIGNED UDC_DESC_STORAGE udc_desc_t udc_desc_fs
Initial value:
= {
.conf.bLength = sizeof(usb_conf_desc_t),
.conf.bDescriptorType = USB_DT_CONFIGURATION,
.conf.wTotalLength = LE16(sizeof(udc_desc_t)),
.conf.bNumInterfaces = USB_DEVICE_NB_INTERFACE,
.conf.bConfigurationValue = 1,
.conf.iConfiguration = 0,
.conf.bmAttributes = USB_CONFIG_ATTR_MUST_SET | USB_DEVICE_ATTR,
.conf.bMaxPower = USB_CONFIG_MAX_POWER(USB_DEVICE_POWER),
.udi_cdc_comm_0 = UDI_CDC_COMM_DESC_0,
.udi_cdc_data_0 = UDI_CDC_DATA_DESC_0_FS,
}
USB_DT_CONFIGURATION
Definition: usb_protocol.h:191
USB_DEVICE_ATTR
#define USB_DEVICE_ATTR
Definition: conf_usb.h:58
USB_CONFIG_ATTR_MUST_SET
#define USB_CONFIG_ATTR_MUST_SET
Must always be set.
Definition: usb_protocol.h:422
USB_DEVICE_NB_INTERFACE
#define USB_DEVICE_NB_INTERFACE
Two interfaces for a CDC device.
Definition: udi_cdc_desc.c:55
usb_conf_desc_t
Standard USB configuration descriptor structure.
Definition: usb_protocol.h:410
UDI_CDC_COMM_DESC_0
#define UDI_CDC_COMM_DESC_0
Definition: udi_cdc.h:138
UDI_CDC_DATA_DESC_0_FS
#define UDI_CDC_DATA_DESC_0_FS
Definition: udi_cdc.h:139
USB_DEVICE_POWER
#define USB_DEVICE_POWER
Definition: conf_usb.h:57
LE16
#define LE16(x)
Definition: compiler.h:890
USB_CONFIG_MAX_POWER
#define USB_CONFIG_MAX_POWER(ma)
Max power in mA.
Definition: usb_protocol.h:427
udc_desc_t
Structure for USB Device Configuration Descriptor.
Definition: udi_cdc_desc.c:136

USB Device Configuration Descriptor filled for full and high speed.

Definition at line 154 of file udi_cdc_desc.c.

◆ udc_device_desc

COMPILER_WORD_ALIGNED UDC_DESC_STORAGE usb_dev_desc_t udc_device_desc

USB Device Descriptor.

Definition at line 65 of file udi_cdc_desc.c.

◆ udi_apis

UDC_DESC_STORAGE udi_api_t* udi_apis[USB_DEVICE_NB_INTERFACE]
Initial value:
= {
#define UDI_CDC_API(index, unused)
}

Associate an UDI for each USB interface.

Definition at line 207 of file udi_cdc_desc.c.


inertial_sense_ros
Author(s):
autogenerated on Sun Feb 28 2021 03:18:01