etn_obj.h

00001 /*******************************************************************************
00002 ********************************************************************************
00003 **                                                                            **
00004 ** ABCC Starter Kit version 2.01.01 (2015-12-14)                              **
00005 **                                                                            **
00006 ** Delivered with:                                                            **
00007 **    ABCC Driver 4.01.01 (2015-12-14)                                        **
00008 **    ABP         7.16.01 (2015-10-14)                                        **
00009 **                                                                            */
00010 /*******************************************************************************
00011 ********************************************************************************
00012 ** COPYRIGHT NOTIFICATION (c) 2015 HMS Industrial Networks AB                 **
00013 **                                                                            **
00014 ** This code is the property of HMS Industrial Networks AB.                   **
00015 ** The source code may not be reproduced, distributed, or used without        **
00016 ** permission. When used together with a product from HMS, permission is      **
00017 ** granted to modify, reproduce and distribute the code in binary form        **
00018 ** without any restrictions.                                                  **
00019 **                                                                            **
00020 ** THE CODE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. HMS DOES NOT    **
00021 ** WARRANT THAT THE FUNCTIONS OF THE CODE WILL MEET YOUR REQUIREMENTS, OR     **
00022 ** THAT THE OPERATION OF THE CODE WILL BE UNINTERRUPTED OR ERROR-FREE, OR     **
00023 ** THAT DEFECTS IN IT CAN BE CORRECTED.                                       **
00024 ********************************************************************************
00025 ********************************************************************************
00026 ** This is the public header file for the Ethernet IO object.
00027 ********************************************************************************
00028 ********************************************************************************
00029 ** Services:
00030 **    ETN_ProcessCmdMsg()     - Processes commands sent to the ETN object.
00031 **
00032 ********************************************************************************
00033 ********************************************************************************
00034 */
00035 
00036 #ifndef ETN_H
00037 #define ETN_H
00038 
00039 /*******************************************************************************
00040 ** Constants
00041 ********************************************************************************
00042 */
00043 
00044 /*******************************************************************************
00045 ** Typedefs
00046 ********************************************************************************
00047 */
00048 
00049 /*------------------------------------------------------------------------------
00050 ** Structure storing attribute #16 'IP configuration' data
00051 **------------------------------------------------------------------------------
00052 */
00053 typedef union ETN_IpConfigType
00054 {
00055    UINT32 alIpConfig[ 3 ];
00056    struct
00057    {
00058       UINT32 lIpAddr;
00059       UINT32 lSnMask;
00060       UINT32 lGwAddr;
00061    }
00062    sAddr;
00063 }
00064 ETN_IpConfigType;
00065 
00066 /*******************************************************************************
00067 ** Public Globals
00068 ********************************************************************************
00069 */
00070 
00071 /*******************************************************************************
00072 ** Public Services
00073 ********************************************************************************
00074 */
00075 
00076 /*------------------------------------------------------------------------------
00077 ** Processes commands sent to the Ethernet object.
00078 **------------------------------------------------------------------------------
00079 ** Arguments:
00080 **    psNewMessage      - Pointer to a ABP_MsgType message.
00081 **
00082 ** Returns:
00083 **    None.
00084 **------------------------------------------------------------------------------
00085 */
00086 void ETN_ProcessCmdMsg( ABP_MsgType* psNewMessage );
00087 
00088 /*------------------------------------------------------------------------------
00089 ** Processes commands sent to the Ethernet object.
00090 **------------------------------------------------------------------------------
00091 ** Arguments:
00092 **    psIpConfig  - Pointer to structure to store current IP configuration
00093 **
00094 ** Returns:
00095 **    None.
00096 **------------------------------------------------------------------------------
00097 */
00098 void ETN_GetIpConfig( ETN_IpConfigType* psIpConfig );
00099 
00100 /*******************************************************************************
00101 ** Callbacks
00102 ********************************************************************************
00103 */
00104 
00105 /*------------------------------------------------------------------------------
00106 ** Optional user callback function that needs to be implememted by user
00107 ** if ETN_OBJ_USE_SET_ATTR_SUCCESS_CALLBACK is set to TRUE.
00108 **------------------------------------------------------------------------------
00109 ** Arguments:
00110 **    iInstance   - Object instance number
00111 **    bAttribute  - Object instance attribute number
00112 **
00113 ** Returns:
00114 **    None.
00115 **------------------------------------------------------------------------------
00116 */
00117 extern void ETN_SetAttrSuccessCallback( UINT16 iInstance, UINT8 bAttribute );
00118 
00119 #endif  /* inclusion lock */