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__ "hog_mouse_demo.c" 39 40 // ***************************************************************************** 41 /* EXAMPLE_START(hog_mouse_demo): HID-over-GATT Mouse 42 */ 43 // ***************************************************************************** 44 45 #include <stdint.h> 46 #include <stdio.h> 47 #include <stdlib.h> 48 #include <string.h> 49 #include <inttypes.h> 50 51 #include "hog_mouse_demo.h" 52 53 #include "btstack.h" 54 55 #include "ble/gatt-service/battery_service_server.h" 56 #include "ble/gatt-service/device_information_service_server.h" 57 #include "ble/gatt-service/hids_device.h" 58 59 // from USB HID Specification 1.1, Appendix B.2 60 const uint8_t hid_descriptor_mouse_boot_mode[] = { 61 0x05, 0x01, // USAGE_PAGE (Generic Desktop) 62 0x09, 0x02, // USAGE (Mouse) 63 0xa1, 0x01, // COLLECTION (Application) 64 65 0x85, 0x01, // Report ID 1 66 67 0x09, 0x01, // USAGE (Pointer) 68 69 0xa1, 0x00, // COLLECTION (Physical) 70 71 #if 1 72 0x05, 0x09, // USAGE_PAGE (Button) 73 0x19, 0x01, // USAGE_MINIMUM (Button 1) 74 0x29, 0x03, // USAGE_MAXIMUM (Button 3) 75 0x15, 0x00, // LOGICAL_MINIMUM (0) 76 0x25, 0x01, // LOGICAL_MAXIMUM (1) 77 0x95, 0x03, // REPORT_COUNT (3) 78 0x75, 0x01, // REPORT_SIZE (1) 79 0x81, 0x02, // INPUT (Data,Var,Abs) 80 0x95, 0x01, // REPORT_COUNT (1) 81 0x75, 0x05, // REPORT_SIZE (5) 82 0x81, 0x03, // INPUT (Cnst,Var,Abs) 83 #endif 84 85 #if 1 86 0x05, 0x01, // USAGE_PAGE (Generic Desktop) 87 0x09, 0x30, // USAGE (X) 88 0x09, 0x31, // USAGE (Y) 89 0x15, 0x81, // LOGICAL_MINIMUM (-127) 90 0x25, 0x7f, // LOGICAL_MAXIMUM (127) 91 0x75, 0x08, // REPORT_SIZE (8) 92 0x95, 0x02, // REPORT_COUNT (2) 93 0x81, 0x06, // INPUT (Data,Var,Rel) 94 #endif 95 96 0xc0, // END_COLLECTION 97 0xc0 // END_COLLECTION 98 }; 99 100 static btstack_packet_callback_registration_t hci_event_callback_registration; 101 static btstack_packet_callback_registration_t sm_event_callback_registration; 102 static uint8_t battery = 100; 103 static hci_con_handle_t con_handle = HCI_CON_HANDLE_INVALID; 104 105 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 106 107 const uint8_t adv_data[] = { 108 // Flags general discoverable, BR/EDR not supported 109 0x02, BLUETOOTH_DATA_TYPE_FLAGS, 0x06, 110 // Name 111 0x0a, BLUETOOTH_DATA_TYPE_COMPLETE_LOCAL_NAME, 'H', 'I', 'D', ' ', 'M', 'o', 'u', 's', 'e', 112 // 16-bit Service UUIDs 113 0x03, BLUETOOTH_DATA_TYPE_COMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS, ORG_BLUETOOTH_SERVICE_HUMAN_INTERFACE_DEVICE & 0xff, ORG_BLUETOOTH_SERVICE_HUMAN_INTERFACE_DEVICE >> 8, 114 }; 115 const uint8_t adv_data_len = sizeof(adv_data); 116 117 static void hog_mouse_setup(void){ 118 119 120 // setup l2cap and register for connection parameter updates 121 l2cap_init(); 122 l2cap_register_packet_handler(&packet_handler); 123 124 // setup le device db 125 le_device_db_init(); 126 127 // setup SM: Display only 128 sm_init(); 129 sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY); 130 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION | SM_AUTHREQ_BONDING); 131 sm_set_authentication_requirements(SM_AUTHREQ_BONDING); 132 133 // setup ATT server 134 att_server_init(profile_data, NULL, NULL); 135 136 // setup battery service 137 battery_service_server_init(battery); 138 139 // setup device information service 140 device_information_service_server_init(); 141 142 // setup HID Device service 143 hids_device_init(0, hid_descriptor_mouse_boot_mode, sizeof(hid_descriptor_mouse_boot_mode)); 144 145 // setup advertisements 146 uint16_t adv_int_min = 0x0030; 147 uint16_t adv_int_max = 0x0030; 148 uint8_t adv_type = 0; 149 bd_addr_t null_addr; 150 memset(null_addr, 0, 6); 151 gap_advertisements_set_params(adv_int_min, adv_int_max, adv_type, 0, null_addr, 0x07, 0x00); 152 gap_advertisements_set_data(adv_data_len, (uint8_t*) adv_data); 153 gap_advertisements_enable(1); 154 155 // register for events 156 hci_event_callback_registration.callback = &packet_handler; 157 hci_add_event_handler(&hci_event_callback_registration); 158 159 sm_event_callback_registration.callback = &packet_handler; 160 sm_add_event_handler(&sm_event_callback_registration); 161 162 hids_device_register_packet_handler(packet_handler); 163 } 164 165 // HID Report sending 166 static void send_report(uint8_t buttons, int8_t dx, int8_t dy){ 167 // uint8_t report[] = { (uint8_t) dx, (uint8_t) dy, buttons}; 168 uint8_t report[] = { buttons, (uint8_t) dx, (uint8_t) dy}; 169 hids_device_send_input_report(con_handle, report, sizeof(report)); 170 printf("Mouse: %d/%d - buttons: %02x\n", dx, dy, buttons); 171 } 172 173 static int dx; 174 static int dy; 175 static uint8_t buttons; 176 177 static void mousing_can_send_now(void){ 178 send_report(buttons, dx, dy); 179 // reset 180 dx = 0; 181 dy = 0; 182 if (buttons){ 183 buttons = 0; 184 hids_device_request_can_send_now_event(con_handle); 185 } 186 } 187 188 // Demo Application 189 190 #ifdef HAVE_BTSTACK_STDIN 191 192 static const int MOUSE_SPEED = 30; 193 194 // On systems with STDIN, we can directly type on the console 195 196 static void stdin_process(char character){ 197 198 if (con_handle == HCI_CON_HANDLE_INVALID) { 199 printf("Mouse not connected, ignoring '%c'\n", character); 200 return; 201 } 202 203 switch (character){ 204 case 'a': 205 dx -= MOUSE_SPEED; 206 break; 207 case 's': 208 dy += MOUSE_SPEED; 209 break; 210 case 'd': 211 dx += MOUSE_SPEED; 212 break; 213 case 'w': 214 dy -= MOUSE_SPEED; 215 break; 216 case 'l': 217 buttons |= 1; 218 break; 219 case 'r': 220 buttons |= 2; 221 break; 222 default: 223 return; 224 } 225 hids_device_request_can_send_now_event(con_handle); 226 } 227 228 #else 229 230 // On embedded systems, simulate clicking on 4 corners of a square 231 232 #define MOUSE_PERIOD_MS 15 233 234 static const int STEPS_PER_DIRECTION = 50; 235 static const int MOUSE_SPEED = 10; 236 237 static btstack_timer_source_t mousing_timer; 238 static int mousing_active = 0; 239 static int step; 240 241 static struct { 242 int dx; 243 int dy; 244 } directions[] = { 245 { 1, 0 }, 246 { 0, 1 }, 247 { -1, 0 }, 248 { 0, -1 }, 249 }; 250 251 252 static void mousing_timer_handler(btstack_timer_source_t * ts){ 253 254 if (con_handle == HCI_CON_HANDLE_INVALID) { 255 mousing_active = 0; 256 return; 257 } 258 259 // simulate left click when corner reached 260 if (step % STEPS_PER_DIRECTION == 0){ 261 buttons |= 1; 262 } 263 // simulate move 264 int direction_index = step / STEPS_PER_DIRECTION; 265 dx += directions[direction_index].dx * MOUSE_SPEED; 266 dy += directions[direction_index].dy * MOUSE_SPEED; 267 268 // next 269 step++; 270 if (step >= STEPS_PER_DIRECTION * 4) { 271 step = 0; 272 } 273 274 // trigger send 275 hids_device_request_can_send_now_event(con_handle); 276 277 // set next timer 278 btstack_run_loop_set_timer(ts, MOUSE_PERIOD_MS); 279 btstack_run_loop_add_timer(ts); 280 } 281 282 static void hid_embedded_start_mousing(void){ 283 if (mousing_active) return; 284 mousing_active = 1; 285 286 printf("Start mousing..\n"); 287 288 step = 0; 289 290 // set one-shot timer 291 mousing_timer.process = &mousing_timer_handler; 292 btstack_run_loop_set_timer(&mousing_timer, MOUSE_PERIOD_MS); 293 btstack_run_loop_add_timer(&mousing_timer); 294 } 295 #endif 296 297 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 298 UNUSED(channel); 299 UNUSED(size); 300 uint16_t conn_interval; 301 302 switch (packet_type) { 303 case HCI_EVENT_PACKET: 304 switch (hci_event_packet_get_type(packet)) { 305 case HCI_EVENT_DISCONNECTION_COMPLETE: 306 con_handle = HCI_CON_HANDLE_INVALID; 307 printf("Disconnected\n"); 308 break; 309 case SM_EVENT_JUST_WORKS_REQUEST: 310 printf("Just Works requested\n"); 311 sm_just_works_confirm(sm_event_just_works_request_get_handle(packet)); 312 break; 313 case SM_EVENT_NUMERIC_COMPARISON_REQUEST: 314 printf("Confirming numeric comparison: %"PRIu32"\n", sm_event_numeric_comparison_request_get_passkey(packet)); 315 sm_numeric_comparison_confirm(sm_event_passkey_display_number_get_handle(packet)); 316 break; 317 case SM_EVENT_PASSKEY_DISPLAY_NUMBER: 318 printf("Display Passkey: %"PRIu32"\n", sm_event_passkey_display_number_get_passkey(packet)); 319 break; 320 case L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_RESPONSE: 321 printf("L2CAP Connection Parameter Update Complete, response: %x\n", l2cap_event_connection_parameter_update_response_get_result(packet)); 322 break; 323 case HCI_EVENT_LE_META: 324 switch (hci_event_le_meta_get_subevent_code(packet)) { 325 case HCI_SUBEVENT_LE_CONNECTION_COMPLETE: 326 // print connection parameters (without using float operations) 327 conn_interval = hci_subevent_le_connection_complete_get_conn_interval(packet); 328 printf("LE Connection Complete:\n"); 329 printf("- Connection Interval: %u.%02u ms\n", conn_interval * 125 / 100, 25 * (conn_interval & 3)); 330 printf("- Connection Latency: %u\n", hci_subevent_le_connection_complete_get_conn_latency(packet)); 331 break; 332 case HCI_SUBEVENT_LE_CONNECTION_UPDATE_COMPLETE: 333 // print connection parameters (without using float operations) 334 conn_interval = hci_subevent_le_connection_update_complete_get_conn_interval(packet); 335 printf("LE Connection Update:\n"); 336 printf("- Connection Interval: %u.%02u ms\n", conn_interval * 125 / 100, 25 * (conn_interval & 3)); 337 printf("- Connection Latency: %u\n", hci_subevent_le_connection_update_complete_get_conn_latency(packet)); 338 break; 339 default: 340 break; 341 } 342 break; 343 case HCI_EVENT_HIDS_META: 344 switch (hci_event_hids_meta_get_subevent_code(packet)){ 345 case HIDS_SUBEVENT_INPUT_REPORT_ENABLE: 346 con_handle = hids_subevent_input_report_enable_get_con_handle(packet); 347 printf("Report Characteristic Subscribed %u\n", hids_subevent_input_report_enable_get_enable(packet)); 348 #ifndef HAVE_BTSTACK_STDIN 349 hid_embedded_start_mousing(); 350 #endif 351 // request connection param update via L2CAP following Apple Bluetooth Design Guidelines 352 // gap_request_connection_parameter_update(con_handle, 12, 12, 4, 100); // 15 ms, 4, 1s 353 354 // directly update connection params via HCI following Apple Bluetooth Design Guidelines 355 // gap_update_connection_parameters(con_handle, 12, 12, 4, 100); // 60-75 ms, 4, 1s 356 357 break; 358 case HIDS_SUBEVENT_BOOT_KEYBOARD_INPUT_REPORT_ENABLE: 359 con_handle = hids_subevent_input_report_enable_get_con_handle(packet); 360 printf("Boot Keyboard Characteristic Subscribed %u\n", hids_subevent_boot_keyboard_input_report_enable_get_enable(packet)); 361 break; 362 case HIDS_SUBEVENT_BOOT_MOUSE_INPUT_REPORT_ENABLE: 363 con_handle = hids_subevent_input_report_enable_get_con_handle(packet); 364 printf("Boot Mouse Characteristic Subscribed %u\n", hids_subevent_boot_mouse_input_report_enable_get_enable(packet)); 365 break; 366 case HIDS_SUBEVENT_PROTOCOL_MODE: 367 printf("Protocol Mode: %s mode\n", hids_subevent_protocol_mode_get_protocol_mode(packet) ? "Report" : "Boot"); 368 break; 369 case HIDS_SUBEVENT_CAN_SEND_NOW: 370 mousing_can_send_now(); 371 break; 372 default: 373 break; 374 } 375 } 376 break; 377 } 378 } 379 380 int btstack_main(void); 381 int btstack_main(void) 382 { 383 hog_mouse_setup(); 384 385 #ifdef HAVE_BTSTACK_STDIN 386 btstack_stdin_setup(stdin_process); 387 #endif 388 389 // turn on! 390 hci_power_control(HCI_POWER_ON); 391 392 return 0; 393 } 394