2017-07-15 10:35:02 -05:00
|
|
|
.. -*- Mode: rst -*-
|
|
|
|
|
|
|
|
|
|
|
|
CGT - The Graphical Interface
|
|
|
|
=============================
|
|
|
|
|
|
|
|
The |Coriolis| graphical interface is split up into two windows.
|
|
|
|
|
|
|
|
* The **Viewer**, with the following features:
|
|
|
|
|
|
|
|
* Basic load/save capabilities.
|
2019-06-04 07:32:23 -05:00
|
|
|
* Displays the current working cell. Could be empty if the design
|
2017-07-15 10:35:02 -05:00
|
|
|
is not yet placed.
|
2019-06-04 07:32:23 -05:00
|
|
|
* Executes Stratus Scripts.
|
2017-07-15 10:35:02 -05:00
|
|
|
* Menu to run the tools (placement, routage).
|
|
|
|
|
|
|
|
Features are detailed in `Viewer & Tools`_.
|
|
|
|
|
|
|
|
|ViewerSnapShot_1|
|
|
|
|
|
2019-06-04 07:32:23 -05:00
|
|
|
* The **Controller**, which allows to:
|
2017-07-15 10:35:02 -05:00
|
|
|
|
2019-06-04 07:32:23 -05:00
|
|
|
* Tweak what is displayed by the *Viewer*. Through the *Look*,
|
2017-07-15 10:35:02 -05:00
|
|
|
*Filter* and *Layers&Gos* tabs.
|
|
|
|
* Browse the |netlist| with eponym tab.
|
|
|
|
* Show the list of selected objects (if any) with *selection*
|
|
|
|
* Walk through the Database, the Cell or the Selection with *Inspector*.
|
|
|
|
This is an advanced feature, reserved for experimented users.
|
2019-06-04 07:32:23 -05:00
|
|
|
* The tab *Settings* which gives access to all the settings.
|
2017-07-15 10:35:02 -05:00
|
|
|
They are closely related to Configuration & Initialisation.
|
|
|
|
|
|
|
|
|bcenter| |ControllerSnapShot_1| |ecenter|
|
|
|
|
|
|
|
|
|
|
|
|
.. _Viewer & Tools:
|
|
|
|
|
|
|
|
Viewer & Tools
|
|
|
|
~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
|Stratus| Netlist Capture
|
|
|
|
-------------------------
|
|
|
|
|
|
|
|
|Stratus| is the replacement for |GenLib| procedural netlist capture language.
|
|
|
|
It is designed as a set of |Python| classes, and comes with it's own documentation
|
|
|
|
(`Stratus Documentation`_)
|
|
|
|
|
|
|
|
|
|
|
|
The |Hurricane| Data-Base
|
|
|
|
-------------------------
|
|
|
|
|
|
|
|
The |Alliance| flow is based on the |MBK| data-base, which has one data-structure
|
|
|
|
for each view. That is, |LOFIG| for the *logical* view and |PHFIG| for the *physical*
|
|
|
|
view. The place and route tools were responsible for maintaining (or not) the
|
|
|
|
coherency between views. Reflecting this weak coupling between views, each one
|
|
|
|
was stored in a separate file with a specific format. The *logical* view is stored
|
|
|
|
in a |vst| file in |VHDL| format and the *physical* in an |ap| file in an ad-hoc format.
|
|
|
|
|
|
|
|
The |Coriolis| flow is based on the |Hurricane| data-base, which has a unified
|
|
|
|
structure for *logical* and *physical* view. That data structure is the |Cell| object.
|
|
|
|
The |Cell| can have any state between pure netlist and completly placed and
|
|
|
|
routed design. Although the memory representation of the views has deeply
|
|
|
|
changed we still use the |Alliance| files format, but they now really represent
|
|
|
|
views of the same object. The point is that one must be very careful about
|
|
|
|
view coherency when going to and from |Coriolis|.
|
|
|
|
|
|
|
|
As for the second release, |Coriolis| can be used only for three purposes :
|
|
|
|
|
|
|
|
* **Placing a design**, in which case the |netlist| view must be present.
|
|
|
|
* **Routing a design**, in that case the |netlist|
|
|
|
|
view and the |layout| view must be present and |layout| view must contain
|
|
|
|
a placement. Both views must have the same name. When saving the routed design,
|
|
|
|
it is advised to change the design name otherwise the original unrouted placement
|
|
|
|
in the |layout| view will be overwritten.
|
|
|
|
* **Viewing a design**, the |netlist| view must be present, if a |layout|
|
|
|
|
view is present it still must have the same name but it can be in any
|
|
|
|
state.
|
|
|
|
|
|
|
|
|
|
|
|
Synthetizing and loading a design
|
|
|
|
---------------------------------
|
|
|
|
|
|
|
|
|Coriolis| supports several file formats. It can load all file format
|
|
|
|
from the |Alliance| toolchain (.ap for layout, behavioural and structural vhdl .vbe and .vst),
|
|
|
|
BLIF netlist format as well as benchmark formats from the ISPD contests.
|
|
|
|
|
|
|
|
It can be compiled with LEF/DEF support, although it requires acceptance of the SI2 license
|
|
|
|
and may not be compiled in your version of the software.
|
|
|
|
|
|
|
|
Synthesis under Yosys
|
|
|
|
.....................
|
|
|
|
|
|
|
|
You can create a BLIF file from the |Yosys| synthetizer, which can be imported under Coriolis.
|
|
|
|
Most libraries are specified as a .lib liberty file and a .lef LEF file.
|
|
|
|
|Yosys| opens most .lib files with minor modifications, but LEF support in Coriolis relies on SI2.
|
|
|
|
If Coriolis hasn't been compiled against it, the library is given in |Alliance| .ap format.
|
|
|
|
`Some free libraries <http://vlsitechnology.org>`_ already provide both .ap and .lib files.
|
|
|
|
|
|
|
|
Once you have installed a common library under |Yosys| and Coriolis, just synthetize your design
|
|
|
|
with |Yosys| and import it (as Blif without the extension) under Coriolis to perform place&route.
|
|
|
|
|
|
|
|
Synthesis under Alliance
|
|
|
|
........................
|
|
|
|
|
|
|
|
|Alliance| is an older toolchain but has been extensively used for years. Coriolis can import
|
|
|
|
and write Alliance designs and libraries directly.
|
|
|
|
|
2020-02-03 10:44:15 -06:00
|
|
|
|
2017-07-15 10:35:02 -05:00
|
|
|
Etesian -- Placer
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
The |Etesian| placer is a state of the art (as of 2015) analytical placer. It is
|
|
|
|
within ``5%`` of other placers' solutions, but is normally a bit worse than ePlace.
|
|
|
|
This |Coriolis| tool is actually an encapsulation of |Coloquinte| which *is* the placer.
|
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
.. note:: *Instance Uniquification:* a same logical instance cannot have
|
|
|
|
two different placements. So, if you don't supply a placement for it, it will be
|
|
|
|
uniquified (cloned) and you will see the copy files appears on disk upon saving.
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
|
|
|
|
|noindent|
|
|
|
|
**Hierarchical Placement**
|
|
|
|
|
|
|
|
The placement area is defined by the top cell abutment box.
|
|
|
|
|
|
|
|
When placing a complete hierarchy, the abutment boxes of the cells (models) other than
|
2019-06-04 07:32:23 -05:00
|
|
|
the top cell are set identical to the one of the top cell and their instances are
|
2017-07-15 10:35:02 -05:00
|
|
|
all placed at position ``(0,0,ID)``. That is, all the abutments boxes, whatever the
|
2019-06-04 07:32:23 -05:00
|
|
|
hierarchical level, define the same area (they are exactly superposed).
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
We choose this scheme because the placer will see all the instances as virtually
|
|
|
|
flattened, so they can be placed anywhere inside the top-cell abutment box.
|
|
|
|
|
|
|
|
|bcenter| |Etesian-1| |ecenter|
|
|
|
|
|
|
|
|
|
|
|
|
|noindent|
|
|
|
|
**Computing the Placement Area**
|
|
|
|
|
|
|
|
The placement area is computed using the ``etesian.aspectRatio`` and ``etesian.spaceMargin``
|
|
|
|
parameters only if the top-cell has an empty abutment box. If the top-cell abutment
|
|
|
|
box has to be set, then it is propagated to all the instances models recursively.
|
|
|
|
|
|
|
|
|
|
|
|
|noindent|
|
|
|
|
**Reseting the Placement**
|
|
|
|
|
|
|
|
Once a placement has been done, the placer cannot reset it (will be implemented
|
|
|
|
later). To perform a new placement, you must restart |cgt|. In addition, if you
|
|
|
|
have saved the placement on disk, you must erase any :cb:`.ap` file, which are
|
|
|
|
automatically reloaded along with the netlist (:cb:`.vst`).
|
|
|
|
|
|
|
|
|noindent|
|
|
|
|
**Limitations**
|
|
|
|
|
|
|
|
Etesian supports standard cells and fixed macros. As for the Coriolis 2.1 version,
|
|
|
|
it doesn't support movable macros, and you must place every macro beforehand.
|
|
|
|
Timing and routability analysis are not included either, and the returned placement
|
|
|
|
may be unroutable.
|
|
|
|
|
|
|
|
|
|
|
|
Etesian Configuration Parameters
|
|
|
|
................................
|
|
|
|
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
|
|
|
| Parameter Identifier | Type | Default |
|
|
|
|
+===================================+==================+============================+
|
|
|
|
| **Etesian Parameters** |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
|``etesian.aspectRatio`` | TypePercentage | :cb:`100` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | Define the height on width ``H/W`` aspect |
|
|
|
|
| | ratio, can be comprised between 10 and 1000 |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
|``etesian.spaceMargin`` | TypePercentage | :cb:`5` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | The extra white space added to the total area |
|
|
|
|
| | of the standard cells |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2023-06-10 07:45:07 -05:00
|
|
|
|``etesian.densityVariation`` | TypePercentage | :cb:`5` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
2023-06-10 07:45:07 -05:00
|
|
|
| | Control deviation from uniform density in the |
|
|
|
|
| | placement, as a percentage of area. |
|
2017-07-15 10:35:02 -05:00
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
|``etesian.effort`` | TypeInt | :cb:`2` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | Sets the balance between the speed of the |
|
|
|
|
| | placer and the solution quality |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
|``etesian.routingDriven`` | TypeBool | :cb:`False` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | Whether the tool will try routing iterations |
|
|
|
|
| | and whitespace allocation to improve |
|
|
|
|
| | routability; to be implemented |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
|``etesian.graphics`` | TypeInt | :cb:`2` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | How often the display will be refreshed |
|
|
|
|
| | More refreshing slows the placer. |
|
|
|
|
| | |
|
|
|
|
| | * ``1`` shows both upper and lower bounds |
|
|
|
|
| | * ``2`` only shows lower bound results |
|
|
|
|
| | * ``3`` only shows the final results |
|
|
|
|
+-----------------------------------+-----------------------------------------------+
|
|
|
|
|
|
|
|
|newpage|
|
|
|
|
|
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
Katana -- Global Router
|
|
|
|
-----------------------
|
2017-07-15 10:35:02 -05:00
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
The quality of |Katana| global routing solutions are equivalent to those of FGR_ 1.0.
|
|
|
|
For an in-depth description of |Katana| algorithms, you may download the thesis of
|
|
|
|
D. |Dupuis| avalaible from here~: `Knik Thesis`_ (|Knik| has been rewritten as part
|
|
|
|
of |Katana|, the algorithms remains essentially the same).
|
2017-07-15 10:35:02 -05:00
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
The global router is now deterministic.
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
Katana -- Detailed Router
|
|
|
|
-------------------------
|
2017-07-15 10:35:02 -05:00
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
|Katana| no longer suffers from the limitations of |Nero|. It can route big designs
|
2017-07-15 10:35:02 -05:00
|
|
|
as its runtime and memory footprint is almost linear (with respect to the number
|
|
|
|
of gates). It has successfully routed design of more than `150K` gates.
|
|
|
|
|medskip|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
**Slow Layer Assignment.** Most of the time, the layer assignment stage is
|
|
|
|
fast (less than a dozen seconds), but in some instances it can take more
|
|
|
|
than a dozen *minutes*. This is a known bug and will be corrected in later
|
|
|
|
releases.
|
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
After each run, |Katana| displays a set of *completion ratios* which must all
|
|
|
|
be equal to `100%` or (``NNNN+0``) if the detailed routing has been successfull.
|
|
|
|
In the event of a failure, on a saturated design, you may tweak the three
|
|
|
|
following configuration parameters:
|
|
|
|
|
|
|
|
#. ``katana.hTrackReservedLocal``, the number of track reserved for local routing,
|
|
|
|
that quantity is substracted from the edge capacities (global routing) to
|
|
|
|
give a sense of the cluttering inside the GCells.
|
|
|
|
#. ``katana.vTrackReservedLocal``, same as above.
|
2019-06-04 07:32:23 -05:00
|
|
|
#. ``etesian.spaceMargin``, increases the free area of the overall design so the
|
2019-05-27 11:49:51 -05:00
|
|
|
routing density decrease.
|
|
|
|
|
|
|
|
The idea is to increase the horizontal and vertical local track reservation until
|
2019-06-04 07:32:23 -05:00
|
|
|
the detailed router succeeds. But in doing so we make the task of the global router
|
|
|
|
more and more difficult as the capacity of the edges decreases, and at some point
|
2019-05-27 11:49:51 -05:00
|
|
|
it will fail too. So this is a balance.
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
Routing a design is done in four ordered steps:
|
|
|
|
|
|
|
|
#. Detailed pre-route :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Detailed PreRoute}`
|
|
|
|
#. Global routing :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Global Route}`
|
|
|
|
#. Detailed routing :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Detailed Route}`
|
|
|
|
#. Finalize routing :math:`\textbf{P\&R} \rightarrow \textbf{Step by Step} \rightarrow \textbf{Finalize Route}`
|
|
|
|
|
2019-06-04 07:32:23 -05:00
|
|
|
It is possible to supply to the router a complete wiring for some nets that the user
|
2017-07-15 10:35:02 -05:00
|
|
|
wants to be routed according to a specific topology. The supplied topology must respect
|
2019-05-27 11:49:51 -05:00
|
|
|
the building rules of the |Anabatic| database (contacts must be, *terminals*, *turns*, *h-tee*
|
|
|
|
& *v-tee* only). During the first step :fboxtt:`Detailed Pre-Route` the router will solve
|
2017-07-15 10:35:02 -05:00
|
|
|
overlaps between the segments, without making any dogleg. If no pre-routed topologies
|
|
|
|
are present, this step may be ommited. Any net routed at this step is then fixed and
|
|
|
|
become unmovable for the later stages.
|
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
After the detailed routing step the |Katana| data-structure is still active
|
2017-07-15 10:35:02 -05:00
|
|
|
(the Hurricane wiring is decorated). The finalize step performs the removal of
|
2019-05-27 11:49:51 -05:00
|
|
|
the |Katana| data-structure, and it is not advisable to save the design before
|
2017-07-15 10:35:02 -05:00
|
|
|
that step.
|
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
You may visualize the density (saturation) of either the edges (global routing)
|
2019-06-04 07:32:23 -05:00
|
|
|
or the GCells (detailed routing) until the routing is finalized. Special layers appear
|
2017-07-15 10:35:02 -05:00
|
|
|
to that effect in the `The Layers&Go Tab`_.
|
|
|
|
|
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
Katana Configuration Parameters
|
|
|
|
...............................
|
2017-07-15 10:35:02 -05:00
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
The |Anabatic| parameters control the layer assignment step.
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
All the defaults value given below are from the default |Alliance| technology
|
|
|
|
(:cb:`cmos` and :cb:`SxLib` cell gauge/routing gauge).
|
|
|
|
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
|
|
|
| Parameter Identifier | Type | Default |
|
|
|
|
+===================================+==================+============================+
|
2019-05-27 11:49:51 -05:00
|
|
|
| **Anabatic Parameters** |
|
2017-07-15 10:35:02 -05:00
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
|``anabatic.topRoutingLayer`` | TypeString | :cb:`METAL5` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | Define the highest metal layer that will be |
|
|
|
|
| | used for routing (inclusive). |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
|``anabatic.globalLengthThreshold`` | TypeInt | :cb:`1450` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | This parameter is used by a layer assignment |
|
|
|
|
| | method which is no longer used (did not give |
|
|
|
|
| | good results) |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``anabatic.saturateRatio`` | TypePercentage | :cb:`80` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | If ``M(x)`` density is above this ratio, |
|
|
|
|
| | move up feedthru global segments up from |
|
|
|
|
| | depth ``x`` to ``x+2`` |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``anabatic.saturateRp`` | TypeInt | :cb:`8` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | If a GCell contains more terminals |
|
|
|
|
| | (:cb:`RoutingPad`) than that number, force a |
|
|
|
|
| | move up of the connecting segments to those |
|
|
|
|
| | in excess |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2019-05-27 11:49:51 -05:00
|
|
|
| **Katana Parameters** |
|
2017-07-15 10:35:02 -05:00
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``katana.hTracksReservedLocal`` | TypeInt | :cb:`3` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | To take account the tracks needed *inside* a |
|
2020-02-03 10:44:15 -06:00
|
|
|
| | GCell to build the *local* routing, decrease |
|
|
|
|
| | the capacity of the edges of the global |
|
|
|
|
| | router. Horizontal and vertical locally |
|
|
|
|
| | reserved capacity can be distinguished for |
|
|
|
|
| | more accuracy. |
|
2017-07-15 10:35:02 -05:00
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``katana.vTracksReservedLocal`` | TypeInt | :cb:`3` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | cf. ``kite.hTracksReservedLocal`` |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``katana.eventsLimit`` | TypeInt | :cb:`4000002` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | The maximum number of segment displacements, |
|
|
|
|
| | this is a last ditch safety against infinite |
|
|
|
|
| | loop. It's perhaps a little too low for big |
|
|
|
|
| | designs |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``katana.ripupCost`` | TypeInt | :cb:`3` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | Differential introduced between two ripup |
|
2019-06-04 07:32:23 -05:00
|
|
|
| | costs to avoid a loop between two ripped up |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | segments |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``katana.strapRipupLimit`` | TypeInt | :cb:`16` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | Maximum number of ripup for *strap* segments |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``katana.localRipupLimit`` | TypeInt | :cb:`9` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | Maximum number of ripup for *local* segments |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``katana.globalRipupLimit`` | TypeInt | :cb:`5` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | Maximum number of ripup for *global* segments,|
|
|
|
|
| | when this limit is reached, triggers topologic|
|
|
|
|
| | modification |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``katana.longGlobalRipupLimit`` | TypeInt | :cb:`5` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | Maximum number of ripup for *long global* |
|
|
|
|
| | segments, when this limit is reached, triggers|
|
|
|
|
| | topological modification |
|
|
|
|
+-----------------------------------+------------------+----------------------------+
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. _Python Scripts in Cgt:
|
|
|
|
|
|
|
|
Executing Python Scripts in Cgt
|
|
|
|
-------------------------------
|
|
|
|
|
|
|
|
Python/Stratus scripts can be executed either in text or graphical mode.
|
|
|
|
|
|
|
|
.. note:: **How Cgt Locates Python Scripts:**
|
|
|
|
|cgt| uses the Python ``import`` mechanism to load Python scripts.
|
2019-06-04 07:32:23 -05:00
|
|
|
So you must give the name of your script whithout ``.py`` extension and
|
|
|
|
it must be reachable through the ``PYTHONPATH``. You may use the
|
2017-07-15 10:35:02 -05:00
|
|
|
dotted module notation.
|
|
|
|
|
2020-04-27 07:14:03 -05:00
|
|
|
A Python/Stratus script must contain a function called ``scriptMain()``
|
2017-07-15 10:35:02 -05:00
|
|
|
with one optional argument, the graphical editor into which it may be
|
|
|
|
running (will be set to ``None`` in text mode). The Python interface to
|
|
|
|
the editor (type: :cb:`CellViewer`) is limited to basic capabilities
|
|
|
|
only.
|
|
|
|
|
|
|
|
Any script given on the command line will be run immediatly *after* the
|
|
|
|
initializations and *before* any other argument is processed.
|
|
|
|
|
2020-02-03 10:44:15 -06:00
|
|
|
For more explanation on Python scripts see `Python Interface to Coriolis`.
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
|
|
|
|
Printing & Snapshots
|
|
|
|
--------------------
|
|
|
|
|
2019-06-04 07:32:23 -05:00
|
|
|
Printing or saving into a |pdf| is fairly simple, just use the **File -> Print**
|
2017-07-15 10:35:02 -05:00
|
|
|
menu or the |CTRL_P| shortcut to open the dialog box.
|
|
|
|
|
|
|
|
The print functionality uses exactly the same rendering mechanism as for the
|
|
|
|
screen, beeing almost *WYSIWYG*. Thus, to obtain the best results it is advisable
|
|
|
|
to select the ``Coriolis.Printer`` look (in the *Controller*), which uses a
|
2019-06-04 07:32:23 -05:00
|
|
|
white background and well suited for high resolutions ``32x32`` pixels patterns
|
2017-07-15 10:35:02 -05:00
|
|
|
|
2019-06-04 07:32:23 -05:00
|
|
|
There is also two modes of printing selectable through the *Controller*
|
2017-07-15 10:35:02 -05:00
|
|
|
**Settings -> Misc -> Printer/Snapshot Mode**:
|
|
|
|
|
|
|
|
=============== ================= =====================================================
|
|
|
|
Mode DPI (approx.) Intended Usage
|
|
|
|
--------------- ----------------- -----------------------------------------------------
|
|
|
|
**Cell Mode** 150 For single ``Cell`` printing or very small designs.
|
|
|
|
Patterns will be bigger and more readable.
|
|
|
|
**Design Mode** 300 For designs (mostly commposed of wires and cells
|
|
|
|
outlines).
|
|
|
|
=============== ================= =====================================================
|
|
|
|
|
|
|
|
.. note:: *The pdf file size*
|
|
|
|
Be aware that the generated |pdf| files are indeed only pixmaps.
|
|
|
|
So they can grew very large if you select paper format above ``A2``
|
|
|
|
or similar.
|
|
|
|
|
|
|
|
|
|
|
|
|noindent|
|
|
|
|
Saving into an image is subject to the same remarks as for |pdf|.
|
|
|
|
|
|
|
|
|
|
|
|
Memento of Shortcuts in Graphic Mode
|
|
|
|
------------------------------------
|
|
|
|
|
|
|
|
The main application binary is |cgt|.
|
|
|
|
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
|
|
|
| Category | Keys | Action |
|
|
|
|
+===============+===================+===========================================================+
|
2019-06-04 07:32:23 -05:00
|
|
|
| **Moves** | | |KeyUp|, | Shifts the view in the according direction |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | |KeyDown| | |
|
|
|
|
| | | |KeyLeft|, | |
|
|
|
|
| | |KeyRight| | |
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| **Fit** | |KeyF| | Fits to the Cell abutment box |
|
2017-07-15 10:35:02 -05:00
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
|
|
|
| **Refresh** | |CTRL_L| | Triggers a complete display redraw |
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
|
|
|
| **Goto** | |KeyG| | *apperture* is the minimum side of the area |
|
|
|
|
| | | displayed around the point to go to. It's an |
|
|
|
|
| | | alternative way of setting the zoom level |
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
|
|
|
| **Zoom** | |KeyZ|, | Respectively zoom by a 2 factor and *unzoom* |
|
|
|
|
| | |KeyM| | by a 2 factor |
|
|
|
|
| +-------------------+-----------------------------------------------------------+
|
|
|
|
| | | |BigMouse| | You can perform a zoom to an area. |
|
|
|
|
| | | Area Zoom | Define the zoom area by *holding down the left |
|
|
|
|
| | | mouse button* while moving the mouse. |
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
|
|
|
| **Selection** | | |BigMouse| | You can select displayed objects under an area. |
|
|
|
|
| | | Area Selection | Define the selection area by *holding down the |
|
|
|
|
| | | right mouse button* while moving the mouse. |
|
|
|
|
| +-------------------+-----------------------------------------------------------+
|
|
|
|
| | | |BigMouse| | You can toggle the selection of one object under |
|
|
|
|
| | | Toggle Selection| the mouse position by pressing |CTRL| and |
|
|
|
|
| | | pressing down *the right mouse button*. A popup |
|
|
|
|
| | | list of what's under the position shows up into |
|
|
|
|
| | | which you can toggle the selection state of one |
|
|
|
|
| | | item. |
|
|
|
|
| +-------------------+-----------------------------------------------------------+
|
|
|
|
| | |KeyCapS| | Toggle the selection visibility |
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
|
|
|
| **Controller**| |CTRL_I| | Show/hide the controller window. |
|
|
|
|
| | | |
|
|
|
|
| | | It's the Swiss Army Knife of the viewer. |
|
|
|
|
| | | From it, you can fine-control the display and |
|
|
|
|
| | | inspect almost everything in your design. |
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
|
|
|
| **Rulers** | |KeyK|, | One stroke on |KeyK| enters the ruler mode, in |
|
|
|
|
| | |KeyESC| | which you can draw one ruler. You can exit the |
|
|
|
|
| | | ruler mode by pressing |KeyESC|. Once in ruler |
|
|
|
|
| | | mode, the first click on the *left mouse button* |
|
|
|
|
| | | sets the ruler's starting point and the second |
|
|
|
|
| | | click the ruler's end point. The second click |
|
|
|
|
| | | exits automatically the ruler mode. |
|
|
|
|
| +-------------------+-----------------------------------------------------------+
|
|
|
|
| | |KeyCapK| | Clears all the drawn rulers |
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
|
|
|
| **Print** | |CTRL_P| | Currently rather crude. It's a direct copy of |
|
|
|
|
| | | what's displayed in pixels. So the resulting |
|
|
|
|
| | | picture will be a little blurred due to |
|
|
|
|
| | | anti-aliasing mechanism. |
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
|
|
|
| **Open/Close**| |CTRL_O| | Opens a new design. The design name must be |
|
|
|
|
| | | given without path or extention. |
|
|
|
|
| +-------------------+-----------------------------------------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| | |CTRL_W| | Closes the current viewer window, but does not quit |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | | the application. |
|
|
|
|
| +-------------------+-----------------------------------------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| | |CTRL_Q| | `CTRL+Q` quits the application |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | | (closing all windows). |
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| **Hierarchy** | |CTRL_Down| | Goes one hierarchy level down. That is, if there |
|
|
|
|
| | | is an *instance* under the cursor position, loads |
|
|
|
|
| | | its *model* Cell in place of the current one. |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +-------------------+-----------------------------------------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| | |CTRL_Up| | Goes one hierarchy level up. If we have entered |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | | the current model through |CTRL_Down| |
|
2019-06-04 07:32:23 -05:00
|
|
|
| | | reloads the previous model (the one |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | | in which this model is instanciated). |
|
|
|
|
+---------------+-------------------+-----------------------------------------------------------+
|
|
|
|
|
|
|
|
|
|
|
|
Cgt Command Line Options
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
Appart from the obvious ``--text`` options, all can be used for text and graphical mode.
|
|
|
|
|
|
|
|
+-----------------------------+------------------------------------------------+
|
|
|
|
| Arguments | Meaning |
|
|
|
|
+=============================+================================================+
|
2019-06-04 07:32:23 -05:00
|
|
|
| `-t|--text` | Instructs |cgt| to run in text mode. |
|
2017-07-15 10:35:02 -05:00
|
|
|
+-----------------------------+------------------------------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| `-L|--log-mode` | Disables the use of |ANSI| escape sequence on |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | the |tty|. Useful when the output is |
|
|
|
|
| | redirected to a file. |
|
|
|
|
+-----------------------------+------------------------------------------------+
|
|
|
|
| `-c <cell>|--cell=<cell>` | The name of the design to load, without |
|
|
|
|
| | leading path or extention. |
|
|
|
|
+-----------------------------+------------------------------------------------+
|
2019-05-27 11:49:51 -05:00
|
|
|
| `-m <val>|--margin=<val>` | Percentage *val* of white space for the placer |
|
|
|
|
| | (|Etesian|). |
|
2017-07-15 10:35:02 -05:00
|
|
|
+-----------------------------+------------------------------------------------+
|
2019-05-27 11:49:51 -05:00
|
|
|
| `--events-limit=<count>` | The maximal number of events after which the |
|
2019-06-04 07:32:23 -05:00
|
|
|
| | router will stop. This is mainly a failsafe |
|
|
|
|
| | against looping. The limit is set to 4 |
|
2019-05-27 11:49:51 -05:00
|
|
|
| | millions of iteration which should suffice to |
|
|
|
|
| | any design of `100K`. gates. For bigger |
|
2019-06-04 07:32:23 -05:00
|
|
|
| | designs you may want to increase this limit. |
|
2017-07-15 10:35:02 -05:00
|
|
|
+-----------------------------+------------------------------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| `-G|--global-route` | Runs the global router (|Katana|). |
|
2017-07-15 10:35:02 -05:00
|
|
|
+-----------------------------+------------------------------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| `-R|--detailed-route` | Runs the detailed router (|Katana|). |
|
2017-07-15 10:35:02 -05:00
|
|
|
+-----------------------------+------------------------------------------------+
|
|
|
|
| `-s|--save-design=<routed>` | The design into which the routed layout will |
|
|
|
|
| | be saved. It is strongly recommanded to choose |
|
|
|
|
| | a different name from the source (unrouted) |
|
|
|
|
| | design. |
|
|
|
|
+-----------------------------+------------------------------------------------+
|
|
|
|
| `--stratus-script=<module>` | Run the Python/Stratus script ``module``. |
|
|
|
|
| | See `Python Scripts in Cgt`_. |
|
|
|
|
+-----------------------------+------------------------------------------------+
|
|
|
|
|
|
|
|
|newpage|
|
|
|
|
|
|
|
|
|
|
|
|
Some Examples :
|
|
|
|
|
2020-02-03 10:44:15 -06:00
|
|
|
* Run both global and detailed router, then save the routed design:
|
|
|
|
|
|
|
|
.. code-block:: sh
|
2017-07-15 10:35:02 -05:00
|
|
|
|
2019-05-27 11:49:51 -05:00
|
|
|
> cgt -v -t -G -R --cell=design --save-design=design_r
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
|
|
|
|
Miscellaneous Settings
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
+---------------------------------------+------------------+----------------------------+
|
|
|
|
| Parameter Identifier | Type | Default |
|
|
|
|
+=======================================+==================+============================+
|
|
|
|
| **Verbosity/Log Parameters** |
|
|
|
|
+---------------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``misc.info`` | TypeBool | :cb:`False` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| | Enables display of *info* level message |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | (:cb:`cinfo` stream) |
|
|
|
|
+---------------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``misc.bug`` | TypeBool | :cb:`False` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| | Enables display of *bug* level message |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | (:cb:`cbug` stream), messages can be a little |
|
|
|
|
| | scarry |
|
|
|
|
+---------------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``misc.logMode`` | TypeBool | :cb:`False` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| | If enabled, assumes that the output device |
|
|
|
|
| | is not a ``tty`` and suppresses any escape |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | sequences |
|
|
|
|
+---------------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``misc.verboseLevel1`` | TypeBool | :cb:`True` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| | First level of verbosity, disables level 2 |
|
2017-07-15 10:35:02 -05:00
|
|
|
+---------------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``misc.verboseLevel2`` | TypeBool | :cb:`False` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
|
|
|
| | Second level of verbosity |
|
|
|
|
+---------------------------------------+------------------+----------------------------+
|
|
|
|
| **Development/Debug Parameters** |
|
|
|
|
+---------------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``misc.minTraceLevel`` | TypeInt | :cb:`0` |
|
2017-07-15 10:35:02 -05:00
|
|
|
+---------------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``misc.maxTraceLevel`` | TypeInt | :cb:`0` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| | Displays trace information *between* those two|
|
2017-07-15 10:35:02 -05:00
|
|
|
| | levels (:cb:`cdebug` stream) |
|
|
|
|
+---------------------------------------+------------------+----------------------------+
|
2020-02-03 10:44:15 -06:00
|
|
|
| ``misc.catchCore`` | TypeBool | :cb:`False` |
|
2017-07-15 10:35:02 -05:00
|
|
|
| +------------------+----------------------------+
|
2019-06-04 07:32:23 -05:00
|
|
|
| | By default, |cgt| does not dump core. |
|
2017-07-15 10:35:02 -05:00
|
|
|
| | To generate one set this flag to :cb:`True` |
|
|
|
|
+---------------------------------------+------------------+----------------------------+
|
|
|
|
|
|
|
|
|newpage|
|
|
|
|
|
|
|
|
|
|
|
|
.. _The Controller:
|
|
|
|
|
|
|
|
The Controller
|
|
|
|
~~~~~~~~~~~~~~
|
|
|
|
|
|
|
|
The *Controller* window is composed of seven tabs:
|
|
|
|
|
|
|
|
#. `The Look Tab`_ to select the display style.
|
|
|
|
#. `The Filter Tab`_ the hierarchical levels to be displayed, the look of
|
|
|
|
rubbers and the dimension units.
|
|
|
|
#. `The Layers&Go Tab`_ to selectively hide/display layers.
|
|
|
|
#. `The Netlist Tab`_ to browse through the |netlist|. Works in association
|
|
|
|
with the *Selection* tab.
|
2019-06-04 07:32:23 -05:00
|
|
|
#. `The Selection Tab`_ allows to view all the currently selected elements.
|
|
|
|
#. `The Inspector Tab`_ browses through either the DataBase, the Cell or
|
2017-07-15 10:35:02 -05:00
|
|
|
the current selection.
|
2019-06-04 07:32:23 -05:00
|
|
|
#. `The Settings Tab`_ accesses all the tool's configuration settings.
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
|
|
|
|
.. _The Look Tab:
|
|
|
|
|
|
|
|
The Look Tab
|
|
|
|
------------
|
|
|
|
|
|
|
|
You can select how the layout will be displayed. There is a special one
|
|
|
|
``Printer.Coriolis`` specifically designed for `Printing & Snapshots`_.
|
|
|
|
You should select it prior to calling the print or snapshot dialog boxes.
|
|
|
|
|
|
|
|
|bcenter| |ControllerLook_1| |ecenter|
|
|
|
|
|
|
|
|
|newpage|
|
|
|
|
|
|
|
|
|
|
|
|
.. _The Filter Tab:
|
|
|
|
|
|
|
|
The Filter Tab
|
|
|
|
--------------
|
|
|
|
|
|
|
|
The filter tab let you select what hierarchical levels of your design will be
|
2019-06-04 07:32:23 -05:00
|
|
|
displayed. Hierarchy level are numbered top-down: the level 0 corresponds to
|
2017-07-15 10:35:02 -05:00
|
|
|
the top-level cell, the level one to the instances of the top-level Cell and
|
|
|
|
so on.
|
|
|
|
|
|
|
|
There are also check boxes to enable/disable the processing of Terminal Cell,
|
2019-06-04 07:32:23 -05:00
|
|
|
Master Cells and Components. The processing of Terminal Cell (hierarchy leaf
|
2017-07-15 10:35:02 -05:00
|
|
|
cells) is disabled by default when you load a hierarchical design and enabled
|
|
|
|
when you load a single Cell.
|
|
|
|
|
|
|
|
You can choose what kind of form to give to the rubbers and the type of
|
|
|
|
unit used to display coordinates.
|
|
|
|
|
|
|
|
.. note:: *What are Rubbers:* |Hurricane| uses *Rubbers* to materialize
|
|
|
|
physical gaps in net topology. That is, if some wires are missing to
|
|
|
|
connect two or more parts of net, a *rubber* will be drawn between them
|
|
|
|
to signal the gap.
|
|
|
|
|
2019-06-04 07:32:23 -05:00
|
|
|
For example, after the detailed routing no *rubber* should remain.
|
|
|
|
They have been made *very* visible as big violet lines...
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
|bcenter| |ControllerFilter_1| |ecenter|
|
|
|
|
|
|
|
|
|newpage|
|
|
|
|
|
|
|
|
|
|
|
|
.. _The Layers&Go Tab:
|
|
|
|
|
|
|
|
The Layers&Go Tab
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
Control the individual display of all *layers* and *Gos*.
|
|
|
|
|
2019-06-04 07:32:23 -05:00
|
|
|
* *Layers* correspond to true physical layers. From a |Hurricane| point of
|
2017-07-15 10:35:02 -05:00
|
|
|
view they are all the *BasicLayers* (could be matched to GDSII).
|
|
|
|
* *Gos* stands from *Graphical Objects*, they are drawings that have no
|
|
|
|
physical existence but are added by the various tools to display extra
|
|
|
|
information. One good exemple is the density map of the detailed router,
|
|
|
|
to easily locate congested areas.
|
|
|
|
|
|
|
|
For each layer/Go there are two check boxes:
|
|
|
|
|
|
|
|
* The normal one triggers the display.
|
|
|
|
* The red-outlined allows objects of that layer to be selectable or not.
|
|
|
|
|
|
|
|
|bcenter| |ControllerLayersGos_1| |ecenter|
|
|
|
|
|
|
|
|
|
|
|
|
.. _The Netlist Tab:
|
|
|
|
|
|
|
|
The Netlist Tab
|
|
|
|
---------------
|
|
|
|
|
|
|
|
The *Netlist* tab shows the list of nets... By default the tab is not
|
|
|
|
*synched* with the displayed Cell. To see the nets you must check the
|
|
|
|
**Sync Netlist** checkbox. You can narrow the set of displayed nets by
|
|
|
|
using the filter pattern (supports regular expressions).
|
|
|
|
|
2019-06-04 07:32:23 -05:00
|
|
|
A very useful feature is to enable the **Sync Selection**, which will
|
2017-07-15 10:35:02 -05:00
|
|
|
automatically select all the components of the selected net(s). You can
|
|
|
|
select multiple nets. In the figure the net ``auxsc35`` is selected and
|
2019-06-04 07:32:23 -05:00
|
|
|
is highlighted in the *Viewer*.
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
|bcenter| |ControllerNetlist_1| |ecenter|
|
|
|
|
|bcenter| |ViewerNetlist_1| |ecenter|
|
|
|
|
|
|
|
|
|
|
|
|
.. _The Selection Tab:
|
|
|
|
|
|
|
|
The Selection Tab
|
|
|
|
-----------------
|
|
|
|
|
2019-06-04 07:32:23 -05:00
|
|
|
The *Selection* tab lists all the components currently selected. They
|
2017-07-15 10:35:02 -05:00
|
|
|
can be filtered thanks to the filter pattern.
|
|
|
|
|
|
|
|
Used in conjunction with the *Netlist* **Sync Selection** you will all see
|
|
|
|
all the components part of *net*.
|
|
|
|
|
|
|
|
In this list, you can toggle individually the selection of component by
|
|
|
|
pressing the ``t`` key. When unselected in this way a component is not
|
|
|
|
removed from the the selection list but instead displayed in red italic.
|
|
|
|
To see where a component is you may make it blink by repeatedly press
|
|
|
|
the ``t`` key...
|
|
|
|
|
|
|
|
|bcenter| |ControllerSelection_1| |ecenter|
|
|
|
|
|
|
|
|
|
|
|
|
.. _The Inspector Tab:
|
|
|
|
|
|
|
|
The Inspector Tab
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
This tab is very useful, but mostly for |Coriolis| developpers. It allows
|
2019-06-04 07:32:23 -05:00
|
|
|
to browse through the live DataBase. The *Inspector* provides three entry points:
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
* **DataBase**: Starts from the whole |Hurricane| DataBase.
|
2019-06-04 07:32:23 -05:00
|
|
|
* **Cell**: Inspects the currently loaded Cell.
|
|
|
|
* **Selection**: Inspects the object currently highlighted in the *Selection* tab.
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
Once an entry point has been activated, you may recursively expore all
|
2019-06-04 07:32:23 -05:00
|
|
|
its fields using the right/left arrows.
|
2017-07-15 10:35:02 -05:00
|
|
|
|
|
|
|
.. note:: *Do not put your fingers in the socket:* when inspecting
|
|
|
|
anything, do not modify the DataBase. If any object under inspection
|
|
|
|
is deleted, you will crash the application...
|
|
|
|
|
|
|
|
.. note:: *Implementation Detail:* the inspector support is done with
|
|
|
|
``Slot``, ``Record`` and ``getString()``.
|
|
|
|
|
|
|
|
|bcenter| |ControllerInspector_1| |ecenter|
|
|
|
|
|bcenter| |ControllerInspector_2| |ecenter|
|
|
|
|
|bcenter| |ControllerInspector_3| |ecenter|
|
|
|
|
|
|
|
|
|
|
|
|
.. _The Settings Tab:
|
|
|
|
|
|
|
|
The Settings Tab
|
|
|
|
----------------
|
|
|
|
|
|
|
|
Here comes the description of the *Settings* tab.
|
|
|
|
|
|
|
|
|bcenter| |ControllerSettings_1| |ecenter|
|