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

1 files changed, 121 insertions, 0 deletions

diff --git a/os/hal/dox/mmc_spi.dox b/os/hal/dox/mmc_spi.dox
new file mode 100644
index 000000000..65e66391e
--- /dev/null
+++ b/os/hal/dox/mmc_spi.dox
@@ -0,0 +1,121 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 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 MMC_SPI MMC over SPI Driver

+ * @brief Generic MMC driver.

+ * @details This module implements a portable MMC driver that uses a SPI

+ *          driver as physical layer.

+ * @pre     In order to use the ADC driver the @p CH_HAL_USE_MMC_SPI option

+ *          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

+ *

+ * The MMC drivers currently supports only cards with capacity up to 2GB

+ * and does not implement CRC checking. Hot plugging and removal are supported

+ * through kernel events.

+ *

+ * @ingroup IO

+ */