diff options
| author | barthess <barthess@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-07-12 18:26:39 +0000 |
|---|---|---|
| committer | barthess <barthess@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2011-07-12 18:26:39 +0000 |
| commit | 621d794bf0d2a6456221f1e478de66e48c293063 (patch) | |
| tree | 5e1d92a9110b4b84218529b5a0d688ff8c468db7 /os/hal/dox | |
| parent | 44960790c58f9055068dbc427384ae8d20048334 (diff) | |
| download | ChibiOS-621d794bf0d2a6456221f1e478de66e48c293063.tar.gz ChibiOS-621d794bf0d2a6456221f1e478de66e48c293063.tar.bz2 ChibiOS-621d794bf0d2a6456221f1e478de66e48c293063.zip | |
I2C. Documentation improvements. Dead code clenups.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/branches/i2c_dev@3153 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/dox')
| -rw-r--r-- | os/hal/dox/i2c.dox | 26 |
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
|