drivers/staging/epl/kernel/EplObdk.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-Obd-Kernel-Modul
   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: EplObdk.h,v $
  53
  54                 $Author: D.Krueger $
  55
  56                 $Revision: 1.8 $  $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/19 k.t.:   start of the implementation
  68
  69 ****************************************************************************/
  70
  71 #include "../EplObd.h"
  72
  73 #ifndef _EPLOBDK_H_
  74 #define _EPLOBDK_H_
  75
  76 //---------------------------------------------------------------------------
  77 // const defines
  78 //---------------------------------------------------------------------------
  79
  80 //---------------------------------------------------------------------------
  81 // typedef
  82 //---------------------------------------------------------------------------
  83
  84 //---------------------------------------------------------------------------
  85 // global variables
  86 //---------------------------------------------------------------------------
  87
  88 extern u8 abEplObdTrashObject_g[8];
  89
  90 //---------------------------------------------------------------------------
  91 // function prototypes
  92 //---------------------------------------------------------------------------
  93 #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_OBDK)) != 0)
  94 // ---------------------------------------------------------------------
  95 EPLDLLEXPORT tEplKernel EplObdInit(EPL_MCO_DECL_PTR_INSTANCE_PTR_ tEplObdInitParam *pInitParam_p);
  96
  97 // ---------------------------------------------------------------------
  98 EPLDLLEXPORT tEplKernel EplObdAddInstance(EPL_MCO_DECL_PTR_INSTANCE_PTR_ tEplObdInitParam *pInitParam_p);
  99
 100 // ---------------------------------------------------------------------
 101 EPLDLLEXPORT tEplKernel EplObdDeleteInstance(EPL_MCO_DECL_INSTANCE_PTR);
 102
 103 // ---------------------------------------------------------------------
 104 EPLDLLEXPORT tEplKernel EplObdWriteEntry(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 105                                          unsigned int uiSubIndex_p,
 106                                          void *pSrcData_p,
 107                                          tEplObdSize Size_p);
 108
 109 // ---------------------------------------------------------------------
 110 EPLDLLEXPORT tEplKernel EplObdReadEntry(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 111                                         unsigned int uiSubIndex_p,
 112                                         void *pDstData_p,
 113                                         tEplObdSize *pSize_p);
 114
 115 // ---------------------------------------------------------------------
 116 EPLDLLEXPORT tEplKernel EplObdSetStoreLoadObjCallback(EPL_MCO_DECL_INSTANCE_PTR_ tEplObdStoreLoadObjCallback fpCallback_p);
 117
 118 // ---------------------------------------------------------------------
 119 EPLDLLEXPORT tEplKernel EplObdAccessOdPart(EPL_MCO_DECL_INSTANCE_PTR_ tEplObdPart ObdPart_p,
 120                                            tEplObdDir Direction_p);
 121
 122 // ---------------------------------------------------------------------
 123 EPLDLLEXPORT tEplKernel EplObdDefineVar(EPL_MCO_DECL_INSTANCE_PTR_ tEplVarParam *pVarParam_p);
 124
 125 // ---------------------------------------------------------------------
 126 EPLDLLEXPORT void *EplObdGetObjectDataPtr(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 127                                           unsigned int uiSubIndex_p);
 128 // ---------------------------------------------------------------------
 129 EPLDLLEXPORT tEplKernel EplObdRegisterUserOd(EPL_MCO_DECL_INSTANCE_PTR_ tEplObdEntryPtr pUserOd_p);
 130
 131 // ---------------------------------------------------------------------
 132 EPLDLLEXPORT void EplObdInitVarEntry(EPL_MCO_DECL_INSTANCE_PTR_ tEplObdVarEntry *pVarEntry_p,
 133                                      tEplObdType Type_p,
 134                                      tEplObdSize ObdSize_p);
 135
 136 // ---------------------------------------------------------------------
 137 EPLDLLEXPORT tEplObdSize EplObdGetDataSize(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 138                                            unsigned int uiSubIndex_p);
 139
 140 // ---------------------------------------------------------------------
 141 EPLDLLEXPORT unsigned int EplObdGetNodeId(EPL_MCO_DECL_INSTANCE_PTR);
 142
 143 // ---------------------------------------------------------------------
 144 EPLDLLEXPORT tEplKernel EplObdSetNodeId(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiNodeId_p,
 145                                         tEplObdNodeIdType NodeIdType_p);
 146
 147 // ---------------------------------------------------------------------
 148 EPLDLLEXPORT tEplKernel EplObdIsNumerical(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 149                                           unsigned int uiSubIndex_p,
 150                                           BOOL *pfEntryNumerical);
 151 // ---------------------------------------------------------------------
 152 EPLDLLEXPORT tEplKernel EplObdWriteEntryFromLe(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 153                                                unsigned int uiSubIndex_p,
 154                                                void *pSrcData_p,
 155                                                tEplObdSize Size_p);
 156
 157 // ---------------------------------------------------------------------
 158 EPLDLLEXPORT tEplKernel EplObdReadEntryToLe(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 159                                             unsigned int uiSubIndex_p,
 160                                             void *pDstData_p,
 161                                             tEplObdSize *pSize_p);
 162
 163 // ---------------------------------------------------------------------
 164 EPLDLLEXPORT tEplKernel EplObdGetAccessType(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 165                                             unsigned int uiSubIndex_p,
 166                                             tEplObdAccess *pAccessTyp_p);
 167
 168 // ---------------------------------------------------------------------
 169 EPLDLLEXPORT tEplKernel EplObdSearchVarEntry(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 170                                              unsigned int uiSubindex_p,
 171                                              tEplObdVarEntry **ppVarEntry_p);
 172
 173 #endif // end of #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_OBDK)) != 0)
 174
 175 #endif // #ifndef _EPLOBDK_H_