-
Notifications
You must be signed in to change notification settings - Fork 4
Feature/add documentation #9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
80f29de
to
1abf3d6
Compare
1abf3d6
to
b26989d
Compare
b24773e
to
fc634dd
Compare
fc634dd
to
2c3ce3f
Compare
2c3ce3f
to
24b8cde
Compare
24b8cde
to
76d6cbf
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pretty general changes on the redaction of the document, also a little comment on the use of cpp terminology that might not be obvious to new cpp users (which is part of the target audience).
|
||
To develop on Xilinx FPGAs, there are a couple of workflows: | ||
|
||
1. Legacy HLS -> Vivado workflow |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe providing a section that goes through the useful resources for following the legacy HLS workflow might be handy, in a separate md file as an appendix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressing it in other PR
To develop on Xilinx FPGAs, there are a couple of workflows: | ||
|
||
1. Legacy HLS -> Vivado workflow | ||
2. Vitis Kernel workflow (newest) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe a comparison matrix can be made as a resource which can be useful if this information has to be consulted on a regular basis.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressing it in other PR
auto dma = platform->GetDataMover(kDmaAddress); | ||
``` | ||
|
||
where `kDmaAddress` is the address of the DMA instance we want to control. This is given by the design. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Define what a design means in this context.
> The IP Cores must have an AXI4-Lite port as a control port | ||
5) Get buffers to exchange data. These buffers are usually dual memory: they are mapped into host and device regions (physically contiguous). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
make examples of how these memory addresses look like, maybe making a diagram for this in the future can help illustrate this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Addressing it in other PR
docs/GettingStarted.md
Outdated
out_mem->Sync(SyncType::DeviceToHost); | ||
``` | ||
that takes any of the following values: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
any can be interpreted as a list of values, clarify that only ONE value is passed to the method but it is ONE from the list provided.
This adds the documentation files required for deployment
76d6cbf
to
2b997d5
Compare
No description provided.