Bluetooth: Host: Deprecate old Bluetooth device name APIs

The following Kconfig APIs are deprecated:

- `CONFIG_BT_DEVICE_NAME`
- `CONFIG_BT_DEVICE_DYNAMIC`
- `CONFIG_BT_DEVICE_NAME_MAX`

The following C APIs are deprecated:

- `bt_get_name()`
- `bt_set_name()`

They are deprecated because the current APIs are not thread safe and can
be confusing.

The Kconfig APIs are replaced by the `BT_GAP_DEVICE_NAME_TYPE` choice.
When selecting `CONFIG_BT_GAP_DEVICE_NAME_STATIC`, the name must be set
using `CONFIG_BT_GAP_DEVICE_NAME`.

When selecting `CONFIG_BT_GAP_DEVICE_NAME_DYNAMIC`, the GAP device name
must be set using `bt_gap_set_device_name()` and retrieved using
`bt_gap_get_device_name()`. The the maximum size of the GAP device name
can now be set using `CONFIG_BT_GAP_DEVICE_NAME_DYNAMIC_MAX`.

Signed-off-by: Théo Battrel <[email protected]>

Author: theob-pro

doc/releases/release-notes-4.2.rst

@@ -99,6 +99,15 @@ Deprecated APIs and options
 * ``xiao_esp32c6`` board target has been deprecated and renamed to
   ``xiao_esp32c6/esp32c6/hpcore``.
 
+* The :c:func:`bt_get_name` and :c:func:`bt_set_name` are deprecated in favor of
+  the new :c:func:`bt_gap_get_device_name` and :c:func:`bt_gap_set_device_name`.
+  :kconfig:option:`CONFIG_BT_DEVICE_NAME`,
+  :kconfig:option:`CONFIG_BT_DEVICE_NAME_DYNAMIC` and
+  :kconfig:option:`CONFIG_BT_DEVICE_NAME_MAX` are deprecated in favor of
+  :kconfig:option:`CONFIG_BT_GAP_DEVICE_NAME`,
+  :kconfig:option:`CONFIG_BT_GAP_DEVICE_NAME_DYNAMIC` and
+  :kconfig:option:`CONFIG_BT_GAP_DEVICE_NAME_DYNAMIC_MAX`.
+
 New APIs and options
 ====================
 

include/zephyr/bluetooth/bluetooth.h

@@ -359,7 +359,7 @@ bool bt_is_ready(void);
  *
  * @return Zero on success or (negative) error code otherwise.
  */
-int bt_set_name(const char *name);
+__deprecated int bt_set_name(const char *name);
 
 /**
  * @brief Get Bluetooth Device Name
@@ -368,7 +368,7 @@ int bt_set_name(const char *name);
  *
  * @return Bluetooth Device Name
  */
-const char *bt_get_name(void);
+__deprecated const char *bt_get_name(void);
 
 /**
  * @brief Get local Bluetooth appearance

subsys/bluetooth/host/Kconfig

@@ -862,13 +862,14 @@ config BT_SCAN_AND_INITIATE_IN_PARALLEL
 	  feature is enabled.
 
 config BT_DEVICE_NAME_DYNAMIC
-	bool "Allow to set Bluetooth device name on runtime"
+	bool "Allow to set Bluetooth device name on runtime [DEPRECATED]"
+	select DEPRECATED
 	help
 	  Enabling this option allows for runtime configuration of Bluetooth
 	  device name.
 
 config BT_DEVICE_NAME_MAX
-	int "Maximum size in bytes for device name"
+	int "Maximum size in bytes for device name [DEPRECATED]"
 	depends on BT_DEVICE_NAME_DYNAMIC
 	default 28
 	range 2 248
@@ -877,7 +878,7 @@ config BT_DEVICE_NAME_MAX
 	  long (excluding NULL termination).
 
 config BT_DEVICE_NAME
-	string "Bluetooth device name"
+	string "Bluetooth device name [DEPRECATED]"
 	default "Zephyr"
 	help
 	  Bluetooth device name. Name can be up to 248 bytes long (excluding