[mirror_ubuntu-jammy-kernel.git] / drivers / memory / fsl-corenet-cf.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * CoreNet Coherency Fabric error reporting
 *
 * Copyright 2014 Freescale Semiconductor Inc.
 */

#include <linux/interrupt.h>
#include <linux/io.h>
#include <linux/irq.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_address.h>
#include <linux/of_device.h>
#include <linux/of_irq.h>
#include <linux/platform_device.h>

enum ccf_version {
	CCF1,
	CCF2,
};

struct ccf_info {
	enum ccf_version version;
	int err_reg_offs;
	bool has_brr;
};

static const struct ccf_info ccf1_info = {
	.version = CCF1,
	.err_reg_offs = 0xa00,
	.has_brr = false,
};

static const struct ccf_info ccf2_info = {
	.version = CCF2,
	.err_reg_offs = 0xe40,
	.has_brr = true,
};

/*
 * This register is present but not documented, with different values for
 * IP_ID, on other chips with fsl,corenet2-cf such as t4240 and b4860.
 */
#define CCF_BRR			0xbf8
#define CCF_BRR_IPID		0xffff0000
#define CCF_BRR_IPID_T1040	0x09310000

static const struct of_device_id ccf_matches[] = {
	{
		.compatible = "fsl,corenet1-cf",
		.data = &ccf1_info,
	},
	{
		.compatible = "fsl,corenet2-cf",
		.data = &ccf2_info,
	},
	{}
};
MODULE_DEVICE_TABLE(of, ccf_matches);

struct ccf_err_regs {
	u32 errdet;		/* 0x00 Error Detect Register */
	/* 0x04 Error Enable (ccf1)/Disable (ccf2) Register */
	u32 errdis;
	/* 0x08 Error Interrupt Enable Register (ccf2 only) */
	u32 errinten;
	u32 cecar;		/* 0x0c Error Capture Attribute Register */
	u32 cecaddrh;		/* 0x10 Error Capture Address High */
	u32 cecaddrl;		/* 0x14 Error Capture Address Low */
	u32 cecar2;		/* 0x18 Error Capture Attribute Register 2 */
};

/* LAE/CV also valid for errdis and errinten */
#define ERRDET_LAE		(1 << 0)  /* Local Access Error */
#define ERRDET_CV		(1 << 1)  /* Coherency Violation */
#define ERRDET_UTID		(1 << 2)  /* Unavailable Target ID (t1040) */
#define ERRDET_MCST		(1 << 3)  /* Multicast Stash (t1040) */
#define ERRDET_CTYPE_SHIFT	26	  /* Capture Type (ccf2 only) */
#define ERRDET_CTYPE_MASK	(0x1f << ERRDET_CTYPE_SHIFT)
#define ERRDET_CAP		(1 << 31) /* Capture Valid (ccf2 only) */

#define CECAR_VAL		(1 << 0)  /* Valid (ccf1 only) */
#define CECAR_UVT		(1 << 15) /* Unavailable target ID (ccf1) */
#define CECAR_SRCID_SHIFT_CCF1	24
#define CECAR_SRCID_MASK_CCF1	(0xff << CECAR_SRCID_SHIFT_CCF1)
#define CECAR_SRCID_SHIFT_CCF2	18
#define CECAR_SRCID_MASK_CCF2	(0xff << CECAR_SRCID_SHIFT_CCF2)

#define CECADDRH_ADDRH		0xff

struct ccf_private {
	const struct ccf_info *info;
	struct device *dev;
	void __iomem *regs;
	struct ccf_err_regs __iomem *err_regs;
	bool t1040;
};

static irqreturn_t ccf_irq(int irq, void *dev_id)
{
	struct ccf_private *ccf = dev_id;
	static DEFINE_RATELIMIT_STATE(ratelimit, DEFAULT_RATELIMIT_INTERVAL,
				      DEFAULT_RATELIMIT_BURST);
	u32 errdet, cecar, cecar2;
	u64 addr;
	u32 src_id;
	bool uvt = false;
	bool cap_valid = false;

	errdet = ioread32be(&ccf->err_regs->errdet);
	cecar = ioread32be(&ccf->err_regs->cecar);
	cecar2 = ioread32be(&ccf->err_regs->cecar2);
	addr = ioread32be(&ccf->err_regs->cecaddrl);
	addr |= ((u64)(ioread32be(&ccf->err_regs->cecaddrh) &
		       CECADDRH_ADDRH)) << 32;

	if (!__ratelimit(&ratelimit))
		goto out;

	switch (ccf->info->version) {
	case CCF1:
		if (cecar & CECAR_VAL) {
			if (cecar & CECAR_UVT)
				uvt = true;

			src_id = (cecar & CECAR_SRCID_MASK_CCF1) >>
				 CECAR_SRCID_SHIFT_CCF1;
			cap_valid = true;
		}

		break;
	case CCF2:
		if (errdet & ERRDET_CAP) {
			src_id = (cecar & CECAR_SRCID_MASK_CCF2) >>
				 CECAR_SRCID_SHIFT_CCF2;
			cap_valid = true;
		}

		break;
	}

	dev_crit(ccf->dev, "errdet 0x%08x cecar 0x%08x cecar2 0x%08x\n",
		 errdet, cecar, cecar2);

	if (errdet & ERRDET_LAE) {
		if (uvt)
			dev_crit(ccf->dev, "LAW Unavailable Target ID\n");
		else
			dev_crit(ccf->dev, "Local Access Window Error\n");
	}

	if (errdet & ERRDET_CV)
		dev_crit(ccf->dev, "Coherency Violation\n");

	if (errdet & ERRDET_UTID)
		dev_crit(ccf->dev, "Unavailable Target ID\n");

	if (errdet & ERRDET_MCST)
		dev_crit(ccf->dev, "Multicast Stash\n");

	if (cap_valid) {
		dev_crit(ccf->dev, "address 0x%09llx, src id 0x%x\n",
			 addr, src_id);
	}

out:
	iowrite32be(errdet, &ccf->err_regs->errdet);
	return errdet ? IRQ_HANDLED : IRQ_NONE;
}

static int ccf_probe(struct platform_device *pdev)
{
	struct ccf_private *ccf;
	struct resource *r;
	const struct of_device_id *match;
	u32 errinten;
	int ret, irq;

	match = of_match_device(ccf_matches, &pdev->dev);
	if (WARN_ON(!match))
		return -ENODEV;

	ccf = devm_kzalloc(&pdev->dev, sizeof(*ccf), GFP_KERNEL);
	if (!ccf)
		return -ENOMEM;

	r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	if (!r) {
		dev_err(&pdev->dev, "%s: no mem resource\n", __func__);
		return -ENXIO;
	}

	ccf->regs = devm_ioremap_resource(&pdev->dev, r);
	if (IS_ERR(ccf->regs))
		return PTR_ERR(ccf->regs);

	ccf->dev = &pdev->dev;
	ccf->info = match->data;
	ccf->err_regs = ccf->regs + ccf->info->err_reg_offs;

	if (ccf->info->has_brr) {
		u32 brr = ioread32be(ccf->regs + CCF_BRR);

		if ((brr & CCF_BRR_IPID) == CCF_BRR_IPID_T1040)
			ccf->t1040 = true;
	}

	dev_set_drvdata(&pdev->dev, ccf);

	irq = platform_get_irq(pdev, 0);
	if (irq < 0)
		return irq;

	ret = devm_request_irq(&pdev->dev, irq, ccf_irq, 0, pdev->name, ccf);
	if (ret) {
		dev_err(&pdev->dev, "%s: can't request irq\n", __func__);
		return ret;
	}

	errinten = ERRDET_LAE | ERRDET_CV;
	if (ccf->t1040)
		errinten |= ERRDET_UTID | ERRDET_MCST;

	switch (ccf->info->version) {
	case CCF1:
		/* On CCF1 this register enables rather than disables. */
		iowrite32be(errinten, &ccf->err_regs->errdis);
		break;

	case CCF2:
		iowrite32be(0, &ccf->err_regs->errdis);
		iowrite32be(errinten, &ccf->err_regs->errinten);
		break;
	}

	return 0;
}

static int ccf_remove(struct platform_device *pdev)
{
	struct ccf_private *ccf = dev_get_drvdata(&pdev->dev);

	switch (ccf->info->version) {
	case CCF1:
		iowrite32be(0, &ccf->err_regs->errdis);
		break;

	case CCF2:
		/*
		 * We clear errdis on ccf1 because that's the only way to
		 * disable interrupts, but on ccf2 there's no need to disable
		 * detection.
		 */
		iowrite32be(0, &ccf->err_regs->errinten);
		break;
	}

	return 0;
}

static struct platform_driver ccf_driver = {
	.driver = {
		.name = KBUILD_MODNAME,
		.of_match_table = ccf_matches,
	},
	.probe = ccf_probe,
	.remove = ccf_remove,
};

module_platform_driver(ccf_driver);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Freescale Semiconductor");
MODULE_DESCRIPTION("Freescale CoreNet Coherency Fabric error reporting");
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
54afbec0 SW	2	/*
	3	* CoreNet Coherency Fabric error reporting
	4	*
	5	* Copyright 2014 Freescale Semiconductor Inc.
54afbec0 SW	6	*/
	7
	8	#include <linux/interrupt.h>
	9	#include <linux/io.h>
	10	#include <linux/irq.h>
	11	#include <linux/module.h>
	12	#include <linux/of.h>
	13	#include <linux/of_address.h>
	14	#include <linux/of_device.h>
	15	#include <linux/of_irq.h>
	16	#include <linux/platform_device.h>
	17
	18	enum ccf_version {
	19	CCF1,
	20	CCF2,
	21	};
	22
	23	struct ccf_info {
	24	enum ccf_version version;
	25	int err_reg_offs;
c3e09b3a	26	bool has_brr;
54afbec0 SW	27	};
	28
	29	static const struct ccf_info ccf1_info = {
	30	.version = CCF1,
	31	.err_reg_offs = 0xa00,
c3e09b3a	32	.has_brr = false,
54afbec0 SW	33	};
	34
	35	static const struct ccf_info ccf2_info = {
	36	.version = CCF2,
	37	.err_reg_offs = 0xe40,
c3e09b3a	38	.has_brr = true,
54afbec0 SW	39	};
54afbec0 SW	40
c3e09b3a SW	41	/*
	42	* This register is present but not documented, with different values for
	43	* IP_ID, on other chips with fsl,corenet2-cf such as t4240 and b4860.
	44	*/
	45	#define CCF_BRR 0xbf8
	46	#define CCF_BRR_IPID 0xffff0000
	47	#define CCF_BRR_IPID_T1040 0x09310000
	48
54afbec0 SW	49	static const struct of_device_id ccf_matches[] = {
	50	{
	51	.compatible = "fsl,corenet1-cf",
	52	.data = &ccf1_info,
	53	},
	54	{
	55	.compatible = "fsl,corenet2-cf",
	56	.data = &ccf2_info,
	57	},
	58	{}
	59	};
613a91e2	60	MODULE_DEVICE_TABLE(of, ccf_matches);
54afbec0 SW	61
	62	struct ccf_err_regs {
	63	u32 errdet; /* 0x00 Error Detect Register */
	64	/* 0x04 Error Enable (ccf1)/Disable (ccf2) Register */
	65	u32 errdis;
	66	/* 0x08 Error Interrupt Enable Register (ccf2 only) */
	67	u32 errinten;
	68	u32 cecar; /* 0x0c Error Capture Attribute Register */
	69	u32 cecaddrh; /* 0x10 Error Capture Address High */
	70	u32 cecaddrl; /* 0x14 Error Capture Address Low */
	71	u32 cecar2; /* 0x18 Error Capture Attribute Register 2 */
	72	};
	73
	74	/* LAE/CV also valid for errdis and errinten */
	75	#define ERRDET_LAE (1 << 0) /* Local Access Error */
	76	#define ERRDET_CV (1 << 1) /* Coherency Violation */
c3e09b3a SW	77	#define ERRDET_UTID (1 << 2) /* Unavailable Target ID (t1040) */
c3e09b3a SW	78	#define ERRDET_MCST (1 << 3) /* Multicast Stash (t1040) */
54afbec0 SW	79	#define ERRDET_CTYPE_SHIFT 26 /* Capture Type (ccf2 only) */
	80	#define ERRDET_CTYPE_MASK (0x1f << ERRDET_CTYPE_SHIFT)
	81	#define ERRDET_CAP (1 << 31) /* Capture Valid (ccf2 only) */
	82
	83	#define CECAR_VAL (1 << 0) /* Valid (ccf1 only) */
	84	#define CECAR_UVT (1 << 15) /* Unavailable target ID (ccf1) */
	85	#define CECAR_SRCID_SHIFT_CCF1 24
	86	#define CECAR_SRCID_MASK_CCF1 (0xff << CECAR_SRCID_SHIFT_CCF1)
	87	#define CECAR_SRCID_SHIFT_CCF2 18
	88	#define CECAR_SRCID_MASK_CCF2 (0xff << CECAR_SRCID_SHIFT_CCF2)
	89
	90	#define CECADDRH_ADDRH 0xff
	91
	92	struct ccf_private {
	93	const struct ccf_info *info;
	94	struct device *dev;
	95	void __iomem *regs;
	96	struct ccf_err_regs __iomem *err_regs;
c3e09b3a	97	bool t1040;
54afbec0 SW	98	};
	99
	100	static irqreturn_t ccf_irq(int irq, void *dev_id)
	101	{
	102	struct ccf_private *ccf = dev_id;
	103	static DEFINE_RATELIMIT_STATE(ratelimit, DEFAULT_RATELIMIT_INTERVAL,
	104	DEFAULT_RATELIMIT_BURST);
	105	u32 errdet, cecar, cecar2;
	106	u64 addr;
	107	u32 src_id;
	108	bool uvt = false;
	109	bool cap_valid = false;
	110
	111	errdet = ioread32be(&ccf->err_regs->errdet);
	112	cecar = ioread32be(&ccf->err_regs->cecar);
	113	cecar2 = ioread32be(&ccf->err_regs->cecar2);
	114	addr = ioread32be(&ccf->err_regs->cecaddrl);
	115	addr \|= ((u64)(ioread32be(&ccf->err_regs->cecaddrh) &
	116	CECADDRH_ADDRH)) << 32;
	117
	118	if (!__ratelimit(&ratelimit))
	119	goto out;
	120
	121	switch (ccf->info->version) {
	122	case CCF1:
	123	if (cecar & CECAR_VAL) {
	124	if (cecar & CECAR_UVT)
	125	uvt = true;
	126
	127	src_id = (cecar & CECAR_SRCID_MASK_CCF1) >>
	128	CECAR_SRCID_SHIFT_CCF1;
	129	cap_valid = true;
	130	}
	131
	132	break;
	133	case CCF2:
	134	if (errdet & ERRDET_CAP) {
	135	src_id = (cecar & CECAR_SRCID_MASK_CCF2) >>
	136	CECAR_SRCID_SHIFT_CCF2;
	137	cap_valid = true;
	138	}
	139
	140	break;
	141	}
	142
	143	dev_crit(ccf->dev, "errdet 0x%08x cecar 0x%08x cecar2 0x%08x\n",
	144	errdet, cecar, cecar2);
	145
	146	if (errdet & ERRDET_LAE) {
	147	if (uvt)
	148	dev_crit(ccf->dev, "LAW Unavailable Target ID\n");
	149	else
	150	dev_crit(ccf->dev, "Local Access Window Error\n");
	151	}
	152
	153	if (errdet & ERRDET_CV)
	154	dev_crit(ccf->dev, "Coherency Violation\n");
	155
c3e09b3a SW	156	if (errdet & ERRDET_UTID)
	157	dev_crit(ccf->dev, "Unavailable Target ID\n");
	158
	159	if (errdet & ERRDET_MCST)
	160	dev_crit(ccf->dev, "Multicast Stash\n");
	161
54afbec0 SW	162	if (cap_valid) {
	163	dev_crit(ccf->dev, "address 0x%09llx, src id 0x%x\n",
	164	addr, src_id);
	165	}
	166
	167	out:
	168	iowrite32be(errdet, &ccf->err_regs->errdet);
	169	return errdet ? IRQ_HANDLED : IRQ_NONE;
	170	}
	171
	172	static int ccf_probe(struct platform_device *pdev)
	173	{
	174	struct ccf_private *ccf;
	175	struct resource *r;
	176	const struct of_device_id *match;
c3e09b3a	177	u32 errinten;
54afbec0 SW	178	int ret, irq;
	179
	180	match = of_match_device(ccf_matches, &pdev->dev);
	181	if (WARN_ON(!match))
	182	return -ENODEV;
	183
	184	ccf = devm_kzalloc(&pdev->dev, sizeof(*ccf), GFP_KERNEL);
	185	if (!ccf)
	186	return -ENOMEM;
	187
	188	r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	189	if (!r) {
	190	dev_err(&pdev->dev, "%s: no mem resource\n", __func__);
	191	return -ENXIO;
	192	}
	193
	194	ccf->regs = devm_ioremap_resource(&pdev->dev, r);
b11a188a	195	if (IS_ERR(ccf->regs))
54afbec0	196	return PTR_ERR(ccf->regs);
54afbec0 SW	197
	198	ccf->dev = &pdev->dev;
	199	ccf->info = match->data;
	200	ccf->err_regs = ccf->regs + ccf->info->err_reg_offs;
	201
c3e09b3a SW	202	if (ccf->info->has_brr) {
	203	u32 brr = ioread32be(ccf->regs + CCF_BRR);
	204
	205	if ((brr & CCF_BRR_IPID) == CCF_BRR_IPID_T1040)
	206	ccf->t1040 = true;
	207	}
	208
54afbec0 SW	209	dev_set_drvdata(&pdev->dev, ccf);
	210
	211	irq = platform_get_irq(pdev, 0);
dd85345a KK	212	if (irq < 0)
dd85345a KK	213	return irq;
54afbec0 SW	214
	215	ret = devm_request_irq(&pdev->dev, irq, ccf_irq, 0, pdev->name, ccf);
	216	if (ret) {
	217	dev_err(&pdev->dev, "%s: can't request irq\n", __func__);
	218	return ret;
	219	}
	220
c3e09b3a SW	221	errinten = ERRDET_LAE \| ERRDET_CV;
	222	if (ccf->t1040)
	223	errinten \|= ERRDET_UTID \| ERRDET_MCST;
	224
54afbec0 SW	225	switch (ccf->info->version) {
	226	case CCF1:
	227	/* On CCF1 this register enables rather than disables. */
c3e09b3a	228	iowrite32be(errinten, &ccf->err_regs->errdis);
54afbec0 SW	229	break;
	230
	231	case CCF2:
	232	iowrite32be(0, &ccf->err_regs->errdis);
c3e09b3a	233	iowrite32be(errinten, &ccf->err_regs->errinten);
54afbec0 SW	234	break;
	235	}
	236
	237	return 0;
	238	}
	239
	240	static int ccf_remove(struct platform_device *pdev)
	241	{
	242	struct ccf_private *ccf = dev_get_drvdata(&pdev->dev);
	243
	244	switch (ccf->info->version) {
	245	case CCF1:
	246	iowrite32be(0, &ccf->err_regs->errdis);
	247	break;
	248
	249	case CCF2:
	250	/*
	251	* We clear errdis on ccf1 because that's the only way to
	252	* disable interrupts, but on ccf2 there's no need to disable
	253	* detection.
	254	*/
	255	iowrite32be(0, &ccf->err_regs->errinten);
	256	break;
	257	}
	258
	259	return 0;
	260	}
	261
	262	static struct platform_driver ccf_driver = {
	263	.driver = {
	264	.name = KBUILD_MODNAME,
54afbec0 SW	265	.of_match_table = ccf_matches,
	266	},
	267	.probe = ccf_probe,
	268	.remove = ccf_remove,
	269	};
	270
	271	module_platform_driver(ccf_driver);
	272
	273	MODULE_LICENSE("GPL");
	274	MODULE_AUTHOR("Freescale Semiconductor");
	275	MODULE_DESCRIPTION("Freescale CoreNet Coherency Fabric error reporting");