From patchwork Tue Jan 21 15:15:45 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Philipp Stanner X-Patchwork-Id: 13946413 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id CB1ADC02182 for ; Tue, 21 Jan 2025 15:16:53 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 54CD210E5E6; Tue, 21 Jan 2025 15:16:53 +0000 (UTC) Authentication-Results: gabe.freedesktop.org; dkim=pass (2048-bit key; unprotected) header.d=kernel.org header.i=@kernel.org header.b="rOXIrtyv"; dkim-atps=neutral Received: from dfw.source.kernel.org (dfw.source.kernel.org [139.178.84.217]) by gabe.freedesktop.org (Postfix) with ESMTPS id 36F7610E5E6 for ; Tue, 21 Jan 2025 15:16:52 +0000 (UTC) Received: from smtp.kernel.org (transwarp.subspace.kernel.org [100.75.92.58]) by dfw.source.kernel.org (Postfix) with ESMTP id 3BAA85C289E; Tue, 21 Jan 2025 15:16:11 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id EC4DCC4CEDF; Tue, 21 Jan 2025 15:16:47 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1737472611; bh=OiXJvgk8kbxD6gc50ANNpufqFzqJSKtUAwGGdTi3SdI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=rOXIrtyvJEOOkDbQQlfrcMjrB7BCN7aOql+jys8FxWvjhI1kKWV7jrRaSEXd3RNZ1 5DMMNqlnIU+FB5/3TriE5r3TB7RzvlKlkum8k/CAsfpph6wve+O99+808wn8eSoGXv VZCgW+GvvODfDJ0W99zFJW2JnIXLIsF4XxGo6RIF2C/dUzAmwN3k9Oobsbd230g35+ qwtZ+y0p+/goOoIqJUh94z5x52doVAVhq2CXKRw+KaZNZ0B3FkpjMgdCixS+sGS3mt FLwTzMp/6sgSDuQ0tFfJS8cAQLh3z3jLrYzgyyTGcDez2IUu/DoOa9MQzSuBhedQi7 F6rw4unU0kMeg== From: Philipp Stanner To: Matthew Brost , Danilo Krummrich , Philipp Stanner , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , David Airlie , Simona Vetter , Sumit Semwal , =?utf-8?q?Christian_K=C3=B6nig?= Cc: dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org, linux-media@vger.kernel.org, linaro-mm-sig@lists.linaro.org, Philipp Stanner Subject: [PATCH v2 2/3] drm/sched: Adjust outdated docu for run_job() Date: Tue, 21 Jan 2025 16:15:45 +0100 Message-ID: <20250121151544.44949-5-phasta@kernel.org> X-Mailer: git-send-email 2.47.1 In-Reply-To: <20250121151544.44949-2-phasta@kernel.org> References: <20250121151544.44949-2-phasta@kernel.org> MIME-Version: 1.0 X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" The documentation for drm_sched_backend_ops.run_job() mentions a certain function called drm_sched_job_recovery(). This function does not exist. What's actually meant is drm_sched_resubmit_jobs(), which is by now also deprecated. Remove the mention of the removed function. Discourage the behavior of drm_sched_backend_ops.run_job() being called multiple times for the same job. Signed-off-by: Philipp Stanner --- Folks, I need input for those "refcount" rules. I say that we either delete that section or someone (Christian?) should provide details about what those rules are, as Danilo requested. P. --- include/drm/gpu_scheduler.h | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/include/drm/gpu_scheduler.h b/include/drm/gpu_scheduler.h index d5cd2a78f27c..cf40fdb55541 100644 --- a/include/drm/gpu_scheduler.h +++ b/include/drm/gpu_scheduler.h @@ -421,14 +421,19 @@ struct drm_sched_backend_ops { /** * @run_job: Called to execute the job once all of the dependencies - * have been resolved. This may be called multiple times, if - * timedout_job() has happened and drm_sched_job_recovery() decides to - * try it again. + * have been resolved. + * + * The deprecated drm_sched_resubmit_jobs() (called from + * drm_sched_backend_ops.timedout_job()) can invoke this again with the + * same parameters. Doing this is strongly discouraged because it + * violates dma_fence rules. * * @sched_job: the job to run * - * Returns: dma_fence the driver must signal once the hardware has - * completed the job ("hardware fence"). + * Returns: + * On success: dma_fence the driver must signal once the hardware has + * completed the job ("hardware fence"). + * On failure: NULL or an ERR_PTR. * * Note that the scheduler expects to 'inherit' its own reference to * this fence from the callback. It does not invoke an extra