You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by pr...@apache.org on 2021/05/12 14:47:44 UTC
[incubator-nuttx] 02/02: Documentation/platforms: fix docs style
and add photo for imxrt1060-evk board
This is an automated email from the ASF dual-hosted git repository.
protobits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx.git
commit d6227623b78ea213a8627edbbdbcfebc357b12ea
Author: Michal Lenc <mi...@seznam.cz>
AuthorDate: Thu Apr 29 17:41:11 2021 +0200
Documentation/platforms: fix docs style and add photo for imxrt1060-evk board
Signed-off-by: Michal Lenc <mi...@seznam.cz>
---
.../arm/imxrt/boards/imxrt1020-evk/index.rst | 20 ++--
.../arm/imxrt/boards/imxrt1050-evk/index.rst | 125 ++++---------------
.../boards/imxrt1060-evk/imxrt1060-evk-front.jpg | Bin 0 -> 109235 bytes
.../arm/imxrt/boards/imxrt1060-evk/index.rst | 132 +++++----------------
.../arm/imxrt/boards/imxrt1064-evk/index.rst | 39 +++---
5 files changed, 88 insertions(+), 228 deletions(-)
diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1020-evk/index.rst b/Documentation/platforms/arm/imxrt/boards/imxrt1020-evk/index.rst
index 67e53f4..922e062 100644
--- a/Documentation/platforms/arm/imxrt/boards/imxrt1020-evk/index.rst
+++ b/Documentation/platforms/arm/imxrt/boards/imxrt1020-evk/index.rst
@@ -3,7 +3,7 @@ i.MX RT1020 EVK
===============
`i.MX RT1020 EVK <https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/i-mx-rt1020-evaluation-kit:MIMXRT1020-EVK>`_
-is an evaluation kit by NXP company. This kit uses the i.MX RT1020 crossover MCU in LQFP144 package with Arm Cortex M7 core.
+is an evaluation kit by NXP company. This kit uses the i.MX RT1020 crossover MCU in LQFP144 package with ARM Cortex M7 core.
Features
========
@@ -42,9 +42,13 @@ LEDs
There is one user accessible LED status indicator located on the 1020-EVK,
USERLED. The function of the LEDs include:
-- D3: Power (Green) & Overpower (Red)
-- D5: User LED (Green) GPIO_AD_B0_05
-- D15: RST LED (Red)
+=== ============ ======
+Pin Description Colour
+=== ============ ======
+D3 Power Supply Green
+D5 User LED Green
+D15 Reset LED Red
+=== ============ ======
This LED is not used by the board port unless CONFIG_ARCH_LEDS is
defined. In that case, the usage by the board port is defined in
@@ -74,9 +78,11 @@ Buttons
This IMXRT board has three external buttons
-- SW2 (IRQ88, ONOFF) Not on a GPIO, No muxing
-- SW3 (IRQ88, POR) Not on a GPIO, No muxing
-- SW4 (IRQ88, USER) Wakeup, GPIO5-0
+=== ============== ========================
+SW2 (IRQ88, ONOFF) Not on a GPIO, No muxing
+SW3 (IRQ88, POR) Not on a GPIO, No muxing
+SW4 (IRQ88, USER) Wakeup, GPIO5-0
+=== ============== ========================
Configurations
==============
diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1050-evk/index.rst b/Documentation/platforms/arm/imxrt/boards/imxrt1050-evk/index.rst
index 1bbc7dc..ad90ec8 100644
--- a/Documentation/platforms/arm/imxrt/boards/imxrt1050-evk/index.rst
+++ b/Documentation/platforms/arm/imxrt/boards/imxrt1050-evk/index.rst
@@ -3,7 +3,7 @@ i.MX RT1050 EVK
===============
`i.MX RT1050 EVK <https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/i-mx-rt1050-evaluation-kit:MIMXRT1050-EVK>`_
-is an evaluation kit by NXP company. This kit uses the i.MX RT1050 crossover MCU with Arm Cortex M7 core.
+is an evaluation kit by NXP company. This kit uses the i.MX RT1050 crossover MCU with ARM Cortex M7 core.
Features
========
@@ -34,13 +34,17 @@ Serial Console
Virtual console port provided by OpenSDA:
-- UART1_TXD GPIO_AD_B0_12 LPUART1_TX
-- UART1_RXD GPIO_AD_B0_13 LPUART1_RX
+========= ============= ==========
+UART1_TXD GPIO_AD_B0_12 LPUART1_TX
+UART1_RXD GPIO_AD_B0_13 LPUART1_RX
+========= ============= ==========
Arduino RS-232 Shield:
-- J22 D0 UART_RX/D0 GPIO_AD_B1_07 LPUART3_RX
-- J22 D1 UART_TX/D1 GPIO_AD_B1_06 LPUART3_TX
+=== == ======= ============= ==========
+J22 D0 UART_RX GPIO_AD_B1_07 LPUART3_RX
+J22 D1 UART_TX GPIO_AD_B1_06 LPUART3_TX
+=== == ======= ============= ==========
LEDs and buttons
================
@@ -51,13 +55,14 @@ LEDs
There are four LED status indicators located on the EVK Board. The
functions of these LEDs include:
-- Main Power Supply(D3)
- - Green: DC 5V main supply is normal.
- - Red: J2 input voltage is over 5.6V.
- - Off: The board is not powered.
-- Reset RED LED(D15)
-- OpenSDA LED(D16)
-- USER LED(D18)
+=== ============
+Pin Description
+=== ============
+D3 Power Supply
+D15 Reset LED
+D16 OpenSDA
+D18 User LED
+=== ============
Only a single LED, D18, is under software control. It connects to
GPIO_AD_B0_09 which is shared with JTAG_TDI and ENET_RST
@@ -89,10 +94,10 @@ Buttons
There are four user interface switches on the MIMXRT1050 EVK Board:
-- SW1: Power Switch (slide switch)
-- SW2: ON/OFF Button
-- SW3: Reset button
-- SW8: User button
+ - SW1: Power Switch (slide switch)
+ - SW2: ON/OFF Button
+ - SW3: Reset button
+ - SW8: User button
Only the user button is available to the software. It is sensed on the
WAKEUP pin which will be pulled low when the button is pressed.
@@ -105,92 +110,8 @@ knsh
This is identical to the nsh configuration below except that NuttX
is built as a protected mode, monolithic module and the user applications
-are built separately. It is recommends to use a special make command;
-not just 'make' but make with the following two arguments:
-
-.. code-block:: console
-
- $ make pass1 pass2
-
-In the normal case (just 'make'), make will attempt to build both user-
-and kernel-mode blobs more or less interleaved. This actual works!
-However, for me it is very confusing so I prefer the above make command:
-Make the user-space binaries first (pass1), then make the kernel-space
-binaries (pass2)
-
-NOTES:
-
-At the end of the build, there will be several files in the top-level
-NuttX build directory:
-
-PASS1:
- - nuttx_user.elf - The pass1 user-space ELF file
- - nuttx_user.hex - The pass1 Intel HEX format file (selected in defconfig)
- - User.map - Symbols in the user-space ELF file
-
-PASS2:
- - nuttx - The pass2 kernel-space ELF file
- - nuttx.hex - The pass2 Intel HEX file (selected in defconfig)
- - System.map - Symbols in the kernel-space ELF file
-
-The J-Link programmer will except files in .hex, .mot, .srec, and .bin
-formats.
-
-Combining .hex files. If you plan to use the .hex files with your
-debugger or FLASH utility, then you may need to combine the two hex
-files into a single .hex file. Here is how you can do that.
-
-The 'tail' of the nuttx.hex file should look something like this
-(with my comments added beginning with #):
-
-.. code-block:: console::
-
- $ tail nuttx.hex
- #xx xxxx 00 data records
- ...
- :10 C93C 00 000000000040184000C2010000000000 90
- :10 C94C 00 2400080000801B4000C01B4000001C40 5D
- :10 C95C 00 00401C4000000C4050BF0060FF000100 74
- #xx xxxx 05 Start Linear Address Record
- :04 0000 05 6000 02C1 D4
- #xx xxxx 01 End Of File record
- :00 0000 01 FF
-
-Use an editor such as vi to remove the 05 and 01 records.
-
-The 'head' of the nuttx_user.hex file should look something like
-this (again with my comments added beginning with #):
-
-.. code-block:: console::
-
- $ head nuttx_user.hex
- #xx xxxx 04 Extended Linear Address Record
- :02 0000 04 6020 7A
- #xx xxxx 00 data records
- :10 0000 00 8905206030002060F2622060FC622060 80
- :10 0010 00 0000242008002420080024205C012420 63
- :10 0020 00 140024203D0020603100206071052060 14
- ...
-
-Nothing needs to be done here. The nuttx_user.hex file should
-be fine.
-
-Combine the edited nuttx.hex and un-edited nuttx_user.hex
-file to produce a single combined hex file:
-
-.. code-block:: console::
-
- $ cat nuttx.hex nuttx_user.hex >combined.hex
-
-Then use the combined.hex file with the to write the FLASH image.
-If you do this a lot, you will probably want to invest a little time
-to develop a tool to automate these steps.
-
-STATUS: This configuration was added on 8 June 2018 primarily to assure
-that all of the components are in place to support the PROTECTED mode
-build. This configuration, however, has not been verified as of this
-writing.
-
+are built separately. For further information about compiling and
+running this configuration please refer to imxrt1064-evk documentation.
netnsh
------
diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/imxrt1060-evk-front.jpg b/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/imxrt1060-evk-front.jpg
new file mode 100644
index 0000000..b0335a3
Binary files /dev/null and b/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/imxrt1060-evk-front.jpg differ
diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/index.rst b/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/index.rst
index 0d7e7d3..8ee9eee 100644
--- a/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/index.rst
+++ b/Documentation/platforms/arm/imxrt/boards/imxrt1060-evk/index.rst
@@ -3,7 +3,13 @@ i.MX RT1060 EVK
===============
`i.MX RT1060 EVK <https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/mimxrt1060-evk-i-mx-rt1060-evaluation-kit:MIMXRT1060-EVK>`_
-is an evaluation kit by NXP company. This kit uses the i.MX RT1060 crossover MCU with Arm Cortex M7 core.
+is an evaluation kit by NXP company. This kit uses the i.MX RT1060 crossover MCU with ARM Cortex M7 core.
+
+.. figure:: imxrt1060-evk-front.jpg
+ :align: center
+ :width: 50%
+
+ i.MX RT1060 EVK
Features
========
@@ -37,13 +43,17 @@ Serial Console
Virtual console port provided by OpenSDA:
-- UART1_TXD GPIO_AD_B0_12 LPUART1_TX
-- UART1_RXD GPIO_AD_B0_13 LPUART1_RX
+========= ============= ==========
+UART1_TXD GPIO_AD_B0_12 LPUART1_TX
+UART1_RXD GPIO_AD_B0_13 LPUART1_RX
+========= ============= ==========
Arduino RS-232 Shield:
-- J22 D0 UART_RX/D0 GPIO_AD_B1_07 LPUART3_RX
-- J22 D1 UART_TX/D1 GPIO_AD_B1_06 LPUART3_TX
+=== == ======= ============= ==========
+J22 D0 UART_RX GPIO_AD_B1_07 LPUART3_RX
+J22 D1 UART_TX GPIO_AD_B1_06 LPUART3_TX
+=== == ======= ============= ==========
LEDs and buttons
================
@@ -54,13 +64,14 @@ LEDs
There are four LED status indicators located on the EVK Board. The
functions of these LEDs include:
-- Main Power Supply(D3)
- - Green: DC 5V main supply is normal.
- - Red: J2 input voltage is over 5.6V.
- - Off: The board is not powered.
-- Reset RED LED(D21)
-- OpenSDA LED(D20)
-- USER LED(D18)
+=== ============
+Pin Description
+=== ============
+D3 Power Supply
+D18 User LED
+D20 OpenSDA
+D21 Reset LED
+=== ============
Only a single LED, D18, is under software control. It connects to
GPIO_AD_B0_09 which is shared with JTAG_TDI and ENET_RST
@@ -92,11 +103,11 @@ Buttons
There are five user interface switches on the MIMXRT1050 EVK Board:
-- SW1: Power Switch (slide switch fir power from J2)
-- SW2: ON/OFF Button
-- SW3: Power-on Reset button state forces to reset the system power except SNVS domain
-- SW9: Reset button
-- SW8: User button GPIO5-00
+ - SW1: Power Switch (slide switch fir power from J2)
+ - SW2: ON/OFF Button
+ - SW3: Power-on Reset button state forces to reset the system power except SNVS domain
+ - SW9: Reset button
+ - SW8: User button GPIO5-00
Only the user button is available to the software. It is sensed on the
WAKEUP pin which will be pulled low when the button is pressed.
@@ -146,91 +157,8 @@ knsh
This is identical to the nsh configuration below except that NuttX
is built as a protected mode, monolithic module and the user applications
-are built separately. It is recommends to use a special make command;
-not just 'make' but make with the following two arguments:
-
-.. code-block:: console
-
- $ make pass1 pass2
-
-In the normal case (just 'make'), make will attempt to build both user-
-and kernel-mode blobs more or less interleaved. This actual works!
-However, for me it is very confusing so I prefer the above make command:
-Make the user-space binaries first (pass1), then make the kernel-space
-binaries (pass2)
-
-NOTES:
-
-At the end of the build, there will be several files in the top-level
-NuttX build directory:
-
-PASS1:
- - nuttx_user.elf - The pass1 user-space ELF file
- - nuttx_user.hex - The pass1 Intel HEX format file (selected in defconfig)
- - User.map - Symbols in the user-space ELF file
-
-PASS2:
- - nuttx - The pass2 kernel-space ELF file
- - nuttx.hex - The pass2 Intel HEX file (selected in defconfig)
- - System.map - Symbols in the kernel-space ELF file
-
-The J-Link programmer will except files in .hex, .mot, .srec, and .bin
-formats.
-
-Combining .hex files. If you plan to use the .hex files with your
-debugger or FLASH utility, then you may need to combine the two hex
-files into a single .hex file. Here is how you can do that.
-
-The 'tail' of the nuttx.hex file should look something like this
-(with my comments added beginning with #):
-
-.. code-block:: console::
-
- $ tail nuttx.hex
- #xx xxxx 00 data records
- ...
- :10 C93C 00 000000000040184000C2010000000000 90
- :10 C94C 00 2400080000801B4000C01B4000001C40 5D
- :10 C95C 00 00401C4000000C4050BF0060FF000100 74
- #xx xxxx 05 Start Linear Address Record
- :04 0000 05 6000 02C1 D4
- #xx xxxx 01 End Of File record
- :00 0000 01 FF
-
-Use an editor such as vi to remove the 05 and 01 records.
-
-The 'head' of the nuttx_user.hex file should look something like
-this (again with my comments added beginning with #):
-
-.. code-block:: console::
-
- $ head nuttx_user.hex
- #xx xxxx 04 Extended Linear Address Record
- :02 0000 04 6020 7A
- #xx xxxx 00 data records
- :10 0000 00 8905206030002060F2622060FC622060 80
- :10 0010 00 0000242008002420080024205C012420 63
- :10 0020 00 140024203D0020603100206071052060 14
- ...
-
-Nothing needs to be done here. The nuttx_user.hex file should
-be fine.
-
-Combine the edited nuttx.hex and un-edited nuttx_user.hex
-file to produce a single combined hex file:
-
-.. code-block:: console::
-
- $ cat nuttx.hex nuttx_user.hex >combined.hex
-
-Then use the combined.hex file with the to write the FLASH image.
-If you do this a lot, you will probably want to invest a little time
-to develop a tool to automate these steps.
-
-STATUS: This configuration was added on 8 June 2018 primarily to assure
-that all of the components are in place to support the PROTECTED mode
-build. This configuration, however, has not been verified as of this
-writing.
+are built separately. For further information about compiling and
+running this configuration please refer to imxrt1064-evk documentation.
netnsh
------
diff --git a/Documentation/platforms/arm/imxrt/boards/imxrt1064-evk/index.rst b/Documentation/platforms/arm/imxrt/boards/imxrt1064-evk/index.rst
index 17613f6..34aaa7c 100644
--- a/Documentation/platforms/arm/imxrt/boards/imxrt1064-evk/index.rst
+++ b/Documentation/platforms/arm/imxrt/boards/imxrt1064-evk/index.rst
@@ -3,7 +3,7 @@ i.MX RT1064 EVK
===============
`i.MX RT1064 EVK <https://www.nxp.com/design/development-boards/i-mx-evaluation-and-development-boards/mimxrt1064-evk-i-mx-rt1064-evaluation-kit:MIMXRT1064-EVK>`_
-is an evaluation kit by NXP company. This kit uses the i.MX RT1064 crossover MCU with Arm Cortex M7 core.
+is an evaluation kit by NXP company. This kit uses the i.MX RT1064 crossover MCU with ARM Cortex M7 core.
Features
========
@@ -37,13 +37,17 @@ Serial Console
Virtual console port provided by OpenSDA:
-- UART1_TXD GPIO_AD_B0_12 LPUART1_TX
-- UART1_RXD GPIO_AD_B0_13 LPUART1_RX
+========= ============= ==========
+UART1_TXD GPIO_AD_B0_12 LPUART1_TX
+UART1_RXD GPIO_AD_B0_13 LPUART1_RX
+========= ============= ==========
Arduino RS-232 Shield:
-- J22 D0 UART_RX/D0 GPIO_AD_B1_07 LPUART3_RX
-- J22 D1 UART_TX/D1 GPIO_AD_B1_06 LPUART3_TX
+=== == ======= ============= ==========
+J22 D0 UART_RX GPIO_AD_B1_07 LPUART3_RX
+J22 D1 UART_TX GPIO_AD_B1_06 LPUART3_TX
+=== == ======= ============= ==========
LEDs and buttons
================
@@ -54,13 +58,14 @@ LEDs
There are four LED status indicators located on the EVK Board. The
functions of these LEDs include:
-- Main Power Supply(D3)
- - Green: DC 5V main supply is normal.
- - Red: J2 input voltage is over 5.6V.
- - Off: The board is not powered.
-- Reset RED LED(D21)
-- OpenSDA LED(D20)
-- USER LED(D18)
+=== ============
+Pin Description
+=== ============
+D3 Power Supply
+D18 User LED
+D20 OpenSDA
+D21 Reset LED
+=== ============
Only a single LED, D18, is under software control. It connects to
GPIO_AD_B0_09 which is shared with JTAG_TDI and ENET_RST
@@ -92,11 +97,11 @@ Buttons
There are five user interface switches on the MIMXRT1050 EVK Board:
-- SW1: Power Switch (slide switch fir power from J2)
-- SW2: ON/OFF Button
-- SW3: Power-on Reset button state forces to reset the system power except SNVS domain
-- SW9: Reset button
-- SW8: User button GPIO5-00
+ - SW1: Power Switch (slide switch fir power from J2)
+ - SW2: ON/OFF Button
+ - SW3: Power-on Reset button state forces to reset the system power except SNVS domain
+ - SW9: Reset button
+ - SW8: User button GPIO5-00
Only the user button is available to the software. It is sensed on the
WAKEUP pin which will be pulled low when the button is pressed.