blob: 017532193fb1c009b83801b27172f8210988f074 [file] [log] [blame]
Dan Williams92281dee2015-08-10 23:07:06 -04001/*
2 * Copyright(c) 2015 Intel Corporation. All rights reserved.
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but
9 * WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
12 */
Dan Williams9476df72016-01-15 16:56:19 -080013#include <linux/radix-tree.h>
14#include <linux/memremap.h>
Christoph Hellwig7d3dcf22015-08-10 23:07:07 -040015#include <linux/device.h>
Dan Williams92281dee2015-08-10 23:07:06 -040016#include <linux/types.h>
Dan Williams34c0fd52016-01-15 16:56:14 -080017#include <linux/pfn_t.h>
Dan Williams92281dee2015-08-10 23:07:06 -040018#include <linux/io.h>
19#include <linux/mm.h>
Christoph Hellwig41e94a82015-08-17 16:00:35 +020020#include <linux/memory_hotplug.h>
Dan Williams92281dee2015-08-10 23:07:06 -040021
22#ifndef ioremap_cache
23/* temporary while we convert existing ioremap_cache users to memremap */
24__weak void __iomem *ioremap_cache(resource_size_t offset, unsigned long size)
25{
26 return ioremap(offset, size);
27}
28#endif
29
Ard Biesheuvelc269cba2016-02-22 15:02:07 +010030#ifndef arch_memremap_wb
31static void *arch_memremap_wb(resource_size_t offset, unsigned long size)
32{
33 return (__force void *)ioremap_cache(offset, size);
34}
35#endif
36
Dan Williams182475b2015-10-26 16:55:56 -040037static void *try_ram_remap(resource_size_t offset, size_t size)
38{
Ard Biesheuvelac343e82016-03-09 14:08:32 -080039 unsigned long pfn = PHYS_PFN(offset);
Dan Williams182475b2015-10-26 16:55:56 -040040
41 /* In the simple case just return the existing linear address */
Ard Biesheuvelac343e82016-03-09 14:08:32 -080042 if (pfn_valid(pfn) && !PageHighMem(pfn_to_page(pfn)))
Dan Williams182475b2015-10-26 16:55:56 -040043 return __va(offset);
Ard Biesheuvelc269cba2016-02-22 15:02:07 +010044 return NULL; /* fallback to arch_memremap_wb */
Dan Williams182475b2015-10-26 16:55:56 -040045}
46
Dan Williams92281dee2015-08-10 23:07:06 -040047/**
48 * memremap() - remap an iomem_resource as cacheable memory
49 * @offset: iomem resource start address
50 * @size: size of remap
Brian Starkeyc907e0e2016-03-22 14:28:00 -070051 * @flags: any of MEMREMAP_WB, MEMREMAP_WT and MEMREMAP_WC
Dan Williams92281dee2015-08-10 23:07:06 -040052 *
53 * memremap() is "ioremap" for cases where it is known that the resource
54 * being mapped does not have i/o side effects and the __iomem
Brian Starkeyc907e0e2016-03-22 14:28:00 -070055 * annotation is not applicable. In the case of multiple flags, the different
56 * mapping types will be attempted in the order listed below until one of
57 * them succeeds.
Dan Williams92281dee2015-08-10 23:07:06 -040058 *
Toshi Kani1c29f252016-01-26 21:57:28 +010059 * MEMREMAP_WB - matches the default mapping for System RAM on
Dan Williams92281dee2015-08-10 23:07:06 -040060 * the architecture. This is usually a read-allocate write-back cache.
61 * Morever, if MEMREMAP_WB is specified and the requested remap region is RAM
62 * memremap() will bypass establishing a new mapping and instead return
63 * a pointer into the direct map.
64 *
65 * MEMREMAP_WT - establish a mapping whereby writes either bypass the
66 * cache or are written through to memory and never exist in a
67 * cache-dirty state with respect to program visibility. Attempts to
Toshi Kani1c29f252016-01-26 21:57:28 +010068 * map System RAM with this mapping type will fail.
Brian Starkeyc907e0e2016-03-22 14:28:00 -070069 *
70 * MEMREMAP_WC - establish a writecombine mapping, whereby writes may
71 * be coalesced together (e.g. in the CPU's write buffers), but is otherwise
72 * uncached. Attempts to map System RAM with this mapping type will fail.
Dan Williams92281dee2015-08-10 23:07:06 -040073 */
74void *memremap(resource_size_t offset, size_t size, unsigned long flags)
75{
Toshi Kani1c29f252016-01-26 21:57:28 +010076 int is_ram = region_intersects(offset, size,
77 IORESOURCE_SYSTEM_RAM, IORES_DESC_NONE);
Dan Williams92281dee2015-08-10 23:07:06 -040078 void *addr = NULL;
79
Brian Starkeycf61e2a2016-03-22 14:27:57 -070080 if (!flags)
81 return NULL;
82
Dan Williams92281dee2015-08-10 23:07:06 -040083 if (is_ram == REGION_MIXED) {
84 WARN_ONCE(1, "memremap attempted on mixed range %pa size: %#lx\n",
85 &offset, (unsigned long) size);
86 return NULL;
87 }
88
89 /* Try all mapping types requested until one returns non-NULL */
90 if (flags & MEMREMAP_WB) {
Dan Williams92281dee2015-08-10 23:07:06 -040091 /*
92 * MEMREMAP_WB is special in that it can be satisifed
93 * from the direct map. Some archs depend on the
94 * capability of memremap() to autodetect cases where
Toshi Kani1c29f252016-01-26 21:57:28 +010095 * the requested range is potentially in System RAM.
Dan Williams92281dee2015-08-10 23:07:06 -040096 */
97 if (is_ram == REGION_INTERSECTS)
Dan Williams182475b2015-10-26 16:55:56 -040098 addr = try_ram_remap(offset, size);
99 if (!addr)
Ard Biesheuvelc269cba2016-02-22 15:02:07 +0100100 addr = arch_memremap_wb(offset, size);
Dan Williams92281dee2015-08-10 23:07:06 -0400101 }
102
103 /*
Brian Starkeycf61e2a2016-03-22 14:27:57 -0700104 * If we don't have a mapping yet and other request flags are
105 * present then we will be attempting to establish a new virtual
Dan Williams92281dee2015-08-10 23:07:06 -0400106 * address mapping. Enforce that this mapping is not aliasing
Toshi Kani1c29f252016-01-26 21:57:28 +0100107 * System RAM.
Dan Williams92281dee2015-08-10 23:07:06 -0400108 */
Brian Starkeycf61e2a2016-03-22 14:27:57 -0700109 if (!addr && is_ram == REGION_INTERSECTS && flags != MEMREMAP_WB) {
Dan Williams92281dee2015-08-10 23:07:06 -0400110 WARN_ONCE(1, "memremap attempted on ram %pa size: %#lx\n",
111 &offset, (unsigned long) size);
112 return NULL;
113 }
114
Brian Starkeycf61e2a2016-03-22 14:27:57 -0700115 if (!addr && (flags & MEMREMAP_WT))
Dan Williams92281dee2015-08-10 23:07:06 -0400116 addr = ioremap_wt(offset, size);
Dan Williams92281dee2015-08-10 23:07:06 -0400117
Brian Starkeyc907e0e2016-03-22 14:28:00 -0700118 if (!addr && (flags & MEMREMAP_WC))
119 addr = ioremap_wc(offset, size);
120
Dan Williams92281dee2015-08-10 23:07:06 -0400121 return addr;
122}
123EXPORT_SYMBOL(memremap);
124
125void memunmap(void *addr)
126{
127 if (is_vmalloc_addr(addr))
128 iounmap((void __iomem *) addr);
129}
130EXPORT_SYMBOL(memunmap);
Christoph Hellwig7d3dcf22015-08-10 23:07:07 -0400131
132static void devm_memremap_release(struct device *dev, void *res)
133{
Toshi Kani9273a8b2016-02-17 13:11:29 -0800134 memunmap(*(void **)res);
Christoph Hellwig7d3dcf22015-08-10 23:07:07 -0400135}
136
137static int devm_memremap_match(struct device *dev, void *res, void *match_data)
138{
139 return *(void **)res == match_data;
140}
141
142void *devm_memremap(struct device *dev, resource_size_t offset,
143 size_t size, unsigned long flags)
144{
145 void **ptr, *addr;
146
Dan Williams538ea4a2015-10-05 20:35:56 -0400147 ptr = devres_alloc_node(devm_memremap_release, sizeof(*ptr), GFP_KERNEL,
148 dev_to_node(dev));
Christoph Hellwig7d3dcf22015-08-10 23:07:07 -0400149 if (!ptr)
Dan Williamsb36f4762015-09-15 02:42:20 -0400150 return ERR_PTR(-ENOMEM);
Christoph Hellwig7d3dcf22015-08-10 23:07:07 -0400151
152 addr = memremap(offset, size, flags);
153 if (addr) {
154 *ptr = addr;
155 devres_add(dev, ptr);
Toshi Kani93f834d2016-02-20 14:32:24 -0800156 } else {
Christoph Hellwig7d3dcf22015-08-10 23:07:07 -0400157 devres_free(ptr);
Toshi Kani93f834d2016-02-20 14:32:24 -0800158 return ERR_PTR(-ENXIO);
159 }
Christoph Hellwig7d3dcf22015-08-10 23:07:07 -0400160
161 return addr;
162}
163EXPORT_SYMBOL(devm_memremap);
164
165void devm_memunmap(struct device *dev, void *addr)
166{
Dan Williamsd7413142015-09-15 02:37:48 -0400167 WARN_ON(devres_release(dev, devm_memremap_release,
168 devm_memremap_match, addr));
Christoph Hellwig7d3dcf22015-08-10 23:07:07 -0400169}
170EXPORT_SYMBOL(devm_memunmap);
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200171
Dan Williamsdb78c222016-02-11 16:13:17 -0800172pfn_t phys_to_pfn_t(phys_addr_t addr, u64 flags)
Dan Williams34c0fd52016-01-15 16:56:14 -0800173{
174 return __pfn_to_pfn_t(addr >> PAGE_SHIFT, flags);
175}
176EXPORT_SYMBOL(phys_to_pfn_t);
177
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200178#ifdef CONFIG_ZONE_DEVICE
Dan Williams9476df72016-01-15 16:56:19 -0800179static DEFINE_MUTEX(pgmap_lock);
180static RADIX_TREE(pgmap_radix, GFP_KERNEL);
181#define SECTION_MASK ~((1UL << PA_SECTION_SHIFT) - 1)
182#define SECTION_SIZE (1UL << PA_SECTION_SHIFT)
183
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200184struct page_map {
185 struct resource res;
Dan Williams9476df72016-01-15 16:56:19 -0800186 struct percpu_ref *ref;
187 struct dev_pagemap pgmap;
Dan Williams4b94ffd2016-01-15 16:56:22 -0800188 struct vmem_altmap altmap;
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200189};
190
Dan Williams3565fce2016-01-15 16:56:55 -0800191void get_zone_device_page(struct page *page)
192{
193 percpu_ref_get(page->pgmap->ref);
194}
195EXPORT_SYMBOL(get_zone_device_page);
196
197void put_zone_device_page(struct page *page)
198{
199 put_dev_pagemap(page->pgmap);
200}
201EXPORT_SYMBOL(put_zone_device_page);
202
Dan Williams9476df72016-01-15 16:56:19 -0800203static void pgmap_radix_release(struct resource *res)
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200204{
Dan Williamseb7d78c2016-01-29 21:48:34 -0800205 resource_size_t key, align_start, align_size, align_end;
206
207 align_start = res->start & ~(SECTION_SIZE - 1);
208 align_size = ALIGN(resource_size(res), SECTION_SIZE);
209 align_end = align_start + align_size - 1;
Dan Williams9476df72016-01-15 16:56:19 -0800210
211 mutex_lock(&pgmap_lock);
212 for (key = res->start; key <= res->end; key += SECTION_SIZE)
213 radix_tree_delete(&pgmap_radix, key >> PA_SECTION_SHIFT);
214 mutex_unlock(&pgmap_lock);
215}
216
Dan Williams5c2c2582016-01-15 16:56:49 -0800217static unsigned long pfn_first(struct page_map *page_map)
218{
219 struct dev_pagemap *pgmap = &page_map->pgmap;
220 const struct resource *res = &page_map->res;
221 struct vmem_altmap *altmap = pgmap->altmap;
222 unsigned long pfn;
223
224 pfn = res->start >> PAGE_SHIFT;
225 if (altmap)
226 pfn += vmem_altmap_offset(altmap);
227 return pfn;
228}
229
230static unsigned long pfn_end(struct page_map *page_map)
231{
232 const struct resource *res = &page_map->res;
233
234 return (res->start + resource_size(res)) >> PAGE_SHIFT;
235}
236
237#define for_each_device_pfn(pfn, map) \
238 for (pfn = pfn_first(map); pfn < pfn_end(map); pfn++)
239
Dan Williams9476df72016-01-15 16:56:19 -0800240static void devm_memremap_pages_release(struct device *dev, void *data)
241{
242 struct page_map *page_map = data;
243 struct resource *res = &page_map->res;
244 resource_size_t align_start, align_size;
Dan Williams4b94ffd2016-01-15 16:56:22 -0800245 struct dev_pagemap *pgmap = &page_map->pgmap;
Dan Williams9476df72016-01-15 16:56:19 -0800246
Dan Williams5c2c2582016-01-15 16:56:49 -0800247 if (percpu_ref_tryget_live(pgmap->ref)) {
248 dev_WARN(dev, "%s: page mapping is still live!\n", __func__);
249 percpu_ref_put(pgmap->ref);
250 }
251
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200252 /* pages are dead and unused, undo the arch mapping */
Dan Williams9476df72016-01-15 16:56:19 -0800253 align_start = res->start & ~(SECTION_SIZE - 1);
254 align_size = ALIGN(resource_size(res), SECTION_SIZE);
255 arch_remove_memory(align_start, align_size);
Dan Williamseb7d78c2016-01-29 21:48:34 -0800256 pgmap_radix_release(res);
Dan Williams4b94ffd2016-01-15 16:56:22 -0800257 dev_WARN_ONCE(dev, pgmap->altmap && pgmap->altmap->alloc,
258 "%s: failed to free all reserved pages\n", __func__);
Dan Williams9476df72016-01-15 16:56:19 -0800259}
260
261/* assumes rcu_read_lock() held at entry */
262struct dev_pagemap *find_dev_pagemap(resource_size_t phys)
263{
264 struct page_map *page_map;
265
266 WARN_ON_ONCE(!rcu_read_lock_held());
267
268 page_map = radix_tree_lookup(&pgmap_radix, phys >> PA_SECTION_SHIFT);
269 return page_map ? &page_map->pgmap : NULL;
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200270}
271
Dan Williams4b94ffd2016-01-15 16:56:22 -0800272/**
273 * devm_memremap_pages - remap and provide memmap backing for the given resource
274 * @dev: hosting device for @res
275 * @res: "host memory" address range
Dan Williams5c2c2582016-01-15 16:56:49 -0800276 * @ref: a live per-cpu reference count
Dan Williams4b94ffd2016-01-15 16:56:22 -0800277 * @altmap: optional descriptor for allocating the memmap from @res
278 *
Dan Williams5c2c2582016-01-15 16:56:49 -0800279 * Notes:
280 * 1/ @ref must be 'live' on entry and 'dead' before devm_memunmap_pages() time
281 * (or devm release event).
282 *
283 * 2/ @res is expected to be a host memory range that could feasibly be
284 * treated as a "System RAM" range, i.e. not a device mmio range, but
285 * this is not enforced.
Dan Williams4b94ffd2016-01-15 16:56:22 -0800286 */
287void *devm_memremap_pages(struct device *dev, struct resource *res,
Dan Williams5c2c2582016-01-15 16:56:49 -0800288 struct percpu_ref *ref, struct vmem_altmap *altmap)
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200289{
Dan Williamseb7d78c2016-01-29 21:48:34 -0800290 resource_size_t key, align_start, align_size, align_end;
Dan Williams4b94ffd2016-01-15 16:56:22 -0800291 struct dev_pagemap *pgmap;
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200292 struct page_map *page_map;
Dan Williams5f29a772016-03-09 14:08:13 -0800293 int error, nid, is_ram;
Dan Williams5c2c2582016-01-15 16:56:49 -0800294 unsigned long pfn;
Dan Williams5f29a772016-03-09 14:08:13 -0800295
296 align_start = res->start & ~(SECTION_SIZE - 1);
297 align_size = ALIGN(res->start + resource_size(res), SECTION_SIZE)
298 - align_start;
Linus Torvaldsd37a14bb2016-03-14 15:15:51 -0700299 is_ram = region_intersects(align_start, align_size,
300 IORESOURCE_SYSTEM_RAM, IORES_DESC_NONE);
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200301
302 if (is_ram == REGION_MIXED) {
303 WARN_ONCE(1, "%s attempted on mixed region %pr\n",
304 __func__, res);
305 return ERR_PTR(-ENXIO);
306 }
307
308 if (is_ram == REGION_INTERSECTS)
309 return __va(res->start);
310
Dan Williams4b94ffd2016-01-15 16:56:22 -0800311 if (altmap && !IS_ENABLED(CONFIG_SPARSEMEM_VMEMMAP)) {
312 dev_err(dev, "%s: altmap requires CONFIG_SPARSEMEM_VMEMMAP=y\n",
313 __func__);
314 return ERR_PTR(-ENXIO);
315 }
316
Dan Williams5c2c2582016-01-15 16:56:49 -0800317 if (!ref)
318 return ERR_PTR(-EINVAL);
319
Dan Williams538ea4a2015-10-05 20:35:56 -0400320 page_map = devres_alloc_node(devm_memremap_pages_release,
321 sizeof(*page_map), GFP_KERNEL, dev_to_node(dev));
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200322 if (!page_map)
323 return ERR_PTR(-ENOMEM);
Dan Williams4b94ffd2016-01-15 16:56:22 -0800324 pgmap = &page_map->pgmap;
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200325
326 memcpy(&page_map->res, res, sizeof(*res));
327
Dan Williams4b94ffd2016-01-15 16:56:22 -0800328 pgmap->dev = dev;
329 if (altmap) {
330 memcpy(&page_map->altmap, altmap, sizeof(*altmap));
331 pgmap->altmap = &page_map->altmap;
332 }
Dan Williams5c2c2582016-01-15 16:56:49 -0800333 pgmap->ref = ref;
Dan Williams4b94ffd2016-01-15 16:56:22 -0800334 pgmap->res = &page_map->res;
335
Dan Williams9476df72016-01-15 16:56:19 -0800336 mutex_lock(&pgmap_lock);
337 error = 0;
Dan Williamseb7d78c2016-01-29 21:48:34 -0800338 align_end = align_start + align_size - 1;
339 for (key = align_start; key <= align_end; key += SECTION_SIZE) {
Dan Williams9476df72016-01-15 16:56:19 -0800340 struct dev_pagemap *dup;
341
342 rcu_read_lock();
343 dup = find_dev_pagemap(key);
344 rcu_read_unlock();
345 if (dup) {
346 dev_err(dev, "%s: %pr collides with mapping for %s\n",
347 __func__, res, dev_name(dup->dev));
348 error = -EBUSY;
349 break;
350 }
351 error = radix_tree_insert(&pgmap_radix, key >> PA_SECTION_SHIFT,
352 page_map);
353 if (error) {
354 dev_err(dev, "%s: failed: %d\n", __func__, error);
355 break;
356 }
357 }
358 mutex_unlock(&pgmap_lock);
359 if (error)
360 goto err_radix;
361
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200362 nid = dev_to_node(dev);
363 if (nid < 0)
Dan Williams7eff93b2015-10-05 20:35:55 -0400364 nid = numa_mem_id();
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200365
Dan Williams9476df72016-01-15 16:56:19 -0800366 error = arch_add_memory(nid, align_start, align_size, true);
367 if (error)
368 goto err_add_memory;
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200369
Dan Williams5c2c2582016-01-15 16:56:49 -0800370 for_each_device_pfn(pfn, page_map) {
371 struct page *page = pfn_to_page(pfn);
372
Dan Williamsd77a1172016-03-09 14:08:10 -0800373 /*
374 * ZONE_DEVICE pages union ->lru with a ->pgmap back
375 * pointer. It is a bug if a ZONE_DEVICE page is ever
376 * freed or placed on a driver-private list. Seed the
377 * storage with LIST_POISON* values.
378 */
379 list_del(&page->lru);
Dan Williams5c2c2582016-01-15 16:56:49 -0800380 page->pgmap = pgmap;
381 }
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200382 devres_add(dev, page_map);
383 return __va(res->start);
Dan Williams9476df72016-01-15 16:56:19 -0800384
385 err_add_memory:
386 err_radix:
387 pgmap_radix_release(res);
388 devres_free(page_map);
389 return ERR_PTR(error);
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200390}
391EXPORT_SYMBOL(devm_memremap_pages);
Dan Williams4b94ffd2016-01-15 16:56:22 -0800392
393unsigned long vmem_altmap_offset(struct vmem_altmap *altmap)
394{
395 /* number of pfns from base where pfn_to_page() is valid */
396 return altmap->reserve + altmap->free;
397}
398
399void vmem_altmap_free(struct vmem_altmap *altmap, unsigned long nr_pfns)
400{
401 altmap->alloc -= nr_pfns;
402}
403
404#ifdef CONFIG_SPARSEMEM_VMEMMAP
405struct vmem_altmap *to_vmem_altmap(unsigned long memmap_start)
406{
407 /*
408 * 'memmap_start' is the virtual address for the first "struct
409 * page" in this range of the vmemmap array. In the case of
Andreas Ziegler07061aa2016-03-15 14:55:33 -0700410 * CONFIG_SPARSEMEM_VMEMMAP a page_to_pfn conversion is simple
Dan Williams4b94ffd2016-01-15 16:56:22 -0800411 * pointer arithmetic, so we can perform this to_vmem_altmap()
412 * conversion without concern for the initialization state of
413 * the struct page fields.
414 */
415 struct page *page = (struct page *) memmap_start;
416 struct dev_pagemap *pgmap;
417
418 /*
Andreas Ziegler07061aa2016-03-15 14:55:33 -0700419 * Unconditionally retrieve a dev_pagemap associated with the
Dan Williams4b94ffd2016-01-15 16:56:22 -0800420 * given physical address, this is only for use in the
421 * arch_{add|remove}_memory() for setting up and tearing down
422 * the memmap.
423 */
424 rcu_read_lock();
425 pgmap = find_dev_pagemap(__pfn_to_phys(page_to_pfn(page)));
426 rcu_read_unlock();
427
428 return pgmap ? pgmap->altmap : NULL;
429}
430#endif /* CONFIG_SPARSEMEM_VMEMMAP */
Christoph Hellwig41e94a82015-08-17 16:00:35 +0200431#endif /* CONFIG_ZONE_DEVICE */