Skip to content

Commit 5323139

Browse files
authored
Merge pull request #4828 from chipsalliance/mergify/bp/6.x/pr-4827
[docs] Fix wrong argument docs in SRAM object (backport #4827)
2 parents efac93e + abed60d commit 5323139

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/main/scala/chisel3/util/SRAM.scala

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,9 @@ object SRAM {
226226
*
227227
* @param size The desired size of the inner `SyncReadMem`
228228
* @tparam T The data type of the memory element
229-
* @param numReadPorts The number of desired read ports >= 0, and (numReadPorts + numReadwritePorts) > 0
230-
* @param numWritePorts The number of desired write ports >= 0, and (numWritePorts + numReadwritePorts) > 0
231-
* @param numReadwritePorts The number of desired read/write ports >= 0, and the above two conditions must hold
229+
* @param readPortClocks A sequence of clocks for each read port; and (numReadPorts + numReadwritePorts) > 0
230+
* @param writePortClocks A sequence of clocks for each write port; and (numWritePorts + numReadwritePorts) > 0
231+
* @param readwritePortClocks A sequence of clocks for each read-write port; and the above two conditions must hold
232232
*
233233
* @return A new `SRAMInterface` wire containing the control signals for each instantiated port
234234
* @note This does *not* return the `SyncReadMem` itself, you must interact with it using the returned bundle
@@ -261,9 +261,9 @@ object SRAM {
261261
*
262262
* @param size The desired size of the inner `SyncReadMem`
263263
* @tparam T The data type of the memory element
264-
* @param numReadPorts The number of desired read ports >= 0, and (numReadPorts + numReadwritePorts) > 0
265-
* @param numWritePorts The number of desired write ports >= 0, and (numWritePorts + numReadwritePorts) > 0
266-
* @param numReadwritePorts The number of desired read/write ports >= 0, and the above two conditions must hold
264+
* @param readPortClocks A sequence of clocks for each read port; and (numReadPorts + numReadwritePorts) > 0
265+
* @param writePortClocks A sequence of clocks for each write port; and (numWritePorts + numReadwritePorts) > 0
266+
* @param readwritePortClocks A sequence of clocks for each read-write port; and the above two conditions must hold
267267
* @param memoryFile A memory file whose path is emitted as Verilog directives to initialize the inner `SyncReadMem`
268268
*
269269
* @return A new `SRAMInterface` wire containing the control signals for each instantiated port

0 commit comments

Comments
 (0)