648e1c22fefd2fac01317c6a211e2633f231935e
[oweals/u-boot.git] / drivers / video / mxsfb.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Freescale i.MX23/i.MX28 LCDIF driver
4  *
5  * Copyright (C) 2011-2013 Marek Vasut <marex@denx.de>
6  */
7 #include <common.h>
8 #include <clk.h>
9 #include <dm.h>
10 #include <env.h>
11 #include <dm/device_compat.h>
12 #include <linux/errno.h>
13 #include <malloc.h>
14 #include <video.h>
15 #include <video_fb.h>
16
17 #include <asm/arch/clock.h>
18 #include <asm/arch/imx-regs.h>
19 #include <asm/arch/sys_proto.h>
20 #include <asm/mach-imx/dma.h>
21 #include <asm/io.h>
22
23 #include "videomodes.h"
24
25 #define PS2KHZ(ps)      (1000000000UL / (ps))
26 #define HZ2PS(hz)       (1000000000UL / ((hz) / 1000))
27
28 #define BITS_PP         18
29 #define BYTES_PP        4
30
31 struct mxs_dma_desc desc;
32
33 /**
34  * mxsfb_system_setup() - Fine-tune LCDIF configuration
35  *
36  * This function is used to adjust the LCDIF configuration. This is usually
37  * needed when driving the controller in System-Mode to operate an 8080 or
38  * 6800 connected SmartLCD.
39  */
40 __weak void mxsfb_system_setup(void)
41 {
42 }
43
44 /*
45  * ARIES M28EVK:
46  * setenv videomode
47  * video=ctfb:x:800,y:480,depth:18,mode:0,pclk:30066,
48  *       le:0,ri:256,up:0,lo:45,hs:1,vs:1,sync:100663296,vmode:0
49  *
50  * Freescale mx23evk/mx28evk with a Seiko 4.3'' WVGA panel:
51  * setenv videomode
52  * video=ctfb:x:800,y:480,depth:24,mode:0,pclk:29851,
53  *       le:89,ri:164,up:23,lo:10,hs:10,vs:10,sync:0,vmode:0
54  */
55
56 static void mxs_lcd_init(struct udevice *dev, u32 fb_addr,
57                          struct display_timing *timings, int bpp)
58 {
59         struct mxs_lcdif_regs *regs = (struct mxs_lcdif_regs *)MXS_LCDIF_BASE;
60         const enum display_flags flags = timings->flags;
61         uint32_t word_len = 0, bus_width = 0;
62         uint8_t valid_data = 0;
63         uint32_t vdctrl0;
64
65 #if CONFIG_IS_ENABLED(CLK)
66         struct clk per_clk;
67         int ret;
68
69         ret = clk_get_by_name(dev, "per", &per_clk);
70         if (ret) {
71                 dev_err(dev, "Failed to get mxs clk: %d\n", ret);
72                 return;
73         }
74
75         ret = clk_set_rate(&per_clk, timings->pixelclock.typ);
76         if (ret < 0) {
77                 dev_err(dev, "Failed to set mxs clk: %d\n", ret);
78                 return;
79         }
80 #else
81         /* Kick in the LCDIF clock */
82         mxs_set_lcdclk(MXS_LCDIF_BASE, timings->pixelclock.typ / 1000);
83 #endif
84
85         /* Restart the LCDIF block */
86         mxs_reset_block(&regs->hw_lcdif_ctrl_reg);
87
88         switch (bpp) {
89         case 24:
90                 word_len = LCDIF_CTRL_WORD_LENGTH_24BIT;
91                 bus_width = LCDIF_CTRL_LCD_DATABUS_WIDTH_24BIT;
92                 valid_data = 0x7;
93                 break;
94         case 18:
95                 word_len = LCDIF_CTRL_WORD_LENGTH_24BIT;
96                 bus_width = LCDIF_CTRL_LCD_DATABUS_WIDTH_18BIT;
97                 valid_data = 0x7;
98                 break;
99         case 16:
100                 word_len = LCDIF_CTRL_WORD_LENGTH_16BIT;
101                 bus_width = LCDIF_CTRL_LCD_DATABUS_WIDTH_16BIT;
102                 valid_data = 0xf;
103                 break;
104         case 8:
105                 word_len = LCDIF_CTRL_WORD_LENGTH_8BIT;
106                 bus_width = LCDIF_CTRL_LCD_DATABUS_WIDTH_8BIT;
107                 valid_data = 0xf;
108                 break;
109         }
110
111         writel(bus_width | word_len | LCDIF_CTRL_DOTCLK_MODE |
112                 LCDIF_CTRL_BYPASS_COUNT | LCDIF_CTRL_LCDIF_MASTER,
113                 &regs->hw_lcdif_ctrl);
114
115         writel(valid_data << LCDIF_CTRL1_BYTE_PACKING_FORMAT_OFFSET,
116                 &regs->hw_lcdif_ctrl1);
117
118         mxsfb_system_setup();
119
120         writel((timings->vactive.typ << LCDIF_TRANSFER_COUNT_V_COUNT_OFFSET) |
121                 timings->hactive.typ, &regs->hw_lcdif_transfer_count);
122
123         vdctrl0 = LCDIF_VDCTRL0_ENABLE_PRESENT | LCDIF_VDCTRL0_ENABLE_POL |
124                   LCDIF_VDCTRL0_VSYNC_PERIOD_UNIT |
125                   LCDIF_VDCTRL0_VSYNC_PULSE_WIDTH_UNIT |
126                   timings->vsync_len.typ;
127
128         if(flags & DISPLAY_FLAGS_HSYNC_HIGH)
129                 vdctrl0 |= LCDIF_VDCTRL0_HSYNC_POL;
130         if(flags & DISPLAY_FLAGS_VSYNC_HIGH)
131                 vdctrl0 |= LCDIF_VDCTRL0_VSYNC_POL;
132         if(flags & DISPLAY_FLAGS_PIXDATA_NEGEDGE)
133                 vdctrl0 |= LCDIF_VDCTRL0_DOTCLK_POL;
134         writel(vdctrl0, &regs->hw_lcdif_vdctrl0);
135         writel(timings->vback_porch.typ + timings->vfront_porch.typ +
136                 timings->vsync_len.typ + timings->vactive.typ,
137                 &regs->hw_lcdif_vdctrl1);
138         writel((timings->hsync_len.typ << LCDIF_VDCTRL2_HSYNC_PULSE_WIDTH_OFFSET) |
139                 (timings->hback_porch.typ + timings->hfront_porch.typ +
140                 timings->hsync_len.typ + timings->hactive.typ),
141                 &regs->hw_lcdif_vdctrl2);
142         writel(((timings->hback_porch.typ + timings->hsync_len.typ) <<
143                 LCDIF_VDCTRL3_HORIZONTAL_WAIT_CNT_OFFSET) |
144                 (timings->vback_porch.typ + timings->vsync_len.typ),
145                 &regs->hw_lcdif_vdctrl3);
146         writel((0 << LCDIF_VDCTRL4_DOTCLK_DLY_SEL_OFFSET) | timings->hactive.typ,
147                 &regs->hw_lcdif_vdctrl4);
148
149         writel(fb_addr, &regs->hw_lcdif_cur_buf);
150         writel(fb_addr, &regs->hw_lcdif_next_buf);
151
152         /* Flush FIFO first */
153         writel(LCDIF_CTRL1_FIFO_CLEAR, &regs->hw_lcdif_ctrl1_set);
154
155 #ifndef CONFIG_VIDEO_MXS_MODE_SYSTEM
156         /* Sync signals ON */
157         setbits_le32(&regs->hw_lcdif_vdctrl4, LCDIF_VDCTRL4_SYNC_SIGNALS_ON);
158 #endif
159
160         /* FIFO cleared */
161         writel(LCDIF_CTRL1_FIFO_CLEAR, &regs->hw_lcdif_ctrl1_clr);
162
163         /* RUN! */
164         writel(LCDIF_CTRL_RUN, &regs->hw_lcdif_ctrl_set);
165 }
166
167 static int mxs_probe_common(struct udevice *dev, struct display_timing *timings,
168                             int bpp, u32 fb)
169 {
170         /* Start framebuffer */
171         mxs_lcd_init(dev, fb, timings, bpp);
172
173 #ifdef CONFIG_VIDEO_MXS_MODE_SYSTEM
174         /*
175          * If the LCD runs in system mode, the LCD refresh has to be triggered
176          * manually by setting the RUN bit in HW_LCDIF_CTRL register. To avoid
177          * having to set this bit manually after every single change in the
178          * framebuffer memory, we set up specially crafted circular DMA, which
179          * sets the RUN bit, then waits until it gets cleared and repeats this
180          * infinitelly. This way, we get smooth continuous updates of the LCD.
181          */
182         struct mxs_lcdif_regs *regs = (struct mxs_lcdif_regs *)MXS_LCDIF_BASE;
183
184         memset(&desc, 0, sizeof(struct mxs_dma_desc));
185         desc.address = (dma_addr_t)&desc;
186         desc.cmd.data = MXS_DMA_DESC_COMMAND_NO_DMAXFER | MXS_DMA_DESC_CHAIN |
187                         MXS_DMA_DESC_WAIT4END |
188                         (1 << MXS_DMA_DESC_PIO_WORDS_OFFSET);
189         desc.cmd.pio_words[0] = readl(&regs->hw_lcdif_ctrl) | LCDIF_CTRL_RUN;
190         desc.cmd.next = (uint32_t)&desc.cmd;
191
192         /* Execute the DMA chain. */
193         mxs_dma_circ_start(MXS_DMA_CHANNEL_AHB_APBH_LCDIF, &desc);
194 #endif
195
196         return 0;
197 }
198
199 static int mxs_remove_common(u32 fb)
200 {
201         struct mxs_lcdif_regs *regs = (struct mxs_lcdif_regs *)MXS_LCDIF_BASE;
202         int timeout = 1000000;
203
204         if (!fb)
205                 return -EINVAL;
206
207         writel(fb, &regs->hw_lcdif_cur_buf_reg);
208         writel(fb, &regs->hw_lcdif_next_buf_reg);
209         writel(LCDIF_CTRL1_VSYNC_EDGE_IRQ, &regs->hw_lcdif_ctrl1_clr);
210         while (--timeout) {
211                 if (readl(&regs->hw_lcdif_ctrl1_reg) &
212                     LCDIF_CTRL1_VSYNC_EDGE_IRQ)
213                         break;
214                 udelay(1);
215         }
216         mxs_reset_block((struct mxs_register_32 *)&regs->hw_lcdif_ctrl_reg);
217
218         return 0;
219 }
220
221 #ifndef CONFIG_DM_VIDEO
222
223 static GraphicDevice panel;
224
225 void lcdif_power_down(void)
226 {
227         mxs_remove_common(panel.frameAdrs);
228 }
229
230 void *video_hw_init(void)
231 {
232         int bpp = -1;
233         int ret = 0;
234         char *penv;
235         void *fb = NULL;
236         struct ctfb_res_modes mode;
237         struct display_timing timings;
238
239         puts("Video: ");
240
241         /* Suck display configuration from "videomode" variable */
242         penv = env_get("videomode");
243         if (!penv) {
244                 puts("MXSFB: 'videomode' variable not set!\n");
245                 return NULL;
246         }
247
248         bpp = video_get_params(&mode, penv);
249
250         /* fill in Graphic device struct */
251         sprintf(panel.modeIdent, "%dx%dx%d", mode.xres, mode.yres, bpp);
252
253         panel.winSizeX = mode.xres;
254         panel.winSizeY = mode.yres;
255         panel.plnSizeX = mode.xres;
256         panel.plnSizeY = mode.yres;
257
258         switch (bpp) {
259         case 24:
260         case 18:
261                 panel.gdfBytesPP = 4;
262                 panel.gdfIndex = GDF_32BIT_X888RGB;
263                 break;
264         case 16:
265                 panel.gdfBytesPP = 2;
266                 panel.gdfIndex = GDF_16BIT_565RGB;
267                 break;
268         case 8:
269                 panel.gdfBytesPP = 1;
270                 panel.gdfIndex = GDF__8BIT_INDEX;
271                 break;
272         default:
273                 printf("MXSFB: Invalid BPP specified! (bpp = %i)\n", bpp);
274                 return NULL;
275         }
276
277         panel.memSize = mode.xres * mode.yres * panel.gdfBytesPP;
278
279         /* Allocate framebuffer */
280         fb = memalign(ARCH_DMA_MINALIGN,
281                       roundup(panel.memSize, ARCH_DMA_MINALIGN));
282         if (!fb) {
283                 printf("MXSFB: Error allocating framebuffer!\n");
284                 return NULL;
285         }
286
287         /* Wipe framebuffer */
288         memset(fb, 0, panel.memSize);
289
290         panel.frameAdrs = (u32)fb;
291
292         printf("%s\n", panel.modeIdent);
293
294         video_ctfb_mode_to_display_timing(&mode, &timings);
295
296         ret = mxs_probe_common(NULL, &timings, bpp, (u32)fb);
297         if (ret)
298                 goto dealloc_fb;
299
300         return (void *)&panel;
301
302 dealloc_fb:
303         free(fb);
304
305         return NULL;
306 }
307 #else /* ifndef CONFIG_DM_VIDEO */
308
309 static int mxs_of_get_timings(struct udevice *dev,
310                               struct display_timing *timings,
311                               u32 *bpp)
312 {
313         int ret = 0;
314         u32 display_phandle;
315         ofnode display_node;
316
317         ret = ofnode_read_u32(dev_ofnode(dev), "display", &display_phandle);
318         if (ret) {
319                 dev_err(dev, "required display property isn't provided\n");
320                 return -EINVAL;
321         }
322
323         display_node = ofnode_get_by_phandle(display_phandle);
324         if (!ofnode_valid(display_node)) {
325                 dev_err(dev, "failed to find display subnode\n");
326                 return -EINVAL;
327         }
328
329         ret = ofnode_read_u32(display_node, "bits-per-pixel", bpp);
330         if (ret) {
331                 dev_err(dev,
332                         "required bits-per-pixel property isn't provided\n");
333                 return -EINVAL;
334         }
335
336         ret = ofnode_decode_display_timing(display_node, 0, timings);
337         if (ret) {
338                 dev_err(dev, "failed to get any display timings\n");
339                 return -EINVAL;
340         }
341
342         return ret;
343 }
344
345 static int mxs_video_probe(struct udevice *dev)
346 {
347         struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
348         struct video_priv *uc_priv = dev_get_uclass_priv(dev);
349
350         struct display_timing timings;
351         u32 bpp = 0;
352         u32 fb_start, fb_end;
353         int ret;
354
355         debug("%s() plat: base 0x%lx, size 0x%x\n",
356                __func__, plat->base, plat->size);
357
358         ret = mxs_of_get_timings(dev, &timings, &bpp);
359         if (ret)
360                 return ret;
361
362         ret = mxs_probe_common(dev, &timings, bpp, plat->base);
363         if (ret)
364                 return ret;
365
366         switch (bpp) {
367         case 32:
368         case 24:
369         case 18:
370                 uc_priv->bpix = VIDEO_BPP32;
371                 break;
372         case 16:
373                 uc_priv->bpix = VIDEO_BPP16;
374                 break;
375         case 8:
376                 uc_priv->bpix = VIDEO_BPP8;
377                 break;
378         default:
379                 dev_err(dev, "invalid bpp specified (bpp = %i)\n", bpp);
380                 return -EINVAL;
381         }
382
383         uc_priv->xsize = timings.hactive.typ;
384         uc_priv->ysize = timings.vactive.typ;
385
386         /* Enable dcache for the frame buffer */
387         fb_start = plat->base & ~(MMU_SECTION_SIZE - 1);
388         fb_end = plat->base + plat->size;
389         fb_end = ALIGN(fb_end, 1 << MMU_SECTION_SHIFT);
390         mmu_set_region_dcache_behaviour(fb_start, fb_end - fb_start,
391                                         DCACHE_WRITEBACK);
392         video_set_flush_dcache(dev, true);
393         gd->fb_base = plat->base;
394
395         return ret;
396 }
397
398 static int mxs_video_bind(struct udevice *dev)
399 {
400         struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
401         struct display_timing timings;
402         u32 bpp = 0;
403         u32 bytes_pp = 0;
404         int ret;
405
406         ret = mxs_of_get_timings(dev, &timings, &bpp);
407         if (ret)
408                 return ret;
409
410         switch (bpp) {
411         case 32:
412         case 24:
413         case 18:
414                 bytes_pp = 4;
415                 break;
416         case 16:
417                 bytes_pp = 2;
418                 break;
419         case 8:
420                 bytes_pp = 1;
421                 break;
422         default:
423                 dev_err(dev, "invalid bpp specified (bpp = %i)\n", bpp);
424                 return -EINVAL;
425         }
426
427         plat->size = timings.hactive.typ * timings.vactive.typ * bytes_pp;
428
429         return 0;
430 }
431
432 static int mxs_video_remove(struct udevice *dev)
433 {
434         struct video_uc_platdata *plat = dev_get_uclass_platdata(dev);
435
436         mxs_remove_common(plat->base);
437
438         return 0;
439 }
440
441 static const struct udevice_id mxs_video_ids[] = {
442         { .compatible = "fsl,imx23-lcdif" },
443         { .compatible = "fsl,imx28-lcdif" },
444         { .compatible = "fsl,imx7ulp-lcdif" },
445         { .compatible = "fsl,imxrt-lcdif" },
446         { /* sentinel */ }
447 };
448
449 U_BOOT_DRIVER(mxs_video) = {
450         .name   = "mxs_video",
451         .id     = UCLASS_VIDEO,
452         .of_match = mxs_video_ids,
453         .bind   = mxs_video_bind,
454         .probe  = mxs_video_probe,
455         .remove = mxs_video_remove,
456         .flags  = DM_FLAG_PRE_RELOC | DM_FLAG_OS_PREPARE,
457 };
458 #endif /* ifndef CONFIG_DM_VIDEO */