Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 1 | #ifndef _TLV_H |
| 2 | #define _TLV_H |
| 3 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 4 | #include <stdint.h> |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 5 | #include <string.h> |
| 6 | |
Harald Welte | dfe6c7d | 2010-02-20 16:24:02 +0100 | [diff] [blame] | 7 | #include <osmocore/msgb.h> |
Harald Welte | 91b5b0d | 2009-02-06 12:51:39 +0000 | [diff] [blame] | 8 | |
Harald Welte | 73310c3 | 2009-10-24 10:04:02 +0200 | [diff] [blame] | 9 | /* Terminology / wording |
| 10 | tag length value (in bits) |
| 11 | |
| 12 | V - - 8 |
| 13 | LV - 8 N * 8 |
| 14 | TLV 8 8 N * 8 |
| 15 | TL16V 8 16 N * 8 |
| 16 | TLV16 8 8 N * 16 |
| 17 | TvLV 8 8/16 N * 8 |
| 18 | |
| 19 | */ |
| 20 | |
Harald Welte | a4d49e9 | 2009-05-23 06:39:58 +0000 | [diff] [blame] | 21 | #define LV_GROSS_LEN(x) (x+1) |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 22 | #define TLV_GROSS_LEN(x) (x+2) |
| 23 | #define TLV16_GROSS_LEN(x) ((2*x)+2) |
Harald Welte | 702d870 | 2008-12-26 20:25:35 +0000 | [diff] [blame] | 24 | #define TL16V_GROSS_LEN(x) (x+3) |
Holger Hans Peter Freyther | 701d175 | 2010-02-09 16:26:49 +0100 | [diff] [blame] | 25 | #define L16TV_GROSS_LEN(x) (x+3) |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 26 | |
Harald Welte | 73310c3 | 2009-10-24 10:04:02 +0200 | [diff] [blame] | 27 | #define TVLV_MAX_ONEBYTE 0x7f |
| 28 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 29 | static inline uint16_t TVLV_GROSS_LEN(uint16_t len) |
Harald Welte | 73310c3 | 2009-10-24 10:04:02 +0200 | [diff] [blame] | 30 | { |
| 31 | if (len <= TVLV_MAX_ONEBYTE) |
| 32 | return TLV_GROSS_LEN(len); |
| 33 | else |
| 34 | return TL16V_GROSS_LEN(len); |
| 35 | } |
| 36 | |
Harald Welte | 91b5b0d | 2009-02-06 12:51:39 +0000 | [diff] [blame] | 37 | /* TLV generation */ |
| 38 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 39 | static inline uint8_t *lv_put(uint8_t *buf, uint8_t len, |
| 40 | const uint8_t *val) |
Harald Welte | a4d49e9 | 2009-05-23 06:39:58 +0000 | [diff] [blame] | 41 | { |
| 42 | *buf++ = len; |
| 43 | memcpy(buf, val, len); |
| 44 | return buf + len; |
| 45 | } |
| 46 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 47 | static inline uint8_t *tlv_put(uint8_t *buf, uint8_t tag, uint8_t len, |
| 48 | const uint8_t *val) |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 49 | { |
| 50 | *buf++ = tag; |
| 51 | *buf++ = len; |
| 52 | memcpy(buf, val, len); |
| 53 | return buf + len; |
| 54 | } |
| 55 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 56 | static inline uint8_t *tlv16_put(uint8_t *buf, uint8_t tag, uint8_t len, |
| 57 | const uint16_t *val) |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 58 | { |
| 59 | *buf++ = tag; |
| 60 | *buf++ = len; |
| 61 | memcpy(buf, val, len*2); |
| 62 | return buf + len*2; |
| 63 | } |
| 64 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 65 | static inline uint8_t *tl16v_put(uint8_t *buf, uint8_t tag, uint16_t len, |
| 66 | const uint8_t *val) |
Harald Welte | 702d870 | 2008-12-26 20:25:35 +0000 | [diff] [blame] | 67 | { |
| 68 | *buf++ = tag; |
| 69 | *buf++ = len >> 8; |
| 70 | *buf++ = len & 0xff; |
| 71 | memcpy(buf, val, len); |
| 72 | return buf + len*2; |
| 73 | } |
| 74 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 75 | static inline uint8_t *tvlv_put(uint8_t *buf, uint8_t tag, uint16_t len, |
| 76 | const uint8_t *val) |
Harald Welte | 73310c3 | 2009-10-24 10:04:02 +0200 | [diff] [blame] | 77 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 78 | uint8_t *ret; |
Harald Welte | 73310c3 | 2009-10-24 10:04:02 +0200 | [diff] [blame] | 79 | |
| 80 | if (len <= TVLV_MAX_ONEBYTE) { |
| 81 | ret = tlv_put(buf, tag, len, val); |
| 82 | buf[1] |= 0x80; |
| 83 | } else |
| 84 | ret = tl16v_put(buf, tag, len, val); |
| 85 | |
| 86 | return ret; |
| 87 | } |
| 88 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 89 | static inline uint8_t *msgb_tlv16_put(struct msgb *msg, uint8_t tag, uint8_t len, const uint16_t *val) |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 90 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 91 | uint8_t *buf = msgb_put(msg, TLV16_GROSS_LEN(len)); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 92 | return tlv16_put(buf, tag, len, val); |
| 93 | } |
| 94 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 95 | static inline uint8_t *msgb_tl16v_put(struct msgb *msg, uint8_t tag, uint16_t len, |
| 96 | const uint8_t *val) |
Harald Welte | 702d870 | 2008-12-26 20:25:35 +0000 | [diff] [blame] | 97 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 98 | uint8_t *buf = msgb_put(msg, TL16V_GROSS_LEN(len)); |
Harald Welte | 702d870 | 2008-12-26 20:25:35 +0000 | [diff] [blame] | 99 | return tl16v_put(buf, tag, len, val); |
| 100 | } |
| 101 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 102 | static inline uint8_t *msgb_tvlv_put(struct msgb *msg, uint8_t tag, uint16_t len, |
| 103 | const uint8_t *val) |
Harald Welte | 73310c3 | 2009-10-24 10:04:02 +0200 | [diff] [blame] | 104 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 105 | uint8_t *buf = msgb_put(msg, TVLV_GROSS_LEN(len)); |
Harald Welte | 73310c3 | 2009-10-24 10:04:02 +0200 | [diff] [blame] | 106 | return tvlv_put(buf, tag, len, val); |
| 107 | } |
| 108 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 109 | static inline uint8_t *msgb_l16tv_put(struct msgb *msg, uint16_t len, uint8_t tag, |
| 110 | const uint8_t *val) |
Holger Hans Peter Freyther | 701d175 | 2010-02-09 16:26:49 +0100 | [diff] [blame] | 111 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 112 | uint8_t *buf = msgb_put(msg, L16TV_GROSS_LEN(len)); |
Holger Hans Peter Freyther | 701d175 | 2010-02-09 16:26:49 +0100 | [diff] [blame] | 113 | |
| 114 | *buf++ = len >> 8; |
| 115 | *buf++ = len & 0xff; |
| 116 | *buf++ = tag; |
| 117 | memcpy(buf, val, len); |
| 118 | return buf + len; |
| 119 | } |
| 120 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 121 | static inline uint8_t *v_put(uint8_t *buf, uint8_t val) |
Harald Welte | a4d49e9 | 2009-05-23 06:39:58 +0000 | [diff] [blame] | 122 | { |
| 123 | *buf++ = val; |
| 124 | return buf; |
| 125 | } |
| 126 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 127 | static inline uint8_t *tv_put(uint8_t *buf, uint8_t tag, |
| 128 | uint8_t val) |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 129 | { |
| 130 | *buf++ = tag; |
| 131 | *buf++ = val; |
| 132 | return buf; |
| 133 | } |
| 134 | |
Harald Welte | 5e3d91b | 2009-12-19 16:42:06 +0100 | [diff] [blame] | 135 | /* 'val' is still in host byte order! */ |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 136 | static inline uint8_t *tv16_put(uint8_t *buf, uint8_t tag, |
| 137 | uint16_t val) |
Harald Welte | 4b63454 | 2008-12-27 01:55:51 +0000 | [diff] [blame] | 138 | { |
| 139 | *buf++ = tag; |
| 140 | *buf++ = val >> 8; |
| 141 | *buf++ = val & 0xff; |
| 142 | return buf; |
| 143 | } |
| 144 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 145 | static inline uint8_t *msgb_lv_put(struct msgb *msg, uint8_t len, const uint8_t *val) |
Harald Welte | a4d49e9 | 2009-05-23 06:39:58 +0000 | [diff] [blame] | 146 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 147 | uint8_t *buf = msgb_put(msg, LV_GROSS_LEN(len)); |
Harald Welte | a4d49e9 | 2009-05-23 06:39:58 +0000 | [diff] [blame] | 148 | return lv_put(buf, len, val); |
| 149 | } |
| 150 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 151 | static inline uint8_t *msgb_tlv_put(struct msgb *msg, uint8_t tag, uint8_t len, const uint8_t *val) |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 152 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 153 | uint8_t *buf = msgb_put(msg, TLV_GROSS_LEN(len)); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 154 | return tlv_put(buf, tag, len, val); |
| 155 | } |
| 156 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 157 | static inline uint8_t *msgb_tv_put(struct msgb *msg, uint8_t tag, uint8_t val) |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 158 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 159 | uint8_t *buf = msgb_put(msg, 2); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 160 | return tv_put(buf, tag, val); |
| 161 | } |
| 162 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 163 | static inline uint8_t *msgb_v_put(struct msgb *msg, uint8_t val) |
Harald Welte | a4d49e9 | 2009-05-23 06:39:58 +0000 | [diff] [blame] | 164 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 165 | uint8_t *buf = msgb_put(msg, 1); |
Harald Welte | a4d49e9 | 2009-05-23 06:39:58 +0000 | [diff] [blame] | 166 | return v_put(buf, val); |
| 167 | } |
| 168 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 169 | static inline uint8_t *msgb_tv16_put(struct msgb *msg, uint8_t tag, uint16_t val) |
Harald Welte | 4b63454 | 2008-12-27 01:55:51 +0000 | [diff] [blame] | 170 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 171 | uint8_t *buf = msgb_put(msg, 3); |
Harald Welte | 4b63454 | 2008-12-27 01:55:51 +0000 | [diff] [blame] | 172 | return tv16_put(buf, tag, val); |
| 173 | } |
| 174 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 175 | static inline uint8_t *msgb_tlv_push(struct msgb *msg, uint8_t tag, uint8_t len, const uint8_t *val) |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 176 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 177 | uint8_t *buf = msgb_push(msg, TLV_GROSS_LEN(len)); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 178 | return tlv_put(buf, tag, len, val); |
| 179 | } |
| 180 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 181 | static inline uint8_t *msgb_tv_push(struct msgb *msg, uint8_t tag, uint8_t val) |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 182 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 183 | uint8_t *buf = msgb_push(msg, 2); |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 184 | return tv_put(buf, tag, val); |
| 185 | } |
| 186 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 187 | static inline uint8_t *msgb_tv16_push(struct msgb *msg, uint8_t tag, uint16_t val) |
Harald Welte | 4b63454 | 2008-12-27 01:55:51 +0000 | [diff] [blame] | 188 | { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 189 | uint8_t *buf = msgb_push(msg, 3); |
Harald Welte | 4b63454 | 2008-12-27 01:55:51 +0000 | [diff] [blame] | 190 | return tv16_put(buf, tag, val); |
| 191 | } |
| 192 | |
Harald Welte | 91b5b0d | 2009-02-06 12:51:39 +0000 | [diff] [blame] | 193 | /* TLV parsing */ |
| 194 | |
| 195 | struct tlv_p_entry { |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 196 | uint16_t len; |
| 197 | const uint8_t *val; |
Harald Welte | 91b5b0d | 2009-02-06 12:51:39 +0000 | [diff] [blame] | 198 | }; |
| 199 | |
Harald Welte | e0590df | 2009-02-15 03:34:15 +0000 | [diff] [blame] | 200 | enum tlv_type { |
Harald Welte | 5078148 | 2010-01-10 17:45:23 +0100 | [diff] [blame] | 201 | TLV_TYPE_NONE, |
Harald Welte | e0590df | 2009-02-15 03:34:15 +0000 | [diff] [blame] | 202 | TLV_TYPE_FIXED, |
| 203 | TLV_TYPE_T, |
| 204 | TLV_TYPE_TV, |
| 205 | TLV_TYPE_TLV, |
| 206 | TLV_TYPE_TL16V, |
Harald Welte | 73310c3 | 2009-10-24 10:04:02 +0200 | [diff] [blame] | 207 | TLV_TYPE_TvLV, |
Harald Welte | e0590df | 2009-02-15 03:34:15 +0000 | [diff] [blame] | 208 | }; |
| 209 | |
| 210 | struct tlv_def { |
| 211 | enum tlv_type type; |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 212 | uint8_t fixed_len; |
Harald Welte | e0590df | 2009-02-15 03:34:15 +0000 | [diff] [blame] | 213 | }; |
| 214 | |
| 215 | struct tlv_definition { |
| 216 | struct tlv_def def[0xff]; |
| 217 | }; |
| 218 | |
Harald Welte | 2fa7934 | 2009-02-14 19:07:10 +0000 | [diff] [blame] | 219 | struct tlv_parsed { |
Harald Welte | 91b5b0d | 2009-02-06 12:51:39 +0000 | [diff] [blame] | 220 | struct tlv_p_entry lv[0xff]; |
| 221 | }; |
| 222 | |
Harald Welte | 73310c3 | 2009-10-24 10:04:02 +0200 | [diff] [blame] | 223 | extern struct tlv_definition tvlv_att_def; |
| 224 | |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 225 | int tlv_parse_one(uint8_t *o_tag, uint16_t *o_len, const uint8_t **o_val, |
Sylvain Munaut | eb429b7 | 2009-10-26 20:19:59 +0100 | [diff] [blame] | 226 | const struct tlv_definition *def, |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 227 | const uint8_t *buf, int buf_len); |
Harald Welte | 7bc4cbc | 2009-02-21 12:59:22 +0000 | [diff] [blame] | 228 | int tlv_parse(struct tlv_parsed *dec, const struct tlv_definition *def, |
Harald Welte | a3d5514 | 2010-02-20 19:10:44 +0100 | [diff] [blame] | 229 | const uint8_t *buf, int buf_len, uint8_t lv_tag, uint8_t lv_tag2); |
Harald Welte | 5078148 | 2010-01-10 17:45:23 +0100 | [diff] [blame] | 230 | /* take a master (src) tlvdev and fill up all empty slots in 'dst' */ |
| 231 | void tlv_def_patch(struct tlv_definition *dst, const struct tlv_definition *src); |
Harald Welte | 2fa7934 | 2009-02-14 19:07:10 +0000 | [diff] [blame] | 232 | |
| 233 | #define TLVP_PRESENT(x, y) ((x)->lv[y].val) |
| 234 | #define TLVP_LEN(x, y) (x)->lv[y].len |
| 235 | #define TLVP_VAL(x, y) (x)->lv[y].val |
Harald Welte | 4b63454 | 2008-12-27 01:55:51 +0000 | [diff] [blame] | 236 | |
Harald Welte | 52b1f98 | 2008-12-23 20:25:15 +0000 | [diff] [blame] | 237 | #endif /* _TLV_H */ |