USB: xhci: Fix check for room on the ring.
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / usb / core / hcd-pci.c
CommitLineData
1da177e4
LT
1/*
2 * (C) Copyright David Brownell 2000-2002
34bbe4c1 3 *
1da177e4
LT
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the
6 * Free Software Foundation; either version 2 of the License, or (at your
7 * option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software Foundation,
16 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17 */
18
1da177e4
LT
19#include <linux/kernel.h>
20#include <linux/module.h>
21#include <linux/pci.h>
6d19c009 22#include <linux/pm_runtime.h>
21b1861f
DB
23#include <linux/usb.h>
24
1da177e4
LT
25#include <asm/io.h>
26#include <asm/irq.h>
21b1861f
DB
27
28#ifdef CONFIG_PPC_PMAC
29#include <asm/machdep.h>
30#include <asm/pmac_feature.h>
31#include <asm/pci-bridge.h>
32#include <asm/prom.h>
33#endif
5f827ea3
DB
34
35#include "usb.h"
1da177e4
LT
36#include "hcd.h"
37
38
c6053ecf 39/* PCI-based HCs are common, but plenty of non-PCI HCs are used too */
1da177e4 40
6d19c009
AS
41#ifdef CONFIG_PM_SLEEP
42
43/* Coordinate handoffs between EHCI and companion controllers
44 * during system resume
45 */
46
47static DEFINE_MUTEX(companions_mutex);
48
49#define CL_UHCI PCI_CLASS_SERIAL_USB_UHCI
50#define CL_OHCI PCI_CLASS_SERIAL_USB_OHCI
51#define CL_EHCI PCI_CLASS_SERIAL_USB_EHCI
52
53enum companion_action {
54 SET_HS_COMPANION, CLEAR_HS_COMPANION, WAIT_FOR_COMPANIONS
55};
56
57static void companion_common(struct pci_dev *pdev, struct usb_hcd *hcd,
58 enum companion_action action)
59{
60 struct pci_dev *companion;
61 struct usb_hcd *companion_hcd;
62 unsigned int slot = PCI_SLOT(pdev->devfn);
63
64 /* Iterate through other PCI functions in the same slot.
65 * If pdev is OHCI or UHCI then we are looking for EHCI, and
66 * vice versa.
67 */
68 companion = NULL;
69 for (;;) {
70 companion = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, companion);
71 if (!companion)
72 break;
73 if (companion->bus != pdev->bus ||
74 PCI_SLOT(companion->devfn) != slot)
75 continue;
76
77 companion_hcd = pci_get_drvdata(companion);
78 if (!companion_hcd)
79 continue;
80
81 /* For SET_HS_COMPANION, store a pointer to the EHCI bus in
82 * the OHCI/UHCI companion bus structure.
83 * For CLEAR_HS_COMPANION, clear the pointer to the EHCI bus
84 * in the OHCI/UHCI companion bus structure.
85 * For WAIT_FOR_COMPANIONS, wait until the OHCI/UHCI
86 * companion controllers have fully resumed.
87 */
88
89 if ((pdev->class == CL_OHCI || pdev->class == CL_UHCI) &&
90 companion->class == CL_EHCI) {
91 /* action must be SET_HS_COMPANION */
92 dev_dbg(&companion->dev, "HS companion for %s\n",
93 dev_name(&pdev->dev));
94 hcd->self.hs_companion = &companion_hcd->self;
95
96 } else if (pdev->class == CL_EHCI &&
97 (companion->class == CL_OHCI ||
98 companion->class == CL_UHCI)) {
99 switch (action) {
100 case SET_HS_COMPANION:
101 dev_dbg(&pdev->dev, "HS companion for %s\n",
102 dev_name(&companion->dev));
103 companion_hcd->self.hs_companion = &hcd->self;
104 break;
105 case CLEAR_HS_COMPANION:
106 companion_hcd->self.hs_companion = NULL;
107 break;
108 case WAIT_FOR_COMPANIONS:
109 device_pm_wait_for_dev(&pdev->dev,
110 &companion->dev);
111 break;
112 }
113 }
114 }
115}
116
117static void set_hs_companion(struct pci_dev *pdev, struct usb_hcd *hcd)
118{
119 mutex_lock(&companions_mutex);
120 dev_set_drvdata(&pdev->dev, hcd);
121 companion_common(pdev, hcd, SET_HS_COMPANION);
122 mutex_unlock(&companions_mutex);
123}
124
125static void clear_hs_companion(struct pci_dev *pdev, struct usb_hcd *hcd)
126{
127 mutex_lock(&companions_mutex);
128 dev_set_drvdata(&pdev->dev, NULL);
129
130 /* If pdev is OHCI or UHCI, just clear its hs_companion pointer */
131 if (pdev->class == CL_OHCI || pdev->class == CL_UHCI)
132 hcd->self.hs_companion = NULL;
133
134 /* Otherwise search for companion buses and clear their pointers */
135 else
136 companion_common(pdev, hcd, CLEAR_HS_COMPANION);
137 mutex_unlock(&companions_mutex);
138}
139
140static void wait_for_companions(struct pci_dev *pdev, struct usb_hcd *hcd)
141{
142 /* Only EHCI controllers need to wait.
143 * No locking is needed because a controller cannot be resumed
144 * while one of its companions is getting unbound.
145 */
146 if (pdev->class == CL_EHCI)
147 companion_common(pdev, hcd, WAIT_FOR_COMPANIONS);
148}
149
150#else /* !CONFIG_PM_SLEEP */
151
152static inline void set_hs_companion(struct pci_dev *d, struct usb_hcd *h) {}
153static inline void clear_hs_companion(struct pci_dev *d, struct usb_hcd *h) {}
154static inline void wait_for_companions(struct pci_dev *d, struct usb_hcd *h) {}
155
156#endif /* !CONFIG_PM_SLEEP */
1da177e4
LT
157
158/*-------------------------------------------------------------------------*/
159
160/* configure so an HC device and id are always provided */
161/* always called with process context; sleeping is OK */
162
163/**
164 * usb_hcd_pci_probe - initialize PCI-based HCDs
165 * @dev: USB Host Controller being probed
166 * @id: pci hotplug id connecting controller to HCD framework
167 * Context: !in_interrupt()
168 *
169 * Allocates basic PCI resources for this USB host controller, and
170 * then invokes the start() method for the HCD associated with it
171 * through the hotplug entry's driver_data.
172 *
173 * Store this function in the HCD's struct pci_driver as probe().
174 */
34bbe4c1 175int usb_hcd_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
1da177e4
LT
176{
177 struct hc_driver *driver;
178 struct usb_hcd *hcd;
179 int retval;
180
181 if (usb_disabled())
182 return -ENODEV;
183
34bbe4c1
GKH
184 if (!id)
185 return -EINVAL;
186 driver = (struct hc_driver *)id->driver_data;
187 if (!driver)
1da177e4
LT
188 return -EINVAL;
189
34bbe4c1 190 if (pci_enable_device(dev) < 0)
1da177e4 191 return -ENODEV;
c6053ecf 192 dev->current_state = PCI_D0;
34bbe4c1
GKH
193
194 if (!dev->irq) {
195 dev_err(&dev->dev,
1da177e4
LT
196 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n",
197 pci_name(dev));
34bbe4c1 198 retval = -ENODEV;
1da177e4 199 goto err1;
34bbe4c1 200 }
1da177e4 201
34bbe4c1 202 hcd = usb_create_hcd(driver, &dev->dev, pci_name(dev));
1da177e4
LT
203 if (!hcd) {
204 retval = -ENOMEM;
205 goto err1;
206 }
207
34bbe4c1
GKH
208 if (driver->flags & HCD_MEMORY) {
209 /* EHCI, OHCI */
210 hcd->rsrc_start = pci_resource_start(dev, 0);
211 hcd->rsrc_len = pci_resource_len(dev, 0);
212 if (!request_mem_region(hcd->rsrc_start, hcd->rsrc_len,
1da177e4 213 driver->description)) {
34bbe4c1 214 dev_dbg(&dev->dev, "controller already in use\n");
1da177e4
LT
215 retval = -EBUSY;
216 goto err2;
217 }
34bbe4c1 218 hcd->regs = ioremap_nocache(hcd->rsrc_start, hcd->rsrc_len);
1da177e4 219 if (hcd->regs == NULL) {
34bbe4c1 220 dev_dbg(&dev->dev, "error mapping memory\n");
1da177e4
LT
221 retval = -EFAULT;
222 goto err3;
223 }
224
34bbe4c1
GKH
225 } else {
226 /* UHCI */
1da177e4
LT
227 int region;
228
229 for (region = 0; region < PCI_ROM_RESOURCE; region++) {
34bbe4c1 230 if (!(pci_resource_flags(dev, region) &
1da177e4
LT
231 IORESOURCE_IO))
232 continue;
233
34bbe4c1
GKH
234 hcd->rsrc_start = pci_resource_start(dev, region);
235 hcd->rsrc_len = pci_resource_len(dev, region);
236 if (request_region(hcd->rsrc_start, hcd->rsrc_len,
1da177e4
LT
237 driver->description))
238 break;
239 }
240 if (region == PCI_ROM_RESOURCE) {
34bbe4c1 241 dev_dbg(&dev->dev, "no i/o regions available\n");
1da177e4 242 retval = -EBUSY;
6d19c009 243 goto err2;
1da177e4
LT
244 }
245 }
246
34bbe4c1 247 pci_set_master(dev);
1da177e4 248
442258e2 249 retval = usb_add_hcd(hcd, dev->irq, IRQF_DISABLED | IRQF_SHARED);
1da177e4
LT
250 if (retval != 0)
251 goto err4;
6d19c009 252 set_hs_companion(dev, hcd);
1da177e4
LT
253 return retval;
254
255 err4:
256 if (driver->flags & HCD_MEMORY) {
34bbe4c1 257 iounmap(hcd->regs);
1da177e4 258 err3:
34bbe4c1 259 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
1da177e4 260 } else
34bbe4c1 261 release_region(hcd->rsrc_start, hcd->rsrc_len);
1da177e4 262 err2:
6d19c009 263 clear_hs_companion(dev, hcd);
34bbe4c1 264 usb_put_hcd(hcd);
1da177e4 265 err1:
34bbe4c1
GKH
266 pci_disable_device(dev);
267 dev_err(&dev->dev, "init %s fail, %d\n", pci_name(dev), retval);
1da177e4 268 return retval;
34bbe4c1 269}
782e70c6 270EXPORT_SYMBOL_GPL(usb_hcd_pci_probe);
1da177e4
LT
271
272
273/* may be called without controller electrically present */
274/* may be called with controller, bus, and devices active */
275
276/**
277 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs
278 * @dev: USB Host Controller being removed
279 * Context: !in_interrupt()
280 *
281 * Reverses the effect of usb_hcd_pci_probe(), first invoking
282 * the HCD's stop() method. It is always called from a thread
283 * context, normally "rmmod", "apmd", or something similar.
284 *
285 * Store this function in the HCD's struct pci_driver as remove().
286 */
34bbe4c1 287void usb_hcd_pci_remove(struct pci_dev *dev)
1da177e4
LT
288{
289 struct usb_hcd *hcd;
290
291 hcd = pci_get_drvdata(dev);
292 if (!hcd)
293 return;
294
34bbe4c1 295 usb_remove_hcd(hcd);
1da177e4 296 if (hcd->driver->flags & HCD_MEMORY) {
34bbe4c1
GKH
297 iounmap(hcd->regs);
298 release_mem_region(hcd->rsrc_start, hcd->rsrc_len);
1da177e4 299 } else {
34bbe4c1 300 release_region(hcd->rsrc_start, hcd->rsrc_len);
1da177e4 301 }
6d19c009 302 clear_hs_companion(dev, hcd);
34bbe4c1 303 usb_put_hcd(hcd);
1da177e4
LT
304 pci_disable_device(dev);
305}
782e70c6 306EXPORT_SYMBOL_GPL(usb_hcd_pci_remove);
1da177e4 307
1da177e4 308/**
abb30641
AS
309 * usb_hcd_pci_shutdown - shutdown host controller
310 * @dev: USB Host Controller being shutdown
1da177e4 311 */
abb30641
AS
312void usb_hcd_pci_shutdown(struct pci_dev *dev)
313{
314 struct usb_hcd *hcd;
315
316 hcd = pci_get_drvdata(dev);
317 if (!hcd)
318 return;
319
320 if (hcd->driver->shutdown)
321 hcd->driver->shutdown(hcd);
322}
323EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown);
324
325#ifdef CONFIG_PM_SLEEP
326
327static int check_root_hub_suspended(struct device *dev)
328{
329 struct pci_dev *pci_dev = to_pci_dev(dev);
330 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
331
332 if (!(hcd->state == HC_STATE_SUSPENDED ||
333 hcd->state == HC_STATE_HALT)) {
334 dev_warn(dev, "Root hub is not suspended\n");
335 return -EBUSY;
336 }
337 return 0;
338}
339
340static int hcd_pci_suspend(struct device *dev)
1da177e4 341{
abb30641
AS
342 struct pci_dev *pci_dev = to_pci_dev(dev);
343 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
344 int retval;
1da177e4 345
5f827ea3
DB
346 /* Root hub suspend should have stopped all downstream traffic,
347 * and all bus master traffic. And done so for both the interface
348 * and the stub usb_device (which we check here). But maybe it
349 * didn't; writing sysfs power/state files ignores such rules...
5f827ea3 350 */
abb30641
AS
351 retval = check_root_hub_suspended(dev);
352 if (retval)
353 return retval;
a0d4922d
AS
354
355 /* We might already be suspended (runtime PM -- not yet written) */
abb30641
AS
356 if (pci_dev->current_state != PCI_D0)
357 return retval;
5f827ea3 358
7be7d741 359 if (hcd->driver->pci_suspend) {
6ec4beb5 360 retval = hcd->driver->pci_suspend(hcd);
7be7d741 361 suspend_report_result(hcd->driver->pci_suspend, retval);
02669492 362 if (retval)
abb30641 363 return retval;
5f827ea3
DB
364 }
365
abb30641 366 synchronize_irq(pci_dev->irq);
c6053ecf 367
a15d95a0
RW
368 /* Downstream ports from this root hub should already be quiesced, so
369 * there will be no DMA activity. Now we can shut down the upstream
abb30641
AS
370 * link (except maybe for PME# resume signaling). We'll enter a
371 * low power state during suspend_noirq, if the hardware allows.
a15d95a0 372 */
abb30641
AS
373 pci_disable_device(pci_dev);
374 return retval;
375}
376
377static int hcd_pci_suspend_noirq(struct device *dev)
378{
379 struct pci_dev *pci_dev = to_pci_dev(dev);
380 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
381 int retval;
382
383 retval = check_root_hub_suspended(dev);
384 if (retval)
385 return retval;
a15d95a0 386
abb30641 387 pci_save_state(pci_dev);
a15d95a0 388
abb30641
AS
389 /* If the root hub is HALTed rather than SUSPENDed,
390 * disallow remote wakeup.
1da177e4 391 */
abb30641
AS
392 if (hcd->state == HC_STATE_HALT)
393 device_set_wakeup_enable(dev, 0);
394 dev_dbg(dev, "wakeup: %d\n", device_may_wakeup(dev));
a0d4922d 395
abb30641
AS
396 /* Possibly enable remote wakeup,
397 * choose the appropriate low-power state, and go to that state.
398 */
399 retval = pci_prepare_to_sleep(pci_dev);
400 if (retval == -EIO) { /* Low-power not supported */
401 dev_dbg(dev, "--> PCI D0 legacy\n");
402 retval = 0;
403 } else if (retval == 0) {
404 dev_dbg(dev, "--> PCI %s\n",
405 pci_power_name(pci_dev->current_state));
a0d4922d 406 } else {
abb30641
AS
407 suspend_report_result(pci_prepare_to_sleep, retval);
408 return retval;
1da177e4
LT
409 }
410
21b1861f 411#ifdef CONFIG_PPC_PMAC
abb30641
AS
412 /* Disable ASIC clocks for USB */
413 if (machine_is(powermac)) {
414 struct device_node *of_node;
415
416 of_node = pci_device_to_OF_node(pci_dev);
417 if (of_node)
418 pmac_call_feature(PMAC_FTR_USB_ENABLE, of_node, 0, 0);
21b1861f 419 }
a0d4922d 420#endif
1da177e4
LT
421 return retval;
422}
1da177e4 423
abb30641 424static int hcd_pci_resume_noirq(struct device *dev)
a0d4922d 425{
abb30641 426 struct pci_dev *pci_dev = to_pci_dev(dev);
a0d4922d 427
a15d95a0
RW
428#ifdef CONFIG_PPC_PMAC
429 /* Reenable ASIC clocks for USB */
430 if (machine_is(powermac)) {
431 struct device_node *of_node;
432
abb30641 433 of_node = pci_device_to_OF_node(pci_dev);
a15d95a0
RW
434 if (of_node)
435 pmac_call_feature(PMAC_FTR_USB_ENABLE,
436 of_node, 0, 1);
437 }
438#endif
439
abb30641
AS
440 /* Go back to D0 and disable remote wakeup */
441 pci_back_from_sleep(pci_dev);
442 return 0;
443}
444
445static int resume_common(struct device *dev, bool hibernated)
446{
447 struct pci_dev *pci_dev = to_pci_dev(dev);
448 struct usb_hcd *hcd = pci_get_drvdata(pci_dev);
449 int retval;
3494252d 450
a0d4922d 451 if (hcd->state != HC_STATE_SUSPENDED) {
abb30641 452 dev_dbg(dev, "can't resume, not suspended!\n");
a0d4922d 453 return 0;
c6053ecf
DB
454 }
455
abb30641 456 retval = pci_enable_device(pci_dev);
c6053ecf 457 if (retval < 0) {
abb30641 458 dev_err(dev, "can't re-enable after resume, %d!\n", retval);
c6053ecf
DB
459 return retval;
460 }
a0d4922d 461
abb30641 462 pci_set_master(pci_dev);
c6053ecf 463
8de98402 464 clear_bit(HCD_FLAG_SAW_IRQ, &hcd->flags);
1da177e4 465
7be7d741 466 if (hcd->driver->pci_resume) {
6d19c009
AS
467 /* This call should be made only during system resume,
468 * not during runtime resume.
469 */
470 wait_for_companions(pci_dev, hcd);
471
6ec4beb5 472 retval = hcd->driver->pci_resume(hcd, hibernated);
5f827ea3 473 if (retval) {
abb30641 474 dev_err(dev, "PCI post-resume error %d!\n", retval);
34bbe4c1 475 usb_hc_died(hcd);
5f827ea3 476 }
1da177e4 477 }
1da177e4
LT
478 return retval;
479}
1da177e4 480
abb30641 481static int hcd_pci_resume(struct device *dev)
64a21d02 482{
abb30641
AS
483 return resume_common(dev, false);
484}
64a21d02 485
abb30641
AS
486static int hcd_pci_restore(struct device *dev)
487{
488 return resume_common(dev, true);
64a21d02 489}
1da177e4 490
47145210 491const struct dev_pm_ops usb_hcd_pci_pm_ops = {
abb30641
AS
492 .suspend = hcd_pci_suspend,
493 .suspend_noirq = hcd_pci_suspend_noirq,
494 .resume_noirq = hcd_pci_resume_noirq,
495 .resume = hcd_pci_resume,
496 .freeze = check_root_hub_suspended,
497 .freeze_noirq = check_root_hub_suspended,
498 .thaw_noirq = NULL,
499 .thaw = NULL,
500 .poweroff = hcd_pci_suspend,
501 .poweroff_noirq = hcd_pci_suspend_noirq,
502 .restore_noirq = hcd_pci_resume_noirq,
503 .restore = hcd_pci_restore,
504};
505EXPORT_SYMBOL_GPL(usb_hcd_pci_pm_ops);
506
507#endif /* CONFIG_PM_SLEEP */