Generic Flash Programmer User Guide: Intel® Quartus® Prime Standard Edition

Download PDF
ID 683491
Date 3/28/2022
Public
Document Table of Contents
Document Table of Contents x
1. Generic Flash Programmer User Guide Intel® Quartus® Prime Standard Edition
1. Generic Flash Programmer User Guide Intel® Quartus® Prime Standard Edition x
1.1. Supported Devices and Configuration Methods 1.2. Quad SPI Flash Byte-Addressing 1.3. Generic Flash Programmer Operation 1.4. Generic Flash Programmer Flow Templates (Convert Programming File) 1.5. Generic Flash Programmer Settings Reference 1.6. Generic Flash Programmer User Guide Revision History
1.3. Generic Flash Programmer Operation x
1.3.1. Generic Flash Programming (Convert Programming File Dialog Box) 1.3.2. Full Erase of Flash Memory Sectors
1.3.1. Generic Flash Programming (Convert Programming File Dialog Box) x
1.3.1.1. Step 1: Generate Primary Device Programming Files 1.3.1.2. Step 2: Generate Secondary Programming Files (Convert Programming Files) 1.3.1.3. Step 3: Program the Flash Memory Device
1.3.1.2. Step 2: Generate Secondary Programming Files (Convert Programming Files) x
1.3.1.2.1. Enabling Bitstream Encryption or Compression for Intel® Arria® 10 and Intel® Cyclone® 10 GX Devices 1.3.1.2.2. Defining a New Flash Memory Configuration Device 1.3.1.2.3. Modifying Programming Flows
1.4. Generic Flash Programmer Flow Templates (Convert Programming File) x
1.4.1. Initialization Flow Templates (Convert Programming File) 1.4.2. Program Flow Template (Convert Programming File) 1.4.3. Erase Flow Template (Convert Programming File) 1.4.4. Verify/Blank-Check/Examine Flow Template (Convert Programming File) 1.4.5. Termination Flow Template (Convert Programming File) 1.4.6. Programming Flow Action Properties
1.5. Generic Flash Programmer Settings Reference x
1.5.1. Convert Programming File Dialog Box 1.5.2. Device and Pin Options 1.5.3. Compression and Encryption Settings (Convert Programming File) 1.5.4. SOF Data Properties Dialog Box (Convert Programming File)
1. Generic Flash Programmer User Guide Intel® Quartus® Prime Standard Edition

1.4.6. Programming Flow Action Properties

The available programming flow Actions have the following properties:
Table 4.  Read Register (RR) Action Properties
Symbol Action Property Description
Read Register (RR) Performs a read operation that returns a list of data register bytes. Name Displays the name of the command that executes as part of the Action, such as Read ID and Read flag status register.
Command Hex value that executes the command, such as 0x70.
Data length (byte) Expected length of returned data. To read according to the .jic file, enter the value as JIC.
Expected data (Optional) For use with Expected data mask. The following are example entries:
  • 1 Byte: 0xAB
  • 2 Bytes: 0xAB 0xCD
  • 3 Bytes: 0xAB 0xCD 0xEF
To compare the actual read back data against the .jic file, enter the value as JIC.
Expected data mask (Optional) Specify this value if you specify the Expected data. The default value is zero. The operation compares the actual read back register values against the expected value and mask value, and reports error on mismatch. The following are example entries:
  • 1 Byte: 0xFF
  • 2 Bytes: 0xFF 0xFF
Delay (us) Delay after Command executes.
Attempt count The number of times to repeat the command. You can use the Expected data, Expected data mask, Delay and Attempt count to create a polling operation on a register value.
Command-Data (bus width) Ratio of command to data bus widths.
Table 5.  Write Register (WR) Action Properties
Action Description Property Description
Write Register (WR) Performs a write operation to a volatile or non-volatile register. Name Displays the name of the command that executes as part of the Action, such as Write enable or Write status register.
Command Hex value that executes the command, such as 0x70.
Data Data that you want to write into the register. If the command doesn't require data (for example, Write Enable), leave this property empty. The following are example entries:
  • 1 Byte: 0xAB
  • 2 Bytes: 0xAB 0xCD
Delay (us) Delay after Command executes.
Command-Data (Bus Width) Ratio of command to data bus widths.
Table 6.  Write Data (WD) Action Properties
Action Description Property Description
Write Data (WD) Performs a write operation of data into the flash memory. Name Displays the name of the command that executes as part of the Action, such as Page program.
Command Hex value that executes the command, such as 0x70.
Address Specifies the flash memory address that you want to start writing. To flash the .jic file, enter the value as JIC.
Data Data that you want to program into the flash device.2 To flash the .jic file, enter the value as JIC.
Page size (byte) Page size of this flash memory device. Typical value is 256 for most flash devices.
Addressing mode (byte) Specifies the number of bytes the flash memory device expects for an address (switch between 3 or 4 bytes). The mode must match the addressing mode that you specify in the Initialization flow.
Delay (us) Delay after Command executes.
Command-Address-Data (bus width) Ratio between command, address, and data bus widths.
Table 7.  Read Data (RD) Action Properties
Symbol Action Property Description
Read Data (WD) Performs a read operation of data from the flash memory. Name Displays the name of the command that executes as part of the Action, such as Read.
Command Hex value that executes the command, such as 0x70.
Address Specifies the flash memory address that you want to start reading. To read according to the .jic file, enter the value as JIC.
Data length (byte) Expected length of returned data. To read according to the .jic file, enter the value as JIC.
Expected data (Optional) For use with Expected data mask. The following are example entries:
  • 1 Byte: 0xAB
  • 2 Bytes: 0xAB 0xCD
  • 3 Bytes: 0xAB 0xCD 0xEF
To compare the actual read back data against the .jic file, enter the value as JIC.
Expected data mask If you specify the Expected data mask, then the operation compares the actual read back data against the expected value and mask value, and reports an error on mismatch. If you want to compare against the .jic file, enter the value as JIC.
Addressing mode (byte) Specifies the number of bytes the flash memory device expects for an address (switch between 3 or 4 bytes). The mode must match the addressing mode that you specify in the Initialization flow.
Dummy clock cycle Specifies the number of dummy clock cycles subsequent to the Command.
Delay (us) Delay after Command executes.
Command-Address-Data (bus width) Ratio between command, address, and data bus widths.
Table 8.  Erase (E) Action Properties
Symbol Action Property Description
Erase (E) Performs an erase of data from the flash memory. Name Displays the name of the command that executes as part of the Action, such as Erase sector.
Command Hex value that executes the command, such as 0x70.
Address Specifies the flash memory address that you want to start erasing. The address must be aligned with Erase size. If you want to flash the .jic file, enter the value as JIC.
Erase size Specifies the erase size (in Bytes).
Addressing mode Specifies the number of bytes the flash memory device expects for an address (switch between 3 or 4 bytes). The mode must match the addressing mode that you specify in the Initialization flow.
Delay Delay after Command executes.
Command-Address (Bus Width) Ratio of command to address bus widths.
2 You can specify the Data value in hex, decimal, or a mixture of both. The max entry cannot exceed 32727. For hex entry, 1 byte (0xAA) equals 5 characters for a max entry of 6553 hex characters. The Data value you specify must match the number of bytes for the page size of 256.
Level Two Title