include/drm/ttm/ttm_tt.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 #ifndef _TTM_TT_H_
  28 #define _TTM_TT_H_
  29
  30 #include <linux/types.h>
  31
  32 struct ttm_tt;
  33 struct ttm_resource;
  34 struct ttm_buffer_object;
  35 struct ttm_operation_ctx;
  36
  37 #define TTM_PAGE_FLAG_SWAPPED         (1 << 4)
  38 #define TTM_PAGE_FLAG_ZERO_ALLOC      (1 << 6)
  39 #define TTM_PAGE_FLAG_DMA32           (1 << 7)
  40 #define TTM_PAGE_FLAG_SG              (1 << 8)
  41 #define TTM_PAGE_FLAG_NO_RETRY        (1 << 9)
  42
  43 #define TTM_PAGE_FLAG_PRIV_POPULATED  (1 << 31)
  44
  45 enum ttm_caching_state {
  46         tt_uncached,
  47         tt_wc,
  48         tt_cached
  49 };
  50
  51 /**
  52  * struct ttm_tt
  53  *
  54  * @pages: Array of pages backing the data.
  55  * @num_pages: Number of pages in the page array.
  56  * @bdev: Pointer to the current struct ttm_bo_device.
  57  * @be: Pointer to the ttm backend.
  58  * @swap_storage: Pointer to shmem struct file for swap storage.
  59  * @caching_state: The current caching state of the pages.
  60  * @state: The current binding state of the pages.
  61  *
  62  * This is a structure holding the pages, caching- and aperture binding
  63  * status for a buffer object that isn't backed by fixed (VRAM / AGP)
  64  * memory.
  65  */
  66 struct ttm_tt {
  67         struct page **pages;
  68         uint32_t page_flags;
  69         unsigned long num_pages;
  70         struct sg_table *sg; /* for SG objects via dma-buf */
  71         struct file *swap_storage;
  72         enum ttm_caching_state caching_state;
  73 };
  74
  75 static inline bool ttm_tt_is_populated(struct ttm_tt *tt)
  76 {
  77         return tt->page_flags & TTM_PAGE_FLAG_PRIV_POPULATED;
  78 }
  79
  80 static inline void ttm_tt_set_unpopulated(struct ttm_tt *tt)
  81 {
  82         tt->page_flags &= ~TTM_PAGE_FLAG_PRIV_POPULATED;
  83 }
  84
  85 static inline void ttm_tt_set_populated(struct ttm_tt *tt)
  86 {
  87         tt->page_flags |= TTM_PAGE_FLAG_PRIV_POPULATED;
  88 }
  89
  90 /**
  91  * struct ttm_dma_tt
  92  *
  93  * @ttm: Base ttm_tt struct.
  94  * @dma_address: The DMA (bus) addresses of the pages
  95  * @pages_list: used by some page allocation backend
  96  *
  97  * This is a structure holding the pages, caching- and aperture binding
  98  * status for a buffer object that isn't backed by fixed (VRAM / AGP)
  99  * memory.
 100  */
 101 struct ttm_dma_tt {
 102         struct ttm_tt ttm;
 103         dma_addr_t *dma_address;
 104         struct list_head pages_list;
 105 };
 106
 107 /**
 108  * ttm_tt_create
 109  *
 110  * @bo: pointer to a struct ttm_buffer_object
 111  * @zero_alloc: true if allocated pages needs to be zeroed
 112  *
 113  * Make sure we have a TTM structure allocated for the given BO.
 114  * No pages are actually allocated.
 115  */
 116 int ttm_tt_create(struct ttm_buffer_object *bo, bool zero_alloc);
 117
 118 /**
 119  * ttm_tt_init
 120  *
 121  * @ttm: The struct ttm_tt.
 122  * @bo: The buffer object we create the ttm for.
 123  * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
 124  *
 125  * Create a struct ttm_tt to back data with system memory pages.
 126  * No pages are actually allocated.
 127  * Returns:
 128  * NULL: Out of memory.
 129  */
 130 int ttm_tt_init(struct ttm_tt *ttm, struct ttm_buffer_object *bo,
 131                 uint32_t page_flags);
 132 int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_buffer_object *bo,
 133                     uint32_t page_flags);
 134 int ttm_sg_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_buffer_object *bo,
 135                    uint32_t page_flags);
 136
 137 /**
 138  * ttm_tt_fini
 139  *
 140  * @ttm: the ttm_tt structure.
 141  *
 142  * Free memory of ttm_tt structure
 143  */
 144 void ttm_tt_fini(struct ttm_tt *ttm);
 145 void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma);
 146
 147 /**
 148  * ttm_ttm_destroy:
 149  *
 150  * @ttm: The struct ttm_tt.
 151  *
 152  * Unbind, unpopulate and destroy common struct ttm_tt.
 153  */
 154 void ttm_tt_destroy(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
 155
 156 /**
 157  * ttm_tt_destroy_common:
 158  *
 159  * Called from driver to destroy common path.
 160  */
 161 void ttm_tt_destroy_common(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
 162
 163 /**
 164  * ttm_tt_swapin:
 165  *
 166  * @ttm: The struct ttm_tt.
 167  *
 168  * Swap in a previously swap out ttm_tt.
 169  */
 170 int ttm_tt_swapin(struct ttm_tt *ttm);
 171
 172 /**
 173  * ttm_tt_set_placement_caching:
 174  *
 175  * @ttm A struct ttm_tt the backing pages of which will change caching policy.
 176  * @placement: Flag indicating the desired caching policy.
 177  *
 178  * This function will change caching policy of any default kernel mappings of
 179  * the pages backing @ttm. If changing from cached to uncached or
 180  * write-combined,
 181  * all CPU caches will first be flushed to make sure the data of the pages
 182  * hit RAM. This function may be very costly as it involves global TLB
 183  * and cache flushes and potential page splitting / combining.
 184  */
 185 int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement);
 186 int ttm_tt_swapout(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
 187
 188 /**
 189  * ttm_tt_populate - allocate pages for a ttm
 190  *
 191  * @ttm: Pointer to the ttm_tt structure
 192  *
 193  * Calls the driver method to allocate pages for a ttm
 194  */
 195 int ttm_tt_populate(struct ttm_bo_device *bdev, struct ttm_tt *ttm, struct ttm_operation_ctx *ctx);
 196
 197 /**
 198  * ttm_tt_unpopulate - free pages from a ttm
 199  *
 200  * @ttm: Pointer to the ttm_tt structure
 201  *
 202  * Calls the driver method to free all pages from a ttm
 203  */
 204 void ttm_tt_unpopulate(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
 205
 206 #if IS_ENABLED(CONFIG_AGP)
 207 #include <linux/agp_backend.h>
 208
 209 /**
 210  * ttm_agp_tt_create
 211  *
 212  * @bo: Buffer object we allocate the ttm for.
 213  * @bridge: The agp bridge this device is sitting on.
 214  * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
 215  *
 216  *
 217  * Create a TTM backend that uses the indicated AGP bridge as an aperture
 218  * for TT memory. This function uses the linux agpgart interface to
 219  * bind and unbind memory backing a ttm_tt.
 220  */
 221 struct ttm_tt *ttm_agp_tt_create(struct ttm_buffer_object *bo,
 222                                  struct agp_bridge_data *bridge,
 223                                  uint32_t page_flags);
 224 int ttm_agp_bind(struct ttm_tt *ttm, struct ttm_resource *bo_mem);
 225 void ttm_agp_unbind(struct ttm_tt *ttm);
 226 void ttm_agp_destroy(struct ttm_tt *ttm);
 227 bool ttm_agp_is_bound(struct ttm_tt *ttm);
 228 #endif
 229
 230 #endif