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. List of Supported .jam and .jbc Actions and Procedures

A .jam or .jbc consists two types of statements: action and procedure.
  • Action—a sequence of steps required to implement a complete operation.
  • Procedure—one of the steps contained in an action statement.

An action statement can contain one or more procedure statements or no procedure statement. For action statements that contain procedure statements, the procedure statements are called in the specified order to complete the associated operation. You can specify some of the procedure statements as "recommended" or "optional" to include or exclude them in the execution of the action statement.

Table 2.  Supported .jam or .jbc Actions and Optional Procedures for Each Action in Altera® Devices

Devices

(.jam)/(.jbc) Action

Optional Procedures

(Off by default)

MAX® 3000A

MAX® 7000B

MAX® 7000AE

Program
  • do_blank_check
  • do_secure
  • do_low_temp_programming
  • do_disable_isp_clamp
  • do_read_usercode
Blankcheck do_disable_isp_clamp
Verify
  • do_disable_isp_clamp
  • do_read_usercode
Erase do_disable_isp_clamp
Read_usercode —

MAX® II

MAX® V

MAX® 10 FPGA

Program
  • do_blank_check
  • do_secure
  • do_disable_isp_clamp
  • do_bypass_cfm
  • do_bypass_ufm
  • do_real_time_isp
  • do_read_usercode
  • do_verify
  • do_force_sram_download
  • do_bypass_icb 1
  • do_bypass_cfm11
Blankcheck
  • do_disable_isp_clamp
  • do_bypass_cfm
  • do_bypass_ufm
  • do_real_time_isp
  • do_force_sram_download
  • do_bypass_icb1
  • do_bypass_cfm11
Verify
  • do_disable_isp_clamp
  • do_bypass_cfm
  • do_bypass_ufm
  • do_real_time_isp
  • do_read_usercode
  • do_force_sram_download
  • do_bypass_icb1
  • do_bypass_cfm11
Erase
  • do_disable_isp_clamp
  • do_bypass_cfm
  • do_bypass_ufm
  • do_real_time_isp
  • do_force_sram_download
  • do_bypass_icb1
  • do_bypass_cfm11
  • do_blank_check
Read_usercode —

Stratix® device family

Arria® device family

Cyclone® device family

Configure
  • do_read_usercode
  • do_halt_on_chip_cc
  • do_ignore_idcode_errors
Read_usercode —

Enhanced Configuration Devices

 Program
  • do_blank_check
  • do_secure
  • do_read_usercode
  • do_init_configuration
Blankcheck —
Verify do_read_usercode
Erase —
Read_usercode —
Init_configuration —

Serial Configuration Devices

 Configure
  • do_read_usercode
  • do_halt_on_chip_cc
  • do_ignore_idcode_errors
Program
  • do_blank_check
  • do_epcs_unprotect
Blankcheck —
Verify —
Erase —
Read_usercode —

Section Content
Definitions of .jam and .jbc Action and Procedure Statements

1 Applicable in MAX® 10 FPGA only.
Level Two Title