Skip to contentSkip to conversation

i2c: sprd: use a specific timeout to avoid system hang up issue

PATCH In review Chunyan Zhang 2 participants 3 messages Dec 14, 2020 – Jan 5, 2021

Subsystems (2)
lore
Share & tools
lore

Chunyan Zhang

author reviewer
#0 lore raw

PATCH v2 1/1 i2c: sprd: use a specific timeout to avoid system hang up issue

From: Chunyan Zhang <[email protected]>

If the i2c device SCL bus being pulled up due to some exception before message transfer done, the system cannot receive the completing interrupt signal any more, it would not exit waiting loop until MAX_SCHEDULE_TIMEOUT jiffies eclipse, that would make the system seemed hang up. To avoid that happen, this patch adds a specific timeout for message transfer.

Fixes 8b9ec0719834 ("i2c: Add Spreadtrum I2C controller driver")

---
* Changes since v1:
- Addressed Wolfram's comments for code;
- Changed to use Signed-off-by instead of Original-by;
- Fixed a compile error.

---
 drivers/i2c/busses/i2c-sprd.c | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)
drivers/i2c/busses/i2c-sprd.c +7 -1
index 19cda6742423..b9f58a4b2281 100644
@@ -72,6 +72,8 @@
 
 /* timeout (ms) for pm runtime autosuspend */
 #define SPRD_I2C_PM_TIMEOUT	1000
+/* timeout (ms) for transfer message */
+#define I2C_XFER_TIMEOUT	1000
 
 /* SPRD i2c data structure */
 struct sprd_i2c {
@@ -244,6 +246,7 @@ static int sprd_i2c_handle_msg(struct i2c_adapter *i2c_adap,
 			       struct i2c_msg *msg, bool is_last_msg)
 {
 	struct sprd_i2c *i2c_dev = i2c_adap->algo_data;
+	unsigned long time_left;
 
 	i2c_dev->msg = msg;
 	i2c_dev->buf = msg->buf;
@@ -273,7 +276,10 @@ static int sprd_i2c_handle_msg(struct i2c_adapter *i2c_adap,
 
 	sprd_i2c_opt_start(i2c_dev);
 
-	wait_for_completion(&i2c_dev->complete);
+	time_left = wait_for_completion_timeout(&i2c_dev->complete,
+				msecs_to_jiffies(I2C_XFER_TIMEOUT));
+	if (!time_left)
+		return -EIO;
 
 	return i2c_dev->err;
 }
Signature · 1 line
2.25.1
#1 lore raw
Quoted 11 lines · Chunyan Zhang

From: Chunyan Zhang <[email protected]>

If the i2c device SCL bus being pulled up due to some exception before message transfer done, the system cannot receive the completing interrupt signal any more, it would not exit waiting loop until MAX_SCHEDULE_TIMEOUT jiffies eclipse, that would make the system seemed hang up. To avoid that happen, this patch adds a specific timeout for message transfer.

Fixes 8b9ec0719834 ("i2c: Add Spreadtrum I2C controller driver")

Took the liberty to change the errno to ETIMEDOUT and applied to for-current, thanks!

author reviewer
#2 lore raw
Quoted 10 lines · Wolfram Sang
Quoted 8 lines · Chunyan Zhang

From: Chunyan Zhang <[email protected]>

If the i2c device SCL bus being pulled up due to some exception before message transfer done, the system cannot receive the completing interrupt signal any more, it would not exit waiting loop until MAX_SCHEDULE_TIMEOUT jiffies eclipse, that would make the system seemed hang up. To avoid that happen, this patch adds a specific timeout for message transfer.

Quoted 6 lines
Quoted 3 lines
Fixes 8b9ec0719834 ("i2c: Add Spreadtrum I2C controller driver")

Took the liberty to change the errno to ETIMEDOUT and applied to for-current, thanks!

Thanks!

Chunyan

Quoted 1 line