xref: /freebsd/sys/dev/ata/ata-pci.c (revision f9218d3d4fd34f082473b3a021c6d4d109fb47cf)
1 /*-
2  * Copyright (c) 1998 - 2003 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  * 3. The name of the author may not be used to endorse or promote products
15  *    derived from this software without specific prior written permission.
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  * $FreeBSD$
29  */
30 
31 #include "opt_ata.h"
32 #include <sys/param.h>
33 #include <sys/systm.h>
34 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/bus.h>
37 #include <sys/malloc.h>
38 #include <machine/stdarg.h>
39 #include <machine/resource.h>
40 #include <machine/bus.h>
41 #ifdef __alpha__
42 #include <machine/md_var.h>
43 #endif
44 #include <sys/rman.h>
45 #include <pci/pcivar.h>
46 #include <pci/pcireg.h>
47 #include <dev/ata/ata-all.h>
48 #include <dev/ata/ata-pci.h>
49 
50 /* local vars */
51 static MALLOC_DEFINE(M_ATAPCI, "ATA PCI", "ATA driver PCI");
52 
53 /* misc defines */
54 #define IOMASK			0xfffffffc
55 
56 /* prototypes */
57 static int ata_pci_add_child(device_t, int);
58 static void ata_pci_locknoop(struct ata_channel *, int);
59 
60 static int
61 ata_pci_probe(device_t dev)
62 {
63     if (pci_get_class(dev) != PCIC_STORAGE)
64 	return ENXIO;
65 
66     switch (pci_get_vendor(dev)) {
67     case ATA_ACARD_ID:
68 	return ata_acard_ident(dev);
69     case ATA_ACER_LABS_ID:
70 	return ata_ali_ident(dev);
71     case ATA_AMD_ID:
72 	return ata_amd_ident(dev);
73     case ATA_CYRIX_ID:
74 	return ata_cyrix_ident(dev);
75     case ATA_CYPRESS_ID:
76 	return ata_cypress_ident(dev);
77     case ATA_HIGHPOINT_ID:
78 	return ata_highpoint_ident(dev);
79     case ATA_INTEL_ID:
80 	return ata_intel_ident(dev);
81     case ATA_NVIDIA_ID:
82 	return ata_nvidia_ident(dev);
83     case ATA_PROMISE_ID:
84 	return ata_promise_ident(dev);
85     case ATA_SERVERWORKS_ID:
86 	return ata_serverworks_ident(dev);
87     case ATA_SILICON_IMAGE_ID:
88 	return ata_sii_ident(dev);
89     case ATA_SIS_ID:
90 	return ata_sis_ident(dev);
91     case ATA_VIA_ID:
92 	return ata_via_ident(dev);
93 
94     case 0x16ca:
95 	if (pci_get_devid(dev) == 0x000116ca) {
96 	    device_set_desc(dev, "Cenatek Rocket Drive controller");
97 	    return 0;
98 	}
99 	return ENXIO;
100 
101     case 0x1042:
102 	if (pci_get_devid(dev)==0x10001042 || pci_get_devid(dev)==0x10011042) {
103 	    device_set_desc(dev,
104 		"RZ 100? ATA controller !WARNING! buggy HW data loss possible");
105 	    return 0;
106 	}
107 	return ENXIO;
108 
109     /* unknown chipset, try generic DMA if it seems possible */
110     default:
111 	if (pci_get_class(dev) == PCIC_STORAGE &&
112 	    (pci_get_subclass(dev) == PCIS_STORAGE_IDE))
113 	    return ata_generic_ident(dev);
114     }
115     return ENXIO;
116 }
117 
118 static int
119 ata_pci_attach(device_t dev)
120 {
121     struct ata_pci_controller *controller = device_get_softc(dev);
122     u_int8_t class, subclass;
123     u_int32_t type, cmd;
124     int rid;
125 
126     /* set up vendor-specific stuff */
127     type = pci_get_devid(dev);
128     class = pci_get_class(dev);
129     subclass = pci_get_subclass(dev);
130     cmd = pci_read_config(dev, PCIR_COMMAND, 2);
131 
132     if (!(cmd & PCIM_CMD_PORTEN)) {
133 	device_printf(dev, "ATA channel disabled by BIOS\n");
134 	return 0;
135     }
136 
137 #ifdef __sparc64__
138     if (!(cmd & PCIM_CMD_BUSMASTEREN)) {
139 	pci_write_config(dev, PCIR_COMMAND, cmd | PCIM_CMD_BUSMASTEREN, 2);
140 	cmd = pci_read_config(dev, PCIR_COMMAND, 2);
141     }
142 #endif
143     /* is busmastering supported ? */
144     if ((cmd & (PCIM_CMD_PORTEN | PCIM_CMD_BUSMASTEREN)) ==
145 	(PCIM_CMD_PORTEN | PCIM_CMD_BUSMASTEREN)) {
146 
147 	/* is there a valid port range to connect to ? */
148 	rid = 0x20;
149 	controller->r_bmio = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
150 						0, ~0, 1, RF_ACTIVE);
151 	if (!controller->r_bmio)
152 	    device_printf(dev, "Busmastering DMA not configured\n");
153     }
154     else
155 	device_printf(dev, "Busmastering DMA not supported\n");
156 
157     /* do chipset specific setups only needed once */
158     controller->dmainit = ata_dmainit;
159     controller->locking = ata_pci_locknoop;
160     controller->chipinit(dev);
161 
162     if (controller->r_bmio) {
163 	controller->bmaddr = rman_get_start(controller->r_bmio);
164 	BUS_RELEASE_RESOURCE(device_get_parent(dev), dev,
165 			     SYS_RES_IOPORT, rid, controller->r_bmio);
166 	controller->r_bmio = NULL;
167     }
168 
169     ata_pci_add_child(dev, 0);
170 
171     if (ATA_MASTERDEV(dev) || pci_read_config(dev, 0x18, 4) & IOMASK)
172 	ata_pci_add_child(dev, 1);
173 
174     return bus_generic_attach(dev);
175 }
176 
177 static int
178 ata_pci_add_child(device_t dev, int unit)
179 {
180     /* check if this is located at one of the std addresses */
181     if (ATA_MASTERDEV(dev)) {
182 	if (!device_add_child(dev, "ata", unit))
183 	    return ENOMEM;
184     }
185     else {
186 	if (!device_add_child(dev, "ata",
187 			      devclass_find_free_unit(ata_devclass, 2)))
188 	    return ENOMEM;
189     }
190     return 0;
191 }
192 
193 static int
194 ata_pci_print_child(device_t dev, device_t child)
195 {
196     struct ata_channel *ch = device_get_softc(child);
197     int retval = 0;
198 
199     retval += bus_print_child_header(dev, child);
200     retval += printf(": at 0x%lx", rman_get_start(ch->r_io));
201 
202     if (ATA_MASTERDEV(dev))
203 	retval += printf(" irq %d", 14 + ch->unit);
204 
205     retval += bus_print_child_footer(dev, child);
206 
207     return retval;
208 }
209 
210 static struct resource *
211 ata_pci_alloc_resource(device_t dev, device_t child, int type, int *rid,
212 		       u_long start, u_long end, u_long count, u_int flags)
213 {
214     struct ata_pci_controller *controller = device_get_softc(dev);
215     int unit = ((struct ata_channel *)device_get_softc(child))->unit;
216     struct resource *res = NULL;
217     int myrid;
218 
219     if (type == SYS_RES_IOPORT) {
220 	switch (*rid) {
221 	case ATA_IOADDR_RID:
222 	    if (ATA_MASTERDEV(dev)) {
223 		myrid = 0;
224 		start = (unit ? ATA_SECONDARY : ATA_PRIMARY);
225 		end = start + ATA_IOSIZE - 1;
226 		count = ATA_IOSIZE;
227 		res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
228 					 SYS_RES_IOPORT, &myrid,
229 					 start, end, count, flags);
230 	    }
231 	    else {
232 		myrid = 0x10 + 8 * unit;
233 		res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
234 					 SYS_RES_IOPORT, &myrid,
235 					 start, end, count, flags);
236 	    }
237 	    break;
238 
239 	case ATA_ALTADDR_RID:
240 	    if (ATA_MASTERDEV(dev)) {
241 		myrid = 0;
242 		start = (unit ? ATA_SECONDARY : ATA_PRIMARY) + ATA_ALTOFFSET;
243 		end = start + ATA_ALTIOSIZE - 1;
244 		count = ATA_ALTIOSIZE;
245 		res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
246 					 SYS_RES_IOPORT, &myrid,
247 					 start, end, count, flags);
248 	    }
249 	    else {
250 		myrid = 0x14 + 8 * unit;
251 		res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
252 					 SYS_RES_IOPORT, &myrid,
253 					 start, end, count, flags);
254 		if (res) {
255 			start = rman_get_start(res) + 2;
256 			end = start + ATA_ALTIOSIZE - 1;
257 			count = ATA_ALTIOSIZE;
258 			BUS_RELEASE_RESOURCE(device_get_parent(dev), dev,
259 					     SYS_RES_IOPORT, myrid, res);
260 			res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
261 						 SYS_RES_IOPORT, &myrid,
262 						 start, end, count, flags);
263 		}
264 	    }
265 	    break;
266 
267 	case ATA_BMADDR_RID:
268 	    if (controller->bmaddr) {
269 		myrid = 0x20;
270 		start = (unit == 0 ?
271 			 controller->bmaddr : controller->bmaddr+ATA_BMIOSIZE);
272 		end = start + ATA_BMIOSIZE - 1;
273 		count = ATA_BMIOSIZE;
274 		res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
275 					 SYS_RES_IOPORT, &myrid,
276 					 start, end, count, flags);
277 	    }
278 	}
279 	return res;
280     }
281 
282     if (type == SYS_RES_IRQ && *rid == ATA_IRQ_RID) {
283 		if (ATA_MASTERDEV(dev)) {
284 #ifdef __alpha__
285 	    return alpha_platform_alloc_ide_intr(unit);
286 #else
287 	    int irq = (unit == 0 ? 14 : 15);
288 
289 	    return BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
290 				      SYS_RES_IRQ, rid, irq, irq, 1, flags);
291 #endif
292 	}
293 	else {
294 	    return controller->r_irq;
295 	}
296     }
297     return 0;
298 }
299 
300 static int
301 ata_pci_release_resource(device_t dev, device_t child, int type, int rid,
302 			 struct resource *r)
303 {
304     int unit = ((struct ata_channel *)device_get_softc(child))->unit;
305 
306     if (type == SYS_RES_IOPORT) {
307 	switch (rid) {
308 	case ATA_IOADDR_RID:
309 	    if (ATA_MASTERDEV(dev))
310 		return BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
311 					    SYS_RES_IOPORT, 0x0, r);
312 	    else
313 		return BUS_RELEASE_RESOURCE(device_get_parent(dev), dev,
314 					    SYS_RES_IOPORT, 0x10 + 8 * unit, r);
315 	    break;
316 
317 	case ATA_ALTADDR_RID:
318 	    if (ATA_MASTERDEV(dev))
319 		return BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
320 					    SYS_RES_IOPORT, 0x0, r);
321 	    else
322 		return BUS_RELEASE_RESOURCE(device_get_parent(dev), dev,
323 					    SYS_RES_IOPORT, 0x14 + 8 * unit, r);
324 	    break;
325 
326 	case ATA_BMADDR_RID:
327 	    return BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
328 					SYS_RES_IOPORT, 0x20, r);
329 	default:
330 	    return ENOENT;
331 	}
332     }
333     if (type == SYS_RES_IRQ) {
334 	if (rid != ATA_IRQ_RID)
335 	    return ENOENT;
336 
337 	if (ATA_MASTERDEV(dev)) {
338 #ifdef __alpha__
339 	    return alpha_platform_release_ide_intr(unit, r);
340 #else
341 	    return BUS_RELEASE_RESOURCE(device_get_parent(dev), child,
342 					SYS_RES_IRQ, rid, r);
343 #endif
344 	}
345 	else
346 	    return 0;
347     }
348     return EINVAL;
349 }
350 
351 static int
352 ata_pci_setup_intr(device_t dev, device_t child, struct resource *irq,
353 		   int flags, driver_intr_t *function, void *argument,
354 		   void **cookiep)
355 {
356     if (ATA_MASTERDEV(dev)) {
357 #ifdef __alpha__
358 	return alpha_platform_setup_ide_intr(child, irq, function, argument,
359 					     cookiep);
360 #else
361 	return BUS_SETUP_INTR(device_get_parent(dev), child, irq,
362 			      flags, function, argument, cookiep);
363 #endif
364     }
365     else {
366 	struct ata_pci_controller *controller = device_get_softc(dev);
367 	int unit = ((struct ata_channel *)device_get_softc(child))->unit;
368 
369 	controller->interrupt[unit].function = function;
370 	controller->interrupt[unit].argument = argument;
371 	*cookiep = controller;
372 	return 0;
373     }
374 }
375 
376 static int
377 ata_pci_teardown_intr(device_t dev, device_t child, struct resource *irq,
378 		      void *cookie)
379 {
380     if (ATA_MASTERDEV(dev)) {
381 #ifdef __alpha__
382 	return alpha_platform_teardown_ide_intr(child, irq, cookie);
383 #else
384 	return BUS_TEARDOWN_INTR(device_get_parent(dev), child, irq, cookie);
385 #endif
386     }
387     else {
388 	struct ata_pci_controller *controller = device_get_softc(dev);
389 	int unit = ((struct ata_channel *)device_get_softc(child))->unit;
390 
391 	controller->interrupt[unit].function = NULL;
392 	controller->interrupt[unit].argument = NULL;
393 	return 0;
394     }
395 }
396 
397 static void
398 ata_pci_locknoop(struct ata_channel *ch, int flags)
399 {
400 }
401 
402 
403 static device_method_t ata_pci_methods[] = {
404     /* device interface */
405     DEVMETHOD(device_probe,		ata_pci_probe),
406     DEVMETHOD(device_attach,		ata_pci_attach),
407     DEVMETHOD(device_shutdown,		bus_generic_shutdown),
408     DEVMETHOD(device_suspend,		bus_generic_suspend),
409     DEVMETHOD(device_resume,		bus_generic_resume),
410 
411     /* bus methods */
412     DEVMETHOD(bus_print_child,		ata_pci_print_child),
413     DEVMETHOD(bus_alloc_resource,	ata_pci_alloc_resource),
414     DEVMETHOD(bus_release_resource,	ata_pci_release_resource),
415     DEVMETHOD(bus_activate_resource,	bus_generic_activate_resource),
416     DEVMETHOD(bus_deactivate_resource,	bus_generic_deactivate_resource),
417     DEVMETHOD(bus_setup_intr,		ata_pci_setup_intr),
418     DEVMETHOD(bus_teardown_intr,	ata_pci_teardown_intr),
419     { 0, 0 }
420 };
421 
422 static driver_t ata_pci_driver = {
423     "atapci",
424     ata_pci_methods,
425     sizeof(struct ata_pci_controller),
426 };
427 
428 static devclass_t ata_pci_devclass;
429 
430 DRIVER_MODULE(atapci, pci, ata_pci_driver, ata_pci_devclass, 0, 0);
431 
432 static int
433 ata_pcisub_probe(device_t dev)
434 {
435     struct ata_pci_controller *ctlr = device_get_softc(device_get_parent(dev));
436     struct ata_channel *ch = device_get_softc(dev);
437     device_t *children;
438     int count, error, i;
439 
440     /* find channel number on this controller */
441     device_get_children(device_get_parent(dev), &children, &count);
442     for (i = 0; i < count; i++) {
443 	if (children[i] == dev)
444 	    ch->unit = i;
445     }
446     free(children, M_TEMP);
447 
448     ch->device[MASTER].setmode = ctlr->setmode;
449     ch->device[SLAVE].setmode = ctlr->setmode;
450     ch->locking = ctlr->locking;
451     ch->chiptype = pci_get_devid(device_get_parent(dev));
452 
453     if (!(error = ata_probe(dev)) && ch->r_bmio) {
454 	/* if simplex controller, only allow DMA on primary channel */
455 	ATA_OUTB(ch->r_bmio, ATA_BMSTAT_PORT,
456 		 ATA_INB(ch->r_bmio, ATA_BMSTAT_PORT) &
457 		 (ATA_BMSTAT_DMA_MASTER | ATA_BMSTAT_DMA_SLAVE));
458 	if (ch->unit == 1 && ATA_INB(ch->r_bmio, ATA_BMSTAT_PORT) &
459 			     ATA_BMSTAT_DMA_SIMPLEX) {
460 	    ata_printf(ch, -1, "simplex device, DMA on primary only\n");
461 	    return error;
462 	}
463 	error = ctlr->dmainit(ch);
464     }
465     return error;
466 }
467 
468 static device_method_t ata_pcisub_methods[] = {
469     /* device interface */
470     DEVMETHOD(device_probe,	ata_pcisub_probe),
471     DEVMETHOD(device_attach,	ata_attach),
472     DEVMETHOD(device_detach,	ata_detach),
473     DEVMETHOD(device_resume,	ata_resume),
474     { 0, 0 }
475 };
476 
477 static driver_t ata_pcisub_driver = {
478     "ata",
479     ata_pcisub_methods,
480     sizeof(struct ata_channel),
481 };
482 
483 DRIVER_MODULE(ata, atapci, ata_pcisub_driver, ata_devclass, 0, 0);
484