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 <arm/mv/mvreg.h>
45 #include <arm/mv/mvvar.h>
46 #include <dev/ofw/ofw_bus.h>
47 #include <dev/ofw/ofw_bus_subr.h>
50 /* local prototypes */
51 static int mvs_setup_interrupt(device_t dev);
52 static void mvs_intr(void *data);
53 static int mvs_suspend(device_t dev);
54 static int mvs_resume(device_t dev);
55 static int mvs_ctlr_setup(device_t dev);
64 {MV_DEV_88F5182, 0x00, "Marvell 88F5182", 2, MVS_Q_GENIIE|MVS_Q_SOC},
65 {MV_DEV_88F6281, 0x00, "Marvell 88F6281", 2, MVS_Q_GENIIE|MVS_Q_SOC},
66 {MV_DEV_MV78100, 0x00, "Marvell MV78100", 2, MVS_Q_GENIIE|MVS_Q_SOC},
67 {MV_DEV_MV78100_Z0, 0x00,"Marvell MV78100", 2, MVS_Q_GENIIE|MVS_Q_SOC},
72 mvs_probe(device_t dev)
76 uint32_t devid, revid;
78 if (!ofw_bus_is_compatible(dev, "mrvl,sata"))
81 soc_id(&devid, &revid);
82 for (i = 0; mvs_ids[i].id != 0; i++) {
83 if (mvs_ids[i].id == devid &&
84 mvs_ids[i].rev <= revid) {
85 snprintf(buf, sizeof(buf), "%s SATA controller",
87 device_set_desc_copy(dev, buf);
88 return (BUS_PROBE_VENDOR);
95 mvs_attach(device_t dev)
97 struct mvs_controller *ctlr = device_get_softc(dev);
100 uint32_t devid, revid;
102 soc_id(&devid, &revid);
105 while (mvs_ids[i].id != 0 &&
106 (mvs_ids[i].id != devid ||
107 mvs_ids[i].rev > revid))
109 ctlr->channels = mvs_ids[i].ports;
110 ctlr->quirks = mvs_ids[i].quirks;
111 resource_int_value(device_get_name(dev),
112 device_get_unit(dev), "ccc", &ctlr->ccc);
114 resource_int_value(device_get_name(dev),
115 device_get_unit(dev), "cccc", &ctlr->cccc);
116 if (ctlr->ccc == 0 || ctlr->cccc == 0) {
120 if (ctlr->ccc > 100000)
123 "Gen-%s, %d %sGbps ports, Port Multiplier %s%s\n",
124 ((ctlr->quirks & MVS_Q_GENI) ? "I" :
125 ((ctlr->quirks & MVS_Q_GENII) ? "II" : "IIe")),
127 ((ctlr->quirks & MVS_Q_GENI) ? "1.5" : "3"),
128 ((ctlr->quirks & MVS_Q_GENI) ?
129 "not supported" : "supported"),
130 ((ctlr->quirks & MVS_Q_GENIIE) ?
132 mtx_init(&ctlr->mtx, "MVS controller lock", NULL, MTX_DEF);
133 /* We should have a memory BAR(0). */
135 if (!(ctlr->r_mem = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
136 &ctlr->r_rid, RF_ACTIVE)))
138 if (ATA_INL(ctlr->r_mem, PORT_BASE(0) + SATA_PHYCFG_OFS) != 0)
139 ctlr->quirks |= MVS_Q_SOC65;
140 /* Setup our own memory management for channels. */
141 ctlr->sc_iomem.rm_start = rman_get_start(ctlr->r_mem);
142 ctlr->sc_iomem.rm_end = rman_get_end(ctlr->r_mem);
143 ctlr->sc_iomem.rm_type = RMAN_ARRAY;
144 ctlr->sc_iomem.rm_descr = "I/O memory addresses";
145 if ((error = rman_init(&ctlr->sc_iomem)) != 0) {
146 bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid, ctlr->r_mem);
149 if ((error = rman_manage_region(&ctlr->sc_iomem,
150 rman_get_start(ctlr->r_mem), rman_get_end(ctlr->r_mem))) != 0) {
151 bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid, ctlr->r_mem);
152 rman_fini(&ctlr->sc_iomem);
156 /* Setup interrupts. */
157 if (mvs_setup_interrupt(dev)) {
158 bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid, ctlr->r_mem);
159 rman_fini(&ctlr->sc_iomem);
162 /* Attach all channels on this controller */
163 for (unit = 0; unit < ctlr->channels; unit++) {
164 child = device_add_child(dev, "mvsch", -1);
166 device_printf(dev, "failed to add channel device\n");
168 device_set_ivars(child, (void *)(intptr_t)unit);
170 bus_generic_attach(dev);
175 mvs_detach(device_t dev)
177 struct mvs_controller *ctlr = device_get_softc(dev);
179 /* Detach & delete all children */
180 device_delete_children(dev);
182 /* Free interrupt. */
183 if (ctlr->irq.r_irq) {
184 bus_teardown_intr(dev, ctlr->irq.r_irq,
186 bus_release_resource(dev, SYS_RES_IRQ,
187 ctlr->irq.r_irq_rid, ctlr->irq.r_irq);
190 rman_fini(&ctlr->sc_iomem);
192 bus_release_resource(dev, SYS_RES_MEMORY, ctlr->r_rid, ctlr->r_mem);
193 mtx_destroy(&ctlr->mtx);
198 mvs_ctlr_setup(device_t dev)
200 struct mvs_controller *ctlr = device_get_softc(dev);
201 int ccc = ctlr->ccc, cccc = ctlr->cccc, ccim = 0;
203 /* Mask chip interrupts */
204 ATA_OUTL(ctlr->r_mem, CHIP_SOC_MIM, 0x00000000);
205 /* Clear HC interrupts */
206 ATA_OUTL(ctlr->r_mem, HC_IC, 0x00000000);
207 /* Clear chip interrupts */
208 ATA_OUTL(ctlr->r_mem, CHIP_SOC_MIC, 0);
209 /* Configure per-HC CCC */
210 if (ccc && bootverbose) {
212 "CCC with %dus/%dcmd enabled\n",
213 ctlr->ccc, ctlr->cccc);
216 ATA_OUTL(ctlr->r_mem, HC_ICT, cccc);
217 ATA_OUTL(ctlr->r_mem, HC_ITT, ccc);
219 ccim |= IC_HC0_COAL_DONE;
220 /* Enable chip interrupts */
221 ctlr->gmim = ((ccc ? IC_HC0_COAL_DONE :
222 (IC_DONE_HC0 & CHIP_SOC_HC0_MASK(ctlr->channels))) |
223 (IC_ERR_HC0 & CHIP_SOC_HC0_MASK(ctlr->channels)));
224 ATA_OUTL(ctlr->r_mem, CHIP_SOC_MIM, ctlr->gmim | ctlr->pmim);
229 mvs_edma(device_t dev, device_t child, int mode)
231 struct mvs_controller *ctlr = device_get_softc(dev);
232 int unit = ((struct mvs_channel *)device_get_softc(child))->unit;
233 int bit = IC_DONE_IRQ << (unit * 2);
237 /* CCC is not working for non-EDMA mode. Unmask device interrupts. */
238 mtx_lock(&ctlr->mtx);
239 if (mode == MVS_EDMA_OFF)
243 ATA_OUTL(ctlr->r_mem, CHIP_SOC_MIM, ctlr->gmim | ctlr->pmim);
244 mtx_unlock(&ctlr->mtx);
248 mvs_suspend(device_t dev)
250 struct mvs_controller *ctlr = device_get_softc(dev);
252 bus_generic_suspend(dev);
253 /* Mask chip interrupts */
254 ATA_OUTL(ctlr->r_mem, CHIP_SOC_MIM, 0x00000000);
259 mvs_resume(device_t dev)
263 return (bus_generic_resume(dev));
267 mvs_setup_interrupt(device_t dev)
269 struct mvs_controller *ctlr = device_get_softc(dev);
271 /* Allocate all IRQs. */
272 ctlr->irq.r_irq_rid = 0;
273 if (!(ctlr->irq.r_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
274 &ctlr->irq.r_irq_rid, RF_SHAREABLE | RF_ACTIVE))) {
275 device_printf(dev, "unable to map interrupt\n");
278 if ((bus_setup_intr(dev, ctlr->irq.r_irq, ATA_INTR_FLAGS, NULL,
279 mvs_intr, ctlr, &ctlr->irq.handle))) {
280 device_printf(dev, "unable to setup interrupt\n");
281 bus_release_resource(dev, SYS_RES_IRQ,
282 ctlr->irq.r_irq_rid, ctlr->irq.r_irq);
290 * Common case interrupt handler.
295 struct mvs_controller *ctlr = data;
296 struct mvs_intr_arg arg;
297 void (*function)(void *);
301 ic = ATA_INL(ctlr->r_mem, CHIP_SOC_MIC);
302 if ((ic & IC_HC0) == 0)
305 /* Acknowledge interrupts of this HC. */
308 /* Processing interrupts from each initialized channel */
309 for (chan_num = 0; chan_num < ctlr->channels; chan_num++) {
310 if (ic & (IC_DONE_IRQ << (chan_num * 2)))
311 aic |= HC_IC_DONE(chan_num) | HC_IC_DEV(chan_num);
314 if (ic & IC_HC0_COAL_DONE)
316 ATA_OUTL(ctlr->r_mem, HC_IC, ~aic);
318 /* Call per-port interrupt handler. */
319 for (p = 0; p < ctlr->channels; p++) {
320 arg.cause = ic & (IC_ERR_IRQ|IC_DONE_IRQ);
321 if ((arg.cause != 0) &&
322 (function = ctlr->interrupt[p].function)) {
323 arg.arg = ctlr->interrupt[p].argument;
330 static struct resource *
331 mvs_alloc_resource(device_t dev, device_t child, int type, int *rid,
332 u_long start, u_long end, u_long count, u_int flags)
334 struct mvs_controller *ctlr = device_get_softc(dev);
335 int unit = ((struct mvs_channel *)device_get_softc(child))->unit;
336 struct resource *res = NULL;
337 int offset = PORT_BASE(unit & 0x03);
342 st = rman_get_start(ctlr->r_mem);
343 res = rman_reserve_resource(&ctlr->sc_iomem, st + offset,
344 st + offset + PORT_SIZE - 1, PORT_SIZE, RF_ACTIVE, child);
346 bus_space_handle_t bsh;
348 bsh = rman_get_bushandle(ctlr->r_mem);
349 bst = rman_get_bustag(ctlr->r_mem);
350 bus_space_subregion(bst, bsh, offset, PORT_SIZE, &bsh);
351 rman_set_bushandle(res, bsh);
352 rman_set_bustag(res, bst);
356 if (*rid == ATA_IRQ_RID)
357 res = ctlr->irq.r_irq;
364 mvs_release_resource(device_t dev, device_t child, int type, int rid,
370 rman_release_resource(r);
373 if (rid != ATA_IRQ_RID)
381 mvs_setup_intr(device_t dev, device_t child, struct resource *irq,
382 int flags, driver_filter_t *filter, driver_intr_t *function,
383 void *argument, void **cookiep)
385 struct mvs_controller *ctlr = device_get_softc(dev);
386 int unit = (intptr_t)device_get_ivars(child);
388 if (filter != NULL) {
389 printf("mvs.c: we cannot use a filter here\n");
392 ctlr->interrupt[unit].function = function;
393 ctlr->interrupt[unit].argument = argument;
398 mvs_teardown_intr(device_t dev, device_t child, struct resource *irq,
401 struct mvs_controller *ctlr = device_get_softc(dev);
402 int unit = (intptr_t)device_get_ivars(child);
404 ctlr->interrupt[unit].function = NULL;
405 ctlr->interrupt[unit].argument = NULL;
410 mvs_print_child(device_t dev, device_t child)
414 retval = bus_print_child_header(dev, child);
415 retval += printf(" at channel %d",
416 (int)(intptr_t)device_get_ivars(child));
417 retval += bus_print_child_footer(dev, child);
423 mvs_child_location_str(device_t dev, device_t child, char *buf,
427 snprintf(buf, buflen, "channel=%d",
428 (int)(intptr_t)device_get_ivars(child));
432 static device_method_t mvs_methods[] = {
433 DEVMETHOD(device_probe, mvs_probe),
434 DEVMETHOD(device_attach, mvs_attach),
435 DEVMETHOD(device_detach, mvs_detach),
436 DEVMETHOD(device_suspend, mvs_suspend),
437 DEVMETHOD(device_resume, mvs_resume),
438 DEVMETHOD(bus_print_child, mvs_print_child),
439 DEVMETHOD(bus_alloc_resource, mvs_alloc_resource),
440 DEVMETHOD(bus_release_resource, mvs_release_resource),
441 DEVMETHOD(bus_setup_intr, mvs_setup_intr),
442 DEVMETHOD(bus_teardown_intr,mvs_teardown_intr),
443 DEVMETHOD(mvs_edma, mvs_edma),
444 DEVMETHOD(bus_child_location_str, mvs_child_location_str),
447 static driver_t mvs_driver = {
450 sizeof(struct mvs_controller)
452 DRIVER_MODULE(mvs, simplebus, mvs_driver, mvs_devclass, 0, 0);
453 MODULE_VERSION(mvs, 1);
454 MODULE_DEPEND(mvs, cam, 1, 1, 1);