auto_detect_xpm - 2023.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2023.2 English

Auto detect the XPM Libraries that are used in the design and set the XPM_LIBRARIES project property.


auto_detect_xpm [‑quiet] [‑verbose]


Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution


FileIO, Project


This command collects the list of Xilinx™ Parameterized Macros (XPM) used in RTL design files and sets the XPM_LIBRARIES property. Because it identifies XPM used in the RTL source files, it must be used after the RTL files are read or added to the design as shown in the example.

Tip: This command is intended for use in non-project mode, and is not needed for project-based flows.

This command will find all the XPMs used in the user RTL and update the XPM_LIBRARIES property on the current project. Synthesis and simulation will use the XPM_LIBRARIES property to properly support these macros.

This command returns nothing, or returns an error if it fails.


-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.


The following example reads the specified RTL file, and then uses auto_detect_xpm to define the XPM_LIBRARIES used in the files:

read_verilog ../top_bgRAM_173_0.v
read_xdc ../top_bgRAM_173_0.xdc