drivers/video/stm32/stm32_ltdc.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2017-2018 STMicroelectronics - All Rights Reserved
   4  * Author(s): Philippe Cornu <philippe.cornu@st.com> for STMicroelectronics.
   5  *            Yannick Fertre <yannick.fertre@st.com> for STMicroelectronics.
   6  */
   7
   8 #define LOG_CATEGORY UCLASS_VIDEO
   9
  10 #include <common.h>
  11 #include <clk.h>
  12 #include <display.h>
  13 #include <dm.h>
  14 #include <log.h>
  15 #include <panel.h>
  16 #include <reset.h>
  17 #include <video.h>
  18 #include <video_bridge.h>
  19 #include <asm/io.h>
  20 #include <dm/device-internal.h>
  21 #include <dm/device_compat.h>
  22 #include <linux/bitops.h>
  23
  24 struct stm32_ltdc_priv {
  25         void __iomem *regs;
  26         enum video_log2_bpp l2bpp;
  27         u32 bg_col_argb;
  28         u32 crop_x, crop_y, crop_w, crop_h;
  29         u32 alpha;
  30 };
  31
  32 /* LTDC main registers */
  33 #define LTDC_IDR        0x00    /* IDentification */
  34 #define LTDC_LCR        0x04    /* Layer Count */
  35 #define LTDC_SSCR       0x08    /* Synchronization Size Configuration */
  36 #define LTDC_BPCR       0x0C    /* Back Porch Configuration */
  37 #define LTDC_AWCR       0x10    /* Active Width Configuration */
  38 #define LTDC_TWCR       0x14    /* Total Width Configuration */
  39 #define LTDC_GCR        0x18    /* Global Control */
  40 #define LTDC_GC1R       0x1C    /* Global Configuration 1 */
  41 #define LTDC_GC2R       0x20    /* Global Configuration 2 */
  42 #define LTDC_SRCR       0x24    /* Shadow Reload Configuration */
  43 #define LTDC_GACR       0x28    /* GAmma Correction */
  44 #define LTDC_BCCR       0x2C    /* Background Color Configuration */
  45 #define LTDC_IER        0x34    /* Interrupt Enable */
  46 #define LTDC_ISR        0x38    /* Interrupt Status */
  47 #define LTDC_ICR        0x3C    /* Interrupt Clear */
  48 #define LTDC_LIPCR      0x40    /* Line Interrupt Position Conf. */
  49 #define LTDC_CPSR       0x44    /* Current Position Status */
  50 #define LTDC_CDSR       0x48    /* Current Display Status */
  51
  52 /* LTDC layer 1 registers */
  53 #define LTDC_L1LC1R     0x80    /* L1 Layer Configuration 1 */
  54 #define LTDC_L1LC2R     0x84    /* L1 Layer Configuration 2 */
  55 #define LTDC_L1CR       0x84    /* L1 Control */
  56 #define LTDC_L1WHPCR    0x88    /* L1 Window Hor Position Config */
  57 #define LTDC_L1WVPCR    0x8C    /* L1 Window Vert Position Config */
  58 #define LTDC_L1CKCR     0x90    /* L1 Color Keying Configuration */
  59 #define LTDC_L1PFCR     0x94    /* L1 Pixel Format Configuration */
  60 #define LTDC_L1CACR     0x98    /* L1 Constant Alpha Config */
  61 #define LTDC_L1DCCR     0x9C    /* L1 Default Color Configuration */
  62 #define LTDC_L1BFCR     0xA0    /* L1 Blend Factors Configuration */
  63 #define LTDC_L1FBBCR    0xA4    /* L1 FrameBuffer Bus Control */
  64 #define LTDC_L1AFBCR    0xA8    /* L1 AuxFB Control */
  65 #define LTDC_L1CFBAR    0xAC    /* L1 Color FrameBuffer Address */
  66 #define LTDC_L1CFBLR    0xB0    /* L1 Color FrameBuffer Length */
  67 #define LTDC_L1CFBLNR   0xB4    /* L1 Color FrameBuffer Line Nb */
  68 #define LTDC_L1AFBAR    0xB8    /* L1 AuxFB Address */
  69 #define LTDC_L1AFBLR    0xBC    /* L1 AuxFB Length */
  70 #define LTDC_L1AFBLNR   0xC0    /* L1 AuxFB Line Number */
  71 #define LTDC_L1CLUTWR   0xC4    /* L1 CLUT Write */
  72
  73 /* Bit definitions */
  74 #define SSCR_VSH        GENMASK(10, 0)  /* Vertical Synchronization Height */
  75 #define SSCR_HSW        GENMASK(27, 16) /* Horizontal Synchronization Width */
  76
  77 #define BPCR_AVBP       GENMASK(10, 0)  /* Accumulated Vertical Back Porch */
  78 #define BPCR_AHBP       GENMASK(27, 16) /* Accumulated Horizontal Back Porch */
  79
  80 #define AWCR_AAH        GENMASK(10, 0)  /* Accumulated Active Height */
  81 #define AWCR_AAW        GENMASK(27, 16) /* Accumulated Active Width */
  82
  83 #define TWCR_TOTALH     GENMASK(10, 0)  /* TOTAL Height */
  84 #define TWCR_TOTALW     GENMASK(27, 16) /* TOTAL Width */
  85
  86 #define GCR_LTDCEN      BIT(0)          /* LTDC ENable */
  87 #define GCR_DEN         BIT(16)         /* Dither ENable */
  88 #define GCR_PCPOL       BIT(28)         /* Pixel Clock POLarity-Inverted */
  89 #define GCR_DEPOL       BIT(29)         /* Data Enable POLarity-High */
  90 #define GCR_VSPOL       BIT(30)         /* Vertical Synchro POLarity-High */
  91 #define GCR_HSPOL       BIT(31)         /* Horizontal Synchro POLarity-High */
  92
  93 #define GC1R_WBCH       GENMASK(3, 0)   /* Width of Blue CHannel output */
  94 #define GC1R_WGCH       GENMASK(7, 4)   /* Width of Green Channel output */
  95 #define GC1R_WRCH       GENMASK(11, 8)  /* Width of Red Channel output */
  96 #define GC1R_PBEN       BIT(12)         /* Precise Blending ENable */
  97 #define GC1R_DT         GENMASK(15, 14) /* Dithering Technique */
  98 #define GC1R_GCT        GENMASK(19, 17) /* Gamma Correction Technique */
  99 #define GC1R_SHREN      BIT(21)         /* SHadow Registers ENabled */
 100 #define GC1R_BCP        BIT(22)         /* Background Colour Programmable */
 101 #define GC1R_BBEN       BIT(23)         /* Background Blending ENabled */
 102 #define GC1R_LNIP       BIT(24)         /* Line Number IRQ Position */
 103 #define GC1R_TP         BIT(25)         /* Timing Programmable */
 104 #define GC1R_IPP        BIT(26)         /* IRQ Polarity Programmable */
 105 #define GC1R_SPP        BIT(27)         /* Sync Polarity Programmable */
 106 #define GC1R_DWP        BIT(28)         /* Dither Width Programmable */
 107 #define GC1R_STREN      BIT(29)         /* STatus Registers ENabled */
 108 #define GC1R_BMEN       BIT(31)         /* Blind Mode ENabled */
 109
 110 #define GC2R_EDCA       BIT(0)          /* External Display Control Ability  */
 111 #define GC2R_STSAEN     BIT(1)          /* Slave Timing Sync Ability ENabled */
 112 #define GC2R_DVAEN      BIT(2)          /* Dual-View Ability ENabled */
 113 #define GC2R_DPAEN      BIT(3)          /* Dual-Port Ability ENabled */
 114 #define GC2R_BW         GENMASK(6, 4)   /* Bus Width (log2 of nb of bytes) */
 115 #define GC2R_EDCEN      BIT(7)          /* External Display Control ENabled */
 116
 117 #define SRCR_IMR        BIT(0)          /* IMmediate Reload */
 118 #define SRCR_VBR        BIT(1)          /* Vertical Blanking Reload */
 119
 120 #define LXCR_LEN        BIT(0)          /* Layer ENable */
 121 #define LXCR_COLKEN     BIT(1)          /* Color Keying Enable */
 122 #define LXCR_CLUTEN     BIT(4)          /* Color Look-Up Table ENable */
 123
 124 #define LXWHPCR_WHSTPOS GENMASK(11, 0)  /* Window Horizontal StarT POSition */
 125 #define LXWHPCR_WHSPPOS GENMASK(27, 16) /* Window Horizontal StoP POSition */
 126
 127 #define LXWVPCR_WVSTPOS GENMASK(10, 0)  /* Window Vertical StarT POSition */
 128 #define LXWVPCR_WVSPPOS GENMASK(26, 16) /* Window Vertical StoP POSition */
 129
 130 #define LXPFCR_PF       GENMASK(2, 0)   /* Pixel Format */
 131
 132 #define LXCACR_CONSTA   GENMASK(7, 0)   /* CONSTant Alpha */
 133
 134 #define LXBFCR_BF2      GENMASK(2, 0)   /* Blending Factor 2 */
 135 #define LXBFCR_BF1      GENMASK(10, 8)  /* Blending Factor 1 */
 136
 137 #define LXCFBLR_CFBLL   GENMASK(12, 0)  /* Color Frame Buffer Line Length */
 138 #define LXCFBLR_CFBP    GENMASK(28, 16) /* Color Frame Buffer Pitch in bytes */
 139
 140 #define LXCFBLNR_CFBLN  GENMASK(10, 0)  /* Color Frame Buffer Line Number */
 141
 142 #define BF1_PAXCA       0x600           /* Pixel Alpha x Constant Alpha */
 143 #define BF1_CA          0x400           /* Constant Alpha */
 144 #define BF2_1PAXCA      0x007           /* 1 - (Pixel Alpha x Constant Alpha) */
 145 #define BF2_1CA         0x005           /* 1 - Constant Alpha */
 146
 147 enum stm32_ltdc_pix_fmt {
 148         PF_ARGB8888 = 0,
 149         PF_RGB888,
 150         PF_RGB565,
 151         PF_ARGB1555,
 152         PF_ARGB4444,
 153         PF_L8,
 154         PF_AL44,
 155         PF_AL88
 156 };
 157
 158 /* TODO add more color format support */
 159 static u32 stm32_ltdc_get_pixel_format(enum video_log2_bpp l2bpp)
 160 {
 161         enum stm32_ltdc_pix_fmt pf;
 162
 163         switch (l2bpp) {
 164         case VIDEO_BPP16:
 165                 pf = PF_RGB565;
 166                 break;
 167
 168         case VIDEO_BPP32:
 169                 pf = PF_ARGB8888;
 170                 break;
 171
 172         case VIDEO_BPP8:
 173                 pf = PF_L8;
 174                 break;
 175
 176         case VIDEO_BPP1:
 177         case VIDEO_BPP2:
 178         case VIDEO_BPP4:
 179         default:
 180                 log_warning("warning %dbpp not supported yet, %dbpp instead\n",
 181                             VNBITS(l2bpp), VNBITS(VIDEO_BPP16));
 182                 pf = PF_RGB565;
 183                 break;
 184         }
 185
 186         log_debug("%d bpp -> ltdc pf %d\n", VNBITS(l2bpp), pf);
 187
 188         return (u32)pf;
 189 }
 190
 191 static bool has_alpha(u32 fmt)
 192 {
 193         switch (fmt) {
 194         case PF_ARGB8888:
 195         case PF_ARGB1555:
 196         case PF_ARGB4444:
 197         case PF_AL44:
 198         case PF_AL88:
 199                 return true;
 200         case PF_RGB888:
 201         case PF_RGB565:
 202         case PF_L8:
 203         default:
 204                 return false;
 205         }
 206 }
 207
 208 static void stm32_ltdc_enable(struct stm32_ltdc_priv *priv)
 209 {
 210         /* Reload configuration immediately & enable LTDC */
 211         setbits_le32(priv->regs + LTDC_SRCR, SRCR_IMR);
 212         setbits_le32(priv->regs + LTDC_GCR, GCR_LTDCEN);
 213 }
 214
 215 static void stm32_ltdc_set_mode(struct stm32_ltdc_priv *priv,
 216                                 struct display_timing *timings)
 217 {
 218         void __iomem *regs = priv->regs;
 219         u32 hsync, vsync, acc_hbp, acc_vbp, acc_act_w, acc_act_h;
 220         u32 total_w, total_h;
 221         u32 val;
 222
 223         /* Convert video timings to ltdc timings */
 224         hsync = timings->hsync_len.typ - 1;
 225         vsync = timings->vsync_len.typ - 1;
 226         acc_hbp = hsync + timings->hback_porch.typ;
 227         acc_vbp = vsync + timings->vback_porch.typ;
 228         acc_act_w = acc_hbp + timings->hactive.typ;
 229         acc_act_h = acc_vbp + timings->vactive.typ;
 230         total_w = acc_act_w + timings->hfront_porch.typ;
 231         total_h = acc_act_h + timings->vfront_porch.typ;
 232
 233         /* Synchronization sizes */
 234         val = (hsync << 16) | vsync;
 235         clrsetbits_le32(regs + LTDC_SSCR, SSCR_VSH | SSCR_HSW, val);
 236
 237         /* Accumulated back porch */
 238         val = (acc_hbp << 16) | acc_vbp;
 239         clrsetbits_le32(regs + LTDC_BPCR, BPCR_AVBP | BPCR_AHBP, val);
 240
 241         /* Accumulated active width */
 242         val = (acc_act_w << 16) | acc_act_h;
 243         clrsetbits_le32(regs + LTDC_AWCR, AWCR_AAW | AWCR_AAH, val);
 244
 245         /* Total width & height */
 246         val = (total_w << 16) | total_h;
 247         clrsetbits_le32(regs + LTDC_TWCR, TWCR_TOTALH | TWCR_TOTALW, val);
 248
 249         setbits_le32(regs + LTDC_LIPCR, acc_act_h + 1);
 250
 251         /* Signal polarities */
 252         val = 0;
 253         log_debug("timing->flags 0x%08x\n", timings->flags);
 254         if (timings->flags & DISPLAY_FLAGS_HSYNC_HIGH)
 255                 val |= GCR_HSPOL;
 256         if (timings->flags & DISPLAY_FLAGS_VSYNC_HIGH)
 257                 val |= GCR_VSPOL;
 258         if (timings->flags & DISPLAY_FLAGS_DE_HIGH)
 259                 val |= GCR_DEPOL;
 260         if (timings->flags & DISPLAY_FLAGS_PIXDATA_NEGEDGE)
 261                 val |= GCR_PCPOL;
 262         clrsetbits_le32(regs + LTDC_GCR,
 263                         GCR_HSPOL | GCR_VSPOL | GCR_DEPOL | GCR_PCPOL, val);
 264
 265         /* Overall background color */
 266         writel(priv->bg_col_argb, priv->regs + LTDC_BCCR);
 267 }
 268
 269 static void stm32_ltdc_set_layer1(struct stm32_ltdc_priv *priv, ulong fb_addr)
 270 {
 271         void __iomem *regs = priv->regs;
 272         u32 x0, x1, y0, y1;
 273         u32 pitch_in_bytes;
 274         u32 line_length;
 275         u32 bus_width;
 276         u32 val, tmp, bpp;
 277         u32 format;
 278
 279         x0 = priv->crop_x;
 280         x1 = priv->crop_x + priv->crop_w - 1;
 281         y0 = priv->crop_y;
 282         y1 = priv->crop_y + priv->crop_h - 1;
 283
 284         /* Horizontal start and stop position */
 285         tmp = (readl(regs + LTDC_BPCR) & BPCR_AHBP) >> 16;
 286         val = ((x1 + 1 + tmp) << 16) + (x0 + 1 + tmp);
 287         clrsetbits_le32(regs + LTDC_L1WHPCR, LXWHPCR_WHSTPOS | LXWHPCR_WHSPPOS,
 288                         val);
 289
 290         /* Vertical start & stop position */
 291         tmp = readl(regs + LTDC_BPCR) & BPCR_AVBP;
 292         val = ((y1 + 1 + tmp) << 16) + (y0 + 1 + tmp);
 293         clrsetbits_le32(regs + LTDC_L1WVPCR, LXWVPCR_WVSTPOS | LXWVPCR_WVSPPOS,
 294                         val);
 295
 296         /* Layer background color */
 297         writel(priv->bg_col_argb, regs + LTDC_L1DCCR);
 298
 299         /* Color frame buffer pitch in bytes & line length */
 300         bpp = VNBITS(priv->l2bpp);
 301         pitch_in_bytes = priv->crop_w * (bpp >> 3);
 302         bus_width = 8 << ((readl(regs + LTDC_GC2R) & GC2R_BW) >> 4);
 303         line_length = ((bpp >> 3) * priv->crop_w) + (bus_width >> 3) - 1;
 304         val = (pitch_in_bytes << 16) | line_length;
 305         clrsetbits_le32(regs + LTDC_L1CFBLR, LXCFBLR_CFBLL | LXCFBLR_CFBP, val);
 306
 307         /* Pixel format */
 308         format = stm32_ltdc_get_pixel_format(priv->l2bpp);
 309         clrsetbits_le32(regs + LTDC_L1PFCR, LXPFCR_PF, format);
 310
 311         /* Constant alpha value */
 312         clrsetbits_le32(regs + LTDC_L1CACR, LXCACR_CONSTA, priv->alpha);
 313
 314         /* Specifies the blending factors : with or without pixel alpha */
 315         /* Manage hw-specific capabilities */
 316         val = has_alpha(format) ? BF1_PAXCA | BF2_1PAXCA : BF1_CA | BF2_1CA;
 317
 318         /* Blending factors */
 319         clrsetbits_le32(regs + LTDC_L1BFCR, LXBFCR_BF2 | LXBFCR_BF1, val);
 320
 321         /* Frame buffer line number */
 322         clrsetbits_le32(regs + LTDC_L1CFBLNR, LXCFBLNR_CFBLN, priv->crop_h);
 323
 324         /* Frame buffer address */
 325         writel(fb_addr, regs + LTDC_L1CFBAR);
 326
 327         /* Enable layer 1 */
 328         setbits_le32(priv->regs + LTDC_L1CR, LXCR_LEN);
 329 }
 330
 331 static int stm32_ltdc_probe(struct udevice *dev)
 332 {
 333         struct video_uc_plat *uc_plat = dev_get_uclass_plat(dev);
 334         struct video_priv *uc_priv = dev_get_uclass_priv(dev);
 335         struct stm32_ltdc_priv *priv = dev_get_priv(dev);
 336         struct udevice *bridge = NULL;
 337         struct udevice *panel = NULL;
 338         struct display_timing timings;
 339         struct clk pclk;
 340         struct reset_ctl rst;
 341         int ret;
 342
 343         priv->regs = (void *)dev_read_addr(dev);
 344         if ((fdt_addr_t)priv->regs == FDT_ADDR_T_NONE) {
 345                 dev_err(dev, "ltdc dt register address error\n");
 346                 return -EINVAL;
 347         }
 348
 349         ret = clk_get_by_index(dev, 0, &pclk);
 350         if (ret) {
 351                 dev_err(dev, "peripheral clock get error %d\n", ret);
 352                 return ret;
 353         }
 354
 355         ret = clk_enable(&pclk);
 356         if (ret) {
 357                 dev_err(dev, "peripheral clock enable error %d\n", ret);
 358                 return ret;
 359         }
 360
 361         ret = uclass_first_device_err(UCLASS_PANEL, &panel);
 362         if (ret) {
 363                 if (ret != -ENODEV)
 364                         dev_err(dev, "panel device error %d\n", ret);
 365                 return ret;
 366         }
 367
 368         ret = panel_get_display_timing(panel, &timings);
 369         if (ret) {
 370                 ret = ofnode_decode_display_timing(dev_ofnode(panel),
 371                                                    0, &timings);
 372                 if (ret) {
 373                         dev_err(dev, "decode display timing error %d\n", ret);
 374                         return ret;
 375                 }
 376         }
 377
 378         ret = clk_set_rate(&pclk, timings.pixelclock.typ);
 379         if (ret)
 380                 dev_warn(dev, "fail to set pixel clock %d hz\n",
 381                          timings.pixelclock.typ);
 382
 383         dev_dbg(dev, "Set pixel clock req %d hz get %ld hz\n",
 384                 timings.pixelclock.typ, clk_get_rate(&pclk));
 385
 386         ret = reset_get_by_index(dev, 0, &rst);
 387         if (ret) {
 388                 dev_err(dev, "missing ltdc hardware reset\n");
 389                 return ret;
 390         }
 391
 392         /* Reset */
 393         reset_deassert(&rst);
 394
 395         if (IS_ENABLED(CONFIG_VIDEO_BRIDGE)) {
 396                 ret = uclass_get_device(UCLASS_VIDEO_BRIDGE, 0, &bridge);
 397                 if (ret)
 398                         dev_dbg(dev,
 399                                 "No video bridge, or no backlight on bridge\n");
 400
 401                 if (bridge) {
 402                         ret = video_bridge_attach(bridge);
 403                         if (ret) {
 404                                 dev_err(bridge, "fail to attach bridge\n");
 405                                 return ret;
 406                         }
 407                 }
 408         }
 409
 410         /* TODO Below parameters are hard-coded for the moment... */
 411         priv->l2bpp = VIDEO_BPP16;
 412         priv->bg_col_argb = 0xFFFFFFFF; /* white no transparency */
 413         priv->crop_x = 0;
 414         priv->crop_y = 0;
 415         priv->crop_w = timings.hactive.typ;
 416         priv->crop_h = timings.vactive.typ;
 417         priv->alpha = 0xFF;
 418
 419         dev_dbg(dev, "%dx%d %dbpp frame buffer at 0x%lx\n",
 420                 timings.hactive.typ, timings.vactive.typ,
 421                 VNBITS(priv->l2bpp), uc_plat->base);
 422         dev_dbg(dev, "crop %d,%d %dx%d bg 0x%08x alpha %d\n",
 423                 priv->crop_x, priv->crop_y, priv->crop_w, priv->crop_h,
 424                 priv->bg_col_argb, priv->alpha);
 425
 426         /* Configure & start LTDC */
 427         stm32_ltdc_set_mode(priv, &timings);
 428         stm32_ltdc_set_layer1(priv, uc_plat->base);
 429         stm32_ltdc_enable(priv);
 430
 431         uc_priv->xsize = timings.hactive.typ;
 432         uc_priv->ysize = timings.vactive.typ;
 433         uc_priv->bpix = priv->l2bpp;
 434
 435         if (!bridge) {
 436                 ret = panel_enable_backlight(panel);
 437                 if (ret) {
 438                         dev_err(dev, "panel %s enable backlight error %d\n",
 439                                 panel->name, ret);
 440                         return ret;
 441                 }
 442         } else if (IS_ENABLED(CONFIG_VIDEO_BRIDGE)) {
 443                 ret = video_bridge_set_backlight(bridge, 80);
 444                 if (ret) {
 445                         dev_err(dev, "fail to set backlight\n");
 446                         return ret;
 447                 }
 448         }
 449
 450         video_set_flush_dcache(dev, true);
 451
 452         return 0;
 453 }
 454
 455 static int stm32_ltdc_bind(struct udevice *dev)
 456 {
 457         struct video_uc_plat *uc_plat = dev_get_uclass_plat(dev);
 458
 459         uc_plat->size = CONFIG_VIDEO_STM32_MAX_XRES *
 460                         CONFIG_VIDEO_STM32_MAX_YRES *
 461                         (CONFIG_VIDEO_STM32_MAX_BPP >> 3);
 462         dev_dbg(dev, "frame buffer max size %d bytes\n", uc_plat->size);
 463
 464         return 0;
 465 }
 466
 467 static const struct udevice_id stm32_ltdc_ids[] = {
 468         { .compatible = "st,stm32-ltdc" },
 469         { }
 470 };
 471
 472 U_BOOT_DRIVER(stm32_ltdc) = {
 473         .name                   = "stm32_display",
 474         .id                     = UCLASS_VIDEO,
 475         .of_match               = stm32_ltdc_ids,
 476         .probe                  = stm32_ltdc_probe,
 477         .bind                   = stm32_ltdc_bind,
 478         .priv_auto      = sizeof(struct stm32_ltdc_priv),
 479 };