Difference between revisions of "Component: SPI Free (Peripheral CAL)"

Latest revision as of 13:12, 7 February 2023

Author	Matrix Ltd
Version	1.2
Category	Peripheral CAL

SPI Free component

A low level implementation giving direct access to the CAL

Component Source Code

Please click here to download the component source project: FC_Comp_Source_SPI_Free.fcfx

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

Detailed description

No detailed description exists yet for this component

Examples

Example showing how to build a component using a CAL component Using CAL Components.

Macro reference

GetConsoleHandle

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

GetList

	GetList
returns Named property list
- STRING	Name

- STRING	Return

GetValue

	GetValue
Reads Named property Value.
- STRING	Name

- STRING	Return

Master_Byte

	Master_Byte
Sends and receives a data byte
- BYTE	DataOut

- BYTE	Return

Master_Init

	Master_Init
Initialise the Master
- VOID	Return

Master_Uninit

	Master_Uninit
Uninitialise the Master
- VOID	Return

SetPrescaler

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

- VOID	Return

SetValue

	SetValue
Change Named property to new Value.
- STRING	Name

- STRING	Value

- VOID	Return

Slave_Init

	Slave_Init
Initialise the Slave
- VOID	Return

Slave_RxByte

	Slave_RxByte
Returns the data received
- BYTE	Return

Slave_TxByte

	Slave_TxByte
Sets the data to be transmitted
- BYTE	Data

- VOID	Return

Slave_Uninit

	Slave_Uninit
Uninitialise the Slave
- VOID	Return

Property reference

	Properties
	Component Enable

	Channel
SPI Channel selector
	MOSI

	MOSI Remap Pin

	MISO

	MISO Remap Pin

	CLK

	Prescale
Prescale option selector
	Clock Polarity
Clock Polarity setting, inactive (idle) state
	Clock Phase
Clock Phase (data change edge) selection
	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

@@ Line 78: / Line 78: @@
 Example showing how to build a component using a CAL component [[Using_CAL_Components|Using CAL Components]].
@@ Line 84: / Line 92: @@
 ==Macro reference==
+===GetConsoleHandle===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Slave_Uninit'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetConsoleHandle'''
 |-
-| colspan="2" | Uninitialise the Slave&nbsp;
+| colspan="2" | Returns a handle to the console used by this component&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===GetList===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
 |-
-| colspan="2" | Reads Named property Value.  &nbsp;
+| colspan="2" | returns Named property list&nbsp;
 |-
 |-
@@ Line 115: / Line 125: @@
+===GetValue===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Slave_Init'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetValue'''
 |-
-| colspan="2" | Initialise the Slave&nbsp;
+| colspan="2" | Reads Named property Value.  &nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Name
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | &nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Master_Uninit'''
 |-
-| colspan="2" | Uninitialise the Master&nbsp;
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===Master_Byte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 159: / Line 163: @@
+===Master_Init===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetConsoleHandle'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Master_Init'''
 |-
-| colspan="2" | Returns a handle to the console used by this component&nbsp;
+| colspan="2" | Initialise the Master&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===Master_Uninit===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Slave_TxByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Master_Uninit'''
 |-
-| colspan="2" | Sets the data to be transmitted&nbsp;
+| colspan="2" | Uninitialise the Master&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Data
 |-
-| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 190: / Line 191: @@
+===SetPrescaler===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Slave_RxByte'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPrescaler'''
+|-
+| colspan="2" | Sets the prescaler value for the clock divider chain&nbsp;
+|-
 |-
-| colspan="2" | Returns the data received&nbsp;
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Prescaler
 |-
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===SetValue===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 226: / Line 234: @@
+===Slave_Init===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPrescaler'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Slave_Init'''
 |-
-| colspan="2" | Sets the prescaler value for the clock divider chain&nbsp;
+| colspan="2" | Initialise the Slave&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Prescaler
 |-
-| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 244: / Line 248: @@
+===Slave_RxByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Master_Init'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Slave_RxByte'''
 |-
-| colspan="2" | Initialise the Master&nbsp;
+| colspan="2" | Returns the data received&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===Slave_TxByte===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetList'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Slave_TxByte'''
 |-
-| colspan="2" | returns Named property list&nbsp;
+| colspan="2" | Sets the data to be transmitted&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Name
+| width="90%" | Data
 |-
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===Slave_Uninit===
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Slave_Uninit'''
+|-
+| colspan="2" | Uninitialise the Slave&nbsp;
+|-
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}