Skip to contentSkip to conversation

cxl/mbox: Robustify handling of mbox_cmd.return_code

PATCH In review Davidlohr Bueso 2 participants 6 messages Apr 4, 2022 CXL

lore
Share & tools
lore

Davidlohr Bueso

author maintainer
#0 lore raw

v2 cover cxl/mbox: Robustify handling of mbox_cmd.return_code

Hi,

Changes from v1 (https://lore.kernel.org/all/[email protected]/):
- Patch 1 now just removes the lock comment, instead of moving it. (Dan)
- Modified pach 3 to use CPP hackery + misc table improvements. (Dan and Adam)
- Dropped patch 5 per concerns about implications with FW. (Dan)
- Picked up Adam's review tags.

Currently the return_code from a completed mbox command is handled as either successful or not. This series teaches the driver to better deal with the different returns from the hardware, allowing better debugging and mapping to proper kernel errno semantics (which are left unchanged for now) as well as more ad-hoc handling.

Applies against linux-cxl's next branch.

Patches 1 and 2 are small nits.
Patch 3 and 4 implement and use the new calls.

Thanks!

Davidlohr Bueso (4):
cxl/mbox: Drop mbox_mutex comment
cxl/pci: Use CXL_MBOX_SUCCESS to check against mbox_cmd return code cxl/mbox: Improve handling of mbox_cmd hw return codes cxl/mbox: Use new return_code handling

 drivers/cxl/core/mbox.c |  7 +++---
 drivers/cxl/cxlmem.h    | 53 ++++++++++++++++++++++++++++++++++++++++-
 drivers/cxl/pci.c       |  7 +++---
 3 files changed, 59 insertions(+), 8 deletions(-)

--
2.26.2

author maintainer
#1 lore raw

PATCH v2 1/4 cxl/mbox: Drop mbox_mutex comment

... we have lockdep for this.

Reviewed by: Adam Manzanares <[email protected]>

---
 drivers/cxl/core/mbox.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/cxl/core/mbox.c +1 -1
index be61a0d8016b..a586c0fa9555 100644
@@ -136,7 +136,7 @@ static struct cxl_mem_command *cxl_mem_find_command(u16 opcode)
  * @out: Caller allocated buffer for the output.
  * @out_size: Expected size of output.
  *
- * Context: Any context. Will acquire and release mbox_mutex.
+ * Context: Any context.
  * Return:
  *  * %>=0	- Number of bytes returned in @out.
  *  * %-E2BIG	- Payload is too large for hardware.
Signature · 1 line
2.26.2
author maintainer
#2 lore raw

PATCH v2 2/4 cxl/pci: Use CXL_MBOX_SUCCESS to check against mbox_cmd return code

In reply to Davidlohr Bueso

Also mention the need for the caller to check against any errors from the hardware in return_code.

Reviewed by: Adam Manzanares <[email protected]>

---
 drivers/cxl/pci.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/cxl/pci.c +2 -2
index 8a7267d116b7..8b131692ed61 100644
@@ -177,9 +177,9 @@ static int __cxl_pci_mbox_send_cmd(struct cxl_dev_state *cxlds,
 	mbox_cmd->return_code =
 		FIELD_GET(CXLDEV_MBOX_STATUS_RET_CODE_MASK, status_reg);
 
-	if (mbox_cmd->return_code != 0) {
+	if (mbox_cmd->return_code != CXL_MBOX_SUCCESS) {
 		dev_dbg(dev, "Mailbox operation had an error\n");
-		return 0;
+		return 0; /* completed but caller must check return_code */
 	}
 
 	/* #7 */
Signature · 1 line
2.26.2
author maintainer
#3 lore raw

PATCH v2 3/4 cxl/mbox: Improve handling of mbox_cmd hw return codes

In reply to Davidlohr Bueso

Upon a completed command the caller is still expected to check the actual return_code register to ensure it succeed. This adds, per the spec, the potential command return codes. It maps the hardware return code with the kernel's errno style, and by default continues to use -ENXIO (Command completed, but device reported an error).

Reviewed by: Adam Manzanares <[email protected]>

---
 drivers/cxl/core/mbox.c |  2 +-
 drivers/cxl/cxlmem.h    | 53 ++++++++++++++++++++++++++++++++++++++++-
 drivers/cxl/pci.c       |  2 +-
 3 files changed, 54 insertions(+), 3 deletions(-)
drivers/cxl/core/mbox.c +1 -1
index a586c0fa9555..353b3f97c7e6 100644
@@ -170,7 +170,7 @@ int cxl_mbox_send_cmd(struct cxl_dev_state *cxlds, u16 opcode, void *in,
 		return rc;
 
 	/* TODO: Map return code to proper kernel style errno */
-	if (mbox_cmd.return_code != CXL_MBOX_SUCCESS)
+	if (mbox_cmd.return_code != CXL_MBOX_CMD_RC_SUCCESS)
 		return -ENXIO;
 
 	/*
drivers/cxl/cxlmem.h +52 -1

61 lines not on this page · raw message

drivers/cxl/pci.c +1 -1
index 8b131692ed61..4fbef05e9082 100644
@@ -177,7 +177,7 @@ static int __cxl_pci_mbox_send_cmd(struct cxl_dev_state *cxlds,
 	mbox_cmd->return_code =
 		FIELD_GET(CXLDEV_MBOX_STATUS_RET_CODE_MASK, status_reg);
 
-	if (mbox_cmd->return_code != CXL_MBOX_SUCCESS) {
+	if (mbox_cmd->return_code != CXL_MBOX_CMD_RC_SUCCESS) {
 		dev_dbg(dev, "Mailbox operation had an error\n");
 		return 0; /* completed but caller must check return_code */
 	}
Signature · 1 line
2.26.2
author maintainer
#4 lore raw

PATCH v2 4/4 cxl/mbox: Use new return_code handling

In reply to Davidlohr Bueso

Use the global cxl_mbox_cmd_rc table to improve debug messaging in __cxl_pci_mbox_send_cmd() and allow cxl_mbox_send_cmd() to map to proper kernel style errno codes - this patch continues to use -ENXIO only so no change in semantics.

Reviewed by: Adam Manzanares <[email protected]>

---
 drivers/cxl/core/mbox.c | 3 +--
 drivers/cxl/pci.c       | 3 ++-
 2 files changed, 3 insertions(+), 3 deletions(-)
drivers/cxl/core/mbox.c +1 -2
index 353b3f97c7e6..d7286c256e1c 100644
@@ -169,9 +169,8 @@ int cxl_mbox_send_cmd(struct cxl_dev_state *cxlds, u16 opcode, void *in,
 	if (rc)
 		return rc;
 
-	/* TODO: Map return code to proper kernel style errno */
 	if (mbox_cmd.return_code != CXL_MBOX_CMD_RC_SUCCESS)
-		return -ENXIO;
+		return cxl_mbox_cmd_rc2errno(&mbox_cmd);
 
 	/*
 	 * Variable sized commands can't be validated and so it's up to the
drivers/cxl/pci.c +2 -1
index 4fbef05e9082..18d31fafc856 100644
@@ -178,7 +178,8 @@ static int __cxl_pci_mbox_send_cmd(struct cxl_dev_state *cxlds,
 		FIELD_GET(CXLDEV_MBOX_STATUS_RET_CODE_MASK, status_reg);
 
 	if (mbox_cmd->return_code != CXL_MBOX_CMD_RC_SUCCESS) {
-		dev_dbg(dev, "Mailbox operation had an error\n");
+		dev_dbg(dev, "Mailbox operation had an error: %s\n",
+			cxl_mbox_cmd_rc2str(mbox_cmd));
 		return 0; /* completed but caller must check return_code */
 	}
 
Signature · 1 line
2.26.2
#5 lore raw
In reply to Davidlohr Bueso
Quoted 15 lines · Davidlohr Bueso

Hi,

Changes from v1 (https://lore.kernel.org/all/[email protected]/):
- Patch 1 now just removes the lock comment, instead of moving it. (Dan)
- Modified pach 3 to use CPP hackery + misc table improvements. (Dan and Adam)
- Dropped patch 5 per concerns about implications with FW. (Dan)
- Picked up Adam's review tags.

Currently the return_code from a completed mbox command is handled as either successful or not. This series teaches the driver to better deal with the different returns from the hardware, allowing better debugging and mapping to proper kernel errno semantics (which are left unchanged for now) as well as more ad-hoc handling.

Quoted 6 lines

Applies against linux-cxl's next branch.

Patches 1 and 2 are small nits.
Patch 3 and 4 implement and use the new calls.

Thanks!

Looks good to me, applied to cxl/pending for 5.19