www.infradead.org Git - users/jedix/linux-maple.git/blob

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 EplObduCalWriteEntry(unsigned int uiIndex_p,

89 unsigned int uiSubIndex_p,

90 void *pSrcData_p,

91 tEplObdSize Size_p);

92 //---------------------------------------------------------------------------

93 EPLDLLEXPORT tEplKernel EplObduCalReadEntry(unsigned int uiIndex_p,

94 unsigned int uiSubIndex_p,

95 void *pDstData_p,

96 tEplObdSize * pSize_p);

97 //---------------------------------------------------------------------------

98 EPLDLLEXPORT tEplKernel EplObduCalAccessOdPart(tEplObdPart ObdPart_p,

99 tEplObdDir Direction_p);

100 //---------------------------------------------------------------------------

101 EPLDLLEXPORT tEplKernel EplObduCalDefineVar(tEplVarParam *pVarParam_p);

102 //---------------------------------------------------------------------------

103 EPLDLLEXPORT void *EplObduCalGetObjectDataPtr(unsigned int uiIndex_p,

104 unsigned int uiSubIndex_p);

105 //---------------------------------------------------------------------------

106 EPLDLLEXPORT tEplKernel EplObduCalRegisterUserOd(tEplObdEntryPtr pUserOd_p);

107 //---------------------------------------------------------------------------

108 EPLDLLEXPORT void EplObduCalInitVarEntry(tEplObdVarEntry *pVarEntry_p,

109 u8 bType_p, tEplObdSize ObdSize_p);

110 //---------------------------------------------------------------------------

111 EPLDLLEXPORT tEplObdSize EplObduCalGetDataSize(unsigned int uiIndex_p,

112 unsigned int uiSubIndex_p);

113 //---------------------------------------------------------------------------

114 EPLDLLEXPORT unsigned int EplObduCalGetNodeId(void);

115 //---------------------------------------------------------------------------

116 EPLDLLEXPORT tEplKernel EplObduCalSetNodeId(unsigned int uiNodeId_p,

117 tEplObdNodeIdType NodeIdType_p);

118 //---------------------------------------------------------------------------

119 EPLDLLEXPORT tEplKernel EplObduCalGetAccessType(unsigned int uiIndex_p,

120 unsigned int uiSubIndex_p,

121 tEplObdAccess *pAccessTyp_p);

122 //---------------------------------------------------------------------------

123 EPLDLLEXPORT tEplKernel EplObduCalReadEntryToLe(unsigned int uiIndex_p,

124 unsigned int uiSubIndex_p,

125 void *pDstData_p,

126 tEplObdSize *pSize_p);

127 //---------------------------------------------------------------------------

128 EPLDLLEXPORT tEplKernel EplObduCalWriteEntryFromLe(unsigned int uiIndex_p,

129 unsigned int uiSubIndex_p,

130 void *pSrcData_p,

131 tEplObdSize Size_p);

132 //---------------------------------------------------------------------------

133 EPLDLLEXPORT tEplKernel

134 EplObduCalSearchVarEntry(EPL_MCO_DECL_INSTANCE_PTR_ unsigned int uiIndex_p,

135 unsigned int uiSubindex_p,

136 tEplObdVarEntry **ppVarEntry_p);

137

138 #endif // #ifndef _EPLOBDUCAL_H_