Additional documentation/README updates

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4519 42af7a65-404d-4744-a932-0658087f49c3

Documentation/README.html

@@ -210,6 +210,8 @@
  |   |- drivers/
  |   |   |- lcd/
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/drivers/lcd/README.txt?view=log"><b><i>README.txt</i></b></a>
+ |   |   |- sercomm/
+ |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/drivers/sercomm/README.txt?view=log">README.txt</a>
  |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/drivers/README.txt?view=log"><b><i>README.txt</i></b></a>
  |   |- fs/
  |   |   |- mmap/

README.txt

@@ -693,6 +693,8 @@ nuttx
  |- drivers/
  |   |- lcd/
  |   |   `- README.txt
+ |   |- sercomm/
+ |   |   `- README.txt
  |   `- README.txt
  |- fs/
  |   |- mmap/

drivers/README.txt

@@ -13,7 +13,7 @@ Files in this directory
 ^^^^^^^^^^^^^^^^^^^^^^^
 
 can.c
-	An unfinished CAN driver.
+  This is a CAN driver.  See include/nuttx/can.h for usage information.
 
 dev_null.c and dev_zero.c
   These files provide the standard /dev/null and /dev/zero devices.
@@ -26,6 +26,11 @@ loop.c
   file (or character device) as a block device.  See losetup() and
   loteardown() in include/nuttx/fs/fs.h.
 
+pwm.c
+  Provides the "upper half" of a pulse width modulation (PWM) driver.
+  The "lower half" of the PWM driver is provided by device-specific
+  logic.  See include/nuttx/pwm.h for usage information.
+
 ramdisk.c
   Can be used to set up a block of memory or (read-only) FLASH as
   a block driver that can be mounted as a files system.  See
@@ -63,7 +68,7 @@ bch/
   performed by loop.c.  See include/nuttx/fs/fs.h for registration
   information.
 
-analog/
+input/
   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.
@@ -94,7 +99,7 @@ pipes/
   FIFO and named pipe drivers.  Standard interfaces are declared
   in include/unistd.h
 
-pm/
+power/
   Power management (PM) driver interfaces.  These interfaces are used
   to manage power usage of a platform by monitoring driver activity
   and by placing drivers into reduce power usage modes when the
@@ -103,6 +108,16 @@ pm/
 sensors/
   Drivers for various sensors
 
+sercomm/
+  Sercomm is the transport used by osmocom-bb that runs on top of serial.
+  See http://bb.osmocom.org/trac/wiki/nuttx-bb/run for detailed the usage
+  of nuttx with sercomm.
+
+  drivers/sercomm is only built if CONFIG_SERCOMM_CONSOLE in the NuttX
+  configuration file.  If you attempt to build this driver without
+  osmocom-bb, you will get compilation errors because of header files
+  that are needed from the osmocom-bb.
+
 serial/
   Front-end character drivers for chip-specific UARTs.  This provide
   some TTY-like functionality and are commonly used (but not required for)

drivers/sercomm/README.txt

@@ -0,0 +1,19 @@
+drivers/sercomm README
+======================
+
+If CONFIG_SERCOMM_CONSOLE is defined in the NuttX configuration file, NuttX
+will attempt to use sercomm (HDLC protocol) to communicate with the
+host system. Sercomm is the transport used by osmocom-bb that runs on top
+of serial.  See http://bb.osmocom.org/trac/wiki/nuttx-bb/run for detailed
+the usage of nuttx with sercomm.
+
+The drivers/sercomm build that you have the osmocom-bb project directory
+at same level as the nuttx project:
+
+  |- nuttx
+  |- apps
+  `- osmocom-bb
+
+If you attempt to build this driver without osmocom-bb, you will get
+compilation errors  because ofheader files that are needed from the
+osmocom-bb directory.