1/*-
2 * Copyright (c) 1998 - 2008 S��ren Schmidt <sos@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
14 *
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.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: releng/10.3/sys/dev/ata/ata-pci.c 254263 2013-08-12 23:30:01Z scottl $");
29
30#include <sys/param.h>
31#include <sys/systm.h>
32#include <sys/kernel.h>
33#include <sys/module.h>
34#include <sys/ata.h>
35#include <sys/bus.h>
36#include <sys/conf.h>
37#include <sys/malloc.h>
38#include <sys/sema.h>
39#include <sys/taskqueue.h>
40#include <vm/uma.h>
41#include <machine/stdarg.h>
42#include <machine/resource.h>
43#include <machine/bus.h>
44#include <sys/rman.h>
45#include <dev/pci/pcivar.h>
46#include <dev/pci/pcireg.h>
47#include <dev/ata/ata-all.h>
48#include <dev/ata/ata-pci.h>
49#include <ata_if.h>
50
51MALLOC_DEFINE(M_ATAPCI, "ata_pci", "ATA driver PCI");
52
53/* misc defines */
54#define IOMASK                  0xfffffffc
55
56/*
57 * generic PCI ATA device probe
58 */
59int
60ata_pci_probe(device_t dev)
61{
62    struct ata_pci_controller *ctlr = device_get_softc(dev);
63    char buffer[64];
64
65    /* is this a storage class device ? */
66    if (pci_get_class(dev) != PCIC_STORAGE)
67	return (ENXIO);
68
69    /* is this an IDE/ATA type device ? */
70    if (pci_get_subclass(dev) != PCIS_STORAGE_IDE)
71	return (ENXIO);
72
73    sprintf(buffer, "%s ATA controller", ata_pcivendor2str(dev));
74    device_set_desc_copy(dev, buffer);
75    ctlr->chipinit = ata_generic_chipinit;
76
77    /* we are a low priority handler */
78    return (BUS_PROBE_GENERIC);
79}
80
81int
82ata_pci_attach(device_t dev)
83{
84    struct ata_pci_controller *ctlr = device_get_softc(dev);
85    device_t child;
86    u_int32_t cmd;
87    int unit;
88
89    /* do chipset specific setups only needed once */
90    ctlr->legacy = ata_legacy(dev);
91    if (ctlr->legacy || pci_read_config(dev, PCIR_BAR(2), 4) & IOMASK)
92	ctlr->channels = 2;
93    else
94	ctlr->channels = 1;
95    ctlr->ichannels = -1;
96    ctlr->ch_attach = ata_pci_ch_attach;
97    ctlr->ch_detach = ata_pci_ch_detach;
98    ctlr->dev = dev;
99
100    /* if needed try to enable busmastering */
101    pci_enable_busmaster(dev);
102    cmd = pci_read_config(dev, PCIR_COMMAND, 2);
103
104    /* if busmastering mode "stuck" use it */
105    if ((cmd & PCIM_CMD_BUSMASTEREN) == PCIM_CMD_BUSMASTEREN) {
106	ctlr->r_type1 = SYS_RES_IOPORT;
107	ctlr->r_rid1 = ATA_BMADDR_RID;
108	ctlr->r_res1 = bus_alloc_resource_any(dev, ctlr->r_type1, &ctlr->r_rid1,
109					      RF_ACTIVE);
110    }
111
112    if (ctlr->chipinit(dev))
113	return ENXIO;
114
115    /* attach all channels on this controller */
116    for (unit = 0; unit < ctlr->channels; unit++) {
117	if ((ctlr->ichannels & (1 << unit)) == 0)
118	    continue;
119	child = device_add_child(dev, "ata",
120	    ((unit == 0 || unit == 1) && ctlr->legacy) ?
121	    unit : devclass_find_free_unit(ata_devclass, 2));
122	if (child == NULL)
123	    device_printf(dev, "failed to add ata child device\n");
124	else
125	    device_set_ivars(child, (void *)(intptr_t)unit);
126    }
127    bus_generic_attach(dev);
128    return 0;
129}
130
131int
132ata_pci_detach(device_t dev)
133{
134    struct ata_pci_controller *ctlr = device_get_softc(dev);
135
136    /* detach & delete all children */
137    device_delete_children(dev);
138
139    if (ctlr->r_irq) {
140	bus_teardown_intr(dev, ctlr->r_irq, ctlr->handle);
141	bus_release_resource(dev, SYS_RES_IRQ, ctlr->r_irq_rid, ctlr->r_irq);
142	if (ctlr->r_irq_rid != ATA_IRQ_RID)
143	    pci_release_msi(dev);
144    }
145    if (ctlr->chipdeinit != NULL)
146	ctlr->chipdeinit(dev);
147    if (ctlr->r_res2) {
148#ifdef __sparc64__
149	bus_space_unmap(rman_get_bustag(ctlr->r_res2),
150	    rman_get_bushandle(ctlr->r_res2), rman_get_size(ctlr->r_res2));
151#endif
152	bus_release_resource(dev, ctlr->r_type2, ctlr->r_rid2, ctlr->r_res2);
153    }
154    if (ctlr->r_res1) {
155#ifdef __sparc64__
156	bus_space_unmap(rman_get_bustag(ctlr->r_res1),
157	    rman_get_bushandle(ctlr->r_res1), rman_get_size(ctlr->r_res1));
158#endif
159	bus_release_resource(dev, ctlr->r_type1, ctlr->r_rid1, ctlr->r_res1);
160    }
161
162    return 0;
163}
164
165int
166ata_pci_suspend(device_t dev)
167{
168    struct ata_pci_controller *ctlr = device_get_softc(dev);
169    int error = 0;
170
171    bus_generic_suspend(dev);
172    if (ctlr->suspend)
173	error = ctlr->suspend(dev);
174    return error;
175}
176
177int
178ata_pci_resume(device_t dev)
179{
180    struct ata_pci_controller *ctlr = device_get_softc(dev);
181    int error = 0;
182
183    if (ctlr->resume)
184	error = ctlr->resume(dev);
185    bus_generic_resume(dev);
186    return error;
187}
188
189int
190ata_pci_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
191{
192
193	return (BUS_READ_IVAR(device_get_parent(dev), dev, which, result));
194}
195
196int
197ata_pci_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
198{
199
200	return (BUS_WRITE_IVAR(device_get_parent(dev), dev, which, value));
201}
202
203uint32_t
204ata_pci_read_config(device_t dev, device_t child, int reg, int width)
205{
206
207	return (pci_read_config(dev, reg, width));
208}
209
210void
211ata_pci_write_config(device_t dev, device_t child, int reg,
212    uint32_t val, int width)
213{
214
215	pci_write_config(dev, reg, val, width);
216}
217
218struct resource *
219ata_pci_alloc_resource(device_t dev, device_t child, int type, int *rid,
220		       u_long start, u_long end, u_long count, u_int flags)
221{
222	struct ata_pci_controller *controller = device_get_softc(dev);
223	struct resource *res = NULL;
224
225	if (device_get_devclass(child) == ata_devclass) {
226		int unit = ((struct ata_channel *)device_get_softc(child))->unit;
227		int myrid;
228
229		if (type == SYS_RES_IOPORT) {
230			switch (*rid) {
231			case ATA_IOADDR_RID:
232			    if (controller->legacy) {
233				start = (unit ? ATA_SECONDARY : ATA_PRIMARY);
234				count = ATA_IOSIZE;
235				end = start + count - 1;
236			    }
237			    myrid = PCIR_BAR(0) + (unit << 3);
238			    res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
239				SYS_RES_IOPORT, &myrid,
240				start, end, count, flags);
241			    break;
242			case ATA_CTLADDR_RID:
243			    if (controller->legacy) {
244				start = (unit ? ATA_SECONDARY : ATA_PRIMARY) +
245				    ATA_CTLOFFSET;
246				count = ATA_CTLIOSIZE;
247				end = start + count - 1;
248			    }
249			    myrid = PCIR_BAR(1) + (unit << 3);
250			    res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
251				SYS_RES_IOPORT, &myrid,
252				start, end, count, flags);
253			    break;
254			}
255		}
256		if (type == SYS_RES_IRQ && *rid == ATA_IRQ_RID) {
257			if (controller->legacy) {
258			    int irq = (unit == 0 ? 14 : 15);
259
260			    res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
261				SYS_RES_IRQ, rid, irq, irq, 1, flags);
262			} else
263			    res = controller->r_irq;
264		}
265	} else {
266		if (type == SYS_RES_IRQ) {
267			if (*rid != ATA_IRQ_RID)
268				return (NULL);
269			res = controller->r_irq;
270		} else {
271			res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
272			     type, rid, start, end, count, flags);
273		}
274	}
275	return (res);
276}
277
278int
279ata_pci_release_resource(device_t dev, device_t child, int type, int rid,
280			 struct resource *r)
281{
282
283	if (device_get_devclass(child) == ata_devclass) {
284		struct ata_pci_controller *controller = device_get_softc(dev);
285		int unit = ((struct ata_channel *)device_get_softc(child))->unit;
286
287	        if (type == SYS_RES_IOPORT) {
288	    		switch (rid) {
289			case ATA_IOADDR_RID:
290		    	    return BUS_RELEASE_RESOURCE(device_get_parent(dev), dev,
291				SYS_RES_IOPORT,
292				PCIR_BAR(0) + (unit << 3), r);
293			case ATA_CTLADDR_RID:
294			    return BUS_RELEASE_RESOURCE(device_get_parent(dev), dev,
295				SYS_RES_IOPORT,
296				PCIR_BAR(1) + (unit << 3), r);
297			default:
298			    return ENOENT;
299			}
300		}
301		if (type == SYS_RES_IRQ) {
302			if (rid != ATA_IRQ_RID)
303				return ENOENT;
304			if (controller->legacy) {
305				return BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
306				    SYS_RES_IRQ, rid, r);
307			} else
308				return 0;
309		}
310	} else {
311		if (type == SYS_RES_IRQ) {
312			if (rid != ATA_IRQ_RID)
313				return (ENOENT);
314			return (0);
315		} else {
316			return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
317			    type, rid, r));
318		}
319	}
320	return (EINVAL);
321}
322
323int
324ata_pci_setup_intr(device_t dev, device_t child, struct resource *irq,
325		   int flags, driver_filter_t *filter, driver_intr_t *function,
326		   void *argument, void **cookiep)
327{
328	struct ata_pci_controller *controller = device_get_softc(dev);
329
330	if (controller->legacy) {
331		return BUS_SETUP_INTR(device_get_parent(dev), child, irq,
332			      flags, filter, function, argument, cookiep);
333	} else {
334		struct ata_pci_controller *controller = device_get_softc(dev);
335		int unit;
336
337	    	if (filter != NULL) {
338			printf("ata-pci.c: we cannot use a filter here\n");
339			return (EINVAL);
340		}
341		if (device_get_devclass(child) == ata_devclass)
342			unit = ((struct ata_channel *)device_get_softc(child))->unit;
343		else
344			unit = ATA_PCI_MAX_CH - 1;
345		controller->interrupt[unit].function = function;
346		controller->interrupt[unit].argument = argument;
347		*cookiep = controller;
348		return 0;
349	}
350}
351
352int
353ata_pci_teardown_intr(device_t dev, device_t child, struct resource *irq,
354		      void *cookie)
355{
356	struct ata_pci_controller *controller = device_get_softc(dev);
357
358        if (controller->legacy) {
359		return BUS_TEARDOWN_INTR(device_get_parent(dev), child, irq, cookie);
360	} else {
361		struct ata_pci_controller *controller = device_get_softc(dev);
362		int unit;
363
364		if (device_get_devclass(child) == ata_devclass)
365			unit = ((struct ata_channel *)device_get_softc(child))->unit;
366		else
367			unit = ATA_PCI_MAX_CH - 1;
368		controller->interrupt[unit].function = NULL;
369		controller->interrupt[unit].argument = NULL;
370		return 0;
371	}
372}
373
374int
375ata_generic_setmode(device_t dev, int target, int mode)
376{
377
378	return (min(mode, ATA_UDMA2));
379}
380
381int
382ata_generic_chipinit(device_t dev)
383{
384    struct ata_pci_controller *ctlr = device_get_softc(dev);
385
386    if (ata_setup_interrupt(dev, ata_generic_intr))
387	return ENXIO;
388    ctlr->setmode = ata_generic_setmode;
389    return 0;
390}
391
392int
393ata_pci_ch_attach(device_t dev)
394{
395    struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
396    struct ata_channel *ch = device_get_softc(dev);
397    struct resource *io = NULL, *ctlio = NULL;
398    int i, rid;
399
400    rid = ATA_IOADDR_RID;
401    if (!(io = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE)))
402	return ENXIO;
403
404    rid = ATA_CTLADDR_RID;
405    if (!(ctlio = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,RF_ACTIVE))){
406	bus_release_resource(dev, SYS_RES_IOPORT, ATA_IOADDR_RID, io);
407	return ENXIO;
408    }
409
410    ata_pci_dmainit(dev);
411
412    for (i = ATA_DATA; i <= ATA_COMMAND; i ++) {
413	ch->r_io[i].res = io;
414	ch->r_io[i].offset = i;
415    }
416    ch->r_io[ATA_CONTROL].res = ctlio;
417    ch->r_io[ATA_CONTROL].offset = ctlr->legacy ? 0 : 2;
418    ch->r_io[ATA_IDX_ADDR].res = io;
419    ata_default_registers(dev);
420    if (ctlr->r_res1) {
421	for (i = ATA_BMCMD_PORT; i <= ATA_BMDTP_PORT; i++) {
422	    ch->r_io[i].res = ctlr->r_res1;
423	    ch->r_io[i].offset = (i - ATA_BMCMD_PORT) + (ch->unit*ATA_BMIOSIZE);
424	}
425    }
426
427    ata_pci_hw(dev);
428    return 0;
429}
430
431int
432ata_pci_ch_detach(device_t dev)
433{
434    struct ata_channel *ch = device_get_softc(dev);
435
436    ata_pci_dmafini(dev);
437
438    bus_release_resource(dev, SYS_RES_IOPORT, ATA_CTLADDR_RID,
439	ch->r_io[ATA_CONTROL].res);
440    bus_release_resource(dev, SYS_RES_IOPORT, ATA_IOADDR_RID,
441	ch->r_io[ATA_IDX_ADDR].res);
442
443    return (0);
444}
445
446int
447ata_pci_status(device_t dev)
448{
449    struct ata_pci_controller *controller =
450	device_get_softc(device_get_parent(dev));
451    struct ata_channel *ch = device_get_softc(dev);
452
453    if ((dumping || !controller->legacy) &&
454	((ch->flags & ATA_ALWAYS_DMASTAT) ||
455	 (ch->dma.flags & ATA_DMA_ACTIVE))) {
456	int bmstat = ATA_IDX_INB(ch, ATA_BMSTAT_PORT) & ATA_BMSTAT_MASK;
457
458	if ((bmstat & ATA_BMSTAT_INTERRUPT) == 0)
459	    return 0;
460	ATA_IDX_OUTB(ch, ATA_BMSTAT_PORT, bmstat & ~ATA_BMSTAT_ERROR);
461	DELAY(1);
462    }
463    if (ATA_IDX_INB(ch, ATA_ALTSTAT) & ATA_S_BUSY) {
464	DELAY(100);
465	if (ATA_IDX_INB(ch, ATA_ALTSTAT) & ATA_S_BUSY)
466	    return 0;
467    }
468    return 1;
469}
470
471void
472ata_pci_hw(device_t dev)
473{
474    struct ata_channel *ch = device_get_softc(dev);
475
476    ata_generic_hw(dev);
477    ch->hw.status = ata_pci_status;
478}
479
480static int
481ata_pci_dmastart(struct ata_request *request)
482{
483    struct ata_channel *ch = device_get_softc(request->parent);
484
485    ATA_DEBUG_RQ(request, "dmastart");
486
487    ATA_IDX_OUTB(ch, ATA_BMSTAT_PORT, (ATA_IDX_INB(ch, ATA_BMSTAT_PORT) |
488		 (ATA_BMSTAT_INTERRUPT | ATA_BMSTAT_ERROR)));
489    ATA_IDX_OUTL(ch, ATA_BMDTP_PORT, request->dma->sg_bus);
490    ch->dma.flags |= ATA_DMA_ACTIVE;
491    ATA_IDX_OUTB(ch, ATA_BMCMD_PORT,
492		 (ATA_IDX_INB(ch, ATA_BMCMD_PORT) & ~ATA_BMCMD_WRITE_READ) |
493		 ((request->flags & ATA_R_READ) ? ATA_BMCMD_WRITE_READ : 0)|
494		 ATA_BMCMD_START_STOP);
495    return 0;
496}
497
498static int
499ata_pci_dmastop(struct ata_request *request)
500{
501    struct ata_channel *ch = device_get_softc(request->parent);
502    int error;
503
504    ATA_DEBUG_RQ(request, "dmastop");
505
506    ATA_IDX_OUTB(ch, ATA_BMCMD_PORT,
507		 ATA_IDX_INB(ch, ATA_BMCMD_PORT) & ~ATA_BMCMD_START_STOP);
508    ch->dma.flags &= ~ATA_DMA_ACTIVE;
509    error = ATA_IDX_INB(ch, ATA_BMSTAT_PORT) & ATA_BMSTAT_MASK;
510    ATA_IDX_OUTB(ch, ATA_BMSTAT_PORT, ATA_BMSTAT_INTERRUPT | ATA_BMSTAT_ERROR);
511    return error;
512}
513
514static void
515ata_pci_dmareset(device_t dev)
516{
517    struct ata_channel *ch = device_get_softc(dev);
518    struct ata_request *request;
519
520    ATA_IDX_OUTB(ch, ATA_BMCMD_PORT,
521		 ATA_IDX_INB(ch, ATA_BMCMD_PORT) & ~ATA_BMCMD_START_STOP);
522    ch->dma.flags &= ~ATA_DMA_ACTIVE;
523    ATA_IDX_OUTB(ch, ATA_BMSTAT_PORT, ATA_BMSTAT_INTERRUPT | ATA_BMSTAT_ERROR);
524    if ((request = ch->running)) {
525	device_printf(dev, "DMA reset calling unload\n");
526	ch->dma.unload(request);
527    }
528}
529
530void
531ata_pci_dmainit(device_t dev)
532{
533    struct ata_channel *ch = device_get_softc(dev);
534
535    ata_dmainit(dev);
536    ch->dma.start = ata_pci_dmastart;
537    ch->dma.stop = ata_pci_dmastop;
538    ch->dma.reset = ata_pci_dmareset;
539}
540
541void
542ata_pci_dmafini(device_t dev)
543{
544
545    ata_dmafini(dev);
546}
547
548int
549ata_pci_print_child(device_t dev, device_t child)
550{
551	int retval;
552
553	retval = bus_print_child_header(dev, child);
554	retval += printf(" at channel %d",
555	    (int)(intptr_t)device_get_ivars(child));
556	retval += bus_print_child_footer(dev, child);
557
558	return (retval);
559}
560
561int
562ata_pci_child_location_str(device_t dev, device_t child, char *buf,
563    size_t buflen)
564{
565
566	snprintf(buf, buflen, "channel=%d",
567	    (int)(intptr_t)device_get_ivars(child));
568	return (0);
569}
570
571static bus_dma_tag_t
572ata_pci_get_dma_tag(device_t bus, device_t child)
573{
574
575	return (bus_get_dma_tag(bus));
576}
577
578static device_method_t ata_pci_methods[] = {
579    /* device interface */
580    DEVMETHOD(device_probe,             ata_pci_probe),
581    DEVMETHOD(device_attach,            ata_pci_attach),
582    DEVMETHOD(device_detach,            ata_pci_detach),
583    DEVMETHOD(device_suspend,           ata_pci_suspend),
584    DEVMETHOD(device_resume,            ata_pci_resume),
585    DEVMETHOD(device_shutdown,          bus_generic_shutdown),
586
587    /* bus methods */
588    DEVMETHOD(bus_read_ivar,		ata_pci_read_ivar),
589    DEVMETHOD(bus_write_ivar,		ata_pci_write_ivar),
590    DEVMETHOD(bus_alloc_resource,       ata_pci_alloc_resource),
591    DEVMETHOD(bus_release_resource,     ata_pci_release_resource),
592    DEVMETHOD(bus_activate_resource,    bus_generic_activate_resource),
593    DEVMETHOD(bus_deactivate_resource,  bus_generic_deactivate_resource),
594    DEVMETHOD(bus_setup_intr,           ata_pci_setup_intr),
595    DEVMETHOD(bus_teardown_intr,        ata_pci_teardown_intr),
596    DEVMETHOD(pci_read_config,		ata_pci_read_config),
597    DEVMETHOD(pci_write_config,		ata_pci_write_config),
598    DEVMETHOD(bus_print_child,		ata_pci_print_child),
599    DEVMETHOD(bus_child_location_str,	ata_pci_child_location_str),
600    DEVMETHOD(bus_get_dma_tag,		ata_pci_get_dma_tag),
601
602    DEVMETHOD_END
603};
604
605devclass_t ata_pci_devclass;
606
607static driver_t ata_pci_driver = {
608    "atapci",
609    ata_pci_methods,
610    sizeof(struct ata_pci_controller),
611};
612
613DRIVER_MODULE(atapci, pci, ata_pci_driver, ata_pci_devclass, NULL, NULL);
614MODULE_VERSION(atapci, 1);
615MODULE_DEPEND(atapci, ata, 1, 1, 1);
616
617static int
618ata_pcichannel_probe(device_t dev)
619{
620
621    if ((intptr_t)device_get_ivars(dev) < 0)
622	    return (ENXIO);
623    device_set_desc(dev, "ATA channel");
624
625    return ata_probe(dev);
626}
627
628static int
629ata_pcichannel_attach(device_t dev)
630{
631    struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
632    struct ata_channel *ch = device_get_softc(dev);
633    int error;
634
635    if (ch->attached)
636	return (0);
637    ch->attached = 1;
638
639    ch->dev = dev;
640    ch->unit = (intptr_t)device_get_ivars(dev);
641
642    resource_int_value(device_get_name(dev),
643	device_get_unit(dev), "pm_level", &ch->pm_level);
644
645    if ((error = ctlr->ch_attach(dev)))
646	return error;
647
648    return ata_attach(dev);
649}
650
651static int
652ata_pcichannel_detach(device_t dev)
653{
654    struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
655    struct ata_channel *ch = device_get_softc(dev);
656    int error;
657
658    if (!ch->attached)
659	return (0);
660    ch->attached = 0;
661
662    if ((error = ata_detach(dev)))
663	return error;
664
665    if (ctlr->ch_detach)
666	return (ctlr->ch_detach(dev));
667
668    return (0);
669}
670static int
671ata_pcichannel_suspend(device_t dev)
672{
673    struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
674    struct ata_channel *ch = device_get_softc(dev);
675    int error;
676
677    if (!ch->attached)
678	return (0);
679
680    if ((error = ata_suspend(dev)))
681	return (error);
682
683    if (ctlr->ch_suspend != NULL && (error = ctlr->ch_suspend(dev)))
684	return (error);
685
686    return (0);
687}
688
689static int
690ata_pcichannel_resume(device_t dev)
691{
692    struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
693    struct ata_channel *ch = device_get_softc(dev);
694    int error;
695
696    if (!ch->attached)
697	return (0);
698
699    if (ctlr->ch_resume != NULL && (error = ctlr->ch_resume(dev)))
700	return (error);
701
702    return ata_resume(dev);
703}
704
705static void
706ata_pcichannel_reset(device_t dev)
707{
708    struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
709    struct ata_channel *ch = device_get_softc(dev);
710
711    /* if DMA engine present reset it  */
712    if (ch->dma.reset)
713	ch->dma.reset(dev);
714
715    /* reset the controller HW */
716    if (ctlr->reset)
717	ctlr->reset(dev);
718    else
719	ata_generic_reset(dev);
720}
721
722static int
723ata_pcichannel_setmode(device_t dev, int target, int mode)
724{
725	struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
726
727	if (ctlr->setmode)
728		return (ctlr->setmode(dev, target, mode));
729	else
730		return (ata_generic_setmode(dev, target, mode));
731}
732
733static int
734ata_pcichannel_getrev(device_t dev, int target)
735{
736	struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
737	struct ata_channel *ch = device_get_softc(dev);
738
739	if (ch->flags & ATA_SATA) {
740		if (ctlr->getrev)
741			return (ctlr->getrev(dev, target));
742		else
743			return (0xff);
744	} else
745		return (0);
746}
747
748static device_method_t ata_pcichannel_methods[] = {
749    /* device interface */
750    DEVMETHOD(device_probe,     ata_pcichannel_probe),
751    DEVMETHOD(device_attach,    ata_pcichannel_attach),
752    DEVMETHOD(device_detach,    ata_pcichannel_detach),
753    DEVMETHOD(device_shutdown,  bus_generic_shutdown),
754    DEVMETHOD(device_suspend,   ata_pcichannel_suspend),
755    DEVMETHOD(device_resume,    ata_pcichannel_resume),
756
757    /* ATA methods */
758    DEVMETHOD(ata_setmode,      ata_pcichannel_setmode),
759    DEVMETHOD(ata_getrev,       ata_pcichannel_getrev),
760    DEVMETHOD(ata_reset,        ata_pcichannel_reset),
761
762    DEVMETHOD_END
763};
764
765driver_t ata_pcichannel_driver = {
766    "ata",
767    ata_pcichannel_methods,
768    sizeof(struct ata_channel),
769};
770
771DRIVER_MODULE(ata, atapci, ata_pcichannel_driver, ata_devclass, NULL, NULL);
772
773/*
774 * misc support fucntions
775 */
776int
777ata_legacy(device_t dev)
778{
779    return (((pci_read_config(dev, PCIR_SUBCLASS, 1) == PCIS_STORAGE_IDE) &&
780	     (pci_read_config(dev, PCIR_PROGIF, 1)&PCIP_STORAGE_IDE_MASTERDEV)&&
781	     ((pci_read_config(dev, PCIR_PROGIF, 1) &
782	       (PCIP_STORAGE_IDE_MODEPRIM | PCIP_STORAGE_IDE_MODESEC)) !=
783	      (PCIP_STORAGE_IDE_MODEPRIM | PCIP_STORAGE_IDE_MODESEC))) ||
784	    (!pci_read_config(dev, PCIR_BAR(0), 4) &&
785	     !pci_read_config(dev, PCIR_BAR(1), 4) &&
786	     !pci_read_config(dev, PCIR_BAR(2), 4) &&
787	     !pci_read_config(dev, PCIR_BAR(3), 4) &&
788	     !pci_read_config(dev, PCIR_BAR(5), 4)));
789}
790
791void
792ata_generic_intr(void *data)
793{
794    struct ata_pci_controller *ctlr = data;
795    struct ata_channel *ch;
796    int unit;
797
798    for (unit = 0; unit < ATA_PCI_MAX_CH; unit++) {
799	if ((ch = ctlr->interrupt[unit].argument))
800	    ctlr->interrupt[unit].function(ch);
801    }
802}
803
804int
805ata_setup_interrupt(device_t dev, void *intr_func)
806{
807    struct ata_pci_controller *ctlr = device_get_softc(dev);
808    int i, msi = 0;
809
810    if (!ctlr->legacy) {
811	if (resource_int_value(device_get_name(dev),
812		device_get_unit(dev), "msi", &i) == 0 && i != 0)
813	    msi = 1;
814	if (msi && pci_msi_count(dev) > 0 && pci_alloc_msi(dev, &msi) == 0) {
815	    ctlr->r_irq_rid = 0x1;
816	} else {
817	    msi = 0;
818	    ctlr->r_irq_rid = ATA_IRQ_RID;
819	}
820	if (!(ctlr->r_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
821		&ctlr->r_irq_rid, RF_SHAREABLE | RF_ACTIVE))) {
822	    device_printf(dev, "unable to map interrupt\n");
823	    if (msi)
824		    pci_release_msi(dev);
825	    return ENXIO;
826	}
827	if ((bus_setup_intr(dev, ctlr->r_irq, ATA_INTR_FLAGS, NULL,
828			    intr_func, ctlr, &ctlr->handle))) {
829	    device_printf(dev, "unable to setup interrupt\n");
830	    bus_release_resource(dev,
831		SYS_RES_IRQ, ctlr->r_irq_rid, ctlr->r_irq);
832	    if (msi)
833		    pci_release_msi(dev);
834	    return ENXIO;
835	}
836    }
837    return 0;
838}
839
840void
841ata_set_desc(device_t dev)
842{
843    struct ata_pci_controller *ctlr = device_get_softc(dev);
844    char buffer[128];
845
846    sprintf(buffer, "%s %s %s controller",
847            ata_pcivendor2str(dev), ctlr->chip->text,
848            ata_mode2str(ctlr->chip->max_dma));
849    device_set_desc_copy(dev, buffer);
850}
851
852const struct ata_chip_id *
853ata_match_chip(device_t dev, const struct ata_chip_id *index)
854{
855    uint32_t devid;
856    uint8_t revid;
857
858    devid = pci_get_devid(dev);
859    revid = pci_get_revid(dev);
860    while (index->chipid != 0) {
861	if (devid == index->chipid && revid >= index->chiprev)
862	    return (index);
863	index++;
864    }
865    return (NULL);
866}
867
868const struct ata_chip_id *
869ata_find_chip(device_t dev, const struct ata_chip_id *index, int slot)
870{
871    const struct ata_chip_id *idx;
872    device_t *children;
873    int nchildren, i;
874    uint8_t s;
875
876    if (device_get_children(device_get_parent(dev), &children, &nchildren))
877	return (NULL);
878
879    for (i = 0; i < nchildren; i++) {
880	s = pci_get_slot(children[i]);
881	if ((slot >= 0 && s == slot) || (slot < 0 && s <= -slot)) {
882	    idx = ata_match_chip(children[i], index);
883	    if (idx != NULL) {
884		free(children, M_TEMP);
885		return (idx);
886	    }
887	}
888    }
889    free(children, M_TEMP);
890    return (NULL);
891}
892
893const char *
894ata_pcivendor2str(device_t dev)
895{
896    switch (pci_get_vendor(dev)) {
897    case ATA_ACARD_ID:          return "Acard";
898    case ATA_ACER_LABS_ID:      return "AcerLabs";
899    case ATA_AMD_ID:            return "AMD";
900    case ATA_ADAPTEC_ID:        return "Adaptec";
901    case ATA_ATI_ID:            return "ATI";
902    case ATA_CYRIX_ID:          return "Cyrix";
903    case ATA_CYPRESS_ID:        return "Cypress";
904    case ATA_HIGHPOINT_ID:      return "HighPoint";
905    case ATA_INTEL_ID:          return "Intel";
906    case ATA_ITE_ID:            return "ITE";
907    case ATA_JMICRON_ID:        return "JMicron";
908    case ATA_MARVELL_ID:        return "Marvell";
909    case ATA_MARVELL2_ID:       return "Marvell";
910    case ATA_NATIONAL_ID:       return "National";
911    case ATA_NETCELL_ID:        return "Netcell";
912    case ATA_NVIDIA_ID:         return "nVidia";
913    case ATA_PROMISE_ID:        return "Promise";
914    case ATA_SERVERWORKS_ID:    return "ServerWorks";
915    case ATA_SILICON_IMAGE_ID:  return "SiI";
916    case ATA_SIS_ID:            return "SiS";
917    case ATA_VIA_ID:            return "VIA";
918    case ATA_CENATEK_ID:        return "Cenatek";
919    case ATA_MICRON_ID:         return "Micron";
920    default:                    return "Generic";
921    }
922}
923
924int
925ata_mode2idx(int mode)
926{
927    if ((mode & ATA_DMA_MASK) == ATA_UDMA0)
928	return (mode & ATA_MODE_MASK) + 8;
929    if ((mode & ATA_DMA_MASK) == ATA_WDMA0)
930	return (mode & ATA_MODE_MASK) + 5;
931    return (mode & ATA_MODE_MASK) - ATA_PIO0;
932}
933