xref: /freebsd-11-stable/sys/dev/ata/ata-cbus.c (revision 82aa34e6fa1cd5a4ad401383522daf51412ea4b2)
1 /*-
2  * Copyright (c) 2002 - 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/ata.h>
34 #include <sys/bus.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
37 #include <sys/conf.h>
38 #include <sys/sema.h>
39 #include <sys/taskqueue.h>
40 #include <vm/uma.h>
41 #include <machine/resource.h>
42 #include <machine/bus.h>
43 #include <sys/rman.h>
44 #include <isa/isavar.h>
45 #include <dev/ata/ata-all.h>
46 #include <ata_if.h>
47 
48 /* local vars */
49 struct ata_cbus_controller {
50     struct resource *io;
51     struct resource *ctlio;
52     struct resource *bankio;
53     struct resource *irq;
54     void *ih;
55     int channels;
56     struct {
57 	void (*function)(void *);
58 	void *argument;
59     } interrupt[2];
60 };
61 
62 /* local prototypes */
63 static void ata_cbus_intr(void *);
64 
65 static int
ata_cbus_probe(device_t dev)66 ata_cbus_probe(device_t dev)
67 {
68     struct resource *io;
69     int rid;
70     rman_res_t tmp;
71 
72     /* dont probe PnP devices */
73     if (isa_get_vendorid(dev))
74 	return (ENXIO);
75 
76     /* allocate the ioport range */
77     rid = ATA_IOADDR_RID;
78     if (!(io = bus_alloc_resource_anywhere(dev, SYS_RES_IOPORT, &rid,
79 					   ATA_PC98_IOSIZE, RF_ACTIVE)))
80 	return ENOMEM;
81 
82     /* calculate & set the altport range */
83     rid = ATA_PC98_CTLADDR_RID;
84     if (bus_get_resource(dev, SYS_RES_IOPORT, rid, &tmp, &tmp)) {
85 	bus_set_resource(dev, SYS_RES_IOPORT, rid,
86 			 rman_get_start(io)+ATA_PC98_CTLOFFSET, ATA_CTLIOSIZE);
87     }
88 
89     /* calculate & set the bank range */
90     rid = ATA_PC98_BANKADDR_RID;
91     if (bus_get_resource(dev, SYS_RES_IOPORT, rid, &tmp, &tmp)) {
92 	bus_set_resource(dev, SYS_RES_IOPORT, rid,
93 			 ATA_PC98_BANK, ATA_PC98_BANKIOSIZE);
94     }
95 
96     bus_release_resource(dev, SYS_RES_IOPORT, ATA_IOADDR_RID, io);
97     return 0;
98 }
99 
100 static int
ata_cbus_attach(device_t dev)101 ata_cbus_attach(device_t dev)
102 {
103     struct ata_cbus_controller *ctlr = device_get_softc(dev);
104     device_t child;
105     int rid, unit;
106 
107     /* allocate resources */
108     rid = ATA_IOADDR_RID;
109     if (!(ctlr->io = bus_alloc_resource_anywhere(dev, SYS_RES_IOPORT, &rid,
110 						 ATA_PC98_IOSIZE, RF_ACTIVE)))
111        return ENOMEM;
112 
113     rid = ATA_PC98_CTLADDR_RID;
114     if (!(ctlr->ctlio =
115 	  bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
116 			     rman_get_start(ctlr->io) + ATA_PC98_CTLOFFSET, ~0,
117 			     ATA_CTLIOSIZE, RF_ACTIVE))) {
118 	bus_release_resource(dev, SYS_RES_IOPORT, ATA_IOADDR_RID, ctlr->io);
119 	return ENOMEM;
120     }
121 
122     rid = ATA_PC98_BANKADDR_RID;
123     if (!(ctlr->bankio = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
124 					    ATA_PC98_BANK, ~0,
125 					    ATA_PC98_BANKIOSIZE, RF_ACTIVE))) {
126 	bus_release_resource(dev, SYS_RES_IOPORT, ATA_IOADDR_RID, ctlr->io);
127 	bus_release_resource(dev, SYS_RES_IOPORT, ATA_CTLADDR_RID, ctlr->ctlio);
128 	return ENOMEM;
129     }
130 
131     rid = ATA_IRQ_RID;
132     if (!(ctlr->irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
133 					     RF_ACTIVE | RF_SHAREABLE))) {
134 	device_printf(dev, "unable to alloc interrupt\n");
135 	bus_release_resource(dev, SYS_RES_IOPORT, ATA_IOADDR_RID, ctlr->io);
136 	bus_release_resource(dev, SYS_RES_IOPORT, ATA_CTLADDR_RID, ctlr->ctlio);
137 	bus_release_resource(dev, SYS_RES_IOPORT,
138 			     ATA_PC98_BANKADDR_RID, ctlr->bankio);
139 	return ENXIO;
140     }
141 
142     if ((bus_setup_intr(dev, ctlr->irq, ATA_INTR_FLAGS,
143 			NULL, ata_cbus_intr, ctlr, &ctlr->ih))) {
144 	device_printf(dev, "unable to setup interrupt\n");
145 	bus_release_resource(dev, SYS_RES_IOPORT, ATA_IOADDR_RID, ctlr->io);
146 	bus_release_resource(dev, SYS_RES_IOPORT, ATA_CTLADDR_RID, ctlr->ctlio);
147 	bus_release_resource(dev, SYS_RES_IOPORT,
148 			     ATA_PC98_BANKADDR_RID, ctlr->bankio);
149 	bus_release_resource(dev, SYS_RES_IOPORT, ATA_IRQ_RID, ctlr->irq);
150 	return ENXIO;
151     }
152 
153 	/* Work around the lack of channel serialization in ATA_CAM. */
154 	ctlr->channels = 1;
155 	device_printf(dev, "second channel ignored\n");
156 
157     for (unit = 0; unit < ctlr->channels; unit++) {
158 	child = device_add_child(dev, "ata", unit);
159 	if (child == NULL)
160 	    device_printf(dev, "failed to add ata child device\n");
161 	else
162 	    device_set_ivars(child, (void *)(intptr_t)unit);
163     }
164 
165     bus_generic_attach(dev);
166     return (0);
167 }
168 
169 static struct resource *
ata_cbus_alloc_resource(device_t dev,device_t child,int type,int * rid,rman_res_t start,rman_res_t end,rman_res_t count,u_int flags)170 ata_cbus_alloc_resource(device_t dev, device_t child, int type, int *rid,
171 			rman_res_t start, rman_res_t end, rman_res_t count,
172 			u_int flags)
173 {
174     struct ata_cbus_controller *ctlr = device_get_softc(dev);
175 
176     if (type == SYS_RES_IOPORT) {
177 	switch (*rid) {
178 	case ATA_IOADDR_RID:
179 	    return ctlr->io;
180 	case ATA_CTLADDR_RID:
181 	    return ctlr->ctlio;
182 	}
183     }
184     if (type == SYS_RES_IRQ)
185 	return ctlr->irq;
186     return 0;
187 }
188 
189 static int
ata_cbus_setup_intr(device_t dev,device_t child,struct resource * irq,int flags,driver_filter_t * filter,driver_intr_t * intr,void * arg,void ** cookiep)190 ata_cbus_setup_intr(device_t dev, device_t child, struct resource *irq,
191 	       int flags, driver_filter_t *filter, driver_intr_t *intr,
192 	       void *arg, void **cookiep)
193 {
194     struct ata_cbus_controller *controller = device_get_softc(dev);
195     int unit = ((struct ata_channel *)device_get_softc(child))->unit;
196 
197     if (filter != NULL) {
198 	    printf("ata-cbus.c: we cannot use a filter here\n");
199 	    return (EINVAL);
200     }
201     controller->interrupt[unit].function = intr;
202     controller->interrupt[unit].argument = arg;
203     *cookiep = controller;
204 
205     return 0;
206 }
207 
208 static int
ata_cbus_print_child(device_t dev,device_t child)209 ata_cbus_print_child(device_t dev, device_t child)
210 {
211     struct ata_channel *ch = device_get_softc(child);
212     int retval = 0;
213 
214     retval += bus_print_child_header(dev, child);
215     retval += printf(" at bank %d", ch->unit);
216     retval += bus_print_child_footer(dev, child);
217     return retval;
218 }
219 
220 static void
ata_cbus_intr(void * data)221 ata_cbus_intr(void *data)
222 {
223     struct ata_cbus_controller *ctlr = data;
224     struct ata_channel *ch;
225     int unit;
226 
227     for (unit = 0; unit < ctlr->channels; unit++) {
228 	if (!(ch = ctlr->interrupt[unit].argument))
229 	    continue;
230 	ctlr->interrupt[unit].function(ch);
231     }
232 }
233 
234 static device_method_t ata_cbus_methods[] = {
235     /* device interface */
236     DEVMETHOD(device_probe,             ata_cbus_probe),
237     DEVMETHOD(device_attach,            ata_cbus_attach),
238 //  DEVMETHOD(device_detach,            ata_cbus_detach),
239 
240     /* bus methods */
241     DEVMETHOD(bus_alloc_resource,       ata_cbus_alloc_resource),
242     DEVMETHOD(bus_setup_intr,           ata_cbus_setup_intr),
243     DEVMETHOD(bus_print_child,          ata_cbus_print_child),
244 
245     DEVMETHOD_END
246 };
247 
248 static driver_t ata_cbus_driver = {
249     "atacbus",
250     ata_cbus_methods,
251     sizeof(struct ata_cbus_controller),
252 };
253 
254 static devclass_t ata_cbus_devclass;
255 
256 DRIVER_MODULE(atacbus, isa, ata_cbus_driver, ata_cbus_devclass, NULL, NULL);
257 
258 static int
ata_cbuschannel_probe(device_t dev)259 ata_cbuschannel_probe(device_t dev)
260 {
261     char buffer[32];
262 
263     sprintf(buffer, "ATA channel %d", (int)(intptr_t)device_get_ivars(dev));
264     device_set_desc_copy(dev, buffer);
265 
266     return ata_probe(dev);
267 }
268 
269 static int
ata_cbuschannel_attach(device_t dev)270 ata_cbuschannel_attach(device_t dev)
271 {
272     struct ata_cbus_controller *ctlr = device_get_softc(device_get_parent(dev));
273     struct ata_channel *ch = device_get_softc(dev);
274     int i;
275 
276     if (ch->attached)
277 	return (0);
278     ch->attached = 1;
279 
280     ch->unit = (intptr_t)device_get_ivars(dev);
281     /* setup the resource vectors */
282     for (i = ATA_DATA; i <= ATA_COMMAND; i ++) {
283 	ch->r_io[i].res = ctlr->io;
284 	ch->r_io[i].offset = i << 1;
285     }
286     ch->r_io[ATA_CONTROL].res = ctlr->ctlio;
287     ch->r_io[ATA_CONTROL].offset = 0;
288     ch->r_io[ATA_IDX_ADDR].res = ctlr->io;
289     ata_default_registers(dev);
290 
291     /* initialize softc for this channel */
292     ch->flags |= ATA_USE_16BIT;
293     ata_generic_hw(dev);
294 
295     return ata_attach(dev);
296 }
297 
298 static int
ata_cbuschannel_detach(device_t dev)299 ata_cbuschannel_detach(device_t dev)
300 {
301     struct ata_channel *ch = device_get_softc(dev);
302 
303     if (!ch->attached)
304 	return (0);
305     ch->attached = 0;
306 
307     return ata_detach(dev);
308 }
309 
310 static int
ata_cbuschannel_suspend(device_t dev)311 ata_cbuschannel_suspend(device_t dev)
312 {
313     struct ata_channel *ch = device_get_softc(dev);
314 
315     if (!ch->attached)
316 	return (0);
317 
318     return ata_suspend(dev);
319 }
320 
321 static int
ata_cbuschannel_resume(device_t dev)322 ata_cbuschannel_resume(device_t dev)
323 {
324     struct ata_channel *ch = device_get_softc(dev);
325 
326     if (!ch->attached)
327 	return (0);
328 
329     return ata_resume(dev);
330 }
331 
332 static device_method_t ata_cbuschannel_methods[] = {
333     /* device interface */
334     DEVMETHOD(device_probe,     ata_cbuschannel_probe),
335     DEVMETHOD(device_attach,    ata_cbuschannel_attach),
336     DEVMETHOD(device_detach,    ata_cbuschannel_detach),
337     DEVMETHOD(device_suspend,   ata_cbuschannel_suspend),
338     DEVMETHOD(device_resume,    ata_cbuschannel_resume),
339     DEVMETHOD_END
340 };
341 
342 static driver_t ata_cbuschannel_driver = {
343     "ata",
344     ata_cbuschannel_methods,
345     sizeof(struct ata_channel),
346 };
347 
348 DRIVER_MODULE(ata, atacbus, ata_cbuschannel_driver, ata_devclass, NULL, NULL);
349 MODULE_DEPEND(ata, ata, 1, 1, 1);
350