include/drm/drm_mm.h

   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 allocated : 1;
  53         unsigned long color;
  54         unsigned long start;
  55         unsigned long size;
  56         struct drm_mm *mm;
  57 };
  58
  59 struct drm_mm {
  60         /* List of all memory nodes that immediately precede a free hole. */
  61         struct list_head hole_stack;
  62         /* head_node.node_list is the list of all memory nodes, ordered
  63          * according to the (increasing) start address of the memory node. */
  64         struct drm_mm_node head_node;
  65         struct list_head unused_nodes;
  66         int num_unused;
  67         spinlock_t unused_lock;
  68         unsigned int scan_check_range : 1;
  69         unsigned scan_alignment;
  70         unsigned long scan_color;
  71         unsigned long scan_size;
  72         unsigned long scan_hit_start;
  73         unsigned long scan_hit_end;
  74         unsigned scanned_blocks;
  75         unsigned long scan_start;
  76         unsigned long scan_end;
  77         struct drm_mm_node *prev_scanned_node;
  78
  79         void (*color_adjust)(struct drm_mm_node *node, unsigned long color,
  80                              unsigned long *start, unsigned long *end);
  81 };
  82
  83 static inline bool drm_mm_node_allocated(struct drm_mm_node *node)
  84 {
  85         return node->allocated;
  86 }
  87
  88 static inline bool drm_mm_initialized(struct drm_mm *mm)
  89 {
  90         return mm->hole_stack.next;
  91 }
  92
  93 static inline unsigned long __drm_mm_hole_node_start(struct drm_mm_node *hole_node)
  94 {
  95         return hole_node->start + hole_node->size;
  96 }
  97
  98 static inline unsigned long drm_mm_hole_node_start(struct drm_mm_node *hole_node)
  99 {
 100         BUG_ON(!hole_node->hole_follows);
 101         return __drm_mm_hole_node_start(hole_node);
 102 }
 103
 104 static inline unsigned long __drm_mm_hole_node_end(struct drm_mm_node *hole_node)
 105 {
 106         return list_entry(hole_node->node_list.next,
 107                           struct drm_mm_node, node_list)->start;
 108 }
 109
 110 static inline unsigned long drm_mm_hole_node_end(struct drm_mm_node *hole_node)
 111 {
 112         return __drm_mm_hole_node_end(hole_node);
 113 }
 114
 115 #define drm_mm_for_each_node(entry, mm) list_for_each_entry(entry, \
 116                                                 &(mm)->head_node.node_list, \
 117                                                 node_list)
 118 #define drm_mm_for_each_scanned_node_reverse(entry, n, mm) \
 119         for (entry = (mm)->prev_scanned_node, \
 120                 next = entry ? list_entry(entry->node_list.next, \
 121                         struct drm_mm_node, node_list) : NULL; \
 122              entry != NULL; entry = next, \
 123                 next = entry ? list_entry(entry->node_list.next, \
 124                         struct drm_mm_node, node_list) : NULL) \
 125
 126 /* Note that we need to unroll list_for_each_entry in order to inline
 127  * setting hole_start and hole_end on each iteration and keep the
 128  * macro sane.
 129  */
 130 #define drm_mm_for_each_hole(entry, mm, hole_start, hole_end) \
 131         for (entry = list_entry((mm)->hole_stack.next, struct drm_mm_node, hole_stack); \
 132              &entry->hole_stack != &(mm)->hole_stack ? \
 133              hole_start = drm_mm_hole_node_start(entry), \
 134              hole_end = drm_mm_hole_node_end(entry), \
 135              1 : 0; \
 136              entry = list_entry(entry->hole_stack.next, struct drm_mm_node, hole_stack))
 137
 138 /*
 139  * Basic range manager support (drm_mm.c)
 140  */
 141 extern struct drm_mm_node *drm_mm_create_block(struct drm_mm *mm,
 142                                                unsigned long start,
 143                                                unsigned long size,
 144                                                bool atomic);
 145 extern struct drm_mm_node *drm_mm_get_block_generic(struct drm_mm_node *node,
 146                                                     unsigned long size,
 147                                                     unsigned alignment,
 148                                                     unsigned long color,
 149                                                     int atomic);
 150 extern struct drm_mm_node *drm_mm_get_block_range_generic(
 151                                                 struct drm_mm_node *node,
 152                                                 unsigned long size,
 153                                                 unsigned alignment,
 154                                                 unsigned long color,
 155                                                 unsigned long start,
 156                                                 unsigned long end,
 157                                                 int atomic);
 158 static inline struct drm_mm_node *drm_mm_get_block(struct drm_mm_node *parent,
 159                                                    unsigned long size,
 160                                                    unsigned alignment)
 161 {
 162         return drm_mm_get_block_generic(parent, size, alignment, 0, 0);
 163 }
 164 static inline struct drm_mm_node *drm_mm_get_block_atomic(struct drm_mm_node *parent,
 165                                                           unsigned long size,
 166                                                           unsigned alignment)
 167 {
 168         return drm_mm_get_block_generic(parent, size, alignment, 0, 1);
 169 }
 170 static inline struct drm_mm_node *drm_mm_get_block_range(
 171                                                 struct drm_mm_node *parent,
 172                                                 unsigned long size,
 173                                                 unsigned alignment,
 174                                                 unsigned long start,
 175                                                 unsigned long end)
 176 {
 177         return drm_mm_get_block_range_generic(parent, size, alignment, 0,
 178                                               start, end, 0);
 179 }
 180 static inline struct drm_mm_node *drm_mm_get_color_block_range(
 181                                                 struct drm_mm_node *parent,
 182                                                 unsigned long size,
 183                                                 unsigned alignment,
 184                                                 unsigned long color,
 185                                                 unsigned long start,
 186                                                 unsigned long end)
 187 {
 188         return drm_mm_get_block_range_generic(parent, size, alignment, color,
 189                                               start, end, 0);
 190 }
 191 static inline struct drm_mm_node *drm_mm_get_block_atomic_range(
 192                                                 struct drm_mm_node *parent,
 193                                                 unsigned long size,
 194                                                 unsigned alignment,
 195                                                 unsigned long start,
 196                                                 unsigned long end)
 197 {
 198         return drm_mm_get_block_range_generic(parent, size, alignment, 0,
 199                                                 start, end, 1);
 200 }
 201
 202 extern int drm_mm_insert_node(struct drm_mm *mm,
 203                               struct drm_mm_node *node,
 204                               unsigned long size,
 205                               unsigned alignment);
 206 extern int drm_mm_insert_node_in_range(struct drm_mm *mm,
 207                                        struct drm_mm_node *node,
 208                                        unsigned long size,
 209                                        unsigned alignment,
 210                                        unsigned long start,
 211                                        unsigned long end);
 212 extern int drm_mm_insert_node_generic(struct drm_mm *mm,
 213                                       struct drm_mm_node *node,
 214                                       unsigned long size,
 215                                       unsigned alignment,
 216                                       unsigned long color);
 217 extern int drm_mm_insert_node_in_range_generic(struct drm_mm *mm,
 218                                        struct drm_mm_node *node,
 219                                        unsigned long size,
 220                                        unsigned alignment,
 221                                        unsigned long color,
 222                                        unsigned long start,
 223                                        unsigned long end);
 224 extern void drm_mm_put_block(struct drm_mm_node *cur);
 225 extern void drm_mm_remove_node(struct drm_mm_node *node);
 226 extern void drm_mm_replace_node(struct drm_mm_node *old, struct drm_mm_node *new);
 227 extern struct drm_mm_node *drm_mm_search_free_generic(const struct drm_mm *mm,
 228                                                       unsigned long size,
 229                                                       unsigned alignment,
 230                                                       unsigned long color,
 231                                                       bool best_match);
 232 extern struct drm_mm_node *drm_mm_search_free_in_range_generic(
 233                                                 const struct drm_mm *mm,
 234                                                 unsigned long size,
 235                                                 unsigned alignment,
 236                                                 unsigned long color,
 237                                                 unsigned long start,
 238                                                 unsigned long end,
 239                                                 bool best_match);
 240 static inline struct drm_mm_node *drm_mm_search_free(const struct drm_mm *mm,
 241                                                      unsigned long size,
 242                                                      unsigned alignment,
 243                                                      bool best_match)
 244 {
 245         return drm_mm_search_free_generic(mm,size, alignment, 0, best_match);
 246 }
 247 static inline  struct drm_mm_node *drm_mm_search_free_in_range(
 248                                                 const struct drm_mm *mm,
 249                                                 unsigned long size,
 250                                                 unsigned alignment,
 251                                                 unsigned long start,
 252                                                 unsigned long end,
 253                                                 bool best_match)
 254 {
 255         return drm_mm_search_free_in_range_generic(mm, size, alignment, 0,
 256                                                    start, end, best_match);
 257 }
 258 static inline struct drm_mm_node *drm_mm_search_free_color(const struct drm_mm *mm,
 259                                                            unsigned long size,
 260                                                            unsigned alignment,
 261                                                            unsigned long color,
 262                                                            bool best_match)
 263 {
 264         return drm_mm_search_free_generic(mm,size, alignment, color, best_match);
 265 }
 266 static inline  struct drm_mm_node *drm_mm_search_free_in_range_color(
 267                                                 const struct drm_mm *mm,
 268                                                 unsigned long size,
 269                                                 unsigned alignment,
 270                                                 unsigned long color,
 271                                                 unsigned long start,
 272                                                 unsigned long end,
 273                                                 bool best_match)
 274 {
 275         return drm_mm_search_free_in_range_generic(mm, size, alignment, color,
 276                                                    start, end, best_match);
 277 }
 278 extern int drm_mm_init(struct drm_mm *mm,
 279                        unsigned long start,
 280                        unsigned long size);
 281 extern void drm_mm_takedown(struct drm_mm *mm);
 282 extern int drm_mm_clean(struct drm_mm *mm);
 283 extern int drm_mm_pre_get(struct drm_mm *mm);
 284
 285 static inline struct drm_mm *drm_get_mm(struct drm_mm_node *block)
 286 {
 287         return block->mm;
 288 }
 289
 290 void drm_mm_init_scan(struct drm_mm *mm,
 291                       unsigned long size,
 292                       unsigned alignment,
 293                       unsigned long color);
 294 void drm_mm_init_scan_with_range(struct drm_mm *mm,
 295                                  unsigned long size,
 296                                  unsigned alignment,
 297                                  unsigned long color,
 298                                  unsigned long start,
 299                                  unsigned long end);
 300 int drm_mm_scan_add_block(struct drm_mm_node *node);
 301 int drm_mm_scan_remove_block(struct drm_mm_node *node);
 302
 303 extern void drm_mm_debug_table(struct drm_mm *mm, const char *prefix);
 304 #ifdef CONFIG_DEBUG_FS
 305 int drm_mm_dump_table(struct seq_file *m, struct drm_mm *mm);
 306 #endif
 307
 308 #endif