API Functions: Interface Designer

This section provides an alphabetical list of API functions used for the Interface Designer.

assign_pkg_pin()

Usage	`assign_pkg_pin(inst, pin_name)`
Parameters	`inst`: The block's object ID or instance name. `pin_name`: GPIO pin name.
Import	DesignAPI
Description	Assign the specified GPIO to the resource associated with the specified package pin.

assign_resource()

Usage	`assign_resource(inst, res_name, block_type)`
Parameters	`inst`: The block's object ID or instance name. `res_name`: Resource name, enclose in double quotes. `block_type`: Type of block. If `inst` is an instance name, indicate the block type. The default is `GPIO`.
Import	DesignAPI
Description	Assign a resource to a GPIO or other block.

auto_calc_pll_clock()

Usage auto_calc_pll_clock(inst, target_freq=None, apply_optimal=True, result_len)

Parameters

inst: A PLL instance block object id or an instance name.

target_freq: A map of output frequency parameters in MHz. The parameters depend on the PLL you are using. If you do not include a parameter, the software uses the default setting.

PLL V3	PLL V2	PLL V1
CLKOUTn_FREQ CLKOUTn_PHASE CLKOUTn_DYNPHASE_EN where n is 0, 1, 2, 3, or 4	CLKOUTn_FREQ CLKOUTn_PHASE where n is 0, 1, or 2	CLKOUTn_FREQ where n is 0, 1, or 2

result_len: Number of results. 0 returns all results. The default is None which returns 5 results.

apply_optimal: When True, apply optimal result counters to PLL, when False, does not.

Returns A list of PLL setting options, a list of property maps.

Import DesignAPI

Description Given desired output clock frequency in MHz (and/or phase in degree), this function sets the required counters and output divider. See PLL Property Reference.

auto_calc_quad_clock()

Usage	`auto_calc_quad_clock(inst)`
Parameters	`inst`: A PMA Direct instance block object id or an instance name.
Returns	The calculated serial clock frequency in GHz formatted as a string or None if the calculation is invalid.
Import	DesignAPI
Description	This function applies to the transceiver's internal PLL when using the transceiver in PMA Direct mode. Calculate the achievable serial and data rate frequency based on the combination of the instance data rate, data width, and reference clock frequency. You can only use this function if the instance's reference clock mode property (MODE) is Custom (see Table 11).

calc_pll_clock()

Usage	`calc_pll_clock(inst)`
Parameters	`inst`: A PLL instance block object id or an instance name.
Returns	Calculated frequencies property map.
Import	DesignAPI
Description	Calculates the VCO frequency, PLL frequency, and all enabled output clock frequencies. You should configure the M, N, and O counters and output dividers before using this function. See PLL Property Reference.

check_design()

Usage	`check_design()`
Parameters	None.
Returns	Boolean `True` (if passes) or `False` (if fails).
Import	DesignAPI
Description	Performs a design rule check. For Python to print errors, set `is_verbose()` to `True`. See Elements of a Python Script.

clear_design()

Usage	`clear_design(block_types)`
Parameters	`block_type`: The block type strings, enclose in double quotes. Refer to Block Types and Device Settings for the supported blocks. Default is `None` which removes all the instances in the design.
Import	DesignAPI
Description	By default, all the instances of specific block_types will be removed; otherwise, all the instances in the design will be removed.

clean_output()

Usage	`clean_output()`
Parameters	None.
Import	DesignAPI
Description	Cleans the generated output files in the project's outflow directory.

create()

Usage	`create(design_name, device_name, path, auto_save, overwrite)`
Parameters	`design_name`: Efinity project name, enclose in double quotes. `device_name`: Name and package for the target FPGA, enclose in double quotes. For example, T20F256. This must be the same name you specified for the project in the Efinity Project Editor. `path`: Location to store the design file, enclose in double quotes. `auto_save`: Boolean `True` or `False` (default). If set to `True`, the design writes the file at the specified location. `overwrite`: Boolean `True` or `False` (default). If `auto_save` is `True`, overwrites the file if it exists at the specified location.
Import	DesignAPI
Description	Create a new interface design. After you create the design, call the `save()` function to save the file to disk.

create_block()

Usage	`create_block(name, block_type, **kwargs`¹`)`
Parameters	`name`: Name of the block, enclose in double quotes. `block_type`: The block type, enclose in double quotes. Refer to Block Types and Device Settings for the supported blocks. MIPI Lane TX and RX: `mode`: Defines a clock lane (`CLOCK_LANE`) or data lane (`DATA_LANE`). If you do not specify the parameter, the software defaults to `DATA_LANE`. `conn_type`: For the MIPI Lane RX, indicate whether you want to connect to the global network (GCLK) or regional network (RCLK). If you do not specify the parameter, the software defaults to `GCLK`. LVDS: `tx_mode`: For LVDS_TX blocks and LVDS_BIDIR blocks, specify whether the block is data (DATA) or clock out (CLKOUT). If you do not specify the parameter, the software defaults to `DATA`. `rx_conn_type`: For LVDS_RX blocks and LVDS_BIDIR blocks, specify the connection type for the LVDS RX. `NORMAL` (default)), `GCLK`, `RCLK`, `PLL_CLKIN`, `PLL_EXTFB`. PMA Direct, Ethernet XGMII, Ethernet SGMII: `cmn_name`: Specify the common instance name for the transceiver lanes in the quad.
Returns	The object ID of the new block.
Import	DesignAPI
Description	Create a new block instance of the specified type. Do not use `create_block()` for GPIO, instead use one of the `create_<type>_gpio()` blocks.

create_clockout_gpio()

Usage	`create_clockout_gpio(name)`
Parameters	`name`: The GPIO name, enclose in double quotes.
Returns	The GPIO object ID.
Import	DesignAPI
Description	Create an output clock GPIO (`clkout`).

create_global_control_gpio()

Usage	`create_global_control_gpio(name)`
Parameters	`name`: The GPIO name, enclose in double quotes.
Returns	The GPIO object ID.
Import	DesignAPI
Description	Create a global control GPIO with connection type `GCTRL`.

create_inout_gpio()

Usage	`create_inout_gpio(name, msb, lsb)`
Parameters	`name`: GPIO name, enclose in double quotes. `msb`: Integer. If creating a bus, specify the MSB. The default is `None`. `lsb`: Integer. If creating a bus, specify the LSB. The default is `None`.
Returns	The object ID of the GPIO or bus.
Import	DesignAPI
Description	Create an inout GPIO. To create a bus, specify values for the MSB and LSB bits.

create_input_clock_gpio()

Usage	`create_input_clock_gpio(name)`
Parameters	`name`: The GPIO name, enclose in double quotes.
Returns	The GPIO object ID.
Import	DesignAPI
Description	Create an input clock GPIO with connection type `GCLK`.

create_input_gpio()

Usage	`create_input_gpio(name, msb, lsb)`
Parameters	`name`: GPIO name, enclose in double quotes. `msb`: Integer. If creating a bus, specify the MSB. The default is `None`. `lsb`: Integer. If creating a bus, specify the LSB. The default is `None`.
Returns	The object ID of the GPIO or bus.
Import	DesignAPI
Description	Create an input GPIO. To create a bus, specify values for the MSB and LSB bits.

create_mipi_input_clock_gpio()

Usage	`create_mipi_input_clock_gpio(name)`
Parameters	`name`: The GPIO name, enclose in double quotes.
Returns	The GPIO object ID.
Import	DesignAPI
Description	Create MIPI input clock GPIO (`mipi_clkin`) with connection type `MIPI_CLKIN`. This input clock is used with the Trion hard MIPI blocks.

create_open_drain_output_gpio()

Usage	`create_open_drain_output_gpio(name)`
Parameters	`name`: GPIO name, enclose in double quotes.
Returns	The object ID of the GPIO.
Import	DesignAPI
Description	Create an inout GPIO in open drain output configuration; the output is grounded. Constant output is set to 0 (GND).

create_output_gpio()

Usage	`create_output_gpio(name, msb, lsb)`
Parameters	`name`: GPIO name, enclose in double quotes. `msb`: Integer. If creating a bus, specify the MSB. The default is `None`. `lsb`: Integer. If creating a bus, specify the LSB. The default is `None`.
Returns	The object ID of the GPIO or bus.
Import	DesignAPI
Description	Create an output GPIO. To create a bus, specify values for the MSB and LSB bits.

create_pll_ext_fb_gpio()

Usage	`create_pll_ext_fb_gpio(name)`
Parameters	`name`: The GPIO name, enclose in double quotes.
Returns	The GPIO object ID.
Import	DesignAPI
Description	Create a PLL external feedback input GPIO (`pll_extfb_conn`) with connection type `PLL_EXTFB`.

create_pll_input_clock_gpio()

Usage	`create_pll_input_clock_gpio(name)`
Parameters	`name`: The GPIO name, enclose in double quotes.
Returns	The GPIO object ID.
Import	DesignAPI
Description	Create an input clock for the PLL (`pll_clkin`) with connection type `PLL_CLKIN`.

create_regional_input_clock_gpio()

Usage	`create_regional_input_clock_gpio(name)`
Parameters	`name`: The GPIO name, enclose in double quotes.
Returns	The GPIO object ID.
Import	DesignAPI
Description	Create a regional input clock GPIO with connection type `RCLK`.

create_unused_gpio()

Usage	`create_unused_gpio(name)`
Parameters	`name`: The GPIO name, enclose in double quotes.
Returns	The GPIO object ID.
Import	DesignAPI
Description	Create an unused GPIO.

create_vref_gpio()

Usage	`create_vref_gpio(name)`
Parameters	`name`: The GPIO name, enclose in double quotes.
Returns	A GPIO object id.
Import	DesignAPI
Description	Create a VREF GPIO.

delete_block()

Usage	`delete_block(inst, block_type)`
Parameters	`inst`: Block object ID or name. If you are deleting the block by name, enclose the name in double quotes. `block_type`: The block type; enclose in double quotes. the default is `JTAG`.
Import	DesignAPI
Description	Delete the specified block instance. if you use a name for `inst`, also specify the block type. For GPIO, use `delete_gpio()`.

delete_gpio()

Usage	`delete_gpio(inst)`
Parameters	`inst`: GPIO or bus object ID or name. If you are deleting the GPIO by name, enclose the name in double quotes. The API searches for GPIO first.
Import	DesignAPI
Description	Delete a GPIO block or GPIO bus block.

export_design()

Usage	`export_design(block_type, block_inst, isf_file, export_all_pin)`
Parameters	`block_type`: Optional. A comma-separated list of block types, enclose names in double quotes. The default is `None`. `block_inst`: Optional. A comma-separated list of instance names, enclose names in double quotes. For GPIO, you can specify a list of bus instances. The default is `None`. `isf_file`: Optional. User-specified path and filename. If you do not specify a name, the script creates the file <design>.isf in the project directory. `export_all_pin`: Optional. Export all pin names, including default auto-generated names. The default is `False`.
Import	DesignAPI
Description	Exports the interface design settings for the specified block type(s) or block instance(s) to an .isf file in the project directory. If you specify both `block_type` and `block_inst`, the block type takes precedence.

export_pcie_rp_outbound()

Usage	`remove_pcie_rp_outbound(inst, filename)`
Parameters	`inst`: The PCIe instance; enclose in double quotes. `filename`: Name of the .json file in which to save the region configuration settings.
Import	DesignAPI
Description	Export the specified PCIe root port outbound region settings to a file in .json format.

generate()

Usage	`generate(enable_bitstream, outdir)`
Parameters	`enable_bitsteam`: Boolean `True` or `False`. If `True`, generate the periphery bitstream file. `outdir`: Specify an optional output directory with path. The default, `None`, saves files in the project's outflow directory. Enclose in double quotes.
Import	DesignAPI
Description	Performs design checks and generates constraint and report files. Optionally generate a periphery bitstream file.

gen_pll_ref_clock()

Usage gen_pll_ref_clock(inst, **kwargs²)

Parameters

inst: PLL block

pll_res: PLL resource name, will overwrite existing resource if it exists.

refclk_name: GPIO instance name for reference clock.

Parameter	PLL	Description
`refclk_res`	V1	GPIO resource name for reference clock.
`refclk_name`	V1	GPIO instance name for reference clock.
`refclk_src`	V2, V3	Reference clock source type, CORE, EXTERNAL or DYNAMIC.
`ext_refclk_no`	V2, V3	External clock source number (V2: 0 or 1) (V3: 0, 1, 2³) for external clocks only.
`ext_refclk_type`	V3	Block name of the clock source. Options are GPIO (default), LVDS_RX, and LVDS_BIDIR.

Import DesignAPI

Description Generate a PLL reference clock. Note: the software automatically detects the GPIO resource. Refer to Example Scripts for examples. See PLL Property Reference for PLL property list..

get_all_block_name()

Usage	`get_all_block_name(block_type)`
Parameters	`block_type`: The block type; enclose in double quotes. the default is `GPIO`.
Returns	A list of the block names.
Import	DesignAPI
Description	Gets the names of all block instances for the specified block type.

get_all_block_version()

Usage	`get_all_block_version()`
Parameters	None.
Returns	Return a dict of block type to block version.
Import	DesignAPI
Description	Gets all block versions.

get_all_global_mux_name()

Usage	`get_all_global_mux_name()`
Parameters	None.
Returns	A list of the clock multiplexer names.
Import	DesignAPI
Description	Gets the names of all clock multiplexer, Bottom, Left, Top, and Right.

get_all_gpio()

Usage	`get_all_gpio()`
Parameters	None.
Returns	A list of GPIO or an empty list.
Import	DesignAPI
Description	Gets a list of all GPIO and buses used.

get_all_gpio_name()

Usage	`get_all_gpio_name()`
Parameters	None.
Returns	A list of GPIO and bus names.
Import	DesignAPI
Description	Gets the names of all GPIO and buses used.

get_all_iobank_name()

Usage	`get_all_iobank_name()`
Parameters	None.
Returns	A list of I/O banks.
Import	DesignAPI
Description	Get the names of all the I/O banks.

get_all_preset_info()

Usage	`get_all_preset_info(name, block_type)`
Parameters	`name`: The instance name. Enclose instance names in double quotes. `block_type`: Type of block; Enclose in double quotes. The default is `DDR`.
Returns	Returns all available presets of the provided instance name.
Import	DesignAPI
Description	Get all preset options according to the provided instance name. The supported block types are DDR (Trion) and PMA_DIRECT (Titanium)

get_all_property()

Usage	`get_all_property(block_type, object_id)`
Parameters	`block_type`: Type of block; enclose in double quotes. The default is `None`. `object_id`: Block object ID. The default is `None`.
Returns	A dict of property names to values.
Import	DesignAPI
Description	Displays all of the properties and values for the specified block type. If you also specify an `object_id`, this command only shows the properties for the block type and object. For example: `block_type="JTAG"`, displays all possible properties. `block_type="GPIO"`, displays all possible properties for all modes. `block_type="GPIO", obj_id=input_gpio`, displays all properties for input GPIO.

get_all_version()

Usage	`get_all_version()`
Parameters	None.
Returns	A list of version information objects.
Import	APIVersion
Description	Get detailed release information for all existing API versions.

get_block_type()

Usage	`get_block_type()`
Parameters	None.
Returns	A list of block type names.
Import	DesignAPI
Description	Gets a list of the available block types. See Block Types and Device Settings.

get_block()

Usage	`get_block(name, block_type)`
Parameters	`name`: Name of the block, enclose in double quotes. `block_type`: The block type, enclose in double quotes.
Returns	Block object ID.
Import	DesignAPI
Description	Get the object ID of the named block. For GPIO, use `get_gpio()`.

get_block_resource()

Usage	`get_block_resource(res_name, block_type)`
Parameters	`res_name`: Resource name; enclose in double quotes. `block_type`: Type of block, enclose in double quotes.
Returns	A dict of property name, value pairs; otherwise returns an empty dict.
Import	DeviceAPI
Description	Get the properties for the specified block resource. If you do not specify a resource name, this command gets information for all resources.

get_block_resource_features()

Usage	`get_block_resource_features(res_name, block_type)`
Parameters	`res_name`: Resource name; enclose in double quotes. `block_type`: MIPI_RX_LANE or MIPI_TX_LANE, enclose in double quotes.
Returns	A dict of property name, value pairs; otherwise returns an empty dict.
Import	DeviceAPI
Description	Get the features (MIPI group, mode, and function) for the specified block resource. If you do not specify a resource name, this command gets information for all resources.

get_block_resource_name()

Usage	`get_block_resource_name(block_type)`
Parameters	`block_type`: Type of block, enclose in double quotes.
Returns	A list of resource names.
Import	DeviceAPI
Description	Get a list of all available resources for the specified block type.

get_block_version()

Usage	`get_block_version(block_type)`
Parameters	`block_type`: Type of block, enclose in double quotes.
Returns	Returns block version.
Import	DesignAPI
Description	Gets the block version for the specific block type.

get_bus()

Usage	`get_bus(name)`
Parameters	`name`: GPIO bus name, enclose in double quotes.
Returns	If found, returns the GPIO bus object ID.
Import	DesignAPI
Description	Get the object ID of a GPIO bus block by name. To get a single GPIO block, use `get_gpio()`.

get_bus_gpio()

Usage	`get_bus_gpio(bus_object_id)`
Parameters	`bus_object_id`: Object ID of the GPIO bus.
Returns	A list of GPIO or an empty list.
Import	DesignAPI
Description	Get a list of the GPIO blocks in the specified bus.

get_current_version()

Usage	`get_current_version()`
Parameters	None.
Returns	Text string.
Import	APIVersion
Description	Get the release's full version number.

get_current_version_info()

Usage	`get_current_version_info()`
Parameters	None.
Returns	A version object.
Import	APIVersion
Description	Get detailed version information for the release.

get_design_check_issue()

Usage	`get_design_check_issue()`
Parameters	None.
Returns	A list of messages.
Import	DesignAPI
Description	Get a list of design check issues.

get_device_property()

Usage	`get_device_property(inst, prop_name, devset_type)`
Parameters	`inst`: The value; enclose in double quotes. `prop_name`: Name of the property, enclose in double quotes. `devset_type`: Specify the device setting type. For the Efinity software v2022.2, the "IOBANK", "SEU", "RU", "EXT_FLASH", and "CLKMUX" types are supported.
Returns	A value if assigned, otherwise, an empty string.
Import	DesignAPI
Description	Get the value of the property for the specified device setting block.

get_device_api()

Usage	`get_device_api()`
Parameters	None.
Returns	Returns DeviceAPI for current design.
Import	DeviceAPI
Description	Gets DeviceAPI for current design.

get_global_dynamic_mux_input_info()

Usage	`get_global_dynamic_mux_input_info(clkmux_name, dynamic_mux, clock_input, index=None)`
Parameters	`clkmux_name`: Clock multiplexer name, enclose in double quotes. `dynamic_mux`: Dynamic multiplexer number (0 or 7), enclose in double quotes. `clock_input`: Dynamic multiplexer input index (0, 1, 2, or 3), enclose in double quotes. `index`: The index associated with the options available at the selected input enclose in double quotes or None. Ti35 and Ti60: 0, 1, 2, 3, 4 Ti90, Ti120, and Ti180: 0, 1, 2, 3, 4, 5, 6
Returns	Returns a list of input resources.
Import	DesignAPI
Description	Get the list of input resources associated to a specific dynamic multiplexer input. Each dynamic multiplexer has 4 inputs with each input having multiple possible resource options to be selected. If `index` is empty, then all available resources associated to the clock_input is listed.

get_gpio()

Usage	`get_gpio(name)`
Parameters	`name`: GPIO name, enclose in double quotes.
Returns	If found, returns the GPIO object ID.
Import	DesignAPI
Description	Get the object ID of a GPIO block by name. To get a bus, use `get_bus()`.

get_gpio_resource()

Usage	`get_gpio_resource(resource_name)`
Parameters	`resource_name`: The GPIO resource name, enclose in double quotes.
Returns	A dict of property name, value pairs; otherwise returns an empty dict.
Import	DeviceAPI
Description	Get the properties for the specified GPIO resource. If you do not specify a resource name, this command returns information for all resources. The properties are: `NAME`: Resource name `INSTANCE`: Instance name, if any `ALT_CONN`: Alternate connection name, if any `CLK_REGION`: Clock region name `IO_BANK`: I/O bank name `PACKAGE_PIN`: Package pin name `PAD`: Pad name `FEATURES`: Special features of the resource, such as DDIO

get_gpio_resource_name()

Usage	`get_gpio_resource_name()`
Parameters	None.
Returns	A list of resource names.
Import	DeviceAPI
Description	Gets a list of all available GPIO resources, including LVDS pins used as GPIO.

get_iobank_voltage()

Usage	`get_iobank_voltage(bank_name)`
Parameters	`bank_name`: The I/O bank; enclose in double quotes.
Returns	The voltage if assigned.
Import	DesignAPI
Description	Get the voltage set for the specified I/O bank.

get_mode_sel_name()

Usage	`get_mode_sel_name(bank_name, bonded_bank=None)`
Parameters	`bank_name`: The I/O bank, enclose in double quotes. `bonded_bank`: None
Import	DesignAPI
Description	Get the name of the mode select pin(s) for the I/O bank.

get_bonded_bank()

Usage	`get_bonded(bank_name)`
Parameters	`bank_name`: the I/O bank, enclose in double quotes.
Import	DesignAPI
Description	Get the name of the bonded I/O bank.

get_object_block_type()

Usage	`get_object_block_type(inst)`
Parameters	`inst`: Instance name or object ID; enclose in double quotes.
Returns	Returns the block type; otherwise returns an empty string.
Import	DesignAPI
Description	Get the block type for the specified block resource.

get_pcie_rp_outbound()

Usage	`get_pcie_rp_outbound(inst)`
Parameters	`inst`: PCIe object ID or instance name. Enclose instance names in double quotes.
Returns	If assigned, returns the list of root port settings; otherwise an empty string.
Import	DesignAPI
Description	Get the root port outbound settings for the specific PCIe instance.

get_pkg_pin()

Usage	`get_pkg_pin(inst)`
Parameters	`inst`: GPIO object ID or instance name. Enclose instance names in double quotes.
Returns	If assigned, returns the pin name; otherwise an empty string.
Import	DesignAPI
Description	Get the package pin assigned to the GPIO instance.

get_preset()

Usage	`get_preset(name, block_type)`
Parameters	`name`: The instance name. Enclose instance names in double quotes. `block_type`: Type of block; Enclose in double quotes. The default is `DDR`.
Returns	Returns current preset ID and description.
Import	DesignAPI
Description	Get preset ID and preset description of current instance. The supported block types are DDR (Trion) and PMA_DIRECT (Titanium)

get_property()

Usage	`get_property(inst, prop_name, block_type)`
Parameters	`inst`: The block's object ID or instance name. Enclose instance names in double quotes. `prop_name`: Name of the property or a comma-separated list of properties. Enclose names in double quotes. `block_type`: Type of block, enclose in double quotes. If `inst` is an instance name, indicate the block type. The default is `GPIO`.
Returns	A dict of property name to value.
Import	DesignAPI
Description	Display the value of the specified property for the instance and block type. You can specify one or more property names. See GPIO Property Reference

get_regional_buffer_info()

Usage	`get_regional_buffer_info(clkmux_name, regional_buf=None)`
Parameters	`clkmux_name`: Left, Right, Bottom, or Top; enclose in double quotes. `regional_buf`: Regional buffer number; enclose in double quotes or None.
Returns	Returns a list of regional buffer resources associated to the specified clock multiplexer; otherwise an empty string.
Import	DesignAPI
Description	Get the information associated with the regional buffer. If `regional_buf` is none or not specified, then it returns info for all regional buffers associated to the clock multiplexer.

get_resource()

Usage	`get_resource(inst, block_type)`
Parameters	`inst`: The block's object ID or instance name. Enclose instance names in double quotes. `block_type`: Indicates the block type, enclose in double quotes. The default is `GPIO`.
Returns	If assigned, returns a string with the name; otherwise an empty string.
Import	DesignAPI
Description	Get the name of the resource assigned to the instance of the specified block type.

get_supported_block()

Usage	`get_supported_block(ver_no=None)`
Parameters	`ver_no=None`: Version number or None; enclose in double quotes.
Returns	A list of block type names.
Import	APIVersion
Description	Get a list of all the supported block types for the specified version number. If `ver_no=None`, get a list of all the supported block types for the current version.

get_version_info()

Usage	`get_version_info(ver_no)`
Parameters	`ver_no`: Version number; enclose in double quotes.
Import	APIVersion
Description	Provide information for the specified version number.

import_design()

Usage	`import_design(design_isf_file, gen_issue_csv, path)`
Parameters	`design_isf_file`: Design filename with .isf extension, enclose in double quotes. `gen_issue_csv`: Boolean `True` or `False` (default). When `True`, the command exports any design issues to a .csv file. `path`: Specify an optional path to save the issues .csv file. If you do not specify a path, it is saved into the same location as the .isf.
Returns	Boolean `True` (if successful) or `False` (if errors).
Import	DesignAPI
Description	Imports the Interface Design from the specified .isf.

import_pcie_rp_outbound()

Usage	`remove_pcie_rp_outbound(inst, filename)`
Parameters	`inst`: The PCIe instance; enclose in double quotes. `filename`: Name of the .json file the contains the region configuration settings.
Import	DesignAPI
Description	Import the PCIe root port outbound region configuration settings from the specified .json file.

is_pkg_pin_used()

Usage	`is_pkg_pin_used(pin_name)`
Parameters	`pin_name`: Package pin name, enclose in double quotes.
Returns	Boolean `True` if used or `False` if not.
Import	DesignAPI
Description	Check if a package pin already has an assignment.

is_resource_used()

Usage	`is_resource_used(res_name, block_type)`
Parameters	`res_name`: Resource name, enclose in double quotes. `block_type`: Indicates the block type, enclose in double quotes. The default is `GPIO`.
Returns	Boolean `True` if used or `False` if not.
Import	DesignAPI
Description	Check if a resource already has an assignment.

load()

Usage	`load(design_file)`
Parameters	`design_file`: The design filename including the path, enclose in double quotes.
Import	DesignAPI
Description	Load the interface design from the specified file.

remove_pcie_rp_outbound()

Usage	`remove_pcie_rp_outbound(inst, region_id_list)`
Parameters	`inst`: The PCIe instance; enclose in double quotes. `region_id_list`: List of region numbers.
Import	DesignAPI
Description	Remove the PCIe root port outbound region settings for the specified region numbers.

reset_device_settings()

Usage	`reset_device_settings(devset_types=None)`
Parameters	`devset_type`: Specify the device setting type string. Default is "NONE" which resets all device settings to default. Refer to Table 2 for the supported settings.
Import	DesignAPI
Description	Reset `devset_type` device settings to the default. If `devset_type` is not set, all device settings are reset to default.

save()

Usage	`save()`
Parameters	None.
Import	DesignAPI
Description	Save the interface to the file specified with the `create()` command.

save_as()

Usage	`save_as(design_file, overwrite)`
Parameters	`design_file`: The design filename including the path, enclose in double quotes. `overwrite`: Boolean `True` or `False` (default). If `auto_save` is `True`, overwrites the file if it exists at the specified location.
Import	DesignAPI
Description	Save the interface design to a new file.

set_device_property()

Usage	`set_device_property(inst, prop_name, prop_value, devset_type)`
Parameters	`inst`: The device setting instance to set; enclose in double quotes. `prop_name`: Name of the property, enclose in double quotes. `prop_value`: The property value, enclose in double quotes. `devset_type`: Specify the device setting type. Refer to Table 2 for the supported settings.
Import	DesignAPI
Description	Set the property of the specified device setting.

set_iobank_voltage()

Usage	`set_iobank_voltage(bank_name, voltage)`
Parameters	`bank_name`: The I/O bank; enclose in double quotes. `voltage`: The voltage to set; enclose in double quotes.
Import	DesignAPI
Description	Set the voltage of the specified I/O bank. You can set values for multiple banks by defining a map. Refer to the iobank_setting.py example script.

set_mode_sel_name()

Usage	`set_mode_sel_name(bank_name, pin_name, bonded_bank=None)`
Parameters	`bank_name`: The I/O bank, enclose in double quotes. `pin_name`: The pin name. `bonded_bank`: None.
Import	DesignAPI
Description	Set the mode select pin name for the I/O bank.

set_preset()

Usage	`set_preset(name, preset_id, block_type)`
Parameters	`name`: The instance name. Enclose instance names in double quotes. `preset_id`: The preset ID. `block_type`: Type of block; Enclose in double quotes. The default is `DDR`.
Import	DesignAPI
Description	Set preset ID and define which preset is used. The supported block types are DDR (Trion) and PMA_DIRECT (Titanium)

set_property()

Usage	`set_property(inst, prop_name, prop_value, block_type)`
Parameters	`inst`: The block's object ID or instance name, enclose instance names in double quotes. `prop_name`: Name of the property, enclose in double quotes. `prop_value`: The property value, enclose in double quotes. `block_type`: Type of block, enclose in double quotes. If `inst` is an instance name, indicate the block type. The default is `GPIO`.
Import	DesignAPI
Description	Set the value of the specified property for the specified block. If `inst` is an instance name, indicate the block type. See GPIO Property Reference Do not use `set_property()` for resources or pins, instead use `assign_resource()` and `assign_pkg_pin()`, respectively.

trace_ref_clock()

Usage	`trace_ref_clock(inst, block_type="PLL")`
Parameters	`inst`: A PLL instance block object id or an instance name. `block_type`: Block type of the instance if it is specified by name.
Returns	A list of one or more clock source property maps.
Import	DesignAPI
Description	Trace the clock source for the target instance. If the instance is a PLL, the clock source is a GPIO instance (PLL V1 and V2) or a GPIO or LVDS instance (PLL V3). In v2021.2, only the PLL block is supported.