]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/drm/drm_mm.h
drm: Introduce drm_mm_create_block()
[mirror_ubuntu-artful-kernel.git] / include / drm / drm_mm.h
CommitLineData
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 */
39#include <linux/list.h>
f1938cd6
DA
40#ifdef CONFIG_DEBUG_FS
41#include <linux/seq_file.h>
42#endif
249d6048
JG
43
44struct drm_mm_node {
d1024ce9 45 struct list_head node_list;
ea7b1dd4
DV
46 struct list_head hole_stack;
47 unsigned hole_follows : 1;
709ea971
DV
48 unsigned scanned_block : 1;
49 unsigned scanned_prev_free : 1;
50 unsigned scanned_next_free : 1;
ea7b1dd4 51 unsigned scanned_preceeds_hole : 1;
b0b7af18 52 unsigned allocated : 1;
6b9d89b4 53 unsigned long color;
249d6048
JG
54 unsigned long start;
55 unsigned long size;
56 struct drm_mm *mm;
249d6048
JG
57};
58
59struct drm_mm {
25985edc 60 /* List of all memory nodes that immediately precede a free hole. */
ea7b1dd4
DV
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;
249d6048
JG
65 struct list_head unused_nodes;
66 int num_unused;
67 spinlock_t unused_lock;
d935cc61 68 unsigned int scan_check_range : 1;
709ea971 69 unsigned scan_alignment;
6b9d89b4 70 unsigned long scan_color;
709ea971
DV
71 unsigned long scan_size;
72 unsigned long scan_hit_start;
73 unsigned scan_hit_size;
74 unsigned scanned_blocks;
d935cc61
DV
75 unsigned long scan_start;
76 unsigned long scan_end;
ae0cec28 77 struct drm_mm_node *prev_scanned_node;
6b9d89b4
CW
78
79 void (*color_adjust)(struct drm_mm_node *node, unsigned long color,
80 unsigned long *start, unsigned long *end);
249d6048
JG
81};
82
b0b7af18
DV
83static inline bool drm_mm_node_allocated(struct drm_mm_node *node)
84{
85 return node->allocated;
86}
87
31a5b8ce
DV
88static inline bool drm_mm_initialized(struct drm_mm *mm)
89{
ea7b1dd4 90 return mm->hole_stack.next;
31a5b8ce 91}
ea7b1dd4
DV
92#define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \
93 &(mm)->head_node.node_list, \
2bbd4492 94 node_list)
ae0cec28
DV
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) \
249d6048
JG
102/*
103 * Basic range manager support (drm_mm.c)
104 */
5973c7ee
CW
105extern struct drm_mm_node *drm_mm_create_block(struct drm_mm *mm,
106 unsigned long start,
107 unsigned long size,
108 bool atomic);
89579f77
TH
109extern struct drm_mm_node *drm_mm_get_block_generic(struct drm_mm_node *node,
110 unsigned long size,
111 unsigned alignment,
6b9d89b4 112 unsigned long color,
89579f77 113 int atomic);
a2e68e92
JG
114extern struct drm_mm_node *drm_mm_get_block_range_generic(
115 struct drm_mm_node *node,
116 unsigned long size,
117 unsigned alignment,
6b9d89b4 118 unsigned long color,
a2e68e92
JG
119 unsigned long start,
120 unsigned long end,
121 int atomic);
89579f77 122static inline struct drm_mm_node *drm_mm_get_block(struct drm_mm_node *parent,
249d6048 123 unsigned long size,
89579f77
TH
124 unsigned alignment)
125{
6b9d89b4 126 return drm_mm_get_block_generic(parent, size, alignment, 0, 0);
89579f77
TH
127}
128static inline struct drm_mm_node *drm_mm_get_block_atomic(struct drm_mm_node *parent,
129 unsigned long size,
130 unsigned alignment)
131{
6b9d89b4 132 return drm_mm_get_block_generic(parent, size, alignment, 0, 1);
89579f77 133}
a2e68e92
JG
134static 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{
6b9d89b4
CW
141 return drm_mm_get_block_range_generic(parent, size, alignment, 0,
142 start, end, 0);
143}
144static 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);
a2e68e92
JG
154}
155static 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{
6b9d89b4 162 return drm_mm_get_block_range_generic(parent, size, alignment, 0,
a2e68e92
JG
163 start, end, 1);
164}
b0b7af18
DV
165extern int drm_mm_insert_node(struct drm_mm *mm, struct drm_mm_node *node,
166 unsigned long size, unsigned alignment);
167extern 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);
249d6048 171extern void drm_mm_put_block(struct drm_mm_node *cur);
b0b7af18
DV
172extern void drm_mm_remove_node(struct drm_mm_node *node);
173extern void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new);
6b9d89b4
CW
174extern 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);
179extern 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);
187static 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}
194static inline struct drm_mm_node *drm_mm_search_free_in_range(
a2e68e92
JG
195 const struct drm_mm *mm,
196 unsigned long size,
197 unsigned alignment,
198 unsigned long start,
199 unsigned long end,
6b9d89b4
CW
200 bool best_match)
201{
202 return drm_mm_search_free_in_range_generic(mm, size, alignment, 0,
203 start, end, best_match);
204}
205static 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}
213static 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}
225extern int drm_mm_init(struct drm_mm *mm,
226 unsigned long start,
249d6048
JG
227 unsigned long size);
228extern void drm_mm_takedown(struct drm_mm *mm);
229extern int drm_mm_clean(struct drm_mm *mm);
249d6048
JG
230extern int drm_mm_pre_get(struct drm_mm *mm);
231
232static inline struct drm_mm *drm_get_mm(struct drm_mm_node *block)
233{
234 return block->mm;
235}
236
6b9d89b4
CW
237void drm_mm_init_scan(struct drm_mm *mm,
238 unsigned long size,
239 unsigned alignment,
240 unsigned long color);
241void drm_mm_init_scan_with_range(struct drm_mm *mm,
242 unsigned long size,
d935cc61 243 unsigned alignment,
6b9d89b4 244 unsigned long color,
d935cc61
DV
245 unsigned long start,
246 unsigned long end);
709ea971
DV
247int drm_mm_scan_add_block(struct drm_mm_node *node);
248int drm_mm_scan_remove_block(struct drm_mm_node *node);
249
99d7e48e 250extern void drm_mm_debug_table(struct drm_mm *mm, const char *prefix);
fa8a1238
DA
251#ifdef CONFIG_DEBUG_FS
252int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm);
253#endif
254
249d6048 255#endif