blob: 083e8df0a817f83b925ac397f5e90cb43b8af1d2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * OHCI HCD (Host Controller Driver) for USB.
3 *
4 * (C) Copyright 1999 Roman Weissgaerber <weissg@vienna.at>
5 * (C) Copyright 2000-2002 David Brownell <dbrownell@users.sourceforge.net>
David Brownelldd9048a2006-12-05 03:18:31 -08006 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * [ Initialisation is based on Linus' ]
8 * [ uhci code and gregs ohci fragments ]
9 * [ (C) Copyright 1999 Linus Torvalds ]
10 * [ (C) Copyright 1999 Gregory P. Smith]
David Brownelldd9048a2006-12-05 03:18:31 -080011 *
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 * PCI Bus Glue
13 *
14 * This file is licenced under the GPL.
15 */
David Brownelldd9048a2006-12-05 03:18:31 -080016
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#ifndef CONFIG_PCI
18#error "This file is PCI bus glue. CONFIG_PCI must be defined."
19#endif
20
Libin Yangab1666c2008-08-08 15:03:31 +080021#include <linux/pci.h>
22#include <linux/io.h>
23
24
25/* constants used to work around PM-related transfer
26 * glitches in some AMD 700 series southbridges
27 */
28#define AB_REG_BAR 0xf0
29#define AB_INDX(addr) ((addr) + 0x00)
30#define AB_DATA(addr) ((addr) + 0x04)
31#define AX_INDXC 0X30
32#define AX_DATAC 0x34
33
34#define NB_PCIE_INDX_ADDR 0xe0
35#define NB_PCIE_INDX_DATA 0xe4
36#define PCIE_P_CNTL 0x10040
37#define BIF_NB 0x10002
38
39static struct pci_dev *amd_smbus_dev;
40static struct pci_dev *amd_hb_dev;
41static int amd_ohci_iso_count;
42
Linus Torvalds1da177e2005-04-16 15:20:36 -070043/*-------------------------------------------------------------------------*/
44
David Brownell931384f2007-04-17 13:06:29 -070045static int broken_suspend(struct usb_hcd *hcd)
46{
47 device_init_wakeup(&hcd->self.root_hub->dev, 0);
48 return 0;
49}
50
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +110051/* AMD 756, for most chips (early revs), corrupts register
52 * values on read ... so enable the vendor workaround.
53 */
David Brownell931384f2007-04-17 13:06:29 -070054static int ohci_quirk_amd756(struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -070055{
56 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
57
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +110058 ohci->flags = OHCI_QUIRK_AMD756;
59 ohci_dbg (ohci, "AMD756 erratum 4 workaround\n");
60
61 /* also erratum 10 (suspend/resume issues) */
David Brownell931384f2007-04-17 13:06:29 -070062 return broken_suspend(hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063}
64
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +110065/* Apple's OHCI driver has a lot of bizarre workarounds
66 * for this chip. Evidently control and bulk lists
67 * can get confused. (B&W G3 models, and ...)
68 */
David Brownell931384f2007-04-17 13:06:29 -070069static int ohci_quirk_opti(struct usb_hcd *hcd)
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +110070{
71 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
72
73 ohci_dbg (ohci, "WARNING: OPTi workarounds unavailable\n");
74
75 return 0;
76}
77
78/* Check for NSC87560. We have to look at the bridge (fn1) to
79 * identify the USB (fn2). This quirk might apply to more or
80 * even all NSC stuff.
81 */
David Brownell931384f2007-04-17 13:06:29 -070082static int ohci_quirk_ns(struct usb_hcd *hcd)
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +110083{
84 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
85 struct pci_dev *b;
86
87 b = pci_get_slot (pdev->bus, PCI_DEVFN (PCI_SLOT (pdev->devfn), 1));
88 if (b && b->device == PCI_DEVICE_ID_NS_87560_LIO
89 && b->vendor == PCI_VENDOR_ID_NS) {
90 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
91
92 ohci->flags |= OHCI_QUIRK_SUPERIO;
93 ohci_dbg (ohci, "Using NSC SuperIO setup\n");
94 }
95 pci_dev_put(b);
96
97 return 0;
98}
99
100/* Check for Compaq's ZFMicro chipset, which needs short
101 * delays before control or bulk queues get re-activated
102 * in finish_unlinks()
103 */
David Brownell931384f2007-04-17 13:06:29 -0700104static int ohci_quirk_zfmicro(struct usb_hcd *hcd)
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +1100105{
106 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
107
108 ohci->flags |= OHCI_QUIRK_ZFMICRO;
Mike Nuss89a0fd12007-08-01 13:24:30 -0700109 ohci_dbg(ohci, "enabled Compaq ZFMicro chipset quirks\n");
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +1100110
111 return 0;
112}
113
Benjamin Herrenschmidt11d1a4a2006-12-15 06:54:03 +1100114/* Check for Toshiba SCC OHCI which has big endian registers
115 * and little endian in memory data structures
116 */
David Brownell931384f2007-04-17 13:06:29 -0700117static int ohci_quirk_toshiba_scc(struct usb_hcd *hcd)
Benjamin Herrenschmidt11d1a4a2006-12-15 06:54:03 +1100118{
119 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
120
121 /* That chip is only present in the southbridge of some
122 * cell based platforms which are supposed to select
123 * CONFIG_USB_OHCI_BIG_ENDIAN_MMIO. We verify here if
124 * that was the case though.
125 */
126#ifdef CONFIG_USB_OHCI_BIG_ENDIAN_MMIO
127 ohci->flags |= OHCI_QUIRK_BE_MMIO;
128 ohci_dbg (ohci, "enabled big endian Toshiba quirk\n");
129 return 0;
130#else
131 ohci_err (ohci, "unsupported big endian Toshiba quirk\n");
132 return -ENXIO;
133#endif
134}
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +1100135
Michael Hanselmannd576bb92007-05-31 23:34:27 +0200136/* Check for NEC chip and apply quirk for allegedly lost interrupts.
137 */
Mike Nuss89a0fd12007-08-01 13:24:30 -0700138
139static void ohci_quirk_nec_worker(struct work_struct *work)
140{
141 struct ohci_hcd *ohci = container_of(work, struct ohci_hcd, nec_work);
142 int status;
143
144 status = ohci_init(ohci);
145 if (status != 0) {
146 ohci_err(ohci, "Restarting NEC controller failed in %s, %d\n",
147 "ohci_init", status);
148 return;
149 }
150
151 status = ohci_restart(ohci);
152 if (status != 0)
153 ohci_err(ohci, "Restarting NEC controller failed in %s, %d\n",
154 "ohci_restart", status);
155}
156
Michael Hanselmannd576bb92007-05-31 23:34:27 +0200157static int ohci_quirk_nec(struct usb_hcd *hcd)
158{
159 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
160
161 ohci->flags |= OHCI_QUIRK_NEC;
Mike Nuss89a0fd12007-08-01 13:24:30 -0700162 INIT_WORK(&ohci->nec_work, ohci_quirk_nec_worker);
Michael Hanselmannd576bb92007-05-31 23:34:27 +0200163 ohci_dbg (ohci, "enabled NEC chipset lost interrupt quirk\n");
164
165 return 0;
166}
167
Libin Yangab1666c2008-08-08 15:03:31 +0800168static int ohci_quirk_amd700(struct usb_hcd *hcd)
169{
170 struct ohci_hcd *ohci = hcd_to_ohci(hcd);
171 u8 rev = 0;
172
173 if (!amd_smbus_dev)
174 amd_smbus_dev = pci_get_device(PCI_VENDOR_ID_ATI,
175 PCI_DEVICE_ID_ATI_SBX00_SMBUS, NULL);
176 if (!amd_smbus_dev)
177 return 0;
178
179 pci_read_config_byte(amd_smbus_dev, PCI_REVISION_ID, &rev);
180 if ((rev > 0x3b) || (rev < 0x30)) {
181 pci_dev_put(amd_smbus_dev);
182 amd_smbus_dev = NULL;
183 return 0;
184 }
185
186 amd_ohci_iso_count++;
187
188 if (!amd_hb_dev)
189 amd_hb_dev = pci_get_device(PCI_VENDOR_ID_AMD, 0x9600, NULL);
190
191 ohci->flags |= OHCI_QUIRK_AMD_ISO;
192 ohci_dbg(ohci, "enabled AMD ISO transfers quirk\n");
193
194 return 0;
195}
196
197/*
198 * The hardware normally enables the A-link power management feature, which
199 * lets the system lower the power consumption in idle states.
200 *
201 * Assume the system is configured to have USB 1.1 ISO transfers going
202 * to or from a USB device. Without this quirk, that stream may stutter
203 * or have breaks occasionally. For transfers going to speakers, this
204 * makes a very audible mess...
205 *
206 * That audio playback corruption is due to the audio stream getting
207 * interrupted occasionally when the link goes in lower power state
208 * This USB quirk prevents the link going into that lower power state
209 * during audio playback or other ISO operations.
210 */
211static void quirk_amd_pll(int on)
212{
213 u32 addr;
214 u32 val;
215 u32 bit = (on > 0) ? 1 : 0;
216
217 pci_read_config_dword(amd_smbus_dev, AB_REG_BAR, &addr);
218
219 /* BIT names/meanings are NDA-protected, sorry ... */
220
221 outl(AX_INDXC, AB_INDX(addr));
222 outl(0x40, AB_DATA(addr));
223 outl(AX_DATAC, AB_INDX(addr));
224 val = inl(AB_DATA(addr));
225 val &= ~((1 << 3) | (1 << 4) | (1 << 9));
226 val |= (bit << 3) | ((!bit) << 4) | ((!bit) << 9);
227 outl(val, AB_DATA(addr));
228
229 if (amd_hb_dev) {
230 addr = PCIE_P_CNTL;
231 pci_write_config_dword(amd_hb_dev, NB_PCIE_INDX_ADDR, addr);
232
233 pci_read_config_dword(amd_hb_dev, NB_PCIE_INDX_DATA, &val);
234 val &= ~(1 | (1 << 3) | (1 << 4) | (1 << 9) | (1 << 12));
235 val |= bit | (bit << 3) | (bit << 12);
236 val |= ((!bit) << 4) | ((!bit) << 9);
237 pci_write_config_dword(amd_hb_dev, NB_PCIE_INDX_DATA, val);
238
239 addr = BIF_NB;
240 pci_write_config_dword(amd_hb_dev, NB_PCIE_INDX_ADDR, addr);
241
242 pci_read_config_dword(amd_hb_dev, NB_PCIE_INDX_DATA, &val);
243 val &= ~(1 << 8);
244 val |= bit << 8;
245 pci_write_config_dword(amd_hb_dev, NB_PCIE_INDX_DATA, val);
246 }
247}
248
249static void amd_iso_dev_put(void)
250{
251 amd_ohci_iso_count--;
252 if (amd_ohci_iso_count == 0) {
253 if (amd_smbus_dev) {
254 pci_dev_put(amd_smbus_dev);
255 amd_smbus_dev = NULL;
256 }
257 if (amd_hb_dev) {
258 pci_dev_put(amd_hb_dev);
259 amd_hb_dev = NULL;
260 }
261 }
262
263}
264
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +1100265/* List of quirks for OHCI */
266static const struct pci_device_id ohci_pci_quirks[] = {
267 {
268 PCI_DEVICE(PCI_VENDOR_ID_AMD, 0x740c),
269 .driver_data = (unsigned long)ohci_quirk_amd756,
270 },
271 {
272 PCI_DEVICE(PCI_VENDOR_ID_OPTI, 0xc861),
273 .driver_data = (unsigned long)ohci_quirk_opti,
274 },
275 {
276 PCI_DEVICE(PCI_VENDOR_ID_NS, PCI_ANY_ID),
277 .driver_data = (unsigned long)ohci_quirk_ns,
278 },
279 {
280 PCI_DEVICE(PCI_VENDOR_ID_COMPAQ, 0xa0f8),
281 .driver_data = (unsigned long)ohci_quirk_zfmicro,
282 },
Benjamin Herrenschmidt11d1a4a2006-12-15 06:54:03 +1100283 {
284 PCI_DEVICE(PCI_VENDOR_ID_TOSHIBA_2, 0x01b6),
285 .driver_data = (unsigned long)ohci_quirk_toshiba_scc,
286 },
David Brownell931384f2007-04-17 13:06:29 -0700287 {
Michael Hanselmannd576bb92007-05-31 23:34:27 +0200288 PCI_DEVICE(PCI_VENDOR_ID_NEC, PCI_DEVICE_ID_NEC_USB),
289 .driver_data = (unsigned long)ohci_quirk_nec,
290 },
291 {
David Brownell931384f2007-04-17 13:06:29 -0700292 /* Toshiba portege 4000 */
293 .vendor = PCI_VENDOR_ID_AL,
294 .device = 0x5237,
Andrey Borzenkov8ab5e8c2007-05-19 14:23:28 -0700295 .subvendor = PCI_VENDOR_ID_TOSHIBA,
David Brownell931384f2007-04-17 13:06:29 -0700296 .subdevice = 0x0004,
297 .driver_data = (unsigned long) broken_suspend,
298 },
Raphael Assenat33f73e52007-04-17 13:09:18 -0700299 {
300 PCI_DEVICE(PCI_VENDOR_ID_ITE, 0x8152),
301 .driver_data = (unsigned long) broken_suspend,
302 },
Libin Yangab1666c2008-08-08 15:03:31 +0800303 {
304 PCI_DEVICE(PCI_VENDOR_ID_ATI, 0x4397),
305 .driver_data = (unsigned long)ohci_quirk_amd700,
306 },
307 {
308 PCI_DEVICE(PCI_VENDOR_ID_ATI, 0x4398),
309 .driver_data = (unsigned long)ohci_quirk_amd700,
310 },
311 {
312 PCI_DEVICE(PCI_VENDOR_ID_ATI, 0x4399),
313 .driver_data = (unsigned long)ohci_quirk_amd700,
314 },
315
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +1100316 /* FIXME for some of the early AMD 760 southbridges, OHCI
317 * won't work at all. blacklist them.
318 */
Benjamin Herrenschmidt11d1a4a2006-12-15 06:54:03 +1100319
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +1100320 {},
321};
322
323static int ohci_pci_reset (struct usb_hcd *hcd)
324{
325 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
326 int ret = 0;
327
328 if (hcd->self.controller) {
329 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
330 const struct pci_device_id *quirk_id;
331
332 quirk_id = pci_match_id(ohci_pci_quirks, pdev);
333 if (quirk_id != NULL) {
334 int (*quirk)(struct usb_hcd *ohci);
335 quirk = (void *)quirk_id->driver_data;
336 ret = quirk(hcd);
337 }
338 }
339 if (ret == 0) {
340 ohci_hcd_init (ohci);
341 return ohci_init (ohci);
342 }
343 return ret;
344}
345
346
347static int __devinit ohci_pci_start (struct usb_hcd *hcd)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348{
349 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
350 int ret;
351
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +1100352#ifdef CONFIG_PM /* avoid warnings about unused pdev */
David Brownell6a9062f2006-01-23 15:28:07 -0800353 if (hcd->self.controller) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
355
David Brownell6a9062f2006-01-23 15:28:07 -0800356 /* RWC may not be set for add-in PCI cards, since boot
357 * firmware probably ignored them. This transfers PCI
358 * PM wakeup capabilities (once the PCI layer is fixed).
359 */
360 if (device_may_wakeup(&pdev->dev))
361 ohci->hc_control |= OHCI_CTRL_RWC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362 }
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +1100363#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +1100365 ret = ohci_run (ohci);
366 if (ret < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 ohci_err (ohci, "can't start\n");
368 ohci_stop (hcd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 }
Benjamin Herrenschmidt4302a592006-12-15 06:53:55 +1100370 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371}
372
373#ifdef CONFIG_PM
374
David Brownell9a5d3e92005-04-18 17:39:23 -0700375static int ohci_pci_suspend (struct usb_hcd *hcd, pm_message_t message)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376{
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100377 struct ohci_hcd *ohci = hcd_to_ohci (hcd);
378 unsigned long flags;
379 int rc = 0;
380
381 /* Root hub was already suspended. Disable irq emission and
382 * mark HW unaccessible, bail out if RH has been resumed. Use
383 * the spinlock to properly synchronize with possible pending
384 * RH suspend or resume activity.
385 *
386 * This is still racy as hcd->state is manipulated outside of
387 * any locks =P But that will be a different fix.
388 */
389 spin_lock_irqsave (&ohci->lock, flags);
390 if (hcd->state != HC_STATE_SUSPENDED) {
391 rc = -EINVAL;
392 goto bail;
393 }
394 ohci_writel(ohci, OHCI_INTR_MIE, &ohci->regs->intrdisable);
395 (void)ohci_readl(ohci, &ohci->regs->intrdisable);
David Brownell18584992006-08-14 23:11:06 -0700396
397 /* make sure snapshot being resumed re-enumerates everything */
398 if (message.event == PM_EVENT_PRETHAW)
399 ohci_usb_reset(ohci);
400
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100401 clear_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
402 bail:
403 spin_unlock_irqrestore (&ohci->lock, flags);
404
405 return rc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406}
407
408
409static int ohci_pci_resume (struct usb_hcd *hcd)
410{
Benjamin Herrenschmidt8de98402005-11-25 09:59:46 +1100411 set_bit(HCD_FLAG_HW_ACCESSIBLE, &hcd->flags);
Alan Stern43bbb7e2008-04-03 18:03:17 -0400412 ohci_finish_controller_resume(hcd);
David Brownellf197b2c2005-09-22 22:42:53 -0700413 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414}
415
416#endif /* CONFIG_PM */
417
418
419/*-------------------------------------------------------------------------*/
420
421static const struct hc_driver ohci_pci_hc_driver = {
422 .description = hcd_name,
423 .product_desc = "OHCI Host Controller",
424 .hcd_priv_size = sizeof(struct ohci_hcd),
425
426 /*
427 * generic hardware linkage
428 */
429 .irq = ohci_irq,
430 .flags = HCD_MEMORY | HCD_USB11,
431
432 /*
433 * basic lifecycle operations
434 */
435 .reset = ohci_pci_reset,
436 .start = ohci_pci_start,
David Brownelld4139842006-08-04 11:31:55 -0700437 .stop = ohci_stop,
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700438 .shutdown = ohci_shutdown,
David Brownelld4139842006-08-04 11:31:55 -0700439
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440#ifdef CONFIG_PM
Alan Stern7be7d742008-04-03 18:03:06 -0400441 .pci_suspend = ohci_pci_suspend,
442 .pci_resume = ohci_pci_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
445 /*
446 * managing i/o requests and associated device resources
447 */
448 .urb_enqueue = ohci_urb_enqueue,
449 .urb_dequeue = ohci_urb_dequeue,
450 .endpoint_disable = ohci_endpoint_disable,
451
452 /*
453 * scheduling support
454 */
455 .get_frame_number = ohci_get_frame,
456
457 /*
458 * root hub support
459 */
460 .hub_status_data = ohci_hub_status_data,
461 .hub_control = ohci_hub_control,
Linus Torvalds09ca8ad2008-07-06 10:27:25 -0700462 .hub_irq_enable = ohci_rhsc_enable,
David Brownell8ad7fe12005-09-13 19:59:11 -0700463#ifdef CONFIG_PM
Alan Stern0c0382e2005-10-13 17:08:02 -0400464 .bus_suspend = ohci_bus_suspend,
465 .bus_resume = ohci_bus_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466#endif
467 .start_port_reset = ohci_start_port_reset,
468};
469
470/*-------------------------------------------------------------------------*/
471
472
473static const struct pci_device_id pci_ids [] = { {
474 /* handle any USB OHCI controller */
Jean Delvarec67808e2006-04-09 20:07:35 +0200475 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_OHCI, ~0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 .driver_data = (unsigned long) &ohci_pci_hc_driver,
477 }, { /* end: all zeroes */ }
478};
479MODULE_DEVICE_TABLE (pci, pci_ids);
480
481/* pci driver glue; this is a "new style" PCI driver module */
482static struct pci_driver ohci_pci_driver = {
483 .name = (char *) hcd_name,
484 .id_table = pci_ids,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
486 .probe = usb_hcd_pci_probe,
487 .remove = usb_hcd_pci_remove,
488
489#ifdef CONFIG_PM
490 .suspend = usb_hcd_pci_suspend,
491 .resume = usb_hcd_pci_resume,
492#endif
Aleksey Gorelov64a21d02006-08-08 17:24:08 -0700493
494 .shutdown = usb_hcd_pci_shutdown,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495};
496