drivers/staging/epl/user/EplObduCal.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 communication abstraction layer
   9                 for the Epl-Obd-Userspace-Modul
  10
  11   License:
  12
  13     Redistribution and use in source and binary forms, with or without
  14     modification, are permitted provided that the following conditions
  15     are met:
  16
  17     1. Redistributions of source code must retain the above copyright
  18        notice, this list of conditions and the following disclaimer.
  19
  20     2. Redistributions in binary form must reproduce the above copyright
  21        notice, this list of conditions and the following disclaimer in the
  22        documentation and/or other materials provided with the distribution.
  23
  24     3. Neither the name of SYSTEC electronic GmbH nor the names of its
  25        contributors may be used to endorse or promote products derived
  26        from this software without prior written permission. For written
  27        permission, please contact info@systec-electronic.com.
  28
  29     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  30     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  31     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  32     FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  33     COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  34     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  35     BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  36     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  37     CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  38     LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  39     ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  40     POSSIBILITY OF SUCH DAMAGE.
  41
  42     Severability Clause:
  43
  44         If a provision of this License is or becomes illegal, invalid or
  45         unenforceable in any jurisdiction, that shall not affect:
  46         1. the validity or enforceability in that jurisdiction of any other
  47            provision of this License; or
  48         2. the validity or enforceability in other jurisdictions of that or
  49            any other provision of this License.
  50
  51   -------------------------------------------------------------------------
  52
  53                 $RCSfile: EplObduCal.h,v $
  54
  55                 $Author: D.Krueger $
  56
  57                 $Revision: 1.4 $  $Date: 2008/04/17 21:36:32 $
  58
  59                 $State: Exp $
  60
  61                 Build Environment:
  62                     GCC V3.4
  63
  64   -------------------------------------------------------------------------
  65
  66   Revision History:
  67
  68   2006/06/19 k.t.:   start of the implementation
  69
  70 ****************************************************************************/
  71
  72 #ifndef _EPLOBDUCAL_H_
  73 #define _EPLOBDUCAL_H_
  74
  75 #include "../EplObd.h"
  76
  77 tEplKernel EplObduCalWriteEntry(unsigned int uiIndex_p,
  78                                 unsigned int uiSubIndex_p,
  79                                 void *pSrcData_p,
  80                                 tEplObdSize Size_p);
  81 //---------------------------------------------------------------------------
  82 tEplKernel EplObduCalReadEntry(unsigned int uiIndex_p,
  83                                unsigned int uiSubIndex_p,
  84                                void *pDstData_p,
  85                                tEplObdSize *pSize_p);
  86 //---------------------------------------------------------------------------
  87 tEplKernel EplObduCalAccessOdPart(tEplObdPart ObdPart_p,
  88                                   tEplObdDir Direction_p);
  89 //---------------------------------------------------------------------------
  90 tEplKernel EplObduCalDefineVar(tEplVarParam *pVarParam_p);
  91 //---------------------------------------------------------------------------
  92 void *EplObduCalGetObjectDataPtr(unsigned int uiIndex_p,
  93                                  unsigned int uiSubIndex_p);
  94 //---------------------------------------------------------------------------
  95 tEplKernel EplObduCalRegisterUserOd(tEplObdEntryPtr pUserOd_p);
  96 //---------------------------------------------------------------------------
  97 void EplObduCalInitVarEntry(tEplObdVarEntry *pVarEntry_p,
  98                             u8 bType_p, tEplObdSize ObdSize_p);
  99 //---------------------------------------------------------------------------
 100 tEplObdSize EplObduCalGetDataSize(unsigned int uiIndex_p,
 101                                   unsigned int uiSubIndex_p);
 102 //---------------------------------------------------------------------------
 103 unsigned int EplObduCalGetNodeId(void);
 104 //---------------------------------------------------------------------------
 105 tEplKernel EplObduCalSetNodeId(unsigned int uiNodeId_p,
 106                                tEplObdNodeIdType NodeIdType_p);
 107 //---------------------------------------------------------------------------
 108 tEplKernel EplObduCalGetAccessType(unsigned int uiIndex_p,
 109                                    unsigned int uiSubIndex_p,
 110                                    tEplObdAccess *pAccessTyp_p);
 111 //---------------------------------------------------------------------------
 112 tEplKernel EplObduCalReadEntryToLe(unsigned int uiIndex_p,
 113                                    unsigned int uiSubIndex_p,
 114                                    void *pDstData_p,
 115                                    tEplObdSize *pSize_p);
 116 //---------------------------------------------------------------------------
 117 tEplKernel EplObduCalWriteEntryFromLe(unsigned int uiIndex_p,
 118                                       unsigned int uiSubIndex_p,
 119                                       void *pSrcData_p,
 120                                       tEplObdSize Size_p);
 121 //---------------------------------------------------------------------------
 122 tEplKernel EplObduCalSearchVarEntry(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 123                                     unsigned int uiSubindex_p,
 124                                     tEplObdVarEntry **ppVarEntry_p);
 125
 126 #endif // #ifndef _EPLOBDUCAL_H_