Skip to contentSkip to conversation

ufs: core: Optimize the UIC command implementation

PATCH Superseded Bart Van Assche 2 participants 11 messages Apr 17 – Apr 23

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Bart Van Assche

author reviewer
#0 lore raw

cover ufs: core: Optimize the UIC command implementation

Hi Martin,

This patch series reduces the number of readl() calls while processing UIC commands. Please consider this patch series for the next merge window.

Thanks,

Bart.

Bart Van Assche (3):
ufs: core: Inline two functions related to UIC commands
ufs: core: Complain if UIC argument 2 is invalid
ufs: core: Optimize ufshcd_add_uic_command_trace()

 drivers/ufs/core/ufshcd.c | 49 +++++++--------------------------------
 1 file changed, 9 insertions(+), 40 deletions(-)
author reviewer
#1 lore raw

PATCH 1/3 ufs: core: Inline two functions related to UIC commands

The implementation of the two functions ufshcd_get_uic_cmd_result() and ufshcd_get_dme_attr_val() is very short. Additionally, both functions only have one caller. Hence, inline both functions.

---
 drivers/ufs/core/ufshcd.c | 37 ++++++++-----------------------------
 1 file changed, 8 insertions(+), 29 deletions(-)
drivers/ufs/core/ufshcd.c +8 -29
index 4805e40ed4d7..7fb3921bceb2 100644
@@ -912,33 +912,6 @@ static inline int ufshcd_get_lists_status(u32 reg)
 	return !((reg & UFSHCD_STATUS_READY) == UFSHCD_STATUS_READY);
 }
 
-/**
- * ufshcd_get_uic_cmd_result - Get the UIC command result
- * @hba: Pointer to adapter instance
- *
- * This function gets the result of UIC command completion
- *
- * Return: 0 on success; non-zero value on error.
- */
-static inline int ufshcd_get_uic_cmd_result(struct ufs_hba *hba)
-{
-	return ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2) &
-	       MASK_UIC_COMMAND_RESULT;
-}
-
-/**
- * ufshcd_get_dme_attr_val - Get the value of attribute returned by UIC command
- * @hba: Pointer to adapter instance
- *
- * This function gets UIC command argument3
- *
- * Return: 0 on success; non-zero value on error.
- */
-static inline u32 ufshcd_get_dme_attr_val(struct ufs_hba *hba)
-{
-	return ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3);
-}
-
 /**
  * ufshcd_get_req_rsp - returns the TR response transaction type
  * @ucd_rsp_ptr: pointer to response UPIU
@@ -5716,8 +5689,14 @@ static irqreturn_t ufshcd_uic_cmd_compl(struct ufs_hba *hba, u32 intr_status)
 		hba->errors |= (UFSHCD_UIC_HIBERN8_MASK & intr_status);
 
 	if (intr_status & UIC_COMMAND_COMPL) {
-		cmd->argument2 |= ufshcd_get_uic_cmd_result(hba);
-		cmd->argument3 = ufshcd_get_dme_attr_val(hba);
+		/*
+		 * Store the UIC command result in the lowest byte of
+		 * cmd->argument2.
+		 */
+		cmd->argument2 |= ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2) &
+				  MASK_UIC_COMMAND_RESULT;
+		/* Store the DME attribute value in cmd->argument3. */
+		cmd->argument3 = ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3);
 		if (!hba->uic_async_done)
 			cmd->cmd_active = false;
 		complete(&cmd->done);
author reviewer
#3 lore raw

PATCH 2/3 ufs: core: Complain if UIC argument 2 is invalid

In reply to Bart Van Assche

According to the UFSHCI standard, the lowest byte of UIC argument 2 is an output value. Additionally, ufshcd_uic_cmd_compl() is based on the assumption that the lowest byte of UIC argument 2 is zero. Hence, complain if the result byte is set when a UIC command is submitted.

---
 drivers/ufs/core/ufshcd.c | 1 +
 1 file changed, 1 insertion(+)
drivers/ufs/core/ufshcd.c +1 -0
index 7fb3921bceb2..0ff9d7c2a7ac 100644
@@ -2571,6 +2571,7 @@ ufshcd_dispatch_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
 	lockdep_assert_held(&hba->uic_cmd_mutex);
 
 	WARN_ON(hba->active_uic_cmd);
+	WARN_ON_ONCE(uic_cmd->argument2 & MASK_UIC_COMMAND_RESULT);
 
 	hba->active_uic_cmd = uic_cmd;
 
Reviewed-by on v1 2/3
#4 lore raw

Re: [PATCH 2/3] ufs: core: Complain if UIC argument 2 is invalid

Quoted 9 lines · Bart Van Assche

According to the UFSHCI standard, the lowest byte of UIC argument 2 is
an output value. Additionally, ufshcd_uic_cmd_compl() is based on the assumption that the lowest byte of UIC argument 2 is zero. Hence, complain
if the result byte is set when a UIC command is submitted.

---

author reviewer
#5 lore raw

PATCH 3/3 ufs: core: Optimize ufshcd_add_uic_command_trace()

In reply to Bart Van Assche

Use cached values in ufshcd_add_uic_command_trace() instead of calling readl(). In ufshcd_uic_cmd_compl(), also read the result byte for power commands since it is also set if a power command completes.

---
 drivers/ufs/core/ufshcd.c | 23 ++++++-----------------
 1 file changed, 6 insertions(+), 17 deletions(-)
drivers/ufs/core/ufshcd.c +6 -17
index 0ff9d7c2a7ac..12445e012cad 100644
@@ -460,20 +460,11 @@ static void ufshcd_add_uic_command_trace(struct ufs_hba *hba,
 					 const struct uic_command *ucmd,
 					 enum ufs_trace_str_t str_t)
 {
-	u32 cmd;
-
 	if (!trace_ufshcd_uic_command_enabled())
 		return;
 
-	if (str_t == UFS_CMD_SEND)
-		cmd = ucmd->command;
-	else
-		cmd = ufshcd_readl(hba, REG_UIC_COMMAND);
-
-	trace_ufshcd_uic_command(hba, str_t, cmd,
-				 ufshcd_readl(hba, REG_UIC_COMMAND_ARG_1),
-				 ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2),
-				 ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3));
+	trace_ufshcd_uic_command(hba, str_t, ucmd->command, ucmd->argument1,
+				 ucmd->argument2, ucmd->argument3);
 }
 
 static void ufshcd_add_command_trace(struct ufs_hba *hba, struct scsi_cmnd *cmd,
@@ -5689,13 +5680,11 @@ static irqreturn_t ufshcd_uic_cmd_compl(struct ufs_hba *hba, u32 intr_status)
 	if (ufshcd_is_auto_hibern8_error(hba, intr_status))
 		hba->errors |= (UFSHCD_UIC_HIBERN8_MASK & intr_status);
 
+	/* Store the UIC command result in the lowest byte of cmd->argument2. */
+	cmd->argument2 |= ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2) &
+		MASK_UIC_COMMAND_RESULT;
+
 	if (intr_status & UIC_COMMAND_COMPL) {
-		/*
-		 * Store the UIC command result in the lowest byte of
-		 * cmd->argument2.
-		 */
-		cmd->argument2 |= ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2) &
-				  MASK_UIC_COMMAND_RESULT;
 		/* Store the DME attribute value in cmd->argument3. */
 		cmd->argument3 = ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3);
 		if (!hba->uic_async_done)
#6 lore raw

Re: [PATCH 3/3] ufs: core: Optimize ufshcd_add_uic_command_trace()

Quoted 28 lines · Bart Van Assche
drivers/ufs/core/ufshcd.c +0 -0
index 0ff9d7c2a7ac..12445e012cad 100644
@@ -460,20 +460,11 @@ static void ufshcd_add_uic_command_trace(struct
 ufs_hba *hba,

                                         const struct uic_command *ucmd,
                                         enum ufs_trace_str_t str_t) {
-       u32 cmd;
-
        if (!trace_ufshcd_uic_command_enabled())
                return;

-       if (str_t == UFS_CMD_SEND)
-               cmd = ucmd->command;
-       else
-               cmd = ufshcd_readl(hba, REG_UIC_COMMAND); -
-       trace_ufshcd_uic_command(hba, str_t, cmd,
-                                ufshcd_readl(hba, REG_UIC_COMMAND_ARG_1),
-                                ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2),
-                                ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3));
+       trace_ufshcd_uic_command(hba, str_t, ucmd->command, ucmd-

Quoted 3 lines
Quoted 1 line

argument1,

+                                ucmd->argument2, ucmd->argument3); }

Hi Bart,

In the complete case, all these commands and arguments 1 to 3 are filled by hardware. If we do not read them from the hardware, how can we be sure of the actual values written by the hardware?

Thanks
Peter

author reviewer
#7 lore raw

Re: [PATCH 3/3] ufs: core: Optimize ufshcd_add_uic_command_trace()

Quoted 3 lines · Peter Wang (王信友)

In the complete case, all these commands and arguments 1 to 3 are filled by hardware. If we do not read them from the hardware, how can we be sure of the actual values written by the hardware?

Hi Peter,

Are we perhaps each interpreting the UFSHCI standard in a different way? My understanding is that the UFSHCI command flow is as follows:
* First, UICCMDARG1, UICCMDARG2 and UICCMDARG3 are written by the host.
* Next, UICCMD is written by the host. This causes the host controller to execute the UIC command.
* Upon completion of the command, the host controller updates the lowest byte of UICCMDARG2. UICCMDARG3 is only updated after execution of the following commands has finished: DME_GET, DME_SET, DME_PEER_GET and DME_PEER_SET.

Thanks,

Bart.

#8 lore raw

Re: [PATCH 3/3] ufs: core: Optimize ufshcd_add_uic_command_trace()

Quoted 18 lines · Bart Van Assche

Hi Peter,

Are we perhaps each interpreting the UFSHCI standard in a different way?
My understanding is that the UFSHCI command flow is as follows:
* First, UICCMDARG1, UICCMDARG2 and UICCMDARG3 are written by the host.
* Next, UICCMD is written by the host. This causes the host controller
   to execute the UIC command.
* Upon completion of the command, the host controller updates the lowest
   byte of UICCMDARG2. UICCMDARG3 is only updated after execution of the
   following commands has finished: DME_GET, DME_SET, DME_PEER_GET and
   DME_PEER_SET.

Quoted 3 lines

Thanks,

Bart.

Hi Bart,

Yes, you are right! In general cases, this is true. But for some error cases, we need this trace debug log to check if the hardware is working as the software expects. Maybe the hardware is stuck or something like that. Therefore, we still need to read the register values from the hardware.

Thanks
Peter

author reviewer
#9 lore raw

Re: [PATCH 3/3] ufs: core: Optimize ufshcd_add_uic_command_trace()

Quoted 6 lines · Peter Wang (王信友)

Yes, you are right! In general cases, this is true. But for some error cases, we need this trace debug log to check if the hardware is working as the software expects. Maybe the hardware is stuck or something like that. Therefore, we still need to read the register values from the hardware.

Hi Peter,

I have started testing the patch below. This patch is intended as a replacement for patch 3/3 in this series:

drivers/ufs/core/ufshcd.c +8 -9
index a44ef7e97125..76416ee88b25 100644
@@ -460,20 +460,19 @@ static void ufshcd_add_uic_command_trace(struct ufs_hba *hba,
 					 const struct uic_command *ucmd,
 					 enum ufs_trace_str_t str_t)
 {
-	u32 cmd;
-
 	if (!trace_ufshcd_uic_command_enabled())
 		return;
 
 	if (str_t == UFS_CMD_SEND)
-		cmd = ucmd->command;
+		trace_ufshcd_uic_command(hba, str_t, ucmd->command,
+					 ucmd->argument1, ucmd->argument2,
+					 ucmd->argument3);
 	else
-		cmd = ufshcd_readl(hba, REG_UIC_COMMAND);
-
-	trace_ufshcd_uic_command(hba, str_t, cmd,
-				 ufshcd_readl(hba, REG_UIC_COMMAND_ARG_1),
-				 ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2),
-				 ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3));
+		trace_ufshcd_uic_command(
+			hba, str_t, ufshcd_readl(hba, REG_UIC_COMMAND),
+			ufshcd_readl(hba, REG_UIC_COMMAND_ARG_1),
+			ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2),
+			ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3));
 }
 
 static void ufshcd_add_command_trace(struct ufs_hba *hba, struct 

scsi_cmnd *cmd,

#10 lore raw

Re: [PATCH 3/3] ufs: core: Optimize ufshcd_add_uic_command_trace()

Quoted 44 lines · Bart Van Assche

Hi Peter,

I have started testing the patch below. This patch is intended as a replacement for patch 3/3 in this series:

drivers/ufs/core/ufshcd.c +0 -0
index a44ef7e97125..76416ee88b25 100644
@@ -460,20 +460,19 @@ static void ufshcd_add_uic_command_trace(struct
 ufs_hba *hba,

                                         const struct uic_command *ucmd,
                                         enum ufs_trace_str_t str_t) {
-       u32 cmd;
-
        if (!trace_ufshcd_uic_command_enabled())
                return;

        if (str_t == UFS_CMD_SEND)
-               cmd = ucmd->command;
+               trace_ufshcd_uic_command(hba, str_t, ucmd->command, +                                        ucmd->argument1, ucmd-

Quoted 1 line

argument2,

+                                        ucmd->argument3); else
-               cmd = ufshcd_readl(hba, REG_UIC_COMMAND); -
-       trace_ufshcd_uic_command(hba, str_t, cmd,
-                                ufshcd_readl(hba, REG_UIC_COMMAND_ARG_1),
-                                ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2),
-                                ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3));
+               trace_ufshcd_uic_command(
+                       hba, str_t, ufshcd_readl(hba, REG_UIC_COMMAND),
+                       ufshcd_readl(hba, REG_UIC_COMMAND_ARG_1), +                       ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2), +                       ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3)); }

Quoted 3 lines

  static void ufshcd_add_command_trace(struct ufs_hba *hba, struct scsi_cmnd *cmd,

Hi Bart,

This patch looks good to me.

Thanks
Peter