Commit 007ed790 authored by Randy Dunlap's avatar Randy Dunlap Committed by Greg Kroah-Hartman
Browse files

i3c: fix device.h kernel-doc warnings 



Fix all kernel-doc warnings in <linux/i3c/device.h>:

include/linux/i3c/device.h:27: warning: contents before sections
include/linux/i3c/device.h:196: warning: Excess function parameter 'dev' description in 'dev_to_i3cdev'

Fixes: fa838c8c ("i3c: move dev_to_i3cdev() to use container_of_const()")
Fixes: 3a379bbc ("i3c: Add core I3C infrastructure")
Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Boris Brezillon <boris.brezillon@bootlin.com>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: linux-i3c@lists.infradead.org
Link: https://lore.kernel.org/r/20230213070324.1564-1-rdunlap@infradead.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent ade1229c

include/linux/i3c/device.h

+7 −6
Original line number Diff line number Diff line
@@ -18,17 +18,18 @@ 
/**

 * enum i3c_error_code - I3C error codes

 *

 * @I3C_ERROR_UNKNOWN: unknown error, usually means the error is not I3C

 *		       related

 * @I3C_ERROR_M0: M0 error

 * @I3C_ERROR_M1: M1 error

 * @I3C_ERROR_M2: M2 error

 *

 * These are the standard error codes as defined by the I3C specification.

 * When -EIO is returned by the i3c_device_do_priv_xfers() or

 * i3c_device_send_hdr_cmds() one can check the error code in

 * &struct_i3c_priv_xfer.err or &struct i3c_hdr_cmd.err to get a better idea of

 * what went wrong.

 *

 * @I3C_ERROR_UNKNOWN: unknown error, usually means the error is not I3C

 *		       related

 * @I3C_ERROR_M0: M0 error

 * @I3C_ERROR_M1: M1 error

 * @I3C_ERROR_M2: M2 error

 */

enum i3c_error_code {

	I3C_ERROR_UNKNOWN = 0,
@@ -189,7 +190,7 @@ struct device *i3cdev_to_dev(struct i3c_device *i3cdev); 


/**

 * dev_to_i3cdev() - Returns the I3C device containing @dev

 * @dev: device object

 * @__dev: device object

 *

 * Return: a pointer to an I3C device object.

 */