2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
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
30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32 #include <linux/console.h>
33 #include <linux/kernel.h>
34 #include <linux/sysrq.h>
35 #include <linux/slab.h>
36 #include <linux/module.h>
38 #include <drm/drm_crtc.h>
39 #include <drm/drm_fb_helper.h>
40 #include <drm/drm_crtc_helper.h>
41 #include <drm/drm_atomic.h>
42 #include <drm/drm_atomic_helper.h>
44 #include "drm_crtc_internal.h"
45 #include "drm_crtc_helper_internal.h"
47 static bool drm_fbdev_emulation = true;
48 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
49 MODULE_PARM_DESC(fbdev_emulation,
50 "Enable legacy fbdev emulation [default=true]");
52 static int drm_fbdev_overalloc = CONFIG_DRM_FBDEV_OVERALLOC;
53 module_param(drm_fbdev_overalloc, int, 0444);
54 MODULE_PARM_DESC(drm_fbdev_overalloc,
55 "Overallocation of the fbdev buffer (%) [default="
56 __MODULE_STRING(CONFIG_DRM_FBDEV_OVERALLOC) "]");
58 static LIST_HEAD(kernel_fb_helper_list);
59 static DEFINE_MUTEX(kernel_fb_helper_lock);
64 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
65 * mode setting driver. They can be used mostly independently from the crtc
66 * helper functions used by many drivers to implement the kernel mode setting
69 * Setup fbdev emulation by calling drm_fb_helper_fbdev_setup() and tear it
70 * down by calling drm_fb_helper_fbdev_teardown().
72 * Drivers that need to handle connector hotplugging (e.g. dp mst) can't use
73 * the setup helper and will need to do the whole four-step setup process with
74 * drm_fb_helper_prepare(), drm_fb_helper_init(),
75 * drm_fb_helper_single_add_all_connectors(), enable hotplugging and
76 * drm_fb_helper_initial_config() to avoid a possible race window.
78 * At runtime drivers should restore the fbdev console by using
79 * drm_fb_helper_lastclose() as their &drm_driver.lastclose callback.
80 * They should also notify the fb helper code from updates to the output
81 * configuration by using drm_fb_helper_output_poll_changed() as their
82 * &drm_mode_config_funcs.output_poll_changed callback.
84 * For suspend/resume consider using drm_mode_config_helper_suspend() and
85 * drm_mode_config_helper_resume() which takes care of fbdev as well.
87 * All other functions exported by the fb helper library can be used to
88 * implement the fbdev driver interface by the driver.
90 * It is possible, though perhaps somewhat tricky, to implement race-free
91 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
92 * helper must be called first to initialize the minimum required to make
93 * hotplug detection work. Drivers also need to make sure to properly set up
94 * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init()
95 * it is safe to enable interrupts and start processing hotplug events. At the
96 * same time, drivers should initialize all modeset objects such as CRTCs,
97 * encoders and connectors. To finish up the fbdev helper initialization, the
98 * drm_fb_helper_init() function is called. To probe for all attached displays
99 * and set up an initial configuration using the detected hardware, drivers
100 * should call drm_fb_helper_single_add_all_connectors() followed by
101 * drm_fb_helper_initial_config().
103 * If &drm_framebuffer_funcs.dirty is set, the
104 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
105 * accumulate changes and schedule &drm_fb_helper.dirty_work to run right
106 * away. This worker then calls the dirty() function ensuring that it will
107 * always run in process context since the fb_*() function could be running in
108 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
109 * callback it will also schedule dirty_work with the damage collected from the
110 * mmap page writes. Drivers can use drm_fb_helper_defio_init() to setup
111 * deferred I/O (coupled with drm_fb_helper_fbdev_teardown()).
114 #define drm_fb_helper_for_each_connector(fbh, i__) \
115 for (({ lockdep_assert_held(&(fbh)->lock); }), \
116 i__ = 0; i__ < (fbh)->connector_count; i__++)
118 static int __drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
119 struct drm_connector *connector)
121 struct drm_fb_helper_connector *fb_conn;
122 struct drm_fb_helper_connector **temp;
125 if (!drm_fbdev_emulation)
128 lockdep_assert_held(&fb_helper->lock);
130 count = fb_helper->connector_count + 1;
132 if (count > fb_helper->connector_info_alloc_count) {
133 size_t size = count * sizeof(fb_conn);
135 temp = krealloc(fb_helper->connector_info, size, GFP_KERNEL);
139 fb_helper->connector_info_alloc_count = count;
140 fb_helper->connector_info = temp;
143 fb_conn = kzalloc(sizeof(*fb_conn), GFP_KERNEL);
147 drm_connector_get(connector);
148 fb_conn->connector = connector;
149 fb_helper->connector_info[fb_helper->connector_count++] = fb_conn;
154 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
155 struct drm_connector *connector)
162 mutex_lock(&fb_helper->lock);
163 err = __drm_fb_helper_add_one_connector(fb_helper, connector);
164 mutex_unlock(&fb_helper->lock);
168 EXPORT_SYMBOL(drm_fb_helper_add_one_connector);
171 * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
173 * @fb_helper: fbdev initialized with drm_fb_helper_init, can be NULL
175 * This functions adds all the available connectors for use with the given
176 * fb_helper. This is a separate step to allow drivers to freely assign
177 * connectors to the fbdev, e.g. if some are reserved for special purposes or
178 * not adequate to be used for the fbcon.
180 * This function is protected against concurrent connector hotadds/removals
181 * using drm_fb_helper_add_one_connector() and
182 * drm_fb_helper_remove_one_connector().
184 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
186 struct drm_device *dev;
187 struct drm_connector *connector;
188 struct drm_connector_list_iter conn_iter;
191 if (!drm_fbdev_emulation || !fb_helper)
194 dev = fb_helper->dev;
196 mutex_lock(&fb_helper->lock);
197 drm_connector_list_iter_begin(dev, &conn_iter);
198 drm_for_each_connector_iter(connector, &conn_iter) {
199 ret = __drm_fb_helper_add_one_connector(fb_helper, connector);
206 drm_fb_helper_for_each_connector(fb_helper, i) {
207 struct drm_fb_helper_connector *fb_helper_connector =
208 fb_helper->connector_info[i];
210 drm_connector_put(fb_helper_connector->connector);
212 kfree(fb_helper_connector);
213 fb_helper->connector_info[i] = NULL;
215 fb_helper->connector_count = 0;
217 drm_connector_list_iter_end(&conn_iter);
218 mutex_unlock(&fb_helper->lock);
222 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
224 static int __drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
225 struct drm_connector *connector)
227 struct drm_fb_helper_connector *fb_helper_connector;
230 if (!drm_fbdev_emulation)
233 lockdep_assert_held(&fb_helper->lock);
235 drm_fb_helper_for_each_connector(fb_helper, i) {
236 if (fb_helper->connector_info[i]->connector == connector)
240 if (i == fb_helper->connector_count)
242 fb_helper_connector = fb_helper->connector_info[i];
243 drm_connector_put(fb_helper_connector->connector);
245 for (j = i + 1; j < fb_helper->connector_count; j++)
246 fb_helper->connector_info[j - 1] = fb_helper->connector_info[j];
248 fb_helper->connector_count--;
249 kfree(fb_helper_connector);
254 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
255 struct drm_connector *connector)
262 mutex_lock(&fb_helper->lock);
263 err = __drm_fb_helper_remove_one_connector(fb_helper, connector);
264 mutex_unlock(&fb_helper->lock);
268 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector);
270 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
272 uint16_t *r_base, *g_base, *b_base;
274 if (crtc->funcs->gamma_set == NULL)
277 r_base = crtc->gamma_store;
278 g_base = r_base + crtc->gamma_size;
279 b_base = g_base + crtc->gamma_size;
281 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base,
282 crtc->gamma_size, NULL);
286 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
287 * @info: fbdev registered by the helper
289 int drm_fb_helper_debug_enter(struct fb_info *info)
291 struct drm_fb_helper *helper = info->par;
292 const struct drm_crtc_helper_funcs *funcs;
295 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
296 for (i = 0; i < helper->crtc_count; i++) {
297 struct drm_mode_set *mode_set =
298 &helper->crtc_info[i].mode_set;
300 if (!mode_set->crtc->enabled)
303 funcs = mode_set->crtc->helper_private;
304 if (funcs->mode_set_base_atomic == NULL)
307 if (drm_drv_uses_atomic_modeset(mode_set->crtc->dev))
310 funcs->mode_set_base_atomic(mode_set->crtc,
314 ENTER_ATOMIC_MODE_SET);
320 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
323 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
324 * @info: fbdev registered by the helper
326 int drm_fb_helper_debug_leave(struct fb_info *info)
328 struct drm_fb_helper *helper = info->par;
329 struct drm_crtc *crtc;
330 const struct drm_crtc_helper_funcs *funcs;
331 struct drm_framebuffer *fb;
334 for (i = 0; i < helper->crtc_count; i++) {
335 struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
337 crtc = mode_set->crtc;
338 if (drm_drv_uses_atomic_modeset(crtc->dev))
341 funcs = crtc->helper_private;
342 fb = crtc->primary->fb;
348 DRM_ERROR("no fb to restore??\n");
352 if (funcs->mode_set_base_atomic == NULL)
355 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
356 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
357 crtc->y, LEAVE_ATOMIC_MODE_SET);
362 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
364 static int restore_fbdev_mode_atomic(struct drm_fb_helper *fb_helper, bool active)
366 struct drm_device *dev = fb_helper->dev;
367 struct drm_plane_state *plane_state;
368 struct drm_plane *plane;
369 struct drm_atomic_state *state;
371 unsigned int plane_mask;
372 struct drm_modeset_acquire_ctx ctx;
374 drm_modeset_acquire_init(&ctx, 0);
376 state = drm_atomic_state_alloc(dev);
382 state->acquire_ctx = &ctx;
385 drm_for_each_plane(plane, dev) {
386 plane_state = drm_atomic_get_plane_state(state, plane);
387 if (IS_ERR(plane_state)) {
388 ret = PTR_ERR(plane_state);
392 plane_state->rotation = DRM_MODE_ROTATE_0;
394 plane->old_fb = plane->fb;
395 plane_mask |= 1 << drm_plane_index(plane);
397 /* disable non-primary: */
398 if (plane->type == DRM_PLANE_TYPE_PRIMARY)
401 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
406 for (i = 0; i < fb_helper->crtc_count; i++) {
407 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
408 struct drm_plane *primary = mode_set->crtc->primary;
410 /* Cannot fail as we've already gotten the plane state above */
411 plane_state = drm_atomic_get_new_plane_state(state, primary);
412 plane_state->rotation = fb_helper->crtc_info[i].rotation;
414 ret = __drm_atomic_helper_set_config(mode_set, state);
419 * __drm_atomic_helper_set_config() sets active when a
420 * mode is set, unconditionally clear it if we force DPMS off
423 struct drm_crtc *crtc = mode_set->crtc;
424 struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
426 crtc_state->active = false;
430 ret = drm_atomic_commit(state);
433 drm_atomic_clean_old_fb(dev, plane_mask, ret);
438 drm_atomic_state_put(state);
440 drm_modeset_drop_locks(&ctx);
441 drm_modeset_acquire_fini(&ctx);
446 drm_atomic_state_clear(state);
447 drm_modeset_backoff(&ctx);
452 static int restore_fbdev_mode_legacy(struct drm_fb_helper *fb_helper)
454 struct drm_device *dev = fb_helper->dev;
455 struct drm_plane *plane;
458 drm_modeset_lock_all(fb_helper->dev);
459 drm_for_each_plane(plane, dev) {
460 if (plane->type != DRM_PLANE_TYPE_PRIMARY)
461 drm_plane_force_disable(plane);
463 if (plane->rotation_property)
464 drm_mode_plane_set_obj_prop(plane,
465 plane->rotation_property,
469 for (i = 0; i < fb_helper->crtc_count; i++) {
470 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
471 struct drm_crtc *crtc = mode_set->crtc;
473 if (crtc->funcs->cursor_set2) {
474 ret = crtc->funcs->cursor_set2(crtc, NULL, 0, 0, 0, 0, 0);
477 } else if (crtc->funcs->cursor_set) {
478 ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
483 ret = drm_mode_set_config_internal(mode_set);
488 drm_modeset_unlock_all(fb_helper->dev);
493 static int restore_fbdev_mode(struct drm_fb_helper *fb_helper)
495 struct drm_device *dev = fb_helper->dev;
497 if (drm_drv_uses_atomic_modeset(dev))
498 return restore_fbdev_mode_atomic(fb_helper, true);
500 return restore_fbdev_mode_legacy(fb_helper);
504 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
505 * @fb_helper: driver-allocated fbdev helper, can be NULL
507 * This should be called from driver's drm &drm_driver.lastclose callback
508 * when implementing an fbcon on top of kms using this helper. This ensures that
509 * the user isn't greeted with a black screen when e.g. X dies.
512 * Zero if everything went ok, negative error code otherwise.
514 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
519 if (!drm_fbdev_emulation || !fb_helper)
522 if (READ_ONCE(fb_helper->deferred_setup))
525 mutex_lock(&fb_helper->lock);
526 ret = restore_fbdev_mode(fb_helper);
528 do_delayed = fb_helper->delayed_hotplug;
530 fb_helper->delayed_hotplug = false;
531 mutex_unlock(&fb_helper->lock);
534 drm_fb_helper_hotplug_event(fb_helper);
538 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
540 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
542 struct drm_device *dev = fb_helper->dev;
543 struct drm_crtc *crtc;
544 int bound = 0, crtcs_bound = 0;
547 * Sometimes user space wants everything disabled, so don't steal the
548 * display if there's a master.
550 if (READ_ONCE(dev->master))
553 drm_for_each_crtc(crtc, dev) {
554 drm_modeset_lock(&crtc->mutex, NULL);
555 if (crtc->primary->fb)
557 if (crtc->primary->fb == fb_helper->fb)
559 drm_modeset_unlock(&crtc->mutex);
562 if (bound < crtcs_bound)
568 #ifdef CONFIG_MAGIC_SYSRQ
570 * restore fbcon display for all kms driver's using this helper, used for sysrq
571 * and panic handling.
573 static bool drm_fb_helper_force_kernel_mode(void)
575 bool ret, error = false;
576 struct drm_fb_helper *helper;
578 if (list_empty(&kernel_fb_helper_list))
581 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
582 struct drm_device *dev = helper->dev;
584 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
587 mutex_lock(&helper->lock);
588 ret = restore_fbdev_mode(helper);
591 mutex_unlock(&helper->lock);
596 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
600 ret = drm_fb_helper_force_kernel_mode();
602 DRM_ERROR("Failed to restore crtc configuration\n");
604 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
606 static void drm_fb_helper_sysrq(int dummy1)
608 schedule_work(&drm_fb_helper_restore_work);
611 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
612 .handler = drm_fb_helper_sysrq,
613 .help_msg = "force-fb(V)",
614 .action_msg = "Restore framebuffer console",
617 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
620 static void dpms_legacy(struct drm_fb_helper *fb_helper, int dpms_mode)
622 struct drm_device *dev = fb_helper->dev;
623 struct drm_crtc *crtc;
624 struct drm_connector *connector;
627 drm_modeset_lock_all(dev);
628 for (i = 0; i < fb_helper->crtc_count; i++) {
629 crtc = fb_helper->crtc_info[i].mode_set.crtc;
634 /* Walk the connectors & encoders on this fb turning them on/off */
635 drm_fb_helper_for_each_connector(fb_helper, j) {
636 connector = fb_helper->connector_info[j]->connector;
637 connector->funcs->dpms(connector, dpms_mode);
638 drm_object_property_set_value(&connector->base,
639 dev->mode_config.dpms_property, dpms_mode);
642 drm_modeset_unlock_all(dev);
645 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
647 struct drm_fb_helper *fb_helper = info->par;
650 * For each CRTC in this fb, turn the connectors on/off.
652 mutex_lock(&fb_helper->lock);
653 if (!drm_fb_helper_is_bound(fb_helper)) {
654 mutex_unlock(&fb_helper->lock);
658 if (drm_drv_uses_atomic_modeset(fb_helper->dev))
659 restore_fbdev_mode_atomic(fb_helper, dpms_mode == DRM_MODE_DPMS_ON);
661 dpms_legacy(fb_helper, dpms_mode);
662 mutex_unlock(&fb_helper->lock);
666 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
667 * @blank: desired blanking state
668 * @info: fbdev registered by the helper
670 int drm_fb_helper_blank(int blank, struct fb_info *info)
672 if (oops_in_progress)
676 /* Display: On; HSync: On, VSync: On */
677 case FB_BLANK_UNBLANK:
678 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
680 /* Display: Off; HSync: On, VSync: On */
681 case FB_BLANK_NORMAL:
682 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
684 /* Display: Off; HSync: Off, VSync: On */
685 case FB_BLANK_HSYNC_SUSPEND:
686 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
688 /* Display: Off; HSync: On, VSync: Off */
689 case FB_BLANK_VSYNC_SUSPEND:
690 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
692 /* Display: Off; HSync: Off, VSync: Off */
693 case FB_BLANK_POWERDOWN:
694 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
699 EXPORT_SYMBOL(drm_fb_helper_blank);
701 static void drm_fb_helper_modeset_release(struct drm_fb_helper *helper,
702 struct drm_mode_set *modeset)
706 for (i = 0; i < modeset->num_connectors; i++) {
707 drm_connector_put(modeset->connectors[i]);
708 modeset->connectors[i] = NULL;
710 modeset->num_connectors = 0;
712 drm_mode_destroy(helper->dev, modeset->mode);
713 modeset->mode = NULL;
715 /* FIXME should hold a ref? */
719 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
723 for (i = 0; i < helper->connector_count; i++) {
724 drm_connector_put(helper->connector_info[i]->connector);
725 kfree(helper->connector_info[i]);
727 kfree(helper->connector_info);
729 for (i = 0; i < helper->crtc_count; i++) {
730 struct drm_mode_set *modeset = &helper->crtc_info[i].mode_set;
732 drm_fb_helper_modeset_release(helper, modeset);
733 kfree(modeset->connectors);
735 kfree(helper->crtc_info);
738 static void drm_fb_helper_resume_worker(struct work_struct *work)
740 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
744 fb_set_suspend(helper->fbdev, 0);
748 static void drm_fb_helper_dirty_work(struct work_struct *work)
750 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
752 struct drm_clip_rect *clip = &helper->dirty_clip;
753 struct drm_clip_rect clip_copy;
756 spin_lock_irqsave(&helper->dirty_lock, flags);
758 clip->x1 = clip->y1 = ~0;
759 clip->x2 = clip->y2 = 0;
760 spin_unlock_irqrestore(&helper->dirty_lock, flags);
762 /* call dirty callback only when it has been really touched */
763 if (clip_copy.x1 < clip_copy.x2 && clip_copy.y1 < clip_copy.y2)
764 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
768 * drm_fb_helper_prepare - setup a drm_fb_helper structure
770 * @helper: driver-allocated fbdev helper structure to set up
771 * @funcs: pointer to structure of functions associate with this helper
773 * Sets up the bare minimum to make the framebuffer helper usable. This is
774 * useful to implement race-free initialization of the polling helpers.
776 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
777 const struct drm_fb_helper_funcs *funcs)
779 INIT_LIST_HEAD(&helper->kernel_fb_list);
780 spin_lock_init(&helper->dirty_lock);
781 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
782 INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
783 helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
784 mutex_init(&helper->lock);
785 helper->funcs = funcs;
788 EXPORT_SYMBOL(drm_fb_helper_prepare);
791 * drm_fb_helper_init - initialize a &struct drm_fb_helper
793 * @fb_helper: driver-allocated fbdev helper structure to initialize
794 * @max_conn_count: max connector count
796 * This allocates the structures for the fbdev helper with the given limits.
797 * Note that this won't yet touch the hardware (through the driver interfaces)
798 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
799 * to allow driver writes more control over the exact init sequence.
801 * Drivers must call drm_fb_helper_prepare() before calling this function.
804 * Zero if everything went ok, nonzero otherwise.
806 int drm_fb_helper_init(struct drm_device *dev,
807 struct drm_fb_helper *fb_helper,
810 struct drm_crtc *crtc;
811 struct drm_mode_config *config = &dev->mode_config;
814 if (!drm_fbdev_emulation) {
815 dev->fb_helper = fb_helper;
822 fb_helper->crtc_info = kcalloc(config->num_crtc, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
823 if (!fb_helper->crtc_info)
826 fb_helper->crtc_count = config->num_crtc;
827 fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
828 if (!fb_helper->connector_info) {
829 kfree(fb_helper->crtc_info);
832 fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
833 fb_helper->connector_count = 0;
835 for (i = 0; i < fb_helper->crtc_count; i++) {
836 fb_helper->crtc_info[i].mode_set.connectors =
837 kcalloc(max_conn_count,
838 sizeof(struct drm_connector *),
841 if (!fb_helper->crtc_info[i].mode_set.connectors)
843 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
844 fb_helper->crtc_info[i].rotation = DRM_MODE_ROTATE_0;
848 drm_for_each_crtc(crtc, dev) {
849 fb_helper->crtc_info[i].mode_set.crtc = crtc;
853 dev->fb_helper = fb_helper;
857 drm_fb_helper_crtc_free(fb_helper);
860 EXPORT_SYMBOL(drm_fb_helper_init);
863 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
864 * @fb_helper: driver-allocated fbdev helper
866 * A helper to alloc fb_info and the members cmap and apertures. Called
867 * by the driver within the fb_probe fb_helper callback function. Drivers do not
868 * need to release the allocated fb_info structure themselves, this is
869 * automatically done when calling drm_fb_helper_fini().
872 * fb_info pointer if things went okay, pointer containing error code
875 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
877 struct device *dev = fb_helper->dev->dev;
878 struct fb_info *info;
881 info = framebuffer_alloc(0, dev);
883 return ERR_PTR(-ENOMEM);
885 ret = fb_alloc_cmap(&info->cmap, 256, 0);
889 info->apertures = alloc_apertures(1);
890 if (!info->apertures) {
895 fb_helper->fbdev = info;
900 fb_dealloc_cmap(&info->cmap);
902 framebuffer_release(info);
905 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
908 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
909 * @fb_helper: driver-allocated fbdev helper, can be NULL
911 * A wrapper around unregister_framebuffer, to release the fb_info
912 * framebuffer device. This must be called before releasing all resources for
913 * @fb_helper by calling drm_fb_helper_fini().
915 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
917 if (fb_helper && fb_helper->fbdev)
918 unregister_framebuffer(fb_helper->fbdev);
920 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
923 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
924 * @fb_helper: driver-allocated fbdev helper, can be NULL
926 * This cleans up all remaining resources associated with @fb_helper. Must be
927 * called after drm_fb_helper_unlink_fbi() was called.
929 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
931 struct fb_info *info;
936 fb_helper->dev->fb_helper = NULL;
938 if (!drm_fbdev_emulation)
941 cancel_work_sync(&fb_helper->resume_work);
942 cancel_work_sync(&fb_helper->dirty_work);
944 info = fb_helper->fbdev;
947 fb_dealloc_cmap(&info->cmap);
948 framebuffer_release(info);
950 fb_helper->fbdev = NULL;
952 mutex_lock(&kernel_fb_helper_lock);
953 if (!list_empty(&fb_helper->kernel_fb_list)) {
954 list_del(&fb_helper->kernel_fb_list);
955 if (list_empty(&kernel_fb_helper_list))
956 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
958 mutex_unlock(&kernel_fb_helper_lock);
960 mutex_destroy(&fb_helper->lock);
961 drm_fb_helper_crtc_free(fb_helper);
964 EXPORT_SYMBOL(drm_fb_helper_fini);
967 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
968 * @fb_helper: driver-allocated fbdev helper, can be NULL
970 * A wrapper around unlink_framebuffer implemented by fbdev core
972 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
974 if (fb_helper && fb_helper->fbdev)
975 unlink_framebuffer(fb_helper->fbdev);
977 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
979 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
980 u32 width, u32 height)
982 struct drm_fb_helper *helper = info->par;
983 struct drm_clip_rect *clip = &helper->dirty_clip;
986 if (!helper->fb->funcs->dirty)
989 spin_lock_irqsave(&helper->dirty_lock, flags);
990 clip->x1 = min_t(u32, clip->x1, x);
991 clip->y1 = min_t(u32, clip->y1, y);
992 clip->x2 = max_t(u32, clip->x2, x + width);
993 clip->y2 = max_t(u32, clip->y2, y + height);
994 spin_unlock_irqrestore(&helper->dirty_lock, flags);
996 schedule_work(&helper->dirty_work);
1000 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
1001 * @info: fb_info struct pointer
1002 * @pagelist: list of dirty mmap framebuffer pages
1004 * This function is used as the &fb_deferred_io.deferred_io
1005 * callback function for flushing the fbdev mmap writes.
1007 void drm_fb_helper_deferred_io(struct fb_info *info,
1008 struct list_head *pagelist)
1010 unsigned long start, end, min, max;
1016 list_for_each_entry(page, pagelist, lru) {
1017 start = page->index << PAGE_SHIFT;
1018 end = start + PAGE_SIZE - 1;
1019 min = min(min, start);
1020 max = max(max, end);
1024 y1 = min / info->fix.line_length;
1025 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
1027 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
1030 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
1033 * drm_fb_helper_defio_init - fbdev deferred I/O initialization
1034 * @fb_helper: driver-allocated fbdev helper
1036 * This function allocates &fb_deferred_io, sets callback to
1037 * drm_fb_helper_deferred_io(), delay to 50ms and calls fb_deferred_io_init().
1038 * It should be called from the &drm_fb_helper_funcs->fb_probe callback.
1039 * drm_fb_helper_fbdev_teardown() cleans up deferred I/O.
1041 * NOTE: A copy of &fb_ops is made and assigned to &info->fbops. This is done
1042 * because fb_deferred_io_cleanup() clears &fbops->fb_mmap and would thereby
1043 * affect other instances of that &fb_ops.
1046 * 0 on success or a negative error code on failure.
1048 int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
1050 struct fb_info *info = fb_helper->fbdev;
1051 struct fb_deferred_io *fbdefio;
1052 struct fb_ops *fbops;
1054 fbdefio = kzalloc(sizeof(*fbdefio), GFP_KERNEL);
1055 fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
1056 if (!fbdefio || !fbops) {
1062 info->fbdefio = fbdefio;
1063 fbdefio->delay = msecs_to_jiffies(50);
1064 fbdefio->deferred_io = drm_fb_helper_deferred_io;
1066 *fbops = *info->fbops;
1067 info->fbops = fbops;
1069 fb_deferred_io_init(info);
1073 EXPORT_SYMBOL(drm_fb_helper_defio_init);
1076 * drm_fb_helper_sys_read - wrapper around fb_sys_read
1077 * @info: fb_info struct pointer
1078 * @buf: userspace buffer to read from framebuffer memory
1079 * @count: number of bytes to read from framebuffer memory
1080 * @ppos: read offset within framebuffer memory
1082 * A wrapper around fb_sys_read implemented by fbdev core
1084 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
1085 size_t count, loff_t *ppos)
1087 return fb_sys_read(info, buf, count, ppos);
1089 EXPORT_SYMBOL(drm_fb_helper_sys_read);
1092 * drm_fb_helper_sys_write - wrapper around fb_sys_write
1093 * @info: fb_info struct pointer
1094 * @buf: userspace buffer to write to framebuffer memory
1095 * @count: number of bytes to write to framebuffer memory
1096 * @ppos: write offset within framebuffer memory
1098 * A wrapper around fb_sys_write implemented by fbdev core
1100 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
1101 size_t count, loff_t *ppos)
1105 ret = fb_sys_write(info, buf, count, ppos);
1107 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
1112 EXPORT_SYMBOL(drm_fb_helper_sys_write);
1115 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
1116 * @info: fbdev registered by the helper
1117 * @rect: info about rectangle to fill
1119 * A wrapper around sys_fillrect implemented by fbdev core
1121 void drm_fb_helper_sys_fillrect(struct fb_info *info,
1122 const struct fb_fillrect *rect)
1124 sys_fillrect(info, rect);
1125 drm_fb_helper_dirty(info, rect->dx, rect->dy,
1126 rect->width, rect->height);
1128 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
1131 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
1132 * @info: fbdev registered by the helper
1133 * @area: info about area to copy
1135 * A wrapper around sys_copyarea implemented by fbdev core
1137 void drm_fb_helper_sys_copyarea(struct fb_info *info,
1138 const struct fb_copyarea *area)
1140 sys_copyarea(info, area);
1141 drm_fb_helper_dirty(info, area->dx, area->dy,
1142 area->width, area->height);
1144 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
1147 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
1148 * @info: fbdev registered by the helper
1149 * @image: info about image to blit
1151 * A wrapper around sys_imageblit implemented by fbdev core
1153 void drm_fb_helper_sys_imageblit(struct fb_info *info,
1154 const struct fb_image *image)
1156 sys_imageblit(info, image);
1157 drm_fb_helper_dirty(info, image->dx, image->dy,
1158 image->width, image->height);
1160 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
1163 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
1164 * @info: fbdev registered by the helper
1165 * @rect: info about rectangle to fill
1167 * A wrapper around cfb_imageblit implemented by fbdev core
1169 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
1170 const struct fb_fillrect *rect)
1172 cfb_fillrect(info, rect);
1173 drm_fb_helper_dirty(info, rect->dx, rect->dy,
1174 rect->width, rect->height);
1176 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
1179 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1180 * @info: fbdev registered by the helper
1181 * @area: info about area to copy
1183 * A wrapper around cfb_copyarea implemented by fbdev core
1185 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1186 const struct fb_copyarea *area)
1188 cfb_copyarea(info, area);
1189 drm_fb_helper_dirty(info, area->dx, area->dy,
1190 area->width, area->height);
1192 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1195 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1196 * @info: fbdev registered by the helper
1197 * @image: info about image to blit
1199 * A wrapper around cfb_imageblit implemented by fbdev core
1201 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1202 const struct fb_image *image)
1204 cfb_imageblit(info, image);
1205 drm_fb_helper_dirty(info, image->dx, image->dy,
1206 image->width, image->height);
1208 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1211 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1212 * @fb_helper: driver-allocated fbdev helper, can be NULL
1213 * @suspend: whether to suspend or resume
1215 * A wrapper around fb_set_suspend implemented by fbdev core.
1216 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1219 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
1221 if (fb_helper && fb_helper->fbdev)
1222 fb_set_suspend(fb_helper->fbdev, suspend);
1224 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1227 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1228 * takes the console lock
1229 * @fb_helper: driver-allocated fbdev helper, can be NULL
1230 * @suspend: whether to suspend or resume
1232 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1233 * isn't available on resume, a worker is tasked with waiting for the lock
1234 * to become available. The console lock can be pretty contented on resume
1235 * due to all the printk activity.
1237 * This function can be called multiple times with the same state since
1238 * &fb_info.state is checked to see if fbdev is running or not before locking.
1240 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1242 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
1245 if (!fb_helper || !fb_helper->fbdev)
1248 /* make sure there's no pending/ongoing resume */
1249 flush_work(&fb_helper->resume_work);
1252 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
1258 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
1261 if (!console_trylock()) {
1262 schedule_work(&fb_helper->resume_work);
1267 fb_set_suspend(fb_helper->fbdev, suspend);
1270 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
1272 static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info)
1274 u32 *palette = (u32 *)info->pseudo_palette;
1277 if (cmap->start + cmap->len > 16)
1280 for (i = 0; i < cmap->len; ++i) {
1281 u16 red = cmap->red[i];
1282 u16 green = cmap->green[i];
1283 u16 blue = cmap->blue[i];
1286 red >>= 16 - info->var.red.length;
1287 green >>= 16 - info->var.green.length;
1288 blue >>= 16 - info->var.blue.length;
1289 value = (red << info->var.red.offset) |
1290 (green << info->var.green.offset) |
1291 (blue << info->var.blue.offset);
1292 if (info->var.transp.length > 0) {
1293 u32 mask = (1 << info->var.transp.length) - 1;
1295 mask <<= info->var.transp.offset;
1298 palette[cmap->start + i] = value;
1304 static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info)
1306 struct drm_fb_helper *fb_helper = info->par;
1307 struct drm_crtc *crtc;
1311 drm_modeset_lock_all(fb_helper->dev);
1312 for (i = 0; i < fb_helper->crtc_count; i++) {
1313 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1314 if (!crtc->funcs->gamma_set || !crtc->gamma_size)
1317 if (cmap->start + cmap->len > crtc->gamma_size)
1320 r = crtc->gamma_store;
1321 g = r + crtc->gamma_size;
1322 b = g + crtc->gamma_size;
1324 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1325 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1326 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1328 ret = crtc->funcs->gamma_set(crtc, r, g, b,
1329 crtc->gamma_size, NULL);
1333 drm_modeset_unlock_all(fb_helper->dev);
1338 static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc,
1339 struct fb_cmap *cmap)
1341 struct drm_device *dev = crtc->dev;
1342 struct drm_property_blob *gamma_lut;
1343 struct drm_color_lut *lut;
1344 int size = crtc->gamma_size;
1347 if (!size || cmap->start + cmap->len > size)
1348 return ERR_PTR(-EINVAL);
1350 gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL);
1351 if (IS_ERR(gamma_lut))
1354 lut = gamma_lut->data;
1355 if (cmap->start || cmap->len != size) {
1356 u16 *r = crtc->gamma_store;
1357 u16 *g = r + crtc->gamma_size;
1358 u16 *b = g + crtc->gamma_size;
1360 for (i = 0; i < cmap->start; i++) {
1362 lut[i].green = g[i];
1365 for (i = cmap->start + cmap->len; i < size; i++) {
1367 lut[i].green = g[i];
1372 for (i = 0; i < cmap->len; i++) {
1373 lut[cmap->start + i].red = cmap->red[i];
1374 lut[cmap->start + i].green = cmap->green[i];
1375 lut[cmap->start + i].blue = cmap->blue[i];
1381 static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info)
1383 struct drm_fb_helper *fb_helper = info->par;
1384 struct drm_device *dev = fb_helper->dev;
1385 struct drm_property_blob *gamma_lut = NULL;
1386 struct drm_modeset_acquire_ctx ctx;
1387 struct drm_crtc_state *crtc_state;
1388 struct drm_atomic_state *state;
1389 struct drm_crtc *crtc;
1394 drm_modeset_acquire_init(&ctx, 0);
1396 state = drm_atomic_state_alloc(dev);
1402 state->acquire_ctx = &ctx;
1404 for (i = 0; i < fb_helper->crtc_count; i++) {
1405 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1408 gamma_lut = setcmap_new_gamma_lut(crtc, cmap);
1409 if (IS_ERR(gamma_lut)) {
1410 ret = PTR_ERR(gamma_lut);
1415 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1416 if (IS_ERR(crtc_state)) {
1417 ret = PTR_ERR(crtc_state);
1421 replaced = drm_property_replace_blob(&crtc_state->degamma_lut,
1423 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
1424 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut,
1426 crtc_state->color_mgmt_changed |= replaced;
1429 ret = drm_atomic_commit(state);
1433 for (i = 0; i < fb_helper->crtc_count; i++) {
1434 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1436 r = crtc->gamma_store;
1437 g = r + crtc->gamma_size;
1438 b = g + crtc->gamma_size;
1440 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1441 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1442 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1446 if (ret == -EDEADLK)
1449 drm_property_blob_put(gamma_lut);
1450 drm_atomic_state_put(state);
1452 drm_modeset_drop_locks(&ctx);
1453 drm_modeset_acquire_fini(&ctx);
1458 drm_atomic_state_clear(state);
1459 drm_modeset_backoff(&ctx);
1464 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1465 * @cmap: cmap to set
1466 * @info: fbdev registered by the helper
1468 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1470 struct drm_fb_helper *fb_helper = info->par;
1473 if (oops_in_progress)
1476 mutex_lock(&fb_helper->lock);
1478 if (!drm_fb_helper_is_bound(fb_helper)) {
1483 if (info->fix.visual == FB_VISUAL_TRUECOLOR)
1484 ret = setcmap_pseudo_palette(cmap, info);
1485 else if (drm_drv_uses_atomic_modeset(fb_helper->dev))
1486 ret = setcmap_atomic(cmap, info);
1488 ret = setcmap_legacy(cmap, info);
1491 mutex_unlock(&fb_helper->lock);
1495 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1498 * drm_fb_helper_ioctl - legacy ioctl implementation
1499 * @info: fbdev registered by the helper
1500 * @cmd: ioctl command
1501 * @arg: ioctl argument
1503 * A helper to implement the standard fbdev ioctl. Only
1504 * FBIO_WAITFORVSYNC is implemented for now.
1506 int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
1509 struct drm_fb_helper *fb_helper = info->par;
1510 struct drm_mode_set *mode_set;
1511 struct drm_crtc *crtc;
1514 mutex_lock(&fb_helper->lock);
1515 if (!drm_fb_helper_is_bound(fb_helper)) {
1521 case FBIO_WAITFORVSYNC:
1523 * Only consider the first CRTC.
1525 * This ioctl is supposed to take the CRTC number as
1526 * an argument, but in fbdev times, what that number
1527 * was supposed to be was quite unclear, different
1528 * drivers were passing that argument differently
1529 * (some by reference, some by value), and most of the
1530 * userspace applications were just hardcoding 0 as an
1533 * The first CRTC should be the integrated panel on
1534 * most drivers, so this is the best choice we can
1535 * make. If we're not smart enough here, one should
1536 * just consider switch the userspace to KMS.
1538 mode_set = &fb_helper->crtc_info[0].mode_set;
1539 crtc = mode_set->crtc;
1542 * Only wait for a vblank event if the CRTC is
1543 * enabled, otherwise just don't do anythintg,
1544 * not even report an error.
1546 ret = drm_crtc_vblank_get(crtc);
1548 drm_crtc_wait_one_vblank(crtc);
1549 drm_crtc_vblank_put(crtc);
1559 mutex_unlock(&fb_helper->lock);
1562 EXPORT_SYMBOL(drm_fb_helper_ioctl);
1565 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1566 * @var: screeninfo to check
1567 * @info: fbdev registered by the helper
1569 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1570 struct fb_info *info)
1572 struct drm_fb_helper *fb_helper = info->par;
1573 struct drm_framebuffer *fb = fb_helper->fb;
1576 if (var->pixclock != 0 || in_dbg_master())
1580 * Changes struct fb_var_screeninfo are currently not pushed back
1581 * to KMS, hence fail if different settings are requested.
1583 if (var->bits_per_pixel != fb->format->cpp[0] * 8 ||
1584 var->xres > fb->width || var->yres > fb->height ||
1585 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1586 DRM_DEBUG("fb requested width/height/bpp can't fit in current fb "
1587 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1588 var->xres, var->yres, var->bits_per_pixel,
1589 var->xres_virtual, var->yres_virtual,
1590 fb->width, fb->height, fb->format->cpp[0] * 8);
1594 switch (var->bits_per_pixel) {
1596 depth = (var->green.length == 6) ? 16 : 15;
1599 depth = (var->transp.length > 0) ? 32 : 24;
1602 depth = var->bits_per_pixel;
1608 var->red.offset = 0;
1609 var->green.offset = 0;
1610 var->blue.offset = 0;
1611 var->red.length = 8;
1612 var->green.length = 8;
1613 var->blue.length = 8;
1614 var->transp.length = 0;
1615 var->transp.offset = 0;
1618 var->red.offset = 10;
1619 var->green.offset = 5;
1620 var->blue.offset = 0;
1621 var->red.length = 5;
1622 var->green.length = 5;
1623 var->blue.length = 5;
1624 var->transp.length = 1;
1625 var->transp.offset = 15;
1628 var->red.offset = 11;
1629 var->green.offset = 5;
1630 var->blue.offset = 0;
1631 var->red.length = 5;
1632 var->green.length = 6;
1633 var->blue.length = 5;
1634 var->transp.length = 0;
1635 var->transp.offset = 0;
1638 var->red.offset = 16;
1639 var->green.offset = 8;
1640 var->blue.offset = 0;
1641 var->red.length = 8;
1642 var->green.length = 8;
1643 var->blue.length = 8;
1644 var->transp.length = 0;
1645 var->transp.offset = 0;
1648 var->red.offset = 16;
1649 var->green.offset = 8;
1650 var->blue.offset = 0;
1651 var->red.length = 8;
1652 var->green.length = 8;
1653 var->blue.length = 8;
1654 var->transp.length = 8;
1655 var->transp.offset = 24;
1662 EXPORT_SYMBOL(drm_fb_helper_check_var);
1665 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1666 * @info: fbdev registered by the helper
1668 * This will let fbcon do the mode init and is called at initialization time by
1669 * the fbdev core when registering the driver, and later on through the hotplug
1672 int drm_fb_helper_set_par(struct fb_info *info)
1674 struct drm_fb_helper *fb_helper = info->par;
1675 struct fb_var_screeninfo *var = &info->var;
1677 if (oops_in_progress)
1680 if (var->pixclock != 0) {
1681 DRM_ERROR("PIXEL CLOCK SET\n");
1685 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1689 EXPORT_SYMBOL(drm_fb_helper_set_par);
1691 static void pan_set(struct drm_fb_helper *fb_helper, int x, int y)
1695 for (i = 0; i < fb_helper->crtc_count; i++) {
1696 struct drm_mode_set *mode_set;
1698 mode_set = &fb_helper->crtc_info[i].mode_set;
1705 static int pan_display_atomic(struct fb_var_screeninfo *var,
1706 struct fb_info *info)
1708 struct drm_fb_helper *fb_helper = info->par;
1711 pan_set(fb_helper, var->xoffset, var->yoffset);
1713 ret = restore_fbdev_mode_atomic(fb_helper, true);
1715 info->var.xoffset = var->xoffset;
1716 info->var.yoffset = var->yoffset;
1718 pan_set(fb_helper, info->var.xoffset, info->var.yoffset);
1723 static int pan_display_legacy(struct fb_var_screeninfo *var,
1724 struct fb_info *info)
1726 struct drm_fb_helper *fb_helper = info->par;
1727 struct drm_mode_set *modeset;
1731 drm_modeset_lock_all(fb_helper->dev);
1732 for (i = 0; i < fb_helper->crtc_count; i++) {
1733 modeset = &fb_helper->crtc_info[i].mode_set;
1735 modeset->x = var->xoffset;
1736 modeset->y = var->yoffset;
1738 if (modeset->num_connectors) {
1739 ret = drm_mode_set_config_internal(modeset);
1741 info->var.xoffset = var->xoffset;
1742 info->var.yoffset = var->yoffset;
1746 drm_modeset_unlock_all(fb_helper->dev);
1752 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1753 * @var: updated screen information
1754 * @info: fbdev registered by the helper
1756 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1757 struct fb_info *info)
1759 struct drm_fb_helper *fb_helper = info->par;
1760 struct drm_device *dev = fb_helper->dev;
1763 if (oops_in_progress)
1766 mutex_lock(&fb_helper->lock);
1767 if (!drm_fb_helper_is_bound(fb_helper)) {
1768 mutex_unlock(&fb_helper->lock);
1772 if (drm_drv_uses_atomic_modeset(dev))
1773 ret = pan_display_atomic(var, info);
1775 ret = pan_display_legacy(var, info);
1776 mutex_unlock(&fb_helper->lock);
1780 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1783 * Allocates the backing storage and sets up the fbdev info structure through
1784 * the ->fb_probe callback.
1786 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1792 struct drm_fb_helper_surface_size sizes;
1795 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1796 sizes.surface_depth = 24;
1797 sizes.surface_bpp = 32;
1798 sizes.fb_width = (u32)-1;
1799 sizes.fb_height = (u32)-1;
1801 /* if driver picks 8 or 16 by default use that for both depth/bpp */
1802 if (preferred_bpp != sizes.surface_bpp)
1803 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1805 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1806 drm_fb_helper_for_each_connector(fb_helper, i) {
1807 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1808 struct drm_cmdline_mode *cmdline_mode;
1810 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1812 if (cmdline_mode->bpp_specified) {
1813 switch (cmdline_mode->bpp) {
1815 sizes.surface_depth = sizes.surface_bpp = 8;
1818 sizes.surface_depth = 15;
1819 sizes.surface_bpp = 16;
1822 sizes.surface_depth = sizes.surface_bpp = 16;
1825 sizes.surface_depth = sizes.surface_bpp = 24;
1828 sizes.surface_depth = 24;
1829 sizes.surface_bpp = 32;
1837 for (i = 0; i < fb_helper->crtc_count; i++) {
1838 struct drm_display_mode *desired_mode;
1839 struct drm_mode_set *mode_set;
1841 /* in case of tile group, are we the last tile vert or horiz?
1842 * If no tile group you are always the last one both vertically
1845 bool lastv = true, lasth = true;
1847 desired_mode = fb_helper->crtc_info[i].desired_mode;
1848 mode_set = &fb_helper->crtc_info[i].mode_set;
1855 x = fb_helper->crtc_info[i].x;
1856 y = fb_helper->crtc_info[i].y;
1858 if (gamma_size == 0)
1859 gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1861 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1862 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1864 for (j = 0; j < mode_set->num_connectors; j++) {
1865 struct drm_connector *connector = mode_set->connectors[j];
1867 if (connector->has_tile) {
1868 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1869 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1870 /* cloning to multiple tiles is just crazy-talk, so: */
1876 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1878 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1881 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1882 DRM_INFO("Cannot find any crtc or sizes\n");
1884 /* First time: disable all crtc's.. */
1885 if (!fb_helper->deferred_setup && !READ_ONCE(fb_helper->dev->master))
1886 restore_fbdev_mode(fb_helper);
1890 /* Handle our overallocation */
1891 sizes.surface_height *= drm_fbdev_overalloc;
1892 sizes.surface_height /= 100;
1894 /* push down into drivers */
1895 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1899 strcpy(fb_helper->fb->comm, "[fbcon]");
1904 * drm_fb_helper_fill_fix - initializes fixed fbdev information
1905 * @info: fbdev registered by the helper
1906 * @pitch: desired pitch
1907 * @depth: desired depth
1909 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1910 * fbdev emulations. Drivers which support acceleration methods which impose
1911 * additional constraints need to set up their own limits.
1913 * Drivers should call this (or their equivalent setup code) from their
1914 * &drm_fb_helper_funcs.fb_probe callback.
1916 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1919 info->fix.type = FB_TYPE_PACKED_PIXELS;
1920 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1921 FB_VISUAL_TRUECOLOR;
1922 info->fix.mmio_start = 0;
1923 info->fix.mmio_len = 0;
1924 info->fix.type_aux = 0;
1925 info->fix.xpanstep = 1; /* doing it in hw */
1926 info->fix.ypanstep = 1; /* doing it in hw */
1927 info->fix.ywrapstep = 0;
1928 info->fix.accel = FB_ACCEL_NONE;
1930 info->fix.line_length = pitch;
1932 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1935 * drm_fb_helper_fill_var - initalizes variable fbdev information
1936 * @info: fbdev instance to set up
1937 * @fb_helper: fb helper instance to use as template
1938 * @fb_width: desired fb width
1939 * @fb_height: desired fb height
1941 * Sets up the variable fbdev metainformation from the given fb helper instance
1942 * and the drm framebuffer allocated in &drm_fb_helper.fb.
1944 * Drivers should call this (or their equivalent setup code) from their
1945 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
1946 * backing storage framebuffer.
1948 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1949 uint32_t fb_width, uint32_t fb_height)
1951 struct drm_framebuffer *fb = fb_helper->fb;
1953 info->pseudo_palette = fb_helper->pseudo_palette;
1954 info->var.xres_virtual = fb->width;
1955 info->var.yres_virtual = fb->height;
1956 info->var.bits_per_pixel = fb->format->cpp[0] * 8;
1957 info->var.accel_flags = FB_ACCELF_TEXT;
1958 info->var.xoffset = 0;
1959 info->var.yoffset = 0;
1960 info->var.activate = FB_ACTIVATE_NOW;
1962 switch (fb->format->depth) {
1964 info->var.red.offset = 0;
1965 info->var.green.offset = 0;
1966 info->var.blue.offset = 0;
1967 info->var.red.length = 8; /* 8bit DAC */
1968 info->var.green.length = 8;
1969 info->var.blue.length = 8;
1970 info->var.transp.offset = 0;
1971 info->var.transp.length = 0;
1974 info->var.red.offset = 10;
1975 info->var.green.offset = 5;
1976 info->var.blue.offset = 0;
1977 info->var.red.length = 5;
1978 info->var.green.length = 5;
1979 info->var.blue.length = 5;
1980 info->var.transp.offset = 15;
1981 info->var.transp.length = 1;
1984 info->var.red.offset = 11;
1985 info->var.green.offset = 5;
1986 info->var.blue.offset = 0;
1987 info->var.red.length = 5;
1988 info->var.green.length = 6;
1989 info->var.blue.length = 5;
1990 info->var.transp.offset = 0;
1993 info->var.red.offset = 16;
1994 info->var.green.offset = 8;
1995 info->var.blue.offset = 0;
1996 info->var.red.length = 8;
1997 info->var.green.length = 8;
1998 info->var.blue.length = 8;
1999 info->var.transp.offset = 0;
2000 info->var.transp.length = 0;
2003 info->var.red.offset = 16;
2004 info->var.green.offset = 8;
2005 info->var.blue.offset = 0;
2006 info->var.red.length = 8;
2007 info->var.green.length = 8;
2008 info->var.blue.length = 8;
2009 info->var.transp.offset = 24;
2010 info->var.transp.length = 8;
2016 info->var.xres = fb_width;
2017 info->var.yres = fb_height;
2019 EXPORT_SYMBOL(drm_fb_helper_fill_var);
2021 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
2025 struct drm_connector *connector;
2028 drm_fb_helper_for_each_connector(fb_helper, i) {
2029 connector = fb_helper->connector_info[i]->connector;
2030 count += connector->funcs->fill_modes(connector, maxX, maxY);
2036 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
2038 struct drm_display_mode *mode;
2040 list_for_each_entry(mode, &fb_connector->connector->modes, head) {
2041 if (mode->hdisplay > width ||
2042 mode->vdisplay > height)
2044 if (mode->type & DRM_MODE_TYPE_PREFERRED)
2049 EXPORT_SYMBOL(drm_has_preferred_mode);
2051 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
2053 return fb_connector->connector->cmdline_mode.specified;
2056 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn)
2058 struct drm_cmdline_mode *cmdline_mode;
2059 struct drm_display_mode *mode;
2060 bool prefer_non_interlace;
2062 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
2063 if (cmdline_mode->specified == false)
2066 /* attempt to find a matching mode in the list of modes
2067 * we have gotten so far, if not add a CVT mode that conforms
2069 if (cmdline_mode->rb || cmdline_mode->margins)
2072 prefer_non_interlace = !cmdline_mode->interlace;
2074 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
2075 /* check width/height */
2076 if (mode->hdisplay != cmdline_mode->xres ||
2077 mode->vdisplay != cmdline_mode->yres)
2080 if (cmdline_mode->refresh_specified) {
2081 if (mode->vrefresh != cmdline_mode->refresh)
2085 if (cmdline_mode->interlace) {
2086 if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
2088 } else if (prefer_non_interlace) {
2089 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
2095 if (prefer_non_interlace) {
2096 prefer_non_interlace = false;
2101 mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
2103 list_add(&mode->head, &fb_helper_conn->connector->modes);
2106 EXPORT_SYMBOL(drm_pick_cmdline_mode);
2108 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
2112 if (connector->display_info.non_desktop)
2116 enable = connector->status == connector_status_connected;
2118 enable = connector->status != connector_status_disconnected;
2123 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
2126 bool any_enabled = false;
2127 struct drm_connector *connector;
2130 drm_fb_helper_for_each_connector(fb_helper, i) {
2131 connector = fb_helper->connector_info[i]->connector;
2132 enabled[i] = drm_connector_enabled(connector, true);
2133 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
2134 connector->display_info.non_desktop ? "non desktop" : enabled[i] ? "yes" : "no");
2136 any_enabled |= enabled[i];
2142 drm_fb_helper_for_each_connector(fb_helper, i) {
2143 connector = fb_helper->connector_info[i]->connector;
2144 enabled[i] = drm_connector_enabled(connector, false);
2148 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
2149 struct drm_display_mode **modes,
2150 struct drm_fb_offset *offsets,
2151 bool *enabled, int width, int height)
2154 bool can_clone = false;
2155 struct drm_fb_helper_connector *fb_helper_conn;
2156 struct drm_display_mode *dmt_mode, *mode;
2158 /* only contemplate cloning in the single crtc case */
2159 if (fb_helper->crtc_count > 1)
2163 drm_fb_helper_for_each_connector(fb_helper, i) {
2168 /* only contemplate cloning if more than one connector is enabled */
2172 /* check the command line or if nothing common pick 1024x768 */
2174 drm_fb_helper_for_each_connector(fb_helper, i) {
2177 fb_helper_conn = fb_helper->connector_info[i];
2178 modes[i] = drm_pick_cmdline_mode(fb_helper_conn);
2183 for (j = 0; j < i; j++) {
2186 if (!drm_mode_equal(modes[j], modes[i]))
2192 DRM_DEBUG_KMS("can clone using command line\n");
2196 /* try and find a 1024x768 mode on each connector */
2198 dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
2200 drm_fb_helper_for_each_connector(fb_helper, i) {
2204 fb_helper_conn = fb_helper->connector_info[i];
2205 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
2206 if (drm_mode_equal(mode, dmt_mode))
2214 DRM_DEBUG_KMS("can clone using 1024x768\n");
2217 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
2221 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
2222 struct drm_display_mode **modes,
2223 struct drm_fb_offset *offsets,
2225 int h_idx, int v_idx)
2227 struct drm_fb_helper_connector *fb_helper_conn;
2229 int hoffset = 0, voffset = 0;
2231 drm_fb_helper_for_each_connector(fb_helper, i) {
2232 fb_helper_conn = fb_helper->connector_info[i];
2233 if (!fb_helper_conn->connector->has_tile)
2236 if (!modes[i] && (h_idx || v_idx)) {
2237 DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
2238 fb_helper_conn->connector->base.id);
2241 if (fb_helper_conn->connector->tile_h_loc < h_idx)
2242 hoffset += modes[i]->hdisplay;
2244 if (fb_helper_conn->connector->tile_v_loc < v_idx)
2245 voffset += modes[i]->vdisplay;
2247 offsets[idx].x = hoffset;
2248 offsets[idx].y = voffset;
2249 DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
2253 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
2254 struct drm_display_mode **modes,
2255 struct drm_fb_offset *offsets,
2256 bool *enabled, int width, int height)
2258 struct drm_fb_helper_connector *fb_helper_conn;
2259 const u64 mask = BIT_ULL(fb_helper->connector_count) - 1;
2260 u64 conn_configured = 0;
2265 drm_fb_helper_for_each_connector(fb_helper, i) {
2266 fb_helper_conn = fb_helper->connector_info[i];
2268 if (conn_configured & BIT_ULL(i))
2271 if (enabled[i] == false) {
2272 conn_configured |= BIT_ULL(i);
2276 /* first pass over all the untiled connectors */
2277 if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
2280 if (tile_pass == 1) {
2281 if (fb_helper_conn->connector->tile_h_loc != 0 ||
2282 fb_helper_conn->connector->tile_v_loc != 0)
2286 if (fb_helper_conn->connector->tile_h_loc != tile_pass - 1 &&
2287 fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
2288 /* if this tile_pass doesn't cover any of the tiles - keep going */
2292 * find the tile offsets for this pass - need to find
2293 * all tiles left and above
2295 drm_get_tile_offsets(fb_helper, modes, offsets,
2296 i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
2298 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
2299 fb_helper_conn->connector->base.id);
2301 /* got for command line mode first */
2302 modes[i] = drm_pick_cmdline_mode(fb_helper_conn);
2304 DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
2305 fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
2306 modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
2308 /* No preferred modes, pick one off the list */
2309 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
2310 list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
2313 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
2315 conn_configured |= BIT_ULL(i);
2318 if ((conn_configured & mask) != mask) {
2325 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
2326 struct drm_fb_helper_crtc **best_crtcs,
2327 struct drm_display_mode **modes,
2328 int n, int width, int height)
2331 struct drm_connector *connector;
2332 const struct drm_connector_helper_funcs *connector_funcs;
2333 struct drm_encoder *encoder;
2334 int my_score, best_score, score;
2335 struct drm_fb_helper_crtc **crtcs, *crtc;
2336 struct drm_fb_helper_connector *fb_helper_conn;
2338 if (n == fb_helper->connector_count)
2341 fb_helper_conn = fb_helper->connector_info[n];
2342 connector = fb_helper_conn->connector;
2344 best_crtcs[n] = NULL;
2345 best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
2346 if (modes[n] == NULL)
2349 crtcs = kcalloc(fb_helper->connector_count,
2350 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2355 if (connector->status == connector_status_connected)
2357 if (drm_has_cmdline_mode(fb_helper_conn))
2359 if (drm_has_preferred_mode(fb_helper_conn, width, height))
2362 connector_funcs = connector->helper_private;
2365 * If the DRM device implements atomic hooks and ->best_encoder() is
2366 * NULL we fallback to the default drm_atomic_helper_best_encoder()
2369 if (drm_drv_uses_atomic_modeset(fb_helper->dev) &&
2370 !connector_funcs->best_encoder)
2371 encoder = drm_atomic_helper_best_encoder(connector);
2373 encoder = connector_funcs->best_encoder(connector);
2379 * select a crtc for this connector and then attempt to configure
2380 * remaining connectors
2382 for (c = 0; c < fb_helper->crtc_count; c++) {
2383 crtc = &fb_helper->crtc_info[c];
2385 if ((encoder->possible_crtcs & (1 << c)) == 0)
2388 for (o = 0; o < n; o++)
2389 if (best_crtcs[o] == crtc)
2393 /* ignore cloning unless only a single crtc */
2394 if (fb_helper->crtc_count > 1)
2397 if (!drm_mode_equal(modes[o], modes[n]))
2402 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
2403 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
2405 if (score > best_score) {
2407 memcpy(best_crtcs, crtcs,
2408 fb_helper->connector_count *
2409 sizeof(struct drm_fb_helper_crtc *));
2418 * This function checks if rotation is necessary because of panel orientation
2419 * and if it is, if it is supported.
2420 * If rotation is necessary and supported, its gets set in fb_crtc.rotation.
2421 * If rotation is necessary but not supported, a DRM_MODE_ROTATE_* flag gets
2422 * or-ed into fb_helper->sw_rotations. In drm_setup_crtcs_fb() we check if only
2423 * one bit is set and then we set fb_info.fbcon_rotate_hint to make fbcon do
2424 * the unsupported rotation.
2426 static void drm_setup_crtc_rotation(struct drm_fb_helper *fb_helper,
2427 struct drm_fb_helper_crtc *fb_crtc,
2428 struct drm_connector *connector)
2430 struct drm_plane *plane = fb_crtc->mode_set.crtc->primary;
2431 uint64_t valid_mask = 0;
2434 fb_crtc->rotation = DRM_MODE_ROTATE_0;
2436 switch (connector->display_info.panel_orientation) {
2437 case DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP:
2438 rotation = DRM_MODE_ROTATE_180;
2440 case DRM_MODE_PANEL_ORIENTATION_LEFT_UP:
2441 rotation = DRM_MODE_ROTATE_90;
2443 case DRM_MODE_PANEL_ORIENTATION_RIGHT_UP:
2444 rotation = DRM_MODE_ROTATE_270;
2447 rotation = DRM_MODE_ROTATE_0;
2451 * TODO: support 90 / 270 degree hardware rotation,
2452 * depending on the hardware this may require the framebuffer
2453 * to be in a specific tiling format.
2455 if (rotation != DRM_MODE_ROTATE_180 || !plane->rotation_property) {
2456 fb_helper->sw_rotations |= rotation;
2460 for (i = 0; i < plane->rotation_property->num_values; i++)
2461 valid_mask |= (1ULL << plane->rotation_property->values[i]);
2463 if (!(rotation & valid_mask)) {
2464 fb_helper->sw_rotations |= rotation;
2468 fb_crtc->rotation = rotation;
2469 /* Rotating in hardware, fbcon should not rotate */
2470 fb_helper->sw_rotations |= DRM_MODE_ROTATE_0;
2473 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper,
2474 u32 width, u32 height)
2476 struct drm_device *dev = fb_helper->dev;
2477 struct drm_fb_helper_crtc **crtcs;
2478 struct drm_display_mode **modes;
2479 struct drm_fb_offset *offsets;
2483 DRM_DEBUG_KMS("\n");
2484 /* prevent concurrent modification of connector_count by hotplug */
2485 lockdep_assert_held(&fb_helper->lock);
2487 crtcs = kcalloc(fb_helper->connector_count,
2488 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2489 modes = kcalloc(fb_helper->connector_count,
2490 sizeof(struct drm_display_mode *), GFP_KERNEL);
2491 offsets = kcalloc(fb_helper->connector_count,
2492 sizeof(struct drm_fb_offset), GFP_KERNEL);
2493 enabled = kcalloc(fb_helper->connector_count,
2494 sizeof(bool), GFP_KERNEL);
2495 if (!crtcs || !modes || !enabled || !offsets) {
2496 DRM_ERROR("Memory allocation failed\n");
2500 mutex_lock(&fb_helper->dev->mode_config.mutex);
2501 if (drm_fb_helper_probe_connector_modes(fb_helper, width, height) == 0)
2502 DRM_DEBUG_KMS("No connectors reported connected with modes\n");
2503 drm_enable_connectors(fb_helper, enabled);
2505 if (!(fb_helper->funcs->initial_config &&
2506 fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2508 enabled, width, height))) {
2509 memset(modes, 0, fb_helper->connector_count*sizeof(modes[0]));
2510 memset(crtcs, 0, fb_helper->connector_count*sizeof(crtcs[0]));
2511 memset(offsets, 0, fb_helper->connector_count*sizeof(offsets[0]));
2513 if (!drm_target_cloned(fb_helper, modes, offsets,
2514 enabled, width, height) &&
2515 !drm_target_preferred(fb_helper, modes, offsets,
2516 enabled, width, height))
2517 DRM_ERROR("Unable to find initial modes\n");
2519 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2522 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2524 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2526 /* need to set the modesets up here for use later */
2527 /* fill out the connector<->crtc mappings into the modesets */
2528 for (i = 0; i < fb_helper->crtc_count; i++)
2529 drm_fb_helper_modeset_release(fb_helper,
2530 &fb_helper->crtc_info[i].mode_set);
2532 fb_helper->sw_rotations = 0;
2533 drm_fb_helper_for_each_connector(fb_helper, i) {
2534 struct drm_display_mode *mode = modes[i];
2535 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2536 struct drm_fb_offset *offset = &offsets[i];
2538 if (mode && fb_crtc) {
2539 struct drm_mode_set *modeset = &fb_crtc->mode_set;
2540 struct drm_connector *connector =
2541 fb_helper->connector_info[i]->connector;
2543 DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2544 mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2546 fb_crtc->desired_mode = mode;
2547 fb_crtc->x = offset->x;
2548 fb_crtc->y = offset->y;
2549 modeset->mode = drm_mode_duplicate(dev,
2550 fb_crtc->desired_mode);
2551 drm_connector_get(connector);
2552 drm_setup_crtc_rotation(fb_helper, fb_crtc, connector);
2553 modeset->connectors[modeset->num_connectors++] = connector;
2554 modeset->x = offset->x;
2555 modeset->y = offset->y;
2566 * This is a continuation of drm_setup_crtcs() that sets up anything related
2567 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
2568 * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
2569 * So, any setup that touches those fields needs to be done here instead of in
2570 * drm_setup_crtcs().
2572 static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper)
2574 struct fb_info *info = fb_helper->fbdev;
2577 for (i = 0; i < fb_helper->crtc_count; i++)
2578 if (fb_helper->crtc_info[i].mode_set.num_connectors)
2579 fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
2581 mutex_lock(&fb_helper->dev->mode_config.mutex);
2582 drm_fb_helper_for_each_connector(fb_helper, i) {
2583 struct drm_connector *connector =
2584 fb_helper->connector_info[i]->connector;
2586 /* use first connected connector for the physical dimensions */
2587 if (connector->status == connector_status_connected) {
2588 info->var.width = connector->display_info.width_mm;
2589 info->var.height = connector->display_info.height_mm;
2593 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2595 switch (fb_helper->sw_rotations) {
2596 case DRM_MODE_ROTATE_0:
2597 info->fbcon_rotate_hint = FB_ROTATE_UR;
2599 case DRM_MODE_ROTATE_90:
2600 info->fbcon_rotate_hint = FB_ROTATE_CCW;
2602 case DRM_MODE_ROTATE_180:
2603 info->fbcon_rotate_hint = FB_ROTATE_UD;
2605 case DRM_MODE_ROTATE_270:
2606 info->fbcon_rotate_hint = FB_ROTATE_CW;
2610 * Multiple bits are set / multiple rotations requested
2611 * fbcon cannot handle separate rotation settings per
2612 * output, so fallback to unrotated.
2614 info->fbcon_rotate_hint = FB_ROTATE_UR;
2618 /* Note: Drops fb_helper->lock before returning. */
2620 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper,
2623 struct drm_device *dev = fb_helper->dev;
2624 struct fb_info *info;
2625 unsigned int width, height;
2628 width = dev->mode_config.max_width;
2629 height = dev->mode_config.max_height;
2631 drm_setup_crtcs(fb_helper, width, height);
2632 ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2634 if (ret == -EAGAIN) {
2635 fb_helper->preferred_bpp = bpp_sel;
2636 fb_helper->deferred_setup = true;
2639 mutex_unlock(&fb_helper->lock);
2643 drm_setup_crtcs_fb(fb_helper);
2645 fb_helper->deferred_setup = false;
2647 info = fb_helper->fbdev;
2648 info->var.pixclock = 0;
2650 /* Need to drop locks to avoid recursive deadlock in
2651 * register_framebuffer. This is ok because the only thing left to do is
2652 * register the fbdev emulation instance in kernel_fb_helper_list. */
2653 mutex_unlock(&fb_helper->lock);
2655 ret = register_framebuffer(info);
2659 dev_info(dev->dev, "fb%d: %s frame buffer device\n",
2660 info->node, info->fix.id);
2662 mutex_lock(&kernel_fb_helper_lock);
2663 if (list_empty(&kernel_fb_helper_list))
2664 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
2666 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
2667 mutex_unlock(&kernel_fb_helper_lock);
2673 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2674 * @fb_helper: fb_helper device struct
2675 * @bpp_sel: bpp value to use for the framebuffer configuration
2677 * Scans the CRTCs and connectors and tries to put together an initial setup.
2678 * At the moment, this is a cloned configuration across all heads with
2679 * a new framebuffer object as the backing store.
2681 * Note that this also registers the fbdev and so allows userspace to call into
2682 * the driver through the fbdev interfaces.
2684 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
2685 * to let the driver allocate and initialize the fbdev info structure and the
2686 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2687 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2688 * values for the fbdev info structure.
2692 * When you have fbcon support built-in or already loaded, this function will do
2693 * a full modeset to setup the fbdev console. Due to locking misdesign in the
2694 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2695 * console_lock. Until console_unlock is called no dmesg lines will be sent out
2696 * to consoles, not even serial console. This means when your driver crashes,
2697 * you will see absolutely nothing else but a system stuck in this function,
2698 * with no further output. Any kind of printk() you place within your own driver
2699 * or in the drm core modeset code will also never show up.
2701 * Standard debug practice is to run the fbcon setup without taking the
2702 * console_lock as a hack, to be able to see backtraces and crashes on the
2703 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2706 * The other option is to just disable fbdev emulation since very likely the
2707 * first modeset from userspace will crash in the same way, and is even easier
2708 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2709 * kernel cmdline option.
2712 * Zero if everything went ok, nonzero otherwise.
2714 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2718 if (!drm_fbdev_emulation)
2721 mutex_lock(&fb_helper->lock);
2722 ret = __drm_fb_helper_initial_config_and_unlock(fb_helper, bpp_sel);
2726 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2729 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2730 * probing all the outputs attached to the fb
2731 * @fb_helper: driver-allocated fbdev helper, can be NULL
2733 * Scan the connectors attached to the fb_helper and try to put together a
2734 * setup after notification of a change in output configuration.
2736 * Called at runtime, takes the mode config locks to be able to check/change the
2737 * modeset configuration. Must be run from process context (which usually means
2738 * either the output polling work or a work item launched from the driver's
2739 * hotplug interrupt).
2741 * Note that drivers may call this even before calling
2742 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2743 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2744 * not miss any hotplug events.
2747 * 0 on success and a non-zero error code otherwise.
2749 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2753 if (!drm_fbdev_emulation || !fb_helper)
2756 mutex_lock(&fb_helper->lock);
2757 if (fb_helper->deferred_setup) {
2758 err = __drm_fb_helper_initial_config_and_unlock(fb_helper,
2759 fb_helper->preferred_bpp);
2763 if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2764 fb_helper->delayed_hotplug = true;
2765 mutex_unlock(&fb_helper->lock);
2769 DRM_DEBUG_KMS("\n");
2771 drm_setup_crtcs(fb_helper, fb_helper->fb->width, fb_helper->fb->height);
2772 drm_setup_crtcs_fb(fb_helper);
2773 mutex_unlock(&fb_helper->lock);
2775 drm_fb_helper_set_par(fb_helper->fbdev);
2779 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2782 * drm_fb_helper_fbdev_setup() - Setup fbdev emulation
2784 * @fb_helper: fbdev helper structure to set up
2785 * @funcs: fbdev helper functions
2786 * @preferred_bpp: Preferred bits per pixel for the device.
2787 * @dev->mode_config.preferred_depth is used if this is zero.
2788 * @max_conn_count: Maximum number of connectors.
2789 * @dev->mode_config.num_connector is used if this is zero.
2791 * This function sets up fbdev emulation and registers fbdev for access by
2792 * userspace. If all connectors are disconnected, setup is deferred to the next
2793 * time drm_fb_helper_hotplug_event() is called.
2794 * The caller must to provide a &drm_fb_helper_funcs->fb_probe callback
2797 * See also: drm_fb_helper_initial_config()
2800 * Zero on success or negative error code on failure.
2802 int drm_fb_helper_fbdev_setup(struct drm_device *dev,
2803 struct drm_fb_helper *fb_helper,
2804 const struct drm_fb_helper_funcs *funcs,
2805 unsigned int preferred_bpp,
2806 unsigned int max_conn_count)
2811 preferred_bpp = dev->mode_config.preferred_depth;
2815 if (!max_conn_count)
2816 max_conn_count = dev->mode_config.num_connector;
2817 if (!max_conn_count) {
2818 DRM_DEV_ERROR(dev->dev, "No connectors\n");
2822 drm_fb_helper_prepare(dev, fb_helper, funcs);
2824 ret = drm_fb_helper_init(dev, fb_helper, max_conn_count);
2826 DRM_DEV_ERROR(dev->dev, "Failed to initialize fbdev helper\n");
2830 ret = drm_fb_helper_single_add_all_connectors(fb_helper);
2832 DRM_DEV_ERROR(dev->dev, "Failed to add connectors\n");
2833 goto err_drm_fb_helper_fini;
2836 if (!drm_drv_uses_atomic_modeset(dev))
2837 drm_helper_disable_unused_functions(dev);
2839 ret = drm_fb_helper_initial_config(fb_helper, preferred_bpp);
2841 DRM_DEV_ERROR(dev->dev, "Failed to set fbdev configuration\n");
2842 goto err_drm_fb_helper_fini;
2847 err_drm_fb_helper_fini:
2848 drm_fb_helper_fini(fb_helper);
2852 EXPORT_SYMBOL(drm_fb_helper_fbdev_setup);
2855 * drm_fb_helper_fbdev_teardown - Tear down fbdev emulation
2858 * This function unregisters fbdev if not already done and cleans up the
2859 * associated resources including the &drm_framebuffer.
2860 * The driver is responsible for freeing the &drm_fb_helper structure which is
2861 * stored in &drm_device->fb_helper. Do note that this pointer has been cleared
2862 * when this function returns.
2864 * In order to support device removal/unplug while file handles are still open,
2865 * drm_fb_helper_unregister_fbi() should be called on device removal and
2866 * drm_fb_helper_fbdev_teardown() in the &drm_driver->release callback when
2867 * file handles are closed.
2869 void drm_fb_helper_fbdev_teardown(struct drm_device *dev)
2871 struct drm_fb_helper *fb_helper = dev->fb_helper;
2872 struct fb_ops *fbops = NULL;
2877 /* Unregister if it hasn't been done already */
2878 if (fb_helper->fbdev && fb_helper->fbdev->dev)
2879 drm_fb_helper_unregister_fbi(fb_helper);
2881 if (fb_helper->fbdev && fb_helper->fbdev->fbdefio) {
2882 fb_deferred_io_cleanup(fb_helper->fbdev);
2883 kfree(fb_helper->fbdev->fbdefio);
2884 fbops = fb_helper->fbdev->fbops;
2887 drm_fb_helper_fini(fb_helper);
2891 drm_framebuffer_remove(fb_helper->fb);
2893 EXPORT_SYMBOL(drm_fb_helper_fbdev_teardown);
2896 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
2899 * This function can be used as the &drm_driver->lastclose callback for drivers
2900 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
2902 void drm_fb_helper_lastclose(struct drm_device *dev)
2904 drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper);
2906 EXPORT_SYMBOL(drm_fb_helper_lastclose);
2909 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
2910 * helper for fbdev emulation
2913 * This function can be used as the
2914 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
2915 * need to call drm_fb_helper_hotplug_event().
2917 void drm_fb_helper_output_poll_changed(struct drm_device *dev)
2919 drm_fb_helper_hotplug_event(dev->fb_helper);
2921 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed);
2923 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2924 * but the module doesn't depend on any fb console symbols. At least
2925 * attempt to load fbcon to avoid leaving the system without a usable console.
2927 int __init drm_fb_helper_modinit(void)
2929 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2930 const char name[] = "fbcon";
2931 struct module *fbcon;
2933 mutex_lock(&module_mutex);
2934 fbcon = find_module(name);
2935 mutex_unlock(&module_mutex);
2938 request_module_nowait(name);
2942 EXPORT_SYMBOL(drm_fb_helper_modinit);