1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2012 Red Hat
5 * based in parts on udlfb.c:
11 #include <linux/moduleparam.h>
12 #include <linux/dma-buf.h>
14 #include <drm/drm_crtc_helper.h>
15 #include <drm/drm_drv.h>
16 #include <drm/drm_fb_helper.h>
17 #include <drm/drm_fourcc.h>
18 #include <drm/drm_modeset_helper.h>
22 #define DL_DEFIO_WRITE_DELAY (HZ/20) /* fb_deferred_io.delay in jiffies */
24 static int fb_defio = 0; /* Optionally enable experimental fb_defio mmap support */
25 static int fb_bpp = 16;
27 module_param(fb_bpp, int, S_IWUSR | S_IRUSR | S_IWGRP | S_IRGRP);
28 module_param(fb_defio, int, S_IWUSR | S_IRUSR | S_IWGRP | S_IRGRP);
31 struct drm_fb_helper helper; /* must be first */
32 struct udl_framebuffer ufb;
36 #define DL_ALIGN_UP(x, a) ALIGN(x, a)
37 #define DL_ALIGN_DOWN(x, a) ALIGN_DOWN(x, a)
39 /** Read the red component (0..255) of a 32 bpp colour. */
40 #define DLO_RGB_GETRED(col) (uint8_t)((col) & 0xFF)
42 /** Read the green component (0..255) of a 32 bpp colour. */
43 #define DLO_RGB_GETGRN(col) (uint8_t)(((col) >> 8) & 0xFF)
45 /** Read the blue component (0..255) of a 32 bpp colour. */
46 #define DLO_RGB_GETBLU(col) (uint8_t)(((col) >> 16) & 0xFF)
48 /** Return red/green component of a 16 bpp colour number. */
49 #define DLO_RG16(red, grn) (uint8_t)((((red) & 0xF8) | ((grn) >> 5)) & 0xFF)
51 /** Return green/blue component of a 16 bpp colour number. */
52 #define DLO_GB16(grn, blu) (uint8_t)(((((grn) & 0x1C) << 3) | ((blu) >> 3)) & 0xFF)
54 /** Return 8 bpp colour number from red, green and blue components. */
55 #define DLO_RGB8(red, grn, blu) ((((red) << 5) | (((grn) & 3) << 3) | ((blu) & 7)) & 0xFF)
58 static uint8_t rgb8(uint32_t col)
60 uint8_t red = DLO_RGB_GETRED(col);
61 uint8_t grn = DLO_RGB_GETGRN(col);
62 uint8_t blu = DLO_RGB_GETBLU(col);
64 return DLO_RGB8(red, grn, blu);
67 static uint16_t rgb16(uint32_t col)
69 uint8_t red = DLO_RGB_GETRED(col);
70 uint8_t grn = DLO_RGB_GETGRN(col);
71 uint8_t blu = DLO_RGB_GETBLU(col);
73 return (DLO_RG16(red, grn) << 8) + DLO_GB16(grn, blu);
77 int udl_handle_damage(struct udl_framebuffer *fb, int x, int y,
78 int width, int height)
80 struct drm_device *dev = fb->base.dev;
81 struct udl_device *udl = to_udl(dev);
84 cycles_t start_cycles, end_cycles;
86 int bytes_identical = 0;
91 BUG_ON(!is_power_of_2(fb->base.format->cpp[0]));
92 log_bpp = __ffs(fb->base.format->cpp[0]);
97 if (!fb->obj->vmapping) {
98 ret = udl_gem_vmap(fb->obj);
100 DRM_ERROR("failed to vmap fb\n");
103 if (!fb->obj->vmapping) {
104 DRM_ERROR("failed to vmapping\n");
109 aligned_x = DL_ALIGN_DOWN(x, sizeof(unsigned long));
110 width = DL_ALIGN_UP(width + (x-aligned_x), sizeof(unsigned long));
114 (x + width > fb->base.width) ||
115 (y + height > fb->base.height))
118 start_cycles = get_cycles();
120 urb = udl_get_urb(dev);
123 cmd = urb->transfer_buffer;
125 for (i = y; i < y + height ; i++) {
126 const int line_offset = fb->base.pitches[0] * i;
127 const int byte_offset = line_offset + (x << log_bpp);
128 const int dev_byte_offset = (fb->base.width * i + x) << log_bpp;
129 if (udl_render_hline(dev, log_bpp, &urb,
130 (char *) fb->obj->vmapping,
131 &cmd, byte_offset, dev_byte_offset,
133 &bytes_identical, &bytes_sent))
137 if (cmd > (char *) urb->transfer_buffer) {
138 /* Send partial buffer remaining before exiting */
140 if (cmd < (char *) urb->transfer_buffer + urb->transfer_buffer_length)
142 len = cmd - (char *) urb->transfer_buffer;
143 ret = udl_submit_urb(dev, urb, len);
146 udl_urb_completion(urb);
149 atomic_add(bytes_sent, &udl->bytes_sent);
150 atomic_add(bytes_identical, &udl->bytes_identical);
151 atomic_add((width * height) << log_bpp, &udl->bytes_rendered);
152 end_cycles = get_cycles();
153 atomic_add(((unsigned int) ((end_cycles - start_cycles)
154 >> 10)), /* Kcycles */
155 &udl->cpu_kcycles_used);
160 static int udl_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
162 unsigned long start = vma->vm_start;
163 unsigned long size = vma->vm_end - vma->vm_start;
164 unsigned long offset;
165 unsigned long page, pos;
167 if (vma->vm_pgoff > (~0UL >> PAGE_SHIFT))
170 offset = vma->vm_pgoff << PAGE_SHIFT;
172 if (offset > info->fix.smem_len || size > info->fix.smem_len - offset)
175 pos = (unsigned long)info->fix.smem_start + offset;
177 pr_debug("mmap() framebuffer addr:%lu size:%lu\n",
180 /* We don't want the framebuffer to be mapped encrypted */
181 vma->vm_page_prot = pgprot_decrypted(vma->vm_page_prot);
184 page = vmalloc_to_pfn((void *)pos);
185 if (remap_pfn_range(vma, start, page, PAGE_SIZE, PAGE_SHARED))
190 if (size > PAGE_SIZE)
196 /* VM_IO | VM_DONTEXPAND | VM_DONTDUMP are set by remap_pfn_range() */
201 * It's common for several clients to have framebuffer open simultaneously.
202 * e.g. both fbcon and X. Makes things interesting.
203 * Assumes caller is holding info->lock (for open and release at least)
205 static int udl_fb_open(struct fb_info *info, int user)
207 struct udl_fbdev *ufbdev = info->par;
208 struct drm_device *dev = ufbdev->ufb.base.dev;
209 struct udl_device *udl = to_udl(dev);
211 /* If the USB device is gone, we don't accept new opens */
212 if (drm_dev_is_unplugged(&udl->drm))
217 #ifdef CONFIG_DRM_FBDEV_EMULATION
218 if (fb_defio && (info->fbdefio == NULL)) {
219 /* enable defio at last moment if not disabled by client */
221 struct fb_deferred_io *fbdefio;
223 fbdefio = kzalloc(sizeof(struct fb_deferred_io), GFP_KERNEL);
226 fbdefio->delay = DL_DEFIO_WRITE_DELAY;
227 fbdefio->deferred_io = drm_fb_helper_deferred_io;
230 info->fbdefio = fbdefio;
231 fb_deferred_io_init(info);
235 pr_debug("open /dev/fb%d user=%d fb_info=%p count=%d\n",
236 info->node, user, info, ufbdev->fb_count);
243 * Assumes caller is holding info->lock mutex (for open and release at least)
245 static int udl_fb_release(struct fb_info *info, int user)
247 struct udl_fbdev *ufbdev = info->par;
251 #ifdef CONFIG_DRM_FBDEV_EMULATION
252 if ((ufbdev->fb_count == 0) && (info->fbdefio)) {
253 fb_deferred_io_cleanup(info);
254 kfree(info->fbdefio);
255 info->fbdefio = NULL;
256 info->fbops->fb_mmap = udl_fb_mmap;
260 pr_debug("released /dev/fb%d user=%d count=%d\n",
261 info->node, user, ufbdev->fb_count);
266 static struct fb_ops udlfb_ops = {
267 .owner = THIS_MODULE,
268 DRM_FB_HELPER_DEFAULT_OPS,
269 .fb_fillrect = drm_fb_helper_sys_fillrect,
270 .fb_copyarea = drm_fb_helper_sys_copyarea,
271 .fb_imageblit = drm_fb_helper_sys_imageblit,
272 .fb_mmap = udl_fb_mmap,
273 .fb_open = udl_fb_open,
274 .fb_release = udl_fb_release,
277 static int udl_user_framebuffer_dirty(struct drm_framebuffer *fb,
278 struct drm_file *file,
279 unsigned flags, unsigned color,
280 struct drm_clip_rect *clips,
283 struct udl_framebuffer *ufb = to_udl_fb(fb);
287 drm_modeset_lock_all(fb->dev);
292 if (ufb->obj->base.import_attach) {
293 ret = dma_buf_begin_cpu_access(ufb->obj->base.import_attach->dmabuf,
299 for (i = 0; i < num_clips; i++) {
300 ret = udl_handle_damage(ufb, clips[i].x1, clips[i].y1,
301 clips[i].x2 - clips[i].x1,
302 clips[i].y2 - clips[i].y1);
307 if (ufb->obj->base.import_attach) {
308 ret = dma_buf_end_cpu_access(ufb->obj->base.import_attach->dmabuf,
313 drm_modeset_unlock_all(fb->dev);
318 static void udl_user_framebuffer_destroy(struct drm_framebuffer *fb)
320 struct udl_framebuffer *ufb = to_udl_fb(fb);
323 drm_gem_object_put_unlocked(&ufb->obj->base);
325 drm_framebuffer_cleanup(fb);
329 static const struct drm_framebuffer_funcs udlfb_funcs = {
330 .destroy = udl_user_framebuffer_destroy,
331 .dirty = udl_user_framebuffer_dirty,
336 udl_framebuffer_init(struct drm_device *dev,
337 struct udl_framebuffer *ufb,
338 const struct drm_mode_fb_cmd2 *mode_cmd,
339 struct udl_gem_object *obj)
344 drm_helper_mode_fill_fb_struct(dev, &ufb->base, mode_cmd);
345 ret = drm_framebuffer_init(dev, &ufb->base, &udlfb_funcs);
350 static int udlfb_create(struct drm_fb_helper *helper,
351 struct drm_fb_helper_surface_size *sizes)
353 struct udl_fbdev *ufbdev =
354 container_of(helper, struct udl_fbdev, helper);
355 struct drm_device *dev = ufbdev->helper.dev;
356 struct fb_info *info;
357 struct drm_framebuffer *fb;
358 struct drm_mode_fb_cmd2 mode_cmd;
359 struct udl_gem_object *obj;
363 if (sizes->surface_bpp == 24)
364 sizes->surface_bpp = 32;
366 mode_cmd.width = sizes->surface_width;
367 mode_cmd.height = sizes->surface_height;
368 mode_cmd.pitches[0] = mode_cmd.width * ((sizes->surface_bpp + 7) / 8);
370 mode_cmd.pixel_format = drm_mode_legacy_fb_format(sizes->surface_bpp,
371 sizes->surface_depth);
373 size = mode_cmd.pitches[0] * mode_cmd.height;
374 size = ALIGN(size, PAGE_SIZE);
376 obj = udl_gem_alloc_object(dev, size);
380 ret = udl_gem_vmap(obj);
382 DRM_ERROR("failed to vmap fb\n");
386 info = drm_fb_helper_alloc_fbi(helper);
392 ret = udl_framebuffer_init(dev, &ufbdev->ufb, &mode_cmd, obj);
396 fb = &ufbdev->ufb.base;
398 ufbdev->helper.fb = fb;
400 info->screen_base = ufbdev->ufb.obj->vmapping;
401 info->fix.smem_len = size;
402 info->fix.smem_start = (unsigned long)ufbdev->ufb.obj->vmapping;
404 info->fbops = &udlfb_ops;
405 drm_fb_helper_fill_info(info, &ufbdev->helper, sizes);
407 DRM_DEBUG_KMS("allocated %dx%d vmal %p\n",
408 fb->width, fb->height,
409 ufbdev->ufb.obj->vmapping);
413 drm_gem_object_put_unlocked(&ufbdev->ufb.obj->base);
418 static const struct drm_fb_helper_funcs udl_fb_helper_funcs = {
419 .fb_probe = udlfb_create,
422 static void udl_fbdev_destroy(struct drm_device *dev,
423 struct udl_fbdev *ufbdev)
425 drm_fb_helper_unregister_fbi(&ufbdev->helper);
426 drm_fb_helper_fini(&ufbdev->helper);
427 if (ufbdev->ufb.obj) {
428 drm_framebuffer_unregister_private(&ufbdev->ufb.base);
429 drm_framebuffer_cleanup(&ufbdev->ufb.base);
430 drm_gem_object_put_unlocked(&ufbdev->ufb.obj->base);
434 int udl_fbdev_init(struct drm_device *dev)
436 struct udl_device *udl = to_udl(dev);
437 int bpp_sel = fb_bpp;
438 struct udl_fbdev *ufbdev;
441 ufbdev = kzalloc(sizeof(struct udl_fbdev), GFP_KERNEL);
447 drm_fb_helper_prepare(dev, &ufbdev->helper, &udl_fb_helper_funcs);
449 ret = drm_fb_helper_init(dev, &ufbdev->helper, 1);
453 ret = drm_fb_helper_single_add_all_connectors(&ufbdev->helper);
457 /* disable all the possible outputs/crtcs before entering KMS mode */
458 drm_helper_disable_unused_functions(dev);
460 ret = drm_fb_helper_initial_config(&ufbdev->helper, bpp_sel);
467 drm_fb_helper_fini(&ufbdev->helper);
473 void udl_fbdev_cleanup(struct drm_device *dev)
475 struct udl_device *udl = to_udl(dev);
479 udl_fbdev_destroy(dev, udl->fbdev);
484 void udl_fbdev_unplug(struct drm_device *dev)
486 struct udl_device *udl = to_udl(dev);
487 struct udl_fbdev *ufbdev;
492 drm_fb_helper_unlink_fbi(&ufbdev->helper);
495 struct drm_framebuffer *
496 udl_fb_user_fb_create(struct drm_device *dev,
497 struct drm_file *file,
498 const struct drm_mode_fb_cmd2 *mode_cmd)
500 struct drm_gem_object *obj;
501 struct udl_framebuffer *ufb;
505 obj = drm_gem_object_lookup(file, mode_cmd->handles[0]);
507 return ERR_PTR(-ENOENT);
509 size = mode_cmd->pitches[0] * mode_cmd->height;
510 size = ALIGN(size, PAGE_SIZE);
512 if (size > obj->size) {
513 DRM_ERROR("object size not sufficient for fb %d %zu %d %d\n", size, obj->size, mode_cmd->pitches[0], mode_cmd->height);
514 return ERR_PTR(-ENOMEM);
517 ufb = kzalloc(sizeof(*ufb), GFP_KERNEL);
519 return ERR_PTR(-ENOMEM);
521 ret = udl_framebuffer_init(dev, ufb, mode_cmd, to_udl_bo(obj));
524 return ERR_PTR(-EINVAL);