Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 12/12/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

4.1.25.4. periph::get_location_info (::quartus::periph)

The following table displays information for the periph::get_location_info Tcl command:

Tcl Package and Version

Belongs to ::quartus::periph

Syntax periph::get_location_info [-h | -help] [-long_help] [-children] [-gid] [-name] [-parents] [-placed_cells] [-properties] [-type] <location_id>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-children Query the children location IDs
-gid Query the gid of the location IDs
-name Return the location name of the location id
-parents Query the parent location IDs
-placed_cells Return the placed cells at the location id
-properties Return the device location properties in json
-type Return the location type of the location id
<location_id> location id
Description
Gets information about the specified location (referenced by location ID).
You can obtain location using the periph::get_locations Tcl command or
using the periph::get_cell_info -location Tcl command
Example Usage
project_open onewire_nf

blueprint::initialize
periph::update_plan

foreach cell [periph::get_cells -placed] {
	puts "Found cell ID $cell named [periph::get_cell_info -name $cell] placed in location [periph::get_cell_info -location $cell] named [periph::get_location_info -name [periph::get_cell_info -location $cell]]"
}
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: The supplied location id <string> is invalid.
TCL_ERROR 1 ERROR: The supplied type <string> is invalid.
TCL_ERROR 1 ERROR: At least one device location ID must be supplied, but no location IDs were supplied
TCL_ERROR 1 ERROR: At least one type must be supplied, but no types were supplied
TCL_ERROR 1 ERROR: <string> location IDs were expected but <string> were supplied
TCL_ERROR 1 ERROR: <string> types were expected but <string> were supplied