git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@4276 35acf78f-673a-0410-8e92-d51de3d6d3f4

3 files changed, 42 insertions, 70 deletions

diff --git a/os/hal/dox/i2s.dox b/os/hal/dox/i2s.dox
new file mode 100644
index 000000000..2c6cc4ca2
--- /dev/null
+++ b/os/hal/dox/i2s.dox
@@ -0,0 +1,31 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,

+                 2011,2012 Giovanni Di Sirio.

+

+    This file is part of ChibiOS/RT.

+

+    ChibiOS/RT is free software; you can redistribute it and/or modify

+    it under the terms of the GNU General Public License as published by

+    the Free Software Foundation; either version 3 of the License, or

+    (at your option) any later version.

+

+    ChibiOS/RT is distributed in the hope that it will be useful,

+    but WITHOUT ANY WARRANTY; without even the implied warranty of

+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+    GNU General Public License for more details.

+

+    You should have received a copy of the GNU General Public License

+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

+*/

+

+/**

+ * @defgroup I2S I2S Driver

+ * @brief   Generic I2S Driver.

+ * @details This module implements a generic I2S  driver.

+ * @pre     In order to use the I2S driver the @p HAL_USE_I2S option

+ *          must be enabled in @p halconf.h.

+ *

+ * @section i2s_1 Driver State Machine

+ *

+ * @ingroup IO

+ */

diff --git a/os/hal/dox/tm.dox b/os/hal/dox/tm.dox
index d895a6d30..c4c537776 100644
--- a/os/hal/dox/tm.dox
+++ b/os/hal/dox/tm.dox
@@ -19,7 +19,7 @@
 */

 

 /**

- * @defgroup TM Time Measurement Driver.

+ * @defgroup TM Time Measurement Driver

  *

  * @brief   Time Measurement unit.

  * @details This module implements a time measurement mechanism able to

diff --git a/os/hal/dox/usb.dox b/os/hal/dox/usb.dox
index 7298e191d..748e41afe 100644
--- a/os/hal/dox/usb.dox
+++ b/os/hal/dox/usb.dox
@@ -86,7 +86,7 @@
     selected -> selected [label="\nSUSPEND/WAKEUP\n>event_cb<\n\nValid EP0 Message\n>requests_hook_cb<\n\nGET DESCRIPTOR\n>get_descriptor_cb<"];

     selected -> configured [label="\nSET_CONF(n)\n>event_cb<"];

     configured -> selected [label="\nSET_CONF(0)\n>event_cb<"];

-    configured -> configured [label="\nSUSPEND/WAKEUP\n>event_cb<\n\nValid EP0 Message\n>requests_hook_cb<\n\nGET DESCRIPTOR\n>get_descriptor_cb<\n\nEndpoints Activity\n >in_cb< or >out_cb<"];

+    configured -> configured [label="\nSUSPEND/WAKEUP\n>event_cb<\n\nValid EP0 Message\n>requests_hook_cb<\n\nGET DESCRIPTOR\n>get_descriptor_cb<\n\nEndpoints Activity\n >in_cb< >out_cb< >setup_cb<"];

     configured -> ready [label="\nUSB RESET\n>event_cb<"];

   }

  * @enddot

@@ -115,57 +115,9 @@
  * - <b>OUT</b> endpoints are used by the application to receive data from

  *   the host.

  * .

- * In ChibiOS/RT the endpoints can be configured in two distinct ways:

- * - <b>Packet Mode</b>. In this mode the driver invokes a callback each

- *   time a packet has been received or transmitted. This mode is especially

- *   suited for those applications handling continuous streams of data.

- *   <br><br>

- *   States diagram for OUT endpoints in packet mode:

- *   @dot

-  digraph example {

-    rankdir="LR";

-    node [shape=circle, fontname=Helvetica, fontsize=8, fixedsize="true",

-          width="0.9", height="0.9"];

-    edge [fontname=Helvetica, fontsize=8];

-

-    disabled [label="EP_DISABLED\nDisabled", style="bold"];

-    receiving [label="EP_BUSY\nReceiving Packet"];

-    idle [label="EP_IDLE\nPacket in Buffer"];

-

-    disabled -> receiving [label="\nusbInitEndpointI()"];

-    receiving -> idle [label="\npacket received\n>out_cb<"];

-    idle -> receiving [label="\nusbReadPacketBuffer()\nusbStartReceiveI()"];

-    receiving -> disabled [label="\nUSB RESET\nusbDisableEndpointsI()"];

-    idle -> disabled [label="\nUSB RESET\nusbDisableEndpointsI()"];

-  }

- *   @enddot

- *   <br><br>

- *   States diagram for IN endpoints in packet mode:

- *   @dot

-  digraph example {

-    rankdir="LR";

-    node [shape=circle, fontname=Helvetica, fontsize=8, fixedsize="true",

-          width="0.9", height="0.9"];

-    edge [fontname=Helvetica, fontsize=8];

-

-    disabled [label="EP_DISABLED\nDisabled", style="bold"];

-    transmitting [label="EP_BUSY\nSending Packet"];

-    idle [label="EP_IDLE\nBuffer Empty"];

-

-    disabled -> idle [label="\nusbInitEndpointI()"];

-    idle -> transmitting [label="\nusbWritePacketBuffer()\nusbStartTransmitI()"];

-    transmitting -> idle [label="\npacket sent\n>in_cb<"];

-    transmitting -> disabled [label="\nUSB RESET\nusbDisableEndpointsI()"];

-    idle -> disabled [label="\nUSB RESET\nusbDisableEndpointsI()"];

-  }

- *   @enddot

- *   <br><br>

- * - <b>Transaction Mode</b>. In this mode the driver invokes a callback

- *   only after a large, potentially multi-packet, transfer has been

- *   completed, a callback is invoked only at the end of the transfer.

- *   <br><br>

- *   States diagram for OUT endpoints in transaction mode:

- *   @dot

+ * The driver invokes a callback after finishing an IN or OUT transaction.

+ * States diagram for OUT endpoints in transaction mode:

+ * @dot

   digraph example {

     rankdir="LR";

     node [shape=circle, fontname=Helvetica, fontsize=8, fixedsize="true",

@@ -183,10 +135,10 @@
     receiving -> disabled [label="\nUSB RESET\nusbDisableEndpointsI()"];

     idle -> disabled [label="\nUSB RESET\nusbDisableEndpointsI()"];

   }

- *   @enddot

- *   <br><br>

- *   States diagram for IN endpoints in transaction mode:

- *   @dot

+ * @enddot

+ * <br><br>

+ * States diagram for IN endpoints in transaction mode:

+ * @dot

   digraph example {

     rankdir="LR";

     node [shape=circle, fontname=Helvetica, fontsize=8, fixedsize="true",

@@ -204,19 +156,8 @@
     transmitting -> disabled [label="\nUSB RESET\nusbDisableEndpointsI()"];

     idle -> disabled [label="\nUSB RESET\nusbDisableEndpointsI()"];

   }

- *   @enddot

- *   <br><br>

- * .

- * @subsection usb_2_3 USB Packet Buffers

- * An important difference between packet and transaction modes is that there

- * is a dedicated endpoint buffer in packet mode while in transaction mode

- * the application has to specify its own buffer for duration of the whole

- * transfer.<br>

- * Packet buffers cannot be accessed directly by the application because those

- * could not be necessarily memory mapped, a buffer could be a FIFO or some

- * other kind of memory accessible in a special way depending on the

- * underlying hardware architecture, the functions @p usbReadPacketI() and

- * @p usbWritePacketI() allow to access packet buffers in an abstract way.

+ * @enddot

+ * <br><br>

  *

  * @subsection usb_2_4 USB Callbacks

  * The USB driver uses callbacks in order to interact with the application.