diff options
Diffstat (limited to 'os/io/io.dox')
-rw-r--r-- | os/io/io.dox | 42 |
1 files changed, 41 insertions, 1 deletions
diff --git a/os/io/io.dox b/os/io/io.dox index f53bb3271..1f68a29c0 100644 --- a/os/io/io.dox +++ b/os/io/io.dox @@ -148,7 +148,7 @@ edge [fontname=Helvetica, fontsize=8];
uninit [label="SPI_UNINIT", style="bold"];
stop [label="SPI_STOP\nLow Power"];
- ready [label="SPI_IDLE\nClock Enabled"];
+ ready [label="SPI_READY\nClock Enabled"];
active [label="SPI_ACTIVE\nBus Active"];
uninit -> stop [label="spiInit()"];
stop -> ready [label="spiStart()"];
@@ -177,6 +177,46 @@ */
/**
+ * @defgroup ADC ADC Driver
+ * @brief Generic ADC Driver.
+ * @details This module implements a generic ADC driver. The driver implements
+ * a state machine internally:
+ * @dot
+ digraph example {
+ rankdir="LR";
+ node [shape=circle, fontname=Helvetica, fontsize=8, fixedsize="true", width="0.75", height="0.75"];
+ edge [fontname=Helvetica, fontsize=8];
+ uninit [label="ADC_UNINIT", style="bold"];
+ stop [label="ADC_STOP\nLow Power"];
+ ready [label="ADC_READY\nClock Enabled"];
+ running [label="ADC_RUNNING\nConverting"];
+ uninit -> stop [label="adcInit()"];
+ stop -> ready [label="adcStart()"];
+ ready -> ready [label="adcStart()"];
+ ready -> stop [label="adcStop()"];
+ stop -> stop [label="adcStop()"];
+ ready -> running [label="adcStartConversion()"];
+ running -> ready [label="adcStopConversion()"];
+ running -> ready [label="End of Conversion"];
+ }
+ * @enddot
+ *
+ * The driver supports a continuous conversion mode with circular buffer,
+ * callback functions allow to process the converted data in real time.
+ * Please refer to the documentation of the function @p adcStartConversion().
+ *
+ * @ingroup IO
+ */
+
+/**
+ * @defgroup ADC_LLD ADC Low Level Driver
+ * @brief @ref ADC low level driver template.
+ * @details This file is a template for a ADC low level driver.
+ *
+ * @ingroup ADC
+ */
+
+/**
* @defgroup MAC MAC Driver
* @brief Generic MAC driver.
* @details This module implements a generic interface for MAC (Media
|