William Kane / Generic

Dependents:   LaserioLib

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers abp_etn.h Source File

abp_etn.h

00001 /*******************************************************************************
00002 ********************************************************************************
00003 **                                                                            **
00004 ** ABP version 7.16.01 (2015-10-14)                                           **
00005 **                                                                            */
00006 /*******************************************************************************
00007 ********************************************************************************
00008 **
00009 ** File Name
00010 ** ---------
00011 **
00012 ** abp_etn.h
00013 **
00014 ********************************************************************************
00015 ********************************************************************************
00016 **
00017 ** Description
00018 ** -----------
00019 **
00020 ** ABP - Anybus-CC Protocol Definitions for Ethernet Object.
00021 **
00022 ** This file contains network specific definitions used by the Anybus-CC
00023 ** Ethernet module as well as applications designed to use such module.
00024 **
00025 ********************************************************************************
00026 ********************************************************************************
00027 **                                                                            **
00028 ** COPYRIGHT NOTIFICATION (c) 2008 HMS Industrial Networks AB                 **
00029 **                                                                            **
00030 ** This code is the property of HMS Industrial Networks AB.                   **
00031 ** The source code may not be reproduced, distributed, or used without        **
00032 ** permission. When used together with a product from HMS, this code can be   **
00033 ** modified, reproduced and distributed in binary form without any            **
00034 ** restrictions.                                                              **
00035 **                                                                            **
00036 ** THE CODE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. HMS DOES NOT    **
00037 ** WARRANT THAT THE FUNCTIONS OF THE CODE WILL MEET YOUR REQUIREMENTS, OR     **
00038 ** THAT THE OPERATION OF THE CODE WILL BE UNINTERRUPTED OR ERROR-FREE, OR     **
00039 ** THAT DEFECTS IN IT CAN BE CORRECTED.                                       **
00040 **                                                                            **
00041 ********************************************************************************
00042 ********************************************************************************
00043 */
00044 
00045 #ifndef ABP_ETN_H
00046 #define ABP_ETN_H
00047 
00048 
00049 /*******************************************************************************
00050 **
00051 ** Anybus-CC Ethernet object constants.
00052 **
00053 ** Object revision: 2.
00054 **
00055 ********************************************************************************
00056 */
00057 
00058 /*------------------------------------------------------------------------------
00059 **
00060 ** The Anybus-CC Ethernet Object instance attributes.
00061 **
00062 **------------------------------------------------------------------------------
00063 */
00064 
00065 #define ABP_ETN_IA_MAC_ADDRESS                 1
00066 #define ABP_ETN_IA_ENABLE_HICP                 2
00067 #define ABP_ETN_IA_ENABLE_WEB                  3
00068 #define ABP_ETN_IA_ENABLE_MOD_TCP              4
00069 #define ABP_ETN_IA_ENABLE_WEB_ADI_ACCESS       5
00070 #define ABP_ETN_IA_ENABLE_FTP                  6
00071 #define ABP_ETN_IA_ENABLE_ADMIN_MODE           7
00072 #define ABP_ETN_IA_NETWORK_STATUS              8
00073 #define ABP_ETN_IA_PORT1_MAC_ADDRESS           9
00074 #define ABP_ETN_IA_PORT2_MAC_ADDRESS           10
00075 #define ABP_ETN_IA_ENABLE_ACD                  11
00076 #define ABP_ETN_IA_PORT1_STATE                 12
00077 #define ABP_ETN_IA_PORT2_STATE                 13
00078 #define ABP_ETN_IA_ENABLE_WEB_UPDATE           14
00079 #define ABP_ETN_IA_ENABLE_HICP_RESET           15
00080 #define ABP_ETN_IA_IP_CONFIGURATION            16
00081 #define ABP_ETN_IA_IP_ADDRESS_BYTE_0_2         17
00082 
00083 /*------------------------------------------------------------------------------
00084 **
00085 ** The data size of the Anybus-CC Ethernet Object instance attributes (in
00086 ** bytes).
00087 **
00088 **------------------------------------------------------------------------------
00089 */
00090 
00091 #define ABP_ETN_IA_MAC_ADDRESS_DS               ( 6 * ABP_UINT8_SIZEOF )
00092 #define ABP_ETN_IA_ENABLE_HICP_DS               ABP_BOOL_SIZEOF
00093 #define ABP_ETN_IA_ENABLE_WEB_DS                ABP_BOOL_SIZEOF
00094 #define ABP_ETN_IA_ENABLE_MOD_TCP_DS            ABP_BOOL_SIZEOF
00095 #define ABP_ETN_IA_ENABLE_WEB_ADI_ACCESS_DS     ABP_BOOL_SIZEOF
00096 #define ABP_ETN_IA_ENABLE_FTP_DS                ABP_BOOL_SIZEOF
00097 #define ABP_ETN_IA_ENABLE_ADMIN_MODE_DS         ABP_BOOL_SIZEOF
00098 #define ABP_ETN_IA_NETWORK_STATUS_DS            ABP_UINT16_SIZEOF
00099 #define ABP_ETN_IA_PORT1_MAC_ADDRESS_DS         ( 6 * ABP_UINT8_SIZEOF )
00100 #define ABP_ETN_IA_PORT2_MAC_ADDRESS_DS         ( 6 * ABP_UINT8_SIZEOF )
00101 #define ABP_ETN_IA_ENABLE_ACD_DS                ABP_BOOL_SIZEOF
00102 #define ABP_ETN_IA_PORT1_STATE_DS               ABP_ENUM_SIZEOF
00103 #define ABP_ETN_IA_PORT2_STATE_DS               ABP_ENUM_SIZEOF
00104 #define ABP_ETN_IA_ENABLE_WEB_UPDATE_DS         ABP_BOOL_SIZEOF
00105 #define ABP_ETN_IA_ENABLE_HICP_RESET_DS         ABP_BOOL_SIZEOF
00106 #define ABP_ETN_IA_IP_CONFIGURATION_DS          ( 3 * ABP_UINT32_SIZEOF )
00107 #define ABP_ETN_IA_IP_ADDRESS_BYTE_0_2_DS       ( 3 * ABP_UINT8_SIZEOF )
00108 
00109 
00110 /*------------------------------------------------------------------------------
00111 **
00112 ** Network status attribute bit definitions.
00113 **
00114 **------------------------------------------------------------------------------
00115 */
00116 
00117 #define ABP_ETN_IA_NETWORK_STATUS_LINK           0x0001
00118 #define ABP_ETN_IA_NETWORK_STATUS_IP_INUSE       0x0002
00119 #define ABP_ETN_IA_NETWORK_STATUS_IP_CONFLICT    0x0004
00120 #define ABP_ETN_IA_NETWORK_STATUS_LINK_PORT1     0x0008
00121 #define ABP_ETN_IA_NETWORK_STATUS_LINK_PORT2     0x0010
00122 
00123 
00124 /*------------------------------------------------------------------------------
00125 **
00126 ** Port 1 and Port 2 state attribute values
00127 **
00128 **------------------------------------------------------------------------------
00129 */
00130 
00131 typedef enum ABP_EtnPortStateType
00132 {
00133    ABP_ETN_IA_PORT_STATE_ENABLE     = 0x00, /* Enable Ethernet port           */
00134    ABP_ETN_IA_PORT_STATE_DISABLE    = 0x01, /* Disable Ethernet port          */
00135 
00136    ABP_ETN_IA_PORT_STATE_NUM_VALUES         /* Number of port states          */
00137 }
00138 ABP_EtnPortStateType;
00139 
00140 #endif  /* inclusion lock */
00141 
00142 /*******************************************************************************
00143 **
00144 ** End of abp_etn.h
00145 **
00146 ********************************************************************************
00147 */