\hypertarget{gerr_8h}{
\section{gerr.h File Reference}
\label{gerr_8h}\index{gerr.h@{gerr.h}}
}
Defines public error codes for the gnat driver.  


\subsection*{Defines}
\begin{CompactItemize}
\item 
\hypertarget{gerr_8h_a0}{
\#define \hyperlink{gerr_8h_a0}{G\_\-OK}\ (0)}
\label{gerr_8h_a0}

\begin{CompactList}\small\item\em generic success return code \item\end{CompactList}\item 
\hypertarget{gerr_8h_a1}{
\#define \hyperlink{gerr_8h_a1}{GERR}\ (-1)}
\label{gerr_8h_a1}

\begin{CompactList}\small\item\em generic failure return code \item\end{CompactList}\item 
\hypertarget{gerr_8h_a2}{
\#define \hyperlink{gerr_8h_a2}{GERR\_\-MEM}\ (-101)}
\label{gerr_8h_a2}

\begin{CompactList}\small\item\em allocating memory error return code \item\end{CompactList}\item 
\hypertarget{gerr_8h_a3}{
\#define \hyperlink{gerr_8h_a3}{GERR\_\-ADDR\_\-MAP}\ (-102)}
\label{gerr_8h_a3}

\begin{CompactList}\small\item\em mapping physical addr to local addr error return code \item\end{CompactList}\item 
\hypertarget{gerr_8h_a4}{
\#define \hyperlink{gerr_8h_a4}{GERR\_\-BRD\_\-DETECT}\ (-103)}
\label{gerr_8h_a4}

\begin{CompactList}\small\item\em unable to detect/probe board error return code \item\end{CompactList}\item 
\hypertarget{gerr_8h_a5}{
\#define \hyperlink{gerr_8h_a5}{GERR\_\-BAD\_\-HANDLE}\ (-104)}
\label{gerr_8h_a5}

\begin{CompactList}\small\item\em bad handle error return code \item\end{CompactList}\item 
\hypertarget{gerr_8h_a6}{
\#define \hyperlink{gerr_8h_a6}{GERR\_\-BAD\_\-PARAM}\ (-105)}
\label{gerr_8h_a6}

\begin{CompactList}\small\item\em bad parameter passed to function error return code \item\end{CompactList}\item 
\hypertarget{gerr_8h_a7}{
\#define \hyperlink{gerr_8h_a7}{GERR\_\-NO\_\-MAP}\ (-106)}
\label{gerr_8h_a7}

\begin{CompactList}\small\item\em physical to local address not mapped error return code \item\end{CompactList}\item 
\hypertarget{gerr_8h_a8}{
\#define \hyperlink{gerr_8h_a8}{GERR\_\-RSP\_\-TIMEOUT}\ (-107)}
\label{gerr_8h_a8}

\begin{CompactList}\small\item\em timeout error while reading response error return code \item\end{CompactList}\item 
\hypertarget{gerr_8h_a9}{
\#define \hyperlink{gerr_8h_a9}{GERR\_\-BAD\_\-RSP}\ (-108)}
\label{gerr_8h_a9}

\begin{CompactList}\small\item\em malformed command response request error return code \item\end{CompactList}\item 
\hypertarget{gerr_8h_a10}{
\#define \hyperlink{gerr_8h_a10}{GERR\_\-RSP\_\-BUF\_\-OVERFLOW}\ (-109)}
\label{gerr_8h_a10}

\begin{CompactList}\small\item\em The response buffer was not big enough to hold the response. \item\end{CompactList}\item 
\hypertarget{gerr_8h_a11}{
\#define \hyperlink{gerr_8h_a11}{GERR\_\-READY\_\-TIMEOUT}\ (-110)}
\label{gerr_8h_a11}

\begin{CompactList}\small\item\em timeout error while waiting for COMM ready \item\end{CompactList}\item 
\hypertarget{gerr_8h_a12}{
\#define \hyperlink{gerr_8h_a12}{GERR\_\-BOARD\_\-VERSION}\ (-111)}
\label{gerr_8h_a12}

\begin{CompactList}\small\item\em Bad hardware version. \item\end{CompactList}\item 
\hypertarget{gerr_8h_a13}{
\#define \hyperlink{gerr_8h_a13}{GERR\_\-LATP\_\-HEADER\_\-PARITY}\ (-112)}
\label{gerr_8h_a13}

\begin{CompactList}\small\item\em LATp cell header parity error. \item\end{CompactList}\item 
\hypertarget{gerr_8h_a14}{
\#define \hyperlink{gerr_8h_a14}{GERR\_\-LATP\_\-CELL\_\-PARITY}\ (-113)}
\label{gerr_8h_a14}

\begin{CompactList}\small\item\em LATp cell body parity error. \item\end{CompactList}\item 
\hypertarget{gerr_8h_a15}{
\#define \hyperlink{gerr_8h_a15}{GERR\_\-LATP\_\-TRUNCATE}\ (-114)}
\label{gerr_8h_a15}

\begin{CompactList}\small\item\em LATp cell truncate error. \item\end{CompactList}\item 
\hypertarget{gerr_8h_a16}{
\#define \hyperlink{gerr_8h_a16}{GERR\_\-HANDLE\_\-NOT\_\-ACTIVE}\ (-115)}
\label{gerr_8h_a16}

\begin{CompactList}\small\item\em Read attempted while handle has been disabled via g\-Set\-Active(). \item\end{CompactList}\item 
\hypertarget{gerr_8h_a17}{
\#define \hyperlink{gerr_8h_a17}{GERR\_\-LATP\_\-CELL\_\-ANNOUNCE}\ (-116)}
\label{gerr_8h_a17}

\begin{CompactList}\small\item\em LATp packet did not begin with proper cell announce bit and control cell bit. \item\end{CompactList}\item 
\#define \hyperlink{gerr_8h_a18}{GERR\_\-RSP\_\-FIFO\_\-NOT\_\-EMPTY}\ (-116)
\begin{CompactList}\small\item\em The response FIFO was not empty after reading one packet of response. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Defines public error codes for the gnat driver. 

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


\subsection{Define Documentation}
\hypertarget{gerr_8h_a18}{
\index{gerr.h@{gerr.h}!GERR_RSP_FIFO_NOT_EMPTY@{GERR\_\-RSP\_\-FIFO\_\-NOT\_\-EMPTY}}
\index{GERR_RSP_FIFO_NOT_EMPTY@{GERR\_\-RSP\_\-FIFO\_\-NOT\_\-EMPTY}!gerr.h@{gerr.h}}
\subsubsection[GERR\_\-RSP\_\-FIFO\_\-NOT\_\-EMPTY]{\setlength{\rightskip}{0pt plus 5cm}\#define GERR\_\-RSP\_\-FIFO\_\-NOT\_\-EMPTY\ (-116)}}
\label{gerr_8h_a18}


The response FIFO was not empty after reading one packet of response. 

Since the CMD/RSP path is a synchronous interface, each read command should create one and one response packet. This error means that more than one packet of data was in the FIFO while reading a response. 