get_waivers - 2024.1 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
UG835
Release Date
2024-05-30
Version
2024.1 English

Get one or more DRC/METHODOLOGY/CDC/LINT message waivers

Syntax

get_waivers [‑type <arg>] [‑id <arg>] [‑of_objects <args>] [‑regexp]
    [‑filter <arg>] [‑nocase] [‑quiet] [‑verbose] [<patterns>]

Returns

Waivers

Usage

Name Description
[-type] Type of waiver - DRC, METHODOLOGY, CDC, LINT, ALL
[-id] ID of the DRC/METHODOLOGY/CDC/LINT message being waived
[-of_objects] List of objects (cells, nets, pins, sites, etc.) for which DRC/METHODLOGY/CDC/LINT waiver(s) were set
[-regexp] Patterns are full regular expressions
[-filter] Filter list with expression
[-nocase] Perform case-insensitive matching (valid only when -regexp specified)
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<patterns>] Match waiver names against patterns Default: * Values: The default search pattern is the wildcard *, or .* when -regexp is specified.

Categories

Waiver, Object

Description

The create_waiver command lets you select individual DRC, methodology, or CDC violations or rule checks that can be waived for a design, letting you move forward in the design flow. The get_waivers command lets you query the defined waiver objects in the current design.

A waiver must be specified for an individual DRC or methodology violation, or for a specific DRC or methodology check, or for a CDC path. The waiver must be assigned to a specific object, or specific violation ID, or for paths using -from/-to arguments. You can format the get_waivers command to return the specific types of waivers you are looking for, or waivers associated with specific objects.

You can report the waivers defined in the current design with report_waivers, and remove waivers from the design using delete_waivers.

Arguments

-type <arg> - (Optional) Specifies the type of waiver to get. Currently supports DRC, METHODOLOGY, and CDC.

-id <arg> - (Optional) Specifies the ID of the check or violation associated with the waiver.

-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 http://perldoc.perl.org/perlre.html 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 http://www.tcl.tk/man/tcl8.5/TclCmd/regexp.htm.

-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_waivers based on property values on the waivers. You can find the properties on an object with the report_property or list_property commands. In the case of the waivers object, "NAME", "OBJECT_COUNTS" and "TYPE" are some 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:
-filter {IS_PRIMITIVE && !IS_LOC_FIXED}

-of_objects <arg> - (Optional) Get the waivers associated with the specified objects (cells, nets, pins, sites, etc.).

-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 waivers against the specified search pattern. The default pattern is the wildcard '*' which gets a list of all waivers in the project.

Examples

This example gets any waivers in the current design:

get_waivers

The following example gets all DRC check waivers:

get_waivers -type DRC *

The following example gets all waivers associated with the specified objects:

get_waivers -of_objects [get_ports {src_in* dest_out*}]