Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Apr 29, 2024
1 parent 43c4c0d commit 5c6532a
Show file tree
Hide file tree
Showing 11 changed files with 56 additions and 18 deletions.
4 changes: 2 additions & 2 deletions Hardware Guide/PCIe Host/updating-firmware.html
Original file line number Diff line number Diff line change
Expand Up @@ -516,8 +516,8 @@ <h1>Updating Firmware in Windows<a class="headerlink" href="#updating-firmware-i
version.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Make sure that the host firmware images matches the hardware version
from the last step or the update will not work properly.</p>
<p>Make sure that the host firmware image you download matches the PCIe Host Hardware version
you verified in the previous step. An incorrect firmware version will not report any error while updating but will cause failures during operation.</p>
</div>
</li>
<li><p>Download the <a class="reference internal" href="../../Resources/downloads.html#pcie-host-updater-download"><span class="std std-ref">PCIe Host Updater</span></a> utilities package and unzip
Expand Down
42 changes: 34 additions & 8 deletions Resources/downloads.html
Original file line number Diff line number Diff line change
Expand Up @@ -520,14 +520,41 @@
<p class="admonition-title">Note</p>
<p>Please see <a class="reference internal" href="../Hardware%20Guide/PCIe%20Host/updating-firmware.html#pcie-host-firmware-update"><span class="std std-ref">Updating PCIe Host Firmware</span></a> for instructions on how to use these files.</p>
</div>
</section>
<section id="hardware-revision-1-4">
<h2>Hardware Revision 1.4<a class="headerlink" href="#hardware-revision-1-4" title="Link to this heading">#</a></h2>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Please <a class="reference internal" href="support.html#support"><span class="std std-ref">get in touch</span></a> so that we can provide the latest firmware
for your board.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Make sure that the host firmware image you download matches the PCIe Host Hardware version you have
as shown in the table below. An incorrect firmware version will not report any error while updating but will cause failures during operation.</p>
</div>
<table class="table">
<colgroup>
<col style="width: 50.0%" />
<col style="width: 50.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><dl class="simple">
<dt>PCIe Host Hardware version</dt><dd><p>as reported by <cite>oni-repl</cite></p>
</dd>
</dl>
</th>
<th class="head"><dl class="simple">
<dt>PCIe Host Firmware latest version</dt><dd><p>to download and update</p>
</dd>
</dl>
</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Hardware Revision 1.4</p></td>
<td><p>Deprecated. Please <a class="reference internal" href="support.html#support"><span class="std std-ref">get in touch</span></a> so we can assist you.</p></td>
</tr>
<tr class="row-odd"><td><p>Hardware Revision 1.5</p></td>
<td><p><a class="reference download internal" download="" href="../_downloads/cd048d80512bf344c6ac16489c5c8b36/onix-host-v1.1-update-revD.bin"><code class="xref download docutils literal notranslate"><span class="pre">Firmware</span> <span class="pre">version</span> <span class="pre">1.1D</span></code></a></p></td>
</tr>
<tr class="row-even"><td><p>Hardware Revision 1.6</p></td>
<td><p><a class="reference download internal" download="" href="../_downloads/50ce2137399bb0c7cab85c50b1b9cbb7/onix-host-v1.1-update-revF.bin"><code class="xref download docutils literal notranslate"><span class="pre">Firmware</span> <span class="pre">version</span> <span class="pre">1.1F</span></code></a></p></td>
</tr>
</tbody>
</table>
</section>
</section>

Expand Down Expand Up @@ -588,7 +615,6 @@ <h2>Hardware Revision 1.4<a class="headerlink" href="#hardware-revision-1-4" tit
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pcie-host-updater">PCIe Host Updater</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#riffa-device-driver">RIFFA Device Driver</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pcie-host-firmware">PCIe Host Firmware</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#hardware-revision-1-4">Hardware Revision 1.4</a></li>
</ul>
</nav></div>

Expand Down
Binary file not shown.
Binary file not shown.
4 changes: 2 additions & 2 deletions _sources/Hardware Guide/PCIe Host/updating-firmware.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Updating Firmware in Windows
version.

.. warning::
Make sure that the host firmware images matches the hardware version
from the last step or the update will not work properly.
Make sure that the host firmware image you download matches the PCIe Host Hardware version
you verified in the previous step. An incorrect firmware version will not report any error while updating but will cause failures during operation.

#. Download the :ref:`pcie_host_updater_download` utilities package and unzip
it. Navigate to this folder using a console.
Expand Down
22 changes: 17 additions & 5 deletions _sources/Resources/downloads.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,23 @@ PCIe Host Firmware
.. note:: Please see :ref:`Updating PCIe Host Firmware
<pcie_host_firmware_update>` for instructions on how to use these files.

Hardware Revision 1.4
----------------------------------------------

.. important:: Please :ref:`get in touch <support>` so that we can provide the latest firmware
for your board.
.. warning::
Make sure that the host firmware image you download matches the PCIe Host Hardware version you have
as shown in the table below. An incorrect firmware version will not report any error while updating but will cause failures during operation.

.. table::
:widths: 50 50

+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| PCIe Host Hardware version | PCIe Host Firmware latest version |
| as reported by `oni-repl` | to download and update |
+=======================================================+=============================================================================================================+
| Hardware Revision 1.4 | Deprecated. Please :ref:`get in touch <support>` so we can assist you. |
+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| Hardware Revision 1.5 | :download:`Firmware version 1.1D <../_static/downloads/onix-gateware-images/onix-host-v1.1-update-revD.bin>`|
+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
| Hardware Revision 1.6 | :download:`Firmware version 1.1F <../_static/downloads/onix-gateware-images/onix-host-v1.1-update-revF.bin>`|
+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+


.. .. list-table:: PCIe Host Revision 1.4 firmware images
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 5c6532a

Please sign in to comment.