Skip to content

chipflow-toml-guide: Fix RST syntax for terms #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2025
Merged

chipflow-toml-guide: Fix RST syntax for terms #106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/chipflow-toml-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ You probably won't need to change these if you're starting from an example repos
default = 'sys_clk'

This section links the clock domains utilized in the design to specific pads.
These pads need to be specified in the `[silicon.pads]`_ section with the :term:type set to :term:clock.
These pads need to be specified in the `[silicon.pads]`_ section with the :term:`type` set to :term:`clock`.
The ``default`` clock domain is associated with the Amaranth :any:`sync <lang-domains>` :ref:`clock domain <lang-clockdomains>`.
Currently, only one ``default`` clock domain is supported.

Expand All @@ -92,7 +92,7 @@ Currently, only one ``default`` clock domain is supported.
default = 'sys_rst_n'

This section identifies the input pads designated for reset functionality.
These pads need to be specified in the `[silicon.pads]`_ section with the :term:type set to :term:reset.
These pads need to be specified in the `[silicon.pads]`_ section with the :term:`type` set to :term:`reset`.
The logic that synchronizes the reset signal with the clock will be generated automatically.

``[chipflow.silicon]``
Expand Down Expand Up @@ -143,7 +143,7 @@ Available pad rings
------------------

The ``silicon.pads`` section lists special pads. In general you are unlikely to need to add to this.
Each pad specified with the name used by the design and two parameters: :term:type and :term:`loc`.
Each pad specified with the name used by the design and two parameters: :term:`type` and :term:`loc`.

.. code-block:: TOML

Expand All @@ -159,7 +159,7 @@ In the above example two pads specified, ``sys_clk`` pad for clock input and ``s
This is the physical location of the pad on your chosen pad ring. How these are indexed varies by the pad ring.

type
The :term:type for each pad can be set to one of :term:clock or :term:reset.
The :term:`type` for each pad can be set to one of :term:`clock` or :term:`reset`.

clock
External clock input.
Expand All @@ -172,8 +172,8 @@ In the above example two pads specified, ``sys_clk`` pad for clock input and ``s
-------------------

This section outlines the connection of pads to the power supply available for the selected process and package.
These pads are declared with the :term:type and :term:loc parameters, similar to the `[silicon.pads]`_ section.
Note that in this context, the :term:type parameter can only be ``ground`` or ``power``.
These pads are declared with the :term:`type` and :term:`loc` parameters, similar to the `[silicon.pads]`_ section.
Note that in this context, the :term:`type` parameter can only be ``ground`` or ``power``.

This is a work in progress, and currently you can use the defaults provided by customer support.

Expand Down
Loading