\hypertarget{gdump_8c}{
\section{gdump.c File Reference}
\label{gdump_8c}\index{gdump.c@{gdump.c}}
}
Implements hardware register methods.  


{\tt \#include \char`\"{}GNAT/gnat.h\char`\"{}}\par
{\tt \#include \char`\"{}GNAT/log.h\char`\"{}}\par
{\tt \#include \char`\"{}GNAT/gerr.h\char`\"{}}\par
{\tt \#include \char`\"{}GNAT/gdump.h\char`\"{}}\par
{\tt \#include \char`\"{}gnat\_\-p.h\char`\"{}}\par
\subsection*{Functions}
\begin{CompactItemize}
\item 
int \hyperlink{gdump_8c_a1}{g\-Dump\-Ctrl\-Reg} (\hyperlink{struct__gnat}{gnat\-Handle} gh, \hyperlink{log_8h_a12}{LOG\_\-level} l\-Level)
\begin{CompactList}\small\item\em logs the contents of the control register \item\end{CompactList}\item 
int \hyperlink{gdump_8c_a2}{g\-Dump\-Stat\-Reg} (\hyperlink{struct__gnat}{gnat\-Handle} gh, \hyperlink{log_8h_a12}{LOG\_\-level} l\-Level)
\begin{CompactList}\small\item\em logs the contents of the status register \item\end{CompactList}\item 
int \hyperlink{gdump_8c_a3}{g\-Dump\-PFReg} (\hyperlink{struct__gnat}{gnat\-Handle} gh)
\begin{CompactList}\small\item\em logs the contents of the play back FIFO register \item\end{CompactList}\item 
int \hyperlink{gdump_8c_a4}{g\-Dump\-RFReg} (\hyperlink{struct__gnat}{gnat\-Handle} gh)
\begin{CompactList}\small\item\em logs the contents of the record back FIFO register \item\end{CompactList}\item 
int \hyperlink{gdump_8c_a5}{g\-Dump\-Int\-Reg} (\hyperlink{struct__gnat}{gnat\-Handle} gh, \hyperlink{log_8h_a12}{LOG\_\-level} l\-Level)
\begin{CompactList}\small\item\em logs the contents of the interrupt config register \item\end{CompactList}\item 
int \hyperlink{gdump_8c_a6}{g\-Dump\-All} (\hyperlink{struct__gnat}{gnat\-Handle} gh)
\begin{CompactList}\small\item\em dumps the contents of the control and status registers \item\end{CompactList}\end{CompactItemize}
\subsection*{Variables}
\begin{CompactItemize}
\item 
\hypertarget{gdump_8c_a0}{
\hyperlink{struct__sLog}{log\-Handle} \hyperlink{gdump_8c_a0}{h\-Log}}
\label{gdump_8c_a0}

\begin{CompactList}\small\item\em file local log handle \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Implements hardware register methods. 

\begin{Desc}
\item[Author:]Curt Brune -- \href{mailto:curt@slac.stanford.edu}{\tt curt@slac.stanford.edu} \end{Desc}


\subsection{Function Documentation}
\hypertarget{gdump_8c_a6}{
\index{gdump.c@{gdump.c}!gDumpAll@{gDumpAll}}
\index{gDumpAll@{gDumpAll}!gdump.c@{gdump.c}}
\subsubsection[gDumpAll]{\setlength{\rightskip}{0pt plus 5cm}int g\-Dump\-All (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh})}}
\label{gdump_8c_a6}


dumps the contents of the control and status registers 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]handle of device \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]OK if successful \end{Desc}
\hypertarget{gdump_8c_a1}{
\index{gdump.c@{gdump.c}!gDumpCtrlReg@{gDumpCtrlReg}}
\index{gDumpCtrlReg@{gDumpCtrlReg}!gdump.c@{gdump.c}}
\subsubsection[gDumpCtrlReg]{\setlength{\rightskip}{0pt plus 5cm}int g\-Dump\-Ctrl\-Reg (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh}, \hyperlink{log_8h_a12}{LOG\_\-level} {\em l\-Level})}}
\label{gdump_8c_a1}


logs the contents of the control register 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]handle of device \item[{\em l\-Level}]logging level \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]OK if successful \end{Desc}
\hypertarget{gdump_8c_a5}{
\index{gdump.c@{gdump.c}!gDumpIntReg@{gDumpIntReg}}
\index{gDumpIntReg@{gDumpIntReg}!gdump.c@{gdump.c}}
\subsubsection[gDumpIntReg]{\setlength{\rightskip}{0pt plus 5cm}int g\-Dump\-Int\-Reg (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh}, \hyperlink{log_8h_a12}{LOG\_\-level} {\em l\-Level})}}
\label{gdump_8c_a5}


logs the contents of the interrupt config register 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]handle of device \item[{\em l\-Level}]logging level \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]OK if successful \end{Desc}
\hypertarget{gdump_8c_a3}{
\index{gdump.c@{gdump.c}!gDumpPFReg@{gDumpPFReg}}
\index{gDumpPFReg@{gDumpPFReg}!gdump.c@{gdump.c}}
\subsubsection[gDumpPFReg]{\setlength{\rightskip}{0pt plus 5cm}int g\-Dump\-PFReg (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh})}}
\label{gdump_8c_a3}


logs the contents of the play back FIFO register 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]handle of device \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]OK if successful \end{Desc}
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING

Reading the FIFO is a destructive read \hypertarget{gdump_8c_a4}{
\index{gdump.c@{gdump.c}!gDumpRFReg@{gDumpRFReg}}
\index{gDumpRFReg@{gDumpRFReg}!gdump.c@{gdump.c}}
\subsubsection[gDumpRFReg]{\setlength{\rightskip}{0pt plus 5cm}int g\-Dump\-RFReg (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh})}}
\label{gdump_8c_a4}


logs the contents of the record back FIFO register 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]handle of device \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]OK if successful \end{Desc}
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING

Reading the FIFO is a destructive read \hypertarget{gdump_8c_a2}{
\index{gdump.c@{gdump.c}!gDumpStatReg@{gDumpStatReg}}
\index{gDumpStatReg@{gDumpStatReg}!gdump.c@{gdump.c}}
\subsubsection[gDumpStatReg]{\setlength{\rightskip}{0pt plus 5cm}int g\-Dump\-Stat\-Reg (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh}, \hyperlink{log_8h_a12}{LOG\_\-level} {\em l\-Level})}}
\label{gdump_8c_a2}


logs the contents of the status register 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em gh}]handle of device \item[{\em l\-Level}]logging level \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]OK if successful \end{Desc}