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/config.h> 20 21 #ifdef CONFIG_USB_DEBUG 22 #define DEBUG 23 #else 24 #undef DEBUG 25 #endif 26 27 #include <linux/kernel.h> 28 #include <linux/module.h> 29 #include <linux/pci.h> 30 #include <asm/io.h> 31 #include <asm/irq.h> 32 #include <linux/usb.h> 33 #include "hcd.h" 34 35 36 /* PCI-based HCs are common, but plenty of non-PCI HCs are used too */ 37 38 39 /*-------------------------------------------------------------------------*/ 40 41 /* configure so an HC device and id are always provided */ 42 /* always called with process context; sleeping is OK */ 43 44 /** 45 * usb_hcd_pci_probe - initialize PCI-based HCDs 46 * @dev: USB Host Controller being probed 47 * @id: pci hotplug id connecting controller to HCD framework 48 * Context: !in_interrupt() 49 * 50 * Allocates basic PCI resources for this USB host controller, and 51 * then invokes the start() method for the HCD associated with it 52 * through the hotplug entry's driver_data. 53 * 54 * Store this function in the HCD's struct pci_driver as probe(). 55 */ 56 int usb_hcd_pci_probe (struct pci_dev *dev, const struct pci_device_id *id) 57 { 58 struct hc_driver *driver; 59 struct usb_hcd *hcd; 60 int retval; 61 62 if (usb_disabled()) 63 return -ENODEV; 64 65 if (!id || !(driver = (struct hc_driver *) id->driver_data)) 66 return -EINVAL; 67 68 if (pci_enable_device (dev) < 0) 69 return -ENODEV; 70 dev->current_state = PCI_D0; 71 dev->dev.power.power_state = PMSG_ON; 72 73 if (!dev->irq) { 74 dev_err (&dev->dev, 75 "Found HC with no IRQ. Check BIOS/PCI %s setup!\n", 76 pci_name(dev)); 77 retval = -ENODEV; 78 goto err1; 79 } 80 81 hcd = usb_create_hcd (driver, &dev->dev, pci_name(dev)); 82 if (!hcd) { 83 retval = -ENOMEM; 84 goto err1; 85 } 86 87 if (driver->flags & HCD_MEMORY) { // EHCI, OHCI 88 hcd->rsrc_start = pci_resource_start (dev, 0); 89 hcd->rsrc_len = pci_resource_len (dev, 0); 90 if (!request_mem_region (hcd->rsrc_start, hcd->rsrc_len, 91 driver->description)) { 92 dev_dbg (&dev->dev, "controller already in use\n"); 93 retval = -EBUSY; 94 goto err2; 95 } 96 hcd->regs = ioremap_nocache (hcd->rsrc_start, hcd->rsrc_len); 97 if (hcd->regs == NULL) { 98 dev_dbg (&dev->dev, "error mapping memory\n"); 99 retval = -EFAULT; 100 goto err3; 101 } 102 103 } else { // UHCI 104 int region; 105 106 for (region = 0; region < PCI_ROM_RESOURCE; region++) { 107 if (!(pci_resource_flags (dev, region) & 108 IORESOURCE_IO)) 109 continue; 110 111 hcd->rsrc_start = pci_resource_start (dev, region); 112 hcd->rsrc_len = pci_resource_len (dev, region); 113 if (request_region (hcd->rsrc_start, hcd->rsrc_len, 114 driver->description)) 115 break; 116 } 117 if (region == PCI_ROM_RESOURCE) { 118 dev_dbg (&dev->dev, "no i/o regions available\n"); 119 retval = -EBUSY; 120 goto err1; 121 } 122 } 123 124 #ifdef CONFIG_PCI_NAMES 125 hcd->product_desc = dev->pretty_name; 126 #endif 127 128 pci_set_master (dev); 129 130 retval = usb_add_hcd (hcd, dev->irq, SA_SHIRQ); 131 if (retval != 0) 132 goto err4; 133 return retval; 134 135 err4: 136 if (driver->flags & HCD_MEMORY) { 137 iounmap (hcd->regs); 138 err3: 139 release_mem_region (hcd->rsrc_start, hcd->rsrc_len); 140 } else 141 release_region (hcd->rsrc_start, hcd->rsrc_len); 142 err2: 143 usb_put_hcd (hcd); 144 err1: 145 pci_disable_device (dev); 146 dev_err (&dev->dev, "init %s fail, %d\n", pci_name(dev), retval); 147 return retval; 148 } 149 EXPORT_SYMBOL (usb_hcd_pci_probe); 150 151 152 /* may be called without controller electrically present */ 153 /* may be called with controller, bus, and devices active */ 154 155 /** 156 * usb_hcd_pci_remove - shutdown processing for PCI-based HCDs 157 * @dev: USB Host Controller being removed 158 * Context: !in_interrupt() 159 * 160 * Reverses the effect of usb_hcd_pci_probe(), first invoking 161 * the HCD's stop() method. It is always called from a thread 162 * context, normally "rmmod", "apmd", or something similar. 163 * 164 * Store this function in the HCD's struct pci_driver as remove(). 165 */ 166 void usb_hcd_pci_remove (struct pci_dev *dev) 167 { 168 struct usb_hcd *hcd; 169 170 hcd = pci_get_drvdata(dev); 171 if (!hcd) 172 return; 173 174 usb_remove_hcd (hcd); 175 if (hcd->driver->flags & HCD_MEMORY) { 176 iounmap (hcd->regs); 177 release_mem_region (hcd->rsrc_start, hcd->rsrc_len); 178 } else { 179 release_region (hcd->rsrc_start, hcd->rsrc_len); 180 } 181 usb_put_hcd (hcd); 182 pci_disable_device(dev); 183 } 184 EXPORT_SYMBOL (usb_hcd_pci_remove); 185 186 187 #ifdef CONFIG_PM 188 189 /** 190 * usb_hcd_pci_suspend - power management suspend of a PCI-based HCD 191 * @dev: USB Host Controller being suspended 192 * @message: semantics in flux 193 * 194 * Store this function in the HCD's struct pci_driver as suspend(). 195 */ 196 int usb_hcd_pci_suspend (struct pci_dev *dev, pm_message_t message) 197 { 198 struct usb_hcd *hcd; 199 int retval = 0; 200 int has_pci_pm; 201 202 hcd = pci_get_drvdata(dev); 203 204 /* FIXME until the generic PM interfaces change a lot more, this 205 * can't use PCI D1 and D2 states. For example, the confusion 206 * between messages and states will need to vanish, and messages 207 * will need to provide a target system state again. 208 * 209 * It'll be important to learn characteristics of the target state, 210 * especially on embedded hardware where the HCD will often be in 211 * charge of an external VBUS power supply and one or more clocks. 212 * Some target system states will leave them active; others won't. 213 * (With PCI, that's often handled by platform BIOS code.) 214 */ 215 216 /* even when the PCI layer rejects some of the PCI calls 217 * below, HCs can try global suspend and reduce DMA traffic. 218 * PM-sensitive HCDs may already have done this. 219 */ 220 has_pci_pm = pci_find_capability(dev, PCI_CAP_ID_PM); 221 222 switch (hcd->state) { 223 224 /* entry if root hub wasn't yet suspended ... from sysfs, 225 * without autosuspend, or if USB_SUSPEND isn't configured. 226 */ 227 case HC_STATE_RUNNING: 228 hcd->state = HC_STATE_QUIESCING; 229 retval = hcd->driver->suspend (hcd, message); 230 if (retval) { 231 dev_dbg (hcd->self.controller, 232 "suspend fail, retval %d\n", 233 retval); 234 break; 235 } 236 hcd->state = HC_STATE_SUSPENDED; 237 /* FALLTHROUGH */ 238 239 /* entry with CONFIG_USB_SUSPEND, or hcds that autosuspend: the 240 * controller and/or root hub will already have been suspended, 241 * but it won't be ready for a PCI resume call. 242 * 243 * FIXME only CONFIG_USB_SUSPEND guarantees hub_suspend() will 244 * have been called, otherwise root hub timers still run ... 245 */ 246 case HC_STATE_SUSPENDED: 247 /* no DMA or IRQs except when HC is active */ 248 if (dev->current_state == PCI_D0) { 249 free_irq (hcd->irq, hcd); 250 pci_save_state (dev); 251 pci_disable_device (dev); 252 } 253 254 if (!has_pci_pm) { 255 dev_dbg (hcd->self.controller, "--> PCI D0/legacy\n"); 256 break; 257 } 258 259 /* NOTE: dev->current_state becomes nonzero only here, and 260 * only for devices that support PCI PM. Also, exiting 261 * PCI_D3 (but not PCI_D1 or PCI_D2) is allowed to reset 262 * some device state (e.g. as part of clock reinit). 263 */ 264 retval = pci_set_power_state (dev, PCI_D3hot); 265 if (retval == 0) { 266 dev_dbg (hcd->self.controller, "--> PCI D3\n"); 267 pci_enable_wake (dev, PCI_D3hot, hcd->remote_wakeup); 268 pci_enable_wake (dev, PCI_D3cold, hcd->remote_wakeup); 269 } else if (retval < 0) { 270 dev_dbg (&dev->dev, "PCI D3 suspend fail, %d\n", 271 retval); 272 (void) usb_hcd_pci_resume (dev); 273 break; 274 } 275 break; 276 default: 277 dev_dbg (hcd->self.controller, "hcd state %d; not suspended\n", 278 hcd->state); 279 WARN_ON(1); 280 retval = -EINVAL; 281 break; 282 } 283 284 /* update power_state **ONLY** to make sysfs happier */ 285 if (retval == 0) 286 dev->dev.power.power_state = message; 287 return retval; 288 } 289 EXPORT_SYMBOL (usb_hcd_pci_suspend); 290 291 /** 292 * usb_hcd_pci_resume - power management resume of a PCI-based HCD 293 * @dev: USB Host Controller being resumed 294 * 295 * Store this function in the HCD's struct pci_driver as resume(). 296 */ 297 int usb_hcd_pci_resume (struct pci_dev *dev) 298 { 299 struct usb_hcd *hcd; 300 int retval; 301 302 hcd = pci_get_drvdata(dev); 303 if (hcd->state != HC_STATE_SUSPENDED) { 304 dev_dbg (hcd->self.controller, 305 "can't resume, not suspended!\n"); 306 return 0; 307 } 308 309 /* NOTE: chip docs cover clean "real suspend" cases (what Linux 310 * calls "standby", "suspend to RAM", and so on). There are also 311 * dirty cases when swsusp fakes a suspend in "shutdown" mode. 312 */ 313 if (dev->current_state != PCI_D0) { 314 #ifdef DEBUG 315 int pci_pm; 316 u16 pmcr; 317 318 pci_pm = pci_find_capability(dev, PCI_CAP_ID_PM); 319 pci_read_config_word(dev, pci_pm + PCI_PM_CTRL, &pmcr); 320 pmcr &= PCI_PM_CTRL_STATE_MASK; 321 if (pmcr) { 322 /* Clean case: power to USB and to HC registers was 323 * maintained; remote wakeup is easy. 324 */ 325 dev_dbg(hcd->self.controller, "resume from PCI D%d\n", 326 pmcr); 327 } else { 328 /* Clean: HC lost Vcc power, D0 uninitialized 329 * + Vaux may have preserved port and transceiver 330 * state ... for remote wakeup from D3cold 331 * + or not; HCD must reinit + re-enumerate 332 * 333 * Dirty: D0 semi-initialized cases with swsusp 334 * + after BIOS init 335 * + after Linux init (HCD statically linked) 336 */ 337 dev_dbg(hcd->self.controller, 338 "PCI D0, from previous PCI D%d\n", 339 dev->current_state); 340 } 341 #endif 342 pci_enable_wake (dev, dev->current_state, 0); 343 pci_enable_wake (dev, PCI_D3cold, 0); 344 } else { 345 /* Same basic cases: clean (powered/not), dirty */ 346 dev_dbg(hcd->self.controller, "PCI legacy resume\n"); 347 } 348 349 /* NOTE: the PCI API itself is asymmetric here. We don't need to 350 * pci_set_power_state(PCI_D0) since that's part of re-enabling; 351 * but that won't re-enable bus mastering. Yet pci_disable_device() 352 * explicitly disables bus mastering... 353 */ 354 retval = pci_enable_device (dev); 355 if (retval < 0) { 356 dev_err (hcd->self.controller, 357 "can't re-enable after resume, %d!\n", retval); 358 return retval; 359 } 360 pci_set_master (dev); 361 pci_restore_state (dev); 362 363 dev->dev.power.power_state = PMSG_ON; 364 365 hcd->state = HC_STATE_RESUMING; 366 hcd->saw_irq = 0; 367 retval = request_irq (dev->irq, usb_hcd_irq, SA_SHIRQ, 368 hcd->irq_descr, hcd); 369 if (retval < 0) { 370 dev_err (hcd->self.controller, 371 "can't restore IRQ after resume!\n"); 372 usb_hc_died (hcd); 373 return retval; 374 } 375 376 retval = hcd->driver->resume (hcd); 377 if (!HC_IS_RUNNING (hcd->state)) { 378 dev_dbg (hcd->self.controller, 379 "resume fail, retval %d\n", retval); 380 usb_hc_died (hcd); 381 } 382 383 pci_enable_device(dev); 384 return retval; 385 } 386 EXPORT_SYMBOL (usb_hcd_pci_resume); 387 388 #endif /* CONFIG_PM */ 389 390 391