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);
370 drm_atomic_state_put(state);
374 drm_atomic_state_clear(state);
375 drm_atomic_legacy_backoff(state);
380 static int restore_fbdev_mode(struct drm_fb_helper *fb_helper)
382 struct drm_device *dev = fb_helper->dev;
383 struct drm_plane *plane;
386 drm_warn_on_modeset_not_all_locked(dev);
388 if (dev->mode_config.funcs->atomic_commit)
389 return restore_fbdev_mode_atomic(fb_helper);
391 drm_for_each_plane(plane, dev) {
392 if (plane->type != DRM_PLANE_TYPE_PRIMARY)
393 drm_plane_force_disable(plane);
395 if (plane->rotation_property) {
396 drm_mode_plane_set_obj_prop(plane,
397 plane->rotation_property,
399 } else if (dev->mode_config.rotation_property) {
400 drm_mode_plane_set_obj_prop(plane,
401 dev->mode_config.rotation_property,
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_crtc *crtc = mode_set->crtc;
411 if (crtc->funcs->cursor_set2) {
412 ret = crtc->funcs->cursor_set2(crtc, NULL, 0, 0, 0, 0, 0);
415 } else if (crtc->funcs->cursor_set) {
416 ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
421 ret = drm_mode_set_config_internal(mode_set);
430 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
431 * @fb_helper: fbcon to restore
433 * This should be called from driver's drm ->lastclose callback
434 * when implementing an fbcon on top of kms using this helper. This ensures that
435 * the user isn't greeted with a black screen when e.g. X dies.
438 * Zero if everything went ok, negative error code otherwise.
440 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
442 struct drm_device *dev = fb_helper->dev;
446 if (!drm_fbdev_emulation)
449 drm_modeset_lock_all(dev);
450 ret = restore_fbdev_mode(fb_helper);
452 do_delayed = fb_helper->delayed_hotplug;
454 fb_helper->delayed_hotplug = false;
455 drm_modeset_unlock_all(dev);
458 drm_fb_helper_hotplug_event(fb_helper);
461 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
463 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
465 struct drm_device *dev = fb_helper->dev;
466 struct drm_crtc *crtc;
467 int bound = 0, crtcs_bound = 0;
469 /* Sometimes user space wants everything disabled, so don't steal the
470 * display if there's a master. */
471 if (READ_ONCE(dev->master))
474 drm_for_each_crtc(crtc, dev) {
475 if (crtc->primary->fb)
477 if (crtc->primary->fb == fb_helper->fb)
481 if (bound < crtcs_bound)
487 #ifdef CONFIG_MAGIC_SYSRQ
489 * restore fbcon display for all kms driver's using this helper, used for sysrq
490 * and panic handling.
492 static bool drm_fb_helper_force_kernel_mode(void)
494 bool ret, error = false;
495 struct drm_fb_helper *helper;
497 if (list_empty(&kernel_fb_helper_list))
500 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
501 struct drm_device *dev = helper->dev;
503 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
506 drm_modeset_lock_all(dev);
507 ret = restore_fbdev_mode(helper);
510 drm_modeset_unlock_all(dev);
515 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
518 ret = drm_fb_helper_force_kernel_mode();
520 DRM_ERROR("Failed to restore crtc configuration\n");
522 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
524 static void drm_fb_helper_sysrq(int dummy1)
526 schedule_work(&drm_fb_helper_restore_work);
529 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
530 .handler = drm_fb_helper_sysrq,
531 .help_msg = "force-fb(V)",
532 .action_msg = "Restore framebuffer console",
535 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
538 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
540 struct drm_fb_helper *fb_helper = info->par;
541 struct drm_device *dev = fb_helper->dev;
542 struct drm_crtc *crtc;
543 struct drm_connector *connector;
547 * For each CRTC in this fb, turn the connectors on/off.
549 drm_modeset_lock_all(dev);
550 if (!drm_fb_helper_is_bound(fb_helper)) {
551 drm_modeset_unlock_all(dev);
555 for (i = 0; i < fb_helper->crtc_count; i++) {
556 crtc = fb_helper->crtc_info[i].mode_set.crtc;
561 /* Walk the connectors & encoders on this fb turning them on/off */
562 for (j = 0; j < fb_helper->connector_count; j++) {
563 connector = fb_helper->connector_info[j]->connector;
564 connector->funcs->dpms(connector, dpms_mode);
565 drm_object_property_set_value(&connector->base,
566 dev->mode_config.dpms_property, dpms_mode);
569 drm_modeset_unlock_all(dev);
573 * drm_fb_helper_blank - implementation for ->fb_blank
574 * @blank: desired blanking state
575 * @info: fbdev registered by the helper
577 int drm_fb_helper_blank(int blank, struct fb_info *info)
579 if (oops_in_progress)
583 /* Display: On; HSync: On, VSync: On */
584 case FB_BLANK_UNBLANK:
585 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
587 /* Display: Off; HSync: On, VSync: On */
588 case FB_BLANK_NORMAL:
589 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
591 /* Display: Off; HSync: Off, VSync: On */
592 case FB_BLANK_HSYNC_SUSPEND:
593 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
595 /* Display: Off; HSync: On, VSync: Off */
596 case FB_BLANK_VSYNC_SUSPEND:
597 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
599 /* Display: Off; HSync: Off, VSync: Off */
600 case FB_BLANK_POWERDOWN:
601 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
606 EXPORT_SYMBOL(drm_fb_helper_blank);
608 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
612 for (i = 0; i < helper->connector_count; i++) {
613 drm_connector_unreference(helper->connector_info[i]->connector);
614 kfree(helper->connector_info[i]);
616 kfree(helper->connector_info);
617 for (i = 0; i < helper->crtc_count; i++) {
618 kfree(helper->crtc_info[i].mode_set.connectors);
619 if (helper->crtc_info[i].mode_set.mode)
620 drm_mode_destroy(helper->dev, helper->crtc_info[i].mode_set.mode);
622 kfree(helper->crtc_info);
625 static void drm_fb_helper_resume_worker(struct work_struct *work)
627 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
631 fb_set_suspend(helper->fbdev, 0);
635 static void drm_fb_helper_dirty_work(struct work_struct *work)
637 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
639 struct drm_clip_rect *clip = &helper->dirty_clip;
640 struct drm_clip_rect clip_copy;
643 spin_lock_irqsave(&helper->dirty_lock, flags);
645 clip->x1 = clip->y1 = ~0;
646 clip->x2 = clip->y2 = 0;
647 spin_unlock_irqrestore(&helper->dirty_lock, flags);
649 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
653 * drm_fb_helper_prepare - setup a drm_fb_helper structure
655 * @helper: driver-allocated fbdev helper structure to set up
656 * @funcs: pointer to structure of functions associate with this helper
658 * Sets up the bare minimum to make the framebuffer helper usable. This is
659 * useful to implement race-free initialization of the polling helpers.
661 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
662 const struct drm_fb_helper_funcs *funcs)
664 INIT_LIST_HEAD(&helper->kernel_fb_list);
665 spin_lock_init(&helper->dirty_lock);
666 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
667 INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
668 helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
669 helper->funcs = funcs;
672 EXPORT_SYMBOL(drm_fb_helper_prepare);
675 * drm_fb_helper_init - initialize a drm_fb_helper structure
677 * @fb_helper: driver-allocated fbdev helper structure to initialize
678 * @crtc_count: maximum number of crtcs to support in this fbdev emulation
679 * @max_conn_count: max connector count
681 * This allocates the structures for the fbdev helper with the given limits.
682 * Note that this won't yet touch the hardware (through the driver interfaces)
683 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
684 * to allow driver writes more control over the exact init sequence.
686 * Drivers must call drm_fb_helper_prepare() before calling this function.
689 * Zero if everything went ok, nonzero otherwise.
691 int drm_fb_helper_init(struct drm_device *dev,
692 struct drm_fb_helper *fb_helper,
693 int crtc_count, int max_conn_count)
695 struct drm_crtc *crtc;
698 if (!drm_fbdev_emulation)
704 fb_helper->crtc_info = kcalloc(crtc_count, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
705 if (!fb_helper->crtc_info)
708 fb_helper->crtc_count = crtc_count;
709 fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
710 if (!fb_helper->connector_info) {
711 kfree(fb_helper->crtc_info);
714 fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
715 fb_helper->connector_count = 0;
717 for (i = 0; i < crtc_count; i++) {
718 fb_helper->crtc_info[i].mode_set.connectors =
719 kcalloc(max_conn_count,
720 sizeof(struct drm_connector *),
723 if (!fb_helper->crtc_info[i].mode_set.connectors)
725 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
729 drm_for_each_crtc(crtc, dev) {
730 fb_helper->crtc_info[i].mode_set.crtc = crtc;
736 drm_fb_helper_crtc_free(fb_helper);
739 EXPORT_SYMBOL(drm_fb_helper_init);
742 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
743 * @fb_helper: driver-allocated fbdev helper
745 * A helper to alloc fb_info and the members cmap and apertures. Called
746 * by the driver within the fb_probe fb_helper callback function.
749 * fb_info pointer if things went okay, pointer containing error code
752 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
754 struct device *dev = fb_helper->dev->dev;
755 struct fb_info *info;
758 info = framebuffer_alloc(0, dev);
760 return ERR_PTR(-ENOMEM);
762 ret = fb_alloc_cmap(&info->cmap, 256, 0);
766 info->apertures = alloc_apertures(1);
767 if (!info->apertures) {
772 fb_helper->fbdev = info;
777 fb_dealloc_cmap(&info->cmap);
779 framebuffer_release(info);
782 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
785 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
786 * @fb_helper: driver-allocated fbdev helper
788 * A wrapper around unregister_framebuffer, to release the fb_info
791 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
793 if (fb_helper && fb_helper->fbdev)
794 unregister_framebuffer(fb_helper->fbdev);
796 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
799 * drm_fb_helper_release_fbi - dealloc fb_info and its members
800 * @fb_helper: driver-allocated fbdev helper
802 * A helper to free memory taken by fb_info and the members cmap and
805 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
808 struct fb_info *info = fb_helper->fbdev;
812 fb_dealloc_cmap(&info->cmap);
813 framebuffer_release(info);
816 fb_helper->fbdev = NULL;
819 EXPORT_SYMBOL(drm_fb_helper_release_fbi);
821 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
823 if (!drm_fbdev_emulation)
826 if (!list_empty(&fb_helper->kernel_fb_list)) {
827 list_del(&fb_helper->kernel_fb_list);
828 if (list_empty(&kernel_fb_helper_list)) {
829 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
833 drm_fb_helper_crtc_free(fb_helper);
836 EXPORT_SYMBOL(drm_fb_helper_fini);
839 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
840 * @fb_helper: driver-allocated fbdev helper
842 * A wrapper around unlink_framebuffer implemented by fbdev core
844 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
846 if (fb_helper && fb_helper->fbdev)
847 unlink_framebuffer(fb_helper->fbdev);
849 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
851 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
852 u32 width, u32 height)
854 struct drm_fb_helper *helper = info->par;
855 struct drm_clip_rect *clip = &helper->dirty_clip;
858 if (!helper->fb->funcs->dirty)
861 spin_lock_irqsave(&helper->dirty_lock, flags);
862 clip->x1 = min_t(u32, clip->x1, x);
863 clip->y1 = min_t(u32, clip->y1, y);
864 clip->x2 = max_t(u32, clip->x2, x + width);
865 clip->y2 = max_t(u32, clip->y2, y + height);
866 spin_unlock_irqrestore(&helper->dirty_lock, flags);
868 schedule_work(&helper->dirty_work);
872 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
873 * @info: fb_info struct pointer
874 * @pagelist: list of dirty mmap framebuffer pages
876 * This function is used as the &fb_deferred_io ->deferred_io
877 * callback function for flushing the fbdev mmap writes.
879 void drm_fb_helper_deferred_io(struct fb_info *info,
880 struct list_head *pagelist)
882 unsigned long start, end, min, max;
888 list_for_each_entry(page, pagelist, lru) {
889 start = page->index << PAGE_SHIFT;
890 end = start + PAGE_SIZE - 1;
891 min = min(min, start);
896 y1 = min / info->fix.line_length;
897 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
899 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
902 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
905 * drm_fb_helper_sys_read - wrapper around fb_sys_read
906 * @info: fb_info struct pointer
907 * @buf: userspace buffer to read from framebuffer memory
908 * @count: number of bytes to read from framebuffer memory
909 * @ppos: read offset within framebuffer memory
911 * A wrapper around fb_sys_read implemented by fbdev core
913 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
914 size_t count, loff_t *ppos)
916 return fb_sys_read(info, buf, count, ppos);
918 EXPORT_SYMBOL(drm_fb_helper_sys_read);
921 * drm_fb_helper_sys_write - wrapper around fb_sys_write
922 * @info: fb_info struct pointer
923 * @buf: userspace buffer to write to framebuffer memory
924 * @count: number of bytes to write to framebuffer memory
925 * @ppos: write offset within framebuffer memory
927 * A wrapper around fb_sys_write implemented by fbdev core
929 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
930 size_t count, loff_t *ppos)
934 ret = fb_sys_write(info, buf, count, ppos);
936 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
941 EXPORT_SYMBOL(drm_fb_helper_sys_write);
944 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
945 * @info: fbdev registered by the helper
946 * @rect: info about rectangle to fill
948 * A wrapper around sys_fillrect implemented by fbdev core
950 void drm_fb_helper_sys_fillrect(struct fb_info *info,
951 const struct fb_fillrect *rect)
953 sys_fillrect(info, rect);
954 drm_fb_helper_dirty(info, rect->dx, rect->dy,
955 rect->width, rect->height);
957 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
960 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
961 * @info: fbdev registered by the helper
962 * @area: info about area to copy
964 * A wrapper around sys_copyarea implemented by fbdev core
966 void drm_fb_helper_sys_copyarea(struct fb_info *info,
967 const struct fb_copyarea *area)
969 sys_copyarea(info, area);
970 drm_fb_helper_dirty(info, area->dx, area->dy,
971 area->width, area->height);
973 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
976 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
977 * @info: fbdev registered by the helper
978 * @image: info about image to blit
980 * A wrapper around sys_imageblit implemented by fbdev core
982 void drm_fb_helper_sys_imageblit(struct fb_info *info,
983 const struct fb_image *image)
985 sys_imageblit(info, image);
986 drm_fb_helper_dirty(info, image->dx, image->dy,
987 image->width, image->height);
989 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
992 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
993 * @info: fbdev registered by the helper
994 * @rect: info about rectangle to fill
996 * A wrapper around cfb_imageblit implemented by fbdev core
998 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
999 const struct fb_fillrect *rect)
1001 cfb_fillrect(info, rect);
1002 drm_fb_helper_dirty(info, rect->dx, rect->dy,
1003 rect->width, rect->height);
1005 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
1008 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1009 * @info: fbdev registered by the helper
1010 * @area: info about area to copy
1012 * A wrapper around cfb_copyarea implemented by fbdev core
1014 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1015 const struct fb_copyarea *area)
1017 cfb_copyarea(info, area);
1018 drm_fb_helper_dirty(info, area->dx, area->dy,
1019 area->width, area->height);
1021 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1024 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1025 * @info: fbdev registered by the helper
1026 * @image: info about image to blit
1028 * A wrapper around cfb_imageblit implemented by fbdev core
1030 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1031 const struct fb_image *image)
1033 cfb_imageblit(info, image);
1034 drm_fb_helper_dirty(info, image->dx, image->dy,
1035 image->width, image->height);
1037 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1040 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1041 * @fb_helper: driver-allocated fbdev helper
1042 * @suspend: whether to suspend or resume
1044 * A wrapper around fb_set_suspend implemented by fbdev core.
1045 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1048 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
1050 if (fb_helper && fb_helper->fbdev)
1051 fb_set_suspend(fb_helper->fbdev, suspend);
1053 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1056 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1057 * takes the console lock
1058 * @fb_helper: driver-allocated fbdev helper
1059 * @suspend: whether to suspend or resume
1061 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1062 * isn't available on resume, a worker is tasked with waiting for the lock
1063 * to become available. The console lock can be pretty contented on resume
1064 * due to all the printk activity.
1066 * This function can be called multiple times with the same state since
1067 * &fb_info->state is checked to see if fbdev is running or not before locking.
1069 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1071 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
1074 if (!fb_helper || !fb_helper->fbdev)
1077 /* make sure there's no pending/ongoing resume */
1078 flush_work(&fb_helper->resume_work);
1081 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
1087 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
1090 if (!console_trylock()) {
1091 schedule_work(&fb_helper->resume_work);
1096 fb_set_suspend(fb_helper->fbdev, suspend);
1099 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
1101 static int setcolreg(struct drm_crtc *crtc, u16 red, u16 green,
1102 u16 blue, u16 regno, struct fb_info *info)
1104 struct drm_fb_helper *fb_helper = info->par;
1105 struct drm_framebuffer *fb = fb_helper->fb;
1107 if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
1110 /* place color in psuedopalette */
1113 palette = (u32 *)info->pseudo_palette;
1114 red >>= (16 - info->var.red.length);
1115 green >>= (16 - info->var.green.length);
1116 blue >>= (16 - info->var.blue.length);
1117 value = (red << info->var.red.offset) |
1118 (green << info->var.green.offset) |
1119 (blue << info->var.blue.offset);
1120 if (info->var.transp.length > 0) {
1121 u32 mask = (1 << info->var.transp.length) - 1;
1122 mask <<= info->var.transp.offset;
1125 palette[regno] = value;
1130 * The driver really shouldn't advertise pseudo/directcolor
1131 * visuals if it can't deal with the palette.
1133 if (WARN_ON(!fb_helper->funcs->gamma_set ||
1134 !fb_helper->funcs->gamma_get))
1137 WARN_ON(fb->bits_per_pixel != 8);
1139 fb_helper->funcs->gamma_set(crtc, red, green, blue, regno);
1145 * drm_fb_helper_setcmap - implementation for ->fb_setcmap
1146 * @cmap: cmap to set
1147 * @info: fbdev registered by the helper
1149 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1151 struct drm_fb_helper *fb_helper = info->par;
1152 struct drm_device *dev = fb_helper->dev;
1153 const struct drm_crtc_helper_funcs *crtc_funcs;
1154 u16 *red, *green, *blue, *transp;
1155 struct drm_crtc *crtc;
1159 if (oops_in_progress)
1162 drm_modeset_lock_all(dev);
1163 if (!drm_fb_helper_is_bound(fb_helper)) {
1164 drm_modeset_unlock_all(dev);
1168 for (i = 0; i < fb_helper->crtc_count; i++) {
1169 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1170 crtc_funcs = crtc->helper_private;
1173 green = cmap->green;
1175 transp = cmap->transp;
1176 start = cmap->start;
1178 for (j = 0; j < cmap->len; j++) {
1179 u16 hred, hgreen, hblue, htransp = 0xffff;
1186 htransp = *transp++;
1188 rc = setcolreg(crtc, hred, hgreen, hblue, start++, info);
1192 if (crtc_funcs->load_lut)
1193 crtc_funcs->load_lut(crtc);
1196 drm_modeset_unlock_all(dev);
1199 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1202 * drm_fb_helper_check_var - implementation for ->fb_check_var
1203 * @var: screeninfo to check
1204 * @info: fbdev registered by the helper
1206 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1207 struct fb_info *info)
1209 struct drm_fb_helper *fb_helper = info->par;
1210 struct drm_framebuffer *fb = fb_helper->fb;
1213 if (var->pixclock != 0 || in_dbg_master())
1217 * Changes struct fb_var_screeninfo are currently not pushed back
1218 * to KMS, hence fail if different settings are requested.
1220 if (var->bits_per_pixel != fb->bits_per_pixel ||
1221 var->xres != fb->width || var->yres != fb->height ||
1222 var->xres_virtual != fb->width || var->yres_virtual != fb->height) {
1223 DRM_DEBUG("fb userspace requested width/height/bpp different than current fb "
1224 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1225 var->xres, var->yres, var->bits_per_pixel,
1226 var->xres_virtual, var->yres_virtual,
1227 fb->width, fb->height, fb->bits_per_pixel);
1231 switch (var->bits_per_pixel) {
1233 depth = (var->green.length == 6) ? 16 : 15;
1236 depth = (var->transp.length > 0) ? 32 : 24;
1239 depth = var->bits_per_pixel;
1245 var->red.offset = 0;
1246 var->green.offset = 0;
1247 var->blue.offset = 0;
1248 var->red.length = 8;
1249 var->green.length = 8;
1250 var->blue.length = 8;
1251 var->transp.length = 0;
1252 var->transp.offset = 0;
1255 var->red.offset = 10;
1256 var->green.offset = 5;
1257 var->blue.offset = 0;
1258 var->red.length = 5;
1259 var->green.length = 5;
1260 var->blue.length = 5;
1261 var->transp.length = 1;
1262 var->transp.offset = 15;
1265 var->red.offset = 11;
1266 var->green.offset = 5;
1267 var->blue.offset = 0;
1268 var->red.length = 5;
1269 var->green.length = 6;
1270 var->blue.length = 5;
1271 var->transp.length = 0;
1272 var->transp.offset = 0;
1275 var->red.offset = 16;
1276 var->green.offset = 8;
1277 var->blue.offset = 0;
1278 var->red.length = 8;
1279 var->green.length = 8;
1280 var->blue.length = 8;
1281 var->transp.length = 0;
1282 var->transp.offset = 0;
1285 var->red.offset = 16;
1286 var->green.offset = 8;
1287 var->blue.offset = 0;
1288 var->red.length = 8;
1289 var->green.length = 8;
1290 var->blue.length = 8;
1291 var->transp.length = 8;
1292 var->transp.offset = 24;
1299 EXPORT_SYMBOL(drm_fb_helper_check_var);
1302 * drm_fb_helper_set_par - implementation for ->fb_set_par
1303 * @info: fbdev registered by the helper
1305 * This will let fbcon do the mode init and is called at initialization time by
1306 * the fbdev core when registering the driver, and later on through the hotplug
1309 int drm_fb_helper_set_par(struct fb_info *info)
1311 struct drm_fb_helper *fb_helper = info->par;
1312 struct fb_var_screeninfo *var = &info->var;
1314 if (oops_in_progress)
1317 if (var->pixclock != 0) {
1318 DRM_ERROR("PIXEL CLOCK SET\n");
1322 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1326 EXPORT_SYMBOL(drm_fb_helper_set_par);
1328 static int pan_display_atomic(struct fb_var_screeninfo *var,
1329 struct fb_info *info)
1331 struct drm_fb_helper *fb_helper = info->par;
1332 struct drm_device *dev = fb_helper->dev;
1333 struct drm_atomic_state *state;
1334 struct drm_plane *plane;
1336 unsigned plane_mask;
1338 state = drm_atomic_state_alloc(dev);
1342 state->acquire_ctx = dev->mode_config.acquire_ctx;
1345 for(i = 0; i < fb_helper->crtc_count; i++) {
1346 struct drm_mode_set *mode_set;
1348 mode_set = &fb_helper->crtc_info[i].mode_set;
1350 mode_set->x = var->xoffset;
1351 mode_set->y = var->yoffset;
1353 ret = __drm_atomic_helper_set_config(mode_set, state);
1357 plane = mode_set->crtc->primary;
1358 plane_mask |= (1 << drm_plane_index(plane));
1359 plane->old_fb = plane->fb;
1362 ret = drm_atomic_commit(state);
1366 info->var.xoffset = var->xoffset;
1367 info->var.yoffset = var->yoffset;
1370 drm_atomic_clean_old_fb(dev, plane_mask, ret);
1372 if (ret == -EDEADLK)
1375 drm_atomic_state_put(state);
1379 drm_atomic_state_clear(state);
1380 drm_atomic_legacy_backoff(state);
1386 * drm_fb_helper_pan_display - implementation for ->fb_pan_display
1387 * @var: updated screen information
1388 * @info: fbdev registered by the helper
1390 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1391 struct fb_info *info)
1393 struct drm_fb_helper *fb_helper = info->par;
1394 struct drm_device *dev = fb_helper->dev;
1395 struct drm_mode_set *modeset;
1399 if (oops_in_progress)
1402 drm_modeset_lock_all(dev);
1403 if (!drm_fb_helper_is_bound(fb_helper)) {
1404 drm_modeset_unlock_all(dev);
1408 if (dev->mode_config.funcs->atomic_commit) {
1409 ret = pan_display_atomic(var, info);
1413 for (i = 0; i < fb_helper->crtc_count; i++) {
1414 modeset = &fb_helper->crtc_info[i].mode_set;
1416 modeset->x = var->xoffset;
1417 modeset->y = var->yoffset;
1419 if (modeset->num_connectors) {
1420 ret = drm_mode_set_config_internal(modeset);
1422 info->var.xoffset = var->xoffset;
1423 info->var.yoffset = var->yoffset;
1428 drm_modeset_unlock_all(dev);
1431 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1434 * Allocates the backing storage and sets up the fbdev info structure through
1435 * the ->fb_probe callback and then registers the fbdev and sets up the panic
1438 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1444 struct fb_info *info;
1445 struct drm_fb_helper_surface_size sizes;
1448 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1449 sizes.surface_depth = 24;
1450 sizes.surface_bpp = 32;
1451 sizes.fb_width = (unsigned)-1;
1452 sizes.fb_height = (unsigned)-1;
1454 /* if driver picks 8 or 16 by default use that
1455 for both depth/bpp */
1456 if (preferred_bpp != sizes.surface_bpp)
1457 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1459 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1460 for (i = 0; i < fb_helper->connector_count; i++) {
1461 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1462 struct drm_cmdline_mode *cmdline_mode;
1464 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1466 if (cmdline_mode->bpp_specified) {
1467 switch (cmdline_mode->bpp) {
1469 sizes.surface_depth = sizes.surface_bpp = 8;
1472 sizes.surface_depth = 15;
1473 sizes.surface_bpp = 16;
1476 sizes.surface_depth = sizes.surface_bpp = 16;
1479 sizes.surface_depth = sizes.surface_bpp = 24;
1482 sizes.surface_depth = 24;
1483 sizes.surface_bpp = 32;
1491 for (i = 0; i < fb_helper->crtc_count; i++) {
1492 struct drm_display_mode *desired_mode;
1493 struct drm_mode_set *mode_set;
1495 /* in case of tile group, are we the last tile vert or horiz?
1496 * If no tile group you are always the last one both vertically
1499 bool lastv = true, lasth = true;
1501 desired_mode = fb_helper->crtc_info[i].desired_mode;
1502 mode_set = &fb_helper->crtc_info[i].mode_set;
1509 x = fb_helper->crtc_info[i].x;
1510 y = fb_helper->crtc_info[i].y;
1512 if (gamma_size == 0)
1513 gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1515 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1516 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1518 for (j = 0; j < mode_set->num_connectors; j++) {
1519 struct drm_connector *connector = mode_set->connectors[j];
1520 if (connector->has_tile) {
1521 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1522 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1523 /* cloning to multiple tiles is just crazy-talk, so: */
1529 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1531 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1534 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1535 /* hmm everyone went away - assume VGA cable just fell out
1536 and will come back later. */
1537 DRM_INFO("Cannot find any crtc or sizes - going 1024x768\n");
1538 sizes.fb_width = sizes.surface_width = 1024;
1539 sizes.fb_height = sizes.surface_height = 768;
1542 /* push down into drivers */
1543 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1547 info = fb_helper->fbdev;
1550 * Set the fb pointer - usually drm_setup_crtcs does this for hotplug
1551 * events, but at init time drm_setup_crtcs needs to be called before
1552 * the fb is allocated (since we need to figure out the desired size of
1553 * the fb before we can allocate it ...). Hence we need to fix things up
1556 for (i = 0; i < fb_helper->crtc_count; i++)
1557 if (fb_helper->crtc_info[i].mode_set.num_connectors)
1558 fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
1561 info->var.pixclock = 0;
1562 if (register_framebuffer(info) < 0)
1565 dev_info(fb_helper->dev->dev, "fb%d: %s frame buffer device\n",
1566 info->node, info->fix.id);
1568 if (list_empty(&kernel_fb_helper_list)) {
1569 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1572 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1578 * drm_fb_helper_fill_fix - initializes fixed fbdev information
1579 * @info: fbdev registered by the helper
1580 * @pitch: desired pitch
1581 * @depth: desired depth
1583 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1584 * fbdev emulations. Drivers which support acceleration methods which impose
1585 * additional constraints need to set up their own limits.
1587 * Drivers should call this (or their equivalent setup code) from their
1588 * ->fb_probe callback.
1590 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1593 info->fix.type = FB_TYPE_PACKED_PIXELS;
1594 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1595 FB_VISUAL_TRUECOLOR;
1596 info->fix.mmio_start = 0;
1597 info->fix.mmio_len = 0;
1598 info->fix.type_aux = 0;
1599 info->fix.xpanstep = 1; /* doing it in hw */
1600 info->fix.ypanstep = 1; /* doing it in hw */
1601 info->fix.ywrapstep = 0;
1602 info->fix.accel = FB_ACCEL_NONE;
1604 info->fix.line_length = pitch;
1607 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1610 * drm_fb_helper_fill_var - initalizes variable fbdev information
1611 * @info: fbdev instance to set up
1612 * @fb_helper: fb helper instance to use as template
1613 * @fb_width: desired fb width
1614 * @fb_height: desired fb height
1616 * Sets up the variable fbdev metainformation from the given fb helper instance
1617 * and the drm framebuffer allocated in fb_helper->fb.
1619 * Drivers should call this (or their equivalent setup code) from their
1620 * ->fb_probe callback after having allocated the fbdev backing
1621 * storage framebuffer.
1623 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1624 uint32_t fb_width, uint32_t fb_height)
1626 struct drm_framebuffer *fb = fb_helper->fb;
1627 info->pseudo_palette = fb_helper->pseudo_palette;
1628 info->var.xres_virtual = fb->width;
1629 info->var.yres_virtual = fb->height;
1630 info->var.bits_per_pixel = fb->bits_per_pixel;
1631 info->var.accel_flags = FB_ACCELF_TEXT;
1632 info->var.xoffset = 0;
1633 info->var.yoffset = 0;
1634 info->var.activate = FB_ACTIVATE_NOW;
1635 info->var.height = -1;
1636 info->var.width = -1;
1638 switch (fb->depth) {
1640 info->var.red.offset = 0;
1641 info->var.green.offset = 0;
1642 info->var.blue.offset = 0;
1643 info->var.red.length = 8; /* 8bit DAC */
1644 info->var.green.length = 8;
1645 info->var.blue.length = 8;
1646 info->var.transp.offset = 0;
1647 info->var.transp.length = 0;
1650 info->var.red.offset = 10;
1651 info->var.green.offset = 5;
1652 info->var.blue.offset = 0;
1653 info->var.red.length = 5;
1654 info->var.green.length = 5;
1655 info->var.blue.length = 5;
1656 info->var.transp.offset = 15;
1657 info->var.transp.length = 1;
1660 info->var.red.offset = 11;
1661 info->var.green.offset = 5;
1662 info->var.blue.offset = 0;
1663 info->var.red.length = 5;
1664 info->var.green.length = 6;
1665 info->var.blue.length = 5;
1666 info->var.transp.offset = 0;
1669 info->var.red.offset = 16;
1670 info->var.green.offset = 8;
1671 info->var.blue.offset = 0;
1672 info->var.red.length = 8;
1673 info->var.green.length = 8;
1674 info->var.blue.length = 8;
1675 info->var.transp.offset = 0;
1676 info->var.transp.length = 0;
1679 info->var.red.offset = 16;
1680 info->var.green.offset = 8;
1681 info->var.blue.offset = 0;
1682 info->var.red.length = 8;
1683 info->var.green.length = 8;
1684 info->var.blue.length = 8;
1685 info->var.transp.offset = 24;
1686 info->var.transp.length = 8;
1692 info->var.xres = fb_width;
1693 info->var.yres = fb_height;
1695 EXPORT_SYMBOL(drm_fb_helper_fill_var);
1697 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
1701 struct drm_connector *connector;
1705 for (i = 0; i < fb_helper->connector_count; i++) {
1706 connector = fb_helper->connector_info[i]->connector;
1707 count += connector->funcs->fill_modes(connector, maxX, maxY);
1713 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
1715 struct drm_display_mode *mode;
1717 list_for_each_entry(mode, &fb_connector->connector->modes, head) {
1718 if (mode->hdisplay > width ||
1719 mode->vdisplay > height)
1721 if (mode->type & DRM_MODE_TYPE_PREFERRED)
1726 EXPORT_SYMBOL(drm_has_preferred_mode);
1728 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
1730 return fb_connector->connector->cmdline_mode.specified;
1733 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
1734 int width, int height)
1736 struct drm_cmdline_mode *cmdline_mode;
1737 struct drm_display_mode *mode;
1738 bool prefer_non_interlace;
1740 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1741 if (cmdline_mode->specified == false)
1744 /* attempt to find a matching mode in the list of modes
1745 * we have gotten so far, if not add a CVT mode that conforms
1747 if (cmdline_mode->rb || cmdline_mode->margins)
1750 prefer_non_interlace = !cmdline_mode->interlace;
1752 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1753 /* check width/height */
1754 if (mode->hdisplay != cmdline_mode->xres ||
1755 mode->vdisplay != cmdline_mode->yres)
1758 if (cmdline_mode->refresh_specified) {
1759 if (mode->vrefresh != cmdline_mode->refresh)
1763 if (cmdline_mode->interlace) {
1764 if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
1766 } else if (prefer_non_interlace) {
1767 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
1773 if (prefer_non_interlace) {
1774 prefer_non_interlace = false;
1779 mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
1781 list_add(&mode->head, &fb_helper_conn->connector->modes);
1784 EXPORT_SYMBOL(drm_pick_cmdline_mode);
1786 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
1791 enable = connector->status == connector_status_connected;
1793 enable = connector->status != connector_status_disconnected;
1798 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
1801 bool any_enabled = false;
1802 struct drm_connector *connector;
1805 for (i = 0; i < fb_helper->connector_count; i++) {
1806 connector = fb_helper->connector_info[i]->connector;
1807 enabled[i] = drm_connector_enabled(connector, true);
1808 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
1809 enabled[i] ? "yes" : "no");
1810 any_enabled |= enabled[i];
1816 for (i = 0; i < fb_helper->connector_count; i++) {
1817 connector = fb_helper->connector_info[i]->connector;
1818 enabled[i] = drm_connector_enabled(connector, false);
1822 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
1823 struct drm_display_mode **modes,
1824 struct drm_fb_offset *offsets,
1825 bool *enabled, int width, int height)
1828 bool can_clone = false;
1829 struct drm_fb_helper_connector *fb_helper_conn;
1830 struct drm_display_mode *dmt_mode, *mode;
1832 /* only contemplate cloning in the single crtc case */
1833 if (fb_helper->crtc_count > 1)
1837 for (i = 0; i < fb_helper->connector_count; i++) {
1842 /* only contemplate cloning if more than one connector is enabled */
1846 /* check the command line or if nothing common pick 1024x768 */
1848 for (i = 0; i < fb_helper->connector_count; i++) {
1851 fb_helper_conn = fb_helper->connector_info[i];
1852 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1857 for (j = 0; j < i; j++) {
1860 if (!drm_mode_equal(modes[j], modes[i]))
1866 DRM_DEBUG_KMS("can clone using command line\n");
1870 /* try and find a 1024x768 mode on each connector */
1872 dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
1874 for (i = 0; i < fb_helper->connector_count; i++) {
1879 fb_helper_conn = fb_helper->connector_info[i];
1880 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1881 if (drm_mode_equal(mode, dmt_mode))
1889 DRM_DEBUG_KMS("can clone using 1024x768\n");
1892 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
1896 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
1897 struct drm_display_mode **modes,
1898 struct drm_fb_offset *offsets,
1900 int h_idx, int v_idx)
1902 struct drm_fb_helper_connector *fb_helper_conn;
1904 int hoffset = 0, voffset = 0;
1906 for (i = 0; i < fb_helper->connector_count; i++) {
1907 fb_helper_conn = fb_helper->connector_info[i];
1908 if (!fb_helper_conn->connector->has_tile)
1911 if (!modes[i] && (h_idx || v_idx)) {
1912 DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
1913 fb_helper_conn->connector->base.id);
1916 if (fb_helper_conn->connector->tile_h_loc < h_idx)
1917 hoffset += modes[i]->hdisplay;
1919 if (fb_helper_conn->connector->tile_v_loc < v_idx)
1920 voffset += modes[i]->vdisplay;
1922 offsets[idx].x = hoffset;
1923 offsets[idx].y = voffset;
1924 DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
1928 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
1929 struct drm_display_mode **modes,
1930 struct drm_fb_offset *offsets,
1931 bool *enabled, int width, int height)
1933 struct drm_fb_helper_connector *fb_helper_conn;
1935 uint64_t conn_configured = 0, mask;
1937 mask = (1 << fb_helper->connector_count) - 1;
1939 for (i = 0; i < fb_helper->connector_count; i++) {
1940 fb_helper_conn = fb_helper->connector_info[i];
1942 if (conn_configured & (1 << i))
1945 if (enabled[i] == false) {
1946 conn_configured |= (1 << i);
1950 /* first pass over all the untiled connectors */
1951 if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
1954 if (tile_pass == 1) {
1955 if (fb_helper_conn->connector->tile_h_loc != 0 ||
1956 fb_helper_conn->connector->tile_v_loc != 0)
1960 if (fb_helper_conn->connector->tile_h_loc != tile_pass -1 &&
1961 fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
1962 /* if this tile_pass doesn't cover any of the tiles - keep going */
1965 /* find the tile offsets for this pass - need
1966 to find all tiles left and above */
1967 drm_get_tile_offsets(fb_helper, modes, offsets,
1968 i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
1970 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
1971 fb_helper_conn->connector->base.id);
1973 /* got for command line mode first */
1974 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1976 DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
1977 fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
1978 modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
1980 /* No preferred modes, pick one off the list */
1981 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
1982 list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
1985 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
1987 conn_configured |= (1 << i);
1990 if ((conn_configured & mask) != mask) {
1997 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
1998 struct drm_fb_helper_crtc **best_crtcs,
1999 struct drm_display_mode **modes,
2000 int n, int width, int height)
2003 struct drm_connector *connector;
2004 const struct drm_connector_helper_funcs *connector_funcs;
2005 struct drm_encoder *encoder;
2006 int my_score, best_score, score;
2007 struct drm_fb_helper_crtc **crtcs, *crtc;
2008 struct drm_fb_helper_connector *fb_helper_conn;
2010 if (n == fb_helper->connector_count)
2013 fb_helper_conn = fb_helper->connector_info[n];
2014 connector = fb_helper_conn->connector;
2016 best_crtcs[n] = NULL;
2017 best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
2018 if (modes[n] == NULL)
2021 crtcs = kzalloc(fb_helper->connector_count *
2022 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2027 if (connector->status == connector_status_connected)
2029 if (drm_has_cmdline_mode(fb_helper_conn))
2031 if (drm_has_preferred_mode(fb_helper_conn, width, height))
2034 connector_funcs = connector->helper_private;
2037 * If the DRM device implements atomic hooks and ->best_encoder() is
2038 * NULL we fallback to the default drm_atomic_helper_best_encoder()
2041 if (fb_helper->dev->mode_config.funcs->atomic_commit &&
2042 !connector_funcs->best_encoder)
2043 encoder = drm_atomic_helper_best_encoder(connector);
2045 encoder = connector_funcs->best_encoder(connector);
2050 /* select a crtc for this connector and then attempt to configure
2051 remaining connectors */
2052 for (c = 0; c < fb_helper->crtc_count; c++) {
2053 crtc = &fb_helper->crtc_info[c];
2055 if ((encoder->possible_crtcs & (1 << c)) == 0)
2058 for (o = 0; o < n; o++)
2059 if (best_crtcs[o] == crtc)
2063 /* ignore cloning unless only a single crtc */
2064 if (fb_helper->crtc_count > 1)
2067 if (!drm_mode_equal(modes[o], modes[n]))
2072 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
2073 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
2075 if (score > best_score) {
2077 memcpy(best_crtcs, crtcs,
2078 fb_helper->connector_count *
2079 sizeof(struct drm_fb_helper_crtc *));
2087 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper)
2089 struct drm_device *dev = fb_helper->dev;
2090 struct drm_fb_helper_crtc **crtcs;
2091 struct drm_display_mode **modes;
2092 struct drm_fb_offset *offsets;
2093 struct drm_mode_set *modeset;
2098 DRM_DEBUG_KMS("\n");
2100 width = dev->mode_config.max_width;
2101 height = dev->mode_config.max_height;
2103 crtcs = kcalloc(fb_helper->connector_count,
2104 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2105 modes = kcalloc(fb_helper->connector_count,
2106 sizeof(struct drm_display_mode *), GFP_KERNEL);
2107 offsets = kcalloc(fb_helper->connector_count,
2108 sizeof(struct drm_fb_offset), GFP_KERNEL);
2109 enabled = kcalloc(fb_helper->connector_count,
2110 sizeof(bool), GFP_KERNEL);
2111 if (!crtcs || !modes || !enabled || !offsets) {
2112 DRM_ERROR("Memory allocation failed\n");
2117 drm_enable_connectors(fb_helper, enabled);
2119 if (!(fb_helper->funcs->initial_config &&
2120 fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2122 enabled, width, height))) {
2123 memset(modes, 0, fb_helper->connector_count*sizeof(modes[0]));
2124 memset(crtcs, 0, fb_helper->connector_count*sizeof(crtcs[0]));
2125 memset(offsets, 0, fb_helper->connector_count*sizeof(offsets[0]));
2127 if (!drm_target_cloned(fb_helper, modes, offsets,
2128 enabled, width, height) &&
2129 !drm_target_preferred(fb_helper, modes, offsets,
2130 enabled, width, height))
2131 DRM_ERROR("Unable to find initial modes\n");
2133 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2136 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2139 /* need to set the modesets up here for use later */
2140 /* fill out the connector<->crtc mappings into the modesets */
2141 for (i = 0; i < fb_helper->crtc_count; i++) {
2142 modeset = &fb_helper->crtc_info[i].mode_set;
2143 modeset->num_connectors = 0;
2147 for (i = 0; i < fb_helper->connector_count; i++) {
2148 struct drm_display_mode *mode = modes[i];
2149 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2150 struct drm_fb_offset *offset = &offsets[i];
2151 modeset = &fb_crtc->mode_set;
2153 if (mode && fb_crtc) {
2154 DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2155 mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2156 fb_crtc->desired_mode = mode;
2157 fb_crtc->x = offset->x;
2158 fb_crtc->y = offset->y;
2160 drm_mode_destroy(dev, modeset->mode);
2161 modeset->mode = drm_mode_duplicate(dev,
2162 fb_crtc->desired_mode);
2163 modeset->connectors[modeset->num_connectors++] = fb_helper->connector_info[i]->connector;
2164 modeset->fb = fb_helper->fb;
2165 modeset->x = offset->x;
2166 modeset->y = offset->y;
2170 /* Clear out any old modes if there are no more connected outputs. */
2171 for (i = 0; i < fb_helper->crtc_count; i++) {
2172 modeset = &fb_helper->crtc_info[i].mode_set;
2173 if (modeset->num_connectors == 0) {
2174 BUG_ON(modeset->fb);
2176 drm_mode_destroy(dev, modeset->mode);
2177 modeset->mode = NULL;
2188 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2189 * @fb_helper: fb_helper device struct
2190 * @bpp_sel: bpp value to use for the framebuffer configuration
2192 * Scans the CRTCs and connectors and tries to put together an initial setup.
2193 * At the moment, this is a cloned configuration across all heads with
2194 * a new framebuffer object as the backing store.
2196 * Note that this also registers the fbdev and so allows userspace to call into
2197 * the driver through the fbdev interfaces.
2199 * This function will call down into the ->fb_probe callback to let
2200 * the driver allocate and initialize the fbdev info structure and the drm
2201 * framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2202 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2203 * values for the fbdev info structure.
2207 * When you have fbcon support built-in or already loaded, this function will do
2208 * a full modeset to setup the fbdev console. Due to locking misdesign in the
2209 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2210 * console_lock. Until console_unlock is called no dmesg lines will be sent out
2211 * to consoles, not even serial console. This means when your driver crashes,
2212 * you will see absolutely nothing else but a system stuck in this function,
2213 * with no further output. Any kind of printk() you place within your own driver
2214 * or in the drm core modeset code will also never show up.
2216 * Standard debug practice is to run the fbcon setup without taking the
2217 * console_lock as a hack, to be able to see backtraces and crashes on the
2218 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2221 * The other option is to just disable fbdev emulation since very likely the
2222 * first modeset from userspace will crash in the same way, and is even easier
2223 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2224 * kernel cmdline option.
2227 * Zero if everything went ok, nonzero otherwise.
2229 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2231 struct drm_device *dev = fb_helper->dev;
2234 if (!drm_fbdev_emulation)
2237 mutex_lock(&dev->mode_config.mutex);
2238 count = drm_fb_helper_probe_connector_modes(fb_helper,
2239 dev->mode_config.max_width,
2240 dev->mode_config.max_height);
2241 mutex_unlock(&dev->mode_config.mutex);
2243 * we shouldn't end up with no modes here.
2246 dev_info(fb_helper->dev->dev, "No connectors reported connected with modes\n");
2248 drm_setup_crtcs(fb_helper);
2250 return drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2252 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2255 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2256 * probing all the outputs attached to the fb
2257 * @fb_helper: the drm_fb_helper
2259 * Scan the connectors attached to the fb_helper and try to put together a
2260 * setup after notification of a change in output configuration.
2262 * Called at runtime, takes the mode config locks to be able to check/change the
2263 * modeset configuration. Must be run from process context (which usually means
2264 * either the output polling work or a work item launched from the driver's
2265 * hotplug interrupt).
2267 * Note that drivers may call this even before calling
2268 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2269 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2270 * not miss any hotplug events.
2273 * 0 on success and a non-zero error code otherwise.
2275 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2277 struct drm_device *dev = fb_helper->dev;
2278 u32 max_width, max_height;
2280 if (!drm_fbdev_emulation)
2283 mutex_lock(&fb_helper->dev->mode_config.mutex);
2284 if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2285 fb_helper->delayed_hotplug = true;
2286 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2289 DRM_DEBUG_KMS("\n");
2291 max_width = fb_helper->fb->width;
2292 max_height = fb_helper->fb->height;
2294 drm_fb_helper_probe_connector_modes(fb_helper, max_width, max_height);
2295 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2297 drm_modeset_lock_all(dev);
2298 drm_setup_crtcs(fb_helper);
2299 drm_modeset_unlock_all(dev);
2300 drm_fb_helper_set_par(fb_helper->fbdev);
2304 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2306 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2307 * but the module doesn't depend on any fb console symbols. At least
2308 * attempt to load fbcon to avoid leaving the system without a usable console.
2310 int __init drm_fb_helper_modinit(void)
2312 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2313 const char *name = "fbcon";
2314 struct module *fbcon;
2316 mutex_lock(&module_mutex);
2317 fbcon = find_module(name);
2318 mutex_unlock(&module_mutex);
2321 request_module_nowait(name);
2325 EXPORT_SYMBOL(drm_fb_helper_modinit);