1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/kernelhwsrv/kernel/eka/include/drivers/iic_transaction.inl Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,245 @@
1.4 +// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// e32/include/iic_transaction.inl
1.18 +//
1.19 +
1.20 +inline TIicBusTransfer::TIicBusTransfer()
1.21 + : iBuffer(NULL), iNext(NULL), iTransaction(NULL) {}
1.22 +
1.23 +inline TIicBusTransfer::TIicBusTransfer(TReqType aType, TInt8 aGranularity, TDes8* aBuffer) : iType((TInt8)aType), iNext(NULL)
1.24 + {
1.25 + __ASSERT_ALWAYS(aBuffer && aGranularity && aBuffer->Size()%(((aGranularity-1)>>3)+1)==0,Kern::Fault("TIicBusTransfer",__LINE__));
1.26 + iBufGranularity=aGranularity;
1.27 + iBuffer=aBuffer;
1.28 + }
1.29 +
1.30 +inline void TIicBusTransfer::LinkAfter(TIicBusTransfer* aPrev)
1.31 + {
1.32 + __ASSERT_ALWAYS(aPrev && aPrev->WordWidth()==iBufGranularity,Kern::Fault("LinkAfter",__LINE__));
1.33 + iNext=aPrev;
1.34 + }
1.35 +
1.36 +inline TInt8 TIicBusTransfer::WordWidth()
1.37 + {return iBufGranularity;}
1.38 +
1.39 +inline TIicBusTransfer::TReqType TIicBusTransfer::Direction()
1.40 + {return (TIicBusTransfer::TReqType)iType;}
1.41 +
1.42 +inline TInt TIicBusTransfer::Length()
1.43 + {
1.44 + TInt8 granularityInBytes = (TInt8)(((iBufGranularity-1)>>3)+1);
1.45 + return(iBuffer->Size()/granularityInBytes);
1.46 + }
1.47 +
1.48 +inline const TIicBusTransfer* TIicBusTransfer::Next()
1.49 + {return iNext;}
1.50 +
1.51 +inline TInt TIicBusTransfer::SetTransferData(TReqType aType, TInt8 aGranularity, TDes8* aBuffer)
1.52 + {
1.53 + __ASSERT_ALWAYS(aBuffer && aGranularity && aBuffer->Size()%(((aGranularity-1)>>3)+1)==0,Kern::Fault("TIicBusTransfer",__LINE__));
1.54 + if((iTransaction==NULL)||(iTransaction->State()==TIicBusTransaction::EFree))
1.55 + {
1.56 + iType = (TInt8)aType;
1.57 + iBufGranularity = aGranularity;
1.58 + iBuffer = aBuffer;
1.59 + return KErrNone;
1.60 + }
1.61 + return KErrInUse;
1.62 + }
1.63 +
1.64 +inline TIicBusTransaction::TIicBusTransaction(): iHeader(NULL), iFlags(NULL), iState(EFree),
1.65 + iHalfDuplexTrans(NULL), iFullDuplexTrans(NULL), iCallback(NULL){}
1.66 +
1.67 +inline TIicBusTransaction::TIicBusTransaction(TDes8* aHeader, TIicBusTransfer* aHdTrans, TInt aPriority) :
1.68 + iHeader(aHeader), iFlags(NULL), iState(EFree), iHalfDuplexTrans(aHdTrans),
1.69 + iFullDuplexTrans(NULL), iCallback(NULL)
1.70 + {
1.71 + __ASSERT_ALWAYS((((TUint)aPriority<(TUint)KNumTrancPriorities)&&((TUint)aPriority>=0)),Kern::Fault("TIicBusTransaction",__LINE__));
1.72 + __ASSERT_ALWAYS(aHeader && aHdTrans,Kern::Fault("TIicBusTransaction",__LINE__));
1.73 + iKey = aPriority;
1.74 + }
1.75 +
1.76 +inline TIicBusTransaction::~TIicBusTransaction()
1.77 + {__ASSERT_ALWAYS(iState==TIicBusTransaction::EFree,Kern::Fault("~TIicBusTransaction",__LINE__));}
1.78 +
1.79 +inline TInt TIicBusTransaction::SetHalfDuplexTrans(TDes8* aHeader, TIicBusTransfer* aHdTrans)
1.80 + {
1.81 + __ASSERT_ALWAYS(aHeader && aHdTrans, Kern::Fault("SetHalfDuplexTrans",__LINE__));
1.82 + __ASSERT_ALWAYS(iState==TIicBusTransaction::EFree,Kern::Fault("SetHalfDuplexTrans",__LINE__));
1.83 + iHeader = aHeader;
1.84 + iHalfDuplexTrans = aHdTrans;
1.85 + while(aHdTrans)
1.86 + {
1.87 + aHdTrans->iTransaction=this;
1.88 + aHdTrans = (TIicBusTransfer*)(aHdTrans->Next());
1.89 + }
1.90 + return KErrNone;
1.91 + }
1.92 +
1.93 +// The client interface for setting full duplex transaction: the API checks that it is possible to have the 2 transactions done in parallel.
1.94 +// It does not check if the channel supports full duplex, so the transaction may still fail at queuing time.
1.95 +inline TInt TIicBusTransaction::SetFullDuplexTrans(TIicBusTransfer* aFdTrans)
1.96 + {
1.97 + __ASSERT_ALWAYS(aFdTrans,Kern::Fault("SetFullDuplexTrans",__LINE__));
1.98 + __ASSERT_ALWAYS(iState==TIicBusTransaction::EFree,Kern::Fault("SetFullDuplexTrans",__LINE__));
1.99 + TIicBusTransfer* local = iHalfDuplexTrans;
1.100 + TIicBusTransfer* remote = aFdTrans;
1.101 + while(local && remote)
1.102 + {
1.103 + if(local->Direction()==remote->Direction())
1.104 + return KErrNotSupported;
1.105 + if(local->Next() && local->Length()<remote->Length())
1.106 + return KErrNotSupported;
1.107 + if(remote->Next() && remote->Length()<local->Length())
1.108 + return KErrNotSupported;
1.109 + local = (TIicBusTransfer*)(local->Next());
1.110 + remote = (TIicBusTransfer*)(remote->Next());
1.111 + }
1.112 + iFullDuplexTrans = aFdTrans;
1.113 + while(aFdTrans)
1.114 + {
1.115 + aFdTrans->iTransaction=this;
1.116 + aFdTrans = (TIicBusTransfer*)(aFdTrans->Next());
1.117 + }
1.118 + return KErrNone;
1.119 + }
1.120 +
1.121 +inline TInt TIicBusTransaction::RemoveTrans(TIicBusTransfer* aTrans)
1.122 + {
1.123 + __ASSERT_ALWAYS(aTrans,Kern::Fault("RemoveTrans",__LINE__));
1.124 + __ASSERT_ALWAYS(iState==TIicBusTransaction::EFree,Kern::Fault("RemoveTrans",__LINE__));
1.125 + TIicBusTransfer* ptr = aTrans;
1.126 + while(ptr!=NULL)
1.127 + {
1.128 + ptr->iTransaction = NULL;
1.129 + ptr = (TIicBusTransfer*)(ptr->Next());
1.130 + }
1.131 + aTrans=NULL;
1.132 + return KErrNone;
1.133 + }
1.134 +
1.135 +inline TInt TIicBusTransaction::RemoveHalfDuplexTrans()
1.136 + {return RemoveTrans(iHalfDuplexTrans);};
1.137 +
1.138 +inline TInt TIicBusTransaction::RemoveFullDuplexTrans()
1.139 + {return RemoveTrans(iFullDuplexTrans);};
1.140 +
1.141 +inline TUint TIicBusTransaction::Flags()
1.142 + {return iFlags;}
1.143 +
1.144 +inline TIicBusTransaction::TIicBusTransaction(TDes8* aHeader, TIicBusTransfer* aHdTrans, TUint8 aFlags, TInt aPriority) :
1.145 + iHeader(aHeader), iFlags(aFlags), iHalfDuplexTrans(aHdTrans), iFullDuplexTrans(NULL), iCallback(NULL)
1.146 + {
1.147 + __ASSERT_ALWAYS(aHeader && aHdTrans,Kern::Fault("TIicBusTransaction",__LINE__));
1.148 + iKey = aPriority;
1.149 + }
1.150 +
1.151 +inline TUint8 TIicBusTransaction::State()
1.152 + {return iState;}
1.153 +
1.154 +inline TInt TIicBusTransaction::GetBusId()
1.155 + {return iBusId;}
1.156 +
1.157 +inline TIicBusCallback::TIicBusCallback(TIicBusCbFn aFn, TAny* aPtr, TDfcQue* aQue, TInt aPriority)
1.158 + : TDfc(DfcFunc, this, aQue, aPriority), iTransaction(NULL), iParam(aPtr), iCallback(aFn) {}
1.159 +
1.160 +inline TIicBusCallback::~TIicBusCallback()
1.161 + {__ASSERT_ALWAYS(!iTransaction || iTransaction->State()==TIicBusTransaction::EFree,Kern::Fault("~TIicBusCallback",__LINE__));}
1.162 +
1.163 +inline void TIicBusCallback::DfcFunc(TAny* aPtr)
1.164 + {
1.165 + TIicBusCallback* pCb = (TIicBusCallback*) aPtr;
1.166 + pCb->iCallback(pCb->iTransaction, pCb->iBusId, pCb->iResult, pCb->iParam);
1.167 + }
1.168 +
1.169 +inline TIicBusSlaveCallback::TIicBusSlaveCallback(TIicBusSlaveCbFn aFn, TAny* aPtr, TDfcQue* aQue, TInt aPriority):
1.170 + TDfc(DfcFunc, this, aQue, aPriority), iParam(aPtr), iCallback(aFn) { }
1.171 +
1.172 +inline void TIicBusSlaveCallback::SetReturn(TInt aRet)
1.173 + {iReturn=aRet;}
1.174 +
1.175 +inline void TIicBusSlaveCallback::SetTxWords(TInt16 aTxWords)
1.176 + {iTxWords=aTxWords;}
1.177 +
1.178 +inline void TIicBusSlaveCallback::SetRxWords(TInt16 aRxWords)
1.179 + {iRxWords=aRxWords;}
1.180 +
1.181 +inline TInt TIicBusSlaveCallback::GetTrigger()
1.182 + {return iTrigger;}
1.183 +
1.184 +inline void TIicBusSlaveCallback::SetTrigger(TInt aTrigger)
1.185 + {iTrigger = aTrigger;}
1.186 +
1.187 +inline TIicBusTransactionPreamble::TIicBusTransactionPreamble(TDes8* aHeader, TIicBusTransfer* aHdTrans, TIicBusPreamble aPreamble, TAny* aArg, TInt aPriority) :
1.188 + TIicBusTransaction(aHeader, aHdTrans, KTransactionWithPreamble, aPriority), iPreamble(aPreamble), iPreambleArg(aArg)
1.189 + {}
1.190 +
1.191 +inline TIicBusTransactionPreamble::TIicBusTransactionPreamble(TDes8* aHeader, TIicBusTransfer* aHdTrans, TIicBusPreamble aPreamble, TAny* aArg, TUint8 aFlags, TInt aPriority) :
1.192 + TIicBusTransaction(aHeader, aHdTrans, aFlags, aPriority), iPreamble(aPreamble), iPreambleArg(aArg)
1.193 + {}
1.194 +
1.195 +inline TIicBusTransactionMultiTransc::TIicBusTransactionMultiTransc(TDes8* aHeader, TIicBusTransfer* aHdTrans, TIicBusMultiTranscCbFn aMultiTransc, TAny* aArg, TInt aPriority) :
1.196 + TIicBusTransaction(aHeader, aHdTrans, KTransactionWithMultiTransc, aPriority), iMultiTransc(aMultiTransc), iMultiTranscArg(aArg)
1.197 + {}
1.198 +
1.199 +inline TIicBusTransactionPreambleExt::TIicBusTransactionPreambleExt(TDes8* aHeader, TIicBusTransfer* aHdTrans,
1.200 + TIicBusPreamble aPreamble, TAny* aPreambleArg,
1.201 + TIicBusMultiTranscCbFn aMultiTransc, TAny* aMultiTranscArg, TInt aPriority) :
1.202 + TIicBusTransactionPreamble(aHeader, aHdTrans, aPreamble, aPreambleArg, KTransactionWithPreamble|KTransactionWithMultiTransc, aPriority),
1.203 + iMultiTransc(aMultiTransc), iMultiTranscArg(aMultiTranscArg)
1.204 + {}
1.205 +
1.206 +inline static TInt CreateSpiBuf(TConfigSpiBufV01*& aBuf,
1.207 + TSpiWordWidth aWordWidth,
1.208 + TInt32 aClkSpeedHz,
1.209 + TSpiClkMode aClkMode,
1.210 + TInt32 aTimeoutPeriod,
1.211 + TEndianness aEndianness,
1.212 + TBitOrder aBitOrder,
1.213 + TUint aTransactionWaitCycles,
1.214 + TSpiSsPinMode aSSPinActiveMode)
1.215 +// Utility function to create a buffer for the SPI bus
1.216 + {
1.217 + aBuf = new TConfigSpiBufV01();
1.218 + if(aBuf==NULL)
1.219 + return KErrNoMemory;
1.220 + TConfigSpiV01 *buf = &((*aBuf)());
1.221 + buf->iWordWidth = aWordWidth;
1.222 + buf->iClkSpeedHz = aClkSpeedHz;
1.223 + buf->iClkMode = aClkMode;
1.224 + buf->iTimeoutPeriod = aTimeoutPeriod;
1.225 + buf->iEndianness = aEndianness;
1.226 + buf->iBitOrder = aBitOrder;
1.227 + buf->iTransactionWaitCycles = aTransactionWaitCycles;
1.228 + buf->iSSPinActiveMode = aSSPinActiveMode;
1.229 + return KErrNone;
1.230 + }
1.231 +
1.232 +inline static TInt CreateI2cBuf(TConfigI2cBufV01*& aBuf,
1.233 + TI2cAddrType aAddrType,
1.234 + TInt32 aClkSpeedHz,
1.235 + TEndianness aEndianness,
1.236 + TInt32 aTimeoutPeriod)
1.237 +// Utility function to create a buffer for the I2C bus
1.238 + {
1.239 + aBuf = new TConfigI2cBufV01();
1.240 + if(aBuf==NULL)
1.241 + return KErrNoMemory;
1.242 + TConfigI2cV01 *buf = &((*aBuf)());
1.243 + buf->iAddrType = aAddrType;
1.244 + buf->iClkSpeedHz = aClkSpeedHz;
1.245 + buf->iEndianness = aEndianness;
1.246 + buf->iTimeoutPeriod = aTimeoutPeriod;
1.247 + return KErrNone;
1.248 + }