omap3530/omap3530_drivers/spi/slave.h
author Lukasz Forynski <lukasz.forynski@gmail.com>
Tue, 21 Sep 2010 02:30:11 +0100
branchBeagle_BSP_dev
changeset 77 e5fd00cbb70a
permissions -rw-r--r--
Added IIC SPI implementation / tests (Master channel only)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
77
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
     1
// Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
     2
// All rights reserved.
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
     3
// This component and the accompanying materials are made available
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
     4
// under the terms of the License "Eclipse Public License v1.0"
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
     5
// which accompanies this distribution, and is available
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
     7
//
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
     8
// Initial Contributors:
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    10
//
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    11
// Contributors:
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    12
// lukasz.forynski@gmail.com
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    13
//
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    14
// Description:
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    15
// omap3530/omap3530_drivers/spi/slave.h
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    16
//
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    17
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    18
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    19
#ifndef __OMAP3530_SPI_SLAVE_H__
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    20
#define __OMAP3530_SPI_SLAVE_H__
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    21
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    22
#include <drivers/iic_channel.h>
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    23
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    24
class DSpiSlaveBeagle: public DIicBusChannelSlave
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    25
	{
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    26
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    27
public:
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    28
	static DSpiSlaveBeagle* New(TInt aChannelNumber, const TBusType aBusType,
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    29
	                              const TChannelDuplex aChanDuplex);
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    30
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    31
	// Gateway function for PSL implementation
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    32
	virtual TInt DoRequest(TInt aOperation);
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    33
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    34
	DSpiSlaveBeagle(TInt aChannelNumber, const TBusType aBusType,
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    35
	                 const TChannelDuplex aChanDuplex);
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    36
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    37
private:
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    38
	// Overriders for base class pure-virtual methods
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    39
	virtual TInt DoCreate(); // second-stage construction,
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    40
	virtual TInt CheckHdr(TDes8* aHdrBuff);
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    41
	virtual void ProcessData(TInt aTrigger, TIicBusSlaveCallback* aCb);
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    42
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    43
	// Internal methods..
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    44
	TBool TransConfigDiffersFromPrev();
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    45
	TInt ConfigureInterface();
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    46
	TInt AsynchConfigureInterface();
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    47
	TInt InitTransfer();
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    48
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    49
	// ISR handler and other static methods..
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    50
	static void IicPslIsr(TAny* aPtr);
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    51
	static void TimeoutCallback(TAny* aPtr);
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    52
	static inline void NotifyClientEnd(DSpiSlaveBeagle* aPtr);
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    53
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    54
	// Register base for the Master channel
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    55
	TUint iSlaveChanBase;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    56
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    57
	// Interrupt ID for the Master channel
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    58
	TInt iSlaveIntId;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    59
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    60
	// Bit mask of the transfer triggers managed by the channel
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    61
	TUint8 iTrigger;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    62
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    63
	// Granularity, expressed as the number of bytes in a word
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    64
	TInt8 iWordSize;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    65
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    66
	// Flag indicating transmission activity - optional, may not be required for all bus types
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    67
	// In the template example it is used to indicate transitions on a chip-select line, such as for SPI.
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    68
	TInt8 iInProgress;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    69
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    70
	// Dummy variable used merely to demonstrate the asynchronous channel capture mechanism
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    71
	// See method AsynchConfigureInterface
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    72
	TInt8 iAsyncConfig;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    73
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    74
	// Pointers to buffers used for Rx and Tx transfers
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    75
	TInt8 *iTxData;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    76
	TInt8 *iRxData;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    77
	TInt8 *iTxDataEnd;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    78
	TInt8 *iRxDataEnd;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    79
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    80
	// Timer to guard 'while' loops..
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    81
	NTimer iHwGuardTimer;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    82
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    83
	// status of the transaction
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    84
	volatile TInt iTransactionStatus;
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    85
	};
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    86
e5fd00cbb70a Added IIC SPI implementation / tests (Master channel only)
Lukasz Forynski <lukasz.forynski@gmail.com>
parents:
diff changeset
    87
#endif /*__OMAP3530_SPI_SLAVE_H__*/