2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
5 * Copyright (c) 2012, 2013 The FreeBSD Foundation
8 * Portions of this software were developed by Oleksandr Rybalko
9 * under sponsorship from the FreeBSD Foundation.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <sys/param.h>
37 #include <sys/systm.h>
41 #include <sys/endian.h>
42 #include <sys/kernel.h>
43 #include <sys/kthread.h>
45 #include <sys/malloc.h>
46 #include <sys/module.h>
47 #include <sys/mutex.h>
48 #include <sys/queue.h>
49 #include <sys/resource.h>
52 #include <sys/timetc.h>
54 #include <sys/consio.h>
61 #include <machine/bus.h>
62 #include <machine/fdt.h>
63 #include <machine/resource.h>
64 #include <machine/intr.h>
66 #include <dev/ofw/ofw_bus.h>
67 #include <dev/ofw/ofw_bus_subr.h>
69 #include <dev/fb/fbreg.h>
70 #include <dev/syscons/syscons.h>
72 #include <arm/freescale/imx/imx51_ccmvar.h>
74 #include <arm/freescale/imx/imx51_ipuv3reg.h>
76 #define IMX51_IPU_HSP_CLOCK 665000000
77 #define IPU3FB_FONT_HEIGHT 16
85 bus_space_handle_t ioh;
86 bus_space_handle_t cm_ioh;
87 bus_space_handle_t dp_ioh;
88 bus_space_handle_t di0_ioh;
89 bus_space_handle_t di1_ioh;
90 bus_space_handle_t dctmpl_ioh;
91 bus_space_handle_t dc_ioh;
92 bus_space_handle_t dmfc_ioh;
93 bus_space_handle_t idmac_ioh;
94 bus_space_handle_t cpmem_ioh;
97 struct video_adapter_softc {
98 /* Videoadpater part */
103 unsigned int fb_size;
111 unsigned int xmargin;
112 unsigned int ymargin;
118 static struct ipu3sc_softc *ipu3sc_softc;
119 static struct video_adapter_softc va_softc;
121 /* FIXME: not only 2 bytes color supported */
122 static uint16_t colors[16] = {
128 0xf81f, /* magenta */
130 0xc618, /* light grey */
131 0xc618, /* XXX: dark grey */
132 0x001f, /* XXX: light blue */
133 0x07e0, /* XXX: light green */
134 0x07ff, /* XXX: light cyan */
135 0xf800, /* XXX: light red */
136 0xf81f, /* XXX: light magenta */
140 static uint32_t colors_24[16] = {
146 0x800080,/* Magenta */
148 0xC0C0C0,/* Silver */
150 0x0000FF,/* Light Blue */
151 0x00FF00,/* Light Green */
152 0x00FFFF,/* Light Cyan */
153 0xFF0000,/* Light Red */
154 0xFF00FF,/* Light Magenta */
155 0xFFFF00,/* Yellow */
161 #define IPUV3_READ(ipuv3, module, reg) \
162 bus_space_read_4((ipuv3)->iot, (ipuv3)->module##_ioh, (reg))
163 #define IPUV3_WRITE(ipuv3, module, reg, val) \
164 bus_space_write_4((ipuv3)->iot, (ipuv3)->module##_ioh, (reg), (val))
166 #define CPMEM_CHANNEL_OFFSET(_c) ((_c) * 0x40)
167 #define CPMEM_WORD_OFFSET(_w) ((_w) * 0x20)
168 #define CPMEM_DP_OFFSET(_d) ((_d) * 0x10000)
169 #define IMX_IPU_DP0 0
170 #define IMX_IPU_DP1 1
171 #define CPMEM_CHANNEL(_dp, _ch, _w) \
172 (CPMEM_DP_OFFSET(_dp) + CPMEM_CHANNEL_OFFSET(_ch) + \
173 CPMEM_WORD_OFFSET(_w))
174 #define CPMEM_OFFSET(_dp, _ch, _w, _o) \
175 (CPMEM_CHANNEL((_dp), (_ch), (_w)) + (_o))
177 #define IPUV3_DEBUG 100
180 #define SUBMOD_DUMP_REG(_sc, _m, _l) \
183 printf("*** " #_m " ***\n"); \
184 for (i = 0; i <= (_l); i += 4) { \
186 printf("%04x: ", i & 0xffff); \
187 printf("0x%08x%c", IPUV3_READ((_sc), _m, i), \
188 ((i + 4) % 32)?' ':'\n'); \
195 int ipuv3_debug = IPUV3_DEBUG;
196 #define DPRINTFN(n,x) if (ipuv3_debug>(n)) printf x; else
198 #define DPRINTFN(n,x)
201 static int ipu3_fb_probe(device_t);
202 static int ipu3_fb_attach(device_t);
205 ipu3_fb_malloc(struct ipu3sc_softc *sc, size_t size)
208 sc->vbase = (uint32_t)contigmalloc(size, M_DEVBUF, M_ZERO, 0, ~0,
210 sc->pbase = vtophys(sc->vbase);
216 ipu3_fb_init(void *arg)
218 struct ipu3sc_softc *sc = arg;
219 struct video_adapter_softc *va_sc = &va_softc;
223 /* FW W0[137:125] - 96 = [41:29] */
224 /* FH W0[149:138] - 96 = [53:42] */
225 w0sh96 = IPUV3_READ(sc, cpmem, CPMEM_OFFSET(IMX_IPU_DP1, 23, 0, 16));
227 w0sh96 |= IPUV3_READ(sc, cpmem, CPMEM_OFFSET(IMX_IPU_DP1, 23, 0, 12));
229 va_sc->width = ((w0sh96 >> 29) & 0x1fff) + 1;
230 va_sc->height = ((w0sh96 >> 42) & 0x0fff) + 1;
232 /* SLY W1[115:102] - 96 = [19:6] */
233 w1sh96 = IPUV3_READ(sc, cpmem, CPMEM_OFFSET(IMX_IPU_DP1, 23, 1, 12));
234 va_sc->stride = ((w1sh96 >> 6) & 0x3fff) + 1;
236 printf("%dx%d [%d]\n", va_sc->width, va_sc->height, va_sc->stride);
237 va_sc->fb_size = va_sc->height * va_sc->stride;
239 ipu3_fb_malloc(sc, va_sc->fb_size);
241 /* DP1 + config_ch_23 + word_2 */
242 IPUV3_WRITE(sc, cpmem, CPMEM_OFFSET(IMX_IPU_DP1, 23, 1, 0),
243 ((sc->pbase >> 3) | ((sc->pbase >> 3) << 29)) & 0xffffffff);
245 IPUV3_WRITE(sc, cpmem, CPMEM_OFFSET(IMX_IPU_DP1, 23, 1, 4),
246 ((sc->pbase >> 3) >> 3) & 0xffffffff);
248 va_sc->fb_addr = (intptr_t)sc->vbase;
249 va_sc->fb_paddr = (intptr_t)sc->pbase;
250 va_sc->bpp = va_sc->stride / va_sc->width;
251 va_sc->depth = va_sc->bpp * 8;
255 ipu3_fb_probe(device_t dev)
259 if (!ofw_bus_status_okay(dev))
262 if (!ofw_bus_is_compatible(dev, "fsl,ipu3"))
265 device_set_desc(dev, "i.MX5x Image Processing Unit v3 (FB)");
267 error = sc_probe_unit(device_get_unit(dev),
268 device_get_flags(dev) | SC_AUTODETECT_KBD);
273 return (BUS_PROBE_DEFAULT);
277 ipu3_fb_attach(device_t dev)
279 struct ipu3sc_softc *sc = device_get_softc(dev);
281 bus_space_handle_t ioh;
293 device_printf(dev, "clock gate status is %d\n",
294 imx51_get_clk_gating(IMX51CLK_IPU_HSP_CLK_ROOT));
298 err = (sc_attach_unit(device_get_unit(dev),
299 device_get_flags(dev) | SC_AUTODETECT_KBD));
302 device_printf(dev, "failed to attach syscons\n");
306 sc = device_get_softc(dev);
307 sc->iot = iot = fdtbus_bs_tag;
310 * Retrieve the device address based on the start address in the
311 * DTS. The DTS for i.MX51 specifies 0x5e000000 as the first register
312 * address, so we just subtract IPU_CM_BASE to get the offset at which
313 * the IPU device was memory mapped.
314 * On i.MX53, the offset is 0.
316 node = ofw_bus_get_node(dev);
317 if ((OF_getencprop(node, "reg", ®, sizeof(reg))) <= 0)
320 base = reg - IPU_CM_BASE(0);
321 /* map controller registers */
322 err = bus_space_map(iot, IPU_CM_BASE(base), IPU_CM_SIZE, 0, &ioh);
327 /* map Display Multi FIFO Controller registers */
328 err = bus_space_map(iot, IPU_DMFC_BASE(base), IPU_DMFC_SIZE, 0, &ioh);
330 goto fail_retarn_dmfc;
333 /* map Display Interface 0 registers */
334 err = bus_space_map(iot, IPU_DI0_BASE(base), IPU_DI0_SIZE, 0, &ioh);
336 goto fail_retarn_di0;
339 /* map Display Interface 1 registers */
340 err = bus_space_map(iot, IPU_DI1_BASE(base), IPU_DI0_SIZE, 0, &ioh);
342 goto fail_retarn_di1;
345 /* map Display Processor registers */
346 err = bus_space_map(iot, IPU_DP_BASE(base), IPU_DP_SIZE, 0, &ioh);
351 /* map Display Controller registers */
352 err = bus_space_map(iot, IPU_DC_BASE(base), IPU_DC_SIZE, 0, &ioh);
357 /* map Image DMA Controller registers */
358 err = bus_space_map(iot, IPU_IDMAC_BASE(base), IPU_IDMAC_SIZE, 0,
361 goto fail_retarn_idmac;
364 /* map CPMEM registers */
365 err = bus_space_map(iot, IPU_CPMEM_BASE(base), IPU_CPMEM_SIZE, 0,
368 goto fail_retarn_cpmem;
371 /* map DCTEMPL registers */
372 err = bus_space_map(iot, IPU_DCTMPL_BASE(base), IPU_DCTMPL_SIZE, 0,
375 goto fail_retarn_dctmpl;
376 sc->dctmpl_ioh = ioh;
379 sc->ih = imx51_ipuv3_intr_establish(IMX51_INT_IPUV3, IPL_BIO,
381 if (sc->ih == NULL) {
382 device_printf(sc->dev,
383 "unable to establish interrupt at irq %d\n",
390 * We have to wait until interrupts are enabled.
391 * Mailbox relies on it to get data from VideoCore
400 bus_space_unmap(sc->iot, sc->cpmem_ioh, IPU_CPMEM_SIZE);
402 bus_space_unmap(sc->iot, sc->idmac_ioh, IPU_IDMAC_SIZE);
404 bus_space_unmap(sc->iot, sc->dc_ioh, IPU_DC_SIZE);
406 bus_space_unmap(sc->iot, sc->dp_ioh, IPU_DP_SIZE);
408 bus_space_unmap(sc->iot, sc->di1_ioh, IPU_DI1_SIZE);
410 bus_space_unmap(sc->iot, sc->di0_ioh, IPU_DI0_SIZE);
412 bus_space_unmap(sc->iot, sc->dmfc_ioh, IPU_DMFC_SIZE);
414 bus_space_unmap(sc->iot, sc->dc_ioh, IPU_CM_SIZE);
416 device_printf(sc->dev,
417 "failed to map registers (errno=%d)\n", err);
421 static device_method_t ipu3_fb_methods[] = {
422 /* Device interface */
423 DEVMETHOD(device_probe, ipu3_fb_probe),
424 DEVMETHOD(device_attach, ipu3_fb_attach),
429 static devclass_t ipu3_fb_devclass;
431 static driver_t ipu3_fb_driver = {
434 sizeof(struct ipu3sc_softc),
437 DRIVER_MODULE(ipu3fb, simplebus, ipu3_fb_driver, ipu3_fb_devclass, 0, 0);
440 * Video driver routines and glue.
442 static int ipu3fb_configure(int);
443 static vi_probe_t ipu3fb_probe;
444 static vi_init_t ipu3fb_init;
445 static vi_get_info_t ipu3fb_get_info;
446 static vi_query_mode_t ipu3fb_query_mode;
447 static vi_set_mode_t ipu3fb_set_mode;
448 static vi_save_font_t ipu3fb_save_font;
449 static vi_load_font_t ipu3fb_load_font;
450 static vi_show_font_t ipu3fb_show_font;
451 static vi_save_palette_t ipu3fb_save_palette;
452 static vi_load_palette_t ipu3fb_load_palette;
453 static vi_set_border_t ipu3fb_set_border;
454 static vi_save_state_t ipu3fb_save_state;
455 static vi_load_state_t ipu3fb_load_state;
456 static vi_set_win_org_t ipu3fb_set_win_org;
457 static vi_read_hw_cursor_t ipu3fb_read_hw_cursor;
458 static vi_set_hw_cursor_t ipu3fb_set_hw_cursor;
459 static vi_set_hw_cursor_shape_t ipu3fb_set_hw_cursor_shape;
460 static vi_blank_display_t ipu3fb_blank_display;
461 static vi_mmap_t ipu3fb_mmap;
462 static vi_ioctl_t ipu3fb_ioctl;
463 static vi_clear_t ipu3fb_clear;
464 static vi_fill_rect_t ipu3fb_fill_rect;
465 static vi_bitblt_t ipu3fb_bitblt;
466 static vi_diag_t ipu3fb_diag;
467 static vi_save_cursor_palette_t ipu3fb_save_cursor_palette;
468 static vi_load_cursor_palette_t ipu3fb_load_cursor_palette;
469 static vi_copy_t ipu3fb_copy;
470 static vi_putp_t ipu3fb_putp;
471 static vi_putc_t ipu3fb_putc;
472 static vi_puts_t ipu3fb_puts;
473 static vi_putm_t ipu3fb_putm;
475 static video_switch_t ipu3fbvidsw = {
476 .probe = ipu3fb_probe,
478 .get_info = ipu3fb_get_info,
479 .query_mode = ipu3fb_query_mode,
480 .set_mode = ipu3fb_set_mode,
481 .save_font = ipu3fb_save_font,
482 .load_font = ipu3fb_load_font,
483 .show_font = ipu3fb_show_font,
484 .save_palette = ipu3fb_save_palette,
485 .load_palette = ipu3fb_load_palette,
486 .set_border = ipu3fb_set_border,
487 .save_state = ipu3fb_save_state,
488 .load_state = ipu3fb_load_state,
489 .set_win_org = ipu3fb_set_win_org,
490 .read_hw_cursor = ipu3fb_read_hw_cursor,
491 .set_hw_cursor = ipu3fb_set_hw_cursor,
492 .set_hw_cursor_shape = ipu3fb_set_hw_cursor_shape,
493 .blank_display = ipu3fb_blank_display,
495 .ioctl = ipu3fb_ioctl,
496 .clear = ipu3fb_clear,
497 .fill_rect = ipu3fb_fill_rect,
498 .bitblt = ipu3fb_bitblt,
500 .save_cursor_palette = ipu3fb_save_cursor_palette,
501 .load_cursor_palette = ipu3fb_load_cursor_palette,
509 VIDEO_DRIVER(ipu3fb, ipu3fbvidsw, ipu3fb_configure);
511 extern sc_rndr_sw_t txtrndrsw;
512 RENDERER(ipu3fb, 0, txtrndrsw, gfb_set);
513 RENDERER_MODULE(ipu3fb, gfb_set);
515 static uint16_t ipu3fb_static_window[ROW*COL];
516 extern u_char dflt_font_16[];
519 ipu3fb_configure(int flags)
521 struct video_adapter_softc *sc;
531 sc->stride = sc->width * sc->bpp;
533 ipu3fb_init(0, &sc->va, 0);
541 ipu3fb_probe(int unit, video_adapter_t **adp, void *arg, int flags)
548 ipu3fb_init(int unit, video_adapter_t *adp, int flags)
550 struct video_adapter_softc *sc;
553 sc = (struct video_adapter_softc *)adp;
556 vid_init_struct(adp, "ipu3fb", -1, unit);
558 sc->font = dflt_font_16;
559 vi->vi_cheight = IPU3FB_FONT_HEIGHT;
561 vi->vi_width = sc->width/8;
562 vi->vi_height = sc->height/vi->vi_cheight;
565 * Clamp width/height to syscons maximums
567 if (vi->vi_width > COL)
569 if (vi->vi_height > ROW)
572 sc->xmargin = (sc->width - (vi->vi_width * vi->vi_cwidth)) / 2;
573 sc->ymargin = (sc->height - (vi->vi_height * vi->vi_cheight))/2;
575 adp->va_window = (vm_offset_t) ipu3fb_static_window;
576 adp->va_flags |= V_ADP_FONT /* | V_ADP_COLOR | V_ADP_MODECHANGE */;
577 adp->va_line_width = sc->stride;
578 adp->va_buffer_size = sc->fb_size;
580 vid_register(&sc->va);
586 ipu3fb_get_info(video_adapter_t *adp, int mode, video_info_t *info)
589 bcopy(&adp->va_info, info, sizeof(*info));
594 ipu3fb_query_mode(video_adapter_t *adp, video_info_t *info)
601 ipu3fb_set_mode(video_adapter_t *adp, int mode)
608 ipu3fb_save_font(video_adapter_t *adp, int page, int size, int width,
609 u_char *data, int c, int count)
616 ipu3fb_load_font(video_adapter_t *adp, int page, int size, int width,
617 u_char *data, int c, int count)
619 struct video_adapter_softc *sc;
621 sc = (struct video_adapter_softc *)adp;
628 ipu3fb_show_font(video_adapter_t *adp, int page)
635 ipu3fb_save_palette(video_adapter_t *adp, u_char *palette)
642 ipu3fb_load_palette(video_adapter_t *adp, u_char *palette)
649 ipu3fb_set_border(video_adapter_t *adp, int border)
652 return (ipu3fb_blank_display(adp, border));
656 ipu3fb_save_state(video_adapter_t *adp, void *p, size_t size)
663 ipu3fb_load_state(video_adapter_t *adp, void *p)
670 ipu3fb_set_win_org(video_adapter_t *adp, off_t offset)
677 ipu3fb_read_hw_cursor(video_adapter_t *adp, int *col, int *row)
685 ipu3fb_set_hw_cursor(video_adapter_t *adp, int col, int row)
692 ipu3fb_set_hw_cursor_shape(video_adapter_t *adp, int base, int height,
693 int celsize, int blink)
700 ipu3fb_blank_display(video_adapter_t *adp, int mode)
707 ipu3fb_mmap(video_adapter_t *adp, vm_ooffset_t offset, vm_paddr_t *paddr,
708 int prot, vm_memattr_t *memattr)
710 struct video_adapter_softc *sc;
712 sc = (struct video_adapter_softc *)adp;
715 * This might be a legacy VGA mem request: if so, just point it at the
716 * framebuffer, since it shouldn't be touched
718 if (offset < sc->stride * sc->height) {
719 *paddr = sc->fb_paddr + offset;
727 ipu3fb_ioctl(video_adapter_t *adp, u_long cmd, caddr_t data)
729 struct video_adapter_softc *sc;
732 sc = (struct video_adapter_softc *)adp;
736 fb = (struct fbtype *)data;
737 fb->fb_type = FBTYPE_PCIMISC;
738 fb->fb_height = sc->height;
739 fb->fb_width = sc->width;
740 fb->fb_depth = sc->depth;
741 if (sc->depth <= 1 || sc->depth > 8)
744 fb->fb_cmsize = 1 << sc->depth;
745 fb->fb_size = sc->fb_size;
750 return (fb_commonioctl(adp, cmd, data));
757 ipu3fb_clear(video_adapter_t *adp)
760 return (ipu3fb_blank_display(adp, 0));
764 ipu3fb_fill_rect(video_adapter_t *adp, int val, int x, int y, int cx, int cy)
771 ipu3fb_bitblt(video_adapter_t *adp, ...)
778 ipu3fb_diag(video_adapter_t *adp, int level)
785 ipu3fb_save_cursor_palette(video_adapter_t *adp, u_char *palette)
792 ipu3fb_load_cursor_palette(video_adapter_t *adp, u_char *palette)
799 ipu3fb_copy(video_adapter_t *adp, vm_offset_t src, vm_offset_t dst, int n)
806 ipu3fb_putp(video_adapter_t *adp, vm_offset_t off, uint32_t p, uint32_t a,
807 int size, int bpp, int bit_ltor, int byte_ltor)
814 ipu3fb_putc(video_adapter_t *adp, vm_offset_t off, uint8_t c, uint8_t a)
816 struct video_adapter_softc *sc;
821 uint32_t fg, bg, color;
823 sc = (struct video_adapter_softc *)adp;
826 if (sc->fb_addr == 0)
828 row = (off / adp->va_info.vi_width) * adp->va_info.vi_cheight;
829 col = (off % adp->va_info.vi_width) * adp->va_info.vi_cwidth;
830 p = sc->font + c * IPU3FB_FONT_HEIGHT;
831 addr = (uint8_t *)sc->fb_addr
832 + (row + sc->ymargin) * (sc->stride)
833 + bpp * (col + sc->xmargin);
836 bg = colors[(a >> 4) & 0x0f];
837 fg = colors[a & 0x0f];
838 } else if (bpp == 3) {
839 bg = colors_24[(a >> 4) & 0x0f];
840 fg = colors_24[a & 0x0f];
845 for (i = 0; i < IPU3FB_FONT_HEIGHT; i++) {
846 for (j = 0, k = 7; j < 8; j++, k--) {
847 if ((p[i] & (1 << k)) == 0)
851 /* FIXME: BPP maybe different */
852 for (b = 0; b < bpp; b ++)
854 (color >> (b << 3)) & 0xff;
857 addr += (sc->stride);
864 ipu3fb_puts(video_adapter_t *adp, vm_offset_t off, u_int16_t *s, int len)
868 for (i = 0; i < len; i++)
869 ipu3fb_putc(adp, off + i, s[i] & 0xff, (s[i] & 0xff00) >> 8);
875 ipu3fb_putm(video_adapter_t *adp, int x, int y, uint8_t *pixel_image,
876 uint32_t pixel_mask, int size, int width)
883 * Define a stub keyboard driver in case one hasn't been
884 * compiled into the kernel
886 #include <sys/kbio.h>
887 #include <dev/kbd/kbdreg.h>
889 static int dummy_kbd_configure(int flags);
891 keyboard_switch_t ipu3dummysw;
894 dummy_kbd_configure(int flags)
899 KEYBOARD_DRIVER(ipu3dummy, ipu3dummysw, dummy_kbd_configure);