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; 73709ea971SDaniel Vetter unsigned scan_hit_size; 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 */ 1415973c7eeSChris Wilson extern struct drm_mm_node *drm_mm_create_block(struct drm_mm *mm, 1425973c7eeSChris Wilson unsigned long start, 1435973c7eeSChris Wilson unsigned long size, 1445973c7eeSChris Wilson bool atomic); 14589579f77SThomas Hellstrom extern struct drm_mm_node *drm_mm_get_block_generic(struct drm_mm_node *node, 146249d6048SJerome Glisse unsigned long size, 14789579f77SThomas Hellstrom unsigned alignment, 1486b9d89b4SChris Wilson unsigned long color, 14989579f77SThomas Hellstrom int atomic); 150a2e68e92SJerome Glisse extern struct drm_mm_node *drm_mm_get_block_range_generic( 151a2e68e92SJerome Glisse struct drm_mm_node *node, 152a2e68e92SJerome Glisse unsigned long size, 153a2e68e92SJerome Glisse unsigned alignment, 1546b9d89b4SChris Wilson unsigned long color, 155a2e68e92SJerome Glisse unsigned long start, 156a2e68e92SJerome Glisse unsigned long end, 157a2e68e92SJerome Glisse int atomic); 15889579f77SThomas Hellstrom static inline struct drm_mm_node *drm_mm_get_block(struct drm_mm_node *parent, 159249d6048SJerome Glisse unsigned long size, 16089579f77SThomas Hellstrom unsigned alignment) 16189579f77SThomas Hellstrom { 1626b9d89b4SChris Wilson return drm_mm_get_block_generic(parent, size, alignment, 0, 0); 16389579f77SThomas Hellstrom } 16489579f77SThomas Hellstrom static inline struct drm_mm_node *drm_mm_get_block_atomic(struct drm_mm_node *parent, 16589579f77SThomas Hellstrom unsigned long size, 16689579f77SThomas Hellstrom unsigned alignment) 16789579f77SThomas Hellstrom { 1686b9d89b4SChris Wilson return drm_mm_get_block_generic(parent, size, alignment, 0, 1); 16989579f77SThomas Hellstrom } 170a2e68e92SJerome Glisse static inline struct drm_mm_node *drm_mm_get_block_range( 171a2e68e92SJerome Glisse struct drm_mm_node *parent, 172a2e68e92SJerome Glisse unsigned long size, 173a2e68e92SJerome Glisse unsigned alignment, 174a2e68e92SJerome Glisse unsigned long start, 175a2e68e92SJerome Glisse unsigned long end) 176a2e68e92SJerome Glisse { 1776b9d89b4SChris Wilson return drm_mm_get_block_range_generic(parent, size, alignment, 0, 1786b9d89b4SChris Wilson start, end, 0); 1796b9d89b4SChris Wilson } 1806b9d89b4SChris Wilson static inline struct drm_mm_node *drm_mm_get_color_block_range( 1816b9d89b4SChris Wilson struct drm_mm_node *parent, 1826b9d89b4SChris Wilson unsigned long size, 1836b9d89b4SChris Wilson unsigned alignment, 1846b9d89b4SChris Wilson unsigned long color, 1856b9d89b4SChris Wilson unsigned long start, 1866b9d89b4SChris Wilson unsigned long end) 1876b9d89b4SChris Wilson { 1886b9d89b4SChris Wilson return drm_mm_get_block_range_generic(parent, size, alignment, color, 189a2e68e92SJerome Glisse start, end, 0); 190a2e68e92SJerome Glisse } 191a2e68e92SJerome Glisse static inline struct drm_mm_node *drm_mm_get_block_atomic_range( 192a2e68e92SJerome Glisse struct drm_mm_node *parent, 193a2e68e92SJerome Glisse unsigned long size, 194a2e68e92SJerome Glisse unsigned alignment, 195a2e68e92SJerome Glisse unsigned long start, 196a2e68e92SJerome Glisse unsigned long end) 197a2e68e92SJerome Glisse { 1986b9d89b4SChris Wilson return drm_mm_get_block_range_generic(parent, size, alignment, 0, 199a2e68e92SJerome Glisse start, end, 1); 200a2e68e92SJerome Glisse } 201b0b7af18SDaniel Vetter extern int drm_mm_insert_node(struct drm_mm *mm, struct drm_mm_node *node, 202b0b7af18SDaniel Vetter unsigned long size, unsigned alignment); 203b0b7af18SDaniel Vetter extern int drm_mm_insert_node_in_range(struct drm_mm *mm, 204b0b7af18SDaniel Vetter struct drm_mm_node *node, 205b0b7af18SDaniel Vetter unsigned long size, unsigned alignment, 206b0b7af18SDaniel Vetter unsigned long start, unsigned long end); 207249d6048SJerome Glisse extern void drm_mm_put_block(struct drm_mm_node *cur); 208b0b7af18SDaniel Vetter extern void drm_mm_remove_node(struct drm_mm_node *node); 209b0b7af18SDaniel Vetter extern void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new); 2106b9d89b4SChris Wilson extern struct drm_mm_node *drm_mm_search_free_generic(const struct drm_mm *mm, 211249d6048SJerome Glisse unsigned long size, 212249d6048SJerome Glisse unsigned alignment, 2136b9d89b4SChris Wilson unsigned long color, 2146b9d89b4SChris Wilson bool best_match); 2156b9d89b4SChris Wilson extern struct drm_mm_node *drm_mm_search_free_in_range_generic( 2166b9d89b4SChris Wilson const struct drm_mm *mm, 2176b9d89b4SChris Wilson unsigned long size, 2186b9d89b4SChris Wilson unsigned alignment, 2196b9d89b4SChris Wilson unsigned long color, 2206b9d89b4SChris Wilson unsigned long start, 2216b9d89b4SChris Wilson unsigned long end, 2226b9d89b4SChris Wilson bool best_match); 2236b9d89b4SChris Wilson static inline struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm, 2246b9d89b4SChris Wilson unsigned long size, 2256b9d89b4SChris Wilson unsigned alignment, 2266b9d89b4SChris Wilson bool best_match) 2276b9d89b4SChris Wilson { 2286b9d89b4SChris Wilson return drm_mm_search_free_generic(mm,size, alignment, 0, best_match); 2296b9d89b4SChris Wilson } 2306b9d89b4SChris Wilson static inline struct drm_mm_node *drm_mm_search_free_in_range( 231a2e68e92SJerome Glisse const struct drm_mm *mm, 232a2e68e92SJerome Glisse unsigned long size, 233a2e68e92SJerome Glisse unsigned alignment, 234a2e68e92SJerome Glisse unsigned long start, 235a2e68e92SJerome Glisse unsigned long end, 2366b9d89b4SChris Wilson bool best_match) 2376b9d89b4SChris Wilson { 2386b9d89b4SChris Wilson return drm_mm_search_free_in_range_generic(mm, size, alignment, 0, 2396b9d89b4SChris Wilson start, end, best_match); 2406b9d89b4SChris Wilson } 2416b9d89b4SChris Wilson static inline struct drm_mm_node *drm_mm_search_free_color(const struct drm_mm *mm, 2426b9d89b4SChris Wilson unsigned long size, 2436b9d89b4SChris Wilson unsigned alignment, 2446b9d89b4SChris Wilson unsigned long color, 2456b9d89b4SChris Wilson bool best_match) 2466b9d89b4SChris Wilson { 2476b9d89b4SChris Wilson return drm_mm_search_free_generic(mm,size, alignment, color, best_match); 2486b9d89b4SChris Wilson } 2496b9d89b4SChris Wilson static inline struct drm_mm_node *drm_mm_search_free_in_range_color( 2506b9d89b4SChris Wilson const struct drm_mm *mm, 2516b9d89b4SChris Wilson unsigned long size, 2526b9d89b4SChris Wilson unsigned alignment, 2536b9d89b4SChris Wilson unsigned long color, 2546b9d89b4SChris Wilson unsigned long start, 2556b9d89b4SChris Wilson unsigned long end, 2566b9d89b4SChris Wilson bool best_match) 2576b9d89b4SChris Wilson { 2586b9d89b4SChris Wilson return drm_mm_search_free_in_range_generic(mm, size, alignment, color, 2596b9d89b4SChris Wilson start, end, best_match); 2606b9d89b4SChris Wilson } 2616b9d89b4SChris Wilson extern int drm_mm_init(struct drm_mm *mm, 2626b9d89b4SChris Wilson unsigned long start, 263249d6048SJerome Glisse unsigned long size); 264249d6048SJerome Glisse extern void drm_mm_takedown(struct drm_mm *mm); 265249d6048SJerome Glisse extern int drm_mm_clean(struct drm_mm *mm); 266249d6048SJerome Glisse extern int drm_mm_pre_get(struct drm_mm *mm); 267249d6048SJerome Glisse 268249d6048SJerome Glisse static inline struct drm_mm *drm_get_mm(struct drm_mm_node *block) 269249d6048SJerome Glisse { 270249d6048SJerome Glisse return block->mm; 271249d6048SJerome Glisse } 272249d6048SJerome Glisse 2736b9d89b4SChris Wilson void drm_mm_init_scan(struct drm_mm *mm, 2746b9d89b4SChris Wilson unsigned long size, 275d935cc61SDaniel Vetter unsigned alignment, 2766b9d89b4SChris Wilson unsigned long color); 2776b9d89b4SChris Wilson void drm_mm_init_scan_with_range(struct drm_mm *mm, 2786b9d89b4SChris Wilson unsigned long size, 2796b9d89b4SChris Wilson unsigned alignment, 2806b9d89b4SChris Wilson unsigned long color, 281d935cc61SDaniel Vetter unsigned long start, 282d935cc61SDaniel Vetter unsigned long end); 283709ea971SDaniel Vetter int drm_mm_scan_add_block(struct drm_mm_node *node); 284709ea971SDaniel Vetter int drm_mm_scan_remove_block(struct drm_mm_node *node); 285709ea971SDaniel Vetter 28699d7e48eSJerome Glisse extern void drm_mm_debug_table(struct drm_mm *mm, const char *prefix); 287fa8a1238SDave Airlie #ifdef CONFIG_DEBUG_FS 288fa8a1238SDave Airlie int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm); 289fa8a1238SDave Airlie #endif 290fa8a1238SDave Airlie 291249d6048SJerome Glisse #endif 292