drm: mm: add api for embedding struct drm_mm_node
[linux-2.6.git] / include / drm / drm_mm.h
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 start;
54         unsigned long size;
55         struct drm_mm *mm;
56 };
57
58 struct drm_mm {
59         /* List of all memory nodes that immediatly preceed a free hole. */
60         struct list_head hole_stack;
61         /* head_node.node_list is the list of all memory nodes, ordered
62          * according to the (increasing) start address of the memory node. */
63         struct drm_mm_node head_node;
64         struct list_head unused_nodes;
65         int num_unused;
66         spinlock_t unused_lock;
67         unsigned int scan_check_range : 1;
68         unsigned scan_alignment;
69         unsigned long scan_size;
70         unsigned long scan_hit_start;
71         unsigned scan_hit_size;
72         unsigned scanned_blocks;
73         unsigned long scan_start;
74         unsigned long scan_end;
75 };
76
77 static inline bool drm_mm_node_allocated(struct drm_mm_node *node)
78 {
79         return node->allocated;
80 }
81
82 static inline bool drm_mm_initialized(struct drm_mm *mm)
83 {
84         return mm->hole_stack.next;
85 }
86 #define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \
87                                                 &(mm)->head_node.node_list, \
88                                                 node_list);
89 /*
90  * Basic range manager support (drm_mm.c)
91  */
92 extern struct drm_mm_node *drm_mm_get_block_generic(struct drm_mm_node *node,
93                                                     unsigned long size,
94                                                     unsigned alignment,
95                                                     int atomic);
96 extern struct drm_mm_node *drm_mm_get_block_range_generic(
97                                                 struct drm_mm_node *node,
98                                                 unsigned long size,
99                                                 unsigned alignment,
100                                                 unsigned long start,
101                                                 unsigned long end,
102                                                 int atomic);
103 static inline struct drm_mm_node *drm_mm_get_block(struct drm_mm_node *parent,
104                                                    unsigned long size,
105                                                    unsigned alignment)
106 {
107         return drm_mm_get_block_generic(parent, size, alignment, 0);
108 }
109 static inline struct drm_mm_node *drm_mm_get_block_atomic(struct drm_mm_node *parent,
110                                                           unsigned long size,
111                                                           unsigned alignment)
112 {
113         return drm_mm_get_block_generic(parent, size, alignment, 1);
114 }
115 static inline struct drm_mm_node *drm_mm_get_block_range(
116                                                 struct drm_mm_node *parent,
117                                                 unsigned long size,
118                                                 unsigned alignment,
119                                                 unsigned long start,
120                                                 unsigned long end)
121 {
122         return drm_mm_get_block_range_generic(parent, size, alignment,
123                                                 start, end, 0);
124 }
125 static inline struct drm_mm_node *drm_mm_get_block_atomic_range(
126                                                 struct drm_mm_node *parent,
127                                                 unsigned long size,
128                                                 unsigned alignment,
129                                                 unsigned long start,
130                                                 unsigned long end)
131 {
132         return drm_mm_get_block_range_generic(parent, size, alignment,
133                                                 start, end, 1);
134 }
135 extern int drm_mm_insert_node(struct drm_mm *mm, struct drm_mm_node *node,
136                               unsigned long size, unsigned alignment);
137 extern int drm_mm_insert_node_in_range(struct drm_mm *mm,
138                                        struct drm_mm_node *node,
139                                        unsigned long size, unsigned alignment,
140                                        unsigned long start, unsigned long end);
141 extern void drm_mm_put_block(struct drm_mm_node *cur);
142 extern void drm_mm_remove_node(struct drm_mm_node *node);
143 extern void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new);
144 extern struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm,
145                                               unsigned long size,
146                                               unsigned alignment,
147                                               int best_match);
148 extern struct drm_mm_node *drm_mm_search_free_in_range(
149                                                 const struct drm_mm *mm,
150                                                 unsigned long size,
151                                                 unsigned alignment,
152                                                 unsigned long start,
153                                                 unsigned long end,
154                                                 int best_match);
155 extern int drm_mm_init(struct drm_mm *mm, unsigned long start,
156                        unsigned long size);
157 extern void drm_mm_takedown(struct drm_mm *mm);
158 extern int drm_mm_clean(struct drm_mm *mm);
159 extern int drm_mm_pre_get(struct drm_mm *mm);
160
161 static inline struct drm_mm *drm_get_mm(struct drm_mm_node *block)
162 {
163         return block->mm;
164 }
165
166 void drm_mm_init_scan(struct drm_mm *mm, unsigned long size,
167                       unsigned alignment);
168 void drm_mm_init_scan_with_range(struct drm_mm *mm, unsigned long size,
169                                  unsigned alignment,
170                                  unsigned long start,
171                                  unsigned long end);
172 int drm_mm_scan_add_block(struct drm_mm_node *node);
173 int drm_mm_scan_remove_block(struct drm_mm_node *node);
174
175 extern void drm_mm_debug_table(struct drm_mm *mm, const char *prefix);
176 #ifdef CONFIG_DEBUG_FS
177 int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm);
178 #endif
179
180 #endif