drivers/usb/core/hub.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * usb hub driver head file
   4  *
   5  * Copyright (C) 1999 Linus Torvalds
   6  * Copyright (C) 1999 Johannes Erdfelt
   7  * Copyright (C) 1999 Gregory P. Smith
   8  * Copyright (C) 2001 Brad Hards (bhards@bigpond.net.au)
   9  * Copyright (C) 2012 Intel Corp (tianyu.lan@intel.com)
  10  *
  11  *  move struct usb_hub to this file.
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License version 2 as
  15  * published by the Free Software Foundation.
  16  *
  17  * This program is distributed in the hope that it will be useful, but
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  19  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20  * for more details.
  21  */
  22
  23 #include <linux/usb.h>
  24 #include <linux/usb/ch11.h>
  25 #include <linux/usb/hcd.h>
  26 #include "usb.h"
  27
  28 struct usb_hub {
  29         struct device           *intfdev;       /* the "interface" device */
  30         struct usb_device       *hdev;
  31         struct kref             kref;
  32         struct urb              *urb;           /* for interrupt polling pipe */
  33
  34         /* buffer for urb ... with extra space in case of babble */
  35         u8                      (*buffer)[8];
  36         union {
  37                 struct usb_hub_status   hub;
  38                 struct usb_port_status  port;
  39         }                       *status;        /* buffer for status reports */
  40         struct mutex            status_mutex;   /* for the status buffer */
  41
  42         int                     error;          /* last reported error */
  43         int                     nerrors;        /* track consecutive errors */
  44
  45         unsigned long           event_bits[1];  /* status change bitmask */
  46         unsigned long           change_bits[1]; /* ports with logical connect
  47                                                         status change */
  48         unsigned long           removed_bits[1]; /* ports with a "removed"
  49                                                         device present */
  50         unsigned long           wakeup_bits[1]; /* ports that have signaled
  51                                                         remote wakeup */
  52         unsigned long           power_bits[1]; /* ports that are powered */
  53         unsigned long           child_usage_bits[1]; /* ports powered on for
  54                                                         children */
  55         unsigned long           warm_reset_bits[1]; /* ports requesting warm
  56                                                         reset recovery */
  57 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
  58 #error event_bits[] is too short!
  59 #endif
  60
  61         struct usb_hub_descriptor *descriptor;  /* class descriptor */
  62         struct usb_tt           tt;             /* Transaction Translator */
  63
  64         unsigned                mA_per_port;    /* current for each child */
  65 #ifdef  CONFIG_PM
  66         unsigned                wakeup_enabled_descendants;
  67 #endif
  68
  69         unsigned                limited_power:1;
  70         unsigned                quiescing:1;
  71         unsigned                disconnected:1;
  72         unsigned                in_reset:1;
  73
  74         unsigned                quirk_check_port_auto_suspend:1;
  75
  76         unsigned                has_indicators:1;
  77         u8                      indicator[USB_MAXCHILDREN];
  78         struct delayed_work     leds;
  79         struct delayed_work     init_work;
  80         struct work_struct      events;
  81         struct usb_port         **ports;
  82 };
  83
  84 /**
  85  * struct usb port - kernel's representation of a usb port
  86  * @child: usb device attached to the port
  87  * @dev: generic device interface
  88  * @port_owner: port's owner
  89  * @peer: related usb2 and usb3 ports (share the same connector)
  90  * @req: default pm qos request for hubs without port power control
  91  * @connect_type: port's connect type
  92  * @location: opaque representation of platform connector location
  93  * @status_lock: synchronize port_event() vs usb_port_{suspend|resume}
  94  * @portnum: port index num based one
  95  * @is_superspeed cache super-speed status
  96  * @usb3_lpm_u1_permit: whether USB3 U1 LPM is permitted.
  97  * @usb3_lpm_u2_permit: whether USB3 U2 LPM is permitted.
  98  */
  99 struct usb_port {
 100         struct usb_device *child;
 101         struct device dev;
 102         struct usb_dev_state *port_owner;
 103         struct usb_port *peer;
 104         struct dev_pm_qos_request *req;
 105         enum usb_port_connect_type connect_type;
 106         usb_port_location_t location;
 107         struct mutex status_lock;
 108         u8 portnum;
 109         unsigned int is_superspeed:1;
 110         unsigned int usb3_lpm_u1_permit:1;
 111         unsigned int usb3_lpm_u2_permit:1;
 112 };
 113
 114 #define to_usb_port(_dev) \
 115         container_of(_dev, struct usb_port, dev)
 116
 117 extern int usb_hub_create_port_device(struct usb_hub *hub,
 118                 int port1);
 119 extern void usb_hub_remove_port_device(struct usb_hub *hub,
 120                 int port1);
 121 extern int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
 122                 int port1, bool set);
 123 extern struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev);
 124 extern int hub_port_debounce(struct usb_hub *hub, int port1,
 125                 bool must_be_connected);
 126 extern int usb_clear_port_feature(struct usb_device *hdev,
 127                 int port1, int feature);
 128
 129 static inline bool hub_is_port_power_switchable(struct usb_hub *hub)
 130 {
 131         __le16 hcs;
 132
 133         if (!hub)
 134                 return false;
 135         hcs = hub->descriptor->wHubCharacteristics;
 136         return (le16_to_cpu(hcs) & HUB_CHAR_LPSM) < HUB_CHAR_NO_LPSM;
 137 }
 138
 139 static inline int hub_is_superspeed(struct usb_device *hdev)
 140 {
 141         return hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS;
 142 }
 143
 144 static inline int hub_is_superspeedplus(struct usb_device *hdev)
 145 {
 146         return (hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS &&
 147                 le16_to_cpu(hdev->descriptor.bcdUSB) >= 0x0310 &&
 148                 hdev->bos->ssp_cap);
 149 }
 150
 151 static inline unsigned hub_power_on_good_delay(struct usb_hub *hub)
 152 {
 153         unsigned delay = hub->descriptor->bPwrOn2PwrGood * 2;
 154
 155         /* Wait at least 100 msec for power to become stable */
 156         return max(delay, 100U);
 157 }
 158
 159 static inline int hub_port_debounce_be_connected(struct usb_hub *hub,
 160                 int port1)
 161 {
 162         return hub_port_debounce(hub, port1, true);
 163 }
 164
 165 static inline int hub_port_debounce_be_stable(struct usb_hub *hub,
 166                 int port1)
 167 {
 168         return hub_port_debounce(hub, port1, false);
 169 }