doc/doxygen/latex/drivers__win32_8cpp.tex
changeset 207 b6572d0336c3
equal deleted inserted replaced
206:6787754b251b 207:b6572d0336c3
       
     1 \hypertarget{drivers__win32_8cpp}{
       
     2 \section{/home/epimerde/documents/tc11/Can\-Festival-3/drivers/win32/drivers\_\-win32.cpp File Reference}
       
     3 \label{drivers__win32_8cpp}\index{/home/epimerde/documents/tc11/CanFestival-3/drivers/win32/drivers_win32.cpp@{/home/epimerde/documents/tc11/CanFestival-3/drivers/win32/drivers\_\-win32.cpp}}
       
     4 }
       
     5 {\tt \#include $<$windows.h$>$}\par
       
     6 {\tt \#include \char`\"{}canfestival.h\char`\"{}}\par
       
     7 {\tt \#include \char`\"{}timer.h\char`\"{}}\par
       
     8 {\tt \#include \char`\"{}timers\_\-driver.h\char`\"{}}\par
       
     9 \subsection*{Data Structures}
       
    10 \begin{CompactItemize}
       
    11 \item 
       
    12 class \hyperlink{classdriver__procs}{driver\_\-procs}
       
    13 \item 
       
    14 struct \hyperlink{structdriver__data}{driver\_\-data}
       
    15 \end{CompactItemize}
       
    16 \subsection*{Defines}
       
    17 \begin{CompactItemize}
       
    18 \item 
       
    19 \#define \hyperlink{drivers__win32_8cpp_74c6a27b44fd54de5cb021299ffce612}{DLL\_\-CALL}(funcname)~($\ast$\_\-\#\#funcname)
       
    20 \item 
       
    21 \#define \hyperlink{drivers__win32_8cpp_7f7ce94bf48fde67f4af7b64c7ca4c85}{FCT\_\-PTR\_\-INIT}~=NULL
       
    22 \item 
       
    23 \#define \hyperlink{drivers__win32_8cpp_fa9a7a4802f45e593e1a49e764b12849}{my\-TEXT}(str)~str
       
    24 \end{CompactItemize}
       
    25 \subsection*{Typedefs}
       
    26 \begin{CompactItemize}
       
    27 \item 
       
    28 typedef UNS8($\ast$) \hyperlink{drivers__win32_8cpp_f0240c9d4c35205726e5ae81888327dd}{CANRECEIVE\_\-DRIVER\_\-PROC} (void $\ast$inst, \hyperlink{structMessage}{Message} $\ast$m)
       
    29 \item 
       
    30 typedef UNS8($\ast$) \hyperlink{drivers__win32_8cpp_90aa70ea2296b46e3fa52ff5e4bbc399}{CANSEND\_\-DRIVER\_\-PROC} (void $\ast$inst, const \hyperlink{structMessage}{Message} $\ast$m)
       
    31 \item 
       
    32 typedef void $\ast$($\ast$) \hyperlink{drivers__win32_8cpp_5db8713e505308b09dbe85ecbe707607}{CANOPEN\_\-DRIVER\_\-PROC} (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$board)
       
    33 \item 
       
    34 typedef int($\ast$) \hyperlink{drivers__win32_8cpp_5613306de0117eb5242ea9934348eb9f}{CANCLOSE\_\-DRIVER\_\-PROC} (void $\ast$inst)
       
    35 \end{CompactItemize}
       
    36 \subsection*{Functions}
       
    37 \begin{CompactItemize}
       
    38 \item 
       
    39 \hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE} \hyperlink{drivers__win32_8cpp_a6eed61fc15f41f772d4645d7a5edeb5}{Load\-Can\-Driver} (char $\ast$driver\_\-name)
       
    40 \item 
       
    41 UNS8 \hyperlink{drivers__win32_8cpp_c608a4ba478a809fd963a342a24226fd}{can\-Receive} (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} fd0, \hyperlink{structMessage}{Message} $\ast$m)
       
    42 \item 
       
    43 void $\ast$ \hyperlink{drivers__win32_8cpp_469503c5171a0cdd8369c1ec39d97d2c}{can\-Receive\-Loop} (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} fd0)
       
    44 \item 
       
    45 UNS8 \hyperlink{drivers__win32_8cpp_01559baf432253d46f1142231a968247}{can\-Send} (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} fd0, \hyperlink{structMessage}{Message} $\ast$m)
       
    46 \item 
       
    47 \hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} \hyperlink{drivers__win32_8cpp_d82cede875fd89036cdeda13e293dafe}{can\-Open} (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$board, \hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
       
    48 \item 
       
    49 int \hyperlink{drivers__win32_8cpp_02957f72a9b951603adb98a142bd447b}{can\-Close} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
       
    50 \end{CompactItemize}
       
    51 \subsection*{Variables}
       
    52 \begin{CompactItemize}
       
    53 \item 
       
    54 \hyperlink{classdriver__procs}{driver\_\-procs} \hyperlink{drivers__win32_8cpp_410d0af15c08b84bce57bd000f9f8034}{s\_\-driver\_\-procs}
       
    55 \end{CompactItemize}
       
    56 
       
    57 
       
    58 \subsection{Define Documentation}
       
    59 \hypertarget{drivers__win32_8cpp_74c6a27b44fd54de5cb021299ffce612}{
       
    60 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!DLL_CALL@{DLL\_\-CALL}}
       
    61 \index{DLL_CALL@{DLL\_\-CALL}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
    62 \subsubsection[DLL\_\-CALL]{\setlength{\rightskip}{0pt plus 5cm}\#define DLL\_\-CALL(funcname)~($\ast$\_\-\#\#funcname)}}
       
    63 \label{drivers__win32_8cpp_74c6a27b44fd54de5cb021299ffce612}
       
    64 
       
    65 
       
    66 
       
    67 
       
    68 Definition at line 32 of file drivers\_\-win32.cpp.\hypertarget{drivers__win32_8cpp_7f7ce94bf48fde67f4af7b64c7ca4c85}{
       
    69 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!FCT_PTR_INIT@{FCT\_\-PTR\_\-INIT}}
       
    70 \index{FCT_PTR_INIT@{FCT\_\-PTR\_\-INIT}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
    71 \subsubsection[FCT\_\-PTR\_\-INIT]{\setlength{\rightskip}{0pt plus 5cm}\#define FCT\_\-PTR\_\-INIT~=NULL}}
       
    72 \label{drivers__win32_8cpp_7f7ce94bf48fde67f4af7b64c7ca4c85}
       
    73 
       
    74 
       
    75 
       
    76 
       
    77 Definition at line 33 of file drivers\_\-win32.cpp.\hypertarget{drivers__win32_8cpp_fa9a7a4802f45e593e1a49e764b12849}{
       
    78 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!myTEXT@{myTEXT}}
       
    79 \index{myTEXT@{myTEXT}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
    80 \subsubsection[myTEXT]{\setlength{\rightskip}{0pt plus 5cm}\#define my\-TEXT(str)~str}}
       
    81 \label{drivers__win32_8cpp_fa9a7a4802f45e593e1a49e764b12849}
       
    82 
       
    83 
       
    84 
       
    85 
       
    86 Definition at line 91 of file drivers\_\-win32.cpp.
       
    87 
       
    88 \subsection{Typedef Documentation}
       
    89 \hypertarget{drivers__win32_8cpp_5613306de0117eb5242ea9934348eb9f}{
       
    90 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!CANCLOSE_DRIVER_PROC@{CANCLOSE\_\-DRIVER\_\-PROC}}
       
    91 \index{CANCLOSE_DRIVER_PROC@{CANCLOSE\_\-DRIVER\_\-PROC}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
    92 \subsubsection[CANCLOSE\_\-DRIVER\_\-PROC]{\setlength{\rightskip}{0pt plus 5cm}typedef int($\ast$) \hyperlink{drivers__win32_8cpp_5613306de0117eb5242ea9934348eb9f}{CANCLOSE\_\-DRIVER\_\-PROC}(void $\ast$inst)}}
       
    93 \label{drivers__win32_8cpp_5613306de0117eb5242ea9934348eb9f}
       
    94 
       
    95 
       
    96 
       
    97 
       
    98 Definition at line 43 of file drivers\_\-win32.cpp.\hypertarget{drivers__win32_8cpp_5db8713e505308b09dbe85ecbe707607}{
       
    99 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!CANOPEN_DRIVER_PROC@{CANOPEN\_\-DRIVER\_\-PROC}}
       
   100 \index{CANOPEN_DRIVER_PROC@{CANOPEN\_\-DRIVER\_\-PROC}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
   101 \subsubsection[CANOPEN\_\-DRIVER\_\-PROC]{\setlength{\rightskip}{0pt plus 5cm}typedef void$\ast$($\ast$) \hyperlink{drivers__win32_8cpp_5db8713e505308b09dbe85ecbe707607}{CANOPEN\_\-DRIVER\_\-PROC}(\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$board)}}
       
   102 \label{drivers__win32_8cpp_5db8713e505308b09dbe85ecbe707607}
       
   103 
       
   104 
       
   105 
       
   106 
       
   107 Definition at line 42 of file drivers\_\-win32.cpp.\hypertarget{drivers__win32_8cpp_f0240c9d4c35205726e5ae81888327dd}{
       
   108 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!CANRECEIVE_DRIVER_PROC@{CANRECEIVE\_\-DRIVER\_\-PROC}}
       
   109 \index{CANRECEIVE_DRIVER_PROC@{CANRECEIVE\_\-DRIVER\_\-PROC}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
   110 \subsubsection[CANRECEIVE\_\-DRIVER\_\-PROC]{\setlength{\rightskip}{0pt plus 5cm}typedef UNS8($\ast$) \hyperlink{drivers__win32_8cpp_f0240c9d4c35205726e5ae81888327dd}{CANRECEIVE\_\-DRIVER\_\-PROC}(void $\ast$inst, \hyperlink{structMessage}{Message} $\ast$m)}}
       
   111 \label{drivers__win32_8cpp_f0240c9d4c35205726e5ae81888327dd}
       
   112 
       
   113 
       
   114 
       
   115 
       
   116 Definition at line 40 of file drivers\_\-win32.cpp.\hypertarget{drivers__win32_8cpp_90aa70ea2296b46e3fa52ff5e4bbc399}{
       
   117 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!CANSEND_DRIVER_PROC@{CANSEND\_\-DRIVER\_\-PROC}}
       
   118 \index{CANSEND_DRIVER_PROC@{CANSEND\_\-DRIVER\_\-PROC}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
   119 \subsubsection[CANSEND\_\-DRIVER\_\-PROC]{\setlength{\rightskip}{0pt plus 5cm}typedef UNS8($\ast$) \hyperlink{drivers__win32_8cpp_90aa70ea2296b46e3fa52ff5e4bbc399}{CANSEND\_\-DRIVER\_\-PROC}(void $\ast$inst, const \hyperlink{structMessage}{Message} $\ast$m)}}
       
   120 \label{drivers__win32_8cpp_90aa70ea2296b46e3fa52ff5e4bbc399}
       
   121 
       
   122 
       
   123 
       
   124 
       
   125 Definition at line 41 of file drivers\_\-win32.cpp.
       
   126 
       
   127 \subsection{Function Documentation}
       
   128 \hypertarget{drivers__win32_8cpp_02957f72a9b951603adb98a142bd447b}{
       
   129 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!canClose@{canClose}}
       
   130 \index{canClose@{canClose}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
   131 \subsubsection[canClose]{\setlength{\rightskip}{0pt plus 5cm}int can\-Close (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
       
   132 \label{drivers__win32_8cpp_02957f72a9b951603adb98a142bd447b}
       
   133 
       
   134 
       
   135 
       
   136 
       
   137 Definition at line 194 of file drivers\_\-win32.cpp.
       
   138 
       
   139 References can\-Close(), struct\_\-CO\_\-Data::can\-Handle, driver\_\-data::continue\_\-receive\_\-thread, DLL\_\-CALL, Enter\-Mutex(), CANPort::fd, driver\_\-data::inst, Leave\-Mutex(), driver\_\-procs::m\_\-can\-Close, driver\_\-data::receive\_\-thread, CANPort::receive\-Task, s\_\-driver\_\-procs, and Wait\-Receive\-Task\-End().\hypertarget{drivers__win32_8cpp_d82cede875fd89036cdeda13e293dafe}{
       
   140 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!canOpen@{canOpen}}
       
   141 \index{canOpen@{canOpen}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
   142 \subsubsection[canOpen]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{win32_2applicfg_8h_712c7b28987b12b8d400df19c92d0f5e}{CAN\_\-HANDLE} can\-Open (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$ {\em board}, \hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
       
   143 \label{drivers__win32_8cpp_d82cede875fd89036cdeda13e293dafe}
       
   144 
       
   145 
       
   146 
       
   147 
       
   148 Definition at line 172 of file drivers\_\-win32.cpp.
       
   149 
       
   150 References struct\_\-s\_\-BOARD::baudrate, struct\_\-s\_\-BOARD::busname, struct\_\-CO\_\-Data::can\-Handle, can\-Open(), canports, can\-Receive\-Loop(), driver\_\-data::continue\_\-receive\_\-thread, Create\-Receive\-Task(), CANPort::d, driver\_\-data::d, DLL\_\-CALL, Enter\-Mutex(), CANPort::fd, driver\_\-data::inst, Leave\-Mutex(), driver\_\-procs::m\_\-can\-Open, MAX\_\-NB\_\-CAN\_\-PORTS, driver\_\-data::receive\_\-thread, s\_\-driver\_\-procs, and CANPort::used.\hypertarget{drivers__win32_8cpp_c608a4ba478a809fd963a342a24226fd}{
       
   151 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!canReceive@{canReceive}}
       
   152 \index{canReceive@{canReceive}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
   153 \subsubsection[canReceive]{\setlength{\rightskip}{0pt plus 5cm}UNS8 can\-Receive (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} {\em fd0}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
       
   154 \label{drivers__win32_8cpp_c608a4ba478a809fd963a342a24226fd}
       
   155 
       
   156 
       
   157 
       
   158 
       
   159 Definition at line 124 of file drivers\_\-win32.cpp.
       
   160 
       
   161 References driver\_\-data::inst, driver\_\-procs::m\_\-can\-Receive, and s\_\-driver\_\-procs.\hypertarget{drivers__win32_8cpp_469503c5171a0cdd8369c1ec39d97d2c}{
       
   162 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!canReceiveLoop@{canReceiveLoop}}
       
   163 \index{canReceiveLoop@{canReceiveLoop}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
   164 \subsubsection[canReceiveLoop]{\setlength{\rightskip}{0pt plus 5cm}void$\ast$ can\-Receive\-Loop (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} {\em fd0})}}
       
   165 \label{drivers__win32_8cpp_469503c5171a0cdd8369c1ec39d97d2c}
       
   166 
       
   167 
       
   168 
       
   169 
       
   170 Definition at line 134 of file drivers\_\-win32.cpp.
       
   171 
       
   172 References can\-Dispatch(), can\-Receive(), driver\_\-data::continue\_\-receive\_\-thread, driver\_\-data::d, Enter\-Mutex(), and Leave\-Mutex().\hypertarget{drivers__win32_8cpp_01559baf432253d46f1142231a968247}{
       
   173 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!canSend@{canSend}}
       
   174 \index{canSend@{canSend}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
   175 \subsubsection[canSend]{\setlength{\rightskip}{0pt plus 5cm}UNS8 can\-Send (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} {\em fd0}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
       
   176 \label{drivers__win32_8cpp_01559baf432253d46f1142231a968247}
       
   177 
       
   178 
       
   179 
       
   180 
       
   181 Definition at line 156 of file drivers\_\-win32.cpp.
       
   182 
       
   183 References can\-Send(), DLL\_\-CALL, Enter\-Mutex(), driver\_\-data::inst, Leave\-Mutex(), driver\_\-procs::m\_\-can\-Send, s\_\-driver\_\-procs, and UNS8.\hypertarget{drivers__win32_8cpp_a6eed61fc15f41f772d4645d7a5edeb5}{
       
   184 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!LoadCanDriver@{LoadCanDriver}}
       
   185 \index{LoadCanDriver@{LoadCanDriver}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
   186 \subsubsection[LoadCanDriver]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE} Load\-Can\-Driver (char $\ast$ {\em driver\_\-name})}}
       
   187 \label{drivers__win32_8cpp_a6eed61fc15f41f772d4645d7a5edeb5}
       
   188 
       
   189 
       
   190 
       
   191 
       
   192 Definition at line 119 of file drivers\_\-win32.cpp.
       
   193 
       
   194 References can\-Close(), can\-Open(), can\-Receive(), can\-Send(), DLSYM, driver\_\-procs::load\_\-canfestival\_\-driver(), and s\_\-driver\_\-procs.
       
   195 
       
   196 \subsection{Variable Documentation}
       
   197 \hypertarget{drivers__win32_8cpp_410d0af15c08b84bce57bd000f9f8034}{
       
   198 \index{drivers_win32.cpp@{drivers\_\-win32.cpp}!s_driver_procs@{s\_\-driver\_\-procs}}
       
   199 \index{s_driver_procs@{s\_\-driver\_\-procs}!drivers_win32.cpp@{drivers\_\-win32.cpp}}
       
   200 \subsubsection[s\_\-driver\_\-procs]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{classdriver__procs}{driver\_\-procs} \hyperlink{drivers__win32_8cpp_410d0af15c08b84bce57bd000f9f8034}{s\_\-driver\_\-procs}}}
       
   201 \label{drivers__win32_8cpp_410d0af15c08b84bce57bd000f9f8034}
       
   202 
       
   203 
       
   204 
       
   205 
       
   206 Definition at line 117 of file drivers\_\-win32.cpp.