Scripting

get_editable_mem_instances


The following table displays information for the get_editable_mem_instances Tcl command:

Tcl Package and Version

Belongs to ::quartus::insystem_memory_edit 1.0

Syntax

get_editable_mem_instances [-h | -help] [-long_help] -device_name <device name> -hardware_name <hardware name>

Arguments

-h | -help

Short help

-long_help

Long help with examples and possible return values

-device_name <device name>

Name of the device that holds the editable memory instances

-hardware_name <hardware name>

Name of the hardware that connects to the JTAG chain

Description

Retrieve a list of editable memory, ROM, or
lpm_constant instances.

A list is returned, each element of which shows the
configuration of each instance.  This element is an
another list that specifies the configuration in the
following order: <instance index> <depth> <width>
<read/write mode> <instance type> <instance name>. The
<read/write mode> can be either "RW" or "W"; <instance
type> can be either "ROM/RAM" or "CONSTANT". An
example showing a list of two instances of different
types is shown below:

{0 1024 8 RW ROM/RAM mem0} {1 1 32 RW CONSTANT con0}

The hardware and device name can be obtained with the
get_hardware_names and get_device_names commands from
the jtag package.

It is recommended that you call this command before
the TCL command, begin_memory_edit.  Within a memory
edit sequence, this command can be applied only to the
same device, on which the memory edit sequence has
started.

Example Usage

# List information of all editable memories
puts "Information on all editable memories:"
puts "index,depth,width,mode,type,name"
foreach instance [get_editable_mem_instances -hardware_name "USB-Blaster \[USB-0\]" -device_name "@1: EP1S25/_HARDCOPY_FPGA_PROTOTYPE (0x020030DD)"] {
	puts "[lindex $instance 0],[lindex $instance 1],[lindex $instance 2],[lindex $instance 3],[lindex $instance 4],[lindex $instance 5]"
}

Return Value

Code Name

Code

String Return

TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: The specified device is not found.
TCL_ERROR 1 ERROR: The specified hardware is not found.
TCL_ERROR 1 ERROR: The TCL command get_editable_mem_instances is called within a memory edit sequence for a different device. End the memory edit first.
TCL_ERROR 1 ERROR: An internal TCL interpreter error occurred.