From Michal Labedzki:

Bluetooth: Add support for HCI USB transport dissector

Based on Bluetooth Core 4.0 specification

Part of:
https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=5032

svn path=/trunk/; revision=46305

3 files changed, 335 insertions, 0 deletions

diff --git a/epan/CMakeLists.txt b/epan/CMakeLists.txt
index 1d2830bdcd..da5b123fda 100644
--- a/epan/CMakeLists.txt
+++ b/epan/CMakeLists.txt
@@ -706,6 +706,7 @@ set(DISSECTOR_SRC
 	dissectors/packet-hazelcast.c
 	dissectors/packet-hci_h1.c
 	dissectors/packet-hci_h4.c
+	dissectors/packet-hci_usb.c
 	dissectors/packet-hclnfsd.c
 	dissectors/packet-hdcp.c
 	dissectors/packet-hdcp2.c
diff --git a/epan/dissectors/Makefile.common b/epan/dissectors/Makefile.common
index 1d3a0c4f41..ae34870f47 100644
--- a/epan/dissectors/Makefile.common
+++ b/epan/dissectors/Makefile.common
@@ -626,6 +626,7 @@ DISSECTOR_SRC = \
 	packet-hazelcast.c	\
 	packet-hci_h1.c		\
 	packet-hci_h4.c		\
+	packet-hci_usb.c	\
 	packet-hclnfsd.c	\
 	packet-hdcp.c		\
 	packet-hdcp2.c		\
diff --git a/epan/dissectors/packet-hci_usb.c b/epan/dissectors/packet-hci_usb.c
new file mode 100644
index 0000000000..f2ea222ffc
--- /dev/null
+++ b/epan/dissectors/packet-hci_usb.c
@@ -0,0 +1,333 @@
+/* packet-hci_usb.c
+ * Routines for Bluetooth HCI USB dissection
+ *
+ * Copyright 2012, Michal Labedzki for Tieto Corporation
+ *
+ * $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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "config.h"
+
+#include <epan/packet.h>
+#include <epan/prefs.h>
+#include <epan/reassemble.h>
+
+#include "packet-usb.h"
+#include "packet-bluetooth-hci.h"
+
+static int proto_hci_usb = -1;
+static int hf_bthci_usb_data = -1;
+
+static gint ett_hci_usb = -1;
+static gint ett_hci_usb_msg_fragment = -1;
+static gint ett_hci_usb_msg_fragments = -1;
+
+static int hf_msg_fragments = -1;
+static int hf_msg_fragment = -1;
+static int hf_msg_fragment_overlap = -1;
+static int hf_msg_fragment_overlap_conflicts = -1;
+static int hf_msg_fragment_multiple_tails = -1;
+static int hf_msg_fragment_too_long_fragment = -1;
+static int hf_msg_fragment_error = -1;
+static int hf_msg_fragment_count = -1;
+static int hf_msg_reassembled_in = -1;
+static int hf_msg_reassembled_length = -1;
+
+static emem_tree_t *chandle_to_bdaddr_table = NULL;
+static emem_tree_t *bdaddr_to_name_table    = NULL;
+static emem_tree_t *localhost_name          = NULL;
+static emem_tree_t *localhost_bdaddr        = NULL;
+static emem_tree_t *fragment_info_table     = NULL;
+
+static GHashTable *fragment_table     = NULL;
+static GHashTable *reassembled_table  = NULL;
+
+typedef struct _fragment_info_t {
+    gint remaining_length;
+    gint fragment_id;
+} fragment_info_t;
+
+static const fragment_items hci_usb_msg_frag_items = {
+    /* Fragment subtrees */
+    &ett_hci_usb_msg_fragment,
+    &ett_hci_usb_msg_fragments,
+    /* Fragment fields */
+    &hf_msg_fragments,
+    &hf_msg_fragment,
+    &hf_msg_fragment_overlap,
+    &hf_msg_fragment_overlap_conflicts,
+    &hf_msg_fragment_multiple_tails,
+    &hf_msg_fragment_too_long_fragment,
+    &hf_msg_fragment_error,
+    &hf_msg_fragment_count,
+    /* Reassembled in field */
+    &hf_msg_reassembled_in,
+    /* Reassembled length field */
+    &hf_msg_reassembled_length,
+    /* Reassembled data field */
+    NULL,
+    /* Tag */
+    "Message fragments"
+};
+
+
+static int
+dissect_hci_usb(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
+{
+    proto_item     *ttree = NULL;
+    proto_tree     *titem = NULL;
+    proto_item     *pitem = NULL;
+    gint            offset = 0;
+    usb_data_t     *usb_data;
+    tvbuff_t       *next_tvb = NULL;
+    void           *pd_save;
+    hci_data_t     *hci_data;
+    gint            p2p_dir_save;
+    guint32         session_id;
+    fragment_data  *reassembled;
+
+    if (tvb_length_remaining(tvb, offset) <= 0)
+        return 0;
+
+    col_set_str(pinfo->cinfo, COL_PROTOCOL, "HCI_USB");
+
+    col_clear(pinfo->cinfo, COL_INFO);
+
+    usb_data = (usb_data_t *) pinfo->private_data;
+
+    p2p_dir_save = pinfo->p2p_dir;
+    pinfo->p2p_dir = usb_data->direction;
+
+    switch (pinfo->p2p_dir) {
+
+    case P2P_DIR_SENT:
+        col_add_str(pinfo->cinfo, COL_INFO, "Sent");
+        break;
+
+    case P2P_DIR_RECV:
+        col_add_str(pinfo->cinfo, COL_INFO, "Rcvd");
+        break;
+
+    default:
+        col_add_fstr(pinfo->cinfo, COL_INFO, "Unknown direction");
+        break;
+    }
+
+    titem = proto_tree_add_item(tree, proto_hci_usb, tvb, offset, -1, ENC_NA);
+    ttree = proto_item_add_subtree(titem, ett_hci_usb);
+
+    pd_save      = pinfo->private_data;
+
+    session_id = usb_data->bus_id << 16 | usb_data->device_address << 8 | ((pinfo->p2p_dir == P2P_DIR_RECV) ? 1 : 0 ) << 7 | usb_data->endpoint;
+
+    hci_data = ep_alloc(sizeof(hci_data_t));
+    hci_data->interface_id = HCI_INTERFACE_USB;
+    hci_data->adapter_id = usb_data->bus_id << 8  | usb_data->device_address;
+    hci_data->chandle_to_bdaddr_table = chandle_to_bdaddr_table;
+    hci_data->bdaddr_to_name_table = bdaddr_to_name_table;
+    hci_data->localhost_bdaddr = localhost_bdaddr;
+    hci_data->localhost_name = localhost_name;
+    pinfo->private_data = hci_data;
+
+    next_tvb = tvb_new_subset_remaining(tvb, offset);
+
+        if (!pinfo->fd->flags.visited && usb_data->endpoint <= 0x02) {
+            fragment_info_t  *fragment_info;
+
+            fragment_info = se_tree_lookup32(fragment_info_table, session_id);
+            if (fragment_info == NULL) {
+                fragment_info = se_alloc(sizeof(fragment_info_t));
+                fragment_info->fragment_id = 0;
+
+                se_tree_insert32(fragment_info_table, session_id, fragment_info);
+            }
+
+            if (fragment_info->fragment_id == 0) {
+                if (usb_data->endpoint == 0x00) {
+                    fragment_info->remaining_length = tvb_get_guint8(tvb, offset + 2) + 3;
+                } else if (usb_data->endpoint == 0x01) {
+                    fragment_info->remaining_length = tvb_get_guint8(tvb, offset + 1) + 2;
+                } else if (usb_data->endpoint == 0x02) {
+                    fragment_info->remaining_length = tvb_get_letohs(tvb, offset + 2) + 4;
+                }
+            }
+
+            fragment_info->remaining_length -= tvb_ensure_length_remaining(tvb, offset);
+
+            fragment_add_seq_check(tvb, offset, pinfo, session_id, fragment_table, reassembled_table, fragment_info->fragment_id, tvb_length_remaining(tvb, offset), (fragment_info->remaining_length == 0) ? FALSE : TRUE);
+            if (fragment_info->remaining_length > 0)
+                fragment_info->fragment_id += 1;
+            else
+                fragment_info->fragment_id = 0;
+        }
+
+        reassembled = fragment_get_reassembled_id(pinfo, session_id, reassembled_table);
+
+        if (reassembled && pinfo->fd->num < reassembled->reassembled_in) {
+            pitem = proto_tree_add_text(ttree, tvb, offset, -1, "Fragment");
+            PROTO_ITEM_SET_GENERATED(pitem);
+
+            col_append_fstr(pinfo->cinfo, COL_INFO, " Fragment");
+        } else if (reassembled && pinfo->fd->num == reassembled->reassembled_in) {
+            pitem = proto_tree_add_text(ttree, tvb, offset, -1, "Complete");
+            PROTO_ITEM_SET_GENERATED(pitem);
+
+            if (reassembled->len > tvb_ensure_length_remaining(tvb, offset)) {
+                next_tvb = process_reassembled_data(tvb, 0, pinfo,
+                        "Reassembled HCI_USB",
+                        reassembled, &hci_usb_msg_frag_items,
+                        NULL, ttree);
+            }
+
+            if (usb_data->endpoint == 0x00) {
+                call_dissector(find_dissector("bthci_cmd"), next_tvb, pinfo, tree);
+            } else if (usb_data->endpoint == 0x01) {
+                call_dissector(find_dissector("bthci_evt"), next_tvb, pinfo, tree);
+            } else if (usb_data->endpoint == 0x02) {
+                call_dissector(find_dissector("bthci_acl"), next_tvb, pinfo, tree);
+            }
+        } else {
+            pitem = proto_tree_add_text(ttree, tvb, offset, -1, "Unknown Fragment");
+            PROTO_ITEM_SET_GENERATED(pitem);
+        }
+
+    if (usb_data->endpoint == 0x03) {
+        call_dissector(find_dissector("bthci_sco"), next_tvb, pinfo, tree);
+    } else if (usb_data->endpoint > 0x03) {
+        proto_tree_add_item(ttree, hf_bthci_usb_data, tvb, offset, -1, ENC_BIG_ENDIAN);
+    }
+
+    offset += tvb_length_remaining(tvb, offset);
+
+    pinfo->p2p_dir = p2p_dir_save;
+    pinfo->private_data = pd_save;
+
+    return offset;
+}
+
+void
+proto_register_hci_usb(void)
+{
+    module_t *module;
+
+    static hf_register_info hf[] = {
+        {  &hf_msg_fragments,
+            { "Message fragments",               "hci_usb.msg.fragments",
+            FT_NONE, BASE_NONE, NULL, 0x00,
+            NULL, HFILL }
+        },
+        {  &hf_msg_fragment,
+            { "Message fragment",                "hci_usb.msg.fragment",
+            FT_FRAMENUM, BASE_NONE, NULL, 0x00,
+            NULL, HFILL }
+        },
+        {  &hf_msg_fragment_overlap,
+            { "Message fragment overlap",        "hci_usb.msg.fragment.overlap",
+            FT_BOOLEAN, BASE_NONE, NULL, 0x00,
+            NULL, HFILL }
+        },
+        {  &hf_msg_fragment_overlap_conflicts,
+            { "Message fragment overlapping with conflicting data", "hci_usb.msg.fragment.overlap.conflicts",
+            FT_BOOLEAN, BASE_NONE, NULL, 0x00,
+            NULL, HFILL }
+        },
+        {  &hf_msg_fragment_multiple_tails,
+            { "Message has multiple tail fragments", "hci_usb.msg.fragment.multiple_tails",
+            FT_BOOLEAN, BASE_NONE, NULL, 0x00,
+            NULL, HFILL }
+        },
+        {  &hf_msg_fragment_too_long_fragment,
+            { "Message fragment too long",       "hci_usb.msg.fragment.too_long_fragment",
+            FT_BOOLEAN, BASE_NONE, NULL, 0x00,
+            NULL, HFILL }
+        },
+        {  &hf_msg_fragment_error,
+            { "Message defragmentation error",   "hci_usb.msg.fragment.error",
+            FT_FRAMENUM, BASE_NONE, NULL, 0x00,
+            NULL, HFILL }
+        },
+        {  &hf_msg_fragment_count,
+            { "Message fragment count",          "hci_usb.msg.fragment.count",
+            FT_UINT32, BASE_DEC, NULL, 0x00,
+            NULL, HFILL }
+        },
+        {  &hf_msg_reassembled_in,
+            { "Reassembled in",                  "hci_usb.msg.reassembled.in",
+            FT_FRAMENUM, BASE_NONE, NULL, 0x00,
+            NULL, HFILL }
+        },
+        {  &hf_msg_reassembled_length,
+            { "Reassembled MP2T length",         "hci_usb.msg.reassembled.length",
+            FT_UINT32, BASE_DEC, NULL, 0x00,
+            NULL, HFILL }
+        },
+        { &hf_bthci_usb_data,
+            { "Unknown Data",                    "hci_usb.data",
+            FT_NONE, BASE_NONE, NULL, 0x00,
+            NULL, HFILL }
+        }
+    };
+
+    static gint *ett[] = {
+        &ett_hci_usb,
+        &ett_hci_usb_msg_fragment,
+        &ett_hci_usb_msg_fragments,
+    };
+
+    fragment_table_init(&fragment_table);
+    reassembled_table_init(&reassembled_table);
+    fragment_info_table = se_tree_create(EMEM_TREE_TYPE_RED_BLACK, "hci_usb fragment_info");
+
+    chandle_to_bdaddr_table = se_tree_create(EMEM_TREE_TYPE_RED_BLACK, "hci_usb adapter/chandle to bdaddr");
+    bdaddr_to_name_table = se_tree_create(EMEM_TREE_TYPE_RED_BLACK, "hci_usb bdaddr to name");
+    localhost_bdaddr = se_tree_create(EMEM_TREE_TYPE_RED_BLACK, "hci_usb adaper/frame to bdaddr");
+    localhost_name = se_tree_create(EMEM_TREE_TYPE_RED_BLACK, "hci_usb adaper/frame to name");
+
+    proto_hci_usb = proto_register_protocol("Bluetooth HCI USB Transport", "HCI_USB", "hci_usb");
+    proto_register_field_array(proto_hci_usb, hf, array_length(hf));
+    proto_register_subtree_array(ett, array_length(ett));
+    new_register_dissector("hci_usb", dissect_hci_usb, proto_hci_usb);
+
+    module = prefs_register_protocol(proto_hci_usb, NULL);
+    prefs_register_static_text_preference(module, "bthci_usb.version",
+            "Bluetooth HCI USB Transport from Core 4.0",
+            "Version of protocol supported by this dissector.");
+}
+
+void
+proto_reg_handoff_hci_usb(void)
+{
+    dissector_handle_t hci_usb_handle;
+
+    hci_usb_handle = find_dissector("hci_usb");
+
+    dissector_add_uint("usb.product", (0x0a5c << 16) | 0x21e8, hci_usb_handle);
+    dissector_add_uint("usb.product", (0x1131 << 16) | 0x1001, hci_usb_handle);
+    dissector_add_uint("usb.product", (0x050d << 16) | 0x0081, hci_usb_handle);
+    dissector_add_uint("usb.product", (0x0a5c << 16) | 0x2198, hci_usb_handle);
+    dissector_add_uint("usb.product", (0x0a5c << 16) | 0x21e8, hci_usb_handle);
+    dissector_add_uint("usb.product", (0x04bf << 16) | 0x0320, hci_usb_handle);
+    dissector_add_uint("usb.product", (0x13d3 << 16) | 0x3375, hci_usb_handle);
+
+    dissector_add_uint("usb.protocol", 0xE00101, hci_usb_handle);
+
+    dissector_add_handle("usb.device", hci_usb_handle);
+}