Skip to content

W
White Rabbit core collection
Commit d774bdca authored by Maciej Lipinski's avatar Maciej Lipinski Committed by Grzegorz Daniluk
Browse files
Options

[streamers/review] added g_tx_buffer_size to tx_streamer 

- made the tx and rx streamer symmetric in terms of seeting the
  buffer size, now both have proper generics
- added proper descriptions
- added sanity checks for generics
- set (hopefully) more sensible defults
parent f9f5e80f
Hide whitespace changes
Inline Side-by-side
Showing with 51 additions and 74 deletions
modules/wr_streamers/streamers_pkg.vhd
View file @ d774bdca
......@@ -9,9 +9,10 @@ package streamers_pkg is
component xtx_streamer
generic (
g_data_width : integer := 32;
g_tx_threshold : integer := 16;
g_tx_max_words_per_frame : integer := 128;
g_tx_timeout : integer := 128;
g_tx_buffer_size : integer := 256;
g_tx_threshold : integer := 128;
g_tx_max_words_per_frame : integer := 256;
g_tx_timeout : integer := 1024;
g_escape_code_disable : boolean := FALSE);
port (
clk_sys_i : in std_logic;
......@@ -37,7 +38,7 @@ package streamers_pkg is
component xrx_streamer
generic (
g_data_width : integer := 32;
g_buffer_size : integer := 16;
g_buffer_size : integer := 256;
g_escape_code_disable : boolean := FALSE;
g_expected_words_number : integer := 0);
port (
......@@ -114,67 +115,22 @@ package streamers_pkg is
component xwr_transmission is
generic (
-----------------------------------------------------------------------------------------
-- Transmission (tx)
-----------------------------------------------------------------------------------------
-- Width of data words on tx_data_i.
g_tx_data_width : integer := 32;
-- Minimum number of data words in the TX buffer that will trigger transmission of an
-- Ethernet frame. Also defines the buffer size (2 * g_tx_threshold). Note
-- that in order for a frame to be transmitted, the buffer must conatain at
-- least one complete block.
g_tx_threshold : integer := 128;
-- Maximum number of data words in a single Ethernet frame. It also defines
-- the maximum block size (since blocks can't be currently split across
-- multiple frames).
g_tx_max_words_per_frame : integer := 128;
-- Transmission timeout (in clk_sys_i cycles), after which the contents
-- of TX buffer are sent regardless of the amount of data that is currently
-- stored in the buffer, so that data in the buffer does not get stuck.
--tx
g_tx_data_width : integer := 32;
g_tx_buffer_size : integer := 256;
g_tx_threshold : integer := 128;
g_tx_max_words_per_frame : integer := 256;
g_tx_timeout : integer := 1024;
-- DO NOT USE unless you know what you are doing
-- legacy stuff: the streamers initially used in Btrain did not check/insert the escape
-- code. This is justified if only one block of a known number of words is sent/expected
g_tx_escape_code_disable : boolean := FALSE;
-----------------------------------------------------------------------------------------
-- Reception (rx)
-----------------------------------------------------------------------------------------
-- Width of the data words. Must be same as in the TX streamer.
-- tx
g_rx_data_width : integer := 32;
-- Size of RX buffer, in data words.
g_rx_buffer_size : integer := 16;
-- DO NOT USE unless you know what you are doing
-- legacy stuff: the streamers that were initially used in Btrain did not check/insert
-- the escape code. This is justified if only one block of a known number of words is
-- sent/expected.
g_rx_buffer_size : integer := 256;
g_rx_escape_code_disable : boolean := FALSE;
-- DO NOT USE unless you know what you are doing
-- legacy stuff: the streamers that were initially used in Btrain accepted only a fixed
-- number of words, regardless of the frame content. If this generic is set to number
-- other than zero, only a fixed number of words is accepted.
-- In combination with the g_escape_code_disable generic set to TRUE, the behaviour of
-- the "Btrain streamers" can be recreated.
g_rx_expected_words_number : integer := 0;
-----------------------------------------------------------------------------------------
-- Statistics config
-----------------------------------------------------------------------------------------
-- width of counters: frame rx/tx/lost, block lost, counter of accumuted latency
-- (minimum 15 bits, max 32)
-- stats
g_stats_cnt_width : integer := 32;
-- width of latency accumulator (max value 64)
g_stats_acc_width : integer := 64;
-----------------------------------------------------------------------------------------
-- WB I/F configuration
-----------------------------------------------------------------------------------------
-- WB i/f
g_slave_mode : t_wishbone_interface_mode := CLASSIC;
g_slave_granularity : t_wishbone_address_granularity := BYTE
);
......
modules/wr_streamers/xrx_streamer.vhd
View file @ d774bdca
......@@ -45,7 +45,7 @@ entity xrx_streamer is
g_data_width : integer := 32;
-- Size of RX buffer, in data words.
g_buffer_size : integer := 16;
g_buffer_size : integer := 256;
-- DO NOT USE unless you know what you are doing
-- legacy stuff: the streamers that were initially used in Btrain did not check/insert
......
modules/wr_streamers/xtx_streamer.vhd
View file @ d774bdca
......@@ -38,23 +38,26 @@ entity xtx_streamer is
-- Width of data words on tx_data_i, must be multiple of 16 bits.
g_data_width : integer := 32;
-- Size of Tx buffer, in data words.
g_tx_buffer_size : integer := 256;
-- Minimum number of data words in the TX buffer that will trigger transmission of an
-- Ethernet frame. Also defines the buffer size (2 * g_tx_threshold). Note
-- that in order for a frame to be transmitted, the buffer must conatain at
-- Ethernet frame. It cannot be breater than g_tx_buffer_size; it is recommended that
-- g_tx_buffer_size = 2 * g_tx_threshold.
-- Note that in order for a frame to be transmitted, the buffer must conatain at
-- least one complete block.
g_tx_threshold : integer := 128;
-- Maximum number of data words in a single Ethernet frame. It also defines
-- the maximum block size (since blocks can't be currently split across
-- multiple frames).
g_tx_max_words_per_frame : integer := 128;
-- multiple frames). It cannot be greater than g_tx_buffer_size
g_tx_max_words_per_frame : integer := 256;
-- Transmission timeout (in clk_sys_i cycles), after which the contents
-- of TX buffer are sent regardless of the amount of data that is currently
-- stored in the buffer, so that data in the buffer does not get stuck.
g_tx_timeout : integer := 1024;
-- DO NOT USE unless you know what you are doing
-- legacy stuff: the streamers initially used in Btrain did not check/insert the escape
-- code. This is justified if only one block of a known number of words is sent/expected
......@@ -226,7 +229,19 @@ architecture rtl of xtx_streamer is
signal reset_dly : std_logic;
begin -- rtl
-------------------------------------------------------------------------------------------
-- check sanity of input generics
-------------------------------------------------------------------------------------------
assert g_tx_buffer_size >= g_tx_threshold
report "The size of the tx buffer must be greater or equal the tx threashold"
severity FAILURE;
assert g_tx_buffer_size >= g_tx_max_words_per_frame
report "The size of tx buffer must be greater or equal the max number of words in frame"
severity FAILURE;
-------------------------------------------------------------------------------------------
U_tx_crc_generator : gc_crc_gen
generic map (
g_polynomial => x"1021",
......@@ -298,11 +313,11 @@ begin -- rtl
U_TX_Buffer : generic_sync_fifo
generic map (
g_data_width => g_data_width + 1,
g_size => 2 * g_tx_threshold,
g_size => g_tx_buffer_size,
g_with_almost_full => true,
g_with_almost_empty => true,
g_almost_empty_threshold => g_tx_threshold,
g_almost_full_threshold => 2*g_tx_threshold - 2,
g_almost_full_threshold => g_tx_buffer_size - 2,
g_show_ahead => true)
port map (
rst_n_i => rst_n_i,
......
modules/wr_streamers/xwr_transmission.vhd
View file @ d774bdca
......@@ -64,16 +64,21 @@ entity xwr_transmission is
-- Width of data words on tx_data_i, must be multiple of 16 bits.
g_tx_data_width : integer := 32;
-- Size of Tx buffer, in data words.
g_tx_buffer_size : integer := 256;
-- Minimum number of data words in the TX buffer that will trigger transmission of an
-- Ethernet frame. Also defines the buffer size (2 * g_tx_threshold). Note
-- that in order for a frame to be transmitted, the buffer must conatain at
-- Ethernet frame. It cannot be breater than g_tx_buffer_size; it is recommended that
-- g_tx_buffer_size = 2 * g_tx_threshold.
-- Note that in order for a frame to be transmitted, the buffer must conatain at
-- least one complete block.ransmitted, the buffer must conatain at
-- least one complete block.
g_tx_threshold : integer := 128;
-- Maximum number of data words in a single Ethernet frame. It also defines
-- the maximum block size (since blocks can't be currently split across
-- multiple frames).
g_tx_max_words_per_frame : integer := 128;
-- multiple frames). It cannot be greater than g_tx_buffer_size
g_tx_max_words_per_frame : integer := 256;
-- Transmission timeout (in clk_sys_i cycles), after which the contents
-- of TX buffer are sent regardless of the amount of data that is currently
......@@ -97,7 +102,7 @@ entity xwr_transmission is
g_rx_data_width : integer := 32;
-- Size of RX buffer, in data words.
g_rx_buffer_size : integer := 16;
g_rx_buffer_size : integer := 256;
-- DO NOT USE unless you know what you are doing
-- legacy stuff: the streamers that were initially used in Btrain did not check/insert
......@@ -300,6 +305,7 @@ begin
U_TX: xtx_streamer
generic map(
g_data_width => g_tx_data_width,
g_tx_buffer_size => g_tx_buffer_size,
g_tx_threshold => g_tx_threshold,
g_tx_max_words_per_frame => g_tx_max_words_per_frame,
g_tx_timeout => g_tx_timeout,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment