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().
90 * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
92 * @fb_helper: fbdev initialized with drm_fb_helper_init
94 * This functions adds all the available connectors for use with the given
95 * fb_helper. This is a separate step to allow drivers to freely assign
96 * connectors to the fbdev, e.g. if some are reserved for special purposes or
97 * not adequate to be used for the fbcon.
99 * This function is protected against concurrent connector hotadds/removals
100 * using drm_fb_helper_add_one_connector() and
101 * drm_fb_helper_remove_one_connector().
103 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
105 struct drm_device *dev = fb_helper->dev;
106 struct drm_connector *connector;
109 if (!drm_fbdev_emulation)
112 mutex_lock(&dev->mode_config.mutex);
113 drm_for_each_connector(connector, dev) {
114 struct drm_fb_helper_connector *fb_helper_connector;
116 fb_helper_connector = kzalloc(sizeof(struct drm_fb_helper_connector), GFP_KERNEL);
117 if (!fb_helper_connector)
120 fb_helper_connector->connector = connector;
121 fb_helper->connector_info[fb_helper->connector_count++] = fb_helper_connector;
123 mutex_unlock(&dev->mode_config.mutex);
126 for (i = 0; i < fb_helper->connector_count; i++) {
127 kfree(fb_helper->connector_info[i]);
128 fb_helper->connector_info[i] = NULL;
130 fb_helper->connector_count = 0;
131 mutex_unlock(&dev->mode_config.mutex);
135 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
137 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector)
139 struct drm_fb_helper_connector **temp;
140 struct drm_fb_helper_connector *fb_helper_connector;
142 if (!drm_fbdev_emulation)
145 WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
146 if (fb_helper->connector_count + 1 > fb_helper->connector_info_alloc_count) {
147 temp = krealloc(fb_helper->connector_info, sizeof(struct drm_fb_helper_connector *) * (fb_helper->connector_count + 1), GFP_KERNEL);
151 fb_helper->connector_info_alloc_count = fb_helper->connector_count + 1;
152 fb_helper->connector_info = temp;
156 fb_helper_connector = kzalloc(sizeof(struct drm_fb_helper_connector), GFP_KERNEL);
157 if (!fb_helper_connector)
160 fb_helper_connector->connector = connector;
161 fb_helper->connector_info[fb_helper->connector_count++] = fb_helper_connector;
164 EXPORT_SYMBOL(drm_fb_helper_add_one_connector);
166 static void remove_from_modeset(struct drm_mode_set *set,
167 struct drm_connector *connector)
171 for (i = 0; i < set->num_connectors; i++) {
172 if (set->connectors[i] == connector)
176 if (i == set->num_connectors)
179 for (j = i + 1; j < set->num_connectors; j++) {
180 set->connectors[j - 1] = set->connectors[j];
182 set->num_connectors--;
185 * TODO maybe need to makes sure we set it back to !=NULL somewhere?
187 if (set->num_connectors == 0) {
189 drm_mode_destroy(connector->dev, set->mode);
194 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
195 struct drm_connector *connector)
197 struct drm_fb_helper_connector *fb_helper_connector;
200 if (!drm_fbdev_emulation)
203 WARN_ON(!mutex_is_locked(&fb_helper->dev->mode_config.mutex));
205 for (i = 0; i < fb_helper->connector_count; i++) {
206 if (fb_helper->connector_info[i]->connector == connector)
210 if (i == fb_helper->connector_count)
212 fb_helper_connector = fb_helper->connector_info[i];
214 for (j = i + 1; j < fb_helper->connector_count; j++) {
215 fb_helper->connector_info[j - 1] = fb_helper->connector_info[j];
217 fb_helper->connector_count--;
218 kfree(fb_helper_connector);
220 /* also cleanup dangling references to the connector: */
221 for (i = 0; i < fb_helper->crtc_count; i++)
222 remove_from_modeset(&fb_helper->crtc_info[i].mode_set, connector);
226 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector);
228 static void drm_fb_helper_save_lut_atomic(struct drm_crtc *crtc, struct drm_fb_helper *helper)
230 uint16_t *r_base, *g_base, *b_base;
233 if (helper->funcs->gamma_get == NULL)
236 r_base = crtc->gamma_store;
237 g_base = r_base + crtc->gamma_size;
238 b_base = g_base + crtc->gamma_size;
240 for (i = 0; i < crtc->gamma_size; i++)
241 helper->funcs->gamma_get(crtc, &r_base[i], &g_base[i], &b_base[i], i);
244 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
246 uint16_t *r_base, *g_base, *b_base;
248 if (crtc->funcs->gamma_set == NULL)
251 r_base = crtc->gamma_store;
252 g_base = r_base + crtc->gamma_size;
253 b_base = g_base + crtc->gamma_size;
255 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
259 * drm_fb_helper_debug_enter - implementation for ->fb_debug_enter
260 * @info: fbdev registered by the helper
262 int drm_fb_helper_debug_enter(struct fb_info *info)
264 struct drm_fb_helper *helper = info->par;
265 const struct drm_crtc_helper_funcs *funcs;
268 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
269 for (i = 0; i < helper->crtc_count; i++) {
270 struct drm_mode_set *mode_set =
271 &helper->crtc_info[i].mode_set;
273 if (!mode_set->crtc->enabled)
276 funcs = mode_set->crtc->helper_private;
277 drm_fb_helper_save_lut_atomic(mode_set->crtc, helper);
278 funcs->mode_set_base_atomic(mode_set->crtc,
282 ENTER_ATOMIC_MODE_SET);
288 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
290 /* Find the real fb for a given fb helper CRTC */
291 static struct drm_framebuffer *drm_mode_config_fb(struct drm_crtc *crtc)
293 struct drm_device *dev = crtc->dev;
296 drm_for_each_crtc(c, dev) {
297 if (crtc->base.id == c->base.id)
298 return c->primary->fb;
305 * drm_fb_helper_debug_leave - implementation for ->fb_debug_leave
306 * @info: fbdev registered by the helper
308 int drm_fb_helper_debug_leave(struct fb_info *info)
310 struct drm_fb_helper *helper = info->par;
311 struct drm_crtc *crtc;
312 const struct drm_crtc_helper_funcs *funcs;
313 struct drm_framebuffer *fb;
316 for (i = 0; i < helper->crtc_count; i++) {
317 struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
318 crtc = mode_set->crtc;
319 funcs = crtc->helper_private;
320 fb = drm_mode_config_fb(crtc);
326 DRM_ERROR("no fb to restore??\n");
330 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
331 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
332 crtc->y, LEAVE_ATOMIC_MODE_SET);
337 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
339 static int restore_fbdev_mode_atomic(struct drm_fb_helper *fb_helper)
341 struct drm_device *dev = fb_helper->dev;
342 struct drm_plane *plane;
343 struct drm_atomic_state *state;
346 state = drm_atomic_state_alloc(dev);
350 state->acquire_ctx = dev->mode_config.acquire_ctx;
352 drm_for_each_plane(plane, dev) {
353 struct drm_plane_state *plane_state;
355 plane->old_fb = plane->fb;
357 plane_state = drm_atomic_get_plane_state(state, plane);
358 if (IS_ERR(plane_state)) {
359 ret = PTR_ERR(plane_state);
363 plane_state->rotation = BIT(DRM_ROTATE_0);
365 /* disable non-primary: */
366 if (plane->type == DRM_PLANE_TYPE_PRIMARY)
369 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
374 for(i = 0; i < fb_helper->crtc_count; i++) {
375 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
377 ret = __drm_atomic_helper_set_config(mode_set, state);
382 ret = drm_atomic_commit(state);
385 drm_for_each_plane(plane, dev) {
387 struct drm_framebuffer *new_fb = plane->state->fb;
389 drm_framebuffer_reference(new_fb);
391 plane->crtc = plane->state->crtc;
394 drm_framebuffer_unreference(plane->old_fb);
396 plane->old_fb = NULL;
403 drm_atomic_state_free(state);
408 drm_atomic_state_clear(state);
409 drm_atomic_legacy_backoff(state);
414 static int restore_fbdev_mode(struct drm_fb_helper *fb_helper)
416 struct drm_device *dev = fb_helper->dev;
417 struct drm_plane *plane;
420 drm_warn_on_modeset_not_all_locked(dev);
422 if (fb_helper->atomic)
423 return restore_fbdev_mode_atomic(fb_helper);
425 drm_for_each_plane(plane, dev) {
426 if (plane->type != DRM_PLANE_TYPE_PRIMARY)
427 drm_plane_force_disable(plane);
429 if (dev->mode_config.rotation_property) {
430 drm_mode_plane_set_obj_prop(plane,
431 dev->mode_config.rotation_property,
436 for (i = 0; i < fb_helper->crtc_count; i++) {
437 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
438 struct drm_crtc *crtc = mode_set->crtc;
441 if (crtc->funcs->cursor_set2) {
442 ret = crtc->funcs->cursor_set2(crtc, NULL, 0, 0, 0, 0, 0);
445 } else if (crtc->funcs->cursor_set) {
446 ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
451 ret = drm_mode_set_config_internal(mode_set);
460 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
461 * @fb_helper: fbcon to restore
463 * This should be called from driver's drm ->lastclose callback
464 * when implementing an fbcon on top of kms using this helper. This ensures that
465 * the user isn't greeted with a black screen when e.g. X dies.
468 * Zero if everything went ok, negative error code otherwise.
470 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
472 struct drm_device *dev = fb_helper->dev;
476 if (!drm_fbdev_emulation)
479 drm_modeset_lock_all(dev);
480 ret = restore_fbdev_mode(fb_helper);
482 do_delayed = fb_helper->delayed_hotplug;
484 fb_helper->delayed_hotplug = false;
485 drm_modeset_unlock_all(dev);
488 drm_fb_helper_hotplug_event(fb_helper);
491 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
493 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
495 struct drm_device *dev = fb_helper->dev;
496 struct drm_crtc *crtc;
497 int bound = 0, crtcs_bound = 0;
499 /* Sometimes user space wants everything disabled, so don't steal the
500 * display if there's a master. */
501 if (dev->primary->master)
504 drm_for_each_crtc(crtc, dev) {
505 if (crtc->primary->fb)
507 if (crtc->primary->fb == fb_helper->fb)
511 if (bound < crtcs_bound)
517 #ifdef CONFIG_MAGIC_SYSRQ
519 * restore fbcon display for all kms driver's using this helper, used for sysrq
520 * and panic handling.
522 static bool drm_fb_helper_force_kernel_mode(void)
524 bool ret, error = false;
525 struct drm_fb_helper *helper;
527 if (list_empty(&kernel_fb_helper_list))
530 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
531 struct drm_device *dev = helper->dev;
533 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
536 drm_modeset_lock_all(dev);
537 ret = restore_fbdev_mode(helper);
540 drm_modeset_unlock_all(dev);
545 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
548 ret = drm_fb_helper_force_kernel_mode();
550 DRM_ERROR("Failed to restore crtc configuration\n");
552 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
554 static void drm_fb_helper_sysrq(int dummy1)
556 schedule_work(&drm_fb_helper_restore_work);
559 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
560 .handler = drm_fb_helper_sysrq,
561 .help_msg = "force-fb(V)",
562 .action_msg = "Restore framebuffer console",
565 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
568 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
570 struct drm_fb_helper *fb_helper = info->par;
571 struct drm_device *dev = fb_helper->dev;
572 struct drm_crtc *crtc;
573 struct drm_connector *connector;
577 * For each CRTC in this fb, turn the connectors on/off.
579 drm_modeset_lock_all(dev);
580 if (!drm_fb_helper_is_bound(fb_helper)) {
581 drm_modeset_unlock_all(dev);
585 for (i = 0; i < fb_helper->crtc_count; i++) {
586 crtc = fb_helper->crtc_info[i].mode_set.crtc;
591 /* Walk the connectors & encoders on this fb turning them on/off */
592 for (j = 0; j < fb_helper->connector_count; j++) {
593 connector = fb_helper->connector_info[j]->connector;
594 connector->funcs->dpms(connector, dpms_mode);
595 drm_object_property_set_value(&connector->base,
596 dev->mode_config.dpms_property, dpms_mode);
599 drm_modeset_unlock_all(dev);
603 * drm_fb_helper_blank - implementation for ->fb_blank
604 * @blank: desired blanking state
605 * @info: fbdev registered by the helper
607 int drm_fb_helper_blank(int blank, struct fb_info *info)
609 if (oops_in_progress)
613 /* Display: On; HSync: On, VSync: On */
614 case FB_BLANK_UNBLANK:
615 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
617 /* Display: Off; HSync: On, VSync: On */
618 case FB_BLANK_NORMAL:
619 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
621 /* Display: Off; HSync: Off, VSync: On */
622 case FB_BLANK_HSYNC_SUSPEND:
623 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
625 /* Display: Off; HSync: On, VSync: Off */
626 case FB_BLANK_VSYNC_SUSPEND:
627 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
629 /* Display: Off; HSync: Off, VSync: Off */
630 case FB_BLANK_POWERDOWN:
631 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
636 EXPORT_SYMBOL(drm_fb_helper_blank);
638 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
642 for (i = 0; i < helper->connector_count; i++)
643 kfree(helper->connector_info[i]);
644 kfree(helper->connector_info);
645 for (i = 0; i < helper->crtc_count; i++) {
646 kfree(helper->crtc_info[i].mode_set.connectors);
647 if (helper->crtc_info[i].mode_set.mode)
648 drm_mode_destroy(helper->dev, helper->crtc_info[i].mode_set.mode);
650 kfree(helper->crtc_info);
654 * drm_fb_helper_prepare - setup a drm_fb_helper structure
656 * @helper: driver-allocated fbdev helper structure to set up
657 * @funcs: pointer to structure of functions associate with this helper
659 * Sets up the bare minimum to make the framebuffer helper usable. This is
660 * useful to implement race-free initialization of the polling helpers.
662 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
663 const struct drm_fb_helper_funcs *funcs)
665 INIT_LIST_HEAD(&helper->kernel_fb_list);
666 helper->funcs = funcs;
669 EXPORT_SYMBOL(drm_fb_helper_prepare);
672 * drm_fb_helper_init - initialize a drm_fb_helper structure
674 * @fb_helper: driver-allocated fbdev helper structure to initialize
675 * @crtc_count: maximum number of crtcs to support in this fbdev emulation
676 * @max_conn_count: max connector count
678 * This allocates the structures for the fbdev helper with the given limits.
679 * Note that this won't yet touch the hardware (through the driver interfaces)
680 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
681 * to allow driver writes more control over the exact init sequence.
683 * Drivers must call drm_fb_helper_prepare() before calling this function.
686 * Zero if everything went ok, nonzero otherwise.
688 int drm_fb_helper_init(struct drm_device *dev,
689 struct drm_fb_helper *fb_helper,
690 int crtc_count, int max_conn_count)
692 struct drm_crtc *crtc;
695 if (!drm_fbdev_emulation)
701 fb_helper->crtc_info = kcalloc(crtc_count, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
702 if (!fb_helper->crtc_info)
705 fb_helper->crtc_count = crtc_count;
706 fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
707 if (!fb_helper->connector_info) {
708 kfree(fb_helper->crtc_info);
711 fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
712 fb_helper->connector_count = 0;
714 for (i = 0; i < crtc_count; i++) {
715 fb_helper->crtc_info[i].mode_set.connectors =
716 kcalloc(max_conn_count,
717 sizeof(struct drm_connector *),
720 if (!fb_helper->crtc_info[i].mode_set.connectors)
722 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
726 drm_for_each_crtc(crtc, dev) {
727 fb_helper->crtc_info[i].mode_set.crtc = crtc;
731 fb_helper->atomic = !!drm_core_check_feature(dev, DRIVER_ATOMIC);
735 drm_fb_helper_crtc_free(fb_helper);
738 EXPORT_SYMBOL(drm_fb_helper_init);
741 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
742 * @fb_helper: driver-allocated fbdev helper
744 * A helper to alloc fb_info and the members cmap and apertures. Called
745 * by the driver within the fb_probe fb_helper callback function.
748 * fb_info pointer if things went okay, pointer containing error code
751 struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
753 struct device *dev = fb_helper->dev->dev;
754 struct fb_info *info;
757 info = framebuffer_alloc(0, dev);
759 return ERR_PTR(-ENOMEM);
761 ret = fb_alloc_cmap(&info->cmap, 256, 0);
765 info->apertures = alloc_apertures(1);
766 if (!info->apertures) {
771 fb_helper->fbdev = info;
776 fb_dealloc_cmap(&info->cmap);
778 framebuffer_release(info);
781 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
784 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
785 * @fb_helper: driver-allocated fbdev helper
787 * A wrapper around unregister_framebuffer, to release the fb_info
790 void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
792 if (fb_helper && fb_helper->fbdev)
793 unregister_framebuffer(fb_helper->fbdev);
795 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
798 * drm_fb_helper_release_fbi - dealloc fb_info and its members
799 * @fb_helper: driver-allocated fbdev helper
801 * A helper to free memory taken by fb_info and the members cmap and
804 void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
807 struct fb_info *info = fb_helper->fbdev;
811 fb_dealloc_cmap(&info->cmap);
812 framebuffer_release(info);
815 fb_helper->fbdev = NULL;
818 EXPORT_SYMBOL(drm_fb_helper_release_fbi);
820 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
822 if (!drm_fbdev_emulation)
825 if (!list_empty(&fb_helper->kernel_fb_list)) {
826 list_del(&fb_helper->kernel_fb_list);
827 if (list_empty(&kernel_fb_helper_list)) {
828 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
832 drm_fb_helper_crtc_free(fb_helper);
835 EXPORT_SYMBOL(drm_fb_helper_fini);
838 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
839 * @fb_helper: driver-allocated fbdev helper
841 * A wrapper around unlink_framebuffer implemented by fbdev core
843 void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
845 if (fb_helper && fb_helper->fbdev)
846 unlink_framebuffer(fb_helper->fbdev);
848 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
851 * drm_fb_helper_sys_read - wrapper around fb_sys_read
852 * @info: fb_info struct pointer
853 * @buf: userspace buffer to read from framebuffer memory
854 * @count: number of bytes to read from framebuffer memory
855 * @ppos: read offset within framebuffer memory
857 * A wrapper around fb_sys_read implemented by fbdev core
859 ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
860 size_t count, loff_t *ppos)
862 return fb_sys_read(info, buf, count, ppos);
864 EXPORT_SYMBOL(drm_fb_helper_sys_read);
867 * drm_fb_helper_sys_write - wrapper around fb_sys_write
868 * @info: fb_info struct pointer
869 * @buf: userspace buffer to write to framebuffer memory
870 * @count: number of bytes to write to framebuffer memory
871 * @ppos: write offset within framebuffer memory
873 * A wrapper around fb_sys_write implemented by fbdev core
875 ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
876 size_t count, loff_t *ppos)
878 return fb_sys_write(info, buf, count, ppos);
880 EXPORT_SYMBOL(drm_fb_helper_sys_write);
883 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
884 * @info: fbdev registered by the helper
885 * @rect: info about rectangle to fill
887 * A wrapper around sys_fillrect implemented by fbdev core
889 void drm_fb_helper_sys_fillrect(struct fb_info *info,
890 const struct fb_fillrect *rect)
892 sys_fillrect(info, rect);
894 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
897 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
898 * @info: fbdev registered by the helper
899 * @area: info about area to copy
901 * A wrapper around sys_copyarea implemented by fbdev core
903 void drm_fb_helper_sys_copyarea(struct fb_info *info,
904 const struct fb_copyarea *area)
906 sys_copyarea(info, area);
908 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
911 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
912 * @info: fbdev registered by the helper
913 * @image: info about image to blit
915 * A wrapper around sys_imageblit implemented by fbdev core
917 void drm_fb_helper_sys_imageblit(struct fb_info *info,
918 const struct fb_image *image)
920 sys_imageblit(info, image);
922 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
925 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
926 * @info: fbdev registered by the helper
927 * @rect: info about rectangle to fill
929 * A wrapper around cfb_imageblit implemented by fbdev core
931 void drm_fb_helper_cfb_fillrect(struct fb_info *info,
932 const struct fb_fillrect *rect)
934 cfb_fillrect(info, rect);
936 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
939 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
940 * @info: fbdev registered by the helper
941 * @area: info about area to copy
943 * A wrapper around cfb_copyarea implemented by fbdev core
945 void drm_fb_helper_cfb_copyarea(struct fb_info *info,
946 const struct fb_copyarea *area)
948 cfb_copyarea(info, area);
950 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
953 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
954 * @info: fbdev registered by the helper
955 * @image: info about image to blit
957 * A wrapper around cfb_imageblit implemented by fbdev core
959 void drm_fb_helper_cfb_imageblit(struct fb_info *info,
960 const struct fb_image *image)
962 cfb_imageblit(info, image);
964 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
967 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
968 * @fb_helper: driver-allocated fbdev helper
969 * @state: desired state, zero to resume, non-zero to suspend
971 * A wrapper around fb_set_suspend implemented by fbdev core
973 void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, int state)
975 if (fb_helper && fb_helper->fbdev)
976 fb_set_suspend(fb_helper->fbdev, state);
978 EXPORT_SYMBOL(drm_fb_helper_set_suspend);
980 static int setcolreg(struct drm_crtc *crtc, u16 red, u16 green,
981 u16 blue, u16 regno, struct fb_info *info)
983 struct drm_fb_helper *fb_helper = info->par;
984 struct drm_framebuffer *fb = fb_helper->fb;
987 if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
990 /* place color in psuedopalette */
993 palette = (u32 *)info->pseudo_palette;
994 red >>= (16 - info->var.red.length);
995 green >>= (16 - info->var.green.length);
996 blue >>= (16 - info->var.blue.length);
997 value = (red << info->var.red.offset) |
998 (green << info->var.green.offset) |
999 (blue << info->var.blue.offset);
1000 if (info->var.transp.length > 0) {
1001 u32 mask = (1 << info->var.transp.length) - 1;
1002 mask <<= info->var.transp.offset;
1005 palette[regno] = value;
1010 * The driver really shouldn't advertise pseudo/directcolor
1011 * visuals if it can't deal with the palette.
1013 if (WARN_ON(!fb_helper->funcs->gamma_set ||
1014 !fb_helper->funcs->gamma_get))
1019 if (fb->bits_per_pixel == 16) {
1020 pindex = regno << 3;
1022 if (fb->depth == 16 && regno > 63)
1024 if (fb->depth == 15 && regno > 31)
1027 if (fb->depth == 16) {
1031 for (i = 0; i < 8; i++)
1032 fb_helper->funcs->gamma_set(crtc, red,
1033 green, blue, pindex + i);
1036 fb_helper->funcs->gamma_get(crtc, &r,
1040 for (i = 0; i < 4; i++)
1041 fb_helper->funcs->gamma_set(crtc, r,
1047 if (fb->depth != 16)
1048 fb_helper->funcs->gamma_set(crtc, red, green, blue, pindex);
1053 * drm_fb_helper_setcmap - implementation for ->fb_setcmap
1054 * @cmap: cmap to set
1055 * @info: fbdev registered by the helper
1057 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1059 struct drm_fb_helper *fb_helper = info->par;
1060 struct drm_device *dev = fb_helper->dev;
1061 const struct drm_crtc_helper_funcs *crtc_funcs;
1062 u16 *red, *green, *blue, *transp;
1063 struct drm_crtc *crtc;
1067 if (oops_in_progress)
1070 drm_modeset_lock_all(dev);
1071 if (!drm_fb_helper_is_bound(fb_helper)) {
1072 drm_modeset_unlock_all(dev);
1076 for (i = 0; i < fb_helper->crtc_count; i++) {
1077 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1078 crtc_funcs = crtc->helper_private;
1081 green = cmap->green;
1083 transp = cmap->transp;
1084 start = cmap->start;
1086 for (j = 0; j < cmap->len; j++) {
1087 u16 hred, hgreen, hblue, htransp = 0xffff;
1094 htransp = *transp++;
1096 rc = setcolreg(crtc, hred, hgreen, hblue, start++, info);
1100 if (crtc_funcs->load_lut)
1101 crtc_funcs->load_lut(crtc);
1104 drm_modeset_unlock_all(dev);
1107 EXPORT_SYMBOL(drm_fb_helper_setcmap);
1110 * drm_fb_helper_check_var - implementation for ->fb_check_var
1111 * @var: screeninfo to check
1112 * @info: fbdev registered by the helper
1114 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1115 struct fb_info *info)
1117 struct drm_fb_helper *fb_helper = info->par;
1118 struct drm_framebuffer *fb = fb_helper->fb;
1121 if (var->pixclock != 0 || in_dbg_master())
1124 /* Need to resize the fb object !!! */
1125 if (var->bits_per_pixel > fb->bits_per_pixel ||
1126 var->xres > fb->width || var->yres > fb->height ||
1127 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1128 DRM_DEBUG("fb userspace requested width/height/bpp is greater than current fb "
1129 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1130 var->xres, var->yres, var->bits_per_pixel,
1131 var->xres_virtual, var->yres_virtual,
1132 fb->width, fb->height, fb->bits_per_pixel);
1136 switch (var->bits_per_pixel) {
1138 depth = (var->green.length == 6) ? 16 : 15;
1141 depth = (var->transp.length > 0) ? 32 : 24;
1144 depth = var->bits_per_pixel;
1150 var->red.offset = 0;
1151 var->green.offset = 0;
1152 var->blue.offset = 0;
1153 var->red.length = 8;
1154 var->green.length = 8;
1155 var->blue.length = 8;
1156 var->transp.length = 0;
1157 var->transp.offset = 0;
1160 var->red.offset = 10;
1161 var->green.offset = 5;
1162 var->blue.offset = 0;
1163 var->red.length = 5;
1164 var->green.length = 5;
1165 var->blue.length = 5;
1166 var->transp.length = 1;
1167 var->transp.offset = 15;
1170 var->red.offset = 11;
1171 var->green.offset = 5;
1172 var->blue.offset = 0;
1173 var->red.length = 5;
1174 var->green.length = 6;
1175 var->blue.length = 5;
1176 var->transp.length = 0;
1177 var->transp.offset = 0;
1180 var->red.offset = 16;
1181 var->green.offset = 8;
1182 var->blue.offset = 0;
1183 var->red.length = 8;
1184 var->green.length = 8;
1185 var->blue.length = 8;
1186 var->transp.length = 0;
1187 var->transp.offset = 0;
1190 var->red.offset = 16;
1191 var->green.offset = 8;
1192 var->blue.offset = 0;
1193 var->red.length = 8;
1194 var->green.length = 8;
1195 var->blue.length = 8;
1196 var->transp.length = 8;
1197 var->transp.offset = 24;
1204 EXPORT_SYMBOL(drm_fb_helper_check_var);
1207 * drm_fb_helper_set_par - implementation for ->fb_set_par
1208 * @info: fbdev registered by the helper
1210 * This will let fbcon do the mode init and is called at initialization time by
1211 * the fbdev core when registering the driver, and later on through the hotplug
1214 int drm_fb_helper_set_par(struct fb_info *info)
1216 struct drm_fb_helper *fb_helper = info->par;
1217 struct fb_var_screeninfo *var = &info->var;
1219 if (oops_in_progress)
1222 if (var->pixclock != 0) {
1223 DRM_ERROR("PIXEL CLOCK SET\n");
1227 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1231 EXPORT_SYMBOL(drm_fb_helper_set_par);
1233 static int pan_display_atomic(struct fb_var_screeninfo *var,
1234 struct fb_info *info)
1236 struct drm_fb_helper *fb_helper = info->par;
1237 struct drm_device *dev = fb_helper->dev;
1238 struct drm_atomic_state *state;
1241 state = drm_atomic_state_alloc(dev);
1245 state->acquire_ctx = dev->mode_config.acquire_ctx;
1247 for(i = 0; i < fb_helper->crtc_count; i++) {
1248 struct drm_mode_set *mode_set;
1250 mode_set = &fb_helper->crtc_info[i].mode_set;
1252 mode_set->crtc->primary->old_fb = mode_set->crtc->primary->fb;
1254 mode_set->x = var->xoffset;
1255 mode_set->y = var->yoffset;
1257 ret = __drm_atomic_helper_set_config(mode_set, state);
1262 ret = drm_atomic_commit(state);
1266 info->var.xoffset = var->xoffset;
1267 info->var.yoffset = var->yoffset;
1271 for(i = 0; i < fb_helper->crtc_count; i++) {
1272 struct drm_mode_set *mode_set;
1273 struct drm_plane *plane;
1275 mode_set = &fb_helper->crtc_info[i].mode_set;
1276 plane = mode_set->crtc->primary;
1279 struct drm_framebuffer *new_fb = plane->state->fb;
1282 drm_framebuffer_reference(new_fb);
1284 plane->crtc = plane->state->crtc;
1287 drm_framebuffer_unreference(plane->old_fb);
1289 plane->old_fb = NULL;
1292 if (ret == -EDEADLK)
1296 drm_atomic_state_free(state);
1301 drm_atomic_state_clear(state);
1302 drm_atomic_legacy_backoff(state);
1308 * drm_fb_helper_pan_display - implementation for ->fb_pan_display
1309 * @var: updated screen information
1310 * @info: fbdev registered by the helper
1312 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1313 struct fb_info *info)
1315 struct drm_fb_helper *fb_helper = info->par;
1316 struct drm_device *dev = fb_helper->dev;
1317 struct drm_mode_set *modeset;
1321 if (oops_in_progress)
1324 drm_modeset_lock_all(dev);
1325 if (!drm_fb_helper_is_bound(fb_helper)) {
1326 drm_modeset_unlock_all(dev);
1330 if (fb_helper->atomic) {
1331 ret = pan_display_atomic(var, info);
1335 for (i = 0; i < fb_helper->crtc_count; i++) {
1336 modeset = &fb_helper->crtc_info[i].mode_set;
1338 modeset->x = var->xoffset;
1339 modeset->y = var->yoffset;
1341 if (modeset->num_connectors) {
1342 ret = drm_mode_set_config_internal(modeset);
1344 info->var.xoffset = var->xoffset;
1345 info->var.yoffset = var->yoffset;
1350 drm_modeset_unlock_all(dev);
1353 EXPORT_SYMBOL(drm_fb_helper_pan_display);
1356 * Allocates the backing storage and sets up the fbdev info structure through
1357 * the ->fb_probe callback and then registers the fbdev and sets up the panic
1360 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1366 struct fb_info *info;
1367 struct drm_fb_helper_surface_size sizes;
1370 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1371 sizes.surface_depth = 24;
1372 sizes.surface_bpp = 32;
1373 sizes.fb_width = (unsigned)-1;
1374 sizes.fb_height = (unsigned)-1;
1376 /* if driver picks 8 or 16 by default use that
1377 for both depth/bpp */
1378 if (preferred_bpp != sizes.surface_bpp)
1379 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1381 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1382 for (i = 0; i < fb_helper->connector_count; i++) {
1383 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1384 struct drm_cmdline_mode *cmdline_mode;
1386 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1388 if (cmdline_mode->bpp_specified) {
1389 switch (cmdline_mode->bpp) {
1391 sizes.surface_depth = sizes.surface_bpp = 8;
1394 sizes.surface_depth = 15;
1395 sizes.surface_bpp = 16;
1398 sizes.surface_depth = sizes.surface_bpp = 16;
1401 sizes.surface_depth = sizes.surface_bpp = 24;
1404 sizes.surface_depth = 24;
1405 sizes.surface_bpp = 32;
1413 for (i = 0; i < fb_helper->crtc_count; i++) {
1414 struct drm_display_mode *desired_mode;
1415 struct drm_mode_set *mode_set;
1417 /* in case of tile group, are we the last tile vert or horiz?
1418 * If no tile group you are always the last one both vertically
1421 bool lastv = true, lasth = true;
1423 desired_mode = fb_helper->crtc_info[i].desired_mode;
1424 mode_set = &fb_helper->crtc_info[i].mode_set;
1431 x = fb_helper->crtc_info[i].x;
1432 y = fb_helper->crtc_info[i].y;
1434 if (gamma_size == 0)
1435 gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1437 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1438 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1440 for (j = 0; j < mode_set->num_connectors; j++) {
1441 struct drm_connector *connector = mode_set->connectors[j];
1442 if (connector->has_tile) {
1443 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1444 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1445 /* cloning to multiple tiles is just crazy-talk, so: */
1451 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1453 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1456 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1457 /* hmm everyone went away - assume VGA cable just fell out
1458 and will come back later. */
1459 DRM_INFO("Cannot find any crtc or sizes - going 1024x768\n");
1460 sizes.fb_width = sizes.surface_width = 1024;
1461 sizes.fb_height = sizes.surface_height = 768;
1464 /* push down into drivers */
1465 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1469 info = fb_helper->fbdev;
1472 * Set the fb pointer - usually drm_setup_crtcs does this for hotplug
1473 * events, but at init time drm_setup_crtcs needs to be called before
1474 * the fb is allocated (since we need to figure out the desired size of
1475 * the fb before we can allocate it ...). Hence we need to fix things up
1478 for (i = 0; i < fb_helper->crtc_count; i++)
1479 if (fb_helper->crtc_info[i].mode_set.num_connectors)
1480 fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
1483 info->var.pixclock = 0;
1484 if (register_framebuffer(info) < 0)
1487 dev_info(fb_helper->dev->dev, "fb%d: %s frame buffer device\n",
1488 info->node, info->fix.id);
1490 if (list_empty(&kernel_fb_helper_list)) {
1491 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1494 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1500 * drm_fb_helper_fill_fix - initializes fixed fbdev information
1501 * @info: fbdev registered by the helper
1502 * @pitch: desired pitch
1503 * @depth: desired depth
1505 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1506 * fbdev emulations. Drivers which support acceleration methods which impose
1507 * additional constraints need to set up their own limits.
1509 * Drivers should call this (or their equivalent setup code) from their
1510 * ->fb_probe callback.
1512 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1515 info->fix.type = FB_TYPE_PACKED_PIXELS;
1516 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1517 FB_VISUAL_TRUECOLOR;
1518 info->fix.mmio_start = 0;
1519 info->fix.mmio_len = 0;
1520 info->fix.type_aux = 0;
1521 info->fix.xpanstep = 1; /* doing it in hw */
1522 info->fix.ypanstep = 1; /* doing it in hw */
1523 info->fix.ywrapstep = 0;
1524 info->fix.accel = FB_ACCEL_NONE;
1526 info->fix.line_length = pitch;
1529 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1532 * drm_fb_helper_fill_var - initalizes variable fbdev information
1533 * @info: fbdev instance to set up
1534 * @fb_helper: fb helper instance to use as template
1535 * @fb_width: desired fb width
1536 * @fb_height: desired fb height
1538 * Sets up the variable fbdev metainformation from the given fb helper instance
1539 * and the drm framebuffer allocated in fb_helper->fb.
1541 * Drivers should call this (or their equivalent setup code) from their
1542 * ->fb_probe callback after having allocated the fbdev backing
1543 * storage framebuffer.
1545 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1546 uint32_t fb_width, uint32_t fb_height)
1548 struct drm_framebuffer *fb = fb_helper->fb;
1549 info->pseudo_palette = fb_helper->pseudo_palette;
1550 info->var.xres_virtual = fb->width;
1551 info->var.yres_virtual = fb->height;
1552 info->var.bits_per_pixel = fb->bits_per_pixel;
1553 info->var.accel_flags = FB_ACCELF_TEXT;
1554 info->var.xoffset = 0;
1555 info->var.yoffset = 0;
1556 info->var.activate = FB_ACTIVATE_NOW;
1557 info->var.height = -1;
1558 info->var.width = -1;
1560 switch (fb->depth) {
1562 info->var.red.offset = 0;
1563 info->var.green.offset = 0;
1564 info->var.blue.offset = 0;
1565 info->var.red.length = 8; /* 8bit DAC */
1566 info->var.green.length = 8;
1567 info->var.blue.length = 8;
1568 info->var.transp.offset = 0;
1569 info->var.transp.length = 0;
1572 info->var.red.offset = 10;
1573 info->var.green.offset = 5;
1574 info->var.blue.offset = 0;
1575 info->var.red.length = 5;
1576 info->var.green.length = 5;
1577 info->var.blue.length = 5;
1578 info->var.transp.offset = 15;
1579 info->var.transp.length = 1;
1582 info->var.red.offset = 11;
1583 info->var.green.offset = 5;
1584 info->var.blue.offset = 0;
1585 info->var.red.length = 5;
1586 info->var.green.length = 6;
1587 info->var.blue.length = 5;
1588 info->var.transp.offset = 0;
1591 info->var.red.offset = 16;
1592 info->var.green.offset = 8;
1593 info->var.blue.offset = 0;
1594 info->var.red.length = 8;
1595 info->var.green.length = 8;
1596 info->var.blue.length = 8;
1597 info->var.transp.offset = 0;
1598 info->var.transp.length = 0;
1601 info->var.red.offset = 16;
1602 info->var.green.offset = 8;
1603 info->var.blue.offset = 0;
1604 info->var.red.length = 8;
1605 info->var.green.length = 8;
1606 info->var.blue.length = 8;
1607 info->var.transp.offset = 24;
1608 info->var.transp.length = 8;
1614 info->var.xres = fb_width;
1615 info->var.yres = fb_height;
1617 EXPORT_SYMBOL(drm_fb_helper_fill_var);
1619 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
1623 struct drm_connector *connector;
1627 for (i = 0; i < fb_helper->connector_count; i++) {
1628 connector = fb_helper->connector_info[i]->connector;
1629 count += connector->funcs->fill_modes(connector, maxX, maxY);
1635 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
1637 struct drm_display_mode *mode;
1639 list_for_each_entry(mode, &fb_connector->connector->modes, head) {
1640 if (mode->hdisplay > width ||
1641 mode->vdisplay > height)
1643 if (mode->type & DRM_MODE_TYPE_PREFERRED)
1648 EXPORT_SYMBOL(drm_has_preferred_mode);
1650 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
1652 return fb_connector->connector->cmdline_mode.specified;
1655 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
1656 int width, int height)
1658 struct drm_cmdline_mode *cmdline_mode;
1659 struct drm_display_mode *mode;
1660 bool prefer_non_interlace;
1662 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1663 if (cmdline_mode->specified == false)
1666 /* attempt to find a matching mode in the list of modes
1667 * we have gotten so far, if not add a CVT mode that conforms
1669 if (cmdline_mode->rb || cmdline_mode->margins)
1672 prefer_non_interlace = !cmdline_mode->interlace;
1674 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1675 /* check width/height */
1676 if (mode->hdisplay != cmdline_mode->xres ||
1677 mode->vdisplay != cmdline_mode->yres)
1680 if (cmdline_mode->refresh_specified) {
1681 if (mode->vrefresh != cmdline_mode->refresh)
1685 if (cmdline_mode->interlace) {
1686 if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
1688 } else if (prefer_non_interlace) {
1689 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
1695 if (prefer_non_interlace) {
1696 prefer_non_interlace = false;
1701 mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
1703 list_add(&mode->head, &fb_helper_conn->connector->modes);
1706 EXPORT_SYMBOL(drm_pick_cmdline_mode);
1708 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
1713 enable = connector->status == connector_status_connected;
1715 enable = connector->status != connector_status_disconnected;
1720 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
1723 bool any_enabled = false;
1724 struct drm_connector *connector;
1727 for (i = 0; i < fb_helper->connector_count; i++) {
1728 connector = fb_helper->connector_info[i]->connector;
1729 enabled[i] = drm_connector_enabled(connector, true);
1730 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
1731 enabled[i] ? "yes" : "no");
1732 any_enabled |= enabled[i];
1738 for (i = 0; i < fb_helper->connector_count; i++) {
1739 connector = fb_helper->connector_info[i]->connector;
1740 enabled[i] = drm_connector_enabled(connector, false);
1744 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
1745 struct drm_display_mode **modes,
1746 struct drm_fb_offset *offsets,
1747 bool *enabled, int width, int height)
1750 bool can_clone = false;
1751 struct drm_fb_helper_connector *fb_helper_conn;
1752 struct drm_display_mode *dmt_mode, *mode;
1754 /* only contemplate cloning in the single crtc case */
1755 if (fb_helper->crtc_count > 1)
1759 for (i = 0; i < fb_helper->connector_count; i++) {
1764 /* only contemplate cloning if more than one connector is enabled */
1768 /* check the command line or if nothing common pick 1024x768 */
1770 for (i = 0; i < fb_helper->connector_count; i++) {
1773 fb_helper_conn = fb_helper->connector_info[i];
1774 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1779 for (j = 0; j < i; j++) {
1782 if (!drm_mode_equal(modes[j], modes[i]))
1788 DRM_DEBUG_KMS("can clone using command line\n");
1792 /* try and find a 1024x768 mode on each connector */
1794 dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
1796 for (i = 0; i < fb_helper->connector_count; i++) {
1801 fb_helper_conn = fb_helper->connector_info[i];
1802 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1803 if (drm_mode_equal(mode, dmt_mode))
1811 DRM_DEBUG_KMS("can clone using 1024x768\n");
1814 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
1818 static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
1819 struct drm_display_mode **modes,
1820 struct drm_fb_offset *offsets,
1822 int h_idx, int v_idx)
1824 struct drm_fb_helper_connector *fb_helper_conn;
1826 int hoffset = 0, voffset = 0;
1828 for (i = 0; i < fb_helper->connector_count; i++) {
1829 fb_helper_conn = fb_helper->connector_info[i];
1830 if (!fb_helper_conn->connector->has_tile)
1833 if (!modes[i] && (h_idx || v_idx)) {
1834 DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
1835 fb_helper_conn->connector->base.id);
1838 if (fb_helper_conn->connector->tile_h_loc < h_idx)
1839 hoffset += modes[i]->hdisplay;
1841 if (fb_helper_conn->connector->tile_v_loc < v_idx)
1842 voffset += modes[i]->vdisplay;
1844 offsets[idx].x = hoffset;
1845 offsets[idx].y = voffset;
1846 DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
1850 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
1851 struct drm_display_mode **modes,
1852 struct drm_fb_offset *offsets,
1853 bool *enabled, int width, int height)
1855 struct drm_fb_helper_connector *fb_helper_conn;
1857 uint64_t conn_configured = 0, mask;
1859 mask = (1 << fb_helper->connector_count) - 1;
1861 for (i = 0; i < fb_helper->connector_count; i++) {
1862 fb_helper_conn = fb_helper->connector_info[i];
1864 if (conn_configured & (1 << i))
1867 if (enabled[i] == false) {
1868 conn_configured |= (1 << i);
1872 /* first pass over all the untiled connectors */
1873 if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
1876 if (tile_pass == 1) {
1877 if (fb_helper_conn->connector->tile_h_loc != 0 ||
1878 fb_helper_conn->connector->tile_v_loc != 0)
1882 if (fb_helper_conn->connector->tile_h_loc != tile_pass -1 &&
1883 fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
1884 /* if this tile_pass doesn't cover any of the tiles - keep going */
1887 /* find the tile offsets for this pass - need
1888 to find all tiles left and above */
1889 drm_get_tile_offsets(fb_helper, modes, offsets,
1890 i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
1892 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
1893 fb_helper_conn->connector->base.id);
1895 /* got for command line mode first */
1896 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1898 DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
1899 fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
1900 modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
1902 /* No preferred modes, pick one off the list */
1903 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
1904 list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
1907 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
1909 conn_configured |= (1 << i);
1912 if ((conn_configured & mask) != mask) {
1919 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
1920 struct drm_fb_helper_crtc **best_crtcs,
1921 struct drm_display_mode **modes,
1922 int n, int width, int height)
1925 struct drm_device *dev = fb_helper->dev;
1926 struct drm_connector *connector;
1927 const struct drm_connector_helper_funcs *connector_funcs;
1928 struct drm_encoder *encoder;
1929 int my_score, best_score, score;
1930 struct drm_fb_helper_crtc **crtcs, *crtc;
1931 struct drm_fb_helper_connector *fb_helper_conn;
1933 if (n == fb_helper->connector_count)
1936 fb_helper_conn = fb_helper->connector_info[n];
1937 connector = fb_helper_conn->connector;
1939 best_crtcs[n] = NULL;
1940 best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
1941 if (modes[n] == NULL)
1944 crtcs = kzalloc(dev->mode_config.num_connector *
1945 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
1950 if (connector->status == connector_status_connected)
1952 if (drm_has_cmdline_mode(fb_helper_conn))
1954 if (drm_has_preferred_mode(fb_helper_conn, width, height))
1957 connector_funcs = connector->helper_private;
1958 encoder = connector_funcs->best_encoder(connector);
1962 /* select a crtc for this connector and then attempt to configure
1963 remaining connectors */
1964 for (c = 0; c < fb_helper->crtc_count; c++) {
1965 crtc = &fb_helper->crtc_info[c];
1967 if ((encoder->possible_crtcs & (1 << c)) == 0)
1970 for (o = 0; o < n; o++)
1971 if (best_crtcs[o] == crtc)
1975 /* ignore cloning unless only a single crtc */
1976 if (fb_helper->crtc_count > 1)
1979 if (!drm_mode_equal(modes[o], modes[n]))
1984 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
1985 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
1987 if (score > best_score) {
1989 memcpy(best_crtcs, crtcs,
1990 dev->mode_config.num_connector *
1991 sizeof(struct drm_fb_helper_crtc *));
1999 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper)
2001 struct drm_device *dev = fb_helper->dev;
2002 struct drm_fb_helper_crtc **crtcs;
2003 struct drm_display_mode **modes;
2004 struct drm_fb_offset *offsets;
2005 struct drm_mode_set *modeset;
2010 DRM_DEBUG_KMS("\n");
2012 width = dev->mode_config.max_width;
2013 height = dev->mode_config.max_height;
2015 crtcs = kcalloc(dev->mode_config.num_connector,
2016 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2017 modes = kcalloc(dev->mode_config.num_connector,
2018 sizeof(struct drm_display_mode *), GFP_KERNEL);
2019 offsets = kcalloc(dev->mode_config.num_connector,
2020 sizeof(struct drm_fb_offset), GFP_KERNEL);
2021 enabled = kcalloc(dev->mode_config.num_connector,
2022 sizeof(bool), GFP_KERNEL);
2023 if (!crtcs || !modes || !enabled || !offsets) {
2024 DRM_ERROR("Memory allocation failed\n");
2029 drm_enable_connectors(fb_helper, enabled);
2031 if (!(fb_helper->funcs->initial_config &&
2032 fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2034 enabled, width, height))) {
2035 memset(modes, 0, dev->mode_config.num_connector*sizeof(modes[0]));
2036 memset(crtcs, 0, dev->mode_config.num_connector*sizeof(crtcs[0]));
2037 memset(offsets, 0, dev->mode_config.num_connector*sizeof(offsets[0]));
2039 if (!drm_target_cloned(fb_helper, modes, offsets,
2040 enabled, width, height) &&
2041 !drm_target_preferred(fb_helper, modes, offsets,
2042 enabled, width, height))
2043 DRM_ERROR("Unable to find initial modes\n");
2045 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2048 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2051 /* need to set the modesets up here for use later */
2052 /* fill out the connector<->crtc mappings into the modesets */
2053 for (i = 0; i < fb_helper->crtc_count; i++) {
2054 modeset = &fb_helper->crtc_info[i].mode_set;
2055 modeset->num_connectors = 0;
2059 for (i = 0; i < fb_helper->connector_count; i++) {
2060 struct drm_display_mode *mode = modes[i];
2061 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2062 struct drm_fb_offset *offset = &offsets[i];
2063 modeset = &fb_crtc->mode_set;
2065 if (mode && fb_crtc) {
2066 DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2067 mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2068 fb_crtc->desired_mode = mode;
2069 fb_crtc->x = offset->x;
2070 fb_crtc->y = offset->y;
2072 drm_mode_destroy(dev, modeset->mode);
2073 modeset->mode = drm_mode_duplicate(dev,
2074 fb_crtc->desired_mode);
2075 modeset->connectors[modeset->num_connectors++] = fb_helper->connector_info[i]->connector;
2076 modeset->fb = fb_helper->fb;
2077 modeset->x = offset->x;
2078 modeset->y = offset->y;
2082 /* Clear out any old modes if there are no more connected outputs. */
2083 for (i = 0; i < fb_helper->crtc_count; i++) {
2084 modeset = &fb_helper->crtc_info[i].mode_set;
2085 if (modeset->num_connectors == 0) {
2086 BUG_ON(modeset->fb);
2088 drm_mode_destroy(dev, modeset->mode);
2089 modeset->mode = NULL;
2100 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2101 * @fb_helper: fb_helper device struct
2102 * @bpp_sel: bpp value to use for the framebuffer configuration
2104 * Scans the CRTCs and connectors and tries to put together an initial setup.
2105 * At the moment, this is a cloned configuration across all heads with
2106 * a new framebuffer object as the backing store.
2108 * Note that this also registers the fbdev and so allows userspace to call into
2109 * the driver through the fbdev interfaces.
2111 * This function will call down into the ->fb_probe callback to let
2112 * the driver allocate and initialize the fbdev info structure and the drm
2113 * framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2114 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2115 * values for the fbdev info structure.
2118 * Zero if everything went ok, nonzero otherwise.
2120 int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2122 struct drm_device *dev = fb_helper->dev;
2125 if (!drm_fbdev_emulation)
2128 mutex_lock(&dev->mode_config.mutex);
2129 count = drm_fb_helper_probe_connector_modes(fb_helper,
2130 dev->mode_config.max_width,
2131 dev->mode_config.max_height);
2132 mutex_unlock(&dev->mode_config.mutex);
2134 * we shouldn't end up with no modes here.
2137 dev_info(fb_helper->dev->dev, "No connectors reported connected with modes\n");
2139 drm_setup_crtcs(fb_helper);
2141 return drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2143 EXPORT_SYMBOL(drm_fb_helper_initial_config);
2146 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2147 * probing all the outputs attached to the fb
2148 * @fb_helper: the drm_fb_helper
2150 * Scan the connectors attached to the fb_helper and try to put together a
2151 * setup after *notification of a change in output configuration.
2153 * Called at runtime, takes the mode config locks to be able to check/change the
2154 * modeset configuration. Must be run from process context (which usually means
2155 * either the output polling work or a work item launched from the driver's
2156 * hotplug interrupt).
2158 * Note that drivers may call this even before calling
2159 * drm_fb_helper_initial_config but only aftert drm_fb_helper_init. This allows
2160 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2161 * not miss any hotplug events.
2164 * 0 on success and a non-zero error code otherwise.
2166 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2168 struct drm_device *dev = fb_helper->dev;
2169 u32 max_width, max_height;
2171 if (!drm_fbdev_emulation)
2174 mutex_lock(&fb_helper->dev->mode_config.mutex);
2175 if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2176 fb_helper->delayed_hotplug = true;
2177 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2180 DRM_DEBUG_KMS("\n");
2182 max_width = fb_helper->fb->width;
2183 max_height = fb_helper->fb->height;
2185 drm_fb_helper_probe_connector_modes(fb_helper, max_width, max_height);
2186 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2188 drm_modeset_lock_all(dev);
2189 drm_setup_crtcs(fb_helper);
2190 drm_modeset_unlock_all(dev);
2191 drm_fb_helper_set_par(fb_helper->fbdev);
2195 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2197 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2198 * but the module doesn't depend on any fb console symbols. At least
2199 * attempt to load fbcon to avoid leaving the system without a usable console.
2201 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2202 static int __init drm_fb_helper_modinit(void)
2204 const char *name = "fbcon";
2205 struct module *fbcon;
2207 mutex_lock(&module_mutex);
2208 fbcon = find_module(name);
2209 mutex_unlock(&module_mutex);
2212 request_module_nowait(name);
2216 module_init(drm_fb_helper_modinit);