1/*
2 * Copyright © 2007 David Airlie
3 *
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:
10 *
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
13 * Software.
14 *
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.
22 *
23 * Authors:
24 *     David Airlie
25 */
26
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>
33#include <linux/mm.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>
39
40#include <drm/drm_crtc.h>
41#include <drm/drm_fb_helper.h>
42#include <drm/drm_fourcc.h>
43
44#include "i915_drv.h"
45#include "intel_display_types.h"
46#include "intel_fbdev.h"
47#include "intel_frontbuffer.h"
48
49static struct intel_frontbuffer *to_frontbuffer(struct intel_fbdev *ifbdev)
50{
51	return ifbdev->fb->frontbuffer;
52}
53
54static void intel_fbdev_invalidate(struct intel_fbdev *ifbdev)
55{
56	intel_frontbuffer_invalidate(to_frontbuffer(ifbdev), ORIGIN_CPU);
57}
58
59static int intel_fbdev_set_par(struct fb_info *info)
60{
61	struct drm_fb_helper *fb_helper = info->par;
62	struct intel_fbdev *ifbdev =
63		container_of(fb_helper, struct intel_fbdev, helper);
64	int ret;
65
66	ret = drm_fb_helper_set_par(info);
67	if (ret == 0)
68		intel_fbdev_invalidate(ifbdev);
69
70	return ret;
71}
72
73static int intel_fbdev_blank(int blank, struct fb_info *info)
74{
75	struct drm_fb_helper *fb_helper = info->par;
76	struct intel_fbdev *ifbdev =
77		container_of(fb_helper, struct intel_fbdev, helper);
78	int ret;
79
80	ret = drm_fb_helper_blank(blank, info);
81	if (ret == 0)
82		intel_fbdev_invalidate(ifbdev);
83
84	return ret;
85}
86
87static int intel_fbdev_pan_display(struct fb_var_screeninfo *var,
88				   struct fb_info *info)
89{
90	struct drm_fb_helper *fb_helper = info->par;
91	struct intel_fbdev *ifbdev =
92		container_of(fb_helper, struct intel_fbdev, helper);
93	int ret;
94
95	ret = drm_fb_helper_pan_display(var, info);
96	if (ret == 0)
97		intel_fbdev_invalidate(ifbdev);
98
99	return ret;
100}
101
102static const struct fb_ops intelfb_ops = {
103	.owner = THIS_MODULE,
104	DRM_FB_HELPER_DEFAULT_OPS,
105	.fb_set_par = intel_fbdev_set_par,
106	.fb_fillrect = drm_fb_helper_cfb_fillrect,
107	.fb_copyarea = drm_fb_helper_cfb_copyarea,
108	.fb_imageblit = drm_fb_helper_cfb_imageblit,
109	.fb_pan_display = intel_fbdev_pan_display,
110	.fb_blank = intel_fbdev_blank,
111};
112
113static int intelfb_alloc(struct drm_fb_helper *helper,
114			 struct drm_fb_helper_surface_size *sizes)
115{
116	struct intel_fbdev *ifbdev =
117		container_of(helper, struct intel_fbdev, helper);
118	struct drm_framebuffer *fb;
119	struct drm_device *dev = helper->dev;
120	struct drm_i915_private *dev_priv = to_i915(dev);
121	struct drm_mode_fb_cmd2 mode_cmd = {};
122	struct drm_i915_gem_object *obj;
123	int size;
124
125	/* we don't do packed 24bpp */
126	if (sizes->surface_bpp == 24)
127		sizes->surface_bpp = 32;
128
129	mode_cmd.width = sizes->surface_width;
130	mode_cmd.height = sizes->surface_height;
131
132	mode_cmd.pitches[0] = ALIGN(mode_cmd.width *
133				    DIV_ROUND_UP(sizes->surface_bpp, 8), 64);
134	mode_cmd.pixel_format = drm_mode_legacy_fb_format(sizes->surface_bpp,
135							  sizes->surface_depth);
136
137	size = mode_cmd.pitches[0] * mode_cmd.height;
138	size = PAGE_ALIGN(size);
139
140	/* If the FB is too big, just don't use it since fbdev is not very
141	 * important and we should probably use that space with FBC or other
142	 * features. */
143	obj = ERR_PTR(-ENODEV);
144	if (size * 2 < dev_priv->stolen_usable_size)
145		obj = i915_gem_object_create_stolen(dev_priv, size);
146	if (IS_ERR(obj))
147		obj = i915_gem_object_create_shmem(dev_priv, size);
148	if (IS_ERR(obj)) {
149		drm_err(&dev_priv->drm, "failed to allocate framebuffer\n");
150		return PTR_ERR(obj);
151	}
152
153	fb = intel_framebuffer_create(obj, &mode_cmd);
154	i915_gem_object_put(obj);
155	if (IS_ERR(fb))
156		return PTR_ERR(fb);
157
158	ifbdev->fb = to_intel_framebuffer(fb);
159	return 0;
160}
161
162static int intelfb_create(struct drm_fb_helper *helper,
163			  struct drm_fb_helper_surface_size *sizes)
164{
165	struct intel_fbdev *ifbdev =
166		container_of(helper, struct intel_fbdev, helper);
167	struct intel_framebuffer *intel_fb = ifbdev->fb;
168	struct drm_device *dev = helper->dev;
169	struct drm_i915_private *dev_priv = to_i915(dev);
170	struct pci_dev *pdev = dev_priv->drm.pdev;
171	struct i915_ggtt *ggtt = &dev_priv->ggtt;
172	const struct i915_ggtt_view view = {
173		.type = I915_GGTT_VIEW_NORMAL,
174	};
175	intel_wakeref_t wakeref;
176	struct fb_info *info;
177	struct i915_vma *vma;
178	unsigned long flags = 0;
179	bool prealloc = false;
180	void __iomem *vaddr;
181	int ret;
182
183	if (intel_fb &&
184	    (sizes->fb_width > intel_fb->base.width ||
185	     sizes->fb_height > intel_fb->base.height)) {
186		drm_dbg_kms(&dev_priv->drm,
187			    "BIOS fb too small (%dx%d), we require (%dx%d),"
188			    " releasing it\n",
189			    intel_fb->base.width, intel_fb->base.height,
190			    sizes->fb_width, sizes->fb_height);
191		drm_framebuffer_put(&intel_fb->base);
192		intel_fb = ifbdev->fb = NULL;
193	}
194	if (!intel_fb || drm_WARN_ON(dev, !intel_fb_obj(&intel_fb->base))) {
195		drm_dbg_kms(&dev_priv->drm,
196			    "no BIOS fb, allocating a new one\n");
197		ret = intelfb_alloc(helper, sizes);
198		if (ret)
199			return ret;
200		intel_fb = ifbdev->fb;
201	} else {
202		drm_dbg_kms(&dev_priv->drm, "re-using BIOS fb\n");
203		prealloc = true;
204		sizes->fb_width = intel_fb->base.width;
205		sizes->fb_height = intel_fb->base.height;
206	}
207
208	wakeref = intel_runtime_pm_get(&dev_priv->runtime_pm);
209
210	/* Pin the GGTT vma for our access via info->screen_base.
211	 * This also validates that any existing fb inherited from the
212	 * BIOS is suitable for own access.
213	 */
214	vma = intel_pin_and_fence_fb_obj(&ifbdev->fb->base,
215					 &view, false, &flags);
216	if (IS_ERR(vma)) {
217		ret = PTR_ERR(vma);
218		goto out_unlock;
219	}
220
221	intel_frontbuffer_flush(to_frontbuffer(ifbdev), ORIGIN_DIRTYFB);
222
223	info = drm_fb_helper_alloc_fbi(helper);
224	if (IS_ERR(info)) {
225		drm_err(&dev_priv->drm, "Failed to allocate fb_info\n");
226		ret = PTR_ERR(info);
227		goto out_unpin;
228	}
229
230	ifbdev->helper.fb = &ifbdev->fb->base;
231
232	info->fbops = &intelfb_ops;
233
234	/* setup aperture base/size for vesafb takeover */
235	info->apertures->ranges[0].base = ggtt->gmadr.start;
236	info->apertures->ranges[0].size = ggtt->mappable_end;
237
238	/* Our framebuffer is the entirety of fbdev's system memory */
239	info->fix.smem_start =
240		(unsigned long)(ggtt->gmadr.start + vma->node.start);
241	info->fix.smem_len = vma->node.size;
242
243	vaddr = i915_vma_pin_iomap(vma);
244	if (IS_ERR(vaddr)) {
245		drm_err(&dev_priv->drm,
246			"Failed to remap framebuffer into virtual memory\n");
247		ret = PTR_ERR(vaddr);
248		goto out_unpin;
249	}
250	info->screen_base = vaddr;
251	info->screen_size = vma->node.size;
252
253	drm_fb_helper_fill_info(info, &ifbdev->helper, sizes);
254
255	/* If the object is shmemfs backed, it will have given us zeroed pages.
256	 * If the object is stolen however, it will be full of whatever
257	 * garbage was left in there.
258	 */
259	if (vma->obj->stolen && !prealloc)
260		memset_io(info->screen_base, 0, info->screen_size);
261
262	/* Use default scratch pixmap (info->pixmap.flags = FB_PIXMAP_SYSTEM) */
263
264	drm_dbg_kms(&dev_priv->drm, "allocated %dx%d fb: 0x%08x\n",
265		    ifbdev->fb->base.width, ifbdev->fb->base.height,
266		    i915_ggtt_offset(vma));
267	ifbdev->vma = vma;
268	ifbdev->vma_flags = flags;
269
270	intel_runtime_pm_put(&dev_priv->runtime_pm, wakeref);
271	vga_switcheroo_client_fb_set(pdev, info);
272	return 0;
273
274out_unpin:
275	intel_unpin_fb_vma(vma, flags);
276out_unlock:
277	intel_runtime_pm_put(&dev_priv->runtime_pm, wakeref);
278	return ret;
279}
280
281static const struct drm_fb_helper_funcs intel_fb_helper_funcs = {
282	.fb_probe = intelfb_create,
283};
284
285static void intel_fbdev_destroy(struct intel_fbdev *ifbdev)
286{
287	/* We rely on the object-free to release the VMA pinning for
288	 * the info->screen_base mmaping. Leaking the VMA is simpler than
289	 * trying to rectify all the possible error paths leading here.
290	 */
291
292	drm_fb_helper_fini(&ifbdev->helper);
293
294	if (ifbdev->vma)
295		intel_unpin_fb_vma(ifbdev->vma, ifbdev->vma_flags);
296
297	if (ifbdev->fb)
298		drm_framebuffer_remove(&ifbdev->fb->base);
299
300	kfree(ifbdev);
301}
302
303/*
304 * Build an intel_fbdev struct using a BIOS allocated framebuffer, if possible.
305 * The core display code will have read out the current plane configuration,
306 * so we use that to figure out if there's an object for us to use as the
307 * fb, and if so, we re-use it for the fbdev configuration.
308 *
309 * Note we only support a single fb shared across pipes for boot (mostly for
310 * fbcon), so we just find the biggest and use that.
311 */
312static bool intel_fbdev_init_bios(struct drm_device *dev,
313				 struct intel_fbdev *ifbdev)
314{
315	struct drm_i915_private *i915 = to_i915(dev);
316	struct intel_framebuffer *fb = NULL;
317	struct drm_crtc *crtc;
318	struct intel_crtc *intel_crtc;
319	unsigned int max_size = 0;
320
321	/* Find the largest fb */
322	for_each_crtc(dev, crtc) {
323		struct drm_i915_gem_object *obj =
324			intel_fb_obj(crtc->primary->state->fb);
325		intel_crtc = to_intel_crtc(crtc);
326
327		if (!crtc->state->active || !obj) {
328			drm_dbg_kms(&i915->drm,
329				    "pipe %c not active or no fb, skipping\n",
330				    pipe_name(intel_crtc->pipe));
331			continue;
332		}
333
334		if (obj->base.size > max_size) {
335			drm_dbg_kms(&i915->drm,
336				    "found possible fb from plane %c\n",
337				    pipe_name(intel_crtc->pipe));
338			fb = to_intel_framebuffer(crtc->primary->state->fb);
339			max_size = obj->base.size;
340		}
341	}
342
343	if (!fb) {
344		drm_dbg_kms(&i915->drm,
345			    "no active fbs found, not using BIOS config\n");
346		goto out;
347	}
348
349	/* Now make sure all the pipes will fit into it */
350	for_each_crtc(dev, crtc) {
351		unsigned int cur_size;
352
353		intel_crtc = to_intel_crtc(crtc);
354
355		if (!crtc->state->active) {
356			drm_dbg_kms(&i915->drm,
357				    "pipe %c not active, skipping\n",
358				    pipe_name(intel_crtc->pipe));
359			continue;
360		}
361
362		drm_dbg_kms(&i915->drm, "checking plane %c for BIOS fb\n",
363			    pipe_name(intel_crtc->pipe));
364
365		/*
366		 * See if the plane fb we found above will fit on this
367		 * pipe.  Note we need to use the selected fb's pitch and bpp
368		 * rather than the current pipe's, since they differ.
369		 */
370		cur_size = crtc->state->adjusted_mode.crtc_hdisplay;
371		cur_size = cur_size * fb->base.format->cpp[0];
372		if (fb->base.pitches[0] < cur_size) {
373			drm_dbg_kms(&i915->drm,
374				    "fb not wide enough for plane %c (%d vs %d)\n",
375				    pipe_name(intel_crtc->pipe),
376				    cur_size, fb->base.pitches[0]);
377			fb = NULL;
378			break;
379		}
380
381		cur_size = crtc->state->adjusted_mode.crtc_vdisplay;
382		cur_size = intel_fb_align_height(&fb->base, 0, cur_size);
383		cur_size *= fb->base.pitches[0];
384		drm_dbg_kms(&i915->drm,
385			    "pipe %c area: %dx%d, bpp: %d, size: %d\n",
386			    pipe_name(intel_crtc->pipe),
387			    crtc->state->adjusted_mode.crtc_hdisplay,
388			    crtc->state->adjusted_mode.crtc_vdisplay,
389			    fb->base.format->cpp[0] * 8,
390			    cur_size);
391
392		if (cur_size > max_size) {
393			drm_dbg_kms(&i915->drm,
394				    "fb not big enough for plane %c (%d vs %d)\n",
395				    pipe_name(intel_crtc->pipe),
396				    cur_size, max_size);
397			fb = NULL;
398			break;
399		}
400
401		drm_dbg_kms(&i915->drm,
402			    "fb big enough for plane %c (%d >= %d)\n",
403			    pipe_name(intel_crtc->pipe),
404			    max_size, cur_size);
405	}
406
407	if (!fb) {
408		drm_dbg_kms(&i915->drm,
409			    "BIOS fb not suitable for all pipes, not using\n");
410		goto out;
411	}
412
413	ifbdev->preferred_bpp = fb->base.format->cpp[0] * 8;
414	ifbdev->fb = fb;
415
416	drm_framebuffer_get(&ifbdev->fb->base);
417
418	/* Final pass to check if any active pipes don't have fbs */
419	for_each_crtc(dev, crtc) {
420		intel_crtc = to_intel_crtc(crtc);
421
422		if (!crtc->state->active)
423			continue;
424
425		drm_WARN(dev, !crtc->primary->state->fb,
426			 "re-used BIOS config but lost an fb on crtc %d\n",
427			 crtc->base.id);
428	}
429
430
431	drm_dbg_kms(&i915->drm, "using BIOS fb for initial console\n");
432	return true;
433
434out:
435
436	return false;
437}
438
439static void intel_fbdev_suspend_worker(struct work_struct *work)
440{
441	intel_fbdev_set_suspend(&container_of(work,
442					      struct drm_i915_private,
443					      fbdev_suspend_work)->drm,
444				FBINFO_STATE_RUNNING,
445				true);
446}
447
448int intel_fbdev_init(struct drm_device *dev)
449{
450	struct drm_i915_private *dev_priv = to_i915(dev);
451	struct intel_fbdev *ifbdev;
452	int ret;
453
454	if (drm_WARN_ON(dev, !HAS_DISPLAY(dev_priv)))
455		return -ENODEV;
456
457	ifbdev = kzalloc(sizeof(struct intel_fbdev), GFP_KERNEL);
458	if (ifbdev == NULL)
459		return -ENOMEM;
460
461	mutex_init(&ifbdev->hpd_lock);
462	drm_fb_helper_prepare(dev, &ifbdev->helper, &intel_fb_helper_funcs);
463
464	if (!intel_fbdev_init_bios(dev, ifbdev))
465		ifbdev->preferred_bpp = 32;
466
467	ret = drm_fb_helper_init(dev, &ifbdev->helper);
468	if (ret) {
469		kfree(ifbdev);
470		return ret;
471	}
472
473	dev_priv->fbdev = ifbdev;
474	INIT_WORK(&dev_priv->fbdev_suspend_work, intel_fbdev_suspend_worker);
475
476	return 0;
477}
478
479static void intel_fbdev_initial_config(void *data, async_cookie_t cookie)
480{
481	struct intel_fbdev *ifbdev = data;
482
483	/* Due to peculiar init order wrt to hpd handling this is separate. */
484	if (drm_fb_helper_initial_config(&ifbdev->helper,
485					 ifbdev->preferred_bpp))
486		intel_fbdev_unregister(to_i915(ifbdev->helper.dev));
487}
488
489void intel_fbdev_initial_config_async(struct drm_device *dev)
490{
491	struct intel_fbdev *ifbdev = to_i915(dev)->fbdev;
492
493	if (!ifbdev)
494		return;
495
496	ifbdev->cookie = async_schedule(intel_fbdev_initial_config, ifbdev);
497}
498
499static void intel_fbdev_sync(struct intel_fbdev *ifbdev)
500{
501	if (!ifbdev->cookie)
502		return;
503
504	/* Only serialises with all preceding async calls, hence +1 */
505	async_synchronize_cookie(ifbdev->cookie + 1);
506	ifbdev->cookie = 0;
507}
508
509void intel_fbdev_unregister(struct drm_i915_private *dev_priv)
510{
511	struct intel_fbdev *ifbdev = dev_priv->fbdev;
512
513	if (!ifbdev)
514		return;
515
516	cancel_work_sync(&dev_priv->fbdev_suspend_work);
517	if (!current_is_async())
518		intel_fbdev_sync(ifbdev);
519
520	drm_fb_helper_unregister_fbi(&ifbdev->helper);
521}
522
523void intel_fbdev_fini(struct drm_i915_private *dev_priv)
524{
525	struct intel_fbdev *ifbdev = fetch_and_zero(&dev_priv->fbdev);
526
527	if (!ifbdev)
528		return;
529
530	intel_fbdev_destroy(ifbdev);
531}
532
533/* Suspends/resumes fbdev processing of incoming HPD events. When resuming HPD
534 * processing, fbdev will perform a full connector reprobe if a hotplug event
535 * was received while HPD was suspended.
536 */
537static void intel_fbdev_hpd_set_suspend(struct drm_i915_private *i915, int state)
538{
539	struct intel_fbdev *ifbdev = i915->fbdev;
540	bool send_hpd = false;
541
542	mutex_lock(&ifbdev->hpd_lock);
543	ifbdev->hpd_suspended = state == FBINFO_STATE_SUSPENDED;
544	send_hpd = !ifbdev->hpd_suspended && ifbdev->hpd_waiting;
545	ifbdev->hpd_waiting = false;
546	mutex_unlock(&ifbdev->hpd_lock);
547
548	if (send_hpd) {
549		drm_dbg_kms(&i915->drm, "Handling delayed fbcon HPD event\n");
550		drm_fb_helper_hotplug_event(&ifbdev->helper);
551	}
552}
553
554void intel_fbdev_set_suspend(struct drm_device *dev, int state, bool synchronous)
555{
556	struct drm_i915_private *dev_priv = to_i915(dev);
557	struct intel_fbdev *ifbdev = dev_priv->fbdev;
558	struct fb_info *info;
559
560	if (!ifbdev || !ifbdev->vma)
561		return;
562
563	info = ifbdev->helper.fbdev;
564
565	if (synchronous) {
566		/* Flush any pending work to turn the console on, and then
567		 * wait to turn it off. It must be synchronous as we are
568		 * about to suspend or unload the driver.
569		 *
570		 * Note that from within the work-handler, we cannot flush
571		 * ourselves, so only flush outstanding work upon suspend!
572		 */
573		if (state != FBINFO_STATE_RUNNING)
574			flush_work(&dev_priv->fbdev_suspend_work);
575
576		console_lock();
577	} else {
578		/*
579		 * The console lock can be pretty contented on resume due
580		 * to all the printk activity.  Try to keep it out of the hot
581		 * path of resume if possible.
582		 */
583		drm_WARN_ON(dev, state != FBINFO_STATE_RUNNING);
584		if (!console_trylock()) {
585			/* Don't block our own workqueue as this can
586			 * be run in parallel with other i915.ko tasks.
587			 */
588			schedule_work(&dev_priv->fbdev_suspend_work);
589			return;
590		}
591	}
592
593	/* On resume from hibernation: If the object is shmemfs backed, it has
594	 * been restored from swap. If the object is stolen however, it will be
595	 * full of whatever garbage was left in there.
596	 */
597	if (state == FBINFO_STATE_RUNNING &&
598	    intel_fb_obj(&ifbdev->fb->base)->stolen)
599		memset_io(info->screen_base, 0, info->screen_size);
600
601	drm_fb_helper_set_suspend(&ifbdev->helper, state);
602	console_unlock();
603
604	intel_fbdev_hpd_set_suspend(dev_priv, state);
605}
606
607void intel_fbdev_output_poll_changed(struct drm_device *dev)
608{
609	struct intel_fbdev *ifbdev = to_i915(dev)->fbdev;
610	bool send_hpd;
611
612	if (!ifbdev)
613		return;
614
615	intel_fbdev_sync(ifbdev);
616
617	mutex_lock(&ifbdev->hpd_lock);
618	send_hpd = !ifbdev->hpd_suspended;
619	ifbdev->hpd_waiting = true;
620	mutex_unlock(&ifbdev->hpd_lock);
621
622	if (send_hpd && (ifbdev->vma || ifbdev->helper.deferred_setup))
623		drm_fb_helper_hotplug_event(&ifbdev->helper);
624}
625
626void intel_fbdev_restore_mode(struct drm_device *dev)
627{
628	struct intel_fbdev *ifbdev = to_i915(dev)->fbdev;
629
630	if (!ifbdev)
631		return;
632
633	intel_fbdev_sync(ifbdev);
634	if (!ifbdev->vma)
635		return;
636
637	if (drm_fb_helper_restore_fbdev_mode_unlocked(&ifbdev->helper) == 0)
638		intel_fbdev_invalidate(ifbdev);
639}
640