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