diff options
author | patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3> | 2009-10-14 21:54:31 +0000 |
---|---|---|
committer | patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3> | 2009-10-14 21:54:31 +0000 |
commit | a52837c29e96dd13d5cefce537bc08f68c0a5e2c (patch) | |
tree | 2378ac6e056241b979c7b134ad4a3575c75b01a4 | |
parent | 0f2256abcf28155c4a5c52b5ab48fff54798dd6e (diff) | |
download | px4-nuttx-a52837c29e96dd13d5cefce537bc08f68c0a5e2c.tar.gz px4-nuttx-a52837c29e96dd13d5cefce537bc08f68c0a5e2c.tar.bz2 px4-nuttx-a52837c29e96dd13d5cefce537bc08f68c0a5e2c.zip |
Add README file info
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@2136 42af7a65-404d-4744-a932-0658087f49c3
-rw-r--r-- | nuttx/Documentation/NuttX.html | 4 | ||||
-rwxr-xr-x | nuttx/Documentation/README.html | 136 | ||||
-rwxr-xr-x | nuttx/README.txt | 116 | ||||
-rw-r--r-- | nuttx/arch/README.txt | 25 |
4 files changed, 276 insertions, 5 deletions
diff --git a/nuttx/Documentation/NuttX.html b/nuttx/Documentation/NuttX.html index 98d8fa7f6..ee34e4891 100644 --- a/nuttx/Documentation/NuttX.html +++ b/nuttx/Documentation/NuttX.html @@ -1668,6 +1668,10 @@ buildroot-0.1.8 2009-xx-xx <spudmonkey@racsa.co.cr> </tr> <tr> <td valign="top" width="22"><img height="20" width="20" src="favicon.ico"></td> + <td><a href="README.html">NuttX README Files</a></td> +</tr> +<tr> + <td valign="top" width="22"><img height="20" width="20" src="favicon.ico"></td> <td><a href="ChangeLog.txt">Change Log</a></td> </tr> <tr> diff --git a/nuttx/Documentation/README.html b/nuttx/Documentation/README.html new file mode 100755 index 000000000..025bd273f --- /dev/null +++ b/nuttx/Documentation/README.html @@ -0,0 +1,136 @@ +<html> +<head> +<title>README Files</title> +</head> +<body background="backgd.gif"> +<base href="http://nuttx.cvs.sourceforge.net/viewvc/*checkout*/nuttx/nuttx/" TARGET="_self"> +<hr><hr> +<table width ="100%"> + <tr align="center" bgcolor="#e4e4e4"> + <td> + <h1><big><font color="#3c34ec"><i>NuttX README Files</i></font></big></h1> + <p>Last Updated: October 14, 2009</p> + </td> + </tr> +</table> +<p> + Additional information can be found in the <code>Documentation/</code> directory and + also in <code>README</code> files that are scattered throughout the source tree. + Below is a guide to the available <code>README</code> files. + Some <code>README</code> files contain more important information than others. + The key <code>README</code> files are shown in <code><i><b>BOLDFACE/ITALIC</i></b></code> below. +</p> +<ul><pre> + . + | + |- arch/ + | | + | |- arm + | | `- src + | | `- <a href="arch/arm/src/lpc214x/README.txt">lpc214x/README.txt</a> + | |- sh/ + | | |- include/ + | | | |-<a href="arch/sh/include/m16c/README.txt">m16c/README.txt</a> + | | | |-<a href="arch/sh/include/sh1/README.txt">sh1/README.txt</a> + | | | `-<a href="arch/sh/include/README.txt">README.txt</a> + | | |- src/ + | | | |-<a href="arch/sh/src/common/README.txt">common/README.txt</a> + | | | |-<a href="arch/sh/src/m16c/README.txt">m16c/README.txt</a> + | | | |-<a href="arch/sh/src/sh1/README.txt">sh1/README.txt</a> + | | | `-<a href="arch/sh/src/README.txt">README.txt</a> + | `- z80/ + | | `- src/ + | | `- <a href="arch/z80/src/z80/README.txt">z80/README.txt</a> + | `- <a href="arch/README.txt"><b><i>README.txt</i></b></a> + |- configs/ + | |- c5471evm/ + | | |- <a href="configs/c5471evm/include/README.txt">include/README.txt</a> + | | |- <a href="configs/c5471evm/src/README.txt">src/README.txt</a> + | | `- <a href="configs/c5471evm/README.txt"><b><i>README.txt</i></b></a> + | |- eagle100/ + | | |- <a href="configs/eagle100/include/README.txt">include/README.txt</a> + | | |- <a href="configs/eagle100/src/README.txt">src/README.txt</a> + | | `- <a href="configs/eagle100/README.txt"><b><i>README.txt</i></b></a> + | |- ez80f910200kitg/ + | | |- <a href="configs/ez80f910200kitg/ostest/README.txt">ostest/README.txt</a> + | | `- <a href="configs/ez80f910200kitg/README.txt"><b><i>README.txt</i></b></a> + | |- ez80f910200zco/ + | | |- <a href="configs/ez80f910200zco/ostest/README.txt">dhcpd/README.txt</a> + | | |- <a href="configs/ez80f910200zco/httpd/README.txt">httpd/README.txt</a> + | | |- <a href="configs/ez80f910200zco/nettest/README.txt">nettest/README.txt</a> + | | |- <a href="configs/ez80f910200zco/nsh/README.txt">nsh/README.txt</a> + | | |- <a href="configs/ez80f910200zco/ostest/README.txt">ostest/README.txt</a> + | | |- <a href="configs/ez80f910200zco/poll/README.txt">poll/README.txt</a> + | | `- <a href="configs/ez80f910200zco/README.txt"><b><i>README.txt</i></b></a> + | |- m68332evb/ + | | |- <a href="configs/m68332evb/include/README.txt">include/README.txt</a> + | | `- <a href="configs/m68332evb/src/README.txt">src/README.txt</a> + | |- mcu123-lpc214x/ + | | |- <a href="configs/mcu123-lpc214x/include/README.txt">include/README.txt</a> + | | |- <a href="configs/mcu123-lpc214x/src/README.txt">src/README.txt</a> + | | `- <a href="configs/mcu123-lpc214x/README.txt"><b><i>README.txt</i></b></a> + | |- mx1ads/ + | | |- <a href="configs/mx1ads/include/README.txt">include/README.txt</a> + | | |- <a href="configs/mx1ads/src/README.txt">src/README.txt</a> + | | `- <a href="configs/mx1ads/README.txt"><b><i>README.txt</i></b></a> + | |- ntosd-dm320/ + | | |- <a href="configs/ntosd-dm320/doc/README.txt">doc/README.txt</a> + | | |- <a href="configs/ntosd-dm320/include/README.txt">include/README.txt</a> + | | |- <a href="configs/ntosd-dm320/src/README.txt">src/README.txt</a> + | | `- <a href="configs/ntosd-dm320/README.txt"><b><i>README.txt</i></b></a> + | |- olimex-strp711/ + | | |- <a href="configs/olimex-strp711/include/README.txt">include/README.txt</a> + | | |- <a href="configs/olimex-strp711/src/README.txt">src/README.txt</a> + | | `- <a href="configs/olimex-strp711/README.txt"><b><i>README.txt</i></b></a> + | |- pjrc-8051/ + | | |- <a href="configs/pjrc-8051/include/README.txt">include/README.txt</a> + | | |- <a href="configs/pjrc-8051/src/README.txt">src/README.txt</a> + | | `- <a href="configs/pjrc-8051/README.txt"><b><i>README.txt</i></b></a> + | |- sim/ + | | |- <a href="configs/sim/include/README.txt">include/README.txt</a> + | | |- <a href="configs/sim/src/README.txt">src/README.txt</a> + | | `- <a href="configs/sim/README.txt"><b><i>README.txt</i></b></a> + | |- skp16c26/ + | | |- <a href="configs/skp16c26/include/README.txt">include/README.txt</a> + | | |- <a href="configs/skp16c26/src/README.txt">src/README.txt</a> + | | `- <a href="configs/skp16c26/README.txt"><b><i>README.txt</i></b></a> + | |- stm3210e-eval/ + | | |- <a href="configs/stm3210e-eval/include/README.txt">include/README.txt</a> + | | |- <a href="configs/stm3210e-eval/RIDE/README.txt">RIDE/README.txt</a> + | | |- <a href="configs/stm3210e-eval/src/README.txt">src/README.txt</a> + | | `- <a href="configs/stm3210e-eval/README.txt"><b><i>README.txt</i></b></a> + | |- us7032evb1/ + | | |- <a href="configs/us7032evb1/bin/README.txt">bin/README.txt</a> + | | |- <a href="configs/us7032evb1/include/README.txt">include/README.txt</a> + | | |- <a href="configs/us7032evb1/src/README.txt">src/README.txt</a> + | | `- <a href="configs/us7032evb1/README.txt"><b><i>README.txt</i></b></a> + | |- xtrs/ + | | |- <a href="configs/xtrs/include/README.txt">include/README.txt</a> + | | |- <a href="configs/xtrs/src/README.txt">src/README.txt</a> + | | `- <a href="configs/xtrs/README.txt"><b><i>README.txt</i></b></a> + | |- z16f2800100zcog/ + | | |- <a href="configs/xtrs/ostest/README.txt">ostest/README.txt</a> + | | |- <a href="configs/xtrs/pashello/README.txt">pashello/README.txt</a> + | | `- <a href="configs/xtrs/README.txt"><b><i>README.txt</i></b></a> + | |- z80sim/ + | | |- <a href="configs/z80sim/include/README.txt">include/README.txt</a> + | | |- <a href="configs/z80sim/src/README.txt">src/README.txt</a> + | | `- <a href="configs/z80sim/README.txt"><b><i>README.txt</i></b></a> + | |- z8encore000zco/ + | | |- <a href="configs/z8encore000zco/ostest/README.txt">ostest/README.txt</a> + | | `- <a href="configs/z8encore000zco/README.txt"><b><i>README.txt</i></b></a> + | |- z8f64200100kit/ + | | |- <a href="configs/z8f64200100kit/ostest/README.txt">ostest/README.txt</a> + | | `- <a href="configs/z8f64200100kit/README.txt"><b><i>README.txt</i></b></a> + | `- <a href="configs/README.txt"><b><i>README.txt</i></b></a> + |- examples/ + | |- <a href="examples/nsh/README.txt"><b><i>nsh/README.txt</i></b></a> + | |- <a href="examples/pashello/README.txt">pashello/README.txt</a> + | `- <a href="examples/README.txt"><b><i>README.txt</i></b></a> + |- graphics/ + | `- <a href="graphics/README.txt"><b><i>README.txt</i></b></a> + |- libxx/ + | `- <a href="libxx/README.txt"><b><i>README.txt</i></b></a> + `- netutils/ + |- <a href="netutils/telnetd/README.txt">telnetd/README.txt</a> + `- <a href="netutils/README"><b><i>README</a></a> diff --git a/nuttx/README.txt b/nuttx/README.txt new file mode 100755 index 000000000..c8ce9a978 --- /dev/null +++ b/nuttx/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/nuttx/arch/README.txt b/nuttx/arch/README.txt index 1e937842b..23b4a0832 100644 --- a/nuttx/arch/README.txt +++ b/nuttx/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 - - |