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

drm/atomic-helper: Make zpos property kerneldoc less misleading

kerneldoc for drm_plane_create_zpos_property() says that the DRM core
will automatically calculate the normalized zpos values, but it doesn't
actually do that anymore since commit 38d868e41c4b ("drm: Don't force
all planes to be added to the state due to zpos"). Instead, drivers are
supposed to explicitly call the drm_atomic_normalize_zpos() function.
Change the kerneldoc comment to reflect that.

v2: reference the commit that introduced the kerneldoc unclarity

Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Thierry Reding <treding@nvidia.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20171120150959.26913-1-thierry.reding@gmail.com

+5 -3
+5 -3
drivers/gpu/drm/drm_blend.c
··· 214 214 * This function initializes generic mutable zpos property and enables support 215 215 * for it in drm core. Drivers can then attach this property to planes to enable 216 216 * support for configurable planes arrangement during blending operation. 217 - * Once mutable zpos property has been enabled, the DRM core will automatically 218 - * calculate &drm_plane_state.normalized_zpos values. Usually min should be set 219 - * to 0 and max to maximal number of planes for given crtc - 1. 217 + * Drivers that attach a mutable zpos property to any plane should call the 218 + * drm_atomic_normalize_zpos() helper during their implementation of 219 + * &drm_mode_config_funcs.atomic_check(), which will update the normalized zpos 220 + * values and store them in &drm_plane_state.normalized_zpos. Usually min 221 + * should be set to 0 and max to maximal number of planes for given crtc - 1. 220 222 * 221 223 * If zpos of some planes cannot be changed (like fixed background or 222 224 * cursor/topmost planes), driver should adjust min/max values and assign those