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 */
96 struct usb_port {
97 struct usb_device *child;
98 struct device dev;
99 struct usb_dev_state *port_owner;
100 struct usb_port *peer;
101 struct dev_pm_qos_request *req;
102 enum usb_port_connect_type connect_type;
103 usb_port_location_t location;
104 struct mutex status_lock;
105 u8 portnum;
106 unsigned int is_superspeed: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
hub_is_port_power_switchable(struct usb_hub * hub)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
hub_is_superspeed(struct usb_device * hdev)134 static inline int hub_is_superspeed(struct usb_device *hdev)
135 {
136 return hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS;
137 }
138
hub_power_on_good_delay(struct usb_hub * hub)139 static inline unsigned hub_power_on_good_delay(struct usb_hub *hub)
140 {
141 unsigned delay = hub->descriptor->bPwrOn2PwrGood * 2;
142
143 if (!hub->hdev->parent) /* root hub */
144 return delay;
145 else /* Wait at least 100 msec for power to become stable */
146 return max(delay, 100U);
147 }
148
hub_port_debounce_be_connected(struct usb_hub * hub,int port1)149 static inline int hub_port_debounce_be_connected(struct usb_hub *hub,
150 int port1)
151 {
152 return hub_port_debounce(hub, port1, true);
153 }
154
hub_port_debounce_be_stable(struct usb_hub * hub,int port1)155 static inline int hub_port_debounce_be_stable(struct usb_hub *hub,
156 int port1)
157 {
158 return hub_port_debounce(hub, port1, false);
159 }
160
161