Customizable Flash Programmer User Guide

Download PDF
ID 683271
Date 4/28/2023
Public
Document Table of Contents
Document Table of Contents x
1. Customizable Flash Programmer Overview 2. Customizable Flash Programmer 3. Implementing the Customizable Flash Programmer 4. Document Revision History for the Customizable Flash Programmer User Guide
1. Customizable Flash Programmer Overview x
1.1. Device Family Support 1.2. Software Support
2. Customizable Flash Programmer x
2.1. Programmer Image 2.2. System Console TCL Script 2.3. Limitations and Restrictions
3. Implementing the Customizable Flash Programmer x
3.1. Generating the Raw Programming Data File (.rpd) from User Design 3.2. Compiling the Programmer Image Project and Generating the .sof File 3.3. Customizing the TCL Script 3.4. Programming the Flash Using the System Console
3.1. Generating the Raw Programming Data File (.rpd) from User Design x
3.1.1. Understanding Quad SPI Flash Byte-Addressing 3.1.2. Understanding Dummy Clock Cycles for Single and Quad IO Fast Read 3.1.3. Generating the .rpd File Using the Convert Programming File Tool
3.1.3. Generating the .rpd File Using the Convert Programming File Tool x
3.1.3.1. Generating .rpd File for Intel® Arria® 10 and Intel® Cyclone® 10 GX Devices 3.1.3.2. Generating .rpd File for Other FPGA Devices
3.2. Compiling the Programmer Image Project and Generating the .sof File x
3.2.1. Configuring the IP Cores Setting 3.2.2. Assigning External Clock Source for the IP Cores 3.2.3. Generating the Programmer Image .sof File from the Reference Project
3.2.1. Configuring the IP Cores Setting x
3.2.1.1. Configuring JTAG to Avalon® Master Bridge IP Core 3.2.1.2. Configuring Intel AvMM Bursting Master IP Core 3.2.1.3. Configuring Generic Serial Flash Interface IP Core
3.3. Customizing the TCL Script x
3.3.1. TCL Script Structures 3.3.2. TCL Script User Setting 3.3.3. Customizing the Programming Flow 3.3.4. Creating Custom Functions
3.4. Programming the Flash Using the System Console x
3.4.1. Executing Commands in the System Console 3.4.2. Executing the System-Console Commands in the Nios® II Command Shell
1. Customizable Flash Programmer Overview
2. Customizable Flash Programmer
3. Implementing the Customizable Flash Programmer
4. Document Revision History for the Customizable Flash Programmer User Guide

3.3.2. TCL Script User Setting

You may use any text editor to edit the TCL script under the User Setting section.

Table 5.  TCL Script User Setting
Setting Options Description
chip_select 0, 1, 2 Specify the access to which flash attached to the FPGA. Only applicable to Intel® Arria® 10 and Intel® Cyclone® 10 GX. For other FPGA devices, always set to 0.
byte_addressing 0, 1

Select the flash byte-addressing mode.

  • 0 = 3-byte addressing
  • 1 = 4-byte addressing
dummy_clock N Specify the number of dummy clock cycles for the flash commands. Refer to the third-party quad SPI flash datasheet.
baud_rate 1 – 16

Specify the IP clock divisor for the quad SPI clock.

  • 1 = div2
  • 2 = div4
  • 3 = div6
  • 16 = div32

For example, if baud_rate = 1, the IP clock is 100 MHz, the quad SPI clock is 50 MHz.

cs_assert_delay N Specify the delay clock cycles before asserting nCS to initiate the flash command.
read_opcode flash read opcode Enter the flash read opcode. Refer to the third-party quad SPI flash datasheet for flash read opcode.
write_opcode flash write opcode Enter the flash write opcode. Refer to the third-party quad SPI flash datasheet for flash write opcode.
polling_opcode 0x05 Applicable to all flash devices except Micron flash device.
0x70 Only applicable to Micron flash device.
verify_during_programming 0, 1

Verify the written data on the fly.

Intel recommends setting verify_during_programming = 1 for first time programming to ensure the script works. For subsequent programming, set verify_during_programming = 0 to reduce programming time.

burst_auto 0, 1 Set burst_auto = 1 to improve programming time. Set burst_auto = 0 if burst auto mode is unstable.
source <extended_script>.tcl <Extended TCL script file> Source for extended TCL script. For example, to source for Micron-specific flash commands in an extended TCL scripts, use this command: source micron_mt25q.tcl.
Level Two Title