Giter VIP home page Giter VIP logo

hwtlib's Introduction

hwtLib

CircleCI PyPI version Coverage Status Documentation Status Python version Join the chat at https://gitter.im/hwt-community/community

hwtLib is the library of hardware components writen using hwt library. Any component can be exported as Xilinx Vivado (IP-exact) or Quartus IPcore using IpPackager or as raw Verilog/VHDL/SystemC code and constraints by to_rtl() function. Target language is specified by keyword parameter serializer.

Content

For example there is a component AxiLiteEndpoint, wich is configured using c-like data type description and it generates a address decoders and convertors to other intefaces if requested. Another example is AxiS_frameParser, which is configured in same way and performs an extraction of the data fields from an input stream. Hwt type system does contains all c-like and SystemVerilog-like types but in addition it allows for better specification of padding and allignment and has an explicit data type for streams. This allows AxiS_frameParser to be easily configured to change alignemnt of the stream, cut/split/replace part of the steam with an easy to read HLS-like description.

Verifications are write in UVM like style and as hwt based design are actually a graph we can easily analyse them. This is every usefull as it allows us to generate most of the test environment automatically in a user controlled and predictable way and write mostly only a test scenario. For example there is no need to build bus transactions manually as AddressSpaceProbe can discover the mapped address space (for any interface) and we can set register values using a proxy as if it was a normal value. This means that you can write a verification which will have a component with arbitrary bus/address space and it will work as long as you keep the names of the registers the same.

Clock frequencies and target chips usually does not matter but if componet generates constraints it surely needs a correct clock period to generate them correctly.

Also note that the code of the components should be shared if @serializeParamsUniq is used, the design for largest FPGAs takes 5s to generate. The verification should be also fast (take look at travis build) if this is not your case you are probably doing something wrong.

  • abstract - abstract classes for component classes like bus endpoint, etc
  • amba - AXI interfaces and components for them (AXI3/4 DMAs, interconnects, Axi-stream components, Axi4Lite address decoders etc...)
  • avalon - same thing as amba just for Avalon interfaces (AvalonST, AvalonMM, ... and components for them)
  • cesnet - components and interfaces specific to Cesnet designs
  • clocking - various generic PLLs, timer generators etc.
  • examples - demonstrative examples of hwt functionality
  • handshaked - components for handshaked interfaces (FIFO, AsyncFifo, Resizer, interconnects, Register, ...)
  • interfaces - various interfaces which does not have it's package yet
  • logic - various components like CRC generator, gray counter, decoders-encoders ...
  • mem - various memories (BRAM, ROM, FIFO, Async FIFO, CAM, LUT, ...)
  • peripheral - various peripheral interfaces and components (I2C, MDIO, SPI, UART, USB, Ethernet, ...)
  • sim - simulation utils
  • structManipulators - DMAs for specific data structures
  • tests - tests which are not related to another components
  • types - deffinitions of common types (uint32_t, ipv6_t, udp_t, ...)
  • xilinx - components, primitives and interfaces specific to Xilinx based designs (IPIF, LocalLink, ...)

If you see any problem/do not underestand something/do miss something open the github issue as others may step uppon same problem sooner or later.

Installation

# from PYPI (latest release)
sudo pip3 install hwtLib

# or from git (latest)
sudo pip3 install -r https://raw.githubusercontent.com/Nic30/hwtLib/master/doc/requirements.txt git+git://github.com/Nic30/hwtLib#egg=hwtLib --upgrade --no-cache

Repositories with opensource HW:

hwtlib's People

Contributors

nic30 avatar optical-o 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.