clocksource/drivers/timer-of: Fix function names
PATCH 1/2 clocksource/drivers/timer-of: Fix function names
All the functions are not prefixed with 'timer_of_', fix the naming in order to have the code consistent.
Signed-off-by Daniel Lezcano <[email protected]>
--- drivers/clocksource/timer-of.c | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-)
drivers/clocksource/timer-of.c +18 -18
@@ -24,7 +24,7 @@#include "timer-of.h" -static __init void timer_irq_exit (struct of_timer_irq *of_irq) +static __init void timer_of_irq_exit (struct of_timer_irq *of_irq) { struct timer_of *to = container_of(of_irq, struct timer_of, of_irq);
@@ -34,8 +34,8 @@ static __init void timer_irq_exit(struct of_timer_irq *of_irq)free_irq (of_irq->irq, clkevt); } -static __init int timer_irq_init (struct device_node *np, -struct of_timer_irq *of_irq) +static __init int timer_of_irq_init (struct device_node *np, +struct of_timer_irq *of_irq) {int ret; struct timer_of *to = container_of(of_irq, struct timer_of, of_irq);
@@ -72,15 +72,15 @@ static __init int timer_irq_init(struct device_node *np,return 0 ; } -static __init void timer_clk_exit (struct of_timer_clk *of_clk) +static __init void timer_of_clk_exit (struct of_timer_clk *of_clk) { of_clk->rate =0 ;clk_disable_unprepare (of_clk->clk);clk_put (of_clk->clk); } -static __init int timer_clk_init (struct device_node *np, -struct of_timer_clk *of_clk) +static __init int timer_of_clk_init (struct device_node *np, +struct of_timer_clk *of_clk) {int ret;
@@ -116,13 +116,13 @@ static __init int timer_clk_init(struct device_node *np, goto out; } -static __init void timer_base_exit (struct of_timer_base *of_base) +static __init void timer_of_base_exit (struct of_timer_base *of_base) {iounmap (of_base->base); } -static __init int timer_base_init (struct device_node *np, -struct of_timer_base *of_base) +static __init int timer_of_base_init (struct device_node *np, +struct of_timer_base *of_base) {const char *name = of_base->name ? of_base->name : np->full_name;
@@ -141,21 +141,21 @@ int __init timer_of_init(struct device_node *np, struct timer_of *to)int flags =0 ;if (to->flags &TIMER_OF_BASE ) { - ret =timer_base_init (np, &to->of_base); + ret =timer_of_base_init (np, &to->of_base);if (ret) goto out_fail; flags |=TIMER_OF_BASE ; }if (to->flags &TIMER_OF_CLOCK ) { - ret =timer_clk_init (np, &to->of_clk); + ret =timer_of_clk_init (np, &to->of_clk);if (ret) goto out_fail; flags |=TIMER_OF_CLOCK ; }if (to->flags &TIMER_OF_IRQ ) { - ret =timer_irq_init (np, &to->of_irq); + ret =timer_of_irq_init (np, &to->of_irq);if (ret) goto out_fail; flags |=TIMER_OF_IRQ ;
@@ -167,13 +167,13 @@ int __init timer_of_init(struct device_node *np, struct timer_of *to) out_fail:if (flags &TIMER_OF_IRQ ) -timer_irq_exit (&to->of_irq); +timer_of_irq_exit (&to->of_irq);if (flags &TIMER_OF_CLOCK ) -timer_clk_exit (&to->of_clk); +timer_of_clk_exit (&to->of_clk);if (flags &TIMER_OF_BASE ) -timer_base_exit (&to->of_base); +timer_of_base_exit (&to->of_base);return ret; }
@@ -187,11 +187,11 @@ int __init timer_of_init(struct device_node *np, struct timer_of *to)void __init timer_of_cleanup (struct timer_of *to) {if (to->flags &TIMER_OF_IRQ ) -timer_irq_exit (&to->of_irq); +timer_of_irq_exit (&to->of_irq);if (to->flags &TIMER_OF_CLOCK ) -timer_clk_exit (&to->of_clk); +timer_of_clk_exit (&to->of_clk);if (to->flags &TIMER_OF_BASE ) -timer_base_exit (&to->of_base); +timer_of_base_exit (&to->of_base); }
Signature · 1 line
2.7.4
PATCH 2/2 clocksource/drivers/timer-of: Add kernel documentation
The current code has no comment, neither function description. Fix this by adding a kernel doc format for the function description.
Signed-off-by Daniel Lezcano <[email protected]>
--- drivers/clocksource/timer-of.c | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+)
drivers/clocksource/timer-of.c +38 -0
@@ -24,6 +24,12 @@#include "timer-of.h" +/** +* timer_of_irq_exit - Release the interrupt +* @of_irq: an of_timer_irq structure pointer +* +* Free the irq resource +*/ static __init void timer_of_irq_exit (struct of_timer_irq *of_irq) { struct timer_of *to = container_of(of_irq, struct timer_of, of_irq);
@@ -34,6 +40,22 @@ static __init void timer_of_irq_exit(struct of_timer_irq *of_irq)free_irq (of_irq->irq, clkevt); } +/** +* timer_of_irq_init - Request the interrupt +* @np: a device tree node pointer +* @of_irq: an of_timer_irq structure pointer +* +* Get the interrupt number from the DT from its definition and +* request it. The interrupt is get by fallbacking as follow: +* +* - Get interrupt number by name +* - Get interrupt number by index +* +* When the interrupt is per cpu, 'request_percpu_irq' is called +* otherwise, 'request_irq' is used. +* +* Returns 0 on success, < 0 otherwise +*/ static __init int timer_of_irq_init (struct device_node *np,struct of_timer_irq *of_irq) {
@@ -72,6 +94,13 @@ static __init int timer_of_irq_init(struct device_node *np,return 0 ; } +/** +* timer_of_clk_exit - Release the clock resources +* @of_clk: a of_timer_clk structure pointer +* +* Disables and release the refcount on the clk +* +*/ static __init void timer_of_clk_exit (struct of_timer_clk *of_clk) { of_clk->rate =0 ;
@@ -79,6 +108,15 @@ static __init void timer_of_clk_exit(struct of_timer_clk *of_clk)clk_put (of_clk->clk); } +/** +* timer_of_clk_init - Initialize the clock resources +* @np: a device tree node pointer +* @of_clk: a of_timer_clk structure pointer +* +* Get the clock by name or by index, enables it and get the rate +* +* Returns 0 on success, < 0 otherwise +*/ static __init int timer_of_clk_init (struct device_node *np,struct of_timer_clk *of_clk) {
Signature · 1 line
2.7.4