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 /** 39 * @title HID Service Client 40 * 41 */ 42 43 #ifndef HIDS_CLIENT_H 44 #define HIDS_CLIENT_H 45 46 #include <stdint.h> 47 #include "btstack_defines.h" 48 #include "btstack_hid.h" 49 #include "bluetooth.h" 50 #include "btstack_linked_list.h" 51 #include "ble/gatt_client.h" 52 53 #if defined __cplusplus 54 extern "C" { 55 #endif 56 57 /** 58 * @text The HID Service Client is used on the HID Host to receive reports and other HID data. 59 */ 60 61 #ifndef MAX_NUM_HID_SERVICES 62 #define MAX_NUM_HID_SERVICES 3 63 #endif 64 #define HIDS_CLIENT_INVALID_REPORT_INDEX 0xFF 65 66 #define HIDS_CLIENT_NUM_REPORTS 15 67 68 typedef enum { 69 HIDS_CLIENT_STATE_IDLE, 70 71 // get all HID services 72 HIDS_CLIENT_STATE_W2_QUERY_SERVICE, 73 HIDS_CLIENT_STATE_W4_SERVICE_RESULT, 74 75 // for each service, discover all characteristics 76 HIDS_CLIENT_STATE_W2_QUERY_CHARACTERISTIC, 77 HIDS_CLIENT_STATE_W4_CHARACTERISTIC_RESULT, 78 79 // called if BOOT mode 80 HIDS_CLIENT_STATE_W2_SET_PROTOCOL_MODE_WITHOUT_RESPONSE, 81 82 // for each REPORT_MAP characteristic, read HID Descriptor (Report Map Characteristic Value) 83 HIDS_CLIENT_STATE_W2_READ_REPORT_MAP_HID_DESCRIPTOR, 84 HIDS_CLIENT_STATE_W4_REPORT_MAP_HID_DESCRIPTOR, 85 86 // for REPORT_MAP characteristic, discover descriptor 87 HIDS_CLIENT_STATE_W2_REPORT_MAP_DISCOVER_CHARACTERISTIC_DESCRIPTORS, 88 HIDS_CLIENT_STATE_W4_REPORT_MAP_CHARACTERISTIC_DESCRIPTORS_RESULT, 89 90 // for REPORT_MAP characteristic, read External Report Reference Characteristic Descriptor 91 HIDS_CLIENT_STATE_W2_REPORT_MAP_READ_EXTERNAL_REPORT_REFERENCE_UUID, 92 HIDS_CLIENT_STATE_W4_REPORT_MAP_EXTERNAL_REPORT_REFERENCE_UUID, 93 94 // for every external report reference uuid, discover external Report characteristic 95 HIDS_CLIENT_STATE_W2_DISCOVER_EXTERNAL_REPORT_CHARACTERISTIC, 96 HIDS_CLIENT_STATE_W4_EXTERNAL_REPORT_CHARACTERISTIC_RESULT, 97 98 // for each Report characteristics, discover Report characteristic descriptor 99 HIDS_CLIENT_STATE_W2_FIND_REPORT, 100 HIDS_CLIENT_STATE_W4_REPORT_FOUND, 101 102 // then read value of Report characteristic descriptor to get report ID and type 103 HIDS_CLIENT_STATE_W2_READ_REPORT_ID_AND_TYPE, 104 HIDS_CLIENT_STATE_W4_REPORT_ID_AND_TYPE, 105 106 HIDS_CLIENT_STATE_W2_ENABLE_INPUT_REPORTS, 107 HIDS_CLIENT_STATE_W4_INPUT_REPORTS_ENABLED, 108 109 HIDS_CLIENT_STATE_CONNECTED, 110 111 HIDS_CLIENT_W2_SEND_WRITE_REPORT, 112 HIDS_CLIENT_W4_WRITE_REPORT_DONE, 113 114 HIDS_CLIENT_W2_SEND_GET_REPORT, 115 HIDS_CLIENT_W4_GET_REPORT_RESULT, 116 117 HIDS_CLIENT_W2_READ_VALUE_OF_CHARACTERISTIC, 118 HIDS_CLIENT_W4_VALUE_OF_CHARACTERISTIC_RESULT, 119 120 HIDS_CLIENT_W2_WRITE_VALUE_OF_CHARACTERISTIC_WITHOUT_RESPONSE, 121 122 HIDS_CLIENT_STATE_W2_CONFIGURE_NOTIFICATIONS, 123 HIDS_CLIENT_STATE_W4_NOTIFICATIONS_CONFIGURED, 124 125 #ifdef ENABLE_TESTING_SUPPORT 126 HIDS_CLIENT_W2_READ_CHARACTERISTIC_CONFIGURATION, 127 HIDS_CLIENT_W4_CHARACTERISTIC_CONFIGURATION_RESULT, 128 #endif 129 130 } hid_service_client_state_t; 131 132 133 typedef struct { 134 // GATT cache 135 136 //reuse as descriptor_handle 137 uint16_t value_handle; 138 uint16_t end_handle; 139 uint16_t properties; 140 141 // UUID of external Report characteristic, stored in Report Map descriptor EXTERNAL_REPORT_REFERENCE 142 uint16_t external_report_reference_uuid; 143 144 #ifdef ENABLE_TESTING_SUPPORT 145 uint16_t ccc_handle; 146 #endif 147 148 // service mapping 149 uint8_t service_index; 150 uint8_t report_id; 151 hid_report_type_t report_type; 152 uint8_t boot_report; 153 gatt_client_notification_t notification_listener; 154 } hids_client_report_t; 155 156 typedef struct { 157 hid_protocol_mode_t protocol_mode; 158 159 uint16_t start_handle; 160 uint16_t end_handle; 161 162 uint16_t report_map_value_handle; 163 uint16_t report_map_end_handle; 164 165 uint16_t hid_information_value_handle; 166 uint16_t control_point_value_handle; 167 uint16_t protocol_mode_value_handle; 168 169 // descriptor storage 170 uint16_t hid_descriptor_offset; 171 uint16_t hid_descriptor_len; 172 uint16_t hid_descriptor_max_len; 173 uint8_t hid_descriptor_status; // ERROR_CODE_SUCCESS if descriptor available, 174 // ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if not, and 175 // ERROR_CODE_MEMORY_CAPACITY_EXCEEDED if descriptor is larger then the available space 176 } hid_service_t; 177 178 typedef struct { 179 btstack_linked_item_t item; 180 181 hci_con_handle_t con_handle; 182 uint16_t cid; 183 184 hid_service_client_state_t state; 185 btstack_packet_handler_t client_handler; 186 187 uint8_t num_instances; 188 hid_service_t services[MAX_NUM_HID_SERVICES]; 189 190 // used for discovering characteristics 191 uint8_t service_index; 192 hid_protocol_mode_t required_protocol_mode; 193 194 // send report 195 hids_client_report_t reports[HIDS_CLIENT_NUM_REPORTS]; 196 uint8_t num_reports; 197 198 hids_client_report_t external_reports[HIDS_CLIENT_NUM_REPORTS]; 199 uint8_t num_external_reports; 200 201 // index used for report and report map search 202 uint8_t report_index; 203 uint16_t report_len; 204 const uint8_t * report; 205 // used to write control_point and protocol_mode 206 uint16_t handle; 207 uint8_t value; 208 } hids_client_t; 209 210 /* API_START */ 211 212 /** 213 * @brief Initialize HID Service Client. The HID Descriptor storage is shared between all connections. 214 * 215 * @param hid_descriptor_storage 216 * @param hid_descriptor_storage_len 217 */ 218 void hids_client_init(uint8_t * hid_descriptor_storage, uint16_t hid_descriptor_storage_len); 219 220 /* @brief Connect to HID Services of remote device. Event GATTSERVICE_SUBEVENT_HID_SERVICE_CONNECTED will be emitted 221 * after all remote HID services and characteristics are found, and notifications for all input reports are enabled. 222 * Status code can be ERROR_CODE_SUCCES if at least one HID service is found, otherwise either ATT errors or 223 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if no service or report map or report are found. 224 * It also contains the number of individual HIDS Services. 225 * 226 * @param con_handle 227 * @param packet_handler 228 * @param protocol_mode see hid_protocol_mode_t in btstack_hid.h 229 * @param hids_cid (out) to use for other functions 230 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_COMMAND_DISALLOWED if there is already a client 231 * associated with con_handle, or BTSTACK_MEMORY_ALLOC_FAILED. 232 */ 233 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); 234 235 /** 236 * @brief Send HID report. 237 * 238 * @param hids_cid 239 * @param report_id 240 * @param report_type 241 * @param report 242 * @param report_len 243 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, 244 * ERROR_CODE_COMMAND_DISALLOWED if client is in wrong state, 245 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if no report with given type and ID is found, or 246 * ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE if report length exceeds MTU. 247 */ 248 uint8_t hids_client_send_write_report(uint16_t hids_cid, uint8_t report_id, hid_report_type_t report_type, const uint8_t * report, uint8_t report_len); 249 250 /** 251 * @brief Get HID report. Event GATTSERVICE_SUBEVENT_HID_REPORT is emitted. 252 * 253 * @param hids_cid 254 * @param report_id 255 * @param report_type 256 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, 257 * ERROR_CODE_COMMAND_DISALLOWED if client is in wrong state, 258 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if no report with given type and ID is found, or 259 * ERROR_CODE_PARAMETER_OUT_OF_MANDATORY_RANGE if report length exceeds MTU. 260 */ 261 uint8_t hids_client_send_get_report(uint16_t hids_cid, uint8_t report_id, hid_report_type_t report_type); 262 263 /** 264 * @brief Get HID Information. Event GATTSERVICE_SUBEVENT_HID_INFORMATION is emitted. 265 * 266 * @param hids_cid 267 * @param service_index 268 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, 269 * ERROR_CODE_COMMAND_DISALLOWED if client is in wrong state, or 270 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if no report with given type and ID is found. 271 */ 272 uint8_t hids_client_get_hid_information(uint16_t hids_cid, uint8_t service_index); 273 274 /** 275 * @brief Get Protocol Mode. Event GATTSERVICE_SUBEVENT_HID_PROTOCOL_MODE is emitted. 276 * 277 * @param hids_cid 278 * @param service_index 279 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, 280 * ERROR_CODE_COMMAND_DISALLOWED if client is in wrong state, or 281 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if no report with given type and ID is found. 282 */ 283 uint8_t hids_client_get_protocol_mode(uint16_t hids_cid, uint8_t service_index); 284 285 /** 286 * @brief Set Protocol Mode. 287 * 288 * @param hids_cid 289 * @param service_index 290 * @param protocol_mode 291 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, 292 * ERROR_CODE_COMMAND_DISALLOWED if client is in wrong state, or 293 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if no report with given type and ID is found. 294 */ 295 uint8_t hids_client_send_set_protocol_mode(uint16_t hids_cid, uint8_t service_index, hid_protocol_mode_t protocol_mode); 296 297 /** 298 * @brief Send Suspend to remote HID service. 299 * 300 * @param hids_cid 301 * @param service_index 302 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, 303 * ERROR_CODE_COMMAND_DISALLOWED if client is in wrong state, or 304 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if no report with given type and ID is found. 305 */ 306 uint8_t hids_client_send_suspend(uint16_t hids_cid, uint8_t service_index); 307 308 /** 309 * @brief Send Exit Suspend to remote HID service. 310 * 311 * @param hids_cid 312 * @param service_index 313 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, 314 * ERROR_CODE_COMMAND_DISALLOWED if client is in wrong state, or 315 * ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE if no report with given type and ID is found. 316 */ 317 uint8_t hids_client_send_exit_suspend(uint16_t hids_cid, uint8_t service_index); 318 319 /** 320 * @brief Enable all notifications. Event GATTSERVICE_SUBEVENT_HID_SERVICE_REPORTS_NOTIFICATION reports current configuration. 321 * 322 * @param hids_cid 323 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, or 324 * ERROR_CODE_COMMAND_DISALLOWED if client is in wrong state. 325 */ 326 uint8_t hids_client_enable_notifications(uint16_t hids_cid); 327 328 /** 329 * @brief Disable all notifications. Event GATTSERVICE_SUBEVENT_HID_SERVICE_REPORTS_NOTIFICATION reports current configuration. 330 * 331 * @param hids_cid 332 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER, or 333 * ERROR_CODE_COMMAND_DISALLOWED if client is in wrong state. 334 */ 335 uint8_t hids_client_disable_notifications(uint16_t hids_cid); 336 337 /** 338 * @brief Disconnect from HID Service. 339 * 340 * @param hids_cid 341 * @return status ERROR_CODE_SUCCESS on success, otherwise ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER 342 */ 343 uint8_t hids_client_disconnect(uint16_t hids_cid); 344 345 /* 346 * @brief Get descriptor data. For services in boot mode without a Report Map, a default HID Descriptor for Keyboard/Mouse is provided. 347 * 348 * @param hid_cid 349 * @return data 350 */ 351 const uint8_t * hids_client_descriptor_storage_get_descriptor_data(uint16_t hids_cid, uint8_t service_index); 352 353 /* 354 * @brief Get descriptor length 355 * 356 * @param hid_cid 357 * @return length 358 */ 359 uint16_t hids_client_descriptor_storage_get_descriptor_len(uint16_t hids_cid, uint8_t service_index); 360 361 /** 362 * @brief De-initialize HID Service Client. 363 * 364 */ 365 void hids_client_deinit(void); 366 367 /* API_END */ 368 369 #if defined __cplusplus 370 } 371 #endif 372 373 #endif 374