summaryrefslogtreecommitdiffstats
path: root/bsp-howto
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2016-12-20 11:18:06 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2016-12-21 11:34:13 +0100
commit7351405fe6841705d8fab2abbd080552e5290ff8 (patch)
tree4b669cbf78a6c0ee4e7baf013368a920033f6d11 /bsp-howto
parentDocument SPI framework (diff)
downloadrtems-docs-7351405fe6841705d8fab2abbd080552e5290ff8.tar.bz2
Document I2C framework
Update #2845.
Diffstat (limited to 'bsp-howto')
-rw-r--r--bsp-howto/i2c.rst19
-rw-r--r--bsp-howto/index.rst1
2 files changed, 20 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>`_.
diff --git a/bsp-howto/index.rst b/bsp-howto/index.rst
index f1c3a4e..649e335 100644
--- a/bsp-howto/index.rst
+++ b/bsp-howto/index.rst
@@ -47,6 +47,7 @@ to the Community Project hosted at http://www.rtems.org.
initilization_code
console
clock
+ i2c
spi
timer
real_time_clock