2 * Copyright (c) 2008 Alexander Motin <mav@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
29 #include <sys/param.h>
30 #include <sys/systm.h>
33 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/mutex.h>
37 #include <sys/resource.h>
39 #include <sys/sysctl.h>
40 #include <sys/taskqueue.h>
42 #include <dev/pci/pcireg.h>
43 #include <dev/pci/pcivar.h>
45 #include <machine/bus.h>
46 #include <machine/resource.h>
47 #include <machine/stdarg.h>
49 #include <dev/mmc/bridge.h>
50 #include <dev/mmc/mmcreg.h>
51 #include <dev/mmc/mmcbrvar.h>
61 #define PCI_SDHCI_IFPIO 0x00
62 #define PCI_SDHCI_IFDMA 0x01
63 #define PCI_SDHCI_IFVENDOR 0x02
65 #define PCI_SLOT_INFO 0x40 /* 8 bits */
66 #define PCI_SLOT_INFO_SLOTS(x) (((x >> 4) & 7) + 1)
67 #define PCI_SLOT_INFO_FIRST_BAR(x) ((x) & 7)
70 * RICOH specific PCI registers
72 #define SDHC_PCI_MODE_KEY 0xf9
73 #define SDHC_PCI_MODE 0x150
74 #define SDHC_PCI_MODE_SD20 0x10
75 #define SDHC_PCI_BASE_FREQ_KEY 0xfc
76 #define SDHC_PCI_BASE_FREQ 0xe1
78 static const struct sdhci_device {
84 { 0x08221180, 0xffff, "RICOH R5C822 SD",
85 SDHCI_QUIRK_FORCE_DMA },
86 { 0xe8221180, 0xffff, "RICOH R5CE822 SD",
87 SDHCI_QUIRK_FORCE_DMA |
88 SDHCI_QUIRK_LOWER_FREQUENCY },
89 { 0xe8231180, 0xffff, "RICOH R5CE823 SD",
90 SDHCI_QUIRK_LOWER_FREQUENCY },
91 { 0x8034104c, 0xffff, "TI XX21/XX11 SD",
92 SDHCI_QUIRK_FORCE_DMA },
93 { 0x05501524, 0xffff, "ENE CB712 SD",
94 SDHCI_QUIRK_BROKEN_TIMINGS },
95 { 0x05511524, 0xffff, "ENE CB712 SD 2",
96 SDHCI_QUIRK_BROKEN_TIMINGS },
97 { 0x07501524, 0xffff, "ENE CB714 SD",
98 SDHCI_QUIRK_RESET_ON_IOS |
99 SDHCI_QUIRK_BROKEN_TIMINGS },
100 { 0x07511524, 0xffff, "ENE CB714 SD 2",
101 SDHCI_QUIRK_RESET_ON_IOS |
102 SDHCI_QUIRK_BROKEN_TIMINGS },
103 { 0x410111ab, 0xffff, "Marvell CaFe SD",
104 SDHCI_QUIRK_INCR_TIMEOUT_CONTROL },
105 { 0x2381197B, 0xffff, "JMicron JMB38X SD",
106 SDHCI_QUIRK_32BIT_DMA_SIZE |
107 SDHCI_QUIRK_RESET_AFTER_REQUEST },
108 { 0x16bc14e4, 0xffff, "Broadcom BCM577xx SDXC/MMC Card Reader",
109 SDHCI_QUIRK_BCM577XX_400KHZ_CLKSRC },
114 struct sdhci_pci_softc {
115 u_int quirks; /* Chip specific quirks */
116 struct resource *irq_res; /* IRQ resource */
117 void *intrhand; /* Interrupt handle */
119 int num_slots; /* Number of slots on this controller */
120 struct sdhci_slot slots[6];
121 struct resource *mem_res[6]; /* Memory resource */
122 uint8_t cfg_freq; /* Saved mode */
123 uint8_t cfg_mode; /* Saved frequency */
126 static int sdhci_enable_msi = 1;
127 SYSCTL_INT(_hw_sdhci, OID_AUTO, enable_msi, CTLFLAG_RDTUN, &sdhci_enable_msi,
128 0, "Enable MSI interrupts");
131 sdhci_pci_read_1(device_t dev, struct sdhci_slot *slot, bus_size_t off)
133 struct sdhci_pci_softc *sc = device_get_softc(dev);
135 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
136 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
137 return bus_read_1(sc->mem_res[slot->num], off);
141 sdhci_pci_write_1(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint8_t val)
143 struct sdhci_pci_softc *sc = device_get_softc(dev);
145 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
146 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
147 bus_write_1(sc->mem_res[slot->num], off, val);
151 sdhci_pci_read_2(device_t dev, struct sdhci_slot *slot, bus_size_t off)
153 struct sdhci_pci_softc *sc = device_get_softc(dev);
155 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
156 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
157 return bus_read_2(sc->mem_res[slot->num], off);
161 sdhci_pci_write_2(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint16_t val)
163 struct sdhci_pci_softc *sc = device_get_softc(dev);
165 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
166 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
167 bus_write_2(sc->mem_res[slot->num], off, val);
171 sdhci_pci_read_4(device_t dev, struct sdhci_slot *slot, bus_size_t off)
173 struct sdhci_pci_softc *sc = device_get_softc(dev);
175 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
176 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
177 return bus_read_4(sc->mem_res[slot->num], off);
181 sdhci_pci_write_4(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint32_t val)
183 struct sdhci_pci_softc *sc = device_get_softc(dev);
185 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
186 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
187 bus_write_4(sc->mem_res[slot->num], off, val);
191 sdhci_pci_read_multi_4(device_t dev, struct sdhci_slot *slot,
192 bus_size_t off, uint32_t *data, bus_size_t count)
194 struct sdhci_pci_softc *sc = device_get_softc(dev);
196 bus_read_multi_stream_4(sc->mem_res[slot->num], off, data, count);
200 sdhci_pci_write_multi_4(device_t dev, struct sdhci_slot *slot,
201 bus_size_t off, uint32_t *data, bus_size_t count)
203 struct sdhci_pci_softc *sc = device_get_softc(dev);
205 bus_write_multi_stream_4(sc->mem_res[slot->num], off, data, count);
208 static void sdhci_pci_intr(void *arg);
211 sdhci_lower_frequency(device_t dev)
213 struct sdhci_pci_softc *sc = device_get_softc(dev);
217 * NB: for RICOH R5CE823, this changes the PCI device ID to 0xe822.
219 pci_write_config(dev, SDHC_PCI_MODE_KEY, 0xfc, 1);
220 sc->cfg_mode = pci_read_config(dev, SDHC_PCI_MODE, 1);
221 pci_write_config(dev, SDHC_PCI_MODE, SDHC_PCI_MODE_SD20, 1);
222 pci_write_config(dev, SDHC_PCI_MODE_KEY, 0x00, 1);
225 * Some SD/MMC cards don't work with the default base
226 * clock frequency of 200 MHz. Lower it to 50 MHz.
228 pci_write_config(dev, SDHC_PCI_BASE_FREQ_KEY, 0x01, 1);
229 sc->cfg_freq = pci_read_config(dev, SDHC_PCI_BASE_FREQ, 1);
230 pci_write_config(dev, SDHC_PCI_BASE_FREQ, 50, 1);
231 pci_write_config(dev, SDHC_PCI_BASE_FREQ_KEY, 0x00, 1);
235 sdhci_restore_frequency(device_t dev)
237 struct sdhci_pci_softc *sc = device_get_softc(dev);
240 pci_write_config(dev, SDHC_PCI_MODE_KEY, 0xfc, 1);
241 pci_write_config(dev, SDHC_PCI_MODE, sc->cfg_mode, 1);
242 pci_write_config(dev, SDHC_PCI_MODE_KEY, 0x00, 1);
244 /* Restore frequency. */
245 pci_write_config(dev, SDHC_PCI_BASE_FREQ_KEY, 0x01, 1);
246 pci_write_config(dev, SDHC_PCI_BASE_FREQ, sc->cfg_freq, 1);
247 pci_write_config(dev, SDHC_PCI_BASE_FREQ_KEY, 0x00, 1);
251 sdhci_pci_probe(device_t dev)
255 uint8_t class, subclass;
258 model = (uint32_t)pci_get_device(dev) << 16;
259 model |= (uint32_t)pci_get_vendor(dev) & 0x0000ffff;
260 subvendor = pci_get_subvendor(dev);
261 class = pci_get_class(dev);
262 subclass = pci_get_subclass(dev);
265 for (i = 0; sdhci_devices[i].model != 0; i++) {
266 if (sdhci_devices[i].model == model &&
267 (sdhci_devices[i].subvendor == 0xffff ||
268 sdhci_devices[i].subvendor == subvendor)) {
269 device_set_desc(dev, sdhci_devices[i].desc);
270 result = BUS_PROBE_DEFAULT;
274 if (result == ENXIO && class == PCIC_BASEPERIPH &&
275 subclass == PCIS_BASEPERIPH_SDHC) {
276 device_set_desc(dev, "Generic SD HCI");
277 result = BUS_PROBE_GENERIC;
284 sdhci_pci_attach(device_t dev)
286 struct sdhci_pci_softc *sc = device_get_softc(dev);
289 int bar, err, rid, slots, i;
291 model = (uint32_t)pci_get_device(dev) << 16;
292 model |= (uint32_t)pci_get_vendor(dev) & 0x0000ffff;
293 subvendor = pci_get_subvendor(dev);
294 /* Apply chip specific quirks. */
295 for (i = 0; sdhci_devices[i].model != 0; i++) {
296 if (sdhci_devices[i].model == model &&
297 (sdhci_devices[i].subvendor == 0xffff ||
298 sdhci_devices[i].subvendor == subvendor)) {
299 sc->quirks = sdhci_devices[i].quirks;
303 /* Some controllers need to be bumped into the right mode. */
304 if (sc->quirks & SDHCI_QUIRK_LOWER_FREQUENCY)
305 sdhci_lower_frequency(dev);
306 /* Read slots info from PCI registers. */
307 slots = pci_read_config(dev, PCI_SLOT_INFO, 1);
308 bar = PCI_SLOT_INFO_FIRST_BAR(slots);
309 slots = PCI_SLOT_INFO_SLOTS(slots);
310 if (slots > 6 || bar > 5) {
311 device_printf(dev, "Incorrect slots information (%d, %d).\n",
318 if (sdhci_enable_msi != 0 && pci_alloc_msi(dev, &i) == 0)
320 sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
321 RF_ACTIVE | (rid != 0 ? 0 : RF_SHAREABLE));
322 if (sc->irq_res == NULL) {
323 device_printf(dev, "Can't allocate IRQ\n");
324 pci_release_msi(dev);
327 /* Scan all slots. */
328 for (i = 0; i < slots; i++) {
329 struct sdhci_slot *slot = &sc->slots[sc->num_slots];
331 /* Allocate memory. */
332 rid = PCIR_BAR(bar + i);
333 sc->mem_res[i] = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
335 if (sc->mem_res[i] == NULL) {
336 device_printf(dev, "Can't allocate memory for slot %d\n", i);
340 slot->quirks = sc->quirks;
342 if (sdhci_init_slot(dev, slot, i) != 0)
347 device_printf(dev, "%d slot(s) allocated\n", sc->num_slots);
348 /* Activate the interrupt */
349 err = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
350 NULL, sdhci_pci_intr, sc, &sc->intrhand);
352 device_printf(dev, "Can't setup IRQ\n");
353 pci_enable_busmaster(dev);
354 /* Process cards detection. */
355 for (i = 0; i < sc->num_slots; i++) {
356 struct sdhci_slot *slot = &sc->slots[i];
358 sdhci_start_slot(slot);
365 sdhci_pci_detach(device_t dev)
367 struct sdhci_pci_softc *sc = device_get_softc(dev);
370 bus_teardown_intr(dev, sc->irq_res, sc->intrhand);
371 bus_release_resource(dev, SYS_RES_IRQ,
372 rman_get_rid(sc->irq_res), sc->irq_res);
373 pci_release_msi(dev);
375 for (i = 0; i < sc->num_slots; i++) {
376 struct sdhci_slot *slot = &sc->slots[i];
378 sdhci_cleanup_slot(slot);
379 bus_release_resource(dev, SYS_RES_MEMORY,
380 rman_get_rid(sc->mem_res[i]), sc->mem_res[i]);
382 if (sc->quirks & SDHCI_QUIRK_LOWER_FREQUENCY)
383 sdhci_restore_frequency(dev);
388 sdhci_pci_shutdown(device_t dev)
390 struct sdhci_pci_softc *sc = device_get_softc(dev);
392 if (sc->quirks & SDHCI_QUIRK_LOWER_FREQUENCY)
393 sdhci_restore_frequency(dev);
398 sdhci_pci_suspend(device_t dev)
400 struct sdhci_pci_softc *sc = device_get_softc(dev);
403 err = bus_generic_suspend(dev);
406 for (i = 0; i < sc->num_slots; i++)
407 sdhci_generic_suspend(&sc->slots[i]);
412 sdhci_pci_resume(device_t dev)
414 struct sdhci_pci_softc *sc = device_get_softc(dev);
417 for (i = 0; i < sc->num_slots; i++)
418 sdhci_generic_resume(&sc->slots[i]);
419 return (bus_generic_resume(dev));
423 sdhci_pci_intr(void *arg)
425 struct sdhci_pci_softc *sc = (struct sdhci_pci_softc *)arg;
428 for (i = 0; i < sc->num_slots; i++) {
429 struct sdhci_slot *slot = &sc->slots[i];
430 sdhci_generic_intr(slot);
434 static device_method_t sdhci_methods[] = {
436 DEVMETHOD(device_probe, sdhci_pci_probe),
437 DEVMETHOD(device_attach, sdhci_pci_attach),
438 DEVMETHOD(device_detach, sdhci_pci_detach),
439 DEVMETHOD(device_shutdown, sdhci_pci_shutdown),
440 DEVMETHOD(device_suspend, sdhci_pci_suspend),
441 DEVMETHOD(device_resume, sdhci_pci_resume),
444 DEVMETHOD(bus_read_ivar, sdhci_generic_read_ivar),
445 DEVMETHOD(bus_write_ivar, sdhci_generic_write_ivar),
448 DEVMETHOD(mmcbr_update_ios, sdhci_generic_update_ios),
449 DEVMETHOD(mmcbr_request, sdhci_generic_request),
450 DEVMETHOD(mmcbr_get_ro, sdhci_generic_get_ro),
451 DEVMETHOD(mmcbr_acquire_host, sdhci_generic_acquire_host),
452 DEVMETHOD(mmcbr_release_host, sdhci_generic_release_host),
454 /* SDHCI registers accessors */
455 DEVMETHOD(sdhci_read_1, sdhci_pci_read_1),
456 DEVMETHOD(sdhci_read_2, sdhci_pci_read_2),
457 DEVMETHOD(sdhci_read_4, sdhci_pci_read_4),
458 DEVMETHOD(sdhci_read_multi_4, sdhci_pci_read_multi_4),
459 DEVMETHOD(sdhci_write_1, sdhci_pci_write_1),
460 DEVMETHOD(sdhci_write_2, sdhci_pci_write_2),
461 DEVMETHOD(sdhci_write_4, sdhci_pci_write_4),
462 DEVMETHOD(sdhci_write_multi_4, sdhci_pci_write_multi_4),
467 static driver_t sdhci_pci_driver = {
470 sizeof(struct sdhci_pci_softc),
472 static devclass_t sdhci_pci_devclass;
474 DRIVER_MODULE(sdhci_pci, pci, sdhci_pci_driver, sdhci_pci_devclass, NULL,
476 MODULE_DEPEND(sdhci_pci, sdhci, 1, 1, 1);
477 DRIVER_MODULE(mmc, sdhci_pci, mmc_driver, mmc_devclass, NULL, NULL);
478 MODULE_DEPEND(sdhci_pci, mmc, 1, 1, 1);