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_helper_internal.h"
46 static bool drm_fbdev_emulation = true;
47 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
48 MODULE_PARM_DESC(fbdev_emulation,
49 "Enable legacy fbdev emulation [default=true]");
51 static LIST_HEAD(kernel_fb_helper_list);
56 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
57 * mode setting driver. They can be used mostly independently from the crtc
58 * helper functions used by many drivers to implement the kernel mode setting
61 * Initialization is done as a four-step process with drm_fb_helper_prepare(),
62 * drm_fb_helper_init(), drm_fb_helper_single_add_all_connectors() and
63 * drm_fb_helper_initial_config(). Drivers with fancier requirements than the
64 * default behaviour can override the third step with their own code.
65 * Teardown is done with drm_fb_helper_fini().
67 * At runtime drivers should restore the fbdev console by calling
68 * drm_fb_helper_restore_fbdev_mode_unlocked() from their ->lastclose callback.
69 * They should also notify the fb helper code from updates to the output
70 * configuration by calling drm_fb_helper_hotplug_event(). For easier
71 * integration with the output polling code in drm_crtc_helper.c the modeset
72 * code provides a ->output_poll_changed callback.
74 * All other functions exported by the fb helper library can be used to
75 * implement the fbdev driver interface by the driver.
77 * It is possible, though perhaps somewhat tricky, to implement race-free
78 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
79 * helper must be called first to initialize the minimum required to make
80 * hotplug detection work. Drivers also need to make sure to properly set up
81 * the dev->mode_config.funcs member. After calling drm_kms_helper_poll_init()
82 * it is safe to enable interrupts and start processing hotplug events. At the
83 * same time, drivers should initialize all modeset objects such as CRTCs,
84 * encoders and connectors. To finish up the fbdev helper initialization, the
85 * drm_fb_helper_init() function is called. To probe for all attached displays
86 * and set up an initial configuration using the detected hardware, drivers
87 * should call drm_fb_helper_single_add_all_connectors() followed by
88 * drm_fb_helper_initial_config().
90 * If &drm_framebuffer_funcs ->dirty is set, the
91 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
92 * accumulate changes and schedule &drm_fb_helper ->dirty_work to run right
93 * away. This worker then calls the dirty() function ensuring that it will
94 * always run in process context since the fb_*() function could be running in
95 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
96 * callback it will also schedule dirty_work with the damage collected from the
101 * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
103 * @fb_helper: fbdev initialized with drm_fb_helper_init
105 * This functions adds all the available connectors for use with the given
106 * fb_helper. This is a separate step to allow drivers to freely assign
107 * connectors to the fbdev, e.g. if some are reserved for special purposes or
108 * not adequate to be used for the fbcon.
110 * This function is protected against concurrent connector hotadds/removals
111 * using drm_fb_helper_add_one_connector() and
112 * drm_fb_helper_remove_one_connector().
114 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
116 struct drm_device *dev = fb_helper->dev;
117 struct drm_connector *connector;
120 if (!drm_fbdev_emulation)
123 mutex_lock(&dev->mode_config.mutex);
124 drm_for_each_connector(connector, dev) {
125 ret = drm_fb_helper_add_one_connector(fb_helper, connector);
130 mutex_unlock(&dev->mode_config.mutex);
133 for (i = 0; i < fb_helper->connector_count; i++) {
134 kfree(fb_helper->connector_info[i]);
135 fb_helper->connector_info[i] = NULL;
137 fb_helper->connector_count = 0;
138 mutex_unlock(&dev->mode_config.mutex);
142 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
144 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector)
146 struct drm_fb_helper_connector **temp;
147 struct drm_fb_helper_connector *fb_helper_connector;
149 if (!drm_fbdev_emulation)
152 WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
153 if (fb_helper->connector_count + 1 > fb_helper->connector_info_alloc_count) {
154 temp = krealloc(fb_helper->connector_info, sizeof(struct drm_fb_helper_connector *) * (fb_helper->connector_count + 1), GFP_KERNEL);
158 fb_helper->connector_info_alloc_count = fb_helper->connector_count + 1;
159 fb_helper->connector_info = temp;
163 fb_helper_connector = kzalloc(sizeof(struct drm_fb_helper_connector), GFP_KERNEL);
164 if (!fb_helper_connector)
167 drm_connector_reference(connector);
168 fb_helper_connector->connector = connector;
169 fb_helper->connector_info[fb_helper->connector_count++] = fb_helper_connector;
172 EXPORT_SYMBOL(drm_fb_helper_add_one_connector);
174 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
175 struct drm_connector *connector)
177 struct drm_fb_helper_connector *fb_helper_connector;
180 if (!drm_fbdev_emulation)
183 WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
185 for (i = 0; i < fb_helper->connector_count; i++) {
186 if (fb_helper->connector_info[i]->connector == connector)
190 if (i == fb_helper->connector_count)
192 fb_helper_connector = fb_helper->connector_info[i];
193 drm_connector_unreference(fb_helper_connector->connector);
195 for (j = i + 1; j < fb_helper->connector_count; j++) {
196 fb_helper->connector_info[j - 1] = fb_helper->connector_info[j];
198 fb_helper->connector_count--;
199 kfree(fb_helper_connector);
203 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector);
205 static void drm_fb_helper_save_lut_atomic(struct drm_crtc *crtc, struct drm_fb_helper *helper)
207 uint16_t *r_base, *g_base, *b_base;
210 if (helper->funcs->gamma_get == NULL)
213 r_base = crtc->gamma_store;
214 g_base = r_base + crtc->gamma_size;
215 b_base = g_base + crtc->gamma_size;
217 for (i = 0; i < crtc->gamma_size; i++)
218 helper->funcs->gamma_get(crtc, &r_base[i], &g_base[i], &b_base[i], i);
221 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
223 uint16_t *r_base, *g_base, *b_base;
225 if (crtc->funcs->gamma_set == NULL)
228 r_base = crtc->gamma_store;
229 g_base = r_base + crtc->gamma_size;
230 b_base = g_base + crtc->gamma_size;
232 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, crtc->gamma_size);
236 * drm_fb_helper_debug_enter - implementation for ->fb_debug_enter
237 * @info: fbdev registered by the helper
239 int drm_fb_helper_debug_enter(struct fb_info *info)
241 struct drm_fb_helper *helper = info->par;
242 const struct drm_crtc_helper_funcs *funcs;
245 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
246 for (i = 0; i < helper->crtc_count; i++) {
247 struct drm_mode_set *mode_set =
248 &helper->crtc_info[i].mode_set;
250 if (!mode_set->crtc->enabled)
253 funcs = mode_set->crtc->helper_private;
254 drm_fb_helper_save_lut_atomic(mode_set->crtc, helper);
255 funcs->mode_set_base_atomic(mode_set->crtc,
259 ENTER_ATOMIC_MODE_SET);
265 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
267 /* Find the real fb for a given fb helper CRTC */
268 static struct drm_framebuffer *drm_mode_config_fb(struct drm_crtc *crtc)
270 struct drm_device *dev = crtc->dev;
273 drm_for_each_crtc(c, dev) {
274 if (crtc->base.id == c->base.id)
275 return c->primary->fb;
282 * drm_fb_helper_debug_leave - implementation for ->fb_debug_leave
283 * @info: fbdev registered by the helper
285 int drm_fb_helper_debug_leave(struct fb_info *info)
287 struct drm_fb_helper *helper = info->par;
288 struct drm_crtc *crtc;
289 const struct drm_crtc_helper_funcs *funcs;
290 struct drm_framebuffer *fb;
293 for (i = 0; i < helper->crtc_count; i++) {
294 struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
295 crtc = mode_set->crtc;
296 funcs = crtc->helper_private;
297 fb = drm_mode_config_fb(crtc);
303 DRM_ERROR("no fb to restore??\n");
307 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
308 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
309 crtc->y, LEAVE_ATOMIC_MODE_SET);
314 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
316 static int restore_fbdev_mode_atomic(struct drm_fb_helper *fb_helper)
318 struct drm_device *dev = fb_helper->dev;
319 struct drm_plane *plane;
320 struct drm_atomic_state *state;
324 state = drm_atomic_state_alloc(dev);
328 state->acquire_ctx = dev->mode_config.acquire_ctx;
331 drm_for_each_plane(plane, dev) {
332 struct drm_plane_state *plane_state;
334 plane_state = drm_atomic_get_plane_state(state, plane);
335 if (IS_ERR(plane_state)) {
336 ret = PTR_ERR(plane_state);
340 plane_state->rotation = DRM_ROTATE_0;
342 plane->old_fb = plane->fb;
343 plane_mask |= 1 << drm_plane_index(plane);
345 /* disable non-primary: */
346 if (plane->type == DRM_PLANE_TYPE_PRIMARY)
349 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
354 for(i = 0; i < fb_helper->crtc_count; i++) {
355 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
357 ret = __drm_atomic_helper_set_config(mode_set, state);
362 ret = drm_atomic_commit(state);
365 drm_atomic_clean_old_fb(dev, plane_mask, ret);
371 drm_atomic_state_free(state);
376 drm_atomic_state_clear(state);
377 drm_atomic_legacy_backoff(state);
382 static int restore_fbdev_mode(struct drm_fb_helper *fb_helper)
384 struct drm_device *dev = fb_helper->dev;
385 struct drm_plane *plane;
388 drm_warn_on_modeset_not_all_locked(dev);
390 if (dev->mode_config.funcs->atomic_commit)
391 return restore_fbdev_mode_atomic(fb_helper);
393 drm_for_each_plane(plane, dev) {
394 if (plane->type != DRM_PLANE_TYPE_PRIMARY)
395 drm_plane_force_disable(plane);
397 if (dev->mode_config.rotation_property) {
398 drm_mode_plane_set_obj_prop(plane,
399 dev->mode_config.rotation_property,
404 for (i = 0; i < fb_helper->crtc_count; i++) {
405 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
406 struct drm_crtc *crtc = mode_set->crtc;
409 if (crtc->funcs->cursor_set2) {
410 ret = crtc->funcs->cursor_set2(crtc, NULL, 0, 0, 0, 0, 0);
413 } else if (crtc->funcs->cursor_set) {
414 ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
419 ret = drm_mode_set_config_internal(mode_set);
428 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
429 * @fb_helper: fbcon to restore
431 * This should be called from driver's drm ->lastclose callback
432 * when implementing an fbcon on top of kms using this helper. This ensures that
433 * the user isn't greeted with a black screen when e.g. X dies.
436 * Zero if everything went ok, negative error code otherwise.
438 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
440 struct drm_device *dev = fb_helper->dev;
444 if (!drm_fbdev_emulation)
447 drm_modeset_lock_all(dev);
448 ret = restore_fbdev_mode(fb_helper);
450 do_delayed = fb_helper->delayed_hotplug;
452 fb_helper->delayed_hotplug = false;
453 drm_modeset_unlock_all(dev);
456 drm_fb_helper_hotplug_event(fb_helper);
459 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
461 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
463 struct drm_device *dev = fb_helper->dev;
464 struct drm_crtc *crtc;
465 int bound = 0, crtcs_bound = 0;
467 /* Sometimes user space wants everything disabled, so don't steal the
468 * display if there's a master. */
469 if (READ_ONCE(dev->master))
472 drm_for_each_crtc(crtc, dev) {
473 if (crtc->primary->fb)
475 if (crtc->primary->fb == fb_helper->fb)
479 if (bound < crtcs_bound)
485 #ifdef CONFIG_MAGIC_SYSRQ
487 * restore fbcon display for all kms driver's using this helper, used for sysrq
488 * and panic handling.
490 static bool drm_fb_helper_force_kernel_mode(void)
492 bool ret, error = false;
493 struct drm_fb_helper *helper;
495 if (list_empty(&kernel_fb_helper_list))
498 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
499 struct drm_device *dev = helper->dev;
501 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
504 drm_modeset_lock_all(dev);
505 ret = restore_fbdev_mode(helper);
508 drm_modeset_unlock_all(dev);
513 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
516 ret = drm_fb_helper_force_kernel_mode();
518 DRM_ERROR("Failed to restore crtc configuration\n");
520 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
522 static void drm_fb_helper_sysrq(int dummy1)
524 schedule_work(&drm_fb_helper_restore_work);
527 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
528 .handler = drm_fb_helper_sysrq,
529 .help_msg = "force-fb(V)",
530 .action_msg = "Restore framebuffer console",
533 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
536 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
538 struct drm_fb_helper *fb_helper = info->par;
539 struct drm_device *dev = fb_helper->dev;
540 struct drm_crtc *crtc;
541 struct drm_connector *connector;
545 * For each CRTC in this fb, turn the connectors on/off.
547 drm_modeset_lock_all(dev);
548 if (!drm_fb_helper_is_bound(fb_helper)) {
549 drm_modeset_unlock_all(dev);
553 for (i = 0; i < fb_helper->crtc_count; i++) {
554 crtc = fb_helper->crtc_info[i].mode_set.crtc;
559 /* Walk the connectors & encoders on this fb turning them on/off */
560 for (j = 0; j < fb_helper->connector_count; j++) {
561 connector = fb_helper->connector_info[j]->connector;
562 connector->funcs->dpms(connector, dpms_mode);
563 drm_object_property_set_value(&connector->base,
564 dev->mode_config.dpms_property, dpms_mode);
567 drm_modeset_unlock_all(dev);
571 * drm_fb_helper_blank - implementation for ->fb_blank
572 * @blank: desired blanking state
573 * @info: fbdev registered by the helper
575 int drm_fb_helper_blank(int blank, struct fb_info *info)
577 if (oops_in_progress)
581 /* Display: On; HSync: On, VSync: On */
582 case FB_BLANK_UNBLANK:
583 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
585 /* Display: Off; HSync: On, VSync: On */
586 case FB_BLANK_NORMAL:
587 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
589 /* Display: Off; HSync: Off, VSync: On */
590 case FB_BLANK_HSYNC_SUSPEND:
591 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
593 /* Display: Off; HSync: On, VSync: Off */
594 case FB_BLANK_VSYNC_SUSPEND:
595 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
597 /* Display: Off; HSync: Off, VSync: Off */
598 case FB_BLANK_POWERDOWN:
599 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
604 EXPORT_SYMBOL(drm_fb_helper_blank);
606 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
610 for (i = 0; i < helper->connector_count; i++) {
611 drm_connector_unreference(helper->connector_info[i]->connector);
612 kfree(helper->connector_info[i]);
614 kfree(helper->connector_info);
615 for (i = 0; i < helper->crtc_count; i++) {
616 kfree(helper->crtc_info[i].mode_set.connectors);
617 if (helper->crtc_info[i].mode_set.mode)
618 drm_mode_destroy(helper->dev, helper->crtc_info[i].mode_set.mode);
620 kfree(helper->crtc_info);
623 static void drm_fb_helper_resume_worker(struct work_struct *work)
625 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
629 fb_set_suspend(helper->fbdev, 0);
633 static void drm_fb_helper_dirty_work(struct work_struct *work)
635 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
637 struct drm_clip_rect *clip = &helper->dirty_clip;
638 struct drm_clip_rect clip_copy;
641 spin_lock_irqsave(&helper->dirty_lock, flags);
643 clip->x1 = clip->y1 = ~0;
644 clip->x2 = clip->y2 = 0;
645 spin_unlock_irqrestore(&helper->dirty_lock, flags);
647 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
651 * drm_fb_helper_prepare - setup a drm_fb_helper structure
653 * @helper: driver-allocated fbdev helper structure to set up
654 * @funcs: pointer to structure of functions associate with this helper
656 * Sets up the bare minimum to make the framebuffer helper usable. This is
657 * useful to implement race-free initialization of the polling helpers.
659 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
660 const struct drm_fb_helper_funcs *funcs)
662 INIT_LIST_HEAD(&helper->kernel_fb_list);
663 spin_lock_init(&helper->dirty_lock);
664 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
665 INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
666 helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
667 helper->funcs = funcs;
670 EXPORT_SYMBOL(drm_fb_helper_prepare);
673 * drm_fb_helper_init - initialize a drm_fb_helper structure
675 * @fb_helper: driver-allocated fbdev helper structure to initialize
676 * @crtc_count: maximum number of crtcs to support in this fbdev emulation
677 * @max_conn_count: max connector count
679 * This allocates the structures for the fbdev helper with the given limits.
680 * Note that this won't yet touch the hardware (through the driver interfaces)
681 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
682 * to allow driver writes more control over the exact init sequence.
684 * Drivers must call drm_fb_helper_prepare() before calling this function.
687 * Zero if everything went ok, nonzero otherwise.
689 int drm_fb_helper_init(struct drm_device *dev,
690 struct drm_fb_helper *fb_helper,
691 int crtc_count, int max_conn_count)
693 struct drm_crtc *crtc;
696 if (!drm_fbdev_emulation)
702 fb_helper->crtc_info = kcalloc(crtc_count, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
703 if (!fb_helper->crtc_info)
706 fb_helper->crtc_count = crtc_count;
707 fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
708 if (!fb_helper->connector_info) {
709 kfree(fb_helper->crtc_info);
712 fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
713 fb_helper->connector_count = 0;
715 for (i = 0; i < crtc_count; i++) {
716 fb_helper->crtc_info[i].mode_set.connectors =
717 kcalloc(max_conn_count,
718 sizeof(struct drm_connector *),
721 if (!fb_helper->crtc_info[i].mode_set.connectors)
723 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
727 drm_for_each_crtc(crtc, dev) {
728 fb_helper->crtc_info[i].mode_set.crtc = crtc;
734 drm_fb_helper_crtc_free(fb_helper);
737 EXPORT_SYMBOL(drm_fb_helper_init);
740 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
741 * @fb_helper: driver-allocated fbdev helper
743 * A helper to alloc fb_info and the members cmap and apertures. Called
744 * by the driver within the fb_probe fb_helper callback function.
747 * fb_info pointer if things went okay, pointer containing error code
750 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
752 struct device *dev = fb_helper->dev->dev;
753 struct fb_info *info;
756 info = framebuffer_alloc(0, dev);
758 return ERR_PTR(-ENOMEM);
760 ret = fb_alloc_cmap(&info->cmap, 256, 0);
764 info->apertures = alloc_apertures(1);
765 if (!info->apertures) {
770 fb_helper->fbdev = info;
775 fb_dealloc_cmap(&info->cmap);
777 framebuffer_release(info);
780 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
783 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
784 * @fb_helper: driver-allocated fbdev helper
786 * A wrapper around unregister_framebuffer, to release the fb_info
789 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
791 if (fb_helper && fb_helper->fbdev)
792 unregister_framebuffer(fb_helper->fbdev);
794 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
797 * drm_fb_helper_release_fbi - dealloc fb_info and its members
798 * @fb_helper: driver-allocated fbdev helper
800 * A helper to free memory taken by fb_info and the members cmap and
803 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
806 struct fb_info *info = fb_helper->fbdev;
810 fb_dealloc_cmap(&info->cmap);
811 framebuffer_release(info);
814 fb_helper->fbdev = NULL;
817 EXPORT_SYMBOL(drm_fb_helper_release_fbi);
819 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
821 if (!drm_fbdev_emulation)
824 if (!list_empty(&fb_helper->kernel_fb_list)) {
825 list_del(&fb_helper->kernel_fb_list);
826 if (list_empty(&kernel_fb_helper_list)) {
827 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
831 drm_fb_helper_crtc_free(fb_helper);
834 EXPORT_SYMBOL(drm_fb_helper_fini);
837 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
838 * @fb_helper: driver-allocated fbdev helper
840 * A wrapper around unlink_framebuffer implemented by fbdev core
842 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
844 if (fb_helper && fb_helper->fbdev)
845 unlink_framebuffer(fb_helper->fbdev);
847 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
849 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
850 u32 width, u32 height)
852 struct drm_fb_helper *helper = info->par;
853 struct drm_clip_rect *clip = &helper->dirty_clip;
856 if (!helper->fb->funcs->dirty)
859 spin_lock_irqsave(&helper->dirty_lock, flags);
860 clip->x1 = min_t(u32, clip->x1, x);
861 clip->y1 = min_t(u32, clip->y1, y);
862 clip->x2 = max_t(u32, clip->x2, x + width);
863 clip->y2 = max_t(u32, clip->y2, y + height);
864 spin_unlock_irqrestore(&helper->dirty_lock, flags);
866 schedule_work(&helper->dirty_work);
870 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
871 * @info: fb_info struct pointer
872 * @pagelist: list of dirty mmap framebuffer pages
874 * This function is used as the &fb_deferred_io ->deferred_io
875 * callback function for flushing the fbdev mmap writes.
877 void drm_fb_helper_deferred_io(struct fb_info *info,
878 struct list_head *pagelist)
880 unsigned long start, end, min, max;
886 list_for_each_entry(page, pagelist, lru) {
887 start = page->index << PAGE_SHIFT;
888 end = start + PAGE_SIZE - 1;
889 min = min(min, start);
894 y1 = min / info->fix.line_length;
895 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
897 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
900 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
903 * drm_fb_helper_sys_read - wrapper around fb_sys_read
904 * @info: fb_info struct pointer
905 * @buf: userspace buffer to read from framebuffer memory
906 * @count: number of bytes to read from framebuffer memory
907 * @ppos: read offset within framebuffer memory
909 * A wrapper around fb_sys_read implemented by fbdev core
911 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
912 size_t count, loff_t *ppos)
914 return fb_sys_read(info, buf, count, ppos);
916 EXPORT_SYMBOL(drm_fb_helper_sys_read);
919 * drm_fb_helper_sys_write - wrapper around fb_sys_write
920 * @info: fb_info struct pointer
921 * @buf: userspace buffer to write to framebuffer memory
922 * @count: number of bytes to write to framebuffer memory
923 * @ppos: write offset within framebuffer memory
925 * A wrapper around fb_sys_write implemented by fbdev core
927 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
928 size_t count, loff_t *ppos)
932 ret = fb_sys_write(info, buf, count, ppos);
934 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
939 EXPORT_SYMBOL(drm_fb_helper_sys_write);
942 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
943 * @info: fbdev registered by the helper
944 * @rect: info about rectangle to fill
946 * A wrapper around sys_fillrect implemented by fbdev core
948 void drm_fb_helper_sys_fillrect(struct fb_info *info,
949 const struct fb_fillrect *rect)
951 sys_fillrect(info, rect);
952 drm_fb_helper_dirty(info, rect->dx, rect->dy,
953 rect->width, rect->height);
955 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
958 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
959 * @info: fbdev registered by the helper
960 * @area: info about area to copy
962 * A wrapper around sys_copyarea implemented by fbdev core
964 void drm_fb_helper_sys_copyarea(struct fb_info *info,
965 const struct fb_copyarea *area)
967 sys_copyarea(info, area);
968 drm_fb_helper_dirty(info, area->dx, area->dy,
969 area->width, area->height);
971 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
974 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
975 * @info: fbdev registered by the helper
976 * @image: info about image to blit
978 * A wrapper around sys_imageblit implemented by fbdev core
980 void drm_fb_helper_sys_imageblit(struct fb_info *info,
981 const struct fb_image *image)
983 sys_imageblit(info, image);
984 drm_fb_helper_dirty(info, image->dx, image->dy,
985 image->width, image->height);
987 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
990 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
991 * @info: fbdev registered by the helper
992 * @rect: info about rectangle to fill
994 * A wrapper around cfb_imageblit implemented by fbdev core
996 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
997 const struct fb_fillrect *rect)
999 cfb_fillrect(info, rect);
1000 drm_fb_helper_dirty(info, rect->dx, rect->dy,
1001 rect->width, rect->height);
1003 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
1006 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1007 * @info: fbdev registered by the helper
1008 * @area: info about area to copy
1010 * A wrapper around cfb_copyarea implemented by fbdev core
1012 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1013 const struct fb_copyarea *area)
1015 cfb_copyarea(info, area);
1016 drm_fb_helper_dirty(info, area->dx, area->dy,
1017 area->width, area->height);
1019 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1022 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1023 * @info: fbdev registered by the helper
1024 * @image: info about image to blit
1026 * A wrapper around cfb_imageblit implemented by fbdev core
1028 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1029 const struct fb_image *image)
1031 cfb_imageblit(info, image);
1032 drm_fb_helper_dirty(info, image->dx, image->dy,
1033 image->width, image->height);
1035 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1038 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1039 * @fb_helper: driver-allocated fbdev helper
1040 * @suspend: whether to suspend or resume
1042 * A wrapper around fb_set_suspend implemented by fbdev core.
1043 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1046 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
1048 if (fb_helper && fb_helper->fbdev)
1049 fb_set_suspend(fb_helper->fbdev, suspend);
1051 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1054 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1055 * takes the console lock
1056 * @fb_helper: driver-allocated fbdev helper
1057 * @suspend: whether to suspend or resume
1059 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1060 * isn't available on resume, a worker is tasked with waiting for the lock
1061 * to become available. The console lock can be pretty contented on resume
1062 * due to all the printk activity.
1064 * This function can be called multiple times with the same state since
1065 * &fb_info->state is checked to see if fbdev is running or not before locking.
1067 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1069 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
1072 if (!fb_helper || !fb_helper->fbdev)
1075 /* make sure there's no pending/ongoing resume */
1076 flush_work(&fb_helper->resume_work);
1079 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
1085 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
1088 if (!console_trylock()) {
1089 schedule_work(&fb_helper->resume_work);
1094 fb_set_suspend(fb_helper->fbdev, suspend);
1097 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
1099 static int setcolreg(struct drm_crtc *crtc, u16 red, u16 green,
1100 u16 blue, u16 regno, struct fb_info *info)
1102 struct drm_fb_helper *fb_helper = info->par;
1103 struct drm_framebuffer *fb = fb_helper->fb;
1105 if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
1108 /* place color in psuedopalette */
1111 palette = (u32 *)info->pseudo_palette;
1112 red >>= (16 - info->var.red.length);
1113 green >>= (16 - info->var.green.length);
1114 blue >>= (16 - info->var.blue.length);
1115 value = (red << info->var.red.offset) |
1116 (green << info->var.green.offset) |
1117 (blue << info->var.blue.offset);
1118 if (info->var.transp.length > 0) {
1119 u32 mask = (1 << info->var.transp.length) - 1;
1120 mask <<= info->var.transp.offset;
1123 palette[regno] = value;
1128 * The driver really shouldn't advertise pseudo/directcolor
1129 * visuals if it can't deal with the palette.
1131 if (WARN_ON(!fb_helper->funcs->gamma_set ||
1132 !fb_helper->funcs->gamma_get))
1135 WARN_ON(fb->bits_per_pixel != 8);
1137 fb_helper->funcs->gamma_set(crtc, red, green, blue, regno);
1143 * drm_fb_helper_setcmap - implementation for ->fb_setcmap
1144 * @cmap: cmap to set
1145 * @info: fbdev registered by the helper
1147 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1149 struct drm_fb_helper *fb_helper = info->par;
1150 struct drm_device *dev = fb_helper->dev;
1151 const struct drm_crtc_helper_funcs *crtc_funcs;
1152 u16 *red, *green, *blue, *transp;
1153 struct drm_crtc *crtc;
1157 if (oops_in_progress)
1160 drm_modeset_lock_all(dev);
1161 if (!drm_fb_helper_is_bound(fb_helper)) {
1162 drm_modeset_unlock_all(dev);
1166 for (i = 0; i < fb_helper->crtc_count; i++) {
1167 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1168 crtc_funcs = crtc->helper_private;
1171 green = cmap->green;
1173 transp = cmap->transp;
1174 start = cmap->start;
1176 for (j = 0; j < cmap->len; j++) {
1177 u16 hred, hgreen, hblue, htransp = 0xffff;
1184 htransp = *transp++;
1186 rc = setcolreg(crtc, hred, hgreen, hblue, start++, info);
1190 if (crtc_funcs->load_lut)
1191 crtc_funcs->load_lut(crtc);
1194 drm_modeset_unlock_all(dev);
1197 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1200 * drm_fb_helper_check_var - implementation for ->fb_check_var
1201 * @var: screeninfo to check
1202 * @info: fbdev registered by the helper
1204 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1205 struct fb_info *info)
1207 struct drm_fb_helper *fb_helper = info->par;
1208 struct drm_framebuffer *fb = fb_helper->fb;
1211 if (var->pixclock != 0 || in_dbg_master())
1214 /* Need to resize the fb object !!! */
1215 if (var->bits_per_pixel > fb->bits_per_pixel ||
1216 var->xres > fb->width || var->yres > fb->height ||
1217 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1218 DRM_DEBUG("fb userspace requested width/height/bpp is greater than current fb "
1219 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1220 var->xres, var->yres, var->bits_per_pixel,
1221 var->xres_virtual, var->yres_virtual,
1222 fb->width, fb->height, fb->bits_per_pixel);
1226 switch (var->bits_per_pixel) {
1228 depth = (var->green.length == 6) ? 16 : 15;
1231 depth = (var->transp.length > 0) ? 32 : 24;
1234 depth = var->bits_per_pixel;
1240 var->red.offset = 0;
1241 var->green.offset = 0;
1242 var->blue.offset = 0;
1243 var->red.length = 8;
1244 var->green.length = 8;
1245 var->blue.length = 8;
1246 var->transp.length = 0;
1247 var->transp.offset = 0;
1250 var->red.offset = 10;
1251 var->green.offset = 5;
1252 var->blue.offset = 0;
1253 var->red.length = 5;
1254 var->green.length = 5;
1255 var->blue.length = 5;
1256 var->transp.length = 1;
1257 var->transp.offset = 15;
1260 var->red.offset = 11;
1261 var->green.offset = 5;
1262 var->blue.offset = 0;
1263 var->red.length = 5;
1264 var->green.length = 6;
1265 var->blue.length = 5;
1266 var->transp.length = 0;
1267 var->transp.offset = 0;
1270 var->red.offset = 16;
1271 var->green.offset = 8;
1272 var->blue.offset = 0;
1273 var->red.length = 8;
1274 var->green.length = 8;
1275 var->blue.length = 8;
1276 var->transp.length = 0;
1277 var->transp.offset = 0;
1280 var->red.offset = 16;
1281 var->green.offset = 8;
1282 var->blue.offset = 0;
1283 var->red.length = 8;
1284 var->green.length = 8;
1285 var->blue.length = 8;
1286 var->transp.length = 8;
1287 var->transp.offset = 24;
1294 EXPORT_SYMBOL(drm_fb_helper_check_var);
1297 * drm_fb_helper_set_par - implementation for ->fb_set_par
1298 * @info: fbdev registered by the helper
1300 * This will let fbcon do the mode init and is called at initialization time by
1301 * the fbdev core when registering the driver, and later on through the hotplug
1304 int drm_fb_helper_set_par(struct fb_info *info)
1306 struct drm_fb_helper *fb_helper = info->par;
1307 struct fb_var_screeninfo *var = &info->var;
1309 if (oops_in_progress)
1312 if (var->pixclock != 0) {
1313 DRM_ERROR("PIXEL CLOCK SET\n");
1317 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1321 EXPORT_SYMBOL(drm_fb_helper_set_par);
1323 static int pan_display_atomic(struct fb_var_screeninfo *var,
1324 struct fb_info *info)
1326 struct drm_fb_helper *fb_helper = info->par;
1327 struct drm_device *dev = fb_helper->dev;
1328 struct drm_atomic_state *state;
1329 struct drm_plane *plane;
1331 unsigned plane_mask;
1333 state = drm_atomic_state_alloc(dev);
1337 state->acquire_ctx = dev->mode_config.acquire_ctx;
1340 for(i = 0; i < fb_helper->crtc_count; i++) {
1341 struct drm_mode_set *mode_set;
1343 mode_set = &fb_helper->crtc_info[i].mode_set;
1345 mode_set->x = var->xoffset;
1346 mode_set->y = var->yoffset;
1348 ret = __drm_atomic_helper_set_config(mode_set, state);
1352 plane = mode_set->crtc->primary;
1353 plane_mask |= (1 << drm_plane_index(plane));
1354 plane->old_fb = plane->fb;
1357 ret = drm_atomic_commit(state);
1361 info->var.xoffset = var->xoffset;
1362 info->var.yoffset = var->yoffset;
1366 drm_atomic_clean_old_fb(dev, plane_mask, ret);
1368 if (ret == -EDEADLK)
1372 drm_atomic_state_free(state);
1377 drm_atomic_state_clear(state);
1378 drm_atomic_legacy_backoff(state);
1384 * drm_fb_helper_pan_display - implementation for ->fb_pan_display
1385 * @var: updated screen information
1386 * @info: fbdev registered by the helper
1388 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1389 struct fb_info *info)
1391 struct drm_fb_helper *fb_helper = info->par;
1392 struct drm_device *dev = fb_helper->dev;
1393 struct drm_mode_set *modeset;
1397 if (oops_in_progress)
1400 drm_modeset_lock_all(dev);
1401 if (!drm_fb_helper_is_bound(fb_helper)) {
1402 drm_modeset_unlock_all(dev);
1406 if (dev->mode_config.funcs->atomic_commit) {
1407 ret = pan_display_atomic(var, info);
1411 for (i = 0; i < fb_helper->crtc_count; i++) {
1412 modeset = &fb_helper->crtc_info[i].mode_set;
1414 modeset->x = var->xoffset;
1415 modeset->y = var->yoffset;
1417 if (modeset->num_connectors) {
1418 ret = drm_mode_set_config_internal(modeset);
1420 info->var.xoffset = var->xoffset;
1421 info->var.yoffset = var->yoffset;
1426 drm_modeset_unlock_all(dev);
1429 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1432 * Allocates the backing storage and sets up the fbdev info structure through
1433 * the ->fb_probe callback and then registers the fbdev and sets up the panic
1436 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1442 struct fb_info *info;
1443 struct drm_fb_helper_surface_size sizes;
1446 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1447 sizes.surface_depth = 24;
1448 sizes.surface_bpp = 32;
1449 sizes.fb_width = (unsigned)-1;
1450 sizes.fb_height = (unsigned)-1;
1452 /* if driver picks 8 or 16 by default use that
1453 for both depth/bpp */
1454 if (preferred_bpp != sizes.surface_bpp)
1455 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1457 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1458 for (i = 0; i < fb_helper->connector_count; i++) {
1459 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1460 struct drm_cmdline_mode *cmdline_mode;
1462 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1464 if (cmdline_mode->bpp_specified) {
1465 switch (cmdline_mode->bpp) {
1467 sizes.surface_depth = sizes.surface_bpp = 8;
1470 sizes.surface_depth = 15;
1471 sizes.surface_bpp = 16;
1474 sizes.surface_depth = sizes.surface_bpp = 16;
1477 sizes.surface_depth = sizes.surface_bpp = 24;
1480 sizes.surface_depth = 24;
1481 sizes.surface_bpp = 32;
1489 for (i = 0; i < fb_helper->crtc_count; i++) {
1490 struct drm_display_mode *desired_mode;
1491 struct drm_mode_set *mode_set;
1493 /* in case of tile group, are we the last tile vert or horiz?
1494 * If no tile group you are always the last one both vertically
1497 bool lastv = true, lasth = true;
1499 desired_mode = fb_helper->crtc_info[i].desired_mode;
1500 mode_set = &fb_helper->crtc_info[i].mode_set;
1507 x = fb_helper->crtc_info[i].x;
1508 y = fb_helper->crtc_info[i].y;
1510 if (gamma_size == 0)
1511 gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1513 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1514 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1516 for (j = 0; j < mode_set->num_connectors; j++) {
1517 struct drm_connector *connector = mode_set->connectors[j];
1518 if (connector->has_tile) {
1519 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1520 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1521 /* cloning to multiple tiles is just crazy-talk, so: */
1527 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1529 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1532 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1533 /* hmm everyone went away - assume VGA cable just fell out
1534 and will come back later. */
1535 DRM_INFO("Cannot find any crtc or sizes - going 1024x768\n");
1536 sizes.fb_width = sizes.surface_width = 1024;
1537 sizes.fb_height = sizes.surface_height = 768;
1540 /* push down into drivers */
1541 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1545 info = fb_helper->fbdev;
1548 * Set the fb pointer - usually drm_setup_crtcs does this for hotplug
1549 * events, but at init time drm_setup_crtcs needs to be called before
1550 * the fb is allocated (since we need to figure out the desired size of
1551 * the fb before we can allocate it ...). Hence we need to fix things up
1554 for (i = 0; i < fb_helper->crtc_count; i++)
1555 if (fb_helper->crtc_info[i].mode_set.num_connectors)
1556 fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
1559 info->var.pixclock = 0;
1560 if (register_framebuffer(info) < 0)
1563 dev_info(fb_helper->dev->dev, "fb%d: %s frame buffer device\n",
1564 info->node, info->fix.id);
1566 if (list_empty(&kernel_fb_helper_list)) {
1567 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1570 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1576 * drm_fb_helper_fill_fix - initializes fixed fbdev information
1577 * @info: fbdev registered by the helper
1578 * @pitch: desired pitch
1579 * @depth: desired depth
1581 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1582 * fbdev emulations. Drivers which support acceleration methods which impose
1583 * additional constraints need to set up their own limits.
1585 * Drivers should call this (or their equivalent setup code) from their
1586 * ->fb_probe callback.
1588 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1591 info->fix.type = FB_TYPE_PACKED_PIXELS;
1592 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1593 FB_VISUAL_TRUECOLOR;
1594 info->fix.mmio_start = 0;
1595 info->fix.mmio_len = 0;
1596 info->fix.type_aux = 0;
1597 info->fix.xpanstep = 1; /* doing it in hw */
1598 info->fix.ypanstep = 1; /* doing it in hw */
1599 info->fix.ywrapstep = 0;
1600 info->fix.accel = FB_ACCEL_NONE;
1602 info->fix.line_length = pitch;
1605 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1608 * drm_fb_helper_fill_var - initalizes variable fbdev information
1609 * @info: fbdev instance to set up
1610 * @fb_helper: fb helper instance to use as template
1611 * @fb_width: desired fb width
1612 * @fb_height: desired fb height
1614 * Sets up the variable fbdev metainformation from the given fb helper instance
1615 * and the drm framebuffer allocated in fb_helper->fb.
1617 * Drivers should call this (or their equivalent setup code) from their
1618 * ->fb_probe callback after having allocated the fbdev backing
1619 * storage framebuffer.
1621 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1622 uint32_t fb_width, uint32_t fb_height)
1624 struct drm_framebuffer *fb = fb_helper->fb;
1625 info->pseudo_palette = fb_helper->pseudo_palette;
1626 info->var.xres_virtual = fb->width;
1627 info->var.yres_virtual = fb->height;
1628 info->var.bits_per_pixel = fb->bits_per_pixel;
1629 info->var.accel_flags = FB_ACCELF_TEXT;
1630 info->var.xoffset = 0;
1631 info->var.yoffset = 0;
1632 info->var.activate = FB_ACTIVATE_NOW;
1633 info->var.height = -1;
1634 info->var.width = -1;
1636 switch (fb->depth) {
1638 info->var.red.offset = 0;
1639 info->var.green.offset = 0;
1640 info->var.blue.offset = 0;
1641 info->var.red.length = 8; /* 8bit DAC */
1642 info->var.green.length = 8;
1643 info->var.blue.length = 8;
1644 info->var.transp.offset = 0;
1645 info->var.transp.length = 0;
1648 info->var.red.offset = 10;
1649 info->var.green.offset = 5;
1650 info->var.blue.offset = 0;
1651 info->var.red.length = 5;
1652 info->var.green.length = 5;
1653 info->var.blue.length = 5;
1654 info->var.transp.offset = 15;
1655 info->var.transp.length = 1;
1658 info->var.red.offset = 11;
1659 info->var.green.offset = 5;
1660 info->var.blue.offset = 0;
1661 info->var.red.length = 5;
1662 info->var.green.length = 6;
1663 info->var.blue.length = 5;
1664 info->var.transp.offset = 0;
1667 info->var.red.offset = 16;
1668 info->var.green.offset = 8;
1669 info->var.blue.offset = 0;
1670 info->var.red.length = 8;
1671 info->var.green.length = 8;
1672 info->var.blue.length = 8;
1673 info->var.transp.offset = 0;
1674 info->var.transp.length = 0;
1677 info->var.red.offset = 16;
1678 info->var.green.offset = 8;
1679 info->var.blue.offset = 0;
1680 info->var.red.length = 8;
1681 info->var.green.length = 8;
1682 info->var.blue.length = 8;
1683 info->var.transp.offset = 24;
1684 info->var.transp.length = 8;
1690 info->var.xres = fb_width;
1691 info->var.yres = fb_height;
1693 EXPORT_SYMBOL(drm_fb_helper_fill_var);
1695 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
1699 struct drm_connector *connector;
1703 for (i = 0; i < fb_helper->connector_count; i++) {
1704 connector = fb_helper->connector_info[i]->connector;
1705 count += connector->funcs->fill_modes(connector, maxX, maxY);
1711 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
1713 struct drm_display_mode *mode;
1715 list_for_each_entry(mode, &fb_connector->connector->modes, head) {
1716 if (mode->hdisplay > width ||
1717 mode->vdisplay > height)
1719 if (mode->type & DRM_MODE_TYPE_PREFERRED)
1724 EXPORT_SYMBOL(drm_has_preferred_mode);
1726 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
1728 return fb_connector->connector->cmdline_mode.specified;
1731 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
1732 int width, int height)
1734 struct drm_cmdline_mode *cmdline_mode;
1735 struct drm_display_mode *mode;
1736 bool prefer_non_interlace;
1738 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1739 if (cmdline_mode->specified == false)
1742 /* attempt to find a matching mode in the list of modes
1743 * we have gotten so far, if not add a CVT mode that conforms
1745 if (cmdline_mode->rb || cmdline_mode->margins)
1748 prefer_non_interlace = !cmdline_mode->interlace;
1750 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1751 /* check width/height */
1752 if (mode->hdisplay != cmdline_mode->xres ||
1753 mode->vdisplay != cmdline_mode->yres)
1756 if (cmdline_mode->refresh_specified) {
1757 if (mode->vrefresh != cmdline_mode->refresh)
1761 if (cmdline_mode->interlace) {
1762 if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
1764 } else if (prefer_non_interlace) {
1765 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
1771 if (prefer_non_interlace) {
1772 prefer_non_interlace = false;
1777 mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
1779 list_add(&mode->head, &fb_helper_conn->connector->modes);
1782 EXPORT_SYMBOL(drm_pick_cmdline_mode);
1784 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
1789 enable = connector->status == connector_status_connected;
1791 enable = connector->status != connector_status_disconnected;
1796 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
1799 bool any_enabled = false;
1800 struct drm_connector *connector;
1803 for (i = 0; i < fb_helper->connector_count; i++) {
1804 connector = fb_helper->connector_info[i]->connector;
1805 enabled[i] = drm_connector_enabled(connector, true);
1806 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
1807 enabled[i] ? "yes" : "no");
1808 any_enabled |= enabled[i];
1814 for (i = 0; i < fb_helper->connector_count; i++) {
1815 connector = fb_helper->connector_info[i]->connector;
1816 enabled[i] = drm_connector_enabled(connector, false);
1820 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
1821 struct drm_display_mode **modes,
1822 struct drm_fb_offset *offsets,
1823 bool *enabled, int width, int height)
1826 bool can_clone = false;
1827 struct drm_fb_helper_connector *fb_helper_conn;
1828 struct drm_display_mode *dmt_mode, *mode;
1830 /* only contemplate cloning in the single crtc case */
1831 if (fb_helper->crtc_count > 1)
1835 for (i = 0; i < fb_helper->connector_count; i++) {
1840 /* only contemplate cloning if more than one connector is enabled */
1844 /* check the command line or if nothing common pick 1024x768 */
1846 for (i = 0; i < fb_helper->connector_count; i++) {
1849 fb_helper_conn = fb_helper->connector_info[i];
1850 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1855 for (j = 0; j < i; j++) {
1858 if (!drm_mode_equal(modes[j], modes[i]))
1864 DRM_DEBUG_KMS("can clone using command line\n");
1868 /* try and find a 1024x768 mode on each connector */
1870 dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
1872 for (i = 0; i < fb_helper->connector_count; i++) {
1877 fb_helper_conn = fb_helper->connector_info[i];
1878 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1879 if (drm_mode_equal(mode, dmt_mode))
1887 DRM_DEBUG_KMS("can clone using 1024x768\n");
1890 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
1894 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
1895 struct drm_display_mode **modes,
1896 struct drm_fb_offset *offsets,
1898 int h_idx, int v_idx)
1900 struct drm_fb_helper_connector *fb_helper_conn;
1902 int hoffset = 0, voffset = 0;
1904 for (i = 0; i < fb_helper->connector_count; i++) {
1905 fb_helper_conn = fb_helper->connector_info[i];
1906 if (!fb_helper_conn->connector->has_tile)
1909 if (!modes[i] && (h_idx || v_idx)) {
1910 DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
1911 fb_helper_conn->connector->base.id);
1914 if (fb_helper_conn->connector->tile_h_loc < h_idx)
1915 hoffset += modes[i]->hdisplay;
1917 if (fb_helper_conn->connector->tile_v_loc < v_idx)
1918 voffset += modes[i]->vdisplay;
1920 offsets[idx].x = hoffset;
1921 offsets[idx].y = voffset;
1922 DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
1926 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
1927 struct drm_display_mode **modes,
1928 struct drm_fb_offset *offsets,
1929 bool *enabled, int width, int height)
1931 struct drm_fb_helper_connector *fb_helper_conn;
1933 uint64_t conn_configured = 0, mask;
1935 mask = (1 << fb_helper->connector_count) - 1;
1937 for (i = 0; i < fb_helper->connector_count; i++) {
1938 fb_helper_conn = fb_helper->connector_info[i];
1940 if (conn_configured & (1 << i))
1943 if (enabled[i] == false) {
1944 conn_configured |= (1 << i);
1948 /* first pass over all the untiled connectors */
1949 if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
1952 if (tile_pass == 1) {
1953 if (fb_helper_conn->connector->tile_h_loc != 0 ||
1954 fb_helper_conn->connector->tile_v_loc != 0)
1958 if (fb_helper_conn->connector->tile_h_loc != tile_pass -1 &&
1959 fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
1960 /* if this tile_pass doesn't cover any of the tiles - keep going */
1963 /* find the tile offsets for this pass - need
1964 to find all tiles left and above */
1965 drm_get_tile_offsets(fb_helper, modes, offsets,
1966 i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
1968 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
1969 fb_helper_conn->connector->base.id);
1971 /* got for command line mode first */
1972 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1974 DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
1975 fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
1976 modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
1978 /* No preferred modes, pick one off the list */
1979 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
1980 list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
1983 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
1985 conn_configured |= (1 << i);
1988 if ((conn_configured & mask) != mask) {
1995 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
1996 struct drm_fb_helper_crtc **best_crtcs,
1997 struct drm_display_mode **modes,
1998 int n, int width, int height)
2001 struct drm_connector *connector;
2002 const struct drm_connector_helper_funcs *connector_funcs;
2003 struct drm_encoder *encoder;
2004 int my_score, best_score, score;
2005 struct drm_fb_helper_crtc **crtcs, *crtc;
2006 struct drm_fb_helper_connector *fb_helper_conn;
2008 if (n == fb_helper->connector_count)
2011 fb_helper_conn = fb_helper->connector_info[n];
2012 connector = fb_helper_conn->connector;
2014 best_crtcs[n] = NULL;
2015 best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
2016 if (modes[n] == NULL)
2019 crtcs = kzalloc(fb_helper->connector_count *
2020 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2025 if (connector->status == connector_status_connected)
2027 if (drm_has_cmdline_mode(fb_helper_conn))
2029 if (drm_has_preferred_mode(fb_helper_conn, width, height))
2032 connector_funcs = connector->helper_private;
2035 * If the DRM device implements atomic hooks and ->best_encoder() is
2036 * NULL we fallback to the default drm_atomic_helper_best_encoder()
2039 if (fb_helper->dev->mode_config.funcs->atomic_commit &&
2040 !connector_funcs->best_encoder)
2041 encoder = drm_atomic_helper_best_encoder(connector);
2043 encoder = connector_funcs->best_encoder(connector);
2048 /* select a crtc for this connector and then attempt to configure
2049 remaining connectors */
2050 for (c = 0; c < fb_helper->crtc_count; c++) {
2051 crtc = &fb_helper->crtc_info[c];
2053 if ((encoder->possible_crtcs & (1 << c)) == 0)
2056 for (o = 0; o < n; o++)
2057 if (best_crtcs[o] == crtc)
2061 /* ignore cloning unless only a single crtc */
2062 if (fb_helper->crtc_count > 1)
2065 if (!drm_mode_equal(modes[o], modes[n]))
2070 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
2071 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
2073 if (score > best_score) {
2075 memcpy(best_crtcs, crtcs,
2076 fb_helper->connector_count *
2077 sizeof(struct drm_fb_helper_crtc *));
2085 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper)
2087 struct drm_device *dev = fb_helper->dev;
2088 struct drm_fb_helper_crtc **crtcs;
2089 struct drm_display_mode **modes;
2090 struct drm_fb_offset *offsets;
2091 struct drm_mode_set *modeset;
2096 DRM_DEBUG_KMS("\n");
2098 width = dev->mode_config.max_width;
2099 height = dev->mode_config.max_height;
2101 crtcs = kcalloc(fb_helper->connector_count,
2102 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2103 modes = kcalloc(fb_helper->connector_count,
2104 sizeof(struct drm_display_mode *), GFP_KERNEL);
2105 offsets = kcalloc(fb_helper->connector_count,
2106 sizeof(struct drm_fb_offset), GFP_KERNEL);
2107 enabled = kcalloc(fb_helper->connector_count,
2108 sizeof(bool), GFP_KERNEL);
2109 if (!crtcs || !modes || !enabled || !offsets) {
2110 DRM_ERROR("Memory allocation failed\n");
2115 drm_enable_connectors(fb_helper, enabled);
2117 if (!(fb_helper->funcs->initial_config &&
2118 fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2120 enabled, width, height))) {
2121 memset(modes, 0, fb_helper->connector_count*sizeof(modes[0]));
2122 memset(crtcs, 0, fb_helper->connector_count*sizeof(crtcs[0]));
2123 memset(offsets, 0, fb_helper->connector_count*sizeof(offsets[0]));
2125 if (!drm_target_cloned(fb_helper, modes, offsets,
2126 enabled, width, height) &&
2127 !drm_target_preferred(fb_helper, modes, offsets,
2128 enabled, width, height))
2129 DRM_ERROR("Unable to find initial modes\n");
2131 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2134 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2137 /* need to set the modesets up here for use later */
2138 /* fill out the connector<->crtc mappings into the modesets */
2139 for (i = 0; i < fb_helper->crtc_count; i++) {
2140 modeset = &fb_helper->crtc_info[i].mode_set;
2141 modeset->num_connectors = 0;
2145 for (i = 0; i < fb_helper->connector_count; i++) {
2146 struct drm_display_mode *mode = modes[i];
2147 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2148 struct drm_fb_offset *offset = &offsets[i];
2149 modeset = &fb_crtc->mode_set;
2151 if (mode && fb_crtc) {
2152 DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2153 mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2154 fb_crtc->desired_mode = mode;
2155 fb_crtc->x = offset->x;
2156 fb_crtc->y = offset->y;
2158 drm_mode_destroy(dev, modeset->mode);
2159 modeset->mode = drm_mode_duplicate(dev,
2160 fb_crtc->desired_mode);
2161 modeset->connectors[modeset->num_connectors++] = fb_helper->connector_info[i]->connector;
2162 modeset->fb = fb_helper->fb;
2163 modeset->x = offset->x;
2164 modeset->y = offset->y;
2168 /* Clear out any old modes if there are no more connected outputs. */
2169 for (i = 0; i < fb_helper->crtc_count; i++) {
2170 modeset = &fb_helper->crtc_info[i].mode_set;
2171 if (modeset->num_connectors == 0) {
2172 BUG_ON(modeset->fb);
2174 drm_mode_destroy(dev, modeset->mode);
2175 modeset->mode = NULL;
2186 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2187 * @fb_helper: fb_helper device struct
2188 * @bpp_sel: bpp value to use for the framebuffer configuration
2190 * Scans the CRTCs and connectors and tries to put together an initial setup.
2191 * At the moment, this is a cloned configuration across all heads with
2192 * a new framebuffer object as the backing store.
2194 * Note that this also registers the fbdev and so allows userspace to call into
2195 * the driver through the fbdev interfaces.
2197 * This function will call down into the ->fb_probe callback to let
2198 * the driver allocate and initialize the fbdev info structure and the drm
2199 * framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2200 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2201 * values for the fbdev info structure.
2205 * When you have fbcon support built-in or already loaded, this function will do
2206 * a full modeset to setup the fbdev console. Due to locking misdesign in the
2207 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2208 * console_lock. Until console_unlock is called no dmesg lines will be sent out
2209 * to consoles, not even serial console. This means when your driver crashes,
2210 * you will see absolutely nothing else but a system stuck in this function,
2211 * with no further output. Any kind of printk() you place within your own driver
2212 * or in the drm core modeset code will also never show up.
2214 * Standard debug practice is to run the fbcon setup without taking the
2215 * console_lock as a hack, to be able to see backtraces and crashes on the
2216 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2219 * The other option is to just disable fbdev emulation since very likely the
2220 * first modeset from userspace will crash in the same way, and is even easier
2221 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2222 * kernel cmdline option.
2225 * Zero if everything went ok, nonzero otherwise.
2227 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2229 struct drm_device *dev = fb_helper->dev;
2232 if (!drm_fbdev_emulation)
2235 mutex_lock(&dev->mode_config.mutex);
2236 count = drm_fb_helper_probe_connector_modes(fb_helper,
2237 dev->mode_config.max_width,
2238 dev->mode_config.max_height);
2239 mutex_unlock(&dev->mode_config.mutex);
2241 * we shouldn't end up with no modes here.
2244 dev_info(fb_helper->dev->dev, "No connectors reported connected with modes\n");
2246 drm_setup_crtcs(fb_helper);
2248 return drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2250 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2253 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2254 * probing all the outputs attached to the fb
2255 * @fb_helper: the drm_fb_helper
2257 * Scan the connectors attached to the fb_helper and try to put together a
2258 * setup after notification of a change in output configuration.
2260 * Called at runtime, takes the mode config locks to be able to check/change the
2261 * modeset configuration. Must be run from process context (which usually means
2262 * either the output polling work or a work item launched from the driver's
2263 * hotplug interrupt).
2265 * Note that drivers may call this even before calling
2266 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2267 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2268 * not miss any hotplug events.
2271 * 0 on success and a non-zero error code otherwise.
2273 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2275 struct drm_device *dev = fb_helper->dev;
2276 u32 max_width, max_height;
2278 if (!drm_fbdev_emulation)
2281 mutex_lock(&fb_helper->dev->mode_config.mutex);
2282 if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2283 fb_helper->delayed_hotplug = true;
2284 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2287 DRM_DEBUG_KMS("\n");
2289 max_width = fb_helper->fb->width;
2290 max_height = fb_helper->fb->height;
2292 drm_fb_helper_probe_connector_modes(fb_helper, max_width, max_height);
2293 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2295 drm_modeset_lock_all(dev);
2296 drm_setup_crtcs(fb_helper);
2297 drm_modeset_unlock_all(dev);
2298 drm_fb_helper_set_par(fb_helper->fbdev);
2302 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2304 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2305 * but the module doesn't depend on any fb console symbols. At least
2306 * attempt to load fbcon to avoid leaving the system without a usable console.
2308 int __init drm_fb_helper_modinit(void)
2310 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2311 const char *name = "fbcon";
2312 struct module *fbcon;
2314 mutex_lock(&module_mutex);
2315 fbcon = find_module(name);
2316 mutex_unlock(&module_mutex);
2319 request_module_nowait(name);
2323 EXPORT_SYMBOL(drm_fb_helper_modinit);