Skip to content

Commit f81e7da

Browse files
committed
update README.md to include info on column/muxing
Signed-off-by: Thinh Nguyen <nguyenthinh19011@gmail.com>
1 parent ba3a5da commit f81e7da

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

src/ram/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ The module will create a new design, therefore a design should not be loaded bef
3636
generate_ram [-mask_size bits]
3737
-word_size bits
3838
-num_words words
39+
[-column_mux_ratio ratio]
3940
[-read_ports count]
4041
[-storage_cell name]
4142
[-tristate_cell name]
@@ -58,6 +59,7 @@ generate_ram [-mask_size bits]
5859
| `-mask_size` | Determines the number of bits which are grouped together for masking during writes. For example, a mask size of `8` will enable each 8 bits of the word to be masked when writing (commonly known as byte masking). A mask size of `1` will enable each bit to be individually masked. The write enable signal for each port will be `(word_size / mask_size)` bits wide. The word size must be a multiple of the mask size. Default: equal to `-word_size`. |
5960
| `-word_size` | Size of each word in bits. |
6061
| `-num_words` | Number of words in the array. |
62+
| `-column_mux_ratio` | Number of words sharing a physical column. Must be `1`, `2`, or `4`. The number of words must be divisible by the column mux ratio. Default: `1` (no column muxing). |
6163
| `-read_ports` | Number of read ports for the array. Default: 1. |
6264
| `-storage_cell` | Name of the master to use for the storage device (i.e. a flip-flop). Must be positive-edge triggered. Default: auto-select from the loaded cell library. |
6365
| `-tristate_cell` | Name of the master to use for the tristate device (i.e. a tristate inverter). It is currently assumed that the device is inverting. Default: auto-select from the loaded cell library. |

0 commit comments

Comments
 (0)