Intel® Quartus® Prime Pro Edition User Guide: Scripting

ID 683432
Date 10/04/2021

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

Document Table of Contents periph::get_cells (::quartus::periph)

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

Tcl Package and Version

Belongs to ::quartus::periph

Syntax periph::get_cells [-h | -help] [-long_help] [-atom_only] [-instance_only] [-ip_only] [-num_location <num_location> ] [-physical_only] [-placed] [-toplevel_only] [-type <type> ] [-unplaced] [ <filter> ]
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-atom_only Return only atom cells
-instance_only Return only instance cells
-ip_only Return only instance cells that are IP instances
-num_location <num_location> Specify a specific number of available locations the cell should have
-physical_only Return only physical cells
-placed Return only placed cells
-toplevel_only Return only toplevel cells
-type <type> Return only cells of the given types
-unplaced Return only unplaced cells
<filter> Object filter

Returns a list of cells IDs in the design. All cell names in the collection match the specified pattern. Wildcards can be used to select multiple cells at once. When you use the wildcard matching, use pipe characters to separate one hierarchy level from the next. They are treated as special characters and are taken into account when string matching with wildcards is performed. When this matching scheme is enabled, the specified pattern is matched against absolute cell names: the names that include the entire hierarchical path. A full cell name can contain multiple pipe characters in it to reflect the hierarchy. All hierarchy levels in the pattern are matched level by level. Any included wildcards refer to only one hierarchical level. For example, "*" and "*|*" produce different collections since they refer to the highest hierarchical level and second highest hierarchical level respectively.

Example Usage
project_open onewire_nf


foreach cell [periph::get_cells -type IO_CLUSTER] {
	puts "Found cell ID $cell named [periph::get_cell_info -name $cell]"
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: The supplied number of locations <string> is invalid.
TCL_ERROR 1 ERROR: <string> number of locations were expected but <string> were supplied