From ce88f176b6130c8fed20401b674bc4ddac491947 Mon Sep 17 00:00:00 2001
From: patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3>
Date: Mon, 12 Mar 2012 15:47:47 +0000
Subject: [PATCH] Add support for the Sure DB-DP11212 PIC32 board

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4476 42af7a65-404d-4744-a932-0658087f49c3
---
 Documentation/NuttX.html             |  6 ++---
 Documentation/NuttxPortingGuide.html | 34 ++++++++++++++++++++++++++--
 2 files changed, 35 insertions(+), 5 deletions(-)

diff --git a/Documentation/NuttX.html b/Documentation/NuttX.html
index e49e50f487..2920d46432 100644
--- a/Documentation/NuttX.html
+++ b/Documentation/NuttX.html
@@ -8,7 +8,7 @@
   <tr align="center" bgcolor="#e4e4e4">
     <td>
       <h1><big><font color="#3c34ec"><i>NuttX RTOS</i></font></big></h1>
-      <p>Last Updated: March 10, 2012</p>
+      <p>Last Updated: March 11, 2012</p>
     </td>
   </tr>
 </table>
@@ -478,7 +478,7 @@
   <td>
     <p>
       <li>
-        Network, USB (host), USB (device), serial, CAN, ADC, DAC, and PWM driver architectures.
+        Network, USB (host), USB (device), serial, CAN, ADC, DAC, PWM, and Quadrature Encoder driver architectures.
       </li>
     </p>
 </tr>
@@ -1790,7 +1790,7 @@
         <a href="http://www.nuttx.org/NuttShell.html">NSH User Guide</a>) as well as several other configurations.
         Additional drivers and configurations were added in NuttX 6.13-6.16.
         Drivers include an Ethernet driver, ADC driver, DAC driver, PWM driver, CAN driver, F4 RTC driver, Quadrature Encoder, DMA, SDIO with DMA
-        (most of these are compatible with the F1 family as well).
+        (these should all be compatible with the STM32 F2 family and many should also be compatible with the STM32 F1 family as well).
         The NuttX6.16 release also includes and logic for saving/restoring F4 FPU registers in context switches.
         Networking intensions include support for Telnet NSH sessions and new configurations for DHPCD and the networking test (nettest).
         A more complete port would include support for SDIO and USB OTG which are not available in NuttX 6.13.
diff --git a/Documentation/NuttxPortingGuide.html b/Documentation/NuttxPortingGuide.html
index f99cf45ad7..e920258620 100644
--- a/Documentation/NuttxPortingGuide.html
+++ b/Documentation/NuttxPortingGuide.html
@@ -12,7 +12,7 @@
       <h1><big><font color="#3c34ec">
         <i>NuttX RTOS Porting Guide</i>
       </font></big></h1>
-      <p>Last Updated: March 3, 2011</p>
+      <p>Last Updated: March 11, 2011</p>
     </td>
   </tr>
 </table>
@@ -128,7 +128,8 @@
        <a href="#usbdevdrivers">6.3.10 USB Device-Side Drivers</a><br>
        <a href="#analogdrivers">6.3.11 Analog (ADC/DAC) Drivers</a><br>
        <a href="#pwmdrivers">6.3.12 PWM Drivers</a><br>
-       <a href="#candrivers">6.3.13 CAN Drivers</a>
+       <a href="#candrivers">6.3.13 CAN Drivers</a><br>
+       <a href="#quadencoder">6.3.14 Quadrature Encoder Drivers</a>
     </ul>
     <a href="#pwrmgmt">6.4 Power Management</a>
     <ul>
@@ -3258,6 +3259,35 @@ extern void up_ledoff(int led);
   </li>
 </ul>
 
+<h3><a name="quadencoder">6.3.14 Quadrature Encoder Drivers</a></h3>
+<p>
+  NuttX supports only a low-level, two-part Quadrature Driver driver.
+</p>
+<ol>
+  <li>
+    An &quot;upper half&quot;, generic driver that provides the comman Quadrature Encoder interface to application level code, and
+  </li>
+  <li>
+    A &quot;lower half&quot;, platform-specific driver that implements the low-level timer controls to implement the Quadrature Encoder functionality.
+  </li>
+</ol>
+<p>
+  Files supporting the Quadrature Encoder can be found in the following locations:
+</p>
+<ul>
+  <li><b>Interface Definition</b>.
+    The header file for the NuttX Quadrature Encoder driver reside at <code>include/nuttx/sensors/qencoder.h</code>.
+    This header file includes both the application level interface to the Quadrature Encoder driver as well as the interface between the &quot;upper half&quot; and &quot;lower half&quot; drivers.
+    The Quadrature Encoder module uses a standard character driver framework.
+  </li>
+  <li><b>&quot;Upper Half&quot; Driver</b>.
+    The generic, &quot;upper half&quot; Quadrature Encoder driver resides at <code>drivers/sensors/qencoder.c</code>.
+  </li>
+  <li><b>&quot;Lower Half&quot; Drivers</b>.
+    Platform-specific Quadrature Encoder drivers reside in <code>arch/</code><i>&lt;architecture&gt;</i><code>/src/</code><i>&lt;chip&gt;</i> directory for the specific processor <i>&lt;architecture&gt;</i> and for the specific <i>&lt;chip&gt;</i> Quadrature Encoder peripheral devices.
+  </li>
+</ul>
+
 <h2><a name="pwrmgmt">6.4 Power Management</a></h2>
 
 <h3><a name="pmoverview">6.4.1 Overview</a></h3>