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_IBM)
84 chip->quirks |= SDHCI_QUIRK_CLOCK_BEFORE_RESET;
86 if (chip->pdev->subsystem_vendor == PCI_VENDOR_ID_SAMSUNG)
87 chip->quirks |= SDHCI_QUIRK_NO_CARD_NO_RESET;
92 static const struct sdhci_pci_fixes sdhci_ricoh = {
94 .quirks = SDHCI_QUIRK_32BIT_DMA_ADDR,
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_BROKEN_TIMEOUT_VAL,
113 static int jmicron_pmos(struct sdhci_pci_chip *chip, int on)
118 ret = pci_read_config_byte(chip->pdev, 0xAE, &scratch);
123 * Turn PMOS on [bit 0], set over current detection to 2.4 V
124 * [bit 1:2] and enable over current debouncing [bit 6].
131 ret = pci_write_config_byte(chip->pdev, 0xAE, scratch);
138 static int jmicron_probe(struct sdhci_pci_chip *chip)
142 if (chip->pdev->revision == 0) {
143 chip->quirks |= SDHCI_QUIRK_32BIT_DMA_ADDR |
144 SDHCI_QUIRK_32BIT_DMA_SIZE |
145 SDHCI_QUIRK_32BIT_ADMA_SIZE |
146 SDHCI_QUIRK_RESET_AFTER_REQUEST |
147 SDHCI_QUIRK_BROKEN_SMALL_PIO |
148 SDHCI_QUIRK_FORCE_HIGHSPEED;
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 static const struct pci_device_id pci_ids[] __devinitdata = {
289 .vendor = PCI_VENDOR_ID_RICOH,
290 .device = PCI_DEVICE_ID_RICOH_R5C822,
291 .subvendor = PCI_ANY_ID,
292 .subdevice = PCI_ANY_ID,
293 .driver_data = (kernel_ulong_t)&sdhci_ricoh,
297 .vendor = PCI_VENDOR_ID_ENE,
298 .device = PCI_DEVICE_ID_ENE_CB712_SD,
299 .subvendor = PCI_ANY_ID,
300 .subdevice = PCI_ANY_ID,
301 .driver_data = (kernel_ulong_t)&sdhci_ene_712,
305 .vendor = PCI_VENDOR_ID_ENE,
306 .device = PCI_DEVICE_ID_ENE_CB712_SD_2,
307 .subvendor = PCI_ANY_ID,
308 .subdevice = PCI_ANY_ID,
309 .driver_data = (kernel_ulong_t)&sdhci_ene_712,
313 .vendor = PCI_VENDOR_ID_ENE,
314 .device = PCI_DEVICE_ID_ENE_CB714_SD,
315 .subvendor = PCI_ANY_ID,
316 .subdevice = PCI_ANY_ID,
317 .driver_data = (kernel_ulong_t)&sdhci_ene_714,
321 .vendor = PCI_VENDOR_ID_ENE,
322 .device = PCI_DEVICE_ID_ENE_CB714_SD_2,
323 .subvendor = PCI_ANY_ID,
324 .subdevice = PCI_ANY_ID,
325 .driver_data = (kernel_ulong_t)&sdhci_ene_714,
329 .vendor = PCI_VENDOR_ID_MARVELL,
330 .device = PCI_DEVICE_ID_MARVELL_88ALP01_SD,
331 .subvendor = PCI_ANY_ID,
332 .subdevice = PCI_ANY_ID,
333 .driver_data = (kernel_ulong_t)&sdhci_cafe,
337 .vendor = PCI_VENDOR_ID_JMICRON,
338 .device = PCI_DEVICE_ID_JMICRON_JMB38X_SD,
339 .subvendor = PCI_ANY_ID,
340 .subdevice = PCI_ANY_ID,
341 .driver_data = (kernel_ulong_t)&sdhci_jmicron,
345 .vendor = PCI_VENDOR_ID_JMICRON,
346 .device = PCI_DEVICE_ID_JMICRON_JMB38X_MMC,
347 .subvendor = PCI_ANY_ID,
348 .subdevice = PCI_ANY_ID,
349 .driver_data = (kernel_ulong_t)&sdhci_jmicron,
352 { /* Generic SD host controller */
353 PCI_DEVICE_CLASS((PCI_CLASS_SYSTEM_SDHCI << 8), 0xFFFF00)
356 { /* end: all zeroes */ },
359 MODULE_DEVICE_TABLE(pci, pci_ids);
361 /*****************************************************************************\
363 * SDHCI core callbacks *
365 \*****************************************************************************/
367 static int sdhci_pci_enable_dma(struct sdhci_host *host)
369 struct sdhci_pci_slot *slot;
370 struct pci_dev *pdev;
373 slot = sdhci_priv(host);
374 pdev = slot->chip->pdev;
376 if (((pdev->class & 0xFFFF00) == (PCI_CLASS_SYSTEM_SDHCI << 8)) &&
377 ((pdev->class & 0x0000FF) != PCI_SDHCI_IFDMA) &&
378 (host->flags & SDHCI_USE_DMA)) {
379 dev_warn(&pdev->dev, "Will use DMA mode even though HW "
380 "doesn't fully claim to support it.\n");
383 ret = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
387 pci_set_master(pdev);
392 static struct sdhci_ops sdhci_pci_ops = {
393 .enable_dma = sdhci_pci_enable_dma,
396 /*****************************************************************************\
400 \*****************************************************************************/
404 static int sdhci_pci_suspend (struct pci_dev *pdev, pm_message_t state)
406 struct sdhci_pci_chip *chip;
407 struct sdhci_pci_slot *slot;
410 chip = pci_get_drvdata(pdev);
414 for (i = 0;i < chip->num_slots;i++) {
415 slot = chip->slots[i];
419 ret = sdhci_suspend_host(slot->host, state);
423 sdhci_resume_host(chip->slots[i]->host);
428 if (chip->fixes && chip->fixes->suspend) {
429 ret = chip->fixes->suspend(chip, state);
431 for (i = chip->num_slots - 1;i >= 0;i--)
432 sdhci_resume_host(chip->slots[i]->host);
437 pci_save_state(pdev);
438 pci_enable_wake(pdev, pci_choose_state(pdev, state), 0);
439 pci_disable_device(pdev);
440 pci_set_power_state(pdev, pci_choose_state(pdev, state));
445 static int sdhci_pci_resume (struct pci_dev *pdev)
447 struct sdhci_pci_chip *chip;
448 struct sdhci_pci_slot *slot;
451 chip = pci_get_drvdata(pdev);
455 pci_set_power_state(pdev, PCI_D0);
456 pci_restore_state(pdev);
457 ret = pci_enable_device(pdev);
461 if (chip->fixes && chip->fixes->resume) {
462 ret = chip->fixes->resume(chip);
467 for (i = 0;i < chip->num_slots;i++) {
468 slot = chip->slots[i];
472 ret = sdhci_resume_host(slot->host);
480 #else /* CONFIG_PM */
482 #define sdhci_pci_suspend NULL
483 #define sdhci_pci_resume NULL
485 #endif /* CONFIG_PM */
487 /*****************************************************************************\
489 * Device probing/removal *
491 \*****************************************************************************/
493 static struct sdhci_pci_slot * __devinit sdhci_pci_probe_slot(
494 struct pci_dev *pdev, struct sdhci_pci_chip *chip, int bar)
496 struct sdhci_pci_slot *slot;
497 struct sdhci_host *host;
499 resource_size_t addr;
503 if (!(pci_resource_flags(pdev, bar) & IORESOURCE_MEM)) {
504 dev_err(&pdev->dev, "BAR %d is not iomem. Aborting.\n", bar);
505 return ERR_PTR(-ENODEV);
508 if (pci_resource_len(pdev, bar) != 0x100) {
509 dev_err(&pdev->dev, "Invalid iomem size. You may "
510 "experience problems.\n");
513 if ((pdev->class & 0x0000FF) == PCI_SDHCI_IFVENDOR) {
514 dev_err(&pdev->dev, "Vendor specific interface. Aborting.\n");
515 return ERR_PTR(-ENODEV);
518 if ((pdev->class & 0x0000FF) > PCI_SDHCI_IFVENDOR) {
519 dev_err(&pdev->dev, "Unknown interface. Aborting.\n");
520 return ERR_PTR(-ENODEV);
523 host = sdhci_alloc_host(&pdev->dev, sizeof(struct sdhci_pci_slot));
529 slot = sdhci_priv(host);
535 host->hw_name = "PCI";
536 host->ops = &sdhci_pci_ops;
537 host->quirks = chip->quirks;
539 host->irq = pdev->irq;
541 ret = pci_request_region(pdev, bar, mmc_hostname(host->mmc));
543 dev_err(&pdev->dev, "cannot request region\n");
547 addr = pci_resource_start(pdev, bar);
548 host->ioaddr = pci_ioremap_bar(pdev, bar);
550 dev_err(&pdev->dev, "failed to remap registers\n");
554 if (chip->fixes && chip->fixes->probe_slot) {
555 ret = chip->fixes->probe_slot(slot);
560 ret = sdhci_add_host(host);
567 if (chip->fixes && chip->fixes->remove_slot)
568 chip->fixes->remove_slot(slot, 0);
571 iounmap(host->ioaddr);
574 pci_release_region(pdev, bar);
575 sdhci_free_host(host);
580 static void sdhci_pci_remove_slot(struct sdhci_pci_slot *slot)
586 scratch = readl(slot->host->ioaddr + SDHCI_INT_STATUS);
587 if (scratch == (u32)-1)
590 sdhci_remove_host(slot->host, dead);
592 if (slot->chip->fixes && slot->chip->fixes->remove_slot)
593 slot->chip->fixes->remove_slot(slot, dead);
595 pci_release_region(slot->chip->pdev, slot->pci_bar);
597 sdhci_free_host(slot->host);
600 static int __devinit sdhci_pci_probe(struct pci_dev *pdev,
601 const struct pci_device_id *ent)
603 struct sdhci_pci_chip *chip;
604 struct sdhci_pci_slot *slot;
606 u8 slots, rev, first_bar;
609 BUG_ON(pdev == NULL);
612 pci_read_config_byte(pdev, PCI_CLASS_REVISION, &rev);
614 dev_info(&pdev->dev, "SDHCI controller found [%04x:%04x] (rev %x)\n",
615 (int)pdev->vendor, (int)pdev->device, (int)rev);
617 ret = pci_read_config_byte(pdev, PCI_SLOT_INFO, &slots);
621 slots = PCI_SLOT_INFO_SLOTS(slots) + 1;
622 dev_dbg(&pdev->dev, "found %d slot(s)\n", slots);
626 BUG_ON(slots > MAX_SLOTS);
628 ret = pci_read_config_byte(pdev, PCI_SLOT_INFO, &first_bar);
632 first_bar &= PCI_SLOT_INFO_FIRST_BAR_MASK;
635 dev_err(&pdev->dev, "Invalid first BAR. Aborting.\n");
639 ret = pci_enable_device(pdev);
643 chip = kzalloc(sizeof(struct sdhci_pci_chip), GFP_KERNEL);
650 chip->fixes = (const struct sdhci_pci_fixes*)ent->driver_data;
652 chip->quirks = chip->fixes->quirks;
653 chip->num_slots = slots;
655 pci_set_drvdata(pdev, chip);
657 if (chip->fixes && chip->fixes->probe) {
658 ret = chip->fixes->probe(chip);
663 for (i = 0;i < slots;i++) {
664 slot = sdhci_pci_probe_slot(pdev, chip, first_bar + i);
667 sdhci_pci_remove_slot(chip->slots[i]);
672 chip->slots[i] = slot;
678 pci_set_drvdata(pdev, NULL);
682 pci_disable_device(pdev);
686 static void __devexit sdhci_pci_remove(struct pci_dev *pdev)
689 struct sdhci_pci_chip *chip;
691 chip = pci_get_drvdata(pdev);
694 for (i = 0;i < chip->num_slots; i++)
695 sdhci_pci_remove_slot(chip->slots[i]);
697 pci_set_drvdata(pdev, NULL);
701 pci_disable_device(pdev);
704 static struct pci_driver sdhci_driver = {
707 .probe = sdhci_pci_probe,
708 .remove = __devexit_p(sdhci_pci_remove),
709 .suspend = sdhci_pci_suspend,
710 .resume = sdhci_pci_resume,
713 /*****************************************************************************\
717 \*****************************************************************************/
719 static int __init sdhci_drv_init(void)
721 return pci_register_driver(&sdhci_driver);
724 static void __exit sdhci_drv_exit(void)
726 pci_unregister_driver(&sdhci_driver);
729 module_init(sdhci_drv_init);
730 module_exit(sdhci_drv_exit);
732 MODULE_AUTHOR("Pierre Ossman <drzeus@drzeus.cx>");
733 MODULE_DESCRIPTION("Secure Digital Host Controller Interface PCI driver");
734 MODULE_LICENSE("GPL");