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(fbdev_emulation
,
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 ret
= __drm_fb_helper_add_one_connector(fb_helper
, connector
);
229 drm_fb_helper_for_each_connector(fb_helper
, i
) {
230 struct drm_fb_helper_connector
*fb_helper_connector
=
231 fb_helper
->connector_info
[i
];
233 drm_connector_put(fb_helper_connector
->connector
);
235 kfree(fb_helper_connector
);
236 fb_helper
->connector_info
[i
] = NULL
;
238 fb_helper
->connector_count
= 0;
240 drm_connector_list_iter_end(&conn_iter
);
241 mutex_unlock(&fb_helper
->lock
);
245 EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors
);
247 static int __drm_fb_helper_remove_one_connector(struct drm_fb_helper
*fb_helper
,
248 struct drm_connector
*connector
)
250 struct drm_fb_helper_connector
*fb_helper_connector
;
253 if (!drm_fbdev_emulation
)
256 lockdep_assert_held(&fb_helper
->lock
);
258 drm_fb_helper_for_each_connector(fb_helper
, i
) {
259 if (fb_helper
->connector_info
[i
]->connector
== connector
)
263 if (i
== fb_helper
->connector_count
)
265 fb_helper_connector
= fb_helper
->connector_info
[i
];
266 drm_connector_put(fb_helper_connector
->connector
);
268 for (j
= i
+ 1; j
< fb_helper
->connector_count
; j
++)
269 fb_helper
->connector_info
[j
- 1] = fb_helper
->connector_info
[j
];
271 fb_helper
->connector_count
--;
272 kfree(fb_helper_connector
);
277 int drm_fb_helper_remove_one_connector(struct drm_fb_helper
*fb_helper
,
278 struct drm_connector
*connector
)
285 mutex_lock(&fb_helper
->lock
);
286 err
= __drm_fb_helper_remove_one_connector(fb_helper
, connector
);
287 mutex_unlock(&fb_helper
->lock
);
291 EXPORT_SYMBOL(drm_fb_helper_remove_one_connector
);
293 static void drm_fb_helper_restore_lut_atomic(struct drm_crtc
*crtc
)
295 uint16_t *r_base
, *g_base
, *b_base
;
297 if (crtc
->funcs
->gamma_set
== NULL
)
300 r_base
= crtc
->gamma_store
;
301 g_base
= r_base
+ crtc
->gamma_size
;
302 b_base
= g_base
+ crtc
->gamma_size
;
304 crtc
->funcs
->gamma_set(crtc
, r_base
, g_base
, b_base
,
305 crtc
->gamma_size
, NULL
);
309 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
310 * @info: fbdev registered by the helper
312 int drm_fb_helper_debug_enter(struct fb_info
*info
)
314 struct drm_fb_helper
*helper
= info
->par
;
315 const struct drm_crtc_helper_funcs
*funcs
;
318 list_for_each_entry(helper
, &kernel_fb_helper_list
, kernel_fb_list
) {
319 for (i
= 0; i
< helper
->crtc_count
; i
++) {
320 struct drm_mode_set
*mode_set
=
321 &helper
->crtc_info
[i
].mode_set
;
323 if (!mode_set
->crtc
->enabled
)
326 funcs
= mode_set
->crtc
->helper_private
;
327 if (funcs
->mode_set_base_atomic
== NULL
)
330 if (drm_drv_uses_atomic_modeset(mode_set
->crtc
->dev
))
333 funcs
->mode_set_base_atomic(mode_set
->crtc
,
337 ENTER_ATOMIC_MODE_SET
);
343 EXPORT_SYMBOL(drm_fb_helper_debug_enter
);
346 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
347 * @info: fbdev registered by the helper
349 int drm_fb_helper_debug_leave(struct fb_info
*info
)
351 struct drm_fb_helper
*helper
= info
->par
;
352 struct drm_crtc
*crtc
;
353 const struct drm_crtc_helper_funcs
*funcs
;
354 struct drm_framebuffer
*fb
;
357 for (i
= 0; i
< helper
->crtc_count
; i
++) {
358 struct drm_mode_set
*mode_set
= &helper
->crtc_info
[i
].mode_set
;
360 crtc
= mode_set
->crtc
;
361 if (drm_drv_uses_atomic_modeset(crtc
->dev
))
364 funcs
= crtc
->helper_private
;
365 fb
= crtc
->primary
->fb
;
371 DRM_ERROR("no fb to restore??\n");
375 if (funcs
->mode_set_base_atomic
== NULL
)
378 drm_fb_helper_restore_lut_atomic(mode_set
->crtc
);
379 funcs
->mode_set_base_atomic(mode_set
->crtc
, fb
, crtc
->x
,
380 crtc
->y
, LEAVE_ATOMIC_MODE_SET
);
385 EXPORT_SYMBOL(drm_fb_helper_debug_leave
);
387 static int restore_fbdev_mode_atomic(struct drm_fb_helper
*fb_helper
, bool active
)
389 struct drm_device
*dev
= fb_helper
->dev
;
390 struct drm_plane_state
*plane_state
;
391 struct drm_plane
*plane
;
392 struct drm_atomic_state
*state
;
394 struct drm_modeset_acquire_ctx ctx
;
396 drm_modeset_acquire_init(&ctx
, 0);
398 state
= drm_atomic_state_alloc(dev
);
404 state
->acquire_ctx
= &ctx
;
406 drm_for_each_plane(plane
, dev
) {
407 plane_state
= drm_atomic_get_plane_state(state
, plane
);
408 if (IS_ERR(plane_state
)) {
409 ret
= PTR_ERR(plane_state
);
413 plane_state
->rotation
= DRM_MODE_ROTATE_0
;
415 /* disable non-primary: */
416 if (plane
->type
== DRM_PLANE_TYPE_PRIMARY
)
419 ret
= __drm_atomic_helper_disable_plane(plane
, plane_state
);
424 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
425 struct drm_mode_set
*mode_set
= &fb_helper
->crtc_info
[i
].mode_set
;
426 struct drm_plane
*primary
= mode_set
->crtc
->primary
;
428 /* Cannot fail as we've already gotten the plane state above */
429 plane_state
= drm_atomic_get_new_plane_state(state
, primary
);
430 plane_state
->rotation
= fb_helper
->crtc_info
[i
].rotation
;
432 ret
= __drm_atomic_helper_set_config(mode_set
, state
);
437 * __drm_atomic_helper_set_config() sets active when a
438 * mode is set, unconditionally clear it if we force DPMS off
441 struct drm_crtc
*crtc
= mode_set
->crtc
;
442 struct drm_crtc_state
*crtc_state
= drm_atomic_get_new_crtc_state(state
, crtc
);
444 crtc_state
->active
= false;
448 ret
= drm_atomic_commit(state
);
454 drm_atomic_state_put(state
);
456 drm_modeset_drop_locks(&ctx
);
457 drm_modeset_acquire_fini(&ctx
);
462 drm_atomic_state_clear(state
);
463 drm_modeset_backoff(&ctx
);
468 static int restore_fbdev_mode_legacy(struct drm_fb_helper
*fb_helper
)
470 struct drm_device
*dev
= fb_helper
->dev
;
471 struct drm_plane
*plane
;
474 drm_modeset_lock_all(fb_helper
->dev
);
475 drm_for_each_plane(plane
, dev
) {
476 if (plane
->type
!= DRM_PLANE_TYPE_PRIMARY
)
477 drm_plane_force_disable(plane
);
479 if (plane
->rotation_property
)
480 drm_mode_plane_set_obj_prop(plane
,
481 plane
->rotation_property
,
485 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
486 struct drm_mode_set
*mode_set
= &fb_helper
->crtc_info
[i
].mode_set
;
487 struct drm_crtc
*crtc
= mode_set
->crtc
;
489 if (crtc
->funcs
->cursor_set2
) {
490 ret
= crtc
->funcs
->cursor_set2(crtc
, NULL
, 0, 0, 0, 0, 0);
493 } else if (crtc
->funcs
->cursor_set
) {
494 ret
= crtc
->funcs
->cursor_set(crtc
, NULL
, 0, 0, 0);
499 ret
= drm_mode_set_config_internal(mode_set
);
504 drm_modeset_unlock_all(fb_helper
->dev
);
509 static int restore_fbdev_mode(struct drm_fb_helper
*fb_helper
)
511 struct drm_device
*dev
= fb_helper
->dev
;
513 if (drm_drv_uses_atomic_modeset(dev
))
514 return restore_fbdev_mode_atomic(fb_helper
, true);
516 return restore_fbdev_mode_legacy(fb_helper
);
520 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
521 * @fb_helper: driver-allocated fbdev helper, can be NULL
523 * This should be called from driver's drm &drm_driver.lastclose callback
524 * when implementing an fbcon on top of kms using this helper. This ensures that
525 * the user isn't greeted with a black screen when e.g. X dies.
528 * Zero if everything went ok, negative error code otherwise.
530 int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper
*fb_helper
)
535 if (!drm_fbdev_emulation
|| !fb_helper
)
538 if (READ_ONCE(fb_helper
->deferred_setup
))
541 mutex_lock(&fb_helper
->lock
);
542 ret
= restore_fbdev_mode(fb_helper
);
544 do_delayed
= fb_helper
->delayed_hotplug
;
546 fb_helper
->delayed_hotplug
= false;
547 mutex_unlock(&fb_helper
->lock
);
550 drm_fb_helper_hotplug_event(fb_helper
);
554 EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked
);
556 static bool drm_fb_helper_is_bound(struct drm_fb_helper
*fb_helper
)
558 struct drm_device
*dev
= fb_helper
->dev
;
559 struct drm_crtc
*crtc
;
560 int bound
= 0, crtcs_bound
= 0;
563 * Sometimes user space wants everything disabled, so don't steal the
564 * display if there's a master.
566 if (READ_ONCE(dev
->master
))
569 drm_for_each_crtc(crtc
, dev
) {
570 drm_modeset_lock(&crtc
->mutex
, NULL
);
571 if (crtc
->primary
->fb
)
573 if (crtc
->primary
->fb
== fb_helper
->fb
)
575 drm_modeset_unlock(&crtc
->mutex
);
578 if (bound
< crtcs_bound
)
584 #ifdef CONFIG_MAGIC_SYSRQ
586 * restore fbcon display for all kms driver's using this helper, used for sysrq
587 * and panic handling.
589 static bool drm_fb_helper_force_kernel_mode(void)
591 bool ret
, error
= false;
592 struct drm_fb_helper
*helper
;
594 if (list_empty(&kernel_fb_helper_list
))
597 list_for_each_entry(helper
, &kernel_fb_helper_list
, kernel_fb_list
) {
598 struct drm_device
*dev
= helper
->dev
;
600 if (dev
->switch_power_state
== DRM_SWITCH_POWER_OFF
)
603 mutex_lock(&helper
->lock
);
604 ret
= restore_fbdev_mode(helper
);
607 mutex_unlock(&helper
->lock
);
612 static void drm_fb_helper_restore_work_fn(struct work_struct
*ignored
)
616 ret
= drm_fb_helper_force_kernel_mode();
618 DRM_ERROR("Failed to restore crtc configuration\n");
620 static DECLARE_WORK(drm_fb_helper_restore_work
, drm_fb_helper_restore_work_fn
);
622 static void drm_fb_helper_sysrq(int dummy1
)
624 schedule_work(&drm_fb_helper_restore_work
);
627 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op
= {
628 .handler
= drm_fb_helper_sysrq
,
629 .help_msg
= "force-fb(V)",
630 .action_msg
= "Restore framebuffer console",
633 static struct sysrq_key_op sysrq_drm_fb_helper_restore_op
= { };
636 static void dpms_legacy(struct drm_fb_helper
*fb_helper
, int dpms_mode
)
638 struct drm_device
*dev
= fb_helper
->dev
;
639 struct drm_crtc
*crtc
;
640 struct drm_connector
*connector
;
643 drm_modeset_lock_all(dev
);
644 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
645 crtc
= fb_helper
->crtc_info
[i
].mode_set
.crtc
;
650 /* Walk the connectors & encoders on this fb turning them on/off */
651 drm_fb_helper_for_each_connector(fb_helper
, j
) {
652 connector
= fb_helper
->connector_info
[j
]->connector
;
653 connector
->funcs
->dpms(connector
, dpms_mode
);
654 drm_object_property_set_value(&connector
->base
,
655 dev
->mode_config
.dpms_property
, dpms_mode
);
658 drm_modeset_unlock_all(dev
);
661 static void drm_fb_helper_dpms(struct fb_info
*info
, int dpms_mode
)
663 struct drm_fb_helper
*fb_helper
= info
->par
;
666 * For each CRTC in this fb, turn the connectors on/off.
668 mutex_lock(&fb_helper
->lock
);
669 if (!drm_fb_helper_is_bound(fb_helper
)) {
670 mutex_unlock(&fb_helper
->lock
);
674 if (drm_drv_uses_atomic_modeset(fb_helper
->dev
))
675 restore_fbdev_mode_atomic(fb_helper
, dpms_mode
== DRM_MODE_DPMS_ON
);
677 dpms_legacy(fb_helper
, dpms_mode
);
678 mutex_unlock(&fb_helper
->lock
);
682 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
683 * @blank: desired blanking state
684 * @info: fbdev registered by the helper
686 int drm_fb_helper_blank(int blank
, struct fb_info
*info
)
688 if (oops_in_progress
)
692 /* Display: On; HSync: On, VSync: On */
693 case FB_BLANK_UNBLANK
:
694 drm_fb_helper_dpms(info
, DRM_MODE_DPMS_ON
);
696 /* Display: Off; HSync: On, VSync: On */
697 case FB_BLANK_NORMAL
:
698 drm_fb_helper_dpms(info
, DRM_MODE_DPMS_STANDBY
);
700 /* Display: Off; HSync: Off, VSync: On */
701 case FB_BLANK_HSYNC_SUSPEND
:
702 drm_fb_helper_dpms(info
, DRM_MODE_DPMS_STANDBY
);
704 /* Display: Off; HSync: On, VSync: Off */
705 case FB_BLANK_VSYNC_SUSPEND
:
706 drm_fb_helper_dpms(info
, DRM_MODE_DPMS_SUSPEND
);
708 /* Display: Off; HSync: Off, VSync: Off */
709 case FB_BLANK_POWERDOWN
:
710 drm_fb_helper_dpms(info
, DRM_MODE_DPMS_OFF
);
715 EXPORT_SYMBOL(drm_fb_helper_blank
);
717 static void drm_fb_helper_modeset_release(struct drm_fb_helper
*helper
,
718 struct drm_mode_set
*modeset
)
722 for (i
= 0; i
< modeset
->num_connectors
; i
++) {
723 drm_connector_put(modeset
->connectors
[i
]);
724 modeset
->connectors
[i
] = NULL
;
726 modeset
->num_connectors
= 0;
728 drm_mode_destroy(helper
->dev
, modeset
->mode
);
729 modeset
->mode
= NULL
;
731 /* FIXME should hold a ref? */
735 static void drm_fb_helper_crtc_free(struct drm_fb_helper
*helper
)
739 for (i
= 0; i
< helper
->connector_count
; i
++) {
740 drm_connector_put(helper
->connector_info
[i
]->connector
);
741 kfree(helper
->connector_info
[i
]);
743 kfree(helper
->connector_info
);
745 for (i
= 0; i
< helper
->crtc_count
; i
++) {
746 struct drm_mode_set
*modeset
= &helper
->crtc_info
[i
].mode_set
;
748 drm_fb_helper_modeset_release(helper
, modeset
);
749 kfree(modeset
->connectors
);
751 kfree(helper
->crtc_info
);
754 static void drm_fb_helper_resume_worker(struct work_struct
*work
)
756 struct drm_fb_helper
*helper
= container_of(work
, struct drm_fb_helper
,
760 fb_set_suspend(helper
->fbdev
, 0);
764 static void drm_fb_helper_dirty_blit_real(struct drm_fb_helper
*fb_helper
,
765 struct drm_clip_rect
*clip
)
767 struct drm_framebuffer
*fb
= fb_helper
->fb
;
768 unsigned int cpp
= drm_format_plane_cpp(fb
->format
->format
, 0);
769 size_t offset
= clip
->y1
* fb
->pitches
[0] + clip
->x1
* cpp
;
770 void *src
= fb_helper
->fbdev
->screen_buffer
+ offset
;
771 void *dst
= fb_helper
->buffer
->vaddr
+ offset
;
772 size_t len
= (clip
->x2
- clip
->x1
) * cpp
;
775 for (y
= clip
->y1
; y
< clip
->y2
; y
++) {
776 memcpy(dst
, src
, len
);
777 src
+= fb
->pitches
[0];
778 dst
+= fb
->pitches
[0];
782 static void drm_fb_helper_dirty_work(struct work_struct
*work
)
784 struct drm_fb_helper
*helper
= container_of(work
, struct drm_fb_helper
,
786 struct drm_clip_rect
*clip
= &helper
->dirty_clip
;
787 struct drm_clip_rect clip_copy
;
790 spin_lock_irqsave(&helper
->dirty_lock
, flags
);
792 clip
->x1
= clip
->y1
= ~0;
793 clip
->x2
= clip
->y2
= 0;
794 spin_unlock_irqrestore(&helper
->dirty_lock
, flags
);
796 /* call dirty callback only when it has been really touched */
797 if (clip_copy
.x1
< clip_copy
.x2
&& clip_copy
.y1
< clip_copy
.y2
) {
798 /* Generic fbdev uses a shadow buffer */
800 drm_fb_helper_dirty_blit_real(helper
, &clip_copy
);
801 helper
->fb
->funcs
->dirty(helper
->fb
, NULL
, 0, 0, &clip_copy
, 1);
806 * drm_fb_helper_prepare - setup a drm_fb_helper structure
808 * @helper: driver-allocated fbdev helper structure to set up
809 * @funcs: pointer to structure of functions associate with this helper
811 * Sets up the bare minimum to make the framebuffer helper usable. This is
812 * useful to implement race-free initialization of the polling helpers.
814 void drm_fb_helper_prepare(struct drm_device
*dev
, struct drm_fb_helper
*helper
,
815 const struct drm_fb_helper_funcs
*funcs
)
817 INIT_LIST_HEAD(&helper
->kernel_fb_list
);
818 spin_lock_init(&helper
->dirty_lock
);
819 INIT_WORK(&helper
->resume_work
, drm_fb_helper_resume_worker
);
820 INIT_WORK(&helper
->dirty_work
, drm_fb_helper_dirty_work
);
821 helper
->dirty_clip
.x1
= helper
->dirty_clip
.y1
= ~0;
822 mutex_init(&helper
->lock
);
823 helper
->funcs
= funcs
;
826 EXPORT_SYMBOL(drm_fb_helper_prepare
);
829 * drm_fb_helper_init - initialize a &struct drm_fb_helper
831 * @fb_helper: driver-allocated fbdev helper structure to initialize
832 * @max_conn_count: max connector count
834 * This allocates the structures for the fbdev helper with the given limits.
835 * Note that this won't yet touch the hardware (through the driver interfaces)
836 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
837 * to allow driver writes more control over the exact init sequence.
839 * Drivers must call drm_fb_helper_prepare() before calling this function.
842 * Zero if everything went ok, nonzero otherwise.
844 int drm_fb_helper_init(struct drm_device
*dev
,
845 struct drm_fb_helper
*fb_helper
,
848 struct drm_crtc
*crtc
;
849 struct drm_mode_config
*config
= &dev
->mode_config
;
852 if (!drm_fbdev_emulation
) {
853 dev
->fb_helper
= fb_helper
;
860 fb_helper
->crtc_info
= kcalloc(config
->num_crtc
, sizeof(struct drm_fb_helper_crtc
), GFP_KERNEL
);
861 if (!fb_helper
->crtc_info
)
864 fb_helper
->crtc_count
= config
->num_crtc
;
865 fb_helper
->connector_info
= kcalloc(dev
->mode_config
.num_connector
, sizeof(struct drm_fb_helper_connector
*), GFP_KERNEL
);
866 if (!fb_helper
->connector_info
) {
867 kfree(fb_helper
->crtc_info
);
870 fb_helper
->connector_info_alloc_count
= dev
->mode_config
.num_connector
;
871 fb_helper
->connector_count
= 0;
873 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
874 fb_helper
->crtc_info
[i
].mode_set
.connectors
=
875 kcalloc(max_conn_count
,
876 sizeof(struct drm_connector
*),
879 if (!fb_helper
->crtc_info
[i
].mode_set
.connectors
)
881 fb_helper
->crtc_info
[i
].mode_set
.num_connectors
= 0;
882 fb_helper
->crtc_info
[i
].rotation
= DRM_MODE_ROTATE_0
;
886 drm_for_each_crtc(crtc
, dev
) {
887 fb_helper
->crtc_info
[i
].mode_set
.crtc
= crtc
;
891 dev
->fb_helper
= fb_helper
;
895 drm_fb_helper_crtc_free(fb_helper
);
898 EXPORT_SYMBOL(drm_fb_helper_init
);
901 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
902 * @fb_helper: driver-allocated fbdev helper
904 * A helper to alloc fb_info and the members cmap and apertures. Called
905 * by the driver within the fb_probe fb_helper callback function. Drivers do not
906 * need to release the allocated fb_info structure themselves, this is
907 * automatically done when calling drm_fb_helper_fini().
910 * fb_info pointer if things went okay, pointer containing error code
913 struct fb_info
*drm_fb_helper_alloc_fbi(struct drm_fb_helper
*fb_helper
)
915 struct device
*dev
= fb_helper
->dev
->dev
;
916 struct fb_info
*info
;
919 info
= framebuffer_alloc(0, dev
);
921 return ERR_PTR(-ENOMEM
);
923 ret
= fb_alloc_cmap(&info
->cmap
, 256, 0);
927 info
->apertures
= alloc_apertures(1);
928 if (!info
->apertures
) {
933 fb_helper
->fbdev
= info
;
938 fb_dealloc_cmap(&info
->cmap
);
940 framebuffer_release(info
);
943 EXPORT_SYMBOL(drm_fb_helper_alloc_fbi
);
946 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
947 * @fb_helper: driver-allocated fbdev helper, can be NULL
949 * A wrapper around unregister_framebuffer, to release the fb_info
950 * framebuffer device. This must be called before releasing all resources for
951 * @fb_helper by calling drm_fb_helper_fini().
953 void drm_fb_helper_unregister_fbi(struct drm_fb_helper
*fb_helper
)
955 if (fb_helper
&& fb_helper
->fbdev
)
956 unregister_framebuffer(fb_helper
->fbdev
);
958 EXPORT_SYMBOL(drm_fb_helper_unregister_fbi
);
961 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
962 * @fb_helper: driver-allocated fbdev helper, can be NULL
964 * This cleans up all remaining resources associated with @fb_helper. Must be
965 * called after drm_fb_helper_unlink_fbi() was called.
967 void drm_fb_helper_fini(struct drm_fb_helper
*fb_helper
)
969 struct fb_info
*info
;
974 fb_helper
->dev
->fb_helper
= NULL
;
976 if (!drm_fbdev_emulation
)
979 cancel_work_sync(&fb_helper
->resume_work
);
980 cancel_work_sync(&fb_helper
->dirty_work
);
982 info
= fb_helper
->fbdev
;
985 fb_dealloc_cmap(&info
->cmap
);
986 framebuffer_release(info
);
988 fb_helper
->fbdev
= NULL
;
990 mutex_lock(&kernel_fb_helper_lock
);
991 if (!list_empty(&fb_helper
->kernel_fb_list
)) {
992 list_del(&fb_helper
->kernel_fb_list
);
993 if (list_empty(&kernel_fb_helper_list
))
994 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op
);
996 mutex_unlock(&kernel_fb_helper_lock
);
998 mutex_destroy(&fb_helper
->lock
);
999 drm_fb_helper_crtc_free(fb_helper
);
1002 EXPORT_SYMBOL(drm_fb_helper_fini
);
1005 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
1006 * @fb_helper: driver-allocated fbdev helper, can be NULL
1008 * A wrapper around unlink_framebuffer implemented by fbdev core
1010 void drm_fb_helper_unlink_fbi(struct drm_fb_helper
*fb_helper
)
1012 if (fb_helper
&& fb_helper
->fbdev
)
1013 unlink_framebuffer(fb_helper
->fbdev
);
1015 EXPORT_SYMBOL(drm_fb_helper_unlink_fbi
);
1017 static void drm_fb_helper_dirty(struct fb_info
*info
, u32 x
, u32 y
,
1018 u32 width
, u32 height
)
1020 struct drm_fb_helper
*helper
= info
->par
;
1021 struct drm_clip_rect
*clip
= &helper
->dirty_clip
;
1022 unsigned long flags
;
1024 if (!helper
->fb
->funcs
->dirty
)
1027 spin_lock_irqsave(&helper
->dirty_lock
, flags
);
1028 clip
->x1
= min_t(u32
, clip
->x1
, x
);
1029 clip
->y1
= min_t(u32
, clip
->y1
, y
);
1030 clip
->x2
= max_t(u32
, clip
->x2
, x
+ width
);
1031 clip
->y2
= max_t(u32
, clip
->y2
, y
+ height
);
1032 spin_unlock_irqrestore(&helper
->dirty_lock
, flags
);
1034 schedule_work(&helper
->dirty_work
);
1038 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
1039 * @info: fb_info struct pointer
1040 * @pagelist: list of dirty mmap framebuffer pages
1042 * This function is used as the &fb_deferred_io.deferred_io
1043 * callback function for flushing the fbdev mmap writes.
1045 void drm_fb_helper_deferred_io(struct fb_info
*info
,
1046 struct list_head
*pagelist
)
1048 unsigned long start
, end
, min
, max
;
1054 list_for_each_entry(page
, pagelist
, lru
) {
1055 start
= page
->index
<< PAGE_SHIFT
;
1056 end
= start
+ PAGE_SIZE
- 1;
1057 min
= min(min
, start
);
1058 max
= max(max
, end
);
1062 y1
= min
/ info
->fix
.line_length
;
1063 y2
= min_t(u32
, DIV_ROUND_UP(max
, info
->fix
.line_length
),
1065 drm_fb_helper_dirty(info
, 0, y1
, info
->var
.xres
, y2
- y1
);
1068 EXPORT_SYMBOL(drm_fb_helper_deferred_io
);
1071 * drm_fb_helper_defio_init - fbdev deferred I/O initialization
1072 * @fb_helper: driver-allocated fbdev helper
1074 * This function allocates &fb_deferred_io, sets callback to
1075 * drm_fb_helper_deferred_io(), delay to 50ms and calls fb_deferred_io_init().
1076 * It should be called from the &drm_fb_helper_funcs->fb_probe callback.
1077 * drm_fb_helper_fbdev_teardown() cleans up deferred I/O.
1079 * NOTE: A copy of &fb_ops is made and assigned to &info->fbops. This is done
1080 * because fb_deferred_io_cleanup() clears &fbops->fb_mmap and would thereby
1081 * affect other instances of that &fb_ops.
1084 * 0 on success or a negative error code on failure.
1086 int drm_fb_helper_defio_init(struct drm_fb_helper
*fb_helper
)
1088 struct fb_info
*info
= fb_helper
->fbdev
;
1089 struct fb_deferred_io
*fbdefio
;
1090 struct fb_ops
*fbops
;
1092 fbdefio
= kzalloc(sizeof(*fbdefio
), GFP_KERNEL
);
1093 fbops
= kzalloc(sizeof(*fbops
), GFP_KERNEL
);
1094 if (!fbdefio
|| !fbops
) {
1100 info
->fbdefio
= fbdefio
;
1101 fbdefio
->delay
= msecs_to_jiffies(50);
1102 fbdefio
->deferred_io
= drm_fb_helper_deferred_io
;
1104 *fbops
= *info
->fbops
;
1105 info
->fbops
= fbops
;
1107 fb_deferred_io_init(info
);
1111 EXPORT_SYMBOL(drm_fb_helper_defio_init
);
1114 * drm_fb_helper_sys_read - wrapper around fb_sys_read
1115 * @info: fb_info struct pointer
1116 * @buf: userspace buffer to read from framebuffer memory
1117 * @count: number of bytes to read from framebuffer memory
1118 * @ppos: read offset within framebuffer memory
1120 * A wrapper around fb_sys_read implemented by fbdev core
1122 ssize_t
drm_fb_helper_sys_read(struct fb_info
*info
, char __user
*buf
,
1123 size_t count
, loff_t
*ppos
)
1125 return fb_sys_read(info
, buf
, count
, ppos
);
1127 EXPORT_SYMBOL(drm_fb_helper_sys_read
);
1130 * drm_fb_helper_sys_write - wrapper around fb_sys_write
1131 * @info: fb_info struct pointer
1132 * @buf: userspace buffer to write to framebuffer memory
1133 * @count: number of bytes to write to framebuffer memory
1134 * @ppos: write offset within framebuffer memory
1136 * A wrapper around fb_sys_write implemented by fbdev core
1138 ssize_t
drm_fb_helper_sys_write(struct fb_info
*info
, const char __user
*buf
,
1139 size_t count
, loff_t
*ppos
)
1143 ret
= fb_sys_write(info
, buf
, count
, ppos
);
1145 drm_fb_helper_dirty(info
, 0, 0, info
->var
.xres
,
1150 EXPORT_SYMBOL(drm_fb_helper_sys_write
);
1153 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
1154 * @info: fbdev registered by the helper
1155 * @rect: info about rectangle to fill
1157 * A wrapper around sys_fillrect implemented by fbdev core
1159 void drm_fb_helper_sys_fillrect(struct fb_info
*info
,
1160 const struct fb_fillrect
*rect
)
1162 sys_fillrect(info
, rect
);
1163 drm_fb_helper_dirty(info
, rect
->dx
, rect
->dy
,
1164 rect
->width
, rect
->height
);
1166 EXPORT_SYMBOL(drm_fb_helper_sys_fillrect
);
1169 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
1170 * @info: fbdev registered by the helper
1171 * @area: info about area to copy
1173 * A wrapper around sys_copyarea implemented by fbdev core
1175 void drm_fb_helper_sys_copyarea(struct fb_info
*info
,
1176 const struct fb_copyarea
*area
)
1178 sys_copyarea(info
, area
);
1179 drm_fb_helper_dirty(info
, area
->dx
, area
->dy
,
1180 area
->width
, area
->height
);
1182 EXPORT_SYMBOL(drm_fb_helper_sys_copyarea
);
1185 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
1186 * @info: fbdev registered by the helper
1187 * @image: info about image to blit
1189 * A wrapper around sys_imageblit implemented by fbdev core
1191 void drm_fb_helper_sys_imageblit(struct fb_info
*info
,
1192 const struct fb_image
*image
)
1194 sys_imageblit(info
, image
);
1195 drm_fb_helper_dirty(info
, image
->dx
, image
->dy
,
1196 image
->width
, image
->height
);
1198 EXPORT_SYMBOL(drm_fb_helper_sys_imageblit
);
1201 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
1202 * @info: fbdev registered by the helper
1203 * @rect: info about rectangle to fill
1205 * A wrapper around cfb_fillrect implemented by fbdev core
1207 void drm_fb_helper_cfb_fillrect(struct fb_info
*info
,
1208 const struct fb_fillrect
*rect
)
1210 cfb_fillrect(info
, rect
);
1211 drm_fb_helper_dirty(info
, rect
->dx
, rect
->dy
,
1212 rect
->width
, rect
->height
);
1214 EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect
);
1217 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1218 * @info: fbdev registered by the helper
1219 * @area: info about area to copy
1221 * A wrapper around cfb_copyarea implemented by fbdev core
1223 void drm_fb_helper_cfb_copyarea(struct fb_info
*info
,
1224 const struct fb_copyarea
*area
)
1226 cfb_copyarea(info
, area
);
1227 drm_fb_helper_dirty(info
, area
->dx
, area
->dy
,
1228 area
->width
, area
->height
);
1230 EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea
);
1233 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1234 * @info: fbdev registered by the helper
1235 * @image: info about image to blit
1237 * A wrapper around cfb_imageblit implemented by fbdev core
1239 void drm_fb_helper_cfb_imageblit(struct fb_info
*info
,
1240 const struct fb_image
*image
)
1242 cfb_imageblit(info
, image
);
1243 drm_fb_helper_dirty(info
, image
->dx
, image
->dy
,
1244 image
->width
, image
->height
);
1246 EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit
);
1249 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1250 * @fb_helper: driver-allocated fbdev helper, can be NULL
1251 * @suspend: whether to suspend or resume
1253 * A wrapper around fb_set_suspend implemented by fbdev core.
1254 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1257 void drm_fb_helper_set_suspend(struct drm_fb_helper
*fb_helper
, bool suspend
)
1259 if (fb_helper
&& fb_helper
->fbdev
)
1260 fb_set_suspend(fb_helper
->fbdev
, suspend
);
1262 EXPORT_SYMBOL(drm_fb_helper_set_suspend
);
1265 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1266 * takes the console lock
1267 * @fb_helper: driver-allocated fbdev helper, can be NULL
1268 * @suspend: whether to suspend or resume
1270 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1271 * isn't available on resume, a worker is tasked with waiting for the lock
1272 * to become available. The console lock can be pretty contented on resume
1273 * due to all the printk activity.
1275 * This function can be called multiple times with the same state since
1276 * &fb_info.state is checked to see if fbdev is running or not before locking.
1278 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1280 void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper
*fb_helper
,
1283 if (!fb_helper
|| !fb_helper
->fbdev
)
1286 /* make sure there's no pending/ongoing resume */
1287 flush_work(&fb_helper
->resume_work
);
1290 if (fb_helper
->fbdev
->state
!= FBINFO_STATE_RUNNING
)
1296 if (fb_helper
->fbdev
->state
== FBINFO_STATE_RUNNING
)
1299 if (!console_trylock()) {
1300 schedule_work(&fb_helper
->resume_work
);
1305 fb_set_suspend(fb_helper
->fbdev
, suspend
);
1308 EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked
);
1310 static int setcmap_pseudo_palette(struct fb_cmap
*cmap
, struct fb_info
*info
)
1312 u32
*palette
= (u32
*)info
->pseudo_palette
;
1315 if (cmap
->start
+ cmap
->len
> 16)
1318 for (i
= 0; i
< cmap
->len
; ++i
) {
1319 u16 red
= cmap
->red
[i
];
1320 u16 green
= cmap
->green
[i
];
1321 u16 blue
= cmap
->blue
[i
];
1324 red
>>= 16 - info
->var
.red
.length
;
1325 green
>>= 16 - info
->var
.green
.length
;
1326 blue
>>= 16 - info
->var
.blue
.length
;
1327 value
= (red
<< info
->var
.red
.offset
) |
1328 (green
<< info
->var
.green
.offset
) |
1329 (blue
<< info
->var
.blue
.offset
);
1330 if (info
->var
.transp
.length
> 0) {
1331 u32 mask
= (1 << info
->var
.transp
.length
) - 1;
1333 mask
<<= info
->var
.transp
.offset
;
1336 palette
[cmap
->start
+ i
] = value
;
1342 static int setcmap_legacy(struct fb_cmap
*cmap
, struct fb_info
*info
)
1344 struct drm_fb_helper
*fb_helper
= info
->par
;
1345 struct drm_crtc
*crtc
;
1349 drm_modeset_lock_all(fb_helper
->dev
);
1350 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1351 crtc
= fb_helper
->crtc_info
[i
].mode_set
.crtc
;
1352 if (!crtc
->funcs
->gamma_set
|| !crtc
->gamma_size
)
1355 if (cmap
->start
+ cmap
->len
> crtc
->gamma_size
)
1358 r
= crtc
->gamma_store
;
1359 g
= r
+ crtc
->gamma_size
;
1360 b
= g
+ crtc
->gamma_size
;
1362 memcpy(r
+ cmap
->start
, cmap
->red
, cmap
->len
* sizeof(*r
));
1363 memcpy(g
+ cmap
->start
, cmap
->green
, cmap
->len
* sizeof(*g
));
1364 memcpy(b
+ cmap
->start
, cmap
->blue
, cmap
->len
* sizeof(*b
));
1366 ret
= crtc
->funcs
->gamma_set(crtc
, r
, g
, b
,
1367 crtc
->gamma_size
, NULL
);
1371 drm_modeset_unlock_all(fb_helper
->dev
);
1376 static struct drm_property_blob
*setcmap_new_gamma_lut(struct drm_crtc
*crtc
,
1377 struct fb_cmap
*cmap
)
1379 struct drm_device
*dev
= crtc
->dev
;
1380 struct drm_property_blob
*gamma_lut
;
1381 struct drm_color_lut
*lut
;
1382 int size
= crtc
->gamma_size
;
1385 if (!size
|| cmap
->start
+ cmap
->len
> size
)
1386 return ERR_PTR(-EINVAL
);
1388 gamma_lut
= drm_property_create_blob(dev
, sizeof(*lut
) * size
, NULL
);
1389 if (IS_ERR(gamma_lut
))
1392 lut
= gamma_lut
->data
;
1393 if (cmap
->start
|| cmap
->len
!= size
) {
1394 u16
*r
= crtc
->gamma_store
;
1395 u16
*g
= r
+ crtc
->gamma_size
;
1396 u16
*b
= g
+ crtc
->gamma_size
;
1398 for (i
= 0; i
< cmap
->start
; i
++) {
1400 lut
[i
].green
= g
[i
];
1403 for (i
= cmap
->start
+ cmap
->len
; i
< size
; i
++) {
1405 lut
[i
].green
= g
[i
];
1410 for (i
= 0; i
< cmap
->len
; i
++) {
1411 lut
[cmap
->start
+ i
].red
= cmap
->red
[i
];
1412 lut
[cmap
->start
+ i
].green
= cmap
->green
[i
];
1413 lut
[cmap
->start
+ i
].blue
= cmap
->blue
[i
];
1419 static int setcmap_atomic(struct fb_cmap
*cmap
, struct fb_info
*info
)
1421 struct drm_fb_helper
*fb_helper
= info
->par
;
1422 struct drm_device
*dev
= fb_helper
->dev
;
1423 struct drm_property_blob
*gamma_lut
= NULL
;
1424 struct drm_modeset_acquire_ctx ctx
;
1425 struct drm_crtc_state
*crtc_state
;
1426 struct drm_atomic_state
*state
;
1427 struct drm_crtc
*crtc
;
1432 drm_modeset_acquire_init(&ctx
, 0);
1434 state
= drm_atomic_state_alloc(dev
);
1440 state
->acquire_ctx
= &ctx
;
1442 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1443 crtc
= fb_helper
->crtc_info
[i
].mode_set
.crtc
;
1446 gamma_lut
= setcmap_new_gamma_lut(crtc
, cmap
);
1447 if (IS_ERR(gamma_lut
)) {
1448 ret
= PTR_ERR(gamma_lut
);
1453 crtc_state
= drm_atomic_get_crtc_state(state
, crtc
);
1454 if (IS_ERR(crtc_state
)) {
1455 ret
= PTR_ERR(crtc_state
);
1459 replaced
= drm_property_replace_blob(&crtc_state
->degamma_lut
,
1461 replaced
|= drm_property_replace_blob(&crtc_state
->ctm
, NULL
);
1462 replaced
|= drm_property_replace_blob(&crtc_state
->gamma_lut
,
1464 crtc_state
->color_mgmt_changed
|= replaced
;
1467 ret
= drm_atomic_commit(state
);
1471 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1472 crtc
= fb_helper
->crtc_info
[i
].mode_set
.crtc
;
1474 r
= crtc
->gamma_store
;
1475 g
= r
+ crtc
->gamma_size
;
1476 b
= g
+ crtc
->gamma_size
;
1478 memcpy(r
+ cmap
->start
, cmap
->red
, cmap
->len
* sizeof(*r
));
1479 memcpy(g
+ cmap
->start
, cmap
->green
, cmap
->len
* sizeof(*g
));
1480 memcpy(b
+ cmap
->start
, cmap
->blue
, cmap
->len
* sizeof(*b
));
1484 if (ret
== -EDEADLK
)
1487 drm_property_blob_put(gamma_lut
);
1488 drm_atomic_state_put(state
);
1490 drm_modeset_drop_locks(&ctx
);
1491 drm_modeset_acquire_fini(&ctx
);
1496 drm_atomic_state_clear(state
);
1497 drm_modeset_backoff(&ctx
);
1502 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1503 * @cmap: cmap to set
1504 * @info: fbdev registered by the helper
1506 int drm_fb_helper_setcmap(struct fb_cmap
*cmap
, struct fb_info
*info
)
1508 struct drm_fb_helper
*fb_helper
= info
->par
;
1511 if (oops_in_progress
)
1514 mutex_lock(&fb_helper
->lock
);
1516 if (!drm_fb_helper_is_bound(fb_helper
)) {
1521 if (info
->fix
.visual
== FB_VISUAL_TRUECOLOR
)
1522 ret
= setcmap_pseudo_palette(cmap
, info
);
1523 else if (drm_drv_uses_atomic_modeset(fb_helper
->dev
))
1524 ret
= setcmap_atomic(cmap
, info
);
1526 ret
= setcmap_legacy(cmap
, info
);
1529 mutex_unlock(&fb_helper
->lock
);
1533 EXPORT_SYMBOL(drm_fb_helper_setcmap
);
1536 * drm_fb_helper_ioctl - legacy ioctl implementation
1537 * @info: fbdev registered by the helper
1538 * @cmd: ioctl command
1539 * @arg: ioctl argument
1541 * A helper to implement the standard fbdev ioctl. Only
1542 * FBIO_WAITFORVSYNC is implemented for now.
1544 int drm_fb_helper_ioctl(struct fb_info
*info
, unsigned int cmd
,
1547 struct drm_fb_helper
*fb_helper
= info
->par
;
1548 struct drm_mode_set
*mode_set
;
1549 struct drm_crtc
*crtc
;
1552 mutex_lock(&fb_helper
->lock
);
1553 if (!drm_fb_helper_is_bound(fb_helper
)) {
1559 case FBIO_WAITFORVSYNC
:
1561 * Only consider the first CRTC.
1563 * This ioctl is supposed to take the CRTC number as
1564 * an argument, but in fbdev times, what that number
1565 * was supposed to be was quite unclear, different
1566 * drivers were passing that argument differently
1567 * (some by reference, some by value), and most of the
1568 * userspace applications were just hardcoding 0 as an
1571 * The first CRTC should be the integrated panel on
1572 * most drivers, so this is the best choice we can
1573 * make. If we're not smart enough here, one should
1574 * just consider switch the userspace to KMS.
1576 mode_set
= &fb_helper
->crtc_info
[0].mode_set
;
1577 crtc
= mode_set
->crtc
;
1580 * Only wait for a vblank event if the CRTC is
1581 * enabled, otherwise just don't do anythintg,
1582 * not even report an error.
1584 ret
= drm_crtc_vblank_get(crtc
);
1586 drm_crtc_wait_one_vblank(crtc
);
1587 drm_crtc_vblank_put(crtc
);
1597 mutex_unlock(&fb_helper
->lock
);
1600 EXPORT_SYMBOL(drm_fb_helper_ioctl
);
1602 static bool drm_fb_pixel_format_equal(const struct fb_var_screeninfo
*var_1
,
1603 const struct fb_var_screeninfo
*var_2
)
1605 return var_1
->bits_per_pixel
== var_2
->bits_per_pixel
&&
1606 var_1
->grayscale
== var_2
->grayscale
&&
1607 var_1
->red
.offset
== var_2
->red
.offset
&&
1608 var_1
->red
.length
== var_2
->red
.length
&&
1609 var_1
->red
.msb_right
== var_2
->red
.msb_right
&&
1610 var_1
->green
.offset
== var_2
->green
.offset
&&
1611 var_1
->green
.length
== var_2
->green
.length
&&
1612 var_1
->green
.msb_right
== var_2
->green
.msb_right
&&
1613 var_1
->blue
.offset
== var_2
->blue
.offset
&&
1614 var_1
->blue
.length
== var_2
->blue
.length
&&
1615 var_1
->blue
.msb_right
== var_2
->blue
.msb_right
&&
1616 var_1
->transp
.offset
== var_2
->transp
.offset
&&
1617 var_1
->transp
.length
== var_2
->transp
.length
&&
1618 var_1
->transp
.msb_right
== var_2
->transp
.msb_right
;
1622 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1623 * @var: screeninfo to check
1624 * @info: fbdev registered by the helper
1626 int drm_fb_helper_check_var(struct fb_var_screeninfo
*var
,
1627 struct fb_info
*info
)
1629 struct drm_fb_helper
*fb_helper
= info
->par
;
1630 struct drm_framebuffer
*fb
= fb_helper
->fb
;
1632 if (var
->pixclock
!= 0 || in_dbg_master())
1635 if ((drm_format_info_block_width(fb
->format
, 0) > 1) ||
1636 (drm_format_info_block_height(fb
->format
, 0) > 1))
1640 * Changes struct fb_var_screeninfo are currently not pushed back
1641 * to KMS, hence fail if different settings are requested.
1643 if (var
->bits_per_pixel
!= fb
->format
->cpp
[0] * 8 ||
1644 var
->xres
> fb
->width
|| var
->yres
> fb
->height
||
1645 var
->xres_virtual
> fb
->width
|| var
->yres_virtual
> fb
->height
) {
1646 DRM_DEBUG("fb requested width/height/bpp can't fit in current fb "
1647 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1648 var
->xres
, var
->yres
, var
->bits_per_pixel
,
1649 var
->xres_virtual
, var
->yres_virtual
,
1650 fb
->width
, fb
->height
, fb
->format
->cpp
[0] * 8);
1655 * drm fbdev emulation doesn't support changing the pixel format at all,
1656 * so reject all pixel format changing requests.
1658 if (!drm_fb_pixel_format_equal(var
, &info
->var
)) {
1659 DRM_DEBUG("fbdev emulation doesn't support changing the pixel format\n");
1665 EXPORT_SYMBOL(drm_fb_helper_check_var
);
1668 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1669 * @info: fbdev registered by the helper
1671 * This will let fbcon do the mode init and is called at initialization time by
1672 * the fbdev core when registering the driver, and later on through the hotplug
1675 int drm_fb_helper_set_par(struct fb_info
*info
)
1677 struct drm_fb_helper
*fb_helper
= info
->par
;
1678 struct fb_var_screeninfo
*var
= &info
->var
;
1680 if (oops_in_progress
)
1683 if (var
->pixclock
!= 0) {
1684 DRM_ERROR("PIXEL CLOCK SET\n");
1688 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper
);
1692 EXPORT_SYMBOL(drm_fb_helper_set_par
);
1694 static void pan_set(struct drm_fb_helper
*fb_helper
, int x
, int y
)
1698 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1699 struct drm_mode_set
*mode_set
;
1701 mode_set
= &fb_helper
->crtc_info
[i
].mode_set
;
1708 static int pan_display_atomic(struct fb_var_screeninfo
*var
,
1709 struct fb_info
*info
)
1711 struct drm_fb_helper
*fb_helper
= info
->par
;
1714 pan_set(fb_helper
, var
->xoffset
, var
->yoffset
);
1716 ret
= restore_fbdev_mode_atomic(fb_helper
, true);
1718 info
->var
.xoffset
= var
->xoffset
;
1719 info
->var
.yoffset
= var
->yoffset
;
1721 pan_set(fb_helper
, info
->var
.xoffset
, info
->var
.yoffset
);
1726 static int pan_display_legacy(struct fb_var_screeninfo
*var
,
1727 struct fb_info
*info
)
1729 struct drm_fb_helper
*fb_helper
= info
->par
;
1730 struct drm_mode_set
*modeset
;
1734 drm_modeset_lock_all(fb_helper
->dev
);
1735 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1736 modeset
= &fb_helper
->crtc_info
[i
].mode_set
;
1738 modeset
->x
= var
->xoffset
;
1739 modeset
->y
= var
->yoffset
;
1741 if (modeset
->num_connectors
) {
1742 ret
= drm_mode_set_config_internal(modeset
);
1744 info
->var
.xoffset
= var
->xoffset
;
1745 info
->var
.yoffset
= var
->yoffset
;
1749 drm_modeset_unlock_all(fb_helper
->dev
);
1755 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1756 * @var: updated screen information
1757 * @info: fbdev registered by the helper
1759 int drm_fb_helper_pan_display(struct fb_var_screeninfo
*var
,
1760 struct fb_info
*info
)
1762 struct drm_fb_helper
*fb_helper
= info
->par
;
1763 struct drm_device
*dev
= fb_helper
->dev
;
1766 if (oops_in_progress
)
1769 mutex_lock(&fb_helper
->lock
);
1770 if (!drm_fb_helper_is_bound(fb_helper
)) {
1771 mutex_unlock(&fb_helper
->lock
);
1775 if (drm_drv_uses_atomic_modeset(dev
))
1776 ret
= pan_display_atomic(var
, info
);
1778 ret
= pan_display_legacy(var
, info
);
1779 mutex_unlock(&fb_helper
->lock
);
1783 EXPORT_SYMBOL(drm_fb_helper_pan_display
);
1786 * Allocates the backing storage and sets up the fbdev info structure through
1787 * the ->fb_probe callback.
1789 static int drm_fb_helper_single_fb_probe(struct drm_fb_helper
*fb_helper
,
1795 struct drm_fb_helper_surface_size sizes
;
1798 memset(&sizes
, 0, sizeof(struct drm_fb_helper_surface_size
));
1799 sizes
.surface_depth
= 24;
1800 sizes
.surface_bpp
= 32;
1801 sizes
.fb_width
= (u32
)-1;
1802 sizes
.fb_height
= (u32
)-1;
1804 /* if driver picks 8 or 16 by default use that for both depth/bpp */
1805 if (preferred_bpp
!= sizes
.surface_bpp
)
1806 sizes
.surface_depth
= sizes
.surface_bpp
= preferred_bpp
;
1808 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1809 drm_fb_helper_for_each_connector(fb_helper
, i
) {
1810 struct drm_fb_helper_connector
*fb_helper_conn
= fb_helper
->connector_info
[i
];
1811 struct drm_cmdline_mode
*cmdline_mode
;
1813 cmdline_mode
= &fb_helper_conn
->connector
->cmdline_mode
;
1815 if (cmdline_mode
->bpp_specified
) {
1816 switch (cmdline_mode
->bpp
) {
1818 sizes
.surface_depth
= sizes
.surface_bpp
= 8;
1821 sizes
.surface_depth
= 15;
1822 sizes
.surface_bpp
= 16;
1825 sizes
.surface_depth
= sizes
.surface_bpp
= 16;
1828 sizes
.surface_depth
= sizes
.surface_bpp
= 24;
1831 sizes
.surface_depth
= 24;
1832 sizes
.surface_bpp
= 32;
1840 for (i
= 0; i
< fb_helper
->crtc_count
; i
++) {
1841 struct drm_display_mode
*desired_mode
;
1842 struct drm_mode_set
*mode_set
;
1844 /* in case of tile group, are we the last tile vert or horiz?
1845 * If no tile group you are always the last one both vertically
1848 bool lastv
= true, lasth
= true;
1850 desired_mode
= fb_helper
->crtc_info
[i
].desired_mode
;
1851 mode_set
= &fb_helper
->crtc_info
[i
].mode_set
;
1858 x
= fb_helper
->crtc_info
[i
].x
;
1859 y
= fb_helper
->crtc_info
[i
].y
;
1861 if (gamma_size
== 0)
1862 gamma_size
= fb_helper
->crtc_info
[i
].mode_set
.crtc
->gamma_size
;
1864 sizes
.surface_width
= max_t(u32
, desired_mode
->hdisplay
+ x
, sizes
.surface_width
);
1865 sizes
.surface_height
= max_t(u32
, desired_mode
->vdisplay
+ y
, sizes
.surface_height
);
1867 for (j
= 0; j
< mode_set
->num_connectors
; j
++) {
1868 struct drm_connector
*connector
= mode_set
->connectors
[j
];
1870 if (connector
->has_tile
) {
1871 lasth
= (connector
->tile_h_loc
== (connector
->num_h_tile
- 1));
1872 lastv
= (connector
->tile_v_loc
== (connector
->num_v_tile
- 1));
1873 /* cloning to multiple tiles is just crazy-talk, so: */
1879 sizes
.fb_width
= min_t(u32
, desired_mode
->hdisplay
+ x
, sizes
.fb_width
);
1881 sizes
.fb_height
= min_t(u32
, desired_mode
->vdisplay
+ y
, sizes
.fb_height
);
1884 if (crtc_count
== 0 || sizes
.fb_width
== -1 || sizes
.fb_height
== -1) {
1885 DRM_INFO("Cannot find any crtc or sizes\n");
1887 /* First time: disable all crtc's.. */
1888 if (!fb_helper
->deferred_setup
&& !READ_ONCE(fb_helper
->dev
->master
))
1889 restore_fbdev_mode(fb_helper
);
1893 /* Handle our overallocation */
1894 sizes
.surface_height
*= drm_fbdev_overalloc
;
1895 sizes
.surface_height
/= 100;
1897 /* push down into drivers */
1898 ret
= (*fb_helper
->funcs
->fb_probe
)(fb_helper
, &sizes
);
1902 strcpy(fb_helper
->fb
->comm
, "[fbcon]");
1907 * drm_fb_helper_fill_fix - initializes fixed fbdev information
1908 * @info: fbdev registered by the helper
1909 * @pitch: desired pitch
1910 * @depth: desired depth
1912 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1913 * fbdev emulations. Drivers which support acceleration methods which impose
1914 * additional constraints need to set up their own limits.
1916 * Drivers should call this (or their equivalent setup code) from their
1917 * &drm_fb_helper_funcs.fb_probe callback.
1919 void drm_fb_helper_fill_fix(struct fb_info
*info
, uint32_t pitch
,
1922 info
->fix
.type
= FB_TYPE_PACKED_PIXELS
;
1923 info
->fix
.visual
= depth
== 8 ? FB_VISUAL_PSEUDOCOLOR
:
1924 FB_VISUAL_TRUECOLOR
;
1925 info
->fix
.mmio_start
= 0;
1926 info
->fix
.mmio_len
= 0;
1927 info
->fix
.type_aux
= 0;
1928 info
->fix
.xpanstep
= 1; /* doing it in hw */
1929 info
->fix
.ypanstep
= 1; /* doing it in hw */
1930 info
->fix
.ywrapstep
= 0;
1931 info
->fix
.accel
= FB_ACCEL_NONE
;
1933 info
->fix
.line_length
= pitch
;
1935 EXPORT_SYMBOL(drm_fb_helper_fill_fix
);
1938 * drm_fb_helper_fill_var - initalizes variable fbdev information
1939 * @info: fbdev instance to set up
1940 * @fb_helper: fb helper instance to use as template
1941 * @fb_width: desired fb width
1942 * @fb_height: desired fb height
1944 * Sets up the variable fbdev metainformation from the given fb helper instance
1945 * and the drm framebuffer allocated in &drm_fb_helper.fb.
1947 * Drivers should call this (or their equivalent setup code) from their
1948 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
1949 * backing storage framebuffer.
1951 void drm_fb_helper_fill_var(struct fb_info
*info
, struct drm_fb_helper
*fb_helper
,
1952 uint32_t fb_width
, uint32_t fb_height
)
1954 struct drm_framebuffer
*fb
= fb_helper
->fb
;
1956 WARN_ON((drm_format_info_block_width(fb
->format
, 0) > 1) ||
1957 (drm_format_info_block_height(fb
->format
, 0) > 1));
1958 info
->pseudo_palette
= fb_helper
->pseudo_palette
;
1959 info
->var
.xres_virtual
= fb
->width
;
1960 info
->var
.yres_virtual
= fb
->height
;
1961 info
->var
.bits_per_pixel
= fb
->format
->cpp
[0] * 8;
1962 info
->var
.accel_flags
= FB_ACCELF_TEXT
;
1963 info
->var
.xoffset
= 0;
1964 info
->var
.yoffset
= 0;
1965 info
->var
.activate
= FB_ACTIVATE_NOW
;
1967 switch (fb
->format
->depth
) {
1969 info
->var
.red
.offset
= 0;
1970 info
->var
.green
.offset
= 0;
1971 info
->var
.blue
.offset
= 0;
1972 info
->var
.red
.length
= 8; /* 8bit DAC */
1973 info
->var
.green
.length
= 8;
1974 info
->var
.blue
.length
= 8;
1975 info
->var
.transp
.offset
= 0;
1976 info
->var
.transp
.length
= 0;
1979 info
->var
.red
.offset
= 10;
1980 info
->var
.green
.offset
= 5;
1981 info
->var
.blue
.offset
= 0;
1982 info
->var
.red
.length
= 5;
1983 info
->var
.green
.length
= 5;
1984 info
->var
.blue
.length
= 5;
1985 info
->var
.transp
.offset
= 15;
1986 info
->var
.transp
.length
= 1;
1989 info
->var
.red
.offset
= 11;
1990 info
->var
.green
.offset
= 5;
1991 info
->var
.blue
.offset
= 0;
1992 info
->var
.red
.length
= 5;
1993 info
->var
.green
.length
= 6;
1994 info
->var
.blue
.length
= 5;
1995 info
->var
.transp
.offset
= 0;
1998 info
->var
.red
.offset
= 16;
1999 info
->var
.green
.offset
= 8;
2000 info
->var
.blue
.offset
= 0;
2001 info
->var
.red
.length
= 8;
2002 info
->var
.green
.length
= 8;
2003 info
->var
.blue
.length
= 8;
2004 info
->var
.transp
.offset
= 0;
2005 info
->var
.transp
.length
= 0;
2008 info
->var
.red
.offset
= 16;
2009 info
->var
.green
.offset
= 8;
2010 info
->var
.blue
.offset
= 0;
2011 info
->var
.red
.length
= 8;
2012 info
->var
.green
.length
= 8;
2013 info
->var
.blue
.length
= 8;
2014 info
->var
.transp
.offset
= 24;
2015 info
->var
.transp
.length
= 8;
2021 info
->var
.xres
= fb_width
;
2022 info
->var
.yres
= fb_height
;
2024 EXPORT_SYMBOL(drm_fb_helper_fill_var
);
2026 static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper
*fb_helper
,
2030 struct drm_connector
*connector
;
2033 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2034 connector
= fb_helper
->connector_info
[i
]->connector
;
2035 count
+= connector
->funcs
->fill_modes(connector
, maxX
, maxY
);
2041 struct drm_display_mode
*drm_has_preferred_mode(struct drm_fb_helper_connector
*fb_connector
, int width
, int height
)
2043 struct drm_display_mode
*mode
;
2045 list_for_each_entry(mode
, &fb_connector
->connector
->modes
, head
) {
2046 if (mode
->hdisplay
> width
||
2047 mode
->vdisplay
> height
)
2049 if (mode
->type
& DRM_MODE_TYPE_PREFERRED
)
2054 EXPORT_SYMBOL(drm_has_preferred_mode
);
2056 static bool drm_has_cmdline_mode(struct drm_fb_helper_connector
*fb_connector
)
2058 return fb_connector
->connector
->cmdline_mode
.specified
;
2061 struct drm_display_mode
*drm_pick_cmdline_mode(struct drm_fb_helper_connector
*fb_helper_conn
)
2063 struct drm_cmdline_mode
*cmdline_mode
;
2064 struct drm_display_mode
*mode
;
2065 bool prefer_non_interlace
;
2067 cmdline_mode
= &fb_helper_conn
->connector
->cmdline_mode
;
2068 if (cmdline_mode
->specified
== false)
2071 /* attempt to find a matching mode in the list of modes
2072 * we have gotten so far, if not add a CVT mode that conforms
2074 if (cmdline_mode
->rb
|| cmdline_mode
->margins
)
2077 prefer_non_interlace
= !cmdline_mode
->interlace
;
2079 list_for_each_entry(mode
, &fb_helper_conn
->connector
->modes
, head
) {
2080 /* check width/height */
2081 if (mode
->hdisplay
!= cmdline_mode
->xres
||
2082 mode
->vdisplay
!= cmdline_mode
->yres
)
2085 if (cmdline_mode
->refresh_specified
) {
2086 if (mode
->vrefresh
!= cmdline_mode
->refresh
)
2090 if (cmdline_mode
->interlace
) {
2091 if (!(mode
->flags
& DRM_MODE_FLAG_INTERLACE
))
2093 } else if (prefer_non_interlace
) {
2094 if (mode
->flags
& DRM_MODE_FLAG_INTERLACE
)
2100 if (prefer_non_interlace
) {
2101 prefer_non_interlace
= false;
2106 mode
= drm_mode_create_from_cmdline_mode(fb_helper_conn
->connector
->dev
,
2108 list_add(&mode
->head
, &fb_helper_conn
->connector
->modes
);
2111 EXPORT_SYMBOL(drm_pick_cmdline_mode
);
2113 static bool drm_connector_enabled(struct drm_connector
*connector
, bool strict
)
2117 if (connector
->display_info
.non_desktop
)
2121 enable
= connector
->status
== connector_status_connected
;
2123 enable
= connector
->status
!= connector_status_disconnected
;
2128 static void drm_enable_connectors(struct drm_fb_helper
*fb_helper
,
2131 bool any_enabled
= false;
2132 struct drm_connector
*connector
;
2135 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2136 connector
= fb_helper
->connector_info
[i
]->connector
;
2137 enabled
[i
] = drm_connector_enabled(connector
, true);
2138 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector
->base
.id
,
2139 connector
->display_info
.non_desktop
? "non desktop" : enabled
[i
] ? "yes" : "no");
2141 any_enabled
|= enabled
[i
];
2147 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2148 connector
= fb_helper
->connector_info
[i
]->connector
;
2149 enabled
[i
] = drm_connector_enabled(connector
, false);
2153 static bool drm_target_cloned(struct drm_fb_helper
*fb_helper
,
2154 struct drm_display_mode
**modes
,
2155 struct drm_fb_offset
*offsets
,
2156 bool *enabled
, int width
, int height
)
2159 bool can_clone
= false;
2160 struct drm_fb_helper_connector
*fb_helper_conn
;
2161 struct drm_display_mode
*dmt_mode
, *mode
;
2163 /* only contemplate cloning in the single crtc case */
2164 if (fb_helper
->crtc_count
> 1)
2168 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2173 /* only contemplate cloning if more than one connector is enabled */
2177 /* check the command line or if nothing common pick 1024x768 */
2179 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2182 fb_helper_conn
= fb_helper
->connector_info
[i
];
2183 modes
[i
] = drm_pick_cmdline_mode(fb_helper_conn
);
2188 for (j
= 0; j
< i
; j
++) {
2191 if (!drm_mode_match(modes
[j
], modes
[i
],
2192 DRM_MODE_MATCH_TIMINGS
|
2193 DRM_MODE_MATCH_CLOCK
|
2194 DRM_MODE_MATCH_FLAGS
|
2195 DRM_MODE_MATCH_3D_FLAGS
))
2201 DRM_DEBUG_KMS("can clone using command line\n");
2205 /* try and find a 1024x768 mode on each connector */
2207 dmt_mode
= drm_mode_find_dmt(fb_helper
->dev
, 1024, 768, 60, false);
2209 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2213 fb_helper_conn
= fb_helper
->connector_info
[i
];
2214 list_for_each_entry(mode
, &fb_helper_conn
->connector
->modes
, head
) {
2215 if (drm_mode_match(mode
, dmt_mode
,
2216 DRM_MODE_MATCH_TIMINGS
|
2217 DRM_MODE_MATCH_CLOCK
|
2218 DRM_MODE_MATCH_FLAGS
|
2219 DRM_MODE_MATCH_3D_FLAGS
))
2227 DRM_DEBUG_KMS("can clone using 1024x768\n");
2230 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
2234 static int drm_get_tile_offsets(struct drm_fb_helper
*fb_helper
,
2235 struct drm_display_mode
**modes
,
2236 struct drm_fb_offset
*offsets
,
2238 int h_idx
, int v_idx
)
2240 struct drm_fb_helper_connector
*fb_helper_conn
;
2242 int hoffset
= 0, voffset
= 0;
2244 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2245 fb_helper_conn
= fb_helper
->connector_info
[i
];
2246 if (!fb_helper_conn
->connector
->has_tile
)
2249 if (!modes
[i
] && (h_idx
|| v_idx
)) {
2250 DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i
,
2251 fb_helper_conn
->connector
->base
.id
);
2254 if (fb_helper_conn
->connector
->tile_h_loc
< h_idx
)
2255 hoffset
+= modes
[i
]->hdisplay
;
2257 if (fb_helper_conn
->connector
->tile_v_loc
< v_idx
)
2258 voffset
+= modes
[i
]->vdisplay
;
2260 offsets
[idx
].x
= hoffset
;
2261 offsets
[idx
].y
= voffset
;
2262 DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset
, voffset
, h_idx
, v_idx
);
2266 static bool drm_target_preferred(struct drm_fb_helper
*fb_helper
,
2267 struct drm_display_mode
**modes
,
2268 struct drm_fb_offset
*offsets
,
2269 bool *enabled
, int width
, int height
)
2271 struct drm_fb_helper_connector
*fb_helper_conn
;
2272 const u64 mask
= BIT_ULL(fb_helper
->connector_count
) - 1;
2273 u64 conn_configured
= 0;
2278 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2279 fb_helper_conn
= fb_helper
->connector_info
[i
];
2281 if (conn_configured
& BIT_ULL(i
))
2284 if (enabled
[i
] == false) {
2285 conn_configured
|= BIT_ULL(i
);
2289 /* first pass over all the untiled connectors */
2290 if (tile_pass
== 0 && fb_helper_conn
->connector
->has_tile
)
2293 if (tile_pass
== 1) {
2294 if (fb_helper_conn
->connector
->tile_h_loc
!= 0 ||
2295 fb_helper_conn
->connector
->tile_v_loc
!= 0)
2299 if (fb_helper_conn
->connector
->tile_h_loc
!= tile_pass
- 1 &&
2300 fb_helper_conn
->connector
->tile_v_loc
!= tile_pass
- 1)
2301 /* if this tile_pass doesn't cover any of the tiles - keep going */
2305 * find the tile offsets for this pass - need to find
2306 * all tiles left and above
2308 drm_get_tile_offsets(fb_helper
, modes
, offsets
,
2309 i
, fb_helper_conn
->connector
->tile_h_loc
, fb_helper_conn
->connector
->tile_v_loc
);
2311 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
2312 fb_helper_conn
->connector
->base
.id
);
2314 /* got for command line mode first */
2315 modes
[i
] = drm_pick_cmdline_mode(fb_helper_conn
);
2317 DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
2318 fb_helper_conn
->connector
->base
.id
, fb_helper_conn
->connector
->tile_group
? fb_helper_conn
->connector
->tile_group
->id
: 0);
2319 modes
[i
] = drm_has_preferred_mode(fb_helper_conn
, width
, height
);
2321 /* No preferred modes, pick one off the list */
2322 if (!modes
[i
] && !list_empty(&fb_helper_conn
->connector
->modes
)) {
2323 list_for_each_entry(modes
[i
], &fb_helper_conn
->connector
->modes
, head
)
2326 DRM_DEBUG_KMS("found mode %s\n", modes
[i
] ? modes
[i
]->name
:
2328 conn_configured
|= BIT_ULL(i
);
2331 if ((conn_configured
& mask
) != mask
) {
2338 static bool connector_has_possible_crtc(struct drm_connector
*connector
,
2339 struct drm_crtc
*crtc
)
2341 struct drm_encoder
*encoder
;
2344 drm_connector_for_each_possible_encoder(connector
, encoder
, i
) {
2345 if (encoder
->possible_crtcs
& drm_crtc_mask(crtc
))
2352 static int drm_pick_crtcs(struct drm_fb_helper
*fb_helper
,
2353 struct drm_fb_helper_crtc
**best_crtcs
,
2354 struct drm_display_mode
**modes
,
2355 int n
, int width
, int height
)
2358 struct drm_connector
*connector
;
2359 int my_score
, best_score
, score
;
2360 struct drm_fb_helper_crtc
**crtcs
, *crtc
;
2361 struct drm_fb_helper_connector
*fb_helper_conn
;
2363 if (n
== fb_helper
->connector_count
)
2366 fb_helper_conn
= fb_helper
->connector_info
[n
];
2367 connector
= fb_helper_conn
->connector
;
2369 best_crtcs
[n
] = NULL
;
2370 best_score
= drm_pick_crtcs(fb_helper
, best_crtcs
, modes
, n
+1, width
, height
);
2371 if (modes
[n
] == NULL
)
2374 crtcs
= kcalloc(fb_helper
->connector_count
,
2375 sizeof(struct drm_fb_helper_crtc
*), GFP_KERNEL
);
2380 if (connector
->status
== connector_status_connected
)
2382 if (drm_has_cmdline_mode(fb_helper_conn
))
2384 if (drm_has_preferred_mode(fb_helper_conn
, width
, height
))
2388 * select a crtc for this connector and then attempt to configure
2389 * remaining connectors
2391 for (c
= 0; c
< fb_helper
->crtc_count
; c
++) {
2392 crtc
= &fb_helper
->crtc_info
[c
];
2394 if (!connector_has_possible_crtc(connector
,
2395 crtc
->mode_set
.crtc
))
2398 for (o
= 0; o
< n
; o
++)
2399 if (best_crtcs
[o
] == crtc
)
2403 /* ignore cloning unless only a single crtc */
2404 if (fb_helper
->crtc_count
> 1)
2407 if (!drm_mode_equal(modes
[o
], modes
[n
]))
2412 memcpy(crtcs
, best_crtcs
, n
* sizeof(struct drm_fb_helper_crtc
*));
2413 score
= my_score
+ drm_pick_crtcs(fb_helper
, crtcs
, modes
, n
+ 1,
2415 if (score
> best_score
) {
2417 memcpy(best_crtcs
, crtcs
,
2418 fb_helper
->connector_count
*
2419 sizeof(struct drm_fb_helper_crtc
*));
2428 * This function checks if rotation is necessary because of panel orientation
2429 * and if it is, if it is supported.
2430 * If rotation is necessary and supported, its gets set in fb_crtc.rotation.
2431 * If rotation is necessary but not supported, a DRM_MODE_ROTATE_* flag gets
2432 * or-ed into fb_helper->sw_rotations. In drm_setup_crtcs_fb() we check if only
2433 * one bit is set and then we set fb_info.fbcon_rotate_hint to make fbcon do
2434 * the unsupported rotation.
2436 static void drm_setup_crtc_rotation(struct drm_fb_helper
*fb_helper
,
2437 struct drm_fb_helper_crtc
*fb_crtc
,
2438 struct drm_connector
*connector
)
2440 struct drm_plane
*plane
= fb_crtc
->mode_set
.crtc
->primary
;
2441 uint64_t valid_mask
= 0;
2444 fb_crtc
->rotation
= DRM_MODE_ROTATE_0
;
2446 switch (connector
->display_info
.panel_orientation
) {
2447 case DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP
:
2448 rotation
= DRM_MODE_ROTATE_180
;
2450 case DRM_MODE_PANEL_ORIENTATION_LEFT_UP
:
2451 rotation
= DRM_MODE_ROTATE_90
;
2453 case DRM_MODE_PANEL_ORIENTATION_RIGHT_UP
:
2454 rotation
= DRM_MODE_ROTATE_270
;
2457 rotation
= DRM_MODE_ROTATE_0
;
2461 * TODO: support 90 / 270 degree hardware rotation,
2462 * depending on the hardware this may require the framebuffer
2463 * to be in a specific tiling format.
2465 if (rotation
!= DRM_MODE_ROTATE_180
|| !plane
->rotation_property
) {
2466 fb_helper
->sw_rotations
|= rotation
;
2470 for (i
= 0; i
< plane
->rotation_property
->num_values
; i
++)
2471 valid_mask
|= (1ULL << plane
->rotation_property
->values
[i
]);
2473 if (!(rotation
& valid_mask
)) {
2474 fb_helper
->sw_rotations
|= rotation
;
2478 fb_crtc
->rotation
= rotation
;
2479 /* Rotating in hardware, fbcon should not rotate */
2480 fb_helper
->sw_rotations
|= DRM_MODE_ROTATE_0
;
2483 static void drm_setup_crtcs(struct drm_fb_helper
*fb_helper
,
2484 u32 width
, u32 height
)
2486 struct drm_device
*dev
= fb_helper
->dev
;
2487 struct drm_fb_helper_crtc
**crtcs
;
2488 struct drm_display_mode
**modes
;
2489 struct drm_fb_offset
*offsets
;
2493 DRM_DEBUG_KMS("\n");
2494 /* prevent concurrent modification of connector_count by hotplug */
2495 lockdep_assert_held(&fb_helper
->lock
);
2497 crtcs
= kcalloc(fb_helper
->connector_count
,
2498 sizeof(struct drm_fb_helper_crtc
*), GFP_KERNEL
);
2499 modes
= kcalloc(fb_helper
->connector_count
,
2500 sizeof(struct drm_display_mode
*), GFP_KERNEL
);
2501 offsets
= kcalloc(fb_helper
->connector_count
,
2502 sizeof(struct drm_fb_offset
), GFP_KERNEL
);
2503 enabled
= kcalloc(fb_helper
->connector_count
,
2504 sizeof(bool), GFP_KERNEL
);
2505 if (!crtcs
|| !modes
|| !enabled
|| !offsets
) {
2506 DRM_ERROR("Memory allocation failed\n");
2510 mutex_lock(&fb_helper
->dev
->mode_config
.mutex
);
2511 if (drm_fb_helper_probe_connector_modes(fb_helper
, width
, height
) == 0)
2512 DRM_DEBUG_KMS("No connectors reported connected with modes\n");
2513 drm_enable_connectors(fb_helper
, enabled
);
2515 if (!(fb_helper
->funcs
->initial_config
&&
2516 fb_helper
->funcs
->initial_config(fb_helper
, crtcs
, modes
,
2518 enabled
, width
, height
))) {
2519 memset(modes
, 0, fb_helper
->connector_count
*sizeof(modes
[0]));
2520 memset(crtcs
, 0, fb_helper
->connector_count
*sizeof(crtcs
[0]));
2521 memset(offsets
, 0, fb_helper
->connector_count
*sizeof(offsets
[0]));
2523 if (!drm_target_cloned(fb_helper
, modes
, offsets
,
2524 enabled
, width
, height
) &&
2525 !drm_target_preferred(fb_helper
, modes
, offsets
,
2526 enabled
, width
, height
))
2527 DRM_ERROR("Unable to find initial modes\n");
2529 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2532 drm_pick_crtcs(fb_helper
, crtcs
, modes
, 0, width
, height
);
2534 mutex_unlock(&fb_helper
->dev
->mode_config
.mutex
);
2536 /* need to set the modesets up here for use later */
2537 /* fill out the connector<->crtc mappings into the modesets */
2538 for (i
= 0; i
< fb_helper
->crtc_count
; i
++)
2539 drm_fb_helper_modeset_release(fb_helper
,
2540 &fb_helper
->crtc_info
[i
].mode_set
);
2542 fb_helper
->sw_rotations
= 0;
2543 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2544 struct drm_display_mode
*mode
= modes
[i
];
2545 struct drm_fb_helper_crtc
*fb_crtc
= crtcs
[i
];
2546 struct drm_fb_offset
*offset
= &offsets
[i
];
2548 if (mode
&& fb_crtc
) {
2549 struct drm_mode_set
*modeset
= &fb_crtc
->mode_set
;
2550 struct drm_connector
*connector
=
2551 fb_helper
->connector_info
[i
]->connector
;
2553 DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2554 mode
->name
, fb_crtc
->mode_set
.crtc
->base
.id
, offset
->x
, offset
->y
);
2556 fb_crtc
->desired_mode
= mode
;
2557 fb_crtc
->x
= offset
->x
;
2558 fb_crtc
->y
= offset
->y
;
2559 modeset
->mode
= drm_mode_duplicate(dev
,
2560 fb_crtc
->desired_mode
);
2561 drm_connector_get(connector
);
2562 drm_setup_crtc_rotation(fb_helper
, fb_crtc
, connector
);
2563 modeset
->connectors
[modeset
->num_connectors
++] = connector
;
2564 modeset
->x
= offset
->x
;
2565 modeset
->y
= offset
->y
;
2576 * This is a continuation of drm_setup_crtcs() that sets up anything related
2577 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
2578 * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
2579 * So, any setup that touches those fields needs to be done here instead of in
2580 * drm_setup_crtcs().
2582 static void drm_setup_crtcs_fb(struct drm_fb_helper
*fb_helper
)
2584 struct fb_info
*info
= fb_helper
->fbdev
;
2587 for (i
= 0; i
< fb_helper
->crtc_count
; i
++)
2588 if (fb_helper
->crtc_info
[i
].mode_set
.num_connectors
)
2589 fb_helper
->crtc_info
[i
].mode_set
.fb
= fb_helper
->fb
;
2591 mutex_lock(&fb_helper
->dev
->mode_config
.mutex
);
2592 drm_fb_helper_for_each_connector(fb_helper
, i
) {
2593 struct drm_connector
*connector
=
2594 fb_helper
->connector_info
[i
]->connector
;
2596 /* use first connected connector for the physical dimensions */
2597 if (connector
->status
== connector_status_connected
) {
2598 info
->var
.width
= connector
->display_info
.width_mm
;
2599 info
->var
.height
= connector
->display_info
.height_mm
;
2603 mutex_unlock(&fb_helper
->dev
->mode_config
.mutex
);
2605 switch (fb_helper
->sw_rotations
) {
2606 case DRM_MODE_ROTATE_0
:
2607 info
->fbcon_rotate_hint
= FB_ROTATE_UR
;
2609 case DRM_MODE_ROTATE_90
:
2610 info
->fbcon_rotate_hint
= FB_ROTATE_CCW
;
2612 case DRM_MODE_ROTATE_180
:
2613 info
->fbcon_rotate_hint
= FB_ROTATE_UD
;
2615 case DRM_MODE_ROTATE_270
:
2616 info
->fbcon_rotate_hint
= FB_ROTATE_CW
;
2620 * Multiple bits are set / multiple rotations requested
2621 * fbcon cannot handle separate rotation settings per
2622 * output, so fallback to unrotated.
2624 info
->fbcon_rotate_hint
= FB_ROTATE_UR
;
2628 /* Note: Drops fb_helper->lock before returning. */
2630 __drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper
*fb_helper
,
2633 struct drm_device
*dev
= fb_helper
->dev
;
2634 struct fb_info
*info
;
2635 unsigned int width
, height
;
2638 width
= dev
->mode_config
.max_width
;
2639 height
= dev
->mode_config
.max_height
;
2641 drm_setup_crtcs(fb_helper
, width
, height
);
2642 ret
= drm_fb_helper_single_fb_probe(fb_helper
, bpp_sel
);
2644 if (ret
== -EAGAIN
) {
2645 fb_helper
->preferred_bpp
= bpp_sel
;
2646 fb_helper
->deferred_setup
= true;
2649 mutex_unlock(&fb_helper
->lock
);
2653 drm_setup_crtcs_fb(fb_helper
);
2655 fb_helper
->deferred_setup
= false;
2657 info
= fb_helper
->fbdev
;
2658 info
->var
.pixclock
= 0;
2659 /* Shamelessly allow physical address leaking to userspace */
2660 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
2661 if (!drm_leak_fbdev_smem
)
2663 /* don't leak any physical addresses to userspace */
2664 info
->flags
|= FBINFO_HIDE_SMEM_START
;
2666 /* Need to drop locks to avoid recursive deadlock in
2667 * register_framebuffer. This is ok because the only thing left to do is
2668 * register the fbdev emulation instance in kernel_fb_helper_list. */
2669 mutex_unlock(&fb_helper
->lock
);
2671 ret
= register_framebuffer(info
);
2675 dev_info(dev
->dev
, "fb%d: %s frame buffer device\n",
2676 info
->node
, info
->fix
.id
);
2678 mutex_lock(&kernel_fb_helper_lock
);
2679 if (list_empty(&kernel_fb_helper_list
))
2680 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op
);
2682 list_add(&fb_helper
->kernel_fb_list
, &kernel_fb_helper_list
);
2683 mutex_unlock(&kernel_fb_helper_lock
);
2689 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2690 * @fb_helper: fb_helper device struct
2691 * @bpp_sel: bpp value to use for the framebuffer configuration
2693 * Scans the CRTCs and connectors and tries to put together an initial setup.
2694 * At the moment, this is a cloned configuration across all heads with
2695 * a new framebuffer object as the backing store.
2697 * Note that this also registers the fbdev and so allows userspace to call into
2698 * the driver through the fbdev interfaces.
2700 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
2701 * to let the driver allocate and initialize the fbdev info structure and the
2702 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2703 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2704 * values for the fbdev info structure.
2708 * When you have fbcon support built-in or already loaded, this function will do
2709 * a full modeset to setup the fbdev console. Due to locking misdesign in the
2710 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2711 * console_lock. Until console_unlock is called no dmesg lines will be sent out
2712 * to consoles, not even serial console. This means when your driver crashes,
2713 * you will see absolutely nothing else but a system stuck in this function,
2714 * with no further output. Any kind of printk() you place within your own driver
2715 * or in the drm core modeset code will also never show up.
2717 * Standard debug practice is to run the fbcon setup without taking the
2718 * console_lock as a hack, to be able to see backtraces and crashes on the
2719 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2722 * The other option is to just disable fbdev emulation since very likely the
2723 * first modeset from userspace will crash in the same way, and is even easier
2724 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2725 * kernel cmdline option.
2728 * Zero if everything went ok, nonzero otherwise.
2730 int drm_fb_helper_initial_config(struct drm_fb_helper
*fb_helper
, int bpp_sel
)
2734 if (!drm_fbdev_emulation
)
2737 mutex_lock(&fb_helper
->lock
);
2738 ret
= __drm_fb_helper_initial_config_and_unlock(fb_helper
, bpp_sel
);
2742 EXPORT_SYMBOL(drm_fb_helper_initial_config
);
2745 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2746 * probing all the outputs attached to the fb
2747 * @fb_helper: driver-allocated fbdev helper, can be NULL
2749 * Scan the connectors attached to the fb_helper and try to put together a
2750 * setup after notification of a change in output configuration.
2752 * Called at runtime, takes the mode config locks to be able to check/change the
2753 * modeset configuration. Must be run from process context (which usually means
2754 * either the output polling work or a work item launched from the driver's
2755 * hotplug interrupt).
2757 * Note that drivers may call this even before calling
2758 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2759 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2760 * not miss any hotplug events.
2763 * 0 on success and a non-zero error code otherwise.
2765 int drm_fb_helper_hotplug_event(struct drm_fb_helper
*fb_helper
)
2769 if (!drm_fbdev_emulation
|| !fb_helper
)
2772 mutex_lock(&fb_helper
->lock
);
2773 if (fb_helper
->deferred_setup
) {
2774 err
= __drm_fb_helper_initial_config_and_unlock(fb_helper
,
2775 fb_helper
->preferred_bpp
);
2779 if (!fb_helper
->fb
|| !drm_fb_helper_is_bound(fb_helper
)) {
2780 fb_helper
->delayed_hotplug
= true;
2781 mutex_unlock(&fb_helper
->lock
);
2785 DRM_DEBUG_KMS("\n");
2787 drm_setup_crtcs(fb_helper
, fb_helper
->fb
->width
, fb_helper
->fb
->height
);
2788 drm_setup_crtcs_fb(fb_helper
);
2789 mutex_unlock(&fb_helper
->lock
);
2791 drm_fb_helper_set_par(fb_helper
->fbdev
);
2795 EXPORT_SYMBOL(drm_fb_helper_hotplug_event
);
2798 * drm_fb_helper_fbdev_setup() - Setup fbdev emulation
2800 * @fb_helper: fbdev helper structure to set up
2801 * @funcs: fbdev helper functions
2802 * @preferred_bpp: Preferred bits per pixel for the device.
2803 * @dev->mode_config.preferred_depth is used if this is zero.
2804 * @max_conn_count: Maximum number of connectors.
2805 * @dev->mode_config.num_connector is used if this is zero.
2807 * This function sets up fbdev emulation and registers fbdev for access by
2808 * userspace. If all connectors are disconnected, setup is deferred to the next
2809 * time drm_fb_helper_hotplug_event() is called.
2810 * The caller must to provide a &drm_fb_helper_funcs->fb_probe callback
2813 * Use drm_fb_helper_fbdev_teardown() to destroy the fbdev.
2815 * See also: drm_fb_helper_initial_config(), drm_fbdev_generic_setup().
2818 * Zero on success or negative error code on failure.
2820 int drm_fb_helper_fbdev_setup(struct drm_device
*dev
,
2821 struct drm_fb_helper
*fb_helper
,
2822 const struct drm_fb_helper_funcs
*funcs
,
2823 unsigned int preferred_bpp
,
2824 unsigned int max_conn_count
)
2829 preferred_bpp
= dev
->mode_config
.preferred_depth
;
2833 if (!max_conn_count
)
2834 max_conn_count
= dev
->mode_config
.num_connector
;
2835 if (!max_conn_count
) {
2836 DRM_DEV_ERROR(dev
->dev
, "fbdev: No connectors\n");
2840 drm_fb_helper_prepare(dev
, fb_helper
, funcs
);
2842 ret
= drm_fb_helper_init(dev
, fb_helper
, max_conn_count
);
2844 DRM_DEV_ERROR(dev
->dev
, "fbdev: Failed to initialize (ret=%d)\n", ret
);
2848 ret
= drm_fb_helper_single_add_all_connectors(fb_helper
);
2850 DRM_DEV_ERROR(dev
->dev
, "fbdev: Failed to add connectors (ret=%d)\n", ret
);
2851 goto err_drm_fb_helper_fini
;
2854 if (!drm_drv_uses_atomic_modeset(dev
))
2855 drm_helper_disable_unused_functions(dev
);
2857 ret
= drm_fb_helper_initial_config(fb_helper
, preferred_bpp
);
2859 DRM_DEV_ERROR(dev
->dev
, "fbdev: Failed to set configuration (ret=%d)\n", ret
);
2860 goto err_drm_fb_helper_fini
;
2865 err_drm_fb_helper_fini
:
2866 drm_fb_helper_fini(fb_helper
);
2870 EXPORT_SYMBOL(drm_fb_helper_fbdev_setup
);
2873 * drm_fb_helper_fbdev_teardown - Tear down fbdev emulation
2876 * This function unregisters fbdev if not already done and cleans up the
2877 * associated resources including the &drm_framebuffer.
2878 * The driver is responsible for freeing the &drm_fb_helper structure which is
2879 * stored in &drm_device->fb_helper. Do note that this pointer has been cleared
2880 * when this function returns.
2882 * In order to support device removal/unplug while file handles are still open,
2883 * drm_fb_helper_unregister_fbi() should be called on device removal and
2884 * drm_fb_helper_fbdev_teardown() in the &drm_driver->release callback when
2885 * file handles are closed.
2887 void drm_fb_helper_fbdev_teardown(struct drm_device
*dev
)
2889 struct drm_fb_helper
*fb_helper
= dev
->fb_helper
;
2890 struct fb_ops
*fbops
= NULL
;
2895 /* Unregister if it hasn't been done already */
2896 if (fb_helper
->fbdev
&& fb_helper
->fbdev
->dev
)
2897 drm_fb_helper_unregister_fbi(fb_helper
);
2899 if (fb_helper
->fbdev
&& fb_helper
->fbdev
->fbdefio
) {
2900 fb_deferred_io_cleanup(fb_helper
->fbdev
);
2901 kfree(fb_helper
->fbdev
->fbdefio
);
2902 fbops
= fb_helper
->fbdev
->fbops
;
2905 drm_fb_helper_fini(fb_helper
);
2909 drm_framebuffer_remove(fb_helper
->fb
);
2911 EXPORT_SYMBOL(drm_fb_helper_fbdev_teardown
);
2914 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
2917 * This function can be used as the &drm_driver->lastclose callback for drivers
2918 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
2920 void drm_fb_helper_lastclose(struct drm_device
*dev
)
2922 drm_fb_helper_restore_fbdev_mode_unlocked(dev
->fb_helper
);
2924 EXPORT_SYMBOL(drm_fb_helper_lastclose
);
2927 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
2928 * helper for fbdev emulation
2931 * This function can be used as the
2932 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
2933 * need to call drm_fb_helper_hotplug_event().
2935 void drm_fb_helper_output_poll_changed(struct drm_device
*dev
)
2937 drm_fb_helper_hotplug_event(dev
->fb_helper
);
2939 EXPORT_SYMBOL(drm_fb_helper_output_poll_changed
);
2941 /* @user: 1=userspace, 0=fbcon */
2942 static int drm_fbdev_fb_open(struct fb_info
*info
, int user
)
2944 struct drm_fb_helper
*fb_helper
= info
->par
;
2946 if (!try_module_get(fb_helper
->dev
->driver
->fops
->owner
))
2952 static int drm_fbdev_fb_release(struct fb_info
*info
, int user
)
2954 struct drm_fb_helper
*fb_helper
= info
->par
;
2956 module_put(fb_helper
->dev
->driver
->fops
->owner
);
2962 * fb_ops.fb_destroy is called by the last put_fb_info() call at the end of
2963 * unregister_framebuffer() or fb_release().
2965 static void drm_fbdev_fb_destroy(struct fb_info
*info
)
2967 struct drm_fb_helper
*fb_helper
= info
->par
;
2968 struct fb_info
*fbi
= fb_helper
->fbdev
;
2969 struct fb_ops
*fbops
= NULL
;
2970 void *shadow
= NULL
;
2973 fb_deferred_io_cleanup(fbi
);
2974 shadow
= fbi
->screen_buffer
;
2978 drm_fb_helper_fini(fb_helper
);
2985 drm_client_framebuffer_delete(fb_helper
->buffer
);
2988 * Remove conditional when all CMA drivers have been moved over to using
2989 * drm_fbdev_generic_setup().
2991 if (fb_helper
->client
.funcs
) {
2992 drm_client_release(&fb_helper
->client
);
2997 static int drm_fbdev_fb_mmap(struct fb_info
*info
, struct vm_area_struct
*vma
)
2999 struct drm_fb_helper
*fb_helper
= info
->par
;
3001 if (fb_helper
->dev
->driver
->gem_prime_mmap
)
3002 return fb_helper
->dev
->driver
->gem_prime_mmap(fb_helper
->buffer
->gem
, vma
);
3007 static struct fb_ops drm_fbdev_fb_ops
= {
3008 .owner
= THIS_MODULE
,
3009 DRM_FB_HELPER_DEFAULT_OPS
,
3010 .fb_open
= drm_fbdev_fb_open
,
3011 .fb_release
= drm_fbdev_fb_release
,
3012 .fb_destroy
= drm_fbdev_fb_destroy
,
3013 .fb_mmap
= drm_fbdev_fb_mmap
,
3014 .fb_read
= drm_fb_helper_sys_read
,
3015 .fb_write
= drm_fb_helper_sys_write
,
3016 .fb_fillrect
= drm_fb_helper_sys_fillrect
,
3017 .fb_copyarea
= drm_fb_helper_sys_copyarea
,
3018 .fb_imageblit
= drm_fb_helper_sys_imageblit
,
3021 static struct fb_deferred_io drm_fbdev_defio
= {
3023 .deferred_io
= drm_fb_helper_deferred_io
,
3027 * drm_fb_helper_generic_probe - Generic fbdev emulation probe helper
3028 * @fb_helper: fbdev helper structure
3029 * @sizes: describes fbdev size and scanout surface size
3031 * This function uses the client API to create a framebuffer backed by a dumb buffer.
3033 * The _sys_ versions are used for &fb_ops.fb_read, fb_write, fb_fillrect,
3034 * fb_copyarea, fb_imageblit.
3037 * Zero on success or negative error code on failure.
3039 int drm_fb_helper_generic_probe(struct drm_fb_helper
*fb_helper
,
3040 struct drm_fb_helper_surface_size
*sizes
)
3042 struct drm_client_dev
*client
= &fb_helper
->client
;
3043 struct drm_client_buffer
*buffer
;
3044 struct drm_framebuffer
*fb
;
3045 struct fb_info
*fbi
;
3049 DRM_DEBUG_KMS("surface width(%d), height(%d) and bpp(%d)\n",
3050 sizes
->surface_width
, sizes
->surface_height
,
3051 sizes
->surface_bpp
);
3053 format
= drm_mode_legacy_fb_format(sizes
->surface_bpp
, sizes
->surface_depth
);
3054 buffer
= drm_client_framebuffer_create(client
, sizes
->surface_width
,
3055 sizes
->surface_height
, format
);
3057 return PTR_ERR(buffer
);
3059 fb_helper
->buffer
= buffer
;
3060 fb_helper
->fb
= buffer
->fb
;
3063 fbi
= drm_fb_helper_alloc_fbi(fb_helper
);
3066 goto err_free_buffer
;
3069 fbi
->par
= fb_helper
;
3070 fbi
->fbops
= &drm_fbdev_fb_ops
;
3071 fbi
->screen_size
= fb
->height
* fb
->pitches
[0];
3072 fbi
->fix
.smem_len
= fbi
->screen_size
;
3073 fbi
->screen_buffer
= buffer
->vaddr
;
3074 /* Shamelessly leak the physical address to user-space */
3075 #if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
3076 if (drm_leak_fbdev_smem
&& fbi
->fix
.smem_start
== 0)
3077 fbi
->fix
.smem_start
=
3078 page_to_phys(virt_to_page(fbi
->screen_buffer
));
3080 strcpy(fbi
->fix
.id
, "DRM emulated");
3082 drm_fb_helper_fill_fix(fbi
, fb
->pitches
[0], fb
->format
->depth
);
3083 drm_fb_helper_fill_var(fbi
, fb_helper
, sizes
->fb_width
, sizes
->fb_height
);
3085 if (fb
->funcs
->dirty
) {
3086 struct fb_ops
*fbops
;
3090 * fb_deferred_io_cleanup() clears &fbops->fb_mmap so a per
3091 * instance version is necessary.
3093 fbops
= kzalloc(sizeof(*fbops
), GFP_KERNEL
);
3094 shadow
= vzalloc(fbi
->screen_size
);
3095 if (!fbops
|| !shadow
) {
3099 goto err_fb_info_destroy
;
3102 *fbops
= *fbi
->fbops
;
3104 fbi
->screen_buffer
= shadow
;
3105 fbi
->fbdefio
= &drm_fbdev_defio
;
3107 fb_deferred_io_init(fbi
);
3112 err_fb_info_destroy
:
3113 drm_fb_helper_fini(fb_helper
);
3115 drm_client_framebuffer_delete(buffer
);
3119 EXPORT_SYMBOL(drm_fb_helper_generic_probe
);
3121 static const struct drm_fb_helper_funcs drm_fb_helper_generic_funcs
= {
3122 .fb_probe
= drm_fb_helper_generic_probe
,
3125 static void drm_fbdev_client_unregister(struct drm_client_dev
*client
)
3127 struct drm_fb_helper
*fb_helper
= drm_fb_helper_from_client(client
);
3129 if (fb_helper
->fbdev
) {
3130 drm_fb_helper_unregister_fbi(fb_helper
);
3131 /* drm_fbdev_fb_destroy() takes care of cleanup */
3135 /* Did drm_fb_helper_fbdev_setup() run? */
3137 drm_fb_helper_fini(fb_helper
);
3139 drm_client_release(client
);
3143 static int drm_fbdev_client_restore(struct drm_client_dev
*client
)
3145 struct drm_fb_helper
*fb_helper
= drm_fb_helper_from_client(client
);
3147 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper
);
3152 static int drm_fbdev_client_hotplug(struct drm_client_dev
*client
)
3154 struct drm_fb_helper
*fb_helper
= drm_fb_helper_from_client(client
);
3155 struct drm_device
*dev
= client
->dev
;
3158 /* If drm_fb_helper_fbdev_setup() failed, we only try once */
3159 if (!fb_helper
->dev
&& fb_helper
->funcs
)
3163 return drm_fb_helper_hotplug_event(dev
->fb_helper
);
3165 if (!dev
->mode_config
.num_connector
) {
3166 DRM_DEV_DEBUG(dev
->dev
, "No connectors found, will not create framebuffer!\n");
3170 ret
= drm_fb_helper_fbdev_setup(dev
, fb_helper
, &drm_fb_helper_generic_funcs
,
3171 fb_helper
->preferred_bpp
, 0);
3173 fb_helper
->dev
= NULL
;
3174 fb_helper
->fbdev
= NULL
;
3181 static const struct drm_client_funcs drm_fbdev_client_funcs
= {
3182 .owner
= THIS_MODULE
,
3183 .unregister
= drm_fbdev_client_unregister
,
3184 .restore
= drm_fbdev_client_restore
,
3185 .hotplug
= drm_fbdev_client_hotplug
,
3189 * drm_fbdev_generic_setup() - Setup generic fbdev emulation
3191 * @preferred_bpp: Preferred bits per pixel for the device.
3192 * @dev->mode_config.preferred_depth is used if this is zero.
3194 * This function sets up generic fbdev emulation for drivers that supports
3195 * dumb buffers with a virtual address and that can be mmap'ed. If the driver
3196 * does not support these functions, it could use drm_fb_helper_fbdev_setup().
3198 * Restore, hotplug events and teardown are all taken care of. Drivers that do
3199 * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves.
3200 * Simple drivers might use drm_mode_config_helper_suspend().
3202 * Drivers that set the dirty callback on their framebuffer will get a shadow
3203 * fbdev buffer that is blitted onto the real buffer. This is done in order to
3204 * make deferred I/O work with all kinds of buffers.
3206 * This function is safe to call even when there are no connectors present.
3207 * Setup will be retried on the next hotplug event.
3209 * The fbdev is destroyed by drm_dev_unregister().
3212 * Zero on success or negative error code on failure.
3214 int drm_fbdev_generic_setup(struct drm_device
*dev
, unsigned int preferred_bpp
)
3216 struct drm_fb_helper
*fb_helper
;
3219 WARN(dev
->fb_helper
, "fb_helper is already set!\n");
3221 if (!drm_fbdev_emulation
)
3224 fb_helper
= kzalloc(sizeof(*fb_helper
), GFP_KERNEL
);
3228 ret
= drm_client_init(dev
, &fb_helper
->client
, "fbdev", &drm_fbdev_client_funcs
);
3231 DRM_DEV_ERROR(dev
->dev
, "Failed to register client: %d\n", ret
);
3235 drm_client_add(&fb_helper
->client
);
3237 fb_helper
->preferred_bpp
= preferred_bpp
;
3239 ret
= drm_fbdev_client_hotplug(&fb_helper
->client
);
3241 DRM_DEV_DEBUG(dev
->dev
, "client hotplug ret=%d\n", ret
);
3245 EXPORT_SYMBOL(drm_fbdev_generic_setup
);
3247 /* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
3248 * but the module doesn't depend on any fb console symbols. At least
3249 * attempt to load fbcon to avoid leaving the system without a usable console.
3251 int __init
drm_fb_helper_modinit(void)
3253 #if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
3254 const char name
[] = "fbcon";
3255 struct module
*fbcon
;
3257 mutex_lock(&module_mutex
);
3258 fbcon
= find_module(name
);
3259 mutex_unlock(&module_mutex
);
3262 request_module_nowait(name
);
3266 EXPORT_SYMBOL(drm_fb_helper_modinit
);