Merge pull request #7837 from eder-matheus/ppl_doc

ppl: error handling and documentation

Author: maliberty

src/odb/src/swig/tcl/odb.tcl

@@ -734,6 +734,9 @@ proc set_io_pin_constraint { args } {
       } elseif { $interval == "*" } {
         set begin [ppl::get_edge_extreme "-region" 1 $edge]
         set end [ppl::get_edge_extreme "-region" 0 $edge]
+      } else {
+        utl::error PPL 212 "Invalid value for \'-region edge:interval\'. Set the interval as the\
+                wildcard \'*\' or as a range \'begin-end\' in microns."
       }
 
       if { [info exists keys(-direction)] && [info exists keys(-pin_names)] } {

src/ppl/README.md

@@ -79,7 +79,7 @@ set_io_pin_constraint
 | ----- | ----- |
 | `-direction` | Pin direction (`input`, `output`, `inout`, or `feedthrough`). |
 | `-pin_names` | List of names. Only one of (`-direction`, `-pin_names`) should be used in a single call for the `set_io_pin_constraint` command. |
-| `-region` | Syntax is `-region edge:interval`. The `edge` values are (`top\|bottom\|left\|right`). The `interval` can be the whole edge with the wildcard `*` value or a range of values. |
+| `-region` | Syntax is `-region edge:interval`. The `edge` values are (`top\|bottom\|left\|right`). The `interval` can be the whole edge with the wildcard `*` value or a range of values `begin-end` in microns. For example, in `-region right:15-60` the interval is on the right edge from 15 microns to 60 microns.|
 | `-mirrored_pins` | List of pins that sets pairs of pins that will be symmetrically placed in the vertical or the horizontal edges. The number of pins in this list **must be even**. For example, in `set_io_pin_constraint -mirrored_pins {pin1 pin2 pin3 pin4 pin5 pin6}`, the pins `pin1` and `pin2` will be placed symmetrically to each other. Same for `pin3` and `pin4`, and for `pin5` and `pin6`. |
 | `-group` | Flag places together on the die boundary the pin list defined in `-pin_names,` similar to the `-group_pins` option on the `place_pins` command. |
 | `-order` | Flag places the pins ordered in ascending x/y position and must be used only when `-group` is also used. |

src/ppl/test/CMakeLists.txt

@@ -30,6 +30,7 @@ or_integration_tests(
     add_constraint_error7
     add_constraint_error8
     add_constraint_error9
+    add_constraint_error10
     annealing1
     annealing2
     annealing3

src/ppl/test/add_constraint_error10.ok

@@ -0,0 +1,7 @@
+[INFO ODB-0227] LEF file: Nangate45/Nangate45.lef, created 22 layers, 27 vias, 135 library cells
+[INFO ODB-0128] Design: gcd
+[INFO ODB-0130]     Created 54 pins.
+[INFO ODB-0131]     Created 88 components and 422 component-terminals.
+[INFO ODB-0133]     Created 54 nets and 88 connections.
+[ERROR PPL-0212] Invalid value for '-region edge:interval'. Set the interval as the wildcard '*' or as a range 'begin-end' in microns.
+PPL-0212

src/ppl/test/add_constraint_error10.tcl

@@ -0,0 +1,10 @@
+# gcd_nangate45 IO placement
+source "helpers.tcl"
+read_lef Nangate45/Nangate45.lef
+read_def gcd.def
+
+catch {
+  set_io_pin_constraint -group -order -region left:90.3 -pin_names {resp_msg[0] req_msg[0]
+  resp_msg[1] req_msg[1] resp_msg[2] req_msg[2] resp_msg[3]}
+} error
+puts $error