2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
6 * DRM framebuffer helper functions
8 * Permission to use, copy, modify, distribute, and sell this software and its
9 * documentation for any purpose is hereby granted without fee, provided that
10 * the above copyright notice appear in all copies and that both that copyright
11 * notice and this permission notice appear in supporting documentation, and
12 * that the name of the copyright holders not be used in advertising or
13 * publicity pertaining to distribution of the software without specific,
14 * written prior permission. The copyright holders make no representations
15 * about the suitability of this software for any purpose. It is provided "as
16 * is" without express or implied warranty.
18 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
27 * Dave Airlie <airlied@linux.ie>
28 * Jesse Barnes <jesse.barnes@intel.com>
30 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32 #include <linux/console.h>
33 #include <linux/dma-buf.h>
34 #include <linux/kernel.h>
35 #include <linux/sysrq.h>
36 #include <linux/slab.h>
37 #include <linux/module.h>
39 #include <drm/drm_crtc.h>
40 #include <drm/drm_fb_helper.h>
41 #include <drm/drm_crtc_helper.h>
42 #include <drm/drm_atomic.h>
43 #include <drm/drm_atomic_helper.h>
45 #include "drm_crtc_internal.h"
46 #include "drm_crtc_helper_internal.h"
48 static bool drm_fbdev_emulation
= true;
49 module_param_named(fbdev_emulation
, drm_fbdev_emulation
, bool, 0600);
50 MODULE_PARM_DESC(fbdev_emulation
,
51 "Enable legacy fbdev emulation [default=true]");
53 static int drm_fbdev_overalloc
= CONFIG_DRM_FBDEV_OVERALLOC
;
54 module_param(drm_fbdev_overalloc
, int, 0444);
55 MODULE_PARM_DESC(drm_fbdev_overalloc
,
56 "Overallocation of the fbdev buffer (%) [default="
57 __MODULE_STRING(CONFIG_DRM_FBDEV_OVERALLOC
) "]");
60 * In order to keep user-space compatibility, we want in certain use-cases
61 * to keep leaking the fbdev physical address to the user-space program
62 * handling the fbdev buffer.
63 * This is a bad habit essentially kept into closed source opengl driver
64 * that should really be moved into open-source upstream projects instead
65 * of using legacy physical addresses in user space to communicate with
66 * other out-of-tree kernel modules.
68 * This module_param *should* be removed as soon as possible and be
69 * considered as a broken and legacy behaviour from a modern fbdev device.
71 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
72 static bool drm_leak_fbdev_smem
= false;
73 module_param_unsafe(drm_leak_fbdev_smem
, bool, 0600);
74 MODULE_PARM_DESC(drm_leak_fbdev_smem
,
75 "Allow unsafe leaking fbdev physical smem address [default=false]");
78 static LIST_HEAD(kernel_fb_helper_list
);
79 static DEFINE_MUTEX(kernel_fb_helper_lock
);
84 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
85 * mode setting driver. They can be used mostly independently from the crtc
86 * helper functions used by many drivers to implement the kernel mode setting
89 * Drivers that support a dumb buffer with a virtual address and mmap support,
90 * should try out the generic fbdev emulation using drm_fbdev_generic_setup().
92 * Setup fbdev emulation by calling drm_fb_helper_fbdev_setup() and tear it
93 * down by calling drm_fb_helper_fbdev_teardown().
95 * Drivers that need to handle connector hotplugging (e.g. dp mst) can't use
96 * the setup helper and will need to do the whole four-step setup process with
97 * drm_fb_helper_prepare(), drm_fb_helper_init(),
98 * drm_fb_helper_single_add_all_connectors(), enable hotplugging and
99 * drm_fb_helper_initial_config() to avoid a possible race window.
101 * At runtime drivers should restore the fbdev console by using
102 * drm_fb_helper_lastclose() as their &drm_driver.lastclose callback.
103 * They should also notify the fb helper code from updates to the output
104 * configuration by using drm_fb_helper_output_poll_changed() as their
105 * &drm_mode_config_funcs.output_poll_changed callback.
107 * For suspend/resume consider using drm_mode_config_helper_suspend() and
108 * drm_mode_config_helper_resume() which takes care of fbdev as well.
110 * All other functions exported by the fb helper library can be used to
111 * implement the fbdev driver interface by the driver.
113 * It is possible, though perhaps somewhat tricky, to implement race-free
114 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
115 * helper must be called first to initialize the minimum required to make
116 * hotplug detection work. Drivers also need to make sure to properly set up
117 * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init()
118 * it is safe to enable interrupts and start processing hotplug events. At the
119 * same time, drivers should initialize all modeset objects such as CRTCs,
120 * encoders and connectors. To finish up the fbdev helper initialization, the
121 * drm_fb_helper_init() function is called. To probe for all attached displays
122 * and set up an initial configuration using the detected hardware, drivers
123 * should call drm_fb_helper_single_add_all_connectors() followed by
124 * drm_fb_helper_initial_config().
126 * If &drm_framebuffer_funcs.dirty is set, the
127 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
128 * accumulate changes and schedule &drm_fb_helper.dirty_work to run right
129 * away. This worker then calls the dirty() function ensuring that it will
130 * always run in process context since the fb_*() function could be running in
131 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
132 * callback it will also schedule dirty_work with the damage collected from the
133 * mmap page writes. Drivers can use drm_fb_helper_defio_init() to setup
134 * deferred I/O (coupled with drm_fb_helper_fbdev_teardown()).
137 #define drm_fb_helper_for_each_connector(fbh, i__) \
138 for (({ lockdep_assert_held(&(fbh)->lock); }), \
139 i__ = 0; i__ < (fbh)->connector_count; i__++)
141 static int __drm_fb_helper_add_one_connector(struct drm_fb_helper
*fb_helper
,
142 struct drm_connector
*connector
)
144 struct drm_fb_helper_connector
*fb_conn
;
145 struct drm_fb_helper_connector
**temp
;
148 if (!drm_fbdev_emulation
)
151 lockdep_assert_held(&fb_helper
->lock
);
153 count
= fb_helper
->connector_count
+ 1;
155 if (count
> fb_helper
->connector_info_alloc_count
) {
156 size_t size
= count
* sizeof(fb_conn
);
158 temp
= krealloc(fb_helper
->connector_info
, size
, GFP_KERNEL
);
162 fb_helper
->connector_info_alloc_count
= count
;
163 fb_helper
->connector_info
= temp
;
166 fb_conn
= kzalloc(sizeof(*fb_conn
), GFP_KERNEL
);
170 drm_connector_get(connector
);
171 fb_conn
->connector
= connector
;
172 fb_helper
->connector_info
[fb_helper
->connector_count
++] = fb_conn
;
177 int drm_fb_helper_add_one_connector(struct drm_fb_helper
*fb_helper
,
178 struct drm_connector
*connector
)
185 mutex_lock(&fb_helper
->lock
);
186 err
= __drm_fb_helper_add_one_connector(fb_helper
, connector
);
187 mutex_unlock(&fb_helper
->lock
);
191 EXPORT_SYMBOL(drm_fb_helper_add_one_connector
);
194 * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
196 * @fb_helper: fbdev initialized with drm_fb_helper_init, can be NULL
198 * This functions adds all the available connectors for use with the given
199 * fb_helper. This is a separate step to allow drivers to freely assign
200 * connectors to the fbdev, e.g. if some are reserved for special purposes or
201 * not adequate to be used for the fbcon.
203 * This function is protected against concurrent connector hotadds/removals
204 * using drm_fb_helper_add_one_connector() and
205 * drm_fb_helper_remove_one_connector().
207 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper
*fb_helper
)
209 struct drm_device
*dev
;
210 struct drm_connector
*connector
;
211 struct drm_connector_list_iter conn_iter
;
214 if (!drm_fbdev_emulation
|| !fb_helper
)
217 dev
= fb_helper
->dev
;
219 mutex_lock(&fb_helper
->lock
);
220 drm_connector_list_iter_begin(dev
, &conn_iter
);
221 drm_for_each_connector_iter(connector
, &conn_iter
) {
222 if (connector
->connector_type
== DRM_MODE_CONNECTOR_WRITEBACK
)
225 ret
= __drm_fb_helper_add_one_connector(fb_helper
, connector
);
232 drm_fb_helper_for_each_connector(fb_helper
, i
) {
233 struct drm_fb_helper_connector
*fb_helper_connector
=
234 fb_helper
->connector_info
[i
];
236 drm_connector_put(fb_helper_connector
->connector
);
238 kfree(fb_helper_connector
);
239 fb_helper
->connector_info
[i
] = NULL
;
241 fb_helper
->connector_count
= 0;
243 drm_connector_list_iter_end(&conn_iter
);
244 mutex_unlock(&fb_helper
->lock
);
248 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors
);
250 static int __drm_fb_helper_remove_one_connector(struct drm_fb_helper
*fb_helper
,
251 struct drm_connector
*connector
)
253 struct drm_fb_helper_connector
*fb_helper_connector
;
256 if (!drm_fbdev_emulation
)
259 lockdep_assert_held(&fb_helper
->lock
);
261 drm_fb_helper_for_each_connector(fb_helper
, i
) {
262 if (fb_helper
->connector_info
[i
]->connector
== connector
)
266 if (i
== fb_helper
->connector_count
)
268 fb_helper_connector
= fb_helper
->connector_info
[i
];
269 drm_connector_put(fb_helper_connector
->connector
);
271 for (j
= i
+ 1; j
< fb_helper
->connector_count
; j
++)
272 fb_helper
->connector_info
[j
- 1] = fb_helper
->connector_info
[j
];
274 fb_helper
->connector_count
--;
275 kfree(fb_helper_connector
);
280 int drm_fb_helper_remove_one_connector(struct drm_fb_helper
*fb_helper
,
281 struct drm_connector
*connector
)
288 mutex_lock(&fb_helper
->lock
);
289 err
= __drm_fb_helper_remove_one_connector(fb_helper
, connector
);
290 mutex_unlock(&fb_helper
->lock
);
294 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector
);
296 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc
*crtc
)
298 uint16_t *r_base
, *g_base
, *b_base
;
300 if (crtc
->funcs
->gamma_set
== NULL
)
303 r_base
= crtc
->gamma_store
;
304 g_base
= r_base
+ crtc
->gamma_size
;
305 b_base
= g_base
+ crtc
->gamma_size
;
307 crtc
->funcs
->gamma_set(crtc
, r_base
, g_base
, b_base
,
308 crtc
->gamma_size
, NULL
);
312 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
313 * @info: fbdev registered by the helper
315 int drm_fb_helper_debug_enter(struct fb_info
*info
)
317 struct drm_fb_helper
*helper
= info
->par
;
318 const struct drm_crtc_helper_funcs
*funcs
;
321 list_for_each_entry(helper
, &kernel_fb_helper_list
, kernel_fb_list
) {
322 for (i
= 0; i
< helper
->crtc_count
; i
++) {
323 struct drm_mode_set
*mode_set
=
324 &helper
->crtc_info
[i
].mode_set
;
326 if (!mode_set
->crtc
->enabled
)
329 funcs
= mode_set
->crtc
->helper_private
;
330 if (funcs
->mode_set_base_atomic
== NULL
)
333 if (drm_drv_uses_atomic_modeset(mode_set
->crtc
->dev
))
336 funcs
->mode_set_base_atomic(mode_set
->crtc
,
340 ENTER_ATOMIC_MODE_SET
);
346 EXPORT_SYMBOL(drm_fb_helper_debug_enter
);
349 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
350 * @info: fbdev registered by the helper
352 int drm_fb_helper_debug_leave(struct fb_info
*info
)
354 struct drm_fb_helper
*helper
= info
->par
;
355 struct drm_crtc
*crtc
;
356 const struct drm_crtc_helper_funcs
*funcs
;
357 struct drm_framebuffer
*fb
;
360 for (i
= 0; i
< helper
->crtc_count
; i
++) {
361 struct drm_mode_set
*mode_set
= &helper
->crtc_info
[i
].mode_set
;
363 crtc
= mode_set
->crtc
;
364 if (drm_drv_uses_atomic_modeset(crtc
->dev
))
367 funcs
= crtc
->helper_private
;
368 fb
= crtc
->primary
->fb
;
374 DRM_ERROR("no fb to restore??\n");
378 if (funcs
->mode_set_base_atomic
== NULL
)
381 drm_fb_helper_restore_lut_atomic(mode_set
->crtc
);
382 funcs
->mode_set_base_atomic(mode_set
->crtc
, fb
, crtc
->x
,
383 crtc
->y
, LEAVE_ATOMIC_MODE_SET
);
388 EXPORT_SYMBOL(drm_fb_helper_debug_leave
);
390 static int restore_fbdev_mode_atomic(struct drm_fb_helper
*fb_helper
, bool active
)
392 struct drm_device
*dev
= fb_helper
->dev
;
393 struct drm_plane_state
*plane_state
;
394 struct drm_plane
*plane
;
395 struct drm_atomic_state
*state
;
397 struct drm_modeset_acquire_ctx ctx
;
399 drm_modeset_acquire_init(&ctx
, 0);
401 state
= drm_atomic_state_alloc(dev
);
407 state
->acquire_ctx
= &ctx
;
409 drm_for_each_plane(plane
, dev
) {
410 plane_state
= drm_atomic_get_plane_state(state
, plane
);
411 if (IS_ERR(plane_state
)) {
412 ret
= PTR_ERR(plane_state
);
416 plane_state
->rotation
= DRM_MODE_ROTATE_0
;
418 /* disable non-primary: */
419 if (plane
->type
== DRM_PLANE_TYPE_PRIMARY
)
422 ret
= __drm_atomic_helper_disable_plane(plane
, plane_state
);
427 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
428 struct drm_mode_set
*mode_set
= &fb_helper
->crtc_info
[i
].mode_set
;
429 struct drm_plane
*primary
= mode_set
->crtc
->primary
;
431 /* Cannot fail as we've already gotten the plane state above */
432 plane_state
= drm_atomic_get_new_plane_state(state
, primary
);
433 plane_state
->rotation
= fb_helper
->crtc_info
[i
].rotation
;
435 ret
= __drm_atomic_helper_set_config(mode_set
, state
);
440 * __drm_atomic_helper_set_config() sets active when a
441 * mode is set, unconditionally clear it if we force DPMS off
444 struct drm_crtc
*crtc
= mode_set
->crtc
;
445 struct drm_crtc_state
*crtc_state
= drm_atomic_get_new_crtc_state(state
, crtc
);
447 crtc_state
->active
= false;
451 ret
= drm_atomic_commit(state
);
457 drm_atomic_state_put(state
);
459 drm_modeset_drop_locks(&ctx
);
460 drm_modeset_acquire_fini(&ctx
);
465 drm_atomic_state_clear(state
);
466 drm_modeset_backoff(&ctx
);
471 static int restore_fbdev_mode_legacy(struct drm_fb_helper
*fb_helper
)
473 struct drm_device
*dev
= fb_helper
->dev
;
474 struct drm_plane
*plane
;
477 drm_modeset_lock_all(fb_helper
->dev
);
478 drm_for_each_plane(plane
, dev
) {
479 if (plane
->type
!= DRM_PLANE_TYPE_PRIMARY
)
480 drm_plane_force_disable(plane
);
482 if (plane
->rotation_property
)
483 drm_mode_plane_set_obj_prop(plane
,
484 plane
->rotation_property
,
488 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
489 struct drm_mode_set
*mode_set
= &fb_helper
->crtc_info
[i
].mode_set
;
490 struct drm_crtc
*crtc
= mode_set
->crtc
;
492 if (crtc
->funcs
->cursor_set2
) {
493 ret
= crtc
->funcs
->cursor_set2(crtc
, NULL
, 0, 0, 0, 0, 0);
496 } else if (crtc
->funcs
->cursor_set
) {
497 ret
= crtc
->funcs
->cursor_set(crtc
, NULL
, 0, 0, 0);
502 ret
= drm_mode_set_config_internal(mode_set
);
507 drm_modeset_unlock_all(fb_helper
->dev
);
512 static int restore_fbdev_mode(struct drm_fb_helper
*fb_helper
)
514 struct drm_device
*dev
= fb_helper
->dev
;
516 if (drm_drv_uses_atomic_modeset(dev
))
517 return restore_fbdev_mode_atomic(fb_helper
, true);
519 return restore_fbdev_mode_legacy(fb_helper
);
523 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
524 * @fb_helper: driver-allocated fbdev helper, can be NULL
526 * This should be called from driver's drm &drm_driver.lastclose callback
527 * when implementing an fbcon on top of kms using this helper. This ensures that
528 * the user isn't greeted with a black screen when e.g. X dies.
531 * Zero if everything went ok, negative error code otherwise.
533 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper
*fb_helper
)
538 if (!drm_fbdev_emulation
|| !fb_helper
)
541 if (READ_ONCE(fb_helper
->deferred_setup
))
544 mutex_lock(&fb_helper
->lock
);
545 ret
= restore_fbdev_mode(fb_helper
);
547 do_delayed
= fb_helper
->delayed_hotplug
;
549 fb_helper
->delayed_hotplug
= false;
550 mutex_unlock(&fb_helper
->lock
);
553 drm_fb_helper_hotplug_event(fb_helper
);
557 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked
);
559 static bool drm_fb_helper_is_bound(struct drm_fb_helper
*fb_helper
)
561 struct drm_device
*dev
= fb_helper
->dev
;
562 struct drm_crtc
*crtc
;
563 int bound
= 0, crtcs_bound
= 0;
566 * Sometimes user space wants everything disabled, so don't steal the
567 * display if there's a master.
569 if (READ_ONCE(dev
->master
))
572 drm_for_each_crtc(crtc
, dev
) {
573 drm_modeset_lock(&crtc
->mutex
, NULL
);
574 if (crtc
->primary
->fb
)
576 if (crtc
->primary
->fb
== fb_helper
->fb
)
578 drm_modeset_unlock(&crtc
->mutex
);
581 if (bound
< crtcs_bound
)
587 #ifdef CONFIG_MAGIC_SYSRQ
589 * restore fbcon display for all kms driver's using this helper, used for sysrq
590 * and panic handling.
592 static bool drm_fb_helper_force_kernel_mode(void)
594 bool ret
, error
= false;
595 struct drm_fb_helper
*helper
;
597 if (list_empty(&kernel_fb_helper_list
))
600 list_for_each_entry(helper
, &kernel_fb_helper_list
, kernel_fb_list
) {
601 struct drm_device
*dev
= helper
->dev
;
603 if (dev
->switch_power_state
== DRM_SWITCH_POWER_OFF
)
606 mutex_lock(&helper
->lock
);
607 ret
= restore_fbdev_mode(helper
);
610 mutex_unlock(&helper
->lock
);
615 static void drm_fb_helper_restore_work_fn(struct work_struct
*ignored
)
619 ret
= drm_fb_helper_force_kernel_mode();
621 DRM_ERROR("Failed to restore crtc configuration\n");
623 static DECLARE_WORK(drm_fb_helper_restore_work
, drm_fb_helper_restore_work_fn
);
625 static void drm_fb_helper_sysrq(int dummy1
)
627 schedule_work(&drm_fb_helper_restore_work
);
630 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op
= {
631 .handler
= drm_fb_helper_sysrq
,
632 .help_msg
= "force-fb(V)",
633 .action_msg
= "Restore framebuffer console",
636 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op
= { };
639 static void dpms_legacy(struct drm_fb_helper
*fb_helper
, int dpms_mode
)
641 struct drm_device
*dev
= fb_helper
->dev
;
642 struct drm_crtc
*crtc
;
643 struct drm_connector
*connector
;
646 drm_modeset_lock_all(dev
);
647 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
648 crtc
= fb_helper
->crtc_info
[i
].mode_set
.crtc
;
653 /* Walk the connectors & encoders on this fb turning them on/off */
654 drm_fb_helper_for_each_connector(fb_helper
, j
) {
655 connector
= fb_helper
->connector_info
[j
]->connector
;
656 connector
->funcs
->dpms(connector
, dpms_mode
);
657 drm_object_property_set_value(&connector
->base
,
658 dev
->mode_config
.dpms_property
, dpms_mode
);
661 drm_modeset_unlock_all(dev
);
664 static void drm_fb_helper_dpms(struct fb_info
*info
, int dpms_mode
)
666 struct drm_fb_helper
*fb_helper
= info
->par
;
669 * For each CRTC in this fb, turn the connectors on/off.
671 mutex_lock(&fb_helper
->lock
);
672 if (!drm_fb_helper_is_bound(fb_helper
)) {
673 mutex_unlock(&fb_helper
->lock
);
677 if (drm_drv_uses_atomic_modeset(fb_helper
->dev
))
678 restore_fbdev_mode_atomic(fb_helper
, dpms_mode
== DRM_MODE_DPMS_ON
);
680 dpms_legacy(fb_helper
, dpms_mode
);
681 mutex_unlock(&fb_helper
->lock
);
685 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
686 * @blank: desired blanking state
687 * @info: fbdev registered by the helper
689 int drm_fb_helper_blank(int blank
, struct fb_info
*info
)
691 if (oops_in_progress
)
695 /* Display: On; HSync: On, VSync: On */
696 case FB_BLANK_UNBLANK
:
697 drm_fb_helper_dpms(info
, DRM_MODE_DPMS_ON
);
699 /* Display: Off; HSync: On, VSync: On */
700 case FB_BLANK_NORMAL
:
701 drm_fb_helper_dpms(info
, DRM_MODE_DPMS_STANDBY
);
703 /* Display: Off; HSync: Off, VSync: On */
704 case FB_BLANK_HSYNC_SUSPEND
:
705 drm_fb_helper_dpms(info
, DRM_MODE_DPMS_STANDBY
);
707 /* Display: Off; HSync: On, VSync: Off */
708 case FB_BLANK_VSYNC_SUSPEND
:
709 drm_fb_helper_dpms(info
, DRM_MODE_DPMS_SUSPEND
);
711 /* Display: Off; HSync: Off, VSync: Off */
712 case FB_BLANK_POWERDOWN
:
713 drm_fb_helper_dpms(info
, DRM_MODE_DPMS_OFF
);
718 EXPORT_SYMBOL(drm_fb_helper_blank
);
720 static void drm_fb_helper_modeset_release(struct drm_fb_helper
*helper
,
721 struct drm_mode_set
*modeset
)
725 for (i
= 0; i
< modeset
->num_connectors
; i
++) {
726 drm_connector_put(modeset
->connectors
[i
]);
727 modeset
->connectors
[i
] = NULL
;
729 modeset
->num_connectors
= 0;
731 drm_mode_destroy(helper
->dev
, modeset
->mode
);
732 modeset
->mode
= NULL
;
734 /* FIXME should hold a ref? */
738 static void drm_fb_helper_crtc_free(struct drm_fb_helper
*helper
)
742 for (i
= 0; i
< helper
->connector_count
; i
++) {
743 drm_connector_put(helper
->connector_info
[i
]->connector
);
744 kfree(helper
->connector_info
[i
]);
746 kfree(helper
->connector_info
);
748 for (i
= 0; i
< helper
->crtc_count
; i
++) {
749 struct drm_mode_set
*modeset
= &helper
->crtc_info
[i
].mode_set
;
751 drm_fb_helper_modeset_release(helper
, modeset
);
752 kfree(modeset
->connectors
);
754 kfree(helper
->crtc_info
);
757 static void drm_fb_helper_resume_worker(struct work_struct
*work
)
759 struct drm_fb_helper
*helper
= container_of(work
, struct drm_fb_helper
,
763 fb_set_suspend(helper
->fbdev
, 0);
767 static void drm_fb_helper_dirty_blit_real(struct drm_fb_helper
*fb_helper
,
768 struct drm_clip_rect
*clip
)
770 struct drm_framebuffer
*fb
= fb_helper
->fb
;
771 unsigned int cpp
= drm_format_plane_cpp(fb
->format
->format
, 0);
772 size_t offset
= clip
->y1
* fb
->pitches
[0] + clip
->x1
* cpp
;
773 void *src
= fb_helper
->fbdev
->screen_buffer
+ offset
;
774 void *dst
= fb_helper
->buffer
->vaddr
+ offset
;
775 size_t len
= (clip
->x2
- clip
->x1
) * cpp
;
778 for (y
= clip
->y1
; y
< clip
->y2
; y
++) {
779 memcpy(dst
, src
, len
);
780 src
+= fb
->pitches
[0];
781 dst
+= fb
->pitches
[0];
785 static void drm_fb_helper_dirty_work(struct work_struct
*work
)
787 struct drm_fb_helper
*helper
= container_of(work
, struct drm_fb_helper
,
789 struct drm_clip_rect
*clip
= &helper
->dirty_clip
;
790 struct drm_clip_rect clip_copy
;
793 spin_lock_irqsave(&helper
->dirty_lock
, flags
);
795 clip
->x1
= clip
->y1
= ~0;
796 clip
->x2
= clip
->y2
= 0;
797 spin_unlock_irqrestore(&helper
->dirty_lock
, flags
);
799 /* call dirty callback only when it has been really touched */
800 if (clip_copy
.x1
< clip_copy
.x2
&& clip_copy
.y1
< clip_copy
.y2
) {
801 /* Generic fbdev uses a shadow buffer */
803 drm_fb_helper_dirty_blit_real(helper
, &clip_copy
);
804 helper
->fb
->funcs
->dirty(helper
->fb
, NULL
, 0, 0, &clip_copy
, 1);
809 * drm_fb_helper_prepare - setup a drm_fb_helper structure
811 * @helper: driver-allocated fbdev helper structure to set up
812 * @funcs: pointer to structure of functions associate with this helper
814 * Sets up the bare minimum to make the framebuffer helper usable. This is
815 * useful to implement race-free initialization of the polling helpers.
817 void drm_fb_helper_prepare(struct drm_device
*dev
, struct drm_fb_helper
*helper
,
818 const struct drm_fb_helper_funcs
*funcs
)
820 INIT_LIST_HEAD(&helper
->kernel_fb_list
);
821 spin_lock_init(&helper
->dirty_lock
);
822 INIT_WORK(&helper
->resume_work
, drm_fb_helper_resume_worker
);
823 INIT_WORK(&helper
->dirty_work
, drm_fb_helper_dirty_work
);
824 helper
->dirty_clip
.x1
= helper
->dirty_clip
.y1
= ~0;
825 mutex_init(&helper
->lock
);
826 helper
->funcs
= funcs
;
829 EXPORT_SYMBOL(drm_fb_helper_prepare
);
832 * drm_fb_helper_init - initialize a &struct drm_fb_helper
834 * @fb_helper: driver-allocated fbdev helper structure to initialize
835 * @max_conn_count: max connector count
837 * This allocates the structures for the fbdev helper with the given limits.
838 * Note that this won't yet touch the hardware (through the driver interfaces)
839 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
840 * to allow driver writes more control over the exact init sequence.
842 * Drivers must call drm_fb_helper_prepare() before calling this function.
845 * Zero if everything went ok, nonzero otherwise.
847 int drm_fb_helper_init(struct drm_device
*dev
,
848 struct drm_fb_helper
*fb_helper
,
851 struct drm_crtc
*crtc
;
852 struct drm_mode_config
*config
= &dev
->mode_config
;
855 if (!drm_fbdev_emulation
) {
856 dev
->fb_helper
= fb_helper
;
863 fb_helper
->crtc_info
= kcalloc(config
->num_crtc
, sizeof(struct drm_fb_helper_crtc
), GFP_KERNEL
);
864 if (!fb_helper
->crtc_info
)
867 fb_helper
->crtc_count
= config
->num_crtc
;
868 fb_helper
->connector_info
= kcalloc(dev
->mode_config
.num_connector
, sizeof(struct drm_fb_helper_connector
*), GFP_KERNEL
);
869 if (!fb_helper
->connector_info
) {
870 kfree(fb_helper
->crtc_info
);
873 fb_helper
->connector_info_alloc_count
= dev
->mode_config
.num_connector
;
874 fb_helper
->connector_count
= 0;
876 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
877 fb_helper
->crtc_info
[i
].mode_set
.connectors
=
878 kcalloc(max_conn_count
,
879 sizeof(struct drm_connector
*),
882 if (!fb_helper
->crtc_info
[i
].mode_set
.connectors
)
884 fb_helper
->crtc_info
[i
].mode_set
.num_connectors
= 0;
885 fb_helper
->crtc_info
[i
].rotation
= DRM_MODE_ROTATE_0
;
889 drm_for_each_crtc(crtc
, dev
) {
890 fb_helper
->crtc_info
[i
].mode_set
.crtc
= crtc
;
894 dev
->fb_helper
= fb_helper
;
898 drm_fb_helper_crtc_free(fb_helper
);
901 EXPORT_SYMBOL(drm_fb_helper_init
);
904 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
905 * @fb_helper: driver-allocated fbdev helper
907 * A helper to alloc fb_info and the members cmap and apertures. Called
908 * by the driver within the fb_probe fb_helper callback function. Drivers do not
909 * need to release the allocated fb_info structure themselves, this is
910 * automatically done when calling drm_fb_helper_fini().
913 * fb_info pointer if things went okay, pointer containing error code
916 struct fb_info
*drm_fb_helper_alloc_fbi(struct drm_fb_helper
*fb_helper
)
918 struct device
*dev
= fb_helper
->dev
->dev
;
919 struct fb_info
*info
;
922 info
= framebuffer_alloc(0, dev
);
924 return ERR_PTR(-ENOMEM
);
926 ret
= fb_alloc_cmap(&info
->cmap
, 256, 0);
930 info
->apertures
= alloc_apertures(1);
931 if (!info
->apertures
) {
936 fb_helper
->fbdev
= info
;
937 info
->skip_vt_switch
= true;
942 fb_dealloc_cmap(&info
->cmap
);
944 framebuffer_release(info
);
947 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi
);
950 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
951 * @fb_helper: driver-allocated fbdev helper, can be NULL
953 * A wrapper around unregister_framebuffer, to release the fb_info
954 * framebuffer device. This must be called before releasing all resources for
955 * @fb_helper by calling drm_fb_helper_fini().
957 void drm_fb_helper_unregister_fbi(struct drm_fb_helper
*fb_helper
)
959 if (fb_helper
&& fb_helper
->fbdev
)
960 unregister_framebuffer(fb_helper
->fbdev
);
962 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi
);
965 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
966 * @fb_helper: driver-allocated fbdev helper, can be NULL
968 * This cleans up all remaining resources associated with @fb_helper. Must be
969 * called after drm_fb_helper_unlink_fbi() was called.
971 void drm_fb_helper_fini(struct drm_fb_helper
*fb_helper
)
973 struct fb_info
*info
;
978 fb_helper
->dev
->fb_helper
= NULL
;
980 if (!drm_fbdev_emulation
)
983 cancel_work_sync(&fb_helper
->resume_work
);
984 cancel_work_sync(&fb_helper
->dirty_work
);
986 info
= fb_helper
->fbdev
;
989 fb_dealloc_cmap(&info
->cmap
);
990 framebuffer_release(info
);
992 fb_helper
->fbdev
= NULL
;
994 mutex_lock(&kernel_fb_helper_lock
);
995 if (!list_empty(&fb_helper
->kernel_fb_list
)) {
996 list_del(&fb_helper
->kernel_fb_list
);
997 if (list_empty(&kernel_fb_helper_list
))
998 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op
);
1000 mutex_unlock(&kernel_fb_helper_lock
);
1002 mutex_destroy(&fb_helper
->lock
);
1003 drm_fb_helper_crtc_free(fb_helper
);
1006 EXPORT_SYMBOL(drm_fb_helper_fini
);
1009 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
1010 * @fb_helper: driver-allocated fbdev helper, can be NULL
1012 * A wrapper around unlink_framebuffer implemented by fbdev core
1014 void drm_fb_helper_unlink_fbi(struct drm_fb_helper
*fb_helper
)
1016 if (fb_helper
&& fb_helper
->fbdev
)
1017 unlink_framebuffer(fb_helper
->fbdev
);
1019 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi
);
1021 static void drm_fb_helper_dirty(struct fb_info
*info
, u32 x
, u32 y
,
1022 u32 width
, u32 height
)
1024 struct drm_fb_helper
*helper
= info
->par
;
1025 struct drm_clip_rect
*clip
= &helper
->dirty_clip
;
1026 unsigned long flags
;
1028 if (!helper
->fb
->funcs
->dirty
)
1031 spin_lock_irqsave(&helper
->dirty_lock
, flags
);
1032 clip
->x1
= min_t(u32
, clip
->x1
, x
);
1033 clip
->y1
= min_t(u32
, clip
->y1
, y
);
1034 clip
->x2
= max_t(u32
, clip
->x2
, x
+ width
);
1035 clip
->y2
= max_t(u32
, clip
->y2
, y
+ height
);
1036 spin_unlock_irqrestore(&helper
->dirty_lock
, flags
);
1038 schedule_work(&helper
->dirty_work
);
1042 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
1043 * @info: fb_info struct pointer
1044 * @pagelist: list of dirty mmap framebuffer pages
1046 * This function is used as the &fb_deferred_io.deferred_io
1047 * callback function for flushing the fbdev mmap writes.
1049 void drm_fb_helper_deferred_io(struct fb_info
*info
,
1050 struct list_head
*pagelist
)
1052 unsigned long start
, end
, min
, max
;
1058 list_for_each_entry(page
, pagelist
, lru
) {
1059 start
= page
->index
<< PAGE_SHIFT
;
1060 end
= start
+ PAGE_SIZE
- 1;
1061 min
= min(min
, start
);
1062 max
= max(max
, end
);
1066 y1
= min
/ info
->fix
.line_length
;
1067 y2
= min_t(u32
, DIV_ROUND_UP(max
, info
->fix
.line_length
),
1069 drm_fb_helper_dirty(info
, 0, y1
, info
->var
.xres
, y2
- y1
);
1072 EXPORT_SYMBOL(drm_fb_helper_deferred_io
);
1075 * drm_fb_helper_defio_init - fbdev deferred I/O initialization
1076 * @fb_helper: driver-allocated fbdev helper
1078 * This function allocates &fb_deferred_io, sets callback to
1079 * drm_fb_helper_deferred_io(), delay to 50ms and calls fb_deferred_io_init().
1080 * It should be called from the &drm_fb_helper_funcs->fb_probe callback.
1081 * drm_fb_helper_fbdev_teardown() cleans up deferred I/O.
1083 * NOTE: A copy of &fb_ops is made and assigned to &info->fbops. This is done
1084 * because fb_deferred_io_cleanup() clears &fbops->fb_mmap and would thereby
1085 * affect other instances of that &fb_ops.
1088 * 0 on success or a negative error code on failure.
1090 int drm_fb_helper_defio_init(struct drm_fb_helper
*fb_helper
)
1092 struct fb_info
*info
= fb_helper
->fbdev
;
1093 struct fb_deferred_io
*fbdefio
;
1094 struct fb_ops
*fbops
;
1096 fbdefio
= kzalloc(sizeof(*fbdefio
), GFP_KERNEL
);
1097 fbops
= kzalloc(sizeof(*fbops
), GFP_KERNEL
);
1098 if (!fbdefio
|| !fbops
) {
1104 info
->fbdefio
= fbdefio
;
1105 fbdefio
->delay
= msecs_to_jiffies(50);
1106 fbdefio
->deferred_io
= drm_fb_helper_deferred_io
;
1108 *fbops
= *info
->fbops
;
1109 info
->fbops
= fbops
;
1111 fb_deferred_io_init(info
);
1115 EXPORT_SYMBOL(drm_fb_helper_defio_init
);
1118 * drm_fb_helper_sys_read - wrapper around fb_sys_read
1119 * @info: fb_info struct pointer
1120 * @buf: userspace buffer to read from framebuffer memory
1121 * @count: number of bytes to read from framebuffer memory
1122 * @ppos: read offset within framebuffer memory
1124 * A wrapper around fb_sys_read implemented by fbdev core
1126 ssize_t
drm_fb_helper_sys_read(struct fb_info
*info
, char __user
*buf
,
1127 size_t count
, loff_t
*ppos
)
1129 return fb_sys_read(info
, buf
, count
, ppos
);
1131 EXPORT_SYMBOL(drm_fb_helper_sys_read
);
1134 * drm_fb_helper_sys_write - wrapper around fb_sys_write
1135 * @info: fb_info struct pointer
1136 * @buf: userspace buffer to write to framebuffer memory
1137 * @count: number of bytes to write to framebuffer memory
1138 * @ppos: write offset within framebuffer memory
1140 * A wrapper around fb_sys_write implemented by fbdev core
1142 ssize_t
drm_fb_helper_sys_write(struct fb_info
*info
, const char __user
*buf
,
1143 size_t count
, loff_t
*ppos
)
1147 ret
= fb_sys_write(info
, buf
, count
, ppos
);
1149 drm_fb_helper_dirty(info
, 0, 0, info
->var
.xres
,
1154 EXPORT_SYMBOL(drm_fb_helper_sys_write
);
1157 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
1158 * @info: fbdev registered by the helper
1159 * @rect: info about rectangle to fill
1161 * A wrapper around sys_fillrect implemented by fbdev core
1163 void drm_fb_helper_sys_fillrect(struct fb_info
*info
,
1164 const struct fb_fillrect
*rect
)
1166 sys_fillrect(info
, rect
);
1167 drm_fb_helper_dirty(info
, rect
->dx
, rect
->dy
,
1168 rect
->width
, rect
->height
);
1170 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect
);
1173 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
1174 * @info: fbdev registered by the helper
1175 * @area: info about area to copy
1177 * A wrapper around sys_copyarea implemented by fbdev core
1179 void drm_fb_helper_sys_copyarea(struct fb_info
*info
,
1180 const struct fb_copyarea
*area
)
1182 sys_copyarea(info
, area
);
1183 drm_fb_helper_dirty(info
, area
->dx
, area
->dy
,
1184 area
->width
, area
->height
);
1186 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea
);
1189 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
1190 * @info: fbdev registered by the helper
1191 * @image: info about image to blit
1193 * A wrapper around sys_imageblit implemented by fbdev core
1195 void drm_fb_helper_sys_imageblit(struct fb_info
*info
,
1196 const struct fb_image
*image
)
1198 sys_imageblit(info
, image
);
1199 drm_fb_helper_dirty(info
, image
->dx
, image
->dy
,
1200 image
->width
, image
->height
);
1202 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit
);
1205 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
1206 * @info: fbdev registered by the helper
1207 * @rect: info about rectangle to fill
1209 * A wrapper around cfb_fillrect implemented by fbdev core
1211 void drm_fb_helper_cfb_fillrect(struct fb_info
*info
,
1212 const struct fb_fillrect
*rect
)
1214 cfb_fillrect(info
, rect
);
1215 drm_fb_helper_dirty(info
, rect
->dx
, rect
->dy
,
1216 rect
->width
, rect
->height
);
1218 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect
);
1221 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1222 * @info: fbdev registered by the helper
1223 * @area: info about area to copy
1225 * A wrapper around cfb_copyarea implemented by fbdev core
1227 void drm_fb_helper_cfb_copyarea(struct fb_info
*info
,
1228 const struct fb_copyarea
*area
)
1230 cfb_copyarea(info
, area
);
1231 drm_fb_helper_dirty(info
, area
->dx
, area
->dy
,
1232 area
->width
, area
->height
);
1234 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea
);
1237 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1238 * @info: fbdev registered by the helper
1239 * @image: info about image to blit
1241 * A wrapper around cfb_imageblit implemented by fbdev core
1243 void drm_fb_helper_cfb_imageblit(struct fb_info
*info
,
1244 const struct fb_image
*image
)
1246 cfb_imageblit(info
, image
);
1247 drm_fb_helper_dirty(info
, image
->dx
, image
->dy
,
1248 image
->width
, image
->height
);
1250 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit
);
1253 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1254 * @fb_helper: driver-allocated fbdev helper, can be NULL
1255 * @suspend: whether to suspend or resume
1257 * A wrapper around fb_set_suspend implemented by fbdev core.
1258 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1261 void drm_fb_helper_set_suspend(struct drm_fb_helper
*fb_helper
, bool suspend
)
1263 if (fb_helper
&& fb_helper
->fbdev
)
1264 fb_set_suspend(fb_helper
->fbdev
, suspend
);
1266 EXPORT_SYMBOL(drm_fb_helper_set_suspend
);
1269 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1270 * takes the console lock
1271 * @fb_helper: driver-allocated fbdev helper, can be NULL
1272 * @suspend: whether to suspend or resume
1274 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1275 * isn't available on resume, a worker is tasked with waiting for the lock
1276 * to become available. The console lock can be pretty contented on resume
1277 * due to all the printk activity.
1279 * This function can be called multiple times with the same state since
1280 * &fb_info.state is checked to see if fbdev is running or not before locking.
1282 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1284 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper
*fb_helper
,
1287 if (!fb_helper
|| !fb_helper
->fbdev
)
1290 /* make sure there's no pending/ongoing resume */
1291 flush_work(&fb_helper
->resume_work
);
1294 if (fb_helper
->fbdev
->state
!= FBINFO_STATE_RUNNING
)
1300 if (fb_helper
->fbdev
->state
== FBINFO_STATE_RUNNING
)
1303 if (!console_trylock()) {
1304 schedule_work(&fb_helper
->resume_work
);
1309 fb_set_suspend(fb_helper
->fbdev
, suspend
);
1312 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked
);
1314 static int setcmap_pseudo_palette(struct fb_cmap
*cmap
, struct fb_info
*info
)
1316 u32
*palette
= (u32
*)info
->pseudo_palette
;
1319 if (cmap
->start
+ cmap
->len
> 16)
1322 for (i
= 0; i
< cmap
->len
; ++i
) {
1323 u16 red
= cmap
->red
[i
];
1324 u16 green
= cmap
->green
[i
];
1325 u16 blue
= cmap
->blue
[i
];
1328 red
>>= 16 - info
->var
.red
.length
;
1329 green
>>= 16 - info
->var
.green
.length
;
1330 blue
>>= 16 - info
->var
.blue
.length
;
1331 value
= (red
<< info
->var
.red
.offset
) |
1332 (green
<< info
->var
.green
.offset
) |
1333 (blue
<< info
->var
.blue
.offset
);
1334 if (info
->var
.transp
.length
> 0) {
1335 u32 mask
= (1 << info
->var
.transp
.length
) - 1;
1337 mask
<<= info
->var
.transp
.offset
;
1340 palette
[cmap
->start
+ i
] = value
;
1346 static int setcmap_legacy(struct fb_cmap
*cmap
, struct fb_info
*info
)
1348 struct drm_fb_helper
*fb_helper
= info
->par
;
1349 struct drm_crtc
*crtc
;
1353 drm_modeset_lock_all(fb_helper
->dev
);
1354 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1355 crtc
= fb_helper
->crtc_info
[i
].mode_set
.crtc
;
1356 if (!crtc
->funcs
->gamma_set
|| !crtc
->gamma_size
)
1359 if (cmap
->start
+ cmap
->len
> crtc
->gamma_size
)
1362 r
= crtc
->gamma_store
;
1363 g
= r
+ crtc
->gamma_size
;
1364 b
= g
+ crtc
->gamma_size
;
1366 memcpy(r
+ cmap
->start
, cmap
->red
, cmap
->len
* sizeof(*r
));
1367 memcpy(g
+ cmap
->start
, cmap
->green
, cmap
->len
* sizeof(*g
));
1368 memcpy(b
+ cmap
->start
, cmap
->blue
, cmap
->len
* sizeof(*b
));
1370 ret
= crtc
->funcs
->gamma_set(crtc
, r
, g
, b
,
1371 crtc
->gamma_size
, NULL
);
1375 drm_modeset_unlock_all(fb_helper
->dev
);
1380 static struct drm_property_blob
*setcmap_new_gamma_lut(struct drm_crtc
*crtc
,
1381 struct fb_cmap
*cmap
)
1383 struct drm_device
*dev
= crtc
->dev
;
1384 struct drm_property_blob
*gamma_lut
;
1385 struct drm_color_lut
*lut
;
1386 int size
= crtc
->gamma_size
;
1389 if (!size
|| cmap
->start
+ cmap
->len
> size
)
1390 return ERR_PTR(-EINVAL
);
1392 gamma_lut
= drm_property_create_blob(dev
, sizeof(*lut
) * size
, NULL
);
1393 if (IS_ERR(gamma_lut
))
1396 lut
= gamma_lut
->data
;
1397 if (cmap
->start
|| cmap
->len
!= size
) {
1398 u16
*r
= crtc
->gamma_store
;
1399 u16
*g
= r
+ crtc
->gamma_size
;
1400 u16
*b
= g
+ crtc
->gamma_size
;
1402 for (i
= 0; i
< cmap
->start
; i
++) {
1404 lut
[i
].green
= g
[i
];
1407 for (i
= cmap
->start
+ cmap
->len
; i
< size
; i
++) {
1409 lut
[i
].green
= g
[i
];
1414 for (i
= 0; i
< cmap
->len
; i
++) {
1415 lut
[cmap
->start
+ i
].red
= cmap
->red
[i
];
1416 lut
[cmap
->start
+ i
].green
= cmap
->green
[i
];
1417 lut
[cmap
->start
+ i
].blue
= cmap
->blue
[i
];
1423 static int setcmap_atomic(struct fb_cmap
*cmap
, struct fb_info
*info
)
1425 struct drm_fb_helper
*fb_helper
= info
->par
;
1426 struct drm_device
*dev
= fb_helper
->dev
;
1427 struct drm_property_blob
*gamma_lut
= NULL
;
1428 struct drm_modeset_acquire_ctx ctx
;
1429 struct drm_crtc_state
*crtc_state
;
1430 struct drm_atomic_state
*state
;
1431 struct drm_crtc
*crtc
;
1436 drm_modeset_acquire_init(&ctx
, 0);
1438 state
= drm_atomic_state_alloc(dev
);
1444 state
->acquire_ctx
= &ctx
;
1446 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1447 crtc
= fb_helper
->crtc_info
[i
].mode_set
.crtc
;
1450 gamma_lut
= setcmap_new_gamma_lut(crtc
, cmap
);
1451 if (IS_ERR(gamma_lut
)) {
1452 ret
= PTR_ERR(gamma_lut
);
1457 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1458 if (IS_ERR(crtc_state
)) {
1459 ret
= PTR_ERR(crtc_state
);
1463 replaced
= drm_property_replace_blob(&crtc_state
->degamma_lut
,
1465 replaced
|= drm_property_replace_blob(&crtc_state
->ctm
, NULL
);
1466 replaced
|= drm_property_replace_blob(&crtc_state
->gamma_lut
,
1468 crtc_state
->color_mgmt_changed
|= replaced
;
1471 ret
= drm_atomic_commit(state
);
1475 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1476 crtc
= fb_helper
->crtc_info
[i
].mode_set
.crtc
;
1478 r
= crtc
->gamma_store
;
1479 g
= r
+ crtc
->gamma_size
;
1480 b
= g
+ crtc
->gamma_size
;
1482 memcpy(r
+ cmap
->start
, cmap
->red
, cmap
->len
* sizeof(*r
));
1483 memcpy(g
+ cmap
->start
, cmap
->green
, cmap
->len
* sizeof(*g
));
1484 memcpy(b
+ cmap
->start
, cmap
->blue
, cmap
->len
* sizeof(*b
));
1488 if (ret
== -EDEADLK
)
1491 drm_property_blob_put(gamma_lut
);
1492 drm_atomic_state_put(state
);
1494 drm_modeset_drop_locks(&ctx
);
1495 drm_modeset_acquire_fini(&ctx
);
1500 drm_atomic_state_clear(state
);
1501 drm_modeset_backoff(&ctx
);
1506 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1507 * @cmap: cmap to set
1508 * @info: fbdev registered by the helper
1510 int drm_fb_helper_setcmap(struct fb_cmap
*cmap
, struct fb_info
*info
)
1512 struct drm_fb_helper
*fb_helper
= info
->par
;
1515 if (oops_in_progress
)
1518 mutex_lock(&fb_helper
->lock
);
1520 if (!drm_fb_helper_is_bound(fb_helper
)) {
1525 if (info
->fix
.visual
== FB_VISUAL_TRUECOLOR
)
1526 ret
= setcmap_pseudo_palette(cmap
, info
);
1527 else if (drm_drv_uses_atomic_modeset(fb_helper
->dev
))
1528 ret
= setcmap_atomic(cmap
, info
);
1530 ret
= setcmap_legacy(cmap
, info
);
1533 mutex_unlock(&fb_helper
->lock
);
1537 EXPORT_SYMBOL(drm_fb_helper_setcmap
);
1540 * drm_fb_helper_ioctl - legacy ioctl implementation
1541 * @info: fbdev registered by the helper
1542 * @cmd: ioctl command
1543 * @arg: ioctl argument
1545 * A helper to implement the standard fbdev ioctl. Only
1546 * FBIO_WAITFORVSYNC is implemented for now.
1548 int drm_fb_helper_ioctl(struct fb_info
*info
, unsigned int cmd
,
1551 struct drm_fb_helper
*fb_helper
= info
->par
;
1552 struct drm_mode_set
*mode_set
;
1553 struct drm_crtc
*crtc
;
1556 mutex_lock(&fb_helper
->lock
);
1557 if (!drm_fb_helper_is_bound(fb_helper
)) {
1563 case FBIO_WAITFORVSYNC
:
1565 * Only consider the first CRTC.
1567 * This ioctl is supposed to take the CRTC number as
1568 * an argument, but in fbdev times, what that number
1569 * was supposed to be was quite unclear, different
1570 * drivers were passing that argument differently
1571 * (some by reference, some by value), and most of the
1572 * userspace applications were just hardcoding 0 as an
1575 * The first CRTC should be the integrated panel on
1576 * most drivers, so this is the best choice we can
1577 * make. If we're not smart enough here, one should
1578 * just consider switch the userspace to KMS.
1580 mode_set
= &fb_helper
->crtc_info
[0].mode_set
;
1581 crtc
= mode_set
->crtc
;
1584 * Only wait for a vblank event if the CRTC is
1585 * enabled, otherwise just don't do anythintg,
1586 * not even report an error.
1588 ret
= drm_crtc_vblank_get(crtc
);
1590 drm_crtc_wait_one_vblank(crtc
);
1591 drm_crtc_vblank_put(crtc
);
1601 mutex_unlock(&fb_helper
->lock
);
1604 EXPORT_SYMBOL(drm_fb_helper_ioctl
);
1606 static bool drm_fb_pixel_format_equal(const struct fb_var_screeninfo
*var_1
,
1607 const struct fb_var_screeninfo
*var_2
)
1609 return var_1
->bits_per_pixel
== var_2
->bits_per_pixel
&&
1610 var_1
->grayscale
== var_2
->grayscale
&&
1611 var_1
->red
.offset
== var_2
->red
.offset
&&
1612 var_1
->red
.length
== var_2
->red
.length
&&
1613 var_1
->red
.msb_right
== var_2
->red
.msb_right
&&
1614 var_1
->green
.offset
== var_2
->green
.offset
&&
1615 var_1
->green
.length
== var_2
->green
.length
&&
1616 var_1
->green
.msb_right
== var_2
->green
.msb_right
&&
1617 var_1
->blue
.offset
== var_2
->blue
.offset
&&
1618 var_1
->blue
.length
== var_2
->blue
.length
&&
1619 var_1
->blue
.msb_right
== var_2
->blue
.msb_right
&&
1620 var_1
->transp
.offset
== var_2
->transp
.offset
&&
1621 var_1
->transp
.length
== var_2
->transp
.length
&&
1622 var_1
->transp
.msb_right
== var_2
->transp
.msb_right
;
1625 static void drm_fb_helper_fill_pixel_fmt(struct fb_var_screeninfo
*var
,
1630 var
->red
.offset
= 0;
1631 var
->green
.offset
= 0;
1632 var
->blue
.offset
= 0;
1633 var
->red
.length
= 8; /* 8bit DAC */
1634 var
->green
.length
= 8;
1635 var
->blue
.length
= 8;
1636 var
->transp
.offset
= 0;
1637 var
->transp
.length
= 0;
1640 var
->red
.offset
= 10;
1641 var
->green
.offset
= 5;
1642 var
->blue
.offset
= 0;
1643 var
->red
.length
= 5;
1644 var
->green
.length
= 5;
1645 var
->blue
.length
= 5;
1646 var
->transp
.offset
= 15;
1647 var
->transp
.length
= 1;
1650 var
->red
.offset
= 11;
1651 var
->green
.offset
= 5;
1652 var
->blue
.offset
= 0;
1653 var
->red
.length
= 5;
1654 var
->green
.length
= 6;
1655 var
->blue
.length
= 5;
1656 var
->transp
.offset
= 0;
1659 var
->red
.offset
= 16;
1660 var
->green
.offset
= 8;
1661 var
->blue
.offset
= 0;
1662 var
->red
.length
= 8;
1663 var
->green
.length
= 8;
1664 var
->blue
.length
= 8;
1665 var
->transp
.offset
= 0;
1666 var
->transp
.length
= 0;
1669 var
->red
.offset
= 16;
1670 var
->green
.offset
= 8;
1671 var
->blue
.offset
= 0;
1672 var
->red
.length
= 8;
1673 var
->green
.length
= 8;
1674 var
->blue
.length
= 8;
1675 var
->transp
.offset
= 24;
1676 var
->transp
.length
= 8;
1684 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1685 * @var: screeninfo to check
1686 * @info: fbdev registered by the helper
1688 int drm_fb_helper_check_var(struct fb_var_screeninfo
*var
,
1689 struct fb_info
*info
)
1691 struct drm_fb_helper
*fb_helper
= info
->par
;
1692 struct drm_framebuffer
*fb
= fb_helper
->fb
;
1694 if (in_dbg_master())
1697 if (var
->pixclock
!= 0) {
1698 DRM_DEBUG("fbdev emulation doesn't support changing the pixel clock, value of pixclock is ignored\n");
1702 if ((drm_format_info_block_width(fb
->format
, 0) > 1) ||
1703 (drm_format_info_block_height(fb
->format
, 0) > 1))
1707 * Changes struct fb_var_screeninfo are currently not pushed back
1708 * to KMS, hence fail if different settings are requested.
1710 if (var
->bits_per_pixel
!= fb
->format
->cpp
[0] * 8 ||
1711 var
->xres
> fb
->width
|| var
->yres
> fb
->height
||
1712 var
->xres_virtual
> fb
->width
|| var
->yres_virtual
> fb
->height
) {
1713 DRM_DEBUG("fb requested width/height/bpp can't fit in current fb "
1714 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1715 var
->xres
, var
->yres
, var
->bits_per_pixel
,
1716 var
->xres_virtual
, var
->yres_virtual
,
1717 fb
->width
, fb
->height
, fb
->format
->cpp
[0] * 8);
1722 * Workaround for SDL 1.2, which is known to be setting all pixel format
1723 * fields values to zero in some cases. We treat this situation as a
1724 * kind of "use some reasonable autodetected values".
1726 if (!var
->red
.offset
&& !var
->green
.offset
&&
1727 !var
->blue
.offset
&& !var
->transp
.offset
&&
1728 !var
->red
.length
&& !var
->green
.length
&&
1729 !var
->blue
.length
&& !var
->transp
.length
&&
1730 !var
->red
.msb_right
&& !var
->green
.msb_right
&&
1731 !var
->blue
.msb_right
&& !var
->transp
.msb_right
) {
1732 drm_fb_helper_fill_pixel_fmt(var
, fb
->format
->depth
);
1736 * drm fbdev emulation doesn't support changing the pixel format at all,
1737 * so reject all pixel format changing requests.
1739 if (!drm_fb_pixel_format_equal(var
, &info
->var
)) {
1740 DRM_DEBUG("fbdev emulation doesn't support changing the pixel format\n");
1746 EXPORT_SYMBOL(drm_fb_helper_check_var
);
1749 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1750 * @info: fbdev registered by the helper
1752 * This will let fbcon do the mode init and is called at initialization time by
1753 * the fbdev core when registering the driver, and later on through the hotplug
1756 int drm_fb_helper_set_par(struct fb_info
*info
)
1758 struct drm_fb_helper
*fb_helper
= info
->par
;
1759 struct fb_var_screeninfo
*var
= &info
->var
;
1761 if (oops_in_progress
)
1764 if (var
->pixclock
!= 0) {
1765 DRM_ERROR("PIXEL CLOCK SET\n");
1769 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper
);
1773 EXPORT_SYMBOL(drm_fb_helper_set_par
);
1775 static void pan_set(struct drm_fb_helper
*fb_helper
, int x
, int y
)
1779 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1780 struct drm_mode_set
*mode_set
;
1782 mode_set
= &fb_helper
->crtc_info
[i
].mode_set
;
1789 static int pan_display_atomic(struct fb_var_screeninfo
*var
,
1790 struct fb_info
*info
)
1792 struct drm_fb_helper
*fb_helper
= info
->par
;
1795 pan_set(fb_helper
, var
->xoffset
, var
->yoffset
);
1797 ret
= restore_fbdev_mode_atomic(fb_helper
, true);
1799 info
->var
.xoffset
= var
->xoffset
;
1800 info
->var
.yoffset
= var
->yoffset
;
1802 pan_set(fb_helper
, info
->var
.xoffset
, info
->var
.yoffset
);
1807 static int pan_display_legacy(struct fb_var_screeninfo
*var
,
1808 struct fb_info
*info
)
1810 struct drm_fb_helper
*fb_helper
= info
->par
;
1811 struct drm_mode_set
*modeset
;
1815 drm_modeset_lock_all(fb_helper
->dev
);
1816 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1817 modeset
= &fb_helper
->crtc_info
[i
].mode_set
;
1819 modeset
->x
= var
->xoffset
;
1820 modeset
->y
= var
->yoffset
;
1822 if (modeset
->num_connectors
) {
1823 ret
= drm_mode_set_config_internal(modeset
);
1825 info
->var
.xoffset
= var
->xoffset
;
1826 info
->var
.yoffset
= var
->yoffset
;
1830 drm_modeset_unlock_all(fb_helper
->dev
);
1836 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1837 * @var: updated screen information
1838 * @info: fbdev registered by the helper
1840 int drm_fb_helper_pan_display(struct fb_var_screeninfo
*var
,
1841 struct fb_info
*info
)
1843 struct drm_fb_helper
*fb_helper
= info
->par
;
1844 struct drm_device
*dev
= fb_helper
->dev
;
1847 if (oops_in_progress
)
1850 mutex_lock(&fb_helper
->lock
);
1851 if (!drm_fb_helper_is_bound(fb_helper
)) {
1852 mutex_unlock(&fb_helper
->lock
);
1856 if (drm_drv_uses_atomic_modeset(dev
))
1857 ret
= pan_display_atomic(var
, info
);
1859 ret
= pan_display_legacy(var
, info
);
1860 mutex_unlock(&fb_helper
->lock
);
1864 EXPORT_SYMBOL(drm_fb_helper_pan_display
);
1867 * Allocates the backing storage and sets up the fbdev info structure through
1868 * the ->fb_probe callback.
1870 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper
*fb_helper
,
1876 struct drm_fb_helper_surface_size sizes
;
1880 memset(&sizes
, 0, sizeof(struct drm_fb_helper_surface_size
));
1881 sizes
.surface_depth
= 24;
1882 sizes
.surface_bpp
= 32;
1883 sizes
.fb_width
= (u32
)-1;
1884 sizes
.fb_height
= (u32
)-1;
1887 * If driver picks 8 or 16 by default use that for both depth/bpp
1890 if (preferred_bpp
!= sizes
.surface_bpp
)
1891 sizes
.surface_depth
= sizes
.surface_bpp
= preferred_bpp
;
1893 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1894 drm_fb_helper_for_each_connector(fb_helper
, i
) {
1895 struct drm_fb_helper_connector
*fb_helper_conn
= fb_helper
->connector_info
[i
];
1896 struct drm_cmdline_mode
*cmdline_mode
;
1898 cmdline_mode
= &fb_helper_conn
->connector
->cmdline_mode
;
1900 if (cmdline_mode
->bpp_specified
) {
1901 switch (cmdline_mode
->bpp
) {
1903 sizes
.surface_depth
= sizes
.surface_bpp
= 8;
1906 sizes
.surface_depth
= 15;
1907 sizes
.surface_bpp
= 16;
1910 sizes
.surface_depth
= sizes
.surface_bpp
= 16;
1913 sizes
.surface_depth
= sizes
.surface_bpp
= 24;
1916 sizes
.surface_depth
= 24;
1917 sizes
.surface_bpp
= 32;
1925 * If we run into a situation where, for example, the primary plane
1926 * supports RGBA5551 (16 bpp, depth 15) but not RGB565 (16 bpp, depth
1927 * 16) we need to scale down the depth of the sizes we request.
1929 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1930 struct drm_mode_set
*mode_set
= &fb_helper
->crtc_info
[i
].mode_set
;
1931 struct drm_crtc
*crtc
= mode_set
->crtc
;
1932 struct drm_plane
*plane
= crtc
->primary
;
1935 DRM_DEBUG("test CRTC %d primary plane\n", i
);
1937 for (j
= 0; j
< plane
->format_count
; j
++) {
1938 const struct drm_format_info
*fmt
;
1940 fmt
= drm_format_info(plane
->format_types
[j
]);
1943 * Do not consider YUV or other complicated formats
1944 * for framebuffers. This means only legacy formats
1945 * are supported (fmt->depth is a legacy field) but
1946 * the framebuffer emulation can only deal with such
1947 * formats, specifically RGB/BGA formats.
1949 if (fmt
->depth
== 0)
1952 /* We found a perfect fit, great */
1953 if (fmt
->depth
== sizes
.surface_depth
) {
1954 best_depth
= fmt
->depth
;
1958 /* Skip depths above what we're looking for */
1959 if (fmt
->depth
> sizes
.surface_depth
)
1962 /* Best depth found so far */
1963 if (fmt
->depth
> best_depth
)
1964 best_depth
= fmt
->depth
;
1967 if (sizes
.surface_depth
!= best_depth
) {
1968 DRM_INFO("requested bpp %d, scaled depth down to %d",
1969 sizes
.surface_bpp
, best_depth
);
1970 sizes
.surface_depth
= best_depth
;
1974 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1975 struct drm_display_mode
*desired_mode
;
1976 struct drm_mode_set
*mode_set
;
1978 /* in case of tile group, are we the last tile vert or horiz?
1979 * If no tile group you are always the last one both vertically
1982 bool lastv
= true, lasth
= true;
1984 desired_mode
= fb_helper
->crtc_info
[i
].desired_mode
;
1985 mode_set
= &fb_helper
->crtc_info
[i
].mode_set
;
1992 x
= fb_helper
->crtc_info
[i
].x
;
1993 y
= fb_helper
->crtc_info
[i
].y
;
1995 if (gamma_size
== 0)
1996 gamma_size
= fb_helper
->crtc_info
[i
].mode_set
.crtc
->gamma_size
;
1998 sizes
.surface_width
= max_t(u32
, desired_mode
->hdisplay
+ x
, sizes
.surface_width
);
1999 sizes
.surface_height
= max_t(u32
, desired_mode
->vdisplay
+ y
, sizes
.surface_height
);
2001 for (j
= 0; j
< mode_set
->num_connectors
; j
++) {
2002 struct drm_connector
*connector
= mode_set
->connectors
[j
];
2004 if (connector
->has_tile
) {
2005 lasth
= (connector
->tile_h_loc
== (connector
->num_h_tile
- 1));
2006 lastv
= (connector
->tile_v_loc
== (connector
->num_v_tile
- 1));
2007 /* cloning to multiple tiles is just crazy-talk, so: */
2013 sizes
.fb_width
= min_t(u32
, desired_mode
->hdisplay
+ x
, sizes
.fb_width
);
2015 sizes
.fb_height
= min_t(u32
, desired_mode
->vdisplay
+ y
, sizes
.fb_height
);
2018 if (crtc_count
== 0 || sizes
.fb_width
== -1 || sizes
.fb_height
== -1) {
2019 DRM_INFO("Cannot find any crtc or sizes\n");
2021 /* First time: disable all crtc's.. */
2022 if (!fb_helper
->deferred_setup
&& !READ_ONCE(fb_helper
->dev
->master
))
2023 restore_fbdev_mode(fb_helper
);
2027 /* Handle our overallocation */
2028 sizes
.surface_height
*= drm_fbdev_overalloc
;
2029 sizes
.surface_height
/= 100;
2031 /* push down into drivers */
2032 ret
= (*fb_helper
->funcs
->fb_probe
)(fb_helper
, &sizes
);
2036 strcpy(fb_helper
->fb
->comm
, "[fbcon]");
2040 static void drm_fb_helper_fill_fix(struct fb_info
*info
, uint32_t pitch
,
2043 info
->fix
.type
= FB_TYPE_PACKED_PIXELS
;
2044 info
->fix
.visual
= depth
== 8 ? FB_VISUAL_PSEUDOCOLOR
:
2045 FB_VISUAL_TRUECOLOR
;
2046 info
->fix
.mmio_start
= 0;
2047 info
->fix
.mmio_len
= 0;
2048 info
->fix
.type_aux
= 0;
2049 info
->fix
.xpanstep
= 1; /* doing it in hw */
2050 info
->fix
.ypanstep
= 1; /* doing it in hw */
2051 info
->fix
.ywrapstep
= 0;
2052 info
->fix
.accel
= FB_ACCEL_NONE
;
2054 info
->fix
.line_length
= pitch
;
2057 static void drm_fb_helper_fill_var(struct fb_info
*info
,
2058 struct drm_fb_helper
*fb_helper
,
2059 uint32_t fb_width
, uint32_t fb_height
)
2061 struct drm_framebuffer
*fb
= fb_helper
->fb
;
2063 WARN_ON((drm_format_info_block_width(fb
->format
, 0) > 1) ||
2064 (drm_format_info_block_height(fb
->format
, 0) > 1));
2065 info
->pseudo_palette
= fb_helper
->pseudo_palette
;
2066 info
->var
.xres_virtual
= fb
->width
;
2067 info
->var
.yres_virtual
= fb
->height
;
2068 info
->var
.bits_per_pixel
= fb
->format
->cpp
[0] * 8;
2069 info
->var
.accel_flags
= FB_ACCELF_TEXT
;
2070 info
->var
.xoffset
= 0;
2071 info
->var
.yoffset
= 0;
2072 info
->var
.activate
= FB_ACTIVATE_NOW
;
2074 drm_fb_helper_fill_pixel_fmt(&info
->var
, fb
->format
->depth
);
2076 info
->var
.xres
= fb_width
;
2077 info
->var
.yres
= fb_height
;
2081 * drm_fb_helper_fill_info - initializes fbdev information
2082 * @info: fbdev instance to set up
2083 * @fb_helper: fb helper instance to use as template
2084 * @sizes: describes fbdev size and scanout surface size
2086 * Sets up the variable and fixed fbdev metainformation from the given fb helper
2087 * instance and the drm framebuffer allocated in &drm_fb_helper.fb.
2089 * Drivers should call this (or their equivalent setup code) from their
2090 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
2091 * backing storage framebuffer.
2093 void drm_fb_helper_fill_info(struct fb_info
*info
,
2094 struct drm_fb_helper
*fb_helper
,
2095 struct drm_fb_helper_surface_size
*sizes
)
2097 struct drm_framebuffer
*fb
= fb_helper
->fb
;
2099 drm_fb_helper_fill_fix(info
, fb
->pitches
[0], fb
->format
->depth
);
2100 drm_fb_helper_fill_var(info
, fb_helper
,
2101 sizes
->fb_width
, sizes
->fb_height
);
2103 info
->par
= fb_helper
;
2104 snprintf(info
->fix
.id
, sizeof(info
->fix
.id
), "%sdrmfb",
2105 fb_helper
->dev
->driver
->name
);
2108 EXPORT_SYMBOL(drm_fb_helper_fill_info
);
2110 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper
*fb_helper
,
2114 struct drm_connector
*connector
;
2117 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2118 connector
= fb_helper
->connector_info
[i
]->connector
;
2119 count
+= connector
->funcs
->fill_modes(connector
, maxX
, maxY
);
2125 struct drm_display_mode
*drm_has_preferred_mode(struct drm_fb_helper_connector
*fb_connector
, int width
, int height
)
2127 struct drm_display_mode
*mode
;
2129 list_for_each_entry(mode
, &fb_connector
->connector
->modes
, head
) {
2130 if (mode
->hdisplay
> width
||
2131 mode
->vdisplay
> height
)
2133 if (mode
->type
& DRM_MODE_TYPE_PREFERRED
)
2138 EXPORT_SYMBOL(drm_has_preferred_mode
);
2140 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector
*fb_connector
)
2142 return fb_connector
->connector
->cmdline_mode
.specified
;
2145 struct drm_display_mode
*drm_pick_cmdline_mode(struct drm_fb_helper_connector
*fb_helper_conn
)
2147 struct drm_cmdline_mode
*cmdline_mode
;
2148 struct drm_display_mode
*mode
;
2149 bool prefer_non_interlace
;
2151 cmdline_mode
= &fb_helper_conn
->connector
->cmdline_mode
;
2152 if (cmdline_mode
->specified
== false)
2155 /* attempt to find a matching mode in the list of modes
2156 * we have gotten so far, if not add a CVT mode that conforms
2158 if (cmdline_mode
->rb
|| cmdline_mode
->margins
)
2161 prefer_non_interlace
= !cmdline_mode
->interlace
;
2163 list_for_each_entry(mode
, &fb_helper_conn
->connector
->modes
, head
) {
2164 /* check width/height */
2165 if (mode
->hdisplay
!= cmdline_mode
->xres
||
2166 mode
->vdisplay
!= cmdline_mode
->yres
)
2169 if (cmdline_mode
->refresh_specified
) {
2170 if (mode
->vrefresh
!= cmdline_mode
->refresh
)
2174 if (cmdline_mode
->interlace
) {
2175 if (!(mode
->flags
& DRM_MODE_FLAG_INTERLACE
))
2177 } else if (prefer_non_interlace
) {
2178 if (mode
->flags
& DRM_MODE_FLAG_INTERLACE
)
2184 if (prefer_non_interlace
) {
2185 prefer_non_interlace
= false;
2190 mode
= drm_mode_create_from_cmdline_mode(fb_helper_conn
->connector
->dev
,
2192 list_add(&mode
->head
, &fb_helper_conn
->connector
->modes
);
2195 EXPORT_SYMBOL(drm_pick_cmdline_mode
);
2197 static bool drm_connector_enabled(struct drm_connector
*connector
, bool strict
)
2201 if (connector
->display_info
.non_desktop
)
2205 enable
= connector
->status
== connector_status_connected
;
2207 enable
= connector
->status
!= connector_status_disconnected
;
2212 static void drm_enable_connectors(struct drm_fb_helper
*fb_helper
,
2215 bool any_enabled
= false;
2216 struct drm_connector
*connector
;
2219 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2220 connector
= fb_helper
->connector_info
[i
]->connector
;
2221 enabled
[i
] = drm_connector_enabled(connector
, true);
2222 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector
->base
.id
,
2223 connector
->display_info
.non_desktop
? "non desktop" : enabled
[i
] ? "yes" : "no");
2225 any_enabled
|= enabled
[i
];
2231 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2232 connector
= fb_helper
->connector_info
[i
]->connector
;
2233 enabled
[i
] = drm_connector_enabled(connector
, false);
2237 static bool drm_target_cloned(struct drm_fb_helper
*fb_helper
,
2238 struct drm_display_mode
**modes
,
2239 struct drm_fb_offset
*offsets
,
2240 bool *enabled
, int width
, int height
)
2243 bool can_clone
= false;
2244 struct drm_fb_helper_connector
*fb_helper_conn
;
2245 struct drm_display_mode
*dmt_mode
, *mode
;
2247 /* only contemplate cloning in the single crtc case */
2248 if (fb_helper
->crtc_count
> 1)
2252 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2257 /* only contemplate cloning if more than one connector is enabled */
2261 /* check the command line or if nothing common pick 1024x768 */
2263 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2266 fb_helper_conn
= fb_helper
->connector_info
[i
];
2267 modes
[i
] = drm_pick_cmdline_mode(fb_helper_conn
);
2272 for (j
= 0; j
< i
; j
++) {
2275 if (!drm_mode_match(modes
[j
], modes
[i
],
2276 DRM_MODE_MATCH_TIMINGS
|
2277 DRM_MODE_MATCH_CLOCK
|
2278 DRM_MODE_MATCH_FLAGS
|
2279 DRM_MODE_MATCH_3D_FLAGS
))
2285 DRM_DEBUG_KMS("can clone using command line\n");
2289 /* try and find a 1024x768 mode on each connector */
2291 dmt_mode
= drm_mode_find_dmt(fb_helper
->dev
, 1024, 768, 60, false);
2293 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2297 fb_helper_conn
= fb_helper
->connector_info
[i
];
2298 list_for_each_entry(mode
, &fb_helper_conn
->connector
->modes
, head
) {
2299 if (drm_mode_match(mode
, dmt_mode
,
2300 DRM_MODE_MATCH_TIMINGS
|
2301 DRM_MODE_MATCH_CLOCK
|
2302 DRM_MODE_MATCH_FLAGS
|
2303 DRM_MODE_MATCH_3D_FLAGS
))
2311 DRM_DEBUG_KMS("can clone using 1024x768\n");
2314 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
2318 static int drm_get_tile_offsets(struct drm_fb_helper
*fb_helper
,
2319 struct drm_display_mode
**modes
,
2320 struct drm_fb_offset
*offsets
,
2322 int h_idx
, int v_idx
)
2324 struct drm_fb_helper_connector
*fb_helper_conn
;
2326 int hoffset
= 0, voffset
= 0;
2328 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2329 fb_helper_conn
= fb_helper
->connector_info
[i
];
2330 if (!fb_helper_conn
->connector
->has_tile
)
2333 if (!modes
[i
] && (h_idx
|| v_idx
)) {
2334 DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i
,
2335 fb_helper_conn
->connector
->base
.id
);
2338 if (fb_helper_conn
->connector
->tile_h_loc
< h_idx
)
2339 hoffset
+= modes
[i
]->hdisplay
;
2341 if (fb_helper_conn
->connector
->tile_v_loc
< v_idx
)
2342 voffset
+= modes
[i
]->vdisplay
;
2344 offsets
[idx
].x
= hoffset
;
2345 offsets
[idx
].y
= voffset
;
2346 DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset
, voffset
, h_idx
, v_idx
);
2350 static bool drm_target_preferred(struct drm_fb_helper
*fb_helper
,
2351 struct drm_display_mode
**modes
,
2352 struct drm_fb_offset
*offsets
,
2353 bool *enabled
, int width
, int height
)
2355 struct drm_fb_helper_connector
*fb_helper_conn
;
2356 const u64 mask
= BIT_ULL(fb_helper
->connector_count
) - 1;
2357 u64 conn_configured
= 0;
2362 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2363 fb_helper_conn
= fb_helper
->connector_info
[i
];
2365 if (conn_configured
& BIT_ULL(i
))
2368 if (enabled
[i
] == false) {
2369 conn_configured
|= BIT_ULL(i
);
2373 /* first pass over all the untiled connectors */
2374 if (tile_pass
== 0 && fb_helper_conn
->connector
->has_tile
)
2377 if (tile_pass
== 1) {
2378 if (fb_helper_conn
->connector
->tile_h_loc
!= 0 ||
2379 fb_helper_conn
->connector
->tile_v_loc
!= 0)
2383 if (fb_helper_conn
->connector
->tile_h_loc
!= tile_pass
- 1 &&
2384 fb_helper_conn
->connector
->tile_v_loc
!= tile_pass
- 1)
2385 /* if this tile_pass doesn't cover any of the tiles - keep going */
2389 * find the tile offsets for this pass - need to find
2390 * all tiles left and above
2392 drm_get_tile_offsets(fb_helper
, modes
, offsets
,
2393 i
, fb_helper_conn
->connector
->tile_h_loc
, fb_helper_conn
->connector
->tile_v_loc
);
2395 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
2396 fb_helper_conn
->connector
->base
.id
);
2398 /* got for command line mode first */
2399 modes
[i
] = drm_pick_cmdline_mode(fb_helper_conn
);
2401 DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
2402 fb_helper_conn
->connector
->base
.id
, fb_helper_conn
->connector
->tile_group
? fb_helper_conn
->connector
->tile_group
->id
: 0);
2403 modes
[i
] = drm_has_preferred_mode(fb_helper_conn
, width
, height
);
2405 /* No preferred modes, pick one off the list */
2406 if (!modes
[i
] && !list_empty(&fb_helper_conn
->connector
->modes
)) {
2407 list_for_each_entry(modes
[i
], &fb_helper_conn
->connector
->modes
, head
)
2410 DRM_DEBUG_KMS("found mode %s\n", modes
[i
] ? modes
[i
]->name
:
2412 conn_configured
|= BIT_ULL(i
);
2415 if ((conn_configured
& mask
) != mask
) {
2422 static bool connector_has_possible_crtc(struct drm_connector
*connector
,
2423 struct drm_crtc
*crtc
)
2425 struct drm_encoder
*encoder
;
2428 drm_connector_for_each_possible_encoder(connector
, encoder
, i
) {
2429 if (encoder
->possible_crtcs
& drm_crtc_mask(crtc
))
2436 static int drm_pick_crtcs(struct drm_fb_helper
*fb_helper
,
2437 struct drm_fb_helper_crtc
**best_crtcs
,
2438 struct drm_display_mode
**modes
,
2439 int n
, int width
, int height
)
2442 struct drm_connector
*connector
;
2443 int my_score
, best_score
, score
;
2444 struct drm_fb_helper_crtc
**crtcs
, *crtc
;
2445 struct drm_fb_helper_connector
*fb_helper_conn
;
2447 if (n
== fb_helper
->connector_count
)
2450 fb_helper_conn
= fb_helper
->connector_info
[n
];
2451 connector
= fb_helper_conn
->connector
;
2453 best_crtcs
[n
] = NULL
;
2454 best_score
= drm_pick_crtcs(fb_helper
, best_crtcs
, modes
, n
+1, width
, height
);
2455 if (modes
[n
] == NULL
)
2458 crtcs
= kcalloc(fb_helper
->connector_count
,
2459 sizeof(struct drm_fb_helper_crtc
*), GFP_KERNEL
);
2464 if (connector
->status
== connector_status_connected
)
2466 if (drm_has_cmdline_mode(fb_helper_conn
))
2468 if (drm_has_preferred_mode(fb_helper_conn
, width
, height
))
2472 * select a crtc for this connector and then attempt to configure
2473 * remaining connectors
2475 for (c
= 0; c
< fb_helper
->crtc_count
; c
++) {
2476 crtc
= &fb_helper
->crtc_info
[c
];
2478 if (!connector_has_possible_crtc(connector
,
2479 crtc
->mode_set
.crtc
))
2482 for (o
= 0; o
< n
; o
++)
2483 if (best_crtcs
[o
] == crtc
)
2487 /* ignore cloning unless only a single crtc */
2488 if (fb_helper
->crtc_count
> 1)
2491 if (!drm_mode_equal(modes
[o
], modes
[n
]))
2496 memcpy(crtcs
, best_crtcs
, n
* sizeof(struct drm_fb_helper_crtc
*));
2497 score
= my_score
+ drm_pick_crtcs(fb_helper
, crtcs
, modes
, n
+ 1,
2499 if (score
> best_score
) {
2501 memcpy(best_crtcs
, crtcs
,
2502 fb_helper
->connector_count
*
2503 sizeof(struct drm_fb_helper_crtc
*));
2512 * This function checks if rotation is necessary because of panel orientation
2513 * and if it is, if it is supported.
2514 * If rotation is necessary and supported, it gets set in fb_crtc.rotation.
2515 * If rotation is necessary but not supported, a DRM_MODE_ROTATE_* flag gets
2516 * or-ed into fb_helper->sw_rotations. In drm_setup_crtcs_fb() we check if only
2517 * one bit is set and then we set fb_info.fbcon_rotate_hint to make fbcon do
2518 * the unsupported rotation.
2520 static void drm_setup_crtc_rotation(struct drm_fb_helper
*fb_helper
,
2521 struct drm_fb_helper_crtc
*fb_crtc
,
2522 struct drm_connector
*connector
)
2524 struct drm_plane
*plane
= fb_crtc
->mode_set
.crtc
->primary
;
2525 uint64_t valid_mask
= 0;
2528 fb_crtc
->rotation
= DRM_MODE_ROTATE_0
;
2530 switch (connector
->display_info
.panel_orientation
) {
2531 case DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP
:
2532 rotation
= DRM_MODE_ROTATE_180
;
2534 case DRM_MODE_PANEL_ORIENTATION_LEFT_UP
:
2535 rotation
= DRM_MODE_ROTATE_90
;
2537 case DRM_MODE_PANEL_ORIENTATION_RIGHT_UP
:
2538 rotation
= DRM_MODE_ROTATE_270
;
2541 rotation
= DRM_MODE_ROTATE_0
;
2545 * TODO: support 90 / 270 degree hardware rotation,
2546 * depending on the hardware this may require the framebuffer
2547 * to be in a specific tiling format.
2549 if (rotation
!= DRM_MODE_ROTATE_180
|| !plane
->rotation_property
) {
2550 fb_helper
->sw_rotations
|= rotation
;
2554 for (i
= 0; i
< plane
->rotation_property
->num_values
; i
++)
2555 valid_mask
|= (1ULL << plane
->rotation_property
->values
[i
]);
2557 if (!(rotation
& valid_mask
)) {
2558 fb_helper
->sw_rotations
|= rotation
;
2562 fb_crtc
->rotation
= rotation
;
2563 /* Rotating in hardware, fbcon should not rotate */
2564 fb_helper
->sw_rotations
|= DRM_MODE_ROTATE_0
;
2567 static void drm_setup_crtcs(struct drm_fb_helper
*fb_helper
,
2568 u32 width
, u32 height
)
2570 struct drm_device
*dev
= fb_helper
->dev
;
2571 struct drm_fb_helper_crtc
**crtcs
;
2572 struct drm_display_mode
**modes
;
2573 struct drm_fb_offset
*offsets
;
2577 DRM_DEBUG_KMS("\n");
2578 /* prevent concurrent modification of connector_count by hotplug */
2579 lockdep_assert_held(&fb_helper
->lock
);
2581 crtcs
= kcalloc(fb_helper
->connector_count
,
2582 sizeof(struct drm_fb_helper_crtc
*), GFP_KERNEL
);
2583 modes
= kcalloc(fb_helper
->connector_count
,
2584 sizeof(struct drm_display_mode
*), GFP_KERNEL
);
2585 offsets
= kcalloc(fb_helper
->connector_count
,
2586 sizeof(struct drm_fb_offset
), GFP_KERNEL
);
2587 enabled
= kcalloc(fb_helper
->connector_count
,
2588 sizeof(bool), GFP_KERNEL
);
2589 if (!crtcs
|| !modes
|| !enabled
|| !offsets
) {
2590 DRM_ERROR("Memory allocation failed\n");
2594 mutex_lock(&fb_helper
->dev
->mode_config
.mutex
);
2595 if (drm_fb_helper_probe_connector_modes(fb_helper
, width
, height
) == 0)
2596 DRM_DEBUG_KMS("No connectors reported connected with modes\n");
2597 drm_enable_connectors(fb_helper
, enabled
);
2599 if (!(fb_helper
->funcs
->initial_config
&&
2600 fb_helper
->funcs
->initial_config(fb_helper
, crtcs
, modes
,
2602 enabled
, width
, height
))) {
2603 memset(modes
, 0, fb_helper
->connector_count
*sizeof(modes
[0]));
2604 memset(crtcs
, 0, fb_helper
->connector_count
*sizeof(crtcs
[0]));
2605 memset(offsets
, 0, fb_helper
->connector_count
*sizeof(offsets
[0]));
2607 if (!drm_target_cloned(fb_helper
, modes
, offsets
,
2608 enabled
, width
, height
) &&
2609 !drm_target_preferred(fb_helper
, modes
, offsets
,
2610 enabled
, width
, height
))
2611 DRM_ERROR("Unable to find initial modes\n");
2613 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2616 drm_pick_crtcs(fb_helper
, crtcs
, modes
, 0, width
, height
);
2618 mutex_unlock(&fb_helper
->dev
->mode_config
.mutex
);
2620 /* need to set the modesets up here for use later */
2621 /* fill out the connector<->crtc mappings into the modesets */
2622 for (i
= 0; i
< fb_helper
->crtc_count
; i
++)
2623 drm_fb_helper_modeset_release(fb_helper
,
2624 &fb_helper
->crtc_info
[i
].mode_set
);
2626 fb_helper
->sw_rotations
= 0;
2627 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2628 struct drm_display_mode
*mode
= modes
[i
];
2629 struct drm_fb_helper_crtc
*fb_crtc
= crtcs
[i
];
2630 struct drm_fb_offset
*offset
= &offsets
[i
];
2632 if (mode
&& fb_crtc
) {
2633 struct drm_mode_set
*modeset
= &fb_crtc
->mode_set
;
2634 struct drm_connector
*connector
=
2635 fb_helper
->connector_info
[i
]->connector
;
2637 DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2638 mode
->name
, fb_crtc
->mode_set
.crtc
->base
.id
, offset
->x
, offset
->y
);
2640 fb_crtc
->desired_mode
= mode
;
2641 fb_crtc
->x
= offset
->x
;
2642 fb_crtc
->y
= offset
->y
;
2643 modeset
->mode
= drm_mode_duplicate(dev
,
2644 fb_crtc
->desired_mode
);
2645 drm_connector_get(connector
);
2646 drm_setup_crtc_rotation(fb_helper
, fb_crtc
, connector
);
2647 modeset
->connectors
[modeset
->num_connectors
++] = connector
;
2648 modeset
->x
= offset
->x
;
2649 modeset
->y
= offset
->y
;
2660 * This is a continuation of drm_setup_crtcs() that sets up anything related
2661 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
2662 * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
2663 * So, any setup that touches those fields needs to be done here instead of in
2664 * drm_setup_crtcs().
2666 static void drm_setup_crtcs_fb(struct drm_fb_helper
*fb_helper
)
2668 struct fb_info
*info
= fb_helper
->fbdev
;
2671 for (i
= 0; i
< fb_helper
->crtc_count
; i
++)
2672 if (fb_helper
->crtc_info
[i
].mode_set
.num_connectors
)
2673 fb_helper
->crtc_info
[i
].mode_set
.fb
= fb_helper
->fb
;
2675 mutex_lock(&fb_helper
->dev
->mode_config
.mutex
);
2676 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2677 struct drm_connector
*connector
=
2678 fb_helper
->connector_info
[i
]->connector
;
2680 /* use first connected connector for the physical dimensions */
2681 if (connector
->status
== connector_status_connected
) {
2682 info
->var
.width
= connector
->display_info
.width_mm
;
2683 info
->var
.height
= connector
->display_info
.height_mm
;
2687 mutex_unlock(&fb_helper
->dev
->mode_config
.mutex
);
2689 switch (fb_helper
->sw_rotations
) {
2690 case DRM_MODE_ROTATE_0
:
2691 info
->fbcon_rotate_hint
= FB_ROTATE_UR
;
2693 case DRM_MODE_ROTATE_90
:
2694 info
->fbcon_rotate_hint
= FB_ROTATE_CCW
;
2696 case DRM_MODE_ROTATE_180
:
2697 info
->fbcon_rotate_hint
= FB_ROTATE_UD
;
2699 case DRM_MODE_ROTATE_270
:
2700 info
->fbcon_rotate_hint
= FB_ROTATE_CW
;
2704 * Multiple bits are set / multiple rotations requested
2705 * fbcon cannot handle separate rotation settings per
2706 * output, so fallback to unrotated.
2708 info
->fbcon_rotate_hint
= FB_ROTATE_UR
;
2712 /* Note: Drops fb_helper->lock before returning. */
2714 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper
*fb_helper
,
2717 struct drm_device
*dev
= fb_helper
->dev
;
2718 struct fb_info
*info
;
2719 unsigned int width
, height
;
2722 width
= dev
->mode_config
.max_width
;
2723 height
= dev
->mode_config
.max_height
;
2725 drm_setup_crtcs(fb_helper
, width
, height
);
2726 ret
= drm_fb_helper_single_fb_probe(fb_helper
, bpp_sel
);
2728 if (ret
== -EAGAIN
) {
2729 fb_helper
->preferred_bpp
= bpp_sel
;
2730 fb_helper
->deferred_setup
= true;
2733 mutex_unlock(&fb_helper
->lock
);
2737 drm_setup_crtcs_fb(fb_helper
);
2739 fb_helper
->deferred_setup
= false;
2741 info
= fb_helper
->fbdev
;
2742 info
->var
.pixclock
= 0;
2743 /* Shamelessly allow physical address leaking to userspace */
2744 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
2745 if (!drm_leak_fbdev_smem
)
2747 /* don't leak any physical addresses to userspace */
2748 info
->flags
|= FBINFO_HIDE_SMEM_START
;
2750 /* Need to drop locks to avoid recursive deadlock in
2751 * register_framebuffer. This is ok because the only thing left to do is
2752 * register the fbdev emulation instance in kernel_fb_helper_list. */
2753 mutex_unlock(&fb_helper
->lock
);
2755 ret
= register_framebuffer(info
);
2759 dev_info(dev
->dev
, "fb%d: %s frame buffer device\n",
2760 info
->node
, info
->fix
.id
);
2762 mutex_lock(&kernel_fb_helper_lock
);
2763 if (list_empty(&kernel_fb_helper_list
))
2764 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op
);
2766 list_add(&fb_helper
->kernel_fb_list
, &kernel_fb_helper_list
);
2767 mutex_unlock(&kernel_fb_helper_lock
);
2773 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2774 * @fb_helper: fb_helper device struct
2775 * @bpp_sel: bpp value to use for the framebuffer configuration
2777 * Scans the CRTCs and connectors and tries to put together an initial setup.
2778 * At the moment, this is a cloned configuration across all heads with
2779 * a new framebuffer object as the backing store.
2781 * Note that this also registers the fbdev and so allows userspace to call into
2782 * the driver through the fbdev interfaces.
2784 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
2785 * to let the driver allocate and initialize the fbdev info structure and the
2786 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2787 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2788 * values for the fbdev info structure.
2792 * When you have fbcon support built-in or already loaded, this function will do
2793 * a full modeset to setup the fbdev console. Due to locking misdesign in the
2794 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2795 * console_lock. Until console_unlock is called no dmesg lines will be sent out
2796 * to consoles, not even serial console. This means when your driver crashes,
2797 * you will see absolutely nothing else but a system stuck in this function,
2798 * with no further output. Any kind of printk() you place within your own driver
2799 * or in the drm core modeset code will also never show up.
2801 * Standard debug practice is to run the fbcon setup without taking the
2802 * console_lock as a hack, to be able to see backtraces and crashes on the
2803 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2806 * The other option is to just disable fbdev emulation since very likely the
2807 * first modeset from userspace will crash in the same way, and is even easier
2808 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2809 * kernel cmdline option.
2812 * Zero if everything went ok, nonzero otherwise.
2814 int drm_fb_helper_initial_config(struct drm_fb_helper
*fb_helper
, int bpp_sel
)
2818 if (!drm_fbdev_emulation
)
2821 mutex_lock(&fb_helper
->lock
);
2822 ret
= __drm_fb_helper_initial_config_and_unlock(fb_helper
, bpp_sel
);
2826 EXPORT_SYMBOL(drm_fb_helper_initial_config
);
2829 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2830 * probing all the outputs attached to the fb
2831 * @fb_helper: driver-allocated fbdev helper, can be NULL
2833 * Scan the connectors attached to the fb_helper and try to put together a
2834 * setup after notification of a change in output configuration.
2836 * Called at runtime, takes the mode config locks to be able to check/change the
2837 * modeset configuration. Must be run from process context (which usually means
2838 * either the output polling work or a work item launched from the driver's
2839 * hotplug interrupt).
2841 * Note that drivers may call this even before calling
2842 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2843 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2844 * not miss any hotplug events.
2847 * 0 on success and a non-zero error code otherwise.
2849 int drm_fb_helper_hotplug_event(struct drm_fb_helper
*fb_helper
)
2853 if (!drm_fbdev_emulation
|| !fb_helper
)
2856 mutex_lock(&fb_helper
->lock
);
2857 if (fb_helper
->deferred_setup
) {
2858 err
= __drm_fb_helper_initial_config_and_unlock(fb_helper
,
2859 fb_helper
->preferred_bpp
);
2863 if (!fb_helper
->fb
|| !drm_fb_helper_is_bound(fb_helper
)) {
2864 fb_helper
->delayed_hotplug
= true;
2865 mutex_unlock(&fb_helper
->lock
);
2869 DRM_DEBUG_KMS("\n");
2871 drm_setup_crtcs(fb_helper
, fb_helper
->fb
->width
, fb_helper
->fb
->height
);
2872 drm_setup_crtcs_fb(fb_helper
);
2873 mutex_unlock(&fb_helper
->lock
);
2875 drm_fb_helper_set_par(fb_helper
->fbdev
);
2879 EXPORT_SYMBOL(drm_fb_helper_hotplug_event
);
2882 * drm_fb_helper_fbdev_setup() - Setup fbdev emulation
2884 * @fb_helper: fbdev helper structure to set up
2885 * @funcs: fbdev helper functions
2886 * @preferred_bpp: Preferred bits per pixel for the device.
2887 * @dev->mode_config.preferred_depth is used if this is zero.
2888 * @max_conn_count: Maximum number of connectors.
2889 * @dev->mode_config.num_connector is used if this is zero.
2891 * This function sets up fbdev emulation and registers fbdev for access by
2892 * userspace. If all connectors are disconnected, setup is deferred to the next
2893 * time drm_fb_helper_hotplug_event() is called.
2894 * The caller must to provide a &drm_fb_helper_funcs->fb_probe callback
2897 * Use drm_fb_helper_fbdev_teardown() to destroy the fbdev.
2899 * See also: drm_fb_helper_initial_config(), drm_fbdev_generic_setup().
2902 * Zero on success or negative error code on failure.
2904 int drm_fb_helper_fbdev_setup(struct drm_device
*dev
,
2905 struct drm_fb_helper
*fb_helper
,
2906 const struct drm_fb_helper_funcs
*funcs
,
2907 unsigned int preferred_bpp
,
2908 unsigned int max_conn_count
)
2913 preferred_bpp
= dev
->mode_config
.preferred_depth
;
2917 if (!max_conn_count
)
2918 max_conn_count
= dev
->mode_config
.num_connector
;
2919 if (!max_conn_count
) {
2920 DRM_DEV_ERROR(dev
->dev
, "fbdev: No connectors\n");
2924 drm_fb_helper_prepare(dev
, fb_helper
, funcs
);
2926 ret
= drm_fb_helper_init(dev
, fb_helper
, max_conn_count
);
2928 DRM_DEV_ERROR(dev
->dev
, "fbdev: Failed to initialize (ret=%d)\n", ret
);
2932 ret
= drm_fb_helper_single_add_all_connectors(fb_helper
);
2934 DRM_DEV_ERROR(dev
->dev
, "fbdev: Failed to add connectors (ret=%d)\n", ret
);
2935 goto err_drm_fb_helper_fini
;
2938 if (!drm_drv_uses_atomic_modeset(dev
))
2939 drm_helper_disable_unused_functions(dev
);
2941 ret
= drm_fb_helper_initial_config(fb_helper
, preferred_bpp
);
2943 DRM_DEV_ERROR(dev
->dev
, "fbdev: Failed to set configuration (ret=%d)\n", ret
);
2944 goto err_drm_fb_helper_fini
;
2949 err_drm_fb_helper_fini
:
2950 drm_fb_helper_fbdev_teardown(dev
);
2954 EXPORT_SYMBOL(drm_fb_helper_fbdev_setup
);
2957 * drm_fb_helper_fbdev_teardown - Tear down fbdev emulation
2960 * This function unregisters fbdev if not already done and cleans up the
2961 * associated resources including the &drm_framebuffer.
2962 * The driver is responsible for freeing the &drm_fb_helper structure which is
2963 * stored in &drm_device->fb_helper. Do note that this pointer has been cleared
2964 * when this function returns.
2966 * In order to support device removal/unplug while file handles are still open,
2967 * drm_fb_helper_unregister_fbi() should be called on device removal and
2968 * drm_fb_helper_fbdev_teardown() in the &drm_driver->release callback when
2969 * file handles are closed.
2971 void drm_fb_helper_fbdev_teardown(struct drm_device
*dev
)
2973 struct drm_fb_helper
*fb_helper
= dev
->fb_helper
;
2974 struct fb_ops
*fbops
= NULL
;
2979 /* Unregister if it hasn't been done already */
2980 if (fb_helper
->fbdev
&& fb_helper
->fbdev
->dev
)
2981 drm_fb_helper_unregister_fbi(fb_helper
);
2983 if (fb_helper
->fbdev
&& fb_helper
->fbdev
->fbdefio
) {
2984 fb_deferred_io_cleanup(fb_helper
->fbdev
);
2985 kfree(fb_helper
->fbdev
->fbdefio
);
2986 fbops
= fb_helper
->fbdev
->fbops
;
2989 drm_fb_helper_fini(fb_helper
);
2993 drm_framebuffer_remove(fb_helper
->fb
);
2995 EXPORT_SYMBOL(drm_fb_helper_fbdev_teardown
);
2998 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
3001 * This function can be used as the &drm_driver->lastclose callback for drivers
3002 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
3004 void drm_fb_helper_lastclose(struct drm_device
*dev
)
3006 drm_fb_helper_restore_fbdev_mode_unlocked(dev
->fb_helper
);
3008 EXPORT_SYMBOL(drm_fb_helper_lastclose
);
3011 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
3012 * helper for fbdev emulation
3015 * This function can be used as the
3016 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
3017 * need to call drm_fb_helper_hotplug_event().
3019 void drm_fb_helper_output_poll_changed(struct drm_device
*dev
)
3021 drm_fb_helper_hotplug_event(dev
->fb_helper
);
3023 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed
);
3025 /* @user: 1=userspace, 0=fbcon */
3026 static int drm_fbdev_fb_open(struct fb_info
*info
, int user
)
3028 struct drm_fb_helper
*fb_helper
= info
->par
;
3030 /* No need to take a ref for fbcon because it unbinds on unregister */
3031 if (user
&& !try_module_get(fb_helper
->dev
->driver
->fops
->owner
))
3037 static int drm_fbdev_fb_release(struct fb_info
*info
, int user
)
3039 struct drm_fb_helper
*fb_helper
= info
->par
;
3042 module_put(fb_helper
->dev
->driver
->fops
->owner
);
3047 static void drm_fbdev_cleanup(struct drm_fb_helper
*fb_helper
)
3049 struct fb_info
*fbi
= fb_helper
->fbdev
;
3050 struct fb_ops
*fbops
= NULL
;
3051 void *shadow
= NULL
;
3053 if (!fb_helper
->dev
)
3056 if (fbi
&& fbi
->fbdefio
) {
3057 fb_deferred_io_cleanup(fbi
);
3058 shadow
= fbi
->screen_buffer
;
3062 drm_fb_helper_fini(fb_helper
);
3069 drm_client_framebuffer_delete(fb_helper
->buffer
);
3072 static void drm_fbdev_release(struct drm_fb_helper
*fb_helper
)
3074 drm_fbdev_cleanup(fb_helper
);
3075 drm_client_release(&fb_helper
->client
);
3080 * fb_ops.fb_destroy is called by the last put_fb_info() call at the end of
3081 * unregister_framebuffer() or fb_release().
3083 static void drm_fbdev_fb_destroy(struct fb_info
*info
)
3085 drm_fbdev_release(info
->par
);
3088 static int drm_fbdev_fb_mmap(struct fb_info
*info
, struct vm_area_struct
*vma
)
3090 struct drm_fb_helper
*fb_helper
= info
->par
;
3092 if (fb_helper
->dev
->driver
->gem_prime_mmap
)
3093 return fb_helper
->dev
->driver
->gem_prime_mmap(fb_helper
->buffer
->gem
, vma
);
3098 static struct fb_ops drm_fbdev_fb_ops
= {
3099 .owner
= THIS_MODULE
,
3100 DRM_FB_HELPER_DEFAULT_OPS
,
3101 .fb_open
= drm_fbdev_fb_open
,
3102 .fb_release
= drm_fbdev_fb_release
,
3103 .fb_destroy
= drm_fbdev_fb_destroy
,
3104 .fb_mmap
= drm_fbdev_fb_mmap
,
3105 .fb_read
= drm_fb_helper_sys_read
,
3106 .fb_write
= drm_fb_helper_sys_write
,
3107 .fb_fillrect
= drm_fb_helper_sys_fillrect
,
3108 .fb_copyarea
= drm_fb_helper_sys_copyarea
,
3109 .fb_imageblit
= drm_fb_helper_sys_imageblit
,
3112 static struct fb_deferred_io drm_fbdev_defio
= {
3114 .deferred_io
= drm_fb_helper_deferred_io
,
3118 * drm_fb_helper_generic_probe - Generic fbdev emulation probe helper
3119 * @fb_helper: fbdev helper structure
3120 * @sizes: describes fbdev size and scanout surface size
3122 * This function uses the client API to create a framebuffer backed by a dumb buffer.
3124 * The _sys_ versions are used for &fb_ops.fb_read, fb_write, fb_fillrect,
3125 * fb_copyarea, fb_imageblit.
3128 * Zero on success or negative error code on failure.
3130 int drm_fb_helper_generic_probe(struct drm_fb_helper
*fb_helper
,
3131 struct drm_fb_helper_surface_size
*sizes
)
3133 struct drm_client_dev
*client
= &fb_helper
->client
;
3134 struct drm_client_buffer
*buffer
;
3135 struct drm_framebuffer
*fb
;
3136 struct fb_info
*fbi
;
3139 DRM_DEBUG_KMS("surface width(%d), height(%d) and bpp(%d)\n",
3140 sizes
->surface_width
, sizes
->surface_height
,
3141 sizes
->surface_bpp
);
3143 format
= drm_mode_legacy_fb_format(sizes
->surface_bpp
, sizes
->surface_depth
);
3144 buffer
= drm_client_framebuffer_create(client
, sizes
->surface_width
,
3145 sizes
->surface_height
, format
);
3147 return PTR_ERR(buffer
);
3149 fb_helper
->buffer
= buffer
;
3150 fb_helper
->fb
= buffer
->fb
;
3153 fbi
= drm_fb_helper_alloc_fbi(fb_helper
);
3155 return PTR_ERR(fbi
);
3157 fbi
->fbops
= &drm_fbdev_fb_ops
;
3158 fbi
->screen_size
= fb
->height
* fb
->pitches
[0];
3159 fbi
->fix
.smem_len
= fbi
->screen_size
;
3160 fbi
->screen_buffer
= buffer
->vaddr
;
3161 /* Shamelessly leak the physical address to user-space */
3162 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
3163 if (drm_leak_fbdev_smem
&& fbi
->fix
.smem_start
== 0)
3164 fbi
->fix
.smem_start
=
3165 page_to_phys(virt_to_page(fbi
->screen_buffer
));
3167 drm_fb_helper_fill_info(fbi
, fb_helper
, sizes
);
3169 if (fb
->funcs
->dirty
) {
3170 struct fb_ops
*fbops
;
3174 * fb_deferred_io_cleanup() clears &fbops->fb_mmap so a per
3175 * instance version is necessary.
3177 fbops
= kzalloc(sizeof(*fbops
), GFP_KERNEL
);
3178 shadow
= vzalloc(fbi
->screen_size
);
3179 if (!fbops
|| !shadow
) {
3185 *fbops
= *fbi
->fbops
;
3187 fbi
->screen_buffer
= shadow
;
3188 fbi
->fbdefio
= &drm_fbdev_defio
;
3190 fb_deferred_io_init(fbi
);
3195 EXPORT_SYMBOL(drm_fb_helper_generic_probe
);
3197 static const struct drm_fb_helper_funcs drm_fb_helper_generic_funcs
= {
3198 .fb_probe
= drm_fb_helper_generic_probe
,
3201 static void drm_fbdev_client_unregister(struct drm_client_dev
*client
)
3203 struct drm_fb_helper
*fb_helper
= drm_fb_helper_from_client(client
);
3205 if (fb_helper
->fbdev
)
3206 /* drm_fbdev_fb_destroy() takes care of cleanup */
3207 drm_fb_helper_unregister_fbi(fb_helper
);
3209 drm_fbdev_release(fb_helper
);
3212 static int drm_fbdev_client_restore(struct drm_client_dev
*client
)
3214 drm_fb_helper_lastclose(client
->dev
);
3219 static int drm_fbdev_client_hotplug(struct drm_client_dev
*client
)
3221 struct drm_fb_helper
*fb_helper
= drm_fb_helper_from_client(client
);
3222 struct drm_device
*dev
= client
->dev
;
3225 /* Setup is not retried if it has failed */
3226 if (!fb_helper
->dev
&& fb_helper
->funcs
)
3230 return drm_fb_helper_hotplug_event(dev
->fb_helper
);
3232 if (!dev
->mode_config
.num_connector
) {
3233 DRM_DEV_DEBUG(dev
->dev
, "No connectors found, will not create framebuffer!\n");
3237 drm_fb_helper_prepare(dev
, fb_helper
, &drm_fb_helper_generic_funcs
);
3239 ret
= drm_fb_helper_init(dev
, fb_helper
, dev
->mode_config
.num_connector
);
3243 ret
= drm_fb_helper_single_add_all_connectors(fb_helper
);
3247 if (!drm_drv_uses_atomic_modeset(dev
))
3248 drm_helper_disable_unused_functions(dev
);
3250 ret
= drm_fb_helper_initial_config(fb_helper
, fb_helper
->preferred_bpp
);
3257 drm_fbdev_cleanup(fb_helper
);
3259 fb_helper
->dev
= NULL
;
3260 fb_helper
->fbdev
= NULL
;
3262 DRM_DEV_ERROR(dev
->dev
, "fbdev: Failed to setup generic emulation (ret=%d)\n", ret
);
3267 static const struct drm_client_funcs drm_fbdev_client_funcs
= {
3268 .owner
= THIS_MODULE
,
3269 .unregister
= drm_fbdev_client_unregister
,
3270 .restore
= drm_fbdev_client_restore
,
3271 .hotplug
= drm_fbdev_client_hotplug
,
3275 * drm_fbdev_generic_setup() - Setup generic fbdev emulation
3277 * @preferred_bpp: Preferred bits per pixel for the device.
3278 * @dev->mode_config.preferred_depth is used if this is zero.
3280 * This function sets up generic fbdev emulation for drivers that supports
3281 * dumb buffers with a virtual address and that can be mmap'ed. If the driver
3282 * does not support these functions, it could use drm_fb_helper_fbdev_setup().
3284 * Restore, hotplug events and teardown are all taken care of. Drivers that do
3285 * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves.
3286 * Simple drivers might use drm_mode_config_helper_suspend().
3288 * Drivers that set the dirty callback on their framebuffer will get a shadow
3289 * fbdev buffer that is blitted onto the real buffer. This is done in order to
3290 * make deferred I/O work with all kinds of buffers.
3292 * This function is safe to call even when there are no connectors present.
3293 * Setup will be retried on the next hotplug event.
3295 * The fbdev is destroyed by drm_dev_unregister().
3298 * Zero on success or negative error code on failure.
3300 int drm_fbdev_generic_setup(struct drm_device
*dev
, unsigned int preferred_bpp
)
3302 struct drm_fb_helper
*fb_helper
;
3305 WARN(dev
->fb_helper
, "fb_helper is already set!\n");
3307 if (!drm_fbdev_emulation
)
3310 fb_helper
= kzalloc(sizeof(*fb_helper
), GFP_KERNEL
);
3314 ret
= drm_client_init(dev
, &fb_helper
->client
, "fbdev", &drm_fbdev_client_funcs
);
3317 DRM_DEV_ERROR(dev
->dev
, "Failed to register client: %d\n", ret
);
3321 drm_client_add(&fb_helper
->client
);
3324 preferred_bpp
= dev
->mode_config
.preferred_depth
;
3327 fb_helper
->preferred_bpp
= preferred_bpp
;
3329 ret
= drm_fbdev_client_hotplug(&fb_helper
->client
);
3331 DRM_DEV_DEBUG(dev
->dev
, "client hotplug ret=%d\n", ret
);
3335 EXPORT_SYMBOL(drm_fbdev_generic_setup
);
3337 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
3338 * but the module doesn't depend on any fb console symbols. At least
3339 * attempt to load fbcon to avoid leaving the system without a usable console.
3341 int __init
drm_fb_helper_modinit(void)
3343 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
3344 const char name
[] = "fbcon";
3345 struct module
*fbcon
;
3347 mutex_lock(&module_mutex
);
3348 fbcon
= find_module(name
);
3349 mutex_unlock(&module_mutex
);
3352 request_module_nowait(name
);
3356 EXPORT_SYMBOL(drm_fb_helper_modinit
);