Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 1 | /* csn1.h |
| 2 | * Declarations and types for CSN1 dissection in wireshark. |
| 3 | * By Vincent Helfre, based on original code by Jari Sassi |
| 4 | * with the gracious authorization of STE |
| 5 | * Copyright (c) 2011 ST-Ericsson |
| 6 | * |
| 7 | * $Id: packet-csn1.h 36306 2011-03-24 09:20:14Z etxrab $ |
| 8 | * |
| 9 | * Wireshark - Network traffic analyzer |
| 10 | * By Gerald Combs <gerald@wireshark.org> |
| 11 | * Copyright 1998 Gerald Combs |
| 12 | * |
| 13 | * This program is free software; you can redistribute it and/or |
| 14 | * modify it under the terms of the GNU General Public License |
| 15 | * as published by the Free Software Foundation; either version 2 |
| 16 | * of the License, or (at your option) any later version. |
| 17 | * |
| 18 | * This program is distributed in the hope that it will be useful, |
| 19 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 20 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 21 | * GNU General Public License for more details. |
| 22 | * |
| 23 | * You should have received a copy of the GNU General Public License |
| 24 | * along with this program; if not, write to the Free Software |
| 25 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 26 | */ |
| 27 | |
Max | 910a387 | 2018-01-30 13:29:38 +0100 | [diff] [blame] | 28 | #ifndef _PACKET_CSN1_H_ |
| 29 | #define _PACKET_CSN1_H_ |
| 30 | |
Alexander Couzens | ccde5c9 | 2017-02-04 03:10:08 +0100 | [diff] [blame] | 31 | #include <osmocom/core/bitvec.h> |
Pau Espin Pedrol | b2653fe | 2020-03-26 15:14:01 +0100 | [diff] [blame] | 32 | #include "wireshark_compat.h" |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 33 | |
| 34 | /* Error codes */ |
| 35 | #define CSN_OK 0 |
| 36 | #define CSN_ERROR_GENERAL -1 |
| 37 | #define CSN_ERROR_DATA_NOT_VALID -2 |
| 38 | #define CSN_ERROR_IN_SCRIPT -3 |
| 39 | #define CSN_ERROR_INVALID_UNION_INDEX -4 |
| 40 | #define CSN_ERROR_NEED_MORE_BITS_TO_UNPACK -5 |
| 41 | #define CSN_ERROR_ILLEGAL_BIT_VALUE -6 |
| 42 | #define CSN_ERROR_INTERNAL -7 |
| 43 | #define CSN_ERROR_STREAM_NOT_SUPPORTED -8 |
| 44 | #define CSN_ERROR_MESSAGE_TOO_LONG -9 |
| 45 | #define CSN_ERROR_ -10 |
| 46 | |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 47 | /* CallBack return status */ |
| 48 | typedef gint16 CSN_CallBackStatus_t; |
| 49 | |
| 50 | #define CSNCBS_OK 0 |
| 51 | #define CSNCBS_NOT_OK -10 |
| 52 | #define CSNCBS_NOT_TO_US -11 |
| 53 | #define CSNCBS_NOT_COMPLETE -12 |
| 54 | |
| 55 | #define CSNCBS_REVISION_LIMIT_STOP -20 /* Stop packing/unpacking - revision limit */ |
| 56 | #define CSNCBS_NOT_SUPPORTED_IE -21 /* Handling of the unpacked IE is not supported by MS-software */ |
| 57 | |
| 58 | |
| 59 | |
| 60 | #ifndef ElementsOf |
| 61 | #define ElementsOf(array) (sizeof(array) / sizeof(array[0])) |
| 62 | #endif |
Pau Espin Pedrol | 5b71697 | 2020-01-24 17:24:01 +0100 | [diff] [blame] | 63 | typedef void(*void_fn_t)(void); |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 64 | |
| 65 | /* Context holding CSN1 parameters */ |
| 66 | typedef struct |
| 67 | { |
| 68 | gint remaining_bits_len; /* IN to an csn stream operation */ |
| 69 | gint bit_offset; /* IN/OUT to an csn stream operation */ |
| 70 | gint direction; /* 0 - decode; 1 - encode */ |
| 71 | } csnStream_t; |
| 72 | |
Vadim Yanitskiy | 39a6505 | 2020-01-25 01:24:59 +0700 | [diff] [blame] | 73 | typedef gint16 (*StreamSerializeFcn_t)(csnStream_t* ar, struct bitvec *vector, unsigned *readIndex, void* data); |
Pau Espin Pedrol | f3ac06b | 2020-03-26 18:13:19 +0100 | [diff] [blame] | 74 | typedef CSN_CallBackStatus_t (*DissectorCallbackFcn_t)(struct bitvec *vector, unsigned *readIndex, void* param1, void* param2); |
| 75 | |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 76 | typedef enum |
| 77 | { |
| 78 | CSN_END = 0, |
| 79 | CSN_BIT, |
| 80 | CSN_UINT, |
| 81 | CSN_TYPE, |
| 82 | CSN_CHOICE, |
| 83 | CSN_UNION, |
| 84 | CSN_UNION_LH, |
| 85 | CSN_UINT_ARRAY, |
| 86 | CSN_TYPE_ARRAY, |
| 87 | CSN_BITMAP, /* Bitmap with constant: <bitmap: bit(64)> */ |
| 88 | CSN_VARIABLE_BITMAP, /* <N: bit (5)> <bitmap: bit(N + offset)> */ |
| 89 | CSN_VARIABLE_BITMAP_1, /* <bitmap: bit**> i.e. to the end of message (R99) */ |
| 90 | CSN_LEFT_ALIGNED_VAR_BMP, /* As variable bitmap but the result is left aligned (R99) */ |
| 91 | CSN_LEFT_ALIGNED_VAR_BMP_1,/* As above only size is to the end of message (R99) */ |
Ivan Kluchnikov | 701d9f8 | 2012-10-10 19:43:37 +0400 | [diff] [blame] | 92 | CSN_PADDING_BITS, /* Padding bits fill to the end of the buffer */ |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 93 | CSN_VARIABLE_ARRAY, /* Array with length specified in parameter: <N: bit(4)> <list: octet(N + offset)> */ |
| 94 | CSN_VARIABLE_TARRAY, /* Type Array with length specified in parameter: <N: bit(x)> <Type>*N */ |
| 95 | CSN_VARIABLE_TARRAY_OFFSET,/* As above but with offset. The offset is stored as third parameter of CSN_DESCR (descr.value) */ |
| 96 | CSN_RECURSIVE_ARRAY, /* Recursive way to specify an array of uint: <list> ::= {1 <number: bit(4) <list>|0}; */ |
| 97 | CSN_RECURSIVE_TARRAY, /* Recursive way to specify an array of type: <list> ::= {1 <type>} ** 0 ; */ |
| 98 | CSN_RECURSIVE_TARRAY_1, /* same as above but first element always exist:<list> ::= <type> {1 <type>} ** 0 ; */ |
| 99 | CSN_RECURSIVE_TARRAY_2, /* same as above but with reversed separators :<lists> ::= <type> { 0 <type> } ** 1 ; */ |
| 100 | CSN_EXIST, |
| 101 | CSN_EXIST_LH, |
| 102 | CSN_NEXT_EXIST, |
| 103 | CSN_NEXT_EXIST_LH, |
| 104 | CSN_NULL, |
| 105 | CSN_FIXED, |
| 106 | CSN_CALLBACK, |
| 107 | CSN_UINT_OFFSET, /* unpack will add offset, inverse pack will subtract offset */ |
| 108 | CSN_UINT_LH, /* Low High extraction of int */ |
| 109 | CSN_SERIALIZE, |
| 110 | CSN_TRAP_ERROR |
| 111 | } csn_type_t; |
| 112 | |
| 113 | /****************************************************************************************** |
| 114 | * CSN_DESCR structure: |
| 115 | * |
| 116 | * type: |
| 117 | * This is the CSN type. All existing types are specified in the section above. |
| 118 | * |
| 119 | * i: |
| 120 | * Depending on the contents of the type parameter, the parameter "i" may have following meaning: |
Ivan Kluchnikov | 701d9f8 | 2012-10-10 19:43:37 +0400 | [diff] [blame] | 121 | * - specifies the number of bits for the CSN_UINT or CSN_UINT_OR_NULL types |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 122 | * - the offset for an array size by which the size is incremented |
| 123 | * for the CSN_VAR_ARRAY type |
| 124 | * - the length of each element of an array for the CSN_REC_ARRAY type |
| 125 | * - the number of the elements in an array for the CSN_TYPE_ARRAY type |
| 126 | * - the offset to the variable keeping the number of elements of an array for in the CSN_VAR_TARRAY type |
| 127 | * - the number of different data types in a union for the CSN_UNION, CSN_UNION_LH, and for the CSN_CHOICE types |
| 128 | * - the length in bits of the fixed number defined for the CSN_FIXED type |
| 129 | * - the number of lines to skip in the CSN_DESCR type specified for the CSN_NEXT_EXIST, CSN_NEXT_EXIST_LH, |
| 130 | * CSN_NEXT_EXIST_OR_NULL, and CSN_NEXT_EXIST_OR_NULL_LH types |
| 131 | * - the number of bits in a bitmap for the CSN_BITMAP type |
| 132 | * - the value by which the number of bits in a bitmap has to be incremented or decremented for the |
| 133 | * CSN_VAR_BITMAP, CSN_LEFT_VAR_BMP, and CSN_LEFT_BMP_1 types |
| 134 | * - the offset to param1 for the CSN_CALLBACK type |
| 135 | * - ERRORCODE used by the CSN_ERROR type |
Ivan Kluchnikov | 701d9f8 | 2012-10-10 19:43:37 +0400 | [diff] [blame] | 136 | * - the bit-length of the LENGTH field in a CSN_SERIALISE type |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 137 | * |
| 138 | * descr |
| 139 | * This parameter has different meaning depending on the value of the type parameter: |
| 140 | * - the offset for the CSN_UINT_OFFSET type |
| 141 | * - the number of the elements in an array of the CSN_UINT_ARRAY type |
| 142 | * - the offset to the parameter where the size of the array has to be stored for the CSN_REC_ARRAY type |
| 143 | * - the address of the internal structure, describing the member type (by means of the CSN_DESCR type) in the |
| 144 | * CSN_TYPE_ARRAY, CSN_VAR_TARRAY, and CSN_TYPE types |
| 145 | * - the address of the variable of type CSN_ChoiceElement_t describing all elements in the CSN_CHOICE type union |
| 146 | * - the offset to the variable where the number of bits has to be or is stored for the CSN_VAR_BITMAP, |
| 147 | * CSN_LEFT_VAR_BMP, and CSN_LEFT_BMP_1 types |
| 148 | * - the function number (case number) for the CSN_CALLBACK and CSN_CALLBACK_NO_ARGS types |
| 149 | * - the free text used by the CSN_TRAP_ERROR |
| 150 | * |
| 151 | * offset |
| 152 | * This is an offset to the _MEMBER parameter counting from the beginning of struct |
| 153 | * where the unpacked or packed value shall be stored or fetched. The meaning of the _MEMBER parameter |
| 154 | * varies depending on the type which is specified and so is the meaning of the offset parameter. |
| 155 | * Some types (and corresponding macros) do not have the _MEMBER parameter and then the offset parameter |
| 156 | * is not used or is different from the offset to the _MEMBER. |
| 157 | * - the fixed value for the CSN_FIXED type |
| 158 | * - an offset to the variable UnionType for CSN_UNION and CSN_UNION_LH types |
| 159 | * - an offset to the variable Exist for CSN_NEXT_EXIST and CSN_NEXT_EXIST_LH types |
| 160 | * - an offset to param2 in the CSN_CALLBACK type |
| 161 | * |
Ivan Kluchnikov | 701d9f8 | 2012-10-10 19:43:37 +0400 | [diff] [blame] | 162 | * may_be_null |
| 163 | * TRUE: if dissection may be attempted at an offset beyond the length of existing data bits |
| 164 | * FALSE: othewise |
| 165 | * |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 166 | * sz |
| 167 | * - is the name of the parameter within the descr where their unpacked or packed value shall be stored or fetched. |
| 168 | * This paramater is pointed out by the offset parameter in the same CSN_DESCR variable as the sz. |
| 169 | * - the free text used by the CSN_TRAP_ERROR (the same as parameter "i") |
| 170 | * |
| 171 | * serialize |
| 172 | * - stores the size of _MEMBER type in case of the M_TYPE_ARRAY and M_VAR_TARRAY, |
| 173 | * - the address of the function which is provided by the M_SERIALIZE type. |
| 174 | ******************************************************************************************/ |
| 175 | |
| 176 | |
| 177 | typedef struct |
| 178 | { |
| 179 | gint16 type; |
| 180 | gint16 i; |
| 181 | union |
| 182 | { |
Pau Espin Pedrol | 5b71697 | 2020-01-24 17:24:01 +0100 | [diff] [blame] | 183 | const void* ptr; |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 184 | guint32 value; |
| 185 | } descr; |
Ivan Kluchnikov | 9b06ff0 | 2012-06-15 10:13:30 +0400 | [diff] [blame] | 186 | unsigned offset; |
Ivan Kluchnikov | 701d9f8 | 2012-10-10 19:43:37 +0400 | [diff] [blame] | 187 | gboolean may_be_null; |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 188 | const char* sz; |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 189 | guint32 value; |
Pau Espin Pedrol | 5b71697 | 2020-01-24 17:24:01 +0100 | [diff] [blame] | 190 | void_fn_t aux_fn; |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 191 | } CSN_DESCR; |
| 192 | |
| 193 | typedef struct |
| 194 | { |
| 195 | guint8 bits; |
| 196 | guint8 value; |
Pau Espin Pedrol | 7cce825 | 2020-01-24 16:41:14 +0100 | [diff] [blame] | 197 | gboolean keep_bits; |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 198 | CSN_DESCR descr; |
| 199 | } CSN_ChoiceElement_t; |
| 200 | |
| 201 | void csnStreamInit(csnStream_t* ar,gint BitOffset,gint BitCount); |
| 202 | |
| 203 | /****************************************************************************** |
| 204 | * FUNCTION: csnStreamDecoder |
| 205 | * DESCRIPTION: |
| 206 | * UnPacks data from bit stream. According to CSN description. |
| 207 | * ARGS: |
| 208 | * ar stream will hold the parameters to the pack function |
| 209 | * ar->remaining_bits_len [IN] Number of bits to unpack [OUT] number of bits left to unpack. |
| 210 | * ar->bit_offset [IN/OUT] is the current bit where to proceed with the next bit to unpack. |
| 211 | |
| 212 | * pDescr CSN description. |
| 213 | * tvb buffer containing the bit stream to unpack. |
| 214 | * data unpacked data. |
| 215 | * ett_csn1 tree |
| 216 | * |
| 217 | * RETURNS: int Number of bits left to be unpacked. Negative Error code if failed to unpack all bits |
| 218 | ******************************************************************************/ |
| 219 | |
Vadim Yanitskiy | 39a6505 | 2020-01-25 01:24:59 +0700 | [diff] [blame] | 220 | gint16 csnStreamDecoder(csnStream_t* ar, const CSN_DESCR* pDescr, struct bitvec *vector, unsigned *readIndex, void* data); |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 221 | |
Vadim Yanitskiy | 39a6505 | 2020-01-25 01:24:59 +0700 | [diff] [blame] | 222 | gint16 csnStreamEncoder(csnStream_t* ar, const CSN_DESCR* pDescr, struct bitvec *vector, unsigned *writeIndex, void* data); |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 223 | |
| 224 | /* CSN struct macro's */ |
| 225 | #define CSN_DESCR_BEGIN(_STRUCT)\ |
| 226 | CSN_DESCR CSNDESCR_##_STRUCT[] = { |
| 227 | |
| 228 | #define CSN_DESCR_END(_STRUCT)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 229 | {CSN_END, 0, {0}, 0, FALSE, "", 0, NULL} }; |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 230 | |
| 231 | /****************************************************************************** |
| 232 | * CSN_ERROR(Par1, Par2, Par3) |
| 233 | * May be called at any time when an abort of packing or unpacking of a message |
| 234 | * is desired |
| 235 | * Par1: C structure name |
| 236 | * Par2: free text which will appear in the error handler |
| 237 | * Par3: Error code |
| 238 | *****************************************************************************/ |
| 239 | #define CSN_ERROR(_STRUCT, _Text, _ERRCODE)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 240 | {CSN_TRAP_ERROR, _ERRCODE, {_Text}, 0, FALSE, _Text, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 241 | |
| 242 | /****************************************************************************** |
| 243 | * M_BIT(Par1, Par2) |
| 244 | * Defines one bit element in the CSN1 syntax. |
| 245 | * Par1: C structure name |
| 246 | * Par2: C structure element name |
| 247 | *****************************************************************************/ |
| 248 | #define M_BIT(_STRUCT, _MEMBER)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 249 | {CSN_BIT, 0, {0}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 701d9f8 | 2012-10-10 19:43:37 +0400 | [diff] [blame] | 250 | |
| 251 | /****************************************************************************** |
| 252 | * M_BIT_OR_NULL(Par1, Par2) |
| 253 | * Similar to the M_BIT except that not only bit 0 or 1 but also the |
| 254 | * end of the message may be encountered when looking for the next element in |
| 255 | * the message. |
| 256 | * Covers the case {null | 0 | 1} |
| 257 | *****************************************************************************/ |
| 258 | #define M_BIT_OR_NULL(_STRUCT, _MEMBER)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 259 | {CSN_BIT, 0, {0}, offsetof(_STRUCT, _MEMBER), TRUE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 260 | |
| 261 | /****************************************************************************** |
| 262 | * M_NEXT_EXIST(Par1, Par2, Par3) |
Pau Espin Pedrol | 5b71697 | 2020-01-24 17:24:01 +0100 | [diff] [blame] | 263 | * Indicates whether the next element or a group of elements defined in the |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 264 | * structure is present or not. |
| 265 | * Par1: C structure name |
| 266 | * Par2: C structure element name |
| 267 | * Par3: number of lines to skip in the CSN_DESCR type specified if the |
| 268 | * element(s) does not exist |
| 269 | *****************************************************************************/ |
| 270 | #define M_NEXT_EXIST(_STRUCT, _MEMBER, _NoOfExisting)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 271 | {CSN_NEXT_EXIST, _NoOfExisting, {0}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 272 | |
| 273 | /****************************************************************************** |
| 274 | * M_NEXT_EXIST_LH(Par1, Par2, Par3) |
| 275 | * similar to the M_NEXT_EXIST except that instead of bit 0/1 which is fetched |
| 276 | * from the message in order to find out whether the next element/elements are |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 277 | * present in the message, the logical operation XOR with the background |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 278 | * pattern 0x2B is performed on the read bit before the decision is made. |
| 279 | *****************************************************************************/ |
| 280 | #define M_NEXT_EXIST_LH(_STRUCT, _MEMBER, _NoOfExisting)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 281 | {CSN_NEXT_EXIST_LH, _NoOfExisting, {0}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 282 | |
| 283 | /****************************************************************************** |
| 284 | * M_NEXT_EXIST_OR_NULL(Par1, Par2, Par3) |
| 285 | * Similar to the M_NEXT_EXIST except that not only bit 0 or 1 but also the end |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 286 | * of the message may be encountered when looking for the next element in the |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 287 | * message. |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 288 | * Covers the case {null | 0 | 1 < IE >} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 289 | *****************************************************************************/ |
| 290 | #define M_NEXT_EXIST_OR_NULL(_STRUCT, _MEMBER, _NoOfExisting)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 291 | {CSN_NEXT_EXIST, _NoOfExisting, {0}, offsetof(_STRUCT, _MEMBER), TRUE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 292 | |
| 293 | /****************************************************************************** |
| 294 | * M_NEXT_EXIST_OR_NULL_LH(Par1, Par2, Par3) |
| 295 | * Similar to the M_NEXT_EXIST_LH except that not only bit 0 or 1 but also the |
| 296 | * end of the message may be encountered when looking for the next element in |
| 297 | * the message. |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 298 | * Covers the case {null | L | H < IE >} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 299 | *****************************************************************************/ |
| 300 | #define M_NEXT_EXIST_OR_NULL_LH(_STRUCT, _MEMBER, _NoOfExisting)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 301 | {CSN_NEXT_EXIST_LH, _NoOfExisting, {(void*)1}, offsetof(_STRUCT, _MEMBER), TRUE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 302 | |
| 303 | /****************************************************************************** |
| 304 | * M_UINT(Par1, Par2, Par3) |
| 305 | * Defines an integer number. |
| 306 | * Par1: C structure name |
| 307 | * Par2: C structure element name |
| 308 | * Par3: number of bits used to code the element (between 1 and 32) |
| 309 | *****************************************************************************/ |
| 310 | #define M_UINT(_STRUCT, _MEMBER, _BITS)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 311 | {CSN_UINT, _BITS, {0}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 701d9f8 | 2012-10-10 19:43:37 +0400 | [diff] [blame] | 312 | |
| 313 | /****************************************************************************** |
| 314 | * M_UINT_OR_NULL(Par1, Par2, Par3) |
| 315 | * Similar to the M_UINT except that not only the request set of bits but also the |
| 316 | * end of the message may be encountered when looking for the next element in |
| 317 | * the message. |
| 318 | * Covers the case {null | 0 | 1 < IE >} |
| 319 | *****************************************************************************/ |
| 320 | #define M_UINT_OR_NULL(_STRUCT, _MEMBER, _BITS)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 321 | {CSN_UINT, _BITS, {0}, offsetof(_STRUCT, _MEMBER), TRUE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 322 | |
| 323 | /****************************************************************************** |
| 324 | * M_UINT(Par1, Par2, Par3) |
| 325 | * This macro has the same functionality as M_UINT except that in addition the |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 326 | * logical "exclusive or" operation with the background value "0x2B" is |
| 327 | * performed before the final value of the integer number is delivered from the |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 328 | * received CSN.1 message |
| 329 | *****************************************************************************/ |
| 330 | #define M_UINT_LH(_STRUCT, _MEMBER, _BITS)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 331 | {CSN_UINT_LH, _BITS, {0}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 332 | |
| 333 | /****************************************************************************** |
| 334 | * M_UINT_OFFSET(Par1, Par2, Par3, Par4) |
| 335 | * Defines an integer number. |
| 336 | * Par1: C structure name |
| 337 | * Par2: C structure element name |
| 338 | * Par3: number of bits used to code the element (between 1 and 32) |
| 339 | * Par4: value added to the returned integer (offset) |
| 340 | *****************************************************************************/ |
| 341 | #define M_UINT_OFFSET(_STRUCT, _MEMBER, _BITS, _OFFSET)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 342 | {CSN_UINT_OFFSET, _BITS, {(void*)_OFFSET}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 343 | |
| 344 | /****************************************************************************** |
| 345 | * M_UINT_ARRAY(Par1, Par2, Par3, Par4) |
| 346 | * Defines an array of integer numbers. The size of the array is fixed. |
| 347 | * Par1: C structure name |
| 348 | * Par2: C structure element name |
| 349 | * Par3: number of bits used to code the each integer element (between 1 and 32) |
| 350 | * Par4: number of elements in the array (fixed integer value) |
| 351 | *****************************************************************************/ |
| 352 | #define M_UINT_ARRAY(_STRUCT, _MEMBER, _BITS, _ElementCount)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 353 | {CSN_UINT_ARRAY, _BITS, {(void*)_ElementCount}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 354 | |
| 355 | /****************************************************************************** |
| 356 | * M_VAR_UINT_ARRAY(Par1, Par2, Par3, Par4) |
| 357 | * Defines an array of integer numbers. The size of the array is variable. |
| 358 | * Par1: C structure name |
| 359 | * Par2: C structure element name |
| 360 | * Par3: number of bits used to code the each integer element (between 1 and 32) |
| 361 | * Par4: number of elements in the array supplied by reference to the |
| 362 | * structure member holding the length value |
| 363 | *****************************************************************************/ |
| 364 | #define M_VAR_UINT_ARRAY(_STRUCT, _MEMBER, _BITS, _ElementCountField)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 365 | {CSN_UINT_ARRAY, _BITS, {(void*)offsetof(_STRUCT, _ElementCountField)}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 1, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 366 | |
| 367 | /****************************************************************************** |
| 368 | * M_VAR_ARRAY(Par1, Par2, Par3, Par4) |
| 369 | * Defines an array of 8 bit large integer numbers. The size of the array is variable. |
| 370 | * Par1: C structure name |
| 371 | * Par2: C structure element name |
| 372 | * Par3: name of the structure member holding the size of the array |
| 373 | * Par4: offset that is added to the Par3 to get the actual size of the array |
| 374 | *****************************************************************************/ |
| 375 | #define M_VAR_ARRAY(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 376 | {CSN_VARIABLE_ARRAY, _OFFSET, {(void*)offsetof(_STRUCT, _ElementCountField)}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 377 | |
| 378 | /****************************************************************************** |
| 379 | * M_VAR_TARRAY(Par1, Par2, Par3, Par4) |
| 380 | * Similar to M_TYPE_ARRAY except that the size of the array is variable. |
| 381 | * Par1: C structure name |
| 382 | * Par2: C structure element name |
| 383 | * Par3: the type of each element of the array |
| 384 | * Par4: name of the structure member holding the size of the array |
| 385 | *****************************************************************************/ |
| 386 | #define M_VAR_TARRAY(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCountField)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 387 | {CSN_VARIABLE_TARRAY, offsetof(_STRUCT, _ElementCountField), {(const void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, sizeof(_MEMBER_TYPE), NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 388 | |
| 389 | /****************************************************************************** |
| 390 | * M_VAR_TARRAY_OFFSET(Par1, Par2, Par3, Par4) |
| 391 | * Same as M_VAR_TARRAY with offset |
| 392 | *****************************************************************************/ |
| 393 | #define M_VAR_TARRAY_OFFSET(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCountField)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 394 | {CSN_VARIABLE_TARRAY_OFFSET, offsetof(_STRUCT, _ElementCountField), {(const void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, sizeof(_MEMBER_TYPE), NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 395 | |
| 396 | /****************************************************************************** |
| 397 | * M_REC_ARRAY(Par1, Par2, Par3, Par4) |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 398 | * similar to the M_VAR_ARRAY. The difference is that the size of the array is |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 399 | * not known in advance and it has to be calculated during unpacking. Its value |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 400 | * is stored in a variable which belongs to the same structure as the array. |
| 401 | * A zero element terminates the array. The CSN.1 syntax describes it |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 402 | * recursively as: |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 403 | * <array> ::={1 <element> <array>| 0} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 404 | * |
| 405 | * Par1: C structure name |
| 406 | * Par2: C structure element name |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 407 | * Par3: name of the structure member where the calculated the size of the |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 408 | * array will be stored |
| 409 | * Par4: length of each element in bits |
| 410 | *****************************************************************************/ |
| 411 | #define M_REC_ARRAY(_STRUCT, _MEMBER, _ElementCountField, _BITS)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 412 | {CSN_RECURSIVE_ARRAY, _BITS, {(const void*)offsetof(_STRUCT, _ElementCountField)}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 413 | |
| 414 | /****************************************************************************** |
| 415 | * M_VAR_TYPE_ARRAY(Par1, Par2, Par3, Par4) |
| 416 | * Defines an array of structures. The size of the array is variable. |
| 417 | * Par1: C structure name |
| 418 | * Par2: C structure element name |
| 419 | * Par3: name of the structure |
| 420 | * Par4: number of elements in the array (fixed integer value) |
| 421 | *****************************************************************************/ |
| 422 | #define M_TYPE_ARRAY(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCount)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 423 | {CSN_TYPE_ARRAY, _ElementCount, {(const void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, sizeof(_MEMBER_TYPE), NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 424 | |
| 425 | /****************************************************************************** |
| 426 | * M_REC_TARRAY(Par1, Par2, Par3, Par4) |
| 427 | * Defines an recursive array of structures. The size of the array is variable. |
| 428 | * <list> ::= {1 <type>} ** 0 ; |
| 429 | * Par1: C structure name |
| 430 | * Par2: C structure element name |
| 431 | * Par3: name of the structure |
| 432 | * Par4: will hold the number of element in the array after unpacking |
| 433 | *****************************************************************************/ |
| 434 | #define M_REC_TARRAY(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCountField)\ |
Pau Espin Pedrol | efad80b | 2020-03-23 14:35:26 +0100 | [diff] [blame] | 435 | {CSN_RECURSIVE_TARRAY, offsetof(_STRUCT, _ElementCountField), {(const void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, sizeof(_MEMBER_TYPE), (void_fn_t)ElementsOf(((_STRUCT*)0)->_MEMBER)} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 436 | |
| 437 | /****************************************************************************** |
| 438 | * M_REC_TARRAY1(Par1, Par2, Par3, Par4) |
| 439 | * Same as M_REC_TARRAY but first element always exist: |
| 440 | * <list> ::= <type> {1 <type>} ** 0 ; |
| 441 | *****************************************************************************/ |
| 442 | #define M_REC_TARRAY_1(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCountField)\ |
Pau Espin Pedrol | efad80b | 2020-03-23 14:35:26 +0100 | [diff] [blame] | 443 | {CSN_RECURSIVE_TARRAY_1, offsetof(_STRUCT, _ElementCountField), {(const void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, sizeof(_MEMBER_TYPE), (void_fn_t)ElementsOf(((_STRUCT*)0)->_MEMBER)} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 444 | |
| 445 | /****************************************************************************** |
| 446 | * M_REC_TARRAY2(Par1, Par2, Par3, Par4) |
| 447 | * Same as M_REC_TARRAY but with reversed separators : |
| 448 | * <lists> ::= <type> { 0 <type> } ** 1 ; |
| 449 | *****************************************************************************/ |
| 450 | #define M_REC_TARRAY_2(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCountField)\ |
Pau Espin Pedrol | efad80b | 2020-03-23 14:35:26 +0100 | [diff] [blame] | 451 | {CSN_RECURSIVE_TARRAY_2, offsetof(_STRUCT, _ElementCountField), {(const void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, sizeof(_MEMBER_TYPE), (void_fn_t)ElementsOf(((_STRUCT*)0)->_MEMBER)} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 452 | |
| 453 | /****************************************************************************** |
| 454 | * M_TYPE(Par1, Par2, Par3) |
| 455 | * Defines a reference to a structure which is described elsewhere |
| 456 | * <list> ::= {1 <type>} ** 0 ; |
| 457 | * Par1: C structure name |
| 458 | * Par2: C structure element name |
| 459 | * Par3: type of member |
| 460 | *****************************************************************************/ |
| 461 | #define M_TYPE(_STRUCT, _MEMBER, _MEMBER_TYPE)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 462 | {CSN_TYPE, 0, {(const void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 463 | |
| 464 | /****************************************************************************** |
| 465 | * M_UNION(Par1, Par2) |
| 466 | * Informs the CSN.1 library that a union follows and how many possible choices |
| 467 | * there are in the union. The actual value of the choice, which points out the |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 468 | * chosen element of the union is stored in the uint8 variable and is usually |
| 469 | * called UnionType. The elements of the union have to be listed directly after |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 470 | * the M_UNION statement. |
| 471 | * Par1: C structure name |
| 472 | * Par2: number of possible choice in the union |
| 473 | *****************************************************************************/ |
| 474 | #define M_UNION(_STRUCT, _COUNT)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 475 | {CSN_UNION, _COUNT, {0}, offsetof(_STRUCT, UnionType), FALSE, "UnionType", 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 476 | |
| 477 | /****************************************************************************** |
| 478 | * M_UNION_LH(Par1, Par2) |
| 479 | * Same as M_UNION but masked with background value 0x2B |
| 480 | *****************************************************************************/ |
| 481 | #define M_UNION_LH(_STRUCT, _COUNT)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 482 | {CSN_UNION_LH, _COUNT, {0}, offsetof(_STRUCT, UnionType), FALSE, "UnionType", 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 483 | |
| 484 | /****************************************************************************** |
| 485 | * M_CHOICE(Par1, Par2, Par3, Par4) |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 486 | * Similar to the M_UNION. In the M_UNION the selected element of all possible |
| 487 | * choices in the union is referred as a sequential numbers, i.e., the first |
| 488 | * choice is addressed as choice 0 the second as choice 1, the third as choice |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 489 | * 2 and so on, both in the encoded message and in the variable UnionType which |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 490 | * is the part of the message. In the CSN_CHOICE case, this rule does not |
| 491 | * apply. There is free but predefined mapping of the element of the union and |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 492 | * the value which addresses this element. |
Vadim Yanitskiy | c991566 | 2020-05-23 17:24:37 +0700 | [diff] [blame] | 493 | * The value of the address is called a selector. Up to 256 (UCHAR_MAX) unique |
| 494 | * selectors can be handled, longer choice list would cause CSN_ERROR_IN_SCRIPT. |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 495 | * After unpacking, this value is then converted to the sequential number of the |
Vadim Yanitskiy | 93ad3fd | 2020-05-23 18:17:19 +0700 | [diff] [blame] | 496 | * element in the union and stored in the UnionType variable (Par2). |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 497 | * Par1: C structure name |
Vadim Yanitskiy | 93ad3fd | 2020-05-23 18:17:19 +0700 | [diff] [blame] | 498 | * Par2: C structure field name holding sequential number of the chosen element. |
| 499 | * BEWARE! Never use an enumerated type here, because its length is |
| 500 | * compiler/machine dependent, while decoder would cast it to guint8. |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 501 | * Par3: address of an array of type CSN_ChoiceElement_t where all possible |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 502 | * values of the selector are provided, together with the selector |
| 503 | * length expressed in bits and the address of the CSN_DESCR type |
| 504 | * where the element is defined. For every element in the union |
| 505 | * there is one line in the Choice variable. These lines have to |
| 506 | * appear in the _CHOICE in the same order as the elements in the |
| 507 | * union. The element of the union selected in the message through |
| 508 | * the _CHOICE parameter is after unpacking translated to the |
| 509 | * corresponding sequential number of this element and stored in |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 510 | * the variable pointed out by the _MEMBER |
| 511 | * Par4: number of possible choices in the union |
| 512 | *****************************************************************************/ |
| 513 | #define M_CHOICE(_STRUCT, _MEMBER, _CHOICE, _ElementCount)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 514 | {CSN_CHOICE, _ElementCount, {(const void*)_CHOICE}, offsetof(_STRUCT, _MEMBER), FALSE, #_CHOICE, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 515 | |
| 516 | /****************************************************************************** |
| 517 | * M_FIXED(Par1, Par2, Par3) |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 518 | * Defines a fixed value of type integer which should be fetched from or stored |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 519 | * in the message |
| 520 | * Par1: C structure name |
| 521 | * Par2: gives the length of the fixed number in bits. |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 522 | * Par3: the value of the number. If the expected value is not present in |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 523 | * the message the unpacking procedure is aborted |
| 524 | *****************************************************************************/ |
| 525 | #define M_FIXED(_STRUCT, _BITS, _BITVALUE)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 526 | {CSN_FIXED, _BITS, {0}, _BITVALUE, FALSE, #_BITVALUE, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 527 | |
| 528 | /****************************************************************************** |
| 529 | * M_SERIALIZE(Par1, Par2, Par3) |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 530 | * Allows using a complete free format of data being encoded or decoded. |
Ivan Kluchnikov | 701d9f8 | 2012-10-10 19:43:37 +0400 | [diff] [blame] | 531 | * When the M_SERIALIZE is encounted during encoding or decoding of a message |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 532 | * the CSNstream program passes the control over to the specified function |
| 533 | * together with all necessary parameters about the current position within |
| 534 | * the message being unpacked or packed. When transferring of "serialized" |
| 535 | * data to or from the message is finished by the function the CSNstream gets |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 536 | * back control over the data stream and continues to work with the message. |
| 537 | *****************************************************************************/ |
Ivan Kluchnikov | 701d9f8 | 2012-10-10 19:43:37 +0400 | [diff] [blame] | 538 | #define M_SERIALIZE(_STRUCT, _MEMBER, _LENGTH_LEN, _SERIALIZEFCN)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 539 | {CSN_SERIALIZE, _LENGTH_LEN, {0}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, (void_fn_t)_SERIALIZEFCN} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 540 | |
| 541 | #define M_CALLBACK(_STRUCT, _CSNCALLBACKFCN, _PARAM1, _PARAM2)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 542 | {CSN_CALLBACK, offsetof(_STRUCT, _PARAM1), {0}, offsetof(_STRUCT, _PARAM2), FALSE, "CallBack_"#_CSNCALLBACKFCN, 0, (void_fn_t)_CSNCALLBACKFCN} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 543 | |
| 544 | /****************************************************************************** |
| 545 | * M_BITMAP(Par1, Par2, Par3) |
Pau Espin Pedrol | e5e2f74 | 2020-03-26 15:14:17 +0100 | [diff] [blame] | 546 | * Defines a type which consists of a bitmap. The size of the bitmap in bits |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 547 | * is fixed and provided by the parameter Par3 |
| 548 | * Par1: C structure name |
| 549 | * Par2: C structure element name |
| 550 | * Par3: length of the bitmap expressed in bits |
| 551 | *****************************************************************************/ |
| 552 | #define M_BITMAP(_STRUCT, _MEMBER, _BITS)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 553 | {CSN_BITMAP, _BITS, {0}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 554 | |
| 555 | /* variable length, right aligned bitmap i.e. _ElementCountField = 11 => 00000111 11111111 */ |
| 556 | #define M_VAR_BITMAP(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 557 | {CSN_VARIABLE_BITMAP, _OFFSET, {(void*)offsetof(_STRUCT, _ElementCountField)}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 558 | |
| 559 | /* variable length, right aligned bitmap filling the rest of message |
| 560 | * - when unpacking the _ElementCountField will be set in runtime |
| 561 | * - when packing _ElementCountField contains the size of bitmap |
| 562 | */ |
| 563 | #define M_VAR_BITMAP_1(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 564 | {CSN_VARIABLE_BITMAP_1, _OFFSET, {(void*)offsetof(_STRUCT, _ElementCountField)}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 565 | |
| 566 | /* variable length, left aligned bitmap i.e. _ElementCountField = 11 => 11111111 11100000 */ |
| 567 | #define M_LEFT_VAR_BMP(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 568 | {CSN_LEFT_ALIGNED_VAR_BMP, _OFFSET, {(void*)offsetof(_STRUCT, _ElementCountField)}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 569 | |
| 570 | /* variable length, left aligned bitmap filling the rest of message |
| 571 | *- when unpacking the _ElementCountField will be set in runtime |
| 572 | * - when packing _ElementCountField contains the size of bitmap |
| 573 | */ |
| 574 | #define M_LEFT_VAR_BMP_1(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 575 | {CSN_LEFT_ALIGNED_VAR_BMP_1, _OFFSET, {(void*)offsetof(_STRUCT, _ElementCountField)}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 701d9f8 | 2012-10-10 19:43:37 +0400 | [diff] [blame] | 576 | |
| 577 | /* todo: dissect padding bits looking for unexpected extensions */ |
| 578 | #define M_PADDING_BITS(_STRUCT)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 579 | {CSN_PADDING_BITS, 0, {0}, 0, TRUE, "Padding", 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 580 | |
Anders Broman | 72c102a | 2020-01-24 14:31:15 +0100 | [diff] [blame] | 581 | #define M_NULL(_STRUCT, _MEMBER, _SKIP_BITS)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 582 | {CSN_NULL, _SKIP_BITS, {0}, offsetof(_STRUCT, _MEMBER), FALSE, #_MEMBER, 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 583 | |
| 584 | #define M_THIS_EXIST(_STRUCT)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 585 | {CSN_EXIST, 0, {0}, offsetof(_STRUCT, Exist), FALSE, "Exist", 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 586 | |
| 587 | #define M_THIS_EXIST_LH(_STRUCT)\ |
Pau Espin Pedrol | 900c2e2 | 2020-01-24 18:05:00 +0100 | [diff] [blame] | 588 | {CSN_EXIST_LH, 0, {0}, offsetof(_STRUCT, Exist), FALSE, "Exist", 0, NULL} |
Ivan Kluchnikov | 487a141 | 2011-12-21 13:17:53 +0300 | [diff] [blame] | 589 | |
| 590 | /* return value 0 if ok else discontionue the unpacking */ |
| 591 | typedef gint16 (*CsnCallBackFcn_t)(void* pv ,...); |
| 592 | |
| 593 | #define CSNDESCR(_FuncType) CSNDESCR_##_FuncType |
| 594 | |
| 595 | #endif /*_PACKET_CSN1_H_*/ |