Document I2C framework

Update #2845.
This commit is contained in:
Sebastian Huber 2016-12-20 11:18:06 +01:00
parent 0cb2748a11
commit 7351405fe6
2 changed files with 20 additions and 0 deletions

19
bsp-howto/i2c.rst Normal file
View File

@ -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>`_.

View File

@ -47,6 +47,7 @@ to the Community Project hosted at http://www.rtems.org.
initilization_code initilization_code
console console
clock clock
i2c
spi spi
timer timer
real_time_clock real_time_clock