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