Hi. This is the feed program for Cosm. (The previous name of the services is Pachube.)

Dependencies:   mbed ThermistorPack Pachube ConfigFile EthernetNetIf TextLCD HTTPClient_ToBeRemoved FatFileSystem SDFileSystem

Committer:
shintamainjp
Date:
Mon Aug 06 12:37:59 2012 +0000
Revision:
0:521ba375aa0f
Pachube renamed to Cosm.

Who changed what in which revision?

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