]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
drm/i915/pm: Simplify pm hook documentation
authorVille Syrjälä <ville.syrjala@linux.intel.com>
Fri, 19 Sep 2025 18:50:10 +0000 (21:50 +0300)
committerVille Syrjälä <ville.syrjala@linux.intel.com>
Mon, 22 Sep 2025 16:34:39 +0000 (19:34 +0300)
Stop spelling out each variant of the hook ("" vs. "_late" vs.
"_early") and just say eg. "@thaw*" to indicate all of them.
Avoids having to update the docs whenever we start/stop using
one of the variants.

Reviewed-by: Rodrigo Vivi <rodrigo.vivi@intel.com>
Reviewed-by: Jouni Högander <jouni.hogander@intel.com>
Signed-off-by: Ville Syrjälä <ville.syrjala@linux.intel.com>
Link: https://patchwork.freedesktop.org/patch/msgid/20250919185015.14561-2-ville.syrjala@linux.intel.com
drivers/gpu/drm/i915/i915_driver.c

index a28c3710c4d50c6012413eb4f4c70b48d751cb3a..76bda4376fe02be7333c3caeff8750b1ebe77d9f 100644 (file)
@@ -1670,18 +1670,18 @@ const struct dev_pm_ops i915_pm_ops = {
 
        /*
         * S4 event handlers
-        * @freeze, @freeze_late    : called (1) before creating the
-        *                            hibernation image [PMSG_FREEZE] and
-        *                            (2) after rebooting, before restoring
-        *                            the image [PMSG_QUIESCE]
-        * @thaw, @thaw_early       : called (1) after creating the hibernation
-        *                            image, before writing it [PMSG_THAW]
-        *                            and (2) after failing to create or
-        *                            restore the image [PMSG_RECOVER]
-        * @poweroff, @poweroff_late: called after writing the hibernation
-        *                            image, before rebooting [PMSG_HIBERNATE]
-        * @restore, @restore_early : called after rebooting and restoring the
-        *                            hibernation image [PMSG_RESTORE]
+        * @freeze*   : called (1) before creating the
+        *              hibernation image [PMSG_FREEZE] and
+        *              (2) after rebooting, before restoring
+        *              the image [PMSG_QUIESCE]
+        * @thaw*     : called (1) after creating the hibernation
+        *              image, before writing it [PMSG_THAW]
+        *              and (2) after failing to create or
+        *              restore the image [PMSG_RECOVER]
+        * @poweroff: called after writing the hibernation
+        *              image, before rebooting [PMSG_HIBERNATE]
+        * @restore : called after rebooting and restoring the
+        *              hibernation image [PMSG_RESTORE]
         */
        .freeze = i915_pm_freeze,
        .freeze_late = i915_pm_freeze_late,