Skip to content

Commit

Permalink
Cleanup sphinx build again...
Browse files Browse the repository at this point in the history
Signed-off-by: Travis F. Collins <[email protected]>
  • Loading branch information
tfcollins committed Jan 17, 2024
1 parent 571f9f6 commit 2de50b0
Show file tree
Hide file tree
Showing 86 changed files with 55 additions and 13,417 deletions.
94 changes: 0 additions & 94 deletions sdoc/source/_index.rst

This file was deleted.

File renamed without changes
File renamed without changes
File renamed without changes
14 changes: 7 additions & 7 deletions sdoc/source/_static/assets/rd_ad9361_custom.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions sdoc/source/_static/assets/rd_adrv9001_custom.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 10 additions & 10 deletions sdoc/source/_static/assets/rd_jesd_custom.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion sdoc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,15 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
# "sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.githubpages",
"myst_parser",
"sphinx_favicon",
"sphinxcontrib.mermaid",
# "sphinx_copybutton",
# "sphinx_togglebutton", # Using this?
"sphinx_design",
]

myst_enable_extensions = [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,18 @@ style D fill:#FF0,stroke:#333,stroke-width:4px,stroke-dasharray: 5 5

At a high-level there are six main steps, two of which are optional. From the far left stage "Generate Verilog From Simulink IP" occurs in Stage 3 "HDL Code Generation" within HWA as outlined in red below. This will create Verilog within the defined project folder and then be copied into the full HDL project later on.

<figure markdown>
![](../HWA_verilog_gen.png){ width=80% }
<figcaption>Figure 2: HDL Workflow Advisor IP verilog generation.</figcaption>
</figure>
```{figure} /_static/assets/HWA_verilog_gen.png
HDL Workflow Advisor IP verilog generation.
```

Within the largest central block of the flowchart labeled **vivado_create_prj.tcl** are all the core steps related the HWA Step 4.1, where the reference HDL project folder is built and necessary cores and nets removed to make room for IP from Simulink generated in HWA Step 3. This stage is highlighed in the figure below. The purple boxes are optional stages that are used in certain customized examples when additional work is required to prepare a reference design. The [Frequency Hopping example](https://github.com/analogdevicesinc/TransceiverToolbox/tree/master/trx_examples/targeting/frequency-hopping) leverages these stages. Once the project is prepared the IP is inserted and bitstream generated, which occurs through HWA Step 4.3.

<figure markdown>
![](../HWA_project_gen.png){ width=80% }
<figcaption>Figure 3: HDL Workflow Advisor project generation step.</figcaption>
</figure>

```{figure} /_static/assets/HWA_project_gen.png
HDL Workflow Advisor project generation step.
```


### Vivado Project Perspective
Expand All @@ -67,17 +68,20 @@ Based on the flow in Figure 1, there are a three main states the HDL reference d

The first state is just the initial creation of the standard unmodified block design. Looking at Figure 4, the three IPs show the dataflow from the interface core (axi_ad9361), through the ADC FIFO, and finally into the pack core. In orange are the data buses and valid signal highlighted. These are important since the generated IP needs to be inserted where these nets are connected. Therefore, in the second state of the design these nets are removed to make room from the new IP.

<figure markdown>
![](../stock_reference_design.png){ width=80% }
<figcaption>Figure 4: RX path in unmodified standard reference design.</figcaption>
</figure>

```{figure} /_static/assets/stock_reference_design.png
RX path in unmodified standard reference design.
```



Once the IP is inserted into the project by HDL-Coder it is connected to the FIFO and pack cores where the nets in Figure 4 were highlighted. The new inserted and connected IP can be see in Figure 5.

<figure markdown>
![](../reference_design_with_IP.png){ width=80% }
<figcaption>Figure 5: RX path with inserted IP from HDL-Coder.</figcaption>
</figure>
```{figure} /_static/assets/reference_design_with_IP.png
RX path with inserted IP from HDL-Coder.
```

The connecting of the IPs and insertion are entirely managed by HDL-Coder and through the [add_io_ports](https://github.com/analogdevicesinc/TransceiverToolbox/blob/master/hdl/vendor/AnalogDevices/+AnalogDevices/add_io_ports.m) function and supporting [JSON port definition file](https://github.com/analogdevicesinc/TransceiverToolbox/blob/master/hdl/vendor/AnalogDevices/+AnalogDevices/ports.json).

Expand Down
7 changes: 0 additions & 7 deletions sdoc/source/fpga/dma_sync.mmd

This file was deleted.

60 changes: 0 additions & 60 deletions sdoc/source/fpga/index.rst

This file was deleted.

10 changes: 3 additions & 7 deletions sdoc/source/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
hide-toc: true
---

<!-- Hide header and click button -->
<style>
.md-typeset h1,
Expand Down Expand Up @@ -50,11 +46,11 @@ The following have device-specific implementations in MATLAB and Simulink. If a



## TOC
## Sections

```{eval-rst}
.. toctree::
:maxdepth: 2
:maxdepth: 1
install.md
streaming.md
Expand All @@ -68,6 +64,6 @@ The following have device-specific implementations in MATLAB and Simulink. If a
```{toctree}
:caption: Development
odocs/dev_hdl_workflow.md
dev_hdl_workflow.md
```

8 changes: 4 additions & 4 deletions sdoc/source/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,20 @@ Before installing Transceiver Toolbox check the [Release Page](https://github.co

To install the toolbox from within MATLAB using the Add-On Explorer, first launch the Explorer from MATLAB's Home tab:

<img class="screenshot" src="/assets/add_ex.png">
<img class="screenshot" src="/_static/assets/add_ex.png">

Search for the toolbox:

<!-- ![Add-On Explorer](assets/trx_search_wbox.png) -->
<img class="screenshot" src="../assets/trx_search_wbox.png">
<img class="screenshot" src="/_static/assets/trx_search_wbox.png">

Select Transceiver Toolbox from results:

<!-- ![Add-On Explorer](assets/trx_search_find_wbox.png) -->
<img class="screenshot" src="../assets/trx_search_find_wbox.png">
<img class="screenshot" src="/_static/assets/trx_search_find_wbox.png">


Select add:

<!-- ![Add-On Explorer](assets/addons_page_wbox.png) -->
<img class="screenshot" src="../assets/addons_page_wbox.png">
<img class="screenshot" src="/_static/assets/addons_page_wbox.png">
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
89 changes: 0 additions & 89 deletions sdoc/source/odocs/_pages/dev_hdl_workflow.md

This file was deleted.

Loading

0 comments on commit 2de50b0

Please sign in to comment.