15 Batch Commands in Voltus-Fi-XL

You can run Voltus-Fi-XL in batch mode by using the vfibatch command and specifying the command file with various batch commands. This section provides a list of commands supported in Voltus-Fi-XL.

extract_xdspf

extract_xdspf
-inputType {pegasus | pvs | calibre}
-inputDir input_dir_name
-RunName input_run_name
-outputDir output_dir_name
-process {n3 | n5 | n7prf | n7 | n10pg | n10 | n20 | n16 | n12 | others}
-techDir tech_dir_name | -techLib tech_lib_file_name
-signalEM {true | false}
[-arrayViaSpacing {auto | value}] 
[-blockingCellFile parasitic_blocking_device_cell_names_file]
[-bus_bit_char string]
[-cclFileName vfiQuantus-<filename>.ccl]
[-coloring {true | false}]
[-commentSubCkt {true | false}]
[-compression {true | false}]
[-customExtract extract_Commands_File]
[-device_properties_file file_name]
[-fractureViaCnt via_count_number]
[-groundNet ground_net_name]
[-generate_ccl_only {true | false}]
[-icell_map_file filename]
[-keep_pin_shorting_res {true | false}]
[-keep_pin_shorting_res_by_layer {"layer1" "layer2" .... }]
[-lic_queue timeout_in_seconds]
[-LVS_BOX_hierarchical_flow {true | false}]
[-min_res_by_layer {true | false}]
[-multiCpu number_of_cpus]
[-outputDspf output_dspf_filename]
[-output_xy_generic {true | false}]
[-PGNets list_of_pg_nets]
[-reduction {true | false}]
[-stacked_via_effect {true | false}]
[-subcktPinOrder pin_order_file]
[-subNodeChar sub_node_char]
[-subConductorModel {true | false}]
[-techName technology_name]
[-techCorner technology_corner_name]
[-temperature value]
[-tech_cmd_file filename]
[-tech_layer_setup_file filename] 
[-tech_lpe_config_file ./lpe_confile]
[-user_ccl_file ccl_file_name]

Generates the xDSPF file using Quantus from within Voltus-Fi-XL.

Before running this command, ensure that the Quantus hierarchy is available because the tool will call the Quantus binary from this path, and also ensure that the Pegasus, PVS, or Calibre® run is performed successfully.

Quantus has a plug-and-play flow that performs Techgen compilation automatically while doing extraction. This is intended to make it easier to maintain the technology files. When this feature is enabled, you can supply the raw techfiles from the foundry and Quantus takes care of the rest.

The following parameters are provided to enable this plug-and-play feature:

-tech_cmd_file name of file
-tech_layer_setup_file name of file
-icell_map_file name of file
-tech_lpe_config_file ./lpe_confile

The extract_xdspf command has the following parameters that are only used for hierarchical EMIR analysis.

-hier_flow {true | false} -hier_flow_pgv {1.cl 2.cl}

Parameters

-arrayViaSpacing {auto | value}

Specifies the via array spacing, which is the distance, a floating point micron value, that will be used as the maximum distance criteria for grouping vias within the same array.

The default value of the via array spacing is 0.35 times the via size for N7, N10, N16, N12, and N20 processes. For other processes, the default is auto, in which case the software sets the via spacing automatically. You can specify either auto or a floating value for this option.

Default: auto

This is an optional parameter.

-blockingCellFile parasitic_blocking_device_cell_names_file

Specifies the file containing the parasitic blocking device cell names, if any. Parasitic extraction for these devices will be skipped.

This is an optional parameter.

-bus_bit_char string

Specifies the type of character to use as the bus notation in the xDSPF output file.

If the argument specified for this option is "[]" (square brackets), then you must prefix the brackets using the backslash (\) character. For example:

-bus_bit_char "\[\]"

No other argument except [] requires the (\) character.

Default: none

This is an optional parameter.

-cclFileName vfiQuantus-<filename>.ccl

Allows you to specify the name of the CCL file to be created. If specified, the CCL file is created as vfiQuantus-<filename>.ccl and if not specified, the file is created as vfiQuantus-<cellname>.ccl.

Default: none

-coloring {true | false}

When set to true, this parameter enables color-aware EM analysis. This is an optional parameter.

Default: false

-commentSubCkt {true | false}

When set to true, this parameter will comment out the top sub-circuit statement in the xDSPF file.

This is an optional parameter.

-compression {true | false}

When set to true, specifies that the xDSPF file should be generated in a compressed format.

This is an optional parameter.

-customExtract extract_Commands_File

Specifies the file with user-customized extract commands. When this file is specified, the Voltus-Fi-generated CCL will not have any extract commands and the commands from the customized extract commands file will be added as is in the Voltus-Fi-generated CCL.

A sample customized extract command fie is as follows:

extract \
-selection "all" \
-type "rc_coupled"

You can create customextract file by using either single or multiple extract settings. Ensure that the commands are in the Quantus CCL file syntax as this file is added as is in the Voltus-Fi-generated CCL.

This is an optional parameter.

-device_properties_file file_name

Specifies the name of the device properties file when the input type is Calibre.

This is an optional parameter.

-fractureViaCnt via_count_number

Specifies the fracture via count to be used for dividing pseudo vias into segments during extraction.

Default: 1

-generate_ccl_only {true | false}

When set to true, generates a CCL file for Quantus but does not execute the Quantus binary. This allows you to modify the CCL file that is generated to create your own customized CCL file.

This customized file can then be specified for running Quantus by using the -user_ccl_file option.

Default: false

-groundNet ground_net_name

Specifies the name of the ground net on which extraction is to be performed.

Default: 0

This is an optional parameter.

-inputDir input_dir_name

Specifies the directory in which the Pegasus, PVS, or Calibre data is stored. This is a required parameter.

-inputType {pegasus | pvs | calibre}

Specifies whether the input data is from the Pegasus or Calibre tool. This is a required parameter.

-keep_pin_shorting_res {true | false}

Preserves the device pin shorting resistors on the *wires layers. The device pin shorting resistors are identified by the layer names of “wires”. For example, the layers “mwires”, “qwires”, “rwires”, “cwires”, “bwires”, and “dwires”, consist of shorting resistors for the MOS, BJT, R, C, generic, and D devices respectively.

When set to true, the shorting resistors will not be removed.

Default: false

This is an optional parameter.

-keep_pin_shorting_res_by_layer {"layer1" "layer2" .... }

Specifies the shorting layer names to be preserved. The valid layer names are “mwires”, “qwires”, “rwires”, “cwires”, “bwires”, and “dwires”.

This is an optional parameter.

-lic_queue timeout_in_seconds

Specifies the license timeout wait time in seconds. This is an optional parameter.

-LVS_BOX_hierarchical_flow {true | false}

When set to true, enables the LVS box hierarchical flow of Quantus. This flow requires some additional options to be included in the Quantus CCL file. When the -LVS_BOX_hierarchical_flow parameter is set to true, these additional options are printed in the Quantus CCL file and the flow is enabled.

Default: false

This is an optional parameter.

-min_res_by_layer {true | false}

When this parameter is set to true, the following information is added in the CCL file:

filter_res \

     -min_res_by_layer "RH_TN_6 0" \

      -min_res 0.001 \

      -remove_dangling_res false

This means that all RH_TN_6 layers are reserved without threshold resistor value.

When this parameter is set to false (default) or not set, the following information is added in the CCL file:

filter_res \

      -min_res 0.001 \

      -remove_dangling_res false

This is an optional parameter.

Default: false

-multiCpu number_of_cpus

Specifies the number of CPUs to be used for distributed processing during the Quantus extraction run.

This is an optional parameter. By default, single CPU is used.

-outputdir output_dir_name

Specifies the directory in which the xDSPF file that is generated will be saved. This is a required parameter.

-outputDspf -output_dspf_filename

Specifies the name of the xDSPF file that is generated. This is an optional parameter. If the filename is not specified, the software generates the file, runName.dspf by default.

-output_xy_generic {true | false}

When set to true, provides the x-axis and y-axis coordinates for a high resistance design resistor. This parameter introduces the GENERIC option in the CCL file. By default, this parameter is set to true.

When this parameter is set to false, there will be no GENERIC option in the CCL file.

-PGNets list_of_pg_nets

Provides the list of PG nets, separated by spaces, for which the xDSPF file is to be generated. This is an optional parameter. It is only specified when the -signalEM parameter is set to false.

-process {n3 | n5 | n7prf | n7 | n10pg | n10 | n20 | n16 | n12 | others}

Specifies the process node.

n3: for the N3 process node

n5: for the N5 process node

n7prf: for the N7PRF process node

n7: for the N7 process node

n10pg: for the N10 process node with PG rules

n10: for the N10 process node

n20: for the N20 process node

n16: for the N16 process node

n12: for the N12 process node

others: for the N20 and above process nodes

-reduction {true | false}

When set to true, this parameter enables the reduce_i_cards option while generating the xDSPF file.

This is an optional parameter.

-RunName input_run_name

Specifies the name of the Pegasus, PVS, or Calibre run. This is a required parameter.

-signalEM {true | false}

Specifies whether the names of signal nets should be included in the xDSPF file or not. If signal nets are not to be included in the EM analysis, set this parameter to false.

-stacked_via_effect {true | false}

When set to true, reports the W parameter as 1,000,000 microns.

When set to false, reports the actual wire width for the short horizontal metal segment.

If a wire segment between the inner layers of adjacent stacked vias is short, the current flowing in the short horizontal segment is expected to be mostly vertical, whereas the horizontal currents may be non-real. By setting this option to true, you can modify the W parameter to be set to 1,000,000 microns to prevent false EM violations.

This is an optional parameter.

Default: false

-subConductorModel {true | false}

When set to true, specifies that parasitic resistor models for subconductor layers should be included during extraction. This is used to support different EM rules for poly layers in EM analysis.

This is an optional parameter.

-subNodeChar sub_node_char

Specifies the character that will be used for subnode identification.

Default: #

This is an optional parameter.

-subcktPinOrder pin_order_file

Specifies the name of the sub-circuit pin order file. The pin order is specified in the xDSPF file using the .SUBCKT and .ENDS statements. You can use this option to provide a file with a different pin order that will override the order specified using the default .SUBCKT statement in the xDSPF file.

This is an optional parameter.

-techDir tech_dir_name | -techLib tech_lib_file_name

Use either the -techDir parameter to specify the name of the directory containing the tech file or use the -techLib parameter to specify the path of the technology file that Quantus will use for generating the xDSPF file.

One of the two parameters must be specified.

-techCorner technology_corner_name

Specifies the technology corner name to be picked from the library. This parameter is optional.

-techName technology_name

Specifies the technology filename to be used for extraction. This parameter is optional if the -techDir parameter has been specified.

-temperature value

Specifies the temperature at which the extraction will be performed. It is specified in degree Celsius.

This is an optional parameter. If not specified, the software will use 25 degree Celsius as the default temperature.

The options, -temperature and temp_coeff specified in the CCL file are mutually exclusive. The following scenarios hold true.

If you specify a temperature by using this parameter, the following option in the CCL file will be set to false:

-include_parasitic_res_temp_coeff "false" \

The software displays the following message:

User specified temperature will be used for extraction. The option include_parasitic_res_temp_coeff will be set as false.

If you do not specify a temperature, the following option in the CCL file will be set to true:

-include_parasitic_res_temp_coeff "true" \

The software displays the following message:

No user specified temperature value so the option include_parasitic_res_temp_coeff will be set as true.

-user_ccl_file ccl_file_name

Specifies the name of the user-customized CCL file to be used for running Quantus.

-tech_cmd_file filename

Specifies the name of the command file to enable the plug and play feature of Quantus.

-tech_layer_setup_file filename

Specifies the name of the technology layer setup file to be used for Techgen compilation. This parameter is only relevant for the plug and play feature of Quantus.

-tech_lpe_config_file ./lpe_confile

Specifies the name of the technology LPE configuration file that is to be passed to Quantus. This parameter is only relevant for the plug and play feature of Quantus.

-icell_map_file filename

Specifies the foundry provided iCellmap file that contains simulation model to DFII cell view mappings and transfer property information. This file is specified only for enabling the plug and play feature of Quantus.

Examples

The following command generates the xDSPF file, test_lib.dspf in the vfi_quantus1 directory:

extract_xdspf \

-signalEM true \
-process n20 \
-techLib pegasus_tech.lib \
-techName n20tech \
-temperature 27 \
-inputType pegasus \
-inputDir test_lib/pegasus \
-RunName test_lib \
-outputdir vfi_quantus1 \
-subcktPinOrder ./your_subckt_pin_order_file
-customExtract myextract.txt
-groundNet "vss" \
-subNodeChar ":" \
-compression true \
-lic_queue 200

The following set of commands are used to generate the xDSPF file, test_lib.dspf in the vfi_quantus1 directory using the user-customized CCL file:
Step 1:

extract_xdspf \

-signalEM true \
-process n20 \
-techLib pegasus_tech.lib \
-techName n20tech \
-temperature 27 \
-inputType pegasus \
-inputDir test_lib/pegasus \
-RunName test_lib \
-outputdir vfi_quantus1 \
-generate_ccl_only true

Step 2:

extract_xdspf \

-user_ccl_file vfiquantus-cell1.ccl \

ground_pins

ground_pins gnd_pin_list

Specifies the names of the virtual ground pins to which the SPICE subcircuit terminal will be connected. This command is used to set up static current analysis in Voltus-Fi-XL.

Parameters

gnd_pin_list

Specifies the names of the virtual ground pins.

Example

The following command is used to specify the names of two ground pins, VSS and VSSA:

ground_pins VSS VSSA

power_pin

power_pin
-pin_name pin_name
-voltage voltage_value

Specifies the power pin and its corresponding voltage value.To specify multiple power pins, use this command multiple times. This command is used to set up static current analysis in Voltus-Fi-XL.

Parameters

`-pin_name` pin_name	Specifies the name of the virtual power pin to which the SPICE subcircuit terminal should be connected.
`-voltage` voltage_value	Specifies the voltage value of the power pin.

Example

The following commands are used to specify the names of two power pins, VDD and VDDA, and their corresponding voltage values:

power_pin \

-pin_name VDD \
-voltage 0.9

power_pin \

-pin_name VDDA \
-voltage 1.1

run_static_simulation

run_static_simulation
-method {Ipeak | Iavg}
-nets net_name_list
[-freq freq_value]
[-global_activity number]
[-activity_file file_name]
[-vcd vcd_file_name]
[-clock_file clock_file_name]
[-cmd_include_file command_file_name]
[-average_power power_value_in_W]
[-power_file power_file_name]

Runs static current analysis in Voltus-Fi-XL.

Parameters

-activity_file file_name

Specifies the path of the activity file, which contains the activity factor on any node of the circuit.

This is an optional parameter. It is only used for the average static current analysis.

-average_power power_value_in_W

Specifies the average power of the design. The default unit is W (Watts). If the value is in any other unit, it must be specified. For example, 20mW. You can specify a single value or multiple values depending upon whether the same or a different power is to be used for the specified nets. This is shown in the examples below.

This is an optional parameter. This is only used for the average static current analysis.

-clock_file clock_file_name

Specifies the name of the clock file, which contains information about the clock nodes, subcircuit definitions, and subcircuit instance names and their frequencies.

This is an optional parameter. This is only used for the average static current analysis.

-cmd_include_file command_file_name

Specifies the name of the file that passes additional user commands to Thunder during static current analysis.

This is an optional parameter.

-freq freq_value

Specifies the value of the dominant frequency of the design. The unit is in mHz (Mega Hertz).

This is an optional parameter. This is only used for the average static current analysis.

-global_activity number

Specifies the average number of times all the unset nodes switch in a clock cycle.

This is an optional parameter. This is only used for average static current analysis.

-method {Ipeak | Iavg}

Specifies whether the peak or average static analysis will be performed.

This is a required parameter.

-nets net_name_list

Specifies the list of nets for which current analysis is to be performed.

This is a required parameter.

-power_file power_file_name

Specifies the name of the average power file, which contains the average power for specific sub circuits.

This is an optional parameter. This is only used for the average static current analysis.

-vcd vcd_file_name

Specifies the vcd file, which contains information about the number of transitions for each net.

This is an optional parameter. This is only used for the average static current analysis.

Examples

The following command is used to run the average static current analysis.
- In this example, the same power value is assigned to the two nets, VDD and VSS:
```
run_static_simulation \
```
```
   -method Iavg \
   -nets {VDD VSS} \
   -freq 300 \
   -global_activity 0.25 \
   -average_power 20mW
```
- In this example, different power values are assigned to the three nets, VDD_1, VDD_2, and VSS_1:
```
run_static_simulation  \
   -method Iavg  \
   -nets {VDD_1 VDD_2 VSS_1} \
   -freq 300 \
   -global_activity 0.25 \
   -average_power {10mW 8mW 18mW}
```
  The above command is only valid if you provide power values for all the specified nets.
The following command is used to run the peak static current analysis:
```
run_static_simulation \
```
```
-method Ipeak \
-nets {VDD VSS}
```

setup_simulation

setup_simulation
-spice_netlist spice_file_name
[-simulation_temperature temp_value]
[-hierarchy_separator char_name]
[-topcell cell_name]
[-output_directory dir_name]

Sets up the options for static current analysis in Voltus-Fi-XL.

Parameters

`-hierarchy_separator` char_name	Specifies the hierarchical separator in the circuit file. This is an optional parameter.This is specified only if the hierarchy separator is other than “`/`”.
`-output_directory` directory_name	Specifies the name of the output directory where the current database will be saved. This is an optional parameter. If this parameter is not specified, the output is stored in the current working directory.
`-simulation_temperature` temp_value	Specifies the temperature, in degree Celsius, at which the simulation will be performed. This is an optional parameter. Default: 25 degree Celsius
`-spice_netlist` spice_file_name	Specifies the SPICE netlist file, which is the DSPF file. This is a required parameter.
`-topcell` cell_name	Specifies the name of the design. It is an optional parameter. By default, the tool populates the top cell name from that specified in the layout.

Example

The following command is used to set up simulation:

setup_simulation \

-spice_netlist  design.spice \
-simulation_temperature 100 \
-topcell designA \
-output_directory ./vps_simulation_1

load_ir_results

load_ir_results
results_file_name

Loads the results of IR drop analysis in Voltus-Fi-XL.

Parameter

results_file_name

Specifies the directory in which the IR drop analysis results should be loaded.

Example

The following command loads the results for IR drop analysis that are stored in the xps.emirtap.emir0_bin file:

load_ir_results \

./abc/raw.out/xps.emirtap.emir0_bin

print_ir_report

print_ir_report
-net {all_power | netname}
-type {ir |iv |rc |rcavg |rcrms | reffective} 
[-threshold threshold_value] 
-filename output_file_name

Prints the results of IR drop analysis in Voltus-Fi-XL. You can generate IR reports for all the power nets or for specific nets.

Before running this command, ensure that the IR drop results are loaded using the load_ir_results command.

Parameters

`-filename` output_file_name	Specifies the name of the IR drop analysis report file. This is a required parameter.
`-net {all_power \|` netname`}`	Specifies whether the IR drop analysis report is to be printed for all the power nets or for the specified net. Select `all_power` to print the IR report for all the power nets. Select netname to print the IR report for the specified net. This is a required parameter.
`-threshold` threshold_value	Specifies that resistors or nodes that have a threshold IR drop ratio value greater than the specified value will be reported. This is an optional parameter. Default: The report prints results for all resistors or nodes.
`-type {ir \| iv \| rc \|rcavg \|rcrms \| reffective}`
	Specifies the analysis type for which the report is being generated. `ir` – specifies that the report is generated for IR drop analysis. `iv` – specifies that the report is generated for transistor-based supply voltage data analysis. `rc` – specifies that the report is generated for peak resistor Current Density analysis. `rcavg` – specifies that the report is generated for average resistor Current Density analysis. `rcrms` – specifies that the report is generated for RMS resistor Current Density analysis. `reffective` – specifies that the report is generated for effective resistance analysis. This is a required parameter.

Examples

The following command prints the IR drop analysis report for all the nets for ir analysis in the all_ir.txt file:
```
print_ir_report \
```
```
-net all_power \
```
```
-type ir \
```
```
-filename all_ir.txt
```
The following command prints the IR drop analysis report for the VDD net for iv analysis in the vdd_iv.txt file:
```
print_ir_report \
```
```
-net VDD \
```
```
-type iv \
```
```
-filename vdd_iv.txt
```
The following command prints the IR drop analysis report for the VSS net for rc analysis in the vss_rc.txt file:
```
print_ir_report \
```
```
-net VSS \
```
```
-type rc \
```
```
-filename vss_rc.txt
```
The following command prints the IR drop analysis report for all power nets for rcrms analysis in the all_power_rcRMS.txt file:
```
print_ir_report \
```
```
-net all_power \
```
```
-type rcrms \
```
```
-filename all_power_rcRMS.txt
```

print_rlrp_report

print_rlrp_report
-net netname
-filename output_file_name
-tap tapname

Prints the RLRP analysis report in Voltus-Fi-XL.

Before running this command, ensure that the IR drop results are loaded using the load_ir_results command.

Parameters

`-filename` output_file_name
	Specifies the name of the RLRP analysis report file. This is a required parameter.
`-net` netname	Specifies the name of the net for which the RLRP report is to be printed. This is a required parameter.
`-tap` tapname	Specifies the instances or tap-nodes of the specified net for which the LRP values are to be printed. You can specify multiple tap nodes for the specified net as shown in the example below. This is a required parameter.

Example

Use the following commands to load the IR drop analysis results and print the RLRP analysis report for the TVDD net in the RLRP.rpt file:

load_ir_results ./abc/raw.out/xps.emirtap.emir0_bin
print_rlrp_report -net TVDD -filename RLRP.rpt -tap MavD7_1_unmatched#d
print_rlrp_report -net TVDD -filename RLRP.rpt -tap MavD7_2_unmatched#d

pin_2_pin_res

pin_2_pin_res
-xdspf filename
-x1 value
-y1 value
-x2 value
-y2 value
-layer1 layername
-layer2 layername
-net netname

Calculates the effective resistance between any two nodes (pins, tap nodes, or subnodes), either on the same layer or on different layers of the same net in Voltus-Fi-XL. Use this command after the load_ir_results command.

All parameters of this command are required parameters.

Parameters

`-xdspf` filename	Specifies the location of the xDSPF file to be used for the Static Power Grid Solver (SPGS) flow of Spectre.
`-x1` value	Specifies the x-coordinate for node 1 in microns.
`-y1` value	Specifies the y-coordinate for node 1 in microns.
`-x2` value	Specifies the x-coordinate for node 2 in microns.
`-y2` value	Specifies the y-coordinate for node 2 in microns.
`-layer1` layername	Specifies the name of the layer for node 1.
`-layer2` layername	Specifies the name of the layer for node 2.
`-net` netname	Specifies the name of the net on which the two nodes are located.

Example

Use the following commands to load the IR results and specify the nodes between which you want to calculate effective resistance.

load_ir_results \
./abc/raw.out/xps.emirtap.emir0_bin

pin_2_pin_res \

-xdspf abc/raw.out/abc_sample.dspf \

-x1 83.40 \

-y1 34.205 \

-x2 83.40 \

-y2 35.205

-layer1 mt1 \

-layer2 mt2 \

-net VDD

print_subnode_to_tap_path_report

print_subnode_to_tap_path_report
-net {netname}
-subnode {subnode name}
-filename {report_file_name}
[-never_traverse_top {true | false}] 
[-report_complete_path {true | false}]

Prints the results of the nearest tap nodes for the specified subnodes in Voltus-Fi-XL.

Before running this command, ensure that the IR drop results are loaded using the load_ir_results command.

Parameters

`-filename` output_file_name
	Specifies the name of the report file to be generated. This is a required parameter.
`-never_traverse_top {true \| false`
	Specifies whether or not the software should traverse the top layers to find a tap node. By default, the software will traverse the top layers to reach the nearest tap node. Set this parameter to `true` if you do not want to traverse the top layers. Default: `false` This is an optional parameter.
`-net` netname	Specifies the name of the net for which the report is to be generated. This is a required parameter.
`-report_complete_path {true \| false}`
	Specifies whether or not the complete path for each traced tap node should be reported. By default, the software will not report the complete path.
`-subnode` subnode_name
	Specifies the name of the subnode for which the report is to be generated. This is a required parameter.

Example

The following command prints the report for the VDD net for tap nodes of the subnode, VDD:36919 in the subnode_tap_path.rpt file:

print_subnode_to_path_report \

-net VDD \

-subnode VDD:36919 \

-filename subnode_tap_path.rpt

loa d_em_results

load_em_results
-tech_file tech_file_name 
[-em_only_ict_file ict_file_name]
[-layer_mapfile layer_map_filename] 
results_file_name

Loads the results of EM analysis in Voltus-Fi-XL.

The qrcTechFile name and layer map file must be specified if the layer names in the qrctechFile are different from those in the simulation database.

Parameters

`-em_only_ict_file` ict_file_name
	Specifies the name of the ICT file with process and EM model information that will be used for EM analysis. This is an optional parameter. For a sample EM only ICT file, see the “File Formats” chapter.
`-layer_mapfile` layer_map_filename
	Specifies the name of the layer map file that provides the mapping between the layer names used in the technology file and the simulation database. This is an optional parameter. It is used only when the layer names in the `qrcTechFile` are different from those in the simulation database.
results_file_name	Specifies the name of the file which contains the EMIR simulation results data. This is a required parameter.
`-tech_file` -tech_file_name
	Specifies the name of the `qrcTechFile` or the `emDataFile` used for EM analysis. This is a required parameter.

Example

The following command loads the results of EM analysis stored in the xps.emirtap.emir0_bin file, and when the layer map file is contactmapfile:

load_em_results \

-tech_file qrcTechFile \

-layer_mapfile contactmapfile /xps.emirtap.emir0_bin

print_em_report

print_em_report
-net {all_power | all_signal | all_nets | netname}
-type {javg | jmax | jabsavg | jacpeak | jacrms | rc | rcavg | rcrms | tc | tcavg | tcrms | acrms_sh | avg_sh | peak_sh} 
[-threshold threshold_value] 
-filename output_file_name
[-rule custom_em_rule_name]

Prints the EM analysis reports in Voltus-Fi-XL.

Before running this command, ensure that the EM results are loaded using the load_em_results command.

Parameters

`-filename` output_file_name
	Specifies the name of the EM analysis report file. This is a required parameter.
`-net {all_power \| all_signal \| all_nets \|` netname`}`
	Specifies that the EM analysis report is to be generated for one of the following: `all_power`: prints the report for all power nets `all_signal`: prints the report for all signal nets `all nets`: prints the report for all nets netname: prints the report for the specified net This is a required parameter.
`-rule` custom_em_rule_name	Specifies the custom EM rule for which the report will be created. This is an optional parameter.
`-threshold` threshold_value
	Specifies that resistors or nodes that have a threshold value of EM ratio above the specified value will be reported. This is an optional parameter. Default: The report prints the results for all resistors or nodes.
`-type {javg \|jmax \| jabsavg \| jacpeak \| jacrms \| rc \| rcavg \| rcrms \| tc \| tcavg \| tcrms \| acrms_sh \| avg_sh \| peak_sh}`
	Specifies the analysis type for which the report is being generated. `javg` – specifies that the report is generated for the average Current Density analysis data. `jmax` – specifies that the report is generated for the peak Current Density analysis data. `jabsavg` – specifies that the report is generated for the average absolute Current Density analysis data. `jacpeak` – specifies that the report is generated for the AC peak Current Density analysis data. `jacrms` – specifies that the report is generated for the RMS Current Density analysis data. `rc` – specifies that the report is generated for the peak resistor Current Density analysis data. `rcavg` – specifies that the report is generated for the average resistor Current Density analysis data. `rcrms` – specifies that the report is generated for the RMS resistor Current Density analysis data. `tc` – specifies that the report is generated for the peak tap Current Density analysis data. `tcavg` – specifies that the report is generated for the average tap Current Density analysis data. `tcrms` – specifies that the report is generated for the RMS tap Current Density analysis data. `acrms_sh` – specifies that the report is generated for AC RMS current analysis data with self-heating effect. `avg_sh` – specifies that the report is generated for average current analysis data with self-heating effect. `peak_sh` – specifies that the report is generated for peak current analysis data with self-heating effect. The above three types of analyses are applicable only in the SHE flow. This is a required parameter.

Examples

The following command prints the EM analysis report for all the power nets for javg analysis in the all_power_javg.txt file:
```
print_em_report \
```
```
-net all_power \
```
```
-type javg \
```
```
-filename all_power_javg.txt
```
The following command prints the EM analysis report for all the signal nets for jmax analysis in the all_signal_jmax.txt file:
```
print_em_report \
```
```
-net all_signal \
```
```
-type jmax \
```
```
-filename all_signal_jmax.txt
```
The following command prints the EM drop analysis report for the VDD net for jabsavg analysis in the vdd_jabsavg.txt file:
```
print_em_report \
```
```
-net VDD \
```
```
-type jabsavg \
```
```
-filename vdd_jabsavg.txt
```
The following command prints the EM drop analysis report for the VDD net for tcrms analysis in the vdd_tcrms.txt file:
```
print_em_report \
```
```
-net VDD \
```
```
-type tcrms \
```
```
-filename vdd_tcrms.txt
```

load_view

load_view
-libname lib
-cellname cell_name
-viewname view_name

Specifies the layout to be used for self-heating effect (SHE) analysis in Voltus-Fi-XL.

Parameters

-cellname cell

Specifies the name of the cell.This is a required parameter.

-libname lib

Specifies the name of the library. This is a required parameter.

-viewname layout

Specifies the layout view for which SHE analysis is to be performed. This is a required parameter.

Example

The following command specifies the layout view for cell1 of library, test_lib:

load_view
-libname test_lib \
-cellname cell1 \
-viewname layout

print_thermal_report

print_thermal_report
-type {mos-region | metal} 
[-tiles tile_matrix]
-filename output_file_name

Prints thermal reports for hierarchical self-heating effect (SHE) analysis in Voltus-Fi-XL.

To generate hierarchical SHE analysis reports using this command, the VTS-Fi-AA license is required to be checked out. This is an advanced license that is not available as part of the Voltus-Fi-XL license.

If you do not want to perform hierarchical SHE analysis, ensure that this command is not specified in the command file.

The SHE EM analysis reports can be generated by specifying the print_em_report command in the command file with the required -type option. No special license is required for generating these reports.

Parameters

-filename output_file_name

Specifies the name of the file in which the hierarchical SHE analysis results will be printed. This is a required parameter.

-tiles tile_matrix

Specifies the OD regions or metal resistors and their temperature change after hierarchical self-heating effect in tile format. The tile matrix is specified as follows:

The design in the layout is divided into sections based on the tile matrix provided, which is the number of divisions in the x- direction multiplied by the number of divisions in the y-direction.

For example:

-tiles 10x15

This is an optional parameter.

-type {mos_region | metal}

When mos-region is specified, the shape of OD regions and their temperature change after hierarchical self-heating effect are printed in the report.

When metal is specified, the shape of metal resistors and their temperature change after hierarchical self-heating effect are printed in the report.

This is a required parameter.

Example

The following sequence of commands will print the results of hierarchical SHE analysis for OD regions in a tile format in the mos-region-tiles.txt file:

load_em_results \
-tech_file qrcTechFile \
-layer_mapfile contactmapfile /input.emir0_bin

print_em_report \
-net all_nets \
-type acrms_sh \
-filename ./acrms_sh.txt

print_thermal_report \
-type mos-region \
-tiles 15x10 \
-filename ./mos-region-tiles.txt

setMultiCpuUsage

setMultiCpuUsage 
[-acquireLicense integer] 
[-keepLicense {true | false}] 
[-licenseList {string}] 
[-localCpu { integer | max}] 
[-remoteHost integer] 
[-cpuPerRemoteHost integer] 
[-releaseLicense] 
[-threadInfo {0 | 1 | 2}] 
[-verbose] 
[-cpuAutoAdjust {true | false}] 
[-autoPageFaultMonitor {0 | 1 | 2 | 3}] 
[-reset] 
[-help]

Specifies the number of threads to use for multi-threading, or the maximum number of computers to use for distributed processing, or the maximum number of computers and the number of threads to use for super-threading. Optionally, this command reports the usage information.

Parameters

`-help`	Outputs the command usage and a brief description about the command parameters.
`-acquireLicense` integer
	Acquires licenses to enable the specified number of CPUs. For example, if you specify `-acquireLicense 5`, the software checks out enough licenses to enable five CPUs. After the licenses are checked out, they can be used for multi-threading, distributed processing, or super-threading.
`-autoPageFaultMonitor {0 \| 1 \| 2 \| 3}`
	Specifies to set a warning rank for performance issues caused by major page faults. The parameter supports the following values: 0 - specifies to disable the reporting of major page faults. 1 - specifies to set the warning rank as 1. This means PF/total PF > 0.8, b > 10, and wa > 85% 2 - specifies to set the warning rank as 2. This means PF/total PF > 0.5, b > 5, and wa > 65% 3 - specifies to set the warning rank as 3. This means PF/total PF > 0.2, b > 1, and wa > 40% where PF is the number of major page faults from the software, total PF is the total number of major page faults in the machine, b is the number of blocked processors, and wa is CPU waiting time.
`-cpuAutoAdjust {true \| false}`
	Specifies that the specified number of CPUs should be adjusted based on the available free memory. The software lowers the number of client processes on the local machine in case of insufficient memory. This is applicable to CPUs only on the local machine. The default value is `true`. If set to `false`, automatic adjustment of CPUs is disabled.
`-cpuPerRemoteHost` integer
	Specifies the number of CPUs used by clients for multi-threading. Note: For super-threading, you must use this parameter in conjunction with the `-remoteHost` parameter. Default: `1` Note : Save/restore is enabled for this option.
`-keepLicense {true \| false}`
	Specifies whether to keep the acquired multiple-CPU licenses until the current session ends. Specify this parameter before running any commands that require multiple-CPU applications. To release all multiple-CPU licenses immediately, use the `-releaseLicense` option. Default: `true`
`-licenseList` `{`tpsmp`}`
	Specifies the list or order of licenses that the software should use for checking out licenses during multiple-cpu processing. The parameter does not support an empty license list, `{}`. This parameter allows the `tpsmp` option.
`-localCpu` string	Specifies the number of CPUs on the local machine. This parameter is required for multi-threading. Default: 1 Note: Save/restore is enabled for this option.
`-releaseLicense`	Releases all the multiple-CPU license(s) immediately. By default, the software holds multiple-CPU licenses until the end of the current session. To specify that the software release multiple-CPU licenses after every multiple-CPU command runs, use the `-keepLicense` parameter.
`-reset`	Resets the specified parameters back to the default values.
`-threadInfo {0 \| 1 \| 2}`
	Reports the usage information. Default: 0 Specify one of the following values: 0 : Does not write messages to the log file. 1 : Writes the final message to the log file. For example, All threaded jobs finished (10 elapsed sec: 0 processor sec (parent), 0 system sec (parent), 0 processor sec (threads), 0 system sec (threads)). 2 : Writes additional starting/ending information for each thread. For example, Starting threaded job 1... Starting threaded job 2... Starting threaded job 3... Ending threaded job 2 (1 elapsed sec, 0 processor sec, 0 system sec, 1.160M). Ending threaded job 3 (2 elapsed sec, 0 processor sec, 0 system sec, 0.895M). Ending threaded job 1 (10 elapsed sec, 0 processor sec, 0 system sec, 1.172M). All threaded jobs finished (10 elapsed sec: 0 processor sec (parent), 0 system sec (parent), 0 processor sec (threads), 0 system sec (threads)).
`-verbose`	Displays messages when changing the multiple-CPU settings.

setDistributeHost

setDistributeHost 
[-help] 
[-add string] 
[-args string]
[-custom] 
[-custom_script string] 
[-custom_script_list string] 
[-local] 
[-lsf] 
[-nc] 
[-noWaitTaskComeUp] 
[-queue string] 
[-remove string]
[-reportLsfInfo]
[-resource string] 
[-rsh] 
[-sge] 
[-shellTimeout integer] 
[-single_cpu_lsf_args string]
[-ssh]
[-timeOut integer]
[-env_script "script"]

Specifies the multiple-CPU processing configuration for distributed processing or super-threading. Voltus-Fi-XL finds hosts from the last setDistributeHost command specified before a distributed processing or super-threading command starts.

Parameters

`-help`	Outputs the command usage and a brief description about the command parameters.
`-add` string	Adds the specified hosts to the `rsh/ssh` configuration. If you specify more than one host, separate each host name with a space. Each time you specify a host, the software uses it to run one client process. To run more than one client process on a host, specify it more than once. For example, if you have two machines that each has two CPUs and you want to use both CPUs in both machines, type a command like the following: `setDistributeHost -rsh -add {machine1 machine2 \ machine1 machine2}`
`-args` string	Specifies any additional arguments you need to provide to the Sun Grid Engine (SGE) or Load Sharing Facility (LSF) job submission command.
`-custom`	Use a custom job submission script for distributed processing.
`-custom_script` string
	Specifies a custom script to run distributed processing.
`-custom_script_list` string
	Specifies that the launch of multiple jobs should be customized, based on the resources required for these jobs. This parameter lets you specify multiple launch strings in order of priority with a maximum allowed job count for each string. If you request for N jobs, the command starts submitting jobs starting from string1, until the corresponding count is reached, at which point it starts submitting the next string in the list. Therefore, the command submits the first "`count1`" jobs with string1 , the next "`count2`" jobs with string2 and so on. It stops when the total submitted jobs has reached the requested number (N). Note : This parameter can only be specified with the `-custom` parameter.
`-env_script` "script"	Specifies a user-defined shell environment script that is run for each of the slave hosts. The parameter allows you to pass these environment settings to the slave hosts by including them in the shell environment script. The license variables used by the software are also automatically passed to the slave hosts to avoid license errors.
`-local`	Runs all the distributed processing jobs on the master machine.
`-lsf`	Specifies a LSF configuration. If you do not specify any parameters for `-lsf`, the software uses the default settings. Note: To use this parameter, LSF must already be set up (typically by specifying the `LSF_ENVDIR` and `LSF_SERVERDIR` environment variables) and `bsub` must be in your search path. Contact your LSF administrator for details.
`-nc`	Uses NC commands (Network Computer from RTDA) for distributed processing.
`-noWaitTaskComeUp`	When specified, does not allow the software to wait for tasks that are delayed or are not likely to occur.
`-queue` string	Specifies the queue for the LSF or Sun Grid Engine (SGE) configuration.
`-remove` string	Removes the specified hosts or all hosts from the `rsh/ssh` configuration. If you specify more than one host, separate each host name with a space.
`-reportLsfInfo`	Specifies to report LSF information in a single report. This parameter allows you to collect the system statistics on the status of the distributed jobs. It has the following information: Host name for master and LSF tasks Number of CPUs on each machine that are being used by a process Job ID/PID for each task process Total memory used on each machine Total virtual memory used on each machine Total CPU time used on each machine You must specify this parameter along with the `-lsf` parameter. To get the LSF information, specify the `getDistributeHost` -`reportLsfInfo` command parameter. You must specify the `getDistributeHost -reportLsfInfo` only after the LSF tasks exit to obtain the task CPU time. If you specify this command before the task exits, the command gives a warning message.
`-resource` string	Specifies a resource string for the SGE or LSF queue. Note: The correct resource string is specific to your installation. Contact your LSF administrator for the appropriate parameters and values.
`-rsh`	Specifies a remote shell configuration.
`-shellTimeout` integer	Specifies the number of seconds the host machine waits for `rsh/ssh` machines to become available for multiple-CPU processing. Default: 5
`-sge`	Specifies an SGE configuration.
`-single_cpu_lsf_args` string
	Specifies the `bsub` options. Note: You must use this parameter to adjust the LSF argument for a single CPU application. Alternatively, use the `-args` parameter to adjust the LSF argument for an application that runs in the super-threading mode.
`-ssh`	Specifies a secure shell configuration.
`-timeout` integer	Specifies the default timeout for a submitted job. This functionality prevents the master machine from hanging when the clients do not come up for some reason. After timeout, a warning message appears informing you that the distributed CPUs did not come online within the expected time. The master will continue waiting for the clients and it is up to you to continue waiting or stop the run if there are problems with the Distributed Resource Management (DRM) system. A sample warning message is given below: Task id 2 did not come up within the specified timeout period (300 seconds). Use `setDistributeHost -timeout` to change the value. This may be a real error due to incorrect or incomplete platform/machine specification provided via setDistributeHost to your distributed resource management system (LSF/Sun Grid Engine etc.). If running locally (`setDistributeHost -local` ), the current machine may be overloaded with too many jobs and swapping (check free memory and CPUs with top). For local runs, consider reducing the number of CPUs you are using via the `setMultiCpuUsage` command, or free up some memory by killing other memory intensive processes. Default: `30 (local/rsh/custom) and 3600 (lsf/sge)`

create_pgv

create_pgv
-macro_name macro_name
[-lib_name name_of_library]
[-libgen_cmd_file cmd_file_name]
[-libgen_path libgen_binary_path]
-tech_file tech_file_name
[-tech_lef_file tech_lef_file_name]
-type {static | dynamic}
[-macro_lef_file macro_lef_file_name]
-sim_dir simulation_dir
[-lef_layer_map lef_layer_map_file_name]
[-oa_lib list_of_OA_libraries]
[-pgdb_layer_map pgdb_layermap_file_name]
[-pgdb_version version_number]
[-trigger_file trigger_file_name]
[-output_directory directory]
[-uti_Ron_file Ron_report_file_dumped_by_Spectre]
[-create_no_device_nets true | false]
[-create_no_device_signal_nets true | false]
[-powergate_state_flow true | false]
[-use_pwl_files true | false]
[-map_connectivity_layers true | false]
[-units value]
[-stopAtVia VIA_layer]

Creates power-grid views in Voltus-Fi-XL. The power-grid views contain information about the power ports of a transistor or block, the internal power grid, and the tap current distribution within a transistor or block.

The create_pgv command has the following parameters that are used only for hierarchical EMIR analysis.

-hier_flow {true | false} -hier_flow_stop_layerlayer_name
-disable_signal_pgdb {true | false} -stop_on_missing_lef_pins {true | false} -sim_dir simulation_dir

Parameters

`-macro_name` macro_name
	Specifies the name of the macro.
`-lib_name` name_of_library
	Specifies the name of the library. This is specified if you want to create a library with a name different than that of the macro. By default, a library is created with the same name as that of the macro.
`-libgen_cmd_file` cmd_file_name
	Specifies the name of the LibGen command file that includes LibGen commands, if any, required to be specified for creating PGVs. For example, the LibGen command file may contain the following: setvar source_drain_equivalent false setvar dspf_vialayer_bounding_box 10
`-libgen_path` libgen_binary_path
	Specifies the location of the LibGen library. This is used only to specify a library outside the IC hierarchy. By default, the software uses the library available in the IC hierarchy. For example, `-libgen_path /tools.lnx86/ssvtools/bin/voltus_libgen \`
`-tech_file` tech_file_name
	Specifies the technology file to be used for reading the technology data.
`-tech_lef_file` tech_lef_file_name
	Specifies the LEF information for the technology data. This parameter is not specified when the OA libraries are specified.
`-type {static \| dynamic}`
	Specifies the type of analysis for which you want to generate power-grid views.
`-macro_lef_file` macro_lef_file_name
	Specifies the LEF information for the design. Note: If the technology data and design data are in the same LEF file, use any of the two options, `-tech_lef_file` or `-macro_lef_file` to specify the filename. In this case, it is an optional parameter.
`-sim_dir` simulation_dir
	Specifies the simulation directory for the current data.
`-lef_layer_map` lef_layer_map_file_name
	Specifies the mapping between LEF layer names and technology layer names. The syntax of the layer map file is as follows: #type technology_layer_name lefdef lef_layer_name Example: # ---- --------------------- ----- ------------- metal METAL_1 lefdef M1 via VIA_1 lefdef VIA1 metal METAL_2 lefdef M2 via VIA_2 lefdef VIA2 where “type” can be `poly/via/metal/diff`. This is an optional parameter. If not specified, the software automatically generates the layer map file.
`-oa_lib` list_of_libraries
	Specifies the OpenAccess (OA) database library name for PGV generation. When this option is specified, the layer map file is automatically generated. However, you can also specify the layer map file by using the`-lef_layer_map` parameter. Note: The parameters, `-tech_lef_file` /`-macro_lef_file` and `-oa_lib` are mutually exclusive.
`-pgdb_layer_map pgdb_layermap_file_name`
	Specifies the mapping between the xDSPF file layer names, written in the simulation database, and the technology layer names. The syntax of the layer map file is as follows: # type technology_layer_name pgdb xDSPF_layer_name Example: # ---- --------------------- ---- --------------- poly POLYCIDE pgdb poly via CONT pgdb pl1co via CONT pgdb odCont1 via CONT pgdb odCont2 metal METAL_1 pgdb metal1 via VIA_1 pgdb VIA1 metal METAL_2 pgdb metal2 via VIA_2 pgdb VIA2 diff OD pgdb nwires diff OD pgdb mwires where “type” can be `poly/via/metal/diff`. Ensure that all the xDSPF file layer names are mapped to the technology layer names. You can map multiple xDSPF file layer names to a single technology layer name. This is shown in the above example. If this parameter is not specified, Voltus-Fi automatically generates the layer map file.
`-pgdb_version` version_number
	Specifies the PGDB version. It is only used when you want to use an older PGDB version instead of the default version, which is the latest available version. For example, `-pgdb_version 9.1` Default: The latest version
`-trigger_file` trigger_file_name
	Specifies the trigger file that is used during a dynamic current simulation to run a detailed analysis for determining the current distribution.
`-output_directory` directory
	Specifies the name of the output directory for power-grid view generation. By default, the power-grid views are stored in the work directory.
`-uti_Ron_file` Ron_report_file_dumped_by_Spectre
	Specifies the `UTI-RON` file that contains multiple on-resistance (Ron) values, that is, minimum, maximum, and average `(min/avg/max)`values, for powergates. If this file is not specified, Voltus-Fi-XL uses the `RON` values from the MMSIM simulation database (`*.emir#_bin` file`)`.
`-create_no_device_nets true \| false`
	When set to `true`, creates power-grid views even when a net has no current file. This is used to capture the nets with only physical data (RC grid) and no electrical data (taps). Default: `false`
`-create_no_device_signal_nets true \| false`
	When set to `true`, creates power-grid views even when a signal net has no current file. This is used to capture the signal nets with only physical data (RC grid) and no electrical data (taps). Default: `false`
`-powergate_state_flow true \| false`
	When set to `true`, searches for power gate state files (`*pwg_state)` and passes them to LibGen. The power gate state files are searched in the UTI Ron directory in which the UTI Ron file is specified. If the UTI Ron file or directory is not specified, then this option does not have any effect even when set to `true`. Examples: `create_pgv` `-uti_ron_dir simout/output.pg.state/xps.raw/emir_uti.raw/` `-powergate_state_flow true` In the above example, the power gate state files are searched in the `emir_uti.raw` directory. `create_pgv` `-uti_ron_file simout/output.pg.state/xps.raw/xps.emirtap.pwg_ron` `-powergate_state_flow true` In the above example, the power gate state files are searched in the `xps.raw` directory in which the UTI Ron file, `xps.emirtap.pwg_ron`, has been specified. Power gate state files are generated by Spectre only when the following option is set: `eisopt report_pwg_state=yes`
`-use_pwl_files true \| false`
	When set to `true`, searches for net-specific PWL files instead of current (`pti`) files in the simulation directory and passes them to LibGen through the `.vhdr` files. Default*: `false`
`-map_connectivity_layers true \| false`
	Controls the handling of `wires` layers. When set to `true`, the `wires` layer resistors are assigned to the layers of its connecting nodes. When set to `false`, the `wires` layer resistors are assigned to the layers specified in the PGDB layer map file. Default*: `true`
`-units` value	Specifies the value of a variable used in PGV generation in database units per micron. Default: `1000` Example: `create_pgv` `-units 10000` In the above example, the value of the variables used in PGV generation is set to 10000 database units per micron.
`-stopAtVia` VIA_layer
	Stops the generation of the power-grid view inside a macro at the specified via layer. This via layer must be included in the PGDB layer map file and the simulation database. The stopAtVia layer should be the lowest via layer below which there should not be any port geometries. Example: `create_pgv` `-stopAtVia VIA_1`

Example

The following command is used to create power-grid views:

create_pgv
-macro_name design1
-lib_name ether
-tech_file RCgen.tch
-type dynamic
-tech_lef_file tech.lef
-macro_lef_file mac.lef
-sim_dir pgv-sim-132 
-lef_layer_map lefdef.layermap.txt
-pgdb_layer_map pgdpmap.txt
-trigger_file trigger_vps.txt
-use_pwl_files true
-output_directory ./vps_pgv_1

update_pgv

update_pgv
-library library_name
-trigger_file trigger_file_name
[-library_prefix prefix]
[-output_directory directory]
[-libgen_path libgen_binary_path]
[-libgen_cmd_file cmd_file_name]
[-force]

Updates a power-grid view (PGV) incrementally.

Parameters

`-library` library_name
	Specifies the name of the library that contains the old PGV.
`-trigger_file` trigger_file_name
	Specifies the trigger file to update the old PGV.
`-library_prefix` prefix
	Specifies the prefix for the generated PGV library (prefix`.cl`).
`-output_directory` directory
	Specifies the name of the output directory in which the merged PGV is created.
`-libgen_path` libgen_binary_path
	Specifies the location of the LibGen library. This is used only to specify a library outside the IC hierarchy. By default, Voltus-Fi uses the library available in the IC hierarchy. For example, `-libgen_path /tools.lnx86/ssvtools/bin/voltus_libgen \`
`-libgen_cmd_file` cmd_file_name
	Specifies the name of the LibGen command file that includes LibGen commands, if any, required to be specified for creating PGVs. For example, the LibGen command file may contain the following commands: setvar source_drain_equivalent false setvar dspf_vialayer_bounding_box 10
`-force`	Updates the report forcefully even if the taps or current sources of every net do not match the existing PGV.

Example

The following command updates the PGVs contained in the ether library. The merged PGV will be created in the vps_pgv_2 directory:

update_pgv \
-library ether \
-trigger_file trigger_vps.txt \
-output_directory ./vps_pgv_2

set_mmsim_pgv_nets

set_mmsim_pgv_nets 
-net net_names 
-voltage voltage_value 
-voltage_source_nets voltage_source_only_nets
-results_file result_file_name
[-prefix prefix_name]
[-feedthru_nets {net1 net2 net#}]

Specifies the nets for which you want to create power-grid views (PGVs) in the MMSIM flow. You can use this command to specify multiple PGV nets at a time.

Parameters

`-net` net_names	Specifies the names of nets for which you want to create PGVs.
`-voltage` voltage_value
	Specifies the voltage of the net.
`-voltage_source_nets` voltage_source_only_nets
	Specifies the names of nets that are connected only to voltage sources and for which a current file, with a `.pti` extension, is not available.
`-results_file` result_file_name
	Specifies the simulation result file to be used. The naming convention of the simulation result file is, `*.emir#_bin`.
`-prefix` prefix_name
	Specifies the name of the prefix used while performing the simulation.
`-feedthru_nets {net1 net2 net#}`	Specifies the feedthrough or dummy power nets for the PGV generation. When specified, generates EM views for the specified feedthrough or dummy nets in the PGV flow. EM views are generated for the specified feedthrough or dummy nets even if there are no current (`pti`) files or power-grid data for these nets from Spectre simulation.

Example

The following command is used to create power-grid views for nets VSS and VDD, voltage source net, CEN, and feedthrough net, WEN:

set_mmsim_pgv_nets \ -net {VDD VSS CEN} \ -voltage {1.1 0 1.1} \ -results_file /emirtap.emir0_bin \ -voltage_source_nets {CEN} -prefix XO. -feedthru_nets {WEN}

report_vfi_XL_ron

report_vfi_XL_ron
-pin_pair_file file_name
-output_file file_name

Generates the layer-wise on-resistance (RON) report for IR drop and EM analysis for the specified pin-pairs in Voltus-Fi-XL.

Parameters

-output_file file_name

Specifies the name of the output file to be created with the RON report.

This is a required parameter.

-pin_pair_file file_name

Specifies the name of the pin-pair file that contains information about all the pin pairs for which the RON report is to be generated. The pins in each pair are separated by a space. Multiple pin-pairs can be specified in different lines.

The software reports the RON between each pin-pair listed in the file.

This is a required parameter.

Example

The following command creates a RON report in the output.rpt file for the pin-pairs specified in the pin_pair.txt file:
```
report_vfi_XL_ron -pin_pair_file pin_pair.txt -output_file output.rpt
```

search_res_id

search_res_id
-x x_location
-y y_location
-layer extracted_layer_name
[-net net_name]
-name resistor_name

Specifies the location and other information related to the resistor that is being queried in Voltus-Fi-XL. You can either search a specific resistor by providing its location, layer name, and net name; or query it by providing the name of the resistor.

You can also specify this command in a Tcl file (conf.tcl) and specify the file in the EMIR control file by using the following emirutil command as follows:

emirutil postTclCmdFile=[conf.tcl]

Parameters

-`layer` extracted_layer_name
	Specifies the name of the extracted layer on which the resistor is located. This parameter is only required if the resistor name is not being specified using the `-name` parameter.
`-name` resistor_name
	Specifies the name of the resistor to be queried. When this parameter is specified, no other parameter is required to be specified. If any other parameter is specified, it will be ignored.
`-net` net_name	Specifies the name of the net. This is an optional parameter. This parameter is only specified if the resistor name is not being specified using the `-name` parameter.
`-x` x_location	Specifies the X-co-ordinate of the resistor to be queried. This parameter is only required if the resistor name is not being specified using the `-name` parameter.
`-y` y_location	Specifies the Y-co-ordinate of the resistor to be queried. This parameter is only required if the resistor name is not being specified using the `-name` parameter.

Examples

The following command is used to query a resistor at the specified co-ordinates on metal layer, m1:
```
search_res_id
-x 4.78
-y 9.75 
-layer m1 
```
The following command is used to query a specific resistor, Ra12:
```
search_res_id -name Ra12
```

res_id_info

res_id_info
-id res_id
[-type {default/a/w/l/La/Lu/Lb/Wu/Wb/delta_T/Lv2v_rms/Tj/Tlife/Td/thickness/r/Iavg/Ipeak/Irms/Iabs_avg/Ipos_avg/Ineg_avg/Iavg_max/Ipeak_max/Irms_max/Iacpeak_max/T/N/name/layer/netName/node1/node2/type/x/y/current_direction/feolT/beolT/beta/alpha/alpha_connecting/alpha_overlapping}]

Specifies the information to be queried for the specified resistor (pRes) in Voltus-Fi-XL.

You can also specify this command in a Tcl file (conf.tcl) and specify the file in the EMIR control file by using the following emirutil command as follows:

emirutil postTclCmdFile=[conf.tcl]

Parameters

`-id` res_id	Specifies the pRes ID for which the information is to be queried. This is a required parameter.
-`type`	Specifies the type of information to be queried for the pRes. You can specify any number of options detailed below. The query will output the values of the specified options for the pRes.
	`default`: When this option is specified, the software returns a set of values for the specified pRes in a specific format. An example of the default output of this command is provided below: name : rx3 layer : m1 netName : VG node1 : VG#2 node2 : XX1/M0#g type : Metal x : 4.780 y : 9.784 current_direction : UnKnown w : 0.02 l : 0.1 Iavg : 3.41e-10 Ipeak : 9.25e-07 Irms : 1.28e-07 Iavg_max : 6.6e-05 Ipeak_max : 0 Irms_max : 0 Iacpeak_max : 0 delta_T : 5 Td : 0.000315 r : 0.0315 rmsLv2v : 1.8e+308 Iavg_rule : (w3) 1.1 * 1 : (l <= 5)
	`a`: Retrieves the area of the pRes.
	`w`: Retrieves the width of the pRes.
	`l`: Retrieves the Blech length of the pRes.
	`La`: Retrieves the length of the pseudo vias.
	`Lu`: Retrieves the upper metal Blech length.
	`Lb`: Retrieves the bottom metal Blech length.
	`Wu`: Retrieves the upper metal width.
	`Wb`: Retrieves the lower metal width.
	`delta_T`: Retrieves the `delta_T` value. For more information, see `delta_T` in the “Variables” chapter.
	`Lv2v_rms`: Retrieves the distance between vias for the RMS analysis.
	`Tj`: Retrieves the temperature to be used for EM analysis.
	`Tlife`: Retrieves the lifetime for which the EM analysis was performed.
	`Td` : Retrieves the time duration in micro second or total “On Time” period.
	thickness: Retrieves the thickness of the layer.
	`r`: Retrieves the duty ratio.
	`Iavg`: Retrieves average current value.
	`Ipeak`: Retrieves peak current value.
	`Irms`: Retrieves RMS resistor current value.
	`Iabs_avg`: Retrieves absolute of average current value.
	`Ipos_avg`: Retrieves average current value in the positive direction.
	`Ineg_avg`: Retrieves average current value in the negative direction.
	`Iavg_max`: Retrieves the maximum average Current Density.
	`Ipeak_max`: Retrieves the maximum peak Current Density.
	`Irms_max`: Retrieves the maximum RMS Current Density.
	`Iacpeak_max`: Retrieves the maximum AC peak Current Density.
	`T`: Retrieves the total time of EM analysis.
	`N`: Retrieves the number of vias.
	`name`: Retrieves the name of the pRes.
	`layer`: Retrieves the layer name.
	`netName`: Retrieves the net name.
	`node1`: Retrieves the name of the first node connected to the pRes.
	`node2`: Retrieves the name of the second node connected to the pRes.
	`type`: Retrieves the type of layer, which may be metal, via, or pseudo via.
	`x`: Retrieves the x-coordinate of the pRes.
	`y`: Retrieves the Y-coordinate of the pRes.
	`current_direction`: Retrieves the current direction flow between nodes 1 and 2 of the resistors.

Examples

The following set of commands are used to query the specified resistor on metal layer, m1,for the specified information:
Step1: Search resistor id:
```
set rid  [search_res_id -x 3.75 -y 8.35 -layer m1] 
```
Step2: Get specific information from resistor id:
```
puts [res_id_info  -id $rid -type Iacpeak_max]
```
```
0
```

The following set of commands are used to query the specified resistor, Ra12, for all information:

Step1: Search resistor id:

set rid [search_res_id -name Ra12]

Step2: Get specific information from resistor id:

puts [res_id_info -id $rid]
name : ra12

layer : via1

netName : VDD

node1 : VDD#1

node2 : VDD#2

type : Via

x : 4.825

y : 9.269

current_direction : Down

w : 0.02

l : 6

Iavg : 1.06e-05

Ipeak : 2.15e-05

Irms : 1.5e-05

Iavg_max : 1e-05

Ipeak_max : 0

Irms_max : 0

Iacpeak_max : 0

delta_T : 5

Td : 0.00493

r : 0.493

a : 0.33

N : 1

Lu : 6

Wu : 0.06

Lb : 0.1

Wb : 0.02

rmsLv2v : 1.8e+308

Iavg_rule : 0.01 * 1 * 1

search_node_id

search_node_id
-x x_location
-y y_location
-layer extracted_layer_name
[-net net_name]

Specifies the information required to search for the node to be queried in Voltus-Fi-XL.

You can also specify this command in a Tcl file (conf.tcl) and specify the file in the EMIR control file by using the following emirutil command as follows:

emirutil postTclCmdFile=[conf.tcl]

Parameters

-`layer` extracted_layer_name
	Specifies the name of the extracted layer on which the node is located. This is a required parameter.
`-net` net_name	Specifies the name of the net. This is an optional parameter.
`-x` x_location	Specifies the x-coordinate for the node to be searched. This is a required parameter.
`-y` y_location	Specifies the y-coordinate for the node to be searched. This is a required parameter.

Example

The following command is used to search for a node at the specified coordinates on metal layer, m2:

search_res_id
-x 3.75 \
-y 8.35 \
-layer m2

node_id_info

node_id_info
-id node_id
[-type {default/name/x/y/IRavg/IRpeak}]

Specifies the information to be retrieved for the specified resistor in Voltus-Fi-XL.

You can also specify this command in a Tcl file (conf.tcl) and specify the file in the EMIR control file by using the following emirutil command as follows:

emirutil postTclCmdFile=[conf.tcl]

Parameters

`-id` node_id	Specifies the node ID for which the information is to be retrieved. This is a required parameter.
-`type`	Specifies the type of information to be retrieved for the node. You can specify from the options detailed below using this parameter.
	`default:` When this option is specified, the software returns a set of values for the specified node in a specific format. An example of the default output of this command is provided below: name : VG#2 x : 4.780 y : 9.834 IRavg : 8.54e-07 IRpeak : 0.00224 netName : VG
	name: Retrieves the name of the node.
	`x`: Retrieves the x-coordinate for the node.
	`y`: Retrieves the y-coordinate for the node.
	`IRavg`: Retrieves the average voltage drop for the node.
	`IRpeak`: Retrieves the peak voltage drop for the node.

Example

The following set of commands are used to query the specified node on metal layer, m2,for the specified information:

Step1: Search node id:

set nid [search_node_id -x 3.75 -y 8.35 -layer m2]

Step2: Get specific information from node id:

puts [node_id_info -id $nid -type IRavg]

Voltus-Fi Custom Power Integrity Solution XL User GuideProduct Version IC23.1, August 2023

15

Batch Commands in Voltus-Fi-XL

extract_xdspf

Parameters

Examples

ground_pins

Parameters

Example

Related Topics

power_pin

Parameters

Example

Related Topics

run_static_simulation

Parameters

Examples

Related Topics

setup_simulation

Parameters

Example

Related Topics

load_ir_results

Parameter

Example

Related Topics

print_ir_report

Parameters

Examples

Related Topics

print_rlrp_report

Parameters

Example

pin_2_pin_res

Parameters

Example

Related Topics

print_subnode_to_tap_path_report

Parameters

Example

Related Topics

load_em_results

Parameters

Example

Related Topic

print_em_report

Parameters

Examples

Related Topic

load_view

Parameters

Example

Related Topic

print_thermal_report

Parameters

Example

Related Topic

setMultiCpuUsage

Parameters

Related Topics

setDistributeHost

Parameters

Related Topics

create_pgv

Parameters

Example

Related Topics

update_pgv

Parameters

Example

Related Topics

set_mmsim_pgv_nets

Parameters

Example

Related Topics

report_vfi_XL_ron

Parameters

Example

Related Topic

search_res_id

Voltus-Fi Custom Power Integrity Solution XL User Guide
Product Version IC23.1, August 2023

loa d_em_results