Blame view

Documentation/edac.txt 26.9 KB
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
1
2
3
  
  
  EDAC - Error Detection And Correction
87f24c3ac   Doug Thompson   drivers/edac: add...
4
  Written by Doug Thompson <dougthompson@xmission.com>
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
5
  7 Dec 2005
87f24c3ac   Doug Thompson   drivers/edac: add...
6
  17 Jul 2007	Updated
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
7

31983a04d   Mauro Carvalho Chehab   Documentation/eda...
8
9
  (c) Mauro Carvalho Chehab <mchehab@redhat.com>
  05 Aug 2009	Nehalem interface
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
10

87f24c3ac   Doug Thompson   drivers/edac: add...
11
  EDAC is maintained and written by:
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
12

87f24c3ac   Doug Thompson   drivers/edac: add...
13
14
15
16
17
18
19
20
21
22
23
24
25
  	Doug Thompson, Dave Jiang, Dave Peterson et al,
  	original author: Thayne Harbaugh,
  
  Contact:
  	website:	bluesmoke.sourceforge.net
  	mailing list:	bluesmoke-devel@lists.sourceforge.net
  
  "bluesmoke" was the name for this device driver when it was "out-of-tree"
  and maintained at sourceforge.net.  When it was pushed into 2.6.16 for the
  first time, it was renamed to 'EDAC'.
  
  The bluesmoke project at sourceforge.net is now utilized as a 'staging area'
  for EDAC development, before it is sent upstream to kernel.org
19f594600   Matt LaPlante   trivial: Miscella...
26
27
  At the bluesmoke/EDAC project site is a series of quilt patches against
  recent kernels, stored in a SVN repository. For easier downloading, there
87f24c3ac   Doug Thompson   drivers/edac: add...
28
  is also a tarball snapshot available.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
29
30
31
32
33
  
  ============================================================================
  EDAC PURPOSE
  
  The 'edac' kernel module goal is to detect and report errors that occur
87f24c3ac   Doug Thompson   drivers/edac: add...
34
35
36
37
38
39
40
  within the computer system running under linux.
  
  MEMORY
  
  In the initial release, memory Correctable Errors (CE) and Uncorrectable
  Errors (UE) are the primary errors being harvested. These types of errors
  are harvested by the 'edac_mc' class of device.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
41
42
43
  
  Detecting CE events, then harvesting those events and reporting them,
  CAN be a predictor of future UE events.  With CE events, the system can
f3479816b   Dave Peterson   [PATCH] EDAC: doc...
44
  continue to operate, but with less safety. Preventive maintenance and
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
45
46
  proactive part replacement of memory DIMMs exhibiting CEs can reduce
  the likelihood of the dreaded UE events and system 'panics'.
87f24c3ac   Doug Thompson   drivers/edac: add...
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
  NON-MEMORY
  
  A new feature for EDAC, the edac_device class of device, was added in
  the 2.6.23 version of the kernel.
  
  This new device type allows for non-memory type of ECC hardware detectors
  to have their states harvested and presented to userspace via the sysfs
  interface.
  
  Some architectures have ECC detectors for L1, L2 and L3 caches, along with DMA
  engines, fabric switches, main data path switches, interconnections,
  and various other hardware data paths. If the hardware reports it, then
  a edac_device device probably can be constructed to harvest and present
  that to userspace.
  
  
  PCI BUS SCANNING
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
64
65
66
  
  In addition, PCI Bus Parity and SERR Errors are scanned for on PCI devices
  in order to determine if errors are occurring on data transfers.
87f24c3ac   Doug Thompson   drivers/edac: add...
67

da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
68
  The presence of PCI Parity errors must be examined with a grain of salt.
f3479816b   Dave Peterson   [PATCH] EDAC: doc...
69
  There are several add-in adapters that do NOT follow the PCI specification
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
70
71
72
73
  with regards to Parity generation and reporting. The specification says
  the vendor should tie the parity status bits to 0 if they do not intend
  to generate parity.  Some vendors do not do this, and thus the parity bit
  can "float" giving false positives.
19f594600   Matt LaPlante   trivial: Miscella...
74
  In the kernel there is a PCI device attribute located in sysfs that is
87f24c3ac   Doug Thompson   drivers/edac: add...
75
  checked by the EDAC PCI scanning code. If that attribute is set,
19f594600   Matt LaPlante   trivial: Miscella...
76
  PCI parity/error scanning is skipped for that device. The attribute
87f24c3ac   Doug Thompson   drivers/edac: add...
77
78
79
  is:
  
  	broken_parity_status
e281d75e2   Davidlohr Bueso   fix typos/grammos...
80
  as is located in /sys/devices/pci<XXX>/0000:XX:YY.Z directories for
87f24c3ac   Doug Thompson   drivers/edac: add...
81
82
83
  PCI devices.
  
  FUTURE HARDWARE SCANNING
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
84

49c0dab7e   Doug Thompson   [PATCH] Fix and e...
85
86
  EDAC will have future error detectors that will be integrated with
  EDAC or added to it, in the following list:
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
87
88
89
90
91
92
93
94
95
96
97
98
99
  
  	MCE	Machine Check Exception
  	MCA	Machine Check Architecture
  	NMI	NMI notification of ECC errors
  	MSRs 	Machine Specific Register error cases
  	and other mechanisms.
  
  These errors are usually bus errors, ECC errors, thermal throttling
  and the like.
  
  
  ============================================================================
  EDAC VERSIONING
87f24c3ac   Doug Thompson   drivers/edac: add...
100
  EDAC is composed of a "core" module (edac_core.ko) and several Memory
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
101
102
  Controller (MC) driver modules. On a given system, the CORE
  is loaded and one MC driver will be loaded. Both the CORE and
87f24c3ac   Doug Thompson   drivers/edac: add...
103
104
105
106
107
  the MC driver (or edac_device driver) have individual versions that reflect
  current release level of their respective modules.
  
  Thus, to "report" on what version a system is running, one must report both
  the CORE's and the MC driver's versions.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
  
  
  LOADING
  
  If 'edac' was statically linked with the kernel then no loading is
  necessary.  If 'edac' was built as modules then simply modprobe the
  'edac' pieces that you need.  You should be able to modprobe
  hardware-specific modules and have the dependencies load the necessary core
  modules.
  
  Example:
  
  $> modprobe amd76x_edac
  
  loads both the amd76x_edac.ko memory controller module and the edac_mc.ko
  core module.
  
  
  ============================================================================
  EDAC sysfs INTERFACE
  
  EDAC presents a 'sysfs' interface for control, reporting and attribute
  reporting purposes.
87f24c3ac   Doug Thompson   drivers/edac: add...
131
132
133
  EDAC lives in the /sys/devices/system/edac directory.
  
  Within this directory there currently reside 2 'edac' components:
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
134
135
  
  	mc	memory controller(s) system
49c0dab7e   Doug Thompson   [PATCH] Fix and e...
136
  	pci	PCI control and status system
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
137
138
139
140
141
142
  
  
  ============================================================================
  Memory Controller (mc) Model
  
  First a background on the memory controller's model abstracted in EDAC.
49c0dab7e   Doug Thompson   [PATCH] Fix and e...
143
  Each 'mc' device controls a set of DIMM memory modules. These modules are
f3479816b   Dave Peterson   [PATCH] EDAC: doc...
144
  laid out in a Chip-Select Row (csrowX) and Channel table (chX). There can
49c0dab7e   Doug Thompson   [PATCH] Fix and e...
145
  be multiple csrows and multiple channels.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
146
147
148
149
150
151
  
  Memory controllers allow for several csrows, with 8 csrows being a typical value.
  Yet, the actual number of csrows depends on the electrical "loading"
  of a given motherboard, memory controller and DIMM characteristics.
  
  Dual channels allows for 128 bit data transfers to the CPU from memory.
49c0dab7e   Doug Thompson   [PATCH] Fix and e...
152
153
  Some newer chipsets allow for more than 2 channels, like Fully Buffered DIMMs
  (FB-DIMMs). The following example will assume 2 channels:
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
  
  
  		Channel 0	Channel 1
  	===================================
  	csrow0	| DIMM_A0	| DIMM_B0 |
  	csrow1	| DIMM_A0	| DIMM_B0 |
  	===================================
  
  	===================================
  	csrow2	| DIMM_A1	| DIMM_B1 |
  	csrow3	| DIMM_A1	| DIMM_B1 |
  	===================================
  
  In the above example table there are 4 physical slots on the motherboard
  for memory DIMMs:
  
  	DIMM_A0
  	DIMM_B0
  	DIMM_A1
  	DIMM_B1
  
  Labels for these slots are usually silk screened on the motherboard. Slots
f3479816b   Dave Peterson   [PATCH] EDAC: doc...
176
  labeled 'A' are channel 0 in this example. Slots labeled 'B'
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
177
178
179
180
181
182
183
184
  are channel 1. Notice that there are two csrows possible on a
  physical DIMM. These csrows are allocated their csrow assignment
  based on the slot into which the memory DIMM is placed. Thus, when 1 DIMM
  is placed in each Channel, the csrows cross both DIMMs.
  
  Memory DIMMs come single or dual "ranked". A rank is a populated csrow.
  Thus, 2 single ranked DIMMs, placed in slots DIMM_A0 and DIMM_B0 above
  will have 1 csrow, csrow0. csrow1 will be empty. On the other hand,
f3479816b   Dave Peterson   [PATCH] EDAC: doc...
185
  when 2 dual ranked DIMMs are similarly placed, then both csrow0 and
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
186
187
188
189
190
191
  csrow1 will be populated. The pattern repeats itself for csrow2 and
  csrow3.
  
  The representation of the above is reflected in the directory tree
  in EDAC's sysfs interface. Starting in directory
  /sys/devices/system/edac/mc each memory controller will be represented
5989f11ba   Raoul Bhatia   EDAC: Fix typos i...
192
  by its own 'mcX' directory, where 'X' is the index of the MC.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
193
194
195
196
197
198
199
200
201
202
  
  
  	..../edac/mc/
  		   |
  		   |->mc0
  		   |->mc1
  		   |->mc2
  		   ....
  
  Under each 'mcX' directory each 'csrowX' is again represented by a
5989f11ba   Raoul Bhatia   EDAC: Fix typos i...
203
  'csrowX', where 'X' is the csrow index:
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
204
205
206
207
208
209
210
211
212
213
214
215
216
217
  
  
  	.../mc/mc0/
  		|
  		|->csrow0
  		|->csrow2
  		|->csrow3
  		....
  
  Notice that there is no csrow1, which indicates that csrow0 is
  composed of a single ranked DIMMs. This should also apply in both
  Channels, in order to have dual-channel mode be operational. Since
  both csrow2 and csrow3 are populated, this indicates a dual ranked
  set of DIMMs for channels 0 and 1.
327dafb1c   Arthur Jones   edac: core fix re...
218
  Within each of the 'mcX' and 'csrowX' directories are several
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
219
  EDAC control and attribute files.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
220
221
222
223
224
  ============================================================================
  'mcX' DIRECTORIES
  
  
  In 'mcX' directories are EDAC control and attribute files for
5989f11ba   Raoul Bhatia   EDAC: Fix typos i...
225
  this 'X' instance of the memory controllers:
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
  
  
  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.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
250
251
252
253
254
255
  Memory Controller name attribute file:
  
  	'mc_name'
  
  	This attribute file displays the type of memory controller
  	that is being utilized.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
  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'
e281d75e2   Davidlohr Bueso   fix typos/grammos...
277
278
  	This attribute file displays the number of UEs that have occurred
  	with no information as to which DIMM slot is having errors.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
  
  
  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
f65e51d74   Sylvestre Ledru   Documentation: fi...
298
  	have occurred wherewith no information as to which DIMM slot
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
299
300
301
302
303
304
305
306
  	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'
4f423ddf5   Frithiof Jensen   [PATCH] EDAC: Add...
307
308
309
310
311
312
313
  	Symlink to the memory controller device.
  
  Sdram memory scrubbing rate:
  
  	'sdram_scrub_rate'
  
  	Read/Write attribute file that controls memory scrubbing. The scrubbing
d91958815   Matt LaPlante   Documentation cle...
314
  	rate is set by writing a minimum bandwidth in bytes/sec to the attribute
4f423ddf5   Frithiof Jensen   [PATCH] EDAC: Add...
315
316
317
318
319
320
321
  	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.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
322
323
324
325
326
327
328
  
  
  
  ============================================================================
  'csrowX' DIRECTORIES
  
  In the 'csrowX' directories are EDAC control and attribute files for
5989f11ba   Raoul Bhatia   EDAC: Fix typos i...
329
  this 'X' instance of csrow:
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
  
  
  Total Uncorrectable Errors count attribute file:
  
  	'ue_count'
  
  	This attribute file displays the total count of uncorrectable
  	errors that have occurred on this csrow. If panic_on_ue is set
  	this counter will not have a chance to increment, since EDAC
  	will panic the system.
  
  
  Total Correctable Errors count attribute file:
  
  	'ce_count'
  
  	This attribute file displays the total count of correctable
  	errors that have occurred on this csrow. 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 memory managed by this csrow attribute file:
  
  	'size_mb'
  
  	This attribute file displays, in count of megabytes, of memory
f3479816b   Dave Peterson   [PATCH] EDAC: doc...
359
  	that this csrow contains.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
360
361
362
363
364
365
366
367
  
  
  Memory Type attribute file:
  
  	'mem_type'
  
  	This attribute file will display what type of memory is currently
  	on this csrow. Normally, either buffered or unbuffered memory.
49c0dab7e   Doug Thompson   [PATCH] Fix and e...
368
369
370
  	Examples:
  		Registered-DDR
  		Unbuffered-DDR
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
371
372
373
374
375
376
377
378
379
380
381
382
383
  
  
  EDAC Mode of operation attribute file:
  
  	'edac_mode'
  
  	This attribute file will display what type of Error detection
  	and correction is being utilized.
  
  
  Device type attribute file:
  
  	'dev_type'
49c0dab7e   Doug Thompson   [PATCH] Fix and e...
384
385
386
387
388
389
390
  	This attribute file will display what type of DRAM device is
  	being utilized on this DIMM.
  	Examples:
  		x1
  		x2
  		x4
  		x8
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
  
  
  Channel 0 CE Count attribute file:
  
  	'ch0_ce_count'
  
  	This attribute file will display the count of CEs on this
  	DIMM located in channel 0.
  
  
  Channel 0 UE Count attribute file:
  
  	'ch0_ue_count'
  
  	This attribute file will display the count of UEs on this
  	DIMM located in channel 0.
  
  
  Channel 0 DIMM Label control file:
  
  	'ch0_dimm_label'
  
  	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.
  
  
  Channel 1 CE Count attribute file:
  
  	'ch1_ce_count'
  
  	This attribute file will display the count of CEs on this
  	DIMM located in channel 1.
  
  
  Channel 1 UE Count attribute file:
  
  	'ch1_ue_count'
  
  	This attribute file will display the count of UEs on this
  	DIMM located in channel 0.
  
  
  Channel 1 DIMM Label control file:
  
  	'ch1_dimm_label'
  
  	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.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
457
458
459
460
461
  ============================================================================
  SYSTEM LOGGING
  
  If logging for UEs and CEs are enabled then system logs will have
  error notices indicating errors that have been detected:
49c0dab7e   Doug Thompson   [PATCH] Fix and e...
462
  EDAC MC0: CE page 0x283, offset 0xce0, grain 8, syndrome 0x6ec3, row 0,
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
463
  channel 1 "DIMM_B1": amd76x_edac
49c0dab7e   Doug Thompson   [PATCH] Fix and e...
464
  EDAC MC0: CE page 0x1e5, offset 0xfb0, grain 8, syndrome 0xb741, row 0,
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
  channel 1 "DIMM_B1": amd76x_edac
  
  
  The structure of the message is:
  	the memory controller			(MC0)
  	Error type				(CE)
  	memory page				(0x283)
  	offset in the page			(0xce0)
  	the byte granularity 			(grain 8)
  		or resolution of the error
  	the error syndrome			(0xb741)
  	memory row				(row 0)
  	memory channel				(channel 1)
  	DIMM label, if set prior		(DIMM B1
  	and then an optional, driver-specific message that may
  		have additional information.
  
  Both UEs and CEs with no info will lack all but memory controller,
  error type, a notice of "no info" and then an optional,
  driver-specific error message.
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
485
486
487
488
489
490
491
492
  ============================================================================
  PCI Bus Parity Detection
  
  
  On Header Type 00 devices the primary status is looked at
  for any parity error regardless of whether Parity is enabled on the
  device.  (The spec indicates parity is generated in some cases).
  On Header Type 01 bridges, the secondary status register is also
f3479816b   Dave Peterson   [PATCH] EDAC: doc...
493
  looked at to see if parity occurred on the bus on the other side of
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
  the bridge.
  
  
  SYSFS CONFIGURATION
  
  Under /sys/devices/system/edac/pci are control and attribute files as follows:
  
  
  Enable/Disable PCI Parity checking control file:
  
  	'check_pci_parity'
  
  
  	This control file enables or disables the PCI Bus Parity scanning
  	operation. Writing a 1 to this file enables the scanning. Writing
  	a 0 to this file disables the scanning.
  
  	Enable:
  	echo "1" >/sys/devices/system/edac/pci/check_pci_parity
  
  	Disable:
  	echo "0" >/sys/devices/system/edac/pci/check_pci_parity
327dafb1c   Arthur Jones   edac: core fix re...
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
  Parity Count:
  
  	'pci_parity_count'
  
  	This attribute file will display the number of parity errors that
  	have been detected.
  
  
  ============================================================================
  MODULE PARAMETERS
  
  Panic on UE control file:
  
  	'edac_mc_panic_on_ue'
  
  	An uncorrectable error will cause a machine panic.  This is usually
  	desirable.  It is a bad idea to continue when an uncorrectable error
  	occurs - it is indeterminate what was uncorrected and the operating
  	system context might be so mangled that continuing will lead to further
  	corruption. If the kernel has MCE configured, then EDAC will never
  	notice the UE.
  
  	LOAD TIME: module/kernel parameter: edac_mc_panic_on_ue=[0|1]
  
  	RUN TIME:  echo "1" > /sys/module/edac_core/parameters/edac_mc_panic_on_ue
  
  
  Log UE control file:
  
  	'edac_mc_log_ue'
  
  	Generate kernel messages describing uncorrectable errors.  These errors
  	are reported through the system message log system.  UE statistics
  	will be accumulated even when UE logging is disabled.
  
  	LOAD TIME: module/kernel parameter: edac_mc_log_ue=[0|1]
  
  	RUN TIME: echo "1" > /sys/module/edac_core/parameters/edac_mc_log_ue
  
  
  Log CE control file:
  
  	'edac_mc_log_ce'
  
  	Generate kernel messages describing correctable errors.  These
  	errors are reported through the system message log system.
  	CE statistics will be accumulated even when CE logging is disabled.
  
  	LOAD TIME: module/kernel parameter: edac_mc_log_ce=[0|1]
  
  	RUN TIME: echo "1" > /sys/module/edac_core/parameters/edac_mc_log_ce
  
  
  Polling period control file:
  
  	'edac_mc_poll_msec'
  
  	The time period, in milliseconds, for polling for error information.
  	Too small a value wastes resources.  Too large a value might delay
  	necessary handling of errors and might loose valuable information for
  	locating the error.  1000 milliseconds (once each second) is the current
  	default. Systems which require all the bandwidth they can get, may
  	increase this.
  
  	LOAD TIME: module/kernel parameter: edac_mc_poll_msec=[0|1]
  
  	RUN TIME: echo "1000" > /sys/module/edac_core/parameters/edac_mc_poll_msec
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
583
584
585
586
  
  Panic on PCI PARITY Error:
  
  	'panic_on_pci_parity'
f3479816b   Dave Peterson   [PATCH] EDAC: doc...
587
  	This control files enables or disables panicking when a parity
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
588
  	error has been detected.
327dafb1c   Arthur Jones   edac: core fix re...
589
  	module/kernel parameter: edac_panic_on_pci_pe=[0|1]
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
590
591
  
  	Enable:
327dafb1c   Arthur Jones   edac: core fix re...
592
  	echo "1" > /sys/module/edac_core/parameters/edac_panic_on_pci_pe
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
593
594
  
  	Disable:
327dafb1c   Arthur Jones   edac: core fix re...
595
  	echo "0" > /sys/module/edac_core/parameters/edac_panic_on_pci_pe
da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
596

da9bb1d27   Alan Cox   [PATCH] EDAC: cor...
597
  =======================================================================
87f24c3ac   Doug Thompson   drivers/edac: add...
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
  
  
  EDAC_DEVICE type of device
  
  In the header file, edac_core.h, there is a series of edac_device structures
  and APIs for the EDAC_DEVICE.
  
  User space access to an edac_device is through the sysfs interface.
  
  At the location /sys/devices/system/edac (sysfs) new edac_device devices will
  appear.
  
  There is a three level tree beneath the above 'edac' directory. For example,
  the 'test_device_edac' device (found at the bluesmoke.sourceforget.net website)
  installs itself as:
  
  	/sys/devices/systm/edac/test-instance
  
  in this directory are various controls, a symlink and one or more 'instance'
  directorys.
  
  The standard default controls are:
  
  	log_ce		boolean to log CE events
  	log_ue		boolean to log UE events
  	panic_on_ue	boolean to 'panic' the system if an UE is encountered
  			(default off, can be set true via startup script)
  	poll_msec	time period between POLL cycles for events
  
  The test_device_edac device adds at least one of its own custom control:
  
  	test_bits	which in the current test driver does nothing but
  			show how it is installed. A ported driver can
  			add one or more such controls and/or attributes
  			for specific uses.
  			One out-of-tree driver uses controls here to allow
  			for ERROR INJECTION operations to hardware
  			injection registers
  
  The symlink points to the 'struct dev' that is registered for this edac_device.
  
  INSTANCES
  
  One or more instance directories are present. For the 'test_device_edac' case:
  
  	test-instance0
  
  
  In this directory there are two default counter attributes, which are totals of
  counter in deeper subdirectories.
  
  	ce_count	total of CE events of subdirectories
  	ue_count	total of UE events of subdirectories
  
  BLOCKS
  
  At the lowest directory level is the 'block' directory. There can be 0, 1
  or more blocks specified in each instance.
  
  	test-block0
  
  
  In this directory the default attributes are:
  
  	ce_count	which is counter of CE events for this 'block'
  			of hardware being monitored
  	ue_count	which is counter of UE events for this 'block'
  			of hardware being monitored
  
  
  The 'test_device_edac' device adds 4 attributes and 1 control:
  
  	test-block-bits-0	for every POLL cycle this counter
  				is incremented
  	test-block-bits-1	every 10 cycles, this counter is bumped once,
  				and test-block-bits-0 is set to 0
  	test-block-bits-2	every 100 cycles, this counter is bumped once,
  				and test-block-bits-1 is set to 0
  	test-block-bits-3	every 1000 cycles, this counter is bumped once,
  				and test-block-bits-2 is set to 0
  
  
  	reset-counters		writing ANY thing to this control will
  				reset all the above counters.
  
  
  Use of the 'test_device_edac' driver should any others to create their own
  unique drivers for their hardware systems.
  
  The 'test_device_edac' sample driver is located at the
  bluesmoke.sourceforge.net project site for EDAC.
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
689
690
691
692
693
694
695
696
697
698
699
  =======================================================================
  NEHALEM USAGE OF EDAC APIs
  
  This chapter documents some EXPERIMENTAL mappings for EDAC API to handle
  Nehalem EDAC driver. They will likely be changed on future versions
  of the driver.
  
  Due to the way Nehalem exports Memory Controller data, some adjustments
  were done at i7core_edac driver. This chapter will cover those differences
  
  1) On Nehalem, there are one Memory Controller per Quick Patch Interconnect
c34443631   Mauro Carvalho Chehab   Documentation/eda...
700
701
     (QPI). At the driver, the term "socket" means one QPI. This is
     associated with a physical CPU socket.
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
702
703
704
705
706
707
  
     Each MC have 3 physical read channels, 3 physical write channels and
     3 logic channels. The driver currenty sees it as just 3 channels.
     Each channel can have up to 3 DIMMs.
  
     The minimum known unity is DIMMs. There are no information about csrows.
c34443631   Mauro Carvalho Chehab   Documentation/eda...
708
709
     As EDAC API maps the minimum unity is csrows, the driver sequencially
     maps channel/dimm into different csrows.
25985edce   Lucas De Marchi   Fix common misspe...
710
     For example, supposing the following layout:
c34443631   Mauro Carvalho Chehab   Documentation/eda...
711
712
713
714
715
716
717
718
719
720
721
722
723
724
  	Ch0 phy rd0, wr0 (0x063f4031): 2 ranks, UDIMMs
  	  dimm 0 1024 Mb offset: 0, bank: 8, rank: 1, row: 0x4000, col: 0x400
  	  dimm 1 1024 Mb offset: 4, bank: 8, rank: 1, row: 0x4000, col: 0x400
          Ch1 phy rd1, wr1 (0x063f4031): 2 ranks, UDIMMs
  	  dimm 0 1024 Mb offset: 0, bank: 8, rank: 1, row: 0x4000, col: 0x400
  	Ch2 phy rd3, wr3 (0x063f4031): 2 ranks, UDIMMs
  	  dimm 0 1024 Mb offset: 0, bank: 8, rank: 1, row: 0x4000, col: 0x400
     The driver will map it as:
  	csrow0: channel 0, dimm0
  	csrow1: channel 0, dimm1
  	csrow2: channel 1, dimm0
  	csrow3: channel 2, dimm0
  
  exports one
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
725
     DIMM per csrow.
c34443631   Mauro Carvalho Chehab   Documentation/eda...
726
     Each QPI is exported as a different memory controller.
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
727
728
729
730
731
  
  2) Nehalem MC has the hability to generate errors. The driver implements this
     functionality via some error injection nodes:
  
     For injecting a memory error, there are some sysfs nodes, under
c34443631   Mauro Carvalho Chehab   Documentation/eda...
732
     /sys/devices/system/edac/mc/mc?/:
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
733

35be95446   Mauro Carvalho Chehab   Documentation/eda...
734
     inject_addrmatch/*:
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
735
736
737
738
739
740
741
742
743
744
745
746
747
748
        Controls the error injection mask register. It is possible to specify
        several characteristics of the address to match an error code:
           dimm = the affected dimm. Numbers are relative to a channel;
           rank = the memory rank;
           channel = the channel that will generate an error;
           bank = the affected bank;
           page = the page address;
           column (or col) = the address column.
        each of the above values can be set to "any" to match any valid value.
  
        At driver init, all values are set to any.
  
        For example, to generate an error at rank 1 of dimm 2, for any channel,
        any bank, any page, any column:
35be95446   Mauro Carvalho Chehab   Documentation/eda...
749
750
  		echo 2 >/sys/devices/system/edac/mc/mc0/inject_addrmatch/dimm
  		echo 1 >/sys/devices/system/edac/mc/mc0/inject_addrmatch/rank
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
751
752
  
  	To return to the default behaviour of matching any, you can do:
35be95446   Mauro Carvalho Chehab   Documentation/eda...
753
754
  		echo any >/sys/devices/system/edac/mc/mc0/inject_addrmatch/dimm
  		echo any >/sys/devices/system/edac/mc/mc0/inject_addrmatch/rank
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
755
756
757
758
759
760
761
762
763
  
     inject_eccmask:
         specifies what bits will have troubles,
  
     inject_section:
         specifies what ECC cache section will get the error:
  		3 for both
  		2 for the highest
  		1 for the lowest
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
     inject_type:
         specifies the type of error, being a combination of the following bits:
  		bit 0 - repeat
  		bit 1 - ecc
  		bit 2 - parity
  
         inject_enable starts the error generation when something different
         than 0 is written.
  
     All inject vars can be read. root permission is needed for write.
  
     Datasheet states that the error will only be generated after a write on an
     address that matches inject_addrmatch. It seems, however, that reading will
     also produce an error.
  
     For example, the following code will generate an error for any write access
     at socket 0, on any DIMM/address on channel 2:
35be95446   Mauro Carvalho Chehab   Documentation/eda...
781
     echo 2 >/sys/devices/system/edac/mc/mc0/inject_addrmatch/channel
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
782
783
784
     echo 2 >/sys/devices/system/edac/mc/mc0/inject_type
     echo 64 >/sys/devices/system/edac/mc/mc0/inject_eccmask
     echo 3 >/sys/devices/system/edac/mc/mc0/inject_section
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
785
786
     echo 1 >/sys/devices/system/edac/mc/mc0/inject_enable
     dd if=/dev/mem of=/dev/null seek=16k bs=4k count=1 >& /dev/null
c34443631   Mauro Carvalho Chehab   Documentation/eda...
787
788
     For socket 1, it is needed to replace "mc0" by "mc1" at the above
     commands.
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
789
790
791
792
793
     The generated error message will look like:
  
     EDAC MC0: UE row 0, channel-a= 0 channel-b= 0 labels "-": NON_FATAL (addr = 0x0075b980, socket=0, Dimm=0, Channel=2, syndrome=0x00000040, count=1, Err=8c0000400001009f:4000080482 (read error: read ECC error))
  
  3) Nehalem specific Corrected Error memory counters
35be95446   Mauro Carvalho Chehab   Documentation/eda...
794
795
     Nehalem have some registers to count memory errors. The driver uses those
     registers to report Corrected Errors on devices with Registered Dimms.
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
796

35be95446   Mauro Carvalho Chehab   Documentation/eda...
797
798
799
800
     However, those counters don't work with Unregistered Dimms. As the chipset
     offers some counters that also work with UDIMMS (but with a worse level of
     granularity than the default ones), the driver exposes those registers for
     UDIMM memories.
c34443631   Mauro Carvalho Chehab   Documentation/eda...
801

35be95446   Mauro Carvalho Chehab   Documentation/eda...
802
     They can be read by looking at the contents of all_channel_counts/
31983a04d   Mauro Carvalho Chehab   Documentation/eda...
803

35be95446   Mauro Carvalho Chehab   Documentation/eda...
804
805
806
807
808
809
810
     $ for i in /sys/devices/system/edac/mc/mc0/all_channel_counts/*; do echo $i; cat $i; done
  	/sys/devices/system/edac/mc/mc0/all_channel_counts/udimm0
  	0
  	/sys/devices/system/edac/mc/mc0/all_channel_counts/udimm1
  	0
  	/sys/devices/system/edac/mc/mc0/all_channel_counts/udimm2
  	0
c34443631   Mauro Carvalho Chehab   Documentation/eda...
811
812
813
814
815
816
817
818
  
     What happens here is that errors on different csrows, but at the same
     dimm number will increment the same counter.
     So, in this memory mapping:
  	csrow0: channel 0, dimm0
  	csrow1: channel 0, dimm1
  	csrow2: channel 1, dimm0
  	csrow3: channel 2, dimm0
35be95446   Mauro Carvalho Chehab   Documentation/eda...
819
820
821
822
823
824
     The hardware will increment udimm0 for an error at the first dimm at either
  	csrow0, csrow2  or csrow3;
     The hardware will increment udimm1 for an error at the second dimm at either
  	csrow0, csrow2  or csrow3;
     The hardware will increment udimm2 for an error at the third dimm at either
  	csrow0, csrow2  or csrow3;
c34443631   Mauro Carvalho Chehab   Documentation/eda...
825
826
827
828
  
  4) Standard error counters
  
     The standard error counters are generated when an mcelog error is received
35be95446   Mauro Carvalho Chehab   Documentation/eda...
829
830
831
     by the driver. Since, with udimm, this is counted by software, it is
     possible that some errors could be lost. With rdimm's, they displays the
     contents of the registers