esa-tu-darmstadt/BlueLib

BlueLib

Useful helpers for Bluespec developers.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

Over the years developing in Bluespec we came accross certain features missing from the AzureIP library. This repository contains some of the frequently used parts.

• A FIFO that counts the maximum number of entries. Useful for design space exploration.
• Network helper functions, e.g. toggle endianess in Word.
• Send out data over a AXI4 stream based network interface, e.g. Xilinx 10G Ethernet Subsystem
• Parse ethernet packets coming from such a subsystem
• Produce colorful text for testbenches

Built With

• Bluespec Compiler

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Have the bluespec compiler installed.

Installation

1. Clone the repo

git clone github.com/esa-tu-darmstadt/BlueLib.git

2. Optional: Install BlueAXI for PacketParser or PacketSender
3. Import BlueLib or a part of the packet in your Bluespec packet:

import BlueLib :: *;

4. Add the src directory to your bsc library path during compilation:

bsc ${OTHER_FLAGS} -p path/to/BlueLib/src

Usage

printColorTimed(RED, $format("Hello World!"));

(0) Hello World!

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Embedded Systems and Applications Group - https://www.esa.informatik.tu-darmstadt.de

Project Link: https://github.com/esa-tu-darmstadt/BlueLib