Skip to content

Commit c5f44c7

Browse files
committed
Add parameter documentation
1 parent c091f7e commit c5f44c7

28 files changed

+363
-0
lines changed

rtl/axis_adapter.v

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,31 @@ THE SOFTWARE.
3131
*/
3232
module axis_adapter #
3333
(
34+
// Width of input AXI stream interface in bits
3435
parameter S_DATA_WIDTH = 8,
36+
// Propagate tkeep signal on input interface
37+
// If disabled, tkeep assumed to be 1'b1
3538
parameter S_KEEP_ENABLE = (S_DATA_WIDTH>8),
39+
// tkeep signal width (words per cycle) on input interface
3640
parameter S_KEEP_WIDTH = (S_DATA_WIDTH/8),
41+
// Width of output AXI stream interface in bits
3742
parameter M_DATA_WIDTH = 8,
43+
// Propagate tkeep signal on output interface
44+
// If disabled, tkeep assumed to be 1'b1
3845
parameter M_KEEP_ENABLE = (M_DATA_WIDTH>8),
46+
// tkeep signal width (words per cycle) on output interface
3947
parameter M_KEEP_WIDTH = (M_DATA_WIDTH/8),
48+
// Propagate tid signal
4049
parameter ID_ENABLE = 0,
50+
// tid signal width
4151
parameter ID_WIDTH = 8,
52+
// Propagate tdest signal
4253
parameter DEST_ENABLE = 0,
54+
// tdest signal width
4355
parameter DEST_WIDTH = 8,
56+
// Propagate tuser signal
4457
parameter USER_ENABLE = 1,
58+
// tuser signal width
4559
parameter USER_WIDTH = 1
4660
)
4761
(

rtl/axis_arb_mux.v

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,25 @@ THE SOFTWARE.
3131
*/
3232
module axis_arb_mux #
3333
(
34+
// Number of AXI stream inputs
3435
parameter S_COUNT = 4,
36+
// Width of AXI stream interfaces in bits
3537
parameter DATA_WIDTH = 8,
38+
// Propagate tkeep signal
3639
parameter KEEP_ENABLE = (DATA_WIDTH>8),
40+
// tkeep signal width (words per cycle)
3741
parameter KEEP_WIDTH = (DATA_WIDTH/8),
42+
// Propagate tid signal
3843
parameter ID_ENABLE = 0,
44+
// tid signal width
3945
parameter ID_WIDTH = 8,
46+
// Propagate tdest signal
4047
parameter DEST_ENABLE = 0,
48+
// tdest signal width
4149
parameter DEST_WIDTH = 8,
50+
// Propagate tuser signal
4251
parameter USER_ENABLE = 1,
52+
// tuser signal width
4353
parameter USER_WIDTH = 1,
4454
// arbitration type: "PRIORITY" or "ROUND_ROBIN"
4555
parameter ARB_TYPE = "PRIORITY",

rtl/axis_arb_mux_wrap.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,23 @@ def generate(ports=4, name=None, output=None):
7373
*/
7474
module {{name}} #
7575
(
76+
// Width of AXI stream interfaces in bits
7677
parameter DATA_WIDTH = 8,
78+
// Propagate tkeep signal
7779
parameter KEEP_ENABLE = (DATA_WIDTH>8),
80+
// tkeep signal width (words per cycle)
7881
parameter KEEP_WIDTH = (DATA_WIDTH/8),
82+
// Propagate tid signal
7983
parameter ID_ENABLE = 0,
84+
// tid signal width
8085
parameter ID_WIDTH = 8,
86+
// Propagate tdest signal
8187
parameter DEST_ENABLE = 0,
88+
// tdest signal width
8289
parameter DEST_WIDTH = 8,
90+
// Propagate tuser signal
8391
parameter USER_ENABLE = 1,
92+
// tuser signal width
8493
parameter USER_WIDTH = 1,
8594
// arbitration type: "PRIORITY" or "ROUND_ROBIN"
8695
parameter ARB_TYPE = "PRIORITY",

rtl/axis_async_fifo.v

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,45 @@ THE SOFTWARE.
3131
*/
3232
module axis_async_fifo #
3333
(
34+
// FIFO depth in words
35+
// KEEP_WIDTH words per cycle if KEEP_ENABLE set
36+
// Rounded up to nearest power of 2 cycles
3437
parameter DEPTH = 4096,
38+
// Width of AXI stream interfaces in bits
3539
parameter DATA_WIDTH = 8,
40+
// Propagate tkeep signal
41+
// If disabled, tkeep assumed to be 1'b1
3642
parameter KEEP_ENABLE = (DATA_WIDTH>8),
43+
// tkeep signal width (words per cycle)
3744
parameter KEEP_WIDTH = (DATA_WIDTH/8),
45+
// Propagate tlast signal
3846
parameter LAST_ENABLE = 1,
47+
// Propagate tid signal
3948
parameter ID_ENABLE = 0,
49+
// tid signal width
4050
parameter ID_WIDTH = 8,
51+
// Propagate tdest signal
4152
parameter DEST_ENABLE = 0,
53+
// tdest signal width
4254
parameter DEST_WIDTH = 8,
55+
// Propagate tuser signal
4356
parameter USER_ENABLE = 1,
57+
// tuser signal width
4458
parameter USER_WIDTH = 1,
59+
// Frame FIFO mode - operate on frames instead of cycles
60+
// When set, m_axis_tvalid will not be deasserted within a frame
61+
// Requires LAST_ENABLE set
4562
parameter FRAME_FIFO = 0,
63+
// tuser value for bad frame marker
4664
parameter USER_BAD_FRAME_VALUE = 1'b1,
65+
// tuser mask for bad frame marker
4766
parameter USER_BAD_FRAME_MASK = 1'b1,
67+
// Drop frames marked bad
68+
// Requires FRAME_FIFO set
4869
parameter DROP_BAD_FRAME = 0,
70+
// Drop incoming frames when full
71+
// When set, s_axis_tready is always asserted
72+
// Requires FRAME_FIFO set
4973
parameter DROP_WHEN_FULL = 0
5074
)
5175
(

rtl/axis_async_fifo_adapter.v

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,23 +31,50 @@ THE SOFTWARE.
3131
*/
3232
module axis_async_fifo_adapter #
3333
(
34+
// FIFO depth in words
35+
// KEEP_WIDTH words per cycle if KEEP_ENABLE set
36+
// Rounded up to nearest power of 2 cycles
3437
parameter DEPTH = 4096,
38+
// Width of input AXI stream interface in bits
3539
parameter S_DATA_WIDTH = 8,
40+
// Propagate tkeep signal on input interface
41+
// If disabled, tkeep assumed to be 1'b1
3642
parameter S_KEEP_ENABLE = (S_DATA_WIDTH>8),
43+
// tkeep signal width (words per cycle) on input interface
3744
parameter S_KEEP_WIDTH = (S_DATA_WIDTH/8),
45+
// Width of output AXI stream interface in bits
3846
parameter M_DATA_WIDTH = 8,
47+
// Propagate tkeep signal on output interface
48+
// If disabled, tkeep assumed to be 1'b1
3949
parameter M_KEEP_ENABLE = (M_DATA_WIDTH>8),
50+
// tkeep signal width (words per cycle) on output interface
4051
parameter M_KEEP_WIDTH = (M_DATA_WIDTH/8),
52+
// Propagate tid signal
4153
parameter ID_ENABLE = 0,
54+
// tid signal width
4255
parameter ID_WIDTH = 8,
56+
// Propagate tdest signal
4357
parameter DEST_ENABLE = 0,
58+
// tdest signal width
4459
parameter DEST_WIDTH = 8,
60+
// Propagate tuser signal
4561
parameter USER_ENABLE = 1,
62+
// tuser signal width
4663
parameter USER_WIDTH = 1,
64+
// Frame FIFO mode - operate on frames instead of cycles
65+
// When set, m_axis_tvalid will not be deasserted within a frame
66+
// Requires LAST_ENABLE set
4767
parameter FRAME_FIFO = 0,
68+
// tuser value for bad frame marker
4869
parameter USER_BAD_FRAME_VALUE = 1'b1,
70+
// tuser mask for bad frame marker
4971
parameter USER_BAD_FRAME_MASK = 1'b1,
72+
// Drop frames marked bad
73+
// Requires FRAME_FIFO set
5074
parameter DROP_BAD_FRAME = 0,
75+
// Drop incoming frames when full
76+
// When set, s_axis_tready is always asserted
77+
// Requires FRAME_FIFO set
5178
parameter DROP_WHEN_FULL = 0
5279
)
5380
(

rtl/axis_broadcast.v

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,27 @@ THE SOFTWARE.
3131
*/
3232
module axis_broadcast #
3333
(
34+
// Number of AXI stream outputs
3435
parameter M_COUNT = 4,
36+
// Width of AXI stream interfaces in bits
3537
parameter DATA_WIDTH = 8,
38+
// Propagate tkeep signal
3639
parameter KEEP_ENABLE = (DATA_WIDTH>8),
40+
// tkeep signal width (words per cycle)
3741
parameter KEEP_WIDTH = (DATA_WIDTH/8),
42+
// Propagate tlast signal
3843
parameter LAST_ENABLE = 1,
44+
// Propagate tid signal
3945
parameter ID_ENABLE = 0,
46+
// tid signal width
4047
parameter ID_WIDTH = 8,
48+
// Propagate tdest signal
4149
parameter DEST_ENABLE = 0,
50+
// tdest signal width
4251
parameter DEST_WIDTH = 8,
52+
// Propagate tuser signal
4353
parameter USER_ENABLE = 1,
54+
// tuser signal width
4455
parameter USER_WIDTH = 1
4556
)
4657
(

rtl/axis_crosspoint.v

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,29 @@ THE SOFTWARE.
3131
*/
3232
module axis_crosspoint #
3333
(
34+
// Number of AXI stream inputs
3435
parameter S_COUNT = 4,
36+
// Number of AXI stream outputs
3537
parameter M_COUNT = 4,
38+
// Width of AXI stream interfaces in bits
3639
parameter DATA_WIDTH = 8,
40+
// Propagate tkeep signal
3741
parameter KEEP_ENABLE = (DATA_WIDTH>8),
42+
// tkeep signal width (words per cycle)
3843
parameter KEEP_WIDTH = (DATA_WIDTH/8),
44+
// Propagate tlast signal
3945
parameter LAST_ENABLE = 1,
46+
// Propagate tid signal
4047
parameter ID_ENABLE = 0,
48+
// tid signal width
4149
parameter ID_WIDTH = 8,
50+
// Propagate tdest signal
4251
parameter DEST_ENABLE = 0,
52+
// tdest signal width
4353
parameter DEST_WIDTH = 8,
54+
// Propagate tuser signal
4455
parameter USER_ENABLE = 1,
56+
// tuser signal width
4557
parameter USER_WIDTH = 1
4658
)
4759
(

rtl/axis_crosspoint_wrap.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,25 @@ def generate(ports=4, name=None, output=None):
7979
*/
8080
module {{name}} #
8181
(
82+
// Width of AXI stream interfaces in bits
8283
parameter DATA_WIDTH = 8,
84+
// Propagate tkeep signal
8385
parameter KEEP_ENABLE = (DATA_WIDTH>8),
86+
// tkeep signal width (words per cycle)
8487
parameter KEEP_WIDTH = (DATA_WIDTH/8),
88+
// Propagate tlast signal
8589
parameter LAST_ENABLE = 1,
90+
// Propagate tid signal
8691
parameter ID_ENABLE = 0,
92+
// tid signal width
8793
parameter ID_WIDTH = 8,
94+
// Propagate tdest signal
8895
parameter DEST_ENABLE = 0,
96+
// tdest signal width
8997
parameter DEST_WIDTH = 8,
98+
// Propagate tuser signal
9099
parameter USER_ENABLE = 1,
100+
// tuser signal width
91101
parameter USER_WIDTH = 1
92102
)
93103
(

rtl/axis_demux.v

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,25 @@ THE SOFTWARE.
3131
*/
3232
module axis_demux #
3333
(
34+
// Number of AXI stream outputs
3435
parameter M_COUNT = 4,
36+
// Width of AXI stream interfaces in bits
3537
parameter DATA_WIDTH = 8,
38+
// Propagate tkeep signal
3639
parameter KEEP_ENABLE = (DATA_WIDTH>8),
40+
// tkeep signal width (words per cycle)
3741
parameter KEEP_WIDTH = (DATA_WIDTH/8),
42+
// Propagate tid signal
3843
parameter ID_ENABLE = 0,
44+
// tid signal width
3945
parameter ID_WIDTH = 8,
46+
// Propagate tdest signal
4047
parameter DEST_ENABLE = 0,
48+
// tdest signal width
4149
parameter DEST_WIDTH = 8,
50+
// Propagate tuser signal
4251
parameter USER_ENABLE = 1,
52+
// tuser signal width
4353
parameter USER_WIDTH = 1
4454
)
4555
(

rtl/axis_demux_wrap.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,23 @@ def generate(ports=4, name=None, output=None):
7373
*/
7474
module {{name}} #
7575
(
76+
// Width of AXI stream interfaces in bits
7677
parameter DATA_WIDTH = 8,
78+
// Propagate tkeep signal
7779
parameter KEEP_ENABLE = (DATA_WIDTH>8),
80+
// tkeep signal width (words per cycle)
7881
parameter KEEP_WIDTH = (DATA_WIDTH/8),
82+
// Propagate tid signal
7983
parameter ID_ENABLE = 0,
84+
// tid signal width
8085
parameter ID_WIDTH = 8,
86+
// Propagate tdest signal
8187
parameter DEST_ENABLE = 0,
88+
// tdest signal width
8289
parameter DEST_WIDTH = 8,
90+
// Propagate tuser signal
8391
parameter USER_ENABLE = 1,
92+
// tuser signal width
8493
parameter USER_WIDTH = 1
8594
)
8695
(

rtl/axis_fifo.v

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,45 @@ THE SOFTWARE.
3131
*/
3232
module axis_fifo #
3333
(
34+
// FIFO depth in words
35+
// KEEP_WIDTH words per cycle if KEEP_ENABLE set
36+
// Rounded up to nearest power of 2 cycles
3437
parameter DEPTH = 4096,
38+
// Width of AXI stream interfaces in bits
3539
parameter DATA_WIDTH = 8,
40+
// Propagate tkeep signal
41+
// If disabled, tkeep assumed to be 1'b1
3642
parameter KEEP_ENABLE = (DATA_WIDTH>8),
43+
// tkeep signal width (words per cycle)
3744
parameter KEEP_WIDTH = (DATA_WIDTH/8),
45+
// Propagate tlast signal
3846
parameter LAST_ENABLE = 1,
47+
// Propagate tid signal
3948
parameter ID_ENABLE = 0,
49+
// tid signal width
4050
parameter ID_WIDTH = 8,
51+
// Propagate tdest signal
4152
parameter DEST_ENABLE = 0,
53+
// tdest signal width
4254
parameter DEST_WIDTH = 8,
55+
// Propagate tuser signal
4356
parameter USER_ENABLE = 1,
57+
// tuser signal width
4458
parameter USER_WIDTH = 1,
59+
// Frame FIFO mode - operate on frames instead of cycles
60+
// When set, m_axis_tvalid will not be deasserted within a frame
61+
// Requires LAST_ENABLE set
4562
parameter FRAME_FIFO = 0,
63+
// tuser value for bad frame marker
4664
parameter USER_BAD_FRAME_VALUE = 1'b1,
65+
// tuser mask for bad frame marker
4766
parameter USER_BAD_FRAME_MASK = 1'b1,
67+
// Drop frames marked bad
68+
// Requires FRAME_FIFO set
4869
parameter DROP_BAD_FRAME = 0,
70+
// Drop incoming frames when full
71+
// When set, s_axis_tready is always asserted
72+
// Requires FRAME_FIFO set
4973
parameter DROP_WHEN_FULL = 0
5074
)
5175
(

0 commit comments

Comments
 (0)