Difference between revisions of "Component: Serial Flash (W25) (EEPROM)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==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_SerialFlash_W25Q.fcfx FC_Comp_Source_SerialFlash_W25Q.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_SerialFlash_W25Q.fcfx FC_Comp_Source_SerialFlash_W25Q.fcfx]
  
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_SerialFlash_W25Q.fcfx FC_Comp_Source_SerialFlash_W25Q.fcfx]
 
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_SerialFlash_W25Q.fcfx FC_Comp_Source_SerialFlash_W25Q.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 44: Line 46:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 68: Line 72:
  
 
==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;" | '''WriteControl'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Status
 +
|-
 +
| colspan="2" | 1 = Write Enabled, 0 = Write Protected 
 +
|-
 +
| 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;" | '''ReadStatus'''
 +
|-
 +
| colspan="2" | Reads one of the internal status registers on the device 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Reg
 +
|-
 +
| colspan="2" | Selects which status register to read, 0 = Status or 1 = Status 2. 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| 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;" | '''ReadDataByte'''
 +
|-
 +
| colspan="2" | Reads a single data byte from the specified address. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | PageAddress
 +
|-
 +
| colspan="2" | Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ByteAddress
 +
|-
 +
| colspan="2" | A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| 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;" | '''ReadUniqueID'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ID
 +
|-
 +
| colspan="2" | 8-Byte data array to store the unique ID read back from the IC. 
 +
|-
 +
| 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;" | '''WriteDataArray'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | PageAddress
 +
|-
 +
| colspan="2" | Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ByteAddress
 +
|-
 +
| colspan="2" | A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Count
 +
|-
 +
| colspan="2" | Number of bytes to write. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| 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;" | '''EraseChip'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Blocking
 +
|-
 +
| colspan="2" | Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait 
 +
|-
 +
| 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;" | '''WriteDataByte'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | PageAddress
 +
|-
 +
| colspan="2" | Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ByteAddress
 +
|-
 +
| colspan="2" | A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Data byte to write 
 +
|-
 +
| 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;" | '''EraseBlock'''
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | EraseMode
 +
|-
 +
| colspan="2" | 0=4KB / 1=32KB / 2=64KB 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | PageAddress
 +
|-
 +
| colspan="2" | Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Blocking
 +
|-
 +
| colspan="2" | Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait 
 +
|-
 +
| 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;" | '''ReadDataArray'''
 +
|-
 +
| colspan="2" | Reads up to 256 data bytes starting from the specified address. Note that all bytes will be read from the same page. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | PageAddress
 +
|-
 +
| colspan="2" | Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ByteAddress
 +
|-
 +
| colspan="2" | A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Count
 +
|-
 +
| colspan="2" | Number of bytes to read. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" | Byta array to store the incoming read data. 
 +
|-
 +
| 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;" | '''Initialise'''
 +
|-
 +
| colspan="2" | Initialises the SPI bus ready for communications. 
 +
|-
 +
|-
 +
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Flash Properties
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Memory Size
 +
|-
 +
| colspan="2" | Sets the size of the flash memory available on the chip. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Number Bytes
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Number Pages
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | SPI Properties
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | SPI Channel selector 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Prescale
 +
|-
 +
| colspan="2" | Prescale option selector 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | MOSI
 +
|-
 +
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | MISO
 +
|-
 +
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | CLK
 +
|-
 +
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | CS / SS
 +
|-
 +
| colspan="2" | 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.  
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Simulate Comms
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | File Simulation
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 +
| width="90%" | Simulation File
 +
|-
 +
| colspan="2" | 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. 
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Unique ID Lower 32-bit
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Unique ID Upper 32-bit
 +
|-
 +
| colspan="2" |  
 +
|}==Macro reference==
  
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"

Revision as of 09:59, 27 January 2023

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

Fc9-comp-macro.png 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. 
Fc9-bool-icon.png - BOOL Status
1 = Write Enabled, 0 = Write Protected 
Fc9-void-icon.png - VOID Return


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


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


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE ID
8-Byte data array to store the unique ID read back from the IC. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-u8-icon.png - BYTE ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
Fc9-u8-icon.png - BYTE Count
Number of bytes to write. 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-bool-icon.png - BOOL Blocking
Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-u8-icon.png - BYTE ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
Fc9-u8-icon.png - BYTE Data
Data byte to write 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE EraseMode
0=4KB / 1=32KB / 2=64KB 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-bool-icon.png - BOOL Blocking
Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png Initialise
Initialises the SPI bus ready for communications. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Flash Properties
Fc9-type-16-icon.png Memory Size
Sets the size of the flash memory available on the chip. 
Fc9-type-21-icon.png Number Bytes
 
Fc9-type-21-icon.png Number Pages
 
Fc9-conn-icon.png SPI Properties
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-5-icon.png 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.  
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png 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. 
Fc9-conn-icon.png File Simulation
Fc9-type-10-icon.png 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. 
Fc9-type-21-icon.png Unique ID Lower 32-bit
 
Fc9-type-21-icon.png Unique ID Upper 32-bit
 

==Macro reference==

Fc9-comp-macro.png 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. 
Fc9-bool-icon.png - BOOL Status
1 = Write Enabled, 0 = Write Protected 
Fc9-void-icon.png - VOID Return


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


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


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE ID
8-Byte data array to store the unique ID read back from the IC. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-u8-icon.png - BYTE ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
Fc9-u8-icon.png - BYTE Count
Number of bytes to write. 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-bool-icon.png - BOOL Blocking
Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-u8-icon.png - BYTE ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
Fc9-u8-icon.png - BYTE Data
Data byte to write 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE EraseMode
0=4KB / 1=32KB / 2=64KB 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-bool-icon.png - BOOL Blocking
Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png Initialise
Initialises the SPI bus ready for communications. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Flash Properties
Fc9-type-16-icon.png Memory Size
Sets the size of the flash memory available on the chip. 
Fc9-type-21-icon.png Number Bytes
 
Fc9-type-21-icon.png Number Pages
 
Fc9-conn-icon.png SPI Properties
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-5-icon.png 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.  
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png 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. 
Fc9-conn-icon.png File Simulation
Fc9-type-10-icon.png 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. 
Fc9-type-21-icon.png Unique ID Lower 32-bit
 
Fc9-type-21-icon.png Unique ID Upper 32-bit
 

==Macro reference==

Fc9-comp-macro.png 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. 
Fc9-bool-icon.png - BOOL Status
1 = Write Enabled, 0 = Write Protected 
Fc9-void-icon.png - VOID Return


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


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


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE ID
8-Byte data array to store the unique ID read back from the IC. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-u8-icon.png - BYTE ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
Fc9-u8-icon.png - BYTE Count
Number of bytes to write. 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-bool-icon.png - BOOL Blocking
Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-u8-icon.png - BYTE ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
Fc9-u8-icon.png - BYTE Data
Data byte to write 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE EraseMode
0=4KB / 1=32KB / 2=64KB 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-bool-icon.png - BOOL Blocking
Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png Initialise
Initialises the SPI bus ready for communications. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Flash Properties
Fc9-type-16-icon.png Memory Size
Sets the size of the flash memory available on the chip. 
Fc9-type-21-icon.png Number Bytes
 
Fc9-type-21-icon.png Number Pages
 
Fc9-conn-icon.png SPI Properties
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-5-icon.png 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.  
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png 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. 
Fc9-conn-icon.png File Simulation
Fc9-type-10-icon.png 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. 
Fc9-type-21-icon.png Unique ID Lower 32-bit
 
Fc9-type-21-icon.png Unique ID Upper 32-bit
 

==Macro reference==

Fc9-comp-macro.png 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. 
Fc9-bool-icon.png - BOOL Status
1 = Write Enabled, 0 = Write Protected 
Fc9-void-icon.png - VOID Return


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


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


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE ID
8-Byte data array to store the unique ID read back from the IC. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-u8-icon.png - BYTE ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
Fc9-u8-icon.png - BYTE Count
Number of bytes to write. 
Fc9-u8-icon.png - BYTE Data
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-bool-icon.png - BOOL Blocking
Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-u8-icon.png - BYTE ByteAddress
A7-A0 : 8-bit Address within the page - Range 0x00 - 0xFF 
Fc9-u8-icon.png - BYTE Data
Data byte to write 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE EraseMode
0=4KB / 1=32KB / 2=64KB 
Fc9-u16-icon.png - UINT PageAddress
Address bits A23-A8 : 16-bit Address - Range 0x0000 - 0xFFFF 
Fc9-bool-icon.png - BOOL Blocking
Controls if the macro blocks until the erase cycle is complete. 0 = Don't Wait, 1 = Wait 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png Initialise
Initialises the SPI bus ready for communications. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Flash Properties
Fc9-type-16-icon.png Memory Size
Sets the size of the flash memory available on the chip. 
Fc9-type-21-icon.png Number Bytes
 
Fc9-type-21-icon.png Number Pages
 
Fc9-conn-icon.png SPI Properties
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-5-icon.png 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.  
Fc9-conn-icon.png Simulation
Fc9-type-7-icon.png 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. 
Fc9-conn-icon.png File Simulation
Fc9-type-10-icon.png 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. 
Fc9-type-21-icon.png Unique ID Lower 32-bit
 
Fc9-type-21-icon.png Unique ID Upper 32-bit
 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Serial_Flash_(W25)_(EEPROM)&oldid=34511"