RE: [RFC PATCH v7 2/8] dpll: Add DPLL framework base functions

From: Jakub Kicinski <kuba@kernel.org>
Sent: Thursday, May 4, 2023 11:21 PM

On Thu, 27 Apr 2023 17:20:03 -0700 Vadim Fedorenko wrote:

quoted

+/**
+ * struct dpll_pin - structure for a dpll pin
+ * @idx:		unique idx given by alloc on global pin's XA
+ * @dev_driver_id:	id given by dev driver
+ * @clock_id:		clock_id of creator
+ * @module:		module of creator
+ * @dpll_refs:		hold referencees to dplls that pin is registered

with

quoted

+ * @pin_refs:		hold references to pins that pin is registered with
+ * @prop:		properties given by registerer
+ * @rclk_dev_name:	holds name of device when pin can recover clock

from it

quoted

+ * @refcount:		refcount
+ **/
+struct dpll_pin {
+	u32 id;
+	u32 pin_idx;
+	u64 clock_id;
+	struct module *module;
+	struct xarray dpll_refs;
+	struct xarray parent_refs;
+	struct dpll_pin_properties prop;
+	char *rclk_dev_name;
+	refcount_t refcount;
+};

The kdoc for structures is quite out of date, please run
./scripts/kernel-doc -none $DPLL_FILES

Done.

quoted

+/**
+ * dpll_device_notify - notify on dpll device change
+ * @dpll: dpll device pointer
+ * @attr: changed attribute
+ *
+ * Broadcast event to the netlink multicast registered listeners.
+ *
+ * Return:
+ * * 0 - success
+ * * negative - error
+ */

Let's move the kdoc to the implementation. I believe that's
the preferred kernel coding style.

Sure, fixed.

Thank you,
Arkadiusz