Skip to content

Commit ba3a5da

Browse files
committed
update README to include info on default value for -mask_size
Signed-off-by: Thinh Nguyen <nguyenthinh19011@gmail.com>
1 parent bc539c3 commit ba3a5da

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

src/ram/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Standard cell libraries must be loaded before running this command.
3333
The module will create a new design, therefore a design should not be loaded before running the command.
3434

3535
```tcl
36-
generate_ram -mask_size bits
36+
generate_ram [-mask_size bits]
3737
-word_size bits
3838
-num_words words
3939
[-read_ports count]
@@ -55,7 +55,7 @@ generate_ram -mask_size bits
5555

5656
| Switch Name | Description |
5757
| ----- | ----- |
58-
| `-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. |
58+
| `-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`. |
5959
| `-word_size` | Size of each word in bits. |
6060
| `-num_words` | Number of words in the array. |
6161
| `-read_ports` | Number of read ports for the array. Default: 1. |

0 commit comments

Comments
 (0)