2 * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
3 * Copyright (c) 2012, 2013 The FreeBSD Foundation
6 * Portions of this software were developed by Oleksandr Rybalko
7 * under sponsorship from the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
39 #include <sys/endian.h>
40 #include <sys/kernel.h>
41 #include <sys/kthread.h>
43 #include <sys/malloc.h>
44 #include <sys/module.h>
45 #include <sys/mutex.h>
46 #include <sys/queue.h>
47 #include <sys/resource.h>
50 #include <sys/timetc.h>
52 #include <sys/consio.h>
56 #include <machine/bus.h>
57 #include <machine/cpu.h>
58 #include <machine/cpufunc.h>
59 #include <machine/fdt.h>
60 #include <machine/resource.h>
61 #include <machine/intr.h>
63 #include <dev/fdt/fdt_common.h>
64 #include <dev/ofw/ofw_bus.h>
65 #include <dev/ofw/ofw_bus_subr.h>
67 #include <dev/fb/fbreg.h>
68 #include <dev/syscons/syscons.h>
70 #include <arm/freescale/imx/imx51_ccmvar.h>
72 #include <arm/freescale/imx/imx51_ipuv3reg.h>
74 #define IMX51_IPU_HSP_CLOCK 665000000
75 #define IPU3FB_FONT_HEIGHT 16
83 bus_space_handle_t ioh;
84 bus_space_handle_t cm_ioh;
85 bus_space_handle_t dp_ioh;
86 bus_space_handle_t di0_ioh;
87 bus_space_handle_t di1_ioh;
88 bus_space_handle_t dctmpl_ioh;
89 bus_space_handle_t dc_ioh;
90 bus_space_handle_t dmfc_ioh;
91 bus_space_handle_t idmac_ioh;
92 bus_space_handle_t cpmem_ioh;
95 struct video_adapter_softc {
96 /* Videoadpater part */
101 unsigned int fb_size;
109 unsigned int xmargin;
110 unsigned int ymargin;
116 static struct ipu3sc_softc *ipu3sc_softc;
117 static struct video_adapter_softc va_softc;
119 /* FIXME: not only 2 bytes color supported */
120 static uint16_t colors[16] = {
126 0xf81f, /* magenta */
128 0xc618, /* light grey */
129 0xc618, /* XXX: dark grey */
130 0x001f, /* XXX: light blue */
131 0x07e0, /* XXX: light green */
132 0x07ff, /* XXX: light cyan */
133 0xf800, /* XXX: light red */
134 0xf81f, /* XXX: light magenta */
138 static uint32_t colors_24[16] = {
144 0x800080,/* Magenta */
146 0xC0C0C0,/* Silver */
148 0x0000FF,/* Light Blue */
149 0x00FF00,/* Light Green */
150 0x00FFFF,/* Light Cyan */
151 0xFF0000,/* Light Red */
152 0xFF00FF,/* Light Magenta */
153 0xFFFF00,/* Yellow */
159 #define IPUV3_READ(ipuv3, module, reg) \
160 bus_space_read_4((ipuv3)->iot, (ipuv3)->module##_ioh, (reg))
161 #define IPUV3_WRITE(ipuv3, module, reg, val) \
162 bus_space_write_4((ipuv3)->iot, (ipuv3)->module##_ioh, (reg), (val))
164 #define CPMEM_CHANNEL_OFFSET(_c) ((_c) * 0x40)
165 #define CPMEM_WORD_OFFSET(_w) ((_w) * 0x20)
166 #define CPMEM_DP_OFFSET(_d) ((_d) * 0x10000)
167 #define IMX_IPU_DP0 0
168 #define IMX_IPU_DP1 1
169 #define CPMEM_CHANNEL(_dp, _ch, _w) \
170 (CPMEM_DP_OFFSET(_dp) + CPMEM_CHANNEL_OFFSET(_ch) + \
171 CPMEM_WORD_OFFSET(_w))
172 #define CPMEM_OFFSET(_dp, _ch, _w, _o) \
173 (CPMEM_CHANNEL((_dp), (_ch), (_w)) + (_o))
175 #define IPUV3_DEBUG 100
178 #define SUBMOD_DUMP_REG(_sc, _m, _l) \
181 printf("*** " #_m " ***\n"); \
182 for (i = 0; i <= (_l); i += 4) { \
184 printf("%04x: ", i & 0xffff); \
185 printf("0x%08x%c", IPUV3_READ((_sc), _m, i), \
186 ((i + 4) % 32)?' ':'\n'); \
193 int ipuv3_debug = IPUV3_DEBUG;
194 #define DPRINTFN(n,x) if (ipuv3_debug>(n)) printf x; else
196 #define DPRINTFN(n,x)
199 static int ipu3_fb_probe(device_t);
200 static int ipu3_fb_attach(device_t);
203 ipu3_fb_malloc(struct ipu3sc_softc *sc, size_t size)
206 sc->vbase = (uint32_t)contigmalloc(size, M_DEVBUF, M_ZERO, 0, ~0,
208 sc->pbase = vtophys(sc->vbase);
214 ipu3_fb_init(void *arg)
216 struct ipu3sc_softc *sc = arg;
217 struct video_adapter_softc *va_sc = &va_softc;
221 /* FW W0[137:125] - 96 = [41:29] */
222 /* FH W0[149:138] - 96 = [53:42] */
223 w0sh96 = IPUV3_READ(sc, cpmem, CPMEM_OFFSET(IMX_IPU_DP1, 23, 0, 16));
225 w0sh96 |= IPUV3_READ(sc, cpmem, CPMEM_OFFSET(IMX_IPU_DP1, 23, 0, 12));
227 va_sc->width = ((w0sh96 >> 29) & 0x1fff) + 1;
228 va_sc->height = ((w0sh96 >> 42) & 0x0fff) + 1;
230 /* SLY W1[115:102] - 96 = [19:6] */
231 w1sh96 = IPUV3_READ(sc, cpmem, CPMEM_OFFSET(IMX_IPU_DP1, 23, 1, 12));
232 va_sc->stride = ((w1sh96 >> 6) & 0x3fff) + 1;
234 printf("%dx%d [%d]\n", va_sc->width, va_sc->height, va_sc->stride);
235 va_sc->fb_size = va_sc->height * va_sc->stride;
237 ipu3_fb_malloc(sc, va_sc->fb_size);
239 /* DP1 + config_ch_23 + word_2 */
240 IPUV3_WRITE(sc, cpmem, CPMEM_OFFSET(IMX_IPU_DP1, 23, 1, 0),
241 ((sc->pbase >> 3) | ((sc->pbase >> 3) << 29)) & 0xffffffff);
243 IPUV3_WRITE(sc, cpmem, CPMEM_OFFSET(IMX_IPU_DP1, 23, 1, 4),
244 ((sc->pbase >> 3) >> 3) & 0xffffffff);
246 va_sc->fb_addr = (intptr_t)sc->vbase;
247 va_sc->fb_paddr = (intptr_t)sc->pbase;
248 va_sc->bpp = va_sc->stride / va_sc->width;
249 va_sc->depth = va_sc->bpp * 8;
253 ipu3_fb_probe(device_t dev)
257 if (!ofw_bus_status_okay(dev))
260 if (!ofw_bus_is_compatible(dev, "fsl,ipu3"))
263 device_set_desc(dev, "i.MX5x Image Processing Unit v3 (FB)");
265 error = sc_probe_unit(device_get_unit(dev),
266 device_get_flags(dev) | SC_AUTODETECT_KBD);
271 return (BUS_PROBE_DEFAULT);
275 ipu3_fb_attach(device_t dev)
277 struct ipu3sc_softc *sc = device_get_softc(dev);
279 bus_space_handle_t ioh;
291 device_printf(dev, "clock gate status is %d\n",
292 imx51_get_clk_gating(IMX51CLK_IPU_HSP_CLK_ROOT));
296 err = (sc_attach_unit(device_get_unit(dev),
297 device_get_flags(dev) | SC_AUTODETECT_KBD));
300 device_printf(dev, "failed to attach syscons\n");
304 sc = device_get_softc(dev);
305 sc->iot = iot = fdtbus_bs_tag;
308 * Retrieve the device address based on the start address in the
309 * DTS. The DTS for i.MX51 specifies 0x5e000000 as the first register
310 * address, so we just subtract IPU_CM_BASE to get the offset at which
311 * the IPU device was memory mapped.
312 * On i.MX53, the offset is 0.
314 node = ofw_bus_get_node(dev);
315 if ((OF_getprop(node, "reg", ®, sizeof(reg))) <= 0)
318 base = fdt32_to_cpu(reg) - IPU_CM_BASE(0);
319 /* map controller registers */
320 err = bus_space_map(iot, IPU_CM_BASE(base), IPU_CM_SIZE, 0, &ioh);
325 /* map Display Multi FIFO Controller registers */
326 err = bus_space_map(iot, IPU_DMFC_BASE(base), IPU_DMFC_SIZE, 0, &ioh);
328 goto fail_retarn_dmfc;
331 /* map Display Interface 0 registers */
332 err = bus_space_map(iot, IPU_DI0_BASE(base), IPU_DI0_SIZE, 0, &ioh);
334 goto fail_retarn_di0;
337 /* map Display Interface 1 registers */
338 err = bus_space_map(iot, IPU_DI1_BASE(base), IPU_DI0_SIZE, 0, &ioh);
340 goto fail_retarn_di1;
343 /* map Display Processor registers */
344 err = bus_space_map(iot, IPU_DP_BASE(base), IPU_DP_SIZE, 0, &ioh);
349 /* map Display Controller registers */
350 err = bus_space_map(iot, IPU_DC_BASE(base), IPU_DC_SIZE, 0, &ioh);
355 /* map Image DMA Controller registers */
356 err = bus_space_map(iot, IPU_IDMAC_BASE(base), IPU_IDMAC_SIZE, 0,
359 goto fail_retarn_idmac;
362 /* map CPMEM registers */
363 err = bus_space_map(iot, IPU_CPMEM_BASE(base), IPU_CPMEM_SIZE, 0,
366 goto fail_retarn_cpmem;
369 /* map DCTEMPL registers */
370 err = bus_space_map(iot, IPU_DCTMPL_BASE(base), IPU_DCTMPL_SIZE, 0,
373 goto fail_retarn_dctmpl;
374 sc->dctmpl_ioh = ioh;
377 sc->ih = imx51_ipuv3_intr_establish(IMX51_INT_IPUV3, IPL_BIO,
379 if (sc->ih == NULL) {
380 device_printf(sc->dev,
381 "unable to establish interrupt at irq %d\n",
388 * We have to wait until interrupts are enabled.
389 * Mailbox relies on it to get data from VideoCore
398 bus_space_unmap(sc->iot, sc->cpmem_ioh, IPU_CPMEM_SIZE);
400 bus_space_unmap(sc->iot, sc->idmac_ioh, IPU_IDMAC_SIZE);
402 bus_space_unmap(sc->iot, sc->dc_ioh, IPU_DC_SIZE);
404 bus_space_unmap(sc->iot, sc->dp_ioh, IPU_DP_SIZE);
406 bus_space_unmap(sc->iot, sc->di1_ioh, IPU_DI1_SIZE);
408 bus_space_unmap(sc->iot, sc->di0_ioh, IPU_DI0_SIZE);
410 bus_space_unmap(sc->iot, sc->dmfc_ioh, IPU_DMFC_SIZE);
412 bus_space_unmap(sc->iot, sc->dc_ioh, IPU_CM_SIZE);
414 device_printf(sc->dev,
415 "failed to map registers (errno=%d)\n", err);
419 static device_method_t ipu3_fb_methods[] = {
420 /* Device interface */
421 DEVMETHOD(device_probe, ipu3_fb_probe),
422 DEVMETHOD(device_attach, ipu3_fb_attach),
427 static devclass_t ipu3_fb_devclass;
429 static driver_t ipu3_fb_driver = {
432 sizeof(struct ipu3sc_softc),
435 DRIVER_MODULE(ipu3fb, simplebus, ipu3_fb_driver, ipu3_fb_devclass, 0, 0);
438 * Video driver routines and glue.
440 static int ipu3fb_configure(int);
441 static vi_probe_t ipu3fb_probe;
442 static vi_init_t ipu3fb_init;
443 static vi_get_info_t ipu3fb_get_info;
444 static vi_query_mode_t ipu3fb_query_mode;
445 static vi_set_mode_t ipu3fb_set_mode;
446 static vi_save_font_t ipu3fb_save_font;
447 static vi_load_font_t ipu3fb_load_font;
448 static vi_show_font_t ipu3fb_show_font;
449 static vi_save_palette_t ipu3fb_save_palette;
450 static vi_load_palette_t ipu3fb_load_palette;
451 static vi_set_border_t ipu3fb_set_border;
452 static vi_save_state_t ipu3fb_save_state;
453 static vi_load_state_t ipu3fb_load_state;
454 static vi_set_win_org_t ipu3fb_set_win_org;
455 static vi_read_hw_cursor_t ipu3fb_read_hw_cursor;
456 static vi_set_hw_cursor_t ipu3fb_set_hw_cursor;
457 static vi_set_hw_cursor_shape_t ipu3fb_set_hw_cursor_shape;
458 static vi_blank_display_t ipu3fb_blank_display;
459 static vi_mmap_t ipu3fb_mmap;
460 static vi_ioctl_t ipu3fb_ioctl;
461 static vi_clear_t ipu3fb_clear;
462 static vi_fill_rect_t ipu3fb_fill_rect;
463 static vi_bitblt_t ipu3fb_bitblt;
464 static vi_diag_t ipu3fb_diag;
465 static vi_save_cursor_palette_t ipu3fb_save_cursor_palette;
466 static vi_load_cursor_palette_t ipu3fb_load_cursor_palette;
467 static vi_copy_t ipu3fb_copy;
468 static vi_putp_t ipu3fb_putp;
469 static vi_putc_t ipu3fb_putc;
470 static vi_puts_t ipu3fb_puts;
471 static vi_putm_t ipu3fb_putm;
473 static video_switch_t ipu3fbvidsw = {
474 .probe = ipu3fb_probe,
476 .get_info = ipu3fb_get_info,
477 .query_mode = ipu3fb_query_mode,
478 .set_mode = ipu3fb_set_mode,
479 .save_font = ipu3fb_save_font,
480 .load_font = ipu3fb_load_font,
481 .show_font = ipu3fb_show_font,
482 .save_palette = ipu3fb_save_palette,
483 .load_palette = ipu3fb_load_palette,
484 .set_border = ipu3fb_set_border,
485 .save_state = ipu3fb_save_state,
486 .load_state = ipu3fb_load_state,
487 .set_win_org = ipu3fb_set_win_org,
488 .read_hw_cursor = ipu3fb_read_hw_cursor,
489 .set_hw_cursor = ipu3fb_set_hw_cursor,
490 .set_hw_cursor_shape = ipu3fb_set_hw_cursor_shape,
491 .blank_display = ipu3fb_blank_display,
493 .ioctl = ipu3fb_ioctl,
494 .clear = ipu3fb_clear,
495 .fill_rect = ipu3fb_fill_rect,
496 .bitblt = ipu3fb_bitblt,
498 .save_cursor_palette = ipu3fb_save_cursor_palette,
499 .load_cursor_palette = ipu3fb_load_cursor_palette,
507 VIDEO_DRIVER(ipu3fb, ipu3fbvidsw, ipu3fb_configure);
509 extern sc_rndr_sw_t txtrndrsw;
510 RENDERER(ipu3fb, 0, txtrndrsw, gfb_set);
511 RENDERER_MODULE(ipu3fb, gfb_set);
513 static uint16_t ipu3fb_static_window[ROW*COL];
514 extern u_char dflt_font_16[];
517 ipu3fb_configure(int flags)
519 struct video_adapter_softc *sc;
529 sc->stride = sc->width * sc->bpp;
531 ipu3fb_init(0, &sc->va, 0);
539 ipu3fb_probe(int unit, video_adapter_t **adp, void *arg, int flags)
546 ipu3fb_init(int unit, video_adapter_t *adp, int flags)
548 struct video_adapter_softc *sc;
551 sc = (struct video_adapter_softc *)adp;
554 vid_init_struct(adp, "ipu3fb", -1, unit);
556 sc->font = dflt_font_16;
557 vi->vi_cheight = IPU3FB_FONT_HEIGHT;
559 vi->vi_width = sc->width/8;
560 vi->vi_height = sc->height/vi->vi_cheight;
563 * Clamp width/height to syscons maximums
565 if (vi->vi_width > COL)
567 if (vi->vi_height > ROW)
570 sc->xmargin = (sc->width - (vi->vi_width * vi->vi_cwidth)) / 2;
571 sc->ymargin = (sc->height - (vi->vi_height * vi->vi_cheight))/2;
573 adp->va_window = (vm_offset_t) ipu3fb_static_window;
574 adp->va_flags |= V_ADP_FONT /* | V_ADP_COLOR | V_ADP_MODECHANGE */;
575 adp->va_line_width = sc->stride;
576 adp->va_buffer_size = sc->fb_size;
578 vid_register(&sc->va);
584 ipu3fb_get_info(video_adapter_t *adp, int mode, video_info_t *info)
587 bcopy(&adp->va_info, info, sizeof(*info));
592 ipu3fb_query_mode(video_adapter_t *adp, video_info_t *info)
599 ipu3fb_set_mode(video_adapter_t *adp, int mode)
606 ipu3fb_save_font(video_adapter_t *adp, int page, int size, int width,
607 u_char *data, int c, int count)
614 ipu3fb_load_font(video_adapter_t *adp, int page, int size, int width,
615 u_char *data, int c, int count)
617 struct video_adapter_softc *sc;
619 sc = (struct video_adapter_softc *)adp;
626 ipu3fb_show_font(video_adapter_t *adp, int page)
633 ipu3fb_save_palette(video_adapter_t *adp, u_char *palette)
640 ipu3fb_load_palette(video_adapter_t *adp, u_char *palette)
647 ipu3fb_set_border(video_adapter_t *adp, int border)
650 return (ipu3fb_blank_display(adp, border));
654 ipu3fb_save_state(video_adapter_t *adp, void *p, size_t size)
661 ipu3fb_load_state(video_adapter_t *adp, void *p)
668 ipu3fb_set_win_org(video_adapter_t *adp, off_t offset)
675 ipu3fb_read_hw_cursor(video_adapter_t *adp, int *col, int *row)
683 ipu3fb_set_hw_cursor(video_adapter_t *adp, int col, int row)
690 ipu3fb_set_hw_cursor_shape(video_adapter_t *adp, int base, int height,
691 int celsize, int blink)
698 ipu3fb_blank_display(video_adapter_t *adp, int mode)
705 ipu3fb_mmap(video_adapter_t *adp, vm_ooffset_t offset, vm_paddr_t *paddr,
706 int prot, vm_memattr_t *memattr)
708 struct video_adapter_softc *sc;
710 sc = (struct video_adapter_softc *)adp;
713 * This might be a legacy VGA mem request: if so, just point it at the
714 * framebuffer, since it shouldn't be touched
716 if (offset < sc->stride * sc->height) {
717 *paddr = sc->fb_paddr + offset;
725 ipu3fb_ioctl(video_adapter_t *adp, u_long cmd, caddr_t data)
727 struct video_adapter_softc *sc;
730 sc = (struct video_adapter_softc *)adp;
734 fb = (struct fbtype *)data;
735 fb->fb_type = FBTYPE_PCIMISC;
736 fb->fb_height = sc->height;
737 fb->fb_width = sc->width;
738 fb->fb_depth = sc->depth;
739 if (sc->depth <= 1 || sc->depth > 8)
742 fb->fb_cmsize = 1 << sc->depth;
743 fb->fb_size = sc->fb_size;
748 return (fb_commonioctl(adp, cmd, data));
755 ipu3fb_clear(video_adapter_t *adp)
758 return (ipu3fb_blank_display(adp, 0));
762 ipu3fb_fill_rect(video_adapter_t *adp, int val, int x, int y, int cx, int cy)
769 ipu3fb_bitblt(video_adapter_t *adp, ...)
776 ipu3fb_diag(video_adapter_t *adp, int level)
783 ipu3fb_save_cursor_palette(video_adapter_t *adp, u_char *palette)
790 ipu3fb_load_cursor_palette(video_adapter_t *adp, u_char *palette)
797 ipu3fb_copy(video_adapter_t *adp, vm_offset_t src, vm_offset_t dst, int n)
804 ipu3fb_putp(video_adapter_t *adp, vm_offset_t off, uint32_t p, uint32_t a,
805 int size, int bpp, int bit_ltor, int byte_ltor)
812 ipu3fb_putc(video_adapter_t *adp, vm_offset_t off, uint8_t c, uint8_t a)
814 struct video_adapter_softc *sc;
819 uint32_t fg, bg, color;
821 sc = (struct video_adapter_softc *)adp;
824 if (sc->fb_addr == 0)
826 row = (off / adp->va_info.vi_width) * adp->va_info.vi_cheight;
827 col = (off % adp->va_info.vi_width) * adp->va_info.vi_cwidth;
828 p = sc->font + c * IPU3FB_FONT_HEIGHT;
829 addr = (uint8_t *)sc->fb_addr
830 + (row + sc->ymargin) * (sc->stride)
831 + bpp * (col + sc->xmargin);
834 bg = colors[(a >> 4) & 0x0f];
835 fg = colors[a & 0x0f];
836 } else if (bpp == 3) {
837 bg = colors_24[(a >> 4) & 0x0f];
838 fg = colors_24[a & 0x0f];
843 for (i = 0; i < IPU3FB_FONT_HEIGHT; i++) {
844 for (j = 0, k = 7; j < 8; j++, k--) {
845 if ((p[i] & (1 << k)) == 0)
849 /* FIXME: BPP maybe different */
850 for (b = 0; b < bpp; b ++)
852 (color >> (b << 3)) & 0xff;
855 addr += (sc->stride);
862 ipu3fb_puts(video_adapter_t *adp, vm_offset_t off, u_int16_t *s, int len)
866 for (i = 0; i < len; i++)
867 ipu3fb_putc(adp, off + i, s[i] & 0xff, (s[i] & 0xff00) >> 8);
873 ipu3fb_putm(video_adapter_t *adp, int x, int y, uint8_t *pixel_image,
874 uint32_t pixel_mask, int size, int width)
881 * Define a stub keyboard driver in case one hasn't been
882 * compiled into the kernel
884 #include <sys/kbio.h>
885 #include <dev/kbd/kbdreg.h>
887 static int dummy_kbd_configure(int flags);
889 keyboard_switch_t ipu3dummysw;
892 dummy_kbd_configure(int flags)
897 KEYBOARD_DRIVER(ipu3dummy, ipu3dummysw, dummy_kbd_configure);