2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
6 * DRM framebuffer helper functions
8 * Permission to use, copy, modify, distribute, and sell this software and its
9 * documentation for any purpose is hereby granted without fee, provided that
10 * the above copyright notice appear in all copies and that both that copyright
11 * notice and this permission notice appear in supporting documentation, and
12 * that the name of the copyright holders not be used in advertising or
13 * publicity pertaining to distribution of the software without specific,
14 * written prior permission. The copyright holders make no representations
15 * about the suitability of this software for any purpose. It is provided "as
16 * is" without express or implied warranty.
18 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32 #include <linux/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 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
365 if (crtc->fb == fb_helper->fb)
369 if (bound < crtcs_bound)
374 #ifdef CONFIG_MAGIC_SYSRQ
375 static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
378 ret = drm_fb_helper_force_kernel_mode();
380 DRM_ERROR("Failed to restore crtc configuration\n");
382 static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
384 static void drm_fb_helper_sysrq(int dummy1)
386 schedule_work(&drm_fb_helper_restore_work);
389 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
390 .handler = drm_fb_helper_sysrq,
391 .help_msg = "force-fb(V)",
392 .action_msg = "Restore framebuffer console",
395 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
398 static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
400 struct drm_fb_helper *fb_helper = info->par;
401 struct drm_device *dev = fb_helper->dev;
402 struct drm_crtc *crtc;
403 struct drm_connector *connector;
407 * fbdev->blank can be called from irq context in case of a panic.
408 * Since we already have our own special panic handler which will
409 * restore the fbdev console mode completely, just bail out early.
411 if (oops_in_progress)
415 * For each CRTC in this fb, turn the connectors on/off.
417 drm_modeset_lock_all(dev);
418 if (!drm_fb_helper_is_bound(fb_helper)) {
419 drm_modeset_unlock_all(dev);
423 for (i = 0; i < fb_helper->crtc_count; i++) {
424 crtc = fb_helper->crtc_info[i].mode_set.crtc;
429 /* Walk the connectors & encoders on this fb turning them on/off */
430 for (j = 0; j < fb_helper->connector_count; j++) {
431 connector = fb_helper->connector_info[j]->connector;
432 connector->funcs->dpms(connector, dpms_mode);
433 drm_object_property_set_value(&connector->base,
434 dev->mode_config.dpms_property, dpms_mode);
437 drm_modeset_unlock_all(dev);
441 * drm_fb_helper_blank - implementation for ->fb_blank
442 * @blank: desired blanking state
443 * @info: fbdev registered by the helper
445 int drm_fb_helper_blank(int blank, struct fb_info *info)
448 /* Display: On; HSync: On, VSync: On */
449 case FB_BLANK_UNBLANK:
450 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
452 /* Display: Off; HSync: On, VSync: On */
453 case FB_BLANK_NORMAL:
454 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
456 /* Display: Off; HSync: Off, VSync: On */
457 case FB_BLANK_HSYNC_SUSPEND:
458 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
460 /* Display: Off; HSync: On, VSync: Off */
461 case FB_BLANK_VSYNC_SUSPEND:
462 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
464 /* Display: Off; HSync: Off, VSync: Off */
465 case FB_BLANK_POWERDOWN:
466 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
471 EXPORT_SYMBOL(drm_fb_helper_blank);
473 static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
477 for (i = 0; i < helper->connector_count; i++)
478 kfree(helper->connector_info[i]);
479 kfree(helper->connector_info);
480 for (i = 0; i < helper->crtc_count; i++) {
481 kfree(helper->crtc_info[i].mode_set.connectors);
482 if (helper->crtc_info[i].mode_set.mode)
483 drm_mode_destroy(helper->dev, helper->crtc_info[i].mode_set.mode);
485 kfree(helper->crtc_info);
489 * drm_fb_helper_init - initialize a drm_fb_helper structure
491 * @fb_helper: driver-allocated fbdev helper structure to initialize
492 * @crtc_count: maximum number of crtcs to support in this fbdev emulation
493 * @max_conn_count: max connector count
495 * This allocates the structures for the fbdev helper with the given limits.
496 * Note that this won't yet touch the hardware (through the driver interfaces)
497 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
498 * to allow driver writes more control over the exact init sequence.
500 * Drivers must set fb_helper->funcs before calling
501 * drm_fb_helper_initial_config().
504 * Zero if everything went ok, nonzero otherwise.
506 int drm_fb_helper_init(struct drm_device *dev,
507 struct drm_fb_helper *fb_helper,
508 int crtc_count, int max_conn_count)
510 struct drm_crtc *crtc;
513 fb_helper->dev = dev;
515 INIT_LIST_HEAD(&fb_helper->kernel_fb_list);
517 fb_helper->crtc_info = kcalloc(crtc_count, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
518 if (!fb_helper->crtc_info)
521 fb_helper->crtc_count = crtc_count;
522 fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
523 if (!fb_helper->connector_info) {
524 kfree(fb_helper->crtc_info);
527 fb_helper->connector_count = 0;
529 for (i = 0; i < crtc_count; i++) {
530 fb_helper->crtc_info[i].mode_set.connectors =
531 kcalloc(max_conn_count,
532 sizeof(struct drm_connector *),
535 if (!fb_helper->crtc_info[i].mode_set.connectors)
537 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
541 list_for_each_entry(crtc, &dev->mode_config.crtc_list, head) {
542 fb_helper->crtc_info[i].mode_set.crtc = crtc;
548 drm_fb_helper_crtc_free(fb_helper);
551 EXPORT_SYMBOL(drm_fb_helper_init);
553 void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
555 if (!list_empty(&fb_helper->kernel_fb_list)) {
556 list_del(&fb_helper->kernel_fb_list);
557 if (list_empty(&kernel_fb_helper_list)) {
558 pr_info("drm: unregistered panic notifier\n");
559 atomic_notifier_chain_unregister(&panic_notifier_list,
561 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
565 drm_fb_helper_crtc_free(fb_helper);
568 EXPORT_SYMBOL(drm_fb_helper_fini);
570 static int setcolreg(struct drm_crtc *crtc, u16 red, u16 green,
571 u16 blue, u16 regno, struct fb_info *info)
573 struct drm_fb_helper *fb_helper = info->par;
574 struct drm_framebuffer *fb = fb_helper->fb;
577 if (info->fix.visual == FB_VISUAL_TRUECOLOR) {
580 /* place color in psuedopalette */
583 palette = (u32 *)info->pseudo_palette;
584 red >>= (16 - info->var.red.length);
585 green >>= (16 - info->var.green.length);
586 blue >>= (16 - info->var.blue.length);
587 value = (red << info->var.red.offset) |
588 (green << info->var.green.offset) |
589 (blue << info->var.blue.offset);
590 if (info->var.transp.length > 0) {
591 u32 mask = (1 << info->var.transp.length) - 1;
592 mask <<= info->var.transp.offset;
595 palette[regno] = value;
600 * The driver really shouldn't advertise pseudo/directcolor
601 * visuals if it can't deal with the palette.
603 if (WARN_ON(!fb_helper->funcs->gamma_set ||
604 !fb_helper->funcs->gamma_get))
609 if (fb->bits_per_pixel == 16) {
612 if (fb->depth == 16 && regno > 63)
614 if (fb->depth == 15 && regno > 31)
617 if (fb->depth == 16) {
621 for (i = 0; i < 8; i++)
622 fb_helper->funcs->gamma_set(crtc, red,
623 green, blue, pindex + i);
626 fb_helper->funcs->gamma_get(crtc, &r,
630 for (i = 0; i < 4; i++)
631 fb_helper->funcs->gamma_set(crtc, r,
638 fb_helper->funcs->gamma_set(crtc, red, green, blue, pindex);
643 * drm_fb_helper_setcmap - implementation for ->fb_setcmap
645 * @info: fbdev registered by the helper
647 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
649 struct drm_fb_helper *fb_helper = info->par;
650 struct drm_device *dev = fb_helper->dev;
651 struct drm_crtc_helper_funcs *crtc_funcs;
652 u16 *red, *green, *blue, *transp;
653 struct drm_crtc *crtc;
657 drm_modeset_lock_all(dev);
658 if (!drm_fb_helper_is_bound(fb_helper)) {
659 drm_modeset_unlock_all(dev);
663 for (i = 0; i < fb_helper->crtc_count; i++) {
664 crtc = fb_helper->crtc_info[i].mode_set.crtc;
665 crtc_funcs = crtc->helper_private;
670 transp = cmap->transp;
673 for (j = 0; j < cmap->len; j++) {
674 u16 hred, hgreen, hblue, htransp = 0xffff;
683 rc = setcolreg(crtc, hred, hgreen, hblue, start++, info);
687 if (crtc_funcs->load_lut)
688 crtc_funcs->load_lut(crtc);
691 drm_modeset_unlock_all(dev);
694 EXPORT_SYMBOL(drm_fb_helper_setcmap);
697 * drm_fb_helper_check_var - implementation for ->fb_check_var
698 * @var: screeninfo to check
699 * @info: fbdev registered by the helper
701 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
702 struct fb_info *info)
704 struct drm_fb_helper *fb_helper = info->par;
705 struct drm_framebuffer *fb = fb_helper->fb;
708 if (var->pixclock != 0 || in_dbg_master())
711 /* Need to resize the fb object !!! */
712 if (var->bits_per_pixel > fb->bits_per_pixel ||
713 var->xres > fb->width || var->yres > fb->height ||
714 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
715 DRM_DEBUG("fb userspace requested width/height/bpp is greater than current fb "
716 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
717 var->xres, var->yres, var->bits_per_pixel,
718 var->xres_virtual, var->yres_virtual,
719 fb->width, fb->height, fb->bits_per_pixel);
723 switch (var->bits_per_pixel) {
725 depth = (var->green.length == 6) ? 16 : 15;
728 depth = (var->transp.length > 0) ? 32 : 24;
731 depth = var->bits_per_pixel;
738 var->green.offset = 0;
739 var->blue.offset = 0;
741 var->green.length = 8;
742 var->blue.length = 8;
743 var->transp.length = 0;
744 var->transp.offset = 0;
747 var->red.offset = 10;
748 var->green.offset = 5;
749 var->blue.offset = 0;
751 var->green.length = 5;
752 var->blue.length = 5;
753 var->transp.length = 1;
754 var->transp.offset = 15;
757 var->red.offset = 11;
758 var->green.offset = 5;
759 var->blue.offset = 0;
761 var->green.length = 6;
762 var->blue.length = 5;
763 var->transp.length = 0;
764 var->transp.offset = 0;
767 var->red.offset = 16;
768 var->green.offset = 8;
769 var->blue.offset = 0;
771 var->green.length = 8;
772 var->blue.length = 8;
773 var->transp.length = 0;
774 var->transp.offset = 0;
777 var->red.offset = 16;
778 var->green.offset = 8;
779 var->blue.offset = 0;
781 var->green.length = 8;
782 var->blue.length = 8;
783 var->transp.length = 8;
784 var->transp.offset = 24;
791 EXPORT_SYMBOL(drm_fb_helper_check_var);
794 * drm_fb_helper_set_par - implementation for ->fb_set_par
795 * @info: fbdev registered by the helper
797 * This will let fbcon do the mode init and is called at initialization time by
798 * the fbdev core when registering the driver, and later on through the hotplug
801 int drm_fb_helper_set_par(struct fb_info *info)
803 struct drm_fb_helper *fb_helper = info->par;
804 struct drm_device *dev = fb_helper->dev;
805 struct fb_var_screeninfo *var = &info->var;
809 if (var->pixclock != 0) {
810 DRM_ERROR("PIXEL CLOCK SET\n");
814 drm_modeset_lock_all(dev);
815 for (i = 0; i < fb_helper->crtc_count; i++) {
816 ret = drm_mode_set_config_internal(&fb_helper->crtc_info[i].mode_set);
818 drm_modeset_unlock_all(dev);
822 drm_modeset_unlock_all(dev);
824 if (fb_helper->delayed_hotplug) {
825 fb_helper->delayed_hotplug = false;
826 drm_fb_helper_hotplug_event(fb_helper);
830 EXPORT_SYMBOL(drm_fb_helper_set_par);
833 * drm_fb_helper_pan_display - implementation for ->fb_pan_display
834 * @var: updated screen information
835 * @info: fbdev registered by the helper
837 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
838 struct fb_info *info)
840 struct drm_fb_helper *fb_helper = info->par;
841 struct drm_device *dev = fb_helper->dev;
842 struct drm_mode_set *modeset;
846 drm_modeset_lock_all(dev);
847 if (!drm_fb_helper_is_bound(fb_helper)) {
848 drm_modeset_unlock_all(dev);
852 for (i = 0; i < fb_helper->crtc_count; i++) {
853 modeset = &fb_helper->crtc_info[i].mode_set;
855 modeset->x = var->xoffset;
856 modeset->y = var->yoffset;
858 if (modeset->num_connectors) {
859 ret = drm_mode_set_config_internal(modeset);
861 info->var.xoffset = var->xoffset;
862 info->var.yoffset = var->yoffset;
866 drm_modeset_unlock_all(dev);
869 EXPORT_SYMBOL(drm_fb_helper_pan_display);
872 * Allocates the backing storage and sets up the fbdev info structure through
873 * the ->fb_probe callback and then registers the fbdev and sets up the panic
876 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
882 struct fb_info *info;
883 struct drm_fb_helper_surface_size sizes;
886 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
887 sizes.surface_depth = 24;
888 sizes.surface_bpp = 32;
889 sizes.fb_width = (unsigned)-1;
890 sizes.fb_height = (unsigned)-1;
892 /* if driver picks 8 or 16 by default use that
893 for both depth/bpp */
894 if (preferred_bpp != sizes.surface_bpp)
895 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
897 /* first up get a count of crtcs now in use and new min/maxes width/heights */
898 for (i = 0; i < fb_helper->connector_count; i++) {
899 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
900 struct drm_cmdline_mode *cmdline_mode;
902 cmdline_mode = &fb_helper_conn->cmdline_mode;
904 if (cmdline_mode->bpp_specified) {
905 switch (cmdline_mode->bpp) {
907 sizes.surface_depth = sizes.surface_bpp = 8;
910 sizes.surface_depth = 15;
911 sizes.surface_bpp = 16;
914 sizes.surface_depth = sizes.surface_bpp = 16;
917 sizes.surface_depth = sizes.surface_bpp = 24;
920 sizes.surface_depth = 24;
921 sizes.surface_bpp = 32;
929 for (i = 0; i < fb_helper->crtc_count; i++) {
930 struct drm_display_mode *desired_mode;
931 desired_mode = fb_helper->crtc_info[i].desired_mode;
935 gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
936 if (desired_mode->hdisplay < sizes.fb_width)
937 sizes.fb_width = desired_mode->hdisplay;
938 if (desired_mode->vdisplay < sizes.fb_height)
939 sizes.fb_height = desired_mode->vdisplay;
940 if (desired_mode->hdisplay > sizes.surface_width)
941 sizes.surface_width = desired_mode->hdisplay;
942 if (desired_mode->vdisplay > sizes.surface_height)
943 sizes.surface_height = desired_mode->vdisplay;
948 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
949 /* hmm everyone went away - assume VGA cable just fell out
950 and will come back later. */
951 DRM_INFO("Cannot find any crtc or sizes - going 1024x768\n");
952 sizes.fb_width = sizes.surface_width = 1024;
953 sizes.fb_height = sizes.surface_height = 768;
956 /* push down into drivers */
957 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
961 info = fb_helper->fbdev;
964 * Set the fb pointer - usually drm_setup_crtcs does this for hotplug
965 * events, but at init time drm_setup_crtcs needs to be called before
966 * the fb is allocated (since we need to figure out the desired size of
967 * the fb before we can allocate it ...). Hence we need to fix things up
970 for (i = 0; i < fb_helper->crtc_count; i++)
971 if (fb_helper->crtc_info[i].mode_set.num_connectors)
972 fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
975 info->var.pixclock = 0;
976 if (register_framebuffer(info) < 0)
979 dev_info(fb_helper->dev->dev, "fb%d: %s frame buffer device\n",
980 info->node, info->fix.id);
982 /* Switch back to kernel console on panic */
983 /* multi card linked list maybe */
984 if (list_empty(&kernel_fb_helper_list)) {
985 dev_info(fb_helper->dev->dev, "registered panic notifier\n");
986 atomic_notifier_chain_register(&panic_notifier_list,
988 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
991 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
997 * drm_fb_helper_fill_fix - initializes fixed fbdev information
998 * @info: fbdev registered by the helper
999 * @pitch: desired pitch
1000 * @depth: desired depth
1002 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1003 * fbdev emulations. Drivers which support acceleration methods which impose
1004 * additional constraints need to set up their own limits.
1006 * Drivers should call this (or their equivalent setup code) from their
1007 * ->fb_probe callback.
1009 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1012 info->fix.type = FB_TYPE_PACKED_PIXELS;
1013 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1014 FB_VISUAL_TRUECOLOR;
1015 info->fix.mmio_start = 0;
1016 info->fix.mmio_len = 0;
1017 info->fix.type_aux = 0;
1018 info->fix.xpanstep = 1; /* doing it in hw */
1019 info->fix.ypanstep = 1; /* doing it in hw */
1020 info->fix.ywrapstep = 0;
1021 info->fix.accel = FB_ACCEL_NONE;
1022 info->fix.type_aux = 0;
1024 info->fix.line_length = pitch;
1027 EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1030 * drm_fb_helper_fill_var - initalizes variable fbdev information
1031 * @info: fbdev instance to set up
1032 * @fb_helper: fb helper instance to use as template
1033 * @fb_width: desired fb width
1034 * @fb_height: desired fb height
1036 * Sets up the variable fbdev metainformation from the given fb helper instance
1037 * and the drm framebuffer allocated in fb_helper->fb.
1039 * Drivers should call this (or their equivalent setup code) from their
1040 * ->fb_probe callback after having allocated the fbdev backing
1041 * storage framebuffer.
1043 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1044 uint32_t fb_width, uint32_t fb_height)
1046 struct drm_framebuffer *fb = fb_helper->fb;
1047 info->pseudo_palette = fb_helper->pseudo_palette;
1048 info->var.xres_virtual = fb->width;
1049 info->var.yres_virtual = fb->height;
1050 info->var.bits_per_pixel = fb->bits_per_pixel;
1051 info->var.accel_flags = FB_ACCELF_TEXT;
1052 info->var.xoffset = 0;
1053 info->var.yoffset = 0;
1054 info->var.activate = FB_ACTIVATE_NOW;
1055 info->var.height = -1;
1056 info->var.width = -1;
1058 switch (fb->depth) {
1060 info->var.red.offset = 0;
1061 info->var.green.offset = 0;
1062 info->var.blue.offset = 0;
1063 info->var.red.length = 8; /* 8bit DAC */
1064 info->var.green.length = 8;
1065 info->var.blue.length = 8;
1066 info->var.transp.offset = 0;
1067 info->var.transp.length = 0;
1070 info->var.red.offset = 10;
1071 info->var.green.offset = 5;
1072 info->var.blue.offset = 0;
1073 info->var.red.length = 5;
1074 info->var.green.length = 5;
1075 info->var.blue.length = 5;
1076 info->var.transp.offset = 15;
1077 info->var.transp.length = 1;
1080 info->var.red.offset = 11;
1081 info->var.green.offset = 5;
1082 info->var.blue.offset = 0;
1083 info->var.red.length = 5;
1084 info->var.green.length = 6;
1085 info->var.blue.length = 5;
1086 info->var.transp.offset = 0;
1089 info->var.red.offset = 16;
1090 info->var.green.offset = 8;
1091 info->var.blue.offset = 0;
1092 info->var.red.length = 8;
1093 info->var.green.length = 8;
1094 info->var.blue.length = 8;
1095 info->var.transp.offset = 0;
1096 info->var.transp.length = 0;
1099 info->var.red.offset = 16;
1100 info->var.green.offset = 8;
1101 info->var.blue.offset = 0;
1102 info->var.red.length = 8;
1103 info->var.green.length = 8;
1104 info->var.blue.length = 8;
1105 info->var.transp.offset = 24;
1106 info->var.transp.length = 8;
1112 info->var.xres = fb_width;
1113 info->var.yres = fb_height;
1115 EXPORT_SYMBOL(drm_fb_helper_fill_var);
1117 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
1121 struct drm_connector *connector;
1125 for (i = 0; i < fb_helper->connector_count; i++) {
1126 connector = fb_helper->connector_info[i]->connector;
1127 count += connector->funcs->fill_modes(connector, maxX, maxY);
1133 static struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
1135 struct drm_display_mode *mode;
1137 list_for_each_entry(mode, &fb_connector->connector->modes, head) {
1138 if (drm_mode_width(mode) > width ||
1139 drm_mode_height(mode) > height)
1141 if (mode->type & DRM_MODE_TYPE_PREFERRED)
1147 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
1149 struct drm_cmdline_mode *cmdline_mode;
1150 cmdline_mode = &fb_connector->cmdline_mode;
1151 return cmdline_mode->specified;
1154 static struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
1155 int width, int height)
1157 struct drm_cmdline_mode *cmdline_mode;
1158 struct drm_display_mode *mode = NULL;
1160 cmdline_mode = &fb_helper_conn->cmdline_mode;
1161 if (cmdline_mode->specified == false)
1164 /* attempt to find a matching mode in the list of modes
1165 * we have gotten so far, if not add a CVT mode that conforms
1167 if (cmdline_mode->rb || cmdline_mode->margins)
1170 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1171 /* check width/height */
1172 if (mode->hdisplay != cmdline_mode->xres ||
1173 mode->vdisplay != cmdline_mode->yres)
1176 if (cmdline_mode->refresh_specified) {
1177 if (mode->vrefresh != cmdline_mode->refresh)
1181 if (cmdline_mode->interlace) {
1182 if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
1189 mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
1191 list_add(&mode->head, &fb_helper_conn->connector->modes);
1195 static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
1200 enable = connector->status == connector_status_connected;
1202 enable = connector->status != connector_status_disconnected;
1207 static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
1210 bool any_enabled = false;
1211 struct drm_connector *connector;
1214 for (i = 0; i < fb_helper->connector_count; i++) {
1215 connector = fb_helper->connector_info[i]->connector;
1216 enabled[i] = drm_connector_enabled(connector, true);
1217 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
1218 enabled[i] ? "yes" : "no");
1219 any_enabled |= enabled[i];
1225 for (i = 0; i < fb_helper->connector_count; i++) {
1226 connector = fb_helper->connector_info[i]->connector;
1227 enabled[i] = drm_connector_enabled(connector, false);
1231 static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
1232 struct drm_display_mode **modes,
1233 bool *enabled, int width, int height)
1236 bool can_clone = false;
1237 struct drm_fb_helper_connector *fb_helper_conn;
1238 struct drm_display_mode *dmt_mode, *mode;
1240 /* only contemplate cloning in the single crtc case */
1241 if (fb_helper->crtc_count > 1)
1245 for (i = 0; i < fb_helper->connector_count; i++) {
1250 /* only contemplate cloning if more than one connector is enabled */
1254 /* check the command line or if nothing common pick 1024x768 */
1256 for (i = 0; i < fb_helper->connector_count; i++) {
1259 fb_helper_conn = fb_helper->connector_info[i];
1260 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1265 for (j = 0; j < i; j++) {
1268 if (!drm_mode_equal(modes[j], modes[i]))
1274 DRM_DEBUG_KMS("can clone using command line\n");
1278 /* try and find a 1024x768 mode on each connector */
1280 dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
1282 for (i = 0; i < fb_helper->connector_count; i++) {
1287 fb_helper_conn = fb_helper->connector_info[i];
1288 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
1289 if (drm_mode_equal(mode, dmt_mode))
1297 DRM_DEBUG_KMS("can clone using 1024x768\n");
1300 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
1304 static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
1305 struct drm_display_mode **modes,
1306 bool *enabled, int width, int height)
1308 struct drm_fb_helper_connector *fb_helper_conn;
1311 for (i = 0; i < fb_helper->connector_count; i++) {
1312 fb_helper_conn = fb_helper->connector_info[i];
1314 if (enabled[i] == false)
1317 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
1318 fb_helper_conn->connector->base.id);
1320 /* got for command line mode first */
1321 modes[i] = drm_pick_cmdline_mode(fb_helper_conn, width, height);
1323 DRM_DEBUG_KMS("looking for preferred mode on connector %d\n",
1324 fb_helper_conn->connector->base.id);
1325 modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
1327 /* No preferred modes, pick one off the list */
1328 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
1329 list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
1332 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
1338 static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
1339 struct drm_fb_helper_crtc **best_crtcs,
1340 struct drm_display_mode **modes,
1341 int n, int width, int height)
1344 struct drm_device *dev = fb_helper->dev;
1345 struct drm_connector *connector;
1346 struct drm_connector_helper_funcs *connector_funcs;
1347 struct drm_encoder *encoder;
1348 int my_score, best_score, score;
1349 struct drm_fb_helper_crtc **crtcs, *crtc;
1350 struct drm_fb_helper_connector *fb_helper_conn;
1352 if (n == fb_helper->connector_count)
1355 fb_helper_conn = fb_helper->connector_info[n];
1356 connector = fb_helper_conn->connector;
1358 best_crtcs[n] = NULL;
1359 best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
1360 if (modes[n] == NULL)
1363 crtcs = kzalloc(dev->mode_config.num_connector *
1364 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
1369 if (connector->status == connector_status_connected)
1371 if (drm_has_cmdline_mode(fb_helper_conn))
1373 if (drm_has_preferred_mode(fb_helper_conn, width, height))
1376 connector_funcs = connector->helper_private;
1377 encoder = connector_funcs->best_encoder(connector);
1381 /* select a crtc for this connector and then attempt to configure
1382 remaining connectors */
1383 for (c = 0; c < fb_helper->crtc_count; c++) {
1384 crtc = &fb_helper->crtc_info[c];
1386 if ((encoder->possible_crtcs & (1 << c)) == 0)
1389 for (o = 0; o < n; o++)
1390 if (best_crtcs[o] == crtc)
1394 /* ignore cloning unless only a single crtc */
1395 if (fb_helper->crtc_count > 1)
1398 if (!drm_mode_equal(modes[o], modes[n]))
1403 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
1404 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
1406 if (score > best_score) {
1408 memcpy(best_crtcs, crtcs,
1409 dev->mode_config.num_connector *
1410 sizeof(struct drm_fb_helper_crtc *));
1418 static void drm_setup_crtcs(struct drm_fb_helper *fb_helper)
1420 struct drm_device *dev = fb_helper->dev;
1421 struct drm_fb_helper_crtc **crtcs;
1422 struct drm_display_mode **modes;
1423 struct drm_mode_set *modeset;
1428 DRM_DEBUG_KMS("\n");
1430 width = dev->mode_config.max_width;
1431 height = dev->mode_config.max_height;
1433 crtcs = kcalloc(dev->mode_config.num_connector,
1434 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
1435 modes = kcalloc(dev->mode_config.num_connector,
1436 sizeof(struct drm_display_mode *), GFP_KERNEL);
1437 enabled = kcalloc(dev->mode_config.num_connector,
1438 sizeof(bool), GFP_KERNEL);
1439 if (!crtcs || !modes || !enabled) {
1440 DRM_ERROR("Memory allocation failed\n");
1445 drm_enable_connectors(fb_helper, enabled);
1447 if (!(fb_helper->funcs->initial_config &&
1448 fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
1449 enabled, width, height))) {
1450 memset(modes, 0, dev->mode_config.num_connector*sizeof(modes[0]));
1451 memset(crtcs, 0, dev->mode_config.num_connector*sizeof(crtcs[0]));
1453 if (!drm_target_cloned(fb_helper,
1454 modes, enabled, width, height) &&
1455 !drm_target_preferred(fb_helper,
1456 modes, enabled, width, height))
1457 DRM_ERROR("Unable to find initial modes\n");
1459 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
1462 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
1465 /* need to set the modesets up here for use later */
1466 /* fill out the connector<->crtc mappings into the modesets */
1467 for (i = 0; i < fb_helper->crtc_count; i++) {
1468 modeset = &fb_helper->crtc_info[i].mode_set;
1469 modeset->num_connectors = 0;
1473 for (i = 0; i < fb_helper->connector_count; i++) {
1474 struct drm_display_mode *mode = modes[i];
1475 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
1476 modeset = &fb_crtc->mode_set;
1478 if (mode && fb_crtc) {
1479 DRM_DEBUG_KMS("desired mode %s set on crtc %d\n",
1480 mode->name, fb_crtc->mode_set.crtc->base.id);
1481 fb_crtc->desired_mode = mode;
1483 drm_mode_destroy(dev, modeset->mode);
1484 modeset->mode = drm_mode_duplicate(dev,
1485 fb_crtc->desired_mode);
1486 modeset->connectors[modeset->num_connectors++] = fb_helper->connector_info[i]->connector;
1487 modeset->fb = fb_helper->fb;
1491 /* Clear out any old modes if there are no more connected outputs. */
1492 for (i = 0; i < fb_helper->crtc_count; i++) {
1493 modeset = &fb_helper->crtc_info[i].mode_set;
1494 if (modeset->num_connectors == 0) {
1495 BUG_ON(modeset->fb);
1496 BUG_ON(modeset->num_connectors);
1498 drm_mode_destroy(dev, modeset->mode);
1499 modeset->mode = NULL;
1509 * drm_fb_helper_initial_config - setup a sane initial connector configuration
1510 * @fb_helper: fb_helper device struct
1511 * @bpp_sel: bpp value to use for the framebuffer configuration
1513 * Scans the CRTCs and connectors and tries to put together an initial setup.
1514 * At the moment, this is a cloned configuration across all heads with
1515 * a new framebuffer object as the backing store.
1517 * Note that this also registers the fbdev and so allows userspace to call into
1518 * the driver through the fbdev interfaces.
1520 * This function will call down into the ->fb_probe callback to let
1521 * the driver allocate and initialize the fbdev info structure and the drm
1522 * framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
1523 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
1524 * values for the fbdev info structure.
1527 * Zero if everything went ok, nonzero otherwise.
1529 bool drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
1531 struct drm_device *dev = fb_helper->dev;
1534 drm_fb_helper_parse_command_line(fb_helper);
1536 count = drm_fb_helper_probe_connector_modes(fb_helper,
1537 dev->mode_config.max_width,
1538 dev->mode_config.max_height);
1540 * we shouldn't end up with no modes here.
1543 dev_info(fb_helper->dev->dev, "No connectors reported connected with modes\n");
1545 drm_setup_crtcs(fb_helper);
1547 return drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
1549 EXPORT_SYMBOL(drm_fb_helper_initial_config);
1552 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
1553 * probing all the outputs attached to the fb
1554 * @fb_helper: the drm_fb_helper
1556 * Scan the connectors attached to the fb_helper and try to put together a
1557 * setup after *notification of a change in output configuration.
1559 * Called at runtime, takes the mode config locks to be able to check/change the
1560 * modeset configuration. Must be run from process context (which usually means
1561 * either the output polling work or a work item launched from the driver's
1562 * hotplug interrupt).
1564 * Note that the driver must ensure that this is only called _after_ the fb has
1565 * been fully set up, i.e. after the call to drm_fb_helper_initial_config.
1568 * 0 on success and a non-zero error code otherwise.
1570 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
1572 struct drm_device *dev = fb_helper->dev;
1573 u32 max_width, max_height;
1578 mutex_lock(&fb_helper->dev->mode_config.mutex);
1579 if (!drm_fb_helper_is_bound(fb_helper)) {
1580 fb_helper->delayed_hotplug = true;
1581 mutex_unlock(&fb_helper->dev->mode_config.mutex);
1584 DRM_DEBUG_KMS("\n");
1586 max_width = fb_helper->fb->width;
1587 max_height = fb_helper->fb->height;
1589 drm_fb_helper_probe_connector_modes(fb_helper, max_width, max_height);
1590 mutex_unlock(&fb_helper->dev->mode_config.mutex);
1592 drm_modeset_lock_all(dev);
1593 drm_setup_crtcs(fb_helper);
1594 drm_modeset_unlock_all(dev);
1595 drm_fb_helper_set_par(fb_helper->fbdev);
1599 EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
1601 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
1602 * but the module doesn't depend on any fb console symbols. At least
1603 * attempt to load fbcon to avoid leaving the system without a usable console.
1605 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
1606 static int __init drm_fb_helper_modinit(void)
1608 const char *name = "fbcon";
1609 struct module *fbcon;
1611 mutex_lock(&module_mutex);
1612 fbcon = find_module(name);
1613 mutex_unlock(&module_mutex);
1616 request_module_nowait(name);
1620 module_init(drm_fb_helper_modinit);