doc/doxygen/latex/lincan_8h.tex
changeset 207 b6572d0336c3
equal deleted inserted replaced
206:6787754b251b 207:b6572d0336c3
       
     1 \hypertarget{lincan_8h}{
       
     2 \section{/home/epimerde/documents/tc11/Can\-Festival-3/drivers/can\_\-lincan/lincan.h File Reference}
       
     3 \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}}
       
     4 }
       
     5 {\tt \#include $<$sys/time.h$>$}\par
       
     6 {\tt \#include $<$sys/types.h$>$}\par
       
     7 {\tt \#include $<$sys/ioctl.h$>$}\par
       
     8 {\tt \#include \char`\"{}./canmsg.h\char`\"{}}\par
       
     9 \subsection*{Data Structures}
       
    10 \begin{CompactItemize}
       
    11 \item 
       
    12 struct \hyperlink{structcan__baudparams__t}{can\_\-baudparams\_\-t}
       
    13 \end{CompactItemize}
       
    14 \subsection*{Defines}
       
    15 \begin{CompactItemize}
       
    16 \item 
       
    17 \#define \hyperlink{lincan_8h_edfec349e7eb84dc1e60924b7f262a0e}{CAN\_\-IOC\_\-MAGIC}~'d'
       
    18 \item 
       
    19 \#define \hyperlink{lincan_8h_3b049542c0383cbce199aad5d240a2dc}{CAN\_\-DRV\_\-QUERY}~\_\-IO(CAN\_\-IOC\_\-MAGIC, 0)
       
    20 \item 
       
    21 \#define \hyperlink{lincan_8h_df0a0b486c35c338028d6054e469d976}{CAN\_\-DRV\_\-QRY\_\-BRANCH}~0
       
    22 \item 
       
    23 \#define \hyperlink{lincan_8h_c50df3601f78c81c90f46fdf29ad926b}{CAN\_\-DRV\_\-QRY\_\-VERSION}~1
       
    24 \item 
       
    25 \#define \hyperlink{lincan_8h_fda0151d8d8e5ffd9609890f4e35447b}{CAN\_\-DRV\_\-QRY\_\-MSGFORMAT}~2
       
    26 \item 
       
    27 \#define \hyperlink{lincan_8h_b905e6aff2332984df0552c6b50203f2}{CMD\_\-START}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 1, \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t})
       
    28 \item 
       
    29 \#define \hyperlink{lincan_8h_46dc7ae84992bfe62cc00731959a67f4}{CMD\_\-STOP}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 2, \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t})
       
    30 \item 
       
    31 \#define \hyperlink{lincan_8h_f9438e3cb11f76f235f619f485820e97}{CONF\_\-BAUD}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 4, \hyperlink{lincan_8h_a4668d3e5f141bf55821db4c528a9231}{bittiming\_\-t})
       
    32 \item 
       
    33 \#define \hyperlink{lincan_8h_c50db35e4beea548c3e66447f25d30c6}{CONF\_\-FILTER}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 8, unsigned char)
       
    34 \item 
       
    35 \#define \hyperlink{lincan_8h_47c1b9c9a7b4183ac4fd96dc5ca8e820}{STAT}~\_\-IO(CAN\_\-IOC\_\-MAGIC, 9)
       
    36 \item 
       
    37 \#define \hyperlink{lincan_8h_76a2a98cbf8a80fd83fb5c6d4df17340}{CANQUE\_\-FILTER}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 10, struct \hyperlink{structcanfilt__t}{canfilt\_\-t})
       
    38 \item 
       
    39 \#define \hyperlink{lincan_8h_4472b7dda19ee82821f9b7b8d063c79f}{CANQUE\_\-FLUSH}~\_\-IO(CAN\_\-IOC\_\-MAGIC, 11)
       
    40 \item 
       
    41 \#define \hyperlink{lincan_8h_fb3bb74a3850e5eb2dbe5ae1c295f748}{CONF\_\-BAUDPARAMS}~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 11, struct \hyperlink{structcan__baudparams__t}{can\_\-baudparams\_\-t})
       
    42 \item 
       
    43 \#define \hyperlink{lincan_8h_af40c0873e8b794d0e252751898fee43}{CANRTR\_\-READ}~\_\-IOWR(CAN\_\-IOC\_\-MAGIC, 12, struct \hyperlink{structcanmsg__t}{canmsg\_\-t})
       
    44 \end{CompactItemize}
       
    45 \subsection*{Typedefs}
       
    46 \begin{CompactItemize}
       
    47 \item 
       
    48 typedef unsigned long \hyperlink{lincan_8h_a4668d3e5f141bf55821db4c528a9231}{bittiming\_\-t}
       
    49 \item 
       
    50 typedef unsigned short \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t}
       
    51 \end{CompactItemize}
       
    52 
       
    53 
       
    54 \subsection{Define Documentation}
       
    55 \hypertarget{lincan_8h_df0a0b486c35c338028d6054e469d976}{
       
    56 \index{lincan.h@{lincan.h}!CAN_DRV_QRY_BRANCH@{CAN\_\-DRV\_\-QRY\_\-BRANCH}}
       
    57 \index{CAN_DRV_QRY_BRANCH@{CAN\_\-DRV\_\-QRY\_\-BRANCH}!lincan.h@{lincan.h}}
       
    58 \subsubsection[CAN\_\-DRV\_\-QRY\_\-BRANCH]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-DRV\_\-QRY\_\-BRANCH~0}}
       
    59 \label{lincan_8h_df0a0b486c35c338028d6054e469d976}
       
    60 
       
    61 
       
    62 
       
    63 
       
    64 Definition at line 58 of file lincan.h.\hypertarget{lincan_8h_fda0151d8d8e5ffd9609890f4e35447b}{
       
    65 \index{lincan.h@{lincan.h}!CAN_DRV_QRY_MSGFORMAT@{CAN\_\-DRV\_\-QRY\_\-MSGFORMAT}}
       
    66 \index{CAN_DRV_QRY_MSGFORMAT@{CAN\_\-DRV\_\-QRY\_\-MSGFORMAT}!lincan.h@{lincan.h}}
       
    67 \subsubsection[CAN\_\-DRV\_\-QRY\_\-MSGFORMAT]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-DRV\_\-QRY\_\-MSGFORMAT~2}}
       
    68 \label{lincan_8h_fda0151d8d8e5ffd9609890f4e35447b}
       
    69 
       
    70 
       
    71 
       
    72 
       
    73 Definition at line 60 of file lincan.h.\hypertarget{lincan_8h_c50df3601f78c81c90f46fdf29ad926b}{
       
    74 \index{lincan.h@{lincan.h}!CAN_DRV_QRY_VERSION@{CAN\_\-DRV\_\-QRY\_\-VERSION}}
       
    75 \index{CAN_DRV_QRY_VERSION@{CAN\_\-DRV\_\-QRY\_\-VERSION}!lincan.h@{lincan.h}}
       
    76 \subsubsection[CAN\_\-DRV\_\-QRY\_\-VERSION]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-DRV\_\-QRY\_\-VERSION~1}}
       
    77 \label{lincan_8h_c50df3601f78c81c90f46fdf29ad926b}
       
    78 
       
    79 
       
    80 
       
    81 
       
    82 Definition at line 59 of file lincan.h.\hypertarget{lincan_8h_3b049542c0383cbce199aad5d240a2dc}{
       
    83 \index{lincan.h@{lincan.h}!CAN_DRV_QUERY@{CAN\_\-DRV\_\-QUERY}}
       
    84 \index{CAN_DRV_QUERY@{CAN\_\-DRV\_\-QUERY}!lincan.h@{lincan.h}}
       
    85 \subsubsection[CAN\_\-DRV\_\-QUERY]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-DRV\_\-QUERY~\_\-IO(CAN\_\-IOC\_\-MAGIC, 0)}}
       
    86 \label{lincan_8h_3b049542c0383cbce199aad5d240a2dc}
       
    87 
       
    88 
       
    89 
       
    90 
       
    91 Definition at line 57 of file lincan.h.\hypertarget{lincan_8h_edfec349e7eb84dc1e60924b7f262a0e}{
       
    92 \index{lincan.h@{lincan.h}!CAN_IOC_MAGIC@{CAN\_\-IOC\_\-MAGIC}}
       
    93 \index{CAN_IOC_MAGIC@{CAN\_\-IOC\_\-MAGIC}!lincan.h@{lincan.h}}
       
    94 \subsubsection[CAN\_\-IOC\_\-MAGIC]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-IOC\_\-MAGIC~'d'}}
       
    95 \label{lincan_8h_edfec349e7eb84dc1e60924b7f262a0e}
       
    96 
       
    97 
       
    98 
       
    99 
       
   100 Definition at line 34 of file lincan.h.\hypertarget{lincan_8h_76a2a98cbf8a80fd83fb5c6d4df17340}{
       
   101 \index{lincan.h@{lincan.h}!CANQUE_FILTER@{CANQUE\_\-FILTER}}
       
   102 \index{CANQUE_FILTER@{CANQUE\_\-FILTER}!lincan.h@{lincan.h}}
       
   103 \subsubsection[CANQUE\_\-FILTER]{\setlength{\rightskip}{0pt plus 5cm}\#define CANQUE\_\-FILTER~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 10, struct \hyperlink{structcanfilt__t}{canfilt\_\-t})}}
       
   104 \label{lincan_8h_76a2a98cbf8a80fd83fb5c6d4df17340}
       
   105 
       
   106 
       
   107 
       
   108 
       
   109 Definition at line 77 of file lincan.h.\hypertarget{lincan_8h_4472b7dda19ee82821f9b7b8d063c79f}{
       
   110 \index{lincan.h@{lincan.h}!CANQUE_FLUSH@{CANQUE\_\-FLUSH}}
       
   111 \index{CANQUE_FLUSH@{CANQUE\_\-FLUSH}!lincan.h@{lincan.h}}
       
   112 \subsubsection[CANQUE\_\-FLUSH]{\setlength{\rightskip}{0pt plus 5cm}\#define CANQUE\_\-FLUSH~\_\-IO(CAN\_\-IOC\_\-MAGIC, 11)}}
       
   113 \label{lincan_8h_4472b7dda19ee82821f9b7b8d063c79f}
       
   114 
       
   115 
       
   116 
       
   117 
       
   118 Definition at line 78 of file lincan.h.\hypertarget{lincan_8h_af40c0873e8b794d0e252751898fee43}{
       
   119 \index{lincan.h@{lincan.h}!CANRTR_READ@{CANRTR\_\-READ}}
       
   120 \index{CANRTR_READ@{CANRTR\_\-READ}!lincan.h@{lincan.h}}
       
   121 \subsubsection[CANRTR\_\-READ]{\setlength{\rightskip}{0pt plus 5cm}\#define CANRTR\_\-READ~\_\-IOWR(CAN\_\-IOC\_\-MAGIC, 12, struct \hyperlink{structcanmsg__t}{canmsg\_\-t})}}
       
   122 \label{lincan_8h_af40c0873e8b794d0e252751898fee43}
       
   123 
       
   124 
       
   125 
       
   126 
       
   127 Definition at line 80 of file lincan.h.\hypertarget{lincan_8h_b905e6aff2332984df0552c6b50203f2}{
       
   128 \index{lincan.h@{lincan.h}!CMD_START@{CMD\_\-START}}
       
   129 \index{CMD_START@{CMD\_\-START}!lincan.h@{lincan.h}}
       
   130 \subsubsection[CMD\_\-START]{\setlength{\rightskip}{0pt plus 5cm}\#define CMD\_\-START~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 1, \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t})}}
       
   131 \label{lincan_8h_b905e6aff2332984df0552c6b50203f2}
       
   132 
       
   133 
       
   134 
       
   135 
       
   136 Definition at line 62 of file lincan.h.\hypertarget{lincan_8h_46dc7ae84992bfe62cc00731959a67f4}{
       
   137 \index{lincan.h@{lincan.h}!CMD_STOP@{CMD\_\-STOP}}
       
   138 \index{CMD_STOP@{CMD\_\-STOP}!lincan.h@{lincan.h}}
       
   139 \subsubsection[CMD\_\-STOP]{\setlength{\rightskip}{0pt plus 5cm}\#define CMD\_\-STOP~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 2, \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t})}}
       
   140 \label{lincan_8h_46dc7ae84992bfe62cc00731959a67f4}
       
   141 
       
   142 
       
   143 
       
   144 
       
   145 Definition at line 63 of file lincan.h.\hypertarget{lincan_8h_f9438e3cb11f76f235f619f485820e97}{
       
   146 \index{lincan.h@{lincan.h}!CONF_BAUD@{CONF\_\-BAUD}}
       
   147 \index{CONF_BAUD@{CONF\_\-BAUD}!lincan.h@{lincan.h}}
       
   148 \subsubsection[CONF\_\-BAUD]{\setlength{\rightskip}{0pt plus 5cm}\#define CONF\_\-BAUD~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 4, \hyperlink{lincan_8h_a4668d3e5f141bf55821db4c528a9231}{bittiming\_\-t})}}
       
   149 \label{lincan_8h_f9438e3cb11f76f235f619f485820e97}
       
   150 
       
   151 
       
   152 
       
   153 
       
   154 Definition at line 66 of file lincan.h.\hypertarget{lincan_8h_fb3bb74a3850e5eb2dbe5ae1c295f748}{
       
   155 \index{lincan.h@{lincan.h}!CONF_BAUDPARAMS@{CONF\_\-BAUDPARAMS}}
       
   156 \index{CONF_BAUDPARAMS@{CONF\_\-BAUDPARAMS}!lincan.h@{lincan.h}}
       
   157 \subsubsection[CONF\_\-BAUDPARAMS]{\setlength{\rightskip}{0pt plus 5cm}\#define CONF\_\-BAUDPARAMS~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 11, struct \hyperlink{structcan__baudparams__t}{can\_\-baudparams\_\-t})}}
       
   158 \label{lincan_8h_fb3bb74a3850e5eb2dbe5ae1c295f748}
       
   159 
       
   160 
       
   161 
       
   162 
       
   163 Definition at line 79 of file lincan.h.\hypertarget{lincan_8h_c50db35e4beea548c3e66447f25d30c6}{
       
   164 \index{lincan.h@{lincan.h}!CONF_FILTER@{CONF\_\-FILTER}}
       
   165 \index{CONF_FILTER@{CONF\_\-FILTER}!lincan.h@{lincan.h}}
       
   166 \subsubsection[CONF\_\-FILTER]{\setlength{\rightskip}{0pt plus 5cm}\#define CONF\_\-FILTER~\_\-IOW(CAN\_\-IOC\_\-MAGIC, 8, unsigned char)}}
       
   167 \label{lincan_8h_c50db35e4beea548c3e66447f25d30c6}
       
   168 
       
   169 
       
   170 
       
   171 
       
   172 Definition at line 71 of file lincan.h.\hypertarget{lincan_8h_47c1b9c9a7b4183ac4fd96dc5ca8e820}{
       
   173 \index{lincan.h@{lincan.h}!STAT@{STAT}}
       
   174 \index{STAT@{STAT}!lincan.h@{lincan.h}}
       
   175 \subsubsection[STAT]{\setlength{\rightskip}{0pt plus 5cm}\#define STAT~\_\-IO(CAN\_\-IOC\_\-MAGIC, 9)}}
       
   176 \label{lincan_8h_47c1b9c9a7b4183ac4fd96dc5ca8e820}
       
   177 
       
   178 
       
   179 
       
   180 
       
   181 Definition at line 76 of file lincan.h.
       
   182 
       
   183 \subsection{Typedef Documentation}
       
   184 \hypertarget{lincan_8h_a4668d3e5f141bf55821db4c528a9231}{
       
   185 \index{lincan.h@{lincan.h}!bittiming_t@{bittiming\_\-t}}
       
   186 \index{bittiming_t@{bittiming\_\-t}!lincan.h@{lincan.h}}
       
   187 \subsubsection[bittiming\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned long \hyperlink{lincan_8h_a4668d3e5f141bf55821db4c528a9231}{bittiming\_\-t}}}
       
   188 \label{lincan_8h_a4668d3e5f141bf55821db4c528a9231}
       
   189 
       
   190 
       
   191 
       
   192 
       
   193 Definition at line 36 of file lincan.h.\hypertarget{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{
       
   194 \index{lincan.h@{lincan.h}!channel_t@{channel\_\-t}}
       
   195 \index{channel_t@{channel\_\-t}!lincan.h@{lincan.h}}
       
   196 \subsubsection[channel\_\-t]{\setlength{\rightskip}{0pt plus 5cm}typedef unsigned short \hyperlink{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}{channel\_\-t}}}
       
   197 \label{lincan_8h_e6ce5c58553fdefeba893c2263f476d3}
       
   198 
       
   199 
       
   200 
       
   201 
       
   202 Definition at line 37 of file lincan.h.