include/hw/resettable.h

16 #include "qom/object.h"
31  * + Cold: reset resulting from a power cycle of the object.
54  * Every Resettable object must maintain some state tracking the
61  * Concrete object implementations (typically specific devices
68  * An object will always move quickly from 'enter' to 'hold'
71  * Object implementations should be prepared for functions handling
76  * Users of a resettable object should not call these methods
79  * @phases.enter: This phase is called when the object enters reset. It
80  * should reset local state of the object, but it must not do anything that
85  * @phases.hold: This phase is called for entry into reset, once every object
89  * @phases.exit: This phase is called when the object leaves the reset state.
98  * owns. This is not the same as the QOM object hierarchy. The function takes
102 typedef void (*ResettableEnterPhase)(Object *obj, ResetType type);
103 typedef void (*ResettableHoldPhase)(Object *obj, ResetType type);
104 typedef void (*ResettableExitPhase)(Object *obj, ResetType type);
105 typedef ResettableState * (*ResettableGetState)(Object *obj);
106 typedef void (*ResettableChildCallback)(Object *, void *opaque,
108 typedef void (*ResettableChildForeach)(Object *obj,
135  * @count: Number of reset level the object is into. It is incremented when
138  * phase handler for this object.
150  * to reuse an object. Typically used in realize step of base classes
160  * Trigger a reset on an object @obj of type @type. @obj must implement
166 void resettable_reset(Object *obj, ResetType type);
170  * Put an object @obj into reset. @obj must implement Resettable interface.
181 void resettable_assert_reset(Object *obj, ResetType type);
185  * Release the object @obj from reset. @obj must implement Resettable interface.
189 void resettable_release_reset(Object *obj, ResetType type);
197 bool resettable_is_in_reset(Object *obj);
213 void resettable_change_parent(Object *obj, Object *newp, Object *oldp);
217  * Helper to call resettable_reset((Object *) opaque, RESET_TYPE_COLD).