Linux Kernel Mentee: Remove Legacy Power Management.
The purpose of this patch series is to remove legacy power management callbacks
from qlogic ethernet drivers.
The callbacks performing suspend() and resume() operations are still calling
pci_save_state(), pci_set_power_state(), etc. and handling the power management
themselves, which is not recommended.
The conversion requires the removal of the those function calls and change the
callback definition accordingly and make use of dev_pm_ops structure.
All patches are compile-tested only.
Vaibhav Gupta (2):
netxen_nic: use generic power management
qlcninc: use generic power management
.../ethernet/qlogic/netxen/netxen_nic_main.c | 59 +++++++++----------
.../net/ethernet/qlogic/qlcnic/qlcnic_hw.c | 10 +---
.../net/ethernet/qlogic/qlcnic/qlcnic_main.c | 33 +++--------
3 files changed, 37 insertions(+), 65 deletions(-)
--
2.27.0
With legacy PM, drivers themselves were responsible for managing the
device's power states and takes care of register states. And they use PCI
helper functions to do it.
After upgrading to the generic structure, PCI core will take care of
required tasks and drivers should do only device-specific operations.
In this driver:
netxen_nic_resume() calls netxen_nic_attach_func() which then invokes PCI
helper functions like pci_enable_device(), pci_set_power_state() and
pci_restore_state(). Other function:
- netxen_io_slot_reset()
also calls netxen_nic_attach_func().
Also, netxen_io_slot_reset() returns specific value based on the return value
of netxen_nic_attach_func() as whole. Thus, cannot simply move some piece of
code from netxen_nic_attach_func() to it.
Hence, define a new function netxen_nic_attach_late_func() to do the tasks
which has to be done after PCI helper functions have done their job.
Now, netxen_nic_attach_func() invokes netxen_nic_attach_late_func(), thus
netxen_io_slot_reset() behaves normally.
And, netxen_nic_resume() calls netxen_nic_attach_late_func() to avoid PCI
helper functions calls.
Compile-tested only.
Signed-off-by: Vaibhav Gupta <[email protected]>
---
.../ethernet/qlogic/netxen/netxen_nic_main.c | 59 +++++++++----------
1 file changed, 28 insertions(+), 31 deletions(-)
diff --git a/drivers/net/ethernet/qlogic/netxen/netxen_nic_main.c b/drivers/net/ethernet/qlogic/netxen/netxen_nic_main.c
index 8067ea04d455..f21847739ef1 100644
--- a/drivers/net/ethernet/qlogic/netxen/netxen_nic_main.c
+++ b/drivers/net/ethernet/qlogic/netxen/netxen_nic_main.c
@@ -1695,19 +1695,13 @@ static void netxen_nic_detach_func(struct netxen_adapter *adapter)
clear_bit(__NX_RESETTING, &adapter->state);
}
-static int netxen_nic_attach_func(struct pci_dev *pdev)
+static int netxen_nic_attach_late_func(struct pci_dev *pdev)
{
struct netxen_adapter *adapter = pci_get_drvdata(pdev);
struct net_device *netdev = adapter->netdev;
int err;
- err = pci_enable_device(pdev);
- if (err)
- return err;
-
- pci_set_power_state(pdev, PCI_D0);
pci_set_master(pdev);
- pci_restore_state(pdev);
adapter->ahw.crb_win = -1;
adapter->ahw.ocm_win = -1;
@@ -1741,6 +1735,20 @@ static int netxen_nic_attach_func(struct pci_dev *pdev)
return err;
}
+static int netxen_nic_attach_func(struct pci_dev *pdev)
+{
+ int err;
+
+ err = pci_enable_device(pdev);
+ if (err)
+ return err;
+
+ pci_set_power_state(pdev, PCI_D0);
+ pci_restore_state(pdev);
+
+ return netxen_nic_attach_late_func(pdev);
+}
+
static pci_ers_result_t netxen_io_error_detected(struct pci_dev *pdev,
pci_channel_state_t state)
{
@@ -1785,36 +1793,24 @@ static void netxen_nic_shutdown(struct pci_dev *pdev)
pci_disable_device(pdev);
}
-#ifdef CONFIG_PM
-static int
-netxen_nic_suspend(struct pci_dev *pdev, pm_message_t state)
+static int __maybe_unused
+netxen_nic_suspend(struct device *dev_d)
{
- struct netxen_adapter *adapter = pci_get_drvdata(pdev);
- int retval;
+ struct netxen_adapter *adapter = dev_get_drvdata(dev_d);
netxen_nic_detach_func(adapter);
- retval = pci_save_state(pdev);
- if (retval)
- return retval;
-
- if (netxen_nic_wol_supported(adapter)) {
- pci_enable_wake(pdev, PCI_D3cold, 1);
- pci_enable_wake(pdev, PCI_D3hot, 1);
- }
-
- pci_disable_device(pdev);
- pci_set_power_state(pdev, pci_choose_state(pdev, state));
+ if (netxen_nic_wol_supported(adapter))
+ device_wakeup_enable(dev_d);
return 0;
}
-static int
-netxen_nic_resume(struct pci_dev *pdev)
+static int __maybe_unused
+netxen_nic_resume(struct device *dev_d)
{
- return netxen_nic_attach_func(pdev);
+ return netxen_nic_attach_late_func(to_pci_dev(dev_d));
}
-#endif
static int netxen_nic_open(struct net_device *netdev)
{
@@ -3448,15 +3444,16 @@ static const struct pci_error_handlers netxen_err_handler = {
.slot_reset = netxen_io_slot_reset,
};
+static SIMPLE_DEV_PM_OPS(netxen_nic_pm_ops,
+ netxen_nic_suspend,
+ netxen_nic_resume);
+
static struct pci_driver netxen_driver = {
.name = netxen_nic_driver_name,
.id_table = netxen_pci_tbl,
.probe = netxen_nic_probe,
.remove = netxen_nic_remove,
-#ifdef CONFIG_PM
- .suspend = netxen_nic_suspend,
- .resume = netxen_nic_resume,
-#endif
+ .driver.pm = &netxen_nic_pm_ops,
.shutdown = netxen_nic_shutdown,
.err_handler = &netxen_err_handler
};
--
2.27.0
With legacy PM, drivers themselves were responsible for managing the
device's power states and takes care of register states. And they use PCI
helper functions to do it.
After upgrading to the generic structure, PCI core will take care of
required tasks and drivers should do only device-specific operations.
.suspend() calls __qlcnic_shutdown, which then calls qlcnic_82xx_shutdown;
.resume() calls __qlcnic_resume, which then calls qlcnic_82xx_resume;
Both ...82xx..() are define in
drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c and are used only in
drivers/net/ethernet/qlogic/qlcnic/qlcnic_main.c.
Hence upgrade them and remove PCI function calls, like pci_save_state() and
pci_enable_wake(), inside them
Compile-tested only.
Signed-off-by: Vaibhav Gupta <[email protected]>
---
.../net/ethernet/qlogic/qlcnic/qlcnic_hw.c | 10 ++----
.../net/ethernet/qlogic/qlcnic/qlcnic_main.c | 33 ++++---------------
2 files changed, 9 insertions(+), 34 deletions(-)
diff --git a/drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c b/drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c
index 822aa393c370..780bba9f2e92 100644
--- a/drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c
+++ b/drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c
@@ -1662,14 +1662,8 @@ int qlcnic_82xx_shutdown(struct pci_dev *pdev)
clear_bit(__QLCNIC_RESETTING, &adapter->state);
- retval = pci_save_state(pdev);
- if (retval)
- return retval;
-
- if (qlcnic_wol_supported(adapter)) {
- pci_enable_wake(pdev, PCI_D3cold, 1);
- pci_enable_wake(pdev, PCI_D3hot, 1);
- }
+ if (qlcnic_wol_supported(adapter))
+ device_wakeup_enable(&pdev->dev);
return 0;
}
diff --git a/drivers/net/ethernet/qlogic/qlcnic/qlcnic_main.c b/drivers/net/ethernet/qlogic/qlcnic/qlcnic_main.c
index 9dd6cb36f366..e52af092a793 100644
--- a/drivers/net/ethernet/qlogic/qlcnic/qlcnic_main.c
+++ b/drivers/net/ethernet/qlogic/qlcnic/qlcnic_main.c
@@ -2811,35 +2811,17 @@ static void qlcnic_shutdown(struct pci_dev *pdev)
pci_disable_device(pdev);
}
-#ifdef CONFIG_PM
-static int qlcnic_suspend(struct pci_dev *pdev, pm_message_t state)
+static int __maybe_unused qlcnic_suspend(struct device *dev_d)
{
- int retval;
-
- retval = __qlcnic_shutdown(pdev);
- if (retval)
- return retval;
-
- pci_set_power_state(pdev, pci_choose_state(pdev, state));
- return 0;
+ return __qlcnic_shutdown(to_pci_dev(dev_d));
}
-static int qlcnic_resume(struct pci_dev *pdev)
+static int __maybe_unused qlcnic_resume(struct device *dev_d)
{
- struct qlcnic_adapter *adapter = pci_get_drvdata(pdev);
- int err;
-
- err = pci_enable_device(pdev);
- if (err)
- return err;
-
- pci_set_power_state(pdev, PCI_D0);
- pci_set_master(pdev);
- pci_restore_state(pdev);
+ struct qlcnic_adapter *adapter = dev_get_drvdata(dev_d);
return __qlcnic_resume(adapter);
}
-#endif
static int qlcnic_open(struct net_device *netdev)
{
@@ -4258,15 +4240,14 @@ static const struct pci_error_handlers qlcnic_err_handler = {
.resume = qlcnic_io_resume,
};
+static SIMPLE_DEV_PM_OPS(qlcnic_pm_ops, qlcnic_suspend, qlcnic_resume);
+
static struct pci_driver qlcnic_driver = {
.name = qlcnic_driver_name,
.id_table = qlcnic_pci_tbl,
.probe = qlcnic_probe,
.remove = qlcnic_remove,
-#ifdef CONFIG_PM
- .suspend = qlcnic_suspend,
- .resume = qlcnic_resume,
-#endif
+ .driver.pm = &qlcnic_pm_ops,
.shutdown = qlcnic_shutdown,
.err_handler = &qlcnic_err_handler,
#ifdef CONFIG_QLCNIC_SRIOV
--
2.27.0
On 02/07/2020 9:36 am, Vaibhav Gupta wrote:
> External Email
>
> ----------------------------------------------------------------------
> With legacy PM, drivers themselves were responsible for managing the
> device's power states and takes care of register states. And they use PCI
> helper functions to do it.
>
> After upgrading to the generic structure, PCI core will take care of
> required tasks and drivers should do only device-specific operations.
>
> .suspend() calls __qlcnic_shutdown, which then calls qlcnic_82xx_shutdown;
> .resume() calls __qlcnic_resume, which then calls qlcnic_82xx_resume;
>
> Both ...82xx..() are define in
> drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c and are used only in
> drivers/net/ethernet/qlogic/qlcnic/qlcnic_main.c.
>
> Hence upgrade them and remove PCI function calls, like pci_save_state()
> and
> pci_enable_wake(), inside them
>
> Compile-tested only.
>
> Signed-off-by: Vaibhav Gupta <[email protected]>
Acked-by: Igor Russkikh <[email protected]>
Thanks!
On Thu, 2 Jul 2020 12:06:32 +0530 Vaibhav Gupta wrote:
> With legacy PM, drivers themselves were responsible for managing the
> device's power states and takes care of register states. And they use PCI
> helper functions to do it.
>
> After upgrading to the generic structure, PCI core will take care of
> required tasks and drivers should do only device-specific operations.
>
> .suspend() calls __qlcnic_shutdown, which then calls qlcnic_82xx_shutdown;
> .resume() calls __qlcnic_resume, which then calls qlcnic_82xx_resume;
>
> Both ...82xx..() are define in
> drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c and are used only in
> drivers/net/ethernet/qlogic/qlcnic/qlcnic_main.c.
>
> Hence upgrade them and remove PCI function calls, like pci_save_state() and
> pci_enable_wake(), inside them
>
> Compile-tested only.
>
> Signed-off-by: Vaibhav Gupta <[email protected]>
drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c: In function ‘qlcnic_82xx_shutdown’:
drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c:1652:6: warning: unused variable ‘retval’ [-Wunused-variable]
1652 | int retval;
| ^~~~~~
On Thu, Jul 2, 2020 at 10:06 PM Jakub Kicinski <[email protected]> wrote:
>
> On Thu, 2 Jul 2020 12:06:32 +0530 Vaibhav Gupta wrote:
> > With legacy PM, drivers themselves were responsible for managing the
> > device's power states and takes care of register states. And they use PCI
> > helper functions to do it.
> >
> > After upgrading to the generic structure, PCI core will take care of
> > required tasks and drivers should do only device-specific operations.
> >
> > .suspend() calls __qlcnic_shutdown, which then calls qlcnic_82xx_shutdown;
> > .resume() calls __qlcnic_resume, which then calls qlcnic_82xx_resume;
> >
> > Both ...82xx..() are define in
> > drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c and are used only in
> > drivers/net/ethernet/qlogic/qlcnic/qlcnic_main.c.
> >
> > Hence upgrade them and remove PCI function calls, like pci_save_state() and
> > pci_enable_wake(), inside them
> >
> > Compile-tested only.
> >
> > Signed-off-by: Vaibhav Gupta <[email protected]>
>
> drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c: In function ‘qlcnic_82xx_shutdown’:
> drivers/net/ethernet/qlogic/qlcnic/qlcnic_hw.c:1652:6: warning: unused variable ‘retval’ [-Wunused-variable]
> 1652 | int retval;
> | ^~~~~~
Fixed in v2.
Thanks!
--Vaibhav Gupta