From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (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 8B1763191BD; Thu, 16 Apr 2026 22:44:48 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.137.202.133 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1776379490; cv=none; b=GkidRFl8P86XyVIlmk4tMsBAFFF/PYGdlsZQIk6XYsjDDIzudAh0fqNLX9nnK2p955SgTfoT4mn8hVdmuoyBOYV0BZnADGZFCfaZxQhmuRpra3OJiiIbdLgIY4DpCiSmFYclKnbFEFukSaB9PNmcZQCL9HqsKiO3UIFSa/5IW5E= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1776379490; c=relaxed/simple; bh=+0t4SYHquyA3oakfRA2GOKSWPJ7dOq9Grf4Lkkoe4mk=; h=Message-ID:Date:MIME-Version:Subject:To:Cc:References:From: In-Reply-To:Content-Type; b=jhFjKMrJC/+0vsXU/co0/qkHexcr5Bu1WsLu6Iv5/68xz+sV+B00ggwEQxigxV1GMyGNwDcJqr/goNCoalx4zbNltIW3Go3UU0J8spJ1R+Pujje1JyFFvrCFL1jssWq86KLE7OhkO9K1qql2j7OCRqu8Wdp3x0ak77DHZb3bmF4= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org; spf=none smtp.mailfrom=infradead.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b=lBpjrR8t; arc=none smtp.client-ip=198.137.202.133 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=infradead.org Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=infradead.org Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="lBpjrR8t" DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: Content-Type:In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date: Message-ID:Sender:Reply-To:Content-ID:Content-Description; bh=xOejhf2JTlBUOqRfxdf0lvXpMeOShPqCZFMc+hUVVlA=; b=lBpjrR8tWIGchgX60Dx+3/WuGd z6WoGjbPom/arFHO7QAxC3NtAM+p+0nay1/wyz4eyi85ig4g2oEhSE1rottWgaivgQ/bkLIG6vkz2 56LUcBaN0ACOx1WIiF5PuvDIFo6+4ab8Yaq9SERLeQ9u3Lp4eoPmY/pX5SOaj1FQrt1VP+p3AsgBJ eeVeNGH4LrGBtIJbfeC+bITlD1zcbt4Ds5WVPLlll9p3lDcl+DR0/nmWkr8X9R6rqhBvugLKBKnGM ZEMQcF9vUyFTaJjSpKBrVx7BCSUbMW6TraI4EZvU2WAVwHaHEDizW5hsy0+Nb3BHbv0tDYuSLgAmg IIC67+Sw==; Received: from [50.53.43.113] (helo=[192.168.254.34]) by bombadil.infradead.org with esmtpsa (Exim 4.98.2 #2 (Red Hat Linux)) id 1wDVS0-000000039Xq-1DLf; Thu, 16 Apr 2026 22:44:44 +0000 Message-ID: Date: Thu, 16 Apr 2026 15:44:43 -0700 Precedence: bulk X-Mailing-List: linux-fbdev@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v2] gpu: ipu-v3: clean up kernel-doc warnings To: dri-devel@lists.freedesktop.org Cc: Philipp Zabel , Maarten Lankhorst , Maxime Ripard , Thomas Zimmermann , David Airlie , Simona Vetter , imx@lists.linux.dev, linux-arm-kernel@lists.infradead.org, Helge Deller , linux-fbdev@vger.kernel.org References: <20260219215211.459108-1-rdunlap@infradead.org> Content-Language: en-US From: Randy Dunlap In-Reply-To: <20260219215211.459108-1-rdunlap@infradead.org> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit ping. On 2/19/26 1:52 PM, Randy Dunlap wrote: > Correct all kernel-doc warnings: > - fix a typedef kernel-doc comment > - mark a list_head as private > - use Returns: for function return values > > Warning: include/video/imx-ipu-image-convert.h:31 struct member 'list' not > described in 'ipu_image_convert_run' > Warning: include/video/imx-ipu-image-convert.h:40 function parameter > 'ipu_image_convert_cb_t' not described in 'void' > Warning: include/video/imx-ipu-image-convert.h:40 expecting prototype for > ipu_image_convert_cb_t(). Prototype was for void() instead > Warning: include/video/imx-ipu-image-convert.h:66 No description found for > return value of 'ipu_image_convert_verify' > Warning: include/video/imx-ipu-image-convert.h:90 No description found for > return value of 'ipu_image_convert_prepare' > Warning: include/video/imx-ipu-image-convert.h:125 No description found for > return value of 'ipu_image_convert_queue' > Warning: include/video/imx-ipu-image-convert.h:163 No description found for > return value of 'ipu_image_convert' > > Signed-off-by: Randy Dunlap > Reviewed-by: Philipp Zabel > --- > v2: add Reviewed-by, update Cc: list, rebase, resend > > Cc: Philipp Zabel > Cc: Maarten Lankhorst > Cc: Maxime Ripard > Cc: Thomas Zimmermann > Cc: David Airlie > Cc: Simona Vetter > Cc: imx@lists.linux.dev > Cc: linux-arm-kernel@lists.infradead.org > Cc: Helge Deller > Cc: linux-fbdev@vger.kernel.org > > include/video/imx-ipu-image-convert.h | 16 +++++++++++----- > 1 file changed, 11 insertions(+), 5 deletions(-) > > --- linux-next-20260218.orig/include/video/imx-ipu-image-convert.h > +++ linux-next-20260218/include/video/imx-ipu-image-convert.h > @@ -27,12 +27,13 @@ struct ipu_image_convert_run { > > int status; > > + /* private: */ > /* internal to image converter, callers don't touch */ > struct list_head list; > }; > > /** > - * ipu_image_convert_cb_t - conversion callback function prototype > + * typedef ipu_image_convert_cb_t - conversion callback function prototype > * > * @run: the completed conversion run pointer > * @ctx: a private context pointer for the callback > @@ -60,7 +61,7 @@ void ipu_image_convert_adjust(struct ipu > * @out: output image format > * @rot_mode: rotation mode > * > - * Returns 0 if the formats and rotation mode meet IPU restrictions, > + * Returns: 0 if the formats and rotation mode meet IPU restrictions, > * -EINVAL otherwise. > */ > int ipu_image_convert_verify(struct ipu_image *in, struct ipu_image *out, > @@ -77,11 +78,11 @@ int ipu_image_convert_verify(struct ipu_ > * @complete: run completion callback > * @complete_context: a context pointer for the completion callback > * > - * Returns an opaque conversion context pointer on success, error pointer > + * In V4L2, drivers should call ipu_image_convert_prepare() at streamon. > + * > + * Returns: an opaque conversion context pointer on success, error pointer > * on failure. The input/output formats and rotation mode must already meet > * IPU retrictions. > - * > - * In V4L2, drivers should call ipu_image_convert_prepare() at streamon. > */ > struct ipu_image_convert_ctx * > ipu_image_convert_prepare(struct ipu_soc *ipu, enum ipu_ic_task ic_task, > @@ -122,6 +123,8 @@ void ipu_image_convert_unprepare(struct > * In V4L2, drivers should call ipu_image_convert_queue() while > * streaming to queue the conversion of a received input buffer. > * For example mem2mem devices this would be called in .device_run. > + * > + * Returns: 0 on success or -errno on error. > */ > int ipu_image_convert_queue(struct ipu_image_convert_run *run); > > @@ -155,6 +158,9 @@ void ipu_image_convert_abort(struct ipu_ > * On successful return the caller can queue more run requests if needed, using > * the prepared context in run->ctx. The caller is responsible for unpreparing > * the context when no more conversion requests are needed. > + * > + * Returns: pointer to the created &struct ipu_image_convert_run that has > + * been queued on success; an ERR_PTR(errno) on error. > */ > struct ipu_image_convert_run * > ipu_image_convert(struct ipu_soc *ipu, enum ipu_ic_task ic_task, -- ~Randy