\hypertarget{gdump_8h}{
\section{gdump.h File Reference}
\label{gdump_8h}\index{gdump.h@{gdump.h}}
}
Defines methods for dumping the gnat driver control registers.  




This graph shows which files directly or indirectly include this file:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=44pt]{gdump_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Functions}
\begin{CompactItemize}
\item 
int \hyperlink{gdump_8h_a0}{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_8h_a1}{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_8h_a2}{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_8h_a3}{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_8h_a4}{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_8h_a5}{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{Detailed Description}
Defines methods for dumping the gnat driver control registers. 

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


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


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}


Here is the call graph for this function:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=120pt]{gdump_8h_a5_cgraph}
\end{center}
\end{figure}
\hypertarget{gdump_8h_a0}{
\index{gdump.h@{gdump.h}!gDumpCtrlReg@{gDumpCtrlReg}}
\index{gDumpCtrlReg@{gDumpCtrlReg}!gdump.h@{gdump.h}}
\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_8h_a0}


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_8h_a4}{
\index{gdump.h@{gdump.h}!gDumpIntReg@{gDumpIntReg}}
\index{gDumpIntReg@{gDumpIntReg}!gdump.h@{gdump.h}}
\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_8h_a4}


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_8h_a2}{
\index{gdump.h@{gdump.h}!gDumpPFReg@{gDumpPFReg}}
\index{gDumpPFReg@{gDumpPFReg}!gdump.h@{gdump.h}}
\subsubsection[gDumpPFReg]{\setlength{\rightskip}{0pt plus 5cm}int g\-Dump\-PFReg (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh})}}
\label{gdump_8h_a2}


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_8h_a3}{
\index{gdump.h@{gdump.h}!gDumpRFReg@{gDumpRFReg}}
\index{gDumpRFReg@{gDumpRFReg}!gdump.h@{gdump.h}}
\subsubsection[gDumpRFReg]{\setlength{\rightskip}{0pt plus 5cm}int g\-Dump\-RFReg (\hyperlink{struct__gnat}{gnat\-Handle} {\em gh})}}
\label{gdump_8h_a3}


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_8h_a1}{
\index{gdump.h@{gdump.h}!gDumpStatReg@{gDumpStatReg}}
\index{gDumpStatReg@{gDumpStatReg}!gdump.h@{gdump.h}}
\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_8h_a1}


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}
