2 * AMD64 class Memory Controller kernel module
4 * Copyright (c) 2009 SoftwareBitMaker.
5 * Copyright (c) 2009 Advanced Micro Devices, Inc.
7 * This file may be distributed under the terms of the
8 * GNU General Public License.
10 * Originally Written by Thayne Harbaugh
12 * Changes by Douglas "norsk" Thompson <dougthompson@xmission.com>:
13 * - K8 CPU Revision D and greater support
15 * Changes by Dave Peterson <dsp@llnl.gov> <dave_peterson@pobox.com>:
16 * - Module largely rewritten, with new (and hopefully correct)
17 * code for dealing with node and chip select interleaving,
18 * various code cleanup, and bug fixes
19 * - Added support for memory hoisting using DRAM hole address
22 * Changes by Douglas "norsk" Thompson <dougthompson@xmission.com>:
23 * -K8 Rev (1207) revision support added, required Revision
24 * specific mini-driver code to support Rev F as well as
27 * Changes by Douglas "norsk" Thompson <dougthompson@xmission.com>:
28 * -Family 10h revision support added. New PCI Device IDs,
29 * indicating new changes. Actual registers modified
30 * were slight, less than the Rev E to Rev F transition
31 * but changing the PCI Device ID was the proper thing to
32 * do, as it provides for almost automactic family
33 * detection. The mods to Rev F required more family
34 * information detection.
36 * Changes/Fixes by Borislav Petkov <bp@alien8.de>:
37 * - misc fixes and code cleanups
39 * This module is based on the following documents
40 * (available from http://www.amd.com/):
42 * Title: BIOS and Kernel Developer's Guide for AMD Athlon 64 and AMD
44 * AMD publication #: 26094
47 * Title: BIOS and Kernel Developer's Guide for AMD NPT Family 0Fh
49 * AMD publication #: 32559
51 * Issue Date: May 2006
53 * Title: BIOS and Kernel Developer's Guide (BKDG) For AMD Family 10h
55 * AMD publication #: 31116
57 * Issue Date: September 07, 2007
59 * Sections in the first 2 documents are no longer in sync with each other.
60 * The Family 10h BKDG was totally re-written from scratch with a new
62 * Therefore, comments that refer to a Document section might be off.
65 #include <linux/module.h>
66 #include <linux/ctype.h>
67 #include <linux/init.h>
68 #include <linux/pci.h>
69 #include <linux/pci_ids.h>
70 #include <linux/slab.h>
71 #include <linux/mmzone.h>
72 #include <linux/edac.h>
74 #include "edac_core.h"
77 #define amd64_debug(fmt, arg...) \
78 edac_printk(KERN_DEBUG, "amd64", fmt, ##arg)
80 #define amd64_info(fmt, arg...) \
81 edac_printk(KERN_INFO, "amd64", fmt, ##arg)
83 #define amd64_notice(fmt, arg...) \
84 edac_printk(KERN_NOTICE, "amd64", fmt, ##arg)
86 #define amd64_warn(fmt, arg...) \
87 edac_printk(KERN_WARNING, "amd64", fmt, ##arg)
89 #define amd64_err(fmt, arg...) \
90 edac_printk(KERN_ERR, "amd64", fmt, ##arg)
92 #define amd64_mc_warn(mci, fmt, arg...) \
93 edac_mc_chipset_printk(mci, KERN_WARNING, "amd64", fmt, ##arg)
95 #define amd64_mc_err(mci, fmt, arg...) \
96 edac_mc_chipset_printk(mci, KERN_ERR, "amd64", fmt, ##arg)
99 * Throughout the comments in this code, the following terms are used:
101 * SysAddr, DramAddr, and InputAddr
103 * These terms come directly from the amd64 documentation
104 * (AMD publication #26094). They are defined as follows:
107 * This is a physical address generated by a CPU core or a device
108 * doing DMA. If generated by a CPU core, a SysAddr is the result of
109 * a virtual to physical address translation by the CPU core's address
110 * translation mechanism (MMU).
113 * A DramAddr is derived from a SysAddr by subtracting an offset that
114 * depends on which node the SysAddr maps to and whether the SysAddr
115 * is within a range affected by memory hoisting. The DRAM Base
116 * (section 3.4.4.1) and DRAM Limit (section 3.4.4.2) registers
117 * determine which node a SysAddr maps to.
119 * If the DRAM Hole Address Register (DHAR) is enabled and the SysAddr
120 * is within the range of addresses specified by this register, then
121 * a value x from the DHAR is subtracted from the SysAddr to produce a
122 * DramAddr. Here, x represents the base address for the node that
123 * the SysAddr maps to plus an offset due to memory hoisting. See
124 * section 3.4.8 and the comments in amd64_get_dram_hole_info() and
125 * sys_addr_to_dram_addr() below for more information.
127 * If the SysAddr is not affected by the DHAR then a value y is
128 * subtracted from the SysAddr to produce a DramAddr. Here, y is the
129 * base address for the node that the SysAddr maps to. See section
130 * 3.4.4 and the comments in sys_addr_to_dram_addr() below for more
134 * A DramAddr is translated to an InputAddr before being passed to the
135 * memory controller for the node that the DramAddr is associated
136 * with. The memory controller then maps the InputAddr to a csrow.
137 * If node interleaving is not in use, then the InputAddr has the same
138 * value as the DramAddr. Otherwise, the InputAddr is produced by
139 * discarding the bits used for node interleaving from the DramAddr.
140 * See section 3.4.4 for more information.
142 * The memory controller for a given node uses its DRAM CS Base and
143 * DRAM CS Mask registers to map an InputAddr to a csrow. See
144 * sections 3.5.4 and 3.5.5 for more information.
147 #define EDAC_AMD64_VERSION "3.4.0"
148 #define EDAC_MOD_STR "amd64_edac"
150 /* Extended Model from CPUID, for CPU Revision numbers */
155 /* Hardware limit on ChipSelect rows per MC and processors per system */
156 #define NUM_CHIPSELECTS 8
157 #define DRAM_RANGES 8
163 * Create a contiguous bitmask starting at bit position @lo and ending at
164 * position @hi. For example
166 * GENMASK(21, 39) gives us the 64bit vector 0x000000ffffe00000.
168 #define GENMASK(lo, hi) (((1ULL << ((hi) - (lo) + 1)) - 1) << (lo))
171 * PCI-defined configuration space registers
173 #define PCI_DEVICE_ID_AMD_15H_M30H_NB_F1 0x141b
174 #define PCI_DEVICE_ID_AMD_15H_M30H_NB_F2 0x141c
175 #define PCI_DEVICE_ID_AMD_15H_NB_F1 0x1601
176 #define PCI_DEVICE_ID_AMD_15H_NB_F2 0x1602
177 #define PCI_DEVICE_ID_AMD_16H_NB_F1 0x1531
178 #define PCI_DEVICE_ID_AMD_16H_NB_F2 0x1532
181 * Function 1 - Address Map
183 #define DRAM_BASE_LO 0x40
184 #define DRAM_LIMIT_LO 0x44
187 * F15 M30h D18F1x2[1C:00]
189 #define DRAM_CONT_BASE 0x200
190 #define DRAM_CONT_LIMIT 0x204
193 * F15 M30h D18F1x2[4C:40]
195 #define DRAM_CONT_HIGH_OFF 0x240
197 #define dram_rw(pvt, i) ((u8)(pvt->ranges[i].base.lo & 0x3))
198 #define dram_intlv_sel(pvt, i) ((u8)((pvt->ranges[i].lim.lo >> 8) & 0x7))
199 #define dram_dst_node(pvt, i) ((u8)(pvt->ranges[i].lim.lo & 0x7))
202 #define dhar_mem_hoist_valid(pvt) ((pvt)->dhar & BIT(1))
203 #define dhar_base(pvt) ((pvt)->dhar & 0xff000000)
204 #define k8_dhar_offset(pvt) (((pvt)->dhar & 0x0000ff00) << 16)
206 /* NOTE: Extra mask bit vs K8 */
207 #define f10_dhar_offset(pvt) (((pvt)->dhar & 0x0000ff80) << 16)
209 #define DCT_CFG_SEL 0x10C
211 #define DRAM_LOCAL_NODE_BASE 0x120
212 #define DRAM_LOCAL_NODE_LIM 0x124
214 #define DRAM_BASE_HI 0x140
215 #define DRAM_LIMIT_HI 0x144
219 * Function 2 - DRAM controller
223 #define DCSB_CS_ENABLE BIT(0)
228 #define csrow_enabled(i, dct, pvt) ((pvt)->csels[(dct)].csbases[(i)] & DCSB_CS_ENABLE)
233 /* Extract the DIMM 'type' on the i'th DIMM from the DBAM reg value passed */
234 #define DBAM_DIMM(i, reg) ((((reg) >> (4*(i)))) & 0xF)
236 #define DBAM_MAX_VALUE 11
240 #define REVE_WIDTH_128 BIT(16)
241 #define WIDTH_128 BIT(11)
245 #define DDR3_MODE BIT(8)
247 #define DCT_SEL_LO 0x110
248 #define dct_high_range_enabled(pvt) ((pvt)->dct_sel_lo & BIT(0))
249 #define dct_interleave_enabled(pvt) ((pvt)->dct_sel_lo & BIT(2))
251 #define dct_ganging_enabled(pvt) ((boot_cpu_data.x86 == 0x10) && ((pvt)->dct_sel_lo & BIT(4)))
253 #define dct_data_intlv_enabled(pvt) ((pvt)->dct_sel_lo & BIT(5))
254 #define dct_memory_cleared(pvt) ((pvt)->dct_sel_lo & BIT(10))
256 #define SWAP_INTLV_REG 0x10c
258 #define DCT_SEL_HI 0x114
261 * Function 3 - Misc Control
266 #define NBCFG_CHIPKILL BIT(23)
267 #define NBCFG_ECC_ENABLE BIT(22)
270 #define F10_NBSL_EXT_ERR_ECC 0x8
271 #define NBSL_PP_OBS 0x2
275 #define F10_ONLINE_SPARE 0xB0
276 #define online_spare_swap_done(pvt, c) (((pvt)->online_spare >> (1 + 2 * (c))) & 0x1)
277 #define online_spare_bad_dramcs(pvt, c) (((pvt)->online_spare >> (4 + 4 * (c))) & 0x7)
279 #define F10_NB_ARRAY_ADDR 0xB8
280 #define F10_NB_ARRAY_DRAM BIT(31)
282 /* Bits [2:1] are used to select 16-byte section within a 64-byte cacheline */
283 #define SET_NB_ARRAY_ADDR(section) (((section) & 0x3) << 1)
285 #define F10_NB_ARRAY_DATA 0xBC
286 #define F10_NB_ARR_ECC_WR_REQ BIT(17)
287 #define SET_NB_DRAM_INJECTION_WRITE(inj) \
288 (BIT(((inj.word) & 0xF) + 20) | \
289 F10_NB_ARR_ECC_WR_REQ | inj.bit_map)
290 #define SET_NB_DRAM_INJECTION_READ(inj) \
291 (BIT(((inj.word) & 0xF) + 20) | \
292 BIT(16) | inj.bit_map)
296 #define NBCAP_CHIPKILL BIT(4)
297 #define NBCAP_SECDED BIT(3)
298 #define NBCAP_DCT_DUAL BIT(0)
300 #define EXT_NB_MCA_CFG 0x180
303 #define MSR_MCGCTL_NBE BIT(4)
314 /* Error injection control structure */
315 struct error_injection
{
321 /* low and high part of PCI config space regs */
327 * See F1x[1, 0][7C:40] DRAM Base/Limit Registers
330 struct reg_pair base
;
334 /* A DCT chip selects collection */
336 u32 csbases
[NUM_CHIPSELECTS
];
339 u32 csmasks
[NUM_CHIPSELECTS
];
346 /* pci_device handles which we utilize */
347 struct pci_dev
*F1
, *F2
, *F3
;
349 u16 mc_node_id
; /* MC index of this MC node */
350 u8 fam
; /* CPU family */
351 u8 model
; /* ... model */
352 u8 stepping
; /* ... stepping */
354 int ext_model
; /* extended model value of this node */
358 u32 dclr0
; /* DRAM Configuration Low DCT0 reg */
359 u32 dclr1
; /* DRAM Configuration Low DCT1 reg */
360 u32 dchr0
; /* DRAM Configuration High DCT0 reg */
361 u32 dchr1
; /* DRAM Configuration High DCT1 reg */
362 u32 nbcap
; /* North Bridge Capabilities */
363 u32 nbcfg
; /* F10 North Bridge Configuration */
364 u32 ext_nbcfg
; /* Extended F10 North Bridge Configuration */
365 u32 dhar
; /* DRAM Hoist reg */
366 u32 dbam0
; /* DRAM Base Address Mapping reg for DCT0 */
367 u32 dbam1
; /* DRAM Base Address Mapping reg for DCT1 */
369 /* one for each DCT */
370 struct chip_select csels
[2];
372 /* DRAM base and limit pairs F1x[78,70,68,60,58,50,48,40] */
373 struct dram_range ranges
[DRAM_RANGES
];
375 u64 top_mem
; /* top of memory below 4GB */
376 u64 top_mem2
; /* top of memory above 4GB */
378 u32 dct_sel_lo
; /* DRAM Controller Select Low */
379 u32 dct_sel_hi
; /* DRAM Controller Select High */
380 u32 online_spare
; /* On-Line spare Reg */
382 /* x4 or x8 syndromes in use */
385 /* place to store error injection parameters prior to issue */
386 struct error_injection injection
;
398 struct mem_ctl_info
*src_mci
;
406 static inline u64
get_dram_base(struct amd64_pvt
*pvt
, u8 i
)
408 u64 addr
= ((u64
)pvt
->ranges
[i
].base
.lo
& 0xffff0000) << 8;
410 if (boot_cpu_data
.x86
== 0xf)
413 return (((u64
)pvt
->ranges
[i
].base
.hi
& 0x000000ff) << 40) | addr
;
416 static inline u64
get_dram_limit(struct amd64_pvt
*pvt
, u8 i
)
418 u64 lim
= (((u64
)pvt
->ranges
[i
].lim
.lo
& 0xffff0000) << 8) | 0x00ffffff;
420 if (boot_cpu_data
.x86
== 0xf)
423 return (((u64
)pvt
->ranges
[i
].lim
.hi
& 0x000000ff) << 40) | lim
;
426 static inline u16
extract_syndrome(u64 status
)
428 return ((status
>> 47) & 0xff) | ((status
>> 16) & 0xff00);
431 static inline u8
dct_sel_interleave_addr(struct amd64_pvt
*pvt
)
433 if (pvt
->fam
== 0x15 && pvt
->model
>= 0x30)
434 return (((pvt
->dct_sel_hi
>> 9) & 0x1) << 2) |
435 ((pvt
->dct_sel_lo
>> 6) & 0x3);
437 return ((pvt
)->dct_sel_lo
>> 6) & 0x3;
440 * per-node ECC settings descriptor
442 struct ecc_settings
{
447 unsigned long nb_mce_enable
:1;
448 unsigned long nb_ecc_prev
:1;
452 #ifdef CONFIG_EDAC_DEBUG
453 int amd64_create_sysfs_dbg_files(struct mem_ctl_info
*mci
);
454 void amd64_remove_sysfs_dbg_files(struct mem_ctl_info
*mci
);
457 static inline int amd64_create_sysfs_dbg_files(struct mem_ctl_info
*mci
)
461 static void inline amd64_remove_sysfs_dbg_files(struct mem_ctl_info
*mci
)
466 #ifdef CONFIG_EDAC_AMD64_ERROR_INJECTION
467 int amd64_create_sysfs_inject_files(struct mem_ctl_info
*mci
);
468 void amd64_remove_sysfs_inject_files(struct mem_ctl_info
*mci
);
471 static inline int amd64_create_sysfs_inject_files(struct mem_ctl_info
*mci
)
475 static inline void amd64_remove_sysfs_inject_files(struct mem_ctl_info
*mci
)
481 * Each of the PCI Device IDs types have their own set of hardware accessor
482 * functions and per device encoding/decoding logic.
485 int (*early_channel_count
) (struct amd64_pvt
*pvt
);
486 void (*map_sysaddr_to_csrow
) (struct mem_ctl_info
*mci
, u64 sys_addr
,
488 int (*dbam_to_cs
) (struct amd64_pvt
*pvt
, u8 dct
, unsigned cs_mode
);
489 int (*read_dct_pci_cfg
) (struct amd64_pvt
*pvt
, int offset
,
490 u32
*val
, const char *func
);
493 struct amd64_family_type
{
494 const char *ctl_name
;
499 int __amd64_read_pci_cfg_dword(struct pci_dev
*pdev
, int offset
,
500 u32
*val
, const char *func
);
501 int __amd64_write_pci_cfg_dword(struct pci_dev
*pdev
, int offset
,
502 u32 val
, const char *func
);
504 #define amd64_read_pci_cfg(pdev, offset, val) \
505 __amd64_read_pci_cfg_dword(pdev, offset, val, __func__)
507 #define amd64_write_pci_cfg(pdev, offset, val) \
508 __amd64_write_pci_cfg_dword(pdev, offset, val, __func__)
510 #define amd64_read_dct_pci_cfg(pvt, offset, val) \
511 pvt->ops->read_dct_pci_cfg(pvt, offset, val, __func__)
513 int amd64_get_dram_hole_info(struct mem_ctl_info
*mci
, u64
*hole_base
,
514 u64
*hole_offset
, u64
*hole_size
);
516 #define to_mci(k) container_of(k, struct mem_ctl_info, dev)
518 /* Injection helpers */
519 static inline void disable_caches(void *dummy
)
521 write_cr0(read_cr0() | X86_CR0_CD
);
525 static inline void enable_caches(void *dummy
)
527 write_cr0(read_cr0() & ~X86_CR0_CD
);
530 static inline u8
dram_intlv_en(struct amd64_pvt
*pvt
, unsigned int i
)
532 if (pvt
->fam
== 0x15 && pvt
->model
>= 0x30) {
534 amd64_read_pci_cfg(pvt
->F1
, DRAM_CONT_LIMIT
, &tmp
);
535 return (u8
) tmp
& 0xF;
537 return (u8
) (pvt
->ranges
[i
].base
.lo
>> 8) & 0x7;
540 static inline u8
dhar_valid(struct amd64_pvt
*pvt
)
542 if (pvt
->fam
== 0x15 && pvt
->model
>= 0x30) {
544 amd64_read_pci_cfg(pvt
->F1
, DRAM_CONT_BASE
, &tmp
);
545 return (tmp
>> 1) & BIT(0);
547 return (pvt
)->dhar
& BIT(0);
550 static inline u32
dct_sel_baseaddr(struct amd64_pvt
*pvt
)
552 if (pvt
->fam
== 0x15 && pvt
->model
>= 0x30) {
554 amd64_read_pci_cfg(pvt
->F1
, DRAM_CONT_BASE
, &tmp
);
555 return (tmp
>> 11) & 0x1FFF;
557 return (pvt
)->dct_sel_lo
& 0xFFFFF800;