doc/doxygen/latex/can__virtual_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__virtual_8c}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/drivers/can\_\-virtual/can\_\-virtual.c File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{can__virtual_8c}\index{/home/epimerde/documents/tc11/CanFestival-3/drivers/can_virtual/can_virtual.c@{/home/epimerde/documents/tc11/CanFestival-3/drivers/can\_\-virtual/can\_\-virtual.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 $<$unistd.h$>$}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
{\tt \#include \char`\"{}can\_\-driver.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
{\tt \#include \char`\"{}def.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
\subsection*{Data Structures}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
struct \hyperlink{structCANPipe}{CANPipe}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
\subsection*{Defines}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\#define \hyperlink{can__virtual_8c_b2f51095e950bbeab1ea15fac21e6146}{MAX\_\-NB\_\-CAN\_\-PIPES}~16
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
\#define \hyperlink{can__virtual_8c_124cab530f97a752eb2e110c1b398c11}{My\-Case}(fc)~case fc: printf(\#fc);break;
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
UNS8 \hyperlink{can__virtual_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
    25
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
void \hyperlink{can__virtual_8c_6baa544d467cbabaf4bacadc74cc6523}{print\_\-message} (\hyperlink{structMessage}{Message} $\ast$m)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
UNS8 \hyperlink{can__virtual_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
    29
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} \hyperlink{can__virtual_8c_945403aba7f36acbd2e7160ade361bab}{can\-Open\_\-driver} (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$board)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
int \hyperlink{can__virtual_8c_76e6a915d0e40a23b863198b2aaa5545}{can\-Close\_\-driver} (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} fd0)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
\subsection*{Variables}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
\hyperlink{structCANPipe}{CANPipe} \hyperlink{can__virtual_8c_53fd0e34e8d4d31bf381700a9d8ae72b}{canpipes} \mbox{[}MAX\_\-NB\_\-CAN\_\-PIPES\mbox{]} = \{\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
\end{CompactItemize}
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
\subsection{Define Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
\hypertarget{can__virtual_8c_b2f51095e950bbeab1ea15fac21e6146}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
\index{can_virtual.c@{can\_\-virtual.c}!MAX_NB_CAN_PIPES@{MAX\_\-NB\_\-CAN\_\-PIPES}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
\index{MAX_NB_CAN_PIPES@{MAX\_\-NB\_\-CAN\_\-PIPES}!can_virtual.c@{can\_\-virtual.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
\subsubsection[MAX\_\-NB\_\-CAN\_\-PIPES]{\setlength{\rightskip}{0pt plus 5cm}\#define MAX\_\-NB\_\-CAN\_\-PIPES~16}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
\label{can__virtual_8c_b2f51095e950bbeab1ea15fac21e6146}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
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
Definition at line 33 of file can\_\-virtual.c.\hypertarget{can__virtual_8c_124cab530f97a752eb2e110c1b398c11}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
\index{can_virtual.c@{can\_\-virtual.c}!MyCase@{MyCase}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
\index{MyCase@{MyCase}!can_virtual.c@{can\_\-virtual.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
\subsubsection[MyCase]{\setlength{\rightskip}{0pt plus 5cm}\#define My\-Case(fc)~case fc: printf(\#fc);break;}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
\label{can__virtual_8c_124cab530f97a752eb2e110c1b398c11}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
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
Definition at line 52 of file can\_\-virtual.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
\hypertarget{can__virtual_8c_76e6a915d0e40a23b863198b2aaa5545}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
\index{can_virtual.c@{can\_\-virtual.c}!canClose_driver@{canClose\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
\index{canClose_driver@{canClose\_\-driver}!can_virtual.c@{can\_\-virtual.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
\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
    67
\label{can__virtual_8c_76e6a915d0e40a23b863198b2aaa5545}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
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
Definition at line 142 of file can\_\-virtual.c.\hypertarget{can__virtual_8c_945403aba7f36acbd2e7160ade361bab}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
\index{can_virtual.c@{can\_\-virtual.c}!canOpen_driver@{canOpen\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
\index{canOpen_driver@{canOpen\_\-driver}!can_virtual.c@{can\_\-virtual.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
\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
    76
\label{can__virtual_8c_945403aba7f36acbd2e7160ade361bab}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    81
Definition at line 121 of file can\_\-virtual.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
References canpipes, MAX\_\-NB\_\-CAN\_\-PIPES, and CANPipe::used.\hypertarget{can__virtual_8c_6b3248e95acf2b08d1fd8b42610cc5a6}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
\index{can_virtual.c@{can\_\-virtual.c}!canReceive_driver@{canReceive\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
\index{canReceive_driver@{canReceive\_\-driver}!can_virtual.c@{can\_\-virtual.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
\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
    87
\label{can__virtual_8c_6b3248e95acf2b08d1fd8b42610cc5a6}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    92
Definition at line 43 of file can\_\-virtual.c.\hypertarget{can__virtual_8c_def95aee49efa13dd047d0b3b5507ad3}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
\index{can_virtual.c@{can\_\-virtual.c}!canSend_driver@{canSend\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
\index{canSend_driver@{canSend\_\-driver}!can_virtual.c@{can\_\-virtual.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    95
\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
    96
\label{can__virtual_8c_def95aee49efa13dd047d0b3b5507ad3}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    98
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    99
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   100
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   101
Definition at line 81 of file can\_\-virtual.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   102
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   103
References canpipes, MAX\_\-NB\_\-CAN\_\-PIPES, and print\_\-message().\hypertarget{can__virtual_8c_6baa544d467cbabaf4bacadc74cc6523}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   104
\index{can_virtual.c@{can\_\-virtual.c}!print_message@{print\_\-message}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   105
\index{print_message@{print\_\-message}!can_virtual.c@{can\_\-virtual.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   106
\subsubsection[print\_\-message]{\setlength{\rightskip}{0pt plus 5cm}void print\_\-message (\hyperlink{structMessage}{Message} $\ast$ {\em m})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   107
\label{can__virtual_8c_6baa544d467cbabaf4bacadc74cc6523}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   108
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   109
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   110
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   111
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   112
Definition at line 53 of file can\_\-virtual.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   113
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   114
References Message::cob\_\-id, Message::data, Message::len, My\-Case, NMT, NODE\_\-GUARD, PDO1rx, PDO1tx, PDO2rx, PDO2tx, PDO3rx, PDO3tx, PDO4rx, PDO4tx, Message::rtr, SDOrx, SDOtx, SYNC, TIME\_\-STAMP, and SHORT\_\-CAN::w.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   115
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   116
\subsection{Variable Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   117
\hypertarget{can__virtual_8c_53fd0e34e8d4d31bf381700a9d8ae72b}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   118
\index{can_virtual.c@{can\_\-virtual.c}!canpipes@{canpipes}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   119
\index{canpipes@{canpipes}!can_virtual.c@{can\_\-virtual.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   120
\subsubsection[canpipes]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{structCANPipe}{CANPipe} \hyperlink{can__virtual_8c_53fd0e34e8d4d31bf381700a9d8ae72b}{canpipes}\mbox{[}MAX\_\-NB\_\-CAN\_\-PIPES\mbox{]} = \{\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\}}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   121
\label{can__virtual_8c_53fd0e34e8d4d31bf381700a9d8ae72b}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   122
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   123
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   124
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   125
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   126
Definition at line 40 of file can\_\-virtual.c.