diff --git a/examples/bluetooth/.build-test-rules.yml b/examples/bluetooth/.build-test-rules.yml index ab53dcd219d2..217d571da14f 100644 --- a/examples/bluetooth/.build-test-rules.yml +++ b/examples/bluetooth/.build-test-rules.yml @@ -99,6 +99,12 @@ examples/bluetooth/nimble/ble_l2cap_coc: temporary: true reason: the other targets are not tested yet +examples/bluetooth/nimble/ble_phy: + enable: + - if: IDF_TARGET in ["esp32c2", "esp32c3", "esp32s3"] + temporary: true + reason: the other targets are not tested yet + examples/bluetooth/nimble/ble_spp: enable: - if: IDF_TARGET in ["esp32", "esp32c3", "esp32s3"] diff --git a/examples/bluetooth/nimble/ble_phy/phy_cent/CMakeLists.txt b/examples/bluetooth/nimble/ble_phy/phy_cent/CMakeLists.txt new file mode 100644 index 000000000000..06b2dba67353 --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_cent/CMakeLists.txt @@ -0,0 +1,8 @@ +# The following lines of boilerplate have to be in your project's +# CMakeLists in this exact order for cmake to work correctly +cmake_minimum_required(VERSION 3.16) + +set(EXTRA_COMPONENT_DIRS $ {CMAKE_CURRENT_LIST_DIR} / .. / .. / common / nimble_central_utils) + +include($ENV{IDF_PATH} / tools / cmake / project.cmake) +project(phy_cent) diff --git a/examples/bluetooth/nimble/ble_phy/phy_cent/README.md b/examples/bluetooth/nimble/ble_phy/phy_cent/README.md new file mode 100644 index 000000000000..e82e7cc550f2 --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_cent/README.md @@ -0,0 +1,169 @@ +| Supported Targets | ESP32-C2 | ESP32-C3 | ESP32-S3 | +| ----------------- | -------- | -------- | -------- | + +# BLE Central PHY Example + +(See the README.md file in the upper level 'examples' directory for more information about examples.) + +This example performs below functionalities: + +* Establishes a connection on LE 1M PHY and switch to LE 2M PHY once connection is established. Then perform GATT read operation against the specified peer. Disconnect the link once this is completed. + +* Change the default LE PHY to 2M/Coded and establish a connection on that PHY. Then perform GATT read operation against the specified peer. Disconnect the link once this is completed. + +This example aims at understanding how to establish connections on preferred PHY and changing LE PHY once the connection is established. + +To test this demo, use any BLE GATT server app that advertises support for the LE PHY service (0xABF2) and includes it in the GATT database. Also make sure device supports extended advertising. + +Note : + +* Make sure to run `python -m pip install --user -r $IDF_PATH/requirements.txt -r $IDF_PATH/tools/ble/requirements.txt` to install the dependency packages needed. +* Currently this Python utility is only supported on Linux (BLE communication is via BLuez + DBus). + +## How to Use Example + +Before project configuration and build, be sure to set the correct chip target using: + +```bash +idf.py set-target +``` + +### Hardware Required + +* A development board with ESP32-C3 SoC (e.g., ESP-WROVER-KIT, etc.) +* A USB cable for Power supply and programming + +See [Development Boards](https://www.espressif.com/en/products/devkits) for more information about it. + +### Configure the Project + +Open the project configuration menu: + +```bash +idf.py menuconfig +``` + +### Build and Flash + +Run `idf.py -p PORT flash monitor` to build, flash and monitor the project. + +(To exit the serial monitor, type ``Ctrl-]``.) + +See the [Getting Started Guide](https://idf.espressif.com/) for full steps to configure and use ESP-IDF to build projects. + +## Example Output + +This is the console output on successful connection: + +``` +I (315) BTDM_INIT: BT controller compile version [05195c9] +I (315) phy_init: phy_version 912,d001756,Jun 2 2022,16:28:07 +I (355) system_api: Base MAC address is not set +I (355) system_api: read default base MAC address from EFUSE +I (355) BTDM_INIT: Bluetooth MAC: 84:f7:03:08:4d:8e + +I (355) NimBLE_BLE_PHY_CENT: BLE Host Task Started +I (465) NimBLE: Connection established +I (465) NimBLE: + +I (465) NimBLE: Prefered LE PHY set to LE_PHY_2M successfully +I (465) NimBLE: GATT procedure initiated: discover all services + +I (565) NimBLE: GATT procedure initiated: discover all characteristics; +I (565) NimBLE: start_handle=1 end_handle=5 + +I (765) NimBLE: GATT procedure initiated: discover all characteristics; +I (765) NimBLE: start_handle=6 end_handle=9 + +I (965) NimBLE: GATT procedure initiated: discover all characteristics; +I (965) NimBLE: start_handle=10 end_handle=65535 + +I (1015) NimBLE: LE PHY Update completed; status=0 conn_handle=1 tx_phy=2 rx_phy = 2 + +I (1165) NimBLE: GATT procedure initiated: discover all descriptors; +I (1165) NimBLE: chr_val_handle=8 end_handle=9 + +I (1265) NimBLE: GATT procedure initiated: discover all descriptors; +I (1265) NimBLE: chr_val_handle=12 end_handle=65535 + +I (1365) NimBLE: Service discovery complete; status=0 conn_handle=1 + +I (1365) NimBLE: GATT procedure initiated: read; +I (1365) NimBLE: att_handle=12 + +I (1375) NimBLE: GAP procedure initiated: terminate connection; conn_handle=1 hci_reason=19 + +I (1415) NimBLE: disconnect; reason=534 +I (1415) NimBLE: + +I (1415) NimBLE: Default LE PHY set successfully; tx_phy = 2, rx_phy = 2 +I (1505) NimBLE: Connection established +I (1505) NimBLE: + +I (1505) NimBLE: GATT procedure initiated: discover all services + +I (1615) NimBLE: GATT procedure initiated: discover all characteristics; +I (1615) NimBLE: start_handle=1 end_handle=5 + +I (1815) NimBLE: GATT procedure initiated: discover all characteristics; +I (1815) NimBLE: start_handle=6 end_handle=9 + +I (2015) NimBLE: LE PHY Update completed; status=0 conn_handle=1 tx_phy=2 rx_phy = 2 + +I (2015) NimBLE: GATT procedure initiated: discover all characteristics; +I (2025) NimBLE: start_handle=10 end_handle=65535 + +I (2215) NimBLE: GATT procedure initiated: discover all descriptors; +I (2215) NimBLE: chr_val_handle=8 end_handle=9 + +I (2315) NimBLE: GATT procedure initiated: discover all descriptors; +I (2315) NimBLE: chr_val_handle=12 end_handle=65535 + +I (2415) NimBLE: Service discovery complete; status=0 conn_handle=1 + +I (2415) NimBLE: GATT procedure initiated: read; +I (2415) NimBLE: att_handle=12 + +I (2425) NimBLE: GAP procedure initiated: terminate connection; conn_handle=1 hci_reason=19 + +I (2465) NimBLE: disconnect; reason=534 +I (2465) NimBLE: + +I (2465) NimBLE: Default LE PHY set successfully; tx_phy = 4, rx_phy = 4 +I (2555) NimBLE: Connection established +I (2555) NimBLE: + +I (2555) NimBLE: GATT procedure initiated: discover all services + +I (2665) NimBLE: GATT procedure initiated: discover all characteristics; +I (2665) NimBLE: start_handle=1 end_handle=5 + +I (2865) NimBLE: GATT procedure initiated: discover all characteristics; +I (2865) NimBLE: start_handle=6 end_handle=9 + +I (3065) NimBLE: LE PHY Update completed; status=0 conn_handle=1 tx_phy=3 rx_phy = 3 + +I (3065) NimBLE: GATT procedure initiated: discover all characteristics; +I (3075) NimBLE: start_handle=10 end_handle=65535 + +I (3265) NimBLE: GATT procedure initiated: discover all descriptors; +I (3265) NimBLE: chr_val_handle=8 end_handle=9 + +I (3365) NimBLE: GATT procedure initiated: discover all descriptors; +I (3365) NimBLE: chr_val_handle=12 end_handle=65535 + +I (3465) NimBLE: Service discovery complete; status=0 conn_handle=1 + +I (3465) NimBLE: GATT procedure initiated: read; +I (3465) NimBLE: att_handle=12 + +I (3475) NimBLE: GAP procedure initiated: terminate connection; conn_handle=1 hci_reason=19 + +I (3515) NimBLE: disconnect; reason=534 +I (3515) NimBLE: + +``` + +## Troubleshooting + +For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon. diff --git a/examples/bluetooth/nimble/ble_phy/phy_cent/main/CMakeLists.txt b/examples/bluetooth/nimble/ble_phy/phy_cent/main/CMakeLists.txt new file mode 100644 index 000000000000..18d510d98825 --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_cent/main/CMakeLists.txt @@ -0,0 +1,4 @@ +set(srcs "main.c") + +idf_component_register(SRCS "${srcs}" + INCLUDE_DIRS ".") diff --git a/examples/bluetooth/nimble/ble_phy/phy_cent/main/Kconfig.projbuild b/examples/bluetooth/nimble/ble_phy/phy_cent/main/Kconfig.projbuild new file mode 100644 index 000000000000..3f37c35634b3 --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_cent/main/Kconfig.projbuild @@ -0,0 +1,16 @@ +menu "Example Configuration" + + config EXAMPLE_PEER_ADDR + string "Peer Address" + default "ADDR_ANY" + help + Enter the peer address in aa:bb:cc:dd:ee:ff form to connect to a specific peripheral + + config EXAMPLE_EXTENDED_ADV + bool + default y + prompt "Enable Extended Adv" + help + Use this option to enable extended advertising in the example + +endmenu diff --git a/examples/bluetooth/nimble/ble_phy/phy_cent/main/main.c b/examples/bluetooth/nimble/ble_phy/phy_cent/main/main.c new file mode 100644 index 000000000000..95d7184f5c56 --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_cent/main/main.c @@ -0,0 +1,499 @@ +/* + * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ + +#include "esp_log.h" +#include "nvs_flash.h" +/* BLE */ +#include "nimble/nimble_port.h" +#include "nimble/nimble_port_freertos.h" +#include "host/ble_hs.h" +#include "host/util/util.h" +#include "console/console.h" +#include "services/gap/ble_svc_gap.h" +#include "phy_cent.h" + +static const char *tag = "NimBLE_BLE_PHY_CENT"; +static int blecent_gap_event(struct ble_gap_event *event, void *arg); +static uint8_t peer_addr[6]; +static void blecent_scan(void); + +static uint8_t s_current_phy; +void ble_store_config_init(void); + +/** + * Performs GATT operation against the specified peer: + * 1. Reads the Supported LE PHY characteristic. + * + * If the peer does not support a required service, characteristic, or + * descriptor, then the peer lied when it claimed support for the alert + * notification service! When this happens, or if a GATT procedure fails, + * this function immediately terminates the connection. + */ +static void +blecent_read(const struct peer *peer) +{ + const struct peer_chr *chr; + int rc; + + /* Read the supported-new-alert-category characteristic. */ + chr = peer_chr_find_uuid(peer, + BLE_UUID16_DECLARE(LE_PHY_UUID16), + BLE_UUID16_DECLARE(LE_PHY_CHR_UUID16)); + if (chr == NULL) { + MODLOG_DFLT(ERROR, "Error: Peer doesn't support the Supported " + "LE PHY characteristic\n"); + goto err; + } + + rc = ble_gattc_read(peer->conn_handle, chr->chr.val_handle, + NULL, NULL); + if (rc != 0) { + MODLOG_DFLT(ERROR, "Error: Failed to read characteristic; rc=%d\n", + rc); + goto err; + } + + return; +err: + /* Terminate the connection. */ + ble_gap_terminate(peer->conn_handle, BLE_ERR_REM_USER_CONN_TERM); +} + +/** + * Called when service discovery of the specified peer has completed. + */ +static void +blecent_on_disc_complete(const struct peer *peer, int status, void *arg) +{ + + if (status != 0) { + /* Service discovery failed. Terminate the connection. */ + MODLOG_DFLT(ERROR, "Error: Service discovery failed; status=%d " + "conn_handle=%d\n", status, peer->conn_handle); + ble_gap_terminate(peer->conn_handle, BLE_ERR_REM_USER_CONN_TERM); + return; + } + + /* Service discovery has completed successfully. Now we have a complete + * list of services, characteristics, and descriptors that the peer + * supports. + */ + MODLOG_DFLT(INFO, "Service discovery complete; status=%d " + "conn_handle=%d\n", status, peer->conn_handle); + + /* Now perform GATT procedure against the peer: read + */ + blecent_read(peer); + + /* Terminate the connection once GATT procedure is completed */ + ble_gap_terminate(peer->conn_handle, BLE_ERR_REM_USER_CONN_TERM); +} + +/* Set preferred LE PHY after connection is established */ +void set_prefered_le_phy_after_conn(uint16_t conn_handle) +{ + uint8_t tx_phys_mask = 0, rx_phys_mask = 0; + + tx_phys_mask = BLE_HCI_LE_PHY_2M_PREF_MASK; + + rx_phys_mask = BLE_HCI_LE_PHY_2M_PREF_MASK; + + int rc = ble_gap_set_prefered_le_phy(conn_handle, tx_phys_mask, rx_phys_mask, 0); + if (rc == 0) { + MODLOG_DFLT(INFO, "Prefered LE PHY set to LE_PHY_2M successfully"); + } else { + MODLOG_DFLT(ERROR, "Failed to set prefered LE_PHY_2M"); + } +} + +/* Set default LE PHY before establishing connection */ +void set_default_le_phy_before_conn(uint8_t tx_phys_mask, uint8_t rx_phys_mask) +{ + int rc = ble_gap_set_prefered_default_le_phy(tx_phys_mask, rx_phys_mask); + if (rc == 0) { + MODLOG_DFLT(INFO, "Default LE PHY set successfully; tx_phy = %d, rx_phy = %d", + tx_phys_mask, rx_phys_mask); + } else { + MODLOG_DFLT(ERROR, "Failed to set default LE PHY"); + } +} + +/** + * Initiates the GAP general discovery procedure. + */ +static void +blecent_scan(void) +{ + uint8_t own_addr_type; + struct ble_gap_disc_params disc_params; + int rc; + + /* Figure out address to use while advertising (no privacy for now) */ + rc = ble_hs_id_infer_auto(0, &own_addr_type); + if (rc != 0) { + MODLOG_DFLT(ERROR, "error determining address type; rc=%d\n", rc); + return; + } + + /* Tell the controller to filter duplicates; we don't want to process + * repeated advertisements from the same device. + */ + disc_params.filter_duplicates = 1; + + /** + * Perform a passive scan. I.e., don't send follow-up scan requests to + * each advertiser. + */ + disc_params.passive = 1; + + /* Use defaults for the rest of the parameters. */ + disc_params.itvl = 0; + disc_params.window = 0; + disc_params.filter_policy = 0; + disc_params.limited = 0; + + rc = ble_gap_disc(own_addr_type, BLE_HS_FOREVER, &disc_params, + blecent_gap_event, NULL); + if (rc != 0) { + MODLOG_DFLT(ERROR, "Error initiating GAP discovery procedure; rc=%d\n", + rc); + } +} + +/** + * Indicates whether we should try to connect to the sender of the specified + * advertisement. The function returns a positive result if the device + * advertises connectability and support for the LE PHY service. + */ +#if CONFIG_EXAMPLE_EXTENDED_ADV +static int +ext_blecent_should_connect(const struct ble_gap_ext_disc_desc *disc) +{ + int offset = 0; + int ad_struct_len = 0; + + if (disc->legacy_event_type != BLE_HCI_ADV_RPT_EVTYPE_ADV_IND && + disc->legacy_event_type != BLE_HCI_ADV_RPT_EVTYPE_DIR_IND) { + return 0; + } + if (strlen(CONFIG_EXAMPLE_PEER_ADDR) && (strncmp(CONFIG_EXAMPLE_PEER_ADDR, "ADDR_ANY", strlen ("ADDR_ANY")) != 0)) { + ESP_LOGI(tag, "Peer address from menuconfig: %s", CONFIG_EXAMPLE_PEER_ADDR); + /* Convert string to address */ + sscanf(CONFIG_EXAMPLE_PEER_ADDR, "%hhx:%hhx:%hhx:%hhx:%hhx:%hhx", + &peer_addr[5], &peer_addr[4], &peer_addr[3], + &peer_addr[2], &peer_addr[1], &peer_addr[0]); + if (memcmp(peer_addr, disc->addr.val, sizeof(disc->addr.val)) != 0) { + return 0; + } + } + + /* The device has to advertise support LE PHY UUID (0xABF2). + */ + do { + ad_struct_len = disc->data[offset]; + + if (!ad_struct_len) { + break; + } + + /* Search if LE PHY UUID is advertised */ + if (disc->data[offset] == 0x03 && disc->data[offset + 1] == 0x03) { + if ( disc->data[offset + 2] == 0xAB && disc->data[offset + 3] == 0xF2 ) { + return 1; + } + } + + offset += ad_struct_len + 1; + + } while ( offset < disc->length_data ); + return 0; +} +#else +static int +blecent_should_connect(const struct ble_gap_disc_desc *disc) +{ + struct ble_hs_adv_fields fields; + int rc; + int i; + + /* The device has to be advertising connectability. */ + if (disc->event_type != BLE_HCI_ADV_RPT_EVTYPE_ADV_IND && + disc->event_type != BLE_HCI_ADV_RPT_EVTYPE_DIR_IND) { + return 0; + } + + rc = ble_hs_adv_parse_fields(&fields, disc->data, disc->length_data); + if (rc != 0) { + return rc; + } + + if (strlen(CONFIG_EXAMPLE_PEER_ADDR) && (strncmp(CONFIG_EXAMPLE_PEER_ADDR, "ADDR_ANY", strlen("ADDR_ANY")) != 0)) { + ESP_LOGI(tag, "Peer address from menuconfig: %s", CONFIG_EXAMPLE_PEER_ADDR); + /* Convert string to address */ + sscanf(CONFIG_EXAMPLE_PEER_ADDR, "%hhx:%hhx:%hhx:%hhx:%hhx:%hhx", + &peer_addr[5], &peer_addr[4], &peer_addr[3], + &peer_addr[2], &peer_addr[1], &peer_addr[0]); + if (memcmp(peer_addr, disc->addr.val, sizeof(disc->addr.val)) != 0) { + return 0; + } + } + + /* The device has to advertise support for LE PHY UUID (0xABF2) + */ + for (i = 0; i < fields.num_uuids16; i++) { + if (ble_uuid_u16(&fields.uuids16[i].u) == LE_PHY_UUID16) { + return 1; + } + } + + return 0; +} +#endif + +/** + * Connects to the sender of the specified advertisement of it looks + * interesting. A device is "interesting" if it advertises connectability and + * support for the LE PHY service. + */ +static void +blecent_connect_if_interesting(void *disc) +{ + uint8_t own_addr_type; + int rc; + ble_addr_t *addr; + + /* Don't do anything if we don't care about this advertiser. */ +#if CONFIG_EXAMPLE_EXTENDED_ADV + if (!ext_blecent_should_connect((struct ble_gap_ext_disc_desc *)disc)) { + return; + } +#else + if (!blecent_should_connect((struct ble_gap_disc_desc *)disc)) { + return; + } +#endif + + /* Scanning must be stopped before a connection can be initiated. */ + rc = ble_gap_disc_cancel(); + if (rc != 0) { + MODLOG_DFLT(DEBUG, "Failed to cancel scan; rc=%d\n", rc); + return; + } + + /* Figure out address to use for connect (no privacy for now) */ + rc = ble_hs_id_infer_auto(0, &own_addr_type); + if (rc != 0) { + MODLOG_DFLT(ERROR, "error determining address type; rc=%d\n", rc); + return; + } + + /* Try to connect the the advertiser. Allow 30 seconds (30000 ms) for + * timeout. + */ +#if CONFIG_EXAMPLE_EXTENDED_ADV + addr = &((struct ble_gap_ext_disc_desc *)disc)->addr; +#else + addr = &((struct ble_gap_disc_desc *)disc)->addr; +#endif + + rc = ble_gap_connect(own_addr_type, addr, 30000, NULL, + blecent_gap_event, NULL); + if (rc != 0) { + MODLOG_DFLT(ERROR, "Error: Failed to connect to device; addr_type=%d " + "addr=%s; rc=%d\n", + addr->type, addr_str(addr->val), rc); + return; + } +} + +/** + * The nimble host executes this callback when a GAP event occurs. The + * application associates a GAP event callback with each connection that is + * established. blecent uses the same callback for all connections. + * + * @param event The event being signalled. + * @param arg Application-specified argument; unused by + * blecent. + * + * @return 0 if the application successfully handled the + * event; nonzero on failure. The semantics + * of the return code is specific to the + * particular GAP event being signalled. + */ +static int +blecent_gap_event(struct ble_gap_event *event, void *arg) +{ + struct ble_gap_conn_desc desc; + struct ble_hs_adv_fields fields; + int rc; + + switch (event->type) { + case BLE_GAP_EVENT_DISC: + rc = ble_hs_adv_parse_fields(&fields, event->disc.data, + event->disc.length_data); + if (rc != 0) { + return 0; + } + + /* An advertisment report was received during GAP discovery. */ + print_adv_fields(&fields); + + /* Try to connect to the advertiser if it looks interesting. */ + blecent_connect_if_interesting(&event->disc); + return 0; + + case BLE_GAP_EVENT_CONNECT: + /* A new connection was established or a connection attempt failed. */ + if (event->connect.status == 0) { + /* Connection successfully established. */ + MODLOG_DFLT(INFO, "Connection established "); + + rc = ble_gap_conn_find(event->connect.conn_handle, &desc); + assert(rc == 0); + print_conn_desc(&desc); + MODLOG_DFLT(INFO, "\n"); + + /* Remember peer. */ + rc = peer_add(event->connect.conn_handle); + if (rc != 0) { + MODLOG_DFLT(ERROR, "Failed to add peer; rc=%d\n", rc); + return 0; + } + + if (s_current_phy == BLE_HCI_LE_PHY_1M_PREF_MASK) { + /* Update LE PHY from 1M to 2M */ + set_prefered_le_phy_after_conn(event->connect.conn_handle); + } + /* Perform service discovery. */ + rc = peer_disc_all(event->connect.conn_handle, + blecent_on_disc_complete, NULL); + if (rc != 0) { + MODLOG_DFLT(ERROR, "Failed to discover services; rc=%d\n", rc); + return 0; + } + } else { + /* Connection attempt failed; resume scanning. */ + MODLOG_DFLT(ERROR, "Error: Connection failed; status=%d\n", + event->connect.status); + blecent_scan(); + } + + return 0; + + case BLE_GAP_EVENT_DISCONNECT: + /* Connection terminated. */ + MODLOG_DFLT(INFO, "disconnect; reason=%d ", event->disconnect.reason); + print_conn_desc(&event->disconnect.conn); + MODLOG_DFLT(INFO, "\n"); + + /* Forget about peer. */ + peer_delete(event->disconnect.conn.conn_handle); + + switch (s_current_phy) { + case BLE_HCI_LE_PHY_1M_PREF_MASK: + /* Setting current phy to create connection on 2M PHY */ + s_current_phy = BLE_HCI_LE_PHY_2M_PREF_MASK; + break; + + case BLE_HCI_LE_PHY_2M_PREF_MASK: + /* Setting current phy to create connection on CODED PHY */ + s_current_phy = BLE_HCI_LE_PHY_CODED_PREF_MASK; + break; + + case BLE_HCI_LE_PHY_CODED_PREF_MASK: + return 0; + } + set_default_le_phy_before_conn(s_current_phy, s_current_phy); + blecent_scan(); + return 0; + + case BLE_GAP_EVENT_DISC_COMPLETE: + MODLOG_DFLT(INFO, "discovery complete; reason=%d\n", + event->disc_complete.reason); + return 0; + +#if CONFIG_EXAMPLE_EXTENDED_ADV + case BLE_GAP_EVENT_EXT_DISC: + /* An advertisment report was received during GAP discovery. */ + ext_print_adv_report(&event->disc); + + blecent_connect_if_interesting(&event->disc); + return 0; +#endif + + case BLE_GAP_EVENT_PHY_UPDATE_COMPLETE: + MODLOG_DFLT(INFO, "LE PHY Update completed; status=%d conn_handle=%d tx_phy=%d " + "rx_phy = %d\n", event->phy_updated.status, + event->phy_updated.conn_handle, event->phy_updated.tx_phy, + event->phy_updated.rx_phy); + return 0; + + default: + return 0; + } +} + +static void +blecent_on_reset(int reason) +{ + MODLOG_DFLT(ERROR, "Resetting state; reason=%d\n", reason); +} + +static void +blecent_on_sync(void) +{ + int rc; + + /* Make sure we have proper identity address set (public preferred) */ + rc = ble_hs_util_ensure_addr(0); + assert(rc == 0); + + s_current_phy = BLE_HCI_LE_PHY_1M_PREF_MASK; + /* Begin scanning for a peripheral to connect to. */ + blecent_scan(); +} + +void blecent_host_task(void *param) +{ + ESP_LOGI(tag, "BLE Host Task Started"); + /* This function will return only when nimble_port_stop() is executed */ + nimble_port_run(); + + nimble_port_freertos_deinit(); +} + +void +app_main(void) +{ + int rc; + /* Initialize NVS — it is used to store PHY calibration data */ + esp_err_t ret = nvs_flash_init(); + if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) { + ESP_ERROR_CHECK(nvs_flash_erase()); + ret = nvs_flash_init(); + } + ESP_ERROR_CHECK(ret); + + nimble_port_init(); + /* Configure the host. */ + ble_hs_cfg.reset_cb = blecent_on_reset; + ble_hs_cfg.sync_cb = blecent_on_sync; + ble_hs_cfg.store_status_cb = ble_store_util_status_rr; + + /* Initialize data structures to track connected peers. */ + rc = peer_init(MYNEWT_VAL(BLE_MAX_CONNECTIONS), 64, 64, 64); + assert(rc == 0); + + /* Set the default device name. */ + rc = ble_svc_gap_device_name_set("blecent-phy"); + assert(rc == 0); + + /* XXX Need to have template for store */ + ble_store_config_init(); + + nimble_port_freertos_init(blecent_host_task); + +} diff --git a/examples/bluetooth/nimble/ble_phy/phy_cent/main/phy_cent.h b/examples/bluetooth/nimble/ble_phy/phy_cent/main/phy_cent.h new file mode 100644 index 000000000000..1db6bfccc86b --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_cent/main/phy_cent.h @@ -0,0 +1,29 @@ +/* + * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ + +#ifndef H_PHY_CENT_ +#define H_PHY_CENT_ + +#include "modlog/modlog.h" +#include "esp_central.h" +#ifdef __cplusplus +extern "C" { +#endif + +struct ble_hs_adv_fields; +struct ble_gap_conn_desc; +struct ble_hs_cfg; +union ble_store_value; +union ble_store_key; + +#define LE_PHY_UUID16 0xABF2 +#define LE_PHY_CHR_UUID16 0xABF3 + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/examples/bluetooth/nimble/ble_phy/phy_cent/sdkconfig.defaults b/examples/bluetooth/nimble/ble_phy/phy_cent/sdkconfig.defaults new file mode 100644 index 000000000000..81960c10799d --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_cent/sdkconfig.defaults @@ -0,0 +1,13 @@ +# Override some defaults so BT stack is enabled +# in this example + +# +# BT config +# +CONFIG_BT_ENABLED=y +CONFIG_BTDM_CTRL_MODE_BLE_ONLY=y +CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY=n +CONFIG_BTDM_CTRL_MODE_BTDM=n +CONFIG_BT_BLUEDROID_ENABLED=n +CONFIG_BT_NIMBLE_ENABLED=y +CONFIG_BT_NIMBLE_EXT_ADV=y diff --git a/examples/bluetooth/nimble/ble_phy/phy_prph/CMakeLists.txt b/examples/bluetooth/nimble/ble_phy/phy_prph/CMakeLists.txt new file mode 100644 index 000000000000..550d0a0827c6 --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_prph/CMakeLists.txt @@ -0,0 +1,8 @@ +# The following lines of boilerplate have to be in your project's +# CMakeLists in this exact order for cmake to work correctly +cmake_minimum_required(VERSION 3.16) + +set(EXTRA_COMPONENT_DIRS $ {CMAKE_CURRENT_LIST_DIR} / .. / .. / common / nimble_peripheral_utils) + +include($ENV{IDF_PATH} / tools / cmake / project.cmake) +project(phy_prph) diff --git a/examples/bluetooth/nimble/ble_phy/phy_prph/README.md b/examples/bluetooth/nimble/ble_phy/phy_prph/README.md new file mode 100644 index 000000000000..4438e147e81b --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_prph/README.md @@ -0,0 +1,171 @@ +| Supported Targets | ESP32-C2 | ESP32-C3 | ESP32-S3 | +| ----------------- | -------- | -------- | -------- | + +# BLE Peripheral PHY Example + +(See the README.md file in the upper level 'examples' directory for more information about examples.) + +This example performs below functionalities: + +* Establishes a connection on LE 1M PHY and switch to LE 2M PHY once connection is established. Then perform GATT read operation against the specified peer. Disconnect the link once this is completed. + +* Change the default LE PHY to 2M/Coded and establish a connection on that PHY. Then perform GATT read operation against the specified peer. Disconnect the link once this is completed. + +This example aims at understanding how to establish connections on preferred PHY and changing LE PHY once the connection is established. + +To test this demo, use any BLE GATT server app that advertises support for the LE PHY service (0xABF2) and includes it in the GATT database. Also make sure device supports extended advertising. + +Note : + +* Make sure to run `python -m pip install --user -r $IDF_PATH/requirements.txt -r $IDF_PATH/tools/ble/requirements.txt` to install the dependency packages needed. +* Currently this Python utility is only supported on Linux (BLE communication is via BLuez + DBus). + +## How to Use Example + +Before project configuration and build, be sure to set the correct chip target using: + +```bash +idf.py set-target +``` + +### Hardware Required + +* A development board with ESP32-C3 SoC (e.g., ESP-WROVER-KIT, etc.) +* A USB cable for Power supply and programming + +See [Development Boards](https://www.espressif.com/en/products/devkits) for more information about it. + +### Configure the Project + +Open the project configuration menu: + +```bash +idf.py menuconfig +``` + +### Build and Flash + +Run `idf.py -p PORT flash monitor` to build, flash and monitor the project. + +(To exit the serial monitor, type ``Ctrl-]``.) + +See the [Getting Started Guide](https://idf.espressif.com/) for full steps to configure and use ESP-IDF to build projects. + +## Example Output + +This is the console output on successful connection: + +``` +I (322) BTDM_INIT: BT controller compile version [05195c9] +I (322) phy_init: phy_version 912,d001756,Jun 2 2022,16:28:07 +I (362) system_api: Base MAC address is not set +I (362) system_api: read default base MAC address from EFUSE +I (362) BTDM_INIT: Bluetooth MAC: 84:f7:03:05:a5:f6 + +I (362) NimBLE_BLE_PHY_PRPH: BLE Host Task Started +I (372) NimBLE: Device Address: +I (372) NimBLE: 84:f7:03:05:a5:f6 +I (382) NimBLE: + +I (382) uart: queue free spaces: 8 +I (4782) NimBLE: connection established; status=0 +I (4782) NimBLE: handle=1 our_ota_addr_type=0 our_ota_addr= +I (4782) NimBLE: 84:f7:03:05:a5:f6 +I (4782) NimBLE: our_id_addr_type=0 our_id_addr= +I (4792) NimBLE: 84:f7:03:05:a5:f6 +I (4792) NimBLE: peer_ota_addr_type=0 peer_ota_addr= +I (4802) NimBLE: 84:f7:03:08:4d:8e +I (4802) NimBLE: peer_id_addr_type=0 peer_id_addr= +I (4812) NimBLE: 84:f7:03:08:4d:8e +I (4812) NimBLE: conn_itvl=40 conn_latency=0 supervision_timeout=256 encrypted=0 authenticated=0 bonded=0 + +I (4822) NimBLE: + +I (4822) NimBLE: advertise complete; reason=0 +I (4832) NimBLE: LE PHY Update completed; status=0 conn_handle=1 tx_phy=1 rx_phy = 0 + +I (5322) NimBLE: LE PHY Update completed; status=0 conn_handle=1 tx_phy=2 rx_phy = 2 + +I (5732) NimBLE: disconnect; reason=531 +I (5732) NimBLE: handle=1 our_ota_addr_type=0 our_ota_addr= +I (5732) NimBLE: 84:f7:03:05:a5:f6 +I (5732) NimBLE: our_id_addr_type=0 our_id_addr= +I (5742) NimBLE: 84:f7:03:05:a5:f6 +I (5742) NimBLE: peer_ota_addr_type=0 peer_ota_addr= +I (5752) NimBLE: 84:f7:03:08:4d:8e +I (5752) NimBLE: peer_id_addr_type=0 peer_id_addr= +I (5762) NimBLE: 84:f7:03:08:4d:8e +I (5762) NimBLE: conn_itvl=40 conn_latency=0 supervision_timeout=256 encrypted=0 authenticated=0 bonded=0 + +I (5772) NimBLE: + +I (5772) NimBLE: Default LE PHY set successfully +I (5822) NimBLE: connection established; status=0 +I (5822) NimBLE: handle=1 our_ota_addr_type=0 our_ota_addr= +I (5822) NimBLE: 84:f7:03:05:a5:f6 +I (5822) NimBLE: our_id_addr_type=0 our_id_addr= +I (5832) NimBLE: 84:f7:03:05:a5:f6 +I (5832) NimBLE: peer_ota_addr_type=0 peer_ota_addr= +I (5842) NimBLE: 84:f7:03:08:4d:8e +I (5842) NimBLE: peer_id_addr_type=0 peer_id_addr= +I (5852) NimBLE: 84:f7:03:08:4d:8e +I (5852) NimBLE: conn_itvl=40 conn_latency=0 supervision_timeout=256 encrypted=0 authenticated=0 bonded=0 + +I (5862) NimBLE: + +I (5862) NimBLE: advertise complete; reason=0 +I (5872) NimBLE: LE PHY Update completed; status=0 conn_handle=1 tx_phy=1 rx_phy = 0 + +I (6322) NimBLE: LE PHY Update completed; status=0 conn_handle=1 tx_phy=2 rx_phy = 2 + +I (6782) NimBLE: disconnect; reason=531 +I (6782) NimBLE: handle=1 our_ota_addr_type=0 our_ota_addr= +I (6782) NimBLE: 84:f7:03:05:a5:f6 +I (6782) NimBLE: our_id_addr_type=0 our_id_addr= +I (6792) NimBLE: 84:f7:03:05:a5:f6 +I (6792) NimBLE: peer_ota_addr_type=0 peer_ota_addr= +I (6802) NimBLE: 84:f7:03:08:4d:8e +I (6802) NimBLE: peer_id_addr_type=0 peer_id_addr= +I (6812) NimBLE: 84:f7:03:08:4d:8e +I (6812) NimBLE: conn_itvl=40 conn_latency=0 supervision_timeout=256 encrypted=0 authenticated=0 bonded=0 + +I (6822) NimBLE: + +I (6822) NimBLE: Default LE PHY set successfully +I (6872) NimBLE: connection established; status=0 +I (6872) NimBLE: handle=1 our_ota_addr_type=0 our_ota_addr= +I (6872) NimBLE: 84:f7:03:05:a5:f6 +I (6872) NimBLE: our_id_addr_type=0 our_id_addr= +I (6882) NimBLE: 84:f7:03:05:a5:f6 +I (6882) NimBLE: peer_ota_addr_type=0 peer_ota_addr= +I (6892) NimBLE: 84:f7:03:08:4d:8e +I (6892) NimBLE: peer_id_addr_type=0 peer_id_addr= +I (6902) NimBLE: 84:f7:03:08:4d:8e +I (6902) NimBLE: conn_itvl=40 conn_latency=0 supervision_timeout=256 encrypted=0 authenticated=0 bonded=0 + +I (6912) NimBLE: + +I (6912) NimBLE: advertise complete; reason=0 +I (6922) NimBLE: LE PHY Update completed; status=0 conn_handle=1 tx_phy=1 rx_phy = 0 + +I (7372) NimBLE: LE PHY Update completed; status=0 conn_handle=1 tx_phy=3 rx_phy = 3 + +I (7832) NimBLE: disconnect; reason=531 +I (7832) NimBLE: handle=1 our_ota_addr_type=0 our_ota_addr= +I (7832) NimBLE: 84:f7:03:05:a5:f6 +I (7832) NimBLE: our_id_addr_type=0 our_id_addr= +I (7842) NimBLE: 84:f7:03:05:a5:f6 +I (7842) NimBLE: peer_ota_addr_type=0 peer_ota_addr= +I (7852) NimBLE: 84:f7:03:08:4d:8e +I (7852) NimBLE: peer_id_addr_type=0 peer_id_addr= +I (7862) NimBLE: 84:f7:03:08:4d:8e +I (7862) NimBLE: conn_itvl=40 conn_latency=0 supervision_timeout=256 encrypted=0 authenticated=0 bonded=0 + +I (7872) NimBLE: + + +``` + +## Troubleshooting + +For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon. diff --git a/examples/bluetooth/nimble/ble_phy/phy_prph/main/CMakeLists.txt b/examples/bluetooth/nimble/ble_phy/phy_prph/main/CMakeLists.txt new file mode 100644 index 000000000000..0d03be369b74 --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_prph/main/CMakeLists.txt @@ -0,0 +1,5 @@ +set(srcs "main.c" + "gatt_svr.c") + +idf_component_register(SRCS "${srcs}" + INCLUDE_DIRS ".") diff --git a/examples/bluetooth/nimble/ble_phy/phy_prph/main/Kconfig.projbuild b/examples/bluetooth/nimble/ble_phy/phy_prph/main/Kconfig.projbuild new file mode 100644 index 000000000000..de90ea86275a --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_prph/main/Kconfig.projbuild @@ -0,0 +1,55 @@ +menu "Example Configuration" + + choice EXAMPLE_USE_IO_TYPE + prompt "I/O Capability" + default BLE_SM_IO_CAP_NO_IO + help + I/O capability of device. + + config BLE_SM_IO_CAP_DISP_ONLY + bool "DISPLAY ONLY" + config BLE_SM_IO_CAP_DISP_YES_NO + bool "DISPLAY YESNO" + config BLE_SM_IO_CAP_KEYBOARD_ONLY + bool "KEYBOARD ONLY" + config BLE_SM_IO_CAP_NO_IO + bool "Just works" + config BLE_SM_IO_CAP_KEYBOARD_DISP + bool "Both KEYBOARD & DISPLAY" + endchoice + + config EXAMPLE_IO_TYPE + int + default 0 if BLE_SM_IO_CAP_DISP_ONLY + default 1 if BLE_SM_IO_CAP_DISP_YES_NO + default 2 if BLE_SM_IO_CAP_KEYBOARD_ONLY + default 3 if BLE_SM_IO_CAP_NO_IO + default 4 if BLE_SM_IO_CAP_KEYBOARD_DISP + + config EXAMPLE_BONDING + bool + prompt "Use Bonding" + help + Use this option to enable/disable bonding. + + config EXAMPLE_MITM + bool + prompt "MITM security" + help + Use this option to enable/disable MITM security. + + config EXAMPLE_USE_SC + bool + depends on BT_NIMBLE_SM_SC + prompt "Use Secure Connection feature" + help + Use this option to enable/disable Security Manager Secure Connection 4.2 feature. + + config EXAMPLE_EXTENDED_ADV + bool + default y + prompt "Enable Extended Adv" + help + Use this option to enable extended advertising in the example + +endmenu diff --git a/examples/bluetooth/nimble/ble_phy/phy_prph/main/gatt_svr.c b/examples/bluetooth/nimble/ble_phy/phy_prph/main/gatt_svr.c new file mode 100644 index 000000000000..ce3db2a024ae --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_prph/main/gatt_svr.c @@ -0,0 +1,125 @@ +/* + * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ + +#include +#include +#include +#include "host/ble_hs.h" +#include "host/ble_uuid.h" +#include "services/gap/ble_svc_gap.h" +#include "services/gatt/ble_svc_gatt.h" +#include "phy_prph.h" + +static int +gatt_svr_chr_access_le_phy(uint16_t conn_handle, uint16_t attr_handle, + struct ble_gatt_access_ctxt *ctxt, + void *arg); + +static const struct ble_gatt_svc_def gatt_svr_svcs_le_phy[] = { + { + /*** Service: LE PHY. */ + .type = BLE_GATT_SVC_TYPE_PRIMARY, + .uuid = BLE_UUID16_DECLARE(LE_PHY_UUID16), + .characteristics = (struct ble_gatt_chr_def[]) + { { + /*** Characteristic */ + .uuid = BLE_UUID16_DECLARE(LE_PHY_CHR_UUID16), + .access_cb = gatt_svr_chr_access_le_phy, + .flags = BLE_GATT_CHR_F_READ | BLE_GATT_CHR_F_READ_ENC, + }, { + 0, /* No more characteristics in this service. */ + } + }, + }, + + { + 0, /* No more services. */ + }, +}; + +static int +gatt_svr_chr_access_le_phy(uint16_t conn_handle, uint16_t attr_handle, + struct ble_gatt_access_ctxt *ctxt, + void *arg) +{ + const ble_uuid_t *uuid; + int rand_num; + int rc; + + uuid = ctxt->chr->uuid; + + /* Determine which characteristic is being accessed by examining its + * 128-bit UUID. + */ + + if (ble_uuid_cmp(uuid, BLE_UUID16_DECLARE(LE_PHY_CHR_UUID16)) == 0) { + assert(ctxt->op == BLE_GATT_ACCESS_OP_READ_CHR); + + /* Respond with a 32-bit random number. */ + rand_num = rand(); + rc = os_mbuf_append(ctxt->om, &rand_num, sizeof rand_num); + return rc == 0 ? 0 : BLE_ATT_ERR_INSUFFICIENT_RES; + } + + /* Unknown characteristic; the nimble stack should not have called this + * function. + */ + assert(0); + return BLE_ATT_ERR_UNLIKELY; +} + +void +gatt_svr_register_cb(struct ble_gatt_register_ctxt *ctxt, void *arg) +{ + char buf[BLE_UUID_STR_LEN]; + + switch (ctxt->op) { + case BLE_GATT_REGISTER_OP_SVC: + MODLOG_DFLT(DEBUG, "registered service %s with handle=%d\n", + ble_uuid_to_str(ctxt->svc.svc_def->uuid, buf), + ctxt->svc.handle); + break; + + case BLE_GATT_REGISTER_OP_CHR: + MODLOG_DFLT(DEBUG, "registering characteristic %s with " + "def_handle=%d val_handle=%d\n", + ble_uuid_to_str(ctxt->chr.chr_def->uuid, buf), + ctxt->chr.def_handle, + ctxt->chr.val_handle); + break; + + case BLE_GATT_REGISTER_OP_DSC: + MODLOG_DFLT(DEBUG, "registering descriptor %s with handle=%d\n", + ble_uuid_to_str(ctxt->dsc.dsc_def->uuid, buf), + ctxt->dsc.handle); + break; + + default: + assert(0); + break; + } +} + +int +gatt_svr_init_le_phy(void) +{ + int rc; + + ble_svc_gap_init(); + ble_svc_gatt_init(); + + rc = ble_gatts_count_cfg(gatt_svr_svcs_le_phy); + if (rc != 0) { + return rc; + } + + rc = ble_gatts_add_svcs(gatt_svr_svcs_le_phy); + if (rc != 0) { + return rc; + } + + return 0; +} diff --git a/examples/bluetooth/nimble/ble_phy/phy_prph/main/main.c b/examples/bluetooth/nimble/ble_phy/phy_prph/main/main.c new file mode 100644 index 000000000000..2b34bdd16ed6 --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_prph/main/main.c @@ -0,0 +1,440 @@ +/* + * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ + +#include "esp_log.h" +#include "nvs_flash.h" +/* BLE */ +#include "nimble/nimble_port.h" +#include "nimble/nimble_port_freertos.h" +#include "host/ble_hs.h" +#include "host/util/util.h" +#include "console/console.h" +#include "services/gap/ble_svc_gap.h" +#include "phy_prph.h" + +#if CONFIG_EXAMPLE_EXTENDED_ADV +static uint8_t ext_adv_pattern_1M[] = { + 0x02, 0x01, 0x06, + 0x03, 0x03, 0xab, 0xcd, + 0x03, 0x03, 0xAB, 0xF2, + 0x0e, 0X09, 'b', 'l', 'e', 'p', 'r', 'p', 'h', '-', 'p', 'h', 'y', '-', '1', 'M', +}; + +static uint8_t ext_adv_pattern_2M[] = { + 0x02, 0x01, 0x06, + 0x03, 0x03, 0xab, 0xcd, + 0x03, 0x03, 0xAB, 0xF2, + 0x0e, 0X09, 'b', 'l', 'e', 'p', 'r', 'p', 'h', '-', 'p', 'h', 'y', '-', '2', 'M', +}; + +static uint8_t ext_adv_pattern_coded[] = { + 0x02, 0x01, 0x06, + 0x03, 0x03, 0xab, 0xcd, + 0x03, 0x03, 0xAB, 0xF2, + 0x11, 0X09, 'b', 'l', 'e', 'p', 'r', 'p', 'h', '-', 'p', 'h', 'y', '-', 'c', 'o', 'd', 'e', + 'd', +}; +#endif + +static const char *tag = "NimBLE_BLE_PHY_PRPH"; +static int bleprph_gap_event(struct ble_gap_event *event, void *arg); +static uint8_t own_addr_type; + +static uint8_t s_current_phy; +void ble_store_config_init(void); + +/* Set default LE PHY before establishing connection */ +void set_default_le_phy_before_conn(uint8_t tx_phys_mask, uint8_t rx_phys_mask) +{ + int rc = ble_gap_set_prefered_default_le_phy(tx_phys_mask, rx_phys_mask); + if (rc == 0) { + MODLOG_DFLT(INFO, "Default LE PHY set successfully"); + } else { + MODLOG_DFLT(ERROR, "Failed to set default LE PHY"); + } +} + +/** + * Logs information about a connection to the console. + */ +static void +bleprph_print_conn_desc(struct ble_gap_conn_desc *desc) +{ + MODLOG_DFLT(INFO, "handle=%d our_ota_addr_type=%d our_ota_addr=", + desc->conn_handle, desc->our_ota_addr.type); + print_addr(desc->our_ota_addr.val); + MODLOG_DFLT(INFO, " our_id_addr_type=%d our_id_addr=", + desc->our_id_addr.type); + print_addr(desc->our_id_addr.val); + MODLOG_DFLT(INFO, " peer_ota_addr_type=%d peer_ota_addr=", + desc->peer_ota_addr.type); + print_addr(desc->peer_ota_addr.val); + MODLOG_DFLT(INFO, " peer_id_addr_type=%d peer_id_addr=", + desc->peer_id_addr.type); + print_addr(desc->peer_id_addr.val); + MODLOG_DFLT(INFO, " conn_itvl=%d conn_latency=%d supervision_timeout=%d " + "encrypted=%d authenticated=%d bonded=%d\n", + desc->conn_itvl, desc->conn_latency, + desc->supervision_timeout, + desc->sec_state.encrypted, + desc->sec_state.authenticated, + desc->sec_state.bonded); +} + +#if CONFIG_EXAMPLE_EXTENDED_ADV +static struct os_mbuf * +ext_get_data(uint8_t ext_adv_pattern[], int size) +{ + struct os_mbuf *data; + int rc; + data = os_msys_get_pkthdr(size, 0); + assert(data); + rc = os_mbuf_append(data, ext_adv_pattern, size); + assert(rc == 0); + return data; +} + +/** + * Enables advertising with the following parameters: + * o General discoverable mode. + * o Undirected connectable mode. + */ +static void +ext_bleprph_advertise(void) +{ + struct ble_gap_ext_adv_params params; + struct os_mbuf *data = NULL; + uint8_t instance = 1; + int rc; + + /* use defaults for non-set params */ + memset (¶ms, 0, sizeof(params)); + + /* enable connectable advertising */ + params.connectable = 1; + params.scannable = 1; + params.legacy_pdu = 1; + + /* advertise using random addr */ + params.own_addr_type = BLE_OWN_ADDR_PUBLIC; + + /* Set current phy; get mbuf for scan rsp data; fill mbuf with scan rsp data */ + switch (s_current_phy) { + case BLE_HCI_LE_PHY_1M_PREF_MASK: + params.primary_phy = BLE_HCI_LE_PHY_1M; + params.secondary_phy = BLE_HCI_LE_PHY_1M; + data = ext_get_data(ext_adv_pattern_1M, sizeof(ext_adv_pattern_1M)); + break; + + case BLE_HCI_LE_PHY_2M_PREF_MASK: + params.primary_phy = BLE_HCI_LE_PHY_1M; + params.secondary_phy = BLE_HCI_LE_PHY_2M; + data = ext_get_data(ext_adv_pattern_2M, sizeof(ext_adv_pattern_2M)); + break; + + case BLE_HCI_LE_PHY_CODED_PREF_MASK: + params.primary_phy = BLE_HCI_LE_PHY_CODED; + params.secondary_phy = BLE_HCI_LE_PHY_CODED; + data = ext_get_data(ext_adv_pattern_coded, sizeof(ext_adv_pattern_coded)); + break; + } + + //params.tx_power = 127; + params.sid = 1; + + params.itvl_min = BLE_GAP_ADV_FAST_INTERVAL1_MIN; + params.itvl_max = BLE_GAP_ADV_FAST_INTERVAL1_MIN; + + /* configure instance 0 */ + rc = ble_gap_ext_adv_configure(instance, ¶ms, NULL, + bleprph_gap_event, NULL); + assert (rc == 0); + + rc = ble_gap_ext_adv_set_data(instance, data); + assert (rc == 0); + + /* start advertising */ + rc = ble_gap_ext_adv_start(instance, 0, 0); + assert (rc == 0); +} +#else +/** + * Enables advertising with the following parameters: + * o General discoverable mode. + * o Undirected connectable mode. + */ +static void +bleprph_advertise(void) +{ + struct ble_gap_adv_params adv_params; + struct ble_hs_adv_fields fields; + const char *name; + int rc; + + /** + * Set the advertisement data included in our advertisements: + * o Flags (indicates advertisement type and other general info). + * o Advertising tx power. + * o Device name. + * o 16-bit service UUIDs (alert notifications). + */ + + memset(&fields, 0, sizeof fields); + + /* Advertise two flags: + * o Discoverability in forthcoming advertisement (general) + * o BLE-only (BR/EDR unsupported). + */ + fields.flags = BLE_HS_ADV_F_DISC_GEN | + BLE_HS_ADV_F_BREDR_UNSUP; + + /* Indicate that the TX power level field should be included; have the + * stack fill this value automatically. This is done by assigning the + * special value BLE_HS_ADV_TX_PWR_LVL_AUTO. + */ + fields.tx_pwr_lvl_is_present = 1; + fields.tx_pwr_lvl = BLE_HS_ADV_TX_PWR_LVL_AUTO; + + name = ble_svc_gap_device_name(); + fields.name = (uint8_t *)name; + fields.name_len = strlen(name); + fields.name_is_complete = 1; + + fields.uuids16 = (ble_uuid16_t[]) { + BLE_UUID16_INIT(LE_PHY_UUID16) + }; + fields.num_uuids16 = 1; + fields.uuids16_is_complete = 1; + + rc = ble_gap_adv_set_fields(&fields); + if (rc != 0) { + MODLOG_DFLT(ERROR, "error setting advertisement data; rc=%d\n", rc); + return; + } + + /* Begin advertising. */ + memset(&adv_params, 0, sizeof adv_params); + adv_params.conn_mode = BLE_GAP_CONN_MODE_UND; + adv_params.disc_mode = BLE_GAP_DISC_MODE_GEN; + rc = ble_gap_adv_start(own_addr_type, NULL, BLE_HS_FOREVER, + &adv_params, bleprph_gap_event, NULL); + if (rc != 0) { + MODLOG_DFLT(ERROR, "error enabling advertisement; rc=%d\n", rc); + return; + } +} +#endif +/** + * The nimble host executes this callback when a GAP event occurs. The + * application associates a GAP event callback with each connection that forms. + * bleprph uses the same callback for all connections. + * + * @param event The type of event being signalled. + * @param ctxt Various information pertaining to the event. + * @param arg Application-specified argument; unused by + * bleprph. + * + * @return 0 if the application successfully handled the + * event; nonzero on failure. The semantics + * of the return code is specific to the + * particular GAP event being signalled. + */ +static int +bleprph_gap_event(struct ble_gap_event *event, void *arg) +{ + struct ble_gap_conn_desc desc; + int rc; + + switch (event->type) { + case BLE_GAP_EVENT_CONNECT: + /* A new connection was established or a connection attempt failed. */ + MODLOG_DFLT(INFO, "connection %s; status=%d ", + event->connect.status == 0 ? "established" : "failed", + event->connect.status); + if (event->connect.status == 0) { + rc = ble_gap_conn_find(event->connect.conn_handle, &desc); + assert(rc == 0); + bleprph_print_conn_desc(&desc); + } + MODLOG_DFLT(INFO, "\n"); + + if (event->connect.status != 0) { + /* Connection failed; resume advertising. */ +#if CONFIG_EXAMPLE_EXTENDED_ADV + ext_bleprph_advertise(); +#else + bleprph_advertise(); +#endif + } + return 0; + + case BLE_GAP_EVENT_DISCONNECT: + MODLOG_DFLT(INFO, "disconnect; reason=%d ", event->disconnect.reason); + bleprph_print_conn_desc(&event->disconnect.conn); + MODLOG_DFLT(INFO, "\n"); + + /* Connection terminated; resume advertising. */ + +#if CONFIG_EXAMPLE_EXTENDED_ADV + switch (s_current_phy) { + case BLE_HCI_LE_PHY_1M_PREF_MASK: + /* Setting current phy to create connection on 2M PHY */ + s_current_phy = BLE_HCI_LE_PHY_2M_PREF_MASK; + break; + + case BLE_HCI_LE_PHY_2M_PREF_MASK: + /* Setting current phy to create connection on CODED PHY */ + s_current_phy = BLE_HCI_LE_PHY_CODED_PREF_MASK; + break; + + case BLE_HCI_LE_PHY_CODED_PREF_MASK: + return 0; + + default: + return 0; + } + set_default_le_phy_before_conn(s_current_phy, s_current_phy); + ext_bleprph_advertise(); +#else + bleprph_advertise(); +#endif + return 0; + + case BLE_GAP_EVENT_CONN_UPDATE: + /* The central has updated the connection parameters. */ + MODLOG_DFLT(INFO, "connection updated; status=%d ", + event->conn_update.status); + rc = ble_gap_conn_find(event->conn_update.conn_handle, &desc); + assert(rc == 0); + bleprph_print_conn_desc(&desc); + MODLOG_DFLT(INFO, "\n"); + return 0; + + case BLE_GAP_EVENT_ADV_COMPLETE: + MODLOG_DFLT(INFO, "advertise complete; reason=%d", + event->adv_complete.reason); +#if !CONFIG_EXAMPLE_EXTENDED_ADV + bleprph_advertise(); +#endif + return 0; + + case BLE_GAP_EVENT_PHY_UPDATE_COMPLETE: + MODLOG_DFLT(INFO, "LE PHY Update completed; status=%d conn_handle=%d tx_phy=%d " + "rx_phy = %d\n", event->phy_updated.status, + event->phy_updated.conn_handle, event->phy_updated.tx_phy, + event->phy_updated.rx_phy); + return 0; + } + + return 0; +} + +static void +bleprph_on_reset(int reason) +{ + MODLOG_DFLT(ERROR, "Resetting state; reason=%d\n", reason); +} + +static void +bleprph_on_sync(void) +{ + int rc; + + /* Make sure we have proper identity address set (public preferred) */ + rc = ble_hs_util_ensure_addr(0); + assert(rc == 0); + + /* Figure out address to use while advertising (no privacy for now) */ + rc = ble_hs_id_infer_auto(0, &own_addr_type); + if (rc != 0) { + MODLOG_DFLT(ERROR, "error determining address type; rc=%d\n", rc); + return; + } + + /* Printing ADDR */ + uint8_t addr_val[6] = {0}; + rc = ble_hs_id_copy_addr(own_addr_type, addr_val, NULL); + + MODLOG_DFLT(INFO, "Device Address: "); + print_addr(addr_val); + MODLOG_DFLT(INFO, "\n"); + + s_current_phy = BLE_HCI_LE_PHY_1M_PREF_MASK; + + /* Begin advertising. */ +#if CONFIG_EXAMPLE_EXTENDED_ADV + ext_bleprph_advertise(); +#else + bleprph_advertise(); +#endif +} + +void bleprph_host_task(void *param) +{ + ESP_LOGI(tag, "BLE Host Task Started"); + /* This function will return only when nimble_port_stop() is executed */ + nimble_port_run(); + + nimble_port_freertos_deinit(); +} + +void +app_main(void) +{ + int rc; + + /* Initialize NVS — it is used to store PHY calibration data */ + esp_err_t ret = nvs_flash_init(); + if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) { + ESP_ERROR_CHECK(nvs_flash_erase()); + ret = nvs_flash_init(); + } + ESP_ERROR_CHECK(ret); + + //ESP_ERROR_CHECK(esp_nimble_hci_and_controller_init()); + + nimble_port_init(); + /* Initialize the NimBLE host configuration. */ + ble_hs_cfg.reset_cb = bleprph_on_reset; + ble_hs_cfg.sync_cb = bleprph_on_sync; + ble_hs_cfg.gatts_register_cb = gatt_svr_register_cb; + ble_hs_cfg.store_status_cb = ble_store_util_status_rr; + + ble_hs_cfg.sm_io_cap = CONFIG_EXAMPLE_IO_TYPE; +#ifdef CONFIG_EXAMPLE_BONDING + ble_hs_cfg.sm_bonding = 1; +#endif +#ifdef CONFIG_EXAMPLE_MITM + ble_hs_cfg.sm_mitm = 1; +#endif +#ifdef CONFIG_EXAMPLE_USE_SC + ble_hs_cfg.sm_sc = 1; +#else + ble_hs_cfg.sm_sc = 0; +#endif +#ifdef CONFIG_EXAMPLE_BONDING + ble_hs_cfg.sm_our_key_dist = 1; + ble_hs_cfg.sm_their_key_dist = 1; +#endif + + rc = gatt_svr_init_le_phy(); + assert(rc == 0); + + /* Set the default device name. */ + rc = ble_svc_gap_device_name_set("bleprph-phy"); + assert(rc == 0); + + /* XXX Need to have template for store */ + ble_store_config_init(); + + nimble_port_freertos_init(bleprph_host_task); + + /* Initialize command line interface to accept input from user */ + rc = scli_init(); + if (rc != ESP_OK) { + ESP_LOGE(tag, "scli_init() failed"); + } +} diff --git a/examples/bluetooth/nimble/ble_phy/phy_prph/main/phy_prph.h b/examples/bluetooth/nimble/ble_phy/phy_prph/main/phy_prph.h new file mode 100644 index 000000000000..b9f8a667e0f3 --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_prph/main/phy_prph.h @@ -0,0 +1,32 @@ +/* + * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ + +#ifndef H_PHY_PRPH_ +#define H_PHY_PRPH_ + +#include +#include "nimble/ble.h" +#include "modlog/modlog.h" +#include "esp_peripheral.h" +#ifdef __cplusplus +extern "C" { +#endif + +struct ble_hs_cfg; +struct ble_gatt_register_ctxt; + +/** Making sure client connects to server having LE PHY UUID */ +#define LE_PHY_UUID16 0xABF2 +#define LE_PHY_CHR_UUID16 0xABF3 + +void gatt_svr_register_cb(struct ble_gatt_register_ctxt *ctxt, void *arg); +int gatt_svr_init_le_phy(void); + +#ifdef __cplusplus +} +#endif + +#endif diff --git a/examples/bluetooth/nimble/ble_phy/phy_prph/sdkconfig.defaults b/examples/bluetooth/nimble/ble_phy/phy_prph/sdkconfig.defaults new file mode 100644 index 000000000000..81960c10799d --- /dev/null +++ b/examples/bluetooth/nimble/ble_phy/phy_prph/sdkconfig.defaults @@ -0,0 +1,13 @@ +# Override some defaults so BT stack is enabled +# in this example + +# +# BT config +# +CONFIG_BT_ENABLED=y +CONFIG_BTDM_CTRL_MODE_BLE_ONLY=y +CONFIG_BTDM_CTRL_MODE_BR_EDR_ONLY=n +CONFIG_BTDM_CTRL_MODE_BTDM=n +CONFIG_BT_BLUEDROID_ENABLED=n +CONFIG_BT_NIMBLE_ENABLED=y +CONFIG_BT_NIMBLE_EXT_ADV=y