]> rtime.felk.cvut.cz Git - CanFestival-3.git/blob - doc/doxygen/latex/unix_8c.tex
First doxygen implementation
[CanFestival-3.git] / doc / doxygen / latex / unix_8c.tex
1 \hypertarget{unix_8c}{
2 \section{/home/epimerde/documents/tc11/Can\-Festival-3/drivers/unix/unix.c File Reference}
3 \label{unix_8c}\index{/home/epimerde/documents/tc11/CanFestival-3/drivers/unix/unix.c@{/home/epimerde/documents/tc11/CanFestival-3/drivers/unix/unix.c}}
4 }
5 {\tt \#include $<$unistd.h$>$}\par
6 {\tt \#include $<$stdio.h$>$}\par
7 {\tt \#include $<$stdlib.h$>$}\par
8 {\tt \#include \char`\"{}data.h\char`\"{}}\par
9 {\tt \#include \char`\"{}canfestival.h\char`\"{}}\par
10 {\tt \#include \char`\"{}timers\_\-driver.h\char`\"{}}\par
11 {\tt \#include \char`\"{}can\_\-driver.h\char`\"{}}\par
12 \subsection*{Data Structures}
13 \begin{CompactItemize}
14 \item 
15 struct \hyperlink{structCANPort}{CANPort}
16 \end{CompactItemize}
17 \subsection*{Defines}
18 \begin{CompactItemize}
19 \item 
20 \#define \hyperlink{unix_8c_74c6a27b44fd54de5cb021299ffce612}{DLL\_\-CALL}(funcname)~($\ast$ funcname\#\#\_\-driver)
21 \item 
22 \#define \hyperlink{unix_8c_7f7ce94bf48fde67f4af7b64c7ca4c85}{FCT\_\-PTR\_\-INIT}~=NULL
23 \item 
24 \#define \hyperlink{unix_8c_2af8b26c5600696a026aa95fe49b9dc9}{DLSYM}(name)
25 \item 
26 \#define \hyperlink{unix_8c_c2f10bc5b98269f33af8a74299236e03}{MAX\_\-NB\_\-CAN\_\-PORTS}~16
27 \end{CompactItemize}
28 \subsection*{Functions}
29 \begin{CompactItemize}
30 \item 
31 UNS8 \hyperlink{unix_8c_cb4f394ec0e040c5962d3dc1957505fb}{Un\-Load\-Can\-Driver} (\hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE} handle)
32 \item 
33 \hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE} \hyperlink{unix_8c_a6eed61fc15f41f772d4645d7a5edeb5}{Load\-Can\-Driver} (char $\ast$driver\_\-name)
34 \item 
35 UNS8 \hyperlink{unix_8c_8d1909a09c50c750e4d8626595acd9f6}{can\-Send} (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} port, \hyperlink{structMessage}{Message} $\ast$m)
36 \item 
37 void \hyperlink{unix_8c_45ceca3727c2fb7ac93958a215efb827}{can\-Receive\-Loop} (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} port)
38 \item 
39 \hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} \hyperlink{unix_8c_7476146ad15948a22e7f80a00c89c40a}{can\-Open} (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$board, \hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
40 \item 
41 int \hyperlink{unix_8c_02957f72a9b951603adb98a142bd447b}{can\-Close} (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$d)
42 \end{CompactItemize}
43 \subsection*{Variables}
44 \begin{CompactItemize}
45 \item 
46 \hyperlink{structCANPort}{CANPort} \hyperlink{unix_8c_0b740cf913752262ceb23d51648da86a}{canports} \mbox{[}MAX\_\-NB\_\-CAN\_\-PORTS\mbox{]} = \{\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\}\}
47 \end{CompactItemize}
48
49
50 \subsection{Define Documentation}
51 \hypertarget{unix_8c_74c6a27b44fd54de5cb021299ffce612}{
52 \index{unix.c@{unix.c}!DLL_CALL@{DLL\_\-CALL}}
53 \index{DLL_CALL@{DLL\_\-CALL}!unix.c@{unix.c}}
54 \subsubsection[DLL\_\-CALL]{\setlength{\rightskip}{0pt plus 5cm}\#define DLL\_\-CALL(funcname)~($\ast$ funcname\#\#\_\-driver)}}
55 \label{unix_8c_74c6a27b44fd54de5cb021299ffce612}
56
57
58
59
60 Definition at line 27 of file unix.c.\hypertarget{unix_8c_2af8b26c5600696a026aa95fe49b9dc9}{
61 \index{unix.c@{unix.c}!DLSYM@{DLSYM}}
62 \index{DLSYM@{DLSYM}!unix.c@{unix.c}}
63 \subsubsection[DLSYM]{\setlength{\rightskip}{0pt plus 5cm}\#define DLSYM(name)}}
64 \label{unix_8c_2af8b26c5600696a026aa95fe49b9dc9}
65
66
67 \textbf{Value:}
68
69 \begin{Code}\begin{verbatim}*(void **) (&name##_driver) = dlsym(handle, #name"_driver");\
70         if ((error = dlerror()) != NULL)  {\
71                 fprintf (stderr, "%s\n", error);\
72                 UnLoadCanDriver(handle);\
73                 return NULL;\
74         }
75 \end{verbatim}\end{Code}
76
77
78 Definition at line 30 of file unix.c.\hypertarget{unix_8c_7f7ce94bf48fde67f4af7b64c7ca4c85}{
79 \index{unix.c@{unix.c}!FCT_PTR_INIT@{FCT\_\-PTR\_\-INIT}}
80 \index{FCT_PTR_INIT@{FCT\_\-PTR\_\-INIT}!unix.c@{unix.c}}
81 \subsubsection[FCT\_\-PTR\_\-INIT]{\setlength{\rightskip}{0pt plus 5cm}\#define FCT\_\-PTR\_\-INIT~=NULL}}
82 \label{unix_8c_7f7ce94bf48fde67f4af7b64c7ca4c85}
83
84
85
86
87 Definition at line 28 of file unix.c.\hypertarget{unix_8c_c2f10bc5b98269f33af8a74299236e03}{
88 \index{unix.c@{unix.c}!MAX_NB_CAN_PORTS@{MAX\_\-NB\_\-CAN\_\-PORTS}}
89 \index{MAX_NB_CAN_PORTS@{MAX\_\-NB\_\-CAN\_\-PORTS}!unix.c@{unix.c}}
90 \subsubsection[MAX\_\-NB\_\-CAN\_\-PORTS]{\setlength{\rightskip}{0pt plus 5cm}\#define MAX\_\-NB\_\-CAN\_\-PORTS~16}}
91 \label{unix_8c_c2f10bc5b98269f33af8a74299236e03}
92
93
94
95
96 Definition at line 49 of file unix.c.
97
98 \subsection{Function Documentation}
99 \hypertarget{unix_8c_02957f72a9b951603adb98a142bd447b}{
100 \index{unix.c@{unix.c}!canClose@{canClose}}
101 \index{canClose@{canClose}!unix.c@{unix.c}}
102 \subsubsection[canClose]{\setlength{\rightskip}{0pt plus 5cm}int can\-Close (\hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
103 \label{unix_8c_02957f72a9b951603adb98a142bd447b}
104
105
106
107
108 Definition at line 178 of file unix.c.\hypertarget{unix_8c_7476146ad15948a22e7f80a00c89c40a}{
109 \index{unix.c@{unix.c}!canOpen@{canOpen}}
110 \index{canOpen@{canOpen}!unix.c@{unix.c}}
111 \subsubsection[canOpen]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} can\-Open (\hyperlink{structstruct__s__BOARD}{s\_\-BOARD} $\ast$ {\em board}, \hyperlink{structstruct__CO__Data}{CO\_\-Data} $\ast$ {\em d})}}
112 \label{unix_8c_7476146ad15948a22e7f80a00c89c40a}
113
114
115
116
117 Definition at line 145 of file unix.c.\hypertarget{unix_8c_45ceca3727c2fb7ac93958a215efb827}{
118 \index{unix.c@{unix.c}!canReceiveLoop@{canReceiveLoop}}
119 \index{canReceiveLoop@{canReceiveLoop}!unix.c@{unix.c}}
120 \subsubsection[canReceiveLoop]{\setlength{\rightskip}{0pt plus 5cm}void can\-Receive\-Loop (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} {\em port})}}
121 \label{unix_8c_45ceca3727c2fb7ac93958a215efb827}
122
123
124
125
126 Definition at line 132 of file unix.c.
127
128 References can\-Dispatch(), can\-Receive(), DLL\_\-CALL, Enter\-Mutex(), and Leave\-Mutex().\hypertarget{unix_8c_8d1909a09c50c750e4d8626595acd9f6}{
129 \index{unix.c@{unix.c}!canSend@{canSend}}
130 \index{canSend@{canSend}!unix.c@{unix.c}}
131 \subsubsection[canSend]{\setlength{\rightskip}{0pt plus 5cm}UNS8 can\-Send (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} {\em port}, \hyperlink{structMessage}{Message} $\ast$ {\em m})}}
132 \label{unix_8c_8d1909a09c50c750e4d8626595acd9f6}
133
134
135
136
137 Definition at line 120 of file unix.c.\hypertarget{unix_8c_a6eed61fc15f41f772d4645d7a5edeb5}{
138 \index{unix.c@{unix.c}!LoadCanDriver@{LoadCanDriver}}
139 \index{LoadCanDriver@{LoadCanDriver}!unix.c@{unix.c}}
140 \subsubsection[LoadCanDriver]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE} Load\-Can\-Driver (char $\ast$ {\em driver\_\-name})}}
141 \label{unix_8c_a6eed61fc15f41f772d4645d7a5edeb5}
142
143
144
145
146 Definition at line 84 of file unix.c.\hypertarget{unix_8c_cb4f394ec0e040c5962d3dc1957505fb}{
147 \index{unix.c@{unix.c}!UnLoadCanDriver@{UnLoadCanDriver}}
148 \index{UnLoadCanDriver@{UnLoadCanDriver}!unix.c@{unix.c}}
149 \subsubsection[UnLoadCanDriver]{\setlength{\rightskip}{0pt plus 5cm}UNS8 Un\-Load\-Can\-Driver (\hyperlink{win32_2canfestival_8h_c4a0f44120dee396ab6bb57e23effaa8}{LIB\_\-HANDLE} {\em handle})}}
150 \label{unix_8c_cb4f394ec0e040c5962d3dc1957505fb}
151
152
153
154
155 Definition at line 71 of file unix.c.
156
157 \subsection{Variable Documentation}
158 \hypertarget{unix_8c_0b740cf913752262ceb23d51648da86a}{
159 \index{unix.c@{unix.c}!canports@{canports}}
160 \index{canports@{canports}!unix.c@{unix.c}}
161 \subsubsection[canports]{\setlength{\rightskip}{0pt plus 5cm}\hyperlink{structCANPort}{CANPort} \hyperlink{unix_8c_0b740cf913752262ceb23d51648da86a}{canports}\mbox{[}MAX\_\-NB\_\-CAN\_\-PORTS\mbox{]} = \{\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\},\{0,\}\}}}
162 \label{unix_8c_0b740cf913752262ceb23d51648da86a}
163
164
165
166
167 Definition at line 66 of file unix.c.