Trial code integration web page update with analogue data and ntp support

Dependencies:   NTPClient_NetServices mbed

Committer:
pmr1
Date:
Fri Aug 06 17:57:45 2010 +0000
Revision:
0:8cc2035bebfc

        

Who changed what in which revision?

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