#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include "esp_err.h"
#include "utilities/compiler/compiler.h"
#include "component/usb/common/usb_common.h"

Go to the source code of this file.

Data Structures
struct	usb_setup_packet

struct	usb_ep_cfg_data

struct	usb_interface_cfg_data

struct	usb_cfg_data

Macros
#define	MAX_PACKET_SIZE0 64

#define	USB_EP_DIR_MASK 0x80

#define	USB_EP_DIR_IN 0x80

#define	USB_EP_DIR_OUT 0x00

#define	USB_TRANS_READ BIT(0)

#define	USB_TRANS_WRITE BIT(1)

#define	USB_TRANS_NO_ZLP BIT(2)

Typedefs
typedef void(*	usb_status_callback) (enum usb_dc_status_code status_code, uint8_t *param)

typedef void(*	usb_ep_callback) (uint8_t ep, enum usb_dc_ep_cb_status_code cb_status)

typedef int(*	usb_request_handler) (struct usb_setup_packet setup, int32_t transfer_len, uint8_t **payload_data)

typedef void(*	usb_interface_config) (uint8_t bInterfaceNumber)

typedef void(*	usb_transfer_callback) (uint8_t ep, int tsize, void *priv)

Enumerations
enum	usb_dc_status_code { USB_DC_ERROR , USB_DC_RESET , USB_DC_CONNECTED , USB_DC_CONFIGURED , USB_DC_DISCONNECTED , USB_DC_SUSPEND , USB_DC_RESUME , USB_DC_INTERFACE , USB_DC_SET_HALT , USB_DC_CLEAR_HALT , USB_DC_UNKNOWN }

enum	usb_dc_ep_cb_status_code { USB_DC_EP_SETUP , USB_DC_EP_DATA_OUT , USB_DC_EP_DATA_IN }

Functions
int	usb_set_config (struct usb_cfg_data *config)

int	usb_deconfig (void)

int	usb_enable (struct usb_cfg_data *config)

int	usb_disable (void)

int	usb_write_would_block (uint8_t ep)

int	usb_write (uint8_t ep, const uint8_t data, uint32_t data_len, uint32_t bytes_ret)

int	usb_read (uint8_t ep, uint8_t data, uint32_t max_data_len, uint32_t ret_bytes)

int	usb_ep_set_stall (uint8_t ep)

int	usb_ep_clear_stall (uint8_t ep)

int	usb_ep_read_wait (uint8_t ep, uint8_t data, uint32_t max_data_len, uint32_t read_bytes)

int	usb_ep_read_continue (uint8_t ep)

void	usb_transfer_ep_callback (uint8_t ep, enum usb_dc_ep_cb_status_code cb_status)

int	usb_transfer (uint8_t ep, uint8_t data, size_t dlen, unsigned int flags, usb_transfer_callback cb, void priv)

int	usb_transfer_sync (uint8_t ep, uint8_t *data, size_t dlen, unsigned int flags)

void	usb_cancel_transfer (uint8_t ep)

void	usb_dev_deinit (void)

void	usb_dev_resume (int configuration)

int	usb_dev_get_configuration (void)

Variables
struct usb_setup_packet	VSF_CAL_PACKED

Macro Definition Documentation

◆ MAX_PACKET_SIZE0

#define MAX_PACKET_SIZE0 64

◆ USB_EP_DIR_MASK

#define USB_EP_DIR_MASK 0x80

◆ USB_EP_DIR_IN

#define USB_EP_DIR_IN 0x80

◆ USB_EP_DIR_OUT

#define USB_EP_DIR_OUT 0x00

◆ USB_TRANS_READ

#define USB_TRANS_READ BIT(0)

◆ USB_TRANS_WRITE

#define USB_TRANS_WRITE BIT(1)

◆ USB_TRANS_NO_ZLP

#define USB_TRANS_NO_ZLP BIT(2)

Typedef Documentation

◆ usb_status_callback

typedef void(* usb_status_callback) (enum usb_dc_status_code status_code, uint8_t *param)

◆ usb_ep_callback

typedef void(* usb_ep_callback) (uint8_t ep, enum usb_dc_ep_cb_status_code cb_status)

◆ usb_request_handler

typedef int(* usb_request_handler) (struct usb_setup_packet *setup, int32_t *transfer_len, uint8_t **payload_data)

◆ usb_interface_config

typedef void(* usb_interface_config) (uint8_t bInterfaceNumber)

◆ usb_transfer_callback

typedef void(* usb_transfer_callback) (uint8_t ep, int tsize, void *priv)

Enumeration Type Documentation

◆ usb_dc_status_code

enum usb_dc_status_code

Enumerator
USB_DC_ERROR
USB_DC_RESET
USB_DC_CONNECTED
USB_DC_CONFIGURED
USB_DC_DISCONNECTED
USB_DC_SUSPEND
USB_DC_RESUME
USB_DC_INTERFACE
USB_DC_SET_HALT
USB_DC_CLEAR_HALT
USB_DC_UNKNOWN

◆ usb_dc_ep_cb_status_code

enum usb_dc_ep_cb_status_code

Enumerator
USB_DC_EP_SETUP
USB_DC_EP_DATA_OUT
USB_DC_EP_DATA_IN

Function Documentation

◆ usb_set_config()

int usb_set_config ( struct usb_cfg_data * config )

◆ usb_deconfig()

int usb_deconfig ( void )

◆ usb_enable()

int usb_enable ( struct usb_cfg_data * config )

◆ usb_disable()

int usb_disable ( void )

◆ usb_write_would_block()

int usb_write_would_block ( uint8_t ep )

◆ usb_write()

int usb_write	(	uint8_t	ep,
		const uint8_t *	data,
		uint32_t	data_len,
		uint32_t *	bytes_ret
	)

◆ usb_read()

int usb_read	(	uint8_t	ep,
		uint8_t *	data,
		uint32_t	max_data_len,
		uint32_t *	ret_bytes
	)

◆ usb_ep_set_stall()

int usb_ep_set_stall ( uint8_t ep )

◆ usb_ep_clear_stall()

int usb_ep_clear_stall ( uint8_t ep )

◆ usb_ep_read_wait()

int usb_ep_read_wait	(	uint8_t	ep,
		uint8_t *	data,
		uint32_t	max_data_len,
		uint32_t *	read_bytes
	)

◆ usb_ep_read_continue()

int usb_ep_read_continue ( uint8_t ep )

◆ usb_transfer_ep_callback()

void usb_transfer_ep_callback	(	uint8_t	ep,
		enum usb_dc_ep_cb_status_code	cb_status
	)

◆ usb_transfer()

int usb_transfer	(	uint8_t	ep,
		uint8_t *	data,
		size_t	dlen,
		unsigned int	flags,
		usb_transfer_callback	cb,
		void *	priv
	)

◆ usb_transfer_sync()

int usb_transfer_sync	(	uint8_t	ep,
		uint8_t *	data,
		size_t	dlen,
		unsigned int	flags
	)

◆ usb_cancel_transfer()

void usb_cancel_transfer ( uint8_t ep )

◆ usb_dev_deinit()

void usb_dev_deinit ( void )

◆ usb_dev_resume()

void usb_dev_resume ( int configuration )

◆ usb_dev_get_configuration()

int usb_dev_get_configuration ( void )

Variable Documentation

◆ VSF_CAL_PACKED

struct usb_setup_packet VSF_CAL_PACKED

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables