This short program illustrates how to use the DS130x_I2C library. My objective is to share the same RTC with Microchip 18F MCU.

Dependencies:   mbed DebugLibrary

Committer:
Yann
Date:
Wed Feb 09 13:57:49 2011 +0000
Revision:
0:f30e2135b0db
V0.0.0.1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Yann 0:f30e2135b0db 1 /**
Yann 0:f30e2135b0db 2 * @file
Yann 0:f30e2135b0db 3 * Abstract Syntax Notation One (ISO 8824, 8825) encoding
Yann 0:f30e2135b0db 4 *
Yann 0:f30e2135b0db 5 * @todo not optimised (yet), favor correctness over speed, favor speed over size
Yann 0:f30e2135b0db 6 */
Yann 0:f30e2135b0db 7
Yann 0:f30e2135b0db 8 /*
Yann 0:f30e2135b0db 9 * Copyright (c) 2006 Axon Digital Design B.V., The Netherlands.
Yann 0:f30e2135b0db 10 * All rights reserved.
Yann 0:f30e2135b0db 11 *
Yann 0:f30e2135b0db 12 * Redistribution and use in source and binary forms, with or without modification,
Yann 0:f30e2135b0db 13 * are permitted provided that the following conditions are met:
Yann 0:f30e2135b0db 14 *
Yann 0:f30e2135b0db 15 * 1. Redistributions of source code must retain the above copyright notice,
Yann 0:f30e2135b0db 16 * this list of conditions and the following disclaimer.
Yann 0:f30e2135b0db 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
Yann 0:f30e2135b0db 18 * this list of conditions and the following disclaimer in the documentation
Yann 0:f30e2135b0db 19 * and/or other materials provided with the distribution.
Yann 0:f30e2135b0db 20 * 3. The name of the author may not be used to endorse or promote products
Yann 0:f30e2135b0db 21 * derived from this software without specific prior written permission.
Yann 0:f30e2135b0db 22 *
Yann 0:f30e2135b0db 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
Yann 0:f30e2135b0db 24 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
Yann 0:f30e2135b0db 25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
Yann 0:f30e2135b0db 26 * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
Yann 0:f30e2135b0db 27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
Yann 0:f30e2135b0db 28 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
Yann 0:f30e2135b0db 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
Yann 0:f30e2135b0db 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
Yann 0:f30e2135b0db 31 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
Yann 0:f30e2135b0db 32 * OF SUCH DAMAGE.
Yann 0:f30e2135b0db 33 *
Yann 0:f30e2135b0db 34 * Author: Christiaan Simons <christiaan.simons@axon.tv>
Yann 0:f30e2135b0db 35 */
Yann 0:f30e2135b0db 36
Yann 0:f30e2135b0db 37 #include "lwip/opt.h"
Yann 0:f30e2135b0db 38
Yann 0:f30e2135b0db 39 #if LWIP_SNMP /* don't build if not configured for use in lwipopts.h */
Yann 0:f30e2135b0db 40
Yann 0:f30e2135b0db 41 #include "lwip/snmp_asn1.h"
Yann 0:f30e2135b0db 42
Yann 0:f30e2135b0db 43 /**
Yann 0:f30e2135b0db 44 * Returns octet count for length.
Yann 0:f30e2135b0db 45 *
Yann 0:f30e2135b0db 46 * @param length
Yann 0:f30e2135b0db 47 * @param octets_needed points to the return value
Yann 0:f30e2135b0db 48 */
Yann 0:f30e2135b0db 49 void
Yann 0:f30e2135b0db 50 snmp_asn1_enc_length_cnt(u16_t length, u8_t *octets_needed)
Yann 0:f30e2135b0db 51 {
Yann 0:f30e2135b0db 52 if (length < 0x80U)
Yann 0:f30e2135b0db 53 {
Yann 0:f30e2135b0db 54 *octets_needed = 1;
Yann 0:f30e2135b0db 55 }
Yann 0:f30e2135b0db 56 else if (length < 0x100U)
Yann 0:f30e2135b0db 57 {
Yann 0:f30e2135b0db 58 *octets_needed = 2;
Yann 0:f30e2135b0db 59 }
Yann 0:f30e2135b0db 60 else
Yann 0:f30e2135b0db 61 {
Yann 0:f30e2135b0db 62 *octets_needed = 3;
Yann 0:f30e2135b0db 63 }
Yann 0:f30e2135b0db 64 }
Yann 0:f30e2135b0db 65
Yann 0:f30e2135b0db 66 /**
Yann 0:f30e2135b0db 67 * Returns octet count for an u32_t.
Yann 0:f30e2135b0db 68 *
Yann 0:f30e2135b0db 69 * @param value
Yann 0:f30e2135b0db 70 * @param octets_needed points to the return value
Yann 0:f30e2135b0db 71 *
Yann 0:f30e2135b0db 72 * @note ASN coded integers are _always_ signed. E.g. +0xFFFF is coded
Yann 0:f30e2135b0db 73 * as 0x00,0xFF,0xFF. Note the leading sign octet. A positive value
Yann 0:f30e2135b0db 74 * of 0xFFFFFFFF is preceded with 0x00 and the length is 5 octets!!
Yann 0:f30e2135b0db 75 */
Yann 0:f30e2135b0db 76 void
Yann 0:f30e2135b0db 77 snmp_asn1_enc_u32t_cnt(u32_t value, u16_t *octets_needed)
Yann 0:f30e2135b0db 78 {
Yann 0:f30e2135b0db 79 if (value < 0x80UL)
Yann 0:f30e2135b0db 80 {
Yann 0:f30e2135b0db 81 *octets_needed = 1;
Yann 0:f30e2135b0db 82 }
Yann 0:f30e2135b0db 83 else if (value < 0x8000UL)
Yann 0:f30e2135b0db 84 {
Yann 0:f30e2135b0db 85 *octets_needed = 2;
Yann 0:f30e2135b0db 86 }
Yann 0:f30e2135b0db 87 else if (value < 0x800000UL)
Yann 0:f30e2135b0db 88 {
Yann 0:f30e2135b0db 89 *octets_needed = 3;
Yann 0:f30e2135b0db 90 }
Yann 0:f30e2135b0db 91 else if (value < 0x80000000UL)
Yann 0:f30e2135b0db 92 {
Yann 0:f30e2135b0db 93 *octets_needed = 4;
Yann 0:f30e2135b0db 94 }
Yann 0:f30e2135b0db 95 else
Yann 0:f30e2135b0db 96 {
Yann 0:f30e2135b0db 97 *octets_needed = 5;
Yann 0:f30e2135b0db 98 }
Yann 0:f30e2135b0db 99 }
Yann 0:f30e2135b0db 100
Yann 0:f30e2135b0db 101 /**
Yann 0:f30e2135b0db 102 * Returns octet count for an s32_t.
Yann 0:f30e2135b0db 103 *
Yann 0:f30e2135b0db 104 * @param value
Yann 0:f30e2135b0db 105 * @param octets_needed points to the return value
Yann 0:f30e2135b0db 106 *
Yann 0:f30e2135b0db 107 * @note ASN coded integers are _always_ signed.
Yann 0:f30e2135b0db 108 */
Yann 0:f30e2135b0db 109 void
Yann 0:f30e2135b0db 110 snmp_asn1_enc_s32t_cnt(s32_t value, u16_t *octets_needed)
Yann 0:f30e2135b0db 111 {
Yann 0:f30e2135b0db 112 if (value < 0)
Yann 0:f30e2135b0db 113 {
Yann 0:f30e2135b0db 114 value = ~value;
Yann 0:f30e2135b0db 115 }
Yann 0:f30e2135b0db 116 if (value < 0x80L)
Yann 0:f30e2135b0db 117 {
Yann 0:f30e2135b0db 118 *octets_needed = 1;
Yann 0:f30e2135b0db 119 }
Yann 0:f30e2135b0db 120 else if (value < 0x8000L)
Yann 0:f30e2135b0db 121 {
Yann 0:f30e2135b0db 122 *octets_needed = 2;
Yann 0:f30e2135b0db 123 }
Yann 0:f30e2135b0db 124 else if (value < 0x800000L)
Yann 0:f30e2135b0db 125 {
Yann 0:f30e2135b0db 126 *octets_needed = 3;
Yann 0:f30e2135b0db 127 }
Yann 0:f30e2135b0db 128 else
Yann 0:f30e2135b0db 129 {
Yann 0:f30e2135b0db 130 *octets_needed = 4;
Yann 0:f30e2135b0db 131 }
Yann 0:f30e2135b0db 132 }
Yann 0:f30e2135b0db 133
Yann 0:f30e2135b0db 134 /**
Yann 0:f30e2135b0db 135 * Returns octet count for an object identifier.
Yann 0:f30e2135b0db 136 *
Yann 0:f30e2135b0db 137 * @param ident_len object identifier array length
Yann 0:f30e2135b0db 138 * @param ident points to object identifier array
Yann 0:f30e2135b0db 139 * @param octets_needed points to the return value
Yann 0:f30e2135b0db 140 */
Yann 0:f30e2135b0db 141 void
Yann 0:f30e2135b0db 142 snmp_asn1_enc_oid_cnt(u8_t ident_len, s32_t *ident, u16_t *octets_needed)
Yann 0:f30e2135b0db 143 {
Yann 0:f30e2135b0db 144 s32_t sub_id;
Yann 0:f30e2135b0db 145 u8_t cnt;
Yann 0:f30e2135b0db 146
Yann 0:f30e2135b0db 147 cnt = 0;
Yann 0:f30e2135b0db 148 if (ident_len > 1)
Yann 0:f30e2135b0db 149 {
Yann 0:f30e2135b0db 150 /* compressed prefix in one octet */
Yann 0:f30e2135b0db 151 cnt++;
Yann 0:f30e2135b0db 152 ident_len -= 2;
Yann 0:f30e2135b0db 153 ident += 2;
Yann 0:f30e2135b0db 154 }
Yann 0:f30e2135b0db 155 while(ident_len > 0)
Yann 0:f30e2135b0db 156 {
Yann 0:f30e2135b0db 157 ident_len--;
Yann 0:f30e2135b0db 158 sub_id = *ident;
Yann 0:f30e2135b0db 159
Yann 0:f30e2135b0db 160 sub_id >>= 7;
Yann 0:f30e2135b0db 161 cnt++;
Yann 0:f30e2135b0db 162 while(sub_id > 0)
Yann 0:f30e2135b0db 163 {
Yann 0:f30e2135b0db 164 sub_id >>= 7;
Yann 0:f30e2135b0db 165 cnt++;
Yann 0:f30e2135b0db 166 }
Yann 0:f30e2135b0db 167 ident++;
Yann 0:f30e2135b0db 168 }
Yann 0:f30e2135b0db 169 *octets_needed = cnt;
Yann 0:f30e2135b0db 170 }
Yann 0:f30e2135b0db 171
Yann 0:f30e2135b0db 172 /**
Yann 0:f30e2135b0db 173 * Encodes ASN type field into a pbuf chained ASN1 msg.
Yann 0:f30e2135b0db 174 *
Yann 0:f30e2135b0db 175 * @param p points to output pbuf to encode value into
Yann 0:f30e2135b0db 176 * @param ofs points to the offset within the pbuf chain
Yann 0:f30e2135b0db 177 * @param type input ASN1 type
Yann 0:f30e2135b0db 178 * @return ERR_OK if successfull, ERR_ARG if we can't (or won't) encode
Yann 0:f30e2135b0db 179 */
Yann 0:f30e2135b0db 180 err_t
Yann 0:f30e2135b0db 181 snmp_asn1_enc_type(struct pbuf *p, u16_t ofs, u8_t type)
Yann 0:f30e2135b0db 182 {
Yann 0:f30e2135b0db 183 u16_t plen, base;
Yann 0:f30e2135b0db 184 u8_t *msg_ptr;
Yann 0:f30e2135b0db 185
Yann 0:f30e2135b0db 186 plen = 0;
Yann 0:f30e2135b0db 187 while (p != NULL)
Yann 0:f30e2135b0db 188 {
Yann 0:f30e2135b0db 189 base = plen;
Yann 0:f30e2135b0db 190 plen += p->len;
Yann 0:f30e2135b0db 191 if (ofs < plen)
Yann 0:f30e2135b0db 192 {
Yann 0:f30e2135b0db 193 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 194 msg_ptr += ofs - base;
Yann 0:f30e2135b0db 195 *msg_ptr = type;
Yann 0:f30e2135b0db 196 return ERR_OK;
Yann 0:f30e2135b0db 197 }
Yann 0:f30e2135b0db 198 p = p->next;
Yann 0:f30e2135b0db 199 }
Yann 0:f30e2135b0db 200 /* p == NULL, ofs >= plen */
Yann 0:f30e2135b0db 201 return ERR_ARG;
Yann 0:f30e2135b0db 202 }
Yann 0:f30e2135b0db 203
Yann 0:f30e2135b0db 204 /**
Yann 0:f30e2135b0db 205 * Encodes host order length field into a pbuf chained ASN1 msg.
Yann 0:f30e2135b0db 206 *
Yann 0:f30e2135b0db 207 * @param p points to output pbuf to encode length into
Yann 0:f30e2135b0db 208 * @param ofs points to the offset within the pbuf chain
Yann 0:f30e2135b0db 209 * @param length is the host order length to be encoded
Yann 0:f30e2135b0db 210 * @return ERR_OK if successfull, ERR_ARG if we can't (or won't) encode
Yann 0:f30e2135b0db 211 */
Yann 0:f30e2135b0db 212 err_t
Yann 0:f30e2135b0db 213 snmp_asn1_enc_length(struct pbuf *p, u16_t ofs, u16_t length)
Yann 0:f30e2135b0db 214 {
Yann 0:f30e2135b0db 215 u16_t plen, base;
Yann 0:f30e2135b0db 216 u8_t *msg_ptr;
Yann 0:f30e2135b0db 217
Yann 0:f30e2135b0db 218 plen = 0;
Yann 0:f30e2135b0db 219 while (p != NULL)
Yann 0:f30e2135b0db 220 {
Yann 0:f30e2135b0db 221 base = plen;
Yann 0:f30e2135b0db 222 plen += p->len;
Yann 0:f30e2135b0db 223 if (ofs < plen)
Yann 0:f30e2135b0db 224 {
Yann 0:f30e2135b0db 225 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 226 msg_ptr += ofs - base;
Yann 0:f30e2135b0db 227
Yann 0:f30e2135b0db 228 if (length < 0x80)
Yann 0:f30e2135b0db 229 {
Yann 0:f30e2135b0db 230 *msg_ptr = (u8_t)length;
Yann 0:f30e2135b0db 231 return ERR_OK;
Yann 0:f30e2135b0db 232 }
Yann 0:f30e2135b0db 233 else if (length < 0x100)
Yann 0:f30e2135b0db 234 {
Yann 0:f30e2135b0db 235 *msg_ptr = 0x81;
Yann 0:f30e2135b0db 236 ofs += 1;
Yann 0:f30e2135b0db 237 if (ofs >= plen)
Yann 0:f30e2135b0db 238 {
Yann 0:f30e2135b0db 239 /* next octet in next pbuf */
Yann 0:f30e2135b0db 240 p = p->next;
Yann 0:f30e2135b0db 241 if (p == NULL) { return ERR_ARG; }
Yann 0:f30e2135b0db 242 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 243 }
Yann 0:f30e2135b0db 244 else
Yann 0:f30e2135b0db 245 {
Yann 0:f30e2135b0db 246 /* next octet in same pbuf */
Yann 0:f30e2135b0db 247 msg_ptr++;
Yann 0:f30e2135b0db 248 }
Yann 0:f30e2135b0db 249 *msg_ptr = (u8_t)length;
Yann 0:f30e2135b0db 250 return ERR_OK;
Yann 0:f30e2135b0db 251 }
Yann 0:f30e2135b0db 252 else
Yann 0:f30e2135b0db 253 {
Yann 0:f30e2135b0db 254 u8_t i;
Yann 0:f30e2135b0db 255
Yann 0:f30e2135b0db 256 /* length >= 0x100 && length <= 0xFFFF */
Yann 0:f30e2135b0db 257 *msg_ptr = 0x82;
Yann 0:f30e2135b0db 258 i = 2;
Yann 0:f30e2135b0db 259 while (i > 0)
Yann 0:f30e2135b0db 260 {
Yann 0:f30e2135b0db 261 i--;
Yann 0:f30e2135b0db 262 ofs += 1;
Yann 0:f30e2135b0db 263 if (ofs >= plen)
Yann 0:f30e2135b0db 264 {
Yann 0:f30e2135b0db 265 /* next octet in next pbuf */
Yann 0:f30e2135b0db 266 p = p->next;
Yann 0:f30e2135b0db 267 if (p == NULL) { return ERR_ARG; }
Yann 0:f30e2135b0db 268 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 269 plen += p->len;
Yann 0:f30e2135b0db 270 }
Yann 0:f30e2135b0db 271 else
Yann 0:f30e2135b0db 272 {
Yann 0:f30e2135b0db 273 /* next octet in same pbuf */
Yann 0:f30e2135b0db 274 msg_ptr++;
Yann 0:f30e2135b0db 275 }
Yann 0:f30e2135b0db 276 if (i == 0)
Yann 0:f30e2135b0db 277 {
Yann 0:f30e2135b0db 278 /* least significant length octet */
Yann 0:f30e2135b0db 279 *msg_ptr = (u8_t)length;
Yann 0:f30e2135b0db 280 }
Yann 0:f30e2135b0db 281 else
Yann 0:f30e2135b0db 282 {
Yann 0:f30e2135b0db 283 /* most significant length octet */
Yann 0:f30e2135b0db 284 *msg_ptr = (u8_t)(length >> 8);
Yann 0:f30e2135b0db 285 }
Yann 0:f30e2135b0db 286 }
Yann 0:f30e2135b0db 287 return ERR_OK;
Yann 0:f30e2135b0db 288 }
Yann 0:f30e2135b0db 289 }
Yann 0:f30e2135b0db 290 p = p->next;
Yann 0:f30e2135b0db 291 }
Yann 0:f30e2135b0db 292 /* p == NULL, ofs >= plen */
Yann 0:f30e2135b0db 293 return ERR_ARG;
Yann 0:f30e2135b0db 294 }
Yann 0:f30e2135b0db 295
Yann 0:f30e2135b0db 296 /**
Yann 0:f30e2135b0db 297 * Encodes u32_t (counter, gauge, timeticks) into a pbuf chained ASN1 msg.
Yann 0:f30e2135b0db 298 *
Yann 0:f30e2135b0db 299 * @param p points to output pbuf to encode value into
Yann 0:f30e2135b0db 300 * @param ofs points to the offset within the pbuf chain
Yann 0:f30e2135b0db 301 * @param octets_needed encoding length (from snmp_asn1_enc_u32t_cnt())
Yann 0:f30e2135b0db 302 * @param value is the host order u32_t value to be encoded
Yann 0:f30e2135b0db 303 * @return ERR_OK if successfull, ERR_ARG if we can't (or won't) encode
Yann 0:f30e2135b0db 304 *
Yann 0:f30e2135b0db 305 * @see snmp_asn1_enc_u32t_cnt()
Yann 0:f30e2135b0db 306 */
Yann 0:f30e2135b0db 307 err_t
Yann 0:f30e2135b0db 308 snmp_asn1_enc_u32t(struct pbuf *p, u16_t ofs, u16_t octets_needed, u32_t value)
Yann 0:f30e2135b0db 309 {
Yann 0:f30e2135b0db 310 u16_t plen, base;
Yann 0:f30e2135b0db 311 u8_t *msg_ptr;
Yann 0:f30e2135b0db 312
Yann 0:f30e2135b0db 313 plen = 0;
Yann 0:f30e2135b0db 314 while (p != NULL)
Yann 0:f30e2135b0db 315 {
Yann 0:f30e2135b0db 316 base = plen;
Yann 0:f30e2135b0db 317 plen += p->len;
Yann 0:f30e2135b0db 318 if (ofs < plen)
Yann 0:f30e2135b0db 319 {
Yann 0:f30e2135b0db 320 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 321 msg_ptr += ofs - base;
Yann 0:f30e2135b0db 322
Yann 0:f30e2135b0db 323 if (octets_needed == 5)
Yann 0:f30e2135b0db 324 {
Yann 0:f30e2135b0db 325 /* not enough bits in 'value' add leading 0x00 */
Yann 0:f30e2135b0db 326 octets_needed--;
Yann 0:f30e2135b0db 327 *msg_ptr = 0x00;
Yann 0:f30e2135b0db 328 ofs += 1;
Yann 0:f30e2135b0db 329 if (ofs >= plen)
Yann 0:f30e2135b0db 330 {
Yann 0:f30e2135b0db 331 /* next octet in next pbuf */
Yann 0:f30e2135b0db 332 p = p->next;
Yann 0:f30e2135b0db 333 if (p == NULL) { return ERR_ARG; }
Yann 0:f30e2135b0db 334 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 335 plen += p->len;
Yann 0:f30e2135b0db 336 }
Yann 0:f30e2135b0db 337 else
Yann 0:f30e2135b0db 338 {
Yann 0:f30e2135b0db 339 /* next octet in same pbuf */
Yann 0:f30e2135b0db 340 msg_ptr++;
Yann 0:f30e2135b0db 341 }
Yann 0:f30e2135b0db 342 }
Yann 0:f30e2135b0db 343 while (octets_needed > 1)
Yann 0:f30e2135b0db 344 {
Yann 0:f30e2135b0db 345 octets_needed--;
Yann 0:f30e2135b0db 346 *msg_ptr = (u8_t)(value >> (octets_needed << 3));
Yann 0:f30e2135b0db 347 ofs += 1;
Yann 0:f30e2135b0db 348 if (ofs >= plen)
Yann 0:f30e2135b0db 349 {
Yann 0:f30e2135b0db 350 /* next octet in next pbuf */
Yann 0:f30e2135b0db 351 p = p->next;
Yann 0:f30e2135b0db 352 if (p == NULL) { return ERR_ARG; }
Yann 0:f30e2135b0db 353 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 354 plen += p->len;
Yann 0:f30e2135b0db 355 }
Yann 0:f30e2135b0db 356 else
Yann 0:f30e2135b0db 357 {
Yann 0:f30e2135b0db 358 /* next octet in same pbuf */
Yann 0:f30e2135b0db 359 msg_ptr++;
Yann 0:f30e2135b0db 360 }
Yann 0:f30e2135b0db 361 }
Yann 0:f30e2135b0db 362 /* (only) one least significant octet */
Yann 0:f30e2135b0db 363 *msg_ptr = (u8_t)value;
Yann 0:f30e2135b0db 364 return ERR_OK;
Yann 0:f30e2135b0db 365 }
Yann 0:f30e2135b0db 366 p = p->next;
Yann 0:f30e2135b0db 367 }
Yann 0:f30e2135b0db 368 /* p == NULL, ofs >= plen */
Yann 0:f30e2135b0db 369 return ERR_ARG;
Yann 0:f30e2135b0db 370 }
Yann 0:f30e2135b0db 371
Yann 0:f30e2135b0db 372 /**
Yann 0:f30e2135b0db 373 * Encodes s32_t integer into a pbuf chained ASN1 msg.
Yann 0:f30e2135b0db 374 *
Yann 0:f30e2135b0db 375 * @param p points to output pbuf to encode value into
Yann 0:f30e2135b0db 376 * @param ofs points to the offset within the pbuf chain
Yann 0:f30e2135b0db 377 * @param octets_needed encoding length (from snmp_asn1_enc_s32t_cnt())
Yann 0:f30e2135b0db 378 * @param value is the host order s32_t value to be encoded
Yann 0:f30e2135b0db 379 * @return ERR_OK if successfull, ERR_ARG if we can't (or won't) encode
Yann 0:f30e2135b0db 380 *
Yann 0:f30e2135b0db 381 * @see snmp_asn1_enc_s32t_cnt()
Yann 0:f30e2135b0db 382 */
Yann 0:f30e2135b0db 383 err_t
Yann 0:f30e2135b0db 384 snmp_asn1_enc_s32t(struct pbuf *p, u16_t ofs, u16_t octets_needed, s32_t value)
Yann 0:f30e2135b0db 385 {
Yann 0:f30e2135b0db 386 u16_t plen, base;
Yann 0:f30e2135b0db 387 u8_t *msg_ptr;
Yann 0:f30e2135b0db 388
Yann 0:f30e2135b0db 389 plen = 0;
Yann 0:f30e2135b0db 390 while (p != NULL)
Yann 0:f30e2135b0db 391 {
Yann 0:f30e2135b0db 392 base = plen;
Yann 0:f30e2135b0db 393 plen += p->len;
Yann 0:f30e2135b0db 394 if (ofs < plen)
Yann 0:f30e2135b0db 395 {
Yann 0:f30e2135b0db 396 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 397 msg_ptr += ofs - base;
Yann 0:f30e2135b0db 398
Yann 0:f30e2135b0db 399 while (octets_needed > 1)
Yann 0:f30e2135b0db 400 {
Yann 0:f30e2135b0db 401 octets_needed--;
Yann 0:f30e2135b0db 402 *msg_ptr = (u8_t)(value >> (octets_needed << 3));
Yann 0:f30e2135b0db 403 ofs += 1;
Yann 0:f30e2135b0db 404 if (ofs >= plen)
Yann 0:f30e2135b0db 405 {
Yann 0:f30e2135b0db 406 /* next octet in next pbuf */
Yann 0:f30e2135b0db 407 p = p->next;
Yann 0:f30e2135b0db 408 if (p == NULL) { return ERR_ARG; }
Yann 0:f30e2135b0db 409 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 410 plen += p->len;
Yann 0:f30e2135b0db 411 }
Yann 0:f30e2135b0db 412 else
Yann 0:f30e2135b0db 413 {
Yann 0:f30e2135b0db 414 /* next octet in same pbuf */
Yann 0:f30e2135b0db 415 msg_ptr++;
Yann 0:f30e2135b0db 416 }
Yann 0:f30e2135b0db 417 }
Yann 0:f30e2135b0db 418 /* (only) one least significant octet */
Yann 0:f30e2135b0db 419 *msg_ptr = (u8_t)value;
Yann 0:f30e2135b0db 420 return ERR_OK;
Yann 0:f30e2135b0db 421 }
Yann 0:f30e2135b0db 422 p = p->next;
Yann 0:f30e2135b0db 423 }
Yann 0:f30e2135b0db 424 /* p == NULL, ofs >= plen */
Yann 0:f30e2135b0db 425 return ERR_ARG;
Yann 0:f30e2135b0db 426 }
Yann 0:f30e2135b0db 427
Yann 0:f30e2135b0db 428 /**
Yann 0:f30e2135b0db 429 * Encodes object identifier into a pbuf chained ASN1 msg.
Yann 0:f30e2135b0db 430 *
Yann 0:f30e2135b0db 431 * @param p points to output pbuf to encode oid into
Yann 0:f30e2135b0db 432 * @param ofs points to the offset within the pbuf chain
Yann 0:f30e2135b0db 433 * @param ident_len object identifier array length
Yann 0:f30e2135b0db 434 * @param ident points to object identifier array
Yann 0:f30e2135b0db 435 * @return ERR_OK if successfull, ERR_ARG if we can't (or won't) encode
Yann 0:f30e2135b0db 436 */
Yann 0:f30e2135b0db 437 err_t
Yann 0:f30e2135b0db 438 snmp_asn1_enc_oid(struct pbuf *p, u16_t ofs, u8_t ident_len, s32_t *ident)
Yann 0:f30e2135b0db 439 {
Yann 0:f30e2135b0db 440 u16_t plen, base;
Yann 0:f30e2135b0db 441 u8_t *msg_ptr;
Yann 0:f30e2135b0db 442
Yann 0:f30e2135b0db 443 plen = 0;
Yann 0:f30e2135b0db 444 while (p != NULL)
Yann 0:f30e2135b0db 445 {
Yann 0:f30e2135b0db 446 base = plen;
Yann 0:f30e2135b0db 447 plen += p->len;
Yann 0:f30e2135b0db 448 if (ofs < plen)
Yann 0:f30e2135b0db 449 {
Yann 0:f30e2135b0db 450 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 451 msg_ptr += ofs - base;
Yann 0:f30e2135b0db 452
Yann 0:f30e2135b0db 453 if (ident_len > 1)
Yann 0:f30e2135b0db 454 {
Yann 0:f30e2135b0db 455 if ((ident[0] == 1) && (ident[1] == 3))
Yann 0:f30e2135b0db 456 {
Yann 0:f30e2135b0db 457 /* compressed (most common) prefix .iso.org */
Yann 0:f30e2135b0db 458 *msg_ptr = 0x2b;
Yann 0:f30e2135b0db 459 }
Yann 0:f30e2135b0db 460 else
Yann 0:f30e2135b0db 461 {
Yann 0:f30e2135b0db 462 /* calculate prefix */
Yann 0:f30e2135b0db 463 *msg_ptr = (u8_t)((ident[0] * 40) + ident[1]);
Yann 0:f30e2135b0db 464 }
Yann 0:f30e2135b0db 465 ofs += 1;
Yann 0:f30e2135b0db 466 if (ofs >= plen)
Yann 0:f30e2135b0db 467 {
Yann 0:f30e2135b0db 468 /* next octet in next pbuf */
Yann 0:f30e2135b0db 469 p = p->next;
Yann 0:f30e2135b0db 470 if (p == NULL) { return ERR_ARG; }
Yann 0:f30e2135b0db 471 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 472 plen += p->len;
Yann 0:f30e2135b0db 473 }
Yann 0:f30e2135b0db 474 else
Yann 0:f30e2135b0db 475 {
Yann 0:f30e2135b0db 476 /* next octet in same pbuf */
Yann 0:f30e2135b0db 477 msg_ptr++;
Yann 0:f30e2135b0db 478 }
Yann 0:f30e2135b0db 479 ident_len -= 2;
Yann 0:f30e2135b0db 480 ident += 2;
Yann 0:f30e2135b0db 481 }
Yann 0:f30e2135b0db 482 else
Yann 0:f30e2135b0db 483 {
Yann 0:f30e2135b0db 484 /* @bug: allow empty varbinds for symmetry (we must decode them for getnext), allow partial compression?? */
Yann 0:f30e2135b0db 485 /* ident_len <= 1, at least we need zeroDotZero (0.0) (ident_len == 2) */
Yann 0:f30e2135b0db 486 return ERR_ARG;
Yann 0:f30e2135b0db 487 }
Yann 0:f30e2135b0db 488 while (ident_len > 0)
Yann 0:f30e2135b0db 489 {
Yann 0:f30e2135b0db 490 s32_t sub_id;
Yann 0:f30e2135b0db 491 u8_t shift, tail;
Yann 0:f30e2135b0db 492
Yann 0:f30e2135b0db 493 ident_len--;
Yann 0:f30e2135b0db 494 sub_id = *ident;
Yann 0:f30e2135b0db 495 tail = 0;
Yann 0:f30e2135b0db 496 shift = 28;
Yann 0:f30e2135b0db 497 while(shift > 0)
Yann 0:f30e2135b0db 498 {
Yann 0:f30e2135b0db 499 u8_t code;
Yann 0:f30e2135b0db 500
Yann 0:f30e2135b0db 501 code = (u8_t)(sub_id >> shift);
Yann 0:f30e2135b0db 502 if ((code != 0) || (tail != 0))
Yann 0:f30e2135b0db 503 {
Yann 0:f30e2135b0db 504 tail = 1;
Yann 0:f30e2135b0db 505 *msg_ptr = code | 0x80;
Yann 0:f30e2135b0db 506 ofs += 1;
Yann 0:f30e2135b0db 507 if (ofs >= plen)
Yann 0:f30e2135b0db 508 {
Yann 0:f30e2135b0db 509 /* next octet in next pbuf */
Yann 0:f30e2135b0db 510 p = p->next;
Yann 0:f30e2135b0db 511 if (p == NULL) { return ERR_ARG; }
Yann 0:f30e2135b0db 512 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 513 plen += p->len;
Yann 0:f30e2135b0db 514 }
Yann 0:f30e2135b0db 515 else
Yann 0:f30e2135b0db 516 {
Yann 0:f30e2135b0db 517 /* next octet in same pbuf */
Yann 0:f30e2135b0db 518 msg_ptr++;
Yann 0:f30e2135b0db 519 }
Yann 0:f30e2135b0db 520 }
Yann 0:f30e2135b0db 521 shift -= 7;
Yann 0:f30e2135b0db 522 }
Yann 0:f30e2135b0db 523 *msg_ptr = (u8_t)sub_id & 0x7F;
Yann 0:f30e2135b0db 524 if (ident_len > 0)
Yann 0:f30e2135b0db 525 {
Yann 0:f30e2135b0db 526 ofs += 1;
Yann 0:f30e2135b0db 527 if (ofs >= plen)
Yann 0:f30e2135b0db 528 {
Yann 0:f30e2135b0db 529 /* next octet in next pbuf */
Yann 0:f30e2135b0db 530 p = p->next;
Yann 0:f30e2135b0db 531 if (p == NULL) { return ERR_ARG; }
Yann 0:f30e2135b0db 532 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 533 plen += p->len;
Yann 0:f30e2135b0db 534 }
Yann 0:f30e2135b0db 535 else
Yann 0:f30e2135b0db 536 {
Yann 0:f30e2135b0db 537 /* next octet in same pbuf */
Yann 0:f30e2135b0db 538 msg_ptr++;
Yann 0:f30e2135b0db 539 }
Yann 0:f30e2135b0db 540 }
Yann 0:f30e2135b0db 541 /* proceed to next sub-identifier */
Yann 0:f30e2135b0db 542 ident++;
Yann 0:f30e2135b0db 543 }
Yann 0:f30e2135b0db 544 return ERR_OK;
Yann 0:f30e2135b0db 545 }
Yann 0:f30e2135b0db 546 p = p->next;
Yann 0:f30e2135b0db 547 }
Yann 0:f30e2135b0db 548 /* p == NULL, ofs >= plen */
Yann 0:f30e2135b0db 549 return ERR_ARG;
Yann 0:f30e2135b0db 550 }
Yann 0:f30e2135b0db 551
Yann 0:f30e2135b0db 552 /**
Yann 0:f30e2135b0db 553 * Encodes raw data (octet string, opaque) into a pbuf chained ASN1 msg.
Yann 0:f30e2135b0db 554 *
Yann 0:f30e2135b0db 555 * @param p points to output pbuf to encode raw data into
Yann 0:f30e2135b0db 556 * @param ofs points to the offset within the pbuf chain
Yann 0:f30e2135b0db 557 * @param raw_len raw data length
Yann 0:f30e2135b0db 558 * @param raw points raw data
Yann 0:f30e2135b0db 559 * @return ERR_OK if successfull, ERR_ARG if we can't (or won't) encode
Yann 0:f30e2135b0db 560 */
Yann 0:f30e2135b0db 561 err_t
Yann 0:f30e2135b0db 562 snmp_asn1_enc_raw(struct pbuf *p, u16_t ofs, u16_t raw_len, u8_t *raw)
Yann 0:f30e2135b0db 563 {
Yann 0:f30e2135b0db 564 u16_t plen, base;
Yann 0:f30e2135b0db 565 u8_t *msg_ptr;
Yann 0:f30e2135b0db 566
Yann 0:f30e2135b0db 567 plen = 0;
Yann 0:f30e2135b0db 568 while (p != NULL)
Yann 0:f30e2135b0db 569 {
Yann 0:f30e2135b0db 570 base = plen;
Yann 0:f30e2135b0db 571 plen += p->len;
Yann 0:f30e2135b0db 572 if (ofs < plen)
Yann 0:f30e2135b0db 573 {
Yann 0:f30e2135b0db 574 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 575 msg_ptr += ofs - base;
Yann 0:f30e2135b0db 576
Yann 0:f30e2135b0db 577 while (raw_len > 1)
Yann 0:f30e2135b0db 578 {
Yann 0:f30e2135b0db 579 /* copy raw_len - 1 octets */
Yann 0:f30e2135b0db 580 raw_len--;
Yann 0:f30e2135b0db 581 *msg_ptr = *raw;
Yann 0:f30e2135b0db 582 raw++;
Yann 0:f30e2135b0db 583 ofs += 1;
Yann 0:f30e2135b0db 584 if (ofs >= plen)
Yann 0:f30e2135b0db 585 {
Yann 0:f30e2135b0db 586 /* next octet in next pbuf */
Yann 0:f30e2135b0db 587 p = p->next;
Yann 0:f30e2135b0db 588 if (p == NULL) { return ERR_ARG; }
Yann 0:f30e2135b0db 589 msg_ptr = (u8_t*)p->payload;
Yann 0:f30e2135b0db 590 plen += p->len;
Yann 0:f30e2135b0db 591 }
Yann 0:f30e2135b0db 592 else
Yann 0:f30e2135b0db 593 {
Yann 0:f30e2135b0db 594 /* next octet in same pbuf */
Yann 0:f30e2135b0db 595 msg_ptr++;
Yann 0:f30e2135b0db 596 }
Yann 0:f30e2135b0db 597 }
Yann 0:f30e2135b0db 598 if (raw_len > 0)
Yann 0:f30e2135b0db 599 {
Yann 0:f30e2135b0db 600 /* copy last or single octet */
Yann 0:f30e2135b0db 601 *msg_ptr = *raw;
Yann 0:f30e2135b0db 602 }
Yann 0:f30e2135b0db 603 return ERR_OK;
Yann 0:f30e2135b0db 604 }
Yann 0:f30e2135b0db 605 p = p->next;
Yann 0:f30e2135b0db 606 }
Yann 0:f30e2135b0db 607 /* p == NULL, ofs >= plen */
Yann 0:f30e2135b0db 608 return ERR_ARG;
Yann 0:f30e2135b0db 609 }
Yann 0:f30e2135b0db 610
Yann 0:f30e2135b0db 611 #endif /* LWIP_SNMP */