Component: FLASH (CAL) (Misc): Difference between revisions

Latest revision as of 14:22, 13 July 2026

Author	Matrix TSL
Version	1.0
Category	Misc

FLASH (CAL) component

CAL - Code Abstraction Layer A low level implementation giving direct access to Flash read and write routines.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

EraseAll

	EraseAll
Erase all flash memory locations on the device.
- BOOL	Aux
0=Primary Flash, 1=Aux Flash if available
- VOID	Return

ErasePage

	ErasePage
Erase the minimum amount of flash (usually a page) at the selected address.
- ULONG	Address
Start address of page
- VOID	Return

ReadInstruction

	ReadInstruction
Reads a single instruction from the device memory. Loads the result into the Data array.
- ULONG	Address
Start address of page
- ULONG	Data

- VOID	Return

WriteInstruction

	WriteInstruction
Writes a the minimum number of instructions to the device memory. Takes the values from the data array.
- ULONG	Address

- ULONG	Data

- VOID	Return

WriteInstructionRow

	WriteInstructionRow
Writes a complete row of instructions to the device memory. Takes the values from the data array.
- ULONG	Address

- ULONG	Data

- VOID	Return

Property reference

	Properties
	Enabled

	Type

	StartAddress

	Bits Per Instruction
Number of bits that can be stored or retreived using a single flash address
	Bits Per Value
Number of bits available when initialising the Flash memory.
	Min Write Count

	Row Instruction Count

	Page Instruction Count

	Program Counter Increment

	Family

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_FLASH.fcfx FC_Comp_Source_FLASH.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_FLASH.fcfx FC_Comp_Source_FLASH.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_FLASH.fcfx FC_Comp_Source_FLASH.fcfx]
 ==Detailed description==
@@ Line 28: / Line 40: @@
 ==Examples==
@@ Line 37: / Line 59: @@
-==Downloadable macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+==Macro reference==
+===EraseAll===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteInstructionRow'''
+| width="90%" class="mtx-class-macrohead" | '''EraseAll'''
 |-
-| colspan="2" | Writes a complete row of instructions to the device memory. Takes the values from the data array.&nbsp;
+| colspan="2" | Erase all flash memory locations on the device.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-| width="90%" | Address
+| width="90%" | Aux
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | 0=Primary Flash, 1=Aux Flash if available&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Data
-|-
-| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 62: / Line 94: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===ErasePage===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ErasePage'''
+| width="90%" class="mtx-class-macrohead" | '''ErasePage'''
 |-
 | colspan="2" | Erase the minimum amount of flash (usually a page) at the selected address.&nbsp;
@@ Line 80: / Line 113: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===ReadInstruction===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadInstruction'''
+| width="90%" class="mtx-class-macrohead" | '''ReadInstruction'''
 |-
 | colspan="2" | Reads a single instruction from the device memory. Loads the result into the Data array.&nbsp;
@@ Line 103: / Line 137: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===WriteInstruction===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WriteInstruction'''
+| width="90%" class="mtx-class-macrohead" | '''WriteInstruction'''
 |-
 | colspan="2" | Writes a the minimum number of instructions to the device memory. Takes the values from the data array.&nbsp;
@@ Line 126: / Line 161: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===WriteInstructionRow===
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''EraseAll'''
+| width="90%" class="mtx-class-macrohead" | '''WriteInstructionRow'''
 |-
-| colspan="2" | Erase all flash memory locations on the device.&nbsp;
+| colspan="2" | Writes a complete row of instructions to the device memory. Takes the values from the data array.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | Address
 |-
+| colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Aux
+| width="90%" | Data
 |-
-| colspan="2" | 0=Primary Flash, 1=Aux Flash if available&nbsp;
+| colspan="2" | &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''
 |}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-

SteveT (talk | contribs)