#include <SPI.h>

Inheritance diagram for SPI:

Collaboration diagram for SPI:

Public Types
enum	tFrameMode { kChipSelect, kPreLatchPulse, kPostLatchPulse, kPreAndPostLatchPulse }
enum	tSPIConstants { kReceiveFIFODepth = 512, kTransmitFIFODepth = 512 }

Public Member Functions
	SPI (DigitalOutput &clk, DigitalOutput &mosi, DigitalInput &miso)
	SPI (DigitalOutput clk, DigitalOutput mosi, DigitalInput *miso)
	SPI (DigitalOutput &clk, DigitalOutput &mosi)
	SPI (DigitalOutput clk, DigitalOutput mosi)
	SPI (DigitalOutput &clk, DigitalInput &miso)
	SPI (DigitalOutput clk, DigitalInput miso)
virtual	~SPI ()
void	SetBitsPerWord (UINT32 bits)
UINT32	GetBitsPerWord ()
void	SetClockRate (double hz)
void	SetMSBFirst ()
void	SetLSBFirst ()
void	SetSampleDataOnFalling ()
void	SetSampleDataOnRising ()
void	SetSlaveSelect (DigitalOutput *ss, tFrameMode mode=kChipSelect, bool activeLow=false)
void	SetSlaveSelect (DigitalOutput &ss, tFrameMode mode=kChipSelect, bool activeLow=false)
DigitalOutput *	GetSlaveSelect (tFrameMode mode=NULL, bool activeLow=NULL)
void	SetClockActiveLow ()
void	SetClockActiveHigh ()
virtual void	ApplyConfig ()
virtual UINT16	GetOutputFIFOAvailable ()
virtual UINT16	GetNumReceived ()
virtual bool	IsDone ()
bool	HadReceiveOverflow ()
virtual void	Write (UINT32 data)
virtual UINT32	Read (bool initiate=false)
virtual void	Reset ()
virtual void	ClearReceivedData ()
Public Member Functions inherited from SensorBase
	SensorBase ()
virtual	~SensorBase ()
Public Member Functions inherited from ErrorBase
virtual Error &	GetError ()
	Retrieve the current error. Get the current error information associated with this sensor.
virtual const Error &	GetError () const
virtual void	SetErrnoError (const char contextMessage, const char filename, const char *function, UINT32 lineNumber) const
	Set error information associated with a C library call that set an error to the "errno" global variable.
virtual void	SetImaqError (int success, const char contextMessage, const char filename, const char *function, UINT32 lineNumber) const
	Set the current error information associated from the nivision Imaq API.
virtual void	SetError (Error::Code code, const char contextMessage, const char filename, const char *function, UINT32 lineNumber) const
	Set the current error information associated with this sensor.
virtual void	SetWPIError (const char errorMessage, const char contextMessage, const char filename, const char function, UINT32 lineNumber) const
	Set the current error information associated with this sensor.
virtual void	CloneError (ErrorBase *rhs) const
virtual void	ClearError () const
	Clear the current error information associated with this sensor.
virtual bool	StatusIsFatal () const
	Check if the current error code represents a fatal error.

Protected Attributes
tSPI *	m_spi
tSPI::tConfig	m_config
tSPI::tChannels	m_channels
DigitalOutput *	m_ss

Static Protected Attributes
static SEM_ID	m_semaphore = NULL

Additional Inherited Members
Static Public Member Functions inherited from SensorBase
static void	DeleteSingletons ()
static UINT32	GetDefaultAnalogModule ()
static UINT32	GetDefaultDigitalModule ()
static UINT32	GetDefaultSolenoidModule ()
static bool	CheckAnalogModule (UINT8 moduleNumber)
static bool	CheckDigitalModule (UINT8 moduleNumber)
static bool	CheckPWMModule (UINT8 moduleNumber)
static bool	CheckRelayModule (UINT8 moduleNumber)
static bool	CheckSolenoidModule (UINT8 moduleNumber)
static bool	CheckDigitalChannel (UINT32 channel)
static bool	CheckRelayChannel (UINT32 channel)
static bool	CheckPWMChannel (UINT32 channel)
static bool	CheckAnalogChannel (UINT32 channel)
static bool	CheckSolenoidChannel (UINT32 channel)
Static Public Attributes inherited from SensorBase
static const UINT32	kSystemClockTicksPerMicrosecond = 40
static const UINT32	kDigitalChannels = 14
static const UINT32	kAnalogChannels = 8
static const UINT32	kAnalogModules = 2
static const UINT32	kDigitalModules = 2
static const UINT32	kSolenoidChannels = 8
static const UINT32	kSolenoidModules = 2
static const UINT32	kPwmChannels = 10
static const UINT32	kRelayChannels = 8
static const UINT32	kChassisSlots = 8
Protected Member Functions inherited from SensorBase
void	AddToSingletonList ()

Detailed Description

SPI bus interface class.

This class is intended to be used by sensor (and other SPI device) drivers. It probably should not be used directly.

The FPGA only supports a single SPI interface.

Definition at line 24 of file SPI.h.

Constructor & Destructor Documentation

SPI::SPI	(	DigitalOutput &	clk,
		DigitalOutput &	mosi,
		DigitalInput &	miso
	)

Constructor for input and output.

Parameters

clk	The digital output for the clock signal.
mosi	The digital output for the written data to the slave (master-out slave-in).
miso	The digital input for the input data from the slave (master-in slave-out).

Definition at line 30 of file SPI.cpp.

SPI::SPI	(	DigitalOutput *	clk,
		DigitalOutput *	mosi,
		DigitalInput *	miso
	)

Constructor for input and output.

Parameters

clk	The digital output for the clock signal.
mosi	The digital output for the written data to the slave (master-out slave-in).
miso	The digital input for the input data from the slave (master-in slave-out).

Definition at line 44 of file SPI.cpp.

SPI::SPI	(	DigitalOutput &	clk,
		DigitalOutput &	mosi
	)

Constructor for output only.

Parameters

clk	The digital output for the clock signal.
mosi	The digital output for the written data to the slave (master-out slave-in).

Definition at line 56 of file SPI.cpp.

SPI::SPI	(	DigitalOutput *	clk,
		DigitalOutput *	mosi
	)

Constructor for output only.

Parameters

clk	The digital output for the clock signal.
mosi	The digital output for the written data to the slave (master-out slave-in).

Definition at line 68 of file SPI.cpp.

SPI::SPI	(	DigitalOutput &	clk,
		DigitalInput &	miso
	)

Constructor for input only.

Parameters

clk	The digital output for the clock signal.
miso	The digital input for the input data from the slave (master-in slave-out).

Definition at line 80 of file SPI.cpp.

SPI::SPI	(	DigitalOutput *	clk,
		DigitalInput *	miso
	)

Constructor for input only.

Parameters

clk	The digital output for the clock signal.
miso	The digital input for the input data from the slave (master-in slave-out).

Definition at line 92 of file SPI.cpp.

SPI::~SPI ( )

virtual

Destructor.

Definition at line 100 of file SPI.cpp.

Member Function Documentation

void SPI::ApplyConfig ( )

virtual

Apply configuration settings and reset the SPI logic.

Definition at line 363 of file SPI.cpp.

void SPI::ClearReceivedData ( )

virtual

Empty the receive FIFO.

Definition at line 523 of file SPI.cpp.

UINT32 SPI::GetBitsPerWord ( )

Get the number of bits from each word that the slave transmits or receives.

Returns: The number of bits in one frame (1 to 32 bits).

Definition at line 186 of file SPI.cpp.

UINT16 SPI::GetNumReceived ( )

virtual

Get the number of words received and currently available to be read from the receive FIFO.

Returns: The number of words available to read.

Definition at line 394 of file SPI.cpp.

UINT16 SPI::GetOutputFIFOAvailable ( )

virtual

Get the number of words that can currently be stored before being transmitted to the device.

Returns: The number of words available to be written.

Definition at line 380 of file SPI.cpp.

DigitalOutput * SPI::GetSlaveSelect	(	tFrameMode *	mode = `NULL`,
		bool *	activeLow = `NULL`
	)

Get the slave select line behavior.

Parameters

mode	Frame mode: kChipSelect: active for the duration of the frame. kPreLatchPulse: pulses before the transfer of each frame. kPostLatchPulse: pulses after the transfer of each frame. kPreAndPostLatchPulse: pulses before and after each frame.
activeLow	True if slave select line is active low.

Returns: The slave select digital output.

Definition at line 329 of file SPI.cpp.

bool SPI::HadReceiveOverflow ( )

Determine if the receive FIFO was full when attempting to add new data at end of a transfer.

Returns: True if the receive FIFO overflowed.

Definition at line 421 of file SPI.cpp.

bool SPI::IsDone ( )

virtual

Have all pending transfers completed?

Returns: True if no transfers are pending.

Definition at line 407 of file SPI.cpp.

UINT32 SPI::Read ( bool initiate = false )

virtual

Read a word from the receive FIFO.

Waits for the current transfer to complete if the receive FIFO is empty.

If the receive FIFO is empty, there is no active transfer, and initiate is false, errors.

Parameters

initiate If true, this function pushes "0" into the transmit buffer and initiates a transfer. If false, this function assumes that data is already in the receive FIFO from a previous write.

Definition at line 468 of file SPI.cpp.

void SPI::Reset ( )

virtual

Stop any transfer in progress and empty the transmit FIFO.

Definition at line 513 of file SPI.cpp.

void SPI::SetBitsPerWord ( UINT32 bits )

Configure the number of bits from each word that the slave transmits or receives.

Parameters

bits	The number of bits in one frame (1 to 32 bits).

Definition at line 175 of file SPI.cpp.

void SPI::SetClockActiveHigh ( )

Configure the clock output line to be active high. This is sometimes called clock polarity low.

Definition at line 355 of file SPI.cpp.

void SPI::SetClockActiveLow ( )

Configure the clock output line to be active low. This is sometimes called clock polarity high.

Definition at line 346 of file SPI.cpp.

void SPI::SetClockRate ( double hz )

Configure the rate of the generated clock signal. The default and maximum value is 76,628.4 Hz.

Parameters

hz	The clock rate in Hertz.

Definition at line 197 of file SPI.cpp.

void SPI::SetLSBFirst ( )

Configure the order that bits are sent and received on the wire to be least significant bit first.

Definition at line 231 of file SPI.cpp.

void SPI::SetMSBFirst ( )

Configure the order that bits are sent and received on the wire to be most significant bit first.

Definition at line 222 of file SPI.cpp.

void SPI::SetSampleDataOnFalling ( )

Configure that the data is stable on the falling edge and the data changes on the rising edge.

Definition at line 240 of file SPI.cpp.

void SPI::SetSampleDataOnRising ( )

Configure that the data is stable on the rising edge and the data changes on the falling edge.

Definition at line 249 of file SPI.cpp.

void SPI::SetSlaveSelect	(	DigitalOutput *	ss,
		tFrameMode	mode = `kChipSelect`,
		bool	activeLow = `false`
	)

Configure the slave select line behavior.

Parameters

ss	slave select digital output.
mode	Frame mode: kChipSelect: active for the duration of the frame. kPreLatchPulse: pulses before the transfer of each frame. kPostLatchPulse: pulses after the transfer of each frame. kPreAndPostLatchPulse: pulses before and after each frame.
activeLow	True if slave select line is active low.

Definition at line 265 of file SPI.cpp.

void SPI::SetSlaveSelect	(	DigitalOutput &	ss,
		tFrameMode	mode = `kChipSelect`,
		bool	activeLow = `false`
	)

Configure the slave select line behavior.

Parameters

ss	slave select digital output.
mode	Frame mode: kChipSelect: active for the duration of the frame. kPreLatchPulse: pulses before the transfer of each frame. kPostLatchPulse: pulses after the transfer of each frame. kPreAndPostLatchPulse: pulses before and after each frame.
activeLow	True if slave select line is active low.

Definition at line 313 of file SPI.cpp.

void SPI::Write ( UINT32 data )

virtual

Write a word to the slave device. Blocks until there is space in the output FIFO.

If not running in output only mode, also saves the data received on the MISO input during the transfer into the receive FIFO.

Definition at line 436 of file SPI.cpp.

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation