Introduce and plumb PMSG_POWEROFF

PMSG_POWEROFF will be used for the PM core to allow differentiating between a hibernation or shutdown sequence when re-using callbacks for common code.

Hibernation is started by writing a hibernation method (such as 'platform' 'shutdown', or 'reboot') to use into /sys/power/disk and writing 'disk' to /sys/power/state.

Shutdown is initiated with the reboot() syscall with arguments on whether to halt the system or power it off.

Tested-by Eric Naim <[email protected]>

Signed-off-by Mario Limonciello (AMD) <[email protected]>

---
v9:
* Add more detail to commit message (Bjorn)
v8:
* Break series into 3 parts
* Drop PMSG_NO_WAKEUP change
v7:
* Reword commit
v5:
* Re-order and split
* Add tags
v4:
* https://lore.kernel.org/linux-pci/[email protected]/

---
 drivers/base/power/main.c    | 7 +++++++
 include/linux/pm.h           | 3 +++
 include/trace/events/power.h | 3 ++-
 3 files changed, 12 insertions(+), 1 deletion(-)

drivers/base/power/main.c +5 -0

index 451d54486645b..ecdd88b578a04 100644
@@ -95,6 +95,8 @@ static const char *pm_verb(int event)
                return "restore";
        case PM_EVENT_RECOVER:
                return "recover";
+       case PM_EVENT_POWEROFF:
+               return "poweroff";
        default:
                return "(unknown PM event)";
        }

@@ -367,6 +369,7 @@ static pm_callback_t pm_op(const struct dev_pm_ops *ops, pm_message_t state)
        case PM_EVENT_FREEZE:
        case PM_EVENT_QUIESCE:
                return ops->freeze;
+       case PM_EVENT_POWEROFF:
        case PM_EVENT_HIBERNATE:
                return ops->poweroff;
        case PM_EVENT_THAW:

@@ -401,6 +404,7 @@ static pm_callback_t pm_late_early_op(const struct dev_pm_ops *ops,
        case PM_EVENT_FREEZE:
        case PM_EVENT_QUIESCE:
                return ops->freeze_late;
+       case PM_EVENT_POWEROFF:
        case PM_EVENT_HIBERNATE:
                return ops->poweroff_late;
        case PM_EVENT_THAW:

@@ -435,6 +439,7 @@ static pm_callback_t pm_noirq_op(const struct dev_pm_ops *ops, pm_message_t stat
        case PM_EVENT_FREEZE:
        case PM_EVENT_QUIESCE:
                return ops->freeze_noirq;
+       case PM_EVENT_POWEROFF:
        case PM_EVENT_HIBERNATE:
                return ops->poweroff_noirq;
        case PM_EVENT_THAW:

drivers/base/power/main.c +0 -0

        }
        return PMSG_ON;
 }

suspend_common() passes a PM message indicating what type of event is occurring. PMSG_POWEROFF is intended to be used when hibernate callbacks were utilized for turning off the system.

Add a new callback hcd_pci_poweroff() which will determine if target state is power off and pass PMSG_POWEROFF as the message.

suspend_common() doesn't do any special handling with this case at the moment, so there are no functional changes in this patch.

Signed-off-by Mario Limonciello (AMD) <[email protected]>

---
v9:
* Reword commit message (Bjorn)
v8:
* Drop SYSTEM_HALT case
v7:
* Reword commit mesasge
v6:
* Fix LKP robot issue without CONFIG_PM_SLEEP
v5:
* New patch
v4:
* https://lore.kernel.org/linux-pci/[email protected]/

---
 drivers/usb/core/hcd-pci.c | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

drivers/usb/core/hcd-pci.c +9 -0

index cd223475917ef..959baccfb07d1 100644
@@ -6,6 +6,7 @@
 #include <linux/kernel.h>
 #include <linux/module.h>
 #include <linux/pci.h>
+#include <linux/pm.h>
 #include <linux/usb.h>
 #include <linux/usb/hcd.h>
 

@@ -531,6 +532,13 @@ static int hcd_pci_freeze(struct device *dev)
        return suspend_common(dev, PMSG_FREEZE);
 }
 
+static int hcd_pci_poweroff(struct device *dev)
+{
+       if (system_state == SYSTEM_POWER_OFF)
+               return suspend_common(dev, PMSG_POWEROFF);
+       return suspend_common(dev, PMSG_SUSPEND);
+}
+
 static int hcd_pci_suspend_noirq(struct device *dev)
 {
        struct pci_dev          *pci_dev = to_pci_dev(dev);

@@ -602,6 +610,7 @@ static int hcd_pci_restore(struct device *dev)
 #define hcd_pci_suspend                NULL
 #define hcd_pci_freeze                 NULL
 #define hcd_pci_suspend_noirq  NULL
+#define hcd_pci_poweroff       NULL
 #define hcd_pci_poweroff_late  NULL
 #define hcd_pci_resume_noirq   NULL
 #define hcd_pci_resume         NULL

Quoted 70 lines · Mario Limonciello (AMD)

suspend_common() passes a PM message indicating what type of event is occurring. PMSG_POWEROFF is intended to be used when hibernate callbacks were utilized for turning off the system.

Add a new callback hcd_pci_poweroff() which will determine if target state is power off and pass PMSG_POWEROFF as the message.

suspend_common() doesn't do any special handling with this case at the moment, so there are no functional changes in this patch.

Signed-off-by Mario Limonciello (AMD) <[email protected]>

---
v9:
* Reword commit message (Bjorn)
v8:
* Drop SYSTEM_HALT case
v7:
* Reword commit mesasge
v6:
* Fix LKP robot issue without CONFIG_PM_SLEEP
v5:
* New patch
v4:
* https://lore.kernel.org/linux-pci/[email protected]/

---
  drivers/usb/core/hcd-pci.c | 11 ++++++++++-
  1 file changed, 10 insertions(+), 1 deletion(-)

drivers/usb/core/hcd-pci.c +10 -1

index cd223475917ef..959baccfb07d1 100644
@@ -6,6 +6,7 @@
  #include <linux/kernel.h>
  #include <linux/module.h>
  #include <linux/pci.h>
+#include <linux/pm.h>
  #include <linux/usb.h>
  #include <linux/usb/hcd.h>
 

@@ -531,6 +532,13 @@ static int hcd_pci_freeze(struct device *dev)
         return suspend_common(dev, PMSG_FREEZE);
  }
 
+static int hcd_pci_poweroff(struct device *dev)
+{
+       if (system_state == SYSTEM_POWER_OFF)
+               return suspend_common(dev, PMSG_POWEROFF);
+       return suspend_common(dev, PMSG_SUSPEND);
+}
+
  static int hcd_pci_suspend_noirq(struct device *dev)
  {
         struct pci_dev          *pci_dev = to_pci_dev(dev);

@@ -602,6 +610,7 @@ static int hcd_pci_restore(struct device *dev)
  #define hcd_pci_suspend                NULL
  #define hcd_pci_freeze                 NULL
  #define hcd_pci_suspend_noirq  NULL
+#define hcd_pci_poweroff       NULL
  #define hcd_pci_poweroff_late  NULL
  #define hcd_pci_resume_noirq   NULL
  #define hcd_pci_resume         NULL

@@ -639,7 +648,7 @@ const struct dev_pm_ops usb_hcd_pci_pm_ops = {
         .freeze_noirq   = check_root_hub_suspended,
         .thaw_noirq     = NULL,
         .thaw           = hcd_pci_resume,
-       .poweroff       = hcd_pci_suspend,
+       .poweroff       = hcd_pci_poweroff,

drivers/usb/core/hcd-pci.c const struct dev_pm_ops usb_hcd_pci_pm_ops = {

Quoted 4 lines

drivers/usb/core/hcd-pci.c +0 -1

         .poweroff_late  = hcd_pci_poweroff_late,
         .poweroff_noirq = hcd_pci_suspend_noirq,
         .restore_noirq  = hcd_pci_resume_noirq,
--

I would defer this patch until you know what exactly suspend_common() will do for PMSG_POWEROFF because it may just be simpler to check system_state == SYSTEM_POWER_OFF in it internally.

Quoted 72 lines · Rafael J. Wysocki

Quoted 70 lines · Mario Limonciello (AMD)

suspend_common() passes a PM message indicating what type of event is occurring. PMSG_POWEROFF is intended to be used when hibernate callbacks were utilized for turning off the system.

Add a new callback hcd_pci_poweroff() which will determine if target state is power off and pass PMSG_POWEROFF as the message.

suspend_common() doesn't do any special handling with this case at the moment, so there are no functional changes in this patch.

Signed-off-by Mario Limonciello (AMD) <[email protected]>

---
v9:
* Reword commit message (Bjorn)
v8:
* Drop SYSTEM_HALT case
v7:
* Reword commit mesasge
v6:
* Fix LKP robot issue without CONFIG_PM_SLEEP
v5:
* New patch
v4:
* https://lore.kernel.org/linux-pci/[email protected]/

---
  drivers/usb/core/hcd-pci.c | 11 ++++++++++-
  1 file changed, 10 insertions(+), 1 deletion(-)

drivers/usb/core/hcd-pci.c +10 -1

index cd223475917ef..959baccfb07d1 100644
@@ -6,6 +6,7 @@
  #include <linux/kernel.h>
  #include <linux/module.h>
  #include <linux/pci.h>
+#include <linux/pm.h>
  #include <linux/usb.h>
  #include <linux/usb/hcd.h>
 

@@ -531,6 +532,13 @@ static int hcd_pci_freeze(struct device *dev)
         return suspend_common(dev, PMSG_FREEZE);
  }
 
+static int hcd_pci_poweroff(struct device *dev)
+{
+       if (system_state == SYSTEM_POWER_OFF)
+               return suspend_common(dev, PMSG_POWEROFF);
+       return suspend_common(dev, PMSG_SUSPEND);
+}
+
  static int hcd_pci_suspend_noirq(struct device *dev)
  {
         struct pci_dev          *pci_dev = to_pci_dev(dev);

@@ -602,6 +610,7 @@ static int hcd_pci_restore(struct device *dev)
  #define hcd_pci_suspend                NULL
  #define hcd_pci_freeze                 NULL
  #define hcd_pci_suspend_noirq  NULL
+#define hcd_pci_poweroff       NULL
  #define hcd_pci_poweroff_late  NULL
  #define hcd_pci_resume_noirq   NULL
  #define hcd_pci_resume         NULL

@@ -639,7 +648,7 @@ const struct dev_pm_ops usb_hcd_pci_pm_ops = {
         .freeze_noirq   = check_root_hub_suspended,
         .thaw_noirq     = NULL,
         .thaw           = hcd_pci_resume,
-       .poweroff       = hcd_pci_suspend,
+       .poweroff       = hcd_pci_poweroff,

Quoted 8 lines

drivers/usb/core/hcd-pci.c const struct dev_pm_ops usb_hcd_pci_pm_ops = {

Quoted 4 lines

drivers/usb/core/hcd-pci.c +0 -1

         .poweroff_late  = hcd_pci_poweroff_late,
         .poweroff_noirq = hcd_pci_suspend_noirq,
         .restore_noirq  = hcd_pci_resume_noirq,
--

I would defer this patch until you know what exactly suspend_common() will do for PMSG_POWEROFF because it may just be simpler to check system_state == SYSTEM_POWER_OFF in it internally.

OK - in that case would you just take the first 3 for 6.19?