[RFC,2/4] Documentation: ABI: Add sysfs-class-bmc documentation to testing

Commit Message

Andrew Jeffery July 3, 2018, 7:04 a.m. UTC

Signed-off-by: Andrew Jeffery <[e-mail]>
---
 Documentation/ABI/testing/sysfs-class-bmc | 62 +++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-bmc

Comments

Greg Kroah-Hartman July 3, 2018, 7:50 a.m. UTC | #1

On Tue, Jul 03, 2018 at 05:04:11PM +1000, Andrew Jeffery wrote:
> Signed-off-by: Andrew Jeffery <[e-mail]>

Same problem here :(

Andrew Jeffery July 4, 2018, 6:29 a.m. UTC | #2

On Tue, 3 Jul 2018, at 17:20, Greg KH wrote:
> On Tue, Jul 03, 2018 at 05:04:11PM +1000, Andrew Jeffery wrote:
> > Signed-off-by: Andrew Jeffery <[e-mail]>
> 
> Same problem here :(

Will fix.

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-bmc b/Documentation/ABI/testing/sysfs-class-bmc
new file mode 100644
index 000000000000..9d42106b89f9
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-bmc
@@ -0,0 +1,62 @@ 
+This document defines the sysfs attributes common to the bmc device class. See
+Documentation/devicetree/bindings/misc/bmc-misc-ctrl.txt for exhaustive list of
+field definitions.
+
+What:		/sys/class/bmc/<field>/label
+Date:		July, 2018
+KernelVersion:	v4.19
+Contact:	[e-mail]
+Description:
+		The name of the field of interest. Corresponds to the value of
+		<field> in the path
+Users:		[e-mail]
+
+What:		/sys/class/bmc/<field>/value
+Date:		July, 2018
+KernelVersion:	v4.19
+Contact:	[e-mail]
+Description:
+		The value of the field of interest.
+
+		If the field is exposed from a read-modify-write register this
+		attribute will be RW, where writes will set the field to the
+		value written. Writing values that exceed the width of the
+		field will return an error.
+
+		If the field is exposed from a write-1-set/write-1-clear
+		register this attribute will be RO, and the attributes 'set'
+		and 'clear' will be present as write-only.
+Users:		[e-mail]
+
+What:		/sys/class/bmc/<field>/mask
+Date:		July, 2018
+KernelVersion:	v4.19
+Contact:	[e-mail]
+Description:
+		The mask applied to the value read/written from the 'value'
+		attribute.
+Users:		[e-mail]
+
+What:		/sys/class/bmc/<field>/set
+Users:		[e-mail]
+Date:		July, 2018
+KernelVersion:	v4.19
+Contact:	[e-mail]
+Description:
+		For fields backed by write-1-set/write-1-clear registers,
+		set bits in the value written will be set in hardware. Zero
+		values are ignored. Writing values that exceed the width of the
+		mask value will return an error.
+Users:		[e-mail]
+
+What:		/sys/class/bmc/<field>/clear
+Users:		[e-mail]
+Date:		July, 2018
+KernelVersion:	v4.19
+Contact:	[e-mail]
+Description:
+		For fields backed by write-1-set/write-1-clear registers,
+		set bits in the value written will be cleared in hardware. Zero
+		values are ignored. Writing values that exceed the width of the
+		mask value will return an error.
+Users:		[e-mail]