\hypertarget{RIM_8h}{
\section{RIM.h File Reference}
\label{RIM_8h}\index{RIM.h@{RIM.h}}
}
Public definitions for the RIM (Register In-Memory) facility. 

{\tt \#include $<$stdio.h$>$}\par


Include dependency graph for RIM.h:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=85pt]{RIM_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=157pt]{RIM_8h__dep__incl}
\end{center}
\end{figure}
\subsection*{Data Structures}
\begin{CompactItemize}
\item 
struct \hyperlink{structLayer__addr}{Layer\_\-addr}
\begin{CompactList}\small\item\em Address of a TFE/SPT node. \item\end{CompactList}\item 
struct \hyperlink{structACD__addr}{ACD\_\-addr}
\begin{CompactList}\small\item\em Address of a ARC/AFE node. \item\end{CompactList}\item 
struct \hyperlink{structTEM__addr}{TEM\_\-addr}
\begin{CompactList}\small\item\em Address of a TEM/TIC/CCC/TCC/CRC/TRC/CFE node. \item\end{CompactList}\item 
union \hyperlink{unionRIM__addr}{RIM\_\-addr}
\begin{CompactList}\small\item\em Union of all the address structures and an array, used for hierarchical leaf identification throughout RIM. \item\end{CompactList}\item 
struct \hyperlink{structRIM__errorInfo}{RIM\_\-error\-Info}
\begin{CompactList}\small\item\em Information used to record a read error occured. \item\end{CompactList}\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{RIM_8h_a0}{
typedef unsigned \hyperlink{RIM_8h_a0}{RIM\_\-type}}
\label{RIM_8h_a0}

\begin{CompactList}\small\item\em Creates a new type used to identify components (TEM, TFE etc). \item\end{CompactList}\item 
\hypertarget{RIM_8h_a1}{
typedef RIM\_\- \hyperlink{RIM_8h_a1}{RIM}}
\label{RIM_8h_a1}

\begin{CompactList}\small\item\em Forward declaration of the RIM structure. \item\end{CompactList}\item 
\hypertarget{RIM_8h_a2}{
typedef RIM\_\-map\_\- \hyperlink{RIM_8h_a2}{RIM\_\-map}}
\label{RIM_8h_a2}

\begin{CompactList}\small\item\em Forward declaration of the RIM\_\-map structure, a bit-map of all the LAT components. \item\end{CompactList}\item 
\hypertarget{RIM_8h_a3}{
typedef void( \hyperlink{RIM_8h_a3}{RIM\_\-decode\-Fn} )(unsigned short $\ast$\hyperlink{t__record_8c_a6}{pkt}, void $\ast$ptr)}
\label{RIM_8h_a3}

\begin{CompactList}\small\item\em Function that Decodes the response from one type of LAT register. \item\end{CompactList}\item 
\hypertarget{RIM_8h_a4}{
typedef unsigned( \hyperlink{RIM_8h_a4}{RIM\_\-load\-Fn} )(void $\ast$param, const \hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$addr, unsigned reg\-Id, const void $\ast$value)}
\label{RIM_8h_a4}

\begin{CompactList}\small\item\em Function that Loads one type of LAT register. \item\end{CompactList}\item 
\hypertarget{RIM_8h_a5}{
typedef unsigned( \hyperlink{RIM_8h_a5}{RIM\_\-read\-Fn} )(void $\ast$param, const \hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$addr, unsigned reg\-Id, \hyperlink{RIM_8h_a3}{RIM\_\-decode\-Fn} $\ast$decode\-Fn, void $\ast$dst, const \hyperlink{structRIM__errorInfo}{RIM\_\-error\-Info} $\ast$info)}
\label{RIM_8h_a5}

\begin{CompactList}\small\item\em Function that Reads one type of LAT register. \item\end{CompactList}\item 
\hypertarget{RIM_8h_a6}{
typedef void( \hyperlink{RIM_8h_a6}{RIM\_\-start\-Dgm} )(void $\ast$ctl)}
\label{RIM_8h_a6}

\begin{CompactList}\small\item\em Function called to start a new datagram. \item\end{CompactList}\item 
\hypertarget{RIM_8h_a7}{
typedef unsigned( \hyperlink{RIM_8h_a7}{RIM\_\-start\-Ctb} )(void $\ast$ctl, size\_\-t size, unsigned type)}
\label{RIM_8h_a7}

\begin{CompactList}\small\item\em Function called to start a new contribution. \item\end{CompactList}\item 
\hypertarget{RIM_8h_a8}{
typedef void( \hyperlink{RIM_8h_a8}{RIM\_\-add\-Data} )(void $\ast$ctl, void $\ast$data, size\_\-t size)}
\label{RIM_8h_a8}

\begin{CompactList}\small\item\em Function called to add data to a contribution. \item\end{CompactList}\item 
\hypertarget{RIM_8h_a9}{
typedef void( \hyperlink{RIM_8h_a9}{RIM\_\-end\-Ctb} )(void $\ast$ctl)}
\label{RIM_8h_a9}

\begin{CompactList}\small\item\em Function called to end a datagram. \item\end{CompactList}\item 
\hypertarget{RIM_8h_a10}{
typedef unsigned( \hyperlink{RIM_8h_a10}{RIM\_\-end\-Dgm} )(void $\ast$ctl)}
\label{RIM_8h_a10}

\begin{CompactList}\small\item\em Function called to end (and send) a datagram. \item\end{CompactList}\end{CompactItemize}
\subsection*{Enumerations}
\begin{CompactItemize}
\item 
enum \{ \par
{\bf LATC\_\-MAJ} =  14, 
\par
{\bf LATC\_\-MIN} =  0
 \}
\begin{CompactList}\small\item\em Current version numbers. \item\end{CompactList}\item 
enum \{ {\bf RIM\_\-MEM\_\-ALIGN} =  sizeof(unsigned long long)
 \}
\begin{CompactList}\small\item\em Memory alignment requirements on a memory block used for a RIM structure. \item\end{CompactList}\item 
enum \{ {\bf FIO\_\-PERMS} =  0666
 \}
\begin{CompactList}\small\item\em File permissions for output files. \item\end{CompactList}\item 
enum \hyperlink{RIM_8h_a87}{LATC\_\-CTB\_\-BASE\_\-ID} \{ \par
{\bf LATC\_\-SSR\_\-APID} =  0x3fd, 
\par
{\bf LATC\_\-CTB\_\-MAP} =  0, 
\par
{\bf LATC\_\-CTB\_\-DATA} =  128
 \}
\begin{CompactList}\small\item\em Contribution type base ID for the two types of LATC contributions. \item\end{CompactList}\item 
enum \{ \par
{\bf RIM\_\-BCAST\_\-ADDR} =  255, 
\par
{\bf N\_\-RIM\_\-ADDR\_\-CPTS} =  4
 \}
\begin{CompactList}\small\item\em Constant values associated with addressing LAT component instances. \item\end{CompactList}\item 
enum \{ {\bf RIM\_\-BAD\_\-TYPE} =  -1
 \}
\item 
enum \hyperlink{RIM_8h_a90}{RIM\_\-ERROR} \{ \par
{\bf RIM\_\-SUCCESS} =  0, 
\par
\hyperlink{RIM_8h_a90a22}{RIM\_\-ADDR\_\-BCAST} =  -11, 
\par
\hyperlink{RIM_8h_a90a23}{RIM\_\-ADDR\_\-RANGE} =  -12, 
\par
\hyperlink{RIM_8h_a90a24}{RIM\_\-ADDR\_\-INDEX} =  -13, 
\par
\hyperlink{RIM_8h_a90a25}{RIM\_\-ADDR\_\-LAYER} =  -14, 
\par
\hyperlink{RIM_8h_a90a26}{RIM\_\-ADDR\_\-LSIG} =  -15, 
\par
\hyperlink{RIM_8h_a90a27}{RIM\_\-ADDR\_\-LXY} =  -16, 
\par
\hyperlink{RIM_8h_a90a28}{RIM\_\-ADDR\_\-LIND} =  -17, 
\par
\hyperlink{RIM_8h_a90a29}{RIM\_\-TYPE\_\-UK} =  -21, 
\par
\hyperlink{RIM_8h_a90a30}{RIM\_\-TYPE\_\-STR} =  -22, 
\par
\hyperlink{RIM_8h_a90a31}{RIM\_\-MAP\_\-NONE} =  -31, 
\par
\hyperlink{RIM_8h_a90a32}{RIM\_\-DIFFER} =  -41, 
\par
\hyperlink{RIM_8h_a90a33}{RIM\_\-REG\_\-ID} =  -42, 
\par
\hyperlink{RIM_8h_a90a34}{RIM\_\-FLD\_\-ID} =  -43, 
\par
\hyperlink{RIM_8h_a90a35}{RIM\_\-NOT\_\-SET} =  -44, 
\par
\hyperlink{RIM_8h_a90a36}{RIM\_\-CPT\_\-NONE} =  -45, 
\par
\hyperlink{RIM_8h_a90a37}{RIM\_\-XML\_\-PARSE} =  -51, 
\par
\hyperlink{RIM_8h_a90a38}{RIM\_\-FILE\_\-END} =  -61, 
\par
\hyperlink{RIM_8h_a90a39}{RIM\_\-FILE\_\-READ} =  -62, 
\par
\hyperlink{RIM_8h_a90a40}{RIM\_\-FILE\_\-WRITE} =  -63, 
\par
\hyperlink{RIM_8h_a90a41}{RIM\_\-FILE\_\-OPEN} =  -64, 
\par
\hyperlink{RIM_8h_a90a42}{RIM\_\-FILE\_\-CLOSE} =  -65, 
\par
\hyperlink{RIM_8h_a90a43}{RIM\_\-BUF\_\-SHORT} =  -71, 
\par
\hyperlink{RIM_8h_a90a44}{RIM\_\-FLD\_\-RANGE} =  -81
 \}
\begin{CompactList}\small\item\em RIM error codes. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
\hypertarget{RIM_8h_a45}{
int {\bf RIM\_\-check\-Bit} (const \hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_a0}{RIM\_\-type} type, const \hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$addr)}
\label{RIM_8h_a45}

\item 
\hypertarget{RIM_8h_a46}{
void {\bf RIM\_\-clear} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim})}
\label{RIM_8h_a46}

\item 
\hypertarget{RIM_8h_a47}{
unsigned {\bf RIM\_\-clear\-Bit} (\hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_a0}{RIM\_\-type} type, const \hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$addr)}
\label{RIM_8h_a47}

\item 
\hypertarget{RIM_8h_a48}{
unsigned {\bf RIM\_\-clear\-By\-TWR} (\hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_a0}{RIM\_\-type} type, unsigned twr)}
\label{RIM_8h_a48}

\item 
\hypertarget{RIM_8h_a49}{
void {\bf RIM\_\-clear\-Map} (\hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map)}
\label{RIM_8h_a49}

\item 
\hypertarget{RIM_8h_a50}{
int {\bf RIM\_\-compare} (const \hyperlink{RIM_8h_a1}{RIM} $\ast$this, const \hyperlink{RIM_8h_a1}{RIM} $\ast$that, \hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map)}
\label{RIM_8h_a50}

\item 
\hypertarget{RIM_8h_a51}{
int {\bf RIM\_\-compare\-Type} (const char $\ast$string, \hyperlink{RIM_8h_a0}{RIM\_\-type} type)}
\label{RIM_8h_a51}

\item 
\hypertarget{RIM_8h_a52}{
\hyperlink{RIM_8h_a1}{RIM} $\ast$ {\bf RIM\_\-construct} (void $\ast$buffer)}
\label{RIM_8h_a52}

\item 
\hypertarget{RIM_8h_a53}{
\hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$ {\bf RIM\_\-construct\-Map} (void $\ast$buffer)}
\label{RIM_8h_a53}

\item 
\hypertarget{RIM_8h_a54}{
unsigned {\bf RIM\_\-consume} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim}, int fd)}
\label{RIM_8h_a54}

\item 
\hypertarget{RIM_8h_a55}{
unsigned {\bf RIM\_\-consume\-Map} (\hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map, int fd)}
\label{RIM_8h_a55}

\item 
\hypertarget{RIM_8h_a56}{
unsigned {\bf RIM\_\-contrast} (const \hyperlink{RIM_8h_a1}{RIM} $\ast$this, const \hyperlink{RIM_8h_a1}{RIM} $\ast$that, const \hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_a0}{RIM\_\-type} $\ast$r\_\-type, \hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$r\_\-addr)}
\label{RIM_8h_a56}

\item 
\hypertarget{RIM_8h_a57}{
void {\bf RIM\_\-correct} (\hyperlink{RIM_8h_a1}{RIM} $\ast$orig, \hyperlink{RIM_8h_a1}{RIM} $\ast$capt)}
\label{RIM_8h_a57}

\item 
\hypertarget{RIM_8h_a58}{
unsigned {\bf RIM\_\-create} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim}, \hyperlink{RIM_8h_a0}{RIM\_\-type} type, int fd)}
\label{RIM_8h_a58}

\item 
\hypertarget{RIM_8h_a59}{
unsigned {\bf RIM\_\-create\-Map} (\hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map, int fd)}
\label{RIM_8h_a59}

\item 
\hypertarget{RIM_8h_a60}{
unsigned {\bf RIM\_\-create\-Mask} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim})}
\label{RIM_8h_a60}

\item 
\hypertarget{RIM_8h_a61}{
void {\bf RIM\_\-dump\-Map} (\hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map, FILE $\ast$fp)}
\label{RIM_8h_a61}

\item 
\hypertarget{RIM_8h_a62}{
unsigned {\bf RIM\_\-get} (const \hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim}, \hyperlink{RIM_8h_a0}{RIM\_\-type} type, const \hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$addr, int reg\-Id, void $\ast$value)}
\label{RIM_8h_a62}

\item 
\hypertarget{RIM_8h_a63}{
unsigned {\bf RIM\_\-get\-Address} (\hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$addr, unsigned index, \hyperlink{RIM_8h_a0}{RIM\_\-type} type)}
\label{RIM_8h_a63}

\item 
\hypertarget{RIM_8h_a64}{
unsigned {\bf RIM\_\-get\-Addr\-Rng} (const char $\ast$string, \hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$addr)}
\label{RIM_8h_a64}

\item 
\hypertarget{RIM_8h_a65}{
const char $\ast$ {\bf RIM\_\-get\-Error\-String} (\hyperlink{RIM_8h_a90}{RIM\_\-ERROR} err)}
\label{RIM_8h_a65}

\item 
\hypertarget{RIM_8h_a66}{
unsigned {\bf RIM\_\-get\-Index} (const \hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$addr, unsigned $\ast$index, \hyperlink{RIM_8h_a0}{RIM\_\-type} type)}
\label{RIM_8h_a66}

\item 
\hypertarget{RIM_8h_a67}{
unsigned {\bf RIM\_\-get\-Layer\-ID} (char sign, char xy, char index, unsigned $\ast$layer)}
\label{RIM_8h_a67}

\item 
\hypertarget{RIM_8h_a68}{
unsigned {\bf RIM\_\-get\-Layer\-Name} (unsigned layer, char $\ast$sign, char $\ast$xy, char $\ast$index)}
\label{RIM_8h_a68}

\item 
\hypertarget{RIM_8h_a69}{
unsigned {\bf RIM\_\-load} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim}, void $\ast$param, \hyperlink{RIM_8h_a4}{RIM\_\-load\-Fn} $\ast$$\ast$load\-Fn)}
\label{RIM_8h_a69}

\item 
\hypertarget{RIM_8h_a70}{
unsigned {\bf RIM\_\-load\-Mdfy} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim}, \hyperlink{RIM_8h_a0}{RIM\_\-type} type, unsigned reg, unsigned fe\-Mask, void $\ast$mask, void $\ast$value, void $\ast$param, \hyperlink{RIM_8h_a4}{RIM\_\-load\-Fn} $\ast$$\ast$load\-Fn)}
\label{RIM_8h_a70}

\item 
\hypertarget{RIM_8h_a71}{
\hyperlink{RIM_8h_a0}{RIM\_\-type} {\bf RIM\_\-lookup\-Type} (const char $\ast$string)}
\label{RIM_8h_a71}

\item 
\hypertarget{RIM_8h_a72}{
unsigned {\bf RIM\_\-name\-Type} (char $\ast$string, \hyperlink{RIM_8h_a0}{RIM\_\-type} type)}
\label{RIM_8h_a72}

\item 
\hypertarget{RIM_8h_a73}{
unsigned {\bf RIM\_\-n\-Types} (void)}
\label{RIM_8h_a73}

\item 
\hypertarget{RIM_8h_a74}{
unsigned {\bf RIM\_\-read} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim}, void $\ast$param, \hyperlink{RIM_8h_a5}{RIM\_\-read\-Fn} $\ast$$\ast$read\-Fn, \hyperlink{RIM_8h_a3}{RIM\_\-decode\-Fn} $\ast$$\ast$decode\-Fn, const \hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$ign)}
\label{RIM_8h_a74}

\item 
\hypertarget{RIM_8h_a75}{
unsigned {\bf RIM\_\-record} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim}, void $\ast$\hyperlink{t__record_8c_a6}{pkt}, \hyperlink{RIM_8h_a6}{RIM\_\-start\-Dgm} $\ast$start\-Dgm, \hyperlink{RIM_8h_a7}{RIM\_\-start\-Ctb} $\ast$start\-Ctb, \hyperlink{RIM_8h_a8}{RIM\_\-add\-Data} $\ast$add\-Data, \hyperlink{RIM_8h_a9}{RIM\_\-end\-Ctb} $\ast$end\-Ctb, \hyperlink{RIM_8h_a10}{RIM\_\-end\-Dgm} $\ast$end\-Dgm)}
\label{RIM_8h_a75}

\item 
\hypertarget{RIM_8h_a76}{
void {\bf RIM\_\-report} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim}, FILE $\ast$fp, unsigned no\-Dflt)}
\label{RIM_8h_a76}

\item 
\hypertarget{RIM_8h_a77}{
unsigned {\bf RIM\_\-retrieve} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim}, char $\ast$dat, size\_\-t len, unsigned id, int verb)}
\label{RIM_8h_a77}

\item 
\hypertarget{RIM_8h_a78}{
unsigned {\bf RIM\_\-set} (\hyperlink{RIM_8h_a1}{RIM} $\ast$\hyperlink{t__record_8c_a4}{rim}, \hyperlink{RIM_8h_a0}{RIM\_\-type} type, const \hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$addr, int reg\-Id, const void $\ast$value)}
\label{RIM_8h_a78}

\item 
\hypertarget{RIM_8h_a79}{
unsigned {\bf RIM\_\-set\-Bit} (\hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_a0}{RIM\_\-type} type, const \hyperlink{unionRIM__addr}{RIM\_\-addr} $\ast$addr)}
\label{RIM_8h_a79}

\item 
\hypertarget{RIM_8h_a80}{
unsigned {\bf RIM\_\-set\-By\-TWR} (\hyperlink{RIM_8h_a2}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_a0}{RIM\_\-type} type, unsigned twr)}
\label{RIM_8h_a80}

\item 
\hypertarget{RIM_8h_a81}{
void {\bf RIM\_\-set\-SPT} (void $\ast$ptr, unsigned short value, unsigned is\-High)}
\label{RIM_8h_a81}

\item 
\hypertarget{RIM_8h_a82}{
size\_\-t {\bf RIM\_\-sizeof} (void)}
\label{RIM_8h_a82}

\item 
\hypertarget{RIM_8h_a83}{
size\_\-t {\bf RIM\_\-sizeof\-Map} (void)}
\label{RIM_8h_a83}

\end{CompactItemize}


\subsection{Detailed Description}
Public definitions for the RIM (Register In-Memory) facility. 

\begin{Desc}
\item[Author:]James Swain \& Owen Saxton\end{Desc}
\begin{Desc}
\item[Id]\hyperlink{RIM_8h}{RIM.h},v 1.2 2007/03/22 23:40:00 saxton Exp \end{Desc}


\subsection{Enumeration Type Documentation}
\hypertarget{RIM_8h_a90}{
\index{RIM.h@{RIM.h}!RIM_ERROR@{RIM\_\-ERROR}}
\index{RIM_ERROR@{RIM\_\-ERROR}!RIM.h@{RIM.h}}
\subsubsection[RIM\_\-ERROR]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{RIM_8h_a90}{RIM\_\-ERROR}}}
\label{RIM_8h_a90}


RIM error codes. 

\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{RIM_ADDR_BCAST@{RIM\_\-ADDR\_\-BCAST}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_ADDR_BCAST@{RIM\_\-ADDR\_\-BCAST}}\item[{\em 
\hypertarget{RIM_8h_a90a22}{
RIM\_\-ADDR\_\-BCAST}
\label{RIM_8h_a90a22}
}]Address structure has a mixture of broadcast and unicast components. \index{RIM_ADDR_RANGE@{RIM\_\-ADDR\_\-RANGE}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_ADDR_RANGE@{RIM\_\-ADDR\_\-RANGE}}\item[{\em 
\hypertarget{RIM_8h_a90a23}{
RIM\_\-ADDR\_\-RANGE}
\label{RIM_8h_a90a23}
}]Address structure has a component out of range. \index{RIM_ADDR_INDEX@{RIM\_\-ADDR\_\-INDEX}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_ADDR_INDEX@{RIM\_\-ADDR\_\-INDEX}}\item[{\em 
\hypertarget{RIM_8h_a90a24}{
RIM\_\-ADDR\_\-INDEX}
\label{RIM_8h_a90a24}
}]The final index exceeds the total number of bits in the map. \index{RIM_ADDR_LAYER@{RIM\_\-ADDR\_\-LAYER}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_ADDR_LAYER@{RIM\_\-ADDR\_\-LAYER}}\item[{\em 
\hypertarget{RIM_8h_a90a25}{
RIM\_\-ADDR\_\-LAYER}
\label{RIM_8h_a90a25}
}]The layer information is nonsensical. \index{RIM_ADDR_LSIG@{RIM\_\-ADDR\_\-LSIG}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_ADDR_LSIG@{RIM\_\-ADDR\_\-LSIG}}\item[{\em 
\hypertarget{RIM_8h_a90a26}{
RIM\_\-ADDR\_\-LSIG}
\label{RIM_8h_a90a26}
}]The layer sign is wrong. \index{RIM_ADDR_LXY@{RIM\_\-ADDR\_\-LXY}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_ADDR_LXY@{RIM\_\-ADDR\_\-LXY}}\item[{\em 
\hypertarget{RIM_8h_a90a27}{
RIM\_\-ADDR\_\-LXY}
\label{RIM_8h_a90a27}
}]The layer x/y is wrong. \index{RIM_ADDR_LIND@{RIM\_\-ADDR\_\-LIND}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_ADDR_LIND@{RIM\_\-ADDR\_\-LIND}}\item[{\em 
\hypertarget{RIM_8h_a90a28}{
RIM\_\-ADDR\_\-LIND}
\label{RIM_8h_a90a28}
}]The layer index is wrong. \index{RIM_TYPE_UK@{RIM\_\-TYPE\_\-UK}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_TYPE_UK@{RIM\_\-TYPE\_\-UK}}\item[{\em 
\hypertarget{RIM_8h_a90a29}{
RIM\_\-TYPE\_\-UK}
\label{RIM_8h_a90a29}
}]RIM\_\-type is unknown. \index{RIM_TYPE_STR@{RIM\_\-TYPE\_\-STR}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_TYPE_STR@{RIM\_\-TYPE\_\-STR}}\item[{\em 
\hypertarget{RIM_8h_a90a30}{
RIM\_\-TYPE\_\-STR}
\label{RIM_8h_a90a30}
}]The string does not match a type name. \index{RIM_MAP_NONE@{RIM\_\-MAP\_\-NONE}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_MAP_NONE@{RIM\_\-MAP\_\-NONE}}\item[{\em 
\hypertarget{RIM_8h_a90a31}{
RIM\_\-MAP\_\-NONE}
\label{RIM_8h_a90a31}
}]There is no sub-map corresponding to this type. \index{RIM_DIFFER@{RIM\_\-DIFFER}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_DIFFER@{RIM\_\-DIFFER}}\item[{\em 
\hypertarget{RIM_8h_a90a32}{
RIM\_\-DIFFER}
\label{RIM_8h_a90a32}
}]Two RIM structures are functionally different. \index{RIM_REG_ID@{RIM\_\-REG\_\-ID}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_REG_ID@{RIM\_\-REG\_\-ID}}\item[{\em 
\hypertarget{RIM_8h_a90a33}{
RIM\_\-REG\_\-ID}
\label{RIM_8h_a90a33}
}]The register ID is out of range. \index{RIM_FLD_ID@{RIM\_\-FLD\_\-ID}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_FLD_ID@{RIM\_\-FLD\_\-ID}}\item[{\em 
\hypertarget{RIM_8h_a90a34}{
RIM\_\-FLD\_\-ID}
\label{RIM_8h_a90a34}
}]The field ID is out of range. \index{RIM_NOT_SET@{RIM\_\-NOT\_\-SET}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_NOT_SET@{RIM\_\-NOT\_\-SET}}\item[{\em 
\hypertarget{RIM_8h_a90a35}{
RIM\_\-NOT\_\-SET}
\label{RIM_8h_a90a35}
}]The requested node has not be previously set. \index{RIM_CPT_NONE@{RIM\_\-CPT\_\-NONE}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_CPT_NONE@{RIM\_\-CPT\_\-NONE}}\item[{\em 
\hypertarget{RIM_8h_a90a36}{
RIM\_\-CPT\_\-NONE}
\label{RIM_8h_a90a36}
}]The requested node has no real data. \index{RIM_XML_PARSE@{RIM\_\-XML\_\-PARSE}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_XML_PARSE@{RIM\_\-XML\_\-PARSE}}\item[{\em 
\hypertarget{RIM_8h_a90a37}{
RIM\_\-XML\_\-PARSE}
\label{RIM_8h_a90a37}
}]There was an error parsing the XML. \index{RIM_FILE_END@{RIM\_\-FILE\_\-END}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_FILE_END@{RIM\_\-FILE\_\-END}}\item[{\em 
\hypertarget{RIM_8h_a90a38}{
RIM\_\-FILE\_\-END}
\label{RIM_8h_a90a38}
}]File end was reached. \index{RIM_FILE_READ@{RIM\_\-FILE\_\-READ}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_FILE_READ@{RIM\_\-FILE\_\-READ}}\item[{\em 
\hypertarget{RIM_8h_a90a39}{
RIM\_\-FILE\_\-READ}
\label{RIM_8h_a90a39}
}]There was an error reading a file. \index{RIM_FILE_WRITE@{RIM\_\-FILE\_\-WRITE}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_FILE_WRITE@{RIM\_\-FILE\_\-WRITE}}\item[{\em 
\hypertarget{RIM_8h_a90a40}{
RIM\_\-FILE\_\-WRITE}
\label{RIM_8h_a90a40}
}]There was an error writing to a file. \index{RIM_FILE_OPEN@{RIM\_\-FILE\_\-OPEN}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_FILE_OPEN@{RIM\_\-FILE\_\-OPEN}}\item[{\em 
\hypertarget{RIM_8h_a90a41}{
RIM\_\-FILE\_\-OPEN}
\label{RIM_8h_a90a41}
}]There was an error opening a file. \index{RIM_FILE_CLOSE@{RIM\_\-FILE\_\-CLOSE}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_FILE_CLOSE@{RIM\_\-FILE\_\-CLOSE}}\item[{\em 
\hypertarget{RIM_8h_a90a42}{
RIM\_\-FILE\_\-CLOSE}
\label{RIM_8h_a90a42}
}]There was an error closing a file. \index{RIM_BUF_SHORT@{RIM\_\-BUF\_\-SHORT}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_BUF_SHORT@{RIM\_\-BUF\_\-SHORT}}\item[{\em 
\hypertarget{RIM_8h_a90a43}{
RIM\_\-BUF\_\-SHORT}
\label{RIM_8h_a90a43}
}]Supplied buffer is too short. \index{RIM_FLD_RANGE@{RIM\_\-FLD\_\-RANGE}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM_FLD_RANGE@{RIM\_\-FLD\_\-RANGE}}\item[{\em 
\hypertarget{RIM_8h_a90a44}{
RIM\_\-FLD\_\-RANGE}
\label{RIM_8h_a90a44}
}]Value being loaded into a field is too large. \end{description}
\end{Desc}

