The network manager does not check the NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE bit

[Leon Liao]

[Impact]

 In some cases, the wow is not configured and the NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE is set (for to disable management of wake-on-LAN in NetworkManager).

 The network manager only checks the NM_SETTING_WIRELESS_WAKE_ON_WLAN_NONE bit.
 But, the NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE does not be check.
 So, the management of wake-on-LAN still is done by NetworkManager.

 The killer 500s Wi-Fi does not want the network-manger to manager the wake-on-LAN so the NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE is set. (The driver will manager itself.) When the network-manager managers the wake-on-LAN, all of the Wi-Fi functions will be lost after the OS resumed from suspend.

[Test Case]

 On a machine with killer 500s Wi-Fi and install the Qualcomm's driver.
 Step 1. Enter suspend (s2idle)
 Setp 2. Resume from suspend

 After resume from suspend, the Wi-Fi function still is normal.

 You can download the kernel and linux-firmware that backport the Qucalcomm's dirver fro focal from below link:
 https://launchpad.net/~vicamo/+archive/ubuntu/ppa-1879633

[Regression Potential]

 * This patch modifies the wake on lan parameters, please test that the corresponding feature still works fine with the different configuration values.

 1. Magic packet test:
  Set Wake on Wireless to off
  Send magic packet to the system
  Ensure it does not wake up

  Set Wake on Wirless to on
  Send magic packet to the system
  Ensure it does wake up

 2. Wi-Fi function test after resumed from suspend:
  After resume from suspend, the Wi-Fi should work normally.
  Scan APs.
  Connect to an AP.

[Other Info]

 * platform: add the NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE status check (!597) · Merge Requests · NetworkManager / NetworkManager · GitLab - https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/597#note_588639

[Leon Liao (lihow731)]

The patch was merged into debian network-manager repository
in https://salsa.debian.org/utopia-team/network-manager/-/commit/e7b44ef4c80907346ec7492a09c45277459924fc.

For Groovy, when network-manager version >= 1.26.2, this patch will be included.
For Focal, the network-manager (1.22.10) needs to carry on this patch.

Append the debdiff for focal.

[Ubuntu Foundations Team Bug Bot (crichton)]

The attachment "network-manager_1.22.10-1ubuntu2.2.debdiff" seems to be a debdiff. The ubuntu-sponsors team has been subscribed to the bug report so that they can review and hopefully sponsor the debdiff. If the attachment isn't a patch, please remove the "patch" flag from the attachment, remove the "patch" tag, and if you are member of the ~ubuntu-sponsors, unsubscribe the team.

[This is an automated message performed by a Launchpad user owned by ~brian-murray, for any issue please contact him.]

[Iain Lane (laney)]

I've uploaded, thanks.

But the regression potential section needs improving, "None" isn't enough. Please improve it to discuss where people should focus their attention / testing.

[Robie Basak (racb)]

Incomplete pending a proper regression analysis.

[Sebastien Bacher (seb128)]

unsubscribing sponsors since is uploaded, the regression potential section still require an update though

[Brian Murray (brian-murray)]

I'd prefer to have something more concrete than this regression potential "please test that the corresponding feature still works fine with the different configuration values.". Could you add details about what exactly would be done? For example:

Set Wake on Wireless to off
Send magic packet to the system
Ensure it does not wake up

Set Wake on Wirless to on
Send magic packet to the system
Ensure it does wake up

[Leon Liao (lihow731)]

Hi,

I updated the description of the regression potential.
Please check it.

Thanks.

[Rex Tsai (chihchun)]

Added upstream issue link in the description for referenc - platform: add the NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE status check (!597) · Merge Requests · NetworkManager / NetworkManager · GitLab - https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/597#note_588639

[Yuan-Chen Cheng (ycheng-twn)]

It exists in queue https://launchpad.net/ubuntu/focal/+queue?queue_state=1&queue_text=network, which is network manager 1.22.10-1ubuntu2.2.

[Brian Murray (brian-murray)]

Hello Leon, or anyone else affected,

Accepted network-manager into focal-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/network-manager/1.22.10-1ubuntu2.2 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, what testing has been performed on the package and change the tag from verification-needed-focal to verification-done-focal. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed-focal. In either case, without details of your testing we will not be able to proceed.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance for helping!

N.B. The updated package will be released to -updates after the bug(s) fixed by this package have been verified and the package has been in -proposed for a minimum of 7 days.

[You-Sheng Yang (vicamo)]

Verified 1.22.10-1ubuntu2.2 from focal-proposed with packages network-manager, libnm0, gir1.2-nm-1.0, network-manager-config-connectivity-ubuntu installed.

[Launchpad Janitor (janitor)]

This bug was fixed in the package network-manager - 1.22.10-1ubuntu2.2

---------------
network-manager (1.22.10-1ubuntu2.2) focal; urgency=medium

  * platform: add the NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE status check
    (LP: #1891632)

 -- Li-Hao Liao (Leon Liao) <email address hidden> Wed, 16 Sep 2020 17:05:18 +0100

[Łukasz Zemczak (sil2100)]

The verification of the Stable Release Update for network-manager has completed successfully and the package is now being released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.