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 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 #define BTSTACK_FILE__ "hid_device.c" 39 40 #include <string.h> 41 42 #include "bluetooth.h" 43 #include "bluetooth_psm.h" 44 #include "bluetooth_sdp.h" 45 #include "btstack_debug.h" 46 #include "btstack_event.h" 47 #include "btstack_hid_parser.h" 48 #include "classic/hid_device.h" 49 #include "classic/sdp_util.h" 50 #include "l2cap.h" 51 52 typedef enum { 53 HID_DEVICE_IDLE, 54 HID_DEVICE_CONNECTED, 55 HID_DEVICE_W2_GET_REPORT, 56 HID_DEVICE_W2_SET_REPORT, 57 HID_DEVICE_W2_GET_PROTOCOL, 58 HID_DEVICE_W2_SET_PROTOCOL, 59 HID_DEVICE_W2_ANSWER_SET_PROTOCOL, 60 HID_DEVICE_W2_SEND_UNSUPPORTED_REQUEST, 61 } hid_device_state_t; 62 63 // hid device state 64 typedef struct hid_device { 65 uint16_t cid; 66 bd_addr_t bd_addr; 67 hci_con_handle_t con_handle; 68 uint16_t control_cid; 69 uint16_t interrupt_cid; 70 uint8_t incoming; 71 uint8_t connected; 72 hid_device_state_t state; 73 hid_report_type_t report_type; 74 uint16_t report_id; 75 uint16_t expected_report_size; 76 uint16_t report_size; 77 uint8_t user_request_can_send_now; 78 79 hid_handshake_param_type_t report_status; 80 hid_protocol_mode_t protocol_mode; 81 } hid_device_t; 82 83 static hid_device_t _hid_device; 84 static uint8_t hid_boot_protocol_mode_supported; 85 static const uint8_t * hid_descriptor; 86 static uint16_t hid_descriptor_len; 87 88 static int dummy_write_report(uint16_t hid_cid, hid_report_type_t report_type, uint16_t report_id, int * out_report_size, uint8_t * out_report){ 89 UNUSED(hid_cid); 90 UNUSED(report_type); 91 UNUSED(report_id); 92 UNUSED(out_report_size); 93 UNUSED(out_report); 94 return -1; 95 } 96 97 static void dummy_set_report(uint16_t hid_cid, hid_report_type_t report_type, int report_size, uint8_t * report){ 98 UNUSED(hid_cid); 99 UNUSED(report_type); 100 UNUSED(report_size); 101 UNUSED(report); 102 } 103 104 static void dummy_report_data(uint16_t hid_cid, hid_report_type_t report_type, uint16_t report_id, int report_size, uint8_t * report){ 105 UNUSED(hid_cid); 106 UNUSED(report_type); 107 UNUSED(report_id); 108 UNUSED(report_size); 109 UNUSED(report); 110 } 111 112 static int (*hci_device_get_report) (uint16_t hid_cid, hid_report_type_t report_type, uint16_t report_id, int * out_report_size, uint8_t * out_report) = dummy_write_report; 113 static void (*hci_device_set_report) (uint16_t hid_cid, hid_report_type_t report_type, int report_size, uint8_t * report) = dummy_set_report; 114 static void (*hci_device_report_data) (uint16_t hid_cid, hid_report_type_t report_type, uint16_t report_id, int report_size, uint8_t * report) = dummy_report_data; 115 116 static btstack_packet_handler_t hid_callback; 117 118 static uint16_t hid_device_cid = 0; 119 120 static uint16_t hid_device_get_next_cid(void){ 121 hid_device_cid++; 122 if (!hid_device_cid){ 123 hid_device_cid = 1; 124 } 125 return hid_device_cid; 126 } 127 128 // TODO: store hid device connection into list 129 static hid_device_t * hid_device_get_instance_for_l2cap_cid(uint16_t cid){ 130 if ((_hid_device.control_cid == cid) || (_hid_device.interrupt_cid == cid)){ 131 return &_hid_device; 132 } 133 return NULL; 134 } 135 136 static hid_device_t * hid_device_get_instance_for_hid_cid(uint16_t hid_cid){ 137 if (_hid_device.cid == hid_cid){ 138 return &_hid_device; 139 } 140 return NULL; 141 } 142 143 static hid_device_t * hid_device_provide_instance_for_bd_addr(bd_addr_t bd_addr){ 144 if (!_hid_device.cid){ 145 (void)memcpy(_hid_device.bd_addr, bd_addr, 6); 146 _hid_device.cid = hid_device_get_next_cid(); 147 _hid_device.protocol_mode = HID_PROTOCOL_MODE_REPORT; 148 _hid_device.con_handle = HCI_CON_HANDLE_INVALID; 149 } 150 return &_hid_device; 151 } 152 153 static hid_device_t * hid_device_create_instance(void){ 154 155 return &_hid_device; 156 } 157 158 void hid_create_sdp_record( 159 uint8_t *service, 160 uint32_t service_record_handle, 161 uint16_t hid_device_subclass, 162 uint8_t hid_country_code, 163 uint8_t hid_virtual_cable, 164 uint8_t hid_reconnect_initiate, 165 uint8_t hid_boot_device, 166 const uint8_t * descriptor, uint16_t descriptor_size, 167 const char *device_name){ 168 169 uint8_t * attribute; 170 de_create_sequence(service); 171 172 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_SERVICE_RECORD_HANDLE); 173 de_add_number(service, DE_UINT, DE_SIZE_32, service_record_handle); 174 175 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_SERVICE_CLASS_ID_LIST); 176 attribute = de_push_sequence(service); 177 { 178 de_add_number(attribute, DE_UUID, DE_SIZE_16, BLUETOOTH_SERVICE_CLASS_HUMAN_INTERFACE_DEVICE_SERVICE); 179 } 180 de_pop_sequence(service, attribute); 181 182 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_PROTOCOL_DESCRIPTOR_LIST); 183 attribute = de_push_sequence(service); 184 { 185 uint8_t * l2cpProtocol = de_push_sequence(attribute); 186 { 187 de_add_number(l2cpProtocol, DE_UUID, DE_SIZE_16, BLUETOOTH_PROTOCOL_L2CAP); 188 de_add_number(l2cpProtocol, DE_UINT, DE_SIZE_16, BLUETOOTH_PSM_HID_CONTROL); 189 } 190 de_pop_sequence(attribute, l2cpProtocol); 191 192 uint8_t * hidProtocol = de_push_sequence(attribute); 193 { 194 de_add_number(hidProtocol, DE_UUID, DE_SIZE_16, BLUETOOTH_PROTOCOL_HIDP); 195 } 196 de_pop_sequence(attribute, hidProtocol); 197 } 198 de_pop_sequence(service, attribute); 199 200 // TODO? 201 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_LANGUAGE_BASE_ATTRIBUTE_ID_LIST); 202 attribute = de_push_sequence(service); 203 { 204 de_add_number(attribute, DE_UINT, DE_SIZE_16, 0x656e); 205 de_add_number(attribute, DE_UINT, DE_SIZE_16, 0x006a); 206 de_add_number(attribute, DE_UINT, DE_SIZE_16, 0x0100); 207 } 208 de_pop_sequence(service, attribute); 209 210 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_ADDITIONAL_PROTOCOL_DESCRIPTOR_LISTS); 211 attribute = de_push_sequence(service); 212 { 213 uint8_t * additionalDescriptorAttribute = de_push_sequence(attribute); 214 { 215 uint8_t * l2cpProtocol = de_push_sequence(additionalDescriptorAttribute); 216 { 217 de_add_number(l2cpProtocol, DE_UUID, DE_SIZE_16, BLUETOOTH_PROTOCOL_L2CAP); 218 de_add_number(l2cpProtocol, DE_UINT, DE_SIZE_16, BLUETOOTH_PSM_HID_INTERRUPT); 219 } 220 de_pop_sequence(additionalDescriptorAttribute, l2cpProtocol); 221 222 uint8_t * hidProtocol = de_push_sequence(additionalDescriptorAttribute); 223 { 224 de_add_number(hidProtocol, DE_UUID, DE_SIZE_16, BLUETOOTH_PROTOCOL_HIDP); 225 } 226 de_pop_sequence(additionalDescriptorAttribute, hidProtocol); 227 } 228 de_pop_sequence(attribute, additionalDescriptorAttribute); 229 } 230 de_pop_sequence(service, attribute); 231 232 // 0x0100 "ServiceName" 233 de_add_number(service, DE_UINT, DE_SIZE_16, 0x0100); 234 de_add_data(service, DE_STRING, strlen(device_name), (uint8_t *) device_name); 235 236 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_BLUETOOTH_PROFILE_DESCRIPTOR_LIST); 237 attribute = de_push_sequence(service); 238 { 239 uint8_t * hidProfile = de_push_sequence(attribute); 240 { 241 de_add_number(hidProfile, DE_UUID, DE_SIZE_16, BLUETOOTH_SERVICE_CLASS_HUMAN_INTERFACE_DEVICE_SERVICE); 242 de_add_number(hidProfile, DE_UINT, DE_SIZE_16, 0x0101); // Version 1.1 243 } 244 de_pop_sequence(attribute, hidProfile); 245 } 246 de_pop_sequence(service, attribute); 247 248 // Deprecated in v1.1.1 249 // de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_DEVICE_RELEASE_NUMBER); 250 // de_add_number(service, DE_UINT, DE_SIZE_16, 0x0101); 251 252 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_PARSER_VERSION); 253 de_add_number(service, DE_UINT, DE_SIZE_16, 0x0111); // v1.1.1 254 255 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_DEVICE_SUBCLASS); 256 de_add_number(service, DE_UINT, DE_SIZE_8, hid_device_subclass); 257 258 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_COUNTRY_CODE); 259 de_add_number(service, DE_UINT, DE_SIZE_8, hid_country_code); 260 261 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_VIRTUAL_CABLE); 262 de_add_number(service, DE_BOOL, DE_SIZE_8, hid_virtual_cable); 263 264 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_RECONNECT_INITIATE); 265 de_add_number(service, DE_BOOL, DE_SIZE_8, hid_reconnect_initiate); 266 267 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_DESCRIPTOR_LIST); 268 attribute = de_push_sequence(service); 269 { 270 uint8_t* hidDescriptor = de_push_sequence(attribute); 271 { 272 de_add_number(hidDescriptor, DE_UINT, DE_SIZE_8, 0x22); // Report Descriptor 273 de_add_data(hidDescriptor, DE_STRING, descriptor_size, (uint8_t *) descriptor); 274 } 275 de_pop_sequence(attribute, hidDescriptor); 276 } 277 de_pop_sequence(service, attribute); 278 279 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HIDLANGID_BASE_LIST); 280 attribute = de_push_sequence(service); 281 { 282 uint8_t* hig_lang_base = de_push_sequence(attribute); 283 { 284 // see: http://www.usb.org/developers/docs/USB_LANGIDs.pdf 285 de_add_number(hig_lang_base, DE_UINT, DE_SIZE_16, 0x0409); // HIDLANGID = English (US) 286 de_add_number(hig_lang_base, DE_UINT, DE_SIZE_16, 0x0100); // HIDLanguageBase = 0x0100 default 287 } 288 de_pop_sequence(attribute, hig_lang_base); 289 } 290 de_pop_sequence(service, attribute); 291 292 uint8_t hid_remote_wake = 1; 293 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_REMOTE_WAKE); 294 de_add_number(service, DE_BOOL, DE_SIZE_8, hid_remote_wake); 295 296 de_add_number(service, DE_UINT, DE_SIZE_16, BLUETOOTH_ATTRIBUTE_HID_BOOT_DEVICE); 297 de_add_number(service, DE_BOOL, DE_SIZE_8, hid_boot_device); 298 } 299 300 static inline void hid_device_emit_connected_event(hid_device_t * context, uint8_t status){ 301 uint8_t event[15]; 302 int pos = 0; 303 event[pos++] = HCI_EVENT_HID_META; 304 pos++; // skip len 305 event[pos++] = HID_SUBEVENT_CONNECTION_OPENED; 306 little_endian_store_16(event,pos,context->cid); 307 pos+=2; 308 event[pos++] = status; 309 reverse_bd_addr(context->bd_addr, &event[pos]); 310 pos += 6; 311 little_endian_store_16(event,pos,context->con_handle); 312 pos += 2; 313 event[pos++] = context->incoming; 314 event[1] = pos - 2; 315 if (pos != sizeof(event)) log_error("hid_device_emit_connected_event size %u", pos); 316 hid_callback(HCI_EVENT_PACKET, context->cid, &event[0], pos); 317 } 318 319 static inline void hid_device_emit_connection_closed_event(hid_device_t * context){ 320 uint8_t event[5]; 321 int pos = 0; 322 event[pos++] = HCI_EVENT_HID_META; 323 pos++; // skip len 324 event[pos++] = HID_SUBEVENT_CONNECTION_CLOSED; 325 little_endian_store_16(event,pos,context->cid); 326 pos+=2; 327 event[1] = pos - 2; 328 if (pos != sizeof(event)) log_error("hid_device_emit_connection_closed_event size %u", pos); 329 hid_callback(HCI_EVENT_PACKET, context->cid, &event[0], pos); 330 } 331 332 static inline void hid_device_emit_can_send_now_event(hid_device_t * context){ 333 uint8_t event[5]; 334 int pos = 0; 335 event[pos++] = HCI_EVENT_HID_META; 336 pos++; // skip len 337 event[pos++] = HID_SUBEVENT_CAN_SEND_NOW; 338 little_endian_store_16(event,pos,context->cid); 339 pos+=2; 340 event[1] = pos - 2; 341 if (pos != sizeof(event)) log_error("hid_device_emit_can_send_now_event size %u", pos); 342 hid_callback(HCI_EVENT_PACKET, context->cid, &event[0], pos); 343 } 344 345 static inline void hid_device_emit_event(hid_device_t * context, uint8_t subevent_type){ 346 uint8_t event[4]; 347 int pos = 0; 348 event[pos++] = HCI_EVENT_HID_META; 349 pos++; // skip len 350 event[pos++] = subevent_type; 351 little_endian_store_16(event,pos,context->cid); 352 pos+=2; 353 event[1] = pos - 2; 354 if (pos != sizeof(event)) log_error("hid_device_emit_event size %u", pos); 355 hid_callback(HCI_EVENT_PACKET, context->cid, &event[0], pos); 356 } 357 358 static int hid_report_size_valid(uint16_t cid, int report_id, hid_report_type_t report_type, int report_size){ 359 if (!report_size) return 0; 360 if (hid_device_in_boot_protocol_mode(cid)){ 361 switch (report_id){ 362 case HID_BOOT_MODE_KEYBOARD_ID: 363 if (report_size < 8) return 0; 364 break; 365 case HID_BOOT_MODE_MOUSE_ID: 366 if (report_size < 1) return 0; 367 break; 368 default: 369 return 0; 370 } 371 } else { 372 int size = btstack_hid_get_report_size_for_id(report_id, report_type, hid_descriptor_len, hid_descriptor); 373 if ((size == 0) || (size != report_size)) return 0; 374 } 375 return 1; 376 } 377 378 static int hid_get_report_size_for_id(uint16_t cid, int report_id, hid_report_type_t report_type, uint16_t descriptor_len, const uint8_t * descriptor){ 379 if (hid_device_in_boot_protocol_mode(cid)){ 380 switch (report_id){ 381 case HID_BOOT_MODE_KEYBOARD_ID: 382 return 8; 383 case HID_BOOT_MODE_MOUSE_ID: 384 return 3; 385 default: 386 return 0; 387 } 388 } else { 389 return btstack_hid_get_report_size_for_id(report_id, report_type, descriptor_len, descriptor); 390 } 391 } 392 393 static hid_report_id_status_t hid_report_id_status(uint16_t cid, uint16_t report_id){ 394 if (hid_device_in_boot_protocol_mode(cid)){ 395 switch (report_id){ 396 case HID_BOOT_MODE_KEYBOARD_ID: 397 case HID_BOOT_MODE_MOUSE_ID: 398 return HID_REPORT_ID_VALID; 399 default: 400 return HID_REPORT_ID_INVALID; 401 } 402 } else { 403 return btstack_hid_id_valid(report_id, hid_descriptor_len, hid_descriptor); 404 } 405 } 406 407 static hid_handshake_param_type_t hid_device_set_report_cmd_is_valid(uint16_t cid, hid_report_type_t report_type, int report_size, uint8_t * report){ 408 int pos = 0; 409 int report_id = 0; 410 411 if (btstack_hid_report_id_declared(hid_descriptor_len, hid_descriptor)){ 412 report_id = report[pos++]; 413 hid_report_id_status_t report_id_status = hid_report_id_status(cid, report_id); 414 switch (report_id_status){ 415 case HID_REPORT_ID_INVALID: 416 return HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_REPORT_ID; 417 default: 418 break; 419 } 420 } 421 422 if (!hid_report_size_valid(cid, report_id, report_type, report_size-pos)){ 423 // TODO clarify DCT/BI-03c 424 return HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER; 425 } 426 return HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL; 427 } 428 429 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t * packet, uint16_t packet_size){ 430 UNUSED(channel); 431 UNUSED(packet_size); 432 int connected_before; 433 uint16_t psm; 434 uint8_t status; 435 hid_device_t * device = NULL; 436 uint8_t param; 437 bd_addr_t address; 438 uint16_t local_cid; 439 int pos = 0; 440 int report_size; 441 uint8_t report[48]; 442 hid_message_type_t message_type; 443 444 switch (packet_type){ 445 case L2CAP_DATA_PACKET: 446 device = hid_device_get_instance_for_l2cap_cid(channel); 447 if (!device) { 448 log_error("no device with cid 0x%02x", channel); 449 return; 450 } 451 message_type = (hid_message_type_t)(packet[0] >> 4); 452 switch (message_type){ 453 case HID_MESSAGE_TYPE_GET_REPORT: 454 455 pos = 0; 456 device->report_type = (hid_report_type_t)(packet[pos++] & 0x03); 457 device->report_id = 0; 458 device->report_status = HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL; 459 device->state = HID_DEVICE_W2_GET_REPORT; 460 461 switch (device->protocol_mode){ 462 case HID_PROTOCOL_MODE_BOOT: 463 if (packet_size < 2){ 464 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER; 465 break; 466 } 467 device->report_id = packet[pos++]; 468 break; 469 case HID_PROTOCOL_MODE_REPORT: 470 if (!btstack_hid_report_id_declared(hid_descriptor_len, hid_descriptor)) { 471 if (packet_size < 2) break; 472 if (packet[0] & 0x08){ 473 if (packet_size > 2) { 474 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_REPORT_ID; 475 } 476 } else { 477 if (packet_size > 1) { 478 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_REPORT_ID; 479 } 480 } 481 break; 482 } 483 if (packet_size < 2){ 484 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER; 485 break; 486 } 487 device->report_id = packet[pos++]; 488 break; 489 default: 490 btstack_assert(false); 491 break; 492 } 493 if (device->report_status != HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL){ 494 l2cap_request_can_send_now_event(device->control_cid); 495 break; 496 } 497 switch (hid_report_id_status(device->cid, device->report_id)){ 498 case HID_REPORT_ID_INVALID: 499 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_REPORT_ID; 500 break; 501 default: 502 break; 503 } 504 505 device->expected_report_size = hid_get_report_size_for_id(device->cid, device->report_id, device->report_type, hid_descriptor_len, hid_descriptor); 506 report_size = device->expected_report_size + pos; // add 1 for header size and report id 507 508 if ((packet[0] & 0x08) && (packet_size >= (pos + 1))){ 509 device->report_size = btstack_min(btstack_min(little_endian_read_16(packet, pos), report_size), sizeof(report)); 510 } else { 511 device->report_size = btstack_min(btstack_min(l2cap_max_mtu(), report_size), sizeof(report)); 512 } 513 514 l2cap_request_can_send_now_event(device->control_cid); 515 break; 516 517 case HID_MESSAGE_TYPE_SET_REPORT: 518 device->state = HID_DEVICE_W2_SET_REPORT; 519 device->report_size = l2cap_max_mtu(); 520 device->report_type = (hid_report_type_t)(packet[0] & 0x03); 521 if (packet_size < 1){ 522 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER; 523 break; 524 } 525 526 switch (device->protocol_mode){ 527 case HID_PROTOCOL_MODE_BOOT: 528 if (packet_size < 3){ 529 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER; 530 break; 531 } 532 device->report_id = packet[1]; 533 device->report_status = hid_device_set_report_cmd_is_valid(device->cid, device->report_type, packet_size - 1, &packet[1]); 534 if (device->report_status != HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL) break; 535 (*hci_device_set_report)(device->cid, device->report_type, packet_size-1, &packet[1]); 536 break; 537 case HID_PROTOCOL_MODE_REPORT: 538 device->report_status = hid_device_set_report_cmd_is_valid(device->cid, device->report_type, packet_size - 1, &packet[1]); 539 if (device->report_status != HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL) break; 540 541 if (packet_size >= 2){ 542 (*hci_device_set_report)(device->cid, device->report_type, packet_size-1, &packet[1]); 543 } else { 544 uint8_t payload[] = {0}; 545 (*hci_device_set_report)(device->cid, device->report_type, 1, payload); 546 } 547 break; 548 default: 549 btstack_assert(false); 550 break; 551 } 552 device->report_type = (hid_report_type_t)(packet[0] & 0x03); 553 l2cap_request_can_send_now_event(device->control_cid); 554 break; 555 case HID_MESSAGE_TYPE_GET_PROTOCOL: 556 device->state = HID_DEVICE_W2_GET_PROTOCOL; 557 if (packet_size != 1) { 558 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER; 559 break; 560 } 561 device->report_status = HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL; 562 // hid_device_request_can_send_now_event(channel); 563 l2cap_request_can_send_now_event(device->control_cid); 564 break; 565 566 case HID_MESSAGE_TYPE_SET_PROTOCOL: 567 device->state = HID_DEVICE_W2_SET_PROTOCOL; 568 if (packet_size != 1) { 569 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER; 570 break; 571 } 572 param = packet[0] & 0x01; 573 if ((param == HID_PROTOCOL_MODE_BOOT) && !hid_boot_protocol_mode_supported){ 574 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER; 575 break; 576 } 577 device->protocol_mode = (hid_protocol_mode_t) param; 578 switch (device->protocol_mode){ 579 case HID_PROTOCOL_MODE_BOOT: 580 break; 581 case HID_PROTOCOL_MODE_REPORT: 582 break; 583 default: 584 btstack_assert(false); 585 break; 586 } 587 device->report_status = HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL; 588 l2cap_request_can_send_now_event(device->control_cid); 589 break; 590 591 case HID_MESSAGE_TYPE_HID_CONTROL: 592 param = packet[0] & 0x0F; 593 switch (param){ 594 case HID_CONTROL_PARAM_SUSPEND: 595 hid_device_emit_event(device, HID_SUBEVENT_SUSPEND); 596 break; 597 case HID_CONTROL_PARAM_EXIT_SUSPEND: 598 hid_device_emit_event(device, HID_SUBEVENT_EXIT_SUSPEND); 599 break; 600 default: 601 device->state = HID_DEVICE_W2_SEND_UNSUPPORTED_REQUEST; 602 l2cap_request_can_send_now_event(device->control_cid); 603 break; 604 } 605 break; 606 607 case HID_MESSAGE_TYPE_DATA: 608 if (packet_size < 2) { 609 break; 610 } 611 pos = 0; 612 device->report_type = (hid_report_type_t)(packet[pos++] & 0x03); 613 device->report_id = 0; 614 if (btstack_hid_report_id_declared(hid_descriptor_len, hid_descriptor)){ 615 device->report_id = packet[pos++]; 616 } 617 618 if (hid_report_id_status(device->cid, device->report_id) == HID_REPORT_ID_INVALID){ 619 log_info("Ignore invalid report data packet"); 620 break; 621 } 622 if (!hid_report_size_valid(device->cid, device->report_id, device->report_type, packet_size - pos)){ 623 log_info("Ignore invalid report data packet, invalid size"); 624 break; 625 } 626 (*hci_device_report_data)(device->cid, device->report_type, device->report_id, packet_size - pos, &packet[pos]); 627 break; 628 default: 629 device->state = HID_DEVICE_W2_SEND_UNSUPPORTED_REQUEST; 630 l2cap_request_can_send_now_event(device->control_cid); 631 break; 632 } 633 break; 634 case HCI_EVENT_PACKET: 635 switch (packet[0]){ 636 case L2CAP_EVENT_INCOMING_CONNECTION: 637 switch (l2cap_event_incoming_connection_get_psm(packet)){ 638 case PSM_HID_CONTROL: 639 case PSM_HID_INTERRUPT: 640 l2cap_event_incoming_connection_get_address(packet, address); 641 device = hid_device_provide_instance_for_bd_addr(address); 642 if (!device) { 643 log_error("L2CAP_EVENT_INCOMING_CONNECTION, cannot create instance for %s", bd_addr_to_str(address)); 644 l2cap_decline_connection(channel); 645 break; 646 } 647 if ((device->con_handle == HCI_CON_HANDLE_INVALID) || (l2cap_event_incoming_connection_get_handle(packet) == device->con_handle)){ 648 device->con_handle = l2cap_event_incoming_connection_get_handle(packet); 649 device->incoming = 1; 650 l2cap_event_incoming_connection_get_address(packet, device->bd_addr); 651 psm = l2cap_event_incoming_connection_get_psm(packet); 652 switch (psm){ 653 case PSM_HID_CONTROL: 654 device->control_cid = l2cap_event_incoming_connection_get_local_cid(packet); 655 break; 656 case PSM_HID_INTERRUPT: 657 device->interrupt_cid = l2cap_event_incoming_connection_get_local_cid(packet); 658 break; 659 default: 660 break; 661 } 662 663 l2cap_accept_connection(channel); 664 } else { 665 l2cap_decline_connection(channel); 666 log_info("L2CAP_EVENT_INCOMING_CONNECTION, decline connection for %s", bd_addr_to_str(address)); 667 } 668 break; 669 default: 670 l2cap_decline_connection(channel); 671 break; 672 } 673 break; 674 case L2CAP_EVENT_CHANNEL_OPENED: 675 device = hid_device_get_instance_for_l2cap_cid(l2cap_event_channel_opened_get_local_cid(packet)); 676 if (!device) { 677 log_error("L2CAP_EVENT_CHANNEL_OPENED, no hid device for local cid 0x%02x", l2cap_event_channel_opened_get_local_cid(packet)); 678 return; 679 } 680 status = l2cap_event_channel_opened_get_status(packet); 681 if (status) { 682 if (device->incoming == 0){ 683 // report error for outgoing connection 684 hid_device_emit_connected_event(device, status); 685 } 686 return; 687 } 688 689 // store con_handle 690 if (device->con_handle == HCI_CON_HANDLE_INVALID){ 691 device->con_handle = l2cap_event_channel_opened_get_handle(packet); 692 } 693 694 // store l2cap cid 695 psm = l2cap_event_channel_opened_get_psm(packet); 696 switch (psm){ 697 case PSM_HID_CONTROL: 698 device->control_cid = l2cap_event_channel_opened_get_local_cid(packet); 699 break; 700 case PSM_HID_INTERRUPT: 701 device->interrupt_cid = l2cap_event_channel_opened_get_local_cid(packet); 702 break; 703 default: 704 break; 705 } 706 707 // connect HID Interrupt for outgoing 708 if ((device->incoming == 0) && (psm == PSM_HID_CONTROL)){ 709 status = l2cap_create_channel(packet_handler, device->bd_addr, PSM_HID_INTERRUPT, 48, &device->interrupt_cid); 710 break; 711 } 712 713 // emit connected if both channels are open 714 connected_before = device->connected; 715 if (!connected_before && device->control_cid && device->interrupt_cid){ 716 device->connected = 1; 717 hid_device_emit_connected_event(device, 0); 718 } 719 break; 720 case L2CAP_EVENT_CHANNEL_CLOSED: 721 device = hid_device_get_instance_for_l2cap_cid(l2cap_event_channel_closed_get_local_cid(packet)); 722 if (!device) return; 723 724 // connected_before = device->connected; 725 device->incoming = 0; 726 if (l2cap_event_channel_closed_get_local_cid(packet) == device->interrupt_cid){ 727 device->interrupt_cid = 0; 728 } 729 if (l2cap_event_channel_closed_get_local_cid(packet) == device->control_cid){ 730 device->control_cid = 0; 731 } 732 if (!device->interrupt_cid && !device->control_cid){ 733 device->connected = 0; 734 device->con_handle = HCI_CON_HANDLE_INVALID; 735 device->cid = 0; 736 hid_device_emit_connection_closed_event(device); 737 } 738 break; 739 740 case L2CAP_EVENT_CAN_SEND_NOW: 741 local_cid = l2cap_event_can_send_now_get_local_cid(packet); 742 device = hid_device_get_instance_for_l2cap_cid(local_cid); 743 744 if (!device) return; 745 switch (device->state){ 746 case HID_DEVICE_W2_GET_REPORT:{ 747 if (device->report_status != HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL) { 748 report[0] = (HID_MESSAGE_TYPE_HANDSHAKE << 4) | device->report_status; 749 hid_device_send_control_message(device->cid, &report[0], 1); 750 break; 751 } 752 753 pos = 0; 754 report[pos++] = (HID_MESSAGE_TYPE_DATA << 4) | device->report_type; 755 if (device->report_id){ 756 report[pos++] = device->report_id; 757 } 758 759 report_size = 0; 760 status = (*hci_device_get_report)(device->cid, device->report_type, device->report_id, &report_size, &report[pos]); 761 762 switch (status){ 763 case 0: 764 device->report_status = HID_HANDSHAKE_PARAM_TYPE_NOT_READY; 765 break; 766 case 1: 767 if (report_size == 0){ 768 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_UNSUPPORTED_REQUEST; 769 break; 770 } 771 if (device->expected_report_size != report_size){ 772 log_error("Expected report size of %d bytes, received %d", device->expected_report_size, report_size); 773 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_UNSUPPORTED_REQUEST; 774 break; 775 } 776 break; 777 default: 778 device->report_status = HID_HANDSHAKE_PARAM_TYPE_ERR_UNSUPPORTED_REQUEST; 779 break; 780 } 781 if (device->report_status != HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL){ 782 report[0] = (HID_MESSAGE_TYPE_HANDSHAKE << 4) | device->report_status; 783 hid_device_send_control_message(device->cid, &report[0], 1); 784 break; 785 } 786 787 // if (report_size > l2cap_max_mtu()){ 788 // report[0] = (HID_MESSAGE_TYPE_HANDSHAKE << 4) | HID_HANDSHAKE_PARAM_TYPE_ERR_INVALID_PARAMETER; 789 // hid_device_send_control_message(device->cid, &report[0], 1); 790 // break; 791 // } 792 793 hid_device_send_control_message(device->cid, &report[0], device->report_size); 794 // device->state = HID_DEVICE_IDLE; 795 break; 796 } 797 case HID_DEVICE_W2_SET_REPORT: 798 case HID_DEVICE_W2_SET_PROTOCOL: 799 report[0] = (HID_MESSAGE_TYPE_HANDSHAKE << 4) | device->report_status; 800 hid_device_send_control_message(device->cid, &report[0], 1); 801 break; 802 case HID_DEVICE_W2_GET_PROTOCOL: 803 if (device->report_status != HID_HANDSHAKE_PARAM_TYPE_SUCCESSFUL){ 804 report[0] = (HID_MESSAGE_TYPE_HANDSHAKE << 4) | device->report_status; 805 hid_device_send_control_message(device->cid, &report[0], 1); 806 break; 807 } 808 809 report[0] = (HID_MESSAGE_TYPE_DATA << 4); 810 report[1] = device->protocol_mode; 811 hid_device_send_control_message(device->cid, &report[0], 2); 812 break; 813 814 815 case HID_DEVICE_W2_SEND_UNSUPPORTED_REQUEST: 816 report[0] = (HID_MESSAGE_TYPE_HANDSHAKE << 4) | HID_HANDSHAKE_PARAM_TYPE_ERR_UNSUPPORTED_REQUEST; 817 hid_device_send_control_message(device->cid, &report[0], 1); 818 break; 819 default: 820 if (device->user_request_can_send_now){ 821 device->user_request_can_send_now = 0; 822 hid_device_emit_can_send_now_event(device); 823 } 824 break; 825 } 826 device->state = HID_DEVICE_IDLE; 827 break; 828 default: 829 break; 830 } 831 break; 832 default: 833 break; 834 } 835 } 836 837 /** 838 * @brief Set up HID Device 839 */ 840 void hid_device_init(uint8_t boot_protocol_mode_supported, uint16_t descriptor_len, const uint8_t * descriptor){ 841 hid_boot_protocol_mode_supported = boot_protocol_mode_supported; 842 hid_descriptor = descriptor; 843 hid_descriptor_len = descriptor_len; 844 hci_device_get_report = dummy_write_report; 845 hci_device_set_report = dummy_set_report; 846 hci_device_report_data = dummy_report_data; 847 848 l2cap_register_service(packet_handler, PSM_HID_INTERRUPT, 100, gap_get_security_level()); 849 l2cap_register_service(packet_handler, PSM_HID_CONTROL, 100, gap_get_security_level()); 850 } 851 852 /** 853 * @brief Register callback for the HID Device client. 854 * @param callback 855 */ 856 void hid_device_register_packet_handler(btstack_packet_handler_t callback){ 857 hid_callback = callback; 858 } 859 860 861 862 void hid_device_register_report_request_callback(int (*callback)(uint16_t hid_cid, hid_report_type_t report_type, uint16_t report_id, int * out_report_size, uint8_t * out_report)){ 863 if (callback == NULL){ 864 callback = dummy_write_report; 865 } 866 hci_device_get_report = callback; 867 } 868 869 void hid_device_register_set_report_callback(void (*callback)(uint16_t hid_cid, hid_report_type_t report_type, int report_size, uint8_t * report)){ 870 if (callback == NULL){ 871 callback = dummy_set_report; 872 } 873 hci_device_set_report = callback; 874 } 875 876 void hid_device_register_report_data_callback(void (*callback)(uint16_t cid, hid_report_type_t report_type, uint16_t report_id, int report_size, uint8_t * report)){ 877 if (callback == NULL){ 878 callback = dummy_report_data; 879 } 880 hci_device_report_data = callback; 881 } 882 883 884 /** 885 * @brief Request can send now event to send HID Report 886 * @param hid_cid 887 */ 888 void hid_device_request_can_send_now_event(uint16_t hid_cid){ 889 hid_device_t * hid_device = hid_device_get_instance_for_hid_cid(hid_cid); 890 if (!hid_device || !hid_device->interrupt_cid) return; 891 hid_device->user_request_can_send_now = 1; 892 l2cap_request_can_send_now_event(hid_device->interrupt_cid); 893 } 894 895 /** 896 * @brief Send HID messageon interrupt channel 897 * @param hid_cid 898 */ 899 void hid_device_send_interrupt_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len){ 900 hid_device_t * hid_device = hid_device_get_instance_for_hid_cid(hid_cid); 901 if (!hid_device || !hid_device->interrupt_cid) return; 902 l2cap_send(hid_device->interrupt_cid, (uint8_t*) message, message_len); 903 // request user can send now if pending 904 if (hid_device->interrupt_cid){ 905 l2cap_request_can_send_now_event((hid_device->interrupt_cid)); 906 } 907 } 908 909 /** 910 * @brief Send HID messageon control channel 911 * @param hid_cid 912 */ 913 void hid_device_send_control_message(uint16_t hid_cid, const uint8_t * message, uint16_t message_len){ 914 hid_device_t * hid_device = hid_device_get_instance_for_hid_cid(hid_cid); 915 if (!hid_device || !hid_device->control_cid) return; 916 l2cap_send(hid_device->control_cid, (uint8_t*) message, message_len); 917 // request user can send now if pending 918 if (hid_device->user_request_can_send_now){ 919 l2cap_request_can_send_now_event((hid_device->control_cid)); 920 } 921 } 922 923 /* 924 * @brief Create HID connection to HID Host 925 * @param addr 926 * @param hid_cid to use for other commands 927 * @result status 928 */ 929 uint8_t hid_device_connect(bd_addr_t addr, uint16_t * hid_cid){ 930 hid_device_t * hid_device = hid_device_create_instance(); 931 if (!hid_device){ 932 log_error("hid_device_connect: could not create a hid device instace"); 933 return BTSTACK_MEMORY_ALLOC_FAILED; 934 } 935 // assign hic_cid 936 *hid_cid = hid_device_get_next_cid(); 937 938 // store address 939 (void)memcpy(hid_device->bd_addr, addr, 6); 940 941 // reset state 942 hid_device->cid = *hid_cid; 943 hid_device->incoming = 0; 944 hid_device->connected = 0; 945 hid_device->control_cid = 0; 946 hid_device->interrupt_cid = 0; 947 hid_device->con_handle = HCI_CON_HANDLE_INVALID; 948 949 // create l2cap control using fixed HID L2CAP PSM 950 log_info("Create outgoing HID Control"); 951 uint8_t status = l2cap_create_channel(packet_handler, hid_device->bd_addr, PSM_HID_CONTROL, 48, &hid_device->control_cid); 952 return status; 953 } 954 955 /* 956 * @brief Disconnect from HID Host 957 * @param hid_cid 958 * @result status 959 */ 960 void hid_device_disconnect_interrupt_channel(uint16_t hid_cid){ 961 hid_device_t * hid_device = hid_device_get_instance_for_hid_cid(hid_cid); 962 if (!hid_device){ 963 log_error("hid_device_disconnect_interrupt_channel: could not find hid device instace"); 964 return; 965 } 966 log_info("Disconnect from interrupt channel HID Host"); 967 if (hid_device->interrupt_cid){ 968 l2cap_disconnect(hid_device->interrupt_cid, 0); // reason isn't used 969 } 970 } 971 972 void hid_device_disconnect_control_channel(uint16_t hid_cid){ 973 hid_device_t * hid_device = hid_device_get_instance_for_hid_cid(hid_cid); 974 if (!hid_device){ 975 log_error("hid_device_disconnect_control_channel: could not find hid device instace"); 976 return; 977 } 978 log_info("Disconnect from control channel HID Host"); 979 if (hid_device->control_cid){ 980 l2cap_disconnect(hid_device->control_cid, 0); // reason isn't used 981 } 982 } 983 984 void hid_device_disconnect(uint16_t hid_cid){ 985 hid_device_t * hid_device = hid_device_get_instance_for_hid_cid(hid_cid); 986 if (!hid_device){ 987 log_error("hid_device_disconnect: could not find hid device instace"); 988 return; 989 } 990 log_info("Disconnect from HID Host"); 991 if (hid_device->interrupt_cid){ 992 l2cap_disconnect(hid_device->interrupt_cid, 0); // reason isn't used 993 } 994 if (hid_device->control_cid){ 995 l2cap_disconnect(hid_device->control_cid, 0); // reason isn't used 996 } 997 } 998 999 int hid_device_in_boot_protocol_mode(uint16_t hid_cid){ 1000 hid_device_t * hid_device = hid_device_get_instance_for_hid_cid(hid_cid); 1001 if (!hid_device){ 1002 log_error("hid_device_in_boot_protocol_mode: could not find hid device instace"); 1003 return 0; 1004 } 1005 return hid_device->protocol_mode == HID_PROTOCOL_MODE_BOOT; 1006 } 1007