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 /*
  46  * TTM_PL_FLAG_TOPDOWN requests to be placed from the
  47  * top of the memory area, instead of the bottom.
  48  */
  49
  50 #define TTM_PL_FLAG_CONTIGUOUS  (1 << 0)
  51 #define TTM_PL_FLAG_TOPDOWN     (1 << 1)
  52
  53 /* For multihop handling */
  54 #define TTM_PL_FLAG_TEMPORARY   (1 << 2)
  55
  56 /**
  57  * struct ttm_place
  58  *
  59  * @fpfn:       first valid page frame number to put the object
  60  * @lpfn:       last valid page frame number to put the object
  61  * @mem_type:   One of TTM_PL_* where the resource should be allocated from.
  62  * @flags:      memory domain and caching flags for the object
  63  *
  64  * Structure indicating a possible place to put an object.
  65  */
  66 struct ttm_place {
  67         unsigned        fpfn;
  68         unsigned        lpfn;
  69         uint32_t        mem_type;
  70         uint32_t        flags;
  71 };
  72
  73 /**
  74  * struct ttm_placement
  75  *
  76  * @num_placement:      number of preferred placements
  77  * @placement:          preferred placements
  78  * @num_busy_placement: number of preferred placements when need to evict buffer
  79  * @busy_placement:     preferred placements when need to evict buffer
  80  *
  81  * Structure indicating the placement you request for an object.
  82  */
  83 struct ttm_placement {
  84         unsigned                num_placement;
  85         const struct ttm_place  *placement;
  86         unsigned                num_busy_placement;
  87         const struct ttm_place  *busy_placement;
  88 };
  89
  90 #endif