blob: 88591ef8fa24f0cf8653a278d6bed086279691f0 [file] [log] [blame]
Jerome Glisse249d6042009-04-08 17:11:16 +02001/**************************************************************************
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>
Dave Airlief1938cd2009-09-08 11:32:08 +100040#ifdef CONFIG_DEBUG_FS
41#include <linux/seq_file.h>
42#endif
Jerome Glisse249d6042009-04-08 17:11:16 +020043
44struct drm_mm_node {
Daniel Vetterd1024ce2010-07-02 15:02:14 +010045 struct list_head node_list;
Daniel Vetterea7b1dd2011-02-18 17:59:12 +010046 struct list_head hole_stack;
47 unsigned hole_follows : 1;
Daniel Vetter709ea972010-07-02 15:02:16 +010048 unsigned scanned_block : 1;
49 unsigned scanned_prev_free : 1;
50 unsigned scanned_next_free : 1;
Daniel Vetterea7b1dd2011-02-18 17:59:12 +010051 unsigned scanned_preceeds_hole : 1;
Daniel Vetterb0b7af12011-02-18 17:59:14 +010052 unsigned allocated : 1;
Chris Wilson6b9d89b2012-07-10 11:15:23 +010053 unsigned long color;
Jerome Glisse249d6042009-04-08 17:11:16 +020054 unsigned long start;
55 unsigned long size;
56 struct drm_mm *mm;
Jerome Glisse249d6042009-04-08 17:11:16 +020057};
58
59struct drm_mm {
Lucas De Marchi25985ed2011-03-30 22:57:33 -030060 /* List of all memory nodes that immediately precede a free hole. */
Daniel Vetterea7b1dd2011-02-18 17:59:12 +010061 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;
Jerome Glisse249d6042009-04-08 17:11:16 +020065 struct list_head unused_nodes;
66 int num_unused;
67 spinlock_t unused_lock;
Daniel Vetterd935cc62010-09-16 15:13:11 +020068 unsigned int scan_check_range : 1;
Daniel Vetter709ea972010-07-02 15:02:16 +010069 unsigned scan_alignment;
Chris Wilson6b9d89b2012-07-10 11:15:23 +010070 unsigned long scan_color;
Daniel Vetter709ea972010-07-02 15:02:16 +010071 unsigned long scan_size;
72 unsigned long scan_hit_start;
Chris Wilson901593f2012-12-19 16:51:06 +000073 unsigned long scan_hit_end;
Daniel Vetter709ea972010-07-02 15:02:16 +010074 unsigned scanned_blocks;
Daniel Vetterd935cc62010-09-16 15:13:11 +020075 unsigned long scan_start;
76 unsigned long scan_end;
Daniel Vetterae0cec22011-02-18 17:59:15 +010077 struct drm_mm_node *prev_scanned_node;
Chris Wilson6b9d89b2012-07-10 11:15:23 +010078
79 void (*color_adjust)(struct drm_mm_node *node, unsigned long color,
80 unsigned long *start, unsigned long *end);
Jerome Glisse249d6042009-04-08 17:11:16 +020081};
82
Daniel Vetterb0b7af12011-02-18 17:59:14 +010083static inline bool drm_mm_node_allocated(struct drm_mm_node *node)
84{
85 return node->allocated;
86}
87
Daniel Vetter31a5b8c2011-02-18 17:59:11 +010088static inline bool drm_mm_initialized(struct drm_mm *mm)
89{
Daniel Vetterea7b1dd2011-02-18 17:59:12 +010090 return mm->hole_stack.next;
Daniel Vetter31a5b8c2011-02-18 17:59:11 +010091}
Chris Wilson9e8944a2012-11-15 11:32:17 +000092
93static inline unsigned long __drm_mm_hole_node_start(struct drm_mm_node *hole_node)
94{
95 return hole_node->start + hole_node->size;
96}
97
98static inline unsigned long drm_mm_hole_node_start(struct drm_mm_node *hole_node)
99{
100 BUG_ON(!hole_node->hole_follows);
101 return __drm_mm_hole_node_start(hole_node);
102}
103
104static inline unsigned long __drm_mm_hole_node_end(struct drm_mm_node *hole_node)
105{
106 return list_entry(hole_node->node_list.next,
107 struct drm_mm_node, node_list)->start;
108}
109
110static inline unsigned long drm_mm_hole_node_end(struct drm_mm_node *hole_node)
111{
112 return __drm_mm_hole_node_end(hole_node);
113}
114
Daniel Vetterea7b1dd2011-02-18 17:59:12 +0100115#define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \
116 &(mm)->head_node.node_list, \
Daniel Vetter2bbd4492011-05-06 23:47:53 +0200117 node_list)
Daniel Vetterae0cec22011-02-18 17:59:15 +0100118#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) \
Chris Wilson9e8944a2012-11-15 11:32:17 +0000125
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.
129 */
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))
137
Jerome Glisse249d6042009-04-08 17:11:16 +0200138/*
139 * Basic range manager support (drm_mm.c)
140 */
Chris Wilson5973c7e2012-11-15 11:32:16 +0000141extern struct drm_mm_node *drm_mm_create_block(struct drm_mm *mm,
142 unsigned long start,
143 unsigned long size,
144 bool atomic);
Thomas Hellstrom89579f72009-06-17 12:29:56 +0200145extern struct drm_mm_node *drm_mm_get_block_generic(struct drm_mm_node *node,
146 unsigned long size,
147 unsigned alignment,
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100148 unsigned long color,
Thomas Hellstrom89579f72009-06-17 12:29:56 +0200149 int atomic);
Jerome Glissea2e68e92009-12-07 15:52:56 +0100150extern struct drm_mm_node *drm_mm_get_block_range_generic(
151 struct drm_mm_node *node,
152 unsigned long size,
153 unsigned alignment,
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100154 unsigned long color,
Jerome Glissea2e68e92009-12-07 15:52:56 +0100155 unsigned long start,
156 unsigned long end,
157 int atomic);
Thomas Hellstrom89579f72009-06-17 12:29:56 +0200158static inline struct drm_mm_node *drm_mm_get_block(struct drm_mm_node *parent,
Jerome Glisse249d6042009-04-08 17:11:16 +0200159 unsigned long size,
Thomas Hellstrom89579f72009-06-17 12:29:56 +0200160 unsigned alignment)
161{
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100162 return drm_mm_get_block_generic(parent, size, alignment, 0, 0);
Thomas Hellstrom89579f72009-06-17 12:29:56 +0200163}
164static inline struct drm_mm_node *drm_mm_get_block_atomic(struct drm_mm_node *parent,
165 unsigned long size,
166 unsigned alignment)
167{
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100168 return drm_mm_get_block_generic(parent, size, alignment, 0, 1);
Thomas Hellstrom89579f72009-06-17 12:29:56 +0200169}
Jerome Glissea2e68e92009-12-07 15:52:56 +0100170static 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)
176{
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100177 return drm_mm_get_block_range_generic(parent, size, alignment, 0,
178 start, end, 0);
179}
180static inline struct drm_mm_node *drm_mm_get_color_block_range(
181 struct drm_mm_node *parent,
182 unsigned long size,
183 unsigned alignment,
184 unsigned long color,
185 unsigned long start,
186 unsigned long end)
187{
188 return drm_mm_get_block_range_generic(parent, size, alignment, color,
189 start, end, 0);
Jerome Glissea2e68e92009-12-07 15:52:56 +0100190}
191static inline struct drm_mm_node *drm_mm_get_block_atomic_range(
192 struct drm_mm_node *parent,
193 unsigned long size,
194 unsigned alignment,
195 unsigned long start,
196 unsigned long end)
197{
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100198 return drm_mm_get_block_range_generic(parent, size, alignment, 0,
Jerome Glissea2e68e92009-12-07 15:52:56 +0100199 start, end, 1);
200}
Chris Wilsonb8103452012-12-07 20:37:06 +0000201
202extern int drm_mm_insert_node(struct drm_mm *mm,
203 struct drm_mm_node *node,
204 unsigned long size,
205 unsigned alignment);
Daniel Vetterb0b7af12011-02-18 17:59:14 +0100206extern int drm_mm_insert_node_in_range(struct drm_mm *mm,
207 struct drm_mm_node *node,
Chris Wilsonb8103452012-12-07 20:37:06 +0000208 unsigned long size,
209 unsigned alignment,
210 unsigned long start,
211 unsigned long end);
212extern int drm_mm_insert_node_generic(struct drm_mm *mm,
213 struct drm_mm_node *node,
214 unsigned long size,
215 unsigned alignment,
216 unsigned long color);
217extern int drm_mm_insert_node_in_range_generic(struct drm_mm *mm,
218 struct drm_mm_node *node,
219 unsigned long size,
220 unsigned alignment,
221 unsigned long color,
222 unsigned long start,
223 unsigned long end);
Jerome Glisse249d6042009-04-08 17:11:16 +0200224extern void drm_mm_put_block(struct drm_mm_node *cur);
Daniel Vetterb0b7af12011-02-18 17:59:14 +0100225extern void drm_mm_remove_node(struct drm_mm_node *node);
226extern void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new);
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100227extern struct drm_mm_node *drm_mm_search_free_generic(const struct drm_mm *mm,
228 unsigned long size,
229 unsigned alignment,
230 unsigned long color,
231 bool best_match);
232extern struct drm_mm_node *drm_mm_search_free_in_range_generic(
233 const struct drm_mm *mm,
234 unsigned long size,
235 unsigned alignment,
236 unsigned long color,
237 unsigned long start,
238 unsigned long end,
239 bool best_match);
240static inline struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm,
241 unsigned long size,
242 unsigned alignment,
243 bool best_match)
244{
245 return drm_mm_search_free_generic(mm,size, alignment, 0, best_match);
246}
247static inline struct drm_mm_node *drm_mm_search_free_in_range(
Jerome Glissea2e68e92009-12-07 15:52:56 +0100248 const struct drm_mm *mm,
249 unsigned long size,
250 unsigned alignment,
251 unsigned long start,
252 unsigned long end,
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100253 bool best_match)
254{
255 return drm_mm_search_free_in_range_generic(mm, size, alignment, 0,
256 start, end, best_match);
257}
258static inline struct drm_mm_node *drm_mm_search_free_color(const struct drm_mm *mm,
259 unsigned long size,
260 unsigned alignment,
261 unsigned long color,
262 bool best_match)
263{
264 return drm_mm_search_free_generic(mm,size, alignment, color, best_match);
265}
266static inline struct drm_mm_node *drm_mm_search_free_in_range_color(
267 const struct drm_mm *mm,
268 unsigned long size,
269 unsigned alignment,
270 unsigned long color,
271 unsigned long start,
272 unsigned long end,
273 bool best_match)
274{
275 return drm_mm_search_free_in_range_generic(mm, size, alignment, color,
276 start, end, best_match);
277}
278extern int drm_mm_init(struct drm_mm *mm,
279 unsigned long start,
Jerome Glisse249d6042009-04-08 17:11:16 +0200280 unsigned long size);
281extern void drm_mm_takedown(struct drm_mm *mm);
282extern int drm_mm_clean(struct drm_mm *mm);
Jerome Glisse249d6042009-04-08 17:11:16 +0200283extern int drm_mm_pre_get(struct drm_mm *mm);
284
285static inline struct drm_mm *drm_get_mm(struct drm_mm_node *block)
286{
287 return block->mm;
288}
289
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100290void drm_mm_init_scan(struct drm_mm *mm,
291 unsigned long size,
292 unsigned alignment,
293 unsigned long color);
294void drm_mm_init_scan_with_range(struct drm_mm *mm,
295 unsigned long size,
Daniel Vetterd935cc62010-09-16 15:13:11 +0200296 unsigned alignment,
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100297 unsigned long color,
Daniel Vetterd935cc62010-09-16 15:13:11 +0200298 unsigned long start,
299 unsigned long end);
Daniel Vetter709ea972010-07-02 15:02:16 +0100300int drm_mm_scan_add_block(struct drm_mm_node *node);
301int drm_mm_scan_remove_block(struct drm_mm_node *node);
302
Jerome Glisse99d7e482009-12-09 21:55:09 +0100303extern void drm_mm_debug_table(struct drm_mm *mm, const char *prefix);
Dave Airliefa8a1232009-08-26 13:13:37 +1000304#ifdef CONFIG_DEBUG_FS
305int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm);
306#endif
307
Jerome Glisse249d6042009-04-08 17:11:16 +0200308#endif