USB Device Driver (UDD)

The UDD driver provides a low-level abstraction of the device controller hardware.

Most events coming from the hardware such as interrupts, which may cause the UDD to call into the UDC and UDI.

Modules
	USBC Device Driver
	USBC low-level driver for USB Device mode.

Data Structures
struct	udd_ctrl_request_t
	Global variable to give and record information of the setup request management. More...

Macros
#define	Udd_setup_is_in()   (USB_REQ_DIR_IN == (udd_g_ctrlreq.req.bmRequestType & USB_REQ_DIR_MASK))
	Return true if the setup request udd_g_ctrlreq indicates IN data transfer. More...
#define	Udd_setup_is_out()   (USB_REQ_DIR_OUT == (udd_g_ctrlreq.req.bmRequestType & USB_REQ_DIR_MASK))
	Return true if the setup request udd_g_ctrlreq indicates OUT data transfer. More...
#define	Udd_setup_recipient()   (udd_g_ctrlreq.req.bmRequestType & USB_REQ_RECIP_MASK)
	Return the recipient of the SETUP request udd_g_ctrlreq. More...
#define	Udd_setup_type()   (udd_g_ctrlreq.req.bmRequestType & USB_REQ_TYPE_MASK)
	Return the type of the SETUP request udd_g_ctrlreq. More...

Typedefs
typedef void(*	udd_callback_halt_cleared_t )(void)
	End of halt callback function type. More...
typedef void(*	udd_callback_trans_t )(udd_ep_status_t status, iram_size_t nb_transfered, udd_ep_id_t ep)
	End of transfer callback function type. More...
typedef uint8_t	udd_ep_id_t
	Endpoint identifier. More...

Enumerations
enum	udd_ep_status_t {   UDD_EP_TRANSFER_OK = 0,   UDD_EP_TRANSFER_ABORT = 1 }
	Endpoint transfer status Returned in parameters of callback register via udd_ep_run routine. More...

Functions
void	udd_attach (void)
	Attach device to the bus when possible. More...
void	udd_detach (void)
	Detaches the device from the bus. More...
void	udd_disable (void)
	Disables the USB Device mode. More...
void	udd_enable (void)
	Enables the USB Device mode. More...
uint16_t	udd_get_frame_number (void)
	Returns the current start of frame number. More...
uint16_t	udd_get_micro_frame_number (void)
	Returns the current micro start of frame number. More...
uint8_t	udd_getaddress (void)
	Returns the USB address of device. More...
bool	udd_include_vbus_monitoring (void)
	Authorizes the VBUS event. More...
bool	udd_is_high_speed (void)
	Test whether the USB Device Controller is running at high speed or not. More...
void	udd_send_remotewakeup (void)
	The USB driver sends a resume signal called Upstream Resume. More...
void	udd_set_address (uint8_t address)
	Changes the USB address of device. More...
void	udd_set_setup_payload (uint8_t *payload, uint16_t payload_size)
	Load setup payload. More...

Variables
udd_ctrl_request_t	udd_g_ctrlreq
	Global variable to give and record information about setup request management. More...

High speed test mode management
The following functions allow the device to jump to a specific test mode required in high speed mode.
void	udd_test_mode_j (void)
void	udd_test_mode_k (void)
void	udd_test_mode_se0_nak (void)
void	udd_test_mode_packet (void)

UDC callbacks to provide for UDD
The following callbacks are used by UDD.
bool	udc_process_setup (void)
	Decodes and manages a setup request. More...
void	udc_reset (void)
	Reset the UDC. More...
void	udc_sof_notify (void)
	To signal that a SOF is occurred. More...

#define Udd_setup_is_in

(

)

(USB_REQ_DIR_IN == (udd_g_ctrlreq.req.bmRequestType & USB_REQ_DIR_MASK))

Return true if the setup request udd_g_ctrlreq indicates IN data transfer.

Referenced by udc_process_setup(), udc_reqstd(), udd_ctrl_setup_received(), udi_cdc_comm_setup(), udi_hid_setup(), udi_msc_setup(), udi_phdc_setup(), and udi_vendor_setup().

#define Udd_setup_is_out

(

)

(USB_REQ_DIR_OUT == (udd_g_ctrlreq.req.bmRequestType & USB_REQ_DIR_MASK))

Return true if the setup request udd_g_ctrlreq indicates OUT data transfer.

Referenced by udi_cdc_comm_setup(), udi_hid_setup(), udi_msc_setup(), udi_phdc_setup(), and udi_vendor_setup().

#define Udd_setup_recipient

(

)

(udd_g_ctrlreq.req.bmRequestType & USB_REQ_RECIP_MASK)

Return the recipient of the SETUP request udd_g_ctrlreq.

See Also

usb_recipient

Referenced by udc_process_setup(), and udc_reqstd().

#define Udd_setup_type

(

)

(udd_g_ctrlreq.req.bmRequestType & USB_REQ_TYPE_MASK)

Return the type of the SETUP request udd_g_ctrlreq.

See Also

usb_reqtype.

Referenced by udc_process_setup(), udi_cdc_comm_setup(), udi_hid_setup(), udi_msc_setup(), udi_phdc_setup(), and udi_vendor_setup().

typedef void(* udd_callback_halt_cleared_t)(void)

End of halt callback function type.

Registered by routine udd_ep_wait_stall_clear() Callback called when endpoint stall is cleared.

typedef void(* udd_callback_trans_t)(udd_ep_status_t status, iram_size_t nb_transfered, udd_ep_id_t ep)

End of transfer callback function type.

Registered by routine udd_ep_run() Callback called by USB interrupt after data transfer or abort (reset,...).

Parameters

status	UDD_EP_TRANSFER_OK, if transfer is complete
status	UDD_EP_TRANSFER_ABORT, if transfer is aborted
n	number of data transfered

typedef uint8_t udd_ep_id_t

Endpoint identifier.

enum udd_ep_status_t

Endpoint transfer status Returned in parameters of callback register via udd_ep_run routine.

Enumerator
UDD_EP_TRANSFER_OK
UDD_EP_TRANSFER_ABORT

bool udc_process_setup

(

void

)

Decodes and manages a setup request.

The driver call it when a SETUP packet is received. The udd_g_ctrlreq contains the data of SETUP packet. If this callback accepts the setup request then it must return 1 and eventually update udd_g_ctrlreq to send or receive data.

Returns

1 if the request is accepted, otherwise 0.

Decodes and manages a setup request.

This function parses a USB SETUP request and submits an appropriate response back to the host or, in the case of SETUP OUT requests with data, sets up a buffer for receiving the data payload.

The main standard requests defined by the USB 2.0 standard are handled internally. The interface requests are sent to UDI, and the specific request sent to a specific application callback.

Returns

true if the request is supported, else the request is stalled by UDD

References udd_ctrl_request_t::callback, NULL, udd_ctrl_request_t::over_under_run, udd_ctrl_request_t::payload_size, udd_ctrl_request_t::req, udc_req_ep(), udc_req_iface(), udc_reqstd(), udd_g_ctrlreq, Udd_setup_is_in, Udd_setup_recipient, Udd_setup_type, USB_REQ_RECIP_ENDPOINT, USB_REQ_RECIP_INTERFACE, USB_REQ_TYPE_STANDARD, and usb_setup_req_t::wLength.

Referenced by udd_ctrl_setup_received().

void udc_reset

(

void

)

Reset the UDC.

The UDC must reset all configuration.

Reset the UDC.

References usb_conf_desc_t::bNumInterfaces, CPU_TO_LE16, udc_config_speed_t::desc, udc_device_status, udc_iface_disable(), udc_num_configuration, udc_ptr_conf, UDC_REMOTEWAKEUP_DISABLE, USB_DEV_STATUS_BUS_POWERED, USB_DEV_STATUS_REMOTEWAKEUP, and USB_DEV_STATUS_SELF_POWERED.

Referenced by udc_req_std_dev_set_configuration(), udc_req_std_dev_set_feature(), and udc_stop().

void udc_sof_notify

(

void

)

To signal that a SOF is occurred.

The UDC must send the signal to all UDIs enabled

References usb_conf_desc_t::bNumInterfaces, udc_config_speed_t::desc, NULL, udi_api_t::sof_notify, udc_num_configuration, udc_ptr_conf, and udc_config_speed_t::udi_apis.

void udd_attach

(

void

)

Attach device to the bus when possible.

Warning

If a VBus control is included in driver, then it will attach device when an acceptable Vbus level from the host is detected.

References cpu_irq_restore(), cpu_irq_save(), Is_otg_clock_usable, otg_freeze_clock, otg_unfreeze_clock, udd_ack_reset, udd_ack_sof, udd_ack_wake_up, udd_attach_device, udd_enable_reset_interrupt, udd_enable_sof_interrupt, udd_enable_suspend_interrupt, udd_enable_wake_up_interrupt, udd_raise_suspend, and udd_sleep_mode().

Referenced by udc_attach(), and udd_enable().

void udd_detach

(

void

)

Detaches the device from the bus.

The driver must remove pull-up on USB line D- or D+.

References otg_freeze_clock, otg_unfreeze_clock, udd_detach_device, and udd_sleep_mode().

Referenced by udc_detach(), and udd_disable().

void udd_disable

(

void

)

Disables the USB Device mode.

References cpu_irq_restore(), cpu_irq_save(), Is_otg_host_mode_enabled, Is_pad_id_device, otg_disable, otg_unfreeze_clock, sleepmgr_unlock_mode(), sysclk_disable_usb(), and udd_detach().

Referenced by udc_stop().

void udd_enable

(

void

)

Enables the USB Device mode.

References bpm_enable_fast_wakeup(), cpu_irq_restore(), cpu_irq_save(), Is_otg_clock_frozen, Is_pad_id_device, Is_pad_vbus_high, otg_dual_enable(), otg_enable, otg_enable_device_mode, otg_freeze_clock, otg_register_desc_tab, otg_unfreeze_clock, pad_vbus_init, sleepmgr_lock_mode(), sysclk_enable_usb(), udd_attach(), udd_g_ep_table, udd_high_speed_disable, udd_high_speed_enable, udd_low_speed_disable, udd_low_speed_enable, UDD_USB_INT_LEVEL, uhd_vbus_handler(), USB_DEVICE_MAX_EP, and usbc_async_wake_up_enable().

Referenced by udc_start().

uint16_t udd_get_frame_number

(

void

)

Returns the current start of frame number.

Returns

current start of frame number.

References udd_frame_number.

Referenced by main_sof_action(), and udi_cdc_tx_send().

uint16_t udd_get_micro_frame_number

(

void

)

Returns the current micro start of frame number.

Returns

current micro start of frame number required in high speed mode.

References udd_micro_frame_number.

Referenced by udi_cdc_tx_send().

uint8_t udd_getaddress

(

void

)

Returns the USB address of device.

Returns

USB address

References udd_get_configured_address.

Referenced by udc_req_std_dev_set_configuration().

bool udd_include_vbus_monitoring

(

void

)

Authorizes the VBUS event.

Returns

true, if the VBUS monitoring is possible.

Referenced by udc_include_vbus_monitoring().

bool udd_is_high_speed

(

void

)

Test whether the USB Device Controller is running at high speed or not.

Returns

true if the Device is running at high speed mode, otherwise false.

References Is_udd_full_speed_mode.

Referenced by main_vendor_iso_out_received(), udc_req_std_dev_get_descriptor(), udc_req_std_dev_set_configuration(), udc_req_std_dev_set_feature(), and udi_cdc_tx_send().

void udd_send_remotewakeup

(

void

)

The USB driver sends a resume signal called Upstream Resume.

References otg_unfreeze_clock, udd_initiate_remote_wake_up, and udd_sleep_mode().

Referenced by udc_remotewakeup().

void udd_set_address

(

uint8_t

address

)

Changes the USB address of device.

Parameters

address

New USB address

References udd_configure_address, udd_disable_address, and udd_enable_address.

Referenced by udc_valid_address().

void udd_set_setup_payload	(	uint8_t *	payload,
		uint16_t	payload_size
	)

Load setup payload.

Parameters

payload	Pointer on payload
payload_size	Size of payload

References udd_ctrl_request_t::payload, udd_ctrl_request_t::payload_size, and udd_g_ctrlreq.

Referenced by udc_req_std_dev_get_configuration(), udc_req_std_dev_get_descriptor(), udc_req_std_dev_get_status(), udc_req_std_dev_get_str_desc(), and udc_req_std_iface_get_setting().

void udd_test_mode_j

(

void

)

Referenced by udc_req_std_dev_set_feature().

void udd_test_mode_k

(

void

)

Referenced by udc_req_std_dev_set_feature().

void udd_test_mode_packet

(

void

)

Referenced by udc_req_std_dev_set_feature().

void udd_test_mode_se0_nak

(

void

)

Referenced by udc_req_std_dev_set_feature().

udd_ctrl_request_t udd_g_ctrlreq

Global variable to give and record information about setup request management.

Referenced by main_extra_string(), main_setup_in_received(), main_setup_out_received(), udc_process_setup(), udc_req_ep(), udc_req_iface(), udc_req_std_dev_clear_feature(), udc_req_std_dev_get_configuration(), udc_req_std_dev_get_descriptor(), udc_req_std_dev_get_status(), udc_req_std_dev_get_str_desc(), udc_req_std_dev_set_address(), udc_req_std_dev_set_configuration(), udc_req_std_dev_set_feature(), udc_req_std_iface_get_setting(), udc_req_std_iface_set_setting(), udc_reqstd(), udc_valid_address(), udd_ctrl_endofrequest(), udd_ctrl_in_sent(), udd_ctrl_init(), udd_ctrl_out_received(), udd_ctrl_setup_received(), udd_set_setup_payload(), udi_cdc_comm_setup(), udi_cdc_setup_to_port(), udi_hid_generic_setfeature_valid(), udi_hid_generic_setreport(), udi_hid_kbd_setreport(), udi_hid_multi_touch_setupreport(), udi_hid_reqstdifaceget_descriptor(), udi_hid_setup(), udi_msc_setup(), udi_phdc_setup(), and udi_vendor_setup().