Skip to contentSkip to conversation

Bluetooth: btusb: Fix suspend issue for Realtek

PATCH Superseded Alex Lu 2 participants 2 messages Jul 26, 2019 – Jul 30, 2019 Bluetooth drivers

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore

Alex Lu

author
#0 lore raw

PATCH 1/1 Bluetooth: btusb: Fix suspend issue for Realtek

From: Alex Lu <[email protected]>

From the perspective of controller, global suspend means there is no SET_FEATURE (DEVICE_REMOTE_WAKEUP) and controller would drop the firmware. It would consume less power. So we should not send this kind of SET_FEATURE when host goes to suspend state.
Otherwise, when making device enter selective suspend, host should send SET_FEATURE to make sure the firmware remains.

---
 drivers/bluetooth/btusb.c | 40 +++++++++++++++++++++++++++++++++++----
 1 file changed, 36 insertions(+), 4 deletions(-)
drivers/bluetooth/btusb.c +36 -4
index 50aed5259c2b..69f6b4208901 100644
@@ -426,6 +426,7 @@ static const struct dmi_system_id btusb_needs_reset_resume_table[] = {
 #define BTUSB_DIAG_RUNNING	10
 #define BTUSB_OOB_WAKE_ENABLED	11
 #define BTUSB_HW_RESET_ACTIVE	12
+#define BTUSB_QUIRK_SUSPEND	13
 
 struct btusb_data {
 	struct hci_dev       *hdev;
@@ -1165,6 +1166,15 @@ static int btusb_open(struct hci_dev *hdev)
 	 */
 	device_wakeup_enable(&data->udev->dev);
 
+	/* Disable device remote wakeup when host is suspended
+	 * For Realtek chips, global suspend without
+	 * SET_FEATURE (DEVICE_REMOTE_WAKEUP) can save more power in device.
+	 */
+#ifdef CONFIG_BT_HCIBTUSB_RTL
+	if (test_bit(BTUSB_QUIRK_SUSPEND, &data->flags))
+		device_wakeup_disable(&data->udev->dev);
+#endif
+
 	if (test_and_set_bit(BTUSB_INTR_RUNNING, &data->flags))
 		goto done;
 
@@ -1227,6 +1237,13 @@ static int btusb_close(struct hci_dev *hdev)
 		goto failed;
 
 	data->intf->needs_remote_wakeup = 0;
+
+	/* Enable remote wake up for auto-suspend */
+#ifdef CONFIG_BT_HCIBTUSB_RTL
+	if (test_bit(BTUSB_QUIRK_SUSPEND, &data->flags))
+		data->intf->needs_remote_wakeup = 1;
+#endif
+
 	device_wakeup_disable(&data->udev->dev);
 	usb_autopm_put_interface(data->intf);
 
@@ -3185,11 +3202,11 @@ static int btusb_probe(struct usb_interface *intf,
 	if (id->driver_info & BTUSB_REALTEK) {
 		hdev->setup = btrtl_setup_realtek;
 
-		/* Realtek devices lose their updated firmware over suspend,
-		 * but the USB hub doesn't notice any status change.
-		 * Explicitly request a device reset on resume.
+		/* Realtek devices lose their updated firmware over global
+		 * suspend that means host doesn't send SET_FEATURE
+		 * (DEVICE_REMOTE_WAKEUP)
 		 */
-		interface_to_usbdev(intf)->quirks |= USB_QUIRK_RESET_RESUME;
+		set_bit(BTUSB_QUIRK_SUSPEND, &data->flags);
 	}
 #endif
 
@@ -3363,6 +3380,21 @@ static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
 		enable_irq(data->oob_wake_irq);
 	}
 
+#ifdef CONFIG_BT_HCIBTUSB_RTL
+	/* 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
+	 * set feature (enable wakeup) or not.
+	 */
+	if (test_bit(BTUSB_QUIRK_SUSPEND, &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;
+	}
+#endif
+
 	return 0;
 }
 
Signature · 1 line
2.19.2
maintainer
#1 lore raw

Hi Alex,

Quoted 17 lines

From the perspective of controller, global suspend means there is no SET_FEATURE (DEVICE_REMOTE_WAKEUP) and controller would drop the firmware. It would consume less power. So we should not send this kind of SET_FEATURE when host goes to suspend state.
Otherwise, when making device enter selective suspend, host should send SET_FEATURE to make sure the firmware remains.

---
drivers/bluetooth/btusb.c | 40 +++++++++++++++++++++++++++++++++++----

1 file changed, 36 insertions(+), 4 deletions(-)
drivers/bluetooth/btusb.c +0 -0
index 50aed5259c2b..69f6b4208901 100644

drivers/bluetooth/btusb.c static const struct dmi_system_id btusb_needs_reset_resume_table[] = { · line 429

Quoted 4 lines
drivers/bluetooth/btusb.c +1 -0
@@ -426,6 +426,7 @@ static const struct dmi_system_id btusb_needs_reset_resume_table[] = {
 #define BTUSB_DIAG_RUNNING	10
 #define BTUSB_OOB_WAKE_ENABLED	11
 #define BTUSB_HW_RESET_ACTIVE	12
+#define BTUSB_QUIRK_SUSPEND	13

I think this name is not really descriptive. What about BTUSB_SUSPEND_DISABLE or BTUSB_WAKEUP_DISABLE or BTUSB_REMOTE_WAKEUP or something that is rather clear.

Quoted 6 lines
drivers/bluetooth/btusb.c +0 -0
 struct btusb_data {
 	struct hci_dev       *hdev;
@@ -1165,6 +1166,15 @@ static int btusb_open(struct hci_dev *hdev)
 	 */
 	device_wakeup_enable(&data->udev->dev);

drivers/bluetooth/btusb.c static int btusb_open(struct hci_dev *hdev) · line 1177

Quoted 10 lines
drivers/bluetooth/btusb.c +9 -0
 
+	/* Disable device remote wakeup when host is suspended
+	 * For Realtek chips, global suspend without
+	 * SET_FEATURE (DEVICE_REMOTE_WAKEUP) can save more power in device.
+	 */
+#ifdef CONFIG_BT_HCIBTUSB_RTL
+	if (test_bit(BTUSB_QUIRK_SUSPEND, &data->flags))
+		device_wakeup_disable(&data->udev->dev);
+#endif
+

I have no idea what the #ifdef does here. Limiting it to HCIBTUSB_RTL seems pointless.

Quoted 4 lines
drivers/bluetooth/btusb.c +0 -0
 	if (test_and_set_bit(BTUSB_INTR_RUNNING, &data->flags))
 		goto done;
 

drivers/bluetooth/btusb.c static int btusb_close(struct hci_dev *hdev) · line 1246

Quoted 10 lines
drivers/bluetooth/btusb.c +7 -0
@@ -1227,6 +1237,13 @@ static int btusb_close(struct hci_dev *hdev)
 		goto failed;
 
 	data->intf->needs_remote_wakeup = 0;
+
+	/* Enable remote wake up for auto-suspend */
+#ifdef CONFIG_BT_HCIBTUSB_RTL
+	if (test_bit(BTUSB_QUIRK_SUSPEND, &data->flags))
+		data->intf->needs_remote_wakeup = 1;
+#endif
+

Same comment as above. No need for the #ifdef.

Quoted 28 lines
drivers/bluetooth/btusb.c +9 -4
 	device_wakeup_disable(&data->udev->dev);
 	usb_autopm_put_interface(data->intf);
 
@@ -3185,11 +3202,11 @@ static int btusb_probe(struct usb_interface *intf,
 	if (id->driver_info & BTUSB_REALTEK) {
 		hdev->setup = btrtl_setup_realtek;
 
-		/* Realtek devices lose their updated firmware over suspend,
-		 * but the USB hub doesn't notice any status change.
-		 * Explicitly request a device reset on resume.
+		/* Realtek devices lose their updated firmware over global
+		 * suspend that means host doesn't send SET_FEATURE
+		 * (DEVICE_REMOTE_WAKEUP)
 		 */
-		interface_to_usbdev(intf)->quirks |= USB_QUIRK_RESET_RESUME;
+		set_bit(BTUSB_QUIRK_SUSPEND, &data->flags);
 	}
 #endif
 
@@ -3363,6 +3380,21 @@ static int btusb_suspend(struct usb_interface *intf, pm_message_t message)
 		enable_irq(data->oob_wake_irq);
 	}
 
+#ifdef CONFIG_BT_HCIBTUSB_RTL
+	/* 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
+	 * set feature (enable wakeup) or not.

drivers/bluetooth/btusb.c static int btusb_suspend(struct usb_interface *intf, pm_message_t message) · line 3397

Quoted 10 lines
drivers/bluetooth/btusb.c +10 -0
+	 */
+	if (test_bit(BTUSB_QUIRK_SUSPEND, &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;
+	}
+#endif
+

The #ifdef is also not needed here.

Regards

Marcel