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: f87b59d3ebb9
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: 77d48a7ec7c4
Choose a head ref
  • 1 commit
  • 3 files changed
  • 1 contributor

Commits on Jun 29, 2020

  1. Copy the full SHA
    77d48a7 View commit details
Showing with 55 additions and 3 deletions.
  1. +1 −1 glscopeclient-manual.tex
  2. +52 −2 section-decodes.tex
  3. +2 −0 section-mainwindow.tex
2 changes: 1 addition & 1 deletion glscopeclient-manual.tex
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@
\usepackage{paralist}
\usepackage{makecell}
\usepackage{colortbl}
\usepackage[osf]{libertine}
%\usepackage[osf]{libertine}
\usepackage{zi4}
\usepackage{float}
\usepackage[libertine,cmbraces]{newtxmath}
54 changes: 52 additions & 2 deletions section-decodes.tex
Original file line number Diff line number Diff line change
@@ -67,9 +67,10 @@ \subsubsection{Conventions}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pagebreak
\subsection{8B/10B (IBM)}
\label{proto:8b10b}

Decodes the standard 8b/10b line code used by SGMII, 1000base-X, DisplayPort, JESD204B, PCIe gen 1/2, SATA, USB 3.0,
and many other common serial protocols.
Decodes the standard 8b/10b line code used by SGMII, \hyperref[proto:1000basex]{1000base-X}, DisplayPort, JESD204,
PCIe gen 1/2, SATA, USB 3.0, and many other common serial protocols.

\begin{tabularx}{16cm}{llX}
\thickhline
@@ -335,6 +336,55 @@ \subsection{Ethernet - 10baseT}
\pagebreak
\subsection{Ethernet - 100baseTX}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pagebreak
\subsection{Ethernet - 1000baseX}
\label{proto:1000basex}

Decodes the 1000base-X Ethernet PCS as specified in IEEE 802.3 clause 36.

\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Signal name} & \textbf{Type} & \textbf{Description} \\
\thickhline
data & 8b/10b & Output of \hyperref[proto:8b10b]{8b/10b protocol decode}\\
\thickhline
\end{tabularx}

\subsubsection{Parameters}

This filter takes no parameters.

\subsubsection{Output Signal}

The 1000base-X filter outputs a series of Ethernet frame segment objects.

\begin{tabularx}{16cm}{lllX}
\thickhline
\textbf{Type} & \textbf{Description} & \textbf{Color} & \textbf{Format} \\
\thickhline
Preamble & Preamble & \cellcolor{preamble}\textcolor{white}{Preamble} & PREAMBLE \\
\thickhline
Preamble & Start of frame delimiter & \cellcolor{preamble}\textcolor{white}{Preamble} & SFD \\
\thickhline
Address & Src/dest MAC & \cellcolor{address}\textcolor{black}{Address} & 02:00:11:22:33:44 \\
\thickhline
Control & Ethertype & \cellcolor{control}\textcolor{white}{Control} & Type: IPv4 \newline Type: 0xbeef \\
\thickhline
Control & VLAN tag & \cellcolor{control}\textcolor{white}{Control} & FIXME \\
\thickhline
Data & Frame data & \cellcolor{data}\textcolor{white}{Data} & a5 \\
\thickhline
Checksum OK & Valid FCS & \cellcolor{checksumok}\textcolor{black}{Checksum OK} & CRC: 0xdeadbeef \\
\thickhline
Checksum Bad & Invalid FCS & \cellcolor{checksumbad}\textcolor{white}{Checksum Bad} & CRC: 0xbaadc0de \\
\thickhline
Error & Malformed data & \cellcolor{error}\textcolor{white}{Error} & ERROR \\
\thickhline
\end{tabularx}

TODO: Document protocol analyzer output

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\pagebreak
\subsection{Ethernet - GMII}
2 changes: 2 additions & 0 deletions section-mainwindow.tex
Original file line number Diff line number Diff line change
@@ -25,6 +25,8 @@ \subsubsection{Setup}

This menu allows instrument settings to be configured. Currently there's not much here.

TODO: Document scope sync wizard, trigger dialog, and halt conditions

\subsubsection{View}

This menu allows display settings to be configured. As of now, the only option is selection of the color palette for