AN 425: Using the Command-Line Jam™ STAPL Solution for Device Programming

Download PDF
ID 683089
Date 10/14/2024
Public
Document Table of Contents
Document Table of Contents x
1. Using the Command-Line Jam™ STAPL Solution for Device Programming
1. Using the Command-Line Jam™ STAPL Solution for Device Programming x
1.1. Jam™ STAPL Players 1.2. Jam™ STAPL Files 1.3. Using the Jam™ STAPL Player 1.4. Using the quartus_jli Command-Line Executable 1.5. Using Jam™ STAPL for ISP with an Embedded Processor 1.6. Board Layout 1.7. Embedded Jam™ STAPL Players 1.8. Updating Devices Using Jam 1.9. Document Revision History for AN 425: Using the Command-Line Jam™ STAPL Solution for Device Programming
1.1. Jam™ STAPL Players x
1.1.1. Differences Between the Jam™ STAPL Players and quartus_jli
1.2. Jam™ STAPL Files x
1.2.1. Generating Byte-Code Jam™ STAPL Files 1.2.2. List of Supported .jam and .jbc Actions and Procedures 1.2.3. Jam™ STAPL Player and quartus_jli Exit Codes
1.2.2. List of Supported .jam and .jbc Actions and Procedures x
1.2.2.1. Definitions of .jam and .jbc Action and Procedure Statements
1.4. Using the quartus_jli Command-Line Executable x
1.4.1. Command-line Syntax of quartus_jli Command-Line Executable
1.5. Using Jam™ STAPL for ISP with an Embedded Processor x
1.5.1. Methods to Connect the JTAG Chain to the Embedded Processor
1.5.1. Methods to Connect the JTAG Chain to the Embedded Processor x
1.5.1.1. Connecting the Embedded Processor Directly to the JTAG Chain 1.5.1.2. Connecting the JTAG Chain to an Existing Bus Using an Interface Device
1.6. Board Layout x
1.6.1. Treat the TCK Signal Trace as a Clock Tree 1.6.2. Use a Pull-Down Resistor on the TCK Signal 1.6.3. Make the JTAG Signal Traces as Short as Possible 1.6.4. Add External Resistors to Pull the Outputs to a Defined Logic Level
1.7. Embedded Jam™ STAPL Players x
1.7.1. The Jam™ STAPL Byte-Code Player 1.7.2. Steps to Port the Jam™ STAPL Byte-Code Player 1.7.3. Jam™ STAPL Byte-Code Player Memory Usage
1.7.2. Steps to Port the Jam™ STAPL Byte-Code Player x
1.7.2.1. Step 1: Set the Preprocessor Statements to Exclude Extraneous Code 1.7.2.2. Step 2: Map the JTAG Signals to the Hardware Pins 1.7.2.3. Step 3: Handle Text Messages from jbi_export() 1.7.2.4. Step 4: Customize Delay Calibration
1.7.3. Jam™ STAPL Byte-Code Player Memory Usage x
1.7.3.1. Estimating ROM Usage 1.7.3.2. Estimating Dynamic Memory Usage 1.7.3.3. Example of Calculating DRAM Required by Jam™ STAPL Byte-Code Player
1.7.3.1. Estimating ROM Usage x
1.7.3.1.1. Algorithm File Size Constants 1.7.3.1.2. Compressed and Uncompressed Data Size Constants 1.7.3.1.3. Jam™ STAPL Byte-Code Player Size
1.8. Updating Devices Using Jam x
1.8.1. jbi_execute Parameters 1.8.2. Running the Jam™ STAPL Byte-Code Player
1. Using the Command-Line Jam™ STAPL Solution for Device Programming

1.2.2.1. Definitions of .jam and .jbc Action and Procedure Statements

Table 3.  Definitions of .jam Action Statements
Action Description
Program Programs the device.
Blankcheck Checks the erased state of the device.
Verify Verifies the entire device against the programming data in the .jam or .jbc.
Erase Performs a bulk erase of the device.
Read_usercode Returns the JTAG USERCODE register information from the device.
Configure Configures the device.
Init_configuration Specifies that the configuration device configures the attached devices immediately after programming.
Check_idcode Compares the actual device IDCODE with the expected IDCODE generated in the .jam and .jbc.
Table 4.  Definitions of .jam Procedure Statements
Procedure Description
do_blank_check When enabled, the device is blank-checked.
do_secure When enabled, the security bit of the device is set.
do_read_usercode When enabled, the player reads the JTAG USERCODE of the device and prints it to the screen.
do_disable_isp_clamp When enabled, the ISP clamp mode of the device is ignored.
do_low_temp_programming When enabled, the procedure allows the industrial low temperature ISP for MAX® 3000A, 7000B, and 7000AE devices.
do_bypass_cfm When enabled, the procedure performs the specified action only on the user flash memory (UFM).
do_bypass_ufm When enabled, the procedure performs the specified action only on the configuration flash memory (CFM).
do_real_time_isp When enabled, the real-time ISP feature is turned on for the ISP action being executed.
do_init_configuration When enabled, the configuration device configures the attached device immediately after programming.
do_halt_on_chip_cc When enabled, the procedure halts the auto-configuration controller to allow programming using the JTAG interface. The nSTATUS pin remains low even after the device is successfully configured.
do_ignore_idcode_errors When enabled, the procedure allows configuration of the device even if an IDCODE error exists.
do_erase_all_cfi When enabled, the procedure erases the common flash interface (CFI) flash memory that is attached to the parallel flash loader (PFL) of the MAX® 10, MAX® V, or MAX® II device.
do_epcs_unprotect When enabled, the procedure removes the protection mode of the serial configuration devices (EPCS).
do_verify When Enabled, during Programming, the data is verified
do_bypass_icb By default, operations will be targeted on fullchip (except read back). However if this procedure is enabled, ICB settings will be excluded.
do_bypass_cfm1 By default, operations will be targeted on fullchip (except read back). However if this procedure is enabled, CFM1 sector (if present) will be excluded.
do_force_sram_download When this option is set, CRAM is upgraded (= internal reconfiguration) automatically on the timing pof was loaded to CFM. This option is used with real_time_isp.
Level Two Title