doc/doxygen/latex/can__peak__win32_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__win32_8c}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     2
\section{/home/epimerde/documents/tc11/Can\-Festival-3/drivers/can\_\-peak\_\-win32/can\_\-peak\_\-win32.c File Reference}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
     3
\label{can__peak__win32_8c}\index{/home/epimerde/documents/tc11/CanFestival-3/drivers/can_peak_win32/can_peak_win32.c@{/home/epimerde/documents/tc11/CanFestival-3/drivers/can\_\-peak\_\-win32/can\_\-peak\_\-win32.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`\"{}cancfg.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__win32_8c_6c15c0d426ae2e61f69f3119d3fe486b}{extra\_\-PCAN\_\-init\_\-params}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    15
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    16
\#define \hyperlink{can__peak__win32_8c_44ef8a15c3be0d9b410c0c21709a12c2}{CAN\_\-INIT\_\-TYPE\_\-ST\_\-RTR}~MSGTYPE\_\-STANDARD $|$ MSGTYPE\_\-RTR
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    17
\end{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    18
\subsection*{Functions}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    19
\begin{CompactItemize}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    20
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    21
int \hyperlink{can__peak__win32_8c_6820d7fa32e6e79d432c6003e4c15c32}{Translate\-Baude\-Rate} (char $\ast$optarg)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    22
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    23
void \hyperlink{can__peak__win32_8c_9f623ce2d3a68e90dfdb1ff0d54a9b57}{can\-Init} (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$board)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    24
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    25
UNS8 \hyperlink{can__peak__win32_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
    26
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    27
UNS8 \hyperlink{can__peak__win32_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
    28
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    29
\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} \hyperlink{can__peak__win32_8c_945403aba7f36acbd2e7160ade361bab}{can\-Open\_\-driver} (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$board)
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    30
\item 
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    31
int \hyperlink{can__peak__win32_8c_76e6a915d0e40a23b863198b2aaa5545}{can\-Close\_\-driver} (\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} fd0)
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__peak__win32_8c_44ef8a15c3be0d9b410c0c21709a12c2}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    37
\index{can_peak_win32.c@{can\_\-peak\_\-win32.c}!CAN_INIT_TYPE_ST_RTR@{CAN\_\-INIT\_\-TYPE\_\-ST\_\-RTR}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    38
\index{CAN_INIT_TYPE_ST_RTR@{CAN\_\-INIT\_\-TYPE\_\-ST\_\-RTR}!can_peak_win32.c@{can\_\-peak\_\-win32.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    39
\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
    40
\label{can__peak__win32_8c_44ef8a15c3be0d9b410c0c21709a12c2}
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 52 of file can\_\-peak\_\-win32.c.\hypertarget{can__peak__win32_8c_6c15c0d426ae2e61f69f3119d3fe486b}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    46
\index{can_peak_win32.c@{can\_\-peak\_\-win32.c}!extra_PCAN_init_params@{extra\_\-PCAN\_\-init\_\-params}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    47
\index{extra_PCAN_init_params@{extra\_\-PCAN\_\-init\_\-params}!can_peak_win32.c@{can\_\-peak\_\-win32.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    48
\subsubsection[extra\_\-PCAN\_\-init\_\-params]{\setlength{\rightskip}{0pt plus 5cm}\#define extra\_\-PCAN\_\-init\_\-params}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    49
\label{can__peak__win32_8c_6c15c0d426ae2e61f69f3119d3fe486b}
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
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    54
Definition at line 36 of file can\_\-peak\_\-win32.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    55
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    56
\subsection{Function Documentation}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    57
\hypertarget{can__peak__win32_8c_76e6a915d0e40a23b863198b2aaa5545}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    58
\index{can_peak_win32.c@{can\_\-peak\_\-win32.c}!canClose_driver@{canClose\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    59
\index{canClose_driver@{canClose\_\-driver}!can_peak_win32.c@{can\_\-peak\_\-win32.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    60
\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
    61
\label{can__peak__win32_8c_76e6a915d0e40a23b863198b2aaa5545}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    62
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    63
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    64
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    65
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    66
Definition at line 237 of file can\_\-peak\_\-win32.c.\hypertarget{can__peak__win32_8c_9f623ce2d3a68e90dfdb1ff0d54a9b57}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    67
\index{can_peak_win32.c@{can\_\-peak\_\-win32.c}!canInit@{canInit}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    68
\index{canInit@{canInit}!can_peak_win32.c@{can\_\-peak\_\-win32.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    69
\subsubsection[canInit]{\setlength{\rightskip}{0pt plus 5cm}void can\-Init (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$ {\em board})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    70
\label{can__peak__win32_8c_9f623ce2d3a68e90dfdb1ff0d54a9b57}
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
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    74
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    75
Definition at line 70 of file can\_\-peak\_\-win32.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    76
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    77
References struct\_\-s\_\-BOARD::baudrate, extra\_\-PCAN\_\-init\_\-params, and Translate\-Baude\-Rate().\hypertarget{can__peak__win32_8c_945403aba7f36acbd2e7160ade361bab}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    78
\index{can_peak_win32.c@{can\_\-peak\_\-win32.c}!canOpen_driver@{canOpen\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    79
\index{canOpen_driver@{canOpen\_\-driver}!can_peak_win32.c@{can\_\-peak\_\-win32.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    80
\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
    81
\label{can__peak__win32_8c_945403aba7f36acbd2e7160ade361bab}
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
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    85
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    86
Definition at line 205 of file can\_\-peak\_\-win32.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    87
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    88
References can\-Init().\hypertarget{can__peak__win32_8c_6b3248e95acf2b08d1fd8b42610cc5a6}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    89
\index{can_peak_win32.c@{can\_\-peak\_\-win32.c}!canReceive_driver@{canReceive\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    90
\index{canReceive_driver@{canReceive\_\-driver}!can_peak_win32.c@{can\_\-peak\_\-win32.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    91
\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
    92
\label{can__peak__win32_8c_6b3248e95acf2b08d1fd8b42610cc5a6}
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
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    96
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    97
Definition at line 89 of file can\_\-peak\_\-win32.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    98
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
    99
References can\-Init(), Message::cob\_\-id, Message::data, Message::len, Message::rtr, UNS8, and SHORT\_\-CAN::w.\hypertarget{can__peak__win32_8c_def95aee49efa13dd047d0b3b5507ad3}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   100
\index{can_peak_win32.c@{can\_\-peak\_\-win32.c}!canSend_driver@{canSend\_\-driver}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   101
\index{canSend_driver@{canSend\_\-driver}!can_peak_win32.c@{can\_\-peak\_\-win32.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   102
\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
   103
\label{can__peak__win32_8c_def95aee49efa13dd047d0b3b5507ad3}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   104
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   105
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   106
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   107
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   108
Definition at line 159 of file can\_\-peak\_\-win32.c.
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   109
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   110
References CAN\_\-INIT\_\-TYPE\_\-ST\_\-RTR, can\-Init(), Message::cob\_\-id, Message::data, Message::len, Message::rtr, UNS8, and SHORT\_\-CAN::w.\hypertarget{can__peak__win32_8c_6820d7fa32e6e79d432c6003e4c15c32}{
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   111
\index{can_peak_win32.c@{can\_\-peak\_\-win32.c}!TranslateBaudeRate@{TranslateBaudeRate}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   112
\index{TranslateBaudeRate@{TranslateBaudeRate}!can_peak_win32.c@{can\_\-peak\_\-win32.c}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   113
\subsubsection[TranslateBaudeRate]{\setlength{\rightskip}{0pt plus 5cm}int Translate\-Baude\-Rate (char $\ast$ {\em optarg})}}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   114
\label{can__peak__win32_8c_6820d7fa32e6e79d432c6003e4c15c32}
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   115
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   116
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   117
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   118
b6572d0336c3 First doxygen implementation
nico
parents:
diff changeset
   119
Definition at line 55 of file can\_\-peak\_\-win32.c.