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

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==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 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==
 
==Detailed description==
 +
 +
  
  
Line 30: Line 32:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 42: Line 46:
  
 
==Macro reference==
 
==Macro reference==
 +
 +
{| 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;" | '''WriteInstructionRow'''
 +
|-
 +
| colspan="2" | Writes a complete row of instructions to the device memory. Takes the values from the data array. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''ErasePage'''
 +
|-
 +
| colspan="2" | Erase the minimum amount of flash (usually a page) at the selected address. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Start address of page 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''ReadInstruction'''
 +
|-
 +
| colspan="2" | Reads a single instruction from the device memory. Loads the result into the Data array. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" | Start address of page 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''WriteInstruction'''
 +
|-
 +
| colspan="2" | Writes a the minimum number of instructions to the device memory. Takes the values from the data array. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Address
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
{| 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;" | '''EraseAll'''
 +
|-
 +
| colspan="2" | Erase all flash memory locations on the device. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Aux
 +
|-
 +
| colspan="2" | 0=Primary Flash, 1=Aux Flash if available 
 +
|-
 +
| 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;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Enabled
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Type
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | StartAddress
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Bits Per Instruction
 +
|-
 +
| colspan="2" | Number of bits that can be stored or retreived using a single flash address 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Bits Per Value
 +
|-
 +
| colspan="2" | Number of bits available when initialising the Flash memory. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Min Write Count
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Row Instruction Count
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Page Instruction Count
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Program Counter Increment
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Family
 +
|-
 +
| colspan="2" |  
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 15:14, 20 January 2023

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 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

Fc9-comp-macro.png WriteInstructionRow
Writes a complete row of instructions to the device memory. Takes the values from the data array. 
Fc9-u32-icon.png - ULONG Address
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ErasePage
Erase the minimum amount of flash (usually a page) at the selected address. 
Fc9-u32-icon.png - ULONG Address
Start address of page 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadInstruction
Reads a single instruction from the device memory. Loads the result into the Data array. 
Fc9-u32-icon.png - ULONG Address
Start address of page 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteInstruction
Writes a the minimum number of instructions to the device memory. Takes the values from the data array. 
Fc9-u32-icon.png - ULONG Address
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png EraseAll
Erase all flash memory locations on the device. 
Fc9-bool-icon.png - BOOL Aux
0=Primary Flash, 1=Aux Flash if available 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Enabled
 
Fc9-type-21-icon.png Type
 
Fc9-type-21-icon.png StartAddress
 
Fc9-type-21-icon.png Bits Per Instruction
Number of bits that can be stored or retreived using a single flash address 
Fc9-type-21-icon.png Bits Per Value
Number of bits available when initialising the Flash memory. 
Fc9-type-21-icon.png Min Write Count
 
Fc9-type-21-icon.png Row Instruction Count
 
Fc9-type-21-icon.png Page Instruction Count
 
Fc9-type-21-icon.png Program Counter Increment
 
Fc9-type-16-icon.png Family
 

==Macro reference==

Fc9-comp-macro.png WriteInstructionRow
Writes a complete row of instructions to the device memory. Takes the values from the data array. 
Fc9-u32-icon.png - ULONG Address
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ErasePage
Erase the minimum amount of flash (usually a page) at the selected address. 
Fc9-u32-icon.png - ULONG Address
Start address of page 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadInstruction
Reads a single instruction from the device memory. Loads the result into the Data array. 
Fc9-u32-icon.png - ULONG Address
Start address of page 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WriteInstruction
Writes a the minimum number of instructions to the device memory. Takes the values from the data array. 
Fc9-u32-icon.png - ULONG Address
 
Fc9-u32-icon.png - ULONG Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png EraseAll
Erase all flash memory locations on the device. 
Fc9-bool-icon.png - BOOL Aux
0=Primary Flash, 1=Aux Flash if available 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-7-icon.png Enabled
 
Fc9-type-21-icon.png Type
 
Fc9-type-21-icon.png StartAddress
 
Fc9-type-21-icon.png Bits Per Instruction
Number of bits that can be stored or retreived using a single flash address 
Fc9-type-21-icon.png Bits Per Value
Number of bits available when initialising the Flash memory. 
Fc9-type-21-icon.png Min Write Count
 
Fc9-type-21-icon.png Row Instruction Count
 
Fc9-type-21-icon.png Page Instruction Count
 
Fc9-type-21-icon.png Program Counter Increment
 
Fc9-type-16-icon.png Family
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_FLASH_(CAL)_(Misc)&oldid=32562"