Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <28960f0b-97b9-7a41-9da3-188be25dd886@amd.com>
Date:   Thu, 17 Nov 2022 14:39:46 -0500
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.4.2
Subject: Re: [PATCH -next] drm/amd/display: fix kernel-doc issues in dc.h
Content-Language: en-US
To:     Randy Dunlap <rdunlap@infradead.org>, linux-kernel@vger.kernel.org
Cc:     Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>,
        Alex Deucher <alexander.deucher@amd.com>,
        Leo Li <sunpeng.li@amd.com>, amd-gfx@lists.freedesktop.org,
        David Airlie <airlied@gmail.com>,
        Daniel Vetter <daniel@ffwll.ch>,
        dri-devel@lists.freedesktop.org
References: <20221117172009.28207-1-rdunlap@infradead.org>
From:   Harry Wentland <harry.wentland@amd.com>
In-Reply-To: <20221117172009.28207-1-rdunlap@infradead.org>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?S3o2azlRSW82blh6QXlNZjQzYW04TW5MWU9YSXlVTlExdy9oTVZZeWxQSTM3?=
 =?utf-8?B?RFNGcVJQN3F0RWpXeFZSTWlyYU5JNmpUMjRkY1ZKYjdURzM3Qkg3MUQrYXoz?=
 =?utf-8?B?Z1hEaUkzTC9ualgvQlhnUnB2bTNWM3lIdEdSVkVnbmszU0VraEZlOHJIdjI3?=
 =?utf-8?B?MWNDbTZOU1ZmWWJWVFBOd0xmckhwUHk3VGxrOXRJcjlPTEhsYmVxeWxqMWd5?=
 =?utf-8?B?cW40cnc2MlVycjd2N1ZPcVJQbSt0bWhlbFN1ZkphT0Z6Qi9YMjZud0o2ai9T?=
 =?utf-8?B?am1CbDdGTVp5Ry9kVGcyeEF4ZnZraklDNzFYck82ZXl5VWJQNmJsNHNqM2ZL?=
 =?utf-8?B?b2NFT291cVJNL1NycHdTYThxV3VLNXRXNm5PN0Z4bExCMzBjQ05ER2RybTVW?=
 =?utf-8?B?bFJsZndEZzJZQWw4UUllUXZwOG43ZzBuSURZZTJ5bE1zMC9vNHp4UjRwWmZZ?=
 =?utf-8?B?cnBWR2xHdDZkcHovWWhvcC9TT2F2ayszb3J3TDRLb2ErMXFUclZDU1REZTNy?=
 =?utf-8?B?bWl0cGNtcE0xZXhFN2tQaEEvTjhlVE9KdENvMVRsY1loRG9hWWgxdEZLTjRE?=
 =?utf-8?B?QnRYczdNdDc1dk4wY0FjVkZtcDVvcGQzSWU3eTdROFQyU04zek5QSllzMDBV?=
 =?utf-8?B?cHlyd3pwVXhJaUE3MzRFZGhsVzhJUFFMMnlxQXUxbnhpcWdieHNxanRyazJt?=
 =?utf-8?B?RDJSMUxmNlo1Z3VBOUFuMGtLS0EzUnZ0Z2hxQVlZeG9SK21WZStiOHJwclQ5?=
 =?utf-8?B?ZFZmNXpuaitDNHl1MWQrNHMwQ09taG96RzJkbUtrWDFoc2QxSUNDYXVxT0xF?=
 =?utf-8?B?SnFVMGZYQTloMlRyeG9EbHliaFhob3h1VDEwR3NjOGs3L0ZkRHpwS0N0ZGNk?=
 =?utf-8?B?UkJ0Z0t5dDNrMk1PZ2l6Tnh4WHpwL0R6SUVUS0s0TjRSSURXS25iek01RXFp?=
 =?utf-8?B?VWphcW9KNmFWV1lSME90MFR4NEpnM2VyZ1R1OGZPZUtiQmFQcFBUekd5bnZz?=
 =?utf-8?B?TVVRd3lzVlFYd0UyVk5seGdjL0xHSWFod3BDcDEwaHdtdzAxS3dNQnlYZnNj?=
 =?utf-8?B?QkY5bXR4UDA1TGVRdmlPaWs2Ym9YZC81SFE5MXVDU3ByWUVFVDFlcFlWRzlz?=
 =?utf-8?B?TzZ2eHluTFVtN1VTVnJVeGhTOVNjdUVwYzR5VDJHeXpPOFpFS1BsUlJ3ekN4?=
 =?utf-8?B?dWo2WC9QNGt1NnY2ZGhHdEJjdUtjMWRGSENrc1gwS2pNR1Q4Ky9rMVhHRWFX?=
 =?utf-8?B?bG5UeFNlNmxGb1JFSmVENFE5LzFqb1Z5aUpPSU5qOU5uUjVOMlRpeHFXQW1P?=
 =?utf-8?B?SEZRL29SMVl1VmlnTEZENFdkRnJmNWlkVGFZUDVNU0ROZVUzWE1RUzFmRDVs?=
 =?utf-8?B?VHh1T0svTm1JYnRldW5tNS9WcThHOGh5WVh4WU9rdmxaZHhQYnZFNGRsYnF6?=
 =?utf-8?B?RXRDVDc0eElST3o2THpWZy9KOWdFdjArRk5uSjhYLytNYkhGcmdhcmFJb3l4?=
 =?utf-8?B?aWo1bHVxNkl1QXEwbGlWYWN1K3lrc3BEak9KbkExSE5pY1NkeWExaDFHMmxX?=
 =?utf-8?B?eHh3aUNNSnNWeEpSU0lPZEE1Yjd2VWw0N2szSzdTRDFlUVdCOW44d2hUNUF4?=
 =?utf-8?B?bCtpSGFVdE9PVm40dENHNGU2WFNPL3NYYWo1cjh1Tm9oMWt4SHpPNVpQMmJB?=
 =?utf-8?B?WHYzNWNpc0JtRXpIbXlvdGxyK1pyblhyMzZad0N6UVZTMDdjTTRHK3N2RmlC?=
 =?utf-8?B?LytNTENNRk8zbFRtTUQ2dmE1eTlkc2s3ZncyRXRCeXQ0WlRCREczdHplMVhY?=
 =?utf-8?B?Y1FWZEljckIzVWRXcU04QWp6ZG44eEJhK2hKSm1YcktrWU5kTGVHWUFxNE4x?=
 =?utf-8?B?TG1HQS9jdlFtdzJUcjdDUmRXVXpZUElzOGYxRVVMeVVqMUJvYlFjMG5kc3ZU?=
 =?utf-8?B?dUFQbGRxcEdQSmFLd2l4Y0lZSXBKcFNZNmJ2TUlQRkFPcjBWYlBaOEt3ZVZ5?=
 =?utf-8?B?cDk0anpLT25WbnMvVXV2bnFMMXZCL0k1VmFYWkR1VGtQbUFHK2tBOFoyaUxU?=
 =?utf-8?B?SVl2VU53NUMxSmJLSzZnUlkzYW8zOUk2UllUVHdYVzZadGNsMTViNlpIYllj?=
 =?utf-8?Q?+LPlfkskAH9/EWFV66zxbwItQ?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: a1ce36aa-1b54-4b69-9fae-08dac8d37d91
X-MS-Exchange-CrossTenant-AuthSource: CO6PR12MB5427.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Nov 2022 19:39:51.3088
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: BAZcg3jGnc3wew1lKwasesTn/CsaIATbin81G6oaKKv/WNhaXK4kqqPN45UWg+pM9ZffcxQfgmwbpMh9GyGRBg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW4PR12MB7310
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,NICE_REPLY_A,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS autolearn=ham
        autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org


On 11/17/22 12:20, Randy Dunlap wrote:
> Fix these kernel-doc complaints:
> 
> drivers/gpu/drm/amd/display/dc/dc.h:505: warning: cannot understand function prototype: 'struct dc_clocks '
> dc.h:472: warning: Enum value 'MPC_SPLIT_AVOID' not described in enum 'pipe_split_policy'
> dc.h:472: warning: Enum value 'MPC_SPLIT_AVOID_MULT_DISP' not described in enum 'pipe_split_policy'
> dc.h:532: warning: Incorrect use of kernel-doc format:          * @fw_based_mclk_switching
> 
> Fixes: ea76895ffab1 ("drm/amd/display: Document pipe split policy")
> Fixes: 1682bd1a6b5f ("drm/amd/display: Expand kernel doc for DC")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Rodrigo Siqueira <Rodrigo.Siqueira@amd.com>
> Cc: Alex Deucher <alexander.deucher@amd.com>
> Cc: Harry Wentland <harry.wentland@amd.com>
> Cc: Leo Li <sunpeng.li@amd.com>
> Cc: amd-gfx@lists.freedesktop.org
> Cc: David Airlie <airlied@gmail.com>
> Cc: Daniel Vetter <daniel@ffwll.ch>
> Cc: dri-devel@lists.freedesktop.org

Reviewed-by: Harry Wentland <harry.wentland@amd.com>

Harry

> ---
>  drivers/gpu/drm/amd/display/dc/dc.h |   12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff -- a/drivers/gpu/drm/amd/display/dc/dc.h b/drivers/gpu/drm/amd/display/dc/dc.h
> --- a/drivers/gpu/drm/amd/display/dc/dc.h
> +++ b/drivers/gpu/drm/amd/display/dc/dc.h
> @@ -458,15 +458,15 @@ enum pipe_split_policy {
>  	MPC_SPLIT_DYNAMIC = 0,
>  
>  	/**
> -	 * @MPC_SPLIT_DYNAMIC: Avoid pipe split, which means that DC will not
> +	 * @MPC_SPLIT_AVOID: Avoid pipe split, which means that DC will not
>  	 * try any sort of split optimization.
>  	 */
>  	MPC_SPLIT_AVOID = 1,
>  
>  	/**
> -	 * @MPC_SPLIT_DYNAMIC: With this option, DC will only try to optimize
> -	 * the pipe utilization when using a single display; if the user
> -	 * connects to a second display, DC will avoid pipe split.
> +	 * @MPC_SPLIT_AVOID_MULT_DISP: With this option, DC will only try to
> +	 * optimize the pipe utilization when using a single display; if the
> +	 * user connects to a second display, DC will avoid pipe split.
>  	 */
>  	MPC_SPLIT_AVOID_MULT_DISP = 2,
>  };
> @@ -497,7 +497,7 @@ enum dcn_zstate_support_state {
>  };
>  
>  /**
> - * dc_clocks - DC pipe clocks
> + * struct dc_clocks - DC pipe clocks
>   *
>   * For any clocks that may differ per pipe only the max is stored in this
>   * structure
> @@ -528,7 +528,7 @@ struct dc_clocks {
>  	bool fclk_prev_p_state_change_support;
>  	int num_ways;
>  
> -	/**
> +	/*
>  	 * @fw_based_mclk_switching
>  	 *
>  	 * DC has a mechanism that leverage the variable refresh rate to switch