OrgApache/incubator-nuttx
OrgApache
/
incubator-nuttx
mirror of https://github.com/apache/incubator-nuttx.git
1
0
Fork 0
Code Issues Releases Wiki Activity
Apache NuttX is a mature, real-time embedded operating system (RTOS)
2,880 Commits 18 Branches 185 Tags 383 MiB
C 97.1%
Assembly 1.2%
CMake 0.6%
Makefile 0.5%
Python 0.3%
Other 0.3%
Go to file
patacongo 87bc3b1d50 Fix big-time naming error -- what was I thinking? 
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3059 42af7a65-404d-4744-a932-0658087f49c3
 		2010-10-30 00:46:27 +00:00
Documentation Add strnlen() 2010-10-27 20:54:11 +00:00
arch Fix big-time naming error -- what was I thinking? 2010-10-30 00:40:53 +00:00
binfmt Should use bdbg, not dbg 2009-12-20 13:34:49 +00:00
configs Fix big-time naming error -- what was I thinking? 2010-10-30 00:46:27 +00:00
drivers Use RECVBLOCK vs multiple SEND 2010-10-01 02:51:45 +00:00
examples update 2010-10-18 16:14:07 +00:00
fs Add IGMP user interface 2010-07-11 18:10:22 +00:00
graphics Fix case where rectangle is moved horizonatlly 2010-08-08 14:35:11 +00:00
include Add strnlen() 2010-10-27 20:54:11 +00:00
lib Add strnlen() 2010-10-27 20:54:11 +00:00
libxx Changing NuttX fixed size type names to C99 standard names -- things will be broken for awhile 2009-12-15 16:58:10 +00:00
mm Switching to C99 stdint/stdbool.h types 2009-12-15 01:39:03 +00:00
net Fix compile error when stats enabled 2010-07-14 18:14:00 +00:00
netutils Lease time is now in host order 2010-08-10 16:39:34 +00:00
sched No up_en/disable_irq's 2010-10-16 03:22:24 +00:00
tools Extra space at end of line 2010-09-08 02:14:23 +00:00
COPYING Misc USB device driver debug 2010-08-07 01:48:15 +00:00
ChangeLog Add strnlen() 2010-10-27 20:54:11 +00:00
Makefile Two pass build for on-demand paging now works 2010-08-29 14:27:58 +00:00
README.txt Add Cygwin build note 2010-10-08 12:33:31 +00:00
ReleaseNotes Fix a signal trampoline bug 2010-10-27 01:46:08 +00:00
TODO Prep for 5.11 Release 2010-10-02 00:55:32 +00:00

README.txt 

README
^^^^^^

  o Installation
  o Configuring NuttX
  o Building NuttX
  o Documentation

INSTALLATION
^^^^^^^^^^^^

Download and Unpack:

  Download and unpack the NuttX tarball.  If you are reading this, then
  you have probably already done that.  After unpacking, you will end
  up with a directory called nuttx-version (where version is the NuttX
  version number). You might want to rename that directory nuttx to
  match the various instructions in the documentation and some scripts
  in the source tree.

  That nuttx build directory should reside in a path that contains no
  spaces in the higher level directory names.  For example, under
  Cygwin, your home directory might be formed from your first and last
  names like: "/home/First Last". That will cause strange errors when
  the make system tries to build.

  [Actually, that problem is probably not to difficult to fix.  Some
   Makefiles probably just need some pathes within double quotes]

A Note about Header Files:

  Some toolchains are built with header files extracted from a C-library
  distribution (such as newlib).  For those toolchains, NuttX must be
  compiled without using the standard header files that are distributed
  with your toolchain.  This prevents including conflicting, incompatible
  header files (such as stdio.h).

  Certain header files, such as setjmp.h and varargs.h, may still be
  needed from your toolchain, however.  If that is the case, one solution
  is to copy those header file from your toolchain into the NuttX include
  directory.

  Also, if you prefer to use the stdint.h and stdbool.h header files from
  your toolchain, those could be copied into the include/ directory too.
  Using most other header files from your toolchain would probably cause
  errors.

CONFIGURING NUTTX
^^^^^^^^^^^^^^^^^

"Canned" NuttX configuration files are retained in:

  configs/<board-name>/<config-dir>

Where <board-name> is the name of your development board and <config-dir>.
Configuring NuttX requires only copying three files from the <config-dir>
to the directly where you installed NuttX (TOPDIR):

  Copy configs/<board-name>/<config-dir>/Make.def to ${TOPDIR}/Make.defs
    Make.defs describes the rules needed by you tool chain to compile
    and link code.  You may need to modify this file to match the
    specific needs of your toolchain.

  Copy configs/<board-name>/<config-dir>/setenv.sh to ${TOPDIR}/setenv.sh
    setenv.sh is an optional convenience file that I use to set
    the PATH variable to the toolchain binaries.  You may chose to
    use setenv.sh or not.  If you use it, then it may need to be
    modified to include the path to your toolchain binaries.

  Copy configs/<board-name>/<config-dir>/defconfig to ${TOPDIR}/.config
    The defconfig file holds the actual build configuration.  This
    file is included by all other make files to determine what is
    included in the build and what is not.  This file is also used
    to generate a C configuration header at include/nuttx/config.h.

General information about configuring NuttX can be found in:

  ${TOPDIR}/configs/README.txt
  ${TOPDIR}/configs/<board-name>/README.txt

There is a configuration script in the tools/ directory that makes this
easier.  It is used as follows:

  cd ${TOPDIR}/tools
  ./configure.sh <board-name>/<config-dir>

BUILDING NUTTX
^^^^^^^^^^^^^^

NuttX builds in-place in the source tree.  You do not need to create
any special build directories.  Assuming that your Make.defs is setup
properly for your tool chain, the following steps are all that are
required to build NuttX:

  cd ${TOPDIR}
  make

At least one configuration (eagle100) requires additional command line
arguments on the make command.  Read ${TOPDIR}/configs/<board-name>/README.txt
to see if that applies to your target.

CYGWIN BUILD PROBLEMS
^^^^^^^^^^^^^^^^^^^^^

If you see strange behaviour when building under Cygwin then you may have
a problem with your PATH variable.  For example, if you see failures to
locate files that are clearly present, then may mean that you are using
the wrong version of a tool.  For example, you may not be using Cywgin's
'make' program at /usr/bin/make.  Try:

    $ which make
    /usr/bin/make

When you install some toolchains (such as Yargarto or CodeSourcery tools),
they may modify your PATH variable to include a path to their binaries.
At that location, they make have GNUWin32 versions of the tools.  So you
might actually be using a version of make that does not understand Cygwin
pathes.

The solution is either:

1. Edit your PATH to remove the path to the GNUWin32 tools, or
2. Put /usr/local/bin, /usr/bin, and /bin at the front of your path:

   $ export PATH=/usr/local/bin:/usr/bin:/bin:$PATH

DOCUMENTATION
^^^^^^^^^^^^^

Additional information can be found in the Documentation/ directory and
also in README files that are scattered throughout the source tree.  The
documentation is in HTML and can be access by loading the following file
into your Web browser:

  Documentation/index.html

NuttX documentation is also available online at http://www.nuttx.org.

Below is a guide to the available README files in the NuttX source tree:

 |
 |- 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/
 |   |- avr32dev1/
 |   |   `- README.txt
 |   |- c5471evm/
 |   |   |- include/README.txt
 |   |   |- src/README.txt
 |   |   `- README.txt
 |   |- demo0s12ne64/
 |   |   `- README.txt
 |   |- ea3131/
 |   |   `- 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
 |   |- lm3s5965-ek/
 |   |   |- include/README.txt
 |   |   |- src/README.txt
 |   |   `- README.txt
 |   |- m68332evb/
 |   |   |- include/README.txt
 |   |   `- src/README.txt
 |   |- mbed/
 |   |   `- 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
 |   |- nucleus1g/
 |   |   `- README.txt
 |   |- olimex-strp711/
 |   |   |- include/README.txt
 |   |   |- src/README.txt
 |   |   `- README.txt
 |   |- olimex-lpc2378/
 |   |   |- include/README.txt
 |   |   |- src/README.txt
 |   |   `- README.txt
 |   |- pjrc-8051/
 |   |   |- include/README.txt
 |   |   |- src/README.txt
 |   |   `- README.txt
 |   |- sam3u-ek/
 |   |   `- 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
 |- drivers/
 |   `- README.txt
 |- examples/
 |   |- nsh/README.txt
 |   |- pashello/README.txt
 |   `- README.txt
 |- graphics/
 |   `- README.txt
 |- libxx/
 |   `- README.txt
 |- netutils/
 |   |- telnetd/README.txt
 |   `- README
 `- tools/
     `- README.txt