Fix various typos and spelling errors.
[obnox/wireshark/wip.git] / epan / dissectors / packet-mtp2.c
1 /* packet-mtp2.c
2  * Routines for MTP2 dissection
3  * It is hopefully (needs testing) compliant to
4  * ITU-T Q.703 and Q.703 Annex A.
5  *
6  * Copyright 2001, 2004 Michael Tuexen <tuexen [AT] fh-muenster.de>
7  *
8  * $Id$
9  *
10  * Wireshark - Network traffic analyzer
11  * By Gerald Combs <gerald@wireshark.org>
12  * Copyright 1998 Gerald Combs
13  *
14  * Copied from packet-m2pa.c
15  *
16  * This program is free software; you can redistribute it and/or
17  * modify it under the terms of the GNU General Public License
18  * as published by the Free Software Foundation; either version 2
19  * of the License, or (at your option) any later version.
20  *
21  * This program is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, write to the Free Software
28  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
29  */
30
31 #ifdef HAVE_CONFIG_H
32 # include "config.h"
33 #endif
34
35 #include <glib.h>
36 #include <epan/packet.h>
37 #include <epan/prefs.h>
38 #include <epan/crc16.h>
39 #include <epan/expert.h>
40
41 /* Initialize the protocol and registered fields */
42 static int proto_mtp2        = -1;
43 static int hf_mtp2_bsn       = -1;
44 static int hf_mtp2_ext_bsn   = -1;
45 static int hf_mtp2_ext_res   = -1;
46 static int hf_mtp2_bib       = -1;
47 static int hf_mtp2_ext_bib   = -1;
48 static int hf_mtp2_fsn       = -1;
49 static int hf_mtp2_ext_fsn   = -1;
50 static int hf_mtp2_fib       = -1;
51 static int hf_mtp2_ext_fib   = -1;
52 static int hf_mtp2_li        = -1;
53 static int hf_mtp2_ext_li    = -1;
54 static int hf_mtp2_spare     = -1;
55 static int hf_mtp2_ext_spare = -1;
56 static int hf_mtp2_sf        = -1;
57 static int hf_mtp2_sf_extra  = -1;
58
59 /* Initialize the subtree pointers */
60 static gint ett_mtp2       = -1;
61
62 static dissector_handle_t mtp3_handle;
63 static gboolean use_extended_sequence_numbers_default = FALSE;
64 static gboolean use_extended_sequence_numbers         = FALSE;
65
66 #define BSN_BIB_LENGTH          1
67 #define FSN_FIB_LENGTH          1
68 #define LI_LENGTH               1
69 #define HEADER_LENGTH           (BSN_BIB_LENGTH + FSN_FIB_LENGTH + LI_LENGTH)
70
71 #define EXTENDED_BSN_BIB_LENGTH 2
72 #define EXTENDED_FSN_FIB_LENGTH 2
73 #define EXTENDED_LI_LENGTH      2
74 #define EXTENDED_HEADER_LENGTH  (EXTENDED_BSN_BIB_LENGTH + EXTENDED_FSN_FIB_LENGTH + EXTENDED_LI_LENGTH)
75
76 #define BSN_BIB_OFFSET          0
77 #define FSN_FIB_OFFSET          (BSN_BIB_OFFSET + BSN_BIB_LENGTH)
78 #define LI_OFFSET               (FSN_FIB_OFFSET + FSN_FIB_LENGTH)
79 #define SIO_OFFSET              (LI_OFFSET + LI_LENGTH)
80
81 #define EXTENDED_BSN_BIB_OFFSET 0
82 #define EXTENDED_FSN_FIB_OFFSET (EXTENDED_BSN_BIB_OFFSET + EXTENDED_BSN_BIB_LENGTH)
83 #define EXTENDED_LI_OFFSET      (EXTENDED_FSN_FIB_OFFSET + EXTENDED_FSN_FIB_LENGTH)
84 #define EXTENDED_SIO_OFFSET     (EXTENDED_LI_OFFSET + EXTENDED_LI_LENGTH)
85
86 #define BSN_MASK                0x7f
87 #define BIB_MASK                0x80
88 #define FSN_MASK                0x7f
89 #define FIB_MASK                0x80
90 #define LI_MASK                 0x3f
91 #define SPARE_MASK              0xc0
92
93 #define EXTENDED_BSN_MASK       0x0fff
94 #define EXTENDED_RES_MASK       0x7000
95 #define EXTENDED_BIB_MASK       0x8000
96 #define EXTENDED_FSN_MASK       0x0fff
97 #define EXTENDED_FIB_MASK       0x8000
98 #define EXTENDED_LI_MASK        0x01ff
99 #define EXTENDED_SPARE_MASK     0xfe00
100
101 static void
102 dissect_mtp2_header(tvbuff_t *su_tvb, proto_item *mtp2_tree)
103 {
104   if (mtp2_tree) {
105     if (use_extended_sequence_numbers) {
106       proto_tree_add_item(mtp2_tree, hf_mtp2_ext_bsn,   su_tvb, EXTENDED_BSN_BIB_OFFSET, EXTENDED_BSN_BIB_LENGTH, ENC_LITTLE_ENDIAN);
107       proto_tree_add_item(mtp2_tree, hf_mtp2_ext_res,   su_tvb, EXTENDED_BSN_BIB_OFFSET, EXTENDED_BSN_BIB_LENGTH, ENC_LITTLE_ENDIAN);
108       proto_tree_add_item(mtp2_tree, hf_mtp2_ext_bib,   su_tvb, EXTENDED_BSN_BIB_OFFSET, EXTENDED_BSN_BIB_LENGTH, ENC_LITTLE_ENDIAN);
109       proto_tree_add_item(mtp2_tree, hf_mtp2_ext_fsn,   su_tvb, EXTENDED_FSN_FIB_OFFSET, EXTENDED_FSN_FIB_LENGTH, ENC_LITTLE_ENDIAN);
110       proto_tree_add_item(mtp2_tree, hf_mtp2_ext_res,   su_tvb, EXTENDED_BSN_BIB_OFFSET, EXTENDED_BSN_BIB_LENGTH, ENC_LITTLE_ENDIAN);
111       proto_tree_add_item(mtp2_tree, hf_mtp2_ext_fib,   su_tvb, EXTENDED_FSN_FIB_OFFSET, EXTENDED_FSN_FIB_LENGTH, ENC_LITTLE_ENDIAN);
112       proto_tree_add_item(mtp2_tree, hf_mtp2_ext_li,    su_tvb, EXTENDED_LI_OFFSET,      EXTENDED_LI_LENGTH,      ENC_LITTLE_ENDIAN);
113       proto_tree_add_item(mtp2_tree, hf_mtp2_ext_spare, su_tvb, EXTENDED_LI_OFFSET,      EXTENDED_LI_LENGTH,      ENC_LITTLE_ENDIAN);
114     } else {
115       proto_tree_add_item(mtp2_tree, hf_mtp2_bsn,   su_tvb, BSN_BIB_OFFSET, BSN_BIB_LENGTH, ENC_LITTLE_ENDIAN);
116       proto_tree_add_item(mtp2_tree, hf_mtp2_bib,   su_tvb, BSN_BIB_OFFSET, BSN_BIB_LENGTH, ENC_LITTLE_ENDIAN);
117       proto_tree_add_item(mtp2_tree, hf_mtp2_fsn,   su_tvb, FSN_FIB_OFFSET, FSN_FIB_LENGTH, ENC_LITTLE_ENDIAN);
118       proto_tree_add_item(mtp2_tree, hf_mtp2_fib,   su_tvb, FSN_FIB_OFFSET, FSN_FIB_LENGTH, ENC_LITTLE_ENDIAN);
119       proto_tree_add_item(mtp2_tree, hf_mtp2_li,    su_tvb, LI_OFFSET,      LI_LENGTH,      ENC_LITTLE_ENDIAN);
120       proto_tree_add_item(mtp2_tree, hf_mtp2_spare, su_tvb, LI_OFFSET,      LI_LENGTH,      ENC_LITTLE_ENDIAN);
121     }
122   }
123 }
124 /*
125 *******************************************************************************
126 * DETAILS : Calculate a new FCS-16 given the current FCS-16 and the new data.
127 *******************************************************************************
128 */
129 static guint16
130 mtp2_fcs16(tvbuff_t * tvbuff)
131 {
132     guint len = tvb_length(tvbuff)-2;
133
134     /* Check for Invalid Length */
135     if (len == 0)
136         return (0x0000);
137     return crc16_ccitt_tvb(tvbuff, len);
138 }
139
140 /*
141  * This function for CRC16 only is based on the decode_fcs of packet_ppp.c
142  */
143 static tvbuff_t *
144 mtp2_decode_crc16(tvbuff_t *tvb, proto_tree *fh_tree, packet_info *pinfo)
145 {
146   tvbuff_t   *next_tvb;
147   gint       len, reported_len;
148   int        rx_fcs_offset;
149   guint32    rx_fcs_exp;
150   guint32    rx_fcs_got;
151   int proto_offset=0;
152   proto_item *cause;
153
154   /*
155    * Do we have the entire packet, and does it include a 2-byte FCS?
156    */
157   len = tvb_length_remaining(tvb, proto_offset);
158   reported_len = tvb_reported_length_remaining(tvb, proto_offset);
159   if (reported_len < 2 || len < 0) {
160     /*
161      * The packet is claimed not to even have enough data for a 2-byte FCS,
162      * or we're already past the end of the captured data.
163      * Don't slice anything off.
164      */
165     next_tvb = tvb_new_subset_remaining(tvb, proto_offset);
166   } else if (len < reported_len) {
167     /*
168      * The packet is claimed to have enough data for a 2-byte FCS, but
169      * we didn't capture all of the packet.
170      * Slice off the 2-byte FCS from the reported length, and trim the
171      * captured length so it's no more than the reported length; that
172      * will slice off what of the FCS, if any, is in the captured
173      * length.
174      */
175     reported_len -= 2;
176     if (len > reported_len)
177       len = reported_len;
178     next_tvb = tvb_new_subset(tvb, proto_offset, len, reported_len);
179   } else {
180     /*
181      * We have the entire packet, and it includes a 2-byte FCS.
182      * Slice it off.
183      */
184     len -= 2;
185     reported_len -= 2;
186     next_tvb = tvb_new_subset(tvb, proto_offset, len, reported_len);
187     
188     /*
189      * Compute the FCS and put it into the tree.
190      */
191     rx_fcs_offset = proto_offset + len;
192     rx_fcs_exp = mtp2_fcs16(tvb);
193     rx_fcs_got = tvb_get_letohs(tvb, rx_fcs_offset);
194     if (rx_fcs_got != rx_fcs_exp) {
195       cause=proto_tree_add_text(fh_tree, tvb, rx_fcs_offset, 2,
196                                 "FCS 16: 0x%04x [incorrect, should be 0x%04x]",
197                                 rx_fcs_got, rx_fcs_exp);
198       proto_item_set_expert_flags(cause, PI_MALFORMED, PI_WARN);
199       expert_add_info_format(pinfo, cause, PI_MALFORMED, PI_WARN, "MTP2 Frame CheckFCS 16 Error");
200     } else {
201       proto_tree_add_text(fh_tree, tvb, rx_fcs_offset, 2,
202                           "FCS 16: 0x%04x [correct]",
203                           rx_fcs_got);
204     }
205   }
206   return next_tvb;
207 }
208
209
210 static void
211 dissect_mtp2_fisu(packet_info *pinfo)
212 {
213   col_set_str(pinfo->cinfo, COL_INFO, "FISU ");
214 }
215
216 static const value_string status_field_vals[] = {
217   { 0x0, "Status Indication O" },
218   { 0x1, "Status Indication N" },
219   { 0x2, "Status Indication E" },
220   { 0x3, "Status Indication OS" },
221   { 0x4, "Status Indication PO" },
222   { 0x5, "Status Indication B" },
223   { 0,   NULL}
224 };
225
226 /* Same as above but in acronym form (for the Info column) */
227 static const value_string status_field_acro_vals[] = {
228   { 0x0, "SIO" },
229   { 0x1, "SIN" },
230   { 0x2, "SIE" },
231   { 0x3, "SIOS" },
232   { 0x4, "SIPO" },
233   { 0x5, "SIB" },
234   { 0,   NULL}
235 };
236
237 #define SF_OFFSET          (LI_OFFSET + LI_LENGTH)
238 #define EXTENDED_SF_OFFSET (EXTENDED_LI_OFFSET + EXTENDED_LI_LENGTH)
239
240 #define SF_LENGTH                       1
241 #define SF_EXTRA_OFFSET                 (SF_OFFSET + SF_LENGTH)
242 #define EXTENDED_SF_EXTRA_OFFSET        (EXTENDED_SF_OFFSET + SF_LENGTH)
243 #define SF_EXTRA_LENGTH                 1
244
245 static void
246 dissect_mtp2_lssu(tvbuff_t *su_tvb, packet_info *pinfo, proto_item *mtp2_tree)
247 {
248   guint8 sf = 0xFF;
249   guint8 sf_offset, sf_extra_offset;
250   
251   if (use_extended_sequence_numbers) {
252     sf_offset = EXTENDED_SF_OFFSET;
253     sf_extra_offset = EXTENDED_SF_EXTRA_OFFSET;
254   } else {
255     sf_offset = SF_OFFSET;
256     sf_extra_offset = SF_EXTRA_OFFSET;
257   }
258
259   proto_tree_add_item(mtp2_tree, hf_mtp2_sf, su_tvb, sf_offset, SF_LENGTH, ENC_LITTLE_ENDIAN);
260   sf = tvb_get_guint8(su_tvb, SF_OFFSET);
261
262   /*  If the LI is 2 then there is an extra octet following the standard SF
263    *  field but it is not defined what this octet is.
264    *  (In any case the first byte of the SF always has the same meaning.)
265    */
266   if ((tvb_get_guint8(su_tvb, LI_OFFSET) & LI_MASK) == 2)
267     proto_tree_add_item(mtp2_tree, hf_mtp2_sf_extra, su_tvb, sf_extra_offset, SF_EXTRA_LENGTH, ENC_LITTLE_ENDIAN);
268
269   if (check_col(pinfo->cinfo, COL_INFO))
270     col_set_str(pinfo->cinfo, COL_INFO, val_to_str_const(sf, status_field_acro_vals, "Unknown"));
271 }
272
273 static void
274 dissect_mtp2_msu(tvbuff_t *su_tvb, packet_info *pinfo, proto_item *mtp2_item, proto_item *tree)
275 {
276   gint sif_sio_length;
277   tvbuff_t *sif_sio_tvb;
278
279   col_set_str(pinfo->cinfo, COL_INFO, "MSU ");
280
281   if (use_extended_sequence_numbers) {
282     sif_sio_length = tvb_length(su_tvb) - EXTENDED_HEADER_LENGTH;
283     sif_sio_tvb = tvb_new_subset(su_tvb, EXTENDED_SIO_OFFSET, sif_sio_length, sif_sio_length);
284   } else {
285     sif_sio_length = tvb_length(su_tvb) - HEADER_LENGTH;
286     sif_sio_tvb = tvb_new_subset(su_tvb, SIO_OFFSET, sif_sio_length, sif_sio_length);
287   }
288   call_dissector(mtp3_handle, sif_sio_tvb, pinfo, tree);
289
290   if (tree) {
291     if (use_extended_sequence_numbers)
292       proto_item_set_len(mtp2_item, EXTENDED_HEADER_LENGTH);
293     else
294       proto_item_set_len(mtp2_item, HEADER_LENGTH);
295   }
296 }
297
298 static void
299 dissect_mtp2_su(tvbuff_t *su_tvb, packet_info *pinfo, proto_item *mtp2_item, proto_item *mtp2_tree, proto_tree *tree,gboolean validate_crc)
300 {
301   guint16 li;
302   tvbuff_t  *next_tvb = NULL;
303
304   dissect_mtp2_header(su_tvb, mtp2_tree); 
305   if (validate_crc)  
306     next_tvb = mtp2_decode_crc16(su_tvb, mtp2_tree, pinfo);
307
308   if (use_extended_sequence_numbers)
309     li = tvb_get_letohs(su_tvb, EXTENDED_LI_OFFSET) & EXTENDED_LI_MASK;
310   else
311     li = tvb_get_guint8(su_tvb, LI_OFFSET) & LI_MASK;
312   switch(li) {
313   case 0:
314     dissect_mtp2_fisu(pinfo);
315     break;
316   case 1:
317   case 2: 
318     if (validate_crc)  
319       dissect_mtp2_lssu(next_tvb, pinfo, mtp2_tree);
320     else
321       dissect_mtp2_lssu(su_tvb, pinfo, mtp2_tree);
322     break;
323   default:
324     /* In some capture files (like .rf5), CRC are not present */
325     /* So, to avoid trouble, give the complete buffer if CRC validation is disabled */
326     if (validate_crc)  
327       dissect_mtp2_msu(next_tvb, pinfo, mtp2_item, tree);
328     else 
329       dissect_mtp2_msu(su_tvb, pinfo, mtp2_item, tree);
330     break;
331   }
332 }
333
334 static void
335 dissect_mtp2_common(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, gboolean validate_crc)
336 {
337   proto_item *mtp2_item = NULL;
338   proto_tree *mtp2_tree = NULL;
339
340   if (pinfo->annex_a_used == MTP2_ANNEX_A_USED_UNKNOWN)
341     use_extended_sequence_numbers = use_extended_sequence_numbers_default;
342   else
343     use_extended_sequence_numbers = (pinfo->annex_a_used == MTP2_ANNEX_A_USED);
344     
345   col_set_str(pinfo->cinfo, COL_PROTOCOL, "MTP2");
346   
347   if (tree) {
348     mtp2_item = proto_tree_add_item(tree, proto_mtp2, tvb, 0, -1, ENC_NA);
349     mtp2_tree = proto_item_add_subtree(mtp2_item, ett_mtp2);
350   };
351
352   dissect_mtp2_su(tvb, pinfo, mtp2_item, mtp2_tree, tree, validate_crc);
353 }
354
355 /* Dissect MTP2 frame with/without CRC16 included at end of payload */
356 static void
357 dissect_mtp2(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
358 {
359   /* If the link extension indicates the FCS presence, then the Checkbits
360    * have to be proceeded in the MTP2 dissector */
361   if ( pinfo->fd->lnk_t == WTAP_ENCAP_ERF ) {
362     dissect_mtp2_common(tvb, pinfo, tree, TRUE);
363   } else {
364     dissect_mtp2_common(tvb, pinfo, tree, FALSE);
365   }
366 }
367
368 void
369 proto_register_mtp2(void)
370 {
371
372   static hf_register_info hf[] = {
373     { &hf_mtp2_bsn,       { "Backward sequence number", "mtp2.bsn",      FT_UINT8,  BASE_DEC, NULL,                    BSN_MASK,            NULL, HFILL } },
374     { &hf_mtp2_ext_bsn,   { "Backward sequence number", "mtp2.bsn",      FT_UINT16, BASE_DEC, NULL,                    EXTENDED_BSN_MASK,   NULL, HFILL } },
375     { &hf_mtp2_ext_res,   { "Reserved",                 "mtp2.res",      FT_UINT16, BASE_DEC, NULL,                    EXTENDED_RES_MASK,   NULL, HFILL } },
376     { &hf_mtp2_bib,       { "Backward indicator bit",   "mtp2.bib",      FT_UINT8,  BASE_DEC, NULL,                    BIB_MASK,            NULL, HFILL } },
377     { &hf_mtp2_ext_bib,   { "Backward indicator bit",   "mtp2.bib",      FT_UINT16, BASE_DEC, NULL,                    EXTENDED_BIB_MASK,   NULL, HFILL } },
378     { &hf_mtp2_fsn,       { "Forward sequence number",  "mtp2.fsn",      FT_UINT8,  BASE_DEC, NULL,                    FSN_MASK,            NULL, HFILL } },
379     { &hf_mtp2_ext_fsn,   { "Forward sequence number",  "mtp2.fsn",      FT_UINT16, BASE_DEC, NULL,                    EXTENDED_FSN_MASK,   NULL, HFILL } },
380     { &hf_mtp2_fib,       { "Forward indicator bit",    "mtp2.fib",      FT_UINT8,  BASE_DEC, NULL,                    FIB_MASK,            NULL, HFILL } },
381     { &hf_mtp2_ext_fib,   { "Forward indicator bit",    "mtp2.fib",      FT_UINT16, BASE_DEC, NULL,                    EXTENDED_FIB_MASK,   NULL, HFILL } },
382     { &hf_mtp2_li,        { "Length Indicator",         "mtp2.li",       FT_UINT8,  BASE_DEC, NULL,                    LI_MASK,             NULL, HFILL } },
383     { &hf_mtp2_ext_li,    { "Length Indicator",         "mtp2.li",       FT_UINT16, BASE_DEC, NULL,                    EXTENDED_LI_MASK,    NULL, HFILL } },
384     { &hf_mtp2_spare,     { "Spare",                    "mtp2.spare",    FT_UINT8,  BASE_DEC, NULL,                    SPARE_MASK,          NULL, HFILL } },
385     { &hf_mtp2_ext_spare, { "Spare",                    "mtp2.spare",    FT_UINT16, BASE_DEC, NULL,                    EXTENDED_SPARE_MASK, NULL, HFILL } },
386     { &hf_mtp2_sf,        { "Status field",             "mtp2.sf",       FT_UINT8,  BASE_DEC, VALS(status_field_vals), 0x0,                 NULL, HFILL } },
387     { &hf_mtp2_sf_extra,  { "Status field extra octet", "mtp2.sf_extra", FT_UINT8,  BASE_HEX, NULL,                    0x0,                 NULL, HFILL } }
388   };
389
390   static gint *ett[] = {
391     &ett_mtp2
392   };
393
394   module_t *mtp2_module;
395
396   proto_mtp2 = proto_register_protocol("Message Transfer Part Level 2", "MTP2", "mtp2");
397   register_dissector("mtp2", dissect_mtp2, proto_mtp2);
398
399   proto_register_field_array(proto_mtp2, hf, array_length(hf));
400   proto_register_subtree_array(ett, array_length(ett));
401   
402   mtp2_module = prefs_register_protocol(proto_mtp2, NULL);
403   prefs_register_bool_preference(mtp2_module, 
404                                  "use_extended_sequence_numbers",
405                                  "Use extended sequence numbers",
406                                  "Whether the MTP2 dissector should use extended sequence numbers as described in Q.703, Annex A as a default.",
407                                  &use_extended_sequence_numbers_default);
408
409
410 }
411
412 void
413 proto_reg_handoff_mtp2(void)
414 {
415   dissector_handle_t mtp2_handle;
416
417   mtp2_handle = find_dissector("mtp2");
418   dissector_add("wtap_encap", WTAP_ENCAP_MTP2, mtp2_handle);
419   dissector_add("wtap_encap", WTAP_ENCAP_MTP2_WITH_PHDR, mtp2_handle);
420
421   mtp3_handle   = find_dissector("mtp3");
422 }