Skip to content

Commit b2bdd59

Browse files
committed
Updates to chipflow-toml-guide.rst
1 parent 6a8eb9b commit b2bdd59

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

docs/chipflow-toml-guide.rst

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ and add the following to your `chipflow.toml`, with the appropriate Python `qual
3838

3939
.. code-block:: TOML
4040
41-
[chipflow.stepe]
41+
[chipflow.steps]
4242
silicon = "my_design.steps.silicon:SiliconStep"
4343
4444
@@ -80,18 +80,13 @@ Available processes
8080
| ihp_sg13g2 | pga144 | IHP SG13G2 130nm SiGe |
8181
+------------+------------+---------------------------+
8282

83-
Available pad rings
84-
-------------------
83+
Available pad rings (``package``)
84+
---------------------------------
8585

8686
+----------+-----------+--------------------+------------------------------------+
8787
| Pad ring | Pad count | Pad locations | Notes |
8888
+==========+===========+====================+====================================+
8989
+----------+-----------+--------------------+------------------------------------+
90-
|| cf20 || 20 || ``N1`` ... ``N7`` || Bare die package with 20 pins |
91-
|| || || ``S1`` ... ``S7`` || |
92-
|| || || ``E1`` ... ``E3`` || |
93-
|| || || ``W1`` ... ``W3`` || |
94-
+----------+-----------+--------------------+------------------------------------+
9590
| pga144 | 144 | ``1`` ... ``144`` | |
9691
+----------+-----------+--------------------+------------------------------------+
9792
|| TBA || || || If you require a different |
@@ -105,9 +100,16 @@ Available pad rings
105100
silicon.pads
106101
============
107102

108-
The ``silicon.pads`` section lists special pads. In general you are unlikely to need to add to this.
103+
The ``silicon.pads`` section lists special pads. In general you are unlikely to need to add to this.
104+
Each pad specified with the name used by the design and two parameters: ``type`` and ``loc``.
105+
106+
.. code-block:: TOML
107+
108+
[chipflow.silicon.pads]
109+
sys_clk = { type = "clock", loc = "114" }
110+
sys_rst_n = { type = "reset", loc = "115" }
109111
110-
For each pad, there's a label which is used by our design, and what ``type`` and ``loc`` each pad should be.
112+
In the above example two pads specified, ``sys_clk`` pad for clock input and ``sys_rst_n`` for reset.
111113

112114
type
113115
----
@@ -117,14 +119,17 @@ The ``type`` for each pad can be set to one of:
117119
clock
118120
External clock input.
119121

122+
reset
123+
External reset input.
124+
120125
i
121126
Input.
122127

123128
o
124129
Output.
125130

126131
io
127-
Input or output.
132+
Both input and output.
128133

129134
loc
130135
----
@@ -134,7 +139,7 @@ This is the physical location of the pad on your chosen pad ring. How these are
134139
silicon.power
135140
=============
136141

137-
This section describes how the pads should be connected to the power available on the chosen process.
142+
This section describes how the pads should be connected to the power available on the chosen process and package.
138143

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

0 commit comments

Comments
 (0)