This sample enables the Direct Test Mode functions described in `Bluetooth® Core Specification <Bluetooth Core Specification_>`_: Version 5.2, Vol. 6, Part F.
The sample supports the following development kits:
.. table-from-sample-yaml::
Additionally, the sample requires one of the following testing devices:
The sample uses Direct Test Mode (DTM) to test the operation of the following features of the radio:
Test procedures are defined in the document `Bluetooth® Low Energy RF PHY Test Specification <Bluetooth Low Energy RF PHY Test Specification_>`_: Document number RF-PHY.TS.p15
You can carry out conformance tests using dedicated test equipment, such as the Anritsu MT8852 or similar, with an nRF5 running the DTM sample set as device under test (DUT).
The DTM sample includes two parts:
You can find the source code of both parts in :file:`samples/bluetooth/direct_test_mode/src`.
This sample contains a driver for a 2-wire UART interface and an experimental HCI UART interface. Unless otherwise stated, all following commands and references describe the 2-wire interface. The 2-wire driver maps two-octet commands and events to the DTM library, as specified by the Bluetooth Low Energy DTM specification. The HCI driver accepts HCI commands in H4 format and implements a minimal set of HCI commands usually sufficient to run DTM testing.
The implementation is self-contained and requires no Bluetooth Low Energy protocol stack for its operation. The MPU is initialized in the standard way. The DTM library function :c:func:`dtm_init` configures all interrupts, timers, and the radio.
This sample may be extended with other interface implementations, such as an HCI interface, USB, or another interface required by the Upper Tester. The extension should be done by adding an appropriate interface implementation in the :file:`transport` directory. The transports must conform to the interface specified in the :file:`transport/dtm_transport.h` file.
The interface to the Lower Tester uses the antenna connector of the chosen development kit. While in principle an aerial connection might be used, conformance tests cover the reading of the transmission power delivered by the DUT. For this reason, a coaxial connection between the DUT and the Lower Tester is employed for all conformance testing.
The DTM module interface can be divided into the following three parts:
The setup functions implement the DTM setup required by the Bluetooth Low Energy standard. The test functions implement the tests defined by the Bluetooth Low Energy standard.
The sample is required to perform the following tasks:
- To parse the relevant encoding format - UART or HCI - for the command, and to use the DTM module interface accordingly.
- To interpret the return values of interface functions used in the DTM module, and to respond to the tester in the correct format.
The DTM sample supports all four PHYs specified in DTM, but not all devices support all the PHYs.
PHY | nRF5340 |
---|---|
LE 1M | Yes |
LE 2M | Yes |
LE Coded S=8 | Yes |
LE Coded S=2 | Yes |
This sample has several ways to set the device output power. The behavior of the commands vary depending on the hardware configuration and Kconfig options as follows:
DTM without front-end module support:
- The official
0x09
DTM command sets the SoC TX output power closest to the requested one when the exact power level is not supported.- The
SET_TX_POWER
vendor-specific command sets the SoC TX output power. You must use only the TX power values supported by your SoC. See the actual values in the SoC Product Specification.
DTM with front-end module support:
When the :ref:`CONFIG_DTM_POWER_CONTROL_AUTOMATIC <CONFIG_DTM_POWER_CONTROL_AUTOMATIC>` Kconfig option is enabled (default), the official
0x09
DTM command sets the final output power to the desired, or the closest available value by configuring the SoC output power and the front-end module gain automatically.Note
The returned output power using this command is valid only for channel 0. If you perform the test on a different channel than the real output power measured by your tester device, it can be equal or less than the returned one. This is because the DTM specification has a limitation when it assumes that output power is the same for all channels. That is why the chosen output power might not be available for the given channel.
When the :ref:`CONFIG_DTM_POWER_CONTROL_AUTOMATIC <CONFIG_DTM_POWER_CONTROL_AUTOMATIC>` Kconfig option is disabled, the official
0x09
DTM command sets only the SoC output power. These commands behave in the same way for the DTM without front-end module support. Additionally, you can use following vendor-specific commands:
- The
SET_TX_POWER
command sets the SoC TX output power.- The
FEM_GAIN_SET
command sets the front-end module gain.
The DTM sample supports all Bluetooth Direction Finding modes specified in DTM.
Direction Finding mode | nRF5340 |
---|---|
AoD 1 us slot | Yes |
AoD 2 us slot | Yes |
AoA | Yes |
The following antenna switching patterns are possible:
The application supports a maximum of 19 antennas in the direction finding mode. The radio can control up to eight GPIO pins for the purpose of controlling the external antenna switches used in direction finding.
To use this sample to test the Bluetooth Direction Finding feature, additional configuration of GPIOs is required to control the antenna array. An example of such configuration is provided in a devicetree overlay file :file:`nrf5340dk_nrf5340_cpunet.overlay`.
The overlay file provides the information about of the GPIOs to be used by the Radio peripheral to switch between antenna patches during the Constant Tone Extension (CTE) reception or transmission. At least one GPIO must be provided to enable antenna switching.
The GPIOs are used by the radio peripheral in the order provided by the dfegpio#-gpios
properties.
The order is important because it has an impact to the mapping of the antenna switching patterns to GPIOs (see Antenna patterns).
To test Direction Finding, provide the following data related to antenna matrix design:
dfegpio#-gpios
properties in the :file:`nrf5340dk_nrf5340_cpunet.overlay` file.dfe-pdu-antenna
property in the :file:`nrf5340dk_nrf5340_cpunet.overlay` file.Note
The PDU antenna is also used for the reference period transmission and reception.
The antenna switching pattern is a binary number where each bit is applied to a particular antenna GPIO pin.
For example, the pattern 0x3
means that antenna GPIOs at index 0,1
is set, while the next ones are left unset.
This also means that, for example, when using four GPIOs, the pattern count cannot be greater than 16 and the maximum allowed value is 15.
If the number of switch-sample periods is greater than the number of stored switching patterns, the radio loops back to the first pattern.
The following table presents the patterns that you can use to switch antennas on the Nordic-designed antenna matrix:
Antenna | PATTERN[3:0] |
---|---|
ANT_12 | 0 (0b0000) |
ANT_10 | 1 (0b0001) |
ANT_11 | 2 (0b0010) |
RFU | 3 (0b0011) |
ANT_3 | 4 (0b0100) |
ANT_1 | 5 (0b0101) |
ANT_2 | 6 (0b0110) |
RFU | 7 (0b0111) |
ANT_6 | 8 (0b1000) |
ANT_4 | 9 (0b1001) |
ANT_5 | 10 (0b1010) |
RFU | 11 (0b1011) |
ANT_9 | 12 (0b1100) |
ANT_7 | 13 (0b1101) |
ANT_8 | 14 (0b1110) |
RFU | 15 (0b1111) |
You can configure the transmitted power gain, antenna output and activation delay in nRF21540 using vendor-specific commands, see Vendor-specific packet payload.
You can configure the antenna output and activation delay for the Skyworks front-end module (FEM) using vendor-specific commands, see Vendor-specific packet payload.
The Bluetooth Low Energy 2-wire UART DTM interface standard reserves the Packet Type, also called payload parameter, with binary value 11
for a Vendor Specific packet payload.
The DTM command is interpreted as vendor-specific when both of the following conditions are met:
10
.11
.Vendor-specific commands can be divided into different categories as follows:
If the Length field is set to 0
(symbol CARRIER_TEST
), an unmodulated carrier is turned on at the channel indicated by the Frequency field.
It remains turned on until a TEST_END
or RESET
command is issued.
If the Length field is set to 1
(symbol CARRIER_TEST_STUDIO
), the field value is used by the nRFgo Studio to indicate that an unmodulated carrier is turned on at the channel.
It remains turned on until a TEST_END
or RESET
command is issued.
If the Length field is set 2
(symbol SET_TX_POWER
), the Frequency field sets the TX power in dBm.
The valid TX power values are specified in the product specification ranging from -40 to +4, where 0
dBm is the reset value.
Only the six least significant bits will fit in the Length field.
The two most significant bits are calculated by the DTM module.
This is possible because the six least significant bits of all valid TX power values are unique.
The TX power can be modified only when no Transmitter Test or Receiver Test is running.
If the Length field is set to 3
(symbol FEM_ANTENNA_SELECT
), the Frequency field sets the front-end module (FEM) antenna output.
The valid values are:
0
- ANT1 enabled, ANT2 disabled1
- ANT1 disabled, ANT2 enabled
If the Length field is set to 4
(symbol FEM_GAIN_SET
), the Frequency field sets the front-end module (FEM) TX gain value in arbitrary units.
The valid gain values are specified in your product-specific front-end module (FEM).
For example, in the nRF21540 front-end module, the gain range is 0 - 31.
If the Length field is set to 5
(symbol FEM_ACTIVE_DELAY_SET
), the Frequency field sets the front-end module (FEM) activation delay in microseconds relative to the radio start.
By default, this value is set to radio ramp-up time - front-end module (FEM) TX/RX settling time
.
If the Length field is set to 6
(symbol FEM_DEFAULT_PARAMS_SET
) and the Frequency field to any value, the front-end module parameters, such as antenna output
, gain
, and delay
, are set to their default values.
All other values of Frequency and Length field are reserved.
Note
Front-end module configuration parameters, such as antenna output
, gain
, and active delay
, are not set to their default values after the DTM reset command.
Testers, for example Anritsu MT8852, issue a reset command at the beginning of every test.
Therefore, you cannot run automated test scripts for front-end modules with other than the default parameters.
If you have changed the default parameters of the front-end module, you can restore them.
You can either send the FEM_DEFAULT_PARAMS_SET
command or power cycle the front-end module.
Note
When you build the DTM sample with support for front-end modules and the :ref:`CONFIG_DTM_POWER_CONTROL_AUTOMATIC <CONFIG_DTM_POWER_CONTROL_AUTOMATIC>` Kconfig option is enabled, the following vendor-specific command are not available:
SET_TX_POWER
FEM_GAIN_SET
You can disable the :ref:`CONFIG_DTM_POWER_CONTROL_AUTOMATIC <CONFIG_DTM_POWER_CONTROL_AUTOMATIC>` Kconfig option if you want to set the SoC output power and the front-end module gain by separate commands.
The official DTM command 0x09
for setting power level takes into account the SoC output power and the front-end module gain to set the total requested output power.
The :file:`dtm_uart_twowire.c` file is an implementation of the UART interface specified in the `Bluetooth Core Specification`_, Volume 6, Part F, Chapter 3.
The :file:`dtm_hci.c` and :file:`hci_uart.c` files are an implementation of the HCI UART interface specified in the `Bluetooth Core Specification`_, Volume 4, Part A (the flow control can be configured by an overlay file).
The default selection of UART pins is defined in :file:`zephyr/boards/arm/board_name/board_name.dts`.
You can change the defaults using the symbols tx-pin
and rx-pin
in the DTS overlay file of the child image at the project level.
The overlay files for the :ref:`nrf5340_remote_shell` child image are located in the :file:`child_image/remote_shell` directory.
The HCI interface allows for a custom remote_hci
image to be used with |nRF5340DKnoref|.
Note
On the nRF5340 development kit, the physical UART interface of the application core is used for communication with the tester device. This sample uses the :ref:`uart_ipc` for sending responses and receiving commands through the UART interface of the application core.
In this sample, the UART console is used to exchange commands and events defined in the DTM specification. Debug messages are not displayed in the UART console. Instead, they are printed by the RTT logger.
If you want to view the debug messages, follow the procedure in :ref:`testing_rtt_connect`. For more information about debugging in the |NCS|, see :ref:`debugging`.
The following configuration parameters are associated with this sample:
Note
On the nRF5340 development kit, this sample requires the :ref:`nrf5340_remote_shell` sample on the application core. The Remote IPC shell sample is built and programmed automatically by default. If you want to program your custom solution for the application core, unset the :kconfig:option:`CONFIG_NCS_SAMPLE_REMOTE_SHELL_CHILD_IMAGE` Kconfig option.
To build the sample with an HCI interface, use the following command:
west build samples/bluetooth/direct_test_mode -b board_name -- --DEXTRA_CONF_FILE=overlay-hci.conf
On the |nRF5340DKnoref| the sample with HCI interface can also be built with the remote_hci image using the following command:
west build samples/bluetooth/direct_test_mode -b board_name -- --DEXTRA_CONF_FILE=overlay-hci-nrf53.conf
On the nRF5340 development kit, you can build this sample configured to use the USB interface as a communication interface with the tester. Use the following command:
west build samples/bluetooth/direct_test_mode -b nrf5340dk_nrf5340_cpunet -- -DCONFIG_DTM_USB=y
You can also build this sample with support for the front-end module. Use the following command:
west build samples/bluetooth/direct_test_mode -b nrf5340dk_nrf5340_cpunet -- -DSHIELD=nrf21540ek -DCONFIG_DTM_USB=y
After programming the sample to your development kit, you can test it in three ways, as described in the following chapters.
Note
For the |nRF5340DKnoref|, see :ref:`logging_cpunet` for information about the COM terminals on which the logging output is available.
Conformance testing is performed using a certified tester. The setup depends on the tester used, and details about the test operation must be found in the tester documentation.
The Application note `nAN34`_ describes two alternatives for setting up a production test with DTM using one of our old devices.
TRANSMITTER_TEST
by sending the 0x80 0x96
DTM command to one of the connected development kits.
This command will trigger TX activity on the 2402 MHz frequency (1st channel) with 10101010
packet pattern and 37-byte packet length.TEST_STATUS_EVENT
packet in response with the SUCCESS status field: 0x00 0x00
.RECEIVER_TEST
by sending the 0x40 0x96
DTM command to the second development kit.
Command parameters are identical to the ones used for the TRANSMITTER_TEST
command.TEST_STATUS_EVENT
packet in response with the SUCCESS status field: 0x00 0x00
.TEST_END DTM
command by sending the 0xC0 0x00
packet.PACKET_REPORTING_EVENT
packet in response.
For example, the 0xD6 0xAC
message indicates that 22188 Radio packets have been received.TRANSMITTER_TEST
by sending the 0x80 0x96
DTM command to the connected development kit.
This command triggers TX activity on 2402 MHz frequency (1st channel) with 10101010
packet pattern and 37-byte packet length.TEST_STATUS_EVENT
packet in response with the SUCCESS status field: 0x00 0x00
.To send commands to and receive responses from the development kit that runs the Direct Test Mode sample, connect to it with RealTerm in Windows or Minicom in Linux.
The Bluetooth Low Energy DTM UART interface standard specifies the following configuration:
Note
The default bit rate of the DTM UART driver is 19200 bps, which is supported by most certified testers.
When using a 2-wire interface, you must send all commands as two-byte HEX numbers. The responses must have the same format.
The RealTerm terminal program offers a graphical interface for setting up your connection.
The RealTerm start window
To test DTM with RealTerm, complete the following steps:
On the :guilabel:`Display` tab, set Display As to Hex[space].
Open the :guilabel:`Port` tab and configure the serial port parameters:
19200
(1).Open
(3).Open the :guilabel:`Send` tab:
0x00 0x00
to send a Reset command.Minicom is a serial communication program that connects to the DTM device.
On the Linux operating system, install a Minicom terminal. On Ubuntu, run:
sudo apt-get install minicom
Run the Minicom terminal:
sudo minicom -D DTM serial port -s
For example:
sudo minicom -D /dev/serial/by-id/usb-SEGGER_J-Link_000683580193-if00 -s
The -s option switches you to Minicom setup mode.
Configure the Minicom terminal:
Configuration window
Select :guilabel:`Serial port setup` and set UART baudrate to 19200
.
Select :guilabel:`Screen and keyboard` and press S on the keyboard to enable the Hex Display.
Press Q on the keyboard to enable Local echo.
Minicom is now configured for receiving data. However, you cannot use it for sending DTM commands.
Send DTM commands:
To send DTM commands, use echo
with -ne
options in another terminal.
You must encode the data as hexadecimal numbers (xHH, byte with hexadecimal value HH, 1 to 2 digits).
sudo echo -ne "encoded command" > DTM serial port
To send a Reset command, for example, run the following command:
sudo echo -ne "\x00\x00" > /dev/serial/by-id/usb-SEGGER_J-Link_000683580193-if00
This sample uses the following |NCS| library:
This sample uses the following |NCS| driver:
This sample has the following nrfx dependencies:
The sample also has the following nrfxlib dependency:
In addition, it has the following Zephyr dependencies:
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。