[deliverable/linux.git] / drivers / edac / amd64_edac.h

/*
 * AMD64 class Memory Controller kernel module
 *
 * Copyright (c) 2009 SoftwareBitMaker.
 * Copyright (c) 2009 Advanced Micro Devices, Inc.
 *
 * This file may be distributed under the terms of the
 * GNU General Public License.
 *
 *	Originally Written by Thayne Harbaugh
 *
 *      Changes by Douglas "norsk" Thompson  <dougthompson@xmission.com>:
 *		- K8 CPU Revision D and greater support
 *
 *      Changes by Dave Peterson <dsp@llnl.gov> <dave_peterson@pobox.com>:
 *		- Module largely rewritten, with new (and hopefully correct)
 *		code for dealing with node and chip select interleaving,
 *		various code cleanup, and bug fixes
 *		- Added support for memory hoisting using DRAM hole address
 *		register
 *
 *	Changes by Douglas "norsk" Thompson <dougthompson@xmission.com>:
 *		-K8 Rev (1207) revision support added, required Revision
 *		specific mini-driver code to support Rev F as well as
 *		prior revisions
 *
 *	Changes by Douglas "norsk" Thompson <dougthompson@xmission.com>:
 *		-Family 10h revision support added. New PCI Device IDs,
 *		indicating new changes. Actual registers modified
 *		were slight, less than the Rev E to Rev F transition
 *		but changing the PCI Device ID was the proper thing to
 *		do, as it provides for almost automactic family
 *		detection. The mods to Rev F required more family
 *		information detection.
 *
 *	Changes/Fixes by Borislav Petkov <bp@alien8.de>:
 *		- misc fixes and code cleanups
 *
 * This module is based on the following documents
 * (available from http://www.amd.com/):
 *
 *	Title:	BIOS and Kernel Developer's Guide for AMD Athlon 64 and AMD
 *		Opteron Processors
 *	AMD publication #: 26094
 *`	Revision: 3.26
 *
 *	Title:	BIOS and Kernel Developer's Guide for AMD NPT Family 0Fh
 *		Processors
 *	AMD publication #: 32559
 *	Revision: 3.00
 *	Issue Date: May 2006
 *
 *	Title:	BIOS and Kernel Developer's Guide (BKDG) For AMD Family 10h
 *		Processors
 *	AMD publication #: 31116
 *	Revision: 3.00
 *	Issue Date: September 07, 2007
 *
 * Sections in the first 2 documents are no longer in sync with each other.
 * The Family 10h BKDG was totally re-written from scratch with a new
 * presentation model.
 * Therefore, comments that refer to a Document section might be off.
 */

#include <linux/module.h>
#include <linux/ctype.h>
#include <linux/init.h>
#include <linux/pci.h>
#include <linux/pci_ids.h>
#include <linux/slab.h>
#include <linux/mmzone.h>
#include <linux/edac.h>
#include <asm/msr.h>
#include "edac_core.h"
#include "mce_amd.h"

#define amd64_debug(fmt, arg...) \
	edac_printk(KERN_DEBUG, "amd64", fmt, ##arg)

#define amd64_info(fmt, arg...) \
	edac_printk(KERN_INFO, "amd64", fmt, ##arg)

#define amd64_notice(fmt, arg...) \
	edac_printk(KERN_NOTICE, "amd64", fmt, ##arg)

#define amd64_warn(fmt, arg...) \
	edac_printk(KERN_WARNING, "amd64", fmt, ##arg)

#define amd64_err(fmt, arg...) \
	edac_printk(KERN_ERR, "amd64", fmt, ##arg)

#define amd64_mc_warn(mci, fmt, arg...) \
	edac_mc_chipset_printk(mci, KERN_WARNING, "amd64", fmt, ##arg)

#define amd64_mc_err(mci, fmt, arg...) \
	edac_mc_chipset_printk(mci, KERN_ERR, "amd64", fmt, ##arg)

/*
 * Throughout the comments in this code, the following terms are used:
 *
 *	SysAddr, DramAddr, and InputAddr
 *
 *  These terms come directly from the amd64 documentation
 * (AMD publication #26094).  They are defined as follows:
 *
 *     SysAddr:
 *         This is a physical address generated by a CPU core or a device
 *         doing DMA.  If generated by a CPU core, a SysAddr is the result of
 *         a virtual to physical address translation by the CPU core's address
 *         translation mechanism (MMU).
 *
 *     DramAddr:
 *         A DramAddr is derived from a SysAddr by subtracting an offset that
 *         depends on which node the SysAddr maps to and whether the SysAddr
 *         is within a range affected by memory hoisting.  The DRAM Base
 *         (section 3.4.4.1) and DRAM Limit (section 3.4.4.2) registers
 *         determine which node a SysAddr maps to.
 *
 *         If the DRAM Hole Address Register (DHAR) is enabled and the SysAddr
 *         is within the range of addresses specified by this register, then
 *         a value x from the DHAR is subtracted from the SysAddr to produce a
 *         DramAddr.  Here, x represents the base address for the node that
 *         the SysAddr maps to plus an offset due to memory hoisting.  See
 *         section 3.4.8 and the comments in amd64_get_dram_hole_info() and
 *         sys_addr_to_dram_addr() below for more information.
 *
 *         If the SysAddr is not affected by the DHAR then a value y is
 *         subtracted from the SysAddr to produce a DramAddr.  Here, y is the
 *         base address for the node that the SysAddr maps to.  See section
 *         3.4.4 and the comments in sys_addr_to_dram_addr() below for more
 *         information.
 *
 *     InputAddr:
 *         A DramAddr is translated to an InputAddr before being passed to the
 *         memory controller for the node that the DramAddr is associated
 *         with.  The memory controller then maps the InputAddr to a csrow.
 *         If node interleaving is not in use, then the InputAddr has the same
 *         value as the DramAddr.  Otherwise, the InputAddr is produced by
 *         discarding the bits used for node interleaving from the DramAddr.
 *         See section 3.4.4 for more information.
 *
 *         The memory controller for a given node uses its DRAM CS Base and
 *         DRAM CS Mask registers to map an InputAddr to a csrow.  See
 *         sections 3.5.4 and 3.5.5 for more information.
 */

#define EDAC_AMD64_VERSION		"3.4.0"
#define EDAC_MOD_STR			"amd64_edac"

/* Extended Model from CPUID, for CPU Revision numbers */
#define K8_REV_D			1
#define K8_REV_E			2
#define K8_REV_F			4

/* Hardware limit on ChipSelect rows per MC and processors per system */
#define NUM_CHIPSELECTS			8
#define DRAM_RANGES			8

#define ON true
#define OFF false

/*
 * Create a contiguous bitmask starting at bit position @lo and ending at
 * position @hi. For example
 *
 * GENMASK(21, 39) gives us the 64bit vector 0x000000ffffe00000.
 */
#define GENMASK(lo, hi)			(((1ULL << ((hi) - (lo) + 1)) - 1) << (lo))

/*
 * PCI-defined configuration space registers
 */
#define PCI_DEVICE_ID_AMD_15H_M30H_NB_F1 0x141b
#define PCI_DEVICE_ID_AMD_15H_M30H_NB_F2 0x141c
#define PCI_DEVICE_ID_AMD_15H_NB_F1	0x1601
#define PCI_DEVICE_ID_AMD_15H_NB_F2	0x1602
#define PCI_DEVICE_ID_AMD_16H_NB_F1	0x1531
#define PCI_DEVICE_ID_AMD_16H_NB_F2	0x1532

/*
 * Function 1 - Address Map
 */
#define DRAM_BASE_LO			0x40
#define DRAM_LIMIT_LO			0x44

/*
 * F15 M30h D18F1x2[1C:00]
 */
#define DRAM_CONT_BASE			0x200
#define DRAM_CONT_LIMIT			0x204

/*
 * F15 M30h D18F1x2[4C:40]
 */
#define DRAM_CONT_HIGH_OFF		0x240

#define dram_rw(pvt, i)			((u8)(pvt->ranges[i].base.lo & 0x3))
#define dram_intlv_sel(pvt, i)		((u8)((pvt->ranges[i].lim.lo >> 8) & 0x7))
#define dram_dst_node(pvt, i)		((u8)(pvt->ranges[i].lim.lo & 0x7))

#define DHAR				0xf0
#define dhar_mem_hoist_valid(pvt)	((pvt)->dhar & BIT(1))
#define dhar_base(pvt)			((pvt)->dhar & 0xff000000)
#define k8_dhar_offset(pvt)		(((pvt)->dhar & 0x0000ff00) << 16)

					/* NOTE: Extra mask bit vs K8 */
#define f10_dhar_offset(pvt)		(((pvt)->dhar & 0x0000ff80) << 16)

#define DCT_CFG_SEL			0x10C

#define DRAM_LOCAL_NODE_BASE		0x120
#define DRAM_LOCAL_NODE_LIM		0x124

#define DRAM_BASE_HI			0x140
#define DRAM_LIMIT_HI			0x144


/*
 * Function 2 - DRAM controller
 */
#define DCSB0				0x40
#define DCSB1				0x140
#define DCSB_CS_ENABLE			BIT(0)

#define DCSM0				0x60
#define DCSM1				0x160

#define csrow_enabled(i, dct, pvt)	((pvt)->csels[(dct)].csbases[(i)] & DCSB_CS_ENABLE)

#define DBAM0				0x80
#define DBAM1				0x180

/* Extract the DIMM 'type' on the i'th DIMM from the DBAM reg value passed */
#define DBAM_DIMM(i, reg)		((((reg) >> (4*(i)))) & 0xF)

#define DBAM_MAX_VALUE			11

#define DCLR0				0x90
#define DCLR1				0x190
#define REVE_WIDTH_128			BIT(16)
#define WIDTH_128			BIT(11)

#define DCHR0				0x94
#define DCHR1				0x194
#define DDR3_MODE			BIT(8)

#define DCT_SEL_LO			0x110
#define dct_high_range_enabled(pvt)	((pvt)->dct_sel_lo & BIT(0))
#define dct_interleave_enabled(pvt)	((pvt)->dct_sel_lo & BIT(2))

#define dct_ganging_enabled(pvt)	((boot_cpu_data.x86 == 0x10) && ((pvt)->dct_sel_lo & BIT(4)))

#define dct_data_intlv_enabled(pvt)	((pvt)->dct_sel_lo & BIT(5))
#define dct_memory_cleared(pvt)		((pvt)->dct_sel_lo & BIT(10))

#define SWAP_INTLV_REG			0x10c

#define DCT_SEL_HI			0x114

/*
 * Function 3 - Misc Control
 */
#define NBCTL				0x40

#define NBCFG				0x44
#define NBCFG_CHIPKILL			BIT(23)
#define NBCFG_ECC_ENABLE		BIT(22)

/* F3x48: NBSL */
#define F10_NBSL_EXT_ERR_ECC		0x8
#define NBSL_PP_OBS			0x2

#define SCRCTRL				0x58

#define F10_ONLINE_SPARE		0xB0
#define online_spare_swap_done(pvt, c)	(((pvt)->online_spare >> (1 + 2 * (c))) & 0x1)
#define online_spare_bad_dramcs(pvt, c)	(((pvt)->online_spare >> (4 + 4 * (c))) & 0x7)

#define F10_NB_ARRAY_ADDR		0xB8
#define F10_NB_ARRAY_DRAM		BIT(31)

/* Bits [2:1] are used to select 16-byte section within a 64-byte cacheline  */
#define SET_NB_ARRAY_ADDR(section)	(((section) & 0x3) << 1)

#define F10_NB_ARRAY_DATA		0xBC
#define F10_NB_ARR_ECC_WR_REQ		BIT(17)
#define SET_NB_DRAM_INJECTION_WRITE(inj)  \
					(BIT(((inj.word) & 0xF) + 20) | \
					F10_NB_ARR_ECC_WR_REQ | inj.bit_map)
#define SET_NB_DRAM_INJECTION_READ(inj)  \
					(BIT(((inj.word) & 0xF) + 20) | \
					BIT(16) |  inj.bit_map)


#define NBCAP				0xE8
#define NBCAP_CHIPKILL			BIT(4)
#define NBCAP_SECDED			BIT(3)
#define NBCAP_DCT_DUAL			BIT(0)

#define EXT_NB_MCA_CFG			0x180

/* MSRs */
#define MSR_MCGCTL_NBE			BIT(4)

enum amd_families {
	K8_CPUS = 0,
	F10_CPUS,
	F15_CPUS,
	F15_M30H_CPUS,
	F16_CPUS,
	NUM_FAMILIES,
};

/* Error injection control structure */
struct error_injection {
	u32	 section;
	u32	 word;
	u32	 bit_map;
};

/* low and high part of PCI config space regs */
struct reg_pair {
	u32 lo, hi;
};

/*
 * See F1x[1, 0][7C:40] DRAM Base/Limit Registers
 */
struct dram_range {
	struct reg_pair base;
	struct reg_pair lim;
};

/* A DCT chip selects collection */
struct chip_select {
	u32 csbases[NUM_CHIPSELECTS];
	u8 b_cnt;

	u32 csmasks[NUM_CHIPSELECTS];
	u8 m_cnt;
};

struct amd64_pvt {
	struct low_ops *ops;

	/* pci_device handles which we utilize */
	struct pci_dev *F1, *F2, *F3;

	u16 mc_node_id;		/* MC index of this MC node */
	u8 fam;			/* CPU family */
	u8 model;		/* ... model */
	u8 stepping;		/* ... stepping */

	int ext_model;		/* extended model value of this node */
	int channel_count;

	/* Raw registers */
	u32 dclr0;		/* DRAM Configuration Low DCT0 reg */
	u32 dclr1;		/* DRAM Configuration Low DCT1 reg */
	u32 dchr0;		/* DRAM Configuration High DCT0 reg */
	u32 dchr1;		/* DRAM Configuration High DCT1 reg */
	u32 nbcap;		/* North Bridge Capabilities */
	u32 nbcfg;		/* F10 North Bridge Configuration */
	u32 ext_nbcfg;		/* Extended F10 North Bridge Configuration */
	u32 dhar;		/* DRAM Hoist reg */
	u32 dbam0;		/* DRAM Base Address Mapping reg for DCT0 */
	u32 dbam1;		/* DRAM Base Address Mapping reg for DCT1 */

	/* one for each DCT */
	struct chip_select csels[2];

	/* DRAM base and limit pairs F1x[78,70,68,60,58,50,48,40] */
	struct dram_range ranges[DRAM_RANGES];

	u64 top_mem;		/* top of memory below 4GB */
	u64 top_mem2;		/* top of memory above 4GB */

	u32 dct_sel_lo;		/* DRAM Controller Select Low */
	u32 dct_sel_hi;		/* DRAM Controller Select High */
	u32 online_spare;	/* On-Line spare Reg */

	/* x4 or x8 syndromes in use */
	u8 ecc_sym_sz;

	/* place to store error injection parameters prior to issue */
	struct error_injection injection;
};

enum err_codes {
	DECODE_OK	=  0,
	ERR_NODE	= -1,
	ERR_CSROW	= -2,
	ERR_CHANNEL	= -3,
};

struct err_info {
	int err_code;
	struct mem_ctl_info *src_mci;
	int csrow;
	int channel;
	u16 syndrome;
	u32 page;
	u32 offset;
};

static inline u64 get_dram_base(struct amd64_pvt *pvt, u8 i)
{
	u64 addr = ((u64)pvt->ranges[i].base.lo & 0xffff0000) << 8;

	if (boot_cpu_data.x86 == 0xf)
		return addr;

	return (((u64)pvt->ranges[i].base.hi & 0x000000ff) << 40) | addr;
}

static inline u64 get_dram_limit(struct amd64_pvt *pvt, u8 i)
{
	u64 lim = (((u64)pvt->ranges[i].lim.lo & 0xffff0000) << 8) | 0x00ffffff;

	if (boot_cpu_data.x86 == 0xf)
		return lim;

	return (((u64)pvt->ranges[i].lim.hi & 0x000000ff) << 40) | lim;
}

static inline u16 extract_syndrome(u64 status)
{
	return ((status >> 47) & 0xff) | ((status >> 16) & 0xff00);
}

static inline u8 dct_sel_interleave_addr(struct amd64_pvt *pvt)
{
	if (pvt->fam == 0x15 && pvt->model >= 0x30)
		return (((pvt->dct_sel_hi >> 9) & 0x1) << 2) |
			((pvt->dct_sel_lo >> 6) & 0x3);

	return	((pvt)->dct_sel_lo >> 6) & 0x3;
}
/*
 * per-node ECC settings descriptor
 */
struct ecc_settings {
	u32 old_nbctl;
	bool nbctl_valid;

	struct flags {
		unsigned long nb_mce_enable:1;
		unsigned long nb_ecc_prev:1;
	} flags;
};

#ifdef CONFIG_EDAC_DEBUG
int amd64_create_sysfs_dbg_files(struct mem_ctl_info *mci);
void amd64_remove_sysfs_dbg_files(struct mem_ctl_info *mci);

#else
static inline int amd64_create_sysfs_dbg_files(struct mem_ctl_info *mci)
{
	return 0;
}
static void inline amd64_remove_sysfs_dbg_files(struct mem_ctl_info *mci)
{
}
#endif

#ifdef CONFIG_EDAC_AMD64_ERROR_INJECTION
int amd64_create_sysfs_inject_files(struct mem_ctl_info *mci);
void amd64_remove_sysfs_inject_files(struct mem_ctl_info *mci);

#else
static inline int amd64_create_sysfs_inject_files(struct mem_ctl_info *mci)
{
	return 0;
}
static inline void amd64_remove_sysfs_inject_files(struct mem_ctl_info *mci)
{
}
#endif

/*
 * Each of the PCI Device IDs types have their own set of hardware accessor
 * functions and per device encoding/decoding logic.
 */
struct low_ops {
	int (*early_channel_count)	(struct amd64_pvt *pvt);
	void (*map_sysaddr_to_csrow)	(struct mem_ctl_info *mci, u64 sys_addr,
					 struct err_info *);
	int (*dbam_to_cs)		(struct amd64_pvt *pvt, u8 dct, unsigned cs_mode);
	int (*read_dct_pci_cfg)		(struct amd64_pvt *pvt, int offset,
					 u32 *val, const char *func);
};

struct amd64_family_type {
	const char *ctl_name;
	u16 f1_id, f3_id;
	struct low_ops ops;
};

int __amd64_read_pci_cfg_dword(struct pci_dev *pdev, int offset,
			       u32 *val, const char *func);
int __amd64_write_pci_cfg_dword(struct pci_dev *pdev, int offset,
				u32 val, const char *func);

#define amd64_read_pci_cfg(pdev, offset, val)	\
	__amd64_read_pci_cfg_dword(pdev, offset, val, __func__)

#define amd64_write_pci_cfg(pdev, offset, val)	\
	__amd64_write_pci_cfg_dword(pdev, offset, val, __func__)

#define amd64_read_dct_pci_cfg(pvt, offset, val) \
	pvt->ops->read_dct_pci_cfg(pvt, offset, val, __func__)

int amd64_get_dram_hole_info(struct mem_ctl_info *mci, u64 *hole_base,
			     u64 *hole_offset, u64 *hole_size);

#define to_mci(k) container_of(k, struct mem_ctl_info, dev)

/* Injection helpers */
static inline void disable_caches(void *dummy)
{
	write_cr0(read_cr0() | X86_CR0_CD);
	wbinvd();
}

static inline void enable_caches(void *dummy)
{
	write_cr0(read_cr0() & ~X86_CR0_CD);
}

static inline u8 dram_intlv_en(struct amd64_pvt *pvt, unsigned int i)
{
	if (pvt->fam == 0x15 && pvt->model >= 0x30) {
		u32 tmp;
		amd64_read_pci_cfg(pvt->F1, DRAM_CONT_LIMIT, &tmp);
		return (u8) tmp & 0xF;
	}
	return (u8) (pvt->ranges[i].base.lo >> 8) & 0x7;
}

static inline u8 dhar_valid(struct amd64_pvt *pvt)
{
	if (pvt->fam == 0x15 && pvt->model >= 0x30) {
		u32 tmp;
		amd64_read_pci_cfg(pvt->F1, DRAM_CONT_BASE, &tmp);
		return (tmp >> 1) & BIT(0);
	}
	return (pvt)->dhar & BIT(0);
}

static inline u32 dct_sel_baseaddr(struct amd64_pvt *pvt)
{
	if (pvt->fam == 0x15 && pvt->model >= 0x30) {
		u32 tmp;
		amd64_read_pci_cfg(pvt->F1, DRAM_CONT_BASE, &tmp);
		return (tmp >> 11) & 0x1FFF;
	}
	return (pvt)->dct_sel_lo & 0xFFFFF800;
}
Commit	Line	Data
cfe40fdb DT	1	/*
	2	* AMD64 class Memory Controller kernel module
	3	*
	4	* Copyright (c) 2009 SoftwareBitMaker.
	5	* Copyright (c) 2009 Advanced Micro Devices, Inc.
	6	*
	7	* This file may be distributed under the terms of the
	8	* GNU General Public License.
	9	*
	10	* Originally Written by Thayne Harbaugh
	11	*
	12	* Changes by Douglas "norsk" Thompson <dougthompson@xmission.com>:
	13	* - K8 CPU Revision D and greater support
	14	*
	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
	20	* register
	21	*
	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
	25	* prior revisions
	26	*
	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.
	35	*
43aff26c	36	* Changes/Fixes by Borislav Petkov <bp@alien8.de>:
cfe40fdb DT	37	* - misc fixes and code cleanups
	38	*
	39	* This module is based on the following documents
	40	* (available from http://www.amd.com/):
	41	*
	42	* Title: BIOS and Kernel Developer's Guide for AMD Athlon 64 and AMD
	43	* Opteron Processors
	44	* AMD publication #: 26094
	45	*` Revision: 3.26
	46	*
	47	* Title: BIOS and Kernel Developer's Guide for AMD NPT Family 0Fh
	48	* Processors
	49	* AMD publication #: 32559
	50	* Revision: 3.00
	51	* Issue Date: May 2006
	52	*
	53	* Title: BIOS and Kernel Developer's Guide (BKDG) For AMD Family 10h
	54	* Processors
	55	* AMD publication #: 31116
	56	* Revision: 3.00
	57	* Issue Date: September 07, 2007
	58	*
	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
	61	* presentation model.
	62	* Therefore, comments that refer to a Document section might be off.
	63	*/
	64
	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>
f9431992	73	#include <asm/msr.h>
cfe40fdb	74	#include "edac_core.h"
47ca08a4	75	#include "mce_amd.h"
cfe40fdb	76
24f9a7fe BP	77	#define amd64_debug(fmt, arg...) \
24f9a7fe BP	78	edac_printk(KERN_DEBUG, "amd64", fmt, ##arg)
cfe40fdb	79
24f9a7fe BP	80	#define amd64_info(fmt, arg...) \
	81	edac_printk(KERN_INFO, "amd64", fmt, ##arg)
	82
	83	#define amd64_notice(fmt, arg...) \
	84	edac_printk(KERN_NOTICE, "amd64", fmt, ##arg)
	85
	86	#define amd64_warn(fmt, arg...) \
	87	edac_printk(KERN_WARNING, "amd64", fmt, ##arg)
	88
	89	#define amd64_err(fmt, arg...) \
	90	edac_printk(KERN_ERR, "amd64", fmt, ##arg)
	91
	92	#define amd64_mc_warn(mci, fmt, arg...) \
	93	edac_mc_chipset_printk(mci, KERN_WARNING, "amd64", fmt, ##arg)
	94
	95	#define amd64_mc_err(mci, fmt, arg...) \
	96	edac_mc_chipset_printk(mci, KERN_ERR, "amd64", fmt, ##arg)
cfe40fdb DT	97
	98	/*
	99	* Throughout the comments in this code, the following terms are used:
	100	*
	101	* SysAddr, DramAddr, and InputAddr
	102	*
	103	* These terms come directly from the amd64 documentation
	104	* (AMD publication #26094). They are defined as follows:
	105	*
	106	* SysAddr:
	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).
	111	*
	112	* DramAddr:
	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.
	118	*
	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.
	126	*
	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
	131	* information.
	132	*
	133	* InputAddr:
	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.
	141	*
	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.
	145	*/
	146
df71a053	147	#define EDAC_AMD64_VERSION "3.4.0"
cfe40fdb DT	148	#define EDAC_MOD_STR "amd64_edac"
	149
	150	/* Extended Model from CPUID, for CPU Revision numbers */
1433eb99 BP	151	#define K8_REV_D 1
	152	#define K8_REV_E 2
	153	#define K8_REV_F 4
cfe40fdb DT	154
cfe40fdb DT	155	/* Hardware limit on ChipSelect rows per MC and processors per system */
7f19bf75 BP	156	#define NUM_CHIPSELECTS 8
7f19bf75 BP	157	#define DRAM_RANGES 8
cfe40fdb	158
f6d6ae96 BP	159	#define ON true
f6d6ae96 BP	160	#define OFF false
cfe40fdb	161
11c75ead BP	162	/*
	163	* Create a contiguous bitmask starting at bit position @lo and ending at
	164	* position @hi. For example
	165	*
	166	* GENMASK(21, 39) gives us the 64bit vector 0x000000ffffe00000.
	167	*/
	168	#define GENMASK(lo, hi) (((1ULL << ((hi) - (lo) + 1)) - 1) << (lo))
	169
cfe40fdb DT	170	/*
	171	* PCI-defined configuration space registers
	172	*/
18b94f66 AG	173	#define PCI_DEVICE_ID_AMD_15H_M30H_NB_F1 0x141b
18b94f66 AG	174	#define PCI_DEVICE_ID_AMD_15H_M30H_NB_F2 0x141c
df71a053 BP	175	#define PCI_DEVICE_ID_AMD_15H_NB_F1 0x1601
df71a053 BP	176	#define PCI_DEVICE_ID_AMD_15H_NB_F2 0x1602
94c1acf2 AG	177	#define PCI_DEVICE_ID_AMD_16H_NB_F1 0x1531
94c1acf2 AG	178	#define PCI_DEVICE_ID_AMD_16H_NB_F2 0x1532
cfe40fdb DT	179
	180	/*
	181	* Function 1 - Address Map
	182	*/
7f19bf75 BP	183	#define DRAM_BASE_LO 0x40
	184	#define DRAM_LIMIT_LO 0x44
	185
18b94f66 AG	186	/*
	187	* F15 M30h D18F1x2[1C:00]
	188	*/
	189	#define DRAM_CONT_BASE 0x200
	190	#define DRAM_CONT_LIMIT 0x204
	191
	192	/*
	193	* F15 M30h D18F1x2[4C:40]
	194	*/
	195	#define DRAM_CONT_HIGH_OFF 0x240
	196
151fa71c BP	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))
7f19bf75	200
bc21fa57	201	#define DHAR 0xf0
c8e518d5 BP	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)
cfe40fdb	205
cfe40fdb	206	/* NOTE: Extra mask bit vs K8 */
c8e518d5	207	#define f10_dhar_offset(pvt) (((pvt)->dhar & 0x0000ff80) << 16)
cfe40fdb	208
b2b0c605	209	#define DCT_CFG_SEL 0x10C
cfe40fdb	210
c1ae6830	211	#define DRAM_LOCAL_NODE_BASE 0x120
f08e457c BP	212	#define DRAM_LOCAL_NODE_LIM 0x124
f08e457c BP	213
7f19bf75 BP	214	#define DRAM_BASE_HI 0x140
7f19bf75 BP	215	#define DRAM_LIMIT_HI 0x144
cfe40fdb DT	216
	217
	218	/*
	219	* Function 2 - DRAM controller
	220	*/
11c75ead BP	221	#define DCSB0 0x40
	222	#define DCSB1 0x140
	223	#define DCSB_CS_ENABLE BIT(0)
cfe40fdb	224
11c75ead BP	225	#define DCSM0 0x60
11c75ead BP	226	#define DCSM1 0x160
cfe40fdb	227
11c75ead	228	#define csrow_enabled(i, dct, pvt) ((pvt)->csels[(dct)].csbases[(i)] & DCSB_CS_ENABLE)
cfe40fdb DT	229
	230	#define DBAM0 0x80
	231	#define DBAM1 0x180
	232
	233	/* Extract the DIMM 'type' on the i'th DIMM from the DBAM reg value passed */
0a5dfc31	234	#define DBAM_DIMM(i, reg) ((((reg) >> (4*(i)))) & 0xF)
cfe40fdb DT	235
	236	#define DBAM_MAX_VALUE 11
	237
cb328507 BP	238	#define DCLR0 0x90
cb328507 BP	239	#define DCLR1 0x190
cfe40fdb	240	#define REVE_WIDTH_128 BIT(16)
41d8bfab	241	#define WIDTH_128 BIT(11)
cfe40fdb	242
cb328507 BP	243	#define DCHR0 0x94
cb328507 BP	244	#define DCHR1 0x194
1433eb99	245	#define DDR3_MODE BIT(8)
cfe40fdb	246
78da121e	247	#define DCT_SEL_LO 0x110
78da121e BP	248	#define dct_high_range_enabled(pvt) ((pvt)->dct_sel_lo & BIT(0))
78da121e BP	249	#define dct_interleave_enabled(pvt) ((pvt)->dct_sel_lo & BIT(2))
cb328507	250
78da121e	251	#define dct_ganging_enabled(pvt) ((boot_cpu_data.x86 == 0x10) && ((pvt)->dct_sel_lo & BIT(4)))
cb328507	252
78da121e	253	#define dct_data_intlv_enabled(pvt) ((pvt)->dct_sel_lo & BIT(5))
78da121e	254	#define dct_memory_cleared(pvt) ((pvt)->dct_sel_lo & BIT(10))
cfe40fdb	255
95b0ef55 BP	256	#define SWAP_INTLV_REG 0x10c
95b0ef55 BP	257
78da121e	258	#define DCT_SEL_HI 0x114
cfe40fdb	259
cfe40fdb DT	260	/*
	261	* Function 3 - Misc Control
	262	*/
c9f4f26e	263	#define NBCTL 0x40
cfe40fdb	264
a97fa68e BP	265	#define NBCFG 0x44
	266	#define NBCFG_CHIPKILL BIT(23)
	267	#define NBCFG_ECC_ENABLE BIT(22)
cfe40fdb	268
5980bb9c	269	/* F3x48: NBSL */
cfe40fdb	270	#define F10_NBSL_EXT_ERR_ECC 0x8
5980bb9c	271	#define NBSL_PP_OBS 0x2
cfe40fdb	272
5980bb9c	273	#define SCRCTRL 0x58
cfe40fdb DT	274
cfe40fdb DT	275	#define F10_ONLINE_SPARE 0xB0
614ec9d8 BP	276	#define online_spare_swap_done(pvt, c) (((pvt)->online_spare >> (1 + 2 * (c))) & 0x1)
614ec9d8 BP	277	#define online_spare_bad_dramcs(pvt, c) (((pvt)->online_spare >> (4 + 4 * (c))) & 0x7)
cfe40fdb DT	278
cfe40fdb DT	279	#define F10_NB_ARRAY_ADDR 0xB8
6e71a870	280	#define F10_NB_ARRAY_DRAM BIT(31)
cfe40fdb DT	281
cfe40fdb DT	282	/* Bits [2:1] are used to select 16-byte section within a 64-byte cacheline */
6e71a870	283	#define SET_NB_ARRAY_ADDR(section) (((section) & 0x3) << 1)
cfe40fdb DT	284
cfe40fdb DT	285	#define F10_NB_ARRAY_DATA 0xBC
66fed2d4	286	#define F10_NB_ARR_ECC_WR_REQ BIT(17)
6e71a870 BP	287	#define SET_NB_DRAM_INJECTION_WRITE(inj) \
6e71a870 BP	288	(BIT(((inj.word) & 0xF) + 20) \| \
66fed2d4	289	F10_NB_ARR_ECC_WR_REQ \| inj.bit_map)
6e71a870 BP	290	#define SET_NB_DRAM_INJECTION_READ(inj) \
	291	(BIT(((inj.word) & 0xF) + 20) \| \
	292	BIT(16) \| inj.bit_map)
	293
cfe40fdb	294
5980bb9c BP	295	#define NBCAP 0xE8
	296	#define NBCAP_CHIPKILL BIT(4)
	297	#define NBCAP_SECDED BIT(3)
	298	#define NBCAP_DCT_DUAL BIT(0)
cfe40fdb	299
ad6a32e9 BP	300	#define EXT_NB_MCA_CFG 0x180
ad6a32e9 BP	301
f6d6ae96	302	/* MSRs */
5980bb9c	303	#define MSR_MCGCTL_NBE BIT(4)
cfe40fdb	304
b2b0c605	305	enum amd_families {
cfe40fdb DT	306	K8_CPUS = 0,
cfe40fdb DT	307	F10_CPUS,
b2b0c605	308	F15_CPUS,
18b94f66	309	F15_M30H_CPUS,
94c1acf2	310	F16_CPUS,
b2b0c605	311	NUM_FAMILIES,
cfe40fdb DT	312	};
cfe40fdb DT	313
cfe40fdb DT	314	/* Error injection control structure */
cfe40fdb DT	315	struct error_injection {
66fed2d4 BP	316	u32 section;
	317	u32 word;
	318	u32 bit_map;
cfe40fdb DT	319	};
cfe40fdb DT	320
7f19bf75 BP	321	/* low and high part of PCI config space regs */
	322	struct reg_pair {
	323	u32 lo, hi;
	324	};
	325
	326	/*
	327	* See F1x[1, 0][7C:40] DRAM Base/Limit Registers
	328	*/
	329	struct dram_range {
	330	struct reg_pair base;
	331	struct reg_pair lim;
	332	};
	333
11c75ead BP	334	/* A DCT chip selects collection */
	335	struct chip_select {
	336	u32 csbases[NUM_CHIPSELECTS];
	337	u8 b_cnt;
	338
	339	u32 csmasks[NUM_CHIPSELECTS];
	340	u8 m_cnt;
	341	};
	342
cfe40fdb	343	struct amd64_pvt {
b8cfa02f BP	344	struct low_ops *ops;
b8cfa02f BP	345
cfe40fdb	346	/* pci_device handles which we utilize */
8d5b5d9c	347	struct pci_dev F1, F2, *F3;
cfe40fdb	348
c7e5301a	349	u16 mc_node_id; /* MC index of this MC node */
18b94f66	350	u8 fam; /* CPU family */
a4b4bedc BP	351	u8 model; /* ... model */
	352	u8 stepping; /* ... stepping */
	353
cfe40fdb	354	int ext_model; /* extended model value of this node */
cfe40fdb DT	355	int channel_count;
	356
	357	/* Raw registers */
	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 */
	368
11c75ead BP	369	/* one for each DCT */
11c75ead BP	370	struct chip_select csels[2];
cfe40fdb	371
7f19bf75 BP	372	/* DRAM base and limit pairs F1x[78,70,68,60,58,50,48,40] */
7f19bf75 BP	373	struct dram_range ranges[DRAM_RANGES];
cfe40fdb	374
cfe40fdb DT	375	u64 top_mem; /* top of memory below 4GB */
	376	u64 top_mem2; /* top of memory above 4GB */
	377
78da121e BP	378	u32 dct_sel_lo; /* DRAM Controller Select Low */
78da121e BP	379	u32 dct_sel_hi; /* DRAM Controller Select High */
b2b0c605	380	u32 online_spare; /* On-Line spare Reg */
cfe40fdb	381
ad6a32e9	382	/* x4 or x8 syndromes in use */
a3b7db09	383	u8 ecc_sym_sz;
ad6a32e9	384
cfe40fdb DT	385	/* place to store error injection parameters prior to issue */
cfe40fdb DT	386	struct error_injection injection;
ae7bb7c6 BP	387	};
ae7bb7c6 BP	388
33ca0643 BP	389	enum err_codes {
	390	DECODE_OK = 0,
	391	ERR_NODE = -1,
	392	ERR_CSROW = -2,
	393	ERR_CHANNEL = -3,
	394	};
	395
	396	struct err_info {
	397	int err_code;
	398	struct mem_ctl_info *src_mci;
	399	int csrow;
	400	int channel;
	401	u16 syndrome;
	402	u32 page;
	403	u32 offset;
	404	};
	405
c7e5301a	406	static inline u64 get_dram_base(struct amd64_pvt *pvt, u8 i)
7f19bf75 BP	407	{
	408	u64 addr = ((u64)pvt->ranges[i].base.lo & 0xffff0000) << 8;
	409
	410	if (boot_cpu_data.x86 == 0xf)
	411	return addr;
	412
	413	return (((u64)pvt->ranges[i].base.hi & 0x000000ff) << 40) \| addr;
	414	}
	415
c7e5301a	416	static inline u64 get_dram_limit(struct amd64_pvt *pvt, u8 i)
7f19bf75 BP	417	{
	418	u64 lim = (((u64)pvt->ranges[i].lim.lo & 0xffff0000) << 8) \| 0x00ffffff;
	419
	420	if (boot_cpu_data.x86 == 0xf)
	421	return lim;
	422
	423	return (((u64)pvt->ranges[i].lim.hi & 0x000000ff) << 40) \| lim;
	424	}
	425
f192c7b1 BP	426	static inline u16 extract_syndrome(u64 status)
	427	{
	428	return ((status >> 47) & 0xff) \| ((status >> 16) & 0xff00);
	429	}
	430
18b94f66 AG	431	static inline u8 dct_sel_interleave_addr(struct amd64_pvt *pvt)
	432	{
	433	if (pvt->fam == 0x15 && pvt->model >= 0x30)
	434	return (((pvt->dct_sel_hi >> 9) & 0x1) << 2) \|
	435	((pvt->dct_sel_lo >> 6) & 0x3);
	436
	437	return ((pvt)->dct_sel_lo >> 6) & 0x3;
	438	}
ae7bb7c6 BP	439	/*
	440	* per-node ECC settings descriptor
	441	*/
	442	struct ecc_settings {
	443	u32 old_nbctl;
	444	bool nbctl_valid;
	445
cfe40fdb	446	struct flags {
d95cf4de BP	447	unsigned long nb_mce_enable:1;
d95cf4de BP	448	unsigned long nb_ecc_prev:1;
cfe40fdb DT	449	} flags;
	450	};
	451
7d6034d3	452	#ifdef CONFIG_EDAC_DEBUG
c5608759 MCC	453	int amd64_create_sysfs_dbg_files(struct mem_ctl_info *mci);
	454	void amd64_remove_sysfs_dbg_files(struct mem_ctl_info *mci);
	455
7d6034d3	456	#else
c5608759 MCC	457	static inline int amd64_create_sysfs_dbg_files(struct mem_ctl_info *mci)
	458	{
	459	return 0;
	460	}
	461	static void inline amd64_remove_sysfs_dbg_files(struct mem_ctl_info *mci)
	462	{
	463	}
7d6034d3 DT	464	#endif
	465
	466	#ifdef CONFIG_EDAC_AMD64_ERROR_INJECTION
c5608759 MCC	467	int amd64_create_sysfs_inject_files(struct mem_ctl_info *mci);
	468	void amd64_remove_sysfs_inject_files(struct mem_ctl_info *mci);
	469
7d6034d3	470	#else
c5608759 MCC	471	static inline int amd64_create_sysfs_inject_files(struct mem_ctl_info *mci)
	472	{
	473	return 0;
	474	}
	475	static inline void amd64_remove_sysfs_inject_files(struct mem_ctl_info *mci)
	476	{
	477	}
7d6034d3 DT	478	#endif
7d6034d3 DT	479
cfe40fdb DT	480	/*
	481	* Each of the PCI Device IDs types have their own set of hardware accessor
	482	* functions and per device encoding/decoding logic.
	483	*/
	484	struct low_ops {
1433eb99	485	int (early_channel_count) (struct amd64_pvt pvt);
f192c7b1	486	void (map_sysaddr_to_csrow) (struct mem_ctl_info mci, u64 sys_addr,
33ca0643	487	struct err_info *);
41d8bfab	488	int (dbam_to_cs) (struct amd64_pvt pvt, u8 dct, unsigned cs_mode);
b2b0c605 BP	489	int (read_dct_pci_cfg) (struct amd64_pvt pvt, int offset,
b2b0c605 BP	490	u32 val, const char func);
cfe40fdb DT	491	};
	492
	493	struct amd64_family_type {
	494	const char *ctl_name;
8d5b5d9c	495	u16 f1_id, f3_id;
cfe40fdb DT	496	struct low_ops ops;
	497	};
	498
66fed2d4 BP	499	int __amd64_read_pci_cfg_dword(struct pci_dev *pdev, int offset,
66fed2d4 BP	500	u32 val, const char func);
b2b0c605 BP	501	int __amd64_write_pci_cfg_dword(struct pci_dev *pdev, int offset,
b2b0c605 BP	502	u32 val, const char *func);
6ba5dcdc	503
b2b0c605 BP	504	#define amd64_read_pci_cfg(pdev, offset, val) \
b2b0c605 BP	505	__amd64_read_pci_cfg_dword(pdev, offset, val, __func__)
6ba5dcdc	506
b2b0c605 BP	507	#define amd64_write_pci_cfg(pdev, offset, val) \
b2b0c605 BP	508	__amd64_write_pci_cfg_dword(pdev, offset, val, __func__)
6ba5dcdc	509
b2b0c605 BP	510	#define amd64_read_dct_pci_cfg(pvt, offset, val) \
b2b0c605 BP	511	pvt->ops->read_dct_pci_cfg(pvt, offset, val, __func__)
6ba5dcdc	512
cfe40fdb DT	513	int amd64_get_dram_hole_info(struct mem_ctl_info mci, u64 hole_base,
cfe40fdb DT	514	u64 hole_offset, u64 hole_size);
c5608759 MCC	515
c5608759 MCC	516	#define to_mci(k) container_of(k, struct mem_ctl_info, dev)
66fed2d4 BP	517
	518	/* Injection helpers */
	519	static inline void disable_caches(void *dummy)
	520	{
	521	write_cr0(read_cr0() \| X86_CR0_CD);
	522	wbinvd();
	523	}
	524
	525	static inline void enable_caches(void *dummy)
	526	{
	527	write_cr0(read_cr0() & ~X86_CR0_CD);
	528	}
18b94f66 AG	529
	530	static inline u8 dram_intlv_en(struct amd64_pvt *pvt, unsigned int i)
	531	{
	532	if (pvt->fam == 0x15 && pvt->model >= 0x30) {
	533	u32 tmp;
	534	amd64_read_pci_cfg(pvt->F1, DRAM_CONT_LIMIT, &tmp);
	535	return (u8) tmp & 0xF;
	536	}
	537	return (u8) (pvt->ranges[i].base.lo >> 8) & 0x7;
	538	}
	539
	540	static inline u8 dhar_valid(struct amd64_pvt *pvt)
	541	{
	542	if (pvt->fam == 0x15 && pvt->model >= 0x30) {
	543	u32 tmp;
	544	amd64_read_pci_cfg(pvt->F1, DRAM_CONT_BASE, &tmp);
	545	return (tmp >> 1) & BIT(0);
	546	}
	547	return (pvt)->dhar & BIT(0);
	548	}
	549
	550	static inline u32 dct_sel_baseaddr(struct amd64_pvt *pvt)
	551	{
	552	if (pvt->fam == 0x15 && pvt->model >= 0x30) {
	553	u32 tmp;
	554	amd64_read_pci_cfg(pvt->F1, DRAM_CONT_BASE, &tmp);
	555	return (tmp >> 11) & 0x1FFF;
	556	}
	557	return (pvt)->dct_sel_lo & 0xFFFFF800;
	558	}