From 380570285a25e20abb6c5d52197f8156df21002d Mon Sep 17 00:00:00 2001 From: Jaafar BEN YOUNES Date: Thu, 3 Oct 2024 14:17:08 +0200 Subject: [PATCH] [NXP][doc][rt] changes since workflow feedback --- .github/.wordlist.txt | 30 +++- docs/guides/nxp/README.md | 2 +- .../guides/nxp/nxp_RTs_ota_software_update.md | 36 ++--- .../all-clusters-app/nxp/rt/rt1060/README.md | 151 +++++++++--------- .../all-clusters-app/nxp/rt/rt1170/README.md | 76 ++++----- 5 files changed, 161 insertions(+), 134 deletions(-) diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt index 5c24cdec825ac1..0433d5b59ab2ff 100644 --- a/.github/.wordlist.txt +++ b/.github/.wordlist.txt @@ -73,6 +73,7 @@ argc args argv armeabi +armgcc armino ARMmbed armv @@ -242,6 +243,7 @@ CLA clapre CLI CLIs +CLK cloudbuild CLRF clusterAttrs @@ -304,8 +306,8 @@ conv CopperConcentrationMeasurement Corstone cortexa -cp -cpio +cp` +cpio` cpp cppreference CPROTO @@ -321,6 +323,7 @@ csu csv ctl ctrl +CTS ctypes CurrentHue CurrentLevel @@ -354,6 +357,7 @@ DCL DCMAKE DCONF DCONFIG +DCP debianutils debugText decrypt @@ -417,6 +421,7 @@ dialout diffstat diffsyms dimmable +DIO dirname dirs disableNotifyUpdateApplied @@ -475,6 +480,7 @@ EchoService ECW edaf edc +edgefast EDR ee eea @@ -529,6 +535,7 @@ ExchangeContext exe ExecStart executables +expander ExtendedPAN ExtensionEntry extern @@ -691,6 +698,7 @@ imager imagetool imageUri img +imgtool Impl ImplClass implementers @@ -735,6 +743,7 @@ isUpperCase itemName iterable itsfoss +iw JDK jinja JLink @@ -822,6 +831,7 @@ LogEvent loopback LowPower LPC +LPUART LSP LTE LTS @@ -900,6 +910,8 @@ MinIntervalFloorSeconds minLength MinRtrAdvInterval minValue +MISO +mimxrt mkdir mlan MLD @@ -909,6 +921,7 @@ Mobly ModeSelect modprobe Modustoolbox +MOSI moveMode MoveToHue MoveToLevel @@ -924,6 +937,7 @@ Multicast multilib Multiprotocol multithreaded +Murata mutex mutexes mv @@ -939,6 +953,7 @@ nano natively navpad nbsp +ncache NCP ncs nding @@ -1000,6 +1015,7 @@ OO openiotsdk openjdk OpenOCD +opensource OpenSSL OpenThread OpenThreadDemo @@ -1039,6 +1055,8 @@ otatesting otaURL OTBR otcli +OTP +OTW outform outgoingCommands overridable @@ -1085,6 +1103,7 @@ PID Pigweed PinCode pinrequest +PIO PIXIT PIXITs pkgconfig @@ -1222,12 +1241,14 @@ RSA rsn RSSI RST +RSTN rsync RTC rtd RTL rtld RTOS +RTS RTT RTX runArgs @@ -1250,6 +1271,7 @@ scm sco scp ScriptBinding +SDA SDB SDC SDHC @@ -1259,6 +1281,7 @@ sdkconfig SDKs SDKTARGETSYSROOT sdl +SDRAM SecureCertDACProvider SED SEGGER @@ -1520,6 +1543,7 @@ UUID ux validator valgrind +VBAT vcom VCP Vectorcall @@ -1532,6 +1556,7 @@ Verifier Verifiers VID vids +VIO virtualenv visualstudio vlatest @@ -1631,4 +1656,5 @@ Zigbee zigbeealliance zigbeethread zsdk +ZTB TBR diff --git a/docs/guides/nxp/README.md b/docs/guides/nxp/README.md index be225ac938f7b5..fc11ed78b2baff 100644 --- a/docs/guides/nxp/README.md +++ b/docs/guides/nxp/README.md @@ -10,5 +10,5 @@ - [NXP - Android Commissioning](nxp_k32w_android_commissioning.md) - [NXP - Linux Examples](nxp_imx8m_linux_examples.md) - [NXP - Manufacturing Data](nxp_manufacturing_flow.md) -- [NXP - RW61x OTA Software Update Guide](nxp_rw61x_ota_software_update.md) +- [NXP - RTs OTA Software Update Guide](nxp_RTs_ota_software_update.md) - [NXP - Zephyr OTA Software Update Guide](nxp_zephyr_ota_software_update.md) diff --git a/docs/guides/nxp/nxp_RTs_ota_software_update.md b/docs/guides/nxp/nxp_RTs_ota_software_update.md index a841a2cce166e1..4a373a006acc75 100644 --- a/docs/guides/nxp/nxp_RTs_ota_software_update.md +++ b/docs/guides/nxp/nxp_RTs_ota_software_update.md @@ -4,8 +4,8 @@ This document describes OTA feature on NXP devices: - RW61x -- RT1060_EVKC -- RT1170_EVKB +- RT1060_EVK-C +- RT1170_EVK-B The OTA Requestor feature enables the device to be informed of, download and apply a software update from an OTA Provider. @@ -96,32 +96,32 @@ For RW61x ``` J-Link > erase 0x8000000, 0x88a0000 ``` -For RT1060-EVKC +For RT1060-EVK-C ``` J-Link > erase 0x60000000, 0x61000000 ``` -For RT1170-EVKB +For RT1170-EVK-B ``` J-Link > erase 0x30000000, 0x34000000 ``` -- MCUBoot application can be built with SDK installed, using intructions +- MCUBoot application can be built with SDK installed, using instructions below. -- Retrieve the mcuboot directory located at ->*/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/examples/<`RT_board`>[1](#RT_board)/ota_examples/mcuboot_opensource/armgcc* +- Retrieve the mcuboot directory located at *'/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/examples/`RTboard`1/ota_examples/mcuboot_opensource/armgcc'* + +*1 `rdrw612bga` or `frdmrw612` for RW61x, `evkcmimxrt1060` for RT1060-EVK-C, `evkbmimxrt1170` for RT1170-EVK-B* -*1 : `rdrw612bga` or `frdmrw612` for RW61x, `evkcmimxrt1060` for RT1060-EVKC, `evkbmimxrt1170` for RT1170-EVKB* ``` user@ubuntu: cd ~/Desktop/connectedhomeip/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/examples//ota_examples/mcuboot_opensource/armgcc ``` -- Build the mcuboot application with running <`build_script`>[2](#mcuboot_build_script) +- Build the mcuboot application with running `build_script`2 ``` user@ubuntu: chmod +x user@ubuntu: export ARMGCC_DIR=/opt/gcc-arm-none-eabi-10.3-2021.10 # with ARMGCC_DIR referencing the compiler path user@ubuntu: ./ ``` -*2 : `build_flash_release.sh` for RW61x, `build_flexspi_nor_release.sh` for RT1060 and RT1170* +*2 `build_flash_release.sh` for RW61x, `build_flexspi_nor_release.sh` for RT1060 and RT1170* - Program the generated binary to the target board. @@ -148,7 +148,7 @@ partitions to be the size of 4.4 MB. If the size is to be changed, the partition addresses should be modified in the flash_partitioning.h accordingly. For more information about the flash partitioning with mcuboot, please refer to the dedicated *readme.txt* located in ->*/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/examples/<`RT_board`>[1](#RT_board)/ota_examples/mcuboot_opensource/.* +>*/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/examples/`RTboard`1/ota_examples/mcuboot_opensource/.* ### Generating and flashing the signed application image @@ -163,20 +163,20 @@ The image must have the following format : The all-clusters application can be generated using the instructions from the -README.md[3](#board) 'Building' +README.md3'Building' section. The application is automatically linked to be executed from the primary image partition, taking into consideration the offset imposed by mcuboot. -3 : [RW61x README.md 'Building'](../../../examples/all-clusters-app/nxp/rt/rw61x/README.md#building), [RT1060 README.md 'Building'](../../../examples/all-clusters-app/nxp/rt/rt1060/README.md#building), [RT1170 README.md 'Building'](../../../examples/all-clusters-app/nxp/rt/rt1170/README.md#building) +*3 [RW61x README.md 'Building'](../../../examples/all-clusters-app/nxp/rt/rw61x/README.md#building), [RT1060 README.md 'Building'](../../../examples/all-clusters-app/nxp/rt/rt1060/README.md#building), [RT1170 README.md 'Building'](../../../examples/all-clusters-app/nxp/rt/rt1170/README.md#building)* -The resulting executable file found in out/release/chip-<`rt_board`>[4](#rt_board)-all-cluster-example +The resulting executable file found in out/release/chip-`board`4-all-cluster-example needs to be converted into raw binary format as shown below. -*4 : `rw61x` for RW61x, `rt1060` for RT1060-EVKC, `rt1170` for RT1170-EVKB* +*4 `rw61x` for RW61x, `rt1060` for RT1060-EVK-C, `rt1170` for RT1170-EVK-B* ```sh -arm-none-eabi-objcopy -R .flash_config -R .NVM -O binary chip-<"rt_board">-all-cluster-example chip-<"rt_board">-all-cluster-example.bin +arm-none-eabi-objcopy -R .flash_config -R .NVM -O binary chip-<"board">-all-cluster-example chip-<"board">-all-cluster-example.bin ``` To sign the image and wrap the raw binary of the application with the header and @@ -231,11 +231,11 @@ For RW61x ``` J-Link > loadbin chip-rw61x-all-cluster-example_SIGNED.bin 0x8020000 ``` -For RT1060-EVKC +For RT1060-EVK-C ``` J-Link > loadbin chip-rt1060-all-cluster-example_SIGNED.bin 0x60040000 ``` -For RT1170-EVKB +For RT1170-EVK-B ``` J-Link > loadbin chip-rt1170-all-cluster-example_SIGNED.bin 0x30040000 ``` diff --git a/examples/all-clusters-app/nxp/rt/rt1060/README.md b/examples/all-clusters-app/nxp/rt/rt1060/README.md index c7ad21ebf954a3..8ca86b222fecef 100644 --- a/examples/all-clusters-app/nxp/rt/rt1060/README.md +++ b/examples/all-clusters-app/nxp/rt/rt1060/README.md @@ -1,6 +1,6 @@ # CHIP RT1060 All-clusters Application -The all-clusters example implements a server which can be accesed by a CHIP +The all-clusters example implements a server which can be accessed by a CHIP controller and can accept basic cluster commands. The example is based on @@ -17,13 +17,13 @@ commissioning and different cluster control. - [Hardware requirements RT1060+IW416](#hardware-requirements-rt1060iw416) - [Hardware requirements RT1060+88W8801](#hardware-requirements-rt106088w8801) - [Hardware requirements RT1060 + K32W0](#hardware-requirements-rt1060--k32w0) - - [Hardware requirements RT1060-EVKC+IW612](#hardware-requirements-rt1060-evkciw612) + - [Hardware requirements RT1060-EVK-C+IW612](#hardware-requirements-rt1060-evk-ciw612) - [Hardware requirements RT1060 + 88W8801 + K32W0x1DK6](#hardware-requirements-rt1060--88w8801--k32w0x1dk6) - [Building](#building) - - [Building with Matter over Wifi configuratiom on RT1060 + transceiver](#building-with-matter-over-wifi-configuratiom-on-rt1060--transceiver) + - [Building with Matter over Wifi configuration on RT1060 + transceiver](#building-with-matter-over-wifi-configuration-on-rt1060--transceiver) - [Build with Matter over Thread configuration on RT1060 + transceiver](#build-with-matter-over-thread-configuration-on-rt1060--transceiver) - [Build with Matter over Thread configuration on RT1060 + K32W0](#build-with-matter-over-thread-configuration-on-rt1060--k32w0) - - [Build with Matter over Thread configuration on RT1060-EVKC + IW612](#build-with-matter-over-thread-configuration-on-rt1060-evkc--iw612) + - [Build with Matter over Thread configuration on RT1060-EVK-C + IW612](#build-with-matter-over-thread-configuration-on-rt1060-evk-c--iw612) - [Build with Matter over Wi-Fi + OpenThread Border Router configuration on RT1060 + 88W8801 + K32W0x1DK6](#build-with-matter-over-wi-fi--openthread-border-router-configuration-on-rt1060--88w8801--k32w0x1dk6) - [General Information](#general-information) - [Manufacturing data](#manufacturing-data) @@ -34,14 +34,14 @@ commissioning and different cluster control. - [Matter over wifi with openthread border router configuration :](#matter-over-wifi-with-openthread-border-router-configuration-) - [Testing the all-clusters application without Matter CLI:](#testing-the-all-clusters-application-without-matter-cli) - [Testing the all-clusters application with Matter CLI enabled:](#testing-the-all-clusters-application-with-matter-cli-enabled) - - [Thread Border Router overwiew](#thread-border-router-overwiew) + - [Thread Border Router overview](#thread-border-router-overview)
## Introduction -![RT1060 EVKB](../../../../platform/nxp/rt/rt1060/doc/images/MIMXRT1060-EVKB-TOP.png) +![RT1060 EVK-B](../../../../platform/nxp/rt/rt1060/doc/images/MIMXRT1060-EVKB-TOP.png) The RT1060 all-cluster application provides a working demonstration of the RT1060 board integration, built using the Project CHIP codebase and the NXP @@ -54,8 +54,8 @@ The example supports: - Matter over Wi-Fi with Openthread Border Router support The example targets the -[NXP MIMXRT1060-EVKB](https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/mimxrt1060-evk-i-mx-rt1060-evaluation-kit:MIMXRT1060-EVK) -board by default. It is also possible to use the older EVK-MIMXRT1060 board, +[NXP MIMXRT1060-EVK-B](https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/mimxrt1060-evk-i-mx-rt1060-evaluation-kit:MIMXRT1060-EVK) +board by default. It is also possible to use the older MIMXRT1060-EVK board, build and board setup instructions differ in some steps. ### Configurations supported @@ -66,12 +66,12 @@ Matter over Wi-Fi : - RT1060 + IW416 (Wi-Fi + BLE) - RT1060 + 88W8801 (Wi-Fi) -- **Experimental:** _RT1060-EVKC + IW612 (Wi-fi +BLE)_ +- **Experimental:** _RT1060-EVK-C + IW612 (Wi-fi +BLE)_ Matter over Thread : - RT1060 + K32W0 (15.4 + BLE) -- **Experimental:** _RT1060-EVKC + IW612 (15.4 + BLE)_ +- **Experimental:** _RT1060-EVK-C + IW612 (15.4 + BLE)_ Matter over Wi-Fi with Openthread Border Router support : @@ -83,31 +83,31 @@ Matter over Wi-Fi with Openthread Border Router support : Host part: -- 1 MIMXRT1060-EVKB or EVK-MIMXRT1060 board +- 1 MIMXRT1060-EVK-B or MIMXRT1060-EVK board - external 5V supply Transceiver part: - 1 AzureWave AW-AM510-uSD evaluation board -Jumper settings for MIMXRT1060-EVKB (enables external 5V supply): +Jumper settings for MIMXRT1060-EVK-B (enables external 5V supply): - remove J40 5-6 - connect J40 1-2 - connect J45 with external power (controlled by SW6 - position 3) -Jumper settings for EVK-MIMXRT1060 (enables external 5V supply): +Jumper settings for MIMXRT1060-EVK (enables external 5V supply): - remove J1 5-6 - connect J1 1-2 - connect J2 with external power (enabled by SW1 - position 3) The hardware should be reworked according to the chapter _Hardware Rework Guide -for MIMXRT1060-EVKB and AW-AM510-uSD_ or the chapter _Hardware Rework Guide for -MIMXRT1060-EVK and AW-AM510-uSD_ in the document _Hardware Rework Guide for -EdgeFast BT PAL_ which can be found in the NXP RT1060 SDK -(docs/wireless/Bluetooth/Edgefast_bluetooth/Hardware Rework Guide for EdgeFast -BT PAL.pdf): +for MIMXRT1060-EVK-B and AW-AM510-uSD_ or the chapter _Hardware Rework Guide for +MIMXRT1060-EVK and AW-AM510-uSD_ in the document _`Hardware Rework Guide for +EdgeFast BT PAL`_ which can be found in the NXP RT1060 SDK +(*docs/wireless/bluetooth/edgefast_bluetooth/Hardware Rework Guide for EdgeFast +BT PAL.pdf*): - Make sure resistors R368/R376/R347/R349/R365/R363/R193/R186 are removed. @@ -117,24 +117,24 @@ using the west tool. Jumper settings for AzureWave AW-AM510-uSD Module: -- J4 1-2: VIO 1.8V (Voltage level of SDIO pins is 1.8V) +- J4 1-2: VIO 1.8V (Voltage level of SD-IO pins is 1.8V) - J2 1-2: 3.3V VIO_uSD (Power Supply from uSD connector) - The pin 1 of J4 is not marked on the board. Please note that pin numbering of J4 is opposite to J2. -Plug AW-AM510-uSD into uSD connector J22 on MIMXRT1060-EVKB or J39 on -EVK-MIMXRT1060. +Plug AW-AM510-uSD into uSD connector J22 on MIMXRT1060-EVK-B or J39 on +MIMXRT1060-EVK. Connect the following pins between RT1060 and AW-AM510-uSD to enable Bluetooth HCI UART: -| PIN NAME | AW-AM510-USD | MIMXRT1060-EVKB | EVK-MIMXRT1060 | PIN NAME OF RT1060 | GPIO NAME OF RT1060 | -| -------- | ------------ | --------------- | -------------- | ------------------ | ------------------- | -| UART_TXD | J10 (pin 4) | J16 (pin 1) | J22 (pin 1) | LPUART3_RXD | GPIO_AD_B1_07 | -| UART_RXD | J10 (pin 2) | J16 (pin 2) | J22 (pin 2) | LPUART3_TXD | GPIO_AD_B1_06 | -| UART_RTS | J10 (pin 6) | J33 (pin 3) | J23 (pin 3) | LPUART3_CTS | GPIO_AD_B1_04 | -| UART_CTS | J10 (pin 8\) | J33 (pin 4) | J23 (pin 4) | LPUART3_RTS | GPIO_AD_B1_05 | -| GND | J6 (pin 7) | J32 (pin 7) | J25 (pin 7) | GND | GND | +| PIN NAME | AW-AM510-uSD | MIMXRT1060-EVK-B | MIMXRT1060-EVK | PIN NAME OF RT1060 | GPIO NAME OF RT1060 | +| -------- | ------------ | ---------------- | -------------- | ------------------ | ------------------- | +| UART_TXD | J10 (pin 4) | J16 (pin 1) | J22 (pin 1) | LPUART3_RXD | GPIO_AD_B1_07 | +| UART_RXD | J10 (pin 2) | J16 (pin 2) | J22 (pin 2) | LPUART3_TXD | GPIO_AD_B1_06 | +| UART_RTS | J10 (pin 6) | J33 (pin 3) | J23 (pin 3) | LPUART3_CTS | GPIO_AD_B1_04 | +| UART_CTS | J10 (pin 8\) | J33 (pin 4) | J23 (pin 4) | LPUART3_RTS | GPIO_AD_B1_05 | +| GND | J6 (pin 7) | J32 (pin 7) | J25 (pin 7) | GND | GND | Attach external antenna into connector on AW-AM510-uSD. @@ -150,7 +150,7 @@ tool. Host part: -- 1 MIMXRT1060-EVKB +- 1 MIMXRT1060-EVK-B Transceiver part : @@ -158,7 +158,7 @@ Transceiver part : - 1 Murata uSD-M.2 Adapter (rev B1) The 88W8801 2DS M.2 Module should be inserted into the Murata uSD-M.2 Adapter and -inserted in the uSD slot J22 of MIMXRT1060-EVKB. The Murata uSD-M.2 Adapter can +inserted in the uSD slot J22 of MIMXRT1060-EVK-B. The Murata uSD-M.2 Adapter can be powered up using uSD pins. For that, set the J1 jumper of Murata uSD-M.2 to position 2-3 (Position 2-3: VBAT supply, typical 3.1 ~ 3.3V, from microSD connector). @@ -170,7 +170,7 @@ to connect it to a Wi-Fi access point on the 2.4 GHz band. Host part: -- 1 MIMXRT1060-EVKB or EVK-MIMXRT1060 board +- 1 MIMXRT1060-EVK-B or MIMXRT1060-EVK board Transceiver part: @@ -180,27 +180,27 @@ Transceiver part: **Board settings** The below table explains pin settings (UART settings) to connect the -evkbmimxrt1060 (host) to a k32w061 transceiver (rcp). +MIMXRT1060-EVK-B (host) to a k32w061 transceiver (rcp). -| PIN NAME | DK6 (K32W061) | I.MXRT1060-EVKB | I.MXRT1060-EVK | PIN NAME OF RT1060 | GPIO NAME OF RT1060 | -| :------------: | :-----------: | :-------------: | :------------: | :----------------: | :-----------------: | -| UART_TXD | PIO, pin 8 | J16, pin 1 | J22, pin 1 | LPUART3_RXD | GPIO_AD_B1_07 | -| UART_RXD | PIO, pin 9 | J16, pin 2 | J22, pin 2 | LPUART3_TXD | GPIO_AD_B1_06 | -| UART_RTS | PIO, pin 6 | J33, pin 3 | J23, pin 3 | LPUART3_CTS | GPIO_AD_B1_04 | -| UART_CTS | PIO, pin 7 | J33, pin 4 | J23, pin 4 | LPUART3_RTS | GPIO_AD_B1_05 | -| GND | J3, pin 1 | J32, pin 7 | J25, pin 7 | XX | XX | -| RESET | RSTN | J33, pin 2 | J23, pin 2 | GPIO_AD_B1_11 | GPIO_AD_B1_11 | -| DIO5/ISP Entry | PIO, pin 5 | J33, pin 1 | J23, pin 1 | GPIO_AD_B1_10 | GPIO_AD_B1_10 | +| PIN NAME | DK6 (K32W061) | MIMXRT1060-EVK-B | MIMXRT1060-EVK | PIN NAME OF RT1060 | GPIO NAME OF RT1060 | +| :------------: | :-----------: | :--------------: | :------------: | :----------------: | :-----------------: | +| UART_TXD | PIO, pin 8 | J16, pin 1 | J22, pin 1 | LPUART3_RXD | GPIO_AD_B1_07 | +| UART_RXD | PIO, pin 9 | J16, pin 2 | J22, pin 2 | LPUART3_TXD | GPIO_AD_B1_06 | +| UART_RTS | PIO, pin 6 | J33, pin 3 | J23, pin 3 | LPUART3_CTS | GPIO_AD_B1_04 | +| UART_CTS | PIO, pin 7 | J33, pin 4 | J23, pin 4 | LPUART3_RTS | GPIO_AD_B1_05 | +| GND | J3, pin 1 | J32, pin 7 | J25, pin 7 | XX | XX | +| RESET | RSTN | J33, pin 2 | J23, pin 2 | GPIO_AD_B1_11 | GPIO_AD_B1_11 | +| DIO5/ISP Entry | PIO, pin 5 | J33, pin 1 | J23, pin 1 | GPIO_AD_B1_10 | GPIO_AD_B1_10 | -The below picture shows pins connections for the EVK-MIMXRT1060. +The below picture shows pins connections for the MIMXRT1060-EVK. ![rt1060_k32w061_pin_settings](../../../../platform/nxp/rt/rt1060/doc/images/rt1060_k32w061_pin_settings.jpg) -#### Hardware requirements RT1060-EVKC+IW612 +#### Hardware requirements RT1060-EVK-C+IW612 Host part: -- 1 MIMXRT1060-EVKC +- 1 MIMXRT1060-EVK-C Hardware should be reworked as below: @@ -215,17 +215,18 @@ Host part: Transceiver part : -- 1 IW612 ( Firecrest) 2EL M.2 Module (rev A1) +- 1 + [2EL M2 A1 IW612 Secure Module](https://www.nxp.com/products/wireless/wi-fi-plus-bluetooth-plus-802-15-4/2-4-5-ghz-dual-band-1x1-wi-fi-6-802-11ax-plus-bluetooth-5-2-plus-802-15-4-tri-radio-solution:IW612) -The IW612 module should be plugged to the M.2 connector on RT1060-EVKC board. +![](../../../../platform/nxp/rt/rt1170/doc/images/iwx612_2EL.jpg) #### Hardware requirements RT1060 + 88W8801 + K32W0x1DK6 -- i.MX RT1060 EVKA or EVKB board +- i.MX RT1060 EVK-A or EVK-B board - 88W8801 module (for Wi-Fi connection), for example 88W8801 2DS M.2 Module (rev A) and Murata uSD-M.2 Adapter (rev B1) - K32W0x1 mezzanine module (for Thread connection) -- IOTZTB-DK006 carrier board for the K32W0x1 module (referenced as DK6 carrier +- IOT_ZTB-DK006 carrier board for the K32W0x1 module (referenced as DK6 carrier board) @@ -235,7 +236,7 @@ The IW612 module should be plugged to the M.2 connector on RT1060-EVKC board. In order to build the Project CHIP example, we recommend using a Linux distribution (supported Operating Systems are listed in [BUILDING.md](../../../../../docs/guides/BUILDING.md)). -- Make sure that below prerequisites are correctly installed (as described in [BUILDING.md](../../../../../docs/guides/BUILDING.md))) +- Make sure that below prerequisites are correctly installed (as described in [BUILDING.md](../../../../../docs/guides/BUILDING.md)). ``` sudo apt-get install git gcc g++ pkg-config libssl-dev libdbus-1-dev \ libglib2.0-dev libavahi-client-dev ninja-build python3-venv python3-dev \ @@ -268,9 +269,9 @@ Note: By default update_nxp_sdk.py will try to initialize all NXP SDKs. Arg "-- - Start building the application. -### Building with Matter over Wifi configuratiom on RT1060 + transceiver +### Building with Matter over Wifi configuration on RT1060 + transceiver -- Build the Wi-fi configuration for **MIMXRT1060-EVKB board + IW416 +- Build the Wi-fi configuration for **MIMXRT1060-EVK-B board + IW416 transceiver** (with BLE for commissioning). ``` @@ -278,7 +279,7 @@ user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt106 user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt1060$ ninja -C out/debug ``` -- Build the Wi-fi configuration for **EVKB-MIMXRT1060 board + 88W8801 +- Build the Wi-fi configuration for **MIMXRT1060-EVK-B board + 88W8801 transceiver** with Matter-over-Wifi configuration and only onnetwork commissioning (without BLE, the WiFi network credentials are provided at build-time which will enable the device to join the Wi-Fi AP at startup): @@ -288,7 +289,7 @@ user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt106 user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt1060$ ninja -C out/debug ``` -- Build the Wi-fi configuration for **MIMXRT1060-EVKC board + IW612 +- Build the Wi-fi configuration for **MIMXRT1060-EVK-C board + IW612 transceiver** (with BLE for commissioning). ``` @@ -296,7 +297,7 @@ user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt106 user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt1060$ ninja -C out/debug ``` -- Build the Wi-fi configuration for **MIMXRT1060-EVKC board + IW612 +- Build the Wi-fi configuration for **MIMXRT1060-EVK-C board + IW612 transceiver** with Matter-over-Wifi configuration and only onnetwork commissioning (without BLE, the WiFi network credentials are provided at build-time which will enable the device to join the Wi-Fi AP at startup): @@ -312,16 +313,16 @@ user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt106 For this configuration a K32W0 RCP image is required and must support in a single image the openthread RCP configuration and the BLE HCI BB configuration. -Messages between the host and the K32W0 transceiver are transfered on a single +Messages between the host and the K32W0 transceiver are transferred on a single UART with flow control support. For that the HDLC-Lite framing protocol is used -to transfert spinel and hci frames. In addition, hci and spinel frames can be +to transfer spinel and hci frames. In addition, hci and spinel frames can be distinguished by using the Spinel convention which is line compatible with BT/BLE HCI. Before building the Matter host application, it is required to generate the K32W0 image supporting features as described above. To build this binary the target `ot_rcp_ble_hci_bb_single_uart_fc` should be built by following the -[Readme.md][ot_rcp_ble_hci_bb_k32w0_readme]. After a successfull build, a `".h"` +[Readme.md][ot_rcp_ble_hci_bb_k32w0_readme]. After a successful build, a `".h"` file will be generated and would contain the K32W0 RCP binary. As described in the [Readme.md][ot_rcp_ble_hci_bb_k32w0_readme], the application binaries will be generated in @@ -362,9 +363,9 @@ user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt106 user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt1060$ ninja -C out/debug ``` -#### Build with Matter over Thread configuration on RT1060-EVKC + IW612 +#### Build with Matter over Thread configuration on RT1060-EVK-C + IW612 -Build the OpenThread configuration for MIMXRT1060-EVKC board + IW612 transceiver +Build the OpenThread configuration for MIMXRT1060-EVK-C board + IW612 transceiver (with BLE for commissioning). ``` @@ -407,7 +408,7 @@ Optional GN options that can be added when building an application: `chip_enable_matter_cli=true` must be added to the _gn gen_ command. - To build the application in debug mode, the argument `is_debug=true optimize_debug=false` must be added to the _gn gen_ command. -- By default, the MIMXRT1060-EVKB will be chosen. To switch to an +- By default, the MIMXRT1060-EVK-B will be chosen. To switch to an MIMXRT1060-EVK, the argument `evkname=\"evkmimxrt1060\"` must be added to the _gn gen_ command. - To build with the option to have Matter certificates/keys pre-loaded in a @@ -436,11 +437,11 @@ For production usage, it is recommended to use the OTP key which needs to be fused in the RT1060 SW_GP2. The application note AN12800 should be followed to get more information. In this case the all cluster app should be updated to indicate to the DCP module to use the OTP key instead of the software key. For -that the call to "FactoryDataPrvdImpl().SetAes128Key()" should be changed to -"FactoryDataPrvdImpl().SetKeySelected(KeySelect::)" with the arg value -specifying where the OTP key is stored (kDCP_OCOTPKeyLow for [127:0] of SW_GP2 -or kDCP_OCOTPKeyHigh for [255:128] of SW_GP2). For more information the RT1060 -FactoryDataProviderImpl class description should be checked. +that the call to `FactoryDataPrvdImpl().SetAes128Key()` should be changed to +`FactoryDataPrvdImpl().SetKeySelected(KeySelect::)` with the arg value +specifying where the OTP key is stored (`kDCP_OCOTPKeyLow` for [127:0] of SW_GP2 +or `kDCP_OCOTPKeyHigh` for [255:128] of SW_GP2). For more information the RT1060 +`FactoryDataProviderImpl` class description should be checked. @@ -451,7 +452,7 @@ In order to flash the application we recommend using - Import the previously downloaded NXP SDK into MCUXpresso IDE. -Right click the empty space in the MCUXpresso IDE's "Installed SDKs" tab to show +Right click the empty space in the MCUXpresso IDE "Installed SDKs" tab to show the menu, select the "Import local SDK Git repository" menu item. ![Import local SDK Git repository](../../../../platform/nxp/rt/rt1060/doc/images/import-local-repository.png) @@ -484,8 +485,8 @@ Right click on the Project -> Properties -> C/C++ Build -> MCU Settings -> Selec ![MCU_Set](../../../../platform/nxp/rt/rt1060/doc/images/mcu-set.png) Sometimes when the MCU is selected it will not initialize all the memory regions -(usualy the BOARD_FLASH, BOARD_SDRAM and NCAHCE_REGION) so it is required that -this regions are added manualy like in the image above. In addition to that on +(usually the BOARD_FLASH, BOARD_SDRAM and NCACHE_REGION) so it is required that +this regions are added manually like in the image above. In addition to that on the BOARD_FLASH line, in the driver tab: ``` @@ -556,7 +557,7 @@ Right click on the Project -> Utilities -> Open Directory Browser here -> edit * ## Testing the example -To know how to commision a device over BLE, follow the instructions from +To know how to commission a device over BLE, follow the instructions from [chip-tool's README.md 'Commission a device over BLE'][readme_ble_commissioning_section]. @@ -592,7 +593,7 @@ In this configuration, the device can be commissioned over Wi-Fi with the 1. Prepare the board with the flashed `All-cluster application` (as shown above). -2. The All-cluster example uses UART1 to print logs while runing the server. To +2. The All-cluster example uses UART1 to print logs while running the server. To view raw UART output, start a terminal emulator like PuTTY and connect to the used COM port with the following UART settings: @@ -642,10 +643,10 @@ Here are described steps to use the all-cluster-app with the Matter CLI enabled - No parity - No flow control -3. The All-cluster example uses UART2 to print logs while runing the server. To +3. The All-cluster example uses UART2 to print logs while running the server. To view raw UART output, a pin should be plugged to an USB to UART adapter - (connector J16 pin 7 in case of MIMXRT1060-EVKB board or connector J22 pin 7 - in case of EVK-MIMXRT1060 board), then start a terminal emulator like PuTTY + (connector J16 pin 7 in case of MIMXRT1060-EVK-B board or connector J22 pin 7 + in case of MIMXRT1060-EVK board), then start a terminal emulator like PuTTY and connect to the used COM port with the following UART settings: - Baud rate: 115200 @@ -692,9 +693,9 @@ Done leader Done ``` - + -## Thread Border Router overwiew +## Thread Border Router overview To enable Thread Border Router support see the [build](README.md#building) section. diff --git a/examples/all-clusters-app/nxp/rt/rt1170/README.md b/examples/all-clusters-app/nxp/rt/rt1170/README.md index 4146b9dd6bfd56..0641b394a245ea 100644 --- a/examples/all-clusters-app/nxp/rt/rt1170/README.md +++ b/examples/all-clusters-app/nxp/rt/rt1170/README.md @@ -1,6 +1,6 @@ # CHIP RT1170 All-clusters Application -The all-clusters example implements a server which can be accesed by a CHIP +The all-clusters example implements a server which can be accessed by a CHIP controller and can accept basic cluster commands. The example is based on @@ -13,13 +13,13 @@ commissioning and different cluster control. - [CHIP RT1170 All-clusters Application](#chip-rt1170-all-clusters-application) - [Introduction](#introduction) - [Configuration(s) supported](#configurations-supported) - - [Hardware requirements for RT1170 + IWX12](#hardware-requirements-for-rt1170--iwx12) - - [Hardware rework for SPI support on EVKB-MIMXRT1170](#hardware-rework-for-spi-support-on-evkb-mimxrt1170) + - [Hardware requirements for RT1170 + IW612](#hardware-requirements-for-rt1170--iw612) + - [Hardware rework for SPI support on MIMXRT1170-EVK-B](#hardware-rework-for-spi-support-on-mimxrt1170-evk-b) - [Board settings (Spinel over SPI, I2C, BLE over UART)](#board-settings-spinel-over-spi-i2c-ble-over-uart) - [Building](#building) - - [Building with Matter over Wifi configuration on RT1170 + IWX12](#building-with-matter-over-wifi-configuration-on-rt1170--iwx12) - - [Building with Matter over Thread configuration on RT1170 + IWX12](#building-with-matter-over-thread-configuration-on-rt1170--iwx12) - - [Building with Matter over Wifi + OpenThread Border Router configuration on RT1170 + IWX12](#building-with-matter-over-wifi--openthread-border-router-configuration-on-rt1170--iwx12) + - [Building with Matter over Wifi configuration on RT1170 + IW612](#building-with-matter-over-wifi-configuration-on-rt1170--iw612) + - [Building with Matter over Thread configuration on RT1170 + IW612](#building-with-matter-over-thread-configuration-on-rt1170--iw612) + - [Building with Matter over Wifi + OpenThread Border Router configuration on RT1170 + IW612](#building-with-matter-over-wifi--openthread-border-router-configuration-on-rt1170--iw612) - [General information](#general-information) - [Manufacturing data](#manufacturing-data) - [Flashing and debugging](#flashing-and-debugging) @@ -29,7 +29,7 @@ commissioning and different cluster control. - [Matter over wifi with openthread border router configuration :](#matter-over-wifi-with-openthread-border-router-configuration-) - [Testing the all-clusters application without Matter CLI:](#testing-the-all-clusters-application-without-matter-cli) - [Testing the all-clusters application with Matter CLI enabled:](#testing-the-all-clusters-application-with-matter-cli-enabled) - - [Thread Border Router overwiew](#thread-border-router-overwiew) + - [Thread Border Router overview](#thread-border-router-overview)
@@ -57,15 +57,15 @@ default. Here are listed configurations that allow to support Matter over Wi-Fi & Matter over Thread on RT1170 : -- RT1170 + IWX12 (Wi-Fi + BLE + 15.4) +- RT1170 + IW612 (Wi-Fi + BLE + 15.4) - + -### Hardware requirements for RT1170 + IWX12 +### Hardware requirements for RT1170 + IW612 Host part: -- 1 EVKB-MIMXRT1170 +- 1 MIMXRT1170-EVK-B Transceiver part : @@ -81,19 +81,19 @@ Transceiver part : - Male to female Burg cables -#### Hardware rework for SPI support on EVKB-MIMXRT1170 +#### Hardware rework for SPI support on MIMXRT1170-EVK-B -To support SPI on the EVKB-MIMXRT1170 board, it is required to remove 0Ω +To support SPI on the MIMXRT1170-EVK-B board, it is required to remove 0Ω resistors R404,R406,R2015. #### Board settings (Spinel over SPI, I2C, BLE over UART) -Plug IW612 Firecrest module to M.2 connector on Murata uSD to M2 adapter +Plug IW612 module to M.2 connector on Murata uSD to M2 adapter -The murata uSD-M2 adapter should be plugged to the RT1170 via SDIO. +The Murata uSD-M2 adapter should be plugged to the RT1170 via SD-IO. The below tables explain pin settings (SPI settings) to connect the -evkbmimxrt1170 (host) to a IWX12 transceiver (rcp). +MIMXRT1170-EVK-B (host) to a IW612 transceiver (rcp). - Murata uSD to M2 adapter connections description: @@ -106,22 +106,22 @@ evkbmimxrt1170 (host) to a IWX12 transceiver (rcp). Use USB-C power supply | Jumper | Position| | :----: | :-----: | | J1 | 1-2 | | J12 | 1-2 | | J13 | 1-2 | | J14 | 1-2 | | JP1.1 (back side)| ON | -- Jumpers positions on MIMXRT1170-EVKB: +- Jumpers positions on MIMXRT1170-EVK-B: | Jumper | Position | | :----: | :------: | | J56 | 2-3 | -- I2C connection to program IO-Expander on the IW612 module +- I2C connection to program IO_Expander on the IW612 module - | MIMXRT1170-EVKB | uSD-M2 adapter | + | MIMXRT1170-EVK-B | uSD-M2 adapter | | :--------------: | :------------: | | I2C_SDA (J10.18) | J5.2 | | I2C_SDL (J10.20) | J5.4 | - SPI connection between RT1170 and uSD-M2 adapter - | MIMXRT1170-EVKB | uSD-M2 adapter | + | MIMXRT1170-EVK-B | uSD-M2 adapter | | :---------------: | :------------: | | SPI_MOSI (J10.8) | J5.10 | | SPI_MISO (J10.10) | J9.7 | @@ -132,13 +132,13 @@ evkbmimxrt1170 (host) to a IWX12 transceiver (rcp). - UART BLE and Reset connections between RT1170 and uSD-M2 adapter - | MIMXRT1170-EVKB | uSD-M2 adapter | + | MIMXRT1170-EVK-B | uSD-M2 adapter | | :---------------: | :------------: | | RESET (J26.2) | J9.3 | - | UART RXD (J25.13) | J9.1 | - | UART TXD (J25.15) | J9.2 | - | UART CTS (J25.9) | J8.4 | - | UART RTS (J25.11) | J8.3 | + | UART_RXD (J25.13) | J9.1 | + | UART_TXD (J25.15) | J9.2 | + | UART_CTS (J25.9) | J8.4 | + | UART_RTS (J25.11) | J8.3 | | GND (J26.1) | J7.6 | @@ -183,9 +183,9 @@ Note: By default update_nxp_sdk.py will try to initialize all NXP SDKs. Arg "-- user@ubuntu:~/Desktop/git/connectedhomeip$ cd examples/all-cluster-app/nxp/rt/rt1170/ ``` -### Building with Matter over Wifi configuration on RT1170 + IWX12 +### Building with Matter over Wifi configuration on RT1170 + IW612 -- Build the Wi-fi configuration for MIMXRT1170 board + IWX12 transceiver (with +- Build the Wi-fi configuration for MIMXRT1170 board + IW612 transceiver (with BLE for commissioning). ``` @@ -193,9 +193,9 @@ user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt117 user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-clusters-app/nxp/rt/rt1170$ ninja -C out/debug ``` -### Building with Matter over Thread configuration on RT1170 + IWX12 +### Building with Matter over Thread configuration on RT1170 + IW612 -- Build the Openthread configuration for MIMXRT1170 board + IWX12 transceiver +- Build the Openthread configuration for MIMXRT1170 board + IW612 transceiver (with BLE for commissioning). ``` @@ -203,7 +203,7 @@ user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-cluster/nxp/rt/rt1170$ gn user@ubuntu:~/Desktop/git/connectedhomeip/examples/all-cluster/nxp/rt/rt1170/$ ninja -C out/debug ``` -### Building with Matter over Wifi + OpenThread Border Router configuration on RT1170 + IWX12 +### Building with Matter over Wifi + OpenThread Border Router configuration on RT1170 + IW612 This configuration supports the Thread Border Router management cluster to provision the Thread credentials. Enabling the Matter CLI in order to control the Thread network on the Border Router is optional but recommended for other features like the Thread credential sharing. @@ -241,7 +241,7 @@ Optional GN options that can be added when building an application: - To build the application with the OTA Requestor enabled, the arguments `chip_enable_ota_requestor=true no_mcuboot=false` must be added to the _gn gen_ command. (More information about the OTA Requestor feature in - [OTA Requestor README](../../../../../docs/guides/nxp/nxp_RTs_ota_software_update.md))) + [OTA Requestor README](../../../../../docs/guides/nxp/nxp_RTs_ota_software_update.md)) @@ -264,7 +264,7 @@ In order to flash the application we recommend using [MCUXpresso IDE (version >= 11.5.0)](https://www.nxp.com/design/software/development-software/mcuxpresso-software-and-tools-/mcuxpresso-integrated-development-environment-ide:MCUXpresso-IDE). - Import the previously downloaded NXP SDK into MCUXpresso IDE. This can be - done by drag-and-dropping the SDK archive into MCUXpresso IDE's "Installed + done by drag-and-dropping the SDK archive into MCUXpresso IDE "Installed SDKs" tab; ![Select SDK](../../../../platform/nxp/rt/rt1170/doc/images/select-sdk.png) - Import the connectedhomeip repo in MCUXpresso IDE as Makefile Project. Use @@ -283,8 +283,8 @@ Right click on the Project -> Properties -> C/C++ Build -> MCU Settings -> Selec ![MCU_Sett](../../../../platform/nxp/rt/rt1170/doc/images/mcu-set.png) Sometimes when the MCU is selected it will not initialize all the memory regions -(usualy the BOARD_FLASH, BOARD_SDRAM and NCAHCE_REGION) so it is required that -this regions are added manualy like in the image above. In addition to that on +(usually the BOARD_FLASH, BOARD_SDRAM and NCACHE_REGION) so it is required that +this regions are added manually like in the image above. In addition to that on the BOARD_FLASH line, in the driver tab: ``` @@ -305,7 +305,7 @@ Right click on the Project -> C/C++ Build-> Tool Chain Editor -> NXP MCU Tools - - Create a debug configuration: - MIMXRT1170-EVKB board supports CMSIS-DAP debug protocol by default. It + MIMXRT1170-EVK-B board supports CMSIS-DAP debug protocol by default. It should be switched to JLink. - download and install @@ -354,7 +354,7 @@ Right click on the Project -> Utilities -> Open Directory Browser here -> edit * ## Testing the example -To know how to commision a device over BLE, follow the instructions from +To know how to commission a device over BLE, follow the instructions from [chip-tool's README.md 'Commission a device over BLE'][readme_ble_commissioning_section]. @@ -494,9 +494,9 @@ Done leader Done ``` - + -## Thread Border Router overwiew +## Thread Border Router overview To enable Thread Border Router support see the [build](README.md#building) section.