Merge branch 'kondys_fix_appender_prepender' into 'devel'

Couple of fixes/updates for components MFB_MVB_APPENDER and MFB_MVB_PREPENDER

See merge request ndk/ndk-fpga!199

Author: Stepan Friedl

comp/mfb_tools/edit/frame_appender/cocotb/prepare.sh

@@ -8,6 +8,8 @@ PKG_COCOTBEXT=$ROOT_PATH/python/cocotbext/
 python -m venv venv-appender
 source venv-appender/bin/activate
 
+source $ROOT_PATH/env.sh
+
 python -m pip install setuptools
 python -m pip install $PKG_COCOTBEXT
 

comp/mfb_tools/edit/frame_appender/mfb_mvb_appender.vhd

@@ -272,45 +272,48 @@ begin
 
     mvb_fifoxm_read(0) <= append_ends_here_reg1 and mfb_src_rdy_reg1 and TX_MFB_DST_RDY and not mvb_fifoxm_empty(0);
 
-    mfb_fifox_i : entity work.MFB_FIFOX
-    generic map(
-        REGIONS             => MFB_REGIONS    ,
-        REGION_SIZE         => MFB_REGION_SIZE,
-        BLOCK_SIZE          => MFB_BLOCK_SIZE ,
-        ITEM_WIDTH          => MFB_ITEM_WIDTH ,
-        META_WIDTH          => MFB_META_WIDTH ,
-        FIFO_DEPTH          => MFB_FIFO_DEPTH ,
-        RAM_TYPE            => "AUTO"         ,
-        DEVICE              => DEVICE         ,
-        ALMOST_FULL_OFFSET  => 0              ,
-        ALMOST_EMPTY_OFFSET => 0
-    )
-    port map(
-        CLK => CLK,
-        RST => RESET,
-
-        RX_DATA     => RX_MFB_DATA      ,
-        RX_META     => RX_MFB_META      ,
-        RX_SOF_POS  => RX_MFB_SOF_POS   ,
-        RX_EOF_POS  => RX_MFB_EOF_POS   ,
-        RX_SOF      => RX_MFB_SOF       ,
-        RX_EOF      => RX_MFB_EOF       ,
-        RX_SRC_RDY  => RX_MFB_SRC_RDY   ,
-        RX_DST_RDY  => RX_MFB_DST_RDY   ,
-
-        TX_DATA     => mfb_fifox_data   ,
-        TX_META     => mfb_fifox_meta   ,
-        TX_SOF_POS  => mfb_fifox_sof_pos,
-        TX_EOF_POS  => mfb_fifox_eof_pos,
-        TX_SOF      => mfb_fifox_sof    ,
-        TX_EOF      => mfb_fifox_eof    ,
-        TX_SRC_RDY  => mfb_fifox_src_rdy,
-        TX_DST_RDY  => mfb_fifox_dst_rdy,
-
-        FIFO_STATUS => open             ,
-        FIFO_AFULL  => open             ,
-        FIFO_AEMPTY => open
-    );
+    -- Using MFB Reconfigurator simplifies the appending logic, however, it also reduces throughput.
+    -- Hence, this is expected to be only a temporary solution.
+    -- This FIFO is left here for a future full-throughput solution (Hint: use also Frame Masker?).
+    -- mfb_fifox_i : entity work.MFB_FIFOX
+    -- generic map(
+    --     REGIONS             => MFB_REGIONS    ,
+    --     REGION_SIZE         => MFB_REGION_SIZE,
+    --     BLOCK_SIZE          => MFB_BLOCK_SIZE ,
+    --     ITEM_WIDTH          => MFB_ITEM_WIDTH ,
+    --     META_WIDTH          => MFB_META_WIDTH ,
+    --     FIFO_DEPTH          => MFB_FIFO_DEPTH ,
+    --     RAM_TYPE            => "AUTO"         ,
+    --     DEVICE              => DEVICE         ,
+    --     ALMOST_FULL_OFFSET  => 0              ,
+    --     ALMOST_EMPTY_OFFSET => 0
+    -- )
+    -- port map(
+    --     CLK => CLK,
+    --     RST => RESET,
+
+    --     RX_DATA     => RX_MFB_DATA      ,
+    --     RX_META     => RX_MFB_META      ,
+    --     RX_SOF_POS  => RX_MFB_SOF_POS   ,
+    --     RX_EOF_POS  => RX_MFB_EOF_POS   ,
+    --     RX_SOF      => RX_MFB_SOF       ,
+    --     RX_EOF      => RX_MFB_EOF       ,
+    --     RX_SRC_RDY  => RX_MFB_SRC_RDY   ,
+    --     RX_DST_RDY  => RX_MFB_DST_RDY   ,
+
+    --     TX_DATA     => mfb_fifox_data   ,
+    --     TX_META     => mfb_fifox_meta   ,
+    --     TX_SOF_POS  => mfb_fifox_sof_pos,
+    --     TX_EOF_POS  => mfb_fifox_eof_pos,
+    --     TX_SOF      => mfb_fifox_sof    ,
+    --     TX_EOF      => mfb_fifox_eof    ,
+    --     TX_SRC_RDY  => mfb_fifox_src_rdy,
+    --     TX_DST_RDY  => mfb_fifox_dst_rdy,
+
+    --     FIFO_STATUS => open             ,
+    --     FIFO_AFULL  => open             ,
+    --     FIFO_AEMPTY => open
+    -- );
 
     -- =======================================================================
     -- Logic to serch for new EOF(POS) and using it to create a vector
@@ -329,7 +332,7 @@ begin
         TX_ITEM_WIDTH         => MFB_ITEM_WIDTH                ,
         META_WIDTH            => MFB_META_WIDTH                ,
         META_MODE             => 0                             ,
-        FIFO_SIZE             => 2                             ,
+        FIFO_SIZE             => MFB_FIFO_DEPTH                ,
         FRAMES_OVER_TX_BLOCK  => 0                             ,
         FRAMES_OVER_TX_REGION => 0                             ,
         DEVICE                => DEVICE
@@ -338,14 +341,14 @@ begin
         CLK                 => CLK                  ,
         RESET               => RESET                ,
 
-        RX_DATA             => mfb_fifox_data       ,
-        RX_META             => mfb_fifox_meta       ,
-        RX_SOF_POS          => mfb_fifox_sof_pos    ,
-        RX_EOF_POS          => mfb_fifox_eof_pos    ,
-        RX_SOF              => mfb_fifox_sof        ,
-        RX_EOF              => mfb_fifox_eof        ,
-        RX_SRC_RDY          => mfb_fifox_src_rdy    ,
-        RX_DST_RDY          => mfb_fifox_dst_rdy    ,
+        RX_DATA             => RX_MFB_DATA          ,
+        RX_META             => RX_MFB_META          ,
+        RX_SOF_POS          => RX_MFB_SOF_POS       ,
+        RX_EOF_POS          => RX_MFB_EOF_POS       ,
+        RX_SOF              => RX_MFB_SOF           ,
+        RX_EOF              => RX_MFB_EOF           ,
+        RX_SRC_RDY          => RX_MFB_SRC_RDY       ,
+        RX_DST_RDY          => RX_MFB_DST_RDY       ,
 
         TX_DATA             => mfb_reconf_tx_data   ,
         TX_META             => mfb_reconf_tx_meta   ,

comp/mfb_tools/edit/frame_prepender/cocotb/prepare.sh

@@ -8,6 +8,8 @@ PKG_COCOTBEXT=$ROOT_PATH/python/cocotbext/
 python -m venv venv-prepender
 source venv-prepender/bin/activate
 
+source $ROOT_PATH/env.sh
+
 python -m pip install setuptools
 python -m pip install $PKG_COCOTBEXT
 

comp/mfb_tools/edit/frame_prepender/mfb_mvb_prepender.vhd

@@ -167,12 +167,12 @@ architecture FULL of MFB_MVB_PREPENDER is
     signal frlen_tx_eof                 : std_logic_vector(MFB_REGIONS-1 downto 0);
     signal frlen_tx_src_rdy             : std_logic;
     signal frlen_tx_dst_rdy             : std_logic;
-    signal frlen_tx_frlen               : std_logic_vector(MFB_REGIONS*log2(PKT_MTU_IN)-1 downto 0);
+    signal frlen_tx_frlen               : std_logic_vector(MFB_REGIONS*log2(PKT_MTU_IN+1)-1 downto 0);
 
-    signal MVB_ITEM_SIZE_items_arr      : u_array_t       (MFB_REGIONS-1 downto 0)(log2(PKT_MTU_IN)-1 downto 0);
+    signal MVB_ITEM_SIZE_items_arr      : u_array_t       (MFB_REGIONS-1 downto 0)(log2(PKT_MTU_IN+1)-1 downto 0);
     signal extd_rx_mvb_meta             : std_logic_vector(MFB_REGIONS*MFB_META_WIDTH-1 downto 0);
-    signal extd_rx_mvb_frlen            : std_logic_vector(MFB_REGIONS*log2(PKT_MTU_IN)-1 downto 0);
-    signal extd_rx_mvb_ext_size         : std_logic_vector(MFB_REGIONS*log2(PKT_MTU_IN)-1 downto 0);
+    signal extd_rx_mvb_frlen            : std_logic_vector(MFB_REGIONS*log2(PKT_MTU_IN+1)-1 downto 0);
+    signal extd_rx_mvb_ext_size         : std_logic_vector(MFB_REGIONS*log2(PKT_MTU_IN+1)-1 downto 0);
     signal extd_rx_mvb_vld              : std_logic_vector(MFB_REGIONS-1 downto 0);
     signal extd_rx_mvb_src_rdy          : std_logic;
     signal extd_rx_mvb_dst_rdy          : std_logic;
@@ -317,14 +317,14 @@ begin
     -- Frame extender expects the length of each frame
     mfb_frame_length_i : entity work.MFB_FRAME_LNG
     generic map(
-        REGIONS        => MFB_REGIONS     ,
-        REGION_SIZE    => MFB_REGION_SIZE ,
-        BLOCK_SIZE     => MFB_BLOCK_SIZE  ,
-        ITEM_WIDTH     => MFB_ITEM_WIDTH  ,
-        META_WIDTH     => MFB_META_WIDTH  ,
-        LNG_WIDTH      => log2(PKT_MTU_IN),
-        REG_BITMAP     => "111"           ,
-        SATURATION     => False           ,
+        REGIONS        => MFB_REGIONS       ,
+        REGION_SIZE    => MFB_REGION_SIZE   ,
+        BLOCK_SIZE     => MFB_BLOCK_SIZE    ,
+        ITEM_WIDTH     => MFB_ITEM_WIDTH    ,
+        META_WIDTH     => MFB_META_WIDTH    ,
+        LNG_WIDTH      => log2(PKT_MTU_IN+1),
+        REG_BITMAP     => "111"             ,
+        SATURATION     => False             ,
         IMPLEMENTATION => "parallel"
     )
     port map(
@@ -355,7 +355,7 @@ begin
     frlen_tx_dst_rdy <= extd_rx_mvb_dst_rdy and extd_rx_mfb_dst_rdy;
 
     -- Frame Extender's RX_MVB_EXT_SIZE generic must be in Items
-    MVB_ITEM_SIZE_items_arr <= (others => to_unsigned(MVB_ITEM_SIZE*MFB_BLOCK_SIZE, log2(PKT_MTU_IN)));
+    MVB_ITEM_SIZE_items_arr <= (others => to_unsigned(MVB_ITEM_SIZE*MFB_BLOCK_SIZE, log2(PKT_MTU_IN+1)));
 
     extd_rx_mvb_meta     <= (others => '0'); -- MFB metadata could be added here (must update src_ and dst_rdy)
     extd_rx_mvb_frlen    <= frlen_tx_frlen;
@@ -378,7 +378,7 @@ begin
         MFB_BLOCK_SIZE  => MFB_BLOCK_SIZE ,
         MFB_ITEM_WIDTH  => MFB_ITEM_WIDTH ,
         PKT_MTU         => PKT_MTU_IN     ,
-        MVB_FIFO_DEPTH  => 4              , -- frame lengths come at the end of a frame (=> shallow FIFO)
+        MVB_FIFO_DEPTH  => 512            ,
         MFB_FIFO_DEPTH  => MFB_FIFO_DEPTH ,
         USERMETA_WIDTH  => 0,
         DEVICE          => DEVICE

comp/mfb_tools/edit/frame_prepender/readme.rst

@@ -1,6 +1,6 @@
 .. _mfb_mvb_prepender:
 
 MFB MVB Prepender
-----------------
+-----------------
 
 .. vhdl:autoentity:: MFB_MVB_PREPENDER