From mboxrd@z Thu Jan 1 00:00:00 1970 From: Sean Paul Date: Wed, 29 May 2019 14:35:37 +0000 Subject: Re: [PATCH] drm: Fix docbook warnings in hdr metadata helper structures Message-Id: <20190529143537.GF17077@art_vandelay> List-Id: References: <1559141030-4386-1-git-send-email-uma.shankar@intel.com> In-Reply-To: <1559141030-4386-1-git-send-email-uma.shankar@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable To: Uma Shankar Cc: linux-fbdev@vger.kernel.org, Bartlomiej Zolnierkiewicz , Maxime Ripard , intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org, Hans Verkuil , David Airlie On Wed, May 29, 2019 at 08:13:50PM +0530, Uma Shankar wrote: > 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 membe= r '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' >=20 > Also adds some property documentation for HDR Metadata Connector > Property in connector property create function. >=20 > Cc: Shashank Sharma > Cc: Ville Syrj=E4l=E4 > Cc: Maarten Lankhorst > Cc: Maxime Ripard > Cc: Sean Paul > Cc: David Airlie > Cc: Daniel Vetter > Cc: Bartlomiej Zolnierkiewicz > Cc: "Ville Syrj=E4l=E4" > Cc: Hans Verkuil > Cc: dri-devel@lists.freedesktop.org > Cc: linux-fbdev@vger.kernel.org > Signed-off-by: Uma Shankar > --- > drivers/gpu/drm/drm_connector.c | 8 ++++++++ > include/drm/drm_connector.h | 3 ++- > include/drm/drm_mode_config.h | 2 +- > include/linux/hdmi.h | 1 + > 4 files changed, 12 insertions(+), 2 deletions(-) >=20 > diff --git a/drivers/gpu/drm/drm_connector.c b/drivers/gpu/drm/drm_connec= tor.c > index c9ac8b9..702307c 100644 > --- a/drivers/gpu/drm/drm_connector.c > +++ b/drivers/gpu/drm/drm_connector.c > @@ -1003,6 +1003,14 @@ int drm_display_info_set_bus_formats(struct drm_di= splay_info *info, > * can also expose this property to external outputs, in which case they > * must support "None", which should be the default (since external scre= ens > * have a built-in scaler). > + * > + * HDR_OUTPUT_METADATA: > + * Connector property to enable userspace to send HDR Metadata to driver. > + * This metadata is based on the composition and blending policies decid= ed > + * by user, taking into account the hardware and sink capabilties. capabilities > + * The driver gets this metadata and creates a Dynamic Range and Masteri= ng > + * Infoframe (DRM) which is then sent to sink. This notifies the sink of > + * the upcoming frame's Color Encoding and Luminance parameters. > */ > =20 > int drm_connector_create_standard_properties(struct drm_device *dev) > diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h > index f8f4003..f226ef0 100644 > --- a/include/drm/drm_connector.h > +++ b/include/drm/drm_connector.h > @@ -1244,8 +1244,9 @@ struct drm_connector { > */ > struct llist_node free_node; > =20 > - /* HDR metdata */ > + /** @hdr_output_metadata: HDR Metadata to be sent to sink */ > struct hdr_output_metadata hdr_output_metadata; > + /** @hdr_sink_metadata: HDR Metadata Information read from sink */ > struct hdr_sink_metadata hdr_sink_metadata; > }; > =20 > diff --git a/include/drm/drm_mode_config.h b/include/drm/drm_mode_config.h > index 4f88cc9..0b180e0 100644 > --- a/include/drm/drm_mode_config.h > +++ b/include/drm/drm_mode_config.h > @@ -837,7 +837,7 @@ struct drm_mode_config { > struct drm_property *writeback_out_fence_ptr_property; > =20 > /** > - * hdr_output_metadata_property: Connector property containing hdr > + * @hdr_output_metadata_property: Connector property containing hdr > * metatda. This will be provided by userspace compositors based May as well fix the spelling of "metadata" while you're here. > * on HDR content > */ > diff --git a/include/linux/hdmi.h b/include/linux/hdmi.h > index ee55ba5..ea5858e 100644 > --- a/include/linux/hdmi.h > +++ b/include/linux/hdmi.h > @@ -398,6 +398,7 @@ ssize_t hdmi_vendor_infoframe_pack_only(const struct = hdmi_vendor_infoframe *fram > * @spd: spd infoframe > * @vendor: union of all vendor infoframes > * @audio: audio infoframe > + * @drm: DRM infoframe Can you spell this out here so it's unambiguous which DRM you're talking ab= out? With the nits fixed, Reviewed-by: Sean Paul > * > * This is used by the generic pack function. This works since all infof= rames > * have the same header which also indicates which type of infoframe sho= uld be > --=20 > 1.9.1 >=20 --=20 Sean Paul, Software Engineer, Google / Chromium OS From mboxrd@z Thu Jan 1 00:00:00 1970 From: Sean Paul Subject: Re: [PATCH] drm: Fix docbook warnings in hdr metadata helper structures Date: Wed, 29 May 2019 10:35:37 -0400 Message-ID: <20190529143537.GF17077@art_vandelay> References: <1559141030-4386-1-git-send-email-uma.shankar@intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: base64 Return-path: Content-Disposition: inline In-Reply-To: <1559141030-4386-1-git-send-email-uma.shankar@intel.com> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: intel-gfx-bounces@lists.freedesktop.org Sender: "Intel-gfx" To: Uma Shankar Cc: linux-fbdev@vger.kernel.org, Bartlomiej Zolnierkiewicz , Maxime Ripard , intel-gfx@lists.freedesktop.org, dri-devel@lists.freedesktop.org, Hans Verkuil , David Airlie List-Id: dri-devel@lists.freedesktop.org T24gV2VkLCBNYXkgMjksIDIwMTkgYXQgMDg6MTM6NTBQTSArMDUzMCwgVW1hIFNoYW5rYXIgd3Jv dGU6Cj4gRml4ZXMgdGhlIGZvbGxvd2luZyB3YXJuaW5nczoKPiAuL2luY2x1ZGUvZHJtL2RybV9t b2RlX2NvbmZpZy5oOjg0MTogd2FybmluZzogSW5jb3JyZWN0IHVzZSBvZgo+IGtlcm5lbC1kb2Mg Zm9ybWF0OiAgICAgICAgICAqIGhkcl9vdXRwdXRfbWV0YWRhdGFfcHJvcGVydHk6IENvbm5lY3Rv cgo+IHByb3BlcnR5IGNvbnRhaW5pbmcgaGRyCj4gLi9pbmNsdWRlL2RybS9kcm1fbW9kZV9jb25m aWcuaDo5MTg6IHdhcm5pbmc6IEZ1bmN0aW9uIHBhcmFtZXRlciBvciBtZW1iZXIgJ2hkcl9vdXRw dXRfbWV0YWRhdGFfcHJvcGVydHknIG5vdCBkZXNjcmliZWQgaW4gJ2RybV9tb2RlX2NvbmZpZycK PiAuL2luY2x1ZGUvZHJtL2RybV9jb25uZWN0b3IuaDoxMjUxOiB3YXJuaW5nOiBGdW5jdGlvbiBw YXJhbWV0ZXIgb3IgbWVtYmVyICdoZHJfb3V0cHV0X21ldGFkYXRhJyBub3QgZGVzY3JpYmVkIGlu ICdkcm1fY29ubmVjdG9yJwo+IC4vaW5jbHVkZS9kcm0vZHJtX2Nvbm5lY3Rvci5oOjEyNTE6IHdh cm5pbmc6IEZ1bmN0aW9uIHBhcmFtZXRlciBvciBtZW1iZXIgJ2hkcl9zaW5rX21ldGFkYXRhJyBu b3QgZGVzY3JpYmVkIGluICdkcm1fY29ubmVjdG9yJwo+IAo+IEFsc28gYWRkcyBzb21lIHByb3Bl cnR5IGRvY3VtZW50YXRpb24gZm9yIEhEUiBNZXRhZGF0YSBDb25uZWN0b3IKPiBQcm9wZXJ0eSBp biBjb25uZWN0b3IgcHJvcGVydHkgY3JlYXRlIGZ1bmN0aW9uLgo+IAo+IENjOiBTaGFzaGFuayBT aGFybWEgPHNoYXNoYW5rLnNoYXJtYUBpbnRlbC5jb20+Cj4gQ2M6IFZpbGxlIFN5cmrDpGzDpCA8 dmlsbGUuc3lyamFsYUBsaW51eC5pbnRlbC5jb20+Cj4gQ2M6IE1hYXJ0ZW4gTGFua2hvcnN0IDxt YWFydGVuLmxhbmtob3JzdEBsaW51eC5pbnRlbC5jb20+Cj4gQ2M6IE1heGltZSBSaXBhcmQgPG1h eGltZS5yaXBhcmRAYm9vdGxpbi5jb20+Cj4gQ2M6IFNlYW4gUGF1bCA8c2VhbkBwb29ybHkucnVu Pgo+IENjOiBEYXZpZCBBaXJsaWUgPGFpcmxpZWRAbGludXguaWU+Cj4gQ2M6IERhbmllbCBWZXR0 ZXIgPGRhbmllbEBmZndsbC5jaD4KPiBDYzogQmFydGxvbWllaiBab2xuaWVya2lld2ljeiA8Yi56 b2xuaWVya2llQHNhbXN1bmcuY29tPgo+IENjOiAiVmlsbGUgU3lyasOkbMOkIiA8dmlsbGUuc3ly amFsYUBsaW51eC5pbnRlbC5jb20+Cj4gQ2M6IEhhbnMgVmVya3VpbCA8aGFuc3ZlcmtAY2lzY28u Y29tPgo+IENjOiBkcmktZGV2ZWxAbGlzdHMuZnJlZWRlc2t0b3Aub3JnCj4gQ2M6IGxpbnV4LWZi ZGV2QHZnZXIua2VybmVsLm9yZwo+IFNpZ25lZC1vZmYtYnk6IFVtYSBTaGFua2FyIDx1bWEuc2hh bmthckBpbnRlbC5jb20+Cj4gLS0tCj4gIGRyaXZlcnMvZ3B1L2RybS9kcm1fY29ubmVjdG9yLmMg fCA4ICsrKysrKysrCj4gIGluY2x1ZGUvZHJtL2RybV9jb25uZWN0b3IuaCAgICAgfCAzICsrLQo+ ICBpbmNsdWRlL2RybS9kcm1fbW9kZV9jb25maWcuaCAgIHwgMiArLQo+ICBpbmNsdWRlL2xpbnV4 L2hkbWkuaCAgICAgICAgICAgIHwgMSArCj4gIDQgZmlsZXMgY2hhbmdlZCwgMTIgaW5zZXJ0aW9u cygrKSwgMiBkZWxldGlvbnMoLSkKPiAKPiBkaWZmIC0tZ2l0IGEvZHJpdmVycy9ncHUvZHJtL2Ry bV9jb25uZWN0b3IuYyBiL2RyaXZlcnMvZ3B1L2RybS9kcm1fY29ubmVjdG9yLmMKPiBpbmRleCBj OWFjOGI5Li43MDIzMDdjIDEwMDY0NAo+IC0tLSBhL2RyaXZlcnMvZ3B1L2RybS9kcm1fY29ubmVj dG9yLmMKPiArKysgYi9kcml2ZXJzL2dwdS9kcm0vZHJtX2Nvbm5lY3Rvci5jCj4gQEAgLTEwMDMs NiArMTAwMywxNCBAQCBpbnQgZHJtX2Rpc3BsYXlfaW5mb19zZXRfYnVzX2Zvcm1hdHMoc3RydWN0 IGRybV9kaXNwbGF5X2luZm8gKmluZm8sCj4gICAqCWNhbiBhbHNvIGV4cG9zZSB0aGlzIHByb3Bl cnR5IHRvIGV4dGVybmFsIG91dHB1dHMsIGluIHdoaWNoIGNhc2UgdGhleQo+ICAgKgltdXN0IHN1 cHBvcnQgIk5vbmUiLCB3aGljaCBzaG91bGQgYmUgdGhlIGRlZmF1bHQgKHNpbmNlIGV4dGVybmFs IHNjcmVlbnMKPiAgICoJaGF2ZSBhIGJ1aWx0LWluIHNjYWxlcikuCj4gKyAqCj4gKyAqIEhEUl9P VVRQVVRfTUVUQURBVEE6Cj4gKyAqCUNvbm5lY3RvciBwcm9wZXJ0eSB0byBlbmFibGUgdXNlcnNw YWNlIHRvIHNlbmQgSERSIE1ldGFkYXRhIHRvIGRyaXZlci4KPiArICoJVGhpcyBtZXRhZGF0YSBp cyBiYXNlZCBvbiB0aGUgY29tcG9zaXRpb24gYW5kIGJsZW5kaW5nIHBvbGljaWVzIGRlY2lkZWQK PiArICoJYnkgdXNlciwgdGFraW5nIGludG8gYWNjb3VudCB0aGUgaGFyZHdhcmUgYW5kIHNpbmsg Y2FwYWJpbHRpZXMuCgpjYXBhYmlsaXRpZXMKCj4gKyAqCVRoZSBkcml2ZXIgZ2V0cyB0aGlzIG1l dGFkYXRhIGFuZCBjcmVhdGVzIGEgRHluYW1pYyBSYW5nZSBhbmQgTWFzdGVyaW5nCj4gKyAqCUlu Zm9mcmFtZSAoRFJNKSB3aGljaCBpcyB0aGVuIHNlbnQgdG8gc2luay4gVGhpcyBub3RpZmllcyB0 aGUgc2luayBvZgo+ICsgKgl0aGUgdXBjb21pbmcgZnJhbWUncyBDb2xvciBFbmNvZGluZyBhbmQg THVtaW5hbmNlIHBhcmFtZXRlcnMuCj4gICAqLwo+ICAKPiAgaW50IGRybV9jb25uZWN0b3JfY3Jl YXRlX3N0YW5kYXJkX3Byb3BlcnRpZXMoc3RydWN0IGRybV9kZXZpY2UgKmRldikKPiBkaWZmIC0t Z2l0IGEvaW5jbHVkZS9kcm0vZHJtX2Nvbm5lY3Rvci5oIGIvaW5jbHVkZS9kcm0vZHJtX2Nvbm5l Y3Rvci5oCj4gaW5kZXggZjhmNDAwMy4uZjIyNmVmMCAxMDA2NDQKPiAtLS0gYS9pbmNsdWRlL2Ry bS9kcm1fY29ubmVjdG9yLmgKPiArKysgYi9pbmNsdWRlL2RybS9kcm1fY29ubmVjdG9yLmgKPiBA QCAtMTI0NCw4ICsxMjQ0LDkgQEAgc3RydWN0IGRybV9jb25uZWN0b3Igewo+ICAJICovCj4gIAlz dHJ1Y3QgbGxpc3Rfbm9kZSBmcmVlX25vZGU7Cj4gIAo+IC0JLyogSERSIG1ldGRhdGEgKi8KPiAr CS8qKiBAaGRyX291dHB1dF9tZXRhZGF0YTogSERSIE1ldGFkYXRhIHRvIGJlIHNlbnQgdG8gc2lu ayAqLwo+ICAJc3RydWN0IGhkcl9vdXRwdXRfbWV0YWRhdGEgaGRyX291dHB1dF9tZXRhZGF0YTsK PiArCS8qKiBAaGRyX3NpbmtfbWV0YWRhdGE6IEhEUiBNZXRhZGF0YSBJbmZvcm1hdGlvbiByZWFk IGZyb20gc2luayAqLwo+ICAJc3RydWN0IGhkcl9zaW5rX21ldGFkYXRhIGhkcl9zaW5rX21ldGFk YXRhOwo+ICB9Owo+ICAKPiBkaWZmIC0tZ2l0IGEvaW5jbHVkZS9kcm0vZHJtX21vZGVfY29uZmln LmggYi9pbmNsdWRlL2RybS9kcm1fbW9kZV9jb25maWcuaAo+IGluZGV4IDRmODhjYzkuLjBiMTgw ZTAgMTAwNjQ0Cj4gLS0tIGEvaW5jbHVkZS9kcm0vZHJtX21vZGVfY29uZmlnLmgKPiArKysgYi9p bmNsdWRlL2RybS9kcm1fbW9kZV9jb25maWcuaAo+IEBAIC04MzcsNyArODM3LDcgQEAgc3RydWN0 IGRybV9tb2RlX2NvbmZpZyB7Cj4gIAlzdHJ1Y3QgZHJtX3Byb3BlcnR5ICp3cml0ZWJhY2tfb3V0 X2ZlbmNlX3B0cl9wcm9wZXJ0eTsKPiAgCj4gIAkvKioKPiAtCSAqIGhkcl9vdXRwdXRfbWV0YWRh dGFfcHJvcGVydHk6IENvbm5lY3RvciBwcm9wZXJ0eSBjb250YWluaW5nIGhkcgo+ICsJICogQGhk cl9vdXRwdXRfbWV0YWRhdGFfcHJvcGVydHk6IENvbm5lY3RvciBwcm9wZXJ0eSBjb250YWluaW5n IGhkcgo+ICAJICogbWV0YXRkYS4gVGhpcyB3aWxsIGJlIHByb3ZpZGVkIGJ5IHVzZXJzcGFjZSBj b21wb3NpdG9ycyBiYXNlZAoKTWF5IGFzIHdlbGwgZml4IHRoZSBzcGVsbGluZyBvZiAibWV0YWRh dGEiIHdoaWxlIHlvdSdyZSBoZXJlLgoKPiAgCSAqIG9uIEhEUiBjb250ZW50Cj4gIAkgKi8KPiBk aWZmIC0tZ2l0IGEvaW5jbHVkZS9saW51eC9oZG1pLmggYi9pbmNsdWRlL2xpbnV4L2hkbWkuaAo+ IGluZGV4IGVlNTViYTUuLmVhNTg1OGUgMTAwNjQ0Cj4gLS0tIGEvaW5jbHVkZS9saW51eC9oZG1p LmgKPiArKysgYi9pbmNsdWRlL2xpbnV4L2hkbWkuaAo+IEBAIC0zOTgsNiArMzk4LDcgQEAgc3Np emVfdCBoZG1pX3ZlbmRvcl9pbmZvZnJhbWVfcGFja19vbmx5KGNvbnN0IHN0cnVjdCBoZG1pX3Zl bmRvcl9pbmZvZnJhbWUgKmZyYW0KPiAgICogQHNwZDogc3BkIGluZm9mcmFtZQo+ICAgKiBAdmVu ZG9yOiB1bmlvbiBvZiBhbGwgdmVuZG9yIGluZm9mcmFtZXMKPiAgICogQGF1ZGlvOiBhdWRpbyBp bmZvZnJhbWUKPiArICogQGRybTogRFJNIGluZm9mcmFtZQoKQ2FuIHlvdSBzcGVsbCB0aGlzIG91 dCBoZXJlIHNvIGl0J3MgdW5hbWJpZ3VvdXMgd2hpY2ggRFJNIHlvdSdyZSB0YWxraW5nIGFib3V0 PwoKV2l0aCB0aGUgbml0cyBmaXhlZCwKClJldmlld2VkLWJ5OiBTZWFuIFBhdWwgPHNlYW5AcG9v cmx5LnJ1bj4KCgo+ICAgKgo+ICAgKiBUaGlzIGlzIHVzZWQgYnkgdGhlIGdlbmVyaWMgcGFjayBm dW5jdGlvbi4gVGhpcyB3b3JrcyBzaW5jZSBhbGwgaW5mb2ZyYW1lcwo+ICAgKiBoYXZlIHRoZSBz YW1lIGhlYWRlciB3aGljaCBhbHNvIGluZGljYXRlcyB3aGljaCB0eXBlIG9mIGluZm9mcmFtZSBz aG91bGQgYmUKPiAtLSAKPiAxLjkuMQo+IAoKLS0gClNlYW4gUGF1bCwgU29mdHdhcmUgRW5naW5l ZXIsIEdvb2dsZSAvIENocm9taXVtIE9TCl9fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19f X19fX19fX19fX19fX19fCkludGVsLWdmeCBtYWlsaW5nIGxpc3QKSW50ZWwtZ2Z4QGxpc3RzLmZy ZWVkZXNrdG9wLm9yZwpodHRwczovL2xpc3RzLmZyZWVkZXNrdG9wLm9yZy9tYWlsbWFuL2xpc3Rp bmZvL2ludGVsLWdmeA==