\hypertarget{TAU_8h}{
\section{TAU.h File Reference}
\label{TAU_8h}\index{TAU.h@{TAU.h}}
}
Thermal Assist Unit, interface.  


{\tt \#include $<$IPBS/L\_\-pubdefs.h$>$}\par
{\tt \#include $<$IPBS/impl/TAU.h.xx-xxx-xxx$>$}\par
\subsection*{Classes}
\begin{CompactItemize}
\item 
struct \hyperlink{struct__TAU__reg__bf}{\_\-TAU\_\-reg\_\-bf}
\begin{CompactList}\small\item\em Bit field definition of the THRM1 and THRM2 registers. \item\end{CompactList}\item 
union \hyperlink{union__TAU__reg}{\_\-TAU\_\-reg}
\begin{CompactList}\small\item\em Union of an unsigned int with the bit field definitions of the THRM1 and THRM2 registers. \item\end{CompactList}\item 
struct \hyperlink{struct__TAU__ctl__bf}{\_\-TAU\_\-ctl\_\-bf}
\begin{CompactList}\small\item\em Bit field definition of the THRM3 register, the control register. \item\end{CompactList}\item 
union \hyperlink{union__TAU__ctl}{\_\-TAU\_\-ctl}
\begin{CompactList}\small\item\em Union of an unsigned int with the bit field definition of the THRM3 register. \item\end{CompactList}\item 
struct \hyperlink{struct__TAU__request}{\_\-TAU\_\-request}
\begin{CompactList}\small\item\em Structure to define a read request. \item\end{CompactList}\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{TAU_8h_476877666060823bb3cf8878cd8fd9ec}{
typedef struct \hyperlink{struct__TAU__request}{\_\-TAU\_\-request} \hyperlink{TAU_8h_476877666060823bb3cf8878cd8fd9ec}{TAU\_\-request}}
\label{TAU_8h_476877666060823bb3cf8878cd8fd9ec}

\begin{CompactList}\small\item\em Typedef for struct {\em \hyperlink{struct__TAU__request}{\_\-TAU\_\-request}\/}. \item\end{CompactList}\item 
\hypertarget{TAU_8h_3aed9e84dcf1645a42287b1c35811db1}{
typedef void( \hyperlink{TAU_8h_3aed9e84dcf1645a42287b1c35811db1}{TAU\_\-isr} )(void)}
\label{TAU_8h_3aed9e84dcf1645a42287b1c35811db1}

\begin{CompactList}\small\item\em Callback signature for the TAU interrupt service routine. \item\end{CompactList}\item 
\hypertarget{TAU_8h_a5cf1dc76fe4c147b261d764431fed1d}{
typedef struct \hyperlink{struct__TAU__reg__bf}{\_\-TAU\_\-reg\_\-bf} \hyperlink{TAU_8h_a5cf1dc76fe4c147b261d764431fed1d}{TAU\_\-reg\_\-bf}}
\label{TAU_8h_a5cf1dc76fe4c147b261d764431fed1d}

\begin{CompactList}\small\item\em Typedef for struct {\em \hyperlink{struct__TAU__reg__bf}{\_\-TAU\_\-reg\_\-bf}\/}. \item\end{CompactList}\item 
\hypertarget{TAU_8h_b4c4614677feca112fe0b161db973916}{
typedef union \hyperlink{union__TAU__reg}{\_\-TAU\_\-reg} \hyperlink{TAU_8h_b4c4614677feca112fe0b161db973916}{TAU\_\-reg}}
\label{TAU_8h_b4c4614677feca112fe0b161db973916}

\begin{CompactList}\small\item\em Typedef for union {\em \hyperlink{union__TAU__reg}{\_\-TAU\_\-reg}\/}. \item\end{CompactList}\item 
\hypertarget{TAU_8h_57e29dc2d8aedf4cb8102c9485261a92}{
typedef struct \hyperlink{struct__TAU__ctl__bf}{\_\-TAU\_\-ctl\_\-bf} \hyperlink{TAU_8h_57e29dc2d8aedf4cb8102c9485261a92}{TAU\_\-ctl\_\-bf}}
\label{TAU_8h_57e29dc2d8aedf4cb8102c9485261a92}

\begin{CompactList}\small\item\em Typedef for struct {\em \hyperlink{struct__TAU__ctl__bf}{\_\-TAU\_\-ctl\_\-bf}\/}. \item\end{CompactList}\item 
\hypertarget{TAU_8h_204bcc3eb7f23c47ada70d14be41d9db}{
typedef union \hyperlink{union__TAU__ctl}{\_\-TAU\_\-ctl} \hyperlink{TAU_8h_204bcc3eb7f23c47ada70d14be41d9db}{TAU\_\-ctl}}
\label{TAU_8h_204bcc3eb7f23c47ada70d14be41d9db}

\begin{CompactList}\small\item\em Typedef for union {\em \hyperlink{union__TAU__ctl}{\_\-TAU\_\-ctl}\/}. \item\end{CompactList}\item 
\hypertarget{TAU_8h_d31be806533f26c12656c982bc3c7e9e}{
typedef int( \hyperlink{TAU_8h_d31be806533f26c12656c982bc3c7e9e}{TAU\_\-completion} )(\hyperlink{struct__TAU__request}{TAU\_\-request} $\ast$request, int temperature, int count, int sequence)}
\label{TAU_8h_d31be806533f26c12656c982bc3c7e9e}

\begin{CompactList}\small\item\em Callback signature for the TAU completion routine. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
Thermal Assist Unit, interface. 

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


\footnotesize\begin{verbatim}
    CVS $Id: TAU.h,v 1.2 2011/03/25 21:15:03 saxton Exp $
\end{verbatim}
\normalsize


\begin{Desc}
\item[SYNOPSIS]This defines the callable interface to the TAU routines. These provide a C interface the TAU registers and functionality.\end{Desc}
See also the inlined versions of these routines in TAU.ih.