applications: nrf5340_audio: Multi-channel support unicast client

Changed when and how a client discovers a server.
Changed how a unicast group is created.
Added new ZBUS messages for Bluetooth LE events.
Now using CIS and CIG ID from the host.
Added server_store for handling unicast servers/headsets
Bonds will created a server entry in server_store.
Added test framework for server_store.
Prints and docs changed.
OCT-3290

Signed-off-by: Alexander Svensen <[email protected]>
Signed-off-by: Kristoffer Skøien <[email protected]>

Author: alexsven

applications/nrf5340_audio/Kconfig.defaults

@@ -15,7 +15,7 @@ config MAIN_STACK_SIZE
 	default 1600
 
 config SYSTEM_WORKQUEUE_STACK_SIZE
-	default 1200
+	default 2000
 
 # As long as thread names are used, config must be set to "y"
 config THREAD_NAME

applications/nrf5340_audio/broadcast_sink/README.rst

@@ -15,7 +15,7 @@ The following limitations apply to this application:
 * One BIG, one of the two BIS streams or a mixed stereo comprising of the two (selectable).
   See :file:`overlay-broadcast_sink.conf` for more information.
 * Audio output: I2S/Analog headset output.
-* Configuration: 16 bit, several bit rates ranging from 32 kbps to 124 kbps.
+* Configuration: 16-bit, several bit rates ranging from 32 kbps to 124 kbps.
 
 .. _nrf53_audio_broadcast_sink_app_requirements:
 
@@ -68,6 +68,18 @@ For other configuration options, see :ref:`nrf53_audio_app_configuration` and :r
 
 For information about how to configure applications in the |NCS|, see :ref:`configure_application`.
 
+.. _nrf53_audio_broadcast_sink_app_configuration_stereo:
+
+Stereo configuration
+====================
+
+The broadcast sink can receive audio from two BISes and play it on the left and right channels of the audio output.
+In this mode, the I2S output is stereo, but :zephyr:board:`nrf5340_audio_dk` still only has one audio output channel, since it has a mono codec (CS47L63).
+
+To configure stereo, program the :ref:`correct headset location <nrf53_audio_app_configuration_headset_location>` for each headset.
+
+See also :file:`overlay-broadcast_sink.conf` for more information.
+
 .. _nrf53_audio_broadcast_sink_app_building:
 
 Building and running

applications/nrf5340_audio/broadcast_source/README.rst

@@ -15,8 +15,8 @@ Play and pause are emulated by enabling and disabling stream, respectively.
 The following limitations apply to this application:
 
 * One BIG with two BIS streams.
-* Audio input: USB or I2S (Line in or using Pulse Density Modulation).
-* Configuration: 16 bit, several bit rates ranging from 32 kbps to 124 kbps.
+* Audio input: USB or I2S (Line-in or using Pulse Density Modulation).
+* Configuration: 16-bit, several bit rates ranging from 32 kbps to 124 kbps.
 
 .. _nrf53_audio_broadcast_source_app_requirements:
 

applications/nrf5340_audio/doc/adapting_application.rst

@@ -9,6 +9,11 @@ Adapting nRF5340 Audio applications for end products
 
 This page describes the relevant configuration sources and lists the steps required for adapting the :ref:`nrf53_audio_app` to end products.
 
+.. note::
+
+   Addresses and other sensitive information are printed for debug purposes.
+   This information must not be exposed in a final product.
+
 Board configuration sources
 ***************************
 

applications/nrf5340_audio/doc/audio_api.rst

@@ -72,6 +72,14 @@ Bluetooth Audio Rendering and Capture
 
 .. doxygengroup:: audio_app_bt_rendering_and_capture
 
+Bluetooth Content Control
+*************************
+
+| Header file: :file:`applications/nrf5340_audio/src/bluetooth/bt_content_control/bt_content_ctrl.h`
+| Source file: :file:`applications/nrf5340_audio/src/bluetooth/bt_content_control/bt_content_ctrl.c`
+
+.. doxygengroup:: audio_app_bt_content_ctrl
+
 Audio I2S
 *********
 

applications/nrf5340_audio/doc/building.rst

@@ -68,9 +68,9 @@ When preparing the JSON file, update the following fields:
   You can check this ten-digit number on the sticker on the nRF5340 Audio development kit.
   Alternatively, connect the development kit to your PC and run ``nrfutil device list`` in a command window to print the SEGGER serial number of all connected kits.
 * ``nrf5340_audio_dk_dev`` - This field assigns the specific nRF5340 Audio development kit to be ``headset`` or ``gateway``.
-* ``channel`` - This field is valid only for headsets.
-  It sets the channels on which the headset is meant to work.
-  When no channel is set, the headset is programmed as a left channel one.
+* ``location`` - This field is valid only for headsets.
+  It sets the location on which the headset is meant to work, especially when using the :ref:`default CIS transport mode configuration <nrf53_audio_transport_mode_configuration>`.
+  For more information, see :ref:`nrf53_audio_app_configuration_headset_location`.
 
 .. _nrf53_audio_app_building_script_running:
 
@@ -226,14 +226,14 @@ Application configuration files
 ===============================
 
 The application uses a :file:`prj.conf` configuration file located in the sample root directory for the default configuration.
-It also provides additional files for different custom configurations.
+It also uses application-specific overlay files and can use additional files for different custom configurations.
 When you build the sample, you can select one of these configurations using the :makevar:`FILE_SUFFIX` variable.
 
-See :ref:`app_build_file_suffixes` and :ref:`cmake_options` for more information.
+See :ref:`nrf53_audio_app_configuration_files`, :ref:`app_build_file_suffixes`, and :ref:`cmake_options` for more information.
 
-The application supports the following custom configurations:
+The application supports the following configuration files:
 
-.. list-table:: Application custom configurations
+.. list-table:: Application configurations
    :widths: auto
    :header-rows: 1
 
@@ -252,8 +252,24 @@ The application supports the following custom configurations:
    * - FOTA DFU
      - :file:`prj_fota.conf`
      - ``fota``
-     - | Builds the debug version of the application with the features needed to perform DFU over Bluetooth LE, and includes bootloaders so that the applications on both the application core and network core can be updated.
+     - | Builds the debug version of the application (:file:`prj.conf`) with the features needed to perform DFU over Bluetooth LE, and includes bootloaders so that the applications on both the application core and network core can be updated.
        | See :ref:`nrf53_audio_app_fota` for more information.
+   * - Application-specific overlay file
+     - :file:`unicast_server/overlay-unicast_server.conf`
+     - ``unicast_server``
+     - Configuration file for the unicast server application.
+   * - Application-specific overlay file
+     - :file:`unicast_client/overlay-unicast_client.conf`
+     - ``unicast_client``
+     - Configuration file for the unicast client application.
+   * - Application-specific overlay file
+     - :file:`broadcast_sink/overlay-broadcast_sink.conf`
+     - ``broadcast_sink``
+     - Configuration file for the broadcast sink application.
+   * - Application-specific overlay file
+     - :file:`broadcast_source/overlay-broadcast_source.conf`
+     - ``broadcast_source``
+     - Configuration file for the broadcast source application.
 
 .. _nrf53_audio_app_configuration_select_build:
 
@@ -302,25 +318,35 @@ The following command example builds the application for :ref:`nrf53_audio_app_f
 The command uses ``-DFILE_SUFFIX=fota`` to pick :file:`prj_fota.conf` instead of the default :file:`prj.conf`.
 It also uses the ``--pristine`` to clean the existing directory before starting the build process.
 
+.. _nrf53_audio_app_building_standard_programming:
+
 Programming the application
 ===========================
 
 After building the files for the development kit you want to program, follow the :ref:`standard procedure for programming applications <building>` in the |NCS|.
 
-When using the default CIS configuration, if you want to use two headset devices, you must also populate the UICR with the desired channel for each headset.
-Use the following commands, depending on which headset you want to populate:
+When using the :ref:`default CIS transport mode configuration <nrf53_audio_transport_mode_configuration>`, if you want to use two headset devices or the stereo configuration, you must :ref:`configure the headset location <nrf53_audio_app_configuration_headset_location>`.
+Use the combined bitfield values, depending on which headset you want to configure:
 
-* Left headset (``--value 0``):
+* Two headsets, left and right:
 
-   .. code-block:: console
+  * Left headset (``--value 1``):
 
-      nrfutil device x-write --address 0x00FF80F4 --value 0
+    .. code-block:: console
 
-* Right headset (``--value 1``):
+       nrfutil device x-write --address 0x00FF80F4 --value 1
 
-   .. code-block:: console
+  * Right headset (``--value 2``):
+
+    .. code-block:: console
+
+       nrfutil device x-write --address 0x00FF80F4 --value 2
+
+* One stereo headset (``--value 3``):
+
+  .. code-block:: console
 
-      nrfutil device x-write --address 0x00FF80F4 --value 1
+     nrfutil device x-write --address 0x00FF80F4 --value 3
 
 Select the correct board when prompted with the popup.
 Alternatively, you can add the ``--serial-number`` parameter followed by the SEGGER serial number of the correct board at the end of the ``nrfutil device`` command.

applications/nrf5340_audio/doc/configuration.rst

@@ -15,7 +15,7 @@ The nRF5340 Audio applications align the configuration with the nRF5340 Audio us
 Among others, the Kconfig options for Bluetooth, Zephyr's audio subsystems, and hardware peripherals are selected to ensure they are enabled.
 
 The :option:`CONFIG_NRF5340_AUDIO` option is the main Kconfig option that activates all nRF5340 Audio functionality.
-See the :file:`Kconfig.defaults` file for details related to the default common configuration.
+See the :file:`Kconfig.defaults` file in the :file:`nrf5340_audio` directory for details related to the default common configuration.
 
 .. note::
    Part of the default configuration is applied by modifying the default values of Kconfig options.
@@ -80,7 +80,7 @@ Enabling the walkie-talkie demo
 
 The walkie-talkie demo uses one or two bidirectional streams from the gateway to one or two headsets.
 The PDM microphone is used as input on both the gateway and headset device.
-To switch to using the walkie-talkie, set the :option:`CONFIG_WALKIE_TALKIE_DEMO` Kconfig option to ``y``  in the :file:`applications/nrf5340_audio/prj.conf` file (for the debug version) or in the :file:`applications/nrf5340_audio/prj_release.conf` file (for the release version).
+To switch to using the walkie-talkie, set the :option:`CONFIG_WALKIE_TALKIE_DEMO` Kconfig option to ``y`` in the :file:`applications/nrf5340_audio/prj.conf` file (for the debug version) or in the :file:`applications/nrf5340_audio/prj_release.conf` file (for the release version).
 
 Enabling the Auracast™ (broadcast) mode
 =======================================
@@ -93,7 +93,7 @@ Enabling the BIS mode with two gateways
 =======================================
 
 In addition to the standard BIS mode with one gateway, you can also add a second gateway device.
-The BIS headsets can then switch between the two gateways and receive audio stream from one of the two gateways.
+The BIS headsets can then switch between the two gateways and receive the audio stream from one of the two gateways.
 
 To configure the second gateway, add both the :option:`CONFIG_TRANSPORT_BIS` and the :option:`CONFIG_BT_AUDIO_USE_BROADCAST_NAME_ALT` Kconfig options set to ``y`` to the :file:`applications/nrf5340_audio/prj.conf` file for the debug version and to the :file:`applications/nrf5340_audio/prj_release.conf` file for the release version.
 You can provide an alternative name to the second gateway using the :option:`CONFIG_BT_AUDIO_BROADCAST_NAME_ALT` or use the default alternative name.
@@ -102,6 +102,62 @@ You build each BIS gateway separately using the normal procedures from :ref:`nrf
 After building the first gateway, configure the required Kconfig options for the second gateway and build the second gateway firmware.
 Remember to program the two firmware versions to two separate gateway devices.
 
+.. _nrf53_audio_app_configuration_headset_location:
+
+Configuring the headset location
+================================
+
+When using the :ref:`default CIS transport mode configuration <nrf53_audio_transport_mode_configuration>`, if you want to use two headset devices or the stereo configuration, you must also define the correct headset location.
+
+The nRF5340 Audio applications use audio location definitions from the Audio Location Definition chapter in the `Bluetooth Assigned Numbers`_ specification.
+These correspond to the bitfields in the :file:`bt_audio_location` enum in the :file:`zephyr/include/zephyr/bluetooth/assigned_numbers.h` file.
+When building the audio application, the location value is used to populate the UICR with the correct bitfield for each headset.
+
+You can set the location for each headset in the following ways, depending on the building and programming method:
+
+* When :ref:`nrf53_audio_app_building_script`, set the location for each headset in the :file:`nrf5340_audio_dk_devices.json` file.
+  Use the location labels from the Audio Location Definition chapter in the `Bluetooth Assigned Numbers`_ specification.
+  For example:
+
+  .. code-block:: json
+
+     [
+      {
+        "nrf5340_audio_dk_snr": 1000,
+        "nrf5340_audio_dk_dev": "headset",
+        "location": ["FRONT_LEFT"]
+      }
+     ]
+
+* When :ref:`nrf53_audio_app_building_standard`, set the location for each headset when running the :ref:`programming command <nrf53_audio_app_building_standard_programming>`.
+  Use the combined bitfield values from the :file:`zephyr/include/zephyr/bluetooth/assigned_numbers.h` file to define the headset location.
+  For example, if you want to use the stereo configuration, use the combined bitfield value of the left and right channels (``1`` and ``2``, respectively):
+
+  .. code-block:: console
+
+     nrfutil device x-write --address 0x00FF80F4 --value 3
+
+The following table lists some of the available locations and their bitfield values:
+
+.. list-table:: Example audio locations and their bitfield values
+   :header-rows: 1
+
+   * - Audio location
+     - Value from specification
+     - Bitfield value
+   * - Mono Audio
+     - ``0x00000000``
+     - n/a
+   * - ``"FRONT_LEFT"``
+     - ``0x00000001``
+     - ``0``
+   * - ``"FRONT_RIGHT"``
+     - ``0x00000002``
+     - ``1``
+   * - Stereo
+     - n/a
+     - ``3`` (``0`` and ``1`` set)
+
 .. _nrf53_audio_source_configuration:
 
 Configuring the audio source
@@ -116,7 +172,7 @@ The audio source is selected using the following Kconfig options:
 * I2S audio source (:option:`CONFIG_AUDIO_SOURCE_I2S`) - Uses 3.5 mm jack analog input using I2S
 
 In the default configuration, the gateway application uses USB as the audio source.
-The :ref:`nrf53_audio_app_building` and the testing steps also refer to using the USB serial connection.
+The :ref:`nrf53_audio_app_building` and testing steps also refer to using the USB serial connection.
 
 The audio source selection affects the firmware architecture and available features.
 USB audio source is limited to unidirectional streams due to CPU load considerations, while I2S supports bidirectional communication.
@@ -172,6 +228,19 @@ These options configure the Bluetooth stack components described in :ref:`nrf53_
 
 See :ref:`config_audio_app_options` for options starting with ``CONFIG_BT_AUDIO``.
 
+.. _nrf53_audio_app_configuration_power_measurements:
+
+Configuring power measurements
+******************************
+
+The power measurements are disabled by default in the :ref:`debug version <nrf53_audio_app_overview_files>` of the application.
+
+.. note::
+   Enabling power measurements in the debug version together with :ref:`debug logging <ug_logging>` increases the power consumption compared with the release version of the application.
+   For better results, consider using the `Power Profiler Kit II (PPK2)`_ and the `Power Profiler app`_ from nRF Connect for Desktop to measure the power consumption.
+
+To enable power measurements in the debug version, set the :kconfig:option:`CONFIG_NRF5340_AUDIO_POWER_MEASUREMENT` Kconfig option to ``y`` in the :file:`applications/nrf5340_audio/prj.conf` file.
+
 .. _nrf53_audio_app_configuration_sd_card_playback:
 
 Enabling SD card playback