USB device descriptors for a single interface

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

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

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

Macros
#define	UDI_VENDOR_EP_BULK_IN   (1 | USB_EP_DIR_IN)
#define	UDI_VENDOR_EP_BULK_OUT   (2 | USB_EP_DIR_OUT)
#define	UDI_VENDOR_EP_INTERRUPT_IN   (3 | USB_EP_DIR_IN)
	Endpoint numbers used by vendor interface. More...
#define	UDI_VENDOR_EP_INTERRUPT_OUT   (6 | USB_EP_DIR_OUT)
#define	UDI_VENDOR_EP_ISO_IN   (4 | USB_EP_DIR_IN)
#define	UDI_VENDOR_EP_ISO_OUT   (5 | USB_EP_DIR_OUT)
#define	UDI_VENDOR_IFACE_NUMBER   0
	Interface number is 0 because it is the unique interface. More...
#define	USB_DEVICE_EP_CTRL_SIZE   64
	Control endpoint size. More...
#define	USB_DEVICE_NB_INTERFACE   1
	Only one interface for this device. More...

Variables
UDC_DESC_STORAGE udc_desc_t	udc_desc_fs
	USB Device Configuration Descriptor filled for FS. More...
UDC_DESC_STORAGE udc_desc_t	udc_desc_hs
	USB Device Configuration Descriptor filled for HS. More...
UDC_DESC_STORAGE usb_dev_desc_t	udc_device_desc
	USB Device Descriptor. More...
UDC_DESC_STORAGE usb_dev_qual_desc_t	udc_device_qual
	USB Device Qualifier Descriptor for HS. More...

UDC structures which contains 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_lsfs [1]
	Add UDI with USB Descriptors FS. More...
UDC_DESC_STORAGE udc_config_speed_t	udc_config_hs [1]
	Add UDI with USB Descriptors HS. More...
UDC_DESC_STORAGE udc_config_t	udc_config
	Add all information about USB Device in global structure for UDC. More...

UDD Configuration
#define	UDI_VENDOR_EP_NB_INT   ((UDI_VENDOR_EPS_SIZE_INT_FS)?2:0)
	Maximum 6 endpoints used by vendor interface. More...
#define	UDI_VENDOR_EP_NB_BULK   ((UDI_VENDOR_EPS_SIZE_BULK_FS)?2:0)
#define	UDI_VENDOR_EP_NB_ISO   ((UDI_VENDOR_EPS_SIZE_ISO_FS)?2:0)
#define	USB_DEVICE_MAX_EP   (UDI_VENDOR_EP_NB_INT+UDI_VENDOR_EP_NB_BULK+UDI_VENDOR_EP_NB_ISO)

#define UDI_VENDOR_EP_BULK_IN   (1 | USB_EP_DIR_IN)

Referenced by udi_vendor_bulk_in_run().

#define UDI_VENDOR_EP_BULK_OUT   (2 | USB_EP_DIR_OUT)

Referenced by udi_vendor_bulk_out_run().

#define UDI_VENDOR_EP_INTERRUPT_IN   (3 | USB_EP_DIR_IN)

Endpoint numbers used by vendor interface.

Note: The order of endpoint can depend on USB hardware capability when a specific mapping is used on USB DPRAM.

Referenced by udi_vendor_interrupt_in_run().

#define UDI_VENDOR_EP_INTERRUPT_OUT   (6 | USB_EP_DIR_OUT)

Referenced by udi_vendor_interrupt_out_run().

#define UDI_VENDOR_EP_ISO_IN   (4 | USB_EP_DIR_IN)

#define UDI_VENDOR_EP_ISO_OUT   (5 | USB_EP_DIR_OUT)

#define UDI_VENDOR_EP_NB_BULK   ((UDI_VENDOR_EPS_SIZE_BULK_FS)?2:0)

#define UDI_VENDOR_EP_NB_INT   ((UDI_VENDOR_EPS_SIZE_INT_FS)?2:0)

Maximum 6 endpoints used by vendor interface.

#define UDI_VENDOR_EP_NB_ISO   ((UDI_VENDOR_EPS_SIZE_ISO_FS)?2:0)

#define UDI_VENDOR_IFACE_NUMBER   0

Interface number is 0 because it is the unique interface.

#define USB_DEVICE_EP_CTRL_SIZE   64

Control endpoint size.

Referenced by udd_ctrl_in_sent(), udd_ctrl_out_received(), and udd_reset_ep_ctrl().

#define USB_DEVICE_MAX_EP   (UDI_VENDOR_EP_NB_INT+UDI_VENDOR_EP_NB_BULK+UDI_VENDOR_EP_NB_ISO)

Referenced by udd_ep_alloc(), udd_ep_clear_halt(), udd_ep_free(), udd_ep_interrupt(), udd_ep_job_table_kill(), udd_ep_job_table_reset(), udd_ep_run(), udd_ep_set_halt(), and udd_ep_wait_stall_clear().

#define USB_DEVICE_NB_INTERFACE   1

Only one interface for this device.

UDC_DESC_STORAGE udc_config_t udc_config

Initial value:

= {
    .confdev_lsfs = &udc_device_desc,
    .conf_lsfs = udc_config_lsfs,

    .confdev_hs = &udc_device_desc,
    .qualifier = &udc_device_qual,
    .conf_hs = udc_config_hs,

}

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

Global variables of USB Device Descriptor and UDI links.

Referenced by udc_req_std_dev_get_descriptor(), and udc_req_std_dev_set_configuration().

UDC_DESC_STORAGE udc_config_speed_t udc_config_hs[1]

Initial value:

= {{
    .desc          = (usb_conf_desc_t UDC_DESC_STORAGE*)&udc_desc_hs,
    .udi_apis      = udi_apis,
}}

Add UDI with USB Descriptors HS.

UDC_DESC_STORAGE udc_config_speed_t udc_config_lsfs[1]

Initial value:

= {{
    .desc          = (usb_conf_desc_t UDC_DESC_STORAGE*)&udc_desc_fs,
    .udi_apis      = udi_apis,
}}

Add UDI with USB Descriptors FS.

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_vendor                = UDI_VENDOR_DESC_FS,
}

USB Device Configuration Descriptor filled for FS.

UDC_DESC_STORAGE udc_desc_t udc_desc_hs

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_vendor                = UDI_VENDOR_DESC_HS,
}

USB Device Configuration Descriptor filled for HS.

UDC_DESC_STORAGE usb_dev_desc_t udc_device_desc

Initial value:

= {
    .bLength                   = sizeof(usb_dev_desc_t),
    .bDescriptorType           = USB_DT_DEVICE,
    .bcdUSB                    = LE16(USB_V2_0),
    .bDeviceClass              = 0,
    .bDeviceSubClass           = 0,
    .bDeviceProtocol           = 0,
    .bMaxPacketSize0           = USB_DEVICE_EP_CTRL_SIZE,
    .idVendor                  = LE16(USB_DEVICE_VENDOR_ID),
    .idProduct                 = LE16(USB_DEVICE_PRODUCT_ID),
    .bcdDevice                 = LE16((USB_DEVICE_MAJOR_VERSION << 8)
        | USB_DEVICE_MINOR_VERSION),

    .iManufacturer             = 1,




    .iProduct                  = 2,






    .iSerialNumber             = 0,  

    .bNumConfigurations        = 1
}

USB Device Descriptor.

UDC_DESC_STORAGE usb_dev_qual_desc_t udc_device_qual

Initial value:

= {
    .bLength                   = sizeof(usb_dev_qual_desc_t),
    .bDescriptorType           = USB_DT_DEVICE_QUALIFIER,
    .bcdUSB                    = LE16(USB_V2_0),
    .bDeviceClass              = 0,
    .bDeviceSubClass           = 0,
    .bDeviceProtocol           = 0,
    .bMaxPacketSize0           = USB_DEVICE_EP_CTRL_SIZE,
    .bNumConfigurations        = 1
}

USB Device Qualifier Descriptor for HS.

UDC_DESC_STORAGE udi_api_t* udi_apis[USB_DEVICE_NB_INTERFACE]

Initial value:

= {
    &udi_api_vendor,
}

Associate an UDI for each USB interface.