blob: cba67865d18f51adabf46f9a18c1071c4e47c19b [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 */
David Herrmann86e81f0e2013-07-25 18:02:31 +020039#include <linux/bug.h>
40#include <linux/kernel.h>
Jerome Glisse249d6042009-04-08 17:11:16 +020041#include <linux/list.h>
David Herrmann86e81f0e2013-07-25 18:02:31 +020042#include <linux/spinlock.h>
Dave Airlief1938cd2009-09-08 11:32:08 +100043#ifdef CONFIG_DEBUG_FS
44#include <linux/seq_file.h>
45#endif
Jerome Glisse249d6042009-04-08 17:11:16 +020046
David Herrmann31e5d7c2013-07-27 13:36:27 +020047enum drm_mm_search_flags {
48 DRM_MM_SEARCH_DEFAULT = 0,
49 DRM_MM_SEARCH_BEST = 1 << 0,
50};
51
Jerome Glisse249d6042009-04-08 17:11:16 +020052struct drm_mm_node {
Daniel Vetterd1024ce2010-07-02 15:02:14 +010053 struct list_head node_list;
Daniel Vetterea7b1dd2011-02-18 17:59:12 +010054 struct list_head hole_stack;
55 unsigned hole_follows : 1;
Daniel Vetter709ea972010-07-02 15:02:16 +010056 unsigned scanned_block : 1;
57 unsigned scanned_prev_free : 1;
58 unsigned scanned_next_free : 1;
Daniel Vetterea7b1dd2011-02-18 17:59:12 +010059 unsigned scanned_preceeds_hole : 1;
Daniel Vetterb0b7af12011-02-18 17:59:14 +010060 unsigned allocated : 1;
Chris Wilson6b9d89b2012-07-10 11:15:23 +010061 unsigned long color;
Jerome Glisse249d6042009-04-08 17:11:16 +020062 unsigned long start;
63 unsigned long size;
64 struct drm_mm *mm;
Jerome Glisse249d6042009-04-08 17:11:16 +020065};
66
67struct drm_mm {
Lucas De Marchi25985ed2011-03-30 22:57:33 -030068 /* List of all memory nodes that immediately precede a free hole. */
Daniel Vetterea7b1dd2011-02-18 17:59:12 +010069 struct list_head hole_stack;
70 /* head_node.node_list is the list of all memory nodes, ordered
71 * according to the (increasing) start address of the memory node. */
72 struct drm_mm_node head_node;
Daniel Vetterd935cc62010-09-16 15:13:11 +020073 unsigned int scan_check_range : 1;
Daniel Vetter709ea972010-07-02 15:02:16 +010074 unsigned scan_alignment;
Chris Wilson6b9d89b2012-07-10 11:15:23 +010075 unsigned long scan_color;
Daniel Vetter709ea972010-07-02 15:02:16 +010076 unsigned long scan_size;
77 unsigned long scan_hit_start;
Chris Wilson901593f2012-12-19 16:51:06 +000078 unsigned long scan_hit_end;
Daniel Vetter709ea972010-07-02 15:02:16 +010079 unsigned scanned_blocks;
Daniel Vetterd935cc62010-09-16 15:13:11 +020080 unsigned long scan_start;
81 unsigned long scan_end;
Daniel Vetterae0cec22011-02-18 17:59:15 +010082 struct drm_mm_node *prev_scanned_node;
Chris Wilson6b9d89b2012-07-10 11:15:23 +010083
84 void (*color_adjust)(struct drm_mm_node *node, unsigned long color,
85 unsigned long *start, unsigned long *end);
Jerome Glisse249d6042009-04-08 17:11:16 +020086};
87
Daniel Vetterb0b7af12011-02-18 17:59:14 +010088static inline bool drm_mm_node_allocated(struct drm_mm_node *node)
89{
90 return node->allocated;
91}
92
Daniel Vetter31a5b8c2011-02-18 17:59:11 +010093static inline bool drm_mm_initialized(struct drm_mm *mm)
94{
Daniel Vetterea7b1dd2011-02-18 17:59:12 +010095 return mm->hole_stack.next;
Daniel Vetter31a5b8c2011-02-18 17:59:11 +010096}
Chris Wilson9e8944a2012-11-15 11:32:17 +000097
98static inline unsigned long __drm_mm_hole_node_start(struct drm_mm_node *hole_node)
99{
100 return hole_node->start + hole_node->size;
101}
102
103static inline unsigned long drm_mm_hole_node_start(struct drm_mm_node *hole_node)
104{
105 BUG_ON(!hole_node->hole_follows);
106 return __drm_mm_hole_node_start(hole_node);
107}
108
109static inline unsigned long __drm_mm_hole_node_end(struct drm_mm_node *hole_node)
110{
111 return list_entry(hole_node->node_list.next,
112 struct drm_mm_node, node_list)->start;
113}
114
115static inline unsigned long drm_mm_hole_node_end(struct drm_mm_node *hole_node)
116{
117 return __drm_mm_hole_node_end(hole_node);
118}
119
Daniel Vetterea7b1dd2011-02-18 17:59:12 +0100120#define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \
121 &(mm)->head_node.node_list, \
Daniel Vetter2bbd4492011-05-06 23:47:53 +0200122 node_list)
Chris Wilson9e8944a2012-11-15 11:32:17 +0000123
124/* Note that we need to unroll list_for_each_entry in order to inline
125 * setting hole_start and hole_end on each iteration and keep the
126 * macro sane.
127 */
128#define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \
129 for (entry = list_entry((mm)->hole_stack.next, struct drm_mm_node, hole_stack); \
130 &entry->hole_stack != &(mm)->hole_stack ? \
131 hole_start = drm_mm_hole_node_start(entry), \
132 hole_end = drm_mm_hole_node_end(entry), \
133 1 : 0; \
134 entry = list_entry(entry->hole_stack.next, struct drm_mm_node, hole_stack))
135
Jerome Glisse249d6042009-04-08 17:11:16 +0200136/*
137 * Basic range manager support (drm_mm.c)
138 */
Ben Widawsky338710e2013-07-05 14:41:03 -0700139extern int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node);
Chris Wilsonb8103452012-12-07 20:37:06 +0000140
Chris Wilsonb8103452012-12-07 20:37:06 +0000141extern int drm_mm_insert_node_generic(struct drm_mm *mm,
142 struct drm_mm_node *node,
143 unsigned long size,
144 unsigned alignment,
David Herrmann31e5d7c2013-07-27 13:36:27 +0200145 unsigned long color,
146 enum drm_mm_search_flags flags);
147static inline int drm_mm_insert_node(struct drm_mm *mm,
148 struct drm_mm_node *node,
149 unsigned long size,
150 unsigned alignment,
151 enum drm_mm_search_flags flags)
152{
153 return drm_mm_insert_node_generic(mm, node, size, alignment, 0, flags);
154}
155
Chris Wilsonb8103452012-12-07 20:37:06 +0000156extern int drm_mm_insert_node_in_range_generic(struct drm_mm *mm,
157 struct drm_mm_node *node,
158 unsigned long size,
159 unsigned alignment,
160 unsigned long color,
161 unsigned long start,
David Herrmann31e5d7c2013-07-27 13:36:27 +0200162 unsigned long end,
163 enum drm_mm_search_flags flags);
164static inline int drm_mm_insert_node_in_range(struct drm_mm *mm,
165 struct drm_mm_node *node,
166 unsigned long size,
167 unsigned alignment,
168 unsigned long start,
169 unsigned long end,
170 enum drm_mm_search_flags flags)
171{
172 return drm_mm_insert_node_in_range_generic(mm, node, size, alignment,
173 0, start, end, flags);
174}
175
Daniel Vetterb0b7af12011-02-18 17:59:14 +0100176extern void drm_mm_remove_node(struct drm_mm_node *node);
177extern void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new);
David Herrmann77ef8bb2013-07-01 20:32:58 +0200178extern void drm_mm_init(struct drm_mm *mm,
179 unsigned long start,
180 unsigned long size);
Jerome Glisse249d6042009-04-08 17:11:16 +0200181extern void drm_mm_takedown(struct drm_mm *mm);
182extern int drm_mm_clean(struct drm_mm *mm);
Jerome Glisse249d6042009-04-08 17:11:16 +0200183
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100184void drm_mm_init_scan(struct drm_mm *mm,
185 unsigned long size,
186 unsigned alignment,
187 unsigned long color);
188void drm_mm_init_scan_with_range(struct drm_mm *mm,
189 unsigned long size,
Daniel Vetterd935cc62010-09-16 15:13:11 +0200190 unsigned alignment,
Chris Wilson6b9d89b2012-07-10 11:15:23 +0100191 unsigned long color,
Daniel Vetterd935cc62010-09-16 15:13:11 +0200192 unsigned long start,
193 unsigned long end);
Daniel Vetter709ea972010-07-02 15:02:16 +0100194int drm_mm_scan_add_block(struct drm_mm_node *node);
195int drm_mm_scan_remove_block(struct drm_mm_node *node);
196
Jerome Glisse99d7e482009-12-09 21:55:09 +0100197extern void drm_mm_debug_table(struct drm_mm *mm, const char *prefix);
Dave Airliefa8a1232009-08-26 13:13:37 +1000198#ifdef CONFIG_DEBUG_FS
199int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm);
200#endif
201
Jerome Glisse249d6042009-04-08 17:11:16 +0200202#endif