Commit 94798081 authored by Dmitry Torokhov's avatar Dmitry Torokhov Committed by Danilo Krummrich
Browse files

driver core: platform: add kerneldoc to struct platform_device_info



Add kernel documentation for struct platform_device_info and its
individual members. While at it remove an extra indent level from the
structure definition.

Signed-off-by: default avatarDmitry Torokhov <dmitry.torokhov@gmail.com>
Reviewed-by: default avatarBartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>
Link: https://patch.msgid.link/20260214025246.2095239-2-dmitry.torokhov@gmail.com


Signed-off-by: default avatarDanilo Krummrich <dakr@kernel.org>
parent 11439c46
Loading
Loading
Loading
Loading
+42 −11
Original line number Diff line number Diff line
@@ -118,6 +118,37 @@ extern int platform_get_irq_byname_optional(struct platform_device *dev,
					    const char *name);
extern int platform_add_devices(struct platform_device **, int);

/**
 * struct platform_device_info - set of parameters for creating a platform device
 * @parent: parent device for the new platform device.
 * @fwnode: firmware node associated with the device.
 * @of_node_reused: indicates that device tree node associated with the device
 *	is shared with another device, typically its ancestor. Setting this to
 *	%true prevents the device from being matched via the OF match table,
 *	and stops the device core from automatically binding pinctrl
 *	configuration to avoid disrupting the other device.
 * @name: name of the device.
 * @id: instance ID of the device. Use %PLATFORM_DEVID_NONE if there is only
 *	one instance of the device, or %PLATFORM_DEVID_AUTO to let the
 *	kernel automatically assign a unique instance ID.
 * @res: set of resources to attach to the device.
 * @num_res: number of entries in @res.
 * @data: device-specific data for this platform device.
 * @size_data: size of device-specific data.
 * @dma_mask: DMA mask for the device.
 * @properties: a set of software properties for the device. If provided,
 *	a managed software node will be automatically created and
 *	assigned to the device. The properties array must be terminated
 *	with a sentinel entry.
 *
 * This structure is used to hold information needed to create and register
 * a platform device using platform_device_register_full().
 *
 * platform_device_register_full() makes deep copies of @name, @res, @data and
 * @properties, so the caller does not need to keep them after registration.
 * If the registration is performed during initialization, these can be marked
 * as __initconst.
 */
struct platform_device_info {
	struct device *parent;
	struct fwnode_handle *fwnode;