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 #include <linux/fb.h>
  28
  29 #include "drmP.h"
  30 #include "drm/drm.h"
  31 #include "drm/drm_crtc.h"
  32 #include "drm/drm_crtc_helper.h"
  33 #include "qxl_drv.h"
  34
  35 #include "qxl_object.h"
  36 #include "drm_fb_helper.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 static struct fb_deferred_io qxl_defio = {
  77         .delay          = QXL_DIRTY_DELAY,
  78         .deferred_io    = drm_fb_helper_deferred_io,
  79 };
  80
  81 static struct fb_ops qxlfb_ops = {
  82         .owner = THIS_MODULE,
  83         .fb_check_var = drm_fb_helper_check_var,
  84         .fb_set_par = drm_fb_helper_set_par, /* TODO: copy vmwgfx */
  85         .fb_fillrect = drm_fb_helper_sys_fillrect,
  86         .fb_copyarea = drm_fb_helper_sys_copyarea,
  87         .fb_imageblit = drm_fb_helper_sys_imageblit,
  88         .fb_pan_display = drm_fb_helper_pan_display,
  89         .fb_blank = drm_fb_helper_blank,
  90         .fb_setcmap = drm_fb_helper_setcmap,
  91         .fb_debug_enter = drm_fb_helper_debug_enter,
  92         .fb_debug_leave = drm_fb_helper_debug_leave,
  93 };
  94
  95 static void qxlfb_destroy_pinned_object(struct drm_gem_object *gobj)
  96 {
  97         struct qxl_bo *qbo = gem_to_qxl_bo(gobj);
  98         int ret;
  99
 100         ret = qxl_bo_reserve(qbo, false);
 101         if (likely(ret == 0)) {
 102                 qxl_bo_kunmap(qbo);
 103                 qxl_bo_unpin(qbo);
 104                 qxl_bo_unreserve(qbo);
 105         }
 106         drm_gem_object_unreference_unlocked(gobj);
 107 }
 108
 109 int qxl_get_handle_for_primary_fb(struct qxl_device *qdev,
 110                                   struct drm_file *file_priv,
 111                                   uint32_t *handle)
 112 {
 113         int r;
 114         struct drm_gem_object *gobj = qdev->fbdev_qfb->obj;
 115
 116         BUG_ON(!gobj);
 117         /* drm_get_handle_create adds a reference - good */
 118         r = drm_gem_handle_create(file_priv, gobj, handle);
 119         if (r)
 120                 return r;
 121         return 0;
 122 }
 123
 124 static int qxlfb_create_pinned_object(struct qxl_fbdev *qfbdev,
 125                                       const struct drm_mode_fb_cmd2 *mode_cmd,
 126                                       struct drm_gem_object **gobj_p)
 127 {
 128         struct qxl_device *qdev = qfbdev->qdev;
 129         struct drm_gem_object *gobj = NULL;
 130         struct qxl_bo *qbo = NULL;
 131         int ret;
 132         int aligned_size, size;
 133         int height = mode_cmd->height;
 134
 135         size = mode_cmd->pitches[0] * height;
 136         aligned_size = ALIGN(size, PAGE_SIZE);
 137         /* TODO: unallocate and reallocate surface0 for real. Hack to just
 138          * have a large enough surface0 for 1024x768 Xorg 32bpp mode */
 139         ret = qxl_gem_object_create(qdev, aligned_size, 0,
 140                                     QXL_GEM_DOMAIN_SURFACE,
 141                                     false, /* is discardable */
 142                                     false, /* is kernel (false means device) */
 143                                     NULL,
 144                                     &gobj);
 145         if (ret) {
 146                 pr_err("failed to allocate framebuffer (%d)\n",
 147                        aligned_size);
 148                 return -ENOMEM;
 149         }
 150         qbo = gem_to_qxl_bo(gobj);
 151
 152         qbo->surf.width = mode_cmd->width;
 153         qbo->surf.height = mode_cmd->height;
 154         qbo->surf.stride = mode_cmd->pitches[0];
 155         qbo->surf.format = SPICE_SURFACE_FMT_32_xRGB;
 156         ret = qxl_bo_reserve(qbo, false);
 157         if (unlikely(ret != 0))
 158                 goto out_unref;
 159         ret = qxl_bo_pin(qbo, QXL_GEM_DOMAIN_SURFACE, NULL);
 160         if (ret) {
 161                 qxl_bo_unreserve(qbo);
 162                 goto out_unref;
 163         }
 164         ret = qxl_bo_kmap(qbo, NULL);
 165         qxl_bo_unreserve(qbo); /* unreserve, will be mmaped */
 166         if (ret)
 167                 goto out_unref;
 168
 169         *gobj_p = gobj;
 170         return 0;
 171 out_unref:
 172         qxlfb_destroy_pinned_object(gobj);
 173         *gobj_p = NULL;
 174         return ret;
 175 }
 176
 177 /*
 178  * FIXME
 179  * It should not be necessary to have a special dirty() callback for fbdev.
 180  */
 181 static int qxlfb_framebuffer_dirty(struct drm_framebuffer *fb,
 182                                    struct drm_file *file_priv,
 183                                    unsigned flags, unsigned color,
 184                                    struct drm_clip_rect *clips,
 185                                    unsigned num_clips)
 186 {
 187         struct qxl_device *qdev = fb->dev->dev_private;
 188         struct fb_info *info = qdev->fbdev_info;
 189         struct qxl_fbdev *qfbdev = info->par;
 190         struct qxl_fb_image qxl_fb_image;
 191         struct fb_image *image = &qxl_fb_image.fb_image;
 192
 193         /* TODO: hard coding 32 bpp */
 194         int stride = qfbdev->qfb.base.pitches[0];
 195
 196         /*
 197          * we are using a shadow draw buffer, at qdev->surface0_shadow
 198          */
 199         qxl_io_log(qdev, "dirty x[%d, %d], y[%d, %d]", clips->x1, clips->x2,
 200                    clips->y1, clips->y2);
 201         image->dx = clips->x1;
 202         image->dy = clips->y1;
 203         image->width = clips->x2 - clips->x1;
 204         image->height = clips->y2 - clips->y1;
 205         image->fg_color = 0xffffffff; /* unused, just to avoid uninitialized
 206                                          warnings */
 207         image->bg_color = 0;
 208         image->depth = 32;           /* TODO: take from somewhere? */
 209         image->cmap.start = 0;
 210         image->cmap.len = 0;
 211         image->cmap.red = NULL;
 212         image->cmap.green = NULL;
 213         image->cmap.blue = NULL;
 214         image->cmap.transp = NULL;
 215         image->data = qfbdev->shadow + (clips->x1 * 4) + (stride * clips->y1);
 216
 217         qxl_fb_image_init(&qxl_fb_image, qdev, info, NULL);
 218         qxl_draw_opaque_fb(&qxl_fb_image, stride);
 219
 220         return 0;
 221 }
 222
 223 static const struct drm_framebuffer_funcs qxlfb_fb_funcs = {
 224         .destroy = qxl_user_framebuffer_destroy,
 225         .dirty = qxlfb_framebuffer_dirty,
 226 };
 227
 228 static int qxlfb_create(struct qxl_fbdev *qfbdev,
 229                         struct drm_fb_helper_surface_size *sizes)
 230 {
 231         struct qxl_device *qdev = qfbdev->qdev;
 232         struct fb_info *info;
 233         struct drm_framebuffer *fb = NULL;
 234         struct drm_mode_fb_cmd2 mode_cmd;
 235         struct drm_gem_object *gobj = NULL;
 236         struct qxl_bo *qbo = NULL;
 237         int ret;
 238         int size;
 239         int bpp = sizes->surface_bpp;
 240         int depth = sizes->surface_depth;
 241         void *shadow;
 242
 243         mode_cmd.width = sizes->surface_width;
 244         mode_cmd.height = sizes->surface_height;
 245
 246         mode_cmd.pitches[0] = ALIGN(mode_cmd.width * ((bpp + 1) / 8), 64);
 247         mode_cmd.pixel_format = drm_mode_legacy_fb_format(bpp, depth);
 248
 249         ret = qxlfb_create_pinned_object(qfbdev, &mode_cmd, &gobj);
 250         if (ret < 0)
 251                 return ret;
 252
 253         qbo = gem_to_qxl_bo(gobj);
 254         QXL_INFO(qdev, "%s: %dx%d %d\n", __func__, mode_cmd.width,
 255                  mode_cmd.height, mode_cmd.pitches[0]);
 256
 257         shadow = vmalloc(mode_cmd.pitches[0] * mode_cmd.height);
 258         /* TODO: what's the usual response to memory allocation errors? */
 259         BUG_ON(!shadow);
 260         QXL_INFO(qdev,
 261         "surface0 at gpu offset %lld, mmap_offset %lld (virt %p, shadow %p)\n",
 262                  qxl_bo_gpu_offset(qbo),
 263                  qxl_bo_mmap_offset(qbo),
 264                  qbo->kptr,
 265                  shadow);
 266         size = mode_cmd.pitches[0] * mode_cmd.height;
 267
 268         info = drm_fb_helper_alloc_fbi(&qfbdev->helper);
 269         if (IS_ERR(info)) {
 270                 ret = PTR_ERR(info);
 271                 goto out_unref;
 272         }
 273
 274         info->par = qfbdev;
 275
 276         qxl_framebuffer_init(qdev->ddev, &qfbdev->qfb, &mode_cmd, gobj,
 277                              &qxlfb_fb_funcs);
 278
 279         fb = &qfbdev->qfb.base;
 280
 281         /* setup helper with fb data */
 282         qfbdev->helper.fb = fb;
 283
 284         qfbdev->shadow = shadow;
 285         strcpy(info->fix.id, "qxldrmfb");
 286
 287         drm_fb_helper_fill_fix(info, fb->pitches[0], fb->depth);
 288
 289         info->flags = FBINFO_DEFAULT | FBINFO_HWACCEL_COPYAREA | FBINFO_HWACCEL_FILLRECT;
 290         info->fbops = &qxlfb_ops;
 291
 292         /*
 293          * TODO: using gobj->size in various places in this function. Not sure
 294          * what the difference between the different sizes is.
 295          */
 296         info->fix.smem_start = qdev->vram_base; /* TODO - correct? */
 297         info->fix.smem_len = gobj->size;
 298         info->screen_base = qfbdev->shadow;
 299         info->screen_size = gobj->size;
 300
 301         drm_fb_helper_fill_var(info, &qfbdev->helper, sizes->fb_width,
 302                                sizes->fb_height);
 303
 304         /* setup aperture base/size for vesafb takeover */
 305         info->apertures->ranges[0].base = qdev->ddev->mode_config.fb_base;
 306         info->apertures->ranges[0].size = qdev->vram_size;
 307
 308         info->fix.mmio_start = 0;
 309         info->fix.mmio_len = 0;
 310
 311         if (info->screen_base == NULL) {
 312                 ret = -ENOSPC;
 313                 goto out_destroy_fbi;
 314         }
 315
 316         info->fbdefio = &qxl_defio;
 317         fb_deferred_io_init(info);
 318
 319         qdev->fbdev_info = info;
 320         qdev->fbdev_qfb = &qfbdev->qfb;
 321         DRM_INFO("fb mappable at 0x%lX, size %lu\n",  info->fix.smem_start, (unsigned long)info->screen_size);
 322         DRM_INFO("fb: depth %d, pitch %d, width %d, height %d\n", fb->depth, fb->pitches[0], fb->width, fb->height);
 323         return 0;
 324
 325 out_destroy_fbi:
 326         drm_fb_helper_release_fbi(&qfbdev->helper);
 327 out_unref:
 328         if (qbo) {
 329                 ret = qxl_bo_reserve(qbo, false);
 330                 if (likely(ret == 0)) {
 331                         qxl_bo_kunmap(qbo);
 332                         qxl_bo_unpin(qbo);
 333                         qxl_bo_unreserve(qbo);
 334                 }
 335         }
 336         if (fb && ret) {
 337                 drm_gem_object_unreference_unlocked(gobj);
 338                 drm_framebuffer_cleanup(fb);
 339                 kfree(fb);
 340         }
 341         drm_gem_object_unreference_unlocked(gobj);
 342         return ret;
 343 }
 344
 345 static int qxl_fb_find_or_create_single(
 346                 struct drm_fb_helper *helper,
 347                 struct drm_fb_helper_surface_size *sizes)
 348 {
 349         struct qxl_fbdev *qfbdev =
 350                 container_of(helper, struct qxl_fbdev, helper);
 351         int new_fb = 0;
 352         int ret;
 353
 354         if (!helper->fb) {
 355                 ret = qxlfb_create(qfbdev, sizes);
 356                 if (ret)
 357                         return ret;
 358                 new_fb = 1;
 359         }
 360         return new_fb;
 361 }
 362
 363 static int qxl_fbdev_destroy(struct drm_device *dev, struct qxl_fbdev *qfbdev)
 364 {
 365         struct qxl_framebuffer *qfb = &qfbdev->qfb;
 366
 367         drm_fb_helper_unregister_fbi(&qfbdev->helper);
 368         drm_fb_helper_release_fbi(&qfbdev->helper);
 369
 370         if (qfb->obj) {
 371                 qxlfb_destroy_pinned_object(qfb->obj);
 372                 qfb->obj = NULL;
 373         }
 374         drm_fb_helper_fini(&qfbdev->helper);
 375         vfree(qfbdev->shadow);
 376         drm_framebuffer_cleanup(&qfb->base);
 377
 378         return 0;
 379 }
 380
 381 static const struct drm_fb_helper_funcs qxl_fb_helper_funcs = {
 382         .fb_probe = qxl_fb_find_or_create_single,
 383 };
 384
 385 int qxl_fbdev_init(struct qxl_device *qdev)
 386 {
 387         struct qxl_fbdev *qfbdev;
 388         int bpp_sel = 32; /* TODO: parameter from somewhere? */
 389         int ret;
 390
 391         qfbdev = kzalloc(sizeof(struct qxl_fbdev), GFP_KERNEL);
 392         if (!qfbdev)
 393                 return -ENOMEM;
 394
 395         qfbdev->qdev = qdev;
 396         qdev->mode_info.qfbdev = qfbdev;
 397         spin_lock_init(&qfbdev->delayed_ops_lock);
 398         INIT_LIST_HEAD(&qfbdev->delayed_ops);
 399
 400         drm_fb_helper_prepare(qdev->ddev, &qfbdev->helper,
 401                               &qxl_fb_helper_funcs);
 402
 403         ret = drm_fb_helper_init(qdev->ddev, &qfbdev->helper,
 404                                  qxl_num_crtc /* num_crtc - QXL supports just 1 */,
 405                                  QXLFB_CONN_LIMIT);
 406         if (ret)
 407                 goto free;
 408
 409         ret = drm_fb_helper_single_add_all_connectors(&qfbdev->helper);
 410         if (ret)
 411                 goto fini;
 412
 413         ret = drm_fb_helper_initial_config(&qfbdev->helper, bpp_sel);
 414         if (ret)
 415                 goto fini;
 416
 417         return 0;
 418
 419 fini:
 420         drm_fb_helper_fini(&qfbdev->helper);
 421 free:
 422         kfree(qfbdev);
 423         return ret;
 424 }
 425
 426 void qxl_fbdev_fini(struct qxl_device *qdev)
 427 {
 428         if (!qdev->mode_info.qfbdev)
 429                 return;
 430
 431         qxl_fbdev_destroy(qdev->ddev, qdev->mode_info.qfbdev);
 432         kfree(qdev->mode_info.qfbdev);
 433         qdev->mode_info.qfbdev = NULL;
 434 }
 435
 436 void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state)
 437 {
 438         drm_fb_helper_set_suspend(&qdev->mode_info.qfbdev->helper, state);
 439 }
 440
 441 bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj)
 442 {
 443         if (qobj == gem_to_qxl_bo(qdev->mode_info.qfbdev->qfb.obj))
 444                 return true;
 445         return false;
 446 }