LE Credit-Based Flow-Control Mode Server - Receive data over L2CAP

Source Code: le_credit_based_flow_control_mode_server.c

iOS 11 and newer supports L2CAP channels in LE Credit-Based Flow-Control Mode for fast transfer over LE Basic iOS example on GitHub

Track throughput

We calculate the throughput by setting a start time and measuring the amount of data sent. After a configurable REPORT_INTERVAL_MS, we print the throughput in kB/s and reset the counter and start time.

static void test_reset(le_cbm_connection_t * context){
  context-&gt;test_data_start = <a href="https://github.com/bluekitchen/btstack/blob/develop/src/btstack_run_loop.h#L273">btstack_run_loop_get_time_ms</a>();
  context-&gt;test_data_sent = 0;
}

static void test_track_data(le_cbm_connection_t * context, int bytes_transferred){
  context-&gt;test_data_sent += bytes_transferred;
  // evaluate
  uint32_t now = <a href="https://github.com/bluekitchen/btstack/blob/develop/src/btstack_run_loop.h#L273">btstack_run_loop_get_time_ms</a>();
  uint32_t time_passed = now - context-&gt;test_data_start;
  if (time_passed &lt; REPORT_INTERVAL_MS) return;
  // print speed
  int bytes_per_second = context-&gt;test_data_sent * 1000 / time_passed;
  printf("%c: %"PRIu32" bytes sent-&gt; %u.%03u kB/s\n", context-&gt;name, context-&gt;test_data_sent, bytes_per_second / 1000, bytes_per_second % 1000);

  // restart
  context-&gt;test_data_start = now;
  context-&gt;test_data_sent  = 0;
}

Streamer

The streamer function checks if notifications are enabled and if a notification can be sent now. It creates some test data - a single letter that gets increased every time - and tracks the data sent.

static void streamer(void){

  if (le_cbm_connection.cid == 0) return;

  // create test data
  le_cbm_connection.counter++;
  if (le_cbm_connection.counter &gt; 'Z') le_cbm_connection.counter = 'A';
  memset(le_cbm_connection.test_data, le_cbm_connection.counter, le_cbm_connection.test_data_len);

  // send
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/l2cap.h#L543">l2cap_send</a>(le_cbm_connection.cid, (uint8_t *) le_cbm_connection.test_data, le_cbm_connection.test_data_len);

  // track
  test_track_data(&amp;le_cbm_connection, le_cbm_connection.test_data_len);

  // request another packet
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/l2cap.h#L583">l2cap_request_can_send_now_event</a>(le_cbm_connection.cid);
}

HCI + L2CAP Packet Handler

The packet handler is used to stop the notifications and reset the MTU on connect It would also be a good place to request the connection parameter update as indicated in the commented code block.

SM Packet Handler

static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
  UNUSED(channel);

  bd_addr_t event_address;
  uint16_t psm;
  uint16_t cid;
  uint16_t conn_interval;
  hci_con_handle_t handle;
  uint8_t status;

  switch (packet_type) {
    case HCI_EVENT_PACKET:
      switch (hci_event_packet_get_type(packet)) {
        case BTSTACK_EVENT_STATE:
        // BTstack activated, get started
        if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING) {
          printf("To start streaming, please run the le_credit_based_flow_control_mode_client example on other device.\n");
        } 
        break;
        case HCI_EVENT_DISCONNECTION_COMPLETE:
          // free connection
          printf("%c: Disconnect, reason 0x%02x\n", le_cbm_connection.name, hci_event_disconnection_complete_get_reason(packet));
          le_cbm_connection.connection_handle = HCI_CON_HANDLE_INVALID;
          break;
        case HCI_EVENT_META_GAP:
          switch (hci_event_gap_meta_get_subevent_code(packet)) {
            case GAP_SUBEVENT_LE_CONNECTION_COMPLETE:
              // print connection parameters (without using float operations)
              conn_interval = gap_subevent_le_connection_complete_get_conn_interval(packet);
              printf("%c: Connection Interval: %u.%02u ms\n", le_cbm_connection.name, conn_interval * 125 / 100, 25 * (conn_interval &amp; 3));
              printf("%c: Connection Latency: %u\n", le_cbm_connection.name, gap_subevent_le_connection_complete_get_conn_latency(packet));

              // min con interval 15 ms - supported from iOS 11
              <a href="https://github.com/bluekitchen/btstack/blob/develop/src/gap.h#L1019">gap_request_connection_parameter_update</a>(le_cbm_connection.connection_handle, 12, 12, 4, 0x0048);
              printf("Connected, requesting conn param update for handle 0x%04x\n", le_cbm_connection.connection_handle);
              //
              test_reset(&amp;le_cbm_connection);
              break;
            default:
              break;
          }
          break;
        case HCI_EVENT_LE_META:
          switch (hci_event_le_meta_get_subevent_code(packet)) {
            case HCI_SUBEVENT_LE_CONNECTION_UPDATE_COMPLETE:
              // print connection parameters (without using float operations)
              conn_interval = hci_subevent_le_connection_update_complete_get_conn_interval(packet);
              printf("LE Connection Update:\n");
              printf("%c: Connection Interval: %u.%02u ms\n", le_cbm_connection.name, conn_interval * 125 / 100, 25 * (conn_interval &amp; 3));
              printf("%c: Connection Latency: %u\n", le_cbm_connection.name, hci_subevent_le_connection_update_complete_get_conn_latency(packet));
              break;
            default:
              break;
          }
          break;

        case L2CAP_EVENT_CONNECTION_PARAMETER_UPDATE_RESPONSE:
          printf("L2CAP Connection Parameter Update Complete, result: 0x%02x\n", l2cap_event_connection_parameter_update_response_get_result(packet));
          break;

        // LE Credit-based Flow-Control Mode

        case L2CAP_EVENT_CBM_INCOMING_CONNECTION: 
          psm = l2cap_event_cbm_incoming_connection_get_psm(packet);
          cid = l2cap_event_cbm_incoming_connection_get_local_cid(packet);
          if (psm != TSPX_le_psm) break;
          printf("L2CAP: Accepting incoming connection request for 0x%02x, PSM %02x\n", cid, psm);
          <a href="https://github.com/bluekitchen/btstack/blob/develop/src/l2cap.h#L699">l2cap_cbm_accept_connection</a>(cid, data_channel_buffer, sizeof(data_channel_buffer), initial_credits);
          break;

        case L2CAP_EVENT_CBM_CHANNEL_OPENED:
          // inform about new l2cap connection
          l2cap_event_cbm_channel_opened_get_address(packet, event_address);
          psm = l2cap_event_cbm_channel_opened_get_psm(packet);
          cid = l2cap_event_cbm_channel_opened_get_local_cid(packet);
          handle = l2cap_event_cbm_channel_opened_get_handle(packet);
          status = l2cap_event_cbm_channel_opened_get_status(packet);
          if (status == ERROR_CODE_SUCCESS) {
            printf("L2CAP: Channel successfully opened: %s, handle 0x%04x, psm 0x%02x, local cid 0x%02x, remote cid 0x%02x\n",
                 <a href="https://github.com/bluekitchen/btstack/blob/develop/src/btstack_util.h#L271">bd_addr_to_str</a>(event_address), handle, psm, cid,  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/btstack_util.h#L118">little_endian_read_16</a>(packet, 15));
            // setup new 
            le_cbm_connection.counter = 'A';
            le_cbm_connection.cid = cid;
            le_cbm_connection.connection_handle = handle;
            le_cbm_connection.test_data_len = <a href="https://github.com/bluekitchen/btstack/blob/develop/src/btstack_util.h#L89">btstack_min</a>(l2cap_event_cbm_channel_opened_get_remote_mtu(packet), sizeof(le_cbm_connection.test_data));
            printf("Test packet size: %u\n", le_cbm_connection.test_data_len);
            test_reset(&amp;le_cbm_connection);
#ifdef TEST_STREAM_DATA
            <a href="https://github.com/bluekitchen/btstack/blob/develop/src/l2cap.h#L583">l2cap_request_can_send_now_event</a>(le_cbm_connection.cid);
#endif
          } else {
            printf("L2CAP: Connection to device %s failed, status 0x%02x\n", <a href="https://github.com/bluekitchen/btstack/blob/develop/src/btstack_util.h#L271">bd_addr_to_str</a>(event_address), status);
          }
          break;

        case L2CAP_EVENT_CHANNEL_CLOSED:
          printf("L2CAP: Channel closed\n");
          le_cbm_connection.cid = 0;
          break;

#ifdef TEST_STREAM_DATA
        case L2CAP_EVENT_CAN_SEND_NOW:
          streamer();
          break;
#endif

        default:
          break;
      }
      break;

    case L2CAP_DATA_PACKET:
      test_track_data(&amp;le_cbm_connection, size);
      break;

    default:
      break;
  }
}

/*
 *
static void sm_packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
  UNUSED(channel);
  UNUSED(size);

  if (packet_type != HCI_EVENT_PACKET) return;

  switch (hci_event_packet_get_type(packet)) {
    case SM_EVENT_JUST_WORKS_REQUEST:
      printf("Just Works requested\n");
      <a href="https://github.com/bluekitchen/btstack/blob/develop/src/ble/sm.h#L156">sm_just_works_confirm</a>(sm_event_just_works_request_get_handle(packet));
      break;
    case SM_EVENT_NUMERIC_COMPARISON_REQUEST:
      printf("Confirming numeric comparison: %"PRIu32"\n", sm_event_numeric_comparison_request_get_passkey(packet));
      <a href="https://github.com/bluekitchen/btstack/blob/develop/src/ble/sm.h#L162">sm_numeric_comparison_confirm</a>(sm_event_passkey_display_number_get_handle(packet));
      break;
    case SM_EVENT_PASSKEY_DISPLAY_NUMBER:
      printf("Display Passkey: %"PRIu32"\n", sm_event_passkey_display_number_get_passkey(packet));
      break;
    default:
      break;
  }
}

The packet handler is used to handle pairing requests

Main Application Setup

Listing here shows main application code. It initializes L2CAP, the Security Manager, and configures the ATT Server with the pre-compiled ATT Database generated from $le_credit_based_flow_control_mode_server.gatt$. Finally, it configures the advertisements and boots the Bluetooth stack.

int btstack_main(int argc, const char * argv[]);
int btstack_main(int argc, const char * argv[]){
  UNUSED(argc);
  UNUSED(argv);

  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/l2cap.h#L477">l2cap_init</a>();

  // setup SM: Display only
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/ble/sm.h#L68">sm_init</a>();

  // setup ATT server: iOS disconnects if ATT MTU Exchange fails
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/ble/att_server.h#L80">att_server_init</a>(profile_data, NULL, NULL);

  // register for HCI events
  hci_event_callback_registration.callback = &amp;packet_handler;
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/hci.h#L1580">hci_add_event_handler</a>(&amp;hci_event_callback_registration);

  // register for SM events
  sm_event_callback_registration.callback = &amp;sm_packet_handler;
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/ble/sm.h#L94">sm_add_event_handler</a>(&amp;sm_event_callback_registration);

  // register for L2CAP events
  l2cap_event_callback_registration.callback = &amp;packet_handler;
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/l2cap.h#L482">l2cap_add_event_handler</a>(&amp;l2cap_event_callback_registration);

  // le data channel setup
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/l2cap.h#L682">l2cap_cbm_register_service</a>(&amp;packet_handler, TSPX_le_psm, LEVEL_2);

  // setup advertisements
  uint16_t adv_int_min = 0x0030;
  uint16_t adv_int_max = 0x0030;
  uint8_t adv_type = 0;
  bd_addr_t null_addr;
  memset(null_addr, 0, 6);
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/gap.h#L714">gap_advertisements_set_params</a>(adv_int_min, adv_int_max, adv_type, 0, null_addr, 0x07, 0x00);
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/gap.h#L701">gap_advertisements_set_data</a>(adv_data_len, (uint8_t *) adv_data);
  <a href="https://github.com/bluekitchen/btstack/blob/develop/src/gap.h#L721">gap_advertisements_enable</a>(1);

  // turn on!
    <a href="https://github.com/bluekitchen/btstack/blob/develop/src/hci.h#L1566">hci_power_control</a>(HCI_POWER_ON);

  return 0;
}