doc/doxygen/latex/canmsg_8h.tex
author nico
Mon, 04 Jun 2007 17:59:50 +0200
changeset 207 b6572d0336c3
permissions -rw-r--r--
First doxygen implementation
\hypertarget{canmsg_8h}{
\section{/home/epimerde/documents/tc11/Can\-Festival-3/drivers/can\_\-lincan/canmsg.h File Reference}
\label{canmsg_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/drivers/can_lincan/canmsg.h@{/home/epimerde/documents/tc11/CanFestival-3/drivers/can\_\-lincan/canmsg.h}}
}
{\tt \#include $<$sys/time.h$>$}\par
{\tt \#include $<$sys/types.h$>$}\par
\subsection*{Data Structures}
\begin{CompactItemize}
\item 
struct \hyperlink{structcanmsg__t}{canmsg\_\-t}
\item 
struct \hyperlink{structcanfilt__t}{canfilt\_\-t}
\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item 
\#define \hyperlink{canmsg_8h_6e08f25b3a7951a82cc337505fc3c27a}{CAN\_\-MSG\_\-VERSION\_\-2}
\item 
\#define \hyperlink{canmsg_8h_eb09c576cda35f0ce23882b092679131}{CAN\_\-MSG\_\-LENGTH}~8
\item 
\#define \hyperlink{canmsg_8h_a17d9d21b15825ab928d225e6b317d26}{MSG\_\-RTR}~(1$<$$<$0)
\item 
\#define \hyperlink{canmsg_8h_8a25d646d69812829a67d88e00245007}{MSG\_\-OVR}~(1$<$$<$1)
\item 
\#define \hyperlink{canmsg_8h_973182db693bc55d98fafe82ad62f68c}{MSG\_\-EXT}~(1$<$$<$2)
\item 
\#define \hyperlink{canmsg_8h_8371666c6983526f38115cda79f63d62}{MSG\_\-LOCAL}~(1$<$$<$3)
\item 
\#define \hyperlink{canmsg_8h_664009574504682c47743d2a3690afa7}{MSG\_\-FILT\_\-MASK\_\-SHIFT}~8
\item 
\#define \hyperlink{canmsg_8h_003ae3d402f58589544d93f02ae5e252}{MSG\_\-RTR\_\-MASK}~(MSG\_\-RTR$<$$<$MSG\_\-FILT\_\-MASK\_\-SHIFT)
\item 
\#define \hyperlink{canmsg_8h_4796f51e6847235d7fcb74b35a023f9f}{MSG\_\-EXT\_\-MASK}~(MSG\_\-EXT$<$$<$MSG\_\-FILT\_\-MASK\_\-SHIFT)
\item 
\#define \hyperlink{canmsg_8h_0fa902ccfba692bf3db9782496acc80b}{MSG\_\-LOCAL\_\-MASK}~(MSG\_\-LOCAL$<$$<$MSG\_\-FILT\_\-MASK\_\-SHIFT)
\item 
\#define \hyperlink{canmsg_8h_2b53a66520d29f4df4473fff575ad417}{MSG\_\-PROCESSLOCAL}~(MSG\_\-OVR$<$$<$MSG\_\-FILT\_\-MASK\_\-SHIFT)
\item 
\#define \hyperlink{canmsg_8h_9a9e40fdca7c76479284ba350e3c8506}{MSG\_\-ID\_\-MASK}~((1l$<$$<$29)-1)
\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef timeval \hyperlink{canmsg_8h_f5a9ea1b33e64787190dccc1ce5419a2}{canmsg\_\-tstamp\_\-t}
\item 
typedef unsigned long \hyperlink{canmsg_8h_4df2eff676652dbe67d372e42ccf8aa7}{canmsg\_\-id\_\-t}
\item 
typedef \hyperlink{structcanmsg__t}{canmsg\_\-t} \hyperlink{canmsg_8h_be94973a423090a2a9a1c15a9479a920}{canmsg\_\-t}
\item 
typedef \hyperlink{structcanfilt__t}{canfilt\_\-t} \hyperlink{canmsg_8h_d37d8411be50cb86c62113a96b56e120}{canfilt\_\-t}
\end{CompactItemize}


\subsection{Define Documentation}
\hypertarget{canmsg_8h_eb09c576cda35f0ce23882b092679131}{
\index{canmsg.h@{canmsg.h}!CAN_MSG_LENGTH@{CAN\_\-MSG\_\-LENGTH}}
\index{CAN_MSG_LENGTH@{CAN\_\-MSG\_\-LENGTH}!canmsg.h@{canmsg.h}}
\subsubsection[CAN\_\-MSG\_\-LENGTH]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-MSG\_\-LENGTH~8}}
\label{canmsg_8h_eb09c576cda35f0ce23882b092679131}




Definition at line 36 of file canmsg.h.\hypertarget{canmsg_8h_6e08f25b3a7951a82cc337505fc3c27a}{
\index{canmsg.h@{canmsg.h}!CAN_MSG_VERSION_2@{CAN\_\-MSG\_\-VERSION\_\-2}}
\index{CAN_MSG_VERSION_2@{CAN\_\-MSG\_\-VERSION\_\-2}!canmsg.h@{canmsg.h}}
\subsubsection[CAN\_\-MSG\_\-VERSION\_\-2]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-MSG\_\-VERSION\_\-2}}
\label{canmsg_8h_6e08f25b3a7951a82cc337505fc3c27a}




Definition at line 33 of file canmsg.h.\hypertarget{canmsg_8h_973182db693bc55d98fafe82ad62f68c}{
\index{canmsg.h@{canmsg.h}!MSG_EXT@{MSG\_\-EXT}}
\index{MSG_EXT@{MSG\_\-EXT}!canmsg.h@{canmsg.h}}
\subsubsection[MSG\_\-EXT]{\setlength{\rightskip}{0pt plus 5cm}\#define MSG\_\-EXT~(1$<$$<$2)}}
\label{canmsg_8h_973182db693bc55d98fafe82ad62f68c}




Definition at line 118 of file canmsg.h.\hypertarget{canmsg_8h_4796f51e6847235d7fcb74b35a023f9f}{
\index{canmsg.h@{canmsg.h}!MSG_EXT_MASK@{MSG\_\-EXT\_\-MASK}}
\index{MSG_EXT_MASK@{MSG\_\-EXT\_\-MASK}!canmsg.h@{canmsg.h}}
\subsubsection[MSG\_\-EXT\_\-MASK]{\setlength{\rightskip}{0pt plus 5cm}\#define MSG\_\-EXT\_\-MASK~(MSG\_\-EXT$<$$<$MSG\_\-FILT\_\-MASK\_\-SHIFT)}}
\label{canmsg_8h_4796f51e6847235d7fcb74b35a023f9f}




Definition at line 125 of file canmsg.h.\hypertarget{canmsg_8h_664009574504682c47743d2a3690afa7}{
\index{canmsg.h@{canmsg.h}!MSG_FILT_MASK_SHIFT@{MSG\_\-FILT\_\-MASK\_\-SHIFT}}
\index{MSG_FILT_MASK_SHIFT@{MSG\_\-FILT\_\-MASK\_\-SHIFT}!canmsg.h@{canmsg.h}}
\subsubsection[MSG\_\-FILT\_\-MASK\_\-SHIFT]{\setlength{\rightskip}{0pt plus 5cm}\#define MSG\_\-FILT\_\-MASK\_\-SHIFT~8}}
\label{canmsg_8h_664009574504682c47743d2a3690afa7}




Definition at line 123 of file canmsg.h.\hypertarget{canmsg_8h_9a9e40fdca7c76479284ba350e3c8506}{
\index{canmsg.h@{canmsg.h}!MSG_ID_MASK@{MSG\_\-ID\_\-MASK}}
\index{MSG_ID_MASK@{MSG\_\-ID\_\-MASK}!canmsg.h@{canmsg.h}}
\subsubsection[MSG\_\-ID\_\-MASK]{\setlength{\rightskip}{0pt plus 5cm}\#define MSG\_\-ID\_\-MASK~((1l$<$$<$29)-1)}}
\label{canmsg_8h_9a9e40fdca7c76479284ba350e3c8506}




Definition at line 130 of file canmsg.h.\hypertarget{canmsg_8h_8371666c6983526f38115cda79f63d62}{
\index{canmsg.h@{canmsg.h}!MSG_LOCAL@{MSG\_\-LOCAL}}
\index{MSG_LOCAL@{MSG\_\-LOCAL}!canmsg.h@{canmsg.h}}
\subsubsection[MSG\_\-LOCAL]{\setlength{\rightskip}{0pt plus 5cm}\#define MSG\_\-LOCAL~(1$<$$<$3)}}
\label{canmsg_8h_8371666c6983526f38115cda79f63d62}




Definition at line 119 of file canmsg.h.\hypertarget{canmsg_8h_0fa902ccfba692bf3db9782496acc80b}{
\index{canmsg.h@{canmsg.h}!MSG_LOCAL_MASK@{MSG\_\-LOCAL\_\-MASK}}
\index{MSG_LOCAL_MASK@{MSG\_\-LOCAL\_\-MASK}!canmsg.h@{canmsg.h}}
\subsubsection[MSG\_\-LOCAL\_\-MASK]{\setlength{\rightskip}{0pt plus 5cm}\#define MSG\_\-LOCAL\_\-MASK~(MSG\_\-LOCAL$<$$<$MSG\_\-FILT\_\-MASK\_\-SHIFT)}}
\label{canmsg_8h_0fa902ccfba692bf3db9782496acc80b}




Definition at line 126 of file canmsg.h.\hypertarget{canmsg_8h_8a25d646d69812829a67d88e00245007}{
\index{canmsg.h@{canmsg.h}!MSG_OVR@{MSG\_\-OVR}}
\index{MSG_OVR@{MSG\_\-OVR}!canmsg.h@{canmsg.h}}
\subsubsection[MSG\_\-OVR]{\setlength{\rightskip}{0pt plus 5cm}\#define MSG\_\-OVR~(1$<$$<$1)}}
\label{canmsg_8h_8a25d646d69812829a67d88e00245007}




Definition at line 117 of file canmsg.h.\hypertarget{canmsg_8h_2b53a66520d29f4df4473fff575ad417}{
\index{canmsg.h@{canmsg.h}!MSG_PROCESSLOCAL@{MSG\_\-PROCESSLOCAL}}
\index{MSG_PROCESSLOCAL@{MSG\_\-PROCESSLOCAL}!canmsg.h@{canmsg.h}}
\subsubsection[MSG\_\-PROCESSLOCAL]{\setlength{\rightskip}{0pt plus 5cm}\#define MSG\_\-PROCESSLOCAL~(MSG\_\-OVR$<$$<$MSG\_\-FILT\_\-MASK\_\-SHIFT)}}
\label{canmsg_8h_2b53a66520d29f4df4473fff575ad417}




Definition at line 127 of file canmsg.h.\hypertarget{canmsg_8h_a17d9d21b15825ab928d225e6b317d26}{
\index{canmsg.h@{canmsg.h}!MSG_RTR@{MSG\_\-RTR}}
\index{MSG_RTR@{MSG\_\-RTR}!canmsg.h@{canmsg.h}}
\subsubsection[MSG\_\-RTR]{\setlength{\rightskip}{0pt plus 5cm}\#define MSG\_\-RTR~(1$<$$<$0)}}
\label{canmsg_8h_a17d9d21b15825ab928d225e6b317d26}




Definition at line 116 of file canmsg.h.\hypertarget{canmsg_8h_003ae3d402f58589544d93f02ae5e252}{
\index{canmsg.h@{canmsg.h}!MSG_RTR_MASK@{MSG\_\-RTR\_\-MASK}}
\index{MSG_RTR_MASK@{MSG\_\-RTR\_\-MASK}!canmsg.h@{canmsg.h}}
\subsubsection[MSG\_\-RTR\_\-MASK]{\setlength{\rightskip}{0pt plus 5cm}\#define MSG\_\-RTR\_\-MASK~(MSG\_\-RTR$<$$<$MSG\_\-FILT\_\-MASK\_\-SHIFT)}}
\label{canmsg_8h_003ae3d402f58589544d93f02ae5e252}




Definition at line 124 of file canmsg.h.

\subsection{Typedef Documentation}
\hypertarget{canmsg_8h_d37d8411be50cb86c62113a96b56e120}{
\index{canmsg.h@{canmsg.h}!canfilt_t@{canfilt\_\-t}}
\index{canfilt_t@{canfilt\_\-t}!canmsg.h@{canmsg.h}}
\subsubsection[canfilt\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef struct \hyperlink{structcanfilt__t}{canfilt\_\-t} \hyperlink{structcanfilt__t}{canfilt\_\-t}}}
\label{canmsg_8h_d37d8411be50cb86c62113a96b56e120}




Definition at line 113 of file canmsg.h.\hypertarget{canmsg_8h_4df2eff676652dbe67d372e42ccf8aa7}{
\index{canmsg.h@{canmsg.h}!canmsg_id_t@{canmsg\_\-id\_\-t}}
\index{canmsg_id_t@{canmsg\_\-id\_\-t}!canmsg.h@{canmsg.h}}
\subsubsection[canmsg\_\-id\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned long \hyperlink{canmsg_8h_4df2eff676652dbe67d372e42ccf8aa7}{canmsg\_\-id\_\-t}}}
\label{canmsg_8h_4df2eff676652dbe67d372e42ccf8aa7}




Definition at line 42 of file canmsg.h.\hypertarget{canmsg_8h_be94973a423090a2a9a1c15a9479a920}{
\index{canmsg.h@{canmsg.h}!canmsg_t@{canmsg\_\-t}}
\index{canmsg_t@{canmsg\_\-t}!canmsg.h@{canmsg.h}}
\subsubsection[canmsg\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef struct \hyperlink{structcanmsg__t}{canmsg\_\-t} \hyperlink{structcanmsg__t}{canmsg\_\-t}}}
\label{canmsg_8h_be94973a423090a2a9a1c15a9479a920}




Definition at line 83 of file canmsg.h.\hypertarget{canmsg_8h_f5a9ea1b33e64787190dccc1ce5419a2}{
\index{canmsg.h@{canmsg.h}!canmsg_tstamp_t@{canmsg\_\-tstamp\_\-t}}
\index{canmsg_tstamp_t@{canmsg\_\-tstamp\_\-t}!canmsg.h@{canmsg.h}}
\subsubsection[canmsg\_\-tstamp\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef struct timeval \hyperlink{canmsg_8h_f5a9ea1b33e64787190dccc1ce5419a2}{canmsg\_\-tstamp\_\-t}}}
\label{canmsg_8h_f5a9ea1b33e64787190dccc1ce5419a2}




Definition at line 40 of file canmsg.h.