git.sur5r.net Git - freertos/blob - Demo/Common/ethernet/lwIP/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 /* SNMP support available? */\r
  41 #if defined(LWIP_SNMP) && (LWIP_SNMP > 0)\r
  42 \r
  43 /** fixed maximum length for object identifier type */\r
  44 #define LWIP_SNMP_OBJ_ID_LEN 32\r
  45 /** internal object identifier representation */\r
  46 struct snmp_obj_id\r
  47 {\r
  48   u8_t len;\r
  49   s32_t id[LWIP_SNMP_OBJ_ID_LEN];\r
  50 };\r
  51 \r
  52 /* system */\r
  53 void snmp_set_sysdesr(u8_t* str, u8_t* strlen);\r
  54 void snmp_set_sysobjid(struct snmp_obj_id *oid);\r
  55 void snmp_get_sysobjid_ptr(struct snmp_obj_id **oid);\r
  56 void snmp_inc_sysuptime(void);\r
  57 void snmp_get_sysuptime(u32_t *value);\r
  58 void snmp_set_syscontact(u8_t *ocstr, u8_t *ocstrlen);\r
  59 void snmp_set_sysname(u8_t *ocstr, u8_t *ocstrlen);\r
  60 void snmp_set_syslocation(u8_t *ocstr, u8_t *ocstrlen);\r
  61 \r
  62 /* network interface */\r
  63 void snmp_add_ifinoctets(struct netif *ni, u32_t value); \r
  64 void snmp_inc_ifinucastpkts(struct netif *ni);\r
  65 void snmp_inc_ifinnucastpkts(struct netif *ni);\r
  66 void snmp_inc_ifindiscards(struct netif *ni);\r
  67 void snmp_add_ifoutoctets(struct netif *ni, u32_t value);\r
  68 void snmp_inc_ifoutucastpkts(struct netif *ni);\r
  69 void snmp_inc_ifoutnucastpkts(struct netif *ni);\r
  70 void snmp_inc_ifoutdiscards(struct netif *ni);\r
  71 void snmp_inc_iflist(void);\r
  72 void snmp_dec_iflist(void);\r
  73 \r
  74 /* ARP (for atTable and ipNetToMediaTable) */\r
  75 void snmp_insert_arpidx_tree(struct netif *ni, struct ip_addr *ip);\r
  76 void snmp_delete_arpidx_tree(struct netif *ni, struct ip_addr *ip);\r
  77 \r
  78 /* IP */\r
  79 void snmp_inc_ipinreceives(void);\r
  80 void snmp_inc_ipinhdrerrors(void);\r
  81 void snmp_inc_ipinaddrerrors(void);\r
  82 void snmp_inc_ipforwdatagrams(void);\r
  83 void snmp_inc_ipinunknownprotos(void);\r
  84 void snmp_inc_ipindiscards(void);\r
  85 void snmp_inc_ipindelivers(void);\r
  86 void snmp_inc_ipoutrequests(void);\r
  87 void snmp_inc_ipoutdiscards(void);\r
  88 void snmp_inc_ipoutnoroutes(void);\r
  89 void snmp_inc_ipreasmreqds(void);\r
  90 void snmp_inc_ipreasmoks(void);\r
  91 void snmp_inc_ipreasmfails(void);\r
  92 void snmp_inc_ipfragoks(void);\r
  93 void snmp_inc_ipfragfails(void);\r
  94 void snmp_inc_ipfragcreates(void);\r
  95 void snmp_inc_iproutingdiscards(void);\r
  96 void snmp_insert_ipaddridx_tree(struct netif *ni);\r
  97 void snmp_delete_ipaddridx_tree(struct netif *ni);\r
  98 void snmp_insert_iprteidx_tree(u8_t dflt, struct netif *ni);\r
  99 void snmp_delete_iprteidx_tree(u8_t dflt, struct netif *ni);\r
 100 \r
 101 /* ICMP */\r
 102 void snmp_inc_icmpinmsgs(void);\r
 103 void snmp_inc_icmpinerrors(void);\r
 104 void snmp_inc_icmpindestunreachs(void);\r
 105 void snmp_inc_icmpintimeexcds(void);\r
 106 void snmp_inc_icmpinparmprobs(void);\r
 107 void snmp_inc_icmpinsrcquenchs(void);\r
 108 void snmp_inc_icmpinredirects(void);\r
 109 void snmp_inc_icmpinechos(void);\r
 110 void snmp_inc_icmpinechoreps(void);\r
 111 void snmp_inc_icmpintimestamps(void);\r
 112 void snmp_inc_icmpintimestampreps(void);\r
 113 void snmp_inc_icmpinaddrmasks(void);\r
 114 void snmp_inc_icmpinaddrmaskreps(void);\r
 115 void snmp_inc_icmpoutmsgs(void);\r
 116 void snmp_inc_icmpouterrors(void);\r
 117 void snmp_inc_icmpoutdestunreachs(void);\r
 118 void snmp_inc_icmpouttimeexcds(void);\r
 119 void snmp_inc_icmpoutparmprobs(void);\r
 120 void snmp_inc_icmpoutsrcquenchs(void);\r
 121 void snmp_inc_icmpoutredirects(void); \r
 122 void snmp_inc_icmpoutechos(void);\r
 123 void snmp_inc_icmpoutechoreps(void);\r
 124 void snmp_inc_icmpouttimestamps(void);\r
 125 void snmp_inc_icmpouttimestampreps(void);\r
 126 void snmp_inc_icmpoutaddrmasks(void);\r
 127 void snmp_inc_icmpoutaddrmaskreps(void);\r
 128 \r
 129 /* TCP */\r
 130 void snmp_inc_tcpactiveopens(void);\r
 131 void snmp_inc_tcppassiveopens(void);\r
 132 void snmp_inc_tcpattemptfails(void);\r
 133 void snmp_inc_tcpestabresets(void);\r
 134 void snmp_inc_tcpinsegs(void);\r
 135 void snmp_inc_tcpoutsegs(void);\r
 136 void snmp_inc_tcpretranssegs(void);\r
 137 void snmp_inc_tcpinerrs(void);\r
 138 void snmp_inc_tcpoutrsts(void);\r
 139 \r
 140 /* UDP */\r
 141 void snmp_inc_udpindatagrams(void);\r
 142 void snmp_inc_udpnoports(void);\r
 143 void snmp_inc_udpinerrors(void);\r
 144 void snmp_inc_udpoutdatagrams(void);\r
 145 void snmp_insert_udpidx_tree(struct udp_pcb *pcb);\r
 146 void snmp_delete_udpidx_tree(struct udp_pcb *pcb);\r
 147 \r
 148 /* SNMP */\r
 149 void snmp_inc_snmpinpkts(void);\r
 150 void snmp_inc_snmpoutpkts(void);\r
 151 void snmp_inc_snmpinbadversions(void);\r
 152 void snmp_inc_snmpinbadcommunitynames(void);\r
 153 void snmp_inc_snmpinbadcommunityuses(void);\r
 154 void snmp_inc_snmpinasnparseerrs(void);\r
 155 void snmp_inc_snmpintoobigs(void);\r
 156 void snmp_inc_snmpinnosuchnames(void);\r
 157 void snmp_inc_snmpinbadvalues(void);\r
 158 void snmp_inc_snmpinreadonlys(void);\r
 159 void snmp_inc_snmpingenerrs(void);\r
 160 void snmp_add_snmpintotalreqvars(u8_t value);\r
 161 void snmp_add_snmpintotalsetvars(u8_t value);\r
 162 void snmp_inc_snmpingetrequests(void);\r
 163 void snmp_inc_snmpingetnexts(void);\r
 164 void snmp_inc_snmpinsetrequests(void);\r
 165 void snmp_inc_snmpingetresponses(void);\r
 166 void snmp_inc_snmpintraps(void);\r
 167 void snmp_inc_snmpouttoobigs(void);\r
 168 void snmp_inc_snmpoutnosuchnames(void);\r
 169 void snmp_inc_snmpoutbadvalues(void);\r
 170 void snmp_inc_snmpoutgenerrs(void);\r
 171 void snmp_inc_snmpoutgetrequests(void);\r
 172 void snmp_inc_snmpoutgetnexts(void);\r
 173 void snmp_inc_snmpoutsetrequests(void);\r
 174 void snmp_inc_snmpoutgetresponses(void);\r
 175 void snmp_inc_snmpouttraps(void);\r
 176 void snmp_get_snmpgrpid_ptr(struct snmp_obj_id **oid);\r
 177 void snmp_set_snmpenableauthentraps(u8_t *value);\r
 178 void snmp_get_snmpenableauthentraps(u8_t *value);\r
 179 \r
 180 /* LWIP_SNMP support not available */\r
 181 /* define everything to be empty */\r
 182 #else\r
 183 \r
 184 /* system */\r
 185 #define snmp_set_sysdesr(str, strlen)\r
 186 #define snmp_get_sysobjid_ptr(oid)\r
 187 #define snmp_inc_sysuptime()\r
 188 #define snmp_get_sysuptime(value)\r
 189 \r
 190 /* network interface */\r
 191 #define snmp_add_ifinoctets(ni,value) \r
 192 #define snmp_inc_ifinucastpkts(ni)\r
 193 #define snmp_inc_ifinnucastpkts(ni)\r
 194 #define snmp_inc_ifindiscards(ni)\r
 195 #define snmp_add_ifoutoctets(ni,value)\r
 196 #define snmp_inc_ifoutucastpkts(ni)\r
 197 #define snmp_inc_ifoutnucastpkts(ni)\r
 198 #define snmp_inc_ifoutdiscards(ni)\r
 199 #define snmp_inc_iflist()\r
 200 #define snmp_dec_iflist()\r
 201 \r
 202 /* ARP */\r
 203 #define snmp_insert_arpidx_tree(ni,ip)\r
 204 #define snmp_delete_arpidx_tree(ni,ip)\r
 205 \r
 206 /* IP */\r
 207 #define snmp_inc_ipinreceives()\r
 208 #define snmp_inc_ipinhdrerrors()\r
 209 #define snmp_inc_ipinaddrerrors()\r
 210 #define snmp_inc_ipforwdatagrams()\r
 211 #define snmp_inc_ipinunknownprotos()\r
 212 #define snmp_inc_ipindiscards()\r
 213 #define snmp_inc_ipindelivers()\r
 214 #define snmp_inc_ipoutrequests()\r
 215 #define snmp_inc_ipoutdiscards()\r
 216 #define snmp_inc_ipoutnoroutes()\r
 217 #define snmp_inc_ipreasmreqds()\r
 218 #define snmp_inc_ipreasmoks()\r
 219 #define snmp_inc_ipreasmfails()\r
 220 #define snmp_inc_ipfragoks()\r
 221 #define snmp_inc_ipfragfails()\r
 222 #define snmp_inc_ipfragcreates()\r
 223 #define snmp_inc_iproutingdiscards()\r
 224 #define snmp_insert_ipaddridx_tree(ni)\r
 225 #define snmp_delete_ipaddridx_tree(ni)\r
 226 #define snmp_insert_iprteidx_tree(dflt, ni)\r
 227 #define snmp_delete_iprteidx_tree(dflt, ni)\r
 228 \r
 229 /* ICMP */\r
 230 #define snmp_inc_icmpinmsgs()\r
 231 #define snmp_inc_icmpinerrors() \r
 232 #define snmp_inc_icmpindestunreachs() \r
 233 #define snmp_inc_icmpintimeexcds()\r
 234 #define snmp_inc_icmpinparmprobs() \r
 235 #define snmp_inc_icmpinsrcquenchs() \r
 236 #define snmp_inc_icmpinredirects() \r
 237 #define snmp_inc_icmpinechos() \r
 238 #define snmp_inc_icmpinechoreps()\r
 239 #define snmp_inc_icmpintimestamps() \r
 240 #define snmp_inc_icmpintimestampreps()\r
 241 #define snmp_inc_icmpinaddrmasks()\r
 242 #define snmp_inc_icmpinaddrmaskreps()\r
 243 #define snmp_inc_icmpoutmsgs()\r
 244 #define snmp_inc_icmpouterrors()\r
 245 #define snmp_inc_icmpoutdestunreachs() \r
 246 #define snmp_inc_icmpouttimeexcds() \r
 247 #define snmp_inc_icmpoutparmprobs()\r
 248 #define snmp_inc_icmpoutsrcquenchs()\r
 249 #define snmp_inc_icmpoutredirects() \r
 250 #define snmp_inc_icmpoutechos() \r
 251 #define snmp_inc_icmpoutechoreps()\r
 252 #define snmp_inc_icmpouttimestamps()\r
 253 #define snmp_inc_icmpouttimestampreps()\r
 254 #define snmp_inc_icmpoutaddrmasks()\r
 255 #define snmp_inc_icmpoutaddrmaskreps()\r
 256 /* TCP */\r
 257 #define snmp_inc_tcpactiveopens()\r
 258 #define snmp_inc_tcppassiveopens()\r
 259 #define snmp_inc_tcpattemptfails()\r
 260 #define snmp_inc_tcpestabresets()\r
 261 #define snmp_inc_tcpinsegs()\r
 262 #define snmp_inc_tcpoutsegs()\r
 263 #define snmp_inc_tcpretranssegs()\r
 264 #define snmp_inc_tcpinerrs()\r
 265 #define snmp_inc_tcpoutrsts()\r
 266 \r
 267 /* UDP */\r
 268 #define snmp_inc_udpindatagrams()\r
 269 #define snmp_inc_udpnoports()\r
 270 #define snmp_inc_udpinerrors()\r
 271 #define snmp_inc_udpoutdatagrams()\r
 272 #define snmp_insert_udpidx_tree(pcb)\r
 273 #define snmp_delete_udpidx_tree(pcb)\r
 274 \r
 275 /* SNMP */\r
 276 #define snmp_inc_snmpinpkts()\r
 277 #define snmp_inc_snmpoutpkts()\r
 278 #define snmp_inc_snmpinbadversions()\r
 279 #define snmp_inc_snmpinbadcommunitynames()\r
 280 #define snmp_inc_snmpinbadcommunityuses()\r
 281 #define snmp_inc_snmpinasnparseerrs()\r
 282 #define snmp_inc_snmpintoobigs()\r
 283 #define snmp_inc_snmpinnosuchnames()\r
 284 #define snmp_inc_snmpinbadvalues()\r
 285 #define snmp_inc_snmpinreadonlys()\r
 286 #define snmp_inc_snmpingenerrs()\r
 287 #define snmp_add_snmpintotalreqvars(value)\r
 288 #define snmp_add_snmpintotalsetvars(value)\r
 289 #define snmp_inc_snmpingetrequests()\r
 290 #define snmp_inc_snmpingetnexts()\r
 291 #define snmp_inc_snmpinsetrequests()\r
 292 #define snmp_inc_snmpingetresponses()\r
 293 #define snmp_inc_snmpintraps()\r
 294 #define snmp_inc_snmpouttoobigs()\r
 295 #define snmp_inc_snmpoutnosuchnames()\r
 296 #define snmp_inc_snmpoutbadvalues()\r
 297 #define snmp_inc_snmpoutgenerrs()\r
 298 #define snmp_inc_snmpoutgetrequests()\r
 299 #define snmp_inc_snmpoutgetnexts()\r
 300 #define snmp_inc_snmpoutsetrequests()\r
 301 #define snmp_inc_snmpoutgetresponses()\r
 302 #define snmp_inc_snmpouttraps()\r
 303 #define snmp_get_snmpgrpid_ptr(oid)\r
 304 #define snmp_set_snmpenableauthentraps(value)\r
 305 #define snmp_get_snmpenableauthentraps(value)\r
 306 \r
 307 #endif\r
 308 \r
 309 #endif /* __LWIP_SNMP_H__ */\r