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

drm/docs: Include hdmi infoframe helper reference

Thierry created such nice kerneldocs, it's a shame we've left them
lingering!

For the fun of it also add a bit of kerneldoc to the header so that we
can also include that. Just in case someone adds kerneldoc in there.

Cc: Thierry Reding <thierry.reding@gmail.com>
Reviewed-by: Alex Deucher <alexander.deucher@amd.com>
Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch>

+23
+11
Documentation/DocBook/drm.tmpl
··· 2219 2219 !Iinclude/drm/drm_flip_work.h 2220 2220 !Edrivers/gpu/drm/drm_flip_work.c 2221 2221 </sect2> 2222 + <sect2> 2223 + <title>HDMI Infoframes Helper Reference</title> 2224 + <para> 2225 + Strictly speaking this is not a DRM helper library but generally useable 2226 + by any driver interfacing with HDMI outputs like v4l or alsa drivers. 2227 + But it nicely fits into the overall topic of mode setting helper 2228 + libraries and hence is also included here. 2229 + </para> 2230 + !Iinclude/linux/hdmi.h 2231 + !Edrivers/video/hdmi.c 2232 + </sect2> 2222 2233 </sect1> 2223 2234 2224 2235 <!-- Internals: kms properties -->
+12
include/linux/hdmi.h
··· 262 262 struct hdmi_vendor_infoframe hdmi; 263 263 }; 264 264 265 + /** 266 + * union hdmi_infoframe - overall union of all abstract infoframe representations 267 + * @any: generic infoframe 268 + * @avi: avi infoframe 269 + * @spd: spd infoframe 270 + * @vendor: union of all vendor infoframes 271 + * @audio: audio infoframe 272 + * 273 + * This is used by the generic pack function. This works since all infoframes 274 + * have the same header which also indicates which type of infoframe should be 275 + * packed. 276 + */ 265 277 union hdmi_infoframe { 266 278 struct hdmi_any_infoframe any; 267 279 struct hdmi_avi_infoframe avi;