From c897fade02dbceae05ee90305dcbc154ea72c4c7 Mon Sep 17 00:00:00 2001 From: Piyush Patle Date: Wed, 1 Apr 2026 03:39:19 +0530 Subject: [PATCH 1/4] Documentation/teensy-lc: port README.txt to rst --- .../arm/kl/boards/teensy-lc/README.txt | 34 ------------------- .../arm/kl/boards/teensy-lc/index.rst | 34 +++++++++++++++++-- 2 files changed, 31 insertions(+), 37 deletions(-) delete mode 100644 Documentation/platforms/arm/kl/boards/teensy-lc/README.txt diff --git a/Documentation/platforms/arm/kl/boards/teensy-lc/README.txt b/Documentation/platforms/arm/kl/boards/teensy-lc/README.txt deleted file mode 100644 index 64f1ee8ba56bb..0000000000000 --- a/Documentation/platforms/arm/kl/boards/teensy-lc/README.txt +++ /dev/null @@ -1,34 +0,0 @@ -Teensy LC README -================ - - This is the README file for NuttX on the PJRC Teensy LC. The Teensy LC - is a DIP style breakout board for the MKL25Z64 and comes with a USB - based bootloader. Contributed by Michael Hope. - -Development Environment -======================= - - All testing was done with the GNU ARM Embedded 4.9 toolchain on - Linux. See https://developer.arm.com/open-source/gnu-toolchain/gnu-rm to download. - - Once you've configured and built NuttX, flash the resulting - nuttx.hex file to the board using the Teensy Loader Application. - -LEDs -==== - - The Teensy LC has a single LED. If CONFIG_ARCH_LEDS is defined, then - NuttX will update the LED as the board boots. The summary is: - - * LED off: board booting - * LED on: initial stack created - * LED flashing: panic. - - See `include/board.h` for details. - -Serial Console -============== - - The serial console is mapped to UART0 and appears on pins 0 (RX) and - 1 (TX). Consider using a 3.3 V USB to serial adapter such as the - Sparkfun #9717 FTDI cable. diff --git a/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst b/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst index 74ed8fffd1800..feb20e782840c 100644 --- a/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst +++ b/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst @@ -2,6 +2,34 @@ teensy-lc ========= -This is the port of nuttx for the Teensy LC board. The Teensy LC -is a DIP style breakout board for the MKL25Z64 and comes with a USB -based bootloader. +This is the NuttX port for the PJRC Teensy LC board. The Teensy LC is a +DIP-style breakout board for the MKL25Z64 and includes a USB-based +bootloader. + +Development Environment +======================= + +Testing was done with the GNU ARM Embedded 4.9 toolchain on Linux. See +https://developer.arm.com/open-source/gnu-toolchain/gnu-rm for toolchain +downloads. + +Once you have configured and built NuttX, flash the resulting ``nuttx.hex`` +image to the board with the Teensy Loader application. + +LEDs +==== + +The Teensy LC provides a single LED. If ``CONFIG_ARCH_LEDS`` is enabled, NuttX +updates that LED during boot: + +* LED off: board booting +* LED on: initial stack created +* LED flashing: panic + +See ``include/board.h`` for the board-specific definitions. + +Serial Console +============== + +The serial console is mapped to UART0 and appears on pins 0 (RX) and 1 (TX). +Use a 3.3 V USB-to-serial adapter, such as the Sparkfun ``#9717`` FTDI cable. From 9b1fecc86cd95ba1bb84bea06fddc3b8cbf3867c Mon Sep 17 00:00:00 2001 From: Piyush Patle Date: Wed, 1 Apr 2026 03:39:34 +0530 Subject: [PATCH 2/4] Documentation/olimex-lpc2378: port README.txt to rst --- .../lpc2378/boards/olimex-lpc2378/README.txt | 11 --------- .../lpc2378/boards/olimex-lpc2378/index.rst | 23 +++++++++++++++++-- 2 files changed, 21 insertions(+), 13 deletions(-) delete mode 100644 Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/README.txt diff --git a/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/README.txt b/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/README.txt deleted file mode 100644 index eafdac7cd0a76..0000000000000 --- a/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/README.txt +++ /dev/null @@ -1,11 +0,0 @@ -There's not much here: - -EXT1 - P3 0:7 are used for LEDs. - -UEXT pin 3/4 -TXD2/RXD2- is UART2. - -The board I have has the revision '-' of LPC2378 even though I got the board -more than 2 years after the chip revision was released :-( . -I can't get NuttX to work if I fully enabled the MAM. - -I used FTDI ft232 usb-serial with nsh piping as seen on the screenshot. diff --git a/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst b/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst index 803f4e179d3a8..f73017812b8c5 100644 --- a/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst +++ b/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst @@ -2,6 +2,25 @@ olimex-lpc2378 ============== -.. include:: README.txt - :literal: +The Olimex LPC2378 board has only a small amount of board-specific porting +information recorded in the original notes. +Board Notes +=========== + +* ``EXT1``: ``P3[0:7]`` are used for LEDs. +* ``UEXT`` pins 3 and 4 provide ``TXD2`` and ``RXD2`` for UART2. + +Known Limitations +================= + +The board used for this port still had the ``-`` LPC2378 revision, even though +it was purchased more than two years after the updated chip revision was +released. With that hardware, NuttX would not run correctly with the MAM fully +enabled. + +Console Setup +============= + +Testing was done with an FTDI ``ft232`` USB-to-serial adapter and NSH piping, +as shown in the original board screenshot. From 7b2f6aa12093c52328cab20fb175111dec46146a Mon Sep 17 00:00:00 2001 From: Piyush Patle Date: Wed, 1 Apr 2026 03:39:43 +0530 Subject: [PATCH 3/4] Documentation/sam4cmp-db: port README.txt to rst --- .../arm/sam34/boards/sam4cmp-db/README.txt | 25 ------------------ .../arm/sam34/boards/sam4cmp-db/index.rst | 26 +++++++++++++++++-- Documentation/platforms/arm/sam34/index.rst | 6 ++--- 3 files changed, 27 insertions(+), 30 deletions(-) delete mode 100644 Documentation/platforms/arm/sam34/boards/sam4cmp-db/README.txt diff --git a/Documentation/platforms/arm/sam34/boards/sam4cmp-db/README.txt b/Documentation/platforms/arm/sam34/boards/sam4cmp-db/README.txt deleted file mode 100644 index e8dc3e1c2a80b..0000000000000 --- a/Documentation/platforms/arm/sam34/boards/sam4cmp-db/README.txt +++ /dev/null @@ -1,25 +0,0 @@ -README -^^^^^^ - -README for NuttX port to the SAM4CMP-DB board. - - http://www.atmel.com/tools/SAM4CMP-DB.aspx - -The board is intended to test NuttX SMP features for dual Cortex-M4. - -Settings -^^^^^^^^ -1. Both CPUs are running at 92.160MHz with PLLB. -2. Serial console can be used via on-board USB-UART (115200/8/N/1) -3. Interrupt handlers such as timer and UART are handled on CPU0 -4. Both CPUs share internal SRAM0 (128KB) -5. SRAM1 is used to boot CPU1. -6. Cache controllers are disabled because of no snooping features. - -Status -^^^^^^ -Currently SMP freature works on the board but is not stable. - -1. "nsh> sleep 1 &" works without crash. -2. "nsh> smp " sometimes works but some assertions might happen. -3. "nsh> ostest " causes deadlocks during the test. diff --git a/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst b/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst index 3858b62106a02..c3e9ff7362141 100644 --- a/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst +++ b/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst @@ -2,5 +2,27 @@ sam4cmp-db ========== -.. include:: README.txt - :literal: +README for the NuttX port to the SAM4CMP-DB board. + +The `SAM4CMP-DB `_ board is used +to exercise NuttX SMP support for dual Cortex-M4 systems. + +Settings +======== + +1. Both CPUs run at 92.160 MHz using PLLB. +2. The serial console is available via the on-board USB-to-UART interface at + 115200 8N1. +3. Interrupt handlers such as the timer and UART run on CPU0. +4. Both CPUs share internal SRAM0 (128 KB). +5. SRAM1 is used to boot CPU1. +6. Cache controllers are disabled because the device has no snooping support. + +Status +====== + +The SMP feature works on the board, but it is not yet stable. + +1. ``nsh> sleep 1 &`` works without crashing. +2. ``nsh> smp`` sometimes works, but assertions may occur. +3. ``nsh> ostest`` causes deadlocks during the test. diff --git a/Documentation/platforms/arm/sam34/index.rst b/Documentation/platforms/arm/sam34/index.rst index 25782bf678816..7bd515d21f722 100644 --- a/Documentation/platforms/arm/sam34/index.rst +++ b/Documentation/platforms/arm/sam34/index.rst @@ -90,9 +90,9 @@ was contributed in part by Max Neklyudov. to NuttX by Masayuki Ishikawa in NuttX-7.19. The SAM4CM is a dual-CPU part and SMP was included for the ARMv7-M and SAM3/4 families. The SAM4CMP-DB board support includes an NSH configuration that operates in -an SMP configuration. Refer to the NuttX board -`README `__ -file for further information. +an SMP configuration. Refer to the +:doc:`board documentation ` for further +information. Microchip SAM4E --------------- From 050944150c1dbf968d26653ba85559a4a1462932 Mon Sep 17 00:00:00 2001 From: Piyush Patle Date: Wed, 1 Apr 2026 03:39:49 +0530 Subject: [PATCH 4/4] Documentation/verdin-mx8mp: port README.txt to rst --- .../arm/mx8mp/boards/verdin-mx8mp/README.txt | 19 -------------- .../arm/mx8mp/boards/verdin-mx8mp/index.rst | 26 +++++++++++++++++++ Documentation/platforms/arm/mx8mp/index.rst | 16 ++++++++++++ 3 files changed, 42 insertions(+), 19 deletions(-) delete mode 100644 Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/README.txt create mode 100644 Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/index.rst create mode 100644 Documentation/platforms/arm/mx8mp/index.rst diff --git a/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/README.txt b/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/README.txt deleted file mode 100644 index 50d4305bb4052..0000000000000 --- a/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/README.txt +++ /dev/null @@ -1,19 +0,0 @@ -README for the verdin-mx8mp Relax -============================ - - The directory provides board support for the Toradex Verdin mx8mp. - Note: this port works on the internal Cortex-M7 auxiliary core, NOT the main Cortex-53 complex! - - LEDs and buttons shall be connected to header pins like this: - - LED21 on GPIO_4 - - LED22 on GPIO_3 - - LED23 on GPIO_2 - - LED24 on GPIO_1 - - SW11 on GPIO_5_CSI - You can adjust this pinout in verdin_mx8mp.h - -Status -====== - - 2023-08-23: The Verdin mx8mp boots into NSH, provides the NSH prompt. - 2023-09-04: gpio support, i2c support (tested with on-board ina219 sensor) diff --git a/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/index.rst b/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/index.rst new file mode 100644 index 0000000000000..2450f36fb9930 --- /dev/null +++ b/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/index.rst @@ -0,0 +1,26 @@ +============= +verdin-mx8mp +============= + +This directory provides board support for the Toradex Verdin i.MX8MP. This +port runs on the internal Cortex-M7 auxiliary core, not on the main +Cortex-A53 complex. + +GPIO Connections +================ + +Connect LEDs and buttons to the header pins as follows: + +* ``LED21`` on ``GPIO_4`` +* ``LED22`` on ``GPIO_3`` +* ``LED23`` on ``GPIO_2`` +* ``LED24`` on ``GPIO_1`` +* ``SW11`` on ``GPIO_5_CSI`` + +You can adjust this pin mapping in ``verdin_mx8mp.h``. + +Status +====== + +* 2023-08-23: boots into NSH and provides the NSH prompt +* 2023-09-04: GPIO and I2C support work, including the on-board INA219 sensor diff --git a/Documentation/platforms/arm/mx8mp/index.rst b/Documentation/platforms/arm/mx8mp/index.rst new file mode 100644 index 0000000000000..c9580d53affe4 --- /dev/null +++ b/Documentation/platforms/arm/mx8mp/index.rst @@ -0,0 +1,16 @@ +===================== +NXP i.MX 8M Plus +===================== + +Support is available for the NXP i.MX 8M Plus family. Current board support is +focused on the Cortex-M7 auxiliary core rather than the main Cortex-A53 +application cores. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/*