The repository is structured into several directories, each with a distinct role:
docs: Contains all the documentation files.
inc: Houses include files, which are incorporated into other SystemVerilog files using the `include directive. These files, which may or may not be part of the RTL, are further categorized into folders based on their protocol or use case. Note that this does not include certain include files located in the Testbench directory.
intf: Stores SystemVerilog interfaces, which are recommended solely for verification purposes and not for RTL design. We favor structured IOs for requests and responses to facilitate connections, as opposed to using interfaces.
rtl: This is where all the design source files are located.
sub: Contains all git repository submodules. Please note the submodule files that do not belong to Squared-Studio sv-genesis files structure are not compiled automatically. They must be manually added in the compile order within the config/*/xvlog for each Testbench (TB). config/*/xvlog file is auto-generated next to the TB top file.
tb: All the Testbenches (TBs) are stored here. Each TB should be in a separate directory that corresponds to the name of the Device Under Test (DUT) module, suffixed with _tb. The Testbenches are utilized to verify the design functionality under various scenarios.
To know how to use different commands on this repo, type make help or just make at the repo root and further details with be printed on the terminal.