1 /* 2 * Copyright (C) 2021 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 #ifndef HIDS_CLIENT_H 39 #define HIDS_CLIENT_H 40 41 #if defined __cplusplus 42 extern "C" { 43 #endif 44 45 #include <stdint.h> 46 #include "hid.h" 47 #include "btstack_defines.h" 48 #include "bluetooth.h" 49 #include "btstack_linked_list.h" 50 #include "ble/gatt_client.h" 51 52 #ifndef MAX_NUM_HID_SERVICES 53 #define MAX_NUM_HID_SERVICES 3 54 #endif 55 #define HIDS_CLIENT_INVALID_REPORT_INDEX 0xFF 56 57 #define HIDS_CLIENT_NUM_REPORTS 15 58 59 typedef enum { 60 HIDS_CLIENT_STATE_IDLE, 61 62 // get all HID services 63 HIDS_CLIENT_STATE_W2_QUERY_SERVICE, 64 HIDS_CLIENT_STATE_W4_SERVICE_RESULT, 65 66 // for each service, discover all characteristics 67 HIDS_CLIENT_STATE_W2_QUERY_CHARACTERISTIC, 68 HIDS_CLIENT_STATE_W4_CHARACTERISTIC_RESULT, 69 70 HIDS_CLIENT_STATE_W2_SET_BOOT_PROTOCOL_MODE, 71 72 // for each REPORT_MAP characteristic, read HID Descriptor (Report Map Characteristic Value) 73 HIDS_CLIENT_STATE_W2_READ_REPORT_MAP_HID_DESCRIPTOR, 74 HIDS_CLIENT_STATE_W4_REPORT_MAP_HID_DESCRIPTOR, 75 76 // for REPORT_MAP characteristic, discover descriptor 77 HIDS_CLIENT_STATE_W2_REPORT_MAP_DISCOVER_CHARACTERISTIC_DESCRIPTORS, 78 HIDS_CLIENT_STATE_W4_REPORT_MAP_CHARACTERISTIC_DESCRIPTORS_RESULT, 79 80 // for REPORT_MAP characteristic, read External Report Reference Characteristic Descriptor 81 HIDS_CLIENT_STATE_W2_REPORT_MAP_READ_EXTERNAL_REPORT_REFERENCE_UUID, 82 HIDS_CLIENT_STATE_W4_REPORT_MAP_EXTERNAL_REPORT_REFERENCE_UUID, 83 84 // for every external report reference uuid, discover external Report characteristic 85 HIDS_CLIENT_STATE_W2_DISCOVER_EXTERNAL_REPORT_CHARACTERISTIC, 86 HIDS_CLIENT_STATE_W4_EXTERNAL_REPORT_CHARACTERISTIC_RESULT, 87 88 // for each Report characteristics, discover Report characteristic descriptor 89 HIDS_CLIENT_STATE_W2_FIND_REPORT, 90 HIDS_CLIENT_STATE_W4_REPORT_FOUND, 91 92 // then read value of Report characteristic descriptor to get report ID and type 93 HIDS_CLIENT_STATE_W2_READ_REPORT_ID_AND_TYPE, 94 HIDS_CLIENT_STATE_W4_REPORT_ID_AND_TYPE, 95 96 HIDS_CLIENT_STATE_W2_ENABLE_INPUT_REPORTS, 97 HIDS_CLIENT_STATE_W4_INPUT_REPORTS_ENABLED, 98 99 HIDS_CLIENT_STATE_CONNECTED, 100 101 HIDS_CLIENT_W2_SEND_WRITE_REPORT, 102 HIDS_CLIENT_W4_WRITE_REPORT_DONE, 103 104 HIDS_CLIENT_W2_SEND_GET_REPORT, 105 HIDS_CLIENT_W4_GET_REPORT_RESULT, 106 107 HIDS_CLIENT_W2_READ_VALUE_OF_CHARACTERISTIC, 108 HIDS_CLIENT_W4_VALUE_OF_CHARACTERISTIC_RESULT, 109 110 HIDS_CLIENT_W2_WRITE_VALUE_OF_CHARACTERISTIC_WITHOUT_RESPONSE, 111 112 #ifdef ENABLE_TESTING_SUPPORT 113 HIDS_CLIENT_W2_READ_CHARACTERISTIC_CONFIGURATION, 114 HIDS_CLIENT_W4_CHARACTERISTIC_CONFIGURATION_RESULT, 115 #endif 116 117 } hid_service_client_state_t; 118 119 120 typedef struct { 121 // GATT cache 122 123 //reuse as descriptor_handle 124 uint16_t value_handle; 125 uint16_t end_handle; 126 uint16_t properties; 127 128 // UUID of external Report characteristic, stored in Report Map descriptor EXTERNAL_REPORT_REFERENCE 129 uint16_t external_report_reference_uuid; 130 131 #ifdef ENABLE_TESTING_SUPPORT 132 uint16_t ccc_handle; 133 #endif 134 135 // service mapping 136 uint8_t service_index; 137 uint8_t report_id; 138 hid_report_type_t report_type; 139 uint8_t boot_report; 140 gatt_client_notification_t notification_listener; 141 } hids_client_report_t; 142 143 typedef struct { 144 uint16_t start_handle; 145 uint16_t end_handle; 146 147 uint16_t report_map_value_handle; 148 uint16_t report_map_end_handle; 149 150 uint16_t hid_information_value_handle; 151 uint16_t control_point_value_handle; 152 uint16_t protocol_mode_value_handle; 153 154 // descriptor storage 155 uint16_t hid_descriptor_offset; 156 uint16_t hid_descriptor_len; 157 uint16_t hid_descriptor_max_len; 158 uint8_t hid_descriptor_status; // ERROR_CODE_SUCCESS if descriptor available, 159 // ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if not, and 160 // ERROR_CODE_MEMORY_CAPACITY_EXCEEDED if descriptor is larger then the available space 161 } hid_service_t; 162 163 typedef struct { 164 btstack_linked_item_t item; 165 166 hci_con_handle_t con_handle; 167 uint16_t cid; 168 hid_protocol_mode_t protocol_mode; 169 hid_service_client_state_t state; 170 btstack_packet_handler_t client_handler; 171 172 uint8_t num_instances; 173 hid_service_t services[MAX_NUM_HID_SERVICES]; 174 175 // used for discovering characteristics 176 uint8_t service_index; 177 hid_protocol_mode_t required_protocol_mode; 178 179 uint16_t protocol_mode_value_handle; 180 181 // send report 182 hids_client_report_t reports[HIDS_CLIENT_NUM_REPORTS]; 183 uint8_t num_reports; 184 185 hids_client_report_t external_reports[HIDS_CLIENT_NUM_REPORTS]; 186 uint8_t num_external_reports; 187 188 // index used for report and report map search 189 uint8_t report_index; 190 uint16_t report_len; 191 const uint8_t * report; 192 // used to write control_point and protocol_mode 193 uint16_t handle; 194 uint8_t value; 195 } hids_client_t; 196 197 /* API_START */ 198 199 /** 200 * @brief Initialize Battery Service. 201 * @param hid_descriptor_storage 202 * @param hid_descriptor_storage_len 203 */ 204 void hids_client_init(uint8_t * hid_descriptor_storage, uint16_t hid_descriptor_storage_len); 205 206 /* @brief Connect to HID Services of remote device. 207 * 208 * @param con_handle 209 * @param packet_handler 210 * @param protocol_mode see hid_protocol_mode_t in hid.h 211 * @param hids_cid 212 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_COMMAND_DISALLOWED if there is already a client associated with con_handle, or BTSTACK_MEMORY_ALLOC_FAILED 213 */ 214 uint8_t hids_client_connect(hci_con_handle_t con_handle, btstack_packet_handler_t packet_handler, hid_protocol_mode_t protocol_mode, uint16_t * hids_cid); 215 216 /** 217 * @brief Send HID output report. 218 * @param hids_cid 219 * @param report_id 220 * @param report 221 * @param report_len 222 * @result status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, ERROR_CODE_COMMAND_DISALLOWED 223 */ 224 uint8_t hids_client_send_write_report(uint16_t hids_cid, uint8_t report_id, const uint8_t * report, uint8_t report_len); 225 226 uint8_t hids_client_send_get_report(uint16_t hids_cid, uint8_t report_id); 227 228 uint8_t hids_client_get_hid_information(uint16_t hids_cid, uint8_t service_index); 229 230 uint8_t hids_client_get_protocol_mode(uint16_t hids_cid, uint8_t service_index); 231 232 uint8_t hids_client_send_set_protocol_mode(uint16_t hids_cid, hid_protocol_mode_t protocol_mode, uint8_t service_index); 233 234 uint8_t hids_client_send_suspend(uint16_t hids_cid, uint8_t service_index); 235 236 uint8_t hids_client_send_exit_suspend(uint16_t hids_cid, uint8_t service_index); 237 238 /** 239 * @brief Disconnect from Battery Service. 240 * @param hids_cid 241 * @return status 242 */ 243 uint8_t hids_client_disconnect(uint16_t hids_cid); 244 245 /* 246 * @brief Get descriptor data 247 * @param hid_cid 248 * @result data 249 */ 250 const uint8_t * hids_client_descriptor_storage_get_descriptor_data(uint16_t hids_cid, uint8_t service_index); 251 252 /* 253 * @brief Get descriptor length 254 * @param hid_cid 255 * @result length 256 */ 257 uint16_t hids_client_descriptor_storage_get_descriptor_len(uint16_t hids_cid, uint8_t service_index); 258 259 /** 260 * @brief De-initialize Battery Service. 261 */ 262 void hids_client_deinit(void); 263 264 /* API_END */ 265 266 #if defined __cplusplus 267 } 268 #endif 269 270 #endif 271