Atmel Software Framework

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
USBB Host Driver

USBB low-level driver for USB host mode.

USB dual role configuration

The defines UHD_ENABLE and UDD_ENABLE must be added in project to allow the USB low level (UHD) to manage or not the dual role (device and host).

USBB Custom configuration

The following USBB driver configuration must be defined in conf_usb_host.h file of the application.

UHD_USB_INT_LEVEL
Option to change the interrupt priority (0 to 3) by default 0 (recommended).

UHD_ISOCHRONOUS_NB_BANK
Feature to reduce or increase isochronous endpoints buffering (1 to 2). Default value 2.

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

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

management

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

Power

The driver uses the sleepmgr service to manage the different sleep modes. The sleep mode depends on USB driver state (uhd_usbb_state_enum).

Warning
Bit-masks are used instead of bit-fields because PB registers require 32-bit write accesses while AVR32-GCC 4.0.2 builds 8-bit accesses even when volatile unsigned int bit-fields are specified.

Data Structures

struct  uhd_ctrl_request_t
 Structure to store the high level setup request. More...
 
struct  uhd_pipe_job_t
 Structure definition to store registered jobs on a pipe. More...
 

Macros

#define UHD_BULK_NB_BANK   2
 
#define UHD_INTERRUPT_NB_BANK   1
 
#define UHD_ISOCHRONOUS_NB_BANK   2
 

Functions

 ISR (otg_interrupt, AVR32_USBB_IRQ_GROUP, UHD_USB_INT_LEVEL)
 Function called by USBB interrupt handler to manage USB interrupts. More...
 
void otg_dual_disable (void)
 Uninitialize the dual role This function is implemented in usbb_host.c file. More...
 
bool otg_dual_enable (void)
 Initialize the dual role This function is implemented in usbb_host.c file. More...
 
static void uhd_ctrl_interrupt (void)
 Manages the events related to control endpoint. More...
 
static void uhd_ctrl_phase_data_in (void)
 Manages the DATA IN phase on control endpoint. More...
 
static void uhd_ctrl_phase_data_in_start (void)
 Starts the DATA IN phase on control endpoint. More...
 
static void uhd_ctrl_phase_data_out (void)
 Manages the DATA OUT phase on control endpoint. More...
 
static void uhd_ctrl_phase_setup (void)
 Sends a USB setup packet to start a control request sequence. More...
 
static void uhd_ctrl_phase_zlp_in (void)
 Starts the ZLP IN phase on control endpoint. More...
 
static void uhd_ctrl_phase_zlp_out (void)
 Starts the ZLP OUT phase on control endpoint. More...
 
static void uhd_ctrl_request_end (uhd_trans_status_t status)
 Call the callback linked to control request and start the next request from the queue. More...
 
void uhd_disable (bool b_id_stop)
 Disables the USB host mode. More...
 
void uhd_enable (void)
 Enables the USB host mode Start the ID pin management if the ID pin is available. More...
 
bool uhd_ep0_alloc (usb_add_t add, uint8_t ep_size)
 Configures and enables a control endpoint 0. More...
 
void uhd_ep_abort (usb_add_t add, usb_ep_t endp)
 Aborts an on-going transfer on an endpoint. More...
 
static void uhd_ep_abort_pipe (uint8_t pipe, uhd_trans_status_t status)
 Aborts the on going transfer on a pipe. More...
 
bool uhd_ep_alloc (usb_add_t add, usb_ep_desc_t *ep_desc)
 Configures and enables an endpoint. More...
 
void uhd_ep_free (usb_add_t add, usb_ep_t endp)
 Disables an endpoint or all endpoint of a device. More...
 
bool uhd_ep_run (usb_add_t add, usb_ep_t endp, bool b_shortpacket, uint8_t *buf, iram_size_t buf_size, uint16_t timeout, uhd_callback_trans_t callback)
 Allows to receive or send data on an endpoint. More...
 
uint16_t uhd_get_frame_number (void)
 Returns the current Start Of Frame (SOF) number. More...
 
uint16_t uhd_get_microframe_number (void)
 Returns the current micro start of frame number. More...
 
static uint8_t uhd_get_pipe (usb_add_t add, usb_ep_t endp)
 Returns the pipe number matching a USB endpoint. More...
 
uhd_speed_t uhd_get_speed (void)
 Returns the speed of connected device. More...
 
static void uhd_interrupt (void)
 Function called by USBB interrupt to manage USB host interrupts. More...
 
bool uhd_is_suspend (void)
 Test if the suspend state is enabled on the USB line. More...
 
static void uhd_pipe_finish_job (uint8_t pipe, uhd_trans_status_t status)
 Call the callback linked to the end of pipe transfer. More...
 
static uhd_trans_status_t uhd_pipe_get_error (uint8_t pipe)
 Translates the USBB pipe error to UHD error. More...
 
static void uhd_pipe_interrupt (uint8_t pipe)
 Manages the following pipe interrupts: More...
 
static void uhd_pipe_interrupt_dma (uint8_t pipe)
 Manages the pipe DMA interrupt. More...
 
static void uhd_pipe_trans_complet (uint8_t pipe)
 Computes and starts the next transfer on a pipe. More...
 
void uhd_resume (void)
 Enables the IDLE state on the USB line. More...
 
void uhd_send_reset (uhd_callback_reset_t callback)
 Enables the Reset state on the USB line. More...
 
bool uhd_setup_request (usb_add_t add, usb_setup_req_t *req, uint8_t *payload, uint16_t payload_size, uhd_callback_setup_run_t callback_run, uhd_callback_setup_end_t callback_end)
 Add a setup request in the control endpoint setup queue. More...
 
static void uhd_sof_interrupt (void)
 Manages timeouts and actions based on SOF events. More...
 
void uhd_suspend (void)
 Enables the suspend state on the USB line. More...
 

Variables

static bool otg_initialized = false
 State of USBB OTG initialization. More...
 
static uhd_callback_reset_t uhd_reset_callback = NULL
 Store the callback to be call at the end of reset signal. More...
 

Power management

enum  uhd_usbb_state_enum {
  UHD_STATE_OFF = 0,
  UHD_STATE_WAIT_ID_HOST = 1,
  UHD_STATE_NO_VBUS = 2,
  UHD_STATE_DISCONNECT = 3,
  UHD_STATE_SUSPEND = 4,
  UHD_STATE_IDLE = 5
}
 States of USBB interface. More...
 
static void uhd_sleep_mode (enum uhd_usbb_state_enum new_state)
 Manages the sleep mode following the USBB state. More...
 

Control endpoint low level management routine.

This function performs control endpoint management.

It handles the SETUP/DATA/HANDSHAKE phases of a control transaction.

enum  uhd_ctrl_request_phase_t {
  UHD_CTRL_REQ_PHASE_SETUP = 0,
  UHD_CTRL_REQ_PHASE_DATA_OUT = 1,
  UHD_CTRL_REQ_PHASE_DATA_IN = 2,
  UHD_CTRL_REQ_PHASE_ZLP_IN = 3,
  UHD_CTRL_REQ_PHASE_ZLP_OUT = 4
}
 Bit definitions to store setup request state machine. More...
 
struct uhd_ctrl_request_tuhd_ctrl_request_first
 Entry points of setup request list. More...
 
struct uhd_ctrl_request_tuhd_ctrl_request_last
 
volatile uint16_t uhd_ctrl_request_timeout
 Remaining time for on-going setup request (No request on-going if equal 0) More...
 
uint16_t uhd_ctrl_nb_trans
 Number of transfered byte on DATA phase of current setup request. More...
 
static bool uhd_b_suspend_requested
 Flag to delay a suspend request after all on-going setup request. More...
 
uhd_ctrl_request_phase_t uhd_ctrl_request_phase
 

Management of bulk/interrupt/isochronous endpoints

The UHD manages the data transfer on endpoints:

  • Start data transfer on endpoint with USB DMA
  • Send a ZLP packet if requested
  • Call registered callback to signal end of transfer The transfer abort and stall feature are supported.
static uhd_pipe_job_t uhd_pipe_job [AVR32_USBB_EPT_NUM-1]
 Array to register a job on bulk/interrupt/isochronous endpoint. More...
 
static uint8_t uhd_suspend_start
 Variables to manage the suspend/resume sequence. More...
 
static uint8_t uhd_resume_start
 
static uint8_t uhd_pipes_unfreeze
 

USBB Host IP properties

These macros give access to IP properties

Get maximal number of endpoints

#define uhd_get_pipe_max_nbr()
 

Host Vbus line control

VBOF is an optional output pin which allows to enable or disable the external VBus generator.

Enables hardware control of USB_VBOF output pin when a Vbus error occur

#define uhd_enable_vbus_error_hw_control()   USBB_CLR_BITS(USBCON,VBUSHWC)
 
#define uhd_disable_vbus_error_hw_control()   USBB_SET_BITS(USBCON,VBUSHWC)
 Disables hardware control of USB_VBOF output pin when a Vbus error occur. More...
 
#define USB_VBOF_PIN   ATPASTE2(USB_VBOF, _PIN)
 Pin and function for USB_VBOF according to configuration from USB_VBOF. More...
 
#define USB_VBOF_FUNCTION   ATPASTE2(USB_VBOF, _FUNCTION)
 
#define uhd_output_vbof_pin()
 Output USB_VBOF onto its pin. More...
 
#define uhd_set_vbof_active_high()   USBB_CLR_BITS(USBCON,VBUSPO)
 Set USB_VBOF output pin polarity. More...
 
#define uhd_set_vbof_active_low()   USBB_SET_BITS(USBCON,VBUSPO)
 
#define uhd_enable_vbus()   USBB_REG_SET(USBSTA,VBUSRQ)
 Requests VBus activation. More...
 
#define uhd_disable_vbus()   USBB_REG_CLR(USBSTA,VBUSRQ)
 Requests VBus deactivation. More...
 
#define Is_uhd_vbus_enabled()   USBB_TST_BITS(USBSTA,VBUSRQ)
 Tests if VBus activation has been requested. More...
 

Host Vbus line monitoring

The VBus level is always checked by USBB hardware.

#define uhd_enable_vbus_error_interrupt()   USBB_SET_BITS(USBCON,VBERRE)
 
#define uhd_disable_vbus_error_interrupt()   USBB_CLR_BITS(USBCON,VBERRE)
 
#define Is_uhd_vbus_error_interrupt_enabled()   USBB_TST_BITS(USBCON,VBERRE)
 
#define uhd_ack_vbus_error_interrupt()   USBB_REG_CLR(USBSTA,VBERRI)
 
#define Is_uhd_vbus_error_interrupt()   USBB_TST_BITS(USBSTA,VBERRI)
 

USB device connection/disconnection monitoring

#define uhd_enable_connection_int()   USBB_REG_SET(UHINTE,DCONNIE)
 
#define uhd_disable_connection_int()   USBB_REG_CLR(UHINTE,DCONNIE)
 
#define Is_uhd_connection_int_enabled()   USBB_TST_BITS(UHINTE,DCONNIE)
 
#define uhd_ack_connection()   USBB_REG_CLR(UHINT,DCONNI)
 
#define Is_uhd_connection()   USBB_TST_BITS(UHINT,DCONNI)
 
#define uhd_enable_disconnection_int()   USBB_REG_SET(UHINTE,DDISCIE)
 
#define uhd_disable_disconnection_int()   USBB_REG_CLR(UHINTE,DDISCIE)
 
#define Is_uhd_disconnection_int_enabled()   USBB_TST_BITS(UHINTE,DDISCIE)
 
#define uhd_ack_disconnection()   USBB_REG_CLR(UHINT,DDISCI)
 
#define Is_uhd_disconnection()   USBB_TST_BITS(UHINT,DDISCI)
 

USB device speed control

#define uhd_get_speed_mode()   USBB_RD_BITFIELD(USBSTA,SPEED)
 
#define Is_uhd_low_speed_mode()   (USBB_RD_BITFIELD(USBSTA,SPEED) == AVR32_USBB_USBSTA_SPEED_LOW)
 
#define Is_uhd_full_speed_mode()   (USBB_RD_BITFIELD(USBSTA,SPEED) == AVR32_USBB_USBSTA_SPEED_FULL)
 
#define Is_uhd_high_speed_mode()   false
 

Bus events control

These macros manage the bus events: reset, SOF, resume, wakeup.

#define uhd_start_reset()   USBB_SET_BITS(UHCON,RESET)
 Initiates a reset event. More...
 
#define Is_uhd_starting_reset()   USBB_TST_BITS(UHCON,RESET)
 
#define uhd_stop_reset()   USBB_CLR_BITS(UHCON,RESET)
 
#define uhd_enable_reset_sent_interrupt()   USBB_REG_SET(UHINTE,RSTIE)
 
#define uhd_disable_reset_sent_interrupt()   USBB_REG_CLR(UHINTE,RSTIE)
 
#define Is_uhd_reset_sent_interrupt_enabled()   USBB_TST_BITS(UHINTE,RSTIE)
 
#define uhd_ack_reset_sent()   USBB_REG_CLR(UHINT,RSTI)
 
#define Is_uhd_reset_sent()   USBB_TST_BITS(UHINT,RSTI)
 
#define uhd_enable_sof()   USBB_SET_BITS(UHCON,SOFE)
 Initiates a SOF events. More...
 
#define uhd_disable_sof()   USBB_CLR_BITS(UHCON,SOFE)
 
#define Is_uhd_sof_enabled()   USBB_TST_BITS(UHCON,SOFE)
 
#define uhd_get_sof_number()   USBB_RD_BITFIELD(UHFNUM,FNUM)
 
#define uhd_get_microsof_number()
 
#define uhd_get_frame_position()   USBB_RD_BITFIELD(UHFNUM,FLENHIGH)
 
#define uhd_enable_sof_interrupt()   USBB_REG_SET(UHINTE,HSOFIE)
 
#define uhd_disable_sof_interrupt()   USBB_REG_CLR(UHINTE,HSOFIE)
 
#define Is_uhd_sof_interrupt_enabled()   USBB_TST_BITS(UHINTE,HSOFIE)
 
#define uhd_ack_sof()   USBB_REG_CLR(UHINT,HSOFI)
 
#define Is_uhd_sof()   USBB_TST_BITS(UHINT,HSOFI)
 
#define uhd_send_resume()   USBB_SET_BITS(UHCON,RESUME)
 Initiates a resume event It is called downstream resume event. More...
 
#define Is_uhd_sending_resume()   USBB_TST_BITS(UHCON,RESUME)
 
#define uhd_enable_downstream_resume_interrupt()   USBB_REG_SET(UHINTE,RSMEDIE)
 
#define uhd_disable_downstream_resume_interrupt()   USBB_REG_CLR(UHINTE,RSMEDIE)
 
#define Is_uhd_downstream_resume_interrupt_enabled()   USBB_TST_BITS(UHINTE,RSMEDIE)
 
#define uhd_ack_downstream_resume()   USBB_REG_CLR(UHINT,RSMEDI)
 
#define Is_uhd_downstream_resume()   USBB_TST_BITS(UHINT,RSMEDI)
 
#define uhd_enable_wakeup_interrupt()   USBB_REG_SET(UHINTE,HWUPIE)
 Detection of a wake-up event A wake-up event is received when the host controller is in the suspend mode: More...
 
#define uhd_disable_wakeup_interrupt()   USBB_REG_CLR(UHINTE,HWUPIE)
 
#define Is_uhd_wakeup_interrupt_enabled()   USBB_TST_BITS(UHINTE,HWUPIE)
 
#define uhd_ack_wakeup()   USBB_REG_CLR(UHINT,HWUPI)
 
#define Is_uhd_wakeup()   USBB_TST_BITS(UHINT,HWUPI)
 
#define uhd_enable_upstream_resume_interrupt()   USBB_REG_SET(UHINTE,RXRSMIE)
 
#define uhd_disable_upstream_resume_interrupt()   USBB_REG_CLR(UHINTE,RXRSMIE)
 
#define Is_uhd_upstream_resume_interrupt_enabled()   USBB_TST_BITS(UHINTE,RXRSMIE)
 
#define uhd_ack_upstream_resume()   USBB_REG_CLR(UHINT,RXRSMI)
 
#define Is_uhd_upstream_resume()   USBB_TST_BITS(UHINT,RXRSMI)
 

#define Is_uhd_connection ( )    USBB_TST_BITS(UHINT,DCONNI)

Referenced by uhd_interrupt().

#define Is_uhd_connection_int_enabled ( )    USBB_TST_BITS(UHINTE,DCONNIE)

Referenced by uhd_interrupt().

#define Is_uhd_disconnection ( )    USBB_TST_BITS(UHINT,DDISCI)

Referenced by uhd_interrupt(), and uhd_sof_interrupt().

#define Is_uhd_disconnection_int_enabled ( )    USBB_TST_BITS(UHINTE,DDISCIE)

Referenced by uhd_interrupt().

#define Is_uhd_downstream_resume ( )    USBB_TST_BITS(UHINT,RSMEDI)

Referenced by uhd_interrupt().

#define Is_uhd_downstream_resume_interrupt_enabled ( )    USBB_TST_BITS(UHINTE,RSMEDIE)
#define Is_uhd_full_speed_mode ( )    (USBB_RD_BITFIELD(USBSTA,SPEED) == AVR32_USBB_USBSTA_SPEED_FULL)
#define Is_uhd_high_speed_mode ( )    false

Referenced by uhd_interrupt(), and uhd_sof_interrupt().

#define Is_uhd_low_speed_mode ( )    (USBB_RD_BITFIELD(USBSTA,SPEED) == AVR32_USBB_USBSTA_SPEED_LOW)
#define Is_uhd_reset_sent ( )    USBB_TST_BITS(UHINT,RSTI)

Referenced by uhd_interrupt().

#define Is_uhd_reset_sent_interrupt_enabled ( )    USBB_TST_BITS(UHINTE,RSTIE)
#define Is_uhd_sending_resume ( )    USBB_TST_BITS(UHCON,RESUME)
#define Is_uhd_sof ( )    USBB_TST_BITS(UHINT,HSOFI)

Referenced by uhd_interrupt().

#define Is_uhd_sof_enabled ( )    USBB_TST_BITS(UHCON,SOFE)

Referenced by uhd_is_suspend(), and uhd_resume().

#define Is_uhd_sof_interrupt_enabled ( )    USBB_TST_BITS(UHINTE,HSOFIE)
#define Is_uhd_starting_reset ( )    USBB_TST_BITS(UHCON,RESET)
#define Is_uhd_upstream_resume ( )    USBB_TST_BITS(UHINT,RXRSMI)

Referenced by uhd_interrupt().

#define Is_uhd_upstream_resume_interrupt_enabled ( )    USBB_TST_BITS(UHINTE,RXRSMIE)
#define Is_uhd_vbus_enabled ( )    USBB_TST_BITS(USBSTA,VBUSRQ)

Tests if VBus activation has been requested.

#define Is_uhd_vbus_error_interrupt ( )    USBB_TST_BITS(USBSTA,VBERRI)

Referenced by uhd_interrupt().

#define Is_uhd_vbus_error_interrupt_enabled ( )    USBB_TST_BITS(USBCON,VBERRE)
#define Is_uhd_wakeup ( )    USBB_TST_BITS(UHINT,HWUPI)

Referenced by uhd_interrupt().

#define Is_uhd_wakeup_interrupt_enabled ( )    USBB_TST_BITS(UHINTE,HWUPIE)

Referenced by uhd_interrupt().

#define uhd_ack_connection ( )    USBB_REG_CLR(UHINT,DCONNI)

Referenced by uhd_interrupt().

#define uhd_ack_disconnection ( )    USBB_REG_CLR(UHINT,DDISCI)

Referenced by uhd_interrupt().

#define uhd_ack_downstream_resume ( )    USBB_REG_CLR(UHINT,RSMEDI)
#define uhd_ack_reset_sent ( )    USBB_REG_CLR(UHINT,RSTI)

Referenced by uhd_interrupt().

#define uhd_ack_sof ( )    USBB_REG_CLR(UHINT,HSOFI)

Referenced by uhd_interrupt().

#define uhd_ack_upstream_resume ( )    USBB_REG_CLR(UHINT,RXRSMI)
#define uhd_ack_vbus_error_interrupt ( )    USBB_REG_CLR(USBSTA,VBERRI)

Referenced by uhd_interrupt().

#define uhd_ack_wakeup ( )    USBB_REG_CLR(UHINT,HWUPI)
#define UHD_BULK_NB_BANK   2

Referenced by uhd_ep_alloc().

#define uhd_disable_connection_int ( )    USBB_REG_CLR(UHINTE,DCONNIE)

Referenced by uhd_interrupt().

#define uhd_disable_disconnection_int ( )    USBB_REG_CLR(UHINTE,DDISCIE)

Referenced by uhd_interrupt().

#define uhd_disable_downstream_resume_interrupt ( )    USBB_REG_CLR(UHINTE,RSMEDIE)
#define uhd_disable_reset_sent_interrupt ( )    USBB_REG_CLR(UHINTE,RSTIE)
#define uhd_disable_sof ( )    USBB_CLR_BITS(UHCON,SOFE)

Referenced by uhd_disable(), and uhd_sof_interrupt().

#define uhd_disable_sof_interrupt ( )    USBB_REG_CLR(UHINTE,HSOFIE)
#define uhd_disable_upstream_resume_interrupt ( )    USBB_REG_CLR(UHINTE,RXRSMIE)
#define uhd_disable_vbus ( )    USBB_REG_CLR(USBSTA,VBUSRQ)

Requests VBus deactivation.

Referenced by uhd_disable().

#define uhd_disable_vbus_error_hw_control ( )    USBB_SET_BITS(USBCON,VBUSHWC)

Disables hardware control of USB_VBOF output pin when a Vbus error occur.

#define uhd_disable_vbus_error_interrupt ( )    USBB_CLR_BITS(USBCON,VBERRE)
#define uhd_disable_wakeup_interrupt ( )    USBB_REG_CLR(UHINTE,HWUPIE)
#define uhd_enable_connection_int ( )    USBB_REG_SET(UHINTE,DCONNIE)

Referenced by uhd_interrupt().

#define uhd_enable_disconnection_int ( )    USBB_REG_SET(UHINTE,DDISCIE)

Referenced by uhd_interrupt().

#define uhd_enable_downstream_resume_interrupt ( )    USBB_REG_SET(UHINTE,RSMEDIE)
#define uhd_enable_reset_sent_interrupt ( )    USBB_REG_SET(UHINTE,RSTIE)
#define uhd_enable_sof ( )    USBB_SET_BITS(UHCON,SOFE)

Initiates a SOF events.

Referenced by uhd_interrupt(), and uhd_resume().

#define uhd_enable_sof_interrupt ( )    USBB_REG_SET(UHINTE,HSOFIE)
#define uhd_enable_upstream_resume_interrupt ( )    USBB_REG_SET(UHINTE,RXRSMIE)
#define uhd_enable_vbus ( )    USBB_REG_SET(USBSTA,VBUSRQ)

Requests VBus activation.

Referenced by uhd_enable().

#define uhd_enable_vbus_error_hw_control ( )    USBB_CLR_BITS(USBCON,VBUSHWC)
#define uhd_enable_vbus_error_interrupt ( )    USBB_SET_BITS(USBCON,VBERRE)
#define uhd_enable_wakeup_interrupt ( )    USBB_REG_SET(UHINTE,HWUPIE)

Detection of a wake-up event A wake-up event is received when the host controller is in the suspend mode:

  • and an upstream resume from the peripheral is detected.
  • and a peripheral disconnection is detected.
#define uhd_get_frame_position ( )    USBB_RD_BITFIELD(UHFNUM,FLENHIGH)

Referenced by uhd_sof_interrupt().

#define uhd_get_microsof_number ( )
Value:
(Rd_bitfield(AVR32_USBB.uhfnum, \
AVR32_USBB_UHFNUM_FNUM_MASK|AVR32_USBB_UHFNUM_MFNUM_MASK))
#define Rd_bitfield(value, mask)
Reads the bit-field of a value specified by a given bit-mask.
Definition: compiler.h:514

Referenced by uhd_get_microframe_number().

#define uhd_get_pipe_max_nbr ( )
Value:
(((USBB_RD_BITFIELD(UFEATURES_EPT_NBR,MAX) - 1) \
& ((1 << AVR32_USBB_UFEATURES_EPT_NBR_MAX_SIZE) - 1)) + 1)
#define USBB_RD_BITFIELD(reg, bit)
Definition: usbb_otg.h:60
#define MAX(a, b)
Definition: jpegint.h:267
#define uhd_get_sof_number ( )    USBB_RD_BITFIELD(UHFNUM,FNUM)

Referenced by uhd_get_frame_number().

#define uhd_get_speed_mode ( )    USBB_RD_BITFIELD(USBSTA,SPEED)

Referenced by uhd_get_speed().

#define UHD_INTERRUPT_NB_BANK   1

Referenced by uhd_ep_alloc().

#define UHD_ISOCHRONOUS_NB_BANK   2

Referenced by uhd_ep_alloc().

#define uhd_output_vbof_pin ( )
Value:
{\
(AVR32_GPIO.port[USB_VBOF_PIN >> 5].pmr0s = 1 << (USB_VBOF_PIN & 0x1F)) :\
(AVR32_GPIO.port[USB_VBOF_PIN >> 5].pmr0c = 1 << (USB_VBOF_PIN & 0x1F)); \
(AVR32_GPIO.port[USB_VBOF_PIN >> 5].pmr1s = 1 << (USB_VBOF_PIN & 0x1F)) :\
(AVR32_GPIO.port[USB_VBOF_PIN >> 5].pmr1c = 1 << (USB_VBOF_PIN & 0x1F)); \
AVR32_GPIO.port[USB_VBOF_PIN >> 5].gperc = 1 << (USB_VBOF_PIN & 0x1F);\
AVR32_GPIO.port[USB_VBOF_PIN >> 5].odmerc = 1 << (USB_VBOF_PIN & 0x1F);\
AVR32_GPIO.port[USB_VBOF_PIN >> 5].puerc = 1 << (USB_VBOF_PIN & 0x1F); }
#define USB_VBOF_FUNCTION
Definition: usbb_host.h:91
#define USB_VBOF_PIN
Pin and function for USB_VBOF according to configuration from USB_VBOF.
Definition: usbb_host.h:90
#define Tst_bits(value, mask)
Tests the bits of a value specified by a given bit-mask.
Definition: compiler.h:478

Output USB_VBOF onto its pin.

Referenced by uhd_enable().

#define uhd_send_resume ( )    USBB_SET_BITS(UHCON,RESUME)

Initiates a resume event It is called downstream resume event.

Referenced by uhd_interrupt(), and uhd_resume().

#define uhd_set_vbof_active_high ( )    USBB_CLR_BITS(USBCON,VBUSPO)

Set USB_VBOF output pin polarity.

Referenced by uhd_enable().

#define uhd_set_vbof_active_low ( )    USBB_SET_BITS(USBCON,VBUSPO)

Referenced by uhd_enable().

#define uhd_start_reset ( )    USBB_SET_BITS(UHCON,RESET)

Initiates a reset event.

Referenced by uhd_send_reset().

#define uhd_stop_reset ( )    USBB_CLR_BITS(UHCON,RESET)

Referenced by uhd_interrupt().

#define USB_VBOF_FUNCTION   ATPASTE2(USB_VBOF, _FUNCTION)
#define USB_VBOF_PIN   ATPASTE2(USB_VBOF, _PIN)

Pin and function for USB_VBOF according to configuration from USB_VBOF.

Bit definitions to store setup request state machine.

Enumerator
UHD_CTRL_REQ_PHASE_SETUP 

Wait a SETUP packet.

UHD_CTRL_REQ_PHASE_DATA_OUT 

Wait a OUT data packet.

UHD_CTRL_REQ_PHASE_DATA_IN 

Wait a IN data packet.

UHD_CTRL_REQ_PHASE_ZLP_IN 

Wait a IN ZLP packet.

UHD_CTRL_REQ_PHASE_ZLP_OUT 

Wait a OUT ZLP packet.

States of USBB interface.

Enumerator
UHD_STATE_OFF 
UHD_STATE_WAIT_ID_HOST 
UHD_STATE_NO_VBUS 
UHD_STATE_DISCONNECT 
UHD_STATE_SUSPEND 
UHD_STATE_IDLE 

ISR ( otg_interrupt  ,
AVR32_USBB_IRQ_GROUP  ,
UHD_USB_INT_LEVEL   
)

Function called by USBB interrupt handler to manage USB interrupts.

It manages the interrupt redirection between host or device interrupt. It answers to OTG events (ID pin change).

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

References Is_otg_clock_usable, Is_otg_device_mode_forced, Is_otg_id_device, Is_otg_id_transition, otg_ack_id_transition, otg_data_memory_barrier, otg_freeze_clock, otg_unfreeze_clock, udc_start(), udc_stop(), udd_interrupt(), UHC_MODE_CHANGE, uhc_start(), uhc_stop(), and uhd_interrupt().

void otg_dual_disable ( void  )

Uninitialize the dual role This function is implemented in usbb_host.c file.

References otg_disable, otg_disable_id_interrupt, otg_disable_pad, otg_initialized, otg_unfreeze_clock, sysclk_disable_usb(), uhd_sleep_mode(), and UHD_STATE_OFF.

Referenced by uhd_disable().

bool otg_dual_enable ( void  )

Initialize the dual role This function is implemented in usbb_host.c file.

Returns
true if the ID pin management has been started, otherwise false.

References irq_register_handler, Is_otg_id_device, otg_ack_id_transition, otg_enable, otg_enable_id_interrupt, otg_freeze_clock, otg_initialized, otg_input_id_pin, otg_unfreeze_clock, pm_asyn_wake_up_enable(), sysclk_enable_usb(), udc_start(), UHC_MODE_CHANGE, uhc_start(), uhd_sleep_mode(), UHD_STATE_OFF, UHD_STATE_WAIT_ID_HOST, and UHD_USB_INT_LEVEL.

Referenced by udd_enable(), and uhd_enable().

static void uhd_ctrl_phase_data_in_start ( void  )
static
static void uhd_ctrl_phase_zlp_in ( void  )
static
static void uhd_ctrl_phase_zlp_out ( void  )
static
void uhd_disable ( bool  b_id_stop)
bool uhd_ep0_alloc ( usb_add_t  add,
uint8_t  ep_size 
)

Configures and enables a control endpoint 0.

Parameters
addUSB address of endpoint
ep_sizeEndpoint control maximum size
Returns
1 if the endpoint is enabled, otherwise 0.

References Is_uhd_pipe_configured, Is_uhd_pipe_enabled, uhd_allocate_memory, uhd_configure_address, uhd_configure_pipe, uhd_disable_pipe, uhd_enable_pipe, uhd_enable_pipe_error_interrupt, uhd_enable_pipe_interrupt, and uhd_enable_stall_interrupt.

Referenced by uhc_enumeration_step11(), uhc_enumeration_step5(), and uhc_enumeration_step9().

void uhd_ep_abort ( usb_add_t  add,
usb_ep_t  endp 
)

Aborts an on-going transfer on an endpoint.

If a transfer is on going, then it is stopped and the callback registered is called to signal the end of transfer. Note: The control endpoint is not authorized.

Parameters
addUSB address of endpoint
endpEndpoint to abort

References uhd_ep_abort_pipe(), uhd_get_pipe(), and UHD_TRANS_ABORTED.

static void uhd_ep_abort_pipe ( uint8_t  pipe,
uhd_trans_status_t  status 
)
static
void uhd_ep_free ( usb_add_t  add,
usb_ep_t  endp 
)

Disables an endpoint or all endpoint of a device.

Parameters
addUSB address of endpoint
endpEndpoint number and direction (USB_EP_DIR_IN/OUT). Remove all endpoints of USB address, if 0xFF.

References uhd_ctrl_request_t::add, Is_uhd_pipe_enabled, uhd_ctrl_request_end(), uhd_ctrl_request_timeout, uhd_disable_pipe, uhd_ep_abort_pipe(), uhd_get_configured_address, uhd_get_pipe_endpoint_address, UHD_TRANS_DISCONNECT, and uhd_unallocate_memory.

Referenced by uhc_connection_tree(), uhc_enumeration_error(), uhc_enumeration_step11(), uhc_enumeration_step14(), uhc_enumeration_step5(), uhc_enumeration_step9(), and uhi_aoa_install().

bool uhd_ep_run ( usb_add_t  add,
usb_ep_t  endp,
bool  b_shortpacket,
uint8_t *  buf,
iram_size_t  buf_size,
uint16_t  timeout,
uhd_callback_trans_t  callback 
)

Allows to receive or send data on an endpoint.

If a USB DMA is available, the driver uses it to transfer endpoint data from or to internal RAM. When the transfer is finished or aborted (stall, reset, ...), the callback is called. This callback returns the transfer status and eventually the number of byte transfered. Note: The control endpoint is not authorized.

Parameters
addUSB address of endpoint
endpEndpoint number
b_shortpacketEnabled automatic short packet
bufBuffer on Internal RAM to send or fill. It must be align, then use COMPILER_WORD_ALIGNED.
buf_sizeBuffer size to send or fill
timeoutTransfer timeout (ms)
callbackNULL or function to call at the end of transfer
Warning
About b_shortpacket, for OUT endpoint it means that a short packet or a Zero Length Packet must be sent to the USB line to properly close the USB transfer at the end of the data transfer. For Bulk and Interrupt IN endpoint, it will automatically stop the transfer at the end of the data transfer (received short packet).
About timeout, for BULK endpoint with timeout set to zero, it means that the transfer will never be stopped before transfer done. Since most of USB embedded peripherals do not manage the transfer bandwidth by peripheral hardware, such a BULK transfer will occupy all USB non-periodic transfer bandwidth. In this case, other BULK transfers started later will be pending until this transfer is done and bandwidth released. So it is better to use BULK transfers with none zero timeout.
Returns
1 if function was successfully done, otherwise 0.

References uhd_pipe_job_t::b_shortpacket, buf, uhd_pipe_job_t::buf, uhd_pipe_job_t::buf_size, uhd_pipe_job_t::busy, uhd_pipe_job_t::call_end, callback, cpu_irq_restore(), cpu_irq_save(), uhd_pipe_job_t::nb_trans, uhd_pipe_job_t::timeout, uhd_get_pipe(), and uhd_pipe_trans_complet().

Referenced by uhi_aoa_read(), uhi_aoa_write(), uhi_cdc_rx_update(), uhi_cdc_tx_update(), uhi_hid_mouse_start_trans_report(), uhi_msc_transfer(), uhi_vendor_bulk_in_run(), uhi_vendor_bulk_out_run(), uhi_vendor_int_in_run(), uhi_vendor_int_out_run(), uhi_vendor_iso_in_run(), and uhi_vendor_iso_out_run().

uint16_t uhd_get_frame_number ( void  )

Returns the current Start Of Frame (SOF) number.

Returns
current start of frame number.

References uhd_get_sof_number.

Referenced by uhi_cdc_rx_received(), uhi_cdc_rx_update(), uhi_cdc_tx_send(), and uhi_cdc_tx_update().

uint16_t uhd_get_microframe_number ( void  )

Returns the current micro start of frame number.

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

References uhd_get_microsof_number.

Referenced by uhi_cdc_rx_received(), uhi_cdc_rx_update(), uhi_cdc_tx_send(), and uhi_cdc_tx_update().

static uint8_t uhd_get_pipe ( usb_add_t  add,
usb_ep_t  endp 
)
static

Returns the pipe number matching a USB endpoint.

Parameters
addUSB address
endpEndpoint number
Returns
Pipe number

References Is_uhd_pipe_enabled, uhd_get_configured_address, and uhd_get_pipe_endpoint_address.

Referenced by uhd_ep_abort(), and uhd_ep_run().

uhd_speed_t uhd_get_speed ( void  )

Returns the speed of connected device.

Returns
Device speed

References Assert, uhd_get_speed_mode, UHD_SPEED_FULL, UHD_SPEED_HIGH, and UHD_SPEED_LOW.

Referenced by uhc_enumeration_step4().

static void uhd_interrupt ( void  )
static
bool uhd_is_suspend ( void  )

Test if the suspend state is enabled on the USB line.

Returns
USB line in SUSPEND state, if true

References Is_uhd_sof_enabled.

Referenced by uhc_is_suspend().

static void uhd_pipe_finish_job ( uint8_t  pipe,
uhd_trans_status_t  status 
)
static

Call the callback linked to the end of pipe transfer.

Parameters
pipePipe number
statusStatus of the transfer

References uhd_pipe_job_t::busy, uhd_pipe_job_t::call_end, uhd_pipe_job_t::nb_trans, NULL, uhd_get_configured_address, and uhd_get_pipe_endpoint_address.

Referenced by uhd_ep_abort_pipe(), uhd_pipe_interrupt(), and uhd_pipe_trans_complet().

static uhd_trans_status_t uhd_pipe_get_error ( uint8_t  pipe)
static

Translates the USBB pipe error to UHD error.

Parameters
pipePipe number to use
Returns
UHD transfer error

References error(), uhd_ack_all_errors, uhd_error_status, UHD_TRANS_DT_MISMATCH, UHD_TRANS_NOTRESPONDING, and UHD_TRANS_PIDFAILURE.

Referenced by uhd_ctrl_interrupt(), and uhd_pipe_interrupt().

static void uhd_pipe_interrupt ( uint8_t  pipe)
static
static void uhd_pipe_interrupt_dma ( uint8_t  pipe)
static
void uhd_resume ( void  )

Enables the IDLE state on the USB line.

The IDLE state is enable when SOF are present on USB line. A Downstream Resume signal can be sent.

References Is_otg_clock_usable, Is_uhd_sof_enabled, otg_unfreeze_clock, uhd_enable_sof, uhd_resume_start, uhd_send_resume, uhd_sleep_mode(), UHD_STATE_IDLE, and uhd_suspend_start.

Referenced by uhc_resume().

void uhd_send_reset ( uhd_callback_reset_t  callback)

Enables the Reset state on the USB line.

Parameters
callbackCallback when reset sequence is finished

References callback, uhd_reset_callback, and uhd_start_reset.

Referenced by uhc_enumeration_reset().

bool uhd_setup_request ( usb_add_t  add,
usb_setup_req_t req,
uint8_t *  payload,
uint16_t  payload_size,
uhd_callback_setup_run_t  callback_run,
uhd_callback_setup_end_t  callback_end 
)

Add a setup request in the control endpoint setup queue.

Note: Request timeout is 5s.

Parameters
addUSB address of control endpoint
reqSetup request definition
payloadBuffer to use in setup DATA phase
payload_sizeSize of buffer used in DATA phase
callback_runCallback to call if buffer is empty or full
callback_endCallback to call when request is finish
Returns
true if the request has been accepted, otherwise false. Note: The swap of "req.wValues" from uin16_t to le16_t is done by UHD.

References uhd_ctrl_request_t::add, Assert, uhd_ctrl_request_t::callback_end, uhd_ctrl_request_t::callback_run, cpu_irq_restore(), cpu_irq_save(), uhd_ctrl_request_t::next_request, NULL, uhd_ctrl_request_t::payload, payload, uhd_ctrl_request_t::payload_size, uhd_ctrl_request_t::req, and uhd_ctrl_phase_setup().

Referenced by uhc_dev_get_string(), uhc_dev_is_high_speed_support(), uhc_enumeration_step11(), uhc_enumeration_step12(), uhc_enumeration_step13(), uhc_enumeration_step14(), uhc_enumeration_step5(), uhc_enumeration_step9(), uhc_remotewakeup(), uhi_aoa_mode_enable_step1(), uhi_aoa_mode_enable_step3(), uhi_aoa_send_info_string(), uhi_cdc_set_conf(), uhi_cdc_set_ctrl_line(), uhi_msc_enable_step1(), uhi_msc_reset_endpoint(), uhi_vendor_control_in_run(), uhi_vendor_control_out_run(), and uhi_vendor_enable().

static void uhd_sleep_mode ( enum uhd_usbb_state_enum  new_state)
static

Manages the sleep mode following the USBB state.

Parameters
new_stateNew USBB state

References SLEEPMGR_FROZEN, SLEEPMGR_IDLE, sleepmgr_lock_mode(), SLEEPMGR_STATIC, SLEEPMGR_STOP, sleepmgr_unlock_mode(), and UHD_STATE_OFF.

Referenced by otg_dual_disable(), otg_dual_enable(), uhd_disable(), uhd_enable(), uhd_interrupt(), uhd_resume(), and uhd_sof_interrupt().

static void uhd_sof_interrupt ( void  )
static

Manages timeouts and actions based on SOF events.

  • Suspend delay
  • Resume delay
  • Setup packet delay
  • Timeout on endpoint control transfer
  • Timeouts on bulk/interrupt/isochronous endpoint transfers
  • UHC user notification
  • SOF user notification

References uhd_pipe_job_t::busy, Is_uhd_disconnection, Is_uhd_high_speed_mode, otg_freeze_clock, uhd_pipe_job_t::timeout, uhc_notify_resume(), uhc_notify_sof(), UHC_SOF_EVENT, uhd_ctrl_request_end(), uhd_ctrl_request_timeout, uhd_disable_sof, uhd_ep_abort_pipe(), uhd_freeze_pipe, uhd_get_frame_position, uhd_pipes_unfreeze, uhd_resume_start, uhd_sleep_mode(), UHD_STATE_SUSPEND, uhd_suspend_start, UHD_TRANS_TIMEOUT, and uhd_unfreeze_pipe.

Referenced by uhd_interrupt().

void uhd_suspend ( void  )

Enables the suspend state on the USB line.

The SUSPEND state is enable when SOF are disabled on USB line.

References Is_uhd_pipe_frozen, uhd_b_suspend_requested, uhd_ctrl_request_timeout, uhd_freeze_pipe, uhd_pipes_unfreeze, and uhd_suspend_start.

Referenced by uhc_enumeration_suspend(), uhc_suspend(), and uhd_ctrl_request_end().

bool otg_initialized = false
static

State of USBB OTG initialization.

Referenced by otg_dual_disable(), and otg_dual_enable().

bool uhd_b_suspend_requested
static

Flag to delay a suspend request after all on-going setup request.

Referenced by uhd_ctrl_request_end(), uhd_enable(), and uhd_suspend().

uint16_t uhd_ctrl_nb_trans

Number of transfered byte on DATA phase of current setup request.

Referenced by uhd_ctrl_phase_data_in(), uhd_ctrl_phase_data_out(), uhd_ctrl_phase_setup(), and uhd_ctrl_request_end().

struct uhd_ctrl_request_t* uhd_ctrl_request_first

Entry points of setup request list.

Referenced by uhd_ctrl_request_end().

struct uhd_ctrl_request_t* uhd_ctrl_request_last
volatile uint16_t uhd_ctrl_request_timeout

Remaining time for on-going setup request (No request on-going if equal 0)

Referenced by uhd_ctrl_interrupt(), uhd_ctrl_phase_setup(), uhd_ctrl_request_end(), uhd_enable(), uhd_ep_free(), uhd_sof_interrupt(), and uhd_suspend().

uhd_pipe_job_t uhd_pipe_job[AVR32_USBB_EPT_NUM-1]
static

Array to register a job on bulk/interrupt/isochronous endpoint.

uint8_t uhd_pipes_unfreeze
static

Referenced by uhd_sof_interrupt(), and uhd_suspend().

uhd_callback_reset_t uhd_reset_callback = NULL
static

Store the callback to be call at the end of reset signal.

Referenced by uhd_interrupt(), and uhd_send_reset().

uint8_t uhd_resume_start
static
uint8_t uhd_suspend_start
static

Variables to manage the suspend/resume sequence.

Referenced by uhd_enable(), uhd_interrupt(), uhd_resume(), uhd_sof_interrupt(), and uhd_suspend().