# RCP Capabilities Test This test is used for testing RCP capabilities. ## Test Topology ``` +-------+ +---------------| PC |----------------+ | +-------+ | | ADB/SSH | ADB/SSH/SERIAL | | +-------+ +------------------+ | DUT |<-----------Thread-------->| Reference Device | +-------+ +------------------+ ``` - PC : The computer to run the test script. - DUT : The device under test. - Reference Device : The device that supports all tested features. ### Python Dependences Before running the test script on PC, testers should install dependences first. ```bash $ pip3 install -r ./tools/cp-caps/requirements.txt ./tools/otci ``` ### Reference Device The [nRF52840DK][ot-nrf528xx-nrf52840] is set as the reference device by default. Testers can also select the other Thread device as the reference device. [ot-nrf528xx-nrf52840]: https://github.com/openthread/ot-nrf528xx/blob/main/src/nrf52840/README.md Quick guide to setting up the nRF52840DK: ```bash $ git clone git@github.com:openthread/ot-nrf528xx.git $ cd ot-nrf528xx/ $ git submodule update --init $ ./script/bootstrap $ ./script/build nrf52840 UART_trans -DOT_DIAGNOSTIC=ON -DOT_CSL_RECEIVER=ON -DOT_LINK_METRICS_INITIATOR=ON -DOT_LINK_METRICS_SUBJECT=ON -DOT_WAKEUP_COORDINATOR=ON $ arm-none-eabi-objcopy -O ihex build/bin/ot-cli-ftd ot-cli-ftd.hex $ nrfutil device program --firmware ot-cli-ftd.hex --options chip_erase_mode=ERASE_ALL $ nrfutil device reset --reset-kind=RESET_PIN ``` ## Test Commands ### Help Info ```bash usage: [device configurations] python3 -m unittest -q [test cases] This unittest is used for testing RCP capabilities. Device configurations: ADB_KEY= Full path to the adb key DEBUG=on Enable the debug information DUT_ADB_TCP= Connect to the DUT via adb tcp DUT_ADB_USB= Connect to the DUT via adb usb DUT_CLI_SERIAL= Connect to the DUT via cli serial port DUT_SSH= Connect to the DUT via ssh REF_ADB_USB= Connect to the reference device via adb usb REF_CLI_SERIAL= Connect to the reference device via cli serial port REF_SSH= Connect to the reference device via ssh Test cases: test_csl test whether the RCP supports CSL transmitter test_data_poll test whether the RCP supports data poll test_diag_commands test whether the RCP supports all diag commands test_frame_formats test whether the RCP supports 802.15.4 frames of all formats test_link_metrics test whether the RCP supports link metrics test_radio_frame_tx_info test mTxInfo field of the radio frame test_throughput test Thread network 1-hop throughput Examples: Run test cases of the specified categories: DUT_ADB_USB=1169UC2F2T0M95OR REF_CLI_SERIAL=/dev/ttyACM0 python3 -m unittest -q test_csl test_data_poll Run all test cases: DUT_ADB_USB=1169UC2F2T0M95OR REF_CLI_SERIAL=/dev/ttyACM0 python3 -m unittest discover -q -s ./ -p 'test_*.py' Run specified test case: DUT_ADB_USB=1169UC2F2T0M95OR REF_CLI_SERIAL=/dev/ttyACM0 python3 -m unittest -q test_diag_commands.TestDiagCommands.test_diag_channel These commands should be run in the path `tools/cp-caps`. ``` > Note: If you get an error of `LIBUSB_ERROR_BUSY` when you are using the ADB USB interface, please run the command `adb kill-server` to kill the ADB server. ### Test Diag Commands The test case `test_diag_commands` tests all diag commands. Following environment variables are used to configure diag command parameters: - DUT_DIAG_GPIO: Diag gpio value. The default value is `0` if it is not set. - DUT_DIAG_RAW_POWER_SETTING: Diag raw power setting value. The default value is `112233` if it is not set. - DUT_DIAG_POWER: Diag power value. The default value is `10` if it is not set. ```bash tools/cp-caps$ DUT_ADB_USB=1269UCKFZTAM95OR REF_CLI_SERIAL=/dev/ttyACM0 DUT_DIAG_GPIO=2 DUT_DIAG_RAW_POWER_SETTING=44556688 DUT_DIAG_POWER=11 python3 -m unittest -q test_diag_commands diag channel --------------------------------------------- OK diag channel 20 ------------------------------------------ OK diag cw start -------------------------------------------- OK diag cw stop --------------------------------------------- OK diag echo 0123456789 ------------------------------------- OK diag echo -n 10 ------------------------------------------ OK diag frame 00010203040506070809 -------------------------- OK diag gpio mode 2 ----------------------------------------- OK diag gpio mode 2 in -------------------------------------- OK diag gpio mode 2 out ------------------------------------- OK diag gpio get 2 ------------------------------------------ OK diag gpio set 2 0 ---------------------------------------- OK diag gpio set 2 1 ---------------------------------------- OK diag power ----------------------------------------------- OK diag power 11 -------------------------------------------- OK diag powersettings --------------------------------------- NotSupported diag powersettings 20 ------------------------------------ NotSupported diag radio receive --------------------------------------- OK diag radio sleep ----------------------------------------- OK diag radio state ----------------------------------------- OK diag rawpowersetting enable ------------------------------ NotSupported diag rawpowersetting 44556688 ---------------------------- NotSupported diag rawpowersetting ------------------------------------- NotSupported diag rawpowersetting disable ----------------------------- NotSupported diag repeat 10 64 ---------------------------------------- OK diag repeat stop ----------------------------------------- OK diag send 100 64 ----------------------------------------- OK diag stats ----------------------------------------------- OK diag stats clear ----------------------------------------- OK diag stream start ---------------------------------------- NotSupported diag stream stop ----------------------------------------- NotSupported ``` ### Test CSL Transmitter The test case `test_csl` tests whether the RCP supports the CSL transmitter. ```bash tools/cp-caps$ DUT_ADB_USB=TW69UCKFZTGM95OR REF_CLI_SERIAL=/dev/ttyACM0 python3 -m unittest -q test_csl CSL Transmitter ------------------------------------------ OK ``` ### Test Data Poll The test case `test_data_poll` tests whether the RCP supports data poll. ```bash tools/cp-caps$ DUT_ADB_USB=TW69UCKFZTGM95OR REF_CLI_SERIAL=/dev/ttyACM0 python3 -m unittest -q test_data_poll Data Poll Child ------------------------------------------ OK Data Poll Parent ----------------------------------------- OK ``` ### Test Link Metrics The test case `test_link_metrics` tests whether the RCP supports link metrics. ```bash tools/cp-caps$ DUT_ADB_USB=TW69UCKFZTGM95OR REF_CLI_SERIAL=/dev/ttyACM0 python3 -m unittest -q test_link_metrics Link Metrics Initiator ----------------------------------- OK Link Metrics Subject ------------------------------------- OK ``` ### Test Throughput The test case `test_throughput` tests the Thread network 1-hop throughput of the DUT. ```bash tools/cp-caps$ DUT_ADB_USB=TW69UCKFZTGM95OR REF_ADB_USB=44061HFAG01AQK python3 -m unittest -q test_throughput Throughput ----------------------------------------------- 75.6 Kbits/sec ``` ### Test Frame Format The test case `test_frame_formats` tests whether the RCP supports sending and receiving 802.15.4 frames of all formats. ```bash tools/cp-caps$ DUT_ADB_USB=TW69UCKFZTGM95OR REF_CLI_SERIAL=/dev/ttyACM0 python3 -m unittest -q test_frame_formats 1 TX ver:2003,Cmd,seq,dst[addr:short,pan:id],src[addr:no,pan:no],sec:no,ie:no,plen:0 --------------- OK 1 RX ver:2003,Cmd,seq,dst[addr:short,pan:id],src[addr:no,pan:no],sec:no,ie:no,plen:0 --------------- OK 2 TX ver:2003,Bcon,seq,dst[addr:no,pan:no],src[addr:extd,pan:id],sec:no,ie:no,plen:30 -------------- OK 2 RX ver:2003,Bcon,seq,dst[addr:no,pan:no],src[addr:extd,pan:id],sec:no,ie:no,plen:30 -------------- OK 3 TX ver:2003,MP,noseq,dst[addr:extd,pan:id],src[addr:extd,pan:no],sec:l5,ie[ren con],plen:0 ------- OK 3 RX ver:2003,MP,noseq,dst[addr:extd,pan:id],src[addr:extd,pan:no],sec:l5,ie[ren con],plen:0 ------- OK 4 TX ver:2006,Cmd,seq,dst[addr:short,pan:id],src[addr:short,pan:no],sec:l5,ie:no,plen:0 ------------ OK 4 RX ver:2006,Cmd,seq,dst[addr:short,pan:id],src[addr:short,pan:no],sec:l5,ie:no,plen:0 ------------ OK 5 TX ver:2006,Cmd,seq,dst[addr:extd,pan:id],src[addr:extd,pan:no],sec:l5,ie:no,plen:0 -------------- OK 5 RX ver:2006,Cmd,seq,dst[addr:extd,pan:id],src[addr:extd,pan:no],sec:l5,ie:no,plen:0 -------------- OK 6 TX ver:2006,Data,seq,dst[addr:extd,pan:id],src[addr:extd,pan:id],sec:no,ie:no,plen:0 ------------- OK 6 RX ver:2006,Data,seq,dst[addr:extd,pan:id],src[addr:extd,pan:id],sec:no,ie:no,plen:0 ------------- OK 7 TX ver:2006,Data,seq,dst[addr:short,pan:id],src[addr:short,pan:id],sec:no,ie:no,plen:0 ----------- OK 7 RX ver:2006,Data,seq,dst[addr:short,pan:id],src[addr:short,pan:id],sec:no,ie:no,plen:0 ----------- OK 8 TX ver:2006,Data,seq,dst[addr:extd,pan:id],src[addr:no,pan:no],sec:no,ie:no,plen:0 --------------- OK 8 RX ver:2006,Data,seq,dst[addr:extd,pan:id],src[addr:no,pan:no],sec:no,ie:no,plen:0 --------------- OK 9 TX ver:2006,Data,seq,dst[addr:short,pan:id],src[addr:no,pan:no],sec:no,ie:no,plen:0 -------------- OK 9 RX ver:2006,Data,seq,dst[addr:short,pan:id],src[addr:no,pan:no],sec:no,ie:no,plen:0 -------------- OK 10 TX ver:2015,Data,seq,dst[addr:no,pan:no],src[addr:no,pan:no],sec:no,ie:no,plen:0 ---------------- OK 10 RX ver:2015,Data,seq,dst[addr:no,pan:no],src[addr:no,pan:no],sec:no,ie:no,plen:0 ---------------- OK 11 TX ver:2015,Data,seq,dst[addr:no,pan:id],src[addr:no,pan:no],sec:no,ie:no,plen:0 ---------------- OK 11 RX ver:2015,Data,seq,dst[addr:no,pan:id],src[addr:no,pan:no],sec:no,ie:no,plen:0 ---------------- OK 12 TX ver:2015,Data,seq,dst[addr:extd,pan:id],src[addr:no,pan:no],sec:no,ie:no,plen:0 -------------- OK 12 RX ver:2015,Data,seq,dst[addr:extd,pan:id],src[addr:no,pan:no],sec:no,ie:no,plen:0 -------------- OK 13 TX ver:2015,Data,seq,dst[addr:extd,pan:no],src[addr:no,pan:no],sec:no,ie:no,plen:0 -------------- OK 13 RX ver:2015,Data,seq,dst[addr:extd,pan:no],src[addr:no,pan:no],sec:no,ie:no,plen:0 -------------- OK 14 TX ver:2015,Data,seq,dst[addr:no,pan:no],src[addr:extd,pan:id],sec:no,ie:no,plen:0 -------------- OK 14 RX ver:2015,Data,seq,dst[addr:no,pan:no],src[addr:extd,pan:id],sec:no,ie:no,plen:0 -------------- OK 15 TX ver:2015,Data,seq,dst[addr:no,pan:no],src[addr:extd,pan:no],sec:no,ie:no,plen:0 -------------- OK 15 RX ver:2015,Data,seq,dst[addr:no,pan:no],src[addr:extd,pan:no],sec:no,ie:no,plen:0 -------------- OK 16 TX ver:2015,Data,seq,dst[addr:extd,pan:id],src[addr:extd,pan:no],sec:no,ie:no,plen:0 ------------ OK 16 RX ver:2015,Data,seq,dst[addr:extd,pan:id],src[addr:extd,pan:no],sec:no,ie:no,plen:0 ------------ OK 17 TX ver:2015,Data,seq,dst[addr:extd,pan:no],src[addr:extd,pan:no],sec:no,ie:no,plen:0 ------------ OK 17 RX ver:2015,Data,seq,dst[addr:extd,pan:no],src[addr:extd,pan:no],sec:no,ie:no,plen:0 ------------ OK 18 TX ver:2015,Data,seq,dst[addr:short,pan:id],src[addr:short,pan:id],sec:no,ie:no,plen:0 ---------- OK 18 RX ver:2015,Data,seq,dst[addr:short,pan:id],src[addr:short,pan:id],sec:no,ie:no,plen:0 ---------- OK 19 TX ver:2015,Data,seq,dst[addr:short,pan:id],src[addr:extd,pan:id],sec:no,ie:no,plen:0 ----------- OK 19 RX ver:2015,Data,seq,dst[addr:short,pan:id],src[addr:extd,pan:id],sec:no,ie:no,plen:0 ----------- OK 20 TX ver:2015,Data,seq,dst[addr:extd,pan:id],src[addr:short,pan:id],sec:no,ie:no,plen:0 ----------- OK 20 RX ver:2015,Data,seq,dst[addr:extd,pan:id],src[addr:short,pan:id],sec:no,ie:no,plen:0 ----------- OK 21 TX ver:2015,Data,seq,dst[addr:short,pan:id],src[addr:short,pan:id],sec:no,ie[csl],plen:0 -------- OK 21 RX ver:2015,Data,seq,dst[addr:short,pan:id],src[addr:short,pan:id],sec:no,ie[csl],plen:0 -------- OK 22 TX ver:2015,Data,noseq,dst[addr:short,pan:id],src[addr:short,pan:id],sec:no,ie:no,plen:0 -------- OK 22 RX ver:2015,Data,noseq,dst[addr:short,pan:id],src[addr:short,pan:id],sec:no,ie:no,plen:0 -------- OK ``` ### Test mTxInfo field of the radio frame. The test case `test_radio_frame_tx_info` tests whether the RCP supports the mTxInfo field of the radio frame. ```bash tools/cp-caps$ DUT_ADB_USB=TW69UCKFZTGM95OR REF_CLI_SERIAL=/dev/ttyACM0 python3 -m unittest -q test_radio_frame_tx_info mCsmaCaEnabled=0 ----------------------------------------- OK mCsmaCaEnabled=1 ----------------------------------------- OK mIsSecurityProcessed=True -------------------------------- OK mIsSecurityProcessed=False ------------------------------- OK mMaxCsmaBackoffs=0 --------------------------------------- OK (12 ms) mMaxCsmaBackoffs=100 ------------------------------------- OK (541 ms) mRxChannelAfterTxDone ------------------------------------ OK mTxDelayBaseTime=now,mTxDelay=500000 --------------------- OK ```