From d4c246e1bf9af0096b69ded8ae65bbf754267754 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Fri, 22 Feb 2013 11:34:04 +0000 Subject: Documentation related fixes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@5298 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/hal/dox/sdc.dox | 78 +++--------------------------------------------------- 1 file changed, 3 insertions(+), 75 deletions(-) (limited to 'os/hal/dox/sdc.dox') diff --git a/os/hal/dox/sdc.dox b/os/hal/dox/sdc.dox index 58dc22310..073629457 100644 --- a/os/hal/dox/sdc.dox +++ b/os/hal/dox/sdc.dox @@ -26,82 +26,10 @@ * must be enabled in @p halconf.h. * * @section sdc_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). - * @if LATEX_PDF - * @dot - digraph example { - size="5, 7"; - rankdir="LR"; - - node [shape=circle, fontname=Sans, fontsize=8, fixedsize="true", width="0.9", height="0.9"]; - edge [fontname=Sans, fontsize=8]; - - stop [label="SDC_STOP\nLow Power"]; - uninit [label="SDC_UNINIT", style="bold"]; - ready [label="SDC_READY\nClock Enabled"]; - connecting [label="SDC_CONN.ING\nConnecting"]; - disconnecting [label="SDC_DISC.ING\nDisconnecting"]; - active [label="SDC_ACTIVE\nCard Ready"]; - reading [label="SDC_READING\nReading"]; - writing [label="SDC_WRITING\nWriting"]; - - uninit -> stop [label=" sdcInit()", constraint=false]; - stop -> stop [label="\nsdcStop()"]; - stop -> ready [label="\nsdcStart()"]; - ready -> stop [label="\nsdcStop()"]; - ready -> ready [label="\nsdcStart()\nsdcDisconnect()"]; - ready -> connecting [label="\nsdcConnect()"]; - connecting -> active [label="\nconnection\nsuccessful"]; - connecting -> active [label="\nsdcConnect()", dir="back"]; - connecting -> ready [label="\nconnection\nfailed"]; - disconnecting -> active [label="\nsdcDisconnect()", dir="back"]; - ready -> disconnecting [label="\ndisconnection\nfinished", dir="back"]; - active -> reading [label="\nsdcRead()"]; - reading -> active [label="\nread finished\nread error"]; - active -> writing [label="\nsdcWrite()"]; - writing -> active [label="\nwrite finished\nwrite error"]; - } - * @enddot - * @else - * @dot - digraph example { - rankdir="LR"; - - node [shape=circle, fontname=Sans, fontsize=8, fixedsize="true", width="0.9", height="0.9"]; - edge [fontname=Sans, fontsize=8]; - - stop [label="SDC_STOP\nLow Power"]; - uninit [label="SDC_UNINIT", style="bold"]; - ready [label="SDC_READY\nClock Enabled"]; - connecting [label="SDC_CONN.ING\nConnecting"]; - disconnecting [label="SDC_DISC.ING\nDisconnecting"]; - active [label="SDC_ACTIVE\nCard Ready"]; - reading [label="SDC_READING\nReading"]; - writing [label="SDC_WRITING\nWriting"]; - - uninit -> stop [label=" sdcInit()", constraint=false]; - stop -> stop [label="\nsdcStop()"]; - stop -> ready [label="\nsdcStart()"]; - ready -> stop [label="\nsdcStop()"]; - ready -> ready [label="\nsdcStart()\nsdcDisconnect()"]; - ready -> connecting [label="\nsdcConnect()"]; - connecting -> active [label="\nconnection\nsuccessful"]; - connecting -> active [label="\nsdcConnect()", dir="back"]; - connecting -> ready [label="\nconnection\nfailed"]; - disconnecting -> active [label="\nsdcDisconnect()", dir="back"]; - ready -> disconnecting [label="\ndisconnection\nfinished", dir="back"]; - active -> reading [label="\nsdcRead()"]; - reading -> active [label="\nread finished\nread error"]; - active -> writing [label="\nsdcWrite()"]; - writing -> active [label="\nwrite finished\nwrite error"]; - } - * @enddot - * @endif + * This driver implements a state machine internally, see the @ref IO_BLOCK + * module documentation for details. * - * @section sdc_2 SDC Operations. + * @section sdc_2 Driver Operations * This driver allows to read or write single or multiple 512 bytes blocks * on a SD Card. * -- cgit v1.2.3