doc/doxygen/latex/can__driver_8h.tex

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