SF BLE HID Over GATT Profile Framework Interface

RTOS-integrated SF BLE HID Over GATT Profile Framework Interface. More...

Data Structures
union	sf_ble_prf_value_t
struct	sf_ble_prf_hid_report_desc_t
struct	sf_ble_prf_hid_report_ind_t
struct	sf_ble_prf_hid_change_event_t
struct	sf_ble_prf_dis_pnpid_t

Macros
#define	SF_BLE_PRF_HIDS_REPORT_MAX   (32U)

Typedefs
typedef uint8_t	sf_ble_prf_hid_protocol_mode_t
typedef uint8_t	sf_ble_prf_hid_ctrl_point_val_t

Enumerations
enum	sf_ble_prf_hidd_event_t {   SF_BLE_PRF_HIDD_EVENT_NONE, SF_BLE_PRF_HIDD_EVENT_REPORT_IND, SF_BLE_PRF_HIDD_EVENT_CFG_IND, SF_BLE_PRF_HIDD_EVENT_PROTO_MODE_CHG_EVT,   SF_BLE_PRF_HIDD_EVENT_REPORT_EVT, SF_BLE_PRF_HIDD_EVENT_CP_CHANGED_EVT }
enum	sf_ble_prf_hid_event_t {   SF_BLE_PRF_HID_EVENT_NONE, SF_BLE_HID_BHOST_EVENT_REPORT_NTF, SF_BLE_HID_BHOST_EVENT_READ_CHAR_RESP, SF_BLE_HID_RHOST_EVENT_REPORT_NTF,   SF_BLE_HID_RHOST_EVENT_BATTERY_LVL_NTF, SF_BLE_HID_RHOST_EVENT_READ_CHAR_RESP, SF_BLE_HID_RHOST_EVENT_READ_LONG_CHAR_RESP }
enum	sf_ble_hidd_device_type_t { SF_BLE_HIDD_HID_DEVICE = 0x01, SF_BLE_HIDD_BOOT_KEYBOARD, SF_BLE_HIDD_BOOT_MOUSE }

Detailed Description

RTOS-integrated SF BLE HID Over GATT Profile Framework Interface.

Summary

This SSP Interface provides access to the ThreadX-aware SF BLE HID Over GATT Profile Framework.

Macro Definition Documentation

SF_BLE_PRF_HIDS_REPORT_MAX

#define SF_BLE_PRF_HIDS_REPORT_MAX   (32U)

Maximum Number of reports in HID

Typedef Documentation

sf_ble_prf_hid_ctrl_point_val_t

typedef uint8_t sf_ble_prf_hid_ctrl_point_val_t

HID Control Point Characteristics

sf_ble_prf_hid_protocol_mode_t

typedef uint8_t sf_ble_prf_hid_protocol_mode_t

Protocol Mode Characteristics

Enumeration Type Documentation

sf_ble_hidd_device_type_t

enum sf_ble_hidd_device_type_t

HID Device types

Enumerator
SF_BLE_HIDD_HID_DEVICE	HID Device type.
SF_BLE_HIDD_BOOT_KEYBOARD	Boot Keyboard type.
SF_BLE_HIDD_BOOT_MOUSE	Boot Mouse type.

sf_ble_prf_hid_event_t

enum sf_ble_prf_hid_event_t

Profile Client user events

Enumerator
SF_BLE_PRF_HID_EVENT_NONE	Event not supported.
SF_BLE_HID_BHOST_EVENT_REPORT_NTF	Report value received from HID device, Refer sf_ble_prf_hid_report_ind_t. HID BHOST
SF_BLE_HID_BHOST_EVENT_READ_CHAR_RESP	read char response received from HID device
SF_BLE_HID_RHOST_EVENT_REPORT_NTF	Report value received from HID device, Refer sf_ble_prf_hid_report_ind_t. HID RHOST
SF_BLE_HID_RHOST_EVENT_BATTERY_LVL_NTF	Battery level received from HID device, Refer sf_ble_bas_battery_lvl_ntf_t.
SF_BLE_HID_RHOST_EVENT_READ_CHAR_RESP	Read char response received from HID device.
SF_BLE_HID_RHOST_EVENT_READ_LONG_CHAR_RESP	Long char read response received from HID device.

sf_ble_prf_hidd_event_t

enum sf_ble_prf_hidd_event_t

Profile Server user events

Enumerator
SF_BLE_PRF_HIDD_EVENT_NONE	Event not supported.
SF_BLE_PRF_HIDD_EVENT_REPORT_IND	Report value updated from Boot Host or Report Host, Refer sf_ble_prf_hid_report_ind_t.
SF_BLE_PRF_HIDD_EVENT_CFG_IND	CCCD change indication from Boot Host or Report Host.
SF_BLE_PRF_HIDD_EVENT_PROTO_MODE_CHG_EVT	protocol mode change event from Boot Host or Report Host, Refer sf_ble_prf_hid_change_event_t
SF_BLE_PRF_HIDD_EVENT_REPORT_EVT	report value update event from Boot Host or Report Host, Refer sf_ble_prf_hid_report_ind_t
SF_BLE_PRF_HIDD_EVENT_CP_CHANGED_EVT	suspend event from Report Host, Refer sf_ble_prf_hid_change_event_t