Re: [PATCH v3 1/2] usb: typec: Consolidate syfs ABI documentation

From: Heikki Krogerus
Date: Tue Nov 10 2020 - 05:52:33 EST


On Fri, Oct 23, 2020 at 02:43:26PM -0700, Prashant Malani wrote:
> Both partner and cable have identity VDOs. These are listed separately
> in the Documentation/ABI/testing/sysfs-class-typec. Factor these out
> into a common location to avoid the duplication.
>
> Signed-off-by: Prashant Malani <pmalani@xxxxxxxxxxxx>

I don't have a problem with this change. FWIW:

Acked-by: Heikki Krogerus <heikki.krogeurus@xxxxxxxxxxxxxxx>

> ---
>
> Patch first introduced in v3.
>
> Documentation/ABI/testing/sysfs-class-typec | 59 ++++++---------------
> 1 file changed, 17 insertions(+), 42 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-class-typec b/Documentation/ABI/testing/sysfs-class-typec
> index b834671522d6..0f839fd022f1 100644
> --- a/Documentation/ABI/testing/sysfs-class-typec
> +++ b/Documentation/ABI/testing/sysfs-class-typec
> @@ -134,42 +134,6 @@ Description:
> Shows if the partner supports USB Power Delivery communication:
> Valid values: yes, no
>
> -What: /sys/class/typec/<port>-partner>/identity/
> -Date: April 2017
> -Contact: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>
> -Description:
> - This directory appears only if the port device driver is capable
> - of showing the result of Discover Identity USB power delivery
> - command. That will not always be possible even when USB power
> - delivery is supported, for example when USB power delivery
> - communication for the port is mostly handled in firmware. If the
> - directory exists, it will have an attribute file for every VDO
> - in Discover Identity command result.
> -
> -What: /sys/class/typec/<port>-partner/identity/id_header
> -Date: April 2017
> -Contact: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>
> -Description:
> - ID Header VDO part of Discover Identity command result. The
> - value will show 0 until Discover Identity command result becomes
> - available. The value can be polled.
> -
> -What: /sys/class/typec/<port>-partner/identity/cert_stat
> -Date: April 2017
> -Contact: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>
> -Description:
> - Cert Stat VDO part of Discover Identity command result. The
> - value will show 0 until Discover Identity command result becomes
> - available. The value can be polled.
> -
> -What: /sys/class/typec/<port>-partner/identity/product
> -Date: April 2017
> -Contact: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>
> -Description:
> - Product VDO part of Discover Identity command result. The value
> - will show 0 until Discover Identity command result becomes
> - available. The value can be polled.
> -
>
> USB Type-C cable devices (eg. /sys/class/typec/port0-cable/)
>
> @@ -196,17 +160,28 @@ Description:
> - type-c
> - captive
>
> -What: /sys/class/typec/<port>-cable/identity/
> +
> +USB Type-C partner/cable Power Delivery Identity objects
> +
> +NOTE: The following attributes will be applicable to both
> +partner (e.g /sys/class/typec/port0-partner/) and
> +cable (e.g /sys/class/typec/port0-cable/) devices. Consequently, the example file
> +paths below are prefixed with "/sys/class/typec/<port>-{partner|cable}/" to
> +reflect this.
> +
> +What: /sys/class/typec/<port>-{partner|cable}/identity/
> Date: April 2017
> Contact: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>
> Description:
> This directory appears only if the port device driver is capable
> of showing the result of Discover Identity USB power delivery
> command. That will not always be possible even when USB power
> - delivery is supported. If the directory exists, it will have an
> - attribute for every VDO returned by Discover Identity command.
> + delivery is supported, for example when USB power delivery
> + communication for the port is mostly handled in firmware. If the
> + directory exists, it will have an attribute file for every VDO
> + in Discover Identity command result.
>
> -What: /sys/class/typec/<port>-cable/identity/id_header
> +What: /sys/class/typec/<port>-{partner|cable}/identity/id_header
> Date: April 2017
> Contact: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>
> Description:
> @@ -214,7 +189,7 @@ Description:
> value will show 0 until Discover Identity command result becomes
> available. The value can be polled.
>
> -What: /sys/class/typec/<port>-cable/identity/cert_stat
> +What: /sys/class/typec/<port>-{partner|cable}/identity/cert_stat
> Date: April 2017
> Contact: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>
> Description:
> @@ -222,7 +197,7 @@ Description:
> value will show 0 until Discover Identity command result becomes
> available. The value can be polled.
>
> -What: /sys/class/typec/<port>-cable/identity/product
> +What: /sys/class/typec/<port>-{partner|cable}/identity/product
> Date: April 2017
> Contact: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>
> Description:
> --
> 2.29.0.rc1.297.gfa9743e501-goog

thanks,

--
heikki