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 // Appearance HID - Mouse (Category 15, Sub-Category 2) 115 0x03, BLUETOOTH_DATA_TYPE_APPEARANCE, 0xC2, 0x03, 116 }; 117 const uint8_t adv_data_len = sizeof(adv_data); 118 119 static void hog_mouse_setup(void){ 120 121 122 // setup l2cap and register for connection parameter updates 123 l2cap_init(); 124 l2cap_register_packet_handler(&packet_handler); 125 126 // setup le device db 127 le_device_db_init(); 128 129 // setup SM: Display only 130 sm_init(); 131 sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY); 132 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION | SM_AUTHREQ_BONDING); 133 sm_set_authentication_requirements(SM_AUTHREQ_BONDING); 134 135 // setup ATT server 136 att_server_init(profile_data, NULL, NULL); 137 138 // setup battery service 139 battery_service_server_init(battery); 140 141 // setup device information service 142 device_information_service_server_init(); 143 144 // setup HID Device service 145 hids_device_init(0, hid_descriptor_mouse_boot_mode, sizeof(hid_descriptor_mouse_boot_mode)); 146 147 // setup advertisements 148 uint16_t adv_int_min = 0x0030; 149 uint16_t adv_int_max = 0x0030; 150 uint8_t adv_type = 0; 151 bd_addr_t null_addr; 152 memset(null_addr, 0, 6); 153 gap_advertisements_set_params(adv_int_min, adv_int_max, adv_type, 0, null_addr, 0x07, 0x00); 154 gap_advertisements_set_data(adv_data_len, (uint8_t*) adv_data); 155 gap_advertisements_enable(1); 156 157 // register for events 158 hci_event_callback_registration.callback = &packet_handler; 159 hci_add_event_handler(&hci_event_callback_registration); 160 161 sm_event_callback_registration.callback = &packet_handler; 162 sm_add_event_handler(&sm_event_callback_registration); 163 164 hids_device_register_packet_handler(packet_handler); 165 } 166 167 // HID Report sending 168 static void send_report(uint8_t buttons, int8_t dx, int8_t dy){ 169 // uint8_t report[] = { (uint8_t) dx, (uint8_t) dy, buttons}; 170 uint8_t report[] = { buttons, (uint8_t) dx, (uint8_t) dy}; 171 hids_device_send_input_report(con_handle, report, sizeof(report)); 172 printf("Mouse: %d/%d - buttons: %02x\n", dx, dy, buttons); 173 } 174 175 static int dx; 176 static int dy; 177 static uint8_t buttons; 178 179 static void mousing_can_send_now(void){ 180 send_report(buttons, dx, dy); 181 // reset 182 dx = 0; 183 dy = 0; 184 if (buttons){ 185 buttons = 0; 186 hids_device_request_can_send_now_event(con_handle); 187 } 188 } 189 190 // Demo Application 191 192 #ifdef HAVE_BTSTACK_STDIN 193 194 static const int MOUSE_SPEED = 30; 195 196 // On systems with STDIN, we can directly type on the console 197 198 static void stdin_process(char character){ 199 200 if (con_handle == HCI_CON_HANDLE_INVALID) { 201 printf("Mouse not connected, ignoring '%c'\n", character); 202 return; 203 } 204 205 switch (character){ 206 case 'a': 207 dx -= MOUSE_SPEED; 208 break; 209 case 's': 210 dy += MOUSE_SPEED; 211 break; 212 case 'd': 213 dx += MOUSE_SPEED; 214 break; 215 case 'w': 216 dy -= MOUSE_SPEED; 217 break; 218 case 'l': 219 buttons |= 1; 220 break; 221 case 'r': 222 buttons |= 2; 223 break; 224 default: 225 return; 226 } 227 hids_device_request_can_send_now_event(con_handle); 228 } 229 230 #else 231 232 // On embedded systems, simulate clicking on 4 corners of a square 233 234 #define MOUSE_PERIOD_MS 15 235 236 static const int STEPS_PER_DIRECTION = 50; 237 static const int MOUSE_SPEED = 10; 238 239 static btstack_timer_source_t mousing_timer; 240 static int mousing_active = 0; 241 static int step; 242 243 static struct { 244 int dx; 245 int dy; 246 } directions[] = { 247 { 1, 0 }, 248 { 0, 1 }, 249 { -1, 0 }, 250 { 0, -1 }, 251 }; 252 253 254 static void mousing_timer_handler(btstack_timer_source_t * ts){ 255 256 if (con_handle == HCI_CON_HANDLE_INVALID) { 257 mousing_active = 0; 258 return; 259 } 260 261 // simulate left click when corner reached 262 if (step % STEPS_PER_DIRECTION == 0){ 263 buttons |= 1; 264 } 265 // simulate move 266 int direction_index = step / STEPS_PER_DIRECTION; 267 dx += directions[direction_index].dx * MOUSE_SPEED; 268 dy += directions[direction_index].dy * MOUSE_SPEED; 269 270 // next 271 step++; 272 if (step >= STEPS_PER_DIRECTION * 4) { 273 step = 0; 274 } 275 276 // trigger send 277 hids_device_request_can_send_now_event(con_handle); 278 279 // set next timer 280 btstack_run_loop_set_timer(ts, MOUSE_PERIOD_MS); 281 btstack_run_loop_add_timer(ts); 282 } 283 284 static void hid_embedded_start_mousing(void){ 285 if (mousing_active) return; 286 mousing_active = 1; 287 288 printf("Start mousing..\n"); 289 290 step = 0; 291 292 // set one-shot timer 293 mousing_timer.process = &mousing_timer_handler; 294 btstack_run_loop_set_timer(&mousing_timer, MOUSE_PERIOD_MS); 295 btstack_run_loop_add_timer(&mousing_timer); 296 } 297 #endif 298 299 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 300 UNUSED(channel); 301 UNUSED(size); 302 uint16_t conn_interval; 303 304 switch (packet_type) { 305 case HCI_EVENT_PACKET: 306 switch (hci_event_packet_get_type(packet)) { 307 case HCI_EVENT_DISCONNECTION_COMPLETE: 308 con_handle = HCI_CON_HANDLE_INVALID; 309 printf("Disconnected\n"); 310 break; 311 case SM_EVENT_JUST_WORKS_REQUEST: 312 printf("Just Works requested\n"); 313 sm_just_works_confirm(sm_event_just_works_request_get_handle(packet)); 314 break; 315 case SM_EVENT_NUMERIC_COMPARISON_REQUEST: 316 printf("Confirming numeric comparison: %"PRIu32"\n", sm_event_numeric_comparison_request_get_passkey(packet)); 317 sm_numeric_comparison_confirm(sm_event_passkey_display_number_get_handle(packet)); 318 break; 319 case SM_EVENT_PASSKEY_DISPLAY_NUMBER: 320 printf("Display Passkey: %"PRIu32"\n", sm_event_passkey_display_number_get_passkey(packet)); 321 break; 322 case L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_RESPONSE: 323 printf("L2CAP Connection Parameter Update Complete, response: %x\n", l2cap_event_connection_parameter_update_response_get_result(packet)); 324 break; 325 case HCI_EVENT_LE_META: 326 switch (hci_event_le_meta_get_subevent_code(packet)) { 327 case HCI_SUBEVENT_LE_CONNECTION_COMPLETE: 328 // print connection parameters (without using float operations) 329 conn_interval = hci_subevent_le_connection_complete_get_conn_interval(packet); 330 printf("LE Connection Complete:\n"); 331 printf("- Connection Interval: %u.%02u ms\n", conn_interval * 125 / 100, 25 * (conn_interval & 3)); 332 printf("- Connection Latency: %u\n", hci_subevent_le_connection_complete_get_conn_latency(packet)); 333 break; 334 case HCI_SUBEVENT_LE_CONNECTION_UPDATE_COMPLETE: 335 // print connection parameters (without using float operations) 336 conn_interval = hci_subevent_le_connection_update_complete_get_conn_interval(packet); 337 printf("LE Connection Update:\n"); 338 printf("- Connection Interval: %u.%02u ms\n", conn_interval * 125 / 100, 25 * (conn_interval & 3)); 339 printf("- Connection Latency: %u\n", hci_subevent_le_connection_update_complete_get_conn_latency(packet)); 340 break; 341 default: 342 break; 343 } 344 break; 345 case HCI_EVENT_HIDS_META: 346 switch (hci_event_hids_meta_get_subevent_code(packet)){ 347 case HIDS_SUBEVENT_INPUT_REPORT_ENABLE: 348 con_handle = hids_subevent_input_report_enable_get_con_handle(packet); 349 printf("Report Characteristic Subscribed %u\n", hids_subevent_input_report_enable_get_enable(packet)); 350 #ifndef HAVE_BTSTACK_STDIN 351 hid_embedded_start_mousing(); 352 #endif 353 // request connection param update via L2CAP following Apple Bluetooth Design Guidelines 354 // gap_request_connection_parameter_update(con_handle, 12, 12, 4, 100); // 15 ms, 4, 1s 355 356 // directly update connection params via HCI following Apple Bluetooth Design Guidelines 357 // gap_update_connection_parameters(con_handle, 12, 12, 4, 100); // 60-75 ms, 4, 1s 358 359 break; 360 case HIDS_SUBEVENT_BOOT_KEYBOARD_INPUT_REPORT_ENABLE: 361 con_handle = hids_subevent_input_report_enable_get_con_handle(packet); 362 printf("Boot Keyboard Characteristic Subscribed %u\n", hids_subevent_boot_keyboard_input_report_enable_get_enable(packet)); 363 break; 364 case HIDS_SUBEVENT_BOOT_MOUSE_INPUT_REPORT_ENABLE: 365 con_handle = hids_subevent_input_report_enable_get_con_handle(packet); 366 printf("Boot Mouse Characteristic Subscribed %u\n", hids_subevent_boot_mouse_input_report_enable_get_enable(packet)); 367 break; 368 case HIDS_SUBEVENT_PROTOCOL_MODE: 369 printf("Protocol Mode: %s mode\n", hids_subevent_protocol_mode_get_protocol_mode(packet) ? "Report" : "Boot"); 370 break; 371 case HIDS_SUBEVENT_CAN_SEND_NOW: 372 mousing_can_send_now(); 373 break; 374 default: 375 break; 376 } 377 } 378 break; 379 } 380 } 381 382 int btstack_main(void); 383 int btstack_main(void) 384 { 385 hog_mouse_setup(); 386 387 #ifdef HAVE_BTSTACK_STDIN 388 btstack_stdin_setup(stdin_process); 389 #endif 390 391 // turn on! 392 hci_power_control(HCI_POWER_ON); 393 394 return 0; 395 } 396