USB Device HID API#

sl_usbd_hid_country_code_t#

sl_usbd_hid_country_code_t

DEFINES.

                     HUMAN INTERFACE DEVICE COUNTRY CODES DEFINES

Note(s) : (1) See 'Device Class Definition for Human Interface Devices (HID), 6/27/01, Version 1.11', section 6.2.1 for more details about HID descriptor country code.

(a) The country code identifies which country the hardware is localized for. Most hardware is not localized and thus this value would be zero (0). However, keyboards may use the field to indicate the language of the key caps.

sl_usbd_hid_async_function_t#

typedef void(* sl_usbd_hid_async_function_t) (uint8_t class_nbr, void *p_buf, uint32_t buf_len, uint32_t xfer_len, void *p_callback_arg, sl_status_t status) )(uint8_t class_nbr, void *p_buf, uint32_t buf_len, uint32_t xfer_len, void *p_callback_arg, sl_status_t status)

GLOBAL CONSTANTS.

DATA TYPES Async comm callback

sl_usbd_hid_init#

sl_status_t sl_usbd_hid_init (void )

GLOBAL CONSTANTS.

FUNCTION PROTOTYPES HID FUNCTIONS

Initialize HID class.

Returns

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

sl_usbd_hid_create_instance#

sl_status_t sl_usbd_hid_create_instance (uint8_t subclass, uint8_t protocol, sl_usbd_hid_country_code_t country_code, uint16_t interval_in, uint16_t interval_out, bool ctrl_rd_en, sl_usbd_hid_callbacks_t * p_hid_callbacks, uint8_t * p_class_nbr)

Add a new instance of the HID class.

Returns

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

sl_usbd_hid_add_to_configuration#

sl_status_t sl_usbd_hid_add_to_configuration (uint8_t class_nbr, uint8_t config_nbr)

Add the HID class instance to the USB device configuration (see Note #1).

Returns

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

Note

• (1) Called several times, it creates multiple instances and configurations. For instance, the following architecture could be created :

  *               FS
  *               |-- Configuration 0 (HID class 0)
  *                                   (HID class 1)
  *                                   (HID class 2)
  *                   |-- Interface 0
  *               |-- Configuration 1 (HID class 0)
  *                   |-- Interface 0
  *               

• (2) Configuration Descriptor corresponding to a HID device uses the following format :

  *               Configuration Descriptor
  *               |-- Interface Descriptor (HID class)
  *                   |-- Endpoint Descriptor (Interrupt IN)
  *                   |-- Endpoint Descriptor (Interrupt OUT) - optional
  *               

sl_usbd_hid_is_enabled#

sl_status_t sl_usbd_hid_is_enabled (uint8_t class_nbr, bool * p_enabled)

Get the HID class enable state.

Returns

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

sl_usbd_hid_write_sync#

sl_status_t sl_usbd_hid_write_sync (uint8_t class_nbr, void * p_buf, uint32_t buf_len, uint16_t timeout, uint32_t * p_xfer_len)

Send data to the host through the Interrupt IN endpoint.

This function is blocking.

Returns

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

sl_usbd_hid_read_sync#

sl_status_t sl_usbd_hid_read_sync (uint8_t class_nbr, void * p_buf, uint32_t buf_len, uint16_t timeout, uint32_t * p_xfer_len)

Receive data from the host through the Interrupt OUT endpoint.

This function is blocking.

Returns

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

sl_usbd_hid_read_async#

sl_status_t sl_usbd_hid_read_async (uint8_t class_nbr, void * p_buf, uint32_t buf_len, sl_usbd_hid_async_function_t async_fnct, void * p_async_arg)

Receive data from the host through the Interrupt OUT endpoint.

This function is non-blocking and returns immediately after transfer preparation. Upon transfer completion, the provided callback is called to notify the application.

Returns

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

sl_usbd_hid_write_async#

sl_status_t sl_usbd_hid_write_async (uint8_t class_nbr, void * p_buf, uint32_t buf_len, sl_usbd_hid_async_function_t async_fnct, void * p_async_arg)

Send data to the host through the Interrupt IN endpoint.

This function is non-blocking, and returns immediately after transfer preparation. Upon transfer completion, the provided callback is called to notify the application.

Returns

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