Upload 100 files

src_en/api.add_mapped_instance.txt

@@ -0,0 +1,6 @@
+<h3 id='___add_mapped_instance'>add_mapped_instance</h3>
+<pre>Add mapped instance pair between REF and IMP
+<b>Usage:</b> add_mapped_instance($ref_instance, $imp_instance);
+<b>Examples:</b>
+  add_mapped_instance("u_subtop/u_def/state_reg", "u_subtop/uinst_def/state_reg");
+</pre>

src_en/api.buffer.txt

@@ -0,0 +1,21 @@
+<h3 id='___buffer'>buffer</h3>
+<pre>ECO command. Buffer high fanout ECO nets
+<b>Usage:</b> buffer($net_names, $buffer_name, $fanout);
+$net_names: Net names to be buffered. Use "," to separate multiple nets, like "eco1_net1,reset2"
+$buffer_name: The buffer module name from library, leave it blank to let the tool pick one.
+              It supports repeater case by ",", for example, "INVX1,INVX16" would have 'INVX1'
+              drives 'INVX16' and 'INVX16' drives the fanouts.
+$fanout: How many fanout to insert a buffer.
+
+<b>Examples:</b>
+
+#1. For every 10 fanout of test_mode, add a buffer, BUFX6
+buffer("test_mode", "BUFX6", 10); 
+
+#2. For every 10 fanout of 'clock', add repeaters, INVX2,INVX16
+buffer("clock", "INVX2,INVX16", 10);
+
+#3. Let the tool pick a buffer
+buffer("clock", "", 10);
+
+</pre>

src_en/api.change_gate.txt

@@ -0,0 +1,39 @@
+<h3 id='___change_gate'>change_gate</h3>
+<pre>ECO command. Modify an instance in ECO
+Two types of usages
+<b>Usage1:</b> change_gate($instance, $new_reference, $pin_mapping);
+$instance: The instance under ECO. Support hierarchical name, "u_abc/U123"
+$new_reference: The new reference name which the instance changes to, E.G. 'AND3X1'. 
+                If no reference is present, the ECO operation is assumed to 
+                  change the instance's pin connections.
+$pin_mapping: Input pins mapping, ".new(old)", E.G. ".A1(A),.B1(B)"
+              if two references have same input pins. The option can be empty
+<b>Usage2:</b> change_gate($instance, $pin_connections);
+$pin_connections: New pin connections, ".A(n242)".
+                  The unspecified pins keeps the original connection.
+                  E.G. pin 'B' connection is unchanged.
+
+<b>Examples:</b>  
+
+#1. U123 has reference OR3X1 with input pins, A,B,C originally
+# change U123 to AND3X1, all input pins are the same.
+change_gate('U123', 'AND3X1', ""); 
+
+#2. A and B keep the connections, discard C
+change_gate('U123', 'AND2X1', "");
+
+#3. A keeps the connections, B connects to what the old C connects. And discard old B
+change_gate('U123', 'AND2X1', ".B(C)"); 
+
+#4. A,B,C keep the same, and new D pin connects to net n123
+change_gate('U123', 'AND4X1', ".D(n123)"); 
+
+#5. AO21X1 has input pins, A0, A1 and B0 
+change_gate('U123', 'AO21X1', ".A0(A),.A1(B),.B0(C)");
+
+#6. change U123 A to n123, B to n124, keep C connection. 
+change_gate("U123", ".A(n123),.B(n124)"); 
+
+#7. Rotating A/B/C connections.
+change_gate("U123", ".A(B),.B(C),.C(A)"); 
+</pre>

src_en/api.change_net.txt

@@ -0,0 +1,25 @@
+<h3 id='___change_net'>change_net</h3>
+<pre>ECO command. Change a existing net's driver
+<b>Usage:</b> change_net($net, $gate, $instance, $connections);
+$net: The net to be ECOed
+$gate: New leaf gate to drive the net
+$instance: The instance name of the new gate. Optional, if it is empty, assigned by the tool
+$connections:  The new gate input pins connections. If it is empty, the gate is inserted in the net
+   Supported formats, 1. Very detail  ".A(net0),.B(net1),.C(net2)"
+                      2. Connect to the pins in alphabetical sequence 
+                          "net1,net0,net2" indicating A->net1,B->net0,C->net2
+                      3. Other instance/pin "U408/Y,U409/Y,net2" indicating A->U408/Y,B->U409/Y,C->net2
+                      4. Special character '-' is used to connect up the original connection
+
+<b>Examples:</b>
+
+#1. Drive n123 with BUFX2 driven by n40
+change_net("n123", "BUFX2", "", "n40");   
+
+#2. Drive n123 with AND2X2 driven by n40 and original n123 driver
+change_net("n123", "AND2X2", "", "-,n40");    
+
+#3. Insert a buffer into n123
+change_net("n123", "BUFX2");   
+
+</pre>

src_en/api.change_pin.txt

@@ -0,0 +1,74 @@
+<h3 id='___change_pin'>change_pin</h3>
+<pre>ECO command. Modify pin connection of instances by inserting gates, changing connection to other signal (LLM: change pin insert gate)
+Two types of usages. 
+
+<b>Usage1:</b> change_pin($pin_name, $net);
+Change pin's connection to a net
+$pin_name: In the format of "instance/pin", can be more than one pins separated by ",",
+             "instance1/pinA,instance2/pinB", E.G. "U123/A", "U123/A,U345/B"
+             Hierarchical naming style is supported as well, "u_abc/U123/A"
+             The pins have to be input in this mode.
+$net: The net name the pin connects to.
+      Hierarchical naming style is supported, "u_abc/net123"
+      When the pin and the net are in different hierarchies, ports are added automatically
+      E.G. 
+      # The tool creates 4 ports across the hierarchies to connect the net to the pin.
+      change_pin("u_abc/u_cde/U200/A", "u_xyz/u_stv/net300");
+      # The tool gets the net tie to Y pin of U300 and do the the same as the previous example.
+      change_pin("u_abc/u_cde/U200/A", "u_xyz/u_stv/U300/Y");
+
+<b>Usage2:</b>my $inst = change_pin($pin_name, $leaf_cell, $new_instance, $connection);
+Insert a new leaf cell to drive the pin
+$inst: Return new instance name if new gate is created in the command.
+$pin_name: In the format of "instance/pin", E.G. U123/A  Hierarchical naming is supported, u_abc/U123/A
+           The pin can be output in this mode. The tool gets the net the pin drives,
+             and change the command to 
+             change_net($thenet, $leaf_cell, $new_instance, $connection);
+$leaf_cell: The leaf cell name to drive the $pin_name
+$new_instance: The instance name for the new inserted leaf cell. 
+               The option is optional, the tool assigns one if it's empty
+               If use '.', the instance is added to the same hierarchy as the $pin_name
+$connection: The pins connection for the new cell. 
+   Supported formats, 1. Detail format:  ".A(net0),.B(net1),.C(net2)"
+                      2. Simple format: Connect to the pins in alphabetical sequence "net1,net0,net2"
+                      3. Mixed format: "u_abc/U123/Y,.B(net1),net2"
+                      4. Special character '-' is used to connect up the original connection
+                      5. Advanced nesting format: 
+                         change_pin("U189/A", "AOI21X2", "", "U190/Y,,BUFX6(BUFX6(BUFX6(n412)))");
+
+<b>Note:</b> All strings should be quoted by ' or " to avoid syntax error or undesired effects.
+     
+
+<b>Examples:</b>
+
+#1. U123 has input pins A,B,C, U234 has input pins A0,A1,B
+# Change A pin of U123 to net12345
+change_pin("U123/A", "net12345"); 
+
+#2. Change A pin of U123 to $net which is defined in the ECO script.
+change_pin("U123/B", $net); 
+
+#3. Change A pin of U123 to net12345
+change_pin("U123/A,U234/B", "net12345");
+
+#4. Insert "NAND2X2 eco12345_U0(.A(net1234),.B(net5678));"
+# to drive U123/A
+change_pin("U123/A", "NAND2X2", "eco12345_U0", "net1234,net5678"); 
+
+#5. Same as above, with more detail of pin connections
+change_pin("U123/A", "NAND2X2", "eco12345_U0", ".A(net1234),.B(net5678)"); 
+
+#6.Insert a buffer to U123 A pin
+change_pin("U123/A", "BUFX4", "", "-"); 
+
+#7. Insert NAND2X1 to drive CK pin and new A connects to the original net
+change_pin("abc_reg_1_/CK", "NAND2X1", "", ".A(-),.B(1'b1)"); 
+
+#8. Do hierarchical connection
+change_pin("u_abc/u_cde/U200/A", "u_xyz/u_stv/U300/Y"); 
+
+#9. Nested connection
+change_pin("qcif/num2/u_spare1/B", "AOI21X2", "eco_inst_on_top1", \
+           "NAND2X2(gte_344/u_smod/U100/Y, gte_344/n114), gte_343/U111, BUFX6(BUFX6(n105))");
+
+</pre>

src_en/api.change_port.txt

@@ -0,0 +1,26 @@
+<h3 id='___change_port'>change_port</h3>
+<pre>ECO command. Change an output port's driver, or add gate after input port 
+<b>Usage1:</b> change_port($port, $gate, $instance, $connections);
+$port: The port under ECO, can be input port or output port
+$gate: New leaf gate to drive the port if the port is output
+       Or add the gate after input port
+$instance: The instance name for the new leaf cell, optional, the tool assigns one if it's empty
+$connections: The new gate input pins connections. If it is empty, the gate is inserted in the net
+   Supported formats, 1. Very detail  ".A(net0),.B(net1),.C(net2)"
+                      2. Connect to the pins in alphabetical sequence 
+                          "net1,net0,net2" indicating A->net1,B->net0,C->net2
+                      3. Other instance/pin "U408/Y,U409/Y,net2" indicating A->U408/Y,B->U409/Y,C->net2
+                      4. Special character '-' is used to connect up the original connection
+<b>Usage2:</b> change_port($port, $inst_pin);
+$port: The port under ECO, output port
+$inst_pin: In the format of 'u1234/Y', instance-name/pin-name
+<b>Note:</b> The difference of change_net and change_port command
+      change_net changes all drains of the net.
+      change_port changes only the port driver.
+
+<b>Examples:</b>
+
+#1. Add buffer to output port 'out1'
+change_port("out1", "BUFX1", "eco_buf0", "-");
+
+</pre>

src_en/api.check_design.txt

@@ -0,0 +1,18 @@
+<h3 id='___check_design'>check_design</h3>
+<pre>Check if the netlist status, searching for unresolved modules, floating and multi-drivers 
+<b>Usage:</b> check_design(@options);
+@options:
+   -ignore list: Ignore the issues matching the list, E.G. 'FE_UNCONNECT*,SCAN_*'. 
+   -eco: Only check instances/wires having been done ECO. Default check all instances/wires
+   -fixfile filename: Create ECO fix file
+   -nouniquify: Dont check uniquify
+
+<b>Examples:</b>
+
+check_design;
+check_design('-ignore', 'FE_UNCONNECT*');
+check_design('-ignore', 'FE_UNCONNECT*,SCAN_*');
+check_design('-ignore', 'W-108');
+check_design("-eco");
+
+</pre>

src_en/api.compare.txt

@@ -0,0 +1,17 @@
+<h3 id='___compare'>compare</h3>
+<pre>Logic equivalence check on output port and register input pins
+<b>Usage:</b> my $no_eq_num = compare(@nets, @options);
+@options:
+   -help: Print this info
+$no_eq_num: Return back non-equivalent number
+
+<b>Examples:</b>
+
+#1. Check if output port 'state_out' is equivalent in IMP/REF netlists
+compare("state_out");
+
+#2. Check two points at the same time.
+    Check if 'state_reg_0_/D' is equivalent in IMP/REF netlists
+    And check if 'state_reg_1_/D' are equivalent in IMP/REF netlists
+compare("state_reg_0_/D", "state_reg_1_/D");
+</pre>

src_en/api.compare_nets.txt

@@ -0,0 +1,14 @@
+<h3 id='___compare_nets'>compare_nets</h3>
+<pre>Check equivalence of two nets in the reference and implementation netlist
+<b>Usage:</b> my $result = compare_nets($net0, $net1, @options);
+$net0: The net in the reference netlist.
+$net1: The net in the implementation netlist.
+@options:
+$result: 1, they are equal, 
+         0, they are not equal.
+
+<b>Examples:</b>
+
+#1 Compare reg1/D in the reference and reg1/D in the implementation netlist
+compare_nets("reg1/D", "reg1/D");
+</pre>

src_en/api.convert_gated_clocks.txt

@@ -0,0 +1,6 @@
+<h3 id='___convert_gated_clocks'>convert_gated_clocks</h3>
+<pre>ECO command. Convert gated clocks to MUX logic.
+In metal ECO, if gated clock cell is not in spare gate list, this command should run before map_spare_cells
+<b>Usage:</b> my $cnt = convert_gated_clocks();
+$cnt: The number of gated clock cells having been converted
+</pre>

src_en/api.create_clock.txt

@@ -0,0 +1,18 @@
+<h3 id='___create_clock'>create_clock</h3>
+<pre>Timing command and GOF Formal command. Create clock for fault verification
+<b>Usage:</b> create_clock($clock_name, $clock_period);
+$clock_name: Clock name, input port name or black box instance output pin
+$clock_period: Clock period
+
+<b>Note:</b> This command can be used multiple times. The clock period is recommended to be multiples of 2
+
+<b>Examples:</b>
+
+#1. Create clock on PIN_SPI_CLK, period 4ns
+create_clock("PIN_SPI_CLK", 4);
+
+#2. Create clock on PIN_APB_CLK and PLL clk_out
+create_clock("PIN_APB_CLK", 2);
+create_clock("u_pll_top/u_pll_core/clk_out", 2);
+
+</pre>

src_en/api.create_pin_mapping_json_file.txt

@@ -0,0 +1,5 @@
+<h3 id='___create_pin_mapping_json_file'>create_pin_mapping_json_file</h3>
+<pre>Create pin mapping file between original synthesis netlist and pre-ECO netlist
+<b>Usage:</b> create_pin_mapping_json_file($filename);
+$filename: JSON file name
+</pre>

src_en/api.create_reset.txt

@@ -0,0 +1,16 @@
+<h3 id='___create_reset'>create_reset</h3>
+<pre>Create reset for the design
+<b>Usage:</b> create_reset($reset_name, $active_level);
+$reset_name: Reset name, input port name or black box instance output pin
+$active_level: The level that the reset is active
+
+<b>Examples:</b>
+
+#1. Create reset on PIN_RESETN, active low
+create_reset("PIN_RESETN", 0);
+
+#2. Create reset on PIN_RESET, active high
+create_reset("PIN_RESET", 1);
+
+
+</pre>

src_en/api.current_design.txt

@@ -0,0 +1,8 @@
+<h3 id='___current_design'>current_design</h3>
+<pre>Set the current top level module (LLM: current design module)
+<b>Usage:</b> current_design($module);
+$module: Set $module as the current top level module.
+         If the argument is missing, return the current setting
+         ".." set to parent module, "~" set to the most top level module 
+<b>Note:</b> It can be reset to the root top module by 'undo_eco'. It is alias command of 'set_top'
+</pre>

src_en/api.current_instance.txt

@@ -0,0 +1,8 @@
+<h3 id='___current_instance'>current_instance</h3>
+<pre>Set the current instance, alias of 'set_inst'
+<b>Usage:</b> current_instance($instance);
+$instance: Set $instance as the current instance.
+         If the argument is missing, return the current setting
+         ".." set to parent module, "~" set to the most top level module 
+<b>Note:</b> It can be reset to the root top module by 'undo_eco'. It has same effect of 'set_top' and 'current_design'
+</pre>

src_en/api.del_gate.txt

@@ -0,0 +1,5 @@
+<h3 id='___del_gate'>del_gate</h3>
+<pre>ECO command. Delete gate
+<b>Usage:</b> del_gate($inst);
+$inst: The instance to be deleted.
+</pre>

src_en/api.del_net.txt

@@ -0,0 +1,5 @@
+<h3 id='___del_net'>del_net</h3>
+<pre>ECO command. Delete net
+<b>Usage:</b> del_net($net);
+$net: The net to be deleted.
+</pre>

src_en/api.del_port.txt

@@ -0,0 +1,5 @@
+<h3 id='___del_port'>del_port</h3>
+<pre>ECO command. Delete port
+<b>Usage:</b> del_port($port);
+$port: The port to be deleted.
+</pre>

src_en/api.dft_drc.txt

@@ -0,0 +1,17 @@
+<h3 id='___dft_drc'>dft_drc</h3>
+<pre>DFT DRC checker
+<b>Usage:</b> my $error = dft_drc(@options);
+$error: DRC errors in the checker
+@options:
+    -single: One clock for each scan chain
+    -glitch: Check reset/set pin glitch
+
+<b>Examples:</b>
+
+#1. Run full DFT DRC
+dft_drc;
+#2. One clock for each scan chain in DRC
+dft_drc("-single");
+#3. Check reset/set pin glitch
+dft_drc("-glitch");
+</pre>

src_en/api.elab_rtl.txt

@@ -0,0 +1,4 @@
+<h3 id='___elab_rtl'>elab_rtl</h3>
+<pre>Elaborate on RTL design
+<b>Usage:</b> elab_rtl();
+</pre>

src_en/api.elaborate.txt

@@ -0,0 +1,4 @@
+<h3 id='___elaborate'>elaborate</h3>
+<pre>Elaborate and compile RTL files
+<b>Usage:</b> elaborate();
+</pre>

src_en/api.exist_inst.txt

@@ -0,0 +1,6 @@
+<h3 id='___exist_inst'>exist_inst</h3>
+<pre>Check if an instance exists (LLM: instance existence)
+<b>Usage:</b>my $ret = exist_inst($inst);
+$inst: The instance for checking
+$ret: 1, the instance exists 0, the instance does not exist
+</pre>

src_en/api.exist_wire.txt

@@ -0,0 +1,6 @@
+<h3 id='___exist_wire'>exist_wire</h3>
+<pre>Check if a wire exists (LLM: wire existence)
+<b>Usage:</b>my $ret = exist_wire($wire);
+$wire: The wire name for checking
+$ret: 1: exists 0: not exist
+</pre>

src_en/api.find_equal_nets.txt

@@ -0,0 +1,11 @@
+<h3 id='___find_equal_nets'>find_equal_nets</h3>
+<pre>Find equivalent nets in IMP for the listed nets in REF, the results are printed out on the screen
+<b>Usage:</b> find_equal_nets(@ref_nets);
+options: ("help","full=i")
+   -help: Print this info
+
+<b>Examples:</b>
+
+#1. Find IMP equal nets for 'mbist_done', 'sync_start' in REF
+find_equal_nets('mbist_done', 'sync_start');
+</pre>

src_en/api.fix_design.txt

@@ -0,0 +1,31 @@
+<h3 id='___fix_design'>fix_design</h3>
+<pre>ECO command to fix the design in automatic ECO (LLM: automatic eco)
+<b>Usage:</b> fix_design(@options);
+@options:
+    -help: Print this information
+    -opt_set optimization_set: Patch optimization set, 0: area/timing 1: cell count, default 0
+    -no_patch_opt: Disable patch optimization. Also see API set_no_patch_opt
+    -flatten: Enable flatten mode ECO. The default mode is hierarchical
+    -list_file the_list_file: The ECO point list file converted from RTL-to-RTL LEC result
+             The list file format:
+                inst u_def/u_sdef/state_reg_1_
+                pin  u_control/u_sreg/u_mem_128x24/A[0]
+                port PORT_READY_OUT
+    -iteration iteration_number: Fix design iteration by default 3 times.
+          The tool repeats the fix process until there is no non-equivalent points or iteration number reached
+<b>Examples:</b>
+
+#1. Fix design on module 'VIDEO_TOP' and its sub-modules
+set_top('VIDEO_TOP');
+set_ignore_output("TEST_SO*");
+set_pin_constant("TEST_EN", 0);
+fix_design;
+save_session("this_eco");
+my $error = LEC;
+
+#2. Do ECO in flatten mode
+fix_design("-flatten");
+
+#3. Do ECO on points listed in the file
+fix_design("-list_file", $list_file);
+</pre>

src_en/api.fix_logic.txt

@@ -0,0 +1,24 @@
+<h3 id='___fix_logic'>fix_logic</h3>
+<pre>ECO command. Fix listed points
+<b>Usage:</b> fix_logic(@pin_port_list,@options);
+@options:
+    -force: Force the tool to replace the logic cone of the points in @pin_port_list
+@pin_port_list: 
+    List of the pins or ports whose logic will be fixed by the reference logic in Reference Netlist
+     The format is "sic_cnt_reg_0/D","sic_cnt_reg_1/D",'\bbr_ccd_reg[0] /D',"out_port"
+     '\' should be kept if the instance has '\' as prefix. 
+     E.G. '\bbr_ccd_reg[0] ' instance has '\' and last space in the name.
+
+
+<b>Examples:</b>
+
+#1. Fix state_regs's D inputs
+fix_logic("state_reg_0/D", "state_reg_1/D");
+
+#2. Fix state_regs's D inputs and one output port
+fix_logic("state_reg_0/D", "state_reg_1/D", "out_port");
+
+#3. Add one new flop, input pins have the same connections as the Reference Netlist
+#  and the output is floating, -recover option sets to 0
+fix_logic('new_flop_reg/D', 'new_flop_reg/CK', 'new_flop_reg/RB');
+</pre>

src_en/api.flatten_modules.txt

@@ -0,0 +1,10 @@
+<h3 id='___flatten_modules'>flatten_modules</h3>
+<pre>Flatten hierarchical modules in reference netlist
+<b>Usage:</b> flatten_modules(@module_names);
+@module_names: List of modules to be flatten
+
+<b>Examples:</b>
+
+flatten_modules("retime_1", "sync_cell_0");
+
+</pre>

src_en/api.get_cell_cofactors.txt

@@ -0,0 +1,18 @@
+<h3 id='___get_cell_cofactors'>get_cell_cofactors</h3>
+<pre>Get combinational cell pin Shannon expansion cofactors
+<b>Usage:</b> @cofactors = get_cell_cofactors($cell, $pin);
+$cell: Leaf cell name
+$pin: Input pin name
+@cofactors: Shannon cofactors for the pin of the cell
+            It has two items if the cell is combinational 
+            It is empty if the cell is sequential or black-box
+
+<b>Examples:</b>
+
+#1. NAND2X1 A pin 
+@ret = get_cell_cofactors("NAND2X1", "A"); # @ret = (1, B);
+#2. AOI222X1 A0 pin
+@ret = get_cell_cofactors("OAI222X4", "A0"); 
+returned @ret = ("!(A1*(B0*(C0+C1)+!B0*(B1*(C0+C1))))", "!(B0*(C0+C1)+!B0*(B1*(C0+C1)))");
+
+</pre>

src_en/api.get_cell_info.txt

@@ -0,0 +1,39 @@
+<h3 id='___get_cell_info'>get_cell_info</h3>
+<pre>Get information of a module or instance (LLM: information)
+<b>Usage:</b> $data = get_cell_info($module_or_inst, @options);
+$module_or_inst: The module or instance's name
+@options:
+    -help: Print this information
+    -conns: Get Connections of the item, only when it's instance
+    -type: Get the item's type information. It can be 'ff','cg,'latch','buf', 
+            run 'get_lib_cells -type_info' for all existing type in the current libraries
+            An array is returned if this option is present
+    -libname: Get the library name that the cell is in
+    -area: Get the area of the item
+    -size: Get the size of the item
+    -fun:  Get the function string of the item
+    -leakage: Get the leakage of the item
+    -ref:     Same as 'get_ref instance' if the item property is instance
+    -context: Get detail library information
+    -attribute attribute_name: Check if the cell has the attribute set. 0 or 1 is returned
+$data: Returned data, if '-attribute' option is present, $data is 0 or 1
+In option is '-conns' case,
+It is a hash having the following data structure
+my $module = $hash->{module};
+my $instance: $hash->{instance};
+foreach my $port (keys %{$hash->{connections}}){
+    my $net = $hash->{connections}{$port};
+}
+
+If no option is present, it return the item's property:
+leaf_instance leaf_module hierarchical_instance hierarchical_module 
+
+<b>Examples:</b>
+
+#1. Get area of one leaf cell
+my $area = get_cell_info("AND2X2", "-area");
+
+#2. Get an attribute of one leaf cell
+my $is_iso = get_cell_info("ISOX2", "-attribute", "is_isolation_cell");
+
+</pre>

src_en/api.get_cells.txt

@@ -0,0 +1,47 @@
+<h3 id='___get_cells'>get_cells</h3>
+<pre>Get all cells in the current module or sub-modules (LLM: find/get instance)
+<b>Usage:</b> my @cells = get_cells($pattern, @options);
+$pattern: The pattern matching instance name, '*', 'U*', 'U123' or '/UI_.*_./' 
+          It can have path, 'u_clk/*', 'u_abc/u_def/*'
+@options:
+    -help: Print this information
+    -hier: Or -h, do the command hierarchically
+    -ref ref_pattern: Get cells that has reference matching ref_pattern, E.G. -ref OAI*
+    -type type_pattern: Type_pattern can be 'ff','latch','itiming','cg','not','rom','ram' ... 
+                        run 'get_lib_cells -type_info' for all existing type in the current libraries
+    -type_match type_pattern: Get cells that have one of the types matches the type_pattern
+    -leaf: Only leaf cells
+    -new: Only new created ECO instances
+    -verbose: To print out reference with instance
+    -dotpath: Path delimit is '.' instead of '/'
+    -nobackslash: Remove backslash 
+    -nonscan: Flops/sync-cells not in scan chain including those scan pins tied off
+@cells: Returned array with all instances matched
+
+<b>Examples:</b>
+
+#1. Get all instances in the current module 
+my @cells = get_cells('*');
+
+#2. Get all instances in the current module 
+my @cells = get_cells();
+
+#3. Get all instances matching 'U234*' in the current module
+my @cells = get_cells('U234*');
+
+#4. Regular expression. Get all instances starting with U and followed by 
+#    two characters, like U10, U99
+my @cells = get_cells('/U../');   
+
+#5. Get all instances matching *reg_*_ hierarchically
+my @cells = get_cells('*reg_*_', '-hier');
+
+#6. Get all instances hierarchically and having reference matching DFF*
+my @cells = get_cells('*', '-hier', '-ref', 'DFF*');
+
+#7. Get all instances in 'u_kb'
+my @cells = get_cells('u_kb/*');
+
+#8. Get all flops, sync-cells not in scan chain 
+my @cells = get_cells('-hier', '-nonscan');
+</pre>

src_en/api.get_conns.txt

@@ -0,0 +1,40 @@
+<h3 id='___get_conns'>get_conns</h3>
+<pre>Get connections of net or pin in the top level module, return the leafs and the hierarchical connections (LLM: conns)
+<b>Usage:</b> @result = get_conns($net_or_pin, @options);
+$net_or_pin: The net name or pin name that needs to get connections.
+@options:
+   -driver: Return driver only
+   -load: Return load only
+   -count: Return connections count
+@result: a two dimension array
+          instance, port_name, pin_or_port, load_or_driver, is_it_a_leaf, 
+@result = ([instance_0, pin_0, 'pin', 'load', 1],
+           ...
+          )
+
+<b>Examples:</b>
+
+#1. Net 'n599' has three connections, instance 'U198' is the driver
+get_conns("n599");
+gte_344 A[14] pin load 0
+U198 Y pin driver 1
+U94 AN pin load 1
+
+#2. Net 'qcifhbeat' has three connections, it is output port of the current top level module
+get_conns("qcifhbeat")
+ qcifhbeat port load
+U80 A pin load 1
+qcifhbeat_reg Q pin driver 1
+
+#3. The argument in inst/pin format
+get_conns("U187/A")
+U294 A1 pin load 1
+U187 A pin load 1
+U80 Y pin driver 1
+
+#4. Return connections count
+get_conns("U187/A", "-count");
+3
+
+
+</pre>

src_en/api.get_coord.txt

@@ -0,0 +1,10 @@
+<h3 id='___get_coord'>get_coord</h3>
+<pre>Get an instance's coordination (LLM: coordination)
+<b>Usage:</b> my ($x, $y) = get_coord($instance);
+$instance: Instance name
+
+<b>Examples:</b>
+
+my ($x, $y) = get_coord("xbar/U1234");
+# $x=100, $y=200 in um
+</pre>

src_en/api.get_definition.txt

@@ -0,0 +1,11 @@
+<h3 id='___get_definition'>get_definition</h3>
+<pre>Get instantiation of instance
+<b>Usage:</b> my $line = get_definition($inst);
+$inst: Instance name.
+$line: The instantiating line
+
+<b>Examples:</b>
+
+get_definition('U78');
+Returns "AND2X1 U78(.A(n1), .B(n2), .Z(n3));"
+</pre>

src_en/api.get_driver.txt

@@ -0,0 +1,35 @@
+<h3 id='___get_driver'>get_driver</h3>
+<pre>Get the driver of a net or pin (LLM: driver)
+<b>Usage:</b> @driver = get_driver($point, @options);
+$point: net name or pin name, 'n12345' or 'U12345/A1'
+@options:
+   -pin: Return in "inst/pin" format, E.G. "state_reg/Q"
+         Return an array if '-pin' is not present
+   -nonbuf: Trace the drivers until none buffer 
+@driver: The driver in array format, if '-pin' is not present.
+         If the point is floating, @driver is empty, 
+         $driver[0]: Driver instance name. It is empty if the driver is port
+         $driver[1]: Driver pin or port name. If the driver is a port, it is the port name
+         $driver[2]: Driver type. It is string "pin" or "port" depending on the driver is port or leaf cell
+         $driver[3]: Driver phase. It is valid when -nonbuf is present, 
+                     indicating if the driver path is inverted
+                     0: not inverted 1: inverted              
+
+<b>Note:</b>
+1. If '-pin' is present, return a scalar, $driver = get_driver("n12345", "-pin");
+2. Use 'get_drivers' if there are multiple drivers, the return data has different structure
+
+<b>Examples:</b>
+
+#1. Get driver of a net
+@driver = get_driver("net12345");
+@driver has content of ("U1247", "Y", "pin");
+
+#2. port_abc is input port
+@driver = get_driver("port_abc"); 
+@driver has content of ("", "port_abc", "port");
+           
+#3. Return in instance/pin format
+$driver = get_driver("net12345", "-pin");
+$driver has content of "U1247/Y"
+</pre>

src_en/api.get_drivers.txt

@@ -0,0 +1,37 @@
+<h3 id='___get_drivers'>get_drivers</h3>
+<pre>Get the drivers of a net or pin (LLM: drivers)
+<b>Usage:</b> @drivers = get_drivers($point, @options);
+$point: net name or pin name, 'n12345' or 'U12345/A1'
+@options:
+   -nonbuf: Trace the drivers until none buffer 
+@drivers: An array of the drivers, if the point is floating, @drivers is empty, 
+         if the point has multi-drivers, @drivers has more than one items.
+         For each item in @drivers
+         Index 0: instance, it is empty if the driver is port
+         Index 1: pin or port, if the driver is port, return port
+         Index 2: string "pin" or "port" depending on the driver is port or leaf cell
+         Index 3: indicating drive path inverted or not
+         If 'nonbuf' is present, the last item in @drivers is the non-buffer driver
+         So '$nonbuf = pop @drivers' can get the non-buffer driver 
+<b>Note:</b>
+Use 'get_driver' instead if the net has only one driver and 'nonbuf' option is not used
+
+<b>Examples:</b>
+
+#1. Get drivers of a net
+@drivers = get_drivers("net12345");
+@drivers has content of (["U1247", "Y", "pin"]);
+
+#2. 'port_abc' is input port
+@drivers = get_drivers("port_abc"); 
+@drivers has content of (["", "port_abc", "port"]);
+   
+#3. Buffers in the path
+ @drivers = get_drivers("state_reg/CK", "-nonbuf");
+ @drivers has content of
+  (
+    ["buf_inst0", "Y", "pin"],
+    ["inv_inst1", "Y", "pin"],
+    ["and_inst2", "Y", "pin"]
+  )
+</pre>

src_en/api.get_instance.txt

@@ -0,0 +1,16 @@
+<h3 id='___get_instance'>get_instance</h3>
+<pre>Get instance in the top level module
+<b>Usage:</b> my $instance = get_instance($pattern, @options);
+$pattern: Match pattern, can have wildcard "*", if it is empty, it is treated as "*"
+@options:
+    -module: module name to have its instance name found
+$instance: Return the first instance matching
+
+<b>Examples:</b>
+
+#1. The fist hierarchical instance matching 'ui_*'.
+$instance = get_instance("ui_*");  
+
+#2. Find the instance name of module 'enet_control' 
+$instance = get_instance("-module", "enet_control");   
+</pre>

src_en/api.get_instances.txt

@@ -0,0 +1,12 @@
+<h3 id='___get_instances'>get_instances</h3>
+<pre>Get all hierarchical instances in the top level module (LLM: hierarchical instances)
+<b>Usage:</b> my @instances = get_instances($pattern);
+$pattern: Match pattern, can have wildcard "*", if it is empty, it is treated as "*"
+
+@instances: Array of the hierarchical instances
+
+<b>Examples:</b>
+
+@instances = get_instances("UI_*"); # Any hierarchical instances with UI_ as prefix.
+@instances = get_instances;         # All hierarchical instances. 
+</pre>

src_en/api.get_leaf_pin_dir.txt

@@ -0,0 +1,12 @@
+<h3 id='___get_leaf_pin_dir'>get_leaf_pin_dir</h3>
+<pre>Get leaf cell pin's direction input/output/inout
+<b>Usage:</b> my $dir = get_leaf_pin_dir("$leaf_name/$pin");
+$pin: pin name, E.G.  A or B or Y
+$leaf: Leaf cell name, E.G. NAND2X2
+$dir: return direction, input/output/inout
+
+<b>Examples:</b>
+
+my $dir = get_leaf_pin_dir("NAND2X2/A");
+
+</pre>

src_en/api.get_leafs_count.txt

@@ -0,0 +1,16 @@
+<h3 id='___get_leafs_count'>get_leafs_count</h3>
+<pre>Get all leaf cells name and count in the top level module, return an array 
+<b>Usage:</b> @leaf_count = get_leafs_count;
+@leaf_count: Array of leaf name and count
+ ( [leaf0, cnt0], [leaf1, cnt1], ...)
+
+<b>Examples:</b>
+
+@leaf_count = get_leafs_count;
+foreach my $leaf_point (@leaf_count){
+   my $leaf_name = $leaf_point->[0];
+   my $count = $leaf_point->[1];
+   print "LEAF: $leaf_name has $count cells
+";
+}
+</pre>

src_en/api.get_lib_cells.txt

@@ -0,0 +1,13 @@
+<h3 id='___get_lib_cells'>get_lib_cells</h3>
+<pre>Get leaf gates in libraries 
+<b>Usage:</b> my @cells = get_lib_cells($pattern, @options);
+@options:
+     -help:            This information
+     -char:            All cells characterization
+     -type leaf_type:  Get leaf gates matching type. 
+                       Leaf_type can be 'ff', 'latch', 'cg', 'buf', 'not', 'and' ...
+     -type_info:       List all types in the current loaded libraries
+     -verbose:         If $pattern matches only one lib cell, print the cell lib information
+$pattern: Library cell name pattern, can have '*'.
+@cells: Return array with name matching
+</pre>

src_en/api.get_loads.txt

@@ -0,0 +1,19 @@
+<h3 id='___get_loads'>get_loads</h3>
+<pre>Get loads of net in the top level module, return the leafs connections (LLM: loads)
+<b>Usage:</b> @result = get_loads($net_or_pin, @options);
+$net_or_pin: The net name or pin name that needs to get fanouts.
+@options:
+   -nonbuf: Trace the loads until none buffer 
+   -bypbuf: Don't include buffer/inverter in the return array
+   -hier: Loads cross hierarchies
+   -fanend: Fanout endpoints, flops or ports
+@result: A two dimension array. Each item has format of 'instance' and 'pin_name' if
+         the load is leaf cell. Or 'port_name' and 'GOF_PIN_IN' 
+@result = ([instance_0, pin_0],
+           [instance_1, pin_1],
+           [port_name, GOF_PIN_IN],
+           ...
+          )
+
+
+</pre>

src_en/api.get_loads_phase.txt

@@ -0,0 +1,16 @@
+<h3 id='___get_loads_phase'>get_loads_phase</h3>
+<pre>Get loads of net with phase in the top level module, return the non-buffer/inverter leafs connections (LLM: loads with phase)
+<b>Usage:</b> @result = get_loads_phase($net_or_pin, @options);
+$net_or_pin: The net name or pin name that needs to get fanouts.
+@options:
+   -help: This information
+@result: A two dimension array. Each item has format of 'instance', 'pin_name' and 'phase', if
+         the load is leaf cell. Or 'port_name', 'GOF_PIN_IN' and 'phase' 
+@result = ([instance_0, leaf_0, pin_0, 0],
+           [instance_1, leaf_0, pin_1, 1],
+           [port_name,  GOF_CELL_OUTPORT,GOF_PIN_IN, 1],
+           ...
+          )
+
+
+</pre>

src_en/api.get_logic_cone.txt

@@ -0,0 +1,14 @@
+<h3 id='___get_logic_cone'>get_logic_cone</h3>
+<pre>Get logic cone of nets or pins
+<b>Usage:</b> $result = get_logic_cone(@InstancePinList, @options);
+@InstancePinList: Instance/pin and net list. 
+$result: 1, the command fails. 0, the command completed successfully
+@options:
+    -o file_name: Write output to the file. Default logic_cone.v
+
+<b>Examples:</b>
+
+my @InstPin = ('abc_reg/D', 'n12345');
+my $ret = get_logic_cone(@InstPin, '-o', 'MyLogicCone.v');
+# The logic cone is written out to verilog file 'MyLogicCone.v'
+</pre>

src_en/api.get_modules.txt

@@ -0,0 +1,15 @@
+<h3 id='___get_modules'>get_modules</h3>
+<pre>Get modules under current module (LLM: submodules)
+<b>Usage:</b> @modules = get_modules($pattern, @options);
+$pattern: Match pattern, can have wildcard "*", if it is empty, it is treated as "*"
+@options:
+    -help: Print this information
+    -hier: Get all modules hierarchically
+@modules: Modules list, ("module0", "module1", ...)
+
+<b>Examples:</b>
+
+@modules = get_modules("*TM*");  # Any hierarchical modules with TM in the name.
+@modules = get_modules;          # All hierarchical modules.
+@modules = get_modules("-hier"); # All hierarchical modules and sub-modules under current module.
+</pre>

src_en/api.get_net_of.txt

@@ -0,0 +1,6 @@
+<h3 id='___get_net_of'>get_net_of</h3>
+<pre>Get net name connecting to a pin (LLM: net of pin)
+<b>Usage:</b> my $net = get_net_of($pin);
+$pin: The pin of the instance, 'U1234.A1' or 'U1234/A1' 
+$net: The net name connecting to the pin
+</pre>

src_en/api.get_nets.txt

@@ -0,0 +1,21 @@
+<h3 id='___get_nets'>get_nets</h3>
+<pre>Get nets that matching pattern (LLM: matched nets)
+<b>Usage:</b> @nets = get_nets($pattern, @options);
+$pattern: The net naming pattern, "*" or empty for all nets
+@options:;
+   -const0: Get all constant zero nets
+   -const1: Get all constant one nets
+@nets: returned net array.
+
+<b>Examples:</b>
+ 
+1#. Get all nets.
+@nets = get_nets("*"); 
+
+2#. All nets with 'dbuffer' as prefix 
+@nets = get_nets("dbuffer_*"); 
+
+3#. Get constant nets
+@nets = get_nets("-const0"); 
+
+</pre>

src_en/api.get_path.txt

@@ -0,0 +1,5 @@
+<h3 id='___get_path'>get_path</h3>
+<pre>Get current hierarchical path (LLM: path)
+<b>Usage:</b> $path = get_path();
+$path: The current path
+</pre>

src_en/api.get_pins.txt

@@ -0,0 +1,30 @@
+<h3 id='___get_pins'>get_pins</h3>
+<pre>Get pins of instance or module (LLM: pins)
+<b>Usage:</b> @pins = get_pins($name, @options);
+$name: The instance or module name, it can be hierarchical or leaf
+@options:
+    -input: Get input pins
+    -output: Get output pins
+    -inout: Get inout pins
+    -clock: Get clock pin, only valid for sequential cell, flop latch and gated-clock-cell
+    -reset: Get reset pin, return "" if it doesn't exist
+    -set:   Get set pin, return "" if it doesn't exist
+    -data: Get data pins
+    -attribute attribute: Get pins with the attribute
+    -nextstate_type type: Get pins matching the type 
+            which can be 'data', 'load', 'scan_in', 'scan_enable'
+            This option is only valid for sequential cell, flop, latch and gated-clock-cell
+If no option is present, get all pins
+@pins: All pins returned, in 'instance/pin' format
+
+<b>Examples:</b>
+
+#1. Get input pins of a hierarchical instance
+my @pins = get_pins("-input", "u_abc/U123");
+Result @pins = ("u_abc/U123/A", "u_abc/U123/B")
+
+#2. Get pins of a leaf cell
+@pins = get_pins("AND2X2");
+Result @pins = ("A","B","Y") 
+
+</pre>

src_en/api.get_ports.txt

@@ -0,0 +1,25 @@
+<h3 id='___get_ports'>get_ports</h3>
+<pre>Get all ports in the current top level module (LLM: ports)
+<b>Usage:</b> @matching_ports = get_ports($pattern, @options);
+$pattern: Match pattern, can have wildcard "*". If it is empty, it is treated as "*"
+@options:
+          -input: Get input ports only
+          -output: Get output ports only
+          -inout: Get inout ports only
+          -bus: Get ports in bus format instead of bit blast. 
+                The API returns an array point if this option present
+                The item in the array has format of [port, IsBus, MaxIndex, MinIndex]
+                if IsBus == 1, MaxIndex is the Max Index of the bus, E.G, 7 if the bus is port_a[7:0]
+                if ISBus==0, MaxIndex and MinIndex are not defined
+  
+If no option is present, get all ports
+
+@matching_ports: Return ports matching the pattern and the option specified in 
+                  the current top level module
+
+<b>Examples:</b>
+
+@ports = get_ports("-input", "dsp2mc_*");  # Get input ports with "dsp2mc_" as prefix
+@ports = get_ports;                       # Get all ports
+
+</pre>

src_en/api.get_ref.txt

@@ -0,0 +1,6 @@
+<h3 id='___get_ref'>get_ref</h3>
+<pre>Get the reference of the instance, return leaf cell name or hierarchical module name (LLM: design name)
+<b>Usage:</b> $reference = get_ref($instance);
+$instance: Instance name, "U123"
+$reference: Return reference name, "NAND2X4" 
+</pre>