Jump to content

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

From Flowcode Help
← Older editNewer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
No edit summary
No edit summary
Line 16: Line 16:


==Component Source Code==
==Component Source Code==
Please click here to download the component source project: [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]
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 32: Line 36:


==Examples==
==Examples==




Line 46: Line 52:


==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:21, 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 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

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


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


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
Writes a the minimum number of instructions to the device memory. Takes the values from the data array. 
- ULONG Address
 
- ULONG Data
 
- VOID Return


EraseAll
Erase all flash memory locations on the device. 
- BOOL Aux
0=Primary Flash, 1=Aux Flash if available 
- 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
 

==Macro reference==

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


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


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
Writes a the minimum number of instructions to the device memory. Takes the values from the data array. 
- ULONG Address
 
- ULONG Data
 
- VOID Return


EraseAll
Erase all flash memory locations on the device. 
- BOOL Aux
0=Primary Flash, 1=Aux Flash if available 
- 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
 

==Macro reference==

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


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


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
Writes a the minimum number of instructions to the device memory. Takes the values from the data array. 
- ULONG Address
 
- ULONG Data
 
- VOID Return


EraseAll
Erase all flash memory locations on the device. 
- BOOL Aux
0=Primary Flash, 1=Aux Flash if available 
- 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
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_FLASH_(CAL)_(Misc)&oldid=33317"