doc/doxygen/latex/lincan_8h.tex
author nico
Tue, 05 Jun 2007 18:43:21 +0200
changeset 210 6b5a4c21e061
parent 207 b6572d0336c3
permissions -rw-r--r--
Manual and Documentation finish
\hypertarget{lincan_8h}{
\section{/home/epimerde/documents/tc11/Can\-Festival-3/drivers/can\_\-lincan/lincan.h File Reference}
\label{lincan_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/drivers/can_lincan/lincan.h@{/home/epimerde/documents/tc11/CanFestival-3/drivers/can\_\-lincan/lincan.h}}
}
{\tt \#include $<$sys/time.h$>$}\par
{\tt \#include $<$sys/types.h$>$}\par
{\tt \#include $<$sys/ioctl.h$>$}\par
{\tt \#include \char`\"{}./canmsg.h\char`\"{}}\par
\subsection*{Data Structures}
\begin{CompactItemize}
\item 
struct \hyperlink{structcan__baudparams__t}{can\_\-baudparams\_\-t}
\end{CompactItemize}
\subsection*{Defines}
\begin{CompactItemize}
\item 
\#define \hyperlink{lincan_8h_edfec349e7eb84dc1e60924b7f262a0e}{CAN\_\-IOC\_\-MAGIC}~'d'
\item 
\#define \hyperlink{lincan_8h_3b049542c0383cbce199aad5d240a2dc}{CAN\_\-DRV\_\-QUERY}~\_\-IO(CAN\_\-IOC\_\-MAGIC, 0)
\item 
\#define \hyperlink{lincan_8h_df0a0b486c35c338028d6054e469d976}{CAN\_\-DRV\_\-QRY\_\-BRANCH}~0
\item 
\#define \hyperlink{lincan_8h_c50df3601f78c81c90f46fdf29ad926b}{CAN\_\-DRV\_\-QRY\_\-VERSION}~1
\item 
\#define \hyperlink{lincan_8h_fda0151d8d8e5ffd9609890f4e35447b}{CAN\_\-DRV\_\-QRY\_\-MSGFORMAT}~2
\item 
\#define \hyperlink{lincan_8h_b905e6aff2332984df0552c6b50203f2}{CMD\_\-START}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 1, \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t})
\item 
\#define \hyperlink{lincan_8h_46dc7ae84992bfe62cc00731959a67f4}{CMD\_\-STOP}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 2, \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t})
\item 
\#define \hyperlink{lincan_8h_f9438e3cb11f76f235f619f485820e97}{CONF\_\-BAUD}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 4, \hyperlink{lincan_8h_a4668d3e5f141bf55821db4c528a9231}{bittiming\_\-t})
\item 
\#define \hyperlink{lincan_8h_c50db35e4beea548c3e66447f25d30c6}{CONF\_\-FILTER}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 8, unsigned char)
\item 
\#define \hyperlink{lincan_8h_47c1b9c9a7b4183ac4fd96dc5ca8e820}{STAT}~\_\-IO(CAN\_\-IOC\_\-MAGIC, 9)
\item 
\#define \hyperlink{lincan_8h_76a2a98cbf8a80fd83fb5c6d4df17340}{CANQUE\_\-FILTER}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 10, struct \hyperlink{structcanfilt__t}{canfilt\_\-t})
\item 
\#define \hyperlink{lincan_8h_4472b7dda19ee82821f9b7b8d063c79f}{CANQUE\_\-FLUSH}~\_\-IO(CAN\_\-IOC\_\-MAGIC, 11)
\item 
\#define \hyperlink{lincan_8h_fb3bb74a3850e5eb2dbe5ae1c295f748}{CONF\_\-BAUDPARAMS}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 11, struct \hyperlink{structcan__baudparams__t}{can\_\-baudparams\_\-t})
\item 
\#define \hyperlink{lincan_8h_af40c0873e8b794d0e252751898fee43}{CANRTR\_\-READ}~\_\-IOWR(CAN\_\-IOC\_\-MAGIC, 12, struct \hyperlink{structcanmsg__t}{canmsg\_\-t})
\end{CompactItemize}
\subsection*{Typedefs}
\begin{CompactItemize}
\item 
typedef unsigned long \hyperlink{lincan_8h_a4668d3e5f141bf55821db4c528a9231}{bittiming\_\-t}
\item 
typedef unsigned short \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t}
\end{CompactItemize}


\subsection{Define Documentation}
\hypertarget{lincan_8h_df0a0b486c35c338028d6054e469d976}{
\index{lincan.h@{lincan.h}!CAN_DRV_QRY_BRANCH@{CAN\_\-DRV\_\-QRY\_\-BRANCH}}
\index{CAN_DRV_QRY_BRANCH@{CAN\_\-DRV\_\-QRY\_\-BRANCH}!lincan.h@{lincan.h}}
\subsubsection[CAN\_\-DRV\_\-QRY\_\-BRANCH]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-DRV\_\-QRY\_\-BRANCH~0}}
\label{lincan_8h_df0a0b486c35c338028d6054e469d976}




Definition at line 58 of file lincan.h.\hypertarget{lincan_8h_fda0151d8d8e5ffd9609890f4e35447b}{
\index{lincan.h@{lincan.h}!CAN_DRV_QRY_MSGFORMAT@{CAN\_\-DRV\_\-QRY\_\-MSGFORMAT}}
\index{CAN_DRV_QRY_MSGFORMAT@{CAN\_\-DRV\_\-QRY\_\-MSGFORMAT}!lincan.h@{lincan.h}}
\subsubsection[CAN\_\-DRV\_\-QRY\_\-MSGFORMAT]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-DRV\_\-QRY\_\-MSGFORMAT~2}}
\label{lincan_8h_fda0151d8d8e5ffd9609890f4e35447b}




Definition at line 60 of file lincan.h.\hypertarget{lincan_8h_c50df3601f78c81c90f46fdf29ad926b}{
\index{lincan.h@{lincan.h}!CAN_DRV_QRY_VERSION@{CAN\_\-DRV\_\-QRY\_\-VERSION}}
\index{CAN_DRV_QRY_VERSION@{CAN\_\-DRV\_\-QRY\_\-VERSION}!lincan.h@{lincan.h}}
\subsubsection[CAN\_\-DRV\_\-QRY\_\-VERSION]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-DRV\_\-QRY\_\-VERSION~1}}
\label{lincan_8h_c50df3601f78c81c90f46fdf29ad926b}




Definition at line 59 of file lincan.h.\hypertarget{lincan_8h_3b049542c0383cbce199aad5d240a2dc}{
\index{lincan.h@{lincan.h}!CAN_DRV_QUERY@{CAN\_\-DRV\_\-QUERY}}
\index{CAN_DRV_QUERY@{CAN\_\-DRV\_\-QUERY}!lincan.h@{lincan.h}}
\subsubsection[CAN\_\-DRV\_\-QUERY]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-DRV\_\-QUERY~\_\-IO(CAN\_\-IOC\_\-MAGIC, 0)}}
\label{lincan_8h_3b049542c0383cbce199aad5d240a2dc}




Definition at line 57 of file lincan.h.\hypertarget{lincan_8h_edfec349e7eb84dc1e60924b7f262a0e}{
\index{lincan.h@{lincan.h}!CAN_IOC_MAGIC@{CAN\_\-IOC\_\-MAGIC}}
\index{CAN_IOC_MAGIC@{CAN\_\-IOC\_\-MAGIC}!lincan.h@{lincan.h}}
\subsubsection[CAN\_\-IOC\_\-MAGIC]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-IOC\_\-MAGIC~'d'}}
\label{lincan_8h_edfec349e7eb84dc1e60924b7f262a0e}




Definition at line 34 of file lincan.h.\hypertarget{lincan_8h_76a2a98cbf8a80fd83fb5c6d4df17340}{
\index{lincan.h@{lincan.h}!CANQUE_FILTER@{CANQUE\_\-FILTER}}
\index{CANQUE_FILTER@{CANQUE\_\-FILTER}!lincan.h@{lincan.h}}
\subsubsection[CANQUE\_\-FILTER]{\setlength{\rightskip}{0pt plus 5cm}\#define CANQUE\_\-FILTER~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 10, struct \hyperlink{structcanfilt__t}{canfilt\_\-t})}}
\label{lincan_8h_76a2a98cbf8a80fd83fb5c6d4df17340}




Definition at line 77 of file lincan.h.\hypertarget{lincan_8h_4472b7dda19ee82821f9b7b8d063c79f}{
\index{lincan.h@{lincan.h}!CANQUE_FLUSH@{CANQUE\_\-FLUSH}}
\index{CANQUE_FLUSH@{CANQUE\_\-FLUSH}!lincan.h@{lincan.h}}
\subsubsection[CANQUE\_\-FLUSH]{\setlength{\rightskip}{0pt plus 5cm}\#define CANQUE\_\-FLUSH~\_\-IO(CAN\_\-IOC\_\-MAGIC, 11)}}
\label{lincan_8h_4472b7dda19ee82821f9b7b8d063c79f}




Definition at line 78 of file lincan.h.\hypertarget{lincan_8h_af40c0873e8b794d0e252751898fee43}{
\index{lincan.h@{lincan.h}!CANRTR_READ@{CANRTR\_\-READ}}
\index{CANRTR_READ@{CANRTR\_\-READ}!lincan.h@{lincan.h}}
\subsubsection[CANRTR\_\-READ]{\setlength{\rightskip}{0pt plus 5cm}\#define CANRTR\_\-READ~\_\-IOWR(CAN\_\-IOC\_\-MAGIC, 12, struct \hyperlink{structcanmsg__t}{canmsg\_\-t})}}
\label{lincan_8h_af40c0873e8b794d0e252751898fee43}




Definition at line 80 of file lincan.h.\hypertarget{lincan_8h_b905e6aff2332984df0552c6b50203f2}{
\index{lincan.h@{lincan.h}!CMD_START@{CMD\_\-START}}
\index{CMD_START@{CMD\_\-START}!lincan.h@{lincan.h}}
\subsubsection[CMD\_\-START]{\setlength{\rightskip}{0pt plus 5cm}\#define CMD\_\-START~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 1, \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t})}}
\label{lincan_8h_b905e6aff2332984df0552c6b50203f2}




Definition at line 62 of file lincan.h.\hypertarget{lincan_8h_46dc7ae84992bfe62cc00731959a67f4}{
\index{lincan.h@{lincan.h}!CMD_STOP@{CMD\_\-STOP}}
\index{CMD_STOP@{CMD\_\-STOP}!lincan.h@{lincan.h}}
\subsubsection[CMD\_\-STOP]{\setlength{\rightskip}{0pt plus 5cm}\#define CMD\_\-STOP~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 2, \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t})}}
\label{lincan_8h_46dc7ae84992bfe62cc00731959a67f4}




Definition at line 63 of file lincan.h.\hypertarget{lincan_8h_f9438e3cb11f76f235f619f485820e97}{
\index{lincan.h@{lincan.h}!CONF_BAUD@{CONF\_\-BAUD}}
\index{CONF_BAUD@{CONF\_\-BAUD}!lincan.h@{lincan.h}}
\subsubsection[CONF\_\-BAUD]{\setlength{\rightskip}{0pt plus 5cm}\#define CONF\_\-BAUD~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 4, \hyperlink{lincan_8h_a4668d3e5f141bf55821db4c528a9231}{bittiming\_\-t})}}
\label{lincan_8h_f9438e3cb11f76f235f619f485820e97}




Definition at line 66 of file lincan.h.\hypertarget{lincan_8h_fb3bb74a3850e5eb2dbe5ae1c295f748}{
\index{lincan.h@{lincan.h}!CONF_BAUDPARAMS@{CONF\_\-BAUDPARAMS}}
\index{CONF_BAUDPARAMS@{CONF\_\-BAUDPARAMS}!lincan.h@{lincan.h}}
\subsubsection[CONF\_\-BAUDPARAMS]{\setlength{\rightskip}{0pt plus 5cm}\#define CONF\_\-BAUDPARAMS~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 11, struct \hyperlink{structcan__baudparams__t}{can\_\-baudparams\_\-t})}}
\label{lincan_8h_fb3bb74a3850e5eb2dbe5ae1c295f748}




Definition at line 79 of file lincan.h.\hypertarget{lincan_8h_c50db35e4beea548c3e66447f25d30c6}{
\index{lincan.h@{lincan.h}!CONF_FILTER@{CONF\_\-FILTER}}
\index{CONF_FILTER@{CONF\_\-FILTER}!lincan.h@{lincan.h}}
\subsubsection[CONF\_\-FILTER]{\setlength{\rightskip}{0pt plus 5cm}\#define CONF\_\-FILTER~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 8, unsigned char)}}
\label{lincan_8h_c50db35e4beea548c3e66447f25d30c6}




Definition at line 71 of file lincan.h.\hypertarget{lincan_8h_47c1b9c9a7b4183ac4fd96dc5ca8e820}{
\index{lincan.h@{lincan.h}!STAT@{STAT}}
\index{STAT@{STAT}!lincan.h@{lincan.h}}
\subsubsection[STAT]{\setlength{\rightskip}{0pt plus 5cm}\#define STAT~\_\-IO(CAN\_\-IOC\_\-MAGIC, 9)}}
\label{lincan_8h_47c1b9c9a7b4183ac4fd96dc5ca8e820}




Definition at line 76 of file lincan.h.

\subsection{Typedef Documentation}
\hypertarget{lincan_8h_a4668d3e5f141bf55821db4c528a9231}{
\index{lincan.h@{lincan.h}!bittiming_t@{bittiming\_\-t}}
\index{bittiming_t@{bittiming\_\-t}!lincan.h@{lincan.h}}
\subsubsection[bittiming\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned long \hyperlink{lincan_8h_a4668d3e5f141bf55821db4c528a9231}{bittiming\_\-t}}}
\label{lincan_8h_a4668d3e5f141bf55821db4c528a9231}




Definition at line 36 of file lincan.h.\hypertarget{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{
\index{lincan.h@{lincan.h}!channel_t@{channel\_\-t}}
\index{channel_t@{channel\_\-t}!lincan.h@{lincan.h}}
\subsubsection[channel\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned short \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t}}}
\label{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}




Definition at line 37 of file lincan.h.