Ethernet test for ECE 4180 and others to find your IP address and do a simple HTTP GET request over port 80.

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Committer:
mkersh3
Date:
Thu Apr 04 05:26:09 2013 +0000
Revision:
0:e7ca326e76ee
Ethernet Test for ECE4180 and others to find their IP Address and do a simple HTTP GET request over port 80.

Who changed what in which revision?

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