sample: Add HCI interface to DTM #12028
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
changelog-entry-required
|
You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds. Note: This comment is automatically posted by the Documentation Publishing GitHub Action. |
Test specificationCI/Jenkins/NRF
CI/Jenkins/integration
Detailed information of selected test modules Note: This message is automatically posted and updated by the CI |
dchat-nordic
requested review from
alwa-nordic,
jori-nordic and
carlescufi
as code owners
github-actions
bot
added
doc-required
peknis
requested changes
Aug 28, 2023
| @@ -50,8 +50,10 @@ The DTM sample includes two parts: | |||
|
|
|||
| You can find the source code of both parts in :file:`samples/bluetooth/direct_test_mode/src`. | |||
|
|
|||
| The DTM sample contains a driver for a 2-wire UART interface. | |||
| The driver maps two-octet commands and events to the DTM library, as specified by the Bluetooth Low Energy DTM specification. | |||
| The DTM sample contains a driver for a 2-wire UART interface and an experimental HCI uart interface. | |||
There was a problem hiding this comment.
Suggested change
| The DTM sample contains a driver for a 2-wire UART interface and an experimental HCI uart interface. | |
| The DTM sample contains a driver for a 2-wire UART interface and an experimental HCI UART interface. |
| The DTM sample contains a driver for a 2-wire UART interface. | ||
| The driver maps two-octet commands and events to the DTM library, as specified by the Bluetooth Low Energy DTM specification. | ||
| The DTM 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 2-wire interface. |
There was a problem hiding this comment.
Suggested change
| Unless otherwise stated all following commands and references describe 2-wire interface. | |
| Unless otherwise stated, all following commands and references describe the 2-wire interface. |
| The DTM 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 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 minimal set of HCI commands usually sufficient to run DTM testing. |
There was a problem hiding this comment.
Suggested change
| The HCI driver accepts HCI commands in H4 format and implements minimal set of HCI commands usually sufficient to run DTM testing. | |
| The HCI driver accepts HCI commands in H4 format and implements a minimal set of HCI commands usually sufficient to run DTM testing. |
| Experimental HCI interface | ||
| ========================== | ||
|
|
||
| To build the sample with HCI interface the following command can be used: |
There was a problem hiding this comment.
Suggested change
| To build the sample with HCI interface the following command can be used: | |
| To build the sample with an HCI interface, use the following command: |
| @@ -455,7 +469,7 @@ The Bluetooth Low Energy DTM UART interface standard specifies the following con | |||
| .. note:: | |||
| The default bit rate of the DTM UART driver is 19200 bps, which is supported by most certified testers. | |||
|
|
|||
| You must send all commands as two-byte HEX numbers. | |||
| Using 2-wire interface you must send all commands as two-byte HEX numbers. | |||
There was a problem hiding this comment.
Suggested change
| Using 2-wire interface you must send all commands as two-byte HEX numbers. | |
| When using a 2-wire interface, you must send all commands as two-byte HEX numbers. |
| }; | ||
|
|
||
| typedef void (*dtm_iq_report_callback_t)(struct dtm_iq_data *data); | ||
|
|
||
| /** @brief Function for initializing DTM module. |
There was a problem hiding this comment.
We usually have the function brief descriptions in imperative format, so suggesting:
"Initialize the DTM module."
| * This function initializes the DTM module and registers the IQ sampling callback. | ||
| * If the callback is not needed, the pointer can be NULL. | ||
| * | ||
| * @param[in] iq_callback Function pointer to the iq report callback, can be NULL. |
There was a problem hiding this comment.
Suggested change
| * @param[in] iq_callback Function pointer to the iq report callback, can be NULL. | |
| * @param[in] iq_callback Function pointer to the IQ report callback, can be NULL. |
| */ | ||
| int dtm_uart_wait_init(void); | ||
|
|
||
| /** @brief Wait for uart poll cycle. |
There was a problem hiding this comment.
Suggested change
| /** @brief Wait for uart poll cycle. | |
| /** @brief Wait for UART poll cycle. |
|
|
||
| /** @brief Wait for uart poll cycle. | ||
| * | ||
| * Wait for half of the uart period used by the DTM. |
There was a problem hiding this comment.
Suggested change
| * Wait for half of the uart period used by the DTM. | |
| * Wait for half of the UART period used by the DTM. |
peknis
approved these changes
Aug 30, 2023
dchat-nordic
force-pushed
the
hci_dtm2
branch
from
a197b73
to
4e21d8d
Compare
peknis
requested changes
Sep 13, 2023
| The DTM sample contains a driver for a 2-wire UART interface. | ||
| The driver maps two-octet commands and events to the DTM library, as specified by the Bluetooth Low Energy DTM specification. | ||
| The DTM 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. |
There was a problem hiding this comment.
Suggested change
| Unless otherwise stated all following commands and references describe the 2-wire interface. | |
| Unless otherwise stated, all following commands and references describe the 2-wire interface. |
KAGA164
requested changes
Sep 26, 2023
| ipc = <&ipc0>; | ||
| ept-name = "remote shell"; | ||
| current-speed = <19200>; | ||
| }; |
There was a problem hiding this comment.
Missing new line at the end of file
| int hci_uart_write(uint8_t type, const uint8_t *hdr, size_t hdr_len, | ||
| const uint8_t *pld, size_t len); | ||
|
|
||
| #endif /* HCI_UART_H_ */ |
There was a problem hiding this comment.
Missing new line at the end of file
|
|
||
| net_buf_put(&hci_tx_queue, buf); | ||
| return 0; | ||
| } |
There was a problem hiding this comment.
Missing new line at the end of file
|
|
||
| CONFIG_NET_BUF=y | ||
|
|
||
| CONFIG_BOARD_ENABLE_CPUNET=y |
There was a problem hiding this comment.
No new line at the end of file
| #include "../../src/transport/hci_uart.h" | ||
| #include "../../rpc/dtm_serialization.h" | ||
|
|
||
| LOG_MODULE_REGISTER(serialization_layer,4 ); |
| return 0; | ||
| } | ||
|
|
||
| static int serialization_init(void) |
There was a problem hiding this comment.
Not sure if this is needed. Maybe main is the best place to execute this
KAGA164
requested changes
Sep 26, 2023
dchat-nordic
force-pushed
the
hci_dtm2
branch
from
4e21d8d
to
37eda6a
Compare
KAGA164
requested changes
Oct 4, 2023
| @@ -54,8 +54,36 @@ config DTM_TRANSPORT_TWOWIRE | |||
| help | |||
| Use the Two Wire transport interface as the DTM transport layer. | |||
|
|
|||
| config DTM_TRANSPORT_HCI | |||
| bool "DTM over HCI UART" | |||
There was a problem hiding this comment.
Suggested change
| bool "DTM over HCI UART" | |
| bool "DTM over HCI UART [EXPERIMENTAL]" |
| #include <nrf_rpc/nrf_rpc_ipc.h> | ||
| #include <nrf_rpc_cbor.h> | ||
|
|
||
| #include "../../src/transport/hci_uart.h" |
There was a problem hiding this comment.
You could use target_include_directory(app PRIVATE .....) in sample CMake to avoid ugly relative paths
|
|
||
| case UART_RX_BUF_REQUEST: | ||
| LOG_DBG("Uart rx buf request"); | ||
| uart_rx_buf_rsp(dev, uart_buf(), 128); |
| return err; | ||
| } | ||
|
|
||
| uart_rx_enable(hci_uart_dev, uart_buf(), 128, 10000); |
| return; | ||
|
|
||
| error_exit: | ||
| __ASSERT_NO_MSG(0); |
There was a problem hiding this comment.
Please change it in all places
Suggested change
| __ASSERT_NO_MSG(0); | |
| __ASSERT_NO_MSG(false); |
KAGA164
requested changes
Oct 9, 2023
|
|
||
| static int hci_rx_test(uint16_t opcode, const uint8_t *data) | ||
| { | ||
| struct bt_hci_cp_le_rx_test *params_v1 = (struct bt_hci_cp_le_rx_test *)data; |
There was a problem hiding this comment.
Maybe union here would be a good idea?
There was a problem hiding this comment.
Changed to union.
|
|
||
| static int hci_tx_test(uint16_t opcode, const uint8_t *data) | ||
| { | ||
| struct bt_hci_cp_le_tx_test *params_v1 = (struct bt_hci_cp_le_tx_test *)data; |
| @@ -981,6 +1098,8 @@ static bool check_pdu(const struct dtm_pdu *pdu) | |||
| ((dtm_inst.cte_info.slot == DTM_CTE_SLOT_1US) ? 2 : 4); | |||
| cte_sample_cnt = NRF_RADIO->DFEPACKET.AMOUNT; | |||
|
|
|||
| report_iq(); | |||
There was a problem hiding this comment.
It seems to me that this function could be called only in cases when iq sample callback is not NULL. The same about starting RSSI measurement. Is it make sense?
There was a problem hiding this comment.
Added condition of callback not null.
| struct nrf_rpc_cbor_ctx ctx; | ||
|
|
||
| LOG_DBG("Call to hci_uart_write"); | ||
| NRF_RPC_CBOR_ALLOC(&hci_group, ctx, 1024+64); |
dchat-nordic
force-pushed
the
hci_dtm2
branch
2 times, most recently
from
b81588e
to
82c771b
Compare
KAGA164
approved these changes
Oct 9, 2023
maje-emb
reviewed
Oct 9, 2023
samples/bluetooth/direct_test_mode/src/transport/dtm_transport.h
Outdated
Show resolved
Hide resolved
samples/bluetooth/direct_test_mode/src/transport/dtm_transport.h
Outdated
Show resolved
Hide resolved
dchat-nordic
force-pushed
the
hci_dtm2
branch
from
5549d5a
to
4af5f0e
Compare
dchat-nordic
force-pushed
the
hci_dtm2
branch
2 times, most recently
from
b8889d2
to
aa62941
Compare
maje-emb
reviewed
Oct 10, 2023
samples/bluetooth/direct_test_mode/src/transport/hci_uart_remote.c
Outdated
Show resolved
Hide resolved
dchat-nordic
force-pushed
the
hci_dtm2
branch
from
aa62941
to
d2d8588
Compare
maje-emb
approved these changes
Oct 11, 2023
peknis
requested changes
Oct 12, 2023
| @@ -50,8 +50,10 @@ The DTM sample includes two parts: | |||
|
|
|||
| You can find the source code of both parts in :file:`samples/bluetooth/direct_test_mode/src`. | |||
|
|
|||
| The DTM sample contains a driver for a 2-wire UART interface. | |||
| The driver maps two-octet commands and events to the DTM library, as specified by the Bluetooth Low Energy DTM specification. | |||
| The DTM sample contains a driver for a 2-wire UART interface and an experimental HCI UART interface. | |||
There was a problem hiding this comment.
Suggested change
| The DTM sample contains a driver for a 2-wire UART interface and an experimental HCI UART interface. | |
| This sample contains a driver for a 2-wire UART interface and an experimental HCI UART interface. |
| @@ -60,8 +62,9 @@ The implementation is self-contained and requires no Bluetooth Low Energy protoc | |||
| The MPU is initialized in the standard way. | |||
| The DTM library function :c:func:`dtm_init` configures all interrupts, timers, and the radio. | |||
|
|
|||
| The :file:`main.c` file may be extended with other interface implementations, such as an HCI interface, USB, or another interface required by the Upper Tester. | |||
| The DTM sample may be extended with other interface implementations, such as an HCI interface, USB, or another interface required by the Upper Tester. | |||
There was a problem hiding this comment.
Suggested change
| The DTM sample may be extended with other interface implementations, such as an HCI interface, USB, or another interface required by the Upper Tester. | |
| 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 shall conform to the interface specified in the :file:`transport/dtm_transport.h` file. |
There was a problem hiding this comment.
Suggested change
| The transports shall conform to the interface specified in the :file:`transport/dtm_transport.h` file. | |
| The transports must conform to the interface specified in the :file:`transport/dtm_transport.h` file. |
| @@ -316,9 +319,13 @@ The DTM-to-Serial adaptation layer | |||
|
|
|||
| 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|. |
There was a problem hiding this comment.
Suggested change
| The HCI interface allows for a custom `remote_hci` image to be used with |nRF5340DKnoref|. | |
| The HCI interface allows for a custom ``remote_hci`` image to be used with |nRF5340DKnoref|. |
|
|
||
| .. code-block:: console | ||
|
|
||
| west build samples/bluetooth/direct_test_mode -b board_name -- --DEXTRA_CONF_FILE=overlay-hci.conf |
There was a problem hiding this comment.
Suggested change
| west build samples/bluetooth/direct_test_mode -b board_name -- --DEXTRA_CONF_FILE=overlay-hci.conf | |
| west build samples/bluetooth/direct_test_mode -b board_name -- --DEXTRA_CONF_FILE=overlay-hci.conf |
|
|
||
| .. code-block:: console | ||
|
|
||
| west build samples/bluetooth/direct_test_mode -b board_name -- --DEXTRA_CONF_FILE=overlay-hci-nrf53.conf |
There was a problem hiding this comment.
Suggested change
| west build samples/bluetooth/direct_test_mode -b board_name -- --DEXTRA_CONF_FILE=overlay-hci-nrf53.conf | |
| west build samples/bluetooth/direct_test_mode -b board_name -- --DEXTRA_CONF_FILE=overlay-hci-nrf53.conf |
| /** @brief Function for initializing DTM module. | ||
| /** @brief DTM Packet status for IQ Sample report. */ | ||
| enum dtm_packet_status { | ||
| /** Packet received with proper CRC */ |
There was a problem hiding this comment.
Suggested change
| /** Packet received with proper CRC */ | |
| /** Packet received with proper CRC. */ |
| if DTM_TRANSPORT_HCI | ||
|
|
||
| config DTM_HCI_QUEUE_COUNT | ||
| int "Count of HCI rx/tx queues" |
There was a problem hiding this comment.
Suggested change
| int "Count of HCI rx/tx queues" | |
| int "Count of HCI RX/TX queues" |
Capitalize these in all places.
Add HCI interface to Direct Test Mode sample. Jira: NCSDK-22490 Signed-off-by: Dominik Chat <dominik.chat@nordicsemi.no>
dchat-nordic
force-pushed
the
hci_dtm2
branch
from
d2d8588
to
e311b16
Compare
peknis
approved these changes
Oct 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add HCI interface to Direct Test Mode sample.
Jira: NCSDK-22490