Commit fd2c35b2 authored by Prashant Malani's avatar Prashant Malani Committed by Greg Kroah-Hartman
Browse files

usb: typec: Consolidate sysfs ABI documentation 



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.

Acked-by: default avatarHeikki Krogerus <heikki.krogerus@linux.intel.com>
Signed-off-by: default avatarPrashant Malani <pmalani@chromium.org>
Link: https://lore.kernel.org/r/20201125084911.1077462-1-pmalani@chromium.org


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 7656ca71

Documentation/ABI/testing/sysfs-class-typec

+17 −42
Original line number Diff line number Diff line
@@ -147,42 +147,6 @@ Description: 
		during Power Delivery discovery. This file remains hidden until a value

		greater than or equal to 0 is set by Type C port driver.



What:		/sys/class/typec/<port>-partner>/identity/

Date:		April 2017

Contact:	Heikki Krogerus <heikki.krogerus@linux.intel.com>

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@linux.intel.com>

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@linux.intel.com>

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@linux.intel.com>

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/)
@@ -219,17 +183,28 @@ Description: 
		This file remains hidden until a value greater than or equal to 0

		is set by Type C port driver.



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@linux.intel.com>

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@linux.intel.com>

Description:
@@ -237,7 +212,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@linux.intel.com>

Description:
@@ -245,7 +220,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@linux.intel.com>

Description: