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 // Disable stdout buffering 149 setbuf(stdout, NULL); 150 } 151 /* LISTING_END */ 152 153 /* @section SDP parser callback 154 * 155 * @text The SDP parsers retrieves the BNEP PAN UUID as explained in 156 * Section [on SDP BNEP Query example](#sec:sdpbnepqueryExample}. 157 */ 158 159 static void handle_sdp_client_query_result(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size) { 160 161 UNUSED(packet_type); 162 UNUSED(channel); 163 UNUSED(size); 164 165 des_iterator_t attribute_list_it; 166 des_iterator_t additional_des_it; 167 des_iterator_t prot_it; 168 uint8_t *des_element; 169 uint8_t *element; 170 uint32_t uuid; 171 uint8_t status; 172 173 switch (hci_event_packet_get_type(packet)){ 174 case SDP_EVENT_QUERY_ATTRIBUTE_VALUE: 175 if (sdp_event_query_attribute_byte_get_attribute_length(packet) <= attribute_value_buffer_size) { 176 attribute_value[sdp_event_query_attribute_byte_get_data_offset(packet)] = sdp_event_query_attribute_byte_get_data(packet); 177 if ((uint16_t)(sdp_event_query_attribute_byte_get_data_offset(packet)+1) == sdp_event_query_attribute_byte_get_attribute_length(packet)) { 178 switch(sdp_event_query_attribute_byte_get_attribute_id(packet)) { 179 case BLUETOOTH_ATTRIBUTE_PROTOCOL_DESCRIPTOR_LIST: 180 for (des_iterator_init(&attribute_list_it, attribute_value); des_iterator_has_more(&attribute_list_it); des_iterator_next(&attribute_list_it)) { 181 if (des_iterator_get_type(&attribute_list_it) != DE_DES) continue; 182 des_element = des_iterator_get_element(&attribute_list_it); 183 des_iterator_init(&prot_it, des_element); 184 element = des_iterator_get_element(&prot_it); 185 if (!element) continue; 186 if (de_get_element_type(element) != DE_UUID) continue; 187 uuid = de_get_uuid32(element); 188 des_iterator_next(&prot_it); 189 switch (uuid){ 190 case BLUETOOTH_PROTOCOL_L2CAP: 191 if (!des_iterator_has_more(&prot_it)) continue; 192 de_element_get_uint16(des_iterator_get_element(&prot_it), &hid_control_psm); 193 printf("HID Control PSM: 0x%04x\n", (int) hid_control_psm); 194 break; 195 default: 196 break; 197 } 198 } 199 break; 200 case BLUETOOTH_ATTRIBUTE_ADDITIONAL_PROTOCOL_DESCRIPTOR_LISTS: 201 for (des_iterator_init(&attribute_list_it, attribute_value); des_iterator_has_more(&attribute_list_it); des_iterator_next(&attribute_list_it)) { 202 if (des_iterator_get_type(&attribute_list_it) != DE_DES) continue; 203 des_element = des_iterator_get_element(&attribute_list_it); 204 for (des_iterator_init(&additional_des_it, des_element); des_iterator_has_more(&additional_des_it); des_iterator_next(&additional_des_it)) { 205 if (des_iterator_get_type(&additional_des_it) != DE_DES) continue; 206 des_element = des_iterator_get_element(&additional_des_it); 207 des_iterator_init(&prot_it, des_element); 208 element = des_iterator_get_element(&prot_it); 209 if (!element) continue; 210 if (de_get_element_type(element) != DE_UUID) continue; 211 uuid = de_get_uuid32(element); 212 des_iterator_next(&prot_it); 213 switch (uuid){ 214 case BLUETOOTH_PROTOCOL_L2CAP: 215 if (!des_iterator_has_more(&prot_it)) continue; 216 de_element_get_uint16(des_iterator_get_element(&prot_it), &hid_interrupt_psm); 217 printf("HID Interrupt PSM: 0x%04x\n", (int) hid_interrupt_psm); 218 break; 219 default: 220 break; 221 } 222 } 223 } 224 break; 225 case BLUETOOTH_ATTRIBUTE_HID_DESCRIPTOR_LIST: 226 for (des_iterator_init(&attribute_list_it, attribute_value); des_iterator_has_more(&attribute_list_it); des_iterator_next(&attribute_list_it)) { 227 if (des_iterator_get_type(&attribute_list_it) != DE_DES) continue; 228 des_element = des_iterator_get_element(&attribute_list_it); 229 for (des_iterator_init(&additional_des_it, des_element); des_iterator_has_more(&additional_des_it); des_iterator_next(&additional_des_it)) { 230 if (des_iterator_get_type(&additional_des_it) != DE_STRING) continue; 231 element = des_iterator_get_element(&additional_des_it); 232 const uint8_t * descriptor = de_get_string(element); 233 hid_descriptor_len = de_get_data_size(element); 234 memcpy(hid_descriptor, descriptor, hid_descriptor_len); 235 printf("HID Descriptor:\n"); 236 printf_hexdump(hid_descriptor, hid_descriptor_len); 237 } 238 } 239 break; 240 default: 241 break; 242 } 243 } 244 } else { 245 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)); 246 } 247 break; 248 249 case SDP_EVENT_QUERY_COMPLETE: 250 if (!hid_control_psm) { 251 printf("HID Control PSM missing\n"); 252 break; 253 } 254 if (!hid_interrupt_psm) { 255 printf("HID Interrupt PSM missing\n"); 256 break; 257 } 258 printf("Setup HID\n"); 259 status = l2cap_create_channel(packet_handler, remote_addr, hid_control_psm, 48, &l2cap_hid_control_cid); 260 if (status){ 261 printf("Connecting to HID Control failed: 0x%02x\n", status); 262 } 263 break; 264 } 265 } 266 267 /* 268 * @section HID Report Handler 269 * 270 * @text Use BTstack's compact HID Parser to process incoming HID Report 271 * Iterate over all fields and process fields with usage page = 0x07 / Keyboard 272 * Check if SHIFT is down and process first character (don't handle multiple key presses) 273 * 274 */ 275 #define NUM_KEYS 6 276 static uint8_t last_keys[NUM_KEYS]; 277 static void hid_host_handle_interrupt_report(const uint8_t * report, uint16_t report_len){ 278 // check if HID Input Report 279 if (report_len < 1) return; 280 if (*report != 0xa1) return; 281 report++; 282 report_len--; 283 btstack_hid_parser_t parser; 284 btstack_hid_parser_init(&parser, hid_descriptor, hid_descriptor_len, HID_REPORT_TYPE_INPUT, report, report_len); 285 int shift = 0; 286 uint8_t new_keys[NUM_KEYS]; 287 memset(new_keys, 0, sizeof(new_keys)); 288 int new_keys_count = 0; 289 while (btstack_hid_parser_has_more(&parser)){ 290 uint16_t usage_page; 291 uint16_t usage; 292 int32_t value; 293 btstack_hid_parser_get_field(&parser, &usage_page, &usage, &value); 294 if (usage_page != 0x07) continue; 295 switch (usage){ 296 case 0xe1: 297 case 0xe6: 298 if (value){ 299 shift = 1; 300 } 301 continue; 302 case 0x00: 303 continue; 304 default: 305 break; 306 } 307 if (usage >= sizeof(keytable_us_none)) continue; 308 309 // store new keys 310 new_keys[new_keys_count++] = usage; 311 312 // check if usage was used last time (and ignore in that case) 313 int i; 314 for (i=0;i<NUM_KEYS;i++){ 315 if (usage == last_keys[i]){ 316 usage = 0; 317 } 318 } 319 if (usage == 0) continue; 320 321 uint8_t key; 322 if (shift){ 323 key = keytable_us_shift[usage]; 324 } else { 325 key = keytable_us_none[usage]; 326 } 327 if (key == CHAR_ILLEGAL) continue; 328 if (key == CHAR_BACKSPACE){ 329 printf("\b \b"); // go back one char, print space, go back one char again 330 continue; 331 } 332 printf("%c", key); 333 } 334 memcpy(last_keys, new_keys, NUM_KEYS); 335 } 336 337 /* 338 * @section Packet Handler 339 * 340 * @text The packet handler responds to various HCI Events. 341 */ 342 343 /* LISTING_START(packetHandler): Packet Handler */ 344 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size) 345 { 346 /* LISTING_PAUSE */ 347 uint8_t event; 348 bd_addr_t event_addr; 349 uint8_t status; 350 uint16_t l2cap_cid; 351 352 /* LISTING_RESUME */ 353 switch (packet_type) { 354 case HCI_EVENT_PACKET: 355 event = hci_event_packet_get_type(packet); 356 switch (event) { 357 /* @text When BTSTACK_EVENT_STATE with state HCI_STATE_WORKING 358 * is received and the example is started in client mode, the remote SDP HID query is started. 359 */ 360 case BTSTACK_EVENT_STATE: 361 if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){ 362 printf("Start SDP HID query for remote HID Device.\n"); 363 sdp_client_query_uuid16(&handle_sdp_client_query_result, remote_addr, BLUETOOTH_SERVICE_CLASS_HUMAN_INTERFACE_DEVICE_SERVICE); 364 } 365 break; 366 367 /* LISTING_PAUSE */ 368 case HCI_EVENT_PIN_CODE_REQUEST: 369 // inform about pin code request 370 printf("Pin code request - using '0000'\n"); 371 hci_event_pin_code_request_get_bd_addr(packet, event_addr); 372 gap_pin_code_response(event_addr, "0000"); 373 break; 374 375 case HCI_EVENT_USER_CONFIRMATION_REQUEST: 376 // inform about user confirmation request 377 printf("SSP User Confirmation Request with numeric value '%"PRIu32"'\n", little_endian_read_32(packet, 8)); 378 printf("SSP User Confirmation Auto accept\n"); 379 break; 380 381 /* LISTING_RESUME */ 382 383 case L2CAP_EVENT_CHANNEL_OPENED: 384 status = packet[2]; 385 if (status){ 386 printf("L2CAP Connection failed: 0x%02x\n", status); 387 break; 388 } 389 l2cap_cid = little_endian_read_16(packet, 13); 390 if (!l2cap_cid) break; 391 if (l2cap_cid == l2cap_hid_control_cid){ 392 status = l2cap_create_channel(packet_handler, remote_addr, hid_interrupt_psm, 48, &l2cap_hid_interrupt_cid); 393 if (status){ 394 printf("Connecting to HID Control failed: 0x%02x\n", status); 395 break; 396 } 397 } 398 if (l2cap_cid == l2cap_hid_interrupt_cid){ 399 printf("HID Connection established\n"); 400 } 401 break; 402 default: 403 break; 404 } 405 break; 406 case L2CAP_DATA_PACKET: 407 // for now, just dump incoming data 408 if (channel == l2cap_hid_interrupt_cid){ 409 hid_host_handle_interrupt_report(packet, size); 410 } else if (channel == l2cap_hid_control_cid){ 411 printf("HID Control: "); 412 printf_hexdump(packet, size); 413 } else { 414 break; 415 } 416 default: 417 break; 418 } 419 } 420 /* LISTING_END */ 421 422 int btstack_main(int argc, const char * argv[]); 423 int btstack_main(int argc, const char * argv[]){ 424 425 (void)argc; 426 (void)argv; 427 428 hid_host_setup(); 429 430 // parse human readable Bluetooth address 431 sscanf_bd_addr(remote_addr_string, remote_addr); 432 433 // Turn on the device 434 hci_power_control(HCI_POWER_ON); 435 return 0; 436 } 437 438 /* EXAMPLE_END */ 439