From 07292be9c02226128959c0faa8a2e8022b9d8067 Mon Sep 17 00:00:00 2001 From: patacongo Date: Thu, 25 Aug 2011 16:44:11 +0000 Subject: [PATCH] Documentation update git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3914 42af7a65-404d-4744-a932-0658087f49c3 --- Documentation/NuttX.html | 28 +++-- Documentation/NuttxPortingGuide.html | 179 ++++++++++++++++++++++++--- drivers/README.txt | 16 ++- drivers/analog/Make.defs | 2 +- syscall/README.txt | 4 +- 5 files changed, 198 insertions(+), 31 deletions(-) diff --git a/Documentation/NuttX.html b/Documentation/NuttX.html index c50e438846..383e7d6a77 100644 --- a/Documentation/NuttX.html +++ b/Documentation/NuttX.html @@ -291,8 +291,10 @@

-

  • Easily extensible to new processor architectures, SoC architecture, or board architectures. - A Porting Guide is in development.
    • +
  • + Easily extensible to new processor architectures, SoC architecture, or board architectures. + A Porting Guide is available. +

    • @@ -395,7 +397,9 @@

    -

  • Network, USB (host), USB (device), serial, CAN, driver architectures.
    • +
  • + Network, USB (host), USB (device), serial, CAN, ADC, DAC driver architectures. +

    • @@ -403,35 +407,43 @@

    -

  • RAMDISK, pipes, FIFO, /dev/null, /dev/zero drivers.
    • +
  • + RAMDISK, pipes, FIFO, /dev/null, /dev/zero, and loop drivers. +


    • -

  • Mount-able volumes. Bind mountpoint, filesystem, and block device driver.
    • +
  • + Mount-able volumes. Bind mountpoint, filesystem, and block device driver. +


    • -

  • FAT12/16/32 filesystem support with optional FAT long file name support1.
    • +
  • + FAT12/16/32 filesystem support with optional FAT long file name support1. +


    • -

  • NXFFS. the NuttX wear-leveling FLASH file system.
    • +
  • + NXFFS. The tiny NuttX wear-leveling FLASH file system. +


    • -

  • Generic driver for SPI-based MMC/SD/SDH cards.
    • +
  • Generic driver for SPI-based or SDIO-based MMC/SD/SDH cards.

    • diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html index 4289e9146a..17d7ad1761 100644 --- a/Documentation/NuttxPortingGuide.html +++ b/Documentation/NuttxPortingGuide.html @@ -12,7 +12,7 @@

    NuttX RTOS Porting Guide

    -

    Last Updated: August 19, 2011

    +

    Last Updated: August 25, 2011

    @@ -59,10 +59,10 @@ 2.13 nuttx/sched/
    2.14 nuttx/syscall/
    2.15 nuttx/tools/
    - 2.16 nuttx/Makefile + 2.16 nuttx/Makefile
    2.17 apps/netutils
    2.18 apps/nshlib
    - 2.19 apps/examples/
    + 2.19 apps/examples/ 3.0 Configuring and Building Appendix A: NuttX Configuration Settings
    @@ -1000,22 +1001,43 @@

    2.6 nuttx/fs

    @@ -1029,13 +1051,16 @@ fs/ |-- Makefile |-- fat/ | |-- Make.defs -| `-- (fat file system source files) +| `-- (FAT file system source files) +|-- mmap/ +| |-- Make.defs +| `-- (RAM-based file mapping source files) |-- nxffs/ | |-- Make.defs -| `-- (NXFFS file system source files) +| `-- (NuttX Flash File System (NXFFS) source files) |-- romfs/ | |-- Make.defs -| `-- (romfs file system source files) +| `-- (ROMFS file system source files) `-- (common file system source files) @@ -1047,12 +1072,21 @@ fs/ @@ -1073,16 +1107,18 @@ graphics/ include/ |-- (standard header files) |-- arpa/ -| `-- (standard header files) +| `-- (Standard header files) +|-- cxx/ +| `-- (C++ standard header files) |-- net/ | `-- uip/ | `-- (uIP specific header files) |-- netinet/ -| `-- (standard header files) +| `-- (Standard header files) |-- nuttx/ -| `-- (nuttx specific header files) +| `-- (NuttX specific header files) `- sys/ - `-- (more standard header files) + `-- (More standard header files)

    2.9 nuttx/lib

    @@ -1090,6 +1126,48 @@ include/ This directory holds a collection of standard libc-like functions with custom interfaces into NuttX.

    +

    + Normally the logic in this file builds to a single library (liblib.a). + However, if NuttX is built as a separately compiled kernel (with CONFIG_NUTTX_KERNEL=y), then the contents of this directory are built as two libraries: + One for use by user programs (libulib.a) and one for use only within the <kernel> space (libklib.a). +

    +

    + These user/kernel space libraries (along with the sycalls of nuttx/syscall) are needed to support the two differing protection domains. +

    +

    + Directory structure: +

    +

    2.10 nuttx/libxx

    @@ -1115,7 +1193,7 @@ include/

    2.14 nuttx/syscall

    - If NuttX is built as a separately compiled kernel (with CONFIG_NUTTX_KERNEL=y), + If NuttX is built as a separately compiled kernel (with CONFIG_NUTTX_KERNEL=y), then the contents of this directory are built. This directory holds a syscall interface that can be used for communication between user-mode applications and the kernel-mode RTOS. @@ -3036,6 +3114,69 @@ extern void up_ledoff(int led); +

    6.3.11 Analog (ADC/DAC) Drivers

    + + +

    6.3.11.1 ADC Drivers

    + + +

    6.3.11.2 DAC Drivers

    + +
    diff --git a/drivers/README.txt b/drivers/README.txt index 871a713df9..3c337956f9 100644 --- a/drivers/README.txt +++ b/drivers/README.txt @@ -38,12 +38,23 @@ rwbuffer.c Subdirectories of this directory: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +analog/ + This directory holds implementations of analog device drivers. + This includes drivers for Analog to Digital Conversion (ADC) as + well as drivers for Digital to Analog Conversion (DAC). + See include/nuttx/analog/*.h for registration information. + bch/ Contains logic that may be used to convert a block driver into a character driver. This is the complementary conversion as that performed by loop.c. See include/nuttx/fs.h for registration information. +analog/ + This directory holds implementations of input device drivers. + This includes such things as touchscreen and keypad drivers. + See include/nuttx/input/*.h for registration information. + lcd/ Drivers for parallel and serial LCD and OLED type devices. These drivers support interfaces as defined in include/nuttx/lcd/lcd.h @@ -74,7 +85,7 @@ sensors/ Drivers for various sensors serial/ - Front-ends character drivers for chip-specific UARTs. This provide + Front-end character drivers for chip-specific UARTs. This provide some TTY-like functionality and are commonly used (but not required for) the NuttX system console. See also include/nuttx/serial.h @@ -84,6 +95,9 @@ usbdev/ usbhost/ USB host drivers. See also include/nuttx/usb/usbhost.h +wireless/ + Drivers for various wireless devices. + Skeleton Files ^^^^^^^^^^^^^^ diff --git a/drivers/analog/Make.defs b/drivers/analog/Make.defs index ed09c709a4..8c868a84f0 100644 --- a/drivers/analog/Make.defs +++ b/drivers/analog/Make.defs @@ -39,7 +39,7 @@ ifeq ($(CONFIG_DAC),y) -# Include the common ADC character driver +# Include the common DAC character driver CSRCS += dac.c diff --git a/syscall/README.txt b/syscall/README.txt index 7797c5781f..42ef78b1f7 100644 --- a/syscall/README.txt +++ b/syscall/README.txt @@ -19,7 +19,7 @@ switch from user-mode to kernel-mode is accomplished using software interrupts (SWIs). SWIs are implemented differently and named differently by different manufacturers but all work essentially the same: A special instruction is executed in user-mode that causes a software generated -interrupt. The software generated interrrupt is caught within the kernel +interrupt. The software generated interrupt is caught within the kernel and handle in kernel-mode. Header Files @@ -117,7 +117,7 @@ database. Here the following definition is used: Proxy - A tiny bit of code that executes in the user space. A proxy has exactly the same function prototype as does the "real" function for which it proxies. However, it only serves to map the function - call into a syscall, marshalling all of the system call parameters + call into a syscall, marshaling all of the system call parameters as necessary. Stub - Another tiny bit of code that executes within the NuttX kernel