get_pkgpin_bytegroups - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2024.1 English

Get a list of package pin byte groups.


get_pkgpin_bytegroups [‑regexp] [‑nocase] [‑filter <arg>]
    [‑of_objects <args>] [‑quiet] [‑verbose] [<patterns>]




Name Description
[-regexp] Patterns are full regular expressions
[-nocase] Perform case-insensitive matching. (valid only when -regexp specified)
[-filter] Filter list with expression
[-of_objects] Get the pin_group of these package_pins, iobank, site, or port.
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<patterns>] Match pin_group against patterns Default: *


Device, XDC, Object


Gets a list of the byte groups on the I/O banks of the current AMD UltraScale™ device.

For 7 series devices, the hierarchy of IO Banks is divided into two object types: I/O Banks and Package Pins. For AMD UltraScale FPGA devices, the IO Bank hierarchy includes two additional divisions: Byte groups and Nibbles.

The relationships of these objects on an UltraScale device are defined as follows:

  • An iobank has 2 or 4 bytegroups.
  • Each pkgpin_bytegroup has 2 nibbles, an upper and lower, and has 13 package pins.
  • Each pkgpin_nibble has 6 or 7 pins, and is the upper or lower nibble of the pkgpin_bytegroup.
  • A package_pin is one pin of an iobank, a pkgpin_bytegroup, or a pkgpin_nibble.
Note: To improve memory and performance, the get_* commands return a container list of a single type of objects (e.g. cells, nets, pins, or ports). You can add new objects to the list (using lappend for instance), but you can only add the same type of object that is currently in the list. Adding a different type of object, or string, to the list is not permitted and will result in a Tcl error.


-regexp - (Optional) Specifies that the search <patterns> are written as regular expressions. Both search <patterns> and -filter expressions must be written as regular expressions when this argument is used. Xilinx® regular expression Tcl commands are always anchored to the start of the search string. You can add ".*" to the beginning or end of a search string to widen the search to include a substring. See for help with regular expression syntax.
Note: The Tcl built-in command regexp is not anchored, and works as a standard Tcl command. For more information refer to

-nocase - (Optional) Perform case-insensitive matching when a pattern has been specified. This argument applies to the use of -regexp only.

-filter <args> - (Optional) Filter the results list with the specified expression. The -filter argument filters the list of objects returned by get_pkgpin_bytegroup based on property values on the objects. You can find the properties on an object with the report_property or list_property commands. In the case of the pkgpin_bytegroup object, "NAME", and "IOBANK" are two of the properties that can be used to filter results.

The filter search pattern should be quoted to avoid having to escape special characters. String matching is case-sensitive and is always anchored to the start and to the end of the search string. The wildcard “*” character can be used at the beginning or at the end of a search string to widen the search to include a substring of the property value.
Note: The filter returns an object if a specified property exists on the object, and the specified pattern matches the property value on the object. In the case of the "*" wildcard character, this will match a property with a defined value of "".
For string comparison, the specific operators that can be used in filter expressions are "equal" (==), "not-equal" (!=), "match" (=~), and "not-match" (!~). Numeric comparison operators <, >, <=, and >= can also be used. Multiple filter expressions can be joined by AND and OR (&& and ||). The following gets input pins that do NOT contain the “RESET” substring within their name:
get_pins * -filter {DIRECTION == IN && NAME !~ "*RESET*"}
Boolean (bool) type properties can be directly evaluated in filter expressions as true or not true:

-of_objects <arg> - (Optional) Get the pkgpin_bytegroups of the specified iobank, site, port, or package_pin objects.

Note: The -of_objects option requires objects to be specified using the get_* commands, such as get_cells or get_pins, rather than specifying objects by name. In addition, -of_objects cannot be used with a search <pattern>.
-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.

<patterns> - (Optional) Match pkgpin_bytegroups against the specified patterns. The default pattern is the wildcard '*' which returns all pkgpin_bytegroups. More than one pattern can be specified to find multiple pins based on different search criteria.


The following example gets a list of all pins on the package of the target device:

get_pkgpin_bytegroups -of [get_iobanks 44]