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

drm: document drm_mode_modeinfo

This allows `struct drm_mode_modeinfo` references to be linkified.

Some descriptions are borrowed from struct drm_display_mode.

Signed-off-by: Simon Ser <contact@emersion.fr>
Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Link: https://patchwork.freedesktop.org/patch/msgid/BBtyuxgs3DvcrMtbRyb7KBEWUviGy1dtWO61eB4@cp3-web-016.plabs.ch

+24
+3
include/drm/drm_modes.h
··· 195 195 * @crtc_vsync_end: hardware mode vertical sync end 196 196 * @crtc_vtotal: hardware mode vertical total size 197 197 * 198 + * This is the kernel API display mode information structure. For the 199 + * user-space version see struct drm_mode_modeinfo. 200 + * 198 201 * The horizontal and vertical timings are defined per the following diagram. 199 202 * 200 203 * ::
+21
include/uapi/drm/drm_mode.h
··· 218 218 #define DRM_MODE_CONTENT_PROTECTION_DESIRED 1 219 219 #define DRM_MODE_CONTENT_PROTECTION_ENABLED 2 220 220 221 + /** 222 + * struct drm_mode_modeinfo - Display mode information. 223 + * @clock: pixel clock in kHz 224 + * @hdisplay: horizontal display size 225 + * @hsync_start: horizontal sync start 226 + * @hsync_end: horizontal sync end 227 + * @htotal: horizontal total size 228 + * @hskew: horizontal skew 229 + * @vdisplay: vertical display size 230 + * @vsync_start: vertical sync start 231 + * @vsync_end: vertical sync end 232 + * @vtotal: vertical total size 233 + * @vscan: vertical scan 234 + * @vrefresh: approximate vertical refresh rate in Hz 235 + * @flags: bitmask of misc. flags, see DRM_MODE_FLAG_* defines 236 + * @type: bitmask of type flags, see DRM_MODE_TYPE_* defines 237 + * @name: string describing the mode resolution 238 + * 239 + * This is the user-space API display mode information structure. For the 240 + * kernel version see struct drm_display_mode. 241 + */ 221 242 struct drm_mode_modeinfo { 222 243 __u32 clock; 223 244 __u16 hdisplay;