2 * Copyright (c) 2003 Peter Grehan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/module.h>
34 #include <sys/kernel.h>
35 #include <sys/sysctl.h>
36 #include <sys/limits.h>
40 #include <sys/fcntl.h>
41 #include <sys/malloc.h>
43 #include <sys/consio.h>
45 #include <machine/bus.h>
46 #include <machine/sc_machdep.h>
50 #include <dev/fb/fbreg.h>
51 #include <dev/syscons/syscons.h>
53 #include <dev/ofw/openfirm.h>
54 #include <dev/ofw/ofw_pci.h>
55 #include <powerpc/ofw/ofw_syscons.h>
56 #include <machine/nexusvar.h>
58 static int ofwfb_ignore_mmap_checks;
59 SYSCTL_NODE(_hw, OID_AUTO, ofwfb, CTLFLAG_RD, 0, "ofwfb");
60 SYSCTL_INT(_hw_ofwfb, OID_AUTO, relax_mmap, CTLFLAG_RW,
61 &ofwfb_ignore_mmap_checks, 0, "relax mmap bounds checking");
63 extern u_char dflt_font_16[];
64 extern u_char dflt_font_14[];
65 extern u_char dflt_font_8[];
67 static int ofwfb_configure(int flags);
69 static vi_probe_t ofwfb_probe;
70 static vi_init_t ofwfb_init;
71 static vi_get_info_t ofwfb_get_info;
72 static vi_query_mode_t ofwfb_query_mode;
73 static vi_set_mode_t ofwfb_set_mode;
74 static vi_save_font_t ofwfb_save_font;
75 static vi_load_font_t ofwfb_load_font;
76 static vi_show_font_t ofwfb_show_font;
77 static vi_save_palette_t ofwfb_save_palette;
78 static vi_load_palette_t ofwfb_load_palette;
79 static vi_set_border_t ofwfb_set_border;
80 static vi_save_state_t ofwfb_save_state;
81 static vi_load_state_t ofwfb_load_state;
82 static vi_set_win_org_t ofwfb_set_win_org;
83 static vi_read_hw_cursor_t ofwfb_read_hw_cursor;
84 static vi_set_hw_cursor_t ofwfb_set_hw_cursor;
85 static vi_set_hw_cursor_shape_t ofwfb_set_hw_cursor_shape;
86 static vi_blank_display_t ofwfb_blank_display;
87 static vi_mmap_t ofwfb_mmap;
88 static vi_ioctl_t ofwfb_ioctl;
89 static vi_clear_t ofwfb_clear;
90 static vi_fill_rect_t ofwfb_fill_rect;
91 static vi_bitblt_t ofwfb_bitblt;
92 static vi_diag_t ofwfb_diag;
93 static vi_save_cursor_palette_t ofwfb_save_cursor_palette;
94 static vi_load_cursor_palette_t ofwfb_load_cursor_palette;
95 static vi_copy_t ofwfb_copy;
96 static vi_putp_t ofwfb_putp;
97 static vi_putc_t ofwfb_putc;
98 static vi_puts_t ofwfb_puts;
99 static vi_putm_t ofwfb_putm;
101 static video_switch_t ofwfbvidsw = {
102 .probe = ofwfb_probe,
104 .get_info = ofwfb_get_info,
105 .query_mode = ofwfb_query_mode,
106 .set_mode = ofwfb_set_mode,
107 .save_font = ofwfb_save_font,
108 .load_font = ofwfb_load_font,
109 .show_font = ofwfb_show_font,
110 .save_palette = ofwfb_save_palette,
111 .load_palette = ofwfb_load_palette,
112 .set_border = ofwfb_set_border,
113 .save_state = ofwfb_save_state,
114 .load_state = ofwfb_load_state,
115 .set_win_org = ofwfb_set_win_org,
116 .read_hw_cursor = ofwfb_read_hw_cursor,
117 .set_hw_cursor = ofwfb_set_hw_cursor,
118 .set_hw_cursor_shape = ofwfb_set_hw_cursor_shape,
119 .blank_display = ofwfb_blank_display,
121 .ioctl = ofwfb_ioctl,
122 .clear = ofwfb_clear,
123 .fill_rect = ofwfb_fill_rect,
124 .bitblt = ofwfb_bitblt,
126 .save_cursor_palette = ofwfb_save_cursor_palette,
127 .load_cursor_palette = ofwfb_load_cursor_palette,
136 * bitmap depth-specific routines
138 static vi_blank_display_t ofwfb_blank_display8;
139 static vi_putc_t ofwfb_putc8;
140 static vi_set_border_t ofwfb_set_border8;
142 static vi_blank_display_t ofwfb_blank_display32;
143 static vi_putc_t ofwfb_putc32;
144 static vi_set_border_t ofwfb_set_border32;
146 VIDEO_DRIVER(ofwfb, ofwfbvidsw, ofwfb_configure);
148 extern sc_rndr_sw_t txtrndrsw;
149 RENDERER(ofwfb, 0, txtrndrsw, gfb_set);
151 RENDERER_MODULE(ofwfb, gfb_set);
154 * Define the iso6429-1983 colormap
160 } ofwfb_cmap[16] = { /* # R G B Color */
162 { 0x00, 0x00, 0x00 }, /* 0 0 0 0 Black */
163 { 0x00, 0x00, 0xaa }, /* 1 0 0 2/3 Blue */
164 { 0x00, 0xaa, 0x00 }, /* 2 0 2/3 0 Green */
165 { 0x00, 0xaa, 0xaa }, /* 3 0 2/3 2/3 Cyan */
166 { 0xaa, 0x00, 0x00 }, /* 4 2/3 0 0 Red */
167 { 0xaa, 0x00, 0xaa }, /* 5 2/3 0 2/3 Magenta */
168 { 0xaa, 0x55, 0x00 }, /* 6 2/3 1/3 0 Brown */
169 { 0xaa, 0xaa, 0xaa }, /* 7 2/3 2/3 2/3 White */
170 { 0x55, 0x55, 0x55 }, /* 8 1/3 1/3 1/3 Gray */
171 { 0x55, 0x55, 0xff }, /* 9 1/3 1/3 1 Bright Blue */
172 { 0x55, 0xff, 0x55 }, /* 10 1/3 1 1/3 Bright Green */
173 { 0x55, 0xff, 0xff }, /* 11 1/3 1 1 Bright Cyan */
174 { 0xff, 0x55, 0x55 }, /* 12 1 1/3 1/3 Bright Red */
175 { 0xff, 0x55, 0xff }, /* 13 1 1/3 1 Bright Magenta */
176 { 0xff, 0xff, 0x80 }, /* 14 1 1 1/3 Bright Yellow */
177 { 0xff, 0xff, 0xff } /* 15 1 1 1 Bright White */
180 #define TODO printf("%s: unimplemented\n", __func__)
182 static u_int16_t ofwfb_static_window[ROW*COL];
184 static struct ofwfb_softc ofwfb_softc;
187 ofwfb_background(uint8_t attr)
193 ofwfb_foreground(uint8_t attr)
195 return (attr & 0x0f);
199 ofwfb_pix32(int attr)
203 retval = (ofwfb_cmap[attr].blue << 16) |
204 (ofwfb_cmap[attr].green << 8) |
205 ofwfb_cmap[attr].red;
211 ofwfb_configure(int flags)
213 struct ofwfb_softc *sc;
224 TUNABLE_INT_FETCH("hw.syscons.disable", &disable);
234 chosen = OF_finddevice("/chosen");
235 OF_getprop(chosen, "stdout", &stdout, sizeof(stdout));
236 node = OF_instance_to_package(stdout);
237 OF_getprop(node, "device_type", type, sizeof(type));
238 if (strcmp(type, "display") != 0)
241 /* Only support 8 and 32-bit framebuffers */
242 OF_getprop(node, "depth", &depth, sizeof(depth));
244 sc->sc_blank = ofwfb_blank_display8;
245 sc->sc_putc = ofwfb_putc8;
246 sc->sc_set_border = ofwfb_set_border8;
247 } else if (depth == 32) {
248 sc->sc_blank = ofwfb_blank_display32;
249 sc->sc_putc = ofwfb_putc32;
250 sc->sc_set_border = ofwfb_set_border32;
254 sc->sc_depth = depth;
257 OF_getprop(node, "height", &sc->sc_height, sizeof(sc->sc_height));
258 OF_getprop(node, "width", &sc->sc_width, sizeof(sc->sc_width));
259 OF_getprop(node, "linebytes", &sc->sc_stride, sizeof(sc->sc_stride));
262 * XXX the physical address of the frame buffer is assumed to be
263 * BAT-mapped so it can be accessed directly
265 OF_getprop(node, "address", &sc->sc_addr, sizeof(sc->sc_addr));
268 * Get the PCI addresses of the adapter. The node may be the
269 * child of the PCI device: in that case, try the parent for
270 * the assigned-addresses property.
272 len = OF_getprop(node, "assigned-addresses", sc->sc_pciaddrs,
273 sizeof(sc->sc_pciaddrs));
275 len = OF_getprop(OF_parent(node), "assigned-addresses", sc->sc_pciaddrs,
276 sizeof(sc->sc_pciaddrs));
280 sc->sc_num_pciaddrs = len / sizeof(struct ofw_pci_register);
283 ofwfb_init(0, &sc->sc_va, 0);
289 ofwfb_probe(int unit, video_adapter_t **adp, void *arg, int flags)
296 ofwfb_init(int unit, video_adapter_t *adp, int flags)
298 struct ofwfb_softc *sc;
307 sc = (struct ofwfb_softc *)adp;
310 vid_init_struct(adp, "ofwfb", -1, unit);
312 if (sc->sc_depth == 8) {
314 * Install the ISO6429 colormap - older OFW systems
315 * don't do this by default
317 memset(name, 0, sizeof(name));
318 OF_package_to_path(sc->sc_node, name, sizeof(name));
320 for (i = 0; i < 16; i++) {
321 OF_call_method("color!", ih, 4, 1,
330 /* The default font size can be overridden by loader */
332 TUNABLE_INT_FETCH("hw.syscons.fsize", &font_height);
333 if (font_height == 8) {
334 sc->sc_font = dflt_font_8;
335 sc->sc_font_height = 8;
336 } else if (font_height == 14) {
337 sc->sc_font = dflt_font_14;
338 sc->sc_font_height = 14;
340 /* default is 8x16 */
341 sc->sc_font = dflt_font_16;
342 sc->sc_font_height = 16;
345 /* The user can set a border in chars - default is 1 char width */
347 TUNABLE_INT_FETCH("hw.syscons.border", &cborder);
349 vi->vi_cheight = sc->sc_font_height;
350 vi->vi_width = sc->sc_width/8 - 2*cborder;
351 vi->vi_height = sc->sc_height/sc->sc_font_height - 2*cborder;
355 * Clamp width/height to syscons maximums
357 if (vi->vi_width > COL)
359 if (vi->vi_height > ROW)
362 sc->sc_xmargin = (sc->sc_width - (vi->vi_width * vi->vi_cwidth)) / 2;
363 sc->sc_ymargin = (sc->sc_height - (vi->vi_height * vi->vi_cheight))/2;
366 * Avoid huge amounts of conditional code in syscons by
367 * defining a dummy h/w text display buffer.
369 adp->va_window = (vm_offset_t) ofwfb_static_window;
371 /* Enable future font-loading and flag color support */
372 adp->va_flags |= V_ADP_FONT | V_ADP_COLOR;
374 ofwfb_blank_display(&sc->sc_va, V_DISPLAY_ON);
376 ofwfb_set_mode(&sc->sc_va, 0);
378 vid_register(&sc->sc_va);
384 ofwfb_get_info(video_adapter_t *adp, int mode, video_info_t *info)
386 bcopy(&adp->va_info, info, sizeof(*info));
391 ofwfb_query_mode(video_adapter_t *adp, video_info_t *info)
398 ofwfb_set_mode(video_adapter_t *adp, int mode)
405 ofwfb_save_font(video_adapter_t *adp, int page, int size, int width,
406 u_char *data, int c, int count)
413 ofwfb_load_font(video_adapter_t *adp, int page, int size, int width,
414 u_char *data, int c, int count)
416 struct ofwfb_softc *sc;
418 sc = (struct ofwfb_softc *)adp;
421 * syscons code has already determined that current width/height
422 * are unchanged for this new font
429 ofwfb_show_font(video_adapter_t *adp, int page)
436 ofwfb_save_palette(video_adapter_t *adp, u_char *palette)
443 ofwfb_load_palette(video_adapter_t *adp, u_char *palette)
450 ofwfb_set_border8(video_adapter_t *adp, int border)
452 struct ofwfb_softc *sc;
457 sc = (struct ofwfb_softc *)adp;
459 bground = ofwfb_background(border);
462 addr = (uint8_t *) sc->sc_addr;
463 for (i = 0; i < sc->sc_ymargin; i++) {
464 for (j = 0; j < sc->sc_width; j++) {
465 *(addr + j) = bground;
467 addr += sc->sc_stride;
471 addr = (uint8_t *) sc->sc_addr + (sc->sc_height - sc->sc_ymargin)*sc->sc_stride;
472 for (i = 0; i < sc->sc_ymargin; i++) {
473 for (j = 0; j < sc->sc_width; j++) {
474 *(addr + j) = bground;
476 addr += sc->sc_stride;
479 /* remaining left and right borders */
480 addr = (uint8_t *) sc->sc_addr + sc->sc_ymargin*sc->sc_stride;
481 for (i = 0; i < sc->sc_height - 2*sc->sc_xmargin; i++) {
482 for (j = 0; j < sc->sc_xmargin; j++) {
483 *(addr + j) = bground;
484 *(addr + j + sc->sc_width - sc->sc_xmargin) = bground;
486 addr += sc->sc_stride;
493 ofwfb_set_border32(video_adapter_t *adp, int border)
495 /* XXX Be lazy for now and blank entire screen */
496 return (ofwfb_blank_display32(adp, border));
500 ofwfb_set_border(video_adapter_t *adp, int border)
502 struct ofwfb_softc *sc;
504 sc = (struct ofwfb_softc *)adp;
506 return ((*sc->sc_set_border)(adp, border));
510 ofwfb_save_state(video_adapter_t *adp, void *p, size_t size)
517 ofwfb_load_state(video_adapter_t *adp, void *p)
524 ofwfb_set_win_org(video_adapter_t *adp, off_t offset)
531 ofwfb_read_hw_cursor(video_adapter_t *adp, int *col, int *row)
540 ofwfb_set_hw_cursor(video_adapter_t *adp, int col, int row)
547 ofwfb_set_hw_cursor_shape(video_adapter_t *adp, int base, int height,
548 int celsize, int blink)
554 ofwfb_blank_display8(video_adapter_t *adp, int mode)
556 struct ofwfb_softc *sc;
560 sc = (struct ofwfb_softc *)adp;
561 addr = (uint8_t *) sc->sc_addr;
563 /* Could be done a lot faster e.g. 32-bits, or Altivec'd */
564 for (i = 0; i < sc->sc_stride*sc->sc_height; i++)
565 *(addr + i) = ofwfb_background(SC_NORM_ATTR);
571 ofwfb_blank_display32(video_adapter_t *adp, int mode)
573 struct ofwfb_softc *sc;
577 sc = (struct ofwfb_softc *)adp;
578 addr = (uint32_t *) sc->sc_addr;
580 for (i = 0; i < (sc->sc_stride/4)*sc->sc_height; i++)
581 *(addr + i) = ofwfb_pix32(ofwfb_background(SC_NORM_ATTR));
587 ofwfb_blank_display(video_adapter_t *adp, int mode)
589 struct ofwfb_softc *sc;
591 sc = (struct ofwfb_softc *)adp;
593 return ((*sc->sc_blank)(adp, mode));
597 ofwfb_mmap(video_adapter_t *adp, vm_offset_t offset, vm_paddr_t *paddr,
600 struct ofwfb_softc *sc;
603 sc = (struct ofwfb_softc *)adp;
605 if (sc->sc_num_pciaddrs == 0)
611 if (ofwfb_ignore_mmap_checks) {
617 * Make sure the requested address lies within the PCI device's assigned addrs
619 for (i = 0; i < sc->sc_num_pciaddrs; i++)
620 if (offset >= sc->sc_pciaddrs[i].phys_lo &&
621 offset < (sc->sc_pciaddrs[i].phys_lo + sc->sc_pciaddrs[i].size_lo)) {
627 * This might be a legacy VGA mem request: if so, just point it at the
628 * framebuffer, since it shouldn't be touched
630 if (offset < sc->sc_stride*sc->sc_height) {
631 *paddr = sc->sc_addr + offset;
639 ofwfb_ioctl(video_adapter_t *adp, u_long cmd, caddr_t data)
646 ofwfb_clear(video_adapter_t *adp)
653 ofwfb_fill_rect(video_adapter_t *adp, int val, int x, int y, int cx, int cy)
660 ofwfb_bitblt(video_adapter_t *adp, ...)
667 ofwfb_diag(video_adapter_t *adp, int level)
674 ofwfb_save_cursor_palette(video_adapter_t *adp, u_char *palette)
681 ofwfb_load_cursor_palette(video_adapter_t *adp, u_char *palette)
688 ofwfb_copy(video_adapter_t *adp, vm_offset_t src, vm_offset_t dst, int n)
695 ofwfb_putp(video_adapter_t *adp, vm_offset_t off, uint32_t p, uint32_t a,
696 int size, int bpp, int bit_ltor, int byte_ltor)
703 ofwfb_putc8(video_adapter_t *adp, vm_offset_t off, uint8_t c, uint8_t a)
705 struct ofwfb_softc *sc;
717 sc = (struct ofwfb_softc *)adp;
718 row = (off / adp->va_info.vi_width) * adp->va_info.vi_cheight;
719 col = (off % adp->va_info.vi_width) * adp->va_info.vi_cwidth;
720 p = sc->sc_font + c*sc->sc_font_height;
721 addr = (u_int32_t *)((int)sc->sc_addr
722 + (row + sc->sc_ymargin)*sc->sc_stride
723 + col + sc->sc_xmargin);
725 fg = ofwfb_foreground(a);
726 bg = ofwfb_background(a);
728 for (i = 0; i < sc->sc_font_height; i++) {
732 * Assume that there is more background than foreground
733 * in characters and init accordingly
735 ch1.l = ch2.l = (bg << 24) | (bg << 16) | (bg << 8) | bg;
738 * Calculate 2 x 4-chars at a time, and then
741 if (fline & 0x80) ch1.c[0] = fg;
742 if (fline & 0x40) ch1.c[1] = fg;
743 if (fline & 0x20) ch1.c[2] = fg;
744 if (fline & 0x10) ch1.c[3] = fg;
746 if (fline & 0x08) ch2.c[0] = fg;
747 if (fline & 0x04) ch2.c[1] = fg;
748 if (fline & 0x02) ch2.c[2] = fg;
749 if (fline & 0x01) ch2.c[3] = fg;
753 addr += (sc->sc_stride / sizeof(u_int32_t));
760 ofwfb_putc32(video_adapter_t *adp, vm_offset_t off, uint8_t c, uint8_t a)
762 struct ofwfb_softc *sc;
769 sc = (struct ofwfb_softc *)adp;
770 row = (off / adp->va_info.vi_width) * adp->va_info.vi_cheight;
771 col = (off % adp->va_info.vi_width) * adp->va_info.vi_cwidth;
772 p = sc->sc_font + c*sc->sc_font_height;
773 addr = (uint32_t *)sc->sc_addr
774 + (row + sc->sc_ymargin)*(sc->sc_stride/4)
775 + col + sc->sc_xmargin;
777 for (i = 0; i < sc->sc_font_height; i++) {
778 for (j = 0, k = 7; j < 8; j++, k--) {
779 if ((p[i] & (1 << k)) == 0)
780 *(addr + j) = ofwfb_pix32(ofwfb_background(a));
782 *(addr + j) = ofwfb_pix32(ofwfb_foreground(a));
784 addr += (sc->sc_stride/4);
791 ofwfb_putc(video_adapter_t *adp, vm_offset_t off, uint8_t c, uint8_t a)
793 struct ofwfb_softc *sc;
795 sc = (struct ofwfb_softc *)adp;
797 return ((*sc->sc_putc)(adp, off, c, a));
801 ofwfb_puts(video_adapter_t *adp, vm_offset_t off, u_int16_t *s, int len)
805 for (i = 0; i < len; i++) {
806 ofwfb_putc(adp, off + i, s[i] & 0xff, (s[i] & 0xff00) >> 8);
812 ofwfb_putm(video_adapter_t *adp, int x, int y, uint8_t *pixel_image,
813 uint32_t pixel_mask, int size, int width)
815 struct ofwfb_softc *sc;
817 sc = (struct ofwfb_softc *)adp;
825 * Define the syscons nexus device attachment
828 ofwfb_scidentify(driver_t *driver, device_t parent)
833 * Add with a priority guaranteed to make it last on
836 child = BUS_ADD_CHILD(parent, INT_MAX, SC_DRIVER_NAME, 0);
838 nexus_set_device_type(child, "syscons");
842 ofwfb_scprobe(device_t dev)
846 name = nexus_get_name(dev);
847 if (strcmp(SC_DRIVER_NAME, name) != 0)
850 device_set_desc(dev, "System console");
851 return (sc_probe_unit(device_get_unit(dev),
852 device_get_flags(dev) | SC_AUTODETECT_KBD));
856 ofwfb_scattach(device_t dev)
858 return (sc_attach_unit(device_get_unit(dev),
859 device_get_flags(dev) | SC_AUTODETECT_KBD));
862 static device_method_t ofwfb_sc_methods[] = {
863 DEVMETHOD(device_identify, ofwfb_scidentify),
864 DEVMETHOD(device_probe, ofwfb_scprobe),
865 DEVMETHOD(device_attach, ofwfb_scattach),
869 static driver_t ofwfb_sc_driver = {
875 static devclass_t sc_devclass;
877 DRIVER_MODULE(sc, nexus, ofwfb_sc_driver, sc_devclass, 0, 0);
880 * Define a stub keyboard driver in case one hasn't been
881 * compiled into the kernel
883 #include <sys/kbio.h>
884 #include <dev/kbd/kbdreg.h>
886 static int dummy_kbd_configure(int flags);
888 keyboard_switch_t dummysw;
891 dummy_kbd_configure(int flags)
896 KEYBOARD_DRIVER(dummy, dummysw, dummy_kbd_configure);
899 * Utility routines from <dev/fb/fbreg.h>
902 ofwfb_bcopy(const void *s, void *d, size_t c)
908 ofwfb_bzero(void *d, size_t c)
914 ofwfb_fillw(int pat, void *base, size_t cnt)
916 u_int16_t *bptr = base;
923 ofwfb_readw(u_int16_t *addr)
929 ofwfb_writew(u_int16_t *addr, u_int16_t val)