2021-05-27 08:46:28

by Kyle Tso

[permalink] [raw]
Subject: [PATCH 0/3] Add the support of SVDM Version 2.0 VDOs

Hi Greg, these patches are based on usb-linus branch. Is it okay?

===

The patches are primarily for the responses to the Discover Identity
command. This part was changed a lot from PD rev2.0 to PD rev3.0 (now
it's rev3.1 :D). e.g. DFP can respond to Discover Identity command with
ACK in PD rev3.x and the Product Type VDOs are quite different. Given
that tcpm.c moved on to PD rev3.x and PD rev2.0 is still supported, some
changes need to be made to support both PD rev3.x and rev2.0.

usb: typec: tcpm: Correct the responses in SVDM Version 2.0 DFP
- This patch is to unblock the responder ACK to Discover Identity if the
port is DFP and the SVDM version is 2.0

dt-bindings: connector: Add PD rev 2.0 VDO definition
- similar changes to Commit 2a1673f0f1de ("usb: pd: Reland VDO
definitions of PD2.0")
https://lore.kernel.org/linux-usb/[email protected]/
- add a new property sink-vdos-v1 to store the PD rev2.0 VDOs

usb: typec: tcpm: Introduce snk_vdo_v1 for SVDM version 1.0
- populate the legacy VDOs from fwnode
- send these data if the port partner is SVDM Version 1.0

Kyle Tso (3):
usb: typec: tcpm: Correct the responses in SVDM Version 2.0 DFP
dt-bindings: connector: Add PD rev 2.0 VDO definition
usb: typec: tcpm: Introduce snk_vdo_v1 for SVDM version 1.0

.../bindings/connector/usb-connector.yaml | 15 ++++
drivers/usb/typec/tcpm/tcpm.c | 52 ++++++++++----
include/dt-bindings/usb/pd.h | 69 ++++++++++++++++++-
3 files changed, 119 insertions(+), 17 deletions(-)

--
2.31.1.818.g46aad6cb9e-goog


2021-05-27 08:46:58

by Kyle Tso

[permalink] [raw]
Subject: [PATCH 1/3] usb: typec: tcpm: Correct the responses in SVDM Version 2.0 DFP

In USB PD Spec Rev 3.1 Ver 1.0, section "6.12.5 Applicability of
Structured VDM Commands", DFP is allowed and recommended to respond to
Discovery Identity with ACK. And in section "6.4.4.2.5.1 Commands other
than Attention", NAK should be returned only when receiving Messages
with invalid fields, Messages in wrong situation, or unrecognize
Messages.

Still keep the original design for SVDM Version 1.0 for backward
compatibilities.

Fixes: 193a68011fdc ("staging: typec: tcpm: Respond to Discover Identity commands")
Signed-off-by: Kyle Tso <[email protected]>
---
drivers/usb/typec/tcpm/tcpm.c | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/drivers/usb/typec/tcpm/tcpm.c b/drivers/usb/typec/tcpm/tcpm.c
index 9ce8c9af4da5..a1bf0dc5babf 100644
--- a/drivers/usb/typec/tcpm/tcpm.c
+++ b/drivers/usb/typec/tcpm/tcpm.c
@@ -1547,19 +1547,25 @@ static int tcpm_pd_svdm(struct tcpm_port *port, struct typec_altmode *adev,
if (PD_VDO_VID(p[0]) != USB_SID_PD)
break;

- if (PD_VDO_SVDM_VER(p[0]) < svdm_version)
+ if (PD_VDO_SVDM_VER(p[0]) < svdm_version) {
typec_partner_set_svdm_version(port->partner,
PD_VDO_SVDM_VER(p[0]));
+ svdm_version = PD_VDO_SVDM_VER(p[0]);
+ }

tcpm_ams_start(port, DISCOVER_IDENTITY);
- /* 6.4.4.3.1: Only respond as UFP (device) */
- if (port->data_role == TYPEC_DEVICE &&
+ /*
+ * PD2.0 Spec 6.10.3: respond with NAK as DFP (data host)
+ * PD3.1 Spec 6.4.4.2.5.1: respond with NAK if "invalid field" or
+ * "wrong configuation" or "Unrecognized"
+ */
+ if ((port->data_role == TYPEC_DEVICE || svdm_version >= SVDM_VER_2_0) &&
port->nr_snk_vdo) {
/*
* Product Type DFP and Connector Type are not defined in SVDM
* version 1.0 and shall be set to zero.
*/
- if (typec_get_negotiated_svdm_version(typec) < SVDM_VER_2_0)
+ if (svdm_version < SVDM_VER_2_0)
response[1] = port->snk_vdo[0] & ~IDH_DFP_MASK
& ~IDH_CONN_MASK;
else
--
2.31.1.818.g46aad6cb9e-goog

2021-05-27 08:47:31

by Kyle Tso

[permalink] [raw]
Subject: [PATCH 2/3] dt-bindings: connector: Add PD rev 2.0 VDO definition

Add the VDO definition for USB PD rev 2.0 in the bindings and define a
new property snk-vdos-v1 containing legacy VDOs as the responses to the
port partner which only supports PD rev 2.0.

Signed-off-by: Kyle Tso <[email protected]>
---
.../bindings/connector/usb-connector.yaml | 15 ++++
include/dt-bindings/usb/pd.h | 69 ++++++++++++++++++-
2 files changed, 81 insertions(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/connector/usb-connector.yaml b/Documentation/devicetree/bindings/connector/usb-connector.yaml
index 32509b98142e..92b49bc37939 100644
--- a/Documentation/devicetree/bindings/connector/usb-connector.yaml
+++ b/Documentation/devicetree/bindings/connector/usb-connector.yaml
@@ -149,6 +149,17 @@ properties:
maxItems: 6
$ref: /schemas/types.yaml#/definitions/uint32-array

+ sink-vdos-v1:
+ description: An array of u32 with each entry, a Vendor Defined Message Object (VDO),
+ providing additional information corresponding to the product, the detailed bit
+ definitions and the order of each VDO can be found in
+ "USB Power Delivery Specification Revision 2.0, Version 1.3" chapter 6.4.4.3.1 Discover
+ Identity. User can specify the VDO array via VDO_IDH/_CERT/_PRODUCT/_CABLE/_AMA defined in
+ dt-bindings/usb/pd.h.
+ minItems: 3
+ maxItems: 6
+ $ref: /schemas/types.yaml#/definitions/uint32-array
+
op-sink-microwatt:
description: Sink required operating power in microwatt, if source can't
offer the power, Capability Mismatch is set. Required for power sink and
@@ -207,6 +218,10 @@ properties:
SNK_READY for non-pd link.
type: boolean

+dependencies:
+ sink-vdos-v1: [ 'sink-vdos' ]
+ sink-vdos: [ 'sink-vdos-v1' ]
+
required:
- compatible

diff --git a/include/dt-bindings/usb/pd.h b/include/dt-bindings/usb/pd.h
index fef3ef65967f..9e47f9673405 100644
--- a/include/dt-bindings/usb/pd.h
+++ b/include/dt-bindings/usb/pd.h
@@ -106,6 +106,10 @@
* <20:16> :: Reserved, Shall be set to zero
* <15:0> :: USB-IF assigned VID for this cable vendor
*/
+
+/* PD Rev2.0 definition */
+#define IDH_PTYPE_UNDEF 0
+
/* SOP Product Type (UFP) */
#define IDH_PTYPE_NOT_UFP 0
#define IDH_PTYPE_HUB 1
@@ -228,7 +232,25 @@
| ((pnum) & 0x1f))

/*
- * Passive Cable VDO
+ * Cable VDO (for both Passive and Active Cable VDO in PD Rev2.0)
+ * ---------
+ * <31:28> :: Cable HW version
+ * <27:24> :: Cable FW version
+ * <23:20> :: Reserved, Shall be set to zero
+ * <19:18> :: type-C to Type-A/B/C/Captive (00b == A, 01 == B, 10 == C, 11 == Captive)
+ * <17> :: Reserved, Shall be set to zero
+ * <16:13> :: cable latency (0001 == <10ns(~1m length))
+ * <12:11> :: cable termination type (11b == both ends active VCONN req)
+ * <10> :: SSTX1 Directionality support (0b == fixed, 1b == cfgable)
+ * <9> :: SSTX2 Directionality support
+ * <8> :: SSRX1 Directionality support
+ * <7> :: SSRX2 Directionality support
+ * <6:5> :: Vbus current handling capability (01b == 3A, 10b == 5A)
+ * <4> :: Vbus through cable (0b == no, 1b == yes)
+ * <3> :: SOP" controller present? (0b == no, 1b == yes)
+ * <2:0> :: USB SS Signaling support
+ *
+ * Passive Cable VDO (PD Rev3.0+)
* ---------
* <31:28> :: Cable HW version
* <27:24> :: Cable FW version
@@ -244,7 +266,7 @@
* <4:3> :: Reserved, Shall be set to zero
* <2:0> :: USB highest speed
*
- * Active Cable VDO 1
+ * Active Cable VDO 1 (PD Rev3.0+)
* ---------
* <31:28> :: Cable HW version
* <27:24> :: Cable FW version
@@ -266,7 +288,9 @@
#define CABLE_VDO_VER1_0 0
#define CABLE_VDO_VER1_3 3

-/* Connector Type */
+/* Connector Type (_ATYPE and _BTYPE are for PD Rev2.0 only) */
+#define CABLE_ATYPE 0
+#define CABLE_BTYPE 1
#define CABLE_CTYPE 2
#define CABLE_CAPTIVE 3

@@ -303,12 +327,22 @@
#define CABLE_CURR_3A 1
#define CABLE_CURR_5A 2

+/* USB SuperSpeed Signaling Support (PD Rev2.0) */
+#define CABLE_USBSS_U2_ONLY 0
+#define CABLE_USBSS_U31_GEN1 1
+#define CABLE_USBSS_U31_GEN2 2
+
/* USB Highest Speed */
#define CABLE_USB2_ONLY 0
#define CABLE_USB32_GEN1 1
#define CABLE_USB32_4_GEN2 2
#define CABLE_USB4_GEN3 3

+#define VDO_CABLE(hw, fw, cbl, lat, term, tx1d, tx2d, rx1d, rx2d, cur, vps, sopp, usbss) \
+ (((hw) & 0x7) << 28 | ((fw) & 0x7) << 24 | ((cbl) & 0x3) << 18 \
+ | ((lat) & 0x7) << 13 | ((term) & 0x3) << 11 | (tx1d) << 10 \
+ | (tx2d) << 9 | (rx1d) << 8 | (rx2d) << 7 | ((cur) & 0x3) << 5 \
+ | (vps) << 4 | (sopp) << 3 | ((usbss) & 0x7))
#define VDO_PCABLE(hw, fw, ver, conn, lat, term, vbm, cur, spd) \
(((hw) & 0xf) << 28 | ((fw) & 0xf) << 24 | ((ver) & 0x7) << 21 \
| ((conn) & 0x3) << 18 | ((lat) & 0xf) << 13 | ((term) & 0x3) << 11 \
@@ -373,6 +407,35 @@
| ((hops) & 0x3) << 6 | (u2) << 5 | (u32) << 4 | (lane) << 3 \
| (iso) << 2 | (gen))

+/*
+ * AMA VDO (PD Rev2.0)
+ * ---------
+ * <31:28> :: Cable HW version
+ * <27:24> :: Cable FW version
+ * <23:12> :: Reserved, Shall be set to zero
+ * <11> :: SSTX1 Directionality support (0b == fixed, 1b == cfgable)
+ * <10> :: SSTX2 Directionality support
+ * <9> :: SSRX1 Directionality support
+ * <8> :: SSRX2 Directionality support
+ * <7:5> :: Vconn power
+ * <4> :: Vconn power required
+ * <3> :: Vbus power required
+ * <2:0> :: USB SS Signaling support
+ */
+#define VDO_AMA(hw, fw, tx1d, tx2d, rx1d, rx2d, vcpwr, vcr, vbr, usbss) \
+ (((hw) & 0x7) << 28 | ((fw) & 0x7) << 24 \
+ | (tx1d) << 11 | (tx2d) << 10 | (rx1d) << 9 | (rx2d) << 8 \
+ | ((vcpwr) & 0x7) << 5 | (vcr) << 4 | (vbr) << 3 \
+ | ((usbss) & 0x7))
+
+#define PD_VDO_AMA_VCONN_REQ(vdo) (((vdo) >> 4) & 1)
+#define PD_VDO_AMA_VBUS_REQ(vdo) (((vdo) >> 3) & 1)
+
+#define AMA_USBSS_U2_ONLY 0
+#define AMA_USBSS_U31_GEN1 1
+#define AMA_USBSS_U31_GEN2 2
+#define AMA_USBSS_BBONLY 3
+
/*
* VPD VDO
* ---------
--
2.31.1.818.g46aad6cb9e-goog

2021-05-27 08:49:38

by Kyle Tso

[permalink] [raw]
Subject: [PATCH 3/3] usb: typec: tcpm: Introduce snk_vdo_v1 for SVDM version 1.0

The ID Header VDO and Product VDOs defined in USB PD Spec rev 2.0 and
rev 3.1 are quite different. Add an additional array snk_vdo_v1 and
send it as the response to the port partner if it only supports SVDM
version 1.0.

Signed-off-by: Kyle Tso <[email protected]>
---
drivers/usb/typec/tcpm/tcpm.c | 40 +++++++++++++++++++++++++----------
1 file changed, 29 insertions(+), 11 deletions(-)

diff --git a/drivers/usb/typec/tcpm/tcpm.c b/drivers/usb/typec/tcpm/tcpm.c
index a1bf0dc5babf..07d2bed0a63b 100644
--- a/drivers/usb/typec/tcpm/tcpm.c
+++ b/drivers/usb/typec/tcpm/tcpm.c
@@ -401,6 +401,8 @@ struct tcpm_port {
unsigned int nr_src_pdo;
u32 snk_pdo[PDO_MAX_OBJECTS];
unsigned int nr_snk_pdo;
+ u32 snk_vdo_v1[VDO_MAX_OBJECTS];
+ unsigned int nr_snk_vdo_v1;
u32 snk_vdo[VDO_MAX_OBJECTS];
unsigned int nr_snk_vdo;

@@ -1561,18 +1563,18 @@ static int tcpm_pd_svdm(struct tcpm_port *port, struct typec_altmode *adev,
*/
if ((port->data_role == TYPEC_DEVICE || svdm_version >= SVDM_VER_2_0) &&
port->nr_snk_vdo) {
- /*
- * Product Type DFP and Connector Type are not defined in SVDM
- * version 1.0 and shall be set to zero.
- */
- if (svdm_version < SVDM_VER_2_0)
- response[1] = port->snk_vdo[0] & ~IDH_DFP_MASK
- & ~IDH_CONN_MASK;
- else
+ if (svdm_version < SVDM_VER_2_0) {
+ response[1] = port->snk_vdo_v1[0];
+ for (i = 1; i < port->nr_snk_vdo_v1; i++)
+ response[i + 1] = port->snk_vdo_v1[i];
+ rlen = port->nr_snk_vdo_v1 + 1;
+
+ } else {
response[1] = port->snk_vdo[0];
- for (i = 1; i < port->nr_snk_vdo; i++)
- response[i + 1] = port->snk_vdo[i];
- rlen = port->nr_snk_vdo + 1;
+ for (i = 1; i < port->nr_snk_vdo; i++)
+ response[i + 1] = port->snk_vdo[i];
+ rlen = port->nr_snk_vdo + 1;
+ }
}
break;
case CMD_DISCOVER_SVID:
@@ -5953,6 +5955,22 @@ static int tcpm_fw_get_caps(struct tcpm_port *port,
return ret;
}

+ /* If sink-vdos is found, sink-vdos-v1 is expected for backward compatibility. */
+ if (port->nr_snk_vdo) {
+ ret = fwnode_property_count_u32(fwnode, "sink-vdos-v1");
+ if (ret < 0)
+ return ret;
+ else if (ret == 0)
+ return -ENODATA;
+
+ port->nr_snk_vdo_v1 = min(ret, VDO_MAX_OBJECTS);
+ ret = fwnode_property_read_u32_array(fwnode, "sink-vdos-v1",
+ port->snk_vdo_v1,
+ port->nr_snk_vdo_v1);
+ if (ret < 0)
+ return ret;
+ }
+
return 0;
}

--
2.31.1.818.g46aad6cb9e-goog

2021-05-31 08:52:26

by Heikki Krogerus

[permalink] [raw]
Subject: Re: [PATCH 1/3] usb: typec: tcpm: Correct the responses in SVDM Version 2.0 DFP

On Thu, May 27, 2021 at 04:44:17PM +0800, Kyle Tso wrote:
> In USB PD Spec Rev 3.1 Ver 1.0, section "6.12.5 Applicability of
> Structured VDM Commands", DFP is allowed and recommended to respond to
> Discovery Identity with ACK. And in section "6.4.4.2.5.1 Commands other
> than Attention", NAK should be returned only when receiving Messages
> with invalid fields, Messages in wrong situation, or unrecognize
> Messages.
>
> Still keep the original design for SVDM Version 1.0 for backward
> compatibilities.
>
> Fixes: 193a68011fdc ("staging: typec: tcpm: Respond to Discover Identity commands")
> Signed-off-by: Kyle Tso <[email protected]>

Acked-by: Heikki Krogerus <[email protected]>

> ---
> drivers/usb/typec/tcpm/tcpm.c | 14 ++++++++++----
> 1 file changed, 10 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/usb/typec/tcpm/tcpm.c b/drivers/usb/typec/tcpm/tcpm.c
> index 9ce8c9af4da5..a1bf0dc5babf 100644
> --- a/drivers/usb/typec/tcpm/tcpm.c
> +++ b/drivers/usb/typec/tcpm/tcpm.c
> @@ -1547,19 +1547,25 @@ static int tcpm_pd_svdm(struct tcpm_port *port, struct typec_altmode *adev,
> if (PD_VDO_VID(p[0]) != USB_SID_PD)
> break;
>
> - if (PD_VDO_SVDM_VER(p[0]) < svdm_version)
> + if (PD_VDO_SVDM_VER(p[0]) < svdm_version) {
> typec_partner_set_svdm_version(port->partner,
> PD_VDO_SVDM_VER(p[0]));
> + svdm_version = PD_VDO_SVDM_VER(p[0]);
> + }
>
> tcpm_ams_start(port, DISCOVER_IDENTITY);
> - /* 6.4.4.3.1: Only respond as UFP (device) */
> - if (port->data_role == TYPEC_DEVICE &&
> + /*
> + * PD2.0 Spec 6.10.3: respond with NAK as DFP (data host)
> + * PD3.1 Spec 6.4.4.2.5.1: respond with NAK if "invalid field" or
> + * "wrong configuation" or "Unrecognized"
> + */
> + if ((port->data_role == TYPEC_DEVICE || svdm_version >= SVDM_VER_2_0) &&
> port->nr_snk_vdo) {
> /*
> * Product Type DFP and Connector Type are not defined in SVDM
> * version 1.0 and shall be set to zero.
> */
> - if (typec_get_negotiated_svdm_version(typec) < SVDM_VER_2_0)
> + if (svdm_version < SVDM_VER_2_0)
> response[1] = port->snk_vdo[0] & ~IDH_DFP_MASK
> & ~IDH_CONN_MASK;
> else
> --
> 2.31.1.818.g46aad6cb9e-goog

--
heikki

2021-05-31 09:07:49

by Heikki Krogerus

[permalink] [raw]
Subject: Re: [PATCH 3/3] usb: typec: tcpm: Introduce snk_vdo_v1 for SVDM version 1.0

On Thu, May 27, 2021 at 04:44:19PM +0800, Kyle Tso wrote:
> The ID Header VDO and Product VDOs defined in USB PD Spec rev 2.0 and
> rev 3.1 are quite different. Add an additional array snk_vdo_v1 and
> send it as the response to the port partner if it only supports SVDM
> version 1.0.
>
> Signed-off-by: Kyle Tso <[email protected]>

Acked-by: Heikki Krogerus <[email protected]>

> ---
> drivers/usb/typec/tcpm/tcpm.c | 40 +++++++++++++++++++++++++----------
> 1 file changed, 29 insertions(+), 11 deletions(-)
>
> diff --git a/drivers/usb/typec/tcpm/tcpm.c b/drivers/usb/typec/tcpm/tcpm.c
> index a1bf0dc5babf..07d2bed0a63b 100644
> --- a/drivers/usb/typec/tcpm/tcpm.c
> +++ b/drivers/usb/typec/tcpm/tcpm.c
> @@ -401,6 +401,8 @@ struct tcpm_port {
> unsigned int nr_src_pdo;
> u32 snk_pdo[PDO_MAX_OBJECTS];
> unsigned int nr_snk_pdo;
> + u32 snk_vdo_v1[VDO_MAX_OBJECTS];
> + unsigned int nr_snk_vdo_v1;
> u32 snk_vdo[VDO_MAX_OBJECTS];
> unsigned int nr_snk_vdo;
>
> @@ -1561,18 +1563,18 @@ static int tcpm_pd_svdm(struct tcpm_port *port, struct typec_altmode *adev,
> */
> if ((port->data_role == TYPEC_DEVICE || svdm_version >= SVDM_VER_2_0) &&
> port->nr_snk_vdo) {
> - /*
> - * Product Type DFP and Connector Type are not defined in SVDM
> - * version 1.0 and shall be set to zero.
> - */
> - if (svdm_version < SVDM_VER_2_0)
> - response[1] = port->snk_vdo[0] & ~IDH_DFP_MASK
> - & ~IDH_CONN_MASK;
> - else
> + if (svdm_version < SVDM_VER_2_0) {
> + response[1] = port->snk_vdo_v1[0];
> + for (i = 1; i < port->nr_snk_vdo_v1; i++)
> + response[i + 1] = port->snk_vdo_v1[i];
> + rlen = port->nr_snk_vdo_v1 + 1;
> +
> + } else {
> response[1] = port->snk_vdo[0];
> - for (i = 1; i < port->nr_snk_vdo; i++)
> - response[i + 1] = port->snk_vdo[i];
> - rlen = port->nr_snk_vdo + 1;
> + for (i = 1; i < port->nr_snk_vdo; i++)
> + response[i + 1] = port->snk_vdo[i];
> + rlen = port->nr_snk_vdo + 1;
> + }
> }
> break;
> case CMD_DISCOVER_SVID:
> @@ -5953,6 +5955,22 @@ static int tcpm_fw_get_caps(struct tcpm_port *port,
> return ret;
> }
>
> + /* If sink-vdos is found, sink-vdos-v1 is expected for backward compatibility. */
> + if (port->nr_snk_vdo) {
> + ret = fwnode_property_count_u32(fwnode, "sink-vdos-v1");
> + if (ret < 0)
> + return ret;
> + else if (ret == 0)
> + return -ENODATA;
> +
> + port->nr_snk_vdo_v1 = min(ret, VDO_MAX_OBJECTS);
> + ret = fwnode_property_read_u32_array(fwnode, "sink-vdos-v1",
> + port->snk_vdo_v1,
> + port->nr_snk_vdo_v1);
> + if (ret < 0)
> + return ret;
> + }
> +
> return 0;
> }
>
> --
> 2.31.1.818.g46aad6cb9e-goog

--
heikki