drivers/gpu/drm/meson/meson_plane.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * Copyright (C) 2016 BayLibre, SAS
   4  * Author: Neil Armstrong <[email protected]>
   5  * Copyright (C) 2015 Amlogic, Inc. All rights reserved.
   6  * Copyright (C) 2014 Endless Mobile
   7  *
   8  * Written by:
   9  *     Jasper St. Pierre <[email protected]>
  10  */
  11
  12 #include <linux/bitfield.h>
  13
  14 #include <drm/drm_atomic.h>
  15 #include <drm/drm_atomic_helper.h>
  16 #include <drm/drm_device.h>
  17 #include <drm/drm_fb_cma_helper.h>
  18 #include <drm/drm_fourcc.h>
  19 #include <drm/drm_gem_cma_helper.h>
  20 #include <drm/drm_gem_framebuffer_helper.h>
  21 #include <drm/drm_plane_helper.h>
  22
  23 #include "meson_plane.h"
  24 #include "meson_registers.h"
  25 #include "meson_viu.h"
  26
  27 /* OSD_SCI_WH_M1 */
  28 #define SCI_WH_M1_W(w)                  FIELD_PREP(GENMASK(28, 16), w)
  29 #define SCI_WH_M1_H(h)                  FIELD_PREP(GENMASK(12, 0), h)
  30
  31 /* OSD_SCO_H_START_END */
  32 /* OSD_SCO_V_START_END */
  33 #define SCO_HV_START(start)             FIELD_PREP(GENMASK(27, 16), start)
  34 #define SCO_HV_END(end)                 FIELD_PREP(GENMASK(11, 0), end)
  35
  36 /* OSD_SC_CTRL0 */
  37 #define SC_CTRL0_PATH_EN                BIT(3)
  38 #define SC_CTRL0_SEL_OSD1               BIT(2)
  39
  40 /* OSD_VSC_CTRL0 */
  41 #define VSC_BANK_LEN(value)             FIELD_PREP(GENMASK(2, 0), value)
  42 #define VSC_TOP_INI_RCV_NUM(value)      FIELD_PREP(GENMASK(6, 3), value)
  43 #define VSC_TOP_RPT_L0_NUM(value)       FIELD_PREP(GENMASK(9, 8), value)
  44 #define VSC_BOT_INI_RCV_NUM(value)      FIELD_PREP(GENMASK(14, 11), value)
  45 #define VSC_BOT_RPT_L0_NUM(value)       FIELD_PREP(GENMASK(17, 16), value)
  46 #define VSC_PROG_INTERLACE              BIT(23)
  47 #define VSC_VERTICAL_SCALER_EN          BIT(24)
  48
  49 /* OSD_VSC_INI_PHASE */
  50 #define VSC_INI_PHASE_BOT(bottom)       FIELD_PREP(GENMASK(31, 16), bottom)
  51 #define VSC_INI_PHASE_TOP(top)          FIELD_PREP(GENMASK(15, 0), top)
  52
  53 /* OSD_HSC_CTRL0 */
  54 #define HSC_BANK_LENGTH(value)          FIELD_PREP(GENMASK(2, 0), value)
  55 #define HSC_INI_RCV_NUM0(value)         FIELD_PREP(GENMASK(6, 3), value)
  56 #define HSC_RPT_P0_NUM0(value)          FIELD_PREP(GENMASK(9, 8), value)
  57 #define HSC_HORIZ_SCALER_EN             BIT(22)
  58
  59 /* VPP_OSD_VSC_PHASE_STEP */
  60 /* VPP_OSD_HSC_PHASE_STEP */
  61 #define SC_PHASE_STEP(value)            FIELD_PREP(GENMASK(27, 0), value)
  62
  63 struct meson_plane {
  64         struct drm_plane base;
  65         struct meson_drm *priv;
  66         bool enabled;
  67 };
  68 #define to_meson_plane(x) container_of(x, struct meson_plane, base)
  69
  70 #define FRAC_16_16(mult, div)    (((mult) << 16) / (div))
  71
  72 static int meson_plane_atomic_check(struct drm_plane *plane,
  73                                     struct drm_plane_state *state)
  74 {
  75         struct drm_crtc_state *crtc_state;
  76
  77         if (!state->crtc)
  78                 return 0;
  79
  80         crtc_state = drm_atomic_get_crtc_state(state->state, state->crtc);
  81         if (IS_ERR(crtc_state))
  82                 return PTR_ERR(crtc_state);
  83
  84         /*
  85          * Only allow :
  86          * - Upscaling up to 5x, vertical and horizontal
  87          * - Final coordinates must match crtc size
  88          */
  89         return drm_atomic_helper_check_plane_state(state, crtc_state,
  90                                                    FRAC_16_16(1, 5),
  91                                                    DRM_PLANE_HELPER_NO_SCALING,
  92                                                    false, true);
  93 }
  94
  95 /* Takes a fixed 16.16 number and converts it to integer. */
  96 static inline int64_t fixed16_to_int(int64_t value)
  97 {
  98         return value >> 16;
  99 }
 100
 101 static void meson_plane_atomic_update(struct drm_plane *plane,
 102                                       struct drm_plane_state *old_state)
 103 {
 104         struct meson_plane *meson_plane = to_meson_plane(plane);
 105         struct drm_plane_state *state = plane->state;
 106         struct drm_rect dest = drm_plane_state_dest(state);
 107         struct meson_drm *priv = meson_plane->priv;
 108         struct drm_framebuffer *fb = state->fb;
 109         struct drm_gem_cma_object *gem;
 110         unsigned long flags;
 111         int vsc_ini_rcv_num, vsc_ini_rpt_p0_num;
 112         int vsc_bot_rcv_num, vsc_bot_rpt_p0_num;
 113         int hsc_ini_rcv_num, hsc_ini_rpt_p0_num;
 114         int hf_phase_step, vf_phase_step;
 115         int src_w, src_h, dst_w, dst_h;
 116         int bot_ini_phase;
 117         int hf_bank_len;
 118         int vf_bank_len;
 119         u8 canvas_id_osd1;
 120
 121         /*
 122          * Update Coordinates
 123          * Update Formats
 124          * Update Buffer
 125          * Enable Plane
 126          */
 127         spin_lock_irqsave(&priv->drm->event_lock, flags);
 128
 129         /* Enable OSD and BLK0, set max global alpha */
 130         priv->viu.osd1_ctrl_stat = OSD_ENABLE |
 131                                    (0xFF << OSD_GLOBAL_ALPHA_SHIFT) |
 132                                    OSD_BLK0_ENABLE;
 133
 134         canvas_id_osd1 = priv->canvas_id_osd1;
 135
 136         /* Set up BLK0 to point to the right canvas */
 137         priv->viu.osd1_blk0_cfg[0] = ((canvas_id_osd1 << OSD_CANVAS_SEL) |
 138                                       OSD_ENDIANNESS_LE);
 139
 140         /* On GXBB, Use the old non-HDR RGB2YUV converter */
 141         if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXBB))
 142                 priv->viu.osd1_blk0_cfg[0] |= OSD_OUTPUT_COLOR_RGB;
 143
 144         switch (fb->format->format) {
 145         case DRM_FORMAT_XRGB8888:
 146                 /* For XRGB, replace the pixel's alpha by 0xFF */
 147                 writel_bits_relaxed(OSD_REPLACE_EN, OSD_REPLACE_EN,
 148                                     priv->io_base + _REG(VIU_OSD1_CTRL_STAT2));
 149                 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_32 |
 150                                               OSD_COLOR_MATRIX_32_ARGB;
 151                 break;
 152         case DRM_FORMAT_XBGR8888:
 153                 /* For XRGB, replace the pixel's alpha by 0xFF */
 154                 writel_bits_relaxed(OSD_REPLACE_EN, OSD_REPLACE_EN,
 155                                     priv->io_base + _REG(VIU_OSD1_CTRL_STAT2));
 156                 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_32 |
 157                                               OSD_COLOR_MATRIX_32_ABGR;
 158                 break;
 159         case DRM_FORMAT_ARGB8888:
 160                 /* For ARGB, use the pixel's alpha */
 161                 writel_bits_relaxed(OSD_REPLACE_EN, 0,
 162                                     priv->io_base + _REG(VIU_OSD1_CTRL_STAT2));
 163                 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_32 |
 164                                               OSD_COLOR_MATRIX_32_ARGB;
 165                 break;
 166         case DRM_FORMAT_ABGR8888:
 167                 /* For ARGB, use the pixel's alpha */
 168                 writel_bits_relaxed(OSD_REPLACE_EN, 0,
 169                                     priv->io_base + _REG(VIU_OSD1_CTRL_STAT2));
 170                 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_32 |
 171                                               OSD_COLOR_MATRIX_32_ABGR;
 172                 break;
 173         case DRM_FORMAT_RGB888:
 174                 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_24 |
 175                                               OSD_COLOR_MATRIX_24_RGB;
 176                 break;
 177         case DRM_FORMAT_RGB565:
 178                 priv->viu.osd1_blk0_cfg[0] |= OSD_BLK_MODE_16 |
 179                                               OSD_COLOR_MATRIX_16_RGB565;
 180                 break;
 181         };
 182
 183         /* Default scaler parameters */
 184         vsc_bot_rcv_num = 0;
 185         vsc_bot_rpt_p0_num = 0;
 186         hf_bank_len = 4;
 187         vf_bank_len = 4;
 188
 189         if (state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE) {
 190                 vsc_bot_rcv_num = 6;
 191                 vsc_bot_rpt_p0_num = 2;
 192         }
 193
 194         hsc_ini_rcv_num = hf_bank_len;
 195         vsc_ini_rcv_num = vf_bank_len;
 196         hsc_ini_rpt_p0_num = (hf_bank_len / 2) - 1;
 197         vsc_ini_rpt_p0_num = (vf_bank_len / 2) - 1;
 198
 199         src_w = fixed16_to_int(state->src_w);
 200         src_h = fixed16_to_int(state->src_h);
 201         dst_w = state->crtc_w;
 202         dst_h = state->crtc_h;
 203
 204         /*
 205          * When the output is interlaced, the OSD must switch between
 206          * each field using the INTERLACE_SEL_ODD (0) of VIU_OSD1_BLK0_CFG_W0
 207          * at each vsync.
 208          * But the vertical scaler can provide such funtionnality if
 209          * is configured for 2:1 scaling with interlace options enabled.
 210          */
 211         if (state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE) {
 212                 dest.y1 /= 2;
 213                 dest.y2 /= 2;
 214                 dst_h /= 2;
 215         }
 216
 217         hf_phase_step = ((src_w << 18) / dst_w) << 6;
 218         vf_phase_step = (src_h << 20) / dst_h;
 219
 220         if (state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE)
 221                 bot_ini_phase = ((vf_phase_step / 2) >> 4);
 222         else
 223                 bot_ini_phase = 0;
 224
 225         vf_phase_step = (vf_phase_step << 4);
 226
 227         /* In interlaced mode, scaler is always active */
 228         if (src_h != dst_h || src_w != dst_w) {
 229                 priv->viu.osd_sc_i_wh_m1 = SCI_WH_M1_W(src_w - 1) |
 230                                            SCI_WH_M1_H(src_h - 1);
 231                 priv->viu.osd_sc_o_h_start_end = SCO_HV_START(dest.x1) |
 232                                                  SCO_HV_END(dest.x2 - 1);
 233                 priv->viu.osd_sc_o_v_start_end = SCO_HV_START(dest.y1) |
 234                                                  SCO_HV_END(dest.y2 - 1);
 235                 /* Enable OSD Scaler */
 236                 priv->viu.osd_sc_ctrl0 = SC_CTRL0_PATH_EN | SC_CTRL0_SEL_OSD1;
 237         } else {
 238                 priv->viu.osd_sc_i_wh_m1 = 0;
 239                 priv->viu.osd_sc_o_h_start_end = 0;
 240                 priv->viu.osd_sc_o_v_start_end = 0;
 241                 priv->viu.osd_sc_ctrl0 = 0;
 242         }
 243
 244         /* In interlaced mode, vertical scaler is always active */
 245         if (src_h != dst_h) {
 246                 priv->viu.osd_sc_v_ctrl0 =
 247                                         VSC_BANK_LEN(vf_bank_len) |
 248                                         VSC_TOP_INI_RCV_NUM(vsc_ini_rcv_num) |
 249                                         VSC_TOP_RPT_L0_NUM(vsc_ini_rpt_p0_num) |
 250                                         VSC_VERTICAL_SCALER_EN;
 251
 252                 if (state->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE)
 253                         priv->viu.osd_sc_v_ctrl0 |=
 254                                         VSC_BOT_INI_RCV_NUM(vsc_bot_rcv_num) |
 255                                         VSC_BOT_RPT_L0_NUM(vsc_bot_rpt_p0_num) |
 256                                         VSC_PROG_INTERLACE;
 257
 258                 priv->viu.osd_sc_v_phase_step = SC_PHASE_STEP(vf_phase_step);
 259                 priv->viu.osd_sc_v_ini_phase = VSC_INI_PHASE_BOT(bot_ini_phase);
 260         } else {
 261                 priv->viu.osd_sc_v_ctrl0 = 0;
 262                 priv->viu.osd_sc_v_phase_step = 0;
 263                 priv->viu.osd_sc_v_ini_phase = 0;
 264         }
 265
 266         /* Horizontal scaler is only used if width does not match */
 267         if (src_w != dst_w) {
 268                 priv->viu.osd_sc_h_ctrl0 =
 269                                         HSC_BANK_LENGTH(hf_bank_len) |
 270                                         HSC_INI_RCV_NUM0(hsc_ini_rcv_num) |
 271                                         HSC_RPT_P0_NUM0(hsc_ini_rpt_p0_num) |
 272                                         HSC_HORIZ_SCALER_EN;
 273                 priv->viu.osd_sc_h_phase_step = SC_PHASE_STEP(hf_phase_step);
 274                 priv->viu.osd_sc_h_ini_phase = 0;
 275         } else {
 276                 priv->viu.osd_sc_h_ctrl0 = 0;
 277                 priv->viu.osd_sc_h_phase_step = 0;
 278                 priv->viu.osd_sc_h_ini_phase = 0;
 279         }
 280
 281         /*
 282          * The format of these registers is (x2 << 16 | x1),
 283          * where x2 is exclusive.
 284          * e.g. +30x1920 would be (1919 << 16) | 30
 285          */
 286         priv->viu.osd1_blk0_cfg[1] =
 287                                 ((fixed16_to_int(state->src.x2) - 1) << 16) |
 288                                 fixed16_to_int(state->src.x1);
 289         priv->viu.osd1_blk0_cfg[2] =
 290                                 ((fixed16_to_int(state->src.y2) - 1) << 16) |
 291                                 fixed16_to_int(state->src.y1);
 292         priv->viu.osd1_blk0_cfg[3] = ((dest.x2 - 1) << 16) | dest.x1;
 293         priv->viu.osd1_blk0_cfg[4] = ((dest.y2 - 1) << 16) | dest.y1;
 294
 295         if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A)) {
 296                 priv->viu.osd_blend_din0_scope_h = ((dest.x2 - 1) << 16) | dest.x1;
 297                 priv->viu.osd_blend_din0_scope_v = ((dest.y2 - 1) << 16) | dest.y1;
 298                 priv->viu.osb_blend0_size = dst_h << 16 | dst_w;
 299                 priv->viu.osb_blend1_size = dst_h << 16 | dst_w;
 300         }
 301
 302         /* Update Canvas with buffer address */
 303         gem = drm_fb_cma_get_gem_obj(fb, 0);
 304
 305         priv->viu.osd1_addr = gem->paddr;
 306         priv->viu.osd1_stride = fb->pitches[0];
 307         priv->viu.osd1_height = fb->height;
 308
 309         if (!meson_plane->enabled) {
 310                 /* Reset OSD1 before enabling it on GXL+ SoCs */
 311                 if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXM) ||
 312                     meson_vpu_is_compatible(priv, VPU_COMPATIBLE_GXL))
 313                         meson_viu_osd1_reset(priv);
 314
 315                 meson_plane->enabled = true;
 316         }
 317
 318         priv->viu.osd1_enabled = true;
 319
 320         spin_unlock_irqrestore(&priv->drm->event_lock, flags);
 321 }
 322
 323 static void meson_plane_atomic_disable(struct drm_plane *plane,
 324                                        struct drm_plane_state *old_state)
 325 {
 326         struct meson_plane *meson_plane = to_meson_plane(plane);
 327         struct meson_drm *priv = meson_plane->priv;
 328
 329         /* Disable OSD1 */
 330         if (meson_vpu_is_compatible(priv, VPU_COMPATIBLE_G12A))
 331                 writel_bits_relaxed(VIU_OSD1_POSTBLD_SRC_OSD1, 0,
 332                                     priv->io_base + _REG(OSD1_BLEND_SRC_CTRL));
 333         else
 334                 writel_bits_relaxed(VPP_OSD1_POSTBLEND, 0,
 335                                     priv->io_base + _REG(VPP_MISC));
 336
 337         meson_plane->enabled = false;
 338         priv->viu.osd1_enabled = false;
 339 }
 340
 341 static const struct drm_plane_helper_funcs meson_plane_helper_funcs = {
 342         .atomic_check   = meson_plane_atomic_check,
 343         .atomic_disable = meson_plane_atomic_disable,
 344         .atomic_update  = meson_plane_atomic_update,
 345         .prepare_fb     = drm_gem_fb_prepare_fb,
 346 };
 347
 348 static const struct drm_plane_funcs meson_plane_funcs = {
 349         .update_plane           = drm_atomic_helper_update_plane,
 350         .disable_plane          = drm_atomic_helper_disable_plane,
 351         .destroy                = drm_plane_cleanup,
 352         .reset                  = drm_atomic_helper_plane_reset,
 353         .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
 354         .atomic_destroy_state   = drm_atomic_helper_plane_destroy_state,
 355 };
 356
 357 static const uint32_t supported_drm_formats[] = {
 358         DRM_FORMAT_ARGB8888,
 359         DRM_FORMAT_ABGR8888,
 360         DRM_FORMAT_XRGB8888,
 361         DRM_FORMAT_XBGR8888,
 362         DRM_FORMAT_RGB888,
 363         DRM_FORMAT_RGB565,
 364 };
 365
 366 int meson_plane_create(struct meson_drm *priv)
 367 {
 368         struct meson_plane *meson_plane;
 369         struct drm_plane *plane;
 370
 371         meson_plane = devm_kzalloc(priv->drm->dev, sizeof(*meson_plane),
 372                                    GFP_KERNEL);
 373         if (!meson_plane)
 374                 return -ENOMEM;
 375
 376         meson_plane->priv = priv;
 377         plane = &meson_plane->base;
 378
 379         drm_universal_plane_init(priv->drm, plane, 0xFF,
 380                                  &meson_plane_funcs,
 381                                  supported_drm_formats,
 382                                  ARRAY_SIZE(supported_drm_formats),
 383                                  NULL,
 384                                  DRM_PLANE_TYPE_PRIMARY, "meson_primary_plane");
 385
 386         drm_plane_helper_add(plane, &meson_plane_helper_funcs);
 387
 388         /* For now, OSD Primary plane is always on the front */
 389         drm_plane_create_zpos_immutable_property(plane, 1);
 390
 391         priv->primary_plane = plane;
 392
 393         return 0;
 394 }