2 * Copyright © 2013 Red Hat
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:
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
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.
26 #include <linux/module.h>
31 #include "drm/drm_crtc.h"
32 #include "drm/drm_crtc_helper.h"
35 #include "qxl_object.h"
36 #include "drm_fb_helper.h"
38 #define QXL_DIRTY_DELAY (HZ / 30)
41 struct drm_fb_helper helper;
42 struct qxl_framebuffer qfb;
43 struct list_head fbdev_list;
44 struct qxl_device *qdev;
46 spinlock_t delayed_ops_lock;
47 struct list_head delayed_ops;
51 /* dirty memory logging */
61 static void qxl_fb_image_init(struct qxl_fb_image *qxl_fb_image,
62 struct qxl_device *qdev, struct fb_info *info,
63 const struct fb_image *image)
65 qxl_fb_image->qdev = qdev;
67 qxl_fb_image->visual = info->fix.visual;
68 if (qxl_fb_image->visual == FB_VISUAL_TRUECOLOR ||
69 qxl_fb_image->visual == FB_VISUAL_DIRECTCOLOR)
70 memcpy(&qxl_fb_image->pseudo_palette,
72 sizeof(qxl_fb_image->pseudo_palette));
75 if (image->depth == 1)
76 qxl_fb_image->visual = FB_VISUAL_MONO10;
78 qxl_fb_image->visual = FB_VISUAL_DIRECTCOLOR;
81 memcpy(&qxl_fb_image->fb_image, image,
82 sizeof(qxl_fb_image->fb_image));
86 static void qxl_fb_dirty_flush(struct fb_info *info)
88 struct qxl_fbdev *qfbdev = info->par;
89 struct qxl_device *qdev = qfbdev->qdev;
90 struct qxl_fb_image qxl_fb_image;
91 struct fb_image *image = &qxl_fb_image.fb_image;
95 /* TODO: hard coding 32 bpp */
96 int stride = qfbdev->qfb.base.pitches[0];
98 spin_lock_irqsave(&qfbdev->dirty.lock, flags);
100 x1 = qfbdev->dirty.x1;
101 x2 = qfbdev->dirty.x2;
102 y1 = qfbdev->dirty.y1;
103 y2 = qfbdev->dirty.y2;
104 qfbdev->dirty.x1 = 0;
105 qfbdev->dirty.x2 = 0;
106 qfbdev->dirty.y1 = 0;
107 qfbdev->dirty.y2 = 0;
109 spin_unlock_irqrestore(&qfbdev->dirty.lock, flags);
112 * we are using a shadow draw buffer, at qdev->surface0_shadow
114 qxl_io_log(qdev, "dirty x[%d, %d], y[%d, %d]", x1, x2, y1, y2);
117 image->width = x2 - x1 + 1;
118 image->height = y2 - y1 + 1;
119 image->fg_color = 0xffffffff; /* unused, just to avoid uninitialized
122 image->depth = 32; /* TODO: take from somewhere? */
123 image->cmap.start = 0;
125 image->cmap.red = NULL;
126 image->cmap.green = NULL;
127 image->cmap.blue = NULL;
128 image->cmap.transp = NULL;
129 image->data = qfbdev->shadow + (x1 * 4) + (stride * y1);
131 qxl_fb_image_init(&qxl_fb_image, qdev, info, NULL);
132 qxl_draw_opaque_fb(&qxl_fb_image, stride);
135 static void qxl_dirty_update(struct qxl_fbdev *qfbdev,
136 int x, int y, int width, int height)
138 struct qxl_device *qdev = qfbdev->qdev;
145 spin_lock_irqsave(&qfbdev->dirty.lock, flags);
147 if (qfbdev->dirty.y1 < y)
148 y = qfbdev->dirty.y1;
149 if (qfbdev->dirty.y2 > y2)
150 y2 = qfbdev->dirty.y2;
151 if (qfbdev->dirty.x1 < x)
152 x = qfbdev->dirty.x1;
153 if (qfbdev->dirty.x2 > x2)
154 x2 = qfbdev->dirty.x2;
156 qfbdev->dirty.x1 = x;
157 qfbdev->dirty.x2 = x2;
158 qfbdev->dirty.y1 = y;
159 qfbdev->dirty.y2 = y2;
161 spin_unlock_irqrestore(&qfbdev->dirty.lock, flags);
163 schedule_work(&qdev->fb_work);
166 static void qxl_deferred_io(struct fb_info *info,
167 struct list_head *pagelist)
169 struct qxl_fbdev *qfbdev = info->par;
170 unsigned long start, end, min, max;
176 list_for_each_entry(page, pagelist, lru) {
177 start = page->index << PAGE_SHIFT;
178 end = start + PAGE_SIZE - 1;
179 min = min(min, start);
184 y1 = min / info->fix.line_length;
185 y2 = (max / info->fix.line_length) + 1;
186 qxl_dirty_update(qfbdev, 0, y1, info->var.xres, y2 - y1);
190 static struct fb_deferred_io qxl_defio = {
191 .delay = QXL_DIRTY_DELAY,
192 .deferred_io = qxl_deferred_io,
195 static void qxl_fb_fillrect(struct fb_info *info,
196 const struct fb_fillrect *rect)
198 struct qxl_fbdev *qfbdev = info->par;
200 drm_fb_helper_sys_fillrect(info, rect);
201 qxl_dirty_update(qfbdev, rect->dx, rect->dy, rect->width,
205 static void qxl_fb_copyarea(struct fb_info *info,
206 const struct fb_copyarea *area)
208 struct qxl_fbdev *qfbdev = info->par;
210 drm_fb_helper_sys_copyarea(info, area);
211 qxl_dirty_update(qfbdev, area->dx, area->dy, area->width,
215 static void qxl_fb_imageblit(struct fb_info *info,
216 const struct fb_image *image)
218 struct qxl_fbdev *qfbdev = info->par;
220 drm_fb_helper_sys_imageblit(info, image);
221 qxl_dirty_update(qfbdev, image->dx, image->dy, image->width,
225 static void qxl_fb_work(struct work_struct *work)
227 struct qxl_device *qdev = container_of(work, struct qxl_device, fb_work);
228 struct qxl_fbdev *qfbdev = qdev->mode_info.qfbdev;
230 qxl_fb_dirty_flush(qfbdev->helper.fbdev);
233 int qxl_fb_init(struct qxl_device *qdev)
235 INIT_WORK(&qdev->fb_work, qxl_fb_work);
239 static struct fb_ops qxlfb_ops = {
240 .owner = THIS_MODULE,
241 .fb_check_var = drm_fb_helper_check_var,
242 .fb_set_par = drm_fb_helper_set_par, /* TODO: copy vmwgfx */
243 .fb_fillrect = qxl_fb_fillrect,
244 .fb_copyarea = qxl_fb_copyarea,
245 .fb_imageblit = qxl_fb_imageblit,
246 .fb_pan_display = drm_fb_helper_pan_display,
247 .fb_blank = drm_fb_helper_blank,
248 .fb_setcmap = drm_fb_helper_setcmap,
249 .fb_debug_enter = drm_fb_helper_debug_enter,
250 .fb_debug_leave = drm_fb_helper_debug_leave,
253 static void qxlfb_destroy_pinned_object(struct drm_gem_object *gobj)
255 struct qxl_bo *qbo = gem_to_qxl_bo(gobj);
258 ret = qxl_bo_reserve(qbo, false);
259 if (likely(ret == 0)) {
262 qxl_bo_unreserve(qbo);
264 drm_gem_object_unreference_unlocked(gobj);
267 int qxl_get_handle_for_primary_fb(struct qxl_device *qdev,
268 struct drm_file *file_priv,
272 struct drm_gem_object *gobj = qdev->fbdev_qfb->obj;
275 /* drm_get_handle_create adds a reference - good */
276 r = drm_gem_handle_create(file_priv, gobj, handle);
282 static int qxlfb_create_pinned_object(struct qxl_fbdev *qfbdev,
283 struct drm_mode_fb_cmd2 *mode_cmd,
284 struct drm_gem_object **gobj_p)
286 struct qxl_device *qdev = qfbdev->qdev;
287 struct drm_gem_object *gobj = NULL;
288 struct qxl_bo *qbo = NULL;
290 int aligned_size, size;
291 int height = mode_cmd->height;
295 drm_fb_get_bpp_depth(mode_cmd->pixel_format, &bpp, &depth);
297 size = mode_cmd->pitches[0] * height;
298 aligned_size = ALIGN(size, PAGE_SIZE);
299 /* TODO: unallocate and reallocate surface0 for real. Hack to just
300 * have a large enough surface0 for 1024x768 Xorg 32bpp mode */
301 ret = qxl_gem_object_create(qdev, aligned_size, 0,
302 QXL_GEM_DOMAIN_SURFACE,
303 false, /* is discardable */
304 false, /* is kernel (false means device) */
308 pr_err("failed to allocate framebuffer (%d)\n",
312 qbo = gem_to_qxl_bo(gobj);
314 qbo->surf.width = mode_cmd->width;
315 qbo->surf.height = mode_cmd->height;
316 qbo->surf.stride = mode_cmd->pitches[0];
317 qbo->surf.format = SPICE_SURFACE_FMT_32_xRGB;
318 ret = qxl_bo_reserve(qbo, false);
319 if (unlikely(ret != 0))
321 ret = qxl_bo_pin(qbo, QXL_GEM_DOMAIN_SURFACE, NULL);
323 qxl_bo_unreserve(qbo);
326 ret = qxl_bo_kmap(qbo, NULL);
327 qxl_bo_unreserve(qbo); /* unreserve, will be mmaped */
334 qxlfb_destroy_pinned_object(gobj);
339 static int qxlfb_create(struct qxl_fbdev *qfbdev,
340 struct drm_fb_helper_surface_size *sizes)
342 struct qxl_device *qdev = qfbdev->qdev;
343 struct fb_info *info;
344 struct drm_framebuffer *fb = NULL;
345 struct drm_mode_fb_cmd2 mode_cmd;
346 struct drm_gem_object *gobj = NULL;
347 struct qxl_bo *qbo = NULL;
350 int bpp = sizes->surface_bpp;
351 int depth = sizes->surface_depth;
354 mode_cmd.width = sizes->surface_width;
355 mode_cmd.height = sizes->surface_height;
357 mode_cmd.pitches[0] = ALIGN(mode_cmd.width * ((bpp + 1) / 8), 64);
358 mode_cmd.pixel_format = drm_mode_legacy_fb_format(bpp, depth);
360 ret = qxlfb_create_pinned_object(qfbdev, &mode_cmd, &gobj);
361 qbo = gem_to_qxl_bo(gobj);
362 QXL_INFO(qdev, "%s: %dx%d %d\n", __func__, mode_cmd.width,
363 mode_cmd.height, mode_cmd.pitches[0]);
365 shadow = vmalloc(mode_cmd.pitches[0] * mode_cmd.height);
366 /* TODO: what's the usual response to memory allocation errors? */
369 "surface0 at gpu offset %lld, mmap_offset %lld (virt %p, shadow %p)\n",
370 qxl_bo_gpu_offset(qbo),
371 qxl_bo_mmap_offset(qbo),
374 size = mode_cmd.pitches[0] * mode_cmd.height;
376 info = drm_fb_helper_alloc_fbi(&qfbdev->helper);
384 qxl_framebuffer_init(qdev->ddev, &qfbdev->qfb, &mode_cmd, gobj);
386 fb = &qfbdev->qfb.base;
388 /* setup helper with fb data */
389 qfbdev->helper.fb = fb;
391 qfbdev->shadow = shadow;
392 strcpy(info->fix.id, "qxldrmfb");
394 drm_fb_helper_fill_fix(info, fb->pitches[0], fb->depth);
396 info->flags = FBINFO_DEFAULT | FBINFO_HWACCEL_COPYAREA | FBINFO_HWACCEL_FILLRECT;
397 info->fbops = &qxlfb_ops;
400 * TODO: using gobj->size in various places in this function. Not sure
401 * what the difference between the different sizes is.
403 info->fix.smem_start = qdev->vram_base; /* TODO - correct? */
404 info->fix.smem_len = gobj->size;
405 info->screen_base = qfbdev->shadow;
406 info->screen_size = gobj->size;
408 drm_fb_helper_fill_var(info, &qfbdev->helper, sizes->fb_width,
411 /* setup aperture base/size for vesafb takeover */
412 info->apertures->ranges[0].base = qdev->ddev->mode_config.fb_base;
413 info->apertures->ranges[0].size = qdev->vram_size;
415 info->fix.mmio_start = 0;
416 info->fix.mmio_len = 0;
418 if (info->screen_base == NULL) {
420 goto out_destroy_fbi;
423 info->fbdefio = &qxl_defio;
424 fb_deferred_io_init(info);
426 qdev->fbdev_info = info;
427 qdev->fbdev_qfb = &qfbdev->qfb;
428 DRM_INFO("fb mappable at 0x%lX, size %lu\n", info->fix.smem_start, (unsigned long)info->screen_size);
429 DRM_INFO("fb: depth %d, pitch %d, width %d, height %d\n", fb->depth, fb->pitches[0], fb->width, fb->height);
433 drm_fb_helper_release_fbi(&qfbdev->helper);
436 ret = qxl_bo_reserve(qbo, false);
437 if (likely(ret == 0)) {
440 qxl_bo_unreserve(qbo);
444 drm_gem_object_unreference(gobj);
445 drm_framebuffer_cleanup(fb);
448 drm_gem_object_unreference(gobj);
452 static int qxl_fb_find_or_create_single(
453 struct drm_fb_helper *helper,
454 struct drm_fb_helper_surface_size *sizes)
456 struct qxl_fbdev *qfbdev =
457 container_of(helper, struct qxl_fbdev, helper);
462 ret = qxlfb_create(qfbdev, sizes);
470 static int qxl_fbdev_destroy(struct drm_device *dev, struct qxl_fbdev *qfbdev)
472 struct qxl_framebuffer *qfb = &qfbdev->qfb;
474 drm_fb_helper_unregister_fbi(&qfbdev->helper);
475 drm_fb_helper_release_fbi(&qfbdev->helper);
478 qxlfb_destroy_pinned_object(qfb->obj);
481 drm_fb_helper_fini(&qfbdev->helper);
482 vfree(qfbdev->shadow);
483 drm_framebuffer_cleanup(&qfb->base);
488 static const struct drm_fb_helper_funcs qxl_fb_helper_funcs = {
489 .fb_probe = qxl_fb_find_or_create_single,
492 int qxl_fbdev_init(struct qxl_device *qdev)
494 struct qxl_fbdev *qfbdev;
495 int bpp_sel = 32; /* TODO: parameter from somewhere? */
498 qfbdev = kzalloc(sizeof(struct qxl_fbdev), GFP_KERNEL);
503 qdev->mode_info.qfbdev = qfbdev;
504 spin_lock_init(&qfbdev->delayed_ops_lock);
505 spin_lock_init(&qfbdev->dirty.lock);
506 INIT_LIST_HEAD(&qfbdev->delayed_ops);
508 drm_fb_helper_prepare(qdev->ddev, &qfbdev->helper,
509 &qxl_fb_helper_funcs);
511 ret = drm_fb_helper_init(qdev->ddev, &qfbdev->helper,
512 qxl_num_crtc /* num_crtc - QXL supports just 1 */,
517 ret = drm_fb_helper_single_add_all_connectors(&qfbdev->helper);
521 ret = drm_fb_helper_initial_config(&qfbdev->helper, bpp_sel);
528 drm_fb_helper_fini(&qfbdev->helper);
534 void qxl_fbdev_fini(struct qxl_device *qdev)
536 if (!qdev->mode_info.qfbdev)
539 qxl_fbdev_destroy(qdev->ddev, qdev->mode_info.qfbdev);
540 kfree(qdev->mode_info.qfbdev);
541 qdev->mode_info.qfbdev = NULL;
544 void qxl_fbdev_set_suspend(struct qxl_device *qdev, int state)
546 drm_fb_helper_set_suspend(&qdev->mode_info.qfbdev->helper, state);
549 bool qxl_fbdev_qobj_is_fb(struct qxl_device *qdev, struct qxl_bo *qobj)
551 if (qobj == gem_to_qxl_bo(qdev->mode_info.qfbdev->qfb.obj))