Skip to content

Commit 4915fb0

Browse files
marian-chereji-nxpmarian-chereji-nxp
authored
[NXP][doc][mcxw7x] Update MCXW7x platforms documentation (#41910)
* [nxp][doc][examples][mcxw71] Restructure platform documentation Signed-off-by: Marian Chereji <marian.chereji@nxp.com> * [nxp][doc][examples][mcxw72] Restructure platform documentation Signed-off-by: Marian Chereji <marian.chereji@nxp.com> * [nxp][cmake][platform][mcxw7x] Remove unused ICD build options Removed the build options o CONFIG_CHIP_ICD_IDLE_MODE_INTERVAL_MS o CONFIG_CHIP_ICD_ACTIVE_MODE_INTERVAL_MS which don't seem to be used anywhere. They were most likely leftovers after replacement with o CHIP_ICD_IDLE_MODE_DURATION o CHIP_ICD_ACTIVE_MODE_DURATION Signed-off-by: Marian Chereji <marian.chereji@nxp.com> --------- Signed-off-by: Marian Chereji <marian.chereji@nxp.com>
1 parent 1faccfc commit 4915fb0

File tree

16 files changed

+717
-1726
lines changed

16 files changed

+717
-1726
lines changed

‎.github/.wordlist.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -910,6 +910,7 @@ mcumgr
910910
MCUs
911911
mcux
912912
MCUXpresso
913+
MCXW
913914
mdash
914915
MDNS
915916
MediaInput

‎config/nxp/cmake/Kconfig.matter.common‎

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -352,26 +352,13 @@ config CHIP_ICD_IDLE_MODE_DURATION
352352
It determines the maximum amount of time the device can stay in the idle mode, which means the
353353
device may be unreachable and not able to receive messages.
354354

355-
config CHIP_ICD_IDLE_MODE_INTERVAL_MS
356-
int "Intermittently Connected Device idle mode interval (ms)"
357-
default 2000
358-
help
359-
Provides the ICD idle mode interval in milliseconds.
360-
361-
362355
config CHIP_ICD_ACTIVE_MODE_DURATION
363356
int "Intermittently Connected Device active mode duration (ms)"
364357
default 10000
365358
help
366359
Provides the Intermittently Connected Device active mode duration in milliseconds.
367360
It determines the minimum amount of time the device shall stay in the active mode.
368361

369-
config CHIP_ICD_ACTIVE_MODE_INTERVAL_MS
370-
int "Intermittently Connected Device active mode interval (ms)"
371-
default 500
372-
help
373-
Provides the ICD active mode interval in milliseconds.
374-
375362
config CHIP_ICD_ACTIVE_MODE_THRESHOLD
376363
int "Intermittently Connected Device active mode threshold (ms)"
377364
default 5000

‎docs/platforms/nxp/nxp_examples_freertos_platforms.md‎

Lines changed: 50 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
- [Testing the example](#testing-the-example)
77
- [Matter Shell](#testing-the-example-application-with-matter-cli-enabled)
88

9+
<a name="introduction"></a>
10+
911
## Introduction
1012

1113
This guide provides step-by-step instructions for working with CHIP applications
@@ -18,6 +20,8 @@ The NXP examples are based on
1820
and provide a prototype application that demonstrates device commissioning and
1921
different cluster control.
2022

23+
<a name="supported-platforms"></a>
24+
2125
### Supported platforms
2226

2327
Matter example applications are supported on the following NXP platforms :
@@ -27,6 +31,10 @@ Matter example applications are supported on the following NXP platforms :
2731
| RW61x | [Matter NXP Guide for RW61x platform](./nxp_rw61x_guide.md) |
2832
| RT1170 | [Matter NXP Guide for RT1170 platform](./nxp_rt1170_guide.md) |
2933
| RT1060 | [Matter NXP Guide for RT1060 platform](./nxp_rt1060_guide.md) |
34+
| MCXW71 | [Matter NXP Guide for MCXW71 platform](./nxp_mcxw71_guide.md) |
35+
| MCXW72 | [Matter NXP Guide for MCXW72 platform](./nxp_mcxw72_guide.md) |
36+
37+
<a name="building"></a>
3038

3139
## Building
3240

@@ -60,7 +68,7 @@ user@ubuntu:~/Desktop/git/connectedhomeip$ scripts/checkout_submodules.py --shal
6068

6169
- Step 2 : Activate Matter environment :
6270

63-
If you are setting the Matter environment for the first time, or your local
71+
If you are setting up the Matter environment for the first time, or your local
6472
environment is out of date, run the following script :
6573

6674
```
@@ -97,8 +105,8 @@ export the path as follows :
97105
user@ubuntu:~/Desktop/git/connectedhomeip$ export ARMGCC_DIR=/path/to/connectedhomeip/.environment/cipd/packages/arm
98106
```
99107

100-
> Note : Steps 1 to 3 can be skipped if your environment is up to date. Steps 4
101-
> and 5 should be repeated in each new terminal session to ensure the
108+
> Note : Steps 1 and 3 can be skipped if your environment is up to date. Steps
109+
> 2, 4 and 5 should be repeated in each new terminal session to ensure the
102110
> environment is correctly configured.
103111
104112
### Build the application
@@ -114,6 +122,8 @@ CHIP NXP examples support building with two different build systems :
114122
> Please refer to the platform [dedicated readme](#supported-platforms) to check
115123
> which build system(s) is supported by the platform.
116124
125+
<a name="cmake-build-system"></a>
126+
117127
#### CMake build system
118128

119129
The example application can be built with `west build` command, which can be
@@ -153,29 +163,39 @@ Additional arguments that can be passed in the `west build` command line :
153163
> configuration supported, please refer to the
154164
> [dedicated readme](#supported-platforms) for the platform you are targeting.
155165
166+
<a name="build-config-files"></a>
167+
156168
##### Available project configuration files and platform compatibility
157169

158-
| Configuration File | Description | Supported platforms |
159-
| ------------------------------------------ | ------------------------------------------------------ | --------------------- |
160-
| `prj_wifi.conf` | Wi-Fi | RW61x, RT1060, RT1170 |
161-
| `prj_wifi_fdata.conf` | Wi-Fi, factory data | RW61x, RT1060, RT1170 |
162-
| `prj_wifi_ota_fdata.conf` | Wi-Fi, factory data, OTA | RW61x, RT1060, RT1170 |
163-
| `prj_wifi_ota_fdata_v2.conf` | Wi-Fi, factory data, OTA, with SW v2 | RW61x, RT1060, RT1170 |
164-
| `prj_wifi_ota.conf` | Wi-Fi, OTA | RW61x, RT1060, RT1170 |
165-
| `prj_wifi_ota_v2.conf` | Wi-Fi, OTA, SW v2 | RW61x, RT1060, RT1170 |
166-
| `prj_wifi_onnetwork.conf` | Wi-Fi onnetwork without BLE | RW61x, RT1060, RT1170 |
167-
| `prj_thread_ftd.conf` | Thread FTD | RW61x, RT1060, RT1170 |
168-
| `prj_thread_ftd_ota.conf` | Thread FTD, OTA | RW61x, RT1060, RT1170 |
169-
| `prj_thread_ftd_ota_fdata.conf` | Thread FTD, OTA, factory data | RW61x, RT1060, RT1170 |
170-
| `prj_thread_ftd_wifi_br_ota.conf` | Wi-Fi + Thread Border Router, OTA | RW61x, RT1060, RT1170 |
171-
| `prj_thread_ftd_wifi_br_ota_fdata.conf` | Wi-Fi + Thread Border Router, OTA, factory data | RW61x, RT1060, RT1170 |
172-
| `prj_thread_ftd_wifi_br_ota_fdata_v2.conf` | Wi-Fi + Thread Border Router, OTA SW v2 , factory data | RW61x, RT1060, RT1170 |
173-
| `prj_thread_ftd_wifi_br_ota_v2.conf` | Wi-Fi + Thread Border Router, OTA with SW v2 | RW61x, RT1060, RT1170 |
174-
| `prj_eth.conf` | Ethernet | RW61x `frdm` |
175-
| `prj_eth_fdata.conf` | Ethernet, factory data | RW61x `frdm` |
176-
| `prj_eth_ota.conf` | Ethernet, OTA | RW61x `frdm` |
177-
| `prj_eth_ota_fdata.conf` | Ethernet, factory data, OTA | RW61x `frdm` |
178-
| `prj_eth_ota_fdata_v2.conf` | Ethernet, factory data, OTA, SW v2 | RW61x `frdm` |
170+
| Configuration File | Description | Supported platforms |
171+
| ------------------------------------------ | ------------------------------------------------------ | ------------------------------------- |
172+
| `prj_wifi.conf` | Wi-Fi | RW61x, RT1060, RT1170 |
173+
| `prj_wifi_fdata.conf` | Wi-Fi, factory data | RW61x, RT1060, RT1170 |
174+
| `prj_wifi_ota_fdata.conf` | Wi-Fi, factory data, OTA | RW61x, RT1060, RT1170 |
175+
| `prj_wifi_ota_fdata_v2.conf` | Wi-Fi, factory data, OTA, with SW v2 | RW61x, RT1060, RT1170 |
176+
| `prj_wifi_ota.conf` | Wi-Fi, OTA | RW61x, RT1060, RT1170 |
177+
| `prj_wifi_ota_v2.conf` | Wi-Fi, OTA, SW v2 | RW61x, RT1060, RT1170 |
178+
| `prj_wifi_onnetwork.conf` | Wi-Fi onnetwork without BLE | RW61x, RT1060, RT1170 |
179+
| `prj_thread_ftd.conf` | Thread FTD | RW61x, RT1060, RT1170, MCXW71, MCXW72 |
180+
| `prj_thread_ftd_fdata.conf` | Thread FTD, factory data | RW61x, RT1060, RT1170, MCXW71, MCXW72 |
181+
| `prj_thread_ftd_ota.conf` | Thread FTD, OTA | RW61x, RT1060, RT1170, MCXW71, MCXW72 |
182+
| `prj_thread_ftd_ota_fdata.conf` | Thread FTD, OTA, factory data | RW61x, RT1060, RT1170, MCXW71, MCXW72 |
183+
| `prj_thread_ftd_wifi_br_ota.conf` | Wi-Fi + Thread Border Router, OTA | RW61x, RT1060, RT1170 |
184+
| `prj_thread_ftd_wifi_br_ota_fdata.conf` | Wi-Fi + Thread Border Router, OTA, factory data | RW61x, RT1060, RT1170 |
185+
| `prj_thread_ftd_wifi_br_ota_fdata_v2.conf` | Wi-Fi + Thread Border Router, OTA SW v2 , factory data | RW61x, RT1060, RT1170 |
186+
| `prj_thread_ftd_wifi_br_ota_v2.conf` | Wi-Fi + Thread Border Router, OTA with SW v2 | RW61x, RT1060, RT1170 |
187+
| `prj_thread_mtd.conf` | Thread MTD | MCXW71, MCXW72 |
188+
| `prj_thread_mtd_fdata.conf` | Thread MTD, factory data | MCXW71, MCXW72 |
189+
| `prj_thread_mtd_low_power.conf` | Thread MTD operating in low power mode | MCXW71, MCXW72 |
190+
| `prj_thread_mtd_low_power_lit.conf` | Thread MTD, low power ICD LIT | MCXW71, MCXW72 |
191+
| `prj_thread_mtd_fdata_low_power.conf` | Thread MTD, factory data, low power | MCXW71, MCXW72 |
192+
| `prj_thread_mtd_ota_low_power.conf` | Thread MTD, OTA, low power | MCXW71, MCXW72 |
193+
| `prj_thread_mtd_ota_fdata.conf` | Thread MTD, OTA, factory data | MCXW71, MCXW72 |
194+
| `prj_eth.conf` | Ethernet | RW61x `frdm` |
195+
| `prj_eth_fdata.conf` | Ethernet, factory data | RW61x `frdm` |
196+
| `prj_eth_ota.conf` | Ethernet, OTA | RW61x `frdm` |
197+
| `prj_eth_ota_fdata.conf` | Ethernet, factory data, OTA | RW61x `frdm` |
198+
| `prj_eth_ota_fdata_v2.conf` | Ethernet, factory data, OTA, SW v2 | RW61x `frdm` |
179199

180200
The build output can be found under the `build_dir` specified in the
181201
`west build` command, the binary can be found under the following name :
@@ -244,12 +264,16 @@ _gn gen_ command when building an application.
244264
> For more information about platform-specific GN options, please refer to the
245265
> platform [dedicated readme](#supported-platforms).
246266
267+
<a name="flashing-and-debugging"></a>
268+
247269
## Flashing and debugging
248270

249271
For flashing and debugging the example application, follow detailed instructions
250-
form the [dedicated readme](#supported-platforms) to the platform you are
272+
from the [dedicated readme](#supported-platforms) to the platform you are
251273
targeting.
252274

275+
<a name="testing-the-example"></a>
276+
253277
## Testing the example
254278

255279
CHIP Tool is a Matter controller which can be used to commission a Matter device
@@ -314,7 +338,7 @@ The Matter CLI can be enabled with the NXP CHIP application.
314338
For more information about the Matter CLI default commands, you can refer to the
315339
dedicated [ReadMe](../../../examples/shell/README.md).
316340

317-
The NXP application supports additional commands :
341+
The NXP applications support additional commands :
318342

319343
```
320344
> help

‎docs/platforms/nxp/nxp_manufacturing_flow.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -140,12 +140,13 @@ Here is the interpretation of the **optional** parameters:
140140

141141
## 3. Write provisioning data
142142

143-
| platform | tool | command | details |
144-
| -------- | --------------------------- | ------------------------------------- | -------------------------------------------------------------------------------------------------- |
145-
| `mcxw71` | `JLink` | `loadfile factory_data.bin 0xFE080` | NA |
146-
| `rw61x` | `JLink` | `loadfile factory_data.bin 0xBFFF000` | Here, `0xBFFF000` is the value of symbol `__FACTORY_DATA_START` from the corresponding `.map` file |
147-
| `rt1060` | `MCUXpresso Flash Tool GUI` | NA | The address is given by the `__FACTORY_DATA_START` symbol in the `.map` file |
148-
| `rt1170` | `MCUXpresso Flash Tool GUI` | NA | The address is given by the `__FACTORY_DATA_START` symbol in the `.map` file |
143+
| platform | tool | command | details |
144+
| -------- | --------------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------- |
145+
| `mcxw71` | `JLink` | `loadfile factory_data.bin 0xFE080` | NA |
146+
| `mcxw72` | `blhost` | `write-memory 0x2002680 factory_data.bin` | Factory data is written in `IFR0`, sector 1 at a predefined offset. The address is expanded here. |
147+
| `rw61x` | `JLink` | `loadfile factory_data.bin 0xBFFF000` | Here, `0xBFFF000` is the value of symbol `__FACTORY_DATA_START` from the corresponding `.map` file |
148+
| `rt1060` | `MCUXpresso Flash Tool GUI` | NA | The address is given by the `__FACTORY_DATA_START` symbol in the `.map` file |
149+
| `rt1170` | `MCUXpresso Flash Tool GUI` | NA | The address is given by the `__FACTORY_DATA_START` symbol in the `.map` file |
149150

150151
## 4. Build app and usage
151152

0 commit comments

Comments
 (0)