diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2013-02-22 11:34:04 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2013-02-22 11:34:04 +0000 |
| commit | d4c246e1bf9af0096b69ded8ae65bbf754267754 (patch) | |
| tree | 234cff7b0a84068b3b6dedca795ba71faa9f1a7b /os/hal/dox/mmc_spi.dox | |
| parent | 4149bab2ca98e041d09d9908b04e634b84257f2c (diff) | |
| download | ChibiOS-d4c246e1bf9af0096b69ded8ae65bbf754267754.tar.gz ChibiOS-d4c246e1bf9af0096b69ded8ae65bbf754267754.tar.bz2 ChibiOS-d4c246e1bf9af0096b69ded8ae65bbf754267754.zip | |
Documentation related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@5298 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/dox/mmc_spi.dox')
| -rw-r--r-- | os/hal/dox/mmc_spi.dox | 92 |
1 files changed, 6 insertions, 86 deletions
diff --git a/os/hal/dox/mmc_spi.dox b/os/hal/dox/mmc_spi.dox index 4ff4fbff7..55dcaafd8 100644 --- a/os/hal/dox/mmc_spi.dox +++ b/os/hal/dox/mmc_spi.dox @@ -28,92 +28,12 @@ * @p HAL_USE_SPI options must be enabled in @p halconf.h.
*
* @section mmc_spi_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=Helvetica, fontsize=8, fixedsize="true", width="0.9", height="0.9"];
- edge [fontname=Helvetica, fontsize=8];
-
- any [label="Any State"];
- stop2 [label="MMC_STOP\nLow Power"];
- uninit [label="MMC_UNINIT", style="bold"];
- stop [label="MMC_STOP\nLow Power"];
- wait [label="MMC_WAIT\nWaiting Card"];
- inserted [label="MMC_INSERTED\nCard Inserted"];
- ready [label="MMC_READY\nCard Ready"];
- reading [label="MMC_READING\nReading"];
- writing [label="MMC_WRITING\nWriting"];
-
- uninit -> stop [label="mmcInit()"];
- stop -> wait [label="mmcStart()", constraint=false];
- wait -> inserted [label="insertion (inserted event)"];
- inserted -> inserted [label="mmcDisconnect()"];
- inserted -> ready [label="mmcConnect()"];
- ready -> ready [label="mmcConnect()"];
- ready -> inserted [label="mmcDisconnect()"];
- ready -> reading [label="mmcStartSequentialRead()"];
- reading -> reading [label="mmcSequentialRead()"];
- reading -> ready [label="mmcStopSequentialRead()"];
- reading -> ready [label="read error"];
- ready -> writing [label="mmcStartSequentialWrite()"];
- writing -> writing [label="mmcSequentialWrite()"];
- writing -> ready [label="mmcStopSequentialWrite()"];
- writing -> ready [label="write error"];
- inserted -> wait [label="removal (removed event)"];
- ready -> wait [label="removal (removed event)"];
- reading -> wait [label="removal (removed event)"];
- writing -> wait [label="removal (removed event)"];
-
- any -> stop2 [label="mmcStop()"];
- }
- * @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];
-
- any [label="Any State"];
- stop2 [label="MMC_STOP\nLow Power"];
- uninit [label="MMC_UNINIT", style="bold"];
- stop [label="MMC_STOP\nLow Power"];
- wait [label="MMC_WAIT\nWaiting Card"];
- inserted [label="MMC_INSERTED\nCard Inserted"];
- ready [label="MMC_READY\nCard Ready"];
- reading [label="MMC_READING\nReading"];
- writing [label="MMC_WRITING\nWriting"];
-
- uninit -> stop [label="mmcInit()"];
- stop -> wait [label="mmcStart()", constraint=false];
- wait -> inserted [label="insertion (inserted event)"];
- inserted -> inserted [label="mmcDisconnect()"];
- inserted -> ready [label="mmcConnect()"];
- ready -> ready [label="mmcConnect()"];
- ready -> inserted [label="mmcDisconnect()"];
- ready -> reading [label="mmcStartSequentialRead()"];
- reading -> reading [label="mmcSequentialRead()"];
- reading -> ready [label="mmcStopSequentialRead()"];
- reading -> ready [label="read error"];
- ready -> writing [label="mmcStartSequentialWrite()"];
- writing -> writing [label="mmcSequentialWrite()"];
- writing -> ready [label="mmcStopSequentialWrite()"];
- writing -> ready [label="write error"];
- inserted -> wait [label="removal (removed event)"];
- ready -> wait [label="removal (removed event)"];
- reading -> wait [label="removal (removed event)"];
- writing -> wait [label="removal (removed event)"];
-
- any -> stop2 [label="mmcStop()"];
- }
- * @enddot
- * @endif
+ * This driver implements a state machine internally, see the @ref IO_BLOCK
+ * module documentation for details.
+ *
+ * @section mmc_spi_2 Driver Operations
+ * This driver allows to read or write single or multiple 512 bytes blocks
+ * on a SD Card.
*
* @ingroup IO
*/
|