4 * Copyright (C) 2012 Intel Corp
6 * Author: Lan Tianyu <tianyu.lan@intel.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
14 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19 #include <linux/slab.h>
20 #include <linux/pm_qos.h>
24 static int usb_port_block_power_off
;
26 static const struct attribute_group
*port_dev_group
[];
28 static ssize_t
connect_type_show(struct device
*dev
,
29 struct device_attribute
*attr
, char *buf
)
31 struct usb_port
*port_dev
= to_usb_port(dev
);
34 switch (port_dev
->connect_type
) {
35 case USB_PORT_CONNECT_TYPE_HOT_PLUG
:
38 case USB_PORT_CONNECT_TYPE_HARD_WIRED
:
41 case USB_PORT_NOT_USED
:
49 return sprintf(buf
, "%s\n", result
);
51 static DEVICE_ATTR_RO(connect_type
);
53 static struct attribute
*port_dev_attrs
[] = {
54 &dev_attr_connect_type
.attr
,
58 static struct attribute_group port_dev_attr_grp
= {
59 .attrs
= port_dev_attrs
,
62 static const struct attribute_group
*port_dev_group
[] = {
67 static void usb_port_device_release(struct device
*dev
)
69 struct usb_port
*port_dev
= to_usb_port(dev
);
76 static int usb_port_runtime_resume(struct device
*dev
)
78 struct usb_port
*port_dev
= to_usb_port(dev
);
79 struct usb_device
*hdev
= to_usb_device(dev
->parent
->parent
);
80 struct usb_interface
*intf
= to_usb_interface(dev
->parent
);
81 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
82 struct usb_device
*udev
= port_dev
->child
;
83 struct usb_port
*peer
= port_dev
->peer
;
84 int port1
= port_dev
->portnum
;
90 set_bit(port1
, hub
->power_bits
);
95 * Power on our usb3 peer before this usb2 port to prevent a usb3
96 * device from degrading to its usb2 connection
98 if (!port_dev
->is_superspeed
&& peer
)
99 pm_runtime_get_sync(&peer
->dev
);
101 usb_autopm_get_interface(intf
);
102 retval
= usb_hub_set_port_power(hdev
, hub
, port1
, true);
103 msleep(hub_power_on_good_delay(hub
));
104 if (udev
&& !retval
) {
106 * Our preference is to simply wait for the port to reconnect,
107 * as that is the lowest latency method to restart the port.
108 * However, there are cases where toggling port power results in
109 * the host port and the device port getting out of sync causing
110 * a link training live lock. Upon timeout, flag the port as
111 * needing warm reset recovery (to be performed later by
112 * usb_port_resume() as requested via usb_wakeup_notification())
114 if (hub_port_debounce_be_connected(hub
, port1
) < 0) {
115 dev_dbg(&port_dev
->dev
, "reconnect timeout\n");
116 if (hub_is_superspeed(hdev
))
117 set_bit(port1
, hub
->warm_reset_bits
);
120 /* Force the child awake to revalidate after the power loss. */
121 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
122 pm_runtime_get_noresume(&port_dev
->dev
);
123 pm_request_resume(&udev
->dev
);
127 usb_autopm_put_interface(intf
);
132 static int usb_port_runtime_suspend(struct device
*dev
)
134 struct usb_port
*port_dev
= to_usb_port(dev
);
135 struct usb_device
*hdev
= to_usb_device(dev
->parent
->parent
);
136 struct usb_interface
*intf
= to_usb_interface(dev
->parent
);
137 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
138 struct usb_port
*peer
= port_dev
->peer
;
139 int port1
= port_dev
->portnum
;
147 if (dev_pm_qos_flags(&port_dev
->dev
, PM_QOS_FLAG_NO_POWER_OFF
)
151 if (usb_port_block_power_off
)
154 usb_autopm_get_interface(intf
);
155 retval
= usb_hub_set_port_power(hdev
, hub
, port1
, false);
156 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
157 if (!port_dev
->is_superspeed
)
158 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
159 usb_autopm_put_interface(intf
);
162 * Our peer usb3 port may now be able to suspend, so
163 * asynchronously queue a suspend request to observe that this
164 * usb2 port is now off.
166 if (!port_dev
->is_superspeed
&& peer
)
167 pm_runtime_put(&peer
->dev
);
173 static const struct dev_pm_ops usb_port_pm_ops
= {
175 .runtime_suspend
= usb_port_runtime_suspend
,
176 .runtime_resume
= usb_port_runtime_resume
,
180 struct device_type usb_port_device_type
= {
182 .release
= usb_port_device_release
,
183 .pm
= &usb_port_pm_ops
,
186 static struct device_driver usb_port_driver
= {
188 .owner
= THIS_MODULE
,
191 static int link_peers(struct usb_port
*left
, struct usb_port
*right
)
193 struct usb_port
*ss_port
, *hs_port
;
196 if (left
->peer
== right
&& right
->peer
== left
)
199 if (left
->peer
|| right
->peer
) {
200 struct usb_port
*lpeer
= left
->peer
;
201 struct usb_port
*rpeer
= right
->peer
;
204 if (left
->location
&& left
->location
== right
->location
)
209 pr_debug("usb: failed to peer %s and %s by %s (%s:%s) (%s:%s)\n",
210 dev_name(&left
->dev
), dev_name(&right
->dev
), method
,
211 dev_name(&left
->dev
),
212 lpeer
? dev_name(&lpeer
->dev
) : "none",
213 dev_name(&right
->dev
),
214 rpeer
? dev_name(&rpeer
->dev
) : "none");
218 rc
= sysfs_create_link(&left
->dev
.kobj
, &right
->dev
.kobj
, "peer");
221 rc
= sysfs_create_link(&right
->dev
.kobj
, &left
->dev
.kobj
, "peer");
223 sysfs_remove_link(&left
->dev
.kobj
, "peer");
228 * We need to wake the HiSpeed port to make sure we don't race
229 * setting ->peer with usb_port_runtime_suspend(). Otherwise we
230 * may miss a suspend event for the SuperSpeed port.
232 if (left
->is_superspeed
) {
234 WARN_ON(right
->is_superspeed
);
238 WARN_ON(!right
->is_superspeed
);
241 pm_runtime_get_sync(&hs_port
->dev
);
247 * The SuperSpeed reference is dropped when the HiSpeed port in
248 * this relationship suspends, i.e. when it is safe to allow a
249 * SuperSpeed connection to drop since there is no risk of a
250 * device degrading to its powered-off HiSpeed connection.
252 * Also, drop the HiSpeed ref taken above.
254 pm_runtime_get_sync(&ss_port
->dev
);
255 pm_runtime_put(&hs_port
->dev
);
260 static void link_peers_report(struct usb_port
*left
, struct usb_port
*right
)
264 rc
= link_peers(left
, right
);
266 dev_dbg(&left
->dev
, "peered to %s\n", dev_name(&right
->dev
));
268 dev_dbg(&left
->dev
, "failed to peer to %s (%d)\n",
269 dev_name(&right
->dev
), rc
);
270 pr_warn_once("usb: port power management may be unreliable\n");
271 usb_port_block_power_off
= 1;
275 static void unlink_peers(struct usb_port
*left
, struct usb_port
*right
)
277 struct usb_port
*ss_port
, *hs_port
;
279 WARN(right
->peer
!= left
|| left
->peer
!= right
,
280 "%s and %s are not peers?\n",
281 dev_name(&left
->dev
), dev_name(&right
->dev
));
284 * We wake the HiSpeed port to make sure we don't race its
285 * usb_port_runtime_resume() event which takes a SuperSpeed ref
286 * when ->peer is !NULL.
288 if (left
->is_superspeed
) {
296 pm_runtime_get_sync(&hs_port
->dev
);
298 sysfs_remove_link(&left
->dev
.kobj
, "peer");
300 sysfs_remove_link(&right
->dev
.kobj
, "peer");
303 /* Drop the SuperSpeed ref held on behalf of the active HiSpeed port */
304 pm_runtime_put(&ss_port
->dev
);
306 /* Drop the ref taken above */
307 pm_runtime_put(&hs_port
->dev
);
311 * For each usb hub device in the system check to see if it is in the
312 * peer domain of the given port_dev, and if it is check to see if it
313 * has a port that matches the given port by location
315 static int match_location(struct usb_device
*peer_hdev
, void *p
)
318 struct usb_hcd
*hcd
, *peer_hcd
;
319 struct usb_port
*port_dev
= p
, *peer
;
320 struct usb_hub
*peer_hub
= usb_hub_to_struct_hub(peer_hdev
);
321 struct usb_device
*hdev
= to_usb_device(port_dev
->dev
.parent
->parent
);
326 hcd
= bus_to_hcd(hdev
->bus
);
327 peer_hcd
= bus_to_hcd(peer_hdev
->bus
);
328 /* peer_hcd is provisional until we verify it against the known peer */
329 if (peer_hcd
!= hcd
->shared_hcd
)
332 for (port1
= 1; port1
<= peer_hdev
->maxchild
; port1
++) {
333 peer
= peer_hub
->ports
[port1
- 1];
334 if (peer
&& peer
->location
== port_dev
->location
) {
335 link_peers_report(port_dev
, peer
);
344 * Find the peer port either via explicit platform firmware "location"
345 * data, the peer hcd for root hubs, or the upstream peer relationship
346 * for all other hubs.
348 static void find_and_link_peer(struct usb_hub
*hub
, int port1
)
350 struct usb_port
*port_dev
= hub
->ports
[port1
- 1], *peer
;
351 struct usb_device
*hdev
= hub
->hdev
;
352 struct usb_device
*peer_hdev
;
353 struct usb_hub
*peer_hub
;
356 * If location data is available then we can only peer this port
357 * by a location match, not the default peer (lest we create a
358 * situation where we need to go back and undo a default peering
359 * when the port is later peered by location data)
361 if (port_dev
->location
) {
362 /* we link the peer in match_location() if found */
363 usb_for_each_dev(port_dev
, match_location
);
365 } else if (!hdev
->parent
) {
366 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
367 struct usb_hcd
*peer_hcd
= hcd
->shared_hcd
;
372 peer_hdev
= peer_hcd
->self
.root_hub
;
374 struct usb_port
*upstream
;
375 struct usb_device
*parent
= hdev
->parent
;
376 struct usb_hub
*parent_hub
= usb_hub_to_struct_hub(parent
);
381 upstream
= parent_hub
->ports
[hdev
->portnum
- 1];
382 if (!upstream
|| !upstream
->peer
)
385 peer_hdev
= upstream
->peer
->child
;
388 peer_hub
= usb_hub_to_struct_hub(peer_hdev
);
389 if (!peer_hub
|| port1
> peer_hdev
->maxchild
)
393 * we found a valid default peer, last check is to make sure it
394 * does not have location data
396 peer
= peer_hub
->ports
[port1
- 1];
397 if (peer
&& peer
->location
== 0)
398 link_peers_report(port_dev
, peer
);
401 int usb_hub_create_port_device(struct usb_hub
*hub
, int port1
)
403 struct usb_port
*port_dev
;
406 port_dev
= kzalloc(sizeof(*port_dev
), GFP_KERNEL
);
410 port_dev
->req
= kzalloc(sizeof(*(port_dev
->req
)), GFP_KERNEL
);
411 if (!port_dev
->req
) {
416 hub
->ports
[port1
- 1] = port_dev
;
417 port_dev
->portnum
= port1
;
418 set_bit(port1
, hub
->power_bits
);
419 port_dev
->dev
.parent
= hub
->intfdev
;
420 port_dev
->dev
.groups
= port_dev_group
;
421 port_dev
->dev
.type
= &usb_port_device_type
;
422 port_dev
->dev
.driver
= &usb_port_driver
;
423 if (hub_is_superspeed(hub
->hdev
))
424 port_dev
->is_superspeed
= 1;
425 dev_set_name(&port_dev
->dev
, "%s-port%d", dev_name(&hub
->hdev
->dev
),
427 mutex_init(&port_dev
->status_lock
);
428 retval
= device_register(&port_dev
->dev
);
430 put_device(&port_dev
->dev
);
434 /* Set default policy of port-poweroff disabled. */
435 retval
= dev_pm_qos_add_request(&port_dev
->dev
, port_dev
->req
,
436 DEV_PM_QOS_FLAGS
, PM_QOS_FLAG_NO_POWER_OFF
);
438 device_unregister(&port_dev
->dev
);
442 find_and_link_peer(hub
, port1
);
445 * Enable runtime pm and hold a refernce that hub_configure()
446 * will drop once the PM_QOS_NO_POWER_OFF flag state has been set
447 * and the hub has been fully registered (hdev->maxchild set).
449 pm_runtime_set_active(&port_dev
->dev
);
450 pm_runtime_get_noresume(&port_dev
->dev
);
451 pm_runtime_enable(&port_dev
->dev
);
452 device_enable_async_suspend(&port_dev
->dev
);
455 * Keep hidden the ability to enable port-poweroff if the hub
456 * does not support power switching.
458 if (!hub_is_port_power_switchable(hub
))
461 /* Attempt to let userspace take over the policy. */
462 retval
= dev_pm_qos_expose_flags(&port_dev
->dev
,
463 PM_QOS_FLAG_NO_POWER_OFF
);
465 dev_warn(&port_dev
->dev
, "failed to expose pm_qos_no_poweroff\n");
469 /* Userspace owns the policy, drop the kernel 'no_poweroff' request. */
470 retval
= dev_pm_qos_remove_request(port_dev
->req
);
472 kfree(port_dev
->req
);
473 port_dev
->req
= NULL
;
478 void usb_hub_remove_port_device(struct usb_hub
*hub
, int port1
)
480 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
481 struct usb_port
*peer
;
483 peer
= port_dev
->peer
;
485 unlink_peers(port_dev
, peer
);
486 device_unregister(&port_dev
->dev
);