drivers/gpu/drm/qxl/qxl_fb.c

   1 /*
   2  * Copyright © 2013 Red Hat
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *     David Airlie
  25  */
  26 #include <linux/module.h>
  27
  28 #include <drm/drmP.h>
  29 #include <drm/drm.h>
  30 #include <drm/drm_crtc.h>
  31 #include <drm/drm_crtc_helper.h>
  32 #include <drm/drm_fb_helper.h>
  33
  34 #include "qxl_drv.h"
  35
  36 #include "qxl_object.h"
  37
  38 #define QXL_DIRTY_DELAY (HZ / 30)
  39
  40 struct qxl_fbdev {
  41         struct drm_fb_helper helper;
  42         struct qxl_framebuffer  qfb;
  43         struct qxl_device       *qdev;
  44
  45         spinlock_t delayed_ops_lock;
  46         struct list_head delayed_ops;
  47         void *shadow;
  48         int size;
  49 };
  50
  51 static void qxl_fb_image_init(struct qxl_fb_image *qxl_fb_image,
  52                               struct qxl_device *qdev, struct fb_info *info,
  53                               const struct fb_image *image)
  54 {
  55         qxl_fb_image->qdev = qdev;
  56         if (info) {
  57                 qxl_fb_image->visual = info->fix.visual;
  58                 if (qxl_fb_image->visual == FB_VISUAL_TRUECOLOR ||
  59                     qxl_fb_image->visual == FB_VISUAL_DIRECTCOLOR)
  60                         memcpy(&qxl_fb_image->pseudo_palette,
  61                                info->pseudo_palette,
  62                                sizeof(qxl_fb_image->pseudo_palette));
  63         } else {
  64                  /* fallback */
  65                 if (image->depth == 1)
  66                         qxl_fb_image->visual = FB_VISUAL_MONO10;
  67                 else
  68                         qxl_fb_image->visual = FB_VISUAL_DIRECTCOLOR;
  69         }
  70         if (image) {
  71                 memcpy(&qxl_fb_image->fb_image, image,
  72                        sizeof(qxl_fb_image->fb_image));
  73         }
  74 }
  75
  76 #ifdef CONFIG_DRM_FBDEV_EMULATION
  77 static struct fb_deferred_io qxl_defio = {
  78         .delay          = QXL_DIRTY_DELAY,
  79         .deferred_io    = drm_fb_helper_deferred_io,
  80 };
  81 #endif
  82
  83 static struct fb_ops qxlfb_ops = {
  84         .owner = THIS_MODULE,
  85         DRM_FB_HELPER_DEFAULT_OPS,
  86         .fb_fillrect = drm_fb_helper_sys_fillrect,
  87         .fb_copyarea = drm_fb_helper_sys_copyarea,
  88         .fb_imageblit = drm_fb_helper_sys_imageblit,
  89 };
  90
  91 static void qxlfb_destroy_pinned_object(struct drm_gem_object *gobj)
  92 {
  93         struct qxl_bo *qbo = gem_to_qxl_bo(gobj);
  94
  95         qxl_bo_kunmap(qbo);
  96         qxl_bo_unpin(qbo);
  97
  98         drm_gem_object_unreference_unlocked(gobj);
  99 }
 100
 101 int qxl_get_handle_for_primary_fb(struct qxl_device *qdev,
 102                                   struct drm_file *file_priv,
 103                                   uint32_t *handle)
 104 {
 105         int r;
 106         struct drm_gem_object *gobj = qdev->fbdev_qfb->obj;
 107
 108         BUG_ON(!gobj);
 109         /* drm_get_handle_create adds a reference - good */
 110         r = drm_gem_handle_create(file_priv, gobj, handle);
 111         if (r)
 112                 return r;
 113         return 0;
 114 }
 115
 116 static int qxlfb_create_pinned_object(struct qxl_fbdev *qfbdev,
 117                                       const struct drm_mode_fb_cmd2 *mode_cmd,
 118                                       struct drm_gem_object **gobj_p)
 119 {
 120         struct qxl_device *qdev = qfbdev->qdev;
 121         struct drm_gem_object *gobj = NULL;
 122         struct qxl_bo *qbo = NULL;
 123         int ret;
 124         int aligned_size, size;
 125         int height = mode_cmd->height;
 126
 127         size = mode_cmd->pitches[0] * height;
 128         aligned_size = ALIGN(size, PAGE_SIZE);
 129         /* TODO: unallocate and reallocate surface0 for real. Hack to just
 130          * have a large enough surface0 for 1024x768 Xorg 32bpp mode */
 131         ret = qxl_gem_object_create(qdev, aligned_size, 0,
 132                                     QXL_GEM_DOMAIN_SURFACE,
 133                                     false, /* is discardable */
 134                                     false, /* is kernel (false means device) */
 135                                     NULL,
 136                                     &gobj);
 137         if (ret) {
 138                 pr_err("failed to allocate framebuffer (%d)\n",
 139                        aligned_size);
 140                 return -ENOMEM;
 141         }
 142         qbo = gem_to_qxl_bo(gobj);
 143
 144         qbo->surf.width = mode_cmd->width;
 145         qbo->surf.height = mode_cmd->height;
 146         qbo->surf.stride = mode_cmd->pitches[0];
 147         qbo->surf.format = SPICE_SURFACE_FMT_32_xRGB;
 148
 149         ret = qxl_bo_pin(qbo, QXL_GEM_DOMAIN_SURFACE, NULL);
 150         if (ret) {
 151                 goto out_unref;
 152         }
 153         ret = qxl_bo_kmap(qbo, NULL);
 154
 155         if (ret)
 156                 goto out_unref;
 157
 158         *gobj_p = gobj;
 159         return 0;
 160 out_unref:
 161         qxlfb_destroy_pinned_object(gobj);
 162         *gobj_p = NULL;
 163         return ret;
 164 }
 165
 166 /*
 167  * FIXME
 168  * It should not be necessary to have a special dirty() callback for fbdev.
 169  */
 170 static int qxlfb_framebuffer_dirty(struct drm_framebuffer *fb,
 171                                    struct drm_file *file_priv,
 172                                    unsigned flags, unsigned color,
 173                                    struct drm_clip_rect *clips,
 174                                    unsigned num_clips)
 175 {
 176         struct qxl_device *qdev = fb->dev->dev_private;
 177         struct fb_info *info = qdev->fbdev_info;
 178         struct qxl_fbdev *qfbdev = info->par;
 179         struct qxl_fb_image qxl_fb_image;
 180         struct fb_image *image = &qxl_fb_image.fb_image;
 181
 182         /* TODO: hard coding 32 bpp */
 183         int stride = qfbdev->qfb.base.pitches[0];
 184
 185         /*
 186          * we are using a shadow draw buffer, at qdev->surface0_shadow
 187          */
 188         qxl_io_log(qdev, "dirty x[%d, %d], y[%d, %d]\n", clips->x1, clips->x2,
 189                    clips->y1, clips->y2);
 190         image->dx = clips->x1;
 191         image->dy = clips->y1;
 192         image->width = clips->x2 - clips->x1;
 193         image->height = clips->y2 - clips->y1;
 194         image->fg_color = 0xffffffff; /* unused, just to avoid uninitialized
 195                                          warnings */
 196         image->bg_color = 0;
 197         image->depth = 32;           /* TODO: take from somewhere? */
 198         image->cmap.start = 0;
 199         image->cmap.len = 0;
 200         image->cmap.red = NULL;
 201         image->cmap.green = NULL;
 202         image->cmap.blue = NULL;
 203         image->cmap.transp = NULL;
 204         image->data = qfbdev->shadow + (clips->x1 * 4) + (stride * clips->y1);
 205
 206         qxl_fb_image_init(&qxl_fb_image, qdev, info, NULL);
 207         qxl_draw_opaque_fb(&qxl_fb_image, stride);
 208
 209         return 0;
 210 }
 211
 212 static const struct drm_framebuffer_funcs qxlfb_fb_funcs = {
 213         .destroy = qxl_user_framebuffer_destroy,
 214         .dirty = qxlfb_framebuffer_dirty,
 215 };
 216
 217 static int qxlfb_create(struct qxl_fbdev *qfbdev,
 218                         struct drm_fb_helper_surface_size *sizes)
 219 {
 220         struct qxl_device *qdev = qfbdev->qdev;
 221         struct fb_info *info;
 222         struct drm_framebuffer *fb = NULL;
 223         struct drm_mode_fb_cmd2 mode_cmd;
 224         struct drm_gem_object *gobj = NULL;
 225         struct qxl_bo *qbo = NULL;
 226         int ret;
 227         int size;
 228         int bpp = sizes->surface_bpp;
 229         int depth = sizes->surface_depth;
 230         void *shadow;
 231
 232         mode_cmd.width = sizes->surface_width;
 233         mode_cmd.height = sizes->surface_height;
 234
 235         mode_cmd.pitches[0] = ALIGN(mode_cmd.width * ((bpp + 1) / 8), 64);
 236         mode_cmd.pixel_format = drm_mode_legacy_fb_format(bpp, depth);
 237
 238         ret = qxlfb_create_pinned_object(qfbdev, &mode_cmd, &gobj);
 239         if (ret < 0)
 240                 return ret;
 241
 242         qbo = gem_to_qxl_bo(gobj);
 243         DRM_DEBUG_DRIVER("%dx%d %d\n", mode_cmd.width,
 244                          mode_cmd.height, mode_cmd.pitches[0]);
 245
 246         shadow = vmalloc(mode_cmd.pitches[0] * mode_cmd.height);
 247         /* TODO: what's the usual response to memory allocation errors? */
 248         BUG_ON(!shadow);
 249         DRM_DEBUG_DRIVER("surface0 at gpu offset %lld, mmap_offset %lld (virt %p, shadow %p)\n",
 250                          qxl_bo_gpu_offset(qbo), qxl_bo_mmap_offset(qbo),
 251                          qbo->kptr, shadow);
 252         size = mode_cmd.pitches[0] * mode_cmd.height;
 253
 254         info = drm_fb_helper_alloc_fbi(&qfbdev->helper);
 255         if (IS_ERR(info)) {
 256                 ret = PTR_ERR(info);
 257                 goto out_unref;
 258         }
 259
 260         info->par = qfbdev;
 261
 262         qxl_framebuffer_init(&qdev->ddev, &qfbdev->qfb, &mode_cmd, gobj,
 263                              &qxlfb_fb_funcs);
 264
 265         fb = &qfbdev->qfb.base;
 266
 267         /* setup helper with fb data */
 268         qfbdev->helper.fb = fb;
 269
 270         qfbdev->shadow = shadow;
 271         strcpy(info->fix.id, "qxldrmfb");
 272
 273         drm_fb_helper_fill_fix(info, fb->pitches[0], fb->format->depth);
 274
 275         info->fbops = &qxlfb_ops;
 276
 277         /*
 278          * TODO: using gobj->size in various places in this function. Not sure
 279          * what the difference between the different sizes is.
 280          */
 281         info->fix.smem_start = qdev->vram_base; /* TODO - correct? */
 282         info->fix.smem_len = gobj->size;
 283         info->screen_base = qfbdev->shadow;
 284         info->screen_size = gobj->size;
 285
 286         drm_fb_helper_fill_var(info, &qfbdev->helper, sizes->fb_width,
 287                                sizes->fb_height);
 288
 289         /* setup aperture base/size for vesafb takeover */
 290         info->apertures->ranges[0].base = qdev->ddev.mode_config.fb_base;
 291         info->apertures->ranges[0].size = qdev->vram_size;
 292
 293         info->fix.mmio_start = 0;
 294         info->fix.mmio_len = 0;
 295
 296         if (info->screen_base == NULL) {
 297                 ret = -ENOSPC;
 298                 goto out_unref;
 299         }
 300
 301 #ifdef CONFIG_DRM_FBDEV_EMULATION
 302         info->fbdefio = &qxl_defio;
 303         fb_deferred_io_init(info);
 304 #endif
 305
 306         qdev->fbdev_info = info;
 307         qdev->fbdev_qfb = &qfbdev->qfb;
 308         DRM_INFO("fb mappable at 0x%lX, size %lu\n",  info->fix.smem_start, (unsigned long)info->screen_size);
 309         DRM_INFO("fb: depth %d, pitch %d, width %d, height %d\n",
 310                  fb->format->depth, fb->pitches[0], fb->width, fb->height);
 311         return 0;
 312
 313 out_unref:
 314         if (qbo) {
 315                 qxl_bo_kunmap(qbo);
 316                 qxl_bo_unpin(qbo);
 317         }
 318         if (fb && ret) {
 319                 drm_gem_object_unreference_unlocked(gobj);
 320                 drm_framebuffer_cleanup(fb);
 321                 kfree(fb);
 322         }
 323         drm_gem_object_unreference_unlocked(gobj);
 324         return ret;
 325 }
 326
 327 static int qxl_fb_find_or_create_single(
 328                 struct drm_fb_helper *helper,
 329                 struct drm_fb_helper_surface_size *sizes)
 330 {
 331         struct qxl_fbdev *qfbdev =
 332                 container_of(helper, struct qxl_fbdev, helper);
 333         int new_fb = 0;
 334         int ret;
 335
 336         if (!helper->fb) {
 337                 ret = qxlfb_create(qfbdev, sizes);
 338                 if (ret)
 339                         return ret;
 340                 new_fb = 1;
 341         }
 342         return new_fb;
 343 }
 344
 345 static int qxl_fbdev_destroy(struct drm_device *dev, struct qxl_fbdev *qfbdev)
 346 {
 347         struct qxl_framebuffer *qfb = &qfbdev->qfb;
 348
 349         drm_fb_helper_unregister_fbi(&qfbdev->helper);
 350
 351         if (qfb->obj) {
 352                 qxlfb_destroy_pinned_object(qfb->obj);
 353                 qfb->obj = NULL;
 354         }
 355         drm_fb_helper_fini(&qfbdev->helper);
 356         vfree(qfbdev->shadow);
 357         drm_framebuffer_cleanup(&qfb->base);
 358
 359         return 0;
 360 }
 361
 362 static const struct drm_fb_helper_funcs qxl_fb_helper_funcs = {
 363         .fb_probe = qxl_fb_find_or_create_single,
 364 };
 365
 366 int qxl_fbdev_init(struct qxl_device *qdev)
 367 {
 368         int ret = 0;
 369
 370 #ifdef CONFIG_DRM_FBDEV_EMULATION
 371         struct qxl_fbdev *qfbdev;
 372         int bpp_sel = 32; /* TODO: parameter from somewhere? */
 373
 374         qfbdev = kzalloc(sizeof(struct qxl_fbdev), GFP_KERNEL);
 375         if (!qfbdev)
 376                 return -ENOMEM;
 377
 378         qfbdev->qdev = qdev;
 379         qdev->mode_info.qfbdev = qfbdev;
 380         spin_lock_init(&qfbdev->delayed_ops_lock);
 381         INIT_LIST_HEAD(&qfbdev->delayed_ops);
 382
 383         drm_fb_helper_prepare(&qdev->ddev, &qfbdev->helper,
 384                               &qxl_fb_helper_funcs);
 385
 386         ret = drm_fb_helper_init(&qdev->ddev, &qfbdev->helper,
 387                                  QXLFB_CONN_LIMIT);
 388         if (ret)
 389                 goto free;
 390
 391         ret = drm_fb_helper_single_add_all_connectors(&qfbdev->helper);
 392         if (ret)
 393                 goto fini;
 394
 395         ret = drm_fb_helper_initial_config(&qfbdev->helper, bpp_sel);
 396         if (ret)
 397                 goto fini;
 398
 399         return 0;
 400
 401 fini:
 402         drm_fb_helper_fini(&qfbdev->helper);
 403 free:
 404         kfree(qfbdev);
 405 #endif
 406
 407         return ret;
 408 }
 409
 410 void qxl_fbdev_fini(struct qxl_device *qdev)
 411 {
 412         if (!qdev->mode_info.qfbdev)
 413                 return;
 414
 415         qxl_fbdev_destroy(&qdev->ddev, qdev->mode_info.qfbdev);
 416         kfree(qdev->mode_info.qfbdev);
 417         qdev->mode_info.qfbdev = NULL;
 418 }
 419
 420 void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state)
 421 {
 422         if (!qdev->mode_info.qfbdev)
 423                 return;
 424
 425         drm_fb_helper_set_suspend(&qdev->mode_info.qfbdev->helper, state);
 426 }
 427
 428 bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj)
 429 {
 430         if (qobj == gem_to_qxl_bo(qdev->mode_info.qfbdev->qfb.obj))
 431                 return true;
 432         return false;
 433 }