diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index 93a10ef460a..cb28103bef5 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -12,7 +12,7 @@
Last Updated: February 14, 2018
+Last Updated: March 22, 2018
@@ -412,35 +412,50 @@Configuration Files. - The NuttX configuration consists of: + The NuttX configuration consists of logic in processor architecture directories, chip/SoC directories, and board configuration directories. + The complete configuration is specified by several settings in the NuttX configuration file.
arch/<arch-name>/ directory
- and are discussed in a paragraph below.
-
- These chip-specific files are contained within chip-specific sub-directories in the
- arch/<arch-name>/ directory and are selected via
- the CONFIG_ARCH_name selection.
+ Processor architecture specific files.
+ These are the files contained in the arch/<arch-name>/ directory and are discussed in a paragraph below.
+ As an example, all ARM processor architectures are provided under the arch/arm/ directory which is selected with the CONFIG_ARCH="arm" configuration option.
+
+ Variants of the processor architecture may be provided in sub-directories of the
+ Extending this example, the ARMv7-M ARM family is supported by logic in arch/arm/include/armv7-m and arch/arm/src/armv7-m directories which are selected by the CONFIG_ARCH_CORTEXM3=y or CONFIG_ARCH_CORTEXM4=y configuration options
+ Chip/SoC specific files. + Each processor architecture is embedded in a System-on-a-Chip (SoC) architecture. + The full SoC architecture includes the processor architecture plus chip-specific interrupt logic, clocking logic, general purpose I/O (GPIO) logic, and specialized, internal peripherals (such as UARTs, USB, etc.). +
+
+ These chip-specific files are contained within chip-specific sub-directories also under the
+ arch/<arch-name>/ directory and are selected via
+ the CONFIG_ARCH_CHIP selection.
+
+ As an example, the STMicro STM32 SoC architecture is based on the ARMv7-M processor and is supported by logic in the arch/arm/include/stm32 and arch/arm/src/stm32 directories which are selected with the CONFIG_ARCH_CHIP="stm32" configuration setting.
+
+ Board specific configurations. + 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 networks, USB, etc.). +
These board-specific configuration files can be found in the
configs/<board-name>/ sub-directories and are discussed
in a paragraph below.
+ The directory configs/stm32f4disovery/, as an example, holds board-specific logic for the STM32F4 Discovery board and is selected via the CONFIG_ARCH_BOARD="stm32f4discovery" configuration setting.
+