Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

drm: docs: Update task from drm TODO list

Update TODO item from drm documentation to contain more applicable
information regarding the removal of deprecated MIPI DSI functions and
no longer reference functions which have already been removed from the
kernel.

Reviewed-by: Douglas Anderson <dianders@chromium.org>
Signed-off-by: Brigham Campbell <me@brighamcampbell.com>
Signed-off-by: Douglas Anderson <dianders@chromium.org>
Link: https://lore.kernel.org/r/20250722015313.561966-5-me@brighamcampbell.com

authored by

Brigham Campbell and committed by
Douglas Anderson
85c23f28 79b6bb18

+11 -11
+11 -11
Documentation/gpu/todo.rst
··· 497 497 498 498 Level: Intermediate 499 499 500 - Transition away from using mipi_dsi_*_write_seq() 501 - ------------------------------------------------- 500 + Transition away from using deprecated MIPI DSI functions 501 + -------------------------------------------------------- 502 502 503 - The macros mipi_dsi_generic_write_seq() and mipi_dsi_dcs_write_seq() are 504 - non-intuitive because, if there are errors, they return out of the *caller's* 505 - function. We should move all callers to use mipi_dsi_generic_write_seq_multi() 506 - and mipi_dsi_dcs_write_seq_multi() macros instead. 503 + There are many functions defined in ``drm_mipi_dsi.c`` which have been 504 + deprecated. Each deprecated function was deprecated in favor of its `multi` 505 + variant (e.g. `mipi_dsi_generic_write()` and `mipi_dsi_generic_write_multi()`). 506 + The `multi` variant of a function includes improved error handling and logic 507 + which makes it more convenient to make several calls in a row, as most MIPI 508 + drivers do. 507 509 508 - Once all callers are transitioned, the macros and the functions that they call, 509 - mipi_dsi_generic_write_chatty() and mipi_dsi_dcs_write_buffer_chatty(), can 510 - probably be removed. Alternatively, if people feel like the _multi() variants 511 - are overkill for some use cases, we could keep the mipi_dsi_*_write_seq() 512 - variants but change them not to return out of the caller. 510 + Drivers should be updated to use undeprecated functions. Once all usages of the 511 + deprecated MIPI DSI functions have been removed, their definitions may be 512 + removed from ``drm_mipi_dsi.c``. 513 513 514 514 Contact: Douglas Anderson <dianders@chromium.org> 515 515