Skip to content

Commit 29474de

Browse files
Add files via upload
1 parent 126e889 commit 29474de

File tree

2 files changed

+65
-0
lines changed

2 files changed

+65
-0
lines changed

LICENSE

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
The Project Zipline source code is licensed under MIT.
2+
The Project XP10 Specifications are licensed under the Open Web Foundation Final
3+
Specification Agreement (OWFa 1.0 - https://www.opencompute.org/documents/owfa10-1).
4+
5+
Project Zipline
6+
7+
The MIT License (MIT)
8+
9+
Copyright (c) 2019 Microsoft Corporation. All rights reserved.
10+
Copyright (c) 2018 Broadcom Inc. All rights reserved.
11+
12+
Permission is hereby granted, free of charge, to any person obtaining a copy
13+
of this software and associated documentation files (the "Software"), to deal
14+
in the Software without restriction, including without limitation the rights
15+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16+
copies of the Software, and to permit persons to whom the Software is
17+
furnished to do so, subject to the following conditions:
18+
19+
The above copyright notice and this permission notice shall be included in
20+
all copies or substantial portions of the Software.
21+
22+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
28+
THE SOFTWARE.
29+

README.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Project Zipline
2+
3+
## Introduction
4+
5+
Project Zipline is a program to accelerate innovation in lossless compression. With this release Microsoft is making two contributions to the OCP open source community:
6+
7+
1. A new compression format called XP10 which is tailored for modern cloud datasets.
8+
9+
2. An RTL implementation which accelerates Huffman Encoding for XP10, Zlib and Gzip.
10+
11+
Future releases will include additional RTL, an RTL test harness and an XP10 SW library.
12+
13+
Project Zipline is open-sourced under the MIT License, see the LICENSE file.
14+
15+
## Build instructions
16+
17+
Instructions for building the RTL design of the Project Zipline / XP10 Huffman Encoder.
18+
19+
Edit the file **./build.setup** for VCS environment settings
20+
21+
Then source the file as follows:
22+
23+
**`source build.setup`**
24+
25+
Go to the huff run directory:
26+
27+
**`cd dv/huff/run`**
28+
29+
Compile the RTL into a simv executable:
30+
31+
**`make compile_rtl`**
32+
33+
Note: There is no testbench included as part of this release
34+
35+
36+

0 commit comments

Comments
 (0)