riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: reorganize and enhance docu on common I2C periph interface

Browse Source
This commit is contained in:
smlng 2017-06-06 13:40:06 +02:00
parent ccc098b36c
commit f5cd3a4496
1 changed files with 15 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
drivers/include/periph/i2c.h
View File

@ -11,12 +11,20 @@
* @ingroup drivers_periph * @ingroup drivers_periph
* @brief Low-level I2C peripheral driver * @brief Low-level I2C peripheral driver
* *
* @{ * This is a simple I2C interface to allow platform independent access to a
* @file * MCU's I2C bus and peripherals. This interface is intentionally designed as
* @brief Low-level I2C peripheral driver interface definition * simple as possible, to allow for easy implementation and maximal portability.
*
* @note The current version of this interface only supports the
* 7-bit addressing mode.
*
* @note This interface is due for remodeling, hence API changes are to
* be expected for upcoming releases.
*
* ## A note on pull-up resistors for SDA/SCL
* *
* The I2C signal lines SDA/SCL need external pull-up resistors which connect * The I2C signal lines SDA/SCL need external pull-up resistors which connect
* the lines to the positive voltage supply Vcc. The I2C driver implementation * the lines to the positive voltage supply VCC. The I2C driver implementation
* should enable the pin's internal pull-up resistors. There are however some * should enable the pin's internal pull-up resistors. There are however some
* use cases for which the internal pull resistors are not strong enough and the * use cases for which the internal pull resistors are not strong enough and the
* I2C bus will show faulty behavior. This can for example happen when * I2C bus will show faulty behavior. This can for example happen when
@ -44,8 +52,9 @@
* For more details refer to section 7.1 in:<br> * For more details refer to section 7.1 in:<br>
* http://www.nxp.com/documents/user_manual/UM10204.pdf * http://www.nxp.com/documents/user_manual/UM10204.pdf
* *
* @note The current version of this interface only supports the * @{
7-bit addressing mode. * @file
* @brief Low-level I2C peripheral driver interface definition
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
* @author Thomas Eichinger <thomas.eichinger@fu-berlin.de> * @author Thomas Eichinger <thomas.eichinger@fu-berlin.de>