svn path=/trunk/; revision=36087

1 files changed, 299 insertions, 0 deletions

diff --git a/epan/dissectors/packet-csn1.h b/epan/dissectors/packet-csn1.h
new file mode 100644
index 0000000000..72a3220121
--- /dev/null
+++ b/epan/dissectors/packet-csn1.h
@@ -0,0 +1,299 @@
+/* packet-csn1.h
+ * Declarations and types for CSN1 dissection in wireshark.
+ * By Vincent Helfre
+ * Copyright (c) 2011 ST-Ericsson
+ *
+ * $Id$
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ */
+
+#ifndef _PACKET_CSN1_H_
+#define _PACKET_CSN1_H_
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <stdio.h>
+#include <string.h>
+#include <glib.h>
+#include <epan/packet.h>
+#include "stddef.h"
+
+/* Error codes */
+#define  CSN_OK                               0
+#define  CSN_ERROR_GENERAL                   -1
+#define  CSN_ERROR_DATA_NOT_VALID            -2
+#define  CSN_ERROR_IN_SCRIPT                 -3
+#define  CSN_ERROR_INVALID_UNION_INDEX       -4
+#define  CSN_ERROR_NEED_MORE_BITS_TO_UNPACK  -5
+#define  CSN_ERROR_ILLEGAL_BIT_VALUE         -6
+#define  CSN_ERROR_INTERNAL                  -7
+#define  CSN_ERROR_STREAM_NOT_SUPPORTED      -8
+#define  CSN_ERROR_MESSAGE_TOO_LONG          -9
+#define  CSN_ERROR_                         -10
+
+/* CallBack return status */
+typedef gint16 CSN_CallBackStatus_t;
+
+#define  CSNCBS_OK                      0
+#define  CSNCBS_NOT_OK                -10
+#define  CSNCBS_NOT_TO_US             -11
+#define  CSNCBS_NOT_COMPLETE          -12
+
+#define CSNCBS_REVISION_LIMIT_STOP   -20 /* Stop packing/unpacking - revision limit */
+#define CSNCBS_NOT_SUPPORTED_IE      -21 /* Handling of the unpacked IE is not supported by MS-software */
+
+
+
+#ifndef ElementsOf
+#define ElementsOf(array) (sizeof(array) / sizeof(array[0]))
+#endif
+
+/* Context holding CSN1 parameters */
+typedef struct
+{
+  gint  remaining_bits_len;  /* IN to an csn stream operation */
+  gint  bit_offset;          /* IN/OUT to an csn stream operation */
+} csnStream_t;
+
+typedef gint16 (*StreamSerializeFcn_t)(proto_tree *tree, csnStream_t* ar, tvbuff_t *tvb, void* data, int ett_csn1);
+
+typedef struct
+{
+  gint16      type;
+  gint16      i;
+  void*       descr;
+  size_t      offset;
+  const char* sz;
+  StreamSerializeFcn_t serialize;
+} CSN_DESCR;
+
+typedef struct
+{
+  guint8     bits;
+  guint8     value;
+  CSN_DESCR descr;
+} CSN_ChoiceElement_t;
+
+void csnStreamInit(csnStream_t* ar,gint BitOffset,gint BitCount);
+
+/******************************************************************************
+* FUNCTION:  csnStreamDissector
+* DESCRIPTION: 
+*            UnPacks data from bit stream. According to CSN description.
+* ARGS:
+*   ar        stream will hold the parameters to the pack function
+*            ar->remaining_bits_len    [IN] Number of bits to unpack [OUT] number of bits left to unpack.
+*            ar->bit_offset            [IN/OUT] is the current bit where to proceed with the next bit to unpack.
+
+*   pDescr    CSN description.
+*   tvb       buffer containing the bit stream to unpack.
+*   data      unpacked data.
+*   ett_csn1  tree
+*
+* RETURNS:  int  Number of bits left to be unpacked. Negative Error code if failed to unpack all bits
+******************************************************************************/
+gint16 csnStreamDissector(proto_tree *tree, csnStream_t* ar, const CSN_DESCR* pDescr, tvbuff_t *tvb, void* data, int ett_csn1);
+
+enum
+{
+  CSN_END = 0, 
+  CSN_BIT,
+  CSN_UINT,
+  CSN_TYPE,
+  CSN_CHOICE,
+  CSN_UNION,
+  CSN_UNION_LH,
+  CSN_UINT_ARRAY,
+  CSN_TYPE_ARRAY,
+  CSN_BITMAP,                /* Bitmap with constant: <bitmap: bit(64)> */
+  CSN_VARIABLE_BITMAP,       /* <N: bit (5)> <bitmap: bit(N + offset)> */
+  CSN_VARIABLE_BITMAP_1,     /* <bitmap: bit**> i.e. to the end of message (R99) */
+  CSN_LEFT_ALIGNED_VAR_BMP,  /* As variable bitmap but the result is left aligned (R99) */
+  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_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 ; */
+  CSN_RECURSIVE_TARRAY_2,    /* same as above but with reversed separators :<lists> ::= <type> { 0 <type> } ** 1 ; */
+  CSN_EXIST,
+  CSN_EXIST_LH,
+  CSN_NEXT_EXIST,
+  CSN_NEXT_EXIST_LH,
+  CSN_NULL,
+  CSN_FIXED,
+  CSN_CALLBACK,
+  CSN_UINT_OFFSET,        /* unpack will add offset, inverse pack will subtract offset */
+  CSN_UINT_LH,            /* Low High extraction of int */
+  CSN_SERIALIZE,
+  CSN_TRAP_ERROR
+};
+
+/* CSN struct macro's */
+#define  CSN_DESCR_BEGIN(_STRUCT)\
+        CSN_DESCR CSNDESCR_##_STRUCT[] = {
+
+#define  CSN_DESCR_END(_STRUCT)\
+        {CSN_END, 0} };
+
+#define  CSN_ERROR(_STRUCT, _Text, _ERRCODE)\
+        {CSN_TRAP_ERROR, _ERRCODE, _Text, 0, _Text}
+
+#define M_BIT(_STRUCT, _MEMBER)\
+        {CSN_BIT, 0, 0, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+#define M_NEXT_EXIST(_STRUCT, _MEMBER, _NoOfExisting)\
+        {CSN_NEXT_EXIST, _NoOfExisting, 0, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+#define M_NEXT_EXIST_LH(_STRUCT, _MEMBER, _NoOfExisting)\
+        {CSN_NEXT_EXIST_LH, _NoOfExisting, 0, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+/* Covers the case of { null | 0 | 1 < IE > }. 
+ * Same as M_NEXT_EXIST with exception of (void*)1 instead of 0.
+ */
+#define M_NEXT_EXIST_OR_NULL(_STRUCT, _MEMBER, _NoOfExisting)\
+        {CSN_NEXT_EXIST, _NoOfExisting, (void*)1, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+/* Covers the case of { null | L | H < IE > }
+ * Same as M_NEXT_EXIST_LH with exception of (void*)1 instead of 0.
+ */
+#define M_NEXT_EXIST_OR_NULL_LH(_STRUCT, _MEMBER, _NoOfExisting)\
+        {CSN_NEXT_EXIST_LH, _NoOfExisting, (void*)1, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+#define M_UINT(_STRUCT, _MEMBER, _BITS)\
+        {CSN_UINT, _BITS, (void*)1, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+#define M_UINT_LH(_STRUCT, _MEMBER, _BITS)\
+        {CSN_UINT_LH, _BITS, (void*)1, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+#define M_UINT_OFFSET(_STRUCT, _MEMBER, _BITS, _OFFSET)\
+        {CSN_UINT_OFFSET, _BITS, (void*)_OFFSET, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+/* 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
+ */
+#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
+ */
+#define M_VAR_UINT_ARRAY(_STRUCT, _MEMBER, _BITS, _ElementCountField)\
+        {CSN_UINT_ARRAY, _BITS, (void*)offsetof(_STRUCT, _ElementCountField), offsetof(_STRUCT, _MEMBER), #_MEMBER, (StreamSerializeFcn_t)1}
+
+#define M_VAR_ARRAY(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\
+        {CSN_VARIABLE_ARRAY, _OFFSET, (void*)offsetof(_STRUCT, _ElementCountField), offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+#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)}
+
+#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)}
+
+#define M_REC_ARRAY(_STRUCT, _MEMBER, _ElementCountField, _BITS)\
+        {CSN_RECURSIVE_ARRAY, _BITS, (void*)offsetof(_STRUCT, _ElementCountField), offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+#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)}
+
+#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)}
+
+#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)}
+
+#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)}
+
+#define M_TYPE(_STRUCT, _MEMBER, _MEMBER_TYPE)\
+        {CSN_TYPE, 0, (void*)CSNDESCR_##_MEMBER_TYPE, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+#define M_UNION(_STRUCT, _COUNT)\
+        {CSN_UNION, _COUNT, 0, offsetof(_STRUCT, UnionType), "UnionType"}
+
+#define M_UNION_LH(_STRUCT, _COUNT)\
+        {CSN_UNION_LH, _COUNT, 0, offsetof(_STRUCT, UnionType), "UnionType"}
+
+#define M_CHOICE(_STRUCT, _MEMBER, _CHOICE, _ElementCount)\
+        {CSN_CHOICE, _ElementCount, (void*)_CHOICE, offsetof(_STRUCT, _MEMBER), #_CHOICE}
+
+#define M_FIXED(_STRUCT, _BITS, _BITVALUE)\
+        {CSN_FIXED, _BITS, 0, _BITVALUE, #_BITVALUE}
+
+#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}
+#define M_CALLBACK_NO_ARGS(_STRUCT, _CSNCALLBACKFCN)\
+        {CSN_CALLBACK, 0, _CSNCALLBACKFCN, 0, "CallBack_"#_CSNCALLBACKFCN}
+
+#define M_CALLBACK_THIS(_STRUCT, _SERIALIZEFCN)\
+        {CSN_SERIALIZE, 1, 0, 0, #_SERIALIZEFCN, _SERIALIZEFCN}
+
+#define M_BITMAP(_STRUCT, _MEMBER, _BITS)\
+        {CSN_BITMAP, _BITS, 0, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+/* variable length, right aligned bitmap i.e. _ElementCountField = 11 => 00000111 11111111 */
+#define M_VAR_BITMAP(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\
+        {CSN_VARIABLE_BITMAP, _OFFSET, (void*)offsetof(_STRUCT, _ElementCountField), offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+/* variable length, right aligned bitmap filling the rest of message
+ * - when unpacking the _ElementCountField will be set in runtime
+ * - when packing _ElementCountField contains the size of bitmap
+ */
+#define M_VAR_BITMAP_1(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\
+        {CSN_VARIABLE_BITMAP_1, _OFFSET, (void*)offsetof(_STRUCT, _ElementCountField), offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+/* variable length, left aligned bitmap i.e. _ElementCountField = 11 => 11111111 11100000 */
+#define M_LEFT_VAR_BMP(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\
+        {CSN_LEFT_ALIGNED_VAR_BMP, _OFFSET, (void*)offsetof(_STRUCT, _ElementCountField), offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+/* variable length, left aligned bitmap filling the rest of message
+ *- when unpacking the _ElementCountField will be set in runtime
+ * - when packing _ElementCountField contains the size of bitmap
+ */
+#define M_LEFT_VAR_BMP_1(_STRUCT, _MEMBER, _ElementCountField, _OFFSET)\
+        {CSN_LEFT_ALIGNED_VAR_BMP_1, _OFFSET, (void*)offsetof(_STRUCT, _ElementCountField), offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+#define M_NULL(_STRUCT, _MEMBER)\
+        {CSN_NULL, 0, 0, offsetof(_STRUCT, _MEMBER), #_MEMBER}
+
+#define M_THIS_EXIST(_STRUCT)\
+        {CSN_EXIST, 0, 0, offsetof(_STRUCT, Exist), "Exist"}
+
+#define M_THIS_EXIST_LH(_STRUCT)\
+        {CSN_EXIST_LH, 0, 0, offsetof(_STRUCT, Exist), "Exist"}
+
+/* return value 0 if ok else discontionue the unpacking */
+typedef gint16 (*CsnCallBackFcn_t)(void* pv ,...);
+
+#define CSNDESCR(_FuncType) CSNDESCR_##_FuncType
+
+#endif /*_PACKET_CSN1_H_*/