author | Laurent Bessard |
Mon, 01 Oct 2012 19:18:35 +0200 | |
changeset 748 | 18ed0f3b030a |
parent 561 | f9be4262c68d |
child 801 | 32d146b64a35 |
permissions | -rwxr-xr-x |
0 | 1 |
/* |
2 |
This file is part of CanFestival, a library implementing CanOpen Stack. |
|
3 |
||
4 |
Copyright (C): Edouard TISSERANT and Francis DUPIN |
|
5 |
||
6 |
See COPYING file for copyrights details. |
|
7 |
||
8 |
This library is free software; you can redistribute it and/or |
|
9 |
modify it under the terms of the GNU Lesser General Public |
|
10 |
License as published by the Free Software Foundation; either |
|
11 |
version 2.1 of the License, or (at your option) any later version. |
|
12 |
||
13 |
This library is distributed in the hope that it will be useful, |
|
14 |
but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
15 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
16 |
Lesser General Public License for more details. |
|
17 |
||
18 |
You should have received a copy of the GNU Lesser General Public |
|
19 |
License along with this library; if not, write to the Free Software |
|
20 |
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
|
21 |
*/ |
|
22 |
||
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
23 |
/** @defgroup timer Timer Management |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
24 |
* @ingroup userapi |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
25 |
*/ |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
26 |
|
0 | 27 |
#ifndef __timer_driver_h__ |
28 |
#define __timer_driver_h__ |
|
29 |
||
145
e747d2e26af0
Win32 Native support and dynamicaly loaded CAN drivers for Linux, Cygwin and Win32.
etisserant
parents:
32
diff
changeset
|
30 |
#include "timerscfg.h" |
0 | 31 |
#include "timer.h" |
32 |
||
33 |
// For use from CAN driver |
|
561 | 34 |
|
35 |
||
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
36 |
/** |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
37 |
* @ingroup timer |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
38 |
* @brief Acquire mutex |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
39 |
*/ |
0 | 40 |
void EnterMutex(void); |
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
41 |
|
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
42 |
/** |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
43 |
* @ingroup timer |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
44 |
* @brief Release mutex |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
45 |
*/ |
0 | 46 |
void LeaveMutex(void); |
561 | 47 |
|
401
2c90876b9751
Fixed segfault on quit with Xenomai, due to bat parameter type in waitReceiveTaskEnd.
etisserant
parents:
145
diff
changeset
|
48 |
void WaitReceiveTaskEnd(TASK_HANDLE*); |
0 | 49 |
|
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
50 |
/** |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
51 |
* @ingroup timer |
561 | 52 |
* @brief Initialize Timer |
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
53 |
*/ |
454 | 54 |
void TimerInit(void); |
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
55 |
|
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
56 |
/** |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
57 |
* @ingroup timer |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
58 |
* @brief Cleanup Timer |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
59 |
*/ |
454 | 60 |
void TimerCleanup(void); |
528
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
61 |
|
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
62 |
/** |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
63 |
* @ingroup timer |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
64 |
* @brief Start the timer task |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
65 |
* @param Callback A callback function |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
66 |
*/ |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
67 |
void StartTimerLoop(TimerCallback_t Callback); |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
68 |
|
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
69 |
/** |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
70 |
* @ingroup timer |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
71 |
* @brief Stop the timer task |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
72 |
* @param Callback A callback function |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
73 |
*/ |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
74 |
void StopTimerLoop(TimerCallback_t Callback); |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
75 |
|
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
76 |
/** |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
77 |
* @brief Stop the timer task |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
78 |
* @param port CanFestival file descriptor |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
79 |
* @param *handle handle of receive loop thread |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
80 |
* @param *ReceiveLoopPtr Pointer on the receive loop function |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
81 |
*/ |
0a30e161d63c
Re-write doxygen tags in headers files to generate User API documentation
greg
parents:
454
diff
changeset
|
82 |
void CreateReceiveTask(CAN_PORT port, TASK_HANDLE* handle, void* ReceiveLoopPtr); |
0 | 83 |
|
84 |
#endif |