Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8b6f04ce authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

edac: move documentation ABI to ABI/testing/sysfs-devices-edac 



The EDAC MC API is currently stored at the wrong place. Move the
parts of the EDAC MC ABI that will be kept to
ABI/testing/sysfs-devices-edac.

The Date: field were added based on git timestamps for the git
commit patches that added the functionality at edac.txt.

Acked-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent 356f0a30

Documentation/ABI/testing/sysfs-devices-edac

0 → 100644
+76 −0
Original line number Diff line number Diff line 
What:		/sys/devices/system/edac/mc/mc*/reset_counters

Date:		January 2006

Contact:	linux-edac@vger.kernel.org

Description:	This write-only control file will zero all the statistical

		counters for UE and CE errors on the given memory controller.

		Zeroing the counters will also reset the timer indicating how

		long since the last counter were reset. This is useful for

		computing errors/time.  Since the counters are always reset

		at driver initialization time, no module/kernel parameter

		is available.



What:		/sys/devices/system/edac/mc/mc*/seconds_since_reset

Date:		January 2006

Contact:	linux-edac@vger.kernel.org

Description:	This attribute file displays how many seconds have elapsed

		since the last counter reset. This can be used with the error

		counters to measure error rates.



What:		/sys/devices/system/edac/mc/mc*/mc_name

Date:		January 2006

Contact:	linux-edac@vger.kernel.org

Description:	This attribute file displays the type of memory controller

		that is being utilized.



What:		/sys/devices/system/edac/mc/mc*/size_mb

Date:		January 2006

Contact:	linux-edac@vger.kernel.org

Description:	This attribute file displays, in count of megabytes, of memory

		that this memory controller manages.



What:		/sys/devices/system/edac/mc/mc*/ue_count

Date:		January 2006

Contact:	linux-edac@vger.kernel.org

Description:	This attribute file displays the total count of uncorrectable

		errors that have occurred on this memory controller. If

		panic_on_ue is set, this counter will not have a chance to

		increment, since EDAC will panic the system



What:		/sys/devices/system/edac/mc/mc*/ue_noinfo_count

Date:		January 2006

Contact:	linux-edac@vger.kernel.org

Description:	This attribute file displays the number of UEs that have

		occurred on this memory controller with no information as to

		which DIMM slot is having errors.



What:		/sys/devices/system/edac/mc/mc*/ce_count

Date:		January 2006

Contact:	linux-edac@vger.kernel.org

Description:	This attribute file displays the total count of correctable

		errors that have occurred on this memory controller. This

		count is very important to examine. CEs provide early

		indications that a DIMM is beginning to fail. This count

		field should be monitored for non-zero values and report

		such information to the system administrator.



What:		/sys/devices/system/edac/mc/mc*/ce_noinfo_count

Date:		January 2006

Contact:	linux-edac@vger.kernel.org

Description:	This attribute file displays the number of CEs that

		have occurred on this memory controller wherewith no

		information as to which DIMM slot is having errors. Memory is

		handicapped, but operational, yet no information is available

		to indicate which slot the failing memory is in. This count

		field should be also be monitored for non-zero values.



What:		/sys/devices/system/edac/mc/mc*/sdram_scrub_rate

Date:		February 2007

Contact:	linux-edac@vger.kernel.org

Description:	Read/Write attribute file that controls memory scrubbing.

		The scrubbing rate used by the memory controller is set by

		writing a minimum bandwidth in bytes/sec to the attribute file.

		The rate will be translated to an internal value that gives at

		least the specified rate.

		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.

Documentation/edac.txt

+8 −104
Original line number Diff line number Diff line
@@ -232,116 +232,20 @@ EDAC control and attribute files. 




In 'mcX' directories are EDAC control and attribute files for

this 'X' instance of the memory controllers:





Counter reset control file:



	'reset_counters'



	This write-only control file will zero all the statistical counters

	for UE and CE errors.  Zeroing the counters will also reset the timer

	indicating how long since the last counter zero.  This is useful

	for computing errors/time.  Since the counters are always reset at

	driver initialization time, no module/kernel parameter is available.



	RUN TIME: echo "anything" >/sys/devices/system/edac/mc/mc0/counter_reset



		This resets the counters on memory controller 0





Seconds since last counter reset control file:



	'seconds_since_reset'



	This attribute file displays how many seconds have elapsed since the

	last counter reset. This can be used with the error counters to

	measure error rates.







Memory Controller name attribute file:



	'mc_name'



	This attribute file displays the type of memory controller

	that is being utilized.





Total memory managed by this memory controller attribute file:



	'size_mb'



	This attribute file displays, in count of megabytes, of memory

	that this instance of memory controller manages.





Total Uncorrectable Errors count attribute file:



	'ue_count'



	This attribute file displays the total count of uncorrectable

	errors that have occurred on this memory controller. If panic_on_ue

	is set this counter will not have a chance to increment,

	since EDAC will panic the system.





Total UE count that had no information attribute fileY:



	'ue_noinfo_count'



	This attribute file displays the number of UEs that have occurred

	with no information as to which DIMM slot is having errors.





Total Correctable Errors count attribute file:



	'ce_count'



	This attribute file displays the total count of correctable

	errors that have occurred on this memory controller. This

	count is very important to examine. CEs provide early

	indications that a DIMM is beginning to fail. This count

	field should be monitored for non-zero values and report

	such information to the system administrator.





Total Correctable Errors count attribute file:



	'ce_noinfo_count'



	This attribute file displays the number of CEs that

	have occurred wherewith no information as to which DIMM slot

	is having errors. Memory is handicapped, but operational,

	yet no information is available to indicate which slot

	the failing memory is in. This count field should be also

	be monitored for non-zero values.



Device Symlink:



	'device'



	Symlink to the memory controller device.



Sdram memory scrubbing rate:



	'sdram_scrub_rate'



	Read/Write attribute file that controls memory scrubbing. The scrubbing

	rate is set by writing a minimum bandwidth in bytes/sec to the attribute

	file. The rate will be translated to an internal value that gives at

	least the specified rate.



	Reading the file will return the actual scrubbing rate employed.



	If configuration fails or memory scrubbing is not implemented, accessing

	that attribute will fail.

this 'X' instance of the memory controllers.



For a description of the sysfs API, please see:

	Documentation/ABI/testing/sysfs/devices-edac





============================================================================

'csrowX' DIRECTORIES



When CONFIG_EDAC_LEGACY_SYSFS is enabled, the sysfs will contain the

csrowX directories. As this API doesn't work properly for Rambus, FB-DIMMs

and modern Intel Memory Controllers, this is being deprecated in favor

of dimmX directories.



In the 'csrowX' directories are EDAC control and attribute files for

this 'X' instance of csrow: