HID: intel-ish-hid: use async resume function
Subsystems (3)
PATCH 1/1 HID: intel-ish-hid: use async resume function
ISH IPC driver uses asynchronous workqueue to do resume now, but there is a potential timing issue: when child devices resume before bus driver, it will cause child devices resume failed and cannot be recovered until reboot. The current implementation in this case do wait for IPC to resume but fail to accommodate for a case when there is no ISH reboot and soft resume is taking time. This issue is apparent on Tiger Lake platform with 5.11.13 kernel when doing suspend to idle then resume(s0ix) test. To resolve this issue, we change ISHTP HID client to use asynchronous resume callback too. In the asynchronous resume callback, it waits for the ISHTP resume done event, and then notify ISHTP HID client link ready.
--- drivers/hid/intel-ish-hid/ishtp-hid-client.c | 15 +++++++++- drivers/hid/intel-ish-hid/ishtp-hid.h | 1 + drivers/hid/intel-ish-hid/ishtp/bus.c | 29 +++++++++++++++----- include/linux/intel-ish-client-if.h | 2 ++ 4 files changed, 39 insertions(+), 8 deletions(-)
drivers/hid/intel-ish-hid/ishtp-hid-client.c +14 -1
@@ -779,6 +779,17 @@ static void hid_ishtp_cl_reset_handler(struct work_struct *work) } } +static void hid_ishtp_cl_resume_handler (struct work_struct *work) +{ + struct ishtp_cl_data *client_data = container_of(work, struct ishtp_cl_data, resume_work); +struct ishtp_cl *hid_ishtp_cl = client_data->hid_ishtp_cl; + +if (ishtp_wait_resume (ishtp_get_ishtp_device (hid_ishtp_cl))) { + client_data->suspended = false; +wake_up_interruptible (&client_data->ishtp_resume_wait); + } +} +void (*hid_print_trace)(void *unused,const char *format, ...);/**
@@ -817,6 +828,8 @@ static int hid_ishtp_cl_probe(struct ishtp_cl_device *cl_device)init_waitqueue_head (&client_data->ishtp_resume_wait);INIT_WORK (&client_data->work, hid_ishtp_cl_reset_handler); +INIT_WORK (&client_data->resume_work, hid_ishtp_cl_resume_handler); + hid_print_trace =ishtp_trace_callback (cl_device);
@@ -918,7 +931,7 @@ static int hid_ishtp_cl_resume(struct device *device)hid_ishtp_trace (client_data,"%s hid_ishtp_cl %p\n" , __func__, hid_ishtp_cl); - client_data->suspended = false; +schedule_work (&client_data->resume_work);return 0 ; }
drivers/hid/intel-ish-hid/ishtp-hid.h +1 -0
@@ -140,6 +140,7 @@ struct ishtp_cl_data {int multi_packet_cnt;struct work_struct work; +struct work_struct resume_work;struct ishtp_cl_device *cl_device; };
drivers/hid/intel-ish-hid/ishtp/bus.c +22 -7
@@ -329,13 +329,6 @@ static int ishtp_cl_device_resume(struct device *dev)if (!device)return 0 ; -/* -* When ISH needs hard reset, it is done asynchrnously, hence bus -* resume will be called before full ISH resume -*/ -if (device->ishtp_dev->resume_flag) -return 0 ; - driver =to_ishtp_cl_driver (dev->driver);if (driver && driver->driver.pm) {if (driver->driver.pm->resume)
@@ -863,6 +856,28 @@ struct device *ishtp_device(struct ishtp_cl_device *device) }EXPORT_SYMBOL (ishtp_device); +/** +* ishtp_wait_resume() - Wait for IPC resume +* +* Wait for IPC resume +* +* Return: resume complete or not +*/ +bool ishtp_wait_resume (struct ishtp_device *dev) +{ +/* 50ms to get resume response */ +#define WAIT_FOR_RESUME_ACK_MS 50 + +/* Waiting to get resume response */ +if (dev->resume_flag) +wait_event_interruptible_timeout (dev->resume_wait, + !dev->resume_flag, +msecs_to_jiffies (WAIT_FOR_RESUME_ACK_MS )); + +return (!dev->resume_flag); +} +EXPORT_SYMBOL_GPL (ishtp_wait_resume); +/** * ishtp_get_pci_device() - Return PCI device dev pointer * This interface is used to return PCI device pointer
include/linux/intel-ish-client-if.h +2 -0
@@ -76,6 +76,8 @@ int ishtp_register_event_cb(struct ishtp_cl_device *device,/* Get the device * from ishtp device instance */ struct device *ishtp_device (struct ishtp_cl_device *cl_device); +/* wait for IPC resume */ +bool ishtp_wait_resume (struct ishtp_device *dev);/* Trace interface for clients */ void *ishtp_trace_callback (struct ishtp_cl_device *cl_device);/* Get device pointer of PCI device for DMA acces */
base-commit: f5711311bfa1abcc64c6dd1e912666a8c0b29a1a
Signature · 1 line
2.17.1
Quoted 18 lines · Ye Xiang
ISH IPC driver uses asynchronous workqueue to do resume now, but there is
a potential timing issue: when child devices resume before bus driver, it
will cause child devices resume failed and cannot be recovered until reboot. The current implementation in this case do wait for IPC to resume
but fail to accommodate for a case when there is no ISH reboot and soft
resume is taking time. This issue is apparent on Tiger Lake platform with
5.11.13 kernel when doing suspend to idle then resume(s0ix) test. To resolve this issue, we change ISHTP HID client to use asynchronous resume
callback too. In the asynchronous resume callback, it waits for the ISHTP
resume done event, and then notify ISHTP HID client link ready.
Quoted 1 line
Signed-off-by Ye Xiang <[email protected]>
Quoted 136 lines
--- drivers/hid/intel-ish-hid/ishtp-hid-client.c | 15 +++++++++- drivers/hid/intel-ish-hid/ishtp-hid.h | 1 + drivers/hid/intel-ish-hid/ishtp/bus.c | 29 +++++++++++++++--- -- include/linux/intel-ish-client-if.h | 2 ++ 4 files changed, 39 insertions(+), 8 deletions(-)drivers/hid/intel-ish-hid/ishtp-hid-client.c +11
-0@@ -779,6 +779,17 @@ static void hid_ishtp_cl_reset_handler(struct work_struct *work) } } +static void hid_ishtp_cl_resume_handler (struct work_struct *work) +{ + struct ishtp_cl_data *client_data = container_of(work, struct ishtp_cl_data, resume_work); +struct ishtp_cl *hid_ishtp_cl = client_data->hid_ishtp_cl; + +if (ishtp_wait_resume (ishtp_get_ishtp_device (hid_ishtp_cl))) { + client_data->suspended = false; +wake_up_interruptible (&client_data->ishtp_resume_wait); + } +} +void (*hid_print_trace)(void *unused,const char *format, ...);/**
drivers/hid/intel-ish-hid/ishtp-hid-client.c +2
-0@@ -817,6 +828,8 @@ static int hid_ishtp_cl_probe(struct ishtp_cl_device *cl_device) init_waitqueue_head(&client_data->ishtp_resume_wait);INIT_WORK (&client_data->work, hid_ishtp_cl_reset_handler); +INIT_WORK (&client_data->resume_work, hid_ishtp_cl_resume_handler); +drivers/hid/intel-ish-hid/ishtp-hid-client.c +1
-1hid_print_trace =ishtp_trace_callback (cl_device);@@ -918,7 +931,7 @@ static int hid_ishtp_cl_resume(struct device *device)hid_ishtp_trace (client_data,"%s hid_ishtp_cl %p\n" , __func__, hid_ishtp_cl); - client_data->suspended = false; +schedule_work (&client_data->resume_work);return 0 ; }drivers/hid/intel-ish-hid/ishtp-hid.h +1
-0@@ -140,6 +140,7 @@ struct ishtp_cl_data {int multi_packet_cnt;struct work_struct work; +struct work_struct resume_work;struct ishtp_cl_device *cl_device; };drivers/hid/intel-ish-hid/ishtp/bus.c +0
-2@@ -329,13 +329,6 @@ static int ishtp_cl_device_resume(struct device *dev)if (!device)return 0 ; -/* -* When ISH needs hard reset, it is done asynchrnously, hence bus
drivers/hid/intel-ish-hid/ishtp/bus.c +22
-5-* resume will be called before full ISH resume -*/ -if (device->ishtp_dev->resume_flag) -return 0 ; - driver =to_ishtp_cl_driver (dev->driver);if (driver && driver->driver.pm) {if (driver->driver.pm->resume)@@ -863,6 +856,28 @@ struct device *ishtp_device(struct ishtp_cl_device *device) }EXPORT_SYMBOL (ishtp_device); +/** +* ishtp_wait_resume() - Wait for IPC resume +* +* Wait for IPC resume +* +* Return: resume complete or not +*/ +bool ishtp_wait_resume (struct ishtp_device *dev) +{ +/* 50ms to get resume response */ +#define WAIT_FOR_RESUME_ACK_MS 50 + +/* Waiting to get resume response */ +if (dev->resume_flag) +wait_event_interruptible_timeout (dev->resume_wait, + !dev->resume_flag, + msecs_to_jiffies(WAIT_FOR_RESUME_ACK_MS )); + +return (!dev->resume_flag); +} +EXPORT_SYMBOL_GPL (ishtp_wait_resume); +/** *
ishtp_get_pci_device()- Return PCI device dev pointer
* This interface is used to return PCI device pointerinclude/linux/intel-ish-client-if.h +2
-0@@ -76,6 +76,8 @@ int ishtp_register_event_cb(struct ishtp_cl_device *device,/* Get the device * from ishtp device instance */ struct device *ishtp_device(struct ishtp_cl_device *cl_device); +/* wait for IPC resume */ +bool ishtp_wait_resume (struct ishtp_device *dev);/* Trace interface for clients */ void *ishtp_trace_callback (struct ishtp_cl_device *cl_device);/* Get device pointer of PCI device for DMA acces */
base-commit:
f5711311bfa1abcc64c6dd1e912666a8c0b29a1a
Jiri Kosina
maintainerQuoted 11 lines · Ye Xiang
ISH IPC driver uses asynchronous workqueue to do resume now, but there is a potential timing issue: when child devices resume before bus driver, it will cause child devices resume failed and cannot be recovered until reboot. The current implementation in this case do wait for IPC to resume but fail to accommodate for a case when there is no ISH reboot and soft resume is taking time. This issue is apparent on Tiger Lake platform with 5.11.13 kernel when doing suspend to idle then resume(s0ix) test. To resolve this issue, we change ISHTP HID client to use asynchronous resume callback too. In the asynchronous resume callback, it waits for the ISHTP resume done event, and then notify ISHTP HID client link ready.
Quoted 1 line
Signed-off-by Ye Xiang <[email protected]>
Srinivas, can I please get your Ack for this one?
Thanks,
Signature · 2 lines
Jiri Kosina SUSE Labs
srinivas pandruvada
maintainerQuoted 22 lines · Jiri Kosina
Quoted 20 lines · Ye Xiang
ISH IPC driver uses asynchronous workqueue to do resume now, but there is
a potential timing issue: when child devices resume before bus driver, it
will cause child devices resume failed and cannot be recovered until
reboot. The current implementation in this case do wait for IPC to resume
but fail to accommodate for a case when there is no ISH reboot and soft
resume is taking time. This issue is apparent on Tiger Lake platform with
5.11.13 kernel when doing suspend to idle then resume(s0ix) test. To
resolve this issue, we change ISHTP HID client to use asynchronous resume
callback too. In the asynchronous resume callback, it waits for the ISHTP
resume done event, and then notify ISHTP HID client link ready.
Quoted 3 lines
Quoted 1 line
Signed-off-by Ye Xiang <[email protected]>Srinivas, can I please get your Ack for this one?
Done.
Thanks,
Srinivas
Quoted 3 lines
Thanks,
Quoted 17 lines · Ye Xiang
ISH IPC driver uses asynchronous workqueue to do resume now, but there is
a potential timing issue: when child devices resume before bus driver, it
will cause child devices resume failed and cannot be recovered until reboot. The current implementation in this case do wait for IPC to resume
but fail to accommodate for a case when there is no ISH reboot and soft resume is taking time. This issue is apparent on Tiger Lake platform with
5.11.13 kernel when doing suspend to idle then resume(s0ix) test. To resolve this issue, we change ISHTP HID client to use asynchronous resume
callback too. In the asynchronous resume callback, it waits for the ISHTP
resume done event, and then notify ISHTP HID client link ready.
Quoted 1 line
Signed-off-by Ye Xiang <[email protected]>
Quoted 135 lines
---
drivers/hid/intel-ish-hid/ishtp-hid-client.c | 15 +++++++++- drivers/hid/intel-ish-hid/ishtp-hid.h | 1 + drivers/hid/intel-ish-hid/ishtp/bus.c | 29 +++++++++++++++----- include/linux/intel-ish-client-if.h | 2 ++4 files changed, 39 insertions(+), 8 deletions(-)drivers/hid/intel-ish-hid/ishtp-hid-client.c +0
-0@@ -779,6 +779,17 @@ static void hid_ishtp_cl_reset_handler(struct work_struct *work) } }drivers/hid/intel-ish-hid/ishtp-hid-client.c +3
-0+static void hid_ishtp_cl_resume_handler (struct work_struct *work) +{ + struct ishtp_cl_data *client_data = container_of(work, struct
ishtp_cl_data,resume_work);
+ structishtp_cl*hid_ishtp_cl=client_data->hid_ishtp_cl;drivers/hid/intel-ish-hid/ishtp-hid-client.c +7
-0+ + if (ishtp_wait_resume(ishtp_get_ishtp_device(hid_ishtp_cl))) { + client_data->suspended = false; + wake_up_interruptible(&client_data->ishtp_resume_wait); + } +} +void (*hid_print_trace)(void *unused, const char *format, ...);
/**drivers/hid/intel-ish-hid/ishtp-hid-client.c +0
-0@@ -817,6 +828,8 @@ static int hid_ishtp_cl_probe(struct ishtp_cl_device *cl_device) init_waitqueue_head(&client_data->ishtp_resume_wait);
INIT_WORK(&client_data->work,hid_ishtp_cl_reset_handler); + INIT_WORK(&client_data->resume_work,hid_ishtp_cl_resume_handler);
+
hid_print_trace =ishtp_trace_callback(cl_device);drivers/hid/intel-ish-hid/ishtp-hid-client.c +0
-0@@ -918,7 +931,7 @@ static int hid_ishtp_cl_resume(struct device *device)
hid_ishtp_trace(client_data, "%shid_ishtp_cl%p\n",__func__,hid_ishtp_cl);
- client_data->suspended = false;
+ schedule_work(&client_data->resume_work);
return 0;
}drivers/hid/intel- renamed from drivers/hid/intel-ish-hid/ishtp-hid.h +0
-0
ish-hid/ishtp-hid.h
index5ffd0da3cf1f..e5fa753fe92f100644drivers/hid/intel-ish-hid/ishtp-hid.h +0
-0@@ -140,6 +140,7 @@ struct ishtp_cl_data { int multi_packet_cnt;
structwork_structwork;
+ structwork_structresume_work;
structishtp_cl_device*cl_device;
};drivers/hid/intel- renamed from drivers/hid/intel-ish-hid/ishtp/bus.c +0
-0
ish-hid/ishtp/bus.c
index0d6465f0eaa8..ead6c8f32759100644drivers/hid/intel-ish-hid/ishtp/bus.c +0
-0@@ -329,13 +329,6 @@ static int ishtp_cl_device_resume(struct device *dev) if (!device) return 0;
- /*
- * When ISH needs hard reset, it is done asynchrnously, hence bus
- * resume will be called before full ISH resume
- */
- if (device->ishtp_dev->resume_flag)
- return 0;
-
driver =to_ishtp_cl_driver(dev->driver);
if (driver &&driver->driver.pm) {
if (driver->driver.pm->resume)drivers/hid/intel-ish-hid/ishtp/bus.c +0
-0@@ -863,6 +856,28 @@ struct device *ishtp_device(struct ishtp_cl_device *device) } EXPORT_SYMBOL(ishtp_device);drivers/hid/intel-ish-hid/ishtp/bus.c +17
-0+/** +* ishtp_wait_resume() - Wait for IPC resume +* +* Wait for IPC resume +* +* Return: resume complete or not +*/ +bool ishtp_wait_resume (struct ishtp_device *dev) +{ + /* 50ms to get resume response */ + #define WAIT_FOR_RESUME_ACK_MS 50 + + /* Waiting to get resume response */ + if (dev->resume_flag) + wait_event_interruptible_timeout(dev->resume_wait, + !dev->resume_flag, +
msecs_to_jiffies(WAIT_FOR_RESUME_ACK_MS));drivers/hid/intel-ish-hid/ishtp/bus.c +5
-0+ + return (!dev->resume_flag); +} +EXPORT_SYMBOL_GPL (ishtp_wait_resume); +/**
*ishtp_get_pci_device()- Return PCI device dev pointer
* This interface is used to return PCI device pointerinclude/linux/intel- renamed from include/linux/intel-ish-client-if.h +0
-0
ish-client-if.h
index1153e0030133..ec3a6ccbece4100644include/linux/intel-ish-client-if.h +0
-0@@ -76,6 +76,8 @@ int ishtp_register_event_cb(struct ishtp_cl_device *device,
/* Get the device * from ishtp device instance */ struct device *ishtp_device(structishtp_cl_device*cl_device);include/linux/intel-ish-client-if.h +2
-0+/* wait for IPC resume */ +bool ishtp_wait_resume (struct ishtp_device *dev);/* Trace interface for clients */
void *ishtp_trace_callback(structishtp_cl_device*cl_device); /* Get device pointer of PCI device for DMA acces */base-commit:
f5711311bfa1abcc64c6dd1e912666a8c0b29a1a
Quoted 11 lines · Ye Xiang
ISH IPC driver uses asynchronous workqueue to do resume now, but there is a potential timing issue: when child devices resume before bus driver, it will cause child devices resume failed and cannot be recovered until reboot. The current implementation in this case do wait for IPC to resume but fail to accommodate for a case when there is no ISH reboot and soft resume is taking time. This issue is apparent on Tiger Lake platform with 5.11.13 kernel when doing suspend to idle then resume(s0ix) test. To resolve this issue, we change ISHTP HID client to use asynchronous resume callback too. In the asynchronous resume callback, it waits for the ISHTP resume done event, and then notify ISHTP HID client link ready.
Quoted 1 line
Signed-off-by Ye Xiang <[email protected]>
Applied, thank you.
Signature · 2 lines
Jiri Kosina SUSE Labs