begriffs open source - freertos/blob - 20100923-V6.1.0-RC2/Demo/Common/ethernet/lwIP_130/src/include/lwip/snmp.h

   1 /*\r
   2  * Copyright (c) 2001, 2002 Leon Woestenberg <leon.woestenberg@axon.tv>\r
   3  * Copyright (c) 2001, 2002 Axon Digital Design B.V., The Netherlands.\r
   4  * All rights reserved.\r
   5  *\r
   6  * Redistribution and use in source and binary forms, with or without modification,\r
   7  * are permitted provided that the following conditions are met:\r
   8  *\r
   9  * 1. Redistributions of source code must retain the above copyright notice,\r
  10  *    this list of conditions and the following disclaimer.\r
  11  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  12  *    this list of conditions and the following disclaimer in the documentation\r
  13  *    and/or other materials provided with the distribution.\r
  14  * 3. The name of the author may not be used to endorse or promote products\r
  15  *    derived from this software without specific prior written permission.\r
  16  *\r
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED\r
  18  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT\r
  20  * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,\r
  21  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT\r
  22  * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\r
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING\r
  25  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY\r
  26  * OF SUCH DAMAGE.\r
  27  *\r
  28  * This file is part of the lwIP TCP/IP stack.\r
  29  *\r
  30  * Author: Leon Woestenberg <leon.woestenberg@axon.tv>\r
  31  *\r
  32  */\r
  33 #ifndef __LWIP_SNMP_H__\r
  34 #define __LWIP_SNMP_H__\r
  35 \r
  36 #include "lwip/opt.h"\r
  37 #include "lwip/netif.h"\r
  38 #include "lwip/udp.h"\r
  39 \r
  40 #ifdef __cplusplus\r
  41 extern "C" {\r
  42 #endif\r
  43 \r
  44 /**\r
  45  * @see RFC1213, "MIB-II, 6. Definitions"\r
  46  */\r
  47 enum snmp_ifType {\r
  48   snmp_ifType_other=1,                /* none of the following */\r
  49   snmp_ifType_regular1822,\r
  50   snmp_ifType_hdh1822,\r
  51   snmp_ifType_ddn_x25,\r
  52   snmp_ifType_rfc877_x25,\r
  53   snmp_ifType_ethernet_csmacd,\r
  54   snmp_ifType_iso88023_csmacd,\r
  55   snmp_ifType_iso88024_tokenBus,\r
  56   snmp_ifType_iso88025_tokenRing,\r
  57   snmp_ifType_iso88026_man,\r
  58   snmp_ifType_starLan,\r
  59   snmp_ifType_proteon_10Mbit,\r
  60   snmp_ifType_proteon_80Mbit,\r
  61   snmp_ifType_hyperchannel,\r
  62   snmp_ifType_fddi,\r
  63   snmp_ifType_lapb,\r
  64   snmp_ifType_sdlc,\r
  65   snmp_ifType_ds1,                    /* T-1 */\r
  66   snmp_ifType_e1,                     /* european equiv. of T-1 */\r
  67   snmp_ifType_basicISDN,\r
  68   snmp_ifType_primaryISDN,            /* proprietary serial */\r
  69   snmp_ifType_propPointToPointSerial,\r
  70   snmp_ifType_ppp,\r
  71   snmp_ifType_softwareLoopback,\r
  72   snmp_ifType_eon,                    /* CLNP over IP [11] */\r
  73   snmp_ifType_ethernet_3Mbit,\r
  74   snmp_ifType_nsip,                   /* XNS over IP */\r
  75   snmp_ifType_slip,                   /* generic SLIP */\r
  76   snmp_ifType_ultra,                  /* ULTRA technologies */\r
  77   snmp_ifType_ds3,                    /* T-3 */\r
  78   snmp_ifType_sip,                    /* SMDS */\r
  79   snmp_ifType_frame_relay\r
  80 };\r
  81 \r
  82 #if LWIP_SNMP /* don't build if not configured for use in lwipopts.h */\r
  83 \r
  84 /** SNMP "sysuptime" Interval */\r
  85 #define SNMP_SYSUPTIME_INTERVAL 10\r
  86 \r
  87 /** fixed maximum length for object identifier type */\r
  88 #define LWIP_SNMP_OBJ_ID_LEN 32\r
  89 \r
  90 /** internal object identifier representation */\r
  91 struct snmp_obj_id\r
  92 {\r
  93   u8_t len;\r
  94   s32_t id[LWIP_SNMP_OBJ_ID_LEN];\r
  95 };\r
  96 \r
  97 /* system */\r
  98 void snmp_set_sysdesr(u8_t* str, u8_t* len);\r
  99 void snmp_set_sysobjid(struct snmp_obj_id *oid);\r
 100 void snmp_get_sysobjid_ptr(struct snmp_obj_id **oid);\r
 101 void snmp_inc_sysuptime(void);\r
 102 void snmp_add_sysuptime(u32_t value);\r
 103 void snmp_get_sysuptime(u32_t *value);\r
 104 void snmp_set_syscontact(u8_t *ocstr, u8_t *ocstrlen);\r
 105 void snmp_set_sysname(u8_t *ocstr, u8_t *ocstrlen);\r
 106 void snmp_set_syslocation(u8_t *ocstr, u8_t *ocstrlen);\r
 107 \r
 108 /* network interface */\r
 109 void snmp_add_ifinoctets(struct netif *ni, u32_t value);\r
 110 void snmp_inc_ifinucastpkts(struct netif *ni);\r
 111 void snmp_inc_ifinnucastpkts(struct netif *ni);\r
 112 void snmp_inc_ifindiscards(struct netif *ni);\r
 113 void snmp_add_ifoutoctets(struct netif *ni, u32_t value);\r
 114 void snmp_inc_ifoutucastpkts(struct netif *ni);\r
 115 void snmp_inc_ifoutnucastpkts(struct netif *ni);\r
 116 void snmp_inc_ifoutdiscards(struct netif *ni);\r
 117 void snmp_inc_iflist(void);\r
 118 void snmp_dec_iflist(void);\r
 119 \r
 120 /* ARP (for atTable and ipNetToMediaTable) */\r
 121 void snmp_insert_arpidx_tree(struct netif *ni, struct ip_addr *ip);\r
 122 void snmp_delete_arpidx_tree(struct netif *ni, struct ip_addr *ip);\r
 123 \r
 124 /* IP */\r
 125 void snmp_inc_ipinreceives(void);\r
 126 void snmp_inc_ipinhdrerrors(void);\r
 127 void snmp_inc_ipinaddrerrors(void);\r
 128 void snmp_inc_ipforwdatagrams(void);\r
 129 void snmp_inc_ipinunknownprotos(void);\r
 130 void snmp_inc_ipindiscards(void);\r
 131 void snmp_inc_ipindelivers(void);\r
 132 void snmp_inc_ipoutrequests(void);\r
 133 void snmp_inc_ipoutdiscards(void);\r
 134 void snmp_inc_ipoutnoroutes(void);\r
 135 void snmp_inc_ipreasmreqds(void);\r
 136 void snmp_inc_ipreasmoks(void);\r
 137 void snmp_inc_ipreasmfails(void);\r
 138 void snmp_inc_ipfragoks(void);\r
 139 void snmp_inc_ipfragfails(void);\r
 140 void snmp_inc_ipfragcreates(void);\r
 141 void snmp_inc_iproutingdiscards(void);\r
 142 void snmp_insert_ipaddridx_tree(struct netif *ni);\r
 143 void snmp_delete_ipaddridx_tree(struct netif *ni);\r
 144 void snmp_insert_iprteidx_tree(u8_t dflt, struct netif *ni);\r
 145 void snmp_delete_iprteidx_tree(u8_t dflt, struct netif *ni);\r
 146 \r
 147 /* ICMP */\r
 148 void snmp_inc_icmpinmsgs(void);\r
 149 void snmp_inc_icmpinerrors(void);\r
 150 void snmp_inc_icmpindestunreachs(void);\r
 151 void snmp_inc_icmpintimeexcds(void);\r
 152 void snmp_inc_icmpinparmprobs(void);\r
 153 void snmp_inc_icmpinsrcquenchs(void);\r
 154 void snmp_inc_icmpinredirects(void);\r
 155 void snmp_inc_icmpinechos(void);\r
 156 void snmp_inc_icmpinechoreps(void);\r
 157 void snmp_inc_icmpintimestamps(void);\r
 158 void snmp_inc_icmpintimestampreps(void);\r
 159 void snmp_inc_icmpinaddrmasks(void);\r
 160 void snmp_inc_icmpinaddrmaskreps(void);\r
 161 void snmp_inc_icmpoutmsgs(void);\r
 162 void snmp_inc_icmpouterrors(void);\r
 163 void snmp_inc_icmpoutdestunreachs(void);\r
 164 void snmp_inc_icmpouttimeexcds(void);\r
 165 void snmp_inc_icmpoutparmprobs(void);\r
 166 void snmp_inc_icmpoutsrcquenchs(void);\r
 167 void snmp_inc_icmpoutredirects(void);\r
 168 void snmp_inc_icmpoutechos(void);\r
 169 void snmp_inc_icmpoutechoreps(void);\r
 170 void snmp_inc_icmpouttimestamps(void);\r
 171 void snmp_inc_icmpouttimestampreps(void);\r
 172 void snmp_inc_icmpoutaddrmasks(void);\r
 173 void snmp_inc_icmpoutaddrmaskreps(void);\r
 174 \r
 175 /* TCP */\r
 176 void snmp_inc_tcpactiveopens(void);\r
 177 void snmp_inc_tcppassiveopens(void);\r
 178 void snmp_inc_tcpattemptfails(void);\r
 179 void snmp_inc_tcpestabresets(void);\r
 180 void snmp_inc_tcpinsegs(void);\r
 181 void snmp_inc_tcpoutsegs(void);\r
 182 void snmp_inc_tcpretranssegs(void);\r
 183 void snmp_inc_tcpinerrs(void);\r
 184 void snmp_inc_tcpoutrsts(void);\r
 185 \r
 186 /* UDP */\r
 187 void snmp_inc_udpindatagrams(void);\r
 188 void snmp_inc_udpnoports(void);\r
 189 void snmp_inc_udpinerrors(void);\r
 190 void snmp_inc_udpoutdatagrams(void);\r
 191 void snmp_insert_udpidx_tree(struct udp_pcb *pcb);\r
 192 void snmp_delete_udpidx_tree(struct udp_pcb *pcb);\r
 193 \r
 194 /* SNMP */\r
 195 void snmp_inc_snmpinpkts(void);\r
 196 void snmp_inc_snmpoutpkts(void);\r
 197 void snmp_inc_snmpinbadversions(void);\r
 198 void snmp_inc_snmpinbadcommunitynames(void);\r
 199 void snmp_inc_snmpinbadcommunityuses(void);\r
 200 void snmp_inc_snmpinasnparseerrs(void);\r
 201 void snmp_inc_snmpintoobigs(void);\r
 202 void snmp_inc_snmpinnosuchnames(void);\r
 203 void snmp_inc_snmpinbadvalues(void);\r
 204 void snmp_inc_snmpinreadonlys(void);\r
 205 void snmp_inc_snmpingenerrs(void);\r
 206 void snmp_add_snmpintotalreqvars(u8_t value);\r
 207 void snmp_add_snmpintotalsetvars(u8_t value);\r
 208 void snmp_inc_snmpingetrequests(void);\r
 209 void snmp_inc_snmpingetnexts(void);\r
 210 void snmp_inc_snmpinsetrequests(void);\r
 211 void snmp_inc_snmpingetresponses(void);\r
 212 void snmp_inc_snmpintraps(void);\r
 213 void snmp_inc_snmpouttoobigs(void);\r
 214 void snmp_inc_snmpoutnosuchnames(void);\r
 215 void snmp_inc_snmpoutbadvalues(void);\r
 216 void snmp_inc_snmpoutgenerrs(void);\r
 217 void snmp_inc_snmpoutgetrequests(void);\r
 218 void snmp_inc_snmpoutgetnexts(void);\r
 219 void snmp_inc_snmpoutsetrequests(void);\r
 220 void snmp_inc_snmpoutgetresponses(void);\r
 221 void snmp_inc_snmpouttraps(void);\r
 222 void snmp_get_snmpgrpid_ptr(struct snmp_obj_id **oid);\r
 223 void snmp_set_snmpenableauthentraps(u8_t *value);\r
 224 void snmp_get_snmpenableauthentraps(u8_t *value);\r
 225 \r
 226 /* LWIP_SNMP support not available */\r
 227 /* define everything to be empty */\r
 228 #else\r
 229 \r
 230 /* system */\r
 231 #define snmp_set_sysdesr(str, len)\r
 232 #define snmp_set_sysobjid(oid);\r
 233 #define snmp_get_sysobjid_ptr(oid)\r
 234 #define snmp_inc_sysuptime()\r
 235 #define snmp_add_sysuptime(value)\r
 236 #define snmp_get_sysuptime(value)\r
 237 #define snmp_set_syscontact(ocstr, ocstrlen);\r
 238 #define snmp_set_sysname(ocstr, ocstrlen);\r
 239 #define snmp_set_syslocation(ocstr, ocstrlen);\r
 240 \r
 241 /* network interface */\r
 242 #define snmp_add_ifinoctets(ni,value)\r
 243 #define snmp_inc_ifinucastpkts(ni)\r
 244 #define snmp_inc_ifinnucastpkts(ni)\r
 245 #define snmp_inc_ifindiscards(ni)\r
 246 #define snmp_add_ifoutoctets(ni,value)\r
 247 #define snmp_inc_ifoutucastpkts(ni)\r
 248 #define snmp_inc_ifoutnucastpkts(ni)\r
 249 #define snmp_inc_ifoutdiscards(ni)\r
 250 #define snmp_inc_iflist()\r
 251 #define snmp_dec_iflist()\r
 252 \r
 253 /* ARP */\r
 254 #define snmp_insert_arpidx_tree(ni,ip)\r
 255 #define snmp_delete_arpidx_tree(ni,ip)\r
 256 \r
 257 /* IP */\r
 258 #define snmp_inc_ipinreceives()\r
 259 #define snmp_inc_ipinhdrerrors()\r
 260 #define snmp_inc_ipinaddrerrors()\r
 261 #define snmp_inc_ipforwdatagrams()\r
 262 #define snmp_inc_ipinunknownprotos()\r
 263 #define snmp_inc_ipindiscards()\r
 264 #define snmp_inc_ipindelivers()\r
 265 #define snmp_inc_ipoutrequests()\r
 266 #define snmp_inc_ipoutdiscards()\r
 267 #define snmp_inc_ipoutnoroutes()\r
 268 #define snmp_inc_ipreasmreqds()\r
 269 #define snmp_inc_ipreasmoks()\r
 270 #define snmp_inc_ipreasmfails()\r
 271 #define snmp_inc_ipfragoks()\r
 272 #define snmp_inc_ipfragfails()\r
 273 #define snmp_inc_ipfragcreates()\r
 274 #define snmp_inc_iproutingdiscards()\r
 275 #define snmp_insert_ipaddridx_tree(ni)\r
 276 #define snmp_delete_ipaddridx_tree(ni)\r
 277 #define snmp_insert_iprteidx_tree(dflt, ni)\r
 278 #define snmp_delete_iprteidx_tree(dflt, ni)\r
 279 \r
 280 /* ICMP */\r
 281 #define snmp_inc_icmpinmsgs()\r
 282 #define snmp_inc_icmpinerrors()\r
 283 #define snmp_inc_icmpindestunreachs()\r
 284 #define snmp_inc_icmpintimeexcds()\r
 285 #define snmp_inc_icmpinparmprobs()\r
 286 #define snmp_inc_icmpinsrcquenchs()\r
 287 #define snmp_inc_icmpinredirects()\r
 288 #define snmp_inc_icmpinechos()\r
 289 #define snmp_inc_icmpinechoreps()\r
 290 #define snmp_inc_icmpintimestamps()\r
 291 #define snmp_inc_icmpintimestampreps()\r
 292 #define snmp_inc_icmpinaddrmasks()\r
 293 #define snmp_inc_icmpinaddrmaskreps()\r
 294 #define snmp_inc_icmpoutmsgs()\r
 295 #define snmp_inc_icmpouterrors()\r
 296 #define snmp_inc_icmpoutdestunreachs()\r
 297 #define snmp_inc_icmpouttimeexcds()\r
 298 #define snmp_inc_icmpoutparmprobs()\r
 299 #define snmp_inc_icmpoutsrcquenchs()\r
 300 #define snmp_inc_icmpoutredirects()\r
 301 #define snmp_inc_icmpoutechos()\r
 302 #define snmp_inc_icmpoutechoreps()\r
 303 #define snmp_inc_icmpouttimestamps()\r
 304 #define snmp_inc_icmpouttimestampreps()\r
 305 #define snmp_inc_icmpoutaddrmasks()\r
 306 #define snmp_inc_icmpoutaddrmaskreps()\r
 307 /* TCP */\r
 308 #define snmp_inc_tcpactiveopens()\r
 309 #define snmp_inc_tcppassiveopens()\r
 310 #define snmp_inc_tcpattemptfails()\r
 311 #define snmp_inc_tcpestabresets()\r
 312 #define snmp_inc_tcpinsegs()\r
 313 #define snmp_inc_tcpoutsegs()\r
 314 #define snmp_inc_tcpretranssegs()\r
 315 #define snmp_inc_tcpinerrs()\r
 316 #define snmp_inc_tcpoutrsts()\r
 317 \r
 318 /* UDP */\r
 319 #define snmp_inc_udpindatagrams()\r
 320 #define snmp_inc_udpnoports()\r
 321 #define snmp_inc_udpinerrors()\r
 322 #define snmp_inc_udpoutdatagrams()\r
 323 #define snmp_insert_udpidx_tree(pcb)\r
 324 #define snmp_delete_udpidx_tree(pcb)\r
 325 \r
 326 /* SNMP */\r
 327 #define snmp_inc_snmpinpkts()\r
 328 #define snmp_inc_snmpoutpkts()\r
 329 #define snmp_inc_snmpinbadversions()\r
 330 #define snmp_inc_snmpinbadcommunitynames()\r
 331 #define snmp_inc_snmpinbadcommunityuses()\r
 332 #define snmp_inc_snmpinasnparseerrs()\r
 333 #define snmp_inc_snmpintoobigs()\r
 334 #define snmp_inc_snmpinnosuchnames()\r
 335 #define snmp_inc_snmpinbadvalues()\r
 336 #define snmp_inc_snmpinreadonlys()\r
 337 #define snmp_inc_snmpingenerrs()\r
 338 #define snmp_add_snmpintotalreqvars(value)\r
 339 #define snmp_add_snmpintotalsetvars(value)\r
 340 #define snmp_inc_snmpingetrequests()\r
 341 #define snmp_inc_snmpingetnexts()\r
 342 #define snmp_inc_snmpinsetrequests()\r
 343 #define snmp_inc_snmpingetresponses()\r
 344 #define snmp_inc_snmpintraps()\r
 345 #define snmp_inc_snmpouttoobigs()\r
 346 #define snmp_inc_snmpoutnosuchnames()\r
 347 #define snmp_inc_snmpoutbadvalues()\r
 348 #define snmp_inc_snmpoutgenerrs()\r
 349 #define snmp_inc_snmpoutgetrequests()\r
 350 #define snmp_inc_snmpoutgetnexts()\r
 351 #define snmp_inc_snmpoutsetrequests()\r
 352 #define snmp_inc_snmpoutgetresponses()\r
 353 #define snmp_inc_snmpouttraps()\r
 354 #define snmp_get_snmpgrpid_ptr(oid)\r
 355 #define snmp_set_snmpenableauthentraps(value)\r
 356 #define snmp_get_snmpenableauthentraps(value)\r
 357 \r
 358 #endif /* LWIP_SNMP */\r
 359 \r
 360 #ifdef __cplusplus\r
 361 }\r
 362 #endif\r
 363 \r
 364 #endif /* __LWIP_SNMP_H__ */\r