xref: /linux/Documentation/ABI/testing/sysfs-edac-scrub (revision 26fd9f7b7ff3794c5de0e6ae538cead53118b4c3)
1What:		/sys/bus/edac/devices/<dev-name>/scrubX
2Date:		March 2025
3KernelVersion:	6.15
4Contact:	linux-edac@vger.kernel.org
5Description:
6		The sysfs EDAC bus devices /<dev-name>/scrubX subdirectory
7		belongs to an instance of memory scrub control feature,
8		where <dev-name> directory corresponds to a device/memory
9		region registered with the EDAC device driver for the
10		scrub control feature.
11
12		The sysfs scrub attr nodes are only present if the parent
13		driver has implemented the corresponding attr callback
14		function and provided the necessary operations to the EDAC
15		device driver during registration.
16
17What:		/sys/bus/edac/devices/<dev-name>/scrubX/addr
18Date:		March 2025
19KernelVersion:	6.15
20Contact:	linux-edac@vger.kernel.org
21Description:
22		(RW) The base address of the memory region to be scrubbed
23		for on-demand scrubbing. Setting address starts scrubbing.
24		The size must be set before that.
25
26		The readback addr value is non-zero if the requested
27		on-demand scrubbing is in progress, zero otherwise.
28
29What:		/sys/bus/edac/devices/<dev-name>/scrubX/size
30Date:		March 2025
31KernelVersion:	6.15
32Contact:	linux-edac@vger.kernel.org
33Description:
34		(RW) The size of the memory region to be scrubbed
35		(on-demand scrubbing).
36
37What:		/sys/bus/edac/devices/<dev-name>/scrubX/enable_background
38Date:		March 2025
39KernelVersion:	6.15
40Contact:	linux-edac@vger.kernel.org
41Description:
42		(RW) Start/Stop background (patrol) scrubbing if supported.
43
44What:		/sys/bus/edac/devices/<dev-name>/scrubX/min_cycle_duration
45Date:		March 2025
46KernelVersion:	6.15
47Contact:	linux-edac@vger.kernel.org
48Description:
49		(RO) Supported minimum scrub cycle duration in seconds
50		by the memory scrubber.
51
52		Device-based scrub: returns the minimum scrub cycle
53		supported by the memory device.
54
55		Region-based scrub: returns the max of minimum scrub cycles
56		supported by individual memory devices that back the region.
57
58What:		/sys/bus/edac/devices/<dev-name>/scrubX/max_cycle_duration
59Date:		March 2025
60KernelVersion:	6.15
61Contact:	linux-edac@vger.kernel.org
62Description:
63		(RO) Supported maximum scrub cycle duration in seconds
64		by the memory scrubber.
65
66		Device-based scrub: returns the maximum scrub cycle supported
67		by the memory device.
68
69		Region-based scrub: returns the min of maximum scrub cycles
70		supported by individual memory devices that back the region.
71
72		If the memory device does not provide maximum scrub cycle
73		information, return the maximum supported value of the scrub
74		cycle field.
75
76What:		/sys/bus/edac/devices/<dev-name>/scrubX/current_cycle_duration
77Date:		March 2025
78KernelVersion:	6.15
79Contact:	linux-edac@vger.kernel.org
80Description:
81		(RW) The current scrub cycle duration in seconds and must be
82		within the supported range by the memory scrubber.
83
84		Scrub has an overhead when running and that may want to be
85		reduced by taking longer to do it.
86