USB Component  Version 6.0
MDK-Professional Middleware for USB Device and Host
 All Data Structures Functions Variables Enumerations Enumerator Groups Pages
Structures

Structures of USB Host component. More...

Structures

struct  USBH_CLS
 
struct  USBH_DEV
 Device Instance (DEV) structure. More...
 
struct  USBH_DEV.__unnamed__
 
struct  USBH_EHCI_t
 Structure containing configuration values for EHCI Compliant Controller. More...
 
struct  USBH_EP
 Endpoint (EP) settings structure. More...
 
struct  USBH_EP_TID_t
 Endpoint handle to thread ID connection structure. More...
 
struct  USBH_EP.__unnamed__
 
struct  USBH_HCI
 Host Controller Instance (HCI) structure. More...
 
struct  USBH_HC_t
 Structure containing configuration values for Custom Controller Interface. More...
 
struct  USBH_HID
 Human Interface Device (HID) instance structure. More...
 
struct  USBH_MSC
 Mass Storage Class (MSC) instance structure. More...
 
struct  USBH_OHCI_t
 Structure containing configuration values for OHCI Compliant Controller. More...
 
struct  usbHID_MouseState
 Mouse state information. More...
 

Description

Structures of USB Host component.


Data Structure Documentation

struct USBH_CLS
struct USBH_DEV

Device Instance (DEV) structure.

Used in

Data Fields
struct USBH_DEV __unnamed__
struct USBH_DEV __unnamed__
uint8_t cfg_desc_len configuration descriptor length
uint8_t class class
uint8_t class_custom class custom handling
uint8_t class_instance class instance
uint8_t ctrl controller index
uint8_t dev_desc_len device descriptor length
uint8_t protocol class protocol
osThreadId recovery_thread_id thread ID of thread that activated recovery
uint8_t subclass subclass
struct USBH_DEV.__unnamed__
Data Fields
uint8_t dev_addr: 8 device communication address
uint8_t dev_speed: 8 device communication speed
uint8_t hub_addr: 8 hub communication address
uint8_t hub_port: 8 hub communication port
struct USBH_EHCI_t

Structure containing configuration values for EHCI Compliant Controller.

Data Fields
uint16_t max_FSTN maximum peri Frame Span Trav Nodes
uint16_t max_iTD maximum iso Transfer Descriptors
uint16_t max_qH maximum queue Heads
uint16_t max_qTD maximum queue Transfer Descriptors
uint16_t max_siTD maximum split iso Transfer Descs
uint32_t * ptr_EHCI pointer to mem mapped reg base address
uint32_t * ptr_FSTN pointer to FSTN memory start
uint32_t * ptr_iTD pointer to iTD memory start
uint32_t * ptr_PFL pointer to Periodic Frame List mem
uint32_t * ptr_qH pointer to qH memory start
uint32_t * ptr_qTD pointer to qTD memory start
uint32_t * ptr_siTD pointer to siTD memory start
struct USBH_EP

Endpoint (EP) settings structure.

Used in

Data Fields
struct USBH_EP __unnamed__
uint8_t bEndpointAddress endpoint address + direction
uint8_t bInterval interval
uint8_t bmAttributes endpoint attributes (type + iso info)
ARM_USBH_EP_HANDLE ep_handle handle to endpoint
uint16_t wMaxPacketSize max packet size + iso info
struct USBH_EP_TID_t

Endpoint handle to thread ID connection structure.

Data Fields
ARM_USBH_EP_HANDLE ep_handle handle to endpoint
osThreadId ep_thread_id endpoint transfer thread ID
struct USBH_EP.__unnamed__
Data Fields
uint8_t dev_addr: 8 device communication address
uint8_t dev_speed: 8 device communication speed
uint8_t hub_addr: 8 hub communication address
uint8_t hub_port: 8 hub communication port
struct USBH_HCI

Host Controller Instance (HCI) structure.

Data Fields
uint16_t debounce_countdown debounce countdown counter
uint16_t debounce_max_countdown debounce maximum countdown counter
uint32_t dev_addr_mask mask of addressed device addresses
USBH_EP ep0 Control Endpoint 0.
uint8_t last_dev_addr last addressed device address
uint16_t port_con port connected map in software
uint16_t port_con_phy port connected map physically
uint16_t port_con_phy_ex port connected map physically (previous state)
uint16_t port_oc port overcurrent
uint32_t port_retry port enumeration retry counters (2 bits per port)
uint32_t port_state port states (4 bits per port)
struct USBH_HC_t

Structure containing configuration values for Custom Controller Interface.

Data Fields
uint16_t max_ep maximum Endpoints
struct USBH_HID

Human Interface Device (HID) instance structure.

Data Fields
USBH_EP int_in_ep interrupt in endpoint
USBH_EP int_out_ep interrupt out endpoint
uint8_t keyboard_in_data_buf report input data buffer
uint8_t keyboard_in_data_buf_ex report input data buffer last state
uint16_t keyboard_in_data_len report input data bytes received
uint8_t keyboard_in_key_pos report input current key position
usbHID_MouseState mouse_state current mouse position and state
USBH_DEV * ptr_dev pointer to device structure
uint8_t * ptr_int_in_buf pointer to interrupt in buffer
uint16_t report_desc_len report descriptor length
uint8_t report_desc_type report descriptor type
struct USBH_MSC

Mass Storage Class (MSC) instance structure.

Data Fields
USBH_EP bulk_in_ep bulk in endpoint
USBH_EP bulk_out_ep bulk out endpoint
uint8_t do_ping do Ping on next out packet
uint8_t max_lun maximum logical units
bool media_ok physical media ready status
USBH_DEV * ptr_dev pointer to device structure
uint32_t tag tag command/data/status protocol
struct USBH_OHCI_t

Structure containing configuration values for OHCI Compliant Controller.

Used for custom class functions.

Data Fields
uint16_t max_ED maximum Endpoint Descriptors
uint16_t max_ITD maximum Iso Transfer Descriptors
uint16_t max_TD maximum Transfer Descriptors
uint32_t * ptr_ED pointer to ED memory start
uint32_t * ptr_HCCA pointer to HCCA memory start
uint32_t * ptr_ITD pointer to ITD memory start
uint32_t * ptr_OHCI pointer to mem mapped reg base address
uint32_t * ptr_TD pointer to TD memory start
struct usbHID_MouseState

Mouse state information.

Used in

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