USB driver APIs. More...

Data Structures
struct	usb_endpoint_config_t
	Endpoint config structure. More...

Macros
#define	USB_PHY_INIT_DELAY_COUNT (16U)

#define	USB_HOST_FRAMELIST_SIZE (8U)

Enumerations
enum	usb_dir_t { usb_dir_out = 0 , usb_dir_in = 1 , usb_dir_in_mask = 0x80 }
	USB transfer direction types. More...

enum	usb_xfer_type_t { usb_xfer_control = 0 , usb_xfer_isochronous , usb_xfer_bulk , usb_xfer_interrupt }
	USB transfer types. More...

enum	usb_controller_mode_t { usb_ctrl_mode_otg = 0 , usb_ctrl_mode_device = 2 , usb_ctrl_mode_host = 3 }
	USB controller work modes. More...

enum	usb_line_state_t { usb_line_state0 = 0 , usb_line_state1 = 1 , usb_line_state2 = 2 }
	USB line state. More...

enum	usb_transceiver_t { usb_tran_parallel = 0 , usb_tran_serial = 1 }
	USB transceiver. More...

Functions
static uint32_t	usb_get_interrupts (USB_Type *ptr)
	Get the mask of all enabled interrupts. More...

static void	usb_enable_interrupts (USB_Type *ptr, uint32_t mask)
	Enable interrupts. More...

static uint32_t	usb_get_status_flags (USB_Type *ptr)
	Get all USB status flags. More...

static void	usb_clear_status_flags (USB_Type *ptr, uint32_t mask)
	Clear status flags. More...

static uint8_t	usb_get_suspend_status (USB_Type *ptr)
	Get USB suspend status. More...

static bool	usb_get_port_reset_status (USB_Type *ptr)
	Get USB reset status. More...

static bool	usb_get_port_ccs (USB_Type *ptr)
	Get USB current connect status. More...

static uint8_t	usb_get_port_speed (USB_Type *ptr)
	Get USB port speed status. More...

void	usb_phy_init (USB_Type *ptr)
	Initialize USB phy. More...

static uint8_t	usb_phy_get_line_state (USB_Type *ptr)
	USB phy get line status. More...

static void	usb_phy_using_internal_vbus (USB_Type *ptr)
	USB phy using internal vbus. More...

static void	usb_phy_using_external_vbus (USB_Type *ptr)
	USB phy using external vbus. More...

static void	usb_phy_disable_dp_dm_pulldown (USB_Type *ptr)
	USB phy disconnect dp/dm pins pulldown resistance. More...

static void	usb_phy_enable_dp_dm_pulldown (USB_Type *ptr)
	USB phy connect dp/dm pins pulldown resistance. More...

void	usb_dcd_bus_reset (USB_Type *ptr, uint16_t ep0_max_packet_size)
	USB device bus reset. More...

void	usb_dcd_init (USB_Type *ptr)
	Initialize controller to device mode. More...

void	usb_dcd_deinit (USB_Type *ptr)
	Deinitialize controller to device. More...

void	usb_dcd_remote_wakeup (USB_Type *ptr)
	Wakeup from host. More...

void	usb_dcd_edpt_open (USB_Type ptr, usb_endpoint_config_t config)
	Open an endpoint. More...

uint8_t	usb_dcd_edpt_get_type (USB_Type *ptr, uint8_t ep_addr)
	get a specified endpoint type More...

void	usb_dcd_edpt_xfer (USB_Type *ptr, uint8_t ep_idx)
	Submit a transfer. More...

void	usb_dcd_edpt_stall (USB_Type *ptr, uint8_t ep_addr)
	Stall endpoint. More...

void	usb_dcd_edpt_clear_stall (USB_Type *ptr, uint8_t ep_addr)
	Clear stall. More...

bool	usb_dcd_edpt_check_stall (USB_Type *ptr, uint8_t ep_addr)
	Clear stall. More...

void	usb_dcd_edpt_close (USB_Type *ptr, uint8_t ep_addr)
	Close a specified endpoint. More...

void	usb_dcd_connect (USB_Type *ptr)
	Connect by enabling internal pull-up resistor on D+/D-. More...

void	usb_dcd_disconnect (USB_Type *ptr)
	Disconnect by disabling internal pull-up resistor on D+/D-. More...

static uint32_t	usb_dcd_get_edpt_setup_status (USB_Type *ptr)
	Get setup status of endpoint. More...

static void	usb_dcd_clear_edpt_setup_status (USB_Type *ptr, uint32_t mask)
	Clear the setup status of all specified endpoints. More...

static void	usb_dcd_set_address (USB_Type *ptr, uint8_t dev_addr)
	Set address. More...

static void	usb_dcd_set_edpt_list_addr (USB_Type *ptr, uint32_t addr)
	Set endpoint list address. More...

static uint8_t	usb_dcd_get_device_addr (USB_Type *ptr)
	Get device address. More...

static uint32_t	usb_dcd_get_edpt_complete_status (USB_Type *ptr)
	Get complete status of endpoint. More...

static void	usb_dcd_clear_edpt_complete_status (USB_Type *ptr, uint32_t mask)
	Clear complete status of endpoint. More...

bool	usb_hcd_init (USB_Type *ptr, uint32_t int_mask, uint16_t framelist_size)
	Initialize controller to host mode. More...

void	usb_hcd_port_reset (USB_Type *ptr)
	Initialize controller to host modeHost Reset port. More...

static void	usb_hcd_set_command (USB_Type *ptr, uint32_t mask)
	Initialize controller to host modeHost set command register. More...

static uint32_t	usb_hcd_get_frame_index (USB_Type *ptr)
	Get frame index. More...

static bool	usb_hcd_get_port_csc (USB_Type *ptr)
	Get port connect status change. More...

static void	usb_hcd_set_power_ctrl_polarity (USB_Type *ptr, bool high)
	Set power ctrl polarity. More...

static void	usb_hcd_enable_port_power (USB_Type *ptr)
	Enable port power. More...

static void	usb_hcd_set_async_list_addr (USB_Type *ptr, uint32_t addr)
	Get port connect status changeSet async list address. More...

static void	usb_hcd_set_periodic_list_addr (USB_Type *ptr, uint32_t addr)
	Set periodic list address. More...

static void	usb_hcd_run (USB_Type *ptr)
	Start hcd controller. More...

static void	usb_hcd_stop (USB_Type *ptr)
	Stop hcd controller. More...

Variables
	usb_control_request_t

Detailed Description

USB driver APIs.

Macro Definition Documentation

◆ USB_HOST_FRAMELIST_SIZE

#define USB_HOST_FRAMELIST_SIZE (8U)

#include <drivers/inc/hpm_usb_drv.h>

a frame list size in USB host mode

◆ USB_PHY_INIT_DELAY_COUNT

#define USB_PHY_INIT_DELAY_COUNT (16U)

#include <drivers/inc/hpm_usb_drv.h>

a delay count for USB phy initialization

Enumeration Type Documentation

◆ usb_controller_mode_t

enum usb_controller_mode_t

#include <drivers/inc/hpm_usb_drv.h>

USB controller work modes.

Enumerator
usb_ctrl_mode_otg
usb_ctrl_mode_device
usb_ctrl_mode_host

◆ usb_dir_t

enum usb_dir_t

#include <drivers/inc/hpm_usb_drv.h>

USB transfer direction types.

Enumerator
usb_dir_out
usb_dir_in
usb_dir_in_mask

◆ usb_line_state_t

enum usb_line_state_t

#include <drivers/inc/hpm_usb_drv.h>

USB line state.

Enumerator
usb_line_state0
usb_line_state1
usb_line_state2

◆ usb_transceiver_t

enum usb_transceiver_t

#include <drivers/inc/hpm_usb_drv.h>

USB transceiver.

Enumerator
usb_tran_parallel
usb_tran_serial

◆ usb_xfer_type_t

enum usb_xfer_type_t

#include <drivers/inc/hpm_usb_drv.h>

USB transfer types.

Enumerator
usb_xfer_control
usb_xfer_isochronous
usb_xfer_bulk
usb_xfer_interrupt

Function Documentation

◆ usb_clear_status_flags()

static void usb_clear_status_flags	(	USB_Type *	ptr,
		uint32_t	mask
	)

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Clear status flags.

Only the specified flags can be cleared by writing USBSTS register.

Parameters

[in]	ptr	A USB peripheral base address
[in]	mask	Mask value for flags to be cleared.

◆ usb_dcd_bus_reset()

void usb_dcd_bus_reset	(	USB_Type *	ptr,
		uint16_t	ep0_max_packet_size
	)

#include <drivers/inc/hpm_usb_drv.h>

USB device bus reset.

Parameters

[in]	ptr	A USB peripheral base address
[in]	ep0_max_packet_size	The maximum packet size of endpoint 0

◆ usb_dcd_clear_edpt_complete_status()

static void usb_dcd_clear_edpt_complete_status	(	USB_Type *	ptr,
		uint32_t	mask
	)

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Clear complete status of endpoint.

Parameters

[in]	ptr	A USB peripheral base address
[in]	mask	A mask of the specified endpoints

◆ usb_dcd_clear_edpt_setup_status()

static void usb_dcd_clear_edpt_setup_status	(	USB_Type *	ptr,
		uint32_t	mask
	)

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Clear the setup status of all specified endpoints.

Parameters

[in]	ptr	A USB peripheral base address
[in]	mask	A mask of all specified endpoints

◆ usb_dcd_connect()

void usb_dcd_connect ( USB_Type * ptr )

#include <drivers/inc/hpm_usb_drv.h>

Connect by enabling internal pull-up resistor on D+/D-.

Parameters

[in] ptr A USB peripheral base address

◆ usb_dcd_deinit()

void usb_dcd_deinit ( USB_Type * ptr )

#include <drivers/inc/hpm_usb_drv.h>

Deinitialize controller to device.

Parameters

[in] ptr A USB peripheral base address

◆ usb_dcd_disconnect()

void usb_dcd_disconnect ( USB_Type * ptr )

#include <drivers/inc/hpm_usb_drv.h>

Disconnect by disabling internal pull-up resistor on D+/D-.

Parameters

[in] ptr A USB peripheral base address

◆ usb_dcd_edpt_check_stall()

bool usb_dcd_edpt_check_stall	(	USB_Type *	ptr,
		uint8_t	ep_addr
	)

#include <drivers/inc/hpm_usb_drv.h>

Clear stall.

Parameters

[in]	ptr	A USB peripheral base address
[in]	ep_addr	An address of the specified endpoint

Return values

The	status of endpoint stall, true is stall, false is not stall

◆ usb_dcd_edpt_clear_stall()

void usb_dcd_edpt_clear_stall	(	USB_Type *	ptr,
		uint8_t	ep_addr
	)

#include <drivers/inc/hpm_usb_drv.h>

Clear stall.

Parameters

[in]	ptr	A USB peripheral base address
[in]	ep_addr	An address of the specified endpoint

◆ usb_dcd_edpt_close()

void usb_dcd_edpt_close	(	USB_Type *	ptr,
		uint8_t	ep_addr
	)

#include <drivers/inc/hpm_usb_drv.h>

Close a specified endpoint.

Parameters

[in]	ptr	A USB peripheral base address
[in]	ep_addr	An address of the specified endpoint

◆ usb_dcd_edpt_get_type()

uint8_t usb_dcd_edpt_get_type	(	USB_Type *	ptr,
		uint8_t	ep_addr
	)

#include <drivers/inc/hpm_usb_drv.h>

get a specified endpoint type

Parameters

[in]	ptr	A USB peripheral base address
[in]	ep_addr	Endpoint address

◆ usb_dcd_edpt_open()

void usb_dcd_edpt_open	(	USB_Type *	ptr,
		usb_endpoint_config_t *	config
	)

#include <drivers/inc/hpm_usb_drv.h>

Open an endpoint.

Parameters

[in]	ptr	A USB peripheral base address
[in]	config	A pointer to the specified endpoint config struct

◆ usb_dcd_edpt_stall()

void usb_dcd_edpt_stall	(	USB_Type *	ptr,
		uint8_t	ep_addr
	)

#include <drivers/inc/hpm_usb_drv.h>

Stall endpoint.

Parameters

[in]	ptr	A USB peripheral base address
[in]	ep_addr	An address of the specified endpoint

◆ usb_dcd_edpt_xfer()

void usb_dcd_edpt_xfer	(	USB_Type *	ptr,
		uint8_t	ep_idx
	)

#include <drivers/inc/hpm_usb_drv.h>

Submit a transfer.

Parameters

[in]	ptr	A USB peripheral base address
[in]	ep_idx	An index of the specified endpoint

◆ usb_dcd_get_device_addr()

static uint8_t usb_dcd_get_device_addr ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get device address.

Parameters

[in] ptr A USB peripheral base address

Return values

The	endpoint address

◆ usb_dcd_get_edpt_complete_status()

static uint32_t usb_dcd_get_edpt_complete_status ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get complete status of endpoint.

Parameters

[in] ptr A USB peripheral base address

Return values

The	complete status od endpoint

◆ usb_dcd_get_edpt_setup_status()

static uint32_t usb_dcd_get_edpt_setup_status ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get setup status of endpoint.

Parameters

[in] ptr A USB peripheral base address

Return values

The	status of setup endpoint

◆ usb_dcd_init()

void usb_dcd_init ( USB_Type * ptr )

#include <drivers/inc/hpm_usb_drv.h>

Initialize controller to device mode.

Parameters

[in] ptr A USB peripheral base address

◆ usb_dcd_remote_wakeup()

void usb_dcd_remote_wakeup ( USB_Type * ptr )

#include <drivers/inc/hpm_usb_drv.h>

Wakeup from host.

Parameters

[in] ptr A USB peripheral base address

◆ usb_dcd_set_address()

static void usb_dcd_set_address	(	USB_Type *	ptr,
		uint8_t	dev_addr
	)

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Set address.

Parameters

[in]	ptr	A USB peripheral base address
[in]	dev_addr	An assigned endpoint address from USB host

◆ usb_dcd_set_edpt_list_addr()

static void usb_dcd_set_edpt_list_addr	(	USB_Type *	ptr,
		uint32_t	addr
	)

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Set endpoint list address.

Parameters

[in]	ptr	A USB peripheral base address
[in]	addr	A start address of the endpoint qtd list

◆ usb_enable_interrupts()

static void usb_enable_interrupts	(	USB_Type *	ptr,
		uint32_t	mask
	)

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Enable interrupts.

Parameters

[in]	ptr	A USB peripheral base address
[in]	mask	Mask value for interrupt events

◆ usb_get_interrupts()

static uint32_t usb_get_interrupts ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get the mask of all enabled interrupts.

Parameters

[in] ptr A USB peripheral base address.

Return values

Mask	of all enabled interrupts.

◆ usb_get_port_ccs()

static bool usb_get_port_ccs ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get USB current connect status.

Parameters

[in] ptr A USB peripheral base address

Return values

The	USB controller reset status

◆ usb_get_port_reset_status()

static bool usb_get_port_reset_status ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get USB reset status.

Parameters

[in] ptr A USB peripheral base address

Return values

The	USB controller reset status

◆ usb_get_port_speed()

static uint8_t usb_get_port_speed ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get USB port speed status.

Parameters

[in] ptr A USB peripheral base address

Return values

The	USB controller port speed status

◆ usb_get_status_flags()

static uint32_t usb_get_status_flags ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get all USB status flags.

Parameters

[in] ptr A USB peripheral base address

Return values

The	USB interrupt status flags

◆ usb_get_suspend_status()

static uint8_t usb_get_suspend_status ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get USB suspend status.

Parameters

[in] ptr A USB peripheral base address

Return values

The	USB controller suspend status

◆ usb_hcd_enable_port_power()

static void usb_hcd_enable_port_power ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Enable port power.

Parameters

[in] ptr A USB peripheral base address

◆ usb_hcd_get_frame_index()

static uint32_t usb_hcd_get_frame_index ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get frame index.

Parameters

[in] ptr A USB peripheral base address

Return values

A	index of the current frame list

◆ usb_hcd_get_port_csc()

static bool usb_hcd_get_port_csc ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get port connect status change.

Parameters

[in] ptr A USB peripheral base address

Return values

A	connect status change

◆ usb_hcd_init()

bool usb_hcd_init	(	USB_Type *	ptr,
		uint32_t	int_mask,
		uint16_t	framelist_size
	)

#include <drivers/inc/hpm_usb_drv.h>

Initialize controller to host mode.

Parameters

[in]	ptr	A USB peripheral base address
[in]	int_mask	A mask of all required interrupts
[in]	framelist_size	A size of the frame list

◆ usb_hcd_port_reset()

void usb_hcd_port_reset ( USB_Type * ptr )

#include <drivers/inc/hpm_usb_drv.h>

Initialize controller to host modeHost Reset port.

Parameters

[in] ptr A USB peripheral base address

◆ usb_hcd_run()

static void usb_hcd_run ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Start hcd controller.

Parameters

[in] ptr A USB peripheral base address

◆ usb_hcd_set_async_list_addr()

static void usb_hcd_set_async_list_addr	(	USB_Type *	ptr,
		uint32_t	addr
	)

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Get port connect status changeSet async list address.

Parameters

[in]	ptr	A USB peripheral base address
[in]	addr	An the start address of the async endpoint list

◆ usb_hcd_set_command()

static void usb_hcd_set_command	(	USB_Type *	ptr,
		uint32_t	mask
	)

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Initialize controller to host modeHost set command register.

Parameters

[in]	ptr	A USB peripheral base address
[in]	mask	A mask of all required commands

◆ usb_hcd_set_periodic_list_addr()

static void usb_hcd_set_periodic_list_addr	(	USB_Type *	ptr,
		uint32_t	addr
	)

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Set periodic list address.

Parameters

[in]	ptr	A USB peripheral base address
[in]	addr	An start address of the periodic endpoint list

◆ usb_hcd_set_power_ctrl_polarity()

static void usb_hcd_set_power_ctrl_polarity	(	USB_Type *	ptr,
		bool	high
	)

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Set power ctrl polarity.

Parameters

[in]	ptr	A USB peripheral base address
[in]	high	true - vbus high level enable, false - vbus low level enable

◆ usb_hcd_stop()

static void usb_hcd_stop ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

Stop hcd controller.

Parameters

[in] ptr A USB peripheral base address

◆ usb_phy_disable_dp_dm_pulldown()

static void usb_phy_disable_dp_dm_pulldown ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

USB phy disconnect dp/dm pins pulldown resistance.

Parameters

[in] ptr A USB peripheral base address

◆ usb_phy_enable_dp_dm_pulldown()

static void usb_phy_enable_dp_dm_pulldown ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

USB phy connect dp/dm pins pulldown resistance.

Parameters

[in] ptr A USB peripheral base address

◆ usb_phy_get_line_state()

static uint8_t usb_phy_get_line_state ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

USB phy get line status.

Parameters

[in] ptr A USB peripheral base address

◆ usb_phy_init()

void usb_phy_init ( USB_Type * ptr )

#include <drivers/inc/hpm_usb_drv.h>

Initialize USB phy.

Parameters

[in] ptr A USB peripheral base address

◆ usb_phy_using_external_vbus()

static void usb_phy_using_external_vbus ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

USB phy using external vbus.

Parameters

[in] ptr A USB peripheral base address

◆ usb_phy_using_internal_vbus()

static void usb_phy_using_internal_vbus ( USB_Type * ptr )

inlinestatic

#include <drivers/inc/hpm_usb_drv.h>

USB phy using internal vbus.

Parameters

[in] ptr A USB peripheral base address

Variable Documentation

◆ usb_control_request_t

usb_control_request_t

#include <drivers/inc/hpm_usb_drv.h>

Data Structures

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ USB_HOST_FRAMELIST_SIZE

◆ USB_PHY_INIT_DELAY_COUNT

Enumeration Type Documentation

◆ usb_controller_mode_t

◆ usb_dir_t

◆ usb_line_state_t

◆ usb_transceiver_t

◆ usb_xfer_type_t

Function Documentation

◆ usb_clear_status_flags()

◆ usb_dcd_bus_reset()

◆ usb_dcd_clear_edpt_complete_status()

◆ usb_dcd_clear_edpt_setup_status()

◆ usb_dcd_connect()

◆ usb_dcd_deinit()

◆ usb_dcd_disconnect()

◆ usb_dcd_edpt_check_stall()

◆ usb_dcd_edpt_clear_stall()

◆ usb_dcd_edpt_close()

◆ usb_dcd_edpt_get_type()

◆ usb_dcd_edpt_open()

◆ usb_dcd_edpt_stall()

◆ usb_dcd_edpt_xfer()

◆ usb_dcd_get_device_addr()

◆ usb_dcd_get_edpt_complete_status()

◆ usb_dcd_get_edpt_setup_status()

◆ usb_dcd_init()

◆ usb_dcd_remote_wakeup()

◆ usb_dcd_set_address()

◆ usb_dcd_set_edpt_list_addr()

◆ usb_enable_interrupts()

◆ usb_get_interrupts()

◆ usb_get_port_ccs()

◆ usb_get_port_reset_status()

◆ usb_get_port_speed()

◆ usb_get_status_flags()

◆ usb_get_suspend_status()

◆ usb_hcd_enable_port_power()

◆ usb_hcd_get_frame_index()

◆ usb_hcd_get_port_csc()

◆ usb_hcd_init()

◆ usb_hcd_port_reset()

◆ usb_hcd_run()

◆ usb_hcd_set_async_list_addr()

◆ usb_hcd_set_command()

◆ usb_hcd_set_periodic_list_addr()

◆ usb_hcd_set_power_ctrl_polarity()

◆ usb_hcd_stop()

◆ usb_phy_disable_dp_dm_pulldown()

◆ usb_phy_enable_dp_dm_pulldown()

◆ usb_phy_get_line_state()

◆ usb_phy_init()

◆ usb_phy_using_external_vbus()

◆ usb_phy_using_internal_vbus()

Variable Documentation

◆ usb_control_request_t