USB High-Speed Port for device mode (USBHS)

USBHS low-level driver for USB device mode.

USBHS Custom configuration

The following USBHS driver configuration must be included in the conf_usb.h file of the application.

UDD_USB_INT_LEVEL
Option to change the interrupt priority (0 to 15) by default 5 (recommended).

UDD_USB_INT_FUN
Option to fit interrupt function to what defined in exception table.

UDD_ISOCHRONOUS_NB_BANK(ep)
Feature to reduce or increase isochronous endpoints buffering (1 to 3). Default value 2.

UDD_BULK_NB_BANK(ep)
Feature to reduce or increase bulk endpoints buffering (1 to 2). Default value 2.

UDD_INTERRUPT_NB_BANK(ep)
Feature to reduce or increase interrupt endpoints buffering (1 to 2). Default value 1.

UDD_NO_SLEEP_MGR
Feature to work without sleep manager module. Default not defined. Note that with this feature defined sleep manager must not be used in application.

management

The USB driver is fully managed by interrupt and does not request periodique task. Thereby, the USB events use callbacks to transfer the information. The callbacks are declared in static during compilation or in variable during code execution.

Static declarations defined in conf_usb.h:

• UDC_VBUS_EVENT(bool b_present)
  To signal Vbus level change
• UDC_SUSPEND_EVENT()
  Called when USB bus enter in suspend mode
• UDC_RESUME_EVENT()
  Called when USB bus is wakeup
• UDC_SOF_EVENT()
  Called for each received SOF, Note: Each 1ms in HS/FS mode only.

Dynamic callbacks, called "endpoint job" , are registered in udd_ep_job_t structure via the following functions:

• udd_ep_run()
  To call it when a transfer is finish
• udd_ep_wait_stall_clear()
  To call it when a endpoint halt is disabled

mode management

The Sleep modes authorized :

• in USB IDLE state, the USBHS needs of USB clock and authorizes up to sleep mode WFI.
• in USB SUSPEND state, the USBHS no needs USB clock and authorizes up to sleep mode WAIT.

Macros
#define	UDD_BULK_NB_BANK(ep)   2
#define	UDD_BULK_NB_BANK_ERROR
#define	UDD_EP_BULK_NB_BANK_ERROR(ep)   (UDD_EP_USED(ep) && UDD_EP_ISO_NBANK_ERROR(ep))
#define	UDD_EP_BULK_NBANK_ERROR(ep)   ( (UDD_BULK_NB_BANK(ep) < 1) || (UDD_BULK_NB_BANK(ep) > 2) )
#define	UDD_EP_INT_NB_BANK_ERROR(ep)   (UDD_EP_USED(ep) && UDD_EP_ISO_NBANK_ERROR(ep))
#define	UDD_EP_INT_NBANK_ERROR(ep)   ( (UDD_INTERRUPT_NB_BANK(ep) < 1) || (UDD_INTERRUPT_NB_BANK(ep) > 2) )
#define	UDD_EP_ISO_NB_BANK_ERROR(ep)   (UDD_EP_USED(ep) && UDD_EP_ISO_NBANK_ERROR(ep))
#define	UDD_EP_ISO_NBANK_ERROR(ep)
#define	UDD_EP_NB_BANK_ERROR(ep, type)   (ATPASTE3(UDD_EP_, type, _NB_BANK_ERROR(ep)))
#define	UDD_INTERRUPT_NB_BANK(ep)   1
#define	UDD_INTERRUPT_NB_BANK_ERROR
#define	UDD_ISO_NB_BANK_ERROR
#define	UDD_ISOCHRONOUS_NB_BANK(ep)   2
#define	USBHS_DEVEPTCFG_EPDIR_Pos   8

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...
void	udd_interrupt (void)
	Function called by USBHS interrupt to manage USB Device interrupts. 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...

Power management routine.
static void	udd_sleep_mode (bool b_idle)

Control endpoint low level management routine.
This function performs control endpoint mangement. It handle the SETUP/DATA/HANDSHAKE phases of a control transaction.
enum	udd_ctrl_ep_state_t {   UDD_EPCTRL_SETUP = 0,   UDD_EPCTRL_DATA_OUT = 1,   UDD_EPCTRL_DATA_IN = 2,   UDD_EPCTRL_HANDSHAKE_WAIT_IN_ZLP = 3,   UDD_EPCTRL_HANDSHAKE_WAIT_OUT_ZLP = 4,   UDD_EPCTRL_STALL_REQ = 5 }
	Bit definitions about endpoint control state machine for udd_ep_control_state. More...
COMPILER_WORD_ALIGNED udd_ctrl_request_t	udd_g_ctrlreq
	Global variable to give and record information about setup request management. More...
static udd_ctrl_ep_state_t	udd_ep_control_state
	State of the endpoint control management. More...
static uint16_t	udd_ctrl_prev_payload_buf_cnt
	Total number of data received/sent during data packet phase with previous payload buffers. More...
static uint16_t	udd_ctrl_payload_buf_cnt
	Number of data received/sent to/from udd_g_ctrlreq.payload buffer. More...
static void	udd_reset_ep_ctrl (void)
	Reset control endpoint. More...
static void	udd_ctrl_init (void)
	Reset control endpoint management. More...
static void	udd_ctrl_setup_received (void)
	Managed reception of SETUP packet on control endpoint. More...
static void	udd_ctrl_in_sent (void)
	Managed reception of IN packet on control endpoint. More...
static void	udd_ctrl_out_received (void)
	Managed reception of OUT packet on control endpoint. More...
static void	udd_ctrl_underflow (void)
	Managed underflow event of IN packet on control endpoint. More...
static void	udd_ctrl_overflow (void)
	Managed overflow event of OUT packet on control endpoint. More...
static void	udd_ctrl_stall_data (void)
	Managed stall event of IN/OUT packet on control endpoint. More...
static void	udd_ctrl_send_zlp_in (void)
	Send a ZLP IN on control endpoint. More...
static void	udd_ctrl_send_zlp_out (void)
	Send a ZLP OUT on control endpoint. More...
static void	udd_ctrl_endofrequest (void)
	Call callback associated to setup request. More...
static bool	udd_ctrl_interrupt (void)
	Main interrupt routine for control endpoint. More...

USBHS Device IP properties
These macros give access to IP properties
#define	udd_get_endpoint_max_nbr()   (9)
	Get maximal number of endpoints. More...
#define	UDD_MAX_PEP_NB   (udd_get_endpoint_max_nbr() + 1)
#define	udd_get_endpoint_bank_max_nbr(ep)   ((ep == 0) ? 1 : (( ep <= 2) ? 3 : 2))
	Get maximal number of banks of endpoints. More...
#define	udd_get_endpoint_size_max(ep)   (((ep) == 0) ? 64 : 1024)
	Get maximal size of endpoint (3X, 1024/64) More...
#define	Is_udd_endpoint_dma_supported(ep)   ((((ep) >= 1) && ((ep) <= 7)) ? true : false)
	Get DMA support of endpoints. More...
#define	Is_udd_endpoint_high_bw_supported(ep)   (((ep) >= 2) ? true : false)
	Get High Band Width support of endpoints. More...

USBHS Device speeds management
#define	udd_low_speed_enable()   (Set_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_LS))
	Enable/disable device low-speed mode. More...
#define	udd_low_speed_disable()   (Clr_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_LS))
#define	Is_udd_low_speed_enable()   (Tst_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_LS))
	Test if device low-speed mode is forced. More...
#define	udd_high_speed_enable()   do { } while (0)
#define	udd_high_speed_disable()   do { } while (0)
#define	Is_udd_full_speed_mode()   true

USBHS device attach control
These macros manage the USBHS Device attach.
#define	udd_detach_device()   (Set_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_DETACH))
	Detaches from USB bus. More...
#define	udd_attach_device()   (Clr_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_DETACH))
	Attaches to USB bus. More...
#define	Is_udd_detached()   (Tst_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_DETACH))
	Test if the device is detached. More...

USBHS device bus events control
These macros manage the USBHS Device bus events.
#define	udd_initiate_remote_wake_up()   (Set_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_RMWKUP))
	Initiates a remote wake-up event. More...
#define	Is_udd_pending_remote_wake_up()   (Tst_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_RMWKUP))
#define	udd_enable_remote_wake_up_interrupt()   (USBHS->USBHS_DEVIER = USBHS_DEVIER_UPRSMES)
	Manage upstream resume event (=remote wakeup) The USB driver sends a resume signal called "Upstream Resume". More...
#define	udd_disable_remote_wake_up_interrupt()   (USBHS->USBHS_DEVIDR = USBHS_DEVIDR_UPRSMEC)
#define	Is_udd_remote_wake_up_interrupt_enabled()   (Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_UPRSME))
#define	udd_ack_remote_wake_up_start()   (USBHS->USBHS_DEVICR = USBHS_DEVICR_UPRSMC)
#define	udd_raise_remote_wake_up_start()   (USBHS->USBHS_DEVIFR = USBHS_DEVIFR_UPRSMS)
#define	Is_udd_remote_wake_up_start()   (Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_UPRSM))
#define	udd_enable_resume_interrupt()   (USBHS->USBHS_DEVIER = USBHS_DEVIER_EORSMES)
	Manage downstream resume event (=remote wakeup from host) The USB controller detects a valid "End of Resume" signal initiated by the host. More...
#define	udd_disable_resume_interrupt()   (USBHS->USBHS_DEVIDR = USBHS_DEVIDR_EORSMEC)
#define	Is_udd_resume_interrupt_enabled()   (Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_EORSME))
#define	udd_ack_resume()   (USBHS->USBHS_DEVICR = USBHS_DEVICR_EORSMC)
#define	udd_raise_resume()   (USBHS->USBHS_DEVIFR = USBHS_DEVIFR_EORSMS)
#define	Is_udd_resume()   (Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_EORSM))
#define	udd_enable_wake_up_interrupt()   (USBHS->USBHS_DEVIER = USBHS_DEVIER_WAKEUPES)
	Manage wake-up event (=usb line activity) The USB controller is reactivated by a filtered non-idle signal from the lines. More...
#define	udd_disable_wake_up_interrupt()   (USBHS->USBHS_DEVIDR = USBHS_DEVIDR_WAKEUPEC)
#define	Is_udd_wake_up_interrupt_enabled()   (Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_WAKEUPE))
#define	udd_ack_wake_up()   (USBHS->USBHS_DEVICR = USBHS_DEVICR_WAKEUPC)
#define	udd_raise_wake_up()   (USBHS->USBHS_DEVIFR = USBHS_DEVIFR_WAKEUPS)
#define	Is_udd_wake_up()   (Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_WAKEUP))
#define	udd_enable_reset_interrupt()   (USBHS->USBHS_DEVIER = USBHS_DEVIER_EORSTES)
	Manage reset event Set when a USB "End of Reset" has been detected. More...
#define	udd_disable_reset_interrupt()   (USBHS->USBHS_DEVIDR = USBHS_DEVIDR_EORSTEC)
#define	Is_udd_reset_interrupt_enabled()   (Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_EORSTE))
#define	udd_ack_reset()   (USBHS->USBHS_DEVICR = USBHS_DEVICR_EORSTC)
#define	udd_raise_reset()   (USBHS->USBHS_DEVIFR = USBHS_DEVIFR_EORSTS)
#define	Is_udd_reset()   (Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_EORST))
#define	udd_enable_sof_interrupt()   (USBHS->USBHS_DEVIER = USBHS_DEVIER_SOFES)
	Manage start of frame event. More...
#define	udd_disable_sof_interrupt()   (USBHS->USBHS_DEVIDR = USBHS_DEVIDR_SOFEC)
#define	Is_udd_sof_interrupt_enabled()   (Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_SOFE))
#define	udd_ack_sof()   (USBHS->USBHS_DEVICR = USBHS_DEVICR_SOFC)
#define	udd_raise_sof()   (USBHS->USBHS_DEVIFR = USBHS_DEVIFR_SOFS)
#define	Is_udd_sof()   (Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_SOF))
#define	udd_frame_number()   (Rd_bitfield(USBHS->USBHS_DEVFNUM, USBHS_DEVFNUM_FNUM_Msk))
#define	Is_udd_frame_number_crc_error()   (Tst_bits(USBHS->USBHS_DEVFNUM, USBHS_DEVFNUM_FNCERR))
#define	udd_enable_msof_interrupt()   (USBHS->USBHS_DEVIER = USBHS_DEVIER_MSOFES)
	Manage Micro start of frame event (High Speed Only) More...
#define	udd_disable_msof_interrupt()   (USBHS->USBHS_DEVIDR = USBHS_DEVIDR_MSOFEC)
#define	Is_udd_msof_interrupt_enabled()   (Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_MSOFE))
#define	udd_ack_msof()   (USBHS->USBHS_DEVICR = USBHS_DEVIMR_MSOFE)
#define	udd_raise_msof()   (USBHS->USBHS_DEVIFR = USBHS_DEVIFR_MSOFS)
#define	Is_udd_msof()   (Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_MSOF))
#define	udd_micro_frame_number()   (Rd_bitfield(USBHS->USBHS_DEVFNUM, (USBHS_DEVFNUM_FNUM_Msk|USBHS_DEVFNUM_MFNUM_Msk)))
#define	udd_enable_suspend_interrupt()   (USBHS->USBHS_DEVIER = USBHS_DEVIER_SUSPES)
	Manage suspend event. More...
#define	udd_disable_suspend_interrupt()   (USBHS->USBHS_DEVIDR = USBHS_DEVIDR_SUSPEC)
#define	Is_udd_suspend_interrupt_enabled()   (Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_SUSPE))
#define	udd_ack_suspend()   (USBHS->USBHS_DEVICR = USBHS_DEVICR_SUSPC)
#define	udd_raise_suspend()   (USBHS->USBHS_DEVIFR = USBHS_DEVIFR_SUSPS)
#define	Is_udd_suspend()   (Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_SUSP))

#define Is_udd_detached

(

)

(Tst_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_DETACH))

Test if the device is detached.

#define Is_udd_endpoint_dma_supported

(

ep

)

((((ep) >= 1) && ((ep) <= 7)) ? true : false)

Get DMA support of endpoints.

#define Is_udd_endpoint_high_bw_supported

(

ep

)

(((ep) >= 2) ? true : false)

Get High Band Width support of endpoints.

#define Is_udd_frame_number_crc_error

(

)

(Tst_bits(USBHS->USBHS_DEVFNUM, USBHS_DEVFNUM_FNCERR))

#define Is_udd_full_speed_mode

(

)

true

Referenced by udd_interrupt(), and udd_is_high_speed().

#define Is_udd_low_speed_enable

(

)

(Tst_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_LS))

Test if device low-speed mode is forced.

#define Is_udd_msof

(

)

(Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_MSOF))

Referenced by udd_interrupt().

#define Is_udd_msof_interrupt_enabled

(

)

(Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_MSOFE))

#define Is_udd_pending_remote_wake_up

(

)

(Tst_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_RMWKUP))

#define Is_udd_remote_wake_up_interrupt_enabled

(

)

(Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_UPRSME))

#define Is_udd_remote_wake_up_start

(

)

(Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_UPRSM))

#define Is_udd_reset

(

)

(Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_EORST))

Referenced by udd_interrupt().

#define Is_udd_reset_interrupt_enabled

(

)

(Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_EORSTE))

#define Is_udd_resume

(

)

(Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_EORSM))

#define Is_udd_resume_interrupt_enabled

(

)

(Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_EORSME))

#define Is_udd_sof

(

)

(Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_SOF))

Referenced by udd_interrupt().

#define Is_udd_sof_interrupt_enabled

(

)

(Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_SOFE))

#define Is_udd_suspend

(

)

(Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_SUSP))

Referenced by udd_interrupt().

#define Is_udd_suspend_interrupt_enabled

(

)

(Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_SUSPE))

Referenced by udd_interrupt().

#define Is_udd_wake_up

(

)

(Tst_bits(USBHS->USBHS_DEVISR, USBHS_DEVISR_WAKEUP))

Referenced by udd_interrupt().

#define Is_udd_wake_up_interrupt_enabled

(

)

(Tst_bits(USBHS->USBHS_DEVIMR, USBHS_DEVIMR_WAKEUPE))

Referenced by udd_interrupt().

#define udd_ack_msof

(

)

(USBHS->USBHS_DEVICR = USBHS_DEVIMR_MSOFE)

Referenced by udd_attach(), and udd_interrupt().

#define udd_ack_remote_wake_up_start

(

)

(USBHS->USBHS_DEVICR = USBHS_DEVICR_UPRSMC)

#define udd_ack_reset

(

)

(USBHS->USBHS_DEVICR = USBHS_DEVICR_EORSTC)

Referenced by udd_attach(), and udd_interrupt().

#define udd_ack_resume

(

)

(USBHS->USBHS_DEVICR = USBHS_DEVICR_EORSMC)

#define udd_ack_sof

(

)

(USBHS->USBHS_DEVICR = USBHS_DEVICR_SOFC)

Referenced by udd_attach(), and udd_interrupt().

#define udd_ack_suspend

(

)

(USBHS->USBHS_DEVICR = USBHS_DEVICR_SUSPC)

#define udd_ack_wake_up

(

)

(USBHS->USBHS_DEVICR = USBHS_DEVICR_WAKEUPC)

Referenced by udd_attach().

#define udd_attach_device

(

)

(Clr_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_DETACH))

Attaches to USB bus.

Referenced by udd_attach().

#define UDD_BULK_NB_BANK

(

ep

)

2

#define UDD_BULK_NB_BANK_ERROR

Value:

(          UDD_EP_NB_BANK_ERROR( 1, BULK) \
        || UDD_EP_NB_BANK_ERROR( 2, BULK) \
        || UDD_EP_NB_BANK_ERROR( 3, BULK) \
        || UDD_EP_NB_BANK_ERROR( 4, BULK) \
        || UDD_EP_NB_BANK_ERROR( 5, BULK) \
        || UDD_EP_NB_BANK_ERROR( 6, BULK) \
        || UDD_EP_NB_BANK_ERROR( 7, BULK) \
        || UDD_EP_NB_BANK_ERROR( 8, BULK) \
        || UDD_EP_NB_BANK_ERROR( 9, BULK) \
        || UDD_EP_NB_BANK_ERROR(10, BULK) \
        || UDD_EP_NB_BANK_ERROR(11, BULK) \
        || UDD_EP_NB_BANK_ERROR(12, BULK) \
        || UDD_EP_NB_BANK_ERROR(13, BULK) \
        || UDD_EP_NB_BANK_ERROR(14, BULK) \
        || UDD_EP_NB_BANK_ERROR(15, BULK) )

#define udd_detach_device

(

)

(Set_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_DETACH))

Detaches from USB bus.

Referenced by udd_detach().

#define udd_disable_msof_interrupt

(

)

(USBHS->USBHS_DEVIDR = USBHS_DEVIDR_MSOFEC)

#define udd_disable_remote_wake_up_interrupt

(

)

(USBHS->USBHS_DEVIDR = USBHS_DEVIDR_UPRSMEC)

#define udd_disable_reset_interrupt

(

)

(USBHS->USBHS_DEVIDR = USBHS_DEVIDR_EORSTEC)

#define udd_disable_resume_interrupt

(

)

(USBHS->USBHS_DEVIDR = USBHS_DEVIDR_EORSMEC)

#define udd_disable_sof_interrupt

(

)

(USBHS->USBHS_DEVIDR = USBHS_DEVIDR_SOFEC)

#define udd_disable_suspend_interrupt

(

)

(USBHS->USBHS_DEVIDR = USBHS_DEVIDR_SUSPEC)

Referenced by udd_interrupt().

#define udd_disable_wake_up_interrupt

(

)

(USBHS->USBHS_DEVIDR = USBHS_DEVIDR_WAKEUPEC)

Referenced by udd_interrupt().

#define udd_enable_msof_interrupt

(

)

(USBHS->USBHS_DEVIER = USBHS_DEVIER_MSOFES)

Manage Micro start of frame event (High Speed Only)

Referenced by udd_attach().

#define udd_enable_remote_wake_up_interrupt

(

)

(USBHS->USBHS_DEVIER = USBHS_DEVIER_UPRSMES)

Manage upstream resume event (=remote wakeup) The USB driver sends a resume signal called "Upstream Resume".

#define udd_enable_reset_interrupt

(

)

(USBHS->USBHS_DEVIER = USBHS_DEVIER_EORSTES)

Manage reset event Set when a USB "End of Reset" has been detected.

Referenced by udd_attach().

#define udd_enable_resume_interrupt

(

)

(USBHS->USBHS_DEVIER = USBHS_DEVIER_EORSMES)

Manage downstream resume event (=remote wakeup from host) The USB controller detects a valid "End of Resume" signal initiated by the host.

#define udd_enable_sof_interrupt

(

)

(USBHS->USBHS_DEVIER = USBHS_DEVIER_SOFES)

Manage start of frame event.

Referenced by udd_attach().

#define udd_enable_suspend_interrupt

(

)

(USBHS->USBHS_DEVIER = USBHS_DEVIER_SUSPES)

Manage suspend event.

Referenced by udd_attach(), and udd_interrupt().

#define udd_enable_wake_up_interrupt

(

)

(USBHS->USBHS_DEVIER = USBHS_DEVIER_WAKEUPES)

Manage wake-up event (=usb line activity) The USB controller is reactivated by a filtered non-idle signal from the lines.

Referenced by udd_attach(), and udd_interrupt().

#define UDD_EP_BULK_NB_BANK_ERROR

(

ep

)

(UDD_EP_USED(ep) && UDD_EP_ISO_NBANK_ERROR(ep))

#define UDD_EP_BULK_NBANK_ERROR

(

ep

)

( (UDD_BULK_NB_BANK(ep) < 1) || (UDD_BULK_NB_BANK(ep) > 2) )

#define UDD_EP_INT_NB_BANK_ERROR

(

ep

)

(UDD_EP_USED(ep) && UDD_EP_ISO_NBANK_ERROR(ep))

#define UDD_EP_INT_NBANK_ERROR

(

ep

)

( (UDD_INTERRUPT_NB_BANK(ep) < 1) || (UDD_INTERRUPT_NB_BANK(ep) > 2) )

#define UDD_EP_ISO_NB_BANK_ERROR

(

ep

)

(UDD_EP_USED(ep) && UDD_EP_ISO_NBANK_ERROR(ep))

#define UDD_EP_ISO_NBANK_ERROR

(

ep

)

Value:

( (UDD_ISOCHRONOUS_NB_BANK(ep) < 1)   \
        || (UDD_ISOCHRONOUS_NB_BANK(ep) > 3) )

#define UDD_EP_NB_BANK_ERROR	(		ep,
			type
	)		(ATPASTE3(UDD_EP_, type, _NB_BANK_ERROR(ep)))

#define udd_frame_number

(

)

(Rd_bitfield(USBHS->USBHS_DEVFNUM, USBHS_DEVFNUM_FNUM_Msk))

Referenced by udd_get_frame_number().

#define udd_get_endpoint_bank_max_nbr

(

ep

)

((ep == 0) ? 1 : (( ep <= 2) ? 3 : 2))

Get maximal number of banks of endpoints.

#define udd_get_endpoint_max_nbr

(

)

(9)

Get maximal number of endpoints.

#define udd_get_endpoint_size_max

(

ep

)

(((ep) == 0) ? 64 : 1024)

Get maximal size of endpoint (3X, 1024/64)

#define udd_high_speed_disable

(

)

do { } while (0)

Referenced by udd_enable().

#define udd_high_speed_enable

(

)

do { } while (0)

Referenced by udd_enable().

#define udd_initiate_remote_wake_up

(

)

(Set_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_RMWKUP))

Initiates a remote wake-up event.

Referenced by udd_send_remotewakeup().

#define UDD_INTERRUPT_NB_BANK

(

ep

)

1

#define UDD_INTERRUPT_NB_BANK_ERROR

Value:

(          UDD_EP_NB_BANK_ERROR( 1, INT) \
        || UDD_EP_NB_BANK_ERROR( 2, INT) \
        || UDD_EP_NB_BANK_ERROR( 3, INT) \
        || UDD_EP_NB_BANK_ERROR( 4, INT) \
        || UDD_EP_NB_BANK_ERROR( 5, INT) \
        || UDD_EP_NB_BANK_ERROR( 6, INT) \
        || UDD_EP_NB_BANK_ERROR( 7, INT) \
        || UDD_EP_NB_BANK_ERROR( 8, INT) \
        || UDD_EP_NB_BANK_ERROR( 9, INT) \
        || UDD_EP_NB_BANK_ERROR(10, INT) \
        || UDD_EP_NB_BANK_ERROR(11, INT) \
        || UDD_EP_NB_BANK_ERROR(12, INT) \
        || UDD_EP_NB_BANK_ERROR(13, INT) \
        || UDD_EP_NB_BANK_ERROR(14, INT) \
        || UDD_EP_NB_BANK_ERROR(15, INT) )

#define UDD_ISO_NB_BANK_ERROR

Value:

(          UDD_EP_NB_BANK_ERROR( 1, ISO) \
        || UDD_EP_NB_BANK_ERROR( 2, ISO) \
        || UDD_EP_NB_BANK_ERROR( 3, ISO) \
        || UDD_EP_NB_BANK_ERROR( 4, ISO) \
        || UDD_EP_NB_BANK_ERROR( 5, ISO) \
        || UDD_EP_NB_BANK_ERROR( 6, ISO) \
        || UDD_EP_NB_BANK_ERROR( 7, ISO) \
        || UDD_EP_NB_BANK_ERROR( 8, ISO) \
        || UDD_EP_NB_BANK_ERROR( 9, ISO) \
        || UDD_EP_NB_BANK_ERROR(10, ISO) \
        || UDD_EP_NB_BANK_ERROR(11, ISO) \
        || UDD_EP_NB_BANK_ERROR(12, ISO) \
        || UDD_EP_NB_BANK_ERROR(13, ISO) \
        || UDD_EP_NB_BANK_ERROR(14, ISO) \
        || UDD_EP_NB_BANK_ERROR(15, ISO) )

#define UDD_ISOCHRONOUS_NB_BANK

(

ep

)

2

#define udd_low_speed_disable

(

)

(Clr_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_LS))

Referenced by udd_enable().

#define udd_low_speed_enable

(

)

(Set_bits(USBHS->USBHS_DEVCTRL, USBHS_DEVCTRL_LS))

Enable/disable device low-speed mode.

Referenced by udd_enable().

#define UDD_MAX_PEP_NB   (udd_get_endpoint_max_nbr() + 1)

#define udd_micro_frame_number

(

)

(Rd_bitfield(USBHS->USBHS_DEVFNUM, (USBHS_DEVFNUM_FNUM_Msk|USBHS_DEVFNUM_MFNUM_Msk)))

Referenced by udd_get_micro_frame_number().

#define udd_raise_msof

(

)

(USBHS->USBHS_DEVIFR = USBHS_DEVIFR_MSOFS)

#define udd_raise_remote_wake_up_start

(

)

(USBHS->USBHS_DEVIFR = USBHS_DEVIFR_UPRSMS)

#define udd_raise_reset

(

)

(USBHS->USBHS_DEVIFR = USBHS_DEVIFR_EORSTS)

#define udd_raise_resume

(

)

(USBHS->USBHS_DEVIFR = USBHS_DEVIFR_EORSMS)

#define udd_raise_sof

(

)

(USBHS->USBHS_DEVIFR = USBHS_DEVIFR_SOFS)

#define udd_raise_suspend

(

)

(USBHS->USBHS_DEVIFR = USBHS_DEVIFR_SUSPS)

Referenced by udd_attach().

#define udd_raise_wake_up

(

)

(USBHS->USBHS_DEVIFR = USBHS_DEVIFR_WAKEUPS)

#define USBHS_DEVEPTCFG_EPDIR_Pos   8

enum udd_ctrl_ep_state_t

Bit definitions about endpoint control state machine for udd_ep_control_state.

Enumerator
UDD_EPCTRL_SETUP	Wait a SETUP packet.
UDD_EPCTRL_DATA_OUT	Wait a OUT data packet.
UDD_EPCTRL_DATA_IN	Wait a IN data packet.
UDD_EPCTRL_HANDSHAKE_WAIT_IN_ZLP	Wait a IN ZLP packet.
UDD_EPCTRL_HANDSHAKE_WAIT_OUT_ZLP	Wait a OUT ZLP packet.
UDD_EPCTRL_STALL_REQ	STALL enabled on IN & OUT packet.

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_msof, udd_ack_reset, udd_ack_sof, udd_ack_wake_up, udd_attach_device, udd_enable_msof_interrupt, 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().

static void udd_ctrl_endofrequest ( void  )

static

Call callback associated to setup request.

Referenced by udd_ctrl_in_sent(), udd_ctrl_out_received(), and udd_ctrl_setup_received().

static void udd_ctrl_in_sent ( void  )

static

Managed reception of IN packet on control endpoint.

References Assert, cpu_irq_restore(), cpu_irq_save(), Is_udd_out_received, udd_ack_in_send, udd_ctrl_endofrequest(), udd_ctrl_init(), udd_ctrl_payload_buf_cnt, udd_ctrl_send_zlp_out(), udd_disable_in_send_interrupt, udd_enable_in_send_interrupt, UDD_EPCTRL_DATA_IN, UDD_EPCTRL_HANDSHAKE_WAIT_IN_ZLP, UDD_EPCTRL_HANDSHAKE_WAIT_OUT_ZLP, udd_get_endpoint_fifo_access, and USB_DEVICE_EP_CTRL_SIZE.

Referenced by udd_ctrl_interrupt(), and udd_ctrl_setup_received().

static void udd_ctrl_init ( void  )

static

Reset control endpoint management.

Called after a USB line reset or at the end of SETUP request (after ZLP)

References cpu_irq_restore(), cpu_irq_save(), NULL, udd_ack_out_received, udd_disable_in_send_interrupt, and UDD_EPCTRL_SETUP.

Referenced by udd_ctrl_in_sent(), udd_ctrl_out_received(), udd_ctrl_setup_received(), and udd_interrupt().

static bool udd_ctrl_interrupt ( void  )

static

Main interrupt routine for control endpoint.

This switchs control endpoint events to correct sub function.

Returns

1 if an event about control endpoint is occured, otherwise 0.

References dbg_print, Is_udd_endpoint_interrupt, Is_udd_in_send, Is_udd_in_send_interrupt_enabled, Is_udd_nak_in, Is_udd_nak_out, Is_udd_out_received, Is_udd_setup_received, udd_ack_nak_in, udd_ack_nak_out, udd_ctrl_in_sent(), udd_ctrl_out_received(), udd_ctrl_overflow(), udd_ctrl_setup_received(), udd_ctrl_underflow(), udd_disable_nak_in_interrupt, udd_disable_nak_out_interrupt, and USBHS_ARRAY.

Referenced by udd_interrupt().

static void udd_ctrl_out_received ( void  )

static

Managed reception of OUT packet on control endpoint.

References cpu_irq_restore(), cpu_irq_save(), NULL, udd_ack_nak_in, udd_ack_out_received, udd_byte_count, udd_ctrl_endofrequest(), udd_ctrl_init(), udd_ctrl_payload_buf_cnt, udd_ctrl_send_zlp_in(), udd_ctrl_stall_data(), udd_enable_nak_in_interrupt, UDD_EPCTRL_DATA_IN, UDD_EPCTRL_DATA_OUT, UDD_EPCTRL_HANDSHAKE_WAIT_OUT_ZLP, udd_get_endpoint_fifo_access, and USB_DEVICE_EP_CTRL_SIZE.

Referenced by udd_ctrl_interrupt().

static void udd_ctrl_overflow ( void  )

static

Managed overflow event of OUT packet on control endpoint.

References Is_udd_in_send, udd_enable_stall_handshake, and UDD_EPCTRL_HANDSHAKE_WAIT_IN_ZLP.

Referenced by udd_ctrl_interrupt().

static void udd_ctrl_send_zlp_in ( void  )

static

Send a ZLP IN on control endpoint.

References cpu_irq_restore(), cpu_irq_save(), udd_ack_in_send, udd_ack_nak_out, udd_enable_in_send_interrupt, udd_enable_nak_out_interrupt, and UDD_EPCTRL_HANDSHAKE_WAIT_IN_ZLP.

Referenced by udd_ctrl_out_received(), udd_ctrl_setup_received(), and udd_ctrl_underflow().

static void udd_ctrl_send_zlp_out ( void  )

static

Send a ZLP OUT on control endpoint.

References cpu_irq_restore(), cpu_irq_save(), udd_ack_nak_in, udd_enable_nak_in_interrupt, and UDD_EPCTRL_HANDSHAKE_WAIT_OUT_ZLP.

Referenced by udd_ctrl_in_sent().

static void udd_ctrl_setup_received ( void  )

static

Managed reception of SETUP packet on control endpoint.

References cpu_irq_restore(), cpu_irq_save(), le16_to_cpu, udc_process_setup(), udd_ack_nak_in, udd_ack_setup_received, udd_byte_count, udd_ctrl_endofrequest(), udd_ctrl_in_sent(), udd_ctrl_init(), udd_ctrl_send_zlp_in(), udd_ctrl_stall_data(), udd_enable_nak_in_interrupt, UDD_EPCTRL_DATA_IN, UDD_EPCTRL_DATA_OUT, UDD_EPCTRL_SETUP, udd_get_endpoint_fifo_access, and Udd_setup_is_in.

Referenced by udd_ctrl_interrupt().

static void udd_ctrl_stall_data ( void  )

static

Managed stall event of IN/OUT packet on control endpoint.

References udd_enable_stall_handshake, and UDD_EPCTRL_STALL_REQ.

Referenced by udd_ctrl_out_received(), and udd_ctrl_setup_received().

static void udd_ctrl_underflow ( void  )

static

Managed underflow event of IN packet on control endpoint.

References Is_udd_out_received, udd_ctrl_send_zlp_in(), udd_enable_stall_handshake, UDD_EPCTRL_DATA_OUT, and UDD_EPCTRL_HANDSHAKE_WAIT_OUT_ZLP.

Referenced by udd_ctrl_interrupt().

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_forced, Is_otg_id_host, otg_disable, otg_freeze_clock, otg_unfreeze_clock, pmc_disable_periph_clk(), sleepmgr_unlock_mode(), sysclk_disable_usb(), and udd_detach().

Referenced by udc_stop().

void udd_enable

(

void

)

Enables the USB Device mode.

References cpu_irq_restore(), cpu_irq_save(), Is_otg_clock_usable, Is_otg_id_device, Is_otg_vbus_high, otg_dual_enable(), otg_enable, otg_freeze_clock, otg_unfreeze_clock, otg_vbus_init, pmc_enable_periph_clk(), pmc_set_fast_startup_input(), sleepmgr_lock_mode(), sysclk_enable_usb(), udd_attach(), udd_high_speed_disable, udd_high_speed_enable, udd_low_speed_disable, udd_low_speed_enable, udd_sleep_mode(), and UDD_USB_INT_LEVEL.

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().

void udd_interrupt

(

void

)

Function called by USBHS interrupt to manage USB Device interrupts.

USB Device interrupt events are splited in three parts:

• USB line events (SOF, reset, suspend, resume, wakeup)
• control endpoint events (setup reception, end of data transfer, underflow, overflow, stall)
• bulk/interrupt/isochronous endpoints events (end of data transfer)

Note: Here, the global interrupt mask is not clear when an USB interrupt is enabled because this one can not be occured during the USB ISR (=during INTX is masked). See Technical reference $3.8.3 Masking interrupt requests in peripheral modules.

References cpu_irq_disable, dbg_print, Is_otg_clock_usable, Is_udd_full_speed_mode, Is_udd_msof, Is_udd_reset, Is_udd_sof, Is_udd_suspend, Is_udd_suspend_interrupt_enabled, Is_udd_wake_up, Is_udd_wake_up_interrupt_enabled, otg_freeze_clock, otg_unfreeze_clock, udc_reset(), UDC_RESUME_EVENT, UDC_SOF_EVENT, udc_sof_notify(), UDC_SUSPEND_EVENT, udd_ack_msof, udd_ack_reset, udd_ack_sof, udd_ctrl_init(), udd_ctrl_interrupt(), udd_disable_suspend_interrupt, udd_disable_wake_up_interrupt, udd_enable_suspend_interrupt, udd_enable_wake_up_interrupt, udd_is_high_speed(), udd_reset_ep_ctrl(), and udd_sleep_mode().

Referenced by ISR().

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(), udd_interrupt(), and udi_cdc_tx_send().

static void udd_reset_ep_ctrl ( void  )

static

Reset control endpoint.

Called after a USB line reset or when UDD is enabled

References cpu_irq_restore(), cpu_irq_save(), udd_allocate_memory, udd_configure_address, udd_configure_endpoint, udd_enable_address, udd_enable_endpoint, udd_enable_endpoint_interrupt, udd_enable_out_received_interrupt, udd_enable_setup_received_interrupt, USB_DEVICE_EP_CTRL_SIZE, and USB_EP_TYPE_CONTROL.

Referenced by udd_interrupt().

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

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().

static void udd_sleep_mode ( bool  b_idle )

static

Referenced by udd_attach(), udd_detach(), udd_enable(), udd_interrupt(), and udd_send_remotewakeup().

uint16_t udd_ctrl_payload_buf_cnt

static

Number of data received/sent to/from udd_g_ctrlreq.payload buffer.

Referenced by udd_ctrl_in_sent(), and udd_ctrl_out_received().

uint16_t udd_ctrl_prev_payload_buf_cnt

static

Total number of data received/sent during data packet phase with previous payload buffers.

udd_ctrl_ep_state_t udd_ep_control_state

static

State of the endpoint control management.

COMPILER_WORD_ALIGNED 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(), udi_cdc_comm_setup(), udi_cdc_setup_to_port(), udi_hid_generic_setfeature_valid(), udi_hid_generic_setreport(), udi_hid_kbd_setreport(), udi_hid_reqstdifaceget_descriptor(), udi_hid_setup(), udi_msc_setup(), udi_phdc_setup(), and udi_vendor_setup().