Skip to content

Commit 039e9b2

Browse files
marius-alex-tachemarius-alex-tache
committed
[NXP][docs] Fix spellcheck errors
Signed-off-by: marius-alex-tache <marius.tache@nxp.com>
1 parent 2686f48 commit 039e9b2

File tree

8 files changed

+220
-182
lines changed

8 files changed

+220
-182
lines changed

‎docs/QUICK_START.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ and platforms.
1717
Use one of the controllers listed above and then a Border Router and Node
1818
combination listed below.
1919

20-
| <div style="width:200px">Border Router</div> | <div style="width:200px">Node</div> | Description |
21-
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22-
| [**ot-br**](https://openthread.io/guides/border-router/build)<br>Thread Border Router <li>RasPi <li>BeagleBone | **lighting-app** <li>[Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nrfconnect/README.md) <li> [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nxp/k32w0/README.md) <li> [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/qpg) <li> [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/silabs/README.md) | The Lighting example is supported by many of the available Thread platforms. See the chip-tool controller instructions for how to actuate the light on/off cluster. |
23-
| [**ot-br**](https://openthread.io/guides/border-router/build)<br>Thread Border Router <li>RasPi <li>BeagleBone | **lock-app** <li>[Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/nrfconnect/README.md) <li> [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/qpg) <li> [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/efr32/README.md) <li> [TI CC13x2x7](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/cc13x2x7_26x2x7/README.md) | The Lock example is supported by many of the available Thread and Wi-Fi platforms. |
20+
| <div style="width:200px">Border Router</div> | <div style="width:200px">Node</div> | Description |
21+
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22+
| [**ot-br**](https://openthread.io/guides/border-router/build)<br>Thread Border Router <li>RasPi <li>BeagleBone | **lighting-app** <li>[Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nrfconnect/README.md) <li> [NXP K32W](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/nxp/k32w0/README.md) <li> [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/qpg) <li> [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lighting-app/silabs/README.md) | The Lighting example is supported by many of the available Thread platforms. See the chip-tool controller instructions for how to actuate the light on/off cluster. |
23+
| [**ot-br**](https://openthread.io/guides/border-router/build)<br>Thread Border Router <li>RasPi <li>BeagleBone | **lock-app** <li>[Nordic nRF5x](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/nrfconnect/README.md) <li> [Qorvo QPG6100](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/qpg) <li> [Silicon Labs EFR32](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/efr32/README.md) <li> [TI CC13x2x7](https://github.com/project-chip/connectedhomeip/tree/master/examples/lock-app/cc13x2x7_26x2x7/README.md) | The Lock example is supported by many of the available Thread and Wi-Fi platforms. |
2424

2525
## Controllers
2626

‎docs/guides/nxp/nxp_k32w0_ota_guide.md

+54-41
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,25 @@
44

55
There are multiple SSBL binaries provided by the SDK:
66

7-
| description | github SDK path | package SDK path |
8-
| ------ | --------------- | ---------------- |
9-
| Default SSBL | NA | `boards/k32w061dk6/wireless_examples/framework/ssbl/binary/ssbl.bin` |
7+
| description | github SDK path | package SDK path |
8+
| ------------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
9+
| Default SSBL | NA | `boards/k32w061dk6/wireless_examples/framework/ssbl/binary/ssbl.bin` |
1010
| SSBL with PDM in external flash | `examples/k32w061dk6/wireless_examples/framework/ssbl/binary/ssbl_ext_flash_pdm_support.bin` | `boards/k32w061dk6/wireless_examples/framework/ssbl/binary/ssbl_ext_flash_pdm_support.bin` |
1111

12-
The SSBL is also built alongside the reference application and it can be configured
13-
according to the following table:
14-
15-
| gn arg | default | description |
16-
| ------ | ------- | ----------- |
17-
| `ssbl_pdm_external_flash` | true | Enable/disable PDM in external flash |
18-
| `ssbl_multi_image_support` | true | Enable/disable multi-image OTA feature |
19-
| `ssbl_ota_entry_storage` | "OTACustomStorage_ExtFlash" | Configure custom OTA entry storage type |
20-
| `ssbl_simple_hash_verification` | false | Enable/disable simple hash verification alternative to secure boot |
21-
| `ssbl_optimize_spifi_flash` | false | Optimize SPIFI flash driver size |
22-
| `ssbl_spifi_dual_mode` | false | Enable/disable SPIFI dual mode support (e.g. used by K32W041AM variant) |
23-
| `ssbl_version` | 0 | Set SSBL version |
24-
| `ssbl_use_redlib` | false | Enable/disable usage of redlib NXP library. If false, the build will use newlib nano |
25-
| `ssbl_ota_data_in_external_flash` | false | Enable/disable OTA support for application with sections stored in external flash |
12+
The SSBL is also built alongside the reference application and it can be
13+
configured according to the following table:
14+
15+
| gn arg | default | description |
16+
| --------------------------------- | --------------------------- | ---------------------------------------------------------------------------------------- |
17+
| `ssbl_pdm_external_flash` | true | Enable/disable PDM in external flash |
18+
| `ssbl_multi_image_support` | true | Enable/disable multi-image OTA feature |
19+
| `ssbl_ota_entry_storage` | "OTACustomStorage_ExtFlash" | Configure custom OTA entry storage type |
20+
| `ssbl_simple_hash_verification` | false | Enable/disable simple hash verification alternative to secure boot |
21+
| `ssbl_optimize_spifi_flash` | false | Optimize `SPIFI` flash driver size |
22+
| `ssbl_spifi_dual_mode` | false | Enable/disable `SPIFI` dual mode support (e.g. used by K32W041AM variant) |
23+
| `ssbl_version` | 0 | Set SSBL version |
24+
| `ssbl_use_redlib` | false | Enable/disable usage of `redlib` NXP library. If false, the build will use `newlib` nano |
25+
| `ssbl_ota_data_in_external_flash` | false | Enable/disable OTA support for application with sections stored in external flash |
2626

2727
## Simple hash verification
2828

@@ -35,11 +35,13 @@ image for integrity check. Applications should be built with
3535
Before writing the SSBL, it it recommanded to fully erase the internal flash.
3636

3737
Using DK6Programmer utility from Windows:
38+
3839
```
3940
DK6Programmer.exe -V 5 -P 1000000 -s <COM_PORT> -e Flash
4041
```
4142

42-
Using dk6prog from SPSDK:
43+
Using `dk6prog` from `SPSDK`:
44+
4345
```
4446
$ dk6prog listdev
4547
This is an experimental utility. Use with caution!
@@ -56,19 +58,20 @@ Erasing memory [####################################] 100%
5658
`chip-k32w0x-ssbl.bin` must be written at address 0 in the internal flash:
5759

5860
Using DK6Programmer utility from Windows:
61+
5962
```
6063
DK6Programmer.exe -V2 -s <COM_PORT> -P 1000000 -Y -p FLASH@0x00="chip-k32w0x-ssbl.bin"
6164
```
6265

63-
Using dk6prog from SPSDK:
66+
Using `dk6prog` from `SPSDK`:
6467

6568
```
6669
$ dk6prog -d DN038ZH3 write 0 ~/path/to/bin/chip-k32w0x-ssbl.bin
6770
6871
This is an experimental utility. Use with caution!
6972
7073
Writing memory [####################################] 100%
71-
Writen 7890 bytes to memory ID 0 at address 0x0
74+
Written 7890 bytes to memory ID 0 at address 0x0
7275
```
7376

7477
### Writing the PSECT
@@ -115,18 +118,20 @@ This is the list of all supported partitions:
115118
First, image directory 0 (SSBL partition) must be written:
116119

117120
Using DK6Programmer utility from Windows:
121+
118122
```
119123
DK6Programmer.exe -V5 -s <COM port> -P 1000000 -w image_dir_0=0000000010000000
120124
```
121125

122-
Using dk6prog from SPSDK:
126+
Using `dk6prog` from `SPSDK`:
127+
123128
```
124129
$ dk6prog -d DN038ZH3 write 0x160 [[0000000010000000]] 8 PSECT
125130
126131
This is an experimental utility. Use with caution!
127132
128133
Writing memory [####################################] 100%
129-
Writen 8 bytes to memory ID PSECT at address 0x160
134+
Written 8 bytes to memory ID PSECT at address 0x160
130135
```
131136

132137
Here is the interpretation of the fields:
@@ -141,18 +146,20 @@ Here is the interpretation of the fields:
141146
Second, image directory 1 (application partition) must be written:
142147

143148
Using DK6Programmer utility from Windows:
149+
144150
```
145151
DK6Programmer.exe -V5 -s <COM port> -P 1000000 -w image_dir_1=00400000C9040101
146152
```
147153

148-
Using dk6prog from SPSDK:
154+
Using `dk6prog` from `SPSDK`:
155+
149156
```
150157
$ dk6prog -d DN038ZH3 write 0x168 [[00400000C9040101]] 8 PSECT
151158
152159
This is an experimental utility. Use with caution!
153160
154161
Writing memory [####################################] 100%
155-
Writen 8 bytes to memory ID PSECT at address 0x168
162+
Written 8 bytes to memory ID PSECT at address 0x168
156163
```
157164

158165
Here is the interpretation of the fields:
@@ -164,34 +171,37 @@ C904 -> 0x4C9 pages of 512-bytes (= 612.5kB)
164171
01 -> image type for the application
165172
```
166173

167-
Please note the user can write additional partitions by writing `image_dir_2/3/4`
168-
with the wanted configuration. In case of using the SPSDK tool, the appropriate offset
169-
must be calculated
174+
Please note the user can write additional partitions by writing
175+
`image_dir_2/3/4` with the wanted configuration. In case of using the `SPSDK`
176+
tool, the appropriate offset must be calculated
170177

171178
## Removing SSBL Upgrade Region
172179

173-
The example also offers the possibility to remove SSBL upgrade region, for reserving more
174-
space for application level.
180+
The example also offers the possibility to remove SSBL upgrade region, for
181+
reserving more space for application level.
175182

176-
A new flag `chip_reduce_ssbl_size` is introduced. In order to remove the SSBL upgrade region,
177-
`chip_reduce_ssbl_size=true` must be provided to the build system
183+
A new flag `chip_reduce_ssbl_size` is introduced. In order to remove the SSBL
184+
upgrade region, `chip_reduce_ssbl_size=true` must be provided to the build
185+
system
178186

179187
The programming method will change:
180188

181-
* Writing image directory 1 should change to
182-
Using DK6Programmer utility from Windows:
189+
- Writing image directory 1 should change to Using DK6Programmer utility from
190+
Windows:
191+
183192
```
184193
DK6Programmer.exe -V5 -s <COM port> -P 1000000 -w image_dir_1=00200000D9040101
185194
```
186195
187-
Using dk6prog from SPSDK:
196+
Using `dk6prog` from `SPSDK`:
197+
188198
```
189199
$ dk6prog -d DN038ZH3 write 0x168 [[00200000D9040101]] 8 PSECT
190200
191201
This is an experimental utility. Use with caution!
192202
193203
Writing memory [####################################] 100%
194-
Writen 8 bytes to memory ID PSECT at address 0x168
204+
Written 8 bytes to memory ID PSECT at address 0x168
195205
```
196206
197207
Here is the interpretation of the fields:
@@ -202,18 +212,21 @@ The programming method will change:
202212
01 -> bootable flag
203213
01 -> image type for the application
204214
```
205-
* Matter application offset address should change to
206-
Using DK6Programmer utility from Windows:
215+
216+
- Matter application offset address should change to Using DK6Programmer
217+
utility from Windows:
218+
207219
```
208220
DK6Programmer.exe -V2 -s <COM_PORT> -P 1000000 -Y -p FLASH@0x2000="chip-k32w0x-contact-example.bin"
209221
```
210222
211-
Using dk6prog from SPSDK:
212-
```
223+
Using `dk6prog` from `SPSDK`:
224+
225+
```
213226
$ dk6prog -d DN038ZH3 write 0x2000 ~/path/to/bin/chip-k32w0x-contact-example.bin
214227
215228
This is an experimental utility. Use with caution!
216229
217230
Writing memory [####################################] 100%
218-
Writen 596450 bytes to memory ID 0 at address 0x2000
219-
```
231+
Written 596450 bytes to memory ID 0 at address 0x2000
232+
```

‎docs/guides/nxp/nxp_k32w_android_commissioning.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The following diagram shows the connectivity between network components required
4848
to allow communication between devices running the CHIPTool and Light
4949
applications:
5050

51-
![nxp_hw_connectivity](../../../third_party/nxp/nxp_matter_support/examples/platform/k32w0/doc/images/nxp_hw_connectivity.JPG)
51+
![nxp_hw_connectivity](../../../examples/platform/nxp/k32w0/doc/images/nxp_hw_connectivity.JPG)
5252

5353
<hr>
5454

@@ -397,7 +397,7 @@ CHIPTool is now ready to be used for commissioning.
397397
398398
3. Navigate to the _Form_ tab then push the _Form_ button using the default
399399
parameters:
400-
![nxp_form_nwk](../../../third_party/nxp/nxp_matter_support/examples/platform/k32w0/doc/images/form_web.JPG)
400+
![nxp_form_nwk](../../../examples/platform/nxp/k32w0/doc/images/form_web.JPG)
401401
402402
4. The message _Form operation is successful_ should be display after a few
403403
seconds.
@@ -431,7 +431,7 @@ To prepare the accessory device for commissioning, complete the following steps:
431431
432432
1. Make sure that JP4 and JP7 jumpers are in leftmost position and a mini-USB
433433
cable is connected between the LPC connector and PC
434-
![nxp_connectors](../../../third_party/nxp/nxp_matter_support/examples/platform/k32w0/doc/images/k32w-dk6-connectors.jpg)
434+
![nxp_connectors](../../../examples/platform/nxp/k32w0/doc/images/k32w-dk6-connectors.jpg)
435435
436436
2. Use a terminal emulator (e.g.: Putty) to connect to the UART console of the
437437
accessory device. Use a baudrate of 115200.
@@ -467,14 +467,14 @@ section, complete the following steps:
467467
progress with scanning, connection, and pairing. At the end of this process,
468468
the Thread network settings screen appears.
469469
470-
![chiptool_main_screen](../../../third_party/nxp/nxp_matter_support/examples/platform/k32w0/doc/images/chiptool_main_screen.png)
470+
![chiptool_main_screen](../../../examples/platform/nxp/k32w0/doc/images/chiptool_main_screen.png)
471471
472472
6. In the Thread network settings screen, use the default settings and tap the
473473
_SAVE NETWORK_ button to send a Thread provisioning message to the accessory
474474
device. You will see the "Network provisioning completed" message when the
475475
accessory device successfully joins the Thread network.
476476
477-
![chiptool_credentials](../../../third_party/nxp/nxp_matter_support/examples/platform/k32w0/doc/images/thread_credentials.png)
477+
![chiptool_credentials](../../../examples/platform/nxp/k32w0/doc/images/thread_credentials.png)
478478
479479
<hr>
480480
@@ -484,7 +484,7 @@ section, complete the following steps:
484484
the provisioning is completed successfully and you are connected to the
485485
device.
486486
487-
![on_off_cluster.png](../../../third_party/nxp/nxp_matter_support/examples/platform/k32w0/doc/images/on_off_cluster.png)
487+
![on_off_cluster.png](../../../examples/platform/nxp/k32w0/doc/images/on_off_cluster.png)
488488
489489
2. Verify that the text box on the screen is not empty and contains the IPv6
490490
address of the accessory device.

‎examples/contact-sensor-app/nxp/k32w0/BUILD.gn

+1-3
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,7 @@ k32w0_executable("contact_sensor_app") {
120120
"${k32w0_platform_dir}/app/support:freertos_mbedtls_utils",
121121
]
122122

123-
defines += [
124-
"CONNECTIVITY_MANAGER_THREAD_DEVICE_TYPE=ConnectivityManager::kThreadDeviceType_SleepyEndDevice"
125-
]
123+
defines += [ "CONNECTIVITY_MANAGER_THREAD_DEVICE_TYPE=ConnectivityManager::kThreadDeviceType_SleepyEndDevice" ]
126124

127125
deps += [
128126
"${chip_root}/third_party/openthread/repo:libopenthread-cli-mtd",

0 commit comments

Comments
 (0)