# YONGA-LZ4 Decoder

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![UPRJ_CI](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml/badge.svg)](https://github.com/efabless/caravel_project_example/actions/workflows/user_project_ci.yml) [![Caravel Build](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml/badge.svg)](https://github.com/efabless/caravel_project_example/actions/workflows/caravel_build.yml)

Table of contents
=================

- [Overview](#overview)
- [Simulation](#simulation)
- [Checklist for Open-MPW Submission](#checklist-for-open-mpw-submission)

Overview
========

YONGA-LZ4 Decoder is an implementation of the decoder of the popular [LZ4](https://github.com/lz4/lz4) compression algorithm.

Simulation
========

TBA

Checklist for Open-MPW 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``
-  [ ] Full Chip Simulation passes for RTL and GL (gate-level)
-  [ ] The hardened Macros are LVS and DRC clean
-  [ ] The hardened ``user_project_wrapper`` adheres to the same pin
   order specified at [pin_order](https://github.com/efabless/caravel/blob/master/openlane/user_project_wrapper_empty/pin_order.cfg)
-  [ ] XOR check passes with zero total difference.
-  [ ] Openlane summary reports are retained under ./signoff/