diff --git a/source/Hardware Guide/Breakout Board/updating-breakout-firmware.rst b/source/Hardware Guide/Breakout Board/updating-breakout-firmware.rst index a480b5f0..b3a0730d 100644 --- a/source/Hardware Guide/Breakout Board/updating-breakout-firmware.rst +++ b/source/Hardware Guide/Breakout Board/updating-breakout-firmware.rst @@ -15,6 +15,8 @@ Updating Breakout Board Firmware in Windows #. Connect a USB-microUSB from the PC you will use to perform the firmware update to the Config port on the side of the breakout board. +.. _breakout_version_difference: + #. Verify the Breakout Board version by looking at the specifications on the product. .. figure:: /_static/images/breakout/breakout_1r5_fw.png diff --git a/source/Hardware Guide/PCIe Host/updating-firmware.rst b/source/Hardware Guide/PCIe Host/updating-firmware.rst index 87bce98c..86bc38df 100644 --- a/source/Hardware Guide/PCIe Host/updating-firmware.rst +++ b/source/Hardware Guide/PCIe Host/updating-firmware.rst @@ -15,6 +15,8 @@ Updating Firmware in Windows .. note:: For a complete description of this program, have a look at its :ref:`usage guide ` +.. _controller_version_difference: + #. Verify your PCIe Host Hardware version by running ``oni-repl`` and typing "H" into the command prompt. This will print a list of all hubs in the current ONI context, one of which will be the PCIe Host. @@ -30,7 +32,7 @@ Updating Firmware in Windows .. figure:: /_static/images/pcie-host/oni-repl-host-hardware-version.png :align: center -#. Download the latest :ref:`pcie_host_image_download` for your hardware +#. Download the latest :ref:`PCIe Host Firmware Image ` for your hardware version. .. warning:: @@ -51,14 +53,13 @@ Updating Firmware in Windows :align: center #. Open the Windows Device Manager by typing "device manager" into the windows - search bar.Find the RIFFA device you are going to update in the device tree. - Right click on the RIFFA device and select inactivate. + search bar. Find the RIFFA device you are going to update in the device tree. It is listed under "Open Ephys ONI PCIe Devices". Right click on the RIFFA device and select Disable device. Click Yes on the warning message. .. figure:: /_static/images/pcie-host/device-manager-disable-riffa.png :align: center :width: 80% -#. Right click again and click activate +#. Right click again and click Enable device. .. figure:: /_static/images/pcie-host/device-manager-enable-riffa.png :align: center @@ -91,7 +92,7 @@ Updating Firmware in Windows .. figure:: /_static/images/pcie-host/oni-pcie-change-mode-to-normal.png :align: center -#. Repeat steps 7 and 8 to reactivate the PCIe Host with the updated +#. Repeat steps 7 and 8 to reenable the PCIe Host with the updated firmware. #. To verify the firmware update, repeat step 3. The firmware version of the diff --git a/source/Resources/downloads.rst b/source/Resources/downloads.rst index d2f210d8..83167d44 100644 --- a/source/Resources/downloads.rst +++ b/source/Resources/downloads.rst @@ -49,7 +49,6 @@ RIFFA Device Driver - 2024.03.14 - Fix race condition in the RIFFA kernel driver for windows. -.. _pcie_host_updater_download: PCIe Host Firmware ---------------------------------------------- @@ -59,11 +58,11 @@ PCIe Host Firmware When using mac or linux, you will need to compile the Updater software from `source `__. -.. _pcie_host_image_download: +.. _pcie_host_updater_download: PCIe Host Upload Tool ______________________________________________ -Software for uploading bitfiles to hardware. +Software for uploading PCIe Host firmware to PCIe Host hardware. .. list-table:: PCIe Host upload tool :widths: 15 25 60 @@ -76,9 +75,9 @@ Software for uploading bitfiles to hardware. - 2022.11.27 - Initial release. ------------------ +.. _pcie_host_image_download: -PCIe Controller Bitfiles +PCIe Host Firmware Images ______________________________________________ .. warning:: @@ -90,18 +89,18 @@ ______________________________________________ .. table:: :widths: 30 70 - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | 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 ` so we can assist you. | - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Hardware Revision 1.5 | | :download:`Firmware version 2.0D <../_static/downloads/onix-gateware-images/onix-host-v2.0-update-revD.bin>` | - | | | Requires OpenEphys.Onix1 v0.6+ or Open Ephys GUI v1.0+ | - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ - | Hardware Revision 1.6 | | :download:`Firmware version 2.0F <../_static/downloads/onix-gateware-images/onix-host-v2.0-update-revF.bin>` | - | | | Requires OpenEphys.Onix1 v0.6+ or Open Ephys GUI v1.0+ | - +-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | | PCIe Host Hardware version | | Latest PCIe Host | + | | :ref:`per oni-repl ` | | firmware version | + +===================================================================+================================================================================================================+ + | Hardware Revision 1.4 | Deprecated. Please :ref:`get in touch ` so we can assist you. | + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Hardware Revision 1.5 | | :download:`Firmware version 2.0D <../_static/downloads/onix-gateware-images/onix-host-v2.0-update-revD.bin>` | + | | | Requires OpenEphys.Onix1 v0.6+ or Open Ephys GUI v1.0+ | + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ + | Hardware Revision 1.6 | | :download:`Firmware version 2.0F <../_static/downloads/onix-gateware-images/onix-host-v2.0-update-revF.bin>` | + | | | Requires OpenEphys.Onix1 v0.6+ or Open Ephys GUI v1.0+ | + +-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------+ .. .. list-table:: PCIe Host Revision 1.4 firmware images @@ -126,9 +125,9 @@ Breakout Board Firmware .. _breakout_updater_download: -Breakout Board Upload Software +Breakout Board Upload Tool ______________________________________________ -Software for uploading bitfiles to hardware. +Software for uploading Breakout Board firmware to Breakout Board hardware. .. list-table:: Breakout Board firmware upload tool :widths: 15 25 60 @@ -141,11 +140,9 @@ Software for uploading bitfiles to hardware. - 2024.07.05 - Initial release. ------------------ - .. _breakout_image_download: -Breakout Board Bitfiles +Breakout Board Firmware Images ______________________________________________ .. warning:: @@ -157,12 +154,12 @@ ______________________________________________ .. table:: :widths: 40 60 - +-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | Breakout Board Hardware version | Breakout Board Firmware latest version | - | as per product specs | to download and update | - +=======================================================+=============================================================================================================+ - | Hardware Revision 1.5 (four headstage ports) | :download:`Firmware version 1.3 <../_static/downloads/onix-gateware-images/breakout-rev1.5-fw1.3.bin>` | - +-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | Hardware Revision 1.6 (two headstage ports) | :download:`Firmware version 1.3 <../_static/downloads/onix-gateware-images/breakout-rev1.6-fw1.3.bin>` | - +-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | | Breakout Board Hardware version | | Latest Breakout Board | + | | :ref:`per visual inspection ` | | firmware version | + +==============================================================+=============================================================================================================+ + | Hardware Revision 1.5 (four headstage ports) | :download:`Firmware version 1.3 <../_static/downloads/onix-gateware-images/breakout-rev1.5-fw1.3.bin>` | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ + | Hardware Revision 1.6 (two headstage ports) | :download:`Firmware version 1.3 <../_static/downloads/onix-gateware-images/breakout-rev1.6-fw1.3.bin>` | + +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ diff --git a/source/_static/images/pcie-host/device-manager-disable-riffa.png b/source/_static/images/pcie-host/device-manager-disable-riffa.png index 074b3c4e..9b5775dd 100644 Binary files a/source/_static/images/pcie-host/device-manager-disable-riffa.png and b/source/_static/images/pcie-host/device-manager-disable-riffa.png differ diff --git a/source/_static/images/pcie-host/device-manager-enable-riffa.png b/source/_static/images/pcie-host/device-manager-enable-riffa.png index 3c5df128..b033961e 100644 Binary files a/source/_static/images/pcie-host/device-manager-enable-riffa.png and b/source/_static/images/pcie-host/device-manager-enable-riffa.png differ