greybus: connection: document the sysfs files
authorGreg Kroah-Hartman <greg@kroah.com>
Thu, 11 Dec 2014 22:11:00 +0000 (17:11 -0500)
committerGreg Kroah-Hartman <greg@kroah.com>
Fri, 12 Dec 2014 00:53:59 +0000 (19:53 -0500)
Document what the sysfs files are for connections, so that people have a
chance to understand what they can be used for.

Reviewed-by: Alex Elder <elder@linaro.org>
Signed-off-by: Greg Kroah-Hartman <greg@kroah.com>
drivers/staging/greybus/Documentation/sysfs-bus-greybus

index cd1d812..b734c67 100644 (file)
@@ -33,3 +33,23 @@ Contact:     Greg Kroah-Hartman <greg@kroah.com>
 Description:
                Vendor ID string of a Greybus interface block.
 
+What:          /sys/bus/greybus/device/.../state
+Date:          December 2014
+KernelVersion: 3.XX
+Contact:       Greg Kroah-Hartman <greg@kroah.com>
+Description:
+               The current state of a Greybus connection.
+
+               It will be one of the following values:
+               0 - invalid
+               1 - disabled
+               2 - enabled
+               3 - error
+               4 - destroying
+
+What:          /sys/bus/greybus/device/.../protocol_id
+Date:          December 2014
+KernelVersion: 3.XX
+Contact:       Greg Kroah-Hartman <greg@kroah.com>
+Description:
+               The protocol id of a Greybus connection.