Merge branch 'fixes' of git://git.infradead.org/users/vkoul/slave-dma
[linux-2.6.git] / include / drm / drm_mm.h
blob4d06edb56d5fbb74480d0ffc4b24297870f8149e
1 /**************************************************************************
3 * Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX. USA.
4 * All Rights Reserved.
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:
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.
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.
27 **************************************************************************/
29 * Authors:
30 * Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
33 #ifndef _DRM_MM_H_
34 #define _DRM_MM_H_
37 * Generic range manager structs
39 #include <linux/list.h>
40 #ifdef CONFIG_DEBUG_FS
41 #include <linux/seq_file.h>
42 #endif
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;
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 long scan_hit_end;
74 unsigned scanned_blocks;
75 unsigned long scan_start;
76 unsigned long scan_end;
77 struct drm_mm_node *prev_scanned_node;
79 void (*color_adjust)(struct drm_mm_node *node, unsigned long color,
80 unsigned long *start, unsigned long *end);
83 static inline bool drm_mm_node_allocated(struct drm_mm_node *node)
85 return node->allocated;
88 static inline bool drm_mm_initialized(struct drm_mm *mm)
90 return mm->hole_stack.next;
93 static inline unsigned long __drm_mm_hole_node_start(struct drm_mm_node *hole_node)
95 return hole_node->start + hole_node->size;
98 static inline unsigned long drm_mm_hole_node_start(struct drm_mm_node *hole_node)
100 BUG_ON(!hole_node->hole_follows);
101 return __drm_mm_hole_node_start(hole_node);
104 static inline unsigned long __drm_mm_hole_node_end(struct drm_mm_node *hole_node)
106 return list_entry(hole_node->node_list.next,
107 struct drm_mm_node, node_list)->start;
110 static inline unsigned long drm_mm_hole_node_end(struct drm_mm_node *hole_node)
112 return __drm_mm_hole_node_end(hole_node);
115 #define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \
116 &(mm)->head_node.node_list, \
117 node_list)
118 #define drm_mm_for_each_scanned_node_reverse(entry, n, mm) \
119 for (entry = (mm)->prev_scanned_node, \
120 next = entry ? list_entry(entry->node_list.next, \
121 struct drm_mm_node, node_list) : NULL; \
122 entry != NULL; entry = next, \
123 next = entry ? list_entry(entry->node_list.next, \
124 struct drm_mm_node, node_list) : NULL) \
126 /* Note that we need to unroll list_for_each_entry in order to inline
127 * setting hole_start and hole_end on each iteration and keep the
128 * macro sane.
130 #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \
131 for (entry = list_entry((mm)->hole_stack.next, struct drm_mm_node, hole_stack); \
132 &entry->hole_stack != &(mm)->hole_stack ? \
133 hole_start = drm_mm_hole_node_start(entry), \
134 hole_end = drm_mm_hole_node_end(entry), \
135 1 : 0; \
136 entry = list_entry(entry->hole_stack.next, struct drm_mm_node, hole_stack))
139 * Basic range manager support (drm_mm.c)
141 extern struct drm_mm_node *drm_mm_create_block(struct drm_mm *mm,
142 unsigned long start,
143 unsigned long size,
144 bool atomic);
145 extern struct drm_mm_node *drm_mm_get_block_generic(struct drm_mm_node *node,
146 unsigned long size,
147 unsigned alignment,
148 unsigned long color,
149 int atomic);
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,
154 unsigned long color,
155 unsigned long start,
156 unsigned long end,
157 int atomic);
158 static inline struct drm_mm_node *drm_mm_get_block(struct drm_mm_node *parent,
159 unsigned long size,
160 unsigned alignment)
162 return drm_mm_get_block_generic(parent, size, alignment, 0, 0);
164 static inline struct drm_mm_node *drm_mm_get_block_atomic(struct drm_mm_node *parent,
165 unsigned long size,
166 unsigned alignment)
168 return drm_mm_get_block_generic(parent, size, alignment, 0, 1);
170 static inline struct drm_mm_node *drm_mm_get_block_range(
171 struct drm_mm_node *parent,
172 unsigned long size,
173 unsigned alignment,
174 unsigned long start,
175 unsigned long end)
177 return drm_mm_get_block_range_generic(parent, size, alignment, 0,
178 start, end, 0);
180 static inline struct drm_mm_node *drm_mm_get_block_atomic_range(
181 struct drm_mm_node *parent,
182 unsigned long size,
183 unsigned alignment,
184 unsigned long start,
185 unsigned long end)
187 return drm_mm_get_block_range_generic(parent, size, alignment, 0,
188 start, end, 1);
191 extern int drm_mm_insert_node(struct drm_mm *mm,
192 struct drm_mm_node *node,
193 unsigned long size,
194 unsigned alignment);
195 extern int drm_mm_insert_node_in_range(struct drm_mm *mm,
196 struct drm_mm_node *node,
197 unsigned long size,
198 unsigned alignment,
199 unsigned long start,
200 unsigned long end);
201 extern int drm_mm_insert_node_generic(struct drm_mm *mm,
202 struct drm_mm_node *node,
203 unsigned long size,
204 unsigned alignment,
205 unsigned long color);
206 extern int drm_mm_insert_node_in_range_generic(struct drm_mm *mm,
207 struct drm_mm_node *node,
208 unsigned long size,
209 unsigned alignment,
210 unsigned long color,
211 unsigned long start,
212 unsigned long end);
213 extern void drm_mm_put_block(struct drm_mm_node *cur);
214 extern void drm_mm_remove_node(struct drm_mm_node *node);
215 extern void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new);
216 extern struct drm_mm_node *drm_mm_search_free_generic(const struct drm_mm *mm,
217 unsigned long size,
218 unsigned alignment,
219 unsigned long color,
220 bool best_match);
221 extern struct drm_mm_node *drm_mm_search_free_in_range_generic(
222 const struct drm_mm *mm,
223 unsigned long size,
224 unsigned alignment,
225 unsigned long color,
226 unsigned long start,
227 unsigned long end,
228 bool best_match);
229 static inline struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm,
230 unsigned long size,
231 unsigned alignment,
232 bool best_match)
234 return drm_mm_search_free_generic(mm,size, alignment, 0, best_match);
236 static inline struct drm_mm_node *drm_mm_search_free_in_range(
237 const struct drm_mm *mm,
238 unsigned long size,
239 unsigned alignment,
240 unsigned long start,
241 unsigned long end,
242 bool best_match)
244 return drm_mm_search_free_in_range_generic(mm, size, alignment, 0,
245 start, end, best_match);
248 extern void drm_mm_init(struct drm_mm *mm,
249 unsigned long start,
250 unsigned long size);
251 extern void drm_mm_takedown(struct drm_mm *mm);
252 extern int drm_mm_clean(struct drm_mm *mm);
253 extern int drm_mm_pre_get(struct drm_mm *mm);
255 static inline struct drm_mm *drm_get_mm(struct drm_mm_node *block)
257 return block->mm;
260 void drm_mm_init_scan(struct drm_mm *mm,
261 unsigned long size,
262 unsigned alignment,
263 unsigned long color);
264 void drm_mm_init_scan_with_range(struct drm_mm *mm,
265 unsigned long size,
266 unsigned alignment,
267 unsigned long color,
268 unsigned long start,
269 unsigned long end);
270 int drm_mm_scan_add_block(struct drm_mm_node *node);
271 int drm_mm_scan_remove_block(struct drm_mm_node *node);
273 extern void drm_mm_debug_table(struct drm_mm *mm, const char *prefix);
274 #ifdef CONFIG_DEBUG_FS
275 int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm);
276 #endif
278 #endif