API Functions: IP Manager

This section provides an alphabetical list of API functions used for the IP Manager.

add_ip()

Usage	`add_ip(module_name)`
Parameters	`module_name`: The name of the IP module.
Import	ProjectXML
Description	Add the IP module to the project.

config_ip()

Usage	`config_ip(module_name, configs)`
Parameters	`module_name`: Module or instance name for the IP. Enclose in double quotes. `configs`: The IP parameters and values in dictionary format.
Import	IPMDesignAPI
Description	Configure the IP instance or module with the specified parameters.

create_ip()

Usage	`create_ip(module_name, vendor, library, name)`
Parameters	`module_name`: Module or instance name for the IP. Enclose in double quotes. `vendor`: IP vendor name (string). Enclose in double quotes. `library`: IP library name (string). Enclose in double quotes. `name`: IP name (string). Enclose in double quotes.
Returns	The vendor, library, name, and version in Vlnv format.
Import	IPMDesignAPI
Description	Create an instance of the IP core with default parameters. To parameterize the IP, use the `config_ip` command.

generate_ip()

Usage	`generate_ip(module_name)`
Parameters	`module_name`: Module or instance name for the IP. Enclose in double quotes.
Returns	Generation result message (success or error).
Import	IPMDesignAPI
Description	Generates the specified IP module or instance. The generated files are saved in the ip folder in the project directory.

get_ip_list()

Usage	`get_ip_list([vendor,] [library,] [name,] [device_name,] [family_name])`
Parameters	`vendor`: IP vendor name (string). Enclose in double quotes. `library`: IP library name (string). Enclose in double quotes. `name`: IP name (string). Enclose in double quotes. `device_name`: Target FPGA (string). Enclose in double quotes. `family_name`: Target FPGA family (Trion, Topaz or Titanium). Enclose in double quotes.
Returns	A list of IP cores, optionally filtered, in Vlnv format.
Import	IPMDesignAPI
Description	Get list of installed IP cores available in the Efinity® software. You can filter the list using the parameters.

is_ip_exists()

Usage	`is_ip_exists(module_name)`
Parameters	`module_name`: IP module name, enclose in double quotes.
Returns	Boolean `True` if used or `False` if not.
Import	ProjectXML
Description	Check whether an IP module is in the project.

save()

Usage	`save()`
Parameters	None.
Import	ProjectXML
Description	Save the project XML file.

validate_ip()

Usage	`validate_ip(module_name)`
Parameters	`module_name`: Module or instance name for the IP. Enclose in double quotes.
Returns	True if the parameters are correctly configured. Error messages, if any, generated during validation.
Import	IPMDesignAPI
Description	Validates the configured parameters for the specified IP module or instance.