ConOpSys V2970  P004.07
ANVILEX control operating system
etn_obj.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ********************************************************************************
3 ** **
4 ** ABCC Starter Kit version 3.04.01 (2018-01-23) **
5 ** **
6 ** Delivered with: **
7 ** ABP 7.55.01 (2017-12-20) **
8 ** ABCC Driver 5.04.01 (2017-12-18) **
9 ** */
10 /*******************************************************************************
11 ********************************************************************************
12 ** COPYRIGHT NOTIFICATION (c) 2015 HMS Industrial Networks AB **
13 ** **
14 ** This code is the property of HMS Industrial Networks AB. **
15 ** The source code may not be reproduced, distributed, or used without **
16 ** permission. When used together with a product from HMS, permission is **
17 ** granted to modify, reproduce and distribute the code in binary form **
18 ** without any restrictions. **
19 ** **
20 ** THE CODE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. HMS DOES NOT **
21 ** WARRANT THAT THE FUNCTIONS OF THE CODE WILL MEET YOUR REQUIREMENTS, OR **
22 ** THAT THE OPERATION OF THE CODE WILL BE UNINTERRUPTED OR ERROR-FREE, OR **
23 ** THAT DEFECTS IN IT CAN BE CORRECTED. **
24 ********************************************************************************
25 ********************************************************************************
26 ** This is the public header file for the Ethernet IO object.
27 ********************************************************************************
28 ********************************************************************************
29 ** Services:
30 ** ETN_ProcessCmdMsg() - Processes commands sent to the ETN object.
31 **
32 ********************************************************************************
33 ********************************************************************************
34 */
35 
36 #ifndef ETN_H
37 #define ETN_H
38 
39 /*******************************************************************************
40 ** Constants
41 ********************************************************************************
42 */
43 
44 /*******************************************************************************
45 ** Typedefs
46 ********************************************************************************
47 */
48 
49 /*------------------------------------------------------------------------------
50 ** Structure storing attribute #16 'IP configuration' data
51 **------------------------------------------------------------------------------
52 */
53 typedef union ETN_IpConfigType
54 {
55  U32 alIpConfig[ 3 ];
56  struct
57  {
58  U32 lIpAddr;
59  U32 lSnMask;
60  U32 lGwAddr;
61  }
62  sAddr;
63 }
64 ETN_IpConfigType;
65 
66 /*******************************************************************************
67 ** Public Globals
68 ********************************************************************************
69 */
70 
71 /*******************************************************************************
72 ** Public Services
73 ********************************************************************************
74 */
75 
76 /*------------------------------------------------------------------------------
77 ** Processes commands sent to the Ethernet object.
78 **------------------------------------------------------------------------------
79 ** Arguments:
80 ** psNewMessage - Pointer to a ABP_MsgType message.
81 **
82 ** Returns:
83 ** None.
84 **------------------------------------------------------------------------------
85 */
86 void ETN_ProcessCmdMsg( ABP_MsgType* psNewMessage );
87 
88 /*------------------------------------------------------------------------------
89 ** Processes commands sent to the Ethernet object.
90 **------------------------------------------------------------------------------
91 ** Arguments:
92 ** psIpConfig - Pointer to structure to store current IP configuration
93 **
94 ** Returns:
95 ** None.
96 **------------------------------------------------------------------------------
97 */
98 void ETN_GetIpConfig( ETN_IpConfigType* psIpConfig );
99 
100 /*******************************************************************************
101 ** Callbacks
102 ********************************************************************************
103 */
104 
105 /*------------------------------------------------------------------------------
106 ** Optional user callback function that needs to be implememted by user
107 ** if ETN_OBJ_USE_SET_ATTR_SUCCESS_CALLBACK is set to TRUE.
108 **------------------------------------------------------------------------------
109 ** Arguments:
110 ** iInstance - Object instance number
111 ** bAttribute - Object instance attribute number
112 **
113 ** Returns:
114 ** None.
115 **------------------------------------------------------------------------------
116 */
117 extern void ETN_SetAttrSuccessCallback( U16 iInstance, U8 bAttribute );
118 
119 #endif /* inclusion lock */
U8
unsigned char U8
Binary 8-Bit unsigned integer datatype defenition.
Definition: Defines.h:183
U32
unsigned long U32
Binary 32-Bit unsigned integer datatype defenition.
Definition: Defines.h:203
U16
unsigned short U16
Binary 16-Bit unsigned integer datatype defenition.
Definition: Defines.h:193
ETN_SetAttrSuccessCallback
void ETN_SetAttrSuccessCallback(U16 iInstance, U8 bAttribute)
ETN_IpConfigType
union ETN_IpConfigType ETN_IpConfigType
ETN_ProcessCmdMsg
void ETN_ProcessCmdMsg(ABP_MsgType *psNewMessage)
ETN_GetIpConfig
void ETN_GetIpConfig(ETN_IpConfigType *psIpConfig)
ETN_IpConfigType
Definition: etn_obj.h:54
ETN_IpConfigType::lGwAddr
U32 lGwAddr
Definition: etn_obj.h:60
ETN_IpConfigType::alIpConfig
U32 alIpConfig[3]
Definition: etn_obj.h:55
ETN_IpConfigType::lSnMask
U32 lSnMask
Definition: etn_obj.h:59
ETN_IpConfigType::lIpAddr
U32 lIpAddr
Definition: etn_obj.h:58
ETN_IpConfigType::sAddr
struct ETN_IpConfigType::@73 sAddr
Generated on Thu Mar 10 2022 03:50:15 for ConOpSys V2970 by doxygen 1.9.1