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: <e0e94b1d-3af8-0723-426e-e35601faf164@amd.com>
Date:   Tue, 6 Sep 2022 17:01:51 -0400
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.11.0
Subject: Re: [PATCH v2] drm/scheduler: quieten kernel-doc warnings
Content-Language: en-US
To:     Alex Deucher <alexdeucher@gmail.com>
Cc:     Randy Dunlap <rdunlap@infradead.org>, linux-kernel@vger.kernel.org,
        David Airlie <airlied@linux.ie>, Jiawei Gu <Jiawei.Gu@amd.com>,
        dri-devel@lists.freedesktop.org,
        Alex Deucher <alexander.deucher@amd.com>,
        Nayan Deshmukh <nayan26deshmukh@gmail.com>,
        =?UTF-8?Q?Christian_K=c3=b6nig?= <christian.koenig@amd.com>
References: <20220404213040.12912-1-rdunlap@infradead.org>
 <68961bab-6448-9a98-8916-9c3cb0c5d020@amd.com>
 <e61a6903-550d-df70-6297-f49cc2750244@infradead.org>
 <ddde170c-7f2c-d9bc-7044-4c609bc915b5@amd.com>
 <CADnq5_NEgVxjAOgvire32K1=PTGzHcs3GL9BqhmQCqq3EBzVDA@mail.gmail.com>
From:   Andrey Grodzovsky <andrey.grodzovsky@amd.com>
In-Reply-To: <CADnq5_NEgVxjAOgvire32K1=PTGzHcs3GL9BqhmQCqq3EBzVDA@mail.gmail.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?Rko0alhhU0cvRWErYlpybkdmSDhtdWRsKy8zT3N6bXl3V1M5NUNoQVFLRmZM?=
 =?utf-8?B?M1YzQng2QUNnYzI2OWNTd2phcEJHNEN4ZFh5c0FwRlJyVDE1K2pIbnhvTkMr?=
 =?utf-8?B?aFFGVWtuSEUrZ2l2ejNDSXkwMENHNW43dlBrdG9ZdG1INGhOV0tvM1BoWmFN?=
 =?utf-8?B?c3FhR2UyVldIWWV0d2RjM2Nod1FITUZsVk1neHNhRTF1OVFQOXQwYktLM0Rq?=
 =?utf-8?B?d2I2Q2FyWmpVdzBrYTZ5ZWdsRnhwWnpqN05MbGoxM1ZtYUVSYS9LWnBvb0d6?=
 =?utf-8?B?ZllJYnhCWlA2WExOdmloeExZV1FXK2s0V25KYXI5dWxvVDAva01NNFBFWGxn?=
 =?utf-8?B?NkdRbzl0ZU9rbGxzNkdobXRhT2laQTZDcnFjN0NnRTIzUTF4bGJ0TTdzZ3Fm?=
 =?utf-8?B?dlU4TTN0R0ZXUGdaYzJUT0tDRldObFRuV3B3TTNJc1NPSlh4dllrWGNodS9h?=
 =?utf-8?B?Ym03TTV5bzhvRU1jK0FZWmpFSEJkMmkvV3VhdzV5NzBPZEppUHZvbzAweGV0?=
 =?utf-8?B?SUhvQXM4VkVoaU9yOFpWZkdobTBDM1dBQlM2aWZySGRpdU1EU3lOTGs3bVRZ?=
 =?utf-8?B?cEN6UUVHWUUxMXBwaUc5UVI5NE1UZkNnT2E5WnVpT0dTMndwTzUzTUVxbVlJ?=
 =?utf-8?B?eHhMc2l3bDFNZy9CNGZMTDY5YWZPcDFkSDZiWTlDRnV3TXdHTmE2cG40Tkd1?=
 =?utf-8?B?NlRCZnMwTDRwNWNwNU8xOTlXNkx2MGJyaEYzUWh5c1VRcVlpMWpITVp6UWxE?=
 =?utf-8?B?akpYSmFsL25tcTEwNGhXZmV1OUNnR0drekhRWFVYQ1plMlR2RVI5cWsxS29q?=
 =?utf-8?B?VWZDN3Q4QVR6OHVVN29ydzhSaU9YaHJJQXlsUW9CNExHemEraGwvV3FabmFM?=
 =?utf-8?B?dWFTa2syVjVWRWEvRlJONWVCU0tvTmt2K0xZMmFxbXZ2K01sZ21qRUJ5K3l2?=
 =?utf-8?B?cTJUQmw5c1l6MUNuN0RtSnNFdzRKZGhNNE9nNUhjUkJwRk5CN2FTTGFCYWww?=
 =?utf-8?B?UklVQ1dINnRPaGJyTmtuUkU2ZHlVQ0lWNmh5cXNSTWhBMDlhUTgvTEhySjZz?=
 =?utf-8?B?SlFNWVJuejJHZTZvWEJhQnYvSEJMQ3JxYy9tcUgweWYrVktIdkRXTFpRRlF1?=
 =?utf-8?B?SVRpM2UyUXJOeG5URHljRWwzUlJPZXlCT0RxTjZuQkREVVBvRTV3MkhrTTIw?=
 =?utf-8?B?R1EvczNmcnJSNlNlM0tqN2RFMFMwOWZFVTNjZm1WcU5yU0Y0QzE1am1wb1VR?=
 =?utf-8?B?UkFhZXNTeERldkZmWTJHenQ2KzE3TmZZeCs5TGc0M1lsYUoxZTVENjkxc2RU?=
 =?utf-8?B?UmVPMGpEV2NYTGE2WThoS1p4SFpBQXVsMXhET3QwQlFXNGhyb05oN0FMWm15?=
 =?utf-8?B?SEd6VVJQTTUzdzVOUXJFMFN6ekVlM3g5MUowMXkzUDM0ZkJRMXllbmNOQVlB?=
 =?utf-8?B?dUUyRXdxaXBsRGhkY3BRbVNpSU1MVWlCUkd4c1VsMm1iNngxQnRHbmN4ZU1N?=
 =?utf-8?B?YUhuT0I2anJWRWRKTW5tMWNpdmdjR0JiRTZ1L1JKc2RSOVB1ajNSMHVYVWJX?=
 =?utf-8?B?NVBsK0FjaEs4MVhYWlVFeGFRUGRhek0xVmUwSUp3MUhCUjlHcmZhT2RrcHNM?=
 =?utf-8?B?VUF3clVTK3JQUUxaVVVpU0VGRDBvQmpndVhCU0w2Q3kvWHIwTG9NeFpYR3o5?=
 =?utf-8?B?b3NpaFBGUVIyTWJwbmUxWUZKVW85alQ1WTh0N2R5UDIwWHFMRnpYaVV3Rys5?=
 =?utf-8?B?eXhSdm8wcFFtSnVyT1JjTW1CNDl3TkpxeWh4NnB5UjNkb2tyd1VORy9ZcjVj?=
 =?utf-8?B?WkNFRzVKVFlSMC9YdS9vZUNXQTVhL0dLUm85MFRWcFpzQXZ0MEYySjN2THp6?=
 =?utf-8?B?MTc2dm81bTZLUGd0RmlLWkxOZlQ0eFF6ODRWUURKRGdTUFA4RHQwVkFZZFBB?=
 =?utf-8?B?dSs1NDMzeDJpY3FMSHR4OWRtc1pXUkVZemVQL05FeGp1di83VHdRMVg4NTJ3?=
 =?utf-8?B?aGZqL3BZUzR6MmRtL1BSWWE5YmNvUGhFK04vcDVJcVVTYjhab3Q5d2pLSEVG?=
 =?utf-8?B?dzJUcHZwd09uQytUYS9JYy8zdEhTOVdkalRDMXBWbFRpb1B4S2JDTlo3K3RS?=
 =?utf-8?B?Y3ExczFuUlZsd0MrVGJFaUZPYVhHT0ZubEwyeTErSm0zNHAvY3JwRUt1RDM0?=
 =?utf-8?Q?/6ouMr8TsNlS2Ex3XWmhCKrheCuArzOs9GS7SpN6sXGI?=
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 3a76c6c6-2068-45f1-0839-08da904b06d3
X-MS-Exchange-CrossTenant-AuthSource: DM5PR12MB1947.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Sep 2022 21:01:53.9661
 (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: GmAy4oUFEdigV4SzMhFNcB5Q0le4LEHXKy7qxTzHlJUehBeDeCe9pWAlEZ+MIprmjOhEw02BFDKaaIFjRaofGw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MW3PR12MB4492
X-Spam-Status: No, score=-3.9 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,T_SCC_BODY_TEXT_LINE
        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

Pushed to drm-misc-next

Andrey

On 2022-09-06 13:57, Alex Deucher wrote:
> On Tue, Sep 6, 2022 at 1:38 PM Andrey Grodzovsky
> <andrey.grodzovsky@amd.com> wrote:
>> I RBed, see bellow.
> Can you push the patch to drm-misc?
>
> Alex
>
>> Andrey
>>
>> On 2022-08-31 14:34, Randy Dunlap wrote:
>>> ping?
>>>
>>> On 4/4/22 14:58, Andrey Grodzovsky wrote:
>>>> Reviewed-by: Andrey Grodzovsky <andrey.grodzovsky@amd.com>
>>>> Andrey
>>>>
>>>> On 2022-04-04 17:30, Randy Dunlap wrote:
>>>>> Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c.
>>>>>
>>>>> Quashes these warnings:
>>>>>
>>>>> include/drm/gpu_scheduler.h:332: warning: missing initial short description on line:
>>>>>     * struct drm_sched_backend_ops
>>>>> include/drm/gpu_scheduler.h:412: warning: missing initial short description on line:
>>>>>     * struct drm_gpu_scheduler
>>>>> include/drm/gpu_scheduler.h:461: warning: Function parameter or member 'dev' not described in 'drm_gpu_scheduler'
>>>>>
>>>>> drivers/gpu/drm/scheduler/sched_main.c:201: warning: missing initial short description on line:
>>>>>     * drm_sched_dependency_optimized
>>>>> drivers/gpu/drm/scheduler/sched_main.c:995: warning: Function parameter or member 'dev' not described in 'drm_sched_init'
>>>>>
>>>>> Fixes: 2d33948e4e00 ("drm/scheduler: add documentation")
>>>>> Fixes: 8ab62eda177b ("drm/sched: Add device pointer to drm_gpu_scheduler")
>>>>> Fixes: 542cff7893a3 ("drm/sched: Avoid lockdep spalt on killing a processes")
>>>>> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
>>>>> Cc: David Airlie <airlied@linux.ie>
>>>>> Cc: Daniel Vetter <daniel@ffwll.ch>
>>>>> Cc: Andrey Grodzovsky <andrey.grodzovsky@amd.com>
>>>>> Cc: Nayan Deshmukh <nayan26deshmukh@gmail.com>
>>>>> Cc: Alex Deucher <alexander.deucher@amd.com>
>>>>> Cc: Christian König <christian.koenig@amd.com>
>>>>> Cc: Jiawei Gu <Jiawei.Gu@amd.com>
>>>>> Cc: dri-devel@lists.freedesktop.org
>>>>> Acked-by: Christian König <christian.koenig@amd.com>
>>>>> ---
>>>>> Feel free to make changes or suggest changes...
>>>>>
>>>>> v2: drop @work description (already done by Andrey)
>>>>>
>>>>>     drivers/gpu/drm/scheduler/sched_main.c |    3 ++-
>>>>>     include/drm/gpu_scheduler.h            |    9 +++++----
>>>>>     2 files changed, 7 insertions(+), 5 deletions(-)
>>>>>
>>>>> --- linux-next-20220404.orig/drivers/gpu/drm/scheduler/sched_main.c
>>>>> +++ linux-next-20220404/drivers/gpu/drm/scheduler/sched_main.c
>>>>> @@ -198,7 +198,7 @@ static void drm_sched_job_done_cb(struct
>>>>>     }
>>>>>       /**
>>>>> - * drm_sched_dependency_optimized
>>>>> + * drm_sched_dependency_optimized - test if the dependency can be optimized
>>>>>      *
>>>>>      * @fence: the dependency fence
>>>>>      * @entity: the entity which depends on the above fence
>>>>> @@ -984,6 +984,7 @@ static int drm_sched_main(void *param)
>>>>>      *        used
>>>>>      * @score: optional score atomic shared with other schedulers
>>>>>      * @name: name used for debugging
>>>>> + * @dev: target &struct device
>>>>>      *
>>>>>      * Return 0 on success, otherwise error code.
>>>>>      */
>>>>> --- linux-next-20220404.orig/include/drm/gpu_scheduler.h
>>>>> +++ linux-next-20220404/include/drm/gpu_scheduler.h
>>>>> @@ -328,10 +328,10 @@ enum drm_gpu_sched_stat {
>>>>>     };
>>>>>       /**
>>>>> - * struct drm_sched_backend_ops
>>>>> + * struct drm_sched_backend_ops - Define the backend operations
>>>>> + *    called by the scheduler
>>>>>      *
>>>>> - * Define the backend operations called by the scheduler,
>>>>> - * these functions should be implemented in driver side.
>>>>> + * These functions should be implemented in the driver side.
>>>>>      */
>>>>>     struct drm_sched_backend_ops {
>>>>>         /**
>>>>> @@ -408,7 +408,7 @@ struct drm_sched_backend_ops {
>>>>>     };
>>>>>       /**
>>>>> - * struct drm_gpu_scheduler
>>>>> + * struct drm_gpu_scheduler - scheduler instance-specific data
>>>>>      *
>>>>>      * @ops: backend operations provided by the driver.
>>>>>      * @hw_submission_limit: the max size of the hardware queue.
>>>>> @@ -434,6 +434,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: system &struct device
>>>>>      *
>>>>>      * One scheduler is implemented for each hardware ring.
>>>>>      */