mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
Merge pull request #3929 from haukepetersen/opt_periph_i2c
drivers/i2c: optimized I2C periph driver interface
This commit is contained in:
Peter Kietzmann
commit
d18063cbe1
@ -151,6 +151,25 @@ enum {
|
||||
GPIO_NUMOF
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Legacy definitions of I2C devices
|
||||
*/
|
||||
enum {
|
||||
#if I2C_0_EN
|
||||
I2C_0, /**< I2C device 0 */
|
||||
#endif
|
||||
#if I2C_1_EN
|
||||
I2C_1, /**< I2C device 1 */
|
||||
#endif
|
||||
#if I2C_2_EN
|
||||
I2C_2, /**< I2C device 2 */
|
||||
#endif
|
||||
#if I2C_3_EN
|
||||
I2C_3, /**< I2C device 3 */
|
||||
#endif
|
||||
I2C_UNDEFINED /**< Deprecated symbol, use I2C_UNDEF instead */
|
||||
};
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
/*
|
||||
* Copyright (C) 2014 Freie Universität Berlin
|
||||
* Copyright (C) 2014-2015 Freie Universität Berlin
|
||||
*
|
||||
* This file is subject to the terms and conditions of the GNU Lesser General
|
||||
* Public License v2.1. See the file LICENSE in the top level directory for more
|
||||
* details.
|
||||
* This file is subject to the terms and conditions of the GNU Lesser
|
||||
* General Public License v2.1. See the file LICENSE in the top level
|
||||
* directory for more details.
|
||||
*/
|
||||
|
||||
/**
|
||||
@ -19,9 +19,10 @@
|
||||
* 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
|
||||
* 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 connecting
|
||||
* a logic analyzer which will raise the capacitance of the bus. In this case you
|
||||
* should make sure you connect external pull-up resistors to both I2C bus lines.
|
||||
* I2C bus will show faulty behavior. This can for example happen when
|
||||
* connecting a logic analyzer which will raise the capacitance of the bus. In
|
||||
* this case you should make sure you connect external pull-up resistors to both
|
||||
* I2C bus lines.
|
||||
*
|
||||
* The minimum and maximum resistances are computed by:
|
||||
* \f{eqnarray*}{
|
||||
@ -34,7 +35,8 @@
|
||||
* \f$ I_{OL} =\f$ Low level output current,
|
||||
* \f$ t_r =\f$ Signal rise time,
|
||||
* \f$ C_b =\f$ Bus capacitance <br>
|
||||
* <br>The pull-up resistors depend on the bus speed. Some typical values are:<br>
|
||||
* <br>The pull-up resistors depend on the bus speed.
|
||||
* Some typical values are:<br>
|
||||
* Normal mode: 10kΩ<br>
|
||||
* Fast mode: 2kΩ<br>
|
||||
* Fast plus mode: 2kΩ
|
||||
@ -54,41 +56,59 @@
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
#include "periph_conf.h"
|
||||
#include "periph_cpu.h"
|
||||
/**
|
||||
* @todo Remove dev_enums.h include once all platforms are ported to the
|
||||
* updated periph interface
|
||||
*/
|
||||
#include "periph/dev_enums.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/* guard this file in case no I2C device is defined */
|
||||
#if I2C_NUMOF
|
||||
|
||||
/** @brief Flag to use for reading from the I2C bus */
|
||||
/**
|
||||
* @brief Flag signaling a write operation on the bus
|
||||
*/
|
||||
#define I2C_FLAG_WRITE 0
|
||||
/** @brief Flag to use for writing to the I2C bus */
|
||||
|
||||
/**
|
||||
* @brief Flag signaling a read operation on the bus
|
||||
*/
|
||||
#define I2C_FLAG_READ 1
|
||||
|
||||
/**
|
||||
* @brief define I2C device identifiers
|
||||
* @brief Default I2C device access macro
|
||||
* @{
|
||||
*/
|
||||
typedef enum {
|
||||
#if I2C_0_EN
|
||||
I2C_0 = 0, /**< I2C device 0 */
|
||||
#ifndef I2C_DEV
|
||||
#define I2C_DEV(x) (x)
|
||||
#endif
|
||||
#if I2C_1_EN
|
||||
I2C_1, /**< I2C device 1 */
|
||||
#endif
|
||||
#if I2C_2_EN
|
||||
I2C_2, /**< I2C device 2 */
|
||||
#endif
|
||||
#if I2C_3_EN
|
||||
I2C_3, /**< I2C device 3 */
|
||||
#endif
|
||||
} i2c_t;
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @brief define I2C bus speed values
|
||||
* @brief Default I2C undefined value
|
||||
* @{
|
||||
*/
|
||||
#ifndef I2C_UNDEF
|
||||
#define I2C_UNDEF (-1)
|
||||
#endif
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @brief Default i2c_t type definition
|
||||
* @{
|
||||
*/
|
||||
#ifndef HAVE_I2C_T
|
||||
typedef unsigned int i2c_t;
|
||||
#endif
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @brief Default mapping of I2C bus speed values
|
||||
* @{
|
||||
*/
|
||||
#ifndef HAVE_I2C_SPEED_T
|
||||
typedef enum {
|
||||
I2C_SPEED_LOW = 0, /**< low speed mode: ~10kbit/s */
|
||||
I2C_SPEED_NORMAL, /**< normal mode: ~100kbit/s */
|
||||
@ -96,6 +116,8 @@ typedef enum {
|
||||
I2C_SPEED_FAST_PLUS, /**< fast plus mode: ~1Mbit/s */
|
||||
I2C_SPEED_HIGH, /**< high speed mode: ~3.4Mbit/s */
|
||||
} i2c_speed_t;
|
||||
#endif
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @brief Initialize an I2C device to run as bus master
|
||||
@ -123,7 +145,8 @@ int i2c_init_slave(i2c_t dev, uint8_t address);
|
||||
/**
|
||||
* @brief Get mutually exclusive access to the given I2C bus
|
||||
*
|
||||
* In case the I2C device is busy, this function will block until the bus is free again.
|
||||
* In case the I2C device is busy, this function will block until the bus is
|
||||
* free again.
|
||||
*
|
||||
* @param[in] dev I2C device to access
|
||||
*
|
||||
@ -169,7 +192,8 @@ int i2c_read_byte(i2c_t dev, uint8_t address, char *data);
|
||||
int i2c_read_bytes(i2c_t dev, uint8_t address, char *data, int length);
|
||||
|
||||
/**
|
||||
* @brief Read one byte from a register at the I2C slave with the given address
|
||||
* @brief Read one byte from a register at the I2C slave with the given
|
||||
* address
|
||||
*
|
||||
* @param[in] dev I2C peripheral device
|
||||
* @param[in] address bus address of the target device
|
||||
@ -182,7 +206,8 @@ int i2c_read_bytes(i2c_t dev, uint8_t address, char *data, int length);
|
||||
int i2c_read_reg(i2c_t dev, uint8_t address, uint8_t reg, char *data);
|
||||
|
||||
/**
|
||||
* @brief Read multiple bytes from a register at the I2C slave with the given address
|
||||
* @brief Read multiple bytes from a register at the I2C slave with the given
|
||||
* address
|
||||
*
|
||||
* @param[in] dev I2C peripheral device
|
||||
* @param[in] address bus address of the target device
|
||||
@ -193,7 +218,8 @@ int i2c_read_reg(i2c_t dev, uint8_t address, uint8_t reg, char *data);
|
||||
* @return the number of bytes that were read
|
||||
* @return -1 on undefined device given
|
||||
*/
|
||||
int i2c_read_regs(i2c_t dev, uint8_t address, uint8_t reg, char *data, int length);
|
||||
int i2c_read_regs(i2c_t dev, uint8_t address, uint8_t reg,
|
||||
char *data, int length);
|
||||
|
||||
/**
|
||||
* @brief Write one byte to an I2C device with the given address
|
||||
@ -234,7 +260,8 @@ int i2c_write_bytes(i2c_t dev, uint8_t address, char *data, int length);
|
||||
int i2c_write_reg(i2c_t dev, uint8_t address, uint8_t reg, char data);
|
||||
|
||||
/**
|
||||
* @brief Write multiple bytes to a register at the I2C slave with the given address
|
||||
* @brief Write multiple bytes to a register at the I2C slave with the given
|
||||
* address
|
||||
*
|
||||
* @param[in] dev I2C peripheral device
|
||||
* @param[in] address bus address of the target device
|
||||
@ -245,7 +272,8 @@ int i2c_write_reg(i2c_t dev, uint8_t address, uint8_t reg, char data);
|
||||
* @return the number of bytes that were written
|
||||
* @return -1 on undefined device given
|
||||
*/
|
||||
int i2c_write_regs(i2c_t dev, uint8_t address, uint8_t reg, char *data, int length);
|
||||
int i2c_write_regs(i2c_t dev, uint8_t address, uint8_t reg,
|
||||
char *data, int length);
|
||||
|
||||
/**
|
||||
* @brief Power on the given I2C peripheral
|
||||
@ -261,8 +289,6 @@ void i2c_poweron(i2c_t dev);
|
||||
*/
|
||||
void i2c_poweroff(i2c_t dev);
|
||||
|
||||
#endif /* I2C_NUMOF */
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
Loading…
Reference in New Issue
Block a user