diff --git a/ChangeLog b/ChangeLog index 1904cf0f0d4..5bec7c5ad79 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1600,5 +1600,6 @@ * apps/Makefile and configs/*/appconfig - Use '=' as the delimiter instead of '/' so that sub-directories in apps/ can be used. * apps/vsn - Move all VSN apps to apps/vsn. + * nuttx/examples moved to apps/examples diff --git a/Documentation/NXGraphicsSubsystem.html b/Documentation/NXGraphicsSubsystem.html index ac67c9614a1..4e6e780547b 100644 --- a/Documentation/NXGraphicsSubsystem.html +++ b/Documentation/NXGraphicsSubsystem.html @@ -12,7 +12,7 @@

NX Graphics Subsystem

-

Last Updated: July 27, 2010

+

Last Updated: March 20, 2010

@@ -212,7 +212,7 @@ Figure 1. - This scren shot shows the final frame for the NuttX example at examples/nx + This scren shot shows the final frame for the NuttX example at apps/examples/nx running on the simulated, Linux x86 platform with simulated framebuffer output to an X window. This picture shows to framed windows with (blank) toolbars. @@ -2499,9 +2499,9 @@ int nxf_convert_32bpp(FAR uint32_t *dest, uint16_t height,

2.6 Sample Code

-

examples/nx. +

apps/examples/nx. No sample code is provided in this document. - However, an example can be found in the NuttX source tree at examples/nx. + However, an example can be found in the NuttX source tree at apps/examples/nx. That code is intended to test NX. Since it is test code, it is designed to exercise functionality and does not necessarily represent best NX coding practices. @@ -2514,7 +2514,7 @@ int nxf_convert_32bpp(FAR uint32_t *dest, uint16_t height, be implemented by the NX client code.

-

Building examples/nx. +

Building apps/examples/nx. Testing was performed using the Linux/Cygwin-based NuttX simulator. Instructions are provided for building that simulation are provided in Appendix C of this document. @@ -2690,11 +2690,11 @@ int nxf_convert_32bpp(FAR uint32_t *dest, uint16_t height, -

examples/nx. - The primary test tool for debugging NX resides at examples/nx. +

apps/examples/nx. + The primary test tool for debugging NX resides at apps/examples/nx.

-

Building examples/nx. - NX testing was performed using examples/nx with the +

Building apps/examples/nx. + NX testing was performed using apps/examples/nx with the Linux/Cygwin-based NuttX simulator. Configuration files for building this test can be found in configs/sim/nx. There are two alternative configurations for building the simulation: @@ -2761,7 +2761,7 @@ make

Test Coverage. - At present, examples/nxt only exercises a subset of NX; + At present, apps/examples/nxt only exercises a subset of NX; the remainder is essentially untested. The following table describes the testing performed on each NX API:

@@ -2938,7 +2938,7 @@ make nx_eventnotify() - This is not used in the current version of examples/nx, + This is not used in the current version of apps/examples/nx, was tested in a previous version) NO diff --git a/Documentation/NuttX.html b/Documentation/NuttX.html index 37e22a0089a..6929f54e1c2 100644 --- a/Documentation/NuttX.html +++ b/Documentation/NuttX.html @@ -8,7 +8,7 @@

NuttX RTOS

-

Last Updated: March 19, 2011

+

Last Updated: March 20, 2011

@@ -948,7 +948,7 @@ 3.0 Configuring and Building

@@ -295,7 +296,7 @@ General documentation for the NuttX OS resides in this directory.

-

2.2 arch

+

2.2 nuttx/arch

2.2.1 Subdirectory Structure

@@ -460,7 +461,7 @@

  • arch/arm/include/lpc214x and arch/arm/src/lpc214x: These directories provide support for NXP LPC214x family of processors. - STATUS: This port boots and passes the OS test (examples/ostest). + STATUS: This port boots and passes the OS test (apps/examples/ostest). The port is complete and verified. As of NuttX 0.3.17, the port includes: timer interrupts, serial console, USB driver, and SPI-based MMC/SD card support. A verified NuttShell configuration is also available. @@ -544,21 +545,21 @@ of progress

    -

    2.3 binfmt

    +

    2.3 nuttx/binfmt

    The binfmt/ subdirectory contains logic for loading binaries in the file system into memory in a form that can be used to execute them.

    -

    2.4 configs

    +

    2.4 nuttx/configs

    The configs/ subdirectory contains configuration data for each board. These board-specific configurations plus the architecture-specific configurations in the arch/ subdirectory complete define a customized port of NuttX.

    -

    2.3.1 Subdirectory Structure

    +

    2.4.1 Subdirectory Structure

    The configs directory contains board specific configuration files. Each board must provide a subdirectory <board-name> under configs/ with the following characteristics: @@ -589,8 +590,8 @@

    -

    2.3.2 Summary of Files

    -

    2.3.2.1 Board Specific Logic

    +

    2.4.2 Summary of Files

    +

    2.4.2.1 Board Specific Logic

    -

    2.3.2.2 Board Specific Configuration Sub-Directories

    +

    2.4.2.2 Board Specific Configuration Sub-Directories

    The configs/<board-name>/ sub-directory holds all of the files that are necessary to configure NuttX for the particular board. @@ -676,7 +677,7 @@

    • -

    2.3.3 Supported Boards

    +

    2.4.3 Supported Boards

    All of the specific boards supported by NuttX are identified below. These are the specific <board-name>'s that may be used to configure NuttX @@ -790,7 +791,7 @@ is available to build these toolchains under Linux or Cygwin.

    -

    2.5 drivers

    +

    2.5 nuttx/drivers

    This directory holds architecture-independent device drivers. @@ -816,13 +817,7 @@ drivers/ `-- (common driver source files) -

    2.6 examples

    - -

    - Example and test programs to build against. -

    - -

    2.7 fs

    +

    2.6 nuttx/fs

    This directory contains the NuttX file system. @@ -840,7 +835,7 @@ fs/ `-- (common file system source files) -

    2.8 graphics

    +

    2.7 nuttx/graphics

    This directory contains files for graphics/video support under NuttX. @@ -857,7 +852,7 @@ graphics/ `-- (common file system source files) -

    2.9 include

    +

    2.8 nuttx/include

    This directory holds NuttX header files. Standard header files file retained in can be included in the normal fashion: @@ -886,30 +881,64 @@ include/ `-- (more standard header files) -

    2.10 lib

    +

    2.9 nuttx/lib

    This directory holds a collection of standard libc-like functions with custom interfaces into NuttX.

    -

    2.11 libxx

    +

    2.10 nuttx/libxx

    This directory holds a tiny, minimal standard std C++ that can be used to build some, simple C++ applications in NuttX.

    -

    2.12 mm

    +

    2.11 nuttx/mm

    This is the NuttX memory manager.

    -

    2.13 net

    +

    2.12 nuttx/net

    This directory contains the implementation of the socket APIs. The subdirectory, uip contains the uIP port.

    -

    2.14 netutils

    +

    2.13 nuttx/sched

    +

    + The files forming core of the NuttX RTOS reside here. +

    + +

    2.14 nuttx/tools

    +

    + This directory holds a collection of tools and scripts to simplify + configuring, building and maintaining NuttX. +

    + + +

    2.15 nuttx/Makefile

    +

    + The top-level Makefile in the ${TOPDIR} directory contains all of the top-level control + logic to build NuttX. + Use of this Makefile to build NuttX is described below. +

    + +

    2.16 apps/netutils

    This directory contains most of the network applications. Some of these are original with NuttX (like tftpc and dhcpd) and others were leveraged from the uIP-1.0 apps directory. @@ -951,38 +980,14 @@ netutils/ `-- (netutils common files) -

    2.15 sched

    +

    2.17 apps/nshlib

    - The files forming core of the NuttX RTOS reside here. + This directory contains for the core of the NuttShell (NSH) application.

    -

    2.16 tools

    +

    2.18 apps/examples

    - This directory holds a collection of tools and scripts to simplify - configuring, building and maintaining NuttX. -

    - - -

    2.17 Makefile

    -

    - The top-level Makefile in the ${TOPDIR} directory contains all of the top-level control - logic to build NuttX. - Use of this Makefile to build NuttX is described below. + Example and test programs to build against.

    @@ -2663,10 +2668,9 @@ extern void up_ledoff(int led);

    NuttX USB Device Trace

    -

    Last Updated: February 25, 2010

    +

    Last Updated: March 20, 2011
    @@ -134,7 +134,7 @@ Otherwise, the trace data goes to console.

    Example. - Here is an example of USB trace output using examples/usbserial for an LPC1768 platform with the following NuttX configuration settings: + Here is an example of USB trace output using apps/examples/usbserial for an LPC1768 platform with the following NuttX configuration settings: