include/drm/ttm/ttm_placement.h

   1 /**************************************************************************
   2  *
   3  * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., 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  * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
  29  */
  30
  31 #ifndef _TTM_PLACEMENT_H_
  32 #define _TTM_PLACEMENT_H_
  33
  34 #include <linux/types.h>
  35
  36 /*
  37  * Memory regions for data placement.
  38  */
  39
  40 #define TTM_PL_SYSTEM           0
  41 #define TTM_PL_TT               1
  42 #define TTM_PL_VRAM             2
  43 #define TTM_PL_PRIV             3
  44
  45 #define TTM_PL_FLAG_SYSTEM      (1 << TTM_PL_SYSTEM)
  46 #define TTM_PL_FLAG_TT          (1 << TTM_PL_TT)
  47 #define TTM_PL_FLAG_VRAM        (1 << TTM_PL_VRAM)
  48 #define TTM_PL_FLAG_PRIV        (1 << TTM_PL_PRIV)
  49 #define TTM_PL_MASK_MEM         0x0000FFFF
  50
  51 /*
  52  * Other flags that affects data placement.
  53  * TTM_PL_FLAG_CACHED indicates cache-coherent mappings
  54  * if available.
  55  * TTM_PL_FLAG_SHARED means that another application may
  56  * reference the buffer.
  57  * TTM_PL_FLAG_NO_EVICT means that the buffer may never
  58  * be evicted to make room for other buffers.
  59  * TTM_PL_FLAG_TOPDOWN requests to be placed from the
  60  * top of the memory area, instead of the bottom.
  61  */
  62
  63 #define TTM_PL_FLAG_CACHED      (1 << 16)
  64 #define TTM_PL_FLAG_UNCACHED    (1 << 17)
  65 #define TTM_PL_FLAG_WC          (1 << 18)
  66 #define TTM_PL_FLAG_NO_EVICT    (1 << 21)
  67 #define TTM_PL_FLAG_TOPDOWN     (1 << 22)
  68
  69 #define TTM_PL_MASK_CACHING     (TTM_PL_FLAG_CACHED | \
  70                                  TTM_PL_FLAG_UNCACHED | \
  71                                  TTM_PL_FLAG_WC)
  72
  73 #define TTM_PL_MASK_MEMTYPE     (TTM_PL_MASK_MEM | TTM_PL_MASK_CACHING)
  74
  75 /**
  76  * struct ttm_place
  77  *
  78  * @fpfn:       first valid page frame number to put the object
  79  * @lpfn:       last valid page frame number to put the object
  80  * @flags:      memory domain and caching flags for the object
  81  *
  82  * Structure indicating a possible place to put an object.
  83  */
  84 struct ttm_place {
  85         unsigned        fpfn;
  86         unsigned        lpfn;
  87         uint32_t        flags;
  88 };
  89
  90 /**
  91  * struct ttm_placement
  92  *
  93  * @num_placement:      number of preferred placements
  94  * @placement:          preferred placements
  95  * @num_busy_placement: number of preferred placements when need to evict buffer
  96  * @busy_placement:     preferred placements when need to evict buffer
  97  *
  98  * Structure indicating the placement you request for an object.
  99  */
 100 struct ttm_placement {
 101         unsigned                num_placement;
 102         const struct ttm_place  *placement;
 103         unsigned                num_busy_placement;
 104         const struct ttm_place  *busy_placement;
 105 };
 106
 107 #endif