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