From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 56EB54BEE43 for ; Sat, 12 Sep 2026 16:25:20 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=213.167.242.64 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1789230322; cv=none; b=VW6Hfu0F6QdUolPtVr+Uj7RLkCjqh2UvXRzNyEtK5P1iSqzOK3O7Gkne4m6hrsiOsCpsfpEJAv5lgJAExI5/WFuaHC6wj5vpuT5ANH3siDRNuV8jfjvEdj5fUx1gjTlTOeWPGtWg0Yf5cGLeB/B5oImazOSiaTd7mH2j9ZPoPMs= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1789230322; c=relaxed/simple; bh=4CNMsE42yELW6hDHST/90JepYoJVdDA+goTAW3rWuyM=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=TF3rt5B1bWQ0G6OWq5svzL6y8PlS5kGhHEb1XcJ371dv9iTj2CLg3Bfb83Xv17ZLqUr6/blRCswimveHoujx0iP2A4tOT8bntVHWrPvB0J0NAzhOtjee2691kTsPtPBzfLFmck3or2G9iwn/dz2HZyuTrAbanp2Wgf3fNh1R748= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=ideasonboard.com; spf=pass smtp.mailfrom=ideasonboard.com; dkim=pass (1024-bit key) header.d=ideasonboard.com header.i=@ideasonboard.com header.b=mbwXM8Rc; arc=none smtp.client-ip=213.167.242.64 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=ideasonboard.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=ideasonboard.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="mbwXM8Rc" Received: from killaraus.ideasonboard.com (2001-14ba-70f3-e800--a06.rev.dnainternet.fi [IPv6:2001:14ba:70f3:e800::a06]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 630F94DC; Sat, 12 Sep 2026 18:23:39 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1789230219; bh=4CNMsE42yELW6hDHST/90JepYoJVdDA+goTAW3rWuyM=; h=Date:From:To:Cc:Subject:References:In-Reply-To:From; b=mbwXM8Rcfk72aBduE7Xs1WJx4R3sYcegGVk1n7Bp3ILBqZsrsZXsj5ZnKW3+w76CS 3r/xHqnGUC3HHXboVpWY9p3qvfrzRkKcWQrMOpsppZ1LOQ6xKracJ1hP7+H6SC7CEJ Bx2rzxFswzhecijDasASZFJAUhuMq8IPGvI7oQ08= Date: Sat, 12 Sep 2026 19:25:16 +0300 From: Laurent Pinchart To: Karl Mehltretter Cc: Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , David Airlie , Simona Vetter , Sam Ravnborg , Danilo Krummrich , Liviu Dudau , dri-devel@lists.freedesktop.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH] drm/gem-dma: Correct GEM object wrapper documentation Message-ID: <20260912162516.GA1892234@killaraus.ideasonboard.com> References: <20260912063258.43169-1-kmehltretter@gmail.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline In-Reply-To: <20260912063258.43169-1-kmehltretter@gmail.com> On Sat, Sep 12, 2026 at 08:32:58AM +0200, Karl Mehltretter wrote: > The drm_gem_dma_object_free() wrapper calls drm_gem_dma_free(), but its > description still names the former drm_gem_dma_free_object() helper. > Update the reference to match the wrapped function. > > Also correct drm_gem_dma_object_get_sg_table() to document an error > pointer on failure. It forwards the result of > drm_gem_dma_get_sg_table(), which returns ERR_PTR() rather than NULL on > failure. > > Fixes: e580ea25c08d ("drm/cma-helper: Pass GEM CMA object in public interfaces") > Fixes: 05b1de51df07 ("drm/cma-helper: Export dedicated wrappers for GEM object functions") > Assisted-by: LLM Throwing LLMs at this kind of things is neither a good use of computing resources nor a good use of maintainer time. Please refrain from doing so in the future. > Signed-off-by: Karl Mehltretter > --- > include/drm/drm_gem_dma_helper.h | 5 +++-- > 1 file changed, 3 insertions(+), 2 deletions(-) > > diff --git a/include/drm/drm_gem_dma_helper.h b/include/drm/drm_gem_dma_helper.h > index f2678e7ecb9847917e9c6c0287af9815d54bae79..5defd47d7de425515c76391d1825f0ed28077eaa 100644 > --- a/include/drm/drm_gem_dma_helper.h > +++ b/include/drm/drm_gem_dma_helper.h > @@ -52,7 +52,7 @@ extern const struct vm_operations_struct drm_gem_dma_vm_ops; > * drm_gem_dma_object_free - GEM object function for drm_gem_dma_free() > * @obj: GEM object to free > * > - * This function wraps drm_gem_dma_free_object(). Drivers that employ the DMA helpers > + * This function wraps drm_gem_dma_free(). Drivers that employ the DMA helpers > * should use it as their &drm_gem_object_funcs.free handler. > */ > static inline void drm_gem_dma_object_free(struct drm_gem_object *obj) > @@ -87,7 +87,8 @@ static inline void drm_gem_dma_object_print_info(struct drm_printer *p, unsigned > * use it as their &drm_gem_object_funcs.get_sg_table handler. > * > * Returns: > - * A pointer to the scatter/gather table of pinned pages or NULL on failure. > + * A pointer to the scatter/gather table of pinned pages on success, or > + * an ERR_PTR() on failure. > */ > static inline struct sg_table *drm_gem_dma_object_get_sg_table(struct drm_gem_object *obj) > { -- Regards, Laurent Pinchart