2 * Copyright (c) 2010 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 * without modification, immediately at the beginning of the file.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/module.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
35 #include <sys/endian.h>
36 #include <sys/malloc.h>
38 #include <sys/mutex.h>
40 #include <machine/stdarg.h>
41 #include <machine/resource.h>
42 #include <machine/bus.h>
44 #include <dev/pci/pcivar.h>
45 #include <dev/pci/pcireg.h>
48 /* local prototypes */
49 static int mvs_setup_interrupt(device_t dev);
50 static void mvs_intr(void *data);
51 static int mvs_suspend(device_t dev);
52 static int mvs_resume(device_t dev);
53 static int mvs_ctlr_setup(device_t dev);
62 {0x504011ab, 0x00, "Marvell 88SX5040", 4, MVS_Q_GENI},
63 {0x504111ab, 0x00, "Marvell 88SX5041", 4, MVS_Q_GENI},
64 {0x508011ab, 0x00, "Marvell 88SX5080", 8, MVS_Q_GENI},
65 {0x508111ab, 0x00, "Marvell 88SX5081", 8, MVS_Q_GENI},
66 {0x604011ab, 0x00, "Marvell 88SX6040", 4, MVS_Q_GENII},
67 {0x604111ab, 0x00, "Marvell 88SX6041", 4, MVS_Q_GENII},
68 {0x604211ab, 0x00, "Marvell 88SX6042", 4, MVS_Q_GENIIE},
69 {0x608011ab, 0x00, "Marvell 88SX6080", 8, MVS_Q_GENII},
70 {0x608111ab, 0x00, "Marvell 88SX6081", 8, MVS_Q_GENII},
71 {0x704211ab, 0x00, "Marvell 88SX7042", 4, MVS_Q_GENIIE|MVS_Q_CT},
72 {0x02419005, 0x00, "Adaptec 1420SA", 4, MVS_Q_GENII},
73 {0x02439005, 0x00, "Adaptec 1430SA", 4, MVS_Q_GENIIE|MVS_Q_CT},
74 {0x00000000, 0x00, NULL, 0, 0}
78 mvs_probe(device_t dev)
82 uint32_t devid = pci_get_devid(dev);
83 uint8_t revid = pci_get_revid(dev);
85 for (i = 0; mvs_ids[i].id != 0; i++) {
86 if (mvs_ids[i].id == devid &&
87 mvs_ids[i].rev <= revid) {
88 snprintf(buf, sizeof(buf), "%s SATA controller",
90 device_set_desc_copy(dev, buf);
91 return (BUS_PROBE_DEFAULT);
98 mvs_attach(device_t dev)
100 struct mvs_controller *ctlr = device_get_softc(dev);
103 uint32_t devid = pci_get_devid(dev);
104 uint8_t revid = pci_get_revid(dev);
108 while (mvs_ids[i].id != 0 &&
109 (mvs_ids[i].id != devid ||
110 mvs_ids[i].rev > revid))
112 ctlr->channels = mvs_ids[i].ports;
113 ctlr->quirks = mvs_ids[i].quirks;
114 resource_int_value(device_get_name(dev),
115 device_get_unit(dev), "ccc", &ctlr->ccc);
117 resource_int_value(device_get_name(dev),
118 device_get_unit(dev), "cccc", &ctlr->cccc);
119 if (ctlr->ccc == 0 || ctlr->cccc == 0) {
123 if (ctlr->ccc > 100000)
126 "Gen-%s, %d %sGbps ports, Port Multiplier %s%s\n",
127 ((ctlr->quirks & MVS_Q_GENI) ? "I" :
128 ((ctlr->quirks & MVS_Q_GENII) ? "II" : "IIe")),
130 ((ctlr->quirks & MVS_Q_GENI) ? "1.5" : "3"),
131 ((ctlr->quirks & MVS_Q_GENI) ?
132 "not supported" : "supported"),
133 ((ctlr->quirks & MVS_Q_GENIIE) ?
135 mtx_init(&ctlr->mtx, "MVS controller lock", NULL, MTX_DEF);
136 /* We should have a memory BAR(0). */
137 ctlr->r_rid = PCIR_BAR(0);
138 if (!(ctlr->r_mem = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
139 &ctlr->r_rid, RF_ACTIVE)))
141 /* Setup our own memory management for channels. */
142 ctlr->sc_iomem.rm_start = rman_get_start(ctlr->r_mem);
143 ctlr->sc_iomem.rm_end = rman_get_end(ctlr->r_mem);
144 ctlr->sc_iomem.rm_type = RMAN_ARRAY;
145 ctlr->sc_iomem.rm_descr = "I/O memory addresses";
146 if ((error = rman_init(&ctlr->sc_iomem)) != 0) {
147 bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid, ctlr->r_mem);
150 if ((error = rman_manage_region(&ctlr->sc_iomem,
151 rman_get_start(ctlr->r_mem), rman_get_end(ctlr->r_mem))) != 0) {
152 bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid, ctlr->r_mem);
153 rman_fini(&ctlr->sc_iomem);
156 pci_enable_busmaster(dev);
158 /* Setup interrupts. */
159 if (mvs_setup_interrupt(dev)) {
160 bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid, ctlr->r_mem);
161 rman_fini(&ctlr->sc_iomem);
164 /* Attach all channels on this controller */
165 for (unit = 0; unit < ctlr->channels; unit++) {
166 child = device_add_child(dev, "mvsch", -1);
168 device_printf(dev, "failed to add channel device\n");
170 device_set_ivars(child, (void *)(intptr_t)unit);
172 bus_generic_attach(dev);
177 mvs_detach(device_t dev)
179 struct mvs_controller *ctlr = device_get_softc(dev);
181 /* Detach & delete all children */
182 device_delete_children(dev);
184 /* Free interrupt. */
185 if (ctlr->irq.r_irq) {
186 bus_teardown_intr(dev, ctlr->irq.r_irq,
188 bus_release_resource(dev, SYS_RES_IRQ,
189 ctlr->irq.r_irq_rid, ctlr->irq.r_irq);
191 pci_release_msi(dev);
193 rman_fini(&ctlr->sc_iomem);
195 bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid, ctlr->r_mem);
196 mtx_destroy(&ctlr->mtx);
201 mvs_ctlr_setup(device_t dev)
203 struct mvs_controller *ctlr = device_get_softc(dev);
204 int i, ccc = ctlr->ccc, cccc = ctlr->cccc, ccim = 0;
206 /* Mask chip interrupts */
207 ATA_OUTL(ctlr->r_mem, CHIP_MIM, 0x00000000);
208 /* Mask PCI interrupts */
209 ATA_OUTL(ctlr->r_mem, CHIP_PCIIM, 0x00000000);
210 /* Clear PCI interrupts */
211 ATA_OUTL(ctlr->r_mem, CHIP_PCIIC, 0x00000000);
212 if (ccc && bootverbose) {
214 "CCC with %dus/%dcmd enabled\n",
215 ctlr->ccc, ctlr->cccc);
218 /* Configure chip-global CCC */
219 if (ctlr->channels > 4 && (ctlr->quirks & MVS_Q_GENI) == 0) {
220 ATA_OUTL(ctlr->r_mem, CHIP_ICT, cccc);
221 ATA_OUTL(ctlr->r_mem, CHIP_ITT, ccc);
222 ATA_OUTL(ctlr->r_mem, CHIP_ICC, ~CHIP_ICC_ALL_PORTS);
224 ccim |= IC_ALL_PORTS_COAL_DONE;
228 for (i = 0; i < ctlr->channels / 4; i++) {
229 /* Configure per-HC CCC */
230 ATA_OUTL(ctlr->r_mem, HC_BASE(i) + HC_ICT, cccc);
231 ATA_OUTL(ctlr->r_mem, HC_BASE(i) + HC_ITT, ccc);
233 ccim |= (IC_HC0_COAL_DONE << (i * IC_HC_SHIFT));
234 /* Clear HC interrupts */
235 ATA_OUTL(ctlr->r_mem, HC_BASE(i) + HC_IC, 0x00000000);
237 /* Enable chip interrupts */
238 ctlr->gmim = (ccim ? ccim : (IC_DONE_HC0 | IC_DONE_HC1)) |
239 IC_ERR_HC0 | IC_ERR_HC1;
240 ctlr->mim = ctlr->gmim | ctlr->pmim;
241 ATA_OUTL(ctlr->r_mem, CHIP_MIM, ctlr->mim);
242 /* Enable PCI interrupts */
243 ATA_OUTL(ctlr->r_mem, CHIP_PCIIM, 0x007fffff);
248 mvs_edma(device_t dev, device_t child, int mode)
250 struct mvs_controller *ctlr = device_get_softc(dev);
251 int unit = ((struct mvs_channel *)device_get_softc(child))->unit;
252 int bit = IC_DONE_IRQ << (unit * 2 + unit / 4) ;
256 /* CCC is not working for non-EDMA mode. Unmask device interrupts. */
257 mtx_lock(&ctlr->mtx);
258 if (mode == MVS_EDMA_OFF)
262 ctlr->mim = ctlr->gmim | ctlr->pmim;
264 ATA_OUTL(ctlr->r_mem, CHIP_MIM, ctlr->mim);
265 mtx_unlock(&ctlr->mtx);
269 mvs_suspend(device_t dev)
271 struct mvs_controller *ctlr = device_get_softc(dev);
273 bus_generic_suspend(dev);
274 /* Mask chip interrupts */
275 ATA_OUTL(ctlr->r_mem, CHIP_MIM, 0x00000000);
276 /* Mask PCI interrupts */
277 ATA_OUTL(ctlr->r_mem, CHIP_PCIIM, 0x00000000);
282 mvs_resume(device_t dev)
286 return (bus_generic_resume(dev));
290 mvs_setup_interrupt(device_t dev)
292 struct mvs_controller *ctlr = device_get_softc(dev);
296 resource_int_value(device_get_name(dev),
297 device_get_unit(dev), "msi", &msi);
301 msi = min(1, pci_msi_count(dev));
302 /* Allocate MSI if needed/present. */
303 if (msi && pci_alloc_msi(dev, &msi) != 0)
306 /* Allocate all IRQs. */
307 ctlr->irq.r_irq_rid = msi ? 1 : 0;
308 if (!(ctlr->irq.r_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
309 &ctlr->irq.r_irq_rid, RF_SHAREABLE | RF_ACTIVE))) {
310 device_printf(dev, "unable to map interrupt\n");
313 if ((bus_setup_intr(dev, ctlr->irq.r_irq, ATA_INTR_FLAGS, NULL,
314 mvs_intr, ctlr, &ctlr->irq.handle))) {
315 device_printf(dev, "unable to setup interrupt\n");
316 bus_release_resource(dev, SYS_RES_IRQ,
317 ctlr->irq.r_irq_rid, ctlr->irq.r_irq);
325 * Common case interrupt handler.
330 struct mvs_controller *ctlr = data;
331 struct mvs_intr_arg arg;
332 void (*function)(void *);
336 ic = ATA_INL(ctlr->r_mem, CHIP_MIC);
338 /* We have to to mask MSI during processing. */
339 mtx_lock(&ctlr->mtx);
340 ATA_OUTL(ctlr->r_mem, CHIP_MIM, 0);
341 ctlr->msia = 1; /* Deny MIM update during processing. */
342 mtx_unlock(&ctlr->mtx);
345 /* Acknowledge all-ports CCC interrupt. */
346 if (ic & IC_ALL_PORTS_COAL_DONE)
347 ATA_OUTL(ctlr->r_mem, CHIP_ICC, ~CHIP_ICC_ALL_PORTS);
348 for (p = 0; p < ctlr->channels; p++) {
352 if ((ic & IC_HC0) == 0) {
357 /* Acknowledge interrupts of this HC. */
359 if (ic & (IC_DONE_IRQ << 0))
360 aic |= HC_IC_DONE(0) | HC_IC_DEV(0);
361 if (ic & (IC_DONE_IRQ << 2))
362 aic |= HC_IC_DONE(1) | HC_IC_DEV(1);
363 if (ic & (IC_DONE_IRQ << 4))
364 aic |= HC_IC_DONE(2) | HC_IC_DEV(2);
365 if (ic & (IC_DONE_IRQ << 6))
366 aic |= HC_IC_DONE(3) | HC_IC_DEV(3);
367 if (ic & IC_HC0_COAL_DONE)
369 ATA_OUTL(ctlr->r_mem, HC_BASE(p == 4) + HC_IC, ~aic);
371 /* Call per-port interrupt handler. */
372 arg.cause = ic & (IC_ERR_IRQ|IC_DONE_IRQ);
373 if ((arg.cause != 0) &&
374 (function = ctlr->interrupt[p].function)) {
375 arg.arg = ctlr->interrupt[p].argument;
381 /* Unmasking MSI triggers next interrupt, if needed. */
382 mtx_lock(&ctlr->mtx);
383 ctlr->msia = 0; /* Allow MIM update. */
384 ATA_OUTL(ctlr->r_mem, CHIP_MIM, ctlr->mim);
385 mtx_unlock(&ctlr->mtx);
389 static struct resource *
390 mvs_alloc_resource(device_t dev, device_t child, int type, int *rid,
391 u_long start, u_long end, u_long count, u_int flags)
393 struct mvs_controller *ctlr = device_get_softc(dev);
394 int unit = ((struct mvs_channel *)device_get_softc(child))->unit;
395 struct resource *res = NULL;
396 int offset = HC_BASE(unit >> 2) + PORT_BASE(unit & 0x03);
401 st = rman_get_start(ctlr->r_mem);
402 res = rman_reserve_resource(&ctlr->sc_iomem, st + offset,
403 st + offset + PORT_SIZE - 1, PORT_SIZE, RF_ACTIVE, child);
405 bus_space_handle_t bsh;
407 bsh = rman_get_bushandle(ctlr->r_mem);
408 bst = rman_get_bustag(ctlr->r_mem);
409 bus_space_subregion(bst, bsh, offset, PORT_SIZE, &bsh);
410 rman_set_bushandle(res, bsh);
411 rman_set_bustag(res, bst);
415 if (*rid == ATA_IRQ_RID)
416 res = ctlr->irq.r_irq;
423 mvs_release_resource(device_t dev, device_t child, int type, int rid,
429 rman_release_resource(r);
432 if (rid != ATA_IRQ_RID)
440 mvs_setup_intr(device_t dev, device_t child, struct resource *irq,
441 int flags, driver_filter_t *filter, driver_intr_t *function,
442 void *argument, void **cookiep)
444 struct mvs_controller *ctlr = device_get_softc(dev);
445 int unit = (intptr_t)device_get_ivars(child);
447 if (filter != NULL) {
448 printf("mvs.c: we cannot use a filter here\n");
451 ctlr->interrupt[unit].function = function;
452 ctlr->interrupt[unit].argument = argument;
457 mvs_teardown_intr(device_t dev, device_t child, struct resource *irq,
460 struct mvs_controller *ctlr = device_get_softc(dev);
461 int unit = (intptr_t)device_get_ivars(child);
463 ctlr->interrupt[unit].function = NULL;
464 ctlr->interrupt[unit].argument = NULL;
469 mvs_print_child(device_t dev, device_t child)
473 retval = bus_print_child_header(dev, child);
474 retval += printf(" at channel %d",
475 (int)(intptr_t)device_get_ivars(child));
476 retval += bus_print_child_footer(dev, child);
482 mvs_child_location_str(device_t dev, device_t child, char *buf,
486 snprintf(buf, buflen, "channel=%d",
487 (int)(intptr_t)device_get_ivars(child));
492 mvs_get_dma_tag(device_t bus, device_t child)
495 return (bus_get_dma_tag(bus));
498 static device_method_t mvs_methods[] = {
499 DEVMETHOD(device_probe, mvs_probe),
500 DEVMETHOD(device_attach, mvs_attach),
501 DEVMETHOD(device_detach, mvs_detach),
502 DEVMETHOD(device_suspend, mvs_suspend),
503 DEVMETHOD(device_resume, mvs_resume),
504 DEVMETHOD(bus_print_child, mvs_print_child),
505 DEVMETHOD(bus_alloc_resource, mvs_alloc_resource),
506 DEVMETHOD(bus_release_resource, mvs_release_resource),
507 DEVMETHOD(bus_setup_intr, mvs_setup_intr),
508 DEVMETHOD(bus_teardown_intr,mvs_teardown_intr),
509 DEVMETHOD(bus_child_location_str, mvs_child_location_str),
510 DEVMETHOD(bus_get_dma_tag, mvs_get_dma_tag),
511 DEVMETHOD(mvs_edma, mvs_edma),
514 static driver_t mvs_driver = {
517 sizeof(struct mvs_controller)
519 DRIVER_MODULE(mvs, pci, mvs_driver, mvs_devclass, 0, 0);
520 MODULE_VERSION(mvs, 1);
521 MODULE_DEPEND(mvs, cam, 1, 1, 1);