diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2016-12-20 11:18:06 +0100 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2016-12-21 11:34:13 +0100 |
commit | 7351405fe6841705d8fab2abbd080552e5290ff8 (patch) | |
tree | 4b669cbf78a6c0ee4e7baf013368a920033f6d11 /bsp-howto/i2c.rst | |
parent | Document SPI framework (diff) | |
download | rtems-docs-7351405fe6841705d8fab2abbd080552e5290ff8.tar.bz2 |
Document I2C framework
Update #2845.
Diffstat (limited to 'bsp-howto/i2c.rst')
-rw-r--r-- | bsp-howto/i2c.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/bsp-howto/i2c.rst b/bsp-howto/i2c.rst new file mode 100644 index 0000000..caa78e1 --- /dev/null +++ b/bsp-howto/i2c.rst @@ -0,0 +1,19 @@ +.. comment SPDX-License-Identifier: CC-BY-SA-4.0 + +.. COMMENT: Copyright (c) 2016 embedded brains GmbH <rtems@embedded-brains.de> +.. COMMENT: All rights reserved. + +I2C Driver +********** + +The Inter-Integrated Circuit (I2C, I²C, IIC) bus drivers should use the +`I2C bus framework <https://git.rtems.org/rtems/tree/cpukit/dev/include/dev/i2c/i2c.h>`_. +For example drivers see the +`Cadence I2C driver <https://git.rtems.org/rtems/tree/c/src/lib/libbsp/arm/xilinx-zynq/i2c/cadence-i2c.c>`_, +the +`Atmel SAM I2C driver <https://git.rtems.org/rtems/tree/c/src/lib/libbsp/arm/atsam/i2c/atsam_i2c_bus.c>`_ +and the +`I2C framework test <https://git.rtems.org/rtems/tree/testsuites/libtests/i2c01/init.c>`_. + +The user API is compatible to the +`Linux I2C user-space API <https://www.kernel.org/doc/Documentation/i2c/dev-interface>`_. |