1 // SPDX-License-Identifier: GPL-2.0-only
5  * kmalloc/kfree interface.  Uses for this includes on-device special
21  * On architectures that don't have NMI-safe cmpxchg implementation,
26  * Copyright 2005 (C) Jes Sorensen <jes@trained-monkey.org>
42 	return chunk->end_addr - chunk->start_addr + 1;  in chunk_size()
52 			return -EBUSY;  in set_bits_ll()
66 			return -EBUSY;  in clear_bits_ll()
74  * bitmap_set_ll - set the specified number of bits at the specified position
79  * Set @nr bits start from @start in @map lock-lessly. Several users
89 	int bits_to_set = BITS_PER_LONG - (start % BITS_PER_LONG);  in bitmap_set_ll()
95 		nr -= bits_to_set;  in bitmap_set_ll()
110  * bitmap_clear_ll - clear the specified number of bits at the specified position
115  * Clear @nr bits start from @start in @map lock-lessly. Several users
125 	int bits_to_clear = BITS_PER_LONG - (start % BITS_PER_LONG);  in bitmap_clear_ll()
131 		nr -= bits_to_clear;  in bitmap_clear_ll()
146  * gen_pool_create - create a new special memory pool
148  * @nid: node id of the node the pool structure should be allocated on, or -1
159 		spin_lock_init(&pool->lock);  in gen_pool_create()
160 		INIT_LIST_HEAD(&pool->chunks);  in gen_pool_create()
161 		pool->min_alloc_order = min_alloc_order;  in gen_pool_create()
162 		pool->algo = gen_pool_first_fit;  in gen_pool_create()
163 		pool->data = NULL;  in gen_pool_create()
164 		pool->name = NULL;  in gen_pool_create()
171  * gen_pool_add_owner- add a new chunk of special memory to the pool
177  *       allocated on, or -1
182  * Returns 0 on success or a -ve errno on failure.
188 	unsigned long nbits = size >> pool->min_alloc_order;  in gen_pool_add_owner()
194 		return -ENOMEM;  in gen_pool_add_owner()
196 	chunk->phys_addr = phys;  in gen_pool_add_owner()
197 	chunk->start_addr = virt;  in gen_pool_add_owner()
198 	chunk->end_addr = virt + size - 1;  in gen_pool_add_owner()
199 	chunk->owner = owner;  in gen_pool_add_owner()
200 	atomic_long_set(&chunk->avail, size);  in gen_pool_add_owner()
202 	spin_lock(&pool->lock);  in gen_pool_add_owner()
203 	list_add_rcu(&chunk->next_chunk, &pool->chunks);  in gen_pool_add_owner()
204 	spin_unlock(&pool->lock);  in gen_pool_add_owner()
211  * gen_pool_virt_to_phys - return the physical address of memory
215  * Returns the physical address on success, or -1 on error.
220 	phys_addr_t paddr = -1;  in gen_pool_virt_to_phys()
223 	list_for_each_entry_rcu(chunk, &pool->chunks, next_chunk) {  in gen_pool_virt_to_phys()
224 		if (addr >= chunk->start_addr && addr <= chunk->end_addr) {  in gen_pool_virt_to_phys()
225 			paddr = chunk->phys_addr + (addr - chunk->start_addr);  in gen_pool_virt_to_phys()
236  * gen_pool_destroy - destroy a special memory pool
246 	int order = pool->min_alloc_order;  in gen_pool_destroy()
249 	list_for_each_safe(_chunk, _next_chunk, &pool->chunks) {  in gen_pool_destroy()
251 		list_del(&chunk->next_chunk);  in gen_pool_destroy()
254 		bit = find_first_bit(chunk->bits, end_bit);  in gen_pool_destroy()
259 	kfree_const(pool->name);  in gen_pool_destroy()
265  * gen_pool_alloc_algo_owner - allocate special memory from the pool
273  * Uses the pool allocation function (with first-fit algorithm by default).
275  * NMI-safe cmpxchg implementation.
282 	int order = pool->min_alloc_order;  in gen_pool_alloc_algo_owner()
295 	nbits = (size + (1UL << order) - 1) >> order;  in gen_pool_alloc_algo_owner()
297 	list_for_each_entry_rcu(chunk, &pool->chunks, next_chunk) {  in gen_pool_alloc_algo_owner()
298 		if (size > atomic_long_read(&chunk->avail))  in gen_pool_alloc_algo_owner()
304 		start_bit = algo(chunk->bits, end_bit, start_bit,  in gen_pool_alloc_algo_owner()
305 				 nbits, data, pool, chunk->start_addr);  in gen_pool_alloc_algo_owner()
308 		remain = bitmap_set_ll(chunk->bits, start_bit, nbits);  in gen_pool_alloc_algo_owner()
310 			remain = bitmap_clear_ll(chunk->bits, start_bit,  in gen_pool_alloc_algo_owner()
311 						 nbits - remain);  in gen_pool_alloc_algo_owner()
316 		addr = chunk->start_addr + ((unsigned long)start_bit << order);  in gen_pool_alloc_algo_owner()
318 		atomic_long_sub(size, &chunk->avail);  in gen_pool_alloc_algo_owner()
320 			*owner = chunk->owner;  in gen_pool_alloc_algo_owner()
329  * gen_pool_dma_alloc - allocate special memory from the pool for DMA usage
332  * @dma: dma-view physical address return value.  Use %NULL if unneeded.
335  * Uses the pool allocation function (with first-fit algorithm by default).
337  * NMI-safe cmpxchg implementation.
343 	return gen_pool_dma_alloc_algo(pool, size, dma, pool->algo, pool->data);  in gen_pool_dma_alloc()
348  * gen_pool_dma_alloc_algo - allocate special memory from the pool for DMA
352  * @dma: DMA-view physical address return value. Use %NULL if unneeded.
358  * architectures without NMI-safe cmpxchg implementation.
382  * gen_pool_dma_alloc_align - allocate special memory from the pool for DMA
386  * @dma: DMA-view physical address return value. Use %NULL if unneeded.
391  * without NMI-safe cmpxchg implementation.
406  * gen_pool_dma_zalloc - allocate special zeroed memory from the pool for
410  * @dma: dma-view physical address return value.  Use %NULL if unneeded.
413  * Uses the pool allocation function (with first-fit algorithm by default).
415  * NMI-safe cmpxchg implementation.
421 	return gen_pool_dma_zalloc_algo(pool, size, dma, pool->algo, pool->data);  in gen_pool_dma_zalloc()
426  * gen_pool_dma_zalloc_algo - allocate special zeroed memory from the pool for
430  * @dma: DMA-view physical address return value. Use %NULL if unneeded.
436  * architectures without NMI-safe cmpxchg implementation.
453  * gen_pool_dma_zalloc_align - allocate special zeroed memory from the pool for
457  * @dma: DMA-view physical address return value. Use %NULL if unneeded.
462  * architectures without NMI-safe cmpxchg implementation.
477  * gen_pool_free_owner - free allocated special memory back to the pool
485  * NMI-safe cmpxchg implementation.
491 	int order = pool->min_alloc_order;  in gen_pool_free_owner()
501 	nbits = (size + (1UL << order) - 1) >> order;  in gen_pool_free_owner()
503 	list_for_each_entry_rcu(chunk, &pool->chunks, next_chunk) {  in gen_pool_free_owner()
504 		if (addr >= chunk->start_addr && addr <= chunk->end_addr) {  in gen_pool_free_owner()
505 			BUG_ON(addr + size - 1 > chunk->end_addr);  in gen_pool_free_owner()
506 			start_bit = (addr - chunk->start_addr) >> order;  in gen_pool_free_owner()
507 			remain = bitmap_clear_ll(chunk->bits, start_bit, nbits);  in gen_pool_free_owner()
510 			atomic_long_add(size, &chunk->avail);  in gen_pool_free_owner()
512 				*owner = chunk->owner;  in gen_pool_free_owner()
523  * gen_pool_for_each_chunk - call func for every chunk of generic memory pool
538 	list_for_each_entry_rcu(chunk, &(pool)->chunks, next_chunk)  in gen_pool_for_each_chunk()
545  * gen_pool_has_addr - checks if an address falls within the range of a pool
557 	unsigned long end = start + size - 1;  in gen_pool_has_addr()
561 	list_for_each_entry_rcu(chunk, &(pool)->chunks, next_chunk) {  in gen_pool_has_addr()
562 		if (start >= chunk->start_addr && start <= chunk->end_addr) {  in gen_pool_has_addr()
563 			if (end <= chunk->end_addr) {  in gen_pool_has_addr()
575  * gen_pool_avail - get available free space of the pool
576  * @pool: pool to get available free space
578  * Return available free space of the specified pool.
586 	list_for_each_entry_rcu(chunk, &pool->chunks, next_chunk)  in gen_pool_avail()
587 		avail += atomic_long_read(&chunk->avail);  in gen_pool_avail()
594  * gen_pool_size - get size in bytes of memory managed by the pool
605 	list_for_each_entry_rcu(chunk, &pool->chunks, next_chunk)  in gen_pool_size()
613  * gen_pool_set_algo - set the allocation algorithm
626 	pool->algo = algo;  in gen_pool_set_algo()
627 	if (!pool->algo)  in gen_pool_set_algo()
628 		pool->algo = gen_pool_first_fit;  in gen_pool_set_algo()
630 	pool->data = data;  in gen_pool_set_algo()
637  * gen_pool_first_fit - find the first available region
638  * of memory matching the size requirement (no alignment constraint)
643  * @data: additional data - unused
656  * gen_pool_first_fit_align - find the first available region
657  * of memory matching the size requirement (alignment constraint)
675 	order = pool->min_alloc_order;  in gen_pool_first_fit_align()
676 	align_mask = ((alignment->align + (1UL << order) - 1) >> order) - 1;  in gen_pool_first_fit_align()
677 	align_off = (start_addr & (alignment->align - 1)) >> order;  in gen_pool_first_fit_align()
685  * gen_pool_fixed_alloc - reserve a specific region
704 	order = pool->min_alloc_order;  in gen_pool_fixed_alloc()
705 	offset_bit = fixed_data->offset >> order;  in gen_pool_fixed_alloc()
706 	if (WARN_ON(fixed_data->offset & ((1UL << order) - 1)))  in gen_pool_fixed_alloc()
718  * gen_pool_first_fit_order_align - find the first available region
725  * @data: additional data - unused
734 	unsigned long align_mask = roundup_pow_of_two(nr) - 1;  in gen_pool_first_fit_order_align()
741  * gen_pool_best_fit - find the best fitting region of memory
742  * matching the size requirement (no alignment constraint)
747  * @data: additional data - unused
766 		if ((next_bit - index) < len) {  in gen_pool_best_fit()
767 			len = next_bit - index;  in gen_pool_best_fit()
790 	if (!data && !(*p)->name)  in devm_gen_pool_match()
793 	if (!data || !(*p)->name)  in devm_gen_pool_match()
796 	return !strcmp((*p)->name, data);  in devm_gen_pool_match()
800  * gen_pool_get - Obtain the gen_pool (if any) for a device
819  * devm_gen_pool_create - managed gen_pool_create
837 		return ERR_PTR(-EINVAL);  in devm_gen_pool_create()
842 			return ERR_PTR(-ENOMEM);  in devm_gen_pool_create()
854 	pool->name = pool_name;  in devm_gen_pool_create()
864 	return ERR_PTR(-ENOMEM);  in devm_gen_pool_create()
870  * of_gen_pool_get - find a pool by phandle property
903 		pool = gen_pool_get(&pdev->dev, name);  in of_gen_pool_get()