lkml.org 
[lkml]   [2018]   [Jan]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 06/20] clocksource/drivers/timer-of: Add kernel documentation
    Date
    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 <daniel.lezcano@linaro.org>
    ---
    drivers/clocksource/timer-of.c | 38 ++++++++++++++++++++++++++++++++++++++
    1 file changed, 38 insertions(+)

    diff --git a/drivers/clocksource/timer-of.c b/drivers/clocksource/timer-of.c
    index ad55654..2af8b8a 100644
    --- a/drivers/clocksource/timer-of.c
    +++ b/drivers/clocksource/timer-of.c
    @@ -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)
    {
    --
    2.7.4
    \
     
     \ /
      Last update: 2018-01-14 23:17    [W:4.132 / U:0.516 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site