[Deepin-Kernel-SIG] [Upstream] [linux 6.6-y] Sync some rtlwifi bugfix from mainline

[opsiff]

Commit:
wifi: rtlwifi: rtl8821ae: Fix media status report
wifi: rtlwifi: pci: wait for firmware loading before releasing memory
wifi: rtlwifi: fix memory leaks and invalid access at probe error path
wifi: rtlwifi: destroy workqueue at rtl_deinit_core
wifi: rtlwifi: remove unused check_buddy_priv

Summary by Sourcery

Sync rtlwifi bug fixes from mainline. This includes fixing media status reports, waiting for firmware loading before releasing memory, fixing memory leaks and invalid access at probe error path, destroying workqueue at rtl_deinit_core, and removing unused check_buddy_priv.

Bug Fixes:

• Fixed media status report.
• Fixed memory leaks and invalid access at probe error path.
• Fixed an issue where memory was released before firmware loading was complete.

Enhancements:

• Removed the unused check_buddy_priv function.
• Workqueues are now destroyed during deinitialization.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request backports several bug fixes from the mainline kernel related to the rtlwifi driver. These fixes address issues such as incorrect media status reporting, potential memory leaks, and improper resource management during driver initialization and deinitialization.

Sequence diagram for improved rtlwifi driver initialization and cleanup

sequenceDiagram
    participant Driver as RTL WiFi Driver
    participant Core as RTL Core
    participant FW as Firmware
    participant HW as Hardware

    Driver->>Core: rtl_pci_probe()
    Core->>HW: Initialize hardware
    Core->>FW: Load firmware
    Note over Core,FW: Now waits for firmware completion
    alt Initialization fails
        Core->>FW: Wait for firmware_loading_complete
        Core->>Core: Cleanup resources
        Core->>Core: Deinit core
    end

    Note over Driver: During shutdown
    Driver->>Core: rtl_deinit_core()
    Core->>Core: Stop C2H command launcher
    Core->>Core: Free scan list entries
    Core->>Core: Free ACK queue entries
    Core->>Core: Destroy work queue

Loading

Class diagram showing removed global variable structure

classDiagram
    class rtl_priv {
        -ieee80211_hw* hw
        -completion firmware_loading_complete
        -rtl_priv* buddy_priv
        -rtl_works works
        +deinit()
    }

    class rtl_works {
        -workqueue* rtl_wq
        +destroy()
    }

    note for rtl_priv "Removed global var and list management"
    rtl_priv -- rtl_works

Loading

State diagram for improved driver cleanup process

stateDiagram-v2
    [*] --> Running
    Running --> Stopping: rtl_pci_disconnect
    Stopping --> CleaningResources: Stop adapter
    CleaningResources --> WaitingFirmware: Wait completion
    WaitingFirmware --> DeinitCore: Firmware done
    DeinitCore --> DestroyWorkqueue: Clean resources
    DestroyWorkqueue --> [*]: Release memory

Loading

File-Level Changes

Change	Details	Files
Fix media status report.	Corrected bit manipulation for setting the operation mode and MAC ID indicator in the media status report command.	drivers/net/wireless/realtek/rtlwifi/rtl8821ae/fw.h
Wait for firmware loading before releasing memory.	Modified the error handling in the probe function to wait for firmware loading completion before deallocating resources. This ensures that firmware loading is complete before resources are released during a probe failure.	drivers/net/wireless/realtek/rtlwifi/pci.c
Fix memory leaks and invalid access at probe error path.	Moved the deinitialization of software variables to occur after waiting for firmware loading completion. This prevents potential memory leaks and invalid memory access during probe failures.	drivers/net/wireless/realtek/rtlwifi/pci.c
Destroy workqueue at rtl_deinit_core.	Moved the workqueue destruction from rtl_pci_deinit to rtl_deinit_core to ensure it is always destroyed. Added a check to ensure the workqueue exists before attempting to destroy it in rtl_deinit_core and _rtl_usb_cleanup_rx. Set the workqueue pointer to NULL after destroying it to prevent double frees.	drivers/net/wireless/realtek/rtlwifi/pci.c drivers/net/wireless/realtek/rtlwifi/base.c drivers/net/wireless/realtek/rtlwifi/usb.c
Remove unused check_buddy_priv function.	Removed the rtl_pci_check_buddy_priv function from pci.c and the corresponding declaration from wifi.h. Removed the call to check_buddy_priv from the rtl_intf_ops structure.	drivers/net/wireless/realtek/rtlwifi/pci.c drivers/net/wireless/realtek/rtlwifi/wifi.h
Remove global variable and list.	Removed the global variable rtl_global_var and its associated list and lock. Removed the addition and deletion of the rtl_priv from the global list. Removed the glb_var member from the rtl_priv structure.	drivers/net/wireless/realtek/rtlwifi/pci.c drivers/net/wireless/realtek/rtlwifi/base.c drivers/net/wireless/realtek/rtlwifi/wifi.h

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @opsiff - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[deepin-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sourcery-ai[bot]
Once this PR has been reviewed and has the lgtm label, please ask for approval from opsiff. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details

Needs approval from an approver in each of these files:

• deepin/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment