Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: ngscopeclient/scopehal-docs
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 34d289216dda
Choose a base ref
...
head repository: ngscopeclient/scopehal-docs
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: f3830598a737
Choose a head ref
  • 2 commits
  • 5 files changed
  • 1 contributor

Commits on Dec 13, 2020

  1. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    36ede52 View commit details
  2. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    f383059 View commit details
Showing with 42 additions and 4 deletions.
  1. +7 −0 glscopeclient-manual.tex
  2. BIN images/proto-analyzer.png
  3. +5 −3 section-history.tex
  4. +28 −0 section-protoanalyzer.tex
  5. +2 −1 section-waveformviews.tex
7 changes: 7 additions & 0 deletions glscopeclient-manual.tex
Original file line number Diff line number Diff line change
@@ -45,6 +45,13 @@
\definecolor{error}{HTML}{ff0000}
\definecolor{idle}{HTML}{404040}

\definecolor{protocmd}{HTML}{600050}
\definecolor{protoctl}{HTML}{808000}
\definecolor{protoread}{HTML}{336699}
\definecolor{protowrite}{HTML}{339966}
\definecolor{protoerror}{HTML}{800000}
\definecolor{protostatus}{HTML}{000080}

% table lines
\newcommand{\thinhline}{\Xhline{1\arrayrulewidth}}
\newcommand{\thickhline}{\Xhline{2.5\arrayrulewidth}}
Binary file modified images/proto-analyzer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 5 additions & 3 deletions section-history.tex
Original file line number Diff line number Diff line change
@@ -5,8 +5,8 @@ \chapter{History View}
see previous state of the system being debugged. Clicking on a timestamp in the history view pauses acquisition and
loads the historical waveform data for analysis.

By default, the history view (Fig. \ref{historyview}) is not displayed and no history is captured. If the history view
is closed, history continues to be captured up to the configured maximum history depth.
By default, the history view (Fig. \ref{historyview}) is not displayed and history is limited to ten waveforms. If the
history view is closed, history continues to be captured up to the configured maximum history depth.

\begin{figure}[H]
\centering
@@ -38,8 +38,10 @@ \section{Estimating Waveform Memory Usage}
history depth given sufficient disk space.

Digital waveforms use one byte per sample for the actual measurement, so 17 MB per channel for a 1M point waveform.
Most logic analyzer or MSO drivers for libscopehal will perform automatic de-duplication when a waveform goes several
clock cycles with no toggles, so the actual memory usage is likely to be significantly less than this.

Filter memory usage varies depending on the specific fitler in question, however it is typically not a large
Filter memory usage varies depending on the specific filter in question, however it is typically not a large
contributor to the overall glscopeclient RAM footprint when using history mode because filters are evaluated
dynamically each time a waveform is pulled from history rather than having output cached for every historical waveform.
Thus, at most one copy of each filter's output is present in memory regardless of history depth.
28 changes: 28 additions & 0 deletions section-protoanalyzer.tex
Original file line number Diff line number Diff line change
@@ -10,6 +10,10 @@ \chapter{Protocol Analyzer View}
waveform, and scrolls the waveform view containing the protocol decode to the start of the packet. This allows
packet-level data to be easily correlated to physical layer waveforms.

If a vertical cursor is active in the waveform area displaying the protocol decode, clicking on a packet in the
analyzer view moves the cursor to the start of the packet. Placing the cursor on a packet highlights the corresponding
row in the protocol analyzer.

\begin{figure}[H]
\centering
\includegraphics[width=14cm]{images/proto-analyzer.png}
@@ -19,3 +23,27 @@ \chapter{Protocol Analyzer View}

Once closed, the protocol analyzer view may be reopened by selecting the protocol of interest from the
\menustyle{Window / Analyzer} menu.

Protocol packets are color coded according to the high-level function of the packet.

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Color name} & \textbf{Use case} & \textbf{Default Color} \\
\thickhline
Command & Executing commands & \cellcolor{protocmd}\textcolor{white}{\#600050} \\
\thickhline
Control & Changing configuration & \cellcolor{protoctl}\textcolor{white}{\#808000} \\
\thickhline
Data read & Reading data & \cellcolor{protoread}\textcolor{white}{\#336699} \\
\thickhline
Data write & Writing data & \cellcolor{protowrite}\textcolor{white}{\#339966} \\
\thickhline
Error & Malformed, bad checksum & \cellcolor{protoerror}\textcolor{white}{\#ff0000} \\
\thickhline
Status & Status updates, flow control & \cellcolor{protostatus}\textcolor{white}{\#000080} \\
\thickhline
\end{tabularx}

Many filters group related packets (request and reply, escape sequences, polling loops, etc) under a single heading to
enable easier navigation of large datasets. The tree expansion button at the left of the timestamp column may be used to expand
the event into its constituent packets.
3 changes: 2 additions & 1 deletion section-waveformviews.tex
Original file line number Diff line number Diff line change
@@ -7,7 +7,8 @@ \section{Navigation}
Scrolling with the mouse wheel adjusts the horizontal scale of the current waveform group, zooming in or out centered
on the position of the mouse cursor.

Pressing SHIFT while scrolling moves the view left and right without adjusting zoom.
Pressing SHIFT while scrolling moves the view left and right without adjusting zoom. If your mouse has a horizontal
scroll feature, this may also be used to pan without zooming.

\section{Plot Area}