ngscopeclient · May 17, 2021
Showing with 33 additions and 31 deletions.

+18 −12 section-drivers.tex

+14 −18 section-gettingstarted.tex

+1 −1 section-legal.tex
diff --git a/section-drivers.tex b/section-drivers.tex
@@ -126,15 +126,16 @@ \section{Demo}
 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 added. As of now, there is no way to configure the
-simulated signal generator.
+Five 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)
+\item Step from 0 to 1V
 \end{itemize}
 
 \begin{tabularx}{16cm}{lllX}
@@ -186,7 +187,9 @@ \section{Pico Technologies}
 \thickhline
 \textbf{Device Family} & \textbf{Driver} & \textbf{Notes} \\
 \thickhline
-6000 series & pico & Early development, incomplete support \\
+3000D series & pico & Early development, incomplete\\
+\thinhline
+6000E series & pico & \\
 \thickhline
 \end{tabularx}
 
@@ -198,9 +201,15 @@ \subsubsection{Typical Performance (6824E, LAN)}
 \thickhline
 \textbf{Channels} & \textbf{Memory depth} & \textbf{WFM/s}\\
 \thickhline
-4 & FIXME & FIXME \\
+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}
 
@@ -259,8 +268,8 @@ \section{Saleae}
 \section{Siglent}
 
 A driver for SDS2000X+ 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' SDS2000X+, SDS5000X and SDS6000X
-scopes . It has been developed using the SDS2000X+.
+(Programming Guide PG01-E11A). This driver should be functional across the 'next generation' SDS2000X+, SDS5000X and
+SDS6000X scopes . It has been developed using the SDS2000X+.
 
 An old Siglent driver with significant bitrot is available in the git archive if required.\\
 
@@ -313,9 +322,6 @@ \subsubsection{Typical Performance (SDS2104X+, LAN)}
 revisions may vary. This series of scopes support sample depths up to 100MPoints, but depths beyond 10MPoints
 require a different software interface and are likely to be extremely slow, so have not yet been implemented.
 
-
-
-
 \section{Teledyne LeCroy / LeCroy}
 
 Teledyne LeCroy (and older LeCroy) devices use the same driver, but two different transports for LAN connections.
@@ -338,15 +344,15 @@ \section{Teledyne LeCroy / LeCroy}
 \thickhline
 MDA & lecroy & vicp & Untested, but should work\\
 \thickhline
-SDA & lecroy & vicp & Untested, but should work\\
+SDA & lecroy & vicp & Tested on SDA 8Zi series\\
 \thickhline
 T3DSO & ??? & ??? & Untested\\
 \thickhline
 WaveAce & ??? & ??? & Untested\\
 \thickhline
 WaveJet & ??? & ??? & Untested\\
 \thickhline
-WaveMaster & lecroy & vicp & Untested, but should work \\
+WaveMaster & lecroy & vicp & \\
 \thickhline
 WaveRunner & lecroy & vicp & Tested on WaveRunner Xi and 8000 series\\
 \thickhline

diff --git a/section-gettingstarted.tex b/section-gettingstarted.tex
@@ -18,13 +18,13 @@ \section{Documentation Conventions}
 
 \section{Host System Requirements}
 
-All current development is performed on Linux operating systems (primarily Debian and Arch), although experimental (and
-incomplete) Windows support is provided. glscopeclient uses gtkmm as the UI toolkit. Current development mostly uses
-3.24 but any recent 3.x version should work.
+The majority of development is performed on Linux operating systems (primarily Debian and Arch), although experimental
+Windows support is available. glscopeclient uses gtkmm as the UI toolkit. Current development mostly uses 3.24 but any
+recent 3.x version should work.
 
-Any 64-bit ARM or Intel processor should be able to run glscopeclient. If AVX2 support is present glscopeclient will
-use special optimized versions of some signal processing functions, however AVX2 is not required. AVX512 is not
-currently used.
+Any 64-bit Intel or AMD processor should be able to run glscopeclient. If AVX2 and/or AVX512F support is present
+glscopeclient will use special optimized versions of some signal processing functions, however neither instruction set
+is required. Compiling in 32-bit mode is not supported due to the significant RAM requirements.
 
 A mouse with scroll wheel, or touchpad with scroll gesture support, is mandatory to enable full use of the UI. We may
 explore alternative input methods for some UI elements in the future.
@@ -41,7 +41,7 @@ \section{Host System Requirements}
 Intel Skylake or newer integrated GPU, plus suitably up-to-date drivers. On Linux with recent Mesa, Intel integrated
 GPUs as old as Ivy Bridge may be used.
 
-TODO: what AMD integrated/ARM GPUs started supporting GL 4.2.
+TODO: what AMD integrated/ARM GPUs started supporting GL 4.2?
 
 To check for necessary graphics card support on Linux:
 \begin{lstlisting}[language=sh]
@@ -56,8 +56,8 @@ \section{Host System Requirements}
 detected GPU is automatically used; there may be a way to select specific devices in the future.
 
 The minimum RAM requirement to actually launch glscopeclient is relatively small (TODO: do some testing) however
-history mode and deep captures can easily consume many GB of RAM. We suggest 8GB as a reasonable minimum, with 32 or
-more encouraged for deep history.
+history mode and deep captures can easily consume many GB of RAM very rapidly. We suggest 8GB as a reasonable minimum,
+with 32 or more encouraged for deep history.
 
 \section{Instrument Support}
 
@@ -110,12 +110,14 @@ \subsection{Linux}
 cd scopehal-apps
 mkdir build
 cd build
-cmake ../
+cmake ../ -DCMAKE_BUILD_TYPE=RELEASE -DCMAKE_INSTALL_PREFIX=/usr
 make -j4
 \end{lstlisting}
 
-\item Install scopehal and scopehal-apps: right now, you don't. As of now, glscopeclient is intended to be run from the
-glscopeclient source directory (src/glscopeclient). Anybody want to contribute and set up a proper install process?
+\item Install scopehal and scopehal-apps
+\begin{lstlisting}[language=sh]
+make install
+\end{lstlisting}
 
 \end{enumerate}
 
@@ -242,8 +244,6 @@ \section{Running glscopeclient}
 typically a hostname:port combination, TTY device path, or similar.
 \end{itemize}
 
-Some users have reported better performance by setting the OMP\_WAIT\_POLICY environment variable to PASSIVE.
-
 \section{Design Philosophy}
 
 glscopeclient's UI is heavily mouse driven and context based. Space used by always-visible buttons, sliders, etc is
@@ -257,10 +257,6 @@ \section{Design Philosophy}
 
 \section{Troubleshooting}
 
-\subsection{Poor performance or hangs}
-
-Ensure the OMP\_WAIT\_POLICY environment variable is set to PASSIVE.
-
 \subsection{Corrupted or no graphical output in waveform areas}
 
 Some users have reported problems with libglvnd under Linux. Changing the CMP0072 declaration in

diff --git a/section-legal.tex b/section-legal.tex
@@ -8,7 +8,7 @@ \section{Introduction}
 
 \section{License Agreement}
 
-Copyright (c) 2012-2020 Andrew D. Zonenberg and contributors.
+Copyright (c) 2012-2021 Andrew D. Zonenberg and contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the