mbed unsupported / lwip

A version of LWIP, provided for backwards compatibility.

Dependents:   AA_DemoBoard DemoBoard HelloServerDemo DemoBoard_RangeIndicator ... more

trunk/Core/lwIP/include/lwip/snmp_structs.h@0:5e1631496985, 2012-05-08 (annotated)

Committer:
root@mbed.org
Date:
Tue May 08 15:32:10 2012 +0100
Revision:
0:5e1631496985
initial commit

Who changed what in which revision?

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