Pileus Git - ~andy/linux/blob - drivers/staging/epl/kernel/EplDllkCal.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 kernelspace DLL Communication Abstraction Layer 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: EplDllkCal.h,v $
  53
  54                 $Author: D.Krueger $
  55
  56                 $Revision: 1.6 $  $Date: 2008/11/13 17:13:09 $
  57
  58                 $State: Exp $
  59
  60                 Build Environment:
  61                     GCC V3.4
  62
  63   -------------------------------------------------------------------------
  64
  65   Revision History:
  66
  67   2006/06/13 d.k.:   start of the implementation, version 1.00
  68
  69
  70 ****************************************************************************/
  71
  72 #ifndef _EPL_DLLKCAL_H_
  73 #define _EPL_DLLKCAL_H_
  74
  75 #include "../EplDll.h"
  76 #include "../EplEvent.h"
  77
  78 //---------------------------------------------------------------------------
  79 // const defines
  80 //---------------------------------------------------------------------------
  81
  82 //---------------------------------------------------------------------------
  83 // typedef
  84 //---------------------------------------------------------------------------
  85
  86 typedef struct
  87 {
  88     unsigned long   m_ulCurTxFrameCountGen;
  89     unsigned long   m_ulCurTxFrameCountNmt;
  90     unsigned long   m_ulCurRxFrameCount;
  91     unsigned long   m_ulMaxTxFrameCountGen;
  92     unsigned long   m_ulMaxTxFrameCountNmt;
  93     unsigned long   m_ulMaxRxFrameCount;
  94
  95 } tEplDllkCalStatistics;
  96
  97 //---------------------------------------------------------------------------
  98 // function prototypes
  99 //---------------------------------------------------------------------------
 100
 101 #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_DLLK)) != 0)
 102
 103 tEplKernel EplDllkCalAddInstance(void);
 104
 105 tEplKernel EplDllkCalDelInstance(void);
 106
 107 tEplKernel EplDllkCalAsyncGetTxCount(tEplDllAsyncReqPriority * pPriority_p, unsigned int * puiCount_p);
 108 tEplKernel EplDllkCalAsyncGetTxFrame(void * pFrame_p, unsigned int * puiFrameSize_p, tEplDllAsyncReqPriority Priority_p);
 109 // only frames with registered AsndServiceIds are passed to CAL
 110 tEplKernel EplDllkCalAsyncFrameReceived(tEplFrameInfo * pFrameInfo_p);
 111
 112 tEplKernel EplDllkCalAsyncSend(tEplFrameInfo * pFrameInfo_p, tEplDllAsyncReqPriority Priority_p);
 113
 114 tEplKernel EplDllkCalAsyncClearBuffer(void);
 115
 116 tEplKernel EplDllkCalGetStatistics(tEplDllkCalStatistics ** ppStatistics);
 117
 118 tEplKernel EplDllkCalProcess(tEplEvent * pEvent_p);
 119
 120 #if (((EPL_MODULE_INTEGRATION) & (EPL_MODULE_NMT_MN)) != 0)
 121
 122 tEplKernel EplDllkCalAsyncClearQueues(void);
 123
 124 tEplKernel EplDllkCalIssueRequest(tEplDllReqServiceId Service_p, unsigned int uiNodeId_p, BYTE bSoaFlag1_p);
 125
 126 tEplKernel EplDllkCalAsyncGetSoaRequest(tEplDllReqServiceId* pReqServiceId_p, unsigned int* puiNodeId_p);
 127
 128 tEplKernel EplDllkCalAsyncSetPendingRequests(unsigned int uiNodeId_p, tEplDllAsyncReqPriority AsyncReqPrio_p, unsigned int uiCount_p);
 129
 130 #endif //(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_NMT_MN)) != 0)
 131
 132 #endif // #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_DLLK)) != 0)
 133
 134 #endif  // #ifndef _EPL_DLLKCAL_H_
 135
 136