kernel/eka/include/drivers/iic_transaction.h
branchRCL_3
changeset 256 c1f20ce4abcf
parent 0 a41df078684a
child 257 3e88ff8f41d5
--- a/kernel/eka/include/drivers/iic_transaction.h	Thu Aug 19 11:14:22 2010 +0300
+++ b/kernel/eka/include/drivers/iic_transaction.h	Tue Aug 31 16:34:26 2010 +0300
@@ -192,7 +192,7 @@
 // 27:23 - Reserved
 // 22:20 - Bus type
 // 19:15 - Channel number
-// 14:10 - Transaction speed
+// 14:10 - Transaction speed	// For use with SET_TRANS_SPEED, GET_TRANS_SPEED - Deprecated
 //  9:0  - Slave address
 #define HS_MASTER_ADDR_SHIFT 29
 #define HS_MASTER_ADDR_MASK 0x7
@@ -202,8 +202,8 @@
 #define BUS_TYPE_MASK 0x7
 #define CHANNEL_NO_SHIFT 15
 #define CHANNEL_NO_MASK 0x1F
-#define TRANS_SPEED_SHIFT 10
-#define TRANS_SPEED_MASK 0x1F
+#define TRANS_SPEED_SHIFT 10	// For use with SET_TRANS_SPEED, GET_TRANS_SPEED - Deprecated
+#define TRANS_SPEED_MASK 0x1F	// For use with SET_TRANS_SPEED, GET_TRANS_SPEED - Deprecated
 #define SLAVE_ADDR_SHIFT 0
 #define SLAVE_ADDR_MASK 0x3FF
 
@@ -262,13 +262,13 @@
 #define SET_CHAN_NUM(aBusId,aChanNum) SET_CONF_FIELD(aBusId,aChanNum,CHANNEL_NO_MASK,CHANNEL_NO_SHIFT)
 /**
 @publishedPartner
-@prototype 9.6
+@deprecated
 Macro to set the Transaction speed of a Bus realisation configuration
 */
 #define SET_TRANS_SPEED(aBusId,aTransSpeed) SET_CONF_FIELD(aBusId,aTransSpeed,TRANS_SPEED_MASK,TRANS_SPEED_SHIFT)
 /**
 @publishedPartner
-@prototype 9.6
+@deprecated
 Macro to get the Transaction speed of a Bus realisation configuration
 */
 #define GET_TRANS_SPEED(aBusId) GET_CONF_FIELD(aBusId,TRANS_SPEED_MASK,TRANS_SPEED_SHIFT)
@@ -421,6 +421,7 @@
         inline TIicBusTransaction();
     
         // the client interface for creating half duplex transactions
+		// The parameter aPriority is required to be at least zero and less than KNumTrancPriorities.
         inline TIicBusTransaction(TDes8* aHeader, TIicBusTransfer* aHdTrans, TInt aPriority=0);
         inline ~TIicBusTransaction();
         inline TInt SetHalfDuplexTrans(TDes8* aHeader, TIicBusTransfer* aHdTrans);