diff options
| author | Sergei Shtylyov <sergei.shtylyov@cogentembedded.com> | 2016-05-28 23:02:50 +0300 |
|---|---|---|
| committer | Sasha Levin <sasha.levin@oracle.com> | 2016-06-17 15:39:10 -0400 |
| commit | 7c8f7a240e802368d9788cc62cd2324dac53e735 (patch) | |
| tree | 92ecd4930eb711f769c1defc445a539114133102 | |
| parent | 3821aa37f7bd4a98d7c9f01eb915cdae06dde1fb (diff) | |
| download | linux-stable-7c8f7a240e802368d9788cc62cd2324dac53e735.tar.gz linux-stable-7c8f7a240e802368d9788cc62cd2324dac53e735.tar.bz2 linux-stable-7c8f7a240e802368d9788cc62cd2324dac53e735.zip | |
of: irq: fix of_irq_get[_byname]() kernel-doc
[ Upstream commit 3993546646baf1dab5f5c4f7d9bb58f2046fd1c1 ]
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>
CC: stable@vger.kernel.org
Signed-off-by: Rob Herring <robh@kernel.org>
Signed-off-by: Sasha Levin <sasha.levin@oracle.com>
| -rw-r--r-- | drivers/of/irq.c | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/drivers/of/irq.c b/drivers/of/irq.c index 1a7980692f25..f5d497989fcd 100644 --- a/drivers/of/irq.c +++ b/drivers/of/irq.c @@ -385,13 +385,13 @@ int of_irq_to_resource(struct device_node *dev, int index, struct resource *r) 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) { @@ -412,12 +412,13 @@ int of_irq_get(struct device_node *dev, int index) 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) { |