Skip to content

Commit

Permalink
[NXP][RT][doc] rework documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jby-nxp committed Oct 8, 2024
1 parent 98ab4cc commit 813458d
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 104 deletions.
31 changes: 4 additions & 27 deletions .github/.wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ argc
args
argv
armeabi
armgcc
armino
ARMmbed
armv
Expand Down Expand Up @@ -243,7 +242,6 @@ CLA
clapre
CLI
CLIs
CLK
cloudbuild
CLRF
clusterAttrs
Expand Down Expand Up @@ -306,8 +304,8 @@ conv
CopperConcentrationMeasurement
Corstone
cortexa
cp`
cpio`
cp
cpio
cpp
cppreference
CPROTO
Expand All @@ -323,7 +321,6 @@ csu
csv
ctl
ctrl
CTS
ctypes
CurrentHue
CurrentLevel
Expand Down Expand Up @@ -357,7 +354,6 @@ DCL
DCMAKE
DCONF
DCONFIG
DCP
debianutils
debugText
decrypt
Expand Down Expand Up @@ -421,7 +417,6 @@ dialout
diffstat
diffsyms
dimmable
DIO
dirname
dirs
disableNotifyUpdateApplied
Expand Down Expand Up @@ -480,7 +475,6 @@ EchoService
ECW
edaf
edc
edgefast
EDR
ee
eea
Expand Down Expand Up @@ -535,7 +529,6 @@ ExchangeContext
exe
ExecStart
executables
expander
ExtendedPAN
ExtensionEntry
extern
Expand Down Expand Up @@ -698,7 +691,6 @@ imager
imagetool
imageUri
img
imgtool
Impl
ImplClass
implementers
Expand Down Expand Up @@ -743,7 +735,7 @@ isUpperCase
itemName
iterable
itsfoss
iw
IW
JDK
jinja
JLink
Expand Down Expand Up @@ -831,7 +823,6 @@ LogEvent
loopback
LowPower
LPC
LPUART
LSP
LTE
LTS
Expand Down Expand Up @@ -903,15 +894,14 @@ microcontroller
microcontrollers
MicroSD
middleware
MIMXRT
minApplicableSoftwareVersion
Minicom
MinInterval
MinIntervalFloorSeconds
minLength
MinRtrAdvInterval
minValue
MISO
mimxrt
mkdir
mlan
MLD
Expand All @@ -921,7 +911,6 @@ Mobly
ModeSelect
modprobe
Modustoolbox
MOSI
moveMode
MoveToHue
MoveToLevel
Expand Down Expand Up @@ -953,7 +942,6 @@ nano
natively
navpad
nbsp
ncache
NCP
ncs
nding
Expand Down Expand Up @@ -1015,7 +1003,6 @@ OO
openiotsdk
openjdk
OpenOCD
opensource
OpenSSL
OpenThread
OpenThreadDemo
Expand Down Expand Up @@ -1055,8 +1042,6 @@ otatesting
otaURL
OTBR
otcli
OTP
OTW
outform
outgoingCommands
overridable
Expand Down Expand Up @@ -1103,7 +1088,6 @@ PID
Pigweed
PinCode
pinrequest
PIO
PIXIT
PIXITs
pkgconfig
Expand Down Expand Up @@ -1241,14 +1225,12 @@ RSA
rsn
RSSI
RST
RSTN
rsync
RTC
rtd
RTL
rtld
RTOS
RTS
RTT
RTX
runArgs
Expand All @@ -1271,7 +1253,6 @@ scm
sco
scp
ScriptBinding
SDA
SDB
SDC
SDHC
Expand All @@ -1281,7 +1262,6 @@ sdkconfig
SDKs
SDKTARGETSYSROOT
sdl
SDRAM
SecureCertDACProvider
SED
SEGGER
Expand Down Expand Up @@ -1543,7 +1523,6 @@ UUID
ux
validator
valgrind
VBAT
vcom
VCP
Vectorcall
Expand All @@ -1556,7 +1535,6 @@ Verifier
Verifiers
VID
vids
VIO
virtualenv
visualstudio
vlatest
Expand Down Expand Up @@ -1656,5 +1634,4 @@ Zigbee
zigbeealliance
zigbeethread
zsdk
ZTB
TBR
8 changes: 4 additions & 4 deletions docs/guides/nxp/nxp_RTs_ota_software_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ J-Link > erase 0x30000000, 0x34000000
- MCUBoot application can be built with SDK installed, using instructions
below.
- Retrieve the mcuboot directory located at
_'<matter_repo_root>/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/examples/<a href="#1" id="1-ref">`RTboard`<sup>1</sup></a>/ota_examples/mcuboot_opensource/armgcc'_
_'<matter_repo_root>/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/examples/<a href="#1" id="1-ref">`RTboard`<sup>1</sup></a>/ota_examples/`mcuboot_opensource/armgcc`'_

_<a id="1" href="#1-ref"><sup>1</sup></a> `rdrw612bga` or `frdmrw612` for RW61x,
`evkcmimxrt1060` for RT1060-EVK-C, `evkbmimxrt1170` for RT1170-EVK-B_
Expand Down Expand Up @@ -160,11 +160,11 @@ Unable to find bootable image

Note : By default, mcuboot application considers the primary and secondary
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
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

> _<matter_repo_root>/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/examples/<a href="#1" id="1ref">`RTboard`<sup>1</sup></a>/ota_examples/mcuboot_opensource/._
> _<matter_repo_root>/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/examples/<a href="#1" id="1ref">`RTboard`<sup>1</sup></a>/ota_examples/`mcuboot_opensource`/._
### Generating and flashing the signed application image

Expand Down Expand Up @@ -274,7 +274,7 @@ To generate the OTA update image the same procedure can be followed from the
[Generating and flashing the signed application image](#generating-and-flashing-the-signed-application-image)
sub-section, replacing the "--version "1.0"" argument with "--version "2.0""
(recent version of the update), without arguments "--pad" "--confirm" when
running imgtool script during OTA Update Image generation.
running `imgtool` script during OTA Update Image generation.

Note : When building the update image, the build arguments
nxp_software_version=2 nxp_software_version_string=\"2.0\" can be added to the
Expand Down
64 changes: 32 additions & 32 deletions examples/all-clusters-app/nxp/rt/rt1060/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The hardware should be reworked according to the chapter _Hardware Rework Guide
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
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.
Expand All @@ -117,8 +117,8 @@ using the west tool.

Jumper settings for AzureWave AW-AM510-uSD Module:

- 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)
- 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.

Expand All @@ -128,13 +128,13 @@ MIMXRT1060-EVK.
Connect the following pins between RT1060 and AW-AM510-uSD to enable Bluetooth
HCI UART:

| 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 |
| 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.

Expand All @@ -160,7 +160,7 @@ Transceiver part :
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-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
to position 2-3 (Position 2-3: `VBAT supply`, typical 3.1 ~ 3.3V, from microSD
connector).

Note: as the 88W8801 module supports only the 2.4 GHz Wi-Fi band, it is
Expand All @@ -182,15 +182,15 @@ Transceiver part:
The below table explains pin settings (UART settings) to connect the
MIMXRT1060-EVK-B (host) to a k32w061 transceiver (rcp).

| 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 |
| 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 MIMXRT1060-EVK.

Expand Down Expand Up @@ -226,7 +226,7 @@ Transceiver part :
- 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)
- IOT_ZTB-DK006 carrier board for the K32W0x1 module (referenced as DK6
- `IOT_ZTB-DK006` carrier board for the K32W0x1 module (referenced as DK6
carrier board)

<a name="building"></a>
Expand Down Expand Up @@ -340,7 +340,7 @@ host Matter application build. In fact the Matter host application is in charge
of storing the K32W0 firmware in its flash to be able to use the
`The Over The Wire (OTW) protocol (over UART)` to download (at host startup) the
k32w0 transceiver image from the host to the K32W0 internal flash. For more
information on the k32w0 OTW protocol, user can consult the doxygen header of
information on the k32w0 `OTW` protocol, user can consult the doxygen header of
the file located in
`<repo_root>/third_party/nxp/nxp_matter_support/github_sdk/common_sdk/repo/middleware/wireless/framework/OTW/k32w0_transceiver/fwk_otw.c`.

Expand All @@ -357,7 +357,7 @@ optional:
will be used. If the K32W061 transceiver binary is saved at another location
an absolute path of its location should be given.
- Optional: `otw_logs_enabled=true` This argument is optional, by default
being set to false. If set to true, RT logging will print the OTW logs.
being set to false. If set to true, RT logging will print the `OTW` logs.

[ot_rcp_ble_hci_bb_k32w0_readme]:
https://github.com/NXP/ot-nxp/blob/v1.0.0.2-tag-nxp/examples/hybrid/ot_rcp_ble_hci_bb/k32w061/README.md#building-the-examples
Expand Down Expand Up @@ -447,15 +447,15 @@ For development purpose the RT1060 all cluster app code could use the hardcoded
AES 128 software key. This software key should be used only during development
stage.

For production usage, it is recommended to use the OTP key which needs to be
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
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.
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.

<a name="flashdebug"></a>

Expand Down Expand Up @@ -501,9 +501,9 @@ 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
(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:
(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:

```
click inside the tab and on the right side a button with three horizontal dots will appear
Expand Down
Loading

0 comments on commit 813458d

Please sign in to comment.