Host Controller Driver structure (USBH_HCD)

Home » RL-USB » RL-USB for USB Host Applications » RL-USB Host Constants and Structures » Host Controller Driver structure (USBH_HCD)

Host Controller Driver (USBH_HCD) structure represents an host controller driver that USB Host Core has on disposal.

typedef struct {                        /* Host Controller Driver structure   */
  void       (*get_capabilities) (USBH_HCI_CAP *cap); /* Get Drv Capabilities */
  void       (*delay_ms        ) (U32  ms);   /* Delay in ms                  */
  BOOL       (*pins_config     ) (BOOL on);   /* Config/Unconfig pins         */
  BOOL       (*init            ) (BOOL on);   /* Init/Uninit Host Controller  */
  BOOL       (*port_power      ) (BOOL on);   /* On/Off Port Power            */
  BOOL       (*port_reset      ) (U8   port); /* Reset Port                   */
  U32        (*get_connect     ) (void);      /* Get port conn/disconn status */
  U32        (*get_speed       ) (void);      /* Get port enumerated speed    */
  U32        (*ep_add          ) (            U8 dev_adr, U8 ep_spd, USB_ENDPOINT_DESCRIPTOR *ptr_epd);
  BOOL       (*ep_config       ) (U32  hndl,  U8 dev_adr, U8 ep_spd, USB_ENDPOINT_DESCRIPTOR *ptr_epd);
  BOOL       (*ep_remove       ) (U32  hndl);
  BOOL       (*urb_submit      ) (U32  hndl,  USBH_URB *ptr_urb);
  BOOL       (*urb_cancel      ) (U32  hndl,  USBH_URB *ptr_urb);
} USBH_HCD;

Explanation of USBH_HCD structure elements:

• get_capabilities is a pointer to the function used to report driver capabilities.
• delay_ms is a pointer to the function used to delay execution for a specified time in milliseconds.
• pins_config is a pointer to function used to configure or unconfigure pins used by the USB Host Controller.
• init is a pointer to a function used to initialize or uninitialize the USB Host Controller.
• port_power is a pointer to a function used to drives port power pin on or off (VBUS).
• port_reset is a pointer to a function used to do a port reset.
• get_connect is a pointer to a function used to get the port connection status.
• get_speed is a pointer to a function used to get the port enumerated speed.
• ep_add is a pointer to a function used to add an endpoint.
• ep_remove is a pointer to a function used to remove an endpoint.
• urb_submit is a pointer to a function used to submit the communication request.
• urb_cancel is a pointer to a function used to cancel the communication request.