xref: /dragonfly/sys/dev/drm/include/drm/drm_mm.h (revision 82730a9c)
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  * $FreeBSD: head/sys/dev/drm2/drm_mm.h 247833 2013-03-05 09:07:58Z kib $
28  **************************************************************************/
29 
30 /*
31  * Authors:
32  * Thomas Hellstrom <thomas-at-tungstengraphics-dot-com>
33  */
34 
35 #ifndef _DRM_MM_H_
36 #define _DRM_MM_H_
37 
38 #include <stdbool.h>
39 #include <linux/list.h>
40 
41 struct drm_mm_node {
42 	struct list_head node_list;
43 	struct list_head hole_stack;
44 	unsigned hole_follows : 1;
45 	unsigned scanned_block : 1;
46 	unsigned scanned_prev_free : 1;
47 	unsigned scanned_next_free : 1;
48 	unsigned scanned_preceeds_hole : 1;
49 	unsigned allocated : 1;
50 	unsigned long start;
51 	unsigned long size;
52 	struct drm_mm *mm;
53 	void *private;
54 };
55 
56 struct drm_mm {
57 	struct list_head hole_stack;
58 	struct drm_mm_node head_node;
59 	struct list_head unused_nodes;
60 	int num_unused;
61 	struct spinlock unused_spin;
62 	unsigned int scan_check_range : 1;
63 	unsigned scan_alignment;
64 	unsigned long scan_size;
65 	unsigned long scan_hit_start;
66 	unsigned scan_hit_size;
67 	unsigned scanned_blocks;
68 	unsigned long scan_start;
69 	unsigned long scan_end;
70 	struct drm_mm_node *prev_scanned_node;
71 };
72 
73 static inline bool drm_mm_node_allocated(struct drm_mm_node *node)
74 {
75 	return node->allocated;
76 }
77 
78 static inline bool drm_mm_initialized(struct drm_mm *mm)
79 {
80 	return (mm->hole_stack.next != NULL);
81 }
82 #define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \
83 						&(mm)->head_node.node_list, \
84 						node_list)
85 #define drm_mm_for_each_scanned_node_reverse(entry, n, mm) \
86 	for (entry = (mm)->prev_scanned_node, \
87 		next = entry ? list_entry(entry->node_list.next, \
88 			struct drm_mm_node, node_list) : NULL; \
89 	     entry != NULL; entry = next, \
90 		next = entry ? list_entry(entry->node_list.next, \
91 			struct drm_mm_node, node_list) : NULL)
92 
93 /*
94  * Basic range manager support (drm_mm.c)
95  */
96 extern struct drm_mm_node *drm_mm_get_block_generic(struct drm_mm_node *node,
97 						    unsigned long size,
98 						    unsigned alignment,
99 						    int atomic);
100 extern struct drm_mm_node *drm_mm_get_block_range_generic(
101 						struct drm_mm_node *node,
102 						unsigned long size,
103 						unsigned alignment,
104 						unsigned long start,
105 						unsigned long end,
106 						int atomic);
107 static inline struct drm_mm_node *drm_mm_get_block(struct drm_mm_node *parent,
108 						   unsigned long size,
109 						   unsigned alignment)
110 {
111 	return drm_mm_get_block_generic(parent, size, alignment, 0);
112 }
113 static inline struct drm_mm_node *drm_mm_get_block_atomic(struct drm_mm_node *parent,
114 							  unsigned long size,
115 							  unsigned alignment)
116 {
117 	return drm_mm_get_block_generic(parent, size, alignment, 1);
118 }
119 static inline struct drm_mm_node *drm_mm_get_block_range(
120 						struct drm_mm_node *parent,
121 						unsigned long size,
122 						unsigned alignment,
123 						unsigned long start,
124 						unsigned long end)
125 {
126 	return drm_mm_get_block_range_generic(parent, size, alignment,
127 						start, end, 0);
128 }
129 static inline struct drm_mm_node *drm_mm_get_block_atomic_range(
130 						struct drm_mm_node *parent,
131 						unsigned long size,
132 						unsigned alignment,
133 						unsigned long start,
134 						unsigned long end)
135 {
136 	return drm_mm_get_block_range_generic(parent, size, alignment,
137 						start, end, 1);
138 }
139 extern int drm_mm_insert_node(struct drm_mm *mm, struct drm_mm_node *node,
140 			      unsigned long size, unsigned alignment);
141 extern int drm_mm_insert_node_in_range(struct drm_mm *mm,
142 				       struct drm_mm_node *node,
143 				       unsigned long size, unsigned alignment,
144 				       unsigned long start, unsigned long end);
145 extern void drm_mm_put_block(struct drm_mm_node *cur);
146 extern void drm_mm_remove_node(struct drm_mm_node *node);
147 extern void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new);
148 extern struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm,
149 					      unsigned long size,
150 					      unsigned alignment,
151 					      int best_match);
152 extern struct drm_mm_node *drm_mm_search_free_in_range(
153 						const struct drm_mm *mm,
154 						unsigned long size,
155 						unsigned alignment,
156 						unsigned long start,
157 						unsigned long end,
158 						int best_match);
159 extern int drm_mm_init(struct drm_mm *mm, unsigned long start,
160 		       unsigned long size);
161 extern void drm_mm_takedown(struct drm_mm *mm);
162 extern int drm_mm_clean(struct drm_mm *mm);
163 extern unsigned long drm_mm_tail_space(struct drm_mm *mm);
164 extern int drm_mm_remove_space_from_tail(struct drm_mm *mm,
165 					 unsigned long size);
166 extern int drm_mm_add_space_to_tail(struct drm_mm *mm,
167 				    unsigned long size, int atomic);
168 extern int drm_mm_pre_get(struct drm_mm *mm);
169 
170 static inline struct drm_mm *drm_get_mm(struct drm_mm_node *block)
171 {
172 	return block->mm;
173 }
174 
175 void drm_mm_init_scan(struct drm_mm *mm, unsigned long size,
176 		      unsigned alignment);
177 void drm_mm_init_scan_with_range(struct drm_mm *mm, unsigned long size,
178 				 unsigned alignment,
179 				 unsigned long start,
180 				 unsigned long end);
181 int drm_mm_scan_add_block(struct drm_mm_node *node);
182 int drm_mm_scan_remove_block(struct drm_mm_node *node);
183 
184 void drm_mm_debug_table(struct drm_mm *mm, const char *prefix);
185 
186 #endif
187