Kersing at 22:21, 21 December 2014

2014-12-21T22:21:48Z

Kersing at 22:21, 21 December 2014

2014-12-21T22:21:27Z

Kersing: Flash EEPROM component

2014-12-21T21:57:47Z

Flash EEPROM component

New page

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| The-Box Development
|-
| width="20%" style="color: gray;" | Version
| 1.0
|-
| width="20%" style="color: gray;" | License
| BSD
|-
| width="20%" style="color: gray;" | Category
| Storage
|}

==[[File:Flash-eeprom.png|Image]] Flash EEPROM component==
The Flash EEPROM component provides EEPROM emulation for PIC24 and dsPIC series controllers using Flash memory.
The component simulates persistence between runs using an external file to store the information.

The component provides storage for 253 words of 16 bits (UINT).

The component uses a wear leveling algorithm which requires 2 full 'erase' pages of memory. The 'erase' page size for a particular device
can be found in the data sheet. Look for the 'erase program memory block size', typically a value of 1536 or 3072 bytes (512 or 1536 words).

'''NOTE''' The component stores values in primary flash. This part of flash memory will be wiped when programming new code to the controller!

==Downloadable macro reference==

===<tt>Initialise</tt>===
Initialize the internal state of the component.

'''Parameters'''

''No parameters''

'''Return value'''

:[[Variable Types|BYTE]]
The macro returns 0 when successful. Any value unequal 0 means failure.

===<tt>Read</tt>===
Reads one word of 16 bits (UINT).

'''Parameters'''

:[[Variable Types|Byte]] ''address''
::The address to read the data from. The address should not exceed 253.

'''Return value'''

:[[Variable Types|UINT]]

===<tt>Write</tt>===
Write a 16 bit word (UINT) to memory.

'''Parameters'''

:[[Variable Types|BYTE]] ''address''
::The address to write the data to. The address should not exceed 253.

:[[Variable Types|UINT]] ''value''
::The 16 bit value to store.

'''Return value'''

:[[Variable Types|BYTE]]
The macro returns 0 when successful. Any value unequal 0 means failure.

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Simulation file

This property is of type ''Filename''

The name of the file to store data during simulation runs.

Auto Address

This property is of type ''True or false'' and can be referenced with the variable name ''AUTOADDR''.

If set to 'Yes' the component will automatically allocate the required flash memory. If set to ''No'' the property ''Address''
should be set to a valid value.

Address

This property is of type ''Unsigned Integer'' and can be referenced with the variable name ''FLASHADDRESS''.

This property is only available if ''Auto Address'' is set to ''No''. Set to a valid address in flash memory beyond the
end address of the program. The value must be at the start of an 'erase' page and there should be at least two full 'erase'
pages of flash available after the address. Do not use this feature if you are unsure which address can safely be used.

@@ Line 102: / Line 102: @@
 pages of flash available after the address. Do not use this feature if you are unsure which address can safely be used.
-==Component==
+==Download==
 The component can be downloaded from the [http://www.matrixtsl.com/mmforums/viewtopic.php?f=58&t=15932 Matrix user forum]

← Older revision		Revision as of 22:21, 21 December 2014
Line 101:		Line 101:
	end address of the program. The value must be at the start of an 'erase' page and there should be at least two full 'erase'		end address of the program. The value must be at the start of an 'erase' page and there should be at least two full 'erase'
	pages of flash available after the address. Do not use this feature if you are unsure which address can safely be used.		pages of flash available after the address. Do not use this feature if you are unsure which address can safely be used.
		+
		+	==Component==
		+	The component can be downloaded from the [http://www.matrixtsl.com/mmforums/viewtopic.php?f=58&t=15932 Matrix user forum]

Flash EEPROM component - Revision history

Kersing at 22:21, 21 December 2014

Kersing at 22:21, 21 December 2014

Kersing: Flash EEPROM component