Component: SPI (CAL) (Misc)

Author	Matrix TSL
Version	2.1
Category	Misc

SPI component

CAL = Code Abstraction Layer - Allows one code base to run on a wide range of chips. A low level implementation giving direct access to the Serial Peripheral Interface peripheral.

Component Source Code

Please click here to view the component source code (Beta): FC_Comp_Source_SPI.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

	Master_Enable_CS
Outputs a low signal to the chip select pin to select the remote slave device.
- VOID	Return

	Slave_Uninit
Uninitialise the Slave
- VOID	Return

	Prv_TextConsole
Send text to the SPI console. Exposed as part of the CAL_SPI component to allow none AutoCS pins and other.
- STRING	str
- BYTE	Colour
0=Default, 1=TX, 2=RX
- BYTE	AppendTimestamp
0=Don't Append / 1=Do Append
- VOID	Return

	Master_Transaction
Sends and receives data bytes via the SPI channel. The Buffer is to contain the data to be sent, and is overwritten by the retuning data from the device. Returns 1 for success, 0 for failure
- BYTE	Buffer
- UINT	Length
Number of bytes to transfer
- BYTE	Return

	GetValue
Reads Named property Value.
- STRING	Name
- STRING	Return

	Slave_Init
Initialise the Slave
- VOID	Return

	Master_Disable_CS
Outputs a high signal to the chip select pin to deselect the remote slave device.
- VOID	Return

	Master_Uninit
Uninitialise the Master
- VOID	Return

	Master_Byte
Sends and receives a data byte
- BYTE	DataOut
- BYTE	Return

	GetConsoleHandle
Returns a handle to the console used by this component
- HANDLE	Return

	Slave_TxByte
Sets the data to be transmitted to the SPI master.
- BYTE	Data
- VOID	Return

	Slave_RxByte
Returns the data received from the SPI Master
- BYTE	Return

	SetValue
Change Named property to new Value.
- STRING	Name
- STRING	Value
- VOID	Return

	SetPrescaler
Sets the prescaler value for the clock divider chain
- BYTE	Prescaler
- VOID	Return

	Master_Init
Initialise the Master
- BYTE	Return

	GetList
returns Named property list
- STRING	Name
- STRING	Return

Property reference

	Properties
	Component Enable
A global flag to enable or disable the SPI component from producing code. Useful for generating components with multiple communications options.
	Connections
	Channel
SPI Channel selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	Use Auto CS
Allow the SPI component to manage the CS pin for us in Master mode. On initialise the CS pin is automatically set high to disable the remote SPI device. Set to No if you want to create a component with multiple CS pins or if you want to manage the CS pin yourself.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	CS Polarity
	Options
	Mode
Configures the mode of the SPI component. Currently only Master mode is supported.
	Prescale
Prescale option selector
	Clock Phase
Clock Phase (data change edge) selection
	Clock Polarity
Clock Polarity setting, inactive (idle) state
	Sample Point
Data bit read sample point
	Simulation
	Scope Traces
Selects if the scope traces are automatically generated or not
	Console Data
Selects if the console data is automatically generated or not
	API
Selects the API Slave to use to send and receive real world SPI data during simulation.

==Macro reference==

	Master_Enable_CS
Outputs a low signal to the chip select pin to select the remote slave device.
- VOID	Return

	Slave_Uninit
Uninitialise the Slave
- VOID	Return

	Prv_TextConsole
Send text to the SPI console. Exposed as part of the CAL_SPI component to allow none AutoCS pins and other.
- STRING	str
- BYTE	Colour
0=Default, 1=TX, 2=RX
- BYTE	AppendTimestamp
0=Don't Append / 1=Do Append
- VOID	Return

	Master_Transaction
Sends and receives data bytes via the SPI channel. The Buffer is to contain the data to be sent, and is overwritten by the retuning data from the device. Returns 1 for success, 0 for failure
- BYTE	Buffer
- UINT	Length
Number of bytes to transfer
- BYTE	Return

	GetValue
Reads Named property Value.
- STRING	Name
- STRING	Return

	Slave_Init
Initialise the Slave
- VOID	Return

	Master_Disable_CS
Outputs a high signal to the chip select pin to deselect the remote slave device.
- VOID	Return

	Master_Uninit
Uninitialise the Master
- VOID	Return

	Master_Byte
Sends and receives a data byte
- BYTE	DataOut
- BYTE	Return

	GetConsoleHandle
Returns a handle to the console used by this component
- HANDLE	Return

	Slave_TxByte
Sets the data to be transmitted to the SPI master.
- BYTE	Data
- VOID	Return

	Slave_RxByte
Returns the data received from the SPI Master
- BYTE	Return

	SetValue
Change Named property to new Value.
- STRING	Name
- STRING	Value
- VOID	Return

	SetPrescaler
Sets the prescaler value for the clock divider chain
- BYTE	Prescaler
- VOID	Return

	Master_Init
Initialise the Master
- BYTE	Return

	GetList
returns Named property list
- STRING	Name
- STRING	Return

Property reference

	Properties
	Component Enable
A global flag to enable or disable the SPI component from producing code. Useful for generating components with multiple communications options.
	Connections
	Channel
SPI Channel selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	Use Auto CS
Allow the SPI component to manage the CS pin for us in Master mode. On initialise the CS pin is automatically set high to disable the remote SPI device. Set to No if you want to create a component with multiple CS pins or if you want to manage the CS pin yourself.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	CS Polarity
	Options
	Mode
Configures the mode of the SPI component. Currently only Master mode is supported.
	Prescale
Prescale option selector
	Clock Phase
Clock Phase (data change edge) selection
	Clock Polarity
Clock Polarity setting, inactive (idle) state
	Sample Point
Data bit read sample point
	Simulation
	Scope Traces
Selects if the scope traces are automatically generated or not
	Console Data
Selects if the console data is automatically generated or not
	API
Selects the API Slave to use to send and receive real world SPI data during simulation.