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/kernel.h>
33 #include <linux/sysrq.h>
34 #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 = BIT(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 (fb_helper->atomic)
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 (dev->primary->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_dirty_work(struct work_struct *work)
623 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
625 struct drm_clip_rect *clip = &helper->dirty_clip;
626 struct drm_clip_rect clip_copy;
629 spin_lock_irqsave(&helper->dirty_lock, flags);
631 clip->x1 = clip->y1 = ~0;
632 clip->x2 = clip->y2 = 0;
633 spin_unlock_irqrestore(&helper->dirty_lock, flags);
635 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
639 * drm_fb_helper_prepare - setup a drm_fb_helper structure
641 * @helper: driver-allocated fbdev helper structure to set up
642 * @funcs: pointer to structure of functions associate with this helper
644 * Sets up the bare minimum to make the framebuffer helper usable. This is
645 * useful to implement race-free initialization of the polling helpers.
647 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
648 const struct drm_fb_helper_funcs *funcs)
650 INIT_LIST_HEAD(&helper->kernel_fb_list);
651 spin_lock_init(&helper->dirty_lock);
652 INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
653 helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
654 helper->funcs = funcs;
657 EXPORT_SYMBOL(drm_fb_helper_prepare);
660 * drm_fb_helper_init - initialize a drm_fb_helper structure
662 * @fb_helper: driver-allocated fbdev helper structure to initialize
663 * @crtc_count: maximum number of crtcs to support in this fbdev emulation
664 * @max_conn_count: max connector count
666 * This allocates the structures for the fbdev helper with the given limits.
667 * Note that this won't yet touch the hardware (through the driver interfaces)
668 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
669 * to allow driver writes more control over the exact init sequence.
671 * Drivers must call drm_fb_helper_prepare() before calling this function.
674 * Zero if everything went ok, nonzero otherwise.
676 int drm_fb_helper_init(struct drm_device *dev,
677 struct drm_fb_helper *fb_helper,
678 int crtc_count, int max_conn_count)
680 struct drm_crtc *crtc;
683 if (!drm_fbdev_emulation)
689 fb_helper->crtc_info = kcalloc(crtc_count, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
690 if (!fb_helper->crtc_info)
693 fb_helper->crtc_count = crtc_count;
694 fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
695 if (!fb_helper->connector_info) {
696 kfree(fb_helper->crtc_info);
699 fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
700 fb_helper->connector_count = 0;
702 for (i = 0; i < crtc_count; i++) {
703 fb_helper->crtc_info[i].mode_set.connectors =
704 kcalloc(max_conn_count,
705 sizeof(struct drm_connector *),
708 if (!fb_helper->crtc_info[i].mode_set.connectors)
710 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
714 drm_for_each_crtc(crtc, dev) {
715 fb_helper->crtc_info[i].mode_set.crtc = crtc;
719 fb_helper->atomic = !!drm_core_check_feature(dev, DRIVER_ATOMIC);
723 drm_fb_helper_crtc_free(fb_helper);
726 EXPORT_SYMBOL(drm_fb_helper_init);
729 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
730 * @fb_helper: driver-allocated fbdev helper
732 * A helper to alloc fb_info and the members cmap and apertures. Called
733 * by the driver within the fb_probe fb_helper callback function.
736 * fb_info pointer if things went okay, pointer containing error code
739 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
741 struct device *dev = fb_helper->dev->dev;
742 struct fb_info *info;
745 info = framebuffer_alloc(0, dev);
747 return ERR_PTR(-ENOMEM);
749 ret = fb_alloc_cmap(&info->cmap, 256, 0);
753 info->apertures = alloc_apertures(1);
754 if (!info->apertures) {
759 fb_helper->fbdev = info;
764 fb_dealloc_cmap(&info->cmap);
766 framebuffer_release(info);
769 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
772 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
773 * @fb_helper: driver-allocated fbdev helper
775 * A wrapper around unregister_framebuffer, to release the fb_info
778 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
780 if (fb_helper && fb_helper->fbdev)
781 unregister_framebuffer(fb_helper->fbdev);
783 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
786 * drm_fb_helper_release_fbi - dealloc fb_info and its members
787 * @fb_helper: driver-allocated fbdev helper
789 * A helper to free memory taken by fb_info and the members cmap and
792 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
795 struct fb_info *info = fb_helper->fbdev;
799 fb_dealloc_cmap(&info->cmap);
800 framebuffer_release(info);
803 fb_helper->fbdev = NULL;
806 EXPORT_SYMBOL(drm_fb_helper_release_fbi);
808 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
810 if (!drm_fbdev_emulation)
813 if (!list_empty(&fb_helper->kernel_fb_list)) {
814 list_del(&fb_helper->kernel_fb_list);
815 if (list_empty(&kernel_fb_helper_list)) {
816 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
820 drm_fb_helper_crtc_free(fb_helper);
823 EXPORT_SYMBOL(drm_fb_helper_fini);
826 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
827 * @fb_helper: driver-allocated fbdev helper
829 * A wrapper around unlink_framebuffer implemented by fbdev core
831 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
833 if (fb_helper && fb_helper->fbdev)
834 unlink_framebuffer(fb_helper->fbdev);
836 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
838 static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
839 u32 width, u32 height)
841 struct drm_fb_helper *helper = info->par;
842 struct drm_clip_rect *clip = &helper->dirty_clip;
845 if (!helper->fb->funcs->dirty)
848 spin_lock_irqsave(&helper->dirty_lock, flags);
849 clip->x1 = min_t(u32, clip->x1, x);
850 clip->y1 = min_t(u32, clip->y1, y);
851 clip->x2 = max_t(u32, clip->x2, x + width);
852 clip->y2 = max_t(u32, clip->y2, y + height);
853 spin_unlock_irqrestore(&helper->dirty_lock, flags);
855 schedule_work(&helper->dirty_work);
859 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
860 * @info: fb_info struct pointer
861 * @pagelist: list of dirty mmap framebuffer pages
863 * This function is used as the &fb_deferred_io ->deferred_io
864 * callback function for flushing the fbdev mmap writes.
866 void drm_fb_helper_deferred_io(struct fb_info *info,
867 struct list_head *pagelist)
869 unsigned long start, end, min, max;
875 list_for_each_entry(page, pagelist, lru) {
876 start = page->index << PAGE_SHIFT;
877 end = start + PAGE_SIZE - 1;
878 min = min(min, start);
883 y1 = min / info->fix.line_length;
884 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
886 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
889 EXPORT_SYMBOL(drm_fb_helper_deferred_io);
892 * drm_fb_helper_sys_read - wrapper around fb_sys_read
893 * @info: fb_info struct pointer
894 * @buf: userspace buffer to read from framebuffer memory
895 * @count: number of bytes to read from framebuffer memory
896 * @ppos: read offset within framebuffer memory
898 * A wrapper around fb_sys_read implemented by fbdev core
900 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
901 size_t count, loff_t *ppos)
903 return fb_sys_read(info, buf, count, ppos);
905 EXPORT_SYMBOL(drm_fb_helper_sys_read);
908 * drm_fb_helper_sys_write - wrapper around fb_sys_write
909 * @info: fb_info struct pointer
910 * @buf: userspace buffer to write to framebuffer memory
911 * @count: number of bytes to write to framebuffer memory
912 * @ppos: write offset within framebuffer memory
914 * A wrapper around fb_sys_write implemented by fbdev core
916 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
917 size_t count, loff_t *ppos)
921 ret = fb_sys_write(info, buf, count, ppos);
923 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
928 EXPORT_SYMBOL(drm_fb_helper_sys_write);
931 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
932 * @info: fbdev registered by the helper
933 * @rect: info about rectangle to fill
935 * A wrapper around sys_fillrect implemented by fbdev core
937 void drm_fb_helper_sys_fillrect(struct fb_info *info,
938 const struct fb_fillrect *rect)
940 sys_fillrect(info, rect);
941 drm_fb_helper_dirty(info, rect->dx, rect->dy,
942 rect->width, rect->height);
944 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
947 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
948 * @info: fbdev registered by the helper
949 * @area: info about area to copy
951 * A wrapper around sys_copyarea implemented by fbdev core
953 void drm_fb_helper_sys_copyarea(struct fb_info *info,
954 const struct fb_copyarea *area)
956 sys_copyarea(info, area);
957 drm_fb_helper_dirty(info, area->dx, area->dy,
958 area->width, area->height);
960 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
963 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
964 * @info: fbdev registered by the helper
965 * @image: info about image to blit
967 * A wrapper around sys_imageblit implemented by fbdev core
969 void drm_fb_helper_sys_imageblit(struct fb_info *info,
970 const struct fb_image *image)
972 sys_imageblit(info, image);
973 drm_fb_helper_dirty(info, image->dx, image->dy,
974 image->width, image->height);
976 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
979 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
980 * @info: fbdev registered by the helper
981 * @rect: info about rectangle to fill
983 * A wrapper around cfb_imageblit implemented by fbdev core
985 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
986 const struct fb_fillrect *rect)
988 cfb_fillrect(info, rect);
989 drm_fb_helper_dirty(info, rect->dx, rect->dy,
990 rect->width, rect->height);
992 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
995 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
996 * @info: fbdev registered by the helper
997 * @area: info about area to copy
999 * A wrapper around cfb_copyarea implemented by fbdev core
1001 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1002 const struct fb_copyarea *area)
1004 cfb_copyarea(info, area);
1005 drm_fb_helper_dirty(info, area->dx, area->dy,
1006 area->width, area->height);
1008 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1011 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1012 * @info: fbdev registered by the helper
1013 * @image: info about image to blit
1015 * A wrapper around cfb_imageblit implemented by fbdev core
1017 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1018 const struct fb_image *image)
1020 cfb_imageblit(info, image);
1021 drm_fb_helper_dirty(info, image->dx, image->dy,
1022 image->width, image->height);
1024 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1027 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1028 * @fb_helper: driver-allocated fbdev helper
1029 * @state: desired state, zero to resume, non-zero to suspend
1031 * A wrapper around fb_set_suspend implemented by fbdev core
1033 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, int state)
1035 if (fb_helper && fb_helper->fbdev)
1036 fb_set_suspend(fb_helper->fbdev, state);
1038 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1040 static int setcolreg(struct drm_crtc *crtc, u16 red, u16 green,
1041 u16 blue, u16 regno, struct fb_info *info)
1043 struct drm_fb_helper *fb_helper = info->par;
1044 struct drm_framebuffer *fb = fb_helper->fb;
1046 if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
1049 /* place color in psuedopalette */
1052 palette = (u32 *)info->pseudo_palette;
1053 red >>= (16 - info->var.red.length);
1054 green >>= (16 - info->var.green.length);
1055 blue >>= (16 - info->var.blue.length);
1056 value = (red << info->var.red.offset) |
1057 (green << info->var.green.offset) |
1058 (blue << info->var.blue.offset);
1059 if (info->var.transp.length > 0) {
1060 u32 mask = (1 << info->var.transp.length) - 1;
1061 mask <<= info->var.transp.offset;
1064 palette[regno] = value;
1069 * The driver really shouldn't advertise pseudo/directcolor
1070 * visuals if it can't deal with the palette.
1072 if (WARN_ON(!fb_helper->funcs->gamma_set ||
1073 !fb_helper->funcs->gamma_get))
1076 WARN_ON(fb->bits_per_pixel != 8);
1078 fb_helper->funcs->gamma_set(crtc, red, green, blue, regno);
1084 * drm_fb_helper_setcmap - implementation for ->fb_setcmap
1085 * @cmap: cmap to set
1086 * @info: fbdev registered by the helper
1088 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1090 struct drm_fb_helper *fb_helper = info->par;
1091 struct drm_device *dev = fb_helper->dev;
1092 const struct drm_crtc_helper_funcs *crtc_funcs;
1093 u16 *red, *green, *blue, *transp;
1094 struct drm_crtc *crtc;
1098 if (oops_in_progress)
1101 drm_modeset_lock_all(dev);
1102 if (!drm_fb_helper_is_bound(fb_helper)) {
1103 drm_modeset_unlock_all(dev);
1107 for (i = 0; i < fb_helper->crtc_count; i++) {
1108 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1109 crtc_funcs = crtc->helper_private;
1112 green = cmap->green;
1114 transp = cmap->transp;
1115 start = cmap->start;
1117 for (j = 0; j < cmap->len; j++) {
1118 u16 hred, hgreen, hblue, htransp = 0xffff;
1125 htransp = *transp++;
1127 rc = setcolreg(crtc, hred, hgreen, hblue, start++, info);
1131 if (crtc_funcs->load_lut)
1132 crtc_funcs->load_lut(crtc);
1135 drm_modeset_unlock_all(dev);
1138 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1141 * drm_fb_helper_check_var - implementation for ->fb_check_var
1142 * @var: screeninfo to check
1143 * @info: fbdev registered by the helper
1145 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1146 struct fb_info *info)
1148 struct drm_fb_helper *fb_helper = info->par;
1149 struct drm_framebuffer *fb = fb_helper->fb;
1152 if (var->pixclock != 0 || in_dbg_master())
1155 /* Need to resize the fb object !!! */
1156 if (var->bits_per_pixel > fb->bits_per_pixel ||
1157 var->xres > fb->width || var->yres > fb->height ||
1158 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1159 DRM_DEBUG("fb userspace requested width/height/bpp is greater than current fb "
1160 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1161 var->xres, var->yres, var->bits_per_pixel,
1162 var->xres_virtual, var->yres_virtual,
1163 fb->width, fb->height, fb->bits_per_pixel);
1167 switch (var->bits_per_pixel) {
1169 depth = (var->green.length == 6) ? 16 : 15;
1172 depth = (var->transp.length > 0) ? 32 : 24;
1175 depth = var->bits_per_pixel;
1181 var->red.offset = 0;
1182 var->green.offset = 0;
1183 var->blue.offset = 0;
1184 var->red.length = 8;
1185 var->green.length = 8;
1186 var->blue.length = 8;
1187 var->transp.length = 0;
1188 var->transp.offset = 0;
1191 var->red.offset = 10;
1192 var->green.offset = 5;
1193 var->blue.offset = 0;
1194 var->red.length = 5;
1195 var->green.length = 5;
1196 var->blue.length = 5;
1197 var->transp.length = 1;
1198 var->transp.offset = 15;
1201 var->red.offset = 11;
1202 var->green.offset = 5;
1203 var->blue.offset = 0;
1204 var->red.length = 5;
1205 var->green.length = 6;
1206 var->blue.length = 5;
1207 var->transp.length = 0;
1208 var->transp.offset = 0;
1211 var->red.offset = 16;
1212 var->green.offset = 8;
1213 var->blue.offset = 0;
1214 var->red.length = 8;
1215 var->green.length = 8;
1216 var->blue.length = 8;
1217 var->transp.length = 0;
1218 var->transp.offset = 0;
1221 var->red.offset = 16;
1222 var->green.offset = 8;
1223 var->blue.offset = 0;
1224 var->red.length = 8;
1225 var->green.length = 8;
1226 var->blue.length = 8;
1227 var->transp.length = 8;
1228 var->transp.offset = 24;
1235 EXPORT_SYMBOL(drm_fb_helper_check_var);
1238 * drm_fb_helper_set_par - implementation for ->fb_set_par
1239 * @info: fbdev registered by the helper
1241 * This will let fbcon do the mode init and is called at initialization time by
1242 * the fbdev core when registering the driver, and later on through the hotplug
1245 int drm_fb_helper_set_par(struct fb_info *info)
1247 struct drm_fb_helper *fb_helper = info->par;
1248 struct fb_var_screeninfo *var = &info->var;
1250 if (oops_in_progress)
1253 if (var->pixclock != 0) {
1254 DRM_ERROR("PIXEL CLOCK SET\n");
1258 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1262 EXPORT_SYMBOL(drm_fb_helper_set_par);
1264 static int pan_display_atomic(struct fb_var_screeninfo *var,
1265 struct fb_info *info)
1267 struct drm_fb_helper *fb_helper = info->par;
1268 struct drm_device *dev = fb_helper->dev;
1269 struct drm_atomic_state *state;
1270 struct drm_plane *plane;
1272 unsigned plane_mask;
1274 state = drm_atomic_state_alloc(dev);
1278 state->acquire_ctx = dev->mode_config.acquire_ctx;
1281 for(i = 0; i < fb_helper->crtc_count; i++) {
1282 struct drm_mode_set *mode_set;
1284 mode_set = &fb_helper->crtc_info[i].mode_set;
1286 mode_set->x = var->xoffset;
1287 mode_set->y = var->yoffset;
1289 ret = __drm_atomic_helper_set_config(mode_set, state);
1293 plane = mode_set->crtc->primary;
1294 plane_mask |= (1 << drm_plane_index(plane));
1295 plane->old_fb = plane->fb;
1298 ret = drm_atomic_commit(state);
1302 info->var.xoffset = var->xoffset;
1303 info->var.yoffset = var->yoffset;
1307 drm_atomic_clean_old_fb(dev, plane_mask, ret);
1309 if (ret == -EDEADLK)
1313 drm_atomic_state_free(state);
1318 drm_atomic_state_clear(state);
1319 drm_atomic_legacy_backoff(state);
1325 * drm_fb_helper_pan_display - implementation for ->fb_pan_display
1326 * @var: updated screen information
1327 * @info: fbdev registered by the helper
1329 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1330 struct fb_info *info)
1332 struct drm_fb_helper *fb_helper = info->par;
1333 struct drm_device *dev = fb_helper->dev;
1334 struct drm_mode_set *modeset;
1338 if (oops_in_progress)
1341 drm_modeset_lock_all(dev);
1342 if (!drm_fb_helper_is_bound(fb_helper)) {
1343 drm_modeset_unlock_all(dev);
1347 if (fb_helper->atomic) {
1348 ret = pan_display_atomic(var, info);
1352 for (i = 0; i < fb_helper->crtc_count; i++) {
1353 modeset = &fb_helper->crtc_info[i].mode_set;
1355 modeset->x = var->xoffset;
1356 modeset->y = var->yoffset;
1358 if (modeset->num_connectors) {
1359 ret = drm_mode_set_config_internal(modeset);
1361 info->var.xoffset = var->xoffset;
1362 info->var.yoffset = var->yoffset;
1367 drm_modeset_unlock_all(dev);
1370 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1373 * Allocates the backing storage and sets up the fbdev info structure through
1374 * the ->fb_probe callback and then registers the fbdev and sets up the panic
1377 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1383 struct fb_info *info;
1384 struct drm_fb_helper_surface_size sizes;
1387 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1388 sizes.surface_depth = 24;
1389 sizes.surface_bpp = 32;
1390 sizes.fb_width = (unsigned)-1;
1391 sizes.fb_height = (unsigned)-1;
1393 /* if driver picks 8 or 16 by default use that
1394 for both depth/bpp */
1395 if (preferred_bpp != sizes.surface_bpp)
1396 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1398 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1399 for (i = 0; i < fb_helper->connector_count; i++) {
1400 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1401 struct drm_cmdline_mode *cmdline_mode;
1403 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1405 if (cmdline_mode->bpp_specified) {
1406 switch (cmdline_mode->bpp) {
1408 sizes.surface_depth = sizes.surface_bpp = 8;
1411 sizes.surface_depth = 15;
1412 sizes.surface_bpp = 16;
1415 sizes.surface_depth = sizes.surface_bpp = 16;
1418 sizes.surface_depth = sizes.surface_bpp = 24;
1421 sizes.surface_depth = 24;
1422 sizes.surface_bpp = 32;
1430 for (i = 0; i < fb_helper->crtc_count; i++) {
1431 struct drm_display_mode *desired_mode;
1432 struct drm_mode_set *mode_set;
1434 /* in case of tile group, are we the last tile vert or horiz?
1435 * If no tile group you are always the last one both vertically
1438 bool lastv = true, lasth = true;
1440 desired_mode = fb_helper->crtc_info[i].desired_mode;
1441 mode_set = &fb_helper->crtc_info[i].mode_set;
1448 x = fb_helper->crtc_info[i].x;
1449 y = fb_helper->crtc_info[i].y;
1451 if (gamma_size == 0)
1452 gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1454 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1455 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1457 for (j = 0; j < mode_set->num_connectors; j++) {
1458 struct drm_connector *connector = mode_set->connectors[j];
1459 if (connector->has_tile) {
1460 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1461 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1462 /* cloning to multiple tiles is just crazy-talk, so: */
1468 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1470 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1473 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1474 /* hmm everyone went away - assume VGA cable just fell out
1475 and will come back later. */
1476 DRM_INFO("Cannot find any crtc or sizes - going 1024x768\n");
1477 sizes.fb_width = sizes.surface_width = 1024;
1478 sizes.fb_height = sizes.surface_height = 768;
1481 /* push down into drivers */
1482 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1486 info = fb_helper->fbdev;
1489 * Set the fb pointer - usually drm_setup_crtcs does this for hotplug
1490 * events, but at init time drm_setup_crtcs needs to be called before
1491 * the fb is allocated (since we need to figure out the desired size of
1492 * the fb before we can allocate it ...). Hence we need to fix things up
1495 for (i = 0; i < fb_helper->crtc_count; i++)
1496 if (fb_helper->crtc_info[i].mode_set.num_connectors)
1497 fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
1500 info->var.pixclock = 0;
1501 if (register_framebuffer(info) < 0)
1504 dev_info(fb_helper->dev->dev, "fb%d: %s frame buffer device\n",
1505 info->node, info->fix.id);
1507 if (list_empty(&kernel_fb_helper_list)) {
1508 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1511 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1517 * drm_fb_helper_fill_fix - initializes fixed fbdev information
1518 * @info: fbdev registered by the helper
1519 * @pitch: desired pitch
1520 * @depth: desired depth
1522 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1523 * fbdev emulations. Drivers which support acceleration methods which impose
1524 * additional constraints need to set up their own limits.
1526 * Drivers should call this (or their equivalent setup code) from their
1527 * ->fb_probe callback.
1529 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1532 info->fix.type = FB_TYPE_PACKED_PIXELS;
1533 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1534 FB_VISUAL_TRUECOLOR;
1535 info->fix.mmio_start = 0;
1536 info->fix.mmio_len = 0;
1537 info->fix.type_aux = 0;
1538 info->fix.xpanstep = 1; /* doing it in hw */
1539 info->fix.ypanstep = 1; /* doing it in hw */
1540 info->fix.ywrapstep = 0;
1541 info->fix.accel = FB_ACCEL_NONE;
1543 info->fix.line_length = pitch;
1546 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1549 * drm_fb_helper_fill_var - initalizes variable fbdev information
1550 * @info: fbdev instance to set up
1551 * @fb_helper: fb helper instance to use as template
1552 * @fb_width: desired fb width
1553 * @fb_height: desired fb height
1555 * Sets up the variable fbdev metainformation from the given fb helper instance
1556 * and the drm framebuffer allocated in fb_helper->fb.
1558 * Drivers should call this (or their equivalent setup code) from their
1559 * ->fb_probe callback after having allocated the fbdev backing
1560 * storage framebuffer.
1562 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1563 uint32_t fb_width, uint32_t fb_height)
1565 struct drm_framebuffer *fb = fb_helper->fb;
1566 info->pseudo_palette = fb_helper->pseudo_palette;
1567 info->var.xres_virtual = fb->width;
1568 info->var.yres_virtual = fb->height;
1569 info->var.bits_per_pixel = fb->bits_per_pixel;
1570 info->var.accel_flags = FB_ACCELF_TEXT;
1571 info->var.xoffset = 0;
1572 info->var.yoffset = 0;
1573 info->var.activate = FB_ACTIVATE_NOW;
1574 info->var.height = -1;
1575 info->var.width = -1;
1577 switch (fb->depth) {
1579 info->var.red.offset = 0;
1580 info->var.green.offset = 0;
1581 info->var.blue.offset = 0;
1582 info->var.red.length = 8; /* 8bit DAC */
1583 info->var.green.length = 8;
1584 info->var.blue.length = 8;
1585 info->var.transp.offset = 0;
1586 info->var.transp.length = 0;
1589 info->var.red.offset = 10;
1590 info->var.green.offset = 5;
1591 info->var.blue.offset = 0;
1592 info->var.red.length = 5;
1593 info->var.green.length = 5;
1594 info->var.blue.length = 5;
1595 info->var.transp.offset = 15;
1596 info->var.transp.length = 1;
1599 info->var.red.offset = 11;
1600 info->var.green.offset = 5;
1601 info->var.blue.offset = 0;
1602 info->var.red.length = 5;
1603 info->var.green.length = 6;
1604 info->var.blue.length = 5;
1605 info->var.transp.offset = 0;
1608 info->var.red.offset = 16;
1609 info->var.green.offset = 8;
1610 info->var.blue.offset = 0;
1611 info->var.red.length = 8;
1612 info->var.green.length = 8;
1613 info->var.blue.length = 8;
1614 info->var.transp.offset = 0;
1615 info->var.transp.length = 0;
1618 info->var.red.offset = 16;
1619 info->var.green.offset = 8;
1620 info->var.blue.offset = 0;
1621 info->var.red.length = 8;
1622 info->var.green.length = 8;
1623 info->var.blue.length = 8;
1624 info->var.transp.offset = 24;
1625 info->var.transp.length = 8;
1631 info->var.xres = fb_width;
1632 info->var.yres = fb_height;
1634 EXPORT_SYMBOL(drm_fb_helper_fill_var);
1636 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
1640 struct drm_connector *connector;
1644 for (i = 0; i < fb_helper->connector_count; i++) {
1645 connector = fb_helper->connector_info[i]->connector;
1646 count += connector->funcs->fill_modes(connector, maxX, maxY);
1652 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
1654 struct drm_display_mode *mode;
1656 list_for_each_entry(mode, &fb_connector->connector->modes, head) {
1657 if (mode->hdisplay > width ||
1658 mode->vdisplay > height)
1660 if (mode->type & DRM_MODE_TYPE_PREFERRED)
1665 EXPORT_SYMBOL(drm_has_preferred_mode);
1667 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
1669 return fb_connector->connector->cmdline_mode.specified;
1672 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
1673 int width, int height)
1675 struct drm_cmdline_mode *cmdline_mode;
1676 struct drm_display_mode *mode;
1677 bool prefer_non_interlace;
1679 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1680 if (cmdline_mode->specified == false)
1683 /* attempt to find a matching mode in the list of modes
1684 * we have gotten so far, if not add a CVT mode that conforms
1686 if (cmdline_mode->rb || cmdline_mode->margins)
1689 prefer_non_interlace = !cmdline_mode->interlace;
1691 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1692 /* check width/height */
1693 if (mode->hdisplay != cmdline_mode->xres ||
1694 mode->vdisplay != cmdline_mode->yres)
1697 if (cmdline_mode->refresh_specified) {
1698 if (mode->vrefresh != cmdline_mode->refresh)
1702 if (cmdline_mode->interlace) {
1703 if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
1705 } else if (prefer_non_interlace) {
1706 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
1712 if (prefer_non_interlace) {
1713 prefer_non_interlace = false;
1718 mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
1720 list_add(&mode->head, &fb_helper_conn->connector->modes);
1723 EXPORT_SYMBOL(drm_pick_cmdline_mode);
1725 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
1730 enable = connector->status == connector_status_connected;
1732 enable = connector->status != connector_status_disconnected;
1737 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
1740 bool any_enabled = false;
1741 struct drm_connector *connector;
1744 for (i = 0; i < fb_helper->connector_count; i++) {
1745 connector = fb_helper->connector_info[i]->connector;
1746 enabled[i] = drm_connector_enabled(connector, true);
1747 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
1748 enabled[i] ? "yes" : "no");
1749 any_enabled |= enabled[i];
1755 for (i = 0; i < fb_helper->connector_count; i++) {
1756 connector = fb_helper->connector_info[i]->connector;
1757 enabled[i] = drm_connector_enabled(connector, false);
1761 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
1762 struct drm_display_mode **modes,
1763 struct drm_fb_offset *offsets,
1764 bool *enabled, int width, int height)
1767 bool can_clone = false;
1768 struct drm_fb_helper_connector *fb_helper_conn;
1769 struct drm_display_mode *dmt_mode, *mode;
1771 /* only contemplate cloning in the single crtc case */
1772 if (fb_helper->crtc_count > 1)
1776 for (i = 0; i < fb_helper->connector_count; i++) {
1781 /* only contemplate cloning if more than one connector is enabled */
1785 /* check the command line or if nothing common pick 1024x768 */
1787 for (i = 0; i < fb_helper->connector_count; i++) {
1790 fb_helper_conn = fb_helper->connector_info[i];
1791 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1796 for (j = 0; j < i; j++) {
1799 if (!drm_mode_equal(modes[j], modes[i]))
1805 DRM_DEBUG_KMS("can clone using command line\n");
1809 /* try and find a 1024x768 mode on each connector */
1811 dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
1813 for (i = 0; i < fb_helper->connector_count; i++) {
1818 fb_helper_conn = fb_helper->connector_info[i];
1819 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1820 if (drm_mode_equal(mode, dmt_mode))
1828 DRM_DEBUG_KMS("can clone using 1024x768\n");
1831 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
1835 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
1836 struct drm_display_mode **modes,
1837 struct drm_fb_offset *offsets,
1839 int h_idx, int v_idx)
1841 struct drm_fb_helper_connector *fb_helper_conn;
1843 int hoffset = 0, voffset = 0;
1845 for (i = 0; i < fb_helper->connector_count; i++) {
1846 fb_helper_conn = fb_helper->connector_info[i];
1847 if (!fb_helper_conn->connector->has_tile)
1850 if (!modes[i] && (h_idx || v_idx)) {
1851 DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
1852 fb_helper_conn->connector->base.id);
1855 if (fb_helper_conn->connector->tile_h_loc < h_idx)
1856 hoffset += modes[i]->hdisplay;
1858 if (fb_helper_conn->connector->tile_v_loc < v_idx)
1859 voffset += modes[i]->vdisplay;
1861 offsets[idx].x = hoffset;
1862 offsets[idx].y = voffset;
1863 DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
1867 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
1868 struct drm_display_mode **modes,
1869 struct drm_fb_offset *offsets,
1870 bool *enabled, int width, int height)
1872 struct drm_fb_helper_connector *fb_helper_conn;
1874 uint64_t conn_configured = 0, mask;
1876 mask = (1 << fb_helper->connector_count) - 1;
1878 for (i = 0; i < fb_helper->connector_count; i++) {
1879 fb_helper_conn = fb_helper->connector_info[i];
1881 if (conn_configured & (1 << i))
1884 if (enabled[i] == false) {
1885 conn_configured |= (1 << i);
1889 /* first pass over all the untiled connectors */
1890 if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
1893 if (tile_pass == 1) {
1894 if (fb_helper_conn->connector->tile_h_loc != 0 ||
1895 fb_helper_conn->connector->tile_v_loc != 0)
1899 if (fb_helper_conn->connector->tile_h_loc != tile_pass -1 &&
1900 fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
1901 /* if this tile_pass doesn't cover any of the tiles - keep going */
1904 /* find the tile offsets for this pass - need
1905 to find all tiles left and above */
1906 drm_get_tile_offsets(fb_helper, modes, offsets,
1907 i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
1909 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
1910 fb_helper_conn->connector->base.id);
1912 /* got for command line mode first */
1913 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1915 DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
1916 fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
1917 modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
1919 /* No preferred modes, pick one off the list */
1920 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
1921 list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
1924 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
1926 conn_configured |= (1 << i);
1929 if ((conn_configured & mask) != mask) {
1936 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
1937 struct drm_fb_helper_crtc **best_crtcs,
1938 struct drm_display_mode **modes,
1939 int n, int width, int height)
1942 struct drm_connector *connector;
1943 const struct drm_connector_helper_funcs *connector_funcs;
1944 struct drm_encoder *encoder;
1945 int my_score, best_score, score;
1946 struct drm_fb_helper_crtc **crtcs, *crtc;
1947 struct drm_fb_helper_connector *fb_helper_conn;
1949 if (n == fb_helper->connector_count)
1952 fb_helper_conn = fb_helper->connector_info[n];
1953 connector = fb_helper_conn->connector;
1955 best_crtcs[n] = NULL;
1956 best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
1957 if (modes[n] == NULL)
1960 crtcs = kzalloc(fb_helper->connector_count *
1961 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
1966 if (connector->status == connector_status_connected)
1968 if (drm_has_cmdline_mode(fb_helper_conn))
1970 if (drm_has_preferred_mode(fb_helper_conn, width, height))
1973 connector_funcs = connector->helper_private;
1974 encoder = connector_funcs->best_encoder(connector);
1978 /* select a crtc for this connector and then attempt to configure
1979 remaining connectors */
1980 for (c = 0; c < fb_helper->crtc_count; c++) {
1981 crtc = &fb_helper->crtc_info[c];
1983 if ((encoder->possible_crtcs & (1 << c)) == 0)
1986 for (o = 0; o < n; o++)
1987 if (best_crtcs[o] == crtc)
1991 /* ignore cloning unless only a single crtc */
1992 if (fb_helper->crtc_count > 1)
1995 if (!drm_mode_equal(modes[o], modes[n]))
2000 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
2001 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
2003 if (score > best_score) {
2005 memcpy(best_crtcs, crtcs,
2006 fb_helper->connector_count *
2007 sizeof(struct drm_fb_helper_crtc *));
2015 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper)
2017 struct drm_device *dev = fb_helper->dev;
2018 struct drm_fb_helper_crtc **crtcs;
2019 struct drm_display_mode **modes;
2020 struct drm_fb_offset *offsets;
2021 struct drm_mode_set *modeset;
2026 DRM_DEBUG_KMS("\n");
2028 width = dev->mode_config.max_width;
2029 height = dev->mode_config.max_height;
2031 crtcs = kcalloc(fb_helper->connector_count,
2032 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2033 modes = kcalloc(fb_helper->connector_count,
2034 sizeof(struct drm_display_mode *), GFP_KERNEL);
2035 offsets = kcalloc(fb_helper->connector_count,
2036 sizeof(struct drm_fb_offset), GFP_KERNEL);
2037 enabled = kcalloc(fb_helper->connector_count,
2038 sizeof(bool), GFP_KERNEL);
2039 if (!crtcs || !modes || !enabled || !offsets) {
2040 DRM_ERROR("Memory allocation failed\n");
2045 drm_enable_connectors(fb_helper, enabled);
2047 if (!(fb_helper->funcs->initial_config &&
2048 fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2050 enabled, width, height))) {
2051 memset(modes, 0, fb_helper->connector_count*sizeof(modes[0]));
2052 memset(crtcs, 0, fb_helper->connector_count*sizeof(crtcs[0]));
2053 memset(offsets, 0, fb_helper->connector_count*sizeof(offsets[0]));
2055 if (!drm_target_cloned(fb_helper, modes, offsets,
2056 enabled, width, height) &&
2057 !drm_target_preferred(fb_helper, modes, offsets,
2058 enabled, width, height))
2059 DRM_ERROR("Unable to find initial modes\n");
2061 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2064 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2067 /* need to set the modesets up here for use later */
2068 /* fill out the connector<->crtc mappings into the modesets */
2069 for (i = 0; i < fb_helper->crtc_count; i++) {
2070 modeset = &fb_helper->crtc_info[i].mode_set;
2071 modeset->num_connectors = 0;
2075 for (i = 0; i < fb_helper->connector_count; i++) {
2076 struct drm_display_mode *mode = modes[i];
2077 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2078 struct drm_fb_offset *offset = &offsets[i];
2079 modeset = &fb_crtc->mode_set;
2081 if (mode && fb_crtc) {
2082 DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2083 mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2084 fb_crtc->desired_mode = mode;
2085 fb_crtc->x = offset->x;
2086 fb_crtc->y = offset->y;
2088 drm_mode_destroy(dev, modeset->mode);
2089 modeset->mode = drm_mode_duplicate(dev,
2090 fb_crtc->desired_mode);
2091 modeset->connectors[modeset->num_connectors++] = fb_helper->connector_info[i]->connector;
2092 modeset->fb = fb_helper->fb;
2093 modeset->x = offset->x;
2094 modeset->y = offset->y;
2098 /* Clear out any old modes if there are no more connected outputs. */
2099 for (i = 0; i < fb_helper->crtc_count; i++) {
2100 modeset = &fb_helper->crtc_info[i].mode_set;
2101 if (modeset->num_connectors == 0) {
2102 BUG_ON(modeset->fb);
2104 drm_mode_destroy(dev, modeset->mode);
2105 modeset->mode = NULL;
2116 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2117 * @fb_helper: fb_helper device struct
2118 * @bpp_sel: bpp value to use for the framebuffer configuration
2120 * Scans the CRTCs and connectors and tries to put together an initial setup.
2121 * At the moment, this is a cloned configuration across all heads with
2122 * a new framebuffer object as the backing store.
2124 * Note that this also registers the fbdev and so allows userspace to call into
2125 * the driver through the fbdev interfaces.
2127 * This function will call down into the ->fb_probe callback to let
2128 * the driver allocate and initialize the fbdev info structure and the drm
2129 * framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2130 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2131 * values for the fbdev info structure.
2135 * When you have fbcon support built-in or already loaded, this function will do
2136 * a full modeset to setup the fbdev console. Due to locking misdesign in the
2137 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2138 * console_lock. Until console_unlock is called no dmesg lines will be sent out
2139 * to consoles, not even serial console. This means when your driver crashes,
2140 * you will see absolutely nothing else but a system stuck in this function,
2141 * with no further output. Any kind of printk() you place within your own driver
2142 * or in the drm core modeset code will also never show up.
2144 * Standard debug practice is to run the fbcon setup without taking the
2145 * console_lock as a hack, to be able to see backtraces and crashes on the
2146 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2149 * The other option is to just disable fbdev emulation since very likely the
2150 * first modeset from userspace will crash in the same way, and is even easier
2151 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2152 * kernel cmdline option.
2155 * Zero if everything went ok, nonzero otherwise.
2157 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2159 struct drm_device *dev = fb_helper->dev;
2162 if (!drm_fbdev_emulation)
2165 mutex_lock(&dev->mode_config.mutex);
2166 count = drm_fb_helper_probe_connector_modes(fb_helper,
2167 dev->mode_config.max_width,
2168 dev->mode_config.max_height);
2169 mutex_unlock(&dev->mode_config.mutex);
2171 * we shouldn't end up with no modes here.
2174 dev_info(fb_helper->dev->dev, "No connectors reported connected with modes\n");
2176 drm_setup_crtcs(fb_helper);
2178 return drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2180 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2183 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2184 * probing all the outputs attached to the fb
2185 * @fb_helper: the drm_fb_helper
2187 * Scan the connectors attached to the fb_helper and try to put together a
2188 * setup after *notification of a change in output configuration.
2190 * Called at runtime, takes the mode config locks to be able to check/change the
2191 * modeset configuration. Must be run from process context (which usually means
2192 * either the output polling work or a work item launched from the driver's
2193 * hotplug interrupt).
2195 * Note that drivers may call this even before calling
2196 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2197 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2198 * not miss any hotplug events.
2201 * 0 on success and a non-zero error code otherwise.
2203 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2205 struct drm_device *dev = fb_helper->dev;
2206 u32 max_width, max_height;
2208 if (!drm_fbdev_emulation)
2211 mutex_lock(&fb_helper->dev->mode_config.mutex);
2212 if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2213 fb_helper->delayed_hotplug = true;
2214 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2217 DRM_DEBUG_KMS("\n");
2219 max_width = fb_helper->fb->width;
2220 max_height = fb_helper->fb->height;
2222 drm_fb_helper_probe_connector_modes(fb_helper, max_width, max_height);
2223 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2225 drm_modeset_lock_all(dev);
2226 drm_setup_crtcs(fb_helper);
2227 drm_modeset_unlock_all(dev);
2228 drm_fb_helper_set_par(fb_helper->fbdev);
2232 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2234 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2235 * but the module doesn't depend on any fb console symbols. At least
2236 * attempt to load fbcon to avoid leaving the system without a usable console.
2238 int __init drm_fb_helper_modinit(void)
2240 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2241 const char *name = "fbcon";
2242 struct module *fbcon;
2244 mutex_lock(&module_mutex);
2245 fbcon = find_module(name);
2246 mutex_unlock(&module_mutex);
2249 request_module_nowait(name);
2253 EXPORT_SYMBOL(drm_fb_helper_modinit);