diff mbox

[2/4] qemu-timer: add timer_init and timer_init_ns/us/ms

Message ID 1420711408-15766-3-git-send-email-pbonzini@redhat.com
State New
Headers show

Commit Message

Paolo Bonzini Jan. 8, 2015, 10:03 a.m. UTC
These functions for the main loop TimerListGroup will replace
timer_new and timer_new_ns/us/ms.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 include/qemu/timer.h | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)

Comments

Fam Zheng Jan. 9, 2015, 2:19 a.m. UTC | #1
On Thu, 01/08 11:03, Paolo Bonzini wrote:
> These functions for the main loop TimerListGroup will replace
> timer_new and timer_new_ns/us/ms.
> 
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  include/qemu/timer.h | 73 ++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 73 insertions(+)
> 
> diff --git a/include/qemu/timer.h b/include/qemu/timer.h
> index 0666920..9f44233 100644
> --- a/include/qemu/timer.h
> +++ b/include/qemu/timer.h
> @@ -428,6 +428,79 @@ void timer_init_tl(QEMUTimer *ts,
>                     QEMUTimerCB *cb, void *opaque);
>  
>  /**
> + * timer_init:
> + * @clock: the clock to associate with the timer

s/@clock/@type/

And similarly below.

> + * @scale: the scale value for the timer
> + * @cb: the callback to call when the timer expires
> + * @opaque: the opaque pointer to pass to the callback
> + *
> + * Create a new timer with the given scale on the default timer list

s/Create a new/Initialize a/ ?

And similarly below.

> + * associated with the clock.
> + *
> + * You need not call an explicit deinit call. Simply make
> + * sure it is not on a list with timer_del.
> + */
> +static inline void timer_init(QEMUTimer *ts, QEMUClockType type, int scale,
> +                              QEMUTimerCB *cb, void *opaque)
> +{
> +    timer_init_tl(ts, main_loop_tlg.tl[type], scale, cb, opaque);
> +}
> +
> +/**
> + * timer_init_ns:
> + * @clock: the clock to associate with the timer
> + * @cb: the callback to call when the timer expires
> + * @opaque: the opaque pointer to pass to the callback
> + *
> + * Create a new timer with nanosecond scale on the default timer list
> + * associated with the clock.
> + *
> + * You need not call an explicit deinit call. Simply make
> + * sure it is not on a list with timer_del.
> + */
> +static inline void timer_init_ns(QEMUTimer *ts, QEMUClockType type,
> +                                 QEMUTimerCB *cb, void *opaque)
> +{
> +    timer_init(ts, type, SCALE_NS, cb, opaque);
> +}
> +
> +/**
> + * timer_init_us:
> + * @clock: the clock to associate with the timer
> + * @cb: the callback to call when the timer expires
> + * @opaque: the opaque pointer to pass to the callback
> + *
> + * Create a new timer with microsecond scale on the default timer list
> + * associated with the clock.
> + *
> + * You need not call an explicit deinit call. Simply make
> + * sure it is not on a list with timer_del.
> + */
> +static inline void timer_init_us(QEMUTimer *ts, QEMUClockType type,
> +                                 QEMUTimerCB *cb, void *opaque)
> +{
> +    timer_init(ts, type, SCALE_US, cb, opaque);
> +}
> +
> +/**
> + * timer_init_ms:
> + * @clock: the clock to associate with the timer
> + * @cb: the callback to call when the timer expires
> + * @opaque: the opaque pointer to pass to the callback
> + *
> + * Create a new timer with millisecond scale on the default timer list
> + * associated with the clock.
> + *
> + * You need not call an explicit deinit call. Simply make
> + * sure it is not on a list with timer_del.
> + */
> +static inline void timer_init_ms(QEMUTimer *ts, QEMUClockType type,
> +                                 QEMUTimerCB *cb, void *opaque)
> +{
> +    timer_init(ts, type, SCALE_MS, cb, opaque);
> +}
> +
> +/**
>   * timer_new_tl:
>   * @timer_list: the timer list to attach the timer to
>   * @scale: the scale value for the timer
> -- 
> 2.1.0
> 
> 
>
Paolo Bonzini Jan. 9, 2015, 10:39 a.m. UTC | #2
On 09/01/2015 03:19, Fam Zheng wrote:
>> >  /**
>> > + * timer_init:
>> > + * @clock: the clock to associate with the timer
> s/@clock/@type/
> 
> And similarly below.

Doh, cut-and-paste error (it's also in timer_new and friends).

>> > + * @scale: the scale value for the timer
>> > + * @cb: the callback to call when the timer expires
>> > + * @opaque: the opaque pointer to pass to the callback
>> > + *
>> > + * Create a new timer with the given scale on the default timer list
> s/Create a new/Initialize a/ ?
> 
> And similarly below.

Good idea, thanks!

Paolo
diff mbox

Patch

diff --git a/include/qemu/timer.h b/include/qemu/timer.h
index 0666920..9f44233 100644
--- a/include/qemu/timer.h
+++ b/include/qemu/timer.h
@@ -428,6 +428,79 @@  void timer_init_tl(QEMUTimer *ts,
                    QEMUTimerCB *cb, void *opaque);
 
 /**
+ * timer_init:
+ * @clock: the clock to associate with the timer
+ * @scale: the scale value for the timer
+ * @cb: the callback to call when the timer expires
+ * @opaque: the opaque pointer to pass to the callback
+ *
+ * Create a new timer with the given scale on the default timer list
+ * associated with the clock.
+ *
+ * You need not call an explicit deinit call. Simply make
+ * sure it is not on a list with timer_del.
+ */
+static inline void timer_init(QEMUTimer *ts, QEMUClockType type, int scale,
+                              QEMUTimerCB *cb, void *opaque)
+{
+    timer_init_tl(ts, main_loop_tlg.tl[type], scale, cb, opaque);
+}
+
+/**
+ * timer_init_ns:
+ * @clock: the clock to associate with the timer
+ * @cb: the callback to call when the timer expires
+ * @opaque: the opaque pointer to pass to the callback
+ *
+ * Create a new timer with nanosecond scale on the default timer list
+ * associated with the clock.
+ *
+ * You need not call an explicit deinit call. Simply make
+ * sure it is not on a list with timer_del.
+ */
+static inline void timer_init_ns(QEMUTimer *ts, QEMUClockType type,
+                                 QEMUTimerCB *cb, void *opaque)
+{
+    timer_init(ts, type, SCALE_NS, cb, opaque);
+}
+
+/**
+ * timer_init_us:
+ * @clock: the clock to associate with the timer
+ * @cb: the callback to call when the timer expires
+ * @opaque: the opaque pointer to pass to the callback
+ *
+ * Create a new timer with microsecond scale on the default timer list
+ * associated with the clock.
+ *
+ * You need not call an explicit deinit call. Simply make
+ * sure it is not on a list with timer_del.
+ */
+static inline void timer_init_us(QEMUTimer *ts, QEMUClockType type,
+                                 QEMUTimerCB *cb, void *opaque)
+{
+    timer_init(ts, type, SCALE_US, cb, opaque);
+}
+
+/**
+ * timer_init_ms:
+ * @clock: the clock to associate with the timer
+ * @cb: the callback to call when the timer expires
+ * @opaque: the opaque pointer to pass to the callback
+ *
+ * Create a new timer with millisecond scale on the default timer list
+ * associated with the clock.
+ *
+ * You need not call an explicit deinit call. Simply make
+ * sure it is not on a list with timer_del.
+ */
+static inline void timer_init_ms(QEMUTimer *ts, QEMUClockType type,
+                                 QEMUTimerCB *cb, void *opaque)
+{
+    timer_init(ts, type, SCALE_MS, cb, opaque);
+}
+
+/**
  * timer_new_tl:
  * @timer_list: the timer list to attach the timer to
  * @scale: the scale value for the timer