156 lines
4.0 KiB
C
156 lines
4.0 KiB
C
/**
|
|
* @file i2cdev.h
|
|
*
|
|
* ESP-IDF I2C master thread-safe functions for communication with I2C slave
|
|
*
|
|
* Copyright (C) 2018 Ruslan V. Uss (https://github.com/UncleRus)
|
|
* MIT Licensed as described in the file LICENSE
|
|
*/
|
|
#ifndef __I2CDEV_H__
|
|
#define __I2CDEV_H__
|
|
|
|
#include <driver/i2c.h>
|
|
#include <freertos/FreeRTOS.h>
|
|
#include <freertos/semphr.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* I2C device descriptor
|
|
*/
|
|
typedef struct
|
|
{
|
|
i2c_port_t port;
|
|
i2c_config_t cfg;
|
|
uint8_t addr; //!< Unshifted address
|
|
SemaphoreHandle_t mutex;
|
|
} i2c_dev_t;
|
|
|
|
/**
|
|
* @brief Init I2Cdev lib
|
|
* The function must be called before any other
|
|
* functions of this library
|
|
* @return ESP_OK on success
|
|
*/
|
|
esp_err_t i2cdev_init();
|
|
|
|
/**
|
|
* @brief Finish work with I2CDev lib
|
|
* Uninstall i2c drivers
|
|
* @return ESP_OK on success
|
|
*/
|
|
esp_err_t i2cdev_done();
|
|
|
|
/**
|
|
* @brief Create mutex for device descriptor
|
|
* @param[out] dev Device descriptor
|
|
* @return ESP_OK on success
|
|
*/
|
|
esp_err_t i2c_dev_create_mutex(i2c_dev_t *dev);
|
|
|
|
/**
|
|
* @brief Delete mutex for device descriptor
|
|
* @param[out] dev Device descriptor
|
|
* @return ESP_OK on success
|
|
*/
|
|
esp_err_t i2c_dev_delete_mutex(i2c_dev_t *dev);
|
|
|
|
/**
|
|
* @brief Take device mutex
|
|
* @param[out] dev Device descriptor
|
|
* @return ESP_OK on success
|
|
*/
|
|
esp_err_t i2c_dev_take_mutex(i2c_dev_t *dev);
|
|
|
|
/**
|
|
* @brief Give device mutex
|
|
* @param[out] dev Device descriptor
|
|
* @return ESP_OK on success
|
|
*/
|
|
esp_err_t i2c_dev_give_mutex(i2c_dev_t *dev);
|
|
|
|
/**
|
|
* @brief Read from slave device
|
|
* Issue a send operation of \p out_data register adress, followed by reading \p in_size bytes
|
|
* from slave into \p in_data .
|
|
* Function is thread-safe.
|
|
* @param[in] dev Device descriptor
|
|
* @param[in] out_data Pointer to data to send if non-null
|
|
* @param[in] out_size Size of data to send
|
|
* @param[out] in_data Pointer to input data buffer
|
|
* @param[in] in_size Number of byte to read
|
|
* @return ESP_OK on success
|
|
*/
|
|
esp_err_t i2c_dev_read(const i2c_dev_t *dev, const void *out_data,
|
|
size_t out_size, void *in_data, size_t in_size);
|
|
|
|
/**
|
|
* @brief Write to slave device
|
|
* Write \p out_size bytes from \p out_data to slave into \p out_reg register address.
|
|
* Function is thread-safe.
|
|
* @param[in] dev Device descriptor
|
|
* @param[in] out_reg Pointer to register address to send if non-null
|
|
* @param[in] out_reg_size Size of register address
|
|
* @param[in] out_data Pointer to data to send
|
|
* @param[in] out_size Size of data to send
|
|
* @return ESP_OK on success
|
|
*/
|
|
esp_err_t i2c_dev_write(const i2c_dev_t *dev, const void *out_reg,
|
|
size_t out_reg_size, const void *out_data, size_t out_size);
|
|
|
|
/**
|
|
* @brief Read from register with an 8-bit address
|
|
* Shortcut to i2c_dev_read().
|
|
* @param[in] dev Device descriptor
|
|
* @param[in] reg Register address
|
|
* @param[out] in_data Pointer to input data buffer
|
|
* @param[in] in_size Number of byte to read
|
|
* @return ESP_OK on success
|
|
*/
|
|
inline esp_err_t i2c_dev_read_reg(const i2c_dev_t *dev, uint8_t reg,
|
|
void *in_data, size_t in_size)
|
|
{
|
|
return i2c_dev_read(dev, ®, 1, in_data, in_size);
|
|
}
|
|
|
|
/**
|
|
* @brief Write to register with an 8-bit address
|
|
* Shortcut to i2c_dev_write().
|
|
* @param[in] dev Device descriptor
|
|
* @param[in] reg Register address
|
|
* @param[in] out_data Pointer to data to send
|
|
* @param[in] out_size Size of data to send
|
|
* @return ESP_OK on success
|
|
*/
|
|
inline esp_err_t i2c_dev_write_reg(const i2c_dev_t *dev, uint8_t reg,
|
|
const void *out_data, size_t out_size)
|
|
{
|
|
return i2c_dev_write(dev, ®, 1, out_data, out_size);
|
|
}
|
|
|
|
#define I2C_DEV_TAKE_MUTEX(dev) do { \
|
|
esp_err_t __ = i2c_dev_take_mutex(dev); \
|
|
if (__ != ESP_OK) return __;\
|
|
} while (0)
|
|
|
|
#define I2C_DEV_GIVE_MUTEX(dev) do { \
|
|
esp_err_t __ = i2c_dev_give_mutex(dev); \
|
|
if (__ != ESP_OK) return __;\
|
|
} while (0)
|
|
|
|
#define I2C_DEV_CHECK(dev,X) do { \
|
|
esp_err_t ___ = X; \
|
|
if (___ != ESP_OK) { \
|
|
I2C_DEV_GIVE_MUTEX(dev); \
|
|
return ___; \
|
|
} \
|
|
} while (0)
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __I2CDEV_H__ */
|