diff --git a/Documentation/components/boards.rst b/Documentation/components/boards.rst new file mode 100644 index 00000000000..3d8b5e80389 --- /dev/null +++ b/Documentation/components/boards.rst @@ -0,0 +1,201 @@ +============== +Boards support +============== + +This page discusses the board support logic for NuttX. + +The ``nuttx/boards`` directory is a part of the internal OS. It should contain +only OS bring-up logic and driver initialization logic. + +**THERE SHOULD BE NO APPLICATION CALLABLE LOGIC IN THIS DIRECTORY.** + +If you have board-specific, application callable logic, that logic should not +go here. Please consider using a sub-directory under ``apps/platform`` instead. + +Board-Specific Configurations +============================= + +The NuttX configuration consists of: + +* Processor architecture specific files. These are the files contained + in the ``arch//`` directory. + +* Chip/SoC specific files. Each processor architecture is embedded + in a chip or System-on-a-Chip (SoC) architecture. The full chip + architecture includes the processor architecture plus chip-specific + interrupt logic, general purpose I/O (GIO) logic, and specialized, + internal peripherals (such as UARTs, USB, etc.). + + These chip-specific files are contained within chip-specific + sub-directories in the ``arch//`` directory and are selected + via the ``CONFIG_ARCH_name`` selection + +* Board specific files. In order to be usable, the chip must be + contained in a board environment. The board configuration defines + additional properties of the board including such things as + peripheral LEDs, external peripherals (such as network, USB, etc.). + + These board-specific configuration files can be found in the + ``boards////`` sub-directories. + Additional configuration information may be available in board-specific documentation pages + at ``Documentation/platforms///``. + +The ``boards/`` subdirectory contains configuration data for each board. These +board-specific configurations plus the architecture-specific configurations in +the ``arch/`` subdirectory completely define a customized port of NuttX. + +``boards/`` Directory Structure +=============================== + +The ``boards/`` directory contains board specific configuration logic. Each +board must provide a subdirectory ```` under ``boards/`` with the +following characteristics:: + + + |-- include/ + | `-- (board-specific header files) + |-- src/ + | |-- Makefile + | `-- (board-specific source files) + |-- + | |-- Make.defs + | `-- defconfig + |-- + | |-- Make.defs + | `-- defconfig + ... + +Summary of Files +================ + +* ``include/`` -- This directory contains board specific header files. This + directory will be linked as include/arch/board at configuration time and + can be included via #include ``. These header file + can only be included by files in ``arch/include/`` and + ``arch//src`` + +* ``src/`` -- This directory contains board specific drivers. This + directory will be linked as ``arch//src/board`` at configuration + time and will be integrated into the build system. + +* ``src/Makefile`` -- This makefile will be invoked to build the board specific + drivers. It must support the following targets: ``libext$(LIBEXT)``, ``clean``, + and ``distclean``. + +A board may have various different configurations using these common source +files. Each board configuration is described by two files: Make.defs and +defconfig. Typically, each set of configuration files is retained in a +separate configuration sub-directory (````, ````, .. +in the above diagram). + +* ``Make.defs`` -- This makefile fragment provides architecture and + tool-specific build options. It will be included by all other + makefiles in the build (once it is installed). This make fragment + should define:: + + Tools: CC, LD, AR, NM, OBJCOPY, OBJDUMP + Tool options: CFLAGS, LDFLAGS + + When this makefile fragment runs, it will be passed TOPDIR which + is the path to the root directory of the build. This makefile + fragment should include:: + + $(TOPDIR)/.config : NuttX configuration + $(TOPDIR)/tools/Config.mk : Common definitions + + Definitions in the ``Make.defs`` file probably depend on some of the + settings in the ``.config`` file. For example, the ``CFLAGS`` will most likely be + different if ``CONFIG_DEBUG_FEATURES=y``. + + The included ``tools/Config.mk`` file contains additional definitions that may + be overridden in the architecture-specific ``Make.defs`` file as necessary:: + + COMPILE, ASSEMBLE, ARCHIVE, CLEAN, and MKDEP macros + +* ``defconfig`` -- This is a configuration file similar to the Linux + configuration file. In contains variable/value pairs like:: + + CONFIG_VARIABLE=value + + This configuration file will be used at build time: + + (1) as a makefile fragment included in other makefiles, and + (2) to generate include/nuttx/config.h which is included by + most C files in the system. + +Configuration Variables +======================= + +At one time, this section provided a list of all NuttX configuration +variables. However, NuttX has since converted to use the kconfig-frontends +tools (See https://bitbucket.org/nuttx/tools/src/master/kconfig-frontends/.) +Now, the NuttX configuration is determined by a self-documenting set of +Kconfig files. + +The current NuttX configuration variables are also documented in separate, +auto-generated configuration variable document. That configuration variable +document is generated using the kconfig2html tool that can be found in the +nuttx/tools directory. That tool analyzes the NuttX Kconfig files and +generates an excruciatingly boring HTML document. + +The latest boring configuration variable documentation can be regenerated at +any time using that tool or, more appropriately, the wrapper script at +nuttx/tools/mkconfigvars.sh. That script will generate the file +nuttx/Documentation/NuttXConfigVariables.html. + +Supported Boards +================ + +The list of supported boards can be found in :ref:`Supported Platforms `. + +Configuring NuttX +================= + +Configuring NuttX requires only copying:: + + boards/////Make.def to ${TOPDIR}/Make.defs + boards/////defconfig to ${TOPDIR}/.config + +- ``tools/configure.sh`` + + There is a script that automates these steps. The following steps will + accomplish the same configuration:: + + tools/configure.sh : + + There is an alternative Windows batch file that can be used in the + windows native environment like:: + + tools\configure.bat : + + See ``tools/README.txt`` for more information about these scripts. + + And if your application directory is not in the standard location (``../apps`` + or ``../apps-``), then you should also specify the location of the + application directory on the command line like:: + + cd tools + ./configure.sh -a : + +Building Symbol Tables +====================== + +Symbol tables are needed at several of the binfmt interfaces in order to bind +a module to the base code. These symbol tables can be tricky to create and +will probably have to be tailored for any specific application, balancing +the number of symbols and the size of the symbol table against the symbols +required by the applications. + +The top-level System.map file is one good source of symbol information +(which, or course, was just generated from the top-level nuttx file +using the GNU 'nm' tool). + +There are also common-separated value (CSV) values in the source try that +provide information about symbols. In particular:: + + nuttx/syscall/syscall.csv - Describes the NuttX RTOS interface, and + nuttx/lib/libc.csv - Describes the NuttX C library interface. + +There is a tool at nuttx/tools/mksymtab that will use these CSV files as +input to generate a generic symbol table. See ``nuttx/tools/README.txt`` for +more information about using the mksymtab tool. diff --git a/Documentation/components/index.rst b/Documentation/components/index.rst index 6938f9fb3e4..72d48a8adc4 100644 --- a/Documentation/components/index.rst +++ b/Documentation/components/index.rst @@ -25,3 +25,4 @@ case, you can head to the :doc:`reference <../reference/index>`. syscall.rst tools/index.rst arch/index.rst + boards.rst diff --git a/boards/arm/a1x/pcduino-a10/README.txt b/Documentation/platforms/arm/a1x/boards/pcduino-a10/README.txt similarity index 100% rename from boards/arm/a1x/pcduino-a10/README.txt rename to Documentation/platforms/arm/a1x/boards/pcduino-a10/README.txt diff --git a/Documentation/platforms/arm/a1x/boards/pcduino-a10/index.rst b/Documentation/platforms/arm/a1x/boards/pcduino-a10/index.rst new file mode 100644 index 00000000000..e10057f205c --- /dev/null +++ b/Documentation/platforms/arm/a1x/boards/pcduino-a10/index.rst @@ -0,0 +1,6 @@ +=========== +pcduino-a10 +=========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/arm/a1x/index.rst b/Documentation/platforms/arm/a1x/index.rst index f4f7e0fcf5e..e1a3cd2f878 100644 --- a/Documentation/platforms/arm/a1x/index.rst +++ b/Documentation/platforms/arm/a1x/index.rst @@ -21,3 +21,12 @@ have are supported by NuttX: ready for "prime time", the pcDuino port is functional and could the basis for a more extensive development. There is, at present, no work in progress to extend this port, however. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/am335x/beaglebone-black/README.txt b/Documentation/platforms/arm/am335x/boards/beaglebone-black/README.txt similarity index 100% rename from boards/arm/am335x/beaglebone-black/README.txt rename to Documentation/platforms/arm/am335x/boards/beaglebone-black/README.txt diff --git a/Documentation/platforms/arm/am335x/boards/beaglebone-black/index.rst b/Documentation/platforms/arm/am335x/boards/beaglebone-black/index.rst new file mode 100644 index 00000000000..21ec7874ad2 --- /dev/null +++ b/Documentation/platforms/arm/am335x/boards/beaglebone-black/index.rst @@ -0,0 +1,7 @@ +================ +beaglebone-black +================ + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/am335x/index.rst b/Documentation/platforms/arm/am335x/index.rst index 90c524fa17a..b69e7342cca 100644 --- a/Documentation/platforms/arm/am335x/index.rst +++ b/Documentation/platforms/arm/am335x/index.rst @@ -22,3 +22,12 @@ AM335x are supported by NuttX: Refer to the Beaglebone Black board `README `__ file for further, up-to-date information. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/at32/at32f437-mini/README.txt b/Documentation/platforms/arm/at32/boards/at32f437-mini/README.txt similarity index 100% rename from boards/arm/at32/at32f437-mini/README.txt rename to Documentation/platforms/arm/at32/boards/at32f437-mini/README.txt diff --git a/Documentation/platforms/arm/at32/boards/at32f437-mini/index.rst b/Documentation/platforms/arm/at32/boards/at32f437-mini/index.rst new file mode 100644 index 00000000000..f8bbf704cbe --- /dev/null +++ b/Documentation/platforms/arm/at32/boards/at32f437-mini/index.rst @@ -0,0 +1,7 @@ +============= +at32f437-mini +============= + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/at32/index.rst b/Documentation/platforms/arm/at32/index.rst index 03404ec1478..9c6ae65eacb 100644 --- a/Documentation/platforms/arm/at32/index.rst +++ b/Documentation/platforms/arm/at32/index.rst @@ -1,3 +1,12 @@ =========== Artery AT32 =========== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/c5471/c5471evm/README.txt b/Documentation/platforms/arm/c5471/boards/c5471evm/README.txt similarity index 100% rename from boards/arm/c5471/c5471evm/README.txt rename to Documentation/platforms/arm/c5471/boards/c5471evm/README.txt diff --git a/Documentation/platforms/arm/c5471/boards/c5471evm/index.rst b/Documentation/platforms/arm/c5471/boards/c5471evm/index.rst new file mode 100644 index 00000000000..9c175ab0b25 --- /dev/null +++ b/Documentation/platforms/arm/c5471/boards/c5471evm/index.rst @@ -0,0 +1,7 @@ +======== +c5471evm +======== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/c5471/index.rst b/Documentation/platforms/arm/c5471/index.rst index 553e0bb35bd..b1602bbf5b5 100644 --- a/Documentation/platforms/arm/c5471/index.rst +++ b/Documentation/platforms/arm/c5471/index.rst @@ -7,3 +7,12 @@ TI TMS320-C5471 NuttX operates on the ARM7 of this dual core processor. This port uses the `Spectrum Digital `__ evaluation board with a GNU arm-nuttx-elf toolchain\* under Linux or Cygwin. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/cxd56xx/spresense/README.txt b/Documentation/platforms/arm/cxd56xx/boards/spresense/README.txt similarity index 100% rename from boards/arm/cxd56xx/spresense/README.txt rename to Documentation/platforms/arm/cxd56xx/boards/spresense/README.txt diff --git a/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst b/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst new file mode 100644 index 00000000000..4654f11e027 --- /dev/null +++ b/Documentation/platforms/arm/cxd56xx/boards/spresense/index.rst @@ -0,0 +1,7 @@ +============== +Sony Spresense +============== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/cxd56xx/index.rst b/Documentation/platforms/arm/cxd56xx/index.rst index 53128372284..e135bb67e83 100644 --- a/Documentation/platforms/arm/cxd56xx/index.rst +++ b/Documentation/platforms/arm/cxd56xx/index.rst @@ -46,3 +46,12 @@ camera support, added audio and board audio control implementation, added an audio_tone_generator, added optional initialization of GNSS and GEOFENCE at boot if the drivers are enabled, added an lcd examples configuration. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/dm320/ntosd-dm320/README.txt b/Documentation/platforms/arm/dm320/boards/ntosd-dm320/README.txt similarity index 100% rename from boards/arm/dm320/ntosd-dm320/README.txt rename to Documentation/platforms/arm/dm320/boards/ntosd-dm320/README.txt diff --git a/Documentation/platforms/arm/dm320/boards/ntosd-dm320/index.rst b/Documentation/platforms/arm/dm320/boards/ntosd-dm320/index.rst new file mode 100644 index 00000000000..c3acef98ad1 --- /dev/null +++ b/Documentation/platforms/arm/dm320/boards/ntosd-dm320/index.rst @@ -0,0 +1,7 @@ +=========== +ntosd-dm320 +=========== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/dm320/index.rst b/Documentation/platforms/arm/dm320/index.rst index 324d33d8a50..07697c07d86 100644 --- a/Documentation/platforms/arm/dm320/index.rst +++ b/Documentation/platforms/arm/dm320/index.rst @@ -8,3 +8,12 @@ NuttX operates on the ARM9 of this dual core processor. This port uses the Neuros OSD with a GNU arm-nuttx-elf toolchain\* under Linux or Cygwin. The port was performed using the OSD v1.0, development board. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/efm32/efm32-g8xx-stk/README.txt b/Documentation/platforms/arm/efm32/boards/efm32-g8xx-stk/README.txt similarity index 100% rename from boards/arm/efm32/efm32-g8xx-stk/README.txt rename to Documentation/platforms/arm/efm32/boards/efm32-g8xx-stk/README.txt diff --git a/Documentation/platforms/arm/efm32/boards/efm32-g8xx-stk/index.rst b/Documentation/platforms/arm/efm32/boards/efm32-g8xx-stk/index.rst new file mode 100644 index 00000000000..67eee38b145 --- /dev/null +++ b/Documentation/platforms/arm/efm32/boards/efm32-g8xx-stk/index.rst @@ -0,0 +1,7 @@ +============== +efm32-g8xx-stk +============== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/efm32/efm32gg-stk3700/README.txt b/Documentation/platforms/arm/efm32/boards/efm32gg-stk3700/README.txt similarity index 100% rename from boards/arm/efm32/efm32gg-stk3700/README.txt rename to Documentation/platforms/arm/efm32/boards/efm32gg-stk3700/README.txt diff --git a/Documentation/platforms/arm/efm32/boards/efm32gg-stk3700/index.rst b/Documentation/platforms/arm/efm32/boards/efm32gg-stk3700/index.rst new file mode 100644 index 00000000000..3f50c3abc39 --- /dev/null +++ b/Documentation/platforms/arm/efm32/boards/efm32gg-stk3700/index.rst @@ -0,0 +1,7 @@ +=============== +efm32gg-stk3700 +=============== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/efm32/olimex-efm32g880f128-stk/README.txt b/Documentation/platforms/arm/efm32/boards/olimex-efm32g880f128-stk/README.txt similarity index 100% rename from boards/arm/efm32/olimex-efm32g880f128-stk/README.txt rename to Documentation/platforms/arm/efm32/boards/olimex-efm32g880f128-stk/README.txt diff --git a/Documentation/platforms/arm/efm32/boards/olimex-efm32g880f128-stk/index.rst b/Documentation/platforms/arm/efm32/boards/olimex-efm32g880f128-stk/index.rst new file mode 100644 index 00000000000..1fc86d6e194 --- /dev/null +++ b/Documentation/platforms/arm/efm32/boards/olimex-efm32g880f128-stk/index.rst @@ -0,0 +1,7 @@ +======================== +olimex-efm32g880f128-stk +======================== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/efm32/index.rst b/Documentation/platforms/arm/efm32/index.rst index bba89bb21a5..6a42fd7f0b3 100644 --- a/Documentation/platforms/arm/efm32/index.rst +++ b/Documentation/platforms/arm/efm32/index.rst @@ -91,3 +91,12 @@ Board support is available for the following: - Development of USB support is in started, but never completed. - Reset Management Unit (RMU) was added Pierre-noel Bouteville in NuttX-7.7. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/eoss3/quickfeather/README.txt b/Documentation/platforms/arm/eoss3/boards/quickfeather/README.txt similarity index 100% rename from boards/arm/eoss3/quickfeather/README.txt rename to Documentation/platforms/arm/eoss3/boards/quickfeather/README.txt diff --git a/Documentation/platforms/arm/eoss3/boards/quickfeather/index.rst b/Documentation/platforms/arm/eoss3/boards/quickfeather/index.rst new file mode 100644 index 00000000000..aa0e315ce9d --- /dev/null +++ b/Documentation/platforms/arm/eoss3/boards/quickfeather/index.rst @@ -0,0 +1,7 @@ +============ +quickfeather +============ + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/eoss3/index.rst b/Documentation/platforms/arm/eoss3/index.rst new file mode 100644 index 00000000000..26e1707e600 --- /dev/null +++ b/Documentation/platforms/arm/eoss3/index.rst @@ -0,0 +1,12 @@ +===== +EOSS3 +===== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/fvp-v8r-aarch32/fvp-armv8r-aarch32/README.txt b/Documentation/platforms/arm/fvp-v8r-aarch32/boards/fvp-armv8r-aarch32/README.txt similarity index 100% rename from boards/arm/fvp-v8r-aarch32/fvp-armv8r-aarch32/README.txt rename to Documentation/platforms/arm/fvp-v8r-aarch32/boards/fvp-armv8r-aarch32/README.txt diff --git a/Documentation/platforms/arm/fvp-v8r-aarch32/boards/fvp-armv8r-aarch32/index.rst b/Documentation/platforms/arm/fvp-v8r-aarch32/boards/fvp-armv8r-aarch32/index.rst new file mode 100644 index 00000000000..cb692dcb6f0 --- /dev/null +++ b/Documentation/platforms/arm/fvp-v8r-aarch32/boards/fvp-armv8r-aarch32/index.rst @@ -0,0 +1,7 @@ +================== +fvp-armv8r-aarch32 +================== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/fvp-v8r-aarch32/index.rst b/Documentation/platforms/arm/fvp-v8r-aarch32/index.rst index 9551e5f5d60..1cf0b254dc2 100644 --- a/Documentation/platforms/arm/fvp-v8r-aarch32/index.rst +++ b/Documentation/platforms/arm/fvp-v8r-aarch32/index.rst @@ -1,2 +1,12 @@ +===================== FVP ARMv8-R Virt Chip ===================== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-eval/index.rst b/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-eval/index.rst new file mode 100644 index 00000000000..b82e40ad56d --- /dev/null +++ b/Documentation/platforms/arm/gd32f4/boards/gd32f450zk-eval/index.rst @@ -0,0 +1,4 @@ +=============== +gd32f450zk-eval +=============== + diff --git a/Documentation/platforms/arm/gd32f4/boards/gd32f470ik-eval/index.rst b/Documentation/platforms/arm/gd32f4/boards/gd32f470ik-eval/index.rst new file mode 100644 index 00000000000..d5e3070ad36 --- /dev/null +++ b/Documentation/platforms/arm/gd32f4/boards/gd32f470ik-eval/index.rst @@ -0,0 +1,4 @@ +=============== +gd32f470ik-eval +=============== + diff --git a/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-eval/index.rst b/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-eval/index.rst new file mode 100644 index 00000000000..661ee86359c --- /dev/null +++ b/Documentation/platforms/arm/gd32f4/boards/gd32f470zk-eval/index.rst @@ -0,0 +1,4 @@ +=============== +gd32f470zk-eval +=============== + diff --git a/Documentation/platforms/arm/gd32f4/index.rst b/Documentation/platforms/arm/gd32f4/index.rst new file mode 100644 index 00000000000..0363bd8a6f0 --- /dev/null +++ b/Documentation/platforms/arm/gd32f4/index.rst @@ -0,0 +1,12 @@ +====== +GD32F4 +====== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/arm/goldfish/index.rst b/Documentation/platforms/arm/goldfish/index.rst new file mode 100644 index 00000000000..6d37a89c863 --- /dev/null +++ b/Documentation/platforms/arm/goldfish/index.rst @@ -0,0 +1,6 @@ +======== +GOLDFISH +======== + +Supported Boards +================ diff --git a/boards/arm/imx6/sabre-6quad/README.txt b/Documentation/platforms/arm/imx6/boards/sabre-6quad/README.txt similarity index 100% rename from boards/arm/imx6/sabre-6quad/README.txt rename to Documentation/platforms/arm/imx6/boards/sabre-6quad/README.txt diff --git a/Documentation/platforms/arm/imx6/boards/sabre-6quad/index.rst b/Documentation/platforms/arm/imx6/boards/sabre-6quad/index.rst new file mode 100644 index 00000000000..75afab3d3f8 --- /dev/null +++ b/Documentation/platforms/arm/imx6/boards/sabre-6quad/index.rst @@ -0,0 +1,6 @@ +=========== +sabre-6quad +=========== + +This directory holds a port of NuttX to the NXP/Freescale Sabre board +featuring the iMX 6Quad CPU. diff --git a/Documentation/platforms/arm/imx6/index.rst b/Documentation/platforms/arm/imx6/index.rst index e2c7a6552b0..2b006dd1180 100644 --- a/Documentation/platforms/arm/imx6/index.rst +++ b/Documentation/platforms/arm/imx6/index.rst @@ -20,3 +20,12 @@ The basic port has been completed for the following i.MX6 board: with SMP support on this platform as described in the `README `__ file for the board. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/arm/imxrt/index.rst b/Documentation/platforms/arm/imxrt/index.rst index 7e9a60ec155..e44eb45b600 100644 --- a/Documentation/platforms/arm/imxrt/index.rst +++ b/Documentation/platforms/arm/imxrt/index.rst @@ -1,6 +1,6 @@ -======= -i.MX RT -======= +=========== +NXP i.MX RT +=========== The i.MX RT series of chips from NXP Semiconductors is based around an ARM Cortex-M7 core running at 500 MHz, 600 MHz or 1 GHz based on particular MCUs diff --git a/boards/arm/kinetis/freedom-k28f/README.txt b/Documentation/platforms/arm/kinetis/boards/freedom-k28f/README.txt similarity index 100% rename from boards/arm/kinetis/freedom-k28f/README.txt rename to Documentation/platforms/arm/kinetis/boards/freedom-k28f/README.txt diff --git a/Documentation/platforms/arm/kinetis/boards/freedom-k28f/index.rst b/Documentation/platforms/arm/kinetis/boards/freedom-k28f/index.rst new file mode 100644 index 00000000000..c0098c9f7db --- /dev/null +++ b/Documentation/platforms/arm/kinetis/boards/freedom-k28f/index.rst @@ -0,0 +1,7 @@ +============ +freedom-k28f +============ + +.. include:: README.txt + :literal: + diff --git a/boards/arm/kinetis/freedom-k64f/README.txt b/Documentation/platforms/arm/kinetis/boards/freedom-k64f/README.txt similarity index 100% rename from boards/arm/kinetis/freedom-k64f/README.txt rename to Documentation/platforms/arm/kinetis/boards/freedom-k64f/README.txt diff --git a/Documentation/platforms/arm/kinetis/boards/freedom-k64f/index.rst b/Documentation/platforms/arm/kinetis/boards/freedom-k64f/index.rst new file mode 100644 index 00000000000..db8b634a3cb --- /dev/null +++ b/Documentation/platforms/arm/kinetis/boards/freedom-k64f/index.rst @@ -0,0 +1,7 @@ +============ +freedom-k64f +============ + +.. include:: README.txt + :literal: + diff --git a/boards/arm/kinetis/freedom-k66f/README.txt b/Documentation/platforms/arm/kinetis/boards/freedom-k66f/README.txt similarity index 100% rename from boards/arm/kinetis/freedom-k66f/README.txt rename to Documentation/platforms/arm/kinetis/boards/freedom-k66f/README.txt diff --git a/Documentation/platforms/arm/kinetis/boards/freedom-k66f/index.rst b/Documentation/platforms/arm/kinetis/boards/freedom-k66f/index.rst new file mode 100644 index 00000000000..88a651e1a02 --- /dev/null +++ b/Documentation/platforms/arm/kinetis/boards/freedom-k66f/index.rst @@ -0,0 +1,7 @@ +============ +freedom-k66f +============ + +.. include:: README.txt + :literal: + diff --git a/boards/arm/kinetis/kwikstik-k40/README.txt b/Documentation/platforms/arm/kinetis/boards/kwikstik-k40/README.txt similarity index 100% rename from boards/arm/kinetis/kwikstik-k40/README.txt rename to Documentation/platforms/arm/kinetis/boards/kwikstik-k40/README.txt diff --git a/Documentation/platforms/arm/kinetis/boards/kwikstik-k40/index.rst b/Documentation/platforms/arm/kinetis/boards/kwikstik-k40/index.rst new file mode 100644 index 00000000000..db43609dca3 --- /dev/null +++ b/Documentation/platforms/arm/kinetis/boards/kwikstik-k40/index.rst @@ -0,0 +1,7 @@ +============ +kwikstik-k40 +============ + +.. include:: README.txt + :literal: + diff --git a/boards/arm/kinetis/teensy-3.x/README.txt b/Documentation/platforms/arm/kinetis/boards/teensy-3.x/README.txt similarity index 100% rename from boards/arm/kinetis/teensy-3.x/README.txt rename to Documentation/platforms/arm/kinetis/boards/teensy-3.x/README.txt diff --git a/Documentation/platforms/arm/kinetis/boards/teensy-3.x/index.rst b/Documentation/platforms/arm/kinetis/boards/teensy-3.x/index.rst new file mode 100644 index 00000000000..13ff96550b3 --- /dev/null +++ b/Documentation/platforms/arm/kinetis/boards/teensy-3.x/index.rst @@ -0,0 +1,7 @@ +========== +teensy-3.x +========== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/kinetis/twr-k60n512/README.txt b/Documentation/platforms/arm/kinetis/boards/twr-k60n512/README.txt similarity index 100% rename from boards/arm/kinetis/twr-k60n512/README.txt rename to Documentation/platforms/arm/kinetis/boards/twr-k60n512/README.txt diff --git a/Documentation/platforms/arm/kinetis/boards/twr-k60n512/index.rst b/Documentation/platforms/arm/kinetis/boards/twr-k60n512/index.rst new file mode 100644 index 00000000000..2b39acc09aa --- /dev/null +++ b/Documentation/platforms/arm/kinetis/boards/twr-k60n512/index.rst @@ -0,0 +1,7 @@ +=========== +twr-k60n512 +=========== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/kinetis/twr-k64f120m/README.txt b/Documentation/platforms/arm/kinetis/boards/twr-k64f120m/README.txt similarity index 100% rename from boards/arm/kinetis/twr-k64f120m/README.txt rename to Documentation/platforms/arm/kinetis/boards/twr-k64f120m/README.txt diff --git a/Documentation/platforms/arm/kinetis/boards/twr-k64f120m/index.rst b/Documentation/platforms/arm/kinetis/boards/twr-k64f120m/index.rst new file mode 100644 index 00000000000..5c788d60e46 --- /dev/null +++ b/Documentation/platforms/arm/kinetis/boards/twr-k64f120m/index.rst @@ -0,0 +1,7 @@ +============ +twr-k64f120m +============ + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/kinetis/index.rst b/Documentation/platforms/arm/kinetis/index.rst index cf752afd0ed..311247b345c 100644 --- a/Documentation/platforms/arm/kinetis/index.rst +++ b/Documentation/platforms/arm/kinetis/index.rst @@ -102,3 +102,12 @@ file for further information. I2C device drivers, RTC alarm functionality, and new SPI driver. - **NuttX-7.26**. David Sidrane contributed DMA support to the Kinetis K6x family. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/kl/freedom-kl25z/README.txt b/Documentation/platforms/arm/kl/boards/freedom-kl25z/README.txt similarity index 100% rename from boards/arm/kl/freedom-kl25z/README.txt rename to Documentation/platforms/arm/kl/boards/freedom-kl25z/README.txt diff --git a/Documentation/platforms/arm/kl/boards/freedom-kl25z/index.rst b/Documentation/platforms/arm/kl/boards/freedom-kl25z/index.rst new file mode 100644 index 00000000000..1beadcd4a5d --- /dev/null +++ b/Documentation/platforms/arm/kl/boards/freedom-kl25z/index.rst @@ -0,0 +1,6 @@ +============= +freedom-kl25z +============= + +.. include:: README.txt + :literal: diff --git a/boards/arm/kl/freedom-kl26z/README.txt b/Documentation/platforms/arm/kl/boards/freedom-kl26z/README.txt similarity index 100% rename from boards/arm/kl/freedom-kl26z/README.txt rename to Documentation/platforms/arm/kl/boards/freedom-kl26z/README.txt diff --git a/Documentation/platforms/arm/kl/boards/freedom-kl26z/index.rst b/Documentation/platforms/arm/kl/boards/freedom-kl26z/index.rst new file mode 100644 index 00000000000..bd113dfadac --- /dev/null +++ b/Documentation/platforms/arm/kl/boards/freedom-kl26z/index.rst @@ -0,0 +1,6 @@ +============= +freedom-kl26z +============= + +.. include:: README.txt + :literal: diff --git a/boards/arm/kl/teensy-lc/README.txt b/Documentation/platforms/arm/kl/boards/teensy-lc/README.txt similarity index 100% rename from boards/arm/kl/teensy-lc/README.txt rename to Documentation/platforms/arm/kl/boards/teensy-lc/README.txt diff --git a/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst b/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst new file mode 100644 index 00000000000..74ed8fffd18 --- /dev/null +++ b/Documentation/platforms/arm/kl/boards/teensy-lc/index.rst @@ -0,0 +1,7 @@ +========= +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. diff --git a/Documentation/platforms/arm/kl/index.rst b/Documentation/platforms/arm/kl/index.rst index dd3659b1654..6a24dcf5a32 100644 --- a/Documentation/platforms/arm/kl/index.rst +++ b/Documentation/platforms/arm/kl/index.rst @@ -28,3 +28,12 @@ board that features the MK26Z128VLH4 Cortex-M0+ MCU, 128KB of FLASH and 16KB of SRAM. See the `Freescale `__ website for further information about this board. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/lc823450/lc823450-xgevk/README.txt b/Documentation/platforms/arm/lc823450/boards/lc823450-xgevk/README.txt similarity index 100% rename from boards/arm/lc823450/lc823450-xgevk/README.txt rename to Documentation/platforms/arm/lc823450/boards/lc823450-xgevk/README.txt diff --git a/Documentation/platforms/arm/lc823450/boards/lc823450-xgevk/index.rst b/Documentation/platforms/arm/lc823450/boards/lc823450-xgevk/index.rst new file mode 100644 index 00000000000..84b50c9d979 --- /dev/null +++ b/Documentation/platforms/arm/lc823450/boards/lc823450-xgevk/index.rst @@ -0,0 +1,7 @@ +============== +lc823450-xgevk +============== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/lc823450/index.rst b/Documentation/platforms/arm/lc823450/index.rst index 1fe53340d46..ccce0540048 100644 --- a/Documentation/platforms/arm/lc823450/index.rst +++ b/Documentation/platforms/arm/lc823450/index.rst @@ -38,3 +38,12 @@ and USB device. ADC, Watchdog, IPC2, and I2S support was added by Masayuki Ishikawa in NuttX-7.23. Bluetooth, SPI, and *PROTECTED* build support were added by Masayuki Ishikawa in NuttX-7.26. Support for for SPI flash boot was added in NuttX-7.28. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/lpc17xx_40xx/lincoln60/README.txt b/Documentation/platforms/arm/lpc17xx/boards/lincoln60/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/lincoln60/README.txt rename to Documentation/platforms/arm/lpc17xx/boards/lincoln60/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/lincoln60/index.rst b/Documentation/platforms/arm/lpc17xx/boards/lincoln60/index.rst new file mode 100644 index 00000000000..14fe1e5eb79 --- /dev/null +++ b/Documentation/platforms/arm/lpc17xx/boards/lincoln60/index.rst @@ -0,0 +1,7 @@ +========= +lincoln60 +========= + +.. include:: README.txt + :literal: + diff --git a/boards/arm/lpc17xx_40xx/lpcxpresso-lpc1768/README.txt b/Documentation/platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/lpcxpresso-lpc1768/README.txt rename to Documentation/platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/index.rst b/Documentation/platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/index.rst new file mode 100644 index 00000000000..e427ed88f2a --- /dev/null +++ b/Documentation/platforms/arm/lpc17xx/boards/lpcxpresso-lpc1768/index.rst @@ -0,0 +1,7 @@ +================== +lpcxpresso-lpc1768 +================== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/lpc17xx_40xx/mbed/README.txt b/Documentation/platforms/arm/lpc17xx/boards/mbed/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/mbed/README.txt rename to Documentation/platforms/arm/lpc17xx/boards/mbed/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/mbed/index.rst b/Documentation/platforms/arm/lpc17xx/boards/mbed/index.rst new file mode 100644 index 00000000000..d4545c23364 --- /dev/null +++ b/Documentation/platforms/arm/lpc17xx/boards/mbed/index.rst @@ -0,0 +1,7 @@ +==== +mbed +==== + +The configurations in this directory support the mbed board (http://mbed.org) +that features the NXP LPC1768 microcontroller. This OS is also built +with the arm-nuttx-elf toolchain*. STATUS: Contributed. diff --git a/boards/arm/lpc17xx_40xx/mcb1700/README.txt b/Documentation/platforms/arm/lpc17xx/boards/mcb1700/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/mcb1700/README.txt rename to Documentation/platforms/arm/lpc17xx/boards/mcb1700/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/mcb1700/index.rst b/Documentation/platforms/arm/lpc17xx/boards/mcb1700/index.rst new file mode 100644 index 00000000000..172f39d2994 --- /dev/null +++ b/Documentation/platforms/arm/lpc17xx/boards/mcb1700/index.rst @@ -0,0 +1,7 @@ +======= +mcb1700 +======= + +.. include:: README.txt + :literal: + diff --git a/boards/arm/lpc17xx_40xx/olimex-lpc1766stk/README.txt b/Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/olimex-lpc1766stk/README.txt rename to Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/index.rst b/Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/index.rst new file mode 100644 index 00000000000..3bb6bcbd803 --- /dev/null +++ b/Documentation/platforms/arm/lpc17xx/boards/olimex-lpc1766stk/index.rst @@ -0,0 +1,7 @@ +================= +olimex-lpc1766stk +================= + +.. include:: README.txt + :literal: + diff --git a/boards/arm/lpc17xx_40xx/open1788/README.txt b/Documentation/platforms/arm/lpc17xx/boards/open1788/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/open1788/README.txt rename to Documentation/platforms/arm/lpc17xx/boards/open1788/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/open1788/index.rst b/Documentation/platforms/arm/lpc17xx/boards/open1788/index.rst new file mode 100644 index 00000000000..6b8a34bccc0 --- /dev/null +++ b/Documentation/platforms/arm/lpc17xx/boards/open1788/index.rst @@ -0,0 +1,7 @@ +======== +open1788 +======== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/lpc17xx_40xx/pnev5180b/README.txt b/Documentation/platforms/arm/lpc17xx/boards/pnev5180b/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/pnev5180b/README.txt rename to Documentation/platforms/arm/lpc17xx/boards/pnev5180b/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/pnev5180b/index.rst b/Documentation/platforms/arm/lpc17xx/boards/pnev5180b/index.rst new file mode 100644 index 00000000000..73297524218 --- /dev/null +++ b/Documentation/platforms/arm/lpc17xx/boards/pnev5180b/index.rst @@ -0,0 +1,7 @@ +========= +pnev5180b +========= + +.. include:: README.txt + :literal: + diff --git a/boards/arm/lpc17xx_40xx/u-blox-c027/README.txt b/Documentation/platforms/arm/lpc17xx/boards/u-blox-c027/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/u-blox-c027/README.txt rename to Documentation/platforms/arm/lpc17xx/boards/u-blox-c027/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/u-blox-c027/index.rst b/Documentation/platforms/arm/lpc17xx/boards/u-blox-c027/index.rst new file mode 100644 index 00000000000..68e90225c6e --- /dev/null +++ b/Documentation/platforms/arm/lpc17xx/boards/u-blox-c027/index.rst @@ -0,0 +1,7 @@ +=========== +u-blox-c027 +=========== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/lpc17xx_40xx/zkit-arm-1769/README.txt b/Documentation/platforms/arm/lpc17xx/boards/zkit-arm-1769/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/zkit-arm-1769/README.txt rename to Documentation/platforms/arm/lpc17xx/boards/zkit-arm-1769/README.txt diff --git a/Documentation/platforms/arm/lpc17xx/boards/zkit-arm-1769/index.rst b/Documentation/platforms/arm/lpc17xx/boards/zkit-arm-1769/index.rst new file mode 100644 index 00000000000..ec9b2c9dd0e --- /dev/null +++ b/Documentation/platforms/arm/lpc17xx/boards/zkit-arm-1769/index.rst @@ -0,0 +1,7 @@ +============= +zkit-arm-1769 +============= + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/lpc17xx/index.rst b/Documentation/platforms/arm/lpc17xx/index.rst index 990a9eb591a..1f05d19e647 100644 --- a/Documentation/platforms/arm/lpc17xx/index.rst +++ b/Documentation/platforms/arm/lpc17xx/index.rst @@ -167,3 +167,12 @@ collaborative effort between Rommel Marcelo and myself (with Rommel being the leading contributor and I claiming only a support role). You can get more information at the Open1788 board from the WaveShare website. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/lpc214x/mcu123-lpc214x/README.txt b/Documentation/platforms/arm/lpc214x/boards/mcu123-lpc214x/README.txt similarity index 100% rename from boards/arm/lpc214x/mcu123-lpc214x/README.txt rename to Documentation/platforms/arm/lpc214x/boards/mcu123-lpc214x/README.txt diff --git a/Documentation/platforms/arm/lpc214x/boards/mcu123-lpc214x/index.rst b/Documentation/platforms/arm/lpc214x/boards/mcu123-lpc214x/index.rst new file mode 100644 index 00000000000..7d7e1579766 --- /dev/null +++ b/Documentation/platforms/arm/lpc214x/boards/mcu123-lpc214x/index.rst @@ -0,0 +1,7 @@ +============== +mcu123-lpc214x +============== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/lpc214x/zp214xpa/README.txt b/Documentation/platforms/arm/lpc214x/boards/zp214xpa/README.txt similarity index 100% rename from boards/arm/lpc214x/zp214xpa/README.txt rename to Documentation/platforms/arm/lpc214x/boards/zp214xpa/README.txt diff --git a/Documentation/platforms/arm/lpc214x/boards/zp214xpa/index.rst b/Documentation/platforms/arm/lpc214x/boards/zp214xpa/index.rst new file mode 100644 index 00000000000..2ceaf4b03a6 --- /dev/null +++ b/Documentation/platforms/arm/lpc214x/boards/zp214xpa/index.rst @@ -0,0 +1,7 @@ +======== +zp214xpa +======== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/lpc214x/index.rst b/Documentation/platforms/arm/lpc214x/index.rst index ecdb0e6ec10..9ad7dd500d8 100644 --- a/Documentation/platforms/arm/lpc214x/index.rst +++ b/Documentation/platforms/arm/lpc214x/index.rst @@ -7,3 +7,68 @@ processors. In particular, support is provided for (1) the mcu123.com lpc214x evaluation board (LPC2148) and (1) the The0.net ZPA213X/4XPA development board (with the The0.net UG-2864AMBAG01 OLED) This port also used the GNU arm-nuttx-elf toolchain\* under Linux or Cygwin. + +http://www.nxp.com/pip/LPC2141FBD64.html + +The LPC2141/42/44/46/48 microcontrollers are based on a 16-bit/32-bit ARM7TDMI-S +CPU with real-time emulation and embedded trace support, that combine +microcontroller with embedded high-speed flash memory ranging from 32 kB to +512 kB. A 128-bit wide memory interface and a unique accelerator architecture +enable 32-bit code execution at the maximum clock rate. For critical code size +applications, the alternative 16-bit Thumb mode reduces code by more than 30 pct +with minimal performance penalty. + +Due to their tiny size and low power consumption, LPC2141/42/44/46/48 are ideal +for applications where miniaturization is a key requirement, such as access +control and point-of-sale. Serial communications interfaces ranging from a USB 2.0 +Full-speed device, multiple UARTs, SPI, SSP to I2C-bus and on-chip SRAM of 8 kB +up to 40 kB, make these devices very well suited for communication gateways and +protocol converters, soft modems, voice recognition and low end imaging, providing +both large buffer size and high processing power. Various 32-bit timers, single +or dual 10-bit ADC(s), 10-bit DAC, PWM channels and 45 fast GPIO lines with up +to nine edge or level sensitive external interrupt pins make these microcontrollers +suitable for industrial control and medical systems. + +Features +======== + +* 16-bit/32-bit ARM7TDMI-S microcontroller in a tiny LQFP64 package. +* 8 kB to 40 kB of on-chip static RAM and 32 kB to 512 kB of on-chip flash memory. + 128-bit wide interface/accelerator enables high-speed 60 MHz operation. +* In-System Programming/In-Application Programming (ISP/IAP) via on-chip boot + loader software. Single flash sector or full chip erase in 400 ms and programming + of 256 B in 1 ms. +* EmbeddedICE RT and Embedded Trace interfaces offer real-time debugging with the + on-chip RealMonitor software and high-speed tracing of instruction execution. +* USB 2.0 Full-speed compliant device controller with 2 kB of endpoint RAM. In addition, + the LPC2146/48 provides 8 kB of on-chip RAM accessible to USB by DMA. +* One or two (LPC2141/42 vs. LPC2144/46/48) 10-bit ADCs provide a total of 6/14 analog + inputs, with conversion times as low as 2.44 us per channel. +* Single 10-bit DAC provides variable analog output (LPC2142/44/46/48 only). +* Two 32-bit timers/external event counters (with four capture and four compare + channels each), PWM unit (six outputs) and watchdog. +* Low power Real-Time Clock (RTC) with independent power and 32 kHz clock input. +* Multiple serial interfaces including two UARTs (16C550), two Fast I2C-bus (400 + kbit/s), SPI and SSP with buffering and variable data length capabilities. +* Vectored Interrupt Controller (VIC) with configurable priorities and vector addresses. +* Up to 45 of 5 V tolerant fast general purpose I/O pins in a tiny LQFP64 package. +* Up to 21 external interrupt pins available. +* 60 MHz maximum CPU clock available from programmable on-chip PLL with settling + time of 100 us. +* On-chip integrated oscillator operates with an external crystal from 1 MHz to 25 MHz. +* Power saving modes include Idle and Power-down. +* Individual enable/disable of peripheral functions as well as peripheral clock scaling + for additional power optimization. +* Processor wake-up from Power-down mode via external interrupt or BOD. +* Single power supply chip with POR and BOD circuits: +* CPU operating voltage range of 3.0 V to 3.6 V (3.3 V +- 10 pct) with 5 V tolerant + I/O pads. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/lpc2378/olimex-lpc2378/README.txt b/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/README.txt similarity index 100% rename from boards/arm/lpc2378/olimex-lpc2378/README.txt rename to Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/README.txt diff --git a/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst b/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst new file mode 100644 index 00000000000..803f4e179d3 --- /dev/null +++ b/Documentation/platforms/arm/lpc2378/boards/olimex-lpc2378/index.rst @@ -0,0 +1,7 @@ +============== +olimex-lpc2378 +============== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/lpc2378/index.rst b/Documentation/platforms/arm/lpc2378/index.rst index 085ab831e68..7d2702d39d8 100644 --- a/Documentation/platforms/arm/lpc2378/index.rst +++ b/Documentation/platforms/arm/lpc2378/index.rst @@ -7,3 +7,12 @@ support is provided for the Olimex-LPC2378 development board. This port was contributed by Rommel Marcelo is was first released in NuttX-5.3. This port also used the GNU arm-nuttx-elf toolchain\* under Linux or Cygwin. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/lpc31xx/ea3131/README.txt b/Documentation/platforms/arm/lpc31xx/boards/ea3131/README.txt similarity index 100% rename from boards/arm/lpc31xx/ea3131/README.txt rename to Documentation/platforms/arm/lpc31xx/boards/ea3131/README.txt diff --git a/Documentation/platforms/arm/lpc31xx/boards/ea3131/index.rst b/Documentation/platforms/arm/lpc31xx/boards/ea3131/index.rst new file mode 100644 index 00000000000..cb4fb6dc95f --- /dev/null +++ b/Documentation/platforms/arm/lpc31xx/boards/ea3131/index.rst @@ -0,0 +1,7 @@ +====== +ea3131 +====== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/lpc31xx/ea3152/README.txt b/Documentation/platforms/arm/lpc31xx/boards/ea3152/README.txt similarity index 100% rename from boards/arm/lpc31xx/ea3152/README.txt rename to Documentation/platforms/arm/lpc31xx/boards/ea3152/README.txt diff --git a/Documentation/platforms/arm/lpc31xx/boards/ea3152/index.rst b/Documentation/platforms/arm/lpc31xx/boards/ea3152/index.rst new file mode 100644 index 00000000000..9404f79a718 --- /dev/null +++ b/Documentation/platforms/arm/lpc31xx/boards/ea3152/index.rst @@ -0,0 +1,7 @@ +====== +ea3152 +====== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/lpc31xx/olimex-lpc-h3131/README.txt b/Documentation/platforms/arm/lpc31xx/boards/olimex-lpc-h3131/README.txt similarity index 100% rename from boards/arm/lpc31xx/olimex-lpc-h3131/README.txt rename to Documentation/platforms/arm/lpc31xx/boards/olimex-lpc-h3131/README.txt diff --git a/Documentation/platforms/arm/lpc31xx/boards/olimex-lpc-h3131/index.rst b/Documentation/platforms/arm/lpc31xx/boards/olimex-lpc-h3131/index.rst new file mode 100644 index 00000000000..459032614d9 --- /dev/null +++ b/Documentation/platforms/arm/lpc31xx/boards/olimex-lpc-h3131/index.rst @@ -0,0 +1,7 @@ +================ +olimex-lpc-h3131 +================ + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/lpc31xx/index.rst b/Documentation/platforms/arm/lpc31xx/index.rst new file mode 100644 index 00000000000..aae9eea5a2c --- /dev/null +++ b/Documentation/platforms/arm/lpc31xx/index.rst @@ -0,0 +1,12 @@ +=========== +NXP LPC31xx +=========== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/lpc17xx_40xx/lpc4088-devkit/README.txt b/Documentation/platforms/arm/lpc40xx/boards/lpc4088-devkit/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/lpc4088-devkit/README.txt rename to Documentation/platforms/arm/lpc40xx/boards/lpc4088-devkit/README.txt diff --git a/boards/arm/lpc17xx_40xx/lpc4088-quickstart/README.txt b/Documentation/platforms/arm/lpc40xx/boards/lpc4088-quickstart/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/lpc4088-quickstart/README.txt rename to Documentation/platforms/arm/lpc40xx/boards/lpc4088-quickstart/README.txt diff --git a/boards/arm/lpc17xx_40xx/lx_cpu/README.txt b/Documentation/platforms/arm/lpc40xx/boards/lx_cpu/README.txt similarity index 100% rename from boards/arm/lpc17xx_40xx/lx_cpu/README.txt rename to Documentation/platforms/arm/lpc40xx/boards/lx_cpu/README.txt diff --git a/Documentation/platforms/arm/lpc40xx/boards/lx_cpu/index.rst b/Documentation/platforms/arm/lpc40xx/boards/lx_cpu/index.rst new file mode 100644 index 00000000000..92bacd1c227 --- /dev/null +++ b/Documentation/platforms/arm/lpc40xx/boards/lx_cpu/index.rst @@ -0,0 +1,8 @@ +====== +lx_cpu +====== + +This port uses the PiKRON ``LX_CPU`` board. See the +http://www.pikron.com/pages/products/cpu_boards/lx_cpu.html for further +information. This board features the NXP LPC4088 (compatible with +LPC1788) and Xilinx Spartan 6 XC6SLX9 diff --git a/Documentation/platforms/arm/lpc40xx/index.rst b/Documentation/platforms/arm/lpc40xx/index.rst index ccdb78f472c..e04cf2f7252 100644 --- a/Documentation/platforms/arm/lpc40xx/index.rst +++ b/Documentation/platforms/arm/lpc40xx/index.rst @@ -12,3 +12,12 @@ support came support for two boards also contributed by jjlange: board may be configured to use either the LPC4088 or the LPC1788. **Driver Status.** + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/lpc43xx/bambino-200e/README.txt b/Documentation/platforms/arm/lpc43xx/boards/bambino-200e/README.txt similarity index 100% rename from boards/arm/lpc43xx/bambino-200e/README.txt rename to Documentation/platforms/arm/lpc43xx/boards/bambino-200e/README.txt diff --git a/boards/arm/lpc43xx/lpc4330-xplorer/README.txt b/Documentation/platforms/arm/lpc43xx/boards/lpc4330-xplorer/README.txt similarity index 100% rename from boards/arm/lpc43xx/lpc4330-xplorer/README.txt rename to Documentation/platforms/arm/lpc43xx/boards/lpc4330-xplorer/README.txt diff --git a/boards/arm/lpc43xx/lpc4337-ws/README.txt b/Documentation/platforms/arm/lpc43xx/boards/lpc4337-ws/README.txt similarity index 100% rename from boards/arm/lpc43xx/lpc4337-ws/README.txt rename to Documentation/platforms/arm/lpc43xx/boards/lpc4337-ws/README.txt diff --git a/boards/arm/lpc43xx/lpc4357-evb/README.txt b/Documentation/platforms/arm/lpc43xx/boards/lpc4357-evb/README.txt similarity index 100% rename from boards/arm/lpc43xx/lpc4357-evb/README.txt rename to Documentation/platforms/arm/lpc43xx/boards/lpc4357-evb/README.txt diff --git a/boards/arm/lpc43xx/lpc4370-link2/README.txt b/Documentation/platforms/arm/lpc43xx/boards/lpc4370-link2/README.txt similarity index 100% rename from boards/arm/lpc43xx/lpc4370-link2/README.txt rename to Documentation/platforms/arm/lpc43xx/boards/lpc4370-link2/README.txt diff --git a/Documentation/platforms/arm/lpc43xx/boards/lpc4370-link2/index.rst b/Documentation/platforms/arm/lpc43xx/boards/lpc4370-link2/index.rst new file mode 100644 index 00000000000..fed62aa831d --- /dev/null +++ b/Documentation/platforms/arm/lpc43xx/boards/lpc4370-link2/index.rst @@ -0,0 +1,8 @@ +============= +lpc4370-link2 +============= + +NuttX port to the NXP LPC4370-Link2 development board featuring the NXP +LPC4370FET100 MCU. Based on the LPC4300 Xplorer port and provided by +Lok Tep. + diff --git a/Documentation/platforms/arm/lpc43xx/index.rst b/Documentation/platforms/arm/lpc43xx/index.rst index 3a4404dc2a7..f442b5ed8dc 100644 --- a/Documentation/platforms/arm/lpc43xx/index.rst +++ b/Documentation/platforms/arm/lpc43xx/index.rst @@ -104,3 +104,12 @@ LPC4337-WS development board featuring the NXP LPC4337JBD144 MCU. leveraged from the LPC17 and contributed by Gintaras Drukteinis. Leveraged the LPC54xx SD/MMC to the LPC43xx. There are still remaining issues with the SD/MMC driver and it is not yet functional. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/lpc54xx/lpcxpresso-lpc54628/README.txt b/Documentation/platforms/arm/lpc54xx/boards/lpcxpresso-lpc54628/README.txt similarity index 100% rename from boards/arm/lpc54xx/lpcxpresso-lpc54628/README.txt rename to Documentation/platforms/arm/lpc54xx/boards/lpcxpresso-lpc54628/README.txt diff --git a/Documentation/platforms/arm/lpc54xx/boards/lpcxpresso-lpc54628/index.rst b/Documentation/platforms/arm/lpc54xx/boards/lpcxpresso-lpc54628/index.rst new file mode 100644 index 00000000000..2b15a8b3bfd --- /dev/null +++ b/Documentation/platforms/arm/lpc54xx/boards/lpcxpresso-lpc54628/index.rst @@ -0,0 +1,7 @@ +=================== +lpcxpresso-lpc54628 +=================== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/lpc54xx/index.rst b/Documentation/platforms/arm/lpc54xx/index.rst index a5c595b3b74..d6db70d9dd7 100644 --- a/Documentation/platforms/arm/lpc54xx/index.rst +++ b/Documentation/platforms/arm/lpc54xx/index.rst @@ -25,3 +25,12 @@ relevant changes incorporated in NuttX-7.26. Refer to the LPCXpresso-LPC54628 board `README `__ file for more detailed information about this port. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/max326xx/max32660-evsys/README.txt b/Documentation/platforms/arm/max326xx/boards/max32660-evsys/README.txt similarity index 100% rename from boards/arm/max326xx/max32660-evsys/README.txt rename to Documentation/platforms/arm/max326xx/boards/max32660-evsys/README.txt diff --git a/Documentation/platforms/arm/max326xx/boards/max32660-evsys/index.rst b/Documentation/platforms/arm/max326xx/boards/max32660-evsys/index.rst new file mode 100644 index 00000000000..61d39a0c0a0 --- /dev/null +++ b/Documentation/platforms/arm/max326xx/boards/max32660-evsys/index.rst @@ -0,0 +1,7 @@ +============== +max32660-evsys +============== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/max326xx/index.rst b/Documentation/platforms/arm/max326xx/index.rst index a6cb77e0627..6f6070ef4eb 100644 --- a/Documentation/platforms/arm/max326xx/index.rst +++ b/Documentation/platforms/arm/max326xx/index.rst @@ -10,3 +10,11 @@ EVSYS was included in the NuttX-7.28 release. A basic NSH configuration is available and is fully functional. Includes unverified support for an SPI0-based SD card. +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/arm/moxart/boards/moxa/index.rst b/Documentation/platforms/arm/moxart/boards/moxa/index.rst new file mode 100644 index 00000000000..dd10749fe6c --- /dev/null +++ b/Documentation/platforms/arm/moxart/boards/moxa/index.rst @@ -0,0 +1,4 @@ +==== +moxa +==== + diff --git a/Documentation/platforms/arm/moxart/index.rst b/Documentation/platforms/arm/moxart/index.rst index 805633236a7..f35f035909d 100644 --- a/Documentation/platforms/arm/moxart/index.rst +++ b/Documentation/platforms/arm/moxart/index.rst @@ -6,3 +6,12 @@ A port to the Moxa NP51x0 series of 2-port advanced RS-232/422/485 serial device servers was contributed by Anton D. Kachalov in NuttX-7.11. This port includes :ref:`NSH ` configuration with support for the Faraday FTMAC100 Ethernet MAC Driver. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/mx8mp/verdin-mx8mp/README.txt b/Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/README.txt similarity index 100% rename from boards/arm/mx8mp/verdin-mx8mp/README.txt rename to Documentation/platforms/arm/mx8mp/boards/verdin-mx8mp/README.txt diff --git a/boards/arm/nuc1xx/nutiny-nuc120/README.txt b/Documentation/platforms/arm/nuc1xx/boards/nutiny-nuc120/README.txt similarity index 100% rename from boards/arm/nuc1xx/nutiny-nuc120/README.txt rename to Documentation/platforms/arm/nuc1xx/boards/nutiny-nuc120/README.txt diff --git a/Documentation/platforms/arm/nuc1xx/boards/nutiny-nuc120/index.rst b/Documentation/platforms/arm/nuc1xx/boards/nutiny-nuc120/index.rst new file mode 100644 index 00000000000..9af617a40ad --- /dev/null +++ b/Documentation/platforms/arm/nuc1xx/boards/nutiny-nuc120/index.rst @@ -0,0 +1,7 @@ +============= +nutiny-nuc120 +============= + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/nuc1xx/index.rst b/Documentation/platforms/arm/nuc1xx/index.rst index f2efcf4417e..cde4ca3d926 100644 --- a/Documentation/platforms/arm/nuc1xx/index.rst +++ b/Documentation/platforms/arm/nuc1xx/index.rst @@ -38,3 +38,13 @@ native toolchain, or 4) Native Windows. A DIY toolchain for Linux or Cygwin is provided by the NuttX `buildroot `__ package. + + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/arm/phy62xx/boards/phy6222/index.rst b/Documentation/platforms/arm/phy62xx/boards/phy6222/index.rst new file mode 100644 index 00000000000..e05d481e13d --- /dev/null +++ b/Documentation/platforms/arm/phy62xx/boards/phy6222/index.rst @@ -0,0 +1,4 @@ +======== +phy62222 +======== + diff --git a/Documentation/platforms/arm/phy62xx/index.rst b/Documentation/platforms/arm/phy62xx/index.rst new file mode 100644 index 00000000000..3ef6467f233 --- /dev/null +++ b/Documentation/platforms/arm/phy62xx/index.rst @@ -0,0 +1,12 @@ +========== +PHY+ PHY62 +========== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/qemu/qemu-armv7a/README.txt b/Documentation/platforms/arm/qemu/boards/qemu-armv7a/README.txt similarity index 100% rename from boards/arm/qemu/qemu-armv7a/README.txt rename to Documentation/platforms/arm/qemu/boards/qemu-armv7a/README.txt diff --git a/Documentation/platforms/arm/qemu/boards/qemu-armv7a/index.rst b/Documentation/platforms/arm/qemu/boards/qemu-armv7a/index.rst new file mode 100644 index 00000000000..2e7d7814dbe --- /dev/null +++ b/Documentation/platforms/arm/qemu/boards/qemu-armv7a/index.rst @@ -0,0 +1,7 @@ +=========== +qemu-armv7a +=========== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/qemu/index.rst b/Documentation/platforms/arm/qemu/index.rst new file mode 100644 index 00000000000..6b90c9c07c1 --- /dev/null +++ b/Documentation/platforms/arm/qemu/index.rst @@ -0,0 +1,12 @@ +==== +QEMU +==== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/rp2040/adafruit-feather-rp2040/README.txt b/Documentation/platforms/arm/rp2040/boards/adafruit-feather-rp2040/README.txt similarity index 100% rename from boards/arm/rp2040/adafruit-feather-rp2040/README.txt rename to Documentation/platforms/arm/rp2040/boards/adafruit-feather-rp2040/README.txt diff --git a/Documentation/platforms/arm/rp2040/boards/adafruit-feather-rp2040/index.rst b/Documentation/platforms/arm/rp2040/boards/adafruit-feather-rp2040/index.rst index 9bbfe545e92..2e2cdbd953c 100644 --- a/Documentation/platforms/arm/rp2040/boards/adafruit-feather-rp2040/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/adafruit-feather-rp2040/index.rst @@ -214,3 +214,8 @@ waveshare-lcd-1.3 NuttShell configuration (console enabled in UART0, at 115200 bps) with support for usbmsc. +README.txt +========== + +.. include:: README.txt + :literal: diff --git a/boards/arm/rp2040/adafruit-kb2040/README.txt b/Documentation/platforms/arm/rp2040/boards/adafruit-kb2040/README.txt similarity index 100% rename from boards/arm/rp2040/adafruit-kb2040/README.txt rename to Documentation/platforms/arm/rp2040/boards/adafruit-kb2040/README.txt diff --git a/Documentation/platforms/arm/rp2040/boards/adafruit-kb2040/index.rst b/Documentation/platforms/arm/rp2040/boards/adafruit-kb2040/index.rst index 3babaa5c4c5..3f6af7d651c 100644 --- a/Documentation/platforms/arm/rp2040/boards/adafruit-kb2040/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/adafruit-kb2040/index.rst @@ -190,3 +190,8 @@ waveshare-lcd-1.3 NuttShell configuration (console enabled in UART0, at 115200 bps) with support for usbmsc. +README.txt +========== + +.. include:: README.txt + :literal: diff --git a/boards/arm/rp2040/adafruit-qt-py-rp2040/README.txt b/Documentation/platforms/arm/rp2040/boards/adafruit-qt-py-rp2040/README.txt similarity index 100% rename from boards/arm/rp2040/adafruit-qt-py-rp2040/README.txt rename to Documentation/platforms/arm/rp2040/boards/adafruit-qt-py-rp2040/README.txt diff --git a/Documentation/platforms/arm/rp2040/boards/adafruit-qt-py-rp2040/index.rst b/Documentation/platforms/arm/rp2040/boards/adafruit-qt-py-rp2040/index.rst index 93f363df5f8..40504b2bb31 100644 --- a/Documentation/platforms/arm/rp2040/boards/adafruit-qt-py-rp2040/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/adafruit-qt-py-rp2040/index.rst @@ -123,3 +123,8 @@ usbnsh Basic NuttShell configuration (console enabled in USB Port, at 115200 bps). +README.txt +========== + +.. include:: README.txt + :literal: diff --git a/boards/arm/rp2040/pimoroni-tiny2040/README.txt b/Documentation/platforms/arm/rp2040/boards/pimoroni-tiny2040/README.txt similarity index 100% rename from boards/arm/rp2040/pimoroni-tiny2040/README.txt rename to Documentation/platforms/arm/rp2040/boards/pimoroni-tiny2040/README.txt diff --git a/Documentation/platforms/arm/rp2040/boards/pimoroni-tiny2040/index.rst b/Documentation/platforms/arm/rp2040/boards/pimoroni-tiny2040/index.rst index 3ef289a0967..138b7cd882c 100644 --- a/Documentation/platforms/arm/rp2040/boards/pimoroni-tiny2040/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/pimoroni-tiny2040/index.rst @@ -131,4 +131,8 @@ usbnsh Basic NuttShell configuration (console enabled in USB Port, at 115200 bps). +README.txt +========== +.. include:: README.txt + :literal: diff --git a/boards/arm/rp2040/raspberrypi-pico-w/README.txt b/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico-w/README.txt similarity index 100% rename from boards/arm/rp2040/raspberrypi-pico-w/README.txt rename to Documentation/platforms/arm/rp2040/boards/raspberrypi-pico-w/README.txt diff --git a/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico-w/index.rst b/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico-w/index.rst index 25d8afcb1cc..b88ec8fb43a 100644 --- a/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico-w/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico-w/index.rst @@ -249,3 +249,9 @@ waveshare-lcd-1.3 NuttShell configuration (console enabled in UART0, at 115200 bps) with support for usbmsc. + +README.txt +========== + +.. include:: README.txt + :literal: diff --git a/boards/arm/rp2040/raspberrypi-pico/README.txt b/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico/README.txt similarity index 100% rename from boards/arm/rp2040/raspberrypi-pico/README.txt rename to Documentation/platforms/arm/rp2040/boards/raspberrypi-pico/README.txt diff --git a/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico/index.rst b/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico/index.rst index 196cf03733f..fd1e52b1fa4 100644 --- a/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/raspberrypi-pico/index.rst @@ -216,3 +216,9 @@ waveshare-lcd-1.3 NuttShell configuration (console enabled in UART0, at 115200 bps) with support for usbmsc. + +README.txt +========== + +.. include:: README.txt + :literal: diff --git a/boards/arm/rp2040/waveshare-rp2040-lcd-1.28/README.txt b/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-lcd-1.28/README.txt similarity index 100% rename from boards/arm/rp2040/waveshare-rp2040-lcd-1.28/README.txt rename to Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-lcd-1.28/README.txt diff --git a/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-lcd-1.28/index.rst b/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-lcd-1.28/index.rst index be38d69e3df..eee43bd1ead 100644 --- a/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-lcd-1.28/index.rst +++ b/Documentation/platforms/arm/rp2040/boards/waveshare-rp2040-lcd-1.28/index.rst @@ -128,3 +128,9 @@ lvgl NuttShell configuration (console enabled in USB Port, at 115200 bps) with support for gc9a01 and LVGL demo (using lcd_dev). + +README.txt +========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/arm/rp2040/index.rst b/Documentation/platforms/arm/rp2040/index.rst index 1805dcdc832..f24d245c589 100644 --- a/Documentation/platforms/arm/rp2040/index.rst +++ b/Documentation/platforms/arm/rp2040/index.rst @@ -1,6 +1,6 @@ -======== -rp2040 -======== +================== +RaspberryPi rp2040 +================== The rp2040 is a dual core chip produced by the RaspberryPi Foundation that is based on ARM Cortex-M0+. diff --git a/boards/arm/sam34/arduino-due/README.txt b/Documentation/platforms/arm/sam34/boards/arduino-due/README.txt similarity index 100% rename from boards/arm/sam34/arduino-due/README.txt rename to Documentation/platforms/arm/sam34/boards/arduino-due/README.txt diff --git a/Documentation/platforms/arm/sam34/boards/arduino-due/index.rst b/Documentation/platforms/arm/sam34/boards/arduino-due/index.rst new file mode 100644 index 00000000000..dab9cd04d36 --- /dev/null +++ b/Documentation/platforms/arm/sam34/boards/arduino-due/index.rst @@ -0,0 +1,6 @@ +=========== +arduino-due +=========== + +This sub-directory holds board support for the Arduino DUE board featuring +the Atmel ATSAM3X8E MCU running at 84 MHz. diff --git a/boards/arm/sam34/flipnclick-sam3x/README.txt b/Documentation/platforms/arm/sam34/boards/flipnclick-sam3x/README.txt similarity index 100% rename from boards/arm/sam34/flipnclick-sam3x/README.txt rename to Documentation/platforms/arm/sam34/boards/flipnclick-sam3x/README.txt diff --git a/Documentation/platforms/arm/sam34/boards/flipnclick-sam3x/index.rst b/Documentation/platforms/arm/sam34/boards/flipnclick-sam3x/index.rst new file mode 100644 index 00000000000..d953e9026b2 --- /dev/null +++ b/Documentation/platforms/arm/sam34/boards/flipnclick-sam3x/index.rst @@ -0,0 +1,6 @@ +================ +flipnclick-sam3x +================ + +.. include:: README.txt + :literal: diff --git a/boards/arm/sam34/sam3u-ek/README.txt b/Documentation/platforms/arm/sam34/boards/sam3u-ek/README.txt similarity index 100% rename from boards/arm/sam34/sam3u-ek/README.txt rename to Documentation/platforms/arm/sam34/boards/sam3u-ek/README.txt diff --git a/Documentation/platforms/arm/sam34/boards/sam3u-ek/index.rst b/Documentation/platforms/arm/sam34/boards/sam3u-ek/index.rst new file mode 100644 index 00000000000..bdb606b86c7 --- /dev/null +++ b/Documentation/platforms/arm/sam34/boards/sam3u-ek/index.rst @@ -0,0 +1,6 @@ +======== +sam3u-ek +======== + +.. include:: README.txt + :literal: diff --git a/boards/arm/sam34/sam4cmp-db/README.txt b/Documentation/platforms/arm/sam34/boards/sam4cmp-db/README.txt similarity index 100% rename from boards/arm/sam34/sam4cmp-db/README.txt rename to Documentation/platforms/arm/sam34/boards/sam4cmp-db/README.txt diff --git a/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst b/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst new file mode 100644 index 00000000000..3858b62106a --- /dev/null +++ b/Documentation/platforms/arm/sam34/boards/sam4cmp-db/index.rst @@ -0,0 +1,6 @@ +========== +sam4cmp-db +========== + +.. include:: README.txt + :literal: diff --git a/boards/arm/sam34/sam4e-ek/README.txt b/Documentation/platforms/arm/sam34/boards/sam4e-ek/README.txt similarity index 100% rename from boards/arm/sam34/sam4e-ek/README.txt rename to Documentation/platforms/arm/sam34/boards/sam4e-ek/README.txt diff --git a/Documentation/platforms/arm/sam34/boards/sam4e-ek/index.rst b/Documentation/platforms/arm/sam34/boards/sam4e-ek/index.rst new file mode 100644 index 00000000000..8ad6898582a --- /dev/null +++ b/Documentation/platforms/arm/sam34/boards/sam4e-ek/index.rst @@ -0,0 +1,6 @@ +======== +sam4e-ek +======== + +.. include:: README.txt + :literal: diff --git a/boards/arm/sam34/sam4l-xplained/README.txt b/Documentation/platforms/arm/sam34/boards/sam4l-xplained/README.txt similarity index 100% rename from boards/arm/sam34/sam4l-xplained/README.txt rename to Documentation/platforms/arm/sam34/boards/sam4l-xplained/README.txt diff --git a/Documentation/platforms/arm/sam34/boards/sam4l-xplained/index.rst b/Documentation/platforms/arm/sam34/boards/sam4l-xplained/index.rst new file mode 100644 index 00000000000..006bfa00db4 --- /dev/null +++ b/Documentation/platforms/arm/sam34/boards/sam4l-xplained/index.rst @@ -0,0 +1,6 @@ +============== +sam4l-xplained +============== + +.. include:: README.txt + :literal: diff --git a/boards/arm/sam34/sam4s-xplained-pro/README.txt b/Documentation/platforms/arm/sam34/boards/sam4s-xplained-pro/README.txt similarity index 100% rename from boards/arm/sam34/sam4s-xplained-pro/README.txt rename to Documentation/platforms/arm/sam34/boards/sam4s-xplained-pro/README.txt diff --git a/Documentation/platforms/arm/sam34/boards/sam4s-xplained-pro/index.rst b/Documentation/platforms/arm/sam34/boards/sam4s-xplained-pro/index.rst new file mode 100644 index 00000000000..0f43e48a14a --- /dev/null +++ b/Documentation/platforms/arm/sam34/boards/sam4s-xplained-pro/index.rst @@ -0,0 +1,6 @@ +================== +sam4s-xplained-pro +================== + +.. include:: README.txt + :literal: diff --git a/boards/arm/sam34/sam4s-xplained/README.txt b/Documentation/platforms/arm/sam34/boards/sam4s-xplained/README.txt similarity index 100% rename from boards/arm/sam34/sam4s-xplained/README.txt rename to Documentation/platforms/arm/sam34/boards/sam4s-xplained/README.txt diff --git a/Documentation/platforms/arm/sam34/boards/sam4s-xplained/index.rst b/Documentation/platforms/arm/sam34/boards/sam4s-xplained/index.rst new file mode 100644 index 00000000000..0e4cb09f55d --- /dev/null +++ b/Documentation/platforms/arm/sam34/boards/sam4s-xplained/index.rst @@ -0,0 +1,6 @@ +============== +sam4s-xplained +============== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/arm/sam34/index.rst b/Documentation/platforms/arm/sam34/index.rst index 5a0fdc67f14..8a8b039ba85 100644 --- a/Documentation/platforms/arm/sam34/index.rst +++ b/Documentation/platforms/arm/sam34/index.rst @@ -141,3 +141,12 @@ devkitARM), or 4) Native Windows. A DIY toolchain for Linux or Cygwin is provided by the NuttX `buildroot `__ package. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/sama5/giant-board/README.md b/Documentation/platforms/arm/sama5/boards/giant-board/index.rst similarity index 83% rename from boards/arm/sama5/giant-board/README.md rename to Documentation/platforms/arm/sama5/boards/giant-board/index.rst index 1b9507f1c6c..f0087dff257 100644 --- a/boards/arm/sama5/giant-board/README.md +++ b/Documentation/platforms/arm/sama5/boards/giant-board/index.rst @@ -1,29 +1,22 @@ -# README +===================== +Groboards Giant Board +===================== - This README file describes the port of NuttX to the Groboards Giant Board - development board. This board features the Atmel SAMA5D27 microprocessor - as a SIP with 128KB on-chip DDR2 RAM (part number `ATSAMA5D27C-D1G`). - See https://groboards.com/giant-board/ for further information. +This page file describes the port of NuttX to the Groboards Giant Board +development board. This board features the Atmel SAMA5D27 microprocessor +as a SIP with 128KB on-chip DDR2 RAM (part number `ATSAMA5D27C-D1G`). +See https://groboards.com/giant-board/ for further information. - This was copied from the SAMA5D2-XULT README, and needs updating. +This was copied from the SAMA5D2-XULT README, and needs updating. -## Contents - - - STATUS - - Loading Code into SRAM with J-Link - - DRAMBOOT, AT25BOOT, SRAMBOOT - - Running NuttX from SDRAM - - Buttons and LEDs - - Serial Console - - Giant Board Configuration Options - - Configurations - -## Status +Status +------ 1. Most of this document is a partially corrected clone of the SAMA5D2-XULT README.txt and still contains errors and inconsistencies. -## Loading Code into SRAM from SD Card +Loading Code into SRAM from SD Card +----------------------------------- There is no JTAG connector on the Giant Board. There are pads to wire up an SWD adapter, but this has not been tested. @@ -35,12 +28,12 @@ https://www.starcat.io/starcat-nuttx/ The SD Card has to be FAT formatted, have an AT91Bootstrap binary called boot.bin, a U-Boot binary called u-boot.bin as well as a compiled device tree for the -SAMA5D27C-D1G called `at91-sama5d27_giantboard.dtb` in the `dtbs/` folder. You can +SAMA5D27C-D1G called ``at91-sama5d27_giantboard.dtb`` in the ``dtbs/`` folder. You can build these yourself using the tools at https://github.com/Groboards/giantboard-tools -The layout should look like this: +The layout should look like this:: BOOT.BIN uboot.env @@ -52,15 +45,17 @@ The layout should look like this: You only need uboot.env if you want to boot automatically. See the U-Boot documentation for instructions on how to create this file. -## Running NuttX from SDRAM +Running NuttX from SDRAM +------------------------ NuttX will be executed from SDRAM, and NuttX binary must reside on SD Card media. -### NuttX Configuration +NuttX Configuration +~~~~~~~~~~~~~~~~~~~ In order to run from SDRAM, NuttX must be built at origin 0x20008000 in SDRAM (skipping over SDRAM memory used by the bootloader). The following -configuration option is required: +configuration option is required:: CONFIG_SAMA5_BOOT_SDRAM=y CONFIG_BOOT_RUNFROMSDRAM=y @@ -72,7 +67,8 @@ as set up by the bootloader. And (2) it will not attempt to configure the SDRAM. Since NuttX is already running from SDRAM, it must accept the SDRAM configuration as set up by the bootloader. -### Boot sequence +Boot sequence +~~~~~~~~~~~~~ Reference: http://www.at91.com/linux4sam/bin/view/Linux4SAM/GettingStarted @@ -100,9 +96,10 @@ The boot sequence of linux4SAM is done in several steps : 4. Then NuttX runs from SDRAM -### NAND FLASH Memory Map +NAND FLASH Memory Map +~~~~~~~~~~~~~~~~~~~~~ -Reference: http://www.at91.com/linux4sam/bin/view/Linux4SAM/GettingStarted +Reference: http://www.at91.com/linux4sam/bin/view/Linux4SAM/GettingStarted :: 0x0000:0000 - 0x0003:ffff: AT91BootStrap 0x0004:0000 - 0x000b:ffff: U-Boot @@ -112,11 +109,13 @@ Reference: http://www.at91.com/linux4sam/bin/view/Linux4SAM/GettingStarted 0x0020:0000 - 0x007f:ffff: NuttX 0x0080:0000 - end: Available for use as a NAND file system -### Load NuttX with U-Boot on AT91 boards +Load NuttX with U-Boot on AT91 boards +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Reference http://www.at91.com/linux4sam/bin/view/Linux4SAM/U-Boot -#### Preparing NuttX image +Preparing NuttX image +..................... U-Boot does not support normal binary images. Instead you have to create an nuttx.bin file. The NuttX build generates this file @@ -124,7 +123,7 @@ automatically. Copy it to the root of the SD Card that you made, and boot the card. The SD Card image above will automatically boot using the nuttx.bin file. If you are using another image (the Giant Board linux image for instance), you can hit space to enter -U-Boot, and then from the U-Boot prompt do the following: +U-Boot, and then from the U-Boot prompt do the following:: U-Boot> fatload mmc 0 0x20008000 nuttx.bin mci: setting clock 257812 Hz, block size 512 @@ -142,27 +141,29 @@ U-Boot, and then from the U-Boot prompt do the following: NuttShell (NSH) NuttX-7.2 nsh> -## Buttons and LEDs +Buttons and LEDs +---------------- -### Buttons +Buttons +~~~~~~~ A single button, PB1, is available on the Giant Board. This is connected to the Power Management Integrated Circuit (PMIC). It is not available to the user. This appears to have no affect under NuttX. -You can add your own buttons, support for pollable buttons is enabled with: +You can add your own buttons, support for pollable buttons is enabled with:: CONFIG_ARCH_BUTTONS=y -For interrupt driven buttons, add: +For interrupt driven buttons, add:: CONFIG_ARCH_IRQBUTTONS=y -Program interfaces for button access are described in nuttx/include/nuttx/arch.h +Program interfaces for button access are described in ``nuttx/include/nuttx/arch.h`` There is an example that can be enabled to test button interrupts. That -example is enabled like: +example is enabled like:: CONFIG_EXAMPLES_BUTTONS=y CONFIG_EXAMPLES_BUTTONS_MAX=0 @@ -171,10 +172,11 @@ example is enabled like: CONFIG_EXAMPLES_IRQBUTTONS_MAX=0 CONFIG_EXAMPLES_IRQBUTTONS_MIN=0 -### LEDs +LEDs +~~~~ There is an Orange LED on the Giant Board, driven by pin (PA6) labeled STATUS. -Bringing the pin high will illuminate the LED. +Bringing the pin high will illuminate the LED:: ------------------------------ ------------------- ------------------------- SAMA5D2 PIO SIGNAL USAGE @@ -183,7 +185,7 @@ Bringing the pin high will illuminate the LED. ------------------------------ ------------------- ------------------------- When CONFIG_ARCH_LEDS is defined in the NuttX configuration, NuttX will -control the Orange LED as follows: +control the Orange LED as follows:: SYMBOL Meaning Orange LED ------------------- ----------------------- --------- @@ -200,11 +202,12 @@ Thus if the Orange LED is statically on, NuttX has successfully booted and is, apparently, running normally. If LED is flashing at approximately 2Hz, then a fatal error has been detected and the system has halted. -## Serial Console +Serial Console +-------------- The default serial console is UART1 (TX and RX on the pin connectors). There is a TTL serial connection available on pins 14 and 15 of the J1 -connector. +connector:: ---- ------------------------ ------------- J1 SCHEMATIC SAMA5D2 @@ -215,7 +218,7 @@ connector. ---- ------------------------ ------------- The other UART on the connectors (J1 and J1) is FLEXCOM4. -Terminology: FLEXCOM is the same as USART in previous SAMA5D versions. +Terminology: FLEXCOM is the same as USART in previous SAMA5D versions:: ---- ----------- ------------- BOARD SAMA5D2 @@ -231,37 +234,38 @@ enabled in all of these configurations unless otherwise noted. REVISIT: UART1 on the DBGU connect might be a better choice for the default serial console -## Giant Board Configuration Options +Giant Board Configuration Options +--------------------------------- CONFIG_ARCH - Identifies the arch/ subdirectory. This should -be set to: +be set to:: CONFIG_ARCH="arm" -CONFIG_ARCH_family - For use in C code: +CONFIG_ARCH_family - For use in C code:: CONFIG_ARCH_ARM=y -CONFIG_ARCH_architecture - For use in C code: +CONFIG_ARCH_architecture - For use in C code:: CONFIG_ARCH_CORTEXA5=y -CONFIG_ARCH_CHIP - Identifies the arch/*/chip subdirectory +CONFIG_ARCH_CHIP - Identifies the ``arch/*/chip`` subdirectory:: CONFIG_ARCH_CHIP="sama5" CONFIG_ARCH_CHIP_name - For use in C code to identify the exact -chip: +chip:: CONFIG_ARCH_CHIP_SAMA5=y CONFIG_ARCH_CHIP_ATSAMA5D27=y -CONFIG_ARCH_BOARD - Identifies the boards/ subdirectory and -hence, the board that supports the particular chip or SoC. +CONFIG_ARCH_BOARD - Identifies the ``boards/`` subdirectory and +hence, the board that supports the particular chip or SoC.:: CONFIG_ARCH_BOARD="giant-board" (for the Groboards Giant Board) -CONFIG_ARCH_BOARD_name - For use in C code +CONFIG_ARCH_BOARD_name - For use in C code:: CONFIG_ARCH_BOARD_GIANT_BOARD=y @@ -271,15 +275,15 @@ of delay loops CONFIG_ENDIAN_BIG - define if big endian (default is little endian) -CONFIG_RAM_SIZE - Describes the installed DRAM (SRAM in this case): +CONFIG_RAM_SIZE - Describes the installed DRAM (SRAM in this case):: CONFIG_RAM_SIZE=0x0002000 (128Kb) -CONFIG_RAM_START - The physical start address of installed DRAM +CONFIG_RAM_START - The physical start address of installed DRAM:: CONFIG_RAM_START=0x20000000 -CONFIG_RAM_VSTART - The virtual start address of installed DRAM +CONFIG_RAM_VSTART - The virtual start address of installed DRAM:: CONFIG_RAM_VSTART=0x20000000 @@ -297,7 +301,7 @@ CONFIG_ARCH_LEDS - Use LEDs to show state. Unique to board architecture. Individual subsystems can be enabled: -REVISIT: Unverified, cloned text from the SAMA5D4-EK README.txt +REVISIT: Unverified, cloned text from the SAMA5D4-EK README.txt:: CONFIG_SAMA5_DBGU - Debug Unit CONFIG_SAMA5_PIT - Periodic Interval Timer @@ -343,7 +347,7 @@ REVISIT: Unverified, cloned text from the SAMA5D4-EK README.txt CONFIG_SAMA5_MPDDRC - MPDDR controller Some subsystems can be configured to operate in different ways. The drivers -need to know how to configure the subsystem. +need to know how to configure the subsystem.:: CONFIG_SAMA5_PIOA_IRQ - Support PIOA interrupts CONFIG_SAMA5_PIOB_IRQ - Support PIOB interrupts @@ -356,31 +360,33 @@ need to know how to configure the subsystem. CONFIG_USART3_SERIALDRIVER - Flexcom3 is configured as a UART CONFIG_USART4_SERIALDRIVER - Flexcom4 is configured as a UART -#### AT91SAMA5 specific device driver settings +AT91SAMA5 specific device driver settings +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - CONFIG_SAMA5_DBGU_SERIAL_CONSOLE - selects the DBGU - for the console and ttyDBGU - CONFIG_SAMA5_DBGU_RXBUFSIZE - Characters are buffered as received. - This specific the size of the receive buffer - CONFIG_SAMA5_DBGU_TXBUFSIZE - Characters are buffered before - being sent. This specific the size of the transmit buffer - CONFIG_SAMA5_DBGU_BAUD - The configure BAUD of the DBGU. - CONFIG_SAMA5_DBGU_PARITY - 0=no parity, 1=odd parity, 2=even parity +- CONFIG_SAMA5_DBGU_SERIAL_CONSOLE - selects the DBGU + for the console and ttyDBGU +- CONFIG_SAMA5_DBGU_RXBUFSIZE - Characters are buffered as received. + This specific the size of the receive buffer +- CONFIG_SAMA5_DBGU_TXBUFSIZE - Characters are buffered before + being sent. This specific the size of the transmit buffer +- CONFIG_SAMA5_DBGU_BAUD - The configure BAUD of the DBGU. +- CONFIG_SAMA5_DBGU_PARITY - 0=no parity, 1=odd parity, 2=even parity - CONFIG_U[S]ARTn_SERIAL_CONSOLE - selects the USARTn (n=0,1,2,3) or UART - m (m=4,5) for the console and ttys0 (default is the DBGU). - CONFIG_U[S]ARTn_RXBUFSIZE - Characters are buffered as received. - This specific the size of the receive buffer - CONFIG_U[S]ARTn_TXBUFSIZE - Characters are buffered before - being sent. This specific the size of the transmit buffer - CONFIG_U[S]ARTn_BAUD - The configure BAUD of the UART. Must be - CONFIG_U[S]ARTn_BITS - The number of bits. Must be either 7 or 8. - CONFIG_U[S]ARTn_PARITY - 0=no parity, 1=odd parity, 2=even parity - CONFIG_U[S]ARTn_2STOP - Two stop bits +- CONFIG_U[S]ARTn_SERIAL_CONSOLE - selects the USARTn (n=0,1,2,3) or UART + m (m=4,5) for the console and ttys0 (default is the DBGU). +- CONFIG_U[S]ARTn_RXBUFSIZE - Characters are buffered as received. + This specific the size of the receive buffer +- CONFIG_U[S]ARTn_TXBUFSIZE - Characters are buffered before + being sent. This specific the size of the transmit buffer +- CONFIG_U[S]ARTn_BAUD - The configure BAUD of the UART. Must be +- CONFIG_U[S]ARTn_BITS - The number of bits. Must be either 7 or 8. +- CONFIG_U[S]ARTn_PARITY - 0=no parity, 1=odd parity, 2=even parity +- CONFIG_U[S]ARTn_2STOP - Two stop bits -#### AT91SAMA5 USB Host Configuration +AT91SAMA5 USB Host Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Pre-requisites +Pre-requisites:: CONFIG_USBDEV - Enable USB device support CONFIG_USBHOST - Enable USB host support @@ -388,7 +394,7 @@ Pre-requisites CONFIG_SAMA5_OHCI - Enable the STM32 USB OTG FS block CONFIG_SCHED_WORKQUEUE - Worker thread support is required -Options: +Options:: CONFIG_SAMA5_OHCI_NEDS Number of endpoint descriptors @@ -407,12 +413,14 @@ Options: config SAMA5_OHCI_REGDEBUG -## Configurations +Configurations +-------------- -### Information Common to All Configurations +Information Common to All Configurations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Each Giant Board configuration is maintained in a sub-directory and -can be selected as follow: +can be selected as follow:: tools/configure.sh giant-board: @@ -420,7 +428,7 @@ Before building, make sure the PATH environment variable includes the correct path to the directory than holds your toolchain binaries. And then build NuttX by simply typing the following. At the conclusion of -the make, the nuttx binary will reside in an ELF file called, simply, nuttx. +the make, the nuttx binary will reside in an ELF file called, simply, nuttx.:: make @@ -430,7 +438,7 @@ must be is one of the following. NOTES: 1. These configurations use the mconf-based configuration tool. To - change any of these configurations using that tool, you should: + change any of these configurations using that tool, you should: a. Build and install the kconfig-mconf tool. See nuttx/README.txt see additional README.txt files in the NuttX tools repository. @@ -446,23 +454,24 @@ NOTES: toolchain selection can easily be reconfigured using 'make menuconfig'. Here are the relevant current settings: - Build Setup: + Build Setup:: - CONFIG_HOST_WINDOWS=y : Microsoft Windows - CONFIG_WINDOWS_CYGWIN=y : Using Cygwin or other POSIX environment + CONFIG_HOST_WINDOWS=y : Microsoft Windows + CONFIG_WINDOWS_CYGWIN=y : Using Cygwin or other POSIX environment -System Type -> Toolchain: +System Type -> Toolchain:: CONFIG_ARM_TOOLCHAIN_GNU_EABI=y : GNU EABI toolchain 4. The SAMA5Dx is running at 528MHz by default in these configurations. -Board Selection -> CPU Frequency +Board Selection -> CPU Frequency:: CONFIG_SAMA5D2XULT_528MHZ=y : Enable 528MHz operation CONFIG_BOARD_LOOPSPERMSEC=65775 : Calibrated on SAMA5D3-Xplained at 528MHz running from SDRAM -### Configuration Sub-directories +Configuration Sub-directories +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Summary: Some of the descriptions below are long and wordy. Here is the concise summary of the available Giant Board configurations: @@ -474,7 +483,8 @@ concise summary of the available Giant Board configurations: There may be issues with some of these configurations. See the details for status of individual configurations. -#### Now for the gory details: +Now for the gory details: +......................... - netnsh: @@ -489,7 +499,7 @@ concise summary of the available Giant Board configurations: very simple NSH configuration upon which you can build further functionality. - NOTES: + NOTES:: 1. This configuration uses the UART1 (PD2 and PD3) for the serial console. USART1 is available at the "DBGU" RS-232 connector (J24). @@ -608,7 +618,7 @@ concise summary of the available Giant Board configurations: peripheral is enabled, and can read and write to a VFAT filesystem on the SD Card. - NuttX will mount the SD Card at `/mnt/mmcsd1`. + NuttX will mount the SD Card at ``/mnt/mmcsd1``. - sdmmc-net-nsh: diff --git a/boards/arm/sama5/jupiter-nano/README.md b/Documentation/platforms/arm/sama5/boards/jupiter-nano/index.rst similarity index 84% rename from boards/arm/sama5/jupiter-nano/README.md rename to Documentation/platforms/arm/sama5/boards/jupiter-nano/index.rst index d0b2f50f374..c3cbdb69779 100644 --- a/boards/arm/sama5/jupiter-nano/README.md +++ b/Documentation/platforms/arm/sama5/boards/jupiter-nano/index.rst @@ -1,29 +1,20 @@ -# README +==================== +Starcat Jupiter Nano +==================== - This README file describes the port of NuttX to the Starcat Jupiter Nano - development board. This board features the Atmel SAMA5D27 microprocessor - as a SIP with 128KB on-chip LPDDR2 RAM (part number `ATSAMA5D27C-LD1G`). - See https://www.starcat.io/products/jupiter-nano/ for further information. +This page file describes the port of NuttX to the Starcat Jupiter Nano +development board. This board features the Atmel SAMA5D27 microprocessor +as a SIP with 128KB on-chip LPDDR2 RAM (part number `ATSAMA5D27C-LD1G`). +See https://www.starcat.io/products/jupiter-nano/ for further information. - This is based the SAMA5D2-XULT README.txt file. - -## Contents - - - STATUS - - Loading Code into SRAM with J-Link hardware debugger - - DRAMBOOT, SRAMBOOT - - Running NuttX from SDRAM - - Buttons and LEDs - - Serial Console - - Jupiter Nano Configuration Options - - Configurations - -## Status +Status +------ 1. Most of this document is a partially corrected clone of the SAMA5D2-XULT README.txt and still contains errors and inconsistencies. -## Loading Code into SRAM via JTAG +Loading Code into SRAM via JTAG +------------------------------- This description assumes that you have a JTAG debugger such as Segger J-Link connected to the Jupiter Nano. These instructions have only been tested with a @@ -46,7 +37,8 @@ a mini-JTAG adapter board and cable. 8. Set the PC to the NuttX entry point 'mon pc 0x20008E20' and start nuttx using 'mon go'. -### Loading Code into SRAM from SD Card +Loading Code into SRAM from SD Card +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can boot NuttX from an SD Card. You can download an SD Card image or a zip file of the required files from this page: @@ -60,7 +52,7 @@ build these yourself using the tools at https://github.com/starcat-io/jupiter-nano-tools -The layout should look like this: +The layout should look like this:: BOOT.BIN uboot.env @@ -72,15 +64,17 @@ The layout should look like this: You only need uboot.env if you want to boot automatically. See the U-Boot documentation for instructions on how to create this file. -## Running NuttX from SDRAM +Running NuttX from SDRAM +------------------------ NuttX will be executed from SDRAM, and NuttX binary must reside on SD Card media. -### NuttX Configuration +NuttX Configuration +~~~~~~~~~~~~~~~~~~~ In order to run from SDRAM, NuttX must be built at origin 0x20008000 in SDRAM (skipping over SDRAM memory used by the bootloader). The following -configuration option is required: +configuration option is required:: CONFIG_SAMA5_BOOT_SDRAM=y CONFIG_BOOT_RUNFROMSDRAM=y @@ -92,7 +86,8 @@ as set up by the bootloader. And (2) it will not attempt to configure the SDRAM. Since NuttX is already running from SDRAM, it must accept the SDRAM configuration as set up by the bootloader. -### Boot sequence +Boot sequence +~~~~~~~~~~~~~ Reference: http://www.at91.com/linux4sam/bin/view/Linux4SAM/GettingStarted @@ -120,9 +115,10 @@ The boot sequence of linux4SAM is done in several steps : 4. Then NuttX runs from SDRAM -### NAND FLASH Memory Map +NAND FLASH Memory Map +~~~~~~~~~~~~~~~~~~~~~ -Reference: http://www.at91.com/linux4sam/bin/view/Linux4SAM/GettingStarted +Reference: http://www.at91.com/linux4sam/bin/view/Linux4SAM/GettingStarted :: 0x0000:0000 - 0x0003:ffff: AT91BootStrap 0x0004:0000 - 0x000b:ffff: U-Boot @@ -132,11 +128,13 @@ Reference: http://www.at91.com/linux4sam/bin/view/Linux4SAM/GettingStarted 0x0020:0000 - 0x007f:ffff: NuttX 0x0080:0000 - end: Available for use as a NAND file system -### Load NuttX with U-Boot on AT91 boards +Load NuttX with U-Boot on AT91 boards +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Reference http://www.at91.com/linux4sam/bin/view/Linux4SAM/U-Boot -#### Preparing NuttX image +Preparing NuttX image +..................... U-Boot does not support normal binary images. Instead you have to create an nuttx.bin file. The NuttX build generates this file @@ -144,7 +142,7 @@ automatically. Copy it to the root of the SD Card that you made, and boot the card. The SD Card image above will automatically boot using the nuttx.bin file. If you are using another image (the Jupiter Nano linux image for instance), you can hit space to enter -U-Boot, and then from the U-Boot prompt do the following: +U-Boot, and then from the U-Boot prompt do the following:: U-Boot> fatload mmc 0 0x20008000 nuttx.bin mci: setting clock 257812 Hz, block size 512 @@ -162,9 +160,11 @@ U-Boot, and then from the U-Boot prompt do the following: NuttShell (NSH) NuttX-11.0 nsh> -## Buttons and LEDs +Buttons and LEDs +---------------- -### Buttons +Buttons +~~~~~~~ Two buttons, labeled S1 RESET, and S2 WAKEUP are available on the Jupiter Nano. Both are connected to the Power Management Integrated Circuit (PMIC) and are @@ -172,18 +172,18 @@ not available to user programs. Pressing RESET will reset the SAMA5D27C-LD1G and ACT8945A PMIC chips. WAKEUP is used to wake up the board if it has been put into a sleep state. -You can add your own buttons, support for pollable buttons is enabled with: +You can add your own buttons, support for pollable buttons is enabled with:: CONFIG_ARCH_BUTTONS=y -For interrupt driven buttons, add: +For interrupt driven buttons, add:: CONFIG_ARCH_IRQBUTTONS=y Program interfaces for button access are described in nuttx/include/nuttx/arch.h There is an example that can be enabled to test button interrupts. That -example is enabled like: +example is enabled like:: CONFIG_EXAMPLES_BUTTONS=y CONFIG_EXAMPLES_BUTTONS_MAX=0 @@ -192,10 +192,11 @@ example is enabled like: CONFIG_EXAMPLES_IRQBUTTONS_MAX=0 CONFIG_EXAMPLES_IRQBUTTONS_MIN=0 -### LEDs +LEDs +~~~~ There is a blue status LED on the Jupiter Nano, driven by pin (PA6) labeled STATUS. -Bringing the pin high will illuminate the LED. +Bringing the pin high will illuminate the LED.:: ------------------------------ ------------------- ------------------------- SAMA5D2 PIO SIGNAL USAGE @@ -204,7 +205,7 @@ Bringing the pin high will illuminate the LED. ------------------------------ ------------------- ------------------------- When CONFIG_ARCH_LEDS is defined in the NuttX configuration, NuttX will -control the blue status LED as follows: +control the blue status LED as follows:: SYMBOL Meaning Blue LED ------------------- ----------------------- --------- @@ -221,11 +222,12 @@ Thus if the blue LED is statically on, NuttX has successfully booted and is, apparently, running normally. If LED is flashing at approximately 2Hz, then a fatal error has been detected and the system has halted. -## Serial Console +Serial Console +-------------- The default serial console is UART1. UART1 is connected to the MCP2200 USB-UART converter, and is available as a USB serial connection on the -micro-USB connector labeled CONSOLE. This is the default serial console. +micro-USB connector labeled CONSOLE. This is the default serial console.:: ------------------------ ------------- SCHEMATIC SAMA5D2 @@ -237,7 +239,7 @@ micro-USB connector labeled CONSOLE. This is the default serial console. The other UARTS on the connectors (J5 and J6) are FLEXCOMS 0, 2, 3 and 4. Terminology: FLEXCOM is the same as USART in previous SAMA5D versions. -These can be configured as UARTs, SPI interfaces, or TWI interfaces. +These can be configured as UARTs, SPI interfaces, or TWI interfaces.:: ---- ----------- ------------- BOARD SAMA5D2 @@ -256,37 +258,38 @@ These can be configured as UARTs, SPI interfaces, or TWI interfaces. By default, the standard UART on the connectors (FLEXCOM4) is enabled in all of these configurations unless otherwise noted. -## Jupiter Nano Configuration Options +Jupiter Nano Configuration Options +---------------------------------- CONFIG_ARCH - Identifies the arch/ subdirectory. This should -be set to: +be set to:: CONFIG_ARCH="arm" -CONFIG_ARCH_family - For use in C code: +CONFIG_ARCH_family - For use in C code:: CONFIG_ARCH_ARM=y -CONFIG_ARCH_architecture - For use in C code: +CONFIG_ARCH_architecture - For use in C code:: CONFIG_ARCH_CORTEXA5=y -CONFIG_ARCH_CHIP - Identifies the arch/*/chip subdirectory +CONFIG_ARCH_CHIP - Identifies the ``arch/*/chip`` subdirectory:: CONFIG_ARCH_CHIP="sama5" CONFIG_ARCH_CHIP_name - For use in C code to identify the exact -chip: +chip:: CONFIG_ARCH_CHIP_SAMA5=y CONFIG_ARCH_CHIP_ATSAMA5D27=y CONFIG_ARCH_BOARD - Identifies the boards/ subdirectory and -hence, the board that supports the particular chip or SoC. +hence, the board that supports the particular chip or SoC:: CONFIG_ARCH_BOARD="jupiter-nano" (for the Starcat Jupiter Nano) -CONFIG_ARCH_BOARD_name - For use in C code +CONFIG_ARCH_BOARD_name - For use in C code:: CONFIG_ARCH_BOARD_GIANT_BOARD=y @@ -296,15 +299,15 @@ of delay loops CONFIG_ENDIAN_BIG - define if big endian (default is little endian) -CONFIG_RAM_SIZE - Describes the installed DRAM (SRAM in this case): +CONFIG_RAM_SIZE - Describes the installed DRAM (SRAM in this case):: CONFIG_RAM_SIZE=0x0002000 (128Kb) -CONFIG_RAM_START - The physical start address of installed DRAM +CONFIG_RAM_START - The physical start address of installed DRAM:: CONFIG_RAM_START=0x20000000 -CONFIG_RAM_VSTART - The virtual start address of installed DRAM +CONFIG_RAM_VSTART - The virtual start address of installed DRAM:: CONFIG_RAM_VSTART=0x20000000 @@ -322,7 +325,7 @@ CONFIG_ARCH_LEDS - Use LEDs to show state. Unique to board architecture. Individual subsystems can be enabled: -REVISIT: Unverified, cloned text from the SAMA5D4-EK README.txt +REVISIT: Unverified, cloned text from the SAMA5D4-EK README.txt:: CONFIG_SAMA5_DBGU - Debug Unit CONFIG_SAMA5_PIT - Periodic Interval Timer @@ -368,7 +371,7 @@ REVISIT: Unverified, cloned text from the SAMA5D4-EK README.txt CONFIG_SAMA5_MPDDRC - MPDDR controller Some subsystems can be configured to operate in different ways. The drivers -need to know how to configure the subsystem. +need to know how to configure the subsystem.:: CONFIG_SAMA5_PIOA_IRQ - Support PIOA interrupts CONFIG_SAMA5_PIOB_IRQ - Support PIOB interrupts @@ -381,31 +384,33 @@ need to know how to configure the subsystem. CONFIG_USART3_SERIALDRIVER - Flexcom3 is configured as a UART CONFIG_USART4_SERIALDRIVER - Flexcom4 is configured as a UART -#### AT91SAMA5 specific device driver settings +AT91SAMA5 specific device driver settings +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - CONFIG_SAMA5_DBGU_SERIAL_CONSOLE - selects the DBGU - for the console and ttyDBGU - CONFIG_SAMA5_DBGU_RXBUFSIZE - Characters are buffered as received. - This specific the size of the receive buffer - CONFIG_SAMA5_DBGU_TXBUFSIZE - Characters are buffered before - being sent. This specific the size of the transmit buffer - CONFIG_SAMA5_DBGU_BAUD - The configure BAUD of the DBGU. - CONFIG_SAMA5_DBGU_PARITY - 0=no parity, 1=odd parity, 2=even parity +- CONFIG_SAMA5_DBGU_SERIAL_CONSOLE - selects the DBGU + for the console and ttyDBGU +- CONFIG_SAMA5_DBGU_RXBUFSIZE - Characters are buffered as received. + This specific the size of the receive buffer +- CONFIG_SAMA5_DBGU_TXBUFSIZE - Characters are buffered before + being sent. This specific the size of the transmit buffer +- CONFIG_SAMA5_DBGU_BAUD - The configure BAUD of the DBGU. +- CONFIG_SAMA5_DBGU_PARITY - 0=no parity, 1=odd parity, 2=even parity - CONFIG_U[S]ARTn_SERIAL_CONSOLE - selects the USARTn (n=0,1,2,3) or UART - m (m=4,5) for the console and ttys0 (default is the DBGU). - CONFIG_U[S]ARTn_RXBUFSIZE - Characters are buffered as received. - This specific the size of the receive buffer - CONFIG_U[S]ARTn_TXBUFSIZE - Characters are buffered before - being sent. This specific the size of the transmit buffer - CONFIG_U[S]ARTn_BAUD - The configure BAUD of the UART. Must be - CONFIG_U[S]ARTn_BITS - The number of bits. Must be either 7 or 8. - CONFIG_U[S]ARTn_PARITY - 0=no parity, 1=odd parity, 2=even parity - CONFIG_U[S]ARTn_2STOP - Two stop bits +- CONFIG_U[S]ARTn_SERIAL_CONSOLE - selects the USARTn (n=0,1,2,3) or UART + m (m=4,5) for the console and ttys0 (default is the DBGU). +- CONFIG_U[S]ARTn_RXBUFSIZE - Characters are buffered as received. + This specific the size of the receive buffer +- CONFIG_U[S]ARTn_TXBUFSIZE - Characters are buffered before + being sent. This specific the size of the transmit buffer +- CONFIG_U[S]ARTn_BAUD - The configure BAUD of the UART. Must be +- CONFIG_U[S]ARTn_BITS - The number of bits. Must be either 7 or 8. +- CONFIG_U[S]ARTn_PARITY - 0=no parity, 1=odd parity, 2=even parity +- CONFIG_U[S]ARTn_2STOP - Two stop bits -#### AT91SAMA5 USB Host Configuration +AT91SAMA5 USB Host Configuration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Pre-requisites +Pre-requisites:: CONFIG_USBDEV - Enable USB device support CONFIG_USBHOST - Enable USB host support @@ -413,7 +418,7 @@ Pre-requisites CONFIG_SAMA5_OHCI - Enable the STM32 USB OTG FS block CONFIG_SCHED_WORKQUEUE - Worker thread support is required -Options: +Options:: CONFIG_SAMA5_OHCI_NEDS Number of endpoint descriptors @@ -432,12 +437,14 @@ Options: config SAMA5_OHCI_REGDEBUG -## Configurations +Configurations +-------------- -### Information Common to All Configurations +Information Common to All Configurations +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Each Jupiter Nano configuration is maintained in a sub-directory and -can be selected as follow: +can be selected as follow:: tools/configure.sh jupiter-nano: @@ -445,14 +452,14 @@ Before building, make sure the PATH environment variable includes the correct path to the directory than holds your toolchain binaries. And then build NuttX by simply typing the following. At the conclusion of -the make, the nuttx binary will reside in an ELF file called, simply, nuttx. +the make, the nuttx binary will reside in an ELF file called, simply, nuttx.:: make The that is provided above as an argument to the tools/configure.sh must be is one of the following. -NOTES: +NOTES:: 1. These configurations use the mconf-based configuration tool. To change any of these configurations using that tool, you should: @@ -476,21 +483,23 @@ NOTES: CONFIG_HOST_WINDOWS=y : Microsoft Windows CONFIG_WINDOWS_CYGWIN=y : Using Cygwin or other POSIX environment -System Type -> Toolchain: +System Type -> Toolchain:: CONFIG_ARMV7A_TOOLCHAIN_GNU_EABIW=y : GNU EABI toolchain for windows 4. The SAMA5Dx is running at 528MHz by default in these configurations. -Board Selection -> CPU Frequency +Board Selection -> CPU Frequency:: CONFIG_SAMA5D2XULT_528MHZ=y : Enable 528MHz operation CONFIG_BOARD_LOOPSPERMSEC=65775 : Calibrated on SAMA5D3-Xplained at 528MHz running from SDRAM -### Configuration Sub-directories +Configuration Sub-directories +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Summary: Some of the descriptions below are long and wordy. Here is the concise summary of the available Jupiter Nano configurations: + - nsh: This is a basic NuttShell (NSH) configuration. @@ -498,7 +507,8 @@ concise summary of the available Jupiter Nano configurations: There may be issues with some of these configurations. See the details for status of individual configurations. -#### Now for the gory details: +Now for the gory details: +......................... - netnsh: @@ -513,7 +523,7 @@ concise summary of the available Jupiter Nano configurations: very simple NSH configuration upon which you can build further functionality. - NOTES: + NOTES:: 1. This configuration uses the UART1 (PD2 and PD3) for the serial console. USART1 is available at the "DBGU" RS-232 connector (J24). @@ -634,26 +644,27 @@ concise summary of the available Jupiter Nano configurations: NuttX will mount the SD Card at `/mnt/mmcsd1`. -## Networking +Networking +---------- - Jupiter Nano has support for Ethernet over USB using CDC-ECM protocol. (All the - SAMA5D27C boards do, actually.) The Jupiter Nano will appear as an Ethernet USB - Gadget on the Linux side. This is a high performance link and can transfer 30MB/s - of data to or from a host computer. +Jupiter Nano has support for Ethernet over USB using CDC-ECM protocol. (All the +SAMA5D27C boards do, actually.) The Jupiter Nano will appear as an Ethernet USB +Gadget on the Linux side. This is a high performance link and can transfer 30MB/s +of data to or from a host computer. - The netnsh sdmmcnsh, or sdmmc-nsh-net-resolvconf configurations will set up the - Ethernet over USB interface to be `10.0.0.2`, and set up default routing via - `10.0.0.1`. The sdmmc-nsh-net-resolvconf also sets up the /etc/resolv.conf file - and configures NuttX to support it, which enables DNS resolution using Google's - open DNS servers. +The netnsh sdmmcnsh, or sdmmc-nsh-net-resolvconf configurations will set up the +Ethernet over USB interface to be `10.0.0.2`, and set up default routing via +`10.0.0.1`. The sdmmc-nsh-net-resolvconf also sets up the /etc/resolv.conf file +and configures NuttX to support it, which enables DNS resolution using Google's +open DNS servers. - The tools/netusb.sh script can set up a Linux computer with IP tables NAT rules - and proper routes to allow the NuttX computer to access the Internet, setting - the Linux side of the Ethernet over USB link to have the IP address of - `10.0.0.1`. +The tools/netusb.sh script can set up a Linux computer with IP tables NAT rules +and proper routes to allow the NuttX computer to access the Internet, setting +the Linux side of the Ethernet over USB link to have the IP address of +`10.0.0.1`. - In the commands below, replace the interface identifier `wlp0s20f3` with the - interface that you use to access the Internet. +In the commands below, replace the interface identifier `wlp0s20f3` with the +interface that you use to access the Internet:: $./tools/netusb.sh show enx020000112233: flags=4098 mtu 1500 @@ -695,5 +706,3 @@ concise summary of the available Jupiter Nano configurations: --- 10.0.0.2 ping statistics --- 1 packets transmitted, 1 received, 0% packet loss, time 0ms rtt min/avg/max/mdev = 0.187/0.187/0.187/0.000 ms - - diff --git a/Documentation/platforms/arm/sama5/boards/sam5d3-xplained/index.rst b/Documentation/platforms/arm/sama5/boards/sam5d3-xplained/index.rst new file mode 100644 index 00000000000..2f336610c42 --- /dev/null +++ b/Documentation/platforms/arm/sama5/boards/sam5d3-xplained/index.rst @@ -0,0 +1,7 @@ +================ +sama5d3-xplained +================ + +This is the port of NuttX to the Atmel SAMA5D3x-Xplained development board. +This board features the Atmel SAMA5D36. See +http://www.atmel.com/devices/sama5d36.aspx. diff --git a/boards/arm/sama5/sama5d2-xult/README.txt b/Documentation/platforms/arm/sama5/boards/sama5d2-xult/README.txt similarity index 100% rename from boards/arm/sama5/sama5d2-xult/README.txt rename to Documentation/platforms/arm/sama5/boards/sama5d2-xult/README.txt diff --git a/Documentation/platforms/arm/sama5/boards/sama5d2-xult/index.rst b/Documentation/platforms/arm/sama5/boards/sama5d2-xult/index.rst new file mode 100644 index 00000000000..d41709cb798 --- /dev/null +++ b/Documentation/platforms/arm/sama5/boards/sama5d2-xult/index.rst @@ -0,0 +1,20 @@ +=========== +sama5d3x-ek +=========== + +This is the port of NuttX to the Atmel SAMA5D3x-EK development boards +(where x=1,3,4, or 5). These boards feature the Atmel SAMA5D3 +microprocessors. Four different SAMA5D3x-EK kits are available + +- SAMA5D31-EK with the ATSAMA5D1 (http://www.atmel.com/devices/sama5d31.aspx) +- SAMA5D33-EK with the ATSAMA5D3 (http://www.atmel.com/devices/sama5d33.aspx) +- SAMA5D34-EK with the ATSAMA5D4 (http://www.atmel.com/devices/sama5d34.aspx) +- SAMA5D35-EK with the ATSAMA5D5 (http://www.atmel.com/devices/sama5d35.aspx) + +The each consist of an identical base board with different plug-in modules +for each CPU. An option 7 inch LCD is also available. All four boards +are supported by NuttX with a simple reconfiguration of the processor +type. + +.. include:: README.txt + :literal: diff --git a/boards/arm/sama5/sama5d3-xplained/README.txt b/Documentation/platforms/arm/sama5/boards/sama5d3-xplained/README.txt similarity index 100% rename from boards/arm/sama5/sama5d3-xplained/README.txt rename to Documentation/platforms/arm/sama5/boards/sama5d3-xplained/README.txt diff --git a/Documentation/platforms/arm/sama5/boards/sama5d3-xplained/index.rst b/Documentation/platforms/arm/sama5/boards/sama5d3-xplained/index.rst new file mode 100644 index 00000000000..6fdb36a54db --- /dev/null +++ b/Documentation/platforms/arm/sama5/boards/sama5d3-xplained/index.rst @@ -0,0 +1,6 @@ +================ +sama5d3-xplained +================ + +.. include:: README.txt + :literal: diff --git a/boards/arm/sama5/sama5d3x-ek/README.txt b/Documentation/platforms/arm/sama5/boards/sama5d3x-ek/README.txt similarity index 100% rename from boards/arm/sama5/sama5d3x-ek/README.txt rename to Documentation/platforms/arm/sama5/boards/sama5d3x-ek/README.txt diff --git a/boards/arm/sama5/sama5d3x-ek/Using-NxPlayer.txt b/Documentation/platforms/arm/sama5/boards/sama5d3x-ek/Using-NxPlayer.txt similarity index 100% rename from boards/arm/sama5/sama5d3x-ek/Using-NxPlayer.txt rename to Documentation/platforms/arm/sama5/boards/sama5d3x-ek/Using-NxPlayer.txt diff --git a/Documentation/platforms/arm/sama5/boards/sama5d3x-ek/index.rst b/Documentation/platforms/arm/sama5/boards/sama5d3x-ek/index.rst new file mode 100644 index 00000000000..60718024220 --- /dev/null +++ b/Documentation/platforms/arm/sama5/boards/sama5d3x-ek/index.rst @@ -0,0 +1,9 @@ +=========== +sama5d3x-ek +=========== + +.. include:: README.txt + :literal: + +.. include:: Using-NxPlayer.txt + :literal: diff --git a/boards/arm/sama5/sama5d4-ek/README.txt b/Documentation/platforms/arm/sama5/boards/sama5d4-ek/README.txt similarity index 100% rename from boards/arm/sama5/sama5d4-ek/README.txt rename to Documentation/platforms/arm/sama5/boards/sama5d4-ek/README.txt diff --git a/boards/arm/sama5/sama5d4-ek/RunningNxWM.txt b/Documentation/platforms/arm/sama5/boards/sama5d4-ek/RunningNxWM.txt similarity index 100% rename from boards/arm/sama5/sama5d4-ek/RunningNxWM.txt rename to Documentation/platforms/arm/sama5/boards/sama5d4-ek/RunningNxWM.txt diff --git a/Documentation/platforms/arm/sama5/boards/sama5d4-ek/index.rst b/Documentation/platforms/arm/sama5/boards/sama5d4-ek/index.rst new file mode 100644 index 00000000000..7cfcf078dcd --- /dev/null +++ b/Documentation/platforms/arm/sama5/boards/sama5d4-ek/index.rst @@ -0,0 +1,9 @@ +========== +sama5d4-ek +========== + +.. include:: README.txt + :literal: + +.. include:: RunningNxWM.txt + :literal: diff --git a/Documentation/platforms/arm/sama5/index.rst b/Documentation/platforms/arm/sama5/index.rst index af02a4a0154..b50627800ab 100644 --- a/Documentation/platforms/arm/sama5/index.rst +++ b/Documentation/platforms/arm/sama5/index.rst @@ -158,3 +158,13 @@ There is a port in progress on one Microchip SAMA5D4 board: native toolchain, or 4) Native Windows. All testing has been performed with the CodeSourcery toolchain (GCC version 4.7.3) in the Cygwin environment under Windows. + + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/samd2l2/arduino-m0/README.txt b/Documentation/platforms/arm/samd2l2/boards/arduino-m0/README.txt similarity index 100% rename from boards/arm/samd2l2/arduino-m0/README.txt rename to Documentation/platforms/arm/samd2l2/boards/arduino-m0/README.txt diff --git a/Documentation/platforms/arm/samd2l2/boards/arduino-m0/index.rst b/Documentation/platforms/arm/samd2l2/boards/arduino-m0/index.rst new file mode 100644 index 00000000000..645634cbb38 --- /dev/null +++ b/Documentation/platforms/arm/samd2l2/boards/arduino-m0/index.rst @@ -0,0 +1,7 @@ +========== +arduino-m0 +========== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/samd2l2/boards/circuit-express/index.rst b/Documentation/platforms/arm/samd2l2/boards/circuit-express/index.rst new file mode 100644 index 00000000000..2504822bf46 --- /dev/null +++ b/Documentation/platforms/arm/samd2l2/boards/circuit-express/index.rst @@ -0,0 +1,3 @@ +=============== +circuit-express +=============== diff --git a/boards/arm/samd2l2/samd20-xplained/README.txt b/Documentation/platforms/arm/samd2l2/boards/samd20-xplained/README.txt similarity index 100% rename from boards/arm/samd2l2/samd20-xplained/README.txt rename to Documentation/platforms/arm/samd2l2/boards/samd20-xplained/README.txt diff --git a/Documentation/platforms/arm/samd2l2/boards/samd20-xplained/index.rst b/Documentation/platforms/arm/samd2l2/boards/samd20-xplained/index.rst new file mode 100644 index 00000000000..f6034cb9a5a --- /dev/null +++ b/Documentation/platforms/arm/samd2l2/boards/samd20-xplained/index.rst @@ -0,0 +1,7 @@ +=============== +samd20-xplained +=============== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/samd2l2/samd21-xplained/README.txt b/Documentation/platforms/arm/samd2l2/boards/samd21-xplained/README.txt similarity index 100% rename from boards/arm/samd2l2/samd21-xplained/README.txt rename to Documentation/platforms/arm/samd2l2/boards/samd21-xplained/README.txt diff --git a/Documentation/platforms/arm/samd2l2/boards/samd21-xplained/index.rst b/Documentation/platforms/arm/samd2l2/boards/samd21-xplained/index.rst new file mode 100644 index 00000000000..59bcea5c8a8 --- /dev/null +++ b/Documentation/platforms/arm/samd2l2/boards/samd21-xplained/index.rst @@ -0,0 +1,7 @@ +=============== +samd21-xplained +=============== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/samd2l2/saml21-xplained/README.txt b/Documentation/platforms/arm/samd2l2/boards/saml21-xplained/README.txt similarity index 100% rename from boards/arm/samd2l2/saml21-xplained/README.txt rename to Documentation/platforms/arm/samd2l2/boards/saml21-xplained/README.txt diff --git a/Documentation/platforms/arm/samd2l2/boards/saml21-xplained/index.rst b/Documentation/platforms/arm/samd2l2/boards/saml21-xplained/index.rst new file mode 100644 index 00000000000..c2d1fe753b9 --- /dev/null +++ b/Documentation/platforms/arm/samd2l2/boards/saml21-xplained/index.rst @@ -0,0 +1,7 @@ +=============== +saml21-xplained +=============== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/samd2l2/index.rst b/Documentation/platforms/arm/samd2l2/index.rst index b341a6cf21f..3e0497993ab 100644 --- a/Documentation/platforms/arm/samd2l2/index.rst +++ b/Documentation/platforms/arm/samd2l2/index.rst @@ -26,3 +26,12 @@ Microchip SAML21 The port of NuttX to the Microchip SAML21-Xplained Pro development board. This board features the ATSAML21J18A MCU (Cortex-M0+ with 256KB of FLASH and 32KB of SRAM). + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/samd5e5/metro-m4/README.txt b/Documentation/platforms/arm/samd5e5/boards/metro-m4/README.txt similarity index 100% rename from boards/arm/samd5e5/metro-m4/README.txt rename to Documentation/platforms/arm/samd5e5/boards/metro-m4/README.txt diff --git a/Documentation/platforms/arm/samd5e5/boards/metro-m4/index.rst b/Documentation/platforms/arm/samd5e5/boards/metro-m4/index.rst new file mode 100644 index 00000000000..a7fab871c2a --- /dev/null +++ b/Documentation/platforms/arm/samd5e5/boards/metro-m4/index.rst @@ -0,0 +1,7 @@ +======== +metro-m4 +======== + +.. include:: README.txt + :literal: + diff --git a/boards/arm/samd5e5/same54-xplained-pro/README.txt b/Documentation/platforms/arm/samd5e5/boards/same54-xplained-pro/README.txt similarity index 100% rename from boards/arm/samd5e5/same54-xplained-pro/README.txt rename to Documentation/platforms/arm/samd5e5/boards/same54-xplained-pro/README.txt diff --git a/Documentation/platforms/arm/samd5e5/boards/same54-xplained-pro/index.rst b/Documentation/platforms/arm/samd5e5/boards/same54-xplained-pro/index.rst new file mode 100644 index 00000000000..7d6f775f569 --- /dev/null +++ b/Documentation/platforms/arm/samd5e5/boards/same54-xplained-pro/index.rst @@ -0,0 +1,7 @@ +=================== +same54-xplained-pro +=================== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/arm/samd5e5/index.rst b/Documentation/platforms/arm/samd5e5/index.rst new file mode 100644 index 00000000000..6dab5602166 --- /dev/null +++ b/Documentation/platforms/arm/samd5e5/index.rst @@ -0,0 +1,12 @@ +================= +Microchip samd5e5 +================= + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm/samv7/same70-qmtech/README.txt b/Documentation/platforms/arm/samv7/boards/same70-qmtech/README.txt similarity index 100% rename from boards/arm/samv7/same70-qmtech/README.txt rename to Documentation/platforms/arm/samv7/boards/same70-qmtech/README.txt diff --git a/Documentation/platforms/arm/samv7/boards/same70-qmtech/index.rst b/Documentation/platforms/arm/samv7/boards/same70-qmtech/index.rst new file mode 100644 index 00000000000..db6a87e7cdb --- /dev/null +++ b/Documentation/platforms/arm/samv7/boards/same70-qmtech/index.rst @@ -0,0 +1,6 @@ +============= +same70-qmtech +============= + +.. include:: README.txt + :literal: diff --git a/boards/arm/samv7/same70-xplained/README.txt b/Documentation/platforms/arm/samv7/boards/same70-xplained/README.txt similarity index 100% rename from boards/arm/samv7/same70-xplained/README.txt rename to Documentation/platforms/arm/samv7/boards/same70-xplained/README.txt diff --git a/Documentation/platforms/arm/samv7/boards/same70-xplained/index.rst b/Documentation/platforms/arm/samv7/boards/same70-xplained/index.rst new file mode 100644 index 00000000000..27dd8a09899 --- /dev/null +++ b/Documentation/platforms/arm/samv7/boards/same70-xplained/index.rst @@ -0,0 +1,6 @@ +=============== +same70-xplained +=============== + +.. include:: README.txt + :literal: diff --git a/boards/arm/samv7/samv71-xult/README.txt b/Documentation/platforms/arm/samv7/boards/samv71-xult/README.txt similarity index 100% rename from boards/arm/samv7/samv71-xult/README.txt rename to Documentation/platforms/arm/samv7/boards/samv71-xult/README.txt diff --git a/Documentation/platforms/arm/samv7/boards/samv71-xult/index.rst b/Documentation/platforms/arm/samv7/boards/samv71-xult/index.rst new file mode 100644 index 00000000000..756595f20e4 --- /dev/null +++ b/Documentation/platforms/arm/samv7/boards/samv71-xult/index.rst @@ -0,0 +1,6 @@ +=========== +samv71-xult +=========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/arm/samv7/index.rst b/Documentation/platforms/arm/samv7/index.rst index 9071b1d65de..79acccde8cc 100644 --- a/Documentation/platforms/arm/samv7/index.rst +++ b/Documentation/platforms/arm/samv7/index.rst @@ -310,11 +310,8 @@ peripheral to memory or memory to memory transfers. Supported Boards ================ -For board documentation please refer to ``board/arm/samv7`` section to separate README files. +.. toctree:: + :glob: + :maxdepth: 1 -.. - .. toctree:: - :glob: - :maxdepth: 1 - - boards/*/* + boards/*/* diff --git a/Documentation/platforms/arm/stm32l5/index.rst b/Documentation/platforms/arm/stm32l5/index.rst index 1f824d5e14f..b1e0111d788 100644 --- a/Documentation/platforms/arm/stm32l5/index.rst +++ b/Documentation/platforms/arm/stm32l5/index.rst @@ -2,6 +2,26 @@ ST STM32L5 ========== +This is a port of NuttX to the STM32L5 Family + +Used development boards are the Nucleo L552ZE-Q, and STM32L562E-DK. + +Most code is copied and adapted from the STM32L4 port. + +The only supported STM32L5 family currently is: + +================ ======= ============================ +NuttX config Manual Chips +================ ======= ============================ +STM32L5 RM0438 STM32L552xx and STM32L562xx +================ ======= ============================ + +TODO list +--------- + +Extensive testing. Only initial sniff tests have been done. +A prober TODO list should be generated. + Supported MCUs ============== diff --git a/Documentation/platforms/arm/stm32u5/index.rst b/Documentation/platforms/arm/stm32u5/index.rst index 0bf6945d1a8..e9055a9043d 100644 --- a/Documentation/platforms/arm/stm32u5/index.rst +++ b/Documentation/platforms/arm/stm32u5/index.rst @@ -2,8 +2,34 @@ ST STM32U5 ========== +This is a port of NuttX to the STM32U5 Family + The STM32U5 is a chip based on ARM Cortex-M33. +Used development board is the B-U585I-IOT02A + +Most code is copied and adapted from the STM32L5 port. + +The only supported STM32U5 family currently is: + +================ ======= ============================ +NuttX config Manual Chips +================ ======= ============================ +STM32U5 RM0456 STM32U575xx and STM32U585xx +================ ======= ============================ + +TODO list +--------- + +Extensive testing. Only initial sniff tests have been done. +A prober TODO list should be generated. + +References +---------- + +[RM0456] STMicroelectronics, STM32U575/585 Arm(R)-based 32-bit MCUs, Rev 2 + + Supported MCUs ============== diff --git a/boards/arm/str71x/olimex-strp711/README.txt b/Documentation/platforms/arm/str71x/boards/olimex-strp711/README.txt similarity index 100% rename from boards/arm/str71x/olimex-strp711/README.txt rename to Documentation/platforms/arm/str71x/boards/olimex-strp711/README.txt diff --git a/boards/arm/tiva/dk-tm4c129x/README.txt b/Documentation/platforms/arm/tiva/boards/dk-tm4c129x/README.txt similarity index 100% rename from boards/arm/tiva/dk-tm4c129x/README.txt rename to Documentation/platforms/arm/tiva/boards/dk-tm4c129x/README.txt diff --git a/boards/arm/tiva/eagle100/README.txt b/Documentation/platforms/arm/tiva/boards/eagle100/README.txt similarity index 100% rename from boards/arm/tiva/eagle100/README.txt rename to Documentation/platforms/arm/tiva/boards/eagle100/README.txt diff --git a/boards/arm/tiva/ekk-lm3s9b96/README.txt b/Documentation/platforms/arm/tiva/boards/ekk-lm3s9b96/README.txt similarity index 100% rename from boards/arm/tiva/ekk-lm3s9b96/README.txt rename to Documentation/platforms/arm/tiva/boards/ekk-lm3s9b96/README.txt diff --git a/boards/arm/tiva/launchxl-cc1310/README.txt b/Documentation/platforms/arm/tiva/boards/launchxl-cc1310/README.txt similarity index 100% rename from boards/arm/tiva/launchxl-cc1310/README.txt rename to Documentation/platforms/arm/tiva/boards/launchxl-cc1310/README.txt diff --git a/boards/arm/tiva/launchxl-cc1312r1/README.txt b/Documentation/platforms/arm/tiva/boards/launchxl-cc1312r1/README.txt similarity index 100% rename from boards/arm/tiva/launchxl-cc1312r1/README.txt rename to Documentation/platforms/arm/tiva/boards/launchxl-cc1312r1/README.txt diff --git a/boards/arm/tiva/lm3s6432-s2e/README.txt b/Documentation/platforms/arm/tiva/boards/lm3s6432-s2e/README.txt similarity index 100% rename from boards/arm/tiva/lm3s6432-s2e/README.txt rename to Documentation/platforms/arm/tiva/boards/lm3s6432-s2e/README.txt diff --git a/boards/arm/tiva/lm3s6965-ek/README.txt b/Documentation/platforms/arm/tiva/boards/lm3s6965-ek/README.txt similarity index 100% rename from boards/arm/tiva/lm3s6965-ek/README.txt rename to Documentation/platforms/arm/tiva/boards/lm3s6965-ek/README.txt diff --git a/boards/arm/tiva/lm3s8962-ek/README.txt b/Documentation/platforms/arm/tiva/boards/lm3s8962-ek/README.txt similarity index 100% rename from boards/arm/tiva/lm3s8962-ek/README.txt rename to Documentation/platforms/arm/tiva/boards/lm3s8962-ek/README.txt diff --git a/boards/arm/tiva/lm4f120-launchpad/README.txt b/Documentation/platforms/arm/tiva/boards/lm4f120-launchpad/README.txt similarity index 100% rename from boards/arm/tiva/lm4f120-launchpad/README.txt rename to Documentation/platforms/arm/tiva/boards/lm4f120-launchpad/README.txt diff --git a/boards/arm/tiva/tm4c123g-launchpad/README.txt b/Documentation/platforms/arm/tiva/boards/tm4c123g-launchpad/README.txt similarity index 100% rename from boards/arm/tiva/tm4c123g-launchpad/README.txt rename to Documentation/platforms/arm/tiva/boards/tm4c123g-launchpad/README.txt diff --git a/boards/arm/tiva/tm4c1294-launchpad/README.txt b/Documentation/platforms/arm/tiva/boards/tm4c1294-launchpad/README.txt similarity index 100% rename from boards/arm/tiva/tm4c1294-launchpad/README.txt rename to Documentation/platforms/arm/tiva/boards/tm4c1294-launchpad/README.txt diff --git a/boards/arm/tiva/tm4c129e-launchpad/README.txt b/Documentation/platforms/arm/tiva/boards/tm4c129e-launchpad/README.txt similarity index 100% rename from boards/arm/tiva/tm4c129e-launchpad/README.txt rename to Documentation/platforms/arm/tiva/boards/tm4c129e-launchpad/README.txt diff --git a/boards/arm/tms570/launchxl-tms57004/README.txt b/Documentation/platforms/arm/tms570/boards/launchxl-tms57004/README.txt similarity index 100% rename from boards/arm/tms570/launchxl-tms57004/README.txt rename to Documentation/platforms/arm/tms570/boards/launchxl-tms57004/README.txt diff --git a/boards/arm/tms570/tms570ls31x-usb-kit/README.txt b/Documentation/platforms/arm/tms570/boards/tms570ls31x-usb-kit/README.txt similarity index 100% rename from boards/arm/tms570/tms570ls31x-usb-kit/README.txt rename to Documentation/platforms/arm/tms570/boards/tms570ls31x-usb-kit/README.txt diff --git a/Documentation/platforms/arm64/a64/boards/pinephone/#index.rst# b/Documentation/platforms/arm64/a64/boards/pinephone/#index.rst# new file mode 100644 index 00000000000..b89790be2e3 --- /dev/null +++ b/Documentation/platforms/arm64/a64/boards/pinephone/#index.rst# @@ -0,0 +1,196 @@ +================ +PINE64 PinePhone +================ +`PinePhone `_ is an ARM64 smartphone created by PINE64. + +Features +======== + +- **System on Chip:** Allwinner A64 + - **CPU:** Quad-Core ARM Cortex-A53 + - **GPU:** ARM Mali400 MP2 + - **Interrupt Controller:** ARM GIC PL400 (Generic Interrupt Controller v2) + - **Display Engine:** Allwinner Display Engine 2.0 (MIPI DSI with DMA) +- **Display:** Xingbangda XBD599 HD IPS Display (5.95 inches, 1440x720 resolution, 16M colors, PWM Backlight) +- **Touch Panel:** Goodix GT917S Capacitive Touch Panel (I2C) +- **LCD Controller:** Sitronix ST7703 (MIPI DSI) +- **RAM:** 2GB or 3GB LPDDR3 SDRAM +- **Internal Storage:** 16GB or 32GB eMMC, extendable up to 2TB via microSD +- **Back Camera:** Single 5MP, 1/4", LED Flash +- **Front Camera:** Single 2MP, f/2.8, 1/5" +- **Sound:** Loudspeaker, 3.5mm jack & mic (jack doubles as Hardware UART if Privacy Switch 6 is Off) +- Modem: Quectel EG25-G + - **LTE-FDD, LTE-TDD, WCDMA, GSM** + - **GNSS:** GPS / GLONASS / BeiDou / Galileo / QZSS, with A-GPS +- 2.4 GHz Wireless: Realtek RTL8723CS + - **WLAN:** WiFi 802.11 b/g/n, single-band, hotspot + - **Bluetooth:** 4.0, A2DP +- **Magnetometer:** STMicroelectronics LIS3MDL +- **Ambient Light / Proximity:** SensorTek STK3335 +- **Accelerometer / Gyroscope:** InvenSense MPU-6050 (I2C) +- **Privacy Switches:** Modem, WiFi & Bluetooth, Microphone, Cameras, Headphone +- **Battery:** Lithium-ion, rated capacity 2800mAh (10.64Wh), typical capacity 3000mAh (11.40Wh) +- **I/O:** USB Type-C, USB Host, DisplayPort Alternate Mode output, 15W 5V 3A Quick Charge, follows USB PD specification +- **Power Management Integrated Circuit:** X-Powers AXP803 (Reduced Serial Bus) + +Serial Console +============== + +A `PinePhone Serial Debug Cable `_ +is required to run NuttX on PinePhone. + +On PinePhone, set the `Privacy Switch 6 (Headphone) `_ +to **Off**. + +Connect PinePhone to our computer with the Serial Debug Cable. +On our computer, start a Serial Terminal and connect to the USB Serial Port +at **115.2 kbps**. + +NuttX will appear in the Serial Console when it boots on PinePhone. + +ARM64 Toolchain +=============== + +Before building NuttX for PinePhone, download the ARM64 Toolchain for +**AArch64 Bare-Metal Target** ``aarch64-none-elf`` from +`Arm GNU Toolchain Downloads `_. +(Skip the section for Beta Releases) + +Add the downloaded toolchain ``gcc-arm-...-aarch64-none-elf/bin`` +to the ``PATH`` Environment Variable. + +Check the ARM64 Toolchain: + +.. code:: console + + $ aarch64-none-elf-gcc -v + +Building +======== + +To build NuttX for PinePhone, :doc:`install the prerequisites ` and +:doc:`clone the git repositories ` for ``nuttx`` and ``apps``. + +Configure the NuttX project and build the project: + +.. code:: console + + $ cd nuttx + $ tools/configure.sh pinephone:lvgl + $ make + $ cp nuttx.bin Image + $ rm -f Image.gz + $ gzip Image + +This produces the file ``Image.gz``, which will be copied to PinePhone in the next step. + +If the build fails with the error ``token "@" is not valid in preprocessor``, +`apply this patch `_ +to ``gcc-arm-none-eabi/arm-none-eabi/include/_newlib_version.h`` +in the ARM64 Toolchain. + +Booting +======= + +NuttX boots on PinePhone via a microSD Card. To prepare the microSD Card, download the +**PinePhone Jumpdrive Image** ``pine64-pinephone.img.xz`` from +`dreemurrs-embedded/Jumpdrive `_. + +Write the downloaded image to a microSD Card with +`Balena Etcher `_. + +Copy the file ``Image.gz`` from the previous section +and overwrite the file on the microSD Card. + +Check that PinePhone is connected to our computer via a +`Serial Debug Cable `_ at 115.2 kbps. +`Privacy Switch 6 (Headphone) `_ +should be set to **Off**. + +Insert the microSD Card into PinePhone and power up PinePhone. +NuttX boots on PinePhone and NuttShell (nsh) appears in the Serial Console. + +To see the available commands in NuttShell: + +.. code:: console + + $ help + +To run the LVGL Touchscreen Demo: + +.. code:: console + + $ lvgldemo widgets + +LEDs +==== + +The supported PinePhone LEDs are: + +===== ========= === +Index LED PIO +===== ========= === +LED1 Green LED PD18 +LED2 Red LED PD19 +LED3 Blue LED PD20 +===== ========= === + +Configurations +============== + +lcd +___ + +Supports LCD Display (XBD599) with LCD Controller (ST7703), +Display Engine 2.0, MIPI Display Serial Interface (DSI), +Power Management Integrated Circuit (AXP803) and +Reduced Serial Bus (RSB). +Serial Console is enabled on UART0 at 115.2 kbps. + +lvgl +____ + +Supports all the features in ``lcd``, +plus LVGL Graphics Library and Touch Panel (GT917S). +Serial Console is enabled on UART0 at 115.2 kbps. + +nsh +--- + +Basic configuration that runs NuttShell (nsh). +This configuration is focused on low level, command-line driver testing. +Built-in applications are supported, but none are enabled. +Serial Console is enabled on UART0 at 115.2 kbps. + +sensor +------ + +Supports Accelerometer / Gyroscope (MPU-6050), +Power Management Integrated Circuit (AXP803) and +Reduced Serial Bus (RSB). +Serial Console is enabled on UART0 at 115.2 kbps. + +Peripheral Support +================== + +NuttX for PinePhone supports these peripherals: + +======================== ======= ===== +Peripheral Support NOTES +======================== ======= ===== +Accelerometer (MPU-6050) Yes +Backlight Yes +Display Engine Yes +Frame Buffer Yes +LCD Controller (ST7703) Yes +LCD Panel (XBD599) Yes +MIPI D-PHY Yes +MIPI DSI Yes +PIO Yes +PMIC (AXP803) Yes +RSB Yes +TCON0 Yes +TWI / I2C Yes +Touch Panel (GT917S) Yes +UART Yes +======================== ======= ===== diff --git a/boards/arm64/fvp-v8r/fvp-armv8r/README.txt b/Documentation/platforms/arm64/fvp-v8r/boards/fvp-armv8r/README.txt similarity index 100% rename from boards/arm64/fvp-v8r/fvp-armv8r/README.txt rename to Documentation/platforms/arm64/fvp-v8r/boards/fvp-armv8r/README.txt diff --git a/Documentation/platforms/arm64/fvp-v8r/boards/fvp-armv8r/index.rst b/Documentation/platforms/arm64/fvp-v8r/boards/fvp-armv8r/index.rst new file mode 100644 index 00000000000..47be1e2497a --- /dev/null +++ b/Documentation/platforms/arm64/fvp-v8r/boards/fvp-armv8r/index.rst @@ -0,0 +1,6 @@ +========== +fvp-armv8r +========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/arm64/fvp-v8r/index.rst b/Documentation/platforms/arm64/fvp-v8r/index.rst new file mode 100644 index 00000000000..50b2e391c37 --- /dev/null +++ b/Documentation/platforms/arm64/fvp-v8r/index.rst @@ -0,0 +1,12 @@ +======= +fvp-v8r +======= + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm64/imx8/imx8qm-mek/README.txt b/Documentation/platforms/arm64/imx8/boards/imx8qm-mek/README.txt similarity index 100% rename from boards/arm64/imx8/imx8qm-mek/README.txt rename to Documentation/platforms/arm64/imx8/boards/imx8qm-mek/README.txt diff --git a/Documentation/platforms/arm64/imx8/boards/imx8qm-mek/index.rst b/Documentation/platforms/arm64/imx8/boards/imx8qm-mek/index.rst new file mode 100644 index 00000000000..aa993fd87d1 --- /dev/null +++ b/Documentation/platforms/arm64/imx8/boards/imx8qm-mek/index.rst @@ -0,0 +1,6 @@ +========== +imx8qm-mek +========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/arm64/imx8/index.rst b/Documentation/platforms/arm64/imx8/index.rst new file mode 100644 index 00000000000..389444ea370 --- /dev/null +++ b/Documentation/platforms/arm64/imx8/index.rst @@ -0,0 +1,12 @@ +========= +NXP i.MX8 +========= + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/arm64/qemu/qemu-armv8a/README.txt b/Documentation/platforms/arm64/qemu/boards/qemu-armv8a/README.txt similarity index 100% rename from boards/arm64/qemu/qemu-armv8a/README.txt rename to Documentation/platforms/arm64/qemu/boards/qemu-armv8a/README.txt diff --git a/Documentation/platforms/arm64/qemu/boards/qemu-armv8a/index.rst b/Documentation/platforms/arm64/qemu/boards/qemu-armv8a/index.rst new file mode 100644 index 00000000000..ada3e678ed9 --- /dev/null +++ b/Documentation/platforms/arm64/qemu/boards/qemu-armv8a/index.rst @@ -0,0 +1,6 @@ +=========== +qemu-armv8a +=========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/arm64/qemu/index.rst b/Documentation/platforms/arm64/qemu/index.rst new file mode 100644 index 00000000000..ed5c3e0287e --- /dev/null +++ b/Documentation/platforms/arm64/qemu/index.rst @@ -0,0 +1,12 @@ +==== +qemu +==== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/arm64/rk3399/boards/nanopi_m4/index.rst b/Documentation/platforms/arm64/rk3399/boards/nanopi_m4/index.rst new file mode 100644 index 00000000000..2f35889a83f --- /dev/null +++ b/Documentation/platforms/arm64/rk3399/boards/nanopi_m4/index.rst @@ -0,0 +1,3 @@ +========= +nanopi_m4 +========= diff --git a/Documentation/platforms/arm64/rk3399/boards/pinephonepro/index.rst b/Documentation/platforms/arm64/rk3399/boards/pinephonepro/index.rst new file mode 100644 index 00000000000..8b86dda58fc --- /dev/null +++ b/Documentation/platforms/arm64/rk3399/boards/pinephonepro/index.rst @@ -0,0 +1,3 @@ +============ +pinephonepro +============ diff --git a/Documentation/platforms/arm64/rk3399/index.rst b/Documentation/platforms/arm64/rk3399/index.rst new file mode 100644 index 00000000000..2b78883f558 --- /dev/null +++ b/Documentation/platforms/arm64/rk3399/index.rst @@ -0,0 +1,12 @@ +=============== +Rockchip rk3399 +=============== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/avr/at32uc3/avr32dev1/README.txt b/Documentation/platforms/avr/at32uc3/boards/avr32dev1/README.txt similarity index 100% rename from boards/avr/at32uc3/avr32dev1/README.txt rename to Documentation/platforms/avr/at32uc3/boards/avr32dev1/README.txt diff --git a/Documentation/platforms/avr/at32uc3/boards/avr32dev1/index.rst b/Documentation/platforms/avr/at32uc3/boards/avr32dev1/index.rst new file mode 100644 index 00000000000..c6856400f76 --- /dev/null +++ b/Documentation/platforms/avr/at32uc3/boards/avr32dev1/index.rst @@ -0,0 +1,10 @@ +========= +avr32dev1 +========= + +This is a port of NuttX to the Atmel AVR32DEV1 board. That board is +based on the Atmel AT32UC3B0256 MCU and uses a specially patched +version of the GNU toolchain: The patches provide support for the +AVR32 family. That patched GNU toolchain is available only from the +Atmel website. STATUS: This port is functional but very basic. There +are configurations for NSH and the OS test. diff --git a/Documentation/platforms/avr/at32uc3/index.rst b/Documentation/platforms/avr/at32uc3/index.rst index 6f6bc8340a1..d5fd061275e 100644 --- a/Documentation/platforms/avr/at32uc3/index.rst +++ b/Documentation/platforms/avr/at32uc3/index.rst @@ -31,3 +31,11 @@ NuttX board `README `__ file for further information. +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/avr/at90usb/micropendous3/README.txt b/Documentation/platforms/avr/at90usb/boards/micropendous3/README.txt similarity index 100% rename from boards/avr/at90usb/micropendous3/README.txt rename to Documentation/platforms/avr/at90usb/boards/micropendous3/README.txt diff --git a/Documentation/platforms/avr/at90usb/boards/micropendous3/index.rst b/Documentation/platforms/avr/at90usb/boards/micropendous3/index.rst new file mode 100644 index 00000000000..18742ba3cbc --- /dev/null +++ b/Documentation/platforms/avr/at90usb/boards/micropendous3/index.rst @@ -0,0 +1,6 @@ +============= +micropendous3 +============= + +.. include:: README.txt + :literal: diff --git a/boards/avr/at90usb/teensy-2.0/README.txt b/Documentation/platforms/avr/at90usb/boards/teensy-2.0/README.txt similarity index 100% rename from boards/avr/at90usb/teensy-2.0/README.txt rename to Documentation/platforms/avr/at90usb/boards/teensy-2.0/README.txt diff --git a/Documentation/platforms/avr/at90usb/boards/teensy-2.0/index.rst b/Documentation/platforms/avr/at90usb/boards/teensy-2.0/index.rst new file mode 100644 index 00000000000..e0d9eb32590 --- /dev/null +++ b/Documentation/platforms/avr/at90usb/boards/teensy-2.0/index.rst @@ -0,0 +1,6 @@ +========== +teensy-2.0 +========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/avr/at90usb/index.rst b/Documentation/platforms/avr/at90usb/index.rst index 085fd5a2d6c..02d6554a6fd 100644 --- a/Documentation/platforms/avr/at90usb/index.rst +++ b/Documentation/platforms/avr/at90usb/index.rst @@ -1,6 +1,6 @@ -=========== -AVR AT90USB -=========== +================= +Microchip AT90USB +================= AVR AT90USB64x and AT90USB6128x ------------------------------- @@ -44,3 +44,12 @@ performed using the NuttX DIY toolchain for Linux or Cygwin is provided by the NuttX `buildroot `__ package. As a result, that toolchain is recommended. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/avr/atmega/amber/README.txt b/Documentation/platforms/avr/atmega/boards/amber/README.txt similarity index 100% rename from boards/avr/atmega/amber/README.txt rename to Documentation/platforms/avr/atmega/boards/amber/README.txt diff --git a/Documentation/platforms/avr/atmega/boards/amber/index.rst b/Documentation/platforms/avr/atmega/boards/amber/index.rst new file mode 100644 index 00000000000..1692af54ec4 --- /dev/null +++ b/Documentation/platforms/avr/atmega/boards/amber/index.rst @@ -0,0 +1,10 @@ +===== +amber +===== + +This is placeholder for the SoC Robotics Amber Web Server that is based +on the Atmel AVR ATMega128 MCU. There is not much there yet and what is +there is untested due to tool-related issues. + +.. include:: README.txt + :literal: diff --git a/boards/avr/atmega/arduino-mega2560/README.txt b/Documentation/platforms/avr/atmega/boards/arduino-mega2560/README.txt similarity index 100% rename from boards/avr/atmega/arduino-mega2560/README.txt rename to Documentation/platforms/avr/atmega/boards/arduino-mega2560/README.txt diff --git a/boards/avr/atmega/moteino-mega/README.txt b/Documentation/platforms/avr/atmega/boards/moteino-mega/README.txt similarity index 100% rename from boards/avr/atmega/moteino-mega/README.txt rename to Documentation/platforms/avr/atmega/boards/moteino-mega/README.txt diff --git a/Documentation/platforms/avr/atmega/index.rst b/Documentation/platforms/avr/atmega/index.rst index c098ba9421d..8151414c5ef 100644 --- a/Documentation/platforms/avr/atmega/index.rst +++ b/Documentation/platforms/avr/atmega/index.rst @@ -1,6 +1,6 @@ -====== -Atmega -====== +================ +Microchip Atmega +================ ATMega128 --------- diff --git a/boards/hc/m9s12/demo9s12ne64/README.txt b/Documentation/platforms/hc/m9s12/boards/demo9s12ne64/README.txt similarity index 100% rename from boards/hc/m9s12/demo9s12ne64/README.txt rename to Documentation/platforms/hc/m9s12/boards/demo9s12ne64/README.txt diff --git a/Documentation/platforms/hc/m9s12/boards/demo9s12ne64/index.rst b/Documentation/platforms/hc/m9s12/boards/demo9s12ne64/index.rst new file mode 100644 index 00000000000..9d2a69cb457 --- /dev/null +++ b/Documentation/platforms/hc/m9s12/boards/demo9s12ne64/index.rst @@ -0,0 +1,6 @@ +============ +demo9s12ne64 +============ + +.. include:: README.txt + :literal: diff --git a/boards/hc/m9s12/ne64badge/README.txt b/Documentation/platforms/hc/m9s12/boards/ne64badge/README.txt similarity index 100% rename from boards/hc/m9s12/ne64badge/README.txt rename to Documentation/platforms/hc/m9s12/boards/ne64badge/README.txt diff --git a/Documentation/platforms/hc/m9s12/boards/ne64badge/index.rst b/Documentation/platforms/hc/m9s12/boards/ne64badge/index.rst new file mode 100644 index 00000000000..d9403b56f61 --- /dev/null +++ b/Documentation/platforms/hc/m9s12/boards/ne64badge/index.rst @@ -0,0 +1,6 @@ +========= +ne64badge +========= + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/hc/m9s12/index.rst b/Documentation/platforms/hc/m9s12/index.rst index fbac08789ca..4b3c42c5c15 100644 --- a/Documentation/platforms/hc/m9s12/index.rst +++ b/Documentation/platforms/hc/m9s12/index.rst @@ -15,3 +15,12 @@ Both use a GNU arm-nuttx-elf toolchain\* under Linux or Cygwin. The NuttX `buildroot `__ provides a properly patched GCC 3.4.4 toolchain that is highly optimized for the m9s12x family. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/mips/pic32mx/mirtoo/README.txt b/Documentation/platforms/mips/pic32mx/boards/mirtoo/README.txt similarity index 100% rename from boards/mips/pic32mx/mirtoo/README.txt rename to Documentation/platforms/mips/pic32mx/boards/mirtoo/README.txt diff --git a/Documentation/platforms/mips/pic32mx/boards/mirtoo/index.rst b/Documentation/platforms/mips/pic32mx/boards/mirtoo/index.rst new file mode 100644 index 00000000000..fda076ba3d2 --- /dev/null +++ b/Documentation/platforms/mips/pic32mx/boards/mirtoo/index.rst @@ -0,0 +1,7 @@ +====== +mirtoo +====== + +.. include:: README.txt + :literal: + diff --git a/boards/mips/pic32mx/pic32mx-starterkit/README.txt b/Documentation/platforms/mips/pic32mx/boards/pic32mx-starterkit/README.txt similarity index 100% rename from boards/mips/pic32mx/pic32mx-starterkit/README.txt rename to Documentation/platforms/mips/pic32mx/boards/pic32mx-starterkit/README.txt diff --git a/Documentation/platforms/mips/pic32mx/boards/pic32mx-starterkit/index.rst b/Documentation/platforms/mips/pic32mx/boards/pic32mx-starterkit/index.rst new file mode 100644 index 00000000000..b13da335051 --- /dev/null +++ b/Documentation/platforms/mips/pic32mx/boards/pic32mx-starterkit/index.rst @@ -0,0 +1,7 @@ +================== +pic32mx-starterkit +================== + +.. include:: README.txt + :literal: + diff --git a/boards/mips/pic32mx/pic32mx7mmb/README.txt b/Documentation/platforms/mips/pic32mx/boards/pic32mx7mmb/README.txt similarity index 100% rename from boards/mips/pic32mx/pic32mx7mmb/README.txt rename to Documentation/platforms/mips/pic32mx/boards/pic32mx7mmb/README.txt diff --git a/Documentation/platforms/mips/pic32mx/boards/pic32mx7mmb/index.rst b/Documentation/platforms/mips/pic32mx/boards/pic32mx7mmb/index.rst new file mode 100644 index 00000000000..1b84e482132 --- /dev/null +++ b/Documentation/platforms/mips/pic32mx/boards/pic32mx7mmb/index.rst @@ -0,0 +1,7 @@ +=========== +pic32mx7mmb +=========== + +.. include:: README.txt + :literal: + diff --git a/boards/mips/pic32mx/sure-pic32mx/README.txt b/Documentation/platforms/mips/pic32mx/boards/sure-pic32mx/README.txt similarity index 100% rename from boards/mips/pic32mx/sure-pic32mx/README.txt rename to Documentation/platforms/mips/pic32mx/boards/sure-pic32mx/README.txt diff --git a/Documentation/platforms/mips/pic32mx/boards/sure-pic32mx/index.rst b/Documentation/platforms/mips/pic32mx/boards/sure-pic32mx/index.rst new file mode 100644 index 00000000000..d5e1bb586c4 --- /dev/null +++ b/Documentation/platforms/mips/pic32mx/boards/sure-pic32mx/index.rst @@ -0,0 +1,7 @@ +============ +sure-pic32mx +============ + +.. include:: README.txt + :literal: + diff --git a/boards/mips/pic32mx/ubw32/README.txt b/Documentation/platforms/mips/pic32mx/boards/ubw32/README.txt similarity index 100% rename from boards/mips/pic32mx/ubw32/README.txt rename to Documentation/platforms/mips/pic32mx/boards/ubw32/README.txt diff --git a/Documentation/platforms/mips/pic32mx/boards/ubw32/index.rst b/Documentation/platforms/mips/pic32mx/boards/ubw32/index.rst new file mode 100644 index 00000000000..fa05bc912c2 --- /dev/null +++ b/Documentation/platforms/mips/pic32mx/boards/ubw32/index.rst @@ -0,0 +1,7 @@ +===== +ubw32 +===== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/mips/pic32mx/index.rst b/Documentation/platforms/mips/pic32mx/index.rst index eff96328ae1..db247694417 100644 --- a/Documentation/platforms/mips/pic32mx/index.rst +++ b/Documentation/platforms/mips/pic32mx/index.rst @@ -57,3 +57,12 @@ PIC32MX795F512L. There one two board ports using this chip: `website `__. #. The MIPS SDE toolchain available from the `Mentor Graphics `__ website. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/mips/pic32mz/chipkit-wifire/README.txt b/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/README.txt similarity index 100% rename from boards/mips/pic32mz/chipkit-wifire/README.txt rename to Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/README.txt diff --git a/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst b/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst new file mode 100644 index 00000000000..1609295a6d3 --- /dev/null +++ b/Documentation/platforms/mips/pic32mz/boards/chipkit-wifire/index.rst @@ -0,0 +1,8 @@ +============== +chipkit-wifire +============== + +.. include:: README.txt + :literal: + + diff --git a/boards/mips/pic32mz/flipnclick-pic32mz/README.txt b/Documentation/platforms/mips/pic32mz/boards/flipnclick-pic32mz/README.txt similarity index 99% rename from boards/mips/pic32mz/flipnclick-pic32mz/README.txt rename to Documentation/platforms/mips/pic32mz/boards/flipnclick-pic32mz/README.txt index d6a2dcdc5d1..529a83e7860 100644 --- a/boards/mips/pic32mz/flipnclick-pic32mz/README.txt +++ b/Documentation/platforms/mips/pic32mz/boards/flipnclick-pic32mz/README.txt @@ -439,3 +439,4 @@ Where is one of the following: the Flip&Click SAM3X and got the same result. There could be SPI issues on the PIC32MX, but more likely that there is an error in my custom HiletGo Click. Damn! + diff --git a/Documentation/platforms/mips/pic32mz/boards/flipnclick-pic32mz/index.rst b/Documentation/platforms/mips/pic32mz/boards/flipnclick-pic32mz/index.rst new file mode 100644 index 00000000000..956e7d3b803 --- /dev/null +++ b/Documentation/platforms/mips/pic32mz/boards/flipnclick-pic32mz/index.rst @@ -0,0 +1,7 @@ +================== +flipnclick-pic32mz +================== + +.. include:: README.txt + :literal: + diff --git a/boards/mips/pic32mz/pic32mz-starterkit/README.txt b/Documentation/platforms/mips/pic32mz/boards/pic32mz-starterkit/README.txt similarity index 100% rename from boards/mips/pic32mz/pic32mz-starterkit/README.txt rename to Documentation/platforms/mips/pic32mz/boards/pic32mz-starterkit/README.txt diff --git a/Documentation/platforms/mips/pic32mz/boards/pic32mz-starterkit/index.rst b/Documentation/platforms/mips/pic32mz/boards/pic32mz-starterkit/index.rst new file mode 100644 index 00000000000..a702117e0b2 --- /dev/null +++ b/Documentation/platforms/mips/pic32mz/boards/pic32mz-starterkit/index.rst @@ -0,0 +1,8 @@ +================== +pic32mz-starterkit +================== + +.. include:: README.txt + :literal: + + diff --git a/Documentation/platforms/mips/pic32mz/index.rst b/Documentation/platforms/mips/pic32mz/index.rst index 7836daaa5c2..959434c40e3 100644 --- a/Documentation/platforms/mips/pic32mz/index.rst +++ b/Documentation/platforms/mips/pic32mz/index.rst @@ -59,3 +59,12 @@ information. This was a collaborative effort between Kristopher Tate, David Sidrane and myself. The basic port is functional and a NuttShell (NSH) configuration is available. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/misco/index.rst b/Documentation/platforms/misco/index.rst index 7e736409f30..c3e7b4bfda7 100644 --- a/Documentation/platforms/misco/index.rst +++ b/Documentation/platforms/misco/index.rst @@ -1,3 +1,4 @@ +===== Misoc ===== diff --git a/boards/misoc/lm32/misoc/README.txt b/Documentation/platforms/misco/lm32/boards/misoc/README.txt similarity index 100% rename from boards/misoc/lm32/misoc/README.txt rename to Documentation/platforms/misco/lm32/boards/misoc/README.txt diff --git a/Documentation/platforms/misco/lm32/boards/misoc/index.rst b/Documentation/platforms/misco/lm32/boards/misoc/index.rst new file mode 100644 index 00000000000..0315364dee9 --- /dev/null +++ b/Documentation/platforms/misco/lm32/boards/misoc/index.rst @@ -0,0 +1,7 @@ +===== +misoc +===== + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/misco/lm32/index.rst b/Documentation/platforms/misco/lm32/index.rst index 0b074c88fff..dfcbd2ed68c 100644 --- a/Documentation/platforms/misco/lm32/index.rst +++ b/Documentation/platforms/misco/lm32/index.rst @@ -1,3 +1,4 @@ +========== Misoc LM32 ========== @@ -10,3 +11,12 @@ Ramtin Amin in NuttX 7.29. **Drivers**. Driver support is basic in these initial releases: Serial, Timer, and Ethernet. "Board" support is a available for developing with Misoc LM32 under Qemu or on your custom FPGA. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/or1k/mor1kx/or1k/README.txt b/Documentation/platforms/or1k/mor1kx/boards/or1k/README.txt similarity index 100% rename from boards/or1k/mor1kx/or1k/README.txt rename to Documentation/platforms/or1k/mor1kx/boards/or1k/README.txt diff --git a/Documentation/platforms/or1k/mor1kx/boards/or1k/index.rst b/Documentation/platforms/or1k/mor1kx/boards/or1k/index.rst new file mode 100644 index 00000000000..2381532f164 --- /dev/null +++ b/Documentation/platforms/or1k/mor1kx/boards/or1k/index.rst @@ -0,0 +1,5 @@ +==== +or1k +==== + +Generic OpenRISC board. diff --git a/Documentation/platforms/or1k/mor1kx/index.rst b/Documentation/platforms/or1k/mor1kx/index.rst index c6d93b37f6e..3f2d0d5acd5 100644 --- a/Documentation/platforms/or1k/mor1kx/index.rst +++ b/Documentation/platforms/or1k/mor1kx/index.rst @@ -6,3 +6,12 @@ OpenRISC mor1kx OpenRISC mor1kx was developed by Matt Thompson Amin and released in NuttX 7.25. Currently only an mor1kx Qemu simulation is available for testing. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/renesas/m16c/skp16c26/README.txt b/Documentation/platforms/renesas/m16c/boards/skp16c26/README.txt similarity index 100% rename from boards/renesas/m16c/skp16c26/README.txt rename to Documentation/platforms/renesas/m16c/boards/skp16c26/README.txt diff --git a/Documentation/platforms/renesas/m16c/boards/skp16c26/index.rst b/Documentation/platforms/renesas/m16c/boards/skp16c26/index.rst new file mode 100644 index 00000000000..deee0d130a9 --- /dev/null +++ b/Documentation/platforms/renesas/m16c/boards/skp16c26/index.rst @@ -0,0 +1,6 @@ +======== +SKP16C26 +======== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/renesas/m16c/index.rst b/Documentation/platforms/renesas/m16c/index.rst index d68b4d410b4..3ca099c79a9 100644 --- a/Documentation/platforms/renesas/m16c/index.rst +++ b/Documentation/platforms/renesas/m16c/index.rst @@ -16,3 +16,12 @@ No workaround is known at this time. This is a show stopper for M16C. Refer to the NuttX board `README `__ file for further information. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/renesas/rx65n/rx65n-grrose/README.txt b/Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/README.txt similarity index 100% rename from boards/renesas/rx65n/rx65n-grrose/README.txt rename to Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/README.txt diff --git a/boards/renesas/rx65n/rx65n-grrose/include/README.TXT b/Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/ROMFS.txt similarity index 100% rename from boards/renesas/rx65n/rx65n-grrose/include/README.TXT rename to Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/ROMFS.txt diff --git a/Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/index.rst b/Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/index.rst new file mode 100644 index 00000000000..ed2dbac37df --- /dev/null +++ b/Documentation/platforms/renesas/rx65n/boards/rx65n-grrose/index.rst @@ -0,0 +1,9 @@ +============ +RX65N GRROSE +============ + +.. include:: README.txt + :literal: + +.. include:: ROMFS.txt + :literal: diff --git a/boards/renesas/rx65n/rx65n-rsk2mb/README.txt b/Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/README.txt similarity index 100% rename from boards/renesas/rx65n/rx65n-rsk2mb/README.txt rename to Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/README.txt diff --git a/boards/renesas/rx65n/rx65n-rsk2mb/include/README.TXT b/Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/ROMFS.txt similarity index 100% rename from boards/renesas/rx65n/rx65n-rsk2mb/include/README.TXT rename to Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/ROMFS.txt diff --git a/Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/index.rst b/Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/index.rst new file mode 100644 index 00000000000..245a4d69e90 --- /dev/null +++ b/Documentation/platforms/renesas/rx65n/boards/rx65n-rsk2mb/index.rst @@ -0,0 +1,9 @@ +============ +RX65N RSK2MB +============ + +.. include:: README.txt + :literal: + +.. include:: ROMFS.txt + :literal: diff --git a/Documentation/platforms/renesas/rx65n/index.rst b/Documentation/platforms/renesas/rx65n/index.rst index d7ffbf12c6f..7367edb68fd 100644 --- a/Documentation/platforms/renesas/rx65n/index.rst +++ b/Documentation/platforms/renesas/rx65n/index.rst @@ -13,3 +13,12 @@ release: - **NuttX-8.2** - **NuttX-9.0** RTC driver for the RX65N was added. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/renesas/sh1/us7032evb1/README.txt b/Documentation/platforms/renesas/sh1/boards/us7032evb1/README.txt similarity index 100% rename from boards/renesas/sh1/us7032evb1/README.txt rename to Documentation/platforms/renesas/sh1/boards/us7032evb1/README.txt diff --git a/Documentation/platforms/renesas/sh1/boards/us7032evb1/index.rst b/Documentation/platforms/renesas/sh1/boards/us7032evb1/index.rst new file mode 100644 index 00000000000..a809d53bed1 --- /dev/null +++ b/Documentation/platforms/renesas/sh1/boards/us7032evb1/index.rst @@ -0,0 +1,6 @@ +========== +US7032EVB1 +========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/renesas/sh1/index.rst b/Documentation/platforms/renesas/sh1/index.rst index 6e040d8aecd..793fd20f52d 100644 --- a/Documentation/platforms/renesas/sh1/index.rst +++ b/Documentation/platforms/renesas/sh1/index.rst @@ -5,3 +5,12 @@ Renesas SH-1 **SH-1 SH7032**. This port uses the Hitachi SH-1 Low-Cost Evaluation Board (SH1_LCEVB1), US7032EVB, with a GNU ELF toolchain\* under Linux or Cygwin. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/risc-v/bl602/boards/bl602evb/index.rst b/Documentation/platforms/risc-v/bl602/boards/bl602evb/index.rst new file mode 100644 index 00000000000..8d99ad135bc --- /dev/null +++ b/Documentation/platforms/risc-v/bl602/boards/bl602evb/index.rst @@ -0,0 +1,3 @@ +======== +bl602evb +======== diff --git a/Documentation/platforms/risc-v/bl602/index.rst b/Documentation/platforms/risc-v/bl602/index.rst index 5a2e8f32479..79b26ebdf3d 100644 --- a/Documentation/platforms/risc-v/bl602/index.rst +++ b/Documentation/platforms/risc-v/bl602/index.rst @@ -212,3 +212,12 @@ LED_PWM No SHA No RSA No ========== ======= ===== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/risc-v/c906/smartl-c906/README-qemu.txt b/Documentation/platforms/risc-v/c906/boards/smartl-c906/README-qemu.txt similarity index 100% rename from boards/risc-v/c906/smartl-c906/README-qemu.txt rename to Documentation/platforms/risc-v/c906/boards/smartl-c906/README-qemu.txt diff --git a/boards/risc-v/c906/smartl-c906/README.txt b/Documentation/platforms/risc-v/c906/boards/smartl-c906/README.txt similarity index 100% rename from boards/risc-v/c906/smartl-c906/README.txt rename to Documentation/platforms/risc-v/c906/boards/smartl-c906/README.txt diff --git a/Documentation/platforms/risc-v/c906/boards/smartl-c906/index.rst b/Documentation/platforms/risc-v/c906/boards/smartl-c906/index.rst new file mode 100644 index 00000000000..c0e9cd01095 --- /dev/null +++ b/Documentation/platforms/risc-v/c906/boards/smartl-c906/index.rst @@ -0,0 +1,9 @@ +=========== +smartl-c906 +=========== + +.. include:: README.txt + :literal: + +.. include:: README-qemu.txt + :literal: diff --git a/Documentation/platforms/risc-v/c906/index.rst b/Documentation/platforms/risc-v/c906/index.rst index 6566a514709..09f8a9d1198 100644 --- a/Documentation/platforms/risc-v/c906/index.rst +++ b/Documentation/platforms/risc-v/c906/index.rst @@ -1,3 +1,12 @@ ========== THEAD C906 ========== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/risc-v/esp32c3/esp32c3-devkit-rust-1/README.txt b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit-rust-1/README.txt similarity index 100% rename from boards/risc-v/esp32c3/esp32c3-devkit-rust-1/README.txt rename to Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit-rust-1/README.txt diff --git a/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit-rust-1/index.rst b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit-rust-1/index.rst new file mode 100644 index 00000000000..77608e05c8b --- /dev/null +++ b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit-rust-1/index.rst @@ -0,0 +1,6 @@ +===================== +esp32c3-devkit-rust-1 +===================== + +.. include:: README.txt + :literal: diff --git a/boards/risc-v/esp32c3/esp32c3-devkit/src/README.txt b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/ROMFS.txt similarity index 100% rename from boards/risc-v/esp32c3/esp32c3-devkit/src/README.txt rename to Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/ROMFS.txt diff --git a/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/index.rst b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/index.rst index fe3caa039f9..cf0116329c7 100644 --- a/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/index.rst +++ b/Documentation/platforms/risc-v/esp32c3/boards/esp32c3-devkit/index.rst @@ -538,3 +538,10 @@ at runtime:: nsh> wapi psk wlan0 mypasswd 3 nsh> wapi essid wlan0 myssid 1 nsh> renew wlan0 + + +ROMFS.txt +========= + +.. include:: ROMFS.txt + :literal: diff --git a/boards/risc-v/fe310/hifive1-revb/README-qemu.txt b/Documentation/platforms/risc-v/fe310/boards/hifive1-revb/README-qemu.txt similarity index 100% rename from boards/risc-v/fe310/hifive1-revb/README-qemu.txt rename to Documentation/platforms/risc-v/fe310/boards/hifive1-revb/README-qemu.txt diff --git a/boards/risc-v/fe310/hifive1-revb/README.txt b/Documentation/platforms/risc-v/fe310/boards/hifive1-revb/README.txt similarity index 100% rename from boards/risc-v/fe310/hifive1-revb/README.txt rename to Documentation/platforms/risc-v/fe310/boards/hifive1-revb/README.txt diff --git a/Documentation/platforms/risc-v/fe310/boards/hifive1-revb/index.rst b/Documentation/platforms/risc-v/fe310/boards/hifive1-revb/index.rst new file mode 100644 index 00000000000..4e49d42af4e --- /dev/null +++ b/Documentation/platforms/risc-v/fe310/boards/hifive1-revb/index.rst @@ -0,0 +1,9 @@ +============ +hifive1-revb +============ + +.. include:: README.txt + :literal: + +.. include:: README-qemu.txt + :literal: diff --git a/Documentation/platforms/risc-v/fe310/index.rst b/Documentation/platforms/risc-v/fe310/index.rst new file mode 100644 index 00000000000..b16b549f19c --- /dev/null +++ b/Documentation/platforms/risc-v/fe310/index.rst @@ -0,0 +1,12 @@ +============ +SiFive FE310 +============ + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/risc-v/hpm6750/hpm6750evk2/README.txt b/Documentation/platforms/risc-v/hpm6750/boards/hpm6750evk2/README.txt similarity index 100% rename from boards/risc-v/hpm6750/hpm6750evk2/README.txt rename to Documentation/platforms/risc-v/hpm6750/boards/hpm6750evk2/README.txt diff --git a/Documentation/platforms/risc-v/hpm6750/boards/hpm6750evk2/index.rst b/Documentation/platforms/risc-v/hpm6750/boards/hpm6750evk2/index.rst new file mode 100644 index 00000000000..cc7e7bd14a9 --- /dev/null +++ b/Documentation/platforms/risc-v/hpm6750/boards/hpm6750evk2/index.rst @@ -0,0 +1,6 @@ +=========== +hpm6750evk2 +=========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/risc-v/hpm6750/index.rst b/Documentation/platforms/risc-v/hpm6750/index.rst index 1c67b6cb9b9..dc99f71ca4e 100644 --- a/Documentation/platforms/risc-v/hpm6750/index.rst +++ b/Documentation/platforms/risc-v/hpm6750/index.rst @@ -1,3 +1,12 @@ =============== Hpmicro HPM6750 =============== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/risc-v/k210/maix-bit/README-qemu.txt b/Documentation/platforms/risc-v/k210/boards/maix-bit/README-qemu.txt similarity index 100% rename from boards/risc-v/k210/maix-bit/README-qemu.txt rename to Documentation/platforms/risc-v/k210/boards/maix-bit/README-qemu.txt diff --git a/boards/risc-v/k210/maix-bit/README.txt b/Documentation/platforms/risc-v/k210/boards/maix-bit/README.txt similarity index 100% rename from boards/risc-v/k210/maix-bit/README.txt rename to Documentation/platforms/risc-v/k210/boards/maix-bit/README.txt diff --git a/Documentation/platforms/risc-v/k210/boards/maix-bit/index.rst b/Documentation/platforms/risc-v/k210/boards/maix-bit/index.rst new file mode 100644 index 00000000000..fbc248a3783 --- /dev/null +++ b/Documentation/platforms/risc-v/k210/boards/maix-bit/index.rst @@ -0,0 +1,9 @@ +======== +maix-bit +======== + +.. include:: README.txt + :literal: + +.. include:: README-qemu.txt + :literal: diff --git a/Documentation/platforms/risc-v/k210/index.rst b/Documentation/platforms/risc-v/k210/index.rst index 1bee6ab39cd..f769049b810 100644 --- a/Documentation/platforms/risc-v/k210/index.rst +++ b/Documentation/platforms/risc-v/k210/index.rst @@ -1,3 +1,12 @@ ============= Kendryte K210 ============= + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/risc-v/litex/arty_a7/README.txt b/Documentation/platforms/risc-v/litex/boards/arty_a7/README.txt similarity index 100% rename from boards/risc-v/litex/arty_a7/README.txt rename to Documentation/platforms/risc-v/litex/boards/arty_a7/README.txt diff --git a/Documentation/platforms/risc-v/litex/boards/arty_a7/index.rst b/Documentation/platforms/risc-v/litex/boards/arty_a7/index.rst new file mode 100644 index 00000000000..9c793ea98a5 --- /dev/null +++ b/Documentation/platforms/risc-v/litex/boards/arty_a7/index.rst @@ -0,0 +1,6 @@ +======= +arty_a7 +======= + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/risc-v/litex/index.rst b/Documentation/platforms/risc-v/litex/index.rst index f17a8a79dc6..939d8257c4d 100644 --- a/Documentation/platforms/risc-v/litex/index.rst +++ b/Documentation/platforms/risc-v/litex/index.rst @@ -68,3 +68,11 @@ Core specific information cores/*/* +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/risc-v/qemu-rv/rv-virt/README.txt b/Documentation/platforms/risc-v/qemu-rv/boards/rv-virt/README.txt similarity index 100% rename from boards/risc-v/qemu-rv/rv-virt/README.txt rename to Documentation/platforms/risc-v/qemu-rv/boards/rv-virt/README.txt diff --git a/Documentation/platforms/risc-v/qemu-rv/boards/rv-virt/index.rst b/Documentation/platforms/risc-v/qemu-rv/boards/rv-virt/index.rst new file mode 100644 index 00000000000..32ced5adb67 --- /dev/null +++ b/Documentation/platforms/risc-v/qemu-rv/boards/rv-virt/index.rst @@ -0,0 +1,6 @@ +======= +rv-virt +======= + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/risc-v/qemu-rv/index.rst b/Documentation/platforms/risc-v/qemu-rv/index.rst new file mode 100644 index 00000000000..d41883e3c6f --- /dev/null +++ b/Documentation/platforms/risc-v/qemu-rv/index.rst @@ -0,0 +1,12 @@ +====================== +QEMU Generic RV32/RV64 +====================== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/risc-v/qemu/index.rst b/Documentation/platforms/risc-v/qemu/index.rst deleted file mode 100644 index d27adccb5a1..00000000000 --- a/Documentation/platforms/risc-v/qemu/index.rst +++ /dev/null @@ -1,3 +0,0 @@ -====================== -QEMU Generic RV32/RV64 -====================== diff --git a/boards/risc-v/rv32m1/rv32m1-vega/README.txt b/Documentation/platforms/risc-v/rv32m1/boards/rv32m1-vega/README.txt similarity index 100% rename from boards/risc-v/rv32m1/rv32m1-vega/README.txt rename to Documentation/platforms/risc-v/rv32m1/boards/rv32m1-vega/README.txt diff --git a/Documentation/platforms/risc-v/rv32m1/boards/rv32m1-vega/index.rst b/Documentation/platforms/risc-v/rv32m1/boards/rv32m1-vega/index.rst new file mode 100644 index 00000000000..755c2f72731 --- /dev/null +++ b/Documentation/platforms/risc-v/rv32m1/boards/rv32m1-vega/index.rst @@ -0,0 +1,6 @@ +=========== +rv32m1-vega +=========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/risc-v/rv32m1/index.rst b/Documentation/platforms/risc-v/rv32m1/index.rst index 8ad07ac3538..840aa7b08fd 100644 --- a/Documentation/platforms/risc-v/rv32m1/index.rst +++ b/Documentation/platforms/risc-v/rv32m1/index.rst @@ -1,3 +1,12 @@ ========== NXP RV32M1 ========== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/sim/sim/sim/src/README.txt b/Documentation/platforms/sim/sim/boards/sim/README.txt similarity index 100% rename from boards/sim/sim/sim/src/README.txt rename to Documentation/platforms/sim/sim/boards/sim/README.txt diff --git a/Documentation/platforms/sim/sim/boards/sim/index.rst b/Documentation/platforms/sim/sim/boards/sim/index.rst index bff5f4b69bb..f40c07f25fc 100644 --- a/Documentation/platforms/sim/sim/boards/sim/index.rst +++ b/Documentation/platforms/sim/sim/boards/sim/index.rst @@ -1776,3 +1776,10 @@ This is a configuration with sim usbhost support. Run sim usbhost with root mode, run sim usbdev or plug-in cdcacm usb device. Then you can use /dev/ttyACM to transfer data. + + +README.txt +========== + +.. include:: README.txt + :literal: diff --git a/Documentation/platforms/sparc/bm3803/boards/xx3803/index.rst b/Documentation/platforms/sparc/bm3803/boards/xx3803/index.rst new file mode 100644 index 00000000000..94cbbea4cf0 --- /dev/null +++ b/Documentation/platforms/sparc/bm3803/boards/xx3803/index.rst @@ -0,0 +1,4 @@ +====== +xx3803 +====== + diff --git a/Documentation/platforms/sparc/bm3803/index.rst b/Documentation/platforms/sparc/bm3803/index.rst index 74d785f6330..a7abe38f6d7 100644 --- a/Documentation/platforms/sparc/bm3803/index.rst +++ b/Documentation/platforms/sparc/bm3803/index.rst @@ -1,2 +1,12 @@ +====== BM3803 ====== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/sparc/bm3823/boards/xx3823/index.rst b/Documentation/platforms/sparc/bm3823/boards/xx3823/index.rst new file mode 100644 index 00000000000..d98eea0ff6d --- /dev/null +++ b/Documentation/platforms/sparc/bm3823/boards/xx3823/index.rst @@ -0,0 +1,4 @@ +====== +xx3823 +====== + diff --git a/Documentation/platforms/sparc/bm3823/index.rst b/Documentation/platforms/sparc/bm3823/index.rst index 62c0f069f75..4f2e5e27f43 100644 --- a/Documentation/platforms/sparc/bm3823/index.rst +++ b/Documentation/platforms/sparc/bm3823/index.rst @@ -1,2 +1,12 @@ +====== BM3823 ====== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/sparc/s698pm/boards/s698pm-dkit/index.rst b/Documentation/platforms/sparc/s698pm/boards/s698pm-dkit/index.rst new file mode 100644 index 00000000000..f507dddf04b --- /dev/null +++ b/Documentation/platforms/sparc/s698pm/boards/s698pm-dkit/index.rst @@ -0,0 +1,3 @@ +=========== +s698pm-dkit +=========== diff --git a/Documentation/platforms/sparc/s698pm/index.rst b/Documentation/platforms/sparc/s698pm/index.rst index 9c2abb5b9d3..dd4bb1ddce2 100644 --- a/Documentation/platforms/sparc/s698pm/index.rst +++ b/Documentation/platforms/sparc/s698pm/index.rst @@ -1,2 +1,12 @@ +====== S698PM ====== + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/x86/index.rst b/Documentation/platforms/x86/index.rst index c0058dc8fae..72b9ba63103 100644 --- a/Documentation/platforms/x86/index.rst +++ b/Documentation/platforms/x86/index.rst @@ -2,6 +2,35 @@ Intel 80x86 =========== +All x86 source reside in lower-level common, chip-specific, and architecture-specific +directories. + +arch/x86/src/common/ Directory +============================== + +This directory holds source files common to all x86 architectures. + +Architecture-Specific Directories +================================= + +Architecture-specific directories hold common source files shared for by +implementations of specific x86 architectures. + +``i486`` + This directory holds logic appropriate for any instantiation of the 32-bit + i486 architecture. + +Chip-Specific directories +========================= + +The same x86 architecture may be realized in different chip implementations. +For SoC chips, in particular, on-chip devices and differing interrupt +structures may require special, chip-specific definitions in these chip- +specific directories. + +``qemu`` + This is the implementation of NuttX on the QEMU x86 simulation. + .. toctree:: :maxdepth: 1 :glob: diff --git a/boards/x86/qemu/qemu-i486/README.txt b/Documentation/platforms/x86/qemu/boards/qemu-i486/README.txt similarity index 100% rename from boards/x86/qemu/qemu-i486/README.txt rename to Documentation/platforms/x86/qemu/boards/qemu-i486/README.txt diff --git a/Documentation/platforms/x86/qemu/boards/qemu-i486/index.rst b/Documentation/platforms/x86/qemu/boards/qemu-i486/index.rst new file mode 100644 index 00000000000..879df26cb0c --- /dev/null +++ b/Documentation/platforms/x86/qemu/boards/qemu-i486/index.rst @@ -0,0 +1,6 @@ +========= +qemu-i486 +========= + +Port of NuttX to QEMU in i486 mode. This port will also run on real i486 +hardware (Google the Bifferboard). diff --git a/Documentation/platforms/x86/qemu/index.rst b/Documentation/platforms/x86/qemu/index.rst index f094d986aec..7ed64378df7 100644 --- a/Documentation/platforms/x86/qemu/index.rst +++ b/Documentation/platforms/x86/qemu/index.rst @@ -16,3 +16,11 @@ x86 port! Refer to the NuttX `README `__ file for further information. +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/Documentation/platforms/x86_64/index.rst b/Documentation/platforms/x86_64/index.rst index 1e902e00835..0d07f623640 100644 --- a/Documentation/platforms/x86_64/index.rst +++ b/Documentation/platforms/x86_64/index.rst @@ -2,6 +2,35 @@ Intel 80x86_64 ============== +All x86_64 source reside in lower-level common, chip-specific, and architecture-specific +directories. + +arch/x86_64/src/common/ Directory +================================= + +This directory holds source files common to all x86_64 architectures. + +Architecture-Specific Directories +================================= + +Architecture-specific directories hold common source files shared for by +implementations of specific x86_64 architectures. + +``intel64`` + This directory holds logic appropriate for any instantiation of the 64-bit + intel64 architecture. + +Chip-Specific directories +========================= + +The same x86 architecture may be realized in different chip implementations. +For SoC chips, in particular, on-chip devices and differing interrupt +structures may require special, chip-specific definitions in these chip- +specific directories. + +``broadwell`` + This is the implementation of NuttX on the Intel Broadwell processors. + .. toctree:: :maxdepth: 1 :glob: diff --git a/boards/x86_64/intel64/qemu-intel64/README.txt b/Documentation/platforms/x86_64/qemu/boards/qemu-intel64/README.txt similarity index 100% rename from boards/x86_64/intel64/qemu-intel64/README.txt rename to Documentation/platforms/x86_64/qemu/boards/qemu-intel64/README.txt diff --git a/Documentation/platforms/x86_64/qemu/boards/qemu-intel64/index.rst b/Documentation/platforms/x86_64/qemu/boards/qemu-intel64/index.rst new file mode 100644 index 00000000000..04bcc426ceb --- /dev/null +++ b/Documentation/platforms/x86_64/qemu/boards/qemu-intel64/index.rst @@ -0,0 +1,7 @@ +============ +qemu-intel64 +============ + +.. include:: README.txt + :literal: + diff --git a/Documentation/platforms/x86_64/qemu/index.rst b/Documentation/platforms/x86_64/qemu/index.rst index 16573ac69e2..5cd096b8416 100644 --- a/Documentation/platforms/x86_64/qemu/index.rst +++ b/Documentation/platforms/x86_64/qemu/index.rst @@ -15,3 +15,12 @@ This kernel with ostest have been tested with - Qemu/KVM on a Xeon 2630v4 machine. - Bochs with broadwell_ult emulation. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/xtensa/esp32/esp32-ethernet-kit/README.txt b/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/README.txt similarity index 100% rename from boards/xtensa/esp32/esp32-ethernet-kit/README.txt rename to Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/README.txt diff --git a/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/index.rst b/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/index.rst index da8cd3dadaf..8958f56638b 100644 --- a/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/index.rst +++ b/Documentation/platforms/xtensa/esp32/boards/esp32-ethernet-kit/index.rst @@ -321,3 +321,10 @@ at runtime:: .. tip:: Please refer to :ref:`ESP32 Wi-Fi Station Mode ` for more information. + + +README.txt +========== + +.. include:: README.txt + :literal: diff --git a/boards/z16/z16f/z16f2800100zcog/README.txt b/Documentation/platforms/z16/z16f/boards/z16f2800100zcog/README.txt similarity index 100% rename from boards/z16/z16f/z16f2800100zcog/README.txt rename to Documentation/platforms/z16/z16f/boards/z16f2800100zcog/README.txt diff --git a/Documentation/platforms/z16/z16f/boards/z16f2800100zcog/index.rst b/Documentation/platforms/z16/z16f/boards/z16f2800100zcog/index.rst new file mode 100644 index 00000000000..5da99ddf883 --- /dev/null +++ b/Documentation/platforms/z16/z16f/boards/z16f2800100zcog/index.rst @@ -0,0 +1,7 @@ +=============== +z16f2800100zcog +=============== + +z16f Microcontroller. This port use the Zilog z16f2800100zcog +development kit and the Zilog ZDS-II Windows command line tools. The +development environment is Cygwin under WinXP. diff --git a/Documentation/platforms/z16/z16f/index.rst b/Documentation/platforms/z16/z16f/index.rst index 44d9d23ce95..765b8274718 100644 --- a/Documentation/platforms/z16/z16f/index.rst +++ b/Documentation/platforms/z16/z16f/index.rst @@ -14,3 +14,12 @@ work around an issue with a ZDS-II 5.0.1 tool problem). An ESPI driver was added in NuttX-7.2. Refer to the NuttX board `README `__ file for further information. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/z80/ez80/ez80f910200kitg/README.txt b/Documentation/platforms/z80/ez80/boards/ez80f910200kitg/README.txt similarity index 93% rename from boards/z80/ez80/ez80f910200kitg/README.txt rename to Documentation/platforms/z80/ez80/boards/ez80f910200kitg/README.txt index 09b3e83c5a5..aa3a6d3980b 100644 --- a/boards/z80/ez80/ez80f910200kitg/README.txt +++ b/Documentation/platforms/z80/ez80/boards/ez80f910200kitg/README.txt @@ -117,4 +117,15 @@ available: trailing bad characters are manually eliminated, then the build will succeed on the next try. -Check out any README.txt files in these s. +ostest/README.txt +^^^^^^^^^^^^^^^^^ + +ostest.zdsproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. Before using, copy the following + files from the toplevel directory: + + nuttx.hex, nuttx.map, nuttx.lod + + to this directory as: + + ostest.hex, ostest.map, ostest.lod diff --git a/Documentation/platforms/z80/ez80/boards/ez80f910200kitg/index.rst b/Documentation/platforms/z80/ez80/boards/ez80f910200kitg/index.rst new file mode 100644 index 00000000000..a803393dccb --- /dev/null +++ b/Documentation/platforms/z80/ez80/boards/ez80f910200kitg/index.rst @@ -0,0 +1,7 @@ +================ +ez80f0910200kitg +================ + +ez80Acclaim! Microcontroller. This port use the Zilog ez80f0910200kitg +development kit, eZ80F091 part, and the Zilog ZDS-II Windows command line +tools. The development environment is Cygwin under WinXP. diff --git a/boards/z80/ez80/ez80f910200zco/README.txt b/Documentation/platforms/z80/ez80/boards/ez80f910200zco/README.txt similarity index 87% rename from boards/z80/ez80/ez80f910200zco/README.txt rename to Documentation/platforms/z80/ez80/boards/ez80f910200zco/README.txt index 5843568ee87..0115761e19e 100644 --- a/boards/z80/ez80/ez80f910200zco/README.txt +++ b/Documentation/platforms/z80/ez80/boards/ez80f910200zco/README.txt @@ -119,4 +119,29 @@ Configuration Subdirectories builds examples/poll. See examples/README.txt for more information about the poll test. -Check out any README.txt files in these s. +dhcpd/README.txt +^^^^^^^^^^^^^^^^ + +dhcpd.zdsproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. + +httpd/README.txt +^^^^^^^^^^^^^^^^ +httpd.zdsproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. + +nettest/README.txt +^^^^^^^^^^^^^^^^ +nettest.zdsproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. + +nsh/README.txt +^^^^^^^^^^^^^^^^ +nsh.zdsproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. + +poll/README.txt +^^^^^^^^^^^^^^^^ + +poll.zdsproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. diff --git a/Documentation/platforms/z80/ez80/boards/ez80f910200zco/index.rst b/Documentation/platforms/z80/ez80/boards/ez80f910200zco/index.rst new file mode 100644 index 00000000000..37a7cd45245 --- /dev/null +++ b/Documentation/platforms/z80/ez80/boards/ez80f910200zco/index.rst @@ -0,0 +1,7 @@ +=============== +ez80f0910200zco +=============== + +ez80Acclaim! Microcontroller. This port use the Zilog ez80f0910200zco +development kit, eZ80F091 part, and the Zilog ZDS-II Windows command line +tools. The development environment is Cygwin under WinXP. diff --git a/boards/z80/ez80/makerlisp/README.txt b/Documentation/platforms/z80/ez80/boards/makerlisp/README.txt similarity index 89% rename from boards/z80/ez80/makerlisp/README.txt rename to Documentation/platforms/z80/ez80/boards/makerlisp/README.txt index 11666e77886..19f28b313e1 100644 --- a/boards/z80/ez80/makerlisp/README.txt +++ b/Documentation/platforms/z80/ez80/boards/makerlisp/README.txt @@ -443,3 +443,46 @@ Configuration Subdirectories STATUS: 2019-06-26: Configuration added. Not yet verified. + + +nsh_flash/README.txt +^^^^^^^^^^^^^^^^^^^^ + +nsh.zdsproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. +nsh.zfpproj is a simple project that will allow you to use the Smart Flash + Programming. NOTE: As of this writing this project does not work, probably + due to RAM configuration in the project. Use ZDS-II instead as is described + in the upper README.txt file +nsh_flash.ztgt is the target file that accompanies the project files. This + one is identical to boards/scripts/makerlisp_ram.ztgt. +nsh_ram.ztgt is the target file that accompanies the project files. This + one is identical to boards/scripts/makerlisp_flash.ztgt. + +sdboot/README.txt +^^^^^^^^^^^^^^^^^ + +sdboot.zdsproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. +sdboot.zfpproj is a simple project that will allow you to use the Smart Flash + Programming. NOTE: As of this writing this project does not work, probably + due to RAM configuration in the project. Use ZDS-II instead as is described + in the upper README.txt file +sdboot_flash.ztgt is the target file that accompanies the project files. This + one is identical to boards/scripts/makerlisp_ram.ztgt. +sdboot_ram.ztgt is the target file that accompanies the project files. This + one is identical to boards/scripts/makerlisp_flash.ztgt. + +nsh_ram/README.txt +^^^^^^^^^^^^^^^^^^ + +nsh.zdsproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. +nsh.zfpproj is a simple project that will allow you to use the Smart Flash + Programming. NOTE: As of this writing this project does not work, probably + due to RAM configuration in the project. Use ZDS-II instead as is described + in the upper README.txt file +nsh_flash.ztgt is the target file that accompanies the project files. This + one is identical to boards/scripts/makerlisp_ram.ztgt. +nsh_ram.ztgt is the target file that accompanies the project files. This + one is identical to boards/scripts/makerlisp_flash.ztgt. diff --git a/Documentation/platforms/z80/ez80/boards/makerlisp/index.rst b/Documentation/platforms/z80/ez80/boards/makerlisp/index.rst new file mode 100644 index 00000000000..d8c6099544e --- /dev/null +++ b/Documentation/platforms/z80/ez80/boards/makerlisp/index.rst @@ -0,0 +1,8 @@ +========= +makerlisp +========= + +This port use the MakerLisp machine based on an eZ80F091 ez80Acclaim! +Microcontroller, and the Zilog ZDS-II Windows command line tools. The +development environment is Cygwin under Windows. A Windows native +development environment is available but has not been verified. diff --git a/boards/z80/ez80/z20x/README.txt b/Documentation/platforms/z80/ez80/boards/z20x/README.txt similarity index 100% rename from boards/z80/ez80/z20x/README.txt rename to Documentation/platforms/z80/ez80/boards/z20x/README.txt diff --git a/Documentation/platforms/z80/ez80/boards/z20x/index.rst b/Documentation/platforms/z80/ez80/boards/z20x/index.rst new file mode 100644 index 00000000000..be0908b4dd5 --- /dev/null +++ b/Documentation/platforms/z80/ez80/boards/z20x/index.rst @@ -0,0 +1,6 @@ +==== +z20x +==== + +Microcontroller. This directory holds the port of NuttX to the z80x board +based on an ez80Acclaim! eZ80F091 microcontroller. diff --git a/Documentation/platforms/z80/ez80/index.rst b/Documentation/platforms/z80/ez80/index.rst index 624304b4b9c..adcf81667dd 100644 --- a/Documentation/platforms/z80/ez80/index.rst +++ b/Documentation/platforms/z80/ez80/index.rst @@ -29,3 +29,12 @@ appropriate configuration to enable support. C intrinsics are also required. Some may be found in the Zilog ZDS-II distribution, requiring some modification to build with the GNU assembler. Additional intrinsics for 64-bit support must be supplied. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/z80/z180/p112/README.txt b/Documentation/platforms/z80/z180/boards/p112/README.txt similarity index 100% rename from boards/z80/z180/p112/README.txt rename to Documentation/platforms/z80/z180/boards/p112/README.txt diff --git a/Documentation/platforms/z80/z180/boards/p112/index.rst b/Documentation/platforms/z80/z180/boards/p112/index.rst new file mode 100644 index 00000000000..926c157472a --- /dev/null +++ b/Documentation/platforms/z80/z180/boards/p112/index.rst @@ -0,0 +1,29 @@ +==== +p112 +==== + +The P112 is notable because it was the first of the hobbyist single board +computers to reach the production stage. The P112 hobbyist computers +were relatively widespread and inspired other hobbyist centered home brew +computing projects such as N8VEM home brew computing project. The P112 +project still maintains many devoted enthusiasts and has an online +repository of software and other information. + +The P112 computer originated as a commercial product of "D-X Designs Pty +Ltd" of Australia. They describe the computer as "The P112 is a stand-alone +8-bit CPU board. Typically running CP/M (tm) or a similar operating system, +it provides a Z80182 (Z-80 upgrade) CPU with up to 1MB of memory, serial, +parallel and diskette IO, and realtime clock, in a 3.5-inch drive form factor. +Powered solely from 5V, it draws 150mA (nominal: not including disk drives) +with a 16MHz CPU clock. Clock speeds up to 24.576MHz are possible." + +The P112 board was last available new in 1996 by Dave Brooks. In late 2004 +on the Usenet Newsgroup comp.os.cpm, talk about making another run of P112 +boards was discussed. David Griffith decided to produce additional P112 kits +with Dave Brooks blessing and the assistance of others. In addition Terry +Gulczynski makes additional P112 derivative hobbyist home brew computers. +Hal Bower was very active in the mid 1990's on the P112 project and ported +the "Banked/Portable BIOS". + +Dave Brooks was successfully funded through Kickstarter for and another +run of P112 boards in November of 2012. diff --git a/Documentation/platforms/z80/z180/index.rst b/Documentation/platforms/z80/z180/index.rst index 2971ec4fbea..9559011fc1b 100644 --- a/Documentation/platforms/z80/z180/index.rst +++ b/Documentation/platforms/z80/z180/index.rst @@ -18,3 +18,57 @@ however, until the third quarter of 2013. So it will be some time before this port is verified on hardware. Refer to the NuttX board `README `__ file for further information. + +The arch/z80 directories contain files to support a variety of 8-bit architectures +from ZiLOG (and spin-architectures such as the Rabbit2000). The arch/z80/src/z180 +sub-directory contains logic unique to the classic Z180 family of chips. + +Files in this directory include: + +``z180_head.asm`` + This is the main entry point into the Z180 program. This includes the + handler for the RESET, power-up interrupt vector and address zero and all + RST interrupts. + +``z180_rom.asm`` + Some architectures may have ROM located at address zero. In this case, a + special version of the "head" logic must be used. This special "head" + file is probably board-specific and, hence, belongs in the board-specific + boards/z80/z180//src directory. This file may, however, be + used as a model for such a board-specific file. + + z180_rom.S is enabled by specifying CONFIG_LINKER_ROM_AT_0000 in the + configuration file. + + A board specific version in the boards/z80/z180//src + directory can be used by: + + 1. Define CONFIG_ARCH_HAVEHEAD + 2. Add the board-specific head file, say .asm, to + boards/z80/z180//src + 3. Add a file called Make.defs in the boards/z80/z180//src + directory containing the line: HEAD_ASRC = .asm + +``Make.defs`` + This is the standard makefile fragment that must be provided in all + chip directories. This fragment identifies the chip-specific file to + be used in building libarch. + +``chip.h`` + This is the standard header file that must be provided in all chip + directories. + +``z180_initialstate.c``, ``z180_copystate.c``, ``z180_restoreusercontext.asm``, ``z180_saveusercontext.asm`` + These files implement the Z180 context switching logic + +``z180_schedulesigaction.c`` and ``z180_sigdeliver.c`` + These files implement Z180 signal handling. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/z80/z8/z8encore000zco/README.txt b/Documentation/platforms/z80/z8/boards/z8encore000zco/README.txt similarity index 91% rename from boards/z80/z8/z8encore000zco/README.txt rename to Documentation/platforms/z80/z8/boards/z8encore000zco/README.txt index c13c8ae9df3..f4ce010de74 100644 --- a/boards/z80/z8/z8encore000zco/README.txt +++ b/Documentation/platforms/z80/z8/boards/z8encore000zco/README.txt @@ -88,4 +88,15 @@ available: trailing bad characters are manually eliminated, then the build will succeed on the next try. -Check out any README.txt files in these s. +ostest/README.txt +^^^^^^^^^^^^^^^^^ + +ostest.zfpproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. Before using, copy the following + files from the toplevel directory: + + nuttx.hex, nuttx.map, nuttx.lod + + to this directory as: + + ostest.hex, ostest.map, ostest.lod diff --git a/Documentation/platforms/z80/z8/boards/z8encore000zco/index.rst b/Documentation/platforms/z80/z8/boards/z8encore000zco/index.rst new file mode 100644 index 00000000000..d5370d66bfd --- /dev/null +++ b/Documentation/platforms/z80/z8/boards/z8encore000zco/index.rst @@ -0,0 +1,7 @@ +============== +z8encore000zco +============== + +z8Encore! Microcontroller. This port use the Zilog z8encore000zco +development kit, Z8F6403 part, and the Zilog ZDS-II Windows command line +tools. The development environment is Cygwin under WinXP. diff --git a/boards/z80/z8/z8f64200100kit/README.txt b/Documentation/platforms/z80/z8/boards/z8f64200100kit/README.txt similarity index 92% rename from boards/z80/z8/z8f64200100kit/README.txt rename to Documentation/platforms/z80/z8/boards/z8f64200100kit/README.txt index f9de1a6ccc4..2d72a97a29d 100644 --- a/boards/z80/z8/z8f64200100kit/README.txt +++ b/Documentation/platforms/z80/z8/boards/z8f64200100kit/README.txt @@ -92,4 +92,16 @@ available: trailing bad characters are manually eliminated, then the build will succeed on the next try. -Check out any README.txt files in these s. +ostest/README.txt +^^^^^^^^^^^^^^^^^ + +ostest.zfpproj is a simple ZDS-II project that will allow you + to use the ZDS-II debugger. Before using, copy the following + files from the toplevel directory: + + nuttx.hex, nuttx.map, nuttx.lod + + to this directory as: + + ostest.hex, ostest.map, ostest.lod + diff --git a/Documentation/platforms/z80/z8/boards/z8f64200100kit/index.rst b/Documentation/platforms/z80/z8/boards/z8f64200100kit/index.rst new file mode 100644 index 00000000000..f00354ae78e --- /dev/null +++ b/Documentation/platforms/z80/z8/boards/z8f64200100kit/index.rst @@ -0,0 +1,8 @@ +============== +z8f64200100kit +============== + +z8Encore! Microcontroller. This port use the Zilog z8f64200100kit +development kit, Z8F6423 part, and the Zilog ZDS-II Windows command line +tools. The development environment is Cygwin under WinXP. + diff --git a/Documentation/platforms/z80/z8/index.rst b/Documentation/platforms/z80/z8/index.rst index 0fccef25461..42b2c3f8c16 100644 --- a/Documentation/platforms/z80/z8/index.rst +++ b/Documentation/platforms/z80/z8/index.rst @@ -17,3 +17,12 @@ README files for the and for the\ `z8f64200100kit `__ for further information. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/z80/z80/z80sim/README.txt b/Documentation/platforms/z80/z80/boards/z80sim/README.txt similarity index 100% rename from boards/z80/z80/z80sim/README.txt rename to Documentation/platforms/z80/z80/boards/z80sim/README.txt diff --git a/Documentation/platforms/z80/z80/boards/z80sim/index.rst b/Documentation/platforms/z80/z80/boards/z80sim/index.rst new file mode 100644 index 00000000000..bb0f4612bd0 --- /dev/null +++ b/Documentation/platforms/z80/z80/boards/z80sim/index.rst @@ -0,0 +1,7 @@ +====== +z80sim +====== + +z80 Microcontroller. This port uses a Z80 instruction set simulator +called z80sim. This port also uses the SDCC toolchain +(http://sdcc.sourceforge.net/") (verified with version 2.6.0). diff --git a/Documentation/platforms/z80/z80/index.rst b/Documentation/platforms/z80/z80/index.rst index 50faf414fc0..f16705024ad 100644 --- a/Documentation/platforms/z80/z80/index.rst +++ b/Documentation/platforms/z80/z80/index.rst @@ -36,3 +36,57 @@ repository if anyone would ever like to resurrect it. to support ARM, Cortex-M3, avr, m68k, m68hc11, m68hc12, m9s12, blackfin, m32c, h8, and SuperH ports. + +The ``arch/z80`` directories contain files to support a variety of 8-bit architectures +from ZiLOG (and spin-architectures such as the Rabbit2000). The arch/z80/src/z80 +sub-directory contains logic unique to the classic Z80 chip. + +Files in this directory include: + +``z80_head.asm`` + This is the main entry point into the Z80 program. This includes the + handler for the RESET, power-up interrupt vector and address zero and all + RST interrupts. + +``z80_rom.asm`` + Some architectures may have ROM located at address zero. In this case, a + special version of the "head" logic must be used. This special "head" + file is probably board-specific and, hence, belongs in the board-specific + boards/z80/z80//src directory. This file may, however, be + used as a model for such a board-specific file. + + z80_rom.S is enabled by specifying CONFIG_LINKER_ROM_AT_0000 in the + configuration file. + + A board specific version in the boards/z80/z80//src directory + can be used by: + + 1. Define CONFIG_ARCH_HAVEHEAD + 2. Add the board-specific head file, say .asm, to + boards/z80/z80//src + 3. Add a file called Make.defs in the boards/z80/z80//src + directory containing the line: HEAD_ASRC = .asm + +``Make.defs`` + This is the standard makefile fragment that must be provided in all + chip directories. This fragment identifies the chip-specific file to + be used in building libarch. + +``chip.h`` + This is the standard header file that must be provided in all chip + directories. + +``z80_initialstate.c``, ``z80_copystate.c``, ``z80_restoreusercontext.asm``, and ``z80_saveusercontext.asm`` + These files implement the Z80 context switching logic + +``z80_schedulesigaction.c`` and ``z80_sigdeliver.c`` + These files implement Z80 signal handling. + +Supported Boards +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + boards/*/* diff --git a/boards/README.txt b/boards/README.txt deleted file mode 100644 index f44bc1f2eb1..00000000000 --- a/boards/README.txt +++ /dev/null @@ -1,990 +0,0 @@ -Board-Specific Configurations -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -This directory contains the board support logic for all boards supported -by NuttX. - -The nuttx/boards directory is a part of the internal OS. It should contain -only OS bring-up logic and driver initialization logic. THERE SHOULD BE NO -APPLICATION CALLABLE LOGIC IN THIS DIRECTORY. - -If you have board-specific, application callable logic, that logic should not -go here. Please consider using a sub-directory under apps/platform instead. - -Table of Contents -^^^^^^^^^^^^^^^^^ - - o Board-Specific Configurations - o Summary of Files - o Configuration Variables - o Supported Boards - o Configuring NuttX - o Building Symbol Tables - -Board-Specific Configurations -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -The NuttX configuration consists of: - -o Processor architecture specific files. These are the files contained - in the arch// directory. - -o Chip/SoC specific files. Each processor architecture is embedded - in a chip or System-on-a-Chip (SoC) architecture. The full chip - architecture includes the processor architecture plus chip-specific - interrupt logic, general purpose I/O (GIO) logic, and specialized, - internal peripherals (such as UARTs, USB, etc.). - - These chip-specific files are contained within chip-specific - sub-directories in the arch// directory and are selected - via the CONFIG_ARCH_name selection - -o Board specific files. In order to be usable, the chip must be - contained in a board environment. The board configuration defines - additional properties of the board including such things as - peripheral LEDs, external peripherals (such as network, USB, etc.). - - These board-specific configuration files can be found in the - boards//// sub-directories and are - discussed in this README. Additional configuration information may be - available in board-specific README files at - boards////README.txt files. - -The boards/ subdirectory contains configuration data for each board. These -board-specific configurations plus the architecture-specific configurations in -the arch/ subdirectory completely define a customized port of NuttX. - -Directory Structure -^^^^^^^^^^^^^^^^^^^ - -The boards/ directory contains board specific configuration logic. Each -board must provide a subdirectory under boards/ with the -following characteristics: - - - |-- README.txt - |-- include/ - | `-- (board-specific header files) - |-- src/ - | |-- Makefile - | `-- (board-specific source files) - |-- - | |-- Make.defs - | `-- defconfig - |-- - | |-- Make.defs - | `-- defconfig - ... - -Summary of Files -^^^^^^^^^^^^^^^^ - -README.txt -- This text file provides additional information unique to - each board configuration sub-directory. - -include/ -- This directory contains board specific header files. This - directory will be linked as include/arch/board at configuration time and - can be included via '#include '. These header file - can only be included by files in arch/include/ and - arch//src - -src/ -- This directory contains board specific drivers. This - directory will be linked as arch//src/board at configuration - time and will be integrated into the build system. - -src/Makefile -- This makefile will be invoked to build the board specific - drivers. It must support the following targets: libext$(LIBEXT), clean, - and distclean. - -A board may have various different configurations using these common source -files. Each board configuration is described by two files: Make.defs and -defconfig. Typically, each set of configuration files is retained in a -separate configuration sub-directory (, , .. in -the above diagram). - -Make.defs -- This makefile fragment provides architecture and - tool-specific build options. It will be included by all other - makefiles in the build (once it is installed). This make fragment - should define: - - Tools: CC, LD, AR, NM, OBJCOPY, OBJDUMP - Tool options: CFLAGS, LDFLAGS - - When this makefile fragment runs, it will be passed TOPDIR which - is the path to the root directory of the build. This makefile - fragment should include: - - $(TOPDIR)/.config : NuttX configuration - $(TOPDIR)/tools/Config.mk : Common definitions - - Definitions in the Make.defs file probably depend on some of the - settings in the .config file. For example, the CFLAGS will most likely be - different if CONFIG_DEBUG_FEATURES=y. - - The included tools/Config.mk file contains additional definitions that may - be overridden in the architecture-specific Make.defs file as necessary: - - COMPILE, ASSEMBLE, ARCHIVE, CLEAN, and MKDEP macros - -defconfig -- This is a configuration file similar to the Linux - configuration file. In contains variable/value pairs like: - - CONFIG_VARIABLE=value - - This configuration file will be used at build time: - - (1) as a makefile fragment included in other makefiles, and - (2) to generate include/nuttx/config.h which is included by - most C files in the system. - -Configuration Variables -^^^^^^^^^^^^^^^^^^^^^^^ - -At one time, this section provided a list of all NuttX configuration -variables. However, NuttX has since converted to use the kconfig-frontends -tools (See https://bitbucket.org/nuttx/tools/src/master/kconfig-frontends/.) -Now, the NuttX configuration is determined by a self-documenting set of -Kconfig files. - -The current NuttX configuration variables are also documented in separate, -auto-generated configuration variable document. That configuration variable -document is generated using the kconfig2html tool that can be found in the -nuttx/tools directory. That tool analyzes the NuttX Kconfig files and -generates an excruciatingly boring HTML document. - -The latest boring configuration variable documentation can be regenerated at -any time using that tool or, more appropriately, the wrapper script at -nuttx/tools/mkconfigvars.sh. That script will generate the file -nuttx/Documentation/NuttXConfigVariables.html. - -Supported Boards -^^^^^^^^^^^^^^^^ - -boards/avr/atmega/amber - This is placeholder for the SoC Robotics Amber Web Server that is based - on the Atmel AVR ATMega128 MCU. There is not much there yet and what is - there is untested due to tool-related issues. - -boards/arm/sam34/arduino-due - This sub-directory holds board support for the Arduino DUE board featuring - the Atmel ATSAM3X8E MCU running at 84 MHz. - -boards/avr/at32uc3/avr32dev1 - This is a port of NuttX to the Atmel AVR32DEV1 board. That board is - based on the Atmel AT32UC3B0256 MCU and uses a specially patched - version of the GNU toolchain: The patches provide support for the - AVR32 family. That patched GNU toolchain is available only from the - Atmel website. STATUS: This port is functional but very basic. There - are configurations for NSH and the OS test. - -boards/arm/stm32/axoloti - Support for the Axoloti synthesizer board based on the STMicro - STM32F427IGH6 MCU. See: http://www.axoloti.com/ - -boards/arm/stm32/b-g474e-dpow1 - Initial support for booting NuttX to a functional NSH prompt on the - STMicro B-G474E-DPOW1 Discovery kit with STM32G474RE MCU. - -boards/arm/stm32/nucleo-g431kb - STMicro Nucleo G431KB board based on the STMicro STM32G431KB MCU. - -boards/arm/stm32/nucleo-g431rb - STMicro Nucleo G431RB board based on the STMicro STM32G431RB MCU. - -boards/arm/stm32f0l0g0/b-l072z-lrwan1 - STMicro STM32L0 Discovery kit with LoRa/SigFox based on STM32L072CZ MCU. - -boards/arm/lpc43xx/bambino-200e - Micromint Bambino board. This board is based on the LPC4330FBD144. - -boards/arm/c5471/c5471evm - This is a port to the Spectrum Digital C5471 evaluation board. The - TMS320C5471 is a dual core processor from TI with an ARM7TDMI general - purpose processor and a c54 DSP. It is also known as TMS320DA180 or just DA180. - NuttX runs on the ARM core and is built with a GNU arm-nuttx-elf toolchain*. - This port is complete and verified. - -boards/arm/tiva/launchxl_cc1310 - Port to the TI SimpleLink CC1310 LaunchPad Evaluation Kit (LAUNCHXL-CC1310) - featuring the SimpleLinkCC1310 chip. This board features the CC1310F128 - part with 128Kb of FLASH and 20Kb of SRAM. - -boards/arm/tiva/launchxl_cc1312r1 - Port to the TI SimpleLink CC1312R1 LaunchPad Evaluation Kit (LAUNCHXL-CC1312R1) - featuring the SimpleLinkCC1312R1 chip. - -boards/arm/stm32/clicker2-stm32 - Mikroe Clicker2 STM32 board based on the STMicro STM32F407VGT6 MCU. - -boards/arm/stm32/cloudctrl - Darcy's CloudController board. This is a small network relay development - board. Based on the Shenzhou IV development board design. It is based on - the STM32F107VC MCU. - -boards/hc/m9s12/demo9s12ne64 - NXP/FreeScale DMO9S12NE64 board based on the MC9S12NE64 hcs12 cpu. This - port uses the m9s12x GCC toolchain. STATUS: (Still) under development; it - is code complete but has not yet been verified. - -boards/arm/tiva/dk-tm4c129x - This is the port of NuttX to the Tiva DK-TM4C129x Connected Development Kit. The - Tiva DK-TM4C129x features the TM4C129XNCZAD MCU. - -boards/arm/lpc31xx/ea3131 - Embedded Artists EA3131 Development board. This board is based on the - an NXP LPC3131 MCU. This OS is built with the arm-nuttx-elf toolchain*. - STATUS: This port is complete and mature. - -boards/arm/lpc31xx/ea3152 - Embedded Artists EA3152 Development board. This board is based on the - an NXP LPC3152 MCU. This OS is built with the arm-nuttx-elf toolchain*. - STATUS: This port is has not be exercised well, but since it is - a simple derivative of the ea3131, it should be fully functional. - -boards/arm/tiva/eagle100 - Micromint Eagle-100 Development board. This board is based on the - an ARM Cortex-M3 MCU, the Luminary LM3S6918. This OS is built with the - arm-nuttx-elf toolchain*. STATUS: This port is complete and mature. - -boards/arm/efm32/efm32-g8xx-stk - The port of NuttX to the EFM32 Gecko Starter Kit (EFM32-G8XX-STK). - -boards/arm/efm32/efm32gg-stk3700 - The port of NuttX to the EFM32 Giant Gecko Starter Kit - (EFM32GG-STK3700). - -boards/arm/tiva/ekk-lm3s9b96 - TI/Stellaris EKK-LM3S9B96 board. This board is based on the - an EKK-LM3S9B96 which is a Cortex-M3. - -boards/arm/stm32/emw3162 - A configuration for the EMW3162 Wi-Fi board - (https://www.waveshare.com/wiki/EMW3162). This board features - the STM32F205RGY6 MCU from STMicro. - -boards/xtensa/esp32/esp-core - The ESP32 is a dual-core system from Espressif with two Harvard architecture - Xtensa LX6 CPUs. All embedded memory, external memory and peripherals are - located on the data bus and/or the instruction bus of bus of these CPUs. - With some minor exceptions, the address mapping of two CPUs is symmetric, - meaning they use the same addresses to access the same memory. - -boards/z80/ez80/ez80f0910200kitg - ez80Acclaim! Microcontroller. This port use the Zilog ez80f0910200kitg - development kit, eZ80F091 part, and the Zilog ZDS-II Windows command line - tools. The development environment is Cygwin under WinXP. - -boards/z80/ez80/ez80f0910200zco - ez80Acclaim! Microcontroller. This port use the Zilog ez80f0910200zco - development kit, eZ80F091 part, and the Zilog ZDS-II Windows command line - tools. The development environment is Cygwin under WinXP. - -boards/arm/stm32/fire-stm32v2 - A configuration for the M3 Wildfire STM32 board. This board is based on the - STM32F103VET6 chip. See http://firestm32.taobao.com . Version 2 and 3 of - the boards are supported but only version 2 has been tested. - -boards/mips/pic32mz/flipnclick-pic32mz - Board support for the Mikroe Flip&Click PIC32MZ board. This board is a - chipKit Arduino-compatible board (but can also be used with the Mikroe - bootloader). It has with four Mikroe Click bus interfaces in addition to - standard Arduino connectors. This board features the Microchip - PIC32MZ2048EFH100 MCU running at 200 MHz (252 MHz capable). - -boards/mips/pic32mz/chipkit-wifire - Board support for the chipKIT Wi-FIRE board. This board is a chipKIT - Arduino-compatible board. This board features - the Microchip PIC32MZ2048EFG100 MCU running at 200 MHz. - -boards/arm/sam34/flipnclick-sam3x - Board support for the Mikroe Flip&Click STM32X board. This board is an - Arduino-Due work-alike with four Mikroe Click bus interfaces. Like the - Arduino DUE, this board features the Atmel ATSAM3X8E MCU running at 84 - MHz. - -boards/arm/kinetis/freedom-k28f - This port uses the NXP/FreeScale FREEDOM-K28F development board. This - board uses the Kinetis K28F MK28FN2M0VMI15 Cortex-M4 MCU. - -boards/arm/kinetis/freedom-k64f - This port uses the NXP/FreeScale FREEDOM-K64F development board. This board - uses the Kinetis K64 MK64FN1M0VLL12 Cortex-M4 MCU. - -boards/arm/kl/freedom-kl25z -boards/arm/kl/freedom-kl26z - These configurations are for the NXP/FreeScale Freedom KL25Z and very similar - KL26Z board. The Freedom-KL25Z features the K25Z120LE3AN chip; the - Freedom-KL26Z has the K26Z128VLH4 chip. These are separate configurations - because of minor differences in the on-board logic. Both include a - built-in SDA debugger. - -boards/arm/stm32/hymini-stm32v - A configuration for the HY-Mini STM32v board. This board is based on the - STM32F103VCT chip. - -boards/arm/kinetis/kwikstik-k40. - Kinetis K40 Cortex-M4 MCU. This port uses the NXP/FreeScale KwikStik-K40 - development board. - -boards/arm/tms570/launchxl-tms57004 - TI Hercules TMS570LS04x/03x LaunchPad Evaluation Kit (LAUNCHXL-TMS57004) - featuring the Hercules TMS570LS0432PZ chip. - -boards/arm/lpc17xx_40xx/lincoln60 - NuttX port to the Micromint Lincoln 60 board. - -boards/arm/tiva/lm3s6432-s2e - Stellaris RDK-S2E Reference Design Kit and the MDL-S2E Ethernet to - Serial module. - -boards/arm/tiva/lm3s6965-ek - Stellaris LM3S6965 Evaluation Kit. This board is based on the - an ARM Cortex-M3 MCU, the Luminary/TI LM3S6965. This OS is built with the - arm-nuttx-elf toolchain*. STATUS: This port is complete and mature. - -boards/arm/tiva/lm3s8962-ek - Stellaris LMS38962 Evaluation Kit. - -boards/arm/tiva/lm4f120-launchpad - This is the port of NuttX to the Stellaris LM4F120 LaunchPad. The - Stellaris LM4F120 LaunchPad Evaluation Board is a low-cost evaluation - platform for ARM Cortex-M4F-based microcontrollers from Texas - Instruments. - -boards/arm/lpc17xx_40xx/lpcxpresso-lpc1768 - Embedded Artists base board with NXP LPCExpresso LPC1768. This board - is based on the NXP LPC1768. The Code Red toolchain is used by default. - STATUS: Under development. - -boards/arm/lpc54xx/lpcxpresso-lpc54628 - NXP LPCExpresso LPC54628. This board is based on the NXP LPC54628. - -boards/arm/lpc43xx/lpc4330-xplorer - NuttX port to the LPC4330-Xplorer board from NGX Technologies featuring - the NXP LPC4330FET100 MCU - -boards/arm/lpc43xx/lpc4337-ws - NuttX port to the WaveShare LPC4337-ws board featuring the NXP LPC4337JBD144 - MCU. - -boards/arm/lpc43xx/lpc4357-evb - NuttX port to the LPC4357-EVB board from Embest featuring the NXP - LPC4357FET256 MCU. Based on the LPC4300 Xplorer port and provided by - Toby Duckworth. - -boards/arm/lpc43xx/lpc4370-link2 - NuttX port to the NXP LPC4370-Link2 development board featuring the NXP - LPC4370FET100 MCU. Based on the LPC4300 Xplorer port and provided by - Lok Tep. - -boards/arm/lpc17xx_40xx/lx_cpu - This port uses the PiKRON LX_CPU board. See the - http://pikron.com/pages/products/cpu_boards/lx_cpu.html for further - information. This board features the NXP LPC4088 (compatible with - LPC1788) and Xilinx Spartan 6 XC6SLX9 - -boards/z80/ez80/makerlisp - This port use the MakerLisp machine based on an eZ80F091 ez80Acclaim! - Microcontroller, and the Zilog ZDS-II Windows command line tools. The - development environment is Cygwin under Windows. A Windows native - development environment is available but has not been verified. - -boards/arm/stm32/maple - NuttX support for the LeafLab's Maple and Maple Mini boards. These boards - are based on the STM32F103RBT6 chip for the standard version and on the - STM32F103CBT6 for the mini version (See http://leaflabs.com/docs/hardware/maple.html) - -boards/arm/max326xx/max32660-evsys - The configurations in this directory support the Maxim Integrated - MAX32660-EVSYS board. - -boards/arm/lpc17xx_40xx/mbed - The configurations in this directory support the mbed board (http://mbed.org) - that features the NXP LPC1768 microcontroller. This OS is also built - with the arm-nuttx-elf toolchain*. STATUS: Contributed. - -boards/arm/lpc17xx_40xx/mcb1700 - Board support for the Keil MCB1700 - -boards/arm/samd5e5/metro-m4 - Th configurations in this directory are part of the port of NuttX to the - Adafruit Metro M4. The Metro M4 uses a Arduino form factor and and pinout. - It's powered with an ATSAMD51J19 - -boards/arm/stm32/mikroe-stm32f4 - This is the port of NuttX to the MikroElektronika Mikromedia for STM32F4 - development board. Contributed by Ken Petit. - -boards/misoc/lm32/misoc - This directory holds the port to NuttX running on a Qemu LM32 system. - You can find the Qemu setup at https://bitbucket.org/key2/qemu - -boards/arm/lpc214x/mcu123-lpc214x - This port is for the NXP LPC2148 as provided on the mcu123.com - lpc214x development board. This OS is also built with the arm-nuttx-elf - toolchain*. The port supports serial, timer0, spi, and usb. - -boards/avr/at90usb/micropendous3 - This is a port to the Opendous Micropendous 3 board. This board may - be populated with either an AVR AT90USB646, 647, 1286, or 1287 MCU. - Support is configured for the AT90USB647. - -boards/mips/pic32mx/mirtoo - This is the port to the DTX1-4000L "Mirtoo" module. This module uses MicroChip - PIC32MX250F128D. See http://www.dimitech.com/ for further information. - -boards/avr/atmega/moteino-mega - This is placeholder for the LowPowerLab MoteinoMEGA that is based - on the Atmel AVR ATMega1284P MCU. There is not much there yet and what is - there is untested due to tool-related issues. - -boards/arm/moxart/moxa - Moxa NP51x0 series of 2-port advanced RS-232/422/485 serial device servers. - -boards/hc/mcs92s12ne6/ne64badge - Future Electronics Group NE64 /PoE Badge board based on the - MC9S12NE64 hcs12 cpu. This port uses the m9s12x GCC toolchain. - STATUS: Under development. The port is code-complete but has - not yet been fully tested. - -boards/arm/nrf52/arduino-nano-33ble - NuttX port to the Arduino Nano 33 BLE Sense board - -boards/arm/nrf52/arduino-nano-33ble-rev2 - NuttX port to the Arduino Nano 33 BLE Sense Rev2 board - -boards/arm/nrf52/nrf52-feather - NuttX port to the Adafruit nRF52832 Feather board - -boards/arm/nrf52/nrf52832-dk - NuttX port to the Nordic nRF52832 Development Kit (PCA10040) - -boards/arm/nrf52/nrf52840-dk - NuttX port to the Nordic nRF52840 Development Kit (PCA10056) - -boards/arm/nrf52/nrf52840-dongle - NuttX port to the Nordic nRF52840 Dongle (PCA10059) - -boards/arm/dm320/ntosd-dm320 - This port uses the Neuros OSD v1.0 Dev Board with a GNU arm-nuttx-elf - toolchain*: see - - http://wiki.neurostechnology.com/index.php/OSD_1.0_Developer_Home - - There are some differences between the Dev Board and the currently - available commercial v1.0 Boards. See - - http://wiki.neurostechnology.com/index.php/OSD_Developer_Board_v1 - - NuttX operates on the ARM9EJS of this dual core processor. - STATUS: This port is code complete, verified, and included in the - NuttX 0.2.1 release. - -boards/arm/stm32f7/nucleo-144 - STMicro Nucleo-144 development board family. Included support for (1) the - Nucleo-F767ZG board featuring the STM32F746ZGT6U MCU. The STM32F746ZGT6U - is a 216MHz Cortex-M7 operation with 1024Kb Flash memory and 320Kb SRAM. - And (2) the Nucleo-F746ZG board featuring the STM32F767ZIT6 MCU. The - STM32F767ZIT6 is a 216MHz Cortex-M7 operation with 2048Kb Flash memory - and 512Kb SRAM. - -boards/arm/stm32f0l0g0/nucleo-f072rb - STMicro Nucleo F072RB board based on the STMicro STM32F072RBT6 MCU. - -boards/arm/stm32/nucleo-f4x1re - STMicro ST Nucleo F401RE and F411RE boards. See - http://mbed.org/platforms/ST-Nucleo-F401RE and - http://developer.mbed.org/platforms/ST-Nucleo-F411RE for more - information about these boards. - -boards/arm/stm32/nucleo-f410rb - NuttX configuration for the STMicro NucleoF410RB board from ST Micro. - This board features the STM32F410RB 100MHz Cortex-M4 with 128 KB Flash - and 32 KB SRAM. - -boards/arm/stm32/nucleo-f303re - STMicro ST Nucleo F303RE board. Contributed by Paul Alexander Patience. - -boards/arm/stm32f0l0g0/nucleo-l073rz - STMicro STM32L0 Discovery kit with LoRa/SigFox based on STM32L072CZ MCU. - -boards/arm/nuc1xx/nutiny-nuc120 - This is the port of NuttX to the NuvoTon NuTiny-SDK-NUC120 board. This - board has the NUC120LE3AN chip with a built-in NuLink debugger. - -boards/arm/efm32/olimex-efm32g880f128-stk - This is the port of NuttX to the Olimex EFM32G880F128-STK development - board. - -boards/arm/lpc17xx_40xx/olimex-lpc1766stk - This port uses the Olimex LPC1766-STK board and a GNU GCC toolchain* under - Linux or Cygwin. STATUS: Complete and mature. - -boards/arm/lpc2378/olimex-lpc2378 - This port uses the Olimex-lpc2378 board and a GNU arm-nuttx-elf toolchain* under - Linux or Cygwin. STATUS: ostest and NSH configurations available. - This port for the NXP LPC2378 was contributed by Rommel Marcelo. - -boards/arm/stm32/olimex-stm32-h405 - This port uses the Olimex STM32 H405 board and a GNU arm-nuttx-elf - toolchain* under Linux or Cygwin. See the http://www.olimex.com for - further information. This board features the STMicro STM32F405RGT6 MCU. - Contributed by Martin Lederhilger. - -boards/arm/stm32/olimex-stm32-h407 - This port uses the Olimex STM32 H407 board and a GNU arm-nuttx-elf - toolchain* under Linux or Cygwin. See the http://www.olimex.com for - further information. This board features the STMicro STM32F407ZGT6 (144 - pins). Contributed by Neil Hancock. - -boards/arm/stm32/olimex-stm32-e407 - Olimex STM32 E407 board based on the STMicro STM32F407ZGT6 (144pins). - Contributed by Mateusz Szafoni. - -boards/arm/stm32/olimex-stm32-p107 - This port uses the Olimex STM32-P107 board (STM32F107VC) and a GNU arm-nuttx-elf - toolchain* under Linux or Cygwin. See the https://www.olimex.com/dev/stm32-p107.html - for further information. Contributed by Max Holtzberg. - -boards/arm/stm32/olimex-stm32-p207 - This port uses the Olimex STM32-P207 board (STM32F207ZE) and a GNU arm-nuttx-elf - toolchain under Linux or Cygwin. See the https://www.olimex.com/dev/stm32-p207.html - for further information. Contributed by Martin Lederhilger. - -boards/arm/stm32/olimex-stm32-p407 - This port uses the Olimex STM32-P407 board (STM32F407ZG) and a GNU arm-nuttx-elf - toolchain under Linux or Cygwin. See the https://www.olimex.com/dev/stm32-p407.html - for further information. - -boards/arm/stm32/olimexino-stm32 - This port uses the Olimexino STM32 board (STM32F103RBT6) and a GNU arm-nuttx-elf - toolchain* under Linux or Cygwin. See the http://www.olimex.com for further\ - information. Contributed by David Sidrane. - -boards/arm/str71x/olimex-strp711 - This port uses the Olimex STR-P711 board and a GNU arm-nuttx-elf toolchain* under - Linux or Cygwin. See the http://www.olimex.com/dev/str-p711.html" for - further information. STATUS: Configurations for the basic OS test and NSH - are complete and verified. - -boards/arm/stm32/omnibusf4 - Flight controllers compatible with the OMINBUSF4 Betaflight target - -boards/or1k/mor1kx/or1k - Generic OpenRISC board. - -boards/arm/a1x/pcduino-a10 - This directory contains the port of NuttX to the pcDuino v1 board - See http://www.pcduino.com/ for information about pcDuino Lite, v1, - and v2. These boards are based around the Allwinner A10 Cortex-A8 CPU. - I have not compared these boards in detail, but I believe that the - differences are cosmetic. This port was developed on the v1 board, but - the others may be compatible. - -boards/z80/z180/p112 - The P112 is notable because it was the first of the hobbyist single board - computers to reach the production stage. The P112 hobbyist computers - were relatively widespread and inspired other hobbyist centered home brew - computing projects such as N8VEM home brew computing project. The P112 - project still maintains many devoted enthusiasts and has an online - repository of software and other information. - - The P112 computer originated as a commercial product of "D-X Designs Pty - Ltd" of Australia. They describe the computer as "The P112 is a stand-alone - 8-bit CPU board. Typically running CP/M (tm) or a similar operating system, - it provides a Z80182 (Z-80 upgrade) CPU with up to 1MB of memory, serial, - parallel and diskette IO, and realtime clock, in a 3.5-inch drive form factor. - Powered solely from 5V, it draws 150mA (nominal: not including disk drives) - with a 16MHz CPU clock. Clock speeds up to 24.576MHz are possible." - - The P112 board was last available new in 1996 by Dave Brooks. In late 2004 - on the Usenet Newsgroup comp.os.cpm, talk about making another run of P112 - boards was discussed. David Griffith decided to produce additional P112 kits - with Dave Brooks blessing and the assistance of others. In addition Terry - Gulczynski makes additional P112 derivative hobbyist home brew computers. - Hal Bower was very active in the mid 1990's on the P112 project and ported - the "Banked/Portable BIOS". - - Dave Brooks was successfully funded through Kickstarter for and another - run of P112 boards in November of 2012. - -boards/arm/stm32/photon - A configuration for the Photon Wifi board from Particle Devices - (https://www.particle.io). This board features the STM32F205RGY6 MCU from - STMicro. - -boards/mips/pic32mx/pic32mx-starterkit - This directory contains the port of NuttX to the Microchip PIC32 Ethernet - Starter Kit (DM320004) with the Multimedia Expansion Board (MEB, DM320005). - See www.microchip.com for further information. - -boards/mips/pic32mx/pic32mx7mmb - This directory will (eventually) contain the port of NuttX to the - Mikroelektronika PIC32MX7 Multimedia Board (MMB). See - http://www.mikroe.com/ for further information. - -boards/mips/pic32mz/pic32mz-starterkit - This directory contains the port of NuttX to the Microchip PIC32MZ - Embedded Connectivity (EC) Starter Kit. There are two configurations of - the starter kit: - - 1) The PIC32MZ Embedded Connectivity Starter Kit based on the - PIC32MZ2048ECH144-I/PH chip (DM320006), and - 2) The PIC32MZ Embedded Connectivity Starter Kit based on the - PIC32MZ2048ECM144-I/PH w/Crypto Engine (DM320006-C) - - See www.microchip.com for further information. - -boards/arm/lpc17xx_40xx/pnev5180b - NXP Semiconductors' PN5180 NFC Frontend Development Kit. This board is - based on the NXP LPC1769 MCU. - -boards/x86/qemu/qemu-i486 - Port of NuttX to QEMU in i486 mode. This port will also run on real i486 - hardware (Google the Bifferboard). - -boards/arm/s32k1xx/s32k118evb - This directory holds the port of NuttX to the NXP S32K118EVB board - featuring the S32K118 Cortex-M0+. - -boards/arm/s32k1xx/s32k146evb - This directory holds the port of NuttX to the NXP S32K146EVB board - featuring the S32K146 Cortex-M4F. - -boards/arm/s32k1xx/s32k148evb - This directory holds the port of NuttX to the NXP S32K148EVB board - featuring the S32K148 Cortex-M4F. - -boards/arm/imx6/sabre-6quad - This directory holds a port of NuttX to the NXP/Freescale Sabre board - featuring the iMX 6Quad CPU. - -boards/arm/sama5/sama5d2-xult - This is the port of NuttX to the Microchip SAMA5D2-Xplained Ultra development - board. This board features the Microchip SAMA5D27. See - https://www.microchip.com/Developmenttools/ProductDetails/ATSAMA5D2C-XULT - -boards/arm/sama5/giant-board - This is the port of NuttX to the Groboards Giant Board board. This board - features the Atmel SAMA5D27C-D1G. See http://groboards.com/giant-board. - -boards/arm/sama5/sama5d3x-ek - This is the port of NuttX to the Atmel SAMA5D3x-EK development boards - (where x=1,3,4, or 5). These boards feature the Atmel SAMA5D3 - microprocessors. Four different SAMA5D3x-EK kits are available - - - SAMA5D31-EK with the ATSAMA5D1 (http://www.atmel.com/devices/sama5d31.aspx) - - SAMA5D33-EK with the ATSAMA5D3 (http://www.atmel.com/devices/sama5d33.aspx) - - SAMA5D34-EK with the ATSAMA5D4 (http://www.atmel.com/devices/sama5d34.aspx) - - SAMA5D35-EK with the ATSAMA5D5 (http://www.atmel.com/devices/sama5d35.aspx) - - The each consist of an identical base board with different plug-in modules - for each CPU. An option 7 inch LCD is also available. All four boards - are supported by NuttX with a simple reconfiguration of the processor - type. - -boards/arm/sama5/sama5d3-xplained - This is the port of NuttX to the Atmel SAMA5D3x-Xplained development board. - This board features the Atmel SAMA5D36. See - http://www.atmel.com/devices/sama5d36.aspx. - -boards/arm/sama5/sama5d4-ek - This is the port of NuttX to the Atmel SAMA5D4-EK development board. - This board features the Atmel SAMA5D44. See http://www.atmel.com. - -boards/arm/samd2l2/samd20-xplained - The port of NuttX to the Atmel SAMD20-Xplained Pro development board. This - board features the ATSAMD20J18A MCU (Cortex-M0+ with 256KB of FLASH and - 32KB of SRAM). - -boards/arm/samd2l2/samd21-xplained - The port of NuttX to the Atmel SAMD21-Xplained Pro development board. This - board features the ATSAMD21J18A MCU (Cortex-M0+ with 256KB of FLASH and - 32KB of SRAM). - -boards/arm/sam34/sam3u-ek - The port of NuttX to the Atmel SAM3U-EK development board. - -boards/arm/sam34/sam4cmp-db - The port of NuttX to the Atmel SAM4CMP-DB development board. - -boards/arm/sam34/sam4e-ek - The port of NuttX to the Atmel SAM4E-EK development board. This board - features the SAM4E16 MCU running at up to 120MHz. - -boards/arm/sam34/sam4l-xplained - The port of NuttX to the Atmel SAM4L-Xplained development board. - -boards/arm/sam34/sam4s-xplained - The port of NuttX to the Atmel SAM4S-Xplained development board. - -boards/arm/sam34/sam4s-xplained-pro - The port of NuttX to the Atmel SAM4S-Xplained Pro development board. - -boards/arm/samv7/same70-qmtech - The port of NuttX to the Atmel SAME70 evaluation board from QMTECH. - -boards/arm/samv7/same70-xplained - The port of NuttX to the Atmel SAME70 Xplained evaluation board. - -boards/arm/samv7/samv71-xult - The port of NuttX to the Atmel SAMV71 Xplained Ultra evaluation board. - -boards/sim/sim/sim - A user-mode port of NuttX to the x86 Linux platform is available. - The purpose of this port is primarily to support OS feature development. - This port does not support interrupts or a real timer (and hence no - round robin scheduler) Otherwise, it is complete. - -boards/arm/stm32/shenzhou - This is the port of NuttX to the Shenzhou development board from - www.armjishu.com. This board features the STMicro STM32F107VCT MCU. - -boards/renesas/m16c/skp16c26 - Renesas M16C processor on the Renesas SKP16C26 StarterKit. This port - uses the GNU m32c toolchain. STATUS: The port is complete but untested - due to issues with compiler internal errors. - -boards/arm/stm32/stm3210e-eval - STMicro STM3210E-EVAL development board based on the STMicro STM32F103ZET6 - microcontroller (ARM Cortex-M3). This port uses the GNU Cortex-M3 - toolchain. - -boards/arm/stm32/stm3220g-eval - STMicro STM3220G-EVAL development board based on the STMicro STM32F407IG - microcontroller (ARM Cortex-M3). - -boards/arm/stm32/stm3240g-eval - STMicro STM3240G-EVAL development board based on the STMicro STM32F103ZET6 - microcontroller (ARM Cortex-M4 with FPU). This port uses a GNU Cortex-M4 - toolchain (such as CodeSourcery). - -boards/arm/stm32/stm32butterfly2 - Kamami stm32butterfly2 development board with optional ETH phy. See - https://kamami.pl/zestawy-uruchomieniowe-stm32/178507-stm32butterfly2.html - -boards/arm/stm32/stm32f051-discovery - STMicro STM32F051-Discovery board based on the STMicro ARCH_CHIP_STM32F051R8 - MCU. - -boards/arm/stm32/stm32f072-discovery - STMicro STM32F072-Discovery board based on the STMicro ARCH_CHIP_STM32F072RB - MCU. - -boards/arm/stm32/stm32f103-minimum - Generic STM32F103C8T6 Minimum ARM Development Board. - -boards/arm/stm32/stm32f4discovery - STMicro STM32F4-Discovery board based on the STMicro STM32F407VGT6 MCU. - -boards/arm/stm32/stm32f411e-disco - This is a minimal configuration that supports low-level test of the - STMicro STM32F411E-Discovery Board. - -boards/arm/stm32/stm32f429i-disco - STMicro STM32F429I-Discovery board based on the STMicro STM32F429ZIT6 MCU. - -boards/arm/stm32f7/stm32f746g-disco - STMicro STM32F746G-DISCO development board featuring the STM32F746NGH6 - MCU. The STM32F746NGH6 is a 216MHz Cortex-M7 operation with 1024Kb Flash - memory and 300Kb SRAM. - -boards/arm/stm32f7/stm32f746g-ws - Waveshare STM32F746 development board featuring the STM32F746IG MCU. - -boards/arm/stm32l4/stm32l476-mdk - Motorola Mods Development Board (MDK) features STM32L476ME MCU. - The STM32L476ME is a Cortex-M4 optimised for low-power operation - at up to 80MHz operation with 1024Kb Flash memory and 96+32Kb SRAM. - -boards/arm/stm32f7/stm32f769i-disco - NuttX configurations for the STMicro STM32F769I-DISCO development board - featuring the STM32F769NIH6 MCU. The STM32F769NIH6 is a 216MHz Cortex-M7 - operating with 2048K Flash memory and 512Kb SRAM. - -boards/arm/stm32l4/stm32l476vg-disco - STMicro STM32L476VG_DISCO development board featuring the STM32L476VG - MCU. The STM32L476VG is a Cortex-M4 optimised for low-power operation - at up to 80MHz operation with 1024Kb Flash memory and 96+32Kb SRAM. - -boards/arm/stm32/stm32ldiscovery - STMicro STM32L-Discovery board based on the STMicro STM32L152RB MCU. - -boards/arm/stm32/stm32vldiscovery - STMicro STM32VL-Discovery board based on the STMicro STM32F100RB MCU. - -boards/mips/pic32mx/sure-pic32mx - The "Advanced USB Storage Demo Board," Model DB-DP11215, from Sure - Electronics (http://www.sureelectronics.net/). This board features - the MicroChip PIC32MX440F512H. See also - http://www.sureelectronics.net/goods.php?id=1168 for further - information about the Sure DB-DP11215 board. - -boards/avr/at90usb/teensy-2.0 - This is the port of NuttX to the PJRC Teensy++ 2.0 board. This board is - developed by http://pjrc.com/teensy/. The Teensy++ 2.0 is based - on an Atmel AT90USB1286 MCU. - -boards/arm/kinetis/teensy-3.x - This is the port of NuttX to the Teensy-3.1 from PJRC - (https://www.pjrc.com/). The Teensy-3.1 features the Freescale - MK30DX256VLH7 chip (now NXP). The MK30DX256VLH7 is a 64-pin Cortex-M4 - running at 72MHz. It has 256KiB of program FLASH memory and 64KiB of - SRAM. For more information about the Teensy 3.1, see - - https://www.pjrc.com/teensy/teensy31.html - https://www.pjrc.com/store/teensy31.html - - This board configuration can also be used with the older Teensy-3.0. The - Teensy-3.0 has the same schematic (although some pins are not used on the - Teensy-3.0). the primary difference is that the Teensy 3.0 has a - MK30DX128VLH5 with slightly less capability. - -boards/arm/imxrt/teensy-4.x - This is the port of NuttX to the PJRC Teensy++ 4.x board. This board is - developed by http://pjrc.com/teensy/. The Teensy++ 4.x is based - on an NXP MIMXRT1062DVL6A MCU. The port can support both Teensy 4.0 and - Teensy 4.1 boards. - - https://www.pjrc.com/store/teensy40.html - https://www.pjrc.com/store/teensy41.html - -boards/arm/kl/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. - -boards/arm/tiva/tm4c123g-launchpad - This is the port of NuttX to the Tiva TM4C123G LaunchPad. The - Tiva TM4C123G LaunchPad Evaluation Board is a low-cost evaluation - platform for ARM Cortex-M4F-based microcontrollers from Texas - Instruments. - -boards/arm/tiva/tm4c1294-launchpad - This is the port of NuttX to the Tiva TM4C1294 LaunchPad. The - Tiva TM4C123G LaunchPad Evaluation Board is a low-cost evaluation - platform for ARM Cortex-M4F-based microcontrollers from Texas - Instruments. - -boards/arm/tiva/tm4c129e-launchpad - This is a port of NuttX to the Tiva TM4C129E Crypto Connected LaunchPad. This - board is a low-cost evaluation platform for ARM Cortex-M4F-based - microcontrollers from Texas Instruments. - -boards/arm/tmx570/tms570ls31x-usb-kit - TI Hercules TMS570LS31xx Evaluation Kit (TMDS570ls31xx USB Kit) - featuring the Hercules TMS570LS3137ZWT chip. - -boards/arm/kinetis/twr-k60n512 - Kinetis K60 Cortex-M4 MCU. This port uses the FreeScale TWR-K60N512 - development board. - -boards/arm/kinetis/twr-k64f120m - Kinetis K64 Cortex-M4 MCU. This port uses the FreeScale TWR-K64F120M - development board. - -boards/mips/pic32mx/ubw32 - This is the port to the Sparkfun UBW32 board. This port uses the original v2.4 - board which is based on the MicroChip PIC32MX460F512L. See - http://www.sparkfun.com/products/8971. This older version has been replaced - with this board http://www.sparkfun.com/products/9713. See also - http://www.schmalzhaus.com/UBW32/. - -boards/renesas/sh1/us7032evb1 - This is a port of the Hitachi SH-1 on the Hitachi SH-1/US7032EVB1 board. - STATUS: Work has just began on this port. - -boards/arm/stm32/viewtool-stm32f107 - NuttX configurations for the ViewTool STM32F103/F107 V1.2 board. This - board may be fitted with either: (1) STM32F107VCT6 or (2) STM32F103VCT6. - See http://www.viewtool.com/ for further information. - -config/xmc4500-relax - Infineon XMC4500 Relax Lite v1 - -config/xmc4700-relax - Infineon XMC4700 Relax - -boards/z16/z16f/z16f2800100zcog - z16f Microcontroller. This port use the Zilog z16f2800100zcog - development kit and the Zilog ZDS-II Windows command line tools. The - development environment is Cygwin under WinXP. - -boards/z80/ez80/z20x - Microcontroller. This directory holds the port of NuttX to the z80x board - based on an ez80Acclaim! eZ80F091 microcontroller. - -boards/z80/z80/z80sim - z80 Microcontroller. This port uses a Z80 instruction set simulator - called z80sim. This port also uses the SDCC toolchain - (http://sdcc.sourceforge.net/") (verified with version 2.6.0). - -boards/z80/z8/z8encore000zco - z8Encore! Microcontroller. This port use the Zilog z8encore000zco - development kit, Z8F6403 part, and the Zilog ZDS-II Windows command line - tools. The development environment is Cygwin under WinXP. - -boards/z80/z8/z8f64200100kit - z8Encore! Microcontroller. This port use the Zilog z8f64200100kit - development kit, Z8F6423 part, and the Zilog ZDS-II Windows command line - tools. The development environment is Cygwin under WinXP. - -boards/arm/lpc214x/zp214xpa - This port is for the NXP LPC2148 as provided on the The0.net - ZPA213X/4XPA development board. Includes support for the - UG-2864AMBAG01 OLED also from The0.net - -boards/arm/lpc17xx_40xx/zkit-arm-1769 - Zilogic System's ARM development Kit, ZKIT-ARM-1769. This board is based - on the NXP LPC1769. The NuttX Buildroot toolchain is used by default. - -Configuring NuttX -^^^^^^^^^^^^^^^^^ - -Configuring NuttX requires only copying - - boards/////Make.def to ${TOPDIR}/Make.defs - boards/////defconfig to ${TOPDIR}/.config - -tools/configure.sh - There is a script that automates these steps. The following steps will - accomplish the same configuration: - - tools/configure.sh : - - There is an alternative Windows batch file that can be used in the - windows native environment like: - - tools\configure.bat : - - See tools/README.txt for more information about these scripts. - - And if your application directory is not in the standard location (../apps - or ../apps-), then you should also specify the location of the - application directory on the command line like: - - cd tools - ./configure.sh -a : - -Building Symbol Tables -^^^^^^^^^^^^^^^^^^^^^^ - -Symbol tables are needed at several of the binfmt interfaces in order to bind -a module to the base code. These symbol tables can be tricky to create and -will probably have to be tailored for any specific application, balancing -the number of symbols and the size of the symbol table against the symbols -required by the applications. - -The top-level System.map file is one good source of symbol information -(which, or course, was just generated from the top-level nuttx file -using the GNU 'nm' tool). - -There are also common-separated value (CSV) values in the source try that -provide information about symbols. In particular: - - nuttx/syscall/syscall.csv - Describes the NuttX RTOS interface, and - nuttx/lib/libc.csv - Describes the NuttX C library interface. - -There is a tool at nuttx/tools/mksymtab that will use these CSV files as -input to generate a generic symbol table. See nuttx/tools/README.txt for -more information about using the mksymtab tool. diff --git a/boards/arm/dm320/ntosd-dm320/doc/README.txt b/boards/arm/dm320/ntosd-dm320/doc/README.txt deleted file mode 100644 index 4761cb9d24c..00000000000 --- a/boards/arm/dm320/ntosd-dm320/doc/README.txt +++ /dev/null @@ -1,75 +0,0 @@ -NuttX on the Neuros Technology OSD -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -References: -^^^^^^^^^^^ - -http://wiki.neurostechnology.com/index.php/Main_Page -http://wiki.neurostechnology.com/index.php/OSD_Developer_Home -http://wiki.neurostechnology.com/index.php/DM320_Platform_development -http://wiki.neurostechnology.com/index.php/The_Neuros_and_Open_Source -... - -Status: -^^^^^^^ - -NOTE: These instructions are for the Neuros development board (and a -rather old version of NuttX), -http://wiki.neurostechnology.com/index.php/OSD_Developer_Board_v1 -and have _not_ been updated for the Neuros OSD 1.0 consumer unit -(or for the current version of NuttX), -http://wiki.neurostechnology.com/index.php/Neuros_OSD_1.0 - -At present, the system only supports a serial console and timer -interrupts so there is not to much that you can do with it. But I -would be happy to work with anyone who is interested in using it. - -General instructions. - -1. Download build-0.1.0.tar.gz and nuttx-0.2.3.tar.gz into the same - . These are the current versions as of this writing - (but could very well new older release now). - -2. Unpack, you should now have /buildroot and - /nuttx-0.2.3 - -3. Rename nuttx-0.2.3 to nuttx - -4. Configure NuttX: - - cd /nuttx/tools - ./configure.sh ntosd-dm320:nsh - -5. Build the toolchain: - - cd /buildroot - cp boards/c5471-defconfig .config - make oldconfig - make - -6. Build NuttX: - - cd nuttx - make - mv nuttx /tftpboot/nuttx.dm320 - - You may also have to modify the PATH environment variable if your make cannot - find the tools. - -7. Configure the OSD u-boot: - - Neuros Devboard > set ipaddr yy.yy.yy.yy - Neuros Devboard > set serverip xx.xx.xx.xx - Neuros Devboard > ... - Neuros Devboard > run update-ipstatic - - where yy.yy.yy.yy is the OSD IP address and xx.xx.xx.xx is - the host PC address. - -8. Load and run nuttx from uboot - - tftpboot xx.xx.xx.xx nuttx.dm320 - go 1008000 - -What will run is an a simple OS test that will verify many of the -features of the OS. (this is nutts/examples/ostest). diff --git a/boards/arm/phy62xx/phy6222/README.txt b/boards/arm/phy62xx/phy6222/README.txt deleted file mode 100644 index 243dee33768..00000000000 --- a/boards/arm/phy62xx/phy6222/README.txt +++ /dev/null @@ -1,17 +0,0 @@ -STATUS -====== - -05/17: The basic NSH configuration is functional and shows that there is - 3-4KB of free heap space. However, attempts to extend this have - failed. I suspect that 8KB of SRAM is insufficient to do much - with the existing NSH configuration. Perhaps some fine tuning - can improve this situation but at this point, I think this board - is only useful for the initial STM32 F0 bring-up, perhaps for - embedded solutions that do not use NSH and for general - experimentation. - - There is also support for the Nucleo boards with the STM32 F072 - and F092 MCUs. Those ports do not suffer from these problems and - seem to work well in fairly complex configurations. Apparently 8KB - is SRAM is not usable but the parts with larger 16KB and 32KB SRAMs - are better matches. diff --git a/boards/arm/s32k1xx/rddrone-bms772/README.txt b/boards/arm/s32k1xx/rddrone-bms772/README.txt deleted file mode 100644 index bb1ade02550..00000000000 --- a/boards/arm/s32k1xx/rddrone-bms772/README.txt +++ /dev/null @@ -1,142 +0,0 @@ -README -====== - -This directory holds the port to the NXP RDDRONE-BMS772 board with S32K144 -MCU. - -A NuttX compatible smart battery application for RDDRONE-BMS772 is also -available. It contains additional drivers and example software to use -most features of the battery management system. - -This application is currently published in a separate repository, but -(parts) may eventually be upstreamed to Apache NuttX: -https://github.com/NXPHoverGames/RDDRONE-BMS772 - - -Contents -======== - - o Status - o Serial Console - o LEDs - o Thread-Aware Debugging with Eclipse - o Configurations - -Status -====== - - 2020-11-02: Configuration first published in separate GitHub repository. - Tested with the aforementioned BMS application. - - 2022-05-25: Basic board configuration prepared for upstreaming to Apache NuttX. - -Serial Console -============== - - By default, the serial console will be provided on the DCD-LZ UART - (available on the 7-pin DCD-LZ debug connector J19): - - DCD-LZ UART RX PTC6 (LPUART1_RX) - DCD-LZ UART TX PTC7 (LPUART1_TX) - -LEDs and Buttons -================ - - LEDs - ---- - The RDDRONE-BMS772 has one RGB LED: - - RedLED PTD16 (FTM0 CH1) - GreenLED PTB13 (FTM0 CH1) - BlueLED PTD15 (FTM0 CH0) - - An output of '0' illuminates the LED. - - If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in - any way. The following definitions are used to access individual RGB - components (see rddrone-bms772.h): - - GPIO_LED_R - GPIO_LED_G - GPIO_LED_B - - The RGB components could, alternatively, be controlled through PWM using - the common RGB LED driver. - - If CONFIG_ARCH_LEDs is defined, then NuttX will control the LEDs on board - the RDDRONE-BMS772. The following definitions describe how NuttX controls - the LEDs: - - ==========================================+========+========+========= - RED GREEN BLUE - ==========================================+========+========+========= - - LED_STARTED NuttX has been started OFF OFF OFF - LED_HEAPALLOCATE Heap has been allocated OFF OFF ON - LED_IRQSENABLED Interrupts enabled OFF OFF ON - LED_STACKCREATED Idle stack created OFF ON OFF - LED_INIRQ In an interrupt (no change) - LED_SIGNAL In a signal handler (no change) - LED_ASSERTION An assertion failed (no change) - LED_PANIC The system has crashed FLASH OFF OFF - LED_IDLE S32K144 in sleep mode (no change) - ==========================================+========+========+========= - -Thread-Aware Debugging with Eclipse -=================================== - - Thread-aware debugging is possible with openocd-nuttx - ( https://github.com/sony/openocd-nuttx ) and was tested together with the - Eclipse-based S32 Design Studio for Arm: - https://www.nxp.com/design/software/development-software/s32-design-studio-ide/s32-design-studio-for-arm:S32DS-ARM - - NOTE: This method was last tested with NuttX 8.2 and S32DS for Arm 2018.R1. - It may not work anymore with recent releases of NuttX and/or S32DS. - - 1. NuttX should be build with debug symbols enabled. - - 2. Build OpenOCD as described here (using the same parameters as well): - https://micro.ros.org/docs/tutorials/old/debugging/ - - 3. A s32k144.cfg file is available in the scripts/ folder. Start OpenOCD - with the following command (adapt the path info): - /usr/local/bin/openocd -f /usr/share/openocd/scripts/interface/jlink.cfg \ - -f boards/s32k1xx/rddrone-bms772/scripts/s32k144.cfg -c init -c "reset halt" - - 4. Setup a GDB debug session in Eclipse. The resulting debug window shows - the NuttX threads. The full stack details can be viewed. - -Configurations -============== - - Common Information - ------------------ - Each RDDRONE-BMS772 configuration is maintained in a sub-directory and can be - selected as follows: - - tools/configure.sh rddrone-bms772: - - Where is one of the sub-directories listed in the next paragraph. - - NOTES (common for all configurations): - - 1. This configuration uses the mconf-based configuration tool. To change - this configuration using that tool, you should: - - a. Build and install the kconfig-mconf tool. See nuttx/README.txt. - Also see additional README.txt files in the NuttX tools repository. - - b. Execute 'make menuconfig' in nuttx/ in order to start the - reconfiguration process. - - 2. Unless otherwise stated, the serial console used is LPUART1 at - 115,200 8N1. This corresponds to the OpenSDA VCOM port. - - Configuration Sub-directories - ----------------------------- - - nsh: - --- - Configures the NuttShell (nsh) located at apps/examples/nsh. Support - for builtin applications is enabled, but in the base configuration the - only application selected is the "Hello, World!" example. diff --git a/boards/arm/s32k1xx/s32k118evb/README.txt b/boards/arm/s32k1xx/s32k118evb/README.txt deleted file mode 100644 index 04a0a02b99d..00000000000 --- a/boards/arm/s32k1xx/s32k118evb/README.txt +++ /dev/null @@ -1,153 +0,0 @@ -README -====== - -This directory holds the port to the NXP S32K118EVB-Q064 development board. - -Contents -======== - - o Status - o Serial Console - o LEDs and Buttons - o OpenSDA Notes - o Configurations - -Status -====== - - 2019-08-14: Configuration created but entirely untested. - - 2019-08-17: The port is code complete. It compiles with no errors or - warnings but is untested. Still waiting for hardware. - - 2019-08-20: The very first image that I wrote to FLASH seems to have - "bricked" the board. The board is sensitive to (1) resetting into a bad - state and (2) incorrect flash configurations. It is difficult to - impossible to recover from these start-up errors. - - 2019-08-22: My S32K118EVB is still borked, but after some additional - changes, Fabio Balzano has verified that the NSH is functional on that - board. - - 2019-10-19: The aforementioned fixes for the FLASH issues were converted - into a set of FLASH configuration options, with a proven default state. - - 2020-06-15: Added FlexCAN driver with SocketCAN support to the S32K1XX - arch. Might work on the S32K118EVB as well, but remains untested. - - 2020-06-16: Added Emulated EEPROM driver and initialization. - - TODO: Need to calibrate the delay loop. The current value of - CONFIG_BOARD_LOOPSPERMSEC is a bogus value retained from a copy-paste - (see apps/examples/calib_udelay). - -Serial Console -============== - - By default, the serial console will be provided on the OpenSDA VCOM port: - - OpenSDA UART RX PTB0 (LPUART0_RX) - OpenSDA UART TX PTB1 (LPUART0_TX) - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - -LEDs and Buttons -================ - - LEDs - ---- - The S32K118EVB has one RGB LED: - - RedLED PTD16 (FTM0 CH1) - GreenLED PTD15 (FTM0 CH0) - BlueLED PTE8 (FTM0 CH6) - - An output of '1' illuminates the LED. - - If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in - any way. The following definitions are used to access individual RGB - components (see s32k118evb.h): - - GPIO_LED_R - GPIO_LED_G - GPIO_LED_B - - The RGB components could, alternatively, be controlled through PWM using - the common RGB LED driver. - - If CONFIG_ARCH_LEDs is defined, then NuttX will control the LEDs on board - the S32K118EVB. The following definitions describe how NuttX controls the - LEDs: - - ==========================================+========+========+========= - RED GREEN BLUE - ==========================================+========+========+========= - - LED_STARTED NuttX has been started OFF OFF OFF - LED_HEAPALLOCATE Heap has been allocated OFF OFF ON - LED_IRQSENABLED Interrupts enabled OFF OFF ON - LED_STACKCREATED Idle stack created OFF ON OFF - LED_INIRQ In an interrupt (no change) - LED_SIGNAL In a signal handler (no change) - LED_ASSERTION An assertion failed (no change) - LED_PANIC The system has crashed FLASH OFF OFF - LED_IDLE S32K118 in sleep mode (no change) - ==========================================+========+========+========= - - Buttons - ------- - The S32K118EVB supports two buttons: - - SW2 PTD3 - SW3 PTD5 - -OpenSDA Notes -============= - - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - - - The drag'n'drog interface expects files in .srec format. - - - Using Segger J-Link: Easy... but remember to use the SWD connector J14 - near the touch electrodes and not the OpenSDA connector near the OpenSDA - USB connector J7. - -Configurations -============== - - Common Information - ------------------ - Each S32K118EVB configuration is maintained in a sub-directory and can be - selected as follows: - - tools/configure.sh s32k118evb: - - Where is one of the sub-directories listed in the next paragraph. - - NOTES (common for all configurations): - - 1. This configuration uses the mconf-based configuration tool. To change - this configuration using that tool, you should: - - a. Build and install the kconfig-mconf tool. See nuttx/README.txt. - Also see additional README.txt files in the NuttX tools repository. - - b. Execute 'make menuconfig' in nuttx/ in order to start the - reconfiguration process. - - 2. Unless otherwise stated, the serial console used is LPUART0 at - 115,200 8N1. This corresponds to the OpenSDA VCOM port. - - Configuration Sub-directories - ----------------------------- - - nsh: - --- - Configures the NuttShell (nsh) located at apps/examples/nsh. Support - for builtin applications is enabled, but in the base configuration no - builtin applications are selected. - - NOTE: This is a very minimal NSH configuration in order to reduce - memory usage. Most of the NSH niceties are not available. diff --git a/boards/arm/s32k1xx/s32k144evb/README.txt b/boards/arm/s32k1xx/s32k144evb/README.txt deleted file mode 100644 index 918e977f727..00000000000 --- a/boards/arm/s32k1xx/s32k144evb/README.txt +++ /dev/null @@ -1,157 +0,0 @@ -README -====== - -This directory holds the port to the NXP S32K144EVB-Q100 development board. - -Contents -======== - - o Status - o Serial Console - o LEDs and Buttons - o OpenSDA Notes - o Thread-Aware Debugging with Eclipse - o Configurations - -Status -====== - - 2020-01-23: Configuration created (copy-paste from S32K146EVB). - Tested: Serial console, I2C, SPI. - - 2020-06-15: Added FlexCAN driver with SocketCAN support to the S32K1XX - arch. Should work also on the S32K144EVB board, but remains untested. - - 2020-06-16: Added Emulated EEPROM driver and initialization. - -Serial Console -============== - - By default, the serial console will be provided on the OpenSDA VCOM port: - - OpenSDA UART RX PTC6 (LPUART1_RX) - OpenSDA UART TX PTC7 (LPUART1_TX) - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - -LEDs and Buttons -================ - - LEDs - ---- - The S32K144EVB has one RGB LED: - - RedLED PTD15 (FTM0 CH0) - GreenLED PTD16 (FTM0 CH1) - BlueLED PTD0 (FTM0 CH2) - - An output of '0' illuminates the LED. - - If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in - any way. The following definitions are used to access individual RGB - components (see s32k144evb.h): - - GPIO_LED_R - GPIO_LED_G - GPIO_LED_B - - The RGB components could, alternatively, be controlled through PWM using - the common RGB LED driver. - - If CONFIG_ARCH_LEDs is defined, then NuttX will control the LEDs on board - the S32K144EVB. The following definitions describe how NuttX controls the - LEDs: - - ==========================================+========+========+========= - RED GREEN BLUE - ==========================================+========+========+========= - - LED_STARTED NuttX has been started OFF OFF OFF - LED_HEAPALLOCATE Heap has been allocated OFF OFF ON - LED_IRQSENABLED Interrupts enabled OFF OFF ON - LED_STACKCREATED Idle stack created OFF ON OFF - LED_INIRQ In an interrupt (no change) - LED_SIGNAL In a signal handler (no change) - LED_ASSERTION An assertion failed (no change) - LED_PANIC The system has crashed FLASH OFF OFF - LED_IDLE S32K144 in sleep mode (no change) - ==========================================+========+========+========= - - Buttons - ------- - The S32K144EVB supports two buttons: - - SW2 PTC12 - SW3 PTC13 - -OpenSDA Notes -============= - - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - - - The drag'n'drog interface expects files in .srec format. - - - Using Segger J-Link: Easy... but remember to use the SWD connector J14 - in the center of the board and not the OpenSDA connector closer to the - OpenSDA USB connector J7. - -Thread-Aware Debugging with Eclipse -=================================== - - Thread-aware debugging is possible with openocd-nuttx - ( https://github.com/sony/openocd-nuttx ) and was tested together with the - Eclipse-based S32 Design Studio for Arm: - https://www.nxp.com/design/software/development-software/s32-design-studio-ide/s32-design-studio-for-arm:S32DS-ARM - - NOTE: This method was last tested with NuttX 8.2 and S32DS for Arm 2018.R1. - It may not work anymore with recent releases of NuttX and/or S32DS. - - 1. NuttX should be build with debug symbols enabled. - - 2. Build OpenOCD as described here (using the same parameters as well): - https://micro.ros.org/docs/tutorials/old/debugging/ - - 3. A s32k144.cfg file is available in the scripts/ folder. Start OpenOCD - with the following command (adapt the path info): - /usr/local/bin/openocd -f /usr/share/openocd/scripts/interface/jlink.cfg \ - -f boards/s32k1xx/s32k144evb/scripts/s32k144.cfg -c init -c "reset halt" - - 4. Setup a GDB debug session in Eclipse. The resulting debug window shows - the NuttX threads. The full stack details can be viewed. - -Configurations -============== - - Common Information - ------------------ - Each S32K144EVB configuration is maintained in a sub-directory and can be - selected as follows: - - tools/configure.sh s32k144evb: - - Where is one of the sub-directories listed in the next paragraph. - - NOTES (common for all configurations): - - 1. This configuration uses the mconf-based configuration tool. To change - this configuration using that tool, you should: - - a. Build and install the kconfig-mconf tool. See nuttx/README.txt. - Also see additional README.txt files in the NuttX tools repository. - - b. Execute 'make menuconfig' in nuttx/ in order to start the - reconfiguration process. - - 2. Unless otherwise stated, the serial console used is LPUART1 at - 115,200 8N1. This corresponds to the OpenSDA VCOM port. - - Configuration Sub-directories - ----------------------------- - - nsh: - --- - Configures the NuttShell (nsh) located at apps/examples/nsh. Support - for builtin applications is enabled, but in the base configuration the - only application selected is the "Hello, World!" example. diff --git a/boards/arm/s32k1xx/s32k146evb/README.txt b/boards/arm/s32k1xx/s32k146evb/README.txt deleted file mode 100644 index 64edeadf22a..00000000000 --- a/boards/arm/s32k1xx/s32k146evb/README.txt +++ /dev/null @@ -1,187 +0,0 @@ -README -====== - -This directory holds the port to the NXP S32K146EVB-Q144 development board. - -Contents -======== - - o Status - o Serial Console - o LEDs and Buttons - o OpenSDA Notes - o Thread-Aware Debugging with Eclipse - o Configurations - -Status -====== - - 2019-08-18: Configuration created but entirely untested. - - 2019-08-20: For initial testing, I ran out of SRAM to avoid the - brickage problems I had with the S32K118EVB (i.e., with - CONFIG_BOOT_RUNFROMISRAM=y). In this mode, the NSH configuration - appears to work correctly. - - 2019-08-21: Writing a relocated version of that same functional binary - into FLASH, however, did not work and, in fact, bricked my S32K146EVB. - That is because the first version of the FLASH image that I used - clobbered the FLASH Configuration bytes at address 0x0400 (I - didn't even know about these!). I have since modified the linker script - to skip this address in FLASH. There is some fragmentary discussion - for recovery from this condition at the NXP Community Forums, but none of - those options are working for me: - https://community.nxp.com/thread/505593 - - Given the success running from SRAM and the success of the same fixes - on the S32K118, I believe that the NSH configuration should now run out - of FLASH. Unfortunately, I cannot demonstrate that. - - 2019-10-19: The NXP Mobile Robotics team has demonstrated that the basic - NSH configuration runs out of FLASH without issues. The aforementioned - fixes for the FLASH issues were converted into a set of FLASH - configuration options, with a proven default state. - - 2019-11-07: A s32k146.cfg configuration file (for OpenOCD) was added to - the scripts/ folder. - - 2020-06-15: Added FlexCAN driver with SocketCAN support to the S32K1XX - arch. Should work also on the S32K146EVB board, but remains untested. - - 2020-06-16: Added Emulated EEPROM driver and initialization. - - TODO: Need to calibrate the delay loop. The current value of - CONFIG_BOARD_LOOPSPERMSEC is a bogus value retained from a copy-paste - (see apps/examples/calib_udelay). - -Serial Console -============== - - By default, the serial console will be provided on the OpenSDA VCOM port: - - OpenSDA UART RX PTC6 (LPUART1_RX) - OpenSDA UART TX PTC7 (LPUART1_TX) - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - -LEDs and Buttons -================ - - LEDs - ---- - The S32K146EVB has one RGB LED: - - RedLED PTD15 (FTM0 CH0) - GreenLED PTD16 (FTM0 CH1) - BlueLED PTD0 (FTM0 CH2) - - An output of '1' illuminates the LED. - - If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in - any way. The following definitions are used to access individual RGB - components (see s32k146evb.h): - - GPIO_LED_R - GPIO_LED_G - GPIO_LED_B - - The RGB components could, alternatively, be controlled through PWM using - the common RGB LED driver. - - If CONFIG_ARCH_LEDs is defined, then NuttX will control the LEDs on board - the S32K146EVB. The following definitions describe how NuttX controls the - LEDs: - - ==========================================+========+========+========= - RED GREEN BLUE - ==========================================+========+========+========= - - LED_STARTED NuttX has been started OFF OFF OFF - LED_HEAPALLOCATE Heap has been allocated OFF OFF ON - LED_IRQSENABLED Interrupts enabled OFF OFF ON - LED_STACKCREATED Idle stack created OFF ON OFF - LED_INIRQ In an interrupt (no change) - LED_SIGNAL In a signal handler (no change) - LED_ASSERTION An assertion failed (no change) - LED_PANIC The system has crashed FLASH OFF OFF - LED_IDLE S32K146 in sleep mode (no change) - ==========================================+========+========+========= - - Buttons - ------- - The S32K146EVB supports two buttons: - - SW2 PTC12 - SW3 PTC13 - -OpenSDA Notes -============= - - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - - - The drag'n'drog interface expects files in .srec format. - - - Using Segger J-Link: Easy... but remember to use the SWD connector J14 - in the center of the board and not the OpenSDA connector closer to the - OpenSDA USB connector J7. - -Thread-Aware Debugging with Eclipse -=================================== - - Thread-aware debugging is possible with openocd-nuttx - ( https://github.com/sony/openocd-nuttx ) and was tested together with the - Eclipse-based S32 Design Studio for Arm: - https://www.nxp.com/design/software/development-software/s32-design-studio-ide/s32-design-studio-for-arm:S32DS-ARM - - NOTE: This method was last tested with NuttX 8.2 and S32DS for Arm 2018.R1. - It may not work anymore with recent releases of NuttX and/or S32DS. - - 1. NuttX should be build with debug symbols enabled. - - 2. Build OpenOCD as described here (using the same parameters as well): - https://micro.ros.org/docs/tutorials/old/debugging/ - - 3. A s32k146.cfg file is available in the scripts/ folder. Start OpenOCD - with the following command (adapt the path info): - /usr/local/bin/openocd -f /usr/share/openocd/scripts/interface/jlink.cfg \ - -f boards/s32k1xx/s32k146evb/scripts/s32k146.cfg -c init -c "reset halt" - - 4. Setup a GDB debug session in Eclipse. The resulting debug window shows - the NuttX threads. The full stack details can be viewed. - -Configurations -============== - - Common Information - ------------------ - Each S32K146EVB configuration is maintained in a sub-directory and can be - selected as follows: - - tools/configure.sh s32k146evb: - - Where is one of the sub-directories listed in the next paragraph. - - NOTES (common for all configurations): - - 1. This configuration uses the mconf-based configuration tool. To change - this configuration using that tool, you should: - - a. Build and install the kconfig-mconf tool. See nuttx/README.txt. - Also see additional README.txt files in the NuttX tools repository. - - b. Execute 'make menuconfig' in nuttx/ in order to start the - reconfiguration process. - - 2. Unless otherwise stated, the serial console used is LPUART1 at - 115,200 8N1. This corresponds to the OpenSDA VCOM port. - - Configuration Sub-directories - ----------------------------- - - nsh: - --- - Configures the NuttShell (nsh) located at apps/examples/nsh. Support - for builtin applications is enabled, but in the base configuration the - only application selected is the "Hello, World!" example. diff --git a/boards/arm/s32k1xx/s32k148evb/README.txt b/boards/arm/s32k1xx/s32k148evb/README.txt deleted file mode 100644 index 7a713875e14..00000000000 --- a/boards/arm/s32k1xx/s32k148evb/README.txt +++ /dev/null @@ -1,139 +0,0 @@ -README -====== - -This directory holds the port to the NXP S32K148EVB-Q176 development board. - -Contents -======== - - o Status - o Serial Console - o LEDs and Buttons - o OpenSDA Notes - o Configurations - -Status -====== - - 2019-08-20: NSH configuration created but entirely untested. - - 2019-08-24: NSH configuration verified running from FLASH. - - 2019-10-19: FLASH configuration options were added. - - 2020-06-15: Added FlexCAN driver with SocketCAN support to the S32K1XX - arch. This feature been tested extensively with the S32K148EVB. - - 2020-06-16: Added Emulated EEPROM driver and initialization. - - TODO: Need to calibrate the delay loop. The current value of - CONFIG_BOARD_LOOPSPERMSEC is a bogus value retained from a copy-paste - (see apps/examples/calib_udelay). - -Serial Console -============== - - By default, the serial console will be provided on the OpenSDA VCOM port: - - OpenSDA UART TX PTC7 (LPUART1_TX) - OpenSDA UART RX PTC6 (LPUART1_RX) - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - -LEDs and Buttons -================ - - LEDs - ---- - The S32K148EVB has one RGB LED: - - RedLED PTE21 (FTM4 CH1) - GreenLED PTE22 (FTM4 CH2) - BlueLED PTE23 (FTM4 CH3) - - An output of '1' illuminates the LED. - - If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in - any way. The following definitions are used to access individual RGB - components (see s32k148evb.h): - - GPIO_LED_R - GPIO_LED_G - GPIO_LED_B - - The RGB components could, alternatively, be controlled through PWM using - the common RGB LED driver. - - If CONFIG_ARCH_LEDs is defined, then NuttX will control the LEDs on board - the S32K148EVB. The following definitions describe how NuttX controls the - LEDs: - - ==========================================+========+========+========= - RED GREEN BLUE - ==========================================+========+========+========= - - LED_STARTED NuttX has been started OFF OFF OFF - LED_HEAPALLOCATE Heap has been allocated OFF OFF ON - LED_IRQSENABLED Interrupts enabled OFF OFF ON - LED_STACKCREATED Idle stack created OFF ON OFF - LED_INIRQ In an interrupt (no change) - LED_SIGNAL In a signal handler (no change) - LED_ASSERTION An assertion failed (no change) - LED_PANIC The system has crashed FLASH OFF OFF - LED_IDLE S32K148 in sleep mode (no change) - ==========================================+========+========+========= - - Buttons - ------- - The S32K148EVB supports two buttons: - - SW3 PTC12 - SW4 PTC13 - -OpenSDA Notes -============= - - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - - - The drag'n'drog interface expects files in .srec format. - - - Using Segger J-Link: Easy... but remember to use the 20-pin SWD - connector J10 near the ethernet connector and not the 10-pin OpenSDA - connector J20 closer to the OpenSDA USB connector J24. - -Configurations -============== - - Common Information - ------------------ - Each S32K148EVB configuration is maintained in a sub-directory and can be - selected as follows: - - tools/configure.sh s32k148evb: - - Where is one of the sub-directories listed in the next paragraph. - - NOTES (common for all configurations): - - 1. This configuration uses the mconf-based configuration tool. To change - this configuration using that tool, you should: - - a. Build and install the kconfig-mconf tool. See nuttx/README.txt. - Also see additional README.txt files in the NuttX tools repository. - - b. Execute 'make menuconfig' in nuttx/ in order to start the - reconfiguration process. - - 2. Unless otherwise stated, the serial console used is LPUART1 at - 115,200 8N1. This corresponds to the OpenSDA VCOM port. - - Configuration Sub-directories - ----------------------------- - - nsh: - --- - Configures the NuttShell (nsh) located at apps/examples/nsh. Support - for builtin applications is enabled, but in the base configuration the - only application selected is the "Hello, World!" example. diff --git a/boards/arm/s32k1xx/ucans32k146/README.txt b/boards/arm/s32k1xx/ucans32k146/README.txt deleted file mode 100644 index 345bf240a54..00000000000 --- a/boards/arm/s32k1xx/ucans32k146/README.txt +++ /dev/null @@ -1,152 +0,0 @@ -README -====== - -This directory holds the port to the NXP UCANS32K146 boards. There exist a -few different revisions/variants of this board. All variants with the -S32K146 microcontroller are supported. - -Contents -======== - - o Status - o Serial Console - o LEDs and Buttons - o Thread-Aware Debugging with Eclipse - o Configurations - -Status -====== - - 2020-01-23: Configuration created (copy-paste from S32K146EVB). - Tested: Serial console, I2C, SPI. - - 2020-06-15: Added FlexCAN driver with SocketCAN support to the S32K1XX - arch, which has been tested with the UCANS32K146 board as well. - - 2020-06-16: Added Emulated EEPROM driver and initialization. - -Serial Console -============== - - By default, the serial console will be provided on the DCD-LZ UART - (available on the 7-pin DCD-LZ debug connector P6): - - OpenSDA UART RX PTC6 (LPUART1_RX) - OpenSDA UART TX PTC7 (LPUART1_TX) - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - -LEDs and Buttons -================ - - LEDs - ---- - The UCANS32K146 has one RGB LED: - - RedLED PTD15 (FTM0 CH0) - GreenLED PTD16 (FTM0 CH1) - BlueLED PTD0 (FTM0 CH2) - - An output of '0' illuminates the LED. - - If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in - any way. The following definitions are used to access individual RGB - components (see ucans32k146.h): - - GPIO_LED_R - GPIO_LED_G - GPIO_LED_B - - The RGB components could, alternatively, be controlled through PWM using - the common RGB LED driver. - - If CONFIG_ARCH_LEDs is defined, then NuttX will control the LEDs on board - the UCANS32K146. The following definitions describe how NuttX controls the - LEDs: - - ==========================================+========+========+========= - RED GREEN BLUE - ==========================================+========+========+========= - - LED_STARTED NuttX has been started OFF OFF OFF - LED_HEAPALLOCATE Heap has been allocated OFF OFF ON - LED_IRQSENABLED Interrupts enabled OFF OFF ON - LED_STACKCREATED Idle stack created OFF ON OFF - LED_INIRQ In an interrupt (no change) - LED_SIGNAL In a signal handler (no change) - LED_ASSERTION An assertion failed (no change) - LED_PANIC The system has crashed FLASH OFF OFF - LED_IDLE S32K146 in sleep mode (no change) - ==========================================+========+========+========= - - Buttons - ------- - The UCANS32K146 supports one button: - - SW3 PTC14 - -Thread-Aware Debugging with Eclipse -=================================== - - Thread-aware debugging is possible with openocd-nuttx - ( https://github.com/sony/openocd-nuttx ) and was tested together with the - Eclipse-based S32 Design Studio for Arm: - https://www.nxp.com/design/software/development-software/s32-design-studio-ide/s32-design-studio-for-arm:S32DS-ARM - - NOTE: This method was last tested with NuttX 8.2 and S32DS for Arm 2018.R1. - It may not work anymore with recent releases of NuttX and/or S32DS. - - 1. NuttX should be build with debug symbols enabled. - - 2. Build OpenOCD as described here (using the same parameters as well): - https://micro.ros.org/docs/tutorials/old/debugging/ - - 3. A s32k146.cfg file is available in the scripts/ folder. Start OpenOCD - with the following command (adapt the path info): - /usr/local/bin/openocd -f /usr/share/openocd/scripts/interface/jlink.cfg \ - -f boards/s32k1xx/ucans32k146/scripts/s32k146.cfg -c init -c "reset halt" - - 4. Setup a GDB debug session in Eclipse. The resulting debug window shows - the NuttX threads. The full stack details can be viewed. - -Configurations -============== - - Common Information - ------------------ - Each UCANS32K146 configuration is maintained in a sub-directory and can be - selected as follows: - - tools/configure.sh ucans32k146: - - Where is one of the sub-directories listed in the next paragraph. - - NOTES (common for all configurations): - - 1. This configuration uses the mconf-based configuration tool. To change - this configuration using that tool, you should: - - a. Build and install the kconfig-mconf tool. See nuttx/README.txt. - Also see additional README.txt files in the NuttX tools repository. - - b. Execute 'make menuconfig' in nuttx/ in order to start the - reconfiguration process. - - 2. Unless otherwise stated, the serial console used is LPUART1 at - 115,200 8N1. This corresponds to the OpenSDA VCOM port. - - Configuration Sub-directories - ----------------------------- - - nsh: - --- - Configures the NuttShell (nsh) located at apps/examples/nsh. Support - for builtin applications is enabled, but in the base configuration the - only application selected is the "Hello, World!" example. - - can: - --- - Besides the NuttShell this configuration also enables (Socket)CAN - support, as well as I2C and SPI support. It includes the SLCAN and - can-utils applications for monitoring and debugging CAN applications. diff --git a/boards/arm/s32k3xx/mr-canhubk3/README.txt b/boards/arm/s32k3xx/mr-canhubk3/README.txt deleted file mode 100644 index 3fe2805aaba..00000000000 --- a/boards/arm/s32k3xx/mr-canhubk3/README.txt +++ /dev/null @@ -1,116 +0,0 @@ -README -====== - -This directory holds the port to the NXP MR-CANHUBK3 board. - -Contents -======== - - o Status - o Serial Console - o LEDs and Buttons - o Configurations - -Status -====== - - 2021-09-28: Configuration created (copy-paste from S32K344EVB). - Remains untested, because hardware is not available yet. - - TODO: Need to calibrate the delay loop. The current value of - CONFIG_BOARD_LOOPSPERMSEC is a bogus value retained from a copy-paste - (see apps/examples/calib_udelay). - -Serial Console -============== - - By default, the serial console will be provided on the DCD-LZ UART - (available on the 7-pin DCD-LZ debug connector P6): - - DCD-LZ UART RX PTA8 (LPUART2_RX) - DCD-LZ UART TX PTA9 (LPUART2_TX) - -LEDs and Buttons -================ - - LEDs - ---- - The MR-CANHUBK3 has one RGB LED: - - RedLED PTE14 (FXIO D7 / EMIOS0 CH19) - GreenLED PTA27 (FXIO D5 / EMIOS1 CH10 / EMIOS2 CH10) - BlueLED PTE12 (FXIO D8 / EMIOS1 CH5) - - An output of '0' illuminates the LED. - - If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in - any way. The following definitions are used to access individual RGB - components (see mr-canhubk3.h): - - GPIO_LED_R - GPIO_LED_G - GPIO_LED_B - - The RGB components could, alternatively, be controlled through PWM using - the common RGB LED driver. - - If CONFIG_ARCH_LEDs is defined, then NuttX will control the LEDs on board - the MR-CANHUBK3. The following definitions describe how NuttX controls the - LEDs: - - ==========================================+========+========+========= - RED GREEN BLUE - ==========================================+========+========+========= - - LED_STARTED NuttX has been started OFF OFF OFF - LED_HEAPALLOCATE Heap has been allocated OFF OFF ON - LED_IRQSENABLED Interrupts enabled OFF OFF ON - LED_STACKCREATED Idle stack created OFF ON OFF - LED_INIRQ In an interrupt (no change) - LED_SIGNAL In a signal handler (no change) - LED_ASSERTION An assertion failed (no change) - LED_PANIC The system has crashed FLASH OFF OFF - LED_IDLE S32K344 in sleep mode (no change) - ==========================================+========+========+========= - - Buttons - ------- - The MR-CANHUBK3 supports two buttons: - - SW1 PTD15 (EIRQ31) - SW2 PTA25 (EIRQ5 / WKPU34) - -Configurations -============== - - Common Information - ------------------ - Each MR-CANHUBK3 configuration is maintained in a sub-directory and can be - selected as follows: - - tools/configure.sh mr-canhubk3: - - Where is one of the sub-directories listed in the next paragraph. - - NOTES (common for all configurations): - - 1. This configuration uses the mconf-based configuration tool. To change - this configuration using that tool, you should: - - a. Build and install the kconfig-mconf tool. See nuttx/README.txt. - Also see additional README.txt files in the NuttX tools repository. - - b. Execute 'make menuconfig' in nuttx/ in order to start the - reconfiguration process. - - 2. Unless otherwise stated, the serial console used is LPUART1 at - 115,200 8N1. This corresponds to the OpenSDA VCOM port. - - Configuration Sub-directories - ----------------------------- - - nsh: - --- - Configures the NuttShell (nsh) located at apps/examples/nsh. Support - for builtin applications is enabled, but in the base configuration the - only application selected is the "Hello, World!" example. diff --git a/boards/arm/s32k3xx/s32k344evb/README.txt b/boards/arm/s32k3xx/s32k344evb/README.txt deleted file mode 100644 index a873687a6d0..00000000000 --- a/boards/arm/s32k3xx/s32k344evb/README.txt +++ /dev/null @@ -1,134 +0,0 @@ -README -====== - -This directory holds the port to the NXP S32K344EVB-Q257 development board. - -Contents -======== - - o Status - o Serial Console - o LEDs and Buttons - o OpenSDA Notes - o Configurations - -Status -====== - - 2021-07-05: Configuration created. - - TODO: Need to calibrate the delay loop. The current value of - CONFIG_BOARD_LOOPSPERMSEC is a bogus value retained from a copy-paste - (see apps/examples/calib_udelay). - -Serial Console -============== - - By default, the serial console will be provided on the OpenSDA VCOM port: - - OpenSDA UART RX PTA15 (LPUART6_RX) - OpenSDA UART TX PTA16 (LPUART6_TX) - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - -LEDs and Buttons -================ - - LEDs - ---- - The S32K344EVB has two RGB LEDs: - - RedLED0 PTA29 (EMIOS1 CH12 / EMIOS2 CH12) - GreenLED0 PTA30 (EMIOS1 CH13 / EMIOS2 CH13) - BlueLED0 PTA31 (EMIOS1 CH14 / FXIO D0) - - RedLED1 PTB18 (EMIOS1 CH15 / EMIOS2 CH14 / FXIO D1) - GreenLED1 PTB25 (EMIOS1 CH21 / EMIOS2 CH21 / FXIO D6) - BlueLED1 PTE12 (EMIOS1 CH5 / FXIO D8) - - An output of '1' illuminates the LED. - - If CONFIG_ARCH_LEDS is not defined, then the user can control the LEDs in - any way. The following definitions are used to access individual RGB - components (see s32k344evb.h): - - GPIO_LED0_R - GPIO_LED0_G - GPIO_LED0_B - - GPIO_LED1_R - GPIO_LED1_G - GPIO_LED1_B - - The RGB components could, alternatively, be controlled through PWM using - the common RGB LED driver. - - If CONFIG_ARCH_LEDs is defined, then NuttX will control the LEDs on board - the S32K344EVB. The following definitions describe how NuttX controls the - LEDs: - - ==========================================+========+========+========= - RED GREEN BLUE - ==========================================+========+========+========= - - LED_STARTED NuttX has been started OFF OFF OFF - LED_HEAPALLOCATE Heap has been allocated OFF OFF ON - LED_IRQSENABLED Interrupts enabled OFF OFF ON - LED_STACKCREATED Idle stack created OFF ON OFF - LED_INIRQ In an interrupt (no change) - LED_SIGNAL In a signal handler (no change) - LED_ASSERTION An assertion failed (no change) - LED_PANIC The system has crashed FLASH OFF OFF - LED_IDLE S32K344 in sleep mode (no change) - ==========================================+========+========+========= - - Buttons - ------- - The S32K344EVB supports two buttons: - - SW0 PTB26 (EIRQ13 / WKPU41) - SW1 PTB19 (WKPU38) - -OpenSDA Notes -============= - - - USB drivers for the PEmicro CDC Serial Port are available here: - http://www.pemicro.com/opensda/ - - - The drag'n'drog interface expects files in .srec format. - -Configurations -============== - - Common Information - ------------------ - Each S32K344EVB configuration is maintained in a sub-directory and can be - selected as follows: - - tools/configure.sh s32k344evb: - - Where is one of the sub-directories listed in the next paragraph. - - NOTES (common for all configurations): - - 1. This configuration uses the mconf-based configuration tool. To change - this configuration using that tool, you should: - - a. Build and install the kconfig-mconf tool. See nuttx/README.txt. - Also see additional README.txt files in the NuttX tools repository. - - b. Execute 'make menuconfig' in nuttx/ in order to start the - reconfiguration process. - - 2. Unless otherwise stated, the serial console used is LPUART1 at - 115,200 8N1. This corresponds to the OpenSDA VCOM port. - - Configuration Sub-directories - ----------------------------- - - nsh: - --- - Configures the NuttShell (nsh) located at apps/examples/nsh. Support - for builtin applications is enabled, but in the base configuration the - only application selected is the "Hello, World!" example. diff --git a/boards/arm/xmc4/xmc4500-relax/README.txt b/boards/arm/xmc4/xmc4500-relax/README.txt deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/boards/arm/xmc4/xmc4700-relax/README.txt b/boards/arm/xmc4/xmc4700-relax/README.txt deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/boards/avr/atmega/mega1284p-xplained/README.txt b/boards/avr/atmega/mega1284p-xplained/README.txt deleted file mode 100644 index 950faa73d1f..00000000000 --- a/boards/avr/atmega/mega1284p-xplained/README.txt +++ /dev/null @@ -1,8 +0,0 @@ -README -^^^^^^ - -NuttX Documentation now is online! - -You can find the documentation to this board at: -https://nuttx.apache.org/docs/latest/platforms/avr/atmega/boards/mega1284p-xplained/index.html -