drivers/gpu/drm/drm_gem_framebuffer_helper.c

   1 /*
   2  * drm gem framebuffer helper functions
   3  *
   4  * Copyright (C) 2017 Noralf Trønnes
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  */
  11
  12 #include <linux/dma-buf.h>
  13 #include <linux/dma-fence.h>
  14 #include <linux/reservation.h>
  15 #include <linux/slab.h>
  16
  17 #include <drm/drm_atomic.h>
  18 #include <drm/drm_atomic_uapi.h>
  19 #include <drm/drm_damage_helper.h>
  20 #include <drm/drm_fb_helper.h>
  21 #include <drm/drm_fourcc.h>
  22 #include <drm/drm_framebuffer.h>
  23 #include <drm/drm_gem.h>
  24 #include <drm/drm_gem_framebuffer_helper.h>
  25 #include <drm/drm_modeset_helper.h>
  26 #include <drm/drm_simple_kms_helper.h>
  27
  28 /**
  29  * DOC: overview
  30  *
  31  * This library provides helpers for drivers that don't subclass
  32  * &drm_framebuffer and use &drm_gem_object for their backing storage.
  33  *
  34  * Drivers without additional needs to validate framebuffers can simply use
  35  * drm_gem_fb_create() and everything is wired up automatically. Other drivers
  36  * can use all parts independently.
  37  */
  38
  39 /**
  40  * drm_gem_fb_get_obj() - Get GEM object backing the framebuffer
  41  * @fb: Framebuffer
  42  * @plane: Plane index
  43  *
  44  * No additional reference is taken beyond the one that the &drm_frambuffer
  45  * already holds.
  46  *
  47  * Returns:
  48  * Pointer to &drm_gem_object for the given framebuffer and plane index or NULL
  49  * if it does not exist.
  50  */
  51 struct drm_gem_object *drm_gem_fb_get_obj(struct drm_framebuffer *fb,
  52                                           unsigned int plane)
  53 {
  54         if (plane >= 4)
  55                 return NULL;
  56
  57         return fb->obj[plane];
  58 }
  59 EXPORT_SYMBOL_GPL(drm_gem_fb_get_obj);
  60
  61 static struct drm_framebuffer *
  62 drm_gem_fb_alloc(struct drm_device *dev,
  63                  const struct drm_mode_fb_cmd2 *mode_cmd,
  64                  struct drm_gem_object **obj, unsigned int num_planes,
  65                  const struct drm_framebuffer_funcs *funcs)
  66 {
  67         struct drm_framebuffer *fb;
  68         int ret, i;
  69
  70         fb = kzalloc(sizeof(*fb), GFP_KERNEL);
  71         if (!fb)
  72                 return ERR_PTR(-ENOMEM);
  73
  74         drm_helper_mode_fill_fb_struct(dev, fb, mode_cmd);
  75
  76         for (i = 0; i < num_planes; i++)
  77                 fb->obj[i] = obj[i];
  78
  79         ret = drm_framebuffer_init(dev, fb, funcs);
  80         if (ret) {
  81                 DRM_DEV_ERROR(dev->dev, "Failed to init framebuffer: %d\n",
  82                               ret);
  83                 kfree(fb);
  84                 return ERR_PTR(ret);
  85         }
  86
  87         return fb;
  88 }
  89
  90 /**
  91  * drm_gem_fb_destroy - Free GEM backed framebuffer
  92  * @fb: Framebuffer
  93  *
  94  * Frees a GEM backed framebuffer with its backing buffer(s) and the structure
  95  * itself. Drivers can use this as their &drm_framebuffer_funcs->destroy
  96  * callback.
  97  */
  98 void drm_gem_fb_destroy(struct drm_framebuffer *fb)
  99 {
 100         int i;
 101
 102         for (i = 0; i < 4; i++)
 103                 drm_gem_object_put_unlocked(fb->obj[i]);
 104
 105         drm_framebuffer_cleanup(fb);
 106         kfree(fb);
 107 }
 108 EXPORT_SYMBOL(drm_gem_fb_destroy);
 109
 110 /**
 111  * drm_gem_fb_create_handle - Create handle for GEM backed framebuffer
 112  * @fb: Framebuffer
 113  * @file: DRM file to register the handle for
 114  * @handle: Pointer to return the created handle
 115  *
 116  * This function creates a handle for the GEM object backing the framebuffer.
 117  * Drivers can use this as their &drm_framebuffer_funcs->create_handle
 118  * callback. The GETFB IOCTL calls into this callback.
 119  *
 120  * Returns:
 121  * 0 on success or a negative error code on failure.
 122  */
 123 int drm_gem_fb_create_handle(struct drm_framebuffer *fb, struct drm_file *file,
 124                              unsigned int *handle)
 125 {
 126         return drm_gem_handle_create(file, fb->obj[0], handle);
 127 }
 128 EXPORT_SYMBOL(drm_gem_fb_create_handle);
 129
 130 /**
 131  * drm_gem_fb_create_with_funcs() - Helper function for the
 132  *                                  &drm_mode_config_funcs.fb_create
 133  *                                  callback
 134  * @dev: DRM device
 135  * @file: DRM file that holds the GEM handle(s) backing the framebuffer
 136  * @mode_cmd: Metadata from the userspace framebuffer creation request
 137  * @funcs: vtable to be used for the new framebuffer object
 138  *
 139  * This function can be used to set &drm_framebuffer_funcs for drivers that need
 140  * custom framebuffer callbacks. Use drm_gem_fb_create() if you don't need to
 141  * change &drm_framebuffer_funcs. The function does buffer size validation.
 142  *
 143  * Returns:
 144  * Pointer to a &drm_framebuffer on success or an error pointer on failure.
 145  */
 146 struct drm_framebuffer *
 147 drm_gem_fb_create_with_funcs(struct drm_device *dev, struct drm_file *file,
 148                              const struct drm_mode_fb_cmd2 *mode_cmd,
 149                              const struct drm_framebuffer_funcs *funcs)
 150 {
 151         const struct drm_format_info *info;
 152         struct drm_gem_object *objs[4];
 153         struct drm_framebuffer *fb;
 154         int ret, i;
 155
 156         info = drm_get_format_info(dev, mode_cmd);
 157         if (!info)
 158                 return ERR_PTR(-EINVAL);
 159
 160         for (i = 0; i < info->num_planes; i++) {
 161                 unsigned int width = mode_cmd->width / (i ? info->hsub : 1);
 162                 unsigned int height = mode_cmd->height / (i ? info->vsub : 1);
 163                 unsigned int min_size;
 164
 165                 objs[i] = drm_gem_object_lookup(file, mode_cmd->handles[i]);
 166                 if (!objs[i]) {
 167                         DRM_DEBUG_KMS("Failed to lookup GEM object\n");
 168                         ret = -ENOENT;
 169                         goto err_gem_object_put;
 170                 }
 171
 172                 min_size = (height - 1) * mode_cmd->pitches[i]
 173                          + drm_format_info_min_pitch(info, i, width)
 174                          + mode_cmd->offsets[i];
 175
 176                 if (objs[i]->size < min_size) {
 177                         drm_gem_object_put_unlocked(objs[i]);
 178                         ret = -EINVAL;
 179                         goto err_gem_object_put;
 180                 }
 181         }
 182
 183         fb = drm_gem_fb_alloc(dev, mode_cmd, objs, i, funcs);
 184         if (IS_ERR(fb)) {
 185                 ret = PTR_ERR(fb);
 186                 goto err_gem_object_put;
 187         }
 188
 189         return fb;
 190
 191 err_gem_object_put:
 192         for (i--; i >= 0; i--)
 193                 drm_gem_object_put_unlocked(objs[i]);
 194
 195         return ERR_PTR(ret);
 196 }
 197 EXPORT_SYMBOL_GPL(drm_gem_fb_create_with_funcs);
 198
 199 static const struct drm_framebuffer_funcs drm_gem_fb_funcs = {
 200         .destroy        = drm_gem_fb_destroy,
 201         .create_handle  = drm_gem_fb_create_handle,
 202 };
 203
 204 /**
 205  * drm_gem_fb_create() - Helper function for the
 206  *                       &drm_mode_config_funcs.fb_create callback
 207  * @dev: DRM device
 208  * @file: DRM file that holds the GEM handle(s) backing the framebuffer
 209  * @mode_cmd: Metadata from the userspace framebuffer creation request
 210  *
 211  * This function creates a new framebuffer object described by
 212  * &drm_mode_fb_cmd2. This description includes handles for the buffer(s)
 213  * backing the framebuffer.
 214  *
 215  * If your hardware has special alignment or pitch requirements these should be
 216  * checked before calling this function. The function does buffer size
 217  * validation. Use drm_gem_fb_create_with_dirty() if you need framebuffer
 218  * flushing.
 219  *
 220  * Drivers can use this as their &drm_mode_config_funcs.fb_create callback.
 221  * The ADDFB2 IOCTL calls into this callback.
 222  *
 223  * Returns:
 224  * Pointer to a &drm_framebuffer on success or an error pointer on failure.
 225  */
 226 struct drm_framebuffer *
 227 drm_gem_fb_create(struct drm_device *dev, struct drm_file *file,
 228                   const struct drm_mode_fb_cmd2 *mode_cmd)
 229 {
 230         return drm_gem_fb_create_with_funcs(dev, file, mode_cmd,
 231                                             &drm_gem_fb_funcs);
 232 }
 233 EXPORT_SYMBOL_GPL(drm_gem_fb_create);
 234
 235 static const struct drm_framebuffer_funcs drm_gem_fb_funcs_dirtyfb = {
 236         .destroy        = drm_gem_fb_destroy,
 237         .create_handle  = drm_gem_fb_create_handle,
 238         .dirty          = drm_atomic_helper_dirtyfb,
 239 };
 240
 241 /**
 242  * drm_gem_fb_create_with_dirty() - Helper function for the
 243  *                       &drm_mode_config_funcs.fb_create callback
 244  * @dev: DRM device
 245  * @file: DRM file that holds the GEM handle(s) backing the framebuffer
 246  * @mode_cmd: Metadata from the userspace framebuffer creation request
 247  *
 248  * This function creates a new framebuffer object described by
 249  * &drm_mode_fb_cmd2. This description includes handles for the buffer(s)
 250  * backing the framebuffer. drm_atomic_helper_dirtyfb() is used for the dirty
 251  * callback giving framebuffer flushing through the atomic machinery. Use
 252  * drm_gem_fb_create() if you don't need the dirty callback.
 253  * The function does buffer size validation.
 254  *
 255  * Drivers should also call drm_plane_enable_fb_damage_clips() on all planes
 256  * to enable userspace to use damage clips also with the ATOMIC IOCTL.
 257  *
 258  * Drivers can use this as their &drm_mode_config_funcs.fb_create callback.
 259  * The ADDFB2 IOCTL calls into this callback.
 260  *
 261  * Returns:
 262  * Pointer to a &drm_framebuffer on success or an error pointer on failure.
 263  */
 264 struct drm_framebuffer *
 265 drm_gem_fb_create_with_dirty(struct drm_device *dev, struct drm_file *file,
 266                              const struct drm_mode_fb_cmd2 *mode_cmd)
 267 {
 268         return drm_gem_fb_create_with_funcs(dev, file, mode_cmd,
 269                                             &drm_gem_fb_funcs_dirtyfb);
 270 }
 271 EXPORT_SYMBOL_GPL(drm_gem_fb_create_with_dirty);
 272
 273 /**
 274  * drm_gem_fb_prepare_fb() - Prepare a GEM backed framebuffer
 275  * @plane: Plane
 276  * @state: Plane state the fence will be attached to
 277  *
 278  * This function prepares a GEM backed framebuffer for scanout by checking if
 279  * the plane framebuffer has a DMA-BUF attached. If it does, it extracts the
 280  * exclusive fence and attaches it to the plane state for the atomic helper to
 281  * wait on. This function can be used as the &drm_plane_helper_funcs.prepare_fb
 282  * callback.
 283  *
 284  * There is no need for &drm_plane_helper_funcs.cleanup_fb hook for simple
 285  * gem based framebuffer drivers which have their buffers always pinned in
 286  * memory.
 287  *
 288  * See drm_atomic_set_fence_for_plane() for a discussion of implicit and
 289  * explicit fencing in atomic modeset updates.
 290  */
 291 int drm_gem_fb_prepare_fb(struct drm_plane *plane,
 292                           struct drm_plane_state *state)
 293 {
 294         struct dma_buf *dma_buf;
 295         struct dma_fence *fence;
 296
 297         if (!state->fb)
 298                 return 0;
 299
 300         dma_buf = drm_gem_fb_get_obj(state->fb, 0)->dma_buf;
 301         if (dma_buf) {
 302                 fence = reservation_object_get_excl_rcu(dma_buf->resv);
 303                 drm_atomic_set_fence_for_plane(state, fence);
 304         }
 305
 306         return 0;
 307 }
 308 EXPORT_SYMBOL_GPL(drm_gem_fb_prepare_fb);
 309
 310 /**
 311  * drm_gem_fb_simple_display_pipe_prepare_fb - prepare_fb helper for
 312  *     &drm_simple_display_pipe
 313  * @pipe: Simple display pipe
 314  * @plane_state: Plane state
 315  *
 316  * This function uses drm_gem_fb_prepare_fb() to check if the plane FB has a
 317  * &dma_buf attached, extracts the exclusive fence and attaches it to plane
 318  * state for the atomic helper to wait on. Drivers can use this as their
 319  * &drm_simple_display_pipe_funcs.prepare_fb callback.
 320  *
 321  * See drm_atomic_set_fence_for_plane() for a discussion of implicit and
 322  * explicit fencing in atomic modeset updates.
 323  */
 324 int drm_gem_fb_simple_display_pipe_prepare_fb(struct drm_simple_display_pipe *pipe,
 325                                               struct drm_plane_state *plane_state)
 326 {
 327         return drm_gem_fb_prepare_fb(&pipe->plane, plane_state);
 328 }
 329 EXPORT_SYMBOL(drm_gem_fb_simple_display_pipe_prepare_fb);
 330
 331 /**
 332  * drm_gem_fbdev_fb_create - Create a GEM backed &drm_framebuffer for fbdev
 333  *                           emulation
 334  * @dev: DRM device
 335  * @sizes: fbdev size description
 336  * @pitch_align: Optional pitch alignment
 337  * @obj: GEM object backing the framebuffer
 338  * @funcs: Optional vtable to be used for the new framebuffer object when the
 339  *         dirty callback is needed.
 340  *
 341  * This function creates a framebuffer from a &drm_fb_helper_surface_size
 342  * description for use in the &drm_fb_helper_funcs.fb_probe callback.
 343  *
 344  * Returns:
 345  * Pointer to a &drm_framebuffer on success or an error pointer on failure.
 346  */
 347 struct drm_framebuffer *
 348 drm_gem_fbdev_fb_create(struct drm_device *dev,
 349                         struct drm_fb_helper_surface_size *sizes,
 350                         unsigned int pitch_align, struct drm_gem_object *obj,
 351                         const struct drm_framebuffer_funcs *funcs)
 352 {
 353         struct drm_mode_fb_cmd2 mode_cmd = { 0 };
 354
 355         mode_cmd.width = sizes->surface_width;
 356         mode_cmd.height = sizes->surface_height;
 357         mode_cmd.pitches[0] = sizes->surface_width *
 358                               DIV_ROUND_UP(sizes->surface_bpp, 8);
 359         if (pitch_align)
 360                 mode_cmd.pitches[0] = roundup(mode_cmd.pitches[0],
 361                                               pitch_align);
 362         mode_cmd.pixel_format = drm_driver_legacy_fb_format(dev, sizes->surface_bpp,
 363                                                             sizes->surface_depth);
 364         if (obj->size < mode_cmd.pitches[0] * mode_cmd.height)
 365                 return ERR_PTR(-EINVAL);
 366
 367         if (!funcs)
 368                 funcs = &drm_gem_fb_funcs;
 369
 370         return drm_gem_fb_alloc(dev, &mode_cmd, &obj, 1, funcs);
 371 }
 372 EXPORT_SYMBOL(drm_gem_fbdev_fb_create);