riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Forgotten some pages of the generated documentation.

This commit is contained in:
Jean-Paul Chaput 2020-08-02 18:22:28 +02:00
parent 3b700baec0
commit 6210a08e99
10 changed files with 261 additions and 213 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
documentation/output/pages/documentation.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Alliance Documentation Alliance Installation How to get, build &amp; install Alliance alongside Coriolis Coriolis Documentation Coriolis User&#39;s Guide Using the software Python Tutorial A Tutorial to use ...">
<meta name="description" content="Alliance Documentation Alliance Installation How to get, build &amp; install Alliance alongside Coriolis `Alliance Check Toolkit`_ Regression tests &amp; examples Coriolis Documentation Coriolis User&#39;s Guide ...">
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
@ -125,6 +125,11 @@
<div class="col-md-5 col-md-offset-1">
<a class="reference external" href="../pages/alliance.html">Alliance Installation</a> <span class="raw-html"><br/></span>
How to get, build &amp; install Alliance alongside Coriolis</div>
<div class="col-md-5">
<div class="row">
<a href="#id2"><span class="problematic" id="id3">`Alliance Check Toolkit`_</span></a> <span class="raw-html"><br/></span>
Regression tests &amp; examples</div>
</div>
</div>
</div>
<div class="section" id="coriolis-documentation">
@ -181,6 +186,12 @@ Cadence Documentation of LEF 5.8 C++ API</p>
Cadence Documentation of DEF 5.8 C++ API</p>
</div>
</div>
</div>
<div class="system-messages section">
<h2>Docutils System Messages</h2>
<div class="system-message" id="id2">
<p class="system-message-title">System Message: ERROR/3 (<tt class="docutils">/dsk/l1/jpc/coriolis-2.x/src/coriolis/documentation/content/pages/documentation.rst</tt>, line 38); <em><a href="#id3">backlink</a></em></p>
Unknown target name: &quot;alliance check toolkit&quot;.</div>
</div>
</div>

12
documentation/output/pages/gitlab.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="The git repositories of all the components of the project: Component Repository Alliance https://gitlab.lip6.fr/jpc/alliance.git Coriolis https://gitlab.lip6.fr/jpc/coriolis.git Alliance Check ...">
<meta name="description" content="The git repositories of all the components of the project: Component Repository Alliance https://gitlab.lip6.fr/vlsi-eda/alliance.git Coriolis https://gitlab.lip6.fr/vlsi-eda/coriolis.git Alliance ...">
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
@ -122,8 +122,8 @@
<p>The <span class="cb">git</span> repositories of all the components of the project:</p>
<table class="table">
<colgroup>
<col width="37%" />
<col width="63%" />
<col width="36%" />
<col width="64%" />
</colgroup>
<thead valign="bottom">
<tr><th class="head">Component</th>
@ -132,13 +132,13 @@
</thead>
<tbody valign="top">
<tr><td><span class="sc">Alliance</span></td>
<td><a class="reference external" href="https://gitlab.lip6.fr/jpc/alliance.git">https://gitlab.lip6.fr/jpc/alliance.git</a></td>
<td><a class="reference external" href="https://gitlab.lip6.fr/vlsi-eda/alliance.git">https://gitlab.lip6.fr/vlsi-eda/alliance.git</a></td>
</tr>
<tr><td><span class="sc">Coriolis</span></td>
<td><a class="reference external" href="https://gitlab.lip6.fr/jpc/coriolis.git">https://gitlab.lip6.fr/jpc/coriolis.git</a></td>
<td><a class="reference external" href="https://gitlab.lip6.fr/vlsi-eda/coriolis.git">https://gitlab.lip6.fr/vlsi-eda/coriolis.git</a></td>
</tr>
<tr><td><span class="cb">Alliance Check Toolkit</span></td>
<td><a class="reference external" href="https://gitlab.lip6.fr/jpc/alliance-check-toolkit.git">https://gitlab.lip6.fr/jpc/alliance-check-toolkit.git</a></td>
<td><a class="reference external" href="https://gitlab.lip6.fr/vlsi-eda/alliance-check-toolkit.git">https://gitlab.lip6.fr/vlsi-eda/alliance-check-toolkit.git</a></td>
</tr>
</tbody>
</table>

36
documentation/output/pages/python-cpp.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Printable version of this document PythonCpp.pdf. Contents 1. Introduction 2. Basic File Structure and CMake configuration 3. Case 1 - DBo Derived, Standalone 4. Case 2 - Hierarchy of DBo Derived ...">
<meta name="description" content="Printable version of this Document PythonCpp.pdf Contents Printable version of this Document 1. Introduction 2. Basic File Structure and CMake configuration 3. Case 1 - DBo Derived, Standalone 4. ...">
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
@ -119,22 +119,26 @@
<!-- Standard CAO/VLSI Concepts. -->
<!-- Alliance & MBK Concepts -->
<!-- Hurricane Concepts. -->
<p>Printable version of this document <a class="reference external" href="../pdfs/PythonCpp.pdf">PythonCpp.pdf</a>.</p>
<div class="section" id="printable-version-of-this-document">
<h2><a class="toc-backref" href="#id7">Printable version of this Document</a></h2>
<p><a class="reference external" href="../pdfs/PythonCpp.pdf">PythonCpp.pdf</a></p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id7">1. Introduction</a></li>
<li><a class="reference internal" href="#basic-file-structure-and-cmake-configuration" id="id8">2. Basic File Structure and CMake configuration</a></li>
<li><a class="reference internal" href="#case-1-dbo-derived-standalone" id="id9">3. Case 1 - DBo Derived, Standalone</a></li>
<li><a class="reference internal" href="#case-2-hierarchy-of-dbo-derived-classes" id="id10">4. Case 2 - Hierarchy of DBo Derived Classes</a></li>
<li><a class="reference internal" href="#case-3-non-dbo-standalone-classe" id="id11">5. Case 3 - Non-DBo Standalone Classe</a></li>
<li><a class="reference internal" href="#encapsulating-dbu" id="id12">6. Encapsulating DbU</a></li>
<li><a class="reference internal" href="#no-c-hurricane-name-encapsulation" id="id13">7. No C++ Hurricane::Name encapsulation</a></li>
<li><a class="reference internal" href="#printable-version-of-this-document" id="id7">Printable version of this Document</a></li>
<li><a class="reference internal" href="#introduction" id="id8">1. Introduction</a></li>
<li><a class="reference internal" href="#basic-file-structure-and-cmake-configuration" id="id9">2. Basic File Structure and CMake configuration</a></li>
<li><a class="reference internal" href="#case-1-dbo-derived-standalone" id="id10">3. Case 1 - DBo Derived, Standalone</a></li>
<li><a class="reference internal" href="#case-2-hierarchy-of-dbo-derived-classes" id="id11">4. Case 2 - Hierarchy of DBo Derived Classes</a></li>
<li><a class="reference internal" href="#case-3-non-dbo-standalone-classe" id="id12">5. Case 3 - Non-DBo Standalone Classe</a></li>
<li><a class="reference internal" href="#encapsulating-dbu" id="id13">6. Encapsulating DbU</a></li>
<li><a class="reference internal" href="#no-c-hurricane-name-encapsulation" id="id14">7. No C++ Hurricane::Name encapsulation</a></li>
</ul>
</div>
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="introduction">
<h2><a class="toc-backref" href="#id7">1. Introduction</a></h2>
<h2><a class="toc-backref" href="#id8">1. Introduction</a></h2>
<ul class="simple">
<li>This document is written for people already familiar with the
<a class="reference external" href="https://docs.python.org/2/c-api/index.html">Python/C API Reference Manual</a>.</li>
@ -298,7 +302,7 @@ like in the code below:</p>
</div>
</div>
<div class="section" id="basic-file-structure-and-cmake-configuration">
<h2><a class="toc-backref" href="#id8">2. Basic File Structure and CMake configuration</a></h2>
<h2><a class="toc-backref" href="#id9">2. Basic File Structure and CMake configuration</a></h2>
<p>As a first example we will consider the <tt class="docutils literal"><span class="pre">Hurrican::Library</span></tt>
class. To export a class into Python, we must create three files:</p>
<ol class="arabic simple">
@ -331,7 +335,7 @@ associated C++ namespace.</li>
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="case-1-dbo-derived-standalone">
<h2><a class="toc-backref" href="#id9">3. Case 1 - DBo Derived, Standalone</a></h2>
<h2><a class="toc-backref" href="#id10">3. Case 1 - DBo Derived, Standalone</a></h2>
<p>As example, we take <tt class="docutils literal">Library</tt>. This a <tt class="docutils literal">DBo</tt> derived class, but we
choose not to export the parent classes. From Python, it will appear
as a base class.</p>
@ -660,7 +664,7 @@ the module itself. This allow to mimic closely the C++ syntax:</p>
</div>
</div>
<div class="section" id="case-2-hierarchy-of-dbo-derived-classes">
<h2><a class="toc-backref" href="#id10">4. Case 2 - Hierarchy of DBo Derived Classes</a></h2>
<h2><a class="toc-backref" href="#id11">4. Case 2 - Hierarchy of DBo Derived Classes</a></h2>
<p>Now we want to export the following C++ class hierarchy into Python:</p>
<pre class="literal-block">
PyEntity &lt;-- PyComponent &lt;-+- PyContact
@ -1060,7 +1064,7 @@ terminal or not.</li>
</div>
</div>
<div class="section" id="case-3-non-dbo-standalone-classe">
<h2><a class="toc-backref" href="#id11">5. Case 3 - Non-DBo Standalone Classe</a></h2>
<h2><a class="toc-backref" href="#id12">5. Case 3 - Non-DBo Standalone Classe</a></h2>
<p>Let's have a look at the encapsulation of <tt class="docutils literal"><span class="pre">Hurricane::Point</span></tt>.</p>
<p>Non-BDo derived classes do not support the bi-directionnal communication.
So each Python object is associated with one C++ object. The C++ object
@ -1213,7 +1217,7 @@ a standalone <tt class="docutils literal">DBo</tt> class and a non-<tt class="do
</div>
</div>
<div class="section" id="encapsulating-dbu">
<h2><a class="toc-backref" href="#id12">6. Encapsulating DbU</a></h2>
<h2><a class="toc-backref" href="#id13">6. Encapsulating DbU</a></h2>
<p>While <tt class="docutils literal"><span class="pre">Hurricane::DbU</span></tt> is a class, the <tt class="docutils literal"><span class="pre">Hurricane::DbU::Unit</span></tt> is only
a <tt class="docutils literal">typedef</tt> over <tt class="docutils literal">uint64_t</tt>. The <tt class="docutils literal">DbU</tt> class only provides a set of
static methods to manipulate and convert to and from other units.
@ -1261,7 +1265,7 @@ the <tt class="docutils literal"><span class="pre">DbU::Unit</span>&nbsp; PyAny_
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="no-c-hurricane-name-encapsulation">
<h2><a class="toc-backref" href="#id13">7. No C++ Hurricane::Name encapsulation</a></h2>
<h2><a class="toc-backref" href="#id14">7. No C++ Hurricane::Name encapsulation</a></h2>
<p>To be written.</p>
</div>

50
documentation/output/pages/python-tutorial.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Printable version of this document PythonTutorial.pdf. First, a small disclaimer. This tutorial assumes that you are already familiar with the concepts of vlsi designs, such as netlist, layout, ...">
<meta name="description" content="Printable version of this Document PythonTutorial.pdf Contents Printable version of this Document 1. Introduction 2. Setting up the Environment 3. Making a Standard Cell -- Layout 4. Manipulating ...">
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
@ -119,32 +119,36 @@
<!-- Standard CAO/VLSI Concepts. -->
<!-- Alliance & MBK Concepts -->
<!-- Hurricane Concepts. -->
<p>Printable version of this document <a class="reference external" href="../pdfs/PythonTutorial.pdf">PythonTutorial.pdf</a>.</p>
<p>First, a small disclaimer. This tutorial assumes that you are already familiar
with the concepts of <span class="sc">vlsi</span> designs, such as <em>netlist</em>, <em>layout</em>, <em>instances</em>
and hierarchical design.</p>
<div class="section" id="printable-version-of-this-document">
<h2><a class="toc-backref" href="#id9">Printable version of this Document</a></h2>
<p><a class="reference external" href="../pdfs/PythonTutorial.pdf">PythonTutorial.pdf</a></p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id9">1. Introduction</a></li>
<li><a class="reference internal" href="#setting-up-the-environment" id="id10">2. Setting up the Environment</a></li>
<li><a class="reference internal" href="#making-a-standard-cell-layout" id="id11">3. Making a Standard Cell -- Layout</a></li>
<li><a class="reference internal" href="#manipulating-cells-nets-and-components" id="id12">4. Manipulating Cells, Nets and Components</a></li>
<li><a class="reference internal" href="#id3" id="id13">5. Make a script runnable through <span class="cb">cgt</span></a></li>
<li><a class="reference internal" href="#making-a-hierarchical-cell-netlist" id="id14">6. Making a hierarchical Cell -- Netlist</a></li>
<li><a class="reference internal" href="#working-in-real-mode" id="id15">7. Working in real mode</a></li>
<li><a class="reference internal" href="#tool-engines-crl-core" id="id16">8. Tool Engines (CRL Core)</a></li>
<li><a class="reference internal" href="#advanced-topics" id="id17">9. Advanced Topics</a></li>
<li><a class="reference internal" href="#printable-version-of-this-document" id="id9">Printable version of this Document</a></li>
<li><a class="reference internal" href="#introduction" id="id10">1. Introduction</a></li>
<li><a class="reference internal" href="#setting-up-the-environment" id="id11">2. Setting up the Environment</a></li>
<li><a class="reference internal" href="#making-a-standard-cell-layout" id="id12">3. Making a Standard Cell -- Layout</a></li>
<li><a class="reference internal" href="#manipulating-cells-nets-and-components" id="id13">4. Manipulating Cells, Nets and Components</a></li>
<li><a class="reference internal" href="#id3" id="id14">5. Make a script runnable through <span class="cb">cgt</span></a></li>
<li><a class="reference internal" href="#making-a-hierarchical-cell-netlist" id="id15">6. Making a hierarchical Cell -- Netlist</a></li>
<li><a class="reference internal" href="#working-in-real-mode" id="id16">7. Working in real mode</a></li>
<li><a class="reference internal" href="#tool-engines-crl-core" id="id17">8. Tool Engines (CRL Core)</a></li>
<li><a class="reference internal" href="#advanced-topics" id="id18">9. Advanced Topics</a></li>
</ul>
</div>
<p>First, a small disclaimer. This tutorial assumes that you are already familiar
with the concepts of <span class="sc">vlsi</span> designs, such as <em>netlist</em>, <em>layout</em>, <em>instances</em>
and hierarchical design.</p>
<!-- -*- Mode: rst -*- -->
<!-- Hurricane doxygen doc links. -->
<!-- Hurricane Viewer doxygen doc links. -->
<!-- CRL Core doxygen doc links. -->
<!-- Hurricane Python Tutorial internal links. -->
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="introduction">
<h2><a class="toc-backref" href="#id9">1. Introduction</a></h2>
<h2><a class="toc-backref" href="#id10">1. Introduction</a></h2>
<p>This tutorial is aimed at two goals :</p>
<ul class="simple">
<li>Presenting how to use Python scripts to control <span class="sc">Coriolis</span>.</li>
@ -276,7 +280,7 @@ to be explicitly deleted.</p>
</div>
</div>
<div class="section" id="setting-up-the-environment">
<h2><a class="toc-backref" href="#id10">2. Setting up the Environment</a></h2>
<h2><a class="toc-backref" href="#id11">2. Setting up the Environment</a></h2>
<div class="section" id="setting-up-the-paths">
<h3>2.1 Setting up the Paths</h3>
<p>To simplify the tedious task of configuring your environment, a helper is provided.
@ -352,7 +356,7 @@ in <a class="reference external" href="../UsersGuide/ViewerTools.html">CGT - The
</div>
</div>
<div class="section" id="making-a-standard-cell-layout">
<h2><a class="toc-backref" href="#id11">3. Making a Standard Cell -- Layout</a></h2>
<h2><a class="toc-backref" href="#id12">3. Making a Standard Cell -- Layout</a></h2>
<p>In this part, we will show how to create and save a terminal <a class="reference external" href="../../hurricane/classHurricane_1_1Cell.html">Cell</a>,
that is, a cell without instances (the end point of a hierarchical
design). To illustrate the case we will draw the layout of a
@ -658,7 +662,7 @@ explanation of that part of the code, refer to <a class="reference external" hre
</div>
</div>
<div class="section" id="manipulating-cells-nets-and-components">
<h2><a class="toc-backref" href="#id12">4. Manipulating Cells, Nets and Components</a></h2>
<h2><a class="toc-backref" href="#id13">4. Manipulating Cells, Nets and Components</a></h2>
<p>In this part, we will show how to navigate through the <a class="reference external" href="../../hurricane/classHurricane_1_1Net.html">Nets</a> and <a class="reference external" href="../../hurricane/classHurricane_1_1Component.html">Components</a> of a <a class="reference external" href="../../hurricane/classHurricane_1_1Cell.html">Cell</a>.</p>
<div class="section" id="hurricane-collections">
<h3>4.1 Hurricane Collections</h3>
@ -729,7 +733,7 @@ may unexpectedly shadow cells from the libraries.</p>
</div>
</div>
<div class="section" id="id3">
<h2><a class="toc-backref" href="#id13">5. Make a script runnable through <span class="cb">cgt</span></a></h2>
<h2><a class="toc-backref" href="#id14">5. Make a script runnable through <span class="cb">cgt</span></a></h2>
<p>To use your script you may run it directly like any other <span class="sc">Python</span> script.
But, for debugging purpose it may be helpful to run it through the
interactive layout viewer <span class="cb">cgt</span>.</p>
@ -801,7 +805,7 @@ The <tt class="docutils literal">Breakpoint.stop()</tt> function takes two argum
</div>
</div>
<div class="section" id="making-a-hierarchical-cell-netlist">
<h2><a class="toc-backref" href="#id14">6. Making a hierarchical Cell -- Netlist</a></h2>
<h2><a class="toc-backref" href="#id15">6. Making a hierarchical Cell -- Netlist</a></h2>
<p>To illustrate the topic, we will build the netlist of a fulladder from
standard cell.</p>
<p><img alt="The fulladder netlist" class="align-middle" src="../pages/images/fulladder-1.png" style="width: 80%;" /></p>
@ -1157,7 +1161,7 @@ directory (under the the root of the <span class="sc">Coriolis</span> installati
</div>
</div>
<div class="section" id="working-in-real-mode">
<h2><a class="toc-backref" href="#id15">7. Working in real mode</a></h2>
<h2><a class="toc-backref" href="#id16">7. Working in real mode</a></h2>
<p>The <a class="reference external" href="../../crlcore/classCRL_1_1AllianceFramework.html">AllianceFramework</a> only manages <em>symbolic</em> layout as <span class="sc">Alliance</span> does.
But <span class="sc">Coriolis</span> is also able to work directly in <em>real</em> mode, meaning
that distances will be expressed in microns instead of lambdas.</p>
@ -1196,7 +1200,7 @@ the one of the FreePDK45, you must load it prior to calling the <span class="sc"
</div>
</div>
<div class="section" id="tool-engines-crl-core">
<h2><a class="toc-backref" href="#id16">8. Tool Engines (CRL Core)</a></h2>
<h2><a class="toc-backref" href="#id17">8. Tool Engines (CRL Core)</a></h2>
<p>The <a class="reference external" href="../../crlcore/classCRL_1_1ToolEngine.html">ToolEngine</a> class is the base class for all tools developped in
<span class="sc">Coriolis</span>. In the rest of the tutorial we will use the names <tt class="docutils literal">tool</tt>
or <tt class="docutils literal">engine</tt> as synonyms.</p>
@ -1396,7 +1400,7 @@ case it is around <tt class="docutils literal">3%</tt>.</p>
</div>
</div>
<div class="section" id="advanced-topics">
<h2><a class="toc-backref" href="#id17">9. Advanced Topics</a></h2>
<h2><a class="toc-backref" href="#id18">9. Advanced Topics</a></h2>
<p>This is a place holder as well as a reminder to myself to write this part of
the documentation.</p>
<div class="section" id="id7">

50
documentation/output/pages/rds.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Disclaimer: This document is still far from complete. Printable version of this document RDS.pdf. Contents Symbolic Layout Symbolic Components Symbolic Segments The RDS File Physical Grid &amp; Lambda ...">
<meta name="description" content="Printable version of this Document RDS.pdf Contents Printable version of this Document Symbolic Layout Symbolic Components Symbolic Segments The RDS File Physical Grid &amp; Lambda Value The ...">
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
@ -119,35 +119,39 @@
<!-- Standard CAO/VLSI Concepts. -->
<!-- Alliance & MBK Concepts -->
<!-- Hurricane Concepts. -->
<p><strong>Disclaimer:</strong> This document is still far from complete.</p>
<p>Printable version of this document <a class="reference external" href="../../../pdf/main/RDS.pdf">RDS.pdf</a>.</p>
<div class="section" id="printable-version-of-this-document">
<h2><a class="toc-backref" href="#id2">Printable version of this Document</a></h2>
<p><a class="reference external" href="{filename}/pdfs/main/RDS.pdf">RDS.pdf</a></p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#symbolic-layout" id="id2">Symbolic Layout</a><ul>
<li><a class="reference internal" href="#symbolic-components" id="id3">Symbolic Components</a></li>
<li><a class="reference internal" href="#symbolic-segments" id="id4">Symbolic Segments</a></li>
<li><a class="reference internal" href="#printable-version-of-this-document" id="id2">Printable version of this Document</a></li>
<li><a class="reference internal" href="#symbolic-layout" id="id3">Symbolic Layout</a><ul>
<li><a class="reference internal" href="#symbolic-components" id="id4">Symbolic Components</a></li>
<li><a class="reference internal" href="#symbolic-segments" id="id5">Symbolic Segments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#the-rds-file" id="id5">The RDS File</a><ul>
<li><a class="reference internal" href="#physical-grid-lambda-value" id="id6">Physical Grid &amp; Lambda Value</a></li>
<li><a class="reference internal" href="#the-mbk-to-rds-segment-table" id="id7">The <tt class="docutils literal">MBK_TO_RDS_SEGMENT</tt> table</a></li>
<li><a class="reference internal" href="#the-mbk-to-rds-via-table" id="id8">The <tt class="docutils literal">MBK_TO_RDS_VIA</tt> table</a></li>
<li><a class="reference internal" href="#the-mbk-to-rds-bigvia-hole-table" id="id9">The <tt class="docutils literal">MBK_TO_RDS_BIGVIA_HOLE</tt> table</a></li>
<li><a class="reference internal" href="#the-mbk-to-rds-bigvia-metal-table" id="id10">The <tt class="docutils literal">MBK_TO_RDS_BIGVIA_METAL</tt> table</a></li>
<li><a class="reference internal" href="#the-mbk-wiresetting-table" id="id11">The <tt class="docutils literal">MBK_WIRESETTING</tt> table</a></li>
<li><a class="reference internal" href="#the-rds-file" id="id6">The RDS File</a><ul>
<li><a class="reference internal" href="#physical-grid-lambda-value" id="id7">Physical Grid &amp; Lambda Value</a></li>
<li><a class="reference internal" href="#the-mbk-to-rds-segment-table" id="id8">The <tt class="docutils literal">MBK_TO_RDS_SEGMENT</tt> table</a></li>
<li><a class="reference internal" href="#the-mbk-to-rds-via-table" id="id9">The <tt class="docutils literal">MBK_TO_RDS_VIA</tt> table</a></li>
<li><a class="reference internal" href="#the-mbk-to-rds-bigvia-hole-table" id="id10">The <tt class="docutils literal">MBK_TO_RDS_BIGVIA_HOLE</tt> table</a></li>
<li><a class="reference internal" href="#the-mbk-to-rds-bigvia-metal-table" id="id11">The <tt class="docutils literal">MBK_TO_RDS_BIGVIA_METAL</tt> table</a></li>
<li><a class="reference internal" href="#the-mbk-wiresetting-table" id="id12">The <tt class="docutils literal">MBK_WIRESETTING</tt> table</a></li>
</ul>
</li>
</ul>
</div>
<p><strong>Disclaimer:</strong> This document is still far from complete.</p>
<!-- -*- Mode: rst -*- -->
<!-- Tools -->
<!-- RDS file syntax. -->
<p></p>
</div>
<div class="section" id="symbolic-layout">
<h2><a class="toc-backref" href="#id2">Symbolic Layout</a></h2>
<h2><a class="toc-backref" href="#id3">Symbolic Layout</a></h2>
<div class="section" id="symbolic-components">
<h3><a class="toc-backref" href="#id3">Symbolic Components</a></h3>
<h3><a class="toc-backref" href="#id4">Symbolic Components</a></h3>
<p>A symbolic layout is, in practice, made of only of three objects:</p>
<table class="table">
<colgroup>
@ -308,7 +312,7 @@ name stuck...</p>
</div>
</div>
<div class="section" id="symbolic-segments">
<h3><a class="toc-backref" href="#id4">Symbolic Segments</a></h3>
<h3><a class="toc-backref" href="#id5">Symbolic Segments</a></h3>
<p>In <span class="sc">Alliance</span>, segments are oriented (up, down, left, right). This disambiguate
the left or right side when using the <tt class="docutils literal">LCW</tt> and <tt class="docutils literal">RCW</tt> rules in the <span class="sc">rds</span> file.
It allows to generate, if needed, asymetric object in the real layout file.</p>
@ -317,7 +321,7 @@ It allows to generate, if needed, asymetric object in the real layout file.</p>
</div>
</div>
<div class="section" id="the-rds-file">
<h2><a class="toc-backref" href="#id5">The RDS File</a></h2>
<h2><a class="toc-backref" href="#id6">The RDS File</a></h2>
<p>The RDS file control how a symbolic layout is transformed into it's real
conterpart.</p>
<div class="note">
@ -357,7 +361,7 @@ conterpart.</p>
</tbody>
</table>
<div class="section" id="physical-grid-lambda-value">
<h3><a class="toc-backref" href="#id6">Physical Grid &amp; Lambda Value</a></h3>
<h3><a class="toc-backref" href="#id7">Physical Grid &amp; Lambda Value</a></h3>
<p>RDS file:</p>
<pre class="literal-block">
DEFINE PHYSICAL_GRID 0.005
@ -374,7 +378,7 @@ the <tt class="docutils literal">LAMBDA</tt> value can be any multiple of the fo
</ul>
</div>
<div class="section" id="the-mbk-to-rds-segment-table">
<h3><a class="toc-backref" href="#id7">The <tt class="docutils literal">MBK_TO_RDS_SEGMENT</tt> table</a></h3>
<h3><a class="toc-backref" href="#id8">The <tt class="docutils literal">MBK_TO_RDS_SEGMENT</tt> table</a></h3>
<p>The <tt class="docutils literal">MBK_TO_RDS_SEGMENT</tt> table control the way segments are translated into
real rectangles. Be aware that we are translating <em>segments</em> and not <em>rectangles</em>.
Segments are defined by their axis (source &amp; target points) and their width.
@ -469,7 +473,7 @@ rectangles).</p>
<p></p>
</div>
<div class="section" id="the-mbk-to-rds-via-table">
<h3><a class="toc-backref" href="#id8">The <tt class="docutils literal">MBK_TO_RDS_VIA</tt> table</a></h3>
<h3><a class="toc-backref" href="#id9">The <tt class="docutils literal">MBK_TO_RDS_VIA</tt> table</a></h3>
<p>This table is to translate <em>default</em> VIAs into real via. In the symbolic layout
the default VIA is simply a point and a set of layers. All layers are converted
in squares shapes centered on the VIA coordinate. The one dimension given is the
@ -503,7 +507,7 @@ END
</div>
</div>
<div class="section" id="the-mbk-to-rds-bigvia-hole-table">
<h3><a class="toc-backref" href="#id9">The <tt class="docutils literal">MBK_TO_RDS_BIGVIA_HOLE</tt> table</a></h3>
<h3><a class="toc-backref" href="#id10">The <tt class="docutils literal">MBK_TO_RDS_BIGVIA_HOLE</tt> table</a></h3>
<p>In <span class="cb">s2r</span>, when generating BIGVIAs, the matrix of holes they contains is
not draw relative to the position of the BIGVIA itself, but on a grid which
is common througout all the design real layout. This is to allow overlap
@ -537,7 +541,7 @@ To avoid that case, if the either side of the BIGVIA is less than
</div>
</div>
<div class="section" id="the-mbk-to-rds-bigvia-metal-table">
<h3><a class="toc-backref" href="#id10">The <tt class="docutils literal">MBK_TO_RDS_BIGVIA_METAL</tt> table</a></h3>
<h3><a class="toc-backref" href="#id11">The <tt class="docutils literal">MBK_TO_RDS_BIGVIA_METAL</tt> table</a></h3>
<p>This table describe how the metal part of a BIGVIA is expanded (for the hole
part, see the previous table <tt class="docutils literal">MBK_TO_RDS_BIGVIA_HOLE</tt>). The rule give for each
metal:</p>
@ -568,7 +572,7 @@ END
</pre>
</div>
<div class="section" id="the-mbk-wiresetting-table">
<h3><a class="toc-backref" href="#id11">The <tt class="docutils literal">MBK_WIRESETTING</tt> table</a></h3>
<h3><a class="toc-backref" href="#id12">The <tt class="docutils literal">MBK_WIRESETTING</tt> table</a></h3>
<p>From a strict standpoint this table shouldn't be here but put in a separate
configuration file, because it contains informations only used by the symbolic
layout tools (<tt class="docutils literal">ocp</tt>, <tt class="docutils literal">nero</tt>, <tt class="docutils literal">ring</tt>).</p>

20
documentation/output/pages/stratus-developpers.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Printable version of this document Stratus.pdf. Contents Class Model Nets Instances Class Model Synopsys class myClass ( Model ) : ... exemple = myClass ( name, param ) Description Every cell made is ...">
<meta name="description" content="Printable version of this Document Stratus.pdf Contents Printable version of this Document Class Model Nets Instances Class Model Synopsys class myClass ( Model ) : ... exemple = myClass ( name, ...">
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
@ -119,17 +119,21 @@
<!-- Standard CAO/VLSI Concepts. -->
<!-- Alliance & MBK Concepts -->
<!-- Hurricane Concepts. -->
<p>Printable version of this document <a class="reference external" href="../../../pdf/main/Stratus.pdf">Stratus.pdf</a>.</p>
<div class="section" id="printable-version-of-this-document">
<h2><a class="toc-backref" href="#id12">Printable version of this Document</a></h2>
<p><a class="reference external" href="../pdfs/Stratus.pdf">Stratus.pdf</a></p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#class-model" id="id12">Class Model</a></li>
<li><a class="reference internal" href="#nets" id="id13">Nets</a></li>
<li><a class="reference internal" href="#instances" id="id14">Instances</a></li>
<li><a class="reference internal" href="#printable-version-of-this-document" id="id12">Printable version of this Document</a></li>
<li><a class="reference internal" href="#class-model" id="id13">Class Model</a></li>
<li><a class="reference internal" href="#nets" id="id14">Nets</a></li>
<li><a class="reference internal" href="#instances" id="id15">Instances</a></li>
</ul>
</div>
</div>
<div class="section" id="class-model">
<h2><a class="toc-backref" href="#id12">Class Model</a></h2>
<h2><a class="toc-backref" href="#id13">Class Model</a></h2>
<div class="section" id="synopsys">
<h3>Synopsys</h3>
<pre class="literal-block">
@ -216,7 +220,7 @@ in separated files</li>
</div>
</div>
<div class="section" id="nets">
<h2><a class="toc-backref" href="#id13">Nets</a></h2>
<h2><a class="toc-backref" href="#id14">Nets</a></h2>
<div class="section" id="id2">
<h3>Synopsys</h3>
<pre class="literal-block">
@ -328,7 +332,7 @@ operation with &amp;, |, ^ ,</li>
</div>
</div>
<div class="section" id="instances">
<h2><a class="toc-backref" href="#id14">Instances</a></h2>
<h2><a class="toc-backref" href="#id15">Instances</a></h2>
<div class="section" id="id7">
<h3>Synopsys</h3>
<pre class="literal-block">

160
documentation/output/pages/stratus-dpgen.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Printable version of this document Stratus.pdf. Contents DpgenInv DpgenBuff DpgenNand2 DpgenNand3 Dpgennand4 DpgenAnd2 DpgenAnd3 DpgenAnd4 DpgenNor2 DpgenNor3 DpgenNor4 DpgenOr2 DpgenOr3 DpgenOr4 ...">
<meta name="description" content="Printable version of this Document Stratus.pdf Contents Printable version of this Document DpgenInv DpgenBuff DpgenNand2 DpgenNand3 Dpgennand4 DpgenAnd2 DpgenAnd3 DpgenAnd4 DpgenNor2 DpgenNor3 ...">
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
@ -119,52 +119,56 @@
<!-- Standard CAO/VLSI Concepts. -->
<!-- Alliance & MBK Concepts -->
<!-- Hurricane Concepts. -->
<p>Printable version of this document <a class="reference external" href="../../../pdf/main/Stratus.pdf">Stratus.pdf</a>.</p>
<div class="section" id="printable-version-of-this-document">
<h2><a class="toc-backref" href="#id2">Printable version of this Document</a></h2>
<p><a class="reference external" href="${filename}/pdfs/Stratus.pdf">Stratus.pdf</a></p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#dpgeninv" id="id2">DpgenInv</a></li>
<li><a class="reference internal" href="#dpgenbuff" id="id3">DpgenBuff</a></li>
<li><a class="reference internal" href="#dpgennand2" id="id4">DpgenNand2</a></li>
<li><a class="reference internal" href="#dpgennand3" id="id5">DpgenNand3</a></li>
<li><a class="reference internal" href="#dpgennand4" id="id6">Dpgennand4</a></li>
<li><a class="reference internal" href="#dpgenand2" id="id7">DpgenAnd2</a></li>
<li><a class="reference internal" href="#dpgenand3" id="id8">DpgenAnd3</a></li>
<li><a class="reference internal" href="#dpgenand4" id="id9">DpgenAnd4</a></li>
<li><a class="reference internal" href="#dpgennor2" id="id10">DpgenNor2</a></li>
<li><a class="reference internal" href="#dpgennor3" id="id11">DpgenNor3</a></li>
<li><a class="reference internal" href="#dpgennor4" id="id12">DpgenNor4</a></li>
<li><a class="reference internal" href="#dpgenor2" id="id13">DpgenOr2</a></li>
<li><a class="reference internal" href="#dpgenor3" id="id14">DpgenOr3</a></li>
<li><a class="reference internal" href="#dpgenor4" id="id15">DpgenOr4</a></li>
<li><a class="reference internal" href="#dpgenxor2" id="id16">DpgenXor2</a></li>
<li><a class="reference internal" href="#dpgenxnor2" id="id17">DpgenXnor2</a></li>
<li><a class="reference internal" href="#dpgennmux2" id="id18">DpgenNmux2</a></li>
<li><a class="reference internal" href="#dpgenmux2" id="id19">DpgenMux2</a></li>
<li><a class="reference internal" href="#dpgennbuse" id="id20">DpgenNbuse</a></li>
<li><a class="reference internal" href="#dpgenbuse" id="id21">DpgenBuse</a></li>
<li><a class="reference internal" href="#dpgennand2mask" id="id22">DpgenNand2mask</a></li>
<li><a class="reference internal" href="#dpgennor2mask" id="id23">DpgenNor2mask</a></li>
<li><a class="reference internal" href="#dpgenxnor2mask" id="id24">DpgenXnor2mask</a></li>
<li><a class="reference internal" href="#dpgenadsb2f" id="id25">DpgenAdsb2f</a></li>
<li><a class="reference internal" href="#dpgenshift" id="id26">DpgenShift</a></li>
<li><a class="reference internal" href="#dpgenshrot" id="id27">DpgenShrot</a></li>
<li><a class="reference internal" href="#dpgennul" id="id28">DpgenNul</a></li>
<li><a class="reference internal" href="#dpgenconst" id="id29">DpgenConst</a></li>
<li><a class="reference internal" href="#dpgenrom2" id="id30">DpgenRom2</a></li>
<li><a class="reference internal" href="#dpgenrom4" id="id31">DpgenRom4</a></li>
<li><a class="reference internal" href="#dpgenram" id="id32">DpgenRam</a></li>
<li><a class="reference internal" href="#dpgenrf1" id="id33">DpgenRf1</a></li>
<li><a class="reference internal" href="#dpgenrf1d" id="id34">DpgenRf1d</a></li>
<li><a class="reference internal" href="#dpgenfifo" id="id35">DpgenFifo</a></li>
<li><a class="reference internal" href="#dpgendff" id="id36">DpgenDff</a></li>
<li><a class="reference internal" href="#dpgendfft" id="id37">DpgenDfft</a></li>
<li><a class="reference internal" href="#dpgensff" id="id38">DpgenSff</a></li>
<li><a class="reference internal" href="#dpgensfft" id="id39">DpgenSfft</a></li>
<li><a class="reference internal" href="#printable-version-of-this-document" id="id2">Printable version of this Document</a></li>
<li><a class="reference internal" href="#dpgeninv" id="id3">DpgenInv</a></li>
<li><a class="reference internal" href="#dpgenbuff" id="id4">DpgenBuff</a></li>
<li><a class="reference internal" href="#dpgennand2" id="id5">DpgenNand2</a></li>
<li><a class="reference internal" href="#dpgennand3" id="id6">DpgenNand3</a></li>
<li><a class="reference internal" href="#dpgennand4" id="id7">Dpgennand4</a></li>
<li><a class="reference internal" href="#dpgenand2" id="id8">DpgenAnd2</a></li>
<li><a class="reference internal" href="#dpgenand3" id="id9">DpgenAnd3</a></li>
<li><a class="reference internal" href="#dpgenand4" id="id10">DpgenAnd4</a></li>
<li><a class="reference internal" href="#dpgennor2" id="id11">DpgenNor2</a></li>
<li><a class="reference internal" href="#dpgennor3" id="id12">DpgenNor3</a></li>
<li><a class="reference internal" href="#dpgennor4" id="id13">DpgenNor4</a></li>
<li><a class="reference internal" href="#dpgenor2" id="id14">DpgenOr2</a></li>
<li><a class="reference internal" href="#dpgenor3" id="id15">DpgenOr3</a></li>
<li><a class="reference internal" href="#dpgenor4" id="id16">DpgenOr4</a></li>
<li><a class="reference internal" href="#dpgenxor2" id="id17">DpgenXor2</a></li>
<li><a class="reference internal" href="#dpgenxnor2" id="id18">DpgenXnor2</a></li>
<li><a class="reference internal" href="#dpgennmux2" id="id19">DpgenNmux2</a></li>
<li><a class="reference internal" href="#dpgenmux2" id="id20">DpgenMux2</a></li>
<li><a class="reference internal" href="#dpgennbuse" id="id21">DpgenNbuse</a></li>
<li><a class="reference internal" href="#dpgenbuse" id="id22">DpgenBuse</a></li>
<li><a class="reference internal" href="#dpgennand2mask" id="id23">DpgenNand2mask</a></li>
<li><a class="reference internal" href="#dpgennor2mask" id="id24">DpgenNor2mask</a></li>
<li><a class="reference internal" href="#dpgenxnor2mask" id="id25">DpgenXnor2mask</a></li>
<li><a class="reference internal" href="#dpgenadsb2f" id="id26">DpgenAdsb2f</a></li>
<li><a class="reference internal" href="#dpgenshift" id="id27">DpgenShift</a></li>
<li><a class="reference internal" href="#dpgenshrot" id="id28">DpgenShrot</a></li>
<li><a class="reference internal" href="#dpgennul" id="id29">DpgenNul</a></li>
<li><a class="reference internal" href="#dpgenconst" id="id30">DpgenConst</a></li>
<li><a class="reference internal" href="#dpgenrom2" id="id31">DpgenRom2</a></li>
<li><a class="reference internal" href="#dpgenrom4" id="id32">DpgenRom4</a></li>
<li><a class="reference internal" href="#dpgenram" id="id33">DpgenRam</a></li>
<li><a class="reference internal" href="#dpgenrf1" id="id34">DpgenRf1</a></li>
<li><a class="reference internal" href="#dpgenrf1d" id="id35">DpgenRf1d</a></li>
<li><a class="reference internal" href="#dpgenfifo" id="id36">DpgenFifo</a></li>
<li><a class="reference internal" href="#dpgendff" id="id37">DpgenDff</a></li>
<li><a class="reference internal" href="#dpgendfft" id="id38">DpgenDfft</a></li>
<li><a class="reference internal" href="#dpgensff" id="id39">DpgenSff</a></li>
<li><a class="reference internal" href="#dpgensfft" id="id40">DpgenSfft</a></li>
</ul>
</div>
</div>
<div class="section" id="dpgeninv">
<h2><a class="toc-backref" href="#id2">DpgenInv</a></h2>
<h2><a class="toc-backref" href="#id3">DpgenInv</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenInv – Inverter Macro-Generator</p>
</li>
@ -244,7 +248,7 @@ class inst_inv ( Model ) :
</ul>
</div>
<div class="section" id="dpgenbuff">
<h2><a class="toc-backref" href="#id3">DpgenBuff</a></h2>
<h2><a class="toc-backref" href="#id4">DpgenBuff</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenBuff – Buffer Macro-Generator</p>
</li>
@ -324,7 +328,7 @@ class inst_buff ( Model ) :
</ul>
</div>
<div class="section" id="dpgennand2">
<h2><a class="toc-backref" href="#id4">DpgenNand2</a></h2>
<h2><a class="toc-backref" href="#id5">DpgenNand2</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNand2 – Nand2 Macro-Generator</p>
</li>
@ -407,7 +411,7 @@ class inst_nand2 ( Model ) :
</ul>
</div>
<div class="section" id="dpgennand3">
<h2><a class="toc-backref" href="#id5">DpgenNand3</a></h2>
<h2><a class="toc-backref" href="#id6">DpgenNand3</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNand3 – Nand3 Macro-Generator</p>
</li>
@ -493,7 +497,7 @@ class inst_nand3 ( Model ) :
</ul>
</div>
<div class="section" id="dpgennand4">
<h2><a class="toc-backref" href="#id6">Dpgennand4</a></h2>
<h2><a class="toc-backref" href="#id7">Dpgennand4</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNand4 – Nand4 Macro-Generator</p>
</li>
@ -582,7 +586,7 @@ class inst_nand4 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenand2">
<h2><a class="toc-backref" href="#id7">DpgenAnd2</a></h2>
<h2><a class="toc-backref" href="#id8">DpgenAnd2</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenAnd2 – And2 Macro-Generator</p>
</li>
@ -665,7 +669,7 @@ class inst_and2 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenand3">
<h2><a class="toc-backref" href="#id8">DpgenAnd3</a></h2>
<h2><a class="toc-backref" href="#id9">DpgenAnd3</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenAnd3 – And3 Macro-Generator</p>
</li>
@ -751,7 +755,7 @@ class inst_and3 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenand4">
<h2><a class="toc-backref" href="#id9">DpgenAnd4</a></h2>
<h2><a class="toc-backref" href="#id10">DpgenAnd4</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenAnd4 – And4 Macro-Generator</p>
</li>
@ -840,7 +844,7 @@ class inst_and4 ( Model ) :
</ul>
</div>
<div class="section" id="dpgennor2">
<h2><a class="toc-backref" href="#id10">DpgenNor2</a></h2>
<h2><a class="toc-backref" href="#id11">DpgenNor2</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNor2 – Nor2 Macro-Generator</p>
</li>
@ -923,7 +927,7 @@ class inst_nor2 ( Model ) :
</ul>
</div>
<div class="section" id="dpgennor3">
<h2><a class="toc-backref" href="#id11">DpgenNor3</a></h2>
<h2><a class="toc-backref" href="#id12">DpgenNor3</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNor3 – Nor3 Macro-Generator</p>
</li>
@ -1009,7 +1013,7 @@ class inst_nor3 ( Model ) :
</ul>
</div>
<div class="section" id="dpgennor4">
<h2><a class="toc-backref" href="#id12">DpgenNor4</a></h2>
<h2><a class="toc-backref" href="#id13">DpgenNor4</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNor4 – Nor4 Macro-Generator</p>
</li>
@ -1099,7 +1103,7 @@ class inst_nor4 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenor2">
<h2><a class="toc-backref" href="#id13">DpgenOr2</a></h2>
<h2><a class="toc-backref" href="#id14">DpgenOr2</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenOr2 – Or2 Macro-Generator</p>
</li>
@ -1183,7 +1187,7 @@ class inst_or2 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenor3">
<h2><a class="toc-backref" href="#id14">DpgenOr3</a></h2>
<h2><a class="toc-backref" href="#id15">DpgenOr3</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenOr3 – Or3 Macro-Generator</p>
</li>
@ -1269,7 +1273,7 @@ class inst_or3 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenor4">
<h2><a class="toc-backref" href="#id15">DpgenOr4</a></h2>
<h2><a class="toc-backref" href="#id16">DpgenOr4</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenOr4 – Or4 Macro-Generator</p>
</li>
@ -1358,7 +1362,7 @@ class inst_or4 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenxor2">
<h2><a class="toc-backref" href="#id16">DpgenXor2</a></h2>
<h2><a class="toc-backref" href="#id17">DpgenXor2</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenXor2 – Xor2 Macro-Generator</p>
</li>
@ -1441,7 +1445,7 @@ class inst_xor2 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenxnor2">
<h2><a class="toc-backref" href="#id17">DpgenXnor2</a></h2>
<h2><a class="toc-backref" href="#id18">DpgenXnor2</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenXnor2 – Xnor2 Macro-Generator</p>
</li>
@ -1524,7 +1528,7 @@ class inst_xnor2 ( Model ) :
</ul>
</div>
<div class="section" id="dpgennmux2">
<h2><a class="toc-backref" href="#id18">DpgenNmux2</a></h2>
<h2><a class="toc-backref" href="#id19">DpgenNmux2</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNmux2 – Multiplexer Macro-Generator</p>
</li>
@ -1604,7 +1608,7 @@ class inst_nmux2 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenmux2">
<h2><a class="toc-backref" href="#id19">DpgenMux2</a></h2>
<h2><a class="toc-backref" href="#id20">DpgenMux2</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenMux2 – Multiplexer Macro-Generator</p>
</li>
@ -1692,7 +1696,7 @@ class inst_mux2 ( Model ) :
</ul>
</div>
<div class="section" id="dpgennbuse">
<h2><a class="toc-backref" href="#id20">DpgenNbuse</a></h2>
<h2><a class="toc-backref" href="#id21">DpgenNbuse</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNbuse – Tristate Macro-Generator</p>
</li>
@ -1770,7 +1774,7 @@ class inst_nbuse ( Model ) :
</ul>
</div>
<div class="section" id="dpgenbuse">
<h2><a class="toc-backref" href="#id21">DpgenBuse</a></h2>
<h2><a class="toc-backref" href="#id22">DpgenBuse</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenBuse – Tristate Macro-Generator</p>
</li>
@ -1848,7 +1852,7 @@ class inst_buse ( Model ) :
</ul>
</div>
<div class="section" id="dpgennand2mask">
<h2><a class="toc-backref" href="#id22">DpgenNand2mask</a></h2>
<h2><a class="toc-backref" href="#id23">DpgenNand2mask</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNand2mask – Programmable Mask Macro-Generator</p>
</li>
@ -1943,7 +1947,7 @@ class inst_nand2mask ( Model ) :
</ul>
</div>
<div class="section" id="dpgennor2mask">
<h2><a class="toc-backref" href="#id23">DpgenNor2mask</a></h2>
<h2><a class="toc-backref" href="#id24">DpgenNor2mask</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNor2mask – Programmable Mask Macro-Generator</p>
</li>
@ -2038,7 +2042,7 @@ class inst_nor2mask ( Model ) :
</ul>
</div>
<div class="section" id="dpgenxnor2mask">
<h2><a class="toc-backref" href="#id24">DpgenXnor2mask</a></h2>
<h2><a class="toc-backref" href="#id25">DpgenXnor2mask</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenXnor2mask – Programmable Mask Macro-Generator</p>
</li>
@ -2133,7 +2137,7 @@ class inst_xnor2mask ( Model ) :
</ul>
</div>
<div class="section" id="dpgenadsb2f">
<h2><a class="toc-backref" href="#id25">DpgenAdsb2f</a></h2>
<h2><a class="toc-backref" href="#id26">DpgenAdsb2f</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenAdsb2f – Adder/Substractor Macro-Generator</p>
</li>
@ -2224,7 +2228,7 @@ class inst_ADSB2F ( Model ) :
</ul>
</div>
<div class="section" id="dpgenshift">
<h2><a class="toc-backref" href="#id26">DpgenShift</a></h2>
<h2><a class="toc-backref" href="#id27">DpgenShift</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenShift – Shifter Macro-Generator</p>
</li>
@ -2304,7 +2308,7 @@ class inst_shifter ( Model ) :
</ul>
</div>
<div class="section" id="dpgenshrot">
<h2><a class="toc-backref" href="#id27">DpgenShrot</a></h2>
<h2><a class="toc-backref" href="#id28">DpgenShrot</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenShrot – Shift/Rotation Macro-Generator</p>
</li>
@ -2388,7 +2392,7 @@ class inst_shrot ( Model ) :
</ul>
</div>
<div class="section" id="dpgennul">
<h2><a class="toc-backref" href="#id28">DpgenNul</a></h2>
<h2><a class="toc-backref" href="#id29">DpgenNul</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenNul – Zero Detector Macro-Generator</p>
</li>
@ -2458,7 +2462,7 @@ class inst_nul ( Model ) :
</ul>
</div>
<div class="section" id="dpgenconst">
<h2><a class="toc-backref" href="#id29">DpgenConst</a></h2>
<h2><a class="toc-backref" href="#id30">DpgenConst</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenConst – Constant Macro-Generator</p>
</li>
@ -2532,7 +2536,7 @@ class inst_const ( Model ) :
</ul>
</div>
<div class="section" id="dpgenrom2">
<h2><a class="toc-backref" href="#id30">DpgenRom2</a></h2>
<h2><a class="toc-backref" href="#id31">DpgenRom2</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenRom2 – 2 words ROM Macro-Generator</p>
</li>
@ -2610,7 +2614,7 @@ class inst_rom2 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenrom4">
<h2><a class="toc-backref" href="#id31">DpgenRom4</a></h2>
<h2><a class="toc-backref" href="#id32">DpgenRom4</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenRom4 – 4 words ROM Macro-Generator</p>
</li>
@ -2698,7 +2702,7 @@ class inst_rom4 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenram">
<h2><a class="toc-backref" href="#id32">DpgenRam</a></h2>
<h2><a class="toc-backref" href="#id33">DpgenRam</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenRam – RAM Macro-Generator</p>
</li>
@ -2778,7 +2782,7 @@ class inst_ram ( Model ) :
</ul>
</div>
<div class="section" id="dpgenrf1">
<h2><a class="toc-backref" href="#id33">DpgenRf1</a></h2>
<h2><a class="toc-backref" href="#id34">DpgenRf1</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenRf1, DpgenRf1r0 – Register File Macro-Generator</p>
</li>
@ -2878,7 +2882,7 @@ class inst_rf1 ( Model ) :
</ul>
</div>
<div class="section" id="dpgenrf1d">
<h2><a class="toc-backref" href="#id34">DpgenRf1d</a></h2>
<h2><a class="toc-backref" href="#id35">DpgenRf1d</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenRf1d, DpgenRf1dr0 – Register File with Decoder
Macro-Generator</p>
@ -2987,7 +2991,7 @@ class inst_rf1d ( Model ) :
</ul>
</div>
<div class="section" id="dpgenfifo">
<h2><a class="toc-backref" href="#id35">DpgenFifo</a></h2>
<h2><a class="toc-backref" href="#id36">DpgenFifo</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenFifo – Fifo Macro-Generator</p>
</li>
@ -3093,7 +3097,7 @@ class inst_fifo ( Model ) :
</ul>
</div>
<div class="section" id="dpgendff">
<h2><a class="toc-backref" href="#id36">DpgenDff</a></h2>
<h2><a class="toc-backref" href="#id37">DpgenDff</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenDff – Dynamic Flip-Flop Macro-Generator</p>
</li>
@ -3173,7 +3177,7 @@ class inst_dff ( Model ) :
</ul>
</div>
<div class="section" id="dpgendfft">
<h2><a class="toc-backref" href="#id37">DpgenDfft</a></h2>
<h2><a class="toc-backref" href="#id38">DpgenDfft</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenDfft – Dynamic Flip-Flop with Scan-Path
Macro-Generator</p>
@ -3265,7 +3269,7 @@ class inst_dfft ( Model ) :
</ul>
</div>
<div class="section" id="dpgensff">
<h2><a class="toc-backref" href="#id38">DpgenSff</a></h2>
<h2><a class="toc-backref" href="#id39">DpgenSff</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenSff – Static Flip-Flop Macro-Generator</p>
</li>
@ -3345,7 +3349,7 @@ class inst_sff ( Model ) :
</ul>
</div>
<div class="section" id="dpgensfft">
<h2><a class="toc-backref" href="#id39">DpgenSfft</a></h2>
<h2><a class="toc-backref" href="#id40">DpgenSfft</a></h2>
<ul>
<li><p class="first"><strong>Name</strong> : DpgenSfft – Static Flip-Flop with Scan-Path
Macro-Generator</p>

38
documentation/output/pages/stratus-language.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Printable version of this document Stratus.pdf. Stratus – Procedural design language based upon Python Contents Introduction Description of a netlist Description of a layout Patterns generation ...">
<meta name="description" content="Printable version of this Document Stratus.pdf Contents Printable version of this Document Introduction Description of a netlist Description of a layout Patterns generation extension Place and Route ...">
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
@ -119,22 +119,26 @@
<!-- Standard CAO/VLSI Concepts. -->
<!-- Alliance & MBK Concepts -->
<!-- Hurricane Concepts. -->
<p>Printable version of this document <a class="reference external" href="../pdfs/Stratus.pdf">Stratus.pdf</a>.</p>
<p>Stratus – Procedural design language based upon <em>Python</em></p>
<div class="section" id="printable-version-of-this-document">
<h2><a class="toc-backref" href="#id185">Printable version of this Document</a></h2>
<p><a class="reference external" href="../pdfs/Stratus.pdf">Stratus.pdf</a></p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#introduction" id="id185">Introduction</a></li>
<li><a class="reference internal" href="#description-of-a-netlist" id="id186">Description of a netlist</a></li>
<li><a class="reference internal" href="#description-of-a-layout" id="id187">Description of a layout</a></li>
<li><a class="reference internal" href="#patterns-generation-extension" id="id188">Patterns generation extension</a></li>
<li><a class="reference internal" href="#place-and-route" id="id189">Place and Route</a></li>
<li><a class="reference internal" href="#instanciation-facilities" id="id190">Instanciation facilities</a></li>
<li><a class="reference internal" href="#useful-links" id="id191">Useful links</a></li>
<li><a class="reference internal" href="#printable-version-of-this-document" id="id185">Printable version of this Document</a></li>
<li><a class="reference internal" href="#introduction" id="id186">Introduction</a></li>
<li><a class="reference internal" href="#description-of-a-netlist" id="id187">Description of a netlist</a></li>
<li><a class="reference internal" href="#description-of-a-layout" id="id188">Description of a layout</a></li>
<li><a class="reference internal" href="#patterns-generation-extension" id="id189">Patterns generation extension</a></li>
<li><a class="reference internal" href="#place-and-route" id="id190">Place and Route</a></li>
<li><a class="reference internal" href="#instanciation-facilities" id="id191">Instanciation facilities</a></li>
<li><a class="reference internal" href="#useful-links" id="id192">Useful links</a></li>
</ul>
</div>
<p>Stratus – Procedural design language based upon <em>Python</em></p>
</div>
<div class="section" id="introduction">
<h2><a class="toc-backref" href="#id185">Introduction</a></h2>
<h2><a class="toc-backref" href="#id186">Introduction</a></h2>
<div class="section" id="stratus">
<h3>Stratus</h3>
<div class="section" id="name">
@ -369,7 +373,7 @@ Inst ( &quot;my_addaccu_%dbits&quot; % n
</div>
</div>
<div class="section" id="description-of-a-netlist">
<h2><a class="toc-backref" href="#id186">Description of a netlist</a></h2>
<h2><a class="toc-backref" href="#id187">Description of a netlist</a></h2>
<div class="section" id="nets">
<h3>Nets</h3>
<div class="section" id="id2">
@ -616,7 +620,7 @@ False by default)</li>
</div>
</div>
<div class="section" id="description-of-a-layout">
<h2><a class="toc-backref" href="#id187">Description of a layout</a></h2>
<h2><a class="toc-backref" href="#id188">Description of a layout</a></h2>
<div class="section" id="place">
<h3>Place</h3>
<div class="section" id="id16">
@ -1145,7 +1149,7 @@ abtument box</li>
</div>
</div>
<div class="section" id="patterns-generation-extension">
<h2><a class="toc-backref" href="#id188">Patterns generation extension</a></h2>
<h2><a class="toc-backref" href="#id189">Patterns generation extension</a></h2>
<div class="section" id="description-of-the-stimuli">
<h3>Description of the stimuli</h3>
<p>The stimuli used for the simulation are described in a <tt class="docutils literal">Stimuli</tt>
@ -1172,7 +1176,7 @@ self._stim.add()
</div>
</div>
<div class="section" id="place-and-route">
<h2><a class="toc-backref" href="#id189">Place and Route</a></h2>
<h2><a class="toc-backref" href="#id190">Place and Route</a></h2>
<div class="section" id="placesegment">
<h3>PlaceSegment</h3>
<div class="section" id="id64">
@ -1796,7 +1800,7 @@ The pads must be placed before calling RoutageCk.</li>
</div>
</div>
<div class="section" id="instanciation-facilities">
<h2><a class="toc-backref" href="#id190">Instanciation facilities</a></h2>
<h2><a class="toc-backref" href="#id191">Instanciation facilities</a></h2>
<div class="section" id="buffer">
<h3>Buffer</h3>
<div class="section" id="id140">
@ -2524,7 +2528,7 @@ The mapping file is not given in the environment variable.</li>
</div>
</div>
<div class="section" id="useful-links">
<h2><a class="toc-backref" href="#id191">Useful links</a></h2>
<h2><a class="toc-backref" href="#id192">Useful links</a></h2>
<div class="section" id="dpgen-generators">
<h3>DpGen generators</h3>
<p>You can find the documentation of the DPGEN library at : ./DpGen.html</p>

24
documentation/output/pages/stratus-patterns.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Printable version of this document Stratus.pdf. Contents Description Syntax Methods Example Description The patterns module of Stratus is a set of Python classes and methods that allows a procedural ...">
<meta name="description" content="Printable version of this Document Stratus.pdf Contents Printable version of this Document Description Syntax Methods Example Description The patterns module of Stratus is a set of Python classes and ...">
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
@ -119,18 +119,22 @@
<!-- Standard CAO/VLSI Concepts. -->
<!-- Alliance & MBK Concepts -->
<!-- Hurricane Concepts. -->
<p>Printable version of this document <a class="reference external" href="../../../pdf/main/Stratus.pdf">Stratus.pdf</a>.</p>
<div class="section" id="printable-version-of-this-document">
<h2><a class="toc-backref" href="#id8">Printable version of this Document</a></h2>
<p><a class="reference external" href="{filename}/pdf/Stratus.pdf">Stratus.pdf</a></p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#description" id="id8">Description</a></li>
<li><a class="reference internal" href="#syntax" id="id9">Syntax</a></li>
<li><a class="reference internal" href="#methods" id="id10">Methods</a></li>
<li><a class="reference internal" href="#example" id="id11">Example</a></li>
<li><a class="reference internal" href="#printable-version-of-this-document" id="id8">Printable version of this Document</a></li>
<li><a class="reference internal" href="#description" id="id9">Description</a></li>
<li><a class="reference internal" href="#syntax" id="id10">Syntax</a></li>
<li><a class="reference internal" href="#methods" id="id11">Methods</a></li>
<li><a class="reference internal" href="#example" id="id12">Example</a></li>
</ul>
</div>
</div>
<div class="section" id="description">
<h2><a class="toc-backref" href="#id8">Description</a></h2>
<h2><a class="toc-backref" href="#id9">Description</a></h2>
<p>The patterns module of <em>Stratus</em> is a set of <em>Python</em> classes and
methods that allows a procedural description of input pattern file for
the logic simulator. The <em>Stratus</em> <tt class="docutils literal">Pattern</tt> method produces a pattern
@ -139,7 +143,7 @@ in pat format, so IT IS STRONGLY RECOMMENDED TO SEE pat(5) manual BEFORE
TO USE IT.</p>
</div>
<div class="section" id="syntax">
<h2><a class="toc-backref" href="#id9">Syntax</a></h2>
<h2><a class="toc-backref" href="#id10">Syntax</a></h2>
<p>From a user point of view, <tt class="docutils literal">Pattern</tt> method is a pattern description
language using all standard <em>Python</em> facilities. Here follows the
description of the <tt class="docutils literal">Pattern</tt> method.
@ -181,7 +185,7 @@ output file (see <tt class="docutils literal">pattern_end</tt> [pattern:sub:<cit
</div>
</div>
<div class="section" id="methods">
<h2><a class="toc-backref" href="#id10">Methods</a></h2>
<h2><a class="toc-backref" href="#id11">Methods</a></h2>
<div class="section" id="patwrite">
<h3>PatWrite</h3>
<p>This class is used to create patterns for <em>Stratus</em> models. Currently it
@ -309,7 +313,7 @@ vectors.</p>
</div>
</div>
<div class="section" id="example">
<h2><a class="toc-backref" href="#id11">Example</a></h2>
<h2><a class="toc-backref" href="#id12">Example</a></h2>
<p><tt class="docutils literal">Pattern</tt> method for an addaccu</p>
<pre class="literal-block">
def Pattern(self):

71
documentation/output/pages/users-guide.html
View File

@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="Contents Credits &amp; License Complete Design Flow &amp; Examples Installation Fixed Directory Tree Building Coriolis Coriolis &amp; Docker Packaging Coriolis Hooking up into Alliance Setting up the Environment ...">
<meta name="description" content="Printable Version of this Document Coriolis User&#39;s Guide. Contents Printable Version of this Document Abstract Credits &amp; License Complete Design Flow &amp; Examples Installation Fixed Directory Tree ...">
<meta name="keywords" content="">
<link rel="icon" href="../favicon.ico">
@ -114,23 +114,28 @@
<!-- -*- Mode: rst -*- -->
<!-- URLs that changes between the various backends. -->
<!-- For HTML backend -->
<div class="section" id="printable-version-of-this-document">
<h2><a class="toc-backref" href="#id13">Printable Version of this Document</a></h2>
<p><a class="reference external" href="../pdfs/UsersGuide.pdf">Coriolis User's Guide</a>.</p>
<div class="contents topic" id="contents">
<p class="topic-title first">Contents</p>
<ul class="simple">
<li><a class="reference internal" href="#credits-license" id="id13">Credits &amp; License</a></li>
<li><a class="reference internal" href="#complete-design-flow-examples" id="id14">Complete Design Flow &amp; Examples</a></li>
<li><a class="reference internal" href="#installation" id="id15">Installation</a><ul>
<li><a class="reference internal" href="#fixed-directory-tree" id="id16">Fixed Directory Tree</a></li>
<li><a class="reference internal" href="#building-coriolis" id="id17">Building Coriolis</a></li>
<li><a class="reference internal" href="#coriolis-docker" id="id18"><span class="sc">Coriolis</span> &amp; Docker</a></li>
<li><a class="reference internal" href="#packaging-coriolis" id="id19">Packaging Coriolis</a></li>
<li><a class="reference internal" href="#hooking-up-into-alliance" id="id20">Hooking up into <span class="sc">Alliance</span></a></li>
<li><a class="reference internal" href="#setting-up-the-environment-coriolisenv-py" id="id21">Setting up the Environment (coriolisEnv.py)</a></li>
<li><a class="reference internal" href="#printable-version-of-this-document" id="id13">Printable Version of this Document</a></li>
<li><a class="reference internal" href="#abstract" id="id14">Abstract</a></li>
<li><a class="reference internal" href="#credits-license" id="id15">Credits &amp; License</a></li>
<li><a class="reference internal" href="#complete-design-flow-examples" id="id16">Complete Design Flow &amp; Examples</a></li>
<li><a class="reference internal" href="#installation" id="id17">Installation</a><ul>
<li><a class="reference internal" href="#fixed-directory-tree" id="id18">Fixed Directory Tree</a></li>
<li><a class="reference internal" href="#building-coriolis" id="id19">Building Coriolis</a></li>
<li><a class="reference internal" href="#coriolis-docker" id="id20"><span class="sc">Coriolis</span> &amp; Docker</a></li>
<li><a class="reference internal" href="#packaging-coriolis" id="id21">Packaging Coriolis</a></li>
<li><a class="reference internal" href="#hooking-up-into-alliance" id="id22">Hooking up into <span class="sc">Alliance</span></a></li>
<li><a class="reference internal" href="#setting-up-the-environment-coriolisenv-py" id="id23">Setting up the Environment (coriolisEnv.py)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#cgt-the-graphical-interface" id="id22">CGT - The Graphical Interface</a><ul>
<li><a class="reference internal" href="#id4" id="id23">Viewer &amp; Tools</a></li>
<li><a class="reference internal" href="#id5" id="id24">The Controller</a></li>
<li><a class="reference internal" href="#cgt-the-graphical-interface" id="id24">CGT - The Graphical Interface</a><ul>
<li><a class="reference internal" href="#id4" id="id25">Viewer &amp; Tools</a></li>
<li><a class="reference internal" href="#id5" id="id26">The Controller</a></li>
</ul>
</li>
</ul>
@ -142,6 +147,9 @@
<!-- Standard CAO/VLSI Concepts. -->
<!-- Alliance & MBK Concepts -->
<!-- Hurricane Concepts. -->
</div>
<div class="section" id="abstract">
<h2><a class="toc-backref" href="#id14">Abstract</a></h2>
<p><span class="sc">Coriolis</span> is a set of tools for <span class="sc">vlsi</span> backend. It's main features are :</p>
<ul class="simple">
<li>An analytic placer <span class="sc">Etesian</span> (based on <span class="sc">Coloquinte</span>).</li>
@ -153,8 +161,9 @@ is currently under development.</li>
<!-- This page is only an excerpt form the `Coriolis User's Guide`_ focused on how -->
<!-- to get and build the toolchain. -->
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="credits-license">
<h2><a class="toc-backref" href="#id13">Credits &amp; License</a></h2>
<h2><a class="toc-backref" href="#id15">Credits &amp; License</a></h2>
<table style="border: none; width: 80%; align: center; margin-left: auto; margin-right: auto; font-size: 110%">
<tr>
<td style="text-align: left" ><span><span class="sc">Hurricane</span></span></td>
@ -192,7 +201,7 @@ copyright© Chris C. N. <span class="sc">Chu</span> from the Iowa State Universi
<p></p>
</div>
<div class="section" id="complete-design-flow-examples">
<h2><a class="toc-backref" href="#id14">Complete Design Flow &amp; Examples</a></h2>
<h2><a class="toc-backref" href="#id16">Complete Design Flow &amp; Examples</a></h2>
<p>While <span class="sc">Coriolis</span> can be used stand-alone, it is in fact part of a more complete
design flow build upon <span class="sc">Yosys</span> and <span class="sc">Alliance</span>. In addition, a set of demos and
examples are supplied in the repository <tt class="docutils literal"><span class="pre">alliance-check-toolkit</span></tt>.</p>
@ -210,7 +219,7 @@ examples are supplied in the repository <tt class="docutils literal"><span class
<!-- -*- Mode: rst -*- -->
</div>
<div class="section" id="installation">
<h2><a class="toc-backref" href="#id15">Installation</a></h2>
<h2><a class="toc-backref" href="#id17">Installation</a></h2>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">As the sources are being released, the binary packaging is dropped.
@ -254,7 +263,7 @@ If you really want to re-generate it, add the <tt class="docutils literal"><span
</ul>
<p>For other distributions, refer to their own packaging system.</p>
<div class="section" id="fixed-directory-tree">
<h3><a class="toc-backref" href="#id16">Fixed Directory Tree</a></h3>
<h3><a class="toc-backref" href="#id18">Fixed Directory Tree</a></h3>
<p>In order to simplify the work of the <span class="cb">ccb</span> installer, the source, build
and installation tree is fixed. To successfully compile <span class="sc">Coriolis</span> you must
follow it exactly. The tree is relative to the home directory of the user
@ -347,12 +356,12 @@ and Python modules (which must be dynamic).</p>
</div>
</div>
<div class="section" id="building-coriolis">
<h3><a class="toc-backref" href="#id17">Building Coriolis</a></h3>
<h3><a class="toc-backref" href="#id19">Building Coriolis</a></h3>
<div class="section" id="the-actively-developed-branch">
<h4>The actively developed branch</h4>
<p>The <strong>devel_anabatic</strong> branch is now closed and we go back to a more classical
scheme where <strong>master</strong> is the stable version and <strong>devel</strong> the development one.</p>
<p>The <span class="sc">Coriolis</span> <span class="cb">git</span> repository is <a class="reference external" href="https://www-soc.lip6.fr/git/coriolis.git">https://www-soc.lip6.fr/git/coriolis.git</a></p>
<p>The <span class="sc">Coriolis</span> <span class="cb">git</span> repository is <a class="reference external" href="https://gitlab.lip6.fr/vlsi-cad/coriolis.git">https://gitlab.lip6.fr/vlsi-cad/coriolis.git</a></p>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">Again, the <strong>devel_anabatic</strong> branch is now closed. Please revert to <strong>devel</strong>
@ -408,7 +417,7 @@ dummy@lepka:support&gt; git clone http://github.com/miloyip/rapidjson
<li><p class="first">Create the source directory and pull the <span class="cb">git</span> repository:</p>
<div class="highlight"><pre><span></span>dummy@lepka:~&gt; mkdir -p ~/coriolis-2.x/src
dummy@lepka:src&gt; <span class="nb">cd</span> ~/coriolis-2.x/src
dummy@lepka:src&gt; git clone https://www-soc.lip6.fr/git/coriolis.git
dummy@lepka:src&gt; git clone https://gitlab.lip6.fr/vlsi-cad/coriolis.git
</pre></div>
</li>
<li><p class="first">Build &amp; install:</p>
@ -519,7 +528,7 @@ this will confuse the installer and end up with a non functional software
<p>Second step is to create the source directory and pull the <span class="cb">git</span> repository:</p>
<div class="highlight"><pre><span></span>dummy@lepka:~&gt; mkdir -p ~/coriolis-2.x/src
dummy@lepka:src&gt; <span class="nb">cd</span> ~/coriolis-2.x/src
dummy@lepka:src&gt; git clone https://www-soc.lip6.fr/git/coriolis.git
dummy@lepka:src&gt; git clone https://gitlab.lip6.fr/vlsi-cad/coriolis.git
</pre></div>
<p>Third and final step, build &amp; install:</p>
<div class="highlight"><pre><span></span>dummy@lepka:src&gt; <span class="nb">cd</span> coriolis
@ -543,7 +552,7 @@ the system.</p>
</div>
</div>
<div class="section" id="coriolis-docker">
<h3><a class="toc-backref" href="#id18"><span class="sc">Coriolis</span> &amp; Docker</a></h3>
<h3><a class="toc-backref" href="#id20"><span class="sc">Coriolis</span> &amp; Docker</a></h3>
<p>Under <tt class="docutils literal">bootstrap/docker/</tt> scripts and configuration files are provided that
allow to rebuild <span class="sc">Alliance</span> and <span class="sc">Coriolis</span> and perform the regression tests
of <tt class="docutils literal"><span class="pre">alliance-check-toolkit</span></tt>. You may have a look at the <tt class="docutils literal">Dockerfile.system</tt>
@ -551,13 +560,13 @@ configuration file to see exactly how to setup a vanilla system to build
<span class="sc">Coriolis</span>.</p>
<p>To run the docker tests, call the <tt class="docutils literal">dockerManage.sh</tt> scripts with the relevant
arguments:</p>
<div class="highlight"><pre><span></span>ego@home:debian-9&gt; ../../dockerManage.sh -scb <span class="c1"># build system, coriolis &amp; bash images.</span>
ego@home:debian-9&gt; ../../dockerManage.sh -r <span class="c1"># run the bash image.</span>
ego@home:debian-9&gt; ../../dockerManage.sh --remove <span class="c1"># clear all images.</span>
<div class="highlight"><pre><span></span>ego@home:debian-9&gt; ../../dockerManage.sh -bS <span class="c1"># build both system &amp; coriolis images.</span>
ego@home:debian-9&gt; ../../dockerManage.sh -r <span class="c1"># compile &amp; check coriolis.</span>
ego@home:debian-9&gt; ../../dockerManage.sh -C <span class="c1"># clear the images.</span>
</pre></div>
</div>
<div class="section" id="packaging-coriolis">
<h3><a class="toc-backref" href="#id19">Packaging Coriolis</a></h3>
<h3><a class="toc-backref" href="#id21">Packaging Coriolis</a></h3>
<p>Packager should not use <span class="cb">ccb</span>, instead <tt class="docutils literal">bootstrap/Makefile.package</tt> is provided
to emulate a top-level <tt class="docutils literal">autotool</tt> makefile. Just copy it in the root of the
<span class="sc">Coriolis</span> git repository (<tt class="docutils literal"><span class="pre">~/corriolis-2.x/src/coriolis/</span></tt>) and build.</p>
@ -568,7 +577,7 @@ to emulate a top-level <tt class="docutils literal">autotool</tt> makefile. Just
</ul>
</div>
<div class="section" id="hooking-up-into-alliance">
<h3><a class="toc-backref" href="#id20">Hooking up into <span class="sc">Alliance</span></a></h3>
<h3><a class="toc-backref" href="#id22">Hooking up into <span class="sc">Alliance</span></a></h3>
<p><span class="sc">Coriolis</span> relies on <span class="sc">Alliance</span> for the cell libraries. So after installing or
packaging, you must configure it so that it can found those libraries.</p>
<p>The easiest way is to setup the <span class="sc">Alliance</span> environment (i.e. sourcing
@ -577,7 +586,7 @@ packaging, you must configure it so that it can found those libraries.</p>
have look to the <cite>Alliance Helper</cite>.</p>
</div>
<div class="section" id="setting-up-the-environment-coriolisenv-py">
<h3><a class="toc-backref" href="#id21">Setting up the Environment (coriolisEnv.py)</a></h3>
<h3><a class="toc-backref" href="#id23">Setting up the Environment (coriolisEnv.py)</a></h3>
<p>To simplify the tedious task of configuring your environment, a helper is provided
in the <tt class="docutils literal">bootstrap</tt> source directory (also installed in the directory
<tt class="docutils literal"><span class="pre">.../install/etc/coriolis2/</span></tt>) :</p>
@ -600,7 +609,7 @@ infinite loop if it's called again in, say <span class="cb">~/.bashrc</span>.</p
</div>
</div>
<div class="section" id="cgt-the-graphical-interface">
<h2><a class="toc-backref" href="#id22">CGT - The Graphical Interface</a></h2>
<h2><a class="toc-backref" href="#id24">CGT - The Graphical Interface</a></h2>
<p>The <span class="sc">Coriolis</span> graphical interface is split up into two windows.</p>
<ul class="simple">
<li>The <strong>Viewer</strong>, with the following features:<ul>
@ -629,7 +638,7 @@ They are closely related to Configuration &amp; Initialisation.</li>
</ul>
<p> <img alt="Controller Basic Snapshot" class="align-middle" src="../pages/images/Controller-1.png" style="width: 80%;" /> </p>
<div class="section" id="id4">
<span id="viewer-tools"></span><h3><a class="toc-backref" href="#id23">Viewer &amp; Tools</a></h3>
<span id="viewer-tools"></span><h3><a class="toc-backref" href="#id25">Viewer &amp; Tools</a></h3>
<div class="section" id="stratus-netlist-capture">
<h4><span class="sc">Stratus</span> Netlist Capture</h4>
<p><span class="sc">Stratus</span> is the replacement for <span class="sc">GenLib</span> procedural netlist capture language.
@ -1322,7 +1331,7 @@ To generate one set this flag to <span class="cb">True</span></td>
</div>
</div>
<div class="section" id="id5">
<span id="the-controller"></span><h3><a class="toc-backref" href="#id24">The Controller</a></h3>
<span id="the-controller"></span><h3><a class="toc-backref" href="#id26">The Controller</a></h3>
<p>The <em>Controller</em> window is composed of seven tabs:</p>
<ol class="arabic simple">
<li><a class="reference internal" href="#the-look-tab">The Look Tab</a> to select the display style.</li>