drivers/staging/epl/EplTimer.h

   1 /****************************************************************************
   2
   3   (c) SYSTEC electronic GmbH, D-07973 Greiz, August-Bebel-Str. 29
   4       www.systec-electronic.com
   5
   6   Project:      openPOWERLINK
   7
   8   Description:  include file for Epl Timer-Module
   9
  10   License:
  11
  12     Redistribution and use in source and binary forms, with or without
  13     modification, are permitted provided that the following conditions
  14     are met:
  15
  16     1. Redistributions of source code must retain the above copyright
  17        notice, this list of conditions and the following disclaimer.
  18
  19     2. Redistributions in binary form must reproduce the above copyright
  20        notice, this list of conditions and the following disclaimer in the
  21        documentation and/or other materials provided with the distribution.
  22
  23     3. Neither the name of SYSTEC electronic GmbH nor the names of its
  24        contributors may be used to endorse or promote products derived
  25        from this software without prior written permission. For written
  26        permission, please contact info@systec-electronic.com.
  27
  28     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  29     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  30     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  31     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  32     COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  33     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  34     BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  35     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  36     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  37     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  38     ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  39     POSSIBILITY OF SUCH DAMAGE.
  40
  41     Severability Clause:
  42
  43         If a provision of this License is or becomes illegal, invalid or
  44         unenforceable in any jurisdiction, that shall not affect:
  45         1. the validity or enforceability in that jurisdiction of any other
  46            provision of this License; or
  47         2. the validity or enforceability in other jurisdictions of that or
  48            any other provision of this License.
  49
  50   -------------------------------------------------------------------------
  51
  52                 $RCSfile: EplTimer.h,v $
  53
  54                 $Author: D.Krueger $
  55
  56                 $Revision: 1.4 $  $Date: 2008/04/17 21:36:32 $
  57
  58                 $State: Exp $
  59
  60                 Build Environment:
  61                     GCC V3.4
  62
  63   -------------------------------------------------------------------------
  64
  65   Revision History:
  66
  67   2006/07/06 k.t.:   start of the implementation
  68
  69 ****************************************************************************/
  70
  71 #include "EplInc.h"
  72 #include "EplEvent.h"
  73
  74 #ifndef _EPLTIMER_H_
  75 #define _EPLTIMER_H_
  76
  77 //---------------------------------------------------------------------------
  78 // const defines
  79 //---------------------------------------------------------------------------
  80
  81 //---------------------------------------------------------------------------
  82 // typedef
  83 //---------------------------------------------------------------------------
  84
  85 // type for timer handle
  86 typedef unsigned long tEplTimerHdl;
  87
  88 typedef struct {
  89         tEplEventSink m_EventSink;
  90         unsigned long m_ulArg;  // d.k.: converted to unsigned long because
  91         // it is never accessed as a pointer by the
  92         // timer module and the data the
  93         // pointer points to is not saved in any way.
  94         // It is just a value. The user is responsible
  95         // to store the data statically and convert
  96         // the pointer between address spaces.
  97
  98 } tEplTimerArg;
  99
 100 typedef struct {
 101         tEplTimerHdl m_TimerHdl;
 102         unsigned long m_ulArg;  // d.k.: converted to unsigned long because
 103         // it is never accessed as a pointer by the
 104         // timer module and the data the
 105         // pointer points to is not saved in any way.
 106         // It is just a value.
 107
 108 } tEplTimerEventArg;
 109
 110 typedef tEplKernel(PUBLIC * tEplTimerkCallback) (tEplTimerEventArg *
 111                                                  pEventArg_p);
 112
 113 //---------------------------------------------------------------------------
 114 // function prototypes
 115 //---------------------------------------------------------------------------
 116
 117 #endif // #ifndef _EPLTIMER_H_