\hypertarget{LSF_8h}{ \section{LSF.h File Reference} \label{LSF_8h}\index{LSF.h@{LSF.h}} } Maps out the LSF data structures. {\tt \#include \char`\"{}LSF/LSF\_\-endianness.h\char`\"{}}\par Include dependency graph for LSF.h:\begin{figure}[H] \begin{center} \leavevmode \includegraphics[width=124pt]{LSF_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=97pt]{LSF_8h__dep__incl} \end{center} \end{figure} \subsection*{Data Structures} \begin{CompactItemize} \item struct \hyperlink{struct__LSF__record__hdr__bf}{\_\-LSF\_\-record\_\-hdr\_\-bf} \begin{CompactList}\small\item\em Layout of a record header, bit field representation. \item\end{CompactList}\item union \hyperlink{union__LSF__record__hdr}{\_\-LSF\_\-record\_\-hdr} \begin{CompactList}\small\item\em Union of the record header as an uninterpretted 32-bit integer with a bit field representation. \item\end{CompactList}\item union \hyperlink{union__LSF__record__bdy}{\_\-LSF\_\-record\_\-bdy} \begin{CompactList}\small\item\em The general structure of the body of an LSF record. \item\end{CompactList}\item struct \hyperlink{struct__LSF__record}{\_\-LSF\_\-record} \begin{CompactList}\small\item\em The general structure of an LSF record. \item\end{CompactList}\item struct \hyperlink{struct__LSF__identity__bf}{\_\-LSF\_\-identity\_\-bf} \begin{CompactList}\small\item\em The bit field representation of the LSF identity word. \item\end{CompactList}\item union \hyperlink{union__LSF__identity}{\_\-LSF\_\-identity} \begin{CompactList}\small\item\em Union of the bit field representation of the LSF\_\-identity word and an uninterpretted 32-bit integer. \item\end{CompactList}\item struct \hyperlink{struct__LSF__contribution__hdr}{\_\-LSF\_\-contribution\_\-hdr} \begin{CompactList}\small\item\em The layout of a contribution header structure. \item\end{CompactList}\item union \hyperlink{union__LSF__contribution__bdy}{\_\-LSF\_\-contribution\_\-bdy} \begin{CompactList}\small\item\em Beginning of the body of the LSF contribution. \item\end{CompactList}\item struct \hyperlink{struct__LSF__contribution}{\_\-LSF\_\-contribution} \begin{CompactList}\small\item\em The general structure of an LSF contribution. \item\end{CompactList}\item struct \hyperlink{struct__LSF__datagram__hdr}{\_\-LSF\_\-datagram\_\-hdr} \begin{CompactList}\small\item\em The LSF datagram header. \item\end{CompactList}\item struct \hyperlink{struct__LSF__root__hdr__bf}{\_\-LSF\_\-root\_\-hdr\_\-bf} \begin{CompactList}\small\item\em The LSF root header as bit fields. \item\end{CompactList}\item union \hyperlink{union__LSF__root__hdr}{\_\-LSF\_\-root\_\-hdr} \begin{CompactList}\small\item\em The LSF root header as a union of 32-bit integer and the bit field representation. \item\end{CompactList}\item union \hyperlink{union__LSF__root__bdy}{\_\-LSF\_\-root\_\-bdy} \begin{CompactList}\small\item\em Beginning of the body of the LSF datagram root contribution. \item\end{CompactList}\item struct \hyperlink{struct__LSF__root}{\_\-LSF\_\-root} \begin{CompactList}\small\item\em Describes the body when the datagram has a root contribution. \item\end{CompactList}\item union \hyperlink{union__LSF__datagram__bdy}{\_\-LSF\_\-datagram\_\-bdy} \begin{CompactList}\small\item\em Beginning of the body of the LSF datagram. \item\end{CompactList}\item struct \hyperlink{struct__LSF__datagram}{\_\-LSF\_\-datagram} \begin{CompactList}\small\item\em The general structure of an LSF datagram. \item\end{CompactList}\end{CompactItemize} \subsection*{Defines} \begin{CompactItemize} \item \#define \hyperlink{LSF_8h_a0}{LSF\_\-RECORD\_\-HDR\_\-COMPOSE}(\_\-type\_\-id, \_\-bridge, \_\-len32) \begin{CompactList}\small\item\em Composes a LSF record header. \item\end{CompactList}\item \#define \hyperlink{LSF_8h_a1}{LSF\_\-IDENTITY\_\-COMPOSE}(\_\-type\_\-id, \_\-version, \_\-dir) \begin{CompactList}\small\item\em Composes the 32-bit identity word for either a datagram or a contribution from the specified pieces. \item\end{CompactList}\item \#define \hyperlink{LSF_8h_a2}{LSF\_\-DATAGRAM\_\-IDENTITY\_\-COMPOSE}(\_\-type\_\-id, \_\-version, \_\-opts) \begin{CompactList}\small\item\em Composes the 32-bit identity word for a datagram using the specified values. \item\end{CompactList}\item \#define \hyperlink{LSF_8h_a3}{LSF\_\-CONTRIBUTION\_\-IDENTITY\_\-COMPOSE}(\_\-type\_\-id, \_\-version, \_\-opts) \begin{CompactList}\small\item\em Composes the 32-bit identity word for a datagram using the specified values. \item\end{CompactList}\item \#define \hyperlink{LSF_8h_a4}{LSF\_\-ROOT\_\-HDR\_\-COMPOSE} \begin{CompactList}\small\item\em Compose the root header word. \item\end{CompactList}\end{CompactItemize} \subsection*{Typedefs} \begin{CompactItemize} \item \hypertarget{LSF_8h_a5}{ typedef enum \hyperlink{LSF_8h_a96}{\_\-LSF\_\-RECORD\_\-HDR\_\-S} \hyperlink{LSF_8h_a5}{LSF\_\-RECORD\_\-HDR\_\-S}} \label{LSF_8h_a5} \begin{CompactList}\small\item\em Typedef for enum \_\-LSF\_\-RECORD\_\-HDR\_\-S. \item\end{CompactList}\item \hypertarget{LSF_8h_a6}{ typedef enum \hyperlink{LSF_8h_a97}{\_\-LSF\_\-RECORD\_\-HDR\_\-V} \hyperlink{LSF_8h_a6}{LSF\_\-RECORD\_\-HDR\_\-V}} \label{LSF_8h_a6} \begin{CompactList}\small\item\em typedef for enum \_\-LSF\_\-RECORD\_\-HDR\_\-V \item\end{CompactList}\item \hypertarget{LSF_8h_a7}{ typedef enum \hyperlink{LSF_8h_a98}{\_\-LSF\_\-RECORD\_\-HDR\_\-M} \hyperlink{LSF_8h_a7}{LSF\_\-RECORD\_\-HDR\_\-M}} \label{LSF_8h_a7} \begin{CompactList}\small\item\em typedef for enum \_\-LSF\_\-RECORD\_\-HDR\_\-M \item\end{CompactList}\item typedef \hyperlink{struct__LSF__record__hdr__bf}{\_\-LSF\_\-record\_\-hdr\_\-bf} \hyperlink{LSF_8h_a8}{LSF\_\-record\_\-hdr\_\-bf} \begin{CompactList}\small\item\em Typedef for struct \hyperlink{struct__LSF__record__hdr__bf}{\_\-LSF\_\-record\_\-hdr\_\-bf}. \item\end{CompactList}\item \hypertarget{LSF_8h_a9}{ typedef \hyperlink{union__LSF__record__hdr}{\_\-LSF\_\-record\_\-hdr} \hyperlink{LSF_8h_a9}{LSF\_\-record\_\-hdr}} \label{LSF_8h_a9} \begin{CompactList}\small\item\em Typedef union \hyperlink{union__LSF__record__hdr}{\_\-LSF\_\-record\_\-hdr}. \item\end{CompactList}\item \hypertarget{LSF_8h_a10}{ typedef \hyperlink{union__LSF__record__bdy}{\_\-LSF\_\-record\_\-bdy} \hyperlink{LSF_8h_a10}{LSF\_\-record\_\-bdy}} \label{LSF_8h_a10} \begin{CompactList}\small\item\em Typedef for struct \hyperlink{union__LSF__record__bdy}{\_\-LSF\_\-record\_\-bdy}. \item\end{CompactList}\item \hypertarget{LSF_8h_a11}{ typedef \hyperlink{struct__LSF__record}{\_\-LSF\_\-record} \hyperlink{LSF_8h_a11}{LSF\_\-record}} \label{LSF_8h_a11} \begin{CompactList}\small\item\em Typedef for struct \hyperlink{struct__LSF__record}{\_\-LSF\_\-record}. \item\end{CompactList}\item typedef enum \hyperlink{LSF_8h_a99}{\_\-LSF\_\-IDENTITY\_\-S} \hyperlink{LSF_8h_a12}{LSF\_\-IDENTITY\_\-S} \begin{CompactList}\small\item\em Typedef for enum \_\-LSF\_\-IDENTITY\_\-S. \item\end{CompactList}\item typedef enum \hyperlink{LSF_8h_a100}{\_\-LSF\_\-IDENTITY\_\-V} \hyperlink{LSF_8h_a13}{LSF\_\-IDENTITY\_\-V} \begin{CompactList}\small\item\em Typedef for enum \_\-LSF\_\-IDENTITY\_\-V. \item\end{CompactList}\item typedef enum \hyperlink{LSF_8h_a101}{\_\-LSF\_\-IDENTITY\_\-M} \hyperlink{LSF_8h_a14}{LSF\_\-IDENTITY\_\-M} \begin{CompactList}\small\item\em Typedef for enum \_\-LSF\_\-IDENTITY\_\-M. \item\end{CompactList}\item typedef \hyperlink{struct__LSF__identity__bf}{\_\-LSF\_\-identity\_\-bf} \hyperlink{LSF_8h_a15}{LSF\_\-identity\_\-bf} \begin{CompactList}\small\item\em Typedef for struct \hyperlink{struct__LSF__identity__bf}{\_\-LSF\_\-identity\_\-bf}. \item\end{CompactList}\item typedef \hyperlink{union__LSF__identity}{\_\-LSF\_\-identity} \hyperlink{LSF_8h_a16}{LSF\_\-identity} \begin{CompactList}\small\item\em Typedef for union \hyperlink{union__LSF__identity}{\_\-LSF\_\-identity}. \item\end{CompactList}\item typedef \hyperlink{struct__LSF__contribution__hdr}{\_\-LSF\_\-contribution\_\-hdr} \hyperlink{LSF_8h_a17}{LSF\_\-contribution\_\-hdr} \begin{CompactList}\small\item\em Typedef for struct \hyperlink{struct__LSF__contribution__hdr}{\_\-LSF\_\-contribution\_\-hdr}. \item\end{CompactList}\item \hypertarget{LSF_8h_a18}{ typedef \hyperlink{union__LSF__contribution__bdy}{\_\-LSF\_\-contribution\_\-bdy} \hyperlink{LSF_8h_a18}{LSF\_\-contribution\_\-bdy}} \label{LSF_8h_a18} \begin{CompactList}\small\item\em Typedef for union \hyperlink{union__LSF__contribution__bdy}{\_\-LSF\_\-contribution\_\-bdy}. \item\end{CompactList}\item \hypertarget{LSF_8h_a19}{ typedef \hyperlink{struct__LSF__contribution}{\_\-LSF\_\-contribution} \hyperlink{LSF_8h_a19}{LSF\_\-contribution}} \label{LSF_8h_a19} \begin{CompactList}\small\item\em Typedef for struct \hyperlink{struct__LSF__contribution}{\_\-LSF\_\-contribution}. \item\end{CompactList}\item typedef \hyperlink{struct__LSF__datagram__hdr}{\_\-LSF\_\-datagram\_\-hdr} \hyperlink{LSF_8h_a20}{LSF\_\-datagram\_\-hdr} \begin{CompactList}\small\item\em Typedef for struct \hyperlink{struct__LSF__datagram__hdr}{\_\-LSF\_\-datagram\_\-hdr}. \item\end{CompactList}\item \hypertarget{LSF_8h_a21}{ typedef enum \hyperlink{LSF_8h_a102}{\_\-LSF\_\-ROOT\_\-HDR\_\-S} \hyperlink{LSF_8h_a21}{LSF\_\-ROOT\_\-HDR\_\-S}} \label{LSF_8h_a21} \begin{CompactList}\small\item\em Typedef for enum \_\-LSF\_\-ROOT\_\-HDR\_\-S. \item\end{CompactList}\item \hypertarget{LSF_8h_a22}{ typedef enum \hyperlink{LSF_8h_a103}{\_\-LSF\_\-ROOT\_\-HDR\_\-V} \hyperlink{LSF_8h_a22}{LSF\_\-ROOT\_\-HDR\_\-V}} \label{LSF_8h_a22} \begin{CompactList}\small\item\em Typedef for enum \_\-LSF\_\-ROOT\_\-HDR\_\-V. \item\end{CompactList}\item \hypertarget{LSF_8h_a23}{ typedef enum \hyperlink{LSF_8h_a104}{\_\-LSF\_\-ROOT\_\-HDR\_\-M} \hyperlink{LSF_8h_a23}{LSF\_\-ROOT\_\-HDR\_\-M}} \label{LSF_8h_a23} \begin{CompactList}\small\item\em Typedef for enum \_\-LSF\_\-ROOT\_\-HDR\_\-M. \item\end{CompactList}\item \hypertarget{LSF_8h_a24}{ typedef \hyperlink{struct__LSF__root__hdr__bf}{\_\-LSF\_\-root\_\-hdr\_\-bf} \hyperlink{LSF_8h_a24}{LSF\_\-root\_\-hdr\_\-bf}} \label{LSF_8h_a24} \begin{CompactList}\small\item\em Typedef for struct \hyperlink{struct__LSF__root__hdr__bf}{\_\-LSF\_\-root\_\-hdr\_\-bf}. \item\end{CompactList}\item \hypertarget{LSF_8h_a25}{ typedef \hyperlink{union__LSF__root__hdr}{\_\-LSF\_\-root\_\-hdr} \hyperlink{LSF_8h_a25}{LSF\_\-root\_\-hdr}} \label{LSF_8h_a25} \begin{CompactList}\small\item\em Typedef for struct \hyperlink{union__LSF__root__hdr}{\_\-LSF\_\-root\_\-hdr}. \item\end{CompactList}\item \hypertarget{LSF_8h_a26}{ typedef \hyperlink{union__LSF__root__bdy}{\_\-LSF\_\-root\_\-bdy} \hyperlink{LSF_8h_a26}{LSF\_\-root\_\-bdy}} \label{LSF_8h_a26} \begin{CompactList}\small\item\em Typedef for union \hyperlink{union__LSF__root__bdy}{\_\-LSF\_\-root\_\-bdy}. \item\end{CompactList}\item \hypertarget{LSF_8h_a27}{ typedef \hyperlink{struct__LSF__root}{\_\-LSF\_\-root} \hyperlink{LSF_8h_a27}{LSF\_\-root}} \label{LSF_8h_a27} \begin{CompactList}\small\item\em Typedef for struct \_\-LSF\_\-datagram\_\-root. \item\end{CompactList}\item \hypertarget{LSF_8h_a28}{ typedef \hyperlink{union__LSF__datagram__bdy}{\_\-LSF\_\-datagram\_\-bdy} \hyperlink{LSF_8h_a28}{LSF\_\-datagram\_\-bdy}} \label{LSF_8h_a28} \begin{CompactList}\small\item\em Typedef for union \hyperlink{union__LSF__datagram__bdy}{\_\-LSF\_\-datagram\_\-bdy}. \item\end{CompactList}\item \hypertarget{LSF_8h_a29}{ typedef \hyperlink{struct__LSF__datagram}{\_\-LSF\_\-datagram} \hyperlink{LSF_8h_a29}{LSF\_\-datagram}} \label{LSF_8h_a29} \begin{CompactList}\small\item\em Typedef for struct \hyperlink{struct__LSF__datagram}{\_\-LSF\_\-datagram}. \item\end{CompactList}\end{CompactItemize} \subsection*{Enumerations} \begin{CompactItemize} \item enum \hyperlink{LSF_8h_a96}{\_\-LSF\_\-RECORD\_\-HDR\_\-S} \{ \par \hyperlink{LSF_8h_a96a30}{LSF\_\-RECORD\_\-HDR\_\-S\_\-BRIDGE} = 8, \par \hyperlink{LSF_8h_a96a31}{LSF\_\-RECORD\_\-HDR\_\-S\_\-TYPEID} = 4, \par \hyperlink{LSF_8h_a96a32}{LSF\_\-RECORD\_\-HDR\_\-S\_\-LEN32} = 20 \} \begin{CompactList}\small\item\em Record level header word, bit field sizes. \item\end{CompactList}\item enum \hyperlink{LSF_8h_a97}{\_\-LSF\_\-RECORD\_\-HDR\_\-V} \{ \par \hyperlink{LSF_8h_a97a33}{LSF\_\-RECORD\_\-HDR\_\-V\_\-BRIDGE} = 24, \par \hyperlink{LSF_8h_a97a34}{LSF\_\-RECORD\_\-HDR\_\-V\_\-TYPEID} = 20, \par \hyperlink{LSF_8h_a97a35}{LSF\_\-RECORD\_\-HDR\_\-V\_\-LEN32} = 0 \} \begin{CompactList}\small\item\em Record Level header, bit field right justified offsets. \item\end{CompactList}\item enum \hyperlink{LSF_8h_a98}{\_\-LSF\_\-RECORD\_\-HDR\_\-M} \{ \par \hyperlink{LSF_8h_a98a36}{LSF\_\-RECORD\_\-HDR\_\-M\_\-TYPEID}, \par \hyperlink{LSF_8h_a98a37}{LSF\_\-RECORD\_\-HDR\_\-M\_\-BRIDGE}, \par \hyperlink{LSF_8h_a98a38}{LSF\_\-RECORD\_\-HDR\_\-M\_\-LEN32} \} \begin{CompactList}\small\item\em Record Level header, bit field in place masks. \item\end{CompactList}\item enum \hyperlink{LSF_8h_a99}{\_\-LSF\_\-IDENTITY\_\-S} \{ \par \hyperlink{LSF_8h_a99a39}{LSF\_\-IDENTITY\_\-S\_\-TYPEID} = 20, \par \hyperlink{LSF_8h_a99a40}{LSF\_\-IDENTITY\_\-S\_\-VERSION} = 8, \par \hyperlink{LSF_8h_a99a41}{LSF\_\-IDENTITY\_\-S\_\-OPTS} = 4, \par \hyperlink{LSF_8h_a99a42}{LSF\_\-IDENTITY\_\-S\_\-RSVD\_\-0} = 1, \par \hyperlink{LSF_8h_a99a43}{LSF\_\-IDENTITY\_\-S\_\-RSVD\_\-1} = 1, \par \hyperlink{LSF_8h_a99a44}{LSF\_\-IDENTITY\_\-S\_\-ROOT} = 1, \par \hyperlink{LSF_8h_a99a45}{LSF\_\-IDENTITY\_\-S\_\-DIR} = 1, \par \hyperlink{LSF_8h_a99a46}{LSF\_\-IDENTITY\_\-S\_\-DGM\_\-CTB} = 1, \par \hyperlink{LSF_8h_a99a47}{LSF\_\-IDENTITY\_\-S\_\-CTB\_\-REC} = 1 \} \begin{CompactList}\small\item\em Enumeration giving the sizes of the bit fields in the LSF identity word. \item\end{CompactList}\item enum \hyperlink{LSF_8h_a100}{\_\-LSF\_\-IDENTITY\_\-V} \{ \par \hyperlink{LSF_8h_a100a48}{LSF\_\-IDENTITY\_\-V\_\-TYPEID} = 0, \par \hyperlink{LSF_8h_a100a49}{LSF\_\-IDENTITY\_\-V\_\-VERSION} = 20, \par \hyperlink{LSF_8h_a100a50}{LSF\_\-IDENTITY\_\-V\_\-OPTS} = 28, \par \hyperlink{LSF_8h_a100a51}{LSF\_\-IDENTITY\_\-V\_\-RSVD\_\-0} = LSF\_\-IDENTITY\_\-V\_\-OPTS + 0, \par \hyperlink{LSF_8h_a100a52}{LSF\_\-IDENTITY\_\-V\_\-RSVD\_\-1} = LSF\_\-IDENTITY\_\-V\_\-OPTS + 1, \par \hyperlink{LSF_8h_a100a53}{LSF\_\-IDENTITY\_\-V\_\-ROOT} = LSF\_\-IDENTITY\_\-V\_\-OPTS + 2, \par \hyperlink{LSF_8h_a100a54}{LSF\_\-IDENTITY\_\-V\_\-DIR} = LSF\_\-IDENTITY\_\-V\_\-OPTS + 3, \par \hyperlink{LSF_8h_a100a55}{LSF\_\-IDENTITY\_\-V\_\-DGM\_\-CTB} = LSF\_\-IDENTITY\_\-V\_\-OPTS + 3, \par \hyperlink{LSF_8h_a100a56}{LSF\_\-IDENTITY\_\-V\_\-CTB\_\-REC} = LSF\_\-IDENTITY\_\-V\_\-OPTS + 3 \} \begin{CompactList}\small\item\em Enumeration giving the right bit offsets of the bit fields in the LSF identity word. \item\end{CompactList}\item enum \hyperlink{LSF_8h_a101}{\_\-LSF\_\-IDENTITY\_\-M} \{ \par \hyperlink{LSF_8h_a101a57}{LSF\_\-IDENTITY\_\-M\_\-TYPEID}, \par \hyperlink{LSF_8h_a101a58}{LSF\_\-IDENTITY\_\-M\_\-VERSION}, \par \hyperlink{LSF_8h_a101a59}{LSF\_\-IDENTITY\_\-M\_\-OPTS}, \par \hyperlink{LSF_8h_a101a60}{LSF\_\-IDENTITY\_\-M\_\-RSVD\_\-0}, \par \hyperlink{LSF_8h_a101a61}{LSF\_\-IDENTITY\_\-M\_\-RSVD\_\-1}, \par \hyperlink{LSF_8h_a101a62}{LSF\_\-IDENTITY\_\-M\_\-ROOT}, \par \hyperlink{LSF_8h_a101a63}{LSF\_\-IDENTITY\_\-M\_\-DIR}, \par \hyperlink{LSF_8h_a101a64}{LSF\_\-IDENTITY\_\-M\_\-DGM\_\-CTB}, \par \hyperlink{LSF_8h_a101a65}{LSF\_\-IDENTITY\_\-M\_\-CTB\_\-REC} \} \begin{CompactList}\small\item\em Enumeration giving the in place masks of the bit fields in the LSF identity word. \item\end{CompactList}\item enum \hyperlink{LSF_8h_a102}{\_\-LSF\_\-ROOT\_\-HDR\_\-S} \{ \par \hyperlink{LSF_8h_a102a66}{LSF\_\-ROOT\_\-HDR\_\-S\_\-LEN32} = 28, \par \hyperlink{LSF_8h_a102a67}{LSF\_\-ROOT\_\-HDR\_\-S\_\-OPTS} = 4, \par \hyperlink{LSF_8h_a102a68}{LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-0} = 1, \par \hyperlink{LSF_8h_a102a69}{LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-1} = 1, \par \hyperlink{LSF_8h_a102a70}{LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-2} = 1, \par \hyperlink{LSF_8h_a102a71}{LSF\_\-ROOT\_\-HDR\_\-S\_\-CTB} = 1 \} \begin{CompactList}\small\item\em The size, in bits, of the fields of the root header word. \item\end{CompactList}\item enum \hyperlink{LSF_8h_a103}{\_\-LSF\_\-ROOT\_\-HDR\_\-V} \{ \par \hyperlink{LSF_8h_a103a72}{LSF\_\-ROOT\_\-HDR\_\-V\_\-LEN32} = 0, \par \hyperlink{LSF_8h_a103a73}{LSF\_\-ROOT\_\-HDR\_\-V\_\-OPTS} = 28, \par \hyperlink{LSF_8h_a103a74}{LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-0} = LSF\_\-ROOT\_\-HDR\_\-V\_\-OPTS + 0, \par \hyperlink{LSF_8h_a103a75}{LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-1} = LSF\_\-ROOT\_\-HDR\_\-V\_\-OPTS + 1, \par \hyperlink{LSF_8h_a103a76}{LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-2} = LSF\_\-ROOT\_\-HDR\_\-V\_\-OPTS + 2, \par \hyperlink{LSF_8h_a103a77}{LSF\_\-ROOT\_\-HDR\_\-V\_\-CTB} = LSF\_\-ROOT\_\-HDR\_\-V\_\-OPTS + 3 \} \begin{CompactList}\small\item\em The right justified bit offset of the fields of the root header word. \item\end{CompactList}\item enum \hyperlink{LSF_8h_a104}{\_\-LSF\_\-ROOT\_\-HDR\_\-M} \{ \par \hyperlink{LSF_8h_a104a78}{LSF\_\-ROOT\_\-HDR\_\-M\_\-LEN32}, \par \hyperlink{LSF_8h_a104a79}{LSF\_\-ROOT\_\-HDR\_\-M\_\-OPTS}, \par \hyperlink{LSF_8h_a104a80}{LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-0}, \par \hyperlink{LSF_8h_a104a81}{LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-1}, \par \hyperlink{LSF_8h_a104a82}{LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-2}, \par \hyperlink{LSF_8h_a104a83}{LSF\_\-ROOT\_\-HDR\_\-M\_\-CTB} \} \begin{CompactList}\small\item\em The in place bit masks of the fields of the root header word. \item\end{CompactList}\end{CompactItemize} \subsection*{Functions} \begin{CompactItemize} \item static \_\-\_\-inline unsigned int \hyperlink{LSF_8h_a84}{LSF\_\-identity\-Compose} (unsigned int type\_\-id, unsigned int version, unsigned int dir) \begin{CompactList}\small\item\em Composes the 32-bit identity word for either a datagram or a contribution from the specified pieces. \item\end{CompactList}\item static \_\-\_\-inline unsigned int \hyperlink{LSF_8h_a85}{LSF\_\-datagram\-Identity\-Compose} (unsigned int type\_\-id, unsigned int version, unsigned int opts) \begin{CompactList}\small\item\em Composes the 32-bit identity word for a datagram from the specified pieces. \item\end{CompactList}\item static \_\-\_\-inline unsigned int \hyperlink{LSF_8h_a86}{LSF\_\-contribution\-Identity\-Compose} (unsigned int type\_\-id, unsigned int version, unsigned int opts) \begin{CompactList}\small\item\em Composes the 32-bit identity word for a contribution from the specified pieces. \item\end{CompactList}\item static \_\-\_\-inline unsigned int \hyperlink{LSF_8h_a87}{LSF\_\-root\-Hdr\-Compose} (unsigned int len32, unsigned int ctb) \begin{CompactList}\small\item\em Compose the root header word. \item\end{CompactList}\item static \_\-\_\-inline unsigned int \hyperlink{LSF_8h_a88}{LSF\_\-record\-Hdr\-Compose} (unsigned int type\_\-id, unsigned int bridge, unsigned int len32) \begin{CompactList}\small\item\em Composes a LSF record header. \item\end{CompactList}\item static \_\-\_\-inline \hyperlink{struct__LSF__datagram}{LSF\_\-datagram} $\ast$ \hyperlink{LSF_8h_a89}{LSF\_\-datagram\-Next} (const \hyperlink{struct__LSF__datagram}{LSF\_\-datagram} $\ast$dgm) \begin{CompactList}\small\item\em Advances the datagram pointer by the length field specified in the datagram. \item\end{CompactList}\item static \_\-\_\-inline \hyperlink{struct__LSF__datagram}{LSF\_\-datagram} $\ast$ \hyperlink{LSF_8h_a90}{LSF\_\-datagram\-Advance} (const \hyperlink{struct__LSF__datagram}{LSF\_\-datagram} $\ast$dgm, unsigned int n32) \begin{CompactList}\small\item\em Advances the datagram pointer by the specified number of 32-bit words. \item\end{CompactList}\item static \_\-\_\-inline \hyperlink{struct__LSF__contribution}{LSF\_\-contribution} $\ast$ \hyperlink{LSF_8h_a91}{LSF\_\-contribution\-Next} (const \hyperlink{struct__LSF__contribution}{LSF\_\-contribution} $\ast$ctb) \begin{CompactList}\small\item\em Advances the contribution pointer by the length field specified in the contribution header. \item\end{CompactList}\item static \_\-\_\-inline \hyperlink{struct__LSF__contribution}{LSF\_\-contribution} $\ast$ \hyperlink{LSF_8h_a92}{LSF\_\-contribution\-Advance} (const \hyperlink{struct__LSF__contribution}{LSF\_\-contribution} $\ast$ctb, unsigned int n32) \begin{CompactList}\small\item\em Advances the contribution pointer by the specified number of 32-bit words. \item\end{CompactList}\item static \_\-\_\-inline \hyperlink{struct__LSF__record}{LSF\_\-record} $\ast$ \hyperlink{LSF_8h_a93}{LSF\_\-record\-Next} (const \hyperlink{struct__LSF__record}{LSF\_\-record} $\ast$rec) \begin{CompactList}\small\item\em Advances the record pointer by the length field specified in the record header. \item\end{CompactList}\item static \_\-\_\-inline \hyperlink{struct__LSF__record}{LSF\_\-record} $\ast$ \hyperlink{LSF_8h_a94}{LSF\_\-record\-Advance} (const \hyperlink{struct__LSF__record}{LSF\_\-record} $\ast$evt, unsigned int n32) \begin{CompactList}\small\item\em Advances the record pointer by the specified number of 32-bit words. \item\end{CompactList}\item static \_\-\_\-inline unsigned int $\ast$ \hyperlink{LSF_8h_a95}{LSF\_\-dat\-Advance} (const unsigned int $\ast$dat, unsigned int n32) \begin{CompactList}\small\item\em Advances the data pointer by the specified number of 32-bit wo. \item\end{CompactList}\end{CompactItemize} \subsection{Detailed Description} Maps out the LSF data structures. \begin{Desc} \item[Author:]JJRussell - \href{mailto:russell@slac.stanford.edu}{\tt russell@slac.stanford.edu}\end{Desc} \footnotesize\begin{verbatim} CVS $Id: LSF.h,v 1.7 2005/11/02 17:18:19 russell Exp $ \end{verbatim} \normalsize \begin{Desc} \item[Overview]This defines the generic aspects of the LAT Science Format (LSF) as implemented by the LAT Flight Software. It has its origins in LDF, but makes 2 significant departures\end{Desc} \begin{enumerate} \item All lengths are in 32-bit words, not bytes\item In addition to the datagram and contribution level objects, LSF adds a third level to this heirarchy, the record.\end{enumerate} \begin{Desc} \item[]LDF made no policy statement concerning the following two issues\end{Desc} \begin{enumerate} \item Alignment of contribution\item Scope of contribution level identifiers\end{enumerate} LSF, however, does make a statement here \begin{enumerate} \item All contribution and record must be 32-bit aligned. This is semi-formalized by LSF specifying lengths in 32-bit words.\item Contribution level and record level identifiers are scoped locally to a datagram. That is, these identifiers have meaning only within the context of a particular datagram and in no way are meant to universally identify a contribution/record in across all datagrams. This means there definition and management is purely a local affair, requiring no coordination to see if a particular number is available.\end{enumerate} \begin{Desc} \item[]LSF makes no references to the contents/data it will encapsulate. In particular, there are no references to anything specific to data that Flight Software may wrap in this protocol.\end{Desc} \begin{Desc} \item[Heirarchy]Heirachicially, the order is\end{Desc} \begin{itemize} \item Datagram\item Contribution\item Record\end{itemize} \begin{Desc} \item[]that is, datagram contain contribution and contribution contain records. Still ambivalent on whether\end{Desc} \begin{itemize} \item A datagram can carry data not contained in a contribution\item Whether to demand the heirachy is strictly enforced, that is contributions must appear under datagrams and records within contributions. For now, the recommendation is that this rule be followed.\end{itemize} \subsection{Define Documentation} \hypertarget{LSF_8h_a3}{ \index{LSF.h@{LSF.h}!LSF_CONTRIBUTION_IDENTITY_COMPOSE@{LSF\_\-CONTRIBUTION\_\-IDENTITY\_\-COMPOSE}} \index{LSF_CONTRIBUTION_IDENTITY_COMPOSE@{LSF\_\-CONTRIBUTION\_\-IDENTITY\_\-COMPOSE}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-CONTRIBUTION\_\-IDENTITY\_\-COMPOSE]{\setlength{\rightskip}{0pt plus 5cm}\#define LSF\_\-CONTRIBUTION\_\-IDENTITY\_\-COMPOSE(\_\-type\_\-id, \_\-version, \_\-opts)}} \label{LSF_8h_a3} {\bf Value:} \footnotesize\begin{verbatim}( (((_opts) ) & LSF_IDENTITY_M_OPTS ) \ | (((_version) << LSF_IDENTITY_V_VERSION) & LSF_IDENTITY_M_VERSION) \ | (((_type_id )<< LSF_IDENTITY_V_TYPEID) & LSF_IDENTITY_M_TYPEID ) ) \end{verbatim}\normalsize Composes the 32-bit identity word for a datagram using the specified values. \begin{Desc} \item[Returns:]The 32-bit identity word;\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em \_\-type\_\-id}]The type/identifier of the datagram or contribution Examples would be LSF\_\-ID\_\-K\_\-LSEP, LSF\_\-ID\_\-K\_\-LSEC \item[{\em \_\-version}]The version of the data being presented \item[{\em \_\-opts}]An options word, composed by selectively OR'ing the enumerations defined in the options field section of LSF\_\-IDENTITY\_\-M\_\-OPTS.\end{description} \end{Desc} \begin{Desc} \item[]This functionality is also available as an inline routine. The macro should be used only where calling a function is not allowed, as in a compile time data intialization statement.\end{Desc} \hypertarget{LSF_8h_a2}{ \index{LSF.h@{LSF.h}!LSF_DATAGRAM_IDENTITY_COMPOSE@{LSF\_\-DATAGRAM\_\-IDENTITY\_\-COMPOSE}} \index{LSF_DATAGRAM_IDENTITY_COMPOSE@{LSF\_\-DATAGRAM\_\-IDENTITY\_\-COMPOSE}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-DATAGRAM\_\-IDENTITY\_\-COMPOSE]{\setlength{\rightskip}{0pt plus 5cm}\#define LSF\_\-DATAGRAM\_\-IDENTITY\_\-COMPOSE(\_\-type\_\-id, \_\-version, \_\-opts)}} \label{LSF_8h_a2} {\bf Value:} \footnotesize\begin{verbatim}( (((_opts) ) & LSF_IDENTITY_M_OPTS ) \ | (((_version) << LSF_IDENTITY_V_VERSION) & LSF_IDENTITY_M_VERSION) \ | (((_type_id )<< LSF_IDENTITY_V_TYPEID) & LSF_IDENTITY_M_TYPEID ) ) \end{verbatim}\normalsize Composes the 32-bit identity word for a datagram using the specified values. \begin{Desc} \item[Returns:]The 32-bit identity word;\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em \_\-type\_\-id}]The type/identifier of the datagram or contribution Examples would be LSF\_\-ID\_\-K\_\-LSEP, LSF\_\-ID\_\-K\_\-LSEC \item[{\em \_\-version}]The version of the data being presented \item[{\em \_\-opts}]An options word, composed by selectively OR'ing the enumerations defined in the options field section of LSF\_\-IDENTITY\_\-M.\end{description} \end{Desc} \begin{Desc} \item[]This functionality is also available as an inline routine. The macro should be used only where calling a function is not allowed, as in a compile time data intialization statement.\end{Desc} \hypertarget{LSF_8h_a1}{ \index{LSF.h@{LSF.h}!LSF_IDENTITY_COMPOSE@{LSF\_\-IDENTITY\_\-COMPOSE}} \index{LSF_IDENTITY_COMPOSE@{LSF\_\-IDENTITY\_\-COMPOSE}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-IDENTITY\_\-COMPOSE]{\setlength{\rightskip}{0pt plus 5cm}\#define LSF\_\-IDENTITY\_\-COMPOSE(\_\-type\_\-id, \_\-version, \_\-dir)}} \label{LSF_8h_a1} {\bf Value:} \footnotesize\begin{verbatim}( (((_dir) << LSF_IDENTITY_V_DIR) & LSF_IDENTITY_M_DIR ) \ | (((_version) << LSF_IDENTITY_V_VERSION) & LSF_IDENTITY_M_VERSION) \ | (((_type_id )<< LSF_IDENTITY_V_TYPEID) & LSF_IDENTITY_M_TYPEID ) ) \end{verbatim}\normalsize Composes the 32-bit identity word for either a datagram or a contribution from the specified pieces. \begin{Desc} \item[Returns:]The 32-bit identity word;\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em \_\-type\_\-id}]The type/identifier of the datagram or contribution Examples would be LSF\_\-ID\_\-K\_\-LSEP, LSF\_\-ID\_\-K\_\-LSEC \item[{\em \_\-version}]The version of the data being presented \item[{\em \_\-dir}]A flag, if true indicating the datagram/contribution is composed of a series of contributions/records\end{description} \end{Desc} \begin{Desc} \item[]This functionality is also available as an inline routine. The macro should be used only where calling a function is not allowed, as in a compile time data intialization statement. This version supports both contributions and datagrams without root contributions.\end{Desc} \begin{Desc} \item[Warning:]This macro may be deprecated in a future release. New code should use the more directed LSF\_\-DATAGRAM\_\-IDENTITY\_\-COMPOSE or LSF\_\-CONTRIBUTION\_\-IDENTITY\_\-COMPOSE.\end{Desc} \hypertarget{LSF_8h_a0}{ \index{LSF.h@{LSF.h}!LSF_RECORD_HDR_COMPOSE@{LSF\_\-RECORD\_\-HDR\_\-COMPOSE}} \index{LSF_RECORD_HDR_COMPOSE@{LSF\_\-RECORD\_\-HDR\_\-COMPOSE}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-RECORD\_\-HDR\_\-COMPOSE]{\setlength{\rightskip}{0pt plus 5cm}\#define LSF\_\-RECORD\_\-HDR\_\-COMPOSE(\_\-type\_\-id, \_\-bridge, \_\-len32)}} \label{LSF_8h_a0} {\bf Value:} \footnotesize\begin{verbatim}( (((_type_id) << LSF_RECORD_HDR_V_TYPEID) & LSF_RECORD_HDR_M_TYPEID) \ | ((( _bridge) << LSF_RECORD_HDR_V_BRIDGE) & LSF_RECORD_HDR_M_BRIDGE) \ | ((( _len32) << LSF_RECORD_HDR_V_LEN32) & LSF_RECORD_HDR_M_LEN32) ) \end{verbatim}\normalsize Composes a LSF record header. \begin{Desc} \item[Returns:]The LSF record header\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em \_\-type\_\-id}]The type/id (0-15) \item[{\em \_\-bridge}]The value of the 8-bit reserved field \item[{\em \_\-len32}]The length, in longwords, of the record\end{description} \end{Desc} \begin{Desc} \item[]Note, this functionality is also available as an inline routine. This macro should be used when initially data structures, {\em i.e\/}, where calling a function is prohibited.\end{Desc} \hypertarget{LSF_8h_a4}{ \index{LSF.h@{LSF.h}!LSF_ROOT_HDR_COMPOSE@{LSF\_\-ROOT\_\-HDR\_\-COMPOSE}} \index{LSF_ROOT_HDR_COMPOSE@{LSF\_\-ROOT\_\-HDR\_\-COMPOSE}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-ROOT\_\-HDR\_\-COMPOSE]{\setlength{\rightskip}{0pt plus 5cm}\#define LSF\_\-ROOT\_\-HDR\_\-COMPOSE}} \label{LSF_8h_a4} {\bf Value:} \footnotesize\begin{verbatim}(_len32, _ctb) \ ( (((_ctb) << LSF_ROOT_HDR_V_CTB ) & LSF_ROOT_HDR_M_CTB ) \ | (((_len32) << LSF_ROOT_HDR_V_LEN32) & LSF_ROOT_HDR_M_LEN32)) \end{verbatim}\normalsize Compose the root header word. \begin{Desc} \item[Returns:]The compose root header word\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em \_\-len32}]The length, in 32-bit words, of the root contribution \item[{\em \_\-ctb}]A flag indicating if the root contribution itself is composed of contributions (1) or is just a bag of bits.\end{description} \end{Desc} \begin{Desc} \item[]Note, this functionality is also available as an inline routine. This macro should be used when initially data structures, {\em i.e\/}, where calling a function is prohibited.\end{Desc} \subsection{Typedef Documentation} \hypertarget{LSF_8h_a17}{ \index{LSF.h@{LSF.h}!LSF_contribution_hdr@{LSF\_\-contribution\_\-hdr}} \index{LSF_contribution_hdr@{LSF\_\-contribution\_\-hdr}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-contribution\_\-hdr]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct__LSF__contribution__hdr}{LSF\_\-contribution\_\-hdr}}} \label{LSF_8h_a17} Typedef for struct \hyperlink{struct__LSF__contribution__hdr}{\_\-LSF\_\-contribution\_\-hdr}. \begin{Desc} \item[]An LSF datagram consists of an outer header (a LSF\_\-datagram\_\-hdr) encapsulating a group of LSF contributors. Each LSF contributor itself is jacketed with its own header (this structure).\end{Desc} \begin{Desc} \item[]Not that because the length field is 24-bits, the maximum length of an LSF contribution is 2$\ast$$\ast$24-1 32-bit words.\end{Desc} \hypertarget{LSF_8h_a20}{ \index{LSF.h@{LSF.h}!LSF_datagram_hdr@{LSF\_\-datagram\_\-hdr}} \index{LSF_datagram_hdr@{LSF\_\-datagram\_\-hdr}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-datagram\_\-hdr]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct__LSF__datagram__hdr}{LSF\_\-datagram\_\-hdr}}} \label{LSF_8h_a20} Typedef for struct \hyperlink{struct__LSF__datagram__hdr}{\_\-LSF\_\-datagram\_\-hdr}. \begin{Desc} \item[]An LSF datagram consists of an outer header (this structure) encapsulating a group of LSF contributors. Each LSF contributor itself is jacketed with its own header (an LSF\_\-contributor\_\-hdr)\end{Desc} \hypertarget{LSF_8h_a16}{ \index{LSF.h@{LSF.h}!LSF_identity@{LSF\_\-identity}} \index{LSF_identity@{LSF\_\-identity}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-identity]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{union__LSF__identity}{LSF\_\-identity}}} \label{LSF_8h_a16} Typedef for union \hyperlink{union__LSF__identity}{\_\-LSF\_\-identity}. \begin{Desc} \item[Note:]This is being maintained as a common structure for both datagrams and contributions. However, as time goes on, differences are appearing. At some point, these two may have to be separated.\end{Desc} \hypertarget{LSF_8h_a15}{ \index{LSF.h@{LSF.h}!LSF_identity_bf@{LSF\_\-identity\_\-bf}} \index{LSF_identity_bf@{LSF\_\-identity\_\-bf}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-identity\_\-bf]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct__LSF__identity__bf}{LSF\_\-identity\_\-bf}}} \label{LSF_8h_a15} Typedef for struct \hyperlink{struct__LSF__identity__bf}{\_\-LSF\_\-identity\_\-bf}. \begin{Desc} \item[]Except for the {\em dir\/} and {\em root\/} fields, these fields are self-explanatory.\end{Desc} \begin{Desc} \item[Root Flag]The {\em root\/} field indicates whether a hidden root contribution immediately follows the datagram header. The length of all the root contributors immedidately follows the datagram header. A parser is free to consume the root contributions as an anonymous bag of bits or pass them to a call back routine.\end{Desc} \begin{Desc} \item[Dir Flag]The {\em dir\/} indicates whether the payload has structure or is just a bag of bytes. For datagrams, this flag indicates that the payload is/is not a series of contributions. It allows a generic LSF parsing tool to decide whether it can drill down into the payload of a datagram or a contribution. Once a datagram or a contribution has set this flag {\em all\/} data in it must be presented as wrapped in a contribution or record header. It is not permitted to set this flag in a contribution and have, for example, the first item in the payload presented as a record and the next piece presented as an unstructured bag-of-bytes.\end{Desc} \begin{Desc} \item[]If this flags applies to the structure of the data {\em after\/} any root contribution. Note that the root header itself contains a {\em dir\/} flag indicating to its consumers whether the data associated with the root contribution is structured or not.\end{Desc} \begin{Desc} \item[Rsvd Field]Currently this field is unused\end{Desc} \begin{Desc} \item[]The likely use of this field when used in the datagram header will be indicate the revision level of LSF itself, and when used in the contribution header, will be to indicate the number of pad bytes to pad the data to a 32-bit boundary.\end{Desc} \begin{Desc} \item[Note:]This is being maintained as a common structure for both datagrams and contributions. However, as time goes on, differences are appearing. At some point, these two may have to be separated.\end{Desc} \hypertarget{LSF_8h_a14}{ \index{LSF.h@{LSF.h}!LSF_IDENTITY_M@{LSF\_\-IDENTITY\_\-M}} \index{LSF_IDENTITY_M@{LSF\_\-IDENTITY\_\-M}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-IDENTITY\_\-M]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{LSF_8h_a14}{LSF\_\-IDENTITY\_\-M}}} \label{LSF_8h_a14} Typedef for enum \_\-LSF\_\-IDENTITY\_\-M. \begin{Desc} \item[Note:]This is being maintained as a common structure for both datagrams and contributions. However, as time goes on, differences are appearing. At some point, these two may have to be separated.\end{Desc} \hypertarget{LSF_8h_a12}{ \index{LSF.h@{LSF.h}!LSF_IDENTITY_S@{LSF\_\-IDENTITY\_\-S}} \index{LSF_IDENTITY_S@{LSF\_\-IDENTITY\_\-S}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-IDENTITY\_\-S]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{LSF_8h_a12}{LSF\_\-IDENTITY\_\-S}}} \label{LSF_8h_a12} Typedef for enum \_\-LSF\_\-IDENTITY\_\-S. \begin{Desc} \item[Note:]This is being maintained as a common structure for both datagrams and contributions. However, as time goes on, differences are appearing. At some point, these two may have to be separated.\end{Desc} \hypertarget{LSF_8h_a13}{ \index{LSF.h@{LSF.h}!LSF_IDENTITY_V@{LSF\_\-IDENTITY\_\-V}} \index{LSF_IDENTITY_V@{LSF\_\-IDENTITY\_\-V}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-IDENTITY\_\-V]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{LSF_8h_a13}{LSF\_\-IDENTITY\_\-V}}} \label{LSF_8h_a13} Typedef for enum \_\-LSF\_\-IDENTITY\_\-V. \begin{Desc} \item[Note:]This is being maintained as a common structure for both datagrams and contributions. However, as time goes on, differences are appearing. At some point, these two may have to be separated.\end{Desc} \hypertarget{LSF_8h_a8}{ \index{LSF.h@{LSF.h}!LSF_record_hdr_bf@{LSF\_\-record\_\-hdr\_\-bf}} \index{LSF_record_hdr_bf@{LSF\_\-record\_\-hdr\_\-bf}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-record\_\-hdr\_\-bf]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{struct__LSF__record__hdr__bf}{LSF\_\-record\_\-hdr\_\-bf}}} \label{LSF_8h_a8} Typedef for struct \hyperlink{struct__LSF__record__hdr__bf}{\_\-LSF\_\-record\_\-hdr\_\-bf}. \begin{Desc} \item[]A record header consists of a 4 bit subformat field nibble and a 20 20 long-word count in the low 16 bits, The remaining 8 bits are meant to be used as a bridge word between the protocol handler and the data handler and is, in general, subformat dependent.\end{Desc} \subsection{Enumeration Type Documentation} \hypertarget{LSF_8h_a101}{ \index{LSF.h@{LSF.h}!_LSF_IDENTITY_M@{\_\-LSF\_\-IDENTITY\_\-M}} \index{_LSF_IDENTITY_M@{\_\-LSF\_\-IDENTITY\_\-M}!LSF.h@{LSF.h}} \subsubsection[\_\-LSF\_\-IDENTITY\_\-M]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{LSF_8h_a101}{\_\-LSF\_\-IDENTITY\_\-M}}} \label{LSF_8h_a101} Enumeration giving the in place masks of the bit fields in the LSF identity word. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{LSF_IDENTITY_M_TYPEID@{LSF\_\-IDENTITY\_\-M\_\-TYPEID}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_M_TYPEID@{LSF\_\-IDENTITY\_\-M\_\-TYPEID}}\item[{\em \hypertarget{LSF_8h_a101a57}{ LSF\_\-IDENTITY\_\-M\_\-TYPEID} \label{LSF_8h_a101a57} }]In place mask of the type\-Id field \index{LSF_IDENTITY_M_VERSION@{LSF\_\-IDENTITY\_\-M\_\-VERSION}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_M_VERSION@{LSF\_\-IDENTITY\_\-M\_\-VERSION}}\item[{\em \hypertarget{LSF_8h_a101a58}{ LSF\_\-IDENTITY\_\-M\_\-VERSION} \label{LSF_8h_a101a58} }]In place mask of the version field \index{LSF_IDENTITY_M_OPTS@{LSF\_\-IDENTITY\_\-M\_\-OPTS}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_M_OPTS@{LSF\_\-IDENTITY\_\-M\_\-OPTS}}\item[{\em \hypertarget{LSF_8h_a101a59}{ LSF\_\-IDENTITY\_\-M\_\-OPTS} \label{LSF_8h_a101a59} }]In place mask of the options field \index{LSF_IDENTITY_M_RSVD_0@{LSF\_\-IDENTITY\_\-M\_\-RSVD\_\-0}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_M_RSVD_0@{LSF\_\-IDENTITY\_\-M\_\-RSVD\_\-0}}\item[{\em \hypertarget{LSF_8h_a101a60}{ LSF\_\-IDENTITY\_\-M\_\-RSVD\_\-0} \label{LSF_8h_a101a60} }]In place mask of the reserved flag 0, must be zero \index{LSF_IDENTITY_M_RSVD_1@{LSF\_\-IDENTITY\_\-M\_\-RSVD\_\-1}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_M_RSVD_1@{LSF\_\-IDENTITY\_\-M\_\-RSVD\_\-1}}\item[{\em \hypertarget{LSF_8h_a101a61}{ LSF\_\-IDENTITY\_\-M\_\-RSVD\_\-1} \label{LSF_8h_a101a61} }]In place mask of the reserved flag 1, must be zero \index{LSF_IDENTITY_M_ROOT@{LSF\_\-IDENTITY\_\-M\_\-ROOT}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_M_ROOT@{LSF\_\-IDENTITY\_\-M\_\-ROOT}}\item[{\em \hypertarget{LSF_8h_a101a62}{ LSF\_\-IDENTITY\_\-M\_\-ROOT} \label{LSF_8h_a101a62} }]In place mask indicating that a root contribution is present immediately after the datagram header. This option is only valid for datagrams, not contributions \index{LSF_IDENTITY_M_DIR@{LSF\_\-IDENTITY\_\-M\_\-DIR}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_M_DIR@{LSF\_\-IDENTITY\_\-M\_\-DIR}}\item[{\em \hypertarget{LSF_8h_a101a63}{ LSF\_\-IDENTITY\_\-M\_\-DIR} \label{LSF_8h_a101a63} }]In place mask of the flag indicating the payload is a structured directory, i.e. it is not just a bag of bits but,\begin{itemize} \item In the case of a datagram header,one or more contributions or\item In the case of a contribution header, one or more records \end{itemize} \index{LSF_IDENTITY_M_DGM_CTB@{LSF\_\-IDENTITY\_\-M\_\-DGM\_\-CTB}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_M_DGM_CTB@{LSF\_\-IDENTITY\_\-M\_\-DGM\_\-CTB}}\item[{\em \hypertarget{LSF_8h_a101a64}{ LSF\_\-IDENTITY\_\-M\_\-DGM\_\-CTB} \label{LSF_8h_a101a64} }]In place mask of the flag indicating that a datagram is composed of contibutions. \index{LSF_IDENTITY_M_CTB_REC@{LSF\_\-IDENTITY\_\-M\_\-CTB\_\-REC}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_M_CTB_REC@{LSF\_\-IDENTITY\_\-M\_\-CTB\_\-REC}}\item[{\em \hypertarget{LSF_8h_a101a65}{ LSF\_\-IDENTITY\_\-M\_\-CTB\_\-REC} \label{LSF_8h_a101a65} }]In place mask of the flag indicating that a contribution is composed of records \end{description} \end{Desc} \hypertarget{LSF_8h_a99}{ \index{LSF.h@{LSF.h}!_LSF_IDENTITY_S@{\_\-LSF\_\-IDENTITY\_\-S}} \index{_LSF_IDENTITY_S@{\_\-LSF\_\-IDENTITY\_\-S}!LSF.h@{LSF.h}} \subsubsection[\_\-LSF\_\-IDENTITY\_\-S]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{LSF_8h_a99}{\_\-LSF\_\-IDENTITY\_\-S}}} \label{LSF_8h_a99} Enumeration giving the sizes of the bit fields in the LSF identity word. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{LSF_IDENTITY_S_TYPEID@{LSF\_\-IDENTITY\_\-S\_\-TYPEID}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_S_TYPEID@{LSF\_\-IDENTITY\_\-S\_\-TYPEID}}\item[{\em \hypertarget{LSF_8h_a99a39}{ LSF\_\-IDENTITY\_\-S\_\-TYPEID} \label{LSF_8h_a99a39} }]Size, in bits, of the type\-Id field \index{LSF_IDENTITY_S_VERSION@{LSF\_\-IDENTITY\_\-S\_\-VERSION}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_S_VERSION@{LSF\_\-IDENTITY\_\-S\_\-VERSION}}\item[{\em \hypertarget{LSF_8h_a99a40}{ LSF\_\-IDENTITY\_\-S\_\-VERSION} \label{LSF_8h_a99a40} }]Size, in bits, of the version field \index{LSF_IDENTITY_S_OPTS@{LSF\_\-IDENTITY\_\-S\_\-OPTS}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_S_OPTS@{LSF\_\-IDENTITY\_\-S\_\-OPTS}}\item[{\em \hypertarget{LSF_8h_a99a41}{ LSF\_\-IDENTITY\_\-S\_\-OPTS} \label{LSF_8h_a99a41} }]Size, in bits, of the options field \index{LSF_IDENTITY_S_RSVD_0@{LSF\_\-IDENTITY\_\-S\_\-RSVD\_\-0}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_S_RSVD_0@{LSF\_\-IDENTITY\_\-S\_\-RSVD\_\-0}}\item[{\em \hypertarget{LSF_8h_a99a42}{ LSF\_\-IDENTITY\_\-S\_\-RSVD\_\-0} \label{LSF_8h_a99a42} }]Size, in bits, of the reserved flag 0, must be zero \index{LSF_IDENTITY_S_RSVD_1@{LSF\_\-IDENTITY\_\-S\_\-RSVD\_\-1}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_S_RSVD_1@{LSF\_\-IDENTITY\_\-S\_\-RSVD\_\-1}}\item[{\em \hypertarget{LSF_8h_a99a43}{ LSF\_\-IDENTITY\_\-S\_\-RSVD\_\-1} \label{LSF_8h_a99a43} }]Size, in bits, of the reserved flag 1, must be zero \index{LSF_IDENTITY_S_ROOT@{LSF\_\-IDENTITY\_\-S\_\-ROOT}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_S_ROOT@{LSF\_\-IDENTITY\_\-S\_\-ROOT}}\item[{\em \hypertarget{LSF_8h_a99a44}{ LSF\_\-IDENTITY\_\-S\_\-ROOT} \label{LSF_8h_a99a44} }]Size, in bits, of the flag indicating that a root contribution is present immediately after the datagram header. This option is only valid for datagrams, not contributions \index{LSF_IDENTITY_S_DIR@{LSF\_\-IDENTITY\_\-S\_\-DIR}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_S_DIR@{LSF\_\-IDENTITY\_\-S\_\-DIR}}\item[{\em \hypertarget{LSF_8h_a99a45}{ LSF\_\-IDENTITY\_\-S\_\-DIR} \label{LSF_8h_a99a45} }]Size, in bits, of the flag indicating the payload is a structured directory, i.e. it is not just a bag of bits but,\begin{itemize} \item In the case of a datagram header,one or more contributions or\item In the case of a contribution header, one or more records This is kept for backward compatibility, consider using LSF\_\-IDENTITY\_\-S\_\-DGM\_\-CTB or LSF\_\-IDENTITY\_\-S\_\-CTB\_\-REC \end{itemize} \index{LSF_IDENTITY_S_DGM_CTB@{LSF\_\-IDENTITY\_\-S\_\-DGM\_\-CTB}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_S_DGM_CTB@{LSF\_\-IDENTITY\_\-S\_\-DGM\_\-CTB}}\item[{\em \hypertarget{LSF_8h_a99a46}{ LSF\_\-IDENTITY\_\-S\_\-DGM\_\-CTB} \label{LSF_8h_a99a46} }]SIze, in bits, of the flag indicating that a datagram is composed of contributions \index{LSF_IDENTITY_S_CTB_REC@{LSF\_\-IDENTITY\_\-S\_\-CTB\_\-REC}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_S_CTB_REC@{LSF\_\-IDENTITY\_\-S\_\-CTB\_\-REC}}\item[{\em \hypertarget{LSF_8h_a99a47}{ LSF\_\-IDENTITY\_\-S\_\-CTB\_\-REC} \label{LSF_8h_a99a47} }]SIze, in bits, of the flag indicating that a contribution is composed of records \end{description} \end{Desc} \hypertarget{LSF_8h_a100}{ \index{LSF.h@{LSF.h}!_LSF_IDENTITY_V@{\_\-LSF\_\-IDENTITY\_\-V}} \index{_LSF_IDENTITY_V@{\_\-LSF\_\-IDENTITY\_\-V}!LSF.h@{LSF.h}} \subsubsection[\_\-LSF\_\-IDENTITY\_\-V]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{LSF_8h_a100}{\_\-LSF\_\-IDENTITY\_\-V}}} \label{LSF_8h_a100} Enumeration giving the right bit offsets of the bit fields in the LSF identity word. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{LSF_IDENTITY_V_TYPEID@{LSF\_\-IDENTITY\_\-V\_\-TYPEID}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_V_TYPEID@{LSF\_\-IDENTITY\_\-V\_\-TYPEID}}\item[{\em \hypertarget{LSF_8h_a100a48}{ LSF\_\-IDENTITY\_\-V\_\-TYPEID} \label{LSF_8h_a100a48} }]Right justified bit offset of the type\-Id field \index{LSF_IDENTITY_V_VERSION@{LSF\_\-IDENTITY\_\-V\_\-VERSION}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_V_VERSION@{LSF\_\-IDENTITY\_\-V\_\-VERSION}}\item[{\em \hypertarget{LSF_8h_a100a49}{ LSF\_\-IDENTITY\_\-V\_\-VERSION} \label{LSF_8h_a100a49} }]Right justified bit offset of the version field \index{LSF_IDENTITY_V_OPTS@{LSF\_\-IDENTITY\_\-V\_\-OPTS}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_V_OPTS@{LSF\_\-IDENTITY\_\-V\_\-OPTS}}\item[{\em \hypertarget{LSF_8h_a100a50}{ LSF\_\-IDENTITY\_\-V\_\-OPTS} \label{LSF_8h_a100a50} }]Right justified bit offset of the options field \index{LSF_IDENTITY_V_RSVD_0@{LSF\_\-IDENTITY\_\-V\_\-RSVD\_\-0}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_V_RSVD_0@{LSF\_\-IDENTITY\_\-V\_\-RSVD\_\-0}}\item[{\em \hypertarget{LSF_8h_a100a51}{ LSF\_\-IDENTITY\_\-V\_\-RSVD\_\-0} \label{LSF_8h_a100a51} }]Right justified bit offset of the reserved field 0, must be zero \index{LSF_IDENTITY_V_RSVD_1@{LSF\_\-IDENTITY\_\-V\_\-RSVD\_\-1}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_V_RSVD_1@{LSF\_\-IDENTITY\_\-V\_\-RSVD\_\-1}}\item[{\em \hypertarget{LSF_8h_a100a52}{ LSF\_\-IDENTITY\_\-V\_\-RSVD\_\-1} \label{LSF_8h_a100a52} }]Right justified bit offset of the reserved field 1, must be zero \index{LSF_IDENTITY_V_ROOT@{LSF\_\-IDENTITY\_\-V\_\-ROOT}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_V_ROOT@{LSF\_\-IDENTITY\_\-V\_\-ROOT}}\item[{\em \hypertarget{LSF_8h_a100a53}{ LSF\_\-IDENTITY\_\-V\_\-ROOT} \label{LSF_8h_a100a53} }]Right justified bit offset of the flag indicating that a root contribution is present immediately after the datagram header. This option is only valid for datagrams, not contributions \index{LSF_IDENTITY_V_DIR@{LSF\_\-IDENTITY\_\-V\_\-DIR}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_V_DIR@{LSF\_\-IDENTITY\_\-V\_\-DIR}}\item[{\em \hypertarget{LSF_8h_a100a54}{ LSF\_\-IDENTITY\_\-V\_\-DIR} \label{LSF_8h_a100a54} }]Right justified bit offset of the flag indicating the payload is a structured directory, i.e. it is not just a bag of bits but,\begin{itemize} \item In the case of a datagram header,one or more contributions or\item In the case of a contribution header, one or more records Kept for backward compatibility, consider using LSF\_\-IDENTITY\_\-V\_\-DGM\_\-CTB or LSF\_\-IDENTITY\_\-V\_\-CTB\_\-REC \end{itemize} \index{LSF_IDENTITY_V_DGM_CTB@{LSF\_\-IDENTITY\_\-V\_\-DGM\_\-CTB}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_V_DGM_CTB@{LSF\_\-IDENTITY\_\-V\_\-DGM\_\-CTB}}\item[{\em \hypertarget{LSF_8h_a100a55}{ LSF\_\-IDENTITY\_\-V\_\-DGM\_\-CTB} \label{LSF_8h_a100a55} }]Right justified bit offset of the flag indicating that a datagram is composed of contributions \index{LSF_IDENTITY_V_CTB_REC@{LSF\_\-IDENTITY\_\-V\_\-CTB\_\-REC}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_IDENTITY_V_CTB_REC@{LSF\_\-IDENTITY\_\-V\_\-CTB\_\-REC}}\item[{\em \hypertarget{LSF_8h_a100a56}{ LSF\_\-IDENTITY\_\-V\_\-CTB\_\-REC} \label{LSF_8h_a100a56} }]Right justified bit offset of the flag indicating that a contribution is composed of records \end{description} \end{Desc} \hypertarget{LSF_8h_a98}{ \index{LSF.h@{LSF.h}!_LSF_RECORD_HDR_M@{\_\-LSF\_\-RECORD\_\-HDR\_\-M}} \index{_LSF_RECORD_HDR_M@{\_\-LSF\_\-RECORD\_\-HDR\_\-M}!LSF.h@{LSF.h}} \subsubsection[\_\-LSF\_\-RECORD\_\-HDR\_\-M]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{LSF_8h_a98}{\_\-LSF\_\-RECORD\_\-HDR\_\-M}}} \label{LSF_8h_a98} Record Level header, bit field in place masks. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{LSF_RECORD_HDR_M_TYPEID@{LSF\_\-RECORD\_\-HDR\_\-M\_\-TYPEID}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_RECORD_HDR_M_TYPEID@{LSF\_\-RECORD\_\-HDR\_\-M\_\-TYPEID}}\item[{\em \hypertarget{LSF_8h_a98a36}{ LSF\_\-RECORD\_\-HDR\_\-M\_\-TYPEID} \label{LSF_8h_a98a36} }]Subformat type, in place mask \index{LSF_RECORD_HDR_M_BRIDGE@{LSF\_\-RECORD\_\-HDR\_\-M\_\-BRIDGE}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_RECORD_HDR_M_BRIDGE@{LSF\_\-RECORD\_\-HDR\_\-M\_\-BRIDGE}}\item[{\em \hypertarget{LSF_8h_a98a37}{ LSF\_\-RECORD\_\-HDR\_\-M\_\-BRIDGE} \label{LSF_8h_a98a37} }]Subformat type reserved field, in place mask \index{LSF_RECORD_HDR_M_LEN32@{LSF\_\-RECORD\_\-HDR\_\-M\_\-LEN32}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_RECORD_HDR_M_LEN32@{LSF\_\-RECORD\_\-HDR\_\-M\_\-LEN32}}\item[{\em \hypertarget{LSF_8h_a98a38}{ LSF\_\-RECORD\_\-HDR\_\-M\_\-LEN32} \label{LSF_8h_a98a38} }]Data length, in place mask \end{description} \end{Desc} \hypertarget{LSF_8h_a96}{ \index{LSF.h@{LSF.h}!_LSF_RECORD_HDR_S@{\_\-LSF\_\-RECORD\_\-HDR\_\-S}} \index{_LSF_RECORD_HDR_S@{\_\-LSF\_\-RECORD\_\-HDR\_\-S}!LSF.h@{LSF.h}} \subsubsection[\_\-LSF\_\-RECORD\_\-HDR\_\-S]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{LSF_8h_a96}{\_\-LSF\_\-RECORD\_\-HDR\_\-S}}} \label{LSF_8h_a96} Record level header word, bit field sizes. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{LSF_RECORD_HDR_S_BRIDGE@{LSF\_\-RECORD\_\-HDR\_\-S\_\-BRIDGE}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_RECORD_HDR_S_BRIDGE@{LSF\_\-RECORD\_\-HDR\_\-S\_\-BRIDGE}}\item[{\em \hypertarget{LSF_8h_a96a30}{ LSF\_\-RECORD\_\-HDR\_\-S\_\-BRIDGE} \label{LSF_8h_a96a30} }]Subformat type reserved field, size in bits \index{LSF_RECORD_HDR_S_TYPEID@{LSF\_\-RECORD\_\-HDR\_\-S\_\-TYPEID}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_RECORD_HDR_S_TYPEID@{LSF\_\-RECORD\_\-HDR\_\-S\_\-TYPEID}}\item[{\em \hypertarget{LSF_8h_a96a31}{ LSF\_\-RECORD\_\-HDR\_\-S\_\-TYPEID} \label{LSF_8h_a96a31} }]Subformat identifier, size in bits \index{LSF_RECORD_HDR_S_LEN32@{LSF\_\-RECORD\_\-HDR\_\-S\_\-LEN32}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_RECORD_HDR_S_LEN32@{LSF\_\-RECORD\_\-HDR\_\-S\_\-LEN32}}\item[{\em \hypertarget{LSF_8h_a96a32}{ LSF\_\-RECORD\_\-HDR\_\-S\_\-LEN32} \label{LSF_8h_a96a32} }]Data length, size in longwords \end{description} \end{Desc} \hypertarget{LSF_8h_a97}{ \index{LSF.h@{LSF.h}!_LSF_RECORD_HDR_V@{\_\-LSF\_\-RECORD\_\-HDR\_\-V}} \index{_LSF_RECORD_HDR_V@{\_\-LSF\_\-RECORD\_\-HDR\_\-V}!LSF.h@{LSF.h}} \subsubsection[\_\-LSF\_\-RECORD\_\-HDR\_\-V]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{LSF_8h_a97}{\_\-LSF\_\-RECORD\_\-HDR\_\-V}}} \label{LSF_8h_a97} Record Level header, bit field right justified offsets. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{LSF_RECORD_HDR_V_BRIDGE@{LSF\_\-RECORD\_\-HDR\_\-V\_\-BRIDGE}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_RECORD_HDR_V_BRIDGE@{LSF\_\-RECORD\_\-HDR\_\-V\_\-BRIDGE}}\item[{\em \hypertarget{LSF_8h_a97a33}{ LSF\_\-RECORD\_\-HDR\_\-V\_\-BRIDGE} \label{LSF_8h_a97a33} }]Subformat type reserved field, size in bits \index{LSF_RECORD_HDR_V_TYPEID@{LSF\_\-RECORD\_\-HDR\_\-V\_\-TYPEID}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_RECORD_HDR_V_TYPEID@{LSF\_\-RECORD\_\-HDR\_\-V\_\-TYPEID}}\item[{\em \hypertarget{LSF_8h_a97a34}{ LSF\_\-RECORD\_\-HDR\_\-V\_\-TYPEID} \label{LSF_8h_a97a34} }]Subformat identifier, size in bits \index{LSF_RECORD_HDR_V_LEN32@{LSF\_\-RECORD\_\-HDR\_\-V\_\-LEN32}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_RECORD_HDR_V_LEN32@{LSF\_\-RECORD\_\-HDR\_\-V\_\-LEN32}}\item[{\em \hypertarget{LSF_8h_a97a35}{ LSF\_\-RECORD\_\-HDR\_\-V\_\-LEN32} \label{LSF_8h_a97a35} }]Data length, size in longwords \end{description} \end{Desc} \hypertarget{LSF_8h_a104}{ \index{LSF.h@{LSF.h}!_LSF_ROOT_HDR_M@{\_\-LSF\_\-ROOT\_\-HDR\_\-M}} \index{_LSF_ROOT_HDR_M@{\_\-LSF\_\-ROOT\_\-HDR\_\-M}!LSF.h@{LSF.h}} \subsubsection[\_\-LSF\_\-ROOT\_\-HDR\_\-M]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{LSF_8h_a104}{\_\-LSF\_\-ROOT\_\-HDR\_\-M}}} \label{LSF_8h_a104} The in place bit masks of the fields of the root header word. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{LSF_ROOT_HDR_M_LEN32@{LSF\_\-ROOT\_\-HDR\_\-M\_\-LEN32}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_M_LEN32@{LSF\_\-ROOT\_\-HDR\_\-M\_\-LEN32}}\item[{\em \hypertarget{LSF_8h_a104a78}{ LSF\_\-ROOT\_\-HDR\_\-M\_\-LEN32} \label{LSF_8h_a104a78} }]In place bit mask of the length field (units = 32-bit words \index{LSF_ROOT_HDR_M_OPTS@{LSF\_\-ROOT\_\-HDR\_\-M\_\-OPTS}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_M_OPTS@{LSF\_\-ROOT\_\-HDR\_\-M\_\-OPTS}}\item[{\em \hypertarget{LSF_8h_a104a79}{ LSF\_\-ROOT\_\-HDR\_\-M\_\-OPTS} \label{LSF_8h_a104a79} }]In place mask of the record options field \index{LSF_ROOT_HDR_M_RSVD_0@{LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-0}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_M_RSVD_0@{LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-0}}\item[{\em \hypertarget{LSF_8h_a104a80}{ LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-0} \label{LSF_8h_a104a80} }]Right justified bit offset o the reserved flags field 0, must be zero \index{LSF_ROOT_HDR_M_RSVD_1@{LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-1}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_M_RSVD_1@{LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-1}}\item[{\em \hypertarget{LSF_8h_a104a81}{ LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-1} \label{LSF_8h_a104a81} }]Right justified bit offset o the reserved flags field 1, must be zero \index{LSF_ROOT_HDR_M_RSVD_2@{LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-2}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_M_RSVD_2@{LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-2}}\item[{\em \hypertarget{LSF_8h_a104a82}{ LSF\_\-ROOT\_\-HDR\_\-M\_\-RSVD\_\-2} \label{LSF_8h_a104a82} }]Right justified bit offset o the reserved flags field 2, must be zero \index{LSF_ROOT_HDR_M_CTB@{LSF\_\-ROOT\_\-HDR\_\-M\_\-CTB}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_M_CTB@{LSF\_\-ROOT\_\-HDR\_\-M\_\-CTB}}\item[{\em \hypertarget{LSF_8h_a104a83}{ LSF\_\-ROOT\_\-HDR\_\-M\_\-CTB} \label{LSF_8h_a104a83} }]In place bit mask of the flag bit indicating the root is composed of contributions \end{description} \end{Desc} \hypertarget{LSF_8h_a102}{ \index{LSF.h@{LSF.h}!_LSF_ROOT_HDR_S@{\_\-LSF\_\-ROOT\_\-HDR\_\-S}} \index{_LSF_ROOT_HDR_S@{\_\-LSF\_\-ROOT\_\-HDR\_\-S}!LSF.h@{LSF.h}} \subsubsection[\_\-LSF\_\-ROOT\_\-HDR\_\-S]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{LSF_8h_a102}{\_\-LSF\_\-ROOT\_\-HDR\_\-S}}} \label{LSF_8h_a102} The size, in bits, of the fields of the root header word. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{LSF_ROOT_HDR_S_LEN32@{LSF\_\-ROOT\_\-HDR\_\-S\_\-LEN32}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_S_LEN32@{LSF\_\-ROOT\_\-HDR\_\-S\_\-LEN32}}\item[{\em \hypertarget{LSF_8h_a102a66}{ LSF\_\-ROOT\_\-HDR\_\-S\_\-LEN32} \label{LSF_8h_a102a66} }]Size, in bits, of the length field (units = 32-bit words \index{LSF_ROOT_HDR_S_OPTS@{LSF\_\-ROOT\_\-HDR\_\-S\_\-OPTS}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_S_OPTS@{LSF\_\-ROOT\_\-HDR\_\-S\_\-OPTS}}\item[{\em \hypertarget{LSF_8h_a102a67}{ LSF\_\-ROOT\_\-HDR\_\-S\_\-OPTS} \label{LSF_8h_a102a67} }]Size, in bits, of the record options field \index{LSF_ROOT_HDR_S_RSVD_0@{LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-0}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_S_RSVD_0@{LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-0}}\item[{\em \hypertarget{LSF_8h_a102a68}{ LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-0} \label{LSF_8h_a102a68} }]Size, in bits, of the reserved flags field 0, must be zero \index{LSF_ROOT_HDR_S_RSVD_1@{LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-1}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_S_RSVD_1@{LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-1}}\item[{\em \hypertarget{LSF_8h_a102a69}{ LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-1} \label{LSF_8h_a102a69} }]Size, in bits, of the reserved flags field 1, must be zero \index{LSF_ROOT_HDR_S_RSVD_2@{LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-2}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_S_RSVD_2@{LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-2}}\item[{\em \hypertarget{LSF_8h_a102a70}{ LSF\_\-ROOT\_\-HDR\_\-S\_\-RSVD\_\-2} \label{LSF_8h_a102a70} }]Size, in bits, of the reserved flags field 2, must be zero \index{LSF_ROOT_HDR_S_CTB@{LSF\_\-ROOT\_\-HDR\_\-S\_\-CTB}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_S_CTB@{LSF\_\-ROOT\_\-HDR\_\-S\_\-CTB}}\item[{\em \hypertarget{LSF_8h_a102a71}{ LSF\_\-ROOT\_\-HDR\_\-S\_\-CTB} \label{LSF_8h_a102a71} }]Size, in bits, of the flag bit indicating the root is composed of contributions \end{description} \end{Desc} \hypertarget{LSF_8h_a103}{ \index{LSF.h@{LSF.h}!_LSF_ROOT_HDR_V@{\_\-LSF\_\-ROOT\_\-HDR\_\-V}} \index{_LSF_ROOT_HDR_V@{\_\-LSF\_\-ROOT\_\-HDR\_\-V}!LSF.h@{LSF.h}} \subsubsection[\_\-LSF\_\-ROOT\_\-HDR\_\-V]{\setlength{\rightskip}{0pt plus 5cm}enum \hyperlink{LSF_8h_a103}{\_\-LSF\_\-ROOT\_\-HDR\_\-V}}} \label{LSF_8h_a103} The right justified bit offset of the fields of the root header word. \begin{Desc} \item[Enumerator: ]\par \begin{description} \index{LSF_ROOT_HDR_V_LEN32@{LSF\_\-ROOT\_\-HDR\_\-V\_\-LEN32}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_V_LEN32@{LSF\_\-ROOT\_\-HDR\_\-V\_\-LEN32}}\item[{\em \hypertarget{LSF_8h_a103a72}{ LSF\_\-ROOT\_\-HDR\_\-V\_\-LEN32} \label{LSF_8h_a103a72} }]Right justified bit offset of the length field (units=32-bit words \index{LSF_ROOT_HDR_V_OPTS@{LSF\_\-ROOT\_\-HDR\_\-V\_\-OPTS}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_V_OPTS@{LSF\_\-ROOT\_\-HDR\_\-V\_\-OPTS}}\item[{\em \hypertarget{LSF_8h_a103a73}{ LSF\_\-ROOT\_\-HDR\_\-V\_\-OPTS} \label{LSF_8h_a103a73} }]Right justified bit offset of the record options field \index{LSF_ROOT_HDR_V_RSVD_0@{LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-0}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_V_RSVD_0@{LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-0}}\item[{\em \hypertarget{LSF_8h_a103a74}{ LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-0} \label{LSF_8h_a103a74} }]Right justified bit offset o the reserved flags field 0, must be zero \index{LSF_ROOT_HDR_V_RSVD_1@{LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-1}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_V_RSVD_1@{LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-1}}\item[{\em \hypertarget{LSF_8h_a103a75}{ LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-1} \label{LSF_8h_a103a75} }]Right justified bit offset o the reserved flags field 1, must be zero \index{LSF_ROOT_HDR_V_RSVD_2@{LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-2}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_V_RSVD_2@{LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-2}}\item[{\em \hypertarget{LSF_8h_a103a76}{ LSF\_\-ROOT\_\-HDR\_\-V\_\-RSVD\_\-2} \label{LSF_8h_a103a76} }]Right justified bit offset o the reserved flags field 2, must be zero \index{LSF_ROOT_HDR_V_CTB@{LSF\_\-ROOT\_\-HDR\_\-V\_\-CTB}!LSF.h@{LSF.h}}\index{LSF.h@{LSF.h}!LSF_ROOT_HDR_V_CTB@{LSF\_\-ROOT\_\-HDR\_\-V\_\-CTB}}\item[{\em \hypertarget{LSF_8h_a103a77}{ LSF\_\-ROOT\_\-HDR\_\-V\_\-CTB} \label{LSF_8h_a103a77} }]Right justified bit offset of the flag bit indicating the root is composed of contributions \end{description} \end{Desc} \subsection{Function Documentation} \hypertarget{LSF_8h_a92}{ \index{LSF.h@{LSF.h}!LSF_contributionAdvance@{LSF\_\-contributionAdvance}} \index{LSF_contributionAdvance@{LSF\_\-contributionAdvance}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-contributionAdvance]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline \hyperlink{struct__LSF__contribution}{LSF\_\-contribution} $\ast$ LSF\_\-contribution\-Advance (const \hyperlink{struct__LSF__contribution}{LSF\_\-contribution} $\ast$ {\em ctb}, unsigned int {\em n32})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a92} Advances the contribution pointer by the specified number of 32-bit words. \begin{Desc} \item[Returns:]The new contribution pointer\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em ctb}]The contribution pointer to advance \item[{\em n32}]The number of 32-bit words to advance the pointer\end{description} \end{Desc} \hypertarget{LSF_8h_a86}{ \index{LSF.h@{LSF.h}!LSF_contributionIdentityCompose@{LSF\_\-contributionIdentityCompose}} \index{LSF_contributionIdentityCompose@{LSF\_\-contributionIdentityCompose}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-contributionIdentityCompose]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline unsigned int LSF\_\-contribution\-Identity\-Compose (unsigned int {\em type\_\-id}, unsigned int {\em version}, unsigned int {\em opts})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a86} Composes the 32-bit identity word for a contribution from the specified pieces. \begin{Desc} \item[Returns:]The 32-bit identity word;\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em version}]The version of the data being presented \item[{\em type\_\-id}]The type/identifier of the contribution Examples would be LSF\_\-ID\_\-K\_\-LSEP, LSF\_\-ID\_\-K\_\-LSEC \item[{\em opts}]An options word, composed by selectively OR'ing the enumerations defined in the options field section of LSF\_\-IDENTITY\_\-M\end{description} \end{Desc} \begin{Desc} \item[]Note, this functionality is also available as a macro. The macro should be used when initializing data structures, {\em i.e\/}, where calling a function is prohibited. The inline is useful when debugging calls for setting a breakpoint on a routine..\end{Desc} \hypertarget{LSF_8h_a91}{ \index{LSF.h@{LSF.h}!LSF_contributionNext@{LSF\_\-contributionNext}} \index{LSF_contributionNext@{LSF\_\-contributionNext}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-contributionNext]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline \hyperlink{struct__LSF__contribution}{LSF\_\-contribution} $\ast$ LSF\_\-contribution\-Next (const \hyperlink{struct__LSF__contribution}{LSF\_\-contribution} $\ast$ {\em ctb})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a91} Advances the contribution pointer by the length field specified in the contribution header. \begin{Desc} \item[Returns:]The new contribution pointer\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em ctb}]The contribution pointer to advance\end{description} \end{Desc} \hypertarget{LSF_8h_a95}{ \index{LSF.h@{LSF.h}!LSF_datAdvance@{LSF\_\-datAdvance}} \index{LSF_datAdvance@{LSF\_\-datAdvance}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-datAdvance]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline unsigned int $\ast$ LSF\_\-dat\-Advance (const unsigned int $\ast$ {\em dat}, unsigned int {\em n32})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a95} Advances the data pointer by the specified number of 32-bit wo. \begin{Desc} \item[Returns:]The new data pointer\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em dat}]The data pointer to advance \item[{\em n32}]The number of 32-bit words to advance the pointer\end{description} \end{Desc} \hypertarget{LSF_8h_a90}{ \index{LSF.h@{LSF.h}!LSF_datagramAdvance@{LSF\_\-datagramAdvance}} \index{LSF_datagramAdvance@{LSF\_\-datagramAdvance}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-datagramAdvance]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline \hyperlink{struct__LSF__datagram}{LSF\_\-datagram} $\ast$ LSF\_\-datagram\-Advance (const \hyperlink{struct__LSF__datagram}{LSF\_\-datagram} $\ast$ {\em dgm}, unsigned int {\em n32})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a90} Advances the datagram pointer by the specified number of 32-bit words. \begin{Desc} \item[Returns:]The new contribution pointer\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em dgm}]The datagram pointer to advance \item[{\em n32}]The number of 32-bit words to advance the pointer\end{description} \end{Desc} \hypertarget{LSF_8h_a85}{ \index{LSF.h@{LSF.h}!LSF_datagramIdentityCompose@{LSF\_\-datagramIdentityCompose}} \index{LSF_datagramIdentityCompose@{LSF\_\-datagramIdentityCompose}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-datagramIdentityCompose]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline unsigned int LSF\_\-datagram\-Identity\-Compose (unsigned int {\em type\_\-id}, unsigned int {\em version}, unsigned int {\em opts})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a85} Composes the 32-bit identity word for a datagram from the specified pieces. \begin{Desc} \item[Returns:]The 32-bit identity word;\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em version}]The version of the data being presented \item[{\em type\_\-id}]The type/identifier of the datagram Examples would be LSF\_\-ID\_\-K\_\-LSEP, LSF\_\-ID\_\-K\_\-LSEC \item[{\em opts}]An options word, composed by selectively OR'ing the enumerations defined in the options field section of LSF\_\-IDENTITY\_\-M\end{description} \end{Desc} \begin{Desc} \item[]Note, this functionality is also available as a macro. The macro should be used when initializing data structures, {\em i.e\/}, where calling a function is prohibited. The inline is useful when debugging calls for setting a breakpoint on a routine.\end{Desc} \hypertarget{LSF_8h_a89}{ \index{LSF.h@{LSF.h}!LSF_datagramNext@{LSF\_\-datagramNext}} \index{LSF_datagramNext@{LSF\_\-datagramNext}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-datagramNext]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline \hyperlink{struct__LSF__datagram}{LSF\_\-datagram} $\ast$ LSF\_\-datagram\-Next (const \hyperlink{struct__LSF__datagram}{LSF\_\-datagram} $\ast$ {\em dgm})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a89} Advances the datagram pointer by the length field specified in the datagram. \begin{Desc} \item[Returns:]The new datagram pointer\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em dgm}]The datagram pointer to advance\end{description} \end{Desc} \hypertarget{LSF_8h_a84}{ \index{LSF.h@{LSF.h}!LSF_identityCompose@{LSF\_\-identityCompose}} \index{LSF_identityCompose@{LSF\_\-identityCompose}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-identityCompose]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline unsigned int LSF\_\-identity\-Compose (unsigned int {\em type\_\-id}, unsigned int {\em version}, unsigned int {\em dir})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a84} Composes the 32-bit identity word for either a datagram or a contribution from the specified pieces. \begin{Desc} \item[Returns:]The 32-bit identity word;\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em dir}]A flag, if true indicating the datagram/contribution is composed of a series of contributions/records \item[{\em version}]The version of the data being presented \item[{\em type\_\-id}]The type/identifier of the datagram or contribution Examples would be LSF\_\-ID\_\-K\_\-LSEP, LSF\_\-ID\_\-K\_\-LSEC\end{description} \end{Desc} \begin{Desc} \item[]Note, this functionality is also available as a macro. The macro should be used when initializing data structures, {\em i.e\/}, where calling a function is prohibited. The inline is useful when debugging calls for setting a breakpoint on a routine.\end{Desc} \begin{Desc} \item[Warning:]This function may be deprecated in a future release. New code should use the more directed LSF\_\-datagram\-Identity\-Compose or LSF\_\-contribution\-Identity\-Compose.\end{Desc} \hypertarget{LSF_8h_a94}{ \index{LSF.h@{LSF.h}!LSF_recordAdvance@{LSF\_\-recordAdvance}} \index{LSF_recordAdvance@{LSF\_\-recordAdvance}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-recordAdvance]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline \hyperlink{struct__LSF__record}{LSF\_\-record} $\ast$ LSF\_\-record\-Advance (const \hyperlink{struct__LSF__record}{LSF\_\-record} $\ast$ {\em rec}, unsigned int {\em n32})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a94} Advances the record pointer by the specified number of 32-bit words. \begin{Desc} \item[Returns:]The new record pointer\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em rec}]The record pointer to advance \item[{\em n32}]The number of 32-bit words to advance the pointer\end{description} \end{Desc} \begin{Desc} \item[Warning:]The advancement is in the natural units of an record, i.e. 32-bit words.\end{Desc} \hypertarget{LSF_8h_a88}{ \index{LSF.h@{LSF.h}!LSF_recordHdrCompose@{LSF\_\-recordHdrCompose}} \index{LSF_recordHdrCompose@{LSF\_\-recordHdrCompose}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-recordHdrCompose]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline unsigned int LSF\_\-record\-Hdr\-Compose (unsigned int {\em type\_\-id}, unsigned int {\em bridge}, unsigned int {\em len32})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a88} Composes a LSF record header. \begin{Desc} \item[Returns:]The LSF record header\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em type\_\-id}]The record's type/id (0-15) \item[{\em bridge}]The value of the 8-bit bridge field \item[{\em len32}]The length, in longwords, of the record\end{description} \end{Desc} \begin{Desc} \item[]Note, this functionality is also available as a macro. The macro should be used when initializing data structures, {\em i.e\/}, where calling a function is prohibited. The inline is useful when debugging calls for setting a breakpoint on a routine.\end{Desc} \hypertarget{LSF_8h_a93}{ \index{LSF.h@{LSF.h}!LSF_recordNext@{LSF\_\-recordNext}} \index{LSF_recordNext@{LSF\_\-recordNext}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-recordNext]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline \hyperlink{struct__LSF__record}{LSF\_\-record} $\ast$ LSF\_\-record\-Next (const \hyperlink{struct__LSF__record}{LSF\_\-record} $\ast$ {\em rec})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a93} Advances the record pointer by the length field specified in the record header. \begin{Desc} \item[Returns:]The new record pointer\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em rec}]The record pointer to advance\end{description} \end{Desc} \hypertarget{LSF_8h_a87}{ \index{LSF.h@{LSF.h}!LSF_rootHdrCompose@{LSF\_\-rootHdrCompose}} \index{LSF_rootHdrCompose@{LSF\_\-rootHdrCompose}!LSF.h@{LSF.h}} \subsubsection[LSF\_\-rootHdrCompose]{\setlength{\rightskip}{0pt plus 5cm}static \_\-\_\-inline unsigned int LSF\_\-root\-Hdr\-Compose (unsigned int {\em len32}, unsigned int {\em opts})\hspace{0.3cm}{\tt \mbox{[}static\mbox{]}}}} \label{LSF_8h_a87} Compose the root header word. \begin{Desc} \item[Returns:]The compose root header word\end{Desc} \begin{Desc} \item[Parameters:] \begin{description} \item[{\em len32}]The length, in 32-bit words, of the root contribution \item[{\em opts}]An options word composed of relevant values from the enumeration LSF\_\-ROOT\_\-HDR\_\-M\_\-OPTS.\end{description} \end{Desc}