Skip to contentSkip to conversation

tpm: ibmvtpm: retry on H_CLOSED in tpm_ibmvtpm_send()

PATCH Superseded George Wilson 3 participants 4 messages Mar 17, 2020 – Mar 19, 2020

Subsystems (3)

v2 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 tpm: ibmvtpm: retry on H_CLOSED in tpm_ibmvtpm_send()

tpm_ibmvtpm_send() can fail during PowerVM Live Partition Mobility resume with an H_CLOSED return from ibmvtpm_send_crq(). The PAPR says, 'The “partner partition suspended” transport event disables the associated CRQ such that any H_SEND_CRQ hcall() to the associated CRQ returns H_Closed until the CRQ has been explicitly enabled using the H_ENABLE_CRQ hcall.' This patch adds a check in tpm_ibmvtpm_send() for an H_CLOSED return from ibmvtpm_send_crq() and in that case calls tpm_ibmvtpm_resume() and retries the ibmvtpm_send_crq() once.

---
 drivers/char/tpm/tpm_ibmvtpm.c | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)
drivers/char/tpm/tpm_ibmvtpm.c +18 -5
index 78cc52690177..ba3bd503e080 100644
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-only
 /*
- * Copyright (C) 2012 IBM Corporation
+ * Copyright (C) 2012-2020 IBM Corporation
  *
  * Author: Ashley Lai <[email protected]>
  *
@@ -25,6 +25,8 @@
 #include "tpm.h"
 #include "tpm_ibmvtpm.h"
 
+static int tpm_ibmvtpm_resume(struct device *dev);
+
 static const char tpm_ibmvtpm_driver_name[] = "tpm_ibmvtpm";
 
 static const struct vio_device_id tpm_ibmvtpm_device_table[] = {
@@ -147,6 +149,7 @@ static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count)
 {
 	struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
 	int rc, sig;
+	bool retry = true;
 
 	if (!ibmvtpm->rtce_buf) {
 		dev_err(ibmvtpm->dev, "ibmvtpm device is not ready\n");
@@ -179,18 +182,28 @@ static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count)
 	 */
 	ibmvtpm->tpm_processing_cmd = true;
 
+again:
 	rc = ibmvtpm_send_crq(ibmvtpm->vdev,
 			IBMVTPM_VALID_CMD, VTPM_TPM_COMMAND,
 			count, ibmvtpm->rtce_dma_handle);
+
 	if (rc != H_SUCCESS) {
+		/*
+		 * H_CLOSED can be returned after LPM resume.  Call
+		 * tpm_ibmvtpm_resume() to re-enable the CRQ then retry
+		 * ibmvtpm_send_crq() once before failing.
+		 */
+		if (rc == H_CLOSED && retry) {
+			tpm_ibmvtpm_resume(ibmvtpm->dev);
+			retry = false;
+			goto again;
+		}
 		dev_err(ibmvtpm->dev, "tpm_ibmvtpm_send failed rc=%d\n", rc);
-		rc = 0;
 		ibmvtpm->tpm_processing_cmd = false;
-	} else
-		rc = 0;
+	}
 
 	spin_unlock(&ibmvtpm->rtce_lock);
-	return rc;
+	return 0;
 }
 
 static void tpm_ibmvtpm_cancel(struct tpm_chip *chip)
Signature · 1 line
2.24.1
#1 lore raw
Quoted 9 lines · George Wilson

tpm_ibmvtpm_send() can fail during PowerVM Live Partition Mobility resume with an H_CLOSED return from ibmvtpm_send_crq(). The PAPR says, 'The “partner partition suspended” transport event disables the associated CRQ such that any H_SEND_CRQ hcall() to the associated CRQ returns H_Closed until the CRQ has been explicitly enabled using the H_ENABLE_CRQ hcall.' This patch adds a check in tpm_ibmvtpm_send() for an H_CLOSED return from ibmvtpm_send_crq() and in that case calls tpm_ibmvtpm_resume() and retries the ibmvtpm_send_crq() once.

Quoted 4 lines

I think this should have a fixes tag.

Quoted 17 lines
---
 drivers/char/tpm/tpm_ibmvtpm.c | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)
drivers/char/tpm/tpm_ibmvtpm.c +1 -1
index 78cc52690177..ba3bd503e080 100644
@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-2.0-only
 /*
- * Copyright (C) 2012 IBM Corporation
+ * Copyright (C) 2012-2020 IBM Corporation
  *
  * Author: Ashley Lai <[email protected]>
  *

drivers/char/tpm/tpm_ibmvtpm.c line 29

Quoted 5 lines
drivers/char/tpm/tpm_ibmvtpm.c +2 -0
@@ -25,6 +25,8 @@
 #include "tpm.h"
 #include "tpm_ibmvtpm.h"
 
+static int tpm_ibmvtpm_resume(struct device *dev);
+

Instead, reposition this function before tpm_ibmvtpm_send().

drivers/char/tpm/tpm_ibmvtpm.c static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count) · line 152

Quoted 8 lines
drivers/char/tpm/tpm_ibmvtpm.c +1 -0
 static const char tpm_ibmvtpm_driver_name[] = "tpm_ibmvtpm";
 
 static const struct vio_device_id tpm_ibmvtpm_device_table[] = {
@@ -147,6 +149,7 @@ static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count)
 {
 	struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
 	int rc, sig;
+	bool retry = true;

Cosmetic: would be nice to have inits when possible in reverse Christmas tree order i.e.

	struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
	bool retry = true;
	int rc, sig;

It is way more pleasing for the eye when you have to read the source code.

drivers/char/tpm/tpm_ibmvtpm.c static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count) · line 189

Quoted 11 lines
drivers/char/tpm/tpm_ibmvtpm.c +2 -0
 	if (!ibmvtpm->rtce_buf) {
 		dev_err(ibmvtpm->dev, "ibmvtpm device is not ready\n");
@@ -179,18 +182,28 @@ static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count)
 	 */
 	ibmvtpm->tpm_processing_cmd = true;
 
+again:
 	rc = ibmvtpm_send_crq(ibmvtpm->vdev,
 			IBMVTPM_VALID_CMD, VTPM_TPM_COMMAND,
 			count, ibmvtpm->rtce_dma_handle);
+

A dangling newline character.

Quoted 27 lines
drivers/char/tpm/tpm_ibmvtpm.c +12 -4
 	if (rc != H_SUCCESS) {
+		/*
+		 * H_CLOSED can be returned after LPM resume.  Call
+		 * tpm_ibmvtpm_resume() to re-enable the CRQ then retry
+		 * ibmvtpm_send_crq() once before failing.
+		 */
+		if (rc == H_CLOSED && retry) {
+			tpm_ibmvtpm_resume(ibmvtpm->dev);
+			retry = false;
+			goto again;
+		}
 		dev_err(ibmvtpm->dev, "tpm_ibmvtpm_send failed rc=%d\n", rc);
-		rc = 0;
 		ibmvtpm->tpm_processing_cmd = false;
-	} else
-		rc = 0;
+	}
 
 	spin_unlock(&ibmvtpm->rtce_lock);
-	return rc;
+	return 0;
 }
 
 static void tpm_ibmvtpm_cancel(struct tpm_chip *chip)
Signature · 1 line
2.24.1

/Jarkko

#2 lore raw
Quoted 12 lines · Jarkko Sakkinen

drivers/char/tpm/tpm_ibmvtpm.c static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count) · line 152

Quoted 8 lines

static const char tpm_ibmvtpm_driver_name[] = "tpm_ibmvtpm";

static const struct vio_device_id tpm_ibmvtpm_device_table[] = {

drivers/char/tpm/tpm_ibmvtpm.c +1 -0
@@ -147,6 +149,7 @@ static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count)
 {
 	struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
 	int rc, sig;
+	bool retry = true;

Cosmetic: would be nice to have inits when possible in reverse Christmas tree order i.e.

Quoted 6 lines
	struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
	bool retry = true;
	int rc, sig;

It is way more pleasing for the eye when you have to read the source code.

I thought only netdev insisted on that :O

Jason

#3 lore raw
Quoted 13 lines · Jason Gunthorpe
Quoted 12 lines · Jarkko Sakkinen

drivers/char/tpm/tpm_ibmvtpm.c static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count) · line 152

Quoted 8 lines

static const char tpm_ibmvtpm_driver_name[] = "tpm_ibmvtpm";

static const struct vio_device_id tpm_ibmvtpm_device_table[] = {

drivers/char/tpm/tpm_ibmvtpm.c +1 -0
@@ -147,6 +149,7 @@ static int tpm_ibmvtpm_send(struct tpm_chip *chip, u8 *buf, size_t count)
 {
 	struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
 	int rc, sig;
+	bool retry = true;

Cosmetic: would be nice to have inits when possible in reverse Christmas tree order i.e.

Quoted 8 lines
Quoted 6 lines
	struct ibmvtpm_dev *ibmvtpm = dev_get_drvdata(&chip->dev);
	bool retry = true;
	int rc, sig;

It is way more pleasing for the eye when you have to read the source code.

I thought only netdev insisted on that :O

x86 seems to prefer too and I agree with the idea. But as I said only that it would be nice.

/Jarkko