2 * EHCI HCD (Host Controller Driver) PCI Bus Glue.
4 * Copyright (c) 2000-2004 by David Brownell
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/pci.h>
24 #include <linux/usb.h>
25 #include <linux/usb/hcd.h>
28 #include "pci-quirks.h"
30 #define DRIVER_DESC "EHCI PCI platform driver"
32 static const char hcd_name
[] = "ehci-pci";
34 /* defined here to avoid adding to pci_ids.h for single instance use */
35 #define PCI_DEVICE_ID_INTEL_CE4100_USB 0x2e70
37 /*-------------------------------------------------------------------------*/
38 #define PCI_DEVICE_ID_INTEL_QUARK_X1000_SOC 0x0939
39 static inline bool is_intel_quark_x1000(struct pci_dev
*pdev
)
41 return pdev
->vendor
== PCI_VENDOR_ID_INTEL
&&
42 pdev
->device
== PCI_DEVICE_ID_INTEL_QUARK_X1000_SOC
;
46 * This is the list of PCI IDs for the devices that have EHCI USB class and
47 * specific drivers for that. One of the example is a ChipIdea device installed
48 * on some Intel MID platforms.
50 static const struct pci_device_id bypass_pci_id_table
[] = {
51 /* ChipIdea on Intel MID platform */
52 { PCI_DEVICE(PCI_VENDOR_ID_INTEL
, 0x0811), },
53 { PCI_DEVICE(PCI_VENDOR_ID_INTEL
, 0x0829), },
54 { PCI_DEVICE(PCI_VENDOR_ID_INTEL
, 0xe006), },
58 static inline bool is_bypassed_id(struct pci_dev
*pdev
)
60 return !!pci_match_id(bypass_pci_id_table
, pdev
);
64 * 0x84 is the offset of in/out threshold register,
65 * and it is the same offset as the register of 'hostpc'.
67 #define intel_quark_x1000_insnreg01 hostpc
69 /* Maximum usable threshold value is 0x7f dwords for both IN and OUT */
70 #define INTEL_QUARK_X1000_EHCI_MAX_THRESHOLD 0x007f007f
72 /* called after powerup, by probe or system-pm "wakeup" */
73 static int ehci_pci_reinit(struct ehci_hcd
*ehci
, struct pci_dev
*pdev
)
77 /* we expect static quirk code to handle the "extended capabilities"
78 * (currently just BIOS handoff) allowed starting with EHCI 0.96
81 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
82 retval
= pci_set_mwi(pdev
);
84 ehci_dbg(ehci
, "MWI active\n");
86 /* Reset the threshold limit */
87 if (is_intel_quark_x1000(pdev
)) {
89 * For the Intel QUARK X1000, raise the I/O threshold to the
90 * maximum usable value in order to improve performance.
92 ehci_writel(ehci
, INTEL_QUARK_X1000_EHCI_MAX_THRESHOLD
,
93 ehci
->regs
->intel_quark_x1000_insnreg01
);
99 /* called during probe() after chip reset completes */
100 static int ehci_pci_setup(struct usb_hcd
*hcd
)
102 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
103 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
107 ehci
->caps
= hcd
->regs
;
110 * ehci_init() causes memory for DMA transfers to be
111 * allocated. Thus, any vendor-specific workarounds based on
112 * limiting the type of memory used for DMA transfers must
113 * happen before ehci_setup() is called.
115 * Most other workarounds can be done either before or after
116 * init and reset; they are located here too.
118 switch (pdev
->vendor
) {
119 case PCI_VENDOR_ID_TOSHIBA_2
:
120 /* celleb's companion chip */
121 if (pdev
->device
== 0x01b5) {
122 #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
123 ehci
->big_endian_mmio
= 1;
126 "unsupported big endian Toshiba quirk\n");
130 case PCI_VENDOR_ID_NVIDIA
:
131 /* NVidia reports that certain chips don't handle
132 * QH, ITD, or SITD addresses above 2GB. (But TD,
133 * data buffer, and periodic schedule are normal.)
135 switch (pdev
->device
) {
136 case 0x003c: /* MCP04 */
137 case 0x005b: /* CK804 */
138 case 0x00d8: /* CK8 */
139 case 0x00e8: /* CK8S */
140 if (pci_set_consistent_dma_mask(pdev
,
141 DMA_BIT_MASK(31)) < 0)
142 ehci_warn(ehci
, "can't enable NVidia "
143 "workaround for >2GB RAM\n");
146 /* Some NForce2 chips have problems with selective suspend;
147 * fixed in newer silicon.
150 if (pdev
->revision
< 0xa4)
151 ehci
->no_selective_suspend
= 1;
155 case PCI_VENDOR_ID_INTEL
:
156 if (pdev
->device
== PCI_DEVICE_ID_INTEL_CE4100_USB
)
159 case PCI_VENDOR_ID_TDI
:
160 if (pdev
->device
== PCI_DEVICE_ID_TDI_EHCI
)
163 case PCI_VENDOR_ID_AMD
:
165 if (usb_amd_find_chipset_info())
166 ehci
->amd_pll_fix
= 1;
167 /* AMD8111 EHCI doesn't work, according to AMD errata */
168 if (pdev
->device
== 0x7463) {
169 ehci_info(ehci
, "ignoring AMD8111 (errata)\n");
175 * EHCI controller on AMD SB700/SB800/Hudson-2/3 platforms may
176 * read/write memory space which does not belong to it when
177 * there is NULL pointer with T-bit set to 1 in the frame list
178 * table. To avoid the issue, the frame list link pointer
179 * should always contain a valid pointer to a inactive qh.
181 if (pdev
->device
== 0x7808) {
182 ehci
->use_dummy_qh
= 1;
183 ehci_info(ehci
, "applying AMD SB700/SB800/Hudson-2/3 EHCI dummy qh workaround\n");
186 case PCI_VENDOR_ID_VIA
:
187 if (pdev
->device
== 0x3104 && (pdev
->revision
& 0xf0) == 0x60) {
190 /* The VT6212 defaults to a 1 usec EHCI sleep time which
191 * hogs the PCI bus *badly*. Setting bit 5 of 0x4B makes
192 * that sleep time use the conventional 10 usec.
194 pci_read_config_byte(pdev
, 0x4b, &tmp
);
197 pci_write_config_byte(pdev
, 0x4b, tmp
| 0x20);
200 case PCI_VENDOR_ID_ATI
:
202 if (usb_amd_find_chipset_info())
203 ehci
->amd_pll_fix
= 1;
206 * EHCI controller on AMD SB700/SB800/Hudson-2/3 platforms may
207 * read/write memory space which does not belong to it when
208 * there is NULL pointer with T-bit set to 1 in the frame list
209 * table. To avoid the issue, the frame list link pointer
210 * should always contain a valid pointer to a inactive qh.
212 if (pdev
->device
== 0x4396) {
213 ehci
->use_dummy_qh
= 1;
214 ehci_info(ehci
, "applying AMD SB700/SB800/Hudson-2/3 EHCI dummy qh workaround\n");
216 /* SB600 and old version of SB700 have a bug in EHCI controller,
217 * which causes usb devices lose response in some cases.
219 if ((pdev
->device
== 0x4386 || pdev
->device
== 0x4396) &&
220 usb_amd_hang_symptom_quirk()) {
222 ehci_info(ehci
, "applying AMD SB600/SB700 USB freeze workaround\n");
223 pci_read_config_byte(pdev
, 0x53, &tmp
);
224 pci_write_config_byte(pdev
, 0x53, tmp
| (1<<3));
227 case PCI_VENDOR_ID_NETMOS
:
228 /* MosChip frame-index-register bug */
229 ehci_info(ehci
, "applying MosChip frame-index workaround\n");
230 ehci
->frame_index_bug
= 1;
234 /* optional debug port, normally in the first BAR */
235 temp
= pci_find_capability(pdev
, PCI_CAP_ID_DBG
);
237 pci_read_config_dword(pdev
, temp
, &temp
);
239 if (((temp
>> 13) & 7) == 1) {
240 u32 hcs_params
= ehci_readl(ehci
,
241 &ehci
->caps
->hcs_params
);
244 ehci
->debug
= hcd
->regs
+ temp
;
245 temp
= ehci_readl(ehci
, &ehci
->debug
->control
);
246 ehci_info(ehci
, "debug port %d%s\n",
247 HCS_DEBUG_PORT(hcs_params
),
248 (temp
& DBGP_ENABLED
) ? " IN USE" : "");
249 if (!(temp
& DBGP_ENABLED
))
254 retval
= ehci_setup(hcd
);
258 /* These workarounds need to be applied after ehci_setup() */
259 switch (pdev
->vendor
) {
260 case PCI_VENDOR_ID_NEC
:
261 ehci
->need_io_watchdog
= 0;
263 case PCI_VENDOR_ID_INTEL
:
264 ehci
->need_io_watchdog
= 0;
266 case PCI_VENDOR_ID_NVIDIA
:
267 switch (pdev
->device
) {
268 /* MCP89 chips on the MacBookAir3,1 give EPROTO when
269 * fetching device descriptors unless LPM is disabled.
270 * There are also intermittent problems enumerating
271 * devices with PPCD enabled.
274 ehci_info(ehci
, "disable ppcd for nvidia mcp89\n");
276 ehci
->command
&= ~CMD_PPCEE
;
282 /* at least the Genesys GL880S needs fixup here */
283 temp
= HCS_N_CC(ehci
->hcs_params
) * HCS_N_PCC(ehci
->hcs_params
);
285 if (temp
&& HCS_N_PORTS(ehci
->hcs_params
) > temp
) {
286 ehci_dbg(ehci
, "bogus port configuration: "
287 "cc=%d x pcc=%d < ports=%d\n",
288 HCS_N_CC(ehci
->hcs_params
),
289 HCS_N_PCC(ehci
->hcs_params
),
290 HCS_N_PORTS(ehci
->hcs_params
));
292 switch (pdev
->vendor
) {
293 case 0x17a0: /* GENESYS */
294 /* GL880S: should be PORTS=2 */
295 temp
|= (ehci
->hcs_params
& ~0xf);
296 ehci
->hcs_params
= temp
;
298 case PCI_VENDOR_ID_NVIDIA
:
299 /* NF4: should be PCC=10 */
304 /* Serial Bus Release Number is at PCI 0x60 offset */
305 if (pdev
->vendor
== PCI_VENDOR_ID_STMICRO
306 && pdev
->device
== PCI_DEVICE_ID_STMICRO_USB_HOST
)
307 ; /* ConneXT has no sbrn register */
309 pci_read_config_byte(pdev
, 0x60, &ehci
->sbrn
);
311 /* Keep this around for a while just in case some EHCI
312 * implementation uses legacy PCI PM support. This test
313 * can be removed on 17 Dec 2009 if the dev_warn() hasn't
314 * been triggered by then.
316 if (!device_can_wakeup(&pdev
->dev
)) {
319 pci_read_config_word(pdev
, 0x62, &port_wake
);
320 if (port_wake
& 0x0001) {
321 dev_warn(&pdev
->dev
, "Enabling legacy PCI PM\n");
322 device_set_wakeup_capable(&pdev
->dev
, 1);
327 if (ehci
->no_selective_suspend
&& device_can_wakeup(&pdev
->dev
))
328 ehci_warn(ehci
, "selective suspend/wakeup unavailable\n");
331 retval
= ehci_pci_reinit(ehci
, pdev
);
336 /*-------------------------------------------------------------------------*/
340 /* suspend/resume, section 4.3 */
342 /* These routines rely on the PCI bus glue
343 * to handle powerdown and wakeup, and currently also on
344 * transceivers that don't need any software attention to set up
345 * the right sort of wakeup.
346 * Also they depend on separate root hub suspend/resume.
349 static int ehci_pci_resume(struct usb_hcd
*hcd
, bool hibernated
)
351 struct ehci_hcd
*ehci
= hcd_to_ehci(hcd
);
352 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
354 if (ehci_resume(hcd
, hibernated
) != 0)
355 (void) ehci_pci_reinit(ehci
, pdev
);
361 #define ehci_suspend NULL
362 #define ehci_pci_resume NULL
363 #endif /* CONFIG_PM */
365 static struct hc_driver __read_mostly ehci_pci_hc_driver
;
367 static const struct ehci_driver_overrides pci_overrides __initconst
= {
368 .reset
= ehci_pci_setup
,
371 /*-------------------------------------------------------------------------*/
373 static int ehci_pci_probe(struct pci_dev
*pdev
, const struct pci_device_id
*id
)
375 if (is_bypassed_id(pdev
))
377 return usb_hcd_pci_probe(pdev
, id
);
380 static void ehci_pci_remove(struct pci_dev
*pdev
)
383 usb_hcd_pci_remove(pdev
);
386 /* PCI driver selection metadata; PCI hotplugging uses this */
387 static const struct pci_device_id pci_ids
[] = { {
388 /* handle any USB 2.0 EHCI controller */
389 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_EHCI
, ~0),
390 .driver_data
= (unsigned long) &ehci_pci_hc_driver
,
392 PCI_VDEVICE(STMICRO
, PCI_DEVICE_ID_STMICRO_USB_HOST
),
393 .driver_data
= (unsigned long) &ehci_pci_hc_driver
,
395 { /* end: all zeroes */ }
397 MODULE_DEVICE_TABLE(pci
, pci_ids
);
399 /* pci driver glue; this is a "new style" PCI driver module */
400 static struct pci_driver ehci_pci_driver
= {
401 .name
= (char *) hcd_name
,
404 .probe
= ehci_pci_probe
,
405 .remove
= ehci_pci_remove
,
406 .shutdown
= usb_hcd_pci_shutdown
,
410 .pm
= &usb_hcd_pci_pm_ops
415 static int __init
ehci_pci_init(void)
420 pr_info("%s: " DRIVER_DESC
"\n", hcd_name
);
422 ehci_init_driver(&ehci_pci_hc_driver
, &pci_overrides
);
424 /* Entries for the PCI suspend/resume callbacks are special */
425 ehci_pci_hc_driver
.pci_suspend
= ehci_suspend
;
426 ehci_pci_hc_driver
.pci_resume
= ehci_pci_resume
;
428 return pci_register_driver(&ehci_pci_driver
);
430 module_init(ehci_pci_init
);
432 static void __exit
ehci_pci_cleanup(void)
434 pci_unregister_driver(&ehci_pci_driver
);
436 module_exit(ehci_pci_cleanup
);
438 MODULE_DESCRIPTION(DRIVER_DESC
);
439 MODULE_AUTHOR("David Brownell");
440 MODULE_AUTHOR("Alan Stern");
441 MODULE_LICENSE("GPL");