Re: [PATCH v3 2/4] clk: add kernel docs for struct clk_core

[Randy Dunlap]

On 5/11/26 6:35 PM, Brian Masney wrote:
> Document all of the members of struct clk_core.
> 
> Signed-off-by: Brian Masney <bmasney@xxxxxxxxxx>

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Thanks.

> ---
>  drivers/clk/clk.c | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 51 insertions(+)
> 
> diff --git a/drivers/clk/clk.c b/drivers/clk/clk.c
> index 048adfa86a5d..0b519d95bbcb 100644
> --- a/drivers/clk/clk.c
> +++ b/drivers/clk/clk.c
> @@ -63,6 +63,57 @@ struct clk_parent_map {
>  	int			index;
>  };
>  
> +/**
> + * struct clk_core - The internal state of a clk in the clk tree.
> + * @name:              Unique name of the clk for identification.
> + * @ops:               Pointer to hardware-specific operations for this clk.
> + * @hw:                Pointer for traversing from a struct clk to its
> + *                     corresponding hardware-specific structure.
> + * @owner:             Kernel module owning this clk (for reference counting).
> + * @dev:               Device associated with this clk (optional)
> + * @rpm_node:          Node for runtime power management list management.
> + * @of_node:           Device tree node associated with this clk (if applicable)
> + * @parent:            Pointer to the current parent in the clock tree.
> + * @parents:           Array of possible parents (for muxes/selectable parents).
> + * @num_parents:       Number of possible parents.
> + * @new_parent_index:  Index of the new parent during parent change operations.
> + * @rate:              Current cached clock rate (Hz).
> + * @req_rate:          The last rate requested by a call to clk_set_rate(). It's
> + *                     initialized to clk_core->rate. It's also updated to
> + *                     clk_core->rate every time the clock is reparented, and
> + *                     when we're doing the orphan -> !orphan transition.
> + * @new_rate:          New rate to be set during a rate change operation.
> + * @new_parent:        Pointer to new parent during parent change. This is also
> + *                     used when a clk's rate is changed.
> + * @new_child:         Pointer to new child during reparenting. This is also
> + *                     used when a clk's rate is changed.
> + * @flags:             Clock property and capability flags. See
> + *                     `clk framework flags`.
> + * @orphan:            True if this clk is currently orphaned.
> + * @rpm_enabled:       True if runtime power management is enabled for this clk.
> + * @enable_count:      Reference count of enables.
> + * @prepare_count:     Reference count of prepares.
> + * @protect_count:     Protection reference count against disable.
> + * @min_rate:          Minimum supported clock rate (Hz).
> + * @max_rate:          Maximum supported clock rate (Hz).
> + * @accuracy:          Accuracy of the clock rate (parts per billion).
> + * @phase:             Current phase (degrees).
> + * @duty:              Current duty cycle configuration (as ratio: num/den).
> + * @children:          All of the children of this clk.
> + * @child_node:        Node for linking as a child in the parent's list.
> + * @hashtable_node:    Node for hash table that allows fast clk lookup by name.
> + * @clks:              All of the clk consumers registered.
> + * @notifier_count:    Number of notifiers registered for this clk.
> + * @dentry:            DebugFS entry for this clk.
> + * @debug_node:        DebugFS node for this clk.
> + * @ref:               Reference count for structure lifetime management.
> + *
> + * Managed by the clk framework. Clk providers and consumers do not interact
> + * with this structure directly. Instead, clk operations flow through the
> + * framework and the framework manipulates this structure to keep track of
> + * parent/child relationships, rate, enable state, etc.
> + *
> + */
>  struct clk_core {
>  	const char		*name;
>  	const struct clk_ops	*ops;
> 

-- 
~Randy