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

drm: Clarify DRM_MODE_REFLECT_X/Y documentation

DRM_MODE_REFLECT_X and DRM_MODE_REFLECT_Y meaning seems a bit unclear
to me, so try to clarify that with a bit of ascii graphics.

Changes since v1:
- Move the ascii graphics in the kerneldoc where all plane
properties are already documented and make sure it's properly
rendered, suggestested by Daniel Vetter.

Signed-off-by: Alexandru Gheorghe <alexandru-cosmin.gheorghe@arm.com>
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/20180910172946.18539-1-alexandru-cosmin.gheorghe@arm.com

+24 -1
+22
drivers/gpu/drm/drm_blend.c
··· 101 101 * Without this property the rectangle is only scaled, but not rotated or 102 102 * reflected. 103 103 * 104 + * Possbile values: 105 + * 106 + * "rotate-<degrees>": 107 + * Signals that a drm plane is rotated <degrees> degrees in counter 108 + * clockwise direction. 109 + * 110 + * "reflect-<axis>": 111 + * Signals that the contents of a drm plane is reflected along the 112 + * <axis> axis, in the same way as mirroring. 113 + * 114 + * reflect-x:: 115 + * 116 + * |o | | o| 117 + * | | -> | | 118 + * | v| |v | 119 + * 120 + * reflect-y:: 121 + * 122 + * |o | | ^| 123 + * | | -> | | 124 + * | v| |o | 125 + * 104 126 * zpos: 105 127 * Z position is set up with drm_plane_create_zpos_immutable_property() and 106 128 * drm_plane_create_zpos_property(). It controls the visibility of overlapping
+2 -1
include/uapi/drm/drm_mode.h
··· 186 186 /* 187 187 * DRM_MODE_REFLECT_<axis> 188 188 * 189 - * Signals that the contents of a drm plane is reflected in the <axis> axis, 189 + * Signals that the contents of a drm plane is reflected along the <axis> axis, 190 190 * in the same way as mirroring. 191 + * See kerneldoc chapter "Plane Composition Properties" for more details. 191 192 * 192 193 * This define is provided as a convenience, looking up the property id 193 194 * using the name->prop id lookup is the preferred method.