xref: /freebsd/sys/dev/ata/ata-pci.c (revision 3fc36ee018bb836bd1796067cf4ef8683f166ebc)
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$");
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 
51 MALLOC_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  */
59 int
60 ata_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 
81 int
82 ata_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 
131 int
132 ata_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 
165 int
166 ata_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 
177 int
178 ata_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 
189 int
190 ata_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 
196 int
197 ata_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 
203 uint32_t
204 ata_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 
210 void
211 ata_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 
218 struct resource *
219 ata_pci_alloc_resource(device_t dev, device_t child, int type, int *rid,
220 		       rman_res_t start, rman_res_t end, rman_res_t count,
221 		       u_int flags)
222 {
223 	struct ata_pci_controller *controller = device_get_softc(dev);
224 	struct resource *res = NULL;
225 
226 	if (device_get_devclass(child) == ata_devclass) {
227 		int unit = ((struct ata_channel *)device_get_softc(child))->unit;
228 		int myrid;
229 
230 		if (type == SYS_RES_IOPORT) {
231 			switch (*rid) {
232 			case ATA_IOADDR_RID:
233 			    if (controller->legacy) {
234 				start = (unit ? ATA_SECONDARY : ATA_PRIMARY);
235 				count = ATA_IOSIZE;
236 				end = start + count - 1;
237 			    }
238 			    myrid = PCIR_BAR(0) + (unit << 3);
239 			    res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
240 				SYS_RES_IOPORT, &myrid,
241 				start, end, count, flags);
242 			    break;
243 			case ATA_CTLADDR_RID:
244 			    if (controller->legacy) {
245 				start = (unit ? ATA_SECONDARY : ATA_PRIMARY) +
246 				    ATA_CTLOFFSET;
247 				count = ATA_CTLIOSIZE;
248 				end = start + count - 1;
249 			    }
250 			    myrid = PCIR_BAR(1) + (unit << 3);
251 			    res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
252 				SYS_RES_IOPORT, &myrid,
253 				start, end, count, flags);
254 			    break;
255 			}
256 		}
257 		if (type == SYS_RES_IRQ && *rid == ATA_IRQ_RID) {
258 			if (controller->legacy) {
259 			    int irq = (unit == 0 ? 14 : 15);
260 
261 			    res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
262 				SYS_RES_IRQ, rid, irq, irq, 1, flags);
263 			} else
264 			    res = controller->r_irq;
265 		}
266 	} else {
267 		if (type == SYS_RES_IRQ) {
268 			if (*rid != ATA_IRQ_RID)
269 				return (NULL);
270 			res = controller->r_irq;
271 		} else {
272 			res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
273 			     type, rid, start, end, count, flags);
274 		}
275 	}
276 	return (res);
277 }
278 
279 int
280 ata_pci_release_resource(device_t dev, device_t child, int type, int rid,
281 			 struct resource *r)
282 {
283 
284 	if (device_get_devclass(child) == ata_devclass) {
285 		struct ata_pci_controller *controller = device_get_softc(dev);
286 		int unit = ((struct ata_channel *)device_get_softc(child))->unit;
287 
288 	        if (type == SYS_RES_IOPORT) {
289 	    		switch (rid) {
290 			case ATA_IOADDR_RID:
291 		    	    return BUS_RELEASE_RESOURCE(device_get_parent(dev), dev,
292 				SYS_RES_IOPORT,
293 				PCIR_BAR(0) + (unit << 3), r);
294 			case ATA_CTLADDR_RID:
295 			    return BUS_RELEASE_RESOURCE(device_get_parent(dev), dev,
296 				SYS_RES_IOPORT,
297 				PCIR_BAR(1) + (unit << 3), r);
298 			default:
299 			    return ENOENT;
300 			}
301 		}
302 		if (type == SYS_RES_IRQ) {
303 			if (rid != ATA_IRQ_RID)
304 				return ENOENT;
305 			if (controller->legacy) {
306 				return BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
307 				    SYS_RES_IRQ, rid, r);
308 			} else
309 				return 0;
310 		}
311 	} else {
312 		if (type == SYS_RES_IRQ) {
313 			if (rid != ATA_IRQ_RID)
314 				return (ENOENT);
315 			return (0);
316 		} else {
317 			return (BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
318 			    type, rid, r));
319 		}
320 	}
321 	return (EINVAL);
322 }
323 
324 int
325 ata_pci_setup_intr(device_t dev, device_t child, struct resource *irq,
326 		   int flags, driver_filter_t *filter, driver_intr_t *function,
327 		   void *argument, void **cookiep)
328 {
329 	struct ata_pci_controller *controller = device_get_softc(dev);
330 
331 	if (controller->legacy) {
332 		return BUS_SETUP_INTR(device_get_parent(dev), child, irq,
333 			      flags, filter, function, argument, cookiep);
334 	} else {
335 		struct ata_pci_controller *controller = device_get_softc(dev);
336 		int unit;
337 
338 	    	if (filter != NULL) {
339 			printf("ata-pci.c: we cannot use a filter here\n");
340 			return (EINVAL);
341 		}
342 		if (device_get_devclass(child) == ata_devclass)
343 			unit = ((struct ata_channel *)device_get_softc(child))->unit;
344 		else
345 			unit = ATA_PCI_MAX_CH - 1;
346 		controller->interrupt[unit].function = function;
347 		controller->interrupt[unit].argument = argument;
348 		*cookiep = controller;
349 		return 0;
350 	}
351 }
352 
353 int
354 ata_pci_teardown_intr(device_t dev, device_t child, struct resource *irq,
355 		      void *cookie)
356 {
357 	struct ata_pci_controller *controller = device_get_softc(dev);
358 
359         if (controller->legacy) {
360 		return BUS_TEARDOWN_INTR(device_get_parent(dev), child, irq, cookie);
361 	} else {
362 		struct ata_pci_controller *controller = device_get_softc(dev);
363 		int unit;
364 
365 		if (device_get_devclass(child) == ata_devclass)
366 			unit = ((struct ata_channel *)device_get_softc(child))->unit;
367 		else
368 			unit = ATA_PCI_MAX_CH - 1;
369 		controller->interrupt[unit].function = NULL;
370 		controller->interrupt[unit].argument = NULL;
371 		return 0;
372 	}
373 }
374 
375 int
376 ata_generic_setmode(device_t dev, int target, int mode)
377 {
378 
379 	return (min(mode, ATA_UDMA2));
380 }
381 
382 int
383 ata_generic_chipinit(device_t dev)
384 {
385     struct ata_pci_controller *ctlr = device_get_softc(dev);
386 
387     if (ata_setup_interrupt(dev, ata_generic_intr))
388 	return ENXIO;
389     ctlr->setmode = ata_generic_setmode;
390     return 0;
391 }
392 
393 int
394 ata_pci_ch_attach(device_t dev)
395 {
396     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
397     struct ata_channel *ch = device_get_softc(dev);
398     struct resource *io = NULL, *ctlio = NULL;
399     int i, rid;
400 
401     rid = ATA_IOADDR_RID;
402     if (!(io = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid, RF_ACTIVE)))
403 	return ENXIO;
404 
405     rid = ATA_CTLADDR_RID;
406     if (!(ctlio = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,RF_ACTIVE))){
407 	bus_release_resource(dev, SYS_RES_IOPORT, ATA_IOADDR_RID, io);
408 	return ENXIO;
409     }
410 
411     ata_pci_dmainit(dev);
412 
413     for (i = ATA_DATA; i <= ATA_COMMAND; i ++) {
414 	ch->r_io[i].res = io;
415 	ch->r_io[i].offset = i;
416     }
417     ch->r_io[ATA_CONTROL].res = ctlio;
418     ch->r_io[ATA_CONTROL].offset = ctlr->legacy ? 0 : 2;
419     ch->r_io[ATA_IDX_ADDR].res = io;
420     ata_default_registers(dev);
421     if (ctlr->r_res1) {
422 	for (i = ATA_BMCMD_PORT; i <= ATA_BMDTP_PORT; i++) {
423 	    ch->r_io[i].res = ctlr->r_res1;
424 	    ch->r_io[i].offset = (i - ATA_BMCMD_PORT) + (ch->unit*ATA_BMIOSIZE);
425 	}
426     }
427 
428     ata_pci_hw(dev);
429     return 0;
430 }
431 
432 int
433 ata_pci_ch_detach(device_t dev)
434 {
435     struct ata_channel *ch = device_get_softc(dev);
436 
437     ata_pci_dmafini(dev);
438 
439     bus_release_resource(dev, SYS_RES_IOPORT, ATA_CTLADDR_RID,
440 	ch->r_io[ATA_CONTROL].res);
441     bus_release_resource(dev, SYS_RES_IOPORT, ATA_IOADDR_RID,
442 	ch->r_io[ATA_IDX_ADDR].res);
443 
444     return (0);
445 }
446 
447 int
448 ata_pci_status(device_t dev)
449 {
450     struct ata_pci_controller *controller =
451 	device_get_softc(device_get_parent(dev));
452     struct ata_channel *ch = device_get_softc(dev);
453 
454     if ((dumping || !controller->legacy) &&
455 	((ch->flags & ATA_ALWAYS_DMASTAT) ||
456 	 (ch->dma.flags & ATA_DMA_ACTIVE))) {
457 	int bmstat = ATA_IDX_INB(ch, ATA_BMSTAT_PORT) & ATA_BMSTAT_MASK;
458 
459 	if ((bmstat & ATA_BMSTAT_INTERRUPT) == 0)
460 	    return 0;
461 	ATA_IDX_OUTB(ch, ATA_BMSTAT_PORT, bmstat & ~ATA_BMSTAT_ERROR);
462 	DELAY(1);
463     }
464     if (ATA_IDX_INB(ch, ATA_ALTSTAT) & ATA_S_BUSY) {
465 	DELAY(100);
466 	if (ATA_IDX_INB(ch, ATA_ALTSTAT) & ATA_S_BUSY)
467 	    return 0;
468     }
469     return 1;
470 }
471 
472 void
473 ata_pci_hw(device_t dev)
474 {
475     struct ata_channel *ch = device_get_softc(dev);
476 
477     ata_generic_hw(dev);
478     ch->hw.status = ata_pci_status;
479 }
480 
481 static int
482 ata_pci_dmastart(struct ata_request *request)
483 {
484     struct ata_channel *ch = device_get_softc(request->parent);
485 
486     ATA_DEBUG_RQ(request, "dmastart");
487 
488     ATA_IDX_OUTB(ch, ATA_BMSTAT_PORT, (ATA_IDX_INB(ch, ATA_BMSTAT_PORT) |
489 		 (ATA_BMSTAT_INTERRUPT | ATA_BMSTAT_ERROR)));
490     ATA_IDX_OUTL(ch, ATA_BMDTP_PORT, request->dma->sg_bus);
491     ch->dma.flags |= ATA_DMA_ACTIVE;
492     ATA_IDX_OUTB(ch, ATA_BMCMD_PORT,
493 		 (ATA_IDX_INB(ch, ATA_BMCMD_PORT) & ~ATA_BMCMD_WRITE_READ) |
494 		 ((request->flags & ATA_R_READ) ? ATA_BMCMD_WRITE_READ : 0)|
495 		 ATA_BMCMD_START_STOP);
496     return 0;
497 }
498 
499 static int
500 ata_pci_dmastop(struct ata_request *request)
501 {
502     struct ata_channel *ch = device_get_softc(request->parent);
503     int error;
504 
505     ATA_DEBUG_RQ(request, "dmastop");
506 
507     ATA_IDX_OUTB(ch, ATA_BMCMD_PORT,
508 		 ATA_IDX_INB(ch, ATA_BMCMD_PORT) & ~ATA_BMCMD_START_STOP);
509     ch->dma.flags &= ~ATA_DMA_ACTIVE;
510     error = ATA_IDX_INB(ch, ATA_BMSTAT_PORT) & ATA_BMSTAT_MASK;
511     ATA_IDX_OUTB(ch, ATA_BMSTAT_PORT, ATA_BMSTAT_INTERRUPT | ATA_BMSTAT_ERROR);
512     return error;
513 }
514 
515 static void
516 ata_pci_dmareset(device_t dev)
517 {
518     struct ata_channel *ch = device_get_softc(dev);
519     struct ata_request *request;
520 
521     ATA_IDX_OUTB(ch, ATA_BMCMD_PORT,
522 		 ATA_IDX_INB(ch, ATA_BMCMD_PORT) & ~ATA_BMCMD_START_STOP);
523     ch->dma.flags &= ~ATA_DMA_ACTIVE;
524     ATA_IDX_OUTB(ch, ATA_BMSTAT_PORT, ATA_BMSTAT_INTERRUPT | ATA_BMSTAT_ERROR);
525     if ((request = ch->running)) {
526 	device_printf(dev, "DMA reset calling unload\n");
527 	ch->dma.unload(request);
528     }
529 }
530 
531 void
532 ata_pci_dmainit(device_t dev)
533 {
534     struct ata_channel *ch = device_get_softc(dev);
535 
536     ata_dmainit(dev);
537     ch->dma.start = ata_pci_dmastart;
538     ch->dma.stop = ata_pci_dmastop;
539     ch->dma.reset = ata_pci_dmareset;
540 }
541 
542 void
543 ata_pci_dmafini(device_t dev)
544 {
545 
546     ata_dmafini(dev);
547 }
548 
549 int
550 ata_pci_print_child(device_t dev, device_t child)
551 {
552 	int retval;
553 
554 	retval = bus_print_child_header(dev, child);
555 	retval += printf(" at channel %d",
556 	    (int)(intptr_t)device_get_ivars(child));
557 	retval += bus_print_child_footer(dev, child);
558 
559 	return (retval);
560 }
561 
562 int
563 ata_pci_child_location_str(device_t dev, device_t child, char *buf,
564     size_t buflen)
565 {
566 
567 	snprintf(buf, buflen, "channel=%d",
568 	    (int)(intptr_t)device_get_ivars(child));
569 	return (0);
570 }
571 
572 static bus_dma_tag_t
573 ata_pci_get_dma_tag(device_t bus, device_t child)
574 {
575 
576 	return (bus_get_dma_tag(bus));
577 }
578 
579 static device_method_t ata_pci_methods[] = {
580     /* device interface */
581     DEVMETHOD(device_probe,             ata_pci_probe),
582     DEVMETHOD(device_attach,            ata_pci_attach),
583     DEVMETHOD(device_detach,            ata_pci_detach),
584     DEVMETHOD(device_suspend,           ata_pci_suspend),
585     DEVMETHOD(device_resume,            ata_pci_resume),
586     DEVMETHOD(device_shutdown,          bus_generic_shutdown),
587 
588     /* bus methods */
589     DEVMETHOD(bus_read_ivar,		ata_pci_read_ivar),
590     DEVMETHOD(bus_write_ivar,		ata_pci_write_ivar),
591     DEVMETHOD(bus_alloc_resource,       ata_pci_alloc_resource),
592     DEVMETHOD(bus_release_resource,     ata_pci_release_resource),
593     DEVMETHOD(bus_activate_resource,    bus_generic_activate_resource),
594     DEVMETHOD(bus_deactivate_resource,  bus_generic_deactivate_resource),
595     DEVMETHOD(bus_setup_intr,           ata_pci_setup_intr),
596     DEVMETHOD(bus_teardown_intr,        ata_pci_teardown_intr),
597     DEVMETHOD(pci_read_config,		ata_pci_read_config),
598     DEVMETHOD(pci_write_config,		ata_pci_write_config),
599     DEVMETHOD(bus_print_child,		ata_pci_print_child),
600     DEVMETHOD(bus_child_location_str,	ata_pci_child_location_str),
601     DEVMETHOD(bus_get_dma_tag,		ata_pci_get_dma_tag),
602 
603     DEVMETHOD_END
604 };
605 
606 devclass_t ata_pci_devclass;
607 
608 static driver_t ata_pci_driver = {
609     "atapci",
610     ata_pci_methods,
611     sizeof(struct ata_pci_controller),
612 };
613 
614 DRIVER_MODULE(atapci, pci, ata_pci_driver, ata_pci_devclass, NULL, NULL);
615 MODULE_VERSION(atapci, 1);
616 MODULE_DEPEND(atapci, ata, 1, 1, 1);
617 
618 static int
619 ata_pcichannel_probe(device_t dev)
620 {
621 
622     if ((intptr_t)device_get_ivars(dev) < 0)
623 	    return (ENXIO);
624     device_set_desc(dev, "ATA channel");
625 
626     return ata_probe(dev);
627 }
628 
629 static int
630 ata_pcichannel_attach(device_t dev)
631 {
632     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
633     struct ata_channel *ch = device_get_softc(dev);
634     int error;
635 
636     if (ch->attached)
637 	return (0);
638     ch->attached = 1;
639 
640     ch->dev = dev;
641     ch->unit = (intptr_t)device_get_ivars(dev);
642 
643     resource_int_value(device_get_name(dev),
644 	device_get_unit(dev), "pm_level", &ch->pm_level);
645 
646     if ((error = ctlr->ch_attach(dev)))
647 	return error;
648 
649     return ata_attach(dev);
650 }
651 
652 static int
653 ata_pcichannel_detach(device_t dev)
654 {
655     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
656     struct ata_channel *ch = device_get_softc(dev);
657     int error;
658 
659     if (!ch->attached)
660 	return (0);
661     ch->attached = 0;
662 
663     if ((error = ata_detach(dev)))
664 	return error;
665 
666     if (ctlr->ch_detach)
667 	return (ctlr->ch_detach(dev));
668 
669     return (0);
670 }
671 static int
672 ata_pcichannel_suspend(device_t dev)
673 {
674     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
675     struct ata_channel *ch = device_get_softc(dev);
676     int error;
677 
678     if (!ch->attached)
679 	return (0);
680 
681     if ((error = ata_suspend(dev)))
682 	return (error);
683 
684     if (ctlr->ch_suspend != NULL && (error = ctlr->ch_suspend(dev)))
685 	return (error);
686 
687     return (0);
688 }
689 
690 static int
691 ata_pcichannel_resume(device_t dev)
692 {
693     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
694     struct ata_channel *ch = device_get_softc(dev);
695     int error;
696 
697     if (!ch->attached)
698 	return (0);
699 
700     if (ctlr->ch_resume != NULL && (error = ctlr->ch_resume(dev)))
701 	return (error);
702 
703     return ata_resume(dev);
704 }
705 
706 static void
707 ata_pcichannel_reset(device_t dev)
708 {
709     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
710     struct ata_channel *ch = device_get_softc(dev);
711 
712     /* if DMA engine present reset it  */
713     if (ch->dma.reset)
714 	ch->dma.reset(dev);
715 
716     /* reset the controller HW */
717     if (ctlr->reset)
718 	ctlr->reset(dev);
719     else
720 	ata_generic_reset(dev);
721 }
722 
723 static int
724 ata_pcichannel_setmode(device_t dev, int target, int mode)
725 {
726 	struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
727 
728 	if (ctlr->setmode)
729 		return (ctlr->setmode(dev, target, mode));
730 	else
731 		return (ata_generic_setmode(dev, target, mode));
732 }
733 
734 static int
735 ata_pcichannel_getrev(device_t dev, int target)
736 {
737 	struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
738 	struct ata_channel *ch = device_get_softc(dev);
739 
740 	if (ch->flags & ATA_SATA) {
741 		if (ctlr->getrev)
742 			return (ctlr->getrev(dev, target));
743 		else
744 			return (0xff);
745 	} else
746 		return (0);
747 }
748 
749 static device_method_t ata_pcichannel_methods[] = {
750     /* device interface */
751     DEVMETHOD(device_probe,     ata_pcichannel_probe),
752     DEVMETHOD(device_attach,    ata_pcichannel_attach),
753     DEVMETHOD(device_detach,    ata_pcichannel_detach),
754     DEVMETHOD(device_shutdown,  bus_generic_shutdown),
755     DEVMETHOD(device_suspend,   ata_pcichannel_suspend),
756     DEVMETHOD(device_resume,    ata_pcichannel_resume),
757 
758     /* ATA methods */
759     DEVMETHOD(ata_setmode,      ata_pcichannel_setmode),
760     DEVMETHOD(ata_getrev,       ata_pcichannel_getrev),
761     DEVMETHOD(ata_reset,        ata_pcichannel_reset),
762 
763     DEVMETHOD_END
764 };
765 
766 driver_t ata_pcichannel_driver = {
767     "ata",
768     ata_pcichannel_methods,
769     sizeof(struct ata_channel),
770 };
771 
772 DRIVER_MODULE(ata, atapci, ata_pcichannel_driver, ata_devclass, NULL, NULL);
773 
774 /*
775  * misc support fucntions
776  */
777 int
778 ata_legacy(device_t dev)
779 {
780     return (((pci_read_config(dev, PCIR_SUBCLASS, 1) == PCIS_STORAGE_IDE) &&
781 	     (pci_read_config(dev, PCIR_PROGIF, 1)&PCIP_STORAGE_IDE_MASTERDEV)&&
782 	     ((pci_read_config(dev, PCIR_PROGIF, 1) &
783 	       (PCIP_STORAGE_IDE_MODEPRIM | PCIP_STORAGE_IDE_MODESEC)) !=
784 	      (PCIP_STORAGE_IDE_MODEPRIM | PCIP_STORAGE_IDE_MODESEC))) ||
785 	    (!pci_read_config(dev, PCIR_BAR(0), 4) &&
786 	     !pci_read_config(dev, PCIR_BAR(1), 4) &&
787 	     !pci_read_config(dev, PCIR_BAR(2), 4) &&
788 	     !pci_read_config(dev, PCIR_BAR(3), 4) &&
789 	     !pci_read_config(dev, PCIR_BAR(5), 4)));
790 }
791 
792 void
793 ata_generic_intr(void *data)
794 {
795     struct ata_pci_controller *ctlr = data;
796     struct ata_channel *ch;
797     int unit;
798 
799     for (unit = 0; unit < ATA_PCI_MAX_CH; unit++) {
800 	if ((ch = ctlr->interrupt[unit].argument))
801 	    ctlr->interrupt[unit].function(ch);
802     }
803 }
804 
805 int
806 ata_setup_interrupt(device_t dev, void *intr_func)
807 {
808     struct ata_pci_controller *ctlr = device_get_softc(dev);
809     int i, msi = 0;
810 
811     if (!ctlr->legacy) {
812 	if (resource_int_value(device_get_name(dev),
813 		device_get_unit(dev), "msi", &i) == 0 && i != 0)
814 	    msi = 1;
815 	if (msi && pci_msi_count(dev) > 0 && pci_alloc_msi(dev, &msi) == 0) {
816 	    ctlr->r_irq_rid = 0x1;
817 	} else {
818 	    msi = 0;
819 	    ctlr->r_irq_rid = ATA_IRQ_RID;
820 	}
821 	if (!(ctlr->r_irq = bus_alloc_resource_any(dev, SYS_RES_IRQ,
822 		&ctlr->r_irq_rid, RF_SHAREABLE | RF_ACTIVE))) {
823 	    device_printf(dev, "unable to map interrupt\n");
824 	    if (msi)
825 		    pci_release_msi(dev);
826 	    return ENXIO;
827 	}
828 	if ((bus_setup_intr(dev, ctlr->r_irq, ATA_INTR_FLAGS, NULL,
829 			    intr_func, ctlr, &ctlr->handle))) {
830 	    device_printf(dev, "unable to setup interrupt\n");
831 	    bus_release_resource(dev,
832 		SYS_RES_IRQ, ctlr->r_irq_rid, ctlr->r_irq);
833 	    if (msi)
834 		    pci_release_msi(dev);
835 	    return ENXIO;
836 	}
837     }
838     return 0;
839 }
840 
841 void
842 ata_set_desc(device_t dev)
843 {
844     struct ata_pci_controller *ctlr = device_get_softc(dev);
845     char buffer[128];
846 
847     sprintf(buffer, "%s %s %s controller",
848             ata_pcivendor2str(dev), ctlr->chip->text,
849             ata_mode2str(ctlr->chip->max_dma));
850     device_set_desc_copy(dev, buffer);
851 }
852 
853 const struct ata_chip_id *
854 ata_match_chip(device_t dev, const struct ata_chip_id *index)
855 {
856     uint32_t devid;
857     uint8_t revid;
858 
859     devid = pci_get_devid(dev);
860     revid = pci_get_revid(dev);
861     while (index->chipid != 0) {
862 	if (devid == index->chipid && revid >= index->chiprev)
863 	    return (index);
864 	index++;
865     }
866     return (NULL);
867 }
868 
869 const struct ata_chip_id *
870 ata_find_chip(device_t dev, const struct ata_chip_id *index, int slot)
871 {
872     const struct ata_chip_id *idx;
873     device_t *children;
874     int nchildren, i;
875     uint8_t s;
876 
877     if (device_get_children(device_get_parent(dev), &children, &nchildren))
878 	return (NULL);
879 
880     for (i = 0; i < nchildren; i++) {
881 	s = pci_get_slot(children[i]);
882 	if ((slot >= 0 && s == slot) || (slot < 0 && s <= -slot)) {
883 	    idx = ata_match_chip(children[i], index);
884 	    if (idx != NULL) {
885 		free(children, M_TEMP);
886 		return (idx);
887 	    }
888 	}
889     }
890     free(children, M_TEMP);
891     return (NULL);
892 }
893 
894 const char *
895 ata_pcivendor2str(device_t dev)
896 {
897     switch (pci_get_vendor(dev)) {
898     case ATA_ACARD_ID:          return "Acard";
899     case ATA_ACER_LABS_ID:      return "AcerLabs";
900     case ATA_AMD_ID:            return "AMD";
901     case ATA_ADAPTEC_ID:        return "Adaptec";
902     case ATA_ATI_ID:            return "ATI";
903     case ATA_CYRIX_ID:          return "Cyrix";
904     case ATA_CYPRESS_ID:        return "Cypress";
905     case ATA_HIGHPOINT_ID:      return "HighPoint";
906     case ATA_INTEL_ID:          return "Intel";
907     case ATA_ITE_ID:            return "ITE";
908     case ATA_JMICRON_ID:        return "JMicron";
909     case ATA_MARVELL_ID:        return "Marvell";
910     case ATA_MARVELL2_ID:       return "Marvell";
911     case ATA_NATIONAL_ID:       return "National";
912     case ATA_NETCELL_ID:        return "Netcell";
913     case ATA_NVIDIA_ID:         return "nVidia";
914     case ATA_PROMISE_ID:        return "Promise";
915     case ATA_SERVERWORKS_ID:    return "ServerWorks";
916     case ATA_SILICON_IMAGE_ID:  return "SiI";
917     case ATA_SIS_ID:            return "SiS";
918     case ATA_VIA_ID:            return "VIA";
919     case ATA_CENATEK_ID:        return "Cenatek";
920     case ATA_MICRON_ID:         return "Micron";
921     default:                    return "Generic";
922     }
923 }
924 
925 int
926 ata_mode2idx(int mode)
927 {
928     if ((mode & ATA_DMA_MASK) == ATA_UDMA0)
929 	return (mode & ATA_MODE_MASK) + 8;
930     if ((mode & ATA_DMA_MASK) == ATA_WDMA0)
931 	return (mode & ATA_MODE_MASK) + 5;
932     return (mode & ATA_MODE_MASK) - ATA_PIO0;
933 }
934