doc/doxygen/latex/can__driver_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
207
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     1
\hypertarget{can__driver_8h}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/include/can\_\-driver.h File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{can__driver_8h}\index{/home/epimerde/documents/tc11/CanFestival-3/include/can_driver.h@{/home/epimerde/documents/tc11/CanFestival-3/include/can\_\-driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     4
}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     5
{\tt \#include \char`\"{}applicfg.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     6
{\tt \#include \char`\"{}can.h\char`\"{}}\par
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     7
\subsection*{Data Structures}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     8
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     9
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    10
struct \hyperlink{structstruct__s__BOARD}{struct\_\-s\_\-BOARD}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    11
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    12
\subsection*{Defines}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    13
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    14
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\#define \hyperlink{can__driver_8h_74c6a27b44fd54de5cb021299ffce612}{DLL\_\-CALL}(funcname)~funcname\#\#\_\-driver
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\subsection*{Typedefs}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
typedef \hyperlink{structstruct__s__BOARD}{struct\_\-s\_\-BOARD} \hyperlink{can__driver_8h_8791342659a586c5fa66d00ca4e4d583}{s\_\-BOARD}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
UNS8 DLL\_\-CALL() \hyperlink{can__driver_8h_54d882f7937b7be0a5558f9d372cb0f7}{can\-Receive} (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE}, \hyperlink{structMessage}{Message} $\ast$) FCT\_\-PTR\_\-INIT
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    26
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
UNS8 DLL\_\-CALL() \hyperlink{can__driver_8h_821c783be9b81479e3d8392cfb8952f4}{can\-Send} (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE}, \hyperlink{structMessage}{Message} $\ast$) FCT\_\-PTR\_\-INIT
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    28
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} DLL\_\-CALL() \hyperlink{can__driver_8h_641404106e253941c94c97e67a8ce524}{can\-Open} (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$) FCT\_\-PTR\_\-INIT
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
int DLL\_\-CALL() \hyperlink{can__driver_8h_daaecb39bb3a67bb15580a112990b506}{can\-Close} (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE}) FCT\_\-PTR\_\-INIT
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    32
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    33
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    34
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    35
\subsection{Define Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    36
\hypertarget{can__driver_8h_74c6a27b44fd54de5cb021299ffce612}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
\index{can_driver.h@{can\_\-driver.h}!DLL_CALL@{DLL\_\-CALL}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
\index{DLL_CALL@{DLL\_\-CALL}!can_driver.h@{can\_\-driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
\subsubsection[DLL\_\-CALL]{\setlength{\rightskip}{0pt plus 5cm}\#define DLL\_\-CALL(funcname)~funcname\#\#\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    40
\label{can__driver_8h_74c6a27b44fd54de5cb021299ffce612}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    41
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    42
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    43
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    44
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    45
Definition at line 39 of file can\_\-driver.h.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
\subsection{Typedef Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
\hypertarget{can__driver_8h_8791342659a586c5fa66d00ca4e4d583}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
\index{can_driver.h@{can\_\-driver.h}!s_BOARD@{s\_\-BOARD}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    50
\index{s_BOARD@{s\_\-BOARD}!can_driver.h@{can\_\-driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    51
\subsubsection[s\_\-BOARD]{\setlength{\rightskip}{0pt plus 5cm}typedef struct \hyperlink{structstruct__s__BOARD}{struct\_\-s\_\-BOARD} \hyperlink{structstruct__s__BOARD}{s\_\-BOARD}}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    52
\label{can__driver_8h_8791342659a586c5fa66d00ca4e4d583}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    53
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
Definition at line 28 of file can\_\-driver.h.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
\hypertarget{can__driver_8h_daaecb39bb3a67bb15580a112990b506}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    61
\index{can_driver.h@{can\_\-driver.h}!canClose@{canClose}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
\index{canClose@{canClose}!can_driver.h@{can\_\-driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
\subsubsection[canClose]{\setlength{\rightskip}{0pt plus 5cm}int DLL\_\-CALL() can\-Close (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
\label{can__driver_8h_daaecb39bb3a67bb15580a112990b506}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
\hypertarget{can__driver_8h_641404106e253941c94c97e67a8ce524}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
\index{can_driver.h@{can\_\-driver.h}!canOpen@{canOpen}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
\index{canOpen@{canOpen}!can_driver.h@{can\_\-driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
\subsubsection[canOpen]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} DLL\_\-CALL() can\-Open (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    71
\label{can__driver_8h_641404106e253941c94c97e67a8ce524}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    72
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    73
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
\hypertarget{can__driver_8h_54d882f7937b7be0a5558f9d372cb0f7}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
\index{can_driver.h@{can\_\-driver.h}!canReceive@{canReceive}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
\index{canReceive@{canReceive}!can_driver.h@{can\_\-driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
\subsubsection[canReceive]{\setlength{\rightskip}{0pt plus 5cm}UNS8 DLL\_\-CALL() can\-Receive (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE}, \hyperlink{structMessage}{Message} $\ast$)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
\label{can__driver_8h_54d882f7937b7be0a5558f9d372cb0f7}
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
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    82
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    83
Definition at line 124 of file drivers\_\-win32.cpp.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    84
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
References driver\_\-data::inst, driver\_\-procs::m\_\-can\-Receive, and s\_\-driver\_\-procs.\hypertarget{can__driver_8h_821c783be9b81479e3d8392cfb8952f4}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
\index{can_driver.h@{can\_\-driver.h}!canSend@{canSend}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
\index{canSend@{canSend}!can_driver.h@{can\_\-driver.h}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
\subsubsection[canSend]{\setlength{\rightskip}{0pt plus 5cm}UNS8 DLL\_\-CALL() can\-Send (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE}, \hyperlink{structMessage}{Message} $\ast$)}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
\label{can__driver_8h_821c783be9b81479e3d8392cfb8952f4}
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
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    93
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    94
Definition at line 120 of file unix.c.