You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
212 lines
7.4 KiB
212 lines
7.4 KiB
/*
|
|
ChibiOS - Copyright (C) 2006..2015 Giovanni Di Sirio
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
/*
|
|
Concepts and parts of this file have been contributed by Uladzimir Pylinsky
|
|
aka barthess.
|
|
*/
|
|
|
|
/**
|
|
* @file i2c.h
|
|
* @brief I2C Driver macros and structures.
|
|
*
|
|
* @addtogroup I2C
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _I2C_H_
|
|
#define _I2C_H_
|
|
|
|
#if (HAL_USE_I2C == TRUE) || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name I2C bus error conditions
|
|
* @{
|
|
*/
|
|
#define I2C_NO_ERROR 0x00 /**< @brief No error. */
|
|
#define I2C_BUS_ERROR 0x01 /**< @brief Bus Error. */
|
|
#define I2C_ARBITRATION_LOST 0x02 /**< @brief Arbitration Lost. */
|
|
#define I2C_ACK_FAILURE 0x04 /**< @brief Acknowledge Failure. */
|
|
#define I2C_OVERRUN 0x08 /**< @brief Overrun/Underrun. */
|
|
#define I2C_PEC_ERROR 0x10 /**< @brief PEC Error in
|
|
reception. */
|
|
#define I2C_TIMEOUT 0x20 /**< @brief Hardware timeout. */
|
|
#define I2C_SMB_ALERT 0x40 /**< @brief SMBus Alert. */
|
|
#define I2C_UNKNOWN_ERROR 0x80 /**< @brief internal error (base value - current mode value added) */
|
|
|
|
#define I2C_STOPPED ((i2cflags_t)(-1))
|
|
/**< @brief stop condition or i2cStop() called */
|
|
/** @} */
|
|
|
|
/**
|
|
* @name I2C function return codes
|
|
* @{
|
|
*/
|
|
#define I2C_OK (MSG_OK)
|
|
#define I2C_ERR_TIMEOUT (MSG_TIMEOUT)
|
|
#define I2C_ERROR (MSG_RESET)
|
|
/** @} */
|
|
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Enables the mutual exclusion APIs on the I2C bus.
|
|
*/
|
|
#if !defined(I2C_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
|
|
#define I2C_USE_MUTUAL_EXCLUSION TRUE
|
|
#endif
|
|
|
|
/**
|
|
* @brief Enables 'lock' capability needed in I2C slave mode
|
|
*/
|
|
#if !defined(HAL_USE_I2C_LOCK) || defined(__DOXYGEN__)
|
|
#define HAL_USE_I2C_LOCK FALSE
|
|
#endif
|
|
|
|
/**
|
|
* @brief Determines whether master mode required to be supported
|
|
*/
|
|
#if !defined(HAL_USE_I2C_MASTER) || defined(__DOXYGEN__)
|
|
#define HAL_USE_I2C_MASTER TRUE
|
|
#endif
|
|
|
|
/**
|
|
* @brief Determines whether slave mode required to be supported
|
|
*/
|
|
#if !defined(HAL_USE_I2C_SLAVE) || defined(__DOXYGEN__)
|
|
#define HAL_USE_I2C_SLAVE FALSE
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
#if I2C_USE_MUTUAL_EXCLUSION && !CH_CFG_USE_MUTEXES && !CH_CFG_USE_SEMAPHORES
|
|
#error "I2C_USE_MUTUAL_EXCLUSION requires CH_CFG_USE_MUTEXES and/or CH_CFG_USE_SEMAPHORES"
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Driver state machine possible states.
|
|
*/
|
|
typedef enum {
|
|
I2C_UNINIT = 0, /**< Not initialized. */
|
|
I2C_STOP = 1, /**< Stopped. */
|
|
I2C_READY = 2, /**< Ready. */
|
|
I2C_ACTIVE_TX = 3, /**< Transmitting. */
|
|
I2C_ACTIVE_RX = 4, /**< Receiving. */
|
|
I2C_LOCKED = 5 /**> Bus or driver locked. */
|
|
} i2cstate_t;
|
|
|
|
#include "hal_i2c_lld.h"
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Wakes up the waiting thread notifying no errors.
|
|
*
|
|
* @param[in] i2cp pointer to the @p I2CDriver object
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define _i2c_wakeup_isr(i2cp) do { \
|
|
osalSysLockFromISR(); \
|
|
osalThreadResumeI(&(i2cp)->thread, MSG_OK); \
|
|
osalSysUnlockFromISR(); \
|
|
} while(0)
|
|
|
|
/**
|
|
* @brief Wakes up the waiting thread notifying errors.
|
|
*
|
|
* @param[in] i2cp pointer to the @p I2CDriver object
|
|
*
|
|
* @notapi
|
|
*/
|
|
#define _i2c_wakeup_error_isr(i2cp) do { \
|
|
osalSysLockFromISR(); \
|
|
osalThreadResumeI(&(i2cp)->thread, MSG_RESET); \
|
|
osalSysUnlockFromISR(); \
|
|
} while(0)
|
|
|
|
/**
|
|
* @brief Wrap i2cMasterTransmitTimeout function with TIME_INFINITE timeout.
|
|
* @api
|
|
*/
|
|
#define i2cMasterTransmit(i2cp, addr, txbuf, txbytes, rxbuf, rxbytes) \
|
|
(i2cMasterTransmitTimeout(i2cp, addr, txbuf, txbytes, rxbuf, rxbytes, \
|
|
TIME_INFINITE))
|
|
|
|
/**
|
|
* @brief Wrap i2cMasterReceiveTimeout function with TIME_INFINITE timeout.
|
|
* @api
|
|
*/
|
|
#define i2cMasterReceive(i2cp, addr, rxbuf, rxbytes) \
|
|
(i2cMasterReceiveTimeout(i2cp, addr, rxbuf, rxbytes, TIME_INFINITE))
|
|
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void i2cInit(void);
|
|
void i2cObjectInit(I2CDriver *i2cp);
|
|
void i2cStart(I2CDriver *i2cp, const I2CConfig *config);
|
|
void i2cStop(I2CDriver *i2cp);
|
|
i2cflags_t i2cGetErrors(I2CDriver *i2cp);
|
|
msg_t i2cMasterTransmitTimeout(I2CDriver *i2cp,
|
|
i2caddr_t addr,
|
|
const uint8_t *txbuf, size_t txbytes,
|
|
uint8_t *rxbuf, size_t rxbytes,
|
|
systime_t timeout);
|
|
msg_t i2cMasterReceiveTimeout(I2CDriver *i2cp,
|
|
i2caddr_t addr,
|
|
uint8_t *rxbuf, size_t rxbytes,
|
|
systime_t timeout);
|
|
|
|
#if HAL_USE_I2C_LOCK /* I2C slave mode support */
|
|
void i2cLock(I2CDriver *i2cp, systime_t lockDuration);
|
|
void i2cUnlock(I2CDriver *i2cp);
|
|
#endif
|
|
|
|
#if I2C_USE_MUTUAL_EXCLUSION == TRUE
|
|
void i2cAcquireBus(I2CDriver *i2cp);
|
|
void i2cReleaseBus(I2CDriver *i2cp);
|
|
#endif /* I2C_USE_MUTUAL_EXCLUSION */
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_I2C == TRUE */
|
|
|
|
#endif /* _I2C_H_ */
|
|
|
|
/** @} */
|