+ NuttX README Files+Last Updated: October 14, 2009 + |
+
+ Additional information can be found in the Documentation/ directory and
+ also in README files that are scattered throughout the source tree.
+ Below is a guide to the available README files.
+ Some README files contain more important information than others.
+ The key README files are shown in BOLDFACE/ITALIC below.
+
+ . + | + |- arch/ + | | + | |- arm + | | `- src + | | `- lpc214x/README.txt + | |- sh/ + | | |- include/ + | | | |-m16c/README.txt + | | | |-sh1/README.txt + | | | `-README.txt + | | |- src/ + | | | |-common/README.txt + | | | |-m16c/README.txt + | | | |-sh1/README.txt + | | | `-README.txt + | `- z80/ + | | `- src/ + | | `- z80/README.txt + | `- README.txt + |- configs/ + | |- c5471evm/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- eagle100/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- ez80f910200kitg/ + | | |- ostest/README.txt + | | `- README.txt + | |- ez80f910200zco/ + | | |- dhcpd/README.txt + | | |- httpd/README.txt + | | |- nettest/README.txt + | | |- nsh/README.txt + | | |- ostest/README.txt + | | |- poll/README.txt + | | `- README.txt + | |- m68332evb/ + | | |- include/README.txt + | | `- src/README.txt + | |- mcu123-lpc214x/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- mx1ads/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- ntosd-dm320/ + | | |- doc/README.txt + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- olimex-strp711/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- pjrc-8051/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- sim/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- skp16c26/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- stm3210e-eval/ + | | |- include/README.txt + | | |- RIDE/README.txt + | | |- src/README.txt + | | `- README.txt + | |- us7032evb1/ + | | |- bin/README.txt + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- xtrs/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- z16f2800100zcog/ + | | |- ostest/README.txt + | | |- pashello/README.txt + | | `- README.txt + | |- z80sim/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- z8encore000zco/ + | | |- ostest/README.txt + | | `- README.txt + | |- z8f64200100kit/ + | | |- ostest/README.txt + | | `- README.txt + | `- README.txt + |- examples/ + | |- nsh/README.txt + | |- pashello/README.txt + | `- README.txt + |- graphics/ + | `- README.txt + |- libxx/ + | `- README.txt + `- netutils/ + |- telnetd/README.txt + `- README diff --git a/README.txt b/README.txt new file mode 100755 index 00000000000..c8ce9a978fd --- /dev/null +++ b/README.txt @@ -0,0 +1,116 @@ +Additional information can be found in the Documentation/ directory and +also in README files that are scattered throughout the source tree. Below +is a guide to the available README files: + + | + |- arch/ + | | + | |- arm + | | `- src + | | `- lpc214x/README.txt + | |- sh/ + | | |- include/ + | | | |-m16c/README.txt + | | | |-sh1/README.txt + | | | `-README.txt + | | |- src/ + | | | |-common/README.txt + | | | |-m16c/README.txt + | | | |-sh1/README.txt + | | | `-README.txt + | `- z80/ + | | `- src/ + | | `- z80/README.txt + | `- README.txt + |- configs/ + | |- c5471evm/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- eagle100/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- ez80f910200kitg/ + | | |- ostest/README.txt + | | `- README.txt + | |- ez80f910200zco/ + | | |- dhcpd/README.txt + | | |- httpd/README.txt + | | |- nettest/README.txt + | | |- nsh/README.txt + | | |- ostest/README.txt + | | |- poll/README.txt + | | `- README.txt + | |- m68332evb/ + | | |- include/README.txt + | | `- src/README.txt + | |- mcu123-lpc214x/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- mx1ads/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- ntosd-dm320/ + | | |- doc/README.txt + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- olimex-strp711/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- pjrc-8051/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- sim/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- skp16c26/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- stm3210e-eval/ + | | |- include/README.txt + | | |- RIDE/README.txt + | | |- src/README.txt + | | `- README.txt + | |- us7032evb1/ + | | |- bin/README.txt + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- xtrs/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- z16f2800100zcog/ + | | |- ostest/README.txt + | | |- pashello/README.txt + | | `- README.txt + | |- z80sim/ + | | |- include/README.txt + | | |- src/README.txt + | | `- README.txt + | |- z8encore000zco/ + | | |- ostest/README.txt + | | `- README.txt + | |- z8f64200100kit/ + | | |- ostest/README.txt + | | `- README.txt + | `- README.txt + |- examples/ + | |- nsh/README.txt + | |- pashello/README.txt + | `- README.txt + |- graphics/ + | `- README.txt + |- libxx/ + | `- README.txt + `- netutils/ + |- telnetd/README.txt + `- README diff --git a/arch/README.txt b/arch/README.txt index 1e937842bbc..23b4a08321a 100644 --- a/arch/README.txt +++ b/arch/README.txt @@ -134,8 +134,14 @@ arch/arm - ARM-based micro-controllers the following subdirectories: arch/arm/include and arch/arm/src/common - Common ARM logic. + Common ARM/Cortex-M3 logic. + arch/arm/src/arm and arch/arm/include/arm + Common ARM-specific logic + + arch/arm/src/cortexm3 and arch/arm/include/cortexm3 + Common Cortex-M3 logic + arch/arm/include/c5471 and arch/arm/src/c5471 TI TMS320C5471 (also called TMS320DM180 or just C5471). NuttX operates on the ARM7 of this dual core processor. This port @@ -146,6 +152,13 @@ arch/arm - ARM-based micro-controllers NuttX operates on the ARM9EJS of this dual core processor. This port complete, verified, and included in the NuttX release 0.2.1. + arch/arm/include/lm3s and arch/arm/src/lm3s + These directories contain support for the Luminary LMS family, particularly + for the LM3S6918. The initial, release of this port was included in NuttX version + 0.4.6. The current port includes timer, serial console, Ethernet, SSI, and microSD + support. There are working configurations the NuttX OS test, to run the NuttShell + (NSH), the NuttX networking test, and the uIP web server. + arch/arm/include/lpc214x and arch/arm/src/lpc214x These directories provide support for NXP LPC214x family of processors. This port boots and passes the OS test (examples/ostest). @@ -153,6 +166,12 @@ arch/arm - ARM-based micro-controllers timer interrupts, serial console, USB driver, and SPI-based MMC/SD card support. A verifed NuttShell (NSH) configuration is also available. + arch/arm/include/stm32 and arch/arm/src/stm32 + These directories contain support for the STMicro STM32 family, particularly + for the STM32F103ZET6. The initial, release of this port was included in NuttX version + 0.4.12. The current port includes timer, and serial console. Work is underway for + USB, SPI, microSD, and LCD. + arch/arm/include/str71x and arch/arm/src/str71x These directories provide support for the STMicro STR71x processors. Coding is complete on the basic port (boot logic, system time, serial console), @@ -214,7 +233,3 @@ arch/c5471 arch/dm320 Replaced with arch/arm/include/dm320 and arch/arm/src/dm320 -Other ports for the for the TI TMS320DM270 and for MIPS are in various states -of progress - -