miegl/b210-k7-fpga
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rfnoc: Fix FIR and AXI RAM block register documentation

Browse Source 
Original-commit: e06ff0f5e08458256bf7ffdd3d9c84c4c1046807
This commit is contained in:
Wade Fife
2020-03-05 13:49:38 -06:00
committed by Wade Fife
parent 3810f5a4d9
commit ec9eb36fb9
2 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/rfnoc/blocks/rfnoc_block_axi_ram_fifo/axi_ram_fifo_regs.vh
+8 -6
View File
@@ -14,7 +14,7 @@
localparam RAM_FIFO_ADDR_W = 7; localparam RAM_FIFO_ADDR_W = 7;
// REG_FIFO_INFO (R|W) // REG_FIFO_INFO (R)
// //
// Contains info/control bits for the FIFO. // Contains info/control bits for the FIFO.
// //
@@ -153,13 +153,15 @@ localparam REG_FIFO_PACKET_CNT = 'h28;
// [3] : Continuous mode (run until stopped). When set to 1, test will continue // [3] : Continuous mode (run until stopped). When set to 1, test will continue
// to run until Stop bit is set. // to run until Stop bit is set.
// //
// [2] : Clear the BIST counters (i.e., the TX, RX, cycle, and error counters) // [2] : Clear the BIST counters (strobe). Resets the TX, RX, cycle, and error
// counters. This bit is self-clearing.
// //
// [1] : Stop BIST (strobe). Write a 1 to this bit to stop the test that is // [1] : Stop BIST (strobe). Write a 1 to this bit to stop the test that is
// currently running // currently running. This bit is self-clearing.
// //
// [0] : Start BIST (strobe). Write a 1 to this bit to start a test using the // [0] : Start BIST (strobe). Write a 1 to this bit to start a test using the
// configured NUM_BYTES and continuous mode setting. // configured NUM_BYTES and continuous mode setting. This bit is
// self-clearing.
// //
localparam REG_BIST_CTRL = 'h30; localparam REG_BIST_CTRL = 'h30;
// //
@@ -170,7 +172,7 @@ localparam REG_BIST_STOP_POS = 1; // Strobe
localparam REG_BIST_START_POS = 0; // Strobe localparam REG_BIST_START_POS = 0; // Strobe
// REG_BIST_CLOCK_RATE (R) // REG_BIST_CLK_RATE (R)
// //
// Reports the clock rate of the BIST component in Hz. This can be used with // Reports the clock rate of the BIST component in Hz. This can be used with
// REG_BIST_CYCLE_COUNT to calculate throughput. // REG_BIST_CYCLE_COUNT to calculate throughput.
lib/rfnoc/blocks/rfnoc_block_fir_filter/rfnoc_fir_filter_regs.vh
+2 -2
View File
@@ -24,7 +24,7 @@ localparam FIR_FILTER_ADDR_W = 4;
localparam REG_FIR_NUM_COEFFS = 'h0; localparam REG_FIR_NUM_COEFFS = 'h0;
// REG_FIR_LOAD_COEFF (R) // REG_FIR_LOAD_COEFF (W)
// //
// Register for inputting the next coefficient to be loaded into the filter. To // Register for inputting the next coefficient to be loaded into the filter. To
// load a new set of filter coefficients, write NUM_COEFFS-1 coefficients to // load a new set of filter coefficients, write NUM_COEFFS-1 coefficients to
@@ -38,7 +38,7 @@ localparam REG_FIR_NUM_COEFFS = 'h0;
localparam REG_FIR_LOAD_COEFF = 'h4; localparam REG_FIR_LOAD_COEFF = 'h4;
// REG_FIR_LOAD_COEFF_LAST (R) // REG_FIR_LOAD_COEFF_LAST (W)
// //
// Register for inputting the last coefficient to be loaded into the filter. To // Register for inputting the last coefficient to be loaded into the filter. To
// load a new set of filter coefficients, write NUM_COEFFS-1 coefficients to // load a new set of filter coefficients, write NUM_COEFFS-1 coefficients to