Commit f1fb23a0 authored by Randy Dunlap's avatar Randy Dunlap Committed by Helge Deller
Browse files

fbdev: ipu-v3: clean up kernel-doc warnings 



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: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarPhilipp Zabel <p.zabel@pengutronix.de>
Signed-off-by: default avatarHelge Deller <deller@gmx.de>
parent 254f4963

include/video/imx-ipu-image-convert.h

+11 −5
Original line number Diff line number Diff line
@@ -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_image *in, struct ipu_image *out, 
 * @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_image *in, struct ipu_image *out, 
 * @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 ipu_image_convert_ctx *ctx); 
 * 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_image_convert_ctx *ctx); 
 * 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,