include/timers_driver.h

   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
  23 /** @defgroup timer Timer Management
  24  *  @ingroup userapi
  25  */
  26
  27 #ifndef __timer_driver_h__
  28 #define __timer_driver_h__
  29
  30 #include "timerscfg.h"
  31 #include "timer.h"
  32
  33 // For use from CAN driver
  34 /**
  35  * @ingroup timer
  36  * @brief Acquire mutex
  37  */
  38 void EnterMutex(void);
  39
  40 /**
  41  * @ingroup timer
  42  * @brief Release mutex
  43  */
  44 void LeaveMutex(void);
  45 void WaitReceiveTaskEnd(TASK_HANDLE*);
  46
  47 /**
  48  * @ingroup timer
  49  * @brief Initialize Timer
  50  *
  51  */
  52 void TimerInit(void);
  53
  54 /**
  55  * @ingroup timer
  56  * @brief Cleanup Timer
  57  */
  58 void TimerCleanup(void);
  59
  60 /**
  61  * @ingroup timer
  62  * @brief Start the timer task
  63  * @param Callback A callback function
  64  */
  65 void StartTimerLoop(TimerCallback_t Callback);
  66
  67 /**
  68  * @ingroup timer
  69  * @brief Stop the timer task
  70  * @param Callback A callback function
  71  */
  72 void StopTimerLoop(TimerCallback_t Callback);
  73 /** @} */
  74
  75 /**
  76  * @brief Stop the timer task
  77  * @param port CanFestival file descriptor
  78  * @param *handle handle of receive loop thread
  79  * @param *ReceiveLoopPtr Pointer on the receive loop function
  80  */
  81 void CreateReceiveTask(CAN_PORT port, TASK_HANDLE* handle, void* ReceiveLoopPtr);
  82
  83 #endif