git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3407 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 50 insertions, 55 deletions

diff --git a/os/hal/include/i2c.h b/os/hal/include/i2c.h
index acf09ec9c..cf4d47713 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,27 +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.                 */

+  I2C_ACTIVE_TRANSCEIVE = 5,                /**< Receiving after transmit.  */

 } 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.

+ *          no matter if sending or reading.

  *

  * @param[in] i2cp      pointer to the @p I2CDriver object triggering the

  *                      callback

@@ -107,7 +104,6 @@ typedef enum {
  */

 typedef void (*i2ccallback_t)(I2CDriver *i2cp, const I2CSlaveConfig *i2cscfg);

 

-

 /**

  * @brief   I2C error notification callback type.

  *

@@ -119,13 +115,11 @@ typedef void (*i2ccallback_t)(I2CDriver *i2cp, const I2CSlaveConfig *i2cscfg);
 typedef void (*i2cerrorcallback_t)(I2CDriver *i2cp,

                                    const I2CSlaveConfig *i2cscfg);

 

-

 /**

- * @brief I2C transmission data block size.

+ * @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

@@ -138,7 +132,6 @@ struct I2CSlaveConfig{
    *        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.

@@ -150,7 +143,6 @@ struct I2CSlaveConfig{
 #endif

 };

 

-

 /*===========================================================================*/

 /* Driver macros.                                                            */

 /*===========================================================================*/

@@ -209,17 +201,18 @@ struct I2CSlaveConfig{
  *          implementation only.

  *

  * @param[in] i2cp      pointer to the @p I2CDriver object

+ * @param[in] i2cscfg   pointer to the @p I2CSlaveConfig object

  *

  * @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) {                                      \

+  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);                                                    \

 }

 

 /**

@@ -233,22 +226,24 @@ struct I2CSlaveConfig{
  *          implementation only.

  *

  * @param[in] i2cp      pointer to the @p I2CDriver object

+ * @param[in] i2cscfg   pointer to the @p I2CSlaveConfig object

  *

  * @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) {                                  \

+  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);                                                    \

 }

 

 /*===========================================================================*/

 /* External declarations.                                                    */

 /*===========================================================================*/

+

 #ifdef __cplusplus

 extern "C" {

 #endif

@@ -257,11 +252,11 @@ extern "C" {
   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);

+                         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);

+                        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);