Sync usage with man page.
[netbsd-mini2440.git] / sys / arch / sparc / dev / cgeight.c
blob034b9e22ccb04a02d7e5b71c6eadbd1e17ee02bb
1 /* $NetBSD: cgeight.c,v 1.45 2008/04/28 20:23:35 martin Exp $ */
3 /*-
4 * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
5 * All rights reserved.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe.
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.
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.
33 * Copyright (c) 1992, 1993
34 * The Regents of the University of California. All rights reserved.
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.
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.
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.
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.
69 * from @(#)cgthree.c 8.2 (Berkeley) 10/30/93
73 * Copyright (c) 1995 Theo de Raadt. All rights reserved.
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.
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.
97 * color display (cgeight) driver.
99 * Does not handle interrupts, even though they can occur.
101 * XXX should defer colormap updates to vertical retrace interrupts
104 #include <sys/cdefs.h>
105 __KERNEL_RCSID(0, "$NetBSD: cgeight.c,v 1.45 2008/04/28 20:23:35 martin Exp $");
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>
117 #include <uvm/uvm_extern.h>
119 #include <machine/autoconf.h>
120 #include <machine/eeprom.h>
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>
128 /* per-display variables */
129 struct cgeight_softc {
130 struct device sc_dev; /* base device */
131 struct fbdevice sc_fb; /* frame buffer device */
132 bus_space_tag_t sc_bustag;
133 bus_addr_t sc_paddr; /* phys address for device mmap() */
135 volatile struct fbcontrol *sc_fbc; /* Brooktree registers */
136 union bt_cmap sc_cmap; /* Brooktree color map */
139 /* autoconfiguration driver */
140 static void cgeightattach(struct device *, struct device *, void *);
141 static int cgeightmatch(struct device *, struct cfdata *, void *);
142 #if defined(SUN4)
143 static void cgeightunblank(struct device *);
144 #endif
146 static int cg8_pfour_probe(void *, void *);
148 CFATTACH_DECL(cgeight, sizeof(struct cgeight_softc),
149 cgeightmatch, cgeightattach, NULL, NULL);
151 extern struct cfdriver cgeight_cd;
153 dev_type_open(cgeightopen);
154 dev_type_ioctl(cgeightioctl);
155 dev_type_mmap(cgeightmmap);
157 const struct cdevsw cgeight_cdevsw = {
158 cgeightopen, nullclose, noread, nowrite, cgeightioctl,
159 nostop, notty, nopoll, cgeightmmap, nokqfilter
162 #if defined(SUN4)
163 /* frame buffer generic driver */
164 static struct fbdriver cgeightfbdriver = {
165 cgeightunblank, cgeightopen, nullclose, cgeightioctl,
166 nopoll, cgeightmmap, nokqfilter
169 static void cgeightloadcmap(struct cgeight_softc *, int, int);
170 static int cgeight_get_video(struct cgeight_softc *);
171 static void cgeight_set_video(struct cgeight_softc *, int);
172 #endif
175 * Match a cgeight.
177 static int
178 cgeightmatch(struct device *parent, struct cfdata *cf, void *aux)
180 union obio_attach_args *uoba = aux;
181 struct obio4_attach_args *oba;
183 if (uoba->uoba_isobio4 == 0)
184 return (0);
186 oba = &uoba->uoba_oba4;
187 return (bus_space_probe(oba->oba_bustag, oba->oba_paddr,
188 4, /* probe size */
189 0, /* offset */
190 0, /* flags */
191 cg8_pfour_probe, NULL));
194 static int
195 cg8_pfour_probe(void *vaddr, void *arg)
198 return (fb_pfour_id(vaddr) == PFOUR_ID_COLOR24);
202 * Attach a display. We need to notice if it is the console, too.
204 static void
205 cgeightattach(struct device *parent, struct device *self, void *aux)
207 #if defined(SUN4)
208 union obio_attach_args *uoba = aux;
209 struct obio4_attach_args *oba = &uoba->uoba_oba4;
210 struct cgeight_softc *sc = device_private(self);
211 struct fbdevice *fb = &sc->sc_fb;
212 bus_space_handle_t bh;
213 volatile struct bt_regs *bt;
214 int ramsize, i, isconsole;
216 sc->sc_bustag = oba->oba_bustag;
217 sc->sc_paddr = (bus_addr_t)oba->oba_paddr;
219 /* Map the pfour register. */
220 if (bus_space_map(oba->oba_bustag, oba->oba_paddr,
221 sizeof(uint32_t),
222 BUS_SPACE_MAP_LINEAR,
223 &bh) != 0) {
224 printf("%s: cannot map pfour register\n", self->dv_xname);
225 return;
227 fb->fb_pfour = (volatile uint32_t *)bh;
229 fb->fb_driver = &cgeightfbdriver;
230 fb->fb_device = &sc->sc_dev;
231 fb->fb_type.fb_type = FBTYPE_MEMCOLOR;
232 fb->fb_flags = device_cfdata(&sc->sc_dev)->cf_flags & FB_USERMASK;
233 fb->fb_flags |= FB_PFOUR;
235 ramsize = PFOUR_COLOR_OFF_END - PFOUR_COLOR_OFF_OVERLAY;
237 fb->fb_type.fb_depth = 24;
238 fb_setsize_eeprom(fb, fb->fb_type.fb_depth, 1152, 900);
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);
246 isconsole = 0;
248 if (CPU_ISSUN4) {
249 struct eeprom *eep = (struct eeprom *)eeprom_va;
252 * Assume this is the console if there's no eeprom info
253 * to be found.
255 if (eep == NULL || eep->eeConsole == EE_CONS_P4OPT)
256 isconsole = fb_is_console(0);
259 #if 0
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>
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.
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);
280 #endif
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", self->dv_xname);
289 return;
291 sc->sc_fbc = (volatile struct fbcontrol *)bh;
293 #if 0 /* XXX thorpej ??? */
294 /* tell the enable plane to look at the mono image */
295 memset(ca->ca_ra.ra_vaddr, 0xff,
296 sc->sc_fb.fb_type.fb_width * sc->sc_fb.fb_type.fb_height / 8);
297 #endif
299 /* grab initial (current) color map */
300 bt = &sc->sc_fbc->fbc_dac;
301 bt->bt_addr = 0;
302 for (i = 0; i < 256 * 3 / 4; i++)
303 sc->sc_cmap.cm_chip[i] = bt->bt_cmap;
305 BT_INIT(bt, 0);
307 #if 0 /* see above */
308 if (isconsole) {
309 printf(" (console)\n");
310 #if defined(RASTERCONSOLE) && 0 /* XXX been told it doesn't work well. */
311 fbrcons_init(fb);
312 #endif
313 } else
314 #endif /* 0 */
315 printf("\n");
318 * Even though we're not using rconsole, we'd still like
319 * to notice if we're the console framebuffer.
321 fb_attach(&sc->sc_fb, isconsole);
322 #endif
326 cgeightopen(dev_t dev, int flags, int mode, struct lwp *l)
328 int unit = minor(dev);
330 if (device_lookup(&cgeight_cd, unit) == NULL)
331 return (ENXIO);
332 return (0);
336 cgeightioctl(dev_t dev, u_long cmd, void *data, int flags, struct lwp *l)
338 #if defined(SUN4)
339 struct cgeight_softc *sc = device_lookup_private(&cgeight_cd,
340 minor(dev));
341 struct fbgattr *fba;
342 int error;
344 switch (cmd) {
346 case FBIOGTYPE:
347 *(struct fbtype *)data = sc->sc_fb.fb_type;
348 break;
350 case FBIOGATTR:
351 fba = (struct fbgattr *)data;
352 fba->real_type = sc->sc_fb.fb_type.fb_type;
353 fba->owner = 0; /* XXX ??? */
354 fba->fbtype = sc->sc_fb.fb_type;
355 fba->sattr.flags = 0;
356 fba->sattr.emu_type = sc->sc_fb.fb_type.fb_type;
357 fba->sattr.dev_specific[0] = -1;
358 fba->emu_types[0] = sc->sc_fb.fb_type.fb_type;
359 fba->emu_types[1] = -1;
360 break;
362 case FBIOGETCMAP:
363 #define p ((struct fbcmap *)data)
364 return (bt_getcmap(p, &sc->sc_cmap, 256, 1));
366 case FBIOPUTCMAP:
367 /* copy to software map */
368 error = bt_putcmap(p, &sc->sc_cmap, 256, 1);
369 if (error)
370 return (error);
371 /* now blast them into the chip */
372 /* XXX should use retrace interrupt */
373 cgeightloadcmap(sc, p->index, p->count);
374 #undef p
375 break;
377 case FBIOGVIDEO:
378 *(int *)data = cgeight_get_video(sc);
379 break;
381 case FBIOSVIDEO:
382 cgeight_set_video(sc, *(int *)data);
383 break;
385 default:
386 return (ENOTTY);
388 #endif /* SUN4 */
390 return (0);
394 * Return the address that would map the given device at the given
395 * offset, allowing for the given protection, or return -1 for error.
397 * The cg8 maps it's overlay plane at 0 for 128K, followed by the
398 * enable plane for 128K, followed by the colour for as long as it
399 * goes. Starting at 8MB, it maps the ramdac for PAGE_SIZE, then the p4
400 * register for PAGE_SIZE, then the bootrom for 0x40000.
402 paddr_t
403 cgeightmmap(dev_t dev, off_t off, int prot)
405 struct cgeight_softc *sc = device_lookup_private(&cgeight_cd,
406 minor(dev));
407 off_t poff;
409 #define START_ENABLE (128*1024)
410 #define START_COLOR ((128*1024) + (128*1024))
411 #define COLOR_SIZE (sc->sc_fb.fb_type.fb_width * \
412 sc->sc_fb.fb_type.fb_height * 3)
413 #define END_COLOR (START_COLOR + COLOR_SIZE)
414 #define START_SPECIAL 0x800000
415 #define PROMSIZE 0x40000
416 #define NOOVERLAY (0x04000000)
418 if (off & PGOFSET)
419 panic("cgeightmap");
421 if (off < 0)
422 return (-1);
423 else if ((u_int)off >= NOOVERLAY) {
424 off -= NOOVERLAY;
427 * X11 maps a huge chunk of the frame buffer; far more than
428 * there really is. We compensate by double-mapping the
429 * first page for as many other pages as it wants
431 while ((u_int)off >= COLOR_SIZE)
432 off -= COLOR_SIZE; /* XXX thorpej ??? */
434 poff = off + PFOUR_COLOR_OFF_COLOR;
435 } else if ((u_int)off < START_ENABLE) {
437 * in overlay plane
439 poff = PFOUR_COLOR_OFF_OVERLAY + off;
440 } else if ((u_int)off < START_COLOR) {
442 * in enable plane
444 poff = (off - START_ENABLE) + PFOUR_COLOR_OFF_ENABLE;
445 } else if ((u_int)off < sc->sc_fb.fb_type.fb_size) {
447 * in colour plane
449 poff = (off - START_COLOR) + PFOUR_COLOR_OFF_COLOR;
450 } else if ((u_int)off < START_SPECIAL) {
452 * hole
454 poff = 0; /* XXX */
455 } else if ((u_int)off == START_SPECIAL) {
457 * colour map (Brooktree)
459 poff = PFOUR_COLOR_OFF_CMAP;
460 } else if ((u_int)off == START_SPECIAL + PAGE_SIZE) {
462 * p4 register
464 poff = 0;
465 } else if ((u_int)off > (START_SPECIAL + (PAGE_SIZE * 2)) &&
466 (u_int) off < (START_SPECIAL + (PAGE_SIZE * 2) + PROMSIZE)) {
468 * rom
470 poff = 0x8000 + (off - (START_SPECIAL + (PAGE_SIZE * 2)));
471 } else
472 return (-1);
474 return (bus_space_mmap(sc->sc_bustag,
475 sc->sc_paddr, poff,
476 prot, BUS_SPACE_MAP_LINEAR));
479 #if defined(SUN4)
481 * Undo the effect of an FBIOSVIDEO that turns the video off.
483 static void
484 cgeightunblank(struct device *dev)
487 cgeight_set_video(device_private(dev), 1);
490 static int
491 cgeight_get_video(struct cgeight_softc *sc)
494 return (fb_pfour_get_video(&sc->sc_fb));
497 static void
498 cgeight_set_video(struct cgeight_softc *sc, int enable)
501 fb_pfour_set_video(&sc->sc_fb, enable);
505 * Load a subset of the current (new) colormap into the Brooktree DAC.
507 static void
508 cgeightloadcmap(struct cgeight_softc *sc, int start, int ncolors)
510 volatile struct bt_regs *bt;
511 u_int *ip;
512 int count;
514 ip = &sc->sc_cmap.cm_chip[BT_D4M3(start)]; /* start/4 * 3 */
515 count = BT_D4M3(start + ncolors - 1) - BT_D4M3(start) + 3;
516 bt = &sc->sc_fbc->fbc_dac;
517 bt->bt_addr = BT_D4M4(start);
518 while (--count >= 0)
519 bt->bt_cmap = *ip++;
521 #endif /* SUN4 */