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 19#include <linux/kernel.h> 20#include <linux/module.h> 21#include <linux/pci.h> 22#include <linux/usb.h> 23 24#include <asm/io.h> 25#include <asm/irq.h> 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 33 34#include "usb.h" 35#include "hcd.h" 36 37 38/* PCI-based HCs are common, but plenty of non-PCI HCs are used too */ 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 */ 58int 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; 72 dev->current_state = PCI_D0; 73 dev->dev.power.power_state = PMSG_ON; 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 126 pci_set_master (dev); 127 128 retval = usb_add_hcd (hcd, dev->irq, IRQF_SHARED); 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} 147EXPORT_SYMBOL (usb_hcd_pci_probe); 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 */ 164void 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} 182EXPORT_SYMBOL (usb_hcd_pci_remove); 183 184 185#ifdef CONFIG_PM 186 187/** 188 * usb_hcd_pci_suspend - power management suspend of a PCI-based HCD 189 * @dev: USB Host Controller being suspended 190 * @message: semantics in flux 191 * 192 * Store this function in the HCD's struct pci_driver as suspend(). 193 */ 194int usb_hcd_pci_suspend (struct pci_dev *dev, pm_message_t message) 195{ 196 struct usb_hcd *hcd; 197 int retval = 0; 198 int has_pci_pm; 199 200 hcd = pci_get_drvdata(dev); 201 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 */ 210 if (hcd->self.root_hub->dev.power.power_state.event == PM_EVENT_ON) 211 return -EBUSY; 212 213 if (hcd->driver->suspend) { 214 retval = hcd->driver->suspend(hcd, message); 215 suspend_report_result(hcd->driver->suspend, retval); 216 if (retval) 217 goto done; 218 } 219 synchronize_irq(dev->irq); 220 221 222 /* even when the PCI layer rejects some of the PCI calls 223 * below, HCs can try global suspend and reduce DMA traffic. 224 * PM-sensitive HCDs may already have done this. 225 */ 226 has_pci_pm = pci_find_capability(dev, PCI_CAP_ID_PM); 227 228 /* Downstream ports from this root hub should already be quiesced, so 229 * there will be no DMA activity. Now we can shut down the upstream 230 * link (except maybe for PME# resume signaling) and enter some PCI 231 * low power state, if the hardware allows. 232 */ 233 if (hcd->state == HC_STATE_SUSPENDED) { 234 235 /* no DMA or IRQs except when HC is active */ 236 if (dev->current_state == PCI_D0) { 237 pci_save_state (dev); 238 pci_disable_device (dev); 239 } 240 241 if (!has_pci_pm) { 242 dev_dbg (hcd->self.controller, "--> PCI D0/legacy\n"); 243 goto done; 244 } 245 246 /* NOTE: dev->current_state becomes nonzero only here, and 247 * only for devices that support PCI PM. Also, exiting 248 * PCI_D3 (but not PCI_D1 or PCI_D2) is allowed to reset 249 * some device state (e.g. as part of clock reinit). 250 */ 251 retval = pci_set_power_state (dev, PCI_D3hot); 252 suspend_report_result(pci_set_power_state, retval); 253 if (retval == 0) { 254 int wake = device_can_wakeup(&hcd->self.root_hub->dev); 255 256 wake = wake && device_may_wakeup(hcd->self.controller); 257 258 dev_dbg (hcd->self.controller, "--> PCI D3%s\n", 259 wake ? "/wakeup" : ""); 260 261 /* Ignore these return values. We rely on pci code to 262 * reject requests the hardware can't implement, rather 263 * than coding the same thing. 264 */ 265 (void) pci_enable_wake (dev, PCI_D3hot, wake); 266 (void) pci_enable_wake (dev, PCI_D3cold, wake); 267 } else { 268 dev_dbg (&dev->dev, "PCI D3 suspend fail, %d\n", 269 retval); 270 (void) usb_hcd_pci_resume (dev); 271 } 272 273 } else if (hcd->state != HC_STATE_HALT) { 274 dev_dbg (hcd->self.controller, "hcd state %d; not suspended\n", 275 hcd->state); 276 WARN_ON(1); 277 retval = -EINVAL; 278 } 279 280done: 281 if (retval == 0) { 282 dev->dev.power.power_state = PMSG_SUSPEND; 283 284#ifdef CONFIG_PPC_PMAC 285 /* Disable ASIC clocks for USB */ 286 if (machine_is(powermac)) { 287 struct device_node *of_node; 288 289 of_node = pci_device_to_OF_node (dev); 290 if (of_node) 291 pmac_call_feature(PMAC_FTR_USB_ENABLE, 292 of_node, 0, 0); 293 } 294#endif 295 } 296 297 return retval; 298} 299EXPORT_SYMBOL (usb_hcd_pci_suspend); 300 301/** 302 * usb_hcd_pci_resume - power management resume of a PCI-based HCD 303 * @dev: USB Host Controller being resumed 304 * 305 * Store this function in the HCD's struct pci_driver as resume(). 306 */ 307int usb_hcd_pci_resume (struct pci_dev *dev) 308{ 309 struct usb_hcd *hcd; 310 int retval; 311 312 hcd = pci_get_drvdata(dev); 313 if (hcd->state != HC_STATE_SUSPENDED) { 314 dev_dbg (hcd->self.controller, 315 "can't resume, not suspended!\n"); 316 return 0; 317 } 318 319#ifdef CONFIG_PPC_PMAC 320 /* Reenable ASIC clocks for USB */ 321 if (machine_is(powermac)) { 322 struct device_node *of_node; 323 324 of_node = pci_device_to_OF_node (dev); 325 if (of_node) 326 pmac_call_feature (PMAC_FTR_USB_ENABLE, 327 of_node, 0, 1); 328 } 329#endif 330 331 /* NOTE: chip docs cover clean "real suspend" cases (what Linux 332 * calls "standby", "suspend to RAM", and so on). There are also 333 * dirty cases when swsusp fakes a suspend in "shutdown" mode. 334 */ 335 if (dev->current_state != PCI_D0) { 336#ifdef DEBUG 337 int pci_pm; 338 u16 pmcr; 339 340 pci_pm = pci_find_capability(dev, PCI_CAP_ID_PM); 341 pci_read_config_word(dev, pci_pm + PCI_PM_CTRL, &pmcr); 342 pmcr &= PCI_PM_CTRL_STATE_MASK; 343 if (pmcr) { 344 /* Clean case: power to USB and to HC registers was 345 * maintained; remote wakeup is easy. 346 */ 347 dev_dbg(hcd->self.controller, "resume from PCI D%d\n", 348 pmcr); 349 } else { 350 /* Clean: HC lost Vcc power, D0 uninitialized 351 * + Vaux may have preserved port and transceiver 352 * state ... for remote wakeup from D3cold 353 * + or not; HCD must reinit + re-enumerate 354 * 355 * Dirty: D0 semi-initialized cases with swsusp 356 * + after BIOS init 357 * + after Linux init (HCD statically linked) 358 */ 359 dev_dbg(hcd->self.controller, 360 "PCI D0, from previous PCI D%d\n", 361 dev->current_state); 362 } 363#endif 364 /* yes, ignore these results too... */ 365 (void) pci_enable_wake (dev, dev->current_state, 0); 366 (void) pci_enable_wake (dev, PCI_D3cold, 0); 367 } else { 368 /* Same basic cases: clean (powered/not), dirty */ 369 dev_dbg(hcd->self.controller, "PCI legacy resume\n"); 370 } 371 372 /* NOTE: the PCI API itself is asymmetric here. We don't need to 373 * pci_set_power_state(PCI_D0) since that's part of re-enabling; 374 * but that won't re-enable bus mastering. Yet pci_disable_device() 375 * explicitly disables bus mastering... 376 */ 377 retval = pci_enable_device (dev); 378 if (retval < 0) { 379 dev_err (hcd->self.controller, 380 "can't re-enable after resume, %d!\n", retval); 381 return retval; 382 } 383 pci_set_master (dev); 384 pci_restore_state (dev); 385 386 dev->dev.power.power_state = PMSG_ON; 387 388 clear_bit(HCD_FLAG_SAW_IRQ, &hcd->flags); 389 390 if (hcd->driver->resume) { 391 retval = hcd->driver->resume(hcd); 392 if (retval) { 393 dev_err (hcd->self.controller, 394 "PCI post-resume error %d!\n", retval); 395 usb_hc_died (hcd); 396 } 397 } 398 399 return retval; 400} 401EXPORT_SYMBOL (usb_hcd_pci_resume); 402 403#endif /* CONFIG_PM */ 404 405/** 406 * usb_hcd_pci_shutdown - shutdown host controller 407 * @dev: USB Host Controller being shutdown 408 */ 409void usb_hcd_pci_shutdown (struct pci_dev *dev) 410{ 411 struct usb_hcd *hcd; 412 413 hcd = pci_get_drvdata(dev); 414 if (!hcd) 415 return; 416 417 if (hcd->driver->shutdown) 418 hcd->driver->shutdown(hcd); 419} 420EXPORT_SYMBOL (usb_hcd_pci_shutdown); 421