doc/doxygen/latex/can__peak__linux_8c.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
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\hypertarget{can__peak__linux_8c}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/drivers/can\_\-peak\_\-linux/can\_\-peak\_\-linux.c File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{can__peak__linux_8c}\index{/home/epimerde/documents/tc11/CanFestival-3/drivers/can_peak_linux/can_peak_linux.c@{/home/epimerde/documents/tc11/CanFestival-3/drivers/can\_\-peak\_\-linux/can\_\-peak\_\-linux.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include $<$stdio.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
{\tt \#include $<$string.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
{\tt \#include $<$errno.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
{\tt \#include $<$fcntl.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
{\tt \#include \char`\"{}libpcan.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
{\tt \#include \char`\"{}can\_\-driver.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\subsection*{Defines}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
\#define \hyperlink{can__peak__linux_8c_44ef8a15c3be0d9b410c0c21709a12c2}{CAN\_\-INIT\_\-TYPE\_\-ST\_\-RTR}~MSGTYPE\_\-STANDARD $|$ MSGTYPE\_\-RTR
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
UNS8 \hyperlink{can__peak__linux_8c_6b3248e95acf2b08d1fd8b42610cc5a6}{can\-Receive\_\-driver} (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} fd0, \hyperlink{structMessage}{Message} $\ast$m)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
UNS8 \hyperlink{can__peak__linux_8c_def95aee49efa13dd047d0b3b5507ad3}{can\-Send\_\-driver} (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} fd0, \hyperlink{structMessage}{Message} $\ast$m)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
int \hyperlink{can__peak__linux_8c_6820d7fa32e6e79d432c6003e4c15c32}{Translate\-Baude\-Rate} (char $\ast$optarg)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} \hyperlink{can__peak__linux_8c_945403aba7f36acbd2e7160ade361bab}{can\-Open\_\-driver} (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$board)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
int \hyperlink{can__peak__linux_8c_76e6a915d0e40a23b863198b2aaa5545}{can\-Close\_\-driver} (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} fd0)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\subsection{Define Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
\hypertarget{can__peak__linux_8c_44ef8a15c3be0d9b410c0c21709a12c2}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
\index{can_peak_linux.c@{can\_\-peak\_\-linux.c}!CAN_INIT_TYPE_ST_RTR@{CAN\_\-INIT\_\-TYPE\_\-ST\_\-RTR}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
\index{CAN_INIT_TYPE_ST_RTR@{CAN\_\-INIT\_\-TYPE\_\-ST\_\-RTR}!can_peak_linux.c@{can\_\-peak\_\-linux.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
\subsubsection[CAN\_\-INIT\_\-TYPE\_\-ST\_\-RTR]{\setlength{\rightskip}{0pt plus 5cm}\#define CAN\_\-INIT\_\-TYPE\_\-ST\_\-RTR~MSGTYPE\_\-STANDARD $|$ MSGTYPE\_\-RTR}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
\label{can__peak__linux_8c_44ef8a15c3be0d9b410c0c21709a12c2}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
Definition at line 37 of file can\_\-peak\_\-linux.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\hypertarget{can__peak__linux_8c_76e6a915d0e40a23b863198b2aaa5545}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
\index{can_peak_linux.c@{can\_\-peak\_\-linux.c}!canClose_driver@{canClose\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
\index{canClose_driver@{canClose\_\-driver}!can_peak_linux.c@{can\_\-peak\_\-linux.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
\subsubsection[canClose\_\-driver]{\setlength{\rightskip}{0pt plus 5cm}int can\-Close\_\-driver (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} {\em fd0})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
\label{can__peak__linux_8c_76e6a915d0e40a23b863198b2aaa5545}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
Definition at line 129 of file can\_\-peak\_\-linux.c.\hypertarget{can__peak__linux_8c_945403aba7f36acbd2e7160ade361bab}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
\index{can_peak_linux.c@{can\_\-peak\_\-linux.c}!canOpen_driver@{canOpen\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
\index{canOpen_driver@{canOpen\_\-driver}!can_peak_linux.c@{can\_\-peak\_\-linux.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
\subsubsection[canOpen\_\-driver]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} can\-Open\_\-driver (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$ {\em board})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
\label{can__peak__linux_8c_945403aba7f36acbd2e7160ade361bab}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
Definition at line 104 of file can\_\-peak\_\-linux.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
References struct\_\-s\_\-BOARD::baudrate, struct\_\-s\_\-BOARD::busname, and Translate\-Baude\-Rate().\hypertarget{can__peak__linux_8c_6b3248e95acf2b08d1fd8b42610cc5a6}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
\index{can_peak_linux.c@{can\_\-peak\_\-linux.c}!canReceive_driver@{canReceive\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
\index{canReceive_driver@{canReceive\_\-driver}!can_peak_linux.c@{can\_\-peak\_\-linux.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
\subsubsection[canReceive\_\-driver]{\setlength{\rightskip}{0pt plus 5cm}UNS8 can\-Receive\_\-driver (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} {\em fd0}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
\label{can__peak__linux_8c_6b3248e95acf2b08d1fd8b42610cc5a6}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
Definition at line 40 of file can\_\-peak\_\-linux.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
References Message::cob\_\-id, Message::data, Message::len, Message::rtr, UNS8, and SHORT\_\-CAN::w.\hypertarget{can__peak__linux_8c_def95aee49efa13dd047d0b3b5507ad3}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
\index{can_peak_linux.c@{can\_\-peak\_\-linux.c}!canSend_driver@{canSend\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
\index{canSend_driver@{canSend\_\-driver}!can_peak_linux.c@{can\_\-peak\_\-linux.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
\subsubsection[canSend\_\-driver]{\setlength{\rightskip}{0pt plus 5cm}UNS8 can\-Send\_\-driver (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} {\em fd0}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
\label{can__peak__linux_8c_def95aee49efa13dd047d0b3b5507ad3}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
Definition at line 64 of file can\_\-peak\_\-linux.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
References CAN\_\-INIT\_\-TYPE\_\-ST\_\-RTR, Message::data, Message::len, Message::rtr, and UNS8.\hypertarget{can__peak__linux_8c_6820d7fa32e6e79d432c6003e4c15c32}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
\index{can_peak_linux.c@{can\_\-peak\_\-linux.c}!TranslateBaudeRate@{TranslateBaudeRate}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
\index{TranslateBaudeRate@{TranslateBaudeRate}!can_peak_linux.c@{can\_\-peak\_\-linux.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
\subsubsection[TranslateBaudeRate]{\setlength{\rightskip}{0pt plus 5cm}int Translate\-Baude\-Rate (char $\ast$ {\em optarg})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
\label{can__peak__linux_8c_6820d7fa32e6e79d432c6003e4c15c32}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    92
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
Definition at line 89 of file can\_\-peak\_\-linux.c.