[PATCH] Documentation: clk: update file names containing referenced structures

[PATCH] Documentation: clk: update file names containing referenced structures

[Andi Shyti]

Commit 'b09d6d991' removes include/linux/clk-private.h and
re-arranges the clock related structures contained in it in
different files. The documentation has not been updated
accordingly, thus it wasn't anymore consistent.

Place the structures referenced by Documentation/clk.txt in the
correct files and update their contents to the latest status.

Signed-off-by: Andi Shyti <andi.shyti@samsung.com>
---
 Documentation/clk.txt | 44 +++++++++++++++++++++++---------------------
 1 file changed, 23 insertions(+), 21 deletions(-)

diff --git a/Documentation/clk.txt b/Documentation/clk.txt
index 5c4bc4d..4c106fd 100644
--- a/Documentation/clk.txt
+++ b/Documentation/clk.txt
@@ -38,17 +38,18 @@ clock interface.
 	Part 2 - common data structures and api
 
 Below is the common struct clk definition from
-include/linux/clk-private.h, modified for brevity:
-
-	struct clk {
-		const char		*name;
-		const struct clk_ops	*ops;
-		struct clk_hw		*hw;
-		char			**parent_names;
-		struct clk		**parents;
-		struct clk		*parent;
-		struct hlist_head	children;
-		struct hlist_node	child_node;
+include/linux/clk.c, modified for brevity:
+
+	struct clk_core {
+		const char              *name;
+		const struct clk_ops    *ops;
+		struct clk_hw           *hw;
+		struct module           *owner;
+		struct clk_core         *parent;
+		const char              **parent_names;
+		struct clk_core         **parents;
+		u8                      num_parents;
+		u8                      new_parent_index;
 		...
 	};
 
@@ -58,35 +59,36 @@ struct clk.  That api is documented in include/linux/clk.h.
 
 Platforms and devices utilizing the common struct clk use the struct
 clk_ops pointer in struct clk to perform the hardware-specific parts of
-the operations defined in clk.h:
+the operations defined in clk-provider.h:
 
 	struct clk_ops {
 		int		(*prepare)(struct clk_hw *hw);
 		void		(*unprepare)(struct clk_hw *hw);
+		int		(*is_prepared)(struct clk_hw *hw);
+		void		(*unprepare_unused)(struct clk_hw *hw);
 		int		(*enable)(struct clk_hw *hw);
 		void		(*disable)(struct clk_hw *hw);
 		int		(*is_enabled)(struct clk_hw *hw);
+		void		(*disable_unused)(struct clk_hw *hw);
 		unsigned long	(*recalc_rate)(struct clk_hw *hw,
 						unsigned long parent_rate);
-		long		(*round_rate)(struct clk_hw *hw,
-						unsigned long rate,
+		long		(*round_rate)(struct clk_hw *hw, unsigned long rate,
 						unsigned long *parent_rate);
 		int		(*determine_rate)(struct clk_hw *hw,
 						  struct clk_rate_request *req);
 		int		(*set_parent)(struct clk_hw *hw, u8 index);
 		u8		(*get_parent)(struct clk_hw *hw);
-		int		(*set_rate)(struct clk_hw *hw,
-					    unsigned long rate,
+		int		(*set_rate)(struct clk_hw *hw, unsigned long rate,
 					    unsigned long parent_rate);
 		int		(*set_rate_and_parent)(struct clk_hw *hw,
 					    unsigned long rate,
-					    unsigned long parent_rate,
-					    u8 index);
+					    unsigned long parent_rate, u8 index);
 		unsigned long	(*recalc_accuracy)(struct clk_hw *hw,
-						unsigned long parent_accuracy);
+						   unsigned long parent_accuracy);
+		int		(*get_phase)(struct clk_hw *hw);
+		int		(*set_phase)(struct clk_hw *hw, int degrees);
 		void		(*init)(struct clk_hw *hw);
-		int		(*debug_init)(struct clk_hw *hw,
-					      struct dentry *dentry);
+		int		(*debug_init)(struct clk_hw *hw, struct dentry *dentry);
 	};
 
 	Part 3 - hardware clk implementations
-- 
2.8.0.rc3

Re: [PATCH] Documentation: clk: update file names containing referenced structures

[Jonathan Corbet]

On Thu, 07 Apr 2016 11:48:53 +0900
Andi Shyti <andi.shyti@samsung.com> wrote:

> Commit 'b09d6d991' removes include/linux/clk-private.h and
> re-arranges the clock related structures contained in it in
> different files. The documentation has not been updated
> accordingly, thus it wasn't anymore consistent.
> 
> Place the structures referenced by Documentation/clk.txt in the
> correct files and update their contents to the latest status.
[...]
>  Below is the common struct clk definition from
> -include/linux/clk-private.h, modified for brevity:
> -
> -	struct clk {
> -		const char		*name;
> -		const struct clk_ops	*ops;
> -		struct clk_hw		*hw;
> -		char			**parent_names;
> -		struct clk		**parents;
> -		struct clk		*parent;
> -		struct hlist_head	children;
> -		struct hlist_node	child_node;
> +include/linux/clk.c, modified for brevity:
> +

Um...include/linux/clk.c?  We have 19 files named clk.c, but none of them
(unsurprisingly) are under include/ .  

The patch also seems to have a bunch of gratuitous white-space changes?

jon

Re: [PATCH] Documentation: clk: update file names containing referenced structures

[Andi Shyti]

> > Commit 'b09d6d991' removes include/linux/clk-private.h and
> > re-arranges the clock related structures contained in it in
> > different files. The documentation has not been updated
> > accordingly, thus it wasn't anymore consistent.
> > 
> > Place the structures referenced by Documentation/clk.txt in the
> > correct files and update their contents to the latest status.
> [...]
> >  Below is the common struct clk definition from
> > -include/linux/clk-private.h, modified for brevity:
> > -
> > -	struct clk {
> > -		const char		*name;
> > -		const struct clk_ops	*ops;
> > -		struct clk_hw		*hw;
> > -		char			**parent_names;
> > -		struct clk		**parents;
> > -		struct clk		*parent;
> > -		struct hlist_head	children;
> > -		struct hlist_node	child_node;
> > +include/linux/clk.c, modified for brevity:
> > +
> 
> Um...include/linux/clk.c?  We have 19 files named clk.c, but none of them
> (unsurprisingly) are under include/ .  
> 
> The patch also seems to have a bunch of gratuitous white-space changes?

yes, sorry, I put too little brain when I formatted it and I was 
too fast when I sent it... I will put a little more brain next
time :)

Thanks,
Andi