Received-SPF: pass (google.com: domain of linux-bluetooth-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Content-Type: text/plain;
        charset=us-ascii
Mime-Version: 1.0 (Mac OS X Mail 13.4 \(3608.120.23.2.1\))
Subject: Re: [PATCH] Bluetooth: btusb: Avoid unnecessary reset upon system
 resume
From:   Kai-Heng Feng <kai.heng.feng@canonical.com>
In-Reply-To: <CANFp7mVJZTizHJDss5BJmdm5ydrfrVy4sBhXRX4vLBmK2sRGSA@mail.gmail.com>
Date:   Fri, 25 Sep 2020 14:03:34 +0800
Cc:     Alex Lu <alex_lu@realsil.com.cn>,
        Marcel Holtmann <marcel@holtmann.org>,
        Johan Hedberg <johan.hedberg@gmail.com>,
        "open list:BLUETOOTH DRIVERS" <linux-bluetooth@vger.kernel.org>,
        open list <linux-kernel@vger.kernel.org>,
        "open list:USB XHCI DRIVER" <linux-usb@vger.kernel.org>
Content-Transfer-Encoding: 8BIT
Message-Id: <C9D4A438-0CF8-42A2-8B9D-F5EF117AEF9B@canonical.com>
References: <20200923175602.9523-1-kai.heng.feng@canonical.com>
 <CANFp7mV7fC9_EZHd7B0Cu-owgCVdA6CNd2bb7XwFf5+6b7FVpg@mail.gmail.com>
 <A6F728DB-A07B-4323-83A5-3DABA8FDC156@canonical.com>
 <CANFp7mVJZTizHJDss5BJmdm5ydrfrVy4sBhXRX4vLBmK2sRGSA@mail.gmail.com>
To:     Abhishek Pandit-Subedi <abhishekpandit@chromium.org>
Precedence: bulk

Hi Abhishek,
> On Sep 25, 2020, at 11:33, Abhishek Pandit-Subedi <abhishekpandit@chromium.org> wrote:
> 
> + Alex Lu (who contributed the original change)
> 
> Hi Kai-Heng,
> 
> 
> On Thu, Sep 24, 2020 at 12:10 AM Kai-Heng Feng
> <kai.heng.feng@canonical.com> wrote:
>> 
>> [+Cc linux-usb]
>> 
>> Hi Abhishek,
>> 
>>> On Sep 24, 2020, at 04:41, Abhishek Pandit-Subedi <abhishekpandit@chromium.org> wrote:
>>> 
>>> Hi Kai-Heng,
>>> 
>>> Which Realtek controller is this on?'
>> 
>> The issue happens on 8821CE.
>> 
>>> 
>>> Specifically for RTL8822CE, we tested without reset_resume being set
>>> and that was causing the controller being reset without bluez ever
>>> learning about it (resulting in devices being unusable without
>>> toggling the BT power).
>> 
>> The reset is done by the kernel, so how does that affect bluez?
>> 
>> From what you described, it sounds more like runtime resume since bluez is already running.
>> If we need reset resume for runtime resume, maybe it's another bug which needs to be addressed?
> 
> From btusb.c:  https://git.kernel.org/pub/scm/linux/kernel/git/bluetooth/bluetooth-next.git/tree/drivers/bluetooth/btusb.c#n4189
> /* Realtek devices lose their updated firmware over global
> * suspend that means host doesn't send SET_FEATURE
> * (DEVICE_REMOTE_WAKEUP)
> */
> 
> Runtime suspend always requires remote wakeup to be set and reset
> resume isn't used there.

Thanks for the clarification.

> 
> During system suspend, when remote wakeup is not set, RTL8822CE loses
> the FW loaded by the driver and any state currently in the controller.
> This causes the kernel and the controller state to go out of sync.
> One of the issues we observed on the Realtek controller without the
> reset resume quirk was that paired or connected devices would just
> stop working after resume.
> 
>> 
>>> If the firmware doesn't cut off power during suspend, maybe you
>>> shouldn't set the BTUSB_WAKEUP_DISABLE flag for that controller.
>> 
>> We don't know beforehand if the platform firmware (BIOS for my case) will cut power off or not.
>> 
>> In general, laptops will cut off the USB power during S3.
>> When AC is plugged, some laptops cuts USB power off and some don't. This also applies to many desktops. Not to mention there can be BIOS options to control USB power under S3/S4/S5...
>> 
>> So we don't know beforehand.
>> 
> 
> I think the confusion here stems from what is actually being turned
> off between our two boards and what we're referring to as firmware :)

Yes :)

> 
> In your case, the Realtek controller retains firmware unless the
> platform cuts of power to USB (which it does during S3).

Not all platform firmware (i.e. BIOS for x86) cut USB power during S3, as I describe in last reply.

> In my case, the Realtek controller loses firmware when Remote Wakeup
> isn't set, even if the platform doesn't cut power to USB.

Thanks for the clarification, I believe it's a case that should to be handled separately.

> 
> In your case, since you don't need to enforce the 'Remote Wakeup' bit,
> if you unset the BTUSB_WAKEUP_DISABLE for that VID:PID, you should get
> the desirable behavior (which is actually the default behavior; remote
> wake will always be asserted instead of only during Runtime Suspend).

So we have three cases here. Assuming reset_resume isn't flagged by btusb:

1) Both USB power and BT firmware were lost during suspend.
USB core finds out power was lost, try to reset resume the device. Since btusb doesn't have reset_resume callback, USB core calls probe instead.

2) Both USB power and BT firmware were kept during suspend. This is my case.
Regular resume handles everything.

3) USB power was kept but BT firmware was lost. This is your case.
USB core finds out power was kept, use regular resume. However the BT firmware was lost, so resume fails.
For this case, maybe we can use btrtl_setup_realtek() in btusb_resume()? It won't re-upload firmware if firmware is retained, and will do proper initializing if firmware was lost.

Kai-Heng

> 
> @Alex -- What is the common behavior for Realtek controllers? Should
> we set BTUSB_WAKEUP_DISABLE only on RTL8822CE or should we unset it
> only on RTL8821CE?
> 
>>> 
>>> I would prefer this doesn't get accepted in its current state.
>> 
>> Of course.
>> I think we need to find the root cause for your case before applying this one.
>> 
>> Kai-Heng
>> 
>>> 
>>> Abhishek
>>> 
>>> On Wed, Sep 23, 2020 at 10:56 AM Kai-Heng Feng
>>> <kai.heng.feng@canonical.com> wrote:
>>>> 
>>>> Realtek bluetooth controller may fail to work after system sleep:
>>>> [ 1272.707670] Bluetooth: hci0: command 0x1001 tx timeout
>>>> [ 1280.835712] Bluetooth: hci0: RTL: HCI_OP_READ_LOCAL_VERSION failed (-110)
>>>> 
>>>> If platform firmware doesn't cut power off during suspend, the firmware
>>>> is considered retained in controller but the driver is still asking USB
>>>> core to perform a reset-resume. This can make bluetooth controller
>>>> unusable.
>>>> 
>>>> So avoid unnecessary reset to resolve the issue.
>>>> 
>>>> For devices that really lose power during suspend, USB core will detect
>>>> and handle reset-resume correctly.
>>>> 
>>>> Signed-off-by: Kai-Heng Feng <kai.heng.feng@canonical.com>
>>>> ---
>>>> drivers/bluetooth/btusb.c | 8 +++-----
>>>> 1 file changed, 3 insertions(+), 5 deletions(-)
>>>> 
>>>> diff --git a/drivers/bluetooth/btusb.c b/drivers/bluetooth/btusb.c
>>>> index 8d2608ddfd08..de86ef4388f9 100644
>>>> --- a/drivers/bluetooth/btusb.c
>>>> +++ b/drivers/bluetooth/btusb.c
>>>> @@ -4255,17 +4255,15 @@ static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
>>>>               enable_irq(data->oob_wake_irq);
>>>>       }
>>>> 
>>>> -       /* For global suspend, Realtek devices lose the loaded fw
>>>> -        * in them. But for autosuspend, firmware should remain.
>>>> -        * Actually, it depends on whether the usb host sends
>>>> +       /* For global suspend, Realtek devices lose the loaded fw in them if
>>>> +        * platform firmware cut power off. But for autosuspend, firmware
>>>> +        * should remain.  Actually, it depends on whether the usb host sends
>>>>        * set feature (enable wakeup) or not.
>>>>        */
>>>>       if (test_bit(BTUSB_WAKEUP_DISABLE, &data->flags)) {
>>>>               if (PMSG_IS_AUTO(message) &&
>>>>                   device_can_wakeup(&data->udev->dev))
>>>>                       data->udev->do_remote_wakeup = 1;
>>>> -               else if (!PMSG_IS_AUTO(message))
>>>> -                       data->udev->reset_resume = 1;
>>>>       }
>>>> 
>>>>       return 0;
>>>> --
>>>> 2.17.1