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