Commit | Line | Data |
---|---|---|
0e70dad0 TR |
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 | Subsystem-wide refactorings | |
11 | =========================== | |
12 | ||
13 | De-midlayer drivers | |
14 | ------------------- | |
15 | ||
16 | With the recent ``drm_bus`` cleanup patches for 3.17 it is no longer required | |
17 | to have a ``drm_bus`` structure set up. Drivers can directly set up the | |
18 | ``drm_device`` structure instead of relying on bus methods in ``drm_usb.c`` | |
19 | and ``drm_platform.c``. The goal is to get rid of the driver's ``->load`` / | |
20 | ``->unload`` callbacks and open-code the load/unload sequence properly, using | |
21 | the new two-stage ``drm_device`` setup/teardown. | |
22 | ||
23 | Once all existing drivers are converted we can also remove those bus support | |
24 | files for USB and platform devices. | |
25 | ||
26 | All you need is a GPU for a non-converted driver (currently almost all of | |
27 | them, but also all the virtual ones used by KVM, so everyone qualifies). | |
28 | ||
29 | Contact: Daniel Vetter, Thierry Reding, respective driver maintainers | |
30 | ||
31 | Switch from reference/unreference to get/put | |
32 | -------------------------------------------- | |
33 | ||
34 | For some reason DRM core uses ``reference``/``unreference`` suffixes for | |
35 | refcounting functions, but kernel uses ``get``/``put`` (e.g. | |
36 | ``kref_get``/``put()``). It would be good to switch over for consistency, and | |
37 | it's shorter. Needs to be done in 3 steps for each pair of functions: | |
38 | ||
39 | * Create new ``get``/``put`` functions, define the old names as compatibility | |
40 | wrappers | |
41 | * Switch over each file/driver using a cocci-generated spatch. | |
42 | * Once all users of the old names are gone, remove them. | |
43 | ||
44 | This way drivers/patches in the progress of getting merged won't break. | |
45 | ||
46 | Contact: Daniel Vetter | |
47 | ||
48 | Convert existing KMS drivers to atomic modesetting | |
49 | -------------------------------------------------- | |
50 | ||
51 | 3.19 has the atomic modeset interfaces and helpers, so drivers can now be | |
52 | converted over. Modern compositors like Wayland or Surfaceflinger on Android | |
53 | really want an atomic modeset interface, so this is all about the bright | |
54 | future. | |
55 | ||
56 | There is a conversion guide for atomic and all you need is a GPU for a | |
57 | non-converted driver (again virtual HW drivers for KVM are still all | |
58 | suitable). | |
59 | ||
60 | As part of this drivers also need to convert to universal plane (which means | |
61 | exposing primary & cursor as proper plane objects). But that's much easier to | |
62 | do by directly using the new atomic helper driver callbacks. | |
63 | ||
64 | Contact: Daniel Vetter, respective driver maintainers | |
1a80cc1c DV |
65 | |
66 | Clean up the clipped coordination confusion around planes | |
67 | --------------------------------------------------------- | |
68 | ||
69 | We have a helper to get this right with drm_plane_helper_check_update(), but | |
70 | it's not consistently used. This should be fixed, preferrably in the atomic | |
71 | helpers (and drivers then moved over to clipped coordinates). Probably the | |
72 | helper should also be moved from drm_plane_helper.c to the atomic helpers, to | |
73 | avoid confusion - the other helpers in that file are all deprecated legacy | |
74 | helpers. | |
75 | ||
76 | Contact: Ville Syrjälä, Daniel Vetter, driver maintainers | |
4e8be453 DV |
77 | |
78 | Implement deferred fbdev setup in the helper | |
79 | -------------------------------------------- | |
80 | ||
81 | Many (especially embedded drivers) want to delay fbdev setup until there's a | |
82 | real screen plugged in. This is to avoid the dreaded fallback to the low-res | |
83 | fbdev default. Many drivers have a hacked-up (and often broken) version of this, | |
84 | better to do it once in the shared helpers. Thierry has a patch series, but that | |
85 | one needs to be rebased and final polish applied. | |
86 | ||
87 | Contact: Thierry Reding, Daniel Vetter, driver maintainers | |
0e70dad0 TR |
88 | |
89 | Convert early atomic drivers to async commit helpers | |
90 | ---------------------------------------------------- | |
91 | ||
92 | For the first year the atomic modeset helpers didn't support asynchronous / | |
93 | nonblocking commits, and every driver had to hand-roll them. This is fixed | |
94 | now, but there's still a pile of existing drivers that easily could be | |
95 | converted over to the new infrastructure. | |
96 | ||
97 | One issue with the helpers is that they require that drivers handle completion | |
98 | events for atomic commits correctly. But fixing these bugs is good anyway. | |
99 | ||
100 | Contact: Daniel Vetter, respective driver maintainers | |
101 | ||
102 | Fallout from atomic KMS | |
103 | ----------------------- | |
104 | ||
105 | ``drm_atomic_helper.c`` provides a batch of functions which implement legacy | |
106 | IOCTLs on top of the new atomic driver interface. Which is really nice for | |
107 | gradual conversion of drivers, but unfortunately the semantic mismatches are | |
108 | a bit too severe. So there's some follow-up work to adjust the function | |
109 | interfaces to fix these issues: | |
110 | ||
111 | * atomic needs the lock acquire context. At the moment that's passed around | |
112 | implicitly with some horrible hacks, and it's also allocate with | |
113 | ``GFP_NOFAIL`` behind the scenes. All legacy paths need to start allocating | |
114 | the acquire context explicitly on stack and then also pass it down into | |
115 | drivers explicitly so that the legacy-on-atomic functions can use them. | |
116 | ||
117 | * A bunch of the vtable hooks are now in the wrong place: DRM has a split | |
118 | between core vfunc tables (named ``drm_foo_funcs``), which are used to | |
119 | implement the userspace ABI. And then there's the optional hooks for the | |
120 | helper libraries (name ``drm_foo_helper_funcs``), which are purely for | |
121 | internal use. Some of these hooks should be move from ``_funcs`` to | |
122 | ``_helper_funcs`` since they are not part of the core ABI. There's a | |
123 | ``FIXME`` comment in the kerneldoc for each such case in ``drm_crtc.h``. | |
124 | ||
125 | * There's a new helper ``drm_atomic_helper_best_encoder()`` which could be | |
126 | used by all atomic drivers which don't select the encoder for a given | |
127 | connector at runtime. That's almost all of them, and would allow us to get | |
128 | rid of a lot of ``best_encoder`` boilerplate in drivers. | |
129 | ||
130 | Contact: Daniel Vetter | |
131 | ||
132 | Get rid of dev->struct_mutex from GEM drivers | |
133 | --------------------------------------------- | |
134 | ||
135 | ``dev->struct_mutex`` is the Big DRM Lock from legacy days and infested | |
136 | everything. Nowadays in modern drivers the only bit where it's mandatory is | |
137 | serializing GEM buffer object destruction. Which unfortunately means drivers | |
138 | have to keep track of that lock and either call ``unreference`` or | |
139 | ``unreference_locked`` depending upon context. | |
140 | ||
141 | Core GEM doesn't have a need for ``struct_mutex`` any more since kernel 4.8, | |
142 | and there's a ``gem_free_object_unlocked`` callback for any drivers which are | |
143 | entirely ``struct_mutex`` free. | |
144 | ||
145 | For drivers that need ``struct_mutex`` it should be replaced with a driver- | |
146 | private lock. The tricky part is the BO free functions, since those can't | |
147 | reliably take that lock any more. Instead state needs to be protected with | |
148 | suitable subordinate locks or some cleanup work pushed to a worker thread. For | |
149 | performance-critical drivers it might also be better to go with a more | |
150 | fine-grained per-buffer object and per-context lockings scheme. Currently the | |
151 | following drivers still use ``struct_mutex``: ``msm``, ``omapdrm`` and | |
152 | ``udl``. | |
153 | ||
154 | Contact: Daniel Vetter | |
155 | ||
aabbcab6 DV |
156 | Switch to drm_connector_list_iter for any connector_list walking |
157 | ---------------------------------------------------------------- | |
158 | ||
159 | Connectors can be hotplugged, and we now have a special list of helpers to walk | |
160 | the connector_list in a race-free fashion, without incurring deadlocks on | |
161 | mutexes and other fun stuff. | |
162 | ||
163 | Unfortunately most drivers are not converted yet. At least all those supporting | |
164 | DP MST hotplug should be converted, since for those drivers the difference | |
165 | matters. See drm_for_each_connector_iter() vs. drm_for_each_connector(). | |
166 | ||
167 | Contact: Daniel Vetter | |
168 | ||
0e70dad0 TR |
169 | Core refactorings |
170 | ================= | |
171 | ||
172 | Use new IDR deletion interface to clean up drm_gem_handle_delete() | |
173 | ------------------------------------------------------------------ | |
174 | ||
175 | See the "This is gross" comment -- apparently the IDR system now can return an | |
176 | error code instead of oopsing. | |
177 | ||
178 | Clean up the DRM header mess | |
179 | ---------------------------- | |
180 | ||
181 | Currently the DRM subsystem has only one global header, ``drmP.h``. This is | |
182 | used both for functions exported to helper libraries and drivers and functions | |
183 | only used internally in the ``drm.ko`` module. The goal would be to move all | |
184 | header declarations not needed outside of ``drm.ko`` into | |
185 | ``drivers/gpu/drm/drm_*_internal.h`` header files. ``EXPORT_SYMBOL`` also | |
186 | needs to be dropped for these functions. | |
187 | ||
188 | This would nicely tie in with the below task to create kerneldoc after the API | |
189 | is cleaned up. Or with the "hide legacy cruft better" task. | |
190 | ||
191 | Note that this is well in progress, but ``drmP.h`` is still huge. The updated | |
192 | plan is to switch to per-file driver API headers, which will also structure | |
193 | the kerneldoc better. This should also allow more fine-grained ``#include`` | |
194 | directives. | |
195 | ||
196 | Contact: Daniel Vetter | |
197 | ||
198 | Add missing kerneldoc for exported functions | |
199 | -------------------------------------------- | |
200 | ||
201 | The DRM reference documentation is still lacking kerneldoc in a few areas. The | |
202 | task would be to clean up interfaces like moving functions around between | |
203 | files to better group them and improving the interfaces like dropping return | |
204 | values for functions that never fail. Then write kerneldoc for all exported | |
205 | functions and an overview section and integrate it all into the drm DocBook. | |
206 | ||
207 | See https://dri.freedesktop.org/docs/drm/ for what's there already. | |
208 | ||
209 | Contact: Daniel Vetter | |
210 | ||
211 | Hide legacy cruft better | |
212 | ------------------------ | |
213 | ||
214 | Way back DRM supported only drivers which shadow-attached to PCI devices with | |
215 | userspace or fbdev drivers setting up outputs. Modern DRM drivers take charge | |
216 | of the entire device, you can spot them with the DRIVER_MODESET flag. | |
217 | ||
218 | Unfortunately there's still large piles of legacy code around which needs to | |
219 | be hidden so that driver writers don't accidentally end up using it. And to | |
220 | prevent security issues in those legacy IOCTLs from being exploited on modern | |
221 | drivers. This has multiple possible subtasks: | |
222 | ||
223 | * Make sure legacy IOCTLs can't be used on modern drivers. | |
224 | * Extract support code for legacy features into a ``drm-legacy.ko`` kernel | |
225 | module and compile it only when one of the legacy drivers is enabled. | |
226 | * Extract legacy functions into their own headers and remove it that from the | |
227 | monolithic ``drmP.h`` header. | |
228 | * Remove any lingering cruft from the OS abstraction layer from modern | |
229 | drivers. | |
230 | ||
231 | This is mostly done, the only thing left is to split up ``drm_irq.c`` into | |
232 | legacy cruft and the parts needed by modern KMS drivers. | |
233 | ||
234 | Contact: Daniel Vetter | |
235 | ||
236 | Make panic handling work | |
237 | ------------------------ | |
238 | ||
239 | This is a really varied tasks with lots of little bits and pieces: | |
240 | ||
241 | * The panic path can't be tested currently, leading to constant breaking. The | |
242 | main issue here is that panics can be triggered from hardirq contexts and | |
243 | hence all panic related callback can run in hardirq context. It would be | |
244 | awesome if we could test at least the fbdev helper code and driver code by | |
245 | e.g. trigger calls through drm debugfs files. hardirq context could be | |
246 | achieved by using an IPI to the local processor. | |
247 | ||
248 | * There's a massive confusion of different panic handlers. DRM fbdev emulation | |
249 | helpers have one, but on top of that the fbcon code itself also has one. We | |
250 | need to make sure that they stop fighting over each another. | |
251 | ||
252 | * ``drm_can_sleep()`` is a mess. It hides real bugs in normal operations and | |
253 | isn't a full solution for panic paths. We need to make sure that it only | |
254 | returns true if there's a panic going on for real, and fix up all the | |
255 | fallout. | |
256 | ||
257 | * The panic handler must never sleep, which also means it can't ever | |
258 | ``mutex_lock()``. Also it can't grab any other lock unconditionally, not | |
259 | even spinlocks (because NMI and hardirq can panic too). We need to either | |
260 | make sure to not call such paths, or trylock everything. Really tricky. | |
261 | ||
262 | * For the above locking troubles reasons it's pretty much impossible to | |
263 | attempt a synchronous modeset from panic handlers. The only thing we could | |
264 | try to achive is an atomic ``set_base`` of the primary plane, and hope that | |
265 | it shows up. Everything else probably needs to be delayed to some worker or | |
266 | something else which happens later on. Otherwise it just kills the box | |
267 | harder, prevent the panic from going out on e.g. netconsole. | |
268 | ||
269 | * There's also proposal for a simplied DRM console instead of the full-blown | |
270 | fbcon and DRM fbdev emulation. Any kind of panic handling tricks should | |
271 | obviously work for both console, in case we ever get kmslog merged. | |
272 | ||
273 | Contact: Daniel Vetter | |
274 | ||
0cad7f71 DV |
275 | Clean up the debugfs support |
276 | ---------------------------- | |
277 | ||
278 | There's a bunch of issues with it: | |
279 | ||
280 | - The drm_info_list ->show() function doesn't even bother to cast to the drm | |
281 | structure for you. This is lazy. | |
282 | ||
283 | - We probably want to have some support for debugfs files on crtc/connectors and | |
284 | maybe other kms objects directly in core. There's even drm_print support in | |
285 | the funcs for these objects to dump kms state, so it's all there. And then the | |
286 | ->show() functions should obviously give you a pointer to the right object. | |
287 | ||
288 | - The drm_info_list stuff is centered on drm_minor instead of drm_device. For | |
289 | anything we want to print drm_device (or maybe drm_file) is the right thing. | |
290 | ||
291 | - The drm_driver->debugfs_init hooks we have is just an artifact of the old | |
292 | midlayered load sequence. DRM debugfs should work more like sysfs, where you | |
293 | can create properties/files for an object anytime you want, and the core | |
294 | takes care of publishing/unpuplishing all the files at register/unregister | |
295 | time. Drivers shouldn't need to worry about these technicalities, and fixing | |
296 | this (together with the drm_minor->drm_device move) would allow us to remove | |
297 | debugfs_init. | |
298 | ||
299 | Contact: Daniel Vetter | |
300 | ||
0e70dad0 TR |
301 | Better Testing |
302 | ============== | |
303 | ||
304 | Enable trinity for DRM | |
305 | ---------------------- | |
306 | ||
307 | And fix up the fallout. Should be really interesting ... | |
308 | ||
309 | Make KMS tests in i-g-t generic | |
310 | ------------------------------- | |
311 | ||
312 | The i915 driver team maintains an extensive testsuite for the i915 DRM driver, | |
313 | including tons of testcases for corner-cases in the modesetting API. It would | |
314 | be awesome if those tests (at least the ones not relying on Intel-specific GEM | |
315 | features) could be made to run on any KMS driver. | |
316 | ||
317 | Basic work to run i-g-t tests on non-i915 is done, what's now missing is mass- | |
318 | converting things over. For modeset tests we also first need a bit of | |
319 | infrastructure to use dumb buffers for untiled buffers, to be able to run all | |
320 | the non-i915 specific modeset tests. | |
321 | ||
322 | Contact: Daniel Vetter | |
323 | ||
324 | Create a virtual KMS driver for testing (vkms) | |
325 | ---------------------------------------------- | |
326 | ||
327 | With all the latest helpers it should be fairly simple to create a virtual KMS | |
328 | driver useful for testing, or for running X or similar on headless machines | |
329 | (to be able to still use the GPU). This would be similar to vgem, but aimed at | |
330 | the modeset side. | |
331 | ||
332 | Once the basics are there there's tons of possibilities to extend it. | |
333 | ||
334 | Contact: Daniel Vetter | |
335 | ||
336 | Driver Specific | |
337 | =============== | |
338 | ||
339 | Outside DRM | |
340 | =========== | |
341 | ||
342 | Better kerneldoc | |
343 | ---------------- | |
344 | ||
345 | This is pretty much done, but there's some advanced topics: | |
346 | ||
347 | Come up with a way to hyperlink to struct members. Currently you can hyperlink | |
348 | to the struct using ``#struct_name``, but not to a member within. Would need | |
349 | buy-in from kerneldoc maintainers, and the big question is how to make it work | |
350 | without totally unsightly | |
351 | ``drm_foo_bar_really_long_structure->even_longer_memeber`` all over the text | |
352 | which breaks text flow. | |
353 | ||
354 | Figure out how to integrate the asciidoc support for ascii-diagrams. We have a | |
355 | few of those (e.g. to describe mode timings), and asciidoc supports converting | |
356 | some ascii-art dialect into pngs. Would be really pretty to make that work. | |
357 | ||
358 | Contact: Daniel Vetter, Jani Nikula | |
359 | ||
360 | Jani is working on this already, hopefully lands in 4.8. |