include/timers_driver.h
author Robert Lehmann <robert.lehmann@sitec-systems.de>
Tue, 28 Jul 2015 16:36:55 +0200
changeset 793 72e9e1064432
parent 561 f9be4262c68d
child 801 32d146b64a35
permissions -rwxr-xr-x
timers_unix: Fix termination problem of WaitReceiveTaskEnd

The function pthread_kill sends the Signal thread and to the own process.
If you use this construct than the application which calls uses the
canfestival api will terminate at the call of canClose. To avoid that
use pthread_cancel instead of pthread_kill. To use the pthread_cancel call
you need to set the cancel ability in the thread function. That means
you need to call pthread_setcancelstate and pthread_setcanceltype.
For the termination of the thread at any time it is important to set the
cancel type to PTHREAD_CANCEL_ASYNCHRONOUS.
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
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 528
diff changeset
    34
f9be4262c68d Add doxygen comments in headers file
greg
parents: 528
diff changeset
    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
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    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
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    46
void LeaveMutex(void);
561
f9be4262c68d Add doxygen comments in headers file
greg
parents: 528
diff changeset
    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
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    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
f9be4262c68d Add doxygen comments in headers file
greg
parents: 528
diff changeset
    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
bc000083297a - add RTAI support
greg
parents: 401
diff changeset
    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
bc000083297a - add RTAI support
greg
parents: 401
diff changeset
    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
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    83
4472ee7c6c3e Commit a new cvs repo.
etisserant
parents:
diff changeset
    84
#endif