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