Structures

Structures of USB Host component. More...

Structures
struct	USBH_PIPE
	USB Host Pipe settings structure. More...
struct	USBH_DEV
	USB Host Device Instance (DEV) structure. More...
struct	USBH_DEV.state
struct	usbHID_MouseState
	Mouse state information. More...
struct	USB_SETUP_PACKET
	USB Setup Packet. More...
struct	CDC_LINE_CODING
	CDC Line Coding structure. More...

Description

Structures of USB Host component.

---

Data Structure Documentation

struct USBH_PIPE

USB Host Pipe settings structure.

Used in

• Function: USBH_PipeCreate; USBH_PipeModify; USBH_PipeDelete; USBH_PipeReset;USBH_PipeReceive; USBH_PipeReceiveGetResult; USBH_PipeSend; USBH_PipeSendGetResult; USBH_PipeAbort;

Data Fields
uint8_t	active	Activity flag.
uint8_t	bEndpointAddress	Endpoint Address + direction.
uint8_t	bInterval	Interval.
uint8_t	bmAttributes	Endpoint Attributes (type + Isochronous info)
uint8_t	dev_addr	Device communication Address.
uint8_t	dev_speed	Device communication Speed.
uint8_t	hub_addr	Hub communication Address.
uint8_t	hub_port	Hub communication Port.
uint32_t	hw_handle	Handle to Hardware resource.
uint32_t	transferred	Last transferred information.
uint16_t	wMaxPacketSize	Maximum Packet Size + Isochronous info.

struct USBH_DEV

USB Host Device Instance (DEV) structure.

Used in

• Function: USBH_CustomClass_Configure;

Data Fields
uint8_t	cfg_desc_len	Configuration Descriptor Length.
uint8_t	class_custom	Class Custom handling.
uint8_t	class_driver	Class Driver used.
uint8_t	class_instance	Class instance.
uint8_t	ctrl	Index of USB Host controller.
uint8_t	dev_addr	Device communication Address.
uint8_t	dev_desc_len	Device Descriptor Length.
uint8_t	dev_speed	Device communication Speed.
uint8_t	hub_addr	Hub communication Address.
uint8_t	hub_port	Hub communication Port.
uint8_t	max_packet_size	Maximum Packet Size.
uint8_t	pid	Product ID.
osThreadId	recovery_thread_id	Thread ID of thread that activated Recovery.
struct USBH_DEV	state
uint8_t	vid	Vendor ID.

struct USBH_DEV.state

Data Fields
uint8_t	configured: 1	Device Configured status.
uint8_t	initialized: 1	Device Initialized status.

struct usbHID_MouseState

Mouse state information.

Used in

• Function: USBH_HID_GetMouseState

Data Fields
uint8_t	button	Current button states.
int16_t	x	Absolute X position change.
int16_t	y	Absolute Y position change.

struct USB_SETUP_PACKET

USB Setup Packet.

Used in

• USB Device Function: USBD_CustomClassn_Endpoint0_SetupPacketReceived; USBD_CustomClassn_Endpoint0_SetupPacketProcessed;

Used in

• USB Host Function: USBH_DefaultPipeSendSetup; USBH_ControlTransfer;

Data Fields
USB_REQUEST_TYPE	bmRequestType	Characteristics of request.
uint8_t	bRequest	Specific request.
uint16_t	wIndex	Index or Offset according to request.
uint16_t	wLength	Number of bytes to transfer if there is a Data stage.
uint16_t	wValue	Value according to request.

struct CDC_LINE_CODING

CDC Line Coding structure.

Format of the data returned when a GetLineCoding request is received (usbcdc11.pdf, 6.2.13)

Used in

• USB Device Function: USBD_CDCn_ACM_SetLineCoding; USBD_CDCn_ACM_GetLineCoding;

Used in

• USB Host Function: USBH_CDC_ACM_SetLineCoding; USBH_CDC_ACM_GetLineCoding;

Data Fields
uint8_t	bCharFormat	Number of stop bits.
uint8_t	bDataBits	Number of data bits.
uint8_t	bParityType	Parity bit type.
uint32_t	dwDTERate	Data terminal rate in bits per second.