Visible to Intel only — GUID: sam1408427225843
Ixiasoft
1.8.1. jbi_execute Parameters
| Parameter | Status | Description |
|---|---|---|
| program | Mandatory | A pointer to the .jbc. For most embedded systems, setting up this parameter is as easy as assigning an address to the pointer before calling jbi_execute(). |
| program_size | Mandatory | Amount of memory (in bytes) that the .jbc occupies. |
| workspace | Optional | A pointer to dynamic memory that can be used by the Jam STAPL Byte-Code Player to perform its necessary functions. The purpose of this parameter is to restrict the player memory usage to a predefined memory space. This memory must be allocated before calling jbi_execute(). If the maximum dynamic memory usage is not a concern, set this parameter to null, which allows the player to dynamically allocate the necessary memory to perform the specified action. |
| workspace_size | Optional | A scalar representing the amount of memory (in bytes) to which workspace points. |
| action | Mandatory | A pointer to a string (text that directs the Jam STAPL Byte-Code Player). Example actions are PROGRAM or VERIFY. In most cases, this parameter is set to the string PROGRAM. The text can be in upper or lower case because the player is not case-sensitive. The Jam STAPL Byte-Code Player supports all actions defined in the Jam STAPL Specification. Take note that the string must be null-terminated. |
| init_list | Optional | An array of pointers to strings. Use this parameter when applying Jam version 1.1 files, or when overriding optional sub-actions. Altera recommends using the STAPL-based .jbc with init_list. When you use a STAPL-based .jbc, init_list must be a null-terminated array of pointers to strings. |
| error_address | — | A pointer to a long integer. If an error is encountered during execution, the Jam STAPL Byte-Code Player records the line of the .jbc where the error occurred. |
| exit_code | — | A pointer to a long integer. Returns a code if there is an error that applies to the syntax or structure of the .jbc. If this kind of error is encountered, the supporting vendor must be contacted with a detailed description of the circumstances in which the exit code was encountered. |