drivers/gpu/drm/sti/sti_cursor.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) STMicroelectronics SA 2014
   4  * Authors: Vincent Abriou <vincent.abriou@st.com>
   5  *          Fabien Dessenne <fabien.dessenne@st.com>
   6  *          for STMicroelectronics.
   7  */
   8
   9 #include <linux/seq_file.h>
  10
  11 #include <drm/drm_atomic.h>
  12 #include <drm/drm_fb_cma_helper.h>
  13 #include <drm/drm_gem_cma_helper.h>
  14
  15 #include "sti_compositor.h"
  16 #include "sti_cursor.h"
  17 #include "sti_plane.h"
  18 #include "sti_vtg.h"
  19
  20 /* Registers */
  21 #define CUR_CTL             0x00
  22 #define CUR_VPO             0x0C
  23 #define CUR_PML             0x14
  24 #define CUR_PMP             0x18
  25 #define CUR_SIZE            0x1C
  26 #define CUR_CML             0x20
  27 #define CUR_AWS             0x28
  28 #define CUR_AWE             0x2C
  29
  30 #define CUR_CTL_CLUT_UPDATE BIT(1)
  31
  32 #define STI_CURS_MIN_SIZE   1
  33 #define STI_CURS_MAX_SIZE   128
  34
  35 /*
  36  * pixmap dma buffer structure
  37  *
  38  * @paddr:  physical address
  39  * @size:   buffer size
  40  * @base:   virtual address
  41  */
  42 struct dma_pixmap {
  43         dma_addr_t paddr;
  44         size_t size;
  45         void *base;
  46 };
  47
  48 /**
  49  * STI Cursor structure
  50  *
  51  * @sti_plane:    sti_plane structure
  52  * @dev:          driver device
  53  * @regs:         cursor registers
  54  * @width:        cursor width
  55  * @height:       cursor height
  56  * @clut:         color look up table
  57  * @clut_paddr:   color look up table physical address
  58  * @pixmap:       pixmap dma buffer (clut8-format cursor)
  59  */
  60 struct sti_cursor {
  61         struct sti_plane plane;
  62         struct device *dev;
  63         void __iomem *regs;
  64         unsigned int width;
  65         unsigned int height;
  66         unsigned short *clut;
  67         dma_addr_t clut_paddr;
  68         struct dma_pixmap pixmap;
  69 };
  70
  71 static const uint32_t cursor_supported_formats[] = {
  72         DRM_FORMAT_ARGB8888,
  73 };
  74
  75 #define to_sti_cursor(x) container_of(x, struct sti_cursor, plane)
  76
  77 #define DBGFS_DUMP(reg) seq_printf(s, "\n  %-25s 0x%08X", #reg, \
  78                                    readl(cursor->regs + reg))
  79
  80 static void cursor_dbg_vpo(struct seq_file *s, u32 val)
  81 {
  82         seq_printf(s, "\txdo:%4d\tydo:%4d", val & 0x0FFF, (val >> 16) & 0x0FFF);
  83 }
  84
  85 static void cursor_dbg_size(struct seq_file *s, u32 val)
  86 {
  87         seq_printf(s, "\t%d x %d", val & 0x07FF, (val >> 16) & 0x07FF);
  88 }
  89
  90 static void cursor_dbg_pml(struct seq_file *s,
  91                            struct sti_cursor *cursor, u32 val)
  92 {
  93         if (cursor->pixmap.paddr == val)
  94                 seq_printf(s, "\tVirt @: %p", cursor->pixmap.base);
  95 }
  96
  97 static void cursor_dbg_cml(struct seq_file *s,
  98                            struct sti_cursor *cursor, u32 val)
  99 {
 100         if (cursor->clut_paddr == val)
 101                 seq_printf(s, "\tVirt @: %p", cursor->clut);
 102 }
 103
 104 static int cursor_dbg_show(struct seq_file *s, void *data)
 105 {
 106         struct drm_info_node *node = s->private;
 107         struct sti_cursor *cursor = (struct sti_cursor *)node->info_ent->data;
 108
 109         seq_printf(s, "%s: (vaddr = 0x%p)",
 110                    sti_plane_to_str(&cursor->plane), cursor->regs);
 111
 112         DBGFS_DUMP(CUR_CTL);
 113         DBGFS_DUMP(CUR_VPO);
 114         cursor_dbg_vpo(s, readl(cursor->regs + CUR_VPO));
 115         DBGFS_DUMP(CUR_PML);
 116         cursor_dbg_pml(s, cursor, readl(cursor->regs + CUR_PML));
 117         DBGFS_DUMP(CUR_PMP);
 118         DBGFS_DUMP(CUR_SIZE);
 119         cursor_dbg_size(s, readl(cursor->regs + CUR_SIZE));
 120         DBGFS_DUMP(CUR_CML);
 121         cursor_dbg_cml(s, cursor, readl(cursor->regs + CUR_CML));
 122         DBGFS_DUMP(CUR_AWS);
 123         DBGFS_DUMP(CUR_AWE);
 124         seq_putc(s, '\n');
 125         return 0;
 126 }
 127
 128 static struct drm_info_list cursor_debugfs_files[] = {
 129         { "cursor", cursor_dbg_show, 0, NULL },
 130 };
 131
 132 static int cursor_debugfs_init(struct sti_cursor *cursor,
 133                                struct drm_minor *minor)
 134 {
 135         unsigned int i;
 136
 137         for (i = 0; i < ARRAY_SIZE(cursor_debugfs_files); i++)
 138                 cursor_debugfs_files[i].data = cursor;
 139
 140         return drm_debugfs_create_files(cursor_debugfs_files,
 141                                         ARRAY_SIZE(cursor_debugfs_files),
 142                                         minor->debugfs_root, minor);
 143 }
 144
 145 static void sti_cursor_argb8888_to_clut8(struct sti_cursor *cursor, u32 *src)
 146 {
 147         u8  *dst = cursor->pixmap.base;
 148         unsigned int i, j;
 149         u32 a, r, g, b;
 150
 151         for (i = 0; i < cursor->height; i++) {
 152                 for (j = 0; j < cursor->width; j++) {
 153                         /* Pick the 2 higher bits of each component */
 154                         a = (*src >> 30) & 3;
 155                         r = (*src >> 22) & 3;
 156                         g = (*src >> 14) & 3;
 157                         b = (*src >> 6) & 3;
 158                         *dst = a << 6 | r << 4 | g << 2 | b;
 159                         src++;
 160                         dst++;
 161                 }
 162         }
 163 }
 164
 165 static void sti_cursor_init(struct sti_cursor *cursor)
 166 {
 167         unsigned short *base = cursor->clut;
 168         unsigned int a, r, g, b;
 169
 170         /* Assign CLUT values, ARGB444 format */
 171         for (a = 0; a < 4; a++)
 172                 for (r = 0; r < 4; r++)
 173                         for (g = 0; g < 4; g++)
 174                                 for (b = 0; b < 4; b++)
 175                                         *base++ = (a * 5) << 12 |
 176                                                   (r * 5) << 8 |
 177                                                   (g * 5) << 4 |
 178                                                   (b * 5);
 179 }
 180
 181 static int sti_cursor_atomic_check(struct drm_plane *drm_plane,
 182                                    struct drm_plane_state *state)
 183 {
 184         struct sti_plane *plane = to_sti_plane(drm_plane);
 185         struct sti_cursor *cursor = to_sti_cursor(plane);
 186         struct drm_crtc *crtc = state->crtc;
 187         struct drm_framebuffer *fb = state->fb;
 188         struct drm_crtc_state *crtc_state;
 189         struct drm_display_mode *mode;
 190         int dst_x, dst_y, dst_w, dst_h;
 191         int src_w, src_h;
 192
 193         /* no need for further checks if the plane is being disabled */
 194         if (!crtc || !fb)
 195                 return 0;
 196
 197         crtc_state = drm_atomic_get_crtc_state(state->state, crtc);
 198         mode = &crtc_state->mode;
 199         dst_x = state->crtc_x;
 200         dst_y = state->crtc_y;
 201         dst_w = clamp_val(state->crtc_w, 0, mode->crtc_hdisplay - dst_x);
 202         dst_h = clamp_val(state->crtc_h, 0, mode->crtc_vdisplay - dst_y);
 203         /* src_x are in 16.16 format */
 204         src_w = state->src_w >> 16;
 205         src_h = state->src_h >> 16;
 206
 207         if (src_w < STI_CURS_MIN_SIZE ||
 208             src_h < STI_CURS_MIN_SIZE ||
 209             src_w > STI_CURS_MAX_SIZE ||
 210             src_h > STI_CURS_MAX_SIZE) {
 211                 DRM_ERROR("Invalid cursor size (%dx%d)\n",
 212                                 src_w, src_h);
 213                 return -EINVAL;
 214         }
 215
 216         /* If the cursor size has changed, re-allocated the pixmap */
 217         if (!cursor->pixmap.base ||
 218             (cursor->width != src_w) ||
 219             (cursor->height != src_h)) {
 220                 cursor->width = src_w;
 221                 cursor->height = src_h;
 222
 223                 if (cursor->pixmap.base)
 224                         dma_free_wc(cursor->dev, cursor->pixmap.size,
 225                                     cursor->pixmap.base, cursor->pixmap.paddr);
 226
 227                 cursor->pixmap.size = cursor->width * cursor->height;
 228
 229                 cursor->pixmap.base = dma_alloc_wc(cursor->dev,
 230                                                    cursor->pixmap.size,
 231                                                    &cursor->pixmap.paddr,
 232                                                    GFP_KERNEL | GFP_DMA);
 233                 if (!cursor->pixmap.base) {
 234                         DRM_ERROR("Failed to allocate memory for pixmap\n");
 235                         return -EINVAL;
 236                 }
 237         }
 238
 239         if (!drm_fb_cma_get_gem_obj(fb, 0)) {
 240                 DRM_ERROR("Can't get CMA GEM object for fb\n");
 241                 return -EINVAL;
 242         }
 243
 244         DRM_DEBUG_KMS("CRTC:%d (%s) drm plane:%d (%s)\n",
 245                       crtc->base.id, sti_mixer_to_str(to_sti_mixer(crtc)),
 246                       drm_plane->base.id, sti_plane_to_str(plane));
 247         DRM_DEBUG_KMS("(%dx%d)@(%d,%d)\n", dst_w, dst_h, dst_x, dst_y);
 248
 249         return 0;
 250 }
 251
 252 static void sti_cursor_atomic_update(struct drm_plane *drm_plane,
 253                                      struct drm_plane_state *oldstate)
 254 {
 255         struct drm_plane_state *state = drm_plane->state;
 256         struct sti_plane *plane = to_sti_plane(drm_plane);
 257         struct sti_cursor *cursor = to_sti_cursor(plane);
 258         struct drm_crtc *crtc = state->crtc;
 259         struct drm_framebuffer *fb = state->fb;
 260         struct drm_display_mode *mode;
 261         int dst_x, dst_y;
 262         struct drm_gem_cma_object *cma_obj;
 263         u32 y, x;
 264         u32 val;
 265
 266         if (!crtc || !fb)
 267                 return;
 268
 269         mode = &crtc->mode;
 270         dst_x = state->crtc_x;
 271         dst_y = state->crtc_y;
 272
 273         cma_obj = drm_fb_cma_get_gem_obj(fb, 0);
 274
 275         /* Convert ARGB8888 to CLUT8 */
 276         sti_cursor_argb8888_to_clut8(cursor, (u32 *)cma_obj->vaddr);
 277
 278         /* AWS and AWE depend on the mode */
 279         y = sti_vtg_get_line_number(*mode, 0);
 280         x = sti_vtg_get_pixel_number(*mode, 0);
 281         val = y << 16 | x;
 282         writel(val, cursor->regs + CUR_AWS);
 283         y = sti_vtg_get_line_number(*mode, mode->vdisplay - 1);
 284         x = sti_vtg_get_pixel_number(*mode, mode->hdisplay - 1);
 285         val = y << 16 | x;
 286         writel(val, cursor->regs + CUR_AWE);
 287
 288         /* Set memory location, size, and position */
 289         writel(cursor->pixmap.paddr, cursor->regs + CUR_PML);
 290         writel(cursor->width, cursor->regs + CUR_PMP);
 291         writel(cursor->height << 16 | cursor->width, cursor->regs + CUR_SIZE);
 292
 293         y = sti_vtg_get_line_number(*mode, dst_y);
 294         x = sti_vtg_get_pixel_number(*mode, dst_x);
 295         writel((y << 16) | x, cursor->regs + CUR_VPO);
 296
 297         /* Set and fetch CLUT */
 298         writel(cursor->clut_paddr, cursor->regs + CUR_CML);
 299         writel(CUR_CTL_CLUT_UPDATE, cursor->regs + CUR_CTL);
 300
 301         sti_plane_update_fps(plane, true, false);
 302
 303         plane->status = STI_PLANE_UPDATED;
 304 }
 305
 306 static void sti_cursor_atomic_disable(struct drm_plane *drm_plane,
 307                                       struct drm_plane_state *oldstate)
 308 {
 309         struct sti_plane *plane = to_sti_plane(drm_plane);
 310
 311         if (!oldstate->crtc) {
 312                 DRM_DEBUG_DRIVER("drm plane:%d not enabled\n",
 313                                  drm_plane->base.id);
 314                 return;
 315         }
 316
 317         DRM_DEBUG_DRIVER("CRTC:%d (%s) drm plane:%d (%s)\n",
 318                          oldstate->crtc->base.id,
 319                          sti_mixer_to_str(to_sti_mixer(oldstate->crtc)),
 320                          drm_plane->base.id, sti_plane_to_str(plane));
 321
 322         plane->status = STI_PLANE_DISABLING;
 323 }
 324
 325 static const struct drm_plane_helper_funcs sti_cursor_helpers_funcs = {
 326         .atomic_check = sti_cursor_atomic_check,
 327         .atomic_update = sti_cursor_atomic_update,
 328         .atomic_disable = sti_cursor_atomic_disable,
 329 };
 330
 331 static void sti_cursor_destroy(struct drm_plane *drm_plane)
 332 {
 333         DRM_DEBUG_DRIVER("\n");
 334
 335         drm_plane_helper_disable(drm_plane, NULL);
 336         drm_plane_cleanup(drm_plane);
 337 }
 338
 339 static int sti_cursor_late_register(struct drm_plane *drm_plane)
 340 {
 341         struct sti_plane *plane = to_sti_plane(drm_plane);
 342         struct sti_cursor *cursor = to_sti_cursor(plane);
 343
 344         return cursor_debugfs_init(cursor, drm_plane->dev->primary);
 345 }
 346
 347 static const struct drm_plane_funcs sti_cursor_plane_helpers_funcs = {
 348         .update_plane = drm_atomic_helper_update_plane,
 349         .disable_plane = drm_atomic_helper_disable_plane,
 350         .destroy = sti_cursor_destroy,
 351         .reset = sti_plane_reset,
 352         .atomic_duplicate_state = drm_atomic_helper_plane_duplicate_state,
 353         .atomic_destroy_state = drm_atomic_helper_plane_destroy_state,
 354         .late_register = sti_cursor_late_register,
 355 };
 356
 357 struct drm_plane *sti_cursor_create(struct drm_device *drm_dev,
 358                                     struct device *dev, int desc,
 359                                     void __iomem *baseaddr,
 360                                     unsigned int possible_crtcs)
 361 {
 362         struct sti_cursor *cursor;
 363         size_t size;
 364         int res;
 365
 366         cursor = devm_kzalloc(dev, sizeof(*cursor), GFP_KERNEL);
 367         if (!cursor) {
 368                 DRM_ERROR("Failed to allocate memory for cursor\n");
 369                 return NULL;
 370         }
 371
 372         /* Allocate clut buffer */
 373         size = 0x100 * sizeof(unsigned short);
 374         cursor->clut = dma_alloc_wc(dev, size, &cursor->clut_paddr,
 375                                     GFP_KERNEL | GFP_DMA);
 376
 377         if (!cursor->clut) {
 378                 DRM_ERROR("Failed to allocate memory for cursor clut\n");
 379                 goto err_clut;
 380         }
 381
 382         cursor->dev = dev;
 383         cursor->regs = baseaddr;
 384         cursor->plane.desc = desc;
 385         cursor->plane.status = STI_PLANE_DISABLED;
 386
 387         sti_cursor_init(cursor);
 388
 389         res = drm_universal_plane_init(drm_dev, &cursor->plane.drm_plane,
 390                                        possible_crtcs,
 391                                        &sti_cursor_plane_helpers_funcs,
 392                                        cursor_supported_formats,
 393                                        ARRAY_SIZE(cursor_supported_formats),
 394                                        NULL, DRM_PLANE_TYPE_CURSOR, NULL);
 395         if (res) {
 396                 DRM_ERROR("Failed to initialize universal plane\n");
 397                 goto err_plane;
 398         }
 399
 400         drm_plane_helper_add(&cursor->plane.drm_plane,
 401                              &sti_cursor_helpers_funcs);
 402
 403         sti_plane_init_property(&cursor->plane, DRM_PLANE_TYPE_CURSOR);
 404
 405         return &cursor->plane.drm_plane;
 406
 407 err_plane:
 408         dma_free_wc(dev, size, cursor->clut, cursor->clut_paddr);
 409 err_clut:
 410         devm_kfree(dev, cursor);
 411         return NULL;
 412 }