Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * (C) Copyright David Brownell 2000-2002 | |
3 | * | |
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> | |
21b1861f DB |
22 | #include <linux/usb.h> |
23 | ||
1da177e4 LT |
24 | #include <asm/io.h> |
25 | #include <asm/irq.h> | |
21b1861f DB |
26 | |
27 | #ifdef CONFIG_PPC_PMAC | |
28 | #include <asm/machdep.h> | |
29 | #include <asm/pmac_feature.h> | |
30 | #include <asm/pci-bridge.h> | |
31 | #include <asm/prom.h> | |
32 | #endif | |
5f827ea3 DB |
33 | |
34 | #include "usb.h" | |
1da177e4 LT |
35 | #include "hcd.h" |
36 | ||
37 | ||
c6053ecf | 38 | /* PCI-based HCs are common, but plenty of non-PCI HCs are used too */ |
1da177e4 LT |
39 | |
40 | ||
41 | /*-------------------------------------------------------------------------*/ | |
42 | ||
43 | /* configure so an HC device and id are always provided */ | |
44 | /* always called with process context; sleeping is OK */ | |
45 | ||
46 | /** | |
47 | * usb_hcd_pci_probe - initialize PCI-based HCDs | |
48 | * @dev: USB Host Controller being probed | |
49 | * @id: pci hotplug id connecting controller to HCD framework | |
50 | * Context: !in_interrupt() | |
51 | * | |
52 | * Allocates basic PCI resources for this USB host controller, and | |
53 | * then invokes the start() method for the HCD associated with it | |
54 | * through the hotplug entry's driver_data. | |
55 | * | |
56 | * Store this function in the HCD's struct pci_driver as probe(). | |
57 | */ | |
58 | int usb_hcd_pci_probe (struct pci_dev *dev, const struct pci_device_id *id) | |
59 | { | |
60 | struct hc_driver *driver; | |
61 | struct usb_hcd *hcd; | |
62 | int retval; | |
63 | ||
64 | if (usb_disabled()) | |
65 | return -ENODEV; | |
66 | ||
67 | if (!id || !(driver = (struct hc_driver *) id->driver_data)) | |
68 | return -EINVAL; | |
69 | ||
70 | if (pci_enable_device (dev) < 0) | |
71 | return -ENODEV; | |
c6053ecf DB |
72 | dev->current_state = PCI_D0; |
73 | dev->dev.power.power_state = PMSG_ON; | |
1da177e4 LT |
74 | |
75 | if (!dev->irq) { | |
76 | dev_err (&dev->dev, | |
77 | "Found HC with no IRQ. Check BIOS/PCI %s setup!\n", | |
78 | pci_name(dev)); | |
79 | retval = -ENODEV; | |
80 | goto err1; | |
81 | } | |
82 | ||
83 | hcd = usb_create_hcd (driver, &dev->dev, pci_name(dev)); | |
84 | if (!hcd) { | |
85 | retval = -ENOMEM; | |
86 | goto err1; | |
87 | } | |
88 | ||
89 | if (driver->flags & HCD_MEMORY) { // EHCI, OHCI | |
90 | hcd->rsrc_start = pci_resource_start (dev, 0); | |
91 | hcd->rsrc_len = pci_resource_len (dev, 0); | |
92 | if (!request_mem_region (hcd->rsrc_start, hcd->rsrc_len, | |
93 | driver->description)) { | |
94 | dev_dbg (&dev->dev, "controller already in use\n"); | |
95 | retval = -EBUSY; | |
96 | goto err2; | |
97 | } | |
98 | hcd->regs = ioremap_nocache (hcd->rsrc_start, hcd->rsrc_len); | |
99 | if (hcd->regs == NULL) { | |
100 | dev_dbg (&dev->dev, "error mapping memory\n"); | |
101 | retval = -EFAULT; | |
102 | goto err3; | |
103 | } | |
104 | ||
105 | } else { // UHCI | |
106 | int region; | |
107 | ||
108 | for (region = 0; region < PCI_ROM_RESOURCE; region++) { | |
109 | if (!(pci_resource_flags (dev, region) & | |
110 | IORESOURCE_IO)) | |
111 | continue; | |
112 | ||
113 | hcd->rsrc_start = pci_resource_start (dev, region); | |
114 | hcd->rsrc_len = pci_resource_len (dev, region); | |
115 | if (request_region (hcd->rsrc_start, hcd->rsrc_len, | |
116 | driver->description)) | |
117 | break; | |
118 | } | |
119 | if (region == PCI_ROM_RESOURCE) { | |
120 | dev_dbg (&dev->dev, "no i/o regions available\n"); | |
121 | retval = -EBUSY; | |
122 | goto err1; | |
123 | } | |
124 | } | |
125 | ||
1da177e4 LT |
126 | pci_set_master (dev); |
127 | ||
442258e2 | 128 | retval = usb_add_hcd(hcd, dev->irq, IRQF_DISABLED | IRQF_SHARED); |
1da177e4 LT |
129 | if (retval != 0) |
130 | goto err4; | |
131 | return retval; | |
132 | ||
133 | err4: | |
134 | if (driver->flags & HCD_MEMORY) { | |
135 | iounmap (hcd->regs); | |
136 | err3: | |
137 | release_mem_region (hcd->rsrc_start, hcd->rsrc_len); | |
138 | } else | |
139 | release_region (hcd->rsrc_start, hcd->rsrc_len); | |
140 | err2: | |
141 | usb_put_hcd (hcd); | |
142 | err1: | |
143 | pci_disable_device (dev); | |
144 | dev_err (&dev->dev, "init %s fail, %d\n", pci_name(dev), retval); | |
145 | return retval; | |
146 | } | |
782e70c6 | 147 | EXPORT_SYMBOL_GPL(usb_hcd_pci_probe); |
1da177e4 LT |
148 | |
149 | ||
150 | /* may be called without controller electrically present */ | |
151 | /* may be called with controller, bus, and devices active */ | |
152 | ||
153 | /** | |
154 | * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs | |
155 | * @dev: USB Host Controller being removed | |
156 | * Context: !in_interrupt() | |
157 | * | |
158 | * Reverses the effect of usb_hcd_pci_probe(), first invoking | |
159 | * the HCD's stop() method. It is always called from a thread | |
160 | * context, normally "rmmod", "apmd", or something similar. | |
161 | * | |
162 | * Store this function in the HCD's struct pci_driver as remove(). | |
163 | */ | |
164 | void usb_hcd_pci_remove (struct pci_dev *dev) | |
165 | { | |
166 | struct usb_hcd *hcd; | |
167 | ||
168 | hcd = pci_get_drvdata(dev); | |
169 | if (!hcd) | |
170 | return; | |
171 | ||
172 | usb_remove_hcd (hcd); | |
173 | if (hcd->driver->flags & HCD_MEMORY) { | |
174 | iounmap (hcd->regs); | |
175 | release_mem_region (hcd->rsrc_start, hcd->rsrc_len); | |
176 | } else { | |
177 | release_region (hcd->rsrc_start, hcd->rsrc_len); | |
178 | } | |
179 | usb_put_hcd (hcd); | |
180 | pci_disable_device(dev); | |
181 | } | |
782e70c6 | 182 | EXPORT_SYMBOL_GPL(usb_hcd_pci_remove); |
1da177e4 LT |
183 | |
184 | ||
185 | #ifdef CONFIG_PM | |
186 | ||
1da177e4 LT |
187 | /** |
188 | * usb_hcd_pci_suspend - power management suspend of a PCI-based HCD | |
189 | * @dev: USB Host Controller being suspended | |
c6053ecf | 190 | * @message: semantics in flux |
1da177e4 LT |
191 | * |
192 | * Store this function in the HCD's struct pci_driver as suspend(). | |
193 | */ | |
c6053ecf | 194 | int usb_hcd_pci_suspend (struct pci_dev *dev, pm_message_t message) |
1da177e4 LT |
195 | { |
196 | struct usb_hcd *hcd; | |
197 | int retval = 0; | |
198 | int has_pci_pm; | |
199 | ||
200 | hcd = pci_get_drvdata(dev); | |
201 | ||
5f827ea3 DB |
202 | /* Root hub suspend should have stopped all downstream traffic, |
203 | * and all bus master traffic. And done so for both the interface | |
204 | * and the stub usb_device (which we check here). But maybe it | |
205 | * didn't; writing sysfs power/state files ignores such rules... | |
206 | * | |
207 | * We must ignore the FREEZE vs SUSPEND distinction here, because | |
208 | * otherwise the swsusp will save (and restore) garbage state. | |
209 | */ | |
f3fd77cd AS |
210 | if (!(hcd->state == HC_STATE_SUSPENDED || |
211 | hcd->state == HC_STATE_HALT)) | |
5f827ea3 DB |
212 | return -EBUSY; |
213 | ||
214 | if (hcd->driver->suspend) { | |
215 | retval = hcd->driver->suspend(hcd, message); | |
02669492 AM |
216 | suspend_report_result(hcd->driver->suspend, retval); |
217 | if (retval) | |
5f827ea3 | 218 | goto done; |
5f827ea3 | 219 | } |
8de98402 | 220 | synchronize_irq(dev->irq); |
5f827ea3 | 221 | |
c6053ecf DB |
222 | /* FIXME until the generic PM interfaces change a lot more, this |
223 | * can't use PCI D1 and D2 states. For example, the confusion | |
224 | * between messages and states will need to vanish, and messages | |
225 | * will need to provide a target system state again. | |
226 | * | |
227 | * It'll be important to learn characteristics of the target state, | |
228 | * especially on embedded hardware where the HCD will often be in | |
229 | * charge of an external VBUS power supply and one or more clocks. | |
230 | * Some target system states will leave them active; others won't. | |
231 | * (With PCI, that's often handled by platform BIOS code.) | |
232 | */ | |
233 | ||
1da177e4 LT |
234 | /* even when the PCI layer rejects some of the PCI calls |
235 | * below, HCs can try global suspend and reduce DMA traffic. | |
236 | * PM-sensitive HCDs may already have done this. | |
237 | */ | |
238 | has_pci_pm = pci_find_capability(dev, PCI_CAP_ID_PM); | |
1da177e4 | 239 | |
5f827ea3 DB |
240 | /* Downstream ports from this root hub should already be quiesced, so |
241 | * there will be no DMA activity. Now we can shut down the upstream | |
242 | * link (except maybe for PME# resume signaling) and enter some PCI | |
243 | * low power state, if the hardware allows. | |
1da177e4 | 244 | */ |
5f827ea3 | 245 | if (hcd->state == HC_STATE_SUSPENDED) { |
1da177e4 | 246 | |
c6053ecf DB |
247 | /* no DMA or IRQs except when HC is active */ |
248 | if (dev->current_state == PCI_D0) { | |
1da177e4 LT |
249 | pci_save_state (dev); |
250 | pci_disable_device (dev); | |
1da177e4 LT |
251 | } |
252 | ||
269954e5 AS |
253 | if (message.event == PM_EVENT_FREEZE || |
254 | message.event == PM_EVENT_PRETHAW) { | |
255 | dev_dbg(hcd->self.controller, "--> no state change\n"); | |
256 | goto done; | |
257 | } | |
258 | ||
1da177e4 LT |
259 | if (!has_pci_pm) { |
260 | dev_dbg (hcd->self.controller, "--> PCI D0/legacy\n"); | |
5f827ea3 | 261 | goto done; |
1da177e4 LT |
262 | } |
263 | ||
c6053ecf DB |
264 | /* NOTE: dev->current_state becomes nonzero only here, and |
265 | * only for devices that support PCI PM. Also, exiting | |
266 | * PCI_D3 (but not PCI_D1 or PCI_D2) is allowed to reset | |
267 | * some device state (e.g. as part of clock reinit). | |
1da177e4 | 268 | */ |
c6053ecf | 269 | retval = pci_set_power_state (dev, PCI_D3hot); |
02669492 | 270 | suspend_report_result(pci_set_power_state, retval); |
1da177e4 | 271 | if (retval == 0) { |
fb669cc0 DB |
272 | int wake = device_can_wakeup(&hcd->self.root_hub->dev); |
273 | ||
274 | wake = wake && device_may_wakeup(hcd->self.controller); | |
275 | ||
276 | dev_dbg (hcd->self.controller, "--> PCI D3%s\n", | |
277 | wake ? "/wakeup" : ""); | |
5f827ea3 DB |
278 | |
279 | /* Ignore these return values. We rely on pci code to | |
280 | * reject requests the hardware can't implement, rather | |
281 | * than coding the same thing. | |
282 | */ | |
fb669cc0 DB |
283 | (void) pci_enable_wake (dev, PCI_D3hot, wake); |
284 | (void) pci_enable_wake (dev, PCI_D3cold, wake); | |
5f827ea3 | 285 | } else { |
c6053ecf DB |
286 | dev_dbg (&dev->dev, "PCI D3 suspend fail, %d\n", |
287 | retval); | |
1da177e4 | 288 | (void) usb_hcd_pci_resume (dev); |
1da177e4 | 289 | } |
5f827ea3 | 290 | |
18584999 | 291 | } else if (hcd->state != HC_STATE_HALT) { |
1da177e4 LT |
292 | dev_dbg (hcd->self.controller, "hcd state %d; not suspended\n", |
293 | hcd->state); | |
c6053ecf | 294 | WARN_ON(1); |
1da177e4 | 295 | retval = -EINVAL; |
1da177e4 LT |
296 | } |
297 | ||
5f827ea3 | 298 | done: |
21b1861f | 299 | if (retval == 0) { |
5f827ea3 | 300 | dev->dev.power.power_state = PMSG_SUSPEND; |
21b1861f DB |
301 | |
302 | #ifdef CONFIG_PPC_PMAC | |
303 | /* Disable ASIC clocks for USB */ | |
e8222502 | 304 | if (machine_is(powermac)) { |
21b1861f DB |
305 | struct device_node *of_node; |
306 | ||
307 | of_node = pci_device_to_OF_node (dev); | |
308 | if (of_node) | |
309 | pmac_call_feature(PMAC_FTR_USB_ENABLE, | |
310 | of_node, 0, 0); | |
311 | } | |
312 | #endif | |
313 | } | |
314 | ||
1da177e4 LT |
315 | return retval; |
316 | } | |
782e70c6 | 317 | EXPORT_SYMBOL_GPL(usb_hcd_pci_suspend); |
1da177e4 LT |
318 | |
319 | /** | |
320 | * usb_hcd_pci_resume - power management resume of a PCI-based HCD | |
321 | * @dev: USB Host Controller being resumed | |
322 | * | |
323 | * Store this function in the HCD's struct pci_driver as resume(). | |
324 | */ | |
325 | int usb_hcd_pci_resume (struct pci_dev *dev) | |
326 | { | |
327 | struct usb_hcd *hcd; | |
328 | int retval; | |
1da177e4 LT |
329 | |
330 | hcd = pci_get_drvdata(dev); | |
331 | if (hcd->state != HC_STATE_SUSPENDED) { | |
332 | dev_dbg (hcd->self.controller, | |
333 | "can't resume, not suspended!\n"); | |
334 | return 0; | |
335 | } | |
1da177e4 | 336 | |
21b1861f DB |
337 | #ifdef CONFIG_PPC_PMAC |
338 | /* Reenable ASIC clocks for USB */ | |
e8222502 | 339 | if (machine_is(powermac)) { |
21b1861f DB |
340 | struct device_node *of_node; |
341 | ||
342 | of_node = pci_device_to_OF_node (dev); | |
343 | if (of_node) | |
344 | pmac_call_feature (PMAC_FTR_USB_ENABLE, | |
345 | of_node, 0, 1); | |
346 | } | |
347 | #endif | |
348 | ||
c6053ecf DB |
349 | /* NOTE: chip docs cover clean "real suspend" cases (what Linux |
350 | * calls "standby", "suspend to RAM", and so on). There are also | |
351 | * dirty cases when swsusp fakes a suspend in "shutdown" mode. | |
352 | */ | |
353 | if (dev->current_state != PCI_D0) { | |
354 | #ifdef DEBUG | |
355 | int pci_pm; | |
356 | u16 pmcr; | |
357 | ||
358 | pci_pm = pci_find_capability(dev, PCI_CAP_ID_PM); | |
359 | pci_read_config_word(dev, pci_pm + PCI_PM_CTRL, &pmcr); | |
360 | pmcr &= PCI_PM_CTRL_STATE_MASK; | |
361 | if (pmcr) { | |
362 | /* Clean case: power to USB and to HC registers was | |
363 | * maintained; remote wakeup is easy. | |
364 | */ | |
365 | dev_dbg(hcd->self.controller, "resume from PCI D%d\n", | |
366 | pmcr); | |
367 | } else { | |
368 | /* Clean: HC lost Vcc power, D0 uninitialized | |
369 | * + Vaux may have preserved port and transceiver | |
370 | * state ... for remote wakeup from D3cold | |
371 | * + or not; HCD must reinit + re-enumerate | |
372 | * | |
373 | * Dirty: D0 semi-initialized cases with swsusp | |
374 | * + after BIOS init | |
375 | * + after Linux init (HCD statically linked) | |
376 | */ | |
377 | dev_dbg(hcd->self.controller, | |
378 | "PCI D0, from previous PCI D%d\n", | |
379 | dev->current_state); | |
380 | } | |
381 | #endif | |
5f827ea3 DB |
382 | /* yes, ignore these results too... */ |
383 | (void) pci_enable_wake (dev, dev->current_state, 0); | |
384 | (void) pci_enable_wake (dev, PCI_D3cold, 0); | |
c6053ecf DB |
385 | } else { |
386 | /* Same basic cases: clean (powered/not), dirty */ | |
387 | dev_dbg(hcd->self.controller, "PCI legacy resume\n"); | |
388 | } | |
389 | ||
390 | /* NOTE: the PCI API itself is asymmetric here. We don't need to | |
391 | * pci_set_power_state(PCI_D0) since that's part of re-enabling; | |
392 | * but that won't re-enable bus mastering. Yet pci_disable_device() | |
393 | * explicitly disables bus mastering... | |
394 | */ | |
395 | retval = pci_enable_device (dev); | |
396 | if (retval < 0) { | |
397 | dev_err (hcd->self.controller, | |
398 | "can't re-enable after resume, %d!\n", retval); | |
399 | return retval; | |
400 | } | |
401 | pci_set_master (dev); | |
402 | pci_restore_state (dev); | |
403 | ||
404 | dev->dev.power.power_state = PMSG_ON; | |
1da177e4 | 405 | |
8de98402 | 406 | clear_bit(HCD_FLAG_SAW_IRQ, &hcd->flags); |
1da177e4 | 407 | |
5f827ea3 DB |
408 | if (hcd->driver->resume) { |
409 | retval = hcd->driver->resume(hcd); | |
410 | if (retval) { | |
411 | dev_err (hcd->self.controller, | |
412 | "PCI post-resume error %d!\n", retval); | |
413 | usb_hc_died (hcd); | |
414 | } | |
1da177e4 LT |
415 | } |
416 | ||
417 | return retval; | |
418 | } | |
782e70c6 | 419 | EXPORT_SYMBOL_GPL(usb_hcd_pci_resume); |
1da177e4 LT |
420 | |
421 | #endif /* CONFIG_PM */ | |
422 | ||
64a21d02 AG |
423 | /** |
424 | * usb_hcd_pci_shutdown - shutdown host controller | |
425 | * @dev: USB Host Controller being shutdown | |
426 | */ | |
427 | void usb_hcd_pci_shutdown (struct pci_dev *dev) | |
428 | { | |
429 | struct usb_hcd *hcd; | |
430 | ||
431 | hcd = pci_get_drvdata(dev); | |
432 | if (!hcd) | |
433 | return; | |
434 | ||
435 | if (hcd->driver->shutdown) | |
436 | hcd->driver->shutdown(hcd); | |
437 | } | |
782e70c6 | 438 | EXPORT_SYMBOL_GPL(usb_hcd_pci_shutdown); |
1da177e4 | 439 |