[v2,10/11] hw/core/qdev: Simplify legacy_reset handling

Commit Message

Peter Maydell Aug. 30, 2024, 2:58 p.m. UTC

Now that all devices which still implement a the legacy reset method
register it via device_class_legacy_reset(), we can simplify the
handling of these devices.  Instead of using the complex
Resettable::get_transitional_function machinery, we register a hold
phase method which invokes the DeviceClass::legacy_reset method.

This will allow us to remove all the get_transitional_function
handling from resettable.c.

Signed-off-by: Peter Maydell <[e-mail]>
---
 hw/core/qdev.c | 55 ++++++++++++++++++++------------------------------
 1 file changed, 22 insertions(+), 33 deletions(-)

Comments

Philippe Mathieu-Daudé Sept. 3, 2024, 2:52 p.m. UTC | #1

On 30/8/24 16:58, Peter Maydell wrote:
> Now that all devices which still implement a the legacy reset method
> register it via device_class_legacy_reset(), we can simplify the
> handling of these devices.  Instead of using the complex
> Resettable::get_transitional_function machinery, we register a hold
> phase method which invokes the DeviceClass::legacy_reset method.
> 
> This will allow us to remove all the get_transitional_function
> handling from resettable.c.
> 
> Signed-off-by: Peter Maydell <[e-mail]>
> ---
>   hw/core/qdev.c | 55 ++++++++++++++++++++------------------------------
>   1 file changed, 22 insertions(+), 33 deletions(-)

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

Patch

diff --git a/hw/core/qdev.c b/hw/core/qdev.c
index 9af0ed3e1b7..db36f54d914 100644
--- a/hw/core/qdev.c
+++ b/hw/core/qdev.c
@@ -747,35 +747,6 @@  device_vmstate_if_get_id(VMStateIf *obj)
     return qdev_get_dev_path(dev);
 }
 
-static void device_transitional_reset(Object *obj)
-{
-    DeviceClass *dc = DEVICE_GET_CLASS(obj);
-
-    /*
-     * Device still using DeviceClass legacy_reset method. This doesn't
-     * reset children. device_get_transitional_reset() checked that
-     * this isn't NULL.
-     */
-    dc->legacy_reset(DEVICE(obj));
-}
-
-/**
- * device_get_transitional_reset:
- * check if the device's class is ready for multi-phase
- */
-static ResettableTrFunction device_get_transitional_reset(Object *obj)
-{
-    DeviceClass *dc = DEVICE_GET_CLASS(obj);
-    if (dc->legacy_reset) {
-        /*
-         * dc->reset has been overridden by a subclass,
-         * the device is not ready for multi phase yet.
-         */
-        return device_transitional_reset;
-    }
-    return NULL;
-}
-
 static void device_class_init(ObjectClass *class, void *data)
 {
     DeviceClass *dc = DEVICE_CLASS(class);
@@ -800,12 +771,9 @@  static void device_class_init(ObjectClass *class, void *data)
      * A NULL legacy_reset implies a three-phase reset device. Devices can
      * only be reset using three-phase aware mechanisms, but we still support
      * for transitional purposes leaf classes which set the old legacy_reset
-     * method via device_class_set_legacy_reset(). If they do so, then
-     * device_get_transitional_reset() will notice and arrange for the
-     * DeviceClass::legacy_reset() method to be called during the hold phase.
+     * method via device_class_set_legacy_reset().
      */
     dc->legacy_reset = NULL;
-    rc->get_transitional_function = device_get_transitional_reset;
 
     object_class_property_add_bool(class, "realized",
                                    device_get_realized, device_set_realized);
@@ -817,8 +785,29 @@  static void device_class_init(ObjectClass *class, void *data)
                                    offsetof(DeviceState, parent_bus), NULL, 0);
 }
 
+static void do_legacy_reset(Object *obj, ResetType type)
+{
+    DeviceClass *dc = DEVICE_GET_CLASS(obj);
+
+    dc->legacy_reset(DEVICE(obj));
+}
+
 void device_class_set_legacy_reset(DeviceClass *dc, DeviceReset dev_reset)
 {
+    /*
+     * A legacy DeviceClass::reset has identical semantics to the
+     * three-phase "hold" method, with no "enter" or "exit"
+     * behaviour. Classes that use this legacy function must be leaf
+     * classes that do not chain up to their parent class reset.
+     * There is no mechanism for resetting a device that does not
+     * use the three-phase APIs, so the only place which calls
+     * the legacy_reset hook is do_legacy_reset().
+     */
+    ResettableClass *rc = RESETTABLE_CLASS(dc);
+
+    rc->phases.enter = NULL;
+    rc->phases.hold = do_legacy_reset;
+    rc->phases.exit = NULL;
     dc->legacy_reset = dev_reset;
 }