]> asedeno.scripts.mit.edu Git - linux.git/blob - drivers/edac/amd64_edac.h
EDAC, amd64: Remove unused printing macros
[linux.git] / drivers / edac / amd64_edac.h
1 /*
2  * AMD64 class Memory Controller kernel module
3  *
4  * Copyright (c) 2009 SoftwareBitMaker.
5  * Copyright (c) 2009-15 Advanced Micro Devices, Inc.
6  *
7  * This file may be distributed under the terms of the
8  * GNU General Public License.
9  */
10
11 #include <linux/module.h>
12 #include <linux/ctype.h>
13 #include <linux/init.h>
14 #include <linux/pci.h>
15 #include <linux/pci_ids.h>
16 #include <linux/slab.h>
17 #include <linux/mmzone.h>
18 #include <linux/edac.h>
19 #include <asm/msr.h>
20 #include "edac_module.h"
21 #include "mce_amd.h"
22
23 #define amd64_info(fmt, arg...) \
24         edac_printk(KERN_INFO, "amd64", fmt, ##arg)
25
26 #define amd64_warn(fmt, arg...) \
27         edac_printk(KERN_WARNING, "amd64", "Warning: " fmt, ##arg)
28
29 #define amd64_err(fmt, arg...) \
30         edac_printk(KERN_ERR, "amd64", "Error: " fmt, ##arg)
31
32 #define amd64_mc_warn(mci, fmt, arg...) \
33         edac_mc_chipset_printk(mci, KERN_WARNING, "amd64", fmt, ##arg)
34
35 #define amd64_mc_err(mci, fmt, arg...) \
36         edac_mc_chipset_printk(mci, KERN_ERR, "amd64", fmt, ##arg)
37
38 /*
39  * Throughout the comments in this code, the following terms are used:
40  *
41  *      SysAddr, DramAddr, and InputAddr
42  *
43  *  These terms come directly from the amd64 documentation
44  * (AMD publication #26094).  They are defined as follows:
45  *
46  *     SysAddr:
47  *         This is a physical address generated by a CPU core or a device
48  *         doing DMA.  If generated by a CPU core, a SysAddr is the result of
49  *         a virtual to physical address translation by the CPU core's address
50  *         translation mechanism (MMU).
51  *
52  *     DramAddr:
53  *         A DramAddr is derived from a SysAddr by subtracting an offset that
54  *         depends on which node the SysAddr maps to and whether the SysAddr
55  *         is within a range affected by memory hoisting.  The DRAM Base
56  *         (section 3.4.4.1) and DRAM Limit (section 3.4.4.2) registers
57  *         determine which node a SysAddr maps to.
58  *
59  *         If the DRAM Hole Address Register (DHAR) is enabled and the SysAddr
60  *         is within the range of addresses specified by this register, then
61  *         a value x from the DHAR is subtracted from the SysAddr to produce a
62  *         DramAddr.  Here, x represents the base address for the node that
63  *         the SysAddr maps to plus an offset due to memory hoisting.  See
64  *         section 3.4.8 and the comments in amd64_get_dram_hole_info() and
65  *         sys_addr_to_dram_addr() below for more information.
66  *
67  *         If the SysAddr is not affected by the DHAR then a value y is
68  *         subtracted from the SysAddr to produce a DramAddr.  Here, y is the
69  *         base address for the node that the SysAddr maps to.  See section
70  *         3.4.4 and the comments in sys_addr_to_dram_addr() below for more
71  *         information.
72  *
73  *     InputAddr:
74  *         A DramAddr is translated to an InputAddr before being passed to the
75  *         memory controller for the node that the DramAddr is associated
76  *         with.  The memory controller then maps the InputAddr to a csrow.
77  *         If node interleaving is not in use, then the InputAddr has the same
78  *         value as the DramAddr.  Otherwise, the InputAddr is produced by
79  *         discarding the bits used for node interleaving from the DramAddr.
80  *         See section 3.4.4 for more information.
81  *
82  *         The memory controller for a given node uses its DRAM CS Base and
83  *         DRAM CS Mask registers to map an InputAddr to a csrow.  See
84  *         sections 3.5.4 and 3.5.5 for more information.
85  */
86
87 #define EDAC_AMD64_VERSION              "3.4.0"
88 #define EDAC_MOD_STR                    "amd64_edac"
89
90 /* Extended Model from CPUID, for CPU Revision numbers */
91 #define K8_REV_D                        1
92 #define K8_REV_E                        2
93 #define K8_REV_F                        4
94
95 /* Hardware limit on ChipSelect rows per MC and processors per system */
96 #define NUM_CHIPSELECTS                 8
97 #define DRAM_RANGES                     8
98
99 #define ON true
100 #define OFF false
101
102 /*
103  * PCI-defined configuration space registers
104  */
105 #define PCI_DEVICE_ID_AMD_15H_NB_F1     0x1601
106 #define PCI_DEVICE_ID_AMD_15H_NB_F2     0x1602
107 #define PCI_DEVICE_ID_AMD_15H_M30H_NB_F1 0x141b
108 #define PCI_DEVICE_ID_AMD_15H_M30H_NB_F2 0x141c
109 #define PCI_DEVICE_ID_AMD_15H_M60H_NB_F1 0x1571
110 #define PCI_DEVICE_ID_AMD_15H_M60H_NB_F2 0x1572
111 #define PCI_DEVICE_ID_AMD_16H_NB_F1     0x1531
112 #define PCI_DEVICE_ID_AMD_16H_NB_F2     0x1532
113 #define PCI_DEVICE_ID_AMD_16H_M30H_NB_F1 0x1581
114 #define PCI_DEVICE_ID_AMD_16H_M30H_NB_F2 0x1582
115 #define PCI_DEVICE_ID_AMD_17H_DF_F0     0x1460
116 #define PCI_DEVICE_ID_AMD_17H_DF_F6     0x1466
117
118 /*
119  * Function 1 - Address Map
120  */
121 #define DRAM_BASE_LO                    0x40
122 #define DRAM_LIMIT_LO                   0x44
123
124 /*
125  * F15 M30h D18F1x2[1C:00]
126  */
127 #define DRAM_CONT_BASE                  0x200
128 #define DRAM_CONT_LIMIT                 0x204
129
130 /*
131  * F15 M30h D18F1x2[4C:40]
132  */
133 #define DRAM_CONT_HIGH_OFF              0x240
134
135 #define dram_rw(pvt, i)                 ((u8)(pvt->ranges[i].base.lo & 0x3))
136 #define dram_intlv_sel(pvt, i)          ((u8)((pvt->ranges[i].lim.lo >> 8) & 0x7))
137 #define dram_dst_node(pvt, i)           ((u8)(pvt->ranges[i].lim.lo & 0x7))
138
139 #define DHAR                            0xf0
140 #define dhar_mem_hoist_valid(pvt)       ((pvt)->dhar & BIT(1))
141 #define dhar_base(pvt)                  ((pvt)->dhar & 0xff000000)
142 #define k8_dhar_offset(pvt)             (((pvt)->dhar & 0x0000ff00) << 16)
143
144                                         /* NOTE: Extra mask bit vs K8 */
145 #define f10_dhar_offset(pvt)            (((pvt)->dhar & 0x0000ff80) << 16)
146
147 #define DCT_CFG_SEL                     0x10C
148
149 #define DRAM_LOCAL_NODE_BASE            0x120
150 #define DRAM_LOCAL_NODE_LIM             0x124
151
152 #define DRAM_BASE_HI                    0x140
153 #define DRAM_LIMIT_HI                   0x144
154
155
156 /*
157  * Function 2 - DRAM controller
158  */
159 #define DCSB0                           0x40
160 #define DCSB1                           0x140
161 #define DCSB_CS_ENABLE                  BIT(0)
162
163 #define DCSM0                           0x60
164 #define DCSM1                           0x160
165
166 #define csrow_enabled(i, dct, pvt)      ((pvt)->csels[(dct)].csbases[(i)] & DCSB_CS_ENABLE)
167
168 #define DRAM_CONTROL                    0x78
169
170 #define DBAM0                           0x80
171 #define DBAM1                           0x180
172
173 /* Extract the DIMM 'type' on the i'th DIMM from the DBAM reg value passed */
174 #define DBAM_DIMM(i, reg)               ((((reg) >> (4*(i)))) & 0xF)
175
176 #define DBAM_MAX_VALUE                  11
177
178 #define DCLR0                           0x90
179 #define DCLR1                           0x190
180 #define REVE_WIDTH_128                  BIT(16)
181 #define WIDTH_128                       BIT(11)
182
183 #define DCHR0                           0x94
184 #define DCHR1                           0x194
185 #define DDR3_MODE                       BIT(8)
186
187 #define DCT_SEL_LO                      0x110
188 #define dct_high_range_enabled(pvt)     ((pvt)->dct_sel_lo & BIT(0))
189 #define dct_interleave_enabled(pvt)     ((pvt)->dct_sel_lo & BIT(2))
190
191 #define dct_ganging_enabled(pvt)        ((boot_cpu_data.x86 == 0x10) && ((pvt)->dct_sel_lo & BIT(4)))
192
193 #define dct_data_intlv_enabled(pvt)     ((pvt)->dct_sel_lo & BIT(5))
194 #define dct_memory_cleared(pvt)         ((pvt)->dct_sel_lo & BIT(10))
195
196 #define SWAP_INTLV_REG                  0x10c
197
198 #define DCT_SEL_HI                      0x114
199
200 #define F15H_M60H_SCRCTRL               0x1C8
201 #define F17H_SCR_BASE_ADDR              0x48
202 #define F17H_SCR_LIMIT_ADDR             0x4C
203
204 /*
205  * Function 3 - Misc Control
206  */
207 #define NBCTL                           0x40
208
209 #define NBCFG                           0x44
210 #define NBCFG_CHIPKILL                  BIT(23)
211 #define NBCFG_ECC_ENABLE                BIT(22)
212
213 /* F3x48: NBSL */
214 #define F10_NBSL_EXT_ERR_ECC            0x8
215 #define NBSL_PP_OBS                     0x2
216
217 #define SCRCTRL                         0x58
218
219 #define F10_ONLINE_SPARE                0xB0
220 #define online_spare_swap_done(pvt, c)  (((pvt)->online_spare >> (1 + 2 * (c))) & 0x1)
221 #define online_spare_bad_dramcs(pvt, c) (((pvt)->online_spare >> (4 + 4 * (c))) & 0x7)
222
223 #define F10_NB_ARRAY_ADDR               0xB8
224 #define F10_NB_ARRAY_DRAM               BIT(31)
225
226 /* Bits [2:1] are used to select 16-byte section within a 64-byte cacheline  */
227 #define SET_NB_ARRAY_ADDR(section)      (((section) & 0x3) << 1)
228
229 #define F10_NB_ARRAY_DATA               0xBC
230 #define F10_NB_ARR_ECC_WR_REQ           BIT(17)
231 #define SET_NB_DRAM_INJECTION_WRITE(inj)  \
232                                         (BIT(((inj.word) & 0xF) + 20) | \
233                                         F10_NB_ARR_ECC_WR_REQ | inj.bit_map)
234 #define SET_NB_DRAM_INJECTION_READ(inj)  \
235                                         (BIT(((inj.word) & 0xF) + 20) | \
236                                         BIT(16) |  inj.bit_map)
237
238
239 #define NBCAP                           0xE8
240 #define NBCAP_CHIPKILL                  BIT(4)
241 #define NBCAP_SECDED                    BIT(3)
242 #define NBCAP_DCT_DUAL                  BIT(0)
243
244 #define EXT_NB_MCA_CFG                  0x180
245
246 /* MSRs */
247 #define MSR_MCGCTL_NBE                  BIT(4)
248
249 /* F17h */
250
251 /* F0: */
252 #define DF_DHAR                         0x104
253
254 /* UMC CH register offsets */
255 #define UMCCH_BASE_ADDR                 0x0
256 #define UMCCH_ADDR_MASK                 0x20
257 #define UMCCH_ADDR_CFG                  0x30
258 #define UMCCH_DIMM_CFG                  0x80
259 #define UMCCH_UMC_CFG                   0x100
260 #define UMCCH_SDP_CTRL                  0x104
261 #define UMCCH_ECC_CTRL                  0x14C
262 #define UMCCH_ECC_BAD_SYMBOL            0xD90
263 #define UMCCH_UMC_CAP                   0xDF0
264 #define UMCCH_UMC_CAP_HI                0xDF4
265
266 /* UMC CH bitfields */
267 #define UMC_ECC_CHIPKILL_CAP            BIT(31)
268 #define UMC_ECC_ENABLED                 BIT(30)
269
270 #define UMC_SDP_INIT                    BIT(31)
271
272 #define NUM_UMCS                        2
273
274 enum amd_families {
275         K8_CPUS = 0,
276         F10_CPUS,
277         F15_CPUS,
278         F15_M30H_CPUS,
279         F15_M60H_CPUS,
280         F16_CPUS,
281         F16_M30H_CPUS,
282         F17_CPUS,
283         NUM_FAMILIES,
284 };
285
286 /* Error injection control structure */
287 struct error_injection {
288         u32      section;
289         u32      word;
290         u32      bit_map;
291 };
292
293 /* low and high part of PCI config space regs */
294 struct reg_pair {
295         u32 lo, hi;
296 };
297
298 /*
299  * See F1x[1, 0][7C:40] DRAM Base/Limit Registers
300  */
301 struct dram_range {
302         struct reg_pair base;
303         struct reg_pair lim;
304 };
305
306 /* A DCT chip selects collection */
307 struct chip_select {
308         u32 csbases[NUM_CHIPSELECTS];
309         u8 b_cnt;
310
311         u32 csmasks[NUM_CHIPSELECTS];
312         u8 m_cnt;
313 };
314
315 struct amd64_umc {
316         u32 dimm_cfg;           /* DIMM Configuration reg */
317         u32 umc_cfg;            /* Configuration reg */
318         u32 sdp_ctrl;           /* SDP Control reg */
319         u32 ecc_ctrl;           /* DRAM ECC Control reg */
320         u32 umc_cap_hi;         /* Capabilities High reg */
321 };
322
323 struct amd64_pvt {
324         struct low_ops *ops;
325
326         /* pci_device handles which we utilize */
327         struct pci_dev *F0, *F1, *F2, *F3, *F6;
328
329         u16 mc_node_id;         /* MC index of this MC node */
330         u8 fam;                 /* CPU family */
331         u8 model;               /* ... model */
332         u8 stepping;            /* ... stepping */
333
334         int ext_model;          /* extended model value of this node */
335         int channel_count;
336
337         /* Raw registers */
338         u32 dclr0;              /* DRAM Configuration Low DCT0 reg */
339         u32 dclr1;              /* DRAM Configuration Low DCT1 reg */
340         u32 dchr0;              /* DRAM Configuration High DCT0 reg */
341         u32 dchr1;              /* DRAM Configuration High DCT1 reg */
342         u32 nbcap;              /* North Bridge Capabilities */
343         u32 nbcfg;              /* F10 North Bridge Configuration */
344         u32 ext_nbcfg;          /* Extended F10 North Bridge Configuration */
345         u32 dhar;               /* DRAM Hoist reg */
346         u32 dbam0;              /* DRAM Base Address Mapping reg for DCT0 */
347         u32 dbam1;              /* DRAM Base Address Mapping reg for DCT1 */
348
349         /* one for each DCT */
350         struct chip_select csels[2];
351
352         /* DRAM base and limit pairs F1x[78,70,68,60,58,50,48,40] */
353         struct dram_range ranges[DRAM_RANGES];
354
355         u64 top_mem;            /* top of memory below 4GB */
356         u64 top_mem2;           /* top of memory above 4GB */
357
358         u32 dct_sel_lo;         /* DRAM Controller Select Low */
359         u32 dct_sel_hi;         /* DRAM Controller Select High */
360         u32 online_spare;       /* On-Line spare Reg */
361
362         /* x4 or x8 syndromes in use */
363         u8 ecc_sym_sz;
364
365         /* place to store error injection parameters prior to issue */
366         struct error_injection injection;
367
368         /* cache the dram_type */
369         enum mem_type dram_type;
370
371         struct amd64_umc *umc;  /* UMC registers */
372 };
373
374 enum err_codes {
375         DECODE_OK       =  0,
376         ERR_NODE        = -1,
377         ERR_CSROW       = -2,
378         ERR_CHANNEL     = -3,
379         ERR_SYND        = -4,
380         ERR_NORM_ADDR   = -5,
381 };
382
383 struct err_info {
384         int err_code;
385         struct mem_ctl_info *src_mci;
386         int csrow;
387         int channel;
388         u16 syndrome;
389         u32 page;
390         u32 offset;
391 };
392
393 static inline u32 get_umc_base(u8 channel)
394 {
395         /* ch0: 0x50000, ch1: 0x150000 */
396         return 0x50000 + (!!channel << 20);
397 }
398
399 static inline u64 get_dram_base(struct amd64_pvt *pvt, u8 i)
400 {
401         u64 addr = ((u64)pvt->ranges[i].base.lo & 0xffff0000) << 8;
402
403         if (boot_cpu_data.x86 == 0xf)
404                 return addr;
405
406         return (((u64)pvt->ranges[i].base.hi & 0x000000ff) << 40) | addr;
407 }
408
409 static inline u64 get_dram_limit(struct amd64_pvt *pvt, u8 i)
410 {
411         u64 lim = (((u64)pvt->ranges[i].lim.lo & 0xffff0000) << 8) | 0x00ffffff;
412
413         if (boot_cpu_data.x86 == 0xf)
414                 return lim;
415
416         return (((u64)pvt->ranges[i].lim.hi & 0x000000ff) << 40) | lim;
417 }
418
419 static inline u16 extract_syndrome(u64 status)
420 {
421         return ((status >> 47) & 0xff) | ((status >> 16) & 0xff00);
422 }
423
424 static inline u8 dct_sel_interleave_addr(struct amd64_pvt *pvt)
425 {
426         if (pvt->fam == 0x15 && pvt->model >= 0x30)
427                 return (((pvt->dct_sel_hi >> 9) & 0x1) << 2) |
428                         ((pvt->dct_sel_lo >> 6) & 0x3);
429
430         return  ((pvt)->dct_sel_lo >> 6) & 0x3;
431 }
432 /*
433  * per-node ECC settings descriptor
434  */
435 struct ecc_settings {
436         u32 old_nbctl;
437         bool nbctl_valid;
438
439         struct flags {
440                 unsigned long nb_mce_enable:1;
441                 unsigned long nb_ecc_prev:1;
442         } flags;
443 };
444
445 #ifdef CONFIG_EDAC_DEBUG
446 extern const struct attribute_group amd64_edac_dbg_group;
447 #endif
448
449 #ifdef CONFIG_EDAC_AMD64_ERROR_INJECTION
450 extern const struct attribute_group amd64_edac_inj_group;
451 #endif
452
453 /*
454  * Each of the PCI Device IDs types have their own set of hardware accessor
455  * functions and per device encoding/decoding logic.
456  */
457 struct low_ops {
458         int (*early_channel_count)      (struct amd64_pvt *pvt);
459         void (*map_sysaddr_to_csrow)    (struct mem_ctl_info *mci, u64 sys_addr,
460                                          struct err_info *);
461         int (*dbam_to_cs)               (struct amd64_pvt *pvt, u8 dct,
462                                          unsigned cs_mode, int cs_mask_nr);
463 };
464
465 struct amd64_family_type {
466         const char *ctl_name;
467         u16 f0_id, f1_id, f2_id, f6_id;
468         struct low_ops ops;
469 };
470
471 int __amd64_read_pci_cfg_dword(struct pci_dev *pdev, int offset,
472                                u32 *val, const char *func);
473 int __amd64_write_pci_cfg_dword(struct pci_dev *pdev, int offset,
474                                 u32 val, const char *func);
475
476 #define amd64_read_pci_cfg(pdev, offset, val)   \
477         __amd64_read_pci_cfg_dword(pdev, offset, val, __func__)
478
479 #define amd64_write_pci_cfg(pdev, offset, val)  \
480         __amd64_write_pci_cfg_dword(pdev, offset, val, __func__)
481
482 int amd64_get_dram_hole_info(struct mem_ctl_info *mci, u64 *hole_base,
483                              u64 *hole_offset, u64 *hole_size);
484
485 #define to_mci(k) container_of(k, struct mem_ctl_info, dev)
486
487 /* Injection helpers */
488 static inline void disable_caches(void *dummy)
489 {
490         write_cr0(read_cr0() | X86_CR0_CD);
491         wbinvd();
492 }
493
494 static inline void enable_caches(void *dummy)
495 {
496         write_cr0(read_cr0() & ~X86_CR0_CD);
497 }
498
499 static inline u8 dram_intlv_en(struct amd64_pvt *pvt, unsigned int i)
500 {
501         if (pvt->fam == 0x15 && pvt->model >= 0x30) {
502                 u32 tmp;
503                 amd64_read_pci_cfg(pvt->F1, DRAM_CONT_LIMIT, &tmp);
504                 return (u8) tmp & 0xF;
505         }
506         return (u8) (pvt->ranges[i].base.lo >> 8) & 0x7;
507 }
508
509 static inline u8 dhar_valid(struct amd64_pvt *pvt)
510 {
511         if (pvt->fam == 0x15 && pvt->model >= 0x30) {
512                 u32 tmp;
513                 amd64_read_pci_cfg(pvt->F1, DRAM_CONT_BASE, &tmp);
514                 return (tmp >> 1) & BIT(0);
515         }
516         return (pvt)->dhar & BIT(0);
517 }
518
519 static inline u32 dct_sel_baseaddr(struct amd64_pvt *pvt)
520 {
521         if (pvt->fam == 0x15 && pvt->model >= 0x30) {
522                 u32 tmp;
523                 amd64_read_pci_cfg(pvt->F1, DRAM_CONT_BASE, &tmp);
524                 return (tmp >> 11) & 0x1FFF;
525         }
526         return (pvt)->dct_sel_lo & 0xFFFFF800;
527 }