[v3,03/15] hw/core/clock: add the clock_new helper function

Commit Message

Luc Michel Oct. 10, 2020, 1:57 p.m. UTC

This function creates a clock and parents it to another object with a given
name. It calls clock_setup_canonical_path before returning the new
clock.

This function is useful to create clocks in devices when one doesn't
want to expose it at the qdev level (as an input or an output).

Suggested-by: Philippe Mathieu-Daudé <[e-mail]>
Signed-off-by: Luc Michel <[e-mail]>
---
 include/hw/clock.h | 13 +++++++++++++
 hw/core/clock.c    | 15 +++++++++++++++
 2 files changed, 28 insertions(+)

Comments

Philippe Mathieu-Daudé Oct. 10, 2020, 3:17 p.m. UTC | #1

On 10/10/20 3:57 PM, Luc Michel wrote:
> This function creates a clock and parents it to another object with a given
> name. It calls clock_setup_canonical_path before returning the new
> clock.
> 
> This function is useful to create clocks in devices when one doesn't
> want to expose it at the qdev level (as an input or an output).
> 
> Suggested-by: Philippe Mathieu-Daudé <[e-mail]>
> Signed-off-by: Luc Michel <[e-mail]>
> ---
>   include/hw/clock.h | 13 +++++++++++++
>   hw/core/clock.c    | 15 +++++++++++++++
>   2 files changed, 28 insertions(+)

Reviewed-by: Philippe Mathieu-Daudé <[e-mail]>

Philippe Mathieu-Daudé Oct. 10, 2020, 3:44 p.m. UTC | #2

On 10/10/20 5:17 PM, Philippe Mathieu-Daudé wrote:
> On 10/10/20 3:57 PM, Luc Michel wrote:
>> This function creates a clock and parents it to another object with a 
>> given
>> name. It calls clock_setup_canonical_path before returning the new
>> clock.
>>
>> This function is useful to create clocks in devices when one doesn't
>> want to expose it at the qdev level (as an input or an output).
>>
>> Suggested-by: Philippe Mathieu-Daudé <[e-mail]>
>> Signed-off-by: Luc Michel <[e-mail]>
>> ---
>>   include/hw/clock.h | 13 +++++++++++++
>>   hw/core/clock.c    | 15 +++++++++++++++
>>   2 files changed, 28 insertions(+)
> 
> Reviewed-by: Philippe Mathieu-Daudé <[e-mail]>

Tested-by: Philippe Mathieu-Daudé <[e-mail]>

Patch

diff --git a/include/hw/clock.h b/include/hw/clock.h
index c93e6113cd..81bcf3e505 100644
--- a/include/hw/clock.h
+++ b/include/hw/clock.h
@@ -93,10 +93,23 @@  extern const VMStateDescription vmstate_clock;
  *
  * compute the canonical path of the clock (used by log messages)
  */
 void clock_setup_canonical_path(Clock *clk);
 
+/**
+ * clock_new:
+ * @parent: the clock parent
+ * @name: the clock object name
+ *
+ * Helper function to create a new clock and parent it to @parent. There is no
+ * need to call clock_setup_canonical_path on the returned clock as it is done
+ * by this function.
+ *
+ * @return the newly created clock
+ */
+Clock *clock_new(Object *parent, const char *name);
+
 /**
  * clock_set_callback:
  * @clk: the clock to register the callback into
  * @cb: the callback function
  * @opaque: the argument to the callback
diff --git a/hw/core/clock.c b/hw/core/clock.c
index 81184734e0..8c6af223e7 100644
--- a/hw/core/clock.c
+++ b/hw/core/clock.c
@@ -21,10 +21,25 @@  void clock_setup_canonical_path(Clock *clk)
 {
     g_free(clk->canonical_path);
     clk->canonical_path = object_get_canonical_path(OBJECT(clk));
 }
 
+Clock *clock_new(Object *parent, const char *name)
+{
+    Object *obj;
+    Clock *clk;
+
+    obj = object_new(TYPE_CLOCK);
+    object_property_add_child(parent, name, obj);
+    object_unref(obj);
+
+    clk = CLOCK(obj);
+    clock_setup_canonical_path(clk);
+
+    return clk;
+}
+
 void clock_set_callback(Clock *clk, ClockCallback *cb, void *opaque)
 {
     clk->callback = cb;
     clk->callback_opaque = opaque;
 }