/* packet-hci_usb.c

 * Routines for Bluetooth HCI USB dissection

 *

 * Copyright 2012, Michal Labedzki for Tieto Corporation

 *

 * Wireshark - Network traffic analyzer

 * By Gerald Combs <gerald@wireshark.org>

 * Copyright 1998 Gerald Combs

 *

 * SPDX-License-Identifier: GPL-2.0-or-later

 */

#include "config.h"

#include <epan/packet.h>

#include <epan/prefs.h>

#include <epan/reassemble.h>

#include "packet-bluetooth.h"

#include "packet-usb.h"

static int proto_hci_usb;

static int hf_bthci_usb_data;

static int hf_bthci_usb_packet_fragment;

static int hf_bthci_usb_packet_complete;

static int hf_bthci_usb_packet_unknown_fragment;

static int hf_bthci_usb_setup_request;

static int hf_bthci_usb_setup_value;

static int hf_bthci_usb_setup_adapter_id;

static int hf_bthci_usb_setup_length;

static int ett_hci_usb;

static int ett_hci_usb_msg_fragment;

static int ett_hci_usb_msg_fragments;

static int hf_msg_fragments;

static int hf_msg_fragment;

static int hf_msg_fragment_overlap;

static int hf_msg_fragment_overlap_conflicts;

static int hf_msg_fragment_multiple_tails;

static int hf_msg_fragment_too_long_fragment;

static int hf_msg_fragment_error;

static int hf_msg_fragment_count;

static int hf_msg_reassembled_in;

static int hf_msg_reassembled_length;

static wmem_tree_t *fragment_info_table;

static reassembly_table hci_usb_reassembly_table;

static dissector_handle_t hci_usb_handle;

static dissector_handle_t bthci_cmd_handle;

static dissector_handle_t bthci_evt_handle;

static dissector_handle_t bthci_acl_handle;

static dissector_handle_t bthci_sco_handle;

typedef struct _fragment_info_t {

    int remaining_length;

    int 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 const value_string request_vals[] = {

    { 0x00,  "Primary Controller Function" },

    { 0x2B,  "AMP Controller Function" },

    { 0xE0,  "Primary Controller Function (Historical)" },

    { 0x00, NULL }

};

static value_string_ext(request_vals_ext) = VALUE_STRING_EXT_INIT(request_vals);

void proto_register_hci_usb(void);

void proto_reg_handoff_hci_usb(void);

static int

dissect_hci_usb(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data)

{

    proto_item        *ttree = NULL;

    proto_tree        *titem = NULL;

    proto_item        *pitem = NULL;

    int                offset = 0;

    urb_info_t        *urb;

    tvbuff_t          *next_tvb = NULL;

    bluetooth_data_t  *bluetooth_data;

    int                p2p_dir_save;

    uint32_t           session_id;

    fragment_head     *reassembled;

    bluetooth_data = (bluetooth_data_t *) data;

    /* Reject the packet if data is NULL */

    if (data == NULL)

        return 0;

    DISSECTOR_ASSERT(bluetooth_data->previous_protocol_data_type == BT_PD_URB_INFO);

    urb = bluetooth_data->previous_protocol_data.urb;

    titem = proto_tree_add_item(tree, proto_hci_usb, tvb, offset, -1, ENC_NA);

    ttree = proto_item_add_subtree(titem, ett_hci_usb);

    col_set_str(pinfo->cinfo, COL_PROTOCOL, "HCI_USB");

    p2p_dir_save = pinfo->p2p_dir;

    pinfo->p2p_dir = (urb->is_request) ? P2P_DIR_SENT : P2P_DIR_RECV;

    switch (pinfo->p2p_dir) {

    case P2P_DIR_SENT:

        col_set_str(pinfo->cinfo, COL_INFO, "Sent");

        break;

    case P2P_DIR_RECV:

        col_set_str(pinfo->cinfo, COL_INFO, "Rcvd");

        break;

    default:

        col_set_str(pinfo->cinfo, COL_INFO, "UnknownDirection");

        break;

    }

    if (urb->is_setup) {

        proto_tree_add_item(ttree, hf_bthci_usb_setup_request, tvb, offset, 1, ENC_LITTLE_ENDIAN);

        offset += 1;

        proto_tree_add_item(ttree, hf_bthci_usb_setup_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

        offset += 2;

        proto_tree_add_item(ttree, hf_bthci_usb_setup_adapter_id, tvb, offset, 2, ENC_LITTLE_ENDIAN);

        offset += 2;

        proto_tree_add_item(ttree, hf_bthci_usb_setup_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

        offset += 2;

    }

    session_id = urb->bus_id << 16 | urb->device_address << 8 | ((pinfo->p2p_dir == P2P_DIR_RECV) ? 1 : 0 ) << 7 | urb->endpoint;

    bluetooth_data->adapter_id = urb->bus_id << 8 | urb->device_address;

/* TODO: adapter disconnect on some USB action, for now do not support adapter disconnection */

    bluetooth_data->adapter_disconnect_in_frame = &bluetooth_max_disconnect_in_frame;

    next_tvb = tvb_new_subset_remaining(tvb, offset);

    if (!pinfo->fd->visited && urb->transfer_type != URB_ISOCHRONOUS &&

            tvb_captured_length(tvb) == tvb_reported_length(tvb)) {

        fragment_info_t  *fragment_info;

        fragment_info = (fragment_info_t *) wmem_tree_lookup32(fragment_info_table, session_id);

        if (fragment_info == NULL) {

            fragment_info = (fragment_info_t *) wmem_new(wmem_file_scope(), fragment_info_t);

            fragment_info->fragment_id = 0;

            fragment_info->remaining_length = 0;

            wmem_tree_insert32(fragment_info_table, session_id, fragment_info);

        }

        if (fragment_info->fragment_id == 0) {

            switch(urb->transfer_type)

            {

            case URB_CONTROL:

                fragment_info->remaining_length = tvb_get_uint8(tvb, offset + 2) + 3;

                break;

            case URB_INTERRUPT:

                fragment_info->remaining_length = tvb_get_uint8(tvb, offset + 1) + 2;

                break;

            case URB_BULK:

                fragment_info->remaining_length = tvb_get_letohs(tvb, offset + 2) + 4;

                break;

            }

        }

        fragment_info->remaining_length -= tvb_reported_length_remaining(tvb, offset);

        fragment_add_seq_check(&hci_usb_reassembly_table,

                               tvb, offset, pinfo, session_id, NULL,

                               fragment_info->fragment_id, tvb_reported_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(&hci_usb_reassembly_table, pinfo, session_id);

    if (reassembled && pinfo->num < reassembled->reassembled_in) {

        pitem = proto_tree_add_item(ttree, hf_bthci_usb_packet_fragment, tvb, offset, -1, ENC_NA);

        proto_item_set_generated(pitem);

        col_append_str(pinfo->cinfo, COL_INFO, " Fragment");

    } else if (reassembled && pinfo->num == reassembled->reassembled_in) {

        pitem = proto_tree_add_item(ttree, hf_bthci_usb_packet_complete, tvb, offset, -1, ENC_NA);

        proto_item_set_generated(pitem);

        if (reassembled->len > (unsigned) tvb_reported_length_remaining(tvb, offset)) {

            next_tvb = process_reassembled_data(tvb, 0, pinfo,

                    "Reassembled HCI_USB",

                    reassembled, &hci_usb_msg_frag_items,

                    NULL, ttree);

        }

        switch(urb->transfer_type)

        {

        case URB_CONTROL:

            call_dissector_with_data(bthci_cmd_handle, next_tvb, pinfo, tree, bluetooth_data);

            break;

        case URB_INTERRUPT:

            call_dissector_with_data(bthci_evt_handle, next_tvb, pinfo, tree, bluetooth_data);

            break;

        case URB_BULK:

            call_dissector_with_data(bthci_acl_handle, next_tvb, pinfo, tree, bluetooth_data);

            break;

        }

    } else {

        pitem = proto_tree_add_item(ttree, hf_bthci_usb_packet_unknown_fragment, tvb, offset, -1, ENC_NA);

        proto_item_set_generated(pitem);

    }

    if (urb->transfer_type == URB_ISOCHRONOUS) {

        call_dissector_with_data(bthci_sco_handle, next_tvb, pinfo, tree, bluetooth_data);

    } else if (urb->transfer_type == URB_UNKNOWN) {

        proto_tree_add_item(ttree, hf_bthci_usb_data, tvb, offset, -1, ENC_NA);

    }

    offset += tvb_reported_length_remaining(tvb, offset);

    pinfo->p2p_dir = p2p_dir_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_packet_fragment,

            { "Packet Fragment",                 "hci_usb.packet.fragment",

            FT_NONE, BASE_NONE, NULL, 0x00,

            NULL, HFILL }

        },

        { &hf_bthci_usb_packet_complete,

            { "Packet Complete",                 "hci_usb.packet.complete",

            FT_NONE, BASE_NONE, NULL, 0x00,

            NULL, HFILL }

        },

        { &hf_bthci_usb_packet_unknown_fragment,

            { "Unknown Packet Fragment",         "hci_usb.packet.unknown_fragment",

            FT_NONE, BASE_NONE, NULL, 0x00,

            NULL, HFILL }

        },

        { &hf_bthci_usb_setup_request,

          { "bRequest",                          "hci_usb.setup.bRequest",

            FT_UINT8, BASE_DEC | BASE_EXT_STRING, &request_vals_ext, 0x0,

            NULL, HFILL }},

        { &hf_bthci_usb_setup_value,

          { "wValue",                            "hci_usb.setup.wValue",

            FT_UINT16, BASE_HEX, NULL, 0x0,

            NULL, HFILL }},

        { &hf_bthci_usb_setup_adapter_id,

          { "Adapter ID",                        "hci_usb.setup.adapter_id",

            FT_UINT16, BASE_DEC, NULL, 0x0,

            NULL, HFILL }},

        { &hf_bthci_usb_setup_length,

          { "wLength",                           "hci_usb.setup.wLength",

            FT_UINT16, BASE_DEC, NULL, 0x0,

            NULL, HFILL }},

        { &hf_bthci_usb_data,

            { "Unknown Data",                    "hci_usb.data",

            FT_NONE, BASE_NONE, NULL, 0x00,

            NULL, HFILL }

        }

    };

    static int *ett[] = {

        &ett_hci_usb,

        &ett_hci_usb_msg_fragment,

        &ett_hci_usb_msg_fragments,

    };

    reassembly_table_register(&hci_usb_reassembly_table,

                          &addresses_reassembly_table_functions);

    fragment_info_table = wmem_tree_new_autoreset(wmem_epan_scope(), wmem_file_scope());

    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));

    hci_usb_handle = register_dissector("hci_usb", dissect_hci_usb, proto_hci_usb);

    module = prefs_register_protocol_subtree("Bluetooth", 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)

{

    bthci_cmd_handle = find_dissector_add_dependency("bthci_cmd", proto_hci_usb);

    bthci_evt_handle = find_dissector_add_dependency("bthci_evt", proto_hci_usb);

    bthci_acl_handle = find_dissector_add_dependency("bthci_acl", proto_hci_usb);

    bthci_sco_handle = find_dissector_add_dependency("bthci_sco", proto_hci_usb);

}

/*

 * Editor modelines  -  https://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:

 */