Jeff Mourich / EthernetNetIf_ChangeHostName

ID the MBED processor on the network if you have more than one. View MBED name on DHCP of your Router - Example \"MBED PE\" Change your ID in Core / host.h

LPC2368/lwip/include/lwip/snmp_structs.h@0:fd3b85615428, 2010-11-06 (annotated)

Committer:
JeffM
Date:
Sat Nov 06 14:11:02 2010 +0000
Revision:
0:fd3b85615428
MBED ID 1A

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JeffM 0:fd3b85615428 1 /**
JeffM 0:fd3b85615428 2 * @file
JeffM 0:fd3b85615428 3 * Generic MIB tree structures.
JeffM 0:fd3b85615428 4 *
JeffM 0:fd3b85615428 5 * @todo namespace prefixes
JeffM 0:fd3b85615428 6 */
JeffM 0:fd3b85615428 7
JeffM 0:fd3b85615428 8 /*
JeffM 0:fd3b85615428 9 * Copyright (c) 2006 Axon Digital Design B.V., The Netherlands.
JeffM 0:fd3b85615428 10 * All rights reserved.
JeffM 0:fd3b85615428 11 *
JeffM 0:fd3b85615428 12 * Redistribution and use in source and binary forms, with or without modification,
JeffM 0:fd3b85615428 13 * are permitted provided that the following conditions are met:
JeffM 0:fd3b85615428 14 *
JeffM 0:fd3b85615428 15 * 1. Redistributions of source code must retain the above copyright notice,
JeffM 0:fd3b85615428 16 * this list of conditions and the following disclaimer.
JeffM 0:fd3b85615428 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
JeffM 0:fd3b85615428 18 * this list of conditions and the following disclaimer in the documentation
JeffM 0:fd3b85615428 19 * and/or other materials provided with the distribution.
JeffM 0:fd3b85615428 20 * 3. The name of the author may not be used to endorse or promote products
JeffM 0:fd3b85615428 21 * derived from this software without specific prior written permission.
JeffM 0:fd3b85615428 22 *
JeffM 0:fd3b85615428 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
JeffM 0:fd3b85615428 24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
JeffM 0:fd3b85615428 25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
JeffM 0:fd3b85615428 26 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
JeffM 0:fd3b85615428 27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
JeffM 0:fd3b85615428 28 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
JeffM 0:fd3b85615428 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
JeffM 0:fd3b85615428 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
JeffM 0:fd3b85615428 31 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
JeffM 0:fd3b85615428 32 * OF SUCH DAMAGE.
JeffM 0:fd3b85615428 33 *
JeffM 0:fd3b85615428 34 * Author: Christiaan Simons <christiaan.simons@axon.tv>
JeffM 0:fd3b85615428 35 */
JeffM 0:fd3b85615428 36
JeffM 0:fd3b85615428 37 #ifndef __LWIP_SNMP_STRUCTS_H__
JeffM 0:fd3b85615428 38 #define __LWIP_SNMP_STRUCTS_H__
JeffM 0:fd3b85615428 39
JeffM 0:fd3b85615428 40 #include "lwip/opt.h"
JeffM 0:fd3b85615428 41
JeffM 0:fd3b85615428 42 #if LWIP_SNMP /* don't build if not configured for use in lwipopts.h */
JeffM 0:fd3b85615428 43
JeffM 0:fd3b85615428 44 #include "lwip/snmp.h"
JeffM 0:fd3b85615428 45
JeffM 0:fd3b85615428 46 #if SNMP_PRIVATE_MIB
JeffM 0:fd3b85615428 47 /* When using a private MIB, you have to create a file 'private_mib.h' that contains
JeffM 0:fd3b85615428 48 * a 'struct mib_array_node mib_private' which contains your MIB. */
JeffM 0:fd3b85615428 49 #include "private_mib.h"
JeffM 0:fd3b85615428 50 #endif
JeffM 0:fd3b85615428 51
JeffM 0:fd3b85615428 52 #ifdef __cplusplus
JeffM 0:fd3b85615428 53 extern "C" {
JeffM 0:fd3b85615428 54 #endif
JeffM 0:fd3b85615428 55
JeffM 0:fd3b85615428 56 /* MIB object instance */
JeffM 0:fd3b85615428 57 #define MIB_OBJECT_NONE 0
JeffM 0:fd3b85615428 58 #define MIB_OBJECT_SCALAR 1
JeffM 0:fd3b85615428 59 #define MIB_OBJECT_TAB 2
JeffM 0:fd3b85615428 60
JeffM 0:fd3b85615428 61 /* MIB access types */
JeffM 0:fd3b85615428 62 #define MIB_ACCESS_READ 1
JeffM 0:fd3b85615428 63 #define MIB_ACCESS_WRITE 2
JeffM 0:fd3b85615428 64
JeffM 0:fd3b85615428 65 /* MIB object access */
JeffM 0:fd3b85615428 66 #define MIB_OBJECT_READ_ONLY MIB_ACCESS_READ
JeffM 0:fd3b85615428 67 #define MIB_OBJECT_READ_WRITE (MIB_ACCESS_READ | MIB_ACCESS_WRITE)
JeffM 0:fd3b85615428 68 #define MIB_OBJECT_WRITE_ONLY MIB_ACCESS_WRITE
JeffM 0:fd3b85615428 69 #define MIB_OBJECT_NOT_ACCESSIBLE 0
JeffM 0:fd3b85615428 70
JeffM 0:fd3b85615428 71 /** object definition returned by (get_object_def)() */
JeffM 0:fd3b85615428 72 struct obj_def
JeffM 0:fd3b85615428 73 {
JeffM 0:fd3b85615428 74 /* MIB_OBJECT_NONE (0), MIB_OBJECT_SCALAR (1), MIB_OBJECT_TAB (2) */
JeffM 0:fd3b85615428 75 u8_t instance;
JeffM 0:fd3b85615428 76 /* 0 read-only, 1 read-write, 2 write-only, 3 not-accessible */
JeffM 0:fd3b85615428 77 u8_t access;
JeffM 0:fd3b85615428 78 /* ASN type for this object */
JeffM 0:fd3b85615428 79 u8_t asn_type;
JeffM 0:fd3b85615428 80 /* value length (host length) */
JeffM 0:fd3b85615428 81 u16_t v_len;
JeffM 0:fd3b85615428 82 /* length of instance part of supplied object identifier */
JeffM 0:fd3b85615428 83 u8_t id_inst_len;
JeffM 0:fd3b85615428 84 /* instance part of supplied object identifier */
JeffM 0:fd3b85615428 85 s32_t *id_inst_ptr;
JeffM 0:fd3b85615428 86 };
JeffM 0:fd3b85615428 87
JeffM 0:fd3b85615428 88 struct snmp_name_ptr
JeffM 0:fd3b85615428 89 {
JeffM 0:fd3b85615428 90 u8_t ident_len;
JeffM 0:fd3b85615428 91 s32_t *ident;
JeffM 0:fd3b85615428 92 };
JeffM 0:fd3b85615428 93
JeffM 0:fd3b85615428 94 /** MIB const scalar (.0) node */
JeffM 0:fd3b85615428 95 #define MIB_NODE_SC 0x01
JeffM 0:fd3b85615428 96 /** MIB const array node */
JeffM 0:fd3b85615428 97 #define MIB_NODE_AR 0x02
JeffM 0:fd3b85615428 98 /** MIB array node (mem_malloced from RAM) */
JeffM 0:fd3b85615428 99 #define MIB_NODE_RA 0x03
JeffM 0:fd3b85615428 100 /** MIB list root node (mem_malloced from RAM) */
JeffM 0:fd3b85615428 101 #define MIB_NODE_LR 0x04
JeffM 0:fd3b85615428 102 /** MIB node for external objects */
JeffM 0:fd3b85615428 103 #define MIB_NODE_EX 0x05
JeffM 0:fd3b85615428 104
JeffM 0:fd3b85615428 105 /** node "base class" layout, the mandatory fields for a node */
JeffM 0:fd3b85615428 106 struct mib_node
JeffM 0:fd3b85615428 107 {
JeffM 0:fd3b85615428 108 /** returns struct obj_def for the given object identifier */
JeffM 0:fd3b85615428 109 void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);
JeffM 0:fd3b85615428 110 /** returns object value for the given object identifier,
JeffM 0:fd3b85615428 111 @note the caller must allocate at least len bytes for the value */
JeffM 0:fd3b85615428 112 void (*get_value)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 113 /** tests length and/or range BEFORE setting */
JeffM 0:fd3b85615428 114 u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 115 /** sets object value, only to be called when set_test() */
JeffM 0:fd3b85615428 116 void (*set_value)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 117 /** One out of MIB_NODE_AR, MIB_NODE_LR or MIB_NODE_EX */
JeffM 0:fd3b85615428 118 u8_t node_type;
JeffM 0:fd3b85615428 119 /* array or max list length */
JeffM 0:fd3b85615428 120 u16_t maxlength;
JeffM 0:fd3b85615428 121 };
JeffM 0:fd3b85615428 122
JeffM 0:fd3b85615428 123 /** derived node for scalars .0 index */
JeffM 0:fd3b85615428 124 typedef struct mib_node mib_scalar_node;
JeffM 0:fd3b85615428 125
JeffM 0:fd3b85615428 126 /** derived node, points to a fixed size const array
JeffM 0:fd3b85615428 127 of sub-identifiers plus a 'child' pointer */
JeffM 0:fd3b85615428 128 struct mib_array_node
JeffM 0:fd3b85615428 129 {
JeffM 0:fd3b85615428 130 /* inherited "base class" members */
JeffM 0:fd3b85615428 131 void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);
JeffM 0:fd3b85615428 132 void (*get_value)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 133 u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 134 void (*set_value)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 135
JeffM 0:fd3b85615428 136 u8_t node_type;
JeffM 0:fd3b85615428 137 u16_t maxlength;
JeffM 0:fd3b85615428 138
JeffM 0:fd3b85615428 139 /* additional struct members */
JeffM 0:fd3b85615428 140 const s32_t *objid;
JeffM 0:fd3b85615428 141 struct mib_node* const *nptr;
JeffM 0:fd3b85615428 142 };
JeffM 0:fd3b85615428 143
JeffM 0:fd3b85615428 144 /** derived node, points to a fixed size mem_malloced array
JeffM 0:fd3b85615428 145 of sub-identifiers plus a 'child' pointer */
JeffM 0:fd3b85615428 146 struct mib_ram_array_node
JeffM 0:fd3b85615428 147 {
JeffM 0:fd3b85615428 148 /* inherited "base class" members */
JeffM 0:fd3b85615428 149 void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);
JeffM 0:fd3b85615428 150 void (*get_value)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 151 u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 152 void (*set_value)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 153
JeffM 0:fd3b85615428 154 u8_t node_type;
JeffM 0:fd3b85615428 155 u16_t maxlength;
JeffM 0:fd3b85615428 156
JeffM 0:fd3b85615428 157 /* aditional struct members */
JeffM 0:fd3b85615428 158 s32_t *objid;
JeffM 0:fd3b85615428 159 struct mib_node **nptr;
JeffM 0:fd3b85615428 160 };
JeffM 0:fd3b85615428 161
JeffM 0:fd3b85615428 162 struct mib_list_node
JeffM 0:fd3b85615428 163 {
JeffM 0:fd3b85615428 164 struct mib_list_node *prev;
JeffM 0:fd3b85615428 165 struct mib_list_node *next;
JeffM 0:fd3b85615428 166 s32_t objid;
JeffM 0:fd3b85615428 167 struct mib_node *nptr;
JeffM 0:fd3b85615428 168 };
JeffM 0:fd3b85615428 169
JeffM 0:fd3b85615428 170 /** derived node, points to a doubly linked list
JeffM 0:fd3b85615428 171 of sub-identifiers plus a 'child' pointer */
JeffM 0:fd3b85615428 172 struct mib_list_rootnode
JeffM 0:fd3b85615428 173 {
JeffM 0:fd3b85615428 174 /* inherited "base class" members */
JeffM 0:fd3b85615428 175 void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);
JeffM 0:fd3b85615428 176 void (*get_value)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 177 u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 178 void (*set_value)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 179
JeffM 0:fd3b85615428 180 u8_t node_type;
JeffM 0:fd3b85615428 181 u16_t maxlength;
JeffM 0:fd3b85615428 182
JeffM 0:fd3b85615428 183 /* additional struct members */
JeffM 0:fd3b85615428 184 struct mib_list_node *head;
JeffM 0:fd3b85615428 185 struct mib_list_node *tail;
JeffM 0:fd3b85615428 186 /* counts list nodes in list */
JeffM 0:fd3b85615428 187 u16_t count;
JeffM 0:fd3b85615428 188 };
JeffM 0:fd3b85615428 189
JeffM 0:fd3b85615428 190 /** derived node, has access functions for mib object in external memory or device
JeffM 0:fd3b85615428 191 using 'tree_level' and 'idx', with a range 0 .. (level_length() - 1) */
JeffM 0:fd3b85615428 192 struct mib_external_node
JeffM 0:fd3b85615428 193 {
JeffM 0:fd3b85615428 194 /* inherited "base class" members */
JeffM 0:fd3b85615428 195 void (*get_object_def)(u8_t ident_len, s32_t *ident, struct obj_def *od);
JeffM 0:fd3b85615428 196 void (*get_value)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 197 u8_t (*set_test)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 198 void (*set_value)(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 199
JeffM 0:fd3b85615428 200 u8_t node_type;
JeffM 0:fd3b85615428 201 u16_t maxlength;
JeffM 0:fd3b85615428 202
JeffM 0:fd3b85615428 203 /* additional struct members */
JeffM 0:fd3b85615428 204 /** points to an external (in memory) record of some sort of addressing
JeffM 0:fd3b85615428 205 information, passed to and interpreted by the funtions below */
JeffM 0:fd3b85615428 206 void* addr_inf;
JeffM 0:fd3b85615428 207 /** tree levels under this node */
JeffM 0:fd3b85615428 208 u8_t tree_levels;
JeffM 0:fd3b85615428 209 /** number of objects at this level */
JeffM 0:fd3b85615428 210 u16_t (*level_length)(void* addr_inf, u8_t level);
JeffM 0:fd3b85615428 211 /** compares object sub identifier with external id
JeffM 0:fd3b85615428 212 return zero when equal, nonzero when unequal */
JeffM 0:fd3b85615428 213 s32_t (*ident_cmp)(void* addr_inf, u8_t level, u16_t idx, s32_t sub_id);
JeffM 0:fd3b85615428 214 void (*get_objid)(void* addr_inf, u8_t level, u16_t idx, s32_t *sub_id);
JeffM 0:fd3b85615428 215
JeffM 0:fd3b85615428 216 /** async Questions */
JeffM 0:fd3b85615428 217 void (*get_object_def_q)(void* addr_inf, u8_t rid, u8_t ident_len, s32_t *ident);
JeffM 0:fd3b85615428 218 void (*get_value_q)(u8_t rid, struct obj_def *od);
JeffM 0:fd3b85615428 219 void (*set_test_q)(u8_t rid, struct obj_def *od);
JeffM 0:fd3b85615428 220 void (*set_value_q)(u8_t rid, struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 221 /** async Answers */
JeffM 0:fd3b85615428 222 void (*get_object_def_a)(u8_t rid, u8_t ident_len, s32_t *ident, struct obj_def *od);
JeffM 0:fd3b85615428 223 void (*get_value_a)(u8_t rid, struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 224 u8_t (*set_test_a)(u8_t rid, struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 225 void (*set_value_a)(u8_t rid, struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 226 /** async Panic Close (agent returns error reply,
JeffM 0:fd3b85615428 227 e.g. used for external transaction cleanup) */
JeffM 0:fd3b85615428 228 void (*get_object_def_pc)(u8_t rid, u8_t ident_len, s32_t *ident);
JeffM 0:fd3b85615428 229 void (*get_value_pc)(u8_t rid, struct obj_def *od);
JeffM 0:fd3b85615428 230 void (*set_test_pc)(u8_t rid, struct obj_def *od);
JeffM 0:fd3b85615428 231 void (*set_value_pc)(u8_t rid, struct obj_def *od);
JeffM 0:fd3b85615428 232 };
JeffM 0:fd3b85615428 233
JeffM 0:fd3b85615428 234 /** export MIB tree from mib2.c */
JeffM 0:fd3b85615428 235 extern const struct mib_array_node internet;
JeffM 0:fd3b85615428 236
JeffM 0:fd3b85615428 237 /** dummy function pointers for non-leaf MIB nodes from mib2.c */
JeffM 0:fd3b85615428 238 void noleafs_get_object_def(u8_t ident_len, s32_t *ident, struct obj_def *od);
JeffM 0:fd3b85615428 239 void noleafs_get_value(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 240 u8_t noleafs_set_test(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 241 void noleafs_set_value(struct obj_def *od, u16_t len, void *value);
JeffM 0:fd3b85615428 242
JeffM 0:fd3b85615428 243 void snmp_oidtoip(s32_t *ident, ip_addr_t *ip);
JeffM 0:fd3b85615428 244 void snmp_iptooid(ip_addr_t *ip, s32_t *ident);
JeffM 0:fd3b85615428 245 void snmp_ifindextonetif(s32_t ifindex, struct netif **netif);
JeffM 0:fd3b85615428 246 void snmp_netiftoifindex(struct netif *netif, s32_t *ifidx);
JeffM 0:fd3b85615428 247
JeffM 0:fd3b85615428 248 struct mib_list_node* snmp_mib_ln_alloc(s32_t id);
JeffM 0:fd3b85615428 249 void snmp_mib_ln_free(struct mib_list_node *ln);
JeffM 0:fd3b85615428 250 struct mib_list_rootnode* snmp_mib_lrn_alloc(void);
JeffM 0:fd3b85615428 251 void snmp_mib_lrn_free(struct mib_list_rootnode *lrn);
JeffM 0:fd3b85615428 252
JeffM 0:fd3b85615428 253 s8_t snmp_mib_node_insert(struct mib_list_rootnode *rn, s32_t objid, struct mib_list_node **insn);
JeffM 0:fd3b85615428 254 s8_t snmp_mib_node_find(struct mib_list_rootnode *rn, s32_t objid, struct mib_list_node **fn);
JeffM 0:fd3b85615428 255 struct mib_list_rootnode *snmp_mib_node_delete(struct mib_list_rootnode *rn, struct mib_list_node *n);
JeffM 0:fd3b85615428 256
JeffM 0:fd3b85615428 257 struct mib_node* snmp_search_tree(struct mib_node *node, u8_t ident_len, s32_t *ident, struct snmp_name_ptr *np);
JeffM 0:fd3b85615428 258 struct mib_node* snmp_expand_tree(struct mib_node *node, u8_t ident_len, s32_t *ident, struct snmp_obj_id *oidret);
JeffM 0:fd3b85615428 259 u8_t snmp_iso_prefix_tst(u8_t ident_len, s32_t *ident);
JeffM 0:fd3b85615428 260 u8_t snmp_iso_prefix_expand(u8_t ident_len, s32_t *ident, struct snmp_obj_id *oidret);
JeffM 0:fd3b85615428 261
JeffM 0:fd3b85615428 262 #ifdef __cplusplus
JeffM 0:fd3b85615428 263 }
JeffM 0:fd3b85615428 264 #endif
JeffM 0:fd3b85615428 265
JeffM 0:fd3b85615428 266 #endif /* LWIP_SNMP */
JeffM 0:fd3b85615428 267
JeffM 0:fd3b85615428 268 #endif /* __LWIP_SNMP_STRUCTS_H__ */