git.oblomov.eu Git - linux-2.6/blob - drivers/staging/epl/user/EplObdu.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-Userspace-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: EplObdu.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/19 k.t.:   start of the implementation
  68
  69 ****************************************************************************/
  70
  71 #ifndef _EPLOBDU_H_
  72 #define _EPLOBDU_H_
  73
  74 #include "../EplObd.h"
  75
  76 #if (((EPL_MODULE_INTEGRATION) & (EPL_MODULE_OBDU)) != 0)
  77
  78 #if EPL_OBD_USE_KERNEL != FALSE
  79 #error "EPL OBDu module enabled, but OBD_USE_KERNEL == TRUE"
  80 #endif
  81
  82 tEplKernel EplObduWriteEntry(unsigned int uiIndex_p, unsigned int uiSubIndex_p,
  83                              void *pSrcData_p, tEplObdSize Size_p);
  84
  85 // ---------------------------------------------------------------------
  86 tEplKernel EplObduReadEntry(unsigned int uiIndex_p, unsigned int uiSubIndex_p,
  87                             void *pDstData_p, tEplObdSize *pSize_p);
  88
  89 // ---------------------------------------------------------------------
  90 tEplKernel EplObduAccessOdPart(tEplObdPart ObdPart_p, tEplObdDir Direction_p);
  91
  92 // ---------------------------------------------------------------------
  93 tEplKernel EplObduDefineVar(tEplVarParam *pVarParam_p);
  94
  95 // ---------------------------------------------------------------------
  96 void *EplObduGetObjectDataPtr(unsigned int uiIndex_p, unsigned int uiSubIndex_p);
  97
  98 // ---------------------------------------------------------------------
  99 tEplKernel EplObduRegisterUserOd(tEplObdEntryPtr pUserOd_p);
 100
 101 // ---------------------------------------------------------------------
 102 void EplObduInitVarEntry(tEplObdVarEntry *pVarEntry_p, u8 bType_p,
 103                          tEplObdSize ObdSize_p);
 104
 105 // ---------------------------------------------------------------------
 106 tEplObdSize EplObduGetDataSize(unsigned int uiIndex_p,
 107                                unsigned int uiSubIndex_p);
 108
 109 // ---------------------------------------------------------------------
 110 unsigned int EplObduGetNodeId(void);
 111
 112 // ---------------------------------------------------------------------
 113 tEplKernel EplObduSetNodeId(unsigned int uiNodeId_p,
 114                             tEplObdNodeIdType NodeIdType_p);
 115
 116 // ---------------------------------------------------------------------
 117 tEplKernel EplObduGetAccessType(unsigned int uiIndex_p,
 118                                 unsigned int uiSubIndex_p,
 119                                 tEplObdAccess *pAccessTyp_p);
 120 // ---------------------------------------------------------------------
 121 tEplKernel EplObduReadEntryToLe(unsigned int uiIndex_p,
 122                                 unsigned int uiSubIndex_p,
 123                                 void *pDstData_p, tEplObdSize *pSize_p);
 124 // ---------------------------------------------------------------------
 125 tEplKernel EplObduWriteEntryFromLe(unsigned int uiIndex_p,
 126                                    unsigned int uiSubIndex_p,
 127                                    void *pSrcData_p, tEplObdSize Size_p);
 128
 129 // ---------------------------------------------------------------------
 130 tEplKernel EplObduSearchVarEntry(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,
 131                                  unsigned int uiSubindex_p,
 132                                  tEplObdVarEntry **ppVarEntry_p);
 133
 134 #elif EPL_OBD_USE_KERNEL != FALSE
 135 #include "../kernel/EplObdk.h"
 136
 137 #define EplObduWriteEntry       EplObdWriteEntry
 138
 139 #define EplObduReadEntry        EplObdReadEntry
 140
 141 #define EplObduAccessOdPart     EplObdAccessOdPart
 142
 143 #define EplObduDefineVar        EplObdDefineVar
 144
 145 #define EplObduGetObjectDataPtr EplObdGetObjectDataPtr
 146
 147 #define EplObduRegisterUserOd   EplObdRegisterUserOd
 148
 149 #define EplObduInitVarEntry     EplObdInitVarEntry
 150
 151 #define EplObduGetDataSize      EplObdGetDataSize
 152
 153 #define EplObduGetNodeId        EplObdGetNodeId
 154
 155 #define EplObduSetNodeId        EplObdSetNodeId
 156
 157 #define EplObduGetAccessType    EplObdGetAccessType
 158
 159 #define EplObduReadEntryToLe    EplObdReadEntryToLe
 160
 161 #define EplObduWriteEntryFromLe EplObdWriteEntryFromLe
 162
 163 #define EplObduSearchVarEntry   EplObdSearchVarEntry
 164
 165 #define EplObduIsNumerical      EplObdIsNumerical
 166
 167 #endif // #if(((EPL_MODULE_INTEGRATION) & (EPL_MODULE_OBDU)) != 0)
 168
 169 #endif // #ifndef _EPLOBDU_H_