userapps/broadcom/cfm/inc/objectdefs.h

   1 /*****************************************************************************
   2 //
   3 //  Copyright (c) 2004  Broadcom Corporation
   4 //  All Rights Reserved
   5 //  No portions of this material may be reproduced in any form without the
   6 //  written permission of:
   7 //          Broadcom Corporation
   8 //          16215 Alton Parkway
   9 //          Irvine, California 92619
  10 //  All information contained in this document is Broadcom Corporation
  11 //  company private, proprietary, and trade secret.
  12 //
  13 ******************************************************************************
  14 //
  15 //  Filename:       objectdefs.h
  16 //  Author:         Peter Tran
  17 //  Creation Date:  03/14/05
  18 //
  19 ******************************************************************************
  20 //  Description:
  21 //      Define the global types, enums. and constants for PSI in object format
  22 //
  23 *****************************************************************************/
  24
  25 #ifndef __OBJECT_DEFS_H__
  26 #define __OBJECT_DEFS_H__
  27
  28 /* important limitation: when adding the appName or objectName in either direction, it is
  29 important not to have appName and objName having the same prefix.   The table entry search
  30 only compare strings up to the prefix length, case not sensitive, to cover situation
  31 such as APP_ID wan_vpi_vci, only wan is searched in the table.    Therefore, it is not
  32 okay to have Lan as the appId, and objectName as lanSomethingSomething.    The search
  33 entry would think lanSomethingSomething is an appId name. */
  34
  35 #define APPNAME_WAN_PREFIX           "wan"
  36 #define APPNAME_IPSRV_PREFIX         "ipsrv"
  37 #define APPNAME_PPPSRV_PREFIX        "pppsrv"
  38 #define APPNAME_PPP_FORMAT           "pppsrv_%d_%d"
  39 #define APPNAME_IPSRV_ENTRY_FORMAT   "ipsrv_%d_%d"
  40 #define OBJNAME_LAN_ENTRY_FORMAT     "entry%d"   /* cannot be lan, need to change */
  41 #define OBJNAME_PPP_ENTRY_FORMAT     "ppp_conId%d"
  42 #define OBJNAME_IPSRV_ENTRY_FORMAT   "dhcpc_conId%d"
  43 #define OBJNAME_WAN_ENTRY_FORMAT     "entry%d"   /* cannot be wan, need to change */
  44 #define OBJNAME_GEN_ENTRY_FORMAT     "entry"
  45
  46 #define OBJNAME_DMZ_HOST             "dmzHost"
  47 #define OBJNAME_SRV_CTRL_LIST        "srvCtrlList"
  48 #define TBLNAME_VRT_SRV              "vrtSrv"
  49 #define ENTRYNAME_VRT_SRV            "vrtSrvEntry"
  50 #define TBLNAME_OUT_FILTER           "outFilter"
  51 #define ENTRYNAME_OUT_FILTER         "outFilterEntry"
  52 #define TBLNAME_IN_FILTER            "inFilter"
  53 #define ENTRYNAME_IN_FILTER          "inFilterEntry"
  54 #define TBLNAME_PRT_TRIGGER          "prtTrigger"
  55 #define ENTRYNAME_PRT_TRIGGER        "prtTriggerEntry"
  56 #define TBLNAME_MAC_FILTER           "macFilter"
  57 #define ENTRYNAME_MAC_FILTER         "macFilterEntry"
  58 #define TBLNAME_QOS_CLS              "qosCls"
  59 #define ENTRYNAME_QOS_CLS            "qosClsEntry"
  60 #define TBLNAME_ACC_CTRL             "accCtrl"
  61 #define ENTRYNAME_ACC_CTRL           "accCtrlEntry"
  62 #define OBJNAME_ACC_CTRL_MODE        "accCtrlMode"
  63 #define TBLNAME_ROUTE                "route"
  64 #define ENTRYNAME_ROUTE              "routeEntry"
  65 #define TBLNAME_RIP_IFC              "ripIfc"
  66 #define ENTRYNAME_RIP_IFC            "ripIfcEntry"
  67 #define OBJNAME_RIP_GLOBAL           "ripGlobal"
  68 #if SUPPORT_PORT_MAP
  69 #define TBLNAME_PMAP                 "pmap"
  70 #define ENTRYNAME_PMAP               "pmapEntry"
  71 #define OBJNAME_PMAP_IFC_CFG         "pmapIfcCfg"
  72 #endif
  73 #ifdef SUPPORT_DDNSD
  74 #define TBLNAME_DDNS                 "ddns"
  75 #define ENTRYNAME_DDNS               "ddnsEntry"
  76 #endif
  77 #ifdef WIRELESS
  78 #define TBLNAME_WL_MSSID_VARS        "wlMssidVars"
  79 #define TBLNAME_WL_MAC_FILTER        "wlMacFilter"
  80 #define TBLNAME_WDS_FILTER           "wdsFilter"
  81 #define TBLNAME_SCAN_WDS_FILTER      "scanWdsFilter"
  82 #define ENTRYNAME_WL_MSSID_VARS      "wlMssidEntry"
  83 #define ENTRYNAME_WL_MAC_FILTER      "wlMacEntry"
  84 #define ENTRYNAME_WDS_FILTER         "wdsEntry"
  85 #define ENTRYNAME_SCAN_WDS_FILTER    "scanWdsEntry"
  86 #endif
  87 #ifdef SUPPORT_TOD
  88 #define TBLNAME_PARENT_CNTRL         "parentCntrl"
  89 #define ENTRYNAME_PARENT_CNTRL       "parentCntrlTbl"
  90 #endif
  91 #ifdef SUPPORT_IPSEC
  92 #define TBLNAME_IPSEC                "ipsconn"
  93 #define ENTRYNAME_IPSEC              "ipsconnEntry"
  94 #define PSX_OBJ_IPSEC_LICENSE_KEY    "ipslicense"
  95 #endif
  96 #ifdef SUPPORT_CERT
  97 #define TBLNAME_CERT_LOCAL           "certLocal"
  98 #define ENTRYNAME_CERT_LOCAL         "certLocalEntry"
  99 #define TBLNAME_CERT_CA              "certCA"
 100 #define ENTRYNAME_CERT_CA            "certCAEntry"
 101 #endif
 102
 103 #ifdef PORT_MIRRORING
 104 #define TBLNAME_PORT_MIRROR_CFG      "portMirrorCfg"
 105 #define ENTRYNAME_PORT_MIRROR_CFG    "portMirrorCfgEntry"
 106 #define OBJNAME_PORT_MIRROR_STATUS   "portMirrorStatus"
 107 #endif
 108
 109 /* system info */
 110 #define PSX_OBJ_SYS_USER_NAME      "sysUserName"
 111 #define PSX_OBJ_SYS_PASSWORD       "sysPassword"
 112 #define PSX_OBJ_SPT_USER_NAME      "sptUserName"
 113 #define PSX_OBJ_SPT_PASSWORD       "sptPassword"
 114 #define PSX_OBJ_USR_USER_NAME      "usrUserName"
 115 #define PSX_OBJ_USR_PASSWORD       "usrPassword"
 116
 117 #ifdef SUPPORT_TR69C
 118 #define PSX_OBJ_TR69C                       "tr69c"
 119 #endif
 120 #define PSX_OBJ_SOFTWARE_VERSION   "swVersion"
 121 #define PSX_OBJ_HARDWARE_VERSION   "hwVersion"
 122 #define PSX_OBJ_SYSLOG_DATA        "sysLogData"
 123 #define PSX_OBJ_DEF_GATEWAY        "defaultGateway"
 124 #define PSX_OBJ_DNS                "dns"
 125 #define PSX_OBJ_SYSLOG             "sysLog"
 126 #define PSX_OBJ_SNMP               "snmp"
 127 #define PSX_OBJ_PROTOCOL           "protocol"
 128 #define PSX_OBJ_ETHCFG             "ethCfg"
 129 #define PSX_OBJ_MGCP_CFG           "mgcpCfg"
 130 #define PSX_OBJ_SIP_CFG            "sipCfg"
 131
 132
 133 #define PSX_ATTR_DNS_PRIMARY       "primary"
 134 #define PSX_ATTR_DNS_SECONDARY     "secondary"
 135 #define PSX_ATTR_DNS_DYNAMIC       "dynamic"
 136
 137 #define PSX_ATTR_SYSLOG_DISPLAY_LEVEL "displayLevel"
 138 #define PSX_ATTR_SYSLOG_LOG_LEVEL     "logLevel"
 139 #define PSX_ATTR_SYSLOG_OPTION        "option"
 140 #define PSX_ATTR_SYSLOG_SERVER_IP     "serverIP"
 141 #define PSX_ATTR_SYSLOG_SERVER_PORT   "serverPort"
 142
 143 #define PSX_ATTR_PMAP_IFC_NAME        "pmapIfName"
 144 #define PSX_ATTR_PMAP_IFC_STATUS      "pmapIfcStatus"
 145
 146 #define PSX_ATTR_VOICE_MGCP_TAG            "mgcpCfg"
 147 #define PSX_ATTR_VOICE_MGCP_CA_ADDR        "caAddr"
 148 #define PSX_ATTR_VOICE_MGCP_GW_NAME        "gwName"
 149 #define PSX_ATTR_VOICE_MGCP_IF_NAME        "ifName"
 150 #define PSX_ATTR_VOICE_MGCP_PREF_CODEC     "prefCodec"
 151 #define PSX_ATTR_VOICE_SIP_TAG             "sipCfg"
 152 #define PSX_ATTR_VOICE_SIP_PROXY_ADDR      "proxyAddr"
 153 #define PSX_ATTR_VOICE_SIP_PROXY_PORT      "proxyPort"
 154 #define PSX_ATTR_VOICE_SIP_OBPROXY_ADDR    "obProxyAddr"
 155 #define PSX_ATTR_VOICE_SIP_OBPROXY_PORT    "obProxyPort"
 156 #define PSX_ATTR_VOICE_SIP_REGISTRAR_ADDR  "regAddr"
 157 #define PSX_ATTR_VOICE_SIP_REGISTRAR_PORT  "regPort"
 158 #define PSX_ATTR_VOICE_SIP_LOG_ADDR        "sipLogAddr"
 159 #define PSX_ATTR_VOICE_SIP_LOG_PORT        "sipLogPort"
 160 #define PSX_ATTR_VOICE_SIP_EXT1            "extension1"
 161 #define PSX_ATTR_VOICE_SIP_PASSWORD1       "password1"
 162 #define PSX_ATTR_VOICE_SIP_EXT2            "extension2"
 163 #define PSX_ATTR_VOICE_SIP_PASSWORD2       "password2"
 164 #define PSX_ATTR_VOICE_SIP_EXT3            "extension3"
 165 #define PSX_ATTR_VOICE_SIP_PASSWORD3       "password3"
 166 #define PSX_ATTR_VOICE_SIP_EXT4            "extension4"
 167 #define PSX_ATTR_VOICE_SIP_PASSWORD4       "password4"
 168 #define PSX_ATTR_VOICE_SIP_IF_NAME         "ifName"
 169 #define PSX_ATTR_VOICE_SIP_DOMAIN_NAME     "domainName"
 170 #define PSX_ATTR_VOICE_LOCALE_NAME         "localeName"
 171 #define PSX_ATTR_VOICE_CODEC_NAME          "voiceCodec"
 172 #define PSX_ATTR_VOICE_PTIME               "voicePtime"
 173 #define PSX_ATTR_VOICE_PSTN_ROUTE_RULE     "pstnRouteRule"
 174 #define PSX_ATTR_VOICE_PSTN_ROUTE_DATA     "pstnRouteData"
 175 #define PSX_ATTR_VOICE_STORE               "store" // To indicate a write to flash
 176 #ifdef STUN_CLIENT
 177 #define PSX_ATTR_VOICE_STUN_SRV_ADDR       "stunSrvAddr"
 178 #define PSX_ATTR_VOICE_STUN_SRV_PORT       "stunSrvPort"
 179 #endif /* STUN_CLIENT */
 180
 181 #define PSX_ATTR_ETH_CFG_SPEED        "speed"
 182 #define PSX_ATTR_ETH_CFG_TYPE         "type"
 183 #define PSX_ATTR_ETH_CFG_MTU          "MTU"
 184 #define PSX_ATTR_IPP_MAKE             "make"
 185 #define PSX_ATTR_IPP_DEV              "dev"
 186 #define PSX_ATTR_IPP_NAME             "name"
 187
 188 // parameter for OBJ_SYSTEM_ACTION
 189 // get operation
 190 #define OBJ_SYSTEM_PSI_CHANGE_NUM     0
 191 #define OBJ_SYSTEM_LAN_DEVICE_NUM     1
 192 #define OBJ_SYSTEM_LAN_STATISTICS     2
 193 #define OBJ_SYSTEM_WAN_DEVICE_NUM     3
 194 #define OBJ_SYSTEM_WAN_STATISTICS     4
 195
 196 // wan statistic fields
 197 #define STS_FROM_LAN                  0
 198 #define STS_FROM_WAN                  1
 199 #define OBJ_STS_IFC_COLS              8
 200 #define OBJ_STS_RX_BYTE               0
 201 #define OBJ_STS_RX_PACKET             1
 202 #define OBJ_STS_RX_ERR                2
 203 #define OBJ_STS_RX_DROP               3
 204 #define OBJ_STS_TX_BYTE               4
 205 #define OBJ_STS_TX_PACKET             5
 206 #define OBJ_STS_TX_ERR                6
 207 #define OBJ_STS_TX_DROP               7
 208 #define OBJ_STS_ALL                   8
 209
 210 // set operation
 211 #define OBJ_SYSTEM_REBOOT             0
 212 #define OBJ_SYSTEM_SAVE_CONFIG        1
 213 #define OBJ_SYSTEM_SAVE_IMAGE         2
 214 #define OBJ_SYSTEM_RESTORE_DEFAULT    3
 215 #define OBJ_SYSTEM_KILL_APPS          4
 216 // get operation
 217 // variable name
 218 #define OBJ_SYSTEM_ACTION             "systemAction"
 219
 220 // parameters for IFC_LAN_INFO
 221 #define OBJ_LAN_INFO               0
 222 #define OBJ_LAN_IP_ADDRESS         1
 223 #define OBJ_LAN_SUBNET_MASK        2
 224 #define OBJ_DHCP_SRV_ENABLE        3
 225 #define OBJ_DHCP_SRV_LEASE_TIME    4
 226 #define OBJ_DHCP_SRV_START_ADDR    5
 227 #define OBJ_DHCP_SRV_END_ADDR      6
 228
 229 // parameter for IFC_ATM_TD_INFO
 230 // get & set operation
 231 #define OBJ_TD_INFO                0
 232 #define OBJ_TD_PEAK_CELL_RATE      1
 233 #define OBJ_TD_SUSTAINED_CELL_RATE 2
 234 #define OBJ_TD_MAX_BURST_SIZE      3
 235 #define OBJ_TD_SERVICE_CATEGORY    4
 236 // get operation
 237 #define OBJ_TD_ID_FROM_INFO        5
 238 #define OBJ_TD_ID_FROM_INDEX       6
 239 #define OBJ_TD_ID_AVAILABLE        7
 240
 241 // parameter for IFC_ATM_VCC_INFO
 242 // get & set operation
 243 #define OBJ_VCC_INFO               0
 244 #define OBJ_VCC_TD_ID              1
 245 #define OBJ_VCC_AAL_TYPE           2
 246 #define OBJ_VCC_ADMIN_STATUS       3
 247 #define OBJ_VCC_ENCAP_MODE         4
 248 #define OBJ_VCC_ENABLE_QOS         5
 249 #define OBJ_VCC_VPI                6
 250 #define OBJ_VCC_VCI                7
 251 #define OBJ_VCC_IFC_ID             8
 252 // get operation
 253 #define OBJ_VCC_ID_FROM_ADDRESS    9
 254 #define OBJ_VCC_ID_AVAILABLE       10
 255 // delete operation
 256 #define OBJ_VCC_DELETE_BY_ID       11
 257 #define OBJ_VCC_DELETE_BY_ADDRESS  12
 258
 259 // parameter for WAN_CON_INFO
 260 // get & set operation
 261 #define OBJ_WAN_CON_INFO           0
 262 #define OBJ_WAN_VCC_ID             1
 263 #define OBJ_WAN_CON_ID             2
 264 #define OBJ_WAN_PROTOCOL           3
 265 #define OBJ_WAN_ENCAP_MODE         4
 266 #define OBJ_WAN_CON_NAME           5
 267 #define OBJ_WAN_FLAG_FIREWALL      6
 268 #define OBJ_WAN_FLAG_NAT           7
 269 #define OBJ_WAN_FLAG_IGMP          8
 270 #define OBJ_WAN_FLAG_SERVICE       9
 271 // get operation
 272 #define OBJ_WAN_ID_AVAILABLE       20
 273
 274 // parameter for WAN_PPP_INFO
 275 // get & set operation
 276 #define OBJ_PPP_INFO               0
 277 #define OBJ_PPP_IDLE_TIMEOUT       1
 278 #define OBJ_PPP_IP_EXTENSION       2
 279 #define OBJ_PPP_AUTH_METHOD        3
 280 #define OBJ_PPP_USER_NAME          4
 281 #define OBJ_PPP_PASSWORD           5
 282 #define OBJ_PPP_SERVICE_NAME       6
 283 #define OBJ_PPP_USE_STATIC_IP_ADDR 7
 284 #define OBJ_PPP_LOCAL_IP_ADDR      8
 285
 286 // parameter for WAN_IP_INFO
 287 // get & set operation
 288 #define OBJ_IP_INFO                0
 289 #define OBJ_IP_ENABLE_DHCP_CLNT    1
 290 #define OBJ_IP_WAN_IP_ADDR         2
 291 #define OBJ_IP_WAN_SUBNET_MASK     3
 292
 293 // parameter for DDNSD
 294 // set operation
 295 #ifdef SUPPORT_DDNSD
 296 #define OBJ_DDNSD_INIT             0
 297 #define OBJ_DDNSD_RESTART          1
 298 #define OBJ_DDNSD_ADD              2
 299 #define OBJ_DDNSD_STORE            3
 300 #define OBJ_DDNSD_CLOSE            4
 301 #endif   // SUPPORT_DDNSD
 302
 303 // parameter for SNTP
 304 // set operation
 305 #ifdef SUPPORT_SNTP
 306 #define OBJ_SNTP_INIT              0
 307 #define OBJ_SNTP_RESTART           1
 308 #define OBJ_STNP_SET_VAR           2
 309 #define OBJ_SNTP_STORE             3
 310 #define OBJ_SNTP_CLOSE             4
 311 // variable name
 312 #define OBJ_SNTP_SERVER_1          "ntpServer1"
 313 #define OBJ_SNTP_SERVER_2          "ntpServer2"
 314 #define OBJ_SNTP_TIMEZONE          "timezone"
 315 #define OBJ_SNTP_ENABLED           "ntp_enabled"
 316 #define OBJ_SNTP_USE_DST           "use_dst"
 317 #define OBJ_SNTP_OFFSET            "timezone_offset"
 318 #define OBJ_SNTP_DST_START         "dst_start"
 319 #define OBJ_SNTP_DST_END           "dst_end"
 320 #define OBJ_SNTP_REFRESH           "sntpRefresh"
 321 #endif   // SUPPORT_SNTP
 322
 323 // parameter for IPP
 324 // set operation
 325 #ifdef SUPPORT_IPP
 326 #define OBJ_IPP_INIT               0
 327 #define OBJ_IPP_RESTART            1
 328 #define OBJ_IPP_SET_VAR            2
 329 #define OBJ_IPP_STORE              3
 330 #define OBJ_IPP_CLOSE              4
 331 // variable name
 332 #define OBJ_IPP_ENABLED            "ipp_enabled"
 333 #define OBJ_IPP_REFRESH            "ippRefresh"
 334 #define OBJ_IPP_MAKE               "ippMake"
 335 #define OBJ_IPP_DEV                "ippDev"
 336 #define OBJ_IPP_NAME               "ippName"
 337 #endif   // SUPPORT_IPP
 338
 339 // parameter for TOD
 340 // set operation
 341 #ifdef SUPPORT_TOD
 342 #define OBJ_TOD_INIT               0
 343 #define OBJ_TOD_ADD                1
 344 #define OBJ_TOD_STORE              2
 345 #endif   // SUPPORT_TOD
 346
 347 #endif /* __OBJECT_DEFS_H__ */