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.9. Document Revision History for AN 425: Using the Command-Line Jam™ STAPL Solution for Device Programming

Document Version Changes
2024.10.14 Text edits only; no new technical information.
Date Version Changes
April 2017 2017.04.10
  • Added optional .jam procedures in Supported .jam or .jbc Actions and Optional Procedures for Each Action in Altera Devices.
  • Added .jam procedure statement and description in Definitions of .jam Procedure Statements.
December 2016 2016.12.09 Updated the typical jam STAPL byte-code data size for MAX V and MAX 10 devices in Data Constants for Altera Devices Supporting the Jam Language (for ISP) table.
September 2014 2014.09.22
  • Added information for MAX 10 devices.
  • Added the "do_epcs_unprotect" optional .jam procedure for serial configuration devices to disable EPCS protection mode.
  • Restructured and rewrote several sections for clarity and style update.
  • Updated template.
December 2010 5.0
  • Changed chapter and topic titles ("Differences Between the Jam STAPL Players and quartus_jli" on page 2, "ASCII Text Files" on page 3, "Byte-Code Files" on page 3, "Generating Jam STAPL Files" on page 3, "Using the quartus_jli Command-Line Executable" on page 10, and "Embedded Jam STAPL Players" on page 16).
  • Updated all screenshots.
  • Updated several table and figure titles (minor text changes).
  • Added information for MAX V devices.
  • Corrected text errors in Figure 9.
  • Updated codes in "Step 2: Map the JTAG Signals to the Hardware Pins" and "Updating Devices Using Jam".
  • Updated equations for clarity. Involves changes in equations numbering throughout the document.
  • Corrected minor error in "Notes to Table 9:" on page 23.
  • Removed "Conclusion" chapter.
  • Major text edits throughout the document.
July 2010 4.0

Technical publication edits. Updated screen shots.
July 2009 3.0

Technical publication edits only. No technical content changes.
August 2008 2.1
  • Added new paragraph: "Updating Devices Using Jam".
  • Updated Table 3.
  • Updated Table 1.
November 2007 2.0
  • Updated "Introduction".
  • Added new sections: "Jam STAPL Players", "Jam STAPL Files", "Using the Jam STAPL for ISP via an Embedded Processor", "Embedded Jam Players", and "Updating Devices Using Jam".
December 2006 1.1
  • Changed chapter title.
  • Updated "Introduction" section.
  • Updated "Differences Between Jam STAPL Player and quartus_jli Command-Line Executable".
  • Updated Figure 6, Figure 7, and Figure 8.
Level Two Title