drivers/gpu/drm/rcar-du/rcar_du_plane.c

   1 /*
   2  * rcar_du_plane.c  --  R-Car Display Unit Planes
   3  *
   4  * Copyright (C) 2013-2014 Renesas Electronics Corporation
   5  *
   6  * Contact: Laurent Pinchart (laurent.pinchart@ideasonboard.com)
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  */
  13
  14 #include <drm/drmP.h>
  15 #include <drm/drm_atomic_helper.h>
  16 #include <drm/drm_crtc.h>
  17 #include <drm/drm_crtc_helper.h>
  18 #include <drm/drm_fb_cma_helper.h>
  19 #include <drm/drm_gem_cma_helper.h>
  20 #include <drm/drm_plane_helper.h>
  21
  22 #include "rcar_du_drv.h"
  23 #include "rcar_du_kms.h"
  24 #include "rcar_du_plane.h"
  25 #include "rcar_du_regs.h"
  26
  27 #define RCAR_DU_COLORKEY_NONE           (0 << 24)
  28 #define RCAR_DU_COLORKEY_SOURCE         (1 << 24)
  29 #define RCAR_DU_COLORKEY_MASK           (1 << 24)
  30
  31 static inline struct rcar_du_plane *to_rcar_plane(struct drm_plane *plane)
  32 {
  33         return container_of(plane, struct rcar_du_plane, plane);
  34 }
  35
  36 static u32 rcar_du_plane_read(struct rcar_du_group *rgrp,
  37                               unsigned int index, u32 reg)
  38 {
  39         return rcar_du_read(rgrp->dev,
  40                             rgrp->mmio_offset + index * PLANE_OFF + reg);
  41 }
  42
  43 static void rcar_du_plane_write(struct rcar_du_group *rgrp,
  44                                 unsigned int index, u32 reg, u32 data)
  45 {
  46         rcar_du_write(rgrp->dev, rgrp->mmio_offset + index * PLANE_OFF + reg,
  47                       data);
  48 }
  49
  50 static int rcar_du_plane_reserve_check(struct rcar_du_plane *plane,
  51                                        const struct rcar_du_format_info *format)
  52 {
  53         struct rcar_du_group *rgrp = plane->group;
  54         unsigned int free;
  55         unsigned int i;
  56         int ret;
  57
  58         mutex_lock(&rgrp->planes.lock);
  59
  60         free = rgrp->planes.free;
  61
  62         if (plane->hwindex != -1) {
  63                 free |= 1 << plane->hwindex;
  64                 if (plane->format->planes == 2)
  65                         free |= 1 << ((plane->hwindex + 1) % 8);
  66         }
  67
  68         for (i = 0; i < ARRAY_SIZE(rgrp->planes.planes); ++i) {
  69                 if (!(free & (1 << i)))
  70                         continue;
  71
  72                 if (format->planes == 1 || free & (1 << ((i + 1) % 8)))
  73                         break;
  74         }
  75
  76         ret = i == ARRAY_SIZE(rgrp->planes.planes) ? -EBUSY : 0;
  77
  78         mutex_unlock(&rgrp->planes.lock);
  79         return ret;
  80 }
  81
  82 static int rcar_du_plane_reserve(struct rcar_du_plane *plane,
  83                                  const struct rcar_du_format_info *format)
  84 {
  85         struct rcar_du_group *rgrp = plane->group;
  86         unsigned int i;
  87         int ret = -EBUSY;
  88
  89         mutex_lock(&rgrp->planes.lock);
  90
  91         for (i = 0; i < RCAR_DU_NUM_HW_PLANES; ++i) {
  92                 if (!(rgrp->planes.free & (1 << i)))
  93                         continue;
  94
  95                 if (format->planes == 1 ||
  96                     rgrp->planes.free & (1 << ((i + 1) % 8)))
  97                         break;
  98         }
  99
 100         if (i == RCAR_DU_NUM_HW_PLANES)
 101                 goto done;
 102
 103         rgrp->planes.free &= ~(1 << i);
 104         if (format->planes == 2)
 105                 rgrp->planes.free &= ~(1 << ((i + 1) % 8));
 106
 107         plane->hwindex = i;
 108
 109         ret = 0;
 110
 111 done:
 112         mutex_unlock(&rgrp->planes.lock);
 113         return ret;
 114 }
 115
 116 static void rcar_du_plane_release(struct rcar_du_plane *plane)
 117 {
 118         struct rcar_du_group *rgrp = plane->group;
 119
 120         if (plane->hwindex == -1)
 121                 return;
 122
 123         mutex_lock(&rgrp->planes.lock);
 124         rgrp->planes.free |= 1 << plane->hwindex;
 125         if (plane->format->planes == 2)
 126                 rgrp->planes.free |= 1 << ((plane->hwindex + 1) % 8);
 127         mutex_unlock(&rgrp->planes.lock);
 128
 129         plane->hwindex = -1;
 130 }
 131
 132 void rcar_du_plane_update_base(struct rcar_du_plane *plane)
 133 {
 134         struct rcar_du_group *rgrp = plane->group;
 135         unsigned int index = plane->hwindex;
 136         bool interlaced;
 137         u32 mwr;
 138
 139         interlaced = plane->crtc->mode.flags & DRM_MODE_FLAG_INTERLACE;
 140
 141         /* Memory pitch (expressed in pixels). Must be doubled for interlaced
 142          * operation with 32bpp formats.
 143          */
 144         if (plane->format->planes == 2)
 145                 mwr = plane->pitch;
 146         else
 147                 mwr = plane->pitch * 8 / plane->format->bpp;
 148
 149         if (interlaced && plane->format->bpp == 32)
 150                 mwr *= 2;
 151
 152         rcar_du_plane_write(rgrp, index, PnMWR, mwr);
 153
 154         /* The Y position is expressed in raster line units and must be doubled
 155          * for 32bpp formats, according to the R8A7790 datasheet. No mention of
 156          * doubling the Y position is found in the R8A7779 datasheet, but the
 157          * rule seems to apply there as well.
 158          *
 159          * Despite not being documented, doubling seem not to be needed when
 160          * operating in interlaced mode.
 161          *
 162          * Similarly, for the second plane, NV12 and NV21 formats seem to
 163          * require a halved Y position value, in both progressive and interlaced
 164          * modes.
 165          */
 166         rcar_du_plane_write(rgrp, index, PnSPXR, plane->src_x);
 167         rcar_du_plane_write(rgrp, index, PnSPYR, plane->src_y *
 168                             (!interlaced && plane->format->bpp == 32 ? 2 : 1));
 169         rcar_du_plane_write(rgrp, index, PnDSA0R, plane->dma[0]);
 170
 171         if (plane->format->planes == 2) {
 172                 index = (index + 1) % 8;
 173
 174                 rcar_du_plane_write(rgrp, index, PnMWR, plane->pitch);
 175
 176                 rcar_du_plane_write(rgrp, index, PnSPXR, plane->src_x);
 177                 rcar_du_plane_write(rgrp, index, PnSPYR, plane->src_y *
 178                                     (plane->format->bpp == 16 ? 2 : 1) / 2);
 179                 rcar_du_plane_write(rgrp, index, PnDSA0R, plane->dma[1]);
 180         }
 181 }
 182
 183 void rcar_du_plane_compute_base(struct rcar_du_plane *plane,
 184                                 struct drm_framebuffer *fb)
 185 {
 186         struct drm_gem_cma_object *gem;
 187
 188         plane->pitch = fb->pitches[0];
 189
 190         gem = drm_fb_cma_get_gem_obj(fb, 0);
 191         plane->dma[0] = gem->paddr + fb->offsets[0];
 192
 193         if (plane->format->planes == 2) {
 194                 gem = drm_fb_cma_get_gem_obj(fb, 1);
 195                 plane->dma[1] = gem->paddr + fb->offsets[1];
 196         }
 197 }
 198
 199 static void rcar_du_plane_setup_mode(struct rcar_du_plane *plane,
 200                                      unsigned int index)
 201 {
 202         struct rcar_du_group *rgrp = plane->group;
 203         u32 colorkey;
 204         u32 pnmr;
 205
 206         /* The PnALPHAR register controls alpha-blending in 16bpp formats
 207          * (ARGB1555 and XRGB1555).
 208          *
 209          * For ARGB, set the alpha value to 0, and enable alpha-blending when
 210          * the A bit is 0. This maps A=0 to alpha=0 and A=1 to alpha=255.
 211          *
 212          * For XRGB, set the alpha value to the plane-wide alpha value and
 213          * enable alpha-blending regardless of the X bit value.
 214          */
 215         if (plane->format->fourcc != DRM_FORMAT_XRGB1555)
 216                 rcar_du_plane_write(rgrp, index, PnALPHAR, PnALPHAR_ABIT_0);
 217         else
 218                 rcar_du_plane_write(rgrp, index, PnALPHAR,
 219                                     PnALPHAR_ABIT_X | plane->alpha);
 220
 221         pnmr = PnMR_BM_MD | plane->format->pnmr;
 222
 223         /* Disable color keying when requested. YUV formats have the
 224          * PnMR_SPIM_TP_OFF bit set in their pnmr field, disabling color keying
 225          * automatically.
 226          */
 227         if ((plane->colorkey & RCAR_DU_COLORKEY_MASK) == RCAR_DU_COLORKEY_NONE)
 228                 pnmr |= PnMR_SPIM_TP_OFF;
 229
 230         /* For packed YUV formats we need to select the U/V order. */
 231         if (plane->format->fourcc == DRM_FORMAT_YUYV)
 232                 pnmr |= PnMR_YCDF_YUYV;
 233
 234         rcar_du_plane_write(rgrp, index, PnMR, pnmr);
 235
 236         switch (plane->format->fourcc) {
 237         case DRM_FORMAT_RGB565:
 238                 colorkey = ((plane->colorkey & 0xf80000) >> 8)
 239                          | ((plane->colorkey & 0x00fc00) >> 5)
 240                          | ((plane->colorkey & 0x0000f8) >> 3);
 241                 rcar_du_plane_write(rgrp, index, PnTC2R, colorkey);
 242                 break;
 243
 244         case DRM_FORMAT_ARGB1555:
 245         case DRM_FORMAT_XRGB1555:
 246                 colorkey = ((plane->colorkey & 0xf80000) >> 9)
 247                          | ((plane->colorkey & 0x00f800) >> 6)
 248                          | ((plane->colorkey & 0x0000f8) >> 3);
 249                 rcar_du_plane_write(rgrp, index, PnTC2R, colorkey);
 250                 break;
 251
 252         case DRM_FORMAT_XRGB8888:
 253         case DRM_FORMAT_ARGB8888:
 254                 rcar_du_plane_write(rgrp, index, PnTC3R,
 255                                     PnTC3R_CODE | (plane->colorkey & 0xffffff));
 256                 break;
 257         }
 258 }
 259
 260 static void __rcar_du_plane_setup(struct rcar_du_plane *plane,
 261                                   unsigned int index)
 262 {
 263         struct rcar_du_group *rgrp = plane->group;
 264         u32 ddcr2 = PnDDCR2_CODE;
 265         u32 ddcr4;
 266
 267         /* Data format
 268          *
 269          * The data format is selected by the DDDF field in PnMR and the EDF
 270          * field in DDCR4.
 271          */
 272         ddcr4 = rcar_du_plane_read(rgrp, index, PnDDCR4);
 273         ddcr4 &= ~PnDDCR4_EDF_MASK;
 274         ddcr4 |= plane->format->edf | PnDDCR4_CODE;
 275
 276         rcar_du_plane_setup_mode(plane, index);
 277
 278         if (plane->format->planes == 2) {
 279                 if (plane->hwindex != index) {
 280                         if (plane->format->fourcc == DRM_FORMAT_NV12 ||
 281                             plane->format->fourcc == DRM_FORMAT_NV21)
 282                                 ddcr2 |= PnDDCR2_Y420;
 283
 284                         if (plane->format->fourcc == DRM_FORMAT_NV21)
 285                                 ddcr2 |= PnDDCR2_NV21;
 286
 287                         ddcr2 |= PnDDCR2_DIVU;
 288                 } else {
 289                         ddcr2 |= PnDDCR2_DIVY;
 290                 }
 291         }
 292
 293         rcar_du_plane_write(rgrp, index, PnDDCR2, ddcr2);
 294         rcar_du_plane_write(rgrp, index, PnDDCR4, ddcr4);
 295
 296         /* Destination position and size */
 297         rcar_du_plane_write(rgrp, index, PnDSXR, plane->width);
 298         rcar_du_plane_write(rgrp, index, PnDSYR, plane->height);
 299         rcar_du_plane_write(rgrp, index, PnDPXR, plane->dst_x);
 300         rcar_du_plane_write(rgrp, index, PnDPYR, plane->dst_y);
 301
 302         /* Wrap-around and blinking, disabled */
 303         rcar_du_plane_write(rgrp, index, PnWASPR, 0);
 304         rcar_du_plane_write(rgrp, index, PnWAMWR, 4095);
 305         rcar_du_plane_write(rgrp, index, PnBTR, 0);
 306         rcar_du_plane_write(rgrp, index, PnMLR, 0);
 307 }
 308
 309 void rcar_du_plane_setup(struct rcar_du_plane *plane)
 310 {
 311         __rcar_du_plane_setup(plane, plane->hwindex);
 312         if (plane->format->planes == 2)
 313                 __rcar_du_plane_setup(plane, (plane->hwindex + 1) % 8);
 314
 315         rcar_du_plane_update_base(plane);
 316 }
 317
 318 static int rcar_du_plane_atomic_check(struct drm_plane *plane,
 319                                       struct drm_plane_state *state)
 320 {
 321         struct rcar_du_plane *rplane = to_rcar_plane(plane);
 322         struct rcar_du_device *rcdu = rplane->group->dev;
 323         const struct rcar_du_format_info *format;
 324         unsigned int nplanes;
 325         int ret;
 326
 327         if (!state->fb || !state->crtc)
 328                 return 0;
 329
 330         if (state->src_w >> 16 != state->crtc_w ||
 331             state->src_h >> 16 != state->crtc_h) {
 332                 dev_dbg(rcdu->dev, "%s: scaling not supported\n", __func__);
 333                 return -EINVAL;
 334         }
 335
 336         format = rcar_du_format_info(state->fb->pixel_format);
 337         if (format == NULL) {
 338                 dev_dbg(rcdu->dev, "%s: unsupported format %08x\n", __func__,
 339                         state->fb->pixel_format);
 340                 return -EINVAL;
 341         }
 342
 343         nplanes = rplane->format ? rplane->format->planes : 0;
 344
 345         /* If the number of required planes has changed we will need to
 346          * reallocate hardware planes. Ensure free planes are available.
 347          */
 348         if (format->planes != nplanes) {
 349                 ret = rcar_du_plane_reserve_check(rplane, format);
 350                 if (ret < 0) {
 351                         dev_dbg(rcdu->dev, "%s: no available hardware plane\n",
 352                                 __func__);
 353                         return ret;
 354                 }
 355         }
 356
 357         return 0;
 358 }
 359
 360 static void rcar_du_plane_disable(struct rcar_du_plane *rplane)
 361 {
 362         if (!rplane->enabled)
 363                 return;
 364
 365         mutex_lock(&rplane->group->planes.lock);
 366         rplane->enabled = false;
 367         mutex_unlock(&rplane->group->planes.lock);
 368
 369         rcar_du_plane_release(rplane);
 370
 371         rplane->crtc = NULL;
 372         rplane->format = NULL;
 373 }
 374
 375 static void rcar_du_plane_atomic_update(struct drm_plane *plane,
 376                                         struct drm_plane_state *old_state)
 377 {
 378         struct rcar_du_plane *rplane = to_rcar_plane(plane);
 379         struct drm_plane_state *state = plane->state;
 380         const struct rcar_du_format_info *format;
 381         unsigned int nplanes;
 382
 383         if (!state->crtc) {
 384                 rcar_du_plane_disable(rplane);
 385                 return;
 386         }
 387
 388         format = rcar_du_format_info(state->fb->pixel_format);
 389         nplanes = rplane->format ? rplane->format->planes : 0;
 390
 391         /* Reallocate hardware planes if the number of required planes has
 392          * changed.
 393          */
 394         if (format->planes != nplanes) {
 395                 rcar_du_plane_release(rplane);
 396                 rcar_du_plane_reserve(rplane, format);
 397         }
 398
 399         rplane->crtc = state->crtc;
 400         rplane->format = format;
 401
 402         rplane->src_x = state->src_x >> 16;
 403         rplane->src_y = state->src_y >> 16;
 404         rplane->dst_x = state->crtc_x;
 405         rplane->dst_y = state->crtc_y;
 406         rplane->width = state->crtc_w;
 407         rplane->height = state->crtc_h;
 408
 409         rcar_du_plane_compute_base(rplane, state->fb);
 410         rcar_du_plane_setup(rplane);
 411
 412         mutex_lock(&rplane->group->planes.lock);
 413         rplane->enabled = true;
 414         mutex_unlock(&rplane->group->planes.lock);
 415 }
 416
 417 static const struct drm_plane_helper_funcs rcar_du_plane_helper_funcs = {
 418         .atomic_check = rcar_du_plane_atomic_check,
 419         .atomic_update = rcar_du_plane_atomic_update,
 420 };
 421
 422 /* Both the .set_property and the .update_plane operations are called with the
 423  * mode_config lock held. There is this no need to explicitly protect access to
 424  * the alpha and colorkey fields and the mode register.
 425  */
 426 static void rcar_du_plane_set_alpha(struct rcar_du_plane *plane, u32 alpha)
 427 {
 428         if (plane->alpha == alpha)
 429                 return;
 430
 431         plane->alpha = alpha;
 432         if (!plane->enabled || plane->format->fourcc != DRM_FORMAT_XRGB1555)
 433                 return;
 434
 435         rcar_du_plane_setup_mode(plane, plane->hwindex);
 436 }
 437
 438 static void rcar_du_plane_set_colorkey(struct rcar_du_plane *plane,
 439                                        u32 colorkey)
 440 {
 441         if (plane->colorkey == colorkey)
 442                 return;
 443
 444         plane->colorkey = colorkey;
 445         if (!plane->enabled)
 446                 return;
 447
 448         rcar_du_plane_setup_mode(plane, plane->hwindex);
 449 }
 450
 451 static void rcar_du_plane_set_zpos(struct rcar_du_plane *plane,
 452                                    unsigned int zpos)
 453 {
 454         mutex_lock(&plane->group->planes.lock);
 455         if (plane->zpos == zpos)
 456                 goto done;
 457
 458         plane->zpos = zpos;
 459         if (!plane->enabled)
 460                 goto done;
 461
 462         rcar_du_crtc_update_planes(plane->crtc);
 463
 464 done:
 465         mutex_unlock(&plane->group->planes.lock);
 466 }
 467
 468 static int rcar_du_plane_set_property(struct drm_plane *plane,
 469                                       struct drm_property *property,
 470                                       uint64_t value)
 471 {
 472         struct rcar_du_plane *rplane = to_rcar_plane(plane);
 473         struct rcar_du_group *rgrp = rplane->group;
 474
 475         if (property == rgrp->planes.alpha)
 476                 rcar_du_plane_set_alpha(rplane, value);
 477         else if (property == rgrp->planes.colorkey)
 478                 rcar_du_plane_set_colorkey(rplane, value);
 479         else if (property == rgrp->planes.zpos)
 480                 rcar_du_plane_set_zpos(rplane, value);
 481         else
 482                 return -EINVAL;
 483
 484         return 0;
 485 }
 486
 487 static const struct drm_plane_funcs rcar_du_plane_funcs = {
 488         .update_plane = drm_plane_helper_update,
 489         .disable_plane = drm_plane_helper_disable,
 490         .reset = drm_atomic_helper_plane_reset,
 491         .set_property = rcar_du_plane_set_property,
 492         .destroy = drm_plane_cleanup,
 493         .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
 494         .atomic_destroy_state = drm_atomic_helper_plane_destroy_state,
 495 };
 496
 497 static const uint32_t formats[] = {
 498         DRM_FORMAT_RGB565,
 499         DRM_FORMAT_ARGB1555,
 500         DRM_FORMAT_XRGB1555,
 501         DRM_FORMAT_XRGB8888,
 502         DRM_FORMAT_ARGB8888,
 503         DRM_FORMAT_UYVY,
 504         DRM_FORMAT_YUYV,
 505         DRM_FORMAT_NV12,
 506         DRM_FORMAT_NV21,
 507         DRM_FORMAT_NV16,
 508 };
 509
 510 int rcar_du_planes_init(struct rcar_du_group *rgrp)
 511 {
 512         struct rcar_du_planes *planes = &rgrp->planes;
 513         struct rcar_du_device *rcdu = rgrp->dev;
 514         unsigned int num_planes;
 515         unsigned int num_crtcs;
 516         unsigned int crtcs;
 517         unsigned int i;
 518         int ret;
 519
 520         mutex_init(&planes->lock);
 521         planes->free = 0xff;
 522
 523         planes->alpha =
 524                 drm_property_create_range(rcdu->ddev, 0, "alpha", 0, 255);
 525         if (planes->alpha == NULL)
 526                 return -ENOMEM;
 527
 528         /* The color key is expressed as an RGB888 triplet stored in a 32-bit
 529          * integer in XRGB8888 format. Bit 24 is used as a flag to disable (0)
 530          * or enable source color keying (1).
 531          */
 532         planes->colorkey =
 533                 drm_property_create_range(rcdu->ddev, 0, "colorkey",
 534                                           0, 0x01ffffff);
 535         if (planes->colorkey == NULL)
 536                 return -ENOMEM;
 537
 538         planes->zpos =
 539                 drm_property_create_range(rcdu->ddev, 0, "zpos", 1, 7);
 540         if (planes->zpos == NULL)
 541                 return -ENOMEM;
 542
 543          /* Create one primary plane per in this group CRTC and seven overlay
 544           * planes.
 545           */
 546         num_crtcs = min(rcdu->num_crtcs - 2 * rgrp->index, 2U);
 547         num_planes = num_crtcs + 7;
 548
 549         crtcs = ((1 << rcdu->num_crtcs) - 1) & (3 << (2 * rgrp->index));
 550
 551         for (i = 0; i < num_planes; ++i) {
 552                 enum drm_plane_type type = i < num_crtcs
 553                                          ? DRM_PLANE_TYPE_PRIMARY
 554                                          : DRM_PLANE_TYPE_OVERLAY;
 555                 struct rcar_du_plane *plane = &planes->planes[i];
 556
 557                 plane->group = rgrp;
 558                 plane->hwindex = -1;
 559                 plane->alpha = 255;
 560                 plane->colorkey = RCAR_DU_COLORKEY_NONE;
 561                 plane->zpos = type == DRM_PLANE_TYPE_PRIMARY ? 0 : 1;
 562
 563                 ret = drm_universal_plane_init(rcdu->ddev, &plane->plane, crtcs,
 564                                                &rcar_du_plane_funcs, formats,
 565                                                ARRAY_SIZE(formats), type);
 566                 if (ret < 0)
 567                         return ret;
 568
 569                 drm_plane_helper_add(&plane->plane,
 570                                      &rcar_du_plane_helper_funcs);
 571
 572                 if (type == DRM_PLANE_TYPE_PRIMARY)
 573                         continue;
 574
 575                 drm_object_attach_property(&plane->plane.base,
 576                                            planes->alpha, 255);
 577                 drm_object_attach_property(&plane->plane.base,
 578                                            planes->colorkey,
 579                                            RCAR_DU_COLORKEY_NONE);
 580                 drm_object_attach_property(&plane->plane.base,
 581                                            planes->zpos, 1);
 582         }
 583
 584         return 0;
 585 }