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