2 * Copyright (C) 2012 Red Hat
4 * based in parts on udlfb.c:
5 * Copyright (C) 2009 Roberto De Ioris <roberto@unbit.it>
6 * Copyright (C) 2009 Jaya Kumar <jayakumar.lkml@gmail.com>
7 * Copyright (C) 2009 Bernie Thompson <bernie@plugable.com>
9 * This file is subject to the terms and conditions of the GNU General Public
10 * License v2. See the file COPYING in the main directory of this archive for
13 #include <linux/module.h>
14 #include <linux/slab.h>
16 #include <linux/dma-buf.h>
19 #include <drm/drm_crtc.h>
20 #include <drm/drm_crtc_helper.h>
23 #include <drm/drm_fb_helper.h>
25 #define DL_DEFIO_WRITE_DELAY (HZ/20) /* fb_deferred_io.delay in jiffies */
27 static int fb_defio
= 0; /* Optionally enable experimental fb_defio mmap support */
28 static int fb_bpp
= 16;
30 module_param(fb_bpp
, int, S_IWUSR
| S_IRUSR
| S_IWGRP
| S_IRGRP
);
31 module_param(fb_defio
, int, S_IWUSR
| S_IRUSR
| S_IWGRP
| S_IRGRP
);
34 struct drm_fb_helper helper
;
35 struct udl_framebuffer ufb
;
39 #define DL_ALIGN_UP(x, a) ALIGN(x, a)
40 #define DL_ALIGN_DOWN(x, a) ALIGN(x-(a-1), a)
42 /** Read the red component (0..255) of a 32 bpp colour. */
43 #define DLO_RGB_GETRED(col) (uint8_t)((col) & 0xFF)
45 /** Read the green component (0..255) of a 32 bpp colour. */
46 #define DLO_RGB_GETGRN(col) (uint8_t)(((col) >> 8) & 0xFF)
48 /** Read the blue component (0..255) of a 32 bpp colour. */
49 #define DLO_RGB_GETBLU(col) (uint8_t)(((col) >> 16) & 0xFF)
51 /** Return red/green component of a 16 bpp colour number. */
52 #define DLO_RG16(red, grn) (uint8_t)((((red) & 0xF8) | ((grn) >> 5)) & 0xFF)
54 /** Return green/blue component of a 16 bpp colour number. */
55 #define DLO_GB16(grn, blu) (uint8_t)(((((grn) & 0x1C) << 3) | ((blu) >> 3)) & 0xFF)
57 /** Return 8 bpp colour number from red, green and blue components. */
58 #define DLO_RGB8(red, grn, blu) ((((red) << 5) | (((grn) & 3) << 3) | ((blu) & 7)) & 0xFF)
61 static uint8_t rgb8(uint32_t col
)
63 uint8_t red
= DLO_RGB_GETRED(col
);
64 uint8_t grn
= DLO_RGB_GETGRN(col
);
65 uint8_t blu
= DLO_RGB_GETBLU(col
);
67 return DLO_RGB8(red
, grn
, blu
);
70 static uint16_t rgb16(uint32_t col
)
72 uint8_t red
= DLO_RGB_GETRED(col
);
73 uint8_t grn
= DLO_RGB_GETGRN(col
);
74 uint8_t blu
= DLO_RGB_GETBLU(col
);
76 return (DLO_RG16(red
, grn
) << 8) + DLO_GB16(grn
, blu
);
81 * NOTE: fb_defio.c is holding info->fbdefio.mutex
82 * Touching ANY framebuffer memory that triggers a page fault
83 * in fb_defio will cause a deadlock, when it also tries to
84 * grab the same mutex.
86 static void udlfb_dpy_deferred_io(struct fb_info
*info
,
87 struct list_head
*pagelist
)
90 struct fb_deferred_io
*fbdefio
= info
->fbdefio
;
91 struct udl_fbdev
*ufbdev
= info
->par
;
92 struct drm_device
*dev
= ufbdev
->ufb
.base
.dev
;
93 struct udl_device
*udl
= dev
->dev_private
;
96 cycles_t start_cycles
, end_cycles
;
98 int bytes_identical
= 0;
99 int bytes_rendered
= 0;
104 start_cycles
= get_cycles();
106 urb
= udl_get_urb(dev
);
110 cmd
= urb
->transfer_buffer
;
112 /* walk the written page list and render each to device */
113 list_for_each_entry(cur
, &fbdefio
->pagelist
, lru
) {
115 if (udl_render_hline(dev
, (ufbdev
->ufb
.base
.bits_per_pixel
/ 8),
116 &urb
, (char *) info
->fix
.smem_start
,
117 &cmd
, cur
->index
<< PAGE_SHIFT
,
118 cur
->index
<< PAGE_SHIFT
,
119 PAGE_SIZE
, &bytes_identical
, &bytes_sent
))
121 bytes_rendered
+= PAGE_SIZE
;
124 if (cmd
> (char *) urb
->transfer_buffer
) {
125 /* Send partial buffer remaining before exiting */
126 int len
= cmd
- (char *) urb
->transfer_buffer
;
127 udl_submit_urb(dev
, urb
, len
);
130 udl_urb_completion(urb
);
133 atomic_add(bytes_sent
, &udl
->bytes_sent
);
134 atomic_add(bytes_identical
, &udl
->bytes_identical
);
135 atomic_add(bytes_rendered
, &udl
->bytes_rendered
);
136 end_cycles
= get_cycles();
137 atomic_add(((unsigned int) ((end_cycles
- start_cycles
)
138 >> 10)), /* Kcycles */
139 &udl
->cpu_kcycles_used
);
142 int udl_handle_damage(struct udl_framebuffer
*fb
, int x
, int y
,
143 int width
, int height
)
145 struct drm_device
*dev
= fb
->base
.dev
;
146 struct udl_device
*udl
= dev
->dev_private
;
149 cycles_t start_cycles
, end_cycles
;
151 int bytes_identical
= 0;
154 int bpp
= (fb
->base
.bits_per_pixel
/ 8);
156 bool store_for_later
= false;
162 if (!fb
->obj
->vmapping
) {
163 ret
= udl_gem_vmap(fb
->obj
);
164 if (ret
== -ENOMEM
) {
165 DRM_ERROR("failed to vmap fb\n");
168 if (!fb
->obj
->vmapping
) {
169 DRM_ERROR("failed to vmapping\n");
174 aligned_x
= DL_ALIGN_DOWN(x
, sizeof(unsigned long));
175 width
= DL_ALIGN_UP(width
+ (x
-aligned_x
), sizeof(unsigned long));
179 (x
+ width
> fb
->base
.width
) ||
180 (y
+ height
> fb
->base
.height
))
183 /* if we are in atomic just store the info
184 can't test inside spin lock */
186 store_for_later
= true;
191 spin_lock_irqsave(&fb
->dirty_lock
, flags
);
202 if (store_for_later
) {
207 spin_unlock_irqrestore(&fb
->dirty_lock
, flags
);
211 fb
->x1
= fb
->y1
= INT_MAX
;
214 spin_unlock_irqrestore(&fb
->dirty_lock
, flags
);
215 start_cycles
= get_cycles();
217 urb
= udl_get_urb(dev
);
220 cmd
= urb
->transfer_buffer
;
222 for (i
= y
; i
<= y2
; i
++) {
223 const int line_offset
= fb
->base
.pitches
[0] * i
;
224 const int byte_offset
= line_offset
+ (x
* bpp
);
225 const int dev_byte_offset
= (fb
->base
.width
* bpp
* i
) + (x
* bpp
);
226 if (udl_render_hline(dev
, bpp
, &urb
,
227 (char *) fb
->obj
->vmapping
,
228 &cmd
, byte_offset
, dev_byte_offset
,
230 &bytes_identical
, &bytes_sent
))
234 if (cmd
> (char *) urb
->transfer_buffer
) {
235 /* Send partial buffer remaining before exiting */
236 int len
= cmd
- (char *) urb
->transfer_buffer
;
237 ret
= udl_submit_urb(dev
, urb
, len
);
240 udl_urb_completion(urb
);
243 atomic_add(bytes_sent
, &udl
->bytes_sent
);
244 atomic_add(bytes_identical
, &udl
->bytes_identical
);
245 atomic_add(width
*height
*bpp
, &udl
->bytes_rendered
);
246 end_cycles
= get_cycles();
247 atomic_add(((unsigned int) ((end_cycles
- start_cycles
)
248 >> 10)), /* Kcycles */
249 &udl
->cpu_kcycles_used
);
254 static int udl_fb_mmap(struct fb_info
*info
, struct vm_area_struct
*vma
)
256 unsigned long start
= vma
->vm_start
;
257 unsigned long size
= vma
->vm_end
- vma
->vm_start
;
258 unsigned long offset
= vma
->vm_pgoff
<< PAGE_SHIFT
;
259 unsigned long page
, pos
;
261 if (offset
+ size
> info
->fix
.smem_len
)
264 pos
= (unsigned long)info
->fix
.smem_start
+ offset
;
266 pr_notice("mmap() framebuffer addr:%lu size:%lu\n",
270 page
= vmalloc_to_pfn((void *)pos
);
271 if (remap_pfn_range(vma
, start
, page
, PAGE_SIZE
, PAGE_SHARED
))
276 if (size
> PAGE_SIZE
)
282 /* VM_IO | VM_DONTEXPAND | VM_DONTDUMP are set by remap_pfn_range() */
286 static void udl_fb_fillrect(struct fb_info
*info
, const struct fb_fillrect
*rect
)
288 struct udl_fbdev
*ufbdev
= info
->par
;
290 drm_fb_helper_sys_fillrect(info
, rect
);
292 udl_handle_damage(&ufbdev
->ufb
, rect
->dx
, rect
->dy
, rect
->width
,
296 static void udl_fb_copyarea(struct fb_info
*info
, const struct fb_copyarea
*region
)
298 struct udl_fbdev
*ufbdev
= info
->par
;
300 drm_fb_helper_sys_copyarea(info
, region
);
302 udl_handle_damage(&ufbdev
->ufb
, region
->dx
, region
->dy
, region
->width
,
306 static void udl_fb_imageblit(struct fb_info
*info
, const struct fb_image
*image
)
308 struct udl_fbdev
*ufbdev
= info
->par
;
310 drm_fb_helper_sys_imageblit(info
, image
);
312 udl_handle_damage(&ufbdev
->ufb
, image
->dx
, image
->dy
, image
->width
,
317 * It's common for several clients to have framebuffer open simultaneously.
318 * e.g. both fbcon and X. Makes things interesting.
319 * Assumes caller is holding info->lock (for open and release at least)
321 static int udl_fb_open(struct fb_info
*info
, int user
)
323 struct udl_fbdev
*ufbdev
= info
->par
;
324 struct drm_device
*dev
= ufbdev
->ufb
.base
.dev
;
325 struct udl_device
*udl
= dev
->dev_private
;
327 /* If the USB device is gone, we don't accept new opens */
328 if (drm_device_is_unplugged(udl
->ddev
))
333 if (fb_defio
&& (info
->fbdefio
== NULL
)) {
334 /* enable defio at last moment if not disabled by client */
336 struct fb_deferred_io
*fbdefio
;
338 fbdefio
= kmalloc(sizeof(struct fb_deferred_io
), GFP_KERNEL
);
341 fbdefio
->delay
= DL_DEFIO_WRITE_DELAY
;
342 fbdefio
->deferred_io
= udlfb_dpy_deferred_io
;
345 info
->fbdefio
= fbdefio
;
346 fb_deferred_io_init(info
);
349 pr_notice("open /dev/fb%d user=%d fb_info=%p count=%d\n",
350 info
->node
, user
, info
, ufbdev
->fb_count
);
357 * Assumes caller is holding info->lock mutex (for open and release at least)
359 static int udl_fb_release(struct fb_info
*info
, int user
)
361 struct udl_fbdev
*ufbdev
= info
->par
;
365 if ((ufbdev
->fb_count
== 0) && (info
->fbdefio
)) {
366 fb_deferred_io_cleanup(info
);
367 kfree(info
->fbdefio
);
368 info
->fbdefio
= NULL
;
369 info
->fbops
->fb_mmap
= udl_fb_mmap
;
372 pr_warn("released /dev/fb%d user=%d count=%d\n",
373 info
->node
, user
, ufbdev
->fb_count
);
378 static struct fb_ops udlfb_ops
= {
379 .owner
= THIS_MODULE
,
380 .fb_check_var
= drm_fb_helper_check_var
,
381 .fb_set_par
= drm_fb_helper_set_par
,
382 .fb_fillrect
= udl_fb_fillrect
,
383 .fb_copyarea
= udl_fb_copyarea
,
384 .fb_imageblit
= udl_fb_imageblit
,
385 .fb_pan_display
= drm_fb_helper_pan_display
,
386 .fb_blank
= drm_fb_helper_blank
,
387 .fb_setcmap
= drm_fb_helper_setcmap
,
388 .fb_debug_enter
= drm_fb_helper_debug_enter
,
389 .fb_debug_leave
= drm_fb_helper_debug_leave
,
390 .fb_mmap
= udl_fb_mmap
,
391 .fb_open
= udl_fb_open
,
392 .fb_release
= udl_fb_release
,
395 static int udl_user_framebuffer_dirty(struct drm_framebuffer
*fb
,
396 struct drm_file
*file
,
397 unsigned flags
, unsigned color
,
398 struct drm_clip_rect
*clips
,
401 struct udl_framebuffer
*ufb
= to_udl_fb(fb
);
405 drm_modeset_lock_all(fb
->dev
);
410 if (ufb
->obj
->base
.import_attach
) {
411 ret
= dma_buf_begin_cpu_access(ufb
->obj
->base
.import_attach
->dmabuf
,
417 for (i
= 0; i
< num_clips
; i
++) {
418 ret
= udl_handle_damage(ufb
, clips
[i
].x1
, clips
[i
].y1
,
419 clips
[i
].x2
- clips
[i
].x1
,
420 clips
[i
].y2
- clips
[i
].y1
);
425 if (ufb
->obj
->base
.import_attach
) {
426 ret
= dma_buf_end_cpu_access(ufb
->obj
->base
.import_attach
->dmabuf
,
431 drm_modeset_unlock_all(fb
->dev
);
436 static void udl_user_framebuffer_destroy(struct drm_framebuffer
*fb
)
438 struct udl_framebuffer
*ufb
= to_udl_fb(fb
);
441 drm_gem_object_unreference_unlocked(&ufb
->obj
->base
);
443 drm_framebuffer_cleanup(fb
);
447 static const struct drm_framebuffer_funcs udlfb_funcs
= {
448 .destroy
= udl_user_framebuffer_destroy
,
449 .dirty
= udl_user_framebuffer_dirty
,
454 udl_framebuffer_init(struct drm_device
*dev
,
455 struct udl_framebuffer
*ufb
,
456 const struct drm_mode_fb_cmd2
*mode_cmd
,
457 struct udl_gem_object
*obj
)
461 spin_lock_init(&ufb
->dirty_lock
);
463 drm_helper_mode_fill_fb_struct(&ufb
->base
, mode_cmd
);
464 ret
= drm_framebuffer_init(dev
, &ufb
->base
, &udlfb_funcs
);
469 static int udlfb_create(struct drm_fb_helper
*helper
,
470 struct drm_fb_helper_surface_size
*sizes
)
472 struct udl_fbdev
*ufbdev
=
473 container_of(helper
, struct udl_fbdev
, helper
);
474 struct drm_device
*dev
= ufbdev
->helper
.dev
;
475 struct fb_info
*info
;
476 struct drm_framebuffer
*fb
;
477 struct drm_mode_fb_cmd2 mode_cmd
;
478 struct udl_gem_object
*obj
;
482 if (sizes
->surface_bpp
== 24)
483 sizes
->surface_bpp
= 32;
485 mode_cmd
.width
= sizes
->surface_width
;
486 mode_cmd
.height
= sizes
->surface_height
;
487 mode_cmd
.pitches
[0] = mode_cmd
.width
* ((sizes
->surface_bpp
+ 7) / 8);
489 mode_cmd
.pixel_format
= drm_mode_legacy_fb_format(sizes
->surface_bpp
,
490 sizes
->surface_depth
);
492 size
= mode_cmd
.pitches
[0] * mode_cmd
.height
;
493 size
= ALIGN(size
, PAGE_SIZE
);
495 obj
= udl_gem_alloc_object(dev
, size
);
499 ret
= udl_gem_vmap(obj
);
501 DRM_ERROR("failed to vmap fb\n");
505 info
= drm_fb_helper_alloc_fbi(helper
);
512 ret
= udl_framebuffer_init(dev
, &ufbdev
->ufb
, &mode_cmd
, obj
);
514 goto out_destroy_fbi
;
516 fb
= &ufbdev
->ufb
.base
;
518 ufbdev
->helper
.fb
= fb
;
520 strcpy(info
->fix
.id
, "udldrmfb");
522 info
->screen_base
= ufbdev
->ufb
.obj
->vmapping
;
523 info
->fix
.smem_len
= size
;
524 info
->fix
.smem_start
= (unsigned long)ufbdev
->ufb
.obj
->vmapping
;
526 info
->flags
= FBINFO_DEFAULT
| FBINFO_CAN_FORCE_OUTPUT
;
527 info
->fbops
= &udlfb_ops
;
528 drm_fb_helper_fill_fix(info
, fb
->pitches
[0], fb
->depth
);
529 drm_fb_helper_fill_var(info
, &ufbdev
->helper
, sizes
->fb_width
, sizes
->fb_height
);
531 DRM_DEBUG_KMS("allocated %dx%d vmal %p\n",
532 fb
->width
, fb
->height
,
533 ufbdev
->ufb
.obj
->vmapping
);
537 drm_fb_helper_release_fbi(helper
);
539 drm_gem_object_unreference_unlocked(&ufbdev
->ufb
.obj
->base
);
544 static const struct drm_fb_helper_funcs udl_fb_helper_funcs
= {
545 .fb_probe
= udlfb_create
,
548 static void udl_fbdev_destroy(struct drm_device
*dev
,
549 struct udl_fbdev
*ufbdev
)
551 drm_fb_helper_unregister_fbi(&ufbdev
->helper
);
552 drm_fb_helper_release_fbi(&ufbdev
->helper
);
553 drm_fb_helper_fini(&ufbdev
->helper
);
554 drm_framebuffer_unregister_private(&ufbdev
->ufb
.base
);
555 drm_framebuffer_cleanup(&ufbdev
->ufb
.base
);
556 drm_gem_object_unreference_unlocked(&ufbdev
->ufb
.obj
->base
);
559 int udl_fbdev_init(struct drm_device
*dev
)
561 struct udl_device
*udl
= dev
->dev_private
;
562 int bpp_sel
= fb_bpp
;
563 struct udl_fbdev
*ufbdev
;
566 ufbdev
= kzalloc(sizeof(struct udl_fbdev
), GFP_KERNEL
);
572 drm_fb_helper_prepare(dev
, &ufbdev
->helper
, &udl_fb_helper_funcs
);
574 ret
= drm_fb_helper_init(dev
, &ufbdev
->helper
,
579 ret
= drm_fb_helper_single_add_all_connectors(&ufbdev
->helper
);
583 /* disable all the possible outputs/crtcs before entering KMS mode */
584 drm_helper_disable_unused_functions(dev
);
586 ret
= drm_fb_helper_initial_config(&ufbdev
->helper
, bpp_sel
);
593 drm_fb_helper_fini(&ufbdev
->helper
);
599 void udl_fbdev_cleanup(struct drm_device
*dev
)
601 struct udl_device
*udl
= dev
->dev_private
;
605 udl_fbdev_destroy(dev
, udl
->fbdev
);
610 void udl_fbdev_unplug(struct drm_device
*dev
)
612 struct udl_device
*udl
= dev
->dev_private
;
613 struct udl_fbdev
*ufbdev
;
618 drm_fb_helper_unlink_fbi(&ufbdev
->helper
);
621 struct drm_framebuffer
*
622 udl_fb_user_fb_create(struct drm_device
*dev
,
623 struct drm_file
*file
,
624 const struct drm_mode_fb_cmd2
*mode_cmd
)
626 struct drm_gem_object
*obj
;
627 struct udl_framebuffer
*ufb
;
631 obj
= drm_gem_object_lookup(dev
, file
, mode_cmd
->handles
[0]);
633 return ERR_PTR(-ENOENT
);
635 size
= mode_cmd
->pitches
[0] * mode_cmd
->height
;
636 size
= ALIGN(size
, PAGE_SIZE
);
638 if (size
> obj
->size
) {
639 DRM_ERROR("object size not sufficient for fb %d %zu %d %d\n", size
, obj
->size
, mode_cmd
->pitches
[0], mode_cmd
->height
);
640 return ERR_PTR(-ENOMEM
);
643 ufb
= kzalloc(sizeof(*ufb
), GFP_KERNEL
);
645 return ERR_PTR(-ENOMEM
);
647 ret
= udl_framebuffer_init(dev
, ufb
, mode_cmd
, to_udl_bo(obj
));
650 return ERR_PTR(-EINVAL
);