Re: [PATCH v3 3/4] usb: typec: ucsi: Register SOP/SOP' Discover Identity Responses

From: Benson Leung
Date: Thu Feb 29 2024 - 20:19:55 EST

Next message: Stephen Boyd: "Re: [PATCH 6/7] clk: qcom: mmcc-apq8084: fix terminating of frequency table arrays"
Previous message: Stephen Boyd: "Re: [PATCH 5/7] clk: qcom: camcc-sc8280xp: fix terminating of frequency table arrays"
In reply to: Jameson Thies: "[PATCH v3 3/4] usb: typec: ucsi: Register SOP/SOP' Discover Identity Responses"
Next in thread: Jameson Thies: "[PATCH v3 4/4] usb: typec: ucsi: Register SOP' alternate modes with cable plug"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]

Hi Jameson,

On Thu, Feb 29, 2024 at 11:26:24PM +0000, Jameson Thies wrote:
> Register SOP and SOP' Discover Identity responses with the USB Type-C
> Connector Class as partner and cable identities, respectively. Discover
> Identity responses are requested from the PPM using the GET_PD_MESSAGE
> UCSI command.
>
> Signed-off-by: Jameson Thies <jthies@xxxxxxxxxx>

Reviewed-by: Benson Leung <bleung@xxxxxxxxxxxx>

> ---
> GET_PD_MESSAGE responses from the PPM populate partner and cable
> identity in sysfs:
> nospike-rev4 /sys/class/typec # ls port0-partner/identity/
> cert_stat id_header product product_type_vdo1 product_type_vdo2
> product_type_vdo3
> nospike-rev4 /sys/class/typec # ls port0-cable/identity/
> cert_stat id_header product product_type_vdo1 product_type_vdo2
> product_type_vdo3
>
> Changes in v3:
> - None.
>
> Changes in v2:
> - Re-ordered memset call and null assignment when unregistering partners
> and cables.
> - Supports registering partner and cable identity with UCSI versions
> before v2.0.
> - Shortened lines to within 80 characters with the exception of two
> error log lines with three indentations.
> - Tested on usb-testing branch merged with chromeOS 6.8-rc2 kernel.
>
> drivers/usb/typec/ucsi/ucsi.c | 125 ++++++++++++++++++++++++++++++++++
> drivers/usb/typec/ucsi/ucsi.h | 29 ++++++++
> 2 files changed, 154 insertions(+)
>
> diff --git a/drivers/usb/typec/ucsi/ucsi.c b/drivers/usb/typec/ucsi/ucsi.c
> index 7c84687b5d1a3..4088422b33c74 100644
> --- a/drivers/usb/typec/ucsi/ucsi.c
> +++ b/drivers/usb/typec/ucsi/ucsi.c
> @@ -646,6 +646,121 @@ static int ucsi_get_src_pdos(struct ucsi_connector *con)
> return ret;
> }
>
> +static int ucsi_read_identity(struct ucsi_connector *con, u8 recipient,
> + struct usb_pd_identity *id)
> +{
> + struct ucsi *ucsi = con->ucsi;
> + struct ucsi_pd_message_disc_id resp = {};
> + u64 command;
> + int ret;
> +
> + if (ucsi->version < UCSI_VERSION_2_0) {
> + /*
> + * Before UCSI v2.0, MESSAGE_IN is 16 bytes which cannot fit
> + * the 28 byte identity response including the VDM header.
> + * First request the VDM header, ID Header VDO, Cert Stat VDO
> + * and Product VDO.
> + */
> + command = UCSI_COMMAND(UCSI_GET_PD_MESSAGE) |
> + UCSI_CONNECTOR_NUMBER(con->num);
> + command |= UCSI_GET_PD_MESSAGE_RECIPIENT(recipient);
> + command |= UCSI_GET_PD_MESSAGE_OFFSET(0);
> + command |= UCSI_GET_PD_MESSAGE_BYTES(0x10);
> + command |= UCSI_GET_PD_MESSAGE_TYPE(
> + UCSI_GET_PD_MESSAGE_TYPE_IDENTITY);
> +
> + ret = ucsi_send_command(ucsi, command, &resp, 0x10);
> + if (ret < 0) {
> + dev_err(ucsi->dev,
> + "UCSI_GET_PD_MESSAGE v1.2 failed first request (%d)\n",
> + ret);
> + return ret;
> + }
> +
> + /* Then request Product Type VDO1 through Product Type VDO3. */
> + command = UCSI_COMMAND(UCSI_GET_PD_MESSAGE) |
> + UCSI_CONNECTOR_NUMBER(con->num);
> + command |= UCSI_GET_PD_MESSAGE_RECIPIENT(recipient);
> + command |= UCSI_GET_PD_MESSAGE_OFFSET(0x10);
> + command |= UCSI_GET_PD_MESSAGE_BYTES(0xc);
> + command |= UCSI_GET_PD_MESSAGE_TYPE(
> + UCSI_GET_PD_MESSAGE_TYPE_IDENTITY);
> +
> + ret = ucsi_send_command(ucsi, command, &resp.vdo[0], 0xc);
> + if (ret < 0) {
> + dev_err(ucsi->dev,
> + "UCSI_GET_PD_MESSAGE v1.2 failed second request (%d)\n",
> + ret);
> + return ret;
> + }
> + } else {
> + /*
> + * In UCSI v2.0 and after, MESSAGE_IN is large enough to request
> + * the large enough to request the full Discover Identity
> + * response at once.
> + */
> + command = UCSI_COMMAND(UCSI_GET_PD_MESSAGE) |
> + UCSI_CONNECTOR_NUMBER(con->num);
> + command |= UCSI_GET_PD_MESSAGE_RECIPIENT(recipient);
> + /* VDM Header + 6 VDOs (0x1c bytes) without an offset */
> + command |= UCSI_GET_PD_MESSAGE_OFFSET(0);
> + command |= UCSI_GET_PD_MESSAGE_BYTES(0x1c);
> + command |= UCSI_GET_PD_MESSAGE_TYPE(
> + UCSI_GET_PD_MESSAGE_TYPE_IDENTITY);
> +
> + ret = ucsi_send_command(ucsi, command, &resp, sizeof(resp));
> + if (ret < 0) {
> + dev_err(ucsi->dev, "UCSI_GET_PD_MESSAGE failed (%d)\n",
> + ret);
> + return ret;
> + }
> + }
> +
> + id->id_header = resp.id_header;
> + id->cert_stat = resp.cert_stat;
> + id->product = resp.product;
> + id->vdo[0] = resp.vdo[0];
> + id->vdo[1] = resp.vdo[1];
> + id->vdo[2] = resp.vdo[2];
> + return 0;
> +}
> +
> +static int ucsi_get_partner_identity(struct ucsi_connector *con)
> +{
> + int ret;
> +
> + ret = ucsi_read_identity(con, UCSI_RECIPIENT_SOP,
> + &con->partner_identity);
> + if (ret < 0)
> + return ret;
> +
> + ret = typec_partner_set_identity(con->partner);
> + if (ret < 0) {
> + dev_err(con->ucsi->dev, "Failed to set partner identity (%d)\n",
> + ret);
> + }
> +
> + return ret;
> +}
> +
> +static int ucsi_get_cable_identity(struct ucsi_connector *con)
> +{
> + int ret;
> +
> + ret = ucsi_read_identity(con, UCSI_RECIPIENT_SOP_P,
> + &con->cable_identity);
> + if (ret < 0)
> + return ret;
> +
> + ret = typec_cable_set_identity(con->cable);
> + if (ret < 0) {
> + dev_err(con->ucsi->dev, "Failed to set cable identity (%d)\n",
> + ret);
> + }
> +
> + return ret;
> +}
> +
> static int ucsi_check_altmodes(struct ucsi_connector *con)
> {
> int ret, num_partner_am;
> @@ -754,6 +869,7 @@ static int ucsi_register_cable(struct ucsi_connector *con)
> break;
> }
>
> + desc.identity = &con->cable_identity;
> desc.active = !!(UCSI_CABLE_PROP_FLAG_ACTIVE_CABLE &
> con->cable_prop.flags);
> desc.pd_revision = UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV_AS_BCD(
> @@ -777,6 +893,7 @@ static void ucsi_unregister_cable(struct ucsi_connector *con)
> return;
>
> typec_unregister_cable(con->cable);
> + memset(&con->cable_identity, 0, sizeof(con->cable_identity));
> con->cable = NULL;
> }
>
> @@ -827,6 +944,7 @@ static int ucsi_register_partner(struct ucsi_connector *con)
> break;
> }
>
> + desc.identity = &con->partner_identity;
> desc.usb_pd = pwr_opmode == UCSI_CONSTAT_PWR_OPMODE_PD;
> desc.pd_revision = UCSI_CONCAP_FLAG_PARTNER_PD_MAJOR_REV_AS_BCD(con->cap.flags);
>
> @@ -855,6 +973,7 @@ static void ucsi_unregister_partner(struct ucsi_connector *con)
> ucsi_unregister_altmodes(con, UCSI_RECIPIENT_SOP);
> ucsi_unregister_cable(con);
> typec_unregister_partner(con->partner);
> + memset(&con->partner_identity, 0, sizeof(con->partner_identity));
> con->partner = NULL;
> }
>
> @@ -975,6 +1094,10 @@ static int ucsi_check_cable(struct ucsi_connector *con)
> if (ret < 0)
> return ret;
>
> + ret = ucsi_get_cable_identity(con);
> + if (ret < 0)
> + return ret;
> +
> return 0;
> }
>
> @@ -1019,6 +1142,7 @@ static void ucsi_handle_connector_change(struct work_struct *work)
> ucsi_register_partner(con);
> ucsi_partner_task(con, ucsi_check_connection, 1, HZ);
> ucsi_partner_task(con, ucsi_check_connector_capability, 1, HZ);
> + ucsi_partner_task(con, ucsi_get_partner_identity, 1, HZ);
> ucsi_partner_task(con, ucsi_check_cable, 1, HZ);
>
> if (UCSI_CONSTAT_PWR_OPMODE(con->status.flags) ==
> @@ -1418,6 +1542,7 @@ static int ucsi_register_port(struct ucsi *ucsi, struct ucsi_connector *con)
> ucsi_register_partner(con);
> ucsi_pwr_opmode_change(con);
> ucsi_port_psy_changed(con);
> + ucsi_get_partner_identity(con);
> ucsi_check_cable(con);
> }
>
> diff --git a/drivers/usb/typec/ucsi/ucsi.h b/drivers/usb/typec/ucsi/ucsi.h
> index f0aabef0b7c64..b89fae82e8ce7 100644
> --- a/drivers/usb/typec/ucsi/ucsi.h
> +++ b/drivers/usb/typec/ucsi/ucsi.h
> @@ -106,6 +106,7 @@ void ucsi_connector_change(struct ucsi *ucsi, u8 num);
> #define UCSI_GET_CABLE_PROPERTY 0x11
> #define UCSI_GET_CONNECTOR_STATUS 0x12
> #define UCSI_GET_ERROR_STATUS 0x13
> +#define UCSI_GET_PD_MESSAGE 0x15
>
> #define UCSI_CONNECTOR_NUMBER(_num_) ((u64)(_num_) << 16)
> #define UCSI_COMMAND(_cmd_) ((_cmd_) & 0xff)
> @@ -159,6 +160,18 @@ void ucsi_connector_change(struct ucsi *ucsi, u8 num);
> #define UCSI_MAX_PDOS (4)
> #define UCSI_GET_PDOS_SRC_PDOS ((u64)1 << 34)
>
> +/* GET_PD_MESSAGE command bits */
> +#define UCSI_GET_PD_MESSAGE_RECIPIENT(_r_) ((u64)(_r_) << 23)
> +#define UCSI_GET_PD_MESSAGE_OFFSET(_r_) ((u64)(_r_) << 26)
> +#define UCSI_GET_PD_MESSAGE_BYTES(_r_) ((u64)(_r_) << 34)
> +#define UCSI_GET_PD_MESSAGE_TYPE(_r_) ((u64)(_r_) << 42)
> +#define UCSI_GET_PD_MESSAGE_TYPE_SNK_CAP_EXT 0
> +#define UCSI_GET_PD_MESSAGE_TYPE_SRC_CAP_EXT 1
> +#define UCSI_GET_PD_MESSAGE_TYPE_BAT_CAP 2
> +#define UCSI_GET_PD_MESSAGE_TYPE_BAT_STAT 3
> +#define UCSI_GET_PD_MESSAGE_TYPE_IDENTITY 4
> +#define UCSI_GET_PD_MESSAGE_TYPE_REVISION 5
> +
> /* -------------------------------------------------------------------------- */
>
> /* Error information returned by PPM in response to GET_ERROR_STATUS command. */
> @@ -338,6 +351,18 @@ struct ucsi_connector_status {
> ((get_unaligned_le32(&(_p_)[5]) & GENMASK(16, 1)) >> 1)
> } __packed;
>
> +/*
> + * Data structure filled by PPM in response to GET_PD_MESSAGE command with the
> + * Response Message Type set to Discover Identity Response.
> + */
> +struct ucsi_pd_message_disc_id {
> + u32 vdm_header;
> + u32 id_header;
> + u32 cert_stat;
> + u32 product;
> + u32 vdo[3];
> +} __packed;
> +
> /* -------------------------------------------------------------------------- */
>
> struct ucsi_debugfs_entry {
> @@ -428,6 +453,10 @@ struct ucsi_connector {
> struct usb_power_delivery_capabilities *partner_sink_caps;
>
> struct usb_role_switch *usb_role_sw;
> +
> + /* USB PD identity */
> + struct usb_pd_identity partner_identity;
> + struct usb_pd_identity cable_identity;
> };
>
> int ucsi_send_command(struct ucsi *ucsi, u64 command,
> --
> 2.44.0.rc1.240.g4c46232300-goog
>

Attachment: signature.asc
Description: PGP signature

Next message: Stephen Boyd: "Re: [PATCH 6/7] clk: qcom: mmcc-apq8084: fix terminating of frequency table arrays"
Previous message: Stephen Boyd: "Re: [PATCH 5/7] clk: qcom: camcc-sc8280xp: fix terminating of frequency table arrays"
In reply to: Jameson Thies: "[PATCH v3 3/4] usb: typec: ucsi: Register SOP/SOP' Discover Identity Responses"
Next in thread: Jameson Thies: "[PATCH v3 4/4] usb: typec: ucsi: Register SOP' alternate modes with cable plug"
Messages sorted by: [ date ] [ thread ] [ subject ] [ author ]