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