From 613fe7d0d19f63f87c649f6a4f0443b3cdbcecfd Mon Sep 17 00:00:00 2001 From: gdisirio Date: Mon, 25 Oct 2010 08:22:39 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2288 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/hal/hal.dox | 112 +++------------------------------------------------------ 1 file changed, 4 insertions(+), 108 deletions(-) diff --git a/os/hal/hal.dox b/os/hal/hal.dox index 308477567..4e4811b34 100644 --- a/os/hal/hal.dox +++ b/os/hal/hal.dox @@ -204,7 +204,7 @@ * @endif * * The driver is not thread safe for performance reasons, if you need to access - * the I2C bus from multiple thread then use the @p i2cAcquireBus() and + * the I2C bus from multiple threads then use the @p i2cAcquireBus() and * @p i2cReleaseBus() APIs in order to gain exclusive access. * * @ingroup IO @@ -285,7 +285,7 @@ * @endif * * The driver is not thread safe for performance reasons, if you need to access - * the SPI bus from multiple thread then use the @p spiAcquireBus() and + * the SPI bus from multiple threads then use the @p spiAcquireBus() and * @p spiReleaseBus() APIs in order to gain exclusive access. * * @ingroup IO @@ -426,8 +426,8 @@ /** * @defgroup CAN CAN Driver * @brief Generic CAN Driver. - * @details This module implements a generic ADC driver. - * @pre In order to use the ADC driver the @p CH_HAL_USE_CAN option + * @details This module implements a generic CAN driver. + * @pre In order to use the CAN driver the @p CH_HAL_USE_CAN option * must be enabled in @p halconf.h. * * @section can_1 Driver State Machine @@ -583,110 +583,6 @@ * * @ingroup MAC */ - -/** - * @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 - */ - /** * @defgroup UART UART Driver -- cgit v1.2.3