include/hw/qdev-clock.h

2  * Device's clock input and output
4  * Copyright GreenSocs 2016-2020
11  * See the COPYING file in the top-level directory.
17 #include "hw/clock.h"
21  * @dev: the device to add an input clock to
22  * @name: the name of the clock (can't be NULL).
27  * @returns: a pointer to the newly added clock
29  * Add an input clock to device @dev as a clock named @name.
33 Clock *qdev_init_clock_in(DeviceState *dev, const char *name,
39  * @dev: the device to add an output clock to
40  * @name: the name of the clock (can't be NULL).
41  * @returns: a pointer to the newly added clock
43  * Add an output clock to device @dev as a clock named @name.
46 Clock *qdev_init_clock_out(DeviceState *dev, const char *name);
50  * @dev: the device which has the clock
51  * @name: the name of the clock (can't be NULL).
52  * @returns: a pointer to the clock
54  * Get the input clock @name from @dev or NULL if does not exist.
56 Clock *qdev_get_clock_in(DeviceState *dev, const char *name);
60  * @dev: the device which has the clock
61  * @name: the name of the clock (can't be NULL).
62  * @returns: a pointer to the clock
64  * Get the output clock @name from @dev or NULL if does not exist.
66 Clock *qdev_get_clock_out(DeviceState *dev, const char *name);
71  * @name: the name of an input clock in @dev
72  * @source: the source clock (an output clock of another device for example)
74  * Set the source clock of input clock @name of device @dev to @source.
75  * @source period update will be propagated to @name clock.
79 void qdev_connect_clock_in(DeviceState *dev, const char *name, Clock *source);
83  * @dev: the device which has the clock
84  * @name: the name of the clock in @dev (can't be NULL)
85  * @alias_dev: the device to add the clock
86  * @alias_name: the name of the clock in @container
87  * @returns: a pointer to the clock
89  * Add a clock @alias_name in @alias_dev which is an alias of the clock @name
91  * An alias clock must not be modified or used by @alias_dev and should
94 Clock *qdev_alias_clock(DeviceState *dev, const char *name,
107  * @name: name of the clock (can't be NULL)
108  * @output: indicates whether the clock is input or output
109  * @callback: for inputs, optional callback to be called on clock's update
125      type_check(Clock *, typeof_field(devstate, field)))
139  * @field: a field in @_devstate (must be Clock*)
140  * @callback: (for input only) callback (or NULL) to be called with the device
142  * @cbevents: (for input only) ClockEvent mask for when callback is called
144  * The name of the clock will be derived from @field
159  * @clocks: a QDEV_CLOCK_END-terminated array which contains the