AN 061: Configuring Topaz FPGAs

About Configuring Topaz FPGAs

This document describes how to configure Topaz™ FPGAs. These FPGAs contain volatile Configuration RAM (CRAM) that you must configure with the desired logic function (via a bitstream) upon power-up and before the core enters normal operation. The Efinity® software generates the bitstream, which is design dependent.

Notice: Refer to the Efinity Software User Guide for information on how to generate the bitstream.

Bitstream Size

The bitstream size is dependent on the FPGA you choose and the configuration parameters you set in the Efinity software.

Table 1. Topaz™ FPGA Bitstream Size
FPGA Maximum Supported Configuration Bits (Single Image) Packages
Tz50 13,735,488 All
Tz75 38,440,704 All
Tz100 38,440,704 All
Tz110 50,096,640 All
Tz170 50,096,640 All
Tz200 105,994,048 All
Tz325 105,994,048 All

The Efinity software automatically compresses the bitstream; therefore, the bitstream size for a typical design should be about 50% of the maximum size shown.

Note: If you are using any of the Topaz security features, the software cannot compress the bitstream.

Bitstream Size for Multiple Images

The following table shows the approximate flash size required for one to four images with and without compression.

Important: These numbers are estimates based on typical designs; the actual size varies slightly depending on your design and could be larger than the values shown here.
Table 2. Bitstream Size for Multiple ImagesRounded to nearest Mbit
Uncomp. = Uncompressed
Comp. = Compressed
Number of Images Tz50 Tz75, Tz100 Tz110, Tz170 Tz200, Tz325
Uncomp. Maximum (Mbits) Comp. Typical (Mbits) Uncomp. Maximum (Mbits) Comp. Typical (Mbits) Uncomp. Maximum (Mbits) Comp. Typical (Mbits) Uncomp. Maximum (Mbits) Comp. Typical (Mbits)
1 14 8 38 19 50 25 106 64
2 28 16 76 38 100 50 212 128
3 42 24 114 57 150 75 318 192
4 56 32 152 76 200 100 424 256

Configuration Time

The FPGA configuration time depends on the frequency and data bus width. To estimate the configuration time for a given FPGA, use the following equation:

Configuration Time = Bitstream Size ÷ (Configuration Clock Frequency × Data Bus Width)

Note: The maximum configuration clock frequency depends on the configuration mode and implementation.
For example:
  • Tz50 FPGA—Assuming 8.85 Mbits of compressed configuration data:
  • Configuration clock frequency—10 MHz
  • Tz50 configuration data bus width—8 bits1

Configuration time: 8.85 Mbits ÷ (10MHz × 8 bits) = 110.625 ms

Planning Your Device Pinout

The configuration mode you choose affects your design's pinout. You should decide which mode you will use and plan for it before performing floorplanning or pin selection for your logic design.

Active and passive configuration modes use multi-function pins during configuration. When configuration completes, these multi-function pins are available for general use. JTAG configuration uses dedicated configuration pins that cannot be used for other functions. Additionally, the configuration mode you choose can affect the voltage restrictions for the I/O bank that contains the configuration pins.

Efinix® recommends that you:

  • Choose the configuration mode(s). Consider the primary configuration mode as well as configuration modes you may need for debugging or future updates.
  • Find the pin and the bank locations for the configuration mode(s).
  • Understand how you use these pins and any restrictions when using multi-function configuration pins as standard I/O pins. For example, consider internal and external pull-ups or pull-downs, connections to external devices, etc.
    Note: In some situations, you may want to use a multi-function configuration pin as an output pin in user mode. If the pin is driven by an external device during configuration, the source that drives this pin during configuration must be tri-stated before the device enters user mode and user logic begins driving it. Otherwise, the drivers can be in contention, and can damage the pin.
  • For each set of configuration pins, determine the common required I/O voltage support for the required configuration bank. You can only use compatible I/O standards elsewhere in that bank.

Other Factors to Consider

Although configuration is typically a one-time event independent of device operation, your configuration choices can affect your design options. Make configuration decisions early in the design cycle to eliminate challenges later:

  • Do you need to support JTAG configuration for debugging purposes?
  • How can you provide easy access to the configuration control and status pins for debugging?
  • What multi-function pins are you using in your logic design and are they active during configuration? If they are, check for conflicts with other uses of these pins.

Additionally, you should:

  • Provide quality signal integrity for key signals during PCB layout, including the configuration clock (even though configuration can operate at a low frequency).
  • Understand the configuration sequence to reduce configuration time.
  • Generate the configuration bitstream for your FPGA using Efinity tools.

Configuration Pins

Some configuration pins are dedicated, and some are dual-purpose.
  • Dedicated pins cannot be used as general purpose I/O.
  • During configuration, use dual-purpose pins as described in this document for the configuration mode you are using. After configuration (in user mode), you can use these pins as general-purpose I/O.
Table 3. Dedicated Configuration PinsThese pins cannot be used as general-purpose I/O after configuration.
All the pins are in internal weak pull-up during configuration mode except for TCK and TDO.
Calculate the resistor value as described in Resistors in Configuration Circuitry.
Pins Direction Description External Weak Pull Up/Pull Down Requirement
CDONE I/O Configuration done status pin. CDONE is an open drain output; connect it to an external pull-up resistor to VCCIO. When CDONE = 1, the configuration is complete and the FPGA enters user mode. You can hold CDONE low and release it to synchronize the FPGAs entering user mode. Pull up
CRESET_N Input Active-low FPGA reset and re-configuration trigger.
Pulse CRESET_N low for a duration of tcreset_N before releasing CRESET_N from low to high to initiate FPGA re-configuration. This pin does not perform a system reset.
 Pull up
TCK Input JTAG test clock input (TCK). The rising edge loads signals applied at the TAP input pins (TMS and TDI). The falling edge clocks out signals through the TAP TDO pin. Pull up
TMS Input JTAG test mode select input (TMS). The I/O sequence on this input controls the test logic operation . The signal value typically changes on the falling edge of TCK. TMS is typically a weak pull-up; when it is not driven by an external source, the test logic perceives a logic 1. Pull up
TDI Input JTAG test data input (TDI). Data applied at this serial input is fed into the instruction register or into a test data register depending on the sequence previously applied at TMS. Typically, the signal applied at TDI changes state following the falling edge of TCK while the registers shift in the value received on the rising edge. Like TMS, TDI is typically a weak pull-up; when it is not driven from an external source, the test logic perceives a logic 1. Pull up
TDO Output JTAG test data output (TDO). This serial output from the test logic is fed from the instruction register or a test data register depending on the sequence previously applied at TMS. The shift out content is based on the issued instruction. The signal driven through TDO changes state following the falling edge of TCK. When data is not being shifted through the device, TDO is set to an inactive drive state (e.g., high-impedance). Pull up
JTAG_VCCIO_SEL Input JTAG voltage select pin.
This pin affects the voltage for the bank in which it is located, or any banks merged with it. Supply VCCIO33_<bank name> with 1.8 V and connect a 1 kΩ external resistor between this pin and ground to use JTAG at 1.8 V.
Leave this pin floating to use the default JTAG at 3.3 V or 2.5 V.
For Tz75 and Tz100 FPGAs the JTAG_VCCIO_SEL bank is BR1.
For Tz200 and Tz325 FPGAs the JTAG_VCCIO_SEL bank is BR4.
 Floating or pull down
Table 4. Dual-Purpose Configuration PinsIn user mode (after configuration), you can use these dual-purpose pins as general I/O. Calculate the resistor value as described in Resistors in Configuration Circuitry.
Configuration Functions Direction Description External Weak Pull Up/Pull Down Requirement
CBSEL[1:0] Input Multi-image configuration selection pin. This function is not applicable to single-image bitstream configuration or internal reconfiguration (remote update).
Connect CBSEL[1:0] to the external resistors for the image you want to use:
00 for image 1
01 for image 2
10 for image 3
11 for image 4
0: Connect to an external weak pull down.
1: Connect to an external weak pull up.
 Pull up or pull down
CCK I/O Passive SPI input configuration clock or active SPI output configuration clock. Optional pull up if required by external load
CDIn I/O Data input for SPI configuration. n is a number from 0 to 31 depending on the SPI configuration data width.
CDI0 is an output in x1 active configuration mode and is a bidirectional pin in all other active configuration modes.
CDI4 is a bidirectional pin in x8 active configuration mode.
In a multi-bit daisy chain connection, CDI[31:0] connects to the data bus in parallel.
 Optional pull up if required by external load
CSI Input Chip select.
0: The FPGA is not selected or enabled and will not be configured.
1: Select the FPGA for all configuration modes.
Tz50 FPGAs require this setting for JTAG configuration mode.
FPGAs require this setting for JTAG configuration mode.
This pin is not bonded out in some of the smaller packages, such as the F100S3F2 and F100.
This pin is not bonded out in some of the smaller packages, such as the F100.
This pin is not bonded out in some of the smaller packages, such as the F100.
CSI must remain high throughout configuration.
 Pull up
CSO Output Chip select output. Asserted after configuration is complete. Connect this pin to the chip select pin of the next FPGA for daisy chain configuration. 3
This pin is not bonded out in some of the smaller packages, such as the F100S3F2 and F100.
This pin is not bonded out in some of the smaller packages, such as the F100.
This pin is not bonded out in some of the smaller packages, such as the F100.
 –
NSTATUS Output
Indicates a configuration error. When the FPGA drives this pin low, it indicates either an device mismatch or a failed bitstream CRC check.
–
SSL_N I/O
SPI configuration mode select. The FPGA senses the value of SSL_N when it comes out of reset (i.e., CRESET_N transitions from low to high).
0: Passive mode; connect to external weak pull down.
1: Active mode; connect to external weak pull up.
In active configuration mode, SSL_N is an active-low chip select to the flash device (CDI0 - CDI3).
 Pull up or pull down
SSU_N Output Active-low chip select to the upper flash device (CDI4 - CDI17) in active x8 configuration mode (dual quad mode).
Not available in W64, V64, F100S3F2, or F100 packages.
Not available in F100 packages.
Not available in F100 packages.
 Optional pull up if required by external load
EXT_CONFIG_CLK Input Alternative clock in active configuration mode. Optional pull up if required by external load
TEST_N Input Active-low test mode enable signal. Set to 1 to disable test mode.
During all configuration modes, rely on the external weak pull-up or drive this pin high.
Pull up
Note: Refer to the column Configuration Functions in the pinout file.

FPGA Configuration Modes

Topaz™ FPGAs have dedicated configuration pins. You select the configuration mode by setting the appropriate condition on the input configuration pins. Topaz™ FPGAs support the following configuration modes.

Table 5. FPGA Configuration Modes
Mode Description
SPI Active (serial/parallel) The FPGA loads the bitstream itself from non-volatile SPI flash memory.
SPI Passive (serial/parallel) An external microprocessor or microcontroller sends the bitstream to the FPGA using the SPI interface.
JTAG A host computer sends instructions through a download cable to the FPGA's JTAG interface using JTAG instructions.

Selecting the Configuration Mode

Each configuration interface corresponds to one or more configuration modes and bus widths.
  • Select the configuration mode by setting the appropriate condition on the SSL_N and TEST_N input pins. (The SSU_N pin can be any value.)
  • Do not toggle the mode pins before the FPGA enters user mode.
Table 6. SPI Hardware SettingsIf you do not make any connections, the default mode is serial x1 SPI active.
Configuration Mode CSI TEST_N SSL_N
SPI Active 1 1 1
SPI Passive 1 1 0
JTAG 1 1 N/A

The JTAG/boundary-scan configuration interface is always available regardless of pin settings. If you send configuration instructions to the JTAG interface, the Topaz FPGA overwrites the previous configuration.

Note: You must set the configuration mode in the Efinity® software; the software includes the mode and other configuration options in the bitstream.

The supported configuration modes are specific to the FPGA and package. Refer to the data sheet for information on the supported configuration modes.

About SPI Clocking and Sampling

Table 7. SPI Interface Clocking and Sampling
Mode Clock Sampling Edge
Passive The CCK clock comes from an external device Positive
Active The FPGA generates the CCK clock User configurable, the default is positive.
You can change this setting in the Efinity Project Editor > Bitstream Generation tab.
Important: Refer to the setup and hold times in the data sheet to ensure system timing closure based on your timing budget.

The microprocessor or microcontroller can set the SPI clock polarity (CPOL bit) and the clock phase (CPHA bit) when the interface is idle, which results in four modes, depending on how you set these bits. Use Mode 3 in your microprocessor or microcontroller when programming the FPGA.

Table 8. SPI Clock Polarity and Phase Modes
Mode Clock Polarity when Idle Data Sampled On Data Shifted On
0 Low Rising edge Falling edge
1 Low Falling edge Rising edge
2 High Falling edge Rising edge
3 High Rising edge Falling edge

Efinix uses Mode 3 for SPI passive mode, which is CPOL bit = 1 and CPHA bit =1 for all Topaz FPGA devices.

Figure 1. SPI Clock Polarity and Phase Modes Diagram

SPI Active Mode

In active mode, the FPGA loads configuration data itself from a configuration bitstream that typically resides in non-volatile memory on the same board. Active modes can be serial or parallel. The FPGA internally generates the configuration clock signal (CCK) and controls configuration by sending a clock or addresses to the flash memory.

The active SPI configuration mode supports low pin count, industry-standard external SPI flash devices to store the bitstream. The FPGA supports a direct connection to the flash device's four-pin SPI interface. Active SPI configuration mode can read from standard 1-bit serial SPI flash devices as well as from flash devices that support x2 and x4 fast output read operations. These modes are proportionally faster than the standard 1-bit SPI interface.

Note: Topaz Tz50 FPGAs only support SPI flash memory with 3-byte addressing mode for configuration.

For even faster loading times, Topaz FPGAs also support a x8 mode that uses two identical SPI flash devices.

Table 9. Active Mode Instructions
Instruction Description SPI Data Width
0BH Fast read x1
3BH Dual output fast read x2
6BH Quad output fast read, single flash device x4
Quad output fast read, two flash devices x8

SPI Active Mode without CSI

Topaz™ FPGAs in smaller pin count packages, such as the F100, may not have the CSI signals bonded out. This pinout limits your programming options. Without CSI, you cannot use cascade configuration.

The schematics for programming without CSI are the same as the regular SPI active schematics except that you do not connect the CSI signal.
Important: Daisy-chain configuration is not supported in packages without CSI.

SPI Active Clocking

An internal oscillator or external clock generates the clocks the FPGA uses during configuration. In SPI active configuration mode, configuration starts operating at the default frequency (10 MHz) and then switches to the user-selected clock to minimize configuration time (assuming the SPI flash device supports the faster fMAX).

You set the configuration clock frequency in the Efinity® software.

Table 10. Clock Setting Recommendations
Clock Source Divider Frequency (MHz) (Typical) Sample On (Default)
Internal Oscillator DIV8 10 Positive edge
Internal Oscillator DIV4 20 Positive edge
Internal Oscillator DIV2 40 Negative edge
Internal Oscillator DIV1 80 Negative edge
External Clock — <40 Positive edge
40 - 125 Negative edge
Note: A free running external clock is required during bitstream generation if External Clock is selected as the Clock Source. Toggling a non-continuous external clock after warm boot will result in configuration failure, and CDONE does not go high.
Note: These sampling recommendations are for typical cases. It is likely that high-speed clocking requires negative edge sampling at the FPGA. In practice, the sampling edge you need to use depends on the round-trip delay, that is, the total delay from the clock edge sent from the FPGA to the flash, the tCO of the flash memory (which can be quite high), and the return data trip back to the FPGA. Therefore, you should consider your board design and choice of flash device when determining whether to sample the positive or negative edge.

SPI Flash Address Width

Table 11. Supported SPI Flash Address Width for Configuration
Device SPI Flash Address Width
24 bit (3-byte Addressing) 32 bit (4-byte Adressing)
Tz50 -
Tz75, Tz100, Tz110, Tz170, ​ Tz200, Tz325

Refer to Project-Based Programming Options for information about enabling 4-byte addressing in the Efinity software.

SPI Passive Mode

In passive mode, the FPGA receives the configuration clock and data from an external active module, such as an external microprocessor or microcontroller. This mode supports a data width of up to 32 bits.

Notice: Refer to the Topaz™ device data sheet for the widths your device supports.

Design considerations are similar to active configuration except CCK must be driven from an external clock source. Each configuration image contains a synchronization pattern. When the Topaz™ FPGA detect the synchronization pattern, it begins configuration. The external active device must supply data continuously on every clock until configuration ends.

Note: Efinix recommends that you use the same VCCIO on the banks of all configuration pins.

SPI Passive Mode without CSI

Topaz™ FPGAs in smaller pin count packages, such as the F100, may not have the CSI signal bonded out. This pinout limits your programming options.
  • Without CSI, you cannot use cascade configuration.

The schematics for programming without CSI are the same as the regular SPI active schematics except that you do not connect the CSI signal.

JTAG Mode

The JTAG serial configuration mode is popular for prototyping and board testing. The four-pin JTAG boundary-scan interface is commonly available on board testers and debugging hardware.

Efinix FPGAs support IEEE standard 1149.1 - 2001.

Notice: Refer to the following web sites for more information about the JTAG interface:
http://ieeexplore.ieee.org/document/6515989/
https://en.wikipedia.org/wiki/JTAG

Table 12. Supported Topaz and Titanium JTAG Instructions
Instruction Binary Code [4:0] Description
BYPASS 11111 Enables BYPASS.
DEVICE_STATUS 01100 Lets you read the device configuration status.
EFUSE_PREWRITE 11000 Loads user data for fuse operations.
EFUSE_USER_WRITE 11010 Blows fuses as defined in EFUSE_PREWRITE.
EFUSE_WRITE_STATUS 11011 Returns status of EFUSE_USER_WRITE operation.
ENTERUSER 00111 Changes the FPGA into user mode.
EXTEST 00000 Enables the boundary-scan EXTEST operation.
IDCODE 00011 Enables shifting out the IDCODE.
INTEST 00001 Enables the boundary-scan INTEST operation.
JTAG_USER1 01000 Connects the JTAG User TAP 1.
JTAG_USER2 01001 Connects the JTAG User TAP 2.
JTAG_USER3 01010 Connects the JTAG User TAP 3.
JTAG_USER4 01011 Connects the JTAG User TAP 4.
PROGRAM 00100 JTAG configuration.
SAMPLE/PRELOAD 00010 Enables the boundary-scan SAMPLE/PRELOAD operation.
USERCODE 01101 Use this instruction to program a 32-bit signature into the FPGA during programming.

Notice: Refer to AN 038: Programming with an MCU and the JTAG Interface for more information about programming Efinix® FPGAs with a microcontroller using JTAG mode.

Connect the FPGA pins as shown in the following diagrams.
Figure 2. JTAG Programming (Tz50 FPGAs with CSI) . See Resistors in Configuration Circuitry for the resistor values.
Figure 3. JTAG Programming (Other FPGAs) . See Resistors in Configuration Circuitry for the resistor values.

The CRESET_N signal needs to be deasserted before JTAG configuration begins. When configuration ends, the JTAG host issues the ENTERUSER instruction to the FPGA. After CDONE goes high and the FPGA receives the ENTERUSER instruction, the FPGA waits for tUSER to elapse, and then it goes into user mode.

Note: The FPGA may go into user mode before tUSER has elapsed. Therefore, you should keep the system interface with the FPGA in reset until tUSER has elapsed.

Figure 4. JTAG Programming Waveform
Figure 5. JTAG Programming Waveform (Detailed View)
Note: Refer to "Power-up Sequence" in the Topaz™ data sheet for power-up details.
Note: Refer to the data sheet for timing specifications.
Important: You can only use a single configuration channel (SPI or JTAG) at the same time. Using both at the same time can result in configuration failure. Therefore, the SPI bus must be inactive during JTAG configuration.
Note: The waveform is shown from the control block perspective and it is required to connect to weak internal pull-up resistors.

Using FPGA, MCU, and SPI Flash Devices Together

Most applications include some combination of FPGA, MCU, and SPI flash in the system design. How you connect the FPGA, MCU, and SPI flash determines the configuration mode and the configuration sequence.

Flash Programming Modes

The following table shows the methods you can use to program the configuration bitstream into the flash device on your board. Although you can program the flash directly using the SPI interface, this method requires that you have a SPI header on your board or use an FDTI chip. Therefore, Efinix recommends that you use a JTAG bridge, because that method only requires a JTAG header, which you would typically have on your board for other purposes.

Table 13. Flash Programming Modes
Mode Description
SPI Active (serial/parallel) Use the Efinity Programmer and a cable connected to a SPI header on the board.
SPI Active using JTAG Bridge (New) A improved version of the SPI Active using JTAG Bridge (Legacy) mode with a faster flash programming time.
SPI Active x8 using JTAG Bridge (New) A improved version of the SPI Active x8 using JTAG Bridge (Legacy) mode with a faster flash programming time.
Notice: Refer to Program using a JTAG Bridge for more information.

Figure 6. Flash Programming Board Setup: SPI Active (Serial/Parallel)

Figure 7. Flash Programming Board Setup: SPI Active Using JTAG Bridge (New)

Figure 8. Flash Programming Board Setup: SPI Active x8 Using JTAG Bridge (New)

Important: Depending upon your vendor, your flash device may have been programmed in the factory. If this is the case, your vendor may have set the Status Register Protect (SRP) bits to protect the software and/or hardware, to prevent power supply lock-down, or to otherwise make the device one-time programmable. To overcome this issue, you will need to check your device flash specifications and status to ensure that it is quad enabled before attempting to re-program the device. The following table outlines the various states of the SRP bits.
Table 14. Status Register Protect Bits
SRP1 SRP2 /WP Status Register Description
0 0 X Software Protection /WP pin has no control. Following a Write Enable instruction, the status register is writable, WEL=1.
0 1 0 Hardware Protected When /WP is low, the status register is locked and is unwritable.
0 1 1 Hardware Unprotected When /WP is high, the status register is unlocked. A Write Enable instruction will make the status register writable, WEL=1.
1 0 X Power Supply Lock-Down The status register is locked and cannot be written to again until the next power-up cycle.
1 1 X One Time Program The status register is permanently protected.

Flash Programming Using Microcontroller

After JTAG has been disabled, you can program the internal SPI flash through the SPI bus with a microprocessor.

Note: The microprocessor can be an off-chip device, such as a programming cable run through the header connection.
To start updating the internal flash, use the microprocessor to:
  1. Drive CRESET_N low
  2. Drive CS - SSL_N low
  3. Begin programming the internal flash.
Figure 9. SPI Flash Programming with Microprocessor
Note: Refer to Using FPGA, MCU, and SPI Flash Devices Together for more information.

Power Sequence

Note: For information regarding the power-up sequence, power-down sequence, and power supply current transient, refer to the Topaz Data Sheets in Documentation page of the Support Center

Power Up Configuration Circuitry Recommendation

You can use one of the following methods to hold the CRESET_N pin of the Topaz™ FPGA low after the power supplies are stable:

  • Supervisor integrated circuit (IC)
  • Microprocessor or microcontroller
Important: Do not drive a signal to any Topaz™ I/O pins before the Topaz™ FPGA is powered up.

Supervisor IC Circuitry Example

Assuming that the VCCIO1A is the last power supply to be stable in the system, the supervisor IC must hold the CRESET_N pin low for a duration of tRP (reset timeout period) after the VCCIO1A reaches the stable threshold.

Ensure that the tRP of the selected supervisor IC is more than the required tCRESET_N. Refer to the supervisor IC vendor for the recommended operating circuitry.

Figure 10. Supervisor IC Power Up Circuitry
Note: The user trigger (pushbutton, FTDI module) must be connected to the MR pin of the supervisor IC.

Microprocessor or Microcontroller Circuitry Example

Figure 11. Microprocessor Power Up Circuitry. See Resistors in Configuration Circuitry for the resistor values.

The microprocessor or microcontroller must hold the CRESET_N pin low more than the required tCRESET_N duration.

Configuration Sequence

The Topaz™ FPGA configuration logic uses the following sequence during configuration:

  1. When CRESET_N returns high (logic 1) after being held low (logic 0), the FPGA samples the logical value on its SSL_N pin. Like other programmable I/O pins, the SSL_N pin has an internal pull-up resistor.
    Notice: Refer to the Topaz™ data sheet for the pulse width requirements of CRESET_N.
  2. If the SSL_N pin is sampled as a logic 1 (high), the FPGA configures using the SPI active configuration interface.
  3. If the SSL_N pin is sampled as a logic 0 (low), the FPGA waits to be configured from an external controller or from another FPGA in SPI active configuration mode using an SPI-like interface.
Figure 12. Configuration Flow Diagram

Support for Multiple Images

When powered up in SPI active mode, the Topaz™ FPGA defaults to the first valid image it finds searching from address 0. If you enable the multi-image feature, you can optionally choose from three other images.

Notice: To enable the multi-image feature, use the Efinity Programmer to combine multiple images into a single hex file. See Program a Single Image for more information.

During multi-image configuration, the Topaz™ FPGA monitors the CBSEL[1:0] pin logic value when configuration or reconfiguration begins to determine which bitstream image to use. Then, it loads the corresponding image starting from the address specified in the bitstream option bits by sending out a fast read instruction followed by the address.

For multi-image configuration, the Efinity® software saves the images to the bitstream file with no configuration bits between images by default.

Note: Some Topaz™ FPGAs may not support multiple images for all configuration modes. The Supported Configuration Modes topic in your data sheet explains which modes the FPGA supports.

Figure 13. Configuration Setup for Multiple Images
Note: Efinix recommends you to store image 0 at the 24'h000000 address as Topaz™ FPGAs always start searching for a valid bit stream from the 24'h000000 address.
Connect CBSEL[1:0] for the image you want to use:
  • 00 for image 1
  • 01 for image 2
  • 10 for image 3
  • 11 for image 4

During configuration, the FPGA initially searches for a valid image starting at the memory location 0x0000_0000 in the SPI flash. It then proceeds to read the memory location based on the CBSEL[1:0] setting. If no valid image is found at that memory location, the FPGA continues to search in ascending order until it locates a valid image. For example, if CBSEL[1:0] is set to 11 and the SPI flash only contains valid images for 00 and 01, the FPGA will load the image from 00. The following table describes valid and invalid images.

Image Details Note
Valid image Configuration performs as expected.
Invalid image FPGA The FPGA cannot recognize a valid image at the targeted SPI Flash address. It continues to search in ascending address and configure with the next valid image if any.
Corrupted image Image is recognized, but the FPGA fails in configuration with CDONE = 0 and NSTATUS = 0 to indicate a device mismatch or CRC error.
Notice: You can also use the internal reconfiguration feature to reconfigure the FPGA with a different image. This feature uses internal logic instead of the CBSEL[1:0] pins. Refer to AN 010: Using the Internal Reconfiguration Feature to Update Efinix FPGAs Remotely for details on this feature.

Configuring Multiple FPGAs

If your application uses multiple Topaz™ FPGAs, you can configure all of them using a single configuration source.
  • FPGAs that use the same configuration file can be loaded at the same time.
  • FPGAs that use different configuration files (images) can be loaded sequentially, either through Topaz™ FPGAs in a daisy chain, or using external logic.

For daisy chain configurations, the Efinity® software includes 2,048 configuration bits between images in the bitstream file.

Note: You cannot utilize daisy-chain packages that do not have the CSI signal bonded out (such as the F100).

Daisy Chaining with a SPI Flash Device

In a daisy chain, the FPGA closest to the configuration data source is the most upstream FPGA and the FPGA furthest from the source is the most downstream FPGA. The most upstream FPGA typically provides the configuration clock. All other FPGAs are in passive serial mode.

Figure 14. Serial Daisy Chain Configuration Interface Example . See Resistors in Configuration Circuitry for the resistor values.

Figure 15. Parallel Daisy Chain Configuration (x4) Interface Example . See Resistors in Configuration Circuitry for the resistor values.

Daisy Chaining with a Microcontroller or Microprocessor

A microcontroller or microprocesser can configure FPGAs in a daisy chain with a single cascaded bitstream file. All FPGAs must be in passive mode.

Figure 16. Serial Daisy Chain Configuration (x32 Passive Mode) Interface Example . See Resistors in Configuration Circuitry for the resistor values.

Resistors in Configuration Circuitry

Efinix recommends that you use 10 kΩ for all unspecified pull-up and pull-down resistors in configuration circuitries.
Important: Perform an IBIS simulation to analyze the impact of pull-up and pull-down resistors on the signal integrity of dual-purpose configuration pins. Typically, 10 kΩ pull-up and pull-down resistors do not significantly affect either the single-ended or differential signals.

Alternatively, you can calculate your own pull-up or pull-down resistance, RUSER, shown in the following sections.

Notice: The internal weak pull-up resistance, internal weak pull-down resistance, and Schmitt Trigger thresholds values used in the following formulas are included in the Topaz™ Data Sheet in the Documentation page of the Support Center.

User-Defined Pull-Up Resistor Values

RUSER = (RCPU × RIPU) ÷ (RIPU - RCPU)

where:
  • RUSER = User-defined pull-up resistance
  • RCPU = Combined pull-up resistance
  • RIPU = Internal weak pull-up resistance

The combined pull-up resistance, RCPU, can be derived using the following formula:

VT+ ≤ VCCIO × (RIPD ÷ (RCPU + RIPD))

where:
  • VT+ = Schmitt Trigger low-to-high threshold
  • VCCIO = I/O bank power supply
  • RIPD = Internal weak pull-down resistance

User-Defined Pull-Down Resistor Values

RUSER = (RCPD × RIPD) ÷ (RIPD - RCPD)

where:
  • RUSER = User-defined pull-down resistance
  • RCPD = Combined pull-down resistance
  • RIPD = Internal weak pull-down resistance

The combined pull-down resistance, RCPD, can be derived using the following formula:

VT- ≥ VCCIO × (RCPD ÷ (RCPD + RIPU))

where:
  • VT- = Schmitt Trigger high-to-low threshold
  • VCCIO = I/O bank power supply
  • RIPU = Internal weak pull-up resistance

Configuration Timing

Topaz FPGA configuration timing is process dependent. The following tables show the timing parameters for the various configuration modes.

Important: Refer to your Topaz FPGA data sheet for the timing specifications for these parameters.
Table 15. All Modes
Symbol Parameter
tCRESET_N Minimum CRESET_N low pulse width required to trigger re-configuration.
tUSER Minimum configuration duration after CDONE goes high before entering user mode.45
Test condition at 10 kΩ pull-up resistance and 10 pF output loading on CDONE pin.
Table 16. Active Mode
Symbol Parameter
fMAX_M Active mode internal configuration clock frequency.
fMAX_M_EXTCLK Active mode external configuration clock frequency.
tSU Setup time. Test condition at 1.8 V I/O standard and 0 pF output loading.
tH Hold time. Test condition at 1.8 V I/O standard and 0 pF output loading.
Table 17. Passive Mode
Symbol Parameter
fMAX_S Passive mode configuration clock frequency.
tCLKH Configuration clock pulse width high.
tCLKL Configuration clock pulse width low.
tSU Setup time.
tH Hold time.
tDMIN Minimum time between deassertion of CRESET_N to first valid configuration data.
Table 18. JTAG Mode
Symbol Parameter
fTCK TCK frequency.
tTDISU TDI setup time.
tTDIH TDI hold time.
tTMSSU TMS setup time.
tTMSH TMS hold time.
tTCKTDO TCK falling edge to TDO output.

Selecting the Right SPI Flash Device

Topaz™ FPGAs support an SPI flash memory interface for active mode configuration. Use these guidelines to help choose the correct flash device for your Topaz™ FPGA.

  • Configuration Bits—Ensure that your chosen flash device has enough bits to store the configuration bitstream.
    • Single image—Find the configuration bits a single image uses (refer to Table 1).
    • Multiple images—Find the configuration bits a single image uses (refer to Table 1). Multiply the number of bits times the number of images to determine the total bits required to store the full bitstream.
    • Daisy chain—Use the formula (i × b) + (2048 × (i - 1)) where i is the number of images and b is the configuration bits for each image. For example, a daisy chain of three Tz50 FPGAs uses (3 × 13,686,496) + (2,048 × (3 - 1)) = 41,063,584 bits.
  • Configuration Bus Width—Determine the supported configuration bus width for the SPI flash device in Supported Configuration Modes section of the Topaz FPGA Data Sheets in the Documentation page of the Support Center.
  • SPI Clock Frequency—Ensure that your SPI flash device supports a clock frequency that is higher than the SPI active configuration clock frequency as described in .
  • Required Voltage—Make sure the voltage your SPI flash device requires is the same as the FPGA I/O bank voltage.
  • Temperature Range—Check that the SPI flash device's temperature range is compatible with the operating temperature as described in the FPGA data sheet.

Flash Memory Support

Efinix has tested a number of third-party flash devices to determine their compatibility with Efinix FPGAs. The following sections provide an overview of tested flash devices, as well as the commands required to perform read and write actions on the flash memory.

Verified Flash Devices

The following table lists third-party flash devices tested and verified by Efinix. Unverified flash devices may still be compatible with your FPGA. Refer to the list of Supporting Commands in AN 070: Understanding SPI Flash Operations in SIP Devices to determine whether your flash device will work with your FPGA.

Table 19. Tested Flash Devices
Manufacturer Family Part Number
GigaDevice6 GD25Q, GD25WQ, and GD25LQ
Macronix MX25L, MX25U, MX25V, MX75L, and MX75U
Puya Semiconductor P25Q
Winbond W25Q
Micron M25P and MT25Q
XTX XT25F
Atmel (Adesto Technologies) AT25SF
ISSI IS25LP128 and IS25WP512M
Note: Efinix recommends using SPI NOR flash memories.

Supported Commands

Use the commands in the following table to perform flash device operations (e.g., read, write). Memory access supports 24-bit addressing, with byte addresses assigned via the address frame. The first byte on the frame is at the address [23:16], followed by address [15:8], and with the last byte at address [7:0]. All serial input and output timing frames for standard SPI commands rely on x1 mode timing.

For dual SPI commands, some serial input/output timings rely on x2 mode timing. Pins SPI_MOSI and SPI_MISO are used for either serial input or output. SPI_WP and SPI_HOLD pin functions are available.

For quad SPI commands, some serial input /output timings rely on x4 mode timing. SPI_MOSI, SPI_MISO, SPI_WP and SPI_HOLD are used for either serial input or output. The QE bit of the status registers must be set to 1 before issuing any quad SPI commands. Also, be aware the functions of the SPI_WP and SPI_HOLD pins are unavailable while the QE bit is set to 1.

Table 20. Supporting Commands (Standard SPI)
Commands Description Value / Number of Bytes (Mode)
Op Code (Command) Address Dummy Data Input Data Output
Status Register
Read Status Register Read Status Register Bit S7 – S0 05h
(x1)
 S7 – S0
(x1)
Read Status Register-1 Read Status Register Bit S15 – S8 35h
(x1)
 S15 – S8
(x1)
Read Configure Register-2 Read Status Register Bit S23 – S16 15h
(x1)
 S23 – S16
(x1)
Write Status Register Write to Status Register Bits S7 – S0 01h
(x1)
 S7 – S0
(x1)
Write Status Register-1 Write to Status Register Bits S15 – S8 31h
(x1)
 S15 – S8
(x1)
Write Configure Register-2 Write to Status Register Bits S23 – S16 11h
(x1)
 S23 – S16
(x1)
Read
Read Array n Bytes Read Until CS# Goes High 03h
(x1)
 3
(x1)
 1+
(x1)
Read Array (Fast) n Bytes Read Until CS# Goes High 0Bh
(x1)
 3
(x1)
 1
(x1)
 1+
(x1)
Read Manufacturer/Device ID Output JEDEC ID: 1-Byte Manufacturer ID
2-Byte Device ID
 9Fh
(x1)
 1 – 3
(x1)
Read Manufacture ID Read Manufacturer ID (Odd Address) and Device ID (Even Address) 90h
(x1)
 3
(x1)
 1+
(x1)
Erase/Program
Page Erase Erase Selected Page 81h
(x1)
 3
(x1)
Sector Erase (4K Bytes) Erase Selected Sector 20h
(x1)
 3
(x1)
Block Erase (32K Bytes) Erase Selected 32K Block 52h
(x1)
 3
(x1)
Block Erase (64K Bytes) Erase Selected 64K Block D8h
(x1)
 3
(x1)
Chip Erase Erase Whole Chip 60h/C7h
(x1)
Page Program Program Selected Page 02h
(x1)
 3
(x1)
 1 – 256
(x1)
Program/Erase Suspend Suspend Program/erase Operation 75h
(x1)
Program/Erase Resume Suspend Program/Erase Operation 7Ah
(x1)
Protection
Write Enable Sets Write Enable Latch Bit S1 WEL = 1 06h
(x1)
Write Disable Resets Write Enable Latch Bit S1 WEL = 0 04h
(x1)
Volatile SR Write Enable Write Enable for Volatile SR 50h
(x1)
Individual Block Lock Individual Block Lock 36h
(x1)
 3
(x1)
Individual Block Unlock Individual Block Lock 39h
(x1)
 3
(x1)
Read Block Lock Status Read Individual Block Lock Register 3Dh
(x1)
 3
(x1)
 1+
(x1)
Global Block Lock Whole Chip Block Protect 7Eh
(x1)
Global Block Unlock Whole Chip Block Unprotect 98h
(x1)
Security
Erase Security Registers Erase Security Registers 44h
(x1)
 3
(x1)
Program Security Registers Program Security Registers 42h
(x1)
 3
(x1)
 1+
(x1)
Read Security Registers Read Value of Security Registers 48h
(x1)
 3
(x1)
 1+
(x1)
Others (Standard SPI)
Reset Enable Enable Reset 66h
(x1)
Reset Enable Reset 99h
(x1)
Deep Power Down Enters Deep Power-Down Mode B9h
(x1)
Release Deep Power -
Down/ Read Electronic ID
 Read Eelectronic ID Data Abh
(x1)
 3
(x1)
 1
(x1)
Read SFDP Read SFDP Parameter (SFDP is a JEDEC Standard, JESD216B) 5Ah
(x1)
 3
(x1)
 1
(x1)
 1+
(x1)
Table 21. Supporting Commands (Dual and Quad SPI)
Commands Description Value / Number of Bytes (Mode)
Op Code (Command) Address Dummy Data Input Data Output
Read (Dual SPI)
Read Dual Output n Bytes Read by Dual Output 3Bh
(x1)
 3
(x1)
 1
(x1)
 1+
(x2)
Read 2IO n Bytes Read by 2IO BBh
(x1)
 3
(x2)
 1
(x1)
 1+
(x1)
Dual Read Manufacture ID Dual Output Manufacture (Odd)/Device ID (Even) 92h
(x1)
 3
(x2)
 1+
(x2)
Read (QUAD SPI)
Read QUAD Output n bytes read out by quad output 6Bh
(x1)
 3
(x1)
 1
(x1)
 1+
(x4)
Read 4IO n Bytes Read by 4IO Ebh
(x1)
 3
(x4)
 3
(x4)
 1+
(x4)
Read Word 4IO n Bytes Word Read by 4IO E7h
(x1)
 3
(x4)
 1
(x4)
 1+
(x4)
Quad Read Manufacture ID Quad Output Manufacture (Odd)/Device ID (Even Address) 94h
(x1)
 3
(x4)
 1+
(x4)
Erase / Program (QUAD SPI)
Quad Page Program Quad Input to Program Selected Page 32h
(x1)
 3
(x1)
 1 – 256
(x4)

Connecting Programming Hardware

You can program Efinix FPGA or the SPI flash using FTDI Mini Modules. This section describes the hardware connections required. See Using the Efinity Programmer for instructions about SPI and JTAG programming using the Efinity® Programmer.

Supported Download Hardware

Table 22. Verified Supported Download Hardware
Manufacturer Type Part Number
FTDI Dual Channel FT2232
Quad Channel FT4232
Single Channel FT232L
Centron Single Channel Efinix Download Cable II
Note: For more details on the specifications and setup of the Centron's Efinix Download Cable II, refer to the Centron cable information sheet.

SPI Programming Connections

The following figure illustrates the connection required when programming the SPI flash with FTDI FT2232H and FT4232H Mini-Module.

Figure 17. SPI Flash Programming with FTDI FT2232H and FT4232H Mini-Module Connections. Refer to the voltage level translator data sheet for the capacitor values.

Figure 18. SPI Flash Programming with Centron's Efinix Download Cable II

JTAG Programming Connections

Efinix does not recommend using the FTDI cable C232HM-DDHSL-0 for JTAG programming due to the possibility of the FPGA not being recognized or the potential for programming failures.

When programming Topaz FPGAs with a JTAG Mini Module, use this connection:

Figure 19. Connect FT2232 Mini-Module to JTAG Pins

Figure 20. Example of FT2232 Mini-Module Connected to JTAG Pins Using 1.8 V Voltage Level Regulator

Figure 21. Connect FT4232 Mini-Module to JTAG Pins

Figure 22. Example of FT4232 Mini-Module Connected to JTAG Pins Using 1.8 V Voltage Level Regulator
Figure 23. Connect Centron's Efinix Download Cable II to JTAG Pins

Using the Efinity Programmer

The Efinity® software has a Programmer you use to configure Topaz™ FPGAs. You can run the Programmer using the GUI or with the command line.

Notice: Topaz FPGAs have built-in security features to help you protect your intellectual property and to prevent tampering. Refer to the Securing Topaz Bitstreams section of the Efinity Software User Guide for more information about using the security features.

Generate a Bitstream (Programming) File

When you run the automated flow, the software automatically generates bitstream files that you can use to configure your target device. You can also generate the bitstream files manually. To generate bitstream files from the command line, use the following command:

Generate a Bitstream File from the Command Line

Linux:
> efx_run.py <project name>.xml --flow pgm
Windows:
> efx_run.bat <project name>.xml --flow pgm
The software generates these files in the outflow directory:
  • .hex file as <project name>.hex. Use this file to program in SPI active or passive mode.
  • .bit file as <project name>.bit. Use this file for JTAG programming.
Important: With the Efinity software v2021.2 and higher, you must use .hex for SPI and .bit for JTAG.

The bitstream file includes programming options you set for your project (e.g., to initialize user memory or set configuration mode). If you change these options you must regenerate the bitstream file. See Project-Based Programming Options.

Note: The software does not generate bitstream files for preliminary devices.

Working with Bitstreams

You can use the Efinity Programmer to manipulate a bitstream before programming an FPGA or flash device.

Edit the Bitstream Header

About this task

You can use the Programmer to edit the bitstream header information, for example, to add project or revision information. To edit the header:

Procedure
  1. In the Programmer, choose File > Edit Header... or click the toolbar icon to open the Edit Image Header dialog box. The window shows the default header information.
  2. Edit the header.
  3. Click Save.
Results
Important: When editing the bitstream header, if you remove any of the auto-generated information (such as Device: <name>), the Programmer may not be able to recognize the bitstream. Efinix recommends that you only append a small amount of information to the auto-generated data if you want to customize or annotate the header. The header can be a maximum of 256 characters, including the auto-generated text.
If you want to write your own program to detect which device the bitstream targets (e.g., using a microprocessor and SPI passive mode), be sure to keep all of the auto-generated header, specifically the Device: <name> string.

Export to Raw Binary Format

The Efinity® software v2018.4 and later supports raw binary (.bin) format for use with third-party flash programmers. To export to this format:
  1. Open the Programmer.
  2. Select the bitstream file.
  3. Click Export.
  4. Specify the filename.
  5. Click Save.

You can also convert the file to .bin at the command line as described in Convert to Intel Hex Format at the Command Line.

Export to .svf Format

The Efinity® software v2021.1 and later supports serial vector format (.svf) files for use with third-party JTAG programmers. To export to this format:
  1. Open the Programmer.
  2. Select a bitstream file.
  3. Click Export.
  4. Specify the filename.
  5. Choose Serial Vector Format (*.svf) as the Files of type.
  6. Click Save.

Convert to Intel Hex Format at the Command Line

You can convert a bitstream file to Intel Hex and other formats at the command line using this command:

export_bitstream.py [--help] [--family FAMILY] [--idcode IDCODE] [--freq FREQ]
    [--sdr_size SDR_SIZE] [--tir_length TIR_LENGTH] [--hir_length HIR_LENGTH]
    [--tdr_length TDR_LENGTH] [--hdr_length HDR_LENGTH] [--enter_user_mode {on, off}]
    format input_file output_file
Table 23. export_bitstream.py Positional Arguments
Argument Input Description
format hex_to_bin, hex_to_intelhex, bin_to_hex, intelhex_to_hex, hex_to_svf Conversion type.
input_file Filename Image file source.
output_file Filename Image file destination.
Table 24. export_bitstream.py Options
Option (Long) Option (Short) Input Description
--help -h None Show help.
--family N/A Family name Device family (SVF only)
--idcode N/A Identification code JTAG IDCODE (SVF only).
--freq N/A Number JTAG frequency (SVF only).
--sdr_size N/A Number Approximate JTAG shift_dr size before cycling to idle state (SVF only).
--tir_length N/A Number JTAG bypass trailer instruction register length (SVF only).
--hir_length N/A Number JTAG bypass header instruction register length (SVF only).
--tdr_length N/A Number JTAG bypass header data register length (SVF only).
--enter_user_mode N/A on, off Enter user mode after JTAG configuration (SVF only).

The following example shows conversion of the bitstream hex file to bin format:

Converting Hex to Bin
%EFINITY_HOME%\bin\python3
%EFINITY_HOME%\pgm\bin\efx_pgm\export_bitstream.py hex_to_bin new_project.hex test2.bin

Combine Bitstreams and Other Files

You may want to store multiple bitstreams or other data into the same flash device on your board. For example, you can combine files for:

  • Multi-image configuration using the CBSEL pins
  • Internal reconfiguration
  • Programming FPGAs in a daisy chain
  • Programming a bitstream and other files such as a RISC-V application binary

You use the Combine Multiple Image Files dialog box to choose files to combine into a single file for programming. Choose one of the following modes:

Table 25. Modes when Combining Images
Mode Use For Number of Images Notes
Selectable Flash Image Multi-image configuration Up to 4 Use this mode if you want the CBSEL pins to control which image the FPGA loads. For this mode, you also need to choose Image Type > External Controller Flash Image. See Program Multiple Images (CBSEL)
Internal reconfiguration Up to 4 Use this mode if you want the internal reconfiguration pins to determine which image the FPGA loads. For this mode, you also need to choose Image Type > Remote Update Flash Image. See Program Multiple Images (Internal Reconfiguration)
Daisy Chain Daisy chains Any number of JTAG devices including those from other vendors 7. See Program a Daisy Chain
Generic Image Combination A bitstream and other files One bitstream and any number of other files See Program Multiple Images (Bitstream and Data)
Note: When you combine images for an MCU-controlled system or SPI passive daisy chain, the Programmer adds padding between the images as needed. Therefore, you can send the entire bitstream continuously until all devices in the chain are configured.

SPI Programming

You can program Efinix FPGAs using the SPI interface and a .hex file.

Program a Single Image

About this task

In single image programming mode, you configure one FPGA with one image.

Procedure
  1. Click the Select Image File button.
  2. Browse to the outflow directory and choose <filename>.hex.
  3. Choose SPI Active or SPI Passive configuration mode.
  4. Click Start Program. The console displays programming messages.

Program Multiple Images (CBSEL)

About this task

In this programming mode, you specify up to four images that can configure one FPGA. You then use the FPGA's CBSEL pins to select which image to use. You can only use active mode.

Procedure
  1. Click the Combine Multiple Images button.
  2. Choose Mode > Selectable Flash Image.
  3. Enter the output file name.
  4. Choose the output file location. The default is the project's outflow directory.
  5. Choose Image Type > External Flash Image. This setting tells the FPGA to use the CBSEL pins.
  6. Click in the table row corresponding to the position for which you want to add an image.
  7. Click Add Image.
  8. Select the image file to place in that location.
  9. Click OK.
  10. Repeat steps 6 through 9 as needed. You can add up to four images.
  11. Click Apply to generate the combined image file.
  12. Click Close to return to the Programmer, which displays the combined image file as the image to use for programming.
  13. Click Start Program.

Program Multiple Images (Internal Reconfiguration)

About this task

In this programming mode, you specify up to four images that can configure one FPGA. You then use the FPGA's internal reconfiguration interface to select which image to use. You can only use active mode.

Procedure
  1. Click the Combine Multiple Images button.
  2. Choose Mode > Selectable Flash Image.
  3. Enter the output file name.
  4. Choose the output file location. The default is the project's outflow directory.
  5. Choose Image Type > Remote Update Flash Image.
    Note: When using internal reconfiguration, you must choose Remote Update Flash Image. If you choose External Flash Image, the FPGA reconfigures with the first image as specified by the CBSEL pins instead of the golden image.
  6. Click in the table row corresponding to the position for which you want to add an image.
  7. Click Add Image.
  8. Select the image file to place in that location.
  9. Click OK.
  10. Repeat steps 6 through 9 as needed. You can add up to four images.
  11. Click Apply to generate the combined image file.
  12. Click Close to return to the Programmer, which displays the combined image file as the image to use for programming.
  13. Click Start Program.
Results
Note: For more information on using the internal reconfiguration feature, refer to AN 010: Using the Internal Reconfiguration Feature to Update Efinix FPGAs Remotely.
Note: For Tz200 and Tz325 internal reconfiguration, SPI active x1 with SPI Programming Clock Divider DIV is not supported.

Program Multiple Images (Bitstream and Data)

About this task

In this programming mode, you specify one bitstream and one or more data files to combine into a single file for programming. You can only use active mode.

Procedure
  1. Click the Combine Multiple Images button.
  2. Choose Mode > Generic Image Combination.
  3. Enter the output file name.
  4. Choose the output file location. The default is the project's outflow directory.
  5. Click Add Image.
  6. Select the image file to place in that location.
  7. Click Open. The image file and flash length are displayed in the table.
  8. Specify the flash address.
  9. Repeat steps 5 through 8 as needed.
    Note: If you want to combine a bitstream and a RISC-V binary, use 0x00000000 as the bitstream's flash address and 0x00380000 as the binary's flash address.
  10. Click Apply to generate the combined image file.
  11. Click Close to return to the Programmer, which displays the combined image file as the image to use for programming.
  12. Click Start Program.
Results

Program a Daisy Chain

About this task

In this programming mode, you specify any number of images to configure a daisy chain of FPGAs. You can choose active or passive configuration for first FPGA; the rest are in passive mode.

Procedure
  1. Click the Combine Multiple Images button.
  2. Select Daisy Chain as the Mode.
  3. Enter the output file name.
  4. Choose the output file location. The default is the project's outflow directory.
  5. Click Add Image to add a file to the daisy chain.
  6. Repeat step 5 to add as many files as you want to the chain. Use the up/down arrows to re-order the images if needed.
  7. Click Apply to generate the combined image file.
  8. Click Close to return to the Programmer, which displays the combined image file as the image to use for programming.
  9. Click Start Program.

JTAG Programming

You can program Efinix FPGAs using the JTAG interface and a .bit file.

Topaz Family JTAG Device IDs

The following table lists the Topaz JTAG device IDs.

Table 26. Topaz JTAG Device IDs
FPGA Package JTAG Device ID
Tz50 All 10668A79
Tz75 All 006C8A79
Tz100 All 006C9A79
Tz110 All 00698A79
Tz170 All 00699A79
Tz200 All 006A8A79
Tz325 All 006A9A79

Program a Single Image

About this task

In single image programming mode, you configure one FPGA with one image.

Procedure
  1. Click the Select Image File button.
  2. Browse to the outflow directory and choose <filename>.bit.
  3. Choose the JTAG configuration mode.
  4. Click Start Program. The console displays programming messages.

Program Using a JTAG Chain

About this task

You can program an FPGA that is part of a JTAG chain. The chain can include Topaz™ FPGAs as well as other devices. You define your JTAG chain using a JTAG chain file. You import the JTAG chain file into the Programmer to perform programming. The JTAG chain file is an XML file (.xml) that includes all of the devices in the chain. For example: 

<?xml version="1.0"?>
                
<chain>
   <device chip_num="1" id_code="0x10661A79" ir_width="5" istr_code="11000" />
   <device chip_num="2" id_code="0x10661A79" ir_width="5" istr_code="11000" />
   <device chip_num="3" id_code="0x10661A79" ir_width="5" istr_code="11000" />
</chain>
where:
  • chip_num is the device order starting from position 1.
  • id_code is the hexadecimal JEDEC device ID (all lowercase letters)
  • ir_width is the width of the instruction register in bits
  • istr_code is the binary IDCODE instruction
Note: To create a Test Data In (TDI) connection, use chip_num=”1” as the first device.
Note: For Topaz FPGAs, use 11000 as the istr_code.

To program using a JTAG chain:

Procedure
  1. Create a JTAG Chain File using a text editor.
  2. Open the Programmer.
  3. Choose your USB Target and Image.
  4. Select JTAG as the Programming Mode.
  5. Click the Import JCF toolbar button.
  6. Browse to your JTAG Chain File and click Open.
  7. Select which device you want to program in the drop-down list next to the JTAG Programming Mode option.
  8. Click Start Program.
Example
Note: If you implement both the daisy chain and JTAG chain together, ensure that the daisy chain is fully completed before executing the JTAG chain. Because the daisy chain requires CSIs to be connected to CSOs, the JTAG chain will only configure successfully when the CSIs are high.

Program using a JTAG Bridge

About this task

Programming with a JTAG bridge is a two-step process: first you configure the FPGA to turn it into a flash programmer (.bit) and second you use the FPGA to program the flash device with the bitstream (.hex).

The SPI Active using JTAG Bridge mode (formerly named SPI Active using JTAG Bridge (New)) has pre-built flash loader (.bit) files that you can use. These .bit files do not require an external clock source. You can still use your own .bit file if you choose to do so.

Note: The JTAG bridge modes were changed in the Efinity software v2025.1. If you are using an older version of software and want to use the SPI Active using JTAG Bridge (Legacy) mode, refer to Appendix: Program using a JTAG Bridge (Legacy).
The JTAG bridge bitstream files bundled with v2025.1 and higher can only be used with v2025.1 or higher. You cannot use older bundled JTAG bridge bitstream files with v2025.1 or higher, and you cannot use the v2025.1 or higher bundled files with older software versions. If you need to use the older bundled files, use the Programmer v2024.2.
Tip: If you would like to incorporate the RTL files for the new flash loader into your own design, use the JTAG to SPI Flash Bridge core in the IP Manager.
The Topaz™ .bit files include a custom JTAG USERCODE in the bitstream:
  • Single flash .bit files—0x96C09A03
  • Dual flash .bit files—0xC07FCFE2
Note: For Topaz FPGAs, the Programmer automatically loads the .bit file based on the FPGA target. The Programmer has separate pre-built .bit files for JTAG bridge mode
For Trion FPGAs, you need to specify the pre-built file to use.
Figure 24. SPI Active Using JTAG Bridge Options

To program using a JTAG bridge:

Procedure
  1. Choose the USB Target.
  2. In the Image box, click the Select Image File button to browse for the .hex file to program the flash device.
  3. Choose the SPI Active using JTAG Bridge or SPI Active x8 using JTAG Bridge programming mode.
  4. Turn on the Auto configure JTAG Bridge Image option.
    For Topaz FPGAs, the Programmer automatically loads the .bit file. Skip step 5 if you want to use the pre-loaded .bit file.
  5. (Optional) Specify your own .bit file.
    1. In the Programming Mode box, click Select Image File.
    2. The Open Image File dialog box opens to a directory of available pre-built .bit files.
      Browse to find your own .bit file.
      The Programmer remembers which file you specify and uses it automatically the next time you run the Programmer.
  6. Choose the SPI Active Options and JTAG Options.
    OptionDescription
    Select Flash x8 mode only. Choose whether to use the upper flash, lower flash, or both.
    Starting Flash Address Specify the address if other than the default.
    Flash Length Specify the length if other than the default.
    Erase Before Programming Default: on. When turned on, the Programmer erases the flash device before re-programming it.
    Select Verify Method Normal verify—The FPGA computes an on-chip hash from the read back flash data to perform verification. Normal verify is significantly faster than in the Programmer v2024.2 and lower (so much faster that you might think it did not do anything).
    Fast verify—Similar to normal verify, but requires a SPI x4 width (quad mode). The Programmer cannot detect whether your board is using quad mode; if your board is not using it and you try to use fast verify, programming will fail.
    Skip verify—Do not verify the flash.
    Device Select Choose the JTAG device ID of the FPGA to program.
    JTAG Clock Speed Choose a speed or specify a custom one.
  7. Click Start Program. The Programmer first configures the FPGA and then programs the flash device.
Results
Important: If you are using the Topaz RSA bitstream authentication security feature, you need to use a signed .bit file. Copy the bundled .bit file from <Efinity version>/pgm/fli/topaz to another directory and sign it. Then point to the signed .bit file in the Programmer. You can also create your own .bit file if you prefer.
Refer to Using the Bitstream Security Key Generator for information on signing existing .bit files.
Efinix strongly recommends you to disable JTAG if you are using the security features to achieve the highest security level. While disabled, you can still program the flash with JTAG Bridge by connecting to a soft JTAG tap IP and four GPIOs. Refer to:

JTAG Programming with FTDI Chip Hardware

About this task

These instructions describe how to program Topaz™ FPGAs using the FTDI Chip FT2232H and FT4232H Mini Modules. Efinix® has tested the hardware for use with Topaz™ FPGAs.

Note: Efinix does not recommend the FTDI Chip C232HM-DDHSL-0 programming cable due to the possibility of the FPGA not being recognized or the potential for programming failures.

Procedure
  1. Open the Efinity® software.
  2. Open the Efinity® Programmer.
  3. Click the Select Bitstream Image button.
  4. Browse to your image and click OK.
  5. Choose one of the following in the USB Target drop-down list:
    • Dual RS232 HS for FT2232H Mini Module
    • FT4232H_MM for FT4232H Mini Module
  6. Choose JTAG from the Programming Mode drop-down list.
  7. Click Start Program.

FTDI Programming at the Command Line

The Efinity software includes a Python script you can use for programming FTDI modules at the command line.

ftdi_pgm.py [--help] [--mode MODE] [--output_file OUTPUT_FILE] [--url URL] [--aurl AURL] 
    [--xml XML] [--num NUM] [--board_profile BOARD_PROFILE] [--address ADDRESS] 
    [--num_bytes NUM_BYTES] [--burst_size BURST_SIZE] [--jtag_bridge_mode JTAG_BRIDGE_MODE] 
    [--jtag_clock_freq JTAG_CLOCK_FREQ] [--verify_method VERIFY_METHOD]
    [--check_flash_if_supported CHECK_FLASH_IF_SUPPORTED] [--spi_active_freq SPI_ACTIVE_FREQ]
    [--spi_passive_freq SPI_PASSIVE_FREQ] [--list_usb] [input_file]
Table 27. ftdi_pgm.py Positional Arguments
Argument Description
input_file HEX file generated from efx_pgm.
Table 28. ftdi_pgm.py Options
Option (Long) Option (Short) Input Description
--help -h None Show help.
--mode -m passive, active, jtag, jtag_chain, erase_flash, read_flash, jtag_bridge, jtag_bridge_x8 Programming mode.
See the Efinity Programmer User Guide.
In Efinity software versions prior to v2025.1, the jtag_bridge and jtag_bridge_new options were named jtag_bridge_new and jtag_bridge_x8_new, respectively.
8
To use the JTAG bridge modes, you must have already configured the with the JTAG SPI flash loader.
The Efinity software v2023.2 and higher includes pre-built flash loader.bit files in < installation directory>/pgm/fli/<family>. Refer to the JTAG SPI Flash Loader Core User Guide for information on using the legacy flash loader.
--output_file -o Filename Output file used for read_flash mode.
--url -u URL FTDI URL (see Identifying FTDI URLs).
--aurl -a URL Alternative URL (Deprecated).
--xml -x Filename XML file for JTAG programming.
--num -n Number Chip target number for JTAG chain programming.
--board_profile -b Generic Board Profile Using FT232, Digilent JTAG-HS3, FireAnt Development Board, Generic Board Profile Using FT2232H, ISX Programming Cable, Titanium Ti180J484 Dev Board, Titanium Ti180M484 Development Kit, Generic Board Profile Using FT4232, JinChen Programming Cable, TJ180A484S Development Kit, Xyloni Development Board, Generic Board Profile Using FT4234HA Name of the board profile used.
--address N/A Hex number Starting flash address for flash read and write operations.
--num_bytes N/A Number Number of bytes to erase or read. For modes erase and read only.
--burst_size N/A Number Individual read or write burst size in multiples of 256 bytes. For legacy JTAG bridge modes only (jtag_bridge and jtag_bridge_x8).
--jtag_bridge_​mode N/A Erase, write, erase_and_write, read, all, all_no_erase JTAG bridge programming mode.
--jtag_clock_freq N/A Number JTAG clock frequency.
--verify_method N/A None, onchipx1, onchipx2, onchipx4 The method used to verify the downloaded bitstream.
Default: onchipx2 (On-chip hash calculation with SPI x2 mode)
--check_flash_​​​​if_supported N/A Hex string Check if flash is supported using the JEDEC ID hex string (e.g., C84012).
--spi_active_​freq N/A Number Set SPI active frequency.
Default: 6000000 Hz
--spi_passive_​freq N/A Number Set SPI passive frequency.
Default: 3000000 Hz
--list_usb -l None List the available USB target's URL.
Linux Examples

To program in Linux:

  1. Open a terminal and change to the Efinity® installation directory.
  2. Type: source ./bin/setup.sh and press enter.
  3. Use the ftdi_program.py command.

Example: Titanium Ti60 F225 Development Board as the only board attached to your computer:

ftdi_program.py <filename>.bit -m jtag

Example: Titanium Ti60 F225 Development Board with serial number FT5ECP6E when another board with an FTDI chip is connected to your computer:

ftdi_program.py <filename>.bit -m jtag --url ftdi://ftdi:4232h:FT5ECP6E/1 
    --aurl ftdi://ftdi:4232h:FT5ECP6E/1
Windows Examples

To program in Windows:

  1. Open a command prompt and change to the Efinity® installation directory.
  2. Type: .\bin\setup.bat and press enter.
  3. Use the ftdi_program.py command.

Example: Titanium Development board as the only board attached to your computer:

%EFINITY_HOME%\bin\python3
\ftdi_program.py <filename>.bit -m jtag

Example: Titanium Ti60 F225 Development Board with serial number FT5ECP6E when another board with an FTDI chip is connected to your computer:

%EFINITY_HOME%\bin\python3
\ftdi_program.py <filename>.bit 
    -m jtag --url ftdi://ftdi:4232h:FT5ECP6E/1 --aurl ftdi://ftdi:4232h:FT5ECP6E/1

Identifying FTDI URLs

Certain Efinity® scripts contain the --url and --aurl options, which require the input of an FTDI URL.

Important: You only need to specify the --url and --aurl options if you have more than one board with an FTDI chip connected to your computer.

The FTDI URL is in the format: 

ftdi://ftdi:<product>:<serial>/<interface>

where:

<product> is the USB product ID of the device
<product> Board
2232h Topaz Tz170J484 Development Board
<serial> is the serial number of the FTDI chip. (Optional)
  • If you only have one Efinix® development board or FTDI device connected to your computer, you do not need to specify the serial number.
  • In the Efinity® software v2020.2 and higher, the Programmer displays the serial number of the FTDI device in the USB Info string. The serial number is a string beginning with FT.

<interface> is the interface number. For Efinix® development boards, <interface> is always 1.

Programmer Messages

The following section lists warning and error messages that the software may display and explains how to fix them.

Message on_program Device is not available
Reason 1. Board not connected or powered off.
2. USB driver is not installed.
To fix 1. Connect board to host and power on the board.
2. Install USB driver.
Message USBError(2, 'Entity not found')
Reason USB driver is not installed.
To fix Install USB driver.
Message *Cannot get JTAG url, Please check your board profile configuration
*int() argument must be a string, a bytes-like object or a real number, not 'NoneType'--(idcode=None)
Reason USB driver is not installed in interface 1 (JTAG).
To fix Install USB driver for interface 1.
Message ERROR: Incompatible file extension for programming mode, please use .bit file for JTAG programming
Reason JTAG chosen as programming mode but .hex file specified in bitstream file.
To fix Specifiy correct the .bit bitstream file.
Message ERROR: Incompatible file extension for programming mode, please use .hex file for SPI Active programming
Reason SPI Active chosen as programming mode but .bit file specified in bitstream file.
To fix Specifiy correct the .hex bitstream file.
Message ERROR: Incompatible file extension for programming mode, please use .hex file for SPI Passive programming
Reason SPI Passive chosen as programming mode but .bit file specified in bitstream file.
To fix Specifiy correct the .hex bitstream file.
Message ERROR: Incompatible file extension for programming mode, please use .hex file for SPI Active using JTAG Bridge programming
Reason SPI Active using JTAG Bridge chosen as programming mode but .bit file specified in bitstream file.
To fix Specifiy correct the .hex bitstream file.
Message ERROR: Incompatible file extension for programming mode, please use .hex file for SPI Active x8 using JTAG Bridge programming
Reason SPI Active x8 using JTAG Bridge chosen as programming mode but .bit file specified in bitstream file.
To fix Specifiy correct the .hex bitstream file.
Message ERROR: Check board is plugged in, and then click on "Refresh USB Targets"
Reason Board disconnected or powered off during programming.
To fix Reconnect the board and click the refresh button.
Message Image file not found
Reason Bitstream file not loaded.
To fix Load the bitstream file.
Message Failure to configure was detected
Reason Programmer internally failed to enter configuration mode.
To fix Program again.
Message Unable to configuire from flash device.
Reason JTAG state failed to enter USER mode.
To fix Reprogram the bitstream.
Message Unable to determine status of device.
Reason 1. JTAG programming in unknown state; potentially hardware issue.
2. Different width chosen to program the bitstream file. For example, the bitstream is x1 width but SPI Active x8 is chosen.
To fix 1. Try to reprogram the bitstream. If using C323HM cable, check the connectivity.
2. Choose the correct width or run the bitgen again.
Message ERROR: Flash verify unsuccessful... mismatch found
Reason 1.Programmed flash does not match with the selected bitstream.
2. The board does not support the selected verify method.
To fix 1. Reprogram the bitstream.
2. Select "Normal verify."
Message ERROR: Unable to verify JTAG interface, cannot determine configuration status
Reason JTAG mode used to program the board, but JTAG interface 1 is unstable or the JTAG connection using C2323HM is incorrect or disconnected.
To fix Check the driver for the JTAG interface or check the wire connection.
Message ERROR: Unknown error trying to read flash device, aborting. Aborting flash programming
FtdiProgram error: could not get flash device
Reason Attempted to program the board via SPI Active or SPI Passive while interface 0 (SPI) is disabled.
To fix Check the driver for the SPI interface. If it is unsupported (using C232HM), then it is not possible to program with SPI.
Message FtdiProgram error: Device is in CONFIGURATION_FAIL state instead of user mode after programming JTAG Bridge Image!
Reason Wrong or incomplete JTAG Bridge image specified.
To fix Specify the correct JTAG Bridge image.
Message Unsupported JTAG Bridge version: 0.0. Please choose the latest bundled JTAG Bridge image and then try again., aborting flash programming FtdiProgram error:
Reason Used an older or unsupported version of the flash loader.
To fix Use the supported version of the flash loader.
Message ERROR: JTAG Bridge Image not found. Please specify correct file path.
- ERROR: File = ""
Reason JTAG Bridge image not specified when SPI Active using JTAG Bridge is selected as programming mode.
To fix Specify the correct JTAG Bridge image.
Message ERROR: Invalid speed entered, please only input numbers
Reason Invalid character entered for Custom JTAG Clock Speed.
To fix Use a numerical speed value.
Message ERROR: Invalid speed entered, out of range, please enter a number between 1000 and 30,000,000"
Reason Invalid character entered for Custom JTAG Clock Speed.
To fix Use a valid value between 1000 and 30,000,000.
Message ERROR: The FPGA given in the bitstream file does not match the FPGA you are trying to program. Check that you are using the correct bitstream file.
Reason Wrong bitstream file specified for the board in use.
To fix Specify the correct bitstream file.
Message Detected 4Byte flag in bitstream but flash is smaller or equal to 16MiB Aborting flash programming
FtdiProgram error:Detected 4Byte flag in bitstream but flash is smaller or equal to 16MiB
Reason 1. Erase or read flash attempted with a starting flash address greater than the flash capacity.
2. Erase length specified greater than the flash capacity.
To fix 1. Specify the correct starting address.
2. Specify the correct length.
Message ERROR: Unable to retrieve flash status Check board is plugged in, and then click on ""Refresh USB Targets"" Unrecognized Flash device. Will use Generic Flash profile. Please contact support if you face any problem.
Reason Programmed bistream contains an incorrect or mismatched header with the board.
To fix Verify that the bitstream header is correct.
Message ERROR: Export SVF feature is disabled for T8/T20 bitstreams
Reason T8 or T20 bitstream exported to SVF.
To fix SVF is not supported for T8 or T20.
Message ERROR: Cannot edit SPI Active clock settings for .bit file, please use the .hex file
Reason Opened Edit SPI Active Clock on a .bit file.
To fix Edit SPI Active Clock only works for .hex files.
Message ERROR: Input file has been corrupted, unable to determine target device
Reason Opened Edit SPI Active Clock on a corrupted .hex file.
To fix Replace the corrupted .hex file to a valid one.
Message ERROR: Unable to read input image file, file maybe have been corrupted
Reason Opened Edit SPI Active Clock on a corrupted .hex file.
To fix Replace the corrupted .hex file to a valid one.
Message ERROR: Device code for JTAG Bridge image CANNOT be Unknown. Please ensure you are using correct bitstream file
Reason 1. Programmer is unable to detect the device code.
2. Connectivity issue.
3. USB driver missing for the JTAG interface.
4. Programmer is unable to detect non-Efinix device.
To fix Ensure there is a valid device ID at Device Select.
Message ERROR: Export feature only works with Efinity bitstreams
Reason Export failed because the bitstream is not originally from Efinity.
To fix Bitsream exports not originally from Efinity are not supported.
Message ERROR: Cannot detect JTAG chain setup. Please import JTAG chain file
Reason Programmer is unable to detect non-Efinix device.
To fix Import the JCF.
Message Calculated IR width is invalid. Please import JTAG chain file
Reason A board in the chain is powered off.
To fix Power on the board and click the refresh button.
Message Total IR width of the previous JCF does not match actual total IR width. Please import JTAG chain file again.
Reason Programmer is unable to detect non-Efinix device and cannot auto-detect IR length of the board in the JTAG chain.
To fix Import the JCF.
Message ERROR: The Programmer cannot detect the FPGA in the JTAG chain. Check the JTAG cable or header for connectivity issues
Reason Incorrect connection of the chain or improperly connected wire.
To fix Check the wire connectivity and check the IDCODE through the SVF Player.
Message ERROR: Invalid ASCII character detected in header, cannot display header text
Reason Bitstream header is incorrectly formatted.
To fix Run the bitstream again to generate a new bitstream.
Message ERROR: JTAG chain file does not match XSD standard
Reason The JCF file in the wrong format.
To fix Fix the format of the JCF.
Message Error occured. OpenocdNotRunning("An error occurred when waiting for response from the main loop. OpenocdNotRunning('Failed to add a user due to: OpenOCD Error: no device found; Return code: 1')")
Reason Occurs in co-debug mode when the board is disconnected and reconnected.
To fix Close and re-open the Programmer.
Message Failed to detect number of JTAG TAP. JTAG chain connection may be broken or number of TAP is greater than 128
Reason Failed to auto-detect the board in the JTAG chain.
To fix Import the JCF.
Message ERROR: Invalid output file <file name> specified for image generation
Reason Name of the output file not specified when using Combine Multiple Image Files.
To fix Specify the file in Output File.
Message ['', '', '', '']
ERROR: All input files for image generation must be targeted to the same device
Reason 1. No file added to the field at Combine Multiple Image Files.
2. Image mixed with a different target device.
To fix 1. Add at least one image to use the tool.
2. Only the same targeted device bitstream file can be used to combine the image.
Message ERROR: Flash address '' is not a valid hexademical number
Reason Flash address unspecified or incorrect at Generic Image Combination.
To fix Specify the flash address in the correct hexadecimal format.
Message ERROR: No input files for image combination
Reason No input file specified for the image combination at Generic Image Combination.
To fix Specify at least one image.
Message ERROR: First flash address '0x00380000' is not equal to 0x00000000
Reason First flash address specified at Generic Image Combination does not start with 0.
To fix For the first image, the flash address must start with 0.
Message ERROR: Flash address '0x00000000' should be greater than or equal to next available
flash address '0x00121000'
Reason Second or later flash address specified at Generic Image Combination starts with 0.
To fix For the second and later images, the flash address cannot start with 0.

Using the Command-Line Programmer

To run the Programmer using the command line, use the command:

Command-Line Programmer

Linux:
efx_run.py <project name>.xml --flow program [--pgm_opts [mode=MODE] [settings_file]]
Windows:
efx_run.bat <project name>.xml --flow program [--pgm_opts [mode=MODE] [settings_file]]

Options

--pgm_opts mode specifies the configuration mode. The available modes are:

Table 29. --pgm_opts Modes
Mode Description
active SPI Active configuration.
passive SPI Passive configuration.
jtag JTAG programming. See the Efinity Programmer User Guide for more information about programming with the JTAG interface.
jtag_bridge SPI Active using JTAG bridge mode.
jtag-bridge_x8 SPI Active x8 using JTAG bridge mode (used with two flash devices). 9
In active mode, the FPGA configures itself from flash memory; in passive mode, a CPU drives the configuration. If you do not specify the mode, it defaults to active. For example, to use JTAG mode, use the command:
efx_run.py <project name>.xml --flow program --pgm_opts mode=jtag

--pgm_opts settings_file specifies a file in which you have saved all of the programming options. A settings file is useful for performing batch programming of multiple devices.

Note: See Programming Options for more programming options.

Project-Based Programming Options

You specify project-based programming options in the Project Editor > Bitstream Generation tab in the Efinity® software. Efinix FPGAs support active and passive configuration in a variety of modes.

Note: Some of these project settings affect bits in the bitstream. Therefore, when you program an FPGA with the Programmer, the setting you make in the Project Editor should match what you intend to use in the Programmer.
Table 30. Project-Specific Programming Options
Option Notes
Active/Passive Active: SPI active mode.
Passive: SPI passive mode.
Your choice of active or passive affects the pinout and determines which choices are available in the Programming Mode box.
JTAG USERCODE Use this field to specify a 32-bit user electronic signature. The USERCODE is included in​ the bitstream. You can read it from the FPGA via the JTAG interface, and you can view the​ JTAG USERCODE in the Programmer’s Advanced Device Status dialog box.
Default: 0xFFFFFFFF
Clock Source
For Topaz FPGAs, choose whether you want to use the FPGA's internal oscillator or an external clock source as the configuration clock.
SPI Programming Clock Divider Choose the divider for the SPI clock. This setting is reflected in the bitstream file.
Default: DIV8
Clock Sampling Edge
For Topaz FPGAs, choose whether the configuration clock should sample on the rising or falling edge. The default is Falling.
Power down flash after programming Enable this option to power down the flash device after the FPGA finishes programming. This setting is reflected in the bitstream file, and you can only set it here.
Default: On
Use 4-byte addressing during configuration ( Topaz only). When you turn this option on, the control block issues 4-byte addresses​ when it configures the FPGA.
This option is not supported for Tz50 FPGAs.
Programming mode Choose the programming mode and width; the choices depend on the FPGA and package you are targeting. This setting is reflected in the bitstream file, and you can only set it here.
Default: SPI <active or passive> x1
Enable Initialized Memory in User RAMs This setting is reflected in the bitstream file, and you can only set it here.
on: The bitstream has initialized memory.
off: The bitstream does not have initialized memory.
smart:
For the Topaz family, this option gives a slightly smaller bitstream.
Default: smart
Release Tri-States before Reset During configuration, core signals are held in reset and the I/O pins are tri-stated. These states are released when the FPGA enters user mode.
On: (default) I/O pins are released from tri-state before the core is released from reset (use this option when the application is core sensitive).
Off: Core signals are released from reset before the I/O pins are released from tri-state (use this option when the application is I/O sensitive).
Enable Bitstream Compression When turned on (default), the software compresses the bitstream.
If you choose Bitstream Encryption or Bitstream Authentication, this option is turned off and disabled because you cannot compress a bitstream and use the security features simultaneously.
Bitstream Encryption
On: The software generates an encrypted bitstream. You also need to specify the .bin file in the FPGA Key Data File box.
Off: (default) The software generates a plaintext bitstream.
Randomize IV value during compilation This option is used with bitstream encryption. The encryption/decryption uses a 96-bit initial vector (IV). If you want the software to generate a random IV for every compilation, leave this option turned on. If you want to specify an IV, turn this option off and specify the value in the 96-bit IV Value box.
On (default): Let the software generate the IV value. (The bitstream will be different every time you compile, even if nothing has changed in your design.)
Off: The software does not generate the IV value; the user will specify it in the 96-bit IV Value box. (If nothing has changed in your design, when you recompile, the bitstream remains the same)
96-bit IV Value Click the refresh button next to this box to generate a random IV value. You can also enter a value you generate with another program.
Bitstream Authentication
On: The software generates a signed bitstream. You also need to specify the .bin file in the FPGA Key Data File box and the RSA private key (.pem) file in the RSA Private Key box.
Off: (default) The software generates an unsigned bitstream.
FPGA Key Data File Specify the location and name of the .bin file you generated with the Efinity Bitstream Security Key Generator.
RSA Private Key Specify the location and name of the RSA private key file (.pem).
Generate JTAG configuration file On (always): Generate a .bit file for JTAG configuration.
Generate JTAG raw binary configuration file On: Generate a .bin file (raw binary) for JTAG configuration.
Off (default): Do not generate a .bin file.
Generate SPI configuration file On (always): Generate a .hex file for SPI programming.
Generate SPI raw binary configuration file On: Generate a .bin file (raw binary) for SPI programming.
Off (default): Do not generate a .bin file.

When you change one of these options, you can simply re-run the bitstream generation flow step. You do not need to recompile the design.

Figure 25. Setting Programming Options

Notice: Refer to the data sheet for your FPGA for information on which configuration options it supports.

Configuration Status Register

Topaz FPGAs have a configuration status register. You can use the Efinity Programmer to monitor the values in this register to help debug confugration issues. View the register values in the Advanced Device Configuration Status dialog box, which you open by clicking the button of the same name.

Table 31. Configuration Status Register
Name Description
IN_USER 0: The FPGA is not in user mode.
1: The FPGA is in user mode. IN_USER waits for all internal resets and tri-states to be released before it goes high.
CDONE Configuration done, has the same value as the CDONE output pin.
0: The FPGA is not configured.
1: Configuation is complete.
NSTATUS Configuration status, has the same value as the active-low NSTATUS output pin if the NSTATUS pin is not driven by user when the FPGA is in user mode.
0: Indicates that the FPGA received a bitstream that was targeted for a different configuration mode or width, or a CRC error is detected during configuration. NSTATUS can also go low if there is a mismatch between the bitstream and the FPGA encryption/authentication keys.
1: During configuration, indicates that the FPGA is in configuration mode.
CRC32_ERROR_CORE 0: No CRC errors were detected in the core configuration bits.
1: One or more CRC errors were detected in the core configuration bits.
RMUPD_ERROR 0: No errors occurred during remote update.
1: An error occurred in the golden image during remote update configuration.
CONFIG_END 0: Configuration is not complete.
1: Configuration completed (whether successful or not).
SYNC_PAT_FOUND 0: Indicates that the FPGA is not receiving the expected synchronization pattern at start of the bitstream. Check for board or power issues.
1: Indicates that the FPGA detected a synchronization pattern at start of the bitstream., and the clock and data connections to the FPGA are acceptable. Any configuration problems are likely digital or logical in nature. After successful configuration the status will return to 0.
SEU_ERROR 0: No SEU detection errors were found.
1: An SEU detection error was found when reading back the SEU CRAM. Has the same value as the SEU detection error status signal to the core fabric.
CRC32_ERROR_PERIPH 0: No CRC errors were detected in the interface configuration bits.
1: One or more CRC errors were detected in the interface configuration bits.
AES256_PASS
For an encrypted bitstream:
0: Decryption failed. The encryption keys used in to program the fuses may not match the ones used to encrypt the bitstream
1: The encrypted bitstream was decrypted successfully.
If the bitstream is not encrypted, this register is always a 1.
RSA_PASS
When using RSA authentication:
0: The signature check failed. The RSA keys used to program the fuses may not match the ones used to sign the bitstream in the Efinity project.
1: The bitstream signature was verified successfully
If RSA authentication is not used, this register is always a 1.
AES_ACTIVE After the FPGA is configured, you can check this status bit for encryption:
0: AES is disabled in the current design.
1: AES is enabled in the current design.
RSA_ACTIVE After the FPGA is configured, you can check this status bit for authentication:
0: RSA is disabled in the current device.
1: RSA is enabled in the current device.
USERCODE Displays the 32-bit hex JTAG USERCODE.

Verifying Configuration

Note: For authenticated and encrypted bitstream, NSTATUS remains as 0.

You can confirm that the FPGA is configured by your bitstream successfully by checking on the following:

  • Use the Efinity Programmer to check whether the FPGA is in user mode. In the Programmer, click the Device Configuration Status > Refresh Device Configuration Status button. The console displays the FPGA status.
  • Monitor the CDONE and NSTATUS pins to determine the status of the FPGA. The status lets you know if there is a configuration error (CDONE = 0 and NSTATUS = 0).
  • You can verify the bit stream stored in the SPI flash after programming is completed in SPI Active mode. Turn on the option in Project Editor > Programmer > SPI Active Options > Verify After Programming to check for errors such as flash image being corrupted during a write, an improperly skipped erase step, etc.
    Note: Generally, Efinix recommends that you keep the Verify After Programming option turned on. However, if you are using the FPGA's built-in CRC checking (enabled by default) with NSTATUS monitoring to verify configuration, you can use that method as a way of verifying the flash (that is, if the FPGA goes into user mode, the flash write is verified).
    Note: The Verify After Programming confirms the correctness of the bit stream programmed into the SPI Flash. It doesn't confirm if the device is in use afterwards.

The Efinity software adds a CRC to the bitstream. During configuration, the FPGA generates another CRC as it reads the bitstream. Then, it compares the two CRCs to see if they match. If they do not, it indicates a configuration error. The CRC error is reflected by CDONE = 0 and NSTATUS = 0. The CRC check can be useful for debugging board problems such as signal integrity issues between the flash device and the FPGA.

Monitoring with the Efinity Programmer

With the board connected to your computer, you can monitor the FPGA's status with the Programmer. The following table describes the values of CDONE and NSTATUS and their meaning.

Note: As NSTATUS is a dual purpose GPIO, you may observe different behavior from Efinity Programmer on NSTATUS if NSTATUS is applied as a GPIO in your bit stream.
Table 32. Monitoring with the Efinity Programmer
CDONE NSTATUS Programmer Message Description
0 0 Failure to configure was detected Configuration failed. This may be caused by:
  • The configured bitstream is for a different configuration mode or width,
  • CRC error is detected during configuration,
  • There is a mismatch between the bitstream and the FPGA encryption/authentication key
0 110 Programming ... The FPGA is in configuration mode.
1 0 – The FPGA is not functioning as expected. Bitstream transmission is completed but failed may be due to the following:
  • Wrong device ID
  • Remote update failure
1 1 Device is in user mode! The FPGA is functioning correctly according to the user design.

Monitoring with a Microcontroller or LEDs

You can optionally monitor the status of CRESET_N, CDONE and NSTATUS with a microcontroller or LEDs. CDONE is a dedicated configuration pin and you can monitor it directly. However, NSTATUS is a dual-purpose configuration pin. To use it to monitor configuration, you can connect it to a GPIO and set it's output value to a constant 0.

To add NSTATUS to your design as a GPIO for monitoring:
  1. In the Interface Designer, create a GPIO block for NSTATUS with the following settings:
    • Instance Name: NSTATUS
    • Mode: Output
  2. In the Instance View pane, assign the NSTATUS instance to the NSTATUS package pin (refer to the pinout file to find the package pin).
  3. Follow these steps to set the external or internal configuration:
    1. For single image (SPI active, SPI passive, and JTAG) and external controller flash image,
      • Set Constant Output: 0 for the NSTATUS
    2. For internal configuration,
      • Assign the cfg_error to the NSTATUS in the RTL top module.
  4. Recompile the design.
  5. Download the bitstream to the flash memory on your board.
The following figure shows example schematics connecting a microcontroller to the FPGA's CDONE and NSTATUS pins:
Figure 26. Connect CDONE and NSTATUS to a Microcontroller
The MCU can verify the configuration with the following steps:
  • Reset the FPGA.
  • Poll CDONE for 1.
  • Wait for tUSER.
  • Sample NSTATUS.
Note: You can add a watchdog timer in the MCU to time the system's configuration, thus preventing the system from hanging if any configuration issues arise.
Table 33. Monitoring with a Microcontroller
CRESET_N CDONE NSTATUS (After tUSER) Description
1 0 0 Configuration failed. This may be caused by:
  • The configured bitstream is for a different configuration mode or width.
  • Wrong device ID.
  • CRC error is detected during configuration.
1 0 111 The FPGA is in configuration mode.
1 1 0 The FPGA is functioning correctly according to the user design.
1 1 1 For internal reconfiguration only. The targeted application image FPGA cannot be configured successfully after six trials or a timeout with the golden image restored.

The following figure shows example schematics connecting LEDs to the FPGA's CDONE and NSTATUS pins:

Figure 27. Connect CDONE and NSTATUS to LEDs
Table 34. Observation through LEDs
CRESET_N CDONE LED NSTATUS LED Description
1 Off Off12 The FPGA is in configuration mode.
1 Off On Configuration fails. This may be caused by:
  • The configured bitstream is for a different configuration mode or width.
  • Wrong device ID.
  • CRC error is detected during configuration.
1 On On The FPGA is functioning correctly according to the user design.
1 On Off The internal reconfiguration only, the targeted application image cannot be configured successfully after 6 trials or a timeout with the golden image restored.

Installing USB Drivers

To program Topaz™ FPGAs using the Efinity® software and programming cables, you need to install drivers.

Efinix development boards have FTDI chips (FT232H, FT2232H, or FT4232H) to communicate with the USB port and other interfaces such as SPI, JTAG, or UART. Refer to the Efinix development kit user guide for details on installing drivers for the development board.

Note: If you are using more than one Efinix development board, you must manage drivers accordingly. Refer to AN 050: Managing Windows Drivers for more information.

For your own development board, Efinix suggests using the FTDI Chip FT2232H or FT4232H Mini Modules for JTAG programming Topaz™ FPGAs. (You can use any JTAG cable for JTAG functions other than programming.)

Note: Efinix does not recommend the FTDI Chip C232HM-DDHSL-0 programming cable due to the possibility of the FPGA not being recognized or the potential for programming failures.
Table 35. USB Programming Connections
Board Connect to Computer with
Efinix development boards USB cable
Your own board FTDI x232H programming kit. For example:
  • FT2232H Mini Module
  • FT4232H Mini Module
Note: The FTDI Chip Mini Module supports 3.3 V I/O voltage only. Refer to the FTDI Chip website for more information about the modules.

Installing the Linux USB Driver

The following instructions explain how to install a USB driver for Linux operating systems.

  1. Disconnect your board from your computer.
  2. In a terminal, use these commands:
    > sudo <installation directory>/bin/install_usb_driver.sh
> sudo udevadm control --reload-rules
> sudo udevadm trigger
Note: If your board was connected to your computer before you executed these commands, you need to disconnect it, then re-connect it.

Installing the Windows USB Driver

On Windows, you use software from Zadig to install drivers. Download the Zadig software (version 2.7 or later) from zadig.akeo.ie. (You do not need to install it; simply run the downloaded executable.)

Important: For some Efinix development boards, Windows automatically installs drivers for some interfaces when you connect the board to your computer. You do not need to install another driver for these interfaces. Refer to the user guide for your development board for specific driver installation requirements.

To install the driver:

  1. Connect the board to your computer with the appropriate cable and power it up.
  2. Run the Zadig software.
    Note: To ensure that the USB driver is persistent across user sessions, run the Zadig software as administrator.
  3. Choose Options > List All Devices.
  4. Repeat the following steps for each interface. The interface names end with (Interface N), where N is the channel number.
    • Select libusb-win32 in the Driver drop-down list.
    • Click Replace Driver.
  5. Close the Zadig software.
Note: This section describes how to install the libusb-win32 driver for each interface separately. If you have previously installed a composite driver or installed using libusbK drivers, you do not need to update or reinstall the driver. They should continue to work correctly.

Appendix: Programming the Flash Using JTAG Bridge (Legacy)

JTAG Bridge (Legacy) and JTAG SPI Flash Loader are EOL. The section has been kept to provide legacy support. For new designs, Efinix recommends using JTAG Bridge (New).

You can use the JTAG SPI Flash Loader to load a new user image into the SPI flash device on your board. The Topaz™ FPGA bridges the JTAG commands sent from the computer to the flash device. This mode lets you save board space because you can use the JTAG header on your board to program the flash instead of using a separate SPI header.

The flash programming flow consists of these steps:
  1. Turn the Topaz™ FPGA into a flash programmer by configuring the FPGA via JTAG with the JTAG SPI Flash Loader IP core. You can configure the IP core using the Efinity IP Manager. You use a .bit bitstream file to configure the FPGA.
  2. Use the Efinity Programmer and the SPI Active using JTAG Bridge mode to program the user image into the flash device. The Programmer sends the command through the Topaz™ FPGA, which in turn programs the flash. You use a .hex bitstream file for the user image.
  3. After the flash is programmed, toggle the Topaz™ FPGA's CRESET_N signal to trigger reconfiguration using the new flash image.

For the SPI Active x8 using JTAG Bridge mode, choose TRUE for the Enable dual flash programming option.

Figure 28. SPI Flash Programming Flow
Notice: For more information on using the JTAG SPI Flash Loader and the SPI Active using JTAG Bridge or SPI Active x8 using JTAG Bridge programming mode, refer to the JTAG SPI Flash Loader Core User Guide.

Revision History

Table 36. Document Revision History
Date Version Description
??? 1.4
For Titanium and Topaz FPGAs, the default setting for the Project Editor > Bitstream Generation tab > Clock Sampling Edge option is Falling (not Rising). (DOC-2804)
Update Figure 23. (DOC-2938)
Update Verified Flash Devices. (DOC-2940)
Added Supported Commands. (DOC-2940)
November 2025 1.3 Added Supported Download Cables section. (DOC-1303)
Added IS25WP512M for ISSI in Supported Flash Devices.
Corrected and Updated Verify Configuration topic including sub-topic Monitoring with a Microcontroller or LEDs.
Added note in GigaDevice's GD25LQ in Supported Flash Devices. (DOC-2711)
Fix BR4/BR1 problem for JTAG_VCCIO_SEL pin. (WEB-266, WEB-267)
Added note about padding in combined bitstream images in Combine Bitstreams and Other Files.
Added note for Tz200 and Tz325 internal reconfiguration where SPI active X1 with SPI Programming Clock Divider DIV is not supported in Program Multiple Images (Internal Reconfiguration). (PROG-672)
March 2025 1.2
Added Figure 6.
Added Figure 7.
Added an006.html#spi_passive_timing__title_jbc_y5d_q2c.
Added an006.html#spi_passive_timing__fig_wfd_x5d_q2d.
Added Figure 4
Added Figure 5
Correct typo in Figure 32.
Added note to Program Using a JTAG Chain. (DOC-2310)
January 2025 1.1 Fixed typo in title of referenced document. (DOC-2302)
Added an006.html#concept_xxk_lwc_cdb__table_i1r_4sg_tdc. (DOC-2254)
December 2024 1.0 Initial release.
1 Not all Tz50 packages support x8 bus widths.
2 CDONE has a drive strength of 12 mA at 1.8 V.
3 Cascaded configuration is not supported in the F100 package.
4 The FPGA may go into user mode before tUSER has elapsed. However, Efinix recommends that you keep the system interface to the FPGA in reset until tUSER has elapsed.
5 For JTAG programming, the min tUSER configuration time is required after CDONE goes high and the FPGA receives the ENTERUSER instruction from the JTAG host (TAP controller in UPDATE_IR state).
6 Does not support 4-byte address mode.
7 Efinity Programmer does not apply any constraints for combining multiple images. Efinix recommends that you run the IBIS simulation to check the signal integrity if you need to connect more than 4 devices in the same daisy chain.
8 The jtag_bridge_x8 mode is only supported in some and Topaz FPGAs. Refer to the data sheet for the modes your FPGA supports.
9 Used with two flash devices. Only supported in some Topaz FPGAs. Refer to the data sheet for the modes your FPGA supports.
10 For authenticated and encrypted bitstream, NSTATUS remains as 0.
11 For authenticated and encrypted bitstream, NSTATUS remains as 0.
12 For authenticated and encrypted bitstream, NSTATUS remains ON.