| From 3993546646baf1dab5f5c4f7d9bb58f2046fd1c1 Mon Sep 17 00:00:00 2001 |
| From: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com> |
| Date: Sat, 28 May 2016 23:02:50 +0300 |
| Subject: of: irq: fix of_irq_get[_byname]() kernel-doc |
| |
| From: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com> |
| |
| commit 3993546646baf1dab5f5c4f7d9bb58f2046fd1c1 upstream. |
| |
| The kernel-doc for the of_irq_get[_byname]() is clearly inadequate in |
| describing the return values -- of_irq_get_byname() is documented better |
| than of_irq_get() but it still doesn't mention that 0 is returned iff |
| irq_create_of_mapping() fails (it doesn't return an error code in this |
| case). Document all possible return value variants, making the writing |
| of the word "IRQ" consistent, while at it... |
| |
| Fixes: 9ec36cafe43b ("of/irq: do irq resolution in platform_get_irq") |
| Fixes: ad69674e73a1 ("of/irq: do irq resolution in platform_get_irq_byname()") |
| Signed-off-by: Sergei Shtylyov <sergei.shtylyov@cogentembedded.com> |
| Signed-off-by: Rob Herring <robh@kernel.org> |
| Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> |
| |
| --- |
| drivers/of/irq.c | 19 ++++++++++--------- |
| 1 file changed, 10 insertions(+), 9 deletions(-) |
| |
| --- a/drivers/of/irq.c |
| +++ b/drivers/of/irq.c |
| @@ -386,13 +386,13 @@ int of_irq_to_resource(struct device_nod |
| EXPORT_SYMBOL_GPL(of_irq_to_resource); |
| |
| /** |
| - * of_irq_get - Decode a node's IRQ and return it as a Linux irq number |
| + * of_irq_get - Decode a node's IRQ and return it as a Linux IRQ number |
| * @dev: pointer to device tree node |
| - * @index: zero-based index of the irq |
| - * |
| - * Returns Linux irq number on success, or -EPROBE_DEFER if the irq domain |
| - * is not yet created. |
| + * @index: zero-based index of the IRQ |
| * |
| + * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or |
| + * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case |
| + * of any other failure. |
| */ |
| int of_irq_get(struct device_node *dev, int index) |
| { |
| @@ -413,12 +413,13 @@ int of_irq_get(struct device_node *dev, |
| EXPORT_SYMBOL_GPL(of_irq_get); |
| |
| /** |
| - * of_irq_get_byname - Decode a node's IRQ and return it as a Linux irq number |
| + * of_irq_get_byname - Decode a node's IRQ and return it as a Linux IRQ number |
| * @dev: pointer to device tree node |
| - * @name: irq name |
| + * @name: IRQ name |
| * |
| - * Returns Linux irq number on success, or -EPROBE_DEFER if the irq domain |
| - * is not yet created, or error code in case of any other failure. |
| + * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or |
| + * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case |
| + * of any other failure. |
| */ |
| int of_irq_get_byname(struct device_node *dev, const char *name) |
| { |
