terasic_mtl_fdt.c revision 266152
1/*-
2 * Copyright (c) 2012-2013 Robert N. M. Watson
3 * All rights reserved.
4 *
5 * This software was developed by SRI International and the University of
6 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
7 * ("CTSRD"), as part of the DARPA CRASH research programme.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 */
30
31#include <sys/cdefs.h>
32__FBSDID("$FreeBSD: stable/10/sys/dev/terasic/mtl/terasic_mtl_fdt.c 266152 2014-05-15 16:11:06Z ian $");
33
34#include <sys/param.h>
35#include <sys/bus.h>
36#include <sys/condvar.h>
37#include <sys/conf.h>
38#include <sys/consio.h>				/* struct vt_mode */
39#include <sys/fbio.h>				/* video_adapter_t */
40#include <sys/kernel.h>
41#include <sys/lock.h>
42#include <sys/malloc.h>
43#include <sys/module.h>
44#include <sys/mutex.h>
45#include <sys/rman.h>
46#include <sys/systm.h>
47
48#include <machine/bus.h>
49#include <machine/resource.h>
50
51#include <dev/fdt/fdt_common.h>
52#include <dev/ofw/openfirm.h>
53#include <dev/ofw/ofw_bus.h>
54#include <dev/ofw/ofw_bus_subr.h>
55
56#include <dev/terasic/mtl/terasic_mtl.h>
57
58static int
59terasic_mtl_fdt_probe(device_t dev)
60{
61
62	if (!ofw_bus_status_okay(dev))
63		return (ENXIO);
64
65	if (ofw_bus_is_compatible(dev, "sri-cambridge,mtl")) {
66		device_set_desc(dev, "Terasic Multi-touch LCD (MTL)");
67		return (BUS_PROBE_DEFAULT);
68	}
69        return (ENXIO);
70}
71
72static int
73terasic_mtl_fdt_attach(device_t dev)
74{
75	struct terasic_mtl_softc *sc;
76	int error;
77
78	sc = device_get_softc(dev);
79	sc->mtl_dev = dev;
80	sc->mtl_unit = device_get_unit(dev);
81
82	/*
83	 * FDT allows multiple memory resources to be defined for a device;
84	 * query them in the order registers, pixel buffer, text buffer.
85	 * However, we need to sanity-check that they are page-aligned and
86	 * page-sized, so we may still abort.
87	 */
88	sc->mtl_reg_rid = 0;
89	sc->mtl_reg_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
90	    &sc->mtl_reg_rid, RF_ACTIVE);
91	if (sc->mtl_reg_res == NULL) {
92		device_printf(dev, "couldn't map register memory\n");
93		error = ENXIO;
94		goto error;
95	}
96	if (rman_get_start(sc->mtl_reg_res) % PAGE_SIZE != 0) {
97		device_printf(dev, "improper register address");
98		error = ENXIO;
99		goto error;
100	}
101	if (rman_get_size(sc->mtl_reg_res) % PAGE_SIZE != 0) {
102		device_printf(dev, "improper register size");
103		error = ENXIO;
104		goto error;
105	}
106	device_printf(sc->mtl_dev, "registers at mem %p-%p\n",
107            (void *)rman_get_start(sc->mtl_reg_res),
108	    (void *)(rman_get_start(sc->mtl_reg_res) +
109	      rman_get_size(sc->mtl_reg_res)));
110
111	sc->mtl_pixel_rid = 1;
112	sc->mtl_pixel_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
113	    &sc->mtl_pixel_rid, RF_ACTIVE);
114	if (sc->mtl_pixel_res == NULL) {
115		device_printf(dev, "couldn't map pixel memory\n");
116		error = ENXIO;
117		goto error;
118	}
119	if (rman_get_start(sc->mtl_pixel_res) % PAGE_SIZE != 0) {
120		device_printf(dev, "improper pixel address");
121		error = ENXIO;
122		goto error;
123	}
124	if (rman_get_size(sc->mtl_pixel_res) % PAGE_SIZE != 0) {
125		device_printf(dev, "improper pixel size");
126		error = ENXIO;
127		goto error;
128	}
129	device_printf(sc->mtl_dev, "pixel frame buffer at mem %p-%p\n",
130            (void *)rman_get_start(sc->mtl_pixel_res),
131	    (void *)(rman_get_start(sc->mtl_pixel_res) +
132	      rman_get_size(sc->mtl_pixel_res)));
133
134	sc->mtl_text_rid = 2;
135	sc->mtl_text_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
136	    &sc->mtl_text_rid, RF_ACTIVE);
137	if (sc->mtl_text_res == NULL) {
138		device_printf(dev, "couldn't map text memory\n");
139		error = ENXIO;
140		goto error;
141	}
142	if (rman_get_start(sc->mtl_text_res) % PAGE_SIZE != 0) {
143		device_printf(dev, "improper text address");
144		error = ENXIO;
145		goto error;
146	}
147	if (rman_get_size(sc->mtl_text_res) % PAGE_SIZE != 0) {
148		device_printf(dev, "improper text size");
149		error = ENXIO;
150		goto error;
151	}
152	device_printf(sc->mtl_dev, "text frame buffer at mem %p-%p\n",
153            (void *)rman_get_start(sc->mtl_text_res),
154	    (void *)(rman_get_start(sc->mtl_text_res) +
155	      rman_get_size(sc->mtl_text_res)));
156
157	error = terasic_mtl_attach(sc);
158	if (error == 0)
159		return (0);
160error:
161	if (sc->mtl_text_res != NULL)
162		bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_text_rid,
163		    sc->mtl_text_res);
164	if (sc->mtl_pixel_res != NULL)
165		bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_pixel_rid,
166		    sc->mtl_pixel_res);
167	if (sc->mtl_reg_res != NULL)
168		bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_reg_rid,
169		    sc->mtl_reg_res);
170	return (error);
171}
172
173static int
174terasic_mtl_fdt_detach(device_t dev)
175{
176	struct terasic_mtl_softc *sc;
177
178	sc = device_get_softc(dev);
179	terasic_mtl_detach(sc);
180	bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_text_rid,
181	    sc->mtl_text_res);
182	bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_pixel_rid,
183	    sc->mtl_pixel_res);
184	bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_reg_rid,
185	    sc->mtl_reg_res);
186	return (0);
187}
188
189static device_method_t terasic_mtl_fdt_methods[] = {
190	DEVMETHOD(device_probe,		terasic_mtl_fdt_probe),
191	DEVMETHOD(device_attach,	terasic_mtl_fdt_attach),
192	DEVMETHOD(device_detach,	terasic_mtl_fdt_detach),
193	{ 0, 0 }
194};
195
196static driver_t terasic_mtl_fdt_driver = {
197	"terasic_mtl",
198	terasic_mtl_fdt_methods,
199	sizeof(struct terasic_mtl_softc),
200};
201
202DRIVER_MODULE(mtl, simplebus, terasic_mtl_fdt_driver, terasic_mtl_devclass, 0,
203    0);
204