2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright 2004 by Peter Grehan. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
14 * 3. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
22 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
24 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
34 * Mac 'Kauai' PCI ATA controller
36 #include <sys/param.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
39 #include <sys/module.h>
41 #include <sys/malloc.h>
43 #include <sys/taskqueue.h>
45 #include <machine/stdarg.h>
46 #include <machine/resource.h>
47 #include <machine/bus.h>
50 #include <dev/ata/ata-all.h>
53 #include <dev/ofw/openfirm.h>
54 #include <dev/ofw/ofw_bus.h>
55 #include <machine/intr_machdep.h>
57 #include <dev/pci/pcivar.h>
58 #include <dev/pci/pcireg.h>
60 #include "ata_dbdma.h"
62 #define ATA_KAUAI_REGOFFSET 0x2000
63 #define ATA_KAUAI_DBDMAOFFSET 0x1000
66 * Offset to alt-control register from base
68 #define ATA_KAUAI_ALTOFFSET (ATA_KAUAI_REGOFFSET + 0x160)
71 * Define the gap between registers
73 #define ATA_KAUAI_REGGAP 16
76 * PIO and DMA access registers
78 #define PIO_CONFIG_REG (ATA_KAUAI_REGOFFSET + 0x200)
79 #define UDMA_CONFIG_REG (ATA_KAUAI_REGOFFSET + 0x210)
80 #define DMA_IRQ_REG (ATA_KAUAI_REGOFFSET + 0x300)
82 #define USE_DBDMA_IRQ 0
85 * Define the kauai pci bus attachment.
87 static int ata_kauai_probe(device_t dev);
88 static int ata_kauai_attach(device_t dev);
89 static int ata_kauai_setmode(device_t dev, int target, int mode);
90 static int ata_kauai_begin_transaction(struct ata_request *request);
92 static device_method_t ata_kauai_methods[] = {
93 /* Device interface */
94 DEVMETHOD(device_probe, ata_kauai_probe),
95 DEVMETHOD(device_attach, ata_kauai_attach),
96 DEVMETHOD(device_detach, bus_generic_detach),
97 DEVMETHOD(device_shutdown, bus_generic_shutdown),
98 DEVMETHOD(device_suspend, bus_generic_suspend),
99 DEVMETHOD(device_resume, bus_generic_resume),
102 DEVMETHOD(ata_setmode, ata_kauai_setmode),
106 struct ata_kauai_softc {
107 struct ata_dbdma_channel sc_ch;
109 struct resource *sc_memr;
113 uint32_t udmaconf[2];
114 uint32_t wdmaconf[2];
118 static driver_t ata_kauai_driver = {
121 sizeof(struct ata_kauai_softc),
124 DRIVER_MODULE(ata, pci, ata_kauai_driver, ata_devclass, NULL, NULL);
125 MODULE_DEPEND(ata, ata, 1, 1, 1);
128 * PCI ID search table
130 static const struct kauai_pci_dev {
132 const char *kpd_desc;
133 } kauai_pci_devlist[] = {
134 { 0x0033106b, "Uninorth2 Kauai ATA Controller" },
135 { 0x003b106b, "Intrepid Kauai ATA Controller" },
136 { 0x0043106b, "K2 Kauai ATA Controller" },
137 { 0x0050106b, "Shasta Kauai ATA Controller" },
138 { 0x0069106b, "Intrepid-2 Kauai ATA Controller" },
143 * IDE transfer timings
145 #define KAUAI_PIO_MASK 0xff000fff
146 #define KAUAI_DMA_MASK 0x00fff000
147 #define KAUAI_UDMA_MASK 0x0000ffff
149 static const u_int pio_timing_kauai[] = {
150 0x08000a92, /* PIO0 */
151 0x0800060f, /* PIO1 */
152 0x0800038b, /* PIO2 */
153 0x05000249, /* PIO3 */
154 0x04000148 /* PIO4 */
157 static const u_int pio_timing_shasta[] = {
158 0x0a000c97, /* PIO0 */
159 0x07000712, /* PIO1 */
160 0x040003cd, /* PIO2 */
161 0x0400028b, /* PIO3 */
162 0x0400010a /* PIO4 */
165 static const u_int dma_timing_kauai[] = {
166 0x00618000, /* WDMA0 */
167 0x00209000, /* WDMA1 */
168 0x00148000 /* WDMA2 */
171 static const u_int dma_timing_shasta[] = {
172 0x00820800, /* WDMA0 */
173 0x0028b000, /* WDMA1 */
174 0x001ca000 /* WDMA2 */
177 static const u_int udma_timing_kauai[] = {
178 0x000070c1, /* UDMA0 */
179 0x00005d81, /* UDMA1 */
180 0x00004a61, /* UDMA2 */
181 0x00003a51, /* UDMA3 */
182 0x00002a31, /* UDMA4 */
183 0x00002921 /* UDMA5 */
186 static const u_int udma_timing_shasta[] = {
187 0x00035901, /* UDMA0 */
188 0x000348b1, /* UDMA1 */
189 0x00033881, /* UDMA2 */
190 0x00033861, /* UDMA3 */
191 0x00033841, /* UDMA4 */
192 0x00033031, /* UDMA5 */
193 0x00033021 /* UDMA6 */
197 ata_kauai_probe(device_t dev)
199 struct ata_kauai_softc *sc;
201 const char *compatstring = NULL;
205 devid = pci_get_devid(dev);
206 for (i = 0; kauai_pci_devlist[i].kpd_desc != NULL; i++) {
207 if (devid == kauai_pci_devlist[i].kpd_devid) {
209 device_set_desc(dev, kauai_pci_devlist[i].kpd_desc);
216 sc = device_get_softc(dev);
217 bzero(sc, sizeof(struct ata_kauai_softc));
219 compatstring = ofw_bus_get_compat(dev);
220 if (compatstring != NULL && strcmp(compatstring,"shasta-ata") == 0)
223 /* Pre-K2 controllers apparently need this hack */
225 (compatstring == NULL || strcmp(compatstring, "K2-UATA") != 0))
226 bus_set_resource(dev, SYS_RES_IRQ, 0, 39, 1);
228 return (ata_probe(dev));
233 ata_kauai_dma_interrupt(struct ata_kauai_softc *sc)
235 /* Clear the DMA interrupt bits */
237 bus_write_4(sc->sc_memr, DMA_IRQ_REG, 0x80000000);
239 return ata_interrupt(sc);
244 ata_kauai_attach(device_t dev)
246 struct ata_kauai_softc *sc = device_get_softc(dev);
247 struct ata_channel *ch;
250 int dbdma_irq_rid = 1;
251 struct resource *dbdma_irq;
255 ch = &sc->sc_ch.sc_ch;
258 sc->sc_memr = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
260 if (sc->sc_memr == NULL) {
261 device_printf(dev, "could not allocate memory\n");
266 * Set up the resource vectors
268 for (i = ATA_DATA; i <= ATA_COMMAND; i++) {
269 ch->r_io[i].res = sc->sc_memr;
270 ch->r_io[i].offset = i*ATA_KAUAI_REGGAP + ATA_KAUAI_REGOFFSET;
272 ch->r_io[ATA_CONTROL].res = sc->sc_memr;
273 ch->r_io[ATA_CONTROL].offset = ATA_KAUAI_ALTOFFSET;
274 ata_default_registers(dev);
277 ch->flags |= ATA_USE_16BIT;
279 /* XXX: ATAPI DMA is unreliable. We should find out why. */
280 ch->flags |= ATA_NO_ATAPI_DMA;
283 pci_enable_busmaster(dev);
285 /* Init DMA engine */
287 sc->sc_ch.dbdma_rid = 1;
288 sc->sc_ch.dbdma_regs = sc->sc_memr;
289 sc->sc_ch.dbdma_offset = ATA_KAUAI_DBDMAOFFSET;
291 ata_dbdma_dmainit(dev);
294 /* Bind to DBDMA interrupt as well */
295 if ((dbdma_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
296 &dbdma_irq_rid, RF_SHAREABLE | RF_ACTIVE)) != NULL) {
297 bus_setup_intr(dev, dbdma_irq, ATA_INTR_FLAGS, NULL,
298 (driver_intr_t *)ata_kauai_dma_interrupt, sc,&cookie);
302 /* Set up initial mode */
303 sc->pioconf[0] = sc->pioconf[1] =
304 bus_read_4(sc->sc_memr, PIO_CONFIG_REG) & 0x0f000fff;
306 sc->udmaconf[0] = sc->udmaconf[1] = 0;
307 sc->wdmaconf[0] = sc->wdmaconf[1] = 0;
309 /* Magic FCR value from Apple */
310 bus_write_4(sc->sc_memr, 0, 0x00000007);
312 /* Set begin_transaction */
313 sc->sc_ch.sc_ch.hw.begin_transaction = ata_kauai_begin_transaction;
315 return ata_attach(dev);
319 ata_kauai_setmode(device_t dev, int target, int mode)
321 struct ata_kauai_softc *sc = device_get_softc(dev);
323 mode = min(mode,sc->shasta ? ATA_UDMA6 : ATA_UDMA5);
326 switch (mode & ATA_DMA_MASK) {
329 = udma_timing_shasta[mode & ATA_MODE_MASK];
332 sc->udmaconf[target] = 0;
334 = dma_timing_shasta[mode & ATA_MODE_MASK];
338 = pio_timing_shasta[(mode & ATA_MODE_MASK) -
343 switch (mode & ATA_DMA_MASK) {
346 = udma_timing_kauai[mode & ATA_MODE_MASK];
349 sc->udmaconf[target] = 0;
351 = dma_timing_kauai[mode & ATA_MODE_MASK];
355 = pio_timing_kauai[(mode & ATA_MODE_MASK)
365 ata_kauai_begin_transaction(struct ata_request *request)
367 struct ata_kauai_softc *sc = device_get_softc(request->parent);
369 bus_write_4(sc->sc_memr, UDMA_CONFIG_REG, sc->udmaconf[request->unit]);
370 bus_write_4(sc->sc_memr, PIO_CONFIG_REG,
371 sc->wdmaconf[request->unit] | sc->pioconf[request->unit]);
373 return ata_begin_transaction(request);