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