hids_client.h

Go to the documentation of this file.

 
#ifndef HIDS_CLIENT_H
#define HIDS_CLIENT_H
 
#include <string.h>
#include "ble_gattc.h"
#include "ble_client.h"
 
typedef enum {
        HIDS_CLIENT_PROTOCOL_MODE_BOOT = 0x00,          
        HIDS_CLIENT_PROTOCOL_MODE_REPORT = 0x01,        
} hids_client_protocol_mode_t;
 
typedef enum {
        HIDS_CLIENT_REPORT_TYPE_INPUT = 0x01,           
        HIDS_CLIENT_REPORT_TYPE_OUTPUT = 0x02,          
        HIDS_CLIENT_REPORT_TYPE_FEATURE = 0x03,         
} hids_client_report_type_t;
 
typedef enum {
        HIDS_CLIENT_BOOT_MOUSE_INPUT,                   
        HIDS_CLIENT_BOOT_KEYBOARD_INPUT,                
        HIDS_CLIENT_BOOT_KEYBOARD_OUTPUT,               
} hids_client_boot_report_type;
 
typedef enum {
        HIDS_CLIENT_CONTROL_POINT_SUSPEND = 0x00,       
        HIDS_CLIENT_CONTROL_POINT_EXIT_SUSPEND = 0x01,  
} hids_client_cp_command_t;
 
typedef enum {
        HIDS_CLIENT_CAP_PROTOCOL_MODE = 0x01,
        HIDS_CLIENT_CAP_BOOT_MOUSE_INPUT = 0x02,
        HIDS_CLIENT_CAP_BOOT_KEYBOARD_INPUT = 0x04,
        HIDS_CLIENT_CAP_BOOT_KEYBOARD_OUTPUT = 0x08,
        HIDS_CLIENT_CAP_HID_INFO = 0x10,
        HIDS_CLIENT_CAP_HID_CONTROL_POINT = 0x20,
        HIDS_CLIENT_CAP_REPORT_MAP = 0x40,
} hids_client_cap_t;
 
typedef struct {
        uint16_t bcd_hid;
        uint8_t  country_code;
        uint8_t  flags;
} hids_client_hid_info_t;
 
typedef struct {
        hids_client_protocol_mode_t mode;
} hids_client_config_t;
 
typedef void (* hids_client_boot_report_cb_t) (ble_client_t *hids_client,
                                                        hids_client_boot_report_type type,
                                                        att_error_t status, uint16_t length,
                                                        const uint8_t *data);
typedef void (* hids_client_report_cb_t) (ble_client_t *hids_client, hids_client_report_type_t type,
                                                        uint8_t report_id, att_error_t status,
                                                        uint16_t length, const uint8_t *data);
typedef void (* hids_client_read_report_map_cb_t) (ble_client_t *hids_client, att_error_t status,
                                                        uint16_t length, const uint8_t *data);
typedef void (* hids_client_read_hid_info_cb_t) (ble_client_t *hids_client,
                                                        const hids_client_hid_info_t *info);
typedef void (* hids_client_input_report_get_notif_state_cb_t) (ble_client_t *hids_client,
                                                                uint8_t report_id,
                                                                att_error_t status, bool enabled);
typedef void (* hids_client_input_report_set_notif_state_cb_t) (ble_client_t *hids_client,
                                                                        uint8_t report_id,
                                                                        att_error_t status);
typedef void (* hids_client_boot_report_get_notif_state_cb_t) (ble_client_t *hids_client,
                                                                hids_client_boot_report_type type,
                                                                att_error_t status, bool enabled);
typedef void (* hids_client_boot_report_set_notif_state_cb_t) (ble_client_t *hids_client,
                                                                hids_client_boot_report_type type,
                                                                att_error_t status);
typedef void (* hids_client_get_protocol_mode_cb_t) (ble_client_t *hids_client, att_error_t status,
                                                                hids_client_protocol_mode_t mode);
typedef void (* hids_client_set_protocol_mode_cb_t) (ble_client_t *hids_client,
                                                                        att_error_t status);
typedef void (* hids_client_external_report_found_cb_t) (ble_client_t *hids_client,
                                                att_error_t status, const att_uuid_t *uuid);
typedef void (* hids_client_discover_external_reports_completed_cb_t) (ble_client_t *hids_client);
typedef void (* hids_client_report_found_cb_t) (ble_client_t *hids_client, att_error_t status,
                                                hids_client_report_type_t type, uint8_t report_id);
typedef void (* hids_client_discover_reports_completed_cb_t) (ble_client_t *hids_client);
typedef void (* hids_client_report_write_completed_cb_t) (ble_client_t *hids_client,
                                                                hids_client_report_type_t type,
                                                                uint8_t report_id,
                                                                att_error_t status);
typedef void (* hids_client_dump_service_data_cb_t) (ble_client_t *hids_client,
                                                                        const char *fmt, ...);
 
typedef struct {
        hids_client_boot_report_cb_t                            boot_report;
        hids_client_report_cb_t                                 report;
        hids_client_read_report_map_cb_t                        report_map;
        hids_client_read_hid_info_cb_t                          hid_info;
        hids_client_input_report_get_notif_state_cb_t           input_report_get_notif_state;
        hids_client_input_report_set_notif_state_cb_t           input_report_set_notif_state;
        hids_client_boot_report_get_notif_state_cb_t            boot_report_get_notif_state;
        hids_client_boot_report_set_notif_state_cb_t            boot_report_set_notif_state;
        hids_client_get_protocol_mode_cb_t                      get_protocol_mode;
        hids_client_set_protocol_mode_cb_t                      set_protocol_mode;
        hids_client_external_report_found_cb_t                  external_report_found;
        hids_client_discover_external_reports_completed_cb_t    discover_external_reports_complete;
        hids_client_report_found_cb_t                           report_found;
        hids_client_discover_reports_completed_cb_t             discover_reports_complete;
        hids_client_report_write_completed_cb_t                 report_write_complete;
} hids_client_callbacks_t;
 
ble_client_t *hids_client_init(const hids_client_config_t *config, const hids_client_callbacks_t *cb,
                                                        const ble_evt_gattc_browse_svc_t *evt);
 
ble_client_t *hids_client_init_from_data(uint16_t conn_idx, const hids_client_config_t *config,
                                const hids_client_callbacks_t *cb,const void *data, size_t length);
 
bool hids_client_set_protocol_mode(ble_client_t *client);
 
bool hids_client_boot_report_read(ble_client_t *client, hids_client_boot_report_type type);
 
bool hids_client_boot_report_write(ble_client_t *client, hids_client_boot_report_type type,
                                        bool response, uint16_t length, const uint8_t *data);
 
bool hids_client_report_write(ble_client_t *client, hids_client_report_type_t type,
                                                uint8_t report_id, bool response, uint16_t length,
                                                const uint8_t *data);
 
bool hids_client_report_read(ble_client_t *client, hids_client_report_type_t type,
                                                                        uint8_t report_id);
 
bool hids_client_cp_command(ble_client_t *client, hids_client_cp_command_t command);
 
bool hids_client_input_report_set_notif_state(ble_client_t *client, uint8_t report_id,
                                                                                bool enable);
 
bool hids_client_input_report_get_notif_state(ble_client_t *client, uint8_t report_id);
 
bool hids_client_boot_report_set_notif_state(ble_client_t *client,
                                                hids_client_boot_report_type type, bool enable);
 
bool hids_client_boot_report_get_notif_state(ble_client_t *client,
                                                                hids_client_boot_report_type type);
 
bool hids_client_get_protocol_mode(ble_client_t *client);
 
bool hids_client_read_hid_info(ble_client_t *client);
 
bool hids_client_read_report_map(ble_client_t *client);
 
bool hids_client_discover_external_reports(ble_client_t *client);
 
bool hids_client_discover_reports(ble_client_t *client);
 
hids_client_cap_t hids_client_get_capabilities(ble_client_t *client);
 
void hids_client_dump_dervice_data(ble_client_t *client, hids_client_dump_service_data_cb_t cb);
 
#endif /* HIDS_CLIENT_H */