Skip to contentSkip to conversation

Send acknowledgment to ec from cors_ec_typec

PATCH Applied Utkarsh Patel 3 participants 9 messages Dec 10, 2020 – Jan 6, 2021

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

cover Send acknowledgment to ec from cors_ec_typec

This adds mechanism of sending mux configuration acknowledgment from kernel to EC. It also modifies cros_typec_cmds_supported() to support multiple feature flags.

Utkarsh Patel (2):
platform/chrome: cros_ec_typec: Parameterize
cros_typec_cmds_supported()
platform/chrome: cros_ec_typec: Send mux configuration acknowledgment
to EC

 drivers/platform/chrome/cros_ec_typec.c       | 28 +++++++++++++++----
 .../linux/platform_data/cros_ec_commands.h    | 17 +++++++++++
 2 files changed, 40 insertions(+), 5 deletions(-)
Signature · 1 line
2.25.1
#1 lore raw

PATCH 1/2 platform/chrome: cros_ec_typec: Parameterize cros_typec_cmds_supported()

cros_typec_cmds_supported() is currently being used to check only one feature flag.
Add a new feature parameter to it so that it can be used to check multiple feature flags supported in cros_ec.
Rename cros_typec_cmds_supported() to cros_typec_feature_supported().

---
 drivers/platform/chrome/cros_ec_typec.c | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)
drivers/platform/chrome/cros_ec_typec.c +7 -5
index ce031a10eb1b..650aa5332055 100644
@@ -829,8 +829,8 @@ static int cros_typec_get_cmd_version(struct cros_typec_data *typec)
 	return 0;
 }
 
-/* Check the EC feature flags to see if TYPEC_* commands are supported. */
-static int cros_typec_cmds_supported(struct cros_typec_data *typec)
+/* Check the EC feature flags to see if TYPEC_* features are supported. */
+static int cros_typec_feature_supported(struct cros_typec_data *typec, enum ec_feature_code feature)
 {
 	struct ec_response_get_features resp = {};
 	int ret;
@@ -839,11 +839,12 @@ static int cros_typec_cmds_supported(struct cros_typec_data *typec)
 				    &resp, sizeof(resp));
 	if (ret < 0) {
 		dev_warn(typec->dev,
-			 "Failed to get features, assuming typec commands unsupported.\n");
+			 "Failed to get features, assuming typec feature=%d unsupported.\n",
+			 feature);
 		return 0;
 	}
 
-	return resp.flags[EC_FEATURE_TYPEC_CMD / 32] & EC_FEATURE_MASK_1(EC_FEATURE_TYPEC_CMD);
+	return resp.flags[feature / 32] & EC_FEATURE_MASK_1(feature);
 }
 
 static void cros_typec_port_work(struct work_struct *work)
@@ -905,7 +906,8 @@ static int cros_typec_probe(struct platform_device *pdev)
 		return ret;
 	}
 
-	typec->typec_cmd_supported = !!cros_typec_cmds_supported(typec);
+	typec->typec_cmd_supported = !!cros_typec_feature_supported(typec,
+					EC_FEATURE_TYPEC_CMD);
 
 	ret = cros_typec_ec_command(typec, 0, EC_CMD_USB_PD_PORTS, NULL, 0,
 				    &resp, sizeof(resp));
Signature · 1 line
2.25.1
Reviewed-by on v1 1/2
#2 lore raw

Re: [PATCH 1/2] platform/chrome: cros_ec_typec: Parameterize cros_typec_cmds_supported()

Hi Utkarsh,

Quoted 7 lines · Utkarsh Patel

cros_typec_cmds_supported() is currently being used to check only one feature flag.
Add a new feature parameter to it so that it can be used to check multiple feature flags supported in cros_ec.
Rename cros_typec_cmds_supported() to cros_typec_feature_supported().

Thanks,

-Prashant

#3 lore raw

PATCH 2/2 platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC

In reply to Utkarsh Patel

In some corner cases downgrade of the superspeed typec device(e.g. Dell typec Dock, apple dongle) was seen because before the SOC mux configuration finishes, EC starts configuring the next mux state.

With this change, once the SOC mux is configured, kernel will send an acknowledgment to EC via Host command EC_CMD_USB_PD_MUX_ACK [1]. After sending the host event EC will wait for the acknowledgment from kernel before starting the PD negotiation for the next mux state. This helps to have a framework to build better error handling along with the synchronization of timing sensitive mux states.

This change also brings in corresponding EC header updates from the EC code base [1].

[1]:
https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/include/ec_commands.h

---
 drivers/platform/chrome/cros_ec_typec.c        | 16 ++++++++++++++++
 include/linux/platform_data/cros_ec_commands.h | 17 +++++++++++++++++
 2 files changed, 33 insertions(+)
drivers/platform/chrome/cros_ec_typec.c +16 -0
index 650aa5332055..e6abe205890c 100644
@@ -74,6 +74,7 @@ struct cros_typec_data {
 	struct notifier_block nb;
 	struct work_struct port_work;
 	bool typec_cmd_supported;
+	bool needs_mux_ack;
 };
 
 static int cros_typec_parse_port_props(struct typec_capability *cap,
@@ -503,6 +504,7 @@ static int cros_typec_configure_mux(struct cros_typec_data *typec, int port_num,
 				struct ec_response_usb_pd_control_v2 *pd_ctrl)
 {
 	struct cros_typec_port *port = typec->ports[port_num];
+	struct ec_params_usb_pd_mux_ack mux_ack;
 	enum typec_orientation orientation;
 	int ret;
 
@@ -543,6 +545,18 @@ static int cros_typec_configure_mux(struct cros_typec_data *typec, int port_num,
 		ret = -ENOTSUPP;
 	}
 
+	if (!typec->needs_mux_ack)
+		return ret;
+
+	/* Sending Acknowledgment to EC */
+	mux_ack.port = port_num;
+
+	if (cros_typec_ec_command(typec, 0, EC_CMD_USB_PD_MUX_ACK, &mux_ack,
+				  sizeof(mux_ack), NULL, 0) < 0)
+		dev_warn(typec->dev,
+			 "Failed to send Mux ACK to EC for port: %d\n",
+			 port_num);
+
 	return ret;
 }
 
@@ -908,6 +922,8 @@ static int cros_typec_probe(struct platform_device *pdev)
 
 	typec->typec_cmd_supported = !!cros_typec_feature_supported(typec,
 					EC_FEATURE_TYPEC_CMD);
+	typec->needs_mux_ack = !!cros_typec_feature_supported(typec,
+					EC_FEATURE_TYPEC_MUX_REQUIRE_AP_ACK);
 
 	ret = cros_typec_ec_command(typec, 0, EC_CMD_USB_PD_PORTS, NULL, 0,
 				    &resp, sizeof(resp));
include/linux/platform_data/cros_ec_commands.h +17 -0
index 7f54fdcdd8cb..3b53e45cb5a0 100644
@@ -1286,6 +1286,16 @@ enum ec_feature_code {
 	EC_FEATURE_ISH = 40,
 	/* New TCPMv2 TYPEC_ prefaced commands supported */
 	EC_FEATURE_TYPEC_CMD = 41,
+	/*
+	 * The EC will wait for direction from the AP to enter Type-C alternate
+	 * modes or USB4.
+	 */
+	EC_FEATURE_TYPEC_REQUIRE_AP_MODE_ENTRY = 42,
+	/*
+	 * The EC will wait for an acknowledge from the AP after setting the
+	 * mux.
+	 */
+	EC_FEATURE_TYPEC_MUX_REQUIRE_AP_ACK = 43,
 };
 
 #define EC_FEATURE_MASK_0(event_code) BIT(event_code % 32)
@@ -6054,6 +6064,13 @@ struct ec_params_charger_control {
 	uint8_t allow_charging;
 } __ec_align_size1;
 
+/* Get ACK from the USB-C SS muxes */
+#define EC_CMD_USB_PD_MUX_ACK 0x0603
+
+struct ec_params_usb_pd_mux_ack {
+	uint8_t port; /* USB-C port number */
+} __ec_align1;
+
 /*****************************************************************************/
 /*
  * Reserve a range of host commands for board-specific, experimental, or
Signature · 1 line
2.25.1
Reviewed-by on v1 2/2
#4 lore raw

Re: [PATCH 2/2] platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC

Hi Utkarsh,

Quoted 11 lines · Utkarsh Patel

In some corner cases downgrade of the superspeed typec device(e.g. Dell typec Dock, apple dongle) was seen because before the SOC mux configuration finishes, EC starts configuring the next mux state.

With this change, once the SOC mux is configured, kernel will send an acknowledgment to EC via Host command EC_CMD_USB_PD_MUX_ACK [1]. After sending the host event EC will wait for the acknowledgment from kernel before starting the PD negotiation for the next mux state. This helps to have a framework to build better error handling along with the synchronization of timing sensitive mux states.

Quoted 7 lines

This change also brings in corresponding EC header updates from the EC code base [1].

[1]:
https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/include/ec_commands.h

I'm not sure what the maintainers' preference is for the header (same patch or separate patch). FWIW:

Thanks,

-Prashant

#5 lore raw

Re: [PATCH 2/2] platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC

Hi Prashant and Utkarash,

Quoted 20 lines · Prashant Malani

Hi Utkarsh,

Quoted 17 lines · Utkarsh Patel

In some corner cases downgrade of the superspeed typec device(e.g. Dell typec Dock, apple dongle) was seen because before the SOC mux configuration finishes, EC starts configuring the next mux state.

With this change, once the SOC mux is configured, kernel will send an acknowledgment to EC via Host command EC_CMD_USB_PD_MUX_ACK [1]. After sending the host event EC will wait for the acknowledgment from kernel before starting the PD negotiation for the next mux state. This helps to have a framework to build better error handling along with the synchronization of timing sensitive mux states.

This change also brings in corresponding EC header updates from the EC code base [1].

[1]:
https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/include/ec_commands.h

Quoted 6 lines
Quoted 1 line

I'm not sure what the maintainers' preference is for the header (same patch or separate patch). FWIW:

I asked Gwendal to look over this change. It looks good to him, so I've gone ahead and merged it.

At some point we have to completely sync ec_commands.h, but the change here is well contained, so it minimally adds to the delta between the EC codebase's header and the kernel's.

Thanks,
Benson

Signature · 7 lines
Benson Leung
Staff Software Engineer
Chrome OS Kernel
Google Inc.
[email protected]
Chromium OS Project
[email protected]
#6 lore raw

Re: [PATCH 2/2] platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC

In reply to Utkarsh Patel

Hi Utkarsh,

drivers/platform/chrome/cros_ec_typec.c

Quoted 25 lines · Utkarsh Patel

In some corner cases downgrade of the superspeed typec device(e.g. Dell typec Dock, apple dongle) was seen because before the SOC mux configuration finishes, EC starts configuring the next mux state.

With this change, once the SOC mux is configured, kernel will send an acknowledgment to EC via Host command EC_CMD_USB_PD_MUX_ACK [1]. After sending the host event EC will wait for the acknowledgment from kernel before starting the PD negotiation for the next mux state. This helps to have a framework to build better error handling along with the synchronization of timing sensitive mux states.

This change also brings in corresponding EC header updates from the EC code base [1].

[1]:
https://chromium.googlesource.com/chromiumos/platform/ec/+/refs/heads/master/include/ec_commands.h

---
 drivers/platform/chrome/cros_ec_typec.c        | 16 ++++++++++++++++
 include/linux/platform_data/cros_ec_commands.h | 17 +++++++++++++++++
 2 files changed, 33 insertions(+)
drivers/platform/chrome/cros_ec_typec.c +0 -0
index 650aa5332055..e6abe205890c 100644

I went ahead and staged this commit, but just for your information, applying this patch was problematic because the sha1 used here didn't match anything in the upstream kernel.

Here's the error when I try to apply this using git am:
Applying: platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC
error: sha1 information is lacking or useless (drivers/platform/chrome/cros_ec_typec.c).
error: could not build fake ancestor
Patch failed at 0001 platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC

Please double check when you run git-format-patch that the branch you are working on comes from publicly available git repos, ideally, based on linus's tagged releases. This will ensure things apply cleanly on my side.

I've gone ahead and staged this, but could you please sanity check that the result is as intended?

https://git.kernel.org/pub/scm/linux/kernel/git/chrome-platform/linux.git/commit/?h=cros-ec-typec-for-5.12&id=8553a979fcd03448a4096c7d431b7ee1a52bfca3

Thank you,
Benson

Quoted 84 lines
drivers/platform/chrome/cros_ec_typec.c +16 -0
@@ -74,6 +74,7 @@ struct cros_typec_data {
 	struct notifier_block nb;
 	struct work_struct port_work;
 	bool typec_cmd_supported;
+	bool needs_mux_ack;
 };
 
 static int cros_typec_parse_port_props(struct typec_capability *cap,
@@ -503,6 +504,7 @@ static int cros_typec_configure_mux(struct cros_typec_data *typec, int port_num,
 				struct ec_response_usb_pd_control_v2 *pd_ctrl)
 {
 	struct cros_typec_port *port = typec->ports[port_num];
+	struct ec_params_usb_pd_mux_ack mux_ack;
 	enum typec_orientation orientation;
 	int ret;
 
@@ -543,6 +545,18 @@ static int cros_typec_configure_mux(struct cros_typec_data *typec, int port_num,
 		ret = -ENOTSUPP;
 	}
 
+	if (!typec->needs_mux_ack)
+		return ret;
+
+	/* Sending Acknowledgment to EC */
+	mux_ack.port = port_num;
+
+	if (cros_typec_ec_command(typec, 0, EC_CMD_USB_PD_MUX_ACK, &mux_ack,
+				  sizeof(mux_ack), NULL, 0) < 0)
+		dev_warn(typec->dev,
+			 "Failed to send Mux ACK to EC for port: %d\n",
+			 port_num);
+
 	return ret;
 }
 
@@ -908,6 +922,8 @@ static int cros_typec_probe(struct platform_device *pdev)
 
 	typec->typec_cmd_supported = !!cros_typec_feature_supported(typec,
 					EC_FEATURE_TYPEC_CMD);
+	typec->needs_mux_ack = !!cros_typec_feature_supported(typec,
+					EC_FEATURE_TYPEC_MUX_REQUIRE_AP_ACK);
 
 	ret = cros_typec_ec_command(typec, 0, EC_CMD_USB_PD_PORTS, NULL, 0,
 				    &resp, sizeof(resp));
include/linux/platform_data/cros_ec_commands.h +17 -0
index 7f54fdcdd8cb..3b53e45cb5a0 100644
@@ -1286,6 +1286,16 @@ enum ec_feature_code {
 	EC_FEATURE_ISH = 40,
 	/* New TCPMv2 TYPEC_ prefaced commands supported */
 	EC_FEATURE_TYPEC_CMD = 41,
+	/*
+	 * The EC will wait for direction from the AP to enter Type-C alternate
+	 * modes or USB4.
+	 */
+	EC_FEATURE_TYPEC_REQUIRE_AP_MODE_ENTRY = 42,
+	/*
+	 * The EC will wait for an acknowledge from the AP after setting the
+	 * mux.
+	 */
+	EC_FEATURE_TYPEC_MUX_REQUIRE_AP_ACK = 43,
 };
 
 #define EC_FEATURE_MASK_0(event_code) BIT(event_code % 32)
@@ -6054,6 +6064,13 @@ struct ec_params_charger_control {
 	uint8_t allow_charging;
 } __ec_align_size1;
 
+/* Get ACK from the USB-C SS muxes */
+#define EC_CMD_USB_PD_MUX_ACK 0x0603
+
+struct ec_params_usb_pd_mux_ack {
+	uint8_t port; /* USB-C port number */
+} __ec_align1;
+
 /*****************************************************************************/
 /*
  * Reserve a range of host commands for board-specific, experimental, or
Signature · 1 line
2.25.1
Signature · 7 lines
Benson Leung
Staff Software Engineer
Chrome OS Kernel
Google Inc.
[email protected]
Chromium OS Project
[email protected]
#7 lore raw

RE: [PATCH 2/2] platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC

Hi Benson,

Thank you for applying the patches.

Quoted 31 lines

-----Original Message-----
From: Benson Leung <[email protected]>
Sent: Tuesday, January 05, 2021 2:51 PM
To: Patel, Utkarsh H <[email protected]>
Cc: [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; Mani, Rajmohan <[email protected]>
Subject: Re: [PATCH 2/2] platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC

Hi Utkarsh,

drivers/platform/chrome/cros_ec_typec.c

Quoted 3 lines
drivers/platform/chrome/cros_ec_typec.c +0 -0
index 650aa5332055..e6abe205890c 100644

I went ahead and staged this commit, but just for your information, applying this patch was problematic because the sha1 used here didn't match anything in the upstream kernel.

Here's the error when I try to apply this using git am:
Applying: platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC
error: sha1 information is lacking or useless (drivers/platform/chrome/cros_ec_typec.c).
error: could not build fake ancestor
Patch failed at 0001 platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC

Quoted 3 lines

Please double check when you run git-format-patch that the branch you are working on comes from publicly available git repos, ideally, based on linus's tagged releases. This will ensure things apply cleanly on my side.

Sorry about this. I think I might have used for-next branch mistakenly when running git-format-patch. I will make sure to use correct one next time.

Quoted 7 lines

I've gone ahead and staged this, but could you please sanity check that the result is as intended?

https://git.kernel.org/pub/scm/linux/kernel/git/chrome-
platform/linux.git/commit/?h=cros-ec-typec-for-
5.12&id=8553a979fcd03448a4096c7d431b7ee1a52bfca3

I have checked it on myside and works as intended.

Quoted 4 lines

Thank you,
Benson

Sincerely,
Utkarsh Patel.

Applied
#8 lore raw
In reply to Utkarsh Patel

Hi Utkarsh,

Quoted 11 lines · Utkarsh Patel

This adds mechanism of sending mux configuration acknowledgment from kernel to EC. It also modifies cros_typec_cmds_supported() to support multiple feature flags.

Utkarsh Patel (2):
platform/chrome: cros_ec_typec: Parameterize
cros_typec_cmds_supported()
platform/chrome: cros_ec_typec: Send mux configuration acknowledgment
to EC

[...]

Applied, thanks!

[1/2] platform/chrome: cros_ec_typec: Parameterize cros_typec_cmds_supported()

      commit: ba8ce515454e1fc5e73ff8989c18c596a3449fef
[2/2] platform/chrome: cros_ec_typec: Send mux configuration acknowledgment to EC
      commit: 8553a979fcd03448a4096c7d431b7ee1a52bfca3

Best regards,

Signature · 7 lines
Benson Leung
Staff Software Engineer
Chrome OS Kernel
Google Inc.
[email protected]
Chromium OS Project
[email protected]