epoc32/include/drivers/iic_transaction.inl
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of the License "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
// e32/include/iic_transaction.inl 
williamr@4
    15
//
williamr@4
    16
williamr@4
    17
inline TIicBusTransfer::TIicBusTransfer() 
williamr@4
    18
    : iBuffer(NULL), iNext(NULL), iTransaction(NULL) {}
williamr@4
    19
williamr@4
    20
inline TIicBusTransfer::TIicBusTransfer(TReqType aType, TInt8 aGranularity, TDes8* aBuffer) : iType((TInt8)aType), iNext(NULL)
williamr@4
    21
    {
williamr@4
    22
    __ASSERT_ALWAYS(aBuffer && aGranularity && aBuffer->Size()%(((aGranularity-1)>>3)+1)==0,Kern::Fault("TIicBusTransfer",__LINE__));
williamr@4
    23
    iBufGranularity=aGranularity;
williamr@4
    24
    iBuffer=aBuffer;
williamr@4
    25
    }
williamr@4
    26
williamr@4
    27
inline void TIicBusTransfer::LinkAfter(TIicBusTransfer* aPrev)
williamr@4
    28
    {
williamr@4
    29
    __ASSERT_ALWAYS(aPrev && aPrev->WordWidth()==iBufGranularity,Kern::Fault("LinkAfter",__LINE__));
williamr@4
    30
    iNext=aPrev;
williamr@4
    31
    }
williamr@4
    32
williamr@4
    33
inline TInt8 TIicBusTransfer::WordWidth() 
williamr@4
    34
    {return iBufGranularity;}
williamr@4
    35
williamr@4
    36
inline TIicBusTransfer::TReqType TIicBusTransfer::Direction() 
williamr@4
    37
    {return (TIicBusTransfer::TReqType)iType;}
williamr@4
    38
williamr@4
    39
inline TInt TIicBusTransfer::Length()
williamr@4
    40
    {
williamr@4
    41
    TInt8 granularityInBytes = (TInt8)(((iBufGranularity-1)>>3)+1);
williamr@4
    42
    return(iBuffer->Size()/granularityInBytes);
williamr@4
    43
    }
williamr@4
    44
williamr@4
    45
inline const TIicBusTransfer* TIicBusTransfer::Next() 
williamr@4
    46
    {return iNext;}
williamr@4
    47
williamr@4
    48
inline TInt TIicBusTransfer::SetTransferData(TReqType aType, TInt8 aGranularity, TDes8* aBuffer)
williamr@4
    49
    {
williamr@4
    50
    __ASSERT_ALWAYS(aBuffer && aGranularity && aBuffer->Size()%(((aGranularity-1)>>3)+1)==0,Kern::Fault("TIicBusTransfer",__LINE__));
williamr@4
    51
    if((iTransaction==NULL)||(iTransaction->State()==TIicBusTransaction::EFree))
williamr@4
    52
        {
williamr@4
    53
        iType = (TInt8)aType;
williamr@4
    54
        iBufGranularity = aGranularity;
williamr@4
    55
        iBuffer = aBuffer;
williamr@4
    56
        return KErrNone;
williamr@4
    57
        }
williamr@4
    58
    return KErrInUse;
williamr@4
    59
    }
williamr@4
    60
williamr@4
    61
inline TIicBusTransaction::TIicBusTransaction(): iHeader(NULL), iFlags(NULL), iState(EFree),
williamr@4
    62
    iHalfDuplexTrans(NULL), iFullDuplexTrans(NULL), iCallback(NULL){}
williamr@4
    63
williamr@4
    64
inline TIicBusTransaction::TIicBusTransaction(TDes8* aHeader, TIicBusTransfer* aHdTrans, TInt aPriority) :
williamr@4
    65
    iHeader(aHeader), iFlags(NULL), iState(EFree), iHalfDuplexTrans(aHdTrans),
williamr@4
    66
    iFullDuplexTrans(NULL), iCallback(NULL)
williamr@4
    67
    {
williamr@4
    68
    __ASSERT_ALWAYS((((TUint)aPriority<(TUint)KNumTrancPriorities)&&((TUint)aPriority>=0)),Kern::Fault("TIicBusTransaction",__LINE__));
williamr@4
    69
    __ASSERT_ALWAYS(aHeader && aHdTrans,Kern::Fault("TIicBusTransaction",__LINE__));
williamr@4
    70
    iKey = aPriority;
williamr@4
    71
    }
williamr@4
    72
williamr@4
    73
inline TIicBusTransaction::~TIicBusTransaction()
williamr@4
    74
    {__ASSERT_ALWAYS(iState==TIicBusTransaction::EFree,Kern::Fault("~TIicBusTransaction",__LINE__));}
williamr@4
    75
williamr@4
    76
inline TInt TIicBusTransaction::SetHalfDuplexTrans(TDes8* aHeader, TIicBusTransfer* aHdTrans)
williamr@4
    77
    {
williamr@4
    78
    __ASSERT_ALWAYS(aHeader && aHdTrans, Kern::Fault("SetHalfDuplexTrans",__LINE__));
williamr@4
    79
    __ASSERT_ALWAYS(iState==TIicBusTransaction::EFree,Kern::Fault("SetHalfDuplexTrans",__LINE__));
williamr@4
    80
    iHeader = aHeader;
williamr@4
    81
    iHalfDuplexTrans = aHdTrans;
williamr@4
    82
    while(aHdTrans)
williamr@4
    83
        {
williamr@4
    84
        aHdTrans->iTransaction=this;
williamr@4
    85
        aHdTrans = (TIicBusTransfer*)(aHdTrans->Next());
williamr@4
    86
        }
williamr@4
    87
    return KErrNone;
williamr@4
    88
    }
williamr@4
    89
williamr@4
    90
// The client interface for setting full duplex transaction: the API checks that it is possible to have the 2 transactions done in parallel.
williamr@4
    91
// It does not check if the channel supports full duplex, so the transaction may still fail at queuing time.
williamr@4
    92
inline TInt TIicBusTransaction::SetFullDuplexTrans(TIicBusTransfer* aFdTrans)
williamr@4
    93
    {
williamr@4
    94
    __ASSERT_ALWAYS(aFdTrans,Kern::Fault("SetFullDuplexTrans",__LINE__));
williamr@4
    95
    __ASSERT_ALWAYS(iState==TIicBusTransaction::EFree,Kern::Fault("SetFullDuplexTrans",__LINE__));
williamr@4
    96
    TIicBusTransfer* local = iHalfDuplexTrans;
williamr@4
    97
    TIicBusTransfer* remote = aFdTrans;
williamr@4
    98
    while(local && remote)
williamr@4
    99
        {
williamr@4
   100
        if(local->Direction()==remote->Direction())
williamr@4
   101
            return KErrNotSupported;
williamr@4
   102
        if(local->Next() && local->Length()<remote->Length())
williamr@4
   103
            return KErrNotSupported;
williamr@4
   104
        if(remote->Next() && remote->Length()<local->Length())
williamr@4
   105
            return KErrNotSupported;
williamr@4
   106
        local = (TIicBusTransfer*)(local->Next());
williamr@4
   107
        remote = (TIicBusTransfer*)(remote->Next());
williamr@4
   108
        }
williamr@4
   109
    iFullDuplexTrans = aFdTrans;
williamr@4
   110
    while(aFdTrans)
williamr@4
   111
        {
williamr@4
   112
        aFdTrans->iTransaction=this;
williamr@4
   113
        aFdTrans = (TIicBusTransfer*)(aFdTrans->Next());
williamr@4
   114
        }
williamr@4
   115
    return KErrNone;
williamr@4
   116
    }
williamr@4
   117
williamr@4
   118
inline TInt TIicBusTransaction::RemoveTrans(TIicBusTransfer* aTrans)
williamr@4
   119
    {
williamr@4
   120
    __ASSERT_ALWAYS(aTrans,Kern::Fault("RemoveTrans",__LINE__));
williamr@4
   121
    __ASSERT_ALWAYS(iState==TIicBusTransaction::EFree,Kern::Fault("RemoveTrans",__LINE__));
williamr@4
   122
    TIicBusTransfer* ptr = aTrans;
williamr@4
   123
    while(ptr!=NULL)
williamr@4
   124
        {
williamr@4
   125
        ptr->iTransaction = NULL;
williamr@4
   126
        ptr = (TIicBusTransfer*)(ptr->Next());
williamr@4
   127
        }
williamr@4
   128
    aTrans=NULL;
williamr@4
   129
    return KErrNone;
williamr@4
   130
    }
williamr@4
   131
williamr@4
   132
inline TInt TIicBusTransaction::RemoveHalfDuplexTrans() 
williamr@4
   133
    {return RemoveTrans(iHalfDuplexTrans);};
williamr@4
   134
williamr@4
   135
inline TInt TIicBusTransaction::RemoveFullDuplexTrans() 
williamr@4
   136
    {return RemoveTrans(iFullDuplexTrans);};
williamr@4
   137
williamr@4
   138
inline TUint TIicBusTransaction::Flags()
williamr@4
   139
    {return iFlags;}
williamr@4
   140
williamr@4
   141
inline TIicBusTransaction::TIicBusTransaction(TDes8* aHeader, TIicBusTransfer* aHdTrans, TUint8 aFlags, TInt aPriority) : 
williamr@4
   142
    iHeader(aHeader), iFlags(aFlags), iHalfDuplexTrans(aHdTrans), iFullDuplexTrans(NULL), iCallback(NULL)
williamr@4
   143
    {
williamr@4
   144
    __ASSERT_ALWAYS(aHeader && aHdTrans,Kern::Fault("TIicBusTransaction",__LINE__));
williamr@4
   145
    iKey = aPriority;
williamr@4
   146
    }
williamr@4
   147
williamr@4
   148
inline TUint8 TIicBusTransaction::State() 
williamr@4
   149
    {return iState;}
williamr@4
   150
williamr@4
   151
inline TInt TIicBusTransaction::GetBusId() 
williamr@4
   152
    {return iBusId;}
williamr@4
   153
williamr@4
   154
inline TIicBusCallback::TIicBusCallback(TIicBusCbFn aFn, TAny* aPtr, TDfcQue* aQue, TInt aPriority) 
williamr@4
   155
    : TDfc(DfcFunc, this, aQue, aPriority), iTransaction(NULL), iParam(aPtr), iCallback(aFn) {}
williamr@4
   156
williamr@4
   157
inline TIicBusCallback::~TIicBusCallback()
williamr@4
   158
    {__ASSERT_ALWAYS(!iTransaction || iTransaction->State()==TIicBusTransaction::EFree,Kern::Fault("~TIicBusCallback",__LINE__));}       
williamr@4
   159
williamr@4
   160
inline void TIicBusCallback::DfcFunc(TAny* aPtr)
williamr@4
   161
    {
williamr@4
   162
    TIicBusCallback* pCb = (TIicBusCallback*) aPtr;
williamr@4
   163
    pCb->iCallback(pCb->iTransaction, pCb->iBusId, pCb->iResult, pCb->iParam);
williamr@4
   164
    }
williamr@4
   165
williamr@4
   166
inline TIicBusSlaveCallback::TIicBusSlaveCallback(TIicBusSlaveCbFn aFn, TAny* aPtr, TDfcQue* aQue, TInt aPriority):  
williamr@4
   167
    TDfc(DfcFunc, this, aQue, aPriority), iParam(aPtr), iCallback(aFn) { }
williamr@4
   168
williamr@4
   169
inline void TIicBusSlaveCallback::SetReturn(TInt aRet) 
williamr@4
   170
    {iReturn=aRet;}
williamr@4
   171
williamr@4
   172
inline void TIicBusSlaveCallback::SetTxWords(TInt16 aTxWords) 
williamr@4
   173
    {iTxWords=aTxWords;}
williamr@4
   174
williamr@4
   175
inline void TIicBusSlaveCallback::SetRxWords(TInt16 aRxWords) 
williamr@4
   176
    {iRxWords=aRxWords;} 
williamr@4
   177
williamr@4
   178
inline TInt TIicBusSlaveCallback::GetTrigger() 
williamr@4
   179
    {return iTrigger;}
williamr@4
   180
williamr@4
   181
inline void TIicBusSlaveCallback::SetTrigger(TInt aTrigger) 
williamr@4
   182
    {iTrigger = aTrigger;}
williamr@4
   183
williamr@4
   184
inline TIicBusTransactionPreamble::TIicBusTransactionPreamble(TDes8* aHeader, TIicBusTransfer* aHdTrans, TIicBusPreamble aPreamble, TAny* aArg, TInt aPriority) :
williamr@4
   185
    TIicBusTransaction(aHeader, aHdTrans, KTransactionWithPreamble, aPriority), iPreamble(aPreamble), iPreambleArg(aArg)
williamr@4
   186
    {}
williamr@4
   187
williamr@4
   188
inline TIicBusTransactionPreamble::TIicBusTransactionPreamble(TDes8* aHeader, TIicBusTransfer* aHdTrans, TIicBusPreamble aPreamble, TAny* aArg, TUint8 aFlags, TInt aPriority) :
williamr@4
   189
    TIicBusTransaction(aHeader, aHdTrans, aFlags, aPriority), iPreamble(aPreamble), iPreambleArg(aArg)
williamr@4
   190
    {}
williamr@4
   191
williamr@4
   192
inline TIicBusTransactionMultiTransc::TIicBusTransactionMultiTransc(TDes8* aHeader, TIicBusTransfer* aHdTrans, TIicBusMultiTranscCbFn aMultiTransc, TAny* aArg, TInt aPriority) :
williamr@4
   193
    TIicBusTransaction(aHeader, aHdTrans, KTransactionWithMultiTransc, aPriority), iMultiTransc(aMultiTransc), iMultiTranscArg(aArg)
williamr@4
   194
    {}
williamr@4
   195
williamr@4
   196
inline TIicBusTransactionPreambleExt::TIicBusTransactionPreambleExt(TDes8* aHeader, TIicBusTransfer* aHdTrans,
williamr@4
   197
    TIicBusPreamble aPreamble, TAny* aPreambleArg,
williamr@4
   198
    TIicBusMultiTranscCbFn aMultiTransc, TAny* aMultiTranscArg, TInt aPriority) :
williamr@4
   199
    TIicBusTransactionPreamble(aHeader, aHdTrans, aPreamble, aPreambleArg, KTransactionWithPreamble|KTransactionWithMultiTransc, aPriority),
williamr@4
   200
    iMultiTransc(aMultiTransc), iMultiTranscArg(aMultiTranscArg)
williamr@4
   201
    {}
williamr@4
   202
williamr@4
   203
inline static TInt CreateSpiBuf(TConfigSpiBufV01*& aBuf,
williamr@4
   204
                                TSpiWordWidth   aWordWidth,
williamr@4
   205
                                TInt32          aClkSpeedHz,
williamr@4
   206
                                TSpiClkMode     aClkMode,
williamr@4
   207
                                TInt32          aTimeoutPeriod,
williamr@4
   208
                                TEndianness     aEndianness,
williamr@4
   209
                                TBitOrder       aBitOrder,
williamr@4
   210
                                TUint           aTransactionWaitCycles,
williamr@4
   211
                                TSpiSsPinMode   aSSPinActiveMode)
williamr@4
   212
// Utility function to create a buffer for the SPI bus
williamr@4
   213
    {
williamr@4
   214
    aBuf = new TConfigSpiBufV01();
williamr@4
   215
    if(aBuf==NULL)
williamr@4
   216
        return KErrNoMemory;
williamr@4
   217
    TConfigSpiV01 *buf = &((*aBuf)());
williamr@4
   218
    buf->iWordWidth = aWordWidth;
williamr@4
   219
    buf->iClkSpeedHz = aClkSpeedHz;
williamr@4
   220
    buf->iClkMode = aClkMode;
williamr@4
   221
    buf->iTimeoutPeriod = aTimeoutPeriod;
williamr@4
   222
    buf->iEndianness = aEndianness;
williamr@4
   223
    buf->iBitOrder = aBitOrder;
williamr@4
   224
    buf->iTransactionWaitCycles = aTransactionWaitCycles;
williamr@4
   225
    buf->iSSPinActiveMode = aSSPinActiveMode;
williamr@4
   226
    return KErrNone;
williamr@4
   227
    }
williamr@4
   228
williamr@4
   229
inline static TInt CreateI2cBuf(TConfigI2cBufV01*& aBuf,
williamr@4
   230
                                TI2cAddrType    aAddrType,
williamr@4
   231
                                TInt32          aClkSpeedHz,
williamr@4
   232
                                TEndianness     aEndianness,
williamr@4
   233
                                TInt32          aTimeoutPeriod)
williamr@4
   234
// Utility function to create a buffer for the I2C bus
williamr@4
   235
    {
williamr@4
   236
    aBuf = new TConfigI2cBufV01();
williamr@4
   237
    if(aBuf==NULL)
williamr@4
   238
        return KErrNoMemory;
williamr@4
   239
    TConfigI2cV01 *buf = &((*aBuf)());
williamr@4
   240
    buf->iAddrType = aAddrType;
williamr@4
   241
    buf->iClkSpeedHz = aClkSpeedHz;
williamr@4
   242
    buf->iEndianness = aEndianness;
williamr@4
   243
    buf->iTimeoutPeriod = aTimeoutPeriod;
williamr@4
   244
    return KErrNone;
williamr@4
   245
    }