hids.h

Go to the documentation of this file.

 
#ifndef HIDS_H_
#define HIDS_H_
 
#include "ble_gap.h"
#include "ble_service.h"
 
typedef enum {
        HIDS_PROTOCOL_MODE_BOOT = 0x00,         
        HIDS_PROTOCOL_MODE_REPORT = 0x01,       
} hids_protocol_mode_t;
 
typedef enum {
        HIDS_CONTROL_POINT_SUSPEND = 0x00,      
        HIDS_CONTROL_POINT_EXIT_SUSPEND = 0x01, 
} hids_cp_command_t;
 
typedef enum {
        HIDS_REPORT_TYPE_INPUT = 0x01,          
        HIDS_REPORT_TYPE_OUTPUT = 0x02,         
        HIDS_REPORT_TYPE_FEATURE = 0x03,        
} hids_report_type_t;
 
typedef void (* hids_set_protocol_mode_cb_t) (ble_service_t *svc, hids_protocol_mode_t mode);
typedef void (* hids_control_point_cb_t) (ble_service_t *svc, hids_cp_command_t command);
typedef void (* hids_boot_keyboard_output_write_cb_t) (ble_service_t *svc, uint16_t length,
                                                                        const uint8_t *data);
typedef void (* hids_report_write_cb_t) (ble_service_t *svc, hids_report_type_t report_type,
                                        uint8_t report_id, uint16_t length, const uint8_t *data);
typedef void (* hids_report_sent_t) (ble_service_t *svc);
typedef void (* hids_notify_boot_mouse_input_report_completed_cb_t) (ble_service_t *svc,
                                                                                bool success);
typedef void (* hids_notify_boot_keyboard_input_report_completed_cb_t) (ble_service_t *svc,
                                                                                bool success);
typedef void (* hids_notify_input_report_completed_cb_t) (ble_service_t *svc, uint8_t report_id,
                                                                                bool success);
 
 
typedef struct {
        hids_set_protocol_mode_cb_t set_protocol_mode;
        hids_control_point_cb_t control_point;
        hids_boot_keyboard_output_write_cb_t boot_keyboard_write;
        hids_report_write_cb_t report_write;
        /* Indicates that report notification has been sent */
        hids_report_sent_t report_sent;
        hids_notify_boot_mouse_input_report_completed_cb_t
                                                        notify_boot_mouse_input_report_completed;
        hids_notify_boot_keyboard_input_report_completed_cb_t
                                                notify_boot_keyboard_input_report_completed;
        hids_notify_input_report_completed_cb_t notify_input_report_completed;
} hids_callbacks_t;
 
typedef struct {
        hids_report_type_t type;        
        uint8_t report_id;              
        uint16_t length;                
} hids_report_t;
 
typedef enum {
        HIDS_INFO_FLAG_REMOTE_WAKE = 0x01,
        HID_INFO_FLAG_NORMALLY_CONNECTABLE = 0x02,
} hids_info_flag_t;
 
typedef struct {
        uint16_t bcd_hid;
        uint8_t country_code;
        uint8_t flags;
} hids_hid_info_t;
 
typedef enum {
        HIDS_BOOT_DEVICE_KEYBOARD = 0x01,
        HIDS_BOOT_DEVICE_MOUSE = 0x02,
        HIDS_BOOT_DEVICE_COMBO = HIDS_BOOT_DEVICE_KEYBOARD | HIDS_BOOT_DEVICE_MOUSE,
} hids_boot_device_t;
 
typedef struct {
        uint8_t num_reports;
        const hids_report_t *reports;
        const uint8_t *report_map;
        uint16_t report_map_length;
        hids_hid_info_t hids_info;
        hids_boot_device_t boot_device;
} hids_config_t;
 
ble_service_t *hids_init(const ble_service_config_t *service_config, const hids_config_t *config,
                                                                const hids_callbacks_t *callbacks);
 
bool hids_attach_connection(ble_service_t *svc, uint16_t conn_idx);
 
bool hids_set_boot_mouse_input_value(ble_service_t *svc, uint16_t length, const uint8_t *data)
                                                                __attribute__((deprecated));
 
bool hids_set_boot_mouse_input_report(ble_service_t *svc, uint16_t length, const uint8_t *data);
 
bool hids_notify_boot_mouse_input_report(ble_service_t *svc, uint16_t length, const uint8_t *data, ble_error_t *ble_err);
 
bool hids_set_boot_keyboard_input_value(ble_service_t *svc, uint16_t length, const uint8_t *data)
                                                                __attribute__((deprecated));
 
bool hids_set_boot_keyboard_input_report(ble_service_t *svc, uint16_t length, const uint8_t *data);
 
bool hids_notify_boot_keyboard_input_report(ble_service_t *svc, uint16_t length,
                                            const uint8_t *data, ble_error_t *ble_err);
 
bool hids_set_report_value(ble_service_t *svc, hids_report_type_t type, uint8_t report_id,
                                uint16_t length, const uint8_t *data) __attribute__((deprecated));
 
bool hids_set_report(ble_service_t *svc, hids_report_type_t type, uint8_t report_id,
                                                        uint16_t length, const uint8_t *data);
 
bool hids_notify_input_report(ble_service_t *svc, uint8_t report_id,
                              uint16_t length, const uint8_t *data, ble_error_t *ble_err);
 
#endif /* HIDS_H_ */