Edac: Add ABI Documentation for the new device nodes

The EDAC ABI were extended to add support for per-DIMM or per-rank
information and silkscreen labels. Properly document them.

Most of the comments there came from edac.txt descriptions of the
fields that are part of the legacy csrowX ABI (e. g.
/sys/devices/system/edac/mc/mc*/csrow*/*).

Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

1 files changed, 64 insertions, 0 deletions

diff --git a/Documentation/ABI/testing/sysfs-devices-edac b/Documentation/ABI/testing/sysfs-devices-edac
index 40db633b00f6..30ee78aaed75 100644
--- a/Documentation/ABI/testing/sysfs-devices-edac
+++ b/Documentation/ABI/testing/sysfs-devices-edac
@@ -74,3 +74,67 @@ Description:	Read/Write attribute file that controls memory scrubbing.
                 Reading the file will return the actual scrubbing rate employed.
                 If configuration fails or memory scrubbing is not implemented,
                 the value of the attribute file will be -1.
+
+What:           /sys/devices/system/edac/mc/mc*/max_location
+Date:           April 2012
+Contact:        Mauro Carvalho Chehab <mchehab@redhat.com>
+                linux-edac@vger.kernel.org
+Description:    This attribute file displays the information about the last
+                available memory slot in this memory controller. It is used by
+                userspace tools in order to display the memory filling layout.
+
+What:           /sys/devices/system/edac/mc/mc*/(dimm|rank)*/size
+Date:           April 2012
+Contact:        Mauro Carvalho Chehab <mchehab@redhat.com>
+                linux-edac@vger.kernel.org
+Description:    This attribute file will display the size of dimm or rank.
+                For dimm*/size, this is the size, in MB of the DIMM memory
+                stick. For rank*/size, this is the size, in MB for one rank
+                of the DIMM memory stick. On single rank memories (1R), this
+                is also the total size of the dimm. On dual rank (2R) memories,
+                this is half the size of the total DIMM memories.
+
+What:           /sys/devices/system/edac/mc/mc*/(dimm|rank)*/dimm_dev_type
+Date:           April 2012
+Contact:        Mauro Carvalho Chehab <mchehab@redhat.com>
+                linux-edac@vger.kernel.org
+Description:    This attribute file will display what type of DRAM device is
+                being utilized on this DIMM (x1, x2, x4, x8, ...).
+
+What:           /sys/devices/system/edac/mc/mc*/(dimm|rank)*/dimm_edac_mode
+Date:           April 2012
+Contact:        Mauro Carvalho Chehab <mchehab@redhat.com>
+                linux-edac@vger.kernel.org
+Description:    This attribute file will display what type of Error detection
+                and correction is being utilized. For example: S4ECD4ED would
+                mean a Chipkill with x4 DRAM.
+
+What:           /sys/devices/system/edac/mc/mc*/(dimm|rank)*/dimm_label
+Date:           April 2012
+Contact:        Mauro Carvalho Chehab <mchehab@redhat.com>
+                linux-edac@vger.kernel.org
+Description:    This control file allows this DIMM to have a label assigned
+                to it. With this label in the module, when errors occur
+                the output can provide the DIMM label in the system log.
+                This becomes vital for panic events to isolate the
+                cause of the UE event.
+                DIMM Labels must be assigned after booting, with information
+                that correctly identifies the physical slot with its
+                silk screen label. This information is currently very
+                motherboard specific and determination of this information
+                must occur in userland at this time.
+
+What:           /sys/devices/system/edac/mc/mc*/(dimm|rank)*/dimm_location
+Date:           April 2012
+Contact:        Mauro Carvalho Chehab <mchehab@redhat.com>
+                linux-edac@vger.kernel.org
+Description:    This attribute file will display the location (csrow/channel,
+                branch/channel/slot or channel/slot) of the dimm or rank.
+
+What:           /sys/devices/system/edac/mc/mc*/(dimm|rank)*/dimm_mem_type
+Date:           April 2012
+Contact:        Mauro Carvalho Chehab <mchehab@redhat.com>
+                linux-edac@vger.kernel.org
+Description:    This attribute file will display what type of memory is
+                currently on this csrow. Normally, either buffered or
+                unbuffered memory (for example, Unbuffered-DDR3).