From Holger Pfrommer:

Enhancement of Hilscher Analyzer Dissector.

https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=6082

svn path=/trunk/; revision=39804

1 files changed, 480 insertions, 0 deletions

diff --git a/epan/dissectors/packet-netanalyzer.c b/epan/dissectors/packet-netanalyzer.c
new file mode 100644
index 0000000000..c1b2c99154
--- /dev/null
+++ b/epan/dissectors/packet-netanalyzer.c
@@ -0,0 +1,480 @@
+/* packet-netanalyzer.c
+ * Dissector for Hilscher netANALYZER frames.
+ * Copyright 2008-2011, Hilscher GmbH, Holger Pfrommer hpfrommer[AT]hilscher.com
+ *
+ * $Id$
+ *
+ * Packet structure:
+ * +---------------------------+
+ * |           Header          |
+ * |         (4 Octets)        |
+ * +---------------------------+
+ * |           Payload         |
+ * .                           .
+ * .                           .
+ * .                           .
+ *
+ * Description:
+ * The header field contains a 32-bit value in little-endian byte order.
+ * The low-order 8 bits are a set of error flags for the packet:
+ *     0x00000001 - MII RX_ER
+ *     0x00000002 - alignment error
+ *     0x00000004 - FCS error
+ *     0x00000008 - frame too long
+ *     0x00000010 - SFD error
+ *     0x00000020 - frame shorter than 64 bytes
+ *     0x00000040 - preamble shorter than 7 bytes
+ *     0x00000080 - preamble longer than 7 bytes/li>
+ * The next bit, 0x00000100, is set if the packet arrived on the GPIO port rather tha the Ethernet port.
+ * The next bit, 0x00000200, is set if the packet was received in transparent capture mode. That should never be set for LINKTYPE_NETANALYZER and should always be set for LINKTYPE_NETANALYZER_TRANSPARENT.
+ * The next 4 bits, 0x00003C00, are a bitfield giving the version of the header field; the current version is 1.
+ * The next 2 bits, 0x0000C000, are the capture port/GPIO number, from 0 to 3.
+ * The next 12 bits, 0x0FFF0000, are the frame length, in bytes.
+ * The topmost 4 bits, 0xF0000000, are reserved.
+ * The payload is an Ethernet frame, beginning with the MAC header and ending with the FCS, for LINKTYPE_NETANALYZER, and an Ethernet frame, beginning with the preamble and ending with the FCS, for LINKTYPE_NETANALYZER_TRANSPARENT.
+ *
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald[AT]wireshark.org>
+ * Copyright 1999 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.
+ */
+
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <glib.h>
+#include <epan/packet.h>
+#include <expert.h>
+
+
+void proto_reg_handoff_netanalyzer(void);
+
+
+#define HEADER_SIZE  4
+#define INFO_TYPE_OFFSET    18
+
+#define MSK_RX_ERR             0x01
+#define TXT_RX_ERR             "MII RX_ER error"
+#define MSK_ALIGN_ERR          0x02
+#define TXT_ALIGN_ERR          "Alignment error"
+#define MSK_FCS_ERROR          0x04
+#define TXT_FCS_ERROR          "FCS error"
+#define MSK_TOO_LONG           0x08
+#define TXT_TOO_LONG           "Frame too long"
+#define MSK_SFD_ERROR          0x10
+#define TXT_SFD_ERROR          "No valid SFD found"
+#define MSK_SHORT_FRAME        0x20
+#define TXT_SHORT_FRAME        "Frame smaller 64 bytes"
+#define MSK_SHORT_PREAMBLE     0x40
+#define TXT_SHORT_PREAMBLE     "Preamble shorter than 7 bytes"
+#define MSK_LONG_PREAMBLE      0x80
+#define TXT_LONG_PREAMBLE      "Preamble longer than 7 bytes"
+
+#define SRT_PORT_NUM           6
+#define SRT_VERSION            2
+#define SRT_GPIO_FLAG          0
+#define MSK_PACKET_STATUS      0xff
+#define MSK_LENGTH             0x0fff
+#define MSK_TRANSPARENT_MODE   0x02
+
+
+static const value_string gpio_number[] = {
+    { 0x0, "GPIO 0" },
+    { 0x1, "GPIO 1" },
+    { 0x2, "GPIO 2" },
+    { 0x3, "GPIO 3" },
+    { 0,   NULL }
+};
+
+static const value_string gpio_edge[] = {
+    { 0x0, "rising edge" },
+    { 0x1, "falling edge" },
+    { 0,   NULL }
+};
+
+
+static dissector_handle_t  eth_dissector_handle;
+static dissector_handle_t  data_dissector_handle;
+
+static gint  proto_netanalyzer           = -1;
+
+static gint  hf_netanalyzer_gpio_number              = -1;
+static gint  hf_netanalyzer_gpio_edge                = -1;
+static gint  hf_netanalyzer_port                     = -1;
+static gint  hf_netanalyzer_length                   = -1;
+static gint  hf_netanalyzer_status                   = -1;
+static gint  hf_netanalyzer_status_rx_err            = -1;
+static gint  hf_netanalyzer_status_align_err         = -1;
+static gint  hf_netanalyzer_status_fcs               = -1;
+static gint  hf_netanalyzer_status_too_long          = -1;
+static gint  hf_netanalyzer_status_sfd_error         = -1;
+static gint  hf_netanalyzer_status_short_frame       = -1;
+static gint  hf_netanalyzer_status_short_preamble    = -1;
+static gint  hf_netanalyzer_status_long_preamble     = -1;
+
+static gint  ett_netanalyzer             = -1;
+static gint  ett_netanalyzer_status                  = -1;
+static gint  ett_netanalyzer_transparent             = -1;
+
+
+/* common routine for Ethernet and transparent mode */
+static int
+dissect_netanalyzer_common(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
+{
+  proto_item              *ti = NULL;
+  proto_tree              *netanalyzer_header_tree = NULL;
+  proto_item              *ti_status = NULL;
+  proto_tree              *netanalyzer_status_tree = NULL;
+  guint32                 packet_status;
+  guint32                 port_num;
+  guint32                 frame_length;
+  guint                   is_gpio;
+  guint32                 offset;
+  guint                   gpio_num;
+  guint                   gpio_edge;
+  guint                   version;
+  guchar                  *szTemp       = NULL;
+  guchar                  *szFollowed   = NULL;
+  guint                   idx;
+
+
+#define MAX_BUFFER 255
+  szTemp=ep_alloc(MAX_BUFFER);
+  szTemp[0]=0;
+  szFollowed=ep_alloc(3);
+  g_snprintf(szFollowed, 3, "");
+
+  if (tree)
+  {
+    /* generate netANALYZER tree */
+    ti = proto_tree_add_item(tree, proto_netanalyzer, tvb, 0, HEADER_SIZE, ENC_NA);
+    netanalyzer_header_tree = proto_item_add_subtree(ti, ett_netanalyzer);
+
+    is_gpio = (tvb_get_guint8(tvb, 1) >> SRT_GPIO_FLAG) & 0x1;
+
+    if (!is_gpio)
+    {
+      /* normal packet, no GPIO */
+
+      /* decode version */
+      version = (tvb_get_guint8(tvb, 1) >> SRT_VERSION) & 0xf;
+      if (version != 1)
+      {
+        /* something is wrong */
+        expert_add_info_format(pinfo, ti, PI_MALFORMED, PI_ERROR, "Wrong netANALYZER header version");
+        return FALSE;
+      }
+
+      /* decode port */
+      port_num = (tvb_get_guint8(tvb, 1) >> SRT_PORT_NUM) & 0x3;
+	  proto_tree_add_item(netanalyzer_status_tree, hf_netanalyzer_port, tvb, 0, 4, ENC_BIG_ENDIAN);
+      g_snprintf(szTemp, MAX_BUFFER, " (Port: %u, ", port_num);
+      proto_item_append_text(ti, szTemp);
+
+      /* decode length */
+      frame_length = tvb_get_letohs(tvb, 2) & MSK_LENGTH;
+	  proto_tree_add_item(netanalyzer_status_tree, hf_netanalyzer_length, tvb, 0, 4, ENC_BIG_ENDIAN);
+      g_snprintf(szTemp, MAX_BUFFER, "Length: %u byte%s, ", frame_length, (frame_length == 1) ? "" : "s" );
+      proto_item_append_text(ti, szTemp);
+
+      /* decode status */
+      g_snprintf(szTemp, MAX_BUFFER, "Status: ");
+      proto_item_append_text(ti, szTemp);
+      packet_status = tvb_get_guint8(tvb, 0);
+      if (packet_status == 0)
+      {
+        ti_status = proto_tree_add_uint_format(netanalyzer_header_tree, hf_netanalyzer_status, tvb, 0, 1, packet_status, "Status: No Error");
+        g_snprintf(szTemp, MAX_BUFFER, "No Error");
+        proto_item_append_text(ti, szTemp);
+      }
+      else
+      {
+        ti_status = proto_tree_add_uint_format(netanalyzer_header_tree, hf_netanalyzer_status, tvb, 0, 1, packet_status, "Status: Error present (expand tree for details)");
+      }
+
+      netanalyzer_status_tree = proto_item_add_subtree(ti_status, ett_netanalyzer_status);
+      proto_tree_add_item(netanalyzer_status_tree, hf_netanalyzer_status_rx_err, tvb, 0, 1, ENC_BIG_ENDIAN);
+      proto_tree_add_item(netanalyzer_status_tree, hf_netanalyzer_status_align_err, tvb, 0, 1, ENC_BIG_ENDIAN);
+      proto_tree_add_item(netanalyzer_status_tree, hf_netanalyzer_status_fcs, tvb, 0, 1, ENC_BIG_ENDIAN);
+      proto_tree_add_item(netanalyzer_status_tree, hf_netanalyzer_status_too_long, tvb, 0, 1, ENC_BIG_ENDIAN);
+      proto_tree_add_item(netanalyzer_status_tree, hf_netanalyzer_status_sfd_error, tvb, 0, 1, ENC_BIG_ENDIAN);
+      proto_tree_add_item(netanalyzer_status_tree, hf_netanalyzer_status_short_frame, tvb, 0, 1, ENC_BIG_ENDIAN);
+      proto_tree_add_item(netanalyzer_status_tree, hf_netanalyzer_status_short_preamble, tvb, 0, 1, ENC_BIG_ENDIAN);
+      proto_tree_add_item(netanalyzer_status_tree, hf_netanalyzer_status_long_preamble, tvb, 0, 1, ENC_BIG_ENDIAN);
+
+      for (idx = 0; idx < 8; idx++)
+      {
+        switch (1 << idx)
+        {
+          case MSK_RX_ERR        : g_snprintf(szTemp, MAX_BUFFER, TXT_RX_ERR); break;
+          case MSK_ALIGN_ERR     : g_snprintf(szTemp, MAX_BUFFER, TXT_ALIGN_ERR); break;
+          case MSK_FCS_ERROR     : g_snprintf(szTemp, MAX_BUFFER, TXT_FCS_ERROR); break;
+          case MSK_TOO_LONG      : g_snprintf(szTemp, MAX_BUFFER, TXT_TOO_LONG); break;
+          case MSK_SFD_ERROR     : g_snprintf(szTemp, MAX_BUFFER, TXT_SFD_ERROR); break;
+          case MSK_SHORT_FRAME   : g_snprintf(szTemp, MAX_BUFFER, TXT_SHORT_FRAME); break;
+          case MSK_SHORT_PREAMBLE: g_snprintf(szTemp, MAX_BUFFER, TXT_SHORT_PREAMBLE); break;
+          case MSK_LONG_PREAMBLE : g_snprintf(szTemp, MAX_BUFFER, TXT_LONG_PREAMBLE); break;
+          default: REPORT_DISSECTOR_BUG("unknown status bit"); break;
+        }
+
+        if (packet_status & (1 << idx))
+        {
+          proto_item_append_text(ti, szFollowed);
+          proto_item_append_text(ti, szTemp);
+          g_snprintf(szFollowed, 3, ", ");
+        }
+      }
+      proto_item_append_text(ti, ")");
+
+      /* decode transparent mode */
+      if (tvb_get_guint8(tvb, 1) & MSK_TRANSPARENT_MODE)
+      {
+        proto_tree_add_text(netanalyzer_header_tree, tvb, 0, 4, "This frame was captured in transparent mode");
+        proto_item_append_text(ti, ", Transparent Mode");
+
+        if (packet_status & MSK_ALIGN_ERR)
+        {
+          proto_tree_add_text(netanalyzer_header_tree, tvb, tvb_length(tvb)-1, 1, "Displayed frame data contains additional nibble due to alignment error (upper nibble is not valid)");
+        }
+      }
+    }
+    else
+    {
+      /* GPIO pseudo packet */
+      /* check consistency */
+      if ( (tvb_get_guint8(tvb, 10) == 0x00) &&
+           (tvb_get_guint8(tvb, 11) == 0x02) &&
+           (tvb_get_guint8(tvb, 12) == 0xa2) &&
+           (tvb_get_guint8(tvb, 13) == 0xff) &&
+           (tvb_get_guint8(tvb, 14) == 0xff) &&
+           (tvb_get_guint8(tvb, 15) == 0xff) &&
+           (tvb_get_guint8(tvb, 16) == 0x88) &&
+           (tvb_get_guint8(tvb, 17) == 0xff) &&
+           (tvb_get_guint8(tvb, INFO_TYPE_OFFSET) == 0x00) )
+      {
+        /* everything ok */
+        if (pinfo)
+          col_set_str(pinfo->cinfo, COL_PROTOCOL, "netANALYZER");
+
+        offset = INFO_TYPE_OFFSET;
+
+        /* GPIO number */
+        offset++;
+        ti = proto_tree_add_item (netanalyzer_header_tree, hf_netanalyzer_gpio_number, tvb, offset, 1, ENC_BIG_ENDIAN);
+        gpio_num = (tvb_get_guint8(tvb, offset) & 0x03);
+
+        /* GPIO edge */
+        offset++;
+        ti = proto_tree_add_item (netanalyzer_header_tree, hf_netanalyzer_gpio_edge, tvb, offset, 1, ENC_BIG_ENDIAN);
+        gpio_edge = (tvb_get_guint8(tvb, offset) & 0x01);
+
+        if (pinfo)
+        {
+          if (gpio_edge == 0x00)
+            g_snprintf(szTemp, MAX_BUFFER, "GPIO event on GPIO %d (rising edge)", gpio_num);
+          else
+            g_snprintf(szTemp, MAX_BUFFER, "GPIO event on GPIO %d (falling edge)", gpio_num);
+
+          col_add_fstr(pinfo->cinfo, COL_INFO, szTemp);
+          proto_item_append_text(ti, " ");
+          proto_item_append_text(ti, szTemp);
+        }
+      }
+      else
+      {
+        /* something is wrong */
+        expert_add_info_format(pinfo, ti, PI_MALFORMED, PI_ERROR, "No valid netANALYZER GPIO definition found");
+      }
+      return FALSE;
+    }
+  }
+  return TRUE;
+}
+
+
+/* Ethernet capture mode */
+static void
+dissect_netanalyzer(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
+{
+  tvbuff_t                *next_tvb;
+  proto_item              *ti = NULL;
+
+  if (tvb_length(tvb) >= 4)
+  {
+    /* generate tvb subset for Ethernet frame */
+    if (dissect_netanalyzer_common(tvb, pinfo, tree))
+    {
+      /* hand off to eth dissector with the new tvb subset */
+      next_tvb = tvb_new_subset(tvb, 4, tvb_length(tvb)-4, tvb_reported_length(tvb)-4);
+      call_dissector(eth_dissector_handle, next_tvb, pinfo, tree);
+    }
+  }
+  else
+  {
+    /* something is wrong */
+    if (tree)
+    {
+      ti = proto_tree_add_text(tree, tvb, 4, tvb_length(tvb)-4, "netANALYZER");
+      expert_add_info_format(pinfo, ti, PI_MALFORMED, PI_ERROR, "No netANALYZER header found");
+    }
+  }
+}
+
+
+/* Transparent capture mode */
+static void
+dissect_netanalyzer_transparent(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
+{
+  proto_item              *ti = NULL;
+  proto_tree              *transparent_payload_tree = NULL;
+  tvbuff_t                *next_tvb;
+
+  if (tvb_length(tvb) >= 4)
+  {
+    /* generate tvb subset for Ethernet frame */
+    if (dissect_netanalyzer_common(tvb, pinfo, tree))
+    {
+      /* do not hand off transparent packet for further Ethernet dissectors
+       * as normally the transparent mode is used for low level analysis
+       * where dissecting the frame's content wouldn't make much sense
+       * use data dissector instead */
+      ti = proto_tree_add_text(tree, tvb, 4, tvb_length(tvb)-4, "Raw packet data");
+      transparent_payload_tree = proto_item_add_subtree(ti, ett_netanalyzer_transparent);
+      next_tvb = tvb_new_subset(tvb, 4, tvb_length(tvb)-4, tvb_reported_length(tvb)-4);
+      call_dissector(data_dissector_handle, next_tvb, pinfo, transparent_payload_tree);
+
+      if (pinfo)
+      {
+        col_set_str(pinfo->cinfo, COL_PROTOCOL, "netANALYZER");
+        col_set_str(pinfo->cinfo, COL_INFO, "Frame captured in transparent mode");
+      }
+    }
+  }
+  else
+  {
+    /* something is wrong */
+    if (tree)
+    {
+      ti = proto_tree_add_text(tree, tvb, 4, tvb_length(tvb)-4, "netANALYZER transparent mode");
+      expert_add_info_format(pinfo, ti, PI_MALFORMED, PI_ERROR, "No netANALYZER header found");
+    }
+  }
+}
+
+
+void proto_register_netanalyzer(void)
+{
+    static hf_register_info hf[] = {
+        { &hf_netanalyzer_gpio_number,
+          { "Event on", "netanalyzer.gpio_event.gpio_number",
+            FT_UINT8, BASE_HEX, VALS(gpio_number), 0x0,
+            "Event on GPIO number", HFILL }
+        },
+        { &hf_netanalyzer_gpio_edge,
+          { "Event type", "netanalyzer.gpio_event.gpio_edge",
+            FT_UINT8, BASE_HEX, VALS(gpio_edge), 0x0,
+            "Edge of GPIO event", HFILL }
+        },
+        { &hf_netanalyzer_port,
+          { "Reception Port", "netanalyzer.port",
+            FT_UINT16, BASE_DEC, NULL, 0xc000,
+            "netANALYZER reception port", HFILL }
+        },
+        { &hf_netanalyzer_length,
+          { "Ethernet frame length", "netanalyzer.framelen",
+            FT_UINT16, BASE_DEC, NULL,  0x0fff,
+            "Actual Ethernet frame length", HFILL }
+        },
+        { &hf_netanalyzer_status,
+          { "Frame Status", "netanalyzer.packetstatus",
+            FT_UINT8, BASE_HEX, NULL, MSK_PACKET_STATUS,
+            "Status of Ethernet frame", HFILL }
+        },
+        { &hf_netanalyzer_status_rx_err,
+          { TXT_RX_ERR, "netanalyzer.packetstatus.rx_er",
+            FT_BOOLEAN, 8, NULL, MSK_RX_ERR,
+            "RX_ER detected in frame", HFILL }
+        },
+        { &hf_netanalyzer_status_align_err,
+          { TXT_ALIGN_ERR, "netanalyzer.packetstatus.alignment_error",
+            FT_BOOLEAN, 8, NULL, MSK_ALIGN_ERR,
+            "Alignment error detected in frame", HFILL }
+        },
+        { &hf_netanalyzer_status_fcs,
+          { TXT_FCS_ERROR, "netanalyzer.packetstatus.fcs_error",
+            FT_BOOLEAN, 8, NULL, MSK_FCS_ERROR,
+            "FCS error detected in frame", HFILL }
+        },
+        { &hf_netanalyzer_status_too_long,
+          { TXT_TOO_LONG, "netanalyzer.packetstatus.too_long",
+            FT_BOOLEAN, 8, NULL, MSK_TOO_LONG,
+            "Frame too long (capture truncated)", HFILL }
+        },
+        { &hf_netanalyzer_status_sfd_error,
+          { TXT_SFD_ERROR, "netanalyzer.packetstatus.sfd_error",
+            FT_BOOLEAN, 8, NULL, MSK_SFD_ERROR,
+            "SDF error detected in frame", HFILL }
+        },
+        { &hf_netanalyzer_status_short_frame,
+          { TXT_SHORT_FRAME, "netanalyzer.packetstatus.short_frame",
+            FT_BOOLEAN, 8, NULL, MSK_SHORT_FRAME,
+            "Frame too short", HFILL }
+        },
+        { &hf_netanalyzer_status_short_preamble,
+          { TXT_SHORT_PREAMBLE, "netanalyzer.packetstatus.short_preamble",
+            FT_BOOLEAN, 8, NULL, MSK_SHORT_PREAMBLE,
+            "Preamble shorter than 7 bytes", HFILL }
+        },
+        { &hf_netanalyzer_status_long_preamble,
+          { TXT_LONG_PREAMBLE, "netanalyzer.packetstatus.long_preamble",
+            FT_BOOLEAN, 8, NULL, MSK_LONG_PREAMBLE,
+            "Preamble longer than 7 bytes", HFILL }
+        },
+    };
+
+    static gint *ett[] = {
+        &ett_netanalyzer,
+        &ett_netanalyzer_status,
+        &ett_netanalyzer_transparent,
+    };
+
+    proto_netanalyzer = proto_register_protocol (
+                          "netANALYZER",            /* name */
+                          "netANALYZER",            /* short name */
+                          "netanalyzer" );          /* abbrev */
+
+    proto_register_field_array(proto_netanalyzer, hf, array_length(hf));
+    proto_register_subtree_array(ett, array_length(ett));
+
+}
+
+
+void proto_reg_handoff_netanalyzer(void)
+{
+  dissector_handle_t netana_handle;
+  dissector_handle_t netana_handle_transparent;
+
+  eth_dissector_handle  = find_dissector("eth_withfcs");
+  data_dissector_handle = find_dissector("data");
+
+  netana_handle             = create_dissector_handle(dissect_netanalyzer,             proto_netanalyzer);
+  netana_handle_transparent = create_dissector_handle(dissect_netanalyzer_transparent, proto_netanalyzer);
+  dissector_add_uint("wtap_encap", WTAP_ENCAP_NETANALYZER,             netana_handle);
+  dissector_add_uint("wtap_encap", WTAP_ENCAP_NETANALYZER_TRANSPARENT, netana_handle_transparent);
+}