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 #include "../EplObd.h" 73 74 #ifndef _EPLOBDUCAL_H_ 75 #define _EPLOBDUCAL_H_ 76 77 //--------------------------------------------------------------------------- 78 // const defines 79 //--------------------------------------------------------------------------- 80 81 //--------------------------------------------------------------------------- 82 // typedef 83 //--------------------------------------------------------------------------- 84 85 //--------------------------------------------------------------------------- 86 // function prototypes 87 //--------------------------------------------------------------------------- 88 EPLDLLEXPORT tEplKernel PUBLIC EplObduCalWriteEntry(unsigned int uiIndex_p, 89 unsigned int uiSubIndex_p, 90 void *pSrcData_p, 91 tEplObdSize Size_p); 92 //--------------------------------------------------------------------------- 93 EPLDLLEXPORT tEplKernel PUBLIC EplObduCalReadEntry(unsigned int uiIndex_p, 94 unsigned int uiSubIndex_p, 95 void *pDstData_p, 96 tEplObdSize * pSize_p); 97 //--------------------------------------------------------------------------- 98 EPLDLLEXPORT tEplKernel PUBLIC EplObduCalAccessOdPart(tEplObdPart ObdPart_p, 99 tEplObdDir Direction_p); 100 //--------------------------------------------------------------------------- 101 EPLDLLEXPORT tEplKernel PUBLIC EplObduCalDefineVar(tEplVarParam MEM * 102 pVarParam_p); 103 //--------------------------------------------------------------------------- 104 EPLDLLEXPORT void *PUBLIC EplObduCalGetObjectDataPtr(unsigned int uiIndex_p, 105 unsigned int uiSubIndex_p); 106 //--------------------------------------------------------------------------- 107 EPLDLLEXPORT tEplKernel PUBLIC EplObduCalRegisterUserOd(tEplObdEntryPtr 108 pUserOd_p); 109 //--------------------------------------------------------------------------- 110 EPLDLLEXPORT void PUBLIC EplObduCalInitVarEntry(tEplObdVarEntry MEM * 111 pVarEntry_p, BYTE bType_p, 112 tEplObdSize ObdSize_p); 113 //--------------------------------------------------------------------------- 114 EPLDLLEXPORT tEplObdSize PUBLIC EplObduCalGetDataSize(unsigned int uiIndex_p, 115 unsigned int 116 uiSubIndex_p); 117 //--------------------------------------------------------------------------- 118 EPLDLLEXPORT unsigned int PUBLIC EplObduCalGetNodeId(void); 119 //--------------------------------------------------------------------------- 120 EPLDLLEXPORT tEplKernel PUBLIC EplObduCalSetNodeId(unsigned int uiNodeId_p, 121 tEplObdNodeIdType 122 NodeIdType_p); 123 //--------------------------------------------------------------------------- 124 EPLDLLEXPORT tEplKernel PUBLIC EplObduCalGetAccessType(unsigned int uiIndex_p, 125 unsigned int 126 uiSubIndex_p, 127 tEplObdAccess * 128 pAccessTyp_p); 129 //--------------------------------------------------------------------------- 130 EPLDLLEXPORT tEplKernel PUBLIC EplObduCalReadEntryToLe(unsigned int uiIndex_p, 131 unsigned int 132 uiSubIndex_p, 133 void *pDstData_p, 134 tEplObdSize * pSize_p); 135 //--------------------------------------------------------------------------- 136 EPLDLLEXPORT tEplKernel PUBLIC EplObduCalWriteEntryFromLe(unsigned int 137 uiIndex_p, 138 unsigned int 139 uiSubIndex_p, 140 void *pSrcData_p, 141 tEplObdSize Size_p); 142 //--------------------------------------------------------------------------- 143 EPLDLLEXPORT tEplKernel PUBLIC 144 EplObduCalSearchVarEntry(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p, 145 unsigned int uiSubindex_p, 146 tEplObdVarEntry MEM ** ppVarEntry_p); 147 148 #endif // #ifndef _EPLOBDUCAL_H_ 149