Skip to content

Commit 50ac5b8

Browse files
author
DavidbrOFS
committed
Deployed 151c9d9 to rel-24.2 with MkDocs 1.4.3 and mike 1.1.2
1 parent 3849575 commit 50ac5b8

File tree

111 files changed

+5642
-2642
lines changed

Some content is hidden

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

111 files changed

+5642
-2642
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Redirecting</title>
6+
<noscript>
7+
<meta http-equiv="refresh" content="1; url=../../../../../../../rel-24.2/embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" />
8+
</noscript>
9+
<script>
10+
window.location.replace("../../../../../../../rel-24.2/embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" + window.location.hash);
11+
</script>
12+
</head>
13+
<body>
14+
Redirecting to <a href="../../../../../../../rel-24.2/embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/">../../../../../../../rel-24.2/embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/</a>...
15+
</body>
16+
</html>

rel-24.2/404.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1544,6 +1544,8 @@
15441544

15451545

15461546

1547+
1548+
15471549

15481550

15491551
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
@@ -1572,6 +1574,20 @@
15721574

15731575

15741576

1577+
1578+
1579+
1580+
1581+
1582+
<li class="md-nav__item">
1583+
<a href="/rel-24.2/embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" class="md-nav__link">
1584+
Agilex™ 7 SoC HPS Multi-QSPI Remote System Update Example
1585+
</a>
1586+
</li>
1587+
1588+
1589+
1590+
15751591
</ul>
15761592
</nav>
15771593
</li>

rel-24.2/common/templates/linux_driver_template/index.html

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818

1919

20-
<title>Linux driver template - Altera-FPGA Site</title>
20+
<title>**Host Attach DFL FPGA Management Engine IP Driver** - Altera-FPGA Site</title>
2121

2222

2323

@@ -116,7 +116,7 @@
116116
<div class="md-header__topic" data-md-component="header-topic">
117117
<span class="md-ellipsis">
118118

119-
Linux driver template
119+
**Host Attach DFL FPGA Management Engine IP Driver**
120120

121121
</span>
122122
</div>
@@ -1562,6 +1562,8 @@
15621562

15631563

15641564

1565+
1566+
15651567

15661568

15671569
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
@@ -1590,6 +1592,20 @@
15901592

15911593

15921594

1595+
1596+
1597+
1598+
1599+
1600+
<li class="md-nav__item">
1601+
<a href="../../../embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" class="md-nav__link">
1602+
Agilex™ 7 SoC HPS Multi-QSPI Remote System Update Example
1603+
</a>
1604+
</li>
1605+
1606+
1607+
1608+
15931609
</ul>
15941610
</nav>
15951611
</li>
@@ -1726,18 +1742,12 @@
17261742

17271743

17281744

1729-
<!--This template provides an outline for you to create your Linux driver page. Below each guidance comment there is an example for your to reference.-->
17301745
<h1 id="host-attach-dfl-fpga-management-engine-ip-driver"><strong>Host Attach DFL FPGA Management Engine IP Driver</strong><a class="headerlink" href="#host-attach-dfl-fpga-management-engine-ip-driver" title="Permanent link">&para;</a></h1>
1731-
<!--Add this date comment below to include date document was last changed-->
1732-
<p>Last updated: <strong>September 03, 2024</strong> </p>
1733-
<!--Note whether your driver is upstreamed or not. If it is upstreamed, provide linux kernel link-->
1746+
<p>Last updated: <strong>September 23, 2024</strong> </p>
17341747
<p><strong>Upstream Status</strong>: <a href="https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/drivers/fpga?h=master">Upstreamed</a></p>
1735-
<!--Note devices supported-->
17361748
<p><strong>Devices supported</strong>: Stratix 10, Agilex 7</p>
1737-
<!--Introduction provides details of IP driver-->
17381749
<h2 id="introduction"><strong>Introduction</strong><a class="headerlink" href="#introduction" title="Permanent link">&para;</a></h2>
17391750
<p>This set of drivers is designed to support FME functionality, as implemented under FPGA Device Feature List (DFL) framework. It is used to expose FME capabilities.</p>
1740-
<!--If this is an OFS Driver include this table that notes the driver, what it maps to, the source and whether the driver is optional or not for DFL.-->
17411751
<table>
17421752
<thead>
17431753
<tr>
@@ -1774,23 +1784,18 @@ <h2 id="introduction"><strong>Introduction</strong><a class="headerlink" href="#
17741784
</tr>
17751785
</tbody>
17761786
</table>
1777-
<!--If there are multiple drivers, you can create a driver dependency chart using mermaid. Below is an example; to learn more about mermaid see https://mermaid.js.org/ -->
17781787
<pre class="mermaid"><code>graph TD;
17791788
A[dfl-fme]--&gt;B[dfl-fme-mgr];
17801789
A[dfl-fme]--&gt;C[dfl-fme-br];
17811790
A[dfl-fme]--&gt;D[dfl-fme-region]; </code></pre>
1782-
<!--Describe the IP(s) that the driver controls, provide a block diagram and link to any user guide documentation. -->
17831791
<h2 id="fpga-management-engine-ip"><strong>FPGA Management Engine IP</strong><a class="headerlink" href="#fpga-management-engine-ip" title="Permanent link">&para;</a></h2>
17841792
<p>The FPGA Management Engine IP provides management features for the platform and controls reset and loading of the AFU into the partial reconfiguration region of the FPGA. Implementation of a PR region is optional.</p>
17851793
<p>Each FME feature exposes its capability to host software drivers through a device feature header (DFH) register found at the beginning of its control status register (CSR) space. The FME CSR maps to physical function 0 (PF0) Base address register 0 (BAR0) so that software can access it through a single PCIe link. For more information about DFHs, refer to the <a href="https://ofs.github.io/latest/hw/d5005/reference_manuals/ofs_fim/mnl_fim_ofs_d5005/#721-device-feature-header-dfh-structure">Device Feature Header (DFH) structure</a>.</p>
1786-
<!--Describe the driver source destinations. -->
17871794
<h2 id="driver-sources"><strong>Driver Sources</strong><a class="headerlink" href="#driver-sources" title="Permanent link">&para;</a></h2>
17881795
<p>The source code for these drivers can be found at https://github.com/OFS/linux-dfl/tree/master/drivers/fpga, where branches labelled fpga-ofs-dev-*-lts correspond with the latest developmental versions of the DFL driver suite on that specific kernel version.</p>
1789-
<!--Provide Kernel Configurations and images-->
17901796
<h2 id="driver-capabilities"><strong>Driver Capabilities</strong><a class="headerlink" href="#driver-capabilities" title="Permanent link">&para;</a></h2>
17911797
<p>This driver set is a DFL specific implementation of generic FPGA drivers available in the kernel. <code>dfl-fme-mgr</code> is a DFL specific instantiation of the generic FPGA manager (drivers/linux/fpga/fpga-mgr.c), <code>dfl-fme-br</code> builds on top of a generic FPGA bridge (drivers/fpga/fpga-bridge.c), and <code>dfl-fme-region</code> instantiates an FPGA region. All three supplementary DFL Drivers depend on <code>dfl-fme</code>.</p>
17921798
<p>The DFL FME driver is a feature device implemented under the Device Feature List (DFL) framework. It enables the platform driver for the FME IP and implements all FPGA platform level management features. Only one FME is created per DFL based FPGA device. The DFL Bridge, Manager, and Region drivers are only required when attempting to configure a PR region in the FIM.</p>
1793-
<!--Provide Kernel Configurations and images-->
17941799
<h2 id="kernel-configurations"><strong>Kernel Configurations</strong><a class="headerlink" href="#kernel-configurations" title="Permanent link">&para;</a></h2>
17951800
<p>FPGA_DFL_FME</p>
17961801
<p><a class="glightbox" href="./images/dfl_fme_menuconfig.PNG" data-type="image" data-width="100%" data-height="auto" data-desc-position="bottom"><img alt="" src="./images/dfl_fme_menuconfig.PNG" /></a></p>
@@ -1800,10 +1805,8 @@ <h2 id="kernel-configurations"><strong>Kernel Configurations</strong><a class="h
18001805
<p><a class="glightbox" href="./images/dfl_fme_br_menuconfig.PNG" data-type="image" data-width="100%" data-height="auto" data-desc-position="bottom"><img alt="" src="./images/dfl_fme_br_menuconfig.PNG" /></a></p>
18011806
<p>FPGA_DFL_FME_REGION</p>
18021807
<p><a class="glightbox" href="./images/dfl_fme_region_menuconfig.PNG" data-type="image" data-width="100%" data-height="auto" data-desc-position="bottom"><img alt="" src="./images/dfl_fme_region_menuconfig.PNG" /></a></p>
1803-
<!--If there are any known issues with the driver, please list them here or provide link-->
18041808
<h2 id="known-issues"><strong>Known Issues</strong><a class="headerlink" href="#known-issues" title="Permanent link">&para;</a></h2>
18051809
<p>None known</p>
1806-
<!--If the driver is used in an example design, describe it and provide links. If there is a block diagram for the example design, include it. -->
18071810
<h2 id="example-designs"><strong>Example Designs</strong><a class="headerlink" href="#example-designs" title="Permanent link">&para;</a></h2>
18081811
<p>The FPGA Management Engine IP is included as a part of the FIM design for <a href="https://github.com/OFS/ofs-agx7-pcie-attach">PCIe Attach supporting DFL</a>, <a href="https://github.com/OFS/ofs-d5005.git">Stratix 10 PCIe Attach</a>, and <a href="https://github.com/OFS/ofs-f2000x-pl">SoC Attach</a>. Please refer to <a href="https://ofs.github.io/">site</a> for more information about these designs.</p>
18091812

@@ -1812,7 +1815,7 @@ <h2 id="example-designs"><strong>Example Designs</strong><a class="headerlink" h
18121815
<small>
18131816

18141817
Last update:
1815-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 3, 2024</span>
1818+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 23, 2024</span>
18161819

18171820
<br>
18181821
Created:

rel-24.2/doc_modules/Notices_&_Disclaimers/index.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1562,6 +1562,8 @@
15621562

15631563

15641564

1565+
1566+
15651567

15661568

15671569
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
@@ -1590,6 +1592,20 @@
15901592

15911593

15921594

1595+
1596+
1597+
1598+
1599+
1600+
<li class="md-nav__item">
1601+
<a href="../../embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" class="md-nav__link">
1602+
Agilex™ 7 SoC HPS Multi-QSPI Remote System Update Example
1603+
</a>
1604+
</li>
1605+
1606+
1607+
1608+
15931609
</ul>
15941610
</nav>
15951611
</li>

rel-24.2/doc_modules/links/index.html

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1557,6 +1557,8 @@
15571557

15581558

15591559

1560+
1561+
15601562

15611563

15621564
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
@@ -1585,6 +1587,20 @@
15851587

15861588

15871589

1590+
1591+
1592+
1593+
1594+
1595+
<li class="md-nav__item">
1596+
<a href="../../embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" class="md-nav__link">
1597+
Agilex™ 7 SoC HPS Multi-QSPI Remote System Update Example
1598+
</a>
1599+
</li>
1600+
1601+
1602+
1603+
15881604
</ul>
15891605
</nav>
15901606
</li>
@@ -1723,19 +1739,14 @@
17231739

17241740
<h1>Links</h1>
17251741

1726-
<!--This file is used for listing global document links. Create a live link when you want to share it across collateral to ensure the naming of the file is always the same. Share your agreed upon bracketed document name with others in this link file and whenever it is listed in their .md file, the correct active links will be created on the site. This links.md also helps if the link path changes, so you don't have to go back and change all of your documentation. Steps to get this to work are:
1727-
1. Decide on document name.
1728-
2. Decide where your link should go. If it is a global document name put it in the docs_module folder. If it is a interdocument link within a certain folder such as "embedded-designs" then create a links.md in the top folder, such as /docs/embedded-designs/doc_modules/links.md and place your link there.
1729-
3. Format the links as such (this is just an example):
1730-
[GSRD User Manual]: https://altera-fpga.github.io/rel-24.2/docs/embedded-designs/agilex-5/e-series/premium/gsrd/ug-gsrd-agx5e-premium/
1731-
In the above example, user only needs to include [GSRD User Manual] in document for live link to work.-->
1742+
17321743

17331744
<hr>
17341745
<div class="md-source-file">
17351746
<small>
17361747

17371748
Last update:
1738-
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">August 30, 2024</span>
1749+
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">September 23, 2024</span>
17391750

17401751
<br>
17411752
Created:

rel-24.2/driver-list/driver-list-all/index.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1562,6 +1562,8 @@
15621562

15631563

15641564

1565+
1566+
15651567

15661568

15671569
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
@@ -1590,6 +1592,20 @@
15901592

15911593

15921594

1595+
1596+
1597+
1598+
1599+
1600+
<li class="md-nav__item">
1601+
<a href="../../embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" class="md-nav__link">
1602+
Agilex™ 7 SoC HPS Multi-QSPI Remote System Update Example
1603+
</a>
1604+
</li>
1605+
1606+
1607+
1608+
15931609
</ul>
15941610
</nav>
15951611
</li>

rel-24.2/driver-list/driver-list-baremetal/index.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1562,6 +1562,8 @@
15621562

15631563

15641564

1565+
1566+
15651567

15661568

15671569
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
@@ -1590,6 +1592,20 @@
15901592

15911593

15921594

1595+
1596+
1597+
1598+
1599+
1600+
<li class="md-nav__item">
1601+
<a href="../../embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" class="md-nav__link">
1602+
Agilex™ 7 SoC HPS Multi-QSPI Remote System Update Example
1603+
</a>
1604+
</li>
1605+
1606+
1607+
1608+
15931609
</ul>
15941610
</nav>
15951611
</li>

rel-24.2/driver-list/driver-list-linux/index.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1562,6 +1562,8 @@
15621562

15631563

15641564

1565+
1566+
15651567

15661568

15671569
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
@@ -1590,6 +1592,20 @@
15901592

15911593

15921594

1595+
1596+
1597+
1598+
1599+
1600+
<li class="md-nav__item">
1601+
<a href="../../embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" class="md-nav__link">
1602+
Agilex™ 7 SoC HPS Multi-QSPI Remote System Update Example
1603+
</a>
1604+
</li>
1605+
1606+
1607+
1608+
15931609
</ul>
15941610
</nav>
15951611
</li>

rel-24.2/driver-list/driver-list-zephyr/index.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1562,6 +1562,8 @@
15621562

15631563

15641564

1565+
1566+
15651567

15661568

15671569
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
@@ -1590,6 +1592,20 @@
15901592

15911593

15921594

1595+
1596+
1597+
1598+
1599+
1600+
<li class="md-nav__item">
1601+
<a href="../../embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" class="md-nav__link">
1602+
Agilex™ 7 SoC HPS Multi-QSPI Remote System Update Example
1603+
</a>
1604+
</li>
1605+
1606+
1607+
1608+
15931609
</ul>
15941610
</nav>
15951611
</li>

rel-24.2/driver-list_all/index.html

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1562,6 +1562,8 @@
15621562

15631563

15641564

1565+
1566+
15651567

15661568

15671569
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
@@ -1590,6 +1592,20 @@
15901592

15911593

15921594

1595+
1596+
1597+
1598+
1599+
1600+
<li class="md-nav__item">
1601+
<a href="../embedded-designs/agilex-7/f-series/soc/rsu/ug-rsu-multiqspi-agx7f-soc/" class="md-nav__link">
1602+
Agilex™ 7 SoC HPS Multi-QSPI Remote System Update Example
1603+
</a>
1604+
</li>
1605+
1606+
1607+
1608+
15931609
</ul>
15941610
</nav>
15951611
</li>

0 commit comments

Comments
 (0)