xref: /freebsd/sys/powerpc/psim/ata_iobus.c (revision 1669d8afc64812c8d2d1d147ae1fd42ff441e1b1)
1 /*-
2  * Copyright 2002 by Peter Grehan. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  * 3. The name of the author may not be used to endorse or promote products
13  *    derived from this software without specific prior written permission.
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,
20  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
22  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 /*
31  * PSIM local bus ATA controller
32  */
33 #include "opt_ata.h"
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/module.h>
38 #include <sys/bus.h>
39 #include <sys/malloc.h>
40 #include <sys/sema.h>
41 #include <sys/taskqueue.h>
42 #include <machine/stdarg.h>
43 #include <vm/uma.h>
44 #include <machine/resource.h>
45 #include <machine/bus.h>
46 #include <sys/rman.h>
47 #include <sys/ata.h>
48 #include <dev/ata/ata-all.h>
49 #include <ata_if.h>
50 
51 #include <dev/ofw/openfirm.h>
52 #include <powerpc/psim/iobusvar.h>
53 
54 /*
55  * Define the iobus ata bus attachment. This creates a pseudo-bus that
56  * the ATA device can be attached to
57  */
58 static  int  ata_iobus_attach(device_t dev);
59 static  int  ata_iobus_probe(device_t dev);
60 static  int  ata_iobus_print_child(device_t dev, device_t child);
61 struct resource *ata_iobus_alloc_resource(device_t, device_t, int, int *,
62 					  u_long, u_long, u_long, u_int);
63 static int ata_iobus_release_resource(device_t, device_t, int, int,
64 				      struct resource *);
65 
66 static device_method_t ata_iobus_methods[] = {
67         /* Device interface */
68 	DEVMETHOD(device_probe,		ata_iobus_probe),
69 	DEVMETHOD(device_attach,        ata_iobus_attach),
70 	DEVMETHOD(device_shutdown,      bus_generic_shutdown),
71 	DEVMETHOD(device_suspend,       bus_generic_suspend),
72 	DEVMETHOD(device_resume,        bus_generic_resume),
73 
74 	/* Bus methods */
75 	DEVMETHOD(bus_print_child,          ata_iobus_print_child),
76 	DEVMETHOD(bus_alloc_resource,       ata_iobus_alloc_resource),
77 	DEVMETHOD(bus_release_resource,     ata_iobus_release_resource),
78 	DEVMETHOD(bus_activate_resource,    bus_generic_activate_resource),
79 	DEVMETHOD(bus_deactivate_resource,  bus_generic_deactivate_resource),
80 	DEVMETHOD(bus_setup_intr,           bus_generic_setup_intr),
81 	DEVMETHOD(bus_teardown_intr,        bus_generic_teardown_intr),
82 
83 	{ 0, 0 }
84 };
85 
86 static driver_t ata_iobus_driver = {
87 	"ataiobus",
88 	ata_iobus_methods,
89 	0,
90 };
91 
92 static devclass_t ata_iobus_devclass;
93 
94 DRIVER_MODULE(ataiobus, iobus, ata_iobus_driver, ata_iobus_devclass, 0, 0);
95 MODULE_DEPEND(ata, ata, 1, 1, 1);
96 
97 static int
98 ata_iobus_probe(device_t dev)
99 {
100 	char *type = iobus_get_name(dev);
101 
102 	if (strncmp(type, "ata", 3) != 0)
103 		return (ENXIO);
104 
105 	device_set_desc(dev, "PSIM ATA Controller");
106 	return (0);
107 }
108 
109 
110 static int
111 ata_iobus_attach(device_t dev)
112 {
113 	/*
114 	 * Add a single child per controller. Should be able
115 	 * to add two
116 	 */
117 	device_add_child(dev, "ata",
118 			 devclass_find_free_unit(ata_devclass, 0));
119 
120 	return (bus_generic_attach(dev));
121 }
122 
123 
124 static int
125 ata_iobus_print_child(device_t dev, device_t child)
126 {
127 	int retval = 0;
128 
129 	retval += bus_print_child_header(dev, child);
130 	/* irq ? */
131 	retval += bus_print_child_footer(dev, child);
132 
133 	return (retval);
134 }
135 
136 
137 struct resource *
138 ata_iobus_alloc_resource(device_t dev, device_t child, int type, int *rid,
139 			 u_long start, u_long end, u_long count, u_int flags)
140 {
141 	struct resource *res = NULL;
142 	int myrid;
143 	u_int *ofw_regs;
144 
145 	ofw_regs = iobus_get_regs(dev);
146 
147 	/*
148 	 * The reg array for the PSIM ata device has 6 start/size entries:
149 	 *  0 - unused
150 	 *  1/2/3 - unused
151 	 *  4/5/6 - primary command
152 	 *  7/8/9 - secondary command
153 	 *  10/11/12 - primary control
154 	 *  13/14/15 - secondary control
155 	 *  16/17/18 - primary/secondary dma registers, unimplemented
156 	 *
157 	 *  The resource values are calculated from these registers
158 	 */
159 	if (type == SYS_RES_IOPORT) {
160 		switch (*rid) {
161 		case ATA_IOADDR_RID:
162 			myrid = 0;
163 			start = ofw_regs[4];
164 			end = start + ATA_IOSIZE - 1;
165 			count = ATA_IOSIZE;
166 			res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
167 						 SYS_RES_MEMORY, &myrid,
168 						 start, end, count, flags);
169 			break;
170 
171 		case ATA_CTLADDR_RID:
172 			myrid = 0;
173 			start = ofw_regs[10];
174 			end = start + ATA_CTLIOSIZE - 1;
175 			count = ATA_CTLIOSIZE;
176 			res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
177 						 SYS_RES_MEMORY, &myrid,
178 						 start, end, count, flags);
179 			break;
180 
181 		case ATA_BMADDR_RID:
182 			/* DMA not properly supported by psim */
183 			break;
184 		}
185 		return (res);
186 
187 	} else if (type == SYS_RES_IRQ && *rid == ATA_IRQ_RID) {
188 		/*
189 		 * Pass this on to the parent
190 		 */
191 		return (BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
192 					   SYS_RES_IRQ, rid, 0, ~0, 1, flags));
193 
194 	} else {
195 		return (NULL);
196 	}
197 }
198 
199 
200 static int
201 ata_iobus_release_resource(device_t dev, device_t child, int type, int rid,
202 			   struct resource *r)
203 {
204 	/* no hotplug... */
205 	return (0);
206 }
207 
208 
209 /*
210  * Define the actual ATA device. This is a sub-bus to the ata-iobus layer
211  * to allow the higher layer bus to massage the resource allocation.
212  */
213 
214 static  int  ata_iobus_sub_probe(device_t dev);
215 static  void ata_iobus_sub_setmode(device_t parent, device_t dev);
216 
217 static device_method_t ata_iobus_sub_methods[] = {
218 	/* Device interface */
219 	DEVMETHOD(device_probe,     ata_iobus_sub_probe),
220 	DEVMETHOD(device_attach,    ata_attach),
221 	DEVMETHOD(device_detach,    ata_detach),
222 	DEVMETHOD(device_resume,    ata_resume),
223 
224 	/* ATA interface */
225 	DEVMETHOD(ata_setmode,	    ata_iobus_sub_setmode),
226 	{ 0, 0 }
227 };
228 
229 static driver_t ata_iobus_sub_driver = {
230 	"ata",
231 	ata_iobus_sub_methods,
232 	sizeof(struct ata_channel),
233 };
234 
235 DRIVER_MODULE(ata, ataiobus, ata_iobus_sub_driver, ata_devclass, 0, 0);
236 
237 static int
238 ata_iobus_sub_probe(device_t dev)
239 {
240 	struct ata_channel *ch = device_get_softc(dev);
241 
242 	/* Only a single unit per controller thus far */
243 	ch->unit = 0;
244 	ch->flags = (ATA_USE_16BIT|ATA_NO_SLAVE);
245 	ata_generic_hw(dev);
246 
247 	return ata_probe(dev);
248 }
249 
250 static void
251 ata_iobus_sub_setmode(device_t parent, device_t dev)
252 {
253 	struct ata_device *atadev = device_get_softc(dev);
254 
255 	/* Only ever PIO mode here... */
256 	atadev->mode = ATA_PIO;
257 }
258