Skip to content

Commit 2e42d48

Browse files
[NXP][docs] Fix spellcheck errors
Signed-off-by: marius-alex-tache <marius.tache@nxp.com>
1 parent d8b806d commit 2e42d48

File tree

3 files changed

+31
-21
lines changed

3 files changed

+31
-21
lines changed

docs/guides/nxp/nxp_k32w0_ota_guide.md

+19-9
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ according to the following table:
1818
| `ssbl_multi_image_support` | true | Enable/disable multi-image OTA feature |
1919
| `ssbl_ota_entry_storage` | "OTACustomStorage_ExtFlash" | Configure custom OTA entry storage type |
2020
| `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) |
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) |
2323
| `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 |
24+
| `ssbl_use_redlib` | false | Enable/disable usage of `redlib` NXP library. If false, the build will use `newlib` nano |
2525
| `ssbl_ota_data_in_external_flash` | false | Enable/disable OTA support for application with sections stored in external flash |
2626

2727
## Simple hash verification
@@ -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,6 +58,7 @@ 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
```
@@ -68,7 +71,7 @@ $ dk6prog -d DN038ZH3 write 0 ~/path/to/bin/chip-k32w0x-ssbl.bin
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

122126
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:
@@ -146,13 +151,14 @@ DK6Programmer.exe -V5 -s <COM port> -P 1000000 -w image_dir_1=00400000C9040101
146151
```
147152

148153
Using dk6prog from SPSDK:
154+
149155
```
150156
$ dk6prog -d DN038ZH3 write 0x168 [[00400000C9040101]] 8 PSECT
151157
152158
This is an experimental utility. Use with caution!
153159
154160
Writing memory [####################################] 100%
155-
Writen 8 bytes to memory ID PSECT at address 0x168
161+
Written 8 bytes to memory ID PSECT at address 0x168
156162
```
157163

158164
Here is the interpretation of the fields:
@@ -180,18 +186,20 @@ The programming method will change:
180186

181187
* Writing image directory 1 should change to
182188
Using DK6Programmer utility from Windows:
189+
183190
```
184191
DK6Programmer.exe -V5 -s <COM port> -P 1000000 -w image_dir_1=00200000D9040101
185192
```
186193
187194
Using dk6prog from SPSDK:
195+
188196
```
189197
$ dk6prog -d DN038ZH3 write 0x168 [[00200000D9040101]] 8 PSECT
190198
191199
This is an experimental utility. Use with caution!
192200
193201
Writing memory [####################################] 100%
194-
Writen 8 bytes to memory ID PSECT at address 0x168
202+
Written 8 bytes to memory ID PSECT at address 0x168
195203
```
196204
197205
Here is the interpretation of the fields:
@@ -204,16 +212,18 @@ The programming method will change:
204212
```
205213
* Matter application offset address should change to
206214
Using DK6Programmer utility from Windows:
215+
207216
```
208217
DK6Programmer.exe -V2 -s <COM_PORT> -P 1000000 -Y -p FLASH@0x2000="chip-k32w0x-contact-example.bin"
209218
```
210219
211220
Using dk6prog from SPSDK:
221+
212222
```
213223
$ dk6prog -d DN038ZH3 write 0x2000 ~/path/to/bin/chip-k32w0x-contact-example.bin
214224
215225
This is an experimental utility. Use with caution!
216226
217227
Writing memory [####################################] 100%
218-
Writen 596450 bytes to memory ID 0 at address 0x2000
228+
Written 596450 bytes to memory ID 0 at address 0x2000
219229
```

examples/contact-sensor-app/nxp/k32w0/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -416,8 +416,8 @@ DK6 Flash Programmer tool has also been integrated part of
416416
[NXP Secure Provisioning SDK (SPSDK)](https://github.com/nxp-mcuxpresso/spsdk). This tool is supported by
417417
environments like Windows, Linux or Mac.
418418

419-
SPSDK can be installed and run from a Python environment using [these instructions](https://spsdk.readthedocs.io/en/latest/usage/installation.html).
420-
This enables the user to have transparent access to the dk6 programming tool through SPSDK.
419+
`SPSDK` can be installed and run from a Python environment using [these instructions](https://spsdk.readthedocs.io/en/latest/usage/installation.html).
420+
This enables the user to have transparent access to the dk6 programming tool through `SPSDK`.
421421

422422
```
423423
# after specific environment installation steps
@@ -433,13 +433,13 @@ $ spsdk --help
433433
...
434434
```
435435

436-
Dependencies for the dk6prog module can be installed using the following command, more details [here](https://spsdk.readthedocs.io/en/latest/usage/installation.html#dk6-tools):
436+
Dependencies for the `dk6prog` module can be installed using the following command, more details [here](https://spsdk.readthedocs.io/en/latest/usage/installation.html#dk6-tools):
437437

438438
```
439439
$ pip install spsdk[dk6]
440440
```
441441

442-
The SPSDK installation adds dk6prog as executable to system path, so user can use directly `dk6prog` from terminal.
442+
The `SPSDK` installation adds `dk6prog` as executable to system path, so user can use directly `dk6prog` from terminal.
443443
The following commands are to be used to write the chip-k32w0x-contact-example binary to the board.
444444

445445
```
@@ -453,7 +453,7 @@ $ dk6prog -d DN038ZH3 write 0x4000 ~/path/to/bin/chip-k32w0x-contact-example.bin
453453
This is an experimental utility. Use with caution!
454454
455455
Writing memory [####################################] 100%
456-
Writen 596450 bytes to memory ID 0 at address 0x4000
456+
Written 596450 bytes to memory ID 0 at address 0x4000
457457
```
458458

459459
> **_Note:_** Running `dk6prog` from Windows OS command line requires an integer value for DEVICE ID.
@@ -604,7 +604,7 @@ More details regarding the internal flash space can be found in the
604604
[linker file](../../../platform/nxp/k32w0/app/ldscripts/chip-k32w0x-linker.ld).
605605

606606
The steps for building the SSBL binary with appropriate configuration and writing to the board
607-
the binary and other OTA related configurations are descrived in the
607+
the binary and other OTA related configurations are described in the
608608
[K32W0x1 OTA guide](../../../../docs/guides/nxp/nxp_k32w0_ota_guide.md).
609609

610610
Note that the application needs to be built using the `chip_enable_ota_requestor=true` option.

examples/lighting-app/nxp/k32w0/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -392,8 +392,8 @@ DK6 Flash Programmer tool has also been integrated part of
392392
[NXP Secure Provisioning SDK (SPSDK)](https://github.com/nxp-mcuxpresso/spsdk). This tool is supported by
393393
environments like Windows, Linux or Mac.
394394

395-
SPSDK can be installed and run from a Python environment using [these instructions](https://spsdk.readthedocs.io/en/latest/usage/installation.html).
396-
This enables the user to have transparent access to the dk6 programming tool through SPSDK.
395+
`SPSDK` can be installed and run from a Python environment using [these instructions](https://spsdk.readthedocs.io/en/latest/usage/installation.html).
396+
This enables the user to have transparent access to the dk6 programming tool through `SPSDK`.
397397

398398
```
399399
# after specific environment installation steps
@@ -409,13 +409,13 @@ $ spsdk --help
409409
...
410410
```
411411

412-
Dependencies for the dk6prog module can be installed using the following command, more details [here](https://spsdk.readthedocs.io/en/latest/usage/installation.html#dk6-tools):
412+
Dependencies for the `dk6prog` module can be installed using the following command, more details [here](https://spsdk.readthedocs.io/en/latest/usage/installation.html#dk6-tools):
413413

414414
```
415415
$ pip install spsdk[dk6]
416416
```
417417

418-
The SPSDK installation adds dk6prog as executable to system path, so user can use directly `dk6prog` from terminal.
418+
The `SPSDK` installation adds `dk6prog` as executable to system path, so user can use directly `dk6prog` from terminal.
419419
The following commands are to be used to write the chip-k32w0x-light-example binary to the board.
420420

421421
```
@@ -429,7 +429,7 @@ $ dk6prog -d DN038ZH3 write 0x4000 ~/path/to/bin/chip-k32w0x-light-example.bin
429429
This is an experimental utility. Use with caution!
430430
431431
Writing memory [####################################] 100%
432-
Writen 596450 bytes to memory ID 0 at address 0x4000
432+
Written 596450 bytes to memory ID 0 at address 0x4000
433433
```
434434

435435
> **_Note:_** Running `dk6prog` from Windows OS command line requires an integer value for DEVICE ID.
@@ -580,7 +580,7 @@ More details regarding the internal flash space can be found in the
580580
[linker file](../../../platform/nxp/k32w0/app/ldscripts/chip-k32w0x-linker.ld).
581581

582582
The steps for building the SSBL binary with appropriate configuration and writing to the board
583-
the binary and other OTA related configurations are descrived in the
583+
the binary and other OTA related configurations are described in the
584584
[K32W0x1 OTA guide](../../../../docs/guides/nxp/nxp_k32w0_ota_guide.md).
585585

586586
Note that the application needs to be built using the `chip_enable_ota_requestor=true` option.

0 commit comments

Comments
 (0)