include/timers_driver.h
author greg
Sat, 17 Jan 2009 17:25:58 +0100
changeset 528 0a30e161d63c
parent 454 bc000083297a
child 561 f9be4262c68d
permissions -rw-r--r--
Re-write doxygen tags in headers files to generate User API documentation
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     1
/*
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     2
This file is part of CanFestival, a library implementing CanOpen Stack. 
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     3
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     4
Copyright (C): Edouard TISSERANT and Francis DUPIN
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     5
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     6
See COPYING file for copyrights details.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     7
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     8
This library is free software; you can redistribute it and/or
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
     9
modify it under the terms of the GNU Lesser General Public
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    10
License as published by the Free Software Foundation; either
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    11
version 2.1 of the License, or (at your option) any later version.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    12
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    13
This library is distributed in the hope that it will be useful,
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    14
but WITHOUT ANY WARRANTY; without even the implied warranty of
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    15
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    16
Lesser General Public License for more details.
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    17
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    18
You should have received a copy of the GNU Lesser General Public
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    19
License along with this library; if not, write to the Free Software
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    20
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    21
*/
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    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
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    27
#ifndef __timer_driver_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    28
#define __timer_driver_h__
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    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
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    31
#include "timer.h"
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    32
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    33
// For use from CAN driver
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    34
/**
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    35
 * @ingroup timer
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    36
 * @brief Acquire mutex
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    37
 */
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    38
void EnterMutex(void);
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    39
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    40
/**
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    41
 * @ingroup timer
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    42
 * @brief Release mutex
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    43
 */
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    44
void LeaveMutex(void);
401
2c90876b9751 Fixed segfault on quit with Xenomai, due to bat parameter type in waitReceiveTaskEnd.
etisserant
parents: 145
diff changeset
    45
void WaitReceiveTaskEnd(TASK_HANDLE*);
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    46
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    47
/**
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    48
 * @ingroup timer
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    49
 * @brief Initialize Timer 
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
 */
454
bc000083297a - add RTAI support
greg
parents: 401
diff changeset
    52
void TimerInit(void);
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    53
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    54
/**
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    55
 * @ingroup timer
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    56
 * @brief Cleanup Timer  
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    57
 */
454
bc000083297a - add RTAI support
greg
parents: 401
diff changeset
    58
void TimerCleanup(void);
528
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    59
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    60
/**
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    61
 * @ingroup timer
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    62
 * @brief Start the timer task
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    63
 * @param Callback A callback function
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    64
 */
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    65
void StartTimerLoop(TimerCallback_t Callback);
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
/**
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    68
 * @ingroup timer
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    69
 * @brief Stop the timer task
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    70
 * @param Callback A callback function
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    71
 */
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    72
void StopTimerLoop(TimerCallback_t Callback);
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
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
 * @brief Stop the timer task
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    77
 * @param port CanFestival file descriptor
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    78
 * @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
    79
 * @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
    80
 */
0a30e161d63c Re-write doxygen tags in headers files to generate User API documentation
greg
parents: 454
diff changeset
    81
void CreateReceiveTask(CAN_PORT port, TASK_HANDLE* handle, void* ReceiveLoopPtr);
0
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    82
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    83
#endif