greybus: interface: add interface-type attribute
[cascardo/linux.git] / drivers / staging / greybus / Documentation / sysfs-bus-greybus
index 044ede6..721010e 100644 (file)
@@ -1,4 +1,4 @@
-What:          /sys/bus/greybus/device/greybusN
+What:          /sys/bus/greybus/devices/greybusN
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -13,7 +13,7 @@ Contact:      Greg Kroah-Hartman <greg@kroah.com>
 Description:
                The ID of the "root" greybus device, or bus.
 
-What:          /sys/bus/greybus/device/N-M
+What:          /sys/bus/greybus/devices/N-M
 Date:          March 2016
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -21,7 +21,7 @@ Description:
                A Module M on the bus N, where M is the 1-byte interface
                ID of the module's primary interface.
 
-What:          /sys/bus/greybus/device/N-M/eject
+What:          /sys/bus/greybus/devices/N-M/eject
 Date:          March 2016
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -29,7 +29,7 @@ Description:
                Writing a non-zero argument to this attibute disables the
                module's interfaces before physically ejecting it.
 
-What:          /sys/bus/greybus/device/N-M/module_id
+What:          /sys/bus/greybus/devices/N-M/module_id
 Date:          March 2016
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -37,14 +37,14 @@ Description:
                The ID of a Greybus module, corresponding to the ID of its
                primary interface.
 
-What:          /sys/bus/greybus/device/N-M/num_interfaces
+What:          /sys/bus/greybus/devices/N-M/num_interfaces
 Date:          March 2016
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                The number of interfaces of a module.
 
-What:          /sys/bus/greybus/device/N-M.I
+What:          /sys/bus/greybus/devices/N-M.I
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -52,14 +52,14 @@ Description:
                An Interface I on the bus N and module N-M, where I is the
                1-byte interface ID.
 
-What:          /sys/bus/greybus/device/N-M.I/current_now
+What:          /sys/bus/greybus/devices/N-M.I/current_now
 Date:          March 2016
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                Current measurement of the interface in microamps (uA)
 
-What:          /sys/bus/greybus/device/N-M.I/ddbl1_manufacturer_id
+What:          /sys/bus/greybus/devices/N-M.I/ddbl1_manufacturer_id
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -67,7 +67,7 @@ Description:
                Unipro Device Descriptor Block Level 1 manufacturer ID for the
                greybus Interface.
 
-What:          /sys/bus/greybus/device/N-M.I/ddbl1_product_id
+What:          /sys/bus/greybus/devices/N-M.I/ddbl1_product_id
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -75,28 +75,36 @@ Description:
                Unipro Device Descriptor Block Level 1 product ID for the
                greybus Interface.
 
-What:          /sys/bus/greybus/device/N-M.I/interface_id
+What:          /sys/bus/greybus/devices/N-M.I/interface_id
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                The ID of a Greybus interface.
 
-What:          /sys/bus/greybus/device/N-M.I/power_now
+What:          /sys/bus/greybus/devices/N-M.I/interface_type
+Date:          June 2016
+KernelVersion: 4.XX
+Contact:       Greg Kroah-Hartman <greg@kroah.com>
+Description:
+               The type of a Greybus interface; "dummy", "unipro", "greybus",
+               or "unknown".
+
+What:          /sys/bus/greybus/devices/N-M.I/power_now
 Date:          March 2016
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                Power measurement of the interface in microwatts (uW)
 
-What:          /sys/bus/greybus/device/N-M.I/product_id
+What:          /sys/bus/greybus/devices/N-M.I/product_id
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                Product ID of a Greybus interface.
 
-What:          /sys/bus/greybus/device/N-M.I/serial_number
+What:          /sys/bus/greybus/devices/N-M.I/serial_number
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -104,29 +112,21 @@ Description:
                Serial Number of the Greybus interface, represented by a 64 bit
                hexadecimal number.
 
-What:          /sys/bus/greybus/device/N-M.I/vendor_id
+What:          /sys/bus/greybus/devices/N-M.I/vendor_id
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                Vendor ID of a Greybus interface.
 
-What:          /sys/bus/greybus/device/N-M.I/version
-Date:          October 2015
-KernelVersion: 4.XX
-Contact:       Greg Kroah-Hartman <greg@kroah.com>
-Description:
-               Interface version represented as <16 bit major number>.<16 bit
-               minor number>.
-
-What:          /sys/bus/greybus/device/N-M.I/voltage_now
+What:          /sys/bus/greybus/devices/N-M.I/voltage_now
 Date:          March 2016
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                Voltage measurement of the interface in microvolts (uV)
 
-What:          /sys/bus/greybus/device/N-M.I.ctrl
+What:          /sys/bus/greybus/devices/N-M.I.ctrl
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -134,21 +134,21 @@ Description:
                Abstract control device for interface I that represents the
                current mode of an enumerated Greybus interface.
 
-What:          /sys/bus/greybus/device/N-M.I.ctrl/product_string
+What:          /sys/bus/greybus/devices/N-M.I.ctrl/product_string
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                Product ID string of a Greybus interface.
 
-What:          /sys/bus/greybus/device/N-M.I.ctrl/vendor_string
+What:          /sys/bus/greybus/devices/N-M.I.ctrl/vendor_string
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                Vendor ID string of a Greybus interface.
 
-What:          /sys/bus/greybus/device/N-M.I.B
+What:          /sys/bus/greybus/devices/N-M.I.B
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -156,21 +156,29 @@ Description:
                A bundle B on the Interface I, B is replaced by a 1-byte
                number representing the bundle.
 
-What:          /sys/bus/greybus/device/N-M.I.B/bundle_class
+What:          /sys/bus/greybus/devices/N-M.I.B/bundle_class
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                The greybus class of the bundle B.
 
-What:          /sys/bus/greybus/device/N-M.I.B/bundle_id
+What:          /sys/bus/greybus/devices/N-M.I.B/bundle_id
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                The interface-unique id of the bundle B.
 
-What:          /sys/bus/greybus/device/N-M.I.B/state
+What:          /sys/bus/greybus/devices/N-M.I.B/gpbX
+Date:          April 2016
+KernelVersion: 4.XX
+Contact:       Greg Kroah-Hartman <greg@kroah.com>
+Description:
+               The General Purpose Bridged PHY device of the bundle B,
+               where X is a dynamically assigned 0-based id.
+
+What:          /sys/bus/greybus/devices/N-M.I.B/state
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -183,14 +191,14 @@ Description:
                value can be read. It's a "poor-man's IPC", yes, but
                simplifies the Android userspace code immensely.
 
-What:          /sys/bus/greybus/device/N-svc
+What:          /sys/bus/greybus/devices/N-svc
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                The singleton SVC device of bus N.
 
-What:          /sys/bus/greybus/device/N-svc/ap_intf_id
+What:          /sys/bus/greybus/devices/N-svc/ap_intf_id
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -200,7 +208,7 @@ Description:
                The interface positions are defined in the ARA
                Module Developer Kit.
 
-What:          /sys/bus/greybus/device/N-svc/endo_id
+What:          /sys/bus/greybus/devices/N-svc/endo_id
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -209,7 +217,7 @@ Description:
                defined by the Endo layout scheme, documented in
                the ARA Module Developer Kit.
 
-What:          /sys/bus/greybus/device/N-svc/intf_eject
+What:          /sys/bus/greybus/devices/N-svc/intf_eject
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
@@ -217,14 +225,14 @@ Description:
                Write the number of the interface that you wish to
                forcibly eject from the system.
 
-What:          /sys/bus/greybus/device/N-svc/version
+What:          /sys/bus/greybus/devices/N-svc/version
 Date:          October 2015
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>
 Description:
                The version number of the firmware in the SVC device.
 
-What:          /sys/bus/greybus/device/N-svc/watchdog
+What:          /sys/bus/greybus/devices/N-svc/watchdog
 Date:          October 2016
 KernelVersion: 4.XX
 Contact:       Greg Kroah-Hartman <greg@kroah.com>