Need help with logic?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

tymonx
173 Stars 39 Forks Apache License 2.0 420 Commits 0 Opened issues

Description

CMake, SystemVerilog and SystemC utilities for creating, building and testing RTL projects for FPGAs and ASICs.

Services available

!
?

Need anything else?

Contributors list

# 3,242
imagema...
sass-fr...
splash
pipelin...
2 commits

Logic

Language Standard Language License Apache-2.0 Build Status Join the chat at https://gitter.im/tymonx/logic

CMake, SystemVerilog and SystemC utilities for creating, building and testing RTL projects for FPGAs and ASICs.

Includes:

  • CMake utilities for rapid building and testing RTL projects
  • SystemVerilog modules for creating high quality RTL projects
  • Modern C++ framework for UVM with SystemC for creating high quality and performance efficient tests for RTL projects

Benefits

  • Quick setup
  • Cross platform, cross IDE
  • No need to create separate scripts for simulation and synthesis
  • No need to create separate scripts for different tools (Intel Quartus, Xilinx Vivado, Verilator, ModelSim, ...)
  • Supports incremental compilation, run slow vendor IP core regeneration and different simulation and synthesis tools only if input source file changes
  • Supports parallel compilation, run slow vendor IP core regeneration and different simulation and synthesis tools in parallel
  • Maintain the same file consistency between simulation and synthesis for different tools
  • Share the same HDL source code base and IP cores for various FPGA projects
  • Integration with Continuous Integration (CI) and Continuous Deployment (CD) like Jenkins, Hudson, GitLab, etc.
  • Run RTL unit tests under ctest: pass/fail, time execution, timeout, parallel execution, tests selection
  • Run the same unit tests with different parameters
  • Easy to integrate with other projects as git submodule
  • Custom UVM printers: JSON
  • Modern HDL testing library written in C++11 using UVM-SystemC
  • Support for Clang 3.5 and later
  • Support for GCC 4.9 and later

Documentation

Examples

FPGA projects that use Logic utilities for creating, building and testing:

  • Virtio - Virtio implementation

Requirements

These 3rd party tools and libraries are required. They must be installed to build logic library:

These 3rd party tools and libraries are optional. They must be installed to build and run tests:

  • Verilator - simulator, lint and coverage tool
  • GoogleTest - C++ unit test framework
  • SVUnit - SystemVerilog unit test framework

These 3rd party tools and libraries are optional:

Workspace

  • README.md - this read me file in MarkDown format
  • LICENSE - license file
  • CMakeLists.txt - CMake root script for building and testing project
  • doc - configuration files for code documentation generator
  • rtl - RTL source files
  • src - C++ source files
  • include - C++ include headers
  • tests - unit tests and verification tests in SystemC using Google Test or UVM and SystemVerilog using SVUnit
  • cmake - additional CMake scripts for building project
  • scripts - additional scripts in TCL or Python for building project

Build

Clone project repository:

git clone [email protected]:tymonx/logic.git

Change current location to project directory:

cd logic

Create build directory:

mkdir build

Change current location to build directory:

cd build

Create build scripts using CMake:

cmake ..

Build project using CMake (generic):

cmake --build . --target all

Or build project using make:

make -j`nproc`

It is much faster to recompile project using Ninja rather than Unix makefiles:

cmake -G Ninja ..
cmake --build . --target all

Documentation

To build documentation:

cmake --build . target doc

Built HTML documentation can be found in:

doc/html

To view HTML documentation, open it using web browser:

 doc/html/index.html

Tests

Run all unit tests:

ctest

Run only unit tests for AXI4-Stream:

ctest -R axi4_stream

Waveforms from unit tests run under ModelSim are stored in:

modelsim/unit_tests/

Waveforms from unit tests run under Verilator are stored in:

verilator/unit_tests/

All unit tests logs are stored in:

Testing/Temporary/LastTest.log

Verilator Coverage

Run Verilator coverage after running all tests:

cmake --build . --target verilator-coverage

Verilator analysis

Enable Verilator analysis:

add_hdl_source(
    ANALYSIS
        TRUE
)

Run Verilator analysis for

:
make verilator-analysis-

Run Verilator analysis for all HDL modules:

make verilator-analysis-all

Creating Intel FPGA Quartus project

Use

add_quartus_project()
function to create Quartus project:
add_quartus_project()

Quartus project will be created under:

quartus/

RTL analysis and elaboration in

Intel FPGA Quartus
for top level entity:
cmake --build . --target quartus-analysis-

RTL compilation in

Intel FPGA Quartus
for top level entity:
cmake --build . --target quartus-compile-

RTL analysis and elaboration in

Intel FPGA Quartus
for all top level entities:
cmake --build . --target quartus-analysis-all

RTL compilation in

Intel FPGA Quartus
for all top level entities:
cmake --build . --target quartus-compile-all

Creating Xilinx Vivado project

Use

add_vivado_project()
function to create Vivado project:
add_vivado_project()

Vivado project will be created under:

vivado/

RTL analysis and elaboration in

Xilinx Vivado
for top level entity:
cmake --build . --target vivado-analysis-

Using with other CMake projects

Change current location to another RTL project root directory:

cd 

Clone and add logic repository to RTL project as git submodule:

git submodule add [email protected]:tymonx/logic.git

Add these lines to CMakeLists.txt root file:

set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH}
    ${CMAKE_CURRENT_LIST_DIR}/logic/cmake
)

include(AddLogic)

enable_testing()

add_subdirectory(logic)

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.