2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
6 * DRM framebuffer helper functions
8 * Permission to use, copy, modify, distribute, and sell this software and its
9 * documentation for any purpose is hereby granted without fee, provided that
10 * the above copyright notice appear in all copies and that both that copyright
11 * notice and this permission notice appear in supporting documentation, and
12 * that the name of the copyright holders not be used in advertising or
13 * publicity pertaining to distribution of the software without specific,
14 * written prior permission. The copyright holders make no representations
15 * about the suitability of this software for any purpose. It is provided "as
16 * is" without express or implied warranty.
18 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
27 * Dave Airlie <airlied@linux.ie>
28 * Jesse Barnes <jesse.barnes@intel.com>
30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32 #include <linux/console.h>
33 #include <linux/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 static bool drm_fbdev_emulation = true;
45 module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
46 MODULE_PARM_DESC(fbdev_emulation,
47 "Enable legacy fbdev emulation [default=true]");
49 static LIST_HEAD(kernel_fb_helper_list);
54 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
55 * mode setting driver. They can be used mostly independently from the crtc
56 * helper functions used by many drivers to implement the kernel mode setting
59 * Initialization is done as a four-step process with drm_fb_helper_prepare(),
60 * drm_fb_helper_init(), drm_fb_helper_single_add_all_connectors() and
61 * drm_fb_helper_initial_config(). Drivers with fancier requirements than the
62 * default behaviour can override the third step with their own code.
63 * Teardown is done with drm_fb_helper_fini().
65 * At runtime drivers should restore the fbdev console by calling
66 * drm_fb_helper_restore_fbdev_mode_unlocked() from their ->lastclose callback.
67 * They should also notify the fb helper code from updates to the output
68 * configuration by calling drm_fb_helper_hotplug_event(). For easier
69 * integration with the output polling code in drm_crtc_helper.c the modeset
70 * code provides a ->output_poll_changed callback.
72 * All other functions exported by the fb helper library can be used to
73 * implement the fbdev driver interface by the driver.
75 * It is possible, though perhaps somewhat tricky, to implement race-free
76 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
77 * helper must be called first to initialize the minimum required to make
78 * hotplug detection work. Drivers also need to make sure to properly set up
79 * the dev->mode_config.funcs member. After calling drm_kms_helper_poll_init()
80 * it is safe to enable interrupts and start processing hotplug events. At the
81 * same time, drivers should initialize all modeset objects such as CRTCs,
82 * encoders and connectors. To finish up the fbdev helper initialization, the
83 * drm_fb_helper_init() function is called. To probe for all attached displays
84 * and set up an initial configuration using the detected hardware, drivers
85 * should call drm_fb_helper_single_add_all_connectors() followed by
86 * drm_fb_helper_initial_config().
88 * If &drm_framebuffer_funcs ->dirty is set, the
89 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
90 * accumulate changes and schedule &drm_fb_helper ->dirty_work to run right
91 * away. This worker then calls the dirty() function ensuring that it will
92 * always run in process context since the fb_*() function could be running in
93 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
94 * callback it will also schedule dirty_work with the damage collected from the
99 * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
101 * @fb_helper: fbdev initialized with drm_fb_helper_init
103 * This functions adds all the available connectors for use with the given
104 * fb_helper. This is a separate step to allow drivers to freely assign
105 * connectors to the fbdev, e.g. if some are reserved for special purposes or
106 * not adequate to be used for the fbcon.
108 * This function is protected against concurrent connector hotadds/removals
109 * using drm_fb_helper_add_one_connector() and
110 * drm_fb_helper_remove_one_connector().
112 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
114 struct drm_device *dev = fb_helper->dev;
115 struct drm_connector *connector;
118 if (!drm_fbdev_emulation)
121 mutex_lock(&dev->mode_config.mutex);
122 drm_for_each_connector(connector, dev) {
123 ret = drm_fb_helper_add_one_connector(fb_helper, connector);
128 mutex_unlock(&dev->mode_config.mutex);
131 for (i = 0; i < fb_helper->connector_count; i++) {
132 kfree(fb_helper->connector_info[i]);
133 fb_helper->connector_info[i] = NULL;
135 fb_helper->connector_count = 0;
136 mutex_unlock(&dev->mode_config.mutex);
140 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
142 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector)
144 struct drm_fb_helper_connector **temp;
145 struct drm_fb_helper_connector *fb_helper_connector;
147 if (!drm_fbdev_emulation)
150 WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
151 if (fb_helper->connector_count + 1 > fb_helper->connector_info_alloc_count) {
152 temp = krealloc(fb_helper->connector_info, sizeof(struct drm_fb_helper_connector *) * (fb_helper->connector_count + 1), GFP_KERNEL);
156 fb_helper->connector_info_alloc_count = fb_helper->connector_count + 1;
157 fb_helper->connector_info = temp;
161 fb_helper_connector = kzalloc(sizeof(struct drm_fb_helper_connector), GFP_KERNEL);
162 if (!fb_helper_connector)
165 drm_connector_reference(connector);
166 fb_helper_connector->connector = connector;
167 fb_helper->connector_info[fb_helper->connector_count++] = fb_helper_connector;
170 EXPORT_SYMBOL(drm_fb_helper_add_one_connector);
172 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
173 struct drm_connector *connector)
175 struct drm_fb_helper_connector *fb_helper_connector;
178 if (!drm_fbdev_emulation)
181 WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
183 for (i = 0; i < fb_helper->connector_count; i++) {
184 if (fb_helper->connector_info[i]->connector == connector)
188 if (i == fb_helper->connector_count)
190 fb_helper_connector = fb_helper->connector_info[i];
191 drm_connector_unreference(fb_helper_connector->connector);
193 for (j = i + 1; j < fb_helper->connector_count; j++) {
194 fb_helper->connector_info[j - 1] = fb_helper->connector_info[j];
196 fb_helper->connector_count--;
197 kfree(fb_helper_connector);
201 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector);
203 static void drm_fb_helper_save_lut_atomic(struct drm_crtc *crtc, struct drm_fb_helper *helper)
205 uint16_t *r_base, *g_base, *b_base;
208 if (helper->funcs->gamma_get == NULL)
211 r_base = crtc->gamma_store;
212 g_base = r_base + crtc->gamma_size;
213 b_base = g_base + crtc->gamma_size;
215 for (i = 0; i < crtc->gamma_size; i++)
216 helper->funcs->gamma_get(crtc, &r_base[i], &g_base[i], &b_base[i], i);
219 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
221 uint16_t *r_base, *g_base, *b_base;
223 if (crtc->funcs->gamma_set == NULL)
226 r_base = crtc->gamma_store;
227 g_base = r_base + crtc->gamma_size;
228 b_base = g_base + crtc->gamma_size;
230 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, crtc->gamma_size);
234 * drm_fb_helper_debug_enter - implementation for ->fb_debug_enter
235 * @info: fbdev registered by the helper
237 int drm_fb_helper_debug_enter(struct fb_info *info)
239 struct drm_fb_helper *helper = info->par;
240 const struct drm_crtc_helper_funcs *funcs;
243 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
244 for (i = 0; i < helper->crtc_count; i++) {
245 struct drm_mode_set *mode_set =
246 &helper->crtc_info[i].mode_set;
248 if (!mode_set->crtc->enabled)
251 funcs = mode_set->crtc->helper_private;
252 drm_fb_helper_save_lut_atomic(mode_set->crtc, helper);
253 funcs->mode_set_base_atomic(mode_set->crtc,
257 ENTER_ATOMIC_MODE_SET);
263 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
265 /* Find the real fb for a given fb helper CRTC */
266 static struct drm_framebuffer *drm_mode_config_fb(struct drm_crtc *crtc)
268 struct drm_device *dev = crtc->dev;
271 drm_for_each_crtc(c, dev) {
272 if (crtc->base.id == c->base.id)
273 return c->primary->fb;
280 * drm_fb_helper_debug_leave - implementation for ->fb_debug_leave
281 * @info: fbdev registered by the helper
283 int drm_fb_helper_debug_leave(struct fb_info *info)
285 struct drm_fb_helper *helper = info->par;
286 struct drm_crtc *crtc;
287 const struct drm_crtc_helper_funcs *funcs;
288 struct drm_framebuffer *fb;
291 for (i = 0; i < helper->crtc_count; i++) {
292 struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
293 crtc = mode_set->crtc;
294 funcs = crtc->helper_private;
295 fb = drm_mode_config_fb(crtc);
301 DRM_ERROR("no fb to restore??\n");
305 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
306 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
307 crtc->y, LEAVE_ATOMIC_MODE_SET);
312 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
314 static int restore_fbdev_mode_atomic(struct drm_fb_helper *fb_helper)
316 struct drm_device *dev = fb_helper->dev;
317 struct drm_plane *plane;
318 struct drm_atomic_state *state;
322 state = drm_atomic_state_alloc(dev);
326 state->acquire_ctx = dev->mode_config.acquire_ctx;
329 drm_for_each_plane(plane, dev) {
330 struct drm_plane_state *plane_state;
332 plane_state = drm_atomic_get_plane_state(state, plane);
333 if (IS_ERR(plane_state)) {
334 ret = PTR_ERR(plane_state);
338 plane_state->rotation = DRM_ROTATE_0;
340 plane->old_fb = plane->fb;
341 plane_mask |= 1 << drm_plane_index(plane);
343 /* disable non-primary: */
344 if (plane->type == DRM_PLANE_TYPE_PRIMARY)
347 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
352 for(i = 0; i < fb_helper->crtc_count; i++) {
353 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
355 ret = __drm_atomic_helper_set_config(mode_set, state);
360 ret = drm_atomic_commit(state);
363 drm_atomic_clean_old_fb(dev, plane_mask, ret);
369 drm_atomic_state_free(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 (dev->mode_config.rotation_property) {
396 drm_mode_plane_set_obj_prop(plane,
397 dev->mode_config.rotation_property,
402 for (i = 0; i < fb_helper->crtc_count; i++) {
403 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
404 struct drm_crtc *crtc = mode_set->crtc;
407 if (crtc->funcs->cursor_set2) {
408 ret = crtc->funcs->cursor_set2(crtc, NULL, 0, 0, 0, 0, 0);
411 } else if (crtc->funcs->cursor_set) {
412 ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
417 ret = drm_mode_set_config_internal(mode_set);
426 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
427 * @fb_helper: fbcon to restore
429 * This should be called from driver's drm ->lastclose callback
430 * when implementing an fbcon on top of kms using this helper. This ensures that
431 * the user isn't greeted with a black screen when e.g. X dies.
434 * Zero if everything went ok, negative error code otherwise.
436 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
438 struct drm_device *dev = fb_helper->dev;
442 if (!drm_fbdev_emulation)
445 drm_modeset_lock_all(dev);
446 ret = restore_fbdev_mode(fb_helper);
448 do_delayed = fb_helper->delayed_hotplug;
450 fb_helper->delayed_hotplug = false;
451 drm_modeset_unlock_all(dev);
454 drm_fb_helper_hotplug_event(fb_helper);
457 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
459 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
461 struct drm_device *dev = fb_helper->dev;
462 struct drm_crtc *crtc;
463 int bound = 0, crtcs_bound = 0;
465 /* Sometimes user space wants everything disabled, so don't steal the
466 * display if there's a master. */
467 if (lockless_dereference(dev->master))
470 drm_for_each_crtc(crtc, dev) {
471 if (crtc->primary->fb)
473 if (crtc->primary->fb == fb_helper->fb)
477 if (bound < crtcs_bound)
483 #ifdef CONFIG_MAGIC_SYSRQ
485 * restore fbcon display for all kms driver's using this helper, used for sysrq
486 * and panic handling.
488 static bool drm_fb_helper_force_kernel_mode(void)
490 bool ret, error = false;
491 struct drm_fb_helper *helper;
493 if (list_empty(&kernel_fb_helper_list))
496 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
497 struct drm_device *dev = helper->dev;
499 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
502 drm_modeset_lock_all(dev);
503 ret = restore_fbdev_mode(helper);
506 drm_modeset_unlock_all(dev);
511 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
514 ret = drm_fb_helper_force_kernel_mode();
516 DRM_ERROR("Failed to restore crtc configuration\n");
518 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
520 static void drm_fb_helper_sysrq(int dummy1)
522 schedule_work(&drm_fb_helper_restore_work);
525 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
526 .handler = drm_fb_helper_sysrq,
527 .help_msg = "force-fb(V)",
528 .action_msg = "Restore framebuffer console",
531 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
534 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
536 struct drm_fb_helper *fb_helper = info->par;
537 struct drm_device *dev = fb_helper->dev;
538 struct drm_crtc *crtc;
539 struct drm_connector *connector;
543 * For each CRTC in this fb, turn the connectors on/off.
545 drm_modeset_lock_all(dev);
546 if (!drm_fb_helper_is_bound(fb_helper)) {
547 drm_modeset_unlock_all(dev);
551 for (i = 0; i < fb_helper->crtc_count; i++) {
552 crtc = fb_helper->crtc_info[i].mode_set.crtc;
557 /* Walk the connectors & encoders on this fb turning them on/off */
558 for (j = 0; j < fb_helper->connector_count; j++) {
559 connector = fb_helper->connector_info[j]->connector;
560 connector->funcs->dpms(connector, dpms_mode);
561 drm_object_property_set_value(&connector->base,
562 dev->mode_config.dpms_property, dpms_mode);
565 drm_modeset_unlock_all(dev);
569 * drm_fb_helper_blank - implementation for ->fb_blank
570 * @blank: desired blanking state
571 * @info: fbdev registered by the helper
573 int drm_fb_helper_blank(int blank, struct fb_info *info)
575 if (oops_in_progress)
579 /* Display: On; HSync: On, VSync: On */
580 case FB_BLANK_UNBLANK:
581 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
583 /* Display: Off; HSync: On, VSync: On */
584 case FB_BLANK_NORMAL:
585 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
587 /* Display: Off; HSync: Off, VSync: On */
588 case FB_BLANK_HSYNC_SUSPEND:
589 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
591 /* Display: Off; HSync: On, VSync: Off */
592 case FB_BLANK_VSYNC_SUSPEND:
593 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
595 /* Display: Off; HSync: Off, VSync: Off */
596 case FB_BLANK_POWERDOWN:
597 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
602 EXPORT_SYMBOL(drm_fb_helper_blank);
604 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
608 for (i = 0; i < helper->connector_count; i++) {
609 drm_connector_unreference(helper->connector_info[i]->connector);
610 kfree(helper->connector_info[i]);
612 kfree(helper->connector_info);
613 for (i = 0; i < helper->crtc_count; i++) {
614 kfree(helper->crtc_info[i].mode_set.connectors);
615 if (helper->crtc_info[i].mode_set.mode)
616 drm_mode_destroy(helper->dev, helper->crtc_info[i].mode_set.mode);
618 kfree(helper->crtc_info);
621 static void drm_fb_helper_resume_worker(struct work_struct *work)
623 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
627 fb_set_suspend(helper->fbdev, 0);
631 static void drm_fb_helper_dirty_work(struct work_struct *work)
633 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
635 struct drm_clip_rect *clip = &helper->dirty_clip;
636 struct drm_clip_rect clip_copy;
639 spin_lock_irqsave(&helper->dirty_lock, flags);
641 clip->x1 = clip->y1 = ~0;
642 clip->x2 = clip->y2 = 0;
643 spin_unlock_irqrestore(&helper->dirty_lock, flags);
645 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
649 * drm_fb_helper_prepare - setup a drm_fb_helper structure
651 * @helper: driver-allocated fbdev helper structure to set up
652 * @funcs: pointer to structure of functions associate with this helper
654 * Sets up the bare minimum to make the framebuffer helper usable. This is
655 * useful to implement race-free initialization of the polling helpers.
657 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
658 const struct drm_fb_helper_funcs *funcs)
660 INIT_LIST_HEAD(&helper->kernel_fb_list);
661 spin_lock_init(&helper->dirty_lock);
662 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
663 INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
664 helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
665 helper->funcs = funcs;
668 EXPORT_SYMBOL(drm_fb_helper_prepare);
671 * drm_fb_helper_init - initialize a drm_fb_helper structure
673 * @fb_helper: driver-allocated fbdev helper structure to initialize
674 * @crtc_count: maximum number of crtcs to support in this fbdev emulation
675 * @max_conn_count: max connector count
677 * This allocates the structures for the fbdev helper with the given limits.
678 * Note that this won't yet touch the hardware (through the driver interfaces)
679 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
680 * to allow driver writes more control over the exact init sequence.
682 * Drivers must call drm_fb_helper_prepare() before calling this function.
685 * Zero if everything went ok, nonzero otherwise.
687 int drm_fb_helper_init(struct drm_device *dev,
688 struct drm_fb_helper *fb_helper,
689 int crtc_count, int max_conn_count)
691 struct drm_crtc *crtc;
694 if (!drm_fbdev_emulation)
700 fb_helper->crtc_info = kcalloc(crtc_count, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
701 if (!fb_helper->crtc_info)
704 fb_helper->crtc_count = crtc_count;
705 fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
706 if (!fb_helper->connector_info) {
707 kfree(fb_helper->crtc_info);
710 fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
711 fb_helper->connector_count = 0;
713 for (i = 0; i < crtc_count; i++) {
714 fb_helper->crtc_info[i].mode_set.connectors =
715 kcalloc(max_conn_count,
716 sizeof(struct drm_connector *),
719 if (!fb_helper->crtc_info[i].mode_set.connectors)
721 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
725 drm_for_each_crtc(crtc, dev) {
726 fb_helper->crtc_info[i].mode_set.crtc = crtc;
732 drm_fb_helper_crtc_free(fb_helper);
735 EXPORT_SYMBOL(drm_fb_helper_init);
738 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
739 * @fb_helper: driver-allocated fbdev helper
741 * A helper to alloc fb_info and the members cmap and apertures. Called
742 * by the driver within the fb_probe fb_helper callback function.
745 * fb_info pointer if things went okay, pointer containing error code
748 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
750 struct device *dev = fb_helper->dev->dev;
751 struct fb_info *info;
754 info = framebuffer_alloc(0, dev);
756 return ERR_PTR(-ENOMEM);
758 ret = fb_alloc_cmap(&info->cmap, 256, 0);
762 info->apertures = alloc_apertures(1);
763 if (!info->apertures) {
768 fb_helper->fbdev = info;
773 fb_dealloc_cmap(&info->cmap);
775 framebuffer_release(info);
778 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
781 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
782 * @fb_helper: driver-allocated fbdev helper
784 * A wrapper around unregister_framebuffer, to release the fb_info
787 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
789 if (fb_helper && fb_helper->fbdev)
790 unregister_framebuffer(fb_helper->fbdev);
792 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
795 * drm_fb_helper_release_fbi - dealloc fb_info and its members
796 * @fb_helper: driver-allocated fbdev helper
798 * A helper to free memory taken by fb_info and the members cmap and
801 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
804 struct fb_info *info = fb_helper->fbdev;
808 fb_dealloc_cmap(&info->cmap);
809 framebuffer_release(info);
812 fb_helper->fbdev = NULL;
815 EXPORT_SYMBOL(drm_fb_helper_release_fbi);
817 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
819 if (!drm_fbdev_emulation)
822 if (!list_empty(&fb_helper->kernel_fb_list)) {
823 list_del(&fb_helper->kernel_fb_list);
824 if (list_empty(&kernel_fb_helper_list)) {
825 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
829 drm_fb_helper_crtc_free(fb_helper);
832 EXPORT_SYMBOL(drm_fb_helper_fini);
835 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
836 * @fb_helper: driver-allocated fbdev helper
838 * A wrapper around unlink_framebuffer implemented by fbdev core
840 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
842 if (fb_helper && fb_helper->fbdev)
843 unlink_framebuffer(fb_helper->fbdev);
845 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
847 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
848 u32 width, u32 height)
850 struct drm_fb_helper *helper = info->par;
851 struct drm_clip_rect *clip = &helper->dirty_clip;
854 if (!helper->fb->funcs->dirty)
857 spin_lock_irqsave(&helper->dirty_lock, flags);
858 clip->x1 = min_t(u32, clip->x1, x);
859 clip->y1 = min_t(u32, clip->y1, y);
860 clip->x2 = max_t(u32, clip->x2, x + width);
861 clip->y2 = max_t(u32, clip->y2, y + height);
862 spin_unlock_irqrestore(&helper->dirty_lock, flags);
864 schedule_work(&helper->dirty_work);
868 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
869 * @info: fb_info struct pointer
870 * @pagelist: list of dirty mmap framebuffer pages
872 * This function is used as the &fb_deferred_io ->deferred_io
873 * callback function for flushing the fbdev mmap writes.
875 void drm_fb_helper_deferred_io(struct fb_info *info,
876 struct list_head *pagelist)
878 unsigned long start, end, min, max;
884 list_for_each_entry(page, pagelist, lru) {
885 start = page->index << PAGE_SHIFT;
886 end = start + PAGE_SIZE - 1;
887 min = min(min, start);
892 y1 = min / info->fix.line_length;
893 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
895 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
898 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
901 * drm_fb_helper_sys_read - wrapper around fb_sys_read
902 * @info: fb_info struct pointer
903 * @buf: userspace buffer to read from framebuffer memory
904 * @count: number of bytes to read from framebuffer memory
905 * @ppos: read offset within framebuffer memory
907 * A wrapper around fb_sys_read implemented by fbdev core
909 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
910 size_t count, loff_t *ppos)
912 return fb_sys_read(info, buf, count, ppos);
914 EXPORT_SYMBOL(drm_fb_helper_sys_read);
917 * drm_fb_helper_sys_write - wrapper around fb_sys_write
918 * @info: fb_info struct pointer
919 * @buf: userspace buffer to write to framebuffer memory
920 * @count: number of bytes to write to framebuffer memory
921 * @ppos: write offset within framebuffer memory
923 * A wrapper around fb_sys_write implemented by fbdev core
925 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
926 size_t count, loff_t *ppos)
930 ret = fb_sys_write(info, buf, count, ppos);
932 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
937 EXPORT_SYMBOL(drm_fb_helper_sys_write);
940 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
941 * @info: fbdev registered by the helper
942 * @rect: info about rectangle to fill
944 * A wrapper around sys_fillrect implemented by fbdev core
946 void drm_fb_helper_sys_fillrect(struct fb_info *info,
947 const struct fb_fillrect *rect)
949 sys_fillrect(info, rect);
950 drm_fb_helper_dirty(info, rect->dx, rect->dy,
951 rect->width, rect->height);
953 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
956 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
957 * @info: fbdev registered by the helper
958 * @area: info about area to copy
960 * A wrapper around sys_copyarea implemented by fbdev core
962 void drm_fb_helper_sys_copyarea(struct fb_info *info,
963 const struct fb_copyarea *area)
965 sys_copyarea(info, area);
966 drm_fb_helper_dirty(info, area->dx, area->dy,
967 area->width, area->height);
969 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
972 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
973 * @info: fbdev registered by the helper
974 * @image: info about image to blit
976 * A wrapper around sys_imageblit implemented by fbdev core
978 void drm_fb_helper_sys_imageblit(struct fb_info *info,
979 const struct fb_image *image)
981 sys_imageblit(info, image);
982 drm_fb_helper_dirty(info, image->dx, image->dy,
983 image->width, image->height);
985 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
988 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
989 * @info: fbdev registered by the helper
990 * @rect: info about rectangle to fill
992 * A wrapper around cfb_imageblit implemented by fbdev core
994 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
995 const struct fb_fillrect *rect)
997 cfb_fillrect(info, rect);
998 drm_fb_helper_dirty(info, rect->dx, rect->dy,
999 rect->width, rect->height);
1001 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
1004 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1005 * @info: fbdev registered by the helper
1006 * @area: info about area to copy
1008 * A wrapper around cfb_copyarea implemented by fbdev core
1010 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1011 const struct fb_copyarea *area)
1013 cfb_copyarea(info, area);
1014 drm_fb_helper_dirty(info, area->dx, area->dy,
1015 area->width, area->height);
1017 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1020 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1021 * @info: fbdev registered by the helper
1022 * @image: info about image to blit
1024 * A wrapper around cfb_imageblit implemented by fbdev core
1026 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1027 const struct fb_image *image)
1029 cfb_imageblit(info, image);
1030 drm_fb_helper_dirty(info, image->dx, image->dy,
1031 image->width, image->height);
1033 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1036 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1037 * @fb_helper: driver-allocated fbdev helper
1038 * @suspend: whether to suspend or resume
1040 * A wrapper around fb_set_suspend implemented by fbdev core.
1041 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1044 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
1046 if (fb_helper && fb_helper->fbdev)
1047 fb_set_suspend(fb_helper->fbdev, suspend);
1049 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1052 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1053 * takes the console lock
1054 * @fb_helper: driver-allocated fbdev helper
1055 * @suspend: whether to suspend or resume
1057 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1058 * isn't available on resume, a worker is tasked with waiting for the lock
1059 * to become available. The console lock can be pretty contented on resume
1060 * due to all the printk activity.
1062 * This function can be called multiple times with the same state since
1063 * &fb_info->state is checked to see if fbdev is running or not before locking.
1065 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1067 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
1070 if (!fb_helper || !fb_helper->fbdev)
1073 /* make sure there's no pending/ongoing resume */
1074 flush_work(&fb_helper->resume_work);
1077 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
1083 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
1086 if (!console_trylock()) {
1087 schedule_work(&fb_helper->resume_work);
1092 fb_set_suspend(fb_helper->fbdev, suspend);
1095 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
1097 static int setcolreg(struct drm_crtc *crtc, u16 red, u16 green,
1098 u16 blue, u16 regno, struct fb_info *info)
1100 struct drm_fb_helper *fb_helper = info->par;
1101 struct drm_framebuffer *fb = fb_helper->fb;
1103 if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
1106 /* place color in psuedopalette */
1109 palette = (u32 *)info->pseudo_palette;
1110 red >>= (16 - info->var.red.length);
1111 green >>= (16 - info->var.green.length);
1112 blue >>= (16 - info->var.blue.length);
1113 value = (red << info->var.red.offset) |
1114 (green << info->var.green.offset) |
1115 (blue << info->var.blue.offset);
1116 if (info->var.transp.length > 0) {
1117 u32 mask = (1 << info->var.transp.length) - 1;
1118 mask <<= info->var.transp.offset;
1121 palette[regno] = value;
1126 * The driver really shouldn't advertise pseudo/directcolor
1127 * visuals if it can't deal with the palette.
1129 if (WARN_ON(!fb_helper->funcs->gamma_set ||
1130 !fb_helper->funcs->gamma_get))
1133 WARN_ON(fb->bits_per_pixel != 8);
1135 fb_helper->funcs->gamma_set(crtc, red, green, blue, regno);
1141 * drm_fb_helper_setcmap - implementation for ->fb_setcmap
1142 * @cmap: cmap to set
1143 * @info: fbdev registered by the helper
1145 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1147 struct drm_fb_helper *fb_helper = info->par;
1148 struct drm_device *dev = fb_helper->dev;
1149 const struct drm_crtc_helper_funcs *crtc_funcs;
1150 u16 *red, *green, *blue, *transp;
1151 struct drm_crtc *crtc;
1155 if (oops_in_progress)
1158 drm_modeset_lock_all(dev);
1159 if (!drm_fb_helper_is_bound(fb_helper)) {
1160 drm_modeset_unlock_all(dev);
1164 for (i = 0; i < fb_helper->crtc_count; i++) {
1165 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1166 crtc_funcs = crtc->helper_private;
1169 green = cmap->green;
1171 transp = cmap->transp;
1172 start = cmap->start;
1174 for (j = 0; j < cmap->len; j++) {
1175 u16 hred, hgreen, hblue, htransp = 0xffff;
1182 htransp = *transp++;
1184 rc = setcolreg(crtc, hred, hgreen, hblue, start++, info);
1188 if (crtc_funcs->load_lut)
1189 crtc_funcs->load_lut(crtc);
1192 drm_modeset_unlock_all(dev);
1195 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1198 * drm_fb_helper_check_var - implementation for ->fb_check_var
1199 * @var: screeninfo to check
1200 * @info: fbdev registered by the helper
1202 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1203 struct fb_info *info)
1205 struct drm_fb_helper *fb_helper = info->par;
1206 struct drm_framebuffer *fb = fb_helper->fb;
1209 if (var->pixclock != 0 || in_dbg_master())
1212 /* Need to resize the fb object !!! */
1213 if (var->bits_per_pixel > fb->bits_per_pixel ||
1214 var->xres > fb->width || var->yres > fb->height ||
1215 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1216 DRM_DEBUG("fb userspace requested width/height/bpp is greater than current fb "
1217 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1218 var->xres, var->yres, var->bits_per_pixel,
1219 var->xres_virtual, var->yres_virtual,
1220 fb->width, fb->height, fb->bits_per_pixel);
1224 switch (var->bits_per_pixel) {
1226 depth = (var->green.length == 6) ? 16 : 15;
1229 depth = (var->transp.length > 0) ? 32 : 24;
1232 depth = var->bits_per_pixel;
1238 var->red.offset = 0;
1239 var->green.offset = 0;
1240 var->blue.offset = 0;
1241 var->red.length = 8;
1242 var->green.length = 8;
1243 var->blue.length = 8;
1244 var->transp.length = 0;
1245 var->transp.offset = 0;
1248 var->red.offset = 10;
1249 var->green.offset = 5;
1250 var->blue.offset = 0;
1251 var->red.length = 5;
1252 var->green.length = 5;
1253 var->blue.length = 5;
1254 var->transp.length = 1;
1255 var->transp.offset = 15;
1258 var->red.offset = 11;
1259 var->green.offset = 5;
1260 var->blue.offset = 0;
1261 var->red.length = 5;
1262 var->green.length = 6;
1263 var->blue.length = 5;
1264 var->transp.length = 0;
1265 var->transp.offset = 0;
1268 var->red.offset = 16;
1269 var->green.offset = 8;
1270 var->blue.offset = 0;
1271 var->red.length = 8;
1272 var->green.length = 8;
1273 var->blue.length = 8;
1274 var->transp.length = 0;
1275 var->transp.offset = 0;
1278 var->red.offset = 16;
1279 var->green.offset = 8;
1280 var->blue.offset = 0;
1281 var->red.length = 8;
1282 var->green.length = 8;
1283 var->blue.length = 8;
1284 var->transp.length = 8;
1285 var->transp.offset = 24;
1292 EXPORT_SYMBOL(drm_fb_helper_check_var);
1295 * drm_fb_helper_set_par - implementation for ->fb_set_par
1296 * @info: fbdev registered by the helper
1298 * This will let fbcon do the mode init and is called at initialization time by
1299 * the fbdev core when registering the driver, and later on through the hotplug
1302 int drm_fb_helper_set_par(struct fb_info *info)
1304 struct drm_fb_helper *fb_helper = info->par;
1305 struct fb_var_screeninfo *var = &info->var;
1307 if (oops_in_progress)
1310 if (var->pixclock != 0) {
1311 DRM_ERROR("PIXEL CLOCK SET\n");
1315 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1319 EXPORT_SYMBOL(drm_fb_helper_set_par);
1321 static int pan_display_atomic(struct fb_var_screeninfo *var,
1322 struct fb_info *info)
1324 struct drm_fb_helper *fb_helper = info->par;
1325 struct drm_device *dev = fb_helper->dev;
1326 struct drm_atomic_state *state;
1327 struct drm_plane *plane;
1329 unsigned plane_mask;
1331 state = drm_atomic_state_alloc(dev);
1335 state->acquire_ctx = dev->mode_config.acquire_ctx;
1338 for(i = 0; i < fb_helper->crtc_count; i++) {
1339 struct drm_mode_set *mode_set;
1341 mode_set = &fb_helper->crtc_info[i].mode_set;
1343 mode_set->x = var->xoffset;
1344 mode_set->y = var->yoffset;
1346 ret = __drm_atomic_helper_set_config(mode_set, state);
1350 plane = mode_set->crtc->primary;
1351 plane_mask |= (1 << drm_plane_index(plane));
1352 plane->old_fb = plane->fb;
1355 ret = drm_atomic_commit(state);
1359 info->var.xoffset = var->xoffset;
1360 info->var.yoffset = var->yoffset;
1364 drm_atomic_clean_old_fb(dev, plane_mask, ret);
1366 if (ret == -EDEADLK)
1370 drm_atomic_state_free(state);
1375 drm_atomic_state_clear(state);
1376 drm_atomic_legacy_backoff(state);
1382 * drm_fb_helper_pan_display - implementation for ->fb_pan_display
1383 * @var: updated screen information
1384 * @info: fbdev registered by the helper
1386 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1387 struct fb_info *info)
1389 struct drm_fb_helper *fb_helper = info->par;
1390 struct drm_device *dev = fb_helper->dev;
1391 struct drm_mode_set *modeset;
1395 if (oops_in_progress)
1398 drm_modeset_lock_all(dev);
1399 if (!drm_fb_helper_is_bound(fb_helper)) {
1400 drm_modeset_unlock_all(dev);
1404 if (dev->mode_config.funcs->atomic_commit) {
1405 ret = pan_display_atomic(var, info);
1409 for (i = 0; i < fb_helper->crtc_count; i++) {
1410 modeset = &fb_helper->crtc_info[i].mode_set;
1412 modeset->x = var->xoffset;
1413 modeset->y = var->yoffset;
1415 if (modeset->num_connectors) {
1416 ret = drm_mode_set_config_internal(modeset);
1418 info->var.xoffset = var->xoffset;
1419 info->var.yoffset = var->yoffset;
1424 drm_modeset_unlock_all(dev);
1427 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1430 * Allocates the backing storage and sets up the fbdev info structure through
1431 * the ->fb_probe callback and then registers the fbdev and sets up the panic
1434 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1440 struct fb_info *info;
1441 struct drm_fb_helper_surface_size sizes;
1444 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1445 sizes.surface_depth = 24;
1446 sizes.surface_bpp = 32;
1447 sizes.fb_width = (unsigned)-1;
1448 sizes.fb_height = (unsigned)-1;
1450 /* if driver picks 8 or 16 by default use that
1451 for both depth/bpp */
1452 if (preferred_bpp != sizes.surface_bpp)
1453 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1455 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1456 for (i = 0; i < fb_helper->connector_count; i++) {
1457 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1458 struct drm_cmdline_mode *cmdline_mode;
1460 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1462 if (cmdline_mode->bpp_specified) {
1463 switch (cmdline_mode->bpp) {
1465 sizes.surface_depth = sizes.surface_bpp = 8;
1468 sizes.surface_depth = 15;
1469 sizes.surface_bpp = 16;
1472 sizes.surface_depth = sizes.surface_bpp = 16;
1475 sizes.surface_depth = sizes.surface_bpp = 24;
1478 sizes.surface_depth = 24;
1479 sizes.surface_bpp = 32;
1487 for (i = 0; i < fb_helper->crtc_count; i++) {
1488 struct drm_display_mode *desired_mode;
1489 struct drm_mode_set *mode_set;
1491 /* in case of tile group, are we the last tile vert or horiz?
1492 * If no tile group you are always the last one both vertically
1495 bool lastv = true, lasth = true;
1497 desired_mode = fb_helper->crtc_info[i].desired_mode;
1498 mode_set = &fb_helper->crtc_info[i].mode_set;
1505 x = fb_helper->crtc_info[i].x;
1506 y = fb_helper->crtc_info[i].y;
1508 if (gamma_size == 0)
1509 gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1511 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1512 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1514 for (j = 0; j < mode_set->num_connectors; j++) {
1515 struct drm_connector *connector = mode_set->connectors[j];
1516 if (connector->has_tile) {
1517 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1518 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1519 /* cloning to multiple tiles is just crazy-talk, so: */
1525 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1527 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1530 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1531 /* hmm everyone went away - assume VGA cable just fell out
1532 and will come back later. */
1533 DRM_INFO("Cannot find any crtc or sizes - going 1024x768\n");
1534 sizes.fb_width = sizes.surface_width = 1024;
1535 sizes.fb_height = sizes.surface_height = 768;
1538 /* push down into drivers */
1539 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1543 info = fb_helper->fbdev;
1546 * Set the fb pointer - usually drm_setup_crtcs does this for hotplug
1547 * events, but at init time drm_setup_crtcs needs to be called before
1548 * the fb is allocated (since we need to figure out the desired size of
1549 * the fb before we can allocate it ...). Hence we need to fix things up
1552 for (i = 0; i < fb_helper->crtc_count; i++)
1553 if (fb_helper->crtc_info[i].mode_set.num_connectors)
1554 fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
1557 info->var.pixclock = 0;
1558 if (register_framebuffer(info) < 0)
1561 dev_info(fb_helper->dev->dev, "fb%d: %s frame buffer device\n",
1562 info->node, info->fix.id);
1564 if (list_empty(&kernel_fb_helper_list)) {
1565 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1568 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1574 * drm_fb_helper_fill_fix - initializes fixed fbdev information
1575 * @info: fbdev registered by the helper
1576 * @pitch: desired pitch
1577 * @depth: desired depth
1579 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1580 * fbdev emulations. Drivers which support acceleration methods which impose
1581 * additional constraints need to set up their own limits.
1583 * Drivers should call this (or their equivalent setup code) from their
1584 * ->fb_probe callback.
1586 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1589 info->fix.type = FB_TYPE_PACKED_PIXELS;
1590 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1591 FB_VISUAL_TRUECOLOR;
1592 info->fix.mmio_start = 0;
1593 info->fix.mmio_len = 0;
1594 info->fix.type_aux = 0;
1595 info->fix.xpanstep = 1; /* doing it in hw */
1596 info->fix.ypanstep = 1; /* doing it in hw */
1597 info->fix.ywrapstep = 0;
1598 info->fix.accel = FB_ACCEL_NONE;
1600 info->fix.line_length = pitch;
1603 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1606 * drm_fb_helper_fill_var - initalizes variable fbdev information
1607 * @info: fbdev instance to set up
1608 * @fb_helper: fb helper instance to use as template
1609 * @fb_width: desired fb width
1610 * @fb_height: desired fb height
1612 * Sets up the variable fbdev metainformation from the given fb helper instance
1613 * and the drm framebuffer allocated in fb_helper->fb.
1615 * Drivers should call this (or their equivalent setup code) from their
1616 * ->fb_probe callback after having allocated the fbdev backing
1617 * storage framebuffer.
1619 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1620 uint32_t fb_width, uint32_t fb_height)
1622 struct drm_framebuffer *fb = fb_helper->fb;
1623 info->pseudo_palette = fb_helper->pseudo_palette;
1624 info->var.xres_virtual = fb->width;
1625 info->var.yres_virtual = fb->height;
1626 info->var.bits_per_pixel = fb->bits_per_pixel;
1627 info->var.accel_flags = FB_ACCELF_TEXT;
1628 info->var.xoffset = 0;
1629 info->var.yoffset = 0;
1630 info->var.activate = FB_ACTIVATE_NOW;
1631 info->var.height = -1;
1632 info->var.width = -1;
1634 switch (fb->depth) {
1636 info->var.red.offset = 0;
1637 info->var.green.offset = 0;
1638 info->var.blue.offset = 0;
1639 info->var.red.length = 8; /* 8bit DAC */
1640 info->var.green.length = 8;
1641 info->var.blue.length = 8;
1642 info->var.transp.offset = 0;
1643 info->var.transp.length = 0;
1646 info->var.red.offset = 10;
1647 info->var.green.offset = 5;
1648 info->var.blue.offset = 0;
1649 info->var.red.length = 5;
1650 info->var.green.length = 5;
1651 info->var.blue.length = 5;
1652 info->var.transp.offset = 15;
1653 info->var.transp.length = 1;
1656 info->var.red.offset = 11;
1657 info->var.green.offset = 5;
1658 info->var.blue.offset = 0;
1659 info->var.red.length = 5;
1660 info->var.green.length = 6;
1661 info->var.blue.length = 5;
1662 info->var.transp.offset = 0;
1665 info->var.red.offset = 16;
1666 info->var.green.offset = 8;
1667 info->var.blue.offset = 0;
1668 info->var.red.length = 8;
1669 info->var.green.length = 8;
1670 info->var.blue.length = 8;
1671 info->var.transp.offset = 0;
1672 info->var.transp.length = 0;
1675 info->var.red.offset = 16;
1676 info->var.green.offset = 8;
1677 info->var.blue.offset = 0;
1678 info->var.red.length = 8;
1679 info->var.green.length = 8;
1680 info->var.blue.length = 8;
1681 info->var.transp.offset = 24;
1682 info->var.transp.length = 8;
1688 info->var.xres = fb_width;
1689 info->var.yres = fb_height;
1691 EXPORT_SYMBOL(drm_fb_helper_fill_var);
1693 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
1697 struct drm_connector *connector;
1701 for (i = 0; i < fb_helper->connector_count; i++) {
1702 connector = fb_helper->connector_info[i]->connector;
1703 count += connector->funcs->fill_modes(connector, maxX, maxY);
1709 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
1711 struct drm_display_mode *mode;
1713 list_for_each_entry(mode, &fb_connector->connector->modes, head) {
1714 if (mode->hdisplay > width ||
1715 mode->vdisplay > height)
1717 if (mode->type & DRM_MODE_TYPE_PREFERRED)
1722 EXPORT_SYMBOL(drm_has_preferred_mode);
1724 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
1726 return fb_connector->connector->cmdline_mode.specified;
1729 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
1730 int width, int height)
1732 struct drm_cmdline_mode *cmdline_mode;
1733 struct drm_display_mode *mode;
1734 bool prefer_non_interlace;
1736 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1737 if (cmdline_mode->specified == false)
1740 /* attempt to find a matching mode in the list of modes
1741 * we have gotten so far, if not add a CVT mode that conforms
1743 if (cmdline_mode->rb || cmdline_mode->margins)
1746 prefer_non_interlace = !cmdline_mode->interlace;
1748 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1749 /* check width/height */
1750 if (mode->hdisplay != cmdline_mode->xres ||
1751 mode->vdisplay != cmdline_mode->yres)
1754 if (cmdline_mode->refresh_specified) {
1755 if (mode->vrefresh != cmdline_mode->refresh)
1759 if (cmdline_mode->interlace) {
1760 if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
1762 } else if (prefer_non_interlace) {
1763 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
1769 if (prefer_non_interlace) {
1770 prefer_non_interlace = false;
1775 mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
1777 list_add(&mode->head, &fb_helper_conn->connector->modes);
1780 EXPORT_SYMBOL(drm_pick_cmdline_mode);
1782 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
1787 enable = connector->status == connector_status_connected;
1789 enable = connector->status != connector_status_disconnected;
1794 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
1797 bool any_enabled = false;
1798 struct drm_connector *connector;
1801 for (i = 0; i < fb_helper->connector_count; i++) {
1802 connector = fb_helper->connector_info[i]->connector;
1803 enabled[i] = drm_connector_enabled(connector, true);
1804 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
1805 enabled[i] ? "yes" : "no");
1806 any_enabled |= enabled[i];
1812 for (i = 0; i < fb_helper->connector_count; i++) {
1813 connector = fb_helper->connector_info[i]->connector;
1814 enabled[i] = drm_connector_enabled(connector, false);
1818 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
1819 struct drm_display_mode **modes,
1820 struct drm_fb_offset *offsets,
1821 bool *enabled, int width, int height)
1824 bool can_clone = false;
1825 struct drm_fb_helper_connector *fb_helper_conn;
1826 struct drm_display_mode *dmt_mode, *mode;
1828 /* only contemplate cloning in the single crtc case */
1829 if (fb_helper->crtc_count > 1)
1833 for (i = 0; i < fb_helper->connector_count; i++) {
1838 /* only contemplate cloning if more than one connector is enabled */
1842 /* check the command line or if nothing common pick 1024x768 */
1844 for (i = 0; i < fb_helper->connector_count; i++) {
1847 fb_helper_conn = fb_helper->connector_info[i];
1848 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1853 for (j = 0; j < i; j++) {
1856 if (!drm_mode_equal(modes[j], modes[i]))
1862 DRM_DEBUG_KMS("can clone using command line\n");
1866 /* try and find a 1024x768 mode on each connector */
1868 dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
1870 for (i = 0; i < fb_helper->connector_count; i++) {
1875 fb_helper_conn = fb_helper->connector_info[i];
1876 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1877 if (drm_mode_equal(mode, dmt_mode))
1885 DRM_DEBUG_KMS("can clone using 1024x768\n");
1888 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
1892 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
1893 struct drm_display_mode **modes,
1894 struct drm_fb_offset *offsets,
1896 int h_idx, int v_idx)
1898 struct drm_fb_helper_connector *fb_helper_conn;
1900 int hoffset = 0, voffset = 0;
1902 for (i = 0; i < fb_helper->connector_count; i++) {
1903 fb_helper_conn = fb_helper->connector_info[i];
1904 if (!fb_helper_conn->connector->has_tile)
1907 if (!modes[i] && (h_idx || v_idx)) {
1908 DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
1909 fb_helper_conn->connector->base.id);
1912 if (fb_helper_conn->connector->tile_h_loc < h_idx)
1913 hoffset += modes[i]->hdisplay;
1915 if (fb_helper_conn->connector->tile_v_loc < v_idx)
1916 voffset += modes[i]->vdisplay;
1918 offsets[idx].x = hoffset;
1919 offsets[idx].y = voffset;
1920 DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
1924 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
1925 struct drm_display_mode **modes,
1926 struct drm_fb_offset *offsets,
1927 bool *enabled, int width, int height)
1929 struct drm_fb_helper_connector *fb_helper_conn;
1931 uint64_t conn_configured = 0, mask;
1933 mask = (1 << fb_helper->connector_count) - 1;
1935 for (i = 0; i < fb_helper->connector_count; i++) {
1936 fb_helper_conn = fb_helper->connector_info[i];
1938 if (conn_configured & (1 << i))
1941 if (enabled[i] == false) {
1942 conn_configured |= (1 << i);
1946 /* first pass over all the untiled connectors */
1947 if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
1950 if (tile_pass == 1) {
1951 if (fb_helper_conn->connector->tile_h_loc != 0 ||
1952 fb_helper_conn->connector->tile_v_loc != 0)
1956 if (fb_helper_conn->connector->tile_h_loc != tile_pass -1 &&
1957 fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
1958 /* if this tile_pass doesn't cover any of the tiles - keep going */
1961 /* find the tile offsets for this pass - need
1962 to find all tiles left and above */
1963 drm_get_tile_offsets(fb_helper, modes, offsets,
1964 i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
1966 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
1967 fb_helper_conn->connector->base.id);
1969 /* got for command line mode first */
1970 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1972 DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
1973 fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
1974 modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
1976 /* No preferred modes, pick one off the list */
1977 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
1978 list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
1981 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
1983 conn_configured |= (1 << i);
1986 if ((conn_configured & mask) != mask) {
1993 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
1994 struct drm_fb_helper_crtc **best_crtcs,
1995 struct drm_display_mode **modes,
1996 int n, int width, int height)
1999 struct drm_connector *connector;
2000 const struct drm_connector_helper_funcs *connector_funcs;
2001 struct drm_encoder *encoder;
2002 int my_score, best_score, score;
2003 struct drm_fb_helper_crtc **crtcs, *crtc;
2004 struct drm_fb_helper_connector *fb_helper_conn;
2006 if (n == fb_helper->connector_count)
2009 fb_helper_conn = fb_helper->connector_info[n];
2010 connector = fb_helper_conn->connector;
2012 best_crtcs[n] = NULL;
2013 best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
2014 if (modes[n] == NULL)
2017 crtcs = kzalloc(fb_helper->connector_count *
2018 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2023 if (connector->status == connector_status_connected)
2025 if (drm_has_cmdline_mode(fb_helper_conn))
2027 if (drm_has_preferred_mode(fb_helper_conn, width, height))
2030 connector_funcs = connector->helper_private;
2033 * If the DRM device implements atomic hooks and ->best_encoder() is
2034 * NULL we fallback to the default drm_atomic_helper_best_encoder()
2037 if (fb_helper->dev->mode_config.funcs->atomic_commit &&
2038 !connector_funcs->best_encoder)
2039 encoder = drm_atomic_helper_best_encoder(connector);
2041 encoder = connector_funcs->best_encoder(connector);
2046 /* select a crtc for this connector and then attempt to configure
2047 remaining connectors */
2048 for (c = 0; c < fb_helper->crtc_count; c++) {
2049 crtc = &fb_helper->crtc_info[c];
2051 if ((encoder->possible_crtcs & (1 << c)) == 0)
2054 for (o = 0; o < n; o++)
2055 if (best_crtcs[o] == crtc)
2059 /* ignore cloning unless only a single crtc */
2060 if (fb_helper->crtc_count > 1)
2063 if (!drm_mode_equal(modes[o], modes[n]))
2068 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
2069 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
2071 if (score > best_score) {
2073 memcpy(best_crtcs, crtcs,
2074 fb_helper->connector_count *
2075 sizeof(struct drm_fb_helper_crtc *));
2083 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper)
2085 struct drm_device *dev = fb_helper->dev;
2086 struct drm_fb_helper_crtc **crtcs;
2087 struct drm_display_mode **modes;
2088 struct drm_fb_offset *offsets;
2089 struct drm_mode_set *modeset;
2094 DRM_DEBUG_KMS("\n");
2096 width = dev->mode_config.max_width;
2097 height = dev->mode_config.max_height;
2099 crtcs = kcalloc(fb_helper->connector_count,
2100 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2101 modes = kcalloc(fb_helper->connector_count,
2102 sizeof(struct drm_display_mode *), GFP_KERNEL);
2103 offsets = kcalloc(fb_helper->connector_count,
2104 sizeof(struct drm_fb_offset), GFP_KERNEL);
2105 enabled = kcalloc(fb_helper->connector_count,
2106 sizeof(bool), GFP_KERNEL);
2107 if (!crtcs || !modes || !enabled || !offsets) {
2108 DRM_ERROR("Memory allocation failed\n");
2113 drm_enable_connectors(fb_helper, enabled);
2115 if (!(fb_helper->funcs->initial_config &&
2116 fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2118 enabled, width, height))) {
2119 memset(modes, 0, fb_helper->connector_count*sizeof(modes[0]));
2120 memset(crtcs, 0, fb_helper->connector_count*sizeof(crtcs[0]));
2121 memset(offsets, 0, fb_helper->connector_count*sizeof(offsets[0]));
2123 if (!drm_target_cloned(fb_helper, modes, offsets,
2124 enabled, width, height) &&
2125 !drm_target_preferred(fb_helper, modes, offsets,
2126 enabled, width, height))
2127 DRM_ERROR("Unable to find initial modes\n");
2129 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2132 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2135 /* need to set the modesets up here for use later */
2136 /* fill out the connector<->crtc mappings into the modesets */
2137 for (i = 0; i < fb_helper->crtc_count; i++) {
2138 modeset = &fb_helper->crtc_info[i].mode_set;
2139 modeset->num_connectors = 0;
2143 for (i = 0; i < fb_helper->connector_count; i++) {
2144 struct drm_display_mode *mode = modes[i];
2145 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2146 struct drm_fb_offset *offset = &offsets[i];
2147 modeset = &fb_crtc->mode_set;
2149 if (mode && fb_crtc) {
2150 DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2151 mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2152 fb_crtc->desired_mode = mode;
2153 fb_crtc->x = offset->x;
2154 fb_crtc->y = offset->y;
2156 drm_mode_destroy(dev, modeset->mode);
2157 modeset->mode = drm_mode_duplicate(dev,
2158 fb_crtc->desired_mode);
2159 modeset->connectors[modeset->num_connectors++] = fb_helper->connector_info[i]->connector;
2160 modeset->fb = fb_helper->fb;
2161 modeset->x = offset->x;
2162 modeset->y = offset->y;
2166 /* Clear out any old modes if there are no more connected outputs. */
2167 for (i = 0; i < fb_helper->crtc_count; i++) {
2168 modeset = &fb_helper->crtc_info[i].mode_set;
2169 if (modeset->num_connectors == 0) {
2170 BUG_ON(modeset->fb);
2172 drm_mode_destroy(dev, modeset->mode);
2173 modeset->mode = NULL;
2184 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2185 * @fb_helper: fb_helper device struct
2186 * @bpp_sel: bpp value to use for the framebuffer configuration
2188 * Scans the CRTCs and connectors and tries to put together an initial setup.
2189 * At the moment, this is a cloned configuration across all heads with
2190 * a new framebuffer object as the backing store.
2192 * Note that this also registers the fbdev and so allows userspace to call into
2193 * the driver through the fbdev interfaces.
2195 * This function will call down into the ->fb_probe callback to let
2196 * the driver allocate and initialize the fbdev info structure and the drm
2197 * framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2198 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2199 * values for the fbdev info structure.
2203 * When you have fbcon support built-in or already loaded, this function will do
2204 * a full modeset to setup the fbdev console. Due to locking misdesign in the
2205 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2206 * console_lock. Until console_unlock is called no dmesg lines will be sent out
2207 * to consoles, not even serial console. This means when your driver crashes,
2208 * you will see absolutely nothing else but a system stuck in this function,
2209 * with no further output. Any kind of printk() you place within your own driver
2210 * or in the drm core modeset code will also never show up.
2212 * Standard debug practice is to run the fbcon setup without taking the
2213 * console_lock as a hack, to be able to see backtraces and crashes on the
2214 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2217 * The other option is to just disable fbdev emulation since very likely the
2218 * first modeset from userspace will crash in the same way, and is even easier
2219 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2220 * kernel cmdline option.
2223 * Zero if everything went ok, nonzero otherwise.
2225 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2227 struct drm_device *dev = fb_helper->dev;
2230 if (!drm_fbdev_emulation)
2233 mutex_lock(&dev->mode_config.mutex);
2234 count = drm_fb_helper_probe_connector_modes(fb_helper,
2235 dev->mode_config.max_width,
2236 dev->mode_config.max_height);
2237 mutex_unlock(&dev->mode_config.mutex);
2239 * we shouldn't end up with no modes here.
2242 dev_info(fb_helper->dev->dev, "No connectors reported connected with modes\n");
2244 drm_setup_crtcs(fb_helper);
2246 return drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2248 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2251 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2252 * probing all the outputs attached to the fb
2253 * @fb_helper: the drm_fb_helper
2255 * Scan the connectors attached to the fb_helper and try to put together a
2256 * setup after notification of a change in output configuration.
2258 * Called at runtime, takes the mode config locks to be able to check/change the
2259 * modeset configuration. Must be run from process context (which usually means
2260 * either the output polling work or a work item launched from the driver's
2261 * hotplug interrupt).
2263 * Note that drivers may call this even before calling
2264 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2265 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2266 * not miss any hotplug events.
2269 * 0 on success and a non-zero error code otherwise.
2271 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2273 struct drm_device *dev = fb_helper->dev;
2274 u32 max_width, max_height;
2276 if (!drm_fbdev_emulation)
2279 mutex_lock(&fb_helper->dev->mode_config.mutex);
2280 if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2281 fb_helper->delayed_hotplug = true;
2282 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2285 DRM_DEBUG_KMS("\n");
2287 max_width = fb_helper->fb->width;
2288 max_height = fb_helper->fb->height;
2290 drm_fb_helper_probe_connector_modes(fb_helper, max_width, max_height);
2291 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2293 drm_modeset_lock_all(dev);
2294 drm_setup_crtcs(fb_helper);
2295 drm_modeset_unlock_all(dev);
2296 drm_fb_helper_set_par(fb_helper->fbdev);
2300 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2302 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2303 * but the module doesn't depend on any fb console symbols. At least
2304 * attempt to load fbcon to avoid leaving the system without a usable console.
2306 int __init drm_fb_helper_modinit(void)
2308 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2309 const char *name = "fbcon";
2310 struct module *fbcon;
2312 mutex_lock(&module_mutex);
2313 fbcon = find_module(name);
2314 mutex_unlock(&module_mutex);
2317 request_module_nowait(name);
2321 EXPORT_SYMBOL(drm_fb_helper_modinit);