[PATCH] drm: fix doc warnings related to drm connector

[PATCH] drm: fix doc warnings related to drm connector

[Bragatheswaran Manickavel]

Addressing drm dp/hdmi connector related kernel documentation
warning and add more information about these values.

Signed-off-by: Bragatheswaran Manickavel <bragathemanick0908@gmail.com>
---
 drivers/gpu/drm/drm_connector.c | 2 ++
 include/drm/drm_connector.h     | 2 ++
 2 files changed, 4 insertions(+)

diff --git a/drivers/gpu/drm/drm_connector.c b/drivers/gpu/drm/drm_connector.c
index bf8371dc2a61..084c95785dda 100644
--- a/drivers/gpu/drm/drm_connector.c
+++ b/drivers/gpu/drm/drm_connector.c
@@ -2203,6 +2203,7 @@ static int drm_mode_create_colorspace_property(struct drm_connector *connector,
 /**
  * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
  * @connector: connector to create the Colorspace property on.
+ * @supported_colorspaces: to get hdmi supported colorspaces.
  *
  * Called by a driver the first time it's needed, must be attached to desired
  * HDMI connectors.
@@ -2227,6 +2228,7 @@ EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
 /**
  * drm_mode_create_dp_colorspace_property - create dp colorspace property
  * @connector: connector to create the Colorspace property on.
+ * @supported_colorspaces: to get dp supported colorspaces.
  *
  * Called by a driver the first time it's needed, must be attached to desired
  * DP connectors.
diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
index d300fde6c1a4..556d66dd122c 100644
--- a/include/drm/drm_connector.h
+++ b/include/drm/drm_connector.h
@@ -498,6 +498,8 @@ enum drm_privacy_screen_status {
  *   ITU-R BT.601 colorimetry format
  *   The DP spec does not say whether this is the 525 or the 625
  *   line version.
+ * @DRM_MODE_COLORIMETRY_COUNT:
+ *   Represents the count of colorspaces.
  */
 enum drm_colorspace {
 	/* For Default case, driver will set the colorspace */
-- 
2.34.1

Re: [PATCH] drm: fix doc warnings related to drm connector

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 2186 bytes --]

On Sat, Sep 09, 2023 at 04:33:43PM +0530, Bragatheswaran Manickavel wrote:
> Addressing drm dp/hdmi connector related kernel documentation
> warning and add more information about these values.

What are these?

> 
> Signed-off-by: Bragatheswaran Manickavel <bragathemanick0908@gmail.com>
> ---
>  drivers/gpu/drm/drm_connector.c | 2 ++
>  include/drm/drm_connector.h     | 2 ++
>  2 files changed, 4 insertions(+)
> 
> diff --git a/drivers/gpu/drm/drm_connector.c b/drivers/gpu/drm/drm_connector.c
> index bf8371dc2a61..084c95785dda 100644
> --- a/drivers/gpu/drm/drm_connector.c
> +++ b/drivers/gpu/drm/drm_connector.c
> @@ -2203,6 +2203,7 @@ static int drm_mode_create_colorspace_property(struct drm_connector *connector,
>  /**
>   * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
>   * @connector: connector to create the Colorspace property on.
> + * @supported_colorspaces: to get hdmi supported colorspaces.
>   *
>   * Called by a driver the first time it's needed, must be attached to desired
>   * HDMI connectors.
> @@ -2227,6 +2228,7 @@ EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
>  /**
>   * drm_mode_create_dp_colorspace_property - create dp colorspace property
>   * @connector: connector to create the Colorspace property on.
> + * @supported_colorspaces: to get dp supported colorspaces.
>   *
>   * Called by a driver the first time it's needed, must be attached to desired
>   * DP connectors.
> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
> index d300fde6c1a4..556d66dd122c 100644
> --- a/include/drm/drm_connector.h
> +++ b/include/drm/drm_connector.h
> @@ -498,6 +498,8 @@ enum drm_privacy_screen_status {
>   *   ITU-R BT.601 colorimetry format
>   *   The DP spec does not say whether this is the 525 or the 625
>   *   line version.
> + * @DRM_MODE_COLORIMETRY_COUNT:
> + *   Represents the count of colorspaces.
>   */
>  enum drm_colorspace {
>  	/* For Default case, driver will set the colorspace */

Oh, you mean to add description for colorspace-related fields.

Thanks.


-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] drm: fix doc warnings related to drm connector

[Randy Dunlap]

On 9/9/23 20:54, Bagas Sanjaya wrote:
> On Sat, Sep 09, 2023 at 04:33:43PM +0530, Bragatheswaran Manickavel wrote:
>> Addressing drm dp/hdmi connector related kernel documentation
>> warning and add more information about these values.
> 
> What are these?
> 

There are already patches for these issues.

Please check latest linux-next and make patches to it instead of using mainline.

Thanks.



>>
>> Signed-off-by: Bragatheswaran Manickavel <bragathemanick0908@gmail.com>
>> ---
>>  drivers/gpu/drm/drm_connector.c | 2 ++
>>  include/drm/drm_connector.h     | 2 ++
>>  2 files changed, 4 insertions(+)
>>
>> diff --git a/drivers/gpu/drm/drm_connector.c b/drivers/gpu/drm/drm_connector.c
>> index bf8371dc2a61..084c95785dda 100644
>> --- a/drivers/gpu/drm/drm_connector.c
>> +++ b/drivers/gpu/drm/drm_connector.c
>> @@ -2203,6 +2203,7 @@ static int drm_mode_create_colorspace_property(struct drm_connector *connector,
>>  /**
>>   * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
>>   * @connector: connector to create the Colorspace property on.
>> + * @supported_colorspaces: to get hdmi supported colorspaces.
>>   *
>>   * Called by a driver the first time it's needed, must be attached to desired
>>   * HDMI connectors.
>> @@ -2227,6 +2228,7 @@ EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
>>  /**
>>   * drm_mode_create_dp_colorspace_property - create dp colorspace property
>>   * @connector: connector to create the Colorspace property on.
>> + * @supported_colorspaces: to get dp supported colorspaces.
>>   *
>>   * Called by a driver the first time it's needed, must be attached to desired
>>   * DP connectors.
>> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
>> index d300fde6c1a4..556d66dd122c 100644
>> --- a/include/drm/drm_connector.h
>> +++ b/include/drm/drm_connector.h
>> @@ -498,6 +498,8 @@ enum drm_privacy_screen_status {
>>   *   ITU-R BT.601 colorimetry format
>>   *   The DP spec does not say whether this is the 525 or the 625
>>   *   line version.
>> + * @DRM_MODE_COLORIMETRY_COUNT:
>> + *   Represents the count of colorspaces.
>>   */
>>  enum drm_colorspace {
>>  	/* For Default case, driver will set the colorspace */
> 
> Oh, you mean to add description for colorspace-related fields.
> 
> Thanks.
> 
> 

-- 
~Randy

Re: [PATCH] drm: fix doc warnings related to drm connector

[Randy Dunlap]

On 9/9/23 23:37, Bragatheswaran Manickavel wrote:
>>On Sun, 10 Sept 2023 at 09:29, Randy Dunlap <rdunlap@infradead.org <mailto:rdunlap@infradead.org>> wrote:
>>On 9/9/23 20:54, Bagas Sanjaya wrote:
>>> On Sat, Sep 09, 2023 at 04:33:43PM +0530, Bragatheswaran Manickavel wrote:
>>>> Addressing drm dp/hdmi connector related kernel documentation
>>>> warning and add more information about these values.
>>>
>>> What are these?
>>>
>>
>>There are already patches for these issues.
>>
>>Please check latest linux-next and make patches to it instead of using mainline.
>>
>>Thanks.
> 
> Just had a look at the latest next-20230908. Changes of include/drm/drm_connector.h are
> not present.

That's correct. The patch for that was sent on Sept. 6 and applied to a drm git tree
on Sept. 7.

It's here:  https://lore.kernel.org/all/20230906-topic-drm_connector_doc-v2-1-1f2dcaa43269@gmail.com/


>>>>
>>>> Signed-off-by: Bragatheswaran Manickavel <bragathemanick0908@gmail.com <mailto:bragathemanick0908@gmail.com>>
>>>> ---
>>>>  drivers/gpu/drm/drm_connector.c | 2 ++
>>>>  include/drm/drm_connector.h     | 2 ++
>>>>  2 files changed, 4 insertions(+)
>>>>
>>>> diff --git a/drivers/gpu/drm/drm_connector.c b/drivers/gpu/drm/drm_connector.c
>>>> index bf8371dc2a61..084c95785dda 100644
>>>> --- a/drivers/gpu/drm/drm_connector.c
>>>> +++ b/drivers/gpu/drm/drm_connector.c
>>>> @@ -2203,6 +2203,7 @@ static int drm_mode_create_colorspace_property(struct drm_connector *connector,
>>>>  /**
>>>>   * drm_mode_create_hdmi_colorspace_property - create hdmi colorspace property
>>>>   * @connector: connector to create the Colorspace property on.
>>>> + * @supported_colorspaces: to get hdmi supported colorspaces.
>>>>   *
>>>>   * Called by a driver the first time it's needed, must be attached to desired
>>>>   * HDMI connectors.
>>>> @@ -2227,6 +2228,7 @@ EXPORT_SYMBOL(drm_mode_create_hdmi_colorspace_property);
>>>>  /**
>>>>   * drm_mode_create_dp_colorspace_property - create dp colorspace property
>>>>   * @connector: connector to create the Colorspace property on.
>>>> + * @supported_colorspaces: to get dp supported colorspaces.
>>>>   *
>>>>   * Called by a driver the first time it's needed, must be attached to desired
>>>>   * DP connectors.
>>>> diff --git a/include/drm/drm_connector.h b/include/drm/drm_connector.h
>>>> index d300fde6c1a4..556d66dd122c 100644
>>>> --- a/include/drm/drm_connector.h
>>>> +++ b/include/drm/drm_connector.h
>>>> @@ -498,6 +498,8 @@ enum drm_privacy_screen_status {
>>>>   *   ITU-R BT.601 colorimetry format
>>>>   *   The DP spec does not say whether this is the 525 or the 625
>>>>   *   line version.
>>>> + * @DRM_MODE_COLORIMETRY_COUNT:
>>>> + *   Represents the count of colorspaces.
>>>>   */
>>>>  enum drm_colorspace {
>>>>      /* For Default case, driver will set the colorspace */
>>>
>>> Oh, you mean to add description for colorspace-related fields.
>>>
>>> Thanks.
>>>
>>>
>>
>>--
> ~Randy

-- 
~Randy