Infineon Logo AIROC BTSDK v4.2 - Documentation
 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
wiced_bt_hidd_ble.h File Reference

Human Interface Device Profile (HID) Device over LE. More...

Data Structures

struct  wiced_bt_hidd_ble_rpt_ref_t
 report reference descriptor value More...
 
struct  wiced_bt_hidd_ble_dev_info_t
 LE HIDD registration information. More...
 
struct  wiced_bt_hidd_ble_dscp_info_t
 HIDD LE description info. More...
 
struct  wiced_bt_hidd_ble_rpt_map_info_t
 LE HIDD report map info. More...
 
struct  wiced_bt_hidd_ble_rpt_data_t
 LE HIDD report data. More...
 
struct  wiced_bt_hidd_ble_get_rpt_data_t
 LE HIDD get report data. More...
 
union  wiced_bt_hidd_ble_cback_data_t
 HIDD LE callback data. More...
 
struct  wiced_bt_hidd_ble_reg_info_t
 HIDD LE registration info. More...
 

Macros

#define HIDD_LE_RPT_NOT_SUPT   0x8F
 GATT application error code for HID profile. More...
 
#define HIDD_LE_KB_TYPE   0x01
 HIDD type. More...
 
#define HIDD_LE_MICE_TYPE   0x02
 bit 1
 
#define HIDD_LE_OTHER_TYPE   0x80
 bit 7
 
#define HIDD_LE_PROTO_MODE_RPT   0x00
 Report protocol.
 
#define HIDD_LE_PROTO_MODE_BOOT   0x01
 Boot protocol.
 
#define HID_LE_RPT_TYPE_INPUT   0x01
 LE HIDD report type. More...
 
#define HID_LE_RPT_TYPE_OUTPUT   0x02
 Output reports.
 
#define HID_LE_RPT_TYPE_FEATURE   0x03
 Feature reports.
 
#define HID_LE_RPT_TYPE_KB_INPUT   0x04
 Keyboard input.
 
#define HID_LE_RPT_TYPE_KB_OUTPUT   0x05
 Keyboard output.
 
#define HID_LE_RPT_TYPE_MI_INPUT   0x06
 Mouse input.
 
#define HID_LE_RPT_TYPE_MAX   HID_LE_RPT_TYPE_FEATURE
 Maximun report type.
 
#define HIDD_LE_REMOTE_WAKE   0x01
 Remote wake.
 
#define HIDD_LE_NORMAL_CONN   0x02
 Normally connectable.
 
#define HIDD_REPT_ID_BOOT_KB   1
 Bluetooth HID Boot Report Keyboard.
 
#define HIDD_REPT_ID_BOOT_MOUSE   2
 Bluetooth HID Boot Report Mouse.
 

Typedefs

typedef uint8_t wiced_bt_hidd_ble_cback_event_t
 HIDD LE callback events.
 
typedef uint8_t wiced_bt_hidd_ble_dev_t
 HIDD LE device types.
 
typedef uint8_t wiced_bt_hidd_ble_proto_t
 HIDD LE protocol types.
 
typedef uint8_t wiced_bt_hidd_ble_rpt_t
 HIDD LE report types.
 
typedef uint8_t wiced_bt_hidd_ble_status_t
 HIDD LE status codes.
 
typedef void( wiced_bt_hidd_ble_cback_t )(uint8_t event, uint32_t data, wiced_bt_hidd_ble_cback_data_t *p_data)
 HIDD LE callback. More...
 

Enumerations

enum  wiced_bt_hidd_ble_cback_event_e {
  WICED_BT_HIDD_BLE_DEV_EVT_OPEN, WICED_BT_HIDD_BLE_DEV_EVT_CLOSE, WICED_BT_HIDD_BLE_DEV_EVT_GET_REPORT, WICED_BT_HIDD_BLE_DEV_EVT_SET_REPORT,
  WICED_BT_HIDD_BLE_DEV_EVT_GET_PROTO, WICED_BT_HIDD_BLE_DEV_EVT_SET_PROTO, WICED_BT_HIDD_BLE_DEV_EVT_DATA
}
 HID-LE-Device Callback Event Values. More...
 
enum  wiced_bt_hidd_ble_status {
  WICED_BT_HIDD_BLE_SUCCESS, WICED_BT_HIDD_BLE_ERR_NOT_REGISTERED, WICED_BT_HIDD_BLE_ERR_ALREADY_REGISTERED, WICED_BT_HIDD_BLE_ERR_NO_RESOURCES,
  WICED_BT_HIDD_BLE_ERR_NO_CONNECTION, WICED_BT_HIDD_BLE_ERR_INVALID_PARAM, WICED_BT_HIDD_BLE_ERR_UNSUPPORTED, WICED_BT_HIDD_BLE_ERR_UNKNOWN_COMMAND,
  WICED_BT_HIDD_BLE_ERR_CONGESTED, WICED_BT_HIDD_BLE_ERR_CONN_IN_PROCESS, WICED_BT_HIDD_BLE_ERR_ALREADY_CONN, WICED_BT_HIDD_BLE_ERR_DISCONNECTING,
  WICED_BT_HIDD_BLE_ERR_SET_CONNABLE_FAIL, WICED_BT_HIDD_BLE_ERR_HOST_UNKNOWN, WICED_BT_HIDD_BLE_ERR_L2CAP_FAILED, WICED_BT_HIDD_BLE_ERR_AUTH_FAILED,
  WICED_BT_HIDD_BLE_ERR_SDP_BUSY, WICED_BT_HIDD_BLE_ERR_GATT, WICED_BT_HIDD_BLE_ERR_INVALID = 0xFF
}
 HIDD LE status codes. More...
 

Functions

void wiced_bt_hidd_ble_init (void)
 Initialize HIDD LE control block and trace variable.
 
wiced_bt_hidd_ble_status_t wiced_bt_hidd_ble_register (wiced_bt_hidd_ble_reg_info_t *p_reg_info)
 This function must be called at startup to register info related to HIDD over LE. More...
 
wiced_bt_hidd_ble_status_t wiced_bt_hidd_ble_deregister (void)
 Disable HIDD service. More...
 
wiced_bt_hidd_ble_status_t wiced_bt_hidd_ble_connect (void)
 Initiates a connection to the host. More...
 
wiced_bt_hidd_ble_status_t wiced_bt_hidd_ble_disconnect (void)
 Disconnects from the host. More...
 
wiced_bt_hidd_ble_status_t wiced_bt_hidd_ble_send_report (uint8_t rep_type, uint8_t rpt_id, uint16_t len, uint16_t offset, uint8_t *p_rpt)
 Sends report data to the host. More...
 
wiced_bt_hidd_ble_status_t wiced_bt_hidd_ble_hand_shake (wiced_bt_hidd_ble_status_t status)
 Acks a set report request. More...
 
wiced_bt_hidd_ble_status_t wiced_bt_hidd_ble_rsp_get_protocol (wiced_bt_hidd_ble_proto_t cur_mode)
 Responds to a get protocol mode request. More...
 
wiced_bt_hidd_ble_status_t wiced_bt_hidd_ble_set_rsp_map_info (wiced_bt_hidd_ble_rpt_map_info_t *p_dev_info)
 This function shall be called at startup to configure the device HID information and report map. More...
 

Detailed Description

Human Interface Device Profile (HID) Device over LE.