1 /* 2 * Copyright (C) 2017 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_host_demo.c" 39 40 /* 41 * hid_host_demo.c 42 */ 43 44 /* EXAMPLE_START(hid_host_demo): HID Host Demo 45 * 46 * @text This example implements an HID Host. For now, it connnects to a fixed device, queries the HID SDP 47 * record and opens the HID Control + Interrupt channels 48 */ 49 50 #include <inttypes.h> 51 #include <stdio.h> 52 53 #include "btstack_config.h" 54 #include "btstack.h" 55 56 #define MAX_ATTRIBUTE_VALUE_SIZE 300 57 58 // SDP 59 static uint8_t hid_descriptor[MAX_ATTRIBUTE_VALUE_SIZE]; 60 static uint16_t hid_descriptor_len; 61 62 static uint16_t hid_control_psm; 63 static uint16_t hid_interrupt_psm; 64 65 static uint8_t attribute_value[MAX_ATTRIBUTE_VALUE_SIZE]; 66 static const unsigned int attribute_value_buffer_size = MAX_ATTRIBUTE_VALUE_SIZE; 67 68 // L2CAP 69 static uint16_t l2cap_hid_control_cid; 70 static uint16_t l2cap_hid_interrupt_cid; 71 72 // MBP 2016 73 static const char * remote_addr_string = "F4-0F-24-3B-1B-E1"; 74 // iMpulse static const char * remote_addr_string = "64:6E:6C:C1:AA:B5"; 75 76 static bd_addr_t remote_addr; 77 78 static btstack_packet_callback_registration_t hci_event_callback_registration; 79 80 // Simplified US Keyboard with Shift modifier 81 82 #define CHAR_ILLEGAL 0xff 83 #define CHAR_RETURN '\n' 84 #define CHAR_ESCAPE 27 85 #define CHAR_TAB '\t' 86 #define CHAR_BACKSPACE 0x7f 87 88 /** 89 * English (US) 90 */ 91 static const uint8_t keytable_us_none [] = { 92 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 0-3 */ 93 'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j', /* 4-13 */ 94 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't', /* 14-23 */ 95 'u', 'v', 'w', 'x', 'y', 'z', /* 24-29 */ 96 '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', /* 30-39 */ 97 CHAR_RETURN, CHAR_ESCAPE, CHAR_BACKSPACE, CHAR_TAB, ' ', /* 40-44 */ 98 '-', '=', '[', ']', '\\', CHAR_ILLEGAL, ';', '\'', 0x60, ',', /* 45-54 */ 99 '.', '/', CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 55-60 */ 100 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 61-64 */ 101 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 65-68 */ 102 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 69-72 */ 103 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 73-76 */ 104 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 77-80 */ 105 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 81-84 */ 106 '*', '-', '+', '\n', '1', '2', '3', '4', '5', /* 85-97 */ 107 '6', '7', '8', '9', '0', '.', 0xa7, /* 97-100 */ 108 }; 109 110 static const uint8_t keytable_us_shift[] = { 111 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 0-3 */ 112 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', /* 4-13 */ 113 'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', /* 14-23 */ 114 'U', 'V', 'W', 'X', 'Y', 'Z', /* 24-29 */ 115 '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', /* 30-39 */ 116 CHAR_RETURN, CHAR_ESCAPE, CHAR_BACKSPACE, CHAR_TAB, ' ', /* 40-44 */ 117 '_', '+', '{', '}', '|', CHAR_ILLEGAL, ':', '"', 0x7E, '<', /* 45-54 */ 118 '>', '?', CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 55-60 */ 119 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 61-64 */ 120 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 65-68 */ 121 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 69-72 */ 122 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 73-76 */ 123 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 77-80 */ 124 CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, CHAR_ILLEGAL, /* 81-84 */ 125 '*', '-', '+', '\n', '1', '2', '3', '4', '5', /* 85-97 */ 126 '6', '7', '8', '9', '0', '.', 0xb1, /* 97-100 */ 127 }; 128 129 130 /* @section Main application configuration 131 * 132 * @text In the application configuration, L2CAP is initialized 133 */ 134 135 /* LISTING_START(PanuSetup): Panu setup */ 136 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 137 static void handle_sdp_client_query_result(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 138 139 static void hid_host_setup(void){ 140 141 // Initialize L2CAP 142 l2cap_init(); 143 144 // register for HCI events 145 hci_event_callback_registration.callback = &packet_handler; 146 hci_add_event_handler(&hci_event_callback_registration); 147 148 // Allow sniff mode requests by HID device 149 gap_set_default_link_policy_settings(LM_LINK_POLICY_ENABLE_SNIFF_MODE); 150 151 // Disable stdout buffering 152 setbuf(stdout, NULL); 153 } 154 /* LISTING_END */ 155 156 /* @section SDP parser callback 157 * 158 * @text The SDP parsers retrieves the BNEP PAN UUID as explained in 159 * Section [on SDP BNEP Query example](#sec:sdpbnepqueryExample}. 160 */ 161 162 static void handle_sdp_client_query_result(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size) { 163 164 UNUSED(packet_type); 165 UNUSED(channel); 166 UNUSED(size); 167 168 des_iterator_t attribute_list_it; 169 des_iterator_t additional_des_it; 170 des_iterator_t prot_it; 171 uint8_t *des_element; 172 uint8_t *element; 173 uint32_t uuid; 174 uint8_t status; 175 176 switch (hci_event_packet_get_type(packet)){ 177 case SDP_EVENT_QUERY_ATTRIBUTE_VALUE: 178 if (sdp_event_query_attribute_byte_get_attribute_length(packet) <= attribute_value_buffer_size) { 179 attribute_value[sdp_event_query_attribute_byte_get_data_offset(packet)] = sdp_event_query_attribute_byte_get_data(packet); 180 if ((uint16_t)(sdp_event_query_attribute_byte_get_data_offset(packet)+1) == sdp_event_query_attribute_byte_get_attribute_length(packet)) { 181 switch(sdp_event_query_attribute_byte_get_attribute_id(packet)) { 182 case BLUETOOTH_ATTRIBUTE_PROTOCOL_DESCRIPTOR_LIST: 183 for (des_iterator_init(&attribute_list_it, attribute_value); des_iterator_has_more(&attribute_list_it); des_iterator_next(&attribute_list_it)) { 184 if (des_iterator_get_type(&attribute_list_it) != DE_DES) continue; 185 des_element = des_iterator_get_element(&attribute_list_it); 186 des_iterator_init(&prot_it, des_element); 187 element = des_iterator_get_element(&prot_it); 188 if (!element) continue; 189 if (de_get_element_type(element) != DE_UUID) continue; 190 uuid = de_get_uuid32(element); 191 des_iterator_next(&prot_it); 192 switch (uuid){ 193 case BLUETOOTH_PROTOCOL_L2CAP: 194 if (!des_iterator_has_more(&prot_it)) continue; 195 de_element_get_uint16(des_iterator_get_element(&prot_it), &hid_control_psm); 196 printf("HID Control PSM: 0x%04x\n", (int) hid_control_psm); 197 break; 198 default: 199 break; 200 } 201 } 202 break; 203 case BLUETOOTH_ATTRIBUTE_ADDITIONAL_PROTOCOL_DESCRIPTOR_LISTS: 204 for (des_iterator_init(&attribute_list_it, attribute_value); des_iterator_has_more(&attribute_list_it); des_iterator_next(&attribute_list_it)) { 205 if (des_iterator_get_type(&attribute_list_it) != DE_DES) continue; 206 des_element = des_iterator_get_element(&attribute_list_it); 207 for (des_iterator_init(&additional_des_it, des_element); des_iterator_has_more(&additional_des_it); des_iterator_next(&additional_des_it)) { 208 if (des_iterator_get_type(&additional_des_it) != DE_DES) continue; 209 des_element = des_iterator_get_element(&additional_des_it); 210 des_iterator_init(&prot_it, des_element); 211 element = des_iterator_get_element(&prot_it); 212 if (!element) continue; 213 if (de_get_element_type(element) != DE_UUID) continue; 214 uuid = de_get_uuid32(element); 215 des_iterator_next(&prot_it); 216 switch (uuid){ 217 case BLUETOOTH_PROTOCOL_L2CAP: 218 if (!des_iterator_has_more(&prot_it)) continue; 219 de_element_get_uint16(des_iterator_get_element(&prot_it), &hid_interrupt_psm); 220 printf("HID Interrupt PSM: 0x%04x\n", (int) hid_interrupt_psm); 221 break; 222 default: 223 break; 224 } 225 } 226 } 227 break; 228 case BLUETOOTH_ATTRIBUTE_HID_DESCRIPTOR_LIST: 229 for (des_iterator_init(&attribute_list_it, attribute_value); des_iterator_has_more(&attribute_list_it); des_iterator_next(&attribute_list_it)) { 230 if (des_iterator_get_type(&attribute_list_it) != DE_DES) continue; 231 des_element = des_iterator_get_element(&attribute_list_it); 232 for (des_iterator_init(&additional_des_it, des_element); des_iterator_has_more(&additional_des_it); des_iterator_next(&additional_des_it)) { 233 if (des_iterator_get_type(&additional_des_it) != DE_STRING) continue; 234 element = des_iterator_get_element(&additional_des_it); 235 const uint8_t * descriptor = de_get_string(element); 236 hid_descriptor_len = de_get_data_size(element); 237 memcpy(hid_descriptor, descriptor, hid_descriptor_len); 238 printf("HID Descriptor:\n"); 239 printf_hexdump(hid_descriptor, hid_descriptor_len); 240 } 241 } 242 break; 243 default: 244 break; 245 } 246 } 247 } else { 248 fprintf(stderr, "SDP attribute value buffer size exceeded: available %d, required %d\n", attribute_value_buffer_size, sdp_event_query_attribute_byte_get_attribute_length(packet)); 249 } 250 break; 251 252 case SDP_EVENT_QUERY_COMPLETE: 253 if (!hid_control_psm) { 254 printf("HID Control PSM missing\n"); 255 break; 256 } 257 if (!hid_interrupt_psm) { 258 printf("HID Interrupt PSM missing\n"); 259 break; 260 } 261 printf("Setup HID\n"); 262 status = l2cap_create_channel(packet_handler, remote_addr, hid_control_psm, 48, &l2cap_hid_control_cid); 263 if (status){ 264 printf("Connecting to HID Control failed: 0x%02x\n", status); 265 } 266 break; 267 } 268 } 269 270 /* 271 * @section HID Report Handler 272 * 273 * @text Use BTstack's compact HID Parser to process incoming HID Report 274 * Iterate over all fields and process fields with usage page = 0x07 / Keyboard 275 * Check if SHIFT is down and process first character (don't handle multiple key presses) 276 * 277 */ 278 #define NUM_KEYS 6 279 static uint8_t last_keys[NUM_KEYS]; 280 static void hid_host_handle_interrupt_report(const uint8_t * report, uint16_t report_len){ 281 // check if HID Input Report 282 if (report_len < 1) return; 283 if (*report != 0xa1) return; 284 report++; 285 report_len--; 286 btstack_hid_parser_t parser; 287 btstack_hid_parser_init(&parser, hid_descriptor, hid_descriptor_len, HID_REPORT_TYPE_INPUT, report, report_len); 288 int shift = 0; 289 uint8_t new_keys[NUM_KEYS]; 290 memset(new_keys, 0, sizeof(new_keys)); 291 int new_keys_count = 0; 292 while (btstack_hid_parser_has_more(&parser)){ 293 uint16_t usage_page; 294 uint16_t usage; 295 int32_t value; 296 btstack_hid_parser_get_field(&parser, &usage_page, &usage, &value); 297 if (usage_page != 0x07) continue; 298 switch (usage){ 299 case 0xe1: 300 case 0xe6: 301 if (value){ 302 shift = 1; 303 } 304 continue; 305 case 0x00: 306 continue; 307 default: 308 break; 309 } 310 if (usage >= sizeof(keytable_us_none)) continue; 311 312 // store new keys 313 new_keys[new_keys_count++] = usage; 314 315 // check if usage was used last time (and ignore in that case) 316 int i; 317 for (i=0;i<NUM_KEYS;i++){ 318 if (usage == last_keys[i]){ 319 usage = 0; 320 } 321 } 322 if (usage == 0) continue; 323 324 uint8_t key; 325 if (shift){ 326 key = keytable_us_shift[usage]; 327 } else { 328 key = keytable_us_none[usage]; 329 } 330 if (key == CHAR_ILLEGAL) continue; 331 if (key == CHAR_BACKSPACE){ 332 printf("\b \b"); // go back one char, print space, go back one char again 333 continue; 334 } 335 printf("%c", key); 336 } 337 memcpy(last_keys, new_keys, NUM_KEYS); 338 } 339 340 /* 341 * @section Packet Handler 342 * 343 * @text The packet handler responds to various HCI Events. 344 */ 345 346 /* LISTING_START(packetHandler): Packet Handler */ 347 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size) 348 { 349 /* LISTING_PAUSE */ 350 uint8_t event; 351 bd_addr_t event_addr; 352 uint8_t status; 353 uint16_t l2cap_cid; 354 355 /* LISTING_RESUME */ 356 switch (packet_type) { 357 case HCI_EVENT_PACKET: 358 event = hci_event_packet_get_type(packet); 359 switch (event) { 360 /* @text When BTSTACK_EVENT_STATE with state HCI_STATE_WORKING 361 * is received and the example is started in client mode, the remote SDP HID query is started. 362 */ 363 case BTSTACK_EVENT_STATE: 364 if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){ 365 printf("Start SDP HID query for remote HID Device.\n"); 366 sdp_client_query_uuid16(&handle_sdp_client_query_result, remote_addr, BLUETOOTH_SERVICE_CLASS_HUMAN_INTERFACE_DEVICE_SERVICE); 367 } 368 break; 369 370 /* LISTING_PAUSE */ 371 case HCI_EVENT_PIN_CODE_REQUEST: 372 // inform about pin code request 373 printf("Pin code request - using '0000'\n"); 374 hci_event_pin_code_request_get_bd_addr(packet, event_addr); 375 gap_pin_code_response(event_addr, "0000"); 376 break; 377 378 case HCI_EVENT_USER_CONFIRMATION_REQUEST: 379 // inform about user confirmation request 380 printf("SSP User Confirmation Request with numeric value '%"PRIu32"'\n", little_endian_read_32(packet, 8)); 381 printf("SSP User Confirmation Auto accept\n"); 382 break; 383 384 /* LISTING_RESUME */ 385 386 case L2CAP_EVENT_CHANNEL_OPENED: 387 status = packet[2]; 388 if (status){ 389 printf("L2CAP Connection failed: 0x%02x\n", status); 390 break; 391 } 392 l2cap_cid = little_endian_read_16(packet, 13); 393 if (!l2cap_cid) break; 394 if (l2cap_cid == l2cap_hid_control_cid){ 395 status = l2cap_create_channel(packet_handler, remote_addr, hid_interrupt_psm, 48, &l2cap_hid_interrupt_cid); 396 if (status){ 397 printf("Connecting to HID Control failed: 0x%02x\n", status); 398 break; 399 } 400 } 401 if (l2cap_cid == l2cap_hid_interrupt_cid){ 402 printf("HID Connection established\n"); 403 } 404 break; 405 default: 406 break; 407 } 408 break; 409 case L2CAP_DATA_PACKET: 410 // for now, just dump incoming data 411 if (channel == l2cap_hid_interrupt_cid){ 412 hid_host_handle_interrupt_report(packet, size); 413 } else if (channel == l2cap_hid_control_cid){ 414 printf("HID Control: "); 415 printf_hexdump(packet, size); 416 } else { 417 break; 418 } 419 default: 420 break; 421 } 422 } 423 /* LISTING_END */ 424 425 int btstack_main(int argc, const char * argv[]); 426 int btstack_main(int argc, const char * argv[]){ 427 428 (void)argc; 429 (void)argv; 430 431 hid_host_setup(); 432 433 // parse human readable Bluetooth address 434 sscanf_bd_addr(remote_addr_string, remote_addr); 435 436 // Turn on the device 437 hci_power_control(HCI_POWER_ON); 438 return 0; 439 } 440 441 /* EXAMPLE_END */ 442