~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/Documentation/admin-guide/RAS/main.rst

Version: ~ [ linux-6.12-rc7 ] ~ [ linux-6.11.7 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.60 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.116 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.171 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.229 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.285 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.323 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.12 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

Diff markup

Differences between /Documentation/admin-guide/RAS/main.rst (Architecture mips) and /Documentation/admin-guide/RAS/main.rst (Architecture sparc)


  1 .. SPDX-License-Identifier: GPL-2.0                 1 .. SPDX-License-Identifier: GPL-2.0
  2 .. include:: <isonum.txt>                           2 .. include:: <isonum.txt>
  3                                                     3 
  4 ==============================================      4 ==================================================
  5 Reliability, Availability and Serviceability (      5 Reliability, Availability and Serviceability (RAS)
  6 ==============================================      6 ==================================================
  7                                                     7 
  8 This documents different aspects of the RAS fu      8 This documents different aspects of the RAS functionality present in the
  9 kernel.                                             9 kernel.
 10                                                    10 
 11 RAS concepts                                       11 RAS concepts
 12 ************                                       12 ************
 13                                                    13 
 14 Reliability, Availability and Serviceability (     14 Reliability, Availability and Serviceability (RAS) is a concept used on
 15 servers meant to measure their robustness.         15 servers meant to measure their robustness.
 16                                                    16 
 17 Reliability                                        17 Reliability
 18   is the probability that a system will produc     18   is the probability that a system will produce correct outputs.
 19                                                    19 
 20   * Generally measured as Mean Time Between Fa     20   * Generally measured as Mean Time Between Failures (MTBF)
 21   * Enhanced by features that help to avoid, d     21   * Enhanced by features that help to avoid, detect and repair hardware faults
 22                                                    22 
 23 Availability                                       23 Availability
 24   is the probability that a system is operatio     24   is the probability that a system is operational at a given time
 25                                                    25 
 26   * Generally measured as a percentage of down     26   * Generally measured as a percentage of downtime per a period of time
 27   * Often uses mechanisms to detect and correc     27   * Often uses mechanisms to detect and correct hardware faults in
 28     runtime;                                       28     runtime;
 29                                                    29 
 30 Serviceability (or maintainability)                30 Serviceability (or maintainability)
 31   is the simplicity and speed with which a sys     31   is the simplicity and speed with which a system can be repaired or
 32   maintained                                       32   maintained
 33                                                    33 
 34   * Generally measured on Mean Time Between Re     34   * Generally measured on Mean Time Between Repair (MTBR)
 35                                                    35 
 36 Improving RAS                                      36 Improving RAS
 37 -------------                                      37 -------------
 38                                                    38 
 39 In order to reduce systems downtime, a system      39 In order to reduce systems downtime, a system should be capable of detecting
 40 hardware errors, and, when possible correcting     40 hardware errors, and, when possible correcting them in runtime. It should
 41 also provide mechanisms to detect hardware deg     41 also provide mechanisms to detect hardware degradation, in order to warn
 42 the system administrator to take the action of     42 the system administrator to take the action of replacing a component before
 43 it causes data loss or system downtime.            43 it causes data loss or system downtime.
 44                                                    44 
 45 Among the monitoring measures, the most usual      45 Among the monitoring measures, the most usual ones include:
 46                                                    46 
 47 * CPU – detect errors at instruction executi     47 * CPU – detect errors at instruction execution and at L1/L2/L3 caches;
 48 * Memory – add error correction logic (ECC)      48 * Memory – add error correction logic (ECC) to detect and correct errors;
 49 * I/O – add CRC checksums for transferred da     49 * I/O – add CRC checksums for transferred data;
 50 * Storage – RAID, journal file systems, chec     50 * Storage – RAID, journal file systems, checksums,
 51   Self-Monitoring, Analysis and Reporting Tech     51   Self-Monitoring, Analysis and Reporting Technology (SMART).
 52                                                    52 
 53 By monitoring the number of occurrences of err     53 By monitoring the number of occurrences of error detections, it is possible
 54 to identify if the probability of hardware err     54 to identify if the probability of hardware errors is increasing, and, on such
 55 case, do a preventive maintenance to replace a     55 case, do a preventive maintenance to replace a degraded component while
 56 those errors are correctable.                      56 those errors are correctable.
 57                                                    57 
 58 Types of errors                                    58 Types of errors
 59 ---------------                                    59 ---------------
 60                                                    60 
 61 Most mechanisms used on modern systems use tec     61 Most mechanisms used on modern systems use technologies like Hamming
 62 Codes that allow error correction when the num     62 Codes that allow error correction when the number of errors on a bit packet
 63 is below a threshold. If the number of errors      63 is below a threshold. If the number of errors is above, those mechanisms
 64 can indicate with a high degree of confidence      64 can indicate with a high degree of confidence that an error happened, but
 65 they can't correct.                                65 they can't correct.
 66                                                    66 
 67 Also, sometimes an error occur on a component      67 Also, sometimes an error occur on a component that it is not used. For
 68 example, a part of the memory that it is not c     68 example, a part of the memory that it is not currently allocated.
 69                                                    69 
 70 That defines some categories of errors:            70 That defines some categories of errors:
 71                                                    71 
 72 * **Correctable Error (CE)** - the error detec     72 * **Correctable Error (CE)** - the error detection mechanism detected and
 73   corrected the error. Such errors are usually     73   corrected the error. Such errors are usually not fatal, although some
 74   Kernel mechanisms allow the system administr     74   Kernel mechanisms allow the system administrator to consider them as fatal.
 75                                                    75 
 76 * **Uncorrected Error (UE)** - the amount of e     76 * **Uncorrected Error (UE)** - the amount of errors happened above the error
 77   correction threshold, and the system was una     77   correction threshold, and the system was unable to auto-correct.
 78                                                    78 
 79 * **Fatal Error** - when an UE error happens o     79 * **Fatal Error** - when an UE error happens on a critical component of the
 80   system (for example, a piece of the Kernel g     80   system (for example, a piece of the Kernel got corrupted by an UE), the
 81   only reliable way to avoid data corruption i     81   only reliable way to avoid data corruption is to hang or reboot the machine.
 82                                                    82 
 83 * **Non-fatal Error** - when an UE error happe     83 * **Non-fatal Error** - when an UE error happens on an unused component,
 84   like a CPU in power down state or an unused      84   like a CPU in power down state or an unused memory bank, the system may
 85   still run, eventually replacing the affected     85   still run, eventually replacing the affected hardware by a hot spare,
 86   if available.                                    86   if available.
 87                                                    87 
 88   Also, when an error happens on a userspace p     88   Also, when an error happens on a userspace process, it is also possible to
 89   kill such process and let userspace restart      89   kill such process and let userspace restart it.
 90                                                    90 
 91 The mechanism for handling non-fatal errors is     91 The mechanism for handling non-fatal errors is usually complex and may
 92 require the help of some userspace application     92 require the help of some userspace application, in order to apply the
 93 policy desired by the system administrator.        93 policy desired by the system administrator.
 94                                                    94 
 95 Identifying a bad hardware component               95 Identifying a bad hardware component
 96 ------------------------------------               96 ------------------------------------
 97                                                    97 
 98 Just detecting a hardware flaw is usually not      98 Just detecting a hardware flaw is usually not enough, as the system needs
 99 to pinpoint to the minimal replaceable unit (M     99 to pinpoint to the minimal replaceable unit (MRU) that should be exchanged
100 to make the hardware reliable again.              100 to make the hardware reliable again.
101                                                   101 
102 So, it requires not only error logging facilit    102 So, it requires not only error logging facilities, but also mechanisms that
103 will translate the error message to the silksc    103 will translate the error message to the silkscreen or component label for
104 the MRU.                                          104 the MRU.
105                                                   105 
106 Typically, it is very complex for memory, as m    106 Typically, it is very complex for memory, as modern CPUs interlace memory
107 from different memory modules, in order to pro    107 from different memory modules, in order to provide a better performance. The
108 DMI BIOS usually have a list of memory module     108 DMI BIOS usually have a list of memory module labels, with can be obtained
109 using the ``dmidecode`` tool. For example, on     109 using the ``dmidecode`` tool. For example, on a desktop machine, it shows::
110                                                   110 
111         Memory Device                             111         Memory Device
112                 Total Width: 64 bits              112                 Total Width: 64 bits
113                 Data Width: 64 bits               113                 Data Width: 64 bits
114                 Size: 16384 MB                    114                 Size: 16384 MB
115                 Form Factor: SODIMM               115                 Form Factor: SODIMM
116                 Set: None                         116                 Set: None
117                 Locator: ChannelA-DIMM0           117                 Locator: ChannelA-DIMM0
118                 Bank Locator: BANK 0              118                 Bank Locator: BANK 0
119                 Type: DDR4                        119                 Type: DDR4
120                 Type Detail: Synchronous          120                 Type Detail: Synchronous
121                 Speed: 2133 MHz                   121                 Speed: 2133 MHz
122                 Rank: 2                           122                 Rank: 2
123                 Configured Clock Speed: 2133 M    123                 Configured Clock Speed: 2133 MHz
124                                                   124 
125 On the above example, a DDR4 SO-DIMM memory mo    125 On the above example, a DDR4 SO-DIMM memory module is located at the
126 system's memory labeled as "BANK 0", as given     126 system's memory labeled as "BANK 0", as given by the *bank locator* field.
127 Please notice that, on such system, the *total    127 Please notice that, on such system, the *total width* is equal to the
128 *data width*. It means that such memory module    128 *data width*. It means that such memory module doesn't have error
129 detection/correction mechanisms.                  129 detection/correction mechanisms.
130                                                   130 
131 Unfortunately, not all systems use the same fi    131 Unfortunately, not all systems use the same field to specify the memory
132 bank. On this example, from an older server, `    132 bank. On this example, from an older server, ``dmidecode`` shows::
133                                                   133 
134         Memory Device                             134         Memory Device
135                 Array Handle: 0x1000              135                 Array Handle: 0x1000
136                 Error Information Handle: Not     136                 Error Information Handle: Not Provided
137                 Total Width: 72 bits              137                 Total Width: 72 bits
138                 Data Width: 64 bits               138                 Data Width: 64 bits
139                 Size: 8192 MB                     139                 Size: 8192 MB
140                 Form Factor: DIMM                 140                 Form Factor: DIMM
141                 Set: 1                            141                 Set: 1
142                 Locator: DIMM_A1                  142                 Locator: DIMM_A1
143                 Bank Locator: Not Specified       143                 Bank Locator: Not Specified
144                 Type: DDR3                        144                 Type: DDR3
145                 Type Detail: Synchronous Regis    145                 Type Detail: Synchronous Registered (Buffered)
146                 Speed: 1600 MHz                   146                 Speed: 1600 MHz
147                 Rank: 2                           147                 Rank: 2
148                 Configured Clock Speed: 1600 M    148                 Configured Clock Speed: 1600 MHz
149                                                   149 
150 There, the DDR3 RDIMM memory module is located    150 There, the DDR3 RDIMM memory module is located at the system's memory labeled
151 as "DIMM_A1", as given by the *locator* field.    151 as "DIMM_A1", as given by the *locator* field. Please notice that this
152 memory module has 64 bits of *data width* and     152 memory module has 64 bits of *data width* and 72 bits of *total width*. So,
153 it has 8 extra bits to be used by error detect    153 it has 8 extra bits to be used by error detection and correction mechanisms.
154 Such kind of memory is called Error-correcting    154 Such kind of memory is called Error-correcting code memory (ECC memory).
155                                                   155 
156 To make things even worse, it is not uncommon     156 To make things even worse, it is not uncommon that systems with different
157 labels on their system's board to use exactly     157 labels on their system's board to use exactly the same BIOS, meaning that
158 the labels provided by the BIOS won't match th    158 the labels provided by the BIOS won't match the real ones.
159                                                   159 
160 ECC memory                                        160 ECC memory
161 ----------                                        161 ----------
162                                                   162 
163 As mentioned in the previous section, ECC memo    163 As mentioned in the previous section, ECC memory has extra bits to be
164 used for error correction. In the above exampl    164 used for error correction. In the above example, a memory module has
165 64 bits of *data width*, and 72 bits of *total    165 64 bits of *data width*, and 72 bits of *total width*.  The extra 8
166 bits which are used for the error detection an    166 bits which are used for the error detection and correction mechanisms
167 are referred to as the *syndrome*\ [#f1]_\ [#f    167 are referred to as the *syndrome*\ [#f1]_\ [#f2]_.
168                                                   168 
169 So, when the cpu requests the memory controlle    169 So, when the cpu requests the memory controller to write a word with
170 *data width*, the memory controller calculates    170 *data width*, the memory controller calculates the *syndrome* in real time,
171 using Hamming code, or some other error correc    171 using Hamming code, or some other error correction code, like SECDED+,
172 producing a code with *total width* size. Such    172 producing a code with *total width* size. Such code is then written
173 on the memory modules.                            173 on the memory modules.
174                                                   174 
175 At read, the *total width* bits code is conver    175 At read, the *total width* bits code is converted back, using the same
176 ECC code used on write, producing a word with     176 ECC code used on write, producing a word with *data width* and a *syndrome*.
177 The word with *data width* is sent to the CPU,    177 The word with *data width* is sent to the CPU, even when errors happen.
178                                                   178 
179 The memory controller also looks at the *syndr    179 The memory controller also looks at the *syndrome* in order to check if
180 there was an error, and if the ECC code was ab    180 there was an error, and if the ECC code was able to fix such error.
181 If the error was corrected, a Corrected Error     181 If the error was corrected, a Corrected Error (CE) happened. If not, an
182 Uncorrected Error (UE) happened.                  182 Uncorrected Error (UE) happened.
183                                                   183 
184 The information about the CE/UE errors is stor    184 The information about the CE/UE errors is stored on some special registers
185 at the memory controller and can be accessed b    185 at the memory controller and can be accessed by reading such registers,
186 either by BIOS, by some special CPUs or by Lin    186 either by BIOS, by some special CPUs or by Linux EDAC driver. On x86 64
187 bit CPUs, such errors can also be retrieved vi    187 bit CPUs, such errors can also be retrieved via the Machine Check
188 Architecture (MCA)\ [#f3]_.                       188 Architecture (MCA)\ [#f3]_.
189                                                   189 
190 .. [#f1] Please notice that several memory con    190 .. [#f1] Please notice that several memory controllers allow operation on a
191   mode called "Lock-Step", where it groups two    191   mode called "Lock-Step", where it groups two memory modules together,
192   doing 128-bit reads/writes. That gives 16 bi    192   doing 128-bit reads/writes. That gives 16 bits for error correction, with
193   significantly improves the error correction     193   significantly improves the error correction mechanism, at the expense
194   that, when an error happens, there's no way     194   that, when an error happens, there's no way to know what memory module is
195   to blame. So, it has to blame both memory mo    195   to blame. So, it has to blame both memory modules.
196                                                   196 
197 .. [#f2] Some memory controllers also allow us    197 .. [#f2] Some memory controllers also allow using memory in mirror mode.
198   On such mode, the same data is written to tw    198   On such mode, the same data is written to two memory modules. At read,
199   the system checks both memory modules, in or    199   the system checks both memory modules, in order to check if both provide
200   identical data. On such configuration, when     200   identical data. On such configuration, when an error happens, there's no
201   way to know what memory module is to blame.     201   way to know what memory module is to blame. So, it has to blame both
202   memory modules (or 4 memory modules, if the     202   memory modules (or 4 memory modules, if the system is also on Lock-step
203   mode).                                          203   mode).
204                                                   204 
205 .. [#f3] For more details about the Machine Ch    205 .. [#f3] For more details about the Machine Check Architecture (MCA),
206   please read Documentation/arch/x86/x86_64/ma    206   please read Documentation/arch/x86/x86_64/machinecheck.rst at the Kernel tree.
207                                                   207 
208 EDAC - Error Detection And Correction             208 EDAC - Error Detection And Correction
209 *************************************             209 *************************************
210                                                   210 
211 .. note::                                         211 .. note::
212                                                   212 
213    "bluesmoke" was the name for this device dr    213    "bluesmoke" was the name for this device driver subsystem when it
214    was "out-of-tree" and maintained at http://    214    was "out-of-tree" and maintained at http://bluesmoke.sourceforge.net.
215    That site is mostly archaic now and can be     215    That site is mostly archaic now and can be used only for historical
216    purposes.                                      216    purposes.
217                                                   217 
218    When the subsystem was pushed upstream for     218    When the subsystem was pushed upstream for the first time, on
219    Kernel 2.6.16, it was renamed to ``EDAC``.     219    Kernel 2.6.16, it was renamed to ``EDAC``.
220                                                   220 
221 Purpose                                           221 Purpose
222 -------                                           222 -------
223                                                   223 
224 The ``edac`` kernel module's goal is to detect    224 The ``edac`` kernel module's goal is to detect and report hardware errors
225 that occur within the computer system running     225 that occur within the computer system running under linux.
226                                                   226 
227 Memory                                            227 Memory
228 ------                                            228 ------
229                                                   229 
230 Memory Correctable Errors (CE) and Uncorrectab    230 Memory Correctable Errors (CE) and Uncorrectable Errors (UE) are the
231 primary errors being harvested. These types of    231 primary errors being harvested. These types of errors are harvested by
232 the ``edac_mc`` device.                           232 the ``edac_mc`` device.
233                                                   233 
234 Detecting CE events, then harvesting those eve    234 Detecting CE events, then harvesting those events and reporting them,
235 **can** but must not necessarily be a predicto    235 **can** but must not necessarily be a predictor of future UE events. With
236 CE events only, the system can and will contin    236 CE events only, the system can and will continue to operate as no data
237 has been damaged yet.                             237 has been damaged yet.
238                                                   238 
239 However, preventive maintenance and proactive     239 However, preventive maintenance and proactive part replacement of memory
240 modules exhibiting CEs can reduce the likeliho    240 modules exhibiting CEs can reduce the likelihood of the dreaded UE events
241 and system panics.                                241 and system panics.
242                                                   242 
243 Other hardware elements                           243 Other hardware elements
244 -----------------------                           244 -----------------------
245                                                   245 
246 A new feature for EDAC, the ``edac_device`` cl    246 A new feature for EDAC, the ``edac_device`` class of device, was added in
247 the 2.6.23 version of the kernel.                 247 the 2.6.23 version of the kernel.
248                                                   248 
249 This new device type allows for non-memory typ    249 This new device type allows for non-memory type of ECC hardware detectors
250 to have their states harvested and presented t    250 to have their states harvested and presented to userspace via the sysfs
251 interface.                                        251 interface.
252                                                   252 
253 Some architectures have ECC detectors for L1,     253 Some architectures have ECC detectors for L1, L2 and L3 caches,
254 along with DMA engines, fabric switches, main     254 along with DMA engines, fabric switches, main data path switches,
255 interconnections, and various other hardware d    255 interconnections, and various other hardware data paths. If the hardware
256 reports it, then a edac_device device probably    256 reports it, then a edac_device device probably can be constructed to
257 harvest and present that to userspace.            257 harvest and present that to userspace.
258                                                   258 
259                                                   259 
260 PCI bus scanning                                  260 PCI bus scanning
261 ----------------                                  261 ----------------
262                                                   262 
263 In addition, PCI devices are scanned for PCI B    263 In addition, PCI devices are scanned for PCI Bus Parity and SERR Errors
264 in order to determine if errors are occurring     264 in order to determine if errors are occurring during data transfers.
265                                                   265 
266 The presence of PCI Parity errors must be exam    266 The presence of PCI Parity errors must be examined with a grain of salt.
267 There are several add-in adapters that do **no    267 There are several add-in adapters that do **not** follow the PCI specification
268 with regards to Parity generation and reportin    268 with regards to Parity generation and reporting. The specification says
269 the vendor should tie the parity status bits t    269 the vendor should tie the parity status bits to 0 if they do not intend
270 to generate parity.  Some vendors do not do th    270 to generate parity.  Some vendors do not do this, and thus the parity bit
271 can "float" giving false positives.               271 can "float" giving false positives.
272                                                   272 
273 There is a PCI device attribute located in sys    273 There is a PCI device attribute located in sysfs that is checked by
274 the EDAC PCI scanning code. If that attribute     274 the EDAC PCI scanning code. If that attribute is set, PCI parity/error
275 scanning is skipped for that device. The attri    275 scanning is skipped for that device. The attribute is::
276                                                   276 
277         broken_parity_status                      277         broken_parity_status
278                                                   278 
279 and is located in ``/sys/devices/pci<XXX>/0000    279 and is located in ``/sys/devices/pci<XXX>/0000:XX:YY.Z`` directories for
280 PCI devices.                                      280 PCI devices.
281                                                   281 
282                                                   282 
283 Versioning                                        283 Versioning
284 ----------                                        284 ----------
285                                                   285 
286 EDAC is composed of a "core" module (``edac_co    286 EDAC is composed of a "core" module (``edac_core.ko``) and several Memory
287 Controller (MC) driver modules. On a given sys    287 Controller (MC) driver modules. On a given system, the CORE is loaded
288 and one MC driver will be loaded. Both the COR    288 and one MC driver will be loaded. Both the CORE and the MC driver (or
289 ``edac_device`` driver) have individual versio    289 ``edac_device`` driver) have individual versions that reflect current
290 release level of their respective modules.        290 release level of their respective modules.
291                                                   291 
292 Thus, to "report" on what version a system is     292 Thus, to "report" on what version a system is running, one must report
293 both the CORE's and the MC driver's versions.     293 both the CORE's and the MC driver's versions.
294                                                   294 
295                                                   295 
296 Loading                                           296 Loading
297 -------                                           297 -------
298                                                   298 
299 If ``edac`` was statically linked with the ker    299 If ``edac`` was statically linked with the kernel then no loading
300 is necessary. If ``edac`` was built as modules    300 is necessary. If ``edac`` was built as modules then simply modprobe
301 the ``edac`` pieces that you need. You should     301 the ``edac`` pieces that you need. You should be able to modprobe
302 hardware-specific modules and have the depende    302 hardware-specific modules and have the dependencies load the necessary
303 core modules.                                     303 core modules.
304                                                   304 
305 Example::                                         305 Example::
306                                                   306 
307         $ modprobe amd76x_edac                    307         $ modprobe amd76x_edac
308                                                   308 
309 loads both the ``amd76x_edac.ko`` memory contr    309 loads both the ``amd76x_edac.ko`` memory controller module and the
310 ``edac_mc.ko`` core module.                       310 ``edac_mc.ko`` core module.
311                                                   311 
312                                                   312 
313 Sysfs interface                                   313 Sysfs interface
314 ---------------                                   314 ---------------
315                                                   315 
316 EDAC presents a ``sysfs`` interface for contro    316 EDAC presents a ``sysfs`` interface for control and reporting purposes. It
317 lives in the /sys/devices/system/edac director    317 lives in the /sys/devices/system/edac directory.
318                                                   318 
319 Within this directory there currently reside 2    319 Within this directory there currently reside 2 components:
320                                                   320 
321         ======= ==============================    321         ======= ==============================
322         mc      memory controller(s) system       322         mc      memory controller(s) system
323         pci     PCI control and status system     323         pci     PCI control and status system
324         ======= ==============================    324         ======= ==============================
325                                                   325 
326                                                   326 
327                                                   327 
328 Memory Controller (mc) Model                      328 Memory Controller (mc) Model
329 ----------------------------                      329 ----------------------------
330                                                   330 
331 Each ``mc`` device controls a set of memory mo    331 Each ``mc`` device controls a set of memory modules [#f4]_. These modules
332 are laid out in a Chip-Select Row (``csrowX``)    332 are laid out in a Chip-Select Row (``csrowX``) and Channel table (``chX``).
333 There can be multiple csrows and multiple chan    333 There can be multiple csrows and multiple channels.
334                                                   334 
335 .. [#f4] Nowadays, the term DIMM (Dual In-line    335 .. [#f4] Nowadays, the term DIMM (Dual In-line Memory Module) is widely
336   used to refer to a memory module, although t    336   used to refer to a memory module, although there are other memory
337   packaging alternatives, like SO-DIMM, SIMM,     337   packaging alternatives, like SO-DIMM, SIMM, etc. The UEFI
338   specification (Version 2.7) defines a memory    338   specification (Version 2.7) defines a memory module in the Common
339   Platform Error Record (CPER) section to be a    339   Platform Error Record (CPER) section to be an SMBIOS Memory Device
340   (Type 17). Along this document, and inside t    340   (Type 17). Along this document, and inside the EDAC subsystem, the term
341   "dimm" is used for all memory modules, even     341   "dimm" is used for all memory modules, even when they use a
342   different kind of packaging.                    342   different kind of packaging.
343                                                   343 
344 Memory controllers allow for several csrows, w    344 Memory controllers allow for several csrows, with 8 csrows being a
345 typical value. Yet, the actual number of csrow    345 typical value. Yet, the actual number of csrows depends on the layout of
346 a given motherboard, memory controller and mem    346 a given motherboard, memory controller and memory module characteristics.
347                                                   347 
348 Dual channels allow for dual data length (e. g    348 Dual channels allow for dual data length (e. g. 128 bits, on 64 bit systems)
349 data transfers to/from the CPU from/to memory.    349 data transfers to/from the CPU from/to memory. Some newer chipsets allow
350 for more than 2 channels, like Fully Buffered     350 for more than 2 channels, like Fully Buffered DIMMs (FB-DIMMs) memory
351 controllers. The following example will assume    351 controllers. The following example will assume 2 channels:
352                                                   352 
353         +------------+-----------------------+    353         +------------+-----------------------+
354         | CS Rows    |       Channels        |    354         | CS Rows    |       Channels        |
355         +------------+-----------+-----------+    355         +------------+-----------+-----------+
356         |            |  ``ch0``  |  ``ch1``  |    356         |            |  ``ch0``  |  ``ch1``  |
357         +============+===========+===========+    357         +============+===========+===========+
358         |            |**DIMM_A0**|**DIMM_B0**|    358         |            |**DIMM_A0**|**DIMM_B0**|
359         +------------+-----------+-----------+    359         +------------+-----------+-----------+
360         | ``csrow0`` |   rank0   |   rank0   |    360         | ``csrow0`` |   rank0   |   rank0   |
361         +------------+-----------+-----------+    361         +------------+-----------+-----------+
362         | ``csrow1`` |   rank1   |   rank1   |    362         | ``csrow1`` |   rank1   |   rank1   |
363         +------------+-----------+-----------+    363         +------------+-----------+-----------+
364         |            |**DIMM_A1**|**DIMM_B1**|    364         |            |**DIMM_A1**|**DIMM_B1**|
365         +------------+-----------+-----------+    365         +------------+-----------+-----------+
366         | ``csrow2`` |    rank0  |  rank0    |    366         | ``csrow2`` |    rank0  |  rank0    |
367         +------------+-----------+-----------+    367         +------------+-----------+-----------+
368         | ``csrow3`` |    rank1  |  rank1    |    368         | ``csrow3`` |    rank1  |  rank1    |
369         +------------+-----------+-----------+    369         +------------+-----------+-----------+
370                                                   370 
371 In the above example, there are 4 physical slo    371 In the above example, there are 4 physical slots on the motherboard
372 for memory DIMMs:                                 372 for memory DIMMs:
373                                                   373 
374         +---------+---------+                     374         +---------+---------+
375         | DIMM_A0 | DIMM_B0 |                     375         | DIMM_A0 | DIMM_B0 |
376         +---------+---------+                     376         +---------+---------+
377         | DIMM_A1 | DIMM_B1 |                     377         | DIMM_A1 | DIMM_B1 |
378         +---------+---------+                     378         +---------+---------+
379                                                   379 
380 Labels for these slots are usually silk-screen    380 Labels for these slots are usually silk-screened on the motherboard.
381 Slots labeled ``A`` are channel 0 in this exam    381 Slots labeled ``A`` are channel 0 in this example. Slots labeled ``B`` are
382 channel 1. Notice that there are two csrows po    382 channel 1. Notice that there are two csrows possible on a physical DIMM.
383 These csrows are allocated their csrow assignm    383 These csrows are allocated their csrow assignment based on the slot into
384 which the memory DIMM is placed. Thus, when 1     384 which the memory DIMM is placed. Thus, when 1 DIMM is placed in each
385 Channel, the csrows cross both DIMMs.             385 Channel, the csrows cross both DIMMs.
386                                                   386 
387 Memory DIMMs come single or dual "ranked". A r    387 Memory DIMMs come single or dual "ranked". A rank is a populated csrow.
388 In the example above 2 dual ranked DIMMs are s    388 In the example above 2 dual ranked DIMMs are similarly placed. Thus,
389 both csrow0 and csrow1 are populated. On the o    389 both csrow0 and csrow1 are populated. On the other hand, when 2 single
390 ranked DIMMs are placed in slots DIMM_A0 and D    390 ranked DIMMs are placed in slots DIMM_A0 and DIMM_B0, then they will
391 have just one csrow (csrow0) and csrow1 will b    391 have just one csrow (csrow0) and csrow1 will be empty. The pattern
392 repeats itself for csrow2 and csrow3. Also not    392 repeats itself for csrow2 and csrow3. Also note that some memory
393 controllers don't have any logic to identify t    393 controllers don't have any logic to identify the memory module, see
394 ``rankX`` directories below.                      394 ``rankX`` directories below.
395                                                   395 
396 The representation of the above is reflected i    396 The representation of the above is reflected in the directory
397 tree in EDAC's sysfs interface. Starting in di    397 tree in EDAC's sysfs interface. Starting in directory
398 ``/sys/devices/system/edac/mc``, each memory c    398 ``/sys/devices/system/edac/mc``, each memory controller will be
399 represented by its own ``mcX`` directory, wher    399 represented by its own ``mcX`` directory, where ``X`` is the
400 index of the MC::                                 400 index of the MC::
401                                                   401 
402         ..../edac/mc/                             402         ..../edac/mc/
403                    |                              403                    |
404                    |->mc0                         404                    |->mc0
405                    |->mc1                         405                    |->mc1
406                    |->mc2                         406                    |->mc2
407                    ....                           407                    ....
408                                                   408 
409 Under each ``mcX`` directory each ``csrowX`` i    409 Under each ``mcX`` directory each ``csrowX`` is again represented by a
410 ``csrowX``, where ``X`` is the csrow index::      410 ``csrowX``, where ``X`` is the csrow index::
411                                                   411 
412         .../mc/mc0/                               412         .../mc/mc0/
413                 |                                 413                 |
414                 |->csrow0                         414                 |->csrow0
415                 |->csrow2                         415                 |->csrow2
416                 |->csrow3                         416                 |->csrow3
417                 ....                              417                 ....
418                                                   418 
419 Notice that there is no csrow1, which indicate    419 Notice that there is no csrow1, which indicates that csrow0 is composed
420 of a single ranked DIMMs. This should also app    420 of a single ranked DIMMs. This should also apply in both Channels, in
421 order to have dual-channel mode be operational    421 order to have dual-channel mode be operational. Since both csrow2 and
422 csrow3 are populated, this indicates a dual ra    422 csrow3 are populated, this indicates a dual ranked set of DIMMs for
423 channels 0 and 1.                                 423 channels 0 and 1.
424                                                   424 
425 Within each of the ``mcX`` and ``csrowX`` dire    425 Within each of the ``mcX`` and ``csrowX`` directories are several EDAC
426 control and attribute files.                      426 control and attribute files.
427                                                   427 
428 ``mcX`` directories                               428 ``mcX`` directories
429 -------------------                               429 -------------------
430                                                   430 
431 In ``mcX`` directories are EDAC control and at    431 In ``mcX`` directories are EDAC control and attribute files for
432 this ``X`` instance of the memory controllers.    432 this ``X`` instance of the memory controllers.
433                                                   433 
434 For a description of the sysfs API, please see    434 For a description of the sysfs API, please see:
435                                                   435 
436         Documentation/ABI/testing/sysfs-device    436         Documentation/ABI/testing/sysfs-devices-edac
437                                                   437 
438                                                   438 
439 ``dimmX`` or ``rankX`` directories                439 ``dimmX`` or ``rankX`` directories
440 ----------------------------------                440 ----------------------------------
441                                                   441 
442 The recommended way to use the EDAC subsystem     442 The recommended way to use the EDAC subsystem is to look at the information
443 provided by the ``dimmX`` or ``rankX`` directo    443 provided by the ``dimmX`` or ``rankX`` directories [#f5]_.
444                                                   444 
445 A typical EDAC system has the following struct    445 A typical EDAC system has the following structure under
446 ``/sys/devices/system/edac/``\ [#f6]_::           446 ``/sys/devices/system/edac/``\ [#f6]_::
447                                                   447 
448         /sys/devices/system/edac/                 448         /sys/devices/system/edac/
449         ├── mc                              449         ├── mc
450         │   ├── mc0                     450         │   ├── mc0
451         │   │   ├── ce_count        451         │   │   ├── ce_count
452         │   │   ├── ce_noinfo_co    452         │   │   ├── ce_noinfo_count
453         │   │   ├── dimm0           453         │   │   ├── dimm0
454         │   │   │   ├── dimm    454         │   │   │   ├── dimm_ce_count
455         │   │   │   ├── dimm    455         │   │   │   ├── dimm_dev_type
456         │   │   │   ├── dimm    456         │   │   │   ├── dimm_edac_mode
457         │   │   │   ├── dimm    457         │   │   │   ├── dimm_label
458         │   │   │   ├── dimm    458         │   │   │   ├── dimm_location
459         │   │   │   ├── dimm    459         │   │   │   ├── dimm_mem_type
460         │   │   │   ├── dimm    460         │   │   │   ├── dimm_ue_count
461         │   │   │   ├── size    461         │   │   │   ├── size
462         │   │   │   └── ueve    462         │   │   │   └── uevent
463         │   │   ├── max_location    463         │   │   ├── max_location
464         │   │   ├── mc_name         464         │   │   ├── mc_name
465         │   │   ├── reset_counte    465         │   │   ├── reset_counters
466         │   │   ├── seconds_sinc    466         │   │   ├── seconds_since_reset
467         │   │   ├── size_mb         467         │   │   ├── size_mb
468         │   │   ├── ue_count        468         │   │   ├── ue_count
469         │   │   ├── ue_noinfo_co    469         │   │   ├── ue_noinfo_count
470         │   │   └── uevent          470         │   │   └── uevent
471         │   ├── mc1                     471         │   ├── mc1
472         │   │   ├── ce_count        472         │   │   ├── ce_count
473         │   │   ├── ce_noinfo_co    473         │   │   ├── ce_noinfo_count
474         │   │   ├── dimm0           474         │   │   ├── dimm0
475         │   │   │   ├── dimm    475         │   │   │   ├── dimm_ce_count
476         │   │   │   ├── dimm    476         │   │   │   ├── dimm_dev_type
477         │   │   │   ├── dimm    477         │   │   │   ├── dimm_edac_mode
478         │   │   │   ├── dimm    478         │   │   │   ├── dimm_label
479         │   │   │   ├── dimm    479         │   │   │   ├── dimm_location
480         │   │   │   ├── dimm    480         │   │   │   ├── dimm_mem_type
481         │   │   │   ├── dimm    481         │   │   │   ├── dimm_ue_count
482         │   │   │   ├── size    482         │   │   │   ├── size
483         │   │   │   └── ueve    483         │   │   │   └── uevent
484         │   │   ├── max_location    484         │   │   ├── max_location
485         │   │   ├── mc_name         485         │   │   ├── mc_name
486         │   │   ├── reset_counte    486         │   │   ├── reset_counters
487         │   │   ├── seconds_sinc    487         │   │   ├── seconds_since_reset
488         │   │   ├── size_mb         488         │   │   ├── size_mb
489         │   │   ├── ue_count        489         │   │   ├── ue_count
490         │   │   ├── ue_noinfo_co    490         │   │   ├── ue_noinfo_count
491         │   │   └── uevent          491         │   │   └── uevent
492         │   └── uevent                  492         │   └── uevent
493         └── uevent                          493         └── uevent
494                                                   494 
495 In the ``dimmX`` directories are EDAC control     495 In the ``dimmX`` directories are EDAC control and attribute files for
496 this ``X`` memory module:                         496 this ``X`` memory module:
497                                                   497 
498 - ``size`` - Total memory managed by this csro    498 - ``size`` - Total memory managed by this csrow attribute file
499                                                   499 
500         This attribute file displays, in count    500         This attribute file displays, in count of megabytes, the memory
501         that this csrow contains.                 501         that this csrow contains.
502                                                   502 
503 - ``dimm_ue_count`` - Uncorrectable Errors cou    503 - ``dimm_ue_count`` - Uncorrectable Errors count attribute file
504                                                   504 
505         This attribute file displays the total    505         This attribute file displays the total count of uncorrectable
506         errors that have occurred on this DIMM    506         errors that have occurred on this DIMM. If panic_on_ue is set
507         this counter will not have a chance to    507         this counter will not have a chance to increment, since EDAC
508         will panic the system.                    508         will panic the system.
509                                                   509 
510 - ``dimm_ce_count`` - Correctable Errors count    510 - ``dimm_ce_count`` - Correctable Errors count attribute file
511                                                   511 
512         This attribute file displays the total    512         This attribute file displays the total count of correctable
513         errors that have occurred on this DIMM    513         errors that have occurred on this DIMM. This count is very
514         important to examine. CEs provide earl    514         important to examine. CEs provide early indications that a
515         DIMM is beginning to fail. This count     515         DIMM is beginning to fail. This count field should be
516         monitored for non-zero values and repo    516         monitored for non-zero values and report such information
517         to the system administrator.              517         to the system administrator.
518                                                   518 
519 - ``dimm_dev_type``  - Device type attribute f    519 - ``dimm_dev_type``  - Device type attribute file
520                                                   520 
521         This attribute file will display what     521         This attribute file will display what type of DRAM device is
522         being utilized on this DIMM.              522         being utilized on this DIMM.
523         Examples:                                 523         Examples:
524                                                   524 
525                 - x1                              525                 - x1
526                 - x2                              526                 - x2
527                 - x4                              527                 - x4
528                 - x8                              528                 - x8
529                                                   529 
530 - ``dimm_edac_mode`` - EDAC Mode of operation     530 - ``dimm_edac_mode`` - EDAC Mode of operation attribute file
531                                                   531 
532         This attribute file will display what     532         This attribute file will display what type of Error detection
533         and correction is being utilized.         533         and correction is being utilized.
534                                                   534 
535 - ``dimm_label`` - memory module label control    535 - ``dimm_label`` - memory module label control file
536                                                   536 
537         This control file allows this DIMM to     537         This control file allows this DIMM to have a label assigned
538         to it. With this label in the module,     538         to it. With this label in the module, when errors occur
539         the output can provide the DIMM label     539         the output can provide the DIMM label in the system log.
540         This becomes vital for panic events to    540         This becomes vital for panic events to isolate the
541         cause of the UE event.                    541         cause of the UE event.
542                                                   542 
543         DIMM Labels must be assigned after boo    543         DIMM Labels must be assigned after booting, with information
544         that correctly identifies the physical    544         that correctly identifies the physical slot with its
545         silk screen label. This information is    545         silk screen label. This information is currently very
546         motherboard specific and determination    546         motherboard specific and determination of this information
547         must occur in userland at this time.      547         must occur in userland at this time.
548                                                   548 
549 - ``dimm_location`` - location of the memory m    549 - ``dimm_location`` - location of the memory module
550                                                   550 
551         The location can have up to 3 levels,     551         The location can have up to 3 levels, and describe how the
552         memory controller identifies the locat    552         memory controller identifies the location of a memory module.
553         Depending on the type of memory and me    553         Depending on the type of memory and memory controller, it
554         can be:                                   554         can be:
555                                                   555 
556                 - *csrow* and *channel* - used    556                 - *csrow* and *channel* - used when the memory controller
557                   doesn't identify a single DI    557                   doesn't identify a single DIMM - e. g. in ``rankX`` dir;
558                 - *branch*, *channel*, *slot*     558                 - *branch*, *channel*, *slot* - typically used on FB-DIMM memory
559                   controllers;                    559                   controllers;
560                 - *channel*, *slot* - used on     560                 - *channel*, *slot* - used on Nehalem and newer Intel drivers.
561                                                   561 
562 - ``dimm_mem_type`` - Memory Type attribute fi    562 - ``dimm_mem_type`` - Memory Type attribute file
563                                                   563 
564         This attribute file will display what     564         This attribute file will display what type of memory is currently
565         on this csrow. Normally, either buffer    565         on this csrow. Normally, either buffered or unbuffered memory.
566         Examples:                                 566         Examples:
567                                                   567 
568                 - Registered-DDR                  568                 - Registered-DDR
569                 - Unbuffered-DDR                  569                 - Unbuffered-DDR
570                                                   570 
571 .. [#f5] On some systems, the memory controlle    571 .. [#f5] On some systems, the memory controller doesn't have any logic
572   to identify the memory module. On such syste    572   to identify the memory module. On such systems, the directory is called ``rankX`` and works on a similar way as the ``csrowX`` directories.
573   On modern Intel memory controllers, the memo    573   On modern Intel memory controllers, the memory controller identifies the
574   memory modules directly. On such systems, th    574   memory modules directly. On such systems, the directory is called ``dimmX``.
575                                                   575 
576 .. [#f6] There are also some ``power`` directo    576 .. [#f6] There are also some ``power`` directories and ``subsystem``
577   symlinks inside the sysfs mapping that are a    577   symlinks inside the sysfs mapping that are automatically created by
578   the sysfs subsystem. Currently, they serve n    578   the sysfs subsystem. Currently, they serve no purpose.
579                                                   579 
580 ``csrowX`` directories                            580 ``csrowX`` directories
581 ----------------------                            581 ----------------------
582                                                   582 
583 When CONFIG_EDAC_LEGACY_SYSFS is enabled, sysf    583 When CONFIG_EDAC_LEGACY_SYSFS is enabled, sysfs will contain the ``csrowX``
584 directories. As this API doesn't work properly    584 directories. As this API doesn't work properly for Rambus, FB-DIMMs and
585 modern Intel Memory Controllers, this is being    585 modern Intel Memory Controllers, this is being deprecated in favor of
586 ``dimmX`` directories.                            586 ``dimmX`` directories.
587                                                   587 
588 In the ``csrowX`` directories are EDAC control    588 In the ``csrowX`` directories are EDAC control and attribute files for
589 this ``X`` instance of csrow:                     589 this ``X`` instance of csrow:
590                                                   590 
591                                                   591 
592 - ``ue_count`` - Total Uncorrectable Errors co    592 - ``ue_count`` - Total Uncorrectable Errors count attribute file
593                                                   593 
594         This attribute file displays the total    594         This attribute file displays the total count of uncorrectable
595         errors that have occurred on this csro    595         errors that have occurred on this csrow. If panic_on_ue is set
596         this counter will not have a chance to    596         this counter will not have a chance to increment, since EDAC
597         will panic the system.                    597         will panic the system.
598                                                   598 
599                                                   599 
600 - ``ce_count`` - Total Correctable Errors coun    600 - ``ce_count`` - Total Correctable Errors count attribute file
601                                                   601 
602         This attribute file displays the total    602         This attribute file displays the total count of correctable
603         errors that have occurred on this csro    603         errors that have occurred on this csrow. This count is very
604         important to examine. CEs provide earl    604         important to examine. CEs provide early indications that a
605         DIMM is beginning to fail. This count     605         DIMM is beginning to fail. This count field should be
606         monitored for non-zero values and repo    606         monitored for non-zero values and report such information
607         to the system administrator.              607         to the system administrator.
608                                                   608 
609                                                   609 
610 - ``size_mb`` - Total memory managed by this c    610 - ``size_mb`` - Total memory managed by this csrow attribute file
611                                                   611 
612         This attribute file displays, in count    612         This attribute file displays, in count of megabytes, the memory
613         that this csrow contains.                 613         that this csrow contains.
614                                                   614 
615                                                   615 
616 - ``mem_type`` - Memory Type attribute file       616 - ``mem_type`` - Memory Type attribute file
617                                                   617 
618         This attribute file will display what     618         This attribute file will display what type of memory is currently
619         on this csrow. Normally, either buffer    619         on this csrow. Normally, either buffered or unbuffered memory.
620         Examples:                                 620         Examples:
621                                                   621 
622                 - Registered-DDR                  622                 - Registered-DDR
623                 - Unbuffered-DDR                  623                 - Unbuffered-DDR
624                                                   624 
625                                                   625 
626 - ``edac_mode`` - EDAC Mode of operation attri    626 - ``edac_mode`` - EDAC Mode of operation attribute file
627                                                   627 
628         This attribute file will display what     628         This attribute file will display what type of Error detection
629         and correction is being utilized.         629         and correction is being utilized.
630                                                   630 
631                                                   631 
632 - ``dev_type`` - Device type attribute file       632 - ``dev_type`` - Device type attribute file
633                                                   633 
634         This attribute file will display what     634         This attribute file will display what type of DRAM device is
635         being utilized on this DIMM.              635         being utilized on this DIMM.
636         Examples:                                 636         Examples:
637                                                   637 
638                 - x1                              638                 - x1
639                 - x2                              639                 - x2
640                 - x4                              640                 - x4
641                 - x8                              641                 - x8
642                                                   642 
643                                                   643 
644 - ``ch0_ce_count`` - Channel 0 CE Count attrib    644 - ``ch0_ce_count`` - Channel 0 CE Count attribute file
645                                                   645 
646         This attribute file will display the c    646         This attribute file will display the count of CEs on this
647         DIMM located in channel 0.                647         DIMM located in channel 0.
648                                                   648 
649                                                   649 
650 - ``ch0_ue_count`` - Channel 0 UE Count attrib    650 - ``ch0_ue_count`` - Channel 0 UE Count attribute file
651                                                   651 
652         This attribute file will display the c    652         This attribute file will display the count of UEs on this
653         DIMM located in channel 0.                653         DIMM located in channel 0.
654                                                   654 
655                                                   655 
656 - ``ch0_dimm_label`` - Channel 0 DIMM Label co    656 - ``ch0_dimm_label`` - Channel 0 DIMM Label control file
657                                                   657 
658                                                   658 
659         This control file allows this DIMM to     659         This control file allows this DIMM to have a label assigned
660         to it. With this label in the module,     660         to it. With this label in the module, when errors occur
661         the output can provide the DIMM label     661         the output can provide the DIMM label in the system log.
662         This becomes vital for panic events to    662         This becomes vital for panic events to isolate the
663         cause of the UE event.                    663         cause of the UE event.
664                                                   664 
665         DIMM Labels must be assigned after boo    665         DIMM Labels must be assigned after booting, with information
666         that correctly identifies the physical    666         that correctly identifies the physical slot with its
667         silk screen label. This information is    667         silk screen label. This information is currently very
668         motherboard specific and determination    668         motherboard specific and determination of this information
669         must occur in userland at this time.      669         must occur in userland at this time.
670                                                   670 
671                                                   671 
672 - ``ch1_ce_count`` - Channel 1 CE Count attrib    672 - ``ch1_ce_count`` - Channel 1 CE Count attribute file
673                                                   673 
674                                                   674 
675         This attribute file will display the c    675         This attribute file will display the count of CEs on this
676         DIMM located in channel 1.                676         DIMM located in channel 1.
677                                                   677 
678                                                   678 
679 - ``ch1_ue_count`` - Channel 1 UE Count attrib    679 - ``ch1_ue_count`` - Channel 1 UE Count attribute file
680                                                   680 
681                                                   681 
682         This attribute file will display the c    682         This attribute file will display the count of UEs on this
683         DIMM located in channel 0.                683         DIMM located in channel 0.
684                                                   684 
685                                                   685 
686 - ``ch1_dimm_label`` - Channel 1 DIMM Label co    686 - ``ch1_dimm_label`` - Channel 1 DIMM Label control file
687                                                   687 
688         This control file allows this DIMM to     688         This control file allows this DIMM to have a label assigned
689         to it. With this label in the module,     689         to it. With this label in the module, when errors occur
690         the output can provide the DIMM label     690         the output can provide the DIMM label in the system log.
691         This becomes vital for panic events to    691         This becomes vital for panic events to isolate the
692         cause of the UE event.                    692         cause of the UE event.
693                                                   693 
694         DIMM Labels must be assigned after boo    694         DIMM Labels must be assigned after booting, with information
695         that correctly identifies the physical    695         that correctly identifies the physical slot with its
696         silk screen label. This information is    696         silk screen label. This information is currently very
697         motherboard specific and determination    697         motherboard specific and determination of this information
698         must occur in userland at this time.      698         must occur in userland at this time.
699                                                   699 
700                                                   700 
701 System Logging                                    701 System Logging
702 --------------                                    702 --------------
703                                                   703 
704 If logging for UEs and CEs is enabled, then sy    704 If logging for UEs and CEs is enabled, then system logs will contain
705 information indicating that errors have been d    705 information indicating that errors have been detected::
706                                                   706 
707   EDAC MC0: CE page 0x283, offset 0xce0, grain    707   EDAC MC0: CE page 0x283, offset 0xce0, grain 8, syndrome 0x6ec3, row 0, channel 1 "DIMM_B1": amd76x_edac
708   EDAC MC0: CE page 0x1e5, offset 0xfb0, grain    708   EDAC MC0: CE page 0x1e5, offset 0xfb0, grain 8, syndrome 0xb741, row 0, channel 1 "DIMM_B1": amd76x_edac
709                                                   709 
710                                                   710 
711 The structure of the message is:                  711 The structure of the message is:
712                                                   712 
713         +-------------------------------------    713         +---------------------------------------+-------------+
714         | Content                                 714         | Content                               | Example     |
715         +=====================================    715         +=======================================+=============+
716         | The memory controller                   716         | The memory controller                 | MC0         |
717         +-------------------------------------    717         +---------------------------------------+-------------+
718         | Error type                              718         | Error type                            | CE          |
719         +-------------------------------------    719         +---------------------------------------+-------------+
720         | Memory page                             720         | Memory page                           | 0x283       |
721         +-------------------------------------    721         +---------------------------------------+-------------+
722         | Offset in the page                      722         | Offset in the page                    | 0xce0       |
723         +-------------------------------------    723         +---------------------------------------+-------------+
724         | The byte granularity                    724         | The byte granularity                  | grain 8     |
725         | or resolution of the error              725         | or resolution of the error            |             |
726         +-------------------------------------    726         +---------------------------------------+-------------+
727         | The error syndrome                      727         | The error syndrome                    | 0xb741      |
728         +-------------------------------------    728         +---------------------------------------+-------------+
729         | Memory row                              729         | Memory row                            | row 0       |
730         +-------------------------------------    730         +---------------------------------------+-------------+
731         | Memory channel                          731         | Memory channel                        | channel 1   |
732         +-------------------------------------    732         +---------------------------------------+-------------+
733         | DIMM label, if set prior                733         | DIMM label, if set prior              | DIMM B1     |
734         +-------------------------------------    734         +---------------------------------------+-------------+
735         | And then an optional, driver-specifi    735         | And then an optional, driver-specific |             |
736         | message that may have additional        736         | message that may have additional      |             |
737         | information.                            737         | information.                          |             |
738         +-------------------------------------    738         +---------------------------------------+-------------+
739                                                   739 
740 Both UEs and CEs with no info will lack all bu    740 Both UEs and CEs with no info will lack all but memory controller, error
741 type, a notice of "no info" and then an option    741 type, a notice of "no info" and then an optional, driver-specific error
742 message.                                          742 message.
743                                                   743 
744                                                   744 
745 PCI Bus Parity Detection                          745 PCI Bus Parity Detection
746 ------------------------                          746 ------------------------
747                                                   747 
748 On Header Type 00 devices, the primary status     748 On Header Type 00 devices, the primary status is looked at for any
749 parity error regardless of whether parity is e    749 parity error regardless of whether parity is enabled on the device or
750 not. (The spec indicates parity is generated i    750 not. (The spec indicates parity is generated in some cases). On Header
751 Type 01 bridges, the secondary status register    751 Type 01 bridges, the secondary status register is also looked at to see
752 if parity occurred on the bus on the other sid    752 if parity occurred on the bus on the other side of the bridge.
753                                                   753 
754                                                   754 
755 Sysfs configuration                               755 Sysfs configuration
756 -------------------                               756 -------------------
757                                                   757 
758 Under ``/sys/devices/system/edac/pci`` are con    758 Under ``/sys/devices/system/edac/pci`` are control and attribute files as
759 follows:                                          759 follows:
760                                                   760 
761                                                   761 
762 - ``check_pci_parity`` - Enable/Disable PCI Pa    762 - ``check_pci_parity`` - Enable/Disable PCI Parity checking control file
763                                                   763 
764         This control file enables or disables     764         This control file enables or disables the PCI Bus Parity scanning
765         operation. Writing a 1 to this file en    765         operation. Writing a 1 to this file enables the scanning. Writing
766         a 0 to this file disables the scanning    766         a 0 to this file disables the scanning.
767                                                   767 
768         Enable::                                  768         Enable::
769                                                   769 
770                 echo "1" >/sys/devices/system/    770                 echo "1" >/sys/devices/system/edac/pci/check_pci_parity
771                                                   771 
772         Disable::                                 772         Disable::
773                                                   773 
774                 echo "0" >/sys/devices/system/    774                 echo "0" >/sys/devices/system/edac/pci/check_pci_parity
775                                                   775 
776                                                   776 
777 - ``pci_parity_count`` - Parity Count             777 - ``pci_parity_count`` - Parity Count
778                                                   778 
779         This attribute file will display the n    779         This attribute file will display the number of parity errors that
780         have been detected.                       780         have been detected.
781                                                   781 
782                                                   782 
783 Module parameters                                 783 Module parameters
784 -----------------                                 784 -----------------
785                                                   785 
786 - ``edac_mc_panic_on_ue`` - Panic on UE contro    786 - ``edac_mc_panic_on_ue`` - Panic on UE control file
787                                                   787 
788         An uncorrectable error will cause a ma    788         An uncorrectable error will cause a machine panic.  This is usually
789         desirable.  It is a bad idea to contin    789         desirable.  It is a bad idea to continue when an uncorrectable error
790         occurs - it is indeterminate what was     790         occurs - it is indeterminate what was uncorrected and the operating
791         system context might be so mangled tha    791         system context might be so mangled that continuing will lead to further
792         corruption. If the kernel has MCE conf    792         corruption. If the kernel has MCE configured, then EDAC will never
793         notice the UE.                            793         notice the UE.
794                                                   794 
795         LOAD TIME::                               795         LOAD TIME::
796                                                   796 
797                 module/kernel parameter: edac_    797                 module/kernel parameter: edac_mc_panic_on_ue=[0|1]
798                                                   798 
799         RUN TIME::                                799         RUN TIME::
800                                                   800 
801                 echo "1" > /sys/module/edac_co    801                 echo "1" > /sys/module/edac_core/parameters/edac_mc_panic_on_ue
802                                                   802 
803                                                   803 
804 - ``edac_mc_log_ue`` - Log UE control file        804 - ``edac_mc_log_ue`` - Log UE control file
805                                                   805 
806                                                   806 
807         Generate kernel messages describing un    807         Generate kernel messages describing uncorrectable errors.  These errors
808         are reported through the system messag    808         are reported through the system message log system.  UE statistics
809         will be accumulated even when UE loggi    809         will be accumulated even when UE logging is disabled.
810                                                   810 
811         LOAD TIME::                               811         LOAD TIME::
812                                                   812 
813                 module/kernel parameter: edac_    813                 module/kernel parameter: edac_mc_log_ue=[0|1]
814                                                   814 
815         RUN TIME::                                815         RUN TIME::
816                                                   816 
817                 echo "1" > /sys/module/edac_co    817                 echo "1" > /sys/module/edac_core/parameters/edac_mc_log_ue
818                                                   818 
819                                                   819 
820 - ``edac_mc_log_ce`` - Log CE control file        820 - ``edac_mc_log_ce`` - Log CE control file
821                                                   821 
822                                                   822 
823         Generate kernel messages describing co    823         Generate kernel messages describing correctable errors.  These
824         errors are reported through the system    824         errors are reported through the system message log system.
825         CE statistics will be accumulated even    825         CE statistics will be accumulated even when CE logging is disabled.
826                                                   826 
827         LOAD TIME::                               827         LOAD TIME::
828                                                   828 
829                 module/kernel parameter: edac_    829                 module/kernel parameter: edac_mc_log_ce=[0|1]
830                                                   830 
831         RUN TIME::                                831         RUN TIME::
832                                                   832 
833                 echo "1" > /sys/module/edac_co    833                 echo "1" > /sys/module/edac_core/parameters/edac_mc_log_ce
834                                                   834 
835                                                   835 
836 - ``edac_mc_poll_msec`` - Polling period contr    836 - ``edac_mc_poll_msec`` - Polling period control file
837                                                   837 
838                                                   838 
839         The time period, in milliseconds, for     839         The time period, in milliseconds, for polling for error information.
840         Too small a value wastes resources.  T    840         Too small a value wastes resources.  Too large a value might delay
841         necessary handling of errors and might    841         necessary handling of errors and might loose valuable information for
842         locating the error.  1000 milliseconds    842         locating the error.  1000 milliseconds (once each second) is the current
843         default. Systems which require all the    843         default. Systems which require all the bandwidth they can get, may
844         increase this.                            844         increase this.
845                                                   845 
846         LOAD TIME::                               846         LOAD TIME::
847                                                   847 
848                 module/kernel parameter: edac_    848                 module/kernel parameter: edac_mc_poll_msec=[0|1]
849                                                   849 
850         RUN TIME::                                850         RUN TIME::
851                                                   851 
852                 echo "1000" > /sys/module/edac    852                 echo "1000" > /sys/module/edac_core/parameters/edac_mc_poll_msec
853                                                   853 
854                                                   854 
855 - ``panic_on_pci_parity`` - Panic on PCI PARIT    855 - ``panic_on_pci_parity`` - Panic on PCI PARITY Error
856                                                   856 
857                                                   857 
858         This control file enables or disables     858         This control file enables or disables panicking when a parity
859         error has been detected.                  859         error has been detected.
860                                                   860 
861                                                   861 
862         module/kernel parameter::                 862         module/kernel parameter::
863                                                   863 
864                         edac_panic_on_pci_pe=[    864                         edac_panic_on_pci_pe=[0|1]
865                                                   865 
866         Enable::                                  866         Enable::
867                                                   867 
868                 echo "1" > /sys/module/edac_co    868                 echo "1" > /sys/module/edac_core/parameters/edac_panic_on_pci_pe
869                                                   869 
870         Disable::                                 870         Disable::
871                                                   871 
872                 echo "0" > /sys/module/edac_co    872                 echo "0" > /sys/module/edac_core/parameters/edac_panic_on_pci_pe
873                                                   873 
874                                                   874 
875                                                   875 
876 EDAC device type                                  876 EDAC device type
877 ----------------                                  877 ----------------
878                                                   878 
879 In the header file, edac_pci.h, there is a ser    879 In the header file, edac_pci.h, there is a series of edac_device structures
880 and APIs for the EDAC_DEVICE.                     880 and APIs for the EDAC_DEVICE.
881                                                   881 
882 User space access to an edac_device is through    882 User space access to an edac_device is through the sysfs interface.
883                                                   883 
884 At the location ``/sys/devices/system/edac`` (    884 At the location ``/sys/devices/system/edac`` (sysfs) new edac_device devices
885 will appear.                                      885 will appear.
886                                                   886 
887 There is a three level tree beneath the above     887 There is a three level tree beneath the above ``edac`` directory. For example,
888 the ``test_device_edac`` device (found at the     888 the ``test_device_edac`` device (found at the http://bluesmoke.sourceforget.net
889 website) installs itself as::                     889 website) installs itself as::
890                                                   890 
891         /sys/devices/system/edac/test-instance    891         /sys/devices/system/edac/test-instance
892                                                   892 
893 in this directory are various controls, a syml    893 in this directory are various controls, a symlink and one or more ``instance``
894 directories.                                      894 directories.
895                                                   895 
896 The standard default controls are:                896 The standard default controls are:
897                                                   897 
898         ==============  ======================    898         ==============  =======================================================
899         log_ce          boolean to log CE even    899         log_ce          boolean to log CE events
900         log_ue          boolean to log UE even    900         log_ue          boolean to log UE events
901         panic_on_ue     boolean to ``panic`` t    901         panic_on_ue     boolean to ``panic`` the system if an UE is encountered
902                         (default off, can be s    902                         (default off, can be set true via startup script)
903         poll_msec       time period between PO    903         poll_msec       time period between POLL cycles for events
904         ==============  ======================    904         ==============  =======================================================
905                                                   905 
906 The test_device_edac device adds at least one     906 The test_device_edac device adds at least one of its own custom control:
907                                                   907 
908         ==============  ======================    908         ==============  ==================================================
909         test_bits       which in the current t    909         test_bits       which in the current test driver does nothing but
910                         show how it is install    910                         show how it is installed. A ported driver can
911                         add one or more such c    911                         add one or more such controls and/or attributes
912                         for specific uses.        912                         for specific uses.
913                         One out-of-tree driver    913                         One out-of-tree driver uses controls here to allow
914                         for ERROR INJECTION op    914                         for ERROR INJECTION operations to hardware
915                         injection registers       915                         injection registers
916         ==============  ======================    916         ==============  ==================================================
917                                                   917 
918 The symlink points to the 'struct dev' that is    918 The symlink points to the 'struct dev' that is registered for this edac_device.
919                                                   919 
920 Instances                                         920 Instances
921 ---------                                         921 ---------
922                                                   922 
923 One or more instance directories are present.     923 One or more instance directories are present. For the ``test_device_edac``
924 case:                                             924 case:
925                                                   925 
926         +----------------+                        926         +----------------+
927         | test-instance0 |                        927         | test-instance0 |
928         +----------------+                        928         +----------------+
929                                                   929 
930                                                   930 
931 In this directory there are two default counte    931 In this directory there are two default counter attributes, which are totals of
932 counter in deeper subdirectories.                 932 counter in deeper subdirectories.
933                                                   933 
934         ==============  ======================    934         ==============  ====================================
935         ce_count        total of CE events of     935         ce_count        total of CE events of subdirectories
936         ue_count        total of UE events of     936         ue_count        total of UE events of subdirectories
937         ==============  ======================    937         ==============  ====================================
938                                                   938 
939 Blocks                                            939 Blocks
940 ------                                            940 ------
941                                                   941 
942 At the lowest directory level is the ``block``    942 At the lowest directory level is the ``block`` directory. There can be 0, 1
943 or more blocks specified in each instance:        943 or more blocks specified in each instance:
944                                                   944 
945         +-------------+                           945         +-------------+
946         | test-block0 |                           946         | test-block0 |
947         +-------------+                           947         +-------------+
948                                                   948 
949 In this directory the default attributes are:     949 In this directory the default attributes are:
950                                                   950 
951         ==============  ======================    951         ==============  ================================================
952         ce_count        which is counter of CE    952         ce_count        which is counter of CE events for this ``block``
953                         of hardware being moni    953                         of hardware being monitored
954         ue_count        which is counter of UE    954         ue_count        which is counter of UE events for this ``block``
955                         of hardware being moni    955                         of hardware being monitored
956         ==============  ======================    956         ==============  ================================================
957                                                   957 
958                                                   958 
959 The ``test_device_edac`` device adds 4 attribu    959 The ``test_device_edac`` device adds 4 attributes and 1 control:
960                                                   960 
961         ================== ===================    961         ================== ====================================================
962         test-block-bits-0       for every POLL    962         test-block-bits-0       for every POLL cycle this counter
963                                 is incremented    963                                 is incremented
964         test-block-bits-1       every 10 cycle    964         test-block-bits-1       every 10 cycles, this counter is bumped once,
965                                 and test-block    965                                 and test-block-bits-0 is set to 0
966         test-block-bits-2       every 100 cycl    966         test-block-bits-2       every 100 cycles, this counter is bumped once,
967                                 and test-block    967                                 and test-block-bits-1 is set to 0
968         test-block-bits-3       every 1000 cyc    968         test-block-bits-3       every 1000 cycles, this counter is bumped once,
969                                 and test-block    969                                 and test-block-bits-2 is set to 0
970         ================== ===================    970         ================== ====================================================
971                                                   971 
972                                                   972 
973         ================== ===================    973         ================== ====================================================
974         reset-counters          writing ANY th    974         reset-counters          writing ANY thing to this control will
975                                 reset all the     975                                 reset all the above counters.
976         ================== ===================    976         ================== ====================================================
977                                                   977 
978                                                   978 
979 Use of the ``test_device_edac`` driver should     979 Use of the ``test_device_edac`` driver should enable any others to create their own
980 unique drivers for their hardware systems.        980 unique drivers for their hardware systems.
981                                                   981 
982 The ``test_device_edac`` sample driver is loca    982 The ``test_device_edac`` sample driver is located at the
983 http://bluesmoke.sourceforge.net project site     983 http://bluesmoke.sourceforge.net project site for EDAC.
984                                                   984 
985                                                   985 
986 Usage of EDAC APIs on Nehalem and newer Intel     986 Usage of EDAC APIs on Nehalem and newer Intel CPUs
987 ----------------------------------------------    987 --------------------------------------------------
988                                                   988 
989 On older Intel architectures, the memory contr    989 On older Intel architectures, the memory controller was part of the North
990 Bridge chipset. Nehalem, Sandy Bridge, Ivy Bri    990 Bridge chipset. Nehalem, Sandy Bridge, Ivy Bridge, Haswell, Sky Lake and
991 newer Intel architectures integrated an enhanc    991 newer Intel architectures integrated an enhanced version of the memory
992 controller (MC) inside the CPUs.                  992 controller (MC) inside the CPUs.
993                                                   993 
994 This chapter will cover the differences of the    994 This chapter will cover the differences of the enhanced memory controllers
995 found on newer Intel CPUs, such as ``i7core_ed    995 found on newer Intel CPUs, such as ``i7core_edac``, ``sb_edac`` and
996 ``sbx_edac`` drivers.                             996 ``sbx_edac`` drivers.
997                                                   997 
998 .. note::                                         998 .. note::
999                                                   999 
1000    The Xeon E7 processor families use a separ    1000    The Xeon E7 processor families use a separate chip for the memory
1001    controller, called Intel Scalable Memory B    1001    controller, called Intel Scalable Memory Buffer. This section doesn't
1002    apply for such families.                      1002    apply for such families.
1003                                                  1003 
1004 1) There is one Memory Controller per Quick P    1004 1) There is one Memory Controller per Quick Patch Interconnect
1005    (QPI). At the driver, the term "socket" me    1005    (QPI). At the driver, the term "socket" means one QPI. This is
1006    associated with a physical CPU socket.        1006    associated with a physical CPU socket.
1007                                                  1007 
1008    Each MC have 3 physical read channels, 3 p    1008    Each MC have 3 physical read channels, 3 physical write channels and
1009    3 logic channels. The driver currently see    1009    3 logic channels. The driver currently sees it as just 3 channels.
1010    Each channel can have up to 3 DIMMs.          1010    Each channel can have up to 3 DIMMs.
1011                                                  1011 
1012    The minimum known unity is DIMMs. There ar    1012    The minimum known unity is DIMMs. There are no information about csrows.
1013    As EDAC API maps the minimum unity is csro    1013    As EDAC API maps the minimum unity is csrows, the driver sequentially
1014    maps channel/DIMM into different csrows.      1014    maps channel/DIMM into different csrows.
1015                                                  1015 
1016    For example, supposing the following layou    1016    For example, supposing the following layout::
1017                                                  1017 
1018         Ch0 phy rd0, wr0 (0x063f4031): 2 rank    1018         Ch0 phy rd0, wr0 (0x063f4031): 2 ranks, UDIMMs
1019           dimm 0 1024 Mb offset: 0, bank: 8,     1019           dimm 0 1024 Mb offset: 0, bank: 8, rank: 1, row: 0x4000, col: 0x400
1020           dimm 1 1024 Mb offset: 4, bank: 8,     1020           dimm 1 1024 Mb offset: 4, bank: 8, rank: 1, row: 0x4000, col: 0x400
1021         Ch1 phy rd1, wr1 (0x063f4031): 2 rank    1021         Ch1 phy rd1, wr1 (0x063f4031): 2 ranks, UDIMMs
1022           dimm 0 1024 Mb offset: 0, bank: 8,     1022           dimm 0 1024 Mb offset: 0, bank: 8, rank: 1, row: 0x4000, col: 0x400
1023         Ch2 phy rd3, wr3 (0x063f4031): 2 rank    1023         Ch2 phy rd3, wr3 (0x063f4031): 2 ranks, UDIMMs
1024           dimm 0 1024 Mb offset: 0, bank: 8,     1024           dimm 0 1024 Mb offset: 0, bank: 8, rank: 1, row: 0x4000, col: 0x400
1025                                                  1025 
1026    The driver will map it as::                   1026    The driver will map it as::
1027                                                  1027 
1028         csrow0: channel 0, dimm0                 1028         csrow0: channel 0, dimm0
1029         csrow1: channel 0, dimm1                 1029         csrow1: channel 0, dimm1
1030         csrow2: channel 1, dimm0                 1030         csrow2: channel 1, dimm0
1031         csrow3: channel 2, dimm0                 1031         csrow3: channel 2, dimm0
1032                                                  1032 
1033    exports one DIMM per csrow.                   1033    exports one DIMM per csrow.
1034                                                  1034 
1035    Each QPI is exported as a different memory    1035    Each QPI is exported as a different memory controller.
1036                                                  1036 
1037 2) The MC has the ability to inject errors to    1037 2) The MC has the ability to inject errors to test drivers. The drivers
1038    implement this functionality via some erro    1038    implement this functionality via some error injection nodes:
1039                                                  1039 
1040    For injecting a memory error, there are so    1040    For injecting a memory error, there are some sysfs nodes, under
1041    ``/sys/devices/system/edac/mc/mc?/``:         1041    ``/sys/devices/system/edac/mc/mc?/``:
1042                                                  1042 
1043    - ``inject_addrmatch/*``:                     1043    - ``inject_addrmatch/*``:
1044       Controls the error injection mask regis    1044       Controls the error injection mask register. It is possible to specify
1045       several characteristics of the address     1045       several characteristics of the address to match an error code::
1046                                                  1046 
1047          dimm = the affected dimm. Numbers ar    1047          dimm = the affected dimm. Numbers are relative to a channel;
1048          rank = the memory rank;                 1048          rank = the memory rank;
1049          channel = the channel that will gene    1049          channel = the channel that will generate an error;
1050          bank = the affected bank;               1050          bank = the affected bank;
1051          page = the page address;                1051          page = the page address;
1052          column (or col) = the address column    1052          column (or col) = the address column.
1053                                                  1053 
1054       each of the above values can be set to     1054       each of the above values can be set to "any" to match any valid value.
1055                                                  1055 
1056       At driver init, all values are set to a    1056       At driver init, all values are set to any.
1057                                                  1057 
1058       For example, to generate an error at ra    1058       For example, to generate an error at rank 1 of dimm 2, for any channel,
1059       any bank, any page, any column::           1059       any bank, any page, any column::
1060                                                  1060 
1061                 echo 2 >/sys/devices/system/e    1061                 echo 2 >/sys/devices/system/edac/mc/mc0/inject_addrmatch/dimm
1062                 echo 1 >/sys/devices/system/e    1062                 echo 1 >/sys/devices/system/edac/mc/mc0/inject_addrmatch/rank
1063                                                  1063 
1064         To return to the default behaviour of    1064         To return to the default behaviour of matching any, you can do::
1065                                                  1065 
1066                 echo any >/sys/devices/system    1066                 echo any >/sys/devices/system/edac/mc/mc0/inject_addrmatch/dimm
1067                 echo any >/sys/devices/system    1067                 echo any >/sys/devices/system/edac/mc/mc0/inject_addrmatch/rank
1068                                                  1068 
1069    - ``inject_eccmask``:                         1069    - ``inject_eccmask``:
1070           specifies what bits will have troub    1070           specifies what bits will have troubles,
1071                                                  1071 
1072    - ``inject_section``:                         1072    - ``inject_section``:
1073        specifies what ECC cache section will     1073        specifies what ECC cache section will get the error::
1074                                                  1074 
1075                 3 for both                       1075                 3 for both
1076                 2 for the highest                1076                 2 for the highest
1077                 1 for the lowest                 1077                 1 for the lowest
1078                                                  1078 
1079    - ``inject_type``:                            1079    - ``inject_type``:
1080        specifies the type of error, being a c    1080        specifies the type of error, being a combination of the following bits::
1081                                                  1081 
1082                 bit 0 - repeat                   1082                 bit 0 - repeat
1083                 bit 1 - ecc                      1083                 bit 1 - ecc
1084                 bit 2 - parity                   1084                 bit 2 - parity
1085                                                  1085 
1086    - ``inject_enable``:                          1086    - ``inject_enable``:
1087        starts the error generation when somet    1087        starts the error generation when something different than 0 is written.
1088                                                  1088 
1089    All inject vars can be read. root permissi    1089    All inject vars can be read. root permission is needed for write.
1090                                                  1090 
1091    Datasheet states that the error will only     1091    Datasheet states that the error will only be generated after a write on an
1092    address that matches inject_addrmatch. It     1092    address that matches inject_addrmatch. It seems, however, that reading will
1093    also produce an error.                        1093    also produce an error.
1094                                                  1094 
1095    For example, the following code will gener    1095    For example, the following code will generate an error for any write access
1096    at socket 0, on any DIMM/address on channe    1096    at socket 0, on any DIMM/address on channel 2::
1097                                                  1097 
1098         echo 2 >/sys/devices/system/edac/mc/m    1098         echo 2 >/sys/devices/system/edac/mc/mc0/inject_addrmatch/channel
1099         echo 2 >/sys/devices/system/edac/mc/m    1099         echo 2 >/sys/devices/system/edac/mc/mc0/inject_type
1100         echo 64 >/sys/devices/system/edac/mc/    1100         echo 64 >/sys/devices/system/edac/mc/mc0/inject_eccmask
1101         echo 3 >/sys/devices/system/edac/mc/m    1101         echo 3 >/sys/devices/system/edac/mc/mc0/inject_section
1102         echo 1 >/sys/devices/system/edac/mc/m    1102         echo 1 >/sys/devices/system/edac/mc/mc0/inject_enable
1103         dd if=/dev/mem of=/dev/null seek=16k     1103         dd if=/dev/mem of=/dev/null seek=16k bs=4k count=1 >& /dev/null
1104                                                  1104 
1105    For socket 1, it is needed to replace "mc0    1105    For socket 1, it is needed to replace "mc0" by "mc1" at the above
1106    commands.                                     1106    commands.
1107                                                  1107 
1108    The generated error message will look like    1108    The generated error message will look like::
1109                                                  1109 
1110         EDAC MC0: UE row 0, channel-a= 0 chan    1110         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))
1111                                                  1111 
1112 3) Corrected Error memory register counters      1112 3) Corrected Error memory register counters
1113                                                  1113 
1114    Those newer MCs have some registers to cou    1114    Those newer MCs have some registers to count memory errors. The driver
1115    uses those registers to report Corrected E    1115    uses those registers to report Corrected Errors on devices with Registered
1116    DIMMs.                                        1116    DIMMs.
1117                                                  1117 
1118    However, those counters don't work with Un    1118    However, those counters don't work with Unregistered DIMM. As the chipset
1119    offers some counters that also work with U    1119    offers some counters that also work with UDIMMs (but with a worse level of
1120    granularity than the default ones), the dr    1120    granularity than the default ones), the driver exposes those registers for
1121    UDIMM memories.                               1121    UDIMM memories.
1122                                                  1122 
1123    They can be read by looking at the content    1123    They can be read by looking at the contents of ``all_channel_counts/``::
1124                                                  1124 
1125      $ for i in /sys/devices/system/edac/mc/m    1125      $ for i in /sys/devices/system/edac/mc/mc0/all_channel_counts/*; do echo $i; cat $i; done
1126         /sys/devices/system/edac/mc/mc0/all_c    1126         /sys/devices/system/edac/mc/mc0/all_channel_counts/udimm0
1127         0                                        1127         0
1128         /sys/devices/system/edac/mc/mc0/all_c    1128         /sys/devices/system/edac/mc/mc0/all_channel_counts/udimm1
1129         0                                        1129         0
1130         /sys/devices/system/edac/mc/mc0/all_c    1130         /sys/devices/system/edac/mc/mc0/all_channel_counts/udimm2
1131         0                                        1131         0
1132                                                  1132 
1133    What happens here is that errors on differ    1133    What happens here is that errors on different csrows, but at the same
1134    dimm number will increment the same counte    1134    dimm number will increment the same counter.
1135    So, in this memory mapping::                  1135    So, in this memory mapping::
1136                                                  1136 
1137         csrow0: channel 0, dimm0                 1137         csrow0: channel 0, dimm0
1138         csrow1: channel 0, dimm1                 1138         csrow1: channel 0, dimm1
1139         csrow2: channel 1, dimm0                 1139         csrow2: channel 1, dimm0
1140         csrow3: channel 2, dimm0                 1140         csrow3: channel 2, dimm0
1141                                                  1141 
1142    The hardware will increment udimm0 for an     1142    The hardware will increment udimm0 for an error at the first dimm at either
1143    csrow0, csrow2  or csrow3;                    1143    csrow0, csrow2  or csrow3;
1144                                                  1144 
1145    The hardware will increment udimm1 for an     1145    The hardware will increment udimm1 for an error at the second dimm at either
1146    csrow0, csrow2  or csrow3;                    1146    csrow0, csrow2  or csrow3;
1147                                                  1147 
1148    The hardware will increment udimm2 for an     1148    The hardware will increment udimm2 for an error at the third dimm at either
1149    csrow0, csrow2  or csrow3;                    1149    csrow0, csrow2  or csrow3;
1150                                                  1150 
1151 4) Standard error counters                       1151 4) Standard error counters
1152                                                  1152 
1153    The standard error counters are generated     1153    The standard error counters are generated when an mcelog error is received
1154    by the driver. Since, with UDIMM, this is     1154    by the driver. Since, with UDIMM, this is counted by software, it is
1155    possible that some errors could be lost. W    1155    possible that some errors could be lost. With RDIMM's, they display the
1156    contents of the registers                     1156    contents of the registers
1157                                                  1157 
1158 Reference documents used on ``amd64_edac``       1158 Reference documents used on ``amd64_edac``
1159 ------------------------------------------       1159 ------------------------------------------
1160                                                  1160 
1161 ``amd64_edac`` module is based on the followi    1161 ``amd64_edac`` module is based on the following documents
1162 (available from http://support.amd.com/en-us/    1162 (available from http://support.amd.com/en-us/search/tech-docs):
1163                                                  1163 
1164 1. :Title:  BIOS and Kernel Developer's Guide    1164 1. :Title:  BIOS and Kernel Developer's Guide for AMD Athlon 64 and AMD
1165            Opteron Processors                    1165            Opteron Processors
1166    :AMD publication #: 26094                     1166    :AMD publication #: 26094
1167    :Revision: 3.26                               1167    :Revision: 3.26
1168    :Link: http://support.amd.com/TechDocs/260    1168    :Link: http://support.amd.com/TechDocs/26094.PDF
1169                                                  1169 
1170 2. :Title:  BIOS and Kernel Developer's Guide    1170 2. :Title:  BIOS and Kernel Developer's Guide for AMD NPT Family 0Fh
1171            Processors                            1171            Processors
1172    :AMD publication #: 32559                     1172    :AMD publication #: 32559
1173    :Revision: 3.00                               1173    :Revision: 3.00
1174    :Issue Date: May 2006                         1174    :Issue Date: May 2006
1175    :Link: http://support.amd.com/TechDocs/325    1175    :Link: http://support.amd.com/TechDocs/32559.pdf
1176                                                  1176 
1177 3. :Title:  BIOS and Kernel Developer's Guide    1177 3. :Title:  BIOS and Kernel Developer's Guide (BKDG) For AMD Family 10h
1178            Processors                            1178            Processors
1179    :AMD publication #: 31116                     1179    :AMD publication #: 31116
1180    :Revision: 3.00                               1180    :Revision: 3.00
1181    :Issue Date: September 07, 2007               1181    :Issue Date: September 07, 2007
1182    :Link: http://support.amd.com/TechDocs/311    1182    :Link: http://support.amd.com/TechDocs/31116.pdf
1183                                                  1183 
1184 4. :Title: BIOS and Kernel Developer's Guide     1184 4. :Title: BIOS and Kernel Developer's Guide (BKDG) for AMD Family 15h
1185           Models 30h-3Fh Processors              1185           Models 30h-3Fh Processors
1186    :AMD publication #: 49125                     1186    :AMD publication #: 49125
1187    :Revision: 3.06                               1187    :Revision: 3.06
1188    :Issue Date: 2/12/2015 (latest release)       1188    :Issue Date: 2/12/2015 (latest release)
1189    :Link: http://support.amd.com/TechDocs/491    1189    :Link: http://support.amd.com/TechDocs/49125_15h_Models_30h-3Fh_BKDG.pdf
1190                                                  1190 
1191 5. :Title: BIOS and Kernel Developer's Guide     1191 5. :Title: BIOS and Kernel Developer's Guide (BKDG) for AMD Family 15h
1192           Models 60h-6Fh Processors              1192           Models 60h-6Fh Processors
1193    :AMD publication #: 50742                     1193    :AMD publication #: 50742
1194    :Revision: 3.01                               1194    :Revision: 3.01
1195    :Issue Date: 7/23/2015 (latest release)       1195    :Issue Date: 7/23/2015 (latest release)
1196    :Link: http://support.amd.com/TechDocs/507    1196    :Link: http://support.amd.com/TechDocs/50742_15h_Models_60h-6Fh_BKDG.pdf
1197                                                  1197 
1198 6. :Title: BIOS and Kernel Developer's Guide     1198 6. :Title: BIOS and Kernel Developer's Guide (BKDG) for AMD Family 16h
1199           Models 00h-0Fh Processors              1199           Models 00h-0Fh Processors
1200    :AMD publication #: 48751                     1200    :AMD publication #: 48751
1201    :Revision: 3.03                               1201    :Revision: 3.03
1202    :Issue Date: 2/23/2015 (latest release)       1202    :Issue Date: 2/23/2015 (latest release)
1203    :Link: http://support.amd.com/TechDocs/487    1203    :Link: http://support.amd.com/TechDocs/48751_16h_bkdg.pdf
1204                                                  1204 
1205 Credits                                          1205 Credits
1206 =======                                          1206 =======
1207                                                  1207 
1208 * Written by Doug Thompson <dougthompson@xmiss    1208 * Written by Doug Thompson <dougthompson@xmission.com>
1209                                                  1209 
1210   - 7 Dec 2005                                   1210   - 7 Dec 2005
1211   - 17 Jul 2007 Updated                          1211   - 17 Jul 2007 Updated
1212                                                  1212 
1213 * |copy| Mauro Carvalho Chehab                   1213 * |copy| Mauro Carvalho Chehab
1214                                                  1214 
1215   - 05 Aug 2009 Nehalem interface                1215   - 05 Aug 2009 Nehalem interface
1216   - 26 Oct 2016 Converted to ReST and cleanup    1216   - 26 Oct 2016 Converted to ReST and cleanups at the Nehalem section
1217                                                  1217 
1218 * EDAC authors/maintainers:                      1218 * EDAC authors/maintainers:
1219                                                  1219 
1220   - Doug Thompson, Dave Jiang, Dave Peterson     1220   - Doug Thompson, Dave Jiang, Dave Peterson et al,
1221   - Mauro Carvalho Chehab                        1221   - Mauro Carvalho Chehab
1222   - Borislav Petkov                              1222   - Borislav Petkov
1223   - original author: Thayne Harbaugh             1223   - original author: Thayne Harbaugh
                                                      

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php