HIDS Definitions and Data Structures

General Description

Contains the HID specific definitions and data structures used in the HID API.

Data Structures
struct	cy_stc_ble_hidss_report_ref_t
	HID server Report Reference descriptor value - Report ID and Report Type. More...
struct	cy_stc_ble_hidss_information_t
	HID Information Characteristic value. More...
struct	cy_stc_ble_hidss_report_t
	HID Server Report Characteristic. More...
struct	cy_stc_ble_hidss_t
	Structure with HID Service attribute handles. More...
struct	cy_stc_ble_hidsc_report_t
	HID Client Report Characteristic. More...
struct	cy_stc_ble_hidsc_report_map_t
	HID client Report map Characteristic. More...
struct	cy_stc_ble_hidsc_t
	Structure with Discovered Attributes Information of HID Service. More...
struct	cy_stc_ble_hids_char_value_t
	HID Service Characteristic Value parameter structure. More...
struct	cy_stc_ble_hids_descr_value_t
	HID Service Characteristic descriptor value parameter structure. More...
struct	cy_stc_ble_hidss_config_t
	Service configuration structure (server) More...
struct	cy_stc_ble_hidsc_config_t
	Service Configuration structure (client) More...

Macros
#define	CY_BLE_HIDSC_REPORT_MAX   (6u)
	Maximum HIDS report Characteristic.

Enumerations
enum	cy_en_ble_hids_char_index_t {   CY_BLE_HIDS_PROTOCOL_MODE = 0u,   CY_BLE_HIDS_INFORMATION = 1u,   CY_BLE_HIDS_CONTROL_POINT = 2u,   CY_BLE_HIDS_REPORT_MAP = 3u,   CY_BLE_HIDS_BOOT_KYBRD_IN_REP = 4u,   CY_BLE_HIDS_BOOT_KYBRD_OUT_REP = 5u,   CY_BLE_HIDS_BOOT_MOUSE_IN_REP = 6u,   CY_BLE_HIDS_REPORT = 7u,   CY_BLE_HIDS_CHAR_COUNT = 8u }
	HIDS Characteristic indexes. More...
enum	cy_en_ble_hids_descr_t {   CY_BLE_HIDS_REPORT_CCCD,   CY_BLE_HIDS_REPORT_RRD,   CY_BLE_HIDS_REPORT_MAP_ERRD,   CY_BLE_HIDS_DESCR_COUNT }
	HID Service Characteristic Descriptors indexes. More...
enum	cy_en_ble_hidsc_char_write_t {   CY_BLE_HIDSC_WRITE_WITHOUT_RESPONSE,   CY_BLE_HIDSC_WRITE_CHAR_VALUE }
	Characteristic Value Write Sub-Procedure supported by HID Service. More...
enum	cy_en_ble_hidsc_char_read_t {   CY_BLE_HIDSC_READ_CHAR_VALUE,   CY_BLE_HIDSC_READ_LONG_CHAR_VALUE }
	Characteristic Value Read Sub-Procedure supported by HID Service. More...

Enumeration Type Documentation

cy_en_ble_hids_char_index_t

enum cy_en_ble_hids_char_index_t

HIDS Characteristic indexes.

Enumerator
CY_BLE_HIDS_PROTOCOL_MODE	Protocol Mode Characteristic index.
CY_BLE_HIDS_INFORMATION	HID Information Characteristic index.
CY_BLE_HIDS_CONTROL_POINT	HID Control Point Characteristic index.
CY_BLE_HIDS_REPORT_MAP	Report Map Characteristic index.
CY_BLE_HIDS_BOOT_KYBRD_IN_REP	Boot Keyboard Input Report Characteristic index.
CY_BLE_HIDS_BOOT_KYBRD_OUT_REP	Boot Keyboard Output Report Characteristic index.
CY_BLE_HIDS_BOOT_MOUSE_IN_REP	Boot Mouse Input Report Characteristic index.
CY_BLE_HIDS_REPORT	Report Characteristic index.
CY_BLE_HIDS_CHAR_COUNT	Total Count of Characteristics.

cy_en_ble_hids_descr_t

enum cy_en_ble_hids_descr_t

HID Service Characteristic Descriptors indexes.

Enumerator
CY_BLE_HIDS_REPORT_CCCD	Client Characteristic Configuration descriptor index.
CY_BLE_HIDS_REPORT_RRD	Report Reference descriptor index.
CY_BLE_HIDS_REPORT_MAP_ERRD	Report Map External Report Reference descriptor index.
CY_BLE_HIDS_DESCR_COUNT	Total Count of Descriptors.

cy_en_ble_hidsc_char_write_t

enum cy_en_ble_hidsc_char_write_t

Characteristic Value Write Sub-Procedure supported by HID Service.

Enumerator
CY_BLE_HIDSC_WRITE_WITHOUT_RESPONSE	Write Without Response.
CY_BLE_HIDSC_WRITE_CHAR_VALUE	Write Characteristic Value.

cy_en_ble_hidsc_char_read_t

enum cy_en_ble_hidsc_char_read_t

Characteristic Value Read Sub-Procedure supported by HID Service.

Enumerator
CY_BLE_HIDSC_READ_CHAR_VALUE	Read Characteristic Value.
CY_BLE_HIDSC_READ_LONG_CHAR_VALUE	Read Long Characteristic Values.