diff mbox series

[2/3] hw/qdev: Rename qdev_connect_gpio_out*() 'input_pin' parameter

Message ID 20211105172127.224462-3-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 
@pin is an input where we connect a device output.
Rename it @input_pin to simplify the documentation.

Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
---
 include/hw/qdev-core.h |  8 ++++----
 hw/core/gpio.c         | 13 +++++++------
 2 files changed, 11 insertions(+), 10 deletions(-)

Comments

wangyanan (Y) Nov. 6, 2021, 3:21 a.m. UTC | #1 
On 2021/11/6 1:21, Philippe Mathieu-Daudé wrote:
> @pin is an input where we connect a device output.
> Rename it @input_pin to simplify the documentation.
>
> Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
> ---
>   include/hw/qdev-core.h |  8 ++++----
>   hw/core/gpio.c         | 13 +++++++------
>   2 files changed, 11 insertions(+), 10 deletions(-)
>
> diff --git a/include/hw/qdev-core.h b/include/hw/qdev-core.h
> index 5b88c8b9dd3..3a0fe643a73 100644
> --- a/include/hw/qdev-core.h
> +++ b/include/hw/qdev-core.h
> @@ -470,7 +470,7 @@ qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
>    * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines
>    * @dev: Device whose GPIO to connect
>    * @n: Number of the anonymous output GPIO line (which must be in range)
> - * @pin: qemu_irq to connect the output line to
> + * @input_pin: qemu_irq to connect the output line to
>    *
>    * This function connects an anonymous output GPIO line on a device
>    * up to an arbitrary qemu_irq, so that when the device asserts that
> @@ -495,14 +495,14 @@ qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
>    *
>    * For named output GPIO lines, use qdev_connect_gpio_out_named().
>    */
> -void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
> +void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq input_pin);
>   /**
>    * 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)
> - * @pin: qemu_irq to connect the output line to
> + * @input_pin: qemu_irq to connect the output line to
>    *
>    * This function connects an anonymous output GPIO line on a device
>    * up to an arbitrary qemu_irq, so that when the device asserts that
> @@ -521,7 +521,7 @@ void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
>    * same qemu_irq; see qdev_connect_gpio_out() for details.
>    */
>   void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
> -                                 qemu_irq pin);
> +                                 qemu_irq input_pin);
>   /**
>    * qdev_get_gpio_out_connector: Get the qemu_irq connected to an output GPIO
>    * @dev: Device whose output GPIO we are interested in
> diff --git a/hw/core/gpio.c b/hw/core/gpio.c
> index 8e6b4f5edf3..80d07a6ec99 100644
> --- a/hw/core/gpio.c
> +++ b/hw/core/gpio.c
> @@ -115,17 +115,18 @@ qemu_irq qdev_get_gpio_in(DeviceState *dev, int n)
>   }
>   
>   void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
> -                                 qemu_irq pin)
> +                                 qemu_irq input_pin)
>   {
>       char *propname = g_strdup_printf("%s[%d]",
>                                        name ? name : "unnamed-gpio-out", n);
> -    if (pin && !OBJECT(pin)->parent) {
> +    if (input_pin && !OBJECT(input_pin)->parent) {
>           /* We need a name for object_property_set_link to work */
>           object_property_add_child(container_get(qdev_get_machine(),
>                                                   "/unattached"),
> -                                  "non-qdev-gpio[*]", OBJECT(pin));
> +                                  "non-qdev-gpio[*]", OBJECT(input_pin));
>       }
> -    object_property_set_link(OBJECT(dev), propname, OBJECT(pin), &error_abort);
> +    object_property_set_link(OBJECT(dev), propname,
> +                             OBJECT(input_pin), &error_abort);
>       g_free(propname);
>   }
>   
> @@ -165,9 +166,9 @@ qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
>       return disconnected;
>   }
>   
> -void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin)
> +void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq input_pin)
>   {
> -    qdev_connect_gpio_out_named(dev, NULL, n, pin);
> +    qdev_connect_gpio_out_named(dev, NULL, n, input_pin);
>   }
>   
>   void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
Reviewed-by: Yanan Wang <wangyanan55@huawei.com>

Thanks,
Yanan
diff mbox series

Patch

diff --git a/include/hw/qdev-core.h b/include/hw/qdev-core.h
index 5b88c8b9dd3..3a0fe643a73 100644
--- a/include/hw/qdev-core.h
+++ b/include/hw/qdev-core.h
@@ -470,7 +470,7 @@  qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
  * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines
  * @dev: Device whose GPIO to connect
  * @n: Number of the anonymous output GPIO line (which must be in range)
- * @pin: qemu_irq to connect the output line to
+ * @input_pin: qemu_irq to connect the output line to
  *
  * This function connects an anonymous output GPIO line on a device
  * up to an arbitrary qemu_irq, so that when the device asserts that
@@ -495,14 +495,14 @@  qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
  *
  * For named output GPIO lines, use qdev_connect_gpio_out_named().
  */
-void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
+void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq input_pin);
 /**
  * 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)
- * @pin: qemu_irq to connect the output line to
+ * @input_pin: qemu_irq to connect the output line to
  *
  * This function connects an anonymous output GPIO line on a device
  * up to an arbitrary qemu_irq, so that when the device asserts that
@@ -521,7 +521,7 @@  void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
  * same qemu_irq; see qdev_connect_gpio_out() for details.
  */
 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
-                                 qemu_irq pin);
+                                 qemu_irq input_pin);
 /**
  * qdev_get_gpio_out_connector: Get the qemu_irq connected to an output GPIO
  * @dev: Device whose output GPIO we are interested in
diff --git a/hw/core/gpio.c b/hw/core/gpio.c
index 8e6b4f5edf3..80d07a6ec99 100644
--- a/hw/core/gpio.c
+++ b/hw/core/gpio.c
@@ -115,17 +115,18 @@  qemu_irq qdev_get_gpio_in(DeviceState *dev, int n)
 }
 
 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
-                                 qemu_irq pin)
+                                 qemu_irq input_pin)
 {
     char *propname = g_strdup_printf("%s[%d]",
                                      name ? name : "unnamed-gpio-out", n);
-    if (pin && !OBJECT(pin)->parent) {
+    if (input_pin && !OBJECT(input_pin)->parent) {
         /* We need a name for object_property_set_link to work */
         object_property_add_child(container_get(qdev_get_machine(),
                                                 "/unattached"),
-                                  "non-qdev-gpio[*]", OBJECT(pin));
+                                  "non-qdev-gpio[*]", OBJECT(input_pin));
     }
-    object_property_set_link(OBJECT(dev), propname, OBJECT(pin), &error_abort);
+    object_property_set_link(OBJECT(dev), propname,
+                             OBJECT(input_pin), &error_abort);
     g_free(propname);
 }
 
@@ -165,9 +166,9 @@  qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
     return disconnected;
 }
 
-void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin)
+void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq input_pin)
 {
-    qdev_connect_gpio_out_named(dev, NULL, n, pin);
+    qdev_connect_gpio_out_named(dev, NULL, n, input_pin);
 }
 
 void qdev_pass_gpios(DeviceState *dev, DeviceState *container,