Update license header
1 file changed
tree: 5113314dc05867f936e7c35b7591399c5cf2c560
  1. .github/
  2. checks/
  3. def/
  4. docs/
  5. gds/
  6. lef/
  7. mag/
  8. maglef/
  9. openlane/
  10. signoff/
  11. spi/
  12. verilog/
  13. .gitignore
  14. .gitmodules
  15. info.yaml
  16. LICENSE
  17. Makefile
  18. README.md
README.md

YONGA-LZ4 Decoder

License UPRJ_CI Caravel Build

Table of contents

Overview

YONGA-LZ4 Decoder is an implementation of the decoder of the popular LZ4 compression algorithm.

Setup

export PDK_ROOT=<pdk-installation-path>
export OPENLANE_ROOT=<openlane-installation-path>
cd $UPRJ_ROOT
export CARAVEL_ROOT=$(pwd)/caravel
make install

Running Simulation

WISHBONE Test

  • This test is meant to verify that we can read and write to the YONGA-LZ4 Decoder through the WISHBONE port. The firmware first writes a compressed data stream to input FIFO of the YONGA-LZ4 Decoder, then reads decoded data stream from output FIFO of the YONGA-LZ4 Decoder.

To run RTL simulation,

cd $UPRJ_ROOT
make verify-wb_test

Hardening the User Project Macro using OpenLANE

# Run openlane to harden user_proj_example
make user_proj_example
# Run openlane to harden user_project_wrapper
make user_project_wrapper

Checklist for Open-MPW Two Submission

  • [x] The project repo adheres to the same directory structure in this repo
  • [x] The project repo contain info.yaml at the project root
  • [x] Top level macro is named user_project_wrapper
  • [x] Full Chip Simulation passes for RTL and GL (gate-level)
  • [x] The hardened Macros are LVS and DRC clean
  • [x] The hardened user_project_wrapper adheres to the same pin order specified at pin_order
  • [x] XOR check passes with zero total difference.
  • [x] Openlane summary reports are retained under ./signoff/

List of Contributors

In alphabetical order:

  • Abdullah Yildiz
  • Altug Somay
  • Burak Yakup Cakar
  • Muhammed Bahadir Turkoglu
  • Rifat Demircioglu