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