[mirror_ubuntu-bionic-kernel.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/bug.h>
#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/spinlock.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;
}

static inline unsigned long __drm_mm_hole_node_start(struct drm_mm_node *hole_node)
{
	return hole_node->start + hole_node->size;
}

static inline unsigned long drm_mm_hole_node_start(struct drm_mm_node *hole_node)
{
	BUG_ON(!hole_node->hole_follows);
	return __drm_mm_hole_node_start(hole_node);
}

static inline unsigned long __drm_mm_hole_node_end(struct drm_mm_node *hole_node)
{
	return list_entry(hole_node->node_list.next,
			  struct drm_mm_node, node_list)->start;
}

static inline unsigned long drm_mm_hole_node_end(struct drm_mm_node *hole_node)
{
	return __drm_mm_hole_node_end(hole_node);
}

#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) \

/* Note that we need to unroll list_for_each_entry in order to inline
 * setting hole_start and hole_end on each iteration and keep the
 * macro sane.
 */
#define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \
	for (entry = list_entry((mm)->hole_stack.next, struct drm_mm_node, hole_stack); \
	     &entry->hole_stack != &(mm)->hole_stack ? \
	     hole_start = drm_mm_hole_node_start(entry), \
	     hole_end = drm_mm_hole_node_end(entry), \
	     1 : 0; \
	     entry = list_entry(entry->hole_stack.next, struct drm_mm_node, hole_stack))

/*
 * Basic range manager support (drm_mm.c)
 */
extern int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node);
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_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);
}

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