usbh.h File Reference

Go to the source code of this file.

Classes
struct	tuh_xfer_s
struct	tuh_itf_info_t
struct	tuh_configure_max3421_t
union	tuh_configure_param_t

Typedefs
typedef struct tuh_xfer_s	tuh_xfer_t
typedef void(*	tuh_xfer_cb_t) (tuh_xfer_t *xfer)

Enumerations
enum	{ TUH_CFGID_INVALID = 0 , TUH_CFGID_RPI_PIO_USB_CONFIGURATION = 100 , TUH_CFGID_MAX3421 = 200 }

Functions
TU_ATTR_WEAK void	tuh_mount_cb (uint8_t daddr)
TU_ATTR_WEAK void	tuh_umount_cb (uint8_t daddr)
void	tuh_event_hook_cb (uint8_t rhport, uint32_t eventid, bool in_isr)
bool	tuh_configure (uint8_t rhport, uint32_t cfg_id, const void *cfg_param)
bool	tuh_rhport_init (uint8_t rhport, const tusb_rhport_init_t *rh_init)
	TU_ATTR_DEPRECATED ("Please use tusb_init(rhport, rh_init) instead") TU_ATTR_ALWAYS_INLINE static inline bool tuh_init(uint8_t rhport)
bool	tuh_deinit (uint8_t rhport)
bool	tuh_inited (void)
void	tuh_task_ext (uint32_t timeout_ms, bool in_isr)
static TU_ATTR_ALWAYS_INLINE void	tuh_task (void)
bool	tuh_task_event_ready (void)
void	hcd_int_handler (uint8_t rhport, bool in_isr)
bool	tuh_rhport_is_active (uint8_t rhport)
bool	tuh_rhport_reset_bus (uint8_t rhport, bool active)
bool	tuh_vid_pid_get (uint8_t daddr, uint16_t *vid, uint16_t *pid)
tusb_speed_t	tuh_speed_get (uint8_t daddr)
bool	tuh_mounted (uint8_t daddr)
static TU_ATTR_ALWAYS_INLINE bool	tuh_suspended (uint8_t daddr)
static TU_ATTR_ALWAYS_INLINE bool	tuh_ready (uint8_t daddr)
bool	tuh_control_xfer (tuh_xfer_t *xfer)
bool	tuh_edpt_xfer (tuh_xfer_t *xfer)
bool	tuh_edpt_open (uint8_t daddr, tusb_desc_endpoint_t const *desc_ep)
bool	tuh_edpt_abort_xfer (uint8_t daddr, uint8_t ep_addr)
bool	tuh_configuration_set (uint8_t daddr, uint8_t config_num, tuh_xfer_cb_t complete_cb, uintptr_t user_data)
bool	tuh_interface_set (uint8_t daddr, uint8_t itf_num, uint8_t itf_alt, tuh_xfer_cb_t complete_cb, uintptr_t user_data)
bool	tuh_descriptor_get (uint8_t daddr, uint8_t type, uint8_t index, void *buffer, uint16_t len, tuh_xfer_cb_t complete_cb, uintptr_t user_data)
bool	tuh_descriptor_get_device (uint8_t daddr, void *buffer, uint16_t len, tuh_xfer_cb_t complete_cb, uintptr_t user_data)
bool	tuh_descriptor_get_configuration (uint8_t daddr, uint8_t index, void *buffer, uint16_t len, tuh_xfer_cb_t complete_cb, uintptr_t user_data)
bool	tuh_descriptor_get_hid_report (uint8_t daddr, uint8_t itf_num, uint8_t desc_type, uint8_t index, void *buffer, uint16_t len, tuh_xfer_cb_t complete_cb, uintptr_t user_data)
bool	tuh_descriptor_get_string (uint8_t daddr, uint8_t index, uint16_t language_id, void *buffer, uint16_t len, tuh_xfer_cb_t complete_cb, uintptr_t user_data)
bool	tuh_descriptor_get_manufacturer_string (uint8_t daddr, uint16_t language_id, void *buffer, uint16_t len, tuh_xfer_cb_t complete_cb, uintptr_t user_data)
bool	tuh_descriptor_get_product_string (uint8_t daddr, uint16_t language_id, void *buffer, uint16_t len, tuh_xfer_cb_t complete_cb, uintptr_t user_data)
bool	tuh_descriptor_get_serial_string (uint8_t daddr, uint16_t language_id, void *buffer, uint16_t len, tuh_xfer_cb_t complete_cb, uintptr_t user_data)
uint8_t	tuh_descriptor_get_sync (uint8_t daddr, uint8_t type, uint8_t index, void *buffer, uint16_t len)
uint8_t	tuh_descriptor_get_device_sync (uint8_t daddr, void *buffer, uint16_t len)
uint8_t	tuh_descriptor_get_configuration_sync (uint8_t daddr, uint8_t index, void *buffer, uint16_t len)
uint8_t	tuh_descriptor_get_hid_report_sync (uint8_t daddr, uint8_t itf_num, uint8_t desc_type, uint8_t index, void *buffer, uint16_t len)
uint8_t	tuh_descriptor_get_string_sync (uint8_t daddr, uint8_t index, uint16_t language_id, void *buffer, uint16_t len)
uint8_t	tuh_descriptor_get_manufacturer_string_sync (uint8_t daddr, uint16_t language_id, void *buffer, uint16_t len)
uint8_t	tuh_descriptor_get_product_string_sync (uint8_t daddr, uint16_t language_id, void *buffer, uint16_t len)
uint8_t	tuh_descriptor_get_serial_string_sync (uint8_t daddr, uint16_t language_id, void *buffer, uint16_t len)

Variables
	C

Typedef Documentation

tuh_xfer_cb_t

typedef void(* tuh_xfer_cb_t) (tuh_xfer_t *xfer)

Definition at line 44 of file usbh.h.

tuh_xfer_t

typedef struct tuh_xfer_s tuh_xfer_t

Definition at line 42 of file usbh.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
TUH_CFGID_INVALID
TUH_CFGID_RPI_PIO_USB_CONFIGURATION
TUH_CFGID_MAX3421

Definition at line 77 of file usbh.h.

Function Documentation

hcd_int_handler()

void hcd_int_handler	(	uint8_t	rhport,
		bool	in_isr
	)

Definition at line 1002 of file hcd_max3421.c.

TU_ATTR_DEPRECATED()

TU_ATTR_DEPRECATED

(

"Please use tusb_init(rhport, rh_init) instead"

)

Definition at line 128 of file usbh.h.

tuh_configuration_set()

bool tuh_configuration_set	(	uint8_t	daddr,
		uint8_t	config_num,
		tuh_xfer_cb_t	complete_cb,
		uintptr_t	user_data
	)

Definition at line 1090 of file usbh.c.

tuh_configure()

bool tuh_configure	(	uint8_t	rhport,
		uint32_t	cfg_id,
		const void *	cfg_param
	)

Definition at line 332 of file usbh.c.

tuh_control_xfer()

bool tuh_control_xfer

(

tuh_xfer_t *

xfer

)

Definition at line 602 of file usbh.c.

tuh_deinit()

bool tuh_deinit

(

uint8_t

rhport

)

Definition at line 405 of file usbh.c.

tuh_descriptor_get()

bool tuh_descriptor_get	(	uint8_t	daddr,
		uint8_t	type,
		uint8_t	index,
		void *	buffer,
		uint16_t	len,
		tuh_xfer_cb_t	complete_cb,
		uintptr_t	user_data
	)

Definition at line 1014 of file usbh.c.

tuh_descriptor_get_configuration()

bool tuh_descriptor_get_configuration	(	uint8_t	daddr,
		uint8_t	index,
		void *	buffer,
		uint16_t	len,
		tuh_xfer_cb_t	complete_cb,
		uintptr_t	user_data
	)

Definition at line 1025 of file usbh.c.

tuh_descriptor_get_configuration_sync()

uint8_t tuh_descriptor_get_configuration_sync	(	uint8_t	daddr,
		uint8_t	index,
		void *	buffer,
		uint16_t	len
	)

Definition at line 1160 of file usbh.c.

tuh_descriptor_get_device()

bool tuh_descriptor_get_device	(	uint8_t	daddr,
		void *	buffer,
		uint16_t	len,
		tuh_xfer_cb_t	complete_cb,
		uintptr_t	user_data
	)

Definition at line 1019 of file usbh.c.

tuh_descriptor_get_device_sync()

uint8_t tuh_descriptor_get_device_sync	(	uint8_t	daddr,
		void *	buffer,
		uint16_t	len
	)

Definition at line 1156 of file usbh.c.

tuh_descriptor_get_hid_report()

bool tuh_descriptor_get_hid_report	(	uint8_t	daddr,
		uint8_t	itf_num,
		uint8_t	desc_type,
		uint8_t	index,
		void *	buffer,
		uint16_t	len,
		tuh_xfer_cb_t	complete_cb,
		uintptr_t	user_data
	)

Definition at line 1064 of file usbh.c.

tuh_descriptor_get_hid_report_sync()

uint8_t tuh_descriptor_get_hid_report_sync	(	uint8_t	daddr,
		uint8_t	itf_num,
		uint8_t	desc_type,
		uint8_t	index,
		void *	buffer,
		uint16_t	len
	)

Definition at line 1165 of file usbh.c.

tuh_descriptor_get_manufacturer_string()

bool tuh_descriptor_get_manufacturer_string	(	uint8_t	daddr,
		uint16_t	language_id,
		void *	buffer,
		uint16_t	len,
		tuh_xfer_cb_t	complete_cb,
		uintptr_t	user_data
	)

Definition at line 1038 of file usbh.c.

tuh_descriptor_get_manufacturer_string_sync()

uint8_t tuh_descriptor_get_manufacturer_string_sync	(	uint8_t	daddr,
		uint16_t	language_id,
		void *	buffer,
		uint16_t	len
	)

Definition at line 1175 of file usbh.c.

tuh_descriptor_get_product_string()

bool tuh_descriptor_get_product_string	(	uint8_t	daddr,
		uint16_t	language_id,
		void *	buffer,
		uint16_t	len,
		tuh_xfer_cb_t	complete_cb,
		uintptr_t	user_data
	)

Definition at line 1047 of file usbh.c.

tuh_descriptor_get_product_string_sync()

uint8_t tuh_descriptor_get_product_string_sync	(	uint8_t	daddr,
		uint16_t	language_id,
		void *	buffer,
		uint16_t	len
	)

Definition at line 1180 of file usbh.c.

tuh_descriptor_get_serial_string()

bool tuh_descriptor_get_serial_string	(	uint8_t	daddr,
		uint16_t	language_id,
		void *	buffer,
		uint16_t	len,
		tuh_xfer_cb_t	complete_cb,
		uintptr_t	user_data
	)

Definition at line 1055 of file usbh.c.

tuh_descriptor_get_serial_string_sync()

uint8_t tuh_descriptor_get_serial_string_sync	(	uint8_t	daddr,
		uint16_t	language_id,
		void *	buffer,
		uint16_t	len
	)

Definition at line 1185 of file usbh.c.

tuh_descriptor_get_string()

bool tuh_descriptor_get_string	(	uint8_t	daddr,
		uint8_t	index,
		uint16_t	language_id,
		void *	buffer,
		uint16_t	len,
		tuh_xfer_cb_t	complete_cb,
		uintptr_t	user_data
	)

Definition at line 1032 of file usbh.c.

tuh_descriptor_get_string_sync()

uint8_t tuh_descriptor_get_string_sync	(	uint8_t	daddr,
		uint8_t	index,
		uint16_t	language_id,
		void *	buffer,
		uint16_t	len
	)

Definition at line 1170 of file usbh.c.

tuh_descriptor_get_sync()

uint8_t tuh_descriptor_get_sync	(	uint8_t	daddr,
		uint8_t	type,
		uint8_t	index,
		void *	buffer,
		uint16_t	len
	)

Definition at line 1151 of file usbh.c.

tuh_edpt_abort_xfer()

bool tuh_edpt_abort_xfer	(	uint8_t	daddr,
		uint8_t	ep_addr
	)

Definition at line 781 of file usbh.c.

tuh_edpt_open()

bool tuh_edpt_open	(	uint8_t	daddr,
		tusb_desc_endpoint_t const *	desc_ep
	)

Definition at line 930 of file usbh.c.

tuh_edpt_xfer()

bool tuh_edpt_xfer

(

tuh_xfer_t *

xfer

)

Definition at line 765 of file usbh.c.

tuh_event_hook_cb()

void tuh_event_hook_cb	(	uint8_t	rhport,
		uint32_t	eventid,
		bool	in_isr
	)

Definition at line 62 of file usbh.c.

tuh_inited()

bool tuh_inited

(

void

)

Definition at line 342 of file usbh.c.

tuh_interface_set()

bool tuh_interface_set	(	uint8_t	daddr,
		uint8_t	itf_num,
		uint8_t	itf_alt,
		tuh_xfer_cb_t	complete_cb,
		uintptr_t	user_data
	)

Definition at line 1116 of file usbh.c.

tuh_mount_cb()

TU_ATTR_WEAK void tuh_mount_cb

(

uint8_t

daddr

)

tuh_mounted()

bool tuh_mounted

(

uint8_t

daddr

)

Definition at line 291 of file usbh.c.

tuh_ready()

static TU_ATTR_ALWAYS_INLINE bool tuh_ready ( uint8_t  daddr )

inlinestatic

Definition at line 198 of file usbh.h.

tuh_rhport_init()

bool tuh_rhport_init	(	uint8_t	rhport,
		const tusb_rhport_init_t *	rh_init
	)

Definition at line 346 of file usbh.c.

tuh_rhport_is_active()

bool tuh_rhport_is_active

(

uint8_t

rhport

)

Definition at line 314 of file usbh.c.

tuh_rhport_reset_bus()

bool tuh_rhport_reset_bus	(	uint8_t	rhport,
		bool	active
	)

Definition at line 318 of file usbh.c.

tuh_speed_get()

tusb_speed_t tuh_speed_get

(

uint8_t

daddr

)

Definition at line 309 of file usbh.c.

tuh_suspended()

static TU_ATTR_ALWAYS_INLINE bool tuh_suspended ( uint8_t  daddr )

inlinestatic

Definition at line 190 of file usbh.h.

tuh_task()

static TU_ATTR_ALWAYS_INLINE void tuh_task ( void  )

inlinestatic

Definition at line 152 of file usbh.h.

tuh_task_event_ready()

bool tuh_task_event_ready

(

void

)

Definition at line 440 of file usbh.c.

tuh_task_ext()

void tuh_task_ext	(	uint32_t	timeout_ms,
		bool	in_isr
	)

Definition at line 465 of file usbh.c.

tuh_umount_cb()

TU_ATTR_WEAK void tuh_umount_cb

(

uint8_t

daddr

)

tuh_vid_pid_get()

bool tuh_vid_pid_get	(	uint8_t	daddr,
		uint16_t *	vid,
		uint16_t *	pid
	)

Definition at line 297 of file usbh.c.

Variable Documentation

C

C

extern

Initial value:

{
#endif
 
#include "common/tusb_common.h"
 
 
 
 
 
 
struct tuh_xfer_s