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