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: <f528a8e4-5162-66d5-09da-5252076882b8@amd.com>
Date:   Mon, 19 Sep 2022 11:19:47 -0400
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.11.0
Subject: Re: [PATCH] A simple doc fix
Content-Language: en-US
To:     Anup K Parikh <parikhanupk.foss@gmail.com>,
        skhan@linuxfoundation.org, airlied@linux.ie, daniel@ffwll.ch
Cc:     dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org
References: <YyGuwqpuwq+PT3K1@autolfshost>
 <5372b154-dc25-a917-9908-c59555afc865@amd.com> <YyIq8mXKXP1kCoLS@autolfshost>
From:   Andrey Grodzovsky <andrey.grodzovsky@amd.com>
In-Reply-To: <YyIq8mXKXP1kCoLS@autolfshost>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?UEFrZ3FQTFJiZkZELzdWNUt3T2VIT28xSmlySVEzU0tZYjR5K3JYT09GS0wr?=
 =?utf-8?B?N2Z1VWJDN29BQ29qUTRVSjZLVnJXd0R0K2Q3UzhHUkhEdDVDMGV5bE9tMm1J?=
 =?utf-8?B?a1k3dk1hR21DN2FYNlRtWUJzcnJWeWtKOTZTdWYzTTQ5Y3IxamMvRkI1TDZQ?=
 =?utf-8?B?WnJPOE5idE5FUXdXUDgrZm5jQkx1bHVBcEp2QVdCYkNJK3RwUVJ0U2xPemJ6?=
 =?utf-8?B?aDFzaWpoVUVSQ0xiVm9uREpZNjVQZmwrQi9KakpRby9ML1RDNjRvbTM2Qng0?=
 =?utf-8?B?V1dpNWhZWDZ5Tlg2b3hqVUp2M1ljeXo1UmlGdjFkdzFaT0FSQTA5ekRmK2lO?=
 =?utf-8?B?VDdLWlpFMTZiM2lNU05JZldSblRuSm5zdk5FaEJPdXE3YklNRTJmREMwQkxS?=
 =?utf-8?B?Qml4YmgwMFIvYlBQUHNEd2lyNEFSUEtEcTlmTk9Yek9CSDhheTd0T1ZmTGZO?=
 =?utf-8?B?NnNhZWdyK3IzZlhUU1JQUVpXRERkcDVRcmdXYWw2c29GMW1peE0xL0U1dFE0?=
 =?utf-8?B?cm1LeGd1aUszdEhHeW5LNEM0bFdoMnIxai9SeHBnVlVNc0tNblJISDFFZ1U4?=
 =?utf-8?B?d3VpNjlwcGpGSW5qZk85ZnBiUEg4SmxrRms5MFMzSFF2alcwUE5rLy9mRy9L?=
 =?utf-8?B?bHh0Zi9QdU91OTNRb2RpUURhK1ZyeUZtTUNCY1hCOGpNNThOLzFKQUNWNHVk?=
 =?utf-8?B?SFJidFRFU3BGcC9vTzRlcEZ6L05UeldiYklXdEZES056bitjWlZLK2w3R2ZJ?=
 =?utf-8?B?bTVBS2tCQjJmZkFpUE5vTmc3TmJEYW1qWjduMnZWTCtTOFZOdlo4ajAzU0U2?=
 =?utf-8?B?NUVQeFdhV0tLRGUvTHAzZzNsOFJtM2FDUjh0UTJzZm1kSENiY083NlJvYjhV?=
 =?utf-8?B?N09PSHEvbWJyZkdMaFlUamNHYjM1eHVTZEVubDNTZ08wSFJaenZWREN4MXdj?=
 =?utf-8?B?VFQ5NDhxUFo4KzdybWx5Y011Vi9JQ0tsb0g2MkJkK3NtMkhVKzhJUkVBV3Rn?=
 =?utf-8?B?QmJ2WjRlVDFKSkRJVHpHUHJPMTBvTUFPa3R5TkI5cHd2Z0JaNHlQWHBsNmY3?=
 =?utf-8?B?NmpoMVNxNkRWQmtCWmNLdzJuMTV3ditzOU1DbG85bTMrN1loclBJUzZRWVRG?=
 =?utf-8?B?SndEWGE0Z1BlNEg3WmwzOHF0SnBzZFp4NlBWV2ZCbm9vbEZwdFRldXdhQ1RI?=
 =?utf-8?B?NzU2cjg1VFdtV2RvQWFlR0xuc3E5VnBtcUxIVDFRQ1VidzRsUDE5Q3JQSGNS?=
 =?utf-8?B?UFc5eGlqWlRDeTg0OVhFdUxBV3AwWUZwQzhZaXVXNEhxSmpxWTBFRUp4L2dV?=
 =?utf-8?B?QXFzeEt6bmZuTTQyVUdOMGhkTlhiTVp3UXNuNU1GNmhteWlpWHRVK1dYQzhQ?=
 =?utf-8?B?VjhGY1k0SWJ2SXV3dVl6YzNpTlFQdUNkM2RSVW5IdGFzYzF2cGNGendJUzBw?=
 =?utf-8?B?enVOMmlIWkRxV2EzeHJQY0U5K0svY2NJZnJmdjYyalIrVThUSDYwSHhvMnBj?=
 =?utf-8?B?Y0lnK3dZWVJrZVpMeW9HcG8vaWQxbkhBSHBNL0cvTjJZcDBaaGNvT3pNK2gy?=
 =?utf-8?B?Y1dOYXBwUXc5dHREaTJPZVdjTmNJd0tYQi9yUThPVkhVZk1FaFFIK2RSdUhT?=
 =?utf-8?B?am9iUGZpWmdrbnRBWWprYitiMWdKSko5aGRqSDYwRU5Wa2hEOHd1MkExUlJ5?=
 =?utf-8?B?NDBsTGNlazRxZk5hclZ0RnVVYkt3RUZ3U0NydHlTRDBxQWg5Qy9NbCttNjZo?=
 =?utf-8?B?aGNzMVlFUDJYOWMrMHBLR1FDWER0MExZczR6L042VjNKYXNWdEJCRmY1UENG?=
 =?utf-8?B?TXA3N1hXWEIwUEpIL2k0eXl6cUM2QUMxM3I0SGZzUGtpelJOZnFOVkZXSzNr?=
 =?utf-8?B?RERtMDFSejlVV3hCWVkzL01CWjJTQ2t3UGZOeTB4SVU3N0pzY2ZBUlVGY0Y3?=
 =?utf-8?B?Y0pLOHZHa3NlRDNGcjFWdVMvcWRWV0xFSE0xOTRjN3hsaTVkQVhBaTAwUXBO?=
 =?utf-8?B?WTBvcU8yL05ZTlJMcHp5enBmU1V0Um02SFRnK3JGZThyS3krR2pmTDBOemFD?=
 =?utf-8?B?emNSNmV1WHJibElzNkR0Uy96QitldWIwYkw2ZWY1Wko3b1FqOWRobG9hamJo?=
 =?utf-8?B?N3ByTGlKUU52c29aSmZnNXdkaWRJMGJwVlpPYXR0TmplY3lzU1ZZeTh5VXNm?=
 =?utf-8?Q?A8w/jS13RzZY8T8tGEdT24IS5HqDI1RvyX9yOicWBjI8?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: cb9b495f-04ea-46e9-db23-08da9a526521
X-MS-Exchange-CrossTenant-AuthSource: DM5PR12MB1947.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Sep 2022 15:19:50.2934
 (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: 7cQOSblUlQV17DunrWcRtHnmjp6qtbbiC40oetWRrtG3F4NlElzSiiJ0FfdtEBwGosfA0PR15PGyVuBZs3vlww==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: IA1PR12MB6529
X-Spam-Status: No, score=-3.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 2022-09-14 15:26, Anup K Parikh wrote:
> On Wed, Sep 14, 2022 at 10:24:36AM -0400, Andrey Grodzovsky wrote:
>> On 2022-09-14 06:36, Anup K Parikh wrote:
>>> Fix two warnings during doc build which also results in corresponding
>>> additions in generated docs
>>>
>>> Warnings Fixed:
>>> 1. include/drm/gpu_scheduler.h:462: warning: Function parameter or member
>>>      'dev' not described in 'drm_gpu_scheduler'
>>> 2. drivers/gpu/drm/scheduler/sched_main.c:1005: warning: Function
>>>      parameter or member 'dev' not described in 'drm_sched_init'
>>>
>>> Signed-off-by: Anup K Parikh <parikhanupk.foss@gmail.com>
>>> ---
>>>    drivers/gpu/drm/scheduler/sched_main.c | 1 +
>>>    include/drm/gpu_scheduler.h            | 1 +
>>>    2 files changed, 2 insertions(+)
>>>
>>> diff --git a/drivers/gpu/drm/scheduler/sched_main.c b/drivers/gpu/drm/scheduler/sched_main.c
>>> index 68317d3a7a27..875d00213849 100644
>>> --- a/drivers/gpu/drm/scheduler/sched_main.c
>>> +++ b/drivers/gpu/drm/scheduler/sched_main.c
>>> @@ -994,6 +994,7 @@ static int drm_sched_main(void *param)
>>>     *		used
>>>     * @score: optional score atomic shared with other schedulers
>>>     * @name: name used for debugging
>>> + * @dev: A device pointer for use in error reporting in a multiple GPU scenario.
>>
>> Why multiple GPUs scenario ? It's also used in single GPU scenario.
>>
>> Andrey
>>
>>
> Hello Mr. Andrey Grodzovsky,
>
> Thanks for the quick review and response.
>
> My documentation string (same for both files) is based on commit id
> 8ab62eda177bc350f34fea4fcea23603b8184bfd. It seemed that both warnings
> might've been introduced by the addition of that device pointer.
>
> Also, the commit message specifically mentions this addition for use with
> DRM_DEV_ERROR() to make life easier under a multiple GPU scenario. So, I
> used cscope to look for DRM_DEV_ERROR() and then for drm_dev_printk(). I
> also checked previous versions of both files and noticed DRM_ERROR() in
> drivers/gpu/drm/scheduler/sched_main.c changed to DRM_DEV_ERROR().
>
> Perhaps, I wrongly correlated my cscope/history findings with the commit
> message and used absolute wording. I guess that this might be (I usually
> avoid absolute wording) useful not only in a single GPU scenario (to print
> better standardized messages with dev when available) but also in non-error
> printing such as with KERN_NOTICE, KERN_INFO, etc. I'm still not sure if
> the added device pointer could be used for something else besides printing.
>
> Please let me know if my understanding is correct and whether I should
> change the wording to:
>
> A device pointer - primarily useful for printing standardized messages with
> DRM_DEV_ERROR().

It could be used for many other things but in this case in deed used 
only for the print.
So yep - looks good.

Andrey


>>>     *
>>>     * Return 0 on success, otherwise error code.
>>>     */
>>> diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h
>>> index addb135eeea6..920b91fd1719 100644
>>> --- a/include/drm/gpu_scheduler.h
>>> +++ b/include/drm/gpu_scheduler.h
>>> @@ -435,6 +435,7 @@ struct drm_sched_backend_ops {
>>>     * @_score: score used when the driver doesn't provide one
>>>     * @ready: marks if the underlying HW is ready to work
>>>     * @free_guilty: A hit to time out handler to free the guilty job.
>>> + * @dev: A device pointer for use in error reporting in a multiple GPU scenario.
>>>     *
>>>     * One scheduler is implemented for each hardware ring.
>>>     */