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