Merge tag 'edac_urgent_for_v5.17_rc3' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-microblaze.git] / Documentation / gpu / todo.rst
1 .. _todo:
2
3 =========
4 TODO list
5 =========
6
7 This section contains a list of smaller janitorial tasks in the kernel DRM
8 graphics subsystem useful as newbie projects. Or for slow rainy days.
9
10 Difficulty
11 ----------
12
13 To make it easier task are categorized into different levels:
14
15 Starter: Good tasks to get started with the DRM subsystem.
16
17 Intermediate: Tasks which need some experience with working in the DRM
18 subsystem, or some specific GPU/display graphics knowledge. For debugging issue
19 it's good to have the relevant hardware (or a virtual driver set up) available
20 for testing.
21
22 Advanced: Tricky tasks that need fairly good understanding of the DRM subsystem
23 and graphics topics. Generally need the relevant hardware for development and
24 testing.
25
26 Expert: Only attempt these if you've successfully completed some tricky
27 refactorings already and are an expert in the specific area
28
29 Subsystem-wide refactorings
30 ===========================
31
32 Remove custom dumb_map_offset implementations
33 ---------------------------------------------
34
35 All GEM based drivers should be using drm_gem_create_mmap_offset() instead.
36 Audit each individual driver, make sure it'll work with the generic
37 implementation (there's lots of outdated locking leftovers in various
38 implementations), and then remove it.
39
40 Contact: Daniel Vetter, respective driver maintainers
41
42 Level: Intermediate
43
44 Convert existing KMS drivers to atomic modesetting
45 --------------------------------------------------
46
47 3.19 has the atomic modeset interfaces and helpers, so drivers can now be
48 converted over. Modern compositors like Wayland or Surfaceflinger on Android
49 really want an atomic modeset interface, so this is all about the bright
50 future.
51
52 There is a conversion guide for atomic and all you need is a GPU for a
53 non-converted driver (again virtual HW drivers for KVM are still all
54 suitable).
55
56 As part of this drivers also need to convert to universal plane (which means
57 exposing primary & cursor as proper plane objects). But that's much easier to
58 do by directly using the new atomic helper driver callbacks.
59
60 Contact: Daniel Vetter, respective driver maintainers
61
62 Level: Advanced
63
64 Clean up the clipped coordination confusion around planes
65 ---------------------------------------------------------
66
67 We have a helper to get this right with drm_plane_helper_check_update(), but
68 it's not consistently used. This should be fixed, preferrably in the atomic
69 helpers (and drivers then moved over to clipped coordinates). Probably the
70 helper should also be moved from drm_plane_helper.c to the atomic helpers, to
71 avoid confusion - the other helpers in that file are all deprecated legacy
72 helpers.
73
74 Contact: Ville Syrjälä, Daniel Vetter, driver maintainers
75
76 Level: Advanced
77
78 Improve plane atomic_check helpers
79 ----------------------------------
80
81 Aside from the clipped coordinates right above there's a few suboptimal things
82 with the current helpers:
83
84 - drm_plane_helper_funcs->atomic_check gets called for enabled or disabled
85   planes. At best this seems to confuse drivers, worst it means they blow up
86   when the plane is disabled without the CRTC. The only special handling is
87   resetting values in the plane state structures, which instead should be moved
88   into the drm_plane_funcs->atomic_duplicate_state functions.
89
90 - Once that's done, helpers could stop calling ->atomic_check for disabled
91   planes.
92
93 - Then we could go through all the drivers and remove the more-or-less confused
94   checks for plane_state->fb and plane_state->crtc.
95
96 Contact: Daniel Vetter
97
98 Level: Advanced
99
100 Convert early atomic drivers to async commit helpers
101 ----------------------------------------------------
102
103 For the first year the atomic modeset helpers didn't support asynchronous /
104 nonblocking commits, and every driver had to hand-roll them. This is fixed
105 now, but there's still a pile of existing drivers that easily could be
106 converted over to the new infrastructure.
107
108 One issue with the helpers is that they require that drivers handle completion
109 events for atomic commits correctly. But fixing these bugs is good anyway.
110
111 Somewhat related is the legacy_cursor_update hack, which should be replaced with
112 the new atomic_async_check/commit functionality in the helpers in drivers that
113 still look at that flag.
114
115 Contact: Daniel Vetter, respective driver maintainers
116
117 Level: Advanced
118
119 Fallout from atomic KMS
120 -----------------------
121
122 ``drm_atomic_helper.c`` provides a batch of functions which implement legacy
123 IOCTLs on top of the new atomic driver interface. Which is really nice for
124 gradual conversion of drivers, but unfortunately the semantic mismatches are
125 a bit too severe. So there's some follow-up work to adjust the function
126 interfaces to fix these issues:
127
128 * atomic needs the lock acquire context. At the moment that's passed around
129   implicitly with some horrible hacks, and it's also allocate with
130   ``GFP_NOFAIL`` behind the scenes. All legacy paths need to start allocating
131   the acquire context explicitly on stack and then also pass it down into
132   drivers explicitly so that the legacy-on-atomic functions can use them.
133
134   Except for some driver code this is done. This task should be finished by
135   adding WARN_ON(!drm_drv_uses_atomic_modeset) in drm_modeset_lock_all().
136
137 * A bunch of the vtable hooks are now in the wrong place: DRM has a split
138   between core vfunc tables (named ``drm_foo_funcs``), which are used to
139   implement the userspace ABI. And then there's the optional hooks for the
140   helper libraries (name ``drm_foo_helper_funcs``), which are purely for
141   internal use. Some of these hooks should be move from ``_funcs`` to
142   ``_helper_funcs`` since they are not part of the core ABI. There's a
143   ``FIXME`` comment in the kerneldoc for each such case in ``drm_crtc.h``.
144
145 Contact: Daniel Vetter
146
147 Level: Intermediate
148
149 Get rid of dev->struct_mutex from GEM drivers
150 ---------------------------------------------
151
152 ``dev->struct_mutex`` is the Big DRM Lock from legacy days and infested
153 everything. Nowadays in modern drivers the only bit where it's mandatory is
154 serializing GEM buffer object destruction. Which unfortunately means drivers
155 have to keep track of that lock and either call ``unreference`` or
156 ``unreference_locked`` depending upon context.
157
158 Core GEM doesn't have a need for ``struct_mutex`` any more since kernel 4.8,
159 and there's a GEM object ``free`` callback for any drivers which are
160 entirely ``struct_mutex`` free.
161
162 For drivers that need ``struct_mutex`` it should be replaced with a driver-
163 private lock. The tricky part is the BO free functions, since those can't
164 reliably take that lock any more. Instead state needs to be protected with
165 suitable subordinate locks or some cleanup work pushed to a worker thread. For
166 performance-critical drivers it might also be better to go with a more
167 fine-grained per-buffer object and per-context lockings scheme. Currently only
168 the ``msm`` and `i915` drivers use ``struct_mutex``.
169
170 Contact: Daniel Vetter, respective driver maintainers
171
172 Level: Advanced
173
174 Move Buffer Object Locking to dma_resv_lock()
175 ---------------------------------------------
176
177 Many drivers have their own per-object locking scheme, usually using
178 mutex_lock(). This causes all kinds of trouble for buffer sharing, since
179 depending which driver is the exporter and importer, the locking hierarchy is
180 reversed.
181
182 To solve this we need one standard per-object locking mechanism, which is
183 dma_resv_lock(). This lock needs to be called as the outermost lock, with all
184 other driver specific per-object locks removed. The problem is tha rolling out
185 the actual change to the locking contract is a flag day, due to struct dma_buf
186 buffer sharing.
187
188 Level: Expert
189
190 Convert logging to drm_* functions with drm_device paramater
191 ------------------------------------------------------------
192
193 For drivers which could have multiple instances, it is necessary to
194 differentiate between which is which in the logs. Since DRM_INFO/WARN/ERROR
195 don't do this, drivers used dev_info/warn/err to make this differentiation. We
196 now have drm_* variants of the drm print functions, so we can start to convert
197 those drivers back to using drm-formatted specific log messages.
198
199 Before you start this conversion please contact the relevant maintainers to make
200 sure your work will be merged - not everyone agrees that the DRM dmesg macros
201 are better.
202
203 Contact: Sean Paul, Maintainer of the driver you plan to convert
204
205 Level: Starter
206
207 Convert drivers to use simple modeset suspend/resume
208 ----------------------------------------------------
209
210 Most drivers (except i915 and nouveau) that use
211 drm_atomic_helper_suspend/resume() can probably be converted to use
212 drm_mode_config_helper_suspend/resume(). Also there's still open-coded version
213 of the atomic suspend/resume code in older atomic modeset drivers.
214
215 Contact: Maintainer of the driver you plan to convert
216
217 Level: Intermediate
218
219 Convert drivers to use drm_fbdev_generic_setup()
220 ------------------------------------------------
221
222 Most drivers can use drm_fbdev_generic_setup(). Driver have to implement
223 atomic modesetting and GEM vmap support. Historically, generic fbdev emulation
224 expected the framebuffer in system memory or system-like memory. By employing
225 struct dma_buf_map, drivers with frambuffers in I/O memory can be supported
226 as well.
227
228 Contact: Maintainer of the driver you plan to convert
229
230 Level: Intermediate
231
232 Reimplement functions in drm_fbdev_fb_ops without fbdev
233 -------------------------------------------------------
234
235 A number of callback functions in drm_fbdev_fb_ops could benefit from
236 being rewritten without dependencies on the fbdev module. Some of the
237 helpers could further benefit from using struct dma_buf_map instead of
238 raw pointers.
239
240 Contact: Thomas Zimmermann <tzimmermann@suse.de>, Daniel Vetter
241
242 Level: Advanced
243
244
245 drm_framebuffer_funcs and drm_mode_config_funcs.fb_create cleanup
246 -----------------------------------------------------------------
247
248 A lot more drivers could be switched over to the drm_gem_framebuffer helpers.
249 Various hold-ups:
250
251 - Need to switch over to the generic dirty tracking code using
252   drm_atomic_helper_dirtyfb first (e.g. qxl).
253
254 - Need to switch to drm_fbdev_generic_setup(), otherwise a lot of the custom fb
255   setup code can't be deleted.
256
257 - Many drivers wrap drm_gem_fb_create() only to check for valid formats. For
258   atomic drivers we could check for valid formats by calling
259   drm_plane_check_pixel_format() against all planes, and pass if any plane
260   supports the format. For non-atomic that's not possible since like the format
261   list for the primary plane is fake and we'd therefor reject valid formats.
262
263 - Many drivers subclass drm_framebuffer, we'd need a embedding compatible
264   version of the varios drm_gem_fb_create functions. Maybe called
265   drm_gem_fb_create/_with_dirty/_with_funcs as needed.
266
267 Contact: Daniel Vetter
268
269 Level: Intermediate
270
271 Generic fbdev defio support
272 ---------------------------
273
274 The defio support code in the fbdev core has some very specific requirements,
275 which means drivers need to have a special framebuffer for fbdev. The main
276 issue is that it uses some fields in struct page itself, which breaks shmem
277 gem objects (and other things). To support defio, affected drivers require
278 the use of a shadow buffer, which may add CPU and memory overhead.
279
280 Possible solution would be to write our own defio mmap code in the drm fbdev
281 emulation. It would need to fully wrap the existing mmap ops, forwarding
282 everything after it has done the write-protect/mkwrite trickery:
283
284 - In the drm_fbdev_fb_mmap helper, if we need defio, change the
285   default page prots to write-protected with something like this::
286
287       vma->vm_page_prot = pgprot_wrprotect(vma->vm_page_prot);
288
289 - Set the mkwrite and fsync callbacks with similar implementions to the core
290   fbdev defio stuff. These should all work on plain ptes, they don't actually
291   require a struct page.  uff. These should all work on plain ptes, they don't
292   actually require a struct page.
293
294 - Track the dirty pages in a separate structure (bitfield with one bit per page
295   should work) to avoid clobbering struct page.
296
297 Might be good to also have some igt testcases for this.
298
299 Contact: Daniel Vetter, Noralf Tronnes
300
301 Level: Advanced
302
303 idr_init_base()
304 ---------------
305
306 DRM core&drivers uses a lot of idr (integer lookup directories) for mapping
307 userspace IDs to internal objects, and in most places ID=0 means NULL and hence
308 is never used. Switching to idr_init_base() for these would make the idr more
309 efficient.
310
311 Contact: Daniel Vetter
312
313 Level: Starter
314
315 struct drm_gem_object_funcs
316 ---------------------------
317
318 GEM objects can now have a function table instead of having the callbacks on the
319 DRM driver struct. This is now the preferred way. Callbacks in drivers have been
320 converted, except for struct drm_driver.gem_prime_mmap.
321
322 Level: Intermediate
323
324 Rename CMA helpers to DMA helpers
325 ---------------------------------
326
327 CMA (standing for contiguous memory allocator) is really a bit an accident of
328 what these were used for first, a much better name would be DMA helpers. In the
329 text these should even be called coherent DMA memory helpers (so maybe CDM, but
330 no one knows what that means) since underneath they just use dma_alloc_coherent.
331
332 Contact: Laurent Pinchart, Daniel Vetter
333
334 Level: Intermediate (mostly because it is a huge tasks without good partial
335 milestones, not technically itself that challenging)
336
337 connector register/unregister fixes
338 -----------------------------------
339
340 - For most connectors it's a no-op to call drm_connector_register/unregister
341   directly from driver code, drm_dev_register/unregister take care of this
342   already. We can remove all of them.
343
344 - For dp drivers it's a bit more a mess, since we need the connector to be
345   registered when calling drm_dp_aux_register. Fix this by instead calling
346   drm_dp_aux_init, and moving the actual registering into a late_register
347   callback as recommended in the kerneldoc.
348
349 Level: Intermediate
350
351 Remove load/unload callbacks from all non-DRIVER_LEGACY drivers
352 ---------------------------------------------------------------
353
354 The load/unload callbacks in struct &drm_driver are very much midlayers, plus
355 for historical reasons they get the ordering wrong (and we can't fix that)
356 between setting up the &drm_driver structure and calling drm_dev_register().
357
358 - Rework drivers to no longer use the load/unload callbacks, directly coding the
359   load/unload sequence into the driver's probe function.
360
361 - Once all non-DRIVER_LEGACY drivers are converted, disallow the load/unload
362   callbacks for all modern drivers.
363
364 Contact: Daniel Vetter
365
366 Level: Intermediate
367
368 Replace drm_detect_hdmi_monitor() with drm_display_info.is_hdmi
369 ---------------------------------------------------------------
370
371 Once EDID is parsed, the monitor HDMI support information is available through
372 drm_display_info.is_hdmi. Many drivers still call drm_detect_hdmi_monitor() to
373 retrieve the same information, which is less efficient.
374
375 Audit each individual driver calling drm_detect_hdmi_monitor() and switch to
376 drm_display_info.is_hdmi if applicable.
377
378 Contact: Laurent Pinchart, respective driver maintainers
379
380 Level: Intermediate
381
382 Consolidate custom driver modeset properties
383 --------------------------------------------
384
385 Before atomic modeset took place, many drivers where creating their own
386 properties. Among other things, atomic brought the requirement that custom,
387 driver specific properties should not be used.
388
389 For this task, we aim to introduce core helpers or reuse the existing ones
390 if available:
391
392 A quick, unconfirmed, examples list.
393
394 Introduce core helpers:
395 - audio (amdgpu, intel, gma500, radeon)
396 - brightness, contrast, etc (armada, nouveau) - overlay only (?)
397 - broadcast rgb (gma500, intel)
398 - colorkey (armada, nouveau, rcar) - overlay only (?)
399 - dither (amdgpu, nouveau, radeon) - varies across drivers
400 - underscan family (amdgpu, radeon, nouveau)
401
402 Already in core:
403 - colorspace (sti)
404 - tv format names, enhancements (gma500, intel)
405 - tv overscan, margins, etc. (gma500, intel)
406 - zorder (omapdrm) - same as zpos (?)
407
408
409 Contact: Emil Velikov, respective driver maintainers
410
411 Level: Intermediate
412
413 Use struct dma_buf_map throughout codebase
414 ------------------------------------------
415
416 Pointers to shared device memory are stored in struct dma_buf_map. Each
417 instance knows whether it refers to system or I/O memory. Most of the DRM-wide
418 interface have been converted to use struct dma_buf_map, but implementations
419 often still use raw pointers.
420
421 The task is to use struct dma_buf_map where it makes sense.
422
423 * Memory managers should use struct dma_buf_map for dma-buf-imported buffers.
424 * TTM might benefit from using struct dma_buf_map internally.
425 * Framebuffer copying and blitting helpers should operate on struct dma_buf_map.
426
427 Contact: Thomas Zimmermann <tzimmermann@suse.de>, Christian König, Daniel Vetter
428
429 Level: Intermediate
430
431 Review all drivers for setting struct drm_mode_config.{max_width,max_height} correctly
432 --------------------------------------------------------------------------------------
433
434 The values in struct drm_mode_config.{max_width,max_height} describe the
435 maximum supported framebuffer size. It's the virtual screen size, but many
436 drivers treat it like limitations of the physical resolution.
437
438 The maximum width depends on the hardware's maximum scanline pitch. The
439 maximum height depends on the amount of addressable video memory. Review all
440 drivers to initialize the fields to the correct values.
441
442 Contact: Thomas Zimmermann <tzimmermann@suse.de>
443
444 Level: Intermediate
445
446
447 Core refactorings
448 =================
449
450 Make panic handling work
451 ------------------------
452
453 This is a really varied tasks with lots of little bits and pieces:
454
455 * The panic path can't be tested currently, leading to constant breaking. The
456   main issue here is that panics can be triggered from hardirq contexts and
457   hence all panic related callback can run in hardirq context. It would be
458   awesome if we could test at least the fbdev helper code and driver code by
459   e.g. trigger calls through drm debugfs files. hardirq context could be
460   achieved by using an IPI to the local processor.
461
462 * There's a massive confusion of different panic handlers. DRM fbdev emulation
463   helpers have one, but on top of that the fbcon code itself also has one. We
464   need to make sure that they stop fighting over each another.
465
466 * ``drm_can_sleep()`` is a mess. It hides real bugs in normal operations and
467   isn't a full solution for panic paths. We need to make sure that it only
468   returns true if there's a panic going on for real, and fix up all the
469   fallout.
470
471 * The panic handler must never sleep, which also means it can't ever
472   ``mutex_lock()``. Also it can't grab any other lock unconditionally, not
473   even spinlocks (because NMI and hardirq can panic too). We need to either
474   make sure to not call such paths, or trylock everything. Really tricky.
475
476 * For the above locking troubles reasons it's pretty much impossible to
477   attempt a synchronous modeset from panic handlers. The only thing we could
478   try to achive is an atomic ``set_base`` of the primary plane, and hope that
479   it shows up. Everything else probably needs to be delayed to some worker or
480   something else which happens later on. Otherwise it just kills the box
481   harder, prevent the panic from going out on e.g. netconsole.
482
483 * There's also proposal for a simplied DRM console instead of the full-blown
484   fbcon and DRM fbdev emulation. Any kind of panic handling tricks should
485   obviously work for both console, in case we ever get kmslog merged.
486
487 Contact: Daniel Vetter
488
489 Level: Advanced
490
491 Clean up the debugfs support
492 ----------------------------
493
494 There's a bunch of issues with it:
495
496 - The drm_info_list ->show() function doesn't even bother to cast to the drm
497   structure for you. This is lazy.
498
499 - We probably want to have some support for debugfs files on crtc/connectors and
500   maybe other kms objects directly in core. There's even drm_print support in
501   the funcs for these objects to dump kms state, so it's all there. And then the
502   ->show() functions should obviously give you a pointer to the right object.
503
504 - The drm_info_list stuff is centered on drm_minor instead of drm_device. For
505   anything we want to print drm_device (or maybe drm_file) is the right thing.
506
507 - The drm_driver->debugfs_init hooks we have is just an artifact of the old
508   midlayered load sequence. DRM debugfs should work more like sysfs, where you
509   can create properties/files for an object anytime you want, and the core
510   takes care of publishing/unpuplishing all the files at register/unregister
511   time. Drivers shouldn't need to worry about these technicalities, and fixing
512   this (together with the drm_minor->drm_device move) would allow us to remove
513   debugfs_init.
514
515 Previous RFC that hasn't landed yet: https://lore.kernel.org/dri-devel/20200513114130.28641-2-wambui.karugax@gmail.com/
516
517 Contact: Daniel Vetter
518
519 Level: Intermediate
520
521 Object lifetime fixes
522 ---------------------
523
524 There's two related issues here
525
526 - Cleanup up the various ->destroy callbacks, which often are all the same
527   simple code.
528
529 - Lots of drivers erroneously allocate DRM modeset objects using devm_kzalloc,
530   which results in use-after free issues on driver unload. This can be serious
531   trouble even for drivers for hardware integrated on the SoC due to
532   EPROBE_DEFERRED backoff.
533
534 Both these problems can be solved by switching over to drmm_kzalloc(), and the
535 various convenience wrappers provided, e.g. drmm_crtc_alloc_with_planes(),
536 drmm_universal_plane_alloc(), ... and so on.
537
538 Contact: Daniel Vetter
539
540 Level: Intermediate
541
542 Remove automatic page mapping from dma-buf importing
543 ----------------------------------------------------
544
545 When importing dma-bufs, the dma-buf and PRIME frameworks automatically map
546 imported pages into the importer's DMA area. drm_gem_prime_fd_to_handle() and
547 drm_gem_prime_handle_to_fd() require that importers call dma_buf_attach()
548 even if they never do actual device DMA, but only CPU access through
549 dma_buf_vmap(). This is a problem for USB devices, which do not support DMA
550 operations.
551
552 To fix the issue, automatic page mappings should be removed from the
553 buffer-sharing code. Fixing this is a bit more involved, since the import/export
554 cache is also tied to &drm_gem_object.import_attach. Meanwhile we paper over
555 this problem for USB devices by fishing out the USB host controller device, as
556 long as that supports DMA. Otherwise importing can still needlessly fail.
557
558 Contact: Thomas Zimmermann <tzimmermann@suse.de>, Daniel Vetter
559
560 Level: Advanced
561
562
563 Better Testing
564 ==============
565
566 Enable trinity for DRM
567 ----------------------
568
569 And fix up the fallout. Should be really interesting ...
570
571 Level: Advanced
572
573 Make KMS tests in i-g-t generic
574 -------------------------------
575
576 The i915 driver team maintains an extensive testsuite for the i915 DRM driver,
577 including tons of testcases for corner-cases in the modesetting API. It would
578 be awesome if those tests (at least the ones not relying on Intel-specific GEM
579 features) could be made to run on any KMS driver.
580
581 Basic work to run i-g-t tests on non-i915 is done, what's now missing is mass-
582 converting things over. For modeset tests we also first need a bit of
583 infrastructure to use dumb buffers for untiled buffers, to be able to run all
584 the non-i915 specific modeset tests.
585
586 Level: Advanced
587
588 Extend virtual test driver (VKMS)
589 ---------------------------------
590
591 See the documentation of :ref:`VKMS <vkms>` for more details. This is an ideal
592 internship task, since it only requires a virtual machine and can be sized to
593 fit the available time.
594
595 Level: See details
596
597 Backlight Refactoring
598 ---------------------
599
600 Backlight drivers have a triple enable/disable state, which is a bit overkill.
601 Plan to fix this:
602
603 1. Roll out backlight_enable() and backlight_disable() helpers everywhere. This
604    has started already.
605 2. In all, only look at one of the three status bits set by the above helpers.
606 3. Remove the other two status bits.
607
608 Contact: Daniel Vetter
609
610 Level: Intermediate
611
612 Driver Specific
613 ===============
614
615 AMD DC Display Driver
616 ---------------------
617
618 AMD DC is the display driver for AMD devices starting with Vega. There has been
619 a bunch of progress cleaning it up but there's still plenty of work to be done.
620
621 See drivers/gpu/drm/amd/display/TODO for tasks.
622
623 Contact: Harry Wentland, Alex Deucher
624
625 vmwgfx: Replace hashtable with Linux' implementation
626 ----------------------------------------------------
627
628 The vmwgfx driver uses its own hashtable implementation. Replace the
629 code with Linux' implementation and update the callers. It's mostly a
630 refactoring task, but the interfaces are different.
631
632 Contact: Zack Rusin, Thomas Zimmermann <tzimmermann@suse.de>
633
634 Level: Intermediate
635
636 Bootsplash
637 ==========
638
639 There is support in place now for writing internal DRM clients making it
640 possible to pick up the bootsplash work that was rejected because it was written
641 for fbdev.
642
643 - [v6,8/8] drm/client: Hack: Add bootsplash example
644   https://patchwork.freedesktop.org/patch/306579/
645
646 - [RFC PATCH v2 00/13] Kernel based bootsplash
647   https://lore.kernel.org/r/20171213194755.3409-1-mstaudt@suse.de
648
649 Contact: Sam Ravnborg
650
651 Level: Advanced
652
653 Outside DRM
654 ===========
655
656 Convert fbdev drivers to DRM
657 ----------------------------
658
659 There are plenty of fbdev drivers for older hardware. Some hardware has
660 become obsolete, but some still provides good(-enough) framebuffers. The
661 drivers that are still useful should be converted to DRM and afterwards
662 removed from fbdev.
663
664 Very simple fbdev drivers can best be converted by starting with a new
665 DRM driver. Simple KMS helpers and SHMEM should be able to handle any
666 existing hardware. The new driver's call-back functions are filled from
667 existing fbdev code.
668
669 More complex fbdev drivers can be refactored step-by-step into a DRM
670 driver with the help of the DRM fbconv helpers. [1] These helpers provide
671 the transition layer between the DRM core infrastructure and the fbdev
672 driver interface. Create a new DRM driver on top of the fbconv helpers,
673 copy over the fbdev driver, and hook it up to the DRM code. Examples for
674 several fbdev drivers are available at [1] and a tutorial of this process
675 available at [2]. The result is a primitive DRM driver that can run X11
676 and Weston.
677
678  - [1] https://gitlab.freedesktop.org/tzimmermann/linux/tree/fbconv
679  - [2] https://gitlab.freedesktop.org/tzimmermann/linux/blob/fbconv/drivers/gpu/drm/drm_fbconv_helper.c
680
681 Contact: Thomas Zimmermann <tzimmermann@suse.de>
682
683 Level: Advanced