[deliverable/linux.git] / include / linux / genalloc.h

/*
 * Basic general purpose allocator for managing special purpose memory
 * not managed by the regular kmalloc/kfree interface.
 * Uses for this includes on-device special memory, uncached memory
 * etc.
 *
 * This source code is licensed under the GNU General Public License,
 * Version 2.  See the file COPYING for more details.
 */


#ifndef __GENALLOC_H__
#define __GENALLOC_H__
/*
 *  General purpose special memory pool descriptor.
 */
struct gen_pool {
	rwlock_t lock;
	struct list_head chunks;	/* list of chunks in this pool */
	int min_alloc_order;		/* minimum allocation order */
};

/*
 *  General purpose special memory pool chunk descriptor.
 */
struct gen_pool_chunk {
	spinlock_t lock;
	struct list_head next_chunk;	/* next chunk in pool */
	phys_addr_t phys_addr;		/* physical starting address of memory chunk */
	unsigned long start_addr;	/* starting address of memory chunk */
	unsigned long end_addr;		/* ending address of memory chunk */
	unsigned long bits[0];		/* bitmap for allocating memory chunk */
};

extern struct gen_pool *gen_pool_create(int, int);
extern phys_addr_t gen_pool_virt_to_phys(struct gen_pool *pool, unsigned long);
extern int gen_pool_add_virt(struct gen_pool *, unsigned long, phys_addr_t,
			     size_t, int);
/**
 * gen_pool_add - add a new chunk of special memory to the pool
 * @pool: pool to add new memory chunk to
 * @addr: starting address of memory chunk to add to pool
 * @size: size in bytes of the memory chunk to add to pool
 * @nid: node id of the node the chunk structure and bitmap should be
 *       allocated on, or -1
 *
 * Add a new chunk of special memory to the specified pool.
 *
 * Returns 0 on success or a -ve errno on failure.
 */
static inline int gen_pool_add(struct gen_pool *pool, unsigned long addr,
			       size_t size, int nid)
{
	return gen_pool_add_virt(pool, addr, -1, size, nid);
}
extern void gen_pool_destroy(struct gen_pool *);
extern unsigned long gen_pool_alloc(struct gen_pool *, size_t);
extern void gen_pool_free(struct gen_pool *, unsigned long, size_t);
#endif /* __GENALLOC_H__ */
Commit	Line	Data
f14f75b8 JS	1	/*
	2	* Basic general purpose allocator for managing special purpose memory
	3	* not managed by the regular kmalloc/kfree interface.
	4	* Uses for this includes on-device special memory, uncached memory
	5	* etc.
	6	*
f14f75b8 JS	7	* This source code is licensed under the GNU General Public License,
	8	* Version 2. See the file COPYING for more details.
	9	*/
	10
f14f75b8	11
6aae6e03 JCPV	12	#ifndef __GENALLOC_H__
6aae6e03 JCPV	13	#define __GENALLOC_H__
f14f75b8	14	/*
929f9727	15	* General purpose special memory pool descriptor.
f14f75b8	16	*/
929f9727 DN	17	struct gen_pool {
	18	rwlock_t lock;
	19	struct list_head chunks; /* list of chunks in this pool */
	20	int min_alloc_order; /* minimum allocation order */
f14f75b8 JS	21	};
	22
	23	/*
929f9727	24	* General purpose special memory pool chunk descriptor.
f14f75b8	25	*/
929f9727	26	struct gen_pool_chunk {
f14f75b8	27	spinlock_t lock;
929f9727	28	struct list_head next_chunk; /* next chunk in pool */
3c8f370d	29	phys_addr_t phys_addr; /* physical starting address of memory chunk */
929f9727 DN	30	unsigned long start_addr; /* starting address of memory chunk */
	31	unsigned long end_addr; /* ending address of memory chunk */
	32	unsigned long bits[0]; /* bitmap for allocating memory chunk */
f14f75b8 JS	33	};
f14f75b8 JS	34
929f9727	35	extern struct gen_pool *gen_pool_create(int, int);
3c8f370d JCPV	36	extern phys_addr_t gen_pool_virt_to_phys(struct gen_pool *pool, unsigned long);
	37	extern int gen_pool_add_virt(struct gen_pool *, unsigned long, phys_addr_t,
	38	size_t, int);
	39	/**
	40	* gen_pool_add - add a new chunk of special memory to the pool
	41	* @pool: pool to add new memory chunk to
	42	* @addr: starting address of memory chunk to add to pool
	43	* @size: size in bytes of the memory chunk to add to pool
	44	* @nid: node id of the node the chunk structure and bitmap should be
	45	* allocated on, or -1
	46	*
	47	* Add a new chunk of special memory to the specified pool.
	48	*
	49	* Returns 0 on success or a -ve errno on failure.
	50	*/
	51	static inline int gen_pool_add(struct gen_pool *pool, unsigned long addr,
	52	size_t size, int nid)
	53	{
	54	return gen_pool_add_virt(pool, addr, -1, size, nid);
	55	}
322acc96	56	extern void gen_pool_destroy(struct gen_pool *);
929f9727 DN	57	extern unsigned long gen_pool_alloc(struct gen_pool *, size_t);
929f9727 DN	58	extern void gen_pool_free(struct gen_pool *, unsigned long, size_t);
6aae6e03	59	#endif /* __GENALLOC_H__ */