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 BLUEKITCHEN 24 * GMBH 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__ "gatt_streamer_server.c" 39 40 // ***************************************************************************** 41 /* EXAMPLE_START(gatt_streamer_server): Performance - Stream Data over GATT (Server) 42 * 43 * @text All newer operating systems provide GATT Client functionality. 44 * This example shows how to get a maximal throughput via BLE: 45 * - send whenever possible, 46 * - use the max ATT MTU. 47 * 48 * @text In theory, we should also update the connection parameters, but we already get 49 * a connection interval of 30 ms and there's no public way to use a shorter 50 * interval with iOS (if we're not implementing an HID device). 51 * 52 * @text Note: To start the streaming, run the example. 53 * On remote device use some GATT Explorer, e.g. LightBlue, BLExplr to enable notifications. 54 */ 55 // ***************************************************************************** 56 57 #include <inttypes.h> 58 #include <stdint.h> 59 #include <stdio.h> 60 #include <stdlib.h> 61 #include <string.h> 62 63 #include "btstack.h" 64 65 // le_streamer.gatt contains the declaration of the provided GATT Services + Characteristics 66 // le_streamer.h contains the binary representation of le_streamer.gatt 67 // it is generated by the build system by calling: $BTSTACK_ROOT/tool/compile_gatt.py le_streamer.gatt le_streamer.h 68 // it needs to be regenerated when the GATT Database declared in le_streamer.gatt file is modified 69 #include "gatt_streamer_server.h" 70 71 #define REPORT_INTERVAL_MS 3000 72 #define MAX_NR_CONNECTIONS 3 73 74 75 static void hci_packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 76 static void att_packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 77 static int att_write_callback(hci_con_handle_t con_handle, uint16_t att_handle, uint16_t transaction_mode, uint16_t offset, uint8_t *buffer, uint16_t buffer_size); 78 static void streamer(void); 79 80 // Flags general discoverable, BR/EDR supported (== not supported flag not set) when ENABLE_GATT_OVER_CLASSIC is enabled 81 #ifdef ENABLE_GATT_OVER_CLASSIC 82 #define APP_AD_FLAGS 0x02 83 #else 84 #define APP_AD_FLAGS 0x06 85 #endif 86 87 const uint8_t adv_data[] = { 88 // Flags general discoverable 89 0x02, BLUETOOTH_DATA_TYPE_FLAGS, APP_AD_FLAGS, 90 // Name 91 0x0c, BLUETOOTH_DATA_TYPE_COMPLETE_LOCAL_NAME, 'L', 'E', ' ', 'S', 't', 'r', 'e', 'a', 'm', 'e', 'r', 92 // Incomplete List of 16-bit Service Class UUIDs -- FF10 - only valid for testing! 93 0x03, BLUETOOTH_DATA_TYPE_INCOMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS, 0x10, 0xff, 94 }; 95 const uint8_t adv_data_len = sizeof(adv_data); 96 97 static btstack_packet_callback_registration_t hci_event_callback_registration; 98 99 // support for multiple clients 100 typedef struct { 101 char name; 102 int le_notification_enabled; 103 uint16_t value_handle; 104 hci_con_handle_t connection_handle; 105 int counter; 106 char test_data[200]; 107 int test_data_len; 108 uint32_t test_data_sent; 109 uint32_t test_data_start; 110 } le_streamer_connection_t; 111 static le_streamer_connection_t le_streamer_connections[MAX_NR_CONNECTIONS]; 112 113 // round robin sending 114 static int connection_index; 115 116 #ifdef ENABLE_GATT_OVER_CLASSIC 117 static uint8_t gatt_service_buffer[70]; 118 #endif 119 120 static void init_connections(void){ 121 // track connections 122 int i; 123 for (i=0;i<MAX_NR_CONNECTIONS;i++){ 124 le_streamer_connections[i].connection_handle = HCI_CON_HANDLE_INVALID; 125 le_streamer_connections[i].name = 'A' + i; 126 } 127 } 128 129 static le_streamer_connection_t * connection_for_conn_handle(hci_con_handle_t conn_handle){ 130 int i; 131 for (i=0;i<MAX_NR_CONNECTIONS;i++){ 132 if (le_streamer_connections[i].connection_handle == conn_handle) return &le_streamer_connections[i]; 133 } 134 return NULL; 135 } 136 137 static void next_connection_index(void){ 138 connection_index++; 139 if (connection_index == MAX_NR_CONNECTIONS){ 140 connection_index = 0; 141 } 142 } 143 144 /* @section Main Application Setup 145 * 146 * @text Listing MainConfiguration shows main application code. 147 * It initializes L2CAP, the Security Manager, and configures the ATT Server with the pre-compiled 148 * ATT Database generated from $le_streamer.gatt$. Finally, it configures the advertisements 149 * and boots the Bluetooth stack. 150 */ 151 152 /* LISTING_START(MainConfiguration): Init L2CAP, SM, ATT Server, and enable advertisements */ 153 154 static void le_streamer_setup(void){ 155 156 l2cap_init(); 157 158 // setup le device db 159 le_device_db_init(); 160 161 // setup SM: Display only 162 sm_init(); 163 164 #ifdef ENABLE_GATT_OVER_CLASSIC 165 // init SDP, create record for GATT and register with SDP 166 sdp_init(); 167 memset(gatt_service_buffer, 0, sizeof(gatt_service_buffer)); 168 gatt_create_sdp_record(gatt_service_buffer, 0x10001, ATT_SERVICE_GATT_SERVICE_START_HANDLE, ATT_SERVICE_GATT_SERVICE_END_HANDLE); 169 sdp_register_service(gatt_service_buffer); 170 printf("SDP service record size: %u\n", de_get_len(gatt_service_buffer)); 171 172 // configure Classic GAP 173 gap_set_local_name("GATT Streamer BR/EDR 00:00:00:00:00:00"); 174 gap_ssp_set_io_capability(SSP_IO_CAPABILITY_DISPLAY_YES_NO); 175 gap_discoverable_control(1); 176 #endif 177 178 // setup ATT server 179 att_server_init(profile_data, NULL, att_write_callback); 180 181 // register for HCI events 182 hci_event_callback_registration.callback = &hci_packet_handler; 183 hci_add_event_handler(&hci_event_callback_registration); 184 185 // register for ATT events 186 att_server_register_packet_handler(att_packet_handler); 187 188 // setup advertisements 189 uint16_t adv_int_min = 0x0030; 190 uint16_t adv_int_max = 0x0030; 191 uint8_t adv_type = 0; 192 bd_addr_t null_addr; 193 memset(null_addr, 0, 6); 194 gap_advertisements_set_params(adv_int_min, adv_int_max, adv_type, 0, null_addr, 0x07, 0x00); 195 gap_advertisements_set_data(adv_data_len, (uint8_t*) adv_data); 196 gap_advertisements_enable(1); 197 198 // init client state 199 init_connections(); 200 } 201 /* LISTING_END */ 202 203 /* 204 * @section Track throughput 205 * @text We calculate the throughput by setting a start time and measuring the amount of 206 * data sent. After a configurable REPORT_INTERVAL_MS, we print the throughput in kB/s 207 * and reset the counter and start time. 208 */ 209 210 /* LISTING_START(tracking): Tracking throughput */ 211 212 static void test_reset(le_streamer_connection_t * context){ 213 context->test_data_start = btstack_run_loop_get_time_ms(); 214 context->test_data_sent = 0; 215 } 216 217 static void test_track_sent(le_streamer_connection_t * context, int bytes_sent){ 218 context->test_data_sent += bytes_sent; 219 // evaluate 220 uint32_t now = btstack_run_loop_get_time_ms(); 221 uint32_t time_passed = now - context->test_data_start; 222 if (time_passed < REPORT_INTERVAL_MS) return; 223 // print speed 224 int bytes_per_second = context->test_data_sent * 1000 / time_passed; 225 printf("%c: %"PRIu32" bytes sent-> %u.%03u kB/s\n", context->name, context->test_data_sent, bytes_per_second / 1000, bytes_per_second % 1000); 226 227 // restart 228 context->test_data_start = now; 229 context->test_data_sent = 0; 230 } 231 /* LISTING_END(tracking): Tracking throughput */ 232 233 /* 234 * @section HCI Packet Handler 235 * 236 * @text The packet handler is used track incoming connections and to stop notifications on disconnect 237 * It is also a good place to request the connection parameter update as indicated 238 * in the commented code block. 239 */ 240 241 /* LISTING_START(hciPacketHandler): Packet Handler */ 242 static void hci_packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 243 UNUSED(channel); 244 UNUSED(size); 245 246 uint16_t conn_interval; 247 hci_con_handle_t con_handle; 248 249 if (packet_type != HCI_EVENT_PACKET) return; 250 251 switch (hci_event_packet_get_type(packet)) { 252 case BTSTACK_EVENT_STATE: 253 // BTstack activated, get started 254 if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING) { 255 printf("To start the streaming, please run the le_streamer_client example on other device, or use some GATT Explorer, e.g. LightBlue, BLExplr.\n"); 256 } 257 break; 258 case HCI_EVENT_DISCONNECTION_COMPLETE: 259 con_handle = hci_event_disconnection_complete_get_connection_handle(packet); 260 printf("- LE Connection %04x: disconnect, reason %02x\n", con_handle, hci_event_disconnection_complete_get_reason(packet)); 261 break; 262 case HCI_EVENT_LE_META: 263 switch (hci_event_le_meta_get_subevent_code(packet)) { 264 case HCI_SUBEVENT_LE_CONNECTION_COMPLETE: 265 // print connection parameters (without using float operations) 266 con_handle = hci_subevent_le_connection_complete_get_connection_handle(packet); 267 conn_interval = hci_subevent_le_connection_complete_get_conn_interval(packet); 268 printf("- LE Connection %04x: connected - connection interval %u.%02u ms, latency %u\n", con_handle, conn_interval * 125 / 100, 269 25 * (conn_interval & 3), hci_subevent_le_connection_complete_get_conn_latency(packet)); 270 271 // request min con interval 15 ms for iOS 11+ 272 printf("- LE Connection %04x: request 15 ms connection interval\n", con_handle); 273 gap_request_connection_parameter_update(con_handle, 12, 12, 0, 0x0048); 274 break; 275 case HCI_SUBEVENT_LE_CONNECTION_UPDATE_COMPLETE: 276 // print connection parameters (without using float operations) 277 con_handle = hci_subevent_le_connection_update_complete_get_connection_handle(packet); 278 conn_interval = hci_subevent_le_connection_update_complete_get_conn_interval(packet); 279 printf("- LE Connection %04x: connection update - connection interval %u.%02u ms, latency %u\n", con_handle, conn_interval * 125 / 100, 280 25 * (conn_interval & 3), hci_subevent_le_connection_update_complete_get_conn_latency(packet)); 281 break; 282 default: 283 break; 284 } 285 break; 286 287 default: 288 break; 289 } 290 } 291 292 /* LISTING_END */ 293 294 /* 295 * @section ATT Packet Handler 296 * 297 * @text The packet handler is used to track the ATT MTU Exchange and trigger ATT send 298 */ 299 300 /* LISTING_START(attPacketHandler): Packet Handler */ 301 static void att_packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 302 UNUSED(channel); 303 UNUSED(size); 304 305 int mtu; 306 le_streamer_connection_t * context; 307 switch (packet_type) { 308 case HCI_EVENT_PACKET: 309 switch (hci_event_packet_get_type(packet)) { 310 case ATT_EVENT_CONNECTED: 311 // setup new 312 context = connection_for_conn_handle(HCI_CON_HANDLE_INVALID); 313 if (!context) break; 314 context->counter = 'A'; 315 context->connection_handle = att_event_connected_get_handle(packet); 316 context->test_data_len = btstack_min(att_server_get_mtu(context->connection_handle) - 3, sizeof(context->test_data)); 317 printf("%c: ATT connected, handle %04x, test data len %u\n", context->name, context->connection_handle, context->test_data_len); 318 break; 319 case ATT_EVENT_MTU_EXCHANGE_COMPLETE: 320 mtu = att_event_mtu_exchange_complete_get_MTU(packet) - 3; 321 context = connection_for_conn_handle(att_event_mtu_exchange_complete_get_handle(packet)); 322 if (!context) break; 323 context->test_data_len = btstack_min(mtu - 3, sizeof(context->test_data)); 324 printf("%c: ATT MTU = %u => use test data of len %u\n", context->name, mtu, context->test_data_len); 325 break; 326 case ATT_EVENT_CAN_SEND_NOW: 327 streamer(); 328 break; 329 case ATT_EVENT_DISCONNECTED: 330 context = connection_for_conn_handle(att_event_disconnected_get_handle(packet)); 331 if (!context) break; 332 // free connection 333 printf("%c: ATT disconnected, handle %04x\n", context->name, context->connection_handle); 334 context->le_notification_enabled = 0; 335 context->connection_handle = HCI_CON_HANDLE_INVALID; 336 break; 337 default: 338 break; 339 } 340 break; 341 default: 342 break; 343 } 344 } 345 /* LISTING_END */ 346 347 /* 348 * @section Streamer 349 * 350 * @text The streamer function checks if notifications are enabled and if a notification can be sent now. 351 * It creates some test data - a single letter that gets increased every time - and tracks the data sent. 352 */ 353 354 /* LISTING_START(streamer): Streaming code */ 355 static void streamer(void){ 356 357 // find next active streaming connection 358 int old_connection_index = connection_index; 359 while (1){ 360 // active found? 361 if ((le_streamer_connections[connection_index].connection_handle != HCI_CON_HANDLE_INVALID) && 362 (le_streamer_connections[connection_index].le_notification_enabled)) break; 363 364 // check next 365 next_connection_index(); 366 367 // none found 368 if (connection_index == old_connection_index) return; 369 } 370 371 le_streamer_connection_t * context = &le_streamer_connections[connection_index]; 372 373 // create test data 374 context->counter++; 375 if (context->counter > 'Z') context->counter = 'A'; 376 memset(context->test_data, context->counter, context->test_data_len); 377 378 // send 379 att_server_notify(context->connection_handle, context->value_handle, (uint8_t*) context->test_data, context->test_data_len); 380 381 // track 382 test_track_sent(context, context->test_data_len); 383 384 // request next send event 385 att_server_request_can_send_now_event(context->connection_handle); 386 387 // check next 388 next_connection_index(); 389 } 390 /* LISTING_END */ 391 392 /* 393 * @section ATT Write 394 * 395 * @text The only valid ATT write in this example is to the Client Characteristic Configuration, which configures notification 396 * and indication. If the ATT handle matches the client configuration handle, the new configuration value is stored. 397 * If notifications get enabled, an ATT_EVENT_CAN_SEND_NOW is requested. See Listing attWrite. 398 */ 399 400 /* LISTING_START(attWrite): ATT Write */ 401 static int att_write_callback(hci_con_handle_t con_handle, uint16_t att_handle, uint16_t transaction_mode, uint16_t offset, uint8_t *buffer, uint16_t buffer_size){ 402 UNUSED(offset); 403 404 // printf("att_write_callback att_handle %04x, transaction mode %u\n", att_handle, transaction_mode); 405 if (transaction_mode != ATT_TRANSACTION_MODE_NONE) return 0; 406 le_streamer_connection_t * context = connection_for_conn_handle(con_handle); 407 switch(att_handle){ 408 case ATT_CHARACTERISTIC_0000FF11_0000_1000_8000_00805F9B34FB_01_CLIENT_CONFIGURATION_HANDLE: 409 case ATT_CHARACTERISTIC_0000FF12_0000_1000_8000_00805F9B34FB_01_CLIENT_CONFIGURATION_HANDLE: 410 context->le_notification_enabled = little_endian_read_16(buffer, 0) == GATT_CLIENT_CHARACTERISTICS_CONFIGURATION_NOTIFICATION; 411 printf("%c: Notifications enabled %u\n", context->name, context->le_notification_enabled); 412 if (context->le_notification_enabled){ 413 switch (att_handle){ 414 case ATT_CHARACTERISTIC_0000FF11_0000_1000_8000_00805F9B34FB_01_CLIENT_CONFIGURATION_HANDLE: 415 context->value_handle = ATT_CHARACTERISTIC_0000FF11_0000_1000_8000_00805F9B34FB_01_VALUE_HANDLE; 416 break; 417 case ATT_CHARACTERISTIC_0000FF12_0000_1000_8000_00805F9B34FB_01_CLIENT_CONFIGURATION_HANDLE: 418 context->value_handle = ATT_CHARACTERISTIC_0000FF12_0000_1000_8000_00805F9B34FB_01_VALUE_HANDLE; 419 break; 420 default: 421 break; 422 } 423 att_server_request_can_send_now_event(context->connection_handle); 424 } 425 test_reset(context); 426 break; 427 case ATT_CHARACTERISTIC_0000FF11_0000_1000_8000_00805F9B34FB_01_VALUE_HANDLE: 428 case ATT_CHARACTERISTIC_0000FF12_0000_1000_8000_00805F9B34FB_01_VALUE_HANDLE: 429 test_track_sent(context, buffer_size); 430 break; 431 default: 432 printf("Write to 0x%04x, len %u\n", att_handle, buffer_size); 433 break; 434 } 435 return 0; 436 } 437 /* LISTING_END */ 438 439 int btstack_main(void); 440 int btstack_main(void) 441 { 442 le_streamer_setup(); 443 444 // turn on! 445 hci_power_control(HCI_POWER_ON); 446 447 return 0; 448 } 449 /* EXAMPLE_END */ 450