aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/include/i2c.h
diff options
context:
space:
mode:
authorbarthess <barthess@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-12-08 20:17:13 +0000
committerbarthess <barthess@35acf78f-673a-0410-8e92-d51de3d6d3f4>2011-12-08 20:17:13 +0000
commit4ca9e4ad312453e11c17746aaa01b4fb637eb83a (patch)
treeb8ad2a8049314384e30f414b146ee4a875fbc953 /os/hal/include/i2c.h
parent8a3ce5e27333e4dc6bd8047c440b84f3060d7d0e (diff)
parent8196de6aef7616f7df96d757dddc9cfa9eb661dc (diff)
downloadChibiOS-4ca9e4ad312453e11c17746aaa01b4fb637eb83a.tar.gz
ChibiOS-4ca9e4ad312453e11c17746aaa01b4fb637eb83a.tar.bz2
ChibiOS-4ca9e4ad312453e11c17746aaa01b4fb637eb83a.zip
RTC for F4x branch.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/branches/rtc_dev@3585 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/hal/include/i2c.h')
-rw-r--r--os/hal/include/i2c.h163
1 files changed, 44 insertions, 119 deletions
diff --git a/os/hal/include/i2c.h b/os/hal/include/i2c.h
index acf09ec9c..31dcb53d5 100644
--- a/os/hal/include/i2c.h
+++ b/os/hal/include/i2c.h
@@ -34,24 +34,27 @@
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
+
/*===========================================================================*/
/* Driver constants. */
/*===========================================================================*/
-#define I2CD_NO_ERROR 0
-/** @brief Bus Error.*/
-#define I2CD_BUS_ERROR 0x01
-/** @brief Arbitration Lost (master mode).*/
-#define I2CD_ARBITRATION_LOST 0x02
-/** @brief Acknowledge Failure.*/
-#define I2CD_ACK_FAILURE 0x04
-/** @brief Overrun/Underrun.*/
-#define I2CD_OVERRUN 0x08
-/** @brief PEC Error in reception.*/
-#define I2CD_PEC_ERROR 0x10
-/** @brief Timeout or Tlow Error.*/
-#define I2CD_TIMEOUT 0x20
-/** @brief SMBus Alert.*/
-#define I2CD_SMB_ALERT 0x40
+
+/**
+ * @name I2C bus error conditions
+ * @{
+ */
+#define I2CD_NO_ERROR 0x00 /**< @brief No error. */
+#define I2CD_BUS_ERROR 0x01 /**< @brief Bus Error. */
+#define I2CD_ARBITRATION_LOST 0x02 /**< @brief Arbitration Lost
+ (master mode). */
+#define I2CD_ACK_FAILURE 0x04 /**< @brief Acknowledge Failure. */
+#define I2CD_OVERRUN 0x08 /**< @brief Overrun/Underrun. */
+#define I2CD_PEC_ERROR 0x10 /**< @brief PEC Error in
+ reception. */
+#define I2CD_TIMEOUT 0x20 /**< @brief Timeout Error. */
+#define I2CD_SMB_ALERT 0x40 /**< @brief SMBus Alert. */
+/** @} */
+
/*===========================================================================*/
/* Driver pre-compile time settings. */
/*===========================================================================*/
@@ -66,6 +69,7 @@
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
+
#if I2C_USE_MUTUAL_EXCLUSION && !CH_USE_MUTEXES && !CH_USE_SEMAPHORES
#error "I2C_USE_MUTUAL_EXCLUSION requires CH_USE_MUTEXES and/or CH_USE_SEMAPHORES"
#endif
@@ -78,84 +82,20 @@
* @brief Driver state machine possible states.
*/
typedef enum {
- /* master part */
- I2C_UNINIT = 0, /**< @brief Not initialized. */
- I2C_STOP = 1, /**< @brief Stopped. */
- I2C_READY = 2, /**< @brief Ready. */
- I2C_ACTIVE_TRANSMIT = 3, /**< @brief Transmit in progress. */
- I2C_ACTIVE_RECEIVE = 4, /**< @brief Receive in progress. */
- I2C_ACTIVE_TRANSCEIVE = 5, /**< @brief Receive after transmit in progress. */
-
- /* Slave part. Not realized. */
- I2C_SACTIVE = 10,
- I2C_STRANSMIT = 11,
- I2C_SRECEIVE = 12,
+ I2C_UNINIT = 0, /**< Not initialized. */
+ I2C_STOP = 1, /**< Stopped. */
+ I2C_READY = 2, /**< Ready. */
+ I2C_ACTIVE_TRANSMIT = 3, /**< Transmitting. */
+ I2C_ACTIVE_RECEIVE = 4, /**< Receiving. */
} i2cstate_t;
-
#include "i2c_lld.h"
-/**
- * @brief I2C notification callback type.
- * @details This callback invoked when byte transfer finish event occurs,
- * No matter sending or reading.
- *
- * @param[in] i2cp pointer to the @p I2CDriver object triggering the
- * callback
- * @param[in] i2cscfg pointer to the @p I2CSlaveConfig object triggering the
- * callback
- */
-typedef void (*i2ccallback_t)(I2CDriver *i2cp, const I2CSlaveConfig *i2cscfg);
-
-
-/**
- * @brief I2C error notification callback type.
- *
- * @param[in] i2cp pointer to the @p I2CDriver object triggering the
- * callback
- * @param[in] i2cscfg pointer to the @p I2CSlaveConfig object triggering the
- * callback
- */
-typedef void (*i2cerrorcallback_t)(I2CDriver *i2cp,
- const I2CSlaveConfig *i2cscfg);
-
-
-/**
- * @brief I2C transmission data block size.
- */
-typedef uint8_t i2cblock_t;
-
-
-/**
- * @brief Structure representing an I2C slave configuration.
- * @details Each slave device has its own config structure with input and
- * output buffers for temporally storing data.
- */
-struct I2CSlaveConfig{
- /**
- * @brief Callback pointer.
- * @note Transfer finished callback. Invoke when all data transferred.
- * If set to @p NULL then the callback is disabled.
- */
- i2ccallback_t id_callback;
-
- /**
- * @brief Callback pointer.
- * @note This callback will be invoked when error condition occur.
- * If set to @p NULL then the callback is disabled.
- */
- i2cerrorcallback_t id_err_callback;
-#if defined(I2C_SLAVECONFIG_EXT_FIELDS)
- I2C_SLAVECONFIG_EXT_FIELDS
-#endif
-};
-
/*===========================================================================*/
/* Driver macros. */
/*===========================================================================*/
-#if I2C_USE_WAIT || defined(__DOXYGEN__)
/**
* @brief Waits for operation completion.
* @details This function waits for the driver to complete the current
@@ -168,12 +108,12 @@ struct I2CSlaveConfig{
*
* @notapi
*/
-#define _i2c_wait_s(i2cp) { \
+#define _i2c_wait_s(i2cp, timeout, rdymsg) { \
chDbgAssert((i2cp)->id_thread == NULL, \
"_i2c_wait(), #1", "already waiting"); \
chSysLock(); \
(i2cp)->id_thread = chThdSelf(); \
- chSchGoSleepS(THD_STATE_SUSPENDED); \
+ rdymsg = chSchGoSleepTimeoutS(THD_STATE_SUSPENDED, timeout); \
chSysUnlock(); \
}
@@ -193,16 +133,11 @@ struct I2CSlaveConfig{
chSysUnlockFromIsr(); \
} \
}
-#else /* !I2C_USE_WAIT */
-#define _i2c_wait_s(i2cp)
-#define _i2c_wakeup_isr(i2cp)
-#endif /* !I2C_USE_WAIT */
/**
* @brief Common ISR code.
* @details This code handles the portable part of the ISR code:
- * - Callback invocation.
- * - Waiting thread wakeup, if any.
+ * - Waiting thread wakeup.
* - Driver state transitions.
*
* @note This macro is meant to be used in the low level drivers
@@ -212,21 +147,15 @@ struct I2CSlaveConfig{
*
* @notapi
*/
-#define _i2c_isr_code(i2cp, i2cscfg) { \
- if(((i2cp)->id_slave_config)->id_callback) { \
- ((i2cp)->id_slave_config)->id_callback(i2cp, i2cscfg); \
- (i2cp)->id_state = I2C_READY; \
- } \
- else \
- (i2cp)->id_state = I2C_READY; \
- _i2c_wakeup_isr(i2cp); \
+#define _i2c_isr_code(i2cp, i2cscfg) { \
+ (i2cp)->id_state = I2C_READY; \
+ _i2c_wakeup_isr(i2cp); \
}
/**
* @brief Error ISR code.
* @details This code handles the portable part of the ISR code:
- * - Error callback invocation.
- * - Waiting thread wakeup, if any.
+ * - Waiting thread wakeup.
* - Driver state transitions.
*
* @note This macro is meant to be used in the low level drivers
@@ -236,19 +165,15 @@ struct I2CSlaveConfig{
*
* @notapi
*/
-#define _i2c_isr_err_code(i2cp, i2cscfg) { \
- if(((i2cp)->id_slave_config)->id_err_callback) { \
- ((i2cp)->id_slave_config)->id_err_callback(i2cp, i2cscfg); \
- (i2cp)->id_state = I2C_READY; \
- } \
- else \
- (i2cp)->id_state = I2C_READY; \
- _i2c_wakeup_isr(i2cp); \
+#define _i2c_isr_err_code(i2cp, i2cscfg) { \
+ (i2cp)->id_state = I2C_READY; \
+ _i2c_wakeup_isr(i2cp); \
}
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
+
#ifdef __cplusplus
extern "C" {
#endif
@@ -256,15 +181,15 @@ extern "C" {
void i2cObjectInit(I2CDriver *i2cp);
void i2cStart(I2CDriver *i2cp, const I2CConfig *config);
void i2cStop(I2CDriver *i2cp);
- void i2cMasterTransmit(I2CDriver *i2cp, const I2CSlaveConfig *i2cscfg,
- uint16_t slave_addr,
- uint8_t *txbuf, size_t txbytes,
- uint8_t *rxbuf, size_t rxbytes);
- void i2cMasterReceive(I2CDriver *i2cp, const I2CSlaveConfig *i2cscfg,
- uint16_t slave_addr, uint8_t *rxbuf, size_t rxbytes);
- void i2cMasterStart(I2CDriver *i2cp);
- void i2cMasterStop(I2CDriver *i2cp);
- void i2cAddFlagsI(I2CDriver *i2cp, i2cflags_t mask);
+ msg_t i2cMasterTransmit(I2CDriver *i2cp,
+ uint8_t slave_addr,
+ uint8_t *txbuf, size_t txbytes,
+ uint8_t *rxbuf, size_t rxbytes,
+ i2cflags_t *errors, systime_t timeout);
+ msg_t i2cMasterReceive(I2CDriver *i2cp,
+ uint8_t slave_addr,
+ uint8_t *rxbuf, size_t rxbytes,
+ i2cflags_t *errors, systime_t timeout);
#if I2C_USE_MUTUAL_EXCLUSION
void i2cAcquireBus(I2CDriver *i2cp);