kernel/2.6.29.6-aldebaran-rt/drivers/staging/epl/kernel/EplDllk.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 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: EplDllk.h,v $
  53
  54                 $Author: D.Krueger $
  55
  56                 $Revision: 1.6 $  $Date: 2008/10/17 15:32:32 $
  57
  58                 $State: Exp $
  59
  60                 Build Environment:
  61                     GCC V3.4
  62
  63   -------------------------------------------------------------------------
  64
  65   Revision History:
  66
  67   2006/06/08 d.k.:   start of the implementation, version 1.00
  68
  69 ****************************************************************************/
  70
  71 #ifndef _EPL_DLLK_H_
  72 #define _EPL_DLLK_H_
  73
  74 #include "../EplDll.h"
  75 #include "../EplEvent.h"
  76
  77 //---------------------------------------------------------------------------
  78 // const defines
  79 //---------------------------------------------------------------------------
  80
  81 //---------------------------------------------------------------------------
  82 // typedef
  83 //---------------------------------------------------------------------------
  84
  85 typedef tEplKernel(*tEplDllkCbAsync) (tEplFrameInfo * pFrameInfo_p);
  86
  87 typedef struct {
  88         BYTE m_be_abSrcMac[6];
  89
  90 } tEplDllkInitParam;
  91
  92 // forward declaration
  93 struct _tEdrvTxBuffer;
  94
  95 struct _tEplDllkNodeInfo {
  96         struct _tEplDllkNodeInfo *m_pNextNodeInfo;
  97         struct _tEdrvTxBuffer *m_pPreqTxBuffer;
  98         unsigned int m_uiNodeId;
  99         DWORD m_dwPresTimeout;
 100         unsigned long m_ulDllErrorEvents;
 101         tEplNmtState m_NmtState;
 102         WORD m_wPresPayloadLimit;
 103         BYTE m_be_abMacAddr[6];
 104         BYTE m_bSoaFlag1;
 105         BOOL m_fSoftDelete;     // delete node after error and ignore error
 106
 107 };
 108
 109 typedef struct _tEplDllkNodeInfo tEplDllkNodeInfo;
 110
 111 //---------------------------------------------------------------------------
 112 // function prototypes
 113 //---------------------------------------------------------------------------
 114
 115 #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_DLLK)) != 0)
 116
 117 tEplKernel EplDllkAddInstance(tEplDllkInitParam * pInitParam_p);
 118
 119 tEplKernel EplDllkDelInstance(void);
 120
 121 // called before NMT_GS_COMMUNICATING will be entered to configure fixed parameters
 122 tEplKernel EplDllkConfig(tEplDllConfigParam * pDllConfigParam_p);
 123
 124 // set identity of local node (may be at any time, e.g. in case of hostname change)
 125 tEplKernel EplDllkSetIdentity(tEplDllIdentParam * pDllIdentParam_p);
 126
 127 // process internal events and do work that cannot be done in interrupt-context
 128 tEplKernel EplDllkProcess(tEplEvent * pEvent_p);
 129
 130 // registers handler for non-EPL frames
 131 tEplKernel EplDllkRegAsyncHandler(tEplDllkCbAsync pfnDllkCbAsync_p);
 132
 133 // deregisters handler for non-EPL frames
 134 tEplKernel EplDllkDeregAsyncHandler(tEplDllkCbAsync pfnDllkCbAsync_p);
 135
 136 // register C_DLL_MULTICAST_ASND in ethernet driver if any AsndServiceId is registered
 137 tEplKernel EplDllkSetAsndServiceIdFilter(tEplDllAsndServiceId ServiceId_p,
 138                                          tEplDllAsndFilter Filter_p);
 139
 140 // creates the buffer for a Tx frame and registers it to the ethernet driver
 141 tEplKernel EplDllkCreateTxFrame(unsigned int *puiHandle_p,
 142                                 tEplFrame ** ppFrame_p,
 143                                 unsigned int *puiFrameSize_p,
 144                                 tEplMsgType MsgType_p,
 145                                 tEplDllAsndServiceId ServiceId_p);
 146
 147 tEplKernel EplDllkDeleteTxFrame(unsigned int uiHandle_p);
 148
 149 #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_NMT_MN)) != 0)
 150
 151 tEplKernel EplDllkAddNode(tEplDllNodeInfo * pNodeInfo_p);
 152
 153 tEplKernel EplDllkDeleteNode(unsigned int uiNodeId_p);
 154
 155 tEplKernel EplDllkSoftDeleteNode(unsigned int uiNodeId_p);
 156
 157 tEplKernel EplDllkSetFlag1OfNode(unsigned int uiNodeId_p, BYTE bSoaFlag1_p);
 158
 159 tEplKernel EplDllkGetFirstNodeInfo(tEplDllkNodeInfo ** ppNodeInfo_p);
 160
 161 #endif //(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_NMT_MN)) != 0)
 162
 163 #endif // #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_DLLK)) != 0)
 164
 165 #endif // #ifndef _EPL_DLLK_H_