section-scope-drivers.tex

\chapter{Oscilloscope Drivers}
\label{sec:scope-drivers}

This chapter describes all of the available drivers for oscilloscopes and logic analyzers.

\section{Agilent}

Agilent devices support a similar similar SCPI command set across most device families.

Please see the table below for details of current hardware support:

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
DSO5000 series & agilent & lan & Not recently tested, but should work.\\
\thinhline
DSO6000 \& MSO6000 series & agilent & lan &  Working. No support for digital channels yet.\\
\thinhline
DSO7000 \& MSO7000 series & agilent & lan & Untested, but should work. No support for digital channels yet.\\
\thinhline
EDUX1000 series & agilent & lan & Untested but should be identical to DSOX1200 but with lower sample memory. \\
\thinhline
DSOX1200 series & agilent & lan & Working. No support for wavegen yet. \\
\thinhline
MSOX-2000 series & agilent & lan \\
\thinhline
MSOX-3000 series & agilent & lan \\
\thickhline
\end{tabularx}

\subsection{agilent}

\subsubsection{Typical Performance (MSO6034A, LAN)}

Interestingly, performance sometimes gets better with more channels or deeper memory. Not sure why.

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
1 & 1K & 66 \\
\thinhline
4 & 1K & 33 \\
\thinhline
4 & 4K & 33 \\
\thinhline
1 & 40K & 33 \\
\thinhline
1 & 4K & 22 \\
\thinhline
1 & 20K & 22 \\
\thinhline
4 & 20K & 22 \\
\thinhline
1 & 100K & 22 \\
\thinhline
4 & 10K & 17 \\
\thinhline
4 & 40K & 12 \\
\thinhline
1 & 200K & 11 \\
\thinhline
1 & 400K & 8 \\
\thinhline
4 & 100K & 6.5 \\
\thinhline
4 & 200K & 4 \\
\thinhline
1 & 1M & 3.7 \\
\thinhline
4 & 400K & 2.3 \\
\thinhline
1 & 1M & 1 \\
\thinhline
4 & 1M & 1 \\
\thinhline
4 & 4M & 0.2 \\
\thickhline
\end{tabularx}

\subsubsection{Typical Performance (MSOX3104T, LAN)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
1 & 2.5K & 3.3 \\
\thinhline
4 & 2.5K & 2.5 \\
\thinhline
1 & 2.5M & 1.0 \\
\thinhline
4 & 2.0M & 0.5 \\
\thickhline
\end{tabularx}

\section{Antikernel Labs}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Notes} \\
\thickhline
Internal Logic Analyzer IP & akila & \\
\thickhline
BLONDEL Oscilloscope Prototype & aklabs & \\
\thickhline
\end{tabularx}

\subsection{akila}

This driver uses a raw binary protocol, not SCPI.

Under-development internal logic analyzer analyzer core for FPGA design debug. The ILA uses a UART interface to a host
system. Since there's no UART support in scopehal yet, socat must be used to bridge the UART to a TCP socket using
the ``lan" transport.

\subsection{aklabs}

This driver uses two TCP sockets. Port 5025 is used for SCPI control plane traffic, and port 50101 is used for waveform
data using a raw binary protocol.

\section{Demo}

The ``demo" driver is a simulation-only driver for development and training purposes, and does not connect to real
hardware.

It ignores any transport provided, and is normally used with the ``null" transport.

The demo instrument is intended to illustrate the usage of ngscopeclient for various types of analysis and to aid in
automated testing on computers which do not have a connection to a real oscilloscope, and is not intended to accurately
model the response or characteristics of real world scope frontends or signals.

It supports memory depths of 10K, 100K, 1M, and 10M points per waveform at rates of 1, 5, 10, 25, 50, and 100 Gsps.
Four test signals are provided, each with 10 mV of Gaussian noise and a 5 GHz low-pass filter added (although this can
be disabled under the channel properties)

Test signals:
\begin{itemize}
\item 1.000 GHz tone
\item 1.000 GHz tone mixed with a second tone, which sweeps from 1.100 to 1.500 GHz
\item 10.3125 Gbps PRBS-31
\item 1.25 Gbps repeating two 8B/10B symbols (K28.5 D16.2)
\end{itemize}

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
Simulator & demo & null & \\
\thickhline
\end{tabularx}

\section{Batronix}

A driver for Batronix Magnova oscilloscope is available in the codebase.
It has been developped, with the help of Batronix team, according to official SCPI documentation for Magnova oscilloscope
(Magnova® SCPI Manual - Version 1.5). This driver has been developed and tested on a Magnova BMO350 running firmware version 1.7.1.

Here are the known limitations of this driver (that should be fixed with further Magnova firmware updates):
\begin{itemize}

\item For now, Magnova's SCPI implementation does not support digital signal acquisition.

\item Selecting specific Arbitrary waveform from function generator is not possible with current Magnova SCPI implementation.

\item Time Scale / Memory Depth / Sample Rate synchronization only work if the scope is in "Extended Capture" mode (Acquire menu).

\end{itemize}

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
Magnova BMO & Batronix & lan & Connection path: <IP>:5025 \\
\thickhline
\end{tabularx}

\subsubsection{Typical Performance (Magnova BMO350, LAN)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
1 & 20K & 9.9 \\
\thinhline
2 & 10K & 6.6 \\
\thinhline
4 & 12.5K & 3.99 \\
\thinhline
1 & 100K & 9.7 \\
\thinhline
4 & 125K & 3.97 \\
\thinhline
1 & 5M & 4.5 \\
\thinhline
4 & 5M & 1.26 \\
\thickhline
\end{tabularx}

These figures were obtained from a Magnova BMO350 running firmware version 1.7.1.

\section{Digilent}

Digilent oscilloscopes using the WaveForms SDK are all supported using the ``digilent" driver in libscopehal. This
driver connects using the ``twinlan" transport to a \href{https://github.com/ngscopeclient/scopehal-waveforms-bridge}
{socket server} which links against the Digilent WaveForms SDK. This provides network transparency, and allows the
Digilent bridge server to be packaged separately for distribution and only installed by users who require it.

As of 2022-03-09, analog input channels on the Analog Discovery Pro and Analog Discovery 2 have been tested and are
functional, however only basic edge triggering is implemented so far. Analog inputs on other devices likely work,
however only these two have been tested to date.

Analog outputs, digital inputs, and digital outputs are currently unimplemented, but are planned to be added in the
future.

\subsection{digilent}

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
Electronics Explorer & digilent & twinlan & Not tested, but probably works\\
\thinhline
Analog Discovery & digilent & twinlan & Not tested, but probably works\\
\thinhline
Analog Discovery 2 & digilent & twinlan & No digital channel support \newline No analog output support\\
\thinhline
Analog Discovery Pro & digilent & twinlan & No digital channel support \newline No analog output support \\
\thinhline
Digital Discovery & digilent & twinlan & No digital channel support,\newline so pretty useless for now\\
\thickhline
\end{tabularx}

\subsubsection{Typical Performance (ADP3450, USB -> LAN)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
4 & 64K & 25.8 \\
\thinhline
2 & 64K & 32.3 \\
\thinhline
1 & 64K & 33.0 \\
\thickhline
\end{tabularx}

\section{DrAndyHaas}

\subsection{haasoscope pro}

HaasoscopePro is an affordable 2 GHz bandwidth 3.2 GS/s (expandable to 6.4 GS/s) 12-bit open-source open-hardware USB oscilloscope.
For more info see the \href{https://github.com/drandyhaas/HaasoscopePro}{HaasoscopePro github}.
This driver connects to a Haasoscope Pro GUI, which must first be running, over a LAN socket.
It supports ~50 Hz of update rate for moderate memory depth.

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Notes} \\
\thickhline
DrAndyHaas & haasoscope pro & lan on port 32001 \\
\thickhline
\end{tabularx}

\section{DreamSource Lab}

DreamSourceLabs oscilloscopes and logic analyzers supported in their fork of sigrok (``libsigrok4DSL'' distributed as part of
their ``DSView'' software package) are supported through the ``dslabs'' driver in libscopehal. This driver connects using
the ``twinlan'' transport to a \href{https://github.com/ngscopeclient/scopehal-sigrok-bridge}{socket server} which links
against libsigrok4DSL. This provides network transparency, and allows the DSLabs bridge server to be packaged separately for
distribution and only installed by users who require it.

As of 2022-03-22, a DSCope U3P100 and a DSLogic U3Pro16has been tested and works adequately. Other products may work
also, but are untested.

On DSCope: Only edge triggers are supported. `Any' edge is not supported. ``Ch0 \&\& Ch1'' and ``Ch0 || Ch1'' trigger modes
are not supported.

On DSLogic: Only edge triggers are supported. All edges are supported. There is currently no way to configure a trigger on more
than one channel. Serial / multi-stage triggers are not supported.

Known issues pending fixes/refactoring:
\begin{itemize}
	\item Interleaved sample rates are not correctly reported in the timebase dialog (but are in the waveform display)
	\item Trigger position is quantized to multiples of 1\% of total capture
	\item Non-localhost performance, and responsiveness in general may suffer as a result of hacky flow control on waveform capture
	\item DSLogic depth configuration is confusing and performance could be improved (currently only buffered more is supported)
	\item DSLogic devices trigger even if pre-trigger buffer has not been filled, leading to a small pre-trigger waveform in some cases
\end{itemize}

\subsection{dslabs}

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Family / Device} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
DScope U3P100 & dslabs & twinlan & Tested, works\\
\thinhline
DSLogic U3P16 & dslabs & twinlan & Tested, works\\
\thinhline
DSCope (others) & dslabs & twinlan & Not tested, but probably works\\
\thinhline
DSLogic (others) & dslabs & twinlan & Not tested, but probably works\\
\thickhline
\end{tabularx}

\subsubsection{Typical DSCope Performance (DSCope U3P100, USB3, localhost)}

\begin{tabularx}{16cm}{lllXX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{Sample Rate} & \textbf{WFM/s} & \textbf{UI-unconstrained WFM/s}\\
\thickhline
2 & 1M & 100MS/s & 14 & 50\\
\thinhline
2 & 5M & 500MS/s & 4.5 & 14\\
\thinhline
1 & 5M & 1GS/s & 8.3 & 32\\
\thickhline
\end{tabularx}

\subsubsection{Typical DSLogic Performance (DSLogic U3Pro16, USB3, localhost)}

\begin{tabularx}{16cm}{lllXX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{Sample Rate} & \textbf{WFM/s} & \textbf{UI-unconstrained WFM/s}\\
\thickhline
16 & 500k & 100MS/s & 16 & 44\\
\thinhline
16 & 500k & 500MS/s & 16 & 55\\
\thickhline
\end{tabularx}

\section{EEVengers}

\subsection{thunderscope}

This driver connects to the TS.NET application to control a ThunderScope.

It supports full-rate 1 Gsps streaming given suitably fast hardware.

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Notes} \\
\thickhline
ThunderScope & thunderscope & Use twinlan transport to TS.NET \\
\thickhline
\end{tabularx}

\section{Enjoy Digital}
TODO (\issue{scopehal}{79})

\section{Generic}

Drivers in this section are not specific to a particular manufacturer's products and support a wide variety of similar
devices.

\subsection{socketcan}
\label{driver:socketcan}

This driver exposes the Linux SocketCAN API as a stream of CAN messages which can be displayed as-is or used as input
to other filter graph blocks. When paired with the ``socketcan" transport and a suitable CAN peripheral, it allows
ngscopeclient to be used as a CAN bus protocol analyzer. Since SocketCAN is a Linux-only API, this driver is not
available on other platforms.

\section{Hantek}
TODO (\issue{scopehal}{26})

\section{Keysight}

Keysight devices support a similar similar SCPI command set across most device families. Many Keysight devices were
previously sold under the Agilent brand and use the same SCPI command set, so they are supported by the ``agilent"
driver.

Please see the table below for details of current hardware support:

\subsection{agilent}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Notes} \\
\thickhline
MSOX-2000 series & agilent &  \\
\thinhline
MSOX-3000 series & agilent &  \\
\thinhline
MSOX-3000T series & agilent &  \\
\thickhline
\end{tabularx}

\subsection{keysightdca}

A driver for the Keysight/Agilent/HP DCA series of equivalent-time sampling oscilloscopes.

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Notes} \\
\thickhline
86100A & keysightdca &  \\
\thickhline
\end{tabularx}

\section{Pico Technology}

Pico oscilloscopes all have slightly different command sets, but are supported using the ``pico" driver in libscopehal.
This driver connects via the ``twinlan" transport to a socket server
\href{https://github.com/ngscopeclient/scopehal-pico-bridge}{scopehal-pico-bridge} which connects to the appropriate
instrument using Pico's binary SDK.

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Notes} \\
\thickhline
2000 series & pico & 2205 MSO, 2206, 2207, 2208 only\\
\thinhline
2000A series & pico & 2204A and 2205A not supported yet\\
\thinhline
2000B series & pico & \\
\thinhline
3000 series & pico & 3204/5/6 MSO only\\
\thinhline
3000A series & pico & \\
\thinhline
3000B series & pico & \\
\thinhline
3000C series & pico & \\
\thinhline
3000D series & pico & \\
\thinhline
4000 series & pico & 4444 and 4824 only\\
\thinhline
4000A series & pico & \\
\thinhline
5000A series & pico & \\
\thinhline
5000B series & pico & \\
\thinhline
5000D series & pico & \\
\thinhline
6000E series & pico & \\
\thickhline
\end{tabularx}

\subsection{pico}

\subsubsection{Typical Performance (6824E, LAN)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
8 & 1M & 15.2 \\
\thinhline
4 & 1M & 30.5 \\
\thinhline
2 & 1M & 64.4 \\
\thinhline
1 & 10M & 12.2 \\
\thinhline
1 & 50M & 3.03 \\
\thickhline
\end{tabularx}

\section{Rigol}

Rigol oscilloscopes have subtle differences in SCPI command set, but this is implemented with quirks handling in the
driver rather than needing different drivers for each scope family.

NOTE: DS1054Z firmware 00.04.02.SP4 is known to have problems with SCPI remote control
(https://github.com/ngscopeclient/scopehal-apps/issues/790); it is unclear what other models and firmware versions may
be affected by this bug. If you encounter problems, please ensure your scope is running the latest firmware release
from Rigol before opening a support ticket.

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Notes} \\
\thickhline
DS1100D/E & rigol & \\
\thinhline
DS1000Z & rigol & \\
\thinhline
MSO5000 & rigol & \\
\thinhline
DHO800 & rigol & \\
\thinhline
DHO900 & rigol & (no digital channels)\\
\thinhline
DHO1000 & rigol & (untested)\\
\thinhline
DHO4000 & rigol & (untested)\\
\thickhline
\end{tabularx}

\subsection{rigol}

\subsubsection{Typical Performance (MSO5000 series, LAN)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
4 & 10K & 0.96 \\
\thinhline
4 & 100K & 0.91 \\
\thinhline
4 & 1M & 0.59\\
\thinhline
4 & 10M & 0.13\\
\thinhline
1 & 100M & 0.0601\\
\thinhline
4 & 25M & 0.0568\\
\thinhline
2 & 50M & 0.0568\\
\thickhline
\end{tabularx}

\subsubsection{Typical Performance (DHO800/900 series, LAN)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
1 & 1K & 11.9 (live mode available for 1Kpt/single channel)\\
\thinhline
2 & 1K & 3.4 \\
\thinhline
4 & 1K & 1.66 \\
\thinhline
1 & 10K & 3.31 \\
\thinhline
2 & 10K & 2.90 \\
\thinhline
4 & 10K & 1.65 \\
\thinhline
1 & 100K & 3.30 \\
\thinhline
4 & 100K & 1.64 \\
\thinhline
1 & 1M & 1.63 \\
\thinhline
4 & 1M & 0.57 \\
\thinhline
1 & 10M & 0.30 \\
\thinhline
4 & 10M & 0.07 \\
\thickhline
\end{tabularx}

\section{Rohde \& Schwarz}

\subsection{rs}

There is partial support for RTM3000 (and possibly others, untested) however it appears to have bitrotted.

TODO (\issue{scopehal}{59})

\subsection{rs\_rto6}

This driver supports the newer RTO6 family scopes (and possibly others, untested).

\subsection{rs\_rtb2k}

A driver for RTB2000 and RTB2 oscilloscope.
Analog and digital channels are supported. An external trigger and a line trigger are available.
The function generator can be used with some restrictions.

Here is a list of notes on how to use it:
\begin{itemize}

\item The bit depth can be changed between 8 bits and 16 bits in the driver settings.

\item The selection lists with the sample rate and memory depth only work correctly with a fixed memory depth.

\item Entries in the selection list for the memory depth are rounded up, resulting in several identical entries.

\item When the oscilloscope is in Run mode and connected to ngscopeclient, data acquisition starts automatically.

\item When connecting the oscilloscope with line trigger to ngscopeclient, a trigger channel must be selected before changing the trigger. Otherwise, the program will crash.

\item The progress bar for downloading digital channels is only displayed for one channel.

\item If only the first logic probe is connected, only these 8 channels are displayed. The second logic probe is not recognized during operation.

\item The triggers for pattern and bus are missing.

\end{itemize}

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
RTB & rs.rtb2k & lan & Connection path: <IP>:5025 \\
\thickhline
\end{tabularx}

\subsubsection{Typical Performance (RTB2000, LAN)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
1 & 10K & 3.4 \\
\thinhline
2 & 10K & 2.6 \\
\thinhline
4 & 10K & 1.8 \\
\thinhline
1 & 100K & 2.6 \\
\thinhline
2 & 100K & 2.0 \\
\thinhline
4 & 100K & 1.4 \\
\thinhline
4 & 1M & 0.3 \\
\thickhline
\end{tabularx}

These figures were obtained from a RTB2000 running firmware version 3.000 on an Raspberry Pi 500.

\section{Saleae}
TODO (\issue{scopehal}{16})

\section{Siglent}

A driver for SDS2000X+/HD is available in the codebase which has been developed according to Siglent offical documentation
(Programming Guide PG01-E11A). This driver should be functional across the 'next generation' SDS800X HD, SDS1000X HD, SDS2000X+,
SDS2000X HD, SDS5000X, SDS6000A/L/Pro and SDS7000A scopes. It has been primarily developed using the SDS2000X+ and SDS2000X HD.
Some older generation scopes are supported as well.

Digital channels are not supported on any scope yet, due to lack of an MSO probe to test with. Many trigger types are
not yet supported.

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
SDS1000X-E series & siglent & lan & Initialises, triggers and downloads waveforms. More testing needed \\
\thinhline
SDS2000X-E series & siglent & lan & Initialises, triggers and downloads waveforms. More testing needed \\
\thickhline
SDS800X HD series & siglent & lan & Basic functionality complete/tested. \\
\thinhline
SDS1000X HD series & siglent & lan & Basic functionality complete, needs testing. \\
\thinhline
SDS2000X+ series & siglent & lan & Basic functionality complete. \\
\thinhline
SDS2000X HD series & siglent & lan & Tested and works well on SDS2354x HD. \\
\thinhline
SDS3000X HD series & siglent & lan & Basic functionality complete, needs testing. \\
\thinhline
SDS5000X series & siglent & lan & Initialises, triggers and downloads waveforms. More testing needed \\
\thinhline
SDS6000A/L/Pro series & siglent & lan & Tested and works well on SDS6204A. 10/12 bit models NOT supported, but unavailable for dev (not sold in western markets). \\
\thinhline
SDS7000A series & siglent & lan & Basic functionality complete, needs testing. \\
\thickhline
\end{tabularx}

\subsubsection{Typical Performance (SDS2104X+, LAN)}

\begin{figure}[h]
\centering
\includegraphics[width=16cm]{images/siglent-samples.png}
\caption{Siglent sample speed for various combinations of depth and channels}
\label{siglent_sample}
\end{figure}


\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
1 & 5-100K & 2.3 \\
\thinhline
2 & 5-100K & 1.6 \\
\thinhline
3 & 5-100K & 1.2 \\
\thinhline
4 & 5-100K & 1 \\
\thinhline
1 & 10M & 0.5 \\
\thinhline
2-4 & 10M & 0.15 \\
\thickhline
\end{tabularx}

These figures were obtained from a SDS2104X+ running firmware version 1.3.7R5. Different scopes and software
revisions may vary.

\subsubsection{Typical Performance (SDS2104X HD, LAN)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
1 & 10K & 8.2 \\
\thinhline
2 & 10K & 7.7 \\
\thinhline
4 & 10K & 5.4 \\
\thinhline
1 & 100K & 7.1 \\
\thinhline
4 & 100K & 4.2 \\
\thinhline
1 & 5M & 0.72 \\
\thinhline
4 & 5M & 0.09 \\
\thickhline
\end{tabularx}

These figures were obtained from a SDS2104X HD running firmware version 1.2.2.9.

\section{Teledyne LeCroy / LeCroy}

Teledyne LeCroy (and older LeCroy) devices use the same driver, but two different transports for LAN connections.

While all Teledyne LeCroy / LeCroy devices use almost identical SCPI command sets, Windows based devices running
XStream or MAUI use a custom framing protocol (``vicp") around the SCPI data while the lower end RTOS based devices use
raw SCPI over TCP (``lan").

Please see the table below for details on which configuration to use with  your hardware.

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
DDA & lecroy & vicp & Tested on DDA5000A series \\
\thinhline
HDO & lecroy & vicp & Tested on HDO9000 series \\
\thinhline
LabMaster & lecroy & vicp & Untested, but should work for 4-channel setups\\
\thinhline
MDA & lecroy & vicp & Untested, but should work\\
\thinhline
SDA & lecroy & vicp & Tested on SDA 8Zi and 8Zi-A series\\
\thinhline
T3DSO & ??? & ??? & Untested\\
\thinhline
WaveAce & ??? & ??? & Untested\\
\thinhline
WaveJet & ??? & ??? & Untested\\
\thinhline
WaveMaster & lecroy & vicp & Same hardware as SDA/DDA\\
\thinhline
WaveRunner & lecroy & vicp & Tested on WaveRunner Xi, 8000, and 9000 series\\
\thinhline
WaveSurfer & lecroy & vicp & Tested on WaveSurfer 3000 series \\
\thickhline
\end{tabularx}

\subsection{lecroy}

This is the primary driver for MAUI based Teledyne LeCroy / LeCroy devices.

This driver has been tested on a wide range of Teledyne LeCroy / LeCroy hardware. It should be compatible with any
Teledyne LeCroy or LeCroy oscilloscope running Windows XP or newer and the MAUI or XStream software.

\subsubsection{Typical Performance (HDO9204, VICP)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
1 & 100K & >50 \\
\thinhline
1 & 400K & 29 - 35 \\
\thinhline
2 & 100K & 30 - 40 \\
\thinhline
4 & 100K & 17 - 21 \\
\thinhline
1 & 2M & 9 - 11 \\
\thinhline
1 & 10M & 2.2 - 2.6 \\
\thinhline
4 & 1M & 5.2 - 6.5 \\
\thinhline
1 & 64M & 0.41 - 0.42 \\
\thinhline
2 & 64M & 0.21 - 0.23 \\
\thinhline
4 & 64M & 0.12 - 0.13 \\
\thickhline
\end{tabularx}

\subsubsection{Typical Performance (WaveRunner 8404M-MS, VICP)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
1 & 80K & 35 - 45 \\
\thinhline
2 & 80K & 35 - 45 \\
\thinhline
2 & 800K & 16 - 17 \\
\thinhline
2 & 8M & 3.1 - 3.2 \\
\thickhline
\end{tabularx}

\subsection{lecroy\_fwp}

This is a special performance-enhanced extension of the base ``lecroy" driver which takes advantage of the FastWavePort
feature of the instrument to gain high speed access to waveform data via shared memory. Waveforms are pulled from
shared memory when a synchronization event fires, then pushed to the client via a separate TCP socket on port 1862.

On low latency LANs, typical performance increases observed with SDA 8Zi series instruments are on the order of 2x
throughput vs using the base driver downloading waveforms via SCPI. On higher latency connections such as VPNs, the
performance increase is likely to be even higher because the push-based model eliminates the need for polling (which
performs increasingly poorly as latency increases).

To use this driver, your instrument must have the XDEV software option installed and the
\href{https://github.com/ngscopeclient/scopehal-fwp-bridge}{scopehal-fwp-bridge} server application running. If the
bridge or option are not detected, the driver falls back to SCPI waveform download and will behave identically to the
base ``lecroy" driver.

There are some limitations to be aware of with this driver:
\begin{itemize}

\item Maxmimum memory depth is limited to no more than 40M samples per channel, regardless of installed instrument
memory. This is an architectural limitation of the FastWavePort API; the next generation FastMultiWavePort API eliminates
this restriction however scopehal-fwp-bridge does not yet support it due to poor documentation.

\item MSO channels are not supported, because neither FastWavePort nor FastMultiWavePort provide shared memory access to
digital channel data. There is no known workaround for this given current instrument APIs.

\item A maximum of four analog channels are supported even if the instrument actually has eight. There are no major
technical blockers to fixing this under FastWavePort however no 8-channel instruments are available to the developers as
of this writing, so there is no way to test potential fixes. FastMultiWavePort has a limit of four channels per instance,
but it may be possible to instantiate multiple copies of the FastMultiWavePort block to work around this.

\item Math functions F9-F12 are used by the FastWavePort blocks and cannot be used for other math functions.

\end{itemize}

\section{Tektronix}

This driver is being primarily developed on a MSO64. It supports SCPI over LXI VXI-11 or TCP sockets.

The hardware supports USBTMC, however waveform download via USBTMC does not work with libscopehal for unknown reasons.

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
MSO5 series & tektronix & lan, lxi &  \\
\thinhline
MSO6 series & tektronix & lan, lxi &  \\
\thickhline
\end{tabularx}

\subsection{Note regarding ``lan" transport on MSO5/6}

The default settings for raw SCPI access on the MSO6 series use a full terminal emulator rather than raw SCPI
commands. To remove the prompts and help text, go to Utility | I/O, then under the Socket Server panel select protocol
``None" rather than the default of ``Terminal".

\subsubsection{Typical Performance (MSO64, LXI, embedded OS)}

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
\thickhline
1 & 50K & 10.3 - 11.4 \\
\thinhline
2 & 50K & 6.7 - 7.2 \\
\thinhline
4 & 50K & 5.1 - 5.3 \\
\thinhline
1 & 500K & 8.7 - 9.5 \\
\thinhline
4 & 500K & 3.8 - 3.9 \\
\thickhline
\end{tabularx}

\section{tinySA}

This driver is meant to be used with tinySA and tinySA ULTRA spectrum analyzers.

It has been developed and tested on a tinySA ULTRA.

The communication with the device is made with UART transport layer.

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Device Family} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
tinySA  & tiny\_sa & uart & Not tested but should work \\
\thinhline
tinySA ULTRA & tiny\_sa & uart & Driver tested on this device \\
\thickhline
\end{tabularx}

\section{Xilinx}
TODO (\issue{scopehal}{40})