diff options
author | Mauro Carvalho Chehab <mchehab@redhat.com> | 2012-04-17 07:53:34 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2012-06-11 12:23:46 -0400 |
commit | 8b6f04ce6b9fb3aa8dd5dcd57d91be5d73e643a0 (patch) | |
tree | 482ee9b920ad1280c9c4bd2805c2a732a15852b2 /Documentation/edac.txt | |
parent | 356f0a30860d44de7ac021708caa0c8bd5688dbe (diff) |
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>
Diffstat (limited to 'Documentation/edac.txt')
-rw-r--r-- | Documentation/edac.txt | 112 |
1 files changed, 8 insertions, 104 deletions
diff --git a/Documentation/edac.txt b/Documentation/edac.txt index fdcc49fad8e1..c25f086a6960 100644 --- a/Documentation/edac.txt +++ b/Documentation/edac.txt | |||
@@ -232,116 +232,20 @@ EDAC control and attribute files. | |||
232 | 232 | ||
233 | 233 | ||
234 | In 'mcX' directories are EDAC control and attribute files for | 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 | |||
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 | 236 | ||
237 | For a description of the sysfs API, please see: | ||
238 | Documentation/ABI/testing/sysfs/devices-edac | ||
340 | 239 | ||
341 | 240 | ||
342 | ============================================================================ | 241 | ============================================================================ |
343 | 'csrowX' DIRECTORIES | 242 | 'csrowX' DIRECTORIES |
344 | 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. | ||
248 | |||
345 | In the 'csrowX' directories are EDAC control and attribute files for | 249 | In the 'csrowX' directories are EDAC control and attribute files for |
346 | this 'X' instance of csrow: | 250 | this 'X' instance of csrow: |
347 | 251 | ||