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