[net-next-2.6.git] / include / drm / drm_mm.h

/**************************************************************************
 *
 * Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX. USA.
 * All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sub license, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice (including the
 * next paragraph) shall be included in all copies or substantial portions
 * of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 * USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 *
 **************************************************************************/
/*
 * Authors:
 * Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
 */

#ifndef _DRM_MM_H_
#define _DRM_MM_H_

/*
 * Generic range manager structs
 */
#include <linux/list.h>
#ifdef CONFIG_DEBUG_FS
#include <linux/seq_file.h>
#endif

struct drm_mm_node {
	struct list_head free_stack;
	struct list_head node_list;
	unsigned free : 1;
	unsigned scanned_block : 1;
	unsigned scanned_prev_free : 1;
	unsigned scanned_next_free : 1;
	unsigned long start;
	unsigned long size;
	struct drm_mm *mm;
};

struct drm_mm {
	/* List of free memory blocks, most recently freed ordered. */
	struct list_head free_stack;
	/* List of all memory nodes, ordered according to the (increasing) start
	 * address of the memory node. */
	struct list_head node_list;
	struct list_head unused_nodes;
	int num_unused;
	spinlock_t unused_lock;
	unsigned scan_alignment;
	unsigned long scan_size;
	unsigned long scan_hit_start;
	unsigned scan_hit_size;
	unsigned scanned_blocks;
};

/*
 * Basic range manager support (drm_mm.c)
 */
extern struct drm_mm_node *drm_mm_get_block_generic(struct drm_mm_node *node,
						    unsigned long size,
						    unsigned alignment,
						    int atomic);
extern struct drm_mm_node *drm_mm_get_block_range_generic(
						struct drm_mm_node *node,
						unsigned long size,
						unsigned alignment,
						unsigned long start,
						unsigned long end,
						int atomic);
static inline struct drm_mm_node *drm_mm_get_block(struct drm_mm_node *parent,
						   unsigned long size,
						   unsigned alignment)
{
	return drm_mm_get_block_generic(parent, size, alignment, 0);
}
static inline struct drm_mm_node *drm_mm_get_block_atomic(struct drm_mm_node *parent,
							  unsigned long size,
							  unsigned alignment)
{
	return drm_mm_get_block_generic(parent, size, alignment, 1);
}
static inline struct drm_mm_node *drm_mm_get_block_range(
						struct drm_mm_node *parent,
						unsigned long size,
						unsigned alignment,
						unsigned long start,
						unsigned long end)
{
	return drm_mm_get_block_range_generic(parent, size, alignment,
						start, end, 0);
}
static inline struct drm_mm_node *drm_mm_get_block_atomic_range(
						struct drm_mm_node *parent,
						unsigned long size,
						unsigned alignment,
						unsigned long start,
						unsigned long end)
{
	return drm_mm_get_block_range_generic(parent, size, alignment,
						start, end, 1);
}
extern void drm_mm_put_block(struct drm_mm_node *cur);
extern struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm,
					      unsigned long size,
					      unsigned alignment,
					      int best_match);
extern struct drm_mm_node *drm_mm_search_free_in_range(
						const struct drm_mm *mm,
						unsigned long size,
						unsigned alignment,
						unsigned long start,
						unsigned long end,
						int best_match);
extern int drm_mm_init(struct drm_mm *mm, unsigned long start,
		       unsigned long size);
extern void drm_mm_takedown(struct drm_mm *mm);
extern int drm_mm_clean(struct drm_mm *mm);
extern unsigned long drm_mm_tail_space(struct drm_mm *mm);
extern int drm_mm_remove_space_from_tail(struct drm_mm *mm,
					 unsigned long size);
extern int drm_mm_add_space_to_tail(struct drm_mm *mm,
				    unsigned long size, int atomic);
extern int drm_mm_pre_get(struct drm_mm *mm);

static inline struct drm_mm *drm_get_mm(struct drm_mm_node *block)
{
	return block->mm;
}

void drm_mm_init_scan(struct drm_mm *mm, unsigned long size,
		      unsigned alignment);
int drm_mm_scan_add_block(struct drm_mm_node *node);
int drm_mm_scan_remove_block(struct drm_mm_node *node);

extern void drm_mm_debug_table(struct drm_mm *mm, const char *prefix);
#ifdef CONFIG_DEBUG_FS
int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm);
#endif

#endif
Commit	Line	Data
249d6048 JG	1	/**************************************************************************
	2	*
	3	* Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX. USA.
	4	* All Rights Reserved.
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a
	7	* copy of this software and associated documentation files (the
	8	* "Software"), to deal in the Software without restriction, including
	9	* without limitation the rights to use, copy, modify, merge, publish,
	10	* distribute, sub license, and/or sell copies of the Software, and to
	11	* permit persons to whom the Software is furnished to do so, subject to
	12	* the following conditions:
	13	*
	14	* The above copyright notice and this permission notice (including the
	15	* next paragraph) shall be included in all copies or substantial portions
	16	* of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
	21	* THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
	22	* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
	23	* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
	24	* USE OR OTHER DEALINGS IN THE SOFTWARE.
	25	*
	26	*
	27	**************************************************************************/
	28	/*
	29	* Authors:
	30	* Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
	31	*/
	32
	33	#ifndef _DRM_MM_H_
	34	#define _DRM_MM_H_
	35
	36	/*
	37	* Generic range manager structs
	38	*/
	39	#include <linux/list.h>
f1938cd6 DA	40	#ifdef CONFIG_DEBUG_FS
	41	#include <linux/seq_file.h>
	42	#endif
249d6048 JG	43
249d6048 JG	44	struct drm_mm_node {
d1024ce9 DV	45	struct list_head free_stack;
d1024ce9 DV	46	struct list_head node_list;
709ea971 DV	47	unsigned free : 1;
	48	unsigned scanned_block : 1;
	49	unsigned scanned_prev_free : 1;
	50	unsigned scanned_next_free : 1;
249d6048 JG	51	unsigned long start;
	52	unsigned long size;
	53	struct drm_mm *mm;
249d6048 JG	54	};
	55
	56	struct drm_mm {
d1024ce9 DV	57	/* List of free memory blocks, most recently freed ordered. */
	58	struct list_head free_stack;
	59	/* List of all memory nodes, ordered according to the (increasing) start
	60	* address of the memory node. */
	61	struct list_head node_list;
249d6048 JG	62	struct list_head unused_nodes;
	63	int num_unused;
	64	spinlock_t unused_lock;
709ea971 DV	65	unsigned scan_alignment;
	66	unsigned long scan_size;
	67	unsigned long scan_hit_start;
	68	unsigned scan_hit_size;
	69	unsigned scanned_blocks;
249d6048 JG	70	};
	71
	72	/*
	73	* Basic range manager support (drm_mm.c)
	74	*/
89579f77 TH	75	extern struct drm_mm_node drm_mm_get_block_generic(struct drm_mm_node node,
	76	unsigned long size,
	77	unsigned alignment,
	78	int atomic);
a2e68e92 JG	79	extern struct drm_mm_node *drm_mm_get_block_range_generic(
	80	struct drm_mm_node *node,
	81	unsigned long size,
	82	unsigned alignment,
	83	unsigned long start,
	84	unsigned long end,
	85	int atomic);
89579f77	86	static inline struct drm_mm_node drm_mm_get_block(struct drm_mm_node parent,
249d6048	87	unsigned long size,
89579f77 TH	88	unsigned alignment)
	89	{
	90	return drm_mm_get_block_generic(parent, size, alignment, 0);
	91	}
	92	static inline struct drm_mm_node drm_mm_get_block_atomic(struct drm_mm_node parent,
	93	unsigned long size,
	94	unsigned alignment)
	95	{
	96	return drm_mm_get_block_generic(parent, size, alignment, 1);
	97	}
a2e68e92 JG	98	static inline struct drm_mm_node *drm_mm_get_block_range(
	99	struct drm_mm_node *parent,
	100	unsigned long size,
	101	unsigned alignment,
	102	unsigned long start,
	103	unsigned long end)
	104	{
	105	return drm_mm_get_block_range_generic(parent, size, alignment,
	106	start, end, 0);
	107	}
	108	static inline struct drm_mm_node *drm_mm_get_block_atomic_range(
	109	struct drm_mm_node *parent,
	110	unsigned long size,
	111	unsigned alignment,
	112	unsigned long start,
	113	unsigned long end)
	114	{
	115	return drm_mm_get_block_range_generic(parent, size, alignment,
	116	start, end, 1);
	117	}
249d6048 JG	118	extern void drm_mm_put_block(struct drm_mm_node *cur);
	119	extern struct drm_mm_node drm_mm_search_free(const struct drm_mm mm,
	120	unsigned long size,
	121	unsigned alignment,
	122	int best_match);
a2e68e92 JG	123	extern struct drm_mm_node *drm_mm_search_free_in_range(
	124	const struct drm_mm *mm,
	125	unsigned long size,
	126	unsigned alignment,
	127	unsigned long start,
	128	unsigned long end,
	129	int best_match);
249d6048 JG	130	extern int drm_mm_init(struct drm_mm *mm, unsigned long start,
	131	unsigned long size);
	132	extern void drm_mm_takedown(struct drm_mm *mm);
	133	extern int drm_mm_clean(struct drm_mm *mm);
	134	extern unsigned long drm_mm_tail_space(struct drm_mm *mm);
	135	extern int drm_mm_remove_space_from_tail(struct drm_mm *mm,
	136	unsigned long size);
	137	extern int drm_mm_add_space_to_tail(struct drm_mm *mm,
	138	unsigned long size, int atomic);
	139	extern int drm_mm_pre_get(struct drm_mm *mm);
	140
	141	static inline struct drm_mm drm_get_mm(struct drm_mm_node block)
	142	{
	143	return block->mm;
	144	}
	145
709ea971 DV	146	void drm_mm_init_scan(struct drm_mm *mm, unsigned long size,
	147	unsigned alignment);
	148	int drm_mm_scan_add_block(struct drm_mm_node *node);
	149	int drm_mm_scan_remove_block(struct drm_mm_node *node);
	150
99d7e48e	151	extern void drm_mm_debug_table(struct drm_mm mm, const char prefix);
fa8a1238 DA	152	#ifdef CONFIG_DEBUG_FS
	153	int drm_mm_dump_table(struct seq_file m, struct drm_mm mm);
	154	#endif
	155
249d6048	156	#endif