| Message ID | 20191004163955.14419-3-corbet@lwn.net |
|---|---|
| State | Accepted |
| Commit | 5ca470a0c3886b80ec13c3a19e9aae4c2f469202 |
| Headers | show |
| Series | Improvements to the genericirq documentation | expand |
On Fri, 4 Oct 2019, Jonathan Corbet wrote: > While checking the results of the :c:func: removal, I noticed that there > was no documentation for request_irq(), and request_threaded_irq() was not > mentioned at all. Add a kerneldoc comment for request_irq() and add > request_threaded_irq() to the list of functions. > > Signed-off-by: Jonathan Corbet <corbet@lwn.net> Reviewed-by: Thomas Gleixner <tglx@linutronix.de> Which reminds me that this documentation really needs some thorough rewrite ...
On Fri, 15 Nov 2019 19:23:29 +0100 (CET) Thomas Gleixner <tglx@linutronix.de> wrote: > On Fri, 4 Oct 2019, Jonathan Corbet wrote: > > > While checking the results of the :c:func: removal, I noticed that there > > was no documentation for request_irq(), and request_threaded_irq() was not > > mentioned at all. Add a kerneldoc comment for request_irq() and add > > request_threaded_irq() to the list of functions. > > > > Signed-off-by: Jonathan Corbet <corbet@lwn.net> Heh...I'd forgotten about this one... > Reviewed-by: Thomas Gleixner <tglx@linutronix.de> Thanks, I'll go ahead and apply it. jon
diff --git a/Documentation/core-api/genericirq.rst b/Documentation/core-api/genericirq.rst index 2e6c99e3ce3b..8f06d885c310 100644 --- a/Documentation/core-api/genericirq.rst +++ b/Documentation/core-api/genericirq.rst @@ -127,6 +127,8 @@ The high-level Driver API consists of following functions: - request_irq() +- request_threaded_irq() + - free_irq() - disable_irq() diff --git a/include/linux/interrupt.h b/include/linux/interrupt.h index 89fc59dab57d..ba873ec7e09d 100644 --- a/include/linux/interrupt.h +++ b/include/linux/interrupt.h @@ -140,6 +140,19 @@ request_threaded_irq(unsigned int irq, irq_handler_t handler, irq_handler_t thread_fn, unsigned long flags, const char *name, void *dev); +/** + * request_irq - Add a handler for an interrupt line + * @irq: The interrupt line to allocate + * @handler: Function to be called when the IRQ occurs. + * Primary handler for threaded interrupts + * If NULL, the default primary handler is installed + * @flags: Handling flags + * @name: Name of the device generating this interrupt + * @dev: A cookie passed to the handler function + * + * This call allocates an interrupt and establishes a handler; see + * the documentation for request_threaded_irq() for details. + */ static inline int __must_check request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags, const char *name, void *dev)
While checking the results of the :c:func: removal, I noticed that there was no documentation for request_irq(), and request_threaded_irq() was not mentioned at all. Add a kerneldoc comment for request_irq() and add request_threaded_irq() to the list of functions. Signed-off-by: Jonathan Corbet <corbet@lwn.net> --- Documentation/core-api/genericirq.rst | 2 ++ include/linux/interrupt.h | 13 +++++++++++++ 2 files changed, 15 insertions(+) -- 2.21.0