Skip to content

Commit bf95ad4

Browse files
Thalleykartben
authored andcommitted
docs: Rename BLE to Bluetooth (LE) where applicable
The BLE acronym is not an official description of Bluetooth LE, and the Bluetooth SIG only ever refers to it as Bluetooth Low Energy or Bluetooth LE, so Zephyr should as well. This commit does not change any board or vendor specific documentation, and the term BLE may still be used in those. It will be up to the vendors to update it if they want, since many of them are using the term BLE in their products. Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
1 parent e6c5f4d commit bf95ad4

File tree

12 files changed

+52
-53
lines changed

12 files changed

+52
-53
lines changed

doc/connectivity/bluetooth/api/hci.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -805,7 +805,7 @@ event shall be generated.
805805
Zephyr Write Tx Power Level (per Role/Connection) Command
806806
=========================================================
807807

808-
This command dynamically modifies BLE Tx power level given a handle and a
808+
This command dynamically modifies Bluetooth Tx power level given a handle and a
809809
handle type (advertiser, scanner, connection).
810810

811811
+--------------------------+-------+--------------------+--------------------+
@@ -818,8 +818,8 @@ handle type (advertiser, scanner, connection).
818818
| | | | Selected_Tx_Power |
819819
+--------------------------+-------+--------------------+--------------------+
820820

821-
The Tx power of the BLE radio interface is modified for any low-level link by
822-
the controller with a high degree of flexibility. The BLE link whose power is
821+
The Tx power of the Bluetooth radio interface is modified for any low-level link by
822+
the controller with a high degree of flexibility. The Bluetooth link whose power is
823823
set is identified based on a handle type (advertiser, scanner, connection) and
824824
handle pair.
825825

@@ -927,10 +927,10 @@ event shall be generated.
927927
Zephyr Read Tx Power Level (per Role/Connection) Command
928928
========================================================
929929

930-
This command reads the BLE Tx power level. In contrast to the standardized HCI
930+
This command reads the Bluetooth Tx power level. In contrast to the standardized HCI
931931
command, i.e. Read_Transmit_Power_Level, which returns the transmitted power
932932
level only for a specified connection handle, this command operates for both
933-
connected and unconnected states. It gets the BLE Tx power level for any given
933+
connected and unconnected states. It gets the Bluetooth Tx power level for any given
934934
handle type (advertiser, scanner, connection) and handle.
935935

936936
+--------------------------+-------+--------------------+--------------------+
@@ -943,7 +943,7 @@ handle type (advertiser, scanner, connection) and handle.
943943
| | | | Tx_Power_Level |
944944
+--------------------------+-------+--------------------+--------------------+
945945

946-
The Tx power of the BLE radio interface used for a low-level link identified
946+
The Tx power of the Bluetooth radio interface used for a low-level link identified
947947
by a pair of Handle_Type and Handle is retrieved from the controller.
948948

949949
The role/state defining input parameter is the Handle_Type, whereas its

doc/connectivity/bluetooth/bluetooth-arch.rst

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,14 @@ This page describes the software architecture of Zephyr's Bluetooth protocol
1010
stack.
1111

1212
.. note::
13-
Zephyr supports mainly Bluetooth Low Energy (BLE), the low-power
13+
Zephyr supports mainly Bluetooth Low Energy (LE), the low-power
1414
version of the Bluetooth specification. Zephyr also has limited support
15-
for portions of the BR/EDR Host. Throughout this architecture document we
16-
use BLE interchangeably for Bluetooth except when noted.
15+
for portions of the BR/EDR Host.
1716

1817
.. _bluetooth-layers:
1918

20-
BLE Layers
21-
==========
19+
Bluetooth LE Layers
20+
===================
2221

2322
There are 3 main layers that together constitute a full Bluetooth Low Energy
2423
protocol stack:
@@ -62,7 +61,7 @@ following configurations are commonly used:
6261

6362
* **Single-chip configuration**: In this configuration, a single microcontroller
6463
implements all three layers and the application itself. This can also be called a
65-
system-on-chip (SoC) implementation. In this case the BLE Host and the BLE
64+
system-on-chip (SoC) implementation. In this case the Bluetooth Host and the Bluetooth
6665
Controller communicate directly through function calls and queues in RAM. The
6766
Bluetooth specification does not specify how HCI is implemented in this
6867
single-chip configuration and so how HCI commands, events, and data flows between
@@ -75,11 +74,11 @@ following configurations are commonly used:
7574
configuration. This configuration allows for a wider variety of combinations of
7675
Hosts when using the Zephyr OS as a Controller. Since HCI ensures
7776
interoperability among Host and Controller implementations, including of course
78-
Zephyr's very own BLE Host and Controller, users of the Zephyr Controller can
77+
Zephyr's very own Bluetooth Host and Controller, users of the Zephyr Controller can
7978
choose to use whatever Host running on any platform they prefer. For example,
80-
the host can be the Linux BLE Host stack (BlueZ) running on any processor
79+
the host can be the Linux Bluetooth Host stack (BlueZ) running on any processor
8180
capable of supporting Linux. The Host processor may of course also run Zephyr
82-
and the Zephyr OS BLE Host. Conversely, combining an IC running the Zephyr
81+
and the Zephyr OS Bluetooth Host. Conversely, combining an IC running the Zephyr
8382
Host with an external Controller that does not run Zephyr is also supported.
8483

8584
.. _bluetooth-build-types:
@@ -88,12 +87,12 @@ Build Types
8887
===========
8988

9089
The Zephyr software stack as an RTOS is highly configurable, and in particular,
91-
the BLE subsystem can be configured in multiple ways during the build process to
90+
the Bluetooth subsystem can be configured in multiple ways during the build process to
9291
include only the features and layers that are required to reduce RAM and ROM
9392
footprint as well as power consumption. Here's a short list of the different
94-
BLE-enabled builds that can be produced from the Zephyr project codebase:
93+
Bluetooth-enabled builds that can be produced from the Zephyr project codebase:
9594

96-
* **Controller-only build**: When built as a BLE Controller, Zephyr includes
95+
* **Controller-only build**: When built as a Bluetooth Controller, Zephyr includes
9796
the Link Layer and a special application. This application is different
9897
depending on the physical transport chosen for HCI:
9998

@@ -114,7 +113,7 @@ BLE-enabled builds that can be produced from the Zephyr project codebase:
114113
corresponding device tree node is enabled.
115114

116115
* **Host-only build**: A Zephyr OS Host build will contain the Application and
117-
the BLE Host, along with an HCI driver (UART or SPI) to interface with an
116+
the Bluetooth Host, along with an HCI driver (UART or SPI) to interface with an
118117
external Controller chip.
119118
A build of this type sets the following Kconfig option values:
120119

@@ -143,12 +142,12 @@ BLE-enabled builds that can be produced from the Zephyr project codebase:
143142
used for Controller-only builds can be built as Combined
144143

145144
The picture below shows the SoC or single-chip configuration when using a Zephyr
146-
combined build (a build that includes both a BLE Host and a Controller in the
145+
combined build (a build that includes both a Bluetooth Host and a Controller in the
147146
same firmware image that is programmed onto the chip):
148147

149148
.. figure:: img/ble_cfg_single.png
150149
:align: center
151-
:alt: BLE Combined build on a single chip
150+
:alt: Bluetooth Combined build on a single chip
152151

153152
A Combined build on a Single-Chip configuration
154153

@@ -157,25 +156,25 @@ combinations are possible, some of which are depicted below:
157156

158157
.. figure:: img/ble_cfg_dual.png
159158
:align: center
160-
:alt: BLE dual-chip configuration builds
159+
:alt: Bluetooth dual-chip configuration builds
161160

162161
Host-only and Controller-only builds on dual-chip configurations
163162

164163
When using a Zephyr Host (left side of image), two instances of Zephyr OS
165164
must be built with different configurations, yielding two separate images that
166165
must be programmed into each of the chips respectively. The Host build image
167-
contains the application, the BLE Host and the selected HCI driver (UART or
166+
contains the application, the Bluetooth Host and the selected HCI driver (UART or
168167
SPI), while the Controller build runs either the
169168
:zephyr:code-sample:`bluetooth_hci_uart`, or the
170169
:zephyr:code-sample:`bluetooth_hci_spi` app to provide an interface to
171-
the BLE Controller.
170+
the Bluetooth Controller.
172171

173172
This configuration is not limited to using a Zephyr OS Host, as the right side
174173
of the image shows. One can indeed take one of the many existing GNU/Linux
175-
distributions, most of which include Linux's own BLE Host (BlueZ), to connect it
174+
distributions, most of which include Linux's own Bluetooth Host (BlueZ), to connect it
176175
via UART or USB to one or more instances of the Zephyr OS Controller build.
177176
BlueZ as a Host supports multiple Controllers simultaneously for applications
178-
that require more than one BLE radio operating at the same time but sharing the
177+
that require more than one Bluetooth radio operating at the same time but sharing the
179178
same Host stack.
180179

181180
Source tree layout

doc/connectivity/bluetooth/bluetooth-dev.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ Simulated nRF5x with BabbleSim
139139
The :ref:`nrf52_bsim <nrf52_bsim>` and :ref:`nrf5340bsim <nrf5340bsim>` boards,
140140
are simulated target boards
141141
which emulate the necessary peripherals of a nRF52/53 SOC to be able to develop
142-
and test BLE applications.
142+
and test Bluetooth LE applications.
143143
These boards, use:
144144

145145
* `BabbleSim`_ to simulate the nRF5x modem and the radio environment.

doc/connectivity/bluetooth/bluetooth-le-host.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ host, and vice-versa.
2121

2222
Perhaps the most important block above the HCI handling is the Generic
2323
Access Profile (GAP). GAP simplifies Bluetooth LE access by defining
24-
four distinct roles of BLE usage:
24+
four distinct roles of Bluetooth usage:
2525

2626
* Connection-oriented roles
2727

@@ -31,9 +31,9 @@ four distinct roles of BLE usage:
3131

3232
* Connection-less roles
3333

34-
* Broadcaster (sending out BLE advertisements, e.g. a smart beacon)
34+
* Broadcaster (sending out Bluetooth LE advertisements, e.g. a smart beacon)
3535

36-
* Observer (scanning for BLE advertisements)
36+
* Observer (scanning for Bluetooth LE advertisements)
3737

3838
Each role comes with its own build-time configuration option:
3939
:kconfig:option:`CONFIG_BT_PERIPHERAL`, :kconfig:option:`CONFIG_BT_CENTRAL`,
@@ -49,7 +49,7 @@ section.
4949
Peripheral role
5050
===============
5151

52-
Most Zephyr-based BLE devices will most likely be peripheral-role
52+
Most Zephyr-based Bluetooth LE devices will most likely be peripheral-role
5353
devices. This means that they perform connectable advertising and expose
5454
one or more GATT services. After registering services using the
5555
:c:func:`bt_gatt_service_register` API the application will typically

doc/connectivity/bluetooth/bluetooth-tools.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Using BlueZ with Zephyr
4040
***********************
4141

4242
The Linux Bluetooth Protocol Stack, BlueZ, comes with a very useful set of
43-
tools that can be used to debug and interact with Zephyr's BLE Host and
43+
tools that can be used to debug and interact with Zephyr's Bluetooth Host and
4444
Controller. In order to benefit from these tools you will need to make sure
4545
that you are running a recent version of the Linux Kernel and BlueZ:
4646

@@ -62,7 +62,7 @@ You can then find :file:`btattach`, :file:`btmgt` and :file:`btproxy` in the
6262
:file:`tools/` folder and :file:`btmon` in the :file:`monitor/` folder.
6363

6464
You'll need to enable BlueZ's experimental features so you can access its
65-
most recent BLE functionality. Do this by editing the file
65+
most recent Bluetooth functionality. Do this by editing the file
6666
:file:`/lib/systemd/system/bluetooth.service`
6767
and making sure to include the :literal:`-E` option in the daemon's execution
6868
start line:
@@ -160,11 +160,11 @@ building and running a sample:
160160

161161
$ sudo ./build/zephyr/zephyr.exe --bt-dev=hci0
162162

163-
Using a Zephyr-based BLE Controller
164-
===================================
163+
Using a Zephyr-based Bluetooth Controller
164+
=========================================
165165

166166
Depending on which hardware you have available, you can choose between two
167-
transports when building a single-mode, Zephyr-based BLE Controller:
167+
transports when building a single-mode, Zephyr-based Bluetooth Controller:
168168

169169
* UART: Use the :zephyr:code-sample:`bluetooth_hci_uart` sample and follow
170170
the instructions in :ref:`bluetooth-hci-uart-qemu-posix`.
@@ -309,7 +309,7 @@ peripheral samples such as :zephyr:code-sample:`ble_peripheral_hr` or
309309
Using Zephyr-based Controllers with BlueZ
310310
*****************************************
311311

312-
If you want to test a Zephyr-powered BLE Controller using BlueZ's Bluetooth
312+
If you want to test a Zephyr-powered Bluetooth Controller using BlueZ's Bluetooth
313313
Host, you will need a few tools described in the :ref:`bluetooth_bluez` section.
314314
Once you have installed the tools you can then use them to interact with your
315315
Zephyr-based controller:

doc/connectivity/bluetooth/features.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ Supported features
88
:depth: 2
99

1010
Since its inception, Zephyr has had a strong focus on Bluetooth and, in
11-
particular, on Bluetooth Low Energy (BLE). Through the contributions of
11+
particular, on Bluetooth Low Energy (LE). Through the contributions of
1212
several companies and individuals involved in existing open source
1313
implementations of the Bluetooth specification (Linux's BlueZ) as well as the
14-
design and development of BLE radio hardware, the protocol stack in Zephyr has
14+
design and development of Bluetooth LE radio hardware, the protocol stack in Zephyr has
1515
grown to be mature and feature-rich, as can be seen in the section below.
1616

1717
* Bluetooth v5.3 compliant
@@ -41,7 +41,7 @@ grown to be mature and feature-rich, as can be seen in the section below.
4141
* All v5.3 specification features supported (except a few minor items)
4242
* Concurrent multi-protocol support ready
4343
* Intelligent scheduling of roles to minimize overlap
44-
* Portable design to any open BLE radio, currently supports Nordic
44+
* Portable design to any open Bluetooth LE radio, currently supports Nordic
4545
Semiconductor nRF52x and nRF53x SoC Series, as well as proprietary radios
4646
* Supports little and big endian architectures, and abstracts the hard
4747
real-time specifics so that they can be encapsulated in a hardware-specific

doc/develop/test/bsim.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ BabbleSim and Zephyr
77
********************
88

99
In the Zephyr project we use the `Babblesim`_ simulator to test some of the Zephyr radio protocols,
10-
including the BLE stack, 802.15.4, and some of the networking stack.
10+
including the Bluetooth LE stack, 802.15.4, and some of the networking stack.
1111

1212
BabbleSim_ is a physical layer simulator, which in combination with the Zephyr
1313
:ref:`bsim boards<bsim boards>`
14-
can be used to simulate a network of BLE and 15.4 devices.
14+
can be used to simulate a network of Bluetooth LE and 15.4 devices.
1515
When we build Zephyr targeting a :ref:`bsim board<bsim boards>` we produce a Linux
1616
executable, which includes the application, Zephyr OS, and models of the HW.
1717

doc/hardware/porting/board_porting.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ The mandatory files are:
281281
#. :file:`plank_<qualifiers>.dts`: a hardware description
282282
in :ref:`devicetree <dt-guide>` format. This declares your SoC, connectors,
283283
and any other hardware components such as LEDs, buttons, sensors, or
284-
communication peripherals (USB, BLE controller, etc).
284+
communication peripherals (USB, Bluetooth controller, etc).
285285

286286
#. :file:`Kconfig.plank`: the base software configuration for selecting SoC and
287287
other board and SoC related settings. Kconfig settings outside of the board

doc/security/vulnerabilities.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1599,8 +1599,8 @@ This has been fixed in main for v3.6.0
15991599
:cve:`2024-3077`
16001600
----------------
16011601

1602-
Bluetooth: Integer underflow in gatt_find_info_rsp. A malicious BLE
1603-
device can crash BLE victim device by sending malformed gatt packet.
1602+
Bluetooth: Integer underflow in gatt_find_info_rsp. A malicious Bluetooth LE
1603+
device can crash Bluetooth LE victim device by sending malformed gatt packet.
16041604

16051605
- `Zephyr project bug tracker GHSA-gmfv-4vfh-2mh8
16061606
<https://github.com/zephyrproject-rtos/zephyr/security/advisories/GHSA-gmfv-4vfh-2mh8>`_
@@ -1615,8 +1615,8 @@ This has been fixed in main for v3.7.0
16151615

16161616
Bluetooth: DoS caused by null pointer dereference.
16171617

1618-
A malicious BLE device can send a specific order of packet
1619-
sequence to cause a DoS attack on the victim BLE device.
1618+
A malicious Bluetooth LE device can send a specific order of packet
1619+
sequence to cause a DoS attack on the victim Bluetooth LE device.
16201620

16211621
- `Zephyr project bug tracker GHSA-jmr9-xw2v-5vf4
16221622
<https://github.com/zephyrproject-rtos/zephyr/security/advisories/GHSA-jmr9-xw2v-5vf4>`_

doc/services/device_mgmt/mcumgr.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The following management operations are available:
1919

2020
over the following transports:
2121

22-
* BLE (Bluetooth Low Energy)
22+
* Bluetooth Low Energy (LE)
2323
* Serial (UART)
2424
* UDP over IP
2525

@@ -32,7 +32,7 @@ The management subsystem is located in :zephyr_file:`subsys/mgmt/` inside of
3232
the Zephyr tree.
3333

3434
Additionally, there is a :zephyr:code-sample:`sample <smp-svr>` server that provides
35-
management functionality over BLE and serial.
35+
management functionality over Bluetooth LE and serial.
3636

3737
.. _mcumgr_tools_libraries:
3838

0 commit comments

Comments
 (0)