Skip to content

Commit bf5895b

Browse files
CSharperMantlekammoh
authored andcommitted
[docs] Fix wrong argument docs in SRAM object (chipsalliance#4827)
1 parent d6e835d commit bf5895b

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -400,9 +400,9 @@ object SRAM {
400400
*
401401
* @param size The desired size of the inner `SyncReadMem`
402402
* @tparam T The data type of the memory element
403-
* @param numReadPorts The number of desired read ports >= 0, and (numReadPorts + numReadwritePorts) > 0
404-
* @param numWritePorts The number of desired write ports >= 0, and (numWritePorts + numReadwritePorts) > 0
405-
* @param numReadwritePorts The number of desired read/write ports >= 0, and the above two conditions must hold
403+
* @param readPortClocks A sequence of clocks for each read port; and (numReadPorts + numReadwritePorts) > 0
404+
* @param writePortClocks A sequence of clocks for each write port; and (numWritePorts + numReadwritePorts) > 0
405+
* @param readwritePortClocks A sequence of clocks for each read-write port; and the above two conditions must hold
406406
*
407407
* @return A new `SRAMInterface` wire containing the control signals for each instantiated port
408408
* @note This does *not* return the `SyncReadMem` itself, you must interact with it using the returned bundle
@@ -435,9 +435,9 @@ object SRAM {
435435
*
436436
* @param size The desired size of the inner `SyncReadMem`
437437
* @tparam T The data type of the memory element
438-
* @param numReadPorts The number of desired read ports >= 0, and (numReadPorts + numReadwritePorts) > 0
439-
* @param numWritePorts The number of desired write ports >= 0, and (numWritePorts + numReadwritePorts) > 0
440-
* @param numReadwritePorts The number of desired read/write ports >= 0, and the above two conditions must hold
438+
* @param readPortClocks A sequence of clocks for each read port; and (numReadPorts + numReadwritePorts) > 0
439+
* @param writePortClocks A sequence of clocks for each write port; and (numWritePorts + numReadwritePorts) > 0
440+
* @param readwritePortClocks A sequence of clocks for each read-write port; and the above two conditions must hold
441441
* @param memoryFile A memory file whose path is emitted as Verilog directives to initialize the inner `SyncReadMem`
442442
*
443443
* @return A new `SRAMInterface` wire containing the control signals for each instantiated port

0 commit comments

Comments
 (0)