ProjetoBB

Dependencies:   F7_Ethernet WebSocketClient mbed mcp3008

Fork of Nucleo_F746ZG_Ethernet by Dieter Graef

Committer:
DieterGraef
Date:
Sat Jun 18 10:49:12 2016 +0000
Revision:
0:f9b6112278fe
Ethernet for the NUCLEO STM32F746 Board Testprogram uses DHCP and NTP to set the clock

Who changed what in which revision?

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