Use MAC address documentation range in filter examples
[metze/wireshark/wip.git] / epan / dissectors / packet-brdwlk.c
index eb8d90013d4877ea36eb99e4095dbdab1983de64..78e6120d1daddb787296c2f9ed6a9a9f6abbec9c 100644 (file)
@@ -2,67 +2,51 @@
  * Routines for decoding MDS Port Analyzer Adapter (FC in Eth) Header
  * Copyright 2001, Dinesh G Dutt <ddutt@andiamo.com>
  *
- * $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.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#ifdef HAVE_CONFIG_H
-# include "config.h"
-#endif
-
-#include <stdlib.h>
-#include <string.h>
-
-#ifdef HAVE_SYS_TYPES_H
-# include <sys/types.h>
-#endif
-
-#ifdef HAVE_NETINET_IN_H
-# include <netinet/in.h>
-#endif
-
-#include <glib.h>
+#include "config.h"
 
 #include <epan/packet.h>
 #include <epan/etypes.h>
+#include "packet-fc.h"
 
 #define BRDWLK_MAX_PACKET_CNT  0xFFFF
 #define BRDWLK_TRUNCATED_BIT   0x8
 #define BRDWLK_HAS_PLEN        0x1
 
 #define FCM_DELIM_SOFC1         0x01
-#define FCM_DELIM_SOFI1                0x02
-#define FCM_DELIM_SOFI2                0x04
-#define FCM_DELIM_SOFI3                0x06
-#define FCM_DELIM_SOFN1                0x03
-#define FCM_DELIM_SOFN2                0x05
-#define FCM_DELIM_SOFN3                0x07
-#define FCM_DELIM_SOFF         0x08
+#define FCM_DELIM_SOFI1         0x02
+#define FCM_DELIM_SOFI2         0x04
+#define FCM_DELIM_SOFI3         0x06
+#define FCM_DELIM_SOFN1         0x03
+#define FCM_DELIM_SOFN2         0x05
+#define FCM_DELIM_SOFN3         0x07
+#define FCM_DELIM_SOFF          0x08
 #define FCM_DELIM_SOFC4         0x09
 #define FCM_DELIM_SOFI4         0x0A
 #define FCM_DELIM_SOFN4         0x0B
 
-#define FCM_DELIM_EOFT         0x01
-#define FCM_DELIM_EOFDT                0x02
-#define FCM_DELIM_EOFN         0x03
-#define FCM_DELIM_EOFA         0x04
+#define FCM_DELIM_EOFT          0x01
+#define FCM_DELIM_EOFDT         0x02
+#define FCM_DELIM_EOFN          0x03
+#define FCM_DELIM_EOFA          0x04
 #define FCM_DELIM_EOFNI         0x07
 #define FCM_DELIM_EOFDTI        0x06
 #define FCM_DELIM_EOFRT         0x0A
@@ -70,6 +54,9 @@
 #define FCM_DELIM_NOEOF         0xF0
 #define FCM_DELIM_EOFJUMBO      0xF1
 
+void proto_register_brdwlk(void);
+void proto_reg_handoff_brdwlk(void);
+
 static const value_string brdwlk_sof_vals[] = {
     {FCM_DELIM_SOFI1, "SOFi1"},
     {FCM_DELIM_SOFI2, "SOFi2"},
@@ -114,115 +101,68 @@ static gint proto_brdwlk = -1;
 static guint16 packet_count = 0;
 static gboolean first_pkt = TRUE;                /* start of capture */
 
-static dissector_handle_t data_handle;
 static dissector_handle_t fc_dissector_handle;
 
 
 static const true_false_string tfs_error_plp = {
-       "Packet Length is PRESENT",
-       "Packet length is NOT present"
+    "Packet Length is PRESENT",
+    "Packet length is NOT present"
 };
 static const true_false_string tfs_error_ef = {
-       "This is an Empty Frame",
-       "Frame is NOT empty"
+    "This is an Empty Frame",
+    "Frame is NOT empty"
 };
 static const true_false_string tfs_error_nd = {
-       "This Frame has NO Data",
-       "This frame carries data"
+    "This Frame has NO Data",
+    "This frame carries data"
 };
 static const true_false_string tfs_error_tr = {
-       "This frame is TRUNCATED",
-       "This frame is NOT truncated"
+    "This frame is TRUNCATED",
+    "This frame is NOT truncated"
 };
 static const true_false_string tfs_error_crc = {
-       "This Frame has a BAD FC CRC",
-       "This frame has a valid crc"
+    "This Frame has a BAD FC CRC",
+    "This frame has a valid crc"
 };
 static const true_false_string tfs_error_ff = {
-       "Fifo is Full",
-       "Fifo is NOT full"
+    "Fifo is Full",
+    "Fifo is NOT full"
 };
 static const true_false_string tfs_error_jumbo = {
-       "This is a JUMBO FC Frame",
-       "This is a NORMAL FC Frame"
+    "This is a JUMBO FC Frame",
+    "This is a NORMAL FC Frame"
 };
 static const true_false_string tfs_error_ctrl = {
-       "Ctrl Characters inside the frame",
-       "No ctrl chars inside the frame"
+    "Ctrl Characters inside the frame",
+    "No ctrl chars inside the frame"
 };
 
 static void
 dissect_brdwlk_err(proto_tree *parent_tree, tvbuff_t *tvb, int offset)
 {
-       proto_item *item=NULL;
-       proto_tree *tree=NULL;
-       guint8 flags;
-
-       flags = tvb_get_guint8 (tvb, offset);
-       if(parent_tree){
-               item=proto_tree_add_uint(parent_tree, hf_brdwlk_error, 
-                               tvb, offset, 1, flags);
-               tree=proto_item_add_subtree(item, ett_brdwlk_error);
-       }
-
-
-       proto_tree_add_boolean(tree, hf_brdwlk_error_plp, tvb, offset, 1, flags);
-       if (flags&0x01){
-               proto_item_append_text(item, "  Packet Length Present");
-       }
-       flags&=(~( 0x01 ));
-
-       proto_tree_add_boolean(tree, hf_brdwlk_error_ef, tvb, offset, 1, flags);
-       if (flags&0x02){
-               proto_item_append_text(item, "  Empty Frame");
-       }
-       flags&=(~( 0x02 ));
-
-       proto_tree_add_boolean(tree, hf_brdwlk_error_nd, tvb, offset, 1, flags);
-       if (flags&0x04){
-               proto_item_append_text(item, "  No Data");
-       }
-       flags&=(~( 0x04 ));
-
-       proto_tree_add_boolean(tree, hf_brdwlk_error_tr, tvb, offset, 1, flags);
-       if (flags&0x08){
-               proto_item_append_text(item, "  Truncated");
-       }
-       flags&=(~( 0x08 ));
-
-       proto_tree_add_boolean(tree, hf_brdwlk_error_badcrc, tvb, offset, 1, flags);
-       if (flags&0x10){
-               proto_item_append_text(item, "  Bad FC CRC");
-       }
-       flags&=(~( 0x10 ));
-
-       proto_tree_add_boolean(tree, hf_brdwlk_error_ff, tvb, offset, 1, flags);
-       if (flags&0x20){
-               proto_item_append_text(item, "  Fifo Full");
-       }
-       flags&=(~( 0x20 ));
-
-       proto_tree_add_boolean(tree, hf_brdwlk_error_jumbo, tvb, offset, 1, flags);
-       if (flags&0x40){
-               proto_item_append_text(item, "  Jumbo FC Frame");
-       }
-       flags&=(~( 0x40 ));
-
-       proto_tree_add_boolean(tree, hf_brdwlk_error_ctrl, tvb, offset, 1, flags);
-       if (flags&0x80){
-               proto_item_append_text(item, "  Ctrl Char Inside Frame");
-       }
-       flags&=(~( 0x80 ));
+    static const int * flags[] = {
+        &hf_brdwlk_error_plp,
+        &hf_brdwlk_error_ef,
+        &hf_brdwlk_error_nd,
+        &hf_brdwlk_error_tr,
+        &hf_brdwlk_error_badcrc,
+        &hf_brdwlk_error_ff,
+        &hf_brdwlk_error_jumbo,
+        &hf_brdwlk_error_ctrl,
+        NULL
+    };
+
+    proto_tree_add_bitmask_with_flags(parent_tree, tvb, offset, hf_brdwlk_error, ett_brdwlk_error, flags, ENC_NA, BMT_NO_FALSE|BMT_NO_TFS);
 }
 
 /* Code to actually dissect the packets */
 static void
-dissect_brdwlk (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
+dissect_brdwlk(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
 {
 
 /* Set up structures needed to add the protocol subtree and manage it */
     proto_item *ti, *hidden_item;
-    proto_tree *brdwlk_tree = NULL;
+    proto_tree *brdwlk_tree;
     tvbuff_t *next_tvb;
     guint8 error, eof, sof;
     int hdrlen = 2,
@@ -230,36 +170,34 @@ dissect_brdwlk (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
     gint len, reported_len, plen;
     guint16 pkt_cnt;
     gboolean dropped_packets;
+    fc_data_t fc_data;
 
     /* Make entries in Protocol column and Info column on summary display */
     col_set_str(pinfo->cinfo, COL_PROTOCOL, "Boardwalk");
-    
+
     col_clear(pinfo->cinfo, COL_INFO);
 
-    pinfo->vsan = (tvb_get_ntohs (tvb, offset) & 0xFFF);
-    sof = (tvb_get_guint8 (tvb, offset) & 0xF0) >> 4;
+    sof = (tvb_get_guint8(tvb, offset) & 0xF0) >> 4;
 
+    fc_data.sof_eof = 0;
     if ((sof == FCM_DELIM_SOFI3) || (sof == FCM_DELIM_SOFI2) || (sof == FCM_DELIM_SOFI1)
         || (sof == FCM_DELIM_SOFI4)) {
-        pinfo->sof_eof = PINFO_SOF_FIRST_FRAME;
+        fc_data.sof_eof = FC_DATA_SOF_FIRST_FRAME;
     }
     else if (sof == FCM_DELIM_SOFF) {
-        pinfo->sof_eof = PINFO_SOF_SOFF;
+        fc_data.sof_eof = FC_DATA_SOF_SOFF;
     }
 
-    if (tree) {
-        ti = proto_tree_add_protocol_format (tree, proto_brdwlk, tvb, 0,
-                                             hdrlen, "Boardwalk");
+    ti = proto_tree_add_protocol_format(tree, proto_brdwlk, tvb, 0,
+            hdrlen, "Boardwalk");
 
-        brdwlk_tree = proto_item_add_subtree (ti, ett_brdwlk);
+    brdwlk_tree = proto_item_add_subtree(ti, ett_brdwlk);
 
-        proto_tree_add_item (brdwlk_tree, hf_brdwlk_sof, tvb, offset, 1, 0);
-        proto_tree_add_item (brdwlk_tree, hf_brdwlk_vsan, tvb, offset, 2, 0);
-
-    }
+    proto_tree_add_item(brdwlk_tree, hf_brdwlk_sof, tvb, offset, 1, ENC_BIG_ENDIAN);
+    proto_tree_add_item(brdwlk_tree, hf_brdwlk_vsan, tvb, offset, 2, ENC_BIG_ENDIAN);
 
     /* Locate EOF which is the last 4 bytes of the frame */
-    len = tvb_length_remaining(tvb, hdrlen);
+    len = tvb_captured_length_remaining(tvb, hdrlen);
     reported_len = tvb_reported_length_remaining(tvb, hdrlen);
     if (reported_len < 4) {
         /*
@@ -291,10 +229,10 @@ dissect_brdwlk (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
         len -= 4;
         reported_len -= 4;
         offset = tvb_reported_length(tvb) - 4;
-        pkt_cnt = tvb_get_ntohs (tvb, offset);
+        pkt_cnt = tvb_get_ntohs(tvb, offset);
         if (tree) {
-            proto_tree_add_uint (brdwlk_tree, hf_brdwlk_pktcnt, tvb, offset,
-                                 2, pkt_cnt);
+            proto_tree_add_uint(brdwlk_tree, hf_brdwlk_pktcnt, tvb, offset,
+                                2, pkt_cnt);
         }
         dropped_packets = FALSE;
         if (pinfo->fd->flags.visited) {
@@ -305,7 +243,7 @@ dissect_brdwlk (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
              * We therefore attach a non-null pointer as frame data to
              * any frame preceded by dropped packets.
              */
-            if (p_get_proto_data(pinfo->fd, proto_brdwlk) != NULL)
+            if (p_get_proto_data(wmem_file_scope(), pinfo, proto_brdwlk, 0) != NULL)
                 dropped_packets = TRUE;
         } else {
             /*
@@ -326,59 +264,55 @@ dissect_brdwlk (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
                      * packets.  (The data we use as the frame data doesn't
                      * matter - it just matters that it's non-null.)
                      */
-                    p_add_proto_data(pinfo->fd, proto_brdwlk, &packet_count);
+                    p_add_proto_data(wmem_file_scope(), pinfo, proto_brdwlk, 0, &packet_count);
                 }
             }
-
-            if (tree) {
-                hidden_item = proto_tree_add_boolean (brdwlk_tree, hf_brdwlk_drop,
-                                               tvb, offset, 0, dropped_packets);
-                PROTO_ITEM_SET_HIDDEN(hidden_item);
-            }
         }
+
+        hidden_item = proto_tree_add_boolean(brdwlk_tree, hf_brdwlk_drop,
+                tvb, offset, 0, dropped_packets);
+        PROTO_ITEM_SET_HIDDEN(hidden_item);
+
         packet_count = pkt_cnt;
 
-       error=tvb_get_guint8(tvb, offset+2);           
-       dissect_brdwlk_err(brdwlk_tree, tvb, offset+2);
+        error=tvb_get_guint8(tvb, offset+2);
+        dissect_brdwlk_err(brdwlk_tree, tvb, offset+2);
 
-        eof = tvb_get_guint8 (tvb, offset+3);
+        eof = tvb_get_guint8(tvb, offset+3);
         if (eof != FCM_DELIM_EOFN) {
-            pinfo->sof_eof |= PINFO_EOF_LAST_FRAME;
+            fc_data.sof_eof |= FC_DATA_EOF_LAST_FRAME;
         }
         else if (eof != FCM_DELIM_EOFT) {
-            pinfo->sof_eof |= PINFO_EOF_INVALID;
-        }
-        
-        if (tree) {
-            proto_tree_add_item (brdwlk_tree, hf_brdwlk_eof, tvb, offset+3,
-                                 1, 0);
+            fc_data.sof_eof |= FC_DATA_EOF_INVALID;
         }
 
+        proto_tree_add_item(brdwlk_tree, hf_brdwlk_eof, tvb, offset+3,
+                1, ENC_BIG_ENDIAN);
+
         if ((error & BRDWLK_HAS_PLEN) && tree) {
             /* In newer Boardwalks, if this bit is set, the actual frame length
              * is also provided. This length is the size between SOF & EOF
              * including FC CRC.
              */
-            plen = tvb_get_ntohl (tvb, offset-4);
+            plen = tvb_get_ntohl(tvb, offset-4);
             plen *= 4;
-            proto_tree_add_uint (brdwlk_tree, hf_brdwlk_plen, tvb, offset-4,
-                                 4, plen);
-            
+            proto_tree_add_uint(brdwlk_tree, hf_brdwlk_plen, tvb, offset-4,
+                                4, plen);
+
 #if 0
             /* XXX - this would throw an exception if it would increase
              * the reported length.
              */
             if (error & BRDWLK_TRUNCATED_BIT) {
-                tvb_set_reported_length (tvb, plen);
+                tvb_set_reported_length(tvb, plen);
             }
 #endif
         }
     }
-    
-    next_tvb = tvb_new_subset (tvb, 2, len, reported_len);
-    if (fc_dissector_handle) {
-        call_dissector (fc_dissector_handle, next_tvb, pinfo, tree);
-    }
+
+    fc_data.ethertype = ETHERTYPE_BRDWALK;
+    next_tvb = tvb_new_subset(tvb, 2, len, reported_len);
+    call_dissector_with_data(fc_dissector_handle, next_tvb, pinfo, tree, &fc_data);
 }
 
 static void
@@ -395,16 +329,16 @@ brdwlk_init(void)
 */
 
 void
-proto_register_brdwlk (void)
-{                 
+proto_register_brdwlk(void)
+{
 
 /* Setup list of header fields  See Section 1.6.1 for details*/
     static hf_register_info hf[] = {
         { &hf_brdwlk_sof,
-          {"SOF", "brdwlk.sof", FT_UINT8, BASE_HEX, VALS (brdwlk_sof_vals),
+          {"SOF", "brdwlk.sof", FT_UINT8, BASE_HEX, VALS(brdwlk_sof_vals),
            0xF0, NULL, HFILL}},
         { &hf_brdwlk_eof,
-          {"EOF", "brdwlk.eof", FT_UINT8, BASE_HEX, VALS (brdwlk_eof_vals),
+          {"EOF", "brdwlk.eof", FT_UINT8, BASE_HEX, VALS(brdwlk_eof_vals),
            0x0F, NULL, HFILL}},
         { &hf_brdwlk_error,
           {"Error", "brdwlk.error", FT_UINT8, BASE_HEX, NULL, 0x0, NULL,
@@ -465,18 +399,26 @@ proto_register_brdwlk (void)
 }
 
 
-/* If this dissector uses sub-dissector registration add a registration routine.
-   This format is required because a script is used to find these routines and
-   create the code that calls these routines.
-*/
 void
 proto_reg_handoff_brdwlk(void)
 {
     dissector_handle_t brdwlk_handle;
 
-    brdwlk_handle = create_dissector_handle (dissect_brdwlk, proto_brdwlk);
-    dissector_add("ethertype", ETHERTYPE_BRDWALK, brdwlk_handle);
-    dissector_add("ethertype", 0xABCD, brdwlk_handle);
-    data_handle = find_dissector("data");
-    fc_dissector_handle = find_dissector ("fc");
+    brdwlk_handle = create_dissector_handle(dissect_brdwlk, proto_brdwlk);
+    dissector_add_uint("ethertype", ETHERTYPE_BRDWALK, brdwlk_handle);
+    dissector_add_uint("ethertype", 0xABCD, brdwlk_handle);
+    fc_dissector_handle = find_dissector("fc");
 }
+
+/*
+ * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
+ *
+ * Local variables:
+ * c-basic-offset: 4
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * vi: set shiftwidth=4 tabstop=8 expandtab:
+ * :indentSize=4:tabSize=8:noTabs=true:
+ */