Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

+84 -104
+76
Documentation/ABI/testing/sysfs-devices-edac
··· 1 + What: /sys/devices/system/edac/mc/mc*/reset_counters 2 + Date: January 2006 3 + Contact: linux-edac@vger.kernel.org 4 + Description: This write-only control file will zero all the statistical 5 + counters for UE and CE errors on the given memory controller. 6 + Zeroing the counters will also reset the timer indicating how 7 + long since the last counter were reset. This is useful for 8 + computing errors/time. Since the counters are always reset 9 + at driver initialization time, no module/kernel parameter 10 + is available. 11 + 12 + What: /sys/devices/system/edac/mc/mc*/seconds_since_reset 13 + Date: January 2006 14 + Contact: linux-edac@vger.kernel.org 15 + Description: This attribute file displays how many seconds have elapsed 16 + since the last counter reset. This can be used with the error 17 + counters to measure error rates. 18 + 19 + What: /sys/devices/system/edac/mc/mc*/mc_name 20 + Date: January 2006 21 + Contact: linux-edac@vger.kernel.org 22 + Description: This attribute file displays the type of memory controller 23 + that is being utilized. 24 + 25 + What: /sys/devices/system/edac/mc/mc*/size_mb 26 + Date: January 2006 27 + Contact: linux-edac@vger.kernel.org 28 + Description: This attribute file displays, in count of megabytes, of memory 29 + that this memory controller manages. 30 + 31 + What: /sys/devices/system/edac/mc/mc*/ue_count 32 + Date: January 2006 33 + Contact: linux-edac@vger.kernel.org 34 + Description: This attribute file displays the total count of uncorrectable 35 + errors that have occurred on this memory controller. If 36 + panic_on_ue is set, this counter will not have a chance to 37 + increment, since EDAC will panic the system 38 + 39 + What: /sys/devices/system/edac/mc/mc*/ue_noinfo_count 40 + Date: January 2006 41 + Contact: linux-edac@vger.kernel.org 42 + Description: This attribute file displays the number of UEs that have 43 + occurred on this memory controller with no information as to 44 + which DIMM slot is having errors. 45 + 46 + What: /sys/devices/system/edac/mc/mc*/ce_count 47 + Date: January 2006 48 + Contact: linux-edac@vger.kernel.org 49 + Description: This attribute file displays the total count of correctable 50 + errors that have occurred on this memory controller. This 51 + count is very important to examine. CEs provide early 52 + indications that a DIMM is beginning to fail. This count 53 + field should be monitored for non-zero values and report 54 + such information to the system administrator. 55 + 56 + What: /sys/devices/system/edac/mc/mc*/ce_noinfo_count 57 + Date: January 2006 58 + Contact: linux-edac@vger.kernel.org 59 + Description: This attribute file displays the number of CEs that 60 + have occurred on this memory controller wherewith no 61 + information as to which DIMM slot is having errors. Memory is 62 + handicapped, but operational, yet no information is available 63 + to indicate which slot the failing memory is in. This count 64 + field should be also be monitored for non-zero values. 65 + 66 + What: /sys/devices/system/edac/mc/mc*/sdram_scrub_rate 67 + Date: February 2007 68 + Contact: linux-edac@vger.kernel.org 69 + Description: Read/Write attribute file that controls memory scrubbing. 70 + The scrubbing rate used by the memory controller is set by 71 + writing a minimum bandwidth in bytes/sec to the attribute file. 72 + The rate will be translated to an internal value that gives at 73 + least the specified rate. 74 + Reading the file will return the actual scrubbing rate employed. 75 + If configuration fails or memory scrubbing is not implemented, 76 + the value of the attribute file will be -1.
+8 -104
Documentation/edac.txt
··· 232 232 233 233 234 234 In 'mcX' directories are EDAC control and attribute files for 235 - this 'X' instance of the memory controllers: 235 + this 'X' instance of the memory controllers. 236 236 237 - 238 - Counter reset control file: 239 - 240 - 'reset_counters' 241 - 242 - This write-only control file will zero all the statistical counters 243 - for UE and CE errors. Zeroing the counters will also reset the timer 244 - indicating how long since the last counter zero. This is useful 245 - for computing errors/time. Since the counters are always reset at 246 - driver initialization time, no module/kernel parameter is available. 247 - 248 - RUN TIME: echo "anything" >/sys/devices/system/edac/mc/mc0/counter_reset 249 - 250 - This resets the counters on memory controller 0 251 - 252 - 253 - Seconds since last counter reset control file: 254 - 255 - 'seconds_since_reset' 256 - 257 - This attribute file displays how many seconds have elapsed since the 258 - last counter reset. This can be used with the error counters to 259 - measure error rates. 260 - 261 - 262 - 263 - Memory Controller name attribute file: 264 - 265 - 'mc_name' 266 - 267 - This attribute file displays the type of memory controller 268 - that is being utilized. 269 - 270 - 271 - Total memory managed by this memory controller attribute file: 272 - 273 - 'size_mb' 274 - 275 - This attribute file displays, in count of megabytes, of memory 276 - that this instance of memory controller manages. 277 - 278 - 279 - Total Uncorrectable Errors count attribute file: 280 - 281 - 'ue_count' 282 - 283 - This attribute file displays the total count of uncorrectable 284 - errors that have occurred on this memory controller. If panic_on_ue 285 - is set this counter will not have a chance to increment, 286 - since EDAC will panic the system. 287 - 288 - 289 - Total UE count that had no information attribute fileY: 290 - 291 - 'ue_noinfo_count' 292 - 293 - This attribute file displays the number of UEs that have occurred 294 - with no information as to which DIMM slot is having errors. 295 - 296 - 297 - Total Correctable Errors count attribute file: 298 - 299 - 'ce_count' 300 - 301 - This attribute file displays the total count of correctable 302 - errors that have occurred on this memory controller. This 303 - count is very important to examine. CEs provide early 304 - indications that a DIMM is beginning to fail. This count 305 - field should be monitored for non-zero values and report 306 - such information to the system administrator. 307 - 308 - 309 - Total Correctable Errors count attribute file: 310 - 311 - 'ce_noinfo_count' 312 - 313 - This attribute file displays the number of CEs that 314 - have occurred wherewith no information as to which DIMM slot 315 - is having errors. Memory is handicapped, but operational, 316 - yet no information is available to indicate which slot 317 - the failing memory is in. This count field should be also 318 - be monitored for non-zero values. 319 - 320 - Device Symlink: 321 - 322 - 'device' 323 - 324 - Symlink to the memory controller device. 325 - 326 - Sdram memory scrubbing rate: 327 - 328 - 'sdram_scrub_rate' 329 - 330 - Read/Write attribute file that controls memory scrubbing. The scrubbing 331 - rate is set by writing a minimum bandwidth in bytes/sec to the attribute 332 - file. The rate will be translated to an internal value that gives at 333 - least the specified rate. 334 - 335 - Reading the file will return the actual scrubbing rate employed. 336 - 337 - If configuration fails or memory scrubbing is not implemented, accessing 338 - that attribute will fail. 339 - 237 + For a description of the sysfs API, please see: 238 + Documentation/ABI/testing/sysfs/devices-edac 340 239 341 240 342 241 ============================================================================ 343 242 'csrowX' DIRECTORIES 243 + 244 + When CONFIG_EDAC_LEGACY_SYSFS is enabled, the sysfs will contain the 245 + csrowX directories. As this API doesn't work properly for Rambus, FB-DIMMs 246 + and modern Intel Memory Controllers, this is being deprecated in favor 247 + of dimmX directories. 344 248 345 249 In the 'csrowX' directories are EDAC control and attribute files for 346 250 this 'X' instance of csrow: