Skip to content

Commit f887561

Browse files
jonnewcjsha
andauthored
Add v2.0 firmware to downloads (#103)
* Add v2.0 firmware to downloads - Reorganize downloads page a bit - Update oni-repl usage - Update oni-repl release * Fix broken ref * Fix link to direct users to riffa installation instructions The link was previously pointing users to a less relevant section. --------- Co-authored-by: cjsha <[email protected]>
1 parent e390b4a commit f887561

File tree

6 files changed

+76
-59
lines changed

6 files changed

+76
-59
lines changed

source/Hardware Guide/PCIe Host/setup-windows.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ Windows does not ship with a C++ runtime. Before using ONIX on windows, you
9999
will need to install `Microsoft Visual C++ Redistributable for Visual Studio
100100
2015, 2017 and 2019 <https://download.visualstudio.microsoft.com/download/pr/453680ea-b88a-411f-80fd-5db37fdc9dbb/5D9999036F2B3A930F83B7FE3E2186B12E79AE7C007D538F52E3582E986A37C3/VC_redist.x64.exe>`__.
101101

102+
.. _install_riffa:
103+
102104
Install Device Driver
103105
---------------------------------------
104106

source/Resources/downloads.rst

Lines changed: 69 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -23,84 +23,69 @@ Downloads
2323
* - :download:`1.0.0 <../_static/downloads/onix-software-releases/oni-repl-x64_v1.0.0.zip>`
2424
- 2022.11.27
2525
- Initial release.
26+
* - :download:`1.1.0 <../_static/downloads/onix-software-releases/oni-repl-x64_v1.1.0.zip>`
27+
- 2025.06.25
28+
- Fixes to hardware reset behavior. Addition of several command line
29+
switches and options in the REPL.
2630

27-
.. _pcie_host_updater_download:
31+
.. _riffa_driver_download:
2832

29-
PCIe Host Updater
33+
RIFFA Device Driver
3034
----------------------------------------------
3135

32-
.. note:: Please see :ref:`Updating PCIe Host Firmware
33-
<pcie_host_firmware_update>` for instructions on how to use these files. When
36+
.. note:: Please see :ref:`Install Device Driver <install_riffa>`
37+
for instructions on how to use this file. When
3438
using mac or linux, you will need to compile from `source
35-
<https://github.com/open-ephys/onix-gateware-field-updaters>`__.
39+
<https://github.com/open-ephys/liboni>`__.
3640

37-
.. list-table:: PCIe Host update tools
41+
.. list-table:: RIFFA PCIe driver
3842
:widths: 15 25 60
3943
:header-rows: 1
4044

4145
* - Version
4246
- Release Date
4347
- Release Notes
44-
* - :download:`1.0.0 <../_static/downloads/onix-software-releases/onix-pcie-host-flash-tools-x64_v1.0.0.zip>`
45-
- 2022.11.27
46-
- Initial release.
47-
48-
-----------------
48+
* - :download:`6.1.0.2 <../_static/downloads/onix-driver-releases/riffa/riffa-x64_v6.1.0.2.zip>`
49+
- 2024.03.14
50+
- Fix race condition in the RIFFA kernel driver for windows.
4951

50-
.. _breakout_updater_download:
52+
.. _pcie_host_updater_download:
5153

52-
Breakout Board Updater
54+
PCIe Host Firmware
5355
----------------------------------------------
5456

55-
.. note:: Please see :ref:`Updating Breakout Board Firmware
56-
<breakout_firmware_update>` for instructions on how to use these files.
57-
58-
.. list-table:: Breakout Board update tools
59-
:widths: 15 25 60
60-
:header-rows: 1
61-
62-
* - Version
63-
- Release Date
64-
- Release Notes
65-
* - :download:`1.0.0 <../_static/downloads/onix-software-releases/tinyprog.zip>`
66-
- 2024.07.05
67-
- Initial release.
57+
.. note:: Please see :ref:`Updating PCIe Host Firmware
58+
<pcie_host_firmware_update>` for instructions on how to use these files.
59+
When using mac or linux, you will need to compile the Updater software from
60+
`source <https://github.com/open-ephys/onix-gateware-field-updaters>`__.
6861

69-
-----------------
62+
.. _pcie_host_image_download:
7063

71-
.. _riffa_driver_download:
64+
PCIe Host Upload Tool
65+
______________________________________________
66+
Software for uploading bitfiles to hardware.
7267

73-
RIFFA Device Driver
74-
----------------------------------------------
75-
76-
.. note:: Please see :ref:`Updating PCIe Host Firmware
77-
<pcie_host_firmware_update>` for instructions on how to use these files. When
78-
using mac or linux, you will need to compile from `source
79-
<https://github.com/open-ephys/liboni>`__.
80-
81-
.. list-table:: RIFFA PCIe driver
68+
.. list-table:: PCIe Host upload tool
8269
:widths: 15 25 60
8370
:header-rows: 1
8471

8572
* - Version
8673
- Release Date
8774
- Release Notes
88-
* - :download:`6.1.0.2 <../_static/downloads/onix-driver-releases/riffa/riffa-x64_v6.1.0.2.zip>`
89-
- 2024.03.14
90-
- Fix race condition in the RIFFA kernel driver for windows.
75+
* - :download:`1.0.0 <../_static/downloads/onix-software-releases/onix-pcie-host-flash-tools-x64_v1.0.0.zip>`
76+
- 2022.11.27
77+
- Initial release.
9178

9279
-----------------
9380

94-
.. _pcie_host_image_download:
95-
96-
PCIe Host Firmware
97-
----------------------------------------------
98-
.. note:: Please see :ref:`Updating PCIe Host Firmware
99-
<pcie_host_firmware_update>` for instructions on how to use these files.
81+
PCIe Controller Bitfiles
82+
______________________________________________
10083

10184
.. warning::
102-
Make sure that the host firmware image you download matches the PCIe Host Hardware version you have
103-
as shown in the table below. An incorrect firmware version will not report any error while updating but will cause failures during operation.
85+
Make sure that the host firmware image you download matches the PCIe Host
86+
Hardware version you have as shown in the table below. An incorrect firmware
87+
version will not report any error while updating but will cause failures
88+
during operation.
10489

10590
.. table::
10691
:widths: 50 50
@@ -111,34 +96,61 @@ PCIe Host Firmware
11196
+=======================================================+=============================================================================================================+
11297
| Hardware Revision 1.4 | Deprecated. Please :ref:`get in touch <support>` so we can assist you. |
11398
+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
114-
| Hardware Revision 1.5 | :download:`Firmware version 1.1D <../_static/downloads/onix-gateware-images/onix-host-v1.1-update-revD.bin>`|
99+
| Hardware Revision 1.5 | :download:`Firmware version 2.0D <../_static/downloads/onix-gateware-images/onix-host-v2.0-update-revD.bin>`|
115100
+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
116-
| Hardware Revision 1.6 | :download:`Firmware version 1.1F <../_static/downloads/onix-gateware-images/onix-host-v1.1-update-revF.bin>`|
101+
| Hardware Revision 1.6 | :download:`Firmware version 2.0F <../_static/downloads/onix-gateware-images/onix-host-v2.0-update-revF.bin>`|
117102
+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
118103

119104

120105
.. .. list-table:: PCIe Host Revision 1.4 firmware images
121106
.. :widths: 15 25 60
122107
.. :header-rows: 1
123-
..
108+
..
124109
.. * - Version
125110
.. - Release Date
126111
.. - Release Notes
127112
.. * - :download:`0.6 <./_static/downloads/onix-gateware-images/pcie-host-1r4/onix-pcie-host-1r4_v0.6.bin>`
128113
.. - 2022.11.27
129114
.. - Remove unnecessary breakout board PLL reset during context initialization which could cause LEDs to turn off.
130-
131115
132-
.. _breakout_image_download:
133116
134117
Breakout Board Firmware
135118
----------------------------------------------
136-
.. note:: Please see :ref:`Updating Breakout Board Firmware
137-
<breakout_firmware_update>` for instructions on how to use these files.
119+
120+
.. note:: Please see :ref:`Updating Breakout Board Firmware <breakout_firmware_update>`
121+
for instructions on how to use these files. When
122+
using mac or linux, you will need to compile from `source
123+
<https://github.com/open-ephys/onix-gateware-field-updaters>`__.
124+
125+
.. _breakout_updater_download:
126+
127+
Breakout Board Upload Software
128+
______________________________________________
129+
Software for uploading bitfiles to hardware.
130+
131+
.. list-table:: Breakout Board firmware upload tool
132+
:widths: 15 25 60
133+
:header-rows: 1
134+
135+
* - Version
136+
- Release Date
137+
- Release Notes
138+
* - :download:`1.0.0 <../_static/downloads/onix-software-releases/tinyprog.zip>`
139+
- 2024.07.05
140+
- Initial release.
141+
142+
-----------------
143+
144+
.. _breakout_image_download:
145+
146+
Breakout Board Bitfiles
147+
______________________________________________
138148

139149
.. warning::
140-
Make sure that the breakout board firmware image you download matches the breakout board hardware version you have
141-
as shown in the table below. An incorrect firmware version will not report any error while updating but will cause failures during operation.
150+
Make sure that the breakout board firmware image you download matches the
151+
breakout board hardware version you have as shown in the table below. An
152+
incorrect firmware version will not report any error while updating but will
153+
cause failures during operation.
142154

143155
.. table::
144156
:widths: 50 50

source/Software Guide/oni-repl/usage.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@
55

66
.. code-block:: console
77
8-
oni-repl <driver> [slot] [-d] [-D <value>] [-n <value>] [-i <device index>]
9-
[--rbytes=<bytes>] [--wbytes=<bytes>] [--dumppath=<path>] [-h,--help] [-v,--version]
8+
oni-repl <driver> [slot] [-q] [-d] [-D <value>] [-n <value>] [-i <device
9+
index>] [--rbytes=<bytes>] [--wbytes=<bytes>] [--dformat=<hex,dec>]
10+
[--dumppath=<path>] [--regpath=<path>] [-h,--help] [-v,--version]
1011
1112
Required Arguments
1213
-----------------------------------
@@ -19,12 +20,14 @@ Required Arguments
1920

2021
Command Line Options
2122
-----------------------------------
23+
-q Quit after intialization. If specified, quit before entering repl but after after establishing a connection with hardware, obtaining the device table, and writing to registers specified in --regpath.
2224
-d Display frames. If specified, frames produced by the oni hardware will be printed to the console.
2325
-D <percent> The percent of frames printed to the console if frames are displayed. Percent should be a value in (0, 100.0].
2426
-n <count> Display at most count frames. Reset only on program restart. Useful for examining the start of the data stream.
2527
-i <index> Only display frames from device with specified index value.
2628
--rbytes=<bytes> Set block read size in bytes. This number determines the latency/bandwidth tradeoff. Large block read sizes will reuslt in less frequent data transfers from hardware that can increase overall streaming bandwith of the system. This number imposes a lower bound on real-time latency since the system will need to accumulate the entire read block before data is transmitted.
2729
--wbytes=<bytes> Set write preallocation size in bytes. This number indicates the amount of memory is reserved for use by the write stream. Tuning my improve real-time performance depending on write frequency.
30+
--dformat=<hex,dec> Set the format of frame data printed to the console to hexidecimal (default) or decimal.
2831
--dumppath=<path> Path to folder to dump raw device data. If not defined, no data will be written. A flat binary file with name <index>_idx-<id>_id-<datetime>.raw will be created for each device in the device table that produces streaming data. The bit-wise frame definition in the ONI device datasheet (as required by the ONI spec) will describe frame data is organized in each file.
2932
--regpath=<path> Path to a text file containing a table of the form:
3033

4 MB
Binary file not shown.
3.87 MB
Binary file not shown.
53.6 KB
Binary file not shown.

0 commit comments

Comments
 (0)