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