2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
6 * DRM framebuffer helper functions
8 * Permission to use, copy, modify, distribute, and sell this software and its
9 * documentation for any purpose is hereby granted without fee, provided that
10 * the above copyright notice appear in all copies and that both that copyright
11 * notice and this permission notice appear in supporting documentation, and
12 * that the name of the copyright holders not be used in advertising or
13 * publicity pertaining to distribution of the software without specific,
14 * written prior permission. The copyright holders make no representations
15 * about the suitability of this software for any purpose. It is provided "as
16 * is" without express or implied warranty.
18 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
27 * Dave Airlie <airlied@linux.ie>
28 * Jesse Barnes <jesse.barnes@intel.com>
30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32 #include <linux/console.h>
33 #include <linux/dma-buf.h>
34 #include <linux/kernel.h>
35 #include <linux/sysrq.h>
36 #include <linux/slab.h>
37 #include <linux/module.h>
39 #include <drm/drm_crtc.h>
40 #include <drm/drm_fb_helper.h>
41 #include <drm/drm_crtc_helper.h>
42 #include <drm/drm_atomic.h>
43 #include <drm/drm_atomic_helper.h>
45 #include "drm_crtc_internal.h"
46 #include "drm_crtc_helper_internal.h"
48 static bool drm_fbdev_emulation = true;
49 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
50 MODULE_PARM_DESC(fbdev_emulation,
51 "Enable legacy fbdev emulation [default=true]");
53 static int drm_fbdev_overalloc = CONFIG_DRM_FBDEV_OVERALLOC;
54 module_param(drm_fbdev_overalloc, int, 0444);
55 MODULE_PARM_DESC(drm_fbdev_overalloc,
56 "Overallocation of the fbdev buffer (%) [default="
57 __MODULE_STRING(CONFIG_DRM_FBDEV_OVERALLOC) "]");
60 * In order to keep user-space compatibility, we want in certain use-cases
61 * to keep leaking the fbdev physical address to the user-space program
62 * handling the fbdev buffer.
63 * This is a bad habit essentially kept into closed source opengl driver
64 * that should really be moved into open-source upstream projects instead
65 * of using legacy physical addresses in user space to communicate with
66 * other out-of-tree kernel modules.
68 * This module_param *should* be removed as soon as possible and be
69 * considered as a broken and legacy behaviour from a modern fbdev device.
71 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
72 static bool drm_leak_fbdev_smem = false;
73 module_param_unsafe(drm_leak_fbdev_smem, bool, 0600);
74 MODULE_PARM_DESC(drm_leak_fbdev_smem,
75 "Allow unsafe leaking fbdev physical smem address [default=false]");
78 static LIST_HEAD(kernel_fb_helper_list);
79 static DEFINE_MUTEX(kernel_fb_helper_lock);
84 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
85 * mode setting driver. They can be used mostly independently from the crtc
86 * helper functions used by many drivers to implement the kernel mode setting
89 * Drivers that support a dumb buffer with a virtual address and mmap support,
90 * should try out the generic fbdev emulation using drm_fbdev_generic_setup().
92 * Setup fbdev emulation by calling drm_fb_helper_fbdev_setup() and tear it
93 * down by calling drm_fb_helper_fbdev_teardown().
95 * Drivers that need to handle connector hotplugging (e.g. dp mst) can't use
96 * the setup helper and will need to do the whole four-step setup process with
97 * drm_fb_helper_prepare(), drm_fb_helper_init(),
98 * drm_fb_helper_single_add_all_connectors(), enable hotplugging and
99 * drm_fb_helper_initial_config() to avoid a possible race window.
101 * At runtime drivers should restore the fbdev console by using
102 * drm_fb_helper_lastclose() as their &drm_driver.lastclose callback.
103 * They should also notify the fb helper code from updates to the output
104 * configuration by using drm_fb_helper_output_poll_changed() as their
105 * &drm_mode_config_funcs.output_poll_changed callback.
107 * For suspend/resume consider using drm_mode_config_helper_suspend() and
108 * drm_mode_config_helper_resume() which takes care of fbdev as well.
110 * All other functions exported by the fb helper library can be used to
111 * implement the fbdev driver interface by the driver.
113 * It is possible, though perhaps somewhat tricky, to implement race-free
114 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
115 * helper must be called first to initialize the minimum required to make
116 * hotplug detection work. Drivers also need to make sure to properly set up
117 * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init()
118 * it is safe to enable interrupts and start processing hotplug events. At the
119 * same time, drivers should initialize all modeset objects such as CRTCs,
120 * encoders and connectors. To finish up the fbdev helper initialization, the
121 * drm_fb_helper_init() function is called. To probe for all attached displays
122 * and set up an initial configuration using the detected hardware, drivers
123 * should call drm_fb_helper_single_add_all_connectors() followed by
124 * drm_fb_helper_initial_config().
126 * If &drm_framebuffer_funcs.dirty is set, the
127 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
128 * accumulate changes and schedule &drm_fb_helper.dirty_work to run right
129 * away. This worker then calls the dirty() function ensuring that it will
130 * always run in process context since the fb_*() function could be running in
131 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
132 * callback it will also schedule dirty_work with the damage collected from the
133 * mmap page writes. Drivers can use drm_fb_helper_defio_init() to setup
134 * deferred I/O (coupled with drm_fb_helper_fbdev_teardown()).
137 #define drm_fb_helper_for_each_connector(fbh, i__) \
138 for (({ lockdep_assert_held(&(fbh)->lock); }), \
139 i__ = 0; i__ < (fbh)->connector_count; i__++)
141 static int __drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
142 struct drm_connector *connector)
144 struct drm_fb_helper_connector *fb_conn;
145 struct drm_fb_helper_connector **temp;
148 if (!drm_fbdev_emulation)
151 lockdep_assert_held(&fb_helper->lock);
153 count = fb_helper->connector_count + 1;
155 if (count > fb_helper->connector_info_alloc_count) {
156 size_t size = count * sizeof(fb_conn);
158 temp = krealloc(fb_helper->connector_info, size, GFP_KERNEL);
162 fb_helper->connector_info_alloc_count = count;
163 fb_helper->connector_info = temp;
166 fb_conn = kzalloc(sizeof(*fb_conn), GFP_KERNEL);
170 drm_connector_get(connector);
171 fb_conn->connector = connector;
172 fb_helper->connector_info[fb_helper->connector_count++] = fb_conn;
177 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
178 struct drm_connector *connector)
185 mutex_lock(&fb_helper->lock);
186 err = __drm_fb_helper_add_one_connector(fb_helper, connector);
187 mutex_unlock(&fb_helper->lock);
191 EXPORT_SYMBOL(drm_fb_helper_add_one_connector);
194 * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
196 * @fb_helper: fbdev initialized with drm_fb_helper_init, can be NULL
198 * This functions adds all the available connectors for use with the given
199 * fb_helper. This is a separate step to allow drivers to freely assign
200 * connectors to the fbdev, e.g. if some are reserved for special purposes or
201 * not adequate to be used for the fbcon.
203 * This function is protected against concurrent connector hotadds/removals
204 * using drm_fb_helper_add_one_connector() and
205 * drm_fb_helper_remove_one_connector().
207 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
209 struct drm_device *dev;
210 struct drm_connector *connector;
211 struct drm_connector_list_iter conn_iter;
214 if (!drm_fbdev_emulation || !fb_helper)
217 dev = fb_helper->dev;
219 mutex_lock(&fb_helper->lock);
220 drm_connector_list_iter_begin(dev, &conn_iter);
221 drm_for_each_connector_iter(connector, &conn_iter) {
222 if (connector->connector_type == DRM_MODE_CONNECTOR_WRITEBACK)
225 ret = __drm_fb_helper_add_one_connector(fb_helper, connector);
232 drm_fb_helper_for_each_connector(fb_helper, i) {
233 struct drm_fb_helper_connector *fb_helper_connector =
234 fb_helper->connector_info[i];
236 drm_connector_put(fb_helper_connector->connector);
238 kfree(fb_helper_connector);
239 fb_helper->connector_info[i] = NULL;
241 fb_helper->connector_count = 0;
243 drm_connector_list_iter_end(&conn_iter);
244 mutex_unlock(&fb_helper->lock);
248 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
250 static int __drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
251 struct drm_connector *connector)
253 struct drm_fb_helper_connector *fb_helper_connector;
256 if (!drm_fbdev_emulation)
259 lockdep_assert_held(&fb_helper->lock);
261 drm_fb_helper_for_each_connector(fb_helper, i) {
262 if (fb_helper->connector_info[i]->connector == connector)
266 if (i == fb_helper->connector_count)
268 fb_helper_connector = fb_helper->connector_info[i];
269 drm_connector_put(fb_helper_connector->connector);
271 for (j = i + 1; j < fb_helper->connector_count; j++)
272 fb_helper->connector_info[j - 1] = fb_helper->connector_info[j];
274 fb_helper->connector_count--;
275 kfree(fb_helper_connector);
280 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
281 struct drm_connector *connector)
288 mutex_lock(&fb_helper->lock);
289 err = __drm_fb_helper_remove_one_connector(fb_helper, connector);
290 mutex_unlock(&fb_helper->lock);
294 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector);
296 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
298 uint16_t *r_base, *g_base, *b_base;
300 if (crtc->funcs->gamma_set == NULL)
303 r_base = crtc->gamma_store;
304 g_base = r_base + crtc->gamma_size;
305 b_base = g_base + crtc->gamma_size;
307 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base,
308 crtc->gamma_size, NULL);
312 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
313 * @info: fbdev registered by the helper
315 int drm_fb_helper_debug_enter(struct fb_info *info)
317 struct drm_fb_helper *helper = info->par;
318 const struct drm_crtc_helper_funcs *funcs;
321 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
322 for (i = 0; i < helper->crtc_count; i++) {
323 struct drm_mode_set *mode_set =
324 &helper->crtc_info[i].mode_set;
326 if (!mode_set->crtc->enabled)
329 funcs = mode_set->crtc->helper_private;
330 if (funcs->mode_set_base_atomic == NULL)
333 if (drm_drv_uses_atomic_modeset(mode_set->crtc->dev))
336 funcs->mode_set_base_atomic(mode_set->crtc,
340 ENTER_ATOMIC_MODE_SET);
346 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
349 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
350 * @info: fbdev registered by the helper
352 int drm_fb_helper_debug_leave(struct fb_info *info)
354 struct drm_fb_helper *helper = info->par;
355 struct drm_crtc *crtc;
356 const struct drm_crtc_helper_funcs *funcs;
357 struct drm_framebuffer *fb;
360 for (i = 0; i < helper->crtc_count; i++) {
361 struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
363 crtc = mode_set->crtc;
364 if (drm_drv_uses_atomic_modeset(crtc->dev))
367 funcs = crtc->helper_private;
368 fb = crtc->primary->fb;
374 DRM_ERROR("no fb to restore??\n");
378 if (funcs->mode_set_base_atomic == NULL)
381 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
382 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
383 crtc->y, LEAVE_ATOMIC_MODE_SET);
388 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
390 static int restore_fbdev_mode_atomic(struct drm_fb_helper *fb_helper, bool active)
392 struct drm_device *dev = fb_helper->dev;
393 struct drm_plane_state *plane_state;
394 struct drm_plane *plane;
395 struct drm_atomic_state *state;
397 struct drm_modeset_acquire_ctx ctx;
399 drm_modeset_acquire_init(&ctx, 0);
401 state = drm_atomic_state_alloc(dev);
407 state->acquire_ctx = &ctx;
409 drm_for_each_plane(plane, dev) {
410 plane_state = drm_atomic_get_plane_state(state, plane);
411 if (IS_ERR(plane_state)) {
412 ret = PTR_ERR(plane_state);
416 plane_state->rotation = DRM_MODE_ROTATE_0;
418 /* disable non-primary: */
419 if (plane->type == DRM_PLANE_TYPE_PRIMARY)
422 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
427 for (i = 0; i < fb_helper->crtc_count; i++) {
428 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
429 struct drm_plane *primary = mode_set->crtc->primary;
431 /* Cannot fail as we've already gotten the plane state above */
432 plane_state = drm_atomic_get_new_plane_state(state, primary);
433 plane_state->rotation = fb_helper->crtc_info[i].rotation;
435 ret = __drm_atomic_helper_set_config(mode_set, state);
440 * __drm_atomic_helper_set_config() sets active when a
441 * mode is set, unconditionally clear it if we force DPMS off
444 struct drm_crtc *crtc = mode_set->crtc;
445 struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
447 crtc_state->active = false;
451 ret = drm_atomic_commit(state);
457 drm_atomic_state_put(state);
459 drm_modeset_drop_locks(&ctx);
460 drm_modeset_acquire_fini(&ctx);
465 drm_atomic_state_clear(state);
466 drm_modeset_backoff(&ctx);
471 static int restore_fbdev_mode_legacy(struct drm_fb_helper *fb_helper)
473 struct drm_device *dev = fb_helper->dev;
474 struct drm_plane *plane;
477 drm_modeset_lock_all(fb_helper->dev);
478 drm_for_each_plane(plane, dev) {
479 if (plane->type != DRM_PLANE_TYPE_PRIMARY)
480 drm_plane_force_disable(plane);
482 if (plane->rotation_property)
483 drm_mode_plane_set_obj_prop(plane,
484 plane->rotation_property,
488 for (i = 0; i < fb_helper->crtc_count; i++) {
489 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
490 struct drm_crtc *crtc = mode_set->crtc;
492 if (crtc->funcs->cursor_set2) {
493 ret = crtc->funcs->cursor_set2(crtc, NULL, 0, 0, 0, 0, 0);
496 } else if (crtc->funcs->cursor_set) {
497 ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
502 ret = drm_mode_set_config_internal(mode_set);
507 drm_modeset_unlock_all(fb_helper->dev);
512 static int restore_fbdev_mode(struct drm_fb_helper *fb_helper)
514 struct drm_device *dev = fb_helper->dev;
516 if (drm_drv_uses_atomic_modeset(dev))
517 return restore_fbdev_mode_atomic(fb_helper, true);
519 return restore_fbdev_mode_legacy(fb_helper);
523 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
524 * @fb_helper: driver-allocated fbdev helper, can be NULL
526 * This should be called from driver's drm &drm_driver.lastclose callback
527 * when implementing an fbcon on top of kms using this helper. This ensures that
528 * the user isn't greeted with a black screen when e.g. X dies.
531 * Zero if everything went ok, negative error code otherwise.
533 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
538 if (!drm_fbdev_emulation || !fb_helper)
541 if (READ_ONCE(fb_helper->deferred_setup))
544 mutex_lock(&fb_helper->lock);
545 ret = restore_fbdev_mode(fb_helper);
547 do_delayed = fb_helper->delayed_hotplug;
549 fb_helper->delayed_hotplug = false;
550 mutex_unlock(&fb_helper->lock);
553 drm_fb_helper_hotplug_event(fb_helper);
557 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
559 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
561 struct drm_device *dev = fb_helper->dev;
562 struct drm_crtc *crtc;
563 int bound = 0, crtcs_bound = 0;
566 * Sometimes user space wants everything disabled, so don't steal the
567 * display if there's a master.
569 if (READ_ONCE(dev->master))
572 drm_for_each_crtc(crtc, dev) {
573 drm_modeset_lock(&crtc->mutex, NULL);
574 if (crtc->primary->fb)
576 if (crtc->primary->fb == fb_helper->fb)
578 drm_modeset_unlock(&crtc->mutex);
581 if (bound < crtcs_bound)
587 #ifdef CONFIG_MAGIC_SYSRQ
589 * restore fbcon display for all kms driver's using this helper, used for sysrq
590 * and panic handling.
592 static bool drm_fb_helper_force_kernel_mode(void)
594 bool ret, error = false;
595 struct drm_fb_helper *helper;
597 if (list_empty(&kernel_fb_helper_list))
600 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
601 struct drm_device *dev = helper->dev;
603 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
606 mutex_lock(&helper->lock);
607 ret = restore_fbdev_mode(helper);
610 mutex_unlock(&helper->lock);
615 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
619 ret = drm_fb_helper_force_kernel_mode();
621 DRM_ERROR("Failed to restore crtc configuration\n");
623 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
625 static void drm_fb_helper_sysrq(int dummy1)
627 schedule_work(&drm_fb_helper_restore_work);
630 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
631 .handler = drm_fb_helper_sysrq,
632 .help_msg = "force-fb(V)",
633 .action_msg = "Restore framebuffer console",
636 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
639 static void dpms_legacy(struct drm_fb_helper *fb_helper, int dpms_mode)
641 struct drm_device *dev = fb_helper->dev;
642 struct drm_crtc *crtc;
643 struct drm_connector *connector;
646 drm_modeset_lock_all(dev);
647 for (i = 0; i < fb_helper->crtc_count; i++) {
648 crtc = fb_helper->crtc_info[i].mode_set.crtc;
653 /* Walk the connectors & encoders on this fb turning them on/off */
654 drm_fb_helper_for_each_connector(fb_helper, j) {
655 connector = fb_helper->connector_info[j]->connector;
656 connector->funcs->dpms(connector, dpms_mode);
657 drm_object_property_set_value(&connector->base,
658 dev->mode_config.dpms_property, dpms_mode);
661 drm_modeset_unlock_all(dev);
664 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
666 struct drm_fb_helper *fb_helper = info->par;
669 * For each CRTC in this fb, turn the connectors on/off.
671 mutex_lock(&fb_helper->lock);
672 if (!drm_fb_helper_is_bound(fb_helper)) {
673 mutex_unlock(&fb_helper->lock);
677 if (drm_drv_uses_atomic_modeset(fb_helper->dev))
678 restore_fbdev_mode_atomic(fb_helper, dpms_mode == DRM_MODE_DPMS_ON);
680 dpms_legacy(fb_helper, dpms_mode);
681 mutex_unlock(&fb_helper->lock);
685 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
686 * @blank: desired blanking state
687 * @info: fbdev registered by the helper
689 int drm_fb_helper_blank(int blank, struct fb_info *info)
691 if (oops_in_progress)
695 /* Display: On; HSync: On, VSync: On */
696 case FB_BLANK_UNBLANK:
697 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
699 /* Display: Off; HSync: On, VSync: On */
700 case FB_BLANK_NORMAL:
701 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
703 /* Display: Off; HSync: Off, VSync: On */
704 case FB_BLANK_HSYNC_SUSPEND:
705 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
707 /* Display: Off; HSync: On, VSync: Off */
708 case FB_BLANK_VSYNC_SUSPEND:
709 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
711 /* Display: Off; HSync: Off, VSync: Off */
712 case FB_BLANK_POWERDOWN:
713 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
718 EXPORT_SYMBOL(drm_fb_helper_blank);
720 static void drm_fb_helper_modeset_release(struct drm_fb_helper *helper,
721 struct drm_mode_set *modeset)
725 for (i = 0; i < modeset->num_connectors; i++) {
726 drm_connector_put(modeset->connectors[i]);
727 modeset->connectors[i] = NULL;
729 modeset->num_connectors = 0;
731 drm_mode_destroy(helper->dev, modeset->mode);
732 modeset->mode = NULL;
734 /* FIXME should hold a ref? */
738 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
742 for (i = 0; i < helper->connector_count; i++) {
743 drm_connector_put(helper->connector_info[i]->connector);
744 kfree(helper->connector_info[i]);
746 kfree(helper->connector_info);
748 for (i = 0; i < helper->crtc_count; i++) {
749 struct drm_mode_set *modeset = &helper->crtc_info[i].mode_set;
751 drm_fb_helper_modeset_release(helper, modeset);
752 kfree(modeset->connectors);
754 kfree(helper->crtc_info);
757 static void drm_fb_helper_resume_worker(struct work_struct *work)
759 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
763 fb_set_suspend(helper->fbdev, 0);
767 static void drm_fb_helper_dirty_blit_real(struct drm_fb_helper *fb_helper,
768 struct drm_clip_rect *clip)
770 struct drm_framebuffer *fb = fb_helper->fb;
771 unsigned int cpp = drm_format_plane_cpp(fb->format->format, 0);
772 size_t offset = clip->y1 * fb->pitches[0] + clip->x1 * cpp;
773 void *src = fb_helper->fbdev->screen_buffer + offset;
774 void *dst = fb_helper->buffer->vaddr + offset;
775 size_t len = (clip->x2 - clip->x1) * cpp;
778 for (y = clip->y1; y < clip->y2; y++) {
779 memcpy(dst, src, len);
780 src += fb->pitches[0];
781 dst += fb->pitches[0];
785 static void drm_fb_helper_dirty_work(struct work_struct *work)
787 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
789 struct drm_clip_rect *clip = &helper->dirty_clip;
790 struct drm_clip_rect clip_copy;
793 spin_lock_irqsave(&helper->dirty_lock, flags);
795 clip->x1 = clip->y1 = ~0;
796 clip->x2 = clip->y2 = 0;
797 spin_unlock_irqrestore(&helper->dirty_lock, flags);
799 /* call dirty callback only when it has been really touched */
800 if (clip_copy.x1 < clip_copy.x2 && clip_copy.y1 < clip_copy.y2) {
801 /* Generic fbdev uses a shadow buffer */
803 drm_fb_helper_dirty_blit_real(helper, &clip_copy);
804 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
809 * drm_fb_helper_prepare - setup a drm_fb_helper structure
811 * @helper: driver-allocated fbdev helper structure to set up
812 * @funcs: pointer to structure of functions associate with this helper
814 * Sets up the bare minimum to make the framebuffer helper usable. This is
815 * useful to implement race-free initialization of the polling helpers.
817 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
818 const struct drm_fb_helper_funcs *funcs)
820 INIT_LIST_HEAD(&helper->kernel_fb_list);
821 spin_lock_init(&helper->dirty_lock);
822 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
823 INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
824 helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
825 mutex_init(&helper->lock);
826 helper->funcs = funcs;
829 EXPORT_SYMBOL(drm_fb_helper_prepare);
832 * drm_fb_helper_init - initialize a &struct drm_fb_helper
834 * @fb_helper: driver-allocated fbdev helper structure to initialize
835 * @max_conn_count: max connector count
837 * This allocates the structures for the fbdev helper with the given limits.
838 * Note that this won't yet touch the hardware (through the driver interfaces)
839 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
840 * to allow driver writes more control over the exact init sequence.
842 * Drivers must call drm_fb_helper_prepare() before calling this function.
845 * Zero if everything went ok, nonzero otherwise.
847 int drm_fb_helper_init(struct drm_device *dev,
848 struct drm_fb_helper *fb_helper,
851 struct drm_crtc *crtc;
852 struct drm_mode_config *config = &dev->mode_config;
855 if (!drm_fbdev_emulation) {
856 dev->fb_helper = fb_helper;
863 fb_helper->crtc_info = kcalloc(config->num_crtc, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
864 if (!fb_helper->crtc_info)
867 fb_helper->crtc_count = config->num_crtc;
868 fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
869 if (!fb_helper->connector_info) {
870 kfree(fb_helper->crtc_info);
873 fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
874 fb_helper->connector_count = 0;
876 for (i = 0; i < fb_helper->crtc_count; i++) {
877 fb_helper->crtc_info[i].mode_set.connectors =
878 kcalloc(max_conn_count,
879 sizeof(struct drm_connector *),
882 if (!fb_helper->crtc_info[i].mode_set.connectors)
884 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
885 fb_helper->crtc_info[i].rotation = DRM_MODE_ROTATE_0;
889 drm_for_each_crtc(crtc, dev) {
890 fb_helper->crtc_info[i].mode_set.crtc = crtc;
894 dev->fb_helper = fb_helper;
898 drm_fb_helper_crtc_free(fb_helper);
901 EXPORT_SYMBOL(drm_fb_helper_init);
904 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
905 * @fb_helper: driver-allocated fbdev helper
907 * A helper to alloc fb_info and the members cmap and apertures. Called
908 * by the driver within the fb_probe fb_helper callback function. Drivers do not
909 * need to release the allocated fb_info structure themselves, this is
910 * automatically done when calling drm_fb_helper_fini().
913 * fb_info pointer if things went okay, pointer containing error code
916 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
918 struct device *dev = fb_helper->dev->dev;
919 struct fb_info *info;
922 info = framebuffer_alloc(0, dev);
924 return ERR_PTR(-ENOMEM);
926 ret = fb_alloc_cmap(&info->cmap, 256, 0);
930 info->apertures = alloc_apertures(1);
931 if (!info->apertures) {
936 fb_helper->fbdev = info;
941 fb_dealloc_cmap(&info->cmap);
943 framebuffer_release(info);
946 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
949 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
950 * @fb_helper: driver-allocated fbdev helper, can be NULL
952 * A wrapper around unregister_framebuffer, to release the fb_info
953 * framebuffer device. This must be called before releasing all resources for
954 * @fb_helper by calling drm_fb_helper_fini().
956 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
958 if (fb_helper && fb_helper->fbdev)
959 unregister_framebuffer(fb_helper->fbdev);
961 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
964 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
965 * @fb_helper: driver-allocated fbdev helper, can be NULL
967 * This cleans up all remaining resources associated with @fb_helper. Must be
968 * called after drm_fb_helper_unlink_fbi() was called.
970 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
972 struct fb_info *info;
977 fb_helper->dev->fb_helper = NULL;
979 if (!drm_fbdev_emulation)
982 cancel_work_sync(&fb_helper->resume_work);
983 cancel_work_sync(&fb_helper->dirty_work);
985 info = fb_helper->fbdev;
988 fb_dealloc_cmap(&info->cmap);
989 framebuffer_release(info);
991 fb_helper->fbdev = NULL;
993 mutex_lock(&kernel_fb_helper_lock);
994 if (!list_empty(&fb_helper->kernel_fb_list)) {
995 list_del(&fb_helper->kernel_fb_list);
996 if (list_empty(&kernel_fb_helper_list))
997 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
999 mutex_unlock(&kernel_fb_helper_lock);
1001 mutex_destroy(&fb_helper->lock);
1002 drm_fb_helper_crtc_free(fb_helper);
1005 EXPORT_SYMBOL(drm_fb_helper_fini);
1008 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
1009 * @fb_helper: driver-allocated fbdev helper, can be NULL
1011 * A wrapper around unlink_framebuffer implemented by fbdev core
1013 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
1015 if (fb_helper && fb_helper->fbdev)
1016 unlink_framebuffer(fb_helper->fbdev);
1018 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
1020 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
1021 u32 width, u32 height)
1023 struct drm_fb_helper *helper = info->par;
1024 struct drm_clip_rect *clip = &helper->dirty_clip;
1025 unsigned long flags;
1027 if (!helper->fb->funcs->dirty)
1030 spin_lock_irqsave(&helper->dirty_lock, flags);
1031 clip->x1 = min_t(u32, clip->x1, x);
1032 clip->y1 = min_t(u32, clip->y1, y);
1033 clip->x2 = max_t(u32, clip->x2, x + width);
1034 clip->y2 = max_t(u32, clip->y2, y + height);
1035 spin_unlock_irqrestore(&helper->dirty_lock, flags);
1037 schedule_work(&helper->dirty_work);
1041 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
1042 * @info: fb_info struct pointer
1043 * @pagelist: list of dirty mmap framebuffer pages
1045 * This function is used as the &fb_deferred_io.deferred_io
1046 * callback function for flushing the fbdev mmap writes.
1048 void drm_fb_helper_deferred_io(struct fb_info *info,
1049 struct list_head *pagelist)
1051 unsigned long start, end, min, max;
1057 list_for_each_entry(page, pagelist, lru) {
1058 start = page->index << PAGE_SHIFT;
1059 end = start + PAGE_SIZE - 1;
1060 min = min(min, start);
1061 max = max(max, end);
1065 y1 = min / info->fix.line_length;
1066 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
1068 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
1071 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
1074 * drm_fb_helper_defio_init - fbdev deferred I/O initialization
1075 * @fb_helper: driver-allocated fbdev helper
1077 * This function allocates &fb_deferred_io, sets callback to
1078 * drm_fb_helper_deferred_io(), delay to 50ms and calls fb_deferred_io_init().
1079 * It should be called from the &drm_fb_helper_funcs->fb_probe callback.
1080 * drm_fb_helper_fbdev_teardown() cleans up deferred I/O.
1082 * NOTE: A copy of &fb_ops is made and assigned to &info->fbops. This is done
1083 * because fb_deferred_io_cleanup() clears &fbops->fb_mmap and would thereby
1084 * affect other instances of that &fb_ops.
1087 * 0 on success or a negative error code on failure.
1089 int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
1091 struct fb_info *info = fb_helper->fbdev;
1092 struct fb_deferred_io *fbdefio;
1093 struct fb_ops *fbops;
1095 fbdefio = kzalloc(sizeof(*fbdefio), GFP_KERNEL);
1096 fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
1097 if (!fbdefio || !fbops) {
1103 info->fbdefio = fbdefio;
1104 fbdefio->delay = msecs_to_jiffies(50);
1105 fbdefio->deferred_io = drm_fb_helper_deferred_io;
1107 *fbops = *info->fbops;
1108 info->fbops = fbops;
1110 fb_deferred_io_init(info);
1114 EXPORT_SYMBOL(drm_fb_helper_defio_init);
1117 * drm_fb_helper_sys_read - wrapper around fb_sys_read
1118 * @info: fb_info struct pointer
1119 * @buf: userspace buffer to read from framebuffer memory
1120 * @count: number of bytes to read from framebuffer memory
1121 * @ppos: read offset within framebuffer memory
1123 * A wrapper around fb_sys_read implemented by fbdev core
1125 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
1126 size_t count, loff_t *ppos)
1128 return fb_sys_read(info, buf, count, ppos);
1130 EXPORT_SYMBOL(drm_fb_helper_sys_read);
1133 * drm_fb_helper_sys_write - wrapper around fb_sys_write
1134 * @info: fb_info struct pointer
1135 * @buf: userspace buffer to write to framebuffer memory
1136 * @count: number of bytes to write to framebuffer memory
1137 * @ppos: write offset within framebuffer memory
1139 * A wrapper around fb_sys_write implemented by fbdev core
1141 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
1142 size_t count, loff_t *ppos)
1146 ret = fb_sys_write(info, buf, count, ppos);
1148 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
1153 EXPORT_SYMBOL(drm_fb_helper_sys_write);
1156 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
1157 * @info: fbdev registered by the helper
1158 * @rect: info about rectangle to fill
1160 * A wrapper around sys_fillrect implemented by fbdev core
1162 void drm_fb_helper_sys_fillrect(struct fb_info *info,
1163 const struct fb_fillrect *rect)
1165 sys_fillrect(info, rect);
1166 drm_fb_helper_dirty(info, rect->dx, rect->dy,
1167 rect->width, rect->height);
1169 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
1172 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
1173 * @info: fbdev registered by the helper
1174 * @area: info about area to copy
1176 * A wrapper around sys_copyarea implemented by fbdev core
1178 void drm_fb_helper_sys_copyarea(struct fb_info *info,
1179 const struct fb_copyarea *area)
1181 sys_copyarea(info, area);
1182 drm_fb_helper_dirty(info, area->dx, area->dy,
1183 area->width, area->height);
1185 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
1188 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
1189 * @info: fbdev registered by the helper
1190 * @image: info about image to blit
1192 * A wrapper around sys_imageblit implemented by fbdev core
1194 void drm_fb_helper_sys_imageblit(struct fb_info *info,
1195 const struct fb_image *image)
1197 sys_imageblit(info, image);
1198 drm_fb_helper_dirty(info, image->dx, image->dy,
1199 image->width, image->height);
1201 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
1204 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
1205 * @info: fbdev registered by the helper
1206 * @rect: info about rectangle to fill
1208 * A wrapper around cfb_fillrect implemented by fbdev core
1210 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
1211 const struct fb_fillrect *rect)
1213 cfb_fillrect(info, rect);
1214 drm_fb_helper_dirty(info, rect->dx, rect->dy,
1215 rect->width, rect->height);
1217 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
1220 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1221 * @info: fbdev registered by the helper
1222 * @area: info about area to copy
1224 * A wrapper around cfb_copyarea implemented by fbdev core
1226 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1227 const struct fb_copyarea *area)
1229 cfb_copyarea(info, area);
1230 drm_fb_helper_dirty(info, area->dx, area->dy,
1231 area->width, area->height);
1233 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1236 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1237 * @info: fbdev registered by the helper
1238 * @image: info about image to blit
1240 * A wrapper around cfb_imageblit implemented by fbdev core
1242 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1243 const struct fb_image *image)
1245 cfb_imageblit(info, image);
1246 drm_fb_helper_dirty(info, image->dx, image->dy,
1247 image->width, image->height);
1249 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1252 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1253 * @fb_helper: driver-allocated fbdev helper, can be NULL
1254 * @suspend: whether to suspend or resume
1256 * A wrapper around fb_set_suspend implemented by fbdev core.
1257 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1260 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
1262 if (fb_helper && fb_helper->fbdev)
1263 fb_set_suspend(fb_helper->fbdev, suspend);
1265 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1268 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1269 * takes the console lock
1270 * @fb_helper: driver-allocated fbdev helper, can be NULL
1271 * @suspend: whether to suspend or resume
1273 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1274 * isn't available on resume, a worker is tasked with waiting for the lock
1275 * to become available. The console lock can be pretty contented on resume
1276 * due to all the printk activity.
1278 * This function can be called multiple times with the same state since
1279 * &fb_info.state is checked to see if fbdev is running or not before locking.
1281 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1283 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
1286 if (!fb_helper || !fb_helper->fbdev)
1289 /* make sure there's no pending/ongoing resume */
1290 flush_work(&fb_helper->resume_work);
1293 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
1299 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
1302 if (!console_trylock()) {
1303 schedule_work(&fb_helper->resume_work);
1308 fb_set_suspend(fb_helper->fbdev, suspend);
1311 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
1313 static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info)
1315 u32 *palette = (u32 *)info->pseudo_palette;
1318 if (cmap->start + cmap->len > 16)
1321 for (i = 0; i < cmap->len; ++i) {
1322 u16 red = cmap->red[i];
1323 u16 green = cmap->green[i];
1324 u16 blue = cmap->blue[i];
1327 red >>= 16 - info->var.red.length;
1328 green >>= 16 - info->var.green.length;
1329 blue >>= 16 - info->var.blue.length;
1330 value = (red << info->var.red.offset) |
1331 (green << info->var.green.offset) |
1332 (blue << info->var.blue.offset);
1333 if (info->var.transp.length > 0) {
1334 u32 mask = (1 << info->var.transp.length) - 1;
1336 mask <<= info->var.transp.offset;
1339 palette[cmap->start + i] = value;
1345 static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info)
1347 struct drm_fb_helper *fb_helper = info->par;
1348 struct drm_crtc *crtc;
1352 drm_modeset_lock_all(fb_helper->dev);
1353 for (i = 0; i < fb_helper->crtc_count; i++) {
1354 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1355 if (!crtc->funcs->gamma_set || !crtc->gamma_size)
1358 if (cmap->start + cmap->len > crtc->gamma_size)
1361 r = crtc->gamma_store;
1362 g = r + crtc->gamma_size;
1363 b = g + crtc->gamma_size;
1365 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1366 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1367 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1369 ret = crtc->funcs->gamma_set(crtc, r, g, b,
1370 crtc->gamma_size, NULL);
1374 drm_modeset_unlock_all(fb_helper->dev);
1379 static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc,
1380 struct fb_cmap *cmap)
1382 struct drm_device *dev = crtc->dev;
1383 struct drm_property_blob *gamma_lut;
1384 struct drm_color_lut *lut;
1385 int size = crtc->gamma_size;
1388 if (!size || cmap->start + cmap->len > size)
1389 return ERR_PTR(-EINVAL);
1391 gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL);
1392 if (IS_ERR(gamma_lut))
1395 lut = gamma_lut->data;
1396 if (cmap->start || cmap->len != size) {
1397 u16 *r = crtc->gamma_store;
1398 u16 *g = r + crtc->gamma_size;
1399 u16 *b = g + crtc->gamma_size;
1401 for (i = 0; i < cmap->start; i++) {
1403 lut[i].green = g[i];
1406 for (i = cmap->start + cmap->len; i < size; i++) {
1408 lut[i].green = g[i];
1413 for (i = 0; i < cmap->len; i++) {
1414 lut[cmap->start + i].red = cmap->red[i];
1415 lut[cmap->start + i].green = cmap->green[i];
1416 lut[cmap->start + i].blue = cmap->blue[i];
1422 static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info)
1424 struct drm_fb_helper *fb_helper = info->par;
1425 struct drm_device *dev = fb_helper->dev;
1426 struct drm_property_blob *gamma_lut = NULL;
1427 struct drm_modeset_acquire_ctx ctx;
1428 struct drm_crtc_state *crtc_state;
1429 struct drm_atomic_state *state;
1430 struct drm_crtc *crtc;
1435 drm_modeset_acquire_init(&ctx, 0);
1437 state = drm_atomic_state_alloc(dev);
1443 state->acquire_ctx = &ctx;
1445 for (i = 0; i < fb_helper->crtc_count; i++) {
1446 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1449 gamma_lut = setcmap_new_gamma_lut(crtc, cmap);
1450 if (IS_ERR(gamma_lut)) {
1451 ret = PTR_ERR(gamma_lut);
1456 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1457 if (IS_ERR(crtc_state)) {
1458 ret = PTR_ERR(crtc_state);
1462 replaced = drm_property_replace_blob(&crtc_state->degamma_lut,
1464 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
1465 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut,
1467 crtc_state->color_mgmt_changed |= replaced;
1470 ret = drm_atomic_commit(state);
1474 for (i = 0; i < fb_helper->crtc_count; i++) {
1475 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1477 r = crtc->gamma_store;
1478 g = r + crtc->gamma_size;
1479 b = g + crtc->gamma_size;
1481 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1482 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1483 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1487 if (ret == -EDEADLK)
1490 drm_property_blob_put(gamma_lut);
1491 drm_atomic_state_put(state);
1493 drm_modeset_drop_locks(&ctx);
1494 drm_modeset_acquire_fini(&ctx);
1499 drm_atomic_state_clear(state);
1500 drm_modeset_backoff(&ctx);
1505 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1506 * @cmap: cmap to set
1507 * @info: fbdev registered by the helper
1509 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1511 struct drm_fb_helper *fb_helper = info->par;
1514 if (oops_in_progress)
1517 mutex_lock(&fb_helper->lock);
1519 if (!drm_fb_helper_is_bound(fb_helper)) {
1524 if (info->fix.visual == FB_VISUAL_TRUECOLOR)
1525 ret = setcmap_pseudo_palette(cmap, info);
1526 else if (drm_drv_uses_atomic_modeset(fb_helper->dev))
1527 ret = setcmap_atomic(cmap, info);
1529 ret = setcmap_legacy(cmap, info);
1532 mutex_unlock(&fb_helper->lock);
1536 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1539 * drm_fb_helper_ioctl - legacy ioctl implementation
1540 * @info: fbdev registered by the helper
1541 * @cmd: ioctl command
1542 * @arg: ioctl argument
1544 * A helper to implement the standard fbdev ioctl. Only
1545 * FBIO_WAITFORVSYNC is implemented for now.
1547 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
1550 struct drm_fb_helper *fb_helper = info->par;
1551 struct drm_mode_set *mode_set;
1552 struct drm_crtc *crtc;
1555 mutex_lock(&fb_helper->lock);
1556 if (!drm_fb_helper_is_bound(fb_helper)) {
1562 case FBIO_WAITFORVSYNC:
1564 * Only consider the first CRTC.
1566 * This ioctl is supposed to take the CRTC number as
1567 * an argument, but in fbdev times, what that number
1568 * was supposed to be was quite unclear, different
1569 * drivers were passing that argument differently
1570 * (some by reference, some by value), and most of the
1571 * userspace applications were just hardcoding 0 as an
1574 * The first CRTC should be the integrated panel on
1575 * most drivers, so this is the best choice we can
1576 * make. If we're not smart enough here, one should
1577 * just consider switch the userspace to KMS.
1579 mode_set = &fb_helper->crtc_info[0].mode_set;
1580 crtc = mode_set->crtc;
1583 * Only wait for a vblank event if the CRTC is
1584 * enabled, otherwise just don't do anythintg,
1585 * not even report an error.
1587 ret = drm_crtc_vblank_get(crtc);
1589 drm_crtc_wait_one_vblank(crtc);
1590 drm_crtc_vblank_put(crtc);
1600 mutex_unlock(&fb_helper->lock);
1603 EXPORT_SYMBOL(drm_fb_helper_ioctl);
1605 static bool drm_fb_pixel_format_equal(const struct fb_var_screeninfo *var_1,
1606 const struct fb_var_screeninfo *var_2)
1608 return var_1->bits_per_pixel == var_2->bits_per_pixel &&
1609 var_1->grayscale == var_2->grayscale &&
1610 var_1->red.offset == var_2->red.offset &&
1611 var_1->red.length == var_2->red.length &&
1612 var_1->red.msb_right == var_2->red.msb_right &&
1613 var_1->green.offset == var_2->green.offset &&
1614 var_1->green.length == var_2->green.length &&
1615 var_1->green.msb_right == var_2->green.msb_right &&
1616 var_1->blue.offset == var_2->blue.offset &&
1617 var_1->blue.length == var_2->blue.length &&
1618 var_1->blue.msb_right == var_2->blue.msb_right &&
1619 var_1->transp.offset == var_2->transp.offset &&
1620 var_1->transp.length == var_2->transp.length &&
1621 var_1->transp.msb_right == var_2->transp.msb_right;
1625 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1626 * @var: screeninfo to check
1627 * @info: fbdev registered by the helper
1629 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1630 struct fb_info *info)
1632 struct drm_fb_helper *fb_helper = info->par;
1633 struct drm_framebuffer *fb = fb_helper->fb;
1635 if (var->pixclock != 0 || in_dbg_master())
1638 if ((drm_format_info_block_width(fb->format, 0) > 1) ||
1639 (drm_format_info_block_height(fb->format, 0) > 1))
1643 * Changes struct fb_var_screeninfo are currently not pushed back
1644 * to KMS, hence fail if different settings are requested.
1646 if (var->bits_per_pixel != fb->format->cpp[0] * 8 ||
1647 var->xres > fb->width || var->yres > fb->height ||
1648 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1649 DRM_DEBUG("fb requested width/height/bpp can't fit in current fb "
1650 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1651 var->xres, var->yres, var->bits_per_pixel,
1652 var->xres_virtual, var->yres_virtual,
1653 fb->width, fb->height, fb->format->cpp[0] * 8);
1658 * drm fbdev emulation doesn't support changing the pixel format at all,
1659 * so reject all pixel format changing requests.
1661 if (!drm_fb_pixel_format_equal(var, &info->var)) {
1662 DRM_DEBUG("fbdev emulation doesn't support changing the pixel format\n");
1668 EXPORT_SYMBOL(drm_fb_helper_check_var);
1671 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1672 * @info: fbdev registered by the helper
1674 * This will let fbcon do the mode init and is called at initialization time by
1675 * the fbdev core when registering the driver, and later on through the hotplug
1678 int drm_fb_helper_set_par(struct fb_info *info)
1680 struct drm_fb_helper *fb_helper = info->par;
1681 struct fb_var_screeninfo *var = &info->var;
1683 if (oops_in_progress)
1686 if (var->pixclock != 0) {
1687 DRM_ERROR("PIXEL CLOCK SET\n");
1691 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1695 EXPORT_SYMBOL(drm_fb_helper_set_par);
1697 static void pan_set(struct drm_fb_helper *fb_helper, int x, int y)
1701 for (i = 0; i < fb_helper->crtc_count; i++) {
1702 struct drm_mode_set *mode_set;
1704 mode_set = &fb_helper->crtc_info[i].mode_set;
1711 static int pan_display_atomic(struct fb_var_screeninfo *var,
1712 struct fb_info *info)
1714 struct drm_fb_helper *fb_helper = info->par;
1717 pan_set(fb_helper, var->xoffset, var->yoffset);
1719 ret = restore_fbdev_mode_atomic(fb_helper, true);
1721 info->var.xoffset = var->xoffset;
1722 info->var.yoffset = var->yoffset;
1724 pan_set(fb_helper, info->var.xoffset, info->var.yoffset);
1729 static int pan_display_legacy(struct fb_var_screeninfo *var,
1730 struct fb_info *info)
1732 struct drm_fb_helper *fb_helper = info->par;
1733 struct drm_mode_set *modeset;
1737 drm_modeset_lock_all(fb_helper->dev);
1738 for (i = 0; i < fb_helper->crtc_count; i++) {
1739 modeset = &fb_helper->crtc_info[i].mode_set;
1741 modeset->x = var->xoffset;
1742 modeset->y = var->yoffset;
1744 if (modeset->num_connectors) {
1745 ret = drm_mode_set_config_internal(modeset);
1747 info->var.xoffset = var->xoffset;
1748 info->var.yoffset = var->yoffset;
1752 drm_modeset_unlock_all(fb_helper->dev);
1758 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1759 * @var: updated screen information
1760 * @info: fbdev registered by the helper
1762 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1763 struct fb_info *info)
1765 struct drm_fb_helper *fb_helper = info->par;
1766 struct drm_device *dev = fb_helper->dev;
1769 if (oops_in_progress)
1772 mutex_lock(&fb_helper->lock);
1773 if (!drm_fb_helper_is_bound(fb_helper)) {
1774 mutex_unlock(&fb_helper->lock);
1778 if (drm_drv_uses_atomic_modeset(dev))
1779 ret = pan_display_atomic(var, info);
1781 ret = pan_display_legacy(var, info);
1782 mutex_unlock(&fb_helper->lock);
1786 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1789 * Allocates the backing storage and sets up the fbdev info structure through
1790 * the ->fb_probe callback.
1792 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1798 struct drm_fb_helper_surface_size sizes;
1802 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1803 sizes.surface_depth = 24;
1804 sizes.surface_bpp = 32;
1805 sizes.fb_width = (u32)-1;
1806 sizes.fb_height = (u32)-1;
1809 * If driver picks 8 or 16 by default use that for both depth/bpp
1812 if (preferred_bpp != sizes.surface_bpp)
1813 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1815 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1816 drm_fb_helper_for_each_connector(fb_helper, i) {
1817 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1818 struct drm_cmdline_mode *cmdline_mode;
1820 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1822 if (cmdline_mode->bpp_specified) {
1823 switch (cmdline_mode->bpp) {
1825 sizes.surface_depth = sizes.surface_bpp = 8;
1828 sizes.surface_depth = 15;
1829 sizes.surface_bpp = 16;
1832 sizes.surface_depth = sizes.surface_bpp = 16;
1835 sizes.surface_depth = sizes.surface_bpp = 24;
1838 sizes.surface_depth = 24;
1839 sizes.surface_bpp = 32;
1847 * If we run into a situation where, for example, the primary plane
1848 * supports RGBA5551 (16 bpp, depth 15) but not RGB565 (16 bpp, depth
1849 * 16) we need to scale down the depth of the sizes we request.
1851 for (i = 0; i < fb_helper->crtc_count; i++) {
1852 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
1853 struct drm_crtc *crtc = mode_set->crtc;
1854 struct drm_plane *plane = crtc->primary;
1857 DRM_DEBUG("test CRTC %d primary plane\n", i);
1859 for (j = 0; j < plane->format_count; j++) {
1860 const struct drm_format_info *fmt;
1862 fmt = drm_format_info(plane->format_types[j]);
1865 * Do not consider YUV or other complicated formats
1866 * for framebuffers. This means only legacy formats
1867 * are supported (fmt->depth is a legacy field) but
1868 * the framebuffer emulation can only deal with such
1869 * formats, specifically RGB/BGA formats.
1871 if (fmt->depth == 0)
1874 /* We found a perfect fit, great */
1875 if (fmt->depth == sizes.surface_depth) {
1876 best_depth = fmt->depth;
1880 /* Skip depths above what we're looking for */
1881 if (fmt->depth > sizes.surface_depth)
1884 /* Best depth found so far */
1885 if (fmt->depth > best_depth)
1886 best_depth = fmt->depth;
1889 if (sizes.surface_depth != best_depth) {
1890 DRM_INFO("requested bpp %d, scaled depth down to %d",
1891 sizes.surface_bpp, best_depth);
1892 sizes.surface_depth = best_depth;
1896 for (i = 0; i < fb_helper->crtc_count; i++) {
1897 struct drm_display_mode *desired_mode;
1898 struct drm_mode_set *mode_set;
1900 /* in case of tile group, are we the last tile vert or horiz?
1901 * If no tile group you are always the last one both vertically
1904 bool lastv = true, lasth = true;
1906 desired_mode = fb_helper->crtc_info[i].desired_mode;
1907 mode_set = &fb_helper->crtc_info[i].mode_set;
1914 x = fb_helper->crtc_info[i].x;
1915 y = fb_helper->crtc_info[i].y;
1917 if (gamma_size == 0)
1918 gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1920 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1921 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1923 for (j = 0; j < mode_set->num_connectors; j++) {
1924 struct drm_connector *connector = mode_set->connectors[j];
1926 if (connector->has_tile) {
1927 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1928 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1929 /* cloning to multiple tiles is just crazy-talk, so: */
1935 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1937 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1940 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1941 DRM_INFO("Cannot find any crtc or sizes\n");
1943 /* First time: disable all crtc's.. */
1944 if (!fb_helper->deferred_setup && !READ_ONCE(fb_helper->dev->master))
1945 restore_fbdev_mode(fb_helper);
1949 /* Handle our overallocation */
1950 sizes.surface_height *= drm_fbdev_overalloc;
1951 sizes.surface_height /= 100;
1953 /* push down into drivers */
1954 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1958 strcpy(fb_helper->fb->comm, "[fbcon]");
1963 * drm_fb_helper_fill_fix - initializes fixed fbdev information
1964 * @info: fbdev registered by the helper
1965 * @pitch: desired pitch
1966 * @depth: desired depth
1968 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1969 * fbdev emulations. Drivers which support acceleration methods which impose
1970 * additional constraints need to set up their own limits.
1972 * Drivers should call this (or their equivalent setup code) from their
1973 * &drm_fb_helper_funcs.fb_probe callback.
1975 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1978 info->fix.type = FB_TYPE_PACKED_PIXELS;
1979 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1980 FB_VISUAL_TRUECOLOR;
1981 info->fix.mmio_start = 0;
1982 info->fix.mmio_len = 0;
1983 info->fix.type_aux = 0;
1984 info->fix.xpanstep = 1; /* doing it in hw */
1985 info->fix.ypanstep = 1; /* doing it in hw */
1986 info->fix.ywrapstep = 0;
1987 info->fix.accel = FB_ACCEL_NONE;
1989 info->fix.line_length = pitch;
1991 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1994 * drm_fb_helper_fill_var - initalizes variable fbdev information
1995 * @info: fbdev instance to set up
1996 * @fb_helper: fb helper instance to use as template
1997 * @fb_width: desired fb width
1998 * @fb_height: desired fb height
2000 * Sets up the variable fbdev metainformation from the given fb helper instance
2001 * and the drm framebuffer allocated in &drm_fb_helper.fb.
2003 * Drivers should call this (or their equivalent setup code) from their
2004 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
2005 * backing storage framebuffer.
2007 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
2008 uint32_t fb_width, uint32_t fb_height)
2010 struct drm_framebuffer *fb = fb_helper->fb;
2012 WARN_ON((drm_format_info_block_width(fb->format, 0) > 1) ||
2013 (drm_format_info_block_height(fb->format, 0) > 1));
2014 info->pseudo_palette = fb_helper->pseudo_palette;
2015 info->var.xres_virtual = fb->width;
2016 info->var.yres_virtual = fb->height;
2017 info->var.bits_per_pixel = fb->format->cpp[0] * 8;
2018 info->var.accel_flags = FB_ACCELF_TEXT;
2019 info->var.xoffset = 0;
2020 info->var.yoffset = 0;
2021 info->var.activate = FB_ACTIVATE_NOW;
2023 switch (fb->format->depth) {
2025 info->var.red.offset = 0;
2026 info->var.green.offset = 0;
2027 info->var.blue.offset = 0;
2028 info->var.red.length = 8; /* 8bit DAC */
2029 info->var.green.length = 8;
2030 info->var.blue.length = 8;
2031 info->var.transp.offset = 0;
2032 info->var.transp.length = 0;
2035 info->var.red.offset = 10;
2036 info->var.green.offset = 5;
2037 info->var.blue.offset = 0;
2038 info->var.red.length = 5;
2039 info->var.green.length = 5;
2040 info->var.blue.length = 5;
2041 info->var.transp.offset = 15;
2042 info->var.transp.length = 1;
2045 info->var.red.offset = 11;
2046 info->var.green.offset = 5;
2047 info->var.blue.offset = 0;
2048 info->var.red.length = 5;
2049 info->var.green.length = 6;
2050 info->var.blue.length = 5;
2051 info->var.transp.offset = 0;
2054 info->var.red.offset = 16;
2055 info->var.green.offset = 8;
2056 info->var.blue.offset = 0;
2057 info->var.red.length = 8;
2058 info->var.green.length = 8;
2059 info->var.blue.length = 8;
2060 info->var.transp.offset = 0;
2061 info->var.transp.length = 0;
2064 info->var.red.offset = 16;
2065 info->var.green.offset = 8;
2066 info->var.blue.offset = 0;
2067 info->var.red.length = 8;
2068 info->var.green.length = 8;
2069 info->var.blue.length = 8;
2070 info->var.transp.offset = 24;
2071 info->var.transp.length = 8;
2077 info->var.xres = fb_width;
2078 info->var.yres = fb_height;
2080 EXPORT_SYMBOL(drm_fb_helper_fill_var);
2082 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
2086 struct drm_connector *connector;
2089 drm_fb_helper_for_each_connector(fb_helper, i) {
2090 connector = fb_helper->connector_info[i]->connector;
2091 count += connector->funcs->fill_modes(connector, maxX, maxY);
2097 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
2099 struct drm_display_mode *mode;
2101 list_for_each_entry(mode, &fb_connector->connector->modes, head) {
2102 if (mode->hdisplay > width ||
2103 mode->vdisplay > height)
2105 if (mode->type & DRM_MODE_TYPE_PREFERRED)
2110 EXPORT_SYMBOL(drm_has_preferred_mode);
2112 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
2114 return fb_connector->connector->cmdline_mode.specified;
2117 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn)
2119 struct drm_cmdline_mode *cmdline_mode;
2120 struct drm_display_mode *mode;
2121 bool prefer_non_interlace;
2123 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
2124 if (cmdline_mode->specified == false)
2127 /* attempt to find a matching mode in the list of modes
2128 * we have gotten so far, if not add a CVT mode that conforms
2130 if (cmdline_mode->rb || cmdline_mode->margins)
2133 prefer_non_interlace = !cmdline_mode->interlace;
2135 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
2136 /* check width/height */
2137 if (mode->hdisplay != cmdline_mode->xres ||
2138 mode->vdisplay != cmdline_mode->yres)
2141 if (cmdline_mode->refresh_specified) {
2142 if (mode->vrefresh != cmdline_mode->refresh)
2146 if (cmdline_mode->interlace) {
2147 if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
2149 } else if (prefer_non_interlace) {
2150 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
2156 if (prefer_non_interlace) {
2157 prefer_non_interlace = false;
2162 mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
2164 list_add(&mode->head, &fb_helper_conn->connector->modes);
2167 EXPORT_SYMBOL(drm_pick_cmdline_mode);
2169 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
2173 if (connector->display_info.non_desktop)
2177 enable = connector->status == connector_status_connected;
2179 enable = connector->status != connector_status_disconnected;
2184 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
2187 bool any_enabled = false;
2188 struct drm_connector *connector;
2191 drm_fb_helper_for_each_connector(fb_helper, i) {
2192 connector = fb_helper->connector_info[i]->connector;
2193 enabled[i] = drm_connector_enabled(connector, true);
2194 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
2195 connector->display_info.non_desktop ? "non desktop" : enabled[i] ? "yes" : "no");
2197 any_enabled |= enabled[i];
2203 drm_fb_helper_for_each_connector(fb_helper, i) {
2204 connector = fb_helper->connector_info[i]->connector;
2205 enabled[i] = drm_connector_enabled(connector, false);
2209 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
2210 struct drm_display_mode **modes,
2211 struct drm_fb_offset *offsets,
2212 bool *enabled, int width, int height)
2215 bool can_clone = false;
2216 struct drm_fb_helper_connector *fb_helper_conn;
2217 struct drm_display_mode *dmt_mode, *mode;
2219 /* only contemplate cloning in the single crtc case */
2220 if (fb_helper->crtc_count > 1)
2224 drm_fb_helper_for_each_connector(fb_helper, i) {
2229 /* only contemplate cloning if more than one connector is enabled */
2233 /* check the command line or if nothing common pick 1024x768 */
2235 drm_fb_helper_for_each_connector(fb_helper, i) {
2238 fb_helper_conn = fb_helper->connector_info[i];
2239 modes[i] = drm_pick_cmdline_mode(fb_helper_conn);
2244 for (j = 0; j < i; j++) {
2247 if (!drm_mode_match(modes[j], modes[i],
2248 DRM_MODE_MATCH_TIMINGS |
2249 DRM_MODE_MATCH_CLOCK |
2250 DRM_MODE_MATCH_FLAGS |
2251 DRM_MODE_MATCH_3D_FLAGS))
2257 DRM_DEBUG_KMS("can clone using command line\n");
2261 /* try and find a 1024x768 mode on each connector */
2263 dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
2265 drm_fb_helper_for_each_connector(fb_helper, i) {
2269 fb_helper_conn = fb_helper->connector_info[i];
2270 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
2271 if (drm_mode_match(mode, dmt_mode,
2272 DRM_MODE_MATCH_TIMINGS |
2273 DRM_MODE_MATCH_CLOCK |
2274 DRM_MODE_MATCH_FLAGS |
2275 DRM_MODE_MATCH_3D_FLAGS))
2283 DRM_DEBUG_KMS("can clone using 1024x768\n");
2286 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
2290 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
2291 struct drm_display_mode **modes,
2292 struct drm_fb_offset *offsets,
2294 int h_idx, int v_idx)
2296 struct drm_fb_helper_connector *fb_helper_conn;
2298 int hoffset = 0, voffset = 0;
2300 drm_fb_helper_for_each_connector(fb_helper, i) {
2301 fb_helper_conn = fb_helper->connector_info[i];
2302 if (!fb_helper_conn->connector->has_tile)
2305 if (!modes[i] && (h_idx || v_idx)) {
2306 DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
2307 fb_helper_conn->connector->base.id);
2310 if (fb_helper_conn->connector->tile_h_loc < h_idx)
2311 hoffset += modes[i]->hdisplay;
2313 if (fb_helper_conn->connector->tile_v_loc < v_idx)
2314 voffset += modes[i]->vdisplay;
2316 offsets[idx].x = hoffset;
2317 offsets[idx].y = voffset;
2318 DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
2322 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
2323 struct drm_display_mode **modes,
2324 struct drm_fb_offset *offsets,
2325 bool *enabled, int width, int height)
2327 struct drm_fb_helper_connector *fb_helper_conn;
2328 const u64 mask = BIT_ULL(fb_helper->connector_count) - 1;
2329 u64 conn_configured = 0;
2334 drm_fb_helper_for_each_connector(fb_helper, i) {
2335 fb_helper_conn = fb_helper->connector_info[i];
2337 if (conn_configured & BIT_ULL(i))
2340 if (enabled[i] == false) {
2341 conn_configured |= BIT_ULL(i);
2345 /* first pass over all the untiled connectors */
2346 if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
2349 if (tile_pass == 1) {
2350 if (fb_helper_conn->connector->tile_h_loc != 0 ||
2351 fb_helper_conn->connector->tile_v_loc != 0)
2355 if (fb_helper_conn->connector->tile_h_loc != tile_pass - 1 &&
2356 fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
2357 /* if this tile_pass doesn't cover any of the tiles - keep going */
2361 * find the tile offsets for this pass - need to find
2362 * all tiles left and above
2364 drm_get_tile_offsets(fb_helper, modes, offsets,
2365 i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
2367 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
2368 fb_helper_conn->connector->base.id);
2370 /* got for command line mode first */
2371 modes[i] = drm_pick_cmdline_mode(fb_helper_conn);
2373 DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
2374 fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
2375 modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
2377 /* No preferred modes, pick one off the list */
2378 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
2379 list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
2382 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
2384 conn_configured |= BIT_ULL(i);
2387 if ((conn_configured & mask) != mask) {
2394 static bool connector_has_possible_crtc(struct drm_connector *connector,
2395 struct drm_crtc *crtc)
2397 struct drm_encoder *encoder;
2400 drm_connector_for_each_possible_encoder(connector, encoder, i) {
2401 if (encoder->possible_crtcs & drm_crtc_mask(crtc))
2408 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
2409 struct drm_fb_helper_crtc **best_crtcs,
2410 struct drm_display_mode **modes,
2411 int n, int width, int height)
2414 struct drm_connector *connector;
2415 int my_score, best_score, score;
2416 struct drm_fb_helper_crtc **crtcs, *crtc;
2417 struct drm_fb_helper_connector *fb_helper_conn;
2419 if (n == fb_helper->connector_count)
2422 fb_helper_conn = fb_helper->connector_info[n];
2423 connector = fb_helper_conn->connector;
2425 best_crtcs[n] = NULL;
2426 best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
2427 if (modes[n] == NULL)
2430 crtcs = kcalloc(fb_helper->connector_count,
2431 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2436 if (connector->status == connector_status_connected)
2438 if (drm_has_cmdline_mode(fb_helper_conn))
2440 if (drm_has_preferred_mode(fb_helper_conn, width, height))
2444 * select a crtc for this connector and then attempt to configure
2445 * remaining connectors
2447 for (c = 0; c < fb_helper->crtc_count; c++) {
2448 crtc = &fb_helper->crtc_info[c];
2450 if (!connector_has_possible_crtc(connector,
2451 crtc->mode_set.crtc))
2454 for (o = 0; o < n; o++)
2455 if (best_crtcs[o] == crtc)
2459 /* ignore cloning unless only a single crtc */
2460 if (fb_helper->crtc_count > 1)
2463 if (!drm_mode_equal(modes[o], modes[n]))
2468 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
2469 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
2471 if (score > best_score) {
2473 memcpy(best_crtcs, crtcs,
2474 fb_helper->connector_count *
2475 sizeof(struct drm_fb_helper_crtc *));
2484 * This function checks if rotation is necessary because of panel orientation
2485 * and if it is, if it is supported.
2486 * If rotation is necessary and supported, its gets set in fb_crtc.rotation.
2487 * If rotation is necessary but not supported, a DRM_MODE_ROTATE_* flag gets
2488 * or-ed into fb_helper->sw_rotations. In drm_setup_crtcs_fb() we check if only
2489 * one bit is set and then we set fb_info.fbcon_rotate_hint to make fbcon do
2490 * the unsupported rotation.
2492 static void drm_setup_crtc_rotation(struct drm_fb_helper *fb_helper,
2493 struct drm_fb_helper_crtc *fb_crtc,
2494 struct drm_connector *connector)
2496 struct drm_plane *plane = fb_crtc->mode_set.crtc->primary;
2497 uint64_t valid_mask = 0;
2500 fb_crtc->rotation = DRM_MODE_ROTATE_0;
2502 switch (connector->display_info.panel_orientation) {
2503 case DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP:
2504 rotation = DRM_MODE_ROTATE_180;
2506 case DRM_MODE_PANEL_ORIENTATION_LEFT_UP:
2507 rotation = DRM_MODE_ROTATE_90;
2509 case DRM_MODE_PANEL_ORIENTATION_RIGHT_UP:
2510 rotation = DRM_MODE_ROTATE_270;
2513 rotation = DRM_MODE_ROTATE_0;
2517 * TODO: support 90 / 270 degree hardware rotation,
2518 * depending on the hardware this may require the framebuffer
2519 * to be in a specific tiling format.
2521 if (rotation != DRM_MODE_ROTATE_180 || !plane->rotation_property) {
2522 fb_helper->sw_rotations |= rotation;
2526 for (i = 0; i < plane->rotation_property->num_values; i++)
2527 valid_mask |= (1ULL << plane->rotation_property->values[i]);
2529 if (!(rotation & valid_mask)) {
2530 fb_helper->sw_rotations |= rotation;
2534 fb_crtc->rotation = rotation;
2535 /* Rotating in hardware, fbcon should not rotate */
2536 fb_helper->sw_rotations |= DRM_MODE_ROTATE_0;
2539 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper,
2540 u32 width, u32 height)
2542 struct drm_device *dev = fb_helper->dev;
2543 struct drm_fb_helper_crtc **crtcs;
2544 struct drm_display_mode **modes;
2545 struct drm_fb_offset *offsets;
2549 DRM_DEBUG_KMS("\n");
2550 /* prevent concurrent modification of connector_count by hotplug */
2551 lockdep_assert_held(&fb_helper->lock);
2553 crtcs = kcalloc(fb_helper->connector_count,
2554 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2555 modes = kcalloc(fb_helper->connector_count,
2556 sizeof(struct drm_display_mode *), GFP_KERNEL);
2557 offsets = kcalloc(fb_helper->connector_count,
2558 sizeof(struct drm_fb_offset), GFP_KERNEL);
2559 enabled = kcalloc(fb_helper->connector_count,
2560 sizeof(bool), GFP_KERNEL);
2561 if (!crtcs || !modes || !enabled || !offsets) {
2562 DRM_ERROR("Memory allocation failed\n");
2566 mutex_lock(&fb_helper->dev->mode_config.mutex);
2567 if (drm_fb_helper_probe_connector_modes(fb_helper, width, height) == 0)
2568 DRM_DEBUG_KMS("No connectors reported connected with modes\n");
2569 drm_enable_connectors(fb_helper, enabled);
2571 if (!(fb_helper->funcs->initial_config &&
2572 fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2574 enabled, width, height))) {
2575 memset(modes, 0, fb_helper->connector_count*sizeof(modes[0]));
2576 memset(crtcs, 0, fb_helper->connector_count*sizeof(crtcs[0]));
2577 memset(offsets, 0, fb_helper->connector_count*sizeof(offsets[0]));
2579 if (!drm_target_cloned(fb_helper, modes, offsets,
2580 enabled, width, height) &&
2581 !drm_target_preferred(fb_helper, modes, offsets,
2582 enabled, width, height))
2583 DRM_ERROR("Unable to find initial modes\n");
2585 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2588 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2590 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2592 /* need to set the modesets up here for use later */
2593 /* fill out the connector<->crtc mappings into the modesets */
2594 for (i = 0; i < fb_helper->crtc_count; i++)
2595 drm_fb_helper_modeset_release(fb_helper,
2596 &fb_helper->crtc_info[i].mode_set);
2598 fb_helper->sw_rotations = 0;
2599 drm_fb_helper_for_each_connector(fb_helper, i) {
2600 struct drm_display_mode *mode = modes[i];
2601 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2602 struct drm_fb_offset *offset = &offsets[i];
2604 if (mode && fb_crtc) {
2605 struct drm_mode_set *modeset = &fb_crtc->mode_set;
2606 struct drm_connector *connector =
2607 fb_helper->connector_info[i]->connector;
2609 DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2610 mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2612 fb_crtc->desired_mode = mode;
2613 fb_crtc->x = offset->x;
2614 fb_crtc->y = offset->y;
2615 modeset->mode = drm_mode_duplicate(dev,
2616 fb_crtc->desired_mode);
2617 drm_connector_get(connector);
2618 drm_setup_crtc_rotation(fb_helper, fb_crtc, connector);
2619 modeset->connectors[modeset->num_connectors++] = connector;
2620 modeset->x = offset->x;
2621 modeset->y = offset->y;
2632 * This is a continuation of drm_setup_crtcs() that sets up anything related
2633 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
2634 * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
2635 * So, any setup that touches those fields needs to be done here instead of in
2636 * drm_setup_crtcs().
2638 static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper)
2640 struct fb_info *info = fb_helper->fbdev;
2643 for (i = 0; i < fb_helper->crtc_count; i++)
2644 if (fb_helper->crtc_info[i].mode_set.num_connectors)
2645 fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
2647 mutex_lock(&fb_helper->dev->mode_config.mutex);
2648 drm_fb_helper_for_each_connector(fb_helper, i) {
2649 struct drm_connector *connector =
2650 fb_helper->connector_info[i]->connector;
2652 /* use first connected connector for the physical dimensions */
2653 if (connector->status == connector_status_connected) {
2654 info->var.width = connector->display_info.width_mm;
2655 info->var.height = connector->display_info.height_mm;
2659 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2661 switch (fb_helper->sw_rotations) {
2662 case DRM_MODE_ROTATE_0:
2663 info->fbcon_rotate_hint = FB_ROTATE_UR;
2665 case DRM_MODE_ROTATE_90:
2666 info->fbcon_rotate_hint = FB_ROTATE_CCW;
2668 case DRM_MODE_ROTATE_180:
2669 info->fbcon_rotate_hint = FB_ROTATE_UD;
2671 case DRM_MODE_ROTATE_270:
2672 info->fbcon_rotate_hint = FB_ROTATE_CW;
2676 * Multiple bits are set / multiple rotations requested
2677 * fbcon cannot handle separate rotation settings per
2678 * output, so fallback to unrotated.
2680 info->fbcon_rotate_hint = FB_ROTATE_UR;
2684 /* Note: Drops fb_helper->lock before returning. */
2686 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper,
2689 struct drm_device *dev = fb_helper->dev;
2690 struct fb_info *info;
2691 unsigned int width, height;
2694 width = dev->mode_config.max_width;
2695 height = dev->mode_config.max_height;
2697 drm_setup_crtcs(fb_helper, width, height);
2698 ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2700 if (ret == -EAGAIN) {
2701 fb_helper->preferred_bpp = bpp_sel;
2702 fb_helper->deferred_setup = true;
2705 mutex_unlock(&fb_helper->lock);
2709 drm_setup_crtcs_fb(fb_helper);
2711 fb_helper->deferred_setup = false;
2713 info = fb_helper->fbdev;
2714 info->var.pixclock = 0;
2715 /* Shamelessly allow physical address leaking to userspace */
2716 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
2717 if (!drm_leak_fbdev_smem)
2719 /* don't leak any physical addresses to userspace */
2720 info->flags |= FBINFO_HIDE_SMEM_START;
2722 /* Need to drop locks to avoid recursive deadlock in
2723 * register_framebuffer. This is ok because the only thing left to do is
2724 * register the fbdev emulation instance in kernel_fb_helper_list. */
2725 mutex_unlock(&fb_helper->lock);
2727 ret = register_framebuffer(info);
2731 dev_info(dev->dev, "fb%d: %s frame buffer device\n",
2732 info->node, info->fix.id);
2734 mutex_lock(&kernel_fb_helper_lock);
2735 if (list_empty(&kernel_fb_helper_list))
2736 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
2738 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
2739 mutex_unlock(&kernel_fb_helper_lock);
2745 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2746 * @fb_helper: fb_helper device struct
2747 * @bpp_sel: bpp value to use for the framebuffer configuration
2749 * Scans the CRTCs and connectors and tries to put together an initial setup.
2750 * At the moment, this is a cloned configuration across all heads with
2751 * a new framebuffer object as the backing store.
2753 * Note that this also registers the fbdev and so allows userspace to call into
2754 * the driver through the fbdev interfaces.
2756 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
2757 * to let the driver allocate and initialize the fbdev info structure and the
2758 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2759 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2760 * values for the fbdev info structure.
2764 * When you have fbcon support built-in or already loaded, this function will do
2765 * a full modeset to setup the fbdev console. Due to locking misdesign in the
2766 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2767 * console_lock. Until console_unlock is called no dmesg lines will be sent out
2768 * to consoles, not even serial console. This means when your driver crashes,
2769 * you will see absolutely nothing else but a system stuck in this function,
2770 * with no further output. Any kind of printk() you place within your own driver
2771 * or in the drm core modeset code will also never show up.
2773 * Standard debug practice is to run the fbcon setup without taking the
2774 * console_lock as a hack, to be able to see backtraces and crashes on the
2775 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2778 * The other option is to just disable fbdev emulation since very likely the
2779 * first modeset from userspace will crash in the same way, and is even easier
2780 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2781 * kernel cmdline option.
2784 * Zero if everything went ok, nonzero otherwise.
2786 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2790 if (!drm_fbdev_emulation)
2793 mutex_lock(&fb_helper->lock);
2794 ret = __drm_fb_helper_initial_config_and_unlock(fb_helper, bpp_sel);
2798 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2801 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2802 * probing all the outputs attached to the fb
2803 * @fb_helper: driver-allocated fbdev helper, can be NULL
2805 * Scan the connectors attached to the fb_helper and try to put together a
2806 * setup after notification of a change in output configuration.
2808 * Called at runtime, takes the mode config locks to be able to check/change the
2809 * modeset configuration. Must be run from process context (which usually means
2810 * either the output polling work or a work item launched from the driver's
2811 * hotplug interrupt).
2813 * Note that drivers may call this even before calling
2814 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2815 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2816 * not miss any hotplug events.
2819 * 0 on success and a non-zero error code otherwise.
2821 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2825 if (!drm_fbdev_emulation || !fb_helper)
2828 mutex_lock(&fb_helper->lock);
2829 if (fb_helper->deferred_setup) {
2830 err = __drm_fb_helper_initial_config_and_unlock(fb_helper,
2831 fb_helper->preferred_bpp);
2835 if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2836 fb_helper->delayed_hotplug = true;
2837 mutex_unlock(&fb_helper->lock);
2841 DRM_DEBUG_KMS("\n");
2843 drm_setup_crtcs(fb_helper, fb_helper->fb->width, fb_helper->fb->height);
2844 drm_setup_crtcs_fb(fb_helper);
2845 mutex_unlock(&fb_helper->lock);
2847 drm_fb_helper_set_par(fb_helper->fbdev);
2851 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2854 * drm_fb_helper_fbdev_setup() - Setup fbdev emulation
2856 * @fb_helper: fbdev helper structure to set up
2857 * @funcs: fbdev helper functions
2858 * @preferred_bpp: Preferred bits per pixel for the device.
2859 * @dev->mode_config.preferred_depth is used if this is zero.
2860 * @max_conn_count: Maximum number of connectors.
2861 * @dev->mode_config.num_connector is used if this is zero.
2863 * This function sets up fbdev emulation and registers fbdev for access by
2864 * userspace. If all connectors are disconnected, setup is deferred to the next
2865 * time drm_fb_helper_hotplug_event() is called.
2866 * The caller must to provide a &drm_fb_helper_funcs->fb_probe callback
2869 * Use drm_fb_helper_fbdev_teardown() to destroy the fbdev.
2871 * See also: drm_fb_helper_initial_config(), drm_fbdev_generic_setup().
2874 * Zero on success or negative error code on failure.
2876 int drm_fb_helper_fbdev_setup(struct drm_device *dev,
2877 struct drm_fb_helper *fb_helper,
2878 const struct drm_fb_helper_funcs *funcs,
2879 unsigned int preferred_bpp,
2880 unsigned int max_conn_count)
2885 preferred_bpp = dev->mode_config.preferred_depth;
2889 if (!max_conn_count)
2890 max_conn_count = dev->mode_config.num_connector;
2891 if (!max_conn_count) {
2892 DRM_DEV_ERROR(dev->dev, "fbdev: No connectors\n");
2896 drm_fb_helper_prepare(dev, fb_helper, funcs);
2898 ret = drm_fb_helper_init(dev, fb_helper, max_conn_count);
2900 DRM_DEV_ERROR(dev->dev, "fbdev: Failed to initialize (ret=%d)\n", ret);
2904 ret = drm_fb_helper_single_add_all_connectors(fb_helper);
2906 DRM_DEV_ERROR(dev->dev, "fbdev: Failed to add connectors (ret=%d)\n", ret);
2907 goto err_drm_fb_helper_fini;
2910 if (!drm_drv_uses_atomic_modeset(dev))
2911 drm_helper_disable_unused_functions(dev);
2913 ret = drm_fb_helper_initial_config(fb_helper, preferred_bpp);
2915 DRM_DEV_ERROR(dev->dev, "fbdev: Failed to set configuration (ret=%d)\n", ret);
2916 goto err_drm_fb_helper_fini;
2921 err_drm_fb_helper_fini:
2922 drm_fb_helper_fbdev_teardown(dev);
2926 EXPORT_SYMBOL(drm_fb_helper_fbdev_setup);
2929 * drm_fb_helper_fbdev_teardown - Tear down fbdev emulation
2932 * This function unregisters fbdev if not already done and cleans up the
2933 * associated resources including the &drm_framebuffer.
2934 * The driver is responsible for freeing the &drm_fb_helper structure which is
2935 * stored in &drm_device->fb_helper. Do note that this pointer has been cleared
2936 * when this function returns.
2938 * In order to support device removal/unplug while file handles are still open,
2939 * drm_fb_helper_unregister_fbi() should be called on device removal and
2940 * drm_fb_helper_fbdev_teardown() in the &drm_driver->release callback when
2941 * file handles are closed.
2943 void drm_fb_helper_fbdev_teardown(struct drm_device *dev)
2945 struct drm_fb_helper *fb_helper = dev->fb_helper;
2946 struct fb_ops *fbops = NULL;
2951 /* Unregister if it hasn't been done already */
2952 if (fb_helper->fbdev && fb_helper->fbdev->dev)
2953 drm_fb_helper_unregister_fbi(fb_helper);
2955 if (fb_helper->fbdev && fb_helper->fbdev->fbdefio) {
2956 fb_deferred_io_cleanup(fb_helper->fbdev);
2957 kfree(fb_helper->fbdev->fbdefio);
2958 fbops = fb_helper->fbdev->fbops;
2961 drm_fb_helper_fini(fb_helper);
2965 drm_framebuffer_remove(fb_helper->fb);
2967 EXPORT_SYMBOL(drm_fb_helper_fbdev_teardown);
2970 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
2973 * This function can be used as the &drm_driver->lastclose callback for drivers
2974 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
2976 void drm_fb_helper_lastclose(struct drm_device *dev)
2978 drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper);
2980 EXPORT_SYMBOL(drm_fb_helper_lastclose);
2983 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
2984 * helper for fbdev emulation
2987 * This function can be used as the
2988 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
2989 * need to call drm_fb_helper_hotplug_event().
2991 void drm_fb_helper_output_poll_changed(struct drm_device *dev)
2993 drm_fb_helper_hotplug_event(dev->fb_helper);
2995 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed);
2997 /* @user: 1=userspace, 0=fbcon */
2998 static int drm_fbdev_fb_open(struct fb_info *info, int user)
3000 struct drm_fb_helper *fb_helper = info->par;
3002 if (!try_module_get(fb_helper->dev->driver->fops->owner))
3008 static int drm_fbdev_fb_release(struct fb_info *info, int user)
3010 struct drm_fb_helper *fb_helper = info->par;
3012 module_put(fb_helper->dev->driver->fops->owner);
3017 static void drm_fbdev_cleanup(struct drm_fb_helper *fb_helper)
3019 struct fb_info *fbi = fb_helper->fbdev;
3020 struct fb_ops *fbops = NULL;
3021 void *shadow = NULL;
3023 if (!fb_helper->dev)
3026 if (fbi && fbi->fbdefio) {
3027 fb_deferred_io_cleanup(fbi);
3028 shadow = fbi->screen_buffer;
3032 drm_fb_helper_fini(fb_helper);
3039 drm_client_framebuffer_delete(fb_helper->buffer);
3042 static void drm_fbdev_release(struct drm_fb_helper *fb_helper)
3044 drm_fbdev_cleanup(fb_helper);
3048 * Remove conditional when all CMA drivers have been moved over to using
3049 * drm_fbdev_generic_setup().
3051 if (fb_helper->client.funcs) {
3052 drm_client_release(&fb_helper->client);
3058 * fb_ops.fb_destroy is called by the last put_fb_info() call at the end of
3059 * unregister_framebuffer() or fb_release().
3061 static void drm_fbdev_fb_destroy(struct fb_info *info)
3063 drm_fbdev_release(info->par);
3066 static int drm_fbdev_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
3068 struct drm_fb_helper *fb_helper = info->par;
3070 if (fb_helper->dev->driver->gem_prime_mmap)
3071 return fb_helper->dev->driver->gem_prime_mmap(fb_helper->buffer->gem, vma);
3076 static struct fb_ops drm_fbdev_fb_ops = {
3077 .owner = THIS_MODULE,
3078 DRM_FB_HELPER_DEFAULT_OPS,
3079 .fb_open = drm_fbdev_fb_open,
3080 .fb_release = drm_fbdev_fb_release,
3081 .fb_destroy = drm_fbdev_fb_destroy,
3082 .fb_mmap = drm_fbdev_fb_mmap,
3083 .fb_read = drm_fb_helper_sys_read,
3084 .fb_write = drm_fb_helper_sys_write,
3085 .fb_fillrect = drm_fb_helper_sys_fillrect,
3086 .fb_copyarea = drm_fb_helper_sys_copyarea,
3087 .fb_imageblit = drm_fb_helper_sys_imageblit,
3090 static struct fb_deferred_io drm_fbdev_defio = {
3092 .deferred_io = drm_fb_helper_deferred_io,
3096 * drm_fb_helper_generic_probe - Generic fbdev emulation probe helper
3097 * @fb_helper: fbdev helper structure
3098 * @sizes: describes fbdev size and scanout surface size
3100 * This function uses the client API to create a framebuffer backed by a dumb buffer.
3102 * The _sys_ versions are used for &fb_ops.fb_read, fb_write, fb_fillrect,
3103 * fb_copyarea, fb_imageblit.
3106 * Zero on success or negative error code on failure.
3108 int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
3109 struct drm_fb_helper_surface_size *sizes)
3111 struct drm_client_dev *client = &fb_helper->client;
3112 struct drm_client_buffer *buffer;
3113 struct drm_framebuffer *fb;
3114 struct fb_info *fbi;
3117 DRM_DEBUG_KMS("surface width(%d), height(%d) and bpp(%d)\n",
3118 sizes->surface_width, sizes->surface_height,
3119 sizes->surface_bpp);
3121 format = drm_mode_legacy_fb_format(sizes->surface_bpp, sizes->surface_depth);
3122 buffer = drm_client_framebuffer_create(client, sizes->surface_width,
3123 sizes->surface_height, format);
3125 return PTR_ERR(buffer);
3127 fb_helper->buffer = buffer;
3128 fb_helper->fb = buffer->fb;
3131 fbi = drm_fb_helper_alloc_fbi(fb_helper);
3133 return PTR_ERR(fbi);
3135 fbi->par = fb_helper;
3136 fbi->fbops = &drm_fbdev_fb_ops;
3137 fbi->screen_size = fb->height * fb->pitches[0];
3138 fbi->fix.smem_len = fbi->screen_size;
3139 fbi->screen_buffer = buffer->vaddr;
3140 /* Shamelessly leak the physical address to user-space */
3141 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
3142 if (drm_leak_fbdev_smem && fbi->fix.smem_start == 0)
3143 fbi->fix.smem_start =
3144 page_to_phys(virt_to_page(fbi->screen_buffer));
3146 strcpy(fbi->fix.id, "DRM emulated");
3148 drm_fb_helper_fill_fix(fbi, fb->pitches[0], fb->format->depth);
3149 drm_fb_helper_fill_var(fbi, fb_helper, sizes->fb_width, sizes->fb_height);
3151 if (fb->funcs->dirty) {
3152 struct fb_ops *fbops;
3156 * fb_deferred_io_cleanup() clears &fbops->fb_mmap so a per
3157 * instance version is necessary.
3159 fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
3160 shadow = vzalloc(fbi->screen_size);
3161 if (!fbops || !shadow) {
3167 *fbops = *fbi->fbops;
3169 fbi->screen_buffer = shadow;
3170 fbi->fbdefio = &drm_fbdev_defio;
3172 fb_deferred_io_init(fbi);
3177 EXPORT_SYMBOL(drm_fb_helper_generic_probe);
3179 static const struct drm_fb_helper_funcs drm_fb_helper_generic_funcs = {
3180 .fb_probe = drm_fb_helper_generic_probe,
3183 static void drm_fbdev_client_unregister(struct drm_client_dev *client)
3185 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
3187 if (fb_helper->fbdev)
3188 /* drm_fbdev_fb_destroy() takes care of cleanup */
3189 drm_fb_helper_unregister_fbi(fb_helper);
3191 drm_fbdev_release(fb_helper);
3194 static int drm_fbdev_client_restore(struct drm_client_dev *client)
3196 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
3198 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
3203 static int drm_fbdev_client_hotplug(struct drm_client_dev *client)
3205 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
3206 struct drm_device *dev = client->dev;
3209 /* Setup is not retried if it has failed */
3210 if (!fb_helper->dev && fb_helper->funcs)
3214 return drm_fb_helper_hotplug_event(dev->fb_helper);
3216 if (!dev->mode_config.num_connector) {
3217 DRM_DEV_DEBUG(dev->dev, "No connectors found, will not create framebuffer!\n");
3221 drm_fb_helper_prepare(dev, fb_helper, &drm_fb_helper_generic_funcs);
3223 ret = drm_fb_helper_init(dev, fb_helper, dev->mode_config.num_connector);
3227 ret = drm_fb_helper_single_add_all_connectors(fb_helper);
3231 if (!drm_drv_uses_atomic_modeset(dev))
3232 drm_helper_disable_unused_functions(dev);
3234 ret = drm_fb_helper_initial_config(fb_helper, fb_helper->preferred_bpp);
3241 drm_fbdev_cleanup(fb_helper);
3243 fb_helper->dev = NULL;
3244 fb_helper->fbdev = NULL;
3246 DRM_DEV_ERROR(dev->dev, "fbdev: Failed to setup generic emulation (ret=%d)\n", ret);
3251 static const struct drm_client_funcs drm_fbdev_client_funcs = {
3252 .owner = THIS_MODULE,
3253 .unregister = drm_fbdev_client_unregister,
3254 .restore = drm_fbdev_client_restore,
3255 .hotplug = drm_fbdev_client_hotplug,
3259 * drm_fbdev_generic_setup() - Setup generic fbdev emulation
3261 * @preferred_bpp: Preferred bits per pixel for the device.
3262 * @dev->mode_config.preferred_depth is used if this is zero.
3264 * This function sets up generic fbdev emulation for drivers that supports
3265 * dumb buffers with a virtual address and that can be mmap'ed. If the driver
3266 * does not support these functions, it could use drm_fb_helper_fbdev_setup().
3268 * Restore, hotplug events and teardown are all taken care of. Drivers that do
3269 * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves.
3270 * Simple drivers might use drm_mode_config_helper_suspend().
3272 * Drivers that set the dirty callback on their framebuffer will get a shadow
3273 * fbdev buffer that is blitted onto the real buffer. This is done in order to
3274 * make deferred I/O work with all kinds of buffers.
3276 * This function is safe to call even when there are no connectors present.
3277 * Setup will be retried on the next hotplug event.
3279 * The fbdev is destroyed by drm_dev_unregister().
3282 * Zero on success or negative error code on failure.
3284 int drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)
3286 struct drm_fb_helper *fb_helper;
3289 WARN(dev->fb_helper, "fb_helper is already set!\n");
3291 if (!drm_fbdev_emulation)
3294 fb_helper = kzalloc(sizeof(*fb_helper), GFP_KERNEL);
3298 ret = drm_client_init(dev, &fb_helper->client, "fbdev", &drm_fbdev_client_funcs);
3301 DRM_DEV_ERROR(dev->dev, "Failed to register client: %d\n", ret);
3305 drm_client_add(&fb_helper->client);
3308 preferred_bpp = dev->mode_config.preferred_depth;
3311 fb_helper->preferred_bpp = preferred_bpp;
3313 ret = drm_fbdev_client_hotplug(&fb_helper->client);
3315 DRM_DEV_DEBUG(dev->dev, "client hotplug ret=%d\n", ret);
3319 EXPORT_SYMBOL(drm_fbdev_generic_setup);
3321 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
3322 * but the module doesn't depend on any fb console symbols. At least
3323 * attempt to load fbcon to avoid leaving the system without a usable console.
3325 int __init drm_fb_helper_modinit(void)
3327 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
3328 const char name[] = "fbcon";
3329 struct module *fbcon;
3331 mutex_lock(&module_mutex);
3332 fbcon = find_module(name);
3333 mutex_unlock(&module_mutex);
3336 request_module_nowait(name);
3340 EXPORT_SYMBOL(drm_fb_helper_modinit);