NuttX RTOSLast Updated: December 18, 2009 |
Table of Contents |
|
Overview |
Goals. Nuttx is a real timed embedded operating system (RTOS). Its goals are:
Small Footprint | |
Usable in all but the tightest micro-controller environments, The focus is on the tiny-to-small, deeply embedded environment. | |
Rich Feature OS Set | |
The goal is to provide implementations of most standard POSIX OS interfaces to support a rich, multi-threaded development environment for deeply embedded processors. NON-GOALS: (1) It is not a goal to provide the rich level of OS features like those provided with Linux. Small footprint is more important than features. Standard compliance is more important than small footprint. (2) There is no MMU-based support for processes. At present, NuttX assumes a flat address space. | |
Highly Scalable | |
Fully scalable from tiny (8-bit) to moderate embedded (32-bit). Scalability with rich feature set is accomplished with: Many tiny source files, link from static libraries, highly configurable, use of weak symbols when available. | |
Standards Compliance | |
NuttX strives to achieve a high degree of standards compliance.
The primary governing standards are POSIX and ANSI standards.
Additional standard APIs from Unix and other common RTOS's are
adopted for functionality not available under these standards
or for functionality that is not appropriate for the deeply-embedded
RTOS (such as Because of this standards conformance, software developed under other standard OSs (such as Linux) should port easily to NuttX. | |
Real-Time | |
Fully pre-emptible, fixed priority and round-robin scheduling. | |
Totally Open | |
Non-restrictive BSD license. | |
GNU Toolchains | |
Compatible GNU toolchains based on buildroot available for download to provide a complete development environment for many architectures. |
Feature Set. Key features of NuttX include:
Standards Compliant Core Task Management | |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
File system | |
| |
| |
| |
/dev/null , /dev/zero drivers. | |
| |
| |
| |
| |
| |
C Library | |
| |
Networking | |
| |
| |
| |
| |
| |
USB Device Support | |
| |
| |
| |
| |
Graphics Support | |
| |
|
NuttX Add-Ons. The following packages are available to extend the basic NuttX feature set:
NuttShell (NSH) | |
| |
Pascal Compiler with NuttX runtime P-Code interpreter add-on | |
|
Look at all those files and features... How can it be a tiny OS?. The NuttX feature list (above) is fairly long and if you look at the NuttX source tree, you will see that there are hundreds of source files comprising NuttX. How can NuttX be a tiny OS with all of that?
Lots of Features -- More can be smaller! | |
The philosophy behind that NuttX is that lots of features are great... BUT also that if you don't use those features, then you should not have to pay a penalty for the unused features. And, with NuttX, you don't! If you don't use a feature, it will not be included in the final executable binary. You only have to pay the penalty of increased footprint for the features that you actually use. Using a variety of technologies, NuttX can scale from the very tiny to the moderate-size system. I have executed NuttX with some simple applications in as little as 32Kb total memory (code and data). On the other hand, typical, richly featured NuttX builds require more like 64Kb (and if all of the features are used, this can push 100Kb). |
|
Many, many files -- More really is smaller! | |
One may be intimidated by the size NuttX source tree. There are hundreds of source files! How can that be a tiny OS? Actually, the large number of files is one of the tricks to keep NuttX small and as scalable as possible. Most files contain only a single function. Sometimes just one tiny function with only a few lines of code. Why?
|
|
Other Tricks | |
As mentioned above, the use of many, tiny source files and linking from static libraries keeps the size of NuttX down. Other tricks used in NuttX include:
|
NuttX Discussion Group |
Most Nuttx-related discussion occurs on the Yahoo! NuttX group. You are cordially invited to join. I make a special effort to answer any questions and provide any help that I can.
Downloads |
nuttx-4.14.
This 46th release of NuttX was made on December 2, 2009 and is available for download from the SourceForge website. The change log associated with the release is available here. Unreleased changes after this release are available in CVS. These unreleased changes are listed here.
The release extends the support for the STMicro STM32 microcontroller. Minimal support for the STM3210E-EVAL development board based around the STM32F103ZET6 MCU was released in NuttX-0.4.12 and extended in Nuttx-0.4.13 to include initial USB support. This completes the STM32F103ZET6 support and adds:
New Generic RTOS Features:
New STM32-specific Features:
This release also corrects some important bugs in the earlier STM32 releases:
NOTE: This version, 4.14, is equivalent to what would have been called 0.4.14 to follow 0.4.13. The zero has been eliminated from the front of the version number to avoid confusion about the state of development: Some have interpreted the leading zero to mean that the code is in some way unstable. That was not the intent. Beginning in January 2010, I will switch to the 2010.nn versioning as many others have done to avoid such confusion.
Supported Platforms |
Linux User Mode | |
A user-mode port of NuttX to the x86 Linux/Cygwin platform is available. The purpose of this port is primarily to support OS feature development. STATUS: Does not support interrupts but is otherwise fully functional. |
|
ARM7TDMI. | |
TI TMS320C5471 (also called C5471 or TMS320DA180 or DA180). NuttX operates on the ARM7 of this dual core processor. This port uses the Spectrum Digital evaluation board with a GNU arm-elf toolchain* under Linux or Cygwin. STATUS: This port is complete, verified, and included in the initial NuttX release. |
|
NXP LPC214x. Support is provided for the NXP LPC214x family of processors. In particular, support is provided for the mcu123.com lpc214x evaluation board (LPC2148). This port also used the GNU arm-elf toolchain* under Linux or Cygwin. STATUS: This port boots and passes the OS test (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 (NSH) configuration is also available. Development Environments: 1) Linux with native Linux GNU toolchain, 2) Cygwin with Cygwin GNU toolchain, or 3) Cygwin with Windows native toolchain (CodeSourcery or devkitARM). A DIY toolchain for Linux or Cygwin is provided by the NuttX buildroot package. |
|
STMicro STR71x. Support is provided for the STMicro STR71x family of processors. In particular, support is provided for the Olimex STR-P711 evaluation board. This port also used the GNU arm-elf toolchain* under Linux or Cygwin. STATUS: Integration is complete on the basic port (boot logic, system time, serial console). Two configurations have been verified: (1) The board boots and passes the OS test with console output visible on UART0, and the NuttShell (NSH) is fully functional with interrupt driven serial console. An SPI driver is available but untested (because the Olimex card slot appears to accept only MMC cards; I have only SD cards). Additional features are needed: USB driver, MMC integration, to name two. Development Environments: 1) Linux with native Linux GNU toolchain, 2) Cygwin with Cygwin GNU toolchain, or 3) Cygwin with Windows native toolchain (CodeSourcery or devkitARM). A DIY toolchain for Linux or Cygwin is provided by the NuttX buildroot package. |
|
ARM920T. | |
Freescale MC9328MX1 or i.MX1. This port uses the Freescale MX1ADS development board with a GNU arm-elf toolchain* under either Linux or Cygwin. STATUS: This port is in progress. Coding is complete on the basic port (timer, serial console, SPI). Verified support for the i.MX1 will be announced in a future release of NuttX (work was been temporarily stopped to support the Luminary LM3S6918 and I have not yet worked around some development tool issues.). |
|
ARM926EJS. | |
TI TMS320DM320 (also called DM320). NuttX operates on the ARM9 of this dual core processor. This port uses the Neuros OSD with a GNU arm-elf toolchain* under Linux or Cygwin. STATUS: The basic port (timer interrupts, serial ports, network, framebuffer, etc.) is complete. All implemented features have been verified with the exception of the USB device-side driver; that implementation is complete but untested. |
|
ARM Cortex-M3. | |
Luminary LM3S6918. This port uses the Micromint Eagle-100 development board with a GNU arm-elf toolchain* under either Linux or Cygwin. STATUS: 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. Development Environments: 1) Linux with native Linux GNU toolchain, 2) Cygwin with Cygwin GNU toolchain, or 3) Cygwin with Windows native toolchain (CodeSourcery or devkitARM). A DIY toolchain for Linux or Cygwin is provided by the NuttX buildroot package. |
|
STMicro STM32F103x. This port uses the STMicro STM3210E-EVAL development board that features the STM32F103ZET6 MCU. This port uses a GNU arm-elf toolchain* under either Linux or Cygwin (with native Windows GNU tools or Cygwin-based GNU tools). STATUS: The basic STM32 port was released in NuttX version 0.4.12. The basic port includes boot-up logic, interrupt driven serial console, and system timer interrupts. The 0.4.13 release added support for SPI, serial FLASH, and USB device.; The 4.14 release added support for buttons and SDIO-based MMC/SD and verifed DMA support. Verified configurations are available for NuttX OS test, the NuttShell (NSH) example, the USB serial device class, and the USB mass storage device class example. Development Environments: 1) Linux with native Linux GNU toolchain, 2) Cygwin with Cygwin GNU toolchain, or 3) Cygwin with Windows native toolchain (RIDE7, CodeSourcery or devkitARM). A DIY toolchain for Linux or Cygwin is provided by the NuttX buildroot package. |
|
8052 Microcontroller | |
PJRC 87C52 Development Board. This port uses the PJRC 87C52 development system and the SDCC toolchain under Linux or Cygwin. STATUS: This port is complete but not stable with timer interrupts enabled. There seems to be some issue when the stack pointer enters into the indirect IRAM address space during interrupt handling. This architecture has not been built in some time will likely have some compilation problems because of SDCC compiler differences. |
|
Renesas/Hitachi SuperH | |
SH-1 SH7032. This port uses the Hitachi SH-1 Low-Cost Evaluation Board (SH1_LCEVB1), US7032EVB, with a GNU arm-elf toolchain* under Linux or Cygwin. STATUS: This port is available as of release 0.3.18 of NuttX. The port is basically complete and many examples run correctly. However, there are remaining instabilities that make the port un-usable. The nature of these is not understood; the behavior is that certain SH-1 instructions stop working as advertised. This could be a silicon problem, some pipeline issue that is not handled properly by the gcc 3.4.5 toolchain (which has very limit SH-1 support to begin with), or perhaps with the CMON debugger. At any rate, I have exhausted all of the energy that I am willing to put into this cool old processor for the time being. |
|
Renesas M16C/26 | |
Renesas M16C/26 Microncontroller. This port uses the Renesas SKP16C26 Starter kit and the GNU M32C toolchain. The development environment is either Linux or Cygwin under WinXP.
STATUS:
Initial source files released in nuttx-0.4.2.
At this point, the port has not been integrated; the target cannot be built
because the GNU m32c-elf-ld: BFD (GNU Binutils) 2.19 assertion fail /home/Owner/projects/nuttx/buildroot/toolchain_build_m32c/binutils-2.19/bfd/elf32-m32c.c:482
Where the reference line is: /* If the symbol is out of range for a 16-bit address, we must have allocated a plt entry. */ BFD_ASSERT (*plt_offset != (bfd_vma) -1); No workaround is known at this time. This is a show stopper for M16C for the time being. |
|
Zilog Z16F | |
Zilog z16f Microncontroller. This port use the Zilog z16f2800100zcog development kit and the Zilog ZDS-II Windows command line tools. The development environment is Cygwin under WinXP. STATUS: The initial release of support for the z16f was made available in NuttX version 0.3.7. |
|
Zilog eZ80 Acclaim! | |
Zilog eZ80Acclaim! Microncontroller. There are two eZ80Acclaim! ports:
Both boards are based on the eZ80F091 part and both use the Zilog ZDS-II Windows command line tools. The development environment is Cygwin under WinXP. STATUS: Integration and testing of NuttX on the ZiLOG ez80f0910200zcog-d is complete. The first integrated version was released in NuttX version 0.4.2 (with important early bugfixes in 0.4.3 and 0.4.4). As of this writing, that port provides basic board support with a serial console, SPI, and eZ80F91 EMAC driver. |
|
Zilog Z8Encore! | |
Zilog Z8Encore! Microncontroller. This port uses the either:
and the Zilog ZDS-II Windows command line tools. The development environment is Cygwin under WinXP. STATUS: This release has been verified only on the ZiLOG ZDS-II Z8Encore! chip simulation as of nuttx-0.3.9. |
|
Zilog Z80 | |
Z80 Instruction Set Simulator. This port uses the SDCC toolchain under Linux or Cygwin (verified using version 2.6.0). This port has been verified using only a Z80 instruction simulator. That simulator can be found in the NuttX CVS here. STATUS: This port is complete and stable to the extent that it can be tested using an instruction set simulator. |
|
Other ports | |
There are partial ports for the TI TMS320DM270 and for MIPS. |
* A highly modified buildroot is available that may be used to build a NuttX-compatible ELF toolchain under Linux or Cygwin. Configurations are available in that buildroot to support ARM, m68k, m68hc11, m68hc12, and SuperH ports.
Development Environments |
Linux + GNU make + GCC/binutils
|
|
The is the most natural development environment for NuttX. Any version of the GCC/binutils toolchain may be used. There is a highly modified buildroot available for download from the NuttX SourceForge page. This download may be used to build a NuttX-compatible ELF toolchain under Linux or Cygwin. That toolchain will support ARM, m68k, m68hc11, m68hc12, and SuperH ports. The buildroot CVS may be accessed in the NuttX CVS. |
|
Linux + GNU make + SDCC
|
|
Also very usable is the Linux environment using the SDCC compiler. The SDCC compiler provides support for the 8051/2, z80, hc08, and other microcontrollers. The SDCC-based logic is less well exercised and you will likely find some compilation issues if you use parts of NuttX with SDCC that have not been well-tested. |
|
Cygwin + GNU make + GCC/binutils
|
|
This combination works well too. It works just as well as the native Linux environment except that compilation and build times are a little longer. The custom NuttX buildroot referenced above may be build in the Cygwin environment as well. |
|
Cygwin + GNU make + SDCC
|
|
I have never tried this combination, but it would probably work just fine. |
|
Cygwin + GNU make + Windows Native Toolchain
|
|
This is a tougher environment. In this case, the Windows native toolchain is unaware of the Cygwin sandbox and, instead, operates in the native Windows environment. The primary difficulties with this are:
Fortunately, this conversion is done simply using the The NuttX make system works around this limitation by copying the platform specific directories in place. These copied directories make work a little more complex, but otherwise work well.
NOTE: dependencies are suppress by setting the make variable Supported Windows Native Toolchains. At present, only the Zilog Z16F, z8Encore, and eZ80Acclaim ports use a non-GCC native Windows toolchain(the Zilog ZDS-II toolchain). Support for Windows native GCC toolchains (CodeSourcery and devkitARM) is currently implemented for the NXP LPC214x, STMicro STR71x, and Luminary LMS6918 ARM ports. (but could easily be extended to any other GCC-based platform with a small effort). |
|
Other Environments?
Windows Native make + Windows Native Toolchain?
|
|
Environment Dependencies. The primary environmental dependency of NuttX are (1) GNU make, (2) bash scripting, and (3) Linux utilities (such as cat, sed, etc.). If you have other platforms that support GNU make or make utilities that are compatible with GNU make, then it is very likely that NuttX would work in that environment as well (with some porting effort). If GNU make is not supported, then some significant modification of the Make system would be required. GNUWin32. For example, with suitable make system changes, it should be possible to use native GNU tools (such as those from GNUWin32) to build NuttX. However, that environment has not been used as of this writing. |
Memory Footprint |
C5471 (ARM7) The build for this ARM7 target that includes most of the OS features and a broad range of OS tests. The size of this executable as given by the Linux size command is (3/9/07):
text data bss dec hex filename 53272 428 3568 57268 dfb4 nuttx
DM320 (ARM9) This build for the ARM9 target includes a significant subset of OS features, a filesystem, Ethernet driver, full TCP/IP, UDP and (minimal) ICMP stacks (via uIP) and a small network test application: (11/8/07, configuration netconfig, examples/nettest)
text data bss dec hex filename 49472 296 3972 53740 d1ec nuttx
Another build for the ARM9 target includes a minimal OS feature set, Ethernet driver, full TCP/IP and (minimal) ICMP stacks, and a small webserver: (11/20/07, configuration uipconfig, examples/uip)
text data bss dec hex filename 52040 72 4148 56260 dbc4 nuttx
87C52 A reduced functionality OS test for the 8052 target requires only about 18-19Kb:
Stack starts at: 0x21 (sp set to 0x20) with 223 bytes available. Other memory: Name Start End Size Max ---------------- -------- -------- -------- -------- PAGED EXT. RAM 0 256 EXTERNAL RAM 0x0100 0x02fd 510 7936 ROM/EPROM/FLASH 0x2100 0x6e55 19798 24384
Licensing |
NuttX is available under the highly permissive BSD license. Other than some fine print that you agree to respect the copyright you should feel absolutely free to use NuttX in any environment and without any concern for jeopardizing any proprietary software that you may link with it.
Release History |
The current NuttX Change Log is available in CVS here. ChangeLog snapshots associated with the current release are available below.
Change Logs for All NuttX Releases |
|
ChangeLog for Current Releases |
|
Unreleased Changes |
ChangeLog for Current Release |
nuttx-4.14 2009-12-02 Gregory Nutt <spudmonkey@racsa.co.cr> * arch/arm/src/stm32/stm32_gpio.c - Add support for configure an input GPIO to generate an EXTI interrupt. * config/stm3210e-eval/src/up_buttons.c - Add support for on-board buttons. * include/nuttx/rwbuffer.h -- Add generic support for read-ahead buffering and write buffering that can be used in any block driver. * include/nuttx/wqueue.h -- Added a generic worker thread that can used to defer processing from an interrupt to a task. * include/nuttx/sdio.h -- Defines a generic SD/SDIO interface can can be bound to a MMC/SD driver to provide SDIO-based MMC/SD support. * drivers/mmcsd/mmcsd_sdio.c -- Provides a an SDIO-based MMC/SD driver. * arch/arm/src/stm32/stm32_sdio.c -- Provides an STM32 implementation of the SDIO interface defined in include/nuttx/sdio.h. * fs/fs_mount.c -- Correct error handling logic. If the bind() method fails, then a reserved node is left in the tree. This causes subsequent attempts to mount at the location to fail (reporting that the node already exists). This is a problem for block drivers for removable media: The bind method could fail repeatedly until media is inserted. * arch/arm/src/stm32/chip.h & stm32_dma.c -- Fixed several definitions that can cause compilation errors when DMA2 is enabled. * arch/arm/src/stm32/stm32_dma.c - Integrated and debugged STM32 DMA functionality that was added in 0.4.12. * configs/stm3210e-eval/usbstorage - Add a configuration to exercise the STM32 with the USB mass storage device class example (examples/usbstorage). * configs/mcu123-lpc214x/up_usbstrg - Move LPC-specific code from examples/usbstorage to configs/mcu123-lpc214x. * configs/stm321e-eval/up_usbstrg - Add STM32-specific logic for the examples/usbstorage test. * arch/arm/src/stm32/stm32_usbdev.c - Fix bugs in STM32 USB device-side driver: (1) Need to disconnect after reset received, (2) Status setup to recover from stall on TX endpoint. pascal-0.1.2 2008-02-10 Gregory Nutt <spudmonkey@racsa.co.cr> * Add logic to build and link with the ZDS-II toolchain use with the z16f. * Make sure that POFF header structures are aligned * Standardized POFF file format to big-endian * Break up large switch statements to lower complexity and eliminate a compiler bug * Changes so that runtime compiles with SDCC. buildroot-0.1.7 2009-06-26 <spudmonkey@racsa.co.cr> * configs/avr-defconfig-4.3.3: Added support for AVR to support a NuttX port of the ATmega128. * toolchain/nxflat: Added logic to build NuttX NXFLAT binding support tools * toolchain/genromfs: Added support for the genromfs tool
Unreleased Changes |
nuttx-5.0 2009-xx-xx Gregory Nutt <spudmonkey@racsa.co.cr> * arch/hc: Adding framework to support m68hc11/12 * configs/demo9s12ne64: Configuration to support Freescale DEMO9S12NE64 development board (MC9S12NE64 m68hcs12 processor). * drivers/mtd/ftl.c - A FLASH translation layer (FTL) has been implemented. This layer will convert a FLASH MTD interface into a block driver that can be used with any file system. Good performance of this layer will depend upon functioning write buffer support! NOTE: FTL support is untested as of the initial check-in. * Numerous minor changes for m68hc12 to eliminate compilation errors and warnings due to the fact that it uses 16-bit integer types and for casts between uint32 (32-bits) and an mc68hc12 pointer (16-bits). * sys/types: Size of off_t and blkcnt_t should not depend on size of int in the architecture; Removed non-standard type STATUS * include/ - Added header files stdint.h, stdbool.h, cxx/cstdint, and cxx/cstdbool * Changed ALL references to non-standard fixed-size types (like uint32, ubyte, etc.) to standard types (like uint32_t, uint8_t, etc.) from stdint.h. Use type bool and {true, false} from stdbool. This effected most of the files in the system! Almost all configurations have been re-built and many have been re-verified in order to get confidence in these changes. * graphics/ and examples/nx - Fix numerous build errors that have been introduced lately. NXGL has suffered some bit-rot from not being used in some of the most recent ports. * The misc/pascal NuttX add-on package has been updated to use the new standard types from stdint.h and stdbool.h and re-integrated with NuttX. The released pascal-2.0 will be the first version that contains the compatible changes. * arch/arm/src/lm3s/lm3s_ethernet.c - Fixed an important bug in the LM3S ethernet driver: If full packet is received, the packet-too-big check will fail because it needs to subtract 6 from the packet size (to account for the 2-byte packet length and the 4-byte packet FCS in the FIFO). * net/accept.c - Fixed a bad assertion (only happens when debug is enabled). pascal-2.0 2010-xx-xx Gregory Nutt <spudmonkey@racsa.co.cr> * Updated to use standard C99 types in stdint.h and stdbool.h. This change was necessary for compatibility with NuttX-5.0. buildroot-1.8 2010-xx-xx <spudmonkey@racsa.co.cr> * configs/cortexm3-defconfig-4.3.3: Added support for NuttX NXFLAT tools. * configs/arm7tdmi-defconfig-4.3.3: Update to arm7tdmi-defconfig-4.2.4. Also builds NuttX NXFLAT tools. * configs/m68hc12-defconfig-4.3.3: Update to m68ch11-defconfig. * configs/m68hc12-defconfig-3.4.6: There are problems building GCC 4.3.3 for the hc12.
Bugs, Issues, Things-To-Do |
The current list of NuttX Things-To-Do in CVS here. A snapshot of the To-Do list associated with the current release are available here.
Other Documentation |
User Guide | |
Porting Guide | |
NuttShell (NSH) | |
NXFLAT Binary Format | |
NX Graphics Subsystem | |
NuttX README Files | |
Change Log | |
To-Do List |
Trademarks |
NOTE: NuttX is not licensed to use the POSIX trademark. NuttX uses the POSIX standard as a development guideline only.