aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/dox/i2c.dox
diff options
context:
space:
mode:
Diffstat (limited to 'os/hal/dox/i2c.dox')
-rw-r--r--os/hal/dox/i2c.dox26
1 files changed, 21 insertions, 5 deletions
diff --git a/os/hal/dox/i2c.dox b/os/hal/dox/i2c.dox
index 1ffd2da47..cd5e3f698 100644
--- a/os/hal/dox/i2c.dox
+++ b/os/hal/dox/i2c.dox
@@ -31,12 +31,28 @@
* 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
- * @else
- * @endif
- *
+ * @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];
+
+ uninit [label="I2C_UNINIT", style="bold"];
+ stop [label="I2C_STOP\nLow Power"];
+ ready [label="I2C_READY\nClock Enabled"];
+ active [label="I2C_ACTIVE\nBus Active"];
+
+ uninit -> stop [label="i2cInit()"];
+ stop -> stop [label="i2cStop()"];
+ stop -> ready [label="i2cStart()"];
+ ready -> active [label="i2cMasterTransmit()\ni2cMasterReceive()"];
+ active -> ready [label="_i2c_isr_code()"];
+ ready -> stop [label="i2cStop()"];
+ }
+ * @enddot
* 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