[deliverable/linux.git] / arch / arm / mach-mvebu / coherency.c

/*
 * Coherency fabric (Aurora) support for Armada 370, 375, 38x and XP
 * platforms.
 *
 * Copyright (C) 2012 Marvell
 *
 * Yehuda Yitschak <yehuday@marvell.com>
 * Gregory Clement <gregory.clement@free-electrons.com>
 * Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
 *
 * This file is licensed under the terms of the GNU General Public
 * License version 2.  This program is licensed "as is" without any
 * warranty of any kind, whether express or implied.
 *
 * The Armada 370, 375, 38x and XP SOCs have a coherency fabric which is
 * responsible for ensuring hardware coherency between all CPUs and between
 * CPUs and I/O masters. This file initializes the coherency fabric and
 * supplies basic routines for configuring and controlling hardware coherency
 */

#define pr_fmt(fmt) "mvebu-coherency: " fmt

#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/of_address.h>
#include <linux/io.h>
#include <linux/smp.h>
#include <linux/dma-mapping.h>
#include <linux/platform_device.h>
#include <linux/slab.h>
#include <linux/mbus.h>
#include <linux/pci.h>
#include <asm/smp_plat.h>
#include <asm/cacheflush.h>
#include <asm/mach/map.h>
#include <asm/dma-mapping.h>
#include "coherency.h"
#include "mvebu-soc-id.h"

unsigned long coherency_phys_base;
void __iomem *coherency_base;
static void __iomem *coherency_cpu_base;
static void __iomem *cpu_config_base;

/* Coherency fabric registers */
#define IO_SYNC_BARRIER_CTL_OFFSET		   0x0

enum {
	COHERENCY_FABRIC_TYPE_NONE,
	COHERENCY_FABRIC_TYPE_ARMADA_370_XP,
	COHERENCY_FABRIC_TYPE_ARMADA_375,
	COHERENCY_FABRIC_TYPE_ARMADA_380,
};

static const struct of_device_id of_coherency_table[] = {
	{.compatible = "marvell,coherency-fabric",
	 .data = (void *) COHERENCY_FABRIC_TYPE_ARMADA_370_XP },
	{.compatible = "marvell,armada-375-coherency-fabric",
	 .data = (void *) COHERENCY_FABRIC_TYPE_ARMADA_375 },
	{.compatible = "marvell,armada-380-coherency-fabric",
	 .data = (void *) COHERENCY_FABRIC_TYPE_ARMADA_380 },
	{ /* end of list */ },
};

/* Functions defined in coherency_ll.S */
int ll_enable_coherency(void);
void ll_add_cpu_to_smp_group(void);

#define CPU_CONFIG_SHARED_L2 BIT(16)

/*
 * Disable the "Shared L2 Present" bit in CPU Configuration register
 * on Armada XP.
 *
 * The "Shared L2 Present" bit affects the "level of coherence" value
 * in the clidr CP15 register.  Cache operation functions such as
 * "flush all" and "invalidate all" operate on all the cache levels
 * that included in the defined level of coherence. When HW I/O
 * coherency is used, this bit causes unnecessary flushes of the L2
 * cache.
 */
static void armada_xp_clear_shared_l2(void)
{
	u32 reg;

	if (!cpu_config_base)
		return;

	reg = readl(cpu_config_base);
	reg &= ~CPU_CONFIG_SHARED_L2;
	writel(reg, cpu_config_base);
}

static int mvebu_hwcc_notifier(struct notifier_block *nb,
			       unsigned long event, void *__dev)
{
	struct device *dev = __dev;

	if (event != BUS_NOTIFY_ADD_DEVICE)
		return NOTIFY_DONE;
	set_dma_ops(dev, &arm_coherent_dma_ops);

	return NOTIFY_OK;
}

static struct notifier_block mvebu_hwcc_nb = {
	.notifier_call = mvebu_hwcc_notifier,
};

static struct notifier_block mvebu_hwcc_pci_nb = {
	.notifier_call = mvebu_hwcc_notifier,
};

static int armada_xp_clear_shared_l2_notifier_func(struct notifier_block *nfb,
					unsigned long action, void *hcpu)
{
	if (action == CPU_STARTING || action == CPU_STARTING_FROZEN)
		armada_xp_clear_shared_l2();

	return NOTIFY_OK;
}

static struct notifier_block armada_xp_clear_shared_l2_notifier = {
	.notifier_call = armada_xp_clear_shared_l2_notifier_func,
	.priority = 100,
};

static void __init armada_370_coherency_init(struct device_node *np)
{
	struct resource res;
	struct device_node *cpu_config_np;

	of_address_to_resource(np, 0, &res);
	coherency_phys_base = res.start;
	/*
	 * Ensure secondary CPUs will see the updated value,
	 * which they read before they join the coherency
	 * fabric, and therefore before they are coherent with
	 * the boot CPU cache.
	 */
	sync_cache_w(&coherency_phys_base);
	coherency_base = of_iomap(np, 0);
	coherency_cpu_base = of_iomap(np, 1);

	cpu_config_np = of_find_compatible_node(NULL, NULL,
						"marvell,armada-xp-cpu-config");
	if (!cpu_config_np)
		goto exit;

	cpu_config_base = of_iomap(cpu_config_np, 0);
	if (!cpu_config_base) {
		of_node_put(cpu_config_np);
		goto exit;
	}

	of_node_put(cpu_config_np);

	register_cpu_notifier(&armada_xp_clear_shared_l2_notifier);

exit:
	set_cpu_coherent();
}

/*
 * This ioremap hook is used on Armada 375/38x to ensure that PCIe
 * memory areas are mapped as MT_UNCACHED instead of MT_DEVICE. This
 * is needed as a workaround for a deadlock issue between the PCIe
 * interface and the cache controller.
 */
static void __iomem *
armada_pcie_wa_ioremap_caller(phys_addr_t phys_addr, size_t size,
			      unsigned int mtype, void *caller)
{
	struct resource pcie_mem;

	mvebu_mbus_get_pcie_mem_aperture(&pcie_mem);

	if (pcie_mem.start <= phys_addr && (phys_addr + size) <= pcie_mem.end)
		mtype = MT_UNCACHED;

	return __arm_ioremap_caller(phys_addr, size, mtype, caller);
}

static void __init armada_375_380_coherency_init(struct device_node *np)
{
	struct device_node *cache_dn;

	coherency_cpu_base = of_iomap(np, 0);
	arch_ioremap_caller = armada_pcie_wa_ioremap_caller;

	/*
	 * We should switch the PL310 to I/O coherency mode only if
	 * I/O coherency is actually enabled.
	 */
	if (!coherency_available())
		return;

	/*
	 * Add the PL310 property "arm,io-coherent". This makes sure the
	 * outer sync operation is not used, which allows to
	 * workaround the system erratum that causes deadlocks when
	 * doing PCIe in an SMP situation on Armada 375 and Armada
	 * 38x.
	 */
	for_each_compatible_node(cache_dn, NULL, "arm,pl310-cache") {
		struct property *p;

		p = kzalloc(sizeof(*p), GFP_KERNEL);
		p->name = kstrdup("arm,io-coherent", GFP_KERNEL);
		of_add_property(cache_dn, p);
	}
}

static int coherency_type(void)
{
	struct device_node *np;
	const struct of_device_id *match;
	int type;

	/*
	 * The coherency fabric is needed:
	 * - For coherency between processors on Armada XP, so only
	 *   when SMP is enabled.
	 * - For coherency between the processor and I/O devices, but
	 *   this coherency requires many pre-requisites (write
	 *   allocate cache policy, shareable pages, SMP bit set) that
	 *   are only meant in SMP situations.
	 *
	 * Note that this means that on Armada 370, there is currently
	 * no way to use hardware I/O coherency, because even when
	 * CONFIG_SMP is enabled, is_smp() returns false due to the
	 * Armada 370 being a single-core processor. To lift this
	 * limitation, we would have to find a way to make the cache
	 * policy set to write-allocate (on all Armada SoCs), and to
	 * set the shareable attribute in page tables (on all Armada
	 * SoCs except the Armada 370). Unfortunately, such decisions
	 * are taken very early in the kernel boot process, at a point
	 * where we don't know yet on which SoC we are running.

	 */
	if (!is_smp())
		return COHERENCY_FABRIC_TYPE_NONE;

	np = of_find_matching_node_and_match(NULL, of_coherency_table, &match);
	if (!np)
		return COHERENCY_FABRIC_TYPE_NONE;

	type = (int) match->data;

	of_node_put(np);

	return type;
}

int set_cpu_coherent(void)
{
	int type = coherency_type();

	if (type == COHERENCY_FABRIC_TYPE_ARMADA_370_XP) {
		if (!coherency_base) {
			pr_warn("Can't make current CPU cache coherent.\n");
			pr_warn("Coherency fabric is not initialized\n");
			return 1;
		}

		armada_xp_clear_shared_l2();
		ll_add_cpu_to_smp_group();
		return ll_enable_coherency();
	}

	return 0;
}

int coherency_available(void)
{
	return coherency_type() != COHERENCY_FABRIC_TYPE_NONE;
}

int __init coherency_init(void)
{
	int type = coherency_type();
	struct device_node *np;

	np = of_find_matching_node(NULL, of_coherency_table);

	if (type == COHERENCY_FABRIC_TYPE_ARMADA_370_XP)
		armada_370_coherency_init(np);
	else if (type == COHERENCY_FABRIC_TYPE_ARMADA_375 ||
		 type == COHERENCY_FABRIC_TYPE_ARMADA_380)
		armada_375_380_coherency_init(np);

	of_node_put(np);

	return 0;
}

static int __init coherency_late_init(void)
{
	if (coherency_available())
		bus_register_notifier(&platform_bus_type,
				      &mvebu_hwcc_nb);
	return 0;
}

postcore_initcall(coherency_late_init);

#if IS_ENABLED(CONFIG_PCI)
static int __init coherency_pci_init(void)
{
	if (coherency_available())
		bus_register_notifier(&pci_bus_type,
				       &mvebu_hwcc_pci_nb);
	return 0;
}

arch_initcall(coherency_pci_init);
#endif
Commit	Line	Data
009f1315	1	/*
e12f12ac TP	2	* Coherency fabric (Aurora) support for Armada 370, 375, 38x and XP
e12f12ac TP	3	* platforms.
009f1315 GC	4	*
	5	* Copyright (C) 2012 Marvell
	6	*
	7	* Yehuda Yitschak <yehuday@marvell.com>
	8	* Gregory Clement <gregory.clement@free-electrons.com>
	9	* Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
	10	*
	11	* This file is licensed under the terms of the GNU General Public
	12	* License version 2. This program is licensed "as is" without any
	13	* warranty of any kind, whether express or implied.
	14	*
e12f12ac	15	* The Armada 370, 375, 38x and XP SOCs have a coherency fabric which is
009f1315 GC	16	* responsible for ensuring hardware coherency between all CPUs and between
	17	* CPUs and I/O masters. This file initializes the coherency fabric and
	18	* supplies basic routines for configuring and controlling hardware coherency
	19	*/
	20
5ab5afd8 TP	21	#define pr_fmt(fmt) "mvebu-coherency: " fmt
5ab5afd8 TP	22
009f1315 GC	23	#include <linux/kernel.h>
	24	#include <linux/init.h>
	25	#include <linux/of_address.h>
	26	#include <linux/io.h>
	27	#include <linux/smp.h>
e60304f8 GC	28	#include <linux/dma-mapping.h>
e60304f8 GC	29	#include <linux/platform_device.h>
5ab5afd8 TP	30	#include <linux/slab.h>
5ab5afd8 TP	31	#include <linux/mbus.h>
b0063aad	32	#include <linux/pci.h>
009f1315	33	#include <asm/smp_plat.h>
580ff0ee	34	#include <asm/cacheflush.h>
497a9230	35	#include <asm/mach/map.h>
1bd4d8a6	36	#include <asm/dma-mapping.h>
b12634e3	37	#include "coherency.h"
39438567	38	#include "mvebu-soc-id.h"
009f1315	39
8bd26e3a	40	unsigned long coherency_phys_base;
ccd6a131	41	void __iomem *coherency_base;
e60304f8	42	static void __iomem *coherency_cpu_base;
d492ccca	43	static void __iomem *cpu_config_base;
009f1315 GC	44
009f1315 GC	45	/* Coherency fabric registers */
e60304f8 GC	46	#define IO_SYNC_BARRIER_CTL_OFFSET 0x0
e60304f8 GC	47
924d38f4	48	enum {
501f928e	49	COHERENCY_FABRIC_TYPE_NONE,
924d38f4	50	COHERENCY_FABRIC_TYPE_ARMADA_370_XP,
77fa4b9a	51	COHERENCY_FABRIC_TYPE_ARMADA_375,
d0de9323	52	COHERENCY_FABRIC_TYPE_ARMADA_380,
924d38f4 TP	53	};
924d38f4 TP	54
444d2d33	55	static const struct of_device_id of_coherency_table[] = {
924d38f4 TP	56	{.compatible = "marvell,coherency-fabric",
924d38f4 TP	57	.data = (void *) COHERENCY_FABRIC_TYPE_ARMADA_370_XP },
77fa4b9a TP	58	{.compatible = "marvell,armada-375-coherency-fabric",
77fa4b9a TP	59	.data = (void *) COHERENCY_FABRIC_TYPE_ARMADA_375 },
d0de9323 TP	60	{.compatible = "marvell,armada-380-coherency-fabric",
d0de9323 TP	61	.data = (void *) COHERENCY_FABRIC_TYPE_ARMADA_380 },
009f1315 GC	62	{ /* end of list */ },
	63	};
	64
2e8a5942 GC	65	/* Functions defined in coherency_ll.S */
	66	int ll_enable_coherency(void);
	67	void ll_add_cpu_to_smp_group(void);
009f1315	68
d492ccca TP	69	#define CPU_CONFIG_SHARED_L2 BIT(16)
	70
	71	/*
	72	* Disable the "Shared L2 Present" bit in CPU Configuration register
	73	* on Armada XP.
	74	*
	75	* The "Shared L2 Present" bit affects the "level of coherence" value
	76	* in the clidr CP15 register. Cache operation functions such as
	77	* "flush all" and "invalidate all" operate on all the cache levels
	78	* that included in the defined level of coherence. When HW I/O
	79	* coherency is used, this bit causes unnecessary flushes of the L2
	80	* cache.
	81	*/
	82	static void armada_xp_clear_shared_l2(void)
	83	{
	84	u32 reg;
	85
	86	if (!cpu_config_base)
	87	return;
	88
	89	reg = readl(cpu_config_base);
	90	reg &= ~CPU_CONFIG_SHARED_L2;
	91	writel(reg, cpu_config_base);
	92	}
	93
b0063aad TP	94	static int mvebu_hwcc_notifier(struct notifier_block *nb,
b0063aad TP	95	unsigned long event, void *__dev)
e60304f8 GC	96	{
	97	struct device *dev = __dev;
	98
	99	if (event != BUS_NOTIFY_ADD_DEVICE)
	100	return NOTIFY_DONE;
1bd4d8a6	101	set_dma_ops(dev, &arm_coherent_dma_ops);
e60304f8 GC	102
	103	return NOTIFY_OK;
	104	}
	105
b0063aad TP	106	static struct notifier_block mvebu_hwcc_nb = {
b0063aad TP	107	.notifier_call = mvebu_hwcc_notifier,
e60304f8 GC	108	};
e60304f8 GC	109
a728b977 EG	110	static struct notifier_block mvebu_hwcc_pci_nb = {
	111	.notifier_call = mvebu_hwcc_notifier,
	112	};
	113
d492ccca TP	114	static int armada_xp_clear_shared_l2_notifier_func(struct notifier_block *nfb,
	115	unsigned long action, void *hcpu)
	116	{
	117	if (action == CPU_STARTING \|\| action == CPU_STARTING_FROZEN)
	118	armada_xp_clear_shared_l2();
	119
	120	return NOTIFY_OK;
	121	}
	122
	123	static struct notifier_block armada_xp_clear_shared_l2_notifier = {
	124	.notifier_call = armada_xp_clear_shared_l2_notifier_func,
	125	.priority = 100,
	126	};
	127
924d38f4 TP	128	static void __init armada_370_coherency_init(struct device_node *np)
	129	{
	130	struct resource res;
d492ccca	131	struct device_node *cpu_config_np;
924d38f4 TP	132
	133	of_address_to_resource(np, 0, &res);
	134	coherency_phys_base = res.start;
	135	/*
	136	* Ensure secondary CPUs will see the updated value,
	137	* which they read before they join the coherency
	138	* fabric, and therefore before they are coherent with
	139	* the boot CPU cache.
	140	*/
	141	sync_cache_w(&coherency_phys_base);
	142	coherency_base = of_iomap(np, 0);
	143	coherency_cpu_base = of_iomap(np, 1);
d492ccca TP	144
	145	cpu_config_np = of_find_compatible_node(NULL, NULL,
	146	"marvell,armada-xp-cpu-config");
	147	if (!cpu_config_np)
	148	goto exit;
	149
	150	cpu_config_base = of_iomap(cpu_config_np, 0);
	151	if (!cpu_config_base) {
	152	of_node_put(cpu_config_np);
	153	goto exit;
	154	}
	155
	156	of_node_put(cpu_config_np);
	157
	158	register_cpu_notifier(&armada_xp_clear_shared_l2_notifier);
	159
	160	exit:
952f4ca7	161	set_cpu_coherent();
924d38f4 TP	162	}
924d38f4 TP	163
497a9230 TP	164	/*
	165	* This ioremap hook is used on Armada 375/38x to ensure that PCIe
	166	* memory areas are mapped as MT_UNCACHED instead of MT_DEVICE. This
	167	* is needed as a workaround for a deadlock issue between the PCIe
	168	* interface and the cache controller.
	169	*/
	170	static void __iomem *
	171	armada_pcie_wa_ioremap_caller(phys_addr_t phys_addr, size_t size,
	172	unsigned int mtype, void *caller)
	173	{
	174	struct resource pcie_mem;
	175
	176	mvebu_mbus_get_pcie_mem_aperture(&pcie_mem);
	177
	178	if (pcie_mem.start <= phys_addr && (phys_addr + size) <= pcie_mem.end)
	179	mtype = MT_UNCACHED;
	180
	181	return __arm_ioremap_caller(phys_addr, size, mtype, caller);
	182	}
	183
d0de9323	184	static void __init armada_375_380_coherency_init(struct device_node *np)
77fa4b9a	185	{
497a9230 TP	186	struct device_node *cache_dn;
497a9230 TP	187
77fa4b9a	188	coherency_cpu_base = of_iomap(np, 0);
497a9230 TP	189	arch_ioremap_caller = armada_pcie_wa_ioremap_caller;
497a9230 TP	190
dcad6887 TP	191	/*
	192	* We should switch the PL310 to I/O coherency mode only if
	193	* I/O coherency is actually enabled.
	194	*/
	195	if (!coherency_available())
	196	return;
	197
497a9230 TP	198	/*
	199	* Add the PL310 property "arm,io-coherent". This makes sure the
	200	* outer sync operation is not used, which allows to
	201	* workaround the system erratum that causes deadlocks when
	202	* doing PCIe in an SMP situation on Armada 375 and Armada
	203	* 38x.
	204	*/
	205	for_each_compatible_node(cache_dn, NULL, "arm,pl310-cache") {
	206	struct property *p;
	207
	208	p = kzalloc(sizeof(*p), GFP_KERNEL);
	209	p->name = kstrdup("arm,io-coherent", GFP_KERNEL);
	210	of_add_property(cache_dn, p);
	211	}
77fa4b9a TP	212	}
77fa4b9a TP	213
501f928e	214	static int coherency_type(void)
009f1315 GC	215	{
009f1315 GC	216	struct device_node *np;
5fbba080	217	const struct of_device_id *match;
e5535545	218	int type;
009f1315	219
e5535545 TP	220	/*
	221	* The coherency fabric is needed:
	222	* - For coherency between processors on Armada XP, so only
	223	* when SMP is enabled.
	224	* - For coherency between the processor and I/O devices, but
	225	* this coherency requires many pre-requisites (write
	226	* allocate cache policy, shareable pages, SMP bit set) that
	227	* are only meant in SMP situations.
	228	*
	229	* Note that this means that on Armada 370, there is currently
	230	* no way to use hardware I/O coherency, because even when
	231	* CONFIG_SMP is enabled, is_smp() returns false due to the
	232	* Armada 370 being a single-core processor. To lift this
	233	* limitation, we would have to find a way to make the cache
	234	* policy set to write-allocate (on all Armada SoCs), and to
	235	* set the shareable attribute in page tables (on all Armada
	236	* SoCs except the Armada 370). Unfortunately, such decisions
	237	* are taken very early in the kernel boot process, at a point
	238	* where we don't know yet on which SoC we are running.
	239
	240	*/
	241	if (!is_smp())
	242	return COHERENCY_FABRIC_TYPE_NONE;
924d38f4	243
e5535545 TP	244	np = of_find_matching_node_and_match(NULL, of_coherency_table, &match);
	245	if (!np)
	246	return COHERENCY_FABRIC_TYPE_NONE;
924d38f4	247
e5535545	248	type = (int) match->data;
77fa4b9a	249
e5535545	250	of_node_put(np);
009f1315	251
e5535545	252	return type;
009f1315	253	}
865e0527	254
01049a5d NH	255	int set_cpu_coherent(void)
	256	{
	257	int type = coherency_type();
	258
	259	if (type == COHERENCY_FABRIC_TYPE_ARMADA_370_XP) {
	260	if (!coherency_base) {
	261	pr_warn("Can't make current CPU cache coherent.\n");
	262	pr_warn("Coherency fabric is not initialized\n");
	263	return 1;
	264	}
d492ccca TP	265
d492ccca TP	266	armada_xp_clear_shared_l2();
01049a5d NH	267	ll_add_cpu_to_smp_group();
	268	return ll_enable_coherency();
	269	}
	270
	271	return 0;
	272	}
	273
501f928e	274	int coherency_available(void)
865e0527	275	{
1bd4d8a6	276	return coherency_type() != COHERENCY_FABRIC_TYPE_NONE;
501f928e TP	277	}
	278
	279	int __init coherency_init(void)
	280	{
	281	int type = coherency_type();
abe511ac JZ	282	struct device_node *np;
	283
	284	np = of_find_matching_node(NULL, of_coherency_table);
501f928e TP	285
	286	if (type == COHERENCY_FABRIC_TYPE_ARMADA_370_XP)
	287	armada_370_coherency_init(np);
d0de9323 TP	288	else if (type == COHERENCY_FABRIC_TYPE_ARMADA_375 \|\|
	289	type == COHERENCY_FABRIC_TYPE_ARMADA_380)
	290	armada_375_380_coherency_init(np);
501f928e	291
2eb04ae0 TP	292	of_node_put(np);
2eb04ae0 TP	293
501f928e TP	294	return 0;
	295	}
	296
	297	static int __init coherency_late_init(void)
	298	{
ef01c6c3 TP	299	if (coherency_available())
	300	bus_register_notifier(&platform_bus_type,
	301	&mvebu_hwcc_nb);
865e0527 TP	302	return 0;
	303	}
	304
	305	postcore_initcall(coherency_late_init);
b0063aad	306
8828ccc3	307	#if IS_ENABLED(CONFIG_PCI)
b0063aad TP	308	static int __init coherency_pci_init(void)
	309	{
	310	if (coherency_available())
	311	bus_register_notifier(&pci_bus_type,
a728b977	312	&mvebu_hwcc_pci_nb);
b0063aad TP	313	return 0;
	314	}
	315
	316	arch_initcall(coherency_pci_init);
8828ccc3	317	#endif