GithubHelp home page GithubHelp logo

kev-j / ip-contributions Goto Github PK

View Code? Open in Web Editor NEW

This project forked from freechipsproject/ip-contributions

0.0 0.0 0.0 153 KB

For contributions of Chisel IP to the chisel community.

Scala 100.00%

ip-contributions's Introduction

Chisel IP Contributions

If you are here you are hopefully considering contributing some useful chisel modules to the community. This is the place to do it.

Current Contributions

Package Type Developer Descpription
BitonicSorter internal Steve Burns A combinational sort generator for arbitrarily typed Vectors
IterativeCordic internal Harrison Liew An iterative Cordic implementation
aes_chisel maven Sergiu Mosanu Implementation of the Advanced Encryption Standard (AES)
How to get it
uart internal Martin Schoeberl A basic serial port (UART)
fifo internal Martin Schoeberl Variations of FIFO queues
spi2wb maven Fabien Marteau Drive a wishbone master bus with SPI
dclib internal Guy Hutchison Utility components for DecoupledIO interfaces
ecc internal Guy Hutchison Hamming Error-Correcting code modules
iir internal Kevin Joly Infinite Impulse Response filter module
fir internal Kevin Joly Finite Impulse Response filter module

Using ip-contributions

ip-contributions is published with Maven central and to use it simply add following line to your build.sbt

libraryDependencies += "edu.berkeley.cs" % "ip-contributions" % "0.5.1"

Getting Started

To begin with you should have some working Chisel code. Adding it is designed to be as simple as possible. There are two main ways to go about this.

  1. Creating a new package here in the src/main/scala and src/test/scala and place your circuit and it's unit tests in those respective directories. More about this
  2. Create an external repository and distribute it via the Maven, let us review it and provides links to it.

External Contributions


aes_chisel

aes_chisel's goals are to:

  • Implement an open-source, transparent, secure encryption module in Chisel
  • Equip developers with ready-to-use, efficient, parameterizable, encryption macros for RISC-V systems
  • Compare performance and resource utilization of generated HDL with pure Verilog and Vivado HLS
  • Compare code size with Verilog, Python, C++ and Vivado HLS as a index of development productivity

spi2wb

spi2wb's goals are to:

  • Drive a wishbone master bus with SPI
  • Be easy to integrate in little FPGA
  • Be used with simple computer and USB tools like BusPirate
  • Avoid usage of softcore under the FPGA to drive wishbone peripherals

More on Locally Provided Contributions

The Requirements

  • Code Style should reasonably follow the default style guide used by the Chisel3 project. See the chisel3 scalastyle-config
  • Unit Tests should be provided that reasonable confidence that a contribution works
  • Useful README.md should be added in your package directory with contribution specific info.
  • Licensing this code is still a WIP

Vetting

Publishing

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org/

ip-contributions's People

Contributors

hutch31 avatar schoeberl avatar chick avatar ekiwi avatar kev-j avatar martoni avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.