2 * Copyright © 2007 David Airlie
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
27 #include <linux/async.h>
28 #include <linux/console.h>
29 #include <linux/delay.h>
30 #include <linux/errno.h>
31 #include <linux/init.h>
32 #include <linux/kernel.h>
34 #include <linux/module.h>
35 #include <linux/string.h>
36 #include <linux/sysrq.h>
37 #include <linux/tty.h>
38 #include <linux/vga_switcheroo.h>
40 #include <drm/drm_crtc.h>
41 #include <drm/drm_fb_helper.h>
42 #include <drm/drm_fourcc.h>
44 #include "gem/i915_gem_lmem.h"
47 #include "intel_display_types.h"
49 #include "intel_fb_pin.h"
50 #include "intel_fbdev.h"
51 #include "intel_frontbuffer.h"
54 struct drm_fb_helper helper;
55 struct intel_framebuffer *fb;
57 unsigned long vma_flags;
58 async_cookie_t cookie;
61 /* Whether or not fbdev hpd processing is temporarily suspended */
62 bool hpd_suspended: 1;
63 /* Set when a hotplug was received while HPD processing was suspended */
66 /* Protects hpd_suspended */
67 struct mutex hpd_lock;
70 static struct intel_frontbuffer *to_frontbuffer(struct intel_fbdev *ifbdev)
72 return ifbdev->fb->frontbuffer;
75 static void intel_fbdev_invalidate(struct intel_fbdev *ifbdev)
77 intel_frontbuffer_invalidate(to_frontbuffer(ifbdev), ORIGIN_CPU);
80 static int intel_fbdev_set_par(struct fb_info *info)
82 struct drm_fb_helper *fb_helper = info->par;
83 struct intel_fbdev *ifbdev =
84 container_of(fb_helper, struct intel_fbdev, helper);
87 ret = drm_fb_helper_set_par(info);
89 intel_fbdev_invalidate(ifbdev);
94 static int intel_fbdev_blank(int blank, struct fb_info *info)
96 struct drm_fb_helper *fb_helper = info->par;
97 struct intel_fbdev *ifbdev =
98 container_of(fb_helper, struct intel_fbdev, helper);
101 ret = drm_fb_helper_blank(blank, info);
103 intel_fbdev_invalidate(ifbdev);
108 static int intel_fbdev_pan_display(struct fb_var_screeninfo *var,
109 struct fb_info *info)
111 struct drm_fb_helper *fb_helper = info->par;
112 struct intel_fbdev *ifbdev =
113 container_of(fb_helper, struct intel_fbdev, helper);
116 ret = drm_fb_helper_pan_display(var, info);
118 intel_fbdev_invalidate(ifbdev);
123 static const struct fb_ops intelfb_ops = {
124 .owner = THIS_MODULE,
125 DRM_FB_HELPER_DEFAULT_OPS,
126 .fb_set_par = intel_fbdev_set_par,
127 .fb_read = drm_fb_helper_cfb_read,
128 .fb_write = drm_fb_helper_cfb_write,
129 .fb_fillrect = drm_fb_helper_cfb_fillrect,
130 .fb_copyarea = drm_fb_helper_cfb_copyarea,
131 .fb_imageblit = drm_fb_helper_cfb_imageblit,
132 .fb_pan_display = intel_fbdev_pan_display,
133 .fb_blank = intel_fbdev_blank,
136 static int intelfb_alloc(struct drm_fb_helper *helper,
137 struct drm_fb_helper_surface_size *sizes)
139 struct intel_fbdev *ifbdev =
140 container_of(helper, struct intel_fbdev, helper);
141 struct drm_framebuffer *fb;
142 struct drm_device *dev = helper->dev;
143 struct drm_i915_private *dev_priv = to_i915(dev);
144 struct drm_mode_fb_cmd2 mode_cmd = {};
145 struct drm_i915_gem_object *obj;
148 /* we don't do packed 24bpp */
149 if (sizes->surface_bpp == 24)
150 sizes->surface_bpp = 32;
152 mode_cmd.width = sizes->surface_width;
153 mode_cmd.height = sizes->surface_height;
155 mode_cmd.pitches[0] = ALIGN(mode_cmd.width *
156 DIV_ROUND_UP(sizes->surface_bpp, 8), 64);
157 mode_cmd.pixel_format = drm_mode_legacy_fb_format(sizes->surface_bpp,
158 sizes->surface_depth);
160 size = mode_cmd.pitches[0] * mode_cmd.height;
161 size = PAGE_ALIGN(size);
163 obj = ERR_PTR(-ENODEV);
164 if (HAS_LMEM(dev_priv)) {
165 obj = i915_gem_object_create_lmem(dev_priv, size,
166 I915_BO_ALLOC_CONTIGUOUS);
169 * If the FB is too big, just don't use it since fbdev is not very
170 * important and we should probably use that space with FBC or other
173 if (size * 2 < dev_priv->stolen_usable_size)
174 obj = i915_gem_object_create_stolen(dev_priv, size);
176 obj = i915_gem_object_create_shmem(dev_priv, size);
180 drm_err(&dev_priv->drm, "failed to allocate framebuffer (%pe)\n", obj);
184 fb = intel_framebuffer_create(obj, &mode_cmd);
185 i915_gem_object_put(obj);
189 ifbdev->fb = to_intel_framebuffer(fb);
193 static int intelfb_create(struct drm_fb_helper *helper,
194 struct drm_fb_helper_surface_size *sizes)
196 struct intel_fbdev *ifbdev =
197 container_of(helper, struct intel_fbdev, helper);
198 struct intel_framebuffer *intel_fb = ifbdev->fb;
199 struct drm_device *dev = helper->dev;
200 struct drm_i915_private *dev_priv = to_i915(dev);
201 struct pci_dev *pdev = to_pci_dev(dev_priv->drm.dev);
202 struct i915_ggtt *ggtt = to_gt(dev_priv)->ggtt;
203 const struct i915_gtt_view view = {
204 .type = I915_GTT_VIEW_NORMAL,
206 intel_wakeref_t wakeref;
207 struct fb_info *info;
208 struct i915_vma *vma;
209 unsigned long flags = 0;
210 bool prealloc = false;
212 struct drm_i915_gem_object *obj;
215 mutex_lock(&ifbdev->hpd_lock);
216 ret = ifbdev->hpd_suspended ? -EAGAIN : 0;
217 mutex_unlock(&ifbdev->hpd_lock);
222 (sizes->fb_width > intel_fb->base.width ||
223 sizes->fb_height > intel_fb->base.height)) {
224 drm_dbg_kms(&dev_priv->drm,
225 "BIOS fb too small (%dx%d), we require (%dx%d),"
227 intel_fb->base.width, intel_fb->base.height,
228 sizes->fb_width, sizes->fb_height);
229 drm_framebuffer_put(&intel_fb->base);
230 intel_fb = ifbdev->fb = NULL;
232 if (!intel_fb || drm_WARN_ON(dev, !intel_fb_obj(&intel_fb->base))) {
233 drm_dbg_kms(&dev_priv->drm,
234 "no BIOS fb, allocating a new one\n");
235 ret = intelfb_alloc(helper, sizes);
238 intel_fb = ifbdev->fb;
240 drm_dbg_kms(&dev_priv->drm, "re-using BIOS fb\n");
242 sizes->fb_width = intel_fb->base.width;
243 sizes->fb_height = intel_fb->base.height;
246 wakeref = intel_runtime_pm_get(&dev_priv->runtime_pm);
248 /* Pin the GGTT vma for our access via info->screen_base.
249 * This also validates that any existing fb inherited from the
250 * BIOS is suitable for own access.
252 vma = intel_pin_and_fence_fb_obj(&ifbdev->fb->base, false,
253 &view, false, &flags);
259 info = drm_fb_helper_alloc_info(helper);
261 drm_err(&dev_priv->drm, "Failed to allocate fb_info (%pe)\n", info);
266 ifbdev->helper.fb = &ifbdev->fb->base;
268 info->fbops = &intelfb_ops;
270 /* setup aperture base/size for vesafb takeover */
271 obj = intel_fb_obj(&intel_fb->base);
272 if (i915_gem_object_is_lmem(obj)) {
273 struct intel_memory_region *mem = obj->mm.region;
275 info->apertures->ranges[0].base = mem->io_start;
276 info->apertures->ranges[0].size = mem->io_size;
278 /* Use fbdev's framebuffer from lmem for discrete */
279 info->fix.smem_start =
280 (unsigned long)(mem->io_start +
281 i915_gem_object_get_dma_address(obj, 0));
282 info->fix.smem_len = obj->base.size;
284 info->apertures->ranges[0].base = ggtt->gmadr.start;
285 info->apertures->ranges[0].size = ggtt->mappable_end;
287 /* Our framebuffer is the entirety of fbdev's system memory */
288 info->fix.smem_start =
289 (unsigned long)(ggtt->gmadr.start + vma->node.start);
290 info->fix.smem_len = vma->size;
293 vaddr = i915_vma_pin_iomap(vma);
295 drm_err(&dev_priv->drm,
296 "Failed to remap framebuffer into virtual memory (%pe)\n", vaddr);
297 ret = PTR_ERR(vaddr);
300 info->screen_base = vaddr;
301 info->screen_size = vma->size;
303 drm_fb_helper_fill_info(info, &ifbdev->helper, sizes);
305 /* If the object is shmemfs backed, it will have given us zeroed pages.
306 * If the object is stolen however, it will be full of whatever
307 * garbage was left in there.
309 if (!i915_gem_object_is_shmem(vma->obj) && !prealloc)
310 memset_io(info->screen_base, 0, info->screen_size);
312 /* Use default scratch pixmap (info->pixmap.flags = FB_PIXMAP_SYSTEM) */
314 drm_dbg_kms(&dev_priv->drm, "allocated %dx%d fb: 0x%08x\n",
315 ifbdev->fb->base.width, ifbdev->fb->base.height,
316 i915_ggtt_offset(vma));
318 ifbdev->vma_flags = flags;
320 intel_runtime_pm_put(&dev_priv->runtime_pm, wakeref);
321 vga_switcheroo_client_fb_set(pdev, info);
325 intel_unpin_fb_vma(vma, flags);
327 intel_runtime_pm_put(&dev_priv->runtime_pm, wakeref);
331 static const struct drm_fb_helper_funcs intel_fb_helper_funcs = {
332 .fb_probe = intelfb_create,
335 static void intel_fbdev_destroy(struct intel_fbdev *ifbdev)
337 /* We rely on the object-free to release the VMA pinning for
338 * the info->screen_base mmaping. Leaking the VMA is simpler than
339 * trying to rectify all the possible error paths leading here.
342 drm_fb_helper_fini(&ifbdev->helper);
345 intel_unpin_fb_vma(ifbdev->vma, ifbdev->vma_flags);
348 drm_framebuffer_remove(&ifbdev->fb->base);
354 * Build an intel_fbdev struct using a BIOS allocated framebuffer, if possible.
355 * The core display code will have read out the current plane configuration,
356 * so we use that to figure out if there's an object for us to use as the
357 * fb, and if so, we re-use it for the fbdev configuration.
359 * Note we only support a single fb shared across pipes for boot (mostly for
360 * fbcon), so we just find the biggest and use that.
362 static bool intel_fbdev_init_bios(struct drm_device *dev,
363 struct intel_fbdev *ifbdev)
365 struct drm_i915_private *i915 = to_i915(dev);
366 struct intel_framebuffer *fb = NULL;
367 struct intel_crtc *crtc;
368 unsigned int max_size = 0;
370 /* Find the largest fb */
371 for_each_intel_crtc(dev, crtc) {
372 struct intel_crtc_state *crtc_state =
373 to_intel_crtc_state(crtc->base.state);
374 struct intel_plane *plane =
375 to_intel_plane(crtc->base.primary);
376 struct intel_plane_state *plane_state =
377 to_intel_plane_state(plane->base.state);
378 struct drm_i915_gem_object *obj =
379 intel_fb_obj(plane_state->uapi.fb);
381 if (!crtc_state->uapi.active) {
382 drm_dbg_kms(&i915->drm,
383 "[CRTC:%d:%s] not active, skipping\n",
384 crtc->base.base.id, crtc->base.name);
389 drm_dbg_kms(&i915->drm,
390 "[PLANE:%d:%s] no fb, skipping\n",
391 plane->base.base.id, plane->base.name);
395 if (obj->base.size > max_size) {
396 drm_dbg_kms(&i915->drm,
397 "found possible fb from [PLANE:%d:%s]\n",
398 plane->base.base.id, plane->base.name);
399 fb = to_intel_framebuffer(plane_state->uapi.fb);
400 max_size = obj->base.size;
405 drm_dbg_kms(&i915->drm,
406 "no active fbs found, not using BIOS config\n");
410 /* Now make sure all the pipes will fit into it */
411 for_each_intel_crtc(dev, crtc) {
412 struct intel_crtc_state *crtc_state =
413 to_intel_crtc_state(crtc->base.state);
414 struct intel_plane *plane =
415 to_intel_plane(crtc->base.primary);
416 unsigned int cur_size;
418 if (!crtc_state->uapi.active) {
419 drm_dbg_kms(&i915->drm,
420 "[CRTC:%d:%s] not active, skipping\n",
421 crtc->base.base.id, crtc->base.name);
425 drm_dbg_kms(&i915->drm, "checking [PLANE:%d:%s] for BIOS fb\n",
426 plane->base.base.id, plane->base.name);
429 * See if the plane fb we found above will fit on this
430 * pipe. Note we need to use the selected fb's pitch and bpp
431 * rather than the current pipe's, since they differ.
433 cur_size = crtc_state->uapi.adjusted_mode.crtc_hdisplay;
434 cur_size = cur_size * fb->base.format->cpp[0];
435 if (fb->base.pitches[0] < cur_size) {
436 drm_dbg_kms(&i915->drm,
437 "fb not wide enough for [PLANE:%d:%s] (%d vs %d)\n",
438 plane->base.base.id, plane->base.name,
439 cur_size, fb->base.pitches[0]);
444 cur_size = crtc_state->uapi.adjusted_mode.crtc_vdisplay;
445 cur_size = intel_fb_align_height(&fb->base, 0, cur_size);
446 cur_size *= fb->base.pitches[0];
447 drm_dbg_kms(&i915->drm,
448 "[CRTC:%d:%s] area: %dx%d, bpp: %d, size: %d\n",
449 crtc->base.base.id, crtc->base.name,
450 crtc_state->uapi.adjusted_mode.crtc_hdisplay,
451 crtc_state->uapi.adjusted_mode.crtc_vdisplay,
452 fb->base.format->cpp[0] * 8,
455 if (cur_size > max_size) {
456 drm_dbg_kms(&i915->drm,
457 "fb not big enough for [PLANE:%d:%s] (%d vs %d)\n",
458 plane->base.base.id, plane->base.name,
464 drm_dbg_kms(&i915->drm,
465 "fb big enough [PLANE:%d:%s] (%d >= %d)\n",
466 plane->base.base.id, plane->base.name,
471 drm_dbg_kms(&i915->drm,
472 "BIOS fb not suitable for all pipes, not using\n");
476 ifbdev->preferred_bpp = fb->base.format->cpp[0] * 8;
479 drm_framebuffer_get(&ifbdev->fb->base);
481 /* Final pass to check if any active pipes don't have fbs */
482 for_each_intel_crtc(dev, crtc) {
483 struct intel_crtc_state *crtc_state =
484 to_intel_crtc_state(crtc->base.state);
485 struct intel_plane *plane =
486 to_intel_plane(crtc->base.primary);
487 struct intel_plane_state *plane_state =
488 to_intel_plane_state(plane->base.state);
490 if (!crtc_state->uapi.active)
493 drm_WARN(dev, !plane_state->uapi.fb,
494 "re-used BIOS config but lost an fb on [PLANE:%d:%s]\n",
495 plane->base.base.id, plane->base.name);
499 drm_dbg_kms(&i915->drm, "using BIOS fb for initial console\n");
507 static void intel_fbdev_suspend_worker(struct work_struct *work)
509 intel_fbdev_set_suspend(&container_of(work,
510 struct drm_i915_private,
511 display.fbdev.suspend_work)->drm,
512 FBINFO_STATE_RUNNING,
516 int intel_fbdev_init(struct drm_device *dev)
518 struct drm_i915_private *dev_priv = to_i915(dev);
519 struct intel_fbdev *ifbdev;
522 if (drm_WARN_ON(dev, !HAS_DISPLAY(dev_priv)))
525 ifbdev = kzalloc(sizeof(struct intel_fbdev), GFP_KERNEL);
529 mutex_init(&ifbdev->hpd_lock);
530 drm_fb_helper_prepare(dev, &ifbdev->helper, &intel_fb_helper_funcs);
532 if (!intel_fbdev_init_bios(dev, ifbdev))
533 ifbdev->preferred_bpp = 32;
535 ret = drm_fb_helper_init(dev, &ifbdev->helper);
541 dev_priv->display.fbdev.fbdev = ifbdev;
542 INIT_WORK(&dev_priv->display.fbdev.suspend_work, intel_fbdev_suspend_worker);
547 static void intel_fbdev_initial_config(void *data, async_cookie_t cookie)
549 struct intel_fbdev *ifbdev = data;
551 /* Due to peculiar init order wrt to hpd handling this is separate. */
552 if (drm_fb_helper_initial_config(&ifbdev->helper,
553 ifbdev->preferred_bpp))
554 intel_fbdev_unregister(to_i915(ifbdev->helper.dev));
557 void intel_fbdev_initial_config_async(struct drm_device *dev)
559 struct intel_fbdev *ifbdev = to_i915(dev)->display.fbdev.fbdev;
564 ifbdev->cookie = async_schedule(intel_fbdev_initial_config, ifbdev);
567 static void intel_fbdev_sync(struct intel_fbdev *ifbdev)
572 /* Only serialises with all preceding async calls, hence +1 */
573 async_synchronize_cookie(ifbdev->cookie + 1);
577 void intel_fbdev_unregister(struct drm_i915_private *dev_priv)
579 struct intel_fbdev *ifbdev = dev_priv->display.fbdev.fbdev;
584 intel_fbdev_set_suspend(&dev_priv->drm, FBINFO_STATE_SUSPENDED, true);
586 if (!current_is_async())
587 intel_fbdev_sync(ifbdev);
589 drm_fb_helper_unregister_info(&ifbdev->helper);
592 void intel_fbdev_fini(struct drm_i915_private *dev_priv)
594 struct intel_fbdev *ifbdev = fetch_and_zero(&dev_priv->display.fbdev.fbdev);
599 intel_fbdev_destroy(ifbdev);
602 /* Suspends/resumes fbdev processing of incoming HPD events. When resuming HPD
603 * processing, fbdev will perform a full connector reprobe if a hotplug event
604 * was received while HPD was suspended.
606 static void intel_fbdev_hpd_set_suspend(struct drm_i915_private *i915, int state)
608 struct intel_fbdev *ifbdev = i915->display.fbdev.fbdev;
609 bool send_hpd = false;
611 mutex_lock(&ifbdev->hpd_lock);
612 ifbdev->hpd_suspended = state == FBINFO_STATE_SUSPENDED;
613 send_hpd = !ifbdev->hpd_suspended && ifbdev->hpd_waiting;
614 ifbdev->hpd_waiting = false;
615 mutex_unlock(&ifbdev->hpd_lock);
618 drm_dbg_kms(&i915->drm, "Handling delayed fbcon HPD event\n");
619 drm_fb_helper_hotplug_event(&ifbdev->helper);
623 void intel_fbdev_set_suspend(struct drm_device *dev, int state, bool synchronous)
625 struct drm_i915_private *dev_priv = to_i915(dev);
626 struct intel_fbdev *ifbdev = dev_priv->display.fbdev.fbdev;
627 struct fb_info *info;
629 if (!ifbdev || !ifbdev->vma)
632 info = ifbdev->helper.info;
635 /* Flush any pending work to turn the console on, and then
636 * wait to turn it off. It must be synchronous as we are
637 * about to suspend or unload the driver.
639 * Note that from within the work-handler, we cannot flush
640 * ourselves, so only flush outstanding work upon suspend!
642 if (state != FBINFO_STATE_RUNNING)
643 flush_work(&dev_priv->display.fbdev.suspend_work);
648 * The console lock can be pretty contented on resume due
649 * to all the printk activity. Try to keep it out of the hot
650 * path of resume if possible.
652 drm_WARN_ON(dev, state != FBINFO_STATE_RUNNING);
653 if (!console_trylock()) {
654 /* Don't block our own workqueue as this can
655 * be run in parallel with other i915.ko tasks.
657 schedule_work(&dev_priv->display.fbdev.suspend_work);
662 /* On resume from hibernation: If the object is shmemfs backed, it has
663 * been restored from swap. If the object is stolen however, it will be
664 * full of whatever garbage was left in there.
666 if (state == FBINFO_STATE_RUNNING &&
667 !i915_gem_object_is_shmem(intel_fb_obj(&ifbdev->fb->base)))
668 memset_io(info->screen_base, 0, info->screen_size);
670 drm_fb_helper_set_suspend(&ifbdev->helper, state);
674 intel_fbdev_hpd_set_suspend(dev_priv, state);
677 void intel_fbdev_output_poll_changed(struct drm_device *dev)
679 struct intel_fbdev *ifbdev = to_i915(dev)->display.fbdev.fbdev;
685 intel_fbdev_sync(ifbdev);
687 mutex_lock(&ifbdev->hpd_lock);
688 send_hpd = !ifbdev->hpd_suspended;
689 ifbdev->hpd_waiting = true;
690 mutex_unlock(&ifbdev->hpd_lock);
692 if (send_hpd && (ifbdev->vma || ifbdev->helper.deferred_setup))
693 drm_fb_helper_hotplug_event(&ifbdev->helper);
696 void intel_fbdev_restore_mode(struct drm_device *dev)
698 struct intel_fbdev *ifbdev = to_i915(dev)->display.fbdev.fbdev;
703 intel_fbdev_sync(ifbdev);
707 if (drm_fb_helper_restore_fbdev_mode_unlocked(&ifbdev->helper) == 0)
708 intel_fbdev_invalidate(ifbdev);
711 struct intel_framebuffer *intel_fbdev_framebuffer(struct intel_fbdev *fbdev)
713 if (!fbdev || !fbdev->helper.fb)
716 return to_intel_framebuffer(fbdev->helper.fb);