Skip to content

Conversation

lleon95
Copy link
Collaborator

@lleon95 lleon95 commented Nov 18, 2023

No description provided.

@lleon95 lleon95 force-pushed the feature/add-documentation branch from 80f29de to 1abf3d6 Compare November 18, 2023 18:16
@lleon95 lleon95 force-pushed the feature/add-documentation branch from 1abf3d6 to b26989d Compare November 18, 2023 18:16
@lleon95 lleon95 force-pushed the feature/add-documentation branch from b24773e to fc634dd Compare November 20, 2023 14:55
@lleon95 lleon95 force-pushed the feature/add-documentation branch from fc634dd to 2c3ce3f Compare November 20, 2023 15:02
@lleon95 lleon95 force-pushed the feature/add-documentation branch from 2c3ce3f to 24b8cde Compare November 20, 2023 15:03
@lleon95 lleon95 force-pushed the feature/add-documentation branch from 24b8cde to 76d6cbf Compare November 20, 2023 15:14
Copy link
Collaborator

@dierpg dierpg left a 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
Copy link
Collaborator

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.

Copy link
Collaborator Author

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)
Copy link
Collaborator

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.

Copy link
Collaborator Author

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.
Copy link
Collaborator

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).
Copy link
Collaborator

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.

Copy link
Collaborator Author

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

out_mem->Sync(SyncType::DeviceToHost);
```
that takes any of the following values:
Copy link
Collaborator

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
@lleon95 lleon95 force-pushed the feature/add-documentation branch from 76d6cbf to 2b997d5 Compare November 30, 2023 16:29
@lleon95 lleon95 merged commit 8a943b5 into develop Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants