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
28#include <sys/cdefs.h>
29__FBSDID("$FreeBSD: releng/10.3/sys/powerpc/psim/ata_iobus.c 249213 2013-04-06 19:12:49Z marius $");
30
31/*
32 * PSIM local bus ATA controller
33 */
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 */
58static  int  ata_iobus_attach(device_t dev);
59static  int  ata_iobus_probe(device_t dev);
60static  int  ata_iobus_print_child(device_t dev, device_t child);
61struct resource *ata_iobus_alloc_resource(device_t, device_t, int, int *,
62					  u_long, u_long, u_long, u_int);
63static int ata_iobus_release_resource(device_t, device_t, int, int,
64				      struct resource *);
65
66static 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	DEVMETHOD_END
84};
85
86static driver_t ata_iobus_driver = {
87	"ataiobus",
88	ata_iobus_methods,
89	0,
90};
91
92static devclass_t ata_iobus_devclass;
93
94DRIVER_MODULE(ataiobus, iobus, ata_iobus_driver, ata_iobus_devclass, NULL,
95    NULL);
96MODULE_DEPEND(ata, ata, 1, 1, 1);
97
98static int
99ata_iobus_probe(device_t dev)
100{
101	char *type = iobus_get_name(dev);
102
103	if (strncmp(type, "ata", 3) != 0)
104		return (ENXIO);
105
106	device_set_desc(dev, "PSIM ATA Controller");
107	return (0);
108}
109
110
111static int
112ata_iobus_attach(device_t dev)
113{
114	/*
115	 * Add a single child per controller. Should be able
116	 * to add two
117	 */
118	device_add_child(dev, "ata", -1);
119	return (bus_generic_attach(dev));
120}
121
122
123static int
124ata_iobus_print_child(device_t dev, device_t child)
125{
126	int retval = 0;
127
128	retval += bus_print_child_header(dev, child);
129	/* irq ? */
130	retval += bus_print_child_footer(dev, child);
131
132	return (retval);
133}
134
135
136struct resource *
137ata_iobus_alloc_resource(device_t dev, device_t child, int type, int *rid,
138			 u_long start, u_long end, u_long count, u_int flags)
139{
140	struct resource *res = NULL;
141	int myrid;
142	u_int *ofw_regs;
143
144	ofw_regs = iobus_get_regs(dev);
145
146	/*
147	 * The reg array for the PSIM ata device has 6 start/size entries:
148	 *  0 - unused
149	 *  1/2/3 - unused
150	 *  4/5/6 - primary command
151	 *  7/8/9 - secondary command
152	 *  10/11/12 - primary control
153	 *  13/14/15 - secondary control
154	 *  16/17/18 - primary/secondary dma registers, unimplemented
155	 *
156	 *  The resource values are calculated from these registers
157	 */
158	if (type == SYS_RES_IOPORT) {
159		switch (*rid) {
160		case ATA_IOADDR_RID:
161			myrid = 0;
162			start = ofw_regs[4];
163			end = start + ATA_IOSIZE - 1;
164			count = ATA_IOSIZE;
165			res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
166						 SYS_RES_MEMORY, &myrid,
167						 start, end, count, flags);
168			break;
169
170		case ATA_CTLADDR_RID:
171			myrid = 0;
172			start = ofw_regs[10];
173			end = start + ATA_CTLIOSIZE - 1;
174			count = ATA_CTLIOSIZE;
175			res = BUS_ALLOC_RESOURCE(device_get_parent(dev), child,
176						 SYS_RES_MEMORY, &myrid,
177						 start, end, count, flags);
178			break;
179
180		case ATA_BMADDR_RID:
181			/* DMA not properly supported by psim */
182			break;
183		}
184		return (res);
185
186	} else if (type == SYS_RES_IRQ && *rid == ATA_IRQ_RID) {
187		/*
188		 * Pass this on to the parent
189		 */
190		return (BUS_ALLOC_RESOURCE(device_get_parent(dev), dev,
191					   SYS_RES_IRQ, rid, 0, ~0, 1, flags));
192
193	} else {
194		return (NULL);
195	}
196}
197
198
199static int
200ata_iobus_release_resource(device_t dev, device_t child, int type, int rid,
201			   struct resource *r)
202{
203	/* no hotplug... */
204	return (0);
205}
206
207
208/*
209 * Define the actual ATA device. This is a sub-bus to the ata-iobus layer
210 * to allow the higher layer bus to massage the resource allocation.
211 */
212
213static  int  ata_iobus_sub_probe(device_t dev);
214static  int  ata_iobus_sub_setmode(device_t dev, int target, int mode);
215
216static device_method_t ata_iobus_sub_methods[] = {
217	/* Device interface */
218	DEVMETHOD(device_probe,     ata_iobus_sub_probe),
219	DEVMETHOD(device_attach,    ata_attach),
220	DEVMETHOD(device_detach,    ata_detach),
221	DEVMETHOD(device_resume,    ata_resume),
222
223	/* ATA interface */
224	DEVMETHOD(ata_setmode,	    ata_iobus_sub_setmode),
225	DEVMETHOD_END
226};
227
228static driver_t ata_iobus_sub_driver = {
229	"ata",
230	ata_iobus_sub_methods,
231	sizeof(struct ata_channel),
232};
233
234DRIVER_MODULE(ata, ataiobus, ata_iobus_sub_driver, ata_devclass, NULL, NULL);
235
236static int
237ata_iobus_sub_probe(device_t dev)
238{
239	struct ata_channel *ch = device_get_softc(dev);
240
241	/* Only a single unit per controller thus far */
242	ch->unit = 0;
243	ch->flags = (ATA_USE_16BIT|ATA_NO_SLAVE);
244	ata_generic_hw(dev);
245
246	return ata_probe(dev);
247}
248
249static int
250ata_iobus_sub_setmode(device_t parent, int target, int mode)
251{
252	/* Only ever PIO mode here... */
253	return (ATA_PIO);
254}
255