Skip to contentSkip to conversation

net: txgbe: Avoid passing uninitialised parameter to pci_wake_from_d3()

PATCH Applied Simon Horman 3 participants 3 messages Jun 6, 2023 – Jun 7, 2023

Subsystems (3)
lore
Share & tools
lore

Simon Horman

author reviewer
#0 lore raw

PATCH v2 1/1 net: txgbe: Avoid passing uninitialised parameter to pci_wake_from_d3()

txgbe_shutdown() relies on txgbe_dev_shutdown() to initialise wake by passing it by reference. However, txgbe_dev_shutdown() doesn't use this parameter at all.

wake is then passed uninitialised by txgbe_dev_shutdown() to pci_wake_from_d3().

Resolve this problem by:
* Removing the unused parameter from txgbe_dev_shutdown()
* Removing the uninitialised variable wake from txgbe_dev_shutdown()
* Passing false to pci_wake_from_d3() - this assumes that although uninitialised wake was in practice false (0).

I'm not sure that this counts as a bug, as I'm not sure that it manifests in any unwanted behaviour. But in any case, the issue was introduced by:

3ce7547e5b71 ("net: txgbe: Add build support for txgbe")

Flagged by Smatch as:

.../txgbe_main.c:486 txgbe_shutdown() error: uninitialized symbol 'wake'.

No functional change intended.
Compile tested only.

---
Changes in v2:
- Correct referenced commit: it self referential in v1
- Add added Reviewed-by tag from Jiawen Wu
- Link to v1: https://lore.kernel.org/r/[email protected]

---
 drivers/net/ethernet/wangxun/txgbe/txgbe_main.c | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)
drivers/net/ethernet/wangxun/txgbe/txgbe_main.c +3 -5
index 0f0d9fa1cde1..cfe47f3d2503 100644
@@ -457,7 +457,7 @@ static int txgbe_close(struct net_device *netdev)
 	return 0;
 }
 
-static void txgbe_dev_shutdown(struct pci_dev *pdev, bool *enable_wake)
+static void txgbe_dev_shutdown(struct pci_dev *pdev)
 {
 	struct wx *wx = pci_get_drvdata(pdev);
 	struct net_device *netdev;
@@ -477,12 +477,10 @@ static void txgbe_dev_shutdown(struct pci_dev *pdev, bool *enable_wake)
 
 static void txgbe_shutdown(struct pci_dev *pdev)
 {
-	bool wake;
-
-	txgbe_dev_shutdown(pdev, &wake);
+	txgbe_dev_shutdown(pdev);
 
 	if (system_state == SYSTEM_POWER_OFF) {
-		pci_wake_from_d3(pdev, wake);
+		pci_wake_from_d3(pdev, false);
 		pci_set_power_state(pdev, PCI_D3hot);
 	}
 }
Reviewed-by on v2 1/1
#1 lore raw
Quoted 21 lines · Simon Horman

txgbe_shutdown() relies on txgbe_dev_shutdown() to initialise wake by passing it by reference. However, txgbe_dev_shutdown() doesn't use this parameter at all.

wake is then passed uninitialised by txgbe_dev_shutdown() to pci_wake_from_d3().

Resolve this problem by:
* Removing the unused parameter from txgbe_dev_shutdown()
* Removing the uninitialised variable wake from txgbe_dev_shutdown()
* Passing false to pci_wake_from_d3() - this assumes that although uninitialised wake was in practice false (0).

I'm not sure that this counts as a bug, as I'm not sure that it manifests in any unwanted behaviour. But in any case, the issue was introduced by:

3ce7547e5b71 ("net: txgbe: Add build support for txgbe")

Flagged by Smatch as:

Quoted 7 lines

.../txgbe_main.c:486 txgbe_shutdown() error: uninitialized symbol 'wake'.

No functional change intended.
Compile tested only.

Quoted 38 lines

---
Changes in v2:
- Correct referenced commit: it self referential in v1
- Add added Reviewed-by tag from Jiawen Wu
- Link to v1: https://lore.kernel.org/r/[email protected]

---
 drivers/net/ethernet/wangxun/txgbe/txgbe_main.c | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)
drivers/net/ethernet/wangxun/txgbe/txgbe_main.c +3 -5
index 0f0d9fa1cde1..cfe47f3d2503 100644
@@ -457,7 +457,7 @@ static int txgbe_close(struct net_device *netdev)
 	return 0;
 }
 
-static void txgbe_dev_shutdown(struct pci_dev *pdev, bool *enable_wake)
+static void txgbe_dev_shutdown(struct pci_dev *pdev)
 {
 	struct wx *wx = pci_get_drvdata(pdev);
 	struct net_device *netdev;
@@ -477,12 +477,10 @@ static void txgbe_dev_shutdown(struct pci_dev *pdev, bool *enable_wake)
 
 static void txgbe_shutdown(struct pci_dev *pdev)
 {
-	bool wake;
-
-	txgbe_dev_shutdown(pdev, &wake);
+	txgbe_dev_shutdown(pdev);
 
 	if (system_state == SYSTEM_POWER_OFF) {
-		pci_wake_from_d3(pdev, wake);
+		pci_wake_from_d3(pdev, false);
 		pci_set_power_state(pdev, PCI_D3hot);
 	}
 }
#2 lore raw
In reply to Simon Horman
This patch was applied to netdev/net-next.git (main) by David S. Miller <[email protected]>:

Hello:

This patch was applied to netdev/net-next.git (main) by David S. Miller <[email protected]>:

Quoted 8 lines · On Tue, 06 Jun 2023 15:49:45 +0200 you wrote:

txgbe_shutdown() relies on txgbe_dev_shutdown() to initialise wake by passing it by reference. However, txgbe_dev_shutdown() doesn't use this parameter at all.

wake is then passed uninitialised by txgbe_dev_shutdown() to pci_wake_from_d3().

[...]

Here is the summary with links:
- [net-next,v2] net: txgbe: Avoid passing uninitialised parameter to pci_wake_from_d3()

    https://git.kernel.org/netdev/net-next/c/e7214663e023

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html