\hypertarget{QLRA_8h}{ \section{QLRA.h File Reference} \label{QLRA_8h}\index{QLRA.h@{QLRA.h}} } Public definitions for the register display routines. {\tt \#include \char`\"{}PBS/WCT.h\char`\"{}}\par Include dependency graph for QLRA.h:\begin{figure}[H] \begin{center} \leavevmode \includegraphics[width=105pt]{QLRA_8h__incl} \end{center} \end{figure} This graph shows which files directly or indirectly include this file:\begin{figure}[H] \begin{center} \leavevmode \includegraphics[width=167pt]{QLRA_8h__dep__incl} \end{center} \end{figure} \subsection*{Data Structures} \begin{CompactItemize} \item struct \hyperlink{struct__QLRA__regSpec}{\_\-QLRA\_\-reg\-Spec} \begin{CompactList}\small\item\em Structure to specify a register, or set of registers. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__regData}{\_\-QLRA\_\-reg\-Data} \begin{CompactList}\small\item\em Structure to hold returned register data. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__esrData}{\_\-QLRA\_\-esr\-Data} \begin{CompactList}\small\item\em Structure to hold returned error and status register data. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__cmdStats}{\_\-QLRA\_\-cmd\-Stats} \begin{CompactList}\small\item\em Structure to hold command statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__rcvStats}{\_\-QLRA\_\-rcv\-Stats} \begin{CompactList}\small\item\em Structure to hold receive statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__trcvStats}{\_\-QLRA\_\-trcv\-Stats} \begin{CompactList}\small\item\em Structure to hold TEM receive statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__xmtStats}{\_\-QLRA\_\-xmt\-Stats} \begin{CompactList}\small\item\em Structure to hold transmit/response statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__aemTrgStats}{\_\-QLRA\_\-aem\-Trg\-Stats} \begin{CompactList}\small\item\em Structure to hold AEM trigger statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__arcErrStats}{\_\-QLRA\_\-arc\-Err\-Stats} \begin{CompactList}\small\item\em Structure to hold ARC event error statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__fifoStats}{\_\-QLRA\_\-fifo\-Stats} \begin{CompactList}\small\item\em Structure to hold CC FIFO statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__cntrStats}{\_\-QLRA\_\-cntr\-Stats} \begin{CompactList}\small\item\em Structure to hold simple counter statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__gemStats}{\_\-QLRA\_\-gem\-Stats} \begin{CompactList}\small\item\em Structure to hold GEM statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__gemStats__V2}{\_\-QLRA\_\-gem\-Stats\_\-V2} \begin{CompactList}\small\item\em Structure to hold GEM statistics, version 2. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__gemStats__V1}{\_\-QLRA\_\-gem\-Stats\_\-V1} \begin{CompactList}\small\item\em Structure to hold GEM statistics, version 1. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__cruStats}{\_\-QLRA\_\-cru\-Stats} \begin{CompactList}\small\item\em Structure to hold CRU statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__pduStats}{\_\-QLRA\_\-pdu\-Stats} \begin{CompactList}\small\item\em Structure to hold PDU statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__ebmStats}{\_\-QLRA\_\-ebm\-Stats} \begin{CompactList}\small\item\em Structure to hold EBM statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__ebmStats__V3}{\_\-QLRA\_\-ebm\-Stats\_\-V3} \begin{CompactList}\small\item\em Structure to hold EBM statistics, version 3 and lower. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__aemStats}{\_\-QLRA\_\-aem\-Stats} \begin{CompactList}\small\item\em Structure to hold AEM statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__temStats}{\_\-QLRA\_\-tem\-Stats} \begin{CompactList}\small\item\em Structure to hold TEM statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__ticStats}{\_\-QLRA\_\-tic\-Stats} \begin{CompactList}\small\item\em Structure to hold TIC statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__cccStats}{\_\-QLRA\_\-ccc\-Stats} \begin{CompactList}\small\item\em Structure to hold CCC statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__tccStats}{\_\-QLRA\_\-tcc\-Stats} \begin{CompactList}\small\item\em Structure to hold TCC statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__stats}{\_\-QLRA\_\-stats} \begin{CompactList}\small\item\em Structure to hold complete statistics. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__stats__V3}{\_\-QLRA\_\-stats\_\-V3} \begin{CompactList}\small\item\em Structure to hold complete statistics, version 3. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__stats__V2}{\_\-QLRA\_\-stats\_\-V2} \begin{CompactList}\small\item\em Structure to hold complete statistics, version 2. \item\end{CompactList}\item struct \hyperlink{struct__QLRA__stats__V1}{\_\-QLRA\_\-stats\_\-V1} \begin{CompactList}\small\item\em Structure to hold complete statistics, version 1. \item\end{CompactList}\end{CompactItemize} \subsection*{Typedefs} \begin{CompactItemize} \item \hypertarget{QLRA_8h_a0}{ typedef enum \hyperlink{QLRA_8h_a78}{\_\-QLRA\_\-disp} \hyperlink{QLRA_8h_a0}{QLRA\_\-disp}} \label{QLRA_8h_a0} \begin{CompactList}\small\item\em Display options. \item\end{CompactList}\item \hypertarget{QLRA_8h_a1}{ typedef enum \hyperlink{QLRA_8h_a79}{\_\-QLRA\_\-misc} \hyperlink{QLRA_8h_a1}{QLRA\_\-misc}} \label{QLRA_8h_a1} \begin{CompactList}\small\item\em Miscellaneous definitions. \item\end{CompactList}\item \hypertarget{QLRA_8h_a2}{ typedef enum \hyperlink{QLRA_8h_a80}{\_\-QLRA\_\-component} \hyperlink{QLRA_8h_a2}{QLRA\_\-component}} \label{QLRA_8h_a2} \begin{CompactList}\small\item\em Component identifiers. \item\end{CompactList}\item \hypertarget{QLRA_8h_a3}{ typedef enum \hyperlink{QLRA_8h_a81}{\_\-QLRA\_\-counts} \hyperlink{QLRA_8h_a3}{QLRA\_\-counts}} \label{QLRA_8h_a3} \begin{CompactList}\small\item\em Conponent counts. \item\end{CompactList}\item \hypertarget{QLRA_8h_a4}{ typedef enum \hyperlink{QLRA_8h_a82}{\_\-QLRA\_\-stats\-Version} \hyperlink{QLRA_8h_a4}{QLRA\_\-stats\-Version}} \label{QLRA_8h_a4} \begin{CompactList}\small\item\em Statistics block version. \item\end{CompactList}\item \hypertarget{QLRA_8h_a5}{ typedef \hyperlink{struct__QLRA__regSpec}{\_\-QLRA\_\-reg\-Spec} \hyperlink{QLRA_8h_a5}{QLRA\_\-reg\-Spec}} \label{QLRA_8h_a5} \begin{CompactList}\small\item\em Structure to specify a register, or set of registers. \item\end{CompactList}\item \hypertarget{QLRA_8h_a6}{ typedef \hyperlink{struct__QLRA__regData}{\_\-QLRA\_\-reg\-Data} \hyperlink{QLRA_8h_a6}{QLRA\_\-reg\-Data}} \label{QLRA_8h_a6} \begin{CompactList}\small\item\em Structure to hold returned register data. \item\end{CompactList}\item \hypertarget{QLRA_8h_a7}{ typedef \hyperlink{struct__QLRA__esrData}{\_\-QLRA\_\-esr\-Data} \hyperlink{QLRA_8h_a7}{QLRA\_\-esr\-Data}} \label{QLRA_8h_a7} \begin{CompactList}\small\item\em Structure to hold returned error and status register data. \item\end{CompactList}\item \hypertarget{QLRA_8h_a8}{ typedef \hyperlink{struct__QLRA__cmdStats}{\_\-QLRA\_\-cmd\-Stats} \hyperlink{QLRA_8h_a8}{QLRA\_\-cmd\-Stats}} \label{QLRA_8h_a8} \begin{CompactList}\small\item\em Structure to hold command statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a9}{ typedef \hyperlink{struct__QLRA__rcvStats}{\_\-QLRA\_\-rcv\-Stats} \hyperlink{QLRA_8h_a9}{QLRA\_\-rcv\-Stats}} \label{QLRA_8h_a9} \begin{CompactList}\small\item\em Structure to hold receive statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a10}{ typedef \hyperlink{struct__QLRA__trcvStats}{\_\-QLRA\_\-trcv\-Stats} \hyperlink{QLRA_8h_a10}{QLRA\_\-trcv\-Stats}} \label{QLRA_8h_a10} \begin{CompactList}\small\item\em Structure to hold TEM receive statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a11}{ typedef \hyperlink{struct__QLRA__xmtStats}{\_\-QLRA\_\-xmt\-Stats} \hyperlink{QLRA_8h_a11}{QLRA\_\-xmt\-Stats}} \label{QLRA_8h_a11} \begin{CompactList}\small\item\em Structure to hold transmit/response statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a12}{ typedef \hyperlink{struct__QLRA__aemTrgStats}{\_\-QLRA\_\-aem\-Trg\-Stats} \hyperlink{QLRA_8h_a12}{QLRA\_\-aem\-Trg\-Stats}} \label{QLRA_8h_a12} \begin{CompactList}\small\item\em Structure to hold AEM trigger statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a13}{ typedef \hyperlink{struct__QLRA__arcErrStats}{\_\-QLRA\_\-arc\-Err\-Stats} \hyperlink{QLRA_8h_a13}{QLRA\_\-arc\-Err\-Stats}} \label{QLRA_8h_a13} \begin{CompactList}\small\item\em Structure to hold ARC event error statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a14}{ typedef \hyperlink{struct__QLRA__fifoStats}{\_\-QLRA\_\-fifo\-Stats} \hyperlink{QLRA_8h_a14}{QLRA\_\-fifo\-Stats}} \label{QLRA_8h_a14} \begin{CompactList}\small\item\em Structure to hold CC FIFO statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a15}{ typedef \hyperlink{struct__QLRA__cntrStats}{\_\-QLRA\_\-cntr\-Stats} \hyperlink{QLRA_8h_a15}{QLRA\_\-cntr\-Stats}} \label{QLRA_8h_a15} \begin{CompactList}\small\item\em Structure to hold simple counter statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a16}{ typedef \hyperlink{struct__QLRA__gemStats}{\_\-QLRA\_\-gem\-Stats} \hyperlink{QLRA_8h_a16}{QLRA\_\-gem\-Stats}} \label{QLRA_8h_a16} \begin{CompactList}\small\item\em Structure to hold GEM statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a17}{ typedef \hyperlink{struct__QLRA__gemStats__V2}{\_\-QLRA\_\-gem\-Stats\_\-V2} \hyperlink{QLRA_8h_a17}{QLRA\_\-gem\-Stats\_\-V2}} \label{QLRA_8h_a17} \begin{CompactList}\small\item\em Structure to hold GEM statistics, version 2. \item\end{CompactList}\item \hypertarget{QLRA_8h_a18}{ typedef \hyperlink{struct__QLRA__gemStats__V1}{\_\-QLRA\_\-gem\-Stats\_\-V1} \hyperlink{QLRA_8h_a18}{QLRA\_\-gem\-Stats\_\-V1}} \label{QLRA_8h_a18} \begin{CompactList}\small\item\em Structure to hold GEM statistics, version 1. \item\end{CompactList}\item \hypertarget{QLRA_8h_a19}{ typedef \hyperlink{struct__QLRA__cruStats}{\_\-QLRA\_\-cru\-Stats} \hyperlink{QLRA_8h_a19}{QLRA\_\-cru\-Stats}} \label{QLRA_8h_a19} \begin{CompactList}\small\item\em Structure to hold CRU statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a20}{ typedef \hyperlink{struct__QLRA__pduStats}{\_\-QLRA\_\-pdu\-Stats} \hyperlink{QLRA_8h_a20}{QLRA\_\-pdu\-Stats}} \label{QLRA_8h_a20} \begin{CompactList}\small\item\em Structure to hold PDU statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a21}{ typedef \hyperlink{struct__QLRA__ebmStats}{\_\-QLRA\_\-ebm\-Stats} \hyperlink{QLRA_8h_a21}{QLRA\_\-ebm\-Stats}} \label{QLRA_8h_a21} \begin{CompactList}\small\item\em Structure to hold EBM statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a22}{ typedef \hyperlink{struct__QLRA__ebmStats__V3}{\_\-QLRA\_\-ebm\-Stats\_\-V3} \hyperlink{QLRA_8h_a22}{QLRA\_\-ebm\-Stats\_\-V3}} \label{QLRA_8h_a22} \begin{CompactList}\small\item\em Structure to hold EBM statistics, version 3 and lower. \item\end{CompactList}\item \hypertarget{QLRA_8h_a23}{ typedef \hyperlink{struct__QLRA__aemStats}{\_\-QLRA\_\-aem\-Stats} \hyperlink{QLRA_8h_a23}{QLRA\_\-aem\-Stats}} \label{QLRA_8h_a23} \begin{CompactList}\small\item\em Structure to hold AEM statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a24}{ typedef \hyperlink{struct__QLRA__temStats}{\_\-QLRA\_\-tem\-Stats} \hyperlink{QLRA_8h_a24}{QLRA\_\-tem\-Stats}} \label{QLRA_8h_a24} \begin{CompactList}\small\item\em Structure to hold TEM statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a25}{ typedef \hyperlink{struct__QLRA__ticStats}{\_\-QLRA\_\-tic\-Stats} \hyperlink{QLRA_8h_a25}{QLRA\_\-tic\-Stats}} \label{QLRA_8h_a25} \begin{CompactList}\small\item\em Structure to hold TIC statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a26}{ typedef \hyperlink{struct__QLRA__cccStats}{\_\-QLRA\_\-ccc\-Stats} \hyperlink{QLRA_8h_a26}{QLRA\_\-ccc\-Stats}} \label{QLRA_8h_a26} \begin{CompactList}\small\item\em Structure to hold CCC statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a27}{ typedef \hyperlink{struct__QLRA__tccStats}{\_\-QLRA\_\-tcc\-Stats} \hyperlink{QLRA_8h_a27}{QLRA\_\-tcc\-Stats}} \label{QLRA_8h_a27} \begin{CompactList}\small\item\em Structure to hold TCC statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a28}{ typedef \hyperlink{struct__QLRA__stats}{\_\-QLRA\_\-stats} \hyperlink{QLRA_8h_a28}{QLRA\_\-stats}} \label{QLRA_8h_a28} \begin{CompactList}\small\item\em Structure to hold complete statistics. \item\end{CompactList}\item \hypertarget{QLRA_8h_a29}{ typedef \hyperlink{struct__QLRA__stats__V3}{\_\-QLRA\_\-stats\_\-V3} \hyperlink{QLRA_8h_a29}{QLRA\_\-stats\_\-V3}} \label{QLRA_8h_a29} \begin{CompactList}\small\item\em Structure to hold complete statistics, version 3. \item\end{CompactList}\item \hypertarget{QLRA_8h_a30}{ typedef \hyperlink{struct__QLRA__stats__V2}{\_\-QLRA\_\-stats\_\-V2} \hyperlink{QLRA_8h_a30}{QLRA\_\-stats\_\-V2}} \label{QLRA_8h_a30} \begin{CompactList}\small\item\em Structure to hold complete statistics, version 2. \item\end{CompactList}\item \hypertarget{QLRA_8h_a31}{ typedef \hyperlink{struct__QLRA__stats__V1}{\_\-QLRA\_\-stats\_\-V1} \hyperlink{QLRA_8h_a31}{QLRA\_\-stats\_\-V1}} \label{QLRA_8h_a31} \begin{CompactList}\small\item\em Structure to hold complete statistics, version 1. \item\end{CompactList}\item \hypertarget{QLRA_8h_a32}{ typedef void($\ast$ \hyperlink{QLRA_8h_a32}{QLRA\_\-regs\-Cb} )(unsigned int secs, \hyperlink{struct__QLRA__regData}{QLRA\_\-reg\-Data} $\ast$r\-Data, void $\ast$parm)} \label{QLRA_8h_a32} \begin{CompactList}\small\item\em Callback routines to process LRA data. \item\end{CompactList}\item \hypertarget{QLRA_8h_a33}{ typedef void($\ast$ {\bf QLRA\_\-esr\-Cb} )(unsigned int secs, \hyperlink{struct__QLRA__esrData}{QLRA\_\-esr\-Data} $\ast$r\-Data, void $\ast$parm)} \label{QLRA_8h_a33} \item \hypertarget{QLRA_8h_a34}{ typedef void($\ast$ {\bf QLRA\_\-stats\-Cb} )(unsigned int secs, \hyperlink{struct__QLRA__stats}{QLRA\_\-stats} $\ast$s\-Data, void $\ast$parm)} \label{QLRA_8h_a34} \end{CompactItemize} \subsection*{Enumerations} \begin{CompactItemize} \item enum \hyperlink{QLRA_8h_a78}{\_\-QLRA\_\-disp} \{ \par \hyperlink{QLRA_8h_a78a35}{QLRA\_\-DOPT\_\-PLAIN} = 0x01, \par \hyperlink{QLRA_8h_a78a36}{QLRA\_\-DOPT\_\-NOHDR} = 0x02 \} \begin{CompactList}\small\item\em Display options. \item\end{CompactList}\item enum \hyperlink{QLRA_8h_a79}{\_\-QLRA\_\-misc} \{ \par \hyperlink{QLRA_8h_a79a37}{QLRA\_\-WILD} = 255, \par \hyperlink{QLRA_8h_a79a38}{QLRA\_\-ACTIVE} = 254 \} \begin{CompactList}\small\item\em Miscellaneous definitions. \item\end{CompactList}\item enum \hyperlink{QLRA_8h_a80}{\_\-QLRA\_\-component} \{ \par {\bf QLRA\_\-CPT\_\-GEM} = 1, \par {\bf QLRA\_\-CPT\_\-EBM} = 2, \par {\bf QLRA\_\-CPT\_\-PDU0} = 3, \par {\bf QLRA\_\-CPT\_\-PDU1} = 4, \par {\bf QLRA\_\-CPT\_\-CRU} = 5, \par {\bf QLRA\_\-CPT\_\-TEM} = 6, \par {\bf QLRA\_\-CPT\_\-TIC} = 7, \par {\bf QLRA\_\-CPT\_\-CCC} = 8, \par {\bf QLRA\_\-CPT\_\-CRC} = 9, \par {\bf QLRA\_\-CPT\_\-CFE} = 10, \par {\bf QLRA\_\-CPT\_\-TCC} = 11, \par {\bf QLRA\_\-CPT\_\-TRC} = 12, \par {\bf QLRA\_\-CPT\_\-TFE} = 13, \par {\bf QLRA\_\-CPT\_\-AEM} = 14, \par {\bf QLRA\_\-CPT\_\-ARC} = 15, \par {\bf QLRA\_\-CPT\_\-AFE} = 16, \par {\bf QLRA\_\-CPT\_\-SIUE} = 33, \par {\bf QLRA\_\-CPT\_\-SIU0} = 34, \par {\bf QLRA\_\-CPT\_\-SIU1} = 35, \par {\bf QLRA\_\-CPT\_\-EPU0} = 36, \par {\bf QLRA\_\-CPT\_\-EPU1} = 37, \par {\bf QLRA\_\-CPT\_\-EPU2} = 38, \par {\bf QLRA\_\-CPT\_\-BCST} = QLRA\_\-WILD \} \begin{CompactList}\small\item\em Component identifiers. \item\end{CompactList}\item enum \hyperlink{QLRA_8h_a81}{\_\-QLRA\_\-counts} \{ \par \hyperlink{QLRA_8h_a81a62}{QLRA\_\-N\_\-TEM} = 16, \par \hyperlink{QLRA_8h_a81a63}{QLRA\_\-N\_\-CCC} = 4, \par \hyperlink{QLRA_8h_a81a64}{QLRA\_\-N\_\-TCC} = 8, \par \hyperlink{QLRA_8h_a81a65}{QLRA\_\-N\_\-CRC} = 4, \par \hyperlink{QLRA_8h_a81a66}{QLRA\_\-N\_\-TRC} = 9, \par \hyperlink{QLRA_8h_a81a67}{QLRA\_\-N\_\-ARC} = 12, \par \hyperlink{QLRA_8h_a81a68}{QLRA\_\-N\_\-CFE} = 12, \par \hyperlink{QLRA_8h_a81a69}{QLRA\_\-N\_\-TFE} = 24, \par \hyperlink{QLRA_8h_a81a70}{QLRA\_\-N\_\-AFE} = 18 \} \begin{CompactList}\small\item\em Conponent counts. \item\end{CompactList}\item enum \hyperlink{QLRA_8h_a82}{\_\-QLRA\_\-stats\-Version} \{ \par \hyperlink{QLRA_8h_a82a71}{QLRA\_\-STATS\_\-MAJOR} = 4, \par \hyperlink{QLRA_8h_a82a72}{QLRA\_\-STATS\_\-MINOR} = 0 \} \begin{CompactList}\small\item\em Statistics block version. \item\end{CompactList}\end{CompactItemize} \subsection*{Functions} \begin{CompactItemize} \item void \hyperlink{QLRA_8h_a73}{QLRA\_\-disp\-Esr\-Data} (unsigned int secs, \hyperlink{struct__QLRA__esrData}{QLRA\_\-esr\-Data} $\ast$r\-Data, void $\ast$parm) \begin{CompactList}\small\item\em Display error and status register data. \item\end{CompactList}\item void \hyperlink{QLRA_8h_a74}{QLRA\_\-disp\-Reg\-Data} (unsigned int secs, \hyperlink{struct__QLRA__regData}{QLRA\_\-reg\-Data} $\ast$r\-Data, void $\ast$parm) \begin{CompactList}\small\item\em Display register data. \item\end{CompactList}\item void \hyperlink{QLRA_8h_a75}{QLRA\_\-disp\-Stats} (unsigned int secs, \hyperlink{struct__QLRA__stats}{QLRA\_\-stats} $\ast$s\-Data, void $\ast$parm) \begin{CompactList}\small\item\em Display statistics data. \item\end{CompactList}\item unsigned \hyperlink{QLRA_8h_a76}{QLRA\_\-read\-Diag} (char $\ast$f\-Name, void $\ast$parm, \hyperlink{QLRA_8h_a32}{QLRA\_\-regs\-Cb} regs\-Rtn) \begin{CompactList}\small\item\em Read the contents of an LRA packet file. \item\end{CompactList}\item unsigned \hyperlink{QLRA_8h_a77}{QLRA\_\-read\-Sci} (char $\ast$f\-Name, void $\ast$parm, \hyperlink{QLRA_8h_a32}{QLRA\_\-regs\-Cb} regs\-Rtn, QLRA\_\-esr\-Cb esr\-Rtn, QLRA\_\-stats\-Cb stats\-Rtn) \begin{CompactList}\small\item\em Read the contents of an LRA datagram file. \item\end{CompactList}\end{CompactItemize} \subsection{Detailed Description} Public definitions for the register display routines. \begin{Desc} \item[Author:]Owen H Saxton\end{Desc} \begin{Desc} \item[Id]\hyperlink{QLRA_8h}{QLRA.h},v 1.3 2009/05/15 23:19:54 saxton Exp \end{Desc} \subsection{Enumeration Type Documentation} \hypertarget{QLRA_8h_a81}{ \index{QLRA.h@{QLRA.h}!_QLRA_counts@{\_\-QLRA\_\-counts}} \index{_QLRA_counts@{\_\-QLRA\_\-counts}!QLRA.h@{QLRA.h}} \subsubsection[\_\-QLRA\_\-counts]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{QLRA_8h_a81}{\_\-QLRA\_\-counts}}} \label{QLRA_8h_a81} Conponent counts. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{QLRA_N_TEM@{QLRA\_\-N\_\-TEM}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_N_TEM@{QLRA\_\-N\_\-TEM}}\item[{\em \hypertarget{QLRA_8h_a81a62}{ QLRA\_\-N\_\-TEM} \label{QLRA_8h_a81a62} }]Number of TEMs. \index{QLRA_N_CCC@{QLRA\_\-N\_\-CCC}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_N_CCC@{QLRA\_\-N\_\-CCC}}\item[{\em \hypertarget{QLRA_8h_a81a63}{ QLRA\_\-N\_\-CCC} \label{QLRA_8h_a81a63} }]Number of CAL cable controllers. \index{QLRA_N_TCC@{QLRA\_\-N\_\-TCC}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_N_TCC@{QLRA\_\-N\_\-TCC}}\item[{\em \hypertarget{QLRA_8h_a81a64}{ QLRA\_\-N\_\-TCC} \label{QLRA_8h_a81a64} }]Number of TKR cable controllers. \index{QLRA_N_CRC@{QLRA\_\-N\_\-CRC}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_N_CRC@{QLRA\_\-N\_\-CRC}}\item[{\em \hypertarget{QLRA_8h_a81a65}{ QLRA\_\-N\_\-CRC} \label{QLRA_8h_a81a65} }]Number of CAL readout controllers. \index{QLRA_N_TRC@{QLRA\_\-N\_\-TRC}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_N_TRC@{QLRA\_\-N\_\-TRC}}\item[{\em \hypertarget{QLRA_8h_a81a66}{ QLRA\_\-N\_\-TRC} \label{QLRA_8h_a81a66} }]Number of TKR readout controllers. \index{QLRA_N_ARC@{QLRA\_\-N\_\-ARC}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_N_ARC@{QLRA\_\-N\_\-ARC}}\item[{\em \hypertarget{QLRA_8h_a81a67}{ QLRA\_\-N\_\-ARC} \label{QLRA_8h_a81a67} }]Number of ACD readout controllers. \index{QLRA_N_CFE@{QLRA\_\-N\_\-CFE}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_N_CFE@{QLRA\_\-N\_\-CFE}}\item[{\em \hypertarget{QLRA_8h_a81a68}{ QLRA\_\-N\_\-CFE} \label{QLRA_8h_a81a68} }]Number of CAL front-ends. \index{QLRA_N_TFE@{QLRA\_\-N\_\-TFE}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_N_TFE@{QLRA\_\-N\_\-TFE}}\item[{\em \hypertarget{QLRA_8h_a81a69}{ QLRA\_\-N\_\-TFE} \label{QLRA_8h_a81a69} }]Number of TKR front-ends. \index{QLRA_N_AFE@{QLRA\_\-N\_\-AFE}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_N_AFE@{QLRA\_\-N\_\-AFE}}\item[{\em \hypertarget{QLRA_8h_a81a70}{ QLRA\_\-N\_\-AFE} \label{QLRA_8h_a81a70} }]Number of ACD front-ends. \end{description} \end{Desc} \hypertarget{QLRA_8h_a78}{ \index{QLRA.h@{QLRA.h}!_QLRA_disp@{\_\-QLRA\_\-disp}} \index{_QLRA_disp@{\_\-QLRA\_\-disp}!QLRA.h@{QLRA.h}} \subsubsection[\_\-QLRA\_\-disp]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{QLRA_8h_a78}{\_\-QLRA\_\-disp}}} \label{QLRA_8h_a78} Display options. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{QLRA_DOPT_PLAIN@{QLRA\_\-DOPT\_\-PLAIN}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_DOPT_PLAIN@{QLRA\_\-DOPT\_\-PLAIN}}\item[{\em \hypertarget{QLRA_8h_a78a35}{ QLRA\_\-DOPT\_\-PLAIN} \label{QLRA_8h_a78a35} }]Do plain display. \index{QLRA_DOPT_NOHDR@{QLRA\_\-DOPT\_\-NOHDR}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_DOPT_NOHDR@{QLRA\_\-DOPT\_\-NOHDR}}\item[{\em \hypertarget{QLRA_8h_a78a36}{ QLRA\_\-DOPT\_\-NOHDR} \label{QLRA_8h_a78a36} }]Don't display header line. \end{description} \end{Desc} \hypertarget{QLRA_8h_a79}{ \index{QLRA.h@{QLRA.h}!_QLRA_misc@{\_\-QLRA\_\-misc}} \index{_QLRA_misc@{\_\-QLRA\_\-misc}!QLRA.h@{QLRA.h}} \subsubsection[\_\-QLRA\_\-misc]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{QLRA_8h_a79}{\_\-QLRA\_\-misc}}} \label{QLRA_8h_a79} Miscellaneous definitions. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{QLRA_WILD@{QLRA\_\-WILD}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_WILD@{QLRA\_\-WILD}}\item[{\em \hypertarget{QLRA_8h_a79a37}{ QLRA\_\-WILD} \label{QLRA_8h_a79a37} }]General purpose wild-card value. \index{QLRA_ACTIVE@{QLRA\_\-ACTIVE}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_ACTIVE@{QLRA\_\-ACTIVE}}\item[{\em \hypertarget{QLRA_8h_a79a38}{ QLRA\_\-ACTIVE} \label{QLRA_8h_a79a38} }]TEM or ARC specifier, active only. \end{description} \end{Desc} \hypertarget{QLRA_8h_a82}{ \index{QLRA.h@{QLRA.h}!_QLRA_statsVersion@{\_\-QLRA\_\-statsVersion}} \index{_QLRA_statsVersion@{\_\-QLRA\_\-statsVersion}!QLRA.h@{QLRA.h}} \subsubsection[\_\-QLRA\_\-statsVersion]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{QLRA_8h_a82}{\_\-QLRA\_\-stats\-Version}}} \label{QLRA_8h_a82} Statistics block version. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{QLRA_STATS_MAJOR@{QLRA\_\-STATS\_\-MAJOR}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_STATS_MAJOR@{QLRA\_\-STATS\_\-MAJOR}}\item[{\em \hypertarget{QLRA_8h_a82a71}{ QLRA\_\-STATS\_\-MAJOR} \label{QLRA_8h_a82a71} }]Major version number. \index{QLRA_STATS_MINOR@{QLRA\_\-STATS\_\-MINOR}!QLRA.h@{QLRA.h}}\index{QLRA.h@{QLRA.h}!QLRA_STATS_MINOR@{QLRA\_\-STATS\_\-MINOR}}\item[{\em \hypertarget{QLRA_8h_a82a72}{ QLRA\_\-STATS\_\-MINOR} \label{QLRA_8h_a82a72} }]Minor version number. \end{description} \end{Desc} \subsection{Function Documentation} \hypertarget{QLRA_8h_a73}{ \index{QLRA.h@{QLRA.h}!QLRA_dispEsrData@{QLRA\_\-dispEsrData}} \index{QLRA_dispEsrData@{QLRA\_\-dispEsrData}!QLRA.h@{QLRA.h}} \subsubsection[QLRA\_\-dispEsrData]{\setlength{\rightskip}{0pt plus 5cm}void QLRA\_\-disp\-Esr\-Data (unsigned int {\em secs}, \hyperlink{struct__QLRA__esrData}{QLRA\_\-esr\-Data} $\ast$ {\em r\-Data}, void $\ast$ {\em parm})}} \label{QLRA_8h_a73} Display error and status register data. This routine produces a formatted display of the contents of a block of error and status register data. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em secs}]The time the register data was obtained, in spacecraft units.\item[{\em r\-Data}]The register data to be displayed.\item[{\em parm}]Options to modify the display.\end{description} \end{Desc} \hypertarget{QLRA_8h_a74}{ \index{QLRA.h@{QLRA.h}!QLRA_dispRegData@{QLRA\_\-dispRegData}} \index{QLRA_dispRegData@{QLRA\_\-dispRegData}!QLRA.h@{QLRA.h}} \subsubsection[QLRA\_\-dispRegData]{\setlength{\rightskip}{0pt plus 5cm}void QLRA\_\-disp\-Reg\-Data (unsigned int {\em secs}, \hyperlink{struct__QLRA__regData}{QLRA\_\-reg\-Data} $\ast$ {\em r\-Data}, void $\ast$ {\em parm})}} \label{QLRA_8h_a74} Display register data. This routine produces a formatted display of the contents of a block of register data. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em secs}]The time the register data was obtained, in spacecraft units.\item[{\em r\-Data}]The register data to be displayed.\item[{\em parm}]Options to modify the display.\end{description} \end{Desc} \hypertarget{QLRA_8h_a75}{ \index{QLRA.h@{QLRA.h}!QLRA_dispStats@{QLRA\_\-dispStats}} \index{QLRA_dispStats@{QLRA\_\-dispStats}!QLRA.h@{QLRA.h}} \subsubsection[QLRA\_\-dispStats]{\setlength{\rightskip}{0pt plus 5cm}void QLRA\_\-disp\-Stats (unsigned int {\em secs}, \hyperlink{struct__QLRA__stats}{QLRA\_\-stats} $\ast$ {\em s\-Data}, void $\ast$ {\em parm})}} \label{QLRA_8h_a75} Display statistics data. This routine produces a formatted display of the contents of a block of statistics data. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em secs}]The time the data was sent, in spacecraft units.\item[{\em s\-Data}]The statistics data to be displayed.\item[{\em parm}]Options to modify the display.\end{description} \end{Desc} \hypertarget{QLRA_8h_a76}{ \index{QLRA.h@{QLRA.h}!QLRA_readDiag@{QLRA\_\-readDiag}} \index{QLRA_readDiag@{QLRA\_\-readDiag}!QLRA.h@{QLRA.h}} \subsubsection[QLRA\_\-readDiag]{\setlength{\rightskip}{0pt plus 5cm}unsigned QLRA\_\-read\-Diag (char $\ast$ {\em f\-Name}, void $\ast$ {\em parm}, \hyperlink{QLRA_8h_a32}{QLRA\_\-regs\-Cb} {\em regs\-Rtn})}} \label{QLRA_8h_a76} Read the contents of an LRA packet file. This routine reads a file of LRA diagnostic data returned from the LAT and calls a processing routine whenever a complete set of data has been assemnled. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em f\-Name}]The name of the file to be processed\item[{\em parm}]User parameter to pass to the processing routine.\item[{\em regs\-Rtn}]Routine to process a set of register data. May be NULL.\end{description} \end{Desc} \begin{Desc} \item[Return values:] \begin{description} \item[{\em QLRA\_\-SUCCESS}]Success\end{description} \end{Desc} \hypertarget{QLRA_8h_a77}{ \index{QLRA.h@{QLRA.h}!QLRA_readSci@{QLRA\_\-readSci}} \index{QLRA_readSci@{QLRA\_\-readSci}!QLRA.h@{QLRA.h}} \subsubsection[QLRA\_\-readSci]{\setlength{\rightskip}{0pt plus 5cm}unsigned QLRA\_\-read\-Sci (char $\ast$ {\em f\-Name}, void $\ast$ {\em parm}, \hyperlink{QLRA_8h_a32}{QLRA\_\-regs\-Cb} {\em regs\-Rtn}, QLRA\_\-esr\-Cb {\em esr\-Rtn}, QLRA\_\-stats\-Cb {\em stats\-Rtn})}} \label{QLRA_8h_a77} Read the contents of an LRA datagram file. This routine reads a file of LRA datagrams returned from the LAT, and calls a user-supplied processing routine for each type of data found. \begin{Desc} \item[Parameters:] \begin{description} \item[{\em f\-Name}]The name of the file to be displayed\item[{\em parm}]User parameter to pass to the processing routine.\item[{\em regs\-Rtn}]Routine to call when a set of register values is read. Can be NULL.\item[{\em esr\-Rtn}]Routine to call when a set of ESR data is read. Can be NULL.\item[{\em stats\-Rtn}]Routine to call when a set of statistics data is read. Can be NULL.\end{description} \end{Desc} \begin{Desc} \item[Return values:] \begin{description} \item[{\em QLRA\_\-SUCCESS}]Success\end{description} \end{Desc}