USBH.h File Reference

Interface of the USB Host Controller (UHC). More...

#include "USBHDriver.h"

Go to the source code of this file.

Data Structures
struct	USBH_device_t
	Structure to store device information. More...
Defines
#define	UHC_DATA(x)   COMPILER_ALIGNED(x)
#define	UHC_BSS(x)   COMPILER_ALIGNED(x)
Enumerations
enum	USBH_enum_status_t {   UHC_ENUM_SUCCESS = 0, UHC_ENUM_UNSUPPORTED, UHC_ENUM_OVERCURRENT, UHC_ENUM_FAIL,   UHC_ENUM_HARDWARE_LIMIT, UHC_ENUM_SOFTWARE_LIMIT, UHC_ENUM_MEMORY_LIMIT, UHC_ENUM_DISCONNECT }
	Enumeration status Used in UHC_ENUM_EVENT() callback when a USB device enumeration is completed. More...
Functions
Functions to control the USB host stack
void	USBH_start (void)
	Starts the host mode.
void	USBH_stop (bool b_id_stop)
	Stops the host mode.
void	USBH_suspend (bool b_remotewakeup)
	Suspends a USB line.
bool	USBH_is_suspend (void)
	Test if the suspend state is enabled on the USB line.
void	USBH_resume (void)
	Resumes the USB line.
User functions to manage a device
uint8_t	USBH_get_device_number (void)
	Returns the number of connected devices.
char *	USBH_dev_get_string_manufacturer (USBH_device_t *dev)
	Gets the USB string manufacturer from a USB device.
char *	USBH_dev_get_string_product (USBH_device_t *dev)
	Gets the USB string product from a USB device.
char *	USBH_dev_get_string_serial (USBH_device_t *dev)
	Gets the USB string serial from a USB device.
char *	USBH_dev_get_string (USBH_device_t *dev, uint8_t str_id)
	Gets a USB string from a USB device.
uint16_t	USBH_dev_get_power (USBH_device_t *dev)
	Gets the maximum consumption of a device (mA).
USBH_Speed_t	USBH_dev_get_speed (USBH_device_t *dev)
	Returns the current device speed.
bool	USBH_dev_is_high_speed_support (USBH_device_t *dev)
	Tests if the device supports the USB high speed This function can wait the end of a setup request and the timing can be long (1ms to 5s). Thus, do not call it in an interrupt routine.

---

Detailed Description

Interface of the USB Host Controller (UHC).

Definition in file USBH.h.