xref: /openbmc/linux/kernel/dma/pool.c (revision 54adadf9b08571fb8b11dc9d0d3a2ddd39825efd)
1e860c299SDavid Rientjes // SPDX-License-Identifier: GPL-2.0
2e860c299SDavid Rientjes /*
3e860c299SDavid Rientjes  * Copyright (C) 2012 ARM Ltd.
4e860c299SDavid Rientjes  * Copyright (C) 2020 Google LLC
5e860c299SDavid Rientjes  */
6e860c299SDavid Rientjes #include <linux/dma-direct.h>
7e860c299SDavid Rientjes #include <linux/dma-noncoherent.h>
8e860c299SDavid Rientjes #include <linux/dma-contiguous.h>
9e860c299SDavid Rientjes #include <linux/init.h>
10e860c299SDavid Rientjes #include <linux/genalloc.h>
11e860c299SDavid Rientjes #include <linux/slab.h>
12*54adadf9SDavid Rientjes #include <linux/workqueue.h>
13e860c299SDavid Rientjes 
14c84dc6e6SDavid Rientjes static struct gen_pool *atomic_pool_dma __ro_after_init;
15c84dc6e6SDavid Rientjes static struct gen_pool *atomic_pool_dma32 __ro_after_init;
16c84dc6e6SDavid Rientjes static struct gen_pool *atomic_pool_kernel __ro_after_init;
17e860c299SDavid Rientjes 
18e860c299SDavid Rientjes #define DEFAULT_DMA_COHERENT_POOL_SIZE  SZ_256K
19*54adadf9SDavid Rientjes static size_t atomic_pool_size = DEFAULT_DMA_COHERENT_POOL_SIZE;
20*54adadf9SDavid Rientjes 
21*54adadf9SDavid Rientjes /* Dynamic background expansion when the atomic pool is near capacity */
22*54adadf9SDavid Rientjes static struct work_struct atomic_pool_work;
23e860c299SDavid Rientjes 
24e860c299SDavid Rientjes static int __init early_coherent_pool(char *p)
25e860c299SDavid Rientjes {
26e860c299SDavid Rientjes 	atomic_pool_size = memparse(p, &p);
27e860c299SDavid Rientjes 	return 0;
28e860c299SDavid Rientjes }
29e860c299SDavid Rientjes early_param("coherent_pool", early_coherent_pool);
30e860c299SDavid Rientjes 
31*54adadf9SDavid Rientjes static int atomic_pool_expand(struct gen_pool *pool, size_t pool_size,
32*54adadf9SDavid Rientjes 			      gfp_t gfp)
33e860c299SDavid Rientjes {
34*54adadf9SDavid Rientjes 	unsigned int order;
35e860c299SDavid Rientjes 	struct page *page;
36e860c299SDavid Rientjes 	void *addr;
37*54adadf9SDavid Rientjes 	int ret = -ENOMEM;
38*54adadf9SDavid Rientjes 
39*54adadf9SDavid Rientjes 	/* Cannot allocate larger than MAX_ORDER-1 */
40*54adadf9SDavid Rientjes 	order = min(get_order(pool_size), MAX_ORDER-1);
41*54adadf9SDavid Rientjes 
42*54adadf9SDavid Rientjes 	do {
43*54adadf9SDavid Rientjes 		pool_size = 1 << (PAGE_SHIFT + order);
44e860c299SDavid Rientjes 
45e860c299SDavid Rientjes 		if (dev_get_cma_area(NULL))
46*54adadf9SDavid Rientjes 			page = dma_alloc_from_contiguous(NULL, 1 << order,
47*54adadf9SDavid Rientjes 							 order, false);
48e860c299SDavid Rientjes 		else
49c84dc6e6SDavid Rientjes 			page = alloc_pages(gfp, order);
50*54adadf9SDavid Rientjes 	} while (!page && order-- > 0);
51e860c299SDavid Rientjes 	if (!page)
52e860c299SDavid Rientjes 		goto out;
53e860c299SDavid Rientjes 
54c84dc6e6SDavid Rientjes 	arch_dma_prep_coherent(page, pool_size);
55e860c299SDavid Rientjes 
56c84dc6e6SDavid Rientjes 	addr = dma_common_contiguous_remap(page, pool_size,
57e860c299SDavid Rientjes 					   pgprot_dmacoherent(PAGE_KERNEL),
58e860c299SDavid Rientjes 					   __builtin_return_address(0));
59e860c299SDavid Rientjes 	if (!addr)
60*54adadf9SDavid Rientjes 		goto free_page;
61e860c299SDavid Rientjes 
62*54adadf9SDavid Rientjes 	ret = gen_pool_add_virt(pool, (unsigned long)addr, page_to_phys(page),
63*54adadf9SDavid Rientjes 				pool_size, NUMA_NO_NODE);
64e860c299SDavid Rientjes 	if (ret)
65e860c299SDavid Rientjes 		goto remove_mapping;
66e860c299SDavid Rientjes 
67e860c299SDavid Rientjes 	return 0;
68e860c299SDavid Rientjes 
69e860c299SDavid Rientjes remove_mapping:
70c84dc6e6SDavid Rientjes 	dma_common_free_remap(addr, pool_size);
71e860c299SDavid Rientjes free_page:
72*54adadf9SDavid Rientjes 	if (!dma_release_from_contiguous(NULL, page, 1 << order))
73c84dc6e6SDavid Rientjes 		__free_pages(page, order);
74e860c299SDavid Rientjes out:
75*54adadf9SDavid Rientjes 	return ret;
76*54adadf9SDavid Rientjes }
77*54adadf9SDavid Rientjes 
78*54adadf9SDavid Rientjes static void atomic_pool_resize(struct gen_pool *pool, gfp_t gfp)
79*54adadf9SDavid Rientjes {
80*54adadf9SDavid Rientjes 	if (pool && gen_pool_avail(pool) < atomic_pool_size)
81*54adadf9SDavid Rientjes 		atomic_pool_expand(pool, gen_pool_size(pool), gfp);
82*54adadf9SDavid Rientjes }
83*54adadf9SDavid Rientjes 
84*54adadf9SDavid Rientjes static void atomic_pool_work_fn(struct work_struct *work)
85*54adadf9SDavid Rientjes {
86*54adadf9SDavid Rientjes 	if (IS_ENABLED(CONFIG_ZONE_DMA))
87*54adadf9SDavid Rientjes 		atomic_pool_resize(atomic_pool_dma,
88*54adadf9SDavid Rientjes 				   GFP_KERNEL | GFP_DMA);
89*54adadf9SDavid Rientjes 	if (IS_ENABLED(CONFIG_ZONE_DMA32))
90*54adadf9SDavid Rientjes 		atomic_pool_resize(atomic_pool_dma32,
91*54adadf9SDavid Rientjes 				   GFP_KERNEL | GFP_DMA32);
92*54adadf9SDavid Rientjes 	atomic_pool_resize(atomic_pool_kernel, GFP_KERNEL);
93*54adadf9SDavid Rientjes }
94*54adadf9SDavid Rientjes 
95*54adadf9SDavid Rientjes static __init struct gen_pool *__dma_atomic_pool_init(size_t pool_size,
96*54adadf9SDavid Rientjes 						      gfp_t gfp)
97*54adadf9SDavid Rientjes {
98*54adadf9SDavid Rientjes 	struct gen_pool *pool;
99*54adadf9SDavid Rientjes 	int ret;
100*54adadf9SDavid Rientjes 
101*54adadf9SDavid Rientjes 	pool = gen_pool_create(PAGE_SHIFT, NUMA_NO_NODE);
102*54adadf9SDavid Rientjes 	if (!pool)
103*54adadf9SDavid Rientjes 		return NULL;
104*54adadf9SDavid Rientjes 
105*54adadf9SDavid Rientjes 	gen_pool_set_algo(pool, gen_pool_first_fit_order_align, NULL);
106*54adadf9SDavid Rientjes 
107*54adadf9SDavid Rientjes 	ret = atomic_pool_expand(pool, pool_size, gfp);
108*54adadf9SDavid Rientjes 	if (ret) {
109*54adadf9SDavid Rientjes 		gen_pool_destroy(pool);
110c84dc6e6SDavid Rientjes 		pr_err("DMA: failed to allocate %zu KiB %pGg pool for atomic allocation\n",
111c84dc6e6SDavid Rientjes 		       pool_size >> 10, &gfp);
112*54adadf9SDavid Rientjes 		return NULL;
113*54adadf9SDavid Rientjes 	}
114*54adadf9SDavid Rientjes 
115*54adadf9SDavid Rientjes 	pr_info("DMA: preallocated %zu KiB %pGg pool for atomic allocations\n",
116*54adadf9SDavid Rientjes 		gen_pool_size(pool) >> 10, &gfp);
117*54adadf9SDavid Rientjes 	return pool;
118e860c299SDavid Rientjes }
119c84dc6e6SDavid Rientjes 
120c84dc6e6SDavid Rientjes static int __init dma_atomic_pool_init(void)
121c84dc6e6SDavid Rientjes {
122c84dc6e6SDavid Rientjes 	int ret = 0;
123c84dc6e6SDavid Rientjes 
124*54adadf9SDavid Rientjes 	INIT_WORK(&atomic_pool_work, atomic_pool_work_fn);
125*54adadf9SDavid Rientjes 
126*54adadf9SDavid Rientjes 	atomic_pool_kernel = __dma_atomic_pool_init(atomic_pool_size,
127c84dc6e6SDavid Rientjes 						    GFP_KERNEL);
128*54adadf9SDavid Rientjes 	if (!atomic_pool_kernel)
129*54adadf9SDavid Rientjes 		ret = -ENOMEM;
130c84dc6e6SDavid Rientjes 	if (IS_ENABLED(CONFIG_ZONE_DMA)) {
131*54adadf9SDavid Rientjes 		atomic_pool_dma = __dma_atomic_pool_init(atomic_pool_size,
132*54adadf9SDavid Rientjes 						GFP_KERNEL | GFP_DMA);
133*54adadf9SDavid Rientjes 		if (!atomic_pool_dma)
134*54adadf9SDavid Rientjes 			ret = -ENOMEM;
135c84dc6e6SDavid Rientjes 	}
136c84dc6e6SDavid Rientjes 	if (IS_ENABLED(CONFIG_ZONE_DMA32)) {
137*54adadf9SDavid Rientjes 		atomic_pool_dma32 = __dma_atomic_pool_init(atomic_pool_size,
138*54adadf9SDavid Rientjes 						GFP_KERNEL | GFP_DMA32);
139*54adadf9SDavid Rientjes 		if (!atomic_pool_dma32)
140*54adadf9SDavid Rientjes 			ret = -ENOMEM;
141c84dc6e6SDavid Rientjes 	}
142c84dc6e6SDavid Rientjes 	return ret;
143c84dc6e6SDavid Rientjes }
144e860c299SDavid Rientjes postcore_initcall(dma_atomic_pool_init);
145e860c299SDavid Rientjes 
146c84dc6e6SDavid Rientjes static inline struct gen_pool *dev_to_pool(struct device *dev)
147e860c299SDavid Rientjes {
148c84dc6e6SDavid Rientjes 	u64 phys_mask;
149c84dc6e6SDavid Rientjes 	gfp_t gfp;
150e860c299SDavid Rientjes 
151c84dc6e6SDavid Rientjes 	gfp = dma_direct_optimal_gfp_mask(dev, dev->coherent_dma_mask,
152c84dc6e6SDavid Rientjes 					  &phys_mask);
153c84dc6e6SDavid Rientjes 	if (IS_ENABLED(CONFIG_ZONE_DMA) && gfp == GFP_DMA)
154c84dc6e6SDavid Rientjes 		return atomic_pool_dma;
155c84dc6e6SDavid Rientjes 	if (IS_ENABLED(CONFIG_ZONE_DMA32) && gfp == GFP_DMA32)
156c84dc6e6SDavid Rientjes 		return atomic_pool_dma32;
157c84dc6e6SDavid Rientjes 	return atomic_pool_kernel;
158e860c299SDavid Rientjes }
159e860c299SDavid Rientjes 
160c84dc6e6SDavid Rientjes static bool dma_in_atomic_pool(struct device *dev, void *start, size_t size)
161e860c299SDavid Rientjes {
162c84dc6e6SDavid Rientjes 	struct gen_pool *pool = dev_to_pool(dev);
163c84dc6e6SDavid Rientjes 
164c84dc6e6SDavid Rientjes 	if (unlikely(!pool))
165c84dc6e6SDavid Rientjes 		return false;
166c84dc6e6SDavid Rientjes 	return gen_pool_has_addr(pool, (unsigned long)start, size);
167c84dc6e6SDavid Rientjes }
168c84dc6e6SDavid Rientjes 
169c84dc6e6SDavid Rientjes void *dma_alloc_from_pool(struct device *dev, size_t size,
170c84dc6e6SDavid Rientjes 			  struct page **ret_page, gfp_t flags)
171c84dc6e6SDavid Rientjes {
172c84dc6e6SDavid Rientjes 	struct gen_pool *pool = dev_to_pool(dev);
173e860c299SDavid Rientjes 	unsigned long val;
174e860c299SDavid Rientjes 	void *ptr = NULL;
175e860c299SDavid Rientjes 
176c84dc6e6SDavid Rientjes 	if (!pool) {
177c84dc6e6SDavid Rientjes 		WARN(1, "%pGg atomic pool not initialised!\n", &flags);
178e860c299SDavid Rientjes 		return NULL;
179e860c299SDavid Rientjes 	}
180e860c299SDavid Rientjes 
181c84dc6e6SDavid Rientjes 	val = gen_pool_alloc(pool, size);
182e860c299SDavid Rientjes 	if (val) {
183c84dc6e6SDavid Rientjes 		phys_addr_t phys = gen_pool_virt_to_phys(pool, val);
184e860c299SDavid Rientjes 
185e860c299SDavid Rientjes 		*ret_page = pfn_to_page(__phys_to_pfn(phys));
186e860c299SDavid Rientjes 		ptr = (void *)val;
187e860c299SDavid Rientjes 		memset(ptr, 0, size);
188e860c299SDavid Rientjes 	}
189*54adadf9SDavid Rientjes 	if (gen_pool_avail(pool) < atomic_pool_size)
190*54adadf9SDavid Rientjes 		schedule_work(&atomic_pool_work);
191e860c299SDavid Rientjes 
192e860c299SDavid Rientjes 	return ptr;
193e860c299SDavid Rientjes }
194e860c299SDavid Rientjes 
195c84dc6e6SDavid Rientjes bool dma_free_from_pool(struct device *dev, void *start, size_t size)
196e860c299SDavid Rientjes {
197c84dc6e6SDavid Rientjes 	struct gen_pool *pool = dev_to_pool(dev);
198c84dc6e6SDavid Rientjes 
199c84dc6e6SDavid Rientjes 	if (!dma_in_atomic_pool(dev, start, size))
200e860c299SDavid Rientjes 		return false;
201c84dc6e6SDavid Rientjes 	gen_pool_free(pool, (unsigned long)start, size);
202e860c299SDavid Rientjes 	return true;
203e860c299SDavid Rientjes }
204