Commit | Line | Data |
---|---|---|
6e30d7cb LT |
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 */ | |
bdb6bc06 | 34 | u8 (*buffer)[8]; |
6e30d7cb LT |
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 | struct list_head event_list; /* hubs w/data or errs ready */ | |
45 | unsigned long event_bits[1]; /* status change bitmask */ | |
46 | unsigned long change_bits[1]; /* ports with logical connect | |
47 | status change */ | |
6e30d7cb LT |
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 */ | |
d5c3834e DW |
52 | unsigned long power_bits[1]; /* ports that are powered */ |
53 | unsigned long child_usage_bits[1]; /* ports powered on for | |
54 | children */ | |
6e30d7cb LT |
55 | #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */ |
56 | #error event_bits[] is too short! | |
57 | #endif | |
58 | ||
59 | struct usb_hub_descriptor *descriptor; /* class descriptor */ | |
60 | struct usb_tt tt; /* Transaction Translator */ | |
61 | ||
62 | unsigned mA_per_port; /* current for each child */ | |
e583d9db AS |
63 | #ifdef CONFIG_PM |
64 | unsigned wakeup_enabled_descendants; | |
65 | #endif | |
6e30d7cb LT |
66 | |
67 | unsigned limited_power:1; | |
68 | unsigned quiescing:1; | |
69 | unsigned disconnected:1; | |
600856c2 | 70 | unsigned in_reset:1; |
6e30d7cb LT |
71 | |
72 | unsigned quirk_check_port_auto_suspend:1; | |
73 | ||
74 | unsigned has_indicators:1; | |
75 | u8 indicator[USB_MAXCHILDREN]; | |
76 | struct delayed_work leds; | |
77 | struct delayed_work init_work; | |
78 | struct usb_port **ports; | |
79 | }; | |
80 | ||
81 | /** | |
82 | * struct usb port - kernel's representation of a usb port | |
025d4430 | 83 | * @child: usb device attached to the port |
6e30d7cb LT |
84 | * @dev: generic device interface |
85 | * @port_owner: port's owner | |
d8521afe | 86 | * @peer: related usb2 and usb3 ports (share the same connector) |
e3d10505 | 87 | * @req: default pm qos request for hubs without port power control |
6e30d7cb | 88 | * @connect_type: port's connect type |
3bfd659b | 89 | * @location: opaque representation of platform connector location |
5c79a1e3 | 90 | * @status_lock: synchronize port_event() vs usb_port_{suspend|resume} |
971fcd49 | 91 | * @portnum: port index num based one |
7ad3c470 | 92 | * @is_superspeed cache super-speed status |
6e30d7cb LT |
93 | */ |
94 | struct usb_port { | |
95 | struct usb_device *child; | |
96 | struct device dev; | |
9b6f0c4b | 97 | struct usb_dev_state *port_owner; |
d8521afe | 98 | struct usb_port *peer; |
e3d10505 | 99 | struct dev_pm_qos_request *req; |
6e30d7cb | 100 | enum usb_port_connect_type connect_type; |
3bfd659b | 101 | usb_port_location_t location; |
5c79a1e3 | 102 | struct mutex status_lock; |
971fcd49 | 103 | u8 portnum; |
7ad3c470 | 104 | unsigned int is_superspeed:1; |
6e30d7cb LT |
105 | }; |
106 | ||
107 | #define to_usb_port(_dev) \ | |
108 | container_of(_dev, struct usb_port, dev) | |
109 | ||
110 | extern int usb_hub_create_port_device(struct usb_hub *hub, | |
111 | int port1); | |
112 | extern void usb_hub_remove_port_device(struct usb_hub *hub, | |
113 | int port1); | |
41341261 | 114 | extern int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub, |
971fcd49 | 115 | int port1, bool set); |
ad493e5e LT |
116 | extern struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev); |
117 | extern int hub_port_debounce(struct usb_hub *hub, int port1, | |
118 | bool must_be_connected); | |
119 | extern int usb_clear_port_feature(struct usb_device *hdev, | |
120 | int port1, int feature); | |
121 | ||
9262c19d DW |
122 | static inline bool hub_is_port_power_switchable(struct usb_hub *hub) |
123 | { | |
124 | __le16 hcs; | |
125 | ||
126 | if (!hub) | |
127 | return false; | |
128 | hcs = hub->descriptor->wHubCharacteristics; | |
129 | return (le16_to_cpu(hcs) & HUB_CHAR_LPSM) < HUB_CHAR_NO_LPSM; | |
130 | } | |
131 | ||
7ad3c470 DW |
132 | static inline int hub_is_superspeed(struct usb_device *hdev) |
133 | { | |
134 | return hdev->descriptor.bDeviceProtocol == USB_HUB_PR_SS; | |
135 | } | |
136 | ||
137 | static inline unsigned hub_power_on_good_delay(struct usb_hub *hub) | |
138 | { | |
139 | unsigned delay = hub->descriptor->bPwrOn2PwrGood * 2; | |
140 | ||
141 | /* Wait at least 100 msec for power to become stable */ | |
142 | return max(delay, 100U); | |
143 | } | |
144 | ||
ad493e5e LT |
145 | static inline int hub_port_debounce_be_connected(struct usb_hub *hub, |
146 | int port1) | |
147 | { | |
148 | return hub_port_debounce(hub, port1, true); | |
149 | } | |
150 | ||
151 | static inline int hub_port_debounce_be_stable(struct usb_hub *hub, | |
152 | int port1) | |
153 | { | |
154 | return hub_port_debounce(hub, port1, false); | |
155 | } | |
6e30d7cb | 156 |