Documentation updates

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

2 files changed, 52 insertions, 12 deletions

diff --git a/nuttx/Documentation/NuttX.html b/nuttx/Documentation/NuttX.html
index a7d66da8c..1ac727263 100644
--- a/nuttx/Documentation/NuttX.html
+++ b/nuttx/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 15, 2011</p>
+      <p>Last Updated: March 16, 2011</p>
     </td>
   </tr>
 </table>
@@ -2200,6 +2200,8 @@ nuttx-5.20 2011-xx-xx Gregory Nutt &lt;spudmonkey@racsa.co.cr&gt;
     * drivers/net/slip.c -- SLIP is now basically functional on the
       LPC17xx with some caveats as described in the TODO list under
       LPC17xx.
+    * arch/x86/include/i486/irq.h -- Fix irqrestore() macro... it was not
+      correctly re-enabling interrupts.
 
 apps-5.20 2011-xx-xx Gregory Nutt &lt;spudmonkey@racsa.co.cr&gt;
 
diff --git a/nuttx/Documentation/NuttxPortingGuide.html b/nuttx/Documentation/NuttxPortingGuide.html
index c9d7f6bd2..d7f65090f 100644
--- a/nuttx/Documentation/NuttxPortingGuide.html
+++ b/nuttx/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 12, 2011</p>
+      <p>Last Updated: March 16, 2011</p>
     </td>
   </tr>
 </table>
@@ -3305,16 +3305,17 @@ build
   </li>
   <li>
     <code>CONFIG_NET_SLIP</code>: Selects the Serial Line Internet Protocol (SLIP) data link layer.
-     The default data link layer for uIP is Ethernet.
-     If <code>CONFIG_NET_SLIP</code> is defined in the NuttX header file, then SLIP will be supported.
-     The basic differences between the SLIP and Ethernet configurations is that when SLIP is selected:
-     <ul>
-       <li>The link level header (that comes before the IP header) is omitted.</li>
-       <li>All MAC address processing is suppressed.</li>
-       <li>ARP is disabled.</li>
-     </ul>
-     If <code>CONFIG_NET_SLIP</code> is not supported, then Ethernet will be used
-     (there is no need to define anything special in the configuration file to use Ethernet -- it is the default).
+     (This selection is discussed further <a href="#slipdriver">below</a>).
+  </li>
+  <li>
+    <code>CONFIG_NET_NOINTS</code>: <code>CONFIG_NET_NOINT</code> indicates that uIP not called from the interrupt level.
+    If <code>CONFIG_NET_NOINTS</code> is defined, critical sections will be managed with semaphores;
+    Otherwise, it assumed that uIP will be called from interrupt level handling and critical sections will be managed by enabling and disabling interrupts.
+  </li>
+  <li>
+    <code>CONFIG_NET_MULTIBUFFER</code>: Traditionally, uIP has used a single buffer for all incoming and outgoing traffic.
+    If this configuration is selected, then the driver can manage multiple I/O buffers and can, for example, be filling one input buffer while sending another output buffer.
+    Or, as another example, the driver may support queuing of concurrent input/ouput and output transfers for better performance.
   </li>
   <li>
     <code>CONFIG_NET_IPv6</code>: Build in support for IPv6
@@ -3408,6 +3409,43 @@ build
   </li>
 </ul>
 
+<h3><a name="slipdriver">SLIP</a></h3>
+<p>
+  The NuttX SLIP driver supports point-to-point IP communications over a serial port.
+  The default data link layer for uIP is Ethernet.
+  If <code>CONFIG_NET_SLIP</code> is defined in the NuttX configuration file, then SLIP will be supported.
+  The basic differences between the SLIP and Ethernet configurations is that when SLIP is selected:
+   <ul>
+     <li>The link level header (that comes before the IP header) is omitted.</li>
+     <li>All MAC address processing is suppressed.</li>
+     <li>ARP is disabled.</li>
+   </ul>
+   If <code>CONFIG_NET_SLIP</code> is not selected, then Ethernet will be used
+   (there is no need to define anything special in the configuration file to use Ethernet -- it is the default).
+</p>
+<ul>
+  <li>
+    <code>CONFIG_NET_SLIP</code>: Enables building of the SLIP driver.
+    SLIP requires at least one IP protocols selected and the following additional network settings: <code>CONFIG_NET_NOINTS</code> and <code>CONFIG_NET_MULTIBUFFER</code>.
+    <code>CONFIG_NET_BUFSIZE</code> <i>must</i> be set to 296.
+    Other optional configuration settings that affect the SLIP driver: <code>CONFIG_NET_STATISTICS</code>.
+    Default: Ethernet.
+  </li>
+  <p>
+    If SLIP is selected, then the following SLIP options are available:
+  </p>
+  <li>
+    <code>CONFIG_CLIP_NINTERFACES</code>: Selects the number of physical SLIP interfaces to support.  Default: 1
+  </li>
+  <li>
+    <code>CONFIG_SLIP_STACKSIZE</code>: Select the stack size of the SLIP RX and TX tasks.  Default: 2048
+  </li>
+  <li>
+    <code>CONFIG_SLIP_DEFPRIO</code>: The priority of the SLIP RX and TX tasks. Default: 128
+  </li>
+  </li>
+</ul>
+
 <h3>UIP Network Utilities</h3>
 <ul>
   <li>