Component: Serial Flash (W25) (EEPROM)

Author	Matrix TSL
Version	1.0
Category	EEPROM

Serial Flash (W25) component

Component to allow support for the Winbond W25 range of SPI Flash devices. Compatible with various sizes of Flash including: 2Mb, 4Mb, 8Mb, 32Mb, 64Mb, 128Mb.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

WriteControl

	WriteControl
Enables or disables writing for things like erasing and programming. Writes must be enabled after a power on reset and again after an erase command.
- BOOL	Status
1 = Write Enabled, 0 = Write Protected
- VOID	Return

ReadStatus

	ReadStatus
Reads one of the internal status registers on the device
- BYTE	Reg
Selects which status register to read, 0 = Status or 1 = Status 2.
- BYTE	Return

ReadDataByte

	ReadDataByte
Reads a single data byte from the specified address.
- UINT	PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF
- BYTE	ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF
- BYTE	Return

ReadUniqueID

	ReadUniqueID
Reads the 8-byte unique identifier from the IC. Useful if you need each board to have it's own guarenteed unique address or identifier.
- BYTE	ID
8-Byte data array to store the unique ID read back from the IC.
- VOID	Return

WriteDataArray

	WriteDataArray
Writes an array of data bytes atarting at the specified address. Writes must be enabled and memory locations must be erased for data writes to function correctly. Note that all bytes will be written to the same page.
- UINT	PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF
- BYTE	ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF
- BYTE	Count
Number of bytes to write.
- BYTE	Data
- VOID	Return

EraseChip

	EraseChip
Erases all data stored on the chip. Chip erase takes between 20 seconds and 100 seconds to complete. Blocking mode is recommended to ensure write cycle is complete.
- BOOL	Blocking
Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait
- VOID	Return

WriteDataByte

	WriteDataByte
Writes a single data byte to the specified address. Writes must be enabled and memory locations must be erased for data writes to function correctly.
- UINT	PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF
- BYTE	ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF
- BYTE	Data
Data byte to write
- VOID	Return

EraseBlock

	EraseBlock
Erases a block of data stored on the chip. Erase takes between 45 milliseconds and 2000 milliseconds to complete. Blocking mode is recommended to ensure write cycle is complete.
- BYTE	EraseMode
0=4KB / 1=32KB / 2=64KB
- UINT	PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF
- BOOL	Blocking
Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait
- VOID	Return

ReadDataArray

	ReadDataArray
Reads up to 256 data bytes starting from the specified address. Note that all bytes will be read from the same page.
- UINT	PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF
- BYTE	ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF
- BYTE	Count
Number of bytes to read.
- BYTE	Data
Byta array to store the incoming read data.
- VOID	Return

Initialise

	Initialise
Initialises the SPI bus ready for communications.
- VOID	Return

Property reference

	Properties
	Flash Properties
	Memory Size
Sets the size of the flash memory available on the chip.
	Number Bytes
	Number Pages
	SPI Properties
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Simulation
	Simulate Comms
Decides how the simulation handles the data. No - Do no SPI simulation and allow all simulation data to come from a local text file. Yes - Use SPI simulation for use with Injector components etc.
	File Simulation
	Simulation File
Name of file to use to hold the contents of the simulated flash memory. $(srcdir) assigns the file to the same folder as the Flowcode project file.
	Unique ID Lower 32-bit
	Unique ID Upper 32-bit