[PATCH] genirq/timings: add kernel-doc for a function param

[PATCH] genirq/timings: add kernel-doc for a function param

[Randy Dunlap]

Add the description for @now to eliminate a kernel-doc warning.
(Is this function used? I don't see it being called.)

timings.c:537: warning: Function parameter or struct member 'now' not described in 'irq_timings_next_event'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
---
 kernel/irq/timings.c |    1 +
 1 file changed, 1 insertion(+)

--- linux-next-20250108.orig/kernel/irq/timings.c
+++ linux-next-20250108/kernel/irq/timings.c
@@ -509,6 +509,7 @@ static inline void irq_timings_store(int
 
 /**
  * irq_timings_next_event - Return when the next event is supposed to arrive
+ * @now: current time
  *
  * During the last busy cycle, the number of interrupts is incremented
  * and stored in the irq_timings structure. This information is

Re: [PATCH] genirq/timings: add kernel-doc for a function param

[Thomas Gleixner]

On Fri, Jan 10 2025 at 22:29, Randy Dunlap wrote:

> Add the description for @now to eliminate a kernel-doc warning.
> (Is this function used? I don't see it being called.)

That's indeed a good question.

Daniel, what's the state of this after 7+ years of being in "comes soon"
state?

Thanks,

        tglx

Re: [PATCH] genirq/timings: add kernel-doc for a function param

[Daniel Lezcano]

Hi Thomas,

[Cc'ed Ulf]

On 15/01/2025 10:59, Thomas Gleixner wrote:
> On Fri, Jan 10 2025 at 22:29, Randy Dunlap wrote:
> 
>> Add the description for @now to eliminate a kernel-doc warning.
>> (Is this function used? I don't see it being called.)
> 
> That's indeed a good question.
> 
> Daniel, what's the state of this after 7+ years of being in "comes soon"
> state?

We recently discussed that with Ulf.

The next irq prediction would greatly help during the DSU [1] shut down 
process. As the last CPU going down initiates the DSU shut down, there 
are no more IPI involved and the timer + irq prediction will be much 
more accurate.

However, it is clear that we are talking about this feature since a long 
time and we did not finish its implementation yet, so it is not really 
serious to ask for more retention in the kernel if it is unused.

On the other side, it took me a lot of effort to elaborate the suffix 
based algorithm for the prediction and it would be a pity if we drop it 
because of the lack of progress :(

So, here is my proposal. Ulf and I will do the changes for the DSU power 
down which is reasonable to say it can happen during the next cycle. If 
there is nothing for the end of the next cycle, then we remove the code.

Does it sound good ?



[1] https://developer.arm.com/Processors/DSU-120


-- 
<http://www.linaro.org/> Linaro.org │ Open source software for ARM SoCs

Follow Linaro:  <http://www.facebook.com/pages/Linaro> Facebook |
<http://twitter.com/#!/linaroorg> Twitter |
<http://www.linaro.org/linaro-blog/> Blog

Re: [PATCH] genirq/timings: add kernel-doc for a function param

[Thomas Gleixner]

On Wed, Jan 15 2025 at 13:09, Daniel Lezcano wrote:
> On 15/01/2025 10:59, Thomas Gleixner wrote:
> So, here is my proposal. Ulf and I will do the changes for the DSU power 
> down which is reasonable to say it can happen during the next cycle. If 
> there is nothing for the end of the next cycle, then we remove the code.
>
> Does it sound good ?

Fair enough.

[tip: irq/core] genirq/timings: Add kernel-doc for a function parameter

[tip-bot2 for Randy Dunlap]

The following commit has been merged into the irq/core branch of tip:

Commit-ID:     2bebd2da85640a9bf96fa931064fe7847eca7f0e
Gitweb:        https://git.kernel.org/tip/2bebd2da85640a9bf96fa931064fe7847eca7f0e
Author:        Randy Dunlap <rdunlap@infradead.org>
AuthorDate:    Fri, 10 Jan 2025 22:29:54 -08:00
Committer:     Thomas Gleixner <tglx@linutronix.de>
CommitterDate: Wed, 15 Jan 2025 19:50:55 +01:00

genirq/timings: Add kernel-doc for a function parameter

Add the description for @now to eliminate a kernel-doc warning.

timings.c:537: warning: Function parameter or struct member 'now' not described in 'irq_timings_next_event'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/all/20250111062954.910657-1-rdunlap@infradead.org

---
 kernel/irq/timings.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/kernel/irq/timings.c b/kernel/irq/timings.c
index c43e2ac..4b7315e 100644
--- a/kernel/irq/timings.c
+++ b/kernel/irq/timings.c
@@ -509,6 +509,7 @@ static inline void irq_timings_store(int irq, struct irqt_stat *irqs, u64 ts)
 
 /**
  * irq_timings_next_event - Return when the next event is supposed to arrive
+ * @now: current time
  *
  * During the last busy cycle, the number of interrupts is incremented
  * and stored in the irq_timings structure. This information is

[tip: irq/core] genirq/timings: Add kernel-doc for a function parameter

[tip-bot2 for Randy Dunlap]

The following commit has been merged into the irq/core branch of tip:

Commit-ID:     554d0fee8a5b09e79ec17a9c3867d4d7b7a818c0
Gitweb:        https://git.kernel.org/tip/554d0fee8a5b09e79ec17a9c3867d4d7b7a818c0
Author:        Randy Dunlap <rdunlap@infradead.org>
AuthorDate:    Fri, 10 Jan 2025 22:29:54 -08:00
Committer:     Thomas Gleixner <tglx@linutronix.de>
CommitterDate: Wed, 15 Jan 2025 21:38:53 +01:00

genirq/timings: Add kernel-doc for a function parameter

Add the description for @now to eliminate a kernel-doc warning.

timings.c:537: warning: Function parameter or struct member 'now' not described in 'irq_timings_next_event'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/all/20250111062954.910657-1-rdunlap@infradead.org


---
 kernel/irq/timings.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/kernel/irq/timings.c b/kernel/irq/timings.c
index c43e2ac..4b7315e 100644
--- a/kernel/irq/timings.c
+++ b/kernel/irq/timings.c
@@ -509,6 +509,7 @@ static inline void irq_timings_store(int irq, struct irqt_stat *irqs, u64 ts)
 
 /**
  * irq_timings_next_event - Return when the next event is supposed to arrive
+ * @now: current time
  *
  * During the last busy cycle, the number of interrupts is incremented
  * and stored in the irq_timings structure. This information is