wu-arch/chipyard
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

grammer + spell check

Browse Source
This commit is contained in:
abejgonzalez
2019-08-08 11:19:57 -07:00
parent 80b6976be9
commit 9538257be1
2 changed files with 8 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/VLSI/HAMMER.rst
View File

@@ -19,13 +19,13 @@ Steps are the sub-components of actions that individually addressable in Hammer
Hooks Hooks
------- -------
Hooks are modifications to steps or actions that are programmaticly defined in a Hammer configuration. Hooks are modifications to steps or actions that are programmatically defined in a Hammer configuration.
Tool Plugins Tool Plugins
============ ============
Hammer supports separatly managed plugins for different CAD tool vendors. Hammer supports separately managed plugins for different CAD tool vendors.
The types of tools(in there hammer names) supported currently include: The types of tools (in there hammer names) supported currently include:
* synthesis * synthesis
* par * par
@@ -34,27 +34,25 @@ The types of tools(in there hammer names) supported currently include:
* sram_generator * sram_generator
* pcb * pcb
In order to configure your tool plugin of choice you will need to set several configuration variables. In order to configure your tool plugin of choice, you will need to set several configuration variables.
First you should select which specific tool you want to use by setting ``vlsi.core.<tool_type>_tool`` to the name of your tool. First, you should select which specific tool you want to use by setting ``vlsi.core.<tool_type>_tool`` to the name of your tool.
For example ``vlsi.core.par_tool: "innovus"``. For example ``vlsi.core.par_tool: "innovus"``.
You will also need to point hammer to the folder that contains your tool plugin by setting ``vlsi.core.<tool_type>_tool_path``. You will also need to point hammer to the folder that contains your tool plugin by setting ``vlsi.core.<tool_type>_tool_path``.
This directory should include a folder with the name of the tool as specified previously, which itself includes a python file ``__init__.py`` and a yaml file ``defaults.yml`` specifing the default values for any tool specific variables. This directory should include a folder with the name of the tool as specified previously, which itself includes a python file ``__init__.py`` and a yaml file ``defaults.yml`` specifying the default values for any tool specific variables.
In addition you can also customize the version of the tools you use by setting ``<tool_type>.<tool_name>.version`` to a tool specific string. In addition you can also customize the version of the tools you use by setting ``<tool_type>.<tool_name>.version`` to a tool specific string.
Looking at the tools ``defaults.yml`` will inform you if there are other variables you would like to set for your use of this tool. Looking at the tools ``defaults.yml`` will inform you if there are other variables you would like to set for your use of this tool.
The ``__init__.py`` file should contain a variable, ``tool``, that points to the class implementing this tools Hammer support. The ``__init__.py`` file should contain a variable, ``tool``, that points to the class implementing this tools Hammer support.
This class should be a subclass of ``Hammer<tool_type>Tool``, which will be a subclass of ``HammerTool``. This class should be a subclass of ``Hammer<tool_type>Tool``, which will be a subclass of ``HammerTool``.
Technology Plugins Technology Plugins
================== ==================
Hammer supports separately managed plugins for different technologies. Hammer supports separately managed plugins for different technologies.
Configuration Configuration
============= =============
To configure a hammer flow the user needs to supply a yaml or json configuration file the chooses the tool and technology plugins and versions as well as any design specific configuration APIs. To configure a hammer flow the user needs to supply a yaml or json configuration file the chooses the tool and technology plugins and versions as well as any design specific configuration APIs.
You can see the current set of all avaialable Hammer APIs `here <https://github.com/ucb-bar/hammer/blob/master/src/hammer-vlsi/defaults.yml>`__. You can see the current set of all available Hammer APIs `here <https://github.com/ucb-bar/hammer/blob/master/src/hammer-vlsi/defaults.yml>`__.

2
docs/VLSI/index.rst
View File

@@ -2,7 +2,7 @@ VLSI Flow
================================ ================================
The Chipyard framework aims to provide wrappers for a general VLSI flow. The Chipyard framework aims to provide wrappers for a general VLSI flow.
In particular, we aim to support the HAMMER physical deisgn generator flow. In particular, we aim to support the HAMMER physical design generator flow.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2