ARM: mvebu: update comments in coherency.c
[firefly-linux-kernel-4.4.55.git] / arch / arm / mach-mvebu / coherency.c
1 /*
2  * Coherency fabric (Aurora) support for Armada 370, 375, 38x and XP
3  * platforms.
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  *
15  * The Armada 370, 375, 38x and XP SOCs have a coherency fabric which is
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
21 #define pr_fmt(fmt) "mvebu-coherency: " fmt
22
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>
28 #include <linux/dma-mapping.h>
29 #include <linux/platform_device.h>
30 #include <linux/slab.h>
31 #include <linux/mbus.h>
32 #include <linux/pci.h>
33 #include <asm/smp_plat.h>
34 #include <asm/cacheflush.h>
35 #include <asm/mach/map.h>
36 #include "armada-370-xp.h"
37 #include "coherency.h"
38 #include "mvebu-soc-id.h"
39
40 unsigned long coherency_phys_base;
41 void __iomem *coherency_base;
42 static void __iomem *coherency_cpu_base;
43
44 /* Coherency fabric registers */
45 #define IO_SYNC_BARRIER_CTL_OFFSET                 0x0
46
47 enum {
48         COHERENCY_FABRIC_TYPE_NONE,
49         COHERENCY_FABRIC_TYPE_ARMADA_370_XP,
50         COHERENCY_FABRIC_TYPE_ARMADA_375,
51         COHERENCY_FABRIC_TYPE_ARMADA_380,
52 };
53
54 static struct of_device_id of_coherency_table[] = {
55         {.compatible = "marvell,coherency-fabric",
56          .data = (void *) COHERENCY_FABRIC_TYPE_ARMADA_370_XP },
57         {.compatible = "marvell,armada-375-coherency-fabric",
58          .data = (void *) COHERENCY_FABRIC_TYPE_ARMADA_375 },
59         {.compatible = "marvell,armada-380-coherency-fabric",
60          .data = (void *) COHERENCY_FABRIC_TYPE_ARMADA_380 },
61         { /* end of list */ },
62 };
63
64 /* Functions defined in coherency_ll.S */
65 int ll_enable_coherency(void);
66 void ll_add_cpu_to_smp_group(void);
67
68 int set_cpu_coherent(void)
69 {
70         if (!coherency_base) {
71                 pr_warn("Can't make current CPU cache coherent.\n");
72                 pr_warn("Coherency fabric is not initialized\n");
73                 return 1;
74         }
75
76         ll_add_cpu_to_smp_group();
77         return ll_enable_coherency();
78 }
79
80 static inline void mvebu_hwcc_sync_io_barrier(void)
81 {
82         writel(0x1, coherency_cpu_base + IO_SYNC_BARRIER_CTL_OFFSET);
83         while (readl(coherency_cpu_base + IO_SYNC_BARRIER_CTL_OFFSET) & 0x1);
84 }
85
86 static dma_addr_t mvebu_hwcc_dma_map_page(struct device *dev, struct page *page,
87                                   unsigned long offset, size_t size,
88                                   enum dma_data_direction dir,
89                                   struct dma_attrs *attrs)
90 {
91         if (dir != DMA_TO_DEVICE)
92                 mvebu_hwcc_sync_io_barrier();
93         return pfn_to_dma(dev, page_to_pfn(page)) + offset;
94 }
95
96
97 static void mvebu_hwcc_dma_unmap_page(struct device *dev, dma_addr_t dma_handle,
98                               size_t size, enum dma_data_direction dir,
99                               struct dma_attrs *attrs)
100 {
101         if (dir != DMA_TO_DEVICE)
102                 mvebu_hwcc_sync_io_barrier();
103 }
104
105 static void mvebu_hwcc_dma_sync(struct device *dev, dma_addr_t dma_handle,
106                         size_t size, enum dma_data_direction dir)
107 {
108         if (dir != DMA_TO_DEVICE)
109                 mvebu_hwcc_sync_io_barrier();
110 }
111
112 static struct dma_map_ops mvebu_hwcc_dma_ops = {
113         .alloc                  = arm_dma_alloc,
114         .free                   = arm_dma_free,
115         .mmap                   = arm_dma_mmap,
116         .map_page               = mvebu_hwcc_dma_map_page,
117         .unmap_page             = mvebu_hwcc_dma_unmap_page,
118         .get_sgtable            = arm_dma_get_sgtable,
119         .map_sg                 = arm_dma_map_sg,
120         .unmap_sg               = arm_dma_unmap_sg,
121         .sync_single_for_cpu    = mvebu_hwcc_dma_sync,
122         .sync_single_for_device = mvebu_hwcc_dma_sync,
123         .sync_sg_for_cpu        = arm_dma_sync_sg_for_cpu,
124         .sync_sg_for_device     = arm_dma_sync_sg_for_device,
125         .set_dma_mask           = arm_dma_set_mask,
126 };
127
128 static int mvebu_hwcc_notifier(struct notifier_block *nb,
129                                unsigned long event, void *__dev)
130 {
131         struct device *dev = __dev;
132
133         if (event != BUS_NOTIFY_ADD_DEVICE)
134                 return NOTIFY_DONE;
135         set_dma_ops(dev, &mvebu_hwcc_dma_ops);
136
137         return NOTIFY_OK;
138 }
139
140 static struct notifier_block mvebu_hwcc_nb = {
141         .notifier_call = mvebu_hwcc_notifier,
142 };
143
144 static struct notifier_block mvebu_hwcc_pci_nb = {
145         .notifier_call = mvebu_hwcc_notifier,
146 };
147
148 static void __init armada_370_coherency_init(struct device_node *np)
149 {
150         struct resource res;
151
152         of_address_to_resource(np, 0, &res);
153         coherency_phys_base = res.start;
154         /*
155          * Ensure secondary CPUs will see the updated value,
156          * which they read before they join the coherency
157          * fabric, and therefore before they are coherent with
158          * the boot CPU cache.
159          */
160         sync_cache_w(&coherency_phys_base);
161         coherency_base = of_iomap(np, 0);
162         coherency_cpu_base = of_iomap(np, 1);
163         set_cpu_coherent();
164 }
165
166 /*
167  * This ioremap hook is used on Armada 375/38x to ensure that PCIe
168  * memory areas are mapped as MT_UNCACHED instead of MT_DEVICE. This
169  * is needed as a workaround for a deadlock issue between the PCIe
170  * interface and the cache controller.
171  */
172 static void __iomem *
173 armada_pcie_wa_ioremap_caller(phys_addr_t phys_addr, size_t size,
174                               unsigned int mtype, void *caller)
175 {
176         struct resource pcie_mem;
177
178         mvebu_mbus_get_pcie_mem_aperture(&pcie_mem);
179
180         if (pcie_mem.start <= phys_addr && (phys_addr + size) <= pcie_mem.end)
181                 mtype = MT_UNCACHED;
182
183         return __arm_ioremap_caller(phys_addr, size, mtype, caller);
184 }
185
186 static void __init armada_375_380_coherency_init(struct device_node *np)
187 {
188         struct device_node *cache_dn;
189
190         coherency_cpu_base = of_iomap(np, 0);
191         arch_ioremap_caller = armada_pcie_wa_ioremap_caller;
192
193         /*
194          * Add the PL310 property "arm,io-coherent". This makes sure the
195          * outer sync operation is not used, which allows to
196          * workaround the system erratum that causes deadlocks when
197          * doing PCIe in an SMP situation on Armada 375 and Armada
198          * 38x.
199          */
200         for_each_compatible_node(cache_dn, NULL, "arm,pl310-cache") {
201                 struct property *p;
202
203                 p = kzalloc(sizeof(*p), GFP_KERNEL);
204                 p->name = kstrdup("arm,io-coherent", GFP_KERNEL);
205                 of_add_property(cache_dn, p);
206         }
207 }
208
209 static int coherency_type(void)
210 {
211         struct device_node *np;
212         const struct of_device_id *match;
213         int type;
214
215         /*
216          * The coherency fabric is needed:
217          * - For coherency between processors on Armada XP, so only
218          *   when SMP is enabled.
219          * - For coherency between the processor and I/O devices, but
220          *   this coherency requires many pre-requisites (write
221          *   allocate cache policy, shareable pages, SMP bit set) that
222          *   are only meant in SMP situations.
223          *
224          * Note that this means that on Armada 370, there is currently
225          * no way to use hardware I/O coherency, because even when
226          * CONFIG_SMP is enabled, is_smp() returns false due to the
227          * Armada 370 being a single-core processor. To lift this
228          * limitation, we would have to find a way to make the cache
229          * policy set to write-allocate (on all Armada SoCs), and to
230          * set the shareable attribute in page tables (on all Armada
231          * SoCs except the Armada 370). Unfortunately, such decisions
232          * are taken very early in the kernel boot process, at a point
233          * where we don't know yet on which SoC we are running.
234
235          */
236         if (!is_smp())
237                 return COHERENCY_FABRIC_TYPE_NONE;
238
239         np = of_find_matching_node_and_match(NULL, of_coherency_table, &match);
240         if (!np)
241                 return COHERENCY_FABRIC_TYPE_NONE;
242
243         type = (int) match->data;
244
245         of_node_put(np);
246
247         return type;
248 }
249
250 int coherency_available(void)
251 {
252         return coherency_type() != COHERENCY_FABRIC_TYPE_NONE;
253 }
254
255 int __init coherency_init(void)
256 {
257         int type = coherency_type();
258         struct device_node *np;
259
260         np = of_find_matching_node(NULL, of_coherency_table);
261
262         if (type == COHERENCY_FABRIC_TYPE_ARMADA_370_XP)
263                 armada_370_coherency_init(np);
264         else if (type == COHERENCY_FABRIC_TYPE_ARMADA_375 ||
265                  type == COHERENCY_FABRIC_TYPE_ARMADA_380)
266                 armada_375_380_coherency_init(np);
267
268         of_node_put(np);
269
270         return 0;
271 }
272
273 static int __init coherency_late_init(void)
274 {
275         if (coherency_available())
276                 bus_register_notifier(&platform_bus_type,
277                                       &mvebu_hwcc_nb);
278         return 0;
279 }
280
281 postcore_initcall(coherency_late_init);
282
283 #if IS_ENABLED(CONFIG_PCI)
284 static int __init coherency_pci_init(void)
285 {
286         if (coherency_available())
287                 bus_register_notifier(&pci_bus_type,
288                                        &mvebu_hwcc_pci_nb);
289         return 0;
290 }
291
292 arch_initcall(coherency_pci_init);
293 #endif