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 Display a List of Available Download Cables in a Machine Display Header File Information in a Jam File Configure and Return JTAG USERCODE of an FPGA Device
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.4.1. Command-line Syntax of quartus_jli Command-Line Executable

To specify which programming hardware or cable to use when performing an action statement, use this command syntax: 
quartus_jli -a<action name> -c<cable index> <filename>.jam
To enable a procedure associated with an action statement, use this command syntax: 
quartus_jli -a<action name> -e<procedure to enable> -c<cable index> <filename>.jam
To disable a procedure associated with an action statement, use this command syntax: 
quartus_jli -a<action name> -d<procedure to disable> -c<cable index> <filename>.jam
To program serial configuration devices with the quartus_jli command-line executable, use the following commands: 
quartus_jli -aconfigure <filename>.jam
quartus_jli -aprogram <filename>.jam
To get more information about an option, use this command syntax: 
quartus_jli --help=<option|topic>

The following examples show the command-line syntax to run the quartus_jli command-line executable.

Display a List of Available Download Cables in a Machine

To display a list of available download cables on a machine as shown in the following figure, at the command prompt, type this command: 
quartus_jli –n
Figure 5. Display of the Available Download CablesNumbers 1) and 2) in the figure are the cable index numbers. In the command, replace <cable index> with the index number of the relevant cable


Display Header File Information in a Jam File

To display the header file information in a .jam when executing an action statement, use this command syntax: 
quartus_jli -a<action name> <filename>.jam -l
Figure 6. Header File Information of a Jam File when Executing an Action Statement


Configure and Return JTAG USERCODE of an FPGA Device

To configure and return the JTAG USERCODE of an FPGA device using the second download cable on the machine with a specific .jam, at the command prompt, type this command: 
quartus_jli -aconfigure -edo_read_usercode -c2 <filename>.jam
Figure 7. Configuring and Reading the JTAG USERCODE of the EP2C70 Device Using the USB-Blaster Cable


Level Two Title