\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 $<$stdlib.h$>$}\par
\subsection*{Classes}
\begin{CompactItemize}
\item 
struct \hyperlink{struct__Layer__addr}{\_\-Layer\_\-addr}
\begin{CompactList}\small\item\em Address of a TFE/SPT node. \item\end{CompactList}\item 
struct \hyperlink{struct__ACD__addr}{\_\-ACD\_\-addr}
\begin{CompactList}\small\item\em Address of a ARC/AFE node. \item\end{CompactList}\item 
struct \hyperlink{struct__TEM__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{union__RIM__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{struct__RIM__rqstInfo}{\_\-RIM\_\-rqstInfo}
\begin{CompactList}\small\item\em Information describing a read request. \item\end{CompactList}\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
\hypertarget{RIM_8h_578d1975a05e3ce266f6693af764aa86}{
typedef unsigned \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type}}
\label{RIM_8h_578d1975a05e3ce266f6693af764aa86}

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

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

\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_fb148443630c494d2314340639c012d8}{
typedef struct \hyperlink{struct__Layer__addr}{\_\-Layer\_\-addr} \hyperlink{RIM_8h_fb148443630c494d2314340639c012d8}{Layer\_\-addr}}
\label{RIM_8h_fb148443630c494d2314340639c012d8}

\begin{CompactList}\small\item\em Address of a TFE/SPT node. \item\end{CompactList}\item 
\hypertarget{RIM_8h_e5c8b533e62a6fd75a689bce1b47c601}{
typedef struct \hyperlink{struct__ACD__addr}{\_\-ACD\_\-addr} \hyperlink{RIM_8h_e5c8b533e62a6fd75a689bce1b47c601}{ACD\_\-addr}}
\label{RIM_8h_e5c8b533e62a6fd75a689bce1b47c601}

\begin{CompactList}\small\item\em Address of a ARC/AFE node. \item\end{CompactList}\item 
\hypertarget{RIM_8h_2d6b76fce437cce2dafd8ff2b3e8f271}{
typedef struct \hyperlink{struct__TEM__addr}{\_\-TEM\_\-addr} \hyperlink{RIM_8h_2d6b76fce437cce2dafd8ff2b3e8f271}{TEM\_\-addr}}
\label{RIM_8h_2d6b76fce437cce2dafd8ff2b3e8f271}

\begin{CompactList}\small\item\em Address of a TEM/TIC/CCC/TCC/CRC/TRC/CFE node. \item\end{CompactList}\item 
\hypertarget{RIM_8h_aa53dcbb6a9bbd0888fd24f43d553c25}{
typedef union \hyperlink{union__RIM__addr}{\_\-RIM\_\-addr} \hyperlink{RIM_8h_aa53dcbb6a9bbd0888fd24f43d553c25}{RIM\_\-addr}}
\label{RIM_8h_aa53dcbb6a9bbd0888fd24f43d553c25}

\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 
typedef struct \hyperlink{struct__RIM__rqstInfo}{\_\-RIM\_\-rqstInfo} \hyperlink{RIM_8h_d69d48908c6bc796278b2189811a4ca0}{RIM\_\-rqstInfo}
\begin{CompactList}\small\item\em Information describing a read request. \item\end{CompactList}\item 
\hypertarget{RIM_8h_456edda1e1a3eccb960b1207956ee6a0}{
typedef void \hyperlink{RIM_8h_456edda1e1a3eccb960b1207956ee6a0}{RIM\_\-decodeFn} (unsigned short $\ast$pkt, void $\ast$ptr, const \hyperlink{struct__RIM__rqstInfo}{RIM\_\-rqstInfo} $\ast$info)}
\label{RIM_8h_456edda1e1a3eccb960b1207956ee6a0}

\begin{CompactList}\small\item\em Function that Decodes the response from one type of LAT register. \item\end{CompactList}\item 
\hypertarget{RIM_8h_40be2dd985735617fb38c2b637926f45}{
typedef unsigned \hyperlink{RIM_8h_40be2dd985735617fb38c2b637926f45}{RIM\_\-loadFn} (void $\ast$param, const \hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$addr, unsigned regId, const void $\ast$value)}
\label{RIM_8h_40be2dd985735617fb38c2b637926f45}

\begin{CompactList}\small\item\em Function that Loads one type of LAT register. \item\end{CompactList}\item 
\hypertarget{RIM_8h_7d6044f709e901c43ff7ccac55ef050b}{
typedef unsigned \hyperlink{RIM_8h_7d6044f709e901c43ff7ccac55ef050b}{RIM\_\-readFn} (void $\ast$param, const \hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$addr, unsigned regId, \hyperlink{RIM_8h_456edda1e1a3eccb960b1207956ee6a0}{RIM\_\-decodeFn} $\ast$decodeFn, void $\ast$dst, const \hyperlink{struct__RIM__rqstInfo}{RIM\_\-rqstInfo} $\ast$info)}
\label{RIM_8h_7d6044f709e901c43ff7ccac55ef050b}

\begin{CompactList}\small\item\em Function that Reads one type of LAT register. \item\end{CompactList}\item 
\hypertarget{RIM_8h_bdc552e93b5e942176b14d6371f94bb6}{
typedef unsigned \hyperlink{RIM_8h_bdc552e93b5e942176b14d6371f94bb6}{RIM\_\-expRecdCB} (void $\ast$parm, unsigned type, int leng)}
\label{RIM_8h_bdc552e93b5e942176b14d6371f94bb6}

\begin{CompactList}\small\item\em Function called to start the export of a new record. \item\end{CompactList}\item 
\hypertarget{RIM_8h_13493529fee92f2c97e7ed60aae8100e}{
typedef unsigned \hyperlink{RIM_8h_13493529fee92f2c97e7ed60aae8100e}{RIM\_\-expDataCB} (void $\ast$parm, void $\ast$data, int leng)}
\label{RIM_8h_13493529fee92f2c97e7ed60aae8100e}

\begin{CompactList}\small\item\em Function called to export data for a record. \item\end{CompactList}\item 
\hypertarget{RIM_8h_4e7d8a31b796cf9730af53684d140440}{
typedef unsigned \hyperlink{RIM_8h_4e7d8a31b796cf9730af53684d140440}{RIM\_\-impRecdCB} (void $\ast$parm, unsigned $\ast$type, int $\ast$leng)}
\label{RIM_8h_4e7d8a31b796cf9730af53684d140440}

\begin{CompactList}\small\item\em Function called to start the import of a new record. \item\end{CompactList}\item 
\hypertarget{RIM_8h_b9894a0d0ed193d3c211b0fc61d14007}{
typedef unsigned \hyperlink{RIM_8h_b9894a0d0ed193d3c211b0fc61d14007}{RIM\_\-impDataCB} (void $\ast$parm, int iShrt, void $\ast$data, int rLeng, int $\ast$leng)}
\label{RIM_8h_b9894a0d0ed193d3c211b0fc61d14007}

\begin{CompactList}\small\item\em Function called to import data for a record. \item\end{CompactList}\end{CompactItemize}
\subsection*{Enumerations}
\begin{CompactItemize}
\item 
enum \{ \par
\textbf{LATC\_\-MAJ} =  15, 
\par
\textbf{LATC\_\-MIN} =  0
 \}
\begin{CompactList}\small\item\em Current version numbers. \item\end{CompactList}\item 
enum \{ \par
\hyperlink{RIM_8h_df764cbdea00d65edcd07bb9953ad2b77e93d8fa8688b1140f28bbcca0e2d415}{RIM\_\-OPT\_\-SWAP} =  0x01, 
\par
\hyperlink{RIM_8h_df764cbdea00d65edcd07bb9953ad2b7a7e1f99126d72445475d494831ff7cc4}{RIM\_\-OPT\_\-CURR} =  0x02
 \}
\begin{CompactList}\small\item\em Import options. \item\end{CompactList}\item 
enum \{ \textbf{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 \{ \par
\textbf{RIM\_\-BCAST\_\-ADDR} =  255, 
\par
\textbf{N\_\-RIM\_\-ADDR\_\-CPTS} =  4
 \}
\begin{CompactList}\small\item\em Constant values associated with addressing LAT component instances. \item\end{CompactList}\item 
enum \{ \textbf{RIM\_\-BAD\_\-TYPE} =  -1
 \}
\item 
enum \{ \par
\hyperlink{RIM_8h_61dadd085c1777f559549e05962b2c9e18a9f92a17ad2f14f2a4a407a34a1110}{UID\_\-INDEX} =  0x0ffff, 
\par
\hyperlink{RIM_8h_61dadd085c1777f559549e05962b2c9ec08e4f543d741949e78757b1ec50859c}{UID\_\-IGN\_\-ERROR} =  0x10000, 
\par
\hyperlink{RIM_8h_61dadd085c1777f559549e05962b2c9ee5cc94ab70a87cd120b7eca5d146db12}{UID\_\-SPT\_\-HIGH} =  0x20000, 
\par
\hyperlink{RIM_8h_61dadd085c1777f559549e05962b2c9e7971de8b22580c2c1c95d7e51c51e5d8}{UID\_\-SPT\_\-TFE} =  0x40000, 
\par
\hyperlink{RIM_8h_61dadd085c1777f559549e05962b2c9ec862956ecda2975c563484b248de1d23}{UID\_\-SPT\_\-LAST} =  0x80000
 \}
\begin{CompactList}\small\item\em Masks for fields in the read request uid value. \item\end{CompactList}\end{CompactItemize}
\subsection*{Functions}
\begin{CompactItemize}
\item 
\hypertarget{RIM_8h_e916a4c6f3708bc8d114d510008f12e1}{
int \textbf{RIM\_\-checkBit} (const \hyperlink{RIM_8h_5683ec066f5c5d208b486ffdedfd54f3}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} type, const \hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$addr)}
\label{RIM_8h_e916a4c6f3708bc8d114d510008f12e1}

\item 
\hypertarget{RIM_8h_24501a5bac335d0a4ca05ca52845cdaa}{
void \textbf{RIM\_\-checkSplit} (short $\ast$ptr, unsigned long long value, unsigned int uid)}
\label{RIM_8h_24501a5bac335d0a4ca05ca52845cdaa}

\item 
\hypertarget{RIM_8h_9542583e2681a7d5681158f59dd989a9}{
void \textbf{RIM\_\-clear} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim)}
\label{RIM_8h_9542583e2681a7d5681158f59dd989a9}

\item 
\hypertarget{RIM_8h_2edbf990904f05352afef16829d0a298}{
unsigned \textbf{RIM\_\-clearBit} (\hyperlink{RIM_8h_5683ec066f5c5d208b486ffdedfd54f3}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} type, const \hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$addr)}
\label{RIM_8h_2edbf990904f05352afef16829d0a298}

\item 
\hypertarget{RIM_8h_b2d9937e69a38207cad9b2b655428edf}{
void \textbf{RIM\_\-clearMap} (\hyperlink{RIM_8h_5683ec066f5c5d208b486ffdedfd54f3}{RIM\_\-map} $\ast$map)}
\label{RIM_8h_b2d9937e69a38207cad9b2b655428edf}

\item 
\hypertarget{RIM_8h_cb5c390646a42f66d9cfdb50e425d8c5}{
int \textbf{RIM\_\-compare} (const \hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim1, const \hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim2, \hyperlink{RIM_8h_5683ec066f5c5d208b486ffdedfd54f3}{RIM\_\-map} $\ast$map)}
\label{RIM_8h_cb5c390646a42f66d9cfdb50e425d8c5}

\item 
\hypertarget{RIM_8h_c4c862001b32f6ad2d7226d2d252fd06}{
int \textbf{RIM\_\-compareType} (const char $\ast$string, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} type)}
\label{RIM_8h_c4c862001b32f6ad2d7226d2d252fd06}

\item 
\hypertarget{RIM_8h_48f1fc27dc9a90ae0097a089c07f2d69}{
\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$ \textbf{RIM\_\-construct} (void $\ast$buffer)}
\label{RIM_8h_48f1fc27dc9a90ae0097a089c07f2d69}

\item 
\hypertarget{RIM_8h_9b47eae4434c81b75970ba29ac2902b3}{
\hyperlink{RIM_8h_5683ec066f5c5d208b486ffdedfd54f3}{RIM\_\-map} $\ast$ \textbf{RIM\_\-constructMap} (void $\ast$buffer)}
\label{RIM_8h_9b47eae4434c81b75970ba29ac2902b3}

\item 
\hypertarget{RIM_8h_73e4162ee97aeed85b7fa4b01fbbe1b2}{
unsigned \textbf{RIM\_\-contrast} (const \hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim1, const \hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim2, const \hyperlink{RIM_8h_5683ec066f5c5d208b486ffdedfd54f3}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} $\ast$r\_\-type, \hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$r\_\-addr)}
\label{RIM_8h_73e4162ee97aeed85b7fa4b01fbbe1b2}

\item 
\hypertarget{RIM_8h_a8e76e0c1dd1cd8fc797513be2725e3d}{
void \textbf{RIM\_\-correct} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$orig, \hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$capt)}
\label{RIM_8h_a8e76e0c1dd1cd8fc797513be2725e3d}

\item 
\hypertarget{RIM_8h_7116862875423f008a1a8edec64cfec8}{
int \textbf{RIM\_\-countMap} (const \hyperlink{RIM_8h_5683ec066f5c5d208b486ffdedfd54f3}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} type)}
\label{RIM_8h_7116862875423f008a1a8edec64cfec8}

\item 
\hypertarget{RIM_8h_3566fc4d9130f51cdd8a7eda3d012171}{
void \textbf{RIM\_\-dataMasks} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, unsigned int $\ast$dMask, unsigned int $\ast$eMask)}
\label{RIM_8h_3566fc4d9130f51cdd8a7eda3d012171}

\item 
\hypertarget{RIM_8h_588f9722fd7e300aa8a145e99fd2627f}{
unsigned \textbf{RIM\_\-export} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, unsigned int typMask, \hyperlink{RIM_8h_bdc552e93b5e942176b14d6371f94bb6}{RIM\_\-expRecdCB} recdRtn, \hyperlink{RIM_8h_13493529fee92f2c97e7ed60aae8100e}{RIM\_\-expDataCB} dataRtn, void $\ast$parm)}
\label{RIM_8h_588f9722fd7e300aa8a145e99fd2627f}

\item 
\hypertarget{RIM_8h_1cf019303d4a5796719127d050fa7a61}{
unsigned \textbf{RIM\_\-exportMap} (\hyperlink{RIM_8h_5683ec066f5c5d208b486ffdedfd54f3}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_bdc552e93b5e942176b14d6371f94bb6}{RIM\_\-expRecdCB} recdRtn, \hyperlink{RIM_8h_13493529fee92f2c97e7ed60aae8100e}{RIM\_\-expDataCB} dataRtn, void $\ast$parm)}
\label{RIM_8h_1cf019303d4a5796719127d050fa7a61}

\item 
\hypertarget{RIM_8h_d6acae40a94386291643f2fa42fd745c}{
unsigned \textbf{RIM\_\-get} (const \hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} type, const \hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$addr, int regId, void $\ast$value)}
\label{RIM_8h_d6acae40a94386291643f2fa42fd745c}

\item 
\hypertarget{RIM_8h_1f8ff9fd2bca009fc966a0125cd1a543}{
unsigned \textbf{RIM\_\-getAddress} (\hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$addr, unsigned int index, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} type)}
\label{RIM_8h_1f8ff9fd2bca009fc966a0125cd1a543}

\item 
\hypertarget{RIM_8h_e59252ce9ce9544ed65d57f03f56151e}{
unsigned \textbf{RIM\_\-getAddrRng} (const char $\ast$string, \hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$addr)}
\label{RIM_8h_e59252ce9ce9544ed65d57f03f56151e}

\item 
\hypertarget{RIM_8h_5cabac0a9a770f1f6025da5ea1083a6f}{
unsigned \textbf{RIM\_\-getIndex} (const \hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$addr, unsigned int $\ast$index, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} type)}
\label{RIM_8h_5cabac0a9a770f1f6025da5ea1083a6f}

\item 
\hypertarget{RIM_8h_589af03832ad1e942b81bf9f3b55431f}{
unsigned \textbf{RIM\_\-getLayerID} (const char $\ast$name, unsigned int $\ast$layer)}
\label{RIM_8h_589af03832ad1e942b81bf9f3b55431f}

\item 
\hypertarget{RIM_8h_3f075ec5553f4004f74fe0d3fac1fb08}{
unsigned \textbf{RIM\_\-getLayerName} (unsigned int layer, char $\ast$name)}
\label{RIM_8h_3f075ec5553f4004f74fe0d3fac1fb08}

\item 
\hypertarget{RIM_8h_5092ae512f130bf2fc787c6fb3a47926}{
unsigned \textbf{RIM\_\-import} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, int optns, unsigned short $\ast$versn, \hyperlink{RIM_8h_4e7d8a31b796cf9730af53684d140440}{RIM\_\-impRecdCB} recdRtn, \hyperlink{RIM_8h_b9894a0d0ed193d3c211b0fc61d14007}{RIM\_\-impDataCB} dataRtn, void $\ast$parm)}
\label{RIM_8h_5092ae512f130bf2fc787c6fb3a47926}

\item 
\hypertarget{RIM_8h_6d56c1b9095af830b9b93f2c16822b2c}{
unsigned \textbf{RIM\_\-importMap} (\hyperlink{RIM_8h_5683ec066f5c5d208b486ffdedfd54f3}{RIM\_\-map} $\ast$map, int optns, unsigned short $\ast$versn, \hyperlink{RIM_8h_4e7d8a31b796cf9730af53684d140440}{RIM\_\-impRecdCB} recdRtn, \hyperlink{RIM_8h_b9894a0d0ed193d3c211b0fc61d14007}{RIM\_\-impDataCB} dataRtn, void $\ast$parm)}
\label{RIM_8h_6d56c1b9095af830b9b93f2c16822b2c}

\item 
\hypertarget{RIM_8h_600604fb11a89d7120fdc383ef702f97}{
unsigned \textbf{RIM\_\-load} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, void $\ast$param, \hyperlink{RIM_8h_40be2dd985735617fb38c2b637926f45}{RIM\_\-loadFn} $\ast$$\ast$loadFn)}
\label{RIM_8h_600604fb11a89d7120fdc383ef702f97}

\item 
\hypertarget{RIM_8h_83237b7ff2ac863b53ae0e1d01d47e91}{
unsigned \textbf{RIM\_\-loadAfeConfig} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, unsigned int mask, unsigned int value0, unsigned int value1, unsigned int rcMask, unsigned int feMask, void $\ast$param, \hyperlink{RIM_8h_40be2dd985735617fb38c2b637926f45}{RIM\_\-loadFn} $\ast$$\ast$loadFn)}
\label{RIM_8h_83237b7ff2ac863b53ae0e1d01d47e91}

\item 
\hypertarget{RIM_8h_e073368687d4d58b98e902fbcd79759b}{
unsigned \textbf{RIM\_\-loadCfeConfig0} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, unsigned int mask, unsigned int value, void $\ast$param, \hyperlink{RIM_8h_40be2dd985735617fb38c2b637926f45}{RIM\_\-loadFn} $\ast$$\ast$loadFn)}
\label{RIM_8h_e073368687d4d58b98e902fbcd79759b}

\item 
\hypertarget{RIM_8h_c996815f2892728bc8c3402bf7eeb6f8}{
unsigned \textbf{RIM\_\-loadCfeConfig1} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, unsigned int mask, unsigned int value0, unsigned int value1, unsigned int cMask, void $\ast$param, \hyperlink{RIM_8h_40be2dd985735617fb38c2b637926f45}{RIM\_\-loadFn} $\ast$$\ast$loadFn)}
\label{RIM_8h_c996815f2892728bc8c3402bf7eeb6f8}

\item 
\hypertarget{RIM_8h_92cae81f707248fca5a8a187b7158a87}{
unsigned \textbf{RIM\_\-loadSplit} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, int nLow, int nHigh, void $\ast$param, \hyperlink{RIM_8h_40be2dd985735617fb38c2b637926f45}{RIM\_\-loadFn} $\ast$$\ast$loadFn)}
\label{RIM_8h_92cae81f707248fca5a8a187b7158a87}

\item 
\hypertarget{RIM_8h_d74a95cbf44ec12348575f1f4afb0091}{
unsigned \textbf{RIM\_\-loadTfeDac} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, unsigned int mask, unsigned int value, int nLow, int nHigh, void $\ast$param, \hyperlink{RIM_8h_40be2dd985735617fb38c2b637926f45}{RIM\_\-loadFn} $\ast$$\ast$loadFn)}
\label{RIM_8h_d74a95cbf44ec12348575f1f4afb0091}

\item 
\hypertarget{RIM_8h_0c8ce01846b056ca5c06efcab115986b}{
\hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} \textbf{RIM\_\-lookupType} (const char $\ast$string)}
\label{RIM_8h_0c8ce01846b056ca5c06efcab115986b}

\item 
\hypertarget{RIM_8h_94e278b66927d9df7f7ffabf9dd21a08}{
unsigned \textbf{RIM\_\-nameType} (char $\ast$string, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} type)}
\label{RIM_8h_94e278b66927d9df7f7ffabf9dd21a08}

\item 
\hypertarget{RIM_8h_b969895deba3cd20677c8e8ae2563c8f}{
unsigned \textbf{RIM\_\-nTypes} (void)}
\label{RIM_8h_b969895deba3cd20677c8e8ae2563c8f}

\item 
\hypertarget{RIM_8h_6033c521b3a275b9eba46857362d6223}{
unsigned \textbf{RIM\_\-read} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, void $\ast$param, \hyperlink{RIM_8h_7d6044f709e901c43ff7ccac55ef050b}{RIM\_\-readFn} $\ast$$\ast$readFn, \hyperlink{RIM_8h_456edda1e1a3eccb960b1207956ee6a0}{RIM\_\-decodeFn} $\ast$$\ast$decodeFn)}
\label{RIM_8h_6033c521b3a275b9eba46857362d6223}

\item 
\hypertarget{RIM_8h_4ab0735e2b1e628c4f9de7ba09bd7ed2}{
unsigned \textbf{RIM\_\-set} (\hyperlink{RIM_8h_2b448e9c87c572134b2e8a16a197c726}{RIM} $\ast$rim, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} type, const \hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$addr, int regId, const void $\ast$value)}
\label{RIM_8h_4ab0735e2b1e628c4f9de7ba09bd7ed2}

\item 
\hypertarget{RIM_8h_fa9b5493971570b4bcc9887eef485741}{
unsigned \textbf{RIM\_\-setBit} (\hyperlink{RIM_8h_5683ec066f5c5d208b486ffdedfd54f3}{RIM\_\-map} $\ast$map, \hyperlink{RIM_8h_578d1975a05e3ce266f6693af764aa86}{RIM\_\-type} type, const \hyperlink{union__RIM__addr}{RIM\_\-addr} $\ast$addr)}
\label{RIM_8h_fa9b5493971570b4bcc9887eef485741}

\item 
\hypertarget{RIM_8h_35d3c6605acb4d7e9b04b9c9c5d4acb2}{
void \textbf{RIM\_\-setSplit} (short $\ast$ptr, unsigned long long value, unsigned int uid)}
\label{RIM_8h_35d3c6605acb4d7e9b04b9c9c5d4acb2}

\item 
\hypertarget{RIM_8h_7bbd90199cbe1d4ba7970a44cb5210d1}{
size\_\-t \textbf{RIM\_\-sizeof} (void)}
\label{RIM_8h_7bbd90199cbe1d4ba7970a44cb5210d1}

\item 
\hypertarget{RIM_8h_55dc1a1fdd8c0520d00fe7bc9804ef0d}{
size\_\-t \textbf{RIM\_\-sizeofMap} (void)}
\label{RIM_8h_55dc1a1fdd8c0520d00fe7bc9804ef0d}

\end{CompactItemize}


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

\begin{Desc}
\item[Author:]James Swain \& Owen Saxton\end{Desc}
{\bf \$Id:} \hyperlink{RIM_8h}{RIM.h},v 1.10 2011/03/27 05:54:08 saxton Exp \$ 

\subsection{Typedef Documentation}
\hypertarget{RIM_8h_d69d48908c6bc796278b2189811a4ca0}{
\index{RIM.h@{RIM.h}!RIM\_\-rqstInfo@{RIM\_\-rqstInfo}}
\index{RIM\_\-rqstInfo@{RIM\_\-rqstInfo}!RIM.h@{RIM.h}}
\subsubsection[{RIM\_\-rqstInfo}]{\setlength{\rightskip}{0pt plus 5cm}typedef struct {\bf \_\-RIM\_\-rqstInfo}  {\bf RIM\_\-rqstInfo}}}
\label{RIM_8h_d69d48908c6bc796278b2189811a4ca0}


Information describing a read request. 

This is used mainly in handling read errors, but is also used when processing registers read during a read of the splits

This structure should really be private to RIM, since the information it contains is essentially held in escrow by LATC and returned in the event that the response to a read command contains an error. However, the additional scaffold required to support an opaque handle just seems like overkill. 

\subsection{Enumeration Type Documentation}
\hypertarget{RIM_8h_df764cbdea00d65edcd07bb9953ad2b7}{
\subsubsection[{"@1}]{\setlength{\rightskip}{0pt plus 5cm}anonymous enum}}
\label{RIM_8h_df764cbdea00d65edcd07bb9953ad2b7}


Import options. 

\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{RIM\_\-OPT\_\-SWAP@{RIM\_\-OPT\_\-SWAP}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM\_\-OPT\_\-SWAP@{RIM\_\-OPT\_\-SWAP}}\item[{\em 
\hypertarget{RIM_8h_df764cbdea00d65edcd07bb9953ad2b77e93d8fa8688b1140f28bbcca0e2d415}{
RIM\_\-OPT\_\-SWAP}
\label{RIM_8h_df764cbdea00d65edcd07bb9953ad2b77e93d8fa8688b1140f28bbcca0e2d415}
}]Swap data bytes. \index{RIM\_\-OPT\_\-CURR@{RIM\_\-OPT\_\-CURR}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!RIM\_\-OPT\_\-CURR@{RIM\_\-OPT\_\-CURR}}\item[{\em 
\hypertarget{RIM_8h_df764cbdea00d65edcd07bb9953ad2b7a7e1f99126d72445475d494831ff7cc4}{
RIM\_\-OPT\_\-CURR}
\label{RIM_8h_df764cbdea00d65edcd07bb9953ad2b7a7e1f99126d72445475d494831ff7cc4}
}]Allow only the current version. \end{description}
\end{Desc}

\hypertarget{RIM_8h_61dadd085c1777f559549e05962b2c9e}{
\subsubsection[{"@5}]{\setlength{\rightskip}{0pt plus 5cm}anonymous enum}}
\label{RIM_8h_61dadd085c1777f559549e05962b2c9e}


Masks for fields in the read request uid value. 

\begin{Desc}
\item[Enumerator: ]\par
\begin{description}
\index{UID\_\-INDEX@{UID\_\-INDEX}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!UID\_\-INDEX@{UID\_\-INDEX}}\item[{\em 
\hypertarget{RIM_8h_61dadd085c1777f559549e05962b2c9e18a9f92a17ad2f14f2a4a407a34a1110}{
UID\_\-INDEX}
\label{RIM_8h_61dadd085c1777f559549e05962b2c9e18a9f92a17ad2f14f2a4a407a34a1110}
}]Index of component. \index{UID\_\-IGN\_\-ERROR@{UID\_\-IGN\_\-ERROR}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!UID\_\-IGN\_\-ERROR@{UID\_\-IGN\_\-ERROR}}\item[{\em 
\hypertarget{RIM_8h_61dadd085c1777f559549e05962b2c9ec08e4f543d741949e78757b1ec50859c}{
UID\_\-IGN\_\-ERROR}
\label{RIM_8h_61dadd085c1777f559549e05962b2c9ec08e4f543d741949e78757b1ec50859c}
}]Ignore any read errors. \index{UID\_\-SPT\_\-HIGH@{UID\_\-SPT\_\-HIGH}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!UID\_\-SPT\_\-HIGH@{UID\_\-SPT\_\-HIGH}}\item[{\em 
\hypertarget{RIM_8h_61dadd085c1777f559549e05962b2c9ee5cc94ab70a87cd120b7eca5d146db12}{
UID\_\-SPT\_\-HIGH}
\label{RIM_8h_61dadd085c1777f559549e05962b2c9ee5cc94ab70a87cd120b7eca5d146db12}
}]Set if high side split; otherwise low. \index{UID\_\-SPT\_\-TFE@{UID\_\-SPT\_\-TFE}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!UID\_\-SPT\_\-TFE@{UID\_\-SPT\_\-TFE}}\item[{\em 
\hypertarget{RIM_8h_61dadd085c1777f559549e05962b2c9e7971de8b22580c2c1c95d7e51c51e5d8}{
UID\_\-SPT\_\-TFE}
\label{RIM_8h_61dadd085c1777f559549e05962b2c9e7971de8b22580c2c1c95d7e51c51e5d8}
}]Set if reading TFE; otherwise TRC. \index{UID\_\-SPT\_\-LAST@{UID\_\-SPT\_\-LAST}!RIM.h@{RIM.h}}\index{RIM.h@{RIM.h}!UID\_\-SPT\_\-LAST@{UID\_\-SPT\_\-LAST}}\item[{\em 
\hypertarget{RIM_8h_61dadd085c1777f559549e05962b2c9ec862956ecda2975c563484b248de1d23}{
UID\_\-SPT\_\-LAST}
\label{RIM_8h_61dadd085c1777f559549e05962b2c9ec862956ecda2975c563484b248de1d23}
}]Set if last read of the group. \end{description}
\end{Desc}