/* packet-usb-hub.c

 * Routines for USB HUB dissection

 * Copyright 2009, Marton Nemeth <nm127@freemail.hu>

 *

 * USB HUB Specification can be found in the Universal Serial Bus

 * Specification 2.0, Chapter 11 Hub Specification.

 * http://www.usb.org/developers/docs/usb_20_052709.zip

 *

 * 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 "packet-usb.h"

void proto_register_usb_hub(void);

void proto_reg_handoff_usb_hub(void);

static dissector_handle_t usb_hub_control_handle;

/* protocols and header fields */

static int proto_usb_hub;

/* USB 2.0, Chapter 11.24.2 Class-Specific Requests */

static int hf_usb_hub_request;

static int hf_usb_hub_value;

static int hf_usb_hub_index;

static int hf_usb_hub_length;

static int hf_usb_hub_hub_feature_selector;

static int hf_usb_hub_port_feature_selector;

static int hf_usb_hub_dev_addr;

static int hf_usb_hub_ep_num;

static int hf_usb_hub_descriptor_type;

static int hf_usb_hub_descriptor_index;

static int hf_usb_hub_zero;

static int hf_usb_hub_tt_flags;

static int hf_usb_hub_tt_port;

static int hf_usb_hub_tt_state_length;

static int hf_usb_hub_port;

static int hf_usb_hub_port_selector;

static int hf_usb_hub_port_status;

static int hf_usb_hub_port_change;

static int hf_usb_hub_port_status_connection;

static int hf_usb_hub_port_status_enable;

static int hf_usb_hub_port_status_suspend;

static int hf_usb_hub_port_status_overcurrent;

static int hf_usb_hub_port_status_reset;

static int hf_usb_hub_port_status_power;

static int hf_usb_hub_port_status_low_speed;

static int hf_usb_hub_port_status_high_speed;

static int hf_usb_hub_port_status_test;

static int hf_usb_hub_port_status_indicator;

static int hf_usb_hub_port_change_connection;

static int hf_usb_hub_port_change_enable;

static int hf_usb_hub_port_change_suspend;

static int hf_usb_hub_port_change_overcurrent;

static int hf_usb_hub_port_change_reset;

static int hf_usb_hub_descriptor_length;

static int ett_usb_hub_wValue;

static int ett_usb_hub_wIndex;

static int ett_usb_hub_wLength;

static int ett_usb_hub_port_status;

static int ett_usb_hub_port_change;

/* Table 11-16. Hub Class Request Codes */

#define USB_HUB_REQUEST_GET_STATUS            0

#define USB_HUB_REQUEST_CLEAR_FEATURE         1

#define USB_HUB_REQUEST_SET_FEATURE           3

#define USB_HUB_REQUEST_GET_DESCRIPTOR        6

#define USB_HUB_REQUEST_SET_DESCRIPTOR        7

#define USB_HUB_REQUEST_CLEAR_TT_BUFFER       8

#define USB_HUB_REQUEST_RESET_TT              9

#define USB_HUB_REQUEST_GET_TT_STATE         10

#define USB_HUB_REQUEST_STOP_TT              11

static const value_string setup_request_names_vals[] = {

  { USB_HUB_REQUEST_GET_STATUS,    "GET_STATUS" },

  { USB_HUB_REQUEST_CLEAR_FEATURE,   "CLEAR_FEATURE" },

  { USB_HUB_REQUEST_SET_FEATURE,     "SET_FEATURE" },

  { USB_HUB_REQUEST_GET_DESCRIPTOR,  "GET_DESCRIPTOR" },

  { USB_HUB_REQUEST_SET_DESCRIPTOR,  "SET_DESCRIPTOR" },

  { USB_HUB_REQUEST_CLEAR_TT_BUFFER, "CLEAR_TT_BUFFER" },

  { USB_HUB_REQUEST_GET_TT_STATE,    "GET_TT_STATE" },

  { USB_HUB_REQUEST_STOP_TT,     "STOP_TT" },

  { 0, NULL }

};

/* Table 11-17 Hub Class Feature Selectors */

#define USB_HUB_FEATURE_C_HUB_LOCAL_POWER      0

#define USB_HUB_FEATURE_C_HUB_OVER_CURRENT     1

#define USB_HUB_FEATURE_PORT_CONNECTION        0

#define USB_HUB_FEATURE_PORT_ENABLE            1

#define USB_HUB_FEATURE_PORT_SUSPEND           2

#define USB_HUB_FEATURE_PORT_OVER_CURRENT      3

#define USB_HUB_FEATURE_PORT_RESET             4

#define USB_HUB_FEATURE_PORT_POWER             8

#define USB_HUB_FEATURE_PORT_LOW_SPEED         9

#define USB_HUB_FEATURE_C_PORT_CONNECTION     16

#define USB_HUB_FEATURE_C_PORT_ENABLE         17

#define USB_HUB_FEATURE_C_PORT_SUSPEND        18

#define USB_HUB_FEATURE_C_PORT_OVER_CURRENT   19

#define USB_HUB_FEATURE_C_PORT_RESET          20

#define USB_HUB_FEATURE_PORT_TEST             21

#define USB_HUB_FEATURE_PORT_INDICATOR        22

/* Table 10-9 Hub Class Feature Selectors (USB3) */

#define USB_HUB_FEATURE_PORT_U1_TIMEOUT       23

#define USB_HUB_FEATURE_PORT_U2_TIMEOUT       24

#define USB_HUB_FEATURE_C_PORT_LINK_STATE     25

#define USB_HUB_FEATURE_C_PORT_CONFIG_ERROR   26

#define USB_HUB_FEATURE_PORT_REMOTE_WAKE_MASK 27

#define USB_HUB_FEATURE_BH_PORT_RESET         28

#define USB_HUB_FEATURE_C_BH_PORT_RESET       29

#define USB_HUB_FEATURE_FORCE_LINKPM_ACCEPT   30

static const value_string hub_class_feature_selectors_recipient_hub_vals[] = {

  { USB_HUB_FEATURE_C_HUB_LOCAL_POWER,  "C_HUB_LOCAL_POWER" },

  { USB_HUB_FEATURE_C_HUB_OVER_CURRENT, "C_HUB_OVER_CURRENT" },

  { 0, NULL }

};

static const value_string hub_class_feature_selectors_recipient_port_vals[] = {

  { USB_HUB_FEATURE_PORT_CONNECTION,      "PORT_CONNECTION" },

  { USB_HUB_FEATURE_PORT_ENABLE,          "PORT_ENABLE" },

  { USB_HUB_FEATURE_PORT_SUSPEND,         "PORT_SUSPEND" },

  { USB_HUB_FEATURE_PORT_OVER_CURRENT,    "PORT_OVER_CURRENT" },

  { USB_HUB_FEATURE_PORT_RESET,           "PORT_RESET" },

  { USB_HUB_FEATURE_PORT_POWER,           "PORT_POWER" },

  { USB_HUB_FEATURE_PORT_LOW_SPEED,       "PORT_LOW_SPEED" },

  { USB_HUB_FEATURE_C_PORT_CONNECTION,    "C_PORT_CONNECTION" },

  { USB_HUB_FEATURE_C_PORT_ENABLE,        "C_PORT_ENABLE" },

  { USB_HUB_FEATURE_C_PORT_SUSPEND,       "C_PORT_SUSPEND" },

  { USB_HUB_FEATURE_C_PORT_OVER_CURRENT,  "C_PORT_OVER_CURRENT" },

  { USB_HUB_FEATURE_C_PORT_RESET,         "C_PORT_RESET" },

  { USB_HUB_FEATURE_PORT_TEST,            "PORT_TEST" },

  { USB_HUB_FEATURE_PORT_INDICATOR,       "PORT_INDICATOR" },

  { USB_HUB_FEATURE_PORT_U1_TIMEOUT,      "PORT_U1_TIMEOUT" },

  { USB_HUB_FEATURE_PORT_U2_TIMEOUT,      "PORT_U2_TIMEOUT" },

  { USB_HUB_FEATURE_C_PORT_LINK_STATE,    "C_PORT_LINK_STATE" },

  { USB_HUB_FEATURE_C_PORT_CONFIG_ERROR,  "C_PORT_CONFIG_ERROR" },

  { USB_HUB_FEATURE_PORT_REMOTE_WAKE_MASK,"PORT_REMOTE_WAKE_MASK" },

  { USB_HUB_FEATURE_BH_PORT_RESET,        "BH_PORT_RESET" },

  { USB_HUB_FEATURE_C_BH_PORT_RESET,      "C_BH_PORT_RESET" },

  { USB_HUB_FEATURE_FORCE_LINKPM_ACCEPT,  "FORCE_LINKPM_ACCEPT" },

  { 0, NULL }

};

static const true_false_string hub_port_status_indicator_meaning = {

  "Software-controlled color",

  "Default colors"

};

/* Dissector for ClearHubFeature, Chapter 11.24.2.1 Clear Hub Feature */

static void

dissect_usb_hub_clear_hub_feature(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info _U_, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  const char* feature_name;

  feature_name = val_to_str(pinfo->pool, usb_trans_info->setup.wValue,

                hub_class_feature_selectors_recipient_hub_vals,

                "UNKNOWN (0x%x)");

  col_append_fstr(pinfo->cinfo, COL_INFO, " [Hub: %s]", feature_name);

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_hub_feature_selector, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wLength);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  } else {

  }

}

/* Dissector for ClearPortFeature, Chapter 11.24.2.2 Clear Port Feature */

static void

dissect_usb_hub_clear_port_feature(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info _U_, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  const char* feature_name;

  feature_name = val_to_str(pinfo->pool, usb_trans_info->setup.wValue,

                hub_class_feature_selectors_recipient_port_vals,

                "UNKNOWN (0x%x)");

  col_append_fstr(pinfo->cinfo, COL_INFO, " [Port %u: %s]", usb_trans_info->setup.wIndex, feature_name);

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_port_feature_selector, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_port, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset++;

    proto_tree_add_item(subtree, hf_usb_hub_port_selector, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset++;

    item = proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wLength);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  } else {

  }

}

/* Dissector for ClearTTBuffer, Chapter 11.24.2.3 Clear TT Buffer */

static void

dissect_usb_hub_clear_tt_buffer(packet_info *pinfo _U_, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info _U_, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_ep_num, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset++;

    proto_tree_add_item(subtree, hf_usb_hub_dev_addr, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset++;

    proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_tt_port, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wLength);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  } else {

  }

}

/* Dissector for GetHubDescriptor, Chapter 11.24.2.5 Get Hub Descriptor */

static void

dissect_usb_hub_get_hub_descriptor(packet_info *pinfo _U_, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info _U_, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_descriptor_index, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset++;

    proto_tree_add_item(subtree, hf_usb_hub_descriptor_type, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset++;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wLength);

    proto_tree_add_item(subtree, hf_usb_hub_descriptor_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  } else {

  }

}

/* Dissector for GetHubStatus, Chapter 11.24.2.6 Get Hub Status */

static void

dissect_usb_hub_get_hub_status(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info _U_, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  col_append_str(pinfo->cinfo, COL_INFO, "    [Hub]");

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    /* length shall always contain 4 */

    /*offset += 2;*/

  } else {

  }

}

/* Dissector for GetPortStatus, Chapter 11.24.2.7 Get Port Status */

static void

dissect_usb_hub_get_port_status(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  col_append_fstr(pinfo->cinfo, COL_INFO, "    [Port %u]", usb_trans_info->setup.wIndex);

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_port, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    /* length shall always contain 4 */

    /*offset += 2;*/

  } else {

    static int * const status_fields[] = {

      &hf_usb_hub_port_status_connection,

      &hf_usb_hub_port_status_enable,

      &hf_usb_hub_port_status_suspend,

      &hf_usb_hub_port_status_overcurrent,

      &hf_usb_hub_port_status_reset,

      &hf_usb_hub_port_status_power,

      &hf_usb_hub_port_status_low_speed,

      &hf_usb_hub_port_status_high_speed,

      &hf_usb_hub_port_status_test,

      &hf_usb_hub_port_status_indicator,

      NULL

    };

    static int * const change_fields[] = {

      &hf_usb_hub_port_change_connection,

      &hf_usb_hub_port_change_enable,

      &hf_usb_hub_port_change_suspend,

      &hf_usb_hub_port_change_overcurrent,

      &hf_usb_hub_port_change_reset,

      NULL

    };

    proto_tree_add_bitmask(tree, tvb, offset, hf_usb_hub_port_status,

                           ett_usb_hub_port_status, status_fields, ENC_LITTLE_ENDIAN);

    offset += 2;

    proto_tree_add_bitmask(tree, tvb, offset, hf_usb_hub_port_change,

                           ett_usb_hub_port_change, change_fields, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  }

}

/* Dissector for GetTTState, Chapter 11.24.2.8 Get_TT_State */

static void

dissect_usb_hub_get_tt_state(packet_info *pinfo _U_, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info _U_, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_tt_flags, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_tt_port, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wLength);

    proto_tree_add_item(subtree, hf_usb_hub_tt_state_length, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  } else {

  }

}

/* Dissector for ResetTT, Chapter 11.24.2.9 Reset_TT */

static void

dissect_usb_hub_reset_tt(packet_info *pinfo _U_, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info _U_, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_tt_port, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wLength);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  } else {

  }

}

/* Dissector for SetHubDescriptor, Chapter 11.24.2.10 Set Hub Descriptor */

static void

dissect_usb_hub_set_hub_descriptor(packet_info *pinfo _U_, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info _U_, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_descriptor_index, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset++;

    proto_tree_add_item(subtree, hf_usb_hub_descriptor_type, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset++;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wLength);

    proto_tree_add_item(subtree, hf_usb_hub_descriptor_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  } else {

  }

}

/* Dissector for StopTT, Chapter 11.24.2.11 Stop TT */

static void

dissect_usb_hub_stop_tt(packet_info *pinfo _U_, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info _U_, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_tt_port, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wLength);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  } else {

  }

}

/* Dissector for SetHubFeature, Chapter 11.24.2.12 Set Hub Feature */

static void

dissect_usb_hub_set_hub_feature(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  const char* feature_name;

  feature_name = val_to_str(pinfo->pool, usb_trans_info->setup.wValue,

                hub_class_feature_selectors_recipient_hub_vals,

                "UNKNOWN (0x%x)");

  col_append_fstr(pinfo->cinfo, COL_INFO, "   [Hub: %s]", feature_name);

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_hub_feature_selector, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wIndex);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wLength);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  } else {

  }

}

/* Dissector for SetPortFeature, Chapter 11.24.2.13 Set Port Feature */

static void

dissect_usb_hub_set_port_feature(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info, urb_info_t *urb _U_)

{

  proto_item *item = NULL;

  proto_tree *subtree = NULL;

  const char* feature_name;

  feature_name = val_to_str(pinfo->pool, usb_trans_info->setup.wValue,

                hub_class_feature_selectors_recipient_port_vals,

                "UNKNOWN (0x%x)");

  col_append_fstr(pinfo->cinfo, COL_INFO, "   [Port %u: %s]", usb_trans_info->setup.wIndex,

          feature_name);

  if (is_request) {

    item = proto_tree_add_item(tree, hf_usb_hub_value, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_port_feature_selector, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    offset += 2;

    item = proto_tree_add_item(tree, hf_usb_hub_index, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wValue);

    proto_tree_add_item(subtree, hf_usb_hub_port, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset++;

    proto_tree_add_item(subtree, hf_usb_hub_port_selector, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset++;

    item = proto_tree_add_item(tree, hf_usb_hub_length, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    subtree = proto_item_add_subtree(item, ett_usb_hub_wLength);

    proto_tree_add_item(subtree, hf_usb_hub_zero, tvb, offset, 2, ENC_LITTLE_ENDIAN);

    /*offset += 2;*/

  } else {

  }

}

typedef void (*usb_setup_dissector)(packet_info *pinfo, proto_tree *tree, tvbuff_t *tvb, int offset, bool is_request, usb_trans_info_t *usb_trans_info, urb_info_t *urb);

typedef struct _usb_setup_dissector_table_t {

  uint8_t request_type;

  uint8_t request;

  usb_setup_dissector dissector;

} usb_setup_dissector_table_t;

/* USB 2.0, Table 11-15 Hub Class Requests */

static const usb_setup_dissector_table_t setup_dissectors[] = {

  { USB_DIR_OUT | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_DEVICE,

    USB_HUB_REQUEST_CLEAR_FEATURE,

    dissect_usb_hub_clear_hub_feature

  },

  { USB_DIR_OUT | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_OTHER,

    USB_HUB_REQUEST_CLEAR_FEATURE,

    dissect_usb_hub_clear_port_feature

  },

  { USB_DIR_OUT | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_OTHER,

    USB_HUB_REQUEST_CLEAR_TT_BUFFER,

    dissect_usb_hub_clear_tt_buffer

  },

  { USB_DIR_IN | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_DEVICE,

    USB_HUB_REQUEST_GET_DESCRIPTOR,

    dissect_usb_hub_get_hub_descriptor

  },

  { USB_DIR_IN | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_DEVICE,

    USB_HUB_REQUEST_GET_STATUS,

    dissect_usb_hub_get_hub_status

  },

  { USB_DIR_IN | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_OTHER,

    USB_HUB_REQUEST_GET_STATUS,

    dissect_usb_hub_get_port_status

  },

  { USB_DIR_OUT | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_OTHER,

    USB_HUB_REQUEST_RESET_TT,

    dissect_usb_hub_reset_tt

  },

  { USB_DIR_OUT | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_DEVICE,

    USB_HUB_REQUEST_SET_DESCRIPTOR,

    dissect_usb_hub_set_hub_descriptor

  },

  { USB_DIR_OUT | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_DEVICE,

    USB_HUB_REQUEST_SET_FEATURE,

    dissect_usb_hub_set_hub_feature

  },

  { USB_DIR_OUT | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_OTHER,

    USB_HUB_REQUEST_SET_FEATURE,

    dissect_usb_hub_set_port_feature

  },

  { USB_DIR_IN | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_OTHER,

    USB_HUB_REQUEST_GET_TT_STATE,

    dissect_usb_hub_get_tt_state

  },

  { USB_DIR_OUT | (RQT_SETUP_TYPE_CLASS << 5) | RQT_SETUP_RECIPIENT_OTHER,

    USB_HUB_REQUEST_STOP_TT,

    dissect_usb_hub_stop_tt

  },

  { 0, 0, NULL }

};

/* Dissector for USB HUB class-specific control request as defined in

 * USB 2.0, Chapter 11.24.2 Class-specific Requests

 * Returns tvb_captured_length(tvb) if a class specific dissector was found

 * and 0 otherwise.

 */

static int

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

{

  bool is_request;

  urb_info_t *urb;

  usb_trans_info_t *usb_trans_info;

  int offset = 0;

  usb_setup_dissector dissector;

  const usb_setup_dissector_table_t *tmp;

  /* Reject the packet if data or usb_trans_info are NULL */

  if (data == NULL || ((urb_info_t *)data)->usb_trans_info == NULL)

    return 0;

  urb = (urb_info_t *)data;

  usb_trans_info = urb->usb_trans_info;

  is_request = (pinfo->srcport==NO_ENDPOINT);

  /* See if we can find a class specific dissector for this request */

  dissector = NULL;

  /* Check valid values for bmRequestType and bRequest */

  for (tmp = setup_dissectors; tmp->dissector; tmp++) {

    if (tmp->request_type == usb_trans_info->setup.requesttype &&

        tmp->request == usb_trans_info->setup.request) {

      dissector = tmp->dissector;

      break;

    }

  }

  /* No, we could not find any class specific dissector for this request

   * return 0 and let USB try any of the standard requests.

   */

  if (!dissector) {

    return 0;

  }

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

  col_add_fstr(pinfo->cinfo, COL_INFO, "%s %s",

  val_to_str(pinfo->pool, usb_trans_info->setup.request, setup_request_names_vals, "Unknown type %x"),

    is_request ? "Request " : "Response");

  if (is_request) {

    proto_tree_add_item(tree, hf_usb_hub_request, tvb, offset, 1, ENC_LITTLE_ENDIAN);

    offset += 1;

  }

  dissector(pinfo, tree, tvb, offset, is_request, usb_trans_info, urb);

  return tvb_captured_length(tvb);

}

void

proto_register_usb_hub(void)

{

  static hf_register_info hf[] = {

    /* USB HUB specific requests */

    { &hf_usb_hub_request,

    { "bRequest", "usbhub.setup.bRequest", FT_UINT8, BASE_HEX, VALS(setup_request_names_vals), 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_value,

    { "wValue", "usbhub.setup.wValue", FT_UINT16, BASE_HEX, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_index,

    { "wIndex", "usbhub.setup.wIndex", FT_UINT16, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_length,

    { "wLength", "usbhub.setup.wLength", FT_UINT16, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_hub_feature_selector,

    { "HubFeatureSelector", "usbhub.setup.HubFeatureSelector", FT_UINT16, BASE_DEC,

      VALS(hub_class_feature_selectors_recipient_hub_vals), 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_port_feature_selector,

    { "PortFeatureSelector", "usbhub.setup.PortFeatureSelector", FT_UINT16, BASE_DEC,

      VALS(hub_class_feature_selectors_recipient_port_vals), 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_dev_addr,

    { "Dev_Addr", "usbhub.setup.Dev_Addr", FT_UINT8, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_ep_num,

    { "EP_Num", "usbhub.setup.EP_Num", FT_UINT8, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_descriptor_type,

    { "DescriptorType", "usbhub.setup.DescriptorType", FT_UINT8, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_descriptor_index,

    { "DescriptorIndex", "usbhub.setup.DescriptorIndex", FT_UINT8, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_descriptor_length,

    { "DescriptorLength", "usbhub.setup.DescriptorLength", FT_UINT16, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_zero,

    { "(zero)", "usbhub.setup.zero", FT_UINT16, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_tt_flags,

    { "TT_Flags", "usbhub.setup.TT_Flags", FT_UINT8, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_tt_port,

    { "TT_Port", "usbhub.setup.TT_Port", FT_UINT16, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_tt_state_length,

    { "TT State Length", "usbhub.setup.TT_StateLength", FT_UINT16, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_port_selector,

    { "PortSelector", "usbhub.setup.PortSelector", FT_UINT8, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_port,

    { "Port", "usbhub.setup.Port", FT_UINT16, BASE_DEC, NULL, 0x0,

      NULL, HFILL }},

    { &hf_usb_hub_port_status,

    { "Port Status", "usbhub.status.port", FT_UINT16, BASE_HEX, NULL, 0,

      NULL, HFILL }},

    { &hf_usb_hub_port_change,

    { "Port Change", "usbhub.change.port", FT_UINT16, BASE_HEX, NULL, 0,

      NULL, HFILL }},

    { &hf_usb_hub_port_status_connection,

    { "PORT_CONNECTION", "usbhub.status.port.connection", FT_BOOLEAN, 16, NULL, (1<<0),

      NULL, HFILL }},

    { &hf_usb_hub_port_status_enable,

    { "PORT_ENABLE", "usbhub.status.port.enable", FT_BOOLEAN, 16, NULL, (1<<1),

      NULL, HFILL }},

    { &hf_usb_hub_port_status_suspend,

    { "PORT_SUSPEND", "usbhub.status.port.suspend", FT_BOOLEAN, 16, NULL, (1<<2),

      NULL, HFILL }},

    { &hf_usb_hub_port_status_overcurrent,

    { "PORT_OVER_CURRENT", "usbhub.status.port.overcurrent", FT_BOOLEAN, 16, NULL, (1<<3),

      NULL, HFILL }},

    { &hf_usb_hub_port_status_reset,

    { "PORT_RESET", "usbhub.status.port.reset", FT_BOOLEAN, 16, NULL, (1<<4),

      NULL, HFILL }},

    { &hf_usb_hub_port_status_power,

    { "PORT_POWER", "usbhub.status.port.power", FT_BOOLEAN, 16, NULL, (1<<8),

      NULL, HFILL }},

    { &hf_usb_hub_port_status_low_speed,

    { "PORT_LOW_SPEED", "usbhub.status.port.low_speed", FT_BOOLEAN, 16, NULL, (1<<9),

      NULL, HFILL }},

    { &hf_usb_hub_port_status_high_speed,

    { "PORT_HIGH_SPEED", "usbhub.status.port.high_speed", FT_BOOLEAN, 16, NULL, (1<<10),

      NULL, HFILL }},

    { &hf_usb_hub_port_status_test,

    { "PORT_TEST", "usbhub.status.port.test", FT_BOOLEAN, 16, NULL, (1<<11),

      NULL, HFILL }},

    { &hf_usb_hub_port_status_indicator,

    { "PORT_INDICATOR", "usbhub.status.port.indicator", FT_BOOLEAN, 16,

      TFS(&hub_port_status_indicator_meaning), (1<<12),

      NULL, HFILL }},

    { &hf_usb_hub_port_change_connection,

    { "C_PORT_CONNECTION", "usbhub.change.port.connection", FT_BOOLEAN, 16, NULL, (1<<0),

      NULL, HFILL }},

    { &hf_usb_hub_port_change_enable,

    { "C_PORT_ENABLE", "usbhub.change.port.enable", FT_BOOLEAN, 16, NULL, (1<<1),

      NULL, HFILL }},

    { &hf_usb_hub_port_change_suspend,

    { "C_PORT_SUSPEND", "usbhub.status.port.suspend", FT_BOOLEAN, 16, NULL, (1<<2),

      NULL, HFILL }},

    { &hf_usb_hub_port_change_overcurrent,

    { "C_PORT_OVER_CURRENT", "usbhub.status.port.overcurrent", FT_BOOLEAN, 16, NULL, (1<<3),

      NULL, HFILL }},

    { &hf_usb_hub_port_change_reset,

    { "C_PORT_RESET", "usbhub.status.port.reset", FT_BOOLEAN, 16, NULL, (1<<4),

      NULL, HFILL }}

  };

  static int *usb_hub_ett[] = {

    &ett_usb_hub_wValue,

    &ett_usb_hub_wIndex,

    &ett_usb_hub_wLength,

    &ett_usb_hub_port_status,

    &ett_usb_hub_port_change

  };

  proto_usb_hub = proto_register_protocol("USB HUB", "USBHUB", "usbhub");

  proto_register_field_array(proto_usb_hub, hf, array_length(hf));

  proto_register_subtree_array(usb_hub_ett, array_length(usb_hub_ett));

  usb_hub_control_handle = register_dissector("usbhub", dissect_usb_hub_control, proto_usb_hub);

}

void

proto_reg_handoff_usb_hub(void)

{

  dissector_add_uint("usb.control", IF_CLASS_HUB, usb_hub_control_handle);

  dissector_add_uint("usb.control", IF_CLASS_UNKNOWN, usb_hub_control_handle);

}

/*

 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html

 *

 * Local variables:

 * c-basic-offset: 8

 * tab-width: 8

 * indent-tabs-mode: t

 * End:

 *

 * vi: set shiftwidth=8 tabstop=8 noexpandtab:

 * :indentSize=8:tabSize=8:noTabs=false:

 */