drm: Fix docbook warnings in hdr metadata helper structures
Fixes the following warnings: ./include/drm/drm_mode_config.h:841: warning: Incorrect use of kernel-doc format: * hdr_output_metadata_property: Connector property containing hdr ./include/drm/drm_mode_config.h:918: warning: Function parameter or member 'hdr_output_metadata_property' not described in 'drm_mode_config' ./include/drm/drm_connector.h:1251: warning: Function parameter or member 'hdr_output_metadata' not described in 'drm_connector' ./include/drm/drm_connector.h:1251: warning: Function parameter or member 'hdr_sink_metadata' not described in 'drm_connector' Also adds some property documentation for HDR Metadata Connector Property in connector property create function. v2: Fixed Sean Paul's review comments. v3: Fixed Daniel Vetter's review comments, added the UAPI structure definition section in kernel docs. v4: Fixed Daniel Vetter's review comments. v5: Added structure member references as per Daniel's suggestion. Cc: Shashank Sharma <shashank.sharma@intel.com> Cc: Ville Syrjä <ville.syrjala@linux.intel.com> Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com> Cc: Maxime Ripard <maxime.ripard@bootlin.com> Cc: Sean Paul <sean@poorly.run> Cc: David Airlie <airlied@linux.ie> Cc: Daniel Vetter <daniel@ffwll.ch> Cc: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com> Cc: "Ville Syrjä" <ville.syrjala@linux.intel.com> Cc: Hans Verkuil <hansverk@cisco.com> Cc: dri-devel@lists.freedesktop.org Cc: linux-fbdev@vger.kernel.org Reviewed-by: Sean Paul <sean@poorly.run> (v1) Signed-off-by: Uma Shankar <uma.shankar@intel.com> [danvet: Fix up markup: () for functions, & for structs. Style guide also recommends to prepend struct for structures.] Signed-off-by: Daniel Vetter <daniel.vetter@ffwll.ch> Link: https://patchwork.freedesktop.org/patch/msgid/1559647022-7336-1-git-send-email-uma.shankar@intel.com
This commit is contained in:
committed by
Daniel Vetter
parent
309aa92636
commit
a09db883e5
@@ -956,6 +956,46 @@ static const struct drm_prop_enum_list hdmi_colorspaces[] = {
|
||||
* is no longer protected and userspace should take appropriate action
|
||||
* (whatever that might be).
|
||||
*
|
||||
* HDR_OUTPUT_METADATA:
|
||||
* Connector property to enable userspace to send HDR Metadata to
|
||||
* driver. This metadata is based on the composition and blending
|
||||
* policies decided by user, taking into account the hardware and
|
||||
* sink capabilities. The driver gets this metadata and creates a
|
||||
* Dynamic Range and Mastering Infoframe (DRM) in case of HDMI,
|
||||
* SDP packet (Non-audio INFOFRAME SDP v1.3) for DP. This is then
|
||||
* sent to sink. This notifies the sink of the upcoming frame's Color
|
||||
* Encoding and Luminance parameters.
|
||||
*
|
||||
* Userspace first need to detect the HDR capabilities of sink by
|
||||
* reading and parsing the EDID. Details of HDR metadata for HDMI
|
||||
* are added in CTA 861.G spec. For DP , its defined in VESA DP
|
||||
* Standard v1.4. It needs to then get the metadata information
|
||||
* of the video/game/app content which are encoded in HDR (basically
|
||||
* using HDR transfer functions). With this information it needs to
|
||||
* decide on a blending policy and compose the relevant
|
||||
* layers/overlays into a common format. Once this blending is done,
|
||||
* userspace will be aware of the metadata of the composed frame to
|
||||
* be send to sink. It then uses this property to communicate this
|
||||
* metadata to driver which then make a Infoframe packet and sends
|
||||
* to sink based on the type of encoder connected.
|
||||
*
|
||||
* Userspace will be responsible to do Tone mapping operation in case:
|
||||
* - Some layers are HDR and others are SDR
|
||||
* - HDR layers luminance is not same as sink
|
||||
* It will even need to do colorspace conversion and get all layers
|
||||
* to one common colorspace for blending. It can use either GL, Media
|
||||
* or display engine to get this done based on the capabilties of the
|
||||
* associated hardware.
|
||||
*
|
||||
* Driver expects metadata to be put in &struct hdr_output_metadata
|
||||
* structure from userspace. This is received as blob and stored in
|
||||
* &drm_connector_state.hdr_output_metadata. It parses EDID and saves the
|
||||
* sink metadata in &struct hdr_sink_metadata, as
|
||||
* &drm_connector.hdr_sink_metadata. Driver uses
|
||||
* drm_hdmi_infoframe_set_hdr_metadata() helper to set the HDR metadata,
|
||||
* hdmi_drm_infoframe_pack() to pack the infoframe as per spec, in case of
|
||||
* HDMI encoder.
|
||||
*
|
||||
* max bpc:
|
||||
* This range property is used by userspace to limit the bit depth. When
|
||||
* used the driver would limit the bpc in accordance with the valid range
|
||||
|
||||
Reference in New Issue
Block a user