xref: /freebsd/sys/dev/vt/hw/fb/vt_fb.c (revision f0cfa1b168014f56c02b83e5f28412cc5f78d117) 
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2013 The FreeBSD Foundation
5  * All rights reserved.
6  *
7  * This software was developed by Aleksandr Rybalko under sponsorship from the
8  * FreeBSD Foundation.
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 AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/malloc.h>
38 #include <sys/queue.h>
39 #include <sys/fbio.h>
40 #include <dev/vt/vt.h>
41 #include <dev/vt/hw/fb/vt_fb.h>
42 #include <dev/vt/colors/vt_termcolors.h>
43 
44 #include <vm/vm.h>
45 #include <vm/pmap.h>
46 
47 static struct vt_driver vt_fb_driver = {
48 	.vd_name = "fb",
49 	.vd_init = vt_fb_init,
50 	.vd_fini = vt_fb_fini,
51 	.vd_blank = vt_fb_blank,
52 	.vd_bitblt_text = vt_fb_bitblt_text,
53 	.vd_bitblt_bmp = vt_fb_bitblt_bitmap,
54 	.vd_drawrect = vt_fb_drawrect,
55 	.vd_setpixel = vt_fb_setpixel,
56 	.vd_postswitch = vt_fb_postswitch,
57 	.vd_priority = VD_PRIORITY_GENERIC+10,
58 	.vd_fb_ioctl = vt_fb_ioctl,
59 	.vd_fb_mmap = vt_fb_mmap,
60 	.vd_suspend = vt_fb_suspend,
61 	.vd_resume = vt_fb_resume,
62 };
63 
64 VT_DRIVER_DECLARE(vt_fb, vt_fb_driver);
65 
66 static void
67 vt_fb_mem_wr1(struct fb_info *sc, uint32_t o, uint8_t v)
68 {
69 
70 	KASSERT((o < sc->fb_size), ("Offset %#08x out of fb size", o));
71 	*(uint8_t *)(sc->fb_vbase + o) = v;
72 }
73 
74 static void
75 vt_fb_mem_wr2(struct fb_info *sc, uint32_t o, uint16_t v)
76 {
77 
78 	KASSERT((o < sc->fb_size), ("Offset %#08x out of fb size", o));
79 	*(uint16_t *)(sc->fb_vbase + o) = v;
80 }
81 
82 static void
83 vt_fb_mem_wr4(struct fb_info *sc, uint32_t o, uint32_t v)
84 {
85 
86 	KASSERT((o < sc->fb_size), ("Offset %#08x out of fb size", o));
87 	*(uint32_t *)(sc->fb_vbase + o) = v;
88 }
89 
90 int
91 vt_fb_ioctl(struct vt_device *vd, u_long cmd, caddr_t data, struct thread *td)
92 {
93 	struct fb_info *info;
94 	int error = 0;
95 
96 	info = vd->vd_softc;
97 
98 	switch (cmd) {
99 	case FBIOGTYPE:
100 		bcopy(info, (struct fbtype *)data, sizeof(struct fbtype));
101 		break;
102 
103 	case FBIO_GETWINORG:	/* get frame buffer window origin */
104 		*(u_int *)data = 0;
105 		break;
106 
107 	case FBIO_GETDISPSTART:	/* get display start address */
108 		((video_display_start_t *)data)->x = 0;
109 		((video_display_start_t *)data)->y = 0;
110 		break;
111 
112 	case FBIO_GETLINEWIDTH:	/* get scan line width in bytes */
113 		*(u_int *)data = info->fb_stride;
114 		break;
115 
116 	case FBIO_BLANK:	/* blank display */
117 		if (vd->vd_driver->vd_blank == NULL)
118 			return (ENODEV);
119 		vd->vd_driver->vd_blank(vd, TC_BLACK);
120 		break;
121 
122 	default:
123 		error = ENOIOCTL;
124 		break;
125 	}
126 
127 	return (error);
128 }
129 
130 int
131 vt_fb_mmap(struct vt_device *vd, vm_ooffset_t offset, vm_paddr_t *paddr,
132     int prot, vm_memattr_t *memattr)
133 {
134 	struct fb_info *info;
135 
136 	info = vd->vd_softc;
137 
138 	if (info->fb_flags & FB_FLAG_NOMMAP)
139 		return (ENODEV);
140 
141 	if (offset >= 0 && offset < info->fb_size) {
142 		if (info->fb_pbase == 0) {
143 			*paddr = vtophys((uint8_t *)info->fb_vbase + offset);
144 		} else {
145 			*paddr = info->fb_pbase + offset;
146 #ifdef VM_MEMATTR_WRITE_COMBINING
147 			*memattr = VM_MEMATTR_WRITE_COMBINING;
148 #endif
149 		}
150 		return (0);
151 	}
152 
153 	return (EINVAL);
154 }
155 
156 void
157 vt_fb_setpixel(struct vt_device *vd, int x, int y, term_color_t color)
158 {
159 	struct fb_info *info;
160 	uint32_t c;
161 	u_int o;
162 
163 	info = vd->vd_softc;
164 	c = info->fb_cmap[color];
165 	o = info->fb_stride * y + x * FBTYPE_GET_BYTESPP(info);
166 
167 	if (info->fb_flags & FB_FLAG_NOWRITE)
168 		return;
169 
170 	KASSERT((info->fb_vbase != 0), ("Unmapped framebuffer"));
171 
172 	switch (FBTYPE_GET_BYTESPP(info)) {
173 	case 1:
174 		vt_fb_mem_wr1(info, o, c);
175 		break;
176 	case 2:
177 		vt_fb_mem_wr2(info, o, c);
178 		break;
179 	case 3:
180 		vt_fb_mem_wr1(info, o, (c >> 16) & 0xff);
181 		vt_fb_mem_wr1(info, o + 1, (c >> 8) & 0xff);
182 		vt_fb_mem_wr1(info, o + 2, c & 0xff);
183 		break;
184 	case 4:
185 		vt_fb_mem_wr4(info, o, c);
186 		break;
187 	default:
188 		/* panic? */
189 		return;
190 	}
191 }
192 
193 void
194 vt_fb_drawrect(struct vt_device *vd, int x1, int y1, int x2, int y2, int fill,
195     term_color_t color)
196 {
197 	int x, y;
198 
199 	for (y = y1; y <= y2; y++) {
200 		if (fill || (y == y1) || (y == y2)) {
201 			for (x = x1; x <= x2; x++)
202 				vt_fb_setpixel(vd, x, y, color);
203 		} else {
204 			vt_fb_setpixel(vd, x1, y, color);
205 			vt_fb_setpixel(vd, x2, y, color);
206 		}
207 	}
208 }
209 
210 void
211 vt_fb_blank(struct vt_device *vd, term_color_t color)
212 {
213 	struct fb_info *info;
214 	uint32_t c;
215 	u_int o, h;
216 
217 	info = vd->vd_softc;
218 	c = info->fb_cmap[color];
219 
220 	if (info->fb_flags & FB_FLAG_NOWRITE)
221 		return;
222 
223 	KASSERT((info->fb_vbase != 0), ("Unmapped framebuffer"));
224 
225 	switch (FBTYPE_GET_BYTESPP(info)) {
226 	case 1:
227 		for (h = 0; h < info->fb_height; h++)
228 			for (o = 0; o < info->fb_stride; o++)
229 				vt_fb_mem_wr1(info, h*info->fb_stride + o, c);
230 		break;
231 	case 2:
232 		for (h = 0; h < info->fb_height; h++)
233 			for (o = 0; o < info->fb_stride; o += 2)
234 				vt_fb_mem_wr2(info, h*info->fb_stride + o, c);
235 		break;
236 	case 3:
237 		for (h = 0; h < info->fb_height; h++)
238 			for (o = 0; o < info->fb_stride; o += 3) {
239 				vt_fb_mem_wr1(info, h*info->fb_stride + o,
240 				    (c >> 16) & 0xff);
241 				vt_fb_mem_wr1(info, h*info->fb_stride + o + 1,
242 				    (c >> 8) & 0xff);
243 				vt_fb_mem_wr1(info, h*info->fb_stride + o + 2,
244 				    c & 0xff);
245 			}
246 		break;
247 	case 4:
248 		for (h = 0; h < info->fb_height; h++)
249 			for (o = 0; o < info->fb_stride; o += 4)
250 				vt_fb_mem_wr4(info, h*info->fb_stride + o, c);
251 		break;
252 	default:
253 		/* panic? */
254 		return;
255 	}
256 }
257 
258 void
259 vt_fb_bitblt_bitmap(struct vt_device *vd, const struct vt_window *vw,
260     const uint8_t *pattern, const uint8_t *mask,
261     unsigned int width, unsigned int height,
262     unsigned int x, unsigned int y, term_color_t fg, term_color_t bg)
263 {
264 	struct fb_info *info;
265 	uint32_t fgc, bgc, cc, o;
266 	int bpp, bpl, xi, yi;
267 	int bit, byte;
268 
269 	info = vd->vd_softc;
270 	bpp = FBTYPE_GET_BYTESPP(info);
271 	fgc = info->fb_cmap[fg];
272 	bgc = info->fb_cmap[bg];
273 	bpl = (width + 7) / 8; /* Bytes per source line. */
274 
275 	if (info->fb_flags & FB_FLAG_NOWRITE)
276 		return;
277 
278 	KASSERT((info->fb_vbase != 0), ("Unmapped framebuffer"));
279 
280 	/* Bound by right and bottom edges. */
281 	if (y + height > vw->vw_draw_area.tr_end.tp_row) {
282 		if (y >= vw->vw_draw_area.tr_end.tp_row)
283 			return;
284 		height = vw->vw_draw_area.tr_end.tp_row - y;
285 	}
286 	if (x + width > vw->vw_draw_area.tr_end.tp_col) {
287 		if (x >= vw->vw_draw_area.tr_end.tp_col)
288 			return;
289 		width = vw->vw_draw_area.tr_end.tp_col - x;
290 	}
291 	for (yi = 0; yi < height; yi++) {
292 		for (xi = 0; xi < width; xi++) {
293 			byte = yi * bpl + xi / 8;
294 			bit = 0x80 >> (xi % 8);
295 			/* Skip pixel write, if mask bit not set. */
296 			if (mask != NULL && (mask[byte] & bit) == 0)
297 				continue;
298 			o = (y + yi) * info->fb_stride + (x + xi) * bpp;
299 			o += vd->vd_transpose;
300 			cc = pattern[byte] & bit ? fgc : bgc;
301 
302 			switch(bpp) {
303 			case 1:
304 				vt_fb_mem_wr1(info, o, cc);
305 				break;
306 			case 2:
307 				vt_fb_mem_wr2(info, o, cc);
308 				break;
309 			case 3:
310 				/* Packed mode, so unaligned. Byte access. */
311 				vt_fb_mem_wr1(info, o, (cc >> 16) & 0xff);
312 				vt_fb_mem_wr1(info, o + 1, (cc >> 8) & 0xff);
313 				vt_fb_mem_wr1(info, o + 2, cc & 0xff);
314 				break;
315 			case 4:
316 				vt_fb_mem_wr4(info, o, cc);
317 				break;
318 			default:
319 				/* panic? */
320 				break;
321 			}
322 		}
323 	}
324 }
325 
326 void
327 vt_fb_bitblt_text(struct vt_device *vd, const struct vt_window *vw,
328     const term_rect_t *area)
329 {
330 	unsigned int col, row, x, y;
331 	struct vt_font *vf;
332 	term_char_t c;
333 	term_color_t fg, bg;
334 	const uint8_t *pattern;
335 
336 	vf = vw->vw_font;
337 
338 	for (row = area->tr_begin.tp_row; row < area->tr_end.tp_row; ++row) {
339 		for (col = area->tr_begin.tp_col; col < area->tr_end.tp_col;
340 		    ++col) {
341 			x = col * vf->vf_width +
342 			    vw->vw_draw_area.tr_begin.tp_col;
343 			y = row * vf->vf_height +
344 			    vw->vw_draw_area.tr_begin.tp_row;
345 
346 			c = VTBUF_GET_FIELD(&vw->vw_buf, row, col);
347 			pattern = vtfont_lookup(vf, c);
348 			vt_determine_colors(c,
349 			    VTBUF_ISCURSOR(&vw->vw_buf, row, col), &fg, &bg);
350 
351 			vt_fb_bitblt_bitmap(vd, vw,
352 			    pattern, NULL, vf->vf_width, vf->vf_height,
353 			    x, y, fg, bg);
354 		}
355 	}
356 
357 #ifndef SC_NO_CUTPASTE
358 	if (!vd->vd_mshown)
359 		return;
360 
361 	term_rect_t drawn_area;
362 
363 	drawn_area.tr_begin.tp_col = area->tr_begin.tp_col * vf->vf_width;
364 	drawn_area.tr_begin.tp_row = area->tr_begin.tp_row * vf->vf_height;
365 	drawn_area.tr_end.tp_col = area->tr_end.tp_col * vf->vf_width;
366 	drawn_area.tr_end.tp_row = area->tr_end.tp_row * vf->vf_height;
367 
368 	if (vt_is_cursor_in_area(vd, &drawn_area)) {
369 		vt_fb_bitblt_bitmap(vd, vw,
370 		    vd->vd_mcursor->map, vd->vd_mcursor->mask,
371 		    vd->vd_mcursor->width, vd->vd_mcursor->height,
372 		    vd->vd_mx_drawn + vw->vw_draw_area.tr_begin.tp_col,
373 		    vd->vd_my_drawn + vw->vw_draw_area.tr_begin.tp_row,
374 		    vd->vd_mcursor_fg, vd->vd_mcursor_bg);
375 	}
376 #endif
377 }
378 
379 void
380 vt_fb_postswitch(struct vt_device *vd)
381 {
382 	struct fb_info *info;
383 
384 	info = vd->vd_softc;
385 
386 	if (info->enter != NULL)
387 		info->enter(info->fb_priv);
388 }
389 
390 static int
391 vt_fb_init_cmap(uint32_t *cmap, int depth)
392 {
393 
394 	switch (depth) {
395 	case 8:
396 		return (vt_generate_cons_palette(cmap, COLOR_FORMAT_RGB,
397 		    0x7, 5, 0x7, 2, 0x3, 0));
398 	case 15:
399 		return (vt_generate_cons_palette(cmap, COLOR_FORMAT_RGB,
400 		    0x1f, 10, 0x1f, 5, 0x1f, 0));
401 	case 16:
402 		return (vt_generate_cons_palette(cmap, COLOR_FORMAT_RGB,
403 		    0x1f, 11, 0x3f, 5, 0x1f, 0));
404 	case 24:
405 	case 32: /* Ignore alpha. */
406 		return (vt_generate_cons_palette(cmap, COLOR_FORMAT_RGB,
407 		    0xff, 16, 0xff, 8, 0xff, 0));
408 	default:
409 		return (1);
410 	}
411 }
412 
413 int
414 vt_fb_init(struct vt_device *vd)
415 {
416 	struct fb_info *info;
417 	u_int margin;
418 	int err;
419 
420 	info = vd->vd_softc;
421 	vd->vd_height = MIN(VT_FB_MAX_HEIGHT, info->fb_height);
422 	margin = (info->fb_height - vd->vd_height) >> 1;
423 	vd->vd_transpose = margin * info->fb_stride;
424 	vd->vd_width = MIN(VT_FB_MAX_WIDTH, info->fb_width);
425 	margin = (info->fb_width - vd->vd_width) >> 1;
426 	vd->vd_transpose += margin * (info->fb_bpp / NBBY);
427 	vd->vd_video_dev = info->fb_video_dev;
428 
429 	if (info->fb_size == 0)
430 		return (CN_DEAD);
431 
432 	if (info->fb_pbase == 0 && info->fb_vbase == 0)
433 		info->fb_flags |= FB_FLAG_NOMMAP;
434 
435 	if (info->fb_cmsize <= 0) {
436 		err = vt_fb_init_cmap(info->fb_cmap, FBTYPE_GET_BPP(info));
437 		if (err)
438 			return (CN_DEAD);
439 		info->fb_cmsize = 16;
440 	}
441 
442 	/* Clear the screen. */
443 	vd->vd_driver->vd_blank(vd, TC_BLACK);
444 
445 	/* Wakeup screen. KMS need this. */
446 	vt_fb_postswitch(vd);
447 
448 	return (CN_INTERNAL);
449 }
450 
451 void
452 vt_fb_fini(struct vt_device *vd, void *softc)
453 {
454 
455 	vd->vd_video_dev = NULL;
456 }
457 
458 int
459 vt_fb_attach(struct fb_info *info)
460 {
461 
462 	vt_allocate(&vt_fb_driver, info);
463 
464 	return (0);
465 }
466 
467 int
468 vt_fb_detach(struct fb_info *info)
469 {
470 
471 	vt_deallocate(&vt_fb_driver, info);
472 
473 	return (0);
474 }
475 
476 void
477 vt_fb_suspend(struct vt_device *vd)
478 {
479 
480 	vt_suspend(vd);
481 }
482 
483 void
484 vt_fb_resume(struct vt_device *vd)
485 {
486 
487 	vt_resume(vd);
488 }
489