Skip to content

Commit 1719212

Browse files
committed
README cleanup
1 parent db4ddf0 commit 1719212

File tree

1 file changed

+36
-6
lines changed

1 file changed

+36
-6
lines changed

lambdalib/iolib/README.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
| Cell | Type | Description |
66
| ---------------------------------|---------|-----------------------------|
7-
[la_iobidir](./rtl/la_iobidir.v) | Digital | Bidirectional
7+
[[la_iobidir](./rtl/la_iobidir.v) | Digital | Bidirectional
88
[la_ioinput](./rtl/la_ioinput.v) | Digital | Input
99
[la_ioxtal](./rtl/la_ioxtal.v) | Digital | Xtal tranceiver
1010
[la_iorxdiff](./rtl/la_iorxdiff.v) | Digital | Differential input
1111
[la_iotxdiff](./rtl/la_iotxdiff.v) | Digital | Differential output
1212
[la_ioanalog](./rtl/la_ioanalog.v) | Analog | Pass through ESD protection
1313
[la_iovdd](./rtl/la_iovdd.v) | Supply | Core power
1414
[la_iovss](./rtl/la_iovss.v) | Supply | Core ground
15-
[la_iovddio](./rtl/la_iovddio.v) | Supply | IO power
15+
[la_iovddio](./rtl/la_iovddio.v) | Supply | IO power
1616
[la_iovssio](./rtl/la_iovssio.v) | Supply | IO ground
1717
[la_iovdda](./rtl/la_iovdda.v) | Supply | Analog power
1818
[la_iovssa](./rtl/la_iovssa.v) | Supply | Analog ground
@@ -21,11 +21,10 @@
2121
[la_ioclamp](./rtl/la_ioclamp.v) | Supply | ESD clamp
2222
[la_iocut](./rtl/la_iocut.v) | Supply | Power ring cutter
2323

24-
2524
## PARAMETERS
2625

2726
### CFGW
28-
The `CFGW` parameter defines the width of the configuration bus of the io cell. IO cells generally include a set of configuration inputs for things like drive strength and operating modes. Setting `CFGW` to a large value (eg. 16/32) should have zero impact on the design as the extra bus bits get optimized away during implementation.
27+
The `CFGW` parameter defines the width of the configuration bus of the io cell. IO cells generally include a set of configuration inputs for things like drive strength and operating modes. Setting `CFGW` to a large value (eg. 16/32) should have zero impact on the design as the extra bus bits get optimized away during implementation.
2928

3029
For la_bidir, the first 8 bits of the configuration bus are reserved for the functionality shown in the table below.
3130

@@ -38,13 +37,44 @@ For la_bidir, the first 8 bits of the configuration bus are reserved for the fun
3837
CFG[7:4] | drive strength |
3938

4039
#### RINGW
41-
The `RINGW` parameter specifies the number of signals within the power bus that connects all of the io cells together within the padring.
40+
The `RINGW` parameter specifies the number of signals within the power bus that connects all of the io cells together within the padring.
4241

4342
### SIDE
44-
The `SIDE` parameter indicates the placement of a cell instances within a padring.Legal values for `SIDE` are: "NO" (north/top), "EA" (east/right), "WE" (west/left), "SO" (south/bottom). The parameter can be used by the technology specific implementation of `iolib` to selec the native orientation of the cell. Modern process nodes place restrictions on the orientation of transistors and include vertical and horizontal version of all active io cells.
43+
The `SIDE` parameter indicates the placement of a cell instances within a padring.Legal values for `SIDE` are: "NO" (north/top), "EA" (east/right), "WE" (west/left), "SO" (south/bottom). The parameter can be used by the technology specific implementation of `iolib` to selec the native orientation of the cell. Modern process nodes place restrictions on the orientation of transistors and include vertical and horizontal version of all active io cells.
4544

4645
### PROP
4746
The `PROP` parameter can be used by the technology specific `iolib` implementation to select between different variants of the `iolib` cell type. The `PROP` parameter is library specific and should only be used when absolutely necessary. Using this parameter means technology/ip information permeates up through the design (nullifying the benefits of lambdalib).
4847

48+
## Cell Description
49+
50+
## la_iobidir
51+
52+
## la_ioinput
53+
54+
## la_ioxtal
55+
56+
## la_iorxdif
57+
58+
## la_iotxdiff
59+
60+
## la_ioanalog
61+
62+
## la_iovdd
63+
64+
## la_iovss
65+
66+
## la_iovddio
67+
68+
## la_iovssio
69+
70+
## la_iovdda
71+
72+
## la_iovssa
73+
74+
## la_iopoc
75+
76+
## la_iocorner
4977

78+
## la_ioclamp
5079

80+
## la_iocut

0 commit comments

Comments
 (0)