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