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

3 files changed, 102 insertions, 3 deletions

diff --git a/os/hal/dox/serial.dox b/os/hal/dox/serial.dox
index d4f2cf634..c2fae58f5 100644
--- a/os/hal/dox/serial.dox
+++ b/os/hal/dox/serial.dox
@@ -30,5 +30,31 @@
  * @pre     In order to use the SERIAL driver the @p HAL_USE_SERIAL option

  *          must be enabled in @p halconf.h.

  *

+ *

+ * @section serial_1 Driver State Machine

+ * The driver implements a state machine internally, not all the driver

+ * functionalities can be used in any moment, any transition not explicitly

+ * shown in the following diagram has to be considered an error and shall

+ * be captured by an assertion (if enabled).

+ * @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];

+

+    uninit [label="SD_UNINIT", style="bold"];

+    stop [label="SD_STOP\nLow Power"];

+    ready [label="SD_READY\nClock Enabled"];

+

+    uninit -> stop [label=" sdInit()"];

+    stop -> stop [label="\nsdStop()"];

+    stop -> ready [label="\nsdStart()"];

+    ready -> stop [label="\nsdStop()"];

+    ready -> ready [label="\nsdStart()"];

+    ready -> ready [label="\nAny I/O operation"];

+  }

+ * @enddot

+ *

  * @ingroup IO

  */

diff --git a/os/hal/dox/serial_usb.dox b/os/hal/dox/serial_usb.dox
index 0f857052b..4384a59f8 100644
--- a/os/hal/dox/serial_usb.dox
+++ b/os/hal/dox/serial_usb.dox
@@ -31,9 +31,25 @@
  * functionalities can be used in any moment, any transition not explicitly

  * shown in the following diagram has to be considered an error and shall

  * be captured by an assertion (if enabled).

- * @if LATEX_PDF

- * @else

- * @endif

+ * @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];

+

+    uninit [label="SDU_UNINIT", style="bold"];

+    stop [label="SDU_STOP\nLow Power"];

+    ready [label="SDU_READY\nClock Enabled"];

+

+    uninit -> stop [label=" sduInit()"];

+    stop -> stop [label="\nsduStop()"];

+    stop -> ready [label="\nsduStart()"];

+    ready -> stop [label="\nsduStop()"];

+    ready -> ready [label="\nsduStart()"];

+    ready -> ready [label="\nAny I/O operation"];

+  }

+ * @enddot

  *

  * @ingroup IO

  */

diff --git a/os/hal/dox/usb.dox b/os/hal/dox/usb.dox
index e9c6687ce..e0916f26a 100644
--- a/os/hal/dox/usb.dox
+++ b/os/hal/dox/usb.dox
@@ -31,7 +31,64 @@
  * shown in the following diagram has to be considered an error and shall

  * be captured by an assertion (if enabled).

  * @if LATEX_PDF

+ * @dot

+  digraph example {

+    size="5, 7";

+    rankdir="LR";

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

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

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

+

+    stop  [label="USB_STOP\nLow Power"];

+    uninit [label="USB_UNINIT", style="bold"];

+    ready [label="USB_READY\nClock Enabled"];

+    selected [label="\nUSB_SELECTED\naddress\nassigned"];

+    configured [label="\nUSB_ACTIVE\nconfiguration\nselected"];

+

+    uninit -> stop [label=" usbInit()", constraint=false];

+    stop -> stop [label="\nusbStop()"];

+    stop -> ready [label="\nusbStart()"];

+    ready -> stop [label="\nusbStop()"];

+    ready -> ready [label="\n\nusbStart()"];

+    ready -> ready [label="\nSUSPEND/WAKEUP\n>event_cb<"];

+    ready -> selected [label="\nSET_ADDRESS\n>event_cb<"];

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

+    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 -> ready [label="\nUSB RESET\n>event_cb<"];

+  }

+ * @enddot

  * @else

+ * @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];

+

+    stop  [label="USB_STOP\nLow Power"];

+    uninit [label="USB_UNINIT", style="bold"];

+    ready [label="USB_READY\nClock Enabled"];

+    selected [label="\nUSB_SELECTED\naddress\nassigned"];

+    configured [label="\nUSB_ACTIVE\nconfiguration\nselected"];

+

+    uninit -> stop [label=" usbInit()", constraint=false];

+    stop -> stop [label="\nusbStop()"];

+    stop -> ready [label="\nusbStart()"];

+    ready -> stop [label="\nusbStop()"];

+    ready -> ready [label="\n\nusbStart()"];

+    ready -> ready [label="\nSUSPEND/WAKEUP\n>event_cb<"];

+    ready -> selected [label="\nSET_ADDRESS\n>event_cb<"];

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

+    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 -> ready [label="\nUSB RESET\n>event_cb<"];

+  }

+ * @enddot

  * @endif

  *

  * @section usb_2 USB Operations