From 87f54e0918f2d376a98072f6beefa3cc75847eab Mon Sep 17 00:00:00 2001 From: Szymon Janc Date: Tue, 17 Mar 2026 12:05:48 +0100 Subject: [PATCH] doc: Update documentation with non-deprecated options Some files were refering to deprecated configuration options. --- docs/ble_setup/ble_addr.rst | 6 +++--- docs/ble_setup/ble_lp_clock.rst | 16 ++++++++-------- nimble/drivers/dialog_cmac/README.md | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/ble_setup/ble_addr.rst b/docs/ble_setup/ble_addr.rst index bfd49923b..f2cadca79 100644 --- a/docs/ble_setup/ble_addr.rst +++ b/docs/ble_setup/ble_addr.rst @@ -28,7 +28,7 @@ Method 2: Hardcode a public address in the Mynewt target The NimBLE controller package exports a :doc:`syscfg <../../../os/modules/sysinitconfig/sysinitconfig>` setting -called ``BLE_PUBLIC_DEV_ADDR``. This setting can be overridden at the +called ``BLE_LL_PUBLIC_DEV_ADDRR``. This setting can be overridden at the application or target level to configure a public Bluetooth address. For example, a target can assign the public address *11:22:33:44:55:66* as follows: @@ -36,7 +36,7 @@ follows: :: syscfg.vals: - BLE_PUBLIC_DEV_ADDR: '(uint8_t[6]){0x66, 0x55, 0x44, 0x33, 0x22, 0x11}' + BLE_LL_PUBLIC_DEV_ADDRR: 0x112233445566 This setting takes the form of a C expression. Specifically, the value is a designated initializer expressing a six-byte array. Also note that @@ -44,7 +44,7 @@ the bytes are reversed, as an array is inherently little-endian, while addresses are generally expressed in big-endian. Note: this method takes precedence over method 1. Whatever is written to -the ``BLE_PUBLIC_DEV_ADDR`` setting is the address that gets used. +the ``BLE_LL_PUBLIC_DEV_ADDRR`` setting is the address that gets used. Method 3: Configure a random address at runtime ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/ble_setup/ble_lp_clock.rst b/docs/ble_setup/ble_lp_clock.rst index 34a967fec..b39bb919e 100644 --- a/docs/ble_setup/ble_lp_clock.rst +++ b/docs/ble_setup/ble_lp_clock.rst @@ -6,7 +6,7 @@ controller. Since the code of controller is optimized to work with 32768 Hz clock, the OS cputime has to be configured accordingly. To make things easier, controller package (``net/nimble/controller``) -defines new system configuration setting ``BLE_LP_CLOCK`` as sets it to +defines new system configuration setting ``BLE_CONTROLLER`` as sets it to ``1`` so other packages can be configured if necessary. The next section describes configuration required for controller to work properly. @@ -14,7 +14,7 @@ System configuration ~~~~~~~~~~~~~~~~~~~~ **Note:** All BSPs based on nRF5x have below settings automatically -applied when ``BLE_LP_CLOCK`` is set, there is no need to configure this +applied when ``BLE_CONTROLLER`` is set, there is no need to configure this in application. The following things need to be configured for NimBLE controller to work @@ -38,26 +38,26 @@ as below: OS_CPUTIME_TIMER_NUM: 5 TIMER_0: 0 TIMER_5: 1 - BLE_XTAL_SETTLE_TIME: 1500 + BLE_LL_RFMGMT_ENABLE_TIME: 1500 On nRF51 platform the only difference is to use timer 3 instead of timer 5. On platforms without 32768 Hz crystal available it usually can be -synthesized by setting ``XTAL_32768_SYNTH`` to ``1`` - this is also +synthesized by setting ``MCU_LFCLK_SOURCE`` to ``LFSYNTH`` - this is also already configured in existing BSPs. Crystal settle time configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The configuration variable ``BLE_XTAL_SETTLE_TIME`` is used by the +The configuration variable ``BLE_LL_RFMGMT_ENABLE_TIME`` is used by the controller to turn on the necessary clock source(s) for the radio and associated peripherals prior to Bluetooth events (advertising, scanning, connections, etc). For the nRF5x platforms, the HFXO needs to be turned -on prior to using the radio and the ``BLE_XTAL_SETTLE_TIME`` must be set -to accommodate this time. The amount of time required is board +on prior to using the radio and the ``BLE_LL_RFMGMT_ENABLE_TIME`` must be +set to accommodate this time. The amount of time required is board dependent, so users must characterize their hardware and set -``BLE_XTAL_SETTLE_TIME`` accordingly. The current value of 1500 +``BLE_LL_RFMGMT_ENABLE_TIME`` accordingly. The current value of 1500 microseconds is a fairly long time and was intended to work for most, if not all, platforms. diff --git a/nimble/drivers/dialog_cmac/README.md b/nimble/drivers/dialog_cmac/README.md index 2e76e2c16..31b64ed30 100644 --- a/nimble/drivers/dialog_cmac/README.md +++ b/nimble/drivers/dialog_cmac/README.md @@ -39,7 +39,7 @@ target used. Target for M33 should be set and configured as any other BLE application. In order to use NimBLE controller on CMAC, set proper HCI transport via syscfg: - BLE_HCI_TRANSPORT: dialog_cmac + BLE_TRANSPORT_HS: dialog_cmac This will include proper transport, driver and add M0+ target to build process.