Merge branch 'spectre' of git://git.armlinux.org.uk/~rmk/linux-arm
[sfrench/cifs-2.6.git] / Documentation / ABI / testing / sysfs-bus-typec
1 What:           /sys/bus/typec/devices/.../active
2 Date:           July 2018
3 Contact:        Heikki Krogerus <heikki.krogerus@linux.intel.com>
4 Description:
5                 Shows if the mode is active or not. The attribute can be used
6                 for entering/exiting the mode. Entering/exiting modes is
7                 supported as synchronous operation so write(2) to the attribute
8                 does not return until the enter/exit mode operation has
9                 finished. The attribute is notified when the mode is
10                 entered/exited so poll(2) on the attribute wakes up.
11                 Entering/exiting a mode will also generate uevent KOBJ_CHANGE.
12
13                 Valid values are boolean.
14
15 What:           /sys/bus/typec/devices/.../description
16 Date:           July 2018
17 Contact:        Heikki Krogerus <heikki.krogerus@linux.intel.com>
18 Description:
19                 Shows description of the mode. The description is optional for
20                 the drivers, just like with the Billboard Devices.
21
22 What:           /sys/bus/typec/devices/.../mode
23 Date:           July 2018
24 Contact:        Heikki Krogerus <heikki.krogerus@linux.intel.com>
25 Description:
26                 The index number of the mode returned by Discover Modes USB
27                 Power Delivery command. Depending on the alternate mode, the
28                 mode index may be significant.
29
30                 With some alternate modes (SVIDs), the mode index is assigned
31                 for specific functionality in the specification for that
32                 alternate mode.
33
34                 With other alternate modes, the mode index values are not
35                 assigned, and can not be therefore used for identification. When
36                 the mode index is not assigned, identifying the alternate mode
37                 must be done with either mode VDO or the description.
38
39 What:           /sys/bus/typec/devices/.../svid
40 Date:           July 2018
41 Contact:        Heikki Krogerus <heikki.krogerus@linux.intel.com>
42 Description:
43                 The Standard or Vendor ID (SVID) assigned by USB-IF for this
44                 alternate mode.
45
46 What:           /sys/bus/typec/devices/.../vdo
47 Date:           July 2018
48 Contact:        Heikki Krogerus <heikki.krogerus@linux.intel.com>
49 Description:
50                 Shows the VDO in hexadecimal returned by Discover Modes command
51                 for this mode.