1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
5 * Copyright (c) 2012, 2013 The FreeBSD Foundation
6 * All rights reserved.
7 *
8 * Portions of this software were developed by Oleksandr Rybalko
9 * under sponsorship from the FreeBSD Foundation.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 */
33#include <sys/cdefs.h>
34__FBSDID("$FreeBSD$");
35
36#include <sys/param.h>
37#include <sys/systm.h>
38#include <sys/bio.h>
39#include <sys/bus.h>
40#include <sys/fbio.h>
41#include <sys/kernel.h>
42#include <sys/malloc.h>
43#include <sys/module.h>
44
45#include <vm/vm.h>
46#include <vm/pmap.h>
47
48#include <dev/ofw/ofw_bus.h>
49#include <dev/ofw/ofw_bus_subr.h>
50
51#include <dev/fb/fbreg.h>
52#include <dev/vt/vt.h>
53#include <dev/vt/colors/vt_termcolors.h>
54
55#include <arm/broadcom/bcm2835/bcm2835_mbox_prop.h>
56
57#include "fb_if.h"
58#include "mbox_if.h"
59
60#define	FB_DEPTH		24
61
62struct bcmsc_softc {
63	struct fb_info 			info;
64	int				fbswap;
65	struct bcm2835_fb_config	fb;
66	device_t			dev;
67};
68
69static struct ofw_compat_data compat_data[] = {
70	{"broadcom,bcm2835-fb",		1},
71	{"brcm,bcm2708-fb",		1},
72	{NULL,				0}
73};
74
75static int bcm_fb_probe(device_t);
76static int bcm_fb_attach(device_t);
77
78static int
79bcm_fb_init(struct bcmsc_softc *sc, struct bcm2835_fb_config *fb)
80{
81	int err;
82
83	err = 0;
84
85	memset(fb, 0, sizeof(*fb));
86	if (bcm2835_mbox_fb_get_w_h(fb) != 0)
87		return (ENXIO);
88	if (bcm2835_mbox_fb_get_bpp(fb) != 0)
89		return (ENXIO);
90	if (fb->bpp < FB_DEPTH) {
91		device_printf(sc->dev, "changing fb bpp from %d to %d\n",
92		    fb->bpp, FB_DEPTH);
93		fb->bpp = FB_DEPTH;
94	} else
95		device_printf(sc->dev, "keeping existing fb bpp of %d\n",
96		    fb->bpp);
97
98	fb->vxres = fb->xres;
99	fb->vyres = fb->yres;
100	fb->xoffset = fb->yoffset = 0;
101
102	if ((err = bcm2835_mbox_fb_init(fb)) != 0) {
103		device_printf(sc->dev, "bcm2835_mbox_fb_init failed, err=%d\n",
104		    err);
105		return (ENXIO);
106	}
107
108	return (0);
109}
110
111static int
112bcm_fb_setup_fbd(struct bcmsc_softc *sc)
113{
114	struct bcm2835_fb_config fb;
115	device_t fbd;
116	int err;
117
118	err = bcm_fb_init(sc, &fb);
119	if (err)
120		return (err);
121
122	memset(&sc->info, 0, sizeof(sc->info));
123	sc->info.fb_name = device_get_nameunit(sc->dev);
124
125	sc->info.fb_vbase = (intptr_t)pmap_mapdev(fb.base, fb.size);
126	sc->info.fb_pbase = fb.base;
127	sc->info.fb_size = fb.size;
128	sc->info.fb_bpp = sc->info.fb_depth = fb.bpp;
129	sc->info.fb_stride = fb.pitch;
130	sc->info.fb_width = fb.xres;
131	sc->info.fb_height = fb.yres;
132#ifdef VM_MEMATTR_WRITE_COMBINING
133	sc->info.fb_flags = FB_FLAG_MEMATTR;
134	sc->info.fb_memattr = VM_MEMATTR_WRITE_COMBINING;
135#endif
136
137	if (sc->fbswap) {
138		switch (sc->info.fb_bpp) {
139		case 24:
140			vt_generate_cons_palette(sc->info.fb_cmap,
141			    COLOR_FORMAT_RGB, 0xff, 0, 0xff, 8, 0xff, 16);
142			sc->info.fb_cmsize = 16;
143			break;
144		case 32:
145			vt_generate_cons_palette(sc->info.fb_cmap,
146			    COLOR_FORMAT_RGB, 0xff, 16, 0xff, 8, 0xff, 0);
147			sc->info.fb_cmsize = 16;
148			break;
149		}
150	}
151
152	fbd = device_add_child(sc->dev, "fbd", device_get_unit(sc->dev));
153	if (fbd == NULL) {
154		device_printf(sc->dev, "Failed to add fbd child\n");
155		pmap_unmapdev(sc->info.fb_vbase, sc->info.fb_size);
156		return (ENXIO);
157	} else if (device_probe_and_attach(fbd) != 0) {
158		device_printf(sc->dev, "Failed to attach fbd device\n");
159		device_delete_child(sc->dev, fbd);
160		pmap_unmapdev(sc->info.fb_vbase, sc->info.fb_size);
161		return (ENXIO);
162	}
163
164	device_printf(sc->dev, "%dx%d(%dx%d@%d,%d) %dbpp\n", fb.xres, fb.yres,
165	    fb.vxres, fb.vyres, fb.xoffset, fb.yoffset, fb.bpp);
166	device_printf(sc->dev,
167	    "fbswap: %d, pitch %d, base 0x%08x, screen_size %d\n",
168	    sc->fbswap, fb.pitch, fb.base, fb.size);
169
170	return (0);
171}
172
173static int
174bcm_fb_resync_sysctl(SYSCTL_HANDLER_ARGS)
175{
176	struct bcmsc_softc *sc = arg1;
177	struct bcm2835_fb_config fb;
178	int val;
179	int err;
180
181	val = 0;
182	err = sysctl_handle_int(oidp, &val, 0, req);
183	if (err || !req->newptr) /* error || read request */
184		return (err);
185
186	bcm_fb_init(sc, &fb);
187
188	return (0);
189}
190
191static void
192bcm_fb_sysctl_init(struct bcmsc_softc *sc)
193{
194	struct sysctl_ctx_list *ctx;
195	struct sysctl_oid *tree_node;
196	struct sysctl_oid_list *tree;
197
198	/*
199	 * Add system sysctl tree/handlers.
200	 */
201	ctx = device_get_sysctl_ctx(sc->dev);
202	tree_node = device_get_sysctl_tree(sc->dev);
203	tree = SYSCTL_CHILDREN(tree_node);
204	SYSCTL_ADD_PROC(ctx, tree, OID_AUTO, "resync",
205	    CTLFLAG_RW | CTLTYPE_UINT | CTLFLAG_NEEDGIANT, sc, sizeof(*sc),
206	    bcm_fb_resync_sysctl, "IU", "Set to resync framebuffer with VC");
207}
208
209static int
210bcm_fb_probe(device_t dev)
211{
212
213	if (ofw_bus_search_compatible(dev, compat_data)->ocd_data == 0)
214		return (ENXIO);
215
216	device_set_desc(dev, "BCM2835 VT framebuffer driver");
217
218	return (BUS_PROBE_DEFAULT);
219}
220
221static int
222bcm_fb_attach(device_t dev)
223{
224	char bootargs[2048], *n, *p, *v;
225	int err;
226	phandle_t chosen;
227	struct bcmsc_softc *sc;
228
229	sc = device_get_softc(dev);
230	sc->dev = dev;
231
232	/* Newer firmware versions needs an inverted color palette. */
233	sc->fbswap = 0;
234	chosen = OF_finddevice("/chosen");
235	if (chosen != -1 &&
236	    OF_getprop(chosen, "bootargs", &bootargs, sizeof(bootargs)) > 0) {
237		p = bootargs;
238		while ((v = strsep(&p, " ")) != NULL) {
239			if (*v == '\0')
240				continue;
241			n = strsep(&v, "=");
242			if (strcmp(n, "bcm2708_fb.fbswap") == 0 && v != NULL)
243				if (*v == '1')
244					sc->fbswap = 1;
245                }
246        }
247
248	bcm_fb_sysctl_init(sc);
249
250	err = bcm_fb_setup_fbd(sc);
251	if (err)
252		return (err);
253
254	return (0);
255}
256
257static struct fb_info *
258bcm_fb_helper_getinfo(device_t dev)
259{
260	struct bcmsc_softc *sc;
261
262	sc = device_get_softc(dev);
263
264	return (&sc->info);
265}
266
267static device_method_t bcm_fb_methods[] = {
268	/* Device interface */
269	DEVMETHOD(device_probe,		bcm_fb_probe),
270	DEVMETHOD(device_attach,	bcm_fb_attach),
271
272	/* Framebuffer service methods */
273	DEVMETHOD(fb_getinfo,		bcm_fb_helper_getinfo),
274
275	DEVMETHOD_END
276};
277
278static devclass_t bcm_fb_devclass;
279
280static driver_t bcm_fb_driver = {
281	"fb",
282	bcm_fb_methods,
283	sizeof(struct bcmsc_softc),
284};
285
286DRIVER_MODULE(bcm2835fb, ofwbus, bcm_fb_driver, bcm_fb_devclass, 0, 0);
287DRIVER_MODULE(bcm2835fb, simplebus, bcm_fb_driver, bcm_fb_devclass, 0, 0);
288