1 /* linux/drivers/mmc/host/sdhci-pci.c - SDHCI on PCI bus interface
3 * Copyright (C) 2005-2008 Pierre Ossman, All Rights Reserved.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or (at
8 * your option) any later version.
10 * Thanks to the following companies for their support:
12 * - JMicron (hardware and technical support)
15 #include <linux/delay.h>
16 #include <linux/highmem.h>
17 #include <linux/pci.h>
18 #include <linux/dma-mapping.h>
20 #include <linux/mmc/host.h>
22 #include <asm/scatterlist.h>
31 #define PCI_SDHCI_IFPIO 0x00
32 #define PCI_SDHCI_IFDMA 0x01
33 #define PCI_SDHCI_IFVENDOR 0x02
35 #define PCI_SLOT_INFO 0x40 /* 8 bits */
36 #define PCI_SLOT_INFO_SLOTS(x) ((x >> 4) & 7)
37 #define PCI_SLOT_INFO_FIRST_BAR_MASK 0x07
41 struct sdhci_pci_chip;
42 struct sdhci_pci_slot;
44 struct sdhci_pci_fixes {
47 int (*probe)(struct sdhci_pci_chip*);
49 int (*probe_slot)(struct sdhci_pci_slot*);
50 void (*remove_slot)(struct sdhci_pci_slot*, int);
52 int (*suspend)(struct sdhci_pci_chip*,
54 int (*resume)(struct sdhci_pci_chip*);
57 struct sdhci_pci_slot {
58 struct sdhci_pci_chip *chip;
59 struct sdhci_host *host;
64 struct sdhci_pci_chip {
68 const struct sdhci_pci_fixes *fixes;
70 int num_slots; /* Slots on controller */
71 struct sdhci_pci_slot *slots[MAX_SLOTS]; /* Pointers to host slots */
75 /*****************************************************************************\
77 * Hardware specific quirk handling *
79 \*****************************************************************************/
81 static int ricoh_probe(struct sdhci_pci_chip *chip)
83 if (chip->pdev->subsystem_vendor == PCI_VENDOR_ID_SAMSUNG ||
84 chip->pdev->subsystem_vendor == PCI_VENDOR_ID_SONY)
85 chip->quirks |= SDHCI_QUIRK_NO_CARD_NO_RESET;
90 static const struct sdhci_pci_fixes sdhci_ricoh = {
92 .quirks = SDHCI_QUIRK_32BIT_DMA_ADDR |
93 SDHCI_QUIRK_FORCE_DMA |
94 SDHCI_QUIRK_CLOCK_BEFORE_RESET,
97 static const struct sdhci_pci_fixes sdhci_ene_712 = {
98 .quirks = SDHCI_QUIRK_SINGLE_POWER_WRITE |
99 SDHCI_QUIRK_BROKEN_DMA,
102 static const struct sdhci_pci_fixes sdhci_ene_714 = {
103 .quirks = SDHCI_QUIRK_SINGLE_POWER_WRITE |
104 SDHCI_QUIRK_RESET_CMD_DATA_ON_IOS |
105 SDHCI_QUIRK_BROKEN_DMA,
108 static const struct sdhci_pci_fixes sdhci_cafe = {
109 .quirks = SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER |
110 SDHCI_QUIRK_NO_BUSY_IRQ |
111 SDHCI_QUIRK_BROKEN_TIMEOUT_VAL,
114 static int jmicron_pmos(struct sdhci_pci_chip *chip, int on)
119 ret = pci_read_config_byte(chip->pdev, 0xAE, &scratch);
124 * Turn PMOS on [bit 0], set over current detection to 2.4 V
125 * [bit 1:2] and enable over current debouncing [bit 6].
132 ret = pci_write_config_byte(chip->pdev, 0xAE, scratch);
139 static int jmicron_probe(struct sdhci_pci_chip *chip)
143 if (chip->pdev->revision == 0) {
144 chip->quirks |= SDHCI_QUIRK_32BIT_DMA_ADDR |
145 SDHCI_QUIRK_32BIT_DMA_SIZE |
146 SDHCI_QUIRK_32BIT_ADMA_SIZE |
147 SDHCI_QUIRK_RESET_AFTER_REQUEST |
148 SDHCI_QUIRK_BROKEN_SMALL_PIO;
152 * JMicron chips can have two interfaces to the same hardware
153 * in order to work around limitations in Microsoft's driver.
154 * We need to make sure we only bind to one of them.
156 * This code assumes two things:
158 * 1. The PCI code adds subfunctions in order.
160 * 2. The MMC interface has a lower subfunction number
161 * than the SD interface.
163 if (chip->pdev->device == PCI_DEVICE_ID_JMICRON_JMB38X_SD) {
164 struct pci_dev *sd_dev;
167 while ((sd_dev = pci_get_device(PCI_VENDOR_ID_JMICRON,
168 PCI_DEVICE_ID_JMICRON_JMB38X_MMC, sd_dev)) != NULL) {
169 if ((PCI_SLOT(chip->pdev->devfn) ==
170 PCI_SLOT(sd_dev->devfn)) &&
171 (chip->pdev->bus == sd_dev->bus))
177 dev_info(&chip->pdev->dev, "Refusing to bind to "
178 "secondary interface.\n");
184 * JMicron chips need a bit of a nudge to enable the power
187 ret = jmicron_pmos(chip, 1);
189 dev_err(&chip->pdev->dev, "Failure enabling card power\n");
196 static void jmicron_enable_mmc(struct sdhci_host *host, int on)
200 scratch = readb(host->ioaddr + 0xC0);
207 writeb(scratch, host->ioaddr + 0xC0);
210 static int jmicron_probe_slot(struct sdhci_pci_slot *slot)
212 if (slot->chip->pdev->revision == 0) {
215 version = readl(slot->host->ioaddr + SDHCI_HOST_VERSION);
216 version = (version & SDHCI_VENDOR_VER_MASK) >>
217 SDHCI_VENDOR_VER_SHIFT;
220 * Older versions of the chip have lots of nasty glitches
221 * in the ADMA engine. It's best just to avoid it
225 slot->host->quirks |= SDHCI_QUIRK_BROKEN_ADMA;
229 * The secondary interface requires a bit set to get the
232 if (slot->chip->pdev->device == PCI_DEVICE_ID_JMICRON_JMB38X_MMC)
233 jmicron_enable_mmc(slot->host, 1);
238 static void jmicron_remove_slot(struct sdhci_pci_slot *slot, int dead)
243 if (slot->chip->pdev->device == PCI_DEVICE_ID_JMICRON_JMB38X_MMC)
244 jmicron_enable_mmc(slot->host, 0);
247 static int jmicron_suspend(struct sdhci_pci_chip *chip, pm_message_t state)
251 if (chip->pdev->device == PCI_DEVICE_ID_JMICRON_JMB38X_MMC) {
252 for (i = 0;i < chip->num_slots;i++)
253 jmicron_enable_mmc(chip->slots[i]->host, 0);
259 static int jmicron_resume(struct sdhci_pci_chip *chip)
263 if (chip->pdev->device == PCI_DEVICE_ID_JMICRON_JMB38X_MMC) {
264 for (i = 0;i < chip->num_slots;i++)
265 jmicron_enable_mmc(chip->slots[i]->host, 1);
268 ret = jmicron_pmos(chip, 1);
270 dev_err(&chip->pdev->dev, "Failure enabling card power\n");
277 static const struct sdhci_pci_fixes sdhci_jmicron = {
278 .probe = jmicron_probe,
280 .probe_slot = jmicron_probe_slot,
281 .remove_slot = jmicron_remove_slot,
283 .suspend = jmicron_suspend,
284 .resume = jmicron_resume,
287 /* SysKonnect CardBus2SDIO extra registers */
288 #define SYSKT_CTRL 0x200
289 #define SYSKT_RDFIFO_STAT 0x204
290 #define SYSKT_WRFIFO_STAT 0x208
291 #define SYSKT_POWER_DATA 0x20c
292 #define SYSKT_POWER_330 0xef
293 #define SYSKT_POWER_300 0xf8
294 #define SYSKT_POWER_184 0xcc
295 #define SYSKT_POWER_CMD 0x20d
296 #define SYSKT_POWER_START (1 << 7)
297 #define SYSKT_POWER_STATUS 0x20e
298 #define SYSKT_POWER_STATUS_OK (1 << 0)
299 #define SYSKT_BOARD_REV 0x210
300 #define SYSKT_CHIP_REV 0x211
301 #define SYSKT_CONF_DATA 0x212
302 #define SYSKT_CONF_DATA_1V8 (1 << 2)
303 #define SYSKT_CONF_DATA_2V5 (1 << 1)
304 #define SYSKT_CONF_DATA_3V3 (1 << 0)
306 static int syskt_probe(struct sdhci_pci_chip *chip)
308 if ((chip->pdev->class & 0x0000FF) == PCI_SDHCI_IFVENDOR) {
309 chip->pdev->class &= ~0x0000FF;
310 chip->pdev->class |= PCI_SDHCI_IFDMA;
315 static int syskt_probe_slot(struct sdhci_pci_slot *slot)
319 u8 board_rev = readb(slot->host->ioaddr + SYSKT_BOARD_REV);
320 u8 chip_rev = readb(slot->host->ioaddr + SYSKT_CHIP_REV);
321 dev_info(&slot->chip->pdev->dev, "SysKonnect CardBus2SDIO, "
322 "board rev %d.%d, chip rev %d.%d\n",
323 board_rev >> 4, board_rev & 0xf,
324 chip_rev >> 4, chip_rev & 0xf);
325 if (chip_rev >= 0x20)
326 slot->host->quirks |= SDHCI_QUIRK_FORCE_DMA;
328 writeb(SYSKT_POWER_330, slot->host->ioaddr + SYSKT_POWER_DATA);
329 writeb(SYSKT_POWER_START, slot->host->ioaddr + SYSKT_POWER_CMD);
331 tm = 10; /* Wait max 1 ms */
333 ps = readw(slot->host->ioaddr + SYSKT_POWER_STATUS);
334 if (ps & SYSKT_POWER_STATUS_OK)
339 dev_err(&slot->chip->pdev->dev,
340 "power regulator never stabilized");
341 writeb(0, slot->host->ioaddr + SYSKT_POWER_CMD);
348 static const struct sdhci_pci_fixes sdhci_syskt = {
349 .quirks = SDHCI_QUIRK_NO_SIMULT_VDD_AND_POWER,
350 .probe = syskt_probe,
351 .probe_slot = syskt_probe_slot,
354 static int via_probe(struct sdhci_pci_chip *chip)
356 if (chip->pdev->revision == 0x10)
357 chip->quirks |= SDHCI_QUIRK_DELAY_AFTER_POWER;
362 static const struct sdhci_pci_fixes sdhci_via = {
366 static const struct pci_device_id pci_ids[] __devinitdata = {
368 .vendor = PCI_VENDOR_ID_RICOH,
369 .device = PCI_DEVICE_ID_RICOH_R5C822,
370 .subvendor = PCI_ANY_ID,
371 .subdevice = PCI_ANY_ID,
372 .driver_data = (kernel_ulong_t)&sdhci_ricoh,
376 .vendor = PCI_VENDOR_ID_ENE,
377 .device = PCI_DEVICE_ID_ENE_CB712_SD,
378 .subvendor = PCI_ANY_ID,
379 .subdevice = PCI_ANY_ID,
380 .driver_data = (kernel_ulong_t)&sdhci_ene_712,
384 .vendor = PCI_VENDOR_ID_ENE,
385 .device = PCI_DEVICE_ID_ENE_CB712_SD_2,
386 .subvendor = PCI_ANY_ID,
387 .subdevice = PCI_ANY_ID,
388 .driver_data = (kernel_ulong_t)&sdhci_ene_712,
392 .vendor = PCI_VENDOR_ID_ENE,
393 .device = PCI_DEVICE_ID_ENE_CB714_SD,
394 .subvendor = PCI_ANY_ID,
395 .subdevice = PCI_ANY_ID,
396 .driver_data = (kernel_ulong_t)&sdhci_ene_714,
400 .vendor = PCI_VENDOR_ID_ENE,
401 .device = PCI_DEVICE_ID_ENE_CB714_SD_2,
402 .subvendor = PCI_ANY_ID,
403 .subdevice = PCI_ANY_ID,
404 .driver_data = (kernel_ulong_t)&sdhci_ene_714,
408 .vendor = PCI_VENDOR_ID_MARVELL,
409 .device = PCI_DEVICE_ID_MARVELL_88ALP01_SD,
410 .subvendor = PCI_ANY_ID,
411 .subdevice = PCI_ANY_ID,
412 .driver_data = (kernel_ulong_t)&sdhci_cafe,
416 .vendor = PCI_VENDOR_ID_JMICRON,
417 .device = PCI_DEVICE_ID_JMICRON_JMB38X_SD,
418 .subvendor = PCI_ANY_ID,
419 .subdevice = PCI_ANY_ID,
420 .driver_data = (kernel_ulong_t)&sdhci_jmicron,
424 .vendor = PCI_VENDOR_ID_JMICRON,
425 .device = PCI_DEVICE_ID_JMICRON_JMB38X_MMC,
426 .subvendor = PCI_ANY_ID,
427 .subdevice = PCI_ANY_ID,
428 .driver_data = (kernel_ulong_t)&sdhci_jmicron,
432 .vendor = PCI_VENDOR_ID_SYSKONNECT,
434 .subvendor = PCI_ANY_ID,
435 .subdevice = PCI_ANY_ID,
436 .driver_data = (kernel_ulong_t)&sdhci_syskt,
440 .vendor = PCI_VENDOR_ID_VIA,
442 .subvendor = PCI_ANY_ID,
443 .subdevice = PCI_ANY_ID,
444 .driver_data = (kernel_ulong_t)&sdhci_via,
447 { /* Generic SD host controller */
448 PCI_DEVICE_CLASS((PCI_CLASS_SYSTEM_SDHCI << 8), 0xFFFF00)
451 { /* end: all zeroes */ },
454 MODULE_DEVICE_TABLE(pci, pci_ids);
456 /*****************************************************************************\
458 * SDHCI core callbacks *
460 \*****************************************************************************/
462 static int sdhci_pci_enable_dma(struct sdhci_host *host)
464 struct sdhci_pci_slot *slot;
465 struct pci_dev *pdev;
468 slot = sdhci_priv(host);
469 pdev = slot->chip->pdev;
471 if (((pdev->class & 0xFFFF00) == (PCI_CLASS_SYSTEM_SDHCI << 8)) &&
472 ((pdev->class & 0x0000FF) != PCI_SDHCI_IFDMA) &&
473 (host->flags & SDHCI_USE_SDMA)) {
474 dev_warn(&pdev->dev, "Will use DMA mode even though HW "
475 "doesn't fully claim to support it.\n");
478 ret = pci_set_dma_mask(pdev, DMA_BIT_MASK(32));
482 pci_set_master(pdev);
487 static struct sdhci_ops sdhci_pci_ops = {
488 .enable_dma = sdhci_pci_enable_dma,
491 /*****************************************************************************\
495 \*****************************************************************************/
499 static int sdhci_pci_suspend (struct pci_dev *pdev, pm_message_t state)
501 struct sdhci_pci_chip *chip;
502 struct sdhci_pci_slot *slot;
503 mmc_pm_flag_t pm_flags = 0;
506 chip = pci_get_drvdata(pdev);
510 for (i = 0;i < chip->num_slots;i++) {
511 slot = chip->slots[i];
515 ret = sdhci_suspend_host(slot->host, state);
519 sdhci_resume_host(chip->slots[i]->host);
523 pm_flags |= slot->host->mmc->pm_flags;
526 if (chip->fixes && chip->fixes->suspend) {
527 ret = chip->fixes->suspend(chip, state);
529 for (i = chip->num_slots - 1;i >= 0;i--)
530 sdhci_resume_host(chip->slots[i]->host);
535 pci_save_state(pdev);
536 if (pm_flags & MMC_PM_KEEP_POWER) {
537 if (pm_flags & MMC_PM_WAKE_SDIO_IRQ)
538 pci_enable_wake(pdev, PCI_D3hot, 1);
539 pci_set_power_state(pdev, PCI_D3hot);
541 pci_enable_wake(pdev, pci_choose_state(pdev, state), 0);
542 pci_disable_device(pdev);
543 pci_set_power_state(pdev, pci_choose_state(pdev, state));
549 static int sdhci_pci_resume (struct pci_dev *pdev)
551 struct sdhci_pci_chip *chip;
552 struct sdhci_pci_slot *slot;
555 chip = pci_get_drvdata(pdev);
559 pci_set_power_state(pdev, PCI_D0);
560 pci_restore_state(pdev);
561 ret = pci_enable_device(pdev);
565 if (chip->fixes && chip->fixes->resume) {
566 ret = chip->fixes->resume(chip);
571 for (i = 0;i < chip->num_slots;i++) {
572 slot = chip->slots[i];
576 ret = sdhci_resume_host(slot->host);
584 #else /* CONFIG_PM */
586 #define sdhci_pci_suspend NULL
587 #define sdhci_pci_resume NULL
589 #endif /* CONFIG_PM */
591 /*****************************************************************************\
593 * Device probing/removal *
595 \*****************************************************************************/
597 static struct sdhci_pci_slot * __devinit sdhci_pci_probe_slot(
598 struct pci_dev *pdev, struct sdhci_pci_chip *chip, int bar)
600 struct sdhci_pci_slot *slot;
601 struct sdhci_host *host;
603 resource_size_t addr;
607 if (!(pci_resource_flags(pdev, bar) & IORESOURCE_MEM)) {
608 dev_err(&pdev->dev, "BAR %d is not iomem. Aborting.\n", bar);
609 return ERR_PTR(-ENODEV);
612 if (pci_resource_len(pdev, bar) != 0x100) {
613 dev_err(&pdev->dev, "Invalid iomem size. You may "
614 "experience problems.\n");
617 if ((pdev->class & 0x0000FF) == PCI_SDHCI_IFVENDOR) {
618 dev_err(&pdev->dev, "Vendor specific interface. Aborting.\n");
619 return ERR_PTR(-ENODEV);
622 if ((pdev->class & 0x0000FF) > PCI_SDHCI_IFVENDOR) {
623 dev_err(&pdev->dev, "Unknown interface. Aborting.\n");
624 return ERR_PTR(-ENODEV);
627 host = sdhci_alloc_host(&pdev->dev, sizeof(struct sdhci_pci_slot));
629 dev_err(&pdev->dev, "cannot allocate host\n");
630 return ERR_PTR(PTR_ERR(host));
633 slot = sdhci_priv(host);
639 host->hw_name = "PCI";
640 host->ops = &sdhci_pci_ops;
641 host->quirks = chip->quirks;
643 host->irq = pdev->irq;
645 ret = pci_request_region(pdev, bar, mmc_hostname(host->mmc));
647 dev_err(&pdev->dev, "cannot request region\n");
651 addr = pci_resource_start(pdev, bar);
652 host->ioaddr = pci_ioremap_bar(pdev, bar);
654 dev_err(&pdev->dev, "failed to remap registers\n");
658 if (chip->fixes && chip->fixes->probe_slot) {
659 ret = chip->fixes->probe_slot(slot);
664 host->mmc->pm_caps = MMC_PM_KEEP_POWER | MMC_PM_WAKE_SDIO_IRQ;
666 ret = sdhci_add_host(host);
673 if (chip->fixes && chip->fixes->remove_slot)
674 chip->fixes->remove_slot(slot, 0);
677 iounmap(host->ioaddr);
680 pci_release_region(pdev, bar);
683 sdhci_free_host(host);
688 static void sdhci_pci_remove_slot(struct sdhci_pci_slot *slot)
694 scratch = readl(slot->host->ioaddr + SDHCI_INT_STATUS);
695 if (scratch == (u32)-1)
698 sdhci_remove_host(slot->host, dead);
700 if (slot->chip->fixes && slot->chip->fixes->remove_slot)
701 slot->chip->fixes->remove_slot(slot, dead);
703 pci_release_region(slot->chip->pdev, slot->pci_bar);
705 sdhci_free_host(slot->host);
708 static int __devinit sdhci_pci_probe(struct pci_dev *pdev,
709 const struct pci_device_id *ent)
711 struct sdhci_pci_chip *chip;
712 struct sdhci_pci_slot *slot;
714 u8 slots, rev, first_bar;
717 BUG_ON(pdev == NULL);
720 pci_read_config_byte(pdev, PCI_CLASS_REVISION, &rev);
722 dev_info(&pdev->dev, "SDHCI controller found [%04x:%04x] (rev %x)\n",
723 (int)pdev->vendor, (int)pdev->device, (int)rev);
725 ret = pci_read_config_byte(pdev, PCI_SLOT_INFO, &slots);
729 slots = PCI_SLOT_INFO_SLOTS(slots) + 1;
730 dev_dbg(&pdev->dev, "found %d slot(s)\n", slots);
734 BUG_ON(slots > MAX_SLOTS);
736 ret = pci_read_config_byte(pdev, PCI_SLOT_INFO, &first_bar);
740 first_bar &= PCI_SLOT_INFO_FIRST_BAR_MASK;
743 dev_err(&pdev->dev, "Invalid first BAR. Aborting.\n");
747 ret = pci_enable_device(pdev);
751 chip = kzalloc(sizeof(struct sdhci_pci_chip), GFP_KERNEL);
758 chip->fixes = (const struct sdhci_pci_fixes*)ent->driver_data;
760 chip->quirks = chip->fixes->quirks;
761 chip->num_slots = slots;
763 pci_set_drvdata(pdev, chip);
765 if (chip->fixes && chip->fixes->probe) {
766 ret = chip->fixes->probe(chip);
771 for (i = 0;i < slots;i++) {
772 slot = sdhci_pci_probe_slot(pdev, chip, first_bar + i);
775 sdhci_pci_remove_slot(chip->slots[i]);
780 chip->slots[i] = slot;
786 pci_set_drvdata(pdev, NULL);
790 pci_disable_device(pdev);
794 static void __devexit sdhci_pci_remove(struct pci_dev *pdev)
797 struct sdhci_pci_chip *chip;
799 chip = pci_get_drvdata(pdev);
802 for (i = 0;i < chip->num_slots; i++)
803 sdhci_pci_remove_slot(chip->slots[i]);
805 pci_set_drvdata(pdev, NULL);
809 pci_disable_device(pdev);
812 static struct pci_driver sdhci_driver = {
815 .probe = sdhci_pci_probe,
816 .remove = __devexit_p(sdhci_pci_remove),
817 .suspend = sdhci_pci_suspend,
818 .resume = sdhci_pci_resume,
821 /*****************************************************************************\
825 \*****************************************************************************/
827 static int __init sdhci_drv_init(void)
829 return pci_register_driver(&sdhci_driver);
832 static void __exit sdhci_drv_exit(void)
834 pci_unregister_driver(&sdhci_driver);
837 module_init(sdhci_drv_init);
838 module_exit(sdhci_drv_exit);
840 MODULE_AUTHOR("Pierre Ossman <pierre@ossman.eu>");
841 MODULE_DESCRIPTION("Secure Digital Host Controller Interface PCI driver");
842 MODULE_LICENSE("GPL");