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

199 lines
10 KiB
ReStructuredText
Raw Normal View History

Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
.. -*- Mode: rst; explicit-buffer-name: "definition.rst<documentation/etc>" -*-
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. role:: raw-html(raw)
:format: html
.. role:: raw-latex(raw)
:format: latex
.. role:: ul
.. role:: cb
.. role:: sc
.. role:: fboxtt
.. HTML/LaTeX backends mixed macros.
.. |br| replace:: :raw-latex:`\linebreak` :raw-html:`<br/>`
.. |medskip| replace:: :raw-latex:`\medskip` :raw-html:`<br class="medskip"/>`
.. |newpage| replace:: :raw-latex:`\newpage`
.. |linebreak| replace:: :raw-latex:`\smallskip`
.. |noindent| replace:: :raw-latex:`\noindent` :raw-html:`<p class="noindent"></p>`
.. |dotfill| replace:: :raw-html:`&nbsp;&nbsp;`
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
.. |bcenter| replace:: :raw-latex:`\begin{center}`
.. |ecenter| replace:: :raw-latex:`\end{center}`
.. |pagestylefancy| replace:: :raw-latex:`\thispagestyle{fancy}`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. Acronyms & names.
.. |GNU| replace:: :sc:`gnu`
.. |LGPL| replace:: :sc:`lgpl`
.. |GPL| replace:: :sc:`gpl`
.. |UPMC| replace:: :sc:`upmc`
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
.. |SorbonneUniversite| replace:: :sc:`Sorbonne Université`
.. |SU| replace:: :sc:`su`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |Bull| replace:: :sc:`Bull`
.. |Cadence| replace:: :sc:`Cadence`
.. |Si2| replace:: :sc:`Si2`
.. |LEFDEF| replace:: :sc:`lefdef`
Update documentation for new technology scheme.
2017-11-17 05:04:33 -06:00
.. |LEF| replace:: :sc:`lef`
.. |DEF| replace:: :sc:`def`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |Flute| replace:: :sc:`Flute`
.. |MacOS| replace:: :sc:`MacOS`
Validating channel routing mode (two metals) on SNX. * New: In Hurricane::Entity, add an id counter limit and a memory size limit. The two limits are checked only when a new Entity object is created. This should help avoiding massive memory links. * New: In CRL Core, add a "crlcore.groundName" and a "crlcore.powerName" parameter to specify the name of the ground/power signals to be created if they are missing in a Cell. For Alliance libraries it would be "vss" & "vdd" (default values), but for real technologies, it is often "gnd!" & "vdd!". The Blif parser is modificated to make use of it. * Bug: In AnabaticEngine::unify(), set the resulting unified segment in the center of the GCells common side. Gcells under a segment are found by using the edge that cover the segment axis. When we have a "bend" GCell stack and the axis is wrong, they could be ommited. This was causing deleted segments to be not removed from some Edges, then core dump. * Change: In Anabatic::AutoSegment::create(), smarter choosing of the reference contact, select the fixed or terminal one instead of always the source one. * New: In Anabatic::Edge::isEnding(), new function to check if a segment going through an Edge is starting/ending in either source or target GCell of the edge (active only when running in channel mode). * New: In Anabatic::Edge::add(), a segment takes part in the occupancy only if it is not ending in either source or target (channel mode only). The occupancy due to terminal is pre-computed in Katana. * New: In Anabatic::Edge::ripup(), in channel mode, never ripup a segment which is ending in either source or target (we *have* to access this edge to connect to the terminal). * Bug: In Anabatic::GCell::hcut() and vcut(), force the update of the Edge which is on the side that will get splitted by the cut. It's capacity will be reduced to it must be updated. * Change: In Anabatic::GCell::updateGContacts() add a flag to conditionnally update horizontals or verticals only. We may require only a partial update when resizing the GCell in only one direction. This, again, related to the fact that we compute the GCells under a segment thanks to it's axis position, so we need to be very careful when modificating axis. * Change: In Katana::Block::resizeChannels(), only update GContact vertical position. Do not disturb X positions of segments. * Bug: In Katana::GlobalRoute::DigitalDistance, in channel mode, some Edges can have a zero capacity, but still be reachable if the net has a terminal in either source or target. Look for this case and return a distance of zero instead of "unreachable". This was causing the global routing not to complete in channel mode. For computing the edge distance, makes the vertical edges much more long (10 times) than the horizontal ones as the vertical capacity is very limited. Hard coded for now, should make it a parameter in the future. * Change: In KatanaEngine::annotateGlobalGraph(), decrease the capacity of edges with reserveCapacity for each terminal inside a GCell. Both north and south edges are decreased as we a terminal will block both north and south edges. As a counterpart, the Edge capacity is not decreased when the global router connect to a terminal. * Change: In Katana::RoutingEvent::revalidate(), when in repair stage, do not expand the slack for horizontal segments in channel mode. So they may not overlap the standard cell row. * Bug: In Stratus documentation, do not use the french option in babel, the documentation is in english! * New: In Documentation, added Hurricane/Python tutorial, part for drawing layout.
2018-03-16 10:20:04 -05:00
.. |Darwin| replace:: :sc:`Darwin`
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
.. |RHEL| replace:: :sc:`rhel`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |RHEL6| replace:: :sc:`rhel6`
.. |RHEL7| replace:: :sc:`rhel7`
.. |SL6| replace:: :sc:`Scientific Linux 6`
.. |SL7| replace:: :sc:`Scientific Linux 7`
.. |Scientific Linux| replace:: :sc:`Scientific Linux`
.. |RedHat| replace:: :sc:`RedHat`
.. |Fedora| replace:: :sc:`Fedora`
.. |FC13| replace:: :sc:`fc13`
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
.. |EPEL| replace:: :sc:`epel`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |Debian| replace:: :sc:`Debian`
.. |Ubuntu| replace:: :sc:`Ubuntu`
Update documentation for new technology scheme.
2017-11-17 05:04:33 -06:00
.. |MOSIS| replace:: :sc:`mosis`
Added netlist & tool engines to Hurricane+Python tutorial.
2018-03-18 17:28:49 -05:00
.. |Blif| replace:: :sc:`blif`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |Alexandre| replace:: :sc:`Alexandre`
.. |Belloeil| replace:: :sc:`Belloeil`
.. |Chaput| replace:: :sc:`Chaput`
Ajout Roselyne dans les contributeurs
2019-05-23 10:30:42 -05:00
.. |Chotin| replace:: :sc:`Chotin`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |Chu| replace:: :sc:`Chu`
.. |Clement| replace:: :sc:`Clement`
.. |Dupuis| replace:: :sc:`Dupuis`
.. |Escassut| replace:: :sc:`Escassut`
.. |Gouvine| replace:: :sc:`Gouvine`
.. |Masson| replace:: :sc:`Masson`
.. |Sroka| replace:: :sc:`Sroka`
.. |Yifei| replace:: :sc:`Yifei`
Added netlist & tool engines to Hurricane+Python tutorial.
2018-03-18 17:28:49 -05:00
.. |VLSI| replace:: :sc:`vlsi`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |ANSI| replace:: :sc:`ansi`
.. |MIPS| replace:: :sc:`mips`
.. |Am2901| replace:: :sc:`Am2901`
.. |Hurricane| replace:: :sc:`Hurricane`
Validating channel routing mode (two metals) on SNX. * New: In Hurricane::Entity, add an id counter limit and a memory size limit. The two limits are checked only when a new Entity object is created. This should help avoiding massive memory links. * New: In CRL Core, add a "crlcore.groundName" and a "crlcore.powerName" parameter to specify the name of the ground/power signals to be created if they are missing in a Cell. For Alliance libraries it would be "vss" & "vdd" (default values), but for real technologies, it is often "gnd!" & "vdd!". The Blif parser is modificated to make use of it. * Bug: In AnabaticEngine::unify(), set the resulting unified segment in the center of the GCells common side. Gcells under a segment are found by using the edge that cover the segment axis. When we have a "bend" GCell stack and the axis is wrong, they could be ommited. This was causing deleted segments to be not removed from some Edges, then core dump. * Change: In Anabatic::AutoSegment::create(), smarter choosing of the reference contact, select the fixed or terminal one instead of always the source one. * New: In Anabatic::Edge::isEnding(), new function to check if a segment going through an Edge is starting/ending in either source or target GCell of the edge (active only when running in channel mode). * New: In Anabatic::Edge::add(), a segment takes part in the occupancy only if it is not ending in either source or target (channel mode only). The occupancy due to terminal is pre-computed in Katana. * New: In Anabatic::Edge::ripup(), in channel mode, never ripup a segment which is ending in either source or target (we *have* to access this edge to connect to the terminal). * Bug: In Anabatic::GCell::hcut() and vcut(), force the update of the Edge which is on the side that will get splitted by the cut. It's capacity will be reduced to it must be updated. * Change: In Anabatic::GCell::updateGContacts() add a flag to conditionnally update horizontals or verticals only. We may require only a partial update when resizing the GCell in only one direction. This, again, related to the fact that we compute the GCells under a segment thanks to it's axis position, so we need to be very careful when modificating axis. * Change: In Katana::Block::resizeChannels(), only update GContact vertical position. Do not disturb X positions of segments. * Bug: In Katana::GlobalRoute::DigitalDistance, in channel mode, some Edges can have a zero capacity, but still be reachable if the net has a terminal in either source or target. Look for this case and return a distance of zero instead of "unreachable". This was causing the global routing not to complete in channel mode. For computing the edge distance, makes the vertical edges much more long (10 times) than the horizontal ones as the vertical capacity is very limited. Hard coded for now, should make it a parameter in the future. * Change: In KatanaEngine::annotateGlobalGraph(), decrease the capacity of edges with reserveCapacity for each terminal inside a GCell. Both north and south edges are decreased as we a terminal will block both north and south edges. As a counterpart, the Edge capacity is not decreased when the global router connect to a terminal. * Change: In Katana::RoutingEvent::revalidate(), when in repair stage, do not expand the slack for horizontal segments in channel mode. So they may not overlap the standard cell row. * Bug: In Stratus documentation, do not use the french option in babel, the documentation is in english! * New: In Documentation, added Hurricane/Python tutorial, part for drawing layout.
2018-03-16 10:20:04 -05:00
.. |CRL| replace:: :sc:`crl`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |Alliance| replace:: :sc:`Alliance`
.. |Yosys| replace:: :sc:`Yosys`
.. |GenLib| replace:: :sc:`GenLib`
.. |Nero| replace:: :sc:`Nero`
.. |Druc| replace:: :cb:`Druc`
.. |Coloquinte| replace:: :sc:`Coloquinte`
.. |Coriolis| replace:: :sc:`Coriolis`
.. |Coriolis1| replace:: :sc:`Coriolis 1`
.. |Coriolis2| replace:: :sc:`Coriolis 2`
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
.. |alliance-check-toolkit| replace:: ``alliance-check-toolkit``
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |VLSISAPD| replace:: :sc:`vlsisapd`
.. |CRLcore| replace:: :sc:`CRLcore`
.. |Cyclop| replace:: :sc:`Cyclop`
.. |Nimbus| replace:: :sc:`Nimbus`
.. |hMetis| replace:: :sc:`hMetis`
.. |Mauka| replace:: :sc:`Mauka`
.. |Etesian| replace:: :sc:`Etesian`
.. |Knik| replace:: :sc:`Knik`
.. |Katabatic| replace:: :sc:`Katabatic`
.. |Kite| replace:: :sc:`Kite`
Added netlist & tool engines to Hurricane+Python tutorial.
2018-03-18 17:28:49 -05:00
.. |Katana| replace:: :sc:`Katana`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |Stratus| replace:: :sc:`Stratus`
.. |Stratus1| replace:: :sc:`Stratus1`
.. |Stratus2| replace:: :sc:`Stratus2`
.. |Unicorn| replace:: :sc:`Unicorn`
.. |ccb| replace:: :cb:`ccb`
.. |cgt| replace:: :cb:`cgt`
.. |Chams| replace:: :sc:`Chams`
.. |OpenChams| replace:: :sc:`OpenChams`
.. |API| replace:: :sc:`api`
.. |STL| replace:: :sc:`stl`
.. |XML| replace:: :sc:`xml`
.. |pdf| replace:: :sc:`pdf`
.. |UTF-8| replace:: :sc:`utf-8`
.. |Python| replace:: :sc:`Python`
.. |Linux| replace:: :sc:`Linux`
.. |MacPorts| replace:: :sc:`MacPorts`
Update generated documenation (change for devtoolset).
2019-03-04 07:35:16 -06:00
.. |devtoolset| replace:: :cb:`devtoolset`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |boost| replace:: :cb:`boost`
.. |Qt| replace:: :sc:`qt`
.. |tty| replace:: :cb:`tty`
.. |svn| replace:: :cb:`svn`
.. |git| replace:: :cb:`git`
.. |rpm| replace:: :cb:`rpm`
.. |gdb| replace:: :cb:`gdb`
In documentation, Update installation instructions.
2019-05-26 08:46:44 -05:00
.. |valgrind| replace:: :cb:`valgrind`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. |cmake| replace:: :cb:`cmake`
.. |struct| replace:: :cb:`struct`
.. |KeyUp| replace:: :fboxtt:`Up`
.. |KeyDown| replace:: :fboxtt:`Down`
.. |KeyLeft| replace:: :fboxtt:`Left`
.. |KeyRight| replace:: :fboxtt:`Right`
.. |KeyF| replace:: :fboxtt:`f`
.. |KeyL| replace:: :fboxtt:`l`
.. |KeyG| replace:: :fboxtt:`g`
.. |KeyZ| replace:: :fboxtt:`z`
.. |KeyM| replace:: :fboxtt:`m`
.. |KeyI| replace:: :fboxtt:`i`
.. |KeyK| replace:: :fboxtt:`k`
.. |KeyP| replace:: :fboxtt:`p`
.. |KeyO| replace:: :fboxtt:`o`
.. |KeyW| replace:: :fboxtt:`w`
.. |KeyQ| replace:: :fboxtt:`q`
.. |KeyCapK| replace:: :fboxtt:`K`
.. |KeyCapS| replace:: :fboxtt:`S`
.. |Plus| replace:: :fboxtt:`+`
.. |KeyESC| replace:: :fboxtt:`ESC`
.. |CTRL| replace:: :fboxtt:`CTRL`
.. |CTRL_L| replace:: :fboxtt:`CTRL+L`
.. |CTRL_I| replace:: :fboxtt:`CTRL+I`
.. |CTRL_P| replace:: :fboxtt:`CTRL+P`
.. |CTRL_O| replace:: :fboxtt:`CTRL+O`
.. |CTRL_W| replace:: :fboxtt:`CTRL+W`
.. |CTRL_Q| replace:: :fboxtt:`CTRL+Q`
.. |CTRL_Down| replace:: :fboxtt:`CTRL+Down`
.. |CTRL_Up| replace:: :fboxtt:`CTRL+Up`
.. |CTRL_Left| replace:: :fboxtt:`CTRL+Left`
.. |CTRL_Right| replace:: :fboxtt:`CTRL+Right`
.. URLs
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
.. _Doxygen: http://www.stack.nl/~dimitri/doxygen/
.. _LaTeX2HTML: http://www.latex2html.org/
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. _FGR: http://vlsicad.eecs.umich.edu/BK/FGR/
.. _Box Router: http://www.cerc.utexas.edu/~thyeros/boxrouter/boxrouter.htm
.. _hMETIS: http://glaros.dtc.umn.edu/gkhome/views/metis
.. _Knik Thesis: http://www-soc.lip6.fr/en/users/damiendupuis/PhD/
.. _RapidJSON: http://miloyip.github.io/rapidjson/
.. _Python/C API Reference Manual: https://docs.python.org/2/c-api/index.html
Update documentation to build on Debian 9.2 (stretch). * Change: In documentation/CMakeLists.txt, for add_custom_targets(), add_dependencies() no longer allow to give files (only others *target* in the sense of cmake). We must use the DEPENDS option of add_custom_target(). * Change: In documentation/UsersGuide, it seems that docutils no longer handle correctly '$' and/or '_' in verbatim in the LaTeX backend. (i.e. they are *not* escaped, resulting in math mode errors). Remove those characters as we can use others... * Commit a snaphot of the current documentation.
2017-10-30 09:33:37 -05:00
.. _Apache License, Version 2.0: http://www.apache.org/licences/LICENSE-2.0
Added netlist & tool engines to Hurricane+Python tutorial.
2018-03-18 17:28:49 -05:00
.. _FreePDK45: https://www.eda.ncsu.edu/wiki/FreePDK45:Contents
.. _Yosys: http://www.clifford.at/yosys/
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. Standard CAO/VLSI Concepts.
.. |netlist| replace:: *netlist*
.. |netlists| replace:: *netlists*
.. |layout| replace:: *layout*
.. |layouts| replace:: *layouts*
.. |CMOS| replace:: :sc:`cmos`
.. |VHDL| replace:: :sc:`vhdl`
.. |NWELL| replace:: :sc:`nwell`
.. |POWER| replace:: :sc:`power`
.. |GROUND| replace:: :sc:`ground`
.. MBK Concepts
.. |MBK| replace:: :sc:`mbk`
.. |LOFIG| replace:: :cb:`Lofig`
.. |PHFIG| replace:: :cb:`Phfig`
.. |SxLib| replace:: :sc:`SxLib`
Complete hoverhaul of the documentation to Sphinx. * New: In documentation, reorganise all the various documents into one Sphinx coherent one. The index also provide a link toward the Doxygen generated doc (C++ APIs) and the venerable LaTeX2HTML ones (for Stratus). This will make easier all future extensions to the doc corpus. The generated documentation is commited into Git so a new user can use it directly after cloning the repository. The HTML doc is truly generated by Sphinx, but the pdf one is created rst2latex. The Sphinx pdf writer is buggy when a "tabular" contain a multicol and a multirow in the same area of the table. rst2latex handles it correctly. We use a theme borrowed for Read The Doc (half of it). It seems that some Javascripts are not working correctly, namely the folding of the navigation sub-menus and the index generation and search mode.
2017-07-15 10:35:02 -05:00
.. |RDS| replace:: :sc:`rds`
Documentation of the Hurricane Python C / API.
2017-06-30 13:00:22 -05:00
.. Hurricane Concepts.
.. |hypernet| replace:: *hypernet*
.. |hypernets| replace:: *hypernets*
.. |Cell| replace:: *Cell*
.. |Rings| replace:: *Rings*
.. |QuadTrees| replace:: *QuadTrees*
.. |Collections| replace:: *Collections*
.. |ap| replace:: :cb:`ap`
.. |vst| replace:: :cb:`vst`
.. |kgr| replace:: :cb:`kgr`
.. |dot_conf| replace:: :cb:`.conf`