USB Device Core API#

sl_usbd_device_speed_t#

sl_usbd_device_speed_t

DATA TYPES.

                                  USB DEVICE SPEED DATA TYPE

Note

• (1) 'Universal Serial Bus Specification Rev 2.0', section 4.2.1 defines three data rates:

  • (a) The USB Low-Speed (LS) signaling bit rate is 1.5 Mb/s.

  • (b) The USB Full-Speed (FS) signaling bit rate is 12 Mb/s.

  • (c) The USB High-Speed (HS) signaling bit rate is 480 Mb/s.

sl_usbd_device_state_t#

sl_usbd_device_state_t

                                  USB DEVICE STATES DATA TYPE

Note

• (1) 'Universal Serial Bus Specification Rev 2.0', section 9.1.1 defines seven visible device states:

  • (a) SL_USBD_DEVICE_STATE_INIT : Device is not attached to the USB.

  • (b) SL_USBD_DEVICE_STATE_ATTACHED : Device is attached to the USB, but not powered.

  • (c) USBD_DEV_STATE_POWERED : Device is attached to the USB and powered, but has not been reset.

  • (d) SL_USBD_DEVICE_STATE_DEFAULT : Device is attached to the USB and powered and has been reset, but has not been assigned a unique address. Device responds at the default address.

  • (e) SL_USBD_DEVICE_STATE_ADDRESSED : Device is attached to the USB, powered, has been reset, and a unique device address has been assigned. Device is not configured.

  • (f) SL_USBD_DEVICE_STATE_CONFIGURED : Device is attached to the USB, powered, has been reset, has a unique address, is configured, and is not suspended. The host may now use the function provided by the device.

  • (g) SL_USBD_DEVICE_STATE_SUSPENDED : Device is, at minimum, attached to the USB and is powered and has not seen bus activity for 3 ms. It may also have a unique address and be configured for use. However, because the device is suspended, the host may not use the device's function.

• (2) An additional state is added (USBD_DEV_STATE_START) to determine if the device controller has been initialized.

sl_usbd_bus_event_t#

sl_usbd_bus_event_t

BUS EVENT DATA TYPE.

sl_usbd_config_event_t#

sl_usbd_config_event_t

CONFIG EVENT DATA TYPE.

sl_usbd_async_function_t#

typedef void(* sl_usbd_async_function_t) (uint8_t ep_addr, void *p_buf, uint32_t buf_len, uint32_t xfer_len, void *p_arg, sl_status_t status) )(uint8_t ep_addr, void *p_buf, uint32_t buf_len, uint32_t xfer_len, void *p_arg, sl_status_t status)

EP ASYNCHRONOUS CALLBACK API.

sl_usbd_core_init#

sl_status_t sl_usbd_core_init (void)

FUNCTION PROTOTYPES.

CONFIGURATION OVERRIDE FUNCTIONS USBD CORE FUNCTIONS

Note(s) : (1) USB Spec 2.0, Section 5.5 states "Control transfers allow access to different parts of a device. Control transfers are intended to support configuration/command/status type communication flows between client software and its function".

(a) "Each USB device is required to implement the Default Control Pipe as a message pipe. This pipe is used by the USB System Software. The Default Control Pipe provides access to the USB device's configuration, status, and control information".

The 'sl_usbd_core_ep_XXXX()' functions perform operations in the default endpoint. Class drivers should use 'sl_usbd_core_ep_XXXX()' to send/receive class specific requests.

                                            sl_usbd_core_init()

Initialize the USB device stack.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) sli_usbd_core_init_internals() MUST be called ... :

  • (a) ONLY ONCE from a product's application;

  • (b) With the following conditions:

    • (1) AFTER the product's OS has been initialized.

    • (2) BEFORE the product's application calls any USB device stack function(s).

sl_usbd_core_start_device#

sl_status_t sl_usbd_core_start_device (void)

Start the device stack.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Device stack can be only started if the device is in one of the following states:

  • SL_USBD_DEVICE_STATE_NONE Device controller has not been initialized.

  • SL_USBD_DEVICE_STATE_INIT Device controller is already initialized.

sl_usbd_core_stop_device#

sl_status_t sl_usbd_core_stop_device (void)

Stop the device stack.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_get_device_state#

sl_status_t sl_usbd_core_get_device_state (sl_usbd_device_state_t *p_dev_state)

Get the current device state.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_get_device_speed#

sl_status_t sl_usbd_core_get_device_speed (sl_usbd_device_speed_t *p_dev_speed)

Get device speed.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_set_device_self_power#

sl_status_t sl_usbd_core_set_device_self_power (bool self_pwr)

Set the device's current power source.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_get_device_configuration#

sl_status_t sl_usbd_core_get_device_configuration (sl_usbd_device_config_t **p_dev_cfg)

Set the device's Microsoft vendor code.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) The vendor code used MUST be different from any vendor bRequest value.

Get the device configuration.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_get_device_frame_number#

sl_status_t sl_usbd_core_get_device_frame_number (uint16_t *p_frame_nbr)

Get the last frame number from the driver.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) The frame number will always be in the range of 0-2047 (11 bits).

• (2) Frame number returned to the caller contains the frame and microframe numbers. It is encoded following this 16-bit format:

  *               | 15 | 14 | 13 | 12 | 11 | 10 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 0 |
  *               |  0    0 |  microframe  |                  frame                     |
  *               

  Caller must use the macros SL_USBD_FRAME_NBR_GET() or SL_USBD_MICROFRAME_NBR_GET() to get the frame or microframe number only.

sl_usbd_core_add_configuration#

sl_status_t sl_usbd_core_add_configuration (uint8_t attrib, uint16_t max_pwr, sl_usbd_device_speed_t spd, const char *p_name, uint8_t *p_cfg_nbr)

Add a configuration attribute to the device.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) USB spec 2.0 (section 7.2.1.3/4) defines power constraints for bus-powered devices: "A low-power function draws up to one unit load from the USB cable when operational" "A function is high-power if, when fully powered, draws over one, but no more than five, unit loads from the USB cable." A unit load is defined as 100mA, so 'max_pwr' argument should be between 0 mA and 500mA

• (2) String support is optional: 'p_name' can be a NULL string pointer.

• (3) Configuration can only be added when the device is in the following states:

  • SL_USBD_DEVICE_STATE_NONE Device controller has not been initialized.

  • SL_USBD_DEVICE_STATE_INIT Device controller is already initialized.

sl_usbd_core_add_interface#

sl_status_t sl_usbd_core_add_interface (uint8_t cfg_nbr, sl_usbd_class_driver_t *p_class_drv, void *p_if_class_arg, void *p_if_alt_class_arg, uint8_t class_code, uint8_t class_sub_code, uint8_t class_protocol_code, const char *p_name, uint8_t *p_if_nbr)

Associate a configuration with its alternative-speed counterpart.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Configurations from high- and full-speed can be associated with each other to provide comparable functionality regardless of speed.

• (2) Configuration can ONLY be associated when the device is in the following states:

  • SL_USBD_DEVICE_STATE_NONE Device controller has not been initialized.

  • SL_USBD_DEVICE_STATE_INIT Device controller is already initialized.

Add an interface to a specific configuration.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) USB Spec 2.0 Interface (section 9.6.5) states: "An interface may include alternate settings that allow the endpoints and/or their characteristics to be varied after the device has been configured. The default setting for an interface is always an alternate setting of zero."

sl_usbd_core_add_alt_interface#

sl_status_t sl_usbd_core_add_alt_interface (uint8_t config_nbr, uint8_t if_nbr, void *p_class_arg, const char *p_name, uint8_t *p_if_alt_nbr)

Add an alternate setting to a specific interface.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_add_interface_group#

sl_status_t sl_usbd_core_add_interface_group (uint8_t config_nbr, uint8_t class_code, uint8_t class_sub_code, uint8_t class_protocol_code, uint8_t if_start, uint8_t if_cnt, const char *p_name, uint8_t *p_if_grp_num)

Create an interface group.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_get_device_descriptor#

sl_status_t sl_usbd_core_get_device_descriptor (uint8_t *p_buf, uint8_t max_len, uint8_t *p_desc_len)

Get the device descriptor.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) This function should be used by drivers that supporting the standard requests auto-reply, (during the initialization process).

sl_usbd_core_get_configuration_descriptor#

sl_status_t sl_usbd_core_get_configuration_descriptor (uint8_t *p_buf, uint16_t max_len, uint8_t config_ix, uint16_t *p_desc_len)

Get a configuration descriptor.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) This function should be used by drivers supporting a standard request's auto-reply, during the initialization process.

sl_usbd_core_get_string_descriptor#

sl_status_t sl_usbd_core_get_string_descriptor (uint8_t *p_buf, uint8_t max_len, uint8_t str_ix, uint8_t *p_desc_len)

Get a string descriptor.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) This function should be used by drivers supporting a standard request's auto-reply, during the initialization process.

sl_usbd_core_add_string#

sl_status_t sl_usbd_core_add_string (const char *p_str)

Add string to USB device.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) USB spec 2.0 chapter 9.5 states: "Where appropriate, descriptors contain references to string descriptors that provide displayable information describing a descriptor in human-readable form. The inclusion of string descriptors is optional. However, the reference fields within descriptors are mandatory. If a device does not support string descriptors, string reference fields must be reset to zero to indicate no string descriptor is available". Since string descriptors are optional, 'p_str' could be a NULL pointer.

sl_usbd_core_get_string_index#

sl_status_t sl_usbd_core_get_string_index (const char *p_str, uint8_t *p_str_ix)

Get string index corresponding to a given string.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_write_08b_to_descriptor_buf#

sl_status_t sl_usbd_core_write_08b_to_descriptor_buf (uint8_t val)

Write an 8-bit value to the descriptor buffer.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) USB classes may use this function to append class-specific descriptors to the configuration descriptor.

sl_usbd_core_write_16b_to_descriptor_buf#

sl_status_t sl_usbd_core_write_16b_to_descriptor_buf (uint16_t val)

Write a 16-bit value in the descriptor buffer.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) USB classes may use this function to append class-specific descriptors to the configuration descriptor.

• (2) USB descriptors are in little-endian format.

sl_usbd_core_write_24b_to_descriptor_buf#

sl_status_t sl_usbd_core_write_24b_to_descriptor_buf (uint32_t val)

Write a 24-bit value to the descriptor buffer.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) USB classes may use this function to append class-specific descriptors to the configuration descriptor.

• (2) USB descriptors are in little-endian format.

sl_usbd_core_write_32b_to_descriptor_buf#

sl_status_t sl_usbd_core_write_32b_to_descriptor_buf (uint32_t val)

Write a 32-bit value to the descriptor buffer.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) USB classes may use this function to append class-specific descriptors to the configuration descriptor.

• (2) USB descriptors are in little-endian format.

sl_usbd_core_write_buf_to_descriptor_buf#

sl_status_t sl_usbd_core_write_buf_to_descriptor_buf (const uint8_t *p_buf, uint16_t len)

Write a buffer into the descriptor buffer.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) USB classes may use this function to append class-specific descriptors to the configuration descriptor.

sl_usbd_core_write_control_sync#

sl_status_t sl_usbd_core_write_control_sync (void *p_buf, uint32_t buf_len, uint16_t timeout_ms, bool end, uint32_t *p_xfer_len)

Send data on the Control IN endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) If end-of-transfer is set and transfer length is multiple of maximum packet size, a zero-length packet is transferred to indicate a short transfer to the host.

• (2) Transmit buffer must be 32 bits aligned.

sl_usbd_core_read_control_sync#

sl_status_t sl_usbd_core_read_control_sync (void *p_buf, uint32_t buf_len, uint16_t timeout_ms, uint32_t *p_xfer_len)

Receive data on the Control OUT endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Receive buffer must be 32 bits aligned.

sl_usbd_core_add_bulk_endpoint#

sl_status_t sl_usbd_core_add_bulk_endpoint (uint8_t config_nbr, uint8_t if_nbr, uint8_t if_alt_nbr, bool dir_in, uint16_t max_pkt_len, uint8_t *p_ep_addr)

Add a bulk endpoint to alternate setting interface.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) If the 'max_pkt_len' argument is '0', the stack will allocate the first available BULK endpoint, regardless its maximum packet size.

sl_usbd_core_read_bulk_sync#

sl_status_t sl_usbd_core_read_bulk_sync (uint8_t ep_addr, void *p_buf, uint32_t buf_len, uint16_t timeout_ms, uint32_t *p_xfer_len)

Receive data on Bulk OUT endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Receive buffer must be 32 bits aligned.

sl_usbd_core_read_bulk_async#

sl_status_t sl_usbd_core_read_bulk_async (uint8_t ep_addr, void *p_buf, uint32_t buf_len, sl_usbd_async_function_t async_fnct, void *p_async_arg)

Receive data on Bulk OUT endpoint asynchronously.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Receive buffer must be 32 bits aligned.

sl_usbd_core_write_bulk_sync#

sl_status_t sl_usbd_core_write_bulk_sync (uint8_t ep_addr, void *p_buf, uint32_t buf_len, uint16_t timeout_ms, bool end, uint32_t *p_xfer_len)

Send data on a Bulk IN endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) This function SHOULD NOT be called from interrupt service routine (ISR).

• (2) Transmit buffer must be 32 bits aligned.

• (3) If end-of-transfer is set and transfer length is multiple of maximum packet sizes, a zero-length packet is transferred to indicate a short transfer to the host.

sl_usbd_core_write_bulk_async#

sl_status_t sl_usbd_core_write_bulk_async (uint8_t ep_addr, void *p_buf, uint32_t buf_len, sl_usbd_async_function_t async_fnct, void *p_async_arg, bool end)

Send data on the Bulk IN endpoint asynchronously.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Transmit buffer must be 32 bits aligned.

• (2) If end-of-transfer is set and transfer length is multiple of maximum packet size, a zero-length packet is transferred to indicate a short transfer to the host.

sl_usbd_core_add_interrupt_endpoint#

sl_status_t sl_usbd_core_add_interrupt_endpoint (uint8_t config_nbr, uint8_t if_nbr, uint8_t if_alt_nbr, bool dir_in, uint16_t max_pkt_len, uint16_t interval, uint8_t *p_ep_addr)

Add an interrupt endpoint to an alternate setting interface.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) If the 'max_pkt_len' argument is '0', the stack will allocate the first available INTERRUPT endpoint, regardless its maximum packet size.

sl_usbd_core_read_interrupt_sync#

sl_status_t sl_usbd_core_read_interrupt_sync (uint8_t ep_addr, void *p_buf, uint32_t buf_len, uint16_t timeout_ms, uint32_t *p_xfer_len)

Receive data on the Interrupt OUT endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) This function SHOULD NOT be called from interrupt service routine (ISR).

• (2) Receive buffer must be 32 bits aligned.

sl_usbd_core_read_interrupt_async#

sl_status_t sl_usbd_core_read_interrupt_async (uint8_t ep_addr, void *p_buf, uint32_t buf_len, sl_usbd_async_function_t async_fnct, void *p_async_arg)

Receive data on Interrupt OUT endpoint asynchronously.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Receive buffer must be 32 bits aligned.

sl_usbd_core_write_interrupt_sync#

sl_status_t sl_usbd_core_write_interrupt_sync (uint8_t ep_addr, void *p_buf, uint32_t buf_len, uint16_t timeout_ms, bool end, uint32_t *p_xfer_len)

Send data on Interrupt IN endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) This function SHOULD NOT be called from interrupt service routine (ISR).

• (2) Transmit buffer must be 32 bits aligned.

• (3) If end-of-transfer is set and transfer length is multiple of maximum packet size, a zero-length packet is transferred to indicate a short transfer to the host.

sl_usbd_core_write_interrupt_async#

sl_status_t sl_usbd_core_write_interrupt_async (uint8_t ep_addr, void *p_buf, uint32_t buf_len, sl_usbd_async_function_t async_fnct, void *p_async_arg, bool end)

Send data on the Interrupt IN endpoint asynchronously.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Transmit buffer must be 32 bits aligned.

• (2) If end-of-transfer is set and transfer length is multiple of maximum packet size, a zero-length packet is transferred to indicate a short transfer to the host.

sl_usbd_core_endpoint_write_zlp#

sl_status_t sl_usbd_core_endpoint_write_zlp (uint8_t ep_addr, uint16_t timeout_ms)

Add an isochronous endpoint to alternate setting interface.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) If the 'max_pkt_len' argument is '0', the stack allocates the first available ISOCHRONOUS endpoint regardless of its maximum packet size.

• (2) For full-speed endpoints, 'transaction_frame' must be set to 1 since there is no support for high-bandwidth endpoints.

• (3) For full-/high-speed isochronous endpoints, bInterval value must be in the range from 1 to 16. The bInterval value is used as the exponent for a 2^(bInterval-1) value. Maximum polling interval value is 2^(16-1) = 32768 frames in full-speed and 32768 microframes (i.e., 4096 frames) in high-speed.

Receive data on an isochronous OUT endpoint asynchronously.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Receive buffer must be 32 bits aligned.

Send data on an isochronous IN endpoint asynchronously.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Transmit buffer must be 32 bits aligned.

Set synchronization feedback rate on synchronization isochronous endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Synchronization endpoints can ONLY be associated when the device is in the following states:

  • SL_USBD_DEVICE_STATE_NONE Device controller has not been initialized.

  • SL_USBD_DEVICE_STATE_INIT Device controller is already initialized.

• (2) For audio class 1.0, the interface class code must be SL_USBD_CLASS_CODE_AUDIO and protocol 'zero'

• (3) If explicit synchronization mechanism is needed to maintain synchronization during transfers, the information carried over the synchronization path must be available every 2 ^ (10 - P) frames, with P ranging from 1 to 9 (512 ms down to 2 ms).

• (4) Table 4-22 "Standard AS Isochronous Synch Endpoint Descriptor" of Audio 1.0 specification indicates for bmAttributes field no usage type for bits 5..4. But USB 2.0 specification, Table 9-13 "Standard Endpoint Descriptor" indicates several types of usage. When an explicit feedback is defined for a asynchronous isochronous endpoint, the associated synch feedback should use the Usage type 'Feedback endpoint'.

Associate synchronization endpoint to isochronous endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) Synchronization endpoints can ONLY be associated when the device is in the following states:

  • SL_USBD_DEVICE_STATE_NONE Device controller has not been initialized.

  • SL_USBD_DEVICE_STATE_INIT Device controller is already initialized.

• (2) For audio class 1.0, interface class code must be SL_USBD_CLASS_CODE_AUDIO and protocol 'zero'.

Send zero-length packet to the host.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) This function should only be called during a synchronous transfer.

sl_usbd_core_endpoint_read_zlp#

sl_status_t sl_usbd_core_endpoint_read_zlp (uint8_t ep_addr, uint16_t timeout_ms)

Receive zero-length packet from the host.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) This function should only be called during a synchronous transfer.

sl_usbd_core_abort_endpoint#

sl_status_t sl_usbd_core_abort_endpoint (uint8_t ep_addr)

Abort I/O transfer on the endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_endpoint_read_complete#

sl_status_t sl_usbd_core_endpoint_read_complete (uint8_t ep_log_nbr)

Notify USB stack that packet receive has completed.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_endpoint_write_complete#

sl_status_t sl_usbd_core_endpoint_write_complete (uint8_t ep_log_nbr)

Notify USB stack that packet transmit has completed.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_endpoint_write_complete_extended#

sl_status_t sl_usbd_core_endpoint_write_complete_extended (uint8_t ep_log_nbr, sl_status_t xfer_err)

Notify USB stack that packet transmit has completed (see Note #1).

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) This function is an alternative to the function sl_usbd_core_endpoint_write_complete() so that a USB device driver can return to the core an error code upon the Tx transfer completion.

sl_usbd_core_stall_endpoint#

sl_status_t sl_usbd_core_stall_endpoint (uint8_t ep_addr, bool state)

Stall the non-control endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_is_endpoint_stalled#

sl_status_t sl_usbd_core_is_endpoint_stalled (uint8_t ep_addr, bool *p_ep_stall)

Get the stall status of a non-control endpoint.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_get_max_endpoint_packet_size#

sl_status_t sl_usbd_core_get_max_endpoint_packet_size (uint8_t ep_addr, uint16_t *p_max_size)

Retrieve the endpoint maximum packet size.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_get_max_phy_endpoint_number#

sl_status_t sl_usbd_core_get_max_phy_endpoint_number (uint8_t *p_ep_phy_nbr)

Get the maximum physical endpoint number.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_core_get_max_open_endpoint_number#

sl_status_t sl_usbd_core_get_max_open_endpoint_number (uint8_t *p_nbr_open)

sl_usbd_on_bus_event#

__WEAK void sl_usbd_on_bus_event (sl_usbd_bus_event_t event)

sl_usbd_on_config_event#

__WEAK void sl_usbd_on_config_event (sl_usbd_config_event_t event, uint8_t config_nbr)

SL_USBD_FRAME_NBR_MAX#

#define SL_USBD_FRAME_NBR_MAX

2047u

MODULE.

INCLUDE FILES MACROS

                                              FRAME

Note(s) : (1) Section 8.3.3 of USB spec 2.0 describes the frame number as: "The frame number field is an 11-bit field that is incremented by the host on a per-frame basis. The frame number field rolls over upon reaching its maximum value of 7FFH and is sent only in SOF tokens at the start of each (micro)frame."

SL_USBD_FRAME_NBR_MASK#

#define SL_USBD_FRAME_NBR_MASK

0b0000011111111111

SL_USBD_MICROFRAME_NBR_MASK#

#define SL_USBD_MICROFRAME_NBR_MASK

0b0011100000000000

SL_USBD_DEV_ATTRIB_SELF_POWERED#

#define SL_USBD_DEV_ATTRIB_SELF_POWERED

0x01u

CONFIGURATION ATTRIBUTES.

SL_USBD_DEV_ATTRIB_REMOTE_WAKEUP#

#define SL_USBD_DEV_ATTRIB_REMOTE_WAKEUP

0x02u

SL_USBD_DESC_LEN_DEV#

#define SL_USBD_DESC_LEN_DEV

18u

DEVICE DESCRIPTOR LENGTH.

SL_USBD_DESC_LEN_DEV_QUAL#

#define SL_USBD_DESC_LEN_DEV_QUAL

10u

SL_USBD_DESC_LEN_HDR#

#define SL_USBD_DESC_LEN_HDR

2u

SL_USBD_DESC_LEN_CFG#

#define SL_USBD_DESC_LEN_CFG

9u

SL_USBD_DESC_LEN_OTHER_SPD_CFG#

#define SL_USBD_DESC_LEN_OTHER_SPD_CFG

9u

SL_USBD_DESC_LEN_IF#

#define SL_USBD_DESC_LEN_IF

9u

SL_USBD_DESC_LEN_IF_ASSOCIATION#

#define SL_USBD_DESC_LEN_IF_ASSOCIATION

8u

SL_USBD_DESC_LEN_EP#

#define SL_USBD_DESC_LEN_EP

7u

SL_USBD_DESC_LEN_OTG#

#define SL_USBD_DESC_LEN_OTG

3u

SL_USBD_REQ_DIR_MASK#

#define SL_USBD_REQ_DIR_MASK

0x80u

                                  REQUEST CHARACTERISTICS

Note(s) : (1) Request types are defined in USB spec 2.0, section 9.3, Table 9-2, 'RequestType' field.

SL_USBD_REQ_DIR_HOST_TO_DEVICE#

#define SL_USBD_REQ_DIR_HOST_TO_DEVICE

0x00u

SL_USBD_REQ_DIR_DEVICE_TO_HOST#

#define SL_USBD_REQ_DIR_DEVICE_TO_HOST

0x80u

SL_USBD_REQ_DIR_BIT#

#define SL_USBD_REQ_DIR_BIT

0x80u

SL_USBD_REQ_TYPE_MASK#

#define SL_USBD_REQ_TYPE_MASK

0x60u

SL_USBD_REQ_TYPE_STANDARD#

#define SL_USBD_REQ_TYPE_STANDARD

0x00u

SL_USBD_REQ_TYPE_CLASS#

#define SL_USBD_REQ_TYPE_CLASS

0x20u

SL_USBD_REQ_TYPE_VENDOR#

#define SL_USBD_REQ_TYPE_VENDOR

0x40u

SL_USBD_REQ_TYPE_RESERVED#

#define SL_USBD_REQ_TYPE_RESERVED

0x60u

SL_USBD_REQ_RECIPIENT_MASK#

#define SL_USBD_REQ_RECIPIENT_MASK

0x1Fu

SL_USBD_REQ_RECIPIENT_DEVICE#

#define SL_USBD_REQ_RECIPIENT_DEVICE

0x00u

SL_USBD_REQ_RECIPIENT_INTERFACE#

#define SL_USBD_REQ_RECIPIENT_INTERFACE

0x01u

SL_USBD_REQ_RECIPIENT_ENDPOINT#

#define SL_USBD_REQ_RECIPIENT_ENDPOINT

0x02u

SL_USBD_REQ_RECIPIENT_OTHER#

#define SL_USBD_REQ_RECIPIENT_OTHER

0x03u

SL_USBD_REQ_GET_STATUS#

#define SL_USBD_REQ_GET_STATUS

0u

                                      STANDARD REQUESTS

Note(s) : (1) Request types are defined in USB spec 2.0, section 9.4, Table 9-4, 'RequestType' field.

SL_USBD_REQ_CLEAR_FEATURE#

#define SL_USBD_REQ_CLEAR_FEATURE

1u

SL_USBD_REQ_SET_FEATURE#

#define SL_USBD_REQ_SET_FEATURE

3u

SL_USBD_REQ_SET_ADDRESS#

#define SL_USBD_REQ_SET_ADDRESS

5u

SL_USBD_REQ_GET_DESCRIPTOR#

#define SL_USBD_REQ_GET_DESCRIPTOR

6u

SL_USBD_REQ_SET_DESCRIPTOR#

#define SL_USBD_REQ_SET_DESCRIPTOR

7u

SL_USBD_REQ_GET_CONFIGURATION#

#define SL_USBD_REQ_GET_CONFIGURATION

8u

SL_USBD_REQ_SET_CONFIGURATION#

#define SL_USBD_REQ_SET_CONFIGURATION

9u

SL_USBD_REQ_GET_INTERFACE#

#define SL_USBD_REQ_GET_INTERFACE

10u

SL_USBD_REQ_SET_INTERFACE#

#define SL_USBD_REQ_SET_INTERFACE

11u

SL_USBD_REQ_SYNCH_FRAME#

#define SL_USBD_REQ_SYNCH_FRAME

12u

SL_USBD_DESC_TYPE_DEVICE#

#define SL_USBD_DESC_TYPE_DEVICE

1u

                                      DESCRIPTOR TYPES

Note(s) : (1) Descriptors types are defined in the USB spec 2.0 section 9.2.6, Table 9-5.

SL_USBD_DESC_TYPE_CONFIGURATION#

#define SL_USBD_DESC_TYPE_CONFIGURATION

2u

SL_USBD_DESC_TYPE_STRING#

#define SL_USBD_DESC_TYPE_STRING

3u

SL_USBD_DESC_TYPE_INTERFACE#

#define SL_USBD_DESC_TYPE_INTERFACE

4u

SL_USBD_DESC_TYPE_ENDPOINT#

#define SL_USBD_DESC_TYPE_ENDPOINT

5u

SL_USBD_DESC_TYPE_DEVICE_QUALIFIER#

#define SL_USBD_DESC_TYPE_DEVICE_QUALIFIER

6u

SL_USBD_DESC_TYPE_OTHER_SPEED_CONFIGURATION#

#define SL_USBD_DESC_TYPE_OTHER_SPEED_CONFIGURATION

7u

SL_USBD_DESC_TYPE_INTERFACE_POWER#

#define SL_USBD_DESC_TYPE_INTERFACE_POWER

8u

SL_USBD_DESC_TYPE_OTG#

#define SL_USBD_DESC_TYPE_OTG

9u

SL_USBD_DESC_TYPE_IAD#

#define SL_USBD_DESC_TYPE_IAD

11u

SL_USBD_LANG_ID_ARABIC_SAUDI_ARABIA#

#define SL_USBD_LANG_ID_ARABIC_SAUDI_ARABIA

0x0401u

                                      LANGUAGE IDENTIFIERS

Note(s) : (1) Languages identifier are defined in "http://www.usb.org/developers/docs/USB_LANGIDs.pdf".

SL_USBD_LANG_ID_CHINESE_TAIWAN#

#define SL_USBD_LANG_ID_CHINESE_TAIWAN

0x0404u

SL_USBD_LANG_ID_ENGLISH_US#

#define SL_USBD_LANG_ID_ENGLISH_US

0x0409u

SL_USBD_LANG_ID_ENGLISH_UK#

#define SL_USBD_LANG_ID_ENGLISH_UK

0x0809u

SL_USBD_LANG_ID_FRENCH#

#define SL_USBD_LANG_ID_FRENCH

0x040Cu

SL_USBD_LANG_ID_GERMAN#

#define SL_USBD_LANG_ID_GERMAN

0x0407u

SL_USBD_LANG_ID_GREEK#

#define SL_USBD_LANG_ID_GREEK

0x0408u

SL_USBD_LANG_ID_ITALIAN#

#define SL_USBD_LANG_ID_ITALIAN

0x0410u

SL_USBD_LANG_ID_PORTUGUESE#

#define SL_USBD_LANG_ID_PORTUGUESE

0x0816u

SL_USBD_LANG_ID_SANSKRIT#

#define SL_USBD_LANG_ID_SANSKRIT

0x044Fu

SL_USBD_CLASS_CODE_USE_IF_DESC#

#define SL_USBD_CLASS_CODE_USE_IF_DESC

0x00u

                                          CLASS CODES

Note(s) : (1) Class codes are defined in "http://www.usb.org/developers/defined_class".

      (2) Class code information can be placed in the Device descriptor or in the Interface
          descriptor. Some defined class code are allowed to be used only in the Device
          descriptor, others can used in both Device and Interface descriptors and come can
          only be used in Interface Descriptors.

      (3) Subclass & protocol codes are defined in the relevant class drivers.

SL_USBD_CLASS_CODE_AUDIO#

#define SL_USBD_CLASS_CODE_AUDIO

0x01u

SL_USBD_CLASS_CODE_CDC_CONTROL#

#define SL_USBD_CLASS_CODE_CDC_CONTROL

0x02u

SL_USBD_CLASS_CODE_HID#

#define SL_USBD_CLASS_CODE_HID

0x03u

SL_USBD_CLASS_CODE_PHYSICAL#

#define SL_USBD_CLASS_CODE_PHYSICAL

0x05u

SL_USBD_CLASS_CODE_IMAGE#

#define SL_USBD_CLASS_CODE_IMAGE

0x06u

SL_USBD_CLASS_CODE_PRINTER#

#define SL_USBD_CLASS_CODE_PRINTER

0x07u

SL_USBD_CLASS_CODE_MASS_STORAGE#

#define SL_USBD_CLASS_CODE_MASS_STORAGE

0x08u

SL_USBD_CLASS_CODE_HUB#

#define SL_USBD_CLASS_CODE_HUB

0x09u

SL_USBD_CLASS_CODE_CDC_DATA#

#define SL_USBD_CLASS_CODE_CDC_DATA

0x0Au

SL_USBD_CLASS_CODE_SMART_CARD#

#define SL_USBD_CLASS_CODE_SMART_CARD

0x0Bu

SL_USBD_CLASS_CODE_CONTENT_SECURITY#

#define SL_USBD_CLASS_CODE_CONTENT_SECURITY

0x0Du

SL_USBD_CLASS_CODE_VIDEO#

#define SL_USBD_CLASS_CODE_VIDEO

0x0Eu

SL_USBD_CLASS_CODE_PERSONAL_HEALTHCARE#

#define SL_USBD_CLASS_CODE_PERSONAL_HEALTHCARE

0x0Fu

SL_USBD_CLASS_CODE_DIAGNOSTIC_DEVICE#

#define SL_USBD_CLASS_CODE_DIAGNOSTIC_DEVICE

0xDCu

SL_USBD_CLASS_CODE_WIRELESS_CONTROLLER#

#define SL_USBD_CLASS_CODE_WIRELESS_CONTROLLER

0xE0u

SL_USBD_CLASS_CODE_MISCELLANEOUS#

#define SL_USBD_CLASS_CODE_MISCELLANEOUS

0xEFu

SL_USBD_CLASS_CODE_APPLICATION_SPECIFIC#

#define SL_USBD_CLASS_CODE_APPLICATION_SPECIFIC

0xFEu

SL_USBD_CLASS_CODE_VENDOR_SPECIFIC#

#define SL_USBD_CLASS_CODE_VENDOR_SPECIFIC

0xFFu

SL_USBD_SUBCLASS_CODE_USE_IF_DESC#

#define SL_USBD_SUBCLASS_CODE_USE_IF_DESC

0x00u

SUB-CLASS CODES.

SL_USBD_SUBCLASS_CODE_USE_COMMON_CLASS#

#define SL_USBD_SUBCLASS_CODE_USE_COMMON_CLASS

0x02u

SL_USBD_SUBCLASS_CODE_VENDOR_SPECIFIC#

#define SL_USBD_SUBCLASS_CODE_VENDOR_SPECIFIC

0xFFu

SL_USBD_PROTOCOL_CODE_USE_IF_DESC#

#define SL_USBD_PROTOCOL_CODE_USE_IF_DESC

0x00u

PROTOCOL CODES.

SL_USBD_PROTOCOL_CODE_USE_IAD#

#define SL_USBD_PROTOCOL_CODE_USE_IAD

0x01u

SL_USBD_PROTOCOL_CODE_VENDOR_SPECIFIC#

#define SL_USBD_PROTOCOL_CODE_VENDOR_SPECIFIC

0xFFu

SL_USBD_FEATURE_SEL_ENDPOINT_HALT#

#define SL_USBD_FEATURE_SEL_ENDPOINT_HALT

0u

FEATURE SELECTORS.

SL_USBD_FEATURE_SEL_DEVICE_REMOTE_WAKEUP#

#define SL_USBD_FEATURE_SEL_DEVICE_REMOTE_WAKEUP

1u

SL_USBD_FEATURE_SEL_TEST_MODE#

#define SL_USBD_FEATURE_SEL_TEST_MODE

2u

SL_USBD_MAX_BUS_PWR_LIMIT_mA#

#define SL_USBD_MAX_BUS_PWR_LIMIT_mA

500u

DEVICE POWER CONSTRAINS.

SL_USBD_ENDPOINT_TYPE_MASK#

#define SL_USBD_ENDPOINT_TYPE_MASK

0x03u

ENDPOINT TYPE.

Note(s) : (1) Endpoint types are defined in the USB spec 2.0 section 9.6.6, Table 9-13, 'bmAttributes' field.

SL_USBD_ENDPOINT_TYPE_CTRL#

#define SL_USBD_ENDPOINT_TYPE_CTRL

0x00u

SL_USBD_ENDPOINT_TYPE_ISOC#

#define SL_USBD_ENDPOINT_TYPE_ISOC

0x01u

SL_USBD_ENDPOINT_TYPE_BULK#

#define SL_USBD_ENDPOINT_TYPE_BULK

0x02u

SL_USBD_ENDPOINT_TYPE_INTR#

#define SL_USBD_ENDPOINT_TYPE_INTR

0x03u

SL_USBD_ENDPOINT_TYPE_SYNC_MASK#

#define SL_USBD_ENDPOINT_TYPE_SYNC_MASK

0x0Cu

SL_USBD_ENDPOINT_TYPE_SYNC_NONE#

#define SL_USBD_ENDPOINT_TYPE_SYNC_NONE

0x00u

SL_USBD_ENDPOINT_TYPE_SYNC_ASYNC#

#define SL_USBD_ENDPOINT_TYPE_SYNC_ASYNC

0x04u

SL_USBD_ENDPOINT_TYPE_SYNC_ADAPTIVE#

#define SL_USBD_ENDPOINT_TYPE_SYNC_ADAPTIVE

0x08u

SL_USBD_ENDPOINT_TYPE_SYNC_SYNC#

#define SL_USBD_ENDPOINT_TYPE_SYNC_SYNC

0x0Cu

SL_USBD_ENDPOINT_TYPE_USAGE_MASK#

#define SL_USBD_ENDPOINT_TYPE_USAGE_MASK

0x30u

SL_USBD_ENDPOINT_TYPE_USAGE_DATA#

#define SL_USBD_ENDPOINT_TYPE_USAGE_DATA

0x00u

SL_USBD_ENDPOINT_TYPE_USAGE_FEEDBACK#

#define SL_USBD_ENDPOINT_TYPE_USAGE_FEEDBACK

0x10u

SL_USBD_ENDPOINT_TYPE_USAGE_IMPLICIT_FEEDBACK#

#define SL_USBD_ENDPOINT_TYPE_USAGE_IMPLICIT_FEEDBACK

0x20u

SL_USBD_ENDPOINT_NBR_MASK#

#define SL_USBD_ENDPOINT_NBR_MASK

0x0Fu

ENDPOINT ADDRESS.

Note(s) : (1) Endpoint address is defined in the USB spec 2.0, section 9.6.6, Table 9-13, 'bEndpointAddress' field.

SL_USBD_ENDPOINT_MAX_NBR#

#define SL_USBD_ENDPOINT_MAX_NBR

32u

SL_USBD_ENDPOINT_DIR_MASK#

#define SL_USBD_ENDPOINT_DIR_MASK

0x80u

SL_USBD_ENDPOINT_DIR_BIT#

#define SL_USBD_ENDPOINT_DIR_BIT

0x80u

SL_USBD_ENDPOINT_DIR_OUT#

#define SL_USBD_ENDPOINT_DIR_OUT

0x00u

SL_USBD_ENDPOINT_DIR_IN#

#define SL_USBD_ENDPOINT_DIR_IN

0x80u

SL_USBD_ENDPOINT_TRANSACTION_PER_UFRAME_1#

#define SL_USBD_ENDPOINT_TRANSACTION_PER_UFRAME_1

1u

SL_USBD_ENDPOINT_TRANSACTION_PER_UFRAME_2#

#define SL_USBD_ENDPOINT_TRANSACTION_PER_UFRAME_2

2u

SL_USBD_ENDPOINT_TRANSACTION_PER_UFRAME_3#

#define SL_USBD_ENDPOINT_TRANSACTION_PER_UFRAME_3

3u

SL_USBD_ENDPOINT_MAX_INTERVAL_VAL#

#define SL_USBD_ENDPOINT_MAX_INTERVAL_VAL

32768u

SL_USBD_MICROSOFT_COMPAT_ID_NULL#

#define SL_USBD_MICROSOFT_COMPAT_ID_NULL

0u

MICROSOFT OS DESCRIPTOR DEFINES.

Note(s) : (1) For more information on Microsoft OS descriptors, see 'http://msdn.microsoft.com/en-us/library/windows/hardware/gg463179.aspx'.

SL_USBD_MICROSOFT_COMPAT_ID_RNDIS#

#define SL_USBD_MICROSOFT_COMPAT_ID_RNDIS

1u

SL_USBD_MICROSOFT_COMPAT_ID_PTP#

#define SL_USBD_MICROSOFT_COMPAT_ID_PTP

2u

SL_USBD_MICROSOFT_COMPAT_ID_MTP#

#define SL_USBD_MICROSOFT_COMPAT_ID_MTP

3u

SL_USBD_MICROSOFT_COMPAT_ID_XUSB20#

#define SL_USBD_MICROSOFT_COMPAT_ID_XUSB20

4u

SL_USBD_MICROSOFT_COMPAT_ID_BLUETOOTH#

#define SL_USBD_MICROSOFT_COMPAT_ID_BLUETOOTH

5u

SL_USBD_MICROSOFT_COMPAT_ID_WINUSB#

#define SL_USBD_MICROSOFT_COMPAT_ID_WINUSB

6u

SL_USBD_MICROSOFT_COMPAT_ID_NONE#

#define SL_USBD_MICROSOFT_COMPAT_ID_NONE

255u

SL_USBD_MICROSOFT_SUBCOMPAT_ID_NULL#

#define SL_USBD_MICROSOFT_SUBCOMPAT_ID_NULL

0u

SL_USBD_MICROSOFT_SUBCOMPAT_ID_BLUETOOTH_1_1#

#define SL_USBD_MICROSOFT_SUBCOMPAT_ID_BLUETOOTH_1_1

1u

SL_USBD_MICROSOFT_SUBCOMPAT_ID_BLUETOOTH_1_2#

#define SL_USBD_MICROSOFT_SUBCOMPAT_ID_BLUETOOTH_1_2

2u

SL_USBD_MICROSOFT_SUBCOMPAT_ID_BLUETOOTH_EDR#

#define SL_USBD_MICROSOFT_SUBCOMPAT_ID_BLUETOOTH_EDR

3u

SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_SZ#

#define SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_SZ

1u

SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_EXPAND_SZ#

#define SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_EXPAND_SZ

2u

SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_BINARY#

#define SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_BINARY

3u

SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_DWORD_LITTLE_ENDIAN#

#define SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_DWORD_LITTLE_ENDIAN

4u

SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_DWORD_BIG_ENDIAN#

#define SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_DWORD_BIG_ENDIAN

5u

SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_LINK#

#define SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_LINK

6u

SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_MULTI_SZ#

#define SL_USBD_MICROSOFT_PROPERTY_TYPE_REG_MULTI_SZ

7u

SL_USBD_ENDPOINT_INFO_TYPE_CTRL#

#define SL_USBD_ENDPOINT_INFO_TYPE_CTRL

0x01u

USB EP INFORMATION TABLE DEFINES.

SL_USBD_ENDPOINT_INFO_TYPE_ISOC#

#define SL_USBD_ENDPOINT_INFO_TYPE_ISOC

0x02u

SL_USBD_ENDPOINT_INFO_TYPE_BULK#

#define SL_USBD_ENDPOINT_INFO_TYPE_BULK

0x04u

SL_USBD_ENDPOINT_INFO_TYPE_INTR#

#define SL_USBD_ENDPOINT_INFO_TYPE_INTR

0x08u

SL_USBD_ENDPOINT_INFO_DIR_OUT#

#define SL_USBD_ENDPOINT_INFO_DIR_OUT

0x10u

SL_USBD_ENDPOINT_INFO_DIR_IN#

#define SL_USBD_ENDPOINT_INFO_DIR_IN

0x20u

SL_USBD_CONFIG_NBR_NONE#

#define SL_USBD_CONFIG_NBR_NONE

255u

USB OBJECT NUMBER.

SL_USBD_CONFIG_NBR_SPD_BIT#

#define SL_USBD_CONFIG_NBR_SPD_BIT

0x80u

SL_USBD_INTERFACE_NBR_NONE#

#define SL_USBD_INTERFACE_NBR_NONE

255u

SL_USBD_ALT_INTERFACE_NBR_NONE#

#define SL_USBD_ALT_INTERFACE_NBR_NONE

255u

SL_USBD_INTERFACE_GROUP_NBR_NONE#

#define SL_USBD_INTERFACE_GROUP_NBR_NONE

255u

SL_USBD_ENDPOINT_ADDR_NONE#

#define SL_USBD_ENDPOINT_ADDR_NONE

255u

SL_USBD_ENDPOINT_PHY_NONE#

#define SL_USBD_ENDPOINT_PHY_NONE

255u

SL_USBD_ENDPOINT_NBR_NONE#

#define SL_USBD_ENDPOINT_NBR_NONE

255u

SL_USBD_CLASS_NBR_NONE#

#define SL_USBD_CLASS_NBR_NONE

255u

USBD_CFG_STR_EN#

#define USBD_CFG_STR_EN

1

USB DEFAULT CONFIGS.

USBD_CFG_MS_OS_DESC_EN#

#define USBD_CFG_MS_OS_DESC_EN

0

USBD_CFG_URB_EXTRA_EN#

#define USBD_CFG_URB_EXTRA_EN

0

SL_USBD_URB_MAX_NBR#

#define SL_USBD_URB_MAX_NBR

SL_USBD_OPEN_ENDPOINTS_QUANTITY

USBD_CFG_HS_EN#

#define USBD_CFG_HS_EN

0

USBD_CFG_EP_ISOC_EN#

#define USBD_CFG_EP_ISOC_EN

0

USBD_CFG_OPTIMIZE_SPD#

#define USBD_CFG_OPTIMIZE_SPD

0

SL_USBD_CORE_EVENT_BUS_NBR#

#define SL_USBD_CORE_EVENT_BUS_NBR

7u

USB CORE EVENTS.

Note(s) : (1) There are 7 possible USB callback events:

              sli_usbd_core_reset_event(),
              sli_usbd_core_suspend_event(),
              sli_usbd_core_resume_event(),
              sli_usbd_core_connect_event(),
              sli_usbd_core_disconnect_event(),
              sli_usbd_core_high_speed_event().

SL_USBD_CORE_EVENT_BUS_NBR_TOTAL#

#define SL_USBD_CORE_EVENT_BUS_NBR_TOTAL

(SL_USBD_CORE_EVENT_BUS_NBR * SL_USBD_DEVICE_QUANTITY)

SL_USBD_CORE_EVENT_ASYNC_NBR#

#define SL_USBD_CORE_EVENT_ASYNC_NBR

((SL_USBD_OPEN_ENDPOINTS_QUANTITY * SL_USBD_DEVICE_QUANTITY) + SL_USBD_EXTRA_URB_QUANTITY)

SL_USBD_CORE_EVENT_NBR_TOTAL#

#define SL_USBD_CORE_EVENT_NBR_TOTAL

(SL_USBD_CORE_EVENT_BUS_NBR_TOTAL + SL_USBD_CORE_EVENT_ASYNC_NBR)

SL_USBD_FRAME_NBR_GET#

#define SL_USBD_FRAME_NBR_GET

(frame_nbr)

GLOBAL CONSTANTS.

MACROS FRAME MACROS

Note(s) : (1) This macro takes into account when the frame number rolls over upon reaching the maximum value of 2047.

SL_USBD_MICROFRAME_NBR_GET#

#define SL_USBD_MICROFRAME_NBR_GET

(microframe_nbr)

SL_USBD_FRAME_NBR_DIFF_GET#

#define SL_USBD_FRAME_NBR_DIFF_GET

SL_USBD_ENDPOINT_PHY_TO_ADDR#

#define SL_USBD_ENDPOINT_PHY_TO_ADDR

ENDPOINT CONVERSION MACROS.

SL_USBD_ENDPOINT_ADDR_TO_PHY#

#define SL_USBD_ENDPOINT_ADDR_TO_PHY

SL_USBD_ENDPOINT_ADDR_TO_LOG#

#define SL_USBD_ENDPOINT_ADDR_TO_LOG

(ep_addr)

SL_USBD_ENDPOINT_PHY_TO_LOG#

#define SL_USBD_ENDPOINT_PHY_TO_LOG

(ep_phy_nbr)

SL_USBD_ENDPOINT_LOG_TO_ADDR_IN#

#define SL_USBD_ENDPOINT_LOG_TO_ADDR_IN

(ep_log_nbr)

SL_USBD_ENDPOINT_LOG_TO_ADDR_OUT#

#define SL_USBD_ENDPOINT_LOG_TO_ADDR_OUT

(ep_log_nbr)

SL_USBD_ENDPOINT_IS_IN#

#define SL_USBD_ENDPOINT_IS_IN

(ep_addr)