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 SD",
87 SDHCI_QUIRK_FORCE_DMA },
88 { 0xe8231180, 0xffff, "RICOH R5CE823 SD",
89 SDHCI_QUIRK_LOWER_FREQUENCY },
90 { 0x8034104c, 0xffff, "TI XX21/XX11 SD",
91 SDHCI_QUIRK_FORCE_DMA },
92 { 0x05501524, 0xffff, "ENE CB712 SD",
93 SDHCI_QUIRK_BROKEN_TIMINGS },
94 { 0x05511524, 0xffff, "ENE CB712 SD 2",
95 SDHCI_QUIRK_BROKEN_TIMINGS },
96 { 0x07501524, 0xffff, "ENE CB714 SD",
97 SDHCI_QUIRK_RESET_ON_IOS |
98 SDHCI_QUIRK_BROKEN_TIMINGS },
99 { 0x07511524, 0xffff, "ENE CB714 SD 2",
100 SDHCI_QUIRK_RESET_ON_IOS |
101 SDHCI_QUIRK_BROKEN_TIMINGS },
102 { 0x410111ab, 0xffff, "Marvell CaFe SD",
103 SDHCI_QUIRK_INCR_TIMEOUT_CONTROL },
104 { 0x2381197B, 0xffff, "JMicron JMB38X SD",
105 SDHCI_QUIRK_32BIT_DMA_SIZE |
106 SDHCI_QUIRK_RESET_AFTER_REQUEST },
111 struct sdhci_pci_softc {
112 device_t dev; /* Controller device */
113 u_int quirks; /* Chip specific quirks */
114 struct resource *irq_res; /* IRQ resource */
115 void *intrhand; /* Interrupt handle */
117 int num_slots; /* Number of slots on this controller */
118 struct sdhci_slot slots[6];
119 struct resource *mem_res[6]; /* Memory resource */
122 static int sdhci_enable_msi = 1;
123 TUNABLE_INT("hw.sdhci.enable_msi", &sdhci_enable_msi);
124 SYSCTL_INT(_hw_sdhci, OID_AUTO, enable_msi, CTLFLAG_RDTUN, &sdhci_enable_msi,
125 0, "Enable MSI interrupts");
128 sdhci_pci_read_1(device_t dev, struct sdhci_slot *slot, bus_size_t off)
130 struct sdhci_pci_softc *sc = device_get_softc(dev);
132 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
133 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
134 return bus_read_1(sc->mem_res[slot->num], off);
138 sdhci_pci_write_1(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint8_t val)
140 struct sdhci_pci_softc *sc = device_get_softc(dev);
142 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
143 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
144 bus_write_1(sc->mem_res[slot->num], off, val);
148 sdhci_pci_read_2(device_t dev, struct sdhci_slot *slot, bus_size_t off)
150 struct sdhci_pci_softc *sc = device_get_softc(dev);
152 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
153 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
154 return bus_read_2(sc->mem_res[slot->num], off);
158 sdhci_pci_write_2(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint16_t val)
160 struct sdhci_pci_softc *sc = device_get_softc(dev);
162 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
163 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
164 bus_write_2(sc->mem_res[slot->num], off, val);
168 sdhci_pci_read_4(device_t dev, struct sdhci_slot *slot, bus_size_t off)
170 struct sdhci_pci_softc *sc = device_get_softc(dev);
172 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
173 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
174 return bus_read_4(sc->mem_res[slot->num], off);
178 sdhci_pci_write_4(device_t dev, struct sdhci_slot *slot, bus_size_t off, uint32_t val)
180 struct sdhci_pci_softc *sc = device_get_softc(dev);
182 bus_barrier(sc->mem_res[slot->num], 0, 0xFF,
183 BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE);
184 bus_write_4(sc->mem_res[slot->num], off, val);
188 sdhci_pci_read_multi_4(device_t dev, struct sdhci_slot *slot,
189 bus_size_t off, uint32_t *data, bus_size_t count)
191 struct sdhci_pci_softc *sc = device_get_softc(dev);
193 bus_read_multi_stream_4(sc->mem_res[slot->num], off, data, count);
197 sdhci_pci_write_multi_4(device_t dev, struct sdhci_slot *slot,
198 bus_size_t off, uint32_t *data, bus_size_t count)
200 struct sdhci_pci_softc *sc = device_get_softc(dev);
202 bus_write_multi_stream_4(sc->mem_res[slot->num], off, data, count);
205 static void sdhci_pci_intr(void *arg);
208 sdhci_lower_frequency(device_t dev)
211 /* Enable SD2.0 mode. */
212 pci_write_config(dev, SDHC_PCI_MODE_KEY, 0xfc, 1);
213 pci_write_config(dev, SDHC_PCI_MODE, SDHC_PCI_MODE_SD20, 1);
214 pci_write_config(dev, SDHC_PCI_MODE_KEY, 0x00, 1);
217 * Some SD/MMC cards don't work with the default base
218 * clock frequency of 200MHz. Lower it to 50Hz.
220 pci_write_config(dev, SDHC_PCI_BASE_FREQ_KEY, 0x01, 1);
221 pci_write_config(dev, SDHC_PCI_BASE_FREQ, 50, 1);
222 pci_write_config(dev, SDHC_PCI_BASE_FREQ_KEY, 0x00, 1);
226 sdhci_pci_probe(device_t dev)
230 uint8_t class, subclass;
233 model = (uint32_t)pci_get_device(dev) << 16;
234 model |= (uint32_t)pci_get_vendor(dev) & 0x0000ffff;
235 subvendor = pci_get_subvendor(dev);
236 class = pci_get_class(dev);
237 subclass = pci_get_subclass(dev);
240 for (i = 0; sdhci_devices[i].model != 0; i++) {
241 if (sdhci_devices[i].model == model &&
242 (sdhci_devices[i].subvendor == 0xffff ||
243 sdhci_devices[i].subvendor == subvendor)) {
244 device_set_desc(dev, sdhci_devices[i].desc);
245 result = BUS_PROBE_DEFAULT;
249 if (result == ENXIO && class == PCIC_BASEPERIPH &&
250 subclass == PCIS_BASEPERIPH_SDHC) {
251 device_set_desc(dev, "Generic SD HCI");
252 result = BUS_PROBE_GENERIC;
259 sdhci_pci_attach(device_t dev)
261 struct sdhci_pci_softc *sc = device_get_softc(dev);
264 int bar, err, rid, slots, i;
267 model = (uint32_t)pci_get_device(dev) << 16;
268 model |= (uint32_t)pci_get_vendor(dev) & 0x0000ffff;
269 subvendor = pci_get_subvendor(dev);
270 /* Apply chip specific quirks. */
271 for (i = 0; sdhci_devices[i].model != 0; i++) {
272 if (sdhci_devices[i].model == model &&
273 (sdhci_devices[i].subvendor == 0xffff ||
274 sdhci_devices[i].subvendor == subvendor)) {
275 sc->quirks = sdhci_devices[i].quirks;
279 /* Some controllers need to be bumped into the right mode. */
280 if (sc->quirks & SDHCI_QUIRK_LOWER_FREQUENCY)
281 sdhci_lower_frequency(dev);
282 /* Read slots info from PCI registers. */
283 slots = pci_read_config(dev, PCI_SLOT_INFO, 1);
284 bar = PCI_SLOT_INFO_FIRST_BAR(slots);
285 slots = PCI_SLOT_INFO_SLOTS(slots);
286 if (slots > 6 || bar > 5) {
287 device_printf(dev, "Incorrect slots information (%d, %d).\n",
294 if (sdhci_enable_msi != 0 && pci_alloc_msi(dev, &i) == 0)
296 sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
297 RF_ACTIVE | (rid != 0 ? 0 : RF_SHAREABLE));
298 if (sc->irq_res == NULL) {
299 device_printf(dev, "Can't allocate IRQ\n");
300 pci_release_msi(dev);
303 /* Scan all slots. */
304 for (i = 0; i < slots; i++) {
305 struct sdhci_slot *slot = &sc->slots[sc->num_slots];
307 /* Allocate memory. */
308 rid = PCIR_BAR(bar + i);
309 sc->mem_res[i] = bus_alloc_resource(dev, SYS_RES_MEMORY,
310 &rid, 0ul, ~0ul, 0x100, RF_ACTIVE);
311 if (sc->mem_res[i] == NULL) {
312 device_printf(dev, "Can't allocate memory for slot %d\n", i);
316 if (sdhci_init_slot(dev, slot, i) != 0)
321 device_printf(dev, "%d slot(s) allocated\n", sc->num_slots);
322 /* Activate the interrupt */
323 err = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
324 NULL, sdhci_pci_intr, sc, &sc->intrhand);
326 device_printf(dev, "Can't setup IRQ\n");
327 pci_enable_busmaster(dev);
328 /* Process cards detection. */
329 for (i = 0; i < sc->num_slots; i++) {
330 struct sdhci_slot *slot = &sc->slots[i];
332 sdhci_start_slot(slot);
339 sdhci_pci_detach(device_t dev)
341 struct sdhci_pci_softc *sc = device_get_softc(dev);
344 bus_teardown_intr(dev, sc->irq_res, sc->intrhand);
345 bus_release_resource(dev, SYS_RES_IRQ,
346 rman_get_rid(sc->irq_res), sc->irq_res);
347 pci_release_msi(dev);
349 for (i = 0; i < sc->num_slots; i++) {
350 struct sdhci_slot *slot = &sc->slots[i];
352 sdhci_cleanup_slot(slot);
353 bus_release_resource(dev, SYS_RES_MEMORY,
354 rman_get_rid(sc->mem_res[i]), sc->mem_res[i]);
360 sdhci_pci_suspend(device_t dev)
362 struct sdhci_pci_softc *sc = device_get_softc(dev);
365 err = bus_generic_suspend(dev);
368 for (i = 0; i < sc->num_slots; i++)
369 sdhci_generic_suspend(&sc->slots[i]);
374 sdhci_pci_resume(device_t dev)
376 struct sdhci_pci_softc *sc = device_get_softc(dev);
379 for (i = 0; i < sc->num_slots; i++)
380 sdhci_generic_resume(&sc->slots[i]);
381 return (bus_generic_resume(dev));
385 sdhci_pci_intr(void *arg)
387 struct sdhci_pci_softc *sc = (struct sdhci_pci_softc *)arg;
390 for (i = 0; i < sc->num_slots; i++) {
391 struct sdhci_slot *slot = &sc->slots[i];
392 sdhci_generic_intr(slot);
396 static device_method_t sdhci_methods[] = {
398 DEVMETHOD(device_probe, sdhci_pci_probe),
399 DEVMETHOD(device_attach, sdhci_pci_attach),
400 DEVMETHOD(device_detach, sdhci_pci_detach),
401 DEVMETHOD(device_suspend, sdhci_pci_suspend),
402 DEVMETHOD(device_resume, sdhci_pci_resume),
405 DEVMETHOD(bus_read_ivar, sdhci_generic_read_ivar),
406 DEVMETHOD(bus_write_ivar, sdhci_generic_write_ivar),
409 DEVMETHOD(mmcbr_update_ios, sdhci_generic_update_ios),
410 DEVMETHOD(mmcbr_request, sdhci_generic_request),
411 DEVMETHOD(mmcbr_get_ro, sdhci_generic_get_ro),
412 DEVMETHOD(mmcbr_acquire_host, sdhci_generic_acquire_host),
413 DEVMETHOD(mmcbr_release_host, sdhci_generic_release_host),
415 /* SDHCI registers accessors */
416 DEVMETHOD(sdhci_read_1, sdhci_pci_read_1),
417 DEVMETHOD(sdhci_read_2, sdhci_pci_read_2),
418 DEVMETHOD(sdhci_read_4, sdhci_pci_read_4),
419 DEVMETHOD(sdhci_read_multi_4, sdhci_pci_read_multi_4),
420 DEVMETHOD(sdhci_write_1, sdhci_pci_write_1),
421 DEVMETHOD(sdhci_write_2, sdhci_pci_write_2),
422 DEVMETHOD(sdhci_write_4, sdhci_pci_write_4),
423 DEVMETHOD(sdhci_write_multi_4, sdhci_pci_write_multi_4),
428 static driver_t sdhci_pci_driver = {
431 sizeof(struct sdhci_pci_softc),
433 static devclass_t sdhci_pci_devclass;
435 DRIVER_MODULE(sdhci_pci, pci, sdhci_pci_driver, sdhci_pci_devclass, NULL,
437 MODULE_DEPEND(sdhci_pci, sdhci, 1, 1, 1);