From 4b0e8e56cfef3ccfeecd27aae6d27cf63f4915d9 Mon Sep 17 00:00:00 2001
From: Gregory Nutt
Date: Wed, 31 Aug 2016 10:58:08 -0600
Subject: [PATCH] Add contactless/ directory to Documentation
---
Documentation/NuttxPortingGuide.html | 113 ++++++++++++++++++++++++---
drivers/README.txt | 5 ++
2 files changed, 109 insertions(+), 9 deletions(-)
diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html
index bf32596fef0..cf7c53dba90 100644
--- a/Documentation/NuttxPortingGuide.html
+++ b/Documentation/NuttxPortingGuide.html
@@ -12,7 +12,7 @@
NuttX RTOS Porting Guide
- Last Updated: June 22, 2016
+ Last Updated: August 31, 2016
@@ -948,22 +948,46 @@ drivers/
| |-- Kconfig
| |-- Make.defs
| `-- (Common ADC and DAC driver source files)
+|-- audio/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (Common audio device source files)
|-- bch/
| |-- Kconfig
| |-- Make.defs
| `-- (bch driver source files)
+|-- contactless/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (Common contactless device driver source files)
|-- input/
| |-- Kconfig
| |-- Make.defs
| `-- (Common touchscreen and keypad driver source files)
+|-- ioexpander/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (Common I/O expander and GPIO-related driver source files)
|-- lcd/
| |-- Kconfig
| |-- Make.defs
| `-- (Common LCD driver source files)
+|-- leds/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (Common LED device driver source files)
+|-- loop/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (Common loop device driver source files)
|-- mmcsd/
| |-- Kconfig
| |-- Make.defs
| `-- (Common MMC/SD card driver source files)
+|-- modem/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (Common modem driver source files)
|-- mtd/
| |-- Kconfig
| |-- Make.defs
@@ -972,11 +996,19 @@ drivers/
| |-- Kconfig
| |-- Make.defs
| `-- (Common network driver source files)
+|-- pipes/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (Common pipe and FIFO driver source files)
+|-- power/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (Common power-related driver source files)
|-- sensors/
| |-- Kconfig
| |-- Make.defs
| `-- (Common sensor driver source files)
-|-- serial/
+|-- sercomm/
| |-- Kconfig
| |-- Make.defs
| `-- (Files for the Calypso SERCOMM driver)
@@ -984,6 +1016,18 @@ drivers/
| |-- Kconfig
| |-- Make.defs
| `-- (Common front-end character drivers for chip-specific UARTs)
+|-- spi/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (Common SPI-related drivers and helper fuctions)
+|-- syslog/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (System logging device support)
+|-- timers/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (Timer-based device driver support)
|-- usbdev/
| |-- Kconfig
| |-- Make.defs
@@ -992,6 +1036,10 @@ drivers/
| |-- Kconfig
| |-- Make.defs
| `-- (Common USB host driver source files)
+|-- usbmonitor/
+| |-- Kconfig
+| |-- Make.defs
+| `-- (USB monitor source files)
|-- wireless/
| |-- Kconfig
| |-- Make.defs
@@ -1085,19 +1133,35 @@ include/
| |-analog/
| | `-- (Analog driver header files)
| |-audio/
-| | `-- (Audio driver header files)
+| | `-- (Contactless driver header files)
| |-binfmt/
| | `-- (Binary format header files)
+| |-contactless/
+| | `-- (Audio driver header files)
+| |-crypto/
+| | `-- (Cryptographic support header files)
+| |-drivers/
+| | `-- (Miscellaneous driver header files)
+| |-eeprom/
+| | `-- (EEPROM driver header files)
| |-fs/
| | `-- (File System header files)
| |-input/
| | `-- (Input device driver header files)
+| |-ioexpander/
+| | `-- (I/O exander and GPIO drvier header files)
| |-lcd/
| | `-- (LCD driver header files)
+| |-leds/
+| | `-- (LED driver header files)
+| |-lib/
+| | `-- (Non-standard C library driver header files)
+| |-mm/
+| | `-- (Memory management header files)
+| |-modem/
+| | `-- (Modem driver header files)
| |-mtd/
| | `-- (Memory technology device header files)
-| |-serial/
-| | `-- (Serial driver header files)
| |-net/
| | `-- (Networking header files)
| |-nx/
@@ -1114,8 +1178,12 @@ include/
| | `-- (SPI driver header files)
| |-syslog/
| | `-- (SYSLOG header files)
+| |-timers/
+| | `-- (Timer-related driver header files)
| |-usb/
| | `-- (USB driver header files)
+| |-video/
+| | `-- (Video-related driver header files)
| `-wireless/
| `-- (Wireless device driver header files)
`- sys/
@@ -1148,16 +1216,28 @@ include/
libc/
+|-- aio/
+| `-- (Implementation of functions from aio.h)
+|-- audio/
+| `-- (Implementation of audio-related functions)
+|-- dirent/
+| `-- (Implementation of functions from dirent.h)
+|-- fixedmath/
+| `-- (Implementation of functions from fixedmath.h)
+|-- hex2bin/
+| `-- (Implementation of functions from hex2bin.h)
|-- libgen/
| `-- (Implementation of functions from libgen.h)
|-- math/
| `-- (Implementation of functions from fixedmath.h)
|-- misc/
| `-- (Implementation of miscellaneous library functions)
-|-- mqueue/
-| `-- (Implementation of some functions from mqueue.h)
|-- net/
| `-- (Implementation of network-related library functions)
+|-- netdb/
+| `-- (Implementation of functions from netdb.h)
+|-- pthread/
+| `-- (Implementation of functions from pthread.h)
|-- queue/
| `-- (Implementation of functions from queue.h)
|-- sched/
@@ -1166,16 +1246,31 @@ libc/
| `-- (Implementation of some functions from semaphore.h)
|-- signal/
| `-- (Implementation of some functions from signal.h)
+|-- spawn/
+| `-- (Implementation of some functions from spawn.h)
|-- stdio/
| `-- (Implementation of functions from stdio.h)
|-- stdlib/
| `-- (Implementation of functions from stdlib.h)
|-- string/
| `-- (Implementation of functions from string.h)
+|-- symtab/
+| `-- (Implementation of symbol-table library functions)
+|-- syslog/
+| `-- (Implementation of functions from syslog.h)
+|-- termios/
+| `-- (Implementation of functions from termios.h)
|-- time/
| `-- (Implementation of some functions from time.h)
-`-- unistd/
- `-- (Implementation of some functions from unistd.h)
+|-- tls/
+| `-- (Implementation of some functions from tls.h)
+|-- wqueue/
+| `-- (Implementation of some functions from wqueue.h)
+|-- unistd/
+| `-- (Implementation of some functions from unistd.h)
+`-- zoneinfo/
+ `-- (Implementation of timezone database)
+
diff --git a/drivers/README.txt b/drivers/README.txt
index a76c0e3434f..fbb13ce25d7 100644
--- a/drivers/README.txt
+++ b/drivers/README.txt
@@ -55,6 +55,11 @@ bch/
performed by loop.c. See include/nuttx/fs/fs.h for registration
information.
+contactless/
+ Contactless devices are related to wireless devices. They are not
+ communication devices with other similar peers, but couplers/interfaces
+ to contactless cards and tags.
+
eeprom/
An EEPROM is a form of Memory Technology Device (see drivers/mtd).
EEPROMs are non-volatile memory like FLASH, but differ in underlying