Programming Support for Jam STAPL Language

Jam Standard Test and Programming Language (STAPL) meets the necessary system requirements of in-system programming via an embedded processor, as it offers small file sizes, ease of use, and platform independence. Using Jam STAPL for in-system programming via an embedded processor permits convenient in-field upgrades, easy design prototyping, and fast production. These benefits lengthen the life and enhance the quality and flexibility of end-products. It can also reduce device inventories by eliminating the need to stock and track programmed devices.

How It Works

Using Jam STAPL for in-system programming via an embedded processor takes place in two stages (as shown in Figure 1). First, the Quartus® II development tool generates the Jam STAPL source code, or Jam File (.jam), then stores it in the system memory. The Jam File contains all information required to program the in-system programmability (ISP)-capable device(s), including the programming algorithm and data needed to upgrade one or more devices.

Figure 1. In-system programming using the Jam File & Jam Player via an embedded processor.

About the Jam File (.jam)

To program Intel FPGA devices using Jam STAPL, designers must first create a Jam File with the Quartus II development software. It is not necessary to recompile existing designs, because the Quartus II software can create a Jam File from a Programmer Object File (.pof). To store a Jam File in erasable programmable read-only memory (EPROM) or Flash memory, it must be converted first to a Hexadecimal (Intel-format) File (.hex) or a similar programming file. Embedded processor software packages or other utilities can automatically convert a Jam File for EPROM or Flash programming. Similarly, some EPROM programmers support "raw binary" or "absolute binary" formats, which allow the Jam File to be read directly by the programmer without conversion.

Figure 2 describes how to generate a Jam File for in-system programming.

Figure 2. Generating a Jam File.

About the Jam Player

The Jam Player is a C program that parses the Jam File, interprets each Jam STAPL instruction, and reads and writes data to and from the JTAG chain. The variables processed by the Jam Player depend on the initialization list variables present at the time of execution. Because each application has unique requirements, the Jam Player source code can be modified easily.

Figure 3 illustrates the Jam Player source code structure.

Figure 3. Jam Player source code structure.

Note:

1. TCK, TMS, TDI, and TDO are the JTAG I/O pins.

The main program performs all of the basic functions of the Jam Player without modification. Only the I/O functions must be modified. They are contained in the jamstub.c file, as shown in Figure 3, and include functions which specify addresses to I/O pins, delay routines, operating system-specific functions, and routines for file I/O pins. These functions can be customized by simply editing the jamstub.c file to then compile the source code for use on any platform.

The Jam Player resides permanently in system memory, where it interprets the commands given in the Jam File and generates a binary data stream for device programming. This structure confines all upgrades to the Jam File, and it allows the Jam Player to adapt to any system architecture.

Frequently Asked Questions

• Can I use the Jam™ Standard Test and Programming Language (STAPL) Player or Jam STAPL Byte-Code Player with older versions of Jam Files (.jam) and Jam STAPL Byte-Code Files (.jbc)?
• Why do I get a "Device Programming Failure" error when programming devices using the stand-alone DOS Jam STAPL Player with the ByteBlaster® II download cable but not when using the Quartus® II Programmer?
• When programming devices with the Jam™ standard test and programming language (STAPL) files, how do I set the security bits?

The Jam Standard Test and Programming Language (STAPL) was created by Intel® FPGA engineers and is supported by a consortium of programmable logic device (PLD) manufacturers, programming equipment makers, and test equipment manufacturers. Jam STAPL was adopted as JEDEC standard JESD-71 in August, 1999.

Jam STAPL addresses the issues that designers face when programming PLDs in-system. These issues include proprietary file formats, vendor-specific programming algorithms, large file sizes, and long programming times. Jam STAPL is a major step forward in providing a software-level standard for in-system programming (ISP).

How Jam STAPL Works

The Jam STAPL programming solution consists of two components: the Jam Composer and the Jam Player.

The Jam Composer is a software program, generally written by a programmable logic vendor that writes a Jam File (.jam) that contains the user data and programming algorithm required to program a design into a device.

The Jam Player is software that reads the Jam File and applies vectors for programming and testing devices in a JTAG chain. Embedded system developers can also use a Jam Player to program devices in their system. Most of the source code required for the Jam Player is contained in the Jam STAPL Developer's Kit available from the Jam STAPL web site. The only software routines required to complete the Jam Player are those needed to access the JTAG chain. Figure 1 shows a basic Jam STAPL flow.

Documentation

• Using Jam STAPL for ISP via an embedded processor chapter of the MAX® II Handbook
• JTAG & In-System programmability chapter of the MAX II Handbook
• AN 95: In-System programmability in MAX® devices

Frequently Asked Questions

• Can I use the Jam STAPL player or Jam STAPL Byte-Code player with older versions of .jam and .jbc?
• How can I determine the contents of the Jam STAPL Byte-Code file (.jbc)?
• Does the Jam STAPL player and the Jam STAPL Byte-Code player support the MasterBlaster™ download cable?
• Does the Jam STAPL player version 2.3 support the USB-Blaster™ download cable?