Received-SPF: softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) client-ip=23.128.96.19;
Message-ID: <15abd5c4-a92c-9ef7-32f3-a39ee3a9844b@amd.com>
Date:   Mon, 4 Apr 2022 11:40:33 -0400
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101
 Thunderbird/91.7.0
Subject: Re: [PATCH] drm/scheduler: quieten kernel-doc warnings
Content-Language: en-US
To:     Randy Dunlap <rdunlap@infradead.org>, linux-kernel@vger.kernel.org
Cc:     David Airlie <airlied@linux.ie>, Daniel Vetter <daniel@ffwll.ch>,
        Nayan Deshmukh <nayan26deshmukh@gmail.com>,
        Alex Deucher <alexander.deucher@amd.com>,
        =?UTF-8?Q?Christian_K=c3=b6nig?= <christian.koenig@amd.com>,
        Jiawei Gu <Jiawei.Gu@amd.com>, dri-devel@lists.freedesktop.org
References: <20220404042509.13455-1-rdunlap@infradead.org>
 <6f89be90-50fe-729c-028c-978044e6840a@amd.com>
 <db007d26-95d0-ff59-788a-0339d119224e@infradead.org>
From:   Andrey Grodzovsky <andrey.grodzovsky@amd.com>
In-Reply-To: <db007d26-95d0-ff59-788a-0339d119224e@infradead.org>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 2
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?VjV0a2p3NkpTRGk0ZDRueXpqcnpTcUNNdmc5M1VMU29qdjBHV3ZWa1hYbVBL?=
 =?utf-8?B?eHVlNmdiMi9QVnpqL00xc2J3RS9hNCtGRUFQazd2cUhnWGx2c0U1SExGZ1hT?=
 =?utf-8?B?MFBzanhuc05NRVhqYS9UVzhBUW4yZWhkckRDVWYvdHB0dWhyUmdEUjFDK2Q4?=
 =?utf-8?B?TGhEdFJKUFVrZjB0VWVnbjZoMFFmckxvTnkvOGkrc0NSUHA1cTdnV2lLeE53?=
 =?utf-8?B?TTJsbnBPUWVpWXpQQTNOcndKZC8wQnVSaitxeHVjNzFUazYxcVNRUktPdmpH?=
 =?utf-8?B?UnFnQzFNc09wNFFreFN2cXNYR1V1OUxLZTd2R2NmOFF1TnhQMlZZd0g3aGxa?=
 =?utf-8?B?cEdpUW54a1FDbU4yRktBVEVWazM3RXQ4eHp1RUx4NW1qbUx3UkdxcGRVTms1?=
 =?utf-8?B?VFptTTQrdVJFclRQRVZQOUhFYWc3bXNyYUdSdW1CRDQvOGR0TGwwYVo0VEpR?=
 =?utf-8?B?bExvUFBHZ2hPbng4UWRWb1lWWUx4eURRcmczVWhZUmVlRDNHcjVvdWF2STdt?=
 =?utf-8?B?S2VuU2N5RFRPd0VRNHc1bEZGNTZIMGEyTnJTVmQ2b3pqRzAwYkYySjNPY1Bt?=
 =?utf-8?B?SkYvR0FBbzRvRTFBTHNHdVZtMGhiaTREeHBWOUI3b09RcERnWFptejBTeTF2?=
 =?utf-8?B?UzdpRkRMaVE4SE1DK0FOUmVnQmJvREdTY1R2aHpucWJtb1NZd3VjTXJvQ0NR?=
 =?utf-8?B?UkgrcFM5b2dDWUFzcjN5emNqKzlMSWwyd3RGVUkzdXdlMkJGdkhzR1h2alQx?=
 =?utf-8?B?N0JJZnJGUW1GL25SNHVHNzVQUWYwUWV1MlFJNVo2TUI0cXZRNTdrT0NnWWdJ?=
 =?utf-8?B?K3ArK2xqWG9ZZmlFWW4vaFNNSmVvMU93Ty9Wa1ZMYkw2RExPMDBZYnprTHNP?=
 =?utf-8?B?U2xHWE10VjB5RU9XSlJLVC9mQlBXM21naDFQNkJSUHRFVUpzYTVHYW9kWFh3?=
 =?utf-8?B?Umg0cFhHZWZCK05NRUxORk9wYkRXZHF3ZkFmaERQSlpDeCtwWGs1NlNITkQz?=
 =?utf-8?B?OGg0aCtEYXVQcWdxemhUeVRUNnF1dlBzQXlVNXg5VmRnN085TC9ORnpCMkFD?=
 =?utf-8?B?cUlVZ05xaWZIVVZWRTNabGd1cnh5UUpZSXM5cXpNekVJUGtMd0VpYXZNbXM3?=
 =?utf-8?B?b0h0NlNHUGx4Ry9hSFQrdnVhRzdxOVlLSjllMmNmUExlNmhXSVNVS01na1BN?=
 =?utf-8?B?VHN2TmJqeUg4cko3NEVvd0dzZGNOQXJZaWJsNVJsWHlxN3FzYWV5QlFseExF?=
 =?utf-8?B?bjhIZ2FFR3ZoSHFiQXNRdDk4TGhzODQxTUNuVHlHRUN6ZnZGTEZsK0F5Qm9v?=
 =?utf-8?B?Wi9UY0lxNm9IZ2JaOGhob1pzYjFreWZXQTlrMkl3YUNrbWc2NThqU3I4Qllr?=
 =?utf-8?B?SjZyWU0ySmJYblJVbjQwbHBwNC9nRTB0bUtEQ3FqL1c0Zk16MlFGalExakFG?=
 =?utf-8?B?VURqSGZadzZVZk5oRkk3NnpXZHg2MTRUZlh2SzBGVEJMNkx1WHhIK0hGa1VB?=
 =?utf-8?B?QmhSWEdXZFFnNS96SFdkNWQ5cXJJTExENjMxV0NhVWdJNVBJTmp1Y01nWTd5?=
 =?utf-8?B?c0JabzQ0REJuVGg1a0lnSEs0NWNsbzNKSVArRW0xdW9BWTJuZDJiYytCVXlM?=
 =?utf-8?B?S3B3VGFjTE8xTHp5VnBhRFhjMmtqZE1vMEtnZytySWZLcHpGYXhvZWdEMTc5?=
 =?utf-8?B?ZkdOeVpIVzFoVHJWeUl2b0pjZWxGa29salRxclFNOHBMb3EwM2RCRi8yYXF6?=
 =?utf-8?B?NVNXcG1LMGhoaGxGczZaWmk5TkRqTEsvM0tJeWgzYkR1aUNRU0NCbkxkdlh0?=
 =?utf-8?B?M2M5c0VyOVlpTGRXRUV1eTI1T2orTDdsNGRRQ1dQUlVHNFJjcEZVVXhZRHY1?=
 =?utf-8?B?TmRnZjNybE54bUF3ZVpxclArc2h5SmN0bG00Q3kxL0VHQnlRWWxaUUpWQ09a?=
 =?utf-8?B?bElyemlCalhkUmxNUHgxN01RWEwyUm45U2tCenBuY2pWTG9UcWhKWnh2Z1J6?=
 =?utf-8?B?c29KUnhqQ1J6MG5YbU9HTEI0WDhoSUQrb2tqWUhJOU1XOUl2ajlJTk93V0d3?=
 =?utf-8?B?ejd4bkJ0eG1uaUtZZ3FQcDhZZHdiczlBN1ZzdFRnVFhXbTVJeXk0NEVERDNT?=
 =?utf-8?B?NFI2SVk0ZkdEYVBxemwwalB6blgra2dTOHkvcDZmUVJtVERQK2UwZ3U5Rm1P?=
 =?utf-8?B?bU1hRVhYTEp4a09maFBhUmcwSk5VNkJzZ0cyOUJReWVmVkZmMlFWaUFwNWZM?=
 =?utf-8?B?RC9IZXdFWFJZTzdmalVtTWZIRldSd2MyMFZDN05zZTlVNVA5dUNqaG0yWk1o?=
 =?utf-8?B?M0QzS1Boa1duUkZwNTdyVW8rL2oxYXZIR01CMkJWaVVBV1JQSEpSTGFsUUJV?=
 =?utf-8?Q?YDX6e7loAkZKunlGPRWG5Sg0TNVF8sO1lpQ9vQc60juqh?=
X-MS-Exchange-AntiSpam-MessageData-1: HIVCzeW3DAYNNw==
X-OriginatorOrg: amd.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 80887a12-8e9e-4e76-a665-08da1651762a
X-MS-Exchange-CrossTenant-AuthSource: DM5PR12MB1947.namprd12.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Apr 2022 15:40:35.9202
 (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: LcX2xaX6NxvIpQdkuAw8if6wbtGHtUVHntNpULL+lL6bUEveY4R56iBLsVyObqp4PrPLSNxjSJfVUVavU8Xi6w==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN8PR12MB3571
X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,DKIM_SIGNED,
	DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,
	MAILING_LIST_MULTI,NICE_REPLY_A,RDNS_NONE,SPF_HELO_NONE,
	T_SCC_BODY_TEXT_LINE autolearn=unavailable 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

Seems to me better this way to avoid merge conflicts ?

Andrey

On 2022-04-04 11:33, Randy Dunlap wrote:
> 
> 
> On 4/4/22 07:34, Andrey Grodzovsky wrote:
>> On 2022-04-04 00:25, Randy Dunlap wrote:
>>> Fix kernel-doc warnings in gpu_scheduler.h and sched_main.c.
>>>
>>> Quashes these warnings:
>>>
>>> include/drm/gpu_scheduler.h:316: warning: Function parameter or member 'work' not described in 'drm_sched_job'
>>
>> Looks good to me except one point is that I already commited a fix for the above warning to drm-misc-next.
>>
> 
> OK. Do I need to send a v2 without the header file fix?
> 
> thanks.
> 
>>
>>> 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
>>> ---
>>> Feel free to make changes or suggest changes...
>>>
>>>    drivers/gpu/drm/scheduler/sched_main.c |    3 ++-
>>>    include/drm/gpu_scheduler.h            |   10 ++++++----
>>>    2 files changed, 8 insertions(+), 5 deletions(-)
>>>
>>> --- linux-next-20220401.orig/drivers/gpu/drm/scheduler/sched_main.c
>>> +++ linux-next-20220401/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-20220401.orig/include/drm/gpu_scheduler.h
>>> +++ linux-next-20220401/include/drm/gpu_scheduler.h
>>> @@ -270,6 +270,7 @@ struct drm_sched_fence *to_drm_sched_fen
>>>     * @sched: the scheduler instance on which this job is scheduled.
>>>     * @s_fence: contains the fences for the scheduling of job.
>>>     * @finish_cb: the callback for the finished fence.
>>> + * @work: scheduler work queue
>>>     * @id: a unique id assigned to each job scheduled on the scheduler.
>>>     * @karma: increment on every hang caused by this job. If this exceeds the hang
>>>     *         limit of the scheduler then the job is marked guilty and will not
>>> @@ -328,10 +329,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 +409,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 +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: system &struct device
>>>     *
>>>     * One scheduler is implemented for each hardware ring.
>>>     */
>