doc/doxygen/latex/timers__xeno_8c.tex

   1 \hypertarget{timers__xeno_8c}{
   2 \section{/home/epimerde/documents/tc11/Can\-Festival-3/drivers/timers\_\-xeno/timers\_\-xeno.c File Reference}
   3 \label{timers__xeno_8c}\index{/home/epimerde/documents/tc11/CanFestival-3/drivers/timers_xeno/timers_xeno.c@{/home/epimerde/documents/tc11/CanFestival-3/drivers/timers\_\-xeno/timers\_\-xeno.c}}
   4 }
   5 {\tt \#include $<$stdlib.h$>$}\par
   6 {\tt \#include $<$unistd.h$>$}\par
   7 {\tt \#include $<$sys/mman.h$>$}\par
   8 {\tt \#include $<$native/task.h$>$}\par
   9 {\tt \#include $<$native/timer.h$>$}\par
  10 {\tt \#include $<$native/mutex.h$>$}\par
  11 {\tt \#include $<$native/alarm.h$>$}\par
  12 {\tt \#include \char`\"{}applicfg.h\char`\"{}}\par
  13 {\tt \#include \char`\"{}can\_\-driver.h\char`\"{}}\par
  14 {\tt \#include \char`\"{}timer.h\char`\"{}}\par
  15 \subsection*{Defines}
  16 \begin{CompactItemize}
  17 \item
  18 \#define \hyperlink{timers__xeno_8c_3e43352afeb0977d4e99f3590026c9ee}{TIMERLOOP\_\-TASK\_\-CREATED}~1
  19 \end{CompactItemize}
  20 \subsection*{Functions}
  21 \begin{CompactItemize}
  22 \item
  23 void \hyperlink{timers__xeno_8c_f37d89241d0a9ac0430a0db6c1ead3d2}{cleanup\_\-all} (void)
  24 \item
  25 void \hyperlink{timers__xeno_8c_8758484f3cebb0cd44bb247c3f23d5e3}{Stop\-Timer\-Loop} (void)
  26 \item
  27 void \hyperlink{timers__xeno_8c_d7fee43b8a44cf8b7036853593044037}{Enter\-Mutex} (void)
  28 \item
  29 void \hyperlink{timers__xeno_8c_73d9a4eb941fb20cf6b597840510394b}{Leave\-Mutex} (void)
  30 \item
  31 void \hyperlink{timers__xeno_8c_15986eb72a64e72df6600dc23c1e19c8}{timerloop\_\-task\_\-proc} (void $\ast$arg)
  32 \item
  33 void \hyperlink{timers__xeno_8c_c9e1731843825eb55e7a94894e6a8ec5}{Start\-Timer\-Loop} (\hyperlink{timer_8h_f7d102e060339d3730ceae5fea03691b}{Timer\-Callback\_\-t} init\_\-callback)
  34 \item
  35 void \hyperlink{timers__xeno_8c_d009be934c04ee04b8e5a1cb5af08efd}{Create\-Receive\-Task} (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} fd0, TASK\_\-HANDLE $\ast$Receive\-Loop\_\-task, void $\ast$Receive\-Loop\_\-task\_\-proc)
  36 \item
  37 void \hyperlink{timers__xeno_8c_aee2aa5ebcc60c3f2231f59c1c7beab0}{Wait\-Receive\-Task\-End} (TASK\_\-HANDLE $\ast$Thread)
  38 \item
  39 void \hyperlink{timers__xeno_8c_b8d05dee70f04b5c5190ab00e84da106}{set\-Timer} (TIMEVAL value)
  40 \item
  41 TIMEVAL \hyperlink{timers__xeno_8c_4dccc204d52176bd547ab34d6858f5ba}{get\-Elapsed\-Time} (void)
  42 \end{CompactItemize}
  43 \subsection*{Variables}
  44 \begin{CompactItemize}
  45 \item
  46 RT\_\-MUTEX \hyperlink{timers__xeno_8c_b6ebfe5bfc980bae026866758af3a7ff}{Can\-Festival\_\-mutex}
  47 \item
  48 RT\_\-TASK \hyperlink{timers__xeno_8c_3921261b6599c37eb3830a799d05f32e}{timerloop\_\-task}
  49 \item
  50 RTIME \hyperlink{timers__xeno_8c_b64940b870e06e40ac13634a9e2b9ac2}{last\_\-time\_\-read}
  51 \item
  52 RTIME \hyperlink{timers__xeno_8c_faf0ed3ab58750ccf1a09c52f7304cc3}{last\_\-occured\_\-alarm}
  53 \item
  54 RTIME \hyperlink{timers__xeno_8c_e2985cf19e9415625d21f0f79b580fd0}{last\_\-alarm\_\-set}
  55 \item
  56 char \hyperlink{timers__xeno_8c_c006a038004f458645d9f7ef06c7bd04}{stop\_\-timer} = 0
  57 \end{CompactItemize}
  58
  59
  60 \subsection{Define Documentation}
  61 \hypertarget{timers__xeno_8c_3e43352afeb0977d4e99f3590026c9ee}{
  62 \index{timers_xeno.c@{timers\_\-xeno.c}!TIMERLOOP_TASK_CREATED@{TIMERLOOP\_\-TASK\_\-CREATED}}
  63 \index{TIMERLOOP_TASK_CREATED@{TIMERLOOP\_\-TASK\_\-CREATED}!timers_xeno.c@{timers\_\-xeno.c}}
  64 \subsubsection[TIMERLOOP\_\-TASK\_\-CREATED]{\setlength{\rightskip}{0pt plus 5cm}\#define TIMERLOOP\_\-TASK\_\-CREATED~1}}
  65 \label{timers__xeno_8c_3e43352afeb0977d4e99f3590026c9ee}
  66
  67
  68
  69
  70 Definition at line 14 of file timers\_\-xeno.c.
  71
  72 \subsection{Function Documentation}
  73 \hypertarget{timers__xeno_8c_f37d89241d0a9ac0430a0db6c1ead3d2}{
  74 \index{timers_xeno.c@{timers\_\-xeno.c}!cleanup_all@{cleanup\_\-all}}
  75 \index{cleanup_all@{cleanup\_\-all}!timers_xeno.c@{timers\_\-xeno.c}}
  76 \subsubsection[cleanup\_\-all]{\setlength{\rightskip}{0pt plus 5cm}void cleanup\_\-all (void)}}
  77 \label{timers__xeno_8c_f37d89241d0a9ac0430a0db6c1ead3d2}
  78
  79
  80
  81
  82 Definition at line 24 of file timers\_\-xeno.c.
  83
  84 References timerloop\_\-task.\hypertarget{timers__xeno_8c_d009be934c04ee04b8e5a1cb5af08efd}{
  85 \index{timers_xeno.c@{timers\_\-xeno.c}!CreateReceiveTask@{CreateReceiveTask}}
  86 \index{CreateReceiveTask@{CreateReceiveTask}!timers_xeno.c@{timers\_\-xeno.c}}
  87 \subsubsection[CreateReceiveTask]{\setlength{\rightskip}{0pt plus 5cm}void Create\-Receive\-Task (\hyperlink{win32_2applicfg_8h_7ef59f941603c6680e74fc335523f17e}{CAN\_\-PORT} {\em fd0}, TASK\_\-HANDLE $\ast$ {\em Receive\-Loop\_\-task}, void $\ast$ {\em Receive\-Loop\_\-task\_\-proc})}}
  88 \label{timers__xeno_8c_d009be934c04ee04b8e5a1cb5af08efd}
  89
  90
  91
  92
  93 Definition at line 93 of file timers\_\-xeno.c.\hypertarget{timers__xeno_8c_d7fee43b8a44cf8b7036853593044037}{
  94 \index{timers_xeno.c@{timers\_\-xeno.c}!EnterMutex@{EnterMutex}}
  95 \index{EnterMutex@{EnterMutex}!timers_xeno.c@{timers\_\-xeno.c}}
  96 \subsubsection[EnterMutex]{\setlength{\rightskip}{0pt plus 5cm}void Enter\-Mutex (void)}}
  97 \label{timers__xeno_8c_d7fee43b8a44cf8b7036853593044037}
  98
  99
 100
 101
 102 Definition at line 35 of file timers\_\-xeno.c.
 103
 104 References Can\-Festival\_\-mutex.\hypertarget{timers__xeno_8c_4dccc204d52176bd547ab34d6858f5ba}{
 105 \index{timers_xeno.c@{timers\_\-xeno.c}!getElapsedTime@{getElapsedTime}}
 106 \index{getElapsedTime@{getElapsedTime}!timers_xeno.c@{timers\_\-xeno.c}}
 107 \subsubsection[getElapsedTime]{\setlength{\rightskip}{0pt plus 5cm}TIMEVAL get\-Elapsed\-Time (void)}}
 108 \label{timers__xeno_8c_4dccc204d52176bd547ab34d6858f5ba}
 109
 110
 111
 112
 113 Definition at line 128 of file timers\_\-xeno.c.
 114
 115 References last\_\-occured\_\-alarm, and last\_\-time\_\-read.\hypertarget{timers__xeno_8c_73d9a4eb941fb20cf6b597840510394b}{
 116 \index{timers_xeno.c@{timers\_\-xeno.c}!LeaveMutex@{LeaveMutex}}
 117 \index{LeaveMutex@{LeaveMutex}!timers_xeno.c@{timers\_\-xeno.c}}
 118 \subsubsection[LeaveMutex]{\setlength{\rightskip}{0pt plus 5cm}void Leave\-Mutex (void)}}
 119 \label{timers__xeno_8c_73d9a4eb941fb20cf6b597840510394b}
 120
 121
 122
 123
 124 Definition at line 40 of file timers\_\-xeno.c.
 125
 126 References Can\-Festival\_\-mutex.\hypertarget{timers__xeno_8c_b8d05dee70f04b5c5190ab00e84da106}{
 127 \index{timers_xeno.c@{timers\_\-xeno.c}!setTimer@{setTimer}}
 128 \index{setTimer@{setTimer}!timers_xeno.c@{timers\_\-xeno.c}}
 129 \subsubsection[setTimer]{\setlength{\rightskip}{0pt plus 5cm}void set\-Timer (TIMEVAL {\em value})}}
 130 \label{timers__xeno_8c_b8d05dee70f04b5c5190ab00e84da106}
 131
 132
 133
 134
 135 Definition at line 122 of file timers\_\-xeno.c.
 136
 137 References last\_\-alarm\_\-set, last\_\-time\_\-read, timerloop\_\-task, and TIMEVAL\_\-MAX.\hypertarget{timers__xeno_8c_c9e1731843825eb55e7a94894e6a8ec5}{
 138 \index{timers_xeno.c@{timers\_\-xeno.c}!StartTimerLoop@{StartTimerLoop}}
 139 \index{StartTimerLoop@{StartTimerLoop}!timers_xeno.c@{timers\_\-xeno.c}}
 140 \subsubsection[StartTimerLoop]{\setlength{\rightskip}{0pt plus 5cm}void Start\-Timer\-Loop (\hyperlink{timer_8h_f7d102e060339d3730ceae5fea03691b}{Timer\-Callback\_\-t} {\em init\_\-callback})}}
 141 \label{timers__xeno_8c_c9e1731843825eb55e7a94894e6a8ec5}
 142
 143
 144
 145
 146 Definition at line 60 of file timers\_\-xeno.c.
 147
 148 References cleanup\_\-all(), get\-Elapsed\-Time(), last\_\-alarm\_\-set, last\_\-occured\_\-alarm, last\_\-time\_\-read, Set\-Alarm(), stop\_\-timer, timerloop\_\-task, and timerloop\_\-task\_\-proc().\hypertarget{timers__xeno_8c_8758484f3cebb0cd44bb247c3f23d5e3}{
 149 \index{timers_xeno.c@{timers\_\-xeno.c}!StopTimerLoop@{StopTimerLoop}}
 150 \index{StopTimerLoop@{StopTimerLoop}!timers_xeno.c@{timers\_\-xeno.c}}
 151 \subsubsection[StopTimerLoop]{\setlength{\rightskip}{0pt plus 5cm}void Stop\-Timer\-Loop (void)}}
 152 \label{timers__xeno_8c_8758484f3cebb0cd44bb247c3f23d5e3}
 153
 154
 155
 156
 157 Definition at line 28 of file timers\_\-xeno.c.
 158
 159 References stop\_\-timer, and timerloop\_\-task.\hypertarget{timers__xeno_8c_15986eb72a64e72df6600dc23c1e19c8}{
 160 \index{timers_xeno.c@{timers\_\-xeno.c}!timerloop_task_proc@{timerloop\_\-task\_\-proc}}
 161 \index{timerloop_task_proc@{timerloop\_\-task\_\-proc}!timers_xeno.c@{timers\_\-xeno.c}}
 162 \subsubsection[timerloop\_\-task\_\-proc]{\setlength{\rightskip}{0pt plus 5cm}void timerloop\_\-task\_\-proc (void $\ast$ {\em arg})}}
 163 \label{timers__xeno_8c_15986eb72a64e72df6600dc23c1e19c8}
 164
 165
 166
 167
 168 Definition at line 45 of file timers\_\-xeno.c.
 169
 170 References Enter\-Mutex(), last\_\-alarm\_\-set, last\_\-occured\_\-alarm, Leave\-Mutex(), stop\_\-timer, and Time\-Dispatch().\hypertarget{timers__xeno_8c_aee2aa5ebcc60c3f2231f59c1c7beab0}{
 171 \index{timers_xeno.c@{timers\_\-xeno.c}!WaitReceiveTaskEnd@{WaitReceiveTaskEnd}}
 172 \index{WaitReceiveTaskEnd@{WaitReceiveTaskEnd}!timers_xeno.c@{timers\_\-xeno.c}}
 173 \subsubsection[WaitReceiveTaskEnd]{\setlength{\rightskip}{0pt plus 5cm}void Wait\-Receive\-Task\-End (TASK\_\-HANDLE $\ast$ {\em Thread})}}
 174 \label{timers__xeno_8c_aee2aa5ebcc60c3f2231f59c1c7beab0}
 175
 176
 177
 178
 179 Definition at line 117 of file timers\_\-xeno.c.
 180
 181 \subsection{Variable Documentation}
 182 \hypertarget{timers__xeno_8c_b6ebfe5bfc980bae026866758af3a7ff}{
 183 \index{timers_xeno.c@{timers\_\-xeno.c}!CanFestival_mutex@{CanFestival\_\-mutex}}
 184 \index{CanFestival_mutex@{CanFestival\_\-mutex}!timers_xeno.c@{timers\_\-xeno.c}}
 185 \subsubsection[CanFestival\_\-mutex]{\setlength{\rightskip}{0pt plus 5cm}RT\_\-MUTEX \hyperlink{timers__xeno_8c_b6ebfe5bfc980bae026866758af3a7ff}{Can\-Festival\_\-mutex}}}
 186 \label{timers__xeno_8c_b6ebfe5bfc980bae026866758af3a7ff}
 187
 188
 189
 190
 191 Definition at line 16 of file timers\_\-xeno.c.\hypertarget{timers__xeno_8c_e2985cf19e9415625d21f0f79b580fd0}{
 192 \index{timers_xeno.c@{timers\_\-xeno.c}!last_alarm_set@{last\_\-alarm\_\-set}}
 193 \index{last_alarm_set@{last\_\-alarm\_\-set}!timers_xeno.c@{timers\_\-xeno.c}}
 194 \subsubsection[last\_\-alarm\_\-set]{\setlength{\rightskip}{0pt plus 5cm}RTIME \hyperlink{timers__xeno_8c_e2985cf19e9415625d21f0f79b580fd0}{last\_\-alarm\_\-set}}}
 195 \label{timers__xeno_8c_e2985cf19e9415625d21f0f79b580fd0}
 196
 197
 198
 199
 200 Definition at line 20 of file timers\_\-xeno.c.\hypertarget{timers__xeno_8c_faf0ed3ab58750ccf1a09c52f7304cc3}{
 201 \index{timers_xeno.c@{timers\_\-xeno.c}!last_occured_alarm@{last\_\-occured\_\-alarm}}
 202 \index{last_occured_alarm@{last\_\-occured\_\-alarm}!timers_xeno.c@{timers\_\-xeno.c}}
 203 \subsubsection[last\_\-occured\_\-alarm]{\setlength{\rightskip}{0pt plus 5cm}RTIME \hyperlink{timers__xeno_8c_faf0ed3ab58750ccf1a09c52f7304cc3}{last\_\-occured\_\-alarm}}}
 204 \label{timers__xeno_8c_faf0ed3ab58750ccf1a09c52f7304cc3}
 205
 206
 207
 208
 209 Definition at line 19 of file timers\_\-xeno.c.\hypertarget{timers__xeno_8c_b64940b870e06e40ac13634a9e2b9ac2}{
 210 \index{timers_xeno.c@{timers\_\-xeno.c}!last_time_read@{last\_\-time\_\-read}}
 211 \index{last_time_read@{last\_\-time\_\-read}!timers_xeno.c@{timers\_\-xeno.c}}
 212 \subsubsection[last\_\-time\_\-read]{\setlength{\rightskip}{0pt plus 5cm}RTIME \hyperlink{timers__xeno_8c_b64940b870e06e40ac13634a9e2b9ac2}{last\_\-time\_\-read}}}
 213 \label{timers__xeno_8c_b64940b870e06e40ac13634a9e2b9ac2}
 214
 215
 216
 217
 218 Definition at line 18 of file timers\_\-xeno.c.\hypertarget{timers__xeno_8c_c006a038004f458645d9f7ef06c7bd04}{
 219 \index{timers_xeno.c@{timers\_\-xeno.c}!stop_timer@{stop\_\-timer}}
 220 \index{stop_timer@{stop\_\-timer}!timers_xeno.c@{timers\_\-xeno.c}}
 221 \subsubsection[stop\_\-timer]{\setlength{\rightskip}{0pt plus 5cm}char \hyperlink{timers__xeno_8c_c006a038004f458645d9f7ef06c7bd04}{stop\_\-timer} = 0}}
 222 \label{timers__xeno_8c_c006a038004f458645d9f7ef06c7bd04}
 223
 224
 225
 226
 227 Definition at line 22 of file timers\_\-xeno.c.\hypertarget{timers__xeno_8c_3921261b6599c37eb3830a799d05f32e}{
 228 \index{timers_xeno.c@{timers\_\-xeno.c}!timerloop_task@{timerloop\_\-task}}
 229 \index{timerloop_task@{timerloop\_\-task}!timers_xeno.c@{timers\_\-xeno.c}}
 230 \subsubsection[timerloop\_\-task]{\setlength{\rightskip}{0pt plus 5cm}RT\_\-TASK \hyperlink{timers__xeno_8c_3921261b6599c37eb3830a799d05f32e}{timerloop\_\-task}}}
 231 \label{timers__xeno_8c_3921261b6599c37eb3830a799d05f32e}
 232
 233
 234
 235
 236 Definition at line 17 of file timers\_\-xeno.c.