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>
42 static LIST_HEAD(kernel_fb_helper_list);
47 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
48 * mode setting driver. They can be used mostly independantely from the crtc
49 * helper functions used by many drivers to implement the kernel mode setting
52 * Initialization is done as a three-step process with drm_fb_helper_init(),
53 * drm_fb_helper_single_add_all_connectors() and drm_fb_helper_initial_config().
54 * Drivers with fancier requirements than the default beheviour can override the
55 * second step with their own code. Teardown is done with drm_fb_helper_fini().
57 * At runtime drivers should restore the fbdev console by calling
58 * drm_fb_helper_restore_fbdev_mode() from their ->lastclose callback. They
59 * should also notify the fb helper code from updates to the output
60 * configuration by calling drm_fb_helper_hotplug_event(). For easier
61 * integration with the output polling code in drm_crtc_helper.c the modeset
62 * code proves a ->output_poll_changed callback.
64 * All other functions exported by the fb helper library can be used to
65 * implement the fbdev driver interface by the driver.
69 * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
71 * @fb_helper: fbdev initialized with drm_fb_helper_init
73 * This functions adds all the available connectors for use with the given
74 * fb_helper. This is a separate step to allow drivers to freely assign
75 * connectors to the fbdev, e.g. if some are reserved for special purposes or
76 * not adequate to be used for the fbcon.
78 * Since this is part of the initial setup before the fbdev is published, no
79 * locking is required.
81 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
83 struct drm_device *dev = fb_helper->dev;
84 struct drm_connector *connector;
87 list_for_each_entry(connector, &dev->mode_config.connector_list, head) {
88 struct drm_fb_helper_connector *fb_helper_connector;
90 fb_helper_connector = kzalloc(sizeof(struct drm_fb_helper_connector), GFP_KERNEL);
91 if (!fb_helper_connector)
94 fb_helper_connector->connector = connector;
95 fb_helper->connector_info[fb_helper->connector_count++] = fb_helper_connector;
99 for (i = 0; i < fb_helper->connector_count; i++) {
100 kfree(fb_helper->connector_info[i]);
101 fb_helper->connector_info[i] = NULL;
103 fb_helper->connector_count = 0;
106 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
108 static int drm_fb_helper_parse_command_line(struct drm_fb_helper *fb_helper)
110 struct drm_fb_helper_connector *fb_helper_conn;
113 for (i = 0; i < fb_helper->connector_count; i++) {
114 struct drm_cmdline_mode *mode;
115 struct drm_connector *connector;
118 fb_helper_conn = fb_helper->connector_info[i];
119 connector = fb_helper_conn->connector;
120 mode = &fb_helper_conn->cmdline_mode;
122 /* do something on return - turn off connector maybe */
123 if (fb_get_options(drm_get_connector_name(connector), &option))
126 if (drm_mode_parse_command_line_for_connector(option,
131 switch (mode->force) {
135 case DRM_FORCE_ON_DIGITAL:
144 DRM_INFO("forcing %s connector %s\n",
145 drm_get_connector_name(connector), s);
146 connector->force = mode->force;
149 DRM_DEBUG_KMS("cmdline mode for connector %s %dx%d@%dHz%s%s%s\n",
150 drm_get_connector_name(connector),
151 mode->xres, mode->yres,
152 mode->refresh_specified ? mode->refresh : 60,
153 mode->rb ? " reduced blanking" : "",
154 mode->margins ? " with margins" : "",
155 mode->interlace ? " interlaced" : "");
162 static void drm_fb_helper_save_lut_atomic(struct drm_crtc *crtc, struct drm_fb_helper *helper)
164 uint16_t *r_base, *g_base, *b_base;
167 if (helper->funcs->gamma_get == NULL)
170 r_base = crtc->gamma_store;
171 g_base = r_base + crtc->gamma_size;
172 b_base = g_base + crtc->gamma_size;
174 for (i = 0; i < crtc->gamma_size; i++)
175 helper->funcs->gamma_get(crtc, &r_base[i], &g_base[i], &b_base[i], i);
178 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
180 uint16_t *r_base, *g_base, *b_base;
182 if (crtc->funcs->gamma_set == NULL)
185 r_base = crtc->gamma_store;
186 g_base = r_base + crtc->gamma_size;
187 b_base = g_base + crtc->gamma_size;
189 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base, 0, crtc->gamma_size);
193 * drm_fb_helper_debug_enter - implementation for ->fb_debug_enter
194 * @info: fbdev registered by the helper
196 int drm_fb_helper_debug_enter(struct fb_info *info)
198 struct drm_fb_helper *helper = info->par;
199 struct drm_crtc_helper_funcs *funcs;
202 if (list_empty(&kernel_fb_helper_list))
205 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
206 for (i = 0; i < helper->crtc_count; i++) {
207 struct drm_mode_set *mode_set =
208 &helper->crtc_info[i].mode_set;
210 if (!mode_set->crtc->enabled)
213 funcs = mode_set->crtc->helper_private;
214 drm_fb_helper_save_lut_atomic(mode_set->crtc, helper);
215 funcs->mode_set_base_atomic(mode_set->crtc,
219 ENTER_ATOMIC_MODE_SET);
225 EXPORT_SYMBOL(drm_fb_helper_debug_enter);
227 /* Find the real fb for a given fb helper CRTC */
228 static struct drm_framebuffer *drm_mode_config_fb(struct drm_crtc *crtc)
230 struct drm_device *dev = crtc->dev;
233 list_for_each_entry(c, &dev->mode_config.crtc_list, head) {
234 if (crtc->base.id == c->base.id)
242 * drm_fb_helper_debug_leave - implementation for ->fb_debug_leave
243 * @info: fbdev registered by the helper
245 int drm_fb_helper_debug_leave(struct fb_info *info)
247 struct drm_fb_helper *helper = info->par;
248 struct drm_crtc *crtc;
249 struct drm_crtc_helper_funcs *funcs;
250 struct drm_framebuffer *fb;
253 for (i = 0; i < helper->crtc_count; i++) {
254 struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
255 crtc = mode_set->crtc;
256 funcs = crtc->helper_private;
257 fb = drm_mode_config_fb(crtc);
263 DRM_ERROR("no fb to restore??\n");
267 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
268 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
269 crtc->y, LEAVE_ATOMIC_MODE_SET);
274 EXPORT_SYMBOL(drm_fb_helper_debug_leave);
277 * drm_fb_helper_restore_fbdev_mode - restore fbdev configuration
278 * @fb_helper: fbcon to restore
280 * This should be called from driver's drm ->lastclose callback
281 * when implementing an fbcon on top of kms using this helper. This ensures that
282 * the user isn't greeted with a black screen when e.g. X dies.
284 bool drm_fb_helper_restore_fbdev_mode(struct drm_fb_helper *fb_helper)
286 struct drm_device *dev = fb_helper->dev;
287 struct drm_plane *plane;
291 drm_warn_on_modeset_not_all_locked(dev);
293 list_for_each_entry(plane, &dev->mode_config.plane_list, head)
294 drm_plane_force_disable(plane);
296 for (i = 0; i < fb_helper->crtc_count; i++) {
297 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
298 struct drm_crtc *crtc = mode_set->crtc;
301 if (crtc->funcs->cursor_set) {
302 ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
307 ret = drm_mode_set_config_internal(mode_set);
313 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode);
316 * restore fbcon display for all kms driver's using this helper, used for sysrq
317 * and panic handling.
319 static bool drm_fb_helper_force_kernel_mode(void)
321 bool ret, error = false;
322 struct drm_fb_helper *helper;
324 if (list_empty(&kernel_fb_helper_list))
327 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
328 if (helper->dev->switch_power_state == DRM_SWITCH_POWER_OFF)
331 ret = drm_fb_helper_restore_fbdev_mode(helper);
338 static int drm_fb_helper_panic(struct notifier_block *n, unsigned long ununsed,
342 * It's a waste of time and effort to switch back to text console
343 * if the kernel should reboot before panic messages can be seen.
345 if (panic_timeout < 0)
348 pr_err("panic occurred, switching back to text console\n");
349 return drm_fb_helper_force_kernel_mode();
352 static struct notifier_block paniced = {
353 .notifier_call = drm_fb_helper_panic,
356 static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
358 struct drm_device *dev = fb_helper->dev;
359 struct drm_crtc *crtc;
360 int bound = 0, crtcs_bound = 0;
362 /* Sometimes user space wants everything disabled, so don't steal the
363 * display if there's a master. */
364 if (dev->primary->master)
367 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
370 if (crtc->fb == fb_helper->fb)
374 if (bound < crtcs_bound)
380 #ifdef CONFIG_MAGIC_SYSRQ
381 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
384 ret = drm_fb_helper_force_kernel_mode();
386 DRM_ERROR("Failed to restore crtc configuration\n");
388 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
390 static void drm_fb_helper_sysrq(int dummy1)
392 schedule_work(&drm_fb_helper_restore_work);
395 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
396 .handler = drm_fb_helper_sysrq,
397 .help_msg = "force-fb(V)",
398 .action_msg = "Restore framebuffer console",
401 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
404 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
406 struct drm_fb_helper *fb_helper = info->par;
407 struct drm_device *dev = fb_helper->dev;
408 struct drm_crtc *crtc;
409 struct drm_connector *connector;
413 * fbdev->blank can be called from irq context in case of a panic.
414 * Since we already have our own special panic handler which will
415 * restore the fbdev console mode completely, just bail out early.
417 if (oops_in_progress)
421 * For each CRTC in this fb, turn the connectors on/off.
423 drm_modeset_lock_all(dev);
424 if (!drm_fb_helper_is_bound(fb_helper)) {
425 drm_modeset_unlock_all(dev);
429 for (i = 0; i < fb_helper->crtc_count; i++) {
430 crtc = fb_helper->crtc_info[i].mode_set.crtc;
435 /* Walk the connectors & encoders on this fb turning them on/off */
436 for (j = 0; j < fb_helper->connector_count; j++) {
437 connector = fb_helper->connector_info[j]->connector;
438 connector->funcs->dpms(connector, dpms_mode);
439 drm_object_property_set_value(&connector->base,
440 dev->mode_config.dpms_property, dpms_mode);
443 drm_modeset_unlock_all(dev);
447 * drm_fb_helper_blank - implementation for ->fb_blank
448 * @blank: desired blanking state
449 * @info: fbdev registered by the helper
451 int drm_fb_helper_blank(int blank, struct fb_info *info)
454 /* Display: On; HSync: On, VSync: On */
455 case FB_BLANK_UNBLANK:
456 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
458 /* Display: Off; HSync: On, VSync: On */
459 case FB_BLANK_NORMAL:
460 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
462 /* Display: Off; HSync: Off, VSync: On */
463 case FB_BLANK_HSYNC_SUSPEND:
464 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
466 /* Display: Off; HSync: On, VSync: Off */
467 case FB_BLANK_VSYNC_SUSPEND:
468 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
470 /* Display: Off; HSync: Off, VSync: Off */
471 case FB_BLANK_POWERDOWN:
472 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
477 EXPORT_SYMBOL(drm_fb_helper_blank);
479 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
483 for (i = 0; i < helper->connector_count; i++)
484 kfree(helper->connector_info[i]);
485 kfree(helper->connector_info);
486 for (i = 0; i < helper->crtc_count; i++) {
487 kfree(helper->crtc_info[i].mode_set.connectors);
488 if (helper->crtc_info[i].mode_set.mode)
489 drm_mode_destroy(helper->dev, helper->crtc_info[i].mode_set.mode);
491 kfree(helper->crtc_info);
495 * drm_fb_helper_init - initialize a drm_fb_helper structure
497 * @fb_helper: driver-allocated fbdev helper structure to initialize
498 * @crtc_count: maximum number of crtcs to support in this fbdev emulation
499 * @max_conn_count: max connector count
501 * This allocates the structures for the fbdev helper with the given limits.
502 * Note that this won't yet touch the hardware (through the driver interfaces)
503 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
504 * to allow driver writes more control over the exact init sequence.
506 * Drivers must set fb_helper->funcs before calling
507 * drm_fb_helper_initial_config().
510 * Zero if everything went ok, nonzero otherwise.
512 int drm_fb_helper_init(struct drm_device *dev,
513 struct drm_fb_helper *fb_helper,
514 int crtc_count, int max_conn_count)
516 struct drm_crtc *crtc;
522 fb_helper->dev = dev;
524 INIT_LIST_HEAD(&fb_helper->kernel_fb_list);
526 fb_helper->crtc_info = kcalloc(crtc_count, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
527 if (!fb_helper->crtc_info)
530 fb_helper->crtc_count = crtc_count;
531 fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
532 if (!fb_helper->connector_info) {
533 kfree(fb_helper->crtc_info);
536 fb_helper->connector_count = 0;
538 for (i = 0; i < crtc_count; i++) {
539 fb_helper->crtc_info[i].mode_set.connectors =
540 kcalloc(max_conn_count,
541 sizeof(struct drm_connector *),
544 if (!fb_helper->crtc_info[i].mode_set.connectors)
546 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
550 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
551 fb_helper->crtc_info[i].mode_set.crtc = crtc;
557 drm_fb_helper_crtc_free(fb_helper);
560 EXPORT_SYMBOL(drm_fb_helper_init);
562 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
564 if (!list_empty(&fb_helper->kernel_fb_list)) {
565 list_del(&fb_helper->kernel_fb_list);
566 if (list_empty(&kernel_fb_helper_list)) {
567 pr_info("drm: unregistered panic notifier\n");
568 atomic_notifier_chain_unregister(&panic_notifier_list,
570 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
574 drm_fb_helper_crtc_free(fb_helper);
577 EXPORT_SYMBOL(drm_fb_helper_fini);
579 static int setcolreg(struct drm_crtc *crtc, u16 red, u16 green,
580 u16 blue, u16 regno, struct fb_info *info)
582 struct drm_fb_helper *fb_helper = info->par;
583 struct drm_framebuffer *fb = fb_helper->fb;
586 if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
589 /* place color in psuedopalette */
592 palette = (u32 *)info->pseudo_palette;
593 red >>= (16 - info->var.red.length);
594 green >>= (16 - info->var.green.length);
595 blue >>= (16 - info->var.blue.length);
596 value = (red << info->var.red.offset) |
597 (green << info->var.green.offset) |
598 (blue << info->var.blue.offset);
599 if (info->var.transp.length > 0) {
600 u32 mask = (1 << info->var.transp.length) - 1;
601 mask <<= info->var.transp.offset;
604 palette[regno] = value;
609 * The driver really shouldn't advertise pseudo/directcolor
610 * visuals if it can't deal with the palette.
612 if (WARN_ON(!fb_helper->funcs->gamma_set ||
613 !fb_helper->funcs->gamma_get))
618 if (fb->bits_per_pixel == 16) {
621 if (fb->depth == 16 && regno > 63)
623 if (fb->depth == 15 && regno > 31)
626 if (fb->depth == 16) {
630 for (i = 0; i < 8; i++)
631 fb_helper->funcs->gamma_set(crtc, red,
632 green, blue, pindex + i);
635 fb_helper->funcs->gamma_get(crtc, &r,
639 for (i = 0; i < 4; i++)
640 fb_helper->funcs->gamma_set(crtc, r,
647 fb_helper->funcs->gamma_set(crtc, red, green, blue, pindex);
652 * drm_fb_helper_setcmap - implementation for ->fb_setcmap
654 * @info: fbdev registered by the helper
656 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
658 struct drm_fb_helper *fb_helper = info->par;
659 struct drm_device *dev = fb_helper->dev;
660 struct drm_crtc_helper_funcs *crtc_funcs;
661 u16 *red, *green, *blue, *transp;
662 struct drm_crtc *crtc;
666 drm_modeset_lock_all(dev);
667 if (!drm_fb_helper_is_bound(fb_helper)) {
668 drm_modeset_unlock_all(dev);
672 for (i = 0; i < fb_helper->crtc_count; i++) {
673 crtc = fb_helper->crtc_info[i].mode_set.crtc;
674 crtc_funcs = crtc->helper_private;
679 transp = cmap->transp;
682 for (j = 0; j < cmap->len; j++) {
683 u16 hred, hgreen, hblue, htransp = 0xffff;
692 rc = setcolreg(crtc, hred, hgreen, hblue, start++, info);
696 if (crtc_funcs->load_lut)
697 crtc_funcs->load_lut(crtc);
700 drm_modeset_unlock_all(dev);
703 EXPORT_SYMBOL(drm_fb_helper_setcmap);
706 * drm_fb_helper_check_var - implementation for ->fb_check_var
707 * @var: screeninfo to check
708 * @info: fbdev registered by the helper
710 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
711 struct fb_info *info)
713 struct drm_fb_helper *fb_helper = info->par;
714 struct drm_framebuffer *fb = fb_helper->fb;
717 if (var->pixclock != 0 || in_dbg_master())
720 /* Need to resize the fb object !!! */
721 if (var->bits_per_pixel > fb->bits_per_pixel ||
722 var->xres > fb->width || var->yres > fb->height ||
723 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
724 DRM_DEBUG("fb userspace requested width/height/bpp is greater than current fb "
725 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
726 var->xres, var->yres, var->bits_per_pixel,
727 var->xres_virtual, var->yres_virtual,
728 fb->width, fb->height, fb->bits_per_pixel);
732 switch (var->bits_per_pixel) {
734 depth = (var->green.length == 6) ? 16 : 15;
737 depth = (var->transp.length > 0) ? 32 : 24;
740 depth = var->bits_per_pixel;
747 var->green.offset = 0;
748 var->blue.offset = 0;
750 var->green.length = 8;
751 var->blue.length = 8;
752 var->transp.length = 0;
753 var->transp.offset = 0;
756 var->red.offset = 10;
757 var->green.offset = 5;
758 var->blue.offset = 0;
760 var->green.length = 5;
761 var->blue.length = 5;
762 var->transp.length = 1;
763 var->transp.offset = 15;
766 var->red.offset = 11;
767 var->green.offset = 5;
768 var->blue.offset = 0;
770 var->green.length = 6;
771 var->blue.length = 5;
772 var->transp.length = 0;
773 var->transp.offset = 0;
776 var->red.offset = 16;
777 var->green.offset = 8;
778 var->blue.offset = 0;
780 var->green.length = 8;
781 var->blue.length = 8;
782 var->transp.length = 0;
783 var->transp.offset = 0;
786 var->red.offset = 16;
787 var->green.offset = 8;
788 var->blue.offset = 0;
790 var->green.length = 8;
791 var->blue.length = 8;
792 var->transp.length = 8;
793 var->transp.offset = 24;
800 EXPORT_SYMBOL(drm_fb_helper_check_var);
803 * drm_fb_helper_set_par - implementation for ->fb_set_par
804 * @info: fbdev registered by the helper
806 * This will let fbcon do the mode init and is called at initialization time by
807 * the fbdev core when registering the driver, and later on through the hotplug
810 int drm_fb_helper_set_par(struct fb_info *info)
812 struct drm_fb_helper *fb_helper = info->par;
813 struct drm_device *dev = fb_helper->dev;
814 struct fb_var_screeninfo *var = &info->var;
816 if (var->pixclock != 0) {
817 DRM_ERROR("PIXEL CLOCK SET\n");
821 drm_modeset_lock_all(dev);
822 drm_fb_helper_restore_fbdev_mode(fb_helper);
823 drm_modeset_unlock_all(dev);
825 if (fb_helper->delayed_hotplug) {
826 fb_helper->delayed_hotplug = false;
827 drm_fb_helper_hotplug_event(fb_helper);
831 EXPORT_SYMBOL(drm_fb_helper_set_par);
834 * drm_fb_helper_pan_display - implementation for ->fb_pan_display
835 * @var: updated screen information
836 * @info: fbdev registered by the helper
838 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
839 struct fb_info *info)
841 struct drm_fb_helper *fb_helper = info->par;
842 struct drm_device *dev = fb_helper->dev;
843 struct drm_mode_set *modeset;
847 drm_modeset_lock_all(dev);
848 if (!drm_fb_helper_is_bound(fb_helper)) {
849 drm_modeset_unlock_all(dev);
853 for (i = 0; i < fb_helper->crtc_count; i++) {
854 modeset = &fb_helper->crtc_info[i].mode_set;
856 modeset->x = var->xoffset;
857 modeset->y = var->yoffset;
859 if (modeset->num_connectors) {
860 ret = drm_mode_set_config_internal(modeset);
862 info->var.xoffset = var->xoffset;
863 info->var.yoffset = var->yoffset;
867 drm_modeset_unlock_all(dev);
870 EXPORT_SYMBOL(drm_fb_helper_pan_display);
873 * Allocates the backing storage and sets up the fbdev info structure through
874 * the ->fb_probe callback and then registers the fbdev and sets up the panic
877 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
883 struct fb_info *info;
884 struct drm_fb_helper_surface_size sizes;
887 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
888 sizes.surface_depth = 24;
889 sizes.surface_bpp = 32;
890 sizes.fb_width = (unsigned)-1;
891 sizes.fb_height = (unsigned)-1;
893 /* if driver picks 8 or 16 by default use that
894 for both depth/bpp */
895 if (preferred_bpp != sizes.surface_bpp)
896 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
898 /* first up get a count of crtcs now in use and new min/maxes width/heights */
899 for (i = 0; i < fb_helper->connector_count; i++) {
900 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
901 struct drm_cmdline_mode *cmdline_mode;
903 cmdline_mode = &fb_helper_conn->cmdline_mode;
905 if (cmdline_mode->bpp_specified) {
906 switch (cmdline_mode->bpp) {
908 sizes.surface_depth = sizes.surface_bpp = 8;
911 sizes.surface_depth = 15;
912 sizes.surface_bpp = 16;
915 sizes.surface_depth = sizes.surface_bpp = 16;
918 sizes.surface_depth = sizes.surface_bpp = 24;
921 sizes.surface_depth = 24;
922 sizes.surface_bpp = 32;
930 for (i = 0; i < fb_helper->crtc_count; i++) {
931 struct drm_display_mode *desired_mode;
932 desired_mode = fb_helper->crtc_info[i].desired_mode;
936 gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
937 if (desired_mode->hdisplay < sizes.fb_width)
938 sizes.fb_width = desired_mode->hdisplay;
939 if (desired_mode->vdisplay < sizes.fb_height)
940 sizes.fb_height = desired_mode->vdisplay;
941 if (desired_mode->hdisplay > sizes.surface_width)
942 sizes.surface_width = desired_mode->hdisplay;
943 if (desired_mode->vdisplay > sizes.surface_height)
944 sizes.surface_height = desired_mode->vdisplay;
949 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
950 /* hmm everyone went away - assume VGA cable just fell out
951 and will come back later. */
952 DRM_INFO("Cannot find any crtc or sizes - going 1024x768\n");
953 sizes.fb_width = sizes.surface_width = 1024;
954 sizes.fb_height = sizes.surface_height = 768;
957 /* push down into drivers */
958 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
962 info = fb_helper->fbdev;
965 * Set the fb pointer - usually drm_setup_crtcs does this for hotplug
966 * events, but at init time drm_setup_crtcs needs to be called before
967 * the fb is allocated (since we need to figure out the desired size of
968 * the fb before we can allocate it ...). Hence we need to fix things up
971 for (i = 0; i < fb_helper->crtc_count; i++)
972 if (fb_helper->crtc_info[i].mode_set.num_connectors)
973 fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
976 info->var.pixclock = 0;
977 if (register_framebuffer(info) < 0)
980 dev_info(fb_helper->dev->dev, "fb%d: %s frame buffer device\n",
981 info->node, info->fix.id);
983 /* Switch back to kernel console on panic */
984 /* multi card linked list maybe */
985 if (list_empty(&kernel_fb_helper_list)) {
986 dev_info(fb_helper->dev->dev, "registered panic notifier\n");
987 atomic_notifier_chain_register(&panic_notifier_list,
989 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
992 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
998 * drm_fb_helper_fill_fix - initializes fixed fbdev information
999 * @info: fbdev registered by the helper
1000 * @pitch: desired pitch
1001 * @depth: desired depth
1003 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1004 * fbdev emulations. Drivers which support acceleration methods which impose
1005 * additional constraints need to set up their own limits.
1007 * Drivers should call this (or their equivalent setup code) from their
1008 * ->fb_probe callback.
1010 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1013 info->fix.type = FB_TYPE_PACKED_PIXELS;
1014 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1015 FB_VISUAL_TRUECOLOR;
1016 info->fix.mmio_start = 0;
1017 info->fix.mmio_len = 0;
1018 info->fix.type_aux = 0;
1019 info->fix.xpanstep = 1; /* doing it in hw */
1020 info->fix.ypanstep = 1; /* doing it in hw */
1021 info->fix.ywrapstep = 0;
1022 info->fix.accel = FB_ACCEL_NONE;
1023 info->fix.type_aux = 0;
1025 info->fix.line_length = pitch;
1028 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1031 * drm_fb_helper_fill_var - initalizes variable fbdev information
1032 * @info: fbdev instance to set up
1033 * @fb_helper: fb helper instance to use as template
1034 * @fb_width: desired fb width
1035 * @fb_height: desired fb height
1037 * Sets up the variable fbdev metainformation from the given fb helper instance
1038 * and the drm framebuffer allocated in fb_helper->fb.
1040 * Drivers should call this (or their equivalent setup code) from their
1041 * ->fb_probe callback after having allocated the fbdev backing
1042 * storage framebuffer.
1044 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1045 uint32_t fb_width, uint32_t fb_height)
1047 struct drm_framebuffer *fb = fb_helper->fb;
1048 info->pseudo_palette = fb_helper->pseudo_palette;
1049 info->var.xres_virtual = fb->width;
1050 info->var.yres_virtual = fb->height;
1051 info->var.bits_per_pixel = fb->bits_per_pixel;
1052 info->var.accel_flags = FB_ACCELF_TEXT;
1053 info->var.xoffset = 0;
1054 info->var.yoffset = 0;
1055 info->var.activate = FB_ACTIVATE_NOW;
1056 info->var.height = -1;
1057 info->var.width = -1;
1059 switch (fb->depth) {
1061 info->var.red.offset = 0;
1062 info->var.green.offset = 0;
1063 info->var.blue.offset = 0;
1064 info->var.red.length = 8; /* 8bit DAC */
1065 info->var.green.length = 8;
1066 info->var.blue.length = 8;
1067 info->var.transp.offset = 0;
1068 info->var.transp.length = 0;
1071 info->var.red.offset = 10;
1072 info->var.green.offset = 5;
1073 info->var.blue.offset = 0;
1074 info->var.red.length = 5;
1075 info->var.green.length = 5;
1076 info->var.blue.length = 5;
1077 info->var.transp.offset = 15;
1078 info->var.transp.length = 1;
1081 info->var.red.offset = 11;
1082 info->var.green.offset = 5;
1083 info->var.blue.offset = 0;
1084 info->var.red.length = 5;
1085 info->var.green.length = 6;
1086 info->var.blue.length = 5;
1087 info->var.transp.offset = 0;
1090 info->var.red.offset = 16;
1091 info->var.green.offset = 8;
1092 info->var.blue.offset = 0;
1093 info->var.red.length = 8;
1094 info->var.green.length = 8;
1095 info->var.blue.length = 8;
1096 info->var.transp.offset = 0;
1097 info->var.transp.length = 0;
1100 info->var.red.offset = 16;
1101 info->var.green.offset = 8;
1102 info->var.blue.offset = 0;
1103 info->var.red.length = 8;
1104 info->var.green.length = 8;
1105 info->var.blue.length = 8;
1106 info->var.transp.offset = 24;
1107 info->var.transp.length = 8;
1113 info->var.xres = fb_width;
1114 info->var.yres = fb_height;
1116 EXPORT_SYMBOL(drm_fb_helper_fill_var);
1118 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
1122 struct drm_connector *connector;
1126 for (i = 0; i < fb_helper->connector_count; i++) {
1127 connector = fb_helper->connector_info[i]->connector;
1128 count += connector->funcs->fill_modes(connector, maxX, maxY);
1134 struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
1136 struct drm_display_mode *mode;
1138 list_for_each_entry(mode, &fb_connector->connector->modes, head) {
1139 if (mode->hdisplay > width ||
1140 mode->vdisplay > height)
1142 if (mode->type & DRM_MODE_TYPE_PREFERRED)
1147 EXPORT_SYMBOL(drm_has_preferred_mode);
1149 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
1151 struct drm_cmdline_mode *cmdline_mode;
1152 cmdline_mode = &fb_connector->cmdline_mode;
1153 return cmdline_mode->specified;
1156 struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
1157 int width, int height)
1159 struct drm_cmdline_mode *cmdline_mode;
1160 struct drm_display_mode *mode = NULL;
1162 cmdline_mode = &fb_helper_conn->cmdline_mode;
1163 if (cmdline_mode->specified == false)
1166 /* attempt to find a matching mode in the list of modes
1167 * we have gotten so far, if not add a CVT mode that conforms
1169 if (cmdline_mode->rb || cmdline_mode->margins)
1172 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1173 /* check width/height */
1174 if (mode->hdisplay != cmdline_mode->xres ||
1175 mode->vdisplay != cmdline_mode->yres)
1178 if (cmdline_mode->refresh_specified) {
1179 if (mode->vrefresh != cmdline_mode->refresh)
1183 if (cmdline_mode->interlace) {
1184 if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
1191 mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
1193 list_add(&mode->head, &fb_helper_conn->connector->modes);
1196 EXPORT_SYMBOL(drm_pick_cmdline_mode);
1198 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
1203 enable = connector->status == connector_status_connected;
1205 enable = connector->status != connector_status_disconnected;
1210 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
1213 bool any_enabled = false;
1214 struct drm_connector *connector;
1217 for (i = 0; i < fb_helper->connector_count; i++) {
1218 connector = fb_helper->connector_info[i]->connector;
1219 enabled[i] = drm_connector_enabled(connector, true);
1220 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
1221 enabled[i] ? "yes" : "no");
1222 any_enabled |= enabled[i];
1228 for (i = 0; i < fb_helper->connector_count; i++) {
1229 connector = fb_helper->connector_info[i]->connector;
1230 enabled[i] = drm_connector_enabled(connector, false);
1234 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
1235 struct drm_display_mode **modes,
1236 bool *enabled, int width, int height)
1239 bool can_clone = false;
1240 struct drm_fb_helper_connector *fb_helper_conn;
1241 struct drm_display_mode *dmt_mode, *mode;
1243 /* only contemplate cloning in the single crtc case */
1244 if (fb_helper->crtc_count > 1)
1248 for (i = 0; i < fb_helper->connector_count; i++) {
1253 /* only contemplate cloning if more than one connector is enabled */
1257 /* check the command line or if nothing common pick 1024x768 */
1259 for (i = 0; i < fb_helper->connector_count; i++) {
1262 fb_helper_conn = fb_helper->connector_info[i];
1263 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1268 for (j = 0; j < i; j++) {
1271 if (!drm_mode_equal(modes[j], modes[i]))
1277 DRM_DEBUG_KMS("can clone using command line\n");
1281 /* try and find a 1024x768 mode on each connector */
1283 dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
1285 for (i = 0; i < fb_helper->connector_count; i++) {
1290 fb_helper_conn = fb_helper->connector_info[i];
1291 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1292 if (drm_mode_equal(mode, dmt_mode))
1300 DRM_DEBUG_KMS("can clone using 1024x768\n");
1303 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
1307 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
1308 struct drm_display_mode **modes,
1309 bool *enabled, int width, int height)
1311 struct drm_fb_helper_connector *fb_helper_conn;
1314 for (i = 0; i < fb_helper->connector_count; i++) {
1315 fb_helper_conn = fb_helper->connector_info[i];
1317 if (enabled[i] == false)
1320 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
1321 fb_helper_conn->connector->base.id);
1323 /* got for command line mode first */
1324 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1326 DRM_DEBUG_KMS("looking for preferred mode on connector %d\n",
1327 fb_helper_conn->connector->base.id);
1328 modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
1330 /* No preferred modes, pick one off the list */
1331 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
1332 list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
1335 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
1341 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
1342 struct drm_fb_helper_crtc **best_crtcs,
1343 struct drm_display_mode **modes,
1344 int n, int width, int height)
1347 struct drm_device *dev = fb_helper->dev;
1348 struct drm_connector *connector;
1349 struct drm_connector_helper_funcs *connector_funcs;
1350 struct drm_encoder *encoder;
1351 int my_score, best_score, score;
1352 struct drm_fb_helper_crtc **crtcs, *crtc;
1353 struct drm_fb_helper_connector *fb_helper_conn;
1355 if (n == fb_helper->connector_count)
1358 fb_helper_conn = fb_helper->connector_info[n];
1359 connector = fb_helper_conn->connector;
1361 best_crtcs[n] = NULL;
1362 best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
1363 if (modes[n] == NULL)
1366 crtcs = kzalloc(dev->mode_config.num_connector *
1367 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
1372 if (connector->status == connector_status_connected)
1374 if (drm_has_cmdline_mode(fb_helper_conn))
1376 if (drm_has_preferred_mode(fb_helper_conn, width, height))
1379 connector_funcs = connector->helper_private;
1380 encoder = connector_funcs->best_encoder(connector);
1384 /* select a crtc for this connector and then attempt to configure
1385 remaining connectors */
1386 for (c = 0; c < fb_helper->crtc_count; c++) {
1387 crtc = &fb_helper->crtc_info[c];
1389 if ((encoder->possible_crtcs & (1 << c)) == 0)
1392 for (o = 0; o < n; o++)
1393 if (best_crtcs[o] == crtc)
1397 /* ignore cloning unless only a single crtc */
1398 if (fb_helper->crtc_count > 1)
1401 if (!drm_mode_equal(modes[o], modes[n]))
1406 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
1407 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
1409 if (score > best_score) {
1411 memcpy(best_crtcs, crtcs,
1412 dev->mode_config.num_connector *
1413 sizeof(struct drm_fb_helper_crtc *));
1421 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper)
1423 struct drm_device *dev = fb_helper->dev;
1424 struct drm_fb_helper_crtc **crtcs;
1425 struct drm_display_mode **modes;
1426 struct drm_mode_set *modeset;
1431 DRM_DEBUG_KMS("\n");
1433 width = dev->mode_config.max_width;
1434 height = dev->mode_config.max_height;
1436 crtcs = kcalloc(dev->mode_config.num_connector,
1437 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
1438 modes = kcalloc(dev->mode_config.num_connector,
1439 sizeof(struct drm_display_mode *), GFP_KERNEL);
1440 enabled = kcalloc(dev->mode_config.num_connector,
1441 sizeof(bool), GFP_KERNEL);
1442 if (!crtcs || !modes || !enabled) {
1443 DRM_ERROR("Memory allocation failed\n");
1448 drm_enable_connectors(fb_helper, enabled);
1450 if (!(fb_helper->funcs->initial_config &&
1451 fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
1452 enabled, width, height))) {
1453 memset(modes, 0, dev->mode_config.num_connector*sizeof(modes[0]));
1454 memset(crtcs, 0, dev->mode_config.num_connector*sizeof(crtcs[0]));
1456 if (!drm_target_cloned(fb_helper,
1457 modes, enabled, width, height) &&
1458 !drm_target_preferred(fb_helper,
1459 modes, enabled, width, height))
1460 DRM_ERROR("Unable to find initial modes\n");
1462 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
1465 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
1468 /* need to set the modesets up here for use later */
1469 /* fill out the connector<->crtc mappings into the modesets */
1470 for (i = 0; i < fb_helper->crtc_count; i++) {
1471 modeset = &fb_helper->crtc_info[i].mode_set;
1472 modeset->num_connectors = 0;
1476 for (i = 0; i < fb_helper->connector_count; i++) {
1477 struct drm_display_mode *mode = modes[i];
1478 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
1479 modeset = &fb_crtc->mode_set;
1481 if (mode && fb_crtc) {
1482 DRM_DEBUG_KMS("desired mode %s set on crtc %d\n",
1483 mode->name, fb_crtc->mode_set.crtc->base.id);
1484 fb_crtc->desired_mode = mode;
1486 drm_mode_destroy(dev, modeset->mode);
1487 modeset->mode = drm_mode_duplicate(dev,
1488 fb_crtc->desired_mode);
1489 modeset->connectors[modeset->num_connectors++] = fb_helper->connector_info[i]->connector;
1490 modeset->fb = fb_helper->fb;
1494 /* Clear out any old modes if there are no more connected outputs. */
1495 for (i = 0; i < fb_helper->crtc_count; i++) {
1496 modeset = &fb_helper->crtc_info[i].mode_set;
1497 if (modeset->num_connectors == 0) {
1498 BUG_ON(modeset->fb);
1499 BUG_ON(modeset->num_connectors);
1501 drm_mode_destroy(dev, modeset->mode);
1502 modeset->mode = NULL;
1512 * drm_fb_helper_initial_config - setup a sane initial connector configuration
1513 * @fb_helper: fb_helper device struct
1514 * @bpp_sel: bpp value to use for the framebuffer configuration
1516 * Scans the CRTCs and connectors and tries to put together an initial setup.
1517 * At the moment, this is a cloned configuration across all heads with
1518 * a new framebuffer object as the backing store.
1520 * Note that this also registers the fbdev and so allows userspace to call into
1521 * the driver through the fbdev interfaces.
1523 * This function will call down into the ->fb_probe callback to let
1524 * the driver allocate and initialize the fbdev info structure and the drm
1525 * framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
1526 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
1527 * values for the fbdev info structure.
1530 * Zero if everything went ok, nonzero otherwise.
1532 bool drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
1534 struct drm_device *dev = fb_helper->dev;
1537 drm_fb_helper_parse_command_line(fb_helper);
1539 count = drm_fb_helper_probe_connector_modes(fb_helper,
1540 dev->mode_config.max_width,
1541 dev->mode_config.max_height);
1543 * we shouldn't end up with no modes here.
1546 dev_info(fb_helper->dev->dev, "No connectors reported connected with modes\n");
1548 drm_setup_crtcs(fb_helper);
1550 return drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
1552 EXPORT_SYMBOL(drm_fb_helper_initial_config);
1555 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
1556 * probing all the outputs attached to the fb
1557 * @fb_helper: the drm_fb_helper
1559 * Scan the connectors attached to the fb_helper and try to put together a
1560 * setup after *notification of a change in output configuration.
1562 * Called at runtime, takes the mode config locks to be able to check/change the
1563 * modeset configuration. Must be run from process context (which usually means
1564 * either the output polling work or a work item launched from the driver's
1565 * hotplug interrupt).
1567 * Note that the driver must ensure that this is only called _after_ the fb has
1568 * been fully set up, i.e. after the call to drm_fb_helper_initial_config.
1571 * 0 on success and a non-zero error code otherwise.
1573 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
1575 struct drm_device *dev = fb_helper->dev;
1576 u32 max_width, max_height;
1581 mutex_lock(&fb_helper->dev->mode_config.mutex);
1582 if (!drm_fb_helper_is_bound(fb_helper)) {
1583 fb_helper->delayed_hotplug = true;
1584 mutex_unlock(&fb_helper->dev->mode_config.mutex);
1587 DRM_DEBUG_KMS("\n");
1589 max_width = fb_helper->fb->width;
1590 max_height = fb_helper->fb->height;
1592 drm_fb_helper_probe_connector_modes(fb_helper, max_width, max_height);
1593 mutex_unlock(&fb_helper->dev->mode_config.mutex);
1595 drm_modeset_lock_all(dev);
1596 drm_setup_crtcs(fb_helper);
1597 drm_modeset_unlock_all(dev);
1598 drm_fb_helper_set_par(fb_helper->fbdev);
1602 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
1604 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
1605 * but the module doesn't depend on any fb console symbols. At least
1606 * attempt to load fbcon to avoid leaving the system without a usable console.
1608 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
1609 static int __init drm_fb_helper_modinit(void)
1611 const char *name = "fbcon";
1612 struct module *fbcon;
1614 mutex_lock(&module_mutex);
1615 fbcon = find_module(name);
1616 mutex_unlock(&module_mutex);
1619 request_module_nowait(name);
1623 module_init(drm_fb_helper_modinit);