diff mbox series

[1/3] hw/qdev: Correct qdev_connect_gpio_out_named() documentation

Message ID 20211105172127.224462-2-f4bug@amsat.org
State New
Headers show
Series hw/qdev: Clarify qdev_connect_gpio_out() documentation | expand

Commit Message

Philippe Mathieu-Daudé Nov. 5, 2021, 5:21 p.m. UTC 
qdev_connect_gpio_out_named() is described as qdev_connect_gpio_out(),
and referring to itself in an endless loop, which is confusing. Fix.

Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
---
 include/hw/qdev-core.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

wangyanan (Y) Nov. 6, 2021, 3:06 a.m. UTC | #1 
Hi Philippe,

On 2021/11/6 1:21, Philippe Mathieu-Daudé wrote:
> qdev_connect_gpio_out_named() is described as qdev_connect_gpio_out(),
> and referring to itself in an endless loop, which is confusing. Fix.
>
> Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
> ---
>   include/hw/qdev-core.h | 5 ++---
>   1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/include/hw/qdev-core.h b/include/hw/qdev-core.h
> index 72622bd3370..5b88c8b9dd3 100644
> --- a/include/hw/qdev-core.h
> +++ b/include/hw/qdev-core.h
> @@ -497,7 +497,8 @@ qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
>    */
>   void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
>   /**
> - * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines
> + * qdev_connect_gpio_out_named: Connect one of a device's named output
> + *                              GPIO lines
>    * @dev: Device whose GPIO to connect
>    * @name: Name of the output GPIO array
>    * @n: Number of the anonymous output GPIO line (which must be in range)
> @@ -518,8 +519,6 @@ void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
>    * It is not valid to try to connect one outbound GPIO to multiple
>    * qemu_irqs at once, or to connect multiple outbound GPIOs to the
>    * same qemu_irq; see qdev_connect_gpio_out() for details.
> - *
> - * For named output GPIO lines, use qdev_connect_gpio_out_named().
After deleting the wrong context, we can also add the right one, like:
"For anonymous output GPIO lines, use qdev_connect_gpio_out()."
>    */
>   void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
>                                    qemu_irq pin);
Having a further, the description of qdev_init_gpio_out_named() also needs
a tweak. Maybe we can squash that fix in this patch too.

Thanks,
Yanan
diff mbox series

Patch

diff --git a/include/hw/qdev-core.h b/include/hw/qdev-core.h
index 72622bd3370..5b88c8b9dd3 100644
--- a/include/hw/qdev-core.h
+++ b/include/hw/qdev-core.h
@@ -497,7 +497,8 @@  qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
  */
 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
 /**
- * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines
+ * qdev_connect_gpio_out_named: Connect one of a device's named output
+ *                              GPIO lines
  * @dev: Device whose GPIO to connect
  * @name: Name of the output GPIO array
  * @n: Number of the anonymous output GPIO line (which must be in range)
@@ -518,8 +519,6 @@  void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
  * It is not valid to try to connect one outbound GPIO to multiple
  * qemu_irqs at once, or to connect multiple outbound GPIOs to the
  * same qemu_irq; see qdev_connect_gpio_out() for details.
- *
- * For named output GPIO lines, use qdev_connect_gpio_out_named().
  */
 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
                                  qemu_irq pin);