SiSK / EthernetInterface

fdsf

Dependents:   sisk_proj_stat MQTT Hello_FXOS8700Q WireFSHandControl ... more

lwip/include/lwip/snmp_structs.h@0:d7bd7384a37c, 2016-12-07 (annotated)

Committer:
grzemich
Date:
Wed Dec 07 23:47:50 2016 +0000
Revision:
0:d7bd7384a37c
dgd

Who changed what in which revision?

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