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