Skip to content

Commit d23c2ac

Browse files
committed
fix readmes
1 parent caee57c commit d23c2ac

File tree

3 files changed

+17
-21
lines changed

3 files changed

+17
-21
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Lambdalib includes the following hardware categories:
99
|[stdlib](lambdalib/stdlib/rtl) | Standard cells (inv, nand, ff, ...)
1010
|[auxlib](lambdalib/auxlib/rtl) | Aux cells can consist of multiple standard cells or physical only cells
1111
|[ramlib](lambdalib/ramlib/rtl) | Memory (single port, dual port, fifo, ...)
12-
|[iolib](lambdalib/iolib/rtl) | IO cells (bidir, vdd, clamp,...)
13-
|[padring](lambdalib/padring/rtl) | Padring generator
12+
|[iolib](lambdalib/iolib) | IO cells (bidir, vdd, clamp,...)
13+
|[padring](lambdalib/padring) | Padring generator
1414
|[vectorlib](lambdalib/vectorlib/rtl) | Vectorized library (mux, isolation)
1515
|[syslib](lambdalib/syslib/rtl) | Vendor agnostic peripheral interface (uart, i2c,...)
1616
|[fpgalib](lambdalib/fpgalib/rtl) | FPGA cells (lut4, ble, clb)

lambdalib/iolib/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
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 transceiver
1010
[la_iorxdiff](./rtl/la_iorxdiff.v) | Digital | Differential input
@@ -77,4 +77,4 @@ The `PROP` parameter can be used by the technology specific `iolib` implementati
7777

7878
## la_ioclamp
7979

80-
## la_iocut
80+
## la_iocut

lambdalib/padring/README.md

Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Introduction
44

5-
The lamdbdalib `padring` library is an automated "pure verilog" padring generator with support for cells within the [IOLIB](../../iolib/README.md) io cell library.
5+
The lamdbdalib `padring` library is an automated "pure verilog" padring generator with support for cells within the [IOLIB](../iolib/README.md) io cell library.
66

77
## PARAMETERS
88

@@ -20,17 +20,17 @@ Specifies the type of cells, pin connections, properties, and power connections
2020

2121
* PIN[7:0] = CELLMAP[7:0] = pin number connected to cell. Positive signal in case of differential pairs.
2222
* COMP[7:0] = CELLMAP[15:8] = pin number of complementary (negative) pad to `PIN`. Used for differential IO cells.
23-
* TYPE[7:0] = CELLMAP[23:16] = cell type (see ./la_padring.vh)
23+
* TYPE[7:0] = CELLMAP[23:16] = cell type (see [la_iopadring.vh](rtl/la_iopadring.vh))
2424
* SECTION[7:0] = CELLMAP[31:24] = padring power section number connected to cell
2525
* PROP[7:0] = CELLMAP[39:32] = property passed to technology specific iolib implementation
2626

27-
The header file [la_iopadring.vh](./rtl/la_iopadring.vh) enumerates the cells recognized by the padring generator. `NULL` is a reserved keyword used to specify an empty `CELLMAP` field.
27+
The header file [la_iopadring.vh](rtl/la_iopadring.vh) enumerates the cells recognized by the padring generator. `NULL` is a reserved keyword used to specify an empty `CELLMAP` field.
2828

2929
### CFGW
30-
Specifies the width of the configuration bus of the io cell. For a description of uses of `CFGW`, see [IOLIB](../../iolib/README.md).
30+
Specifies the width of the configuration bus of the io cell. For a description of uses of `CFGW`, see [IOLIB](../iolib/README.md).
3131

3232
#### RINGW
33-
The `RINGW` parameter specifies the number of signals within the power bus that connects all of the io cells together within the padring. For a description of uses of `RINGW`, see [IOLIB](../../iolib/README.md).
33+
The `RINGW` parameter specifies the number of signals within the power bus that connects all of the io cells together within the padring. For a description of uses of `RINGW`, see [IOLIB](../iolib/README.md).
3434

3535

3636
## Using the Generator
@@ -50,7 +50,6 @@ The following excerpt from the testbench illustrate the use of the `CELLMAP`, `N
5050

5151
```verilog
5252
53-
5453
// Setting up your parameters
5554
5655
localparam CFGW = 8;
@@ -65,16 +64,16 @@ The following excerpt from the testbench illustrate the use of the `CELLMAP`, `N
6564
localparam [7:0] PIN_RXP = 8'h02;
6665
localparam [7:0] PIN_RXN = 8'h03;
6766
68-
localparam NULL = 8'h0;
67+
localparam [7:0] NULL = 8'h0;
6968
7069
localparam CELLMAP = {{NULL, NULL, LA_VSS, NULL, NULL},
71-
{NULL, NULL, LA_BIDIR, NULL, PIN_IO0},
72-
{NULL, NULL, LA_ANALOG, NULL, PIN_AN0},
73-
{NULL, NULL, LA_VDDIO, NULL, NULL},
74-
{NULL, NULL, LA_RXDIFF, PIN_RXN, PIN_RXP},
75-
{NULL, NULL, LA_VSS, NULL, NULL},
76-
{NULL, NULL, LA_VSS, NULL, NULL},
77-
{NULL, NULL, LA_VSS, NULL, NULL}};
70+
{NULL, NULL, LA_BIDIR, NULL, PIN_IO0},
71+
{NULL, NULL, LA_ANALOG, NULL, PIN_AN0},
72+
{NULL, NULL, LA_VDDIO, NULL, NULL},
73+
{NULL, NULL, LA_RXDIFF, PIN_RXN, PIN_RXP},
74+
{NULL, NULL, LA_VSS, NULL, NULL},
75+
{NULL, NULL, LA_VSS, NULL, NULL},
76+
{NULL, NULL, LA_VSS, NULL, NULL}};
7877
7978
// Instantiating the padring in your design
8079
la_iopadring #(.CFGW(CFGW),
@@ -92,7 +91,4 @@ la_iopadring #(.CFGW(CFGW),
9291
.WE_CELLMAP(CELLMAP),
9392
.SO_CELLMAP(CELLMAP))
9493
la_iopadring(...)
95-
96-
97-
9894
```

0 commit comments

Comments
 (0)