diff options
author | Anders Broman <anders.broman@ericsson.com> | 2011-03-23 09:14:50 +0000 |
---|---|---|
committer | Anders Broman <anders.broman@ericsson.com> | 2011-03-23 09:14:50 +0000 |
commit | fd782e736c10534cbb4b7ffd00beeb8c8dbd4c96 (patch) | |
tree | ac7f316d1ca4ff33636637a536e1aa12a59e05ce /epan/dissectors/packet-csn1.h | |
parent | cb56e8455673ee820c7562cd327a827ee6673d15 (diff) |
From Vincent Helfre:
- added documentation in packet-csn1.h
- fixed a bug in packet-csn1.c
- fixed a BSIC description in packet-gsm_a_rr.c
- removed the "_v" suffix in packet-gsm_rlcmac element description
svn path=/trunk/; revision=36284
Diffstat (limited to 'epan/dissectors/packet-csn1.h')
-rw-r--r-- | epan/dissectors/packet-csn1.h | 266 |
1 files changed, 232 insertions, 34 deletions
diff --git a/epan/dissectors/packet-csn1.h b/epan/dissectors/packet-csn1.h index 9a5ba13417..49bfa5aca1 100644 --- a/epan/dissectors/packet-csn1.h +++ b/epan/dissectors/packet-csn1.h @@ -1,6 +1,7 @@ /* packet-csn1.h * Declarations and types for CSN1 dissection in wireshark. - * By Vincent Helfre + * By Vincent Helfre, based on original code by Jari Sassi + * with the gracious authorization of STE * Copyright (c) 2011 ST-Ericsson * * $Id$ @@ -66,7 +67,7 @@ typedef struct typedef gint16 (*StreamSerializeFcn_t)(proto_tree *tree, csnStream_t* ar, tvbuff_t *tvb, void* data, int ett_csn1); -enum +typedef enum { CSN_END = 0, CSN_BIT, @@ -84,7 +85,7 @@ enum CSN_LEFT_ALIGNED_VAR_BMP_1,/* As above only size is to the end of message (R99) */ CSN_VARIABLE_ARRAY, /* Array with length specified in parameter: <N: bit(4)> <list: octet(N + offset)> */ CSN_VARIABLE_TARRAY, /* Type Array with length specified in parameter: <N: bit(x)> <Type>*N */ - CSN_VARIABLE_TARRAY_OFFSET,/* As above but with offset 1. Unpack: <N: bit(x)> <Type>*N - 1 Pack: <N: bit(x)> <Type>*N + 1 */ + CSN_VARIABLE_TARRAY_OFFSET,/* As above but with offset. The offset is stored as third parameter of CSN_DESCR (descr.value) */ CSN_RECURSIVE_ARRAY, /* Recursive way to specify an array of uint: <list> ::= {1 <number: bit(4) <list>|0}; */ CSN_RECURSIVE_TARRAY, /* Recursive way to specify an array of type: <list> ::= {1 <type>} ** 0 ; */ CSN_RECURSIVE_TARRAY_1, /* same as above but first element always exist:<list> ::= <type> {1 <type>} ** 0 ; */ @@ -100,7 +101,7 @@ enum CSN_UINT_LH, /* Low High extraction of int */ CSN_SERIALIZE, CSN_TRAP_ERROR -}; +} csn_type_t; /****************************************************************************************** * CSN_DESCR structure: @@ -118,7 +119,7 @@ enum * - the offset to the variable keeping the number of elements of an array for in the CSN_VAR_TARRAY type * - the number of different data types in a union for the CSN_UNION, CSN_UNION_LH, and for the CSN_CHOICE types * - the length in bits of the fixed number defined for the CSN_FIXED type - * - the number of lines to skip in the CSN_DESCR type specified for the CSN_NEXT_EXIST, CSN_NEXT_EXIST_LH, + * - the number of lines to skip in the CSN_DESCR type specified for the CSN_NEXT_EXIST, CSN_NEXT_EXIST_LH, * CSN_NEXT_EXIST_OR_NULL, and CSN_NEXT_EXIST_OR_NULL_LH types * - the number of bits in a bitmap for the CSN_BITMAP type * - the value by which the number of bits in a bitmap has to be incremented or decremented for the @@ -140,14 +141,14 @@ enum * - the free text used by the CSN_TRAP_ERROR * * offset - * This is an offset to the _MEMBER parameter counting from the beginning of struct + * This is an offset to the _MEMBER parameter counting from the beginning of struct * where the unpacked or packed value shall be stored or fetched. The meaning of the _MEMBER parameter * varies depending on the type which is specified and so is the meaning of the offset parameter. * Some types (and corresponding macros) do not have the _MEMBER parameter and then the offset parameter * is not used or is different from the offset to the _MEMBER. - * - the fixed value for the CSN_FIXED type - * - an offset to the variable UnionType for CSN_UNION and CSN_UNION_LH types - * - an offset to the variable Exist for CSN_NEXT_EXIST and CSN_NEXT_EXIST_LH types + * - the fixed value for the CSN_FIXED type + * - an offset to the variable UnionType for CSN_UNION and CSN_UNION_LH types + * - an offset to the variable Exist for CSN_NEXT_EXIST and CSN_NEXT_EXIST_LH types * - an offset to param2 in the CSN_CALLBACK type * * sz @@ -156,7 +157,7 @@ enum * - the free text used by the CSN_TRAP_ERROR (the same as parameter "i") * * serialize - * - stores the size of _MEMBER type in case of the M_TYPE_ARRAY and M_VAR_TARRAY, + * - stores the size of _MEMBER type in case of the M_TYPE_ARRAY and M_VAR_TARRAY, * - the address of the function which is provided by the M_SERIALIZE type. ******************************************************************************************/ @@ -213,107 +214,304 @@ gint16 csnStreamDissector(proto_tree *tree, csnStream_t* ar, const CSN_DESCR* pD #define CSN_DESCR_END(_STRUCT)\ {CSN_END, 0, {0}, 0, "", {(StreamSerializeFcn_t)0}} }; -#define CSN_ERROR(_STRUCT, _Text, _ERRCODE)\ +/****************************************************************************** + * CSN_ERROR(Par1, Par2, Par3) + * May be called at any time when an abort of packing or unpacking of a message + * is desired + * Par1: C structure name + * Par2: free text which will appear in the error handler + * Par3: Error code + *****************************************************************************/ +#define CSN_ERROR(_STRUCT, _Text, _ERRCODE)\ {CSN_TRAP_ERROR, _ERRCODE, {_Text}, 0, _Text, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_BIT(Par1, Par2) + * Defines one bit element in the CSN1 syntax. + * Par1: C structure name + * Par2: C structure element name + *****************************************************************************/ #define M_BIT(_STRUCT, _MEMBER)\ {CSN_BIT, 0, {0}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_NEXT_EXIST(Par1, Par2, Par3) + * Indicates whether the next element or a group of elements defined in the + * structure is present or not. + * Par1: C structure name + * Par2: C structure element name + * Par3: number of lines to skip in the CSN_DESCR type specified if the + * element(s) does not exist + *****************************************************************************/ #define M_NEXT_EXIST(_STRUCT, _MEMBER, _NoOfExisting)\ {CSN_NEXT_EXIST, _NoOfExisting, {0}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_NEXT_EXIST_LH(Par1, Par2, Par3) + * similar to the M_NEXT_EXIST except that instead of bit 0/1 which is fetched + * from the message in order to find out whether the next element/elements are + * present in the message, the logical operation XOR with the background + * pattern 0x2B is performed on the read bit before the decision is made. + *****************************************************************************/ #define M_NEXT_EXIST_LH(_STRUCT, _MEMBER, _NoOfExisting)\ {CSN_NEXT_EXIST_LH, _NoOfExisting, {0}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} -/* Covers the case of { null | 0 | 1 < IE > }. - * Same as M_NEXT_EXIST with exception of (void*)1 instead of 0. - */ +/****************************************************************************** + * M_NEXT_EXIST_OR_NULL(Par1, Par2, Par3) + * Similar to the M_NEXT_EXIST except that not only bit 0 or 1 but also the end + * of the message may be encountered when looking for the next element in the + * message. + * Covers the case {null | 0 | 1 < IE >} + *****************************************************************************/ #define M_NEXT_EXIST_OR_NULL(_STRUCT, _MEMBER, _NoOfExisting)\ {CSN_NEXT_EXIST, _NoOfExisting, {(void*)1}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} -/* Covers the case of { null | L | H < IE > } - * Same as M_NEXT_EXIST_LH with exception of (void*)1 instead of 0. - */ +/****************************************************************************** + * M_NEXT_EXIST_OR_NULL_LH(Par1, Par2, Par3) + * Similar to the M_NEXT_EXIST_LH except that not only bit 0 or 1 but also the + * end of the message may be encountered when looking for the next element in + * the message. + * Covers the case {null | L | H < IE >} + *****************************************************************************/ #define M_NEXT_EXIST_OR_NULL_LH(_STRUCT, _MEMBER, _NoOfExisting)\ {CSN_NEXT_EXIST_LH, _NoOfExisting, {(void*)1}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_UINT(Par1, Par2, Par3) + * Defines an integer number. + * Par1: C structure name + * Par2: C structure element name + * Par3: number of bits used to code the element (between 1 and 32) + *****************************************************************************/ #define M_UINT(_STRUCT, _MEMBER, _BITS)\ {CSN_UINT, _BITS, {(void*)1}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_UINT(Par1, Par2, Par3) + * This macro has the same functionality as M_UINT except that in addition the + * logical "exclusive or" operation with the background value "0x2B" is + * performed before the final value of the integer number is delivered from the + * received CSN.1 message + *****************************************************************************/ #define M_UINT_LH(_STRUCT, _MEMBER, _BITS)\ {CSN_UINT_LH, _BITS, {(void*)1}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_UINT_OFFSET(Par1, Par2, Par3, Par4) + * Defines an integer number. + * Par1: C structure name + * Par2: C structure element name + * Par3: number of bits used to code the element (between 1 and 32) + * Par4: value added to the returned integer (offset) + *****************************************************************************/ #define M_UINT_OFFSET(_STRUCT, _MEMBER, _BITS, _OFFSET)\ {CSN_UINT_OFFSET, _BITS, {(void*)_OFFSET}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} -/* target is an array of integers where - * _BITS => number of bits in bitstream to decode for each element - * _ElementCount => target array length supplied by value - * _MEMBER => reference to the first element of target array - * - * The last parameter ((0) in structure instantiation marks target array length as a value - */ +/****************************************************************************** + * M_UINT_ARRAY(Par1, Par2, Par3, Par4) + * Defines an array of integer numbers. The size of the array is fixed. + * Par1: C structure name + * Par2: C structure element name + * Par3: number of bits used to code the each integer element (between 1 and 32) + * Par4: number of elements in the array (fixed integer value) + *****************************************************************************/ #define M_UINT_ARRAY(_STRUCT, _MEMBER, _BITS, _ElementCount)\ {CSN_UINT_ARRAY, _BITS, {(void*)_ElementCount}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} -/* same as above but - * _ElementCountField => target array length supplied by reference to structure member holding length value - * - * The last parameter (1) in structure instantiation marks target array length as a reference to value - */ +/****************************************************************************** + * M_VAR_UINT_ARRAY(Par1, Par2, Par3, Par4) + * Defines an array of integer numbers. The size of the array is variable. + * Par1: C structure name + * Par2: C structure element name + * Par3: number of bits used to code the each integer element (between 1 and 32) + * Par4: number of elements in the array supplied by reference to the + * structure member holding the length value + *****************************************************************************/ #define M_VAR_UINT_ARRAY(_STRUCT, _MEMBER, _BITS, _ElementCountField)\ {CSN_UINT_ARRAY, _BITS, {(void*)offsetof(_STRUCT, _ElementCountField)}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)1}} +/****************************************************************************** + * M_VAR_ARRAY(Par1, Par2, Par3, Par4) + * Defines an array of 8 bit large integer numbers. The size of the array is variable. + * Par1: C structure name + * Par2: C structure element name + * Par3: name of the structure member holding the size of the array + * Par4: offset that is added to the Par3 to get the actual size of the array + *****************************************************************************/ #define M_VAR_ARRAY(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\ {CSN_VARIABLE_ARRAY, _OFFSET, {(void*)offsetof(_STRUCT, _ElementCountField)}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_VAR_TARRAY(Par1, Par2, Par3, Par4) + * Similar to M_TYPE_ARRAY except that the size of the array is variable. + * Par1: C structure name + * Par2: C structure element name + * Par3: the type of each element of the array + * Par4: name of the structure member holding the size of the array + *****************************************************************************/ #define M_VAR_TARRAY(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCountField)\ {CSN_VARIABLE_TARRAY, offsetof(_STRUCT, _ElementCountField), {(void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)sizeof(_MEMBER_TYPE)}} +/****************************************************************************** + * M_VAR_TARRAY_OFFSET(Par1, Par2, Par3, Par4) + * Same as M_VAR_TARRAY with offset + *****************************************************************************/ #define M_VAR_TARRAY_OFFSET(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCountField)\ {CSN_VARIABLE_TARRAY_OFFSET, offsetof(_STRUCT, _ElementCountField), {(void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)sizeof(_MEMBER_TYPE)}} +/****************************************************************************** + * M_REC_ARRAY(Par1, Par2, Par3, Par4) + * similar to the M_VAR_ARRAY. The difference is that the size of the array is + * not known in advance and it has to be calculated during unpacking. Its value + * is stored in a variable which belongs to the same structure as the array. + * A zero element terminates the array. The CSN.1 syntax describes it + * recursively as: + * <array> ::={1 <element> <array>| 0} + * + * Par1: C structure name + * Par2: C structure element name + * Par3: name of the structure member where the calculated the size of the + * array will be stored + * Par4: length of each element in bits + *****************************************************************************/ #define M_REC_ARRAY(_STRUCT, _MEMBER, _ElementCountField, _BITS)\ {CSN_RECURSIVE_ARRAY, _BITS, {(void*)offsetof(_STRUCT, _ElementCountField)}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_VAR_TYPE_ARRAY(Par1, Par2, Par3, Par4) + * Defines an array of structures. The size of the array is variable. + * Par1: C structure name + * Par2: C structure element name + * Par3: name of the structure + * Par4: number of elements in the array (fixed integer value) + *****************************************************************************/ #define M_TYPE_ARRAY(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCount)\ {CSN_TYPE_ARRAY, _ElementCount, {(void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)sizeof(_MEMBER_TYPE)}} +/****************************************************************************** + * M_REC_TARRAY(Par1, Par2, Par3, Par4) + * Defines an recursive array of structures. The size of the array is variable. + * <list> ::= {1 <type>} ** 0 ; + * Par1: C structure name + * Par2: C structure element name + * Par3: name of the structure + * Par4: will hold the number of element in the array after unpacking + *****************************************************************************/ #define M_REC_TARRAY(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCountField)\ {CSN_RECURSIVE_TARRAY, offsetof(_STRUCT, _ElementCountField), {(void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)sizeof(_MEMBER_TYPE)}} +/****************************************************************************** + * M_REC_TARRAY1(Par1, Par2, Par3, Par4) + * Same as M_REC_TARRAY but first element always exist: + * <list> ::= <type> {1 <type>} ** 0 ; + *****************************************************************************/ #define M_REC_TARRAY_1(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCountField)\ {CSN_RECURSIVE_TARRAY_1, offsetof(_STRUCT, _ElementCountField), {(void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)sizeof(_MEMBER_TYPE)}} +/****************************************************************************** + * M_REC_TARRAY2(Par1, Par2, Par3, Par4) + * Same as M_REC_TARRAY but with reversed separators : + * <lists> ::= <type> { 0 <type> } ** 1 ; + *****************************************************************************/ #define M_REC_TARRAY_2(_STRUCT, _MEMBER, _MEMBER_TYPE, _ElementCountField)\ {CSN_RECURSIVE_TARRAY_2, offsetof(_STRUCT, _ElementCountField), {(void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)sizeof(_MEMBER_TYPE)}} +/****************************************************************************** + * M_TYPE(Par1, Par2, Par3) + * Defines a reference to a structure which is described elsewhere + * <list> ::= {1 <type>} ** 0 ; + * Par1: C structure name + * Par2: C structure element name + * Par3: type of member + *****************************************************************************/ #define M_TYPE(_STRUCT, _MEMBER, _MEMBER_TYPE)\ {CSN_TYPE, 0, {(void*)CSNDESCR_##_MEMBER_TYPE}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_UNION(Par1, Par2) + * Informs the CSN.1 library that a union follows and how many possible choices + * there are in the union. The actual value of the choice, which points out the + * chosen element of the union is stored in the uint8 variable and is usually + * called UnionType. The elements of the union have to be listed directly after + * the M_UNION statement. + * Par1: C structure name + * Par2: number of possible choice in the union + *****************************************************************************/ #define M_UNION(_STRUCT, _COUNT)\ {CSN_UNION, _COUNT, {0}, offsetof(_STRUCT, UnionType), "UnionType", {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_UNION_LH(Par1, Par2) + * Same as M_UNION but masked with background value 0x2B + *****************************************************************************/ #define M_UNION_LH(_STRUCT, _COUNT)\ {CSN_UNION_LH, _COUNT, {0}, offsetof(_STRUCT, UnionType), "UnionType", {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_CHOICE(Par1, Par2, Par3, Par4) + * Similar to the M_UNION. In the M_UNION the selected element of all possible + * choices in the union is referred as a sequential numbers, i.e., the first + * choice is addressed as choice 0 the second as choice 1, the third as choice + * 2 and so on, both in the encoded message and in the variable UnionType which + * is the part of the message. In the CSN_CHOICE case, this rule does not + * apply. There is free but predefined mapping of the element of the union and + * the value which addresses this element. + * The value of the address is called a selector. + * After unpacking, this value is then converted to the sequential number of the + * element in the union and stored in the UnionType variable. + * Par1: C structure name + * Par2: C structure element name + * Par3: address of an array of type CSN_ChoiceElement_t where all possible + * values of the selector are provided, together with the selector + * length expressed in bits and the address of the CSN_DESCR type + * where the element is defined. For every element in the union + * there is one line in the Choice variable. These lines have to + * appear in the _CHOICE in the same order as the elements in the + * union. The element of the union selected in the message through + * the _CHOICE parameter is after unpacking translated to the + * corresponding sequential number of this element and stored in + * the variable pointed out by the _MEMBER + * Par4: number of possible choices in the union + *****************************************************************************/ #define M_CHOICE(_STRUCT, _MEMBER, _CHOICE, _ElementCount)\ {CSN_CHOICE, _ElementCount, {(void*)_CHOICE}, offsetof(_STRUCT, _MEMBER), #_CHOICE, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_FIXED(Par1, Par2, Par3) + * Defines a fixed value of type integer which should be fetched from or stored + * in the message + * Par1: C structure name + * Par2: gives the length of the fixed number in bits. + * Par3: the value of the number. If the expected value is not present in +* the message the unpacking procedure is aborted + *****************************************************************************/ #define M_FIXED(_STRUCT, _BITS, _BITVALUE)\ {CSN_FIXED, _BITS, {0}, _BITVALUE, #_BITVALUE, {(StreamSerializeFcn_t)0}} +/****************************************************************************** + * M_SERIALIZE(Par1, Par2, Par3) + * Allows using a complete free format of data being encoded or decoded. + * When the M_SERIALIZE is uncounted during encoding or decoding of a message + * the CSNstream program passes the control over to the specified function + * together with all necessary parameters about the current position within + * the message being unpacked or packed. When transferring of "serialized" + * data to or from the message is finished by the function the CSNstream gets + * back control over the data stream and continues to work with the message. + *****************************************************************************/ #define M_SERIALIZE(_STRUCT, _MEMBER, _SERIALIZEFCN)\ {CSN_SERIALIZE, 1, {0}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {_SERIALIZEFCN}} #define M_CALLBACK(_STRUCT, _CSNCALLBACKFCN, _PARAM1, _PARAM2)\ {CSN_CALLBACK, offsetof(_STRUCT, _PARAM1), {_CSNCALLBACKFCN}, offsetof(_STRUCT, _PARAM2), "CallBack_"#_CSNCALLBACKFCN, {(StreamSerializeFcn_t)0}} -#define M_CALLBACK_NO_ARGS(_STRUCT, _CSNCALLBACKFCN)\ - {CSN_CALLBACK, 0, {_CSNCALLBACKFCN}, 0, "CallBack_"#_CSNCALLBACKFCN, {(StreamSerializeFcn_t)0}} - -#define M_CALLBACK_THIS(_STRUCT, _SERIALIZEFCN)\ - {CSN_SERIALIZE, 1, {0}, 0, #_SERIALIZEFCN, {_SERIALIZEFCN}} +/****************************************************************************** + * M_BITMAP(Par1, Par2, Par3) + * Defines a type which consists of a bitmap. The size of the bitmap in bits + * is fixed and provided by the parameter Par3 + * Par1: C structure name + * Par2: C structure element name + * Par3: length of the bitmap expressed in bits + *****************************************************************************/ #define M_BITMAP(_STRUCT, _MEMBER, _BITS)\ {CSN_BITMAP, _BITS, {0}, offsetof(_STRUCT, _MEMBER), #_MEMBER, {(StreamSerializeFcn_t)0}} |