Skip to content

Commit a92de8c

Browse files
bo3zbo3z
committed
Update docs for 0.2.1
1 parent c82dc30 commit a92de8c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+376
-180
lines changed

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,6 @@ misc/
4848
*.d
4949
*.DS_Store
5050
*.venv
51-
__pycache__
51+
__pycache__
52+
docs/docs-sw/
53+
docs/docs-driver/

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</p>
88

99
[![Documentation Status](https://github.com/fpgasystems/Coyote/actions/workflows/build_docs.yaml/badge.svg?branch=master)](https://fpgasystems.github.io/Coyote/)
10-
[![Build benchmarks](https://github.com/fpgasystems/Coyote/actions/workflows/build_static.yaml/badge.svg?branch=master)](https://github.com/fpgasystems/Coyote/actions/workflows/build_static.yaml)
10+
[![Build benchmarks](https://github.com/fpgasystems/Coyote/actions/workflows/build_static.yaml/badge.svg?branch=master)](https://github.com/fpgasystems/Coyote/actions/workflows/build_hls.yaml)
1111
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
1212

1313
# _An operating system for FPGAs_
@@ -49,7 +49,7 @@ Additional details on **Coyote's** features and internals can be found in the [d
4949
## Prerequisites
5050
- **Linux**: For the basic Coyote functionality, Linux >= 5 is sufficient. Coyote has been extensively tested with Linux 5.4, Linux 5.15, Linux 6.2 and Linux 6.8.
5151
- **CMake**: CMake >= 3.5 with support for C++17.
52-
- **Vivado & Vitis**: Coyote has to be built with the full Vivado suite, including Vitis HLS. Coyote supports Vivado/Vitis HLS >= 2022.1. We have conducted extensive testing with Vivado 2022.1 and recommend this version for synthesizing Coyote (but others should work as well). All network-related Coyote configurations are built using the UltraScale+ Integrated 100G Ethernet Subsystem, for which a valid license must be obtained.
52+
- **Vivado & Vitis**: Coyote has to be built with the full Vivado suite, including Vitis HLS. Coyote supports Vivado/Vitis HLS >= 2022.1. We have conducted extensive testing with Vivado 2024.1 and 2022.1, though others should work as well. All network-related Coyote configurations are built using the UltraScale+ Integrated 100G Ethernet Subsystem, for which a valid license must be obtained.
5353
- **FPGA**: The main target platform for the current Coyote release is the AMD Alveo U55C accelerator card, Additionally, Coyote also supports and has extensively been tested on Alveo U250 and Alveo U280.
5454

5555
Additional requirements for certain features (e.g. GPU peer-to-peer) are covered in the respective example covering the feature.

‎docs/Doxyfile-driver‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
PROJECT_NAME = "docs-driver"
2+
3+
RECURSIVE = YES
4+
INPUT = ../driver/include/
5+
OUTPUT_DIRECTORY = docs-driver/
6+
STRIP_FROM_PATH = ../driver/include/ ../driver/include/platform/ ../driver/include/vfpga ../driver/include/reconfig
7+
EXCLUDE_PATTERNS = */coyote_defs.h
8+
9+
GENERATE_XML = YES
10+
GENERATE_HTML = NO
11+
GENERATE_LATEX = NO

‎docs/Doxyfile-sw‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
PROJECT_NAME = "docs-sw"
2+
3+
INPUT = ../sw/include/
4+
OUTPUT_DIRECTORY = docs-sw/
5+
STRIP_FROM_PATH = ../sw/include/
6+
EXCLUDE_PATTERNS = */cDefs.hpp
7+
8+
GENERATE_XML = YES
9+
GENERATE_HTML = NO
10+
GENERATE_LATEX = NO
11+
12+
EXTRACT_ALL = YES
13+
SHOW_INCLUDE_FILES = NO

‎docs/requirements.txt‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ nbsphinx-link
1010
shapely
1111
sphinx
1212
sphinx-markdown-builder
13-
sphinx-rtd-theme
13+
sphinx-rtd-theme
14+
breathe

‎docs/source/api/driver.rst‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
2+
Device driver
3+
===================================
4+
5+
coyote_driver.h
6+
------------------------------------
7+
.. doxygenfile:: coyote_driver.h
8+
:project: docs-driver
9+
10+
11+
coyote_setup.h
12+
------------------------------------
13+
.. doxygenfile:: coyote_setup.h
14+
:project: docs-driver
15+
16+
coyote_sysfs.h
17+
------------------------------------
18+
.. doxygenfile:: coyote_sysfs.h
19+
:project: docs-driver
20+
21+
vfpga_gup.h
22+
------------------------------------
23+
.. doxygenfile:: vfpga_gup.h
24+
:project: docs-driver
25+
26+
vfpga_hw.h
27+
------------------------------------
28+
.. doxygenfile:: vfpga_hw.h
29+
:project: docs-driver
30+
31+
vfpga_isr.h
32+
------------------------------------
33+
.. doxygenfile:: vfpga_isr.h
34+
:project: docs-driver
35+
36+
vfpga_ops.h
37+
------------------------------------
38+
.. doxygenfile:: vfpga_ops.h
39+
:project: docs-driver
40+
41+
42+
vfpga_uisr.h
43+
------------------------------------
44+
.. doxygenfile:: vfpga_uisr.h
45+
:project: docs-driver
46+
47+
reconfig_hw.h
48+
------------------------------------
49+
.. doxygenfile:: reconfig_hw.h
50+
:project: docs-driver
51+
52+
reconfig_isr.h
53+
------------------------------------
54+
.. doxygenfile:: reconfig_isr.h
55+
:project: docs-driver
56+
57+
reconfig_mem.h
58+
------------------------------------
59+
.. doxygenfile:: reconfig_mem.h
60+
:project: docs-driver
61+
62+
reconfig_ops.h
63+
------------------------------------
64+
.. doxygenfile:: reconfig_ops.h
65+
:project: docs-driver
66+
67+
pci_util.h
68+
------------------------------------
69+
.. doxygenfile:: pci_util.h
70+
:project: docs-driver
71+
72+
pci_xdma.h
73+
------------------------------------
74+
.. doxygenfile:: pci_xdma.h
75+
:project: docs-driver

‎docs/source/api/sw.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
2+
Software
3+
===================================
4+
.. doxygenindex::
5+
:project: docs-sw

‎docs/source/conf.py‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919

2020
# -- Project information -----------------------------------------------------
2121

22-
project = 'Coyote-docs'
22+
project = 'Coyote'
2323
copyright = '2025, System Group, ETH Zurich'
2424
author = 'Systems Group, ETH Zurich'
2525

2626
# The short X.Y version
2727
version = ''
2828
# The full version, including alpha/beta/rc tags
29-
release = 'v1.0.0'
29+
release = 'v0.2.1'
3030

3131

3232
# -- General configuration ---------------------------------------------------
@@ -186,6 +186,11 @@
186186

187187

188188
# -- Extension configuration -------------------------------------------------
189+
extensions = ['breathe']
190+
breathe_projects = {
191+
"docs-sw": "../docs-sw/xml/",
192+
"docs-driver": "../docs-driver/xml/"
193+
}
189194

190195
# -- Options for intersphinx extension ---------------------------------------
191196

‎docs/source/cyt_ov.png‎

1.1 MB
Loading

‎docs/source/developer/index.rst‎

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,47 @@
11

22
###################################
33
Developer Guide
4-
###################################
4+
###################################
5+
6+
Contributing
7+
-----------------------
8+
9+
We welcome contributions to Coyote, both for source code as well as documentation. All code should be added via pull requests (PR), targetting the main branch. When opening a PR, please make sure the following steps are followed:
10+
11+
1. In the PR description, clearly document all changes made. Coyote includes a PR template, which can be used for this purpose.
12+
13+
2. If adding new functionality, please ensure it works as expeted and add an example/test on how to use it.
14+
15+
3. Ensure your code is well-commented and documented, with the necessary changes also reflected in Coyote's documentation.
16+
17+
4. Be sure to to use the same license for your contributions as the current license of the Coyote component you are contributing to (described below)
18+
19+
**Code license:** Most of Coyote code is licensed under the terms described in [LICENSE](https://github.com/fpgasystems/Coyote/blob/master/LICENSE.md), which corresponds to the MIT Licence.
20+
An exception to this is the Coyote device driver, which is open-sourced with the GPL v2 license.
21+
Any contributions to Coyote will be accepted under the same terms of license.
22+
23+
**Code reviews:** We will aim to review your contribution in a timely manner and, if additional fixes/modifications are needed, provide feedback to guide you. When accepted, your pull request will be merged to the main branch of the repository.
24+
25+
Code of Conduct
26+
-----------------------
27+
In the interest of fostering an open and welcoming environment, we as
28+
contributors and maintainers pledge to make participation in our project and
29+
our community a harassment-free experience for everyone, regardless of age, body
30+
size, disability, ethnicity, sex characteristics, gender identity and expression,
31+
level of experience, education, socio-economic status, nationality, personal
32+
appearance, race, religion, or sexual identity and orientation.
33+
34+
Examples of behavior that contributes to creating a positive environment
35+
include:
36+
37+
* Using welcoming and inclusive language
38+
* Being respectful of differing viewpoints and experiences
39+
* Gracefully accepting constructive criticism
40+
* Focusing on what is best for the community
41+
* Showing empathy towards other community members
42+
43+
**Attribution**: This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
44+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
45+
46+
For answers to common questions about this code of conduct, see
47+
https://www.contributor-covenant.org/faq

0 commit comments

Comments
 (0)