2023-09-28 17:36:29

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] add kernel-doc for dc_dmub_caps

Hi--

On 9/28/23 09:34, Sagar Vashnav wrote:
> From: sagar-7227 <[email protected]>
>
> Add kernel documentation for the dc_dmub_caps structure.
>
> Signed-off-by: sagar-7227 <[email protected]>

Use full name, please.

> ---
> dc.h | 10 ++++++++++
> 1 file changed, 10 insertions(+)
>

What file is being patched?
The patch should include the file's full path, like:

diff --git a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h


> diff --git a/dc.h b/dc.h
> index 8125839..cd4dab3 100644
> --- a/dc.h
> +++ b/dc.h
> @@ -208,6 +208,16 @@ struct dc_color_caps {
> struct mpc_color_caps mpc;
> };
>
> +/**
> + * struct dc_dmub_caps - DMUB (Display Microcontroller Unit) capabilities
> + * @psr: support for PSR (Power Saving State Residency)
> + * @mclk_sw: support for MCLK_SW (Memory Clock Switch)
> + * @subvp_psr: supprt for SUBVP PSR (Sub-Viewport Power Saving State Residency)

support

> + * @gecc_enable: GECC (Global Error Correcting Code) enablement.
> + *
> + * This structure describes the capabilities of the Display Microcontroller Unit (DMUB).
> + * It specifies whether certain features like PSR and MCLK_SW are supported.
> + */
> struct dc_dmub_caps {
> bool psr;
> bool mclk_sw;

For the patch to be considered, reviewed, and accepted, it should be sent
to the AMD DRM display maintainers & mailing list. See the MAINTAINERS file:

AMD DISPLAY CORE
M: Harry Wentland <[email protected]>
M: Leo Li <[email protected]>
M: Rodrigo Siqueira <[email protected]>
L: [email protected]


Thanks.
~Randy




2023-09-29 21:12:15

by Sagar Vashnav

[permalink] [raw]
Subject: [PATCH] add kernel docs for dc_dmub_caps

Add kernel documentation for the dc_dmub_caps structure.

Signed-off-by: Sagar Vashnav <[email protected]>
---
drivers/gpu/drm/amd/display/dc/dc.h | 10 ++++++++++
1 file changed, 10 insertions(+)

diff --git a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
index 8125839..14b4c50 100644
--- a/drivers/gpu/drm/amd/display/dc/dc.h
+++ b/drivers/gpu/drm/amd/display/dc/dc.h
@@ -208,6 +208,16 @@ struct dc_color_caps {
struct mpc_color_caps mpc;
};

+/**
+ * struct dc_dmub_caps - DMUB (Display Microcontroller Unit) capabilities
+ * @psr: support for PSR (Power Saving State Residency)
+ * @mclk_sw: support for MCLK_SW (Memory Clock Switch)
+ * @subvp_psr: support for SUBVP PSR (Sub-Viewport Power Saving State Residency)
+ * @gecc_enable: GECC (Global Error Correcting Code) enablement.
+ *
+ * This structure describes the capabilities of the Display Microcontroller Unit (DMUB).
+ * It specifies whether certain features like PSR and MCLK_SW are supported.
+ */
struct dc_dmub_caps {
bool psr;
bool mclk_sw;
--
2.34.1

2023-09-30 05:01:00

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] add kernel docs for dc_dmub_caps

Hi,

The $Subject could be improved, e.g.:

[PATCH] drm/amd/display: add kernel docs for dc_dmub_caps


On 9/29/23 03:00, Sagar Vashnav wrote:
> Add kernel documentation for the dc_dmub_caps structure.
>
> Signed-off-by: Sagar Vashnav <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

Thanks.

> ---
> drivers/gpu/drm/amd/display/dc/dc.h | 10 ++++++++++
> 1 file changed, 10 insertions(+)
>
> diff --git a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
> index 8125839..14b4c50 100644
> --- a/drivers/gpu/drm/amd/display/dc/dc.h
> +++ b/drivers/gpu/drm/amd/display/dc/dc.h
> @@ -208,6 +208,16 @@ struct dc_color_caps {
> struct mpc_color_caps mpc;
> };
>
> +/**
> + * struct dc_dmub_caps - DMUB (Display Microcontroller Unit) capabilities
> + * @psr: support for PSR (Power Saving State Residency)
> + * @mclk_sw: support for MCLK_SW (Memory Clock Switch)
> + * @subvp_psr: support for SUBVP PSR (Sub-Viewport Power Saving State Residency)
> + * @gecc_enable: GECC (Global Error Correcting Code) enablement.
> + *
> + * This structure describes the capabilities of the Display Microcontroller Unit (DMUB).
> + * It specifies whether certain features like PSR and MCLK_SW are supported.
> + */
> struct dc_dmub_caps {
> bool psr;
> bool mclk_sw;

--
~Randy

2023-10-02 06:16:17

by Sagar Vashnav

[permalink] [raw]
Subject: [PATCH] drm/amd/display: add kernel docs for dc_dmub_caps

Add kernel documentation for the dc_dmub_caps structure.

Signed-off-by: Sagar Vashnav <[email protected]>
---
drivers/gpu/drm/amd/display/dc/dc.h | 10 ++++++++++
1 file changed, 10 insertions(+)

diff --git a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
index 81258392d..14b4c503d 100644
--- a/drivers/gpu/drm/amd/display/dc/dc.h
+++ b/drivers/gpu/drm/amd/display/dc/dc.h
@@ -208,6 +208,16 @@ struct dc_color_caps {
struct mpc_color_caps mpc;
};

+/**
+ * struct dc_dmub_caps - DMUB (Display Microcontroller Unit) capabilities
+ * @psr: support for PSR (Power Saving State Residency)
+ * @mclk_sw: support for MCLK_SW (Memory Clock Switch)
+ * @subvp_psr: support for SUBVP PSR (Sub-Viewport Power Saving State Residency)
+ * @gecc_enable: GECC (Global Error Correcting Code) enablement.
+ *
+ * This structure describes the capabilities of the Display Microcontroller Unit (DMUB).
+ * It specifies whether certain features like PSR and MCLK_SW are supported.
+ */
struct dc_dmub_caps {
bool psr;
bool mclk_sw;
--
2.34.1

2023-10-02 10:41:51

by Randy Dunlap

[permalink] [raw]
Subject: Re: [PATCH] drm/amd/display: add kernel docs for dc_dmub_caps



On 10/1/23 21:41, Sagar Vashnav wrote:
> Add kernel documentation for the dc_dmub_caps structure.
>
> Signed-off-by: Sagar Vashnav <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

Thanks.

> ---
> drivers/gpu/drm/amd/display/dc/dc.h | 10 ++++++++++
> 1 file changed, 10 insertions(+)
>
> diff --git a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
> index 81258392d..14b4c503d 100644
> --- a/drivers/gpu/drm/amd/display/dc/dc.h
> +++ b/drivers/gpu/drm/amd/display/dc/dc.h
> @@ -208,6 +208,16 @@ struct dc_color_caps {
> struct mpc_color_caps mpc;
> };
>
> +/**
> + * struct dc_dmub_caps - DMUB (Display Microcontroller Unit) capabilities
> + * @psr: support for PSR (Power Saving State Residency)
> + * @mclk_sw: support for MCLK_SW (Memory Clock Switch)
> + * @subvp_psr: support for SUBVP PSR (Sub-Viewport Power Saving State Residency)
> + * @gecc_enable: GECC (Global Error Correcting Code) enablement.
> + *
> + * This structure describes the capabilities of the Display Microcontroller Unit (DMUB).
> + * It specifies whether certain features like PSR and MCLK_SW are supported.
> + */
> struct dc_dmub_caps {
> bool psr;
> bool mclk_sw;

--
~Randy