terasic_mtl_fdt.c revision 245373
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: head/sys/dev/terasic/mtl/terasic_mtl_fdt.c 245373 2013-01-13 16:27:56Z rwatson $");
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_is_compatible(dev, "cambridge,mtl")) {
63		device_set_desc(dev, "Terasic Multi-touch LCD (MTL)");
64		return (BUS_PROBE_DEFAULT);
65	}
66        return (ENXIO);
67}
68
69static int
70terasic_mtl_fdt_attach(device_t dev)
71{
72	struct terasic_mtl_softc *sc;
73	int error;
74
75	sc = device_get_softc(dev);
76	sc->mtl_dev = dev;
77	sc->mtl_unit = device_get_unit(dev);
78
79	/*
80	 * FDT allows multiple memory resources to be defined for a device;
81	 * query them in the order registers, pixel buffer, text buffer.
82	 * However, we need to sanity-check that they are page-aligned and
83	 * page-sized, so we may still abort.
84	 */
85	sc->mtl_reg_rid = 0;
86	sc->mtl_reg_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
87	    &sc->mtl_reg_rid, RF_ACTIVE);
88	if (sc->mtl_reg_res == NULL) {
89		device_printf(dev, "couldn't map register memory\n");
90		error = ENXIO;
91		goto error;
92	}
93	if (rman_get_start(sc->mtl_reg_res) % PAGE_SIZE != 0) {
94		device_printf(dev, "improper register address");
95		error = ENXIO;
96		goto error;
97	}
98	if (rman_get_size(sc->mtl_reg_res) % PAGE_SIZE != 0) {
99		device_printf(dev, "improper register size");
100		error = ENXIO;
101		goto error;
102	}
103	device_printf(sc->mtl_dev, "registers at mem %p-%p\n",
104            (void *)rman_get_start(sc->mtl_reg_res),
105	    (void *)(rman_get_start(sc->mtl_reg_res) +
106	      rman_get_size(sc->mtl_reg_res)));
107
108	sc->mtl_pixel_rid = 1;
109	sc->mtl_pixel_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
110	    &sc->mtl_pixel_rid, RF_ACTIVE);
111	if (sc->mtl_pixel_res == NULL) {
112		device_printf(dev, "couldn't map pixel memory\n");
113		error = ENXIO;
114		goto error;
115	}
116	if (rman_get_start(sc->mtl_pixel_res) % PAGE_SIZE != 0) {
117		device_printf(dev, "improper pixel address");
118		error = ENXIO;
119		goto error;
120	}
121	if (rman_get_size(sc->mtl_pixel_res) % PAGE_SIZE != 0) {
122		device_printf(dev, "improper pixel size");
123		error = ENXIO;
124		goto error;
125	}
126	device_printf(sc->mtl_dev, "pixel frame buffer at mem %p-%p\n",
127            (void *)rman_get_start(sc->mtl_pixel_res),
128	    (void *)(rman_get_start(sc->mtl_pixel_res) +
129	      rman_get_size(sc->mtl_pixel_res)));
130
131	sc->mtl_text_rid = 2;
132	sc->mtl_text_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
133	    &sc->mtl_text_rid, RF_ACTIVE);
134	if (sc->mtl_text_res == NULL) {
135		device_printf(dev, "couldn't map text memory\n");
136		error = ENXIO;
137		goto error;
138	}
139	if (rman_get_start(sc->mtl_text_res) % PAGE_SIZE != 0) {
140		device_printf(dev, "improper text address");
141		error = ENXIO;
142		goto error;
143	}
144	if (rman_get_size(sc->mtl_text_res) % PAGE_SIZE != 0) {
145		device_printf(dev, "improper text size");
146		error = ENXIO;
147		goto error;
148	}
149	device_printf(sc->mtl_dev, "text frame buffer at mem %p-%p\n",
150            (void *)rman_get_start(sc->mtl_text_res),
151	    (void *)(rman_get_start(sc->mtl_text_res) +
152	      rman_get_size(sc->mtl_text_res)));
153
154	error = terasic_mtl_attach(sc);
155	if (error == 0)
156		return (0);
157error:
158	if (sc->mtl_text_res != NULL)
159		bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_text_rid,
160		    sc->mtl_text_res);
161	if (sc->mtl_pixel_res != NULL)
162		bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_pixel_rid,
163		    sc->mtl_pixel_res);
164	if (sc->mtl_reg_res != NULL)
165		bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_reg_rid,
166		    sc->mtl_reg_res);
167	return (error);
168}
169
170static int
171terasic_mtl_fdt_detach(device_t dev)
172{
173	struct terasic_mtl_softc *sc;
174
175	sc = device_get_softc(dev);
176	terasic_mtl_detach(sc);
177	bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_text_rid,
178	    sc->mtl_text_res);
179	bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_pixel_rid,
180	    sc->mtl_pixel_res);
181	bus_release_resource(dev, SYS_RES_MEMORY, sc->mtl_reg_rid,
182	    sc->mtl_reg_res);
183	return (0);
184}
185
186static device_method_t terasic_mtl_fdt_methods[] = {
187	DEVMETHOD(device_probe,		terasic_mtl_fdt_probe),
188	DEVMETHOD(device_attach,	terasic_mtl_fdt_attach),
189	DEVMETHOD(device_detach,	terasic_mtl_fdt_detach),
190	{ 0, 0 }
191};
192
193static driver_t terasic_mtl_fdt_driver = {
194	"terasic_mtl",
195	terasic_mtl_fdt_methods,
196	sizeof(struct terasic_mtl_softc),
197};
198
199static devclass_t terasic_mtl_devclass;
200
201DRIVER_MODULE(mtl, simplebus, terasic_mtl_fdt_driver, terasic_mtl_devclass, 0,
202    0);
203