HLS Build System - #391
Draft
russell-slac wants to merge 13 commits into
Draft
Conversation
Contributor
|
@russell-slac Please add the SLAC license coding header to all production code files |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
HLS Build System
hlsBs. for short, aims to simplify the building of HLS projects, particularly multi-component projects. It is compatible, and the steps are interchangeable, with the native VITIS/IDE methods. This accomodates legacy projects or different styles of work.
It has two main pieces
A project file which specifies the contents of the HLS configuration file, the component naming and the auxiliary enhanced .dcp and .zip files.
A suite of commands to implement creation and management of the a) workspace, b) configuration files and components and c) running the various build steps (csim, synthesis, cosim, package, implementation and ip).
Shortcomings
Documentation for the commands is by man pages. In the near term these are adequate for command usage, but should have an overview/user manual to illustrate common usage patterns.
Documentation on how to write a project file is non-existent. Because it is more open-ended, it is challenging. Both a reference and user manual is needed.