Loading...
1/*
2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
5 *
6 * DRM framebuffer helper functions
7 *
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.
17 *
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
24 * OF THIS SOFTWARE.
25 *
26 * Authors:
27 * Dave Airlie <airlied@linux.ie>
28 * Jesse Barnes <jesse.barnes@intel.com>
29 */
30#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31
32#include <linux/console.h>
33#include <linux/kernel.h>
34#include <linux/sysrq.h>
35#include <linux/slab.h>
36#include <linux/module.h>
37#include <drm/drmP.h>
38#include <drm/drm_crtc.h>
39#include <drm/drm_fb_helper.h>
40#include <drm/drm_crtc_helper.h>
41#include <drm/drm_atomic.h>
42#include <drm/drm_atomic_helper.h>
43
44#include "drm_crtc_internal.h"
45#include "drm_crtc_helper_internal.h"
46
47static bool drm_fbdev_emulation = true;
48module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
49MODULE_PARM_DESC(fbdev_emulation,
50 "Enable legacy fbdev emulation [default=true]");
51
52static int drm_fbdev_overalloc = CONFIG_DRM_FBDEV_OVERALLOC;
53module_param(drm_fbdev_overalloc, int, 0444);
54MODULE_PARM_DESC(drm_fbdev_overalloc,
55 "Overallocation of the fbdev buffer (%) [default="
56 __MODULE_STRING(CONFIG_DRM_FBDEV_OVERALLOC) "]");
57
58static LIST_HEAD(kernel_fb_helper_list);
59static DEFINE_MUTEX(kernel_fb_helper_lock);
60
61/**
62 * DOC: fbdev helpers
63 *
64 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
65 * mode setting driver. They can be used mostly independently from the crtc
66 * helper functions used by many drivers to implement the kernel mode setting
67 * interfaces.
68 *
69 * Setup fbdev emulation by calling drm_fb_helper_fbdev_setup() and tear it
70 * down by calling drm_fb_helper_fbdev_teardown().
71 *
72 * Drivers that need to handle connector hotplugging (e.g. dp mst) can't use
73 * the setup helper and will need to do the whole four-step setup process with
74 * drm_fb_helper_prepare(), drm_fb_helper_init(),
75 * drm_fb_helper_single_add_all_connectors(), enable hotplugging and
76 * drm_fb_helper_initial_config() to avoid a possible race window.
77 *
78 * At runtime drivers should restore the fbdev console by using
79 * drm_fb_helper_lastclose() as their &drm_driver.lastclose callback.
80 * They should also notify the fb helper code from updates to the output
81 * configuration by using drm_fb_helper_output_poll_changed() as their
82 * &drm_mode_config_funcs.output_poll_changed callback.
83 *
84 * For suspend/resume consider using drm_mode_config_helper_suspend() and
85 * drm_mode_config_helper_resume() which takes care of fbdev as well.
86 *
87 * All other functions exported by the fb helper library can be used to
88 * implement the fbdev driver interface by the driver.
89 *
90 * It is possible, though perhaps somewhat tricky, to implement race-free
91 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
92 * helper must be called first to initialize the minimum required to make
93 * hotplug detection work. Drivers also need to make sure to properly set up
94 * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init()
95 * it is safe to enable interrupts and start processing hotplug events. At the
96 * same time, drivers should initialize all modeset objects such as CRTCs,
97 * encoders and connectors. To finish up the fbdev helper initialization, the
98 * drm_fb_helper_init() function is called. To probe for all attached displays
99 * and set up an initial configuration using the detected hardware, drivers
100 * should call drm_fb_helper_single_add_all_connectors() followed by
101 * drm_fb_helper_initial_config().
102 *
103 * If &drm_framebuffer_funcs.dirty is set, the
104 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
105 * accumulate changes and schedule &drm_fb_helper.dirty_work to run right
106 * away. This worker then calls the dirty() function ensuring that it will
107 * always run in process context since the fb_*() function could be running in
108 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
109 * callback it will also schedule dirty_work with the damage collected from the
110 * mmap page writes. Drivers can use drm_fb_helper_defio_init() to setup
111 * deferred I/O (coupled with drm_fb_helper_fbdev_teardown()).
112 */
113
114#define drm_fb_helper_for_each_connector(fbh, i__) \
115 for (({ lockdep_assert_held(&(fbh)->lock); }), \
116 i__ = 0; i__ < (fbh)->connector_count; i__++)
117
118static int __drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
119 struct drm_connector *connector)
120{
121 struct drm_fb_helper_connector *fb_conn;
122 struct drm_fb_helper_connector **temp;
123 unsigned int count;
124
125 if (!drm_fbdev_emulation)
126 return 0;
127
128 lockdep_assert_held(&fb_helper->lock);
129
130 count = fb_helper->connector_count + 1;
131
132 if (count > fb_helper->connector_info_alloc_count) {
133 size_t size = count * sizeof(fb_conn);
134
135 temp = krealloc(fb_helper->connector_info, size, GFP_KERNEL);
136 if (!temp)
137 return -ENOMEM;
138
139 fb_helper->connector_info_alloc_count = count;
140 fb_helper->connector_info = temp;
141 }
142
143 fb_conn = kzalloc(sizeof(*fb_conn), GFP_KERNEL);
144 if (!fb_conn)
145 return -ENOMEM;
146
147 drm_connector_get(connector);
148 fb_conn->connector = connector;
149 fb_helper->connector_info[fb_helper->connector_count++] = fb_conn;
150
151 return 0;
152}
153
154int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
155 struct drm_connector *connector)
156{
157 int err;
158
159 if (!fb_helper)
160 return 0;
161
162 mutex_lock(&fb_helper->lock);
163 err = __drm_fb_helper_add_one_connector(fb_helper, connector);
164 mutex_unlock(&fb_helper->lock);
165
166 return err;
167}
168EXPORT_SYMBOL(drm_fb_helper_add_one_connector);
169
170/**
171 * drm_fb_helper_single_add_all_connectors() - add all connectors to fbdev
172 * emulation helper
173 * @fb_helper: fbdev initialized with drm_fb_helper_init, can be NULL
174 *
175 * This functions adds all the available connectors for use with the given
176 * fb_helper. This is a separate step to allow drivers to freely assign
177 * connectors to the fbdev, e.g. if some are reserved for special purposes or
178 * not adequate to be used for the fbcon.
179 *
180 * This function is protected against concurrent connector hotadds/removals
181 * using drm_fb_helper_add_one_connector() and
182 * drm_fb_helper_remove_one_connector().
183 */
184int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
185{
186 struct drm_device *dev;
187 struct drm_connector *connector;
188 struct drm_connector_list_iter conn_iter;
189 int i, ret = 0;
190
191 if (!drm_fbdev_emulation || !fb_helper)
192 return 0;
193
194 dev = fb_helper->dev;
195
196 mutex_lock(&fb_helper->lock);
197 drm_connector_list_iter_begin(dev, &conn_iter);
198 drm_for_each_connector_iter(connector, &conn_iter) {
199 ret = __drm_fb_helper_add_one_connector(fb_helper, connector);
200 if (ret)
201 goto fail;
202 }
203 goto out;
204
205fail:
206 drm_fb_helper_for_each_connector(fb_helper, i) {
207 struct drm_fb_helper_connector *fb_helper_connector =
208 fb_helper->connector_info[i];
209
210 drm_connector_put(fb_helper_connector->connector);
211
212 kfree(fb_helper_connector);
213 fb_helper->connector_info[i] = NULL;
214 }
215 fb_helper->connector_count = 0;
216out:
217 drm_connector_list_iter_end(&conn_iter);
218 mutex_unlock(&fb_helper->lock);
219
220 return ret;
221}
222EXPORT_SYMBOL(drm_fb_helper_single_add_all_connectors);
223
224static int __drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
225 struct drm_connector *connector)
226{
227 struct drm_fb_helper_connector *fb_helper_connector;
228 int i, j;
229
230 if (!drm_fbdev_emulation)
231 return 0;
232
233 lockdep_assert_held(&fb_helper->lock);
234
235 drm_fb_helper_for_each_connector(fb_helper, i) {
236 if (fb_helper->connector_info[i]->connector == connector)
237 break;
238 }
239
240 if (i == fb_helper->connector_count)
241 return -EINVAL;
242 fb_helper_connector = fb_helper->connector_info[i];
243 drm_connector_put(fb_helper_connector->connector);
244
245 for (j = i + 1; j < fb_helper->connector_count; j++)
246 fb_helper->connector_info[j - 1] = fb_helper->connector_info[j];
247
248 fb_helper->connector_count--;
249 kfree(fb_helper_connector);
250
251 return 0;
252}
253
254int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
255 struct drm_connector *connector)
256{
257 int err;
258
259 if (!fb_helper)
260 return 0;
261
262 mutex_lock(&fb_helper->lock);
263 err = __drm_fb_helper_remove_one_connector(fb_helper, connector);
264 mutex_unlock(&fb_helper->lock);
265
266 return err;
267}
268EXPORT_SYMBOL(drm_fb_helper_remove_one_connector);
269
270static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
271{
272 uint16_t *r_base, *g_base, *b_base;
273
274 if (crtc->funcs->gamma_set == NULL)
275 return;
276
277 r_base = crtc->gamma_store;
278 g_base = r_base + crtc->gamma_size;
279 b_base = g_base + crtc->gamma_size;
280
281 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base,
282 crtc->gamma_size, NULL);
283}
284
285/**
286 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
287 * @info: fbdev registered by the helper
288 */
289int drm_fb_helper_debug_enter(struct fb_info *info)
290{
291 struct drm_fb_helper *helper = info->par;
292 const struct drm_crtc_helper_funcs *funcs;
293 int i;
294
295 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
296 for (i = 0; i < helper->crtc_count; i++) {
297 struct drm_mode_set *mode_set =
298 &helper->crtc_info[i].mode_set;
299
300 if (!mode_set->crtc->enabled)
301 continue;
302
303 funcs = mode_set->crtc->helper_private;
304 if (funcs->mode_set_base_atomic == NULL)
305 continue;
306
307 if (drm_drv_uses_atomic_modeset(mode_set->crtc->dev))
308 continue;
309
310 funcs->mode_set_base_atomic(mode_set->crtc,
311 mode_set->fb,
312 mode_set->x,
313 mode_set->y,
314 ENTER_ATOMIC_MODE_SET);
315 }
316 }
317
318 return 0;
319}
320EXPORT_SYMBOL(drm_fb_helper_debug_enter);
321
322/**
323 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
324 * @info: fbdev registered by the helper
325 */
326int drm_fb_helper_debug_leave(struct fb_info *info)
327{
328 struct drm_fb_helper *helper = info->par;
329 struct drm_crtc *crtc;
330 const struct drm_crtc_helper_funcs *funcs;
331 struct drm_framebuffer *fb;
332 int i;
333
334 for (i = 0; i < helper->crtc_count; i++) {
335 struct drm_mode_set *mode_set = &helper->crtc_info[i].mode_set;
336
337 crtc = mode_set->crtc;
338 if (drm_drv_uses_atomic_modeset(crtc->dev))
339 continue;
340
341 funcs = crtc->helper_private;
342 fb = crtc->primary->fb;
343
344 if (!crtc->enabled)
345 continue;
346
347 if (!fb) {
348 DRM_ERROR("no fb to restore??\n");
349 continue;
350 }
351
352 if (funcs->mode_set_base_atomic == NULL)
353 continue;
354
355 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
356 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
357 crtc->y, LEAVE_ATOMIC_MODE_SET);
358 }
359
360 return 0;
361}
362EXPORT_SYMBOL(drm_fb_helper_debug_leave);
363
364static int restore_fbdev_mode_atomic(struct drm_fb_helper *fb_helper, bool active)
365{
366 struct drm_device *dev = fb_helper->dev;
367 struct drm_plane_state *plane_state;
368 struct drm_plane *plane;
369 struct drm_atomic_state *state;
370 int i, ret;
371 unsigned int plane_mask;
372 struct drm_modeset_acquire_ctx ctx;
373
374 drm_modeset_acquire_init(&ctx, 0);
375
376 state = drm_atomic_state_alloc(dev);
377 if (!state) {
378 ret = -ENOMEM;
379 goto out_ctx;
380 }
381
382 state->acquire_ctx = &ctx;
383retry:
384 plane_mask = 0;
385 drm_for_each_plane(plane, dev) {
386 plane_state = drm_atomic_get_plane_state(state, plane);
387 if (IS_ERR(plane_state)) {
388 ret = PTR_ERR(plane_state);
389 goto out_state;
390 }
391
392 plane_state->rotation = DRM_MODE_ROTATE_0;
393
394 plane->old_fb = plane->fb;
395 plane_mask |= 1 << drm_plane_index(plane);
396
397 /* disable non-primary: */
398 if (plane->type == DRM_PLANE_TYPE_PRIMARY)
399 continue;
400
401 ret = __drm_atomic_helper_disable_plane(plane, plane_state);
402 if (ret != 0)
403 goto out_state;
404 }
405
406 for (i = 0; i < fb_helper->crtc_count; i++) {
407 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
408 struct drm_plane *primary = mode_set->crtc->primary;
409
410 /* Cannot fail as we've already gotten the plane state above */
411 plane_state = drm_atomic_get_new_plane_state(state, primary);
412 plane_state->rotation = fb_helper->crtc_info[i].rotation;
413
414 ret = __drm_atomic_helper_set_config(mode_set, state);
415 if (ret != 0)
416 goto out_state;
417
418 /*
419 * __drm_atomic_helper_set_config() sets active when a
420 * mode is set, unconditionally clear it if we force DPMS off
421 */
422 if (!active) {
423 struct drm_crtc *crtc = mode_set->crtc;
424 struct drm_crtc_state *crtc_state = drm_atomic_get_new_crtc_state(state, crtc);
425
426 crtc_state->active = false;
427 }
428 }
429
430 ret = drm_atomic_commit(state);
431
432out_state:
433 drm_atomic_clean_old_fb(dev, plane_mask, ret);
434
435 if (ret == -EDEADLK)
436 goto backoff;
437
438 drm_atomic_state_put(state);
439out_ctx:
440 drm_modeset_drop_locks(&ctx);
441 drm_modeset_acquire_fini(&ctx);
442
443 return ret;
444
445backoff:
446 drm_atomic_state_clear(state);
447 drm_modeset_backoff(&ctx);
448
449 goto retry;
450}
451
452static int restore_fbdev_mode_legacy(struct drm_fb_helper *fb_helper)
453{
454 struct drm_device *dev = fb_helper->dev;
455 struct drm_plane *plane;
456 int i, ret = 0;
457
458 drm_modeset_lock_all(fb_helper->dev);
459 drm_for_each_plane(plane, dev) {
460 if (plane->type != DRM_PLANE_TYPE_PRIMARY)
461 drm_plane_force_disable(plane);
462
463 if (plane->rotation_property)
464 drm_mode_plane_set_obj_prop(plane,
465 plane->rotation_property,
466 DRM_MODE_ROTATE_0);
467 }
468
469 for (i = 0; i < fb_helper->crtc_count; i++) {
470 struct drm_mode_set *mode_set = &fb_helper->crtc_info[i].mode_set;
471 struct drm_crtc *crtc = mode_set->crtc;
472
473 if (crtc->funcs->cursor_set2) {
474 ret = crtc->funcs->cursor_set2(crtc, NULL, 0, 0, 0, 0, 0);
475 if (ret)
476 goto out;
477 } else if (crtc->funcs->cursor_set) {
478 ret = crtc->funcs->cursor_set(crtc, NULL, 0, 0, 0);
479 if (ret)
480 goto out;
481 }
482
483 ret = drm_mode_set_config_internal(mode_set);
484 if (ret)
485 goto out;
486 }
487out:
488 drm_modeset_unlock_all(fb_helper->dev);
489
490 return ret;
491}
492
493static int restore_fbdev_mode(struct drm_fb_helper *fb_helper)
494{
495 struct drm_device *dev = fb_helper->dev;
496
497 if (drm_drv_uses_atomic_modeset(dev))
498 return restore_fbdev_mode_atomic(fb_helper, true);
499 else
500 return restore_fbdev_mode_legacy(fb_helper);
501}
502
503/**
504 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
505 * @fb_helper: driver-allocated fbdev helper, can be NULL
506 *
507 * This should be called from driver's drm &drm_driver.lastclose callback
508 * when implementing an fbcon on top of kms using this helper. This ensures that
509 * the user isn't greeted with a black screen when e.g. X dies.
510 *
511 * RETURNS:
512 * Zero if everything went ok, negative error code otherwise.
513 */
514int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
515{
516 bool do_delayed;
517 int ret;
518
519 if (!drm_fbdev_emulation || !fb_helper)
520 return -ENODEV;
521
522 if (READ_ONCE(fb_helper->deferred_setup))
523 return 0;
524
525 mutex_lock(&fb_helper->lock);
526 ret = restore_fbdev_mode(fb_helper);
527
528 do_delayed = fb_helper->delayed_hotplug;
529 if (do_delayed)
530 fb_helper->delayed_hotplug = false;
531 mutex_unlock(&fb_helper->lock);
532
533 if (do_delayed)
534 drm_fb_helper_hotplug_event(fb_helper);
535
536 return ret;
537}
538EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
539
540static bool drm_fb_helper_is_bound(struct drm_fb_helper *fb_helper)
541{
542 struct drm_device *dev = fb_helper->dev;
543 struct drm_crtc *crtc;
544 int bound = 0, crtcs_bound = 0;
545
546 /*
547 * Sometimes user space wants everything disabled, so don't steal the
548 * display if there's a master.
549 */
550 if (READ_ONCE(dev->master))
551 return false;
552
553 drm_for_each_crtc(crtc, dev) {
554 drm_modeset_lock(&crtc->mutex, NULL);
555 if (crtc->primary->fb)
556 crtcs_bound++;
557 if (crtc->primary->fb == fb_helper->fb)
558 bound++;
559 drm_modeset_unlock(&crtc->mutex);
560 }
561
562 if (bound < crtcs_bound)
563 return false;
564
565 return true;
566}
567
568#ifdef CONFIG_MAGIC_SYSRQ
569/*
570 * restore fbcon display for all kms driver's using this helper, used for sysrq
571 * and panic handling.
572 */
573static bool drm_fb_helper_force_kernel_mode(void)
574{
575 bool ret, error = false;
576 struct drm_fb_helper *helper;
577
578 if (list_empty(&kernel_fb_helper_list))
579 return false;
580
581 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
582 struct drm_device *dev = helper->dev;
583
584 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
585 continue;
586
587 mutex_lock(&helper->lock);
588 ret = restore_fbdev_mode(helper);
589 if (ret)
590 error = true;
591 mutex_unlock(&helper->lock);
592 }
593 return error;
594}
595
596static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
597{
598 bool ret;
599
600 ret = drm_fb_helper_force_kernel_mode();
601 if (ret == true)
602 DRM_ERROR("Failed to restore crtc configuration\n");
603}
604static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
605
606static void drm_fb_helper_sysrq(int dummy1)
607{
608 schedule_work(&drm_fb_helper_restore_work);
609}
610
611static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
612 .handler = drm_fb_helper_sysrq,
613 .help_msg = "force-fb(V)",
614 .action_msg = "Restore framebuffer console",
615};
616#else
617static struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
618#endif
619
620static void dpms_legacy(struct drm_fb_helper *fb_helper, int dpms_mode)
621{
622 struct drm_device *dev = fb_helper->dev;
623 struct drm_crtc *crtc;
624 struct drm_connector *connector;
625 int i, j;
626
627 drm_modeset_lock_all(dev);
628 for (i = 0; i < fb_helper->crtc_count; i++) {
629 crtc = fb_helper->crtc_info[i].mode_set.crtc;
630
631 if (!crtc->enabled)
632 continue;
633
634 /* Walk the connectors & encoders on this fb turning them on/off */
635 drm_fb_helper_for_each_connector(fb_helper, j) {
636 connector = fb_helper->connector_info[j]->connector;
637 connector->funcs->dpms(connector, dpms_mode);
638 drm_object_property_set_value(&connector->base,
639 dev->mode_config.dpms_property, dpms_mode);
640 }
641 }
642 drm_modeset_unlock_all(dev);
643}
644
645static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
646{
647 struct drm_fb_helper *fb_helper = info->par;
648
649 /*
650 * For each CRTC in this fb, turn the connectors on/off.
651 */
652 mutex_lock(&fb_helper->lock);
653 if (!drm_fb_helper_is_bound(fb_helper)) {
654 mutex_unlock(&fb_helper->lock);
655 return;
656 }
657
658 if (drm_drv_uses_atomic_modeset(fb_helper->dev))
659 restore_fbdev_mode_atomic(fb_helper, dpms_mode == DRM_MODE_DPMS_ON);
660 else
661 dpms_legacy(fb_helper, dpms_mode);
662 mutex_unlock(&fb_helper->lock);
663}
664
665/**
666 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
667 * @blank: desired blanking state
668 * @info: fbdev registered by the helper
669 */
670int drm_fb_helper_blank(int blank, struct fb_info *info)
671{
672 if (oops_in_progress)
673 return -EBUSY;
674
675 switch (blank) {
676 /* Display: On; HSync: On, VSync: On */
677 case FB_BLANK_UNBLANK:
678 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
679 break;
680 /* Display: Off; HSync: On, VSync: On */
681 case FB_BLANK_NORMAL:
682 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
683 break;
684 /* Display: Off; HSync: Off, VSync: On */
685 case FB_BLANK_HSYNC_SUSPEND:
686 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
687 break;
688 /* Display: Off; HSync: On, VSync: Off */
689 case FB_BLANK_VSYNC_SUSPEND:
690 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
691 break;
692 /* Display: Off; HSync: Off, VSync: Off */
693 case FB_BLANK_POWERDOWN:
694 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
695 break;
696 }
697 return 0;
698}
699EXPORT_SYMBOL(drm_fb_helper_blank);
700
701static void drm_fb_helper_modeset_release(struct drm_fb_helper *helper,
702 struct drm_mode_set *modeset)
703{
704 int i;
705
706 for (i = 0; i < modeset->num_connectors; i++) {
707 drm_connector_put(modeset->connectors[i]);
708 modeset->connectors[i] = NULL;
709 }
710 modeset->num_connectors = 0;
711
712 drm_mode_destroy(helper->dev, modeset->mode);
713 modeset->mode = NULL;
714
715 /* FIXME should hold a ref? */
716 modeset->fb = NULL;
717}
718
719static void drm_fb_helper_crtc_free(struct drm_fb_helper *helper)
720{
721 int i;
722
723 for (i = 0; i < helper->connector_count; i++) {
724 drm_connector_put(helper->connector_info[i]->connector);
725 kfree(helper->connector_info[i]);
726 }
727 kfree(helper->connector_info);
728
729 for (i = 0; i < helper->crtc_count; i++) {
730 struct drm_mode_set *modeset = &helper->crtc_info[i].mode_set;
731
732 drm_fb_helper_modeset_release(helper, modeset);
733 kfree(modeset->connectors);
734 }
735 kfree(helper->crtc_info);
736}
737
738static void drm_fb_helper_resume_worker(struct work_struct *work)
739{
740 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
741 resume_work);
742
743 console_lock();
744 fb_set_suspend(helper->fbdev, 0);
745 console_unlock();
746}
747
748static void drm_fb_helper_dirty_work(struct work_struct *work)
749{
750 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
751 dirty_work);
752 struct drm_clip_rect *clip = &helper->dirty_clip;
753 struct drm_clip_rect clip_copy;
754 unsigned long flags;
755
756 spin_lock_irqsave(&helper->dirty_lock, flags);
757 clip_copy = *clip;
758 clip->x1 = clip->y1 = ~0;
759 clip->x2 = clip->y2 = 0;
760 spin_unlock_irqrestore(&helper->dirty_lock, flags);
761
762 /* call dirty callback only when it has been really touched */
763 if (clip_copy.x1 < clip_copy.x2 && clip_copy.y1 < clip_copy.y2)
764 helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
765}
766
767/**
768 * drm_fb_helper_prepare - setup a drm_fb_helper structure
769 * @dev: DRM device
770 * @helper: driver-allocated fbdev helper structure to set up
771 * @funcs: pointer to structure of functions associate with this helper
772 *
773 * Sets up the bare minimum to make the framebuffer helper usable. This is
774 * useful to implement race-free initialization of the polling helpers.
775 */
776void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
777 const struct drm_fb_helper_funcs *funcs)
778{
779 INIT_LIST_HEAD(&helper->kernel_fb_list);
780 spin_lock_init(&helper->dirty_lock);
781 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
782 INIT_WORK(&helper->dirty_work, drm_fb_helper_dirty_work);
783 helper->dirty_clip.x1 = helper->dirty_clip.y1 = ~0;
784 mutex_init(&helper->lock);
785 helper->funcs = funcs;
786 helper->dev = dev;
787}
788EXPORT_SYMBOL(drm_fb_helper_prepare);
789
790/**
791 * drm_fb_helper_init - initialize a &struct drm_fb_helper
792 * @dev: drm device
793 * @fb_helper: driver-allocated fbdev helper structure to initialize
794 * @max_conn_count: max connector count
795 *
796 * This allocates the structures for the fbdev helper with the given limits.
797 * Note that this won't yet touch the hardware (through the driver interfaces)
798 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
799 * to allow driver writes more control over the exact init sequence.
800 *
801 * Drivers must call drm_fb_helper_prepare() before calling this function.
802 *
803 * RETURNS:
804 * Zero if everything went ok, nonzero otherwise.
805 */
806int drm_fb_helper_init(struct drm_device *dev,
807 struct drm_fb_helper *fb_helper,
808 int max_conn_count)
809{
810 struct drm_crtc *crtc;
811 struct drm_mode_config *config = &dev->mode_config;
812 int i;
813
814 if (!drm_fbdev_emulation) {
815 dev->fb_helper = fb_helper;
816 return 0;
817 }
818
819 if (!max_conn_count)
820 return -EINVAL;
821
822 fb_helper->crtc_info = kcalloc(config->num_crtc, sizeof(struct drm_fb_helper_crtc), GFP_KERNEL);
823 if (!fb_helper->crtc_info)
824 return -ENOMEM;
825
826 fb_helper->crtc_count = config->num_crtc;
827 fb_helper->connector_info = kcalloc(dev->mode_config.num_connector, sizeof(struct drm_fb_helper_connector *), GFP_KERNEL);
828 if (!fb_helper->connector_info) {
829 kfree(fb_helper->crtc_info);
830 return -ENOMEM;
831 }
832 fb_helper->connector_info_alloc_count = dev->mode_config.num_connector;
833 fb_helper->connector_count = 0;
834
835 for (i = 0; i < fb_helper->crtc_count; i++) {
836 fb_helper->crtc_info[i].mode_set.connectors =
837 kcalloc(max_conn_count,
838 sizeof(struct drm_connector *),
839 GFP_KERNEL);
840
841 if (!fb_helper->crtc_info[i].mode_set.connectors)
842 goto out_free;
843 fb_helper->crtc_info[i].mode_set.num_connectors = 0;
844 fb_helper->crtc_info[i].rotation = DRM_MODE_ROTATE_0;
845 }
846
847 i = 0;
848 drm_for_each_crtc(crtc, dev) {
849 fb_helper->crtc_info[i].mode_set.crtc = crtc;
850 i++;
851 }
852
853 dev->fb_helper = fb_helper;
854
855 return 0;
856out_free:
857 drm_fb_helper_crtc_free(fb_helper);
858 return -ENOMEM;
859}
860EXPORT_SYMBOL(drm_fb_helper_init);
861
862/**
863 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
864 * @fb_helper: driver-allocated fbdev helper
865 *
866 * A helper to alloc fb_info and the members cmap and apertures. Called
867 * by the driver within the fb_probe fb_helper callback function. Drivers do not
868 * need to release the allocated fb_info structure themselves, this is
869 * automatically done when calling drm_fb_helper_fini().
870 *
871 * RETURNS:
872 * fb_info pointer if things went okay, pointer containing error code
873 * otherwise
874 */
875struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
876{
877 struct device *dev = fb_helper->dev->dev;
878 struct fb_info *info;
879 int ret;
880
881 info = framebuffer_alloc(0, dev);
882 if (!info)
883 return ERR_PTR(-ENOMEM);
884
885 ret = fb_alloc_cmap(&info->cmap, 256, 0);
886 if (ret)
887 goto err_release;
888
889 info->apertures = alloc_apertures(1);
890 if (!info->apertures) {
891 ret = -ENOMEM;
892 goto err_free_cmap;
893 }
894
895 fb_helper->fbdev = info;
896
897 return info;
898
899err_free_cmap:
900 fb_dealloc_cmap(&info->cmap);
901err_release:
902 framebuffer_release(info);
903 return ERR_PTR(ret);
904}
905EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
906
907/**
908 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
909 * @fb_helper: driver-allocated fbdev helper, can be NULL
910 *
911 * A wrapper around unregister_framebuffer, to release the fb_info
912 * framebuffer device. This must be called before releasing all resources for
913 * @fb_helper by calling drm_fb_helper_fini().
914 */
915void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
916{
917 if (fb_helper && fb_helper->fbdev)
918 unregister_framebuffer(fb_helper->fbdev);
919}
920EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
921
922/**
923 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
924 * @fb_helper: driver-allocated fbdev helper, can be NULL
925 *
926 * This cleans up all remaining resources associated with @fb_helper. Must be
927 * called after drm_fb_helper_unlink_fbi() was called.
928 */
929void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
930{
931 struct fb_info *info;
932
933 if (!fb_helper)
934 return;
935
936 fb_helper->dev->fb_helper = NULL;
937
938 if (!drm_fbdev_emulation)
939 return;
940
941 cancel_work_sync(&fb_helper->resume_work);
942 cancel_work_sync(&fb_helper->dirty_work);
943
944 info = fb_helper->fbdev;
945 if (info) {
946 if (info->cmap.len)
947 fb_dealloc_cmap(&info->cmap);
948 framebuffer_release(info);
949 }
950 fb_helper->fbdev = NULL;
951
952 mutex_lock(&kernel_fb_helper_lock);
953 if (!list_empty(&fb_helper->kernel_fb_list)) {
954 list_del(&fb_helper->kernel_fb_list);
955 if (list_empty(&kernel_fb_helper_list))
956 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
957 }
958 mutex_unlock(&kernel_fb_helper_lock);
959
960 mutex_destroy(&fb_helper->lock);
961 drm_fb_helper_crtc_free(fb_helper);
962
963}
964EXPORT_SYMBOL(drm_fb_helper_fini);
965
966/**
967 * drm_fb_helper_unlink_fbi - wrapper around unlink_framebuffer
968 * @fb_helper: driver-allocated fbdev helper, can be NULL
969 *
970 * A wrapper around unlink_framebuffer implemented by fbdev core
971 */
972void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
973{
974 if (fb_helper && fb_helper->fbdev)
975 unlink_framebuffer(fb_helper->fbdev);
976}
977EXPORT_SYMBOL(drm_fb_helper_unlink_fbi);
978
979static void drm_fb_helper_dirty(struct fb_info *info, u32 x, u32 y,
980 u32 width, u32 height)
981{
982 struct drm_fb_helper *helper = info->par;
983 struct drm_clip_rect *clip = &helper->dirty_clip;
984 unsigned long flags;
985
986 if (!helper->fb->funcs->dirty)
987 return;
988
989 spin_lock_irqsave(&helper->dirty_lock, flags);
990 clip->x1 = min_t(u32, clip->x1, x);
991 clip->y1 = min_t(u32, clip->y1, y);
992 clip->x2 = max_t(u32, clip->x2, x + width);
993 clip->y2 = max_t(u32, clip->y2, y + height);
994 spin_unlock_irqrestore(&helper->dirty_lock, flags);
995
996 schedule_work(&helper->dirty_work);
997}
998
999/**
1000 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
1001 * @info: fb_info struct pointer
1002 * @pagelist: list of dirty mmap framebuffer pages
1003 *
1004 * This function is used as the &fb_deferred_io.deferred_io
1005 * callback function for flushing the fbdev mmap writes.
1006 */
1007void drm_fb_helper_deferred_io(struct fb_info *info,
1008 struct list_head *pagelist)
1009{
1010 unsigned long start, end, min, max;
1011 struct page *page;
1012 u32 y1, y2;
1013
1014 min = ULONG_MAX;
1015 max = 0;
1016 list_for_each_entry(page, pagelist, lru) {
1017 start = page->index << PAGE_SHIFT;
1018 end = start + PAGE_SIZE - 1;
1019 min = min(min, start);
1020 max = max(max, end);
1021 }
1022
1023 if (min < max) {
1024 y1 = min / info->fix.line_length;
1025 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
1026 info->var.yres);
1027 drm_fb_helper_dirty(info, 0, y1, info->var.xres, y2 - y1);
1028 }
1029}
1030EXPORT_SYMBOL(drm_fb_helper_deferred_io);
1031
1032/**
1033 * drm_fb_helper_defio_init - fbdev deferred I/O initialization
1034 * @fb_helper: driver-allocated fbdev helper
1035 *
1036 * This function allocates &fb_deferred_io, sets callback to
1037 * drm_fb_helper_deferred_io(), delay to 50ms and calls fb_deferred_io_init().
1038 * It should be called from the &drm_fb_helper_funcs->fb_probe callback.
1039 * drm_fb_helper_fbdev_teardown() cleans up deferred I/O.
1040 *
1041 * NOTE: A copy of &fb_ops is made and assigned to &info->fbops. This is done
1042 * because fb_deferred_io_cleanup() clears &fbops->fb_mmap and would thereby
1043 * affect other instances of that &fb_ops.
1044 *
1045 * Returns:
1046 * 0 on success or a negative error code on failure.
1047 */
1048int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
1049{
1050 struct fb_info *info = fb_helper->fbdev;
1051 struct fb_deferred_io *fbdefio;
1052 struct fb_ops *fbops;
1053
1054 fbdefio = kzalloc(sizeof(*fbdefio), GFP_KERNEL);
1055 fbops = kzalloc(sizeof(*fbops), GFP_KERNEL);
1056 if (!fbdefio || !fbops) {
1057 kfree(fbdefio);
1058 kfree(fbops);
1059 return -ENOMEM;
1060 }
1061
1062 info->fbdefio = fbdefio;
1063 fbdefio->delay = msecs_to_jiffies(50);
1064 fbdefio->deferred_io = drm_fb_helper_deferred_io;
1065
1066 *fbops = *info->fbops;
1067 info->fbops = fbops;
1068
1069 fb_deferred_io_init(info);
1070
1071 return 0;
1072}
1073EXPORT_SYMBOL(drm_fb_helper_defio_init);
1074
1075/**
1076 * drm_fb_helper_sys_read - wrapper around fb_sys_read
1077 * @info: fb_info struct pointer
1078 * @buf: userspace buffer to read from framebuffer memory
1079 * @count: number of bytes to read from framebuffer memory
1080 * @ppos: read offset within framebuffer memory
1081 *
1082 * A wrapper around fb_sys_read implemented by fbdev core
1083 */
1084ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
1085 size_t count, loff_t *ppos)
1086{
1087 return fb_sys_read(info, buf, count, ppos);
1088}
1089EXPORT_SYMBOL(drm_fb_helper_sys_read);
1090
1091/**
1092 * drm_fb_helper_sys_write - wrapper around fb_sys_write
1093 * @info: fb_info struct pointer
1094 * @buf: userspace buffer to write to framebuffer memory
1095 * @count: number of bytes to write to framebuffer memory
1096 * @ppos: write offset within framebuffer memory
1097 *
1098 * A wrapper around fb_sys_write implemented by fbdev core
1099 */
1100ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
1101 size_t count, loff_t *ppos)
1102{
1103 ssize_t ret;
1104
1105 ret = fb_sys_write(info, buf, count, ppos);
1106 if (ret > 0)
1107 drm_fb_helper_dirty(info, 0, 0, info->var.xres,
1108 info->var.yres);
1109
1110 return ret;
1111}
1112EXPORT_SYMBOL(drm_fb_helper_sys_write);
1113
1114/**
1115 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
1116 * @info: fbdev registered by the helper
1117 * @rect: info about rectangle to fill
1118 *
1119 * A wrapper around sys_fillrect implemented by fbdev core
1120 */
1121void drm_fb_helper_sys_fillrect(struct fb_info *info,
1122 const struct fb_fillrect *rect)
1123{
1124 sys_fillrect(info, rect);
1125 drm_fb_helper_dirty(info, rect->dx, rect->dy,
1126 rect->width, rect->height);
1127}
1128EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
1129
1130/**
1131 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
1132 * @info: fbdev registered by the helper
1133 * @area: info about area to copy
1134 *
1135 * A wrapper around sys_copyarea implemented by fbdev core
1136 */
1137void drm_fb_helper_sys_copyarea(struct fb_info *info,
1138 const struct fb_copyarea *area)
1139{
1140 sys_copyarea(info, area);
1141 drm_fb_helper_dirty(info, area->dx, area->dy,
1142 area->width, area->height);
1143}
1144EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
1145
1146/**
1147 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
1148 * @info: fbdev registered by the helper
1149 * @image: info about image to blit
1150 *
1151 * A wrapper around sys_imageblit implemented by fbdev core
1152 */
1153void drm_fb_helper_sys_imageblit(struct fb_info *info,
1154 const struct fb_image *image)
1155{
1156 sys_imageblit(info, image);
1157 drm_fb_helper_dirty(info, image->dx, image->dy,
1158 image->width, image->height);
1159}
1160EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
1161
1162/**
1163 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
1164 * @info: fbdev registered by the helper
1165 * @rect: info about rectangle to fill
1166 *
1167 * A wrapper around cfb_imageblit implemented by fbdev core
1168 */
1169void drm_fb_helper_cfb_fillrect(struct fb_info *info,
1170 const struct fb_fillrect *rect)
1171{
1172 cfb_fillrect(info, rect);
1173 drm_fb_helper_dirty(info, rect->dx, rect->dy,
1174 rect->width, rect->height);
1175}
1176EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
1177
1178/**
1179 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
1180 * @info: fbdev registered by the helper
1181 * @area: info about area to copy
1182 *
1183 * A wrapper around cfb_copyarea implemented by fbdev core
1184 */
1185void drm_fb_helper_cfb_copyarea(struct fb_info *info,
1186 const struct fb_copyarea *area)
1187{
1188 cfb_copyarea(info, area);
1189 drm_fb_helper_dirty(info, area->dx, area->dy,
1190 area->width, area->height);
1191}
1192EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
1193
1194/**
1195 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
1196 * @info: fbdev registered by the helper
1197 * @image: info about image to blit
1198 *
1199 * A wrapper around cfb_imageblit implemented by fbdev core
1200 */
1201void drm_fb_helper_cfb_imageblit(struct fb_info *info,
1202 const struct fb_image *image)
1203{
1204 cfb_imageblit(info, image);
1205 drm_fb_helper_dirty(info, image->dx, image->dy,
1206 image->width, image->height);
1207}
1208EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
1209
1210/**
1211 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
1212 * @fb_helper: driver-allocated fbdev helper, can be NULL
1213 * @suspend: whether to suspend or resume
1214 *
1215 * A wrapper around fb_set_suspend implemented by fbdev core.
1216 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
1217 * the lock yourself
1218 */
1219void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
1220{
1221 if (fb_helper && fb_helper->fbdev)
1222 fb_set_suspend(fb_helper->fbdev, suspend);
1223}
1224EXPORT_SYMBOL(drm_fb_helper_set_suspend);
1225
1226/**
1227 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
1228 * takes the console lock
1229 * @fb_helper: driver-allocated fbdev helper, can be NULL
1230 * @suspend: whether to suspend or resume
1231 *
1232 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
1233 * isn't available on resume, a worker is tasked with waiting for the lock
1234 * to become available. The console lock can be pretty contented on resume
1235 * due to all the printk activity.
1236 *
1237 * This function can be called multiple times with the same state since
1238 * &fb_info.state is checked to see if fbdev is running or not before locking.
1239 *
1240 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
1241 */
1242void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
1243 bool suspend)
1244{
1245 if (!fb_helper || !fb_helper->fbdev)
1246 return;
1247
1248 /* make sure there's no pending/ongoing resume */
1249 flush_work(&fb_helper->resume_work);
1250
1251 if (suspend) {
1252 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
1253 return;
1254
1255 console_lock();
1256
1257 } else {
1258 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
1259 return;
1260
1261 if (!console_trylock()) {
1262 schedule_work(&fb_helper->resume_work);
1263 return;
1264 }
1265 }
1266
1267 fb_set_suspend(fb_helper->fbdev, suspend);
1268 console_unlock();
1269}
1270EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
1271
1272static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info)
1273{
1274 u32 *palette = (u32 *)info->pseudo_palette;
1275 int i;
1276
1277 if (cmap->start + cmap->len > 16)
1278 return -EINVAL;
1279
1280 for (i = 0; i < cmap->len; ++i) {
1281 u16 red = cmap->red[i];
1282 u16 green = cmap->green[i];
1283 u16 blue = cmap->blue[i];
1284 u32 value;
1285
1286 red >>= 16 - info->var.red.length;
1287 green >>= 16 - info->var.green.length;
1288 blue >>= 16 - info->var.blue.length;
1289 value = (red << info->var.red.offset) |
1290 (green << info->var.green.offset) |
1291 (blue << info->var.blue.offset);
1292 if (info->var.transp.length > 0) {
1293 u32 mask = (1 << info->var.transp.length) - 1;
1294
1295 mask <<= info->var.transp.offset;
1296 value |= mask;
1297 }
1298 palette[cmap->start + i] = value;
1299 }
1300
1301 return 0;
1302}
1303
1304static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info)
1305{
1306 struct drm_fb_helper *fb_helper = info->par;
1307 struct drm_crtc *crtc;
1308 u16 *r, *g, *b;
1309 int i, ret = 0;
1310
1311 drm_modeset_lock_all(fb_helper->dev);
1312 for (i = 0; i < fb_helper->crtc_count; i++) {
1313 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1314 if (!crtc->funcs->gamma_set || !crtc->gamma_size)
1315 return -EINVAL;
1316
1317 if (cmap->start + cmap->len > crtc->gamma_size)
1318 return -EINVAL;
1319
1320 r = crtc->gamma_store;
1321 g = r + crtc->gamma_size;
1322 b = g + crtc->gamma_size;
1323
1324 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1325 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1326 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1327
1328 ret = crtc->funcs->gamma_set(crtc, r, g, b,
1329 crtc->gamma_size, NULL);
1330 if (ret)
1331 return ret;
1332 }
1333 drm_modeset_unlock_all(fb_helper->dev);
1334
1335 return ret;
1336}
1337
1338static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc,
1339 struct fb_cmap *cmap)
1340{
1341 struct drm_device *dev = crtc->dev;
1342 struct drm_property_blob *gamma_lut;
1343 struct drm_color_lut *lut;
1344 int size = crtc->gamma_size;
1345 int i;
1346
1347 if (!size || cmap->start + cmap->len > size)
1348 return ERR_PTR(-EINVAL);
1349
1350 gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL);
1351 if (IS_ERR(gamma_lut))
1352 return gamma_lut;
1353
1354 lut = gamma_lut->data;
1355 if (cmap->start || cmap->len != size) {
1356 u16 *r = crtc->gamma_store;
1357 u16 *g = r + crtc->gamma_size;
1358 u16 *b = g + crtc->gamma_size;
1359
1360 for (i = 0; i < cmap->start; i++) {
1361 lut[i].red = r[i];
1362 lut[i].green = g[i];
1363 lut[i].blue = b[i];
1364 }
1365 for (i = cmap->start + cmap->len; i < size; i++) {
1366 lut[i].red = r[i];
1367 lut[i].green = g[i];
1368 lut[i].blue = b[i];
1369 }
1370 }
1371
1372 for (i = 0; i < cmap->len; i++) {
1373 lut[cmap->start + i].red = cmap->red[i];
1374 lut[cmap->start + i].green = cmap->green[i];
1375 lut[cmap->start + i].blue = cmap->blue[i];
1376 }
1377
1378 return gamma_lut;
1379}
1380
1381static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info)
1382{
1383 struct drm_fb_helper *fb_helper = info->par;
1384 struct drm_device *dev = fb_helper->dev;
1385 struct drm_property_blob *gamma_lut = NULL;
1386 struct drm_modeset_acquire_ctx ctx;
1387 struct drm_crtc_state *crtc_state;
1388 struct drm_atomic_state *state;
1389 struct drm_crtc *crtc;
1390 u16 *r, *g, *b;
1391 int i, ret = 0;
1392 bool replaced;
1393
1394 drm_modeset_acquire_init(&ctx, 0);
1395
1396 state = drm_atomic_state_alloc(dev);
1397 if (!state) {
1398 ret = -ENOMEM;
1399 goto out_ctx;
1400 }
1401
1402 state->acquire_ctx = &ctx;
1403retry:
1404 for (i = 0; i < fb_helper->crtc_count; i++) {
1405 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1406
1407 if (!gamma_lut)
1408 gamma_lut = setcmap_new_gamma_lut(crtc, cmap);
1409 if (IS_ERR(gamma_lut)) {
1410 ret = PTR_ERR(gamma_lut);
1411 gamma_lut = NULL;
1412 goto out_state;
1413 }
1414
1415 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1416 if (IS_ERR(crtc_state)) {
1417 ret = PTR_ERR(crtc_state);
1418 goto out_state;
1419 }
1420
1421 replaced = drm_property_replace_blob(&crtc_state->degamma_lut,
1422 NULL);
1423 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
1424 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut,
1425 gamma_lut);
1426 crtc_state->color_mgmt_changed |= replaced;
1427 }
1428
1429 ret = drm_atomic_commit(state);
1430 if (ret)
1431 goto out_state;
1432
1433 for (i = 0; i < fb_helper->crtc_count; i++) {
1434 crtc = fb_helper->crtc_info[i].mode_set.crtc;
1435
1436 r = crtc->gamma_store;
1437 g = r + crtc->gamma_size;
1438 b = g + crtc->gamma_size;
1439
1440 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1441 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1442 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1443 }
1444
1445out_state:
1446 if (ret == -EDEADLK)
1447 goto backoff;
1448
1449 drm_property_blob_put(gamma_lut);
1450 drm_atomic_state_put(state);
1451out_ctx:
1452 drm_modeset_drop_locks(&ctx);
1453 drm_modeset_acquire_fini(&ctx);
1454
1455 return ret;
1456
1457backoff:
1458 drm_atomic_state_clear(state);
1459 drm_modeset_backoff(&ctx);
1460 goto retry;
1461}
1462
1463/**
1464 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1465 * @cmap: cmap to set
1466 * @info: fbdev registered by the helper
1467 */
1468int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1469{
1470 struct drm_fb_helper *fb_helper = info->par;
1471 int ret;
1472
1473 if (oops_in_progress)
1474 return -EBUSY;
1475
1476 mutex_lock(&fb_helper->lock);
1477
1478 if (!drm_fb_helper_is_bound(fb_helper)) {
1479 ret = -EBUSY;
1480 goto out;
1481 }
1482
1483 if (info->fix.visual == FB_VISUAL_TRUECOLOR)
1484 ret = setcmap_pseudo_palette(cmap, info);
1485 else if (drm_drv_uses_atomic_modeset(fb_helper->dev))
1486 ret = setcmap_atomic(cmap, info);
1487 else
1488 ret = setcmap_legacy(cmap, info);
1489
1490out:
1491 mutex_unlock(&fb_helper->lock);
1492
1493 return ret;
1494}
1495EXPORT_SYMBOL(drm_fb_helper_setcmap);
1496
1497/**
1498 * drm_fb_helper_ioctl - legacy ioctl implementation
1499 * @info: fbdev registered by the helper
1500 * @cmd: ioctl command
1501 * @arg: ioctl argument
1502 *
1503 * A helper to implement the standard fbdev ioctl. Only
1504 * FBIO_WAITFORVSYNC is implemented for now.
1505 */
1506int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
1507 unsigned long arg)
1508{
1509 struct drm_fb_helper *fb_helper = info->par;
1510 struct drm_mode_set *mode_set;
1511 struct drm_crtc *crtc;
1512 int ret = 0;
1513
1514 mutex_lock(&fb_helper->lock);
1515 if (!drm_fb_helper_is_bound(fb_helper)) {
1516 ret = -EBUSY;
1517 goto unlock;
1518 }
1519
1520 switch (cmd) {
1521 case FBIO_WAITFORVSYNC:
1522 /*
1523 * Only consider the first CRTC.
1524 *
1525 * This ioctl is supposed to take the CRTC number as
1526 * an argument, but in fbdev times, what that number
1527 * was supposed to be was quite unclear, different
1528 * drivers were passing that argument differently
1529 * (some by reference, some by value), and most of the
1530 * userspace applications were just hardcoding 0 as an
1531 * argument.
1532 *
1533 * The first CRTC should be the integrated panel on
1534 * most drivers, so this is the best choice we can
1535 * make. If we're not smart enough here, one should
1536 * just consider switch the userspace to KMS.
1537 */
1538 mode_set = &fb_helper->crtc_info[0].mode_set;
1539 crtc = mode_set->crtc;
1540
1541 /*
1542 * Only wait for a vblank event if the CRTC is
1543 * enabled, otherwise just don't do anythintg,
1544 * not even report an error.
1545 */
1546 ret = drm_crtc_vblank_get(crtc);
1547 if (!ret) {
1548 drm_crtc_wait_one_vblank(crtc);
1549 drm_crtc_vblank_put(crtc);
1550 }
1551
1552 ret = 0;
1553 goto unlock;
1554 default:
1555 ret = -ENOTTY;
1556 }
1557
1558unlock:
1559 mutex_unlock(&fb_helper->lock);
1560 return ret;
1561}
1562EXPORT_SYMBOL(drm_fb_helper_ioctl);
1563
1564/**
1565 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1566 * @var: screeninfo to check
1567 * @info: fbdev registered by the helper
1568 */
1569int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1570 struct fb_info *info)
1571{
1572 struct drm_fb_helper *fb_helper = info->par;
1573 struct drm_framebuffer *fb = fb_helper->fb;
1574 int depth;
1575
1576 if (var->pixclock != 0 || in_dbg_master())
1577 return -EINVAL;
1578
1579 /*
1580 * Changes struct fb_var_screeninfo are currently not pushed back
1581 * to KMS, hence fail if different settings are requested.
1582 */
1583 if (var->bits_per_pixel != fb->format->cpp[0] * 8 ||
1584 var->xres > fb->width || var->yres > fb->height ||
1585 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1586 DRM_DEBUG("fb requested width/height/bpp can't fit in current fb "
1587 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1588 var->xres, var->yres, var->bits_per_pixel,
1589 var->xres_virtual, var->yres_virtual,
1590 fb->width, fb->height, fb->format->cpp[0] * 8);
1591 return -EINVAL;
1592 }
1593
1594 switch (var->bits_per_pixel) {
1595 case 16:
1596 depth = (var->green.length == 6) ? 16 : 15;
1597 break;
1598 case 32:
1599 depth = (var->transp.length > 0) ? 32 : 24;
1600 break;
1601 default:
1602 depth = var->bits_per_pixel;
1603 break;
1604 }
1605
1606 switch (depth) {
1607 case 8:
1608 var->red.offset = 0;
1609 var->green.offset = 0;
1610 var->blue.offset = 0;
1611 var->red.length = 8;
1612 var->green.length = 8;
1613 var->blue.length = 8;
1614 var->transp.length = 0;
1615 var->transp.offset = 0;
1616 break;
1617 case 15:
1618 var->red.offset = 10;
1619 var->green.offset = 5;
1620 var->blue.offset = 0;
1621 var->red.length = 5;
1622 var->green.length = 5;
1623 var->blue.length = 5;
1624 var->transp.length = 1;
1625 var->transp.offset = 15;
1626 break;
1627 case 16:
1628 var->red.offset = 11;
1629 var->green.offset = 5;
1630 var->blue.offset = 0;
1631 var->red.length = 5;
1632 var->green.length = 6;
1633 var->blue.length = 5;
1634 var->transp.length = 0;
1635 var->transp.offset = 0;
1636 break;
1637 case 24:
1638 var->red.offset = 16;
1639 var->green.offset = 8;
1640 var->blue.offset = 0;
1641 var->red.length = 8;
1642 var->green.length = 8;
1643 var->blue.length = 8;
1644 var->transp.length = 0;
1645 var->transp.offset = 0;
1646 break;
1647 case 32:
1648 var->red.offset = 16;
1649 var->green.offset = 8;
1650 var->blue.offset = 0;
1651 var->red.length = 8;
1652 var->green.length = 8;
1653 var->blue.length = 8;
1654 var->transp.length = 8;
1655 var->transp.offset = 24;
1656 break;
1657 default:
1658 return -EINVAL;
1659 }
1660 return 0;
1661}
1662EXPORT_SYMBOL(drm_fb_helper_check_var);
1663
1664/**
1665 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1666 * @info: fbdev registered by the helper
1667 *
1668 * This will let fbcon do the mode init and is called at initialization time by
1669 * the fbdev core when registering the driver, and later on through the hotplug
1670 * callback.
1671 */
1672int drm_fb_helper_set_par(struct fb_info *info)
1673{
1674 struct drm_fb_helper *fb_helper = info->par;
1675 struct fb_var_screeninfo *var = &info->var;
1676
1677 if (oops_in_progress)
1678 return -EBUSY;
1679
1680 if (var->pixclock != 0) {
1681 DRM_ERROR("PIXEL CLOCK SET\n");
1682 return -EINVAL;
1683 }
1684
1685 drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper);
1686
1687 return 0;
1688}
1689EXPORT_SYMBOL(drm_fb_helper_set_par);
1690
1691static void pan_set(struct drm_fb_helper *fb_helper, int x, int y)
1692{
1693 int i;
1694
1695 for (i = 0; i < fb_helper->crtc_count; i++) {
1696 struct drm_mode_set *mode_set;
1697
1698 mode_set = &fb_helper->crtc_info[i].mode_set;
1699
1700 mode_set->x = x;
1701 mode_set->y = y;
1702 }
1703}
1704
1705static int pan_display_atomic(struct fb_var_screeninfo *var,
1706 struct fb_info *info)
1707{
1708 struct drm_fb_helper *fb_helper = info->par;
1709 int ret;
1710
1711 pan_set(fb_helper, var->xoffset, var->yoffset);
1712
1713 ret = restore_fbdev_mode_atomic(fb_helper, true);
1714 if (!ret) {
1715 info->var.xoffset = var->xoffset;
1716 info->var.yoffset = var->yoffset;
1717 } else
1718 pan_set(fb_helper, info->var.xoffset, info->var.yoffset);
1719
1720 return ret;
1721}
1722
1723static int pan_display_legacy(struct fb_var_screeninfo *var,
1724 struct fb_info *info)
1725{
1726 struct drm_fb_helper *fb_helper = info->par;
1727 struct drm_mode_set *modeset;
1728 int ret = 0;
1729 int i;
1730
1731 drm_modeset_lock_all(fb_helper->dev);
1732 for (i = 0; i < fb_helper->crtc_count; i++) {
1733 modeset = &fb_helper->crtc_info[i].mode_set;
1734
1735 modeset->x = var->xoffset;
1736 modeset->y = var->yoffset;
1737
1738 if (modeset->num_connectors) {
1739 ret = drm_mode_set_config_internal(modeset);
1740 if (!ret) {
1741 info->var.xoffset = var->xoffset;
1742 info->var.yoffset = var->yoffset;
1743 }
1744 }
1745 }
1746 drm_modeset_unlock_all(fb_helper->dev);
1747
1748 return ret;
1749}
1750
1751/**
1752 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1753 * @var: updated screen information
1754 * @info: fbdev registered by the helper
1755 */
1756int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1757 struct fb_info *info)
1758{
1759 struct drm_fb_helper *fb_helper = info->par;
1760 struct drm_device *dev = fb_helper->dev;
1761 int ret;
1762
1763 if (oops_in_progress)
1764 return -EBUSY;
1765
1766 mutex_lock(&fb_helper->lock);
1767 if (!drm_fb_helper_is_bound(fb_helper)) {
1768 mutex_unlock(&fb_helper->lock);
1769 return -EBUSY;
1770 }
1771
1772 if (drm_drv_uses_atomic_modeset(dev))
1773 ret = pan_display_atomic(var, info);
1774 else
1775 ret = pan_display_legacy(var, info);
1776 mutex_unlock(&fb_helper->lock);
1777
1778 return ret;
1779}
1780EXPORT_SYMBOL(drm_fb_helper_pan_display);
1781
1782/*
1783 * Allocates the backing storage and sets up the fbdev info structure through
1784 * the ->fb_probe callback.
1785 */
1786static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1787 int preferred_bpp)
1788{
1789 int ret = 0;
1790 int crtc_count = 0;
1791 int i;
1792 struct drm_fb_helper_surface_size sizes;
1793 int gamma_size = 0;
1794
1795 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1796 sizes.surface_depth = 24;
1797 sizes.surface_bpp = 32;
1798 sizes.fb_width = (u32)-1;
1799 sizes.fb_height = (u32)-1;
1800
1801 /* if driver picks 8 or 16 by default use that for both depth/bpp */
1802 if (preferred_bpp != sizes.surface_bpp)
1803 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1804
1805 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1806 drm_fb_helper_for_each_connector(fb_helper, i) {
1807 struct drm_fb_helper_connector *fb_helper_conn = fb_helper->connector_info[i];
1808 struct drm_cmdline_mode *cmdline_mode;
1809
1810 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
1811
1812 if (cmdline_mode->bpp_specified) {
1813 switch (cmdline_mode->bpp) {
1814 case 8:
1815 sizes.surface_depth = sizes.surface_bpp = 8;
1816 break;
1817 case 15:
1818 sizes.surface_depth = 15;
1819 sizes.surface_bpp = 16;
1820 break;
1821 case 16:
1822 sizes.surface_depth = sizes.surface_bpp = 16;
1823 break;
1824 case 24:
1825 sizes.surface_depth = sizes.surface_bpp = 24;
1826 break;
1827 case 32:
1828 sizes.surface_depth = 24;
1829 sizes.surface_bpp = 32;
1830 break;
1831 }
1832 break;
1833 }
1834 }
1835
1836 crtc_count = 0;
1837 for (i = 0; i < fb_helper->crtc_count; i++) {
1838 struct drm_display_mode *desired_mode;
1839 struct drm_mode_set *mode_set;
1840 int x, y, j;
1841 /* in case of tile group, are we the last tile vert or horiz?
1842 * If no tile group you are always the last one both vertically
1843 * and horizontally
1844 */
1845 bool lastv = true, lasth = true;
1846
1847 desired_mode = fb_helper->crtc_info[i].desired_mode;
1848 mode_set = &fb_helper->crtc_info[i].mode_set;
1849
1850 if (!desired_mode)
1851 continue;
1852
1853 crtc_count++;
1854
1855 x = fb_helper->crtc_info[i].x;
1856 y = fb_helper->crtc_info[i].y;
1857
1858 if (gamma_size == 0)
1859 gamma_size = fb_helper->crtc_info[i].mode_set.crtc->gamma_size;
1860
1861 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1862 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1863
1864 for (j = 0; j < mode_set->num_connectors; j++) {
1865 struct drm_connector *connector = mode_set->connectors[j];
1866
1867 if (connector->has_tile) {
1868 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1869 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1870 /* cloning to multiple tiles is just crazy-talk, so: */
1871 break;
1872 }
1873 }
1874
1875 if (lasth)
1876 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1877 if (lastv)
1878 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1879 }
1880
1881 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1882 DRM_INFO("Cannot find any crtc or sizes\n");
1883
1884 /* First time: disable all crtc's.. */
1885 if (!fb_helper->deferred_setup && !READ_ONCE(fb_helper->dev->master))
1886 restore_fbdev_mode(fb_helper);
1887 return -EAGAIN;
1888 }
1889
1890 /* Handle our overallocation */
1891 sizes.surface_height *= drm_fbdev_overalloc;
1892 sizes.surface_height /= 100;
1893
1894 /* push down into drivers */
1895 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1896 if (ret < 0)
1897 return ret;
1898
1899 strcpy(fb_helper->fb->comm, "[fbcon]");
1900 return 0;
1901}
1902
1903/**
1904 * drm_fb_helper_fill_fix - initializes fixed fbdev information
1905 * @info: fbdev registered by the helper
1906 * @pitch: desired pitch
1907 * @depth: desired depth
1908 *
1909 * Helper to fill in the fixed fbdev information useful for a non-accelerated
1910 * fbdev emulations. Drivers which support acceleration methods which impose
1911 * additional constraints need to set up their own limits.
1912 *
1913 * Drivers should call this (or their equivalent setup code) from their
1914 * &drm_fb_helper_funcs.fb_probe callback.
1915 */
1916void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1917 uint32_t depth)
1918{
1919 info->fix.type = FB_TYPE_PACKED_PIXELS;
1920 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1921 FB_VISUAL_TRUECOLOR;
1922 info->fix.mmio_start = 0;
1923 info->fix.mmio_len = 0;
1924 info->fix.type_aux = 0;
1925 info->fix.xpanstep = 1; /* doing it in hw */
1926 info->fix.ypanstep = 1; /* doing it in hw */
1927 info->fix.ywrapstep = 0;
1928 info->fix.accel = FB_ACCEL_NONE;
1929
1930 info->fix.line_length = pitch;
1931}
1932EXPORT_SYMBOL(drm_fb_helper_fill_fix);
1933
1934/**
1935 * drm_fb_helper_fill_var - initalizes variable fbdev information
1936 * @info: fbdev instance to set up
1937 * @fb_helper: fb helper instance to use as template
1938 * @fb_width: desired fb width
1939 * @fb_height: desired fb height
1940 *
1941 * Sets up the variable fbdev metainformation from the given fb helper instance
1942 * and the drm framebuffer allocated in &drm_fb_helper.fb.
1943 *
1944 * Drivers should call this (or their equivalent setup code) from their
1945 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
1946 * backing storage framebuffer.
1947 */
1948void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
1949 uint32_t fb_width, uint32_t fb_height)
1950{
1951 struct drm_framebuffer *fb = fb_helper->fb;
1952
1953 info->pseudo_palette = fb_helper->pseudo_palette;
1954 info->var.xres_virtual = fb->width;
1955 info->var.yres_virtual = fb->height;
1956 info->var.bits_per_pixel = fb->format->cpp[0] * 8;
1957 info->var.accel_flags = FB_ACCELF_TEXT;
1958 info->var.xoffset = 0;
1959 info->var.yoffset = 0;
1960 info->var.activate = FB_ACTIVATE_NOW;
1961
1962 switch (fb->format->depth) {
1963 case 8:
1964 info->var.red.offset = 0;
1965 info->var.green.offset = 0;
1966 info->var.blue.offset = 0;
1967 info->var.red.length = 8; /* 8bit DAC */
1968 info->var.green.length = 8;
1969 info->var.blue.length = 8;
1970 info->var.transp.offset = 0;
1971 info->var.transp.length = 0;
1972 break;
1973 case 15:
1974 info->var.red.offset = 10;
1975 info->var.green.offset = 5;
1976 info->var.blue.offset = 0;
1977 info->var.red.length = 5;
1978 info->var.green.length = 5;
1979 info->var.blue.length = 5;
1980 info->var.transp.offset = 15;
1981 info->var.transp.length = 1;
1982 break;
1983 case 16:
1984 info->var.red.offset = 11;
1985 info->var.green.offset = 5;
1986 info->var.blue.offset = 0;
1987 info->var.red.length = 5;
1988 info->var.green.length = 6;
1989 info->var.blue.length = 5;
1990 info->var.transp.offset = 0;
1991 break;
1992 case 24:
1993 info->var.red.offset = 16;
1994 info->var.green.offset = 8;
1995 info->var.blue.offset = 0;
1996 info->var.red.length = 8;
1997 info->var.green.length = 8;
1998 info->var.blue.length = 8;
1999 info->var.transp.offset = 0;
2000 info->var.transp.length = 0;
2001 break;
2002 case 32:
2003 info->var.red.offset = 16;
2004 info->var.green.offset = 8;
2005 info->var.blue.offset = 0;
2006 info->var.red.length = 8;
2007 info->var.green.length = 8;
2008 info->var.blue.length = 8;
2009 info->var.transp.offset = 24;
2010 info->var.transp.length = 8;
2011 break;
2012 default:
2013 break;
2014 }
2015
2016 info->var.xres = fb_width;
2017 info->var.yres = fb_height;
2018}
2019EXPORT_SYMBOL(drm_fb_helper_fill_var);
2020
2021static int drm_fb_helper_probe_connector_modes(struct drm_fb_helper *fb_helper,
2022 uint32_t maxX,
2023 uint32_t maxY)
2024{
2025 struct drm_connector *connector;
2026 int i, count = 0;
2027
2028 drm_fb_helper_for_each_connector(fb_helper, i) {
2029 connector = fb_helper->connector_info[i]->connector;
2030 count += connector->funcs->fill_modes(connector, maxX, maxY);
2031 }
2032
2033 return count;
2034}
2035
2036struct drm_display_mode *drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector, int width, int height)
2037{
2038 struct drm_display_mode *mode;
2039
2040 list_for_each_entry(mode, &fb_connector->connector->modes, head) {
2041 if (mode->hdisplay > width ||
2042 mode->vdisplay > height)
2043 continue;
2044 if (mode->type & DRM_MODE_TYPE_PREFERRED)
2045 return mode;
2046 }
2047 return NULL;
2048}
2049EXPORT_SYMBOL(drm_has_preferred_mode);
2050
2051static bool drm_has_cmdline_mode(struct drm_fb_helper_connector *fb_connector)
2052{
2053 return fb_connector->connector->cmdline_mode.specified;
2054}
2055
2056struct drm_display_mode *drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn)
2057{
2058 struct drm_cmdline_mode *cmdline_mode;
2059 struct drm_display_mode *mode;
2060 bool prefer_non_interlace;
2061
2062 cmdline_mode = &fb_helper_conn->connector->cmdline_mode;
2063 if (cmdline_mode->specified == false)
2064 return NULL;
2065
2066 /* attempt to find a matching mode in the list of modes
2067 * we have gotten so far, if not add a CVT mode that conforms
2068 */
2069 if (cmdline_mode->rb || cmdline_mode->margins)
2070 goto create_mode;
2071
2072 prefer_non_interlace = !cmdline_mode->interlace;
2073again:
2074 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
2075 /* check width/height */
2076 if (mode->hdisplay != cmdline_mode->xres ||
2077 mode->vdisplay != cmdline_mode->yres)
2078 continue;
2079
2080 if (cmdline_mode->refresh_specified) {
2081 if (mode->vrefresh != cmdline_mode->refresh)
2082 continue;
2083 }
2084
2085 if (cmdline_mode->interlace) {
2086 if (!(mode->flags & DRM_MODE_FLAG_INTERLACE))
2087 continue;
2088 } else if (prefer_non_interlace) {
2089 if (mode->flags & DRM_MODE_FLAG_INTERLACE)
2090 continue;
2091 }
2092 return mode;
2093 }
2094
2095 if (prefer_non_interlace) {
2096 prefer_non_interlace = false;
2097 goto again;
2098 }
2099
2100create_mode:
2101 mode = drm_mode_create_from_cmdline_mode(fb_helper_conn->connector->dev,
2102 cmdline_mode);
2103 list_add(&mode->head, &fb_helper_conn->connector->modes);
2104 return mode;
2105}
2106EXPORT_SYMBOL(drm_pick_cmdline_mode);
2107
2108static bool drm_connector_enabled(struct drm_connector *connector, bool strict)
2109{
2110 bool enable;
2111
2112 if (connector->display_info.non_desktop)
2113 return false;
2114
2115 if (strict)
2116 enable = connector->status == connector_status_connected;
2117 else
2118 enable = connector->status != connector_status_disconnected;
2119
2120 return enable;
2121}
2122
2123static void drm_enable_connectors(struct drm_fb_helper *fb_helper,
2124 bool *enabled)
2125{
2126 bool any_enabled = false;
2127 struct drm_connector *connector;
2128 int i = 0;
2129
2130 drm_fb_helper_for_each_connector(fb_helper, i) {
2131 connector = fb_helper->connector_info[i]->connector;
2132 enabled[i] = drm_connector_enabled(connector, true);
2133 DRM_DEBUG_KMS("connector %d enabled? %s\n", connector->base.id,
2134 connector->display_info.non_desktop ? "non desktop" : enabled[i] ? "yes" : "no");
2135
2136 any_enabled |= enabled[i];
2137 }
2138
2139 if (any_enabled)
2140 return;
2141
2142 drm_fb_helper_for_each_connector(fb_helper, i) {
2143 connector = fb_helper->connector_info[i]->connector;
2144 enabled[i] = drm_connector_enabled(connector, false);
2145 }
2146}
2147
2148static bool drm_target_cloned(struct drm_fb_helper *fb_helper,
2149 struct drm_display_mode **modes,
2150 struct drm_fb_offset *offsets,
2151 bool *enabled, int width, int height)
2152{
2153 int count, i, j;
2154 bool can_clone = false;
2155 struct drm_fb_helper_connector *fb_helper_conn;
2156 struct drm_display_mode *dmt_mode, *mode;
2157
2158 /* only contemplate cloning in the single crtc case */
2159 if (fb_helper->crtc_count > 1)
2160 return false;
2161
2162 count = 0;
2163 drm_fb_helper_for_each_connector(fb_helper, i) {
2164 if (enabled[i])
2165 count++;
2166 }
2167
2168 /* only contemplate cloning if more than one connector is enabled */
2169 if (count <= 1)
2170 return false;
2171
2172 /* check the command line or if nothing common pick 1024x768 */
2173 can_clone = true;
2174 drm_fb_helper_for_each_connector(fb_helper, i) {
2175 if (!enabled[i])
2176 continue;
2177 fb_helper_conn = fb_helper->connector_info[i];
2178 modes[i] = drm_pick_cmdline_mode(fb_helper_conn);
2179 if (!modes[i]) {
2180 can_clone = false;
2181 break;
2182 }
2183 for (j = 0; j < i; j++) {
2184 if (!enabled[j])
2185 continue;
2186 if (!drm_mode_equal(modes[j], modes[i]))
2187 can_clone = false;
2188 }
2189 }
2190
2191 if (can_clone) {
2192 DRM_DEBUG_KMS("can clone using command line\n");
2193 return true;
2194 }
2195
2196 /* try and find a 1024x768 mode on each connector */
2197 can_clone = true;
2198 dmt_mode = drm_mode_find_dmt(fb_helper->dev, 1024, 768, 60, false);
2199
2200 drm_fb_helper_for_each_connector(fb_helper, i) {
2201 if (!enabled[i])
2202 continue;
2203
2204 fb_helper_conn = fb_helper->connector_info[i];
2205 list_for_each_entry(mode, &fb_helper_conn->connector->modes, head) {
2206 if (drm_mode_equal(mode, dmt_mode))
2207 modes[i] = mode;
2208 }
2209 if (!modes[i])
2210 can_clone = false;
2211 }
2212
2213 if (can_clone) {
2214 DRM_DEBUG_KMS("can clone using 1024x768\n");
2215 return true;
2216 }
2217 DRM_INFO("kms: can't enable cloning when we probably wanted to.\n");
2218 return false;
2219}
2220
2221static int drm_get_tile_offsets(struct drm_fb_helper *fb_helper,
2222 struct drm_display_mode **modes,
2223 struct drm_fb_offset *offsets,
2224 int idx,
2225 int h_idx, int v_idx)
2226{
2227 struct drm_fb_helper_connector *fb_helper_conn;
2228 int i;
2229 int hoffset = 0, voffset = 0;
2230
2231 drm_fb_helper_for_each_connector(fb_helper, i) {
2232 fb_helper_conn = fb_helper->connector_info[i];
2233 if (!fb_helper_conn->connector->has_tile)
2234 continue;
2235
2236 if (!modes[i] && (h_idx || v_idx)) {
2237 DRM_DEBUG_KMS("no modes for connector tiled %d %d\n", i,
2238 fb_helper_conn->connector->base.id);
2239 continue;
2240 }
2241 if (fb_helper_conn->connector->tile_h_loc < h_idx)
2242 hoffset += modes[i]->hdisplay;
2243
2244 if (fb_helper_conn->connector->tile_v_loc < v_idx)
2245 voffset += modes[i]->vdisplay;
2246 }
2247 offsets[idx].x = hoffset;
2248 offsets[idx].y = voffset;
2249 DRM_DEBUG_KMS("returned %d %d for %d %d\n", hoffset, voffset, h_idx, v_idx);
2250 return 0;
2251}
2252
2253static bool drm_target_preferred(struct drm_fb_helper *fb_helper,
2254 struct drm_display_mode **modes,
2255 struct drm_fb_offset *offsets,
2256 bool *enabled, int width, int height)
2257{
2258 struct drm_fb_helper_connector *fb_helper_conn;
2259 const u64 mask = BIT_ULL(fb_helper->connector_count) - 1;
2260 u64 conn_configured = 0;
2261 int tile_pass = 0;
2262 int i;
2263
2264retry:
2265 drm_fb_helper_for_each_connector(fb_helper, i) {
2266 fb_helper_conn = fb_helper->connector_info[i];
2267
2268 if (conn_configured & BIT_ULL(i))
2269 continue;
2270
2271 if (enabled[i] == false) {
2272 conn_configured |= BIT_ULL(i);
2273 continue;
2274 }
2275
2276 /* first pass over all the untiled connectors */
2277 if (tile_pass == 0 && fb_helper_conn->connector->has_tile)
2278 continue;
2279
2280 if (tile_pass == 1) {
2281 if (fb_helper_conn->connector->tile_h_loc != 0 ||
2282 fb_helper_conn->connector->tile_v_loc != 0)
2283 continue;
2284
2285 } else {
2286 if (fb_helper_conn->connector->tile_h_loc != tile_pass - 1 &&
2287 fb_helper_conn->connector->tile_v_loc != tile_pass - 1)
2288 /* if this tile_pass doesn't cover any of the tiles - keep going */
2289 continue;
2290
2291 /*
2292 * find the tile offsets for this pass - need to find
2293 * all tiles left and above
2294 */
2295 drm_get_tile_offsets(fb_helper, modes, offsets,
2296 i, fb_helper_conn->connector->tile_h_loc, fb_helper_conn->connector->tile_v_loc);
2297 }
2298 DRM_DEBUG_KMS("looking for cmdline mode on connector %d\n",
2299 fb_helper_conn->connector->base.id);
2300
2301 /* got for command line mode first */
2302 modes[i] = drm_pick_cmdline_mode(fb_helper_conn);
2303 if (!modes[i]) {
2304 DRM_DEBUG_KMS("looking for preferred mode on connector %d %d\n",
2305 fb_helper_conn->connector->base.id, fb_helper_conn->connector->tile_group ? fb_helper_conn->connector->tile_group->id : 0);
2306 modes[i] = drm_has_preferred_mode(fb_helper_conn, width, height);
2307 }
2308 /* No preferred modes, pick one off the list */
2309 if (!modes[i] && !list_empty(&fb_helper_conn->connector->modes)) {
2310 list_for_each_entry(modes[i], &fb_helper_conn->connector->modes, head)
2311 break;
2312 }
2313 DRM_DEBUG_KMS("found mode %s\n", modes[i] ? modes[i]->name :
2314 "none");
2315 conn_configured |= BIT_ULL(i);
2316 }
2317
2318 if ((conn_configured & mask) != mask) {
2319 tile_pass++;
2320 goto retry;
2321 }
2322 return true;
2323}
2324
2325static int drm_pick_crtcs(struct drm_fb_helper *fb_helper,
2326 struct drm_fb_helper_crtc **best_crtcs,
2327 struct drm_display_mode **modes,
2328 int n, int width, int height)
2329{
2330 int c, o;
2331 struct drm_connector *connector;
2332 const struct drm_connector_helper_funcs *connector_funcs;
2333 struct drm_encoder *encoder;
2334 int my_score, best_score, score;
2335 struct drm_fb_helper_crtc **crtcs, *crtc;
2336 struct drm_fb_helper_connector *fb_helper_conn;
2337
2338 if (n == fb_helper->connector_count)
2339 return 0;
2340
2341 fb_helper_conn = fb_helper->connector_info[n];
2342 connector = fb_helper_conn->connector;
2343
2344 best_crtcs[n] = NULL;
2345 best_score = drm_pick_crtcs(fb_helper, best_crtcs, modes, n+1, width, height);
2346 if (modes[n] == NULL)
2347 return best_score;
2348
2349 crtcs = kcalloc(fb_helper->connector_count,
2350 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2351 if (!crtcs)
2352 return best_score;
2353
2354 my_score = 1;
2355 if (connector->status == connector_status_connected)
2356 my_score++;
2357 if (drm_has_cmdline_mode(fb_helper_conn))
2358 my_score++;
2359 if (drm_has_preferred_mode(fb_helper_conn, width, height))
2360 my_score++;
2361
2362 connector_funcs = connector->helper_private;
2363
2364 /*
2365 * If the DRM device implements atomic hooks and ->best_encoder() is
2366 * NULL we fallback to the default drm_atomic_helper_best_encoder()
2367 * helper.
2368 */
2369 if (drm_drv_uses_atomic_modeset(fb_helper->dev) &&
2370 !connector_funcs->best_encoder)
2371 encoder = drm_atomic_helper_best_encoder(connector);
2372 else
2373 encoder = connector_funcs->best_encoder(connector);
2374
2375 if (!encoder)
2376 goto out;
2377
2378 /*
2379 * select a crtc for this connector and then attempt to configure
2380 * remaining connectors
2381 */
2382 for (c = 0; c < fb_helper->crtc_count; c++) {
2383 crtc = &fb_helper->crtc_info[c];
2384
2385 if ((encoder->possible_crtcs & (1 << c)) == 0)
2386 continue;
2387
2388 for (o = 0; o < n; o++)
2389 if (best_crtcs[o] == crtc)
2390 break;
2391
2392 if (o < n) {
2393 /* ignore cloning unless only a single crtc */
2394 if (fb_helper->crtc_count > 1)
2395 continue;
2396
2397 if (!drm_mode_equal(modes[o], modes[n]))
2398 continue;
2399 }
2400
2401 crtcs[n] = crtc;
2402 memcpy(crtcs, best_crtcs, n * sizeof(struct drm_fb_helper_crtc *));
2403 score = my_score + drm_pick_crtcs(fb_helper, crtcs, modes, n + 1,
2404 width, height);
2405 if (score > best_score) {
2406 best_score = score;
2407 memcpy(best_crtcs, crtcs,
2408 fb_helper->connector_count *
2409 sizeof(struct drm_fb_helper_crtc *));
2410 }
2411 }
2412out:
2413 kfree(crtcs);
2414 return best_score;
2415}
2416
2417/*
2418 * This function checks if rotation is necessary because of panel orientation
2419 * and if it is, if it is supported.
2420 * If rotation is necessary and supported, its gets set in fb_crtc.rotation.
2421 * If rotation is necessary but not supported, a DRM_MODE_ROTATE_* flag gets
2422 * or-ed into fb_helper->sw_rotations. In drm_setup_crtcs_fb() we check if only
2423 * one bit is set and then we set fb_info.fbcon_rotate_hint to make fbcon do
2424 * the unsupported rotation.
2425 */
2426static void drm_setup_crtc_rotation(struct drm_fb_helper *fb_helper,
2427 struct drm_fb_helper_crtc *fb_crtc,
2428 struct drm_connector *connector)
2429{
2430 struct drm_plane *plane = fb_crtc->mode_set.crtc->primary;
2431 uint64_t valid_mask = 0;
2432 int i, rotation;
2433
2434 fb_crtc->rotation = DRM_MODE_ROTATE_0;
2435
2436 switch (connector->display_info.panel_orientation) {
2437 case DRM_MODE_PANEL_ORIENTATION_BOTTOM_UP:
2438 rotation = DRM_MODE_ROTATE_180;
2439 break;
2440 case DRM_MODE_PANEL_ORIENTATION_LEFT_UP:
2441 rotation = DRM_MODE_ROTATE_90;
2442 break;
2443 case DRM_MODE_PANEL_ORIENTATION_RIGHT_UP:
2444 rotation = DRM_MODE_ROTATE_270;
2445 break;
2446 default:
2447 rotation = DRM_MODE_ROTATE_0;
2448 }
2449
2450 /*
2451 * TODO: support 90 / 270 degree hardware rotation,
2452 * depending on the hardware this may require the framebuffer
2453 * to be in a specific tiling format.
2454 */
2455 if (rotation != DRM_MODE_ROTATE_180 || !plane->rotation_property) {
2456 fb_helper->sw_rotations |= rotation;
2457 return;
2458 }
2459
2460 for (i = 0; i < plane->rotation_property->num_values; i++)
2461 valid_mask |= (1ULL << plane->rotation_property->values[i]);
2462
2463 if (!(rotation & valid_mask)) {
2464 fb_helper->sw_rotations |= rotation;
2465 return;
2466 }
2467
2468 fb_crtc->rotation = rotation;
2469 /* Rotating in hardware, fbcon should not rotate */
2470 fb_helper->sw_rotations |= DRM_MODE_ROTATE_0;
2471}
2472
2473static void drm_setup_crtcs(struct drm_fb_helper *fb_helper,
2474 u32 width, u32 height)
2475{
2476 struct drm_device *dev = fb_helper->dev;
2477 struct drm_fb_helper_crtc **crtcs;
2478 struct drm_display_mode **modes;
2479 struct drm_fb_offset *offsets;
2480 bool *enabled;
2481 int i;
2482
2483 DRM_DEBUG_KMS("\n");
2484 /* prevent concurrent modification of connector_count by hotplug */
2485 lockdep_assert_held(&fb_helper->lock);
2486
2487 crtcs = kcalloc(fb_helper->connector_count,
2488 sizeof(struct drm_fb_helper_crtc *), GFP_KERNEL);
2489 modes = kcalloc(fb_helper->connector_count,
2490 sizeof(struct drm_display_mode *), GFP_KERNEL);
2491 offsets = kcalloc(fb_helper->connector_count,
2492 sizeof(struct drm_fb_offset), GFP_KERNEL);
2493 enabled = kcalloc(fb_helper->connector_count,
2494 sizeof(bool), GFP_KERNEL);
2495 if (!crtcs || !modes || !enabled || !offsets) {
2496 DRM_ERROR("Memory allocation failed\n");
2497 goto out;
2498 }
2499
2500 mutex_lock(&fb_helper->dev->mode_config.mutex);
2501 if (drm_fb_helper_probe_connector_modes(fb_helper, width, height) == 0)
2502 DRM_DEBUG_KMS("No connectors reported connected with modes\n");
2503 drm_enable_connectors(fb_helper, enabled);
2504
2505 if (!(fb_helper->funcs->initial_config &&
2506 fb_helper->funcs->initial_config(fb_helper, crtcs, modes,
2507 offsets,
2508 enabled, width, height))) {
2509 memset(modes, 0, fb_helper->connector_count*sizeof(modes[0]));
2510 memset(crtcs, 0, fb_helper->connector_count*sizeof(crtcs[0]));
2511 memset(offsets, 0, fb_helper->connector_count*sizeof(offsets[0]));
2512
2513 if (!drm_target_cloned(fb_helper, modes, offsets,
2514 enabled, width, height) &&
2515 !drm_target_preferred(fb_helper, modes, offsets,
2516 enabled, width, height))
2517 DRM_ERROR("Unable to find initial modes\n");
2518
2519 DRM_DEBUG_KMS("picking CRTCs for %dx%d config\n",
2520 width, height);
2521
2522 drm_pick_crtcs(fb_helper, crtcs, modes, 0, width, height);
2523 }
2524 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2525
2526 /* need to set the modesets up here for use later */
2527 /* fill out the connector<->crtc mappings into the modesets */
2528 for (i = 0; i < fb_helper->crtc_count; i++)
2529 drm_fb_helper_modeset_release(fb_helper,
2530 &fb_helper->crtc_info[i].mode_set);
2531
2532 fb_helper->sw_rotations = 0;
2533 drm_fb_helper_for_each_connector(fb_helper, i) {
2534 struct drm_display_mode *mode = modes[i];
2535 struct drm_fb_helper_crtc *fb_crtc = crtcs[i];
2536 struct drm_fb_offset *offset = &offsets[i];
2537
2538 if (mode && fb_crtc) {
2539 struct drm_mode_set *modeset = &fb_crtc->mode_set;
2540 struct drm_connector *connector =
2541 fb_helper->connector_info[i]->connector;
2542
2543 DRM_DEBUG_KMS("desired mode %s set on crtc %d (%d,%d)\n",
2544 mode->name, fb_crtc->mode_set.crtc->base.id, offset->x, offset->y);
2545
2546 fb_crtc->desired_mode = mode;
2547 fb_crtc->x = offset->x;
2548 fb_crtc->y = offset->y;
2549 modeset->mode = drm_mode_duplicate(dev,
2550 fb_crtc->desired_mode);
2551 drm_connector_get(connector);
2552 drm_setup_crtc_rotation(fb_helper, fb_crtc, connector);
2553 modeset->connectors[modeset->num_connectors++] = connector;
2554 modeset->x = offset->x;
2555 modeset->y = offset->y;
2556 }
2557 }
2558out:
2559 kfree(crtcs);
2560 kfree(modes);
2561 kfree(offsets);
2562 kfree(enabled);
2563}
2564
2565/*
2566 * This is a continuation of drm_setup_crtcs() that sets up anything related
2567 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
2568 * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
2569 * So, any setup that touches those fields needs to be done here instead of in
2570 * drm_setup_crtcs().
2571 */
2572static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper)
2573{
2574 struct fb_info *info = fb_helper->fbdev;
2575 int i;
2576
2577 for (i = 0; i < fb_helper->crtc_count; i++)
2578 if (fb_helper->crtc_info[i].mode_set.num_connectors)
2579 fb_helper->crtc_info[i].mode_set.fb = fb_helper->fb;
2580
2581 mutex_lock(&fb_helper->dev->mode_config.mutex);
2582 drm_fb_helper_for_each_connector(fb_helper, i) {
2583 struct drm_connector *connector =
2584 fb_helper->connector_info[i]->connector;
2585
2586 /* use first connected connector for the physical dimensions */
2587 if (connector->status == connector_status_connected) {
2588 info->var.width = connector->display_info.width_mm;
2589 info->var.height = connector->display_info.height_mm;
2590 break;
2591 }
2592 }
2593 mutex_unlock(&fb_helper->dev->mode_config.mutex);
2594
2595 switch (fb_helper->sw_rotations) {
2596 case DRM_MODE_ROTATE_0:
2597 info->fbcon_rotate_hint = FB_ROTATE_UR;
2598 break;
2599 case DRM_MODE_ROTATE_90:
2600 info->fbcon_rotate_hint = FB_ROTATE_CCW;
2601 break;
2602 case DRM_MODE_ROTATE_180:
2603 info->fbcon_rotate_hint = FB_ROTATE_UD;
2604 break;
2605 case DRM_MODE_ROTATE_270:
2606 info->fbcon_rotate_hint = FB_ROTATE_CW;
2607 break;
2608 default:
2609 /*
2610 * Multiple bits are set / multiple rotations requested
2611 * fbcon cannot handle separate rotation settings per
2612 * output, so fallback to unrotated.
2613 */
2614 info->fbcon_rotate_hint = FB_ROTATE_UR;
2615 }
2616}
2617
2618/* Note: Drops fb_helper->lock before returning. */
2619static int
2620__drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper,
2621 int bpp_sel)
2622{
2623 struct drm_device *dev = fb_helper->dev;
2624 struct fb_info *info;
2625 unsigned int width, height;
2626 int ret;
2627
2628 width = dev->mode_config.max_width;
2629 height = dev->mode_config.max_height;
2630
2631 drm_setup_crtcs(fb_helper, width, height);
2632 ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
2633 if (ret < 0) {
2634 if (ret == -EAGAIN) {
2635 fb_helper->preferred_bpp = bpp_sel;
2636 fb_helper->deferred_setup = true;
2637 ret = 0;
2638 }
2639 mutex_unlock(&fb_helper->lock);
2640
2641 return ret;
2642 }
2643 drm_setup_crtcs_fb(fb_helper);
2644
2645 fb_helper->deferred_setup = false;
2646
2647 info = fb_helper->fbdev;
2648 info->var.pixclock = 0;
2649
2650 /* Need to drop locks to avoid recursive deadlock in
2651 * register_framebuffer. This is ok because the only thing left to do is
2652 * register the fbdev emulation instance in kernel_fb_helper_list. */
2653 mutex_unlock(&fb_helper->lock);
2654
2655 ret = register_framebuffer(info);
2656 if (ret < 0)
2657 return ret;
2658
2659 dev_info(dev->dev, "fb%d: %s frame buffer device\n",
2660 info->node, info->fix.id);
2661
2662 mutex_lock(&kernel_fb_helper_lock);
2663 if (list_empty(&kernel_fb_helper_list))
2664 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
2665
2666 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
2667 mutex_unlock(&kernel_fb_helper_lock);
2668
2669 return 0;
2670}
2671
2672/**
2673 * drm_fb_helper_initial_config - setup a sane initial connector configuration
2674 * @fb_helper: fb_helper device struct
2675 * @bpp_sel: bpp value to use for the framebuffer configuration
2676 *
2677 * Scans the CRTCs and connectors and tries to put together an initial setup.
2678 * At the moment, this is a cloned configuration across all heads with
2679 * a new framebuffer object as the backing store.
2680 *
2681 * Note that this also registers the fbdev and so allows userspace to call into
2682 * the driver through the fbdev interfaces.
2683 *
2684 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
2685 * to let the driver allocate and initialize the fbdev info structure and the
2686 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_var() and
2687 * drm_fb_helper_fill_fix() are provided as helpers to setup simple default
2688 * values for the fbdev info structure.
2689 *
2690 * HANG DEBUGGING:
2691 *
2692 * When you have fbcon support built-in or already loaded, this function will do
2693 * a full modeset to setup the fbdev console. Due to locking misdesign in the
2694 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
2695 * console_lock. Until console_unlock is called no dmesg lines will be sent out
2696 * to consoles, not even serial console. This means when your driver crashes,
2697 * you will see absolutely nothing else but a system stuck in this function,
2698 * with no further output. Any kind of printk() you place within your own driver
2699 * or in the drm core modeset code will also never show up.
2700 *
2701 * Standard debug practice is to run the fbcon setup without taking the
2702 * console_lock as a hack, to be able to see backtraces and crashes on the
2703 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
2704 * cmdline option.
2705 *
2706 * The other option is to just disable fbdev emulation since very likely the
2707 * first modeset from userspace will crash in the same way, and is even easier
2708 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
2709 * kernel cmdline option.
2710 *
2711 * RETURNS:
2712 * Zero if everything went ok, nonzero otherwise.
2713 */
2714int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
2715{
2716 int ret;
2717
2718 if (!drm_fbdev_emulation)
2719 return 0;
2720
2721 mutex_lock(&fb_helper->lock);
2722 ret = __drm_fb_helper_initial_config_and_unlock(fb_helper, bpp_sel);
2723
2724 return ret;
2725}
2726EXPORT_SYMBOL(drm_fb_helper_initial_config);
2727
2728/**
2729 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
2730 * probing all the outputs attached to the fb
2731 * @fb_helper: driver-allocated fbdev helper, can be NULL
2732 *
2733 * Scan the connectors attached to the fb_helper and try to put together a
2734 * setup after notification of a change in output configuration.
2735 *
2736 * Called at runtime, takes the mode config locks to be able to check/change the
2737 * modeset configuration. Must be run from process context (which usually means
2738 * either the output polling work or a work item launched from the driver's
2739 * hotplug interrupt).
2740 *
2741 * Note that drivers may call this even before calling
2742 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
2743 * for a race-free fbcon setup and will make sure that the fbdev emulation will
2744 * not miss any hotplug events.
2745 *
2746 * RETURNS:
2747 * 0 on success and a non-zero error code otherwise.
2748 */
2749int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
2750{
2751 int err = 0;
2752
2753 if (!drm_fbdev_emulation || !fb_helper)
2754 return 0;
2755
2756 mutex_lock(&fb_helper->lock);
2757 if (fb_helper->deferred_setup) {
2758 err = __drm_fb_helper_initial_config_and_unlock(fb_helper,
2759 fb_helper->preferred_bpp);
2760 return err;
2761 }
2762
2763 if (!fb_helper->fb || !drm_fb_helper_is_bound(fb_helper)) {
2764 fb_helper->delayed_hotplug = true;
2765 mutex_unlock(&fb_helper->lock);
2766 return err;
2767 }
2768
2769 DRM_DEBUG_KMS("\n");
2770
2771 drm_setup_crtcs(fb_helper, fb_helper->fb->width, fb_helper->fb->height);
2772 drm_setup_crtcs_fb(fb_helper);
2773 mutex_unlock(&fb_helper->lock);
2774
2775 drm_fb_helper_set_par(fb_helper->fbdev);
2776
2777 return 0;
2778}
2779EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
2780
2781/**
2782 * drm_fb_helper_fbdev_setup() - Setup fbdev emulation
2783 * @dev: DRM device
2784 * @fb_helper: fbdev helper structure to set up
2785 * @funcs: fbdev helper functions
2786 * @preferred_bpp: Preferred bits per pixel for the device.
2787 * @dev->mode_config.preferred_depth is used if this is zero.
2788 * @max_conn_count: Maximum number of connectors.
2789 * @dev->mode_config.num_connector is used if this is zero.
2790 *
2791 * This function sets up fbdev emulation and registers fbdev for access by
2792 * userspace. If all connectors are disconnected, setup is deferred to the next
2793 * time drm_fb_helper_hotplug_event() is called.
2794 * The caller must to provide a &drm_fb_helper_funcs->fb_probe callback
2795 * function.
2796 *
2797 * See also: drm_fb_helper_initial_config()
2798 *
2799 * Returns:
2800 * Zero on success or negative error code on failure.
2801 */
2802int drm_fb_helper_fbdev_setup(struct drm_device *dev,
2803 struct drm_fb_helper *fb_helper,
2804 const struct drm_fb_helper_funcs *funcs,
2805 unsigned int preferred_bpp,
2806 unsigned int max_conn_count)
2807{
2808 int ret;
2809
2810 if (!preferred_bpp)
2811 preferred_bpp = dev->mode_config.preferred_depth;
2812 if (!preferred_bpp)
2813 preferred_bpp = 32;
2814
2815 if (!max_conn_count)
2816 max_conn_count = dev->mode_config.num_connector;
2817 if (!max_conn_count) {
2818 DRM_DEV_ERROR(dev->dev, "No connectors\n");
2819 return -EINVAL;
2820 }
2821
2822 drm_fb_helper_prepare(dev, fb_helper, funcs);
2823
2824 ret = drm_fb_helper_init(dev, fb_helper, max_conn_count);
2825 if (ret < 0) {
2826 DRM_DEV_ERROR(dev->dev, "Failed to initialize fbdev helper\n");
2827 return ret;
2828 }
2829
2830 ret = drm_fb_helper_single_add_all_connectors(fb_helper);
2831 if (ret < 0) {
2832 DRM_DEV_ERROR(dev->dev, "Failed to add connectors\n");
2833 goto err_drm_fb_helper_fini;
2834 }
2835
2836 if (!drm_drv_uses_atomic_modeset(dev))
2837 drm_helper_disable_unused_functions(dev);
2838
2839 ret = drm_fb_helper_initial_config(fb_helper, preferred_bpp);
2840 if (ret < 0) {
2841 DRM_DEV_ERROR(dev->dev, "Failed to set fbdev configuration\n");
2842 goto err_drm_fb_helper_fini;
2843 }
2844
2845 return 0;
2846
2847err_drm_fb_helper_fini:
2848 drm_fb_helper_fini(fb_helper);
2849
2850 return ret;
2851}
2852EXPORT_SYMBOL(drm_fb_helper_fbdev_setup);
2853
2854/**
2855 * drm_fb_helper_fbdev_teardown - Tear down fbdev emulation
2856 * @dev: DRM device
2857 *
2858 * This function unregisters fbdev if not already done and cleans up the
2859 * associated resources including the &drm_framebuffer.
2860 * The driver is responsible for freeing the &drm_fb_helper structure which is
2861 * stored in &drm_device->fb_helper. Do note that this pointer has been cleared
2862 * when this function returns.
2863 *
2864 * In order to support device removal/unplug while file handles are still open,
2865 * drm_fb_helper_unregister_fbi() should be called on device removal and
2866 * drm_fb_helper_fbdev_teardown() in the &drm_driver->release callback when
2867 * file handles are closed.
2868 */
2869void drm_fb_helper_fbdev_teardown(struct drm_device *dev)
2870{
2871 struct drm_fb_helper *fb_helper = dev->fb_helper;
2872 struct fb_ops *fbops = NULL;
2873
2874 if (!fb_helper)
2875 return;
2876
2877 /* Unregister if it hasn't been done already */
2878 if (fb_helper->fbdev && fb_helper->fbdev->dev)
2879 drm_fb_helper_unregister_fbi(fb_helper);
2880
2881 if (fb_helper->fbdev && fb_helper->fbdev->fbdefio) {
2882 fb_deferred_io_cleanup(fb_helper->fbdev);
2883 kfree(fb_helper->fbdev->fbdefio);
2884 fbops = fb_helper->fbdev->fbops;
2885 }
2886
2887 drm_fb_helper_fini(fb_helper);
2888 kfree(fbops);
2889
2890 if (fb_helper->fb)
2891 drm_framebuffer_remove(fb_helper->fb);
2892}
2893EXPORT_SYMBOL(drm_fb_helper_fbdev_teardown);
2894
2895/**
2896 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
2897 * @dev: DRM device
2898 *
2899 * This function can be used as the &drm_driver->lastclose callback for drivers
2900 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
2901 */
2902void drm_fb_helper_lastclose(struct drm_device *dev)
2903{
2904 drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper);
2905}
2906EXPORT_SYMBOL(drm_fb_helper_lastclose);
2907
2908/**
2909 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
2910 * helper for fbdev emulation
2911 * @dev: DRM device
2912 *
2913 * This function can be used as the
2914 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
2915 * need to call drm_fb_helper_hotplug_event().
2916 */
2917void drm_fb_helper_output_poll_changed(struct drm_device *dev)
2918{
2919 drm_fb_helper_hotplug_event(dev->fb_helper);
2920}
2921EXPORT_SYMBOL(drm_fb_helper_output_poll_changed);
2922
2923/* The Kconfig DRM_KMS_HELPER selects FRAMEBUFFER_CONSOLE (if !EXPERT)
2924 * but the module doesn't depend on any fb console symbols. At least
2925 * attempt to load fbcon to avoid leaving the system without a usable console.
2926 */
2927int __init drm_fb_helper_modinit(void)
2928{
2929#if defined(CONFIG_FRAMEBUFFER_CONSOLE_MODULE) && !defined(CONFIG_EXPERT)
2930 const char name[] = "fbcon";
2931 struct module *fbcon;
2932
2933 mutex_lock(&module_mutex);
2934 fbcon = find_module(name);
2935 mutex_unlock(&module_mutex);
2936
2937 if (!fbcon)
2938 request_module_nowait(name);
2939#endif
2940 return 0;
2941}
2942EXPORT_SYMBOL(drm_fb_helper_modinit);
1/*
2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
5 *
6 * DRM framebuffer helper functions
7 *
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.
17 *
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
24 * OF THIS SOFTWARE.
25 *
26 * Authors:
27 * Dave Airlie <airlied@linux.ie>
28 * Jesse Barnes <jesse.barnes@intel.com>
29 */
30#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
31
32#include <linux/console.h>
33#include <linux/dma-buf.h>
34#include <linux/kernel.h>
35#include <linux/module.h>
36#include <linux/slab.h>
37#include <linux/sysrq.h>
38#include <linux/vmalloc.h>
39
40#include <drm/drm_atomic.h>
41#include <drm/drm_crtc.h>
42#include <drm/drm_crtc_helper.h>
43#include <drm/drm_drv.h>
44#include <drm/drm_fb_helper.h>
45#include <drm/drm_fourcc.h>
46#include <drm/drm_print.h>
47#include <drm/drm_vblank.h>
48
49#include "drm_crtc_helper_internal.h"
50#include "drm_internal.h"
51
52static bool drm_fbdev_emulation = true;
53module_param_named(fbdev_emulation, drm_fbdev_emulation, bool, 0600);
54MODULE_PARM_DESC(fbdev_emulation,
55 "Enable legacy fbdev emulation [default=true]");
56
57static int drm_fbdev_overalloc = CONFIG_DRM_FBDEV_OVERALLOC;
58module_param(drm_fbdev_overalloc, int, 0444);
59MODULE_PARM_DESC(drm_fbdev_overalloc,
60 "Overallocation of the fbdev buffer (%) [default="
61 __MODULE_STRING(CONFIG_DRM_FBDEV_OVERALLOC) "]");
62
63/*
64 * In order to keep user-space compatibility, we want in certain use-cases
65 * to keep leaking the fbdev physical address to the user-space program
66 * handling the fbdev buffer.
67 * This is a bad habit essentially kept into closed source opengl driver
68 * that should really be moved into open-source upstream projects instead
69 * of using legacy physical addresses in user space to communicate with
70 * other out-of-tree kernel modules.
71 *
72 * This module_param *should* be removed as soon as possible and be
73 * considered as a broken and legacy behaviour from a modern fbdev device.
74 */
75#if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
76static bool drm_leak_fbdev_smem = false;
77module_param_unsafe(drm_leak_fbdev_smem, bool, 0600);
78MODULE_PARM_DESC(drm_leak_fbdev_smem,
79 "Allow unsafe leaking fbdev physical smem address [default=false]");
80#endif
81
82static LIST_HEAD(kernel_fb_helper_list);
83static DEFINE_MUTEX(kernel_fb_helper_lock);
84
85/**
86 * DOC: fbdev helpers
87 *
88 * The fb helper functions are useful to provide an fbdev on top of a drm kernel
89 * mode setting driver. They can be used mostly independently from the crtc
90 * helper functions used by many drivers to implement the kernel mode setting
91 * interfaces.
92 *
93 * Drivers that support a dumb buffer with a virtual address and mmap support,
94 * should try out the generic fbdev emulation using drm_fbdev_generic_setup().
95 * It will automatically set up deferred I/O if the driver requires a shadow
96 * buffer.
97 *
98 * At runtime drivers should restore the fbdev console by using
99 * drm_fb_helper_lastclose() as their &drm_driver.lastclose callback.
100 * They should also notify the fb helper code from updates to the output
101 * configuration by using drm_fb_helper_output_poll_changed() as their
102 * &drm_mode_config_funcs.output_poll_changed callback.
103 *
104 * For suspend/resume consider using drm_mode_config_helper_suspend() and
105 * drm_mode_config_helper_resume() which takes care of fbdev as well.
106 *
107 * All other functions exported by the fb helper library can be used to
108 * implement the fbdev driver interface by the driver.
109 *
110 * It is possible, though perhaps somewhat tricky, to implement race-free
111 * hotplug detection using the fbdev helpers. The drm_fb_helper_prepare()
112 * helper must be called first to initialize the minimum required to make
113 * hotplug detection work. Drivers also need to make sure to properly set up
114 * the &drm_mode_config.funcs member. After calling drm_kms_helper_poll_init()
115 * it is safe to enable interrupts and start processing hotplug events. At the
116 * same time, drivers should initialize all modeset objects such as CRTCs,
117 * encoders and connectors. To finish up the fbdev helper initialization, the
118 * drm_fb_helper_init() function is called. To probe for all attached displays
119 * and set up an initial configuration using the detected hardware, drivers
120 * should call drm_fb_helper_initial_config().
121 *
122 * If &drm_framebuffer_funcs.dirty is set, the
123 * drm_fb_helper_{cfb,sys}_{write,fillrect,copyarea,imageblit} functions will
124 * accumulate changes and schedule &drm_fb_helper.dirty_work to run right
125 * away. This worker then calls the dirty() function ensuring that it will
126 * always run in process context since the fb_*() function could be running in
127 * atomic context. If drm_fb_helper_deferred_io() is used as the deferred_io
128 * callback it will also schedule dirty_work with the damage collected from the
129 * mmap page writes.
130 *
131 * Deferred I/O is not compatible with SHMEM. Such drivers should request an
132 * fbdev shadow buffer and call drm_fbdev_generic_setup() instead.
133 */
134
135static void drm_fb_helper_restore_lut_atomic(struct drm_crtc *crtc)
136{
137 uint16_t *r_base, *g_base, *b_base;
138
139 if (crtc->funcs->gamma_set == NULL)
140 return;
141
142 r_base = crtc->gamma_store;
143 g_base = r_base + crtc->gamma_size;
144 b_base = g_base + crtc->gamma_size;
145
146 crtc->funcs->gamma_set(crtc, r_base, g_base, b_base,
147 crtc->gamma_size, NULL);
148}
149
150/**
151 * drm_fb_helper_debug_enter - implementation for &fb_ops.fb_debug_enter
152 * @info: fbdev registered by the helper
153 */
154int drm_fb_helper_debug_enter(struct fb_info *info)
155{
156 struct drm_fb_helper *helper = info->par;
157 const struct drm_crtc_helper_funcs *funcs;
158 struct drm_mode_set *mode_set;
159
160 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
161 mutex_lock(&helper->client.modeset_mutex);
162 drm_client_for_each_modeset(mode_set, &helper->client) {
163 if (!mode_set->crtc->enabled)
164 continue;
165
166 funcs = mode_set->crtc->helper_private;
167 if (funcs->mode_set_base_atomic == NULL)
168 continue;
169
170 if (drm_drv_uses_atomic_modeset(mode_set->crtc->dev))
171 continue;
172
173 funcs->mode_set_base_atomic(mode_set->crtc,
174 mode_set->fb,
175 mode_set->x,
176 mode_set->y,
177 ENTER_ATOMIC_MODE_SET);
178 }
179 mutex_unlock(&helper->client.modeset_mutex);
180 }
181
182 return 0;
183}
184EXPORT_SYMBOL(drm_fb_helper_debug_enter);
185
186/**
187 * drm_fb_helper_debug_leave - implementation for &fb_ops.fb_debug_leave
188 * @info: fbdev registered by the helper
189 */
190int drm_fb_helper_debug_leave(struct fb_info *info)
191{
192 struct drm_fb_helper *helper = info->par;
193 struct drm_client_dev *client = &helper->client;
194 struct drm_device *dev = helper->dev;
195 struct drm_crtc *crtc;
196 const struct drm_crtc_helper_funcs *funcs;
197 struct drm_mode_set *mode_set;
198 struct drm_framebuffer *fb;
199
200 mutex_lock(&client->modeset_mutex);
201 drm_client_for_each_modeset(mode_set, client) {
202 crtc = mode_set->crtc;
203 if (drm_drv_uses_atomic_modeset(crtc->dev))
204 continue;
205
206 funcs = crtc->helper_private;
207 fb = crtc->primary->fb;
208
209 if (!crtc->enabled)
210 continue;
211
212 if (!fb) {
213 drm_err(dev, "no fb to restore?\n");
214 continue;
215 }
216
217 if (funcs->mode_set_base_atomic == NULL)
218 continue;
219
220 drm_fb_helper_restore_lut_atomic(mode_set->crtc);
221 funcs->mode_set_base_atomic(mode_set->crtc, fb, crtc->x,
222 crtc->y, LEAVE_ATOMIC_MODE_SET);
223 }
224 mutex_unlock(&client->modeset_mutex);
225
226 return 0;
227}
228EXPORT_SYMBOL(drm_fb_helper_debug_leave);
229
230static int
231__drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper,
232 bool force)
233{
234 bool do_delayed;
235 int ret;
236
237 if (!drm_fbdev_emulation || !fb_helper)
238 return -ENODEV;
239
240 if (READ_ONCE(fb_helper->deferred_setup))
241 return 0;
242
243 mutex_lock(&fb_helper->lock);
244 if (force) {
245 /*
246 * Yes this is the _locked version which expects the master lock
247 * to be held. But for forced restores we're intentionally
248 * racing here, see drm_fb_helper_set_par().
249 */
250 ret = drm_client_modeset_commit_locked(&fb_helper->client);
251 } else {
252 ret = drm_client_modeset_commit(&fb_helper->client);
253 }
254
255 do_delayed = fb_helper->delayed_hotplug;
256 if (do_delayed)
257 fb_helper->delayed_hotplug = false;
258 mutex_unlock(&fb_helper->lock);
259
260 if (do_delayed)
261 drm_fb_helper_hotplug_event(fb_helper);
262
263 return ret;
264}
265
266/**
267 * drm_fb_helper_restore_fbdev_mode_unlocked - restore fbdev configuration
268 * @fb_helper: driver-allocated fbdev helper, can be NULL
269 *
270 * This should be called from driver's drm &drm_driver.lastclose callback
271 * when implementing an fbcon on top of kms using this helper. This ensures that
272 * the user isn't greeted with a black screen when e.g. X dies.
273 *
274 * RETURNS:
275 * Zero if everything went ok, negative error code otherwise.
276 */
277int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
278{
279 return __drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper, false);
280}
281EXPORT_SYMBOL(drm_fb_helper_restore_fbdev_mode_unlocked);
282
283#ifdef CONFIG_MAGIC_SYSRQ
284/* emergency restore, don't bother with error reporting */
285static void drm_fb_helper_restore_work_fn(struct work_struct *ignored)
286{
287 struct drm_fb_helper *helper;
288
289 mutex_lock(&kernel_fb_helper_lock);
290 list_for_each_entry(helper, &kernel_fb_helper_list, kernel_fb_list) {
291 struct drm_device *dev = helper->dev;
292
293 if (dev->switch_power_state == DRM_SWITCH_POWER_OFF)
294 continue;
295
296 mutex_lock(&helper->lock);
297 drm_client_modeset_commit_locked(&helper->client);
298 mutex_unlock(&helper->lock);
299 }
300 mutex_unlock(&kernel_fb_helper_lock);
301}
302
303static DECLARE_WORK(drm_fb_helper_restore_work, drm_fb_helper_restore_work_fn);
304
305static void drm_fb_helper_sysrq(int dummy1)
306{
307 schedule_work(&drm_fb_helper_restore_work);
308}
309
310static const struct sysrq_key_op sysrq_drm_fb_helper_restore_op = {
311 .handler = drm_fb_helper_sysrq,
312 .help_msg = "force-fb(v)",
313 .action_msg = "Restore framebuffer console",
314};
315#else
316static const struct sysrq_key_op sysrq_drm_fb_helper_restore_op = { };
317#endif
318
319static void drm_fb_helper_dpms(struct fb_info *info, int dpms_mode)
320{
321 struct drm_fb_helper *fb_helper = info->par;
322
323 mutex_lock(&fb_helper->lock);
324 drm_client_modeset_dpms(&fb_helper->client, dpms_mode);
325 mutex_unlock(&fb_helper->lock);
326}
327
328/**
329 * drm_fb_helper_blank - implementation for &fb_ops.fb_blank
330 * @blank: desired blanking state
331 * @info: fbdev registered by the helper
332 */
333int drm_fb_helper_blank(int blank, struct fb_info *info)
334{
335 if (oops_in_progress)
336 return -EBUSY;
337
338 switch (blank) {
339 /* Display: On; HSync: On, VSync: On */
340 case FB_BLANK_UNBLANK:
341 drm_fb_helper_dpms(info, DRM_MODE_DPMS_ON);
342 break;
343 /* Display: Off; HSync: On, VSync: On */
344 case FB_BLANK_NORMAL:
345 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
346 break;
347 /* Display: Off; HSync: Off, VSync: On */
348 case FB_BLANK_HSYNC_SUSPEND:
349 drm_fb_helper_dpms(info, DRM_MODE_DPMS_STANDBY);
350 break;
351 /* Display: Off; HSync: On, VSync: Off */
352 case FB_BLANK_VSYNC_SUSPEND:
353 drm_fb_helper_dpms(info, DRM_MODE_DPMS_SUSPEND);
354 break;
355 /* Display: Off; HSync: Off, VSync: Off */
356 case FB_BLANK_POWERDOWN:
357 drm_fb_helper_dpms(info, DRM_MODE_DPMS_OFF);
358 break;
359 }
360 return 0;
361}
362EXPORT_SYMBOL(drm_fb_helper_blank);
363
364static void drm_fb_helper_resume_worker(struct work_struct *work)
365{
366 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
367 resume_work);
368
369 console_lock();
370 fb_set_suspend(helper->fbdev, 0);
371 console_unlock();
372}
373
374static void drm_fb_helper_damage_blit_real(struct drm_fb_helper *fb_helper,
375 struct drm_clip_rect *clip,
376 struct dma_buf_map *dst)
377{
378 struct drm_framebuffer *fb = fb_helper->fb;
379 unsigned int cpp = fb->format->cpp[0];
380 size_t offset = clip->y1 * fb->pitches[0] + clip->x1 * cpp;
381 void *src = fb_helper->fbdev->screen_buffer + offset;
382 size_t len = (clip->x2 - clip->x1) * cpp;
383 unsigned int y;
384
385 dma_buf_map_incr(dst, offset); /* go to first pixel within clip rect */
386
387 for (y = clip->y1; y < clip->y2; y++) {
388 dma_buf_map_memcpy_to(dst, src, len);
389 dma_buf_map_incr(dst, fb->pitches[0]);
390 src += fb->pitches[0];
391 }
392}
393
394static int drm_fb_helper_damage_blit(struct drm_fb_helper *fb_helper,
395 struct drm_clip_rect *clip)
396{
397 struct drm_client_buffer *buffer = fb_helper->buffer;
398 struct dma_buf_map map, dst;
399 int ret;
400
401 /*
402 * We have to pin the client buffer to its current location while
403 * flushing the shadow buffer. In the general case, concurrent
404 * modesetting operations could try to move the buffer and would
405 * fail. The modeset has to be serialized by acquiring the reservation
406 * object of the underlying BO here.
407 *
408 * For fbdev emulation, we only have to protect against fbdev modeset
409 * operations. Nothing else will involve the client buffer's BO. So it
410 * is sufficient to acquire struct drm_fb_helper.lock here.
411 */
412 mutex_lock(&fb_helper->lock);
413
414 ret = drm_client_buffer_vmap(buffer, &map);
415 if (ret)
416 goto out;
417
418 dst = map;
419 drm_fb_helper_damage_blit_real(fb_helper, clip, &dst);
420
421 drm_client_buffer_vunmap(buffer);
422
423out:
424 mutex_unlock(&fb_helper->lock);
425
426 return ret;
427}
428
429static void drm_fb_helper_damage_work(struct work_struct *work)
430{
431 struct drm_fb_helper *helper = container_of(work, struct drm_fb_helper,
432 damage_work);
433 struct drm_device *dev = helper->dev;
434 struct drm_clip_rect *clip = &helper->damage_clip;
435 struct drm_clip_rect clip_copy;
436 unsigned long flags;
437 int ret;
438
439 spin_lock_irqsave(&helper->damage_lock, flags);
440 clip_copy = *clip;
441 clip->x1 = clip->y1 = ~0;
442 clip->x2 = clip->y2 = 0;
443 spin_unlock_irqrestore(&helper->damage_lock, flags);
444
445 /* Call damage handlers only if necessary */
446 if (!(clip_copy.x1 < clip_copy.x2 && clip_copy.y1 < clip_copy.y2))
447 return;
448
449 if (helper->buffer) {
450 ret = drm_fb_helper_damage_blit(helper, &clip_copy);
451 if (drm_WARN_ONCE(dev, ret, "Damage blitter failed: ret=%d\n", ret))
452 goto err;
453 }
454
455 if (helper->fb->funcs->dirty) {
456 ret = helper->fb->funcs->dirty(helper->fb, NULL, 0, 0, &clip_copy, 1);
457 if (drm_WARN_ONCE(dev, ret, "Dirty helper failed: ret=%d\n", ret))
458 goto err;
459 }
460
461 return;
462
463err:
464 /*
465 * Restore damage clip rectangle on errors. The next run
466 * of the damage worker will perform the update.
467 */
468 spin_lock_irqsave(&helper->damage_lock, flags);
469 clip->x1 = min_t(u32, clip->x1, clip_copy.x1);
470 clip->y1 = min_t(u32, clip->y1, clip_copy.y1);
471 clip->x2 = max_t(u32, clip->x2, clip_copy.x2);
472 clip->y2 = max_t(u32, clip->y2, clip_copy.y2);
473 spin_unlock_irqrestore(&helper->damage_lock, flags);
474}
475
476/**
477 * drm_fb_helper_prepare - setup a drm_fb_helper structure
478 * @dev: DRM device
479 * @helper: driver-allocated fbdev helper structure to set up
480 * @funcs: pointer to structure of functions associate with this helper
481 *
482 * Sets up the bare minimum to make the framebuffer helper usable. This is
483 * useful to implement race-free initialization of the polling helpers.
484 */
485void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
486 const struct drm_fb_helper_funcs *funcs)
487{
488 INIT_LIST_HEAD(&helper->kernel_fb_list);
489 spin_lock_init(&helper->damage_lock);
490 INIT_WORK(&helper->resume_work, drm_fb_helper_resume_worker);
491 INIT_WORK(&helper->damage_work, drm_fb_helper_damage_work);
492 helper->damage_clip.x1 = helper->damage_clip.y1 = ~0;
493 mutex_init(&helper->lock);
494 helper->funcs = funcs;
495 helper->dev = dev;
496}
497EXPORT_SYMBOL(drm_fb_helper_prepare);
498
499/**
500 * drm_fb_helper_init - initialize a &struct drm_fb_helper
501 * @dev: drm device
502 * @fb_helper: driver-allocated fbdev helper structure to initialize
503 *
504 * This allocates the structures for the fbdev helper with the given limits.
505 * Note that this won't yet touch the hardware (through the driver interfaces)
506 * nor register the fbdev. This is only done in drm_fb_helper_initial_config()
507 * to allow driver writes more control over the exact init sequence.
508 *
509 * Drivers must call drm_fb_helper_prepare() before calling this function.
510 *
511 * RETURNS:
512 * Zero if everything went ok, nonzero otherwise.
513 */
514int drm_fb_helper_init(struct drm_device *dev,
515 struct drm_fb_helper *fb_helper)
516{
517 int ret;
518
519 if (!drm_fbdev_emulation) {
520 dev->fb_helper = fb_helper;
521 return 0;
522 }
523
524 /*
525 * If this is not the generic fbdev client, initialize a drm_client
526 * without callbacks so we can use the modesets.
527 */
528 if (!fb_helper->client.funcs) {
529 ret = drm_client_init(dev, &fb_helper->client, "drm_fb_helper", NULL);
530 if (ret)
531 return ret;
532 }
533
534 dev->fb_helper = fb_helper;
535
536 return 0;
537}
538EXPORT_SYMBOL(drm_fb_helper_init);
539
540/**
541 * drm_fb_helper_alloc_fbi - allocate fb_info and some of its members
542 * @fb_helper: driver-allocated fbdev helper
543 *
544 * A helper to alloc fb_info and the members cmap and apertures. Called
545 * by the driver within the fb_probe fb_helper callback function. Drivers do not
546 * need to release the allocated fb_info structure themselves, this is
547 * automatically done when calling drm_fb_helper_fini().
548 *
549 * RETURNS:
550 * fb_info pointer if things went okay, pointer containing error code
551 * otherwise
552 */
553struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
554{
555 struct device *dev = fb_helper->dev->dev;
556 struct fb_info *info;
557 int ret;
558
559 info = framebuffer_alloc(0, dev);
560 if (!info)
561 return ERR_PTR(-ENOMEM);
562
563 ret = fb_alloc_cmap(&info->cmap, 256, 0);
564 if (ret)
565 goto err_release;
566
567 /*
568 * TODO: We really should be smarter here and alloc an apperture
569 * for each IORESOURCE_MEM resource helper->dev->dev has and also
570 * init the ranges of the appertures based on the resources.
571 * Note some drivers currently count on there being only 1 empty
572 * aperture and fill this themselves, these will need to be dealt
573 * with somehow when fixing this.
574 */
575 info->apertures = alloc_apertures(1);
576 if (!info->apertures) {
577 ret = -ENOMEM;
578 goto err_free_cmap;
579 }
580
581 fb_helper->fbdev = info;
582 info->skip_vt_switch = true;
583
584 return info;
585
586err_free_cmap:
587 fb_dealloc_cmap(&info->cmap);
588err_release:
589 framebuffer_release(info);
590 return ERR_PTR(ret);
591}
592EXPORT_SYMBOL(drm_fb_helper_alloc_fbi);
593
594/**
595 * drm_fb_helper_unregister_fbi - unregister fb_info framebuffer device
596 * @fb_helper: driver-allocated fbdev helper, can be NULL
597 *
598 * A wrapper around unregister_framebuffer, to release the fb_info
599 * framebuffer device. This must be called before releasing all resources for
600 * @fb_helper by calling drm_fb_helper_fini().
601 */
602void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
603{
604 if (fb_helper && fb_helper->fbdev)
605 unregister_framebuffer(fb_helper->fbdev);
606}
607EXPORT_SYMBOL(drm_fb_helper_unregister_fbi);
608
609/**
610 * drm_fb_helper_fini - finialize a &struct drm_fb_helper
611 * @fb_helper: driver-allocated fbdev helper, can be NULL
612 *
613 * This cleans up all remaining resources associated with @fb_helper.
614 */
615void drm_fb_helper_fini(struct drm_fb_helper *fb_helper)
616{
617 struct fb_info *info;
618
619 if (!fb_helper)
620 return;
621
622 fb_helper->dev->fb_helper = NULL;
623
624 if (!drm_fbdev_emulation)
625 return;
626
627 cancel_work_sync(&fb_helper->resume_work);
628 cancel_work_sync(&fb_helper->damage_work);
629
630 info = fb_helper->fbdev;
631 if (info) {
632 if (info->cmap.len)
633 fb_dealloc_cmap(&info->cmap);
634 framebuffer_release(info);
635 }
636 fb_helper->fbdev = NULL;
637
638 mutex_lock(&kernel_fb_helper_lock);
639 if (!list_empty(&fb_helper->kernel_fb_list)) {
640 list_del(&fb_helper->kernel_fb_list);
641 if (list_empty(&kernel_fb_helper_list))
642 unregister_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
643 }
644 mutex_unlock(&kernel_fb_helper_lock);
645
646 mutex_destroy(&fb_helper->lock);
647
648 if (!fb_helper->client.funcs)
649 drm_client_release(&fb_helper->client);
650}
651EXPORT_SYMBOL(drm_fb_helper_fini);
652
653static bool drm_fbdev_use_shadow_fb(struct drm_fb_helper *fb_helper)
654{
655 struct drm_device *dev = fb_helper->dev;
656 struct drm_framebuffer *fb = fb_helper->fb;
657
658 return dev->mode_config.prefer_shadow_fbdev ||
659 dev->mode_config.prefer_shadow ||
660 fb->funcs->dirty;
661}
662
663static void drm_fb_helper_damage(struct fb_info *info, u32 x, u32 y,
664 u32 width, u32 height)
665{
666 struct drm_fb_helper *helper = info->par;
667 struct drm_clip_rect *clip = &helper->damage_clip;
668 unsigned long flags;
669
670 if (!drm_fbdev_use_shadow_fb(helper))
671 return;
672
673 spin_lock_irqsave(&helper->damage_lock, flags);
674 clip->x1 = min_t(u32, clip->x1, x);
675 clip->y1 = min_t(u32, clip->y1, y);
676 clip->x2 = max_t(u32, clip->x2, x + width);
677 clip->y2 = max_t(u32, clip->y2, y + height);
678 spin_unlock_irqrestore(&helper->damage_lock, flags);
679
680 schedule_work(&helper->damage_work);
681}
682
683/**
684 * drm_fb_helper_deferred_io() - fbdev deferred_io callback function
685 * @info: fb_info struct pointer
686 * @pagelist: list of mmap framebuffer pages that have to be flushed
687 *
688 * This function is used as the &fb_deferred_io.deferred_io
689 * callback function for flushing the fbdev mmap writes.
690 */
691void drm_fb_helper_deferred_io(struct fb_info *info,
692 struct list_head *pagelist)
693{
694 unsigned long start, end, min, max;
695 struct page *page;
696 u32 y1, y2;
697
698 min = ULONG_MAX;
699 max = 0;
700 list_for_each_entry(page, pagelist, lru) {
701 start = page->index << PAGE_SHIFT;
702 end = start + PAGE_SIZE - 1;
703 min = min(min, start);
704 max = max(max, end);
705 }
706
707 if (min < max) {
708 y1 = min / info->fix.line_length;
709 y2 = min_t(u32, DIV_ROUND_UP(max, info->fix.line_length),
710 info->var.yres);
711 drm_fb_helper_damage(info, 0, y1, info->var.xres, y2 - y1);
712 }
713}
714EXPORT_SYMBOL(drm_fb_helper_deferred_io);
715
716/**
717 * drm_fb_helper_sys_read - wrapper around fb_sys_read
718 * @info: fb_info struct pointer
719 * @buf: userspace buffer to read from framebuffer memory
720 * @count: number of bytes to read from framebuffer memory
721 * @ppos: read offset within framebuffer memory
722 *
723 * A wrapper around fb_sys_read implemented by fbdev core
724 */
725ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
726 size_t count, loff_t *ppos)
727{
728 return fb_sys_read(info, buf, count, ppos);
729}
730EXPORT_SYMBOL(drm_fb_helper_sys_read);
731
732/**
733 * drm_fb_helper_sys_write - wrapper around fb_sys_write
734 * @info: fb_info struct pointer
735 * @buf: userspace buffer to write to framebuffer memory
736 * @count: number of bytes to write to framebuffer memory
737 * @ppos: write offset within framebuffer memory
738 *
739 * A wrapper around fb_sys_write implemented by fbdev core
740 */
741ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
742 size_t count, loff_t *ppos)
743{
744 ssize_t ret;
745
746 ret = fb_sys_write(info, buf, count, ppos);
747 if (ret > 0)
748 drm_fb_helper_damage(info, 0, 0, info->var.xres, info->var.yres);
749
750 return ret;
751}
752EXPORT_SYMBOL(drm_fb_helper_sys_write);
753
754/**
755 * drm_fb_helper_sys_fillrect - wrapper around sys_fillrect
756 * @info: fbdev registered by the helper
757 * @rect: info about rectangle to fill
758 *
759 * A wrapper around sys_fillrect implemented by fbdev core
760 */
761void drm_fb_helper_sys_fillrect(struct fb_info *info,
762 const struct fb_fillrect *rect)
763{
764 sys_fillrect(info, rect);
765 drm_fb_helper_damage(info, rect->dx, rect->dy, rect->width, rect->height);
766}
767EXPORT_SYMBOL(drm_fb_helper_sys_fillrect);
768
769/**
770 * drm_fb_helper_sys_copyarea - wrapper around sys_copyarea
771 * @info: fbdev registered by the helper
772 * @area: info about area to copy
773 *
774 * A wrapper around sys_copyarea implemented by fbdev core
775 */
776void drm_fb_helper_sys_copyarea(struct fb_info *info,
777 const struct fb_copyarea *area)
778{
779 sys_copyarea(info, area);
780 drm_fb_helper_damage(info, area->dx, area->dy, area->width, area->height);
781}
782EXPORT_SYMBOL(drm_fb_helper_sys_copyarea);
783
784/**
785 * drm_fb_helper_sys_imageblit - wrapper around sys_imageblit
786 * @info: fbdev registered by the helper
787 * @image: info about image to blit
788 *
789 * A wrapper around sys_imageblit implemented by fbdev core
790 */
791void drm_fb_helper_sys_imageblit(struct fb_info *info,
792 const struct fb_image *image)
793{
794 sys_imageblit(info, image);
795 drm_fb_helper_damage(info, image->dx, image->dy, image->width, image->height);
796}
797EXPORT_SYMBOL(drm_fb_helper_sys_imageblit);
798
799/**
800 * drm_fb_helper_cfb_fillrect - wrapper around cfb_fillrect
801 * @info: fbdev registered by the helper
802 * @rect: info about rectangle to fill
803 *
804 * A wrapper around cfb_fillrect implemented by fbdev core
805 */
806void drm_fb_helper_cfb_fillrect(struct fb_info *info,
807 const struct fb_fillrect *rect)
808{
809 cfb_fillrect(info, rect);
810 drm_fb_helper_damage(info, rect->dx, rect->dy, rect->width, rect->height);
811}
812EXPORT_SYMBOL(drm_fb_helper_cfb_fillrect);
813
814/**
815 * drm_fb_helper_cfb_copyarea - wrapper around cfb_copyarea
816 * @info: fbdev registered by the helper
817 * @area: info about area to copy
818 *
819 * A wrapper around cfb_copyarea implemented by fbdev core
820 */
821void drm_fb_helper_cfb_copyarea(struct fb_info *info,
822 const struct fb_copyarea *area)
823{
824 cfb_copyarea(info, area);
825 drm_fb_helper_damage(info, area->dx, area->dy, area->width, area->height);
826}
827EXPORT_SYMBOL(drm_fb_helper_cfb_copyarea);
828
829/**
830 * drm_fb_helper_cfb_imageblit - wrapper around cfb_imageblit
831 * @info: fbdev registered by the helper
832 * @image: info about image to blit
833 *
834 * A wrapper around cfb_imageblit implemented by fbdev core
835 */
836void drm_fb_helper_cfb_imageblit(struct fb_info *info,
837 const struct fb_image *image)
838{
839 cfb_imageblit(info, image);
840 drm_fb_helper_damage(info, image->dx, image->dy, image->width, image->height);
841}
842EXPORT_SYMBOL(drm_fb_helper_cfb_imageblit);
843
844/**
845 * drm_fb_helper_set_suspend - wrapper around fb_set_suspend
846 * @fb_helper: driver-allocated fbdev helper, can be NULL
847 * @suspend: whether to suspend or resume
848 *
849 * A wrapper around fb_set_suspend implemented by fbdev core.
850 * Use drm_fb_helper_set_suspend_unlocked() if you don't need to take
851 * the lock yourself
852 */
853void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend)
854{
855 if (fb_helper && fb_helper->fbdev)
856 fb_set_suspend(fb_helper->fbdev, suspend);
857}
858EXPORT_SYMBOL(drm_fb_helper_set_suspend);
859
860/**
861 * drm_fb_helper_set_suspend_unlocked - wrapper around fb_set_suspend that also
862 * takes the console lock
863 * @fb_helper: driver-allocated fbdev helper, can be NULL
864 * @suspend: whether to suspend or resume
865 *
866 * A wrapper around fb_set_suspend() that takes the console lock. If the lock
867 * isn't available on resume, a worker is tasked with waiting for the lock
868 * to become available. The console lock can be pretty contented on resume
869 * due to all the printk activity.
870 *
871 * This function can be called multiple times with the same state since
872 * &fb_info.state is checked to see if fbdev is running or not before locking.
873 *
874 * Use drm_fb_helper_set_suspend() if you need to take the lock yourself.
875 */
876void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
877 bool suspend)
878{
879 if (!fb_helper || !fb_helper->fbdev)
880 return;
881
882 /* make sure there's no pending/ongoing resume */
883 flush_work(&fb_helper->resume_work);
884
885 if (suspend) {
886 if (fb_helper->fbdev->state != FBINFO_STATE_RUNNING)
887 return;
888
889 console_lock();
890
891 } else {
892 if (fb_helper->fbdev->state == FBINFO_STATE_RUNNING)
893 return;
894
895 if (!console_trylock()) {
896 schedule_work(&fb_helper->resume_work);
897 return;
898 }
899 }
900
901 fb_set_suspend(fb_helper->fbdev, suspend);
902 console_unlock();
903}
904EXPORT_SYMBOL(drm_fb_helper_set_suspend_unlocked);
905
906static int setcmap_pseudo_palette(struct fb_cmap *cmap, struct fb_info *info)
907{
908 u32 *palette = (u32 *)info->pseudo_palette;
909 int i;
910
911 if (cmap->start + cmap->len > 16)
912 return -EINVAL;
913
914 for (i = 0; i < cmap->len; ++i) {
915 u16 red = cmap->red[i];
916 u16 green = cmap->green[i];
917 u16 blue = cmap->blue[i];
918 u32 value;
919
920 red >>= 16 - info->var.red.length;
921 green >>= 16 - info->var.green.length;
922 blue >>= 16 - info->var.blue.length;
923 value = (red << info->var.red.offset) |
924 (green << info->var.green.offset) |
925 (blue << info->var.blue.offset);
926 if (info->var.transp.length > 0) {
927 u32 mask = (1 << info->var.transp.length) - 1;
928
929 mask <<= info->var.transp.offset;
930 value |= mask;
931 }
932 palette[cmap->start + i] = value;
933 }
934
935 return 0;
936}
937
938static int setcmap_legacy(struct fb_cmap *cmap, struct fb_info *info)
939{
940 struct drm_fb_helper *fb_helper = info->par;
941 struct drm_mode_set *modeset;
942 struct drm_crtc *crtc;
943 u16 *r, *g, *b;
944 int ret = 0;
945
946 drm_modeset_lock_all(fb_helper->dev);
947 drm_client_for_each_modeset(modeset, &fb_helper->client) {
948 crtc = modeset->crtc;
949 if (!crtc->funcs->gamma_set || !crtc->gamma_size) {
950 ret = -EINVAL;
951 goto out;
952 }
953
954 if (cmap->start + cmap->len > crtc->gamma_size) {
955 ret = -EINVAL;
956 goto out;
957 }
958
959 r = crtc->gamma_store;
960 g = r + crtc->gamma_size;
961 b = g + crtc->gamma_size;
962
963 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
964 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
965 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
966
967 ret = crtc->funcs->gamma_set(crtc, r, g, b,
968 crtc->gamma_size, NULL);
969 if (ret)
970 goto out;
971 }
972out:
973 drm_modeset_unlock_all(fb_helper->dev);
974
975 return ret;
976}
977
978static struct drm_property_blob *setcmap_new_gamma_lut(struct drm_crtc *crtc,
979 struct fb_cmap *cmap)
980{
981 struct drm_device *dev = crtc->dev;
982 struct drm_property_blob *gamma_lut;
983 struct drm_color_lut *lut;
984 int size = crtc->gamma_size;
985 int i;
986
987 if (!size || cmap->start + cmap->len > size)
988 return ERR_PTR(-EINVAL);
989
990 gamma_lut = drm_property_create_blob(dev, sizeof(*lut) * size, NULL);
991 if (IS_ERR(gamma_lut))
992 return gamma_lut;
993
994 lut = gamma_lut->data;
995 if (cmap->start || cmap->len != size) {
996 u16 *r = crtc->gamma_store;
997 u16 *g = r + crtc->gamma_size;
998 u16 *b = g + crtc->gamma_size;
999
1000 for (i = 0; i < cmap->start; i++) {
1001 lut[i].red = r[i];
1002 lut[i].green = g[i];
1003 lut[i].blue = b[i];
1004 }
1005 for (i = cmap->start + cmap->len; i < size; i++) {
1006 lut[i].red = r[i];
1007 lut[i].green = g[i];
1008 lut[i].blue = b[i];
1009 }
1010 }
1011
1012 for (i = 0; i < cmap->len; i++) {
1013 lut[cmap->start + i].red = cmap->red[i];
1014 lut[cmap->start + i].green = cmap->green[i];
1015 lut[cmap->start + i].blue = cmap->blue[i];
1016 }
1017
1018 return gamma_lut;
1019}
1020
1021static int setcmap_atomic(struct fb_cmap *cmap, struct fb_info *info)
1022{
1023 struct drm_fb_helper *fb_helper = info->par;
1024 struct drm_device *dev = fb_helper->dev;
1025 struct drm_property_blob *gamma_lut = NULL;
1026 struct drm_modeset_acquire_ctx ctx;
1027 struct drm_crtc_state *crtc_state;
1028 struct drm_atomic_state *state;
1029 struct drm_mode_set *modeset;
1030 struct drm_crtc *crtc;
1031 u16 *r, *g, *b;
1032 bool replaced;
1033 int ret = 0;
1034
1035 drm_modeset_acquire_init(&ctx, 0);
1036
1037 state = drm_atomic_state_alloc(dev);
1038 if (!state) {
1039 ret = -ENOMEM;
1040 goto out_ctx;
1041 }
1042
1043 state->acquire_ctx = &ctx;
1044retry:
1045 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1046 crtc = modeset->crtc;
1047
1048 if (!gamma_lut)
1049 gamma_lut = setcmap_new_gamma_lut(crtc, cmap);
1050 if (IS_ERR(gamma_lut)) {
1051 ret = PTR_ERR(gamma_lut);
1052 gamma_lut = NULL;
1053 goto out_state;
1054 }
1055
1056 crtc_state = drm_atomic_get_crtc_state(state, crtc);
1057 if (IS_ERR(crtc_state)) {
1058 ret = PTR_ERR(crtc_state);
1059 goto out_state;
1060 }
1061
1062 /*
1063 * FIXME: This always uses gamma_lut. Some HW have only
1064 * degamma_lut, in which case we should reset gamma_lut and set
1065 * degamma_lut. See drm_crtc_legacy_gamma_set().
1066 */
1067 replaced = drm_property_replace_blob(&crtc_state->degamma_lut,
1068 NULL);
1069 replaced |= drm_property_replace_blob(&crtc_state->ctm, NULL);
1070 replaced |= drm_property_replace_blob(&crtc_state->gamma_lut,
1071 gamma_lut);
1072 crtc_state->color_mgmt_changed |= replaced;
1073 }
1074
1075 ret = drm_atomic_commit(state);
1076 if (ret)
1077 goto out_state;
1078
1079 drm_client_for_each_modeset(modeset, &fb_helper->client) {
1080 crtc = modeset->crtc;
1081
1082 r = crtc->gamma_store;
1083 g = r + crtc->gamma_size;
1084 b = g + crtc->gamma_size;
1085
1086 memcpy(r + cmap->start, cmap->red, cmap->len * sizeof(*r));
1087 memcpy(g + cmap->start, cmap->green, cmap->len * sizeof(*g));
1088 memcpy(b + cmap->start, cmap->blue, cmap->len * sizeof(*b));
1089 }
1090
1091out_state:
1092 if (ret == -EDEADLK)
1093 goto backoff;
1094
1095 drm_property_blob_put(gamma_lut);
1096 drm_atomic_state_put(state);
1097out_ctx:
1098 drm_modeset_drop_locks(&ctx);
1099 drm_modeset_acquire_fini(&ctx);
1100
1101 return ret;
1102
1103backoff:
1104 drm_atomic_state_clear(state);
1105 drm_modeset_backoff(&ctx);
1106 goto retry;
1107}
1108
1109/**
1110 * drm_fb_helper_setcmap - implementation for &fb_ops.fb_setcmap
1111 * @cmap: cmap to set
1112 * @info: fbdev registered by the helper
1113 */
1114int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info)
1115{
1116 struct drm_fb_helper *fb_helper = info->par;
1117 struct drm_device *dev = fb_helper->dev;
1118 int ret;
1119
1120 if (oops_in_progress)
1121 return -EBUSY;
1122
1123 mutex_lock(&fb_helper->lock);
1124
1125 if (!drm_master_internal_acquire(dev)) {
1126 ret = -EBUSY;
1127 goto unlock;
1128 }
1129
1130 mutex_lock(&fb_helper->client.modeset_mutex);
1131 if (info->fix.visual == FB_VISUAL_TRUECOLOR)
1132 ret = setcmap_pseudo_palette(cmap, info);
1133 else if (drm_drv_uses_atomic_modeset(fb_helper->dev))
1134 ret = setcmap_atomic(cmap, info);
1135 else
1136 ret = setcmap_legacy(cmap, info);
1137 mutex_unlock(&fb_helper->client.modeset_mutex);
1138
1139 drm_master_internal_release(dev);
1140unlock:
1141 mutex_unlock(&fb_helper->lock);
1142
1143 return ret;
1144}
1145EXPORT_SYMBOL(drm_fb_helper_setcmap);
1146
1147/**
1148 * drm_fb_helper_ioctl - legacy ioctl implementation
1149 * @info: fbdev registered by the helper
1150 * @cmd: ioctl command
1151 * @arg: ioctl argument
1152 *
1153 * A helper to implement the standard fbdev ioctl. Only
1154 * FBIO_WAITFORVSYNC is implemented for now.
1155 */
1156int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
1157 unsigned long arg)
1158{
1159 struct drm_fb_helper *fb_helper = info->par;
1160 struct drm_device *dev = fb_helper->dev;
1161 struct drm_crtc *crtc;
1162 int ret = 0;
1163
1164 mutex_lock(&fb_helper->lock);
1165 if (!drm_master_internal_acquire(dev)) {
1166 ret = -EBUSY;
1167 goto unlock;
1168 }
1169
1170 switch (cmd) {
1171 case FBIO_WAITFORVSYNC:
1172 /*
1173 * Only consider the first CRTC.
1174 *
1175 * This ioctl is supposed to take the CRTC number as
1176 * an argument, but in fbdev times, what that number
1177 * was supposed to be was quite unclear, different
1178 * drivers were passing that argument differently
1179 * (some by reference, some by value), and most of the
1180 * userspace applications were just hardcoding 0 as an
1181 * argument.
1182 *
1183 * The first CRTC should be the integrated panel on
1184 * most drivers, so this is the best choice we can
1185 * make. If we're not smart enough here, one should
1186 * just consider switch the userspace to KMS.
1187 */
1188 crtc = fb_helper->client.modesets[0].crtc;
1189
1190 /*
1191 * Only wait for a vblank event if the CRTC is
1192 * enabled, otherwise just don't do anythintg,
1193 * not even report an error.
1194 */
1195 ret = drm_crtc_vblank_get(crtc);
1196 if (!ret) {
1197 drm_crtc_wait_one_vblank(crtc);
1198 drm_crtc_vblank_put(crtc);
1199 }
1200
1201 ret = 0;
1202 break;
1203 default:
1204 ret = -ENOTTY;
1205 }
1206
1207 drm_master_internal_release(dev);
1208unlock:
1209 mutex_unlock(&fb_helper->lock);
1210 return ret;
1211}
1212EXPORT_SYMBOL(drm_fb_helper_ioctl);
1213
1214static bool drm_fb_pixel_format_equal(const struct fb_var_screeninfo *var_1,
1215 const struct fb_var_screeninfo *var_2)
1216{
1217 return var_1->bits_per_pixel == var_2->bits_per_pixel &&
1218 var_1->grayscale == var_2->grayscale &&
1219 var_1->red.offset == var_2->red.offset &&
1220 var_1->red.length == var_2->red.length &&
1221 var_1->red.msb_right == var_2->red.msb_right &&
1222 var_1->green.offset == var_2->green.offset &&
1223 var_1->green.length == var_2->green.length &&
1224 var_1->green.msb_right == var_2->green.msb_right &&
1225 var_1->blue.offset == var_2->blue.offset &&
1226 var_1->blue.length == var_2->blue.length &&
1227 var_1->blue.msb_right == var_2->blue.msb_right &&
1228 var_1->transp.offset == var_2->transp.offset &&
1229 var_1->transp.length == var_2->transp.length &&
1230 var_1->transp.msb_right == var_2->transp.msb_right;
1231}
1232
1233static void drm_fb_helper_fill_pixel_fmt(struct fb_var_screeninfo *var,
1234 u8 depth)
1235{
1236 switch (depth) {
1237 case 8:
1238 var->red.offset = 0;
1239 var->green.offset = 0;
1240 var->blue.offset = 0;
1241 var->red.length = 8; /* 8bit DAC */
1242 var->green.length = 8;
1243 var->blue.length = 8;
1244 var->transp.offset = 0;
1245 var->transp.length = 0;
1246 break;
1247 case 15:
1248 var->red.offset = 10;
1249 var->green.offset = 5;
1250 var->blue.offset = 0;
1251 var->red.length = 5;
1252 var->green.length = 5;
1253 var->blue.length = 5;
1254 var->transp.offset = 15;
1255 var->transp.length = 1;
1256 break;
1257 case 16:
1258 var->red.offset = 11;
1259 var->green.offset = 5;
1260 var->blue.offset = 0;
1261 var->red.length = 5;
1262 var->green.length = 6;
1263 var->blue.length = 5;
1264 var->transp.offset = 0;
1265 break;
1266 case 24:
1267 var->red.offset = 16;
1268 var->green.offset = 8;
1269 var->blue.offset = 0;
1270 var->red.length = 8;
1271 var->green.length = 8;
1272 var->blue.length = 8;
1273 var->transp.offset = 0;
1274 var->transp.length = 0;
1275 break;
1276 case 32:
1277 var->red.offset = 16;
1278 var->green.offset = 8;
1279 var->blue.offset = 0;
1280 var->red.length = 8;
1281 var->green.length = 8;
1282 var->blue.length = 8;
1283 var->transp.offset = 24;
1284 var->transp.length = 8;
1285 break;
1286 default:
1287 break;
1288 }
1289}
1290
1291/**
1292 * drm_fb_helper_check_var - implementation for &fb_ops.fb_check_var
1293 * @var: screeninfo to check
1294 * @info: fbdev registered by the helper
1295 */
1296int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
1297 struct fb_info *info)
1298{
1299 struct drm_fb_helper *fb_helper = info->par;
1300 struct drm_framebuffer *fb = fb_helper->fb;
1301 struct drm_device *dev = fb_helper->dev;
1302
1303 if (in_dbg_master())
1304 return -EINVAL;
1305
1306 if (var->pixclock != 0) {
1307 drm_dbg_kms(dev, "fbdev emulation doesn't support changing the pixel clock, value of pixclock is ignored\n");
1308 var->pixclock = 0;
1309 }
1310
1311 if ((drm_format_info_block_width(fb->format, 0) > 1) ||
1312 (drm_format_info_block_height(fb->format, 0) > 1))
1313 return -EINVAL;
1314
1315 /*
1316 * Changes struct fb_var_screeninfo are currently not pushed back
1317 * to KMS, hence fail if different settings are requested.
1318 */
1319 if (var->bits_per_pixel > fb->format->cpp[0] * 8 ||
1320 var->xres > fb->width || var->yres > fb->height ||
1321 var->xres_virtual > fb->width || var->yres_virtual > fb->height) {
1322 drm_dbg_kms(dev, "fb requested width/height/bpp can't fit in current fb "
1323 "request %dx%d-%d (virtual %dx%d) > %dx%d-%d\n",
1324 var->xres, var->yres, var->bits_per_pixel,
1325 var->xres_virtual, var->yres_virtual,
1326 fb->width, fb->height, fb->format->cpp[0] * 8);
1327 return -EINVAL;
1328 }
1329
1330 /*
1331 * Workaround for SDL 1.2, which is known to be setting all pixel format
1332 * fields values to zero in some cases. We treat this situation as a
1333 * kind of "use some reasonable autodetected values".
1334 */
1335 if (!var->red.offset && !var->green.offset &&
1336 !var->blue.offset && !var->transp.offset &&
1337 !var->red.length && !var->green.length &&
1338 !var->blue.length && !var->transp.length &&
1339 !var->red.msb_right && !var->green.msb_right &&
1340 !var->blue.msb_right && !var->transp.msb_right) {
1341 drm_fb_helper_fill_pixel_fmt(var, fb->format->depth);
1342 }
1343
1344 /*
1345 * Likewise, bits_per_pixel should be rounded up to a supported value.
1346 */
1347 var->bits_per_pixel = fb->format->cpp[0] * 8;
1348
1349 /*
1350 * drm fbdev emulation doesn't support changing the pixel format at all,
1351 * so reject all pixel format changing requests.
1352 */
1353 if (!drm_fb_pixel_format_equal(var, &info->var)) {
1354 drm_dbg_kms(dev, "fbdev emulation doesn't support changing the pixel format\n");
1355 return -EINVAL;
1356 }
1357
1358 return 0;
1359}
1360EXPORT_SYMBOL(drm_fb_helper_check_var);
1361
1362/**
1363 * drm_fb_helper_set_par - implementation for &fb_ops.fb_set_par
1364 * @info: fbdev registered by the helper
1365 *
1366 * This will let fbcon do the mode init and is called at initialization time by
1367 * the fbdev core when registering the driver, and later on through the hotplug
1368 * callback.
1369 */
1370int drm_fb_helper_set_par(struct fb_info *info)
1371{
1372 struct drm_fb_helper *fb_helper = info->par;
1373 struct fb_var_screeninfo *var = &info->var;
1374 bool force;
1375
1376 if (oops_in_progress)
1377 return -EBUSY;
1378
1379 if (var->pixclock != 0) {
1380 drm_err(fb_helper->dev, "PIXEL CLOCK SET\n");
1381 return -EINVAL;
1382 }
1383
1384 /*
1385 * Normally we want to make sure that a kms master takes precedence over
1386 * fbdev, to avoid fbdev flickering and occasionally stealing the
1387 * display status. But Xorg first sets the vt back to text mode using
1388 * the KDSET IOCTL with KD_TEXT, and only after that drops the master
1389 * status when exiting.
1390 *
1391 * In the past this was caught by drm_fb_helper_lastclose(), but on
1392 * modern systems where logind always keeps a drm fd open to orchestrate
1393 * the vt switching, this doesn't work.
1394 *
1395 * To not break the userspace ABI we have this special case here, which
1396 * is only used for the above case. Everything else uses the normal
1397 * commit function, which ensures that we never steal the display from
1398 * an active drm master.
1399 */
1400 force = var->activate & FB_ACTIVATE_KD_TEXT;
1401
1402 __drm_fb_helper_restore_fbdev_mode_unlocked(fb_helper, force);
1403
1404 return 0;
1405}
1406EXPORT_SYMBOL(drm_fb_helper_set_par);
1407
1408static void pan_set(struct drm_fb_helper *fb_helper, int x, int y)
1409{
1410 struct drm_mode_set *mode_set;
1411
1412 mutex_lock(&fb_helper->client.modeset_mutex);
1413 drm_client_for_each_modeset(mode_set, &fb_helper->client) {
1414 mode_set->x = x;
1415 mode_set->y = y;
1416 }
1417 mutex_unlock(&fb_helper->client.modeset_mutex);
1418}
1419
1420static int pan_display_atomic(struct fb_var_screeninfo *var,
1421 struct fb_info *info)
1422{
1423 struct drm_fb_helper *fb_helper = info->par;
1424 int ret;
1425
1426 pan_set(fb_helper, var->xoffset, var->yoffset);
1427
1428 ret = drm_client_modeset_commit_locked(&fb_helper->client);
1429 if (!ret) {
1430 info->var.xoffset = var->xoffset;
1431 info->var.yoffset = var->yoffset;
1432 } else
1433 pan_set(fb_helper, info->var.xoffset, info->var.yoffset);
1434
1435 return ret;
1436}
1437
1438static int pan_display_legacy(struct fb_var_screeninfo *var,
1439 struct fb_info *info)
1440{
1441 struct drm_fb_helper *fb_helper = info->par;
1442 struct drm_client_dev *client = &fb_helper->client;
1443 struct drm_mode_set *modeset;
1444 int ret = 0;
1445
1446 mutex_lock(&client->modeset_mutex);
1447 drm_modeset_lock_all(fb_helper->dev);
1448 drm_client_for_each_modeset(modeset, client) {
1449 modeset->x = var->xoffset;
1450 modeset->y = var->yoffset;
1451
1452 if (modeset->num_connectors) {
1453 ret = drm_mode_set_config_internal(modeset);
1454 if (!ret) {
1455 info->var.xoffset = var->xoffset;
1456 info->var.yoffset = var->yoffset;
1457 }
1458 }
1459 }
1460 drm_modeset_unlock_all(fb_helper->dev);
1461 mutex_unlock(&client->modeset_mutex);
1462
1463 return ret;
1464}
1465
1466/**
1467 * drm_fb_helper_pan_display - implementation for &fb_ops.fb_pan_display
1468 * @var: updated screen information
1469 * @info: fbdev registered by the helper
1470 */
1471int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
1472 struct fb_info *info)
1473{
1474 struct drm_fb_helper *fb_helper = info->par;
1475 struct drm_device *dev = fb_helper->dev;
1476 int ret;
1477
1478 if (oops_in_progress)
1479 return -EBUSY;
1480
1481 mutex_lock(&fb_helper->lock);
1482 if (!drm_master_internal_acquire(dev)) {
1483 ret = -EBUSY;
1484 goto unlock;
1485 }
1486
1487 if (drm_drv_uses_atomic_modeset(dev))
1488 ret = pan_display_atomic(var, info);
1489 else
1490 ret = pan_display_legacy(var, info);
1491
1492 drm_master_internal_release(dev);
1493unlock:
1494 mutex_unlock(&fb_helper->lock);
1495
1496 return ret;
1497}
1498EXPORT_SYMBOL(drm_fb_helper_pan_display);
1499
1500/*
1501 * Allocates the backing storage and sets up the fbdev info structure through
1502 * the ->fb_probe callback.
1503 */
1504static int drm_fb_helper_single_fb_probe(struct drm_fb_helper *fb_helper,
1505 int preferred_bpp)
1506{
1507 struct drm_client_dev *client = &fb_helper->client;
1508 struct drm_device *dev = fb_helper->dev;
1509 struct drm_mode_config *config = &dev->mode_config;
1510 int ret = 0;
1511 int crtc_count = 0;
1512 struct drm_connector_list_iter conn_iter;
1513 struct drm_fb_helper_surface_size sizes;
1514 struct drm_connector *connector;
1515 struct drm_mode_set *mode_set;
1516 int best_depth = 0;
1517
1518 memset(&sizes, 0, sizeof(struct drm_fb_helper_surface_size));
1519 sizes.surface_depth = 24;
1520 sizes.surface_bpp = 32;
1521 sizes.fb_width = (u32)-1;
1522 sizes.fb_height = (u32)-1;
1523
1524 /*
1525 * If driver picks 8 or 16 by default use that for both depth/bpp
1526 * to begin with
1527 */
1528 if (preferred_bpp != sizes.surface_bpp)
1529 sizes.surface_depth = sizes.surface_bpp = preferred_bpp;
1530
1531 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1532 drm_client_for_each_connector_iter(connector, &conn_iter) {
1533 struct drm_cmdline_mode *cmdline_mode;
1534
1535 cmdline_mode = &connector->cmdline_mode;
1536
1537 if (cmdline_mode->bpp_specified) {
1538 switch (cmdline_mode->bpp) {
1539 case 8:
1540 sizes.surface_depth = sizes.surface_bpp = 8;
1541 break;
1542 case 15:
1543 sizes.surface_depth = 15;
1544 sizes.surface_bpp = 16;
1545 break;
1546 case 16:
1547 sizes.surface_depth = sizes.surface_bpp = 16;
1548 break;
1549 case 24:
1550 sizes.surface_depth = sizes.surface_bpp = 24;
1551 break;
1552 case 32:
1553 sizes.surface_depth = 24;
1554 sizes.surface_bpp = 32;
1555 break;
1556 }
1557 break;
1558 }
1559 }
1560 drm_connector_list_iter_end(&conn_iter);
1561
1562 /*
1563 * If we run into a situation where, for example, the primary plane
1564 * supports RGBA5551 (16 bpp, depth 15) but not RGB565 (16 bpp, depth
1565 * 16) we need to scale down the depth of the sizes we request.
1566 */
1567 mutex_lock(&client->modeset_mutex);
1568 drm_client_for_each_modeset(mode_set, client) {
1569 struct drm_crtc *crtc = mode_set->crtc;
1570 struct drm_plane *plane = crtc->primary;
1571 int j;
1572
1573 drm_dbg_kms(dev, "test CRTC %u primary plane\n", drm_crtc_index(crtc));
1574
1575 for (j = 0; j < plane->format_count; j++) {
1576 const struct drm_format_info *fmt;
1577
1578 fmt = drm_format_info(plane->format_types[j]);
1579
1580 /*
1581 * Do not consider YUV or other complicated formats
1582 * for framebuffers. This means only legacy formats
1583 * are supported (fmt->depth is a legacy field) but
1584 * the framebuffer emulation can only deal with such
1585 * formats, specifically RGB/BGA formats.
1586 */
1587 if (fmt->depth == 0)
1588 continue;
1589
1590 /* We found a perfect fit, great */
1591 if (fmt->depth == sizes.surface_depth) {
1592 best_depth = fmt->depth;
1593 break;
1594 }
1595
1596 /* Skip depths above what we're looking for */
1597 if (fmt->depth > sizes.surface_depth)
1598 continue;
1599
1600 /* Best depth found so far */
1601 if (fmt->depth > best_depth)
1602 best_depth = fmt->depth;
1603 }
1604 }
1605 if (sizes.surface_depth != best_depth && best_depth) {
1606 drm_info(dev, "requested bpp %d, scaled depth down to %d",
1607 sizes.surface_bpp, best_depth);
1608 sizes.surface_depth = best_depth;
1609 }
1610
1611 /* first up get a count of crtcs now in use and new min/maxes width/heights */
1612 crtc_count = 0;
1613 drm_client_for_each_modeset(mode_set, client) {
1614 struct drm_display_mode *desired_mode;
1615 int x, y, j;
1616 /* in case of tile group, are we the last tile vert or horiz?
1617 * If no tile group you are always the last one both vertically
1618 * and horizontally
1619 */
1620 bool lastv = true, lasth = true;
1621
1622 desired_mode = mode_set->mode;
1623
1624 if (!desired_mode)
1625 continue;
1626
1627 crtc_count++;
1628
1629 x = mode_set->x;
1630 y = mode_set->y;
1631
1632 sizes.surface_width = max_t(u32, desired_mode->hdisplay + x, sizes.surface_width);
1633 sizes.surface_height = max_t(u32, desired_mode->vdisplay + y, sizes.surface_height);
1634
1635 for (j = 0; j < mode_set->num_connectors; j++) {
1636 struct drm_connector *connector = mode_set->connectors[j];
1637
1638 if (connector->has_tile &&
1639 desired_mode->hdisplay == connector->tile_h_size &&
1640 desired_mode->vdisplay == connector->tile_v_size) {
1641 lasth = (connector->tile_h_loc == (connector->num_h_tile - 1));
1642 lastv = (connector->tile_v_loc == (connector->num_v_tile - 1));
1643 /* cloning to multiple tiles is just crazy-talk, so: */
1644 break;
1645 }
1646 }
1647
1648 if (lasth)
1649 sizes.fb_width = min_t(u32, desired_mode->hdisplay + x, sizes.fb_width);
1650 if (lastv)
1651 sizes.fb_height = min_t(u32, desired_mode->vdisplay + y, sizes.fb_height);
1652 }
1653 mutex_unlock(&client->modeset_mutex);
1654
1655 if (crtc_count == 0 || sizes.fb_width == -1 || sizes.fb_height == -1) {
1656 drm_info(dev, "Cannot find any crtc or sizes\n");
1657
1658 /* First time: disable all crtc's.. */
1659 if (!fb_helper->deferred_setup)
1660 drm_client_modeset_commit(client);
1661 return -EAGAIN;
1662 }
1663
1664 /* Handle our overallocation */
1665 sizes.surface_height *= drm_fbdev_overalloc;
1666 sizes.surface_height /= 100;
1667 if (sizes.surface_height > config->max_height) {
1668 drm_dbg_kms(dev, "Fbdev over-allocation too large; clamping height to %d\n",
1669 config->max_height);
1670 sizes.surface_height = config->max_height;
1671 }
1672
1673 /* push down into drivers */
1674 ret = (*fb_helper->funcs->fb_probe)(fb_helper, &sizes);
1675 if (ret < 0)
1676 return ret;
1677
1678 strcpy(fb_helper->fb->comm, "[fbcon]");
1679 return 0;
1680}
1681
1682static void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
1683 uint32_t depth)
1684{
1685 info->fix.type = FB_TYPE_PACKED_PIXELS;
1686 info->fix.visual = depth == 8 ? FB_VISUAL_PSEUDOCOLOR :
1687 FB_VISUAL_TRUECOLOR;
1688 info->fix.mmio_start = 0;
1689 info->fix.mmio_len = 0;
1690 info->fix.type_aux = 0;
1691 info->fix.xpanstep = 1; /* doing it in hw */
1692 info->fix.ypanstep = 1; /* doing it in hw */
1693 info->fix.ywrapstep = 0;
1694 info->fix.accel = FB_ACCEL_NONE;
1695
1696 info->fix.line_length = pitch;
1697}
1698
1699static void drm_fb_helper_fill_var(struct fb_info *info,
1700 struct drm_fb_helper *fb_helper,
1701 uint32_t fb_width, uint32_t fb_height)
1702{
1703 struct drm_framebuffer *fb = fb_helper->fb;
1704
1705 WARN_ON((drm_format_info_block_width(fb->format, 0) > 1) ||
1706 (drm_format_info_block_height(fb->format, 0) > 1));
1707 info->pseudo_palette = fb_helper->pseudo_palette;
1708 info->var.xres_virtual = fb->width;
1709 info->var.yres_virtual = fb->height;
1710 info->var.bits_per_pixel = fb->format->cpp[0] * 8;
1711 info->var.accel_flags = FB_ACCELF_TEXT;
1712 info->var.xoffset = 0;
1713 info->var.yoffset = 0;
1714 info->var.activate = FB_ACTIVATE_NOW;
1715
1716 drm_fb_helper_fill_pixel_fmt(&info->var, fb->format->depth);
1717
1718 info->var.xres = fb_width;
1719 info->var.yres = fb_height;
1720}
1721
1722/**
1723 * drm_fb_helper_fill_info - initializes fbdev information
1724 * @info: fbdev instance to set up
1725 * @fb_helper: fb helper instance to use as template
1726 * @sizes: describes fbdev size and scanout surface size
1727 *
1728 * Sets up the variable and fixed fbdev metainformation from the given fb helper
1729 * instance and the drm framebuffer allocated in &drm_fb_helper.fb.
1730 *
1731 * Drivers should call this (or their equivalent setup code) from their
1732 * &drm_fb_helper_funcs.fb_probe callback after having allocated the fbdev
1733 * backing storage framebuffer.
1734 */
1735void drm_fb_helper_fill_info(struct fb_info *info,
1736 struct drm_fb_helper *fb_helper,
1737 struct drm_fb_helper_surface_size *sizes)
1738{
1739 struct drm_framebuffer *fb = fb_helper->fb;
1740
1741 drm_fb_helper_fill_fix(info, fb->pitches[0], fb->format->depth);
1742 drm_fb_helper_fill_var(info, fb_helper,
1743 sizes->fb_width, sizes->fb_height);
1744
1745 info->par = fb_helper;
1746 snprintf(info->fix.id, sizeof(info->fix.id), "%s",
1747 fb_helper->dev->driver->name);
1748
1749}
1750EXPORT_SYMBOL(drm_fb_helper_fill_info);
1751
1752/*
1753 * This is a continuation of drm_setup_crtcs() that sets up anything related
1754 * to the framebuffer. During initialization, drm_setup_crtcs() is called before
1755 * the framebuffer has been allocated (fb_helper->fb and fb_helper->fbdev).
1756 * So, any setup that touches those fields needs to be done here instead of in
1757 * drm_setup_crtcs().
1758 */
1759static void drm_setup_crtcs_fb(struct drm_fb_helper *fb_helper)
1760{
1761 struct drm_client_dev *client = &fb_helper->client;
1762 struct drm_connector_list_iter conn_iter;
1763 struct fb_info *info = fb_helper->fbdev;
1764 unsigned int rotation, sw_rotations = 0;
1765 struct drm_connector *connector;
1766 struct drm_mode_set *modeset;
1767
1768 mutex_lock(&client->modeset_mutex);
1769 drm_client_for_each_modeset(modeset, client) {
1770 if (!modeset->num_connectors)
1771 continue;
1772
1773 modeset->fb = fb_helper->fb;
1774
1775 if (drm_client_rotation(modeset, &rotation))
1776 /* Rotating in hardware, fbcon should not rotate */
1777 sw_rotations |= DRM_MODE_ROTATE_0;
1778 else
1779 sw_rotations |= rotation;
1780 }
1781 mutex_unlock(&client->modeset_mutex);
1782
1783 drm_connector_list_iter_begin(fb_helper->dev, &conn_iter);
1784 drm_client_for_each_connector_iter(connector, &conn_iter) {
1785
1786 /* use first connected connector for the physical dimensions */
1787 if (connector->status == connector_status_connected) {
1788 info->var.width = connector->display_info.width_mm;
1789 info->var.height = connector->display_info.height_mm;
1790 break;
1791 }
1792 }
1793 drm_connector_list_iter_end(&conn_iter);
1794
1795 switch (sw_rotations) {
1796 case DRM_MODE_ROTATE_0:
1797 info->fbcon_rotate_hint = FB_ROTATE_UR;
1798 break;
1799 case DRM_MODE_ROTATE_90:
1800 info->fbcon_rotate_hint = FB_ROTATE_CCW;
1801 break;
1802 case DRM_MODE_ROTATE_180:
1803 info->fbcon_rotate_hint = FB_ROTATE_UD;
1804 break;
1805 case DRM_MODE_ROTATE_270:
1806 info->fbcon_rotate_hint = FB_ROTATE_CW;
1807 break;
1808 default:
1809 /*
1810 * Multiple bits are set / multiple rotations requested
1811 * fbcon cannot handle separate rotation settings per
1812 * output, so fallback to unrotated.
1813 */
1814 info->fbcon_rotate_hint = FB_ROTATE_UR;
1815 }
1816}
1817
1818/* Note: Drops fb_helper->lock before returning. */
1819static int
1820__drm_fb_helper_initial_config_and_unlock(struct drm_fb_helper *fb_helper,
1821 int bpp_sel)
1822{
1823 struct drm_device *dev = fb_helper->dev;
1824 struct fb_info *info;
1825 unsigned int width, height;
1826 int ret;
1827
1828 width = dev->mode_config.max_width;
1829 height = dev->mode_config.max_height;
1830
1831 drm_client_modeset_probe(&fb_helper->client, width, height);
1832 ret = drm_fb_helper_single_fb_probe(fb_helper, bpp_sel);
1833 if (ret < 0) {
1834 if (ret == -EAGAIN) {
1835 fb_helper->preferred_bpp = bpp_sel;
1836 fb_helper->deferred_setup = true;
1837 ret = 0;
1838 }
1839 mutex_unlock(&fb_helper->lock);
1840
1841 return ret;
1842 }
1843 drm_setup_crtcs_fb(fb_helper);
1844
1845 fb_helper->deferred_setup = false;
1846
1847 info = fb_helper->fbdev;
1848 info->var.pixclock = 0;
1849 /* Shamelessly allow physical address leaking to userspace */
1850#if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
1851 if (!drm_leak_fbdev_smem)
1852#endif
1853 /* don't leak any physical addresses to userspace */
1854 info->flags |= FBINFO_HIDE_SMEM_START;
1855
1856 /* Need to drop locks to avoid recursive deadlock in
1857 * register_framebuffer. This is ok because the only thing left to do is
1858 * register the fbdev emulation instance in kernel_fb_helper_list. */
1859 mutex_unlock(&fb_helper->lock);
1860
1861 ret = register_framebuffer(info);
1862 if (ret < 0)
1863 return ret;
1864
1865 drm_info(dev, "fb%d: %s frame buffer device\n",
1866 info->node, info->fix.id);
1867
1868 mutex_lock(&kernel_fb_helper_lock);
1869 if (list_empty(&kernel_fb_helper_list))
1870 register_sysrq_key('v', &sysrq_drm_fb_helper_restore_op);
1871
1872 list_add(&fb_helper->kernel_fb_list, &kernel_fb_helper_list);
1873 mutex_unlock(&kernel_fb_helper_lock);
1874
1875 return 0;
1876}
1877
1878/**
1879 * drm_fb_helper_initial_config - setup a sane initial connector configuration
1880 * @fb_helper: fb_helper device struct
1881 * @bpp_sel: bpp value to use for the framebuffer configuration
1882 *
1883 * Scans the CRTCs and connectors and tries to put together an initial setup.
1884 * At the moment, this is a cloned configuration across all heads with
1885 * a new framebuffer object as the backing store.
1886 *
1887 * Note that this also registers the fbdev and so allows userspace to call into
1888 * the driver through the fbdev interfaces.
1889 *
1890 * This function will call down into the &drm_fb_helper_funcs.fb_probe callback
1891 * to let the driver allocate and initialize the fbdev info structure and the
1892 * drm framebuffer used to back the fbdev. drm_fb_helper_fill_info() is provided
1893 * as a helper to setup simple default values for the fbdev info structure.
1894 *
1895 * HANG DEBUGGING:
1896 *
1897 * When you have fbcon support built-in or already loaded, this function will do
1898 * a full modeset to setup the fbdev console. Due to locking misdesign in the
1899 * VT/fbdev subsystem that entire modeset sequence has to be done while holding
1900 * console_lock. Until console_unlock is called no dmesg lines will be sent out
1901 * to consoles, not even serial console. This means when your driver crashes,
1902 * you will see absolutely nothing else but a system stuck in this function,
1903 * with no further output. Any kind of printk() you place within your own driver
1904 * or in the drm core modeset code will also never show up.
1905 *
1906 * Standard debug practice is to run the fbcon setup without taking the
1907 * console_lock as a hack, to be able to see backtraces and crashes on the
1908 * serial line. This can be done by setting the fb.lockless_register_fb=1 kernel
1909 * cmdline option.
1910 *
1911 * The other option is to just disable fbdev emulation since very likely the
1912 * first modeset from userspace will crash in the same way, and is even easier
1913 * to debug. This can be done by setting the drm_kms_helper.fbdev_emulation=0
1914 * kernel cmdline option.
1915 *
1916 * RETURNS:
1917 * Zero if everything went ok, nonzero otherwise.
1918 */
1919int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel)
1920{
1921 int ret;
1922
1923 if (!drm_fbdev_emulation)
1924 return 0;
1925
1926 mutex_lock(&fb_helper->lock);
1927 ret = __drm_fb_helper_initial_config_and_unlock(fb_helper, bpp_sel);
1928
1929 return ret;
1930}
1931EXPORT_SYMBOL(drm_fb_helper_initial_config);
1932
1933/**
1934 * drm_fb_helper_hotplug_event - respond to a hotplug notification by
1935 * probing all the outputs attached to the fb
1936 * @fb_helper: driver-allocated fbdev helper, can be NULL
1937 *
1938 * Scan the connectors attached to the fb_helper and try to put together a
1939 * setup after notification of a change in output configuration.
1940 *
1941 * Called at runtime, takes the mode config locks to be able to check/change the
1942 * modeset configuration. Must be run from process context (which usually means
1943 * either the output polling work or a work item launched from the driver's
1944 * hotplug interrupt).
1945 *
1946 * Note that drivers may call this even before calling
1947 * drm_fb_helper_initial_config but only after drm_fb_helper_init. This allows
1948 * for a race-free fbcon setup and will make sure that the fbdev emulation will
1949 * not miss any hotplug events.
1950 *
1951 * RETURNS:
1952 * 0 on success and a non-zero error code otherwise.
1953 */
1954int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
1955{
1956 int err = 0;
1957
1958 if (!drm_fbdev_emulation || !fb_helper)
1959 return 0;
1960
1961 mutex_lock(&fb_helper->lock);
1962 if (fb_helper->deferred_setup) {
1963 err = __drm_fb_helper_initial_config_and_unlock(fb_helper,
1964 fb_helper->preferred_bpp);
1965 return err;
1966 }
1967
1968 if (!fb_helper->fb || !drm_master_internal_acquire(fb_helper->dev)) {
1969 fb_helper->delayed_hotplug = true;
1970 mutex_unlock(&fb_helper->lock);
1971 return err;
1972 }
1973
1974 drm_master_internal_release(fb_helper->dev);
1975
1976 drm_dbg_kms(fb_helper->dev, "\n");
1977
1978 drm_client_modeset_probe(&fb_helper->client, fb_helper->fb->width, fb_helper->fb->height);
1979 drm_setup_crtcs_fb(fb_helper);
1980 mutex_unlock(&fb_helper->lock);
1981
1982 drm_fb_helper_set_par(fb_helper->fbdev);
1983
1984 return 0;
1985}
1986EXPORT_SYMBOL(drm_fb_helper_hotplug_event);
1987
1988/**
1989 * drm_fb_helper_lastclose - DRM driver lastclose helper for fbdev emulation
1990 * @dev: DRM device
1991 *
1992 * This function can be used as the &drm_driver->lastclose callback for drivers
1993 * that only need to call drm_fb_helper_restore_fbdev_mode_unlocked().
1994 */
1995void drm_fb_helper_lastclose(struct drm_device *dev)
1996{
1997 drm_fb_helper_restore_fbdev_mode_unlocked(dev->fb_helper);
1998}
1999EXPORT_SYMBOL(drm_fb_helper_lastclose);
2000
2001/**
2002 * drm_fb_helper_output_poll_changed - DRM mode config \.output_poll_changed
2003 * helper for fbdev emulation
2004 * @dev: DRM device
2005 *
2006 * This function can be used as the
2007 * &drm_mode_config_funcs.output_poll_changed callback for drivers that only
2008 * need to call drm_fb_helper_hotplug_event().
2009 */
2010void drm_fb_helper_output_poll_changed(struct drm_device *dev)
2011{
2012 drm_fb_helper_hotplug_event(dev->fb_helper);
2013}
2014EXPORT_SYMBOL(drm_fb_helper_output_poll_changed);
2015
2016/* @user: 1=userspace, 0=fbcon */
2017static int drm_fbdev_fb_open(struct fb_info *info, int user)
2018{
2019 struct drm_fb_helper *fb_helper = info->par;
2020
2021 /* No need to take a ref for fbcon because it unbinds on unregister */
2022 if (user && !try_module_get(fb_helper->dev->driver->fops->owner))
2023 return -ENODEV;
2024
2025 return 0;
2026}
2027
2028static int drm_fbdev_fb_release(struct fb_info *info, int user)
2029{
2030 struct drm_fb_helper *fb_helper = info->par;
2031
2032 if (user)
2033 module_put(fb_helper->dev->driver->fops->owner);
2034
2035 return 0;
2036}
2037
2038static void drm_fbdev_cleanup(struct drm_fb_helper *fb_helper)
2039{
2040 struct fb_info *fbi = fb_helper->fbdev;
2041 void *shadow = NULL;
2042
2043 if (!fb_helper->dev)
2044 return;
2045
2046 if (fbi) {
2047 if (fbi->fbdefio)
2048 fb_deferred_io_cleanup(fbi);
2049 if (drm_fbdev_use_shadow_fb(fb_helper))
2050 shadow = fbi->screen_buffer;
2051 }
2052
2053 drm_fb_helper_fini(fb_helper);
2054
2055 if (shadow)
2056 vfree(shadow);
2057 else if (fb_helper->buffer)
2058 drm_client_buffer_vunmap(fb_helper->buffer);
2059
2060 drm_client_framebuffer_delete(fb_helper->buffer);
2061}
2062
2063static void drm_fbdev_release(struct drm_fb_helper *fb_helper)
2064{
2065 drm_fbdev_cleanup(fb_helper);
2066 drm_client_release(&fb_helper->client);
2067 kfree(fb_helper);
2068}
2069
2070/*
2071 * fb_ops.fb_destroy is called by the last put_fb_info() call at the end of
2072 * unregister_framebuffer() or fb_release().
2073 */
2074static void drm_fbdev_fb_destroy(struct fb_info *info)
2075{
2076 drm_fbdev_release(info->par);
2077}
2078
2079static int drm_fbdev_fb_mmap(struct fb_info *info, struct vm_area_struct *vma)
2080{
2081 struct drm_fb_helper *fb_helper = info->par;
2082
2083 if (fb_helper->dev->driver->gem_prime_mmap)
2084 return fb_helper->dev->driver->gem_prime_mmap(fb_helper->buffer->gem, vma);
2085 else
2086 return -ENODEV;
2087}
2088
2089static bool drm_fbdev_use_iomem(struct fb_info *info)
2090{
2091 struct drm_fb_helper *fb_helper = info->par;
2092 struct drm_client_buffer *buffer = fb_helper->buffer;
2093
2094 return !drm_fbdev_use_shadow_fb(fb_helper) && buffer->map.is_iomem;
2095}
2096
2097static ssize_t fb_read_screen_base(struct fb_info *info, char __user *buf, size_t count,
2098 loff_t pos)
2099{
2100 const char __iomem *src = info->screen_base + pos;
2101 size_t alloc_size = min_t(size_t, count, PAGE_SIZE);
2102 ssize_t ret = 0;
2103 int err = 0;
2104 char *tmp;
2105
2106 tmp = kmalloc(alloc_size, GFP_KERNEL);
2107 if (!tmp)
2108 return -ENOMEM;
2109
2110 while (count) {
2111 size_t c = min_t(size_t, count, alloc_size);
2112
2113 memcpy_fromio(tmp, src, c);
2114 if (copy_to_user(buf, tmp, c)) {
2115 err = -EFAULT;
2116 break;
2117 }
2118
2119 src += c;
2120 buf += c;
2121 ret += c;
2122 count -= c;
2123 }
2124
2125 kfree(tmp);
2126
2127 return ret ? ret : err;
2128}
2129
2130static ssize_t fb_read_screen_buffer(struct fb_info *info, char __user *buf, size_t count,
2131 loff_t pos)
2132{
2133 const char *src = info->screen_buffer + pos;
2134
2135 if (copy_to_user(buf, src, count))
2136 return -EFAULT;
2137
2138 return count;
2139}
2140
2141static ssize_t drm_fbdev_fb_read(struct fb_info *info, char __user *buf,
2142 size_t count, loff_t *ppos)
2143{
2144 loff_t pos = *ppos;
2145 size_t total_size;
2146 ssize_t ret;
2147
2148 if (info->screen_size)
2149 total_size = info->screen_size;
2150 else
2151 total_size = info->fix.smem_len;
2152
2153 if (pos >= total_size)
2154 return 0;
2155 if (count >= total_size)
2156 count = total_size;
2157 if (total_size - count < pos)
2158 count = total_size - pos;
2159
2160 if (drm_fbdev_use_iomem(info))
2161 ret = fb_read_screen_base(info, buf, count, pos);
2162 else
2163 ret = fb_read_screen_buffer(info, buf, count, pos);
2164
2165 if (ret > 0)
2166 *ppos += ret;
2167
2168 return ret;
2169}
2170
2171static ssize_t fb_write_screen_base(struct fb_info *info, const char __user *buf, size_t count,
2172 loff_t pos)
2173{
2174 char __iomem *dst = info->screen_base + pos;
2175 size_t alloc_size = min_t(size_t, count, PAGE_SIZE);
2176 ssize_t ret = 0;
2177 int err = 0;
2178 u8 *tmp;
2179
2180 tmp = kmalloc(alloc_size, GFP_KERNEL);
2181 if (!tmp)
2182 return -ENOMEM;
2183
2184 while (count) {
2185 size_t c = min_t(size_t, count, alloc_size);
2186
2187 if (copy_from_user(tmp, buf, c)) {
2188 err = -EFAULT;
2189 break;
2190 }
2191 memcpy_toio(dst, tmp, c);
2192
2193 dst += c;
2194 buf += c;
2195 ret += c;
2196 count -= c;
2197 }
2198
2199 kfree(tmp);
2200
2201 return ret ? ret : err;
2202}
2203
2204static ssize_t fb_write_screen_buffer(struct fb_info *info, const char __user *buf, size_t count,
2205 loff_t pos)
2206{
2207 char *dst = info->screen_buffer + pos;
2208
2209 if (copy_from_user(dst, buf, count))
2210 return -EFAULT;
2211
2212 return count;
2213}
2214
2215static ssize_t drm_fbdev_fb_write(struct fb_info *info, const char __user *buf,
2216 size_t count, loff_t *ppos)
2217{
2218 loff_t pos = *ppos;
2219 size_t total_size;
2220 ssize_t ret;
2221 int err = 0;
2222
2223 if (info->screen_size)
2224 total_size = info->screen_size;
2225 else
2226 total_size = info->fix.smem_len;
2227
2228 if (pos > total_size)
2229 return -EFBIG;
2230 if (count > total_size) {
2231 err = -EFBIG;
2232 count = total_size;
2233 }
2234 if (total_size - count < pos) {
2235 if (!err)
2236 err = -ENOSPC;
2237 count = total_size - pos;
2238 }
2239
2240 /*
2241 * Copy to framebuffer even if we already logged an error. Emulates
2242 * the behavior of the original fbdev implementation.
2243 */
2244 if (drm_fbdev_use_iomem(info))
2245 ret = fb_write_screen_base(info, buf, count, pos);
2246 else
2247 ret = fb_write_screen_buffer(info, buf, count, pos);
2248
2249 if (ret > 0)
2250 *ppos += ret;
2251
2252 if (ret > 0)
2253 drm_fb_helper_damage(info, 0, 0, info->var.xres_virtual, info->var.yres_virtual);
2254
2255 return ret ? ret : err;
2256}
2257
2258static void drm_fbdev_fb_fillrect(struct fb_info *info,
2259 const struct fb_fillrect *rect)
2260{
2261 if (drm_fbdev_use_iomem(info))
2262 drm_fb_helper_cfb_fillrect(info, rect);
2263 else
2264 drm_fb_helper_sys_fillrect(info, rect);
2265}
2266
2267static void drm_fbdev_fb_copyarea(struct fb_info *info,
2268 const struct fb_copyarea *area)
2269{
2270 if (drm_fbdev_use_iomem(info))
2271 drm_fb_helper_cfb_copyarea(info, area);
2272 else
2273 drm_fb_helper_sys_copyarea(info, area);
2274}
2275
2276static void drm_fbdev_fb_imageblit(struct fb_info *info,
2277 const struct fb_image *image)
2278{
2279 if (drm_fbdev_use_iomem(info))
2280 drm_fb_helper_cfb_imageblit(info, image);
2281 else
2282 drm_fb_helper_sys_imageblit(info, image);
2283}
2284
2285static const struct fb_ops drm_fbdev_fb_ops = {
2286 .owner = THIS_MODULE,
2287 DRM_FB_HELPER_DEFAULT_OPS,
2288 .fb_open = drm_fbdev_fb_open,
2289 .fb_release = drm_fbdev_fb_release,
2290 .fb_destroy = drm_fbdev_fb_destroy,
2291 .fb_mmap = drm_fbdev_fb_mmap,
2292 .fb_read = drm_fbdev_fb_read,
2293 .fb_write = drm_fbdev_fb_write,
2294 .fb_fillrect = drm_fbdev_fb_fillrect,
2295 .fb_copyarea = drm_fbdev_fb_copyarea,
2296 .fb_imageblit = drm_fbdev_fb_imageblit,
2297};
2298
2299static struct fb_deferred_io drm_fbdev_defio = {
2300 .delay = HZ / 20,
2301 .deferred_io = drm_fb_helper_deferred_io,
2302};
2303
2304/*
2305 * This function uses the client API to create a framebuffer backed by a dumb buffer.
2306 *
2307 * The _sys_ versions are used for &fb_ops.fb_read, fb_write, fb_fillrect,
2308 * fb_copyarea, fb_imageblit.
2309 */
2310static int drm_fb_helper_generic_probe(struct drm_fb_helper *fb_helper,
2311 struct drm_fb_helper_surface_size *sizes)
2312{
2313 struct drm_client_dev *client = &fb_helper->client;
2314 struct drm_device *dev = fb_helper->dev;
2315 struct drm_client_buffer *buffer;
2316 struct drm_framebuffer *fb;
2317 struct fb_info *fbi;
2318 u32 format;
2319 struct dma_buf_map map;
2320 int ret;
2321
2322 drm_dbg_kms(dev, "surface width(%d), height(%d) and bpp(%d)\n",
2323 sizes->surface_width, sizes->surface_height,
2324 sizes->surface_bpp);
2325
2326 format = drm_mode_legacy_fb_format(sizes->surface_bpp, sizes->surface_depth);
2327 buffer = drm_client_framebuffer_create(client, sizes->surface_width,
2328 sizes->surface_height, format);
2329 if (IS_ERR(buffer))
2330 return PTR_ERR(buffer);
2331
2332 fb_helper->buffer = buffer;
2333 fb_helper->fb = buffer->fb;
2334 fb = buffer->fb;
2335
2336 fbi = drm_fb_helper_alloc_fbi(fb_helper);
2337 if (IS_ERR(fbi))
2338 return PTR_ERR(fbi);
2339
2340 fbi->fbops = &drm_fbdev_fb_ops;
2341 fbi->screen_size = fb->height * fb->pitches[0];
2342 fbi->fix.smem_len = fbi->screen_size;
2343
2344 drm_fb_helper_fill_info(fbi, fb_helper, sizes);
2345
2346 if (drm_fbdev_use_shadow_fb(fb_helper)) {
2347 fbi->screen_buffer = vzalloc(fbi->screen_size);
2348 if (!fbi->screen_buffer)
2349 return -ENOMEM;
2350
2351 fbi->fbdefio = &drm_fbdev_defio;
2352
2353 fb_deferred_io_init(fbi);
2354 } else {
2355 /* buffer is mapped for HW framebuffer */
2356 ret = drm_client_buffer_vmap(fb_helper->buffer, &map);
2357 if (ret)
2358 return ret;
2359 if (map.is_iomem)
2360 fbi->screen_base = map.vaddr_iomem;
2361 else
2362 fbi->screen_buffer = map.vaddr;
2363
2364 /*
2365 * Shamelessly leak the physical address to user-space. As
2366 * page_to_phys() is undefined for I/O memory, warn in this
2367 * case.
2368 */
2369#if IS_ENABLED(CONFIG_DRM_FBDEV_LEAK_PHYS_SMEM)
2370 if (drm_leak_fbdev_smem && fbi->fix.smem_start == 0 &&
2371 !drm_WARN_ON_ONCE(dev, map.is_iomem))
2372 fbi->fix.smem_start =
2373 page_to_phys(virt_to_page(fbi->screen_buffer));
2374#endif
2375 }
2376
2377 return 0;
2378}
2379
2380static const struct drm_fb_helper_funcs drm_fb_helper_generic_funcs = {
2381 .fb_probe = drm_fb_helper_generic_probe,
2382};
2383
2384static void drm_fbdev_client_unregister(struct drm_client_dev *client)
2385{
2386 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2387
2388 if (fb_helper->fbdev)
2389 /* drm_fbdev_fb_destroy() takes care of cleanup */
2390 drm_fb_helper_unregister_fbi(fb_helper);
2391 else
2392 drm_fbdev_release(fb_helper);
2393}
2394
2395static int drm_fbdev_client_restore(struct drm_client_dev *client)
2396{
2397 drm_fb_helper_lastclose(client->dev);
2398
2399 return 0;
2400}
2401
2402static int drm_fbdev_client_hotplug(struct drm_client_dev *client)
2403{
2404 struct drm_fb_helper *fb_helper = drm_fb_helper_from_client(client);
2405 struct drm_device *dev = client->dev;
2406 int ret;
2407
2408 /* Setup is not retried if it has failed */
2409 if (!fb_helper->dev && fb_helper->funcs)
2410 return 0;
2411
2412 if (dev->fb_helper)
2413 return drm_fb_helper_hotplug_event(dev->fb_helper);
2414
2415 if (!dev->mode_config.num_connector) {
2416 drm_dbg_kms(dev, "No connectors found, will not create framebuffer!\n");
2417 return 0;
2418 }
2419
2420 drm_fb_helper_prepare(dev, fb_helper, &drm_fb_helper_generic_funcs);
2421
2422 ret = drm_fb_helper_init(dev, fb_helper);
2423 if (ret)
2424 goto err;
2425
2426 if (!drm_drv_uses_atomic_modeset(dev))
2427 drm_helper_disable_unused_functions(dev);
2428
2429 ret = drm_fb_helper_initial_config(fb_helper, fb_helper->preferred_bpp);
2430 if (ret)
2431 goto err_cleanup;
2432
2433 return 0;
2434
2435err_cleanup:
2436 drm_fbdev_cleanup(fb_helper);
2437err:
2438 fb_helper->dev = NULL;
2439 fb_helper->fbdev = NULL;
2440
2441 drm_err(dev, "fbdev: Failed to setup generic emulation (ret=%d)\n", ret);
2442
2443 return ret;
2444}
2445
2446static const struct drm_client_funcs drm_fbdev_client_funcs = {
2447 .owner = THIS_MODULE,
2448 .unregister = drm_fbdev_client_unregister,
2449 .restore = drm_fbdev_client_restore,
2450 .hotplug = drm_fbdev_client_hotplug,
2451};
2452
2453/**
2454 * drm_fbdev_generic_setup() - Setup generic fbdev emulation
2455 * @dev: DRM device
2456 * @preferred_bpp: Preferred bits per pixel for the device.
2457 * @dev->mode_config.preferred_depth is used if this is zero.
2458 *
2459 * This function sets up generic fbdev emulation for drivers that supports
2460 * dumb buffers with a virtual address and that can be mmap'ed.
2461 * drm_fbdev_generic_setup() shall be called after the DRM driver registered
2462 * the new DRM device with drm_dev_register().
2463 *
2464 * Restore, hotplug events and teardown are all taken care of. Drivers that do
2465 * suspend/resume need to call drm_fb_helper_set_suspend_unlocked() themselves.
2466 * Simple drivers might use drm_mode_config_helper_suspend().
2467 *
2468 * Drivers that set the dirty callback on their framebuffer will get a shadow
2469 * fbdev buffer that is blitted onto the real buffer. This is done in order to
2470 * make deferred I/O work with all kinds of buffers. A shadow buffer can be
2471 * requested explicitly by setting struct drm_mode_config.prefer_shadow or
2472 * struct drm_mode_config.prefer_shadow_fbdev to true beforehand. This is
2473 * required to use generic fbdev emulation with SHMEM helpers.
2474 *
2475 * This function is safe to call even when there are no connectors present.
2476 * Setup will be retried on the next hotplug event.
2477 *
2478 * The fbdev is destroyed by drm_dev_unregister().
2479 */
2480void drm_fbdev_generic_setup(struct drm_device *dev,
2481 unsigned int preferred_bpp)
2482{
2483 struct drm_fb_helper *fb_helper;
2484 int ret;
2485
2486 drm_WARN(dev, !dev->registered, "Device has not been registered.\n");
2487 drm_WARN(dev, dev->fb_helper, "fb_helper is already set!\n");
2488
2489 if (!drm_fbdev_emulation)
2490 return;
2491
2492 fb_helper = kzalloc(sizeof(*fb_helper), GFP_KERNEL);
2493 if (!fb_helper) {
2494 drm_err(dev, "Failed to allocate fb_helper\n");
2495 return;
2496 }
2497
2498 ret = drm_client_init(dev, &fb_helper->client, "fbdev", &drm_fbdev_client_funcs);
2499 if (ret) {
2500 kfree(fb_helper);
2501 drm_err(dev, "Failed to register client: %d\n", ret);
2502 return;
2503 }
2504
2505 /*
2506 * FIXME: This mixes up depth with bpp, which results in a glorious
2507 * mess, resulting in some drivers picking wrong fbdev defaults and
2508 * others wrong preferred_depth defaults.
2509 */
2510 if (!preferred_bpp)
2511 preferred_bpp = dev->mode_config.preferred_depth;
2512 if (!preferred_bpp)
2513 preferred_bpp = 32;
2514 fb_helper->preferred_bpp = preferred_bpp;
2515
2516 ret = drm_fbdev_client_hotplug(&fb_helper->client);
2517 if (ret)
2518 drm_dbg_kms(dev, "client hotplug ret=%d\n", ret);
2519
2520 drm_client_register(&fb_helper->client);
2521}
2522EXPORT_SYMBOL(drm_fbdev_generic_setup);