1/*	$NetBSD: cgeight.c,v 1.46 2008/06/11 21:25:31 drochner Exp $	*/
2
3/*-
4 * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32/*
33 * Copyright (c) 1992, 1993
34 *	The Regents of the University of California.  All rights reserved.
35 *
36 * This software was developed by the Computer Systems Engineering group
37 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
38 * contributed to Berkeley.
39 *
40 * All advertising materials mentioning features or use of this software
41 * must display the following acknowledgement:
42 *	This product includes software developed by the University of
43 *	California, Lawrence Berkeley Laboratory.
44 *
45 * Redistribution and use in source and binary forms, with or without
46 * modification, are permitted provided that the following conditions
47 * are met:
48 * 1. Redistributions of source code must retain the above copyright
49 *    notice, this list of conditions and the following disclaimer.
50 * 2. Redistributions in binary form must reproduce the above copyright
51 *    notice, this list of conditions and the following disclaimer in the
52 *    documentation and/or other materials provided with the distribution.
53 * 3. Neither the name of the University nor the names of its contributors
54 *    may be used to endorse or promote products derived from this software
55 *    without specific prior written permission.
56 *
57 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
58 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
59 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
60 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
61 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
62 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
63 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
64 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
65 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
66 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
67 * SUCH DAMAGE.
68 *
69 *	from @(#)cgthree.c	8.2 (Berkeley) 10/30/93
70 */
71
72/*
73 * Copyright (c) 1995 Theo de Raadt.  All rights reserved.
74 *
75 * Redistribution and use in source and binary forms, with or without
76 * modification, are permitted provided that the following conditions
77 * are met:
78 * 1. Redistributions of source code must retain the above copyright
79 *    notice, this list of conditions and the following disclaimer.
80 * 2. Redistributions in binary form must reproduce the above copyright
81 *    notice, this list of conditions and the following disclaimer in the
82 *    documentation and/or other materials provided with the distribution.
83 *
84 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
85 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
86 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
87 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
88 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
89 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
90 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
91 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
92 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
93 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
94 */
95
96/*
97 * color display (cgeight) driver.
98 *
99 * Does not handle interrupts, even though they can occur.
100 *
101 * XXX should defer colormap updates to vertical retrace interrupts
102 */
103
104#include <sys/cdefs.h>
105__KERNEL_RCSID(0, "$NetBSD: cgeight.c,v 1.46 2008/06/11 21:25:31 drochner Exp $");
106
107#include <sys/param.h>
108#include <sys/systm.h>
109#include <sys/buf.h>
110#include <sys/device.h>
111#include <sys/ioctl.h>
112#include <sys/malloc.h>
113#include <sys/mman.h>
114#include <sys/tty.h>
115#include <sys/conf.h>
116
117#include <uvm/uvm_extern.h>
118
119#include <machine/autoconf.h>
120#include <machine/eeprom.h>
121
122#include <dev/sun/fbio.h>
123#include <dev/sun/fbvar.h>
124#include <dev/sun/btreg.h>
125#include <dev/sun/btvar.h>
126#include <dev/sun/pfourreg.h>
127
128/* per-display variables */
129struct cgeight_softc {
130	struct fbdevice	sc_fb;		/* frame buffer device */
131	bus_space_tag_t	sc_bustag;
132	bus_addr_t	sc_paddr;	/* phys address for device mmap() */
133
134	volatile struct fbcontrol *sc_fbc;	/* Brooktree registers */
135	union bt_cmap	sc_cmap;	/* Brooktree color map */
136};
137
138/* autoconfiguration driver */
139static void	cgeightattach(device_t, device_t, void *);
140static int	cgeightmatch(device_t, cfdata_t, void *);
141#if defined(SUN4)
142static void	cgeightunblank(device_t);
143#endif
144
145static int	cg8_pfour_probe(void *, void *);
146
147CFATTACH_DECL_NEW(cgeight, sizeof(struct cgeight_softc),
148    cgeightmatch, cgeightattach, NULL, NULL);
149
150extern struct cfdriver cgeight_cd;
151
152dev_type_open(cgeightopen);
153dev_type_ioctl(cgeightioctl);
154dev_type_mmap(cgeightmmap);
155
156const struct cdevsw cgeight_cdevsw = {
157	cgeightopen, nullclose, noread, nowrite, cgeightioctl,
158	nostop, notty, nopoll, cgeightmmap, nokqfilter
159};
160
161#if defined(SUN4)
162/* frame buffer generic driver */
163static struct fbdriver cgeightfbdriver = {
164	cgeightunblank, cgeightopen, nullclose, cgeightioctl,
165	nopoll, cgeightmmap, nokqfilter
166};
167
168static void cgeightloadcmap(struct cgeight_softc *, int, int);
169static int cgeight_get_video(struct cgeight_softc *);
170static void cgeight_set_video(struct cgeight_softc *, int);
171#endif
172
173/*
174 * Match a cgeight.
175 */
176static int
177cgeightmatch(device_t parent, cfdata_t cf, void *aux)
178{
179	union obio_attach_args *uoba = aux;
180	struct obio4_attach_args *oba;
181
182	if (uoba->uoba_isobio4 == 0)
183		return (0);
184
185	oba = &uoba->uoba_oba4;
186	return (bus_space_probe(oba->oba_bustag, oba->oba_paddr,
187				4,	/* probe size */
188				0,	/* offset */
189				0,	/* flags */
190				cg8_pfour_probe, NULL));
191}
192
193static int
194cg8_pfour_probe(void *vaddr, void *arg)
195{
196
197	return (fb_pfour_id(vaddr) == PFOUR_ID_COLOR24);
198}
199
200/*
201 * Attach a display.  We need to notice if it is the console, too.
202 */
203static void
204cgeightattach(device_t parent, device_t self, void *aux)
205{
206#if defined(SUN4)
207	union obio_attach_args *uoba = aux;
208	struct obio4_attach_args *oba = &uoba->uoba_oba4;
209	struct cgeight_softc *sc = device_private(self);
210	struct fbdevice *fb = &sc->sc_fb;
211	bus_space_handle_t bh;
212	volatile struct bt_regs *bt;
213	int ramsize, i, isconsole;
214
215	sc->sc_bustag = oba->oba_bustag;
216	sc->sc_paddr = (bus_addr_t)oba->oba_paddr;
217
218	/* Map the pfour register. */
219	if (bus_space_map(oba->oba_bustag, oba->oba_paddr,
220			  sizeof(uint32_t),
221			  BUS_SPACE_MAP_LINEAR,
222			  &bh) != 0) {
223		printf("%s: cannot map pfour register\n",
224			device_xname(self));
225		return;
226	}
227	fb->fb_pfour = (volatile uint32_t *)bh;
228
229	fb->fb_driver = &cgeightfbdriver;
230	fb->fb_device = self;
231	fb->fb_type.fb_type = FBTYPE_MEMCOLOR;
232	fb->fb_flags = device_cfdata(self)->cf_flags & FB_USERMASK;
233	fb->fb_flags |= FB_PFOUR;
234
235	ramsize = PFOUR_COLOR_OFF_END - PFOUR_COLOR_OFF_OVERLAY;
236
237	fb->fb_type.fb_depth = 24;
238	fb_setsize_eeprom(fb, fb->fb_type.fb_depth, 1152, 900);
239
240	sc->sc_fb.fb_type.fb_cmsize = 256;
241	sc->sc_fb.fb_type.fb_size = ramsize;
242	printf(": cgeight/p4, %d x %d",
243		fb->fb_type.fb_width,
244		fb->fb_type.fb_height);
245
246	isconsole = 0;
247
248	if (CPU_ISSUN4) {
249		struct eeprom *eep = (struct eeprom *)eeprom_va;
250
251		/*
252		 * Assume this is the console if there's no eeprom info
253		 * to be found.
254		 */
255		if (eep == NULL || eep->eeConsole == EE_CONS_P4OPT)
256			isconsole = fb_is_console(0);
257	}
258
259#if 0
260	/*
261	 * We don't do any of the console handling here.  Instead,
262	 * we let the bwtwo driver pick up the overlay plane and
263	 * use it instead.  Rconsole should have better performance
264	 * with the 1-bit depth.
265	 *      -- Jason R. Thorpe <thorpej@NetBSD.org>
266	 */
267
268	/*
269	 * When the ROM has mapped in a cgfour display, the address
270	 * maps only the video RAM, so in any case we have to map the
271	 * registers ourselves.  We only need the video RAM if we are
272	 * going to print characters via rconsole.
273	 */
274
275	if (isconsole) {
276		/* XXX this is kind of a waste */
277		fb->fb_pixels = mapiodev(ca->ca_ra.ra_reg,
278					 PFOUR_COLOR_OFF_OVERLAY, ramsize);
279	}
280#endif
281
282	/* Map the Brooktree. */
283	if (bus_space_map(oba->oba_bustag,
284			  oba->oba_paddr + PFOUR_COLOR_OFF_CMAP,
285			  sizeof(struct fbcontrol),
286			  BUS_SPACE_MAP_LINEAR,
287			  &bh) != 0) {
288		printf("%s: cannot map control registers\n",
289			device_xname(self));
290		return;
291	}
292	sc->sc_fbc = (volatile struct fbcontrol *)bh;
293
294#if 0	/* XXX thorpej ??? */
295	/* tell the enable plane to look at the mono image */
296	memset(ca->ca_ra.ra_vaddr, 0xff,
297	    sc->sc_fb.fb_type.fb_width * sc->sc_fb.fb_type.fb_height / 8);
298#endif
299
300	/* grab initial (current) color map */
301	bt = &sc->sc_fbc->fbc_dac;
302	bt->bt_addr = 0;
303	for (i = 0; i < 256 * 3 / 4; i++)
304		sc->sc_cmap.cm_chip[i] = bt->bt_cmap;
305
306	BT_INIT(bt, 0);
307
308#if 0	/* see above */
309	if (isconsole) {
310		printf(" (console)\n");
311#if defined(RASTERCONSOLE) && 0	/* XXX been told it doesn't work well. */
312		fbrcons_init(fb);
313#endif
314	} else
315#endif /* 0 */
316		printf("\n");
317
318	/*
319	 * Even though we're not using rconsole, we'd still like
320	 * to notice if we're the console framebuffer.
321	 */
322	fb_attach(&sc->sc_fb, isconsole);
323#endif
324}
325
326int
327cgeightopen(dev_t dev, int flags, int mode, struct lwp *l)
328{
329	int unit = minor(dev);
330
331	if (device_lookup(&cgeight_cd, unit) == NULL)
332		return (ENXIO);
333	return (0);
334}
335
336int
337cgeightioctl(dev_t dev, u_long cmd, void *data, int flags, struct lwp *l)
338{
339#if defined(SUN4)
340	struct cgeight_softc *sc = device_lookup_private(&cgeight_cd,
341							 minor(dev));
342	struct fbgattr *fba;
343	int error;
344
345	switch (cmd) {
346
347	case FBIOGTYPE:
348		*(struct fbtype *)data = sc->sc_fb.fb_type;
349		break;
350
351	case FBIOGATTR:
352		fba = (struct fbgattr *)data;
353		fba->real_type = sc->sc_fb.fb_type.fb_type;
354		fba->owner = 0;		/* XXX ??? */
355		fba->fbtype = sc->sc_fb.fb_type;
356		fba->sattr.flags = 0;
357		fba->sattr.emu_type = sc->sc_fb.fb_type.fb_type;
358		fba->sattr.dev_specific[0] = -1;
359		fba->emu_types[0] = sc->sc_fb.fb_type.fb_type;
360		fba->emu_types[1] = -1;
361		break;
362
363	case FBIOGETCMAP:
364#define p ((struct fbcmap *)data)
365		return (bt_getcmap(p, &sc->sc_cmap, 256, 1));
366
367	case FBIOPUTCMAP:
368		/* copy to software map */
369		error = bt_putcmap(p, &sc->sc_cmap, 256, 1);
370		if (error)
371			return (error);
372		/* now blast them into the chip */
373		/* XXX should use retrace interrupt */
374		cgeightloadcmap(sc, p->index, p->count);
375#undef p
376		break;
377
378	case FBIOGVIDEO:
379		*(int *)data = cgeight_get_video(sc);
380		break;
381
382	case FBIOSVIDEO:
383		cgeight_set_video(sc, *(int *)data);
384		break;
385
386	default:
387		return (ENOTTY);
388	}
389#endif /* SUN4 */
390
391	return (0);
392}
393
394/*
395 * Return the address that would map the given device at the given
396 * offset, allowing for the given protection, or return -1 for error.
397 *
398 * The cg8 maps it's overlay plane at 0 for 128K, followed by the
399 * enable plane for 128K, followed by the colour for as long as it
400 * goes. Starting at 8MB, it maps the ramdac for PAGE_SIZE, then the p4
401 * register for PAGE_SIZE, then the bootrom for 0x40000.
402 */
403paddr_t
404cgeightmmap(dev_t dev, off_t off, int prot)
405{
406	struct cgeight_softc *sc = device_lookup_private(&cgeight_cd,
407							 minor(dev));
408	off_t poff;
409
410#define START_ENABLE	(128*1024)
411#define START_COLOR	((128*1024) + (128*1024))
412#define COLOR_SIZE	(sc->sc_fb.fb_type.fb_width * \
413			    sc->sc_fb.fb_type.fb_height * 3)
414#define END_COLOR	(START_COLOR + COLOR_SIZE)
415#define START_SPECIAL	0x800000
416#define PROMSIZE	0x40000
417#define NOOVERLAY	(0x04000000)
418
419	if (off & PGOFSET)
420		panic("cgeightmap");
421
422	if (off < 0)
423		return (-1);
424	else if ((u_int)off >= NOOVERLAY) {
425		off -= NOOVERLAY;
426
427		/*
428		 * X11 maps a huge chunk of the frame buffer; far more than
429		 * there really is. We compensate by double-mapping the
430		 * first page for as many other pages as it wants
431		 */
432		while ((u_int)off >= COLOR_SIZE)
433			off -= COLOR_SIZE;	/* XXX thorpej ??? */
434
435		poff = off + PFOUR_COLOR_OFF_COLOR;
436	} else if ((u_int)off < START_ENABLE) {
437		/*
438		 * in overlay plane
439		 */
440		poff = PFOUR_COLOR_OFF_OVERLAY + off;
441	} else if ((u_int)off < START_COLOR) {
442		/*
443		 * in enable plane
444		 */
445		poff = (off - START_ENABLE) + PFOUR_COLOR_OFF_ENABLE;
446	} else if ((u_int)off < sc->sc_fb.fb_type.fb_size) {
447		/*
448		 * in colour plane
449		 */
450		poff = (off - START_COLOR) + PFOUR_COLOR_OFF_COLOR;
451	} else if ((u_int)off < START_SPECIAL) {
452		/*
453		 * hole
454		 */
455		poff = 0;	/* XXX */
456	} else if ((u_int)off == START_SPECIAL) {
457		/*
458		 * colour map (Brooktree)
459		 */
460		poff = PFOUR_COLOR_OFF_CMAP;
461	} else if ((u_int)off == START_SPECIAL + PAGE_SIZE) {
462		/*
463		 * p4 register
464		 */
465		poff = 0;
466	} else if ((u_int)off > (START_SPECIAL + (PAGE_SIZE * 2)) &&
467	    (u_int) off < (START_SPECIAL + (PAGE_SIZE * 2) + PROMSIZE)) {
468		/*
469		 * rom
470		 */
471		poff = 0x8000 + (off - (START_SPECIAL + (PAGE_SIZE * 2)));
472	} else
473		return (-1);
474
475	return (bus_space_mmap(sc->sc_bustag,
476		sc->sc_paddr, poff,
477		prot, BUS_SPACE_MAP_LINEAR));
478}
479
480#if defined(SUN4)
481/*
482 * Undo the effect of an FBIOSVIDEO that turns the video off.
483 */
484static void
485cgeightunblank(device_t dev)
486{
487
488	cgeight_set_video(device_private(dev), 1);
489}
490
491static int
492cgeight_get_video(struct cgeight_softc *sc)
493{
494
495	return (fb_pfour_get_video(&sc->sc_fb));
496}
497
498static void
499cgeight_set_video(struct cgeight_softc *sc, int enable)
500{
501
502	fb_pfour_set_video(&sc->sc_fb, enable);
503}
504
505/*
506 * Load a subset of the current (new) colormap into the Brooktree DAC.
507 */
508static void
509cgeightloadcmap(struct cgeight_softc *sc, int start, int ncolors)
510{
511	volatile struct bt_regs *bt;
512	u_int *ip;
513	int count;
514
515	ip = &sc->sc_cmap.cm_chip[BT_D4M3(start)];	/* start/4 * 3 */
516	count = BT_D4M3(start + ncolors - 1) - BT_D4M3(start) + 3;
517	bt = &sc->sc_fbc->fbc_dac;
518	bt->bt_addr = BT_D4M4(start);
519	while (--count >= 0)
520		bt->bt_cmap = *ip++;
521}
522#endif /* SUN4 */
523