Update to README files

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

Documentation/README.html

@@ -8,7 +8,7 @@
   <tr align="center" bgcolor="#e4e4e4">
     <td>
       <h1><big><font color="#3c34ec"><i>NuttX README Files</i></font></big></h1>
-      <p>Last Updated: December 20, 2011</p>
+      <p>Last Updated: December 24, 2011</p>
     </td>
   </tr>
 </table>
@@ -64,6 +64,8 @@
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/detron/README.txt?view=log"><b><i>README.txt</i></b></a>
  |   |   |- ea3131/
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/ea3131/README.txt?view=log"><b><i>README.txt</i></b></a>
+ |   |   |- ea3152/
+ |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/ea3152/README.txt?view=log"><b><i>README.txt</i></b></a>
  |   |   |- eagle100/
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/eagle100/include/README.txt?view=log">include/README.txt</a>
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/eagle100/src/README.txt?view=log">src/README.txt</a>
@@ -90,7 +92,7 @@
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/lm3s6965-ek/include/README.txt?view=log">include/README.txt</a>
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/lm3s6965-ek/src/README.txt?view=log">src/README.txt</a>
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/lm3s6965-ek/README.txt?view=log"><b><i>README.txt</i></b></a>
- |   |   |- lm3s8962
+ |   |   |- lm3s8962-ek/
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/lm3s8962-ek/include/README.txt?view=log">include/README.txt</a>
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/lm3s8962-ek/src/README.txt?view=log">src/README.txt</a>
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/lm3s8962-ek/README.txt?view=log"><b><i>README.txt</i></b></a>
@@ -140,7 +142,8 @@
  |   |   |- qemu-i486/
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/qemu-i486/include/README.txt?view=log">include/README.txt</a>
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/qemu-i486/src/README.txt?view=log">src/README.txt</a>
- |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/qemu-i486/README.txt?view=log"><b><i>README.txt</i></b |   |   |- rgmp/
+ |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/qemu-i486/README.txt?view=log"><b><i>README.txt</i></b></a>
+ |   |   |- rgmp/
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/rgmp/include/README.txt?view=log">include/README.txt</a>
  |   |   |   |- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/rgmp/src/README.txt?view=log">src/README.txt</a>
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/rgmp/README.txt?view=log"><b><i>README.txt</i></b></a>></a>
@@ -163,6 +166,8 @@
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/stm3240g-eval/README.txt?view=log"><b><i>README.txt</i></b></a>
  |   |   |- sure-pic32mx/
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/sure-pic32mx/README.txt?view=log"><b><i>README.txt</i></b></a>
+ |   |   |- teensy/
+ |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/teensy/README.txt?view=log"><b><i>README.txt</i></b></a>
  |   |   |- twr-k60n512/
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/twr-k60n512/README.txt?view=log"><b><i>README.txt</i></b></a>
  |   |   |- us7032evb1/
@@ -193,6 +198,8 @@
  |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/z8f64200100kit/README.txt?view=log"><b><i>README.txt</i></b></a>
  |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/configs/README.txt?view=log"><b><i>README.txt</i></b></a>
  |   |- drivers/
+ |   |   |- mmap/
+ |   |   |   `- <a href="http://nuttx.svn.sourceforge.net/viewvc/nuttx/trunk/nuttx/drivers/lcd/README.txt?view=log"><b><i>README.txt</i></b></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

@@ -351,6 +351,8 @@ nuttx
  |   |   `- README.txt
  |   |- ea3131/
  |   |   `- README.txt
+ |   |- ea3152/
+ |   |   `- README.txt
  |   |- eagle100/
  |   |   |- include/README.txt
  |   |   |- src/README.txt
@@ -366,6 +368,10 @@ nuttx
  |   |   |- ostest/README.txt
  |   |   |- poll/README.txt
  |   |   `- README.txt
+ |   |-  hymini-stm32v/
+ |   |   |- include/README.txt
+ |   |   |- src/README.txt
+ |   |   `- README.txt
  |   |- kwikstik-k40/
  |   |   `- README.txt
  |   |- lm3s6965-ek/
@@ -442,8 +448,12 @@ nuttx
  |   |   |- RIDE/README.txt
  |   |   |- src/README.txt
  |   |   `- README.txt
+ |   |- stm3240g-eval/
+ |   |   `- README.txt
  |   |- sure-pic32mx/
  |   |   `- README.txt
+ |   |- teensy/
+ |   |   `- README.txt
  |   |- twr-k60n512/
  |   |   `- README.txt
  |   |- us7032evb1/
@@ -474,6 +484,8 @@ nuttx
  |   |   `- README.txt
  |   `- README.txt
  |- drivers/
+ |   |- lcd/
+ |   |   `- README.txt
  |   `- README.txt
  |- fs/
  |   |- mmap/

configs/pic32-starterkit/README.txt

@@ -51,6 +51,7 @@ Contents
   MEB Connector
   PICtail
   Toolchains
+  Powering the Board
   Loading NuttX with PICkit2
   Serial Console
   PIC32MX Configuration Options
@@ -419,6 +420,17 @@ Toolchains
      If you have problems with the dependency build (for example, if you are not
      building on C:), then you may need to modify tools/mkdeps.sh
 
+Powering the Board
+==================
+
+  "Power can be supplied to the Multimedia Expansion Board through the DC
+   connector located on the Multimedia Expansion Board... By connecting 
+   9-14V power supply to the DC connector, the Multimedia Expansion Board
+   and starter kit will receive the proper voltages. The user can also
+   supply power via the starter kit. However, if the application uses
+   multiple features of the Multimedia Expansion Board, it is recommended
+   to use 9-14V power supply."
+
 Loading NuttX with PICkit2
 ==========================
 

configs/pic32-starterkit/ostest/defconfig

@@ -49,7 +49,9 @@
 # CONFIG_ARCH_BOARD_name - for use in C code
 # CONFIG_ENDIAN_BIG - define if big endian (default is little endian)
 #   NOTE: The PIC32MX is always little endian.
-# CONFIG_BOARD_LOOPSPERMSEC - for delay loops
+# CONFIG_BOARD_LOOPSPERMSEC.  You simply use a stop watch to measure
+#   the 100 second delay then adjust CONFIG_BOARD_LOOPSPERMSEC until
+#   the delay actually is 100 seconds.
 # CONFIG_DRAM_SIZE - Describes the installed DRAM.
 # CONFIG_DRAM_START - The start address of DRAM (physical)
 # CONFIG_DRAM_END - Last address+1 of installed RAM
@@ -65,9 +67,6 @@
 # CONFIG_ARCH_CALIBRATION - Enables some build in instrumentation that
 #   cause a 100 second delay during boot-up.  This 100 second delay
 #   serves no purpose other than it allows you to calibrate
-# CONFIG_BOARD_LOOPSPERMSEC.  You simply use a stop watch to measure
-#   the 100 second delay then adjust CONFIG_BOARD_LOOPSPERMSEC until
-#   the delay actually is 100 seconds.
 # CONFIG_ARCH_DMA - Support DMA initialization
 #
 CONFIG_ARCH=mips
@@ -177,7 +176,7 @@ CONFIG_PIC32MX_IOPORTG=y
 #    can be enabled later by software).
 #
 CONFIG_PIC32MX_DEBUGGER=2
-CONFIG_PIC32MX_ICESEL=0
+CONFIG_PIC32MX_ICESEL=1
 
 #
 # PIC32MX specific serial device driver settings

drivers/lcd/README.txt

@@ -0,0 +1,135 @@
+Contents
+========
+
+This is the README.txt file for the drivers/lcd/ directory.
+
+  - LCD Header files
+    include/nuttx/lcd/lcd.h
+    struct lcd_dev_s
+  - Binding LCD Drivers
+  - Examples: /drivers/lcd/
+  - Examples: configs/
+  - graphics/
+
+LCD Header files
+================
+
+  include/nuttx/lcd/lcd.h
+
+      Structures and APIs needed to work with LCD drivers are provided in
+      this header file.  This header file also depends on some of the same
+      definitions used for the frame buffer driver as privided in
+      include/nuttx/fb.h.
+
+  struct lcd_dev_s
+
+      Each LCD device driver must implement an instance of struct lcd_dev_s.
+      That structure defines a call table with the following methods:
+
+      - Get information about the LCD video controller configuration and the
+        configuration of each LCD color plane.
+
+        int (*getvideoinfo)(FAR struct lcd_dev_s *dev,
+                            FAR struct fb_videoinfo_s *vinfo);
+        int (*getplaneinfo)(FAR struct lcd_dev_s *dev, unsigned int planeno,
+                           FAR struct lcd_planeinfo_s *pinfo);
+
+      - The following are provided only if the video hardware supports RGB
+        color mapping:
+
+        int (*getcmap)(FAR struct lcd_dev_s *dev,
+                       FAR struct fb_cmap_s *cmap);
+        int (*putcmap)(FAR struct lcd_dev_s *dev,
+                       FAR const struct fb_cmap_s *cmap);
+
+      - The following are provided only if the video hardware supports a
+        hardware cursor:
+
+        int (*getcursor)(FAR struct lcd_dev_s *dev,
+                         FAR struct fb_cursorattrib_s *attrib);
+        int (*setcursor)(FAR struct lcd_dev_s *dev,
+                         FAR struct fb_setcursor_s *settings);
+
+      - Get the LCD panel power status (0: full off - CONFIG_LCD_MAXPOWER:
+        full on). On backlit LCDs, this setting may correspond to the
+        backlight setting.
+
+        int (*getpower)(struct lcd_dev_s *dev);
+
+      - Enable/disable LCD panel power (0: full off - CONFIG_LCD_MAXPOWER:
+        full on). On backlit LCDs, this setting may correspond to the
+        backlight setting.
+
+        int (*setpower)(struct lcd_dev_s *dev, int power);
+
+      - Get the current contrast setting (0-CONFIG_LCD_MAXCONTRAST) */
+
+        int (*getcontrast)(struct lcd_dev_s *dev);
+
+     - Set LCD panel contrast (0-CONFIG_LCD_MAXCONTRAST)
+
+        int (*setcontrast)(struct lcd_dev_s *dev, unsigned int contrast);
+
+Binding LCD Drivers
+===================
+
+  LCD drivers are not normally directly accessed by user code, but are
+  usually bound to another,  higher level device driver. In general, the
+  binding sequence is:
+
+  1. Get an instance of struct lcd_dev_s from the hardware-specific LCD
+     device driver, and 
+  2. Provide that instance to the initialization method of the higher
+    level device driver.
+
+Examples: /drivers/lcd/
+=======================
+
+Re-usable LCD drivers reside in the drivers/lcd directory:
+
+  nokia6100.c.  Supports the Nokia 6100 display with either the Philips
+    PCF883 or the Epson S1D15G10 display controller.  This LCD is used
+    with the Olimex LPC1766-STK (but has not been fully integrated).
+  
+  p14201.c.  Driver for RiT P14201 series display with SD1329 IC
+    controller.  This OLED is used with older versions of the
+    TI/Luminary LM3S8962 Evaluation Kit.
+  
+  ug-9664hswag01.c.  OLED Display Module, UG-9664HSWAG01", Univision
+    Technology Inc.  Used with the LPC Xpresso and Embedded Artists
+    base board.
+
+Examples: configs/
+==================
+
+There are additional LCD drivers in the configs/<board>/src directory
+that support additional LCDs.  LCD drivers in the configuration directory
+if they support some differ LCD interface (such as a parallel interface)
+that makes then less re-usable:
+
+configs/sam3u-ek/src/up_lcd.c.
+
+  configs/hymini-stm32v/src/ssd1289.c.
+  
+    SSD1289
+  
+  configs/sam3u-ek/src/up_lcd.c
+  
+    The SAM3U-EK developement board features a TFT/Transmissive color
+    LCD module with touch-screen, FTM280C12D, with integrated driver IC
+    HX8346.
+
+  configs/stm3210e-eval/src/up_lcd.c
+
+    This driver supports the following LCDs:
+
+    1. Ampire AM-240320LTNQW00H
+    2. Orise Tech SPFD5408B
+    3. RenesasSP R61580
+     
+  configs/skp16c26/src/up_lcd.c.  Untest alphanumeric LCD driver.
+
+graphics/
+=========
+
+  See also the usage of the LCD driver in the graphics/ directory.