1249d6048SJerome Glisse /************************************************************************** 2249d6048SJerome Glisse * 3249d6048SJerome Glisse * Copyright 2006-2008 Tungsten Graphics, Inc., Cedar Park, TX. USA. 4249d6048SJerome Glisse * All Rights Reserved. 5249d6048SJerome Glisse * 6249d6048SJerome Glisse * Permission is hereby granted, free of charge, to any person obtaining a 7249d6048SJerome Glisse * copy of this software and associated documentation files (the 8249d6048SJerome Glisse * "Software"), to deal in the Software without restriction, including 9249d6048SJerome Glisse * without limitation the rights to use, copy, modify, merge, publish, 10249d6048SJerome Glisse * distribute, sub license, and/or sell copies of the Software, and to 11249d6048SJerome Glisse * permit persons to whom the Software is furnished to do so, subject to 12249d6048SJerome Glisse * the following conditions: 13249d6048SJerome Glisse * 14249d6048SJerome Glisse * The above copyright notice and this permission notice (including the 15249d6048SJerome Glisse * next paragraph) shall be included in all copies or substantial portions 16249d6048SJerome Glisse * of the Software. 17249d6048SJerome Glisse * 18249d6048SJerome Glisse * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 19249d6048SJerome Glisse * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 20249d6048SJerome Glisse * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL 21249d6048SJerome Glisse * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, 22249d6048SJerome Glisse * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 23249d6048SJerome Glisse * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE 24249d6048SJerome Glisse * USE OR OTHER DEALINGS IN THE SOFTWARE. 25249d6048SJerome Glisse * 26249d6048SJerome Glisse * 27249d6048SJerome Glisse **************************************************************************/ 28249d6048SJerome Glisse /* 29249d6048SJerome Glisse * Authors: 30249d6048SJerome Glisse * Thomas Hellstrom <thomas-at-tungstengraphics-dot-com> 31249d6048SJerome Glisse */ 32249d6048SJerome Glisse 33249d6048SJerome Glisse #ifndef _DRM_MM_H_ 34249d6048SJerome Glisse #define _DRM_MM_H_ 35249d6048SJerome Glisse 36249d6048SJerome Glisse /* 37249d6048SJerome Glisse * Generic range manager structs 38249d6048SJerome Glisse */ 39249d6048SJerome Glisse #include <linux/list.h> 40f1938cd6SDave Airlie #ifdef CONFIG_DEBUG_FS 41f1938cd6SDave Airlie #include <linux/seq_file.h> 42f1938cd6SDave Airlie #endif 43249d6048SJerome Glisse 44249d6048SJerome Glisse struct drm_mm_node { 45d1024ce9SDaniel Vetter struct list_head node_list; 46ea7b1dd4SDaniel Vetter struct list_head hole_stack; 47ea7b1dd4SDaniel Vetter unsigned hole_follows : 1; 48709ea971SDaniel Vetter unsigned scanned_block : 1; 49709ea971SDaniel Vetter unsigned scanned_prev_free : 1; 50709ea971SDaniel Vetter unsigned scanned_next_free : 1; 51ea7b1dd4SDaniel Vetter unsigned scanned_preceeds_hole : 1; 52b0b7af18SDaniel Vetter unsigned allocated : 1; 536b9d89b4SChris Wilson unsigned long color; 54249d6048SJerome Glisse unsigned long start; 55249d6048SJerome Glisse unsigned long size; 56249d6048SJerome Glisse struct drm_mm *mm; 57249d6048SJerome Glisse }; 58249d6048SJerome Glisse 59249d6048SJerome Glisse struct drm_mm { 6025985edcSLucas De Marchi /* List of all memory nodes that immediately precede a free hole. */ 61ea7b1dd4SDaniel Vetter struct list_head hole_stack; 62ea7b1dd4SDaniel Vetter /* head_node.node_list is the list of all memory nodes, ordered 63ea7b1dd4SDaniel Vetter * according to the (increasing) start address of the memory node. */ 64ea7b1dd4SDaniel Vetter struct drm_mm_node head_node; 65249d6048SJerome Glisse struct list_head unused_nodes; 66249d6048SJerome Glisse int num_unused; 67249d6048SJerome Glisse spinlock_t unused_lock; 68d935cc61SDaniel Vetter unsigned int scan_check_range : 1; 69709ea971SDaniel Vetter unsigned scan_alignment; 706b9d89b4SChris Wilson unsigned long scan_color; 71709ea971SDaniel Vetter unsigned long scan_size; 72709ea971SDaniel Vetter unsigned long scan_hit_start; 73901593f2SChris Wilson unsigned long scan_hit_end; 74709ea971SDaniel Vetter unsigned scanned_blocks; 75d935cc61SDaniel Vetter unsigned long scan_start; 76d935cc61SDaniel Vetter unsigned long scan_end; 77ae0cec28SDaniel Vetter struct drm_mm_node *prev_scanned_node; 786b9d89b4SChris Wilson 796b9d89b4SChris Wilson void (*color_adjust)(struct drm_mm_node *node, unsigned long color, 806b9d89b4SChris Wilson unsigned long *start, unsigned long *end); 81249d6048SJerome Glisse }; 82249d6048SJerome Glisse 83b0b7af18SDaniel Vetter static inline bool drm_mm_node_allocated(struct drm_mm_node *node) 84b0b7af18SDaniel Vetter { 85b0b7af18SDaniel Vetter return node->allocated; 86b0b7af18SDaniel Vetter } 87b0b7af18SDaniel Vetter 8831a5b8ceSDaniel Vetter static inline bool drm_mm_initialized(struct drm_mm *mm) 8931a5b8ceSDaniel Vetter { 90ea7b1dd4SDaniel Vetter return mm->hole_stack.next; 9131a5b8ceSDaniel Vetter } 929e8944abSChris Wilson 939e8944abSChris Wilson static inline unsigned long __drm_mm_hole_node_start(struct drm_mm_node *hole_node) 949e8944abSChris Wilson { 959e8944abSChris Wilson return hole_node->start + hole_node->size; 969e8944abSChris Wilson } 979e8944abSChris Wilson 989e8944abSChris Wilson static inline unsigned long drm_mm_hole_node_start(struct drm_mm_node *hole_node) 999e8944abSChris Wilson { 1009e8944abSChris Wilson BUG_ON(!hole_node->hole_follows); 1019e8944abSChris Wilson return __drm_mm_hole_node_start(hole_node); 1029e8944abSChris Wilson } 1039e8944abSChris Wilson 1049e8944abSChris Wilson static inline unsigned long __drm_mm_hole_node_end(struct drm_mm_node *hole_node) 1059e8944abSChris Wilson { 1069e8944abSChris Wilson return list_entry(hole_node->node_list.next, 1079e8944abSChris Wilson struct drm_mm_node, node_list)->start; 1089e8944abSChris Wilson } 1099e8944abSChris Wilson 1109e8944abSChris Wilson static inline unsigned long drm_mm_hole_node_end(struct drm_mm_node *hole_node) 1119e8944abSChris Wilson { 1129e8944abSChris Wilson return __drm_mm_hole_node_end(hole_node); 1139e8944abSChris Wilson } 1149e8944abSChris Wilson 115ea7b1dd4SDaniel Vetter #define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \ 116ea7b1dd4SDaniel Vetter &(mm)->head_node.node_list, \ 1172bbd4492SDaniel Vetter node_list) 118ae0cec28SDaniel Vetter #define drm_mm_for_each_scanned_node_reverse(entry, n, mm) \ 119ae0cec28SDaniel Vetter for (entry = (mm)->prev_scanned_node, \ 120ae0cec28SDaniel Vetter next = entry ? list_entry(entry->node_list.next, \ 121ae0cec28SDaniel Vetter struct drm_mm_node, node_list) : NULL; \ 122ae0cec28SDaniel Vetter entry != NULL; entry = next, \ 123ae0cec28SDaniel Vetter next = entry ? list_entry(entry->node_list.next, \ 124ae0cec28SDaniel Vetter struct drm_mm_node, node_list) : NULL) \ 1259e8944abSChris Wilson 1269e8944abSChris Wilson /* Note that we need to unroll list_for_each_entry in order to inline 1279e8944abSChris Wilson * setting hole_start and hole_end on each iteration and keep the 1289e8944abSChris Wilson * macro sane. 1299e8944abSChris Wilson */ 1309e8944abSChris Wilson #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \ 1319e8944abSChris Wilson for (entry = list_entry((mm)->hole_stack.next, struct drm_mm_node, hole_stack); \ 1329e8944abSChris Wilson &entry->hole_stack != &(mm)->hole_stack ? \ 1339e8944abSChris Wilson hole_start = drm_mm_hole_node_start(entry), \ 1349e8944abSChris Wilson hole_end = drm_mm_hole_node_end(entry), \ 1359e8944abSChris Wilson 1 : 0; \ 1369e8944abSChris Wilson entry = list_entry(entry->hole_stack.next, struct drm_mm_node, hole_stack)) 1379e8944abSChris Wilson 138249d6048SJerome Glisse /* 139249d6048SJerome Glisse * Basic range manager support (drm_mm.c) 140249d6048SJerome Glisse */ 141338710e7SBen Widawsky extern int drm_mm_reserve_node(struct drm_mm *mm, struct drm_mm_node *node); 14289579f77SThomas Hellstrom extern struct drm_mm_node *drm_mm_get_block_generic(struct drm_mm_node *node, 143249d6048SJerome Glisse unsigned long size, 14489579f77SThomas Hellstrom unsigned alignment, 1456b9d89b4SChris Wilson unsigned long color, 14689579f77SThomas Hellstrom int atomic); 147a2e68e92SJerome Glisse extern struct drm_mm_node *drm_mm_get_block_range_generic( 148a2e68e92SJerome Glisse struct drm_mm_node *node, 149a2e68e92SJerome Glisse unsigned long size, 150a2e68e92SJerome Glisse unsigned alignment, 1516b9d89b4SChris Wilson unsigned long color, 152a2e68e92SJerome Glisse unsigned long start, 153a2e68e92SJerome Glisse unsigned long end, 154a2e68e92SJerome Glisse int atomic); 155b3a070ccSBen Widawsky 15689579f77SThomas Hellstrom static inline struct drm_mm_node *drm_mm_get_block(struct drm_mm_node *parent, 157249d6048SJerome Glisse unsigned long size, 15889579f77SThomas Hellstrom unsigned alignment) 15989579f77SThomas Hellstrom { 1606b9d89b4SChris Wilson return drm_mm_get_block_generic(parent, size, alignment, 0, 0); 16189579f77SThomas Hellstrom } 16289579f77SThomas Hellstrom static inline struct drm_mm_node *drm_mm_get_block_atomic(struct drm_mm_node *parent, 16389579f77SThomas Hellstrom unsigned long size, 16489579f77SThomas Hellstrom unsigned alignment) 16589579f77SThomas Hellstrom { 1666b9d89b4SChris Wilson return drm_mm_get_block_generic(parent, size, alignment, 0, 1); 16789579f77SThomas Hellstrom } 168a2e68e92SJerome Glisse static inline struct drm_mm_node *drm_mm_get_block_range( 169a2e68e92SJerome Glisse struct drm_mm_node *parent, 170a2e68e92SJerome Glisse unsigned long size, 171a2e68e92SJerome Glisse unsigned alignment, 172a2e68e92SJerome Glisse unsigned long start, 173a2e68e92SJerome Glisse unsigned long end) 174a2e68e92SJerome Glisse { 1756b9d89b4SChris Wilson return drm_mm_get_block_range_generic(parent, size, alignment, 0, 1766b9d89b4SChris Wilson start, end, 0); 1776b9d89b4SChris Wilson } 1786b9d89b4SChris Wilson static inline struct drm_mm_node *drm_mm_get_color_block_range( 1796b9d89b4SChris Wilson struct drm_mm_node *parent, 1806b9d89b4SChris Wilson unsigned long size, 1816b9d89b4SChris Wilson unsigned alignment, 1826b9d89b4SChris Wilson unsigned long color, 1836b9d89b4SChris Wilson unsigned long start, 1846b9d89b4SChris Wilson unsigned long end) 1856b9d89b4SChris Wilson { 1866b9d89b4SChris Wilson return drm_mm_get_block_range_generic(parent, size, alignment, color, 187a2e68e92SJerome Glisse start, end, 0); 188a2e68e92SJerome Glisse } 189a2e68e92SJerome Glisse static inline struct drm_mm_node *drm_mm_get_block_atomic_range( 190a2e68e92SJerome Glisse struct drm_mm_node *parent, 191a2e68e92SJerome Glisse unsigned long size, 192a2e68e92SJerome Glisse unsigned alignment, 193a2e68e92SJerome Glisse unsigned long start, 194a2e68e92SJerome Glisse unsigned long end) 195a2e68e92SJerome Glisse { 1966b9d89b4SChris Wilson return drm_mm_get_block_range_generic(parent, size, alignment, 0, 197a2e68e92SJerome Glisse start, end, 1); 198a2e68e92SJerome Glisse } 199b8103450SChris Wilson 200b8103450SChris Wilson extern int drm_mm_insert_node(struct drm_mm *mm, 201b8103450SChris Wilson struct drm_mm_node *node, 202b8103450SChris Wilson unsigned long size, 203b8103450SChris Wilson unsigned alignment); 204b0b7af18SDaniel Vetter extern int drm_mm_insert_node_in_range(struct drm_mm *mm, 205b0b7af18SDaniel Vetter struct drm_mm_node *node, 206b8103450SChris Wilson unsigned long size, 207b8103450SChris Wilson unsigned alignment, 208b8103450SChris Wilson unsigned long start, 209b8103450SChris Wilson unsigned long end); 210b8103450SChris Wilson extern int drm_mm_insert_node_generic(struct drm_mm *mm, 211b8103450SChris Wilson struct drm_mm_node *node, 212b8103450SChris Wilson unsigned long size, 213b8103450SChris Wilson unsigned alignment, 214b8103450SChris Wilson unsigned long color); 215b8103450SChris Wilson extern int drm_mm_insert_node_in_range_generic(struct drm_mm *mm, 216b8103450SChris Wilson struct drm_mm_node *node, 217b8103450SChris Wilson unsigned long size, 218b8103450SChris Wilson unsigned alignment, 219b8103450SChris Wilson unsigned long color, 220b8103450SChris Wilson unsigned long start, 221b8103450SChris Wilson unsigned long end); 222249d6048SJerome Glisse extern void drm_mm_put_block(struct drm_mm_node *cur); 223b0b7af18SDaniel Vetter extern void drm_mm_remove_node(struct drm_mm_node *node); 224b0b7af18SDaniel Vetter extern void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new); 2256b9d89b4SChris Wilson extern struct drm_mm_node *drm_mm_search_free_generic(const struct drm_mm *mm, 226249d6048SJerome Glisse unsigned long size, 227249d6048SJerome Glisse unsigned alignment, 2286b9d89b4SChris Wilson unsigned long color, 2296b9d89b4SChris Wilson bool best_match); 2306b9d89b4SChris Wilson extern struct drm_mm_node *drm_mm_search_free_in_range_generic( 2316b9d89b4SChris Wilson const struct drm_mm *mm, 2326b9d89b4SChris Wilson unsigned long size, 2336b9d89b4SChris Wilson unsigned alignment, 2346b9d89b4SChris Wilson unsigned long color, 2356b9d89b4SChris Wilson unsigned long start, 2366b9d89b4SChris Wilson unsigned long end, 2376b9d89b4SChris Wilson bool best_match); 2386b9d89b4SChris Wilson static inline struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm, 2396b9d89b4SChris Wilson unsigned long size, 2406b9d89b4SChris Wilson unsigned alignment, 2416b9d89b4SChris Wilson bool best_match) 2426b9d89b4SChris Wilson { 2436b9d89b4SChris Wilson return drm_mm_search_free_generic(mm,size, alignment, 0, best_match); 2446b9d89b4SChris Wilson } 2456b9d89b4SChris Wilson static inline struct drm_mm_node *drm_mm_search_free_in_range( 246a2e68e92SJerome Glisse const struct drm_mm *mm, 247a2e68e92SJerome Glisse unsigned long size, 248a2e68e92SJerome Glisse unsigned alignment, 249a2e68e92SJerome Glisse unsigned long start, 250a2e68e92SJerome Glisse unsigned long end, 2516b9d89b4SChris Wilson bool best_match) 2526b9d89b4SChris Wilson { 2536b9d89b4SChris Wilson return drm_mm_search_free_in_range_generic(mm, size, alignment, 0, 2546b9d89b4SChris Wilson start, end, best_match); 2556b9d89b4SChris Wilson } 2566b9d89b4SChris Wilson static inline struct drm_mm_node *drm_mm_search_free_color(const struct drm_mm *mm, 2576b9d89b4SChris Wilson unsigned long size, 2586b9d89b4SChris Wilson unsigned alignment, 2596b9d89b4SChris Wilson unsigned long color, 2606b9d89b4SChris Wilson bool best_match) 2616b9d89b4SChris Wilson { 2626b9d89b4SChris Wilson return drm_mm_search_free_generic(mm,size, alignment, color, best_match); 2636b9d89b4SChris Wilson } 2646b9d89b4SChris Wilson static inline struct drm_mm_node *drm_mm_search_free_in_range_color( 2656b9d89b4SChris Wilson const struct drm_mm *mm, 2666b9d89b4SChris Wilson unsigned long size, 2676b9d89b4SChris Wilson unsigned alignment, 2686b9d89b4SChris Wilson unsigned long color, 2696b9d89b4SChris Wilson unsigned long start, 2706b9d89b4SChris Wilson unsigned long end, 2716b9d89b4SChris Wilson bool best_match) 2726b9d89b4SChris Wilson { 2736b9d89b4SChris Wilson return drm_mm_search_free_in_range_generic(mm, size, alignment, color, 2746b9d89b4SChris Wilson start, end, best_match); 2756b9d89b4SChris Wilson } 2766b9d89b4SChris Wilson extern int drm_mm_init(struct drm_mm *mm, 2776b9d89b4SChris Wilson unsigned long start, 278249d6048SJerome Glisse unsigned long size); 279249d6048SJerome Glisse extern void drm_mm_takedown(struct drm_mm *mm); 280249d6048SJerome Glisse extern int drm_mm_clean(struct drm_mm *mm); 281249d6048SJerome Glisse extern int drm_mm_pre_get(struct drm_mm *mm); 282249d6048SJerome Glisse 283249d6048SJerome Glisse static inline struct drm_mm *drm_get_mm(struct drm_mm_node *block) 284249d6048SJerome Glisse { 285249d6048SJerome Glisse return block->mm; 286249d6048SJerome Glisse } 287249d6048SJerome Glisse 2886b9d89b4SChris Wilson void drm_mm_init_scan(struct drm_mm *mm, 2896b9d89b4SChris Wilson unsigned long size, 290d935cc61SDaniel Vetter unsigned alignment, 2916b9d89b4SChris Wilson unsigned long color); 2926b9d89b4SChris Wilson void drm_mm_init_scan_with_range(struct drm_mm *mm, 2936b9d89b4SChris Wilson unsigned long size, 2946b9d89b4SChris Wilson unsigned alignment, 2956b9d89b4SChris Wilson unsigned long color, 296d935cc61SDaniel Vetter unsigned long start, 297d935cc61SDaniel Vetter unsigned long end); 298709ea971SDaniel Vetter int drm_mm_scan_add_block(struct drm_mm_node *node); 299709ea971SDaniel Vetter int drm_mm_scan_remove_block(struct drm_mm_node *node); 300709ea971SDaniel Vetter 30199d7e48eSJerome Glisse extern void drm_mm_debug_table(struct drm_mm *mm, const char *prefix); 302fa8a1238SDave Airlie #ifdef CONFIG_DEBUG_FS 303fa8a1238SDave Airlie int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm); 304fa8a1238SDave Airlie #endif 305fa8a1238SDave Airlie 306249d6048SJerome Glisse #endif 307