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 ssize_t
usb3_lpm_permit_show(struct device
*dev
,
54 struct device_attribute
*attr
, char *buf
)
56 struct usb_port
*port_dev
= to_usb_port(dev
);
59 if (port_dev
->usb3_lpm_u1_permit
) {
60 if (port_dev
->usb3_lpm_u2_permit
)
65 if (port_dev
->usb3_lpm_u2_permit
)
71 return sprintf(buf
, "%s\n", p
);
74 static ssize_t
usb3_lpm_permit_store(struct device
*dev
,
75 struct device_attribute
*attr
,
76 const char *buf
, size_t count
)
78 struct usb_port
*port_dev
= to_usb_port(dev
);
79 struct usb_device
*udev
= port_dev
->child
;
82 if (!strncmp(buf
, "u1_u2", 5)) {
83 port_dev
->usb3_lpm_u1_permit
= 1;
84 port_dev
->usb3_lpm_u2_permit
= 1;
86 } else if (!strncmp(buf
, "u1", 2)) {
87 port_dev
->usb3_lpm_u1_permit
= 1;
88 port_dev
->usb3_lpm_u2_permit
= 0;
90 } else if (!strncmp(buf
, "u2", 2)) {
91 port_dev
->usb3_lpm_u1_permit
= 0;
92 port_dev
->usb3_lpm_u2_permit
= 1;
94 } else if (!strncmp(buf
, "0", 1)) {
95 port_dev
->usb3_lpm_u1_permit
= 0;
96 port_dev
->usb3_lpm_u2_permit
= 0;
100 /* If device is connected to the port, disable or enable lpm
101 * to make new u1 u2 setting take effect immediately.
104 hcd
= bus_to_hcd(udev
->bus
);
107 usb_lock_device(udev
);
108 mutex_lock(hcd
->bandwidth_mutex
);
109 if (!usb_disable_lpm(udev
))
110 usb_enable_lpm(udev
);
111 mutex_unlock(hcd
->bandwidth_mutex
);
112 usb_unlock_device(udev
);
117 static DEVICE_ATTR_RW(usb3_lpm_permit
);
119 static struct attribute
*port_dev_attrs
[] = {
120 &dev_attr_connect_type
.attr
,
124 static struct attribute_group port_dev_attr_grp
= {
125 .attrs
= port_dev_attrs
,
128 static const struct attribute_group
*port_dev_group
[] = {
133 static struct attribute
*port_dev_usb3_attrs
[] = {
134 &dev_attr_usb3_lpm_permit
.attr
,
138 static struct attribute_group port_dev_usb3_attr_grp
= {
139 .attrs
= port_dev_usb3_attrs
,
142 static const struct attribute_group
*port_dev_usb3_group
[] = {
144 &port_dev_usb3_attr_grp
,
148 static void usb_port_device_release(struct device
*dev
)
150 struct usb_port
*port_dev
= to_usb_port(dev
);
152 kfree(port_dev
->req
);
157 static int usb_port_runtime_resume(struct device
*dev
)
159 struct usb_port
*port_dev
= to_usb_port(dev
);
160 struct usb_device
*hdev
= to_usb_device(dev
->parent
->parent
);
161 struct usb_interface
*intf
= to_usb_interface(dev
->parent
);
162 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
163 struct usb_device
*udev
= port_dev
->child
;
164 struct usb_port
*peer
= port_dev
->peer
;
165 int port1
= port_dev
->portnum
;
171 set_bit(port1
, hub
->power_bits
);
176 * Power on our usb3 peer before this usb2 port to prevent a usb3
177 * device from degrading to its usb2 connection
179 if (!port_dev
->is_superspeed
&& peer
)
180 pm_runtime_get_sync(&peer
->dev
);
182 usb_autopm_get_interface(intf
);
183 retval
= usb_hub_set_port_power(hdev
, hub
, port1
, true);
184 msleep(hub_power_on_good_delay(hub
));
185 if (udev
&& !retval
) {
187 * Our preference is to simply wait for the port to reconnect,
188 * as that is the lowest latency method to restart the port.
189 * However, there are cases where toggling port power results in
190 * the host port and the device port getting out of sync causing
191 * a link training live lock. Upon timeout, flag the port as
192 * needing warm reset recovery (to be performed later by
193 * usb_port_resume() as requested via usb_wakeup_notification())
195 if (hub_port_debounce_be_connected(hub
, port1
) < 0) {
196 dev_dbg(&port_dev
->dev
, "reconnect timeout\n");
197 if (hub_is_superspeed(hdev
))
198 set_bit(port1
, hub
->warm_reset_bits
);
201 /* Force the child awake to revalidate after the power loss. */
202 if (!test_and_set_bit(port1
, hub
->child_usage_bits
)) {
203 pm_runtime_get_noresume(&port_dev
->dev
);
204 pm_request_resume(&udev
->dev
);
208 usb_autopm_put_interface(intf
);
213 static int usb_port_runtime_suspend(struct device
*dev
)
215 struct usb_port
*port_dev
= to_usb_port(dev
);
216 struct usb_device
*hdev
= to_usb_device(dev
->parent
->parent
);
217 struct usb_interface
*intf
= to_usb_interface(dev
->parent
);
218 struct usb_hub
*hub
= usb_hub_to_struct_hub(hdev
);
219 struct usb_port
*peer
= port_dev
->peer
;
220 int port1
= port_dev
->portnum
;
228 if (dev_pm_qos_flags(&port_dev
->dev
, PM_QOS_FLAG_NO_POWER_OFF
)
232 if (usb_port_block_power_off
)
235 usb_autopm_get_interface(intf
);
236 retval
= usb_hub_set_port_power(hdev
, hub
, port1
, false);
237 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_CONNECTION
);
238 if (!port_dev
->is_superspeed
)
239 usb_clear_port_feature(hdev
, port1
, USB_PORT_FEAT_C_ENABLE
);
240 usb_autopm_put_interface(intf
);
243 * Our peer usb3 port may now be able to suspend, so
244 * asynchronously queue a suspend request to observe that this
245 * usb2 port is now off.
247 if (!port_dev
->is_superspeed
&& peer
)
248 pm_runtime_put(&peer
->dev
);
253 static int usb_port_prepare(struct device
*dev
)
259 static const struct dev_pm_ops usb_port_pm_ops
= {
261 .runtime_suspend
= usb_port_runtime_suspend
,
262 .runtime_resume
= usb_port_runtime_resume
,
263 .prepare
= usb_port_prepare
,
267 struct device_type usb_port_device_type
= {
269 .release
= usb_port_device_release
,
270 .pm
= &usb_port_pm_ops
,
273 static struct device_driver usb_port_driver
= {
275 .owner
= THIS_MODULE
,
278 static int link_peers(struct usb_port
*left
, struct usb_port
*right
)
280 struct usb_port
*ss_port
, *hs_port
;
283 if (left
->peer
== right
&& right
->peer
== left
)
286 if (left
->peer
|| right
->peer
) {
287 struct usb_port
*lpeer
= left
->peer
;
288 struct usb_port
*rpeer
= right
->peer
;
291 if (left
->location
&& left
->location
== right
->location
)
296 pr_debug("usb: failed to peer %s and %s by %s (%s:%s) (%s:%s)\n",
297 dev_name(&left
->dev
), dev_name(&right
->dev
), method
,
298 dev_name(&left
->dev
),
299 lpeer
? dev_name(&lpeer
->dev
) : "none",
300 dev_name(&right
->dev
),
301 rpeer
? dev_name(&rpeer
->dev
) : "none");
305 rc
= sysfs_create_link(&left
->dev
.kobj
, &right
->dev
.kobj
, "peer");
308 rc
= sysfs_create_link(&right
->dev
.kobj
, &left
->dev
.kobj
, "peer");
310 sysfs_remove_link(&left
->dev
.kobj
, "peer");
315 * We need to wake the HiSpeed port to make sure we don't race
316 * setting ->peer with usb_port_runtime_suspend(). Otherwise we
317 * may miss a suspend event for the SuperSpeed port.
319 if (left
->is_superspeed
) {
321 WARN_ON(right
->is_superspeed
);
325 WARN_ON(!right
->is_superspeed
);
328 pm_runtime_get_sync(&hs_port
->dev
);
334 * The SuperSpeed reference is dropped when the HiSpeed port in
335 * this relationship suspends, i.e. when it is safe to allow a
336 * SuperSpeed connection to drop since there is no risk of a
337 * device degrading to its powered-off HiSpeed connection.
339 * Also, drop the HiSpeed ref taken above.
341 pm_runtime_get_sync(&ss_port
->dev
);
342 pm_runtime_put(&hs_port
->dev
);
347 static void link_peers_report(struct usb_port
*left
, struct usb_port
*right
)
351 rc
= link_peers(left
, right
);
353 dev_dbg(&left
->dev
, "peered to %s\n", dev_name(&right
->dev
));
355 dev_dbg(&left
->dev
, "failed to peer to %s (%d)\n",
356 dev_name(&right
->dev
), rc
);
357 pr_warn_once("usb: port power management may be unreliable\n");
358 usb_port_block_power_off
= 1;
362 static void unlink_peers(struct usb_port
*left
, struct usb_port
*right
)
364 struct usb_port
*ss_port
, *hs_port
;
366 WARN(right
->peer
!= left
|| left
->peer
!= right
,
367 "%s and %s are not peers?\n",
368 dev_name(&left
->dev
), dev_name(&right
->dev
));
371 * We wake the HiSpeed port to make sure we don't race its
372 * usb_port_runtime_resume() event which takes a SuperSpeed ref
373 * when ->peer is !NULL.
375 if (left
->is_superspeed
) {
383 pm_runtime_get_sync(&hs_port
->dev
);
385 sysfs_remove_link(&left
->dev
.kobj
, "peer");
387 sysfs_remove_link(&right
->dev
.kobj
, "peer");
390 /* Drop the SuperSpeed ref held on behalf of the active HiSpeed port */
391 pm_runtime_put(&ss_port
->dev
);
393 /* Drop the ref taken above */
394 pm_runtime_put(&hs_port
->dev
);
398 * For each usb hub device in the system check to see if it is in the
399 * peer domain of the given port_dev, and if it is check to see if it
400 * has a port that matches the given port by location
402 static int match_location(struct usb_device
*peer_hdev
, void *p
)
405 struct usb_hcd
*hcd
, *peer_hcd
;
406 struct usb_port
*port_dev
= p
, *peer
;
407 struct usb_hub
*peer_hub
= usb_hub_to_struct_hub(peer_hdev
);
408 struct usb_device
*hdev
= to_usb_device(port_dev
->dev
.parent
->parent
);
413 hcd
= bus_to_hcd(hdev
->bus
);
414 peer_hcd
= bus_to_hcd(peer_hdev
->bus
);
415 /* peer_hcd is provisional until we verify it against the known peer */
416 if (peer_hcd
!= hcd
->shared_hcd
)
419 for (port1
= 1; port1
<= peer_hdev
->maxchild
; port1
++) {
420 peer
= peer_hub
->ports
[port1
- 1];
421 if (peer
&& peer
->location
== port_dev
->location
) {
422 link_peers_report(port_dev
, peer
);
431 * Find the peer port either via explicit platform firmware "location"
432 * data, the peer hcd for root hubs, or the upstream peer relationship
433 * for all other hubs.
435 static void find_and_link_peer(struct usb_hub
*hub
, int port1
)
437 struct usb_port
*port_dev
= hub
->ports
[port1
- 1], *peer
;
438 struct usb_device
*hdev
= hub
->hdev
;
439 struct usb_device
*peer_hdev
;
440 struct usb_hub
*peer_hub
;
443 * If location data is available then we can only peer this port
444 * by a location match, not the default peer (lest we create a
445 * situation where we need to go back and undo a default peering
446 * when the port is later peered by location data)
448 if (port_dev
->location
) {
449 /* we link the peer in match_location() if found */
450 usb_for_each_dev(port_dev
, match_location
);
452 } else if (!hdev
->parent
) {
453 struct usb_hcd
*hcd
= bus_to_hcd(hdev
->bus
);
454 struct usb_hcd
*peer_hcd
= hcd
->shared_hcd
;
459 peer_hdev
= peer_hcd
->self
.root_hub
;
461 struct usb_port
*upstream
;
462 struct usb_device
*parent
= hdev
->parent
;
463 struct usb_hub
*parent_hub
= usb_hub_to_struct_hub(parent
);
468 upstream
= parent_hub
->ports
[hdev
->portnum
- 1];
469 if (!upstream
|| !upstream
->peer
)
472 peer_hdev
= upstream
->peer
->child
;
475 peer_hub
= usb_hub_to_struct_hub(peer_hdev
);
476 if (!peer_hub
|| port1
> peer_hdev
->maxchild
)
480 * we found a valid default peer, last check is to make sure it
481 * does not have location data
483 peer
= peer_hub
->ports
[port1
- 1];
484 if (peer
&& peer
->location
== 0)
485 link_peers_report(port_dev
, peer
);
488 int usb_hub_create_port_device(struct usb_hub
*hub
, int port1
)
490 struct usb_port
*port_dev
;
491 struct usb_device
*hdev
= hub
->hdev
;
494 port_dev
= kzalloc(sizeof(*port_dev
), GFP_KERNEL
);
498 port_dev
->req
= kzalloc(sizeof(*(port_dev
->req
)), GFP_KERNEL
);
499 if (!port_dev
->req
) {
504 hub
->ports
[port1
- 1] = port_dev
;
505 port_dev
->portnum
= port1
;
506 set_bit(port1
, hub
->power_bits
);
507 port_dev
->dev
.parent
= hub
->intfdev
;
508 if (hub_is_superspeed(hdev
)) {
509 port_dev
->usb3_lpm_u1_permit
= 1;
510 port_dev
->usb3_lpm_u2_permit
= 1;
511 port_dev
->dev
.groups
= port_dev_usb3_group
;
513 port_dev
->dev
.groups
= port_dev_group
;
514 port_dev
->dev
.type
= &usb_port_device_type
;
515 port_dev
->dev
.driver
= &usb_port_driver
;
516 if (hub_is_superspeed(hub
->hdev
))
517 port_dev
->is_superspeed
= 1;
518 dev_set_name(&port_dev
->dev
, "%s-port%d", dev_name(&hub
->hdev
->dev
),
520 mutex_init(&port_dev
->status_lock
);
521 retval
= device_register(&port_dev
->dev
);
523 put_device(&port_dev
->dev
);
527 /* Set default policy of port-poweroff disabled. */
528 retval
= dev_pm_qos_add_request(&port_dev
->dev
, port_dev
->req
,
529 DEV_PM_QOS_FLAGS
, PM_QOS_FLAG_NO_POWER_OFF
);
531 device_unregister(&port_dev
->dev
);
535 find_and_link_peer(hub
, port1
);
538 * Enable runtime pm and hold a refernce that hub_configure()
539 * will drop once the PM_QOS_NO_POWER_OFF flag state has been set
540 * and the hub has been fully registered (hdev->maxchild set).
542 pm_runtime_set_active(&port_dev
->dev
);
543 pm_runtime_get_noresume(&port_dev
->dev
);
544 pm_runtime_enable(&port_dev
->dev
);
545 device_enable_async_suspend(&port_dev
->dev
);
548 * Keep hidden the ability to enable port-poweroff if the hub
549 * does not support power switching.
551 if (!hub_is_port_power_switchable(hub
))
554 /* Attempt to let userspace take over the policy. */
555 retval
= dev_pm_qos_expose_flags(&port_dev
->dev
,
556 PM_QOS_FLAG_NO_POWER_OFF
);
558 dev_warn(&port_dev
->dev
, "failed to expose pm_qos_no_poweroff\n");
562 /* Userspace owns the policy, drop the kernel 'no_poweroff' request. */
563 retval
= dev_pm_qos_remove_request(port_dev
->req
);
565 kfree(port_dev
->req
);
566 port_dev
->req
= NULL
;
571 void usb_hub_remove_port_device(struct usb_hub
*hub
, int port1
)
573 struct usb_port
*port_dev
= hub
->ports
[port1
- 1];
574 struct usb_port
*peer
;
576 peer
= port_dev
->peer
;
578 unlink_peers(port_dev
, peer
);
579 device_unregister(&port_dev
->dev
);