[deliverable/linux.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 node_list;
	struct list_head hole_stack;
	unsigned hole_follows : 1;
	unsigned scanned_block : 1;
	unsigned scanned_prev_free : 1;
	unsigned scanned_next_free : 1;
	unsigned scanned_preceeds_hole : 1;
	unsigned allocated : 1;
	unsigned long color;
	unsigned long start;
	unsigned long size;
	struct drm_mm *mm;
};

struct drm_mm {
	/* List of all memory nodes that immediately precede a free hole. */
	struct list_head hole_stack;
	/* head_node.node_list is the list of all memory nodes, ordered
	 * according to the (increasing) start address of the memory node. */
	struct drm_mm_node head_node;
	struct list_head unused_nodes;
	int num_unused;
	spinlock_t unused_lock;
	unsigned int scan_check_range : 1;
	unsigned scan_alignment;
	unsigned long scan_color;
	unsigned long scan_size;
	unsigned long scan_hit_start;
	unsigned long scan_hit_end;
	unsigned scanned_blocks;
	unsigned long scan_start;
	unsigned long scan_end;
	struct drm_mm_node *prev_scanned_node;

	void (*color_adjust)(struct drm_mm_node *node, unsigned long color,
			     unsigned long *start, unsigned long *end);
};

static inline bool drm_mm_node_allocated(struct drm_mm_node *node)
{
	return node->allocated;
}

static inline bool drm_mm_initialized(struct drm_mm *mm)
{
	return mm->hole_stack.next;
}
#define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \
						&(mm)->head_node.node_list, \
						node_list)
#define drm_mm_for_each_scanned_node_reverse(entry, n, mm) \
	for (entry = (mm)->prev_scanned_node, \
		next = entry ? list_entry(entry->node_list.next, \
			struct drm_mm_node, node_list) : NULL; \
	     entry != NULL; entry = next, \
		next = entry ? list_entry(entry->node_list.next, \
			struct drm_mm_node, node_list) : NULL) \
/*
 * 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,
						    unsigned long color,
						    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 color,
						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, 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, 0, 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, 0,
					      start, end, 0);
}
static inline struct drm_mm_node *drm_mm_get_color_block_range(
						struct drm_mm_node *parent,
						unsigned long size,
						unsigned alignment,
						unsigned long color,
						unsigned long start,
						unsigned long end)
{
	return drm_mm_get_block_range_generic(parent, size, alignment, color,
					      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, 0,
						start, end, 1);
}

extern int drm_mm_insert_node(struct drm_mm *mm,
			      struct drm_mm_node *node,
			      unsigned long size,
			      unsigned alignment);
extern int drm_mm_insert_node_in_range(struct drm_mm *mm,
				       struct drm_mm_node *node,
				       unsigned long size,
				       unsigned alignment,
				       unsigned long start,
				       unsigned long end);
extern int drm_mm_insert_node_generic(struct drm_mm *mm,
				      struct drm_mm_node *node,
				      unsigned long size,
				      unsigned alignment,
				      unsigned long color);
extern int drm_mm_insert_node_in_range_generic(struct drm_mm *mm,
				       struct drm_mm_node *node,
				       unsigned long size,
				       unsigned alignment,
				       unsigned long color,
				       unsigned long start,
				       unsigned long end);
extern void drm_mm_put_block(struct drm_mm_node *cur);
extern void drm_mm_remove_node(struct drm_mm_node *node);
extern void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new);
extern struct drm_mm_node *drm_mm_search_free_generic(const struct drm_mm *mm,
						      unsigned long size,
						      unsigned alignment,
						      unsigned long color,
						      bool best_match);
extern struct drm_mm_node *drm_mm_search_free_in_range_generic(
						const struct drm_mm *mm,
						unsigned long size,
						unsigned alignment,
						unsigned long color,
						unsigned long start,
						unsigned long end,
						bool best_match);
static inline struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm,
						     unsigned long size,
						     unsigned alignment,
						     bool best_match)
{
	return drm_mm_search_free_generic(mm,size, alignment, 0, best_match);
}
static inline  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,
						bool best_match)
{
	return drm_mm_search_free_in_range_generic(mm, size, alignment, 0,
						   start, end, best_match);
}
static inline struct drm_mm_node *drm_mm_search_free_color(const struct drm_mm *mm,
							   unsigned long size,
							   unsigned alignment,
							   unsigned long color,
							   bool best_match)
{
	return drm_mm_search_free_generic(mm,size, alignment, color, best_match);
}
static inline  struct drm_mm_node *drm_mm_search_free_in_range_color(
						const struct drm_mm *mm,
						unsigned long size,
						unsigned alignment,
						unsigned long color,
						unsigned long start,
						unsigned long end,
						bool best_match)
{
	return drm_mm_search_free_in_range_generic(mm, size, alignment, color,
						   start, end, 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 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,
		      unsigned long color);
void drm_mm_init_scan_with_range(struct drm_mm *mm,
				 unsigned long size,
				 unsigned alignment,
				 unsigned long color,
				 unsigned long start,
				 unsigned long end);
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	45	struct list_head node_list;
ea7b1dd4 DV	46	struct list_head hole_stack;
ea7b1dd4 DV	47	unsigned hole_follows : 1;
709ea971 DV	48	unsigned scanned_block : 1;
	49	unsigned scanned_prev_free : 1;
	50	unsigned scanned_next_free : 1;
ea7b1dd4	51	unsigned scanned_preceeds_hole : 1;
b0b7af18	52	unsigned allocated : 1;
6b9d89b4	53	unsigned long color;
249d6048 JG	54	unsigned long start;
	55	unsigned long size;
	56	struct drm_mm *mm;
249d6048 JG	57	};
	58
	59	struct drm_mm {
25985edc	60	/* List of all memory nodes that immediately precede a free hole. */
ea7b1dd4 DV	61	struct list_head hole_stack;
	62	/* head_node.node_list is the list of all memory nodes, ordered
	63	* according to the (increasing) start address of the memory node. */
	64	struct drm_mm_node head_node;
249d6048 JG	65	struct list_head unused_nodes;
	66	int num_unused;
	67	spinlock_t unused_lock;
d935cc61	68	unsigned int scan_check_range : 1;
709ea971	69	unsigned scan_alignment;
6b9d89b4	70	unsigned long scan_color;
709ea971 DV	71	unsigned long scan_size;
709ea971 DV	72	unsigned long scan_hit_start;
901593f2	73	unsigned long scan_hit_end;
709ea971	74	unsigned scanned_blocks;
d935cc61 DV	75	unsigned long scan_start;
d935cc61 DV	76	unsigned long scan_end;
ae0cec28	77	struct drm_mm_node *prev_scanned_node;
6b9d89b4 CW	78
	79	void (color_adjust)(struct drm_mm_node node, unsigned long color,
	80	unsigned long start, unsigned long end);
249d6048 JG	81	};
249d6048 JG	82
b0b7af18 DV	83	static inline bool drm_mm_node_allocated(struct drm_mm_node *node)
	84	{
	85	return node->allocated;
	86	}
	87
31a5b8ce DV	88	static inline bool drm_mm_initialized(struct drm_mm *mm)
31a5b8ce DV	89	{
ea7b1dd4	90	return mm->hole_stack.next;
31a5b8ce	91	}
ea7b1dd4 DV	92	#define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \
ea7b1dd4 DV	93	&(mm)->head_node.node_list, \
2bbd4492	94	node_list)
ae0cec28 DV	95	#define drm_mm_for_each_scanned_node_reverse(entry, n, mm) \
	96	for (entry = (mm)->prev_scanned_node, \
	97	next = entry ? list_entry(entry->node_list.next, \
	98	struct drm_mm_node, node_list) : NULL; \
	99	entry != NULL; entry = next, \
	100	next = entry ? list_entry(entry->node_list.next, \
	101	struct drm_mm_node, node_list) : NULL) \
249d6048 JG	102	/*
	103	* Basic range manager support (drm_mm.c)
	104	*/
89579f77 TH	105	extern struct drm_mm_node drm_mm_get_block_generic(struct drm_mm_node node,
	106	unsigned long size,
	107	unsigned alignment,
6b9d89b4	108	unsigned long color,
89579f77	109	int atomic);
a2e68e92 JG	110	extern struct drm_mm_node *drm_mm_get_block_range_generic(
	111	struct drm_mm_node *node,
	112	unsigned long size,
	113	unsigned alignment,
6b9d89b4	114	unsigned long color,
a2e68e92 JG	115	unsigned long start,
	116	unsigned long end,
	117	int atomic);
89579f77	118	static inline struct drm_mm_node drm_mm_get_block(struct drm_mm_node parent,
249d6048	119	unsigned long size,
89579f77 TH	120	unsigned alignment)
89579f77 TH	121	{
6b9d89b4	122	return drm_mm_get_block_generic(parent, size, alignment, 0, 0);
89579f77 TH	123	}
	124	static inline struct drm_mm_node drm_mm_get_block_atomic(struct drm_mm_node parent,
	125	unsigned long size,
	126	unsigned alignment)
	127	{
6b9d89b4	128	return drm_mm_get_block_generic(parent, size, alignment, 0, 1);
89579f77	129	}
a2e68e92 JG	130	static inline struct drm_mm_node *drm_mm_get_block_range(
	131	struct drm_mm_node *parent,
	132	unsigned long size,
	133	unsigned alignment,
	134	unsigned long start,
	135	unsigned long end)
	136	{
6b9d89b4 CW	137	return drm_mm_get_block_range_generic(parent, size, alignment, 0,
	138	start, end, 0);
	139	}
	140	static inline struct drm_mm_node *drm_mm_get_color_block_range(
	141	struct drm_mm_node *parent,
	142	unsigned long size,
	143	unsigned alignment,
	144	unsigned long color,
	145	unsigned long start,
	146	unsigned long end)
	147	{
	148	return drm_mm_get_block_range_generic(parent, size, alignment, color,
	149	start, end, 0);
a2e68e92 JG	150	}
	151	static inline struct drm_mm_node *drm_mm_get_block_atomic_range(
	152	struct drm_mm_node *parent,
	153	unsigned long size,
	154	unsigned alignment,
	155	unsigned long start,
	156	unsigned long end)
	157	{
6b9d89b4	158	return drm_mm_get_block_range_generic(parent, size, alignment, 0,
a2e68e92 JG	159	start, end, 1);
a2e68e92 JG	160	}
b8103450 CW	161
	162	extern int drm_mm_insert_node(struct drm_mm *mm,
	163	struct drm_mm_node *node,
	164	unsigned long size,
	165	unsigned alignment);
b0b7af18 DV	166	extern int drm_mm_insert_node_in_range(struct drm_mm *mm,
b0b7af18 DV	167	struct drm_mm_node *node,
b8103450 CW	168	unsigned long size,
	169	unsigned alignment,
	170	unsigned long start,
	171	unsigned long end);
	172	extern int drm_mm_insert_node_generic(struct drm_mm *mm,
	173	struct drm_mm_node *node,
	174	unsigned long size,
	175	unsigned alignment,
	176	unsigned long color);
	177	extern int drm_mm_insert_node_in_range_generic(struct drm_mm *mm,
	178	struct drm_mm_node *node,
	179	unsigned long size,
	180	unsigned alignment,
	181	unsigned long color,
	182	unsigned long start,
	183	unsigned long end);
249d6048	184	extern void drm_mm_put_block(struct drm_mm_node *cur);
b0b7af18 DV	185	extern void drm_mm_remove_node(struct drm_mm_node *node);
b0b7af18 DV	186	extern void drm_mm_replace_node(struct drm_mm_node old, struct drm_mm_node new);
6b9d89b4 CW	187	extern struct drm_mm_node drm_mm_search_free_generic(const struct drm_mm mm,
	188	unsigned long size,
	189	unsigned alignment,
	190	unsigned long color,
	191	bool best_match);
	192	extern struct drm_mm_node *drm_mm_search_free_in_range_generic(
	193	const struct drm_mm *mm,
	194	unsigned long size,
	195	unsigned alignment,
	196	unsigned long color,
	197	unsigned long start,
	198	unsigned long end,
	199	bool best_match);
	200	static inline struct drm_mm_node drm_mm_search_free(const struct drm_mm mm,
	201	unsigned long size,
	202	unsigned alignment,
	203	bool best_match)
	204	{
	205	return drm_mm_search_free_generic(mm,size, alignment, 0, best_match);
	206	}
	207	static inline struct drm_mm_node *drm_mm_search_free_in_range(
a2e68e92 JG	208	const struct drm_mm *mm,
	209	unsigned long size,
	210	unsigned alignment,
	211	unsigned long start,
	212	unsigned long end,
6b9d89b4 CW	213	bool best_match)
	214	{
	215	return drm_mm_search_free_in_range_generic(mm, size, alignment, 0,
	216	start, end, best_match);
	217	}
	218	static inline struct drm_mm_node drm_mm_search_free_color(const struct drm_mm mm,
	219	unsigned long size,
	220	unsigned alignment,
	221	unsigned long color,
	222	bool best_match)
	223	{
	224	return drm_mm_search_free_generic(mm,size, alignment, color, best_match);
	225	}
	226	static inline struct drm_mm_node *drm_mm_search_free_in_range_color(
	227	const struct drm_mm *mm,
	228	unsigned long size,
	229	unsigned alignment,
	230	unsigned long color,
	231	unsigned long start,
	232	unsigned long end,
	233	bool best_match)
	234	{
	235	return drm_mm_search_free_in_range_generic(mm, size, alignment, color,
	236	start, end, best_match);
	237	}
	238	extern int drm_mm_init(struct drm_mm *mm,
	239	unsigned long start,
249d6048 JG	240	unsigned long size);
	241	extern void drm_mm_takedown(struct drm_mm *mm);
	242	extern int drm_mm_clean(struct drm_mm *mm);
249d6048 JG	243	extern int drm_mm_pre_get(struct drm_mm *mm);
	244
	245	static inline struct drm_mm drm_get_mm(struct drm_mm_node block)
	246	{
	247	return block->mm;
	248	}
	249
6b9d89b4 CW	250	void drm_mm_init_scan(struct drm_mm *mm,
	251	unsigned long size,
	252	unsigned alignment,
	253	unsigned long color);
	254	void drm_mm_init_scan_with_range(struct drm_mm *mm,
	255	unsigned long size,
d935cc61	256	unsigned alignment,
6b9d89b4	257	unsigned long color,
d935cc61 DV	258	unsigned long start,
d935cc61 DV	259	unsigned long end);
709ea971 DV	260	int drm_mm_scan_add_block(struct drm_mm_node *node);
	261	int drm_mm_scan_remove_block(struct drm_mm_node *node);
	262
99d7e48e	263	extern void drm_mm_debug_table(struct drm_mm mm, const char prefix);
fa8a1238 DA	264	#ifdef CONFIG_DEBUG_FS
	265	int drm_mm_dump_table(struct seq_file m, struct drm_mm mm);
	266	#endif
	267
249d6048	268	#endif