From: asterix <asterix@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Mon, 26 Jul 2010 15:32:44 +0000 (+0000)
Subject: Add comments.
X-Git-Tag: 2.6.0~288^2~24
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=bd5d86e945779d6f76e6cf01b08cf1167480e964;p=bertos.git

Add comments.

git-svn-id: https://src.develer.com/svnoss/bertos/branches/i2c@4071 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/bertos/drv/i2c.h b/bertos/drv/i2c.h
index 75fb54a5..268e2451 100644
--- a/bertos/drv/i2c.h
+++ b/bertos/drv/i2c.h
@@ -136,20 +136,24 @@ bool i2c_recv(void *_buf, size_t count);
 
 /*
  * I2c new api
- *
  */
-#define I2C_OK               0
-#define I2C_ERR           BV(3)
-#define I2C_ARB_LOST      BV(2)
-#define I2C_START_TIMEOUT BV(0)
-#define I2C_NO_ACK        BV(1)
-
 
+ /*
+  * I2C error flags
+  */
+#define I2C_OK               0     ///< I2C no errors flag
+#define I2C_ERR           BV(3)    ///< I2C generic error
+#define I2C_ARB_LOST      BV(2)    ///< I2C arbitration lost error
+#define I2C_START_TIMEOUT BV(0)    ///< I2C timeout error on start
+#define I2C_NO_ACK        BV(1)    ///< I2C no ack for sla start
 
-#define I2C_NOSTOP           0
-#define I2C_STOP          BV(0)
-#define I2C_START_R       BV(1)
-#define I2C_START_W          0
+/*
+ * I2C command flags
+ */
+#define I2C_NOSTOP           0    ///< Do not program the stop for current transition
+#define I2C_STOP          BV(0)   ///< Program the stop for current transition
+#define I2C_START_R       BV(1)   ///< Start read command
+#define I2C_START_W          0    ///< Start write command
 
 
 #define I2C_TEST_START(flag)  ((flag) & I2C_START_R)