xref: /openbmc/linux/include/drm/drm_mm.h (revision d1024ce9)
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>
40 #ifdef CONFIG_DEBUG_FS
41 #include <linux/seq_file.h>
42 #endif
43 
44 struct drm_mm_node {
45 	struct list_head free_stack;
46 	struct list_head node_list;
47 	int free;
48 	unsigned long start;
49 	unsigned long size;
50 	struct drm_mm *mm;
51 };
52 
53 struct drm_mm {
54 	/* List of free memory blocks, most recently freed ordered. */
55 	struct list_head free_stack;
56 	/* List of all memory nodes, ordered according to the (increasing) start
57 	 * address of the memory node. */
58 	struct list_head node_list;
59 	struct list_head unused_nodes;
60 	int num_unused;
61 	spinlock_t unused_lock;
62 };
63 
64 /*
65  * Basic range manager support (drm_mm.c)
66  */
67 extern struct drm_mm_node *drm_mm_get_block_generic(struct drm_mm_node *node,
68 						    unsigned long size,
69 						    unsigned alignment,
70 						    int atomic);
71 extern struct drm_mm_node *drm_mm_get_block_range_generic(
72 						struct drm_mm_node *node,
73 						unsigned long size,
74 						unsigned alignment,
75 						unsigned long start,
76 						unsigned long end,
77 						int atomic);
78 static inline struct drm_mm_node *drm_mm_get_block(struct drm_mm_node *parent,
79 						   unsigned long size,
80 						   unsigned alignment)
81 {
82 	return drm_mm_get_block_generic(parent, size, alignment, 0);
83 }
84 static inline struct drm_mm_node *drm_mm_get_block_atomic(struct drm_mm_node *parent,
85 							  unsigned long size,
86 							  unsigned alignment)
87 {
88 	return drm_mm_get_block_generic(parent, size, alignment, 1);
89 }
90 static inline struct drm_mm_node *drm_mm_get_block_range(
91 						struct drm_mm_node *parent,
92 						unsigned long size,
93 						unsigned alignment,
94 						unsigned long start,
95 						unsigned long end)
96 {
97 	return drm_mm_get_block_range_generic(parent, size, alignment,
98 						start, end, 0);
99 }
100 static inline struct drm_mm_node *drm_mm_get_block_atomic_range(
101 						struct drm_mm_node *parent,
102 						unsigned long size,
103 						unsigned alignment,
104 						unsigned long start,
105 						unsigned long end)
106 {
107 	return drm_mm_get_block_range_generic(parent, size, alignment,
108 						start, end, 1);
109 }
110 extern void drm_mm_put_block(struct drm_mm_node *cur);
111 extern struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm,
112 					      unsigned long size,
113 					      unsigned alignment,
114 					      int best_match);
115 extern struct drm_mm_node *drm_mm_search_free_in_range(
116 						const struct drm_mm *mm,
117 						unsigned long size,
118 						unsigned alignment,
119 						unsigned long start,
120 						unsigned long end,
121 						int best_match);
122 extern int drm_mm_init(struct drm_mm *mm, unsigned long start,
123 		       unsigned long size);
124 extern void drm_mm_takedown(struct drm_mm *mm);
125 extern int drm_mm_clean(struct drm_mm *mm);
126 extern unsigned long drm_mm_tail_space(struct drm_mm *mm);
127 extern int drm_mm_remove_space_from_tail(struct drm_mm *mm,
128 					 unsigned long size);
129 extern int drm_mm_add_space_to_tail(struct drm_mm *mm,
130 				    unsigned long size, int atomic);
131 extern int drm_mm_pre_get(struct drm_mm *mm);
132 
133 static inline struct drm_mm *drm_get_mm(struct drm_mm_node *block)
134 {
135 	return block->mm;
136 }
137 
138 extern void drm_mm_debug_table(struct drm_mm *mm, const char *prefix);
139 #ifdef CONFIG_DEBUG_FS
140 int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm);
141 #endif
142 
143 #endif
144