Skip to content

Commit

Permalink
docs(mfb-tools): improve the documentation of component MFB_USER_PACK…
Browse files Browse the repository at this point in the history
…ET_GEN
  • Loading branch information
jakubcabal committed Dec 18, 2024
1 parent 7ea7ce5 commit f841543
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions comp/mfb_tools/logic/user_packet_gen/mfb_user_packet_gen.vhd
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ use IEEE.numeric_std.all;
use work.math_pack.all;
use work.type_pack.all;

-- Component MFB_USER_PACKET_GEN allows you to generate empty MFB frames based
-- on instructions sent through the MVB interface. One instruction in the form
-- of an MVB item corresponds to one generated MFB frame. If enough instructions
-- are available, the component tries to generate MFB frames with minimal gaps
-- between MFB frames. Each generated MFB frame can be of different size within
-- the allowed range. Through MVB instructions (items), user metadata can be
-- inserted into the generated packets. The metadata are then available on the
-- MFB signal TX_META and are valid with SOF.
--
entity MFB_USER_PACKET_GEN is
generic(
-- =======================================================================
Expand Down

0 comments on commit f841543

Please sign in to comment.