1 /* 2 * Copyright (C) 2014 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 BLUEKITCHEN 24 * GMBH 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 #define BTSTACK_FILE__ "hids_device.c" 39 40 /** 41 * Implementation of the GATT HIDS Device 42 * To use with your application, add '#import <hids.gatt>' to your .gatt file 43 */ 44 45 #include "hids_device.h" 46 47 #include "ble/att_db.h" 48 #include "ble/att_server.h" 49 #include "bluetooth_gatt.h" 50 #include "btstack_util.h" 51 #include "btstack_debug.h" 52 53 #define HIDS_DEVICE_ERROR_CODE_INAPPROPRIATE_CONNECTION_PARAMETERS 0x80 54 55 // storage for 'generic' HID Device with single Input, Output, and Feature Report 56 static hids_device_report_t hid_reports_generic_storage[3]; 57 58 typedef struct{ 59 uint16_t con_handle; 60 61 uint8_t hid_country_code; 62 const uint8_t * hid_descriptor; 63 uint16_t hid_descriptor_size; 64 65 uint16_t hid_report_map_handle; 66 uint8_t hid_protocol_mode; 67 uint16_t hid_protocol_mode_value_handle; 68 69 uint16_t hid_boot_mouse_input_value_handle; 70 uint16_t hid_boot_mouse_input_client_configuration_handle; 71 uint16_t hid_boot_mouse_input_client_configuration_value; 72 73 uint16_t hid_boot_keyboard_input_value_handle; 74 uint16_t hid_boot_keyboard_input_client_configuration_handle; 75 uint16_t hid_boot_keyboard_input_client_configuration_value; 76 77 hids_device_report_t * hid_reports; 78 79 uint8_t hid_input_reports_num; 80 uint8_t hid_output_reports_num; 81 uint8_t hid_feature_reports_num; 82 83 uint16_t hid_control_point_value_handle; 84 uint8_t hid_control_point_suspend; 85 86 btstack_context_callback_registration_t battery_callback; 87 } hids_device_t; 88 89 static hids_device_t hids_device; 90 91 static btstack_packet_handler_t packet_handler; 92 static att_service_handler_t hid_service; 93 94 // TODO: store hids device connection into list 95 static hids_device_t * hids_device_get_instance_for_con_handle(uint16_t con_handle){ 96 UNUSED(con_handle); 97 return &hids_device; 98 } 99 100 static hids_device_t * hids_device_create_instance(void){ 101 memset(&hids_device, 0, sizeof(hids_device_t)); 102 return &hids_device; 103 } 104 105 static hids_device_report_t * hids_device_get_report_for_client_configuration_handle(hids_device_t * device, uint16_t client_configuration_handle){ 106 uint8_t pos; 107 uint8_t total_reports = device->hid_input_reports_num + device->hid_output_reports_num + device->hid_feature_reports_num; 108 for (pos = 0 ; pos < total_reports ; pos++){ 109 if (device->hid_reports[pos].client_configuration_handle == client_configuration_handle){ 110 return &device->hid_reports[pos]; 111 } 112 } 113 return NULL; 114 } 115 116 static hids_device_report_t * 117 hids_device_get_report_for_id_and_type(hids_device_t *device, uint16_t report_id, hid_report_type_t type) { 118 uint8_t pos; 119 uint8_t total_reports = device->hid_input_reports_num + device->hid_output_reports_num + device->hid_feature_reports_num; 120 for (pos = 0 ; pos < total_reports ; pos++){ 121 if ((device->hid_reports[pos].type == type) && (device->hid_reports[pos].id == report_id)){ 122 return &device->hid_reports[pos]; 123 } 124 } 125 return NULL; 126 } 127 128 static void hids_device_emit_event_with_uint8(uint8_t event, hci_con_handle_t con_handle, uint8_t value){ 129 hids_device_t * instance = hids_device_get_instance_for_con_handle(con_handle); 130 if (!instance){ 131 log_error("no instance for handle 0x%02x", con_handle); 132 return; 133 } 134 135 if (!packet_handler) return; 136 uint8_t buffer[6]; 137 buffer[0] = HCI_EVENT_HIDS_META; 138 buffer[1] = 4; 139 buffer[2] = event; 140 little_endian_store_16(buffer, 3, (uint16_t) con_handle); 141 buffer[5] = value; 142 (*packet_handler)(HCI_EVENT_PACKET, 0, buffer, sizeof(buffer)); 143 } 144 145 static void hids_device_emit_event(uint8_t event, hci_con_handle_t con_handle){ 146 hids_device_t * instance = hids_device_get_instance_for_con_handle(con_handle); 147 if (!instance){ 148 log_error("no instance for handle 0x%02x", con_handle); 149 return; 150 } 151 152 if (!packet_handler) return; 153 uint8_t buffer[5]; 154 buffer[0] = HCI_EVENT_HIDS_META; 155 buffer[1] = 4; 156 buffer[2] = event; 157 little_endian_store_16(buffer, 3, (uint16_t) con_handle); 158 (*packet_handler)(HCI_EVENT_PACKET, 0, buffer, sizeof(buffer)); 159 } 160 161 static void hids_device_can_send_now(void * context){ 162 hci_con_handle_t con_handle = (hci_con_handle_t) (uintptr_t) context; 163 // notify client 164 hids_device_t * instance = hids_device_get_instance_for_con_handle(con_handle); 165 if (!instance){ 166 log_error("no instance for handle 0x%02x", con_handle); 167 return; 168 } 169 170 if (!packet_handler) return; 171 uint8_t buffer[5]; 172 buffer[0] = HCI_EVENT_HIDS_META; 173 buffer[1] = 3; 174 buffer[2] = HIDS_SUBEVENT_CAN_SEND_NOW; 175 little_endian_store_16(buffer, 3, (uint16_t) con_handle); 176 (*packet_handler)(HCI_EVENT_PACKET, 0, buffer, sizeof(buffer)); 177 } 178 179 // ATT Client Read Callback for Dynamic Data 180 // - if buffer == NULL, don't copy data, just return size of value 181 // - if buffer != NULL, copy data and return number bytes copied 182 static uint16_t att_read_callback(hci_con_handle_t con_handle, uint16_t att_handle, uint16_t offset, uint8_t * buffer, uint16_t buffer_size){ 183 hids_device_t * instance = hids_device_get_instance_for_con_handle(con_handle); 184 if (!instance){ 185 log_error("no instance for handle 0x%02x", con_handle); 186 return HIDS_DEVICE_ERROR_CODE_INAPPROPRIATE_CONNECTION_PARAMETERS; 187 } 188 189 if (att_handle == instance->hid_protocol_mode_value_handle){ 190 log_info("Read protocol mode"); 191 return att_read_callback_handle_byte(instance->hid_protocol_mode, offset, buffer, buffer_size); 192 } 193 194 if (att_handle == instance->hid_report_map_handle){ 195 log_info("Read report map"); 196 return att_read_callback_handle_blob(instance->hid_descriptor, instance->hid_descriptor_size, offset, buffer, buffer_size); 197 } 198 199 if (att_handle == instance->hid_boot_mouse_input_client_configuration_handle){ 200 return att_read_callback_handle_little_endian_16(instance->hid_boot_mouse_input_client_configuration_value, offset, buffer, buffer_size); 201 } 202 203 if (att_handle == instance->hid_boot_keyboard_input_client_configuration_handle){ 204 return att_read_callback_handle_little_endian_16(instance->hid_boot_keyboard_input_client_configuration_value, offset, buffer, buffer_size); 205 } 206 207 if (att_handle == instance->hid_control_point_value_handle){ 208 if (buffer && (buffer_size >= 1u)){ 209 buffer[0] = instance->hid_control_point_suspend; 210 } 211 return 1; 212 } 213 214 hids_device_report_t * report = hids_device_get_report_for_client_configuration_handle(instance, att_handle); 215 if (report != NULL){ 216 return att_read_callback_handle_little_endian_16(report->client_configuration_value, offset, buffer, buffer_size); 217 } 218 return 0; 219 } 220 221 static int att_write_callback(hci_con_handle_t con_handle, uint16_t att_handle, uint16_t transaction_mode, uint16_t offset, uint8_t *buffer, uint16_t buffer_size){ 222 UNUSED(transaction_mode); 223 UNUSED(buffer_size); 224 UNUSED(offset); 225 226 hids_device_t * instance = hids_device_get_instance_for_con_handle(con_handle); 227 if (!instance){ 228 log_error("no instance for handle 0x%02x", con_handle); 229 return HIDS_DEVICE_ERROR_CODE_INAPPROPRIATE_CONNECTION_PARAMETERS; 230 } 231 232 if (att_handle == instance->hid_boot_mouse_input_client_configuration_handle){ 233 uint16_t new_value = little_endian_read_16(buffer, 0); 234 instance->hid_boot_mouse_input_client_configuration_value = new_value; 235 hids_device_emit_event_with_uint8(HIDS_SUBEVENT_BOOT_MOUSE_INPUT_REPORT_ENABLE, con_handle, (uint8_t) new_value); 236 } 237 if (att_handle == instance->hid_boot_keyboard_input_client_configuration_handle){ 238 uint16_t new_value = little_endian_read_16(buffer, 0); 239 instance->hid_boot_keyboard_input_client_configuration_value = new_value; 240 hids_device_emit_event_with_uint8(HIDS_SUBEVENT_BOOT_KEYBOARD_INPUT_REPORT_ENABLE, con_handle, (uint8_t) new_value); 241 } 242 243 if (att_handle == instance->hid_protocol_mode_value_handle){ 244 instance->hid_protocol_mode = buffer[0]; 245 log_info("Set protocol mode: %u", instance->hid_protocol_mode); 246 hids_device_emit_event_with_uint8(HIDS_SUBEVENT_PROTOCOL_MODE, con_handle, instance->hid_protocol_mode); 247 } 248 249 if (att_handle == instance->hid_control_point_value_handle){ 250 if (buffer_size < 1u){ 251 return ATT_ERROR_INVALID_OFFSET; 252 } 253 instance->hid_control_point_suspend = buffer[0]; 254 instance->con_handle = con_handle; 255 log_info("Set suspend tp: %u", instance->hid_control_point_suspend ); 256 if (instance->hid_control_point_suspend == 0u){ 257 hids_device_emit_event(HIDS_SUBEVENT_SUSPEND, con_handle); 258 } else if (instance->hid_control_point_suspend == 1u){ 259 hids_device_emit_event(HIDS_SUBEVENT_EXIT_SUSPEND, con_handle); 260 } 261 } 262 263 hids_device_report_t * report = hids_device_get_report_for_client_configuration_handle(instance, att_handle); 264 if (report != NULL){ 265 uint16_t new_value = little_endian_read_16(buffer, 0); 266 report->client_configuration_value = new_value; 267 log_info("Enable Report (type %u) notifications: %x", (uint8_t) report->type, new_value); 268 269 switch (report->type){ 270 case HID_REPORT_TYPE_INPUT: 271 hids_device_emit_event_with_uint8(HIDS_SUBEVENT_INPUT_REPORT_ENABLE, con_handle, (uint8_t) new_value); 272 break; 273 case HID_REPORT_TYPE_OUTPUT: 274 hids_device_emit_event_with_uint8(HIDS_SUBEVENT_OUTPUT_REPORT_ENABLE, con_handle, (uint8_t) new_value); 275 break; 276 case HID_REPORT_TYPE_FEATURE: 277 hids_device_emit_event_with_uint8(HIDS_SUBEVENT_FEATURE_REPORT_ENABLE, con_handle, (uint8_t) new_value); 278 break; 279 default: 280 btstack_unreachable(); 281 break; 282 } 283 } 284 return 0; 285 } 286 287 void hids_device_init_with_storage(uint8_t hid_country_code, const uint8_t * hid_descriptor, uint16_t hid_descriptor_size, 288 uint16_t num_reports, hids_device_report_t * report_storage){ 289 290 hids_device_t * instance = hids_device_create_instance(); 291 292 btstack_assert(num_reports > 0); 293 btstack_assert(report_storage != NULL); 294 295 instance->hid_country_code = hid_country_code; 296 instance->hid_descriptor = hid_descriptor; 297 instance->hid_descriptor_size = hid_descriptor_size; 298 299 // default 300 instance->hid_protocol_mode = 1; 301 302 // get service handle range 303 uint16_t start_handle = 0; 304 uint16_t end_handle = 0xffff; 305 int service_found = gatt_server_get_handle_range_for_service_with_uuid16(ORG_BLUETOOTH_SERVICE_HUMAN_INTERFACE_DEVICE, &start_handle, &end_handle); 306 btstack_assert(service_found != 0); 307 UNUSED(service_found); 308 309 // get report map handle 310 instance->hid_report_map_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_REPORT_MAP); 311 312 // get report map handle 313 instance->hid_protocol_mode_value_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_PROTOCOL_MODE); 314 315 // get value and client configuration handles for boot mouse input, boot keyboard input and report input 316 instance->hid_boot_mouse_input_value_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_BOOT_MOUSE_INPUT_REPORT); 317 instance->hid_boot_mouse_input_client_configuration_handle = gatt_server_get_client_configuration_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_BOOT_MOUSE_INPUT_REPORT); 318 319 instance->hid_boot_keyboard_input_value_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_BOOT_KEYBOARD_INPUT_REPORT); 320 instance->hid_boot_keyboard_input_client_configuration_handle = gatt_server_get_client_configuration_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_BOOT_KEYBOARD_INPUT_REPORT); 321 322 instance->hid_control_point_value_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_HID_CONTROL_POINT); 323 324 log_info("hid_report_map_handle 0x%02x", instance->hid_report_map_handle); 325 log_info("hid_protocol_mode_value_handle 0x%02x", instance->hid_protocol_mode_value_handle); 326 log_info("hid_boot_mouse_input_value_handle 0x%02x", instance->hid_boot_mouse_input_value_handle); 327 log_info("hid_boot_mouse_input_client_configuration_handle 0x%02x", instance->hid_boot_mouse_input_client_configuration_handle); 328 log_info("hid_boot_keyboard_input_value_handle 0x%02x", instance->hid_boot_keyboard_input_value_handle); 329 log_info("hid_boot_keyboard_input_client_configuration_handle 0x%02x", instance->hid_boot_keyboard_input_client_configuration_handle); 330 log_info("hid_control_point_value_handle 0x%02x", instance->hid_control_point_value_handle); 331 332 instance->hid_reports = report_storage; 333 334 uint16_t hid_reports_num = num_reports; 335 uint16_t assigned_reports_num = 0; 336 uint16_t start_chr_handle = start_handle; 337 338 while ( (start_chr_handle < end_handle) && (assigned_reports_num < hid_reports_num)) { 339 uint16_t chr_value_handle = gatt_server_get_value_handle_for_characteristic_with_uuid16(start_chr_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_REPORT); 340 if (chr_value_handle == 0){ 341 break; 342 } 343 344 uint16_t chr_client_configuration_handle = gatt_server_get_client_configuration_handle_for_characteristic_with_uuid16(start_chr_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_REPORT); 345 uint16_t report_reference_handle = gatt_server_get_descriptor_handle_for_characteristic_with_uuid16(start_chr_handle, end_handle, ORG_BLUETOOTH_CHARACTERISTIC_REPORT, ORG_BLUETOOTH_DESCRIPTOR_REPORT_REFERENCE); 346 uint16_t report_reference_value_len; 347 const uint8_t * report_reference_value = gatt_server_get_const_value_for_handle(report_reference_handle, &report_reference_value_len); 348 349 if (report_reference_value == NULL){ 350 break; 351 } 352 if (report_reference_value_len != 2){ 353 break; 354 } 355 356 hids_device_report_t * report = &report_storage[assigned_reports_num]; 357 report->value_handle = chr_value_handle; 358 report->client_configuration_handle = chr_client_configuration_handle; 359 report->client_configuration_value = 0; 360 361 report->id = report_reference_value[0]; 362 report->type = (hid_report_type_t)report_reference_value[1]; 363 364 switch (report->type){ 365 case HID_REPORT_TYPE_INPUT: 366 instance->hid_input_reports_num++; 367 break; 368 case HID_REPORT_TYPE_OUTPUT: 369 instance->hid_output_reports_num++; 370 break; 371 case HID_REPORT_TYPE_FEATURE: 372 instance->hid_feature_reports_num++; 373 break; 374 default: 375 btstack_unreachable(); 376 return; 377 } 378 log_info("hid_report_value_handle 0x%02x, id %u, type %u", report->value_handle, report->id, (uint8_t)report->type); 379 log_info("hid_report_client_configuration_handle 0x%02x", report->client_configuration_handle); 380 381 assigned_reports_num++; 382 start_chr_handle = chr_client_configuration_handle + 1; 383 } 384 385 // register service with ATT Server 386 hid_service.start_handle = start_handle; 387 hid_service.end_handle = end_handle; 388 hid_service.read_callback = &att_read_callback; 389 hid_service.write_callback = &att_write_callback; 390 att_server_register_service_handler(&hid_service); 391 } 392 393 /** 394 * @brief Set up HIDS Device 395 */ 396 void hids_device_init(uint8_t country_code, const uint8_t * descriptor, uint16_t descriptor_size){ 397 uint16_t hid_reports_num = sizeof(hid_reports_generic_storage) / sizeof(hids_device_report_t); 398 hids_device_init_with_storage(country_code, descriptor, descriptor_size, hid_reports_num, hid_reports_generic_storage); 399 } 400 401 /** 402 * @brief Register callback for the HIDS Device client. 403 * @param callback 404 */ 405 void hids_device_register_packet_handler(btstack_packet_handler_t callback){ 406 packet_handler = callback; 407 } 408 409 /** 410 * @brief Request can send now event to send HID Report 411 * Generates an HIDS_SUBEVENT_CAN_SEND_NOW subevent 412 * @param hid_cid 413 */ 414 void hids_device_request_can_send_now_event(hci_con_handle_t con_handle){ 415 hids_device_t * instance = hids_device_get_instance_for_con_handle(con_handle); 416 if (!instance){ 417 log_error("no instance for handle 0x%02x", con_handle); 418 return; 419 } 420 421 instance->battery_callback.callback = &hids_device_can_send_now; 422 instance->battery_callback.context = (void*) (uintptr_t) con_handle; 423 att_server_register_can_send_now_callback(&instance->battery_callback, con_handle); 424 } 425 426 uint8_t hids_device_send_input_report_for_id(hci_con_handle_t con_handle, uint16_t report_id, const uint8_t * report, uint16_t report_len){ 427 hids_device_t * instance = hids_device_get_instance_for_con_handle(con_handle); 428 if (!instance){ 429 log_error("no instance for handle 0x%02x", con_handle); 430 return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER; 431 } 432 433 hids_device_report_t * report_storage = hids_device_get_report_for_id_and_type(instance, report_id, 434 HID_REPORT_TYPE_INPUT); 435 if (report_storage == NULL){ 436 return ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE; 437 } 438 439 return att_server_notify(con_handle, report_storage->value_handle, report, report_len); 440 } 441 442 uint8_t hids_device_send_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len){ 443 hids_device_t * device = hids_device_get_instance_for_con_handle(con_handle); 444 if (!device){ 445 log_error("no instance for handle 0x%02x", con_handle); 446 return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER; 447 } 448 449 uint8_t pos; 450 uint8_t total_reports = device->hid_input_reports_num + device->hid_output_reports_num + device->hid_feature_reports_num; 451 for (pos = 0 ; pos < total_reports ; pos++){ 452 hids_device_report_t * report_storage = &device->hid_reports[pos]; 453 if (report_storage->type == HID_REPORT_TYPE_INPUT){ 454 return att_server_notify(con_handle, report_storage->value_handle, report, report_len); 455 } 456 } 457 return ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE; 458 } 459 460 /** 461 * @brief Send HID Boot Mouse Input Report 462 */ 463 uint8_t hids_device_send_boot_mouse_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len){ 464 hids_device_t * instance = hids_device_get_instance_for_con_handle(con_handle); 465 if (!instance){ 466 log_error("no instance for handle 0x%02x", con_handle); 467 return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER; 468 } 469 return att_server_notify(con_handle, instance->hid_boot_mouse_input_value_handle, report, report_len); 470 } 471 472 /** 473 * @brief Send HID Boot Mouse Input Report 474 */ 475 uint8_t hids_device_send_boot_keyboard_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len){ 476 hids_device_t * instance = hids_device_get_instance_for_con_handle(con_handle); 477 if (!instance){ 478 log_error("no instance for handle 0x%02x", con_handle); 479 return ERROR_CODE_UNKNOWN_CONNECTION_IDENTIFIER; 480 } 481 return att_server_notify(con_handle, instance->hid_boot_keyboard_input_value_handle, report, report_len); 482 } 483