Loading...
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#ifndef _TTM_BO_DRIVER_H_
31#define _TTM_BO_DRIVER_H_
32
33#include <drm/drm_mm.h>
34#include <drm/drm_vma_manager.h>
35#include <linux/workqueue.h>
36#include <linux/fs.h>
37#include <linux/spinlock.h>
38#include <linux/dma-resv.h>
39
40#include <drm/ttm/ttm_device.h>
41
42#include "ttm_bo_api.h"
43#include "ttm_kmap_iter.h"
44#include "ttm_placement.h"
45#include "ttm_tt.h"
46#include "ttm_pool.h"
47
48/*
49 * ttm_bo.c
50 */
51
52/**
53 * ttm_bo_mem_space
54 *
55 * @bo: Pointer to a struct ttm_buffer_object. the data of which
56 * we want to allocate space for.
57 * @proposed_placement: Proposed new placement for the buffer object.
58 * @mem: A struct ttm_resource.
59 * @interruptible: Sleep interruptible when sliping.
60 * @no_wait_gpu: Return immediately if the GPU is busy.
61 *
62 * Allocate memory space for the buffer object pointed to by @bo, using
63 * the placement flags in @mem, potentially evicting other idle buffer objects.
64 * This function may sleep while waiting for space to become available.
65 * Returns:
66 * -EBUSY: No space available (only if no_wait == 1).
67 * -ENOMEM: Could not allocate memory for the buffer object, either due to
68 * fragmentation or concurrent allocators.
69 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
70 */
71int ttm_bo_mem_space(struct ttm_buffer_object *bo,
72 struct ttm_placement *placement,
73 struct ttm_resource **mem,
74 struct ttm_operation_ctx *ctx);
75
76/**
77 * ttm_bo_unmap_virtual
78 *
79 * @bo: tear down the virtual mappings for this BO
80 */
81void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
82
83/**
84 * ttm_bo_reserve:
85 *
86 * @bo: A pointer to a struct ttm_buffer_object.
87 * @interruptible: Sleep interruptible if waiting.
88 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
89 * @ticket: ticket used to acquire the ww_mutex.
90 *
91 * Locks a buffer object for validation. (Or prevents other processes from
92 * locking it for validation), while taking a number of measures to prevent
93 * deadlocks.
94 *
95 * Returns:
96 * -EDEADLK: The reservation may cause a deadlock.
97 * Release all buffer reservations, wait for @bo to become unreserved and
98 * try again.
99 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
100 * a signal. Release all buffer reservations and return to user-space.
101 * -EBUSY: The function needed to sleep, but @no_wait was true
102 * -EALREADY: Bo already reserved using @ticket. This error code will only
103 * be returned if @use_ticket is set to true.
104 */
105static inline int ttm_bo_reserve(struct ttm_buffer_object *bo,
106 bool interruptible, bool no_wait,
107 struct ww_acquire_ctx *ticket)
108{
109 int ret;
110
111 if (no_wait) {
112 bool success;
113 if (WARN_ON(ticket))
114 return -EBUSY;
115
116 success = dma_resv_trylock(bo->base.resv);
117 return success ? 0 : -EBUSY;
118 }
119
120 if (interruptible)
121 ret = dma_resv_lock_interruptible(bo->base.resv, ticket);
122 else
123 ret = dma_resv_lock(bo->base.resv, ticket);
124 if (ret == -EINTR)
125 return -ERESTARTSYS;
126 return ret;
127}
128
129/**
130 * ttm_bo_reserve_slowpath:
131 * @bo: A pointer to a struct ttm_buffer_object.
132 * @interruptible: Sleep interruptible if waiting.
133 * @sequence: Set (@bo)->sequence to this value after lock
134 *
135 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
136 * from all our other reservations. Because there are no other reservations
137 * held by us, this function cannot deadlock any more.
138 */
139static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo,
140 bool interruptible,
141 struct ww_acquire_ctx *ticket)
142{
143 if (interruptible) {
144 int ret = dma_resv_lock_slow_interruptible(bo->base.resv,
145 ticket);
146 if (ret == -EINTR)
147 ret = -ERESTARTSYS;
148 return ret;
149 }
150 dma_resv_lock_slow(bo->base.resv, ticket);
151 return 0;
152}
153
154static inline void
155ttm_bo_move_to_lru_tail_unlocked(struct ttm_buffer_object *bo)
156{
157 spin_lock(&bo->bdev->lru_lock);
158 ttm_bo_move_to_lru_tail(bo);
159 spin_unlock(&bo->bdev->lru_lock);
160}
161
162static inline void ttm_bo_assign_mem(struct ttm_buffer_object *bo,
163 struct ttm_resource *new_mem)
164{
165 WARN_ON(bo->resource);
166 bo->resource = new_mem;
167}
168
169/**
170 * ttm_bo_move_null = assign memory for a buffer object.
171 * @bo: The bo to assign the memory to
172 * @new_mem: The memory to be assigned.
173 *
174 * Assign the memory from new_mem to the memory of the buffer object bo.
175 */
176static inline void ttm_bo_move_null(struct ttm_buffer_object *bo,
177 struct ttm_resource *new_mem)
178{
179 ttm_resource_free(bo, &bo->resource);
180 ttm_bo_assign_mem(bo, new_mem);
181}
182
183/**
184 * ttm_bo_unreserve
185 *
186 * @bo: A pointer to a struct ttm_buffer_object.
187 *
188 * Unreserve a previous reservation of @bo.
189 */
190static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo)
191{
192 ttm_bo_move_to_lru_tail_unlocked(bo);
193 dma_resv_unlock(bo->base.resv);
194}
195
196/*
197 * ttm_bo_util.c
198 */
199int ttm_mem_io_reserve(struct ttm_device *bdev,
200 struct ttm_resource *mem);
201void ttm_mem_io_free(struct ttm_device *bdev,
202 struct ttm_resource *mem);
203
204/**
205 * ttm_bo_move_memcpy
206 *
207 * @bo: A pointer to a struct ttm_buffer_object.
208 * @interruptible: Sleep interruptible if waiting.
209 * @no_wait_gpu: Return immediately if the GPU is busy.
210 * @new_mem: struct ttm_resource indicating where to move.
211 *
212 * Fallback move function for a mappable buffer object in mappable memory.
213 * The function will, if successful,
214 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
215 * and update the (@bo)->mem placement flags. If unsuccessful, the old
216 * data remains untouched, and it's up to the caller to free the
217 * memory space indicated by @new_mem.
218 * Returns:
219 * !0: Failure.
220 */
221
222int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
223 struct ttm_operation_ctx *ctx,
224 struct ttm_resource *new_mem);
225
226/**
227 * ttm_bo_move_accel_cleanup.
228 *
229 * @bo: A pointer to a struct ttm_buffer_object.
230 * @fence: A fence object that signals when moving is complete.
231 * @evict: This is an evict move. Don't return until the buffer is idle.
232 * @pipeline: evictions are to be pipelined.
233 * @new_mem: struct ttm_resource indicating where to move.
234 *
235 * Accelerated move function to be called when an accelerated move
236 * has been scheduled. The function will create a new temporary buffer object
237 * representing the old placement, and put the sync object on both buffer
238 * objects. After that the newly created buffer object is unref'd to be
239 * destroyed when the move is complete. This will help pipeline
240 * buffer moves.
241 */
242int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
243 struct dma_fence *fence, bool evict,
244 bool pipeline,
245 struct ttm_resource *new_mem);
246
247/**
248 * ttm_bo_move_sync_cleanup.
249 *
250 * @bo: A pointer to a struct ttm_buffer_object.
251 * @new_mem: struct ttm_resource indicating where to move.
252 *
253 * Special case of ttm_bo_move_accel_cleanup where the bo is guaranteed
254 * by the caller to be idle. Typically used after memcpy buffer moves.
255 */
256void ttm_bo_move_sync_cleanup(struct ttm_buffer_object *bo,
257 struct ttm_resource *new_mem);
258
259/**
260 * ttm_bo_pipeline_gutting.
261 *
262 * @bo: A pointer to a struct ttm_buffer_object.
263 *
264 * Pipelined gutting a BO of its backing store.
265 */
266int ttm_bo_pipeline_gutting(struct ttm_buffer_object *bo);
267
268/**
269 * ttm_io_prot
270 *
271 * bo: ttm buffer object
272 * res: ttm resource object
273 * @tmp: Page protection flag for a normal, cached mapping.
274 *
275 * Utility function that returns the pgprot_t that should be used for
276 * setting up a PTE with the caching model indicated by @c_state.
277 */
278pgprot_t ttm_io_prot(struct ttm_buffer_object *bo, struct ttm_resource *res,
279 pgprot_t tmp);
280
281/**
282 * ttm_bo_tt_bind
283 *
284 * Bind the object tt to a memory resource.
285 */
286int ttm_bo_tt_bind(struct ttm_buffer_object *bo, struct ttm_resource *mem);
287
288/**
289 * ttm_bo_tt_destroy.
290 */
291void ttm_bo_tt_destroy(struct ttm_buffer_object *bo);
292
293void ttm_move_memcpy(bool clear,
294 u32 num_pages,
295 struct ttm_kmap_iter *dst_iter,
296 struct ttm_kmap_iter *src_iter);
297
298struct ttm_kmap_iter *
299ttm_kmap_iter_iomap_init(struct ttm_kmap_iter_iomap *iter_io,
300 struct io_mapping *iomap,
301 struct sg_table *st,
302 resource_size_t start);
303#endif
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#ifndef _TTM_BO_DRIVER_H_
31#define _TTM_BO_DRIVER_H_
32
33#include <ttm/ttm_bo_api.h>
34#include <ttm/ttm_memory.h>
35#include <ttm/ttm_module.h>
36#include <ttm/ttm_placement.h>
37#include <drm/drm_mm.h>
38#include <drm/drm_global.h>
39#include <drm/drm_vma_manager.h>
40#include <linux/workqueue.h>
41#include <linux/fs.h>
42#include <linux/spinlock.h>
43#include <linux/reservation.h>
44
45struct ttm_backend_func {
46 /**
47 * struct ttm_backend_func member bind
48 *
49 * @ttm: Pointer to a struct ttm_tt.
50 * @bo_mem: Pointer to a struct ttm_mem_reg describing the
51 * memory type and location for binding.
52 *
53 * Bind the backend pages into the aperture in the location
54 * indicated by @bo_mem. This function should be able to handle
55 * differences between aperture and system page sizes.
56 */
57 int (*bind) (struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
58
59 /**
60 * struct ttm_backend_func member unbind
61 *
62 * @ttm: Pointer to a struct ttm_tt.
63 *
64 * Unbind previously bound backend pages. This function should be
65 * able to handle differences between aperture and system page sizes.
66 */
67 int (*unbind) (struct ttm_tt *ttm);
68
69 /**
70 * struct ttm_backend_func member destroy
71 *
72 * @ttm: Pointer to a struct ttm_tt.
73 *
74 * Destroy the backend. This will be call back from ttm_tt_destroy so
75 * don't call ttm_tt_destroy from the callback or infinite loop.
76 */
77 void (*destroy) (struct ttm_tt *ttm);
78};
79
80#define TTM_PAGE_FLAG_WRITE (1 << 3)
81#define TTM_PAGE_FLAG_SWAPPED (1 << 4)
82#define TTM_PAGE_FLAG_PERSISTENT_SWAP (1 << 5)
83#define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6)
84#define TTM_PAGE_FLAG_DMA32 (1 << 7)
85#define TTM_PAGE_FLAG_SG (1 << 8)
86
87enum ttm_caching_state {
88 tt_uncached,
89 tt_wc,
90 tt_cached
91};
92
93/**
94 * struct ttm_tt
95 *
96 * @bdev: Pointer to a struct ttm_bo_device.
97 * @func: Pointer to a struct ttm_backend_func that describes
98 * the backend methods.
99 * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL
100 * pointer.
101 * @pages: Array of pages backing the data.
102 * @num_pages: Number of pages in the page array.
103 * @bdev: Pointer to the current struct ttm_bo_device.
104 * @be: Pointer to the ttm backend.
105 * @swap_storage: Pointer to shmem struct file for swap storage.
106 * @caching_state: The current caching state of the pages.
107 * @state: The current binding state of the pages.
108 *
109 * This is a structure holding the pages, caching- and aperture binding
110 * status for a buffer object that isn't backed by fixed (VRAM / AGP)
111 * memory.
112 */
113
114struct ttm_tt {
115 struct ttm_bo_device *bdev;
116 struct ttm_backend_func *func;
117 struct page *dummy_read_page;
118 struct page **pages;
119 uint32_t page_flags;
120 unsigned long num_pages;
121 struct sg_table *sg; /* for SG objects via dma-buf */
122 struct ttm_bo_global *glob;
123 struct file *swap_storage;
124 enum ttm_caching_state caching_state;
125 enum {
126 tt_bound,
127 tt_unbound,
128 tt_unpopulated,
129 } state;
130};
131
132/**
133 * struct ttm_dma_tt
134 *
135 * @ttm: Base ttm_tt struct.
136 * @cpu_address: The CPU address of the pages
137 * @dma_address: The DMA (bus) addresses of the pages
138 * @pages_list: used by some page allocation backend
139 *
140 * This is a structure holding the pages, caching- and aperture binding
141 * status for a buffer object that isn't backed by fixed (VRAM / AGP)
142 * memory.
143 */
144struct ttm_dma_tt {
145 struct ttm_tt ttm;
146 void **cpu_address;
147 dma_addr_t *dma_address;
148 struct list_head pages_list;
149};
150
151#define TTM_MEMTYPE_FLAG_FIXED (1 << 0) /* Fixed (on-card) PCI memory */
152#define TTM_MEMTYPE_FLAG_MAPPABLE (1 << 1) /* Memory mappable */
153#define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */
154
155struct ttm_mem_type_manager;
156
157struct ttm_mem_type_manager_func {
158 /**
159 * struct ttm_mem_type_manager member init
160 *
161 * @man: Pointer to a memory type manager.
162 * @p_size: Implementation dependent, but typically the size of the
163 * range to be managed in pages.
164 *
165 * Called to initialize a private range manager. The function is
166 * expected to initialize the man::priv member.
167 * Returns 0 on success, negative error code on failure.
168 */
169 int (*init)(struct ttm_mem_type_manager *man, unsigned long p_size);
170
171 /**
172 * struct ttm_mem_type_manager member takedown
173 *
174 * @man: Pointer to a memory type manager.
175 *
176 * Called to undo the setup done in init. All allocated resources
177 * should be freed.
178 */
179 int (*takedown)(struct ttm_mem_type_manager *man);
180
181 /**
182 * struct ttm_mem_type_manager member get_node
183 *
184 * @man: Pointer to a memory type manager.
185 * @bo: Pointer to the buffer object we're allocating space for.
186 * @placement: Placement details.
187 * @flags: Additional placement flags.
188 * @mem: Pointer to a struct ttm_mem_reg to be filled in.
189 *
190 * This function should allocate space in the memory type managed
191 * by @man. Placement details if
192 * applicable are given by @placement. If successful,
193 * @mem::mm_node should be set to a non-null value, and
194 * @mem::start should be set to a value identifying the beginning
195 * of the range allocated, and the function should return zero.
196 * If the memory region accommodate the buffer object, @mem::mm_node
197 * should be set to NULL, and the function should return 0.
198 * If a system error occurred, preventing the request to be fulfilled,
199 * the function should return a negative error code.
200 *
201 * Note that @mem::mm_node will only be dereferenced by
202 * struct ttm_mem_type_manager functions and optionally by the driver,
203 * which has knowledge of the underlying type.
204 *
205 * This function may not be called from within atomic context, so
206 * an implementation can and must use either a mutex or a spinlock to
207 * protect any data structures managing the space.
208 */
209 int (*get_node)(struct ttm_mem_type_manager *man,
210 struct ttm_buffer_object *bo,
211 const struct ttm_place *place,
212 struct ttm_mem_reg *mem);
213
214 /**
215 * struct ttm_mem_type_manager member put_node
216 *
217 * @man: Pointer to a memory type manager.
218 * @mem: Pointer to a struct ttm_mem_reg to be filled in.
219 *
220 * This function frees memory type resources previously allocated
221 * and that are identified by @mem::mm_node and @mem::start. May not
222 * be called from within atomic context.
223 */
224 void (*put_node)(struct ttm_mem_type_manager *man,
225 struct ttm_mem_reg *mem);
226
227 /**
228 * struct ttm_mem_type_manager member debug
229 *
230 * @man: Pointer to a memory type manager.
231 * @prefix: Prefix to be used in printout to identify the caller.
232 *
233 * This function is called to print out the state of the memory
234 * type manager to aid debugging of out-of-memory conditions.
235 * It may not be called from within atomic context.
236 */
237 void (*debug)(struct ttm_mem_type_manager *man, const char *prefix);
238};
239
240/**
241 * struct ttm_mem_type_manager
242 *
243 * @has_type: The memory type has been initialized.
244 * @use_type: The memory type is enabled.
245 * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory
246 * managed by this memory type.
247 * @gpu_offset: If used, the GPU offset of the first managed page of
248 * fixed memory or the first managed location in an aperture.
249 * @size: Size of the managed region.
250 * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX,
251 * as defined in ttm_placement_common.h
252 * @default_caching: The default caching policy used for a buffer object
253 * placed in this memory type if the user doesn't provide one.
254 * @func: structure pointer implementing the range manager. See above
255 * @priv: Driver private closure for @func.
256 * @io_reserve_mutex: Mutex optionally protecting shared io_reserve structures
257 * @use_io_reserve_lru: Use an lru list to try to unreserve io_mem_regions
258 * reserved by the TTM vm system.
259 * @io_reserve_lru: Optional lru list for unreserving io mem regions.
260 * @io_reserve_fastpath: Only use bdev::driver::io_mem_reserve to obtain
261 * static information. bdev::driver::io_mem_free is never used.
262 * @lru: The lru list for this memory type.
263 *
264 * This structure is used to identify and manage memory types for a device.
265 * It's set up by the ttm_bo_driver::init_mem_type method.
266 */
267
268
269
270struct ttm_mem_type_manager {
271 struct ttm_bo_device *bdev;
272
273 /*
274 * No protection. Constant from start.
275 */
276
277 bool has_type;
278 bool use_type;
279 uint32_t flags;
280 uint64_t gpu_offset; /* GPU address space is independent of CPU word size */
281 uint64_t size;
282 uint32_t available_caching;
283 uint32_t default_caching;
284 const struct ttm_mem_type_manager_func *func;
285 void *priv;
286 struct mutex io_reserve_mutex;
287 bool use_io_reserve_lru;
288 bool io_reserve_fastpath;
289
290 /*
291 * Protected by @io_reserve_mutex:
292 */
293
294 struct list_head io_reserve_lru;
295
296 /*
297 * Protected by the global->lru_lock.
298 */
299
300 struct list_head lru;
301};
302
303/**
304 * struct ttm_bo_driver
305 *
306 * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
307 * @invalidate_caches: Callback to invalidate read caches when a buffer object
308 * has been evicted.
309 * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager
310 * structure.
311 * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
312 * @move: Callback for a driver to hook in accelerated functions to
313 * move a buffer.
314 * If set to NULL, a potentially slow memcpy() move is used.
315 */
316
317struct ttm_bo_driver {
318 /**
319 * ttm_tt_create
320 *
321 * @bdev: pointer to a struct ttm_bo_device:
322 * @size: Size of the data needed backing.
323 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
324 * @dummy_read_page: See struct ttm_bo_device.
325 *
326 * Create a struct ttm_tt to back data with system memory pages.
327 * No pages are actually allocated.
328 * Returns:
329 * NULL: Out of memory.
330 */
331 struct ttm_tt *(*ttm_tt_create)(struct ttm_bo_device *bdev,
332 unsigned long size,
333 uint32_t page_flags,
334 struct page *dummy_read_page);
335
336 /**
337 * ttm_tt_populate
338 *
339 * @ttm: The struct ttm_tt to contain the backing pages.
340 *
341 * Allocate all backing pages
342 * Returns:
343 * -ENOMEM: Out of memory.
344 */
345 int (*ttm_tt_populate)(struct ttm_tt *ttm);
346
347 /**
348 * ttm_tt_unpopulate
349 *
350 * @ttm: The struct ttm_tt to contain the backing pages.
351 *
352 * Free all backing page
353 */
354 void (*ttm_tt_unpopulate)(struct ttm_tt *ttm);
355
356 /**
357 * struct ttm_bo_driver member invalidate_caches
358 *
359 * @bdev: the buffer object device.
360 * @flags: new placement of the rebound buffer object.
361 *
362 * A previosly evicted buffer has been rebound in a
363 * potentially new location. Tell the driver that it might
364 * consider invalidating read (texture) caches on the next command
365 * submission as a consequence.
366 */
367
368 int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags);
369 int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type,
370 struct ttm_mem_type_manager *man);
371 /**
372 * struct ttm_bo_driver member evict_flags:
373 *
374 * @bo: the buffer object to be evicted
375 *
376 * Return the bo flags for a buffer which is not mapped to the hardware.
377 * These will be placed in proposed_flags so that when the move is
378 * finished, they'll end up in bo->mem.flags
379 */
380
381 void(*evict_flags) (struct ttm_buffer_object *bo,
382 struct ttm_placement *placement);
383 /**
384 * struct ttm_bo_driver member move:
385 *
386 * @bo: the buffer to move
387 * @evict: whether this motion is evicting the buffer from
388 * the graphics address space
389 * @interruptible: Use interruptible sleeps if possible when sleeping.
390 * @no_wait: whether this should give up and return -EBUSY
391 * if this move would require sleeping
392 * @new_mem: the new memory region receiving the buffer
393 *
394 * Move a buffer between two memory regions.
395 */
396 int (*move) (struct ttm_buffer_object *bo,
397 bool evict, bool interruptible,
398 bool no_wait_gpu,
399 struct ttm_mem_reg *new_mem);
400
401 /**
402 * struct ttm_bo_driver_member verify_access
403 *
404 * @bo: Pointer to a buffer object.
405 * @filp: Pointer to a struct file trying to access the object.
406 *
407 * Called from the map / write / read methods to verify that the
408 * caller is permitted to access the buffer object.
409 * This member may be set to NULL, which will refuse this kind of
410 * access for all buffer objects.
411 * This function should return 0 if access is granted, -EPERM otherwise.
412 */
413 int (*verify_access) (struct ttm_buffer_object *bo,
414 struct file *filp);
415
416 /* hook to notify driver about a driver move so it
417 * can do tiling things */
418 void (*move_notify)(struct ttm_buffer_object *bo,
419 struct ttm_mem_reg *new_mem);
420 /* notify the driver we are taking a fault on this BO
421 * and have reserved it */
422 int (*fault_reserve_notify)(struct ttm_buffer_object *bo);
423
424 /**
425 * notify the driver that we're about to swap out this bo
426 */
427 void (*swap_notify) (struct ttm_buffer_object *bo);
428
429 /**
430 * Driver callback on when mapping io memory (for bo_move_memcpy
431 * for instance). TTM will take care to call io_mem_free whenever
432 * the mapping is not use anymore. io_mem_reserve & io_mem_free
433 * are balanced.
434 */
435 int (*io_mem_reserve)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
436 void (*io_mem_free)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
437};
438
439/**
440 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
441 */
442
443struct ttm_bo_global_ref {
444 struct drm_global_reference ref;
445 struct ttm_mem_global *mem_glob;
446};
447
448/**
449 * struct ttm_bo_global - Buffer object driver global data.
450 *
451 * @mem_glob: Pointer to a struct ttm_mem_global object for accounting.
452 * @dummy_read_page: Pointer to a dummy page used for mapping requests
453 * of unpopulated pages.
454 * @shrink: A shrink callback object used for buffer object swap.
455 * @device_list_mutex: Mutex protecting the device list.
456 * This mutex is held while traversing the device list for pm options.
457 * @lru_lock: Spinlock protecting the bo subsystem lru lists.
458 * @device_list: List of buffer object devices.
459 * @swap_lru: Lru list of buffer objects used for swapping.
460 */
461
462struct ttm_bo_global {
463
464 /**
465 * Constant after init.
466 */
467
468 struct kobject kobj;
469 struct ttm_mem_global *mem_glob;
470 struct page *dummy_read_page;
471 struct ttm_mem_shrink shrink;
472 struct mutex device_list_mutex;
473 spinlock_t lru_lock;
474
475 /**
476 * Protected by device_list_mutex.
477 */
478 struct list_head device_list;
479
480 /**
481 * Protected by the lru_lock.
482 */
483 struct list_head swap_lru;
484
485 /**
486 * Internal protection.
487 */
488 atomic_t bo_count;
489};
490
491
492#define TTM_NUM_MEM_TYPES 8
493
494#define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs
495 idling before CPU mapping */
496#define TTM_BO_PRIV_FLAG_MAX 1
497/**
498 * struct ttm_bo_device - Buffer object driver device-specific data.
499 *
500 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
501 * @man: An array of mem_type_managers.
502 * @vma_manager: Address space manager
503 * lru_lock: Spinlock that protects the buffer+device lru lists and
504 * ddestroy lists.
505 * @val_seq: Current validation sequence.
506 * @dev_mapping: A pointer to the struct address_space representing the
507 * device address space.
508 * @wq: Work queue structure for the delayed delete workqueue.
509 *
510 */
511
512struct ttm_bo_device {
513
514 /*
515 * Constant after bo device init / atomic.
516 */
517 struct list_head device_list;
518 struct ttm_bo_global *glob;
519 struct ttm_bo_driver *driver;
520 struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES];
521
522 /*
523 * Protected by internal locks.
524 */
525 struct drm_vma_offset_manager vma_manager;
526
527 /*
528 * Protected by the global:lru lock.
529 */
530 struct list_head ddestroy;
531 uint32_t val_seq;
532
533 /*
534 * Protected by load / firstopen / lastclose /unload sync.
535 */
536
537 struct address_space *dev_mapping;
538
539 /*
540 * Internal protection.
541 */
542
543 struct delayed_work wq;
544
545 bool need_dma32;
546};
547
548/**
549 * ttm_flag_masked
550 *
551 * @old: Pointer to the result and original value.
552 * @new: New value of bits.
553 * @mask: Mask of bits to change.
554 *
555 * Convenience function to change a number of bits identified by a mask.
556 */
557
558static inline uint32_t
559ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask)
560{
561 *old ^= (*old ^ new) & mask;
562 return *old;
563}
564
565/**
566 * ttm_tt_init
567 *
568 * @ttm: The struct ttm_tt.
569 * @bdev: pointer to a struct ttm_bo_device:
570 * @size: Size of the data needed backing.
571 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
572 * @dummy_read_page: See struct ttm_bo_device.
573 *
574 * Create a struct ttm_tt to back data with system memory pages.
575 * No pages are actually allocated.
576 * Returns:
577 * NULL: Out of memory.
578 */
579extern int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev,
580 unsigned long size, uint32_t page_flags,
581 struct page *dummy_read_page);
582extern int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev,
583 unsigned long size, uint32_t page_flags,
584 struct page *dummy_read_page);
585
586/**
587 * ttm_tt_fini
588 *
589 * @ttm: the ttm_tt structure.
590 *
591 * Free memory of ttm_tt structure
592 */
593extern void ttm_tt_fini(struct ttm_tt *ttm);
594extern void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma);
595
596/**
597 * ttm_ttm_bind:
598 *
599 * @ttm: The struct ttm_tt containing backing pages.
600 * @bo_mem: The struct ttm_mem_reg identifying the binding location.
601 *
602 * Bind the pages of @ttm to an aperture location identified by @bo_mem
603 */
604extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
605
606/**
607 * ttm_ttm_destroy:
608 *
609 * @ttm: The struct ttm_tt.
610 *
611 * Unbind, unpopulate and destroy common struct ttm_tt.
612 */
613extern void ttm_tt_destroy(struct ttm_tt *ttm);
614
615/**
616 * ttm_ttm_unbind:
617 *
618 * @ttm: The struct ttm_tt.
619 *
620 * Unbind a struct ttm_tt.
621 */
622extern void ttm_tt_unbind(struct ttm_tt *ttm);
623
624/**
625 * ttm_tt_swapin:
626 *
627 * @ttm: The struct ttm_tt.
628 *
629 * Swap in a previously swap out ttm_tt.
630 */
631extern int ttm_tt_swapin(struct ttm_tt *ttm);
632
633/**
634 * ttm_tt_set_placement_caching:
635 *
636 * @ttm A struct ttm_tt the backing pages of which will change caching policy.
637 * @placement: Flag indicating the desired caching policy.
638 *
639 * This function will change caching policy of any default kernel mappings of
640 * the pages backing @ttm. If changing from cached to uncached or
641 * write-combined,
642 * all CPU caches will first be flushed to make sure the data of the pages
643 * hit RAM. This function may be very costly as it involves global TLB
644 * and cache flushes and potential page splitting / combining.
645 */
646extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement);
647extern int ttm_tt_swapout(struct ttm_tt *ttm,
648 struct file *persistent_swap_storage);
649
650/**
651 * ttm_tt_unpopulate - free pages from a ttm
652 *
653 * @ttm: Pointer to the ttm_tt structure
654 *
655 * Calls the driver method to free all pages from a ttm
656 */
657extern void ttm_tt_unpopulate(struct ttm_tt *ttm);
658
659/*
660 * ttm_bo.c
661 */
662
663/**
664 * ttm_mem_reg_is_pci
665 *
666 * @bdev: Pointer to a struct ttm_bo_device.
667 * @mem: A valid struct ttm_mem_reg.
668 *
669 * Returns true if the memory described by @mem is PCI memory,
670 * false otherwise.
671 */
672extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev,
673 struct ttm_mem_reg *mem);
674
675/**
676 * ttm_bo_mem_space
677 *
678 * @bo: Pointer to a struct ttm_buffer_object. the data of which
679 * we want to allocate space for.
680 * @proposed_placement: Proposed new placement for the buffer object.
681 * @mem: A struct ttm_mem_reg.
682 * @interruptible: Sleep interruptible when sliping.
683 * @no_wait_gpu: Return immediately if the GPU is busy.
684 *
685 * Allocate memory space for the buffer object pointed to by @bo, using
686 * the placement flags in @mem, potentially evicting other idle buffer objects.
687 * This function may sleep while waiting for space to become available.
688 * Returns:
689 * -EBUSY: No space available (only if no_wait == 1).
690 * -ENOMEM: Could not allocate memory for the buffer object, either due to
691 * fragmentation or concurrent allocators.
692 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
693 */
694extern int ttm_bo_mem_space(struct ttm_buffer_object *bo,
695 struct ttm_placement *placement,
696 struct ttm_mem_reg *mem,
697 bool interruptible,
698 bool no_wait_gpu);
699
700extern void ttm_bo_mem_put(struct ttm_buffer_object *bo,
701 struct ttm_mem_reg *mem);
702extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo,
703 struct ttm_mem_reg *mem);
704
705extern void ttm_bo_global_release(struct drm_global_reference *ref);
706extern int ttm_bo_global_init(struct drm_global_reference *ref);
707
708extern int ttm_bo_device_release(struct ttm_bo_device *bdev);
709
710/**
711 * ttm_bo_device_init
712 *
713 * @bdev: A pointer to a struct ttm_bo_device to initialize.
714 * @glob: A pointer to an initialized struct ttm_bo_global.
715 * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
716 * @mapping: The address space to use for this bo.
717 * @file_page_offset: Offset into the device address space that is available
718 * for buffer data. This ensures compatibility with other users of the
719 * address space.
720 *
721 * Initializes a struct ttm_bo_device:
722 * Returns:
723 * !0: Failure.
724 */
725extern int ttm_bo_device_init(struct ttm_bo_device *bdev,
726 struct ttm_bo_global *glob,
727 struct ttm_bo_driver *driver,
728 struct address_space *mapping,
729 uint64_t file_page_offset, bool need_dma32);
730
731/**
732 * ttm_bo_unmap_virtual
733 *
734 * @bo: tear down the virtual mappings for this BO
735 */
736extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
737
738/**
739 * ttm_bo_unmap_virtual
740 *
741 * @bo: tear down the virtual mappings for this BO
742 *
743 * The caller must take ttm_mem_io_lock before calling this function.
744 */
745extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo);
746
747extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object *bo);
748extern void ttm_mem_io_free_vm(struct ttm_buffer_object *bo);
749extern int ttm_mem_io_lock(struct ttm_mem_type_manager *man,
750 bool interruptible);
751extern void ttm_mem_io_unlock(struct ttm_mem_type_manager *man);
752
753extern void ttm_bo_del_sub_from_lru(struct ttm_buffer_object *bo);
754extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo);
755
756/**
757 * __ttm_bo_reserve:
758 *
759 * @bo: A pointer to a struct ttm_buffer_object.
760 * @interruptible: Sleep interruptible if waiting.
761 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
762 * @use_ticket: If @bo is already reserved, Only sleep waiting for
763 * it to become unreserved if @ticket->stamp is older.
764 *
765 * Will not remove reserved buffers from the lru lists.
766 * Otherwise identical to ttm_bo_reserve.
767 *
768 * Returns:
769 * -EDEADLK: The reservation may cause a deadlock.
770 * Release all buffer reservations, wait for @bo to become unreserved and
771 * try again. (only if use_sequence == 1).
772 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
773 * a signal. Release all buffer reservations and return to user-space.
774 * -EBUSY: The function needed to sleep, but @no_wait was true
775 * -EALREADY: Bo already reserved using @ticket. This error code will only
776 * be returned if @use_ticket is set to true.
777 */
778static inline int __ttm_bo_reserve(struct ttm_buffer_object *bo,
779 bool interruptible,
780 bool no_wait, bool use_ticket,
781 struct ww_acquire_ctx *ticket)
782{
783 int ret = 0;
784
785 if (no_wait) {
786 bool success;
787 if (WARN_ON(ticket))
788 return -EBUSY;
789
790 success = ww_mutex_trylock(&bo->resv->lock);
791 return success ? 0 : -EBUSY;
792 }
793
794 if (interruptible)
795 ret = ww_mutex_lock_interruptible(&bo->resv->lock, ticket);
796 else
797 ret = ww_mutex_lock(&bo->resv->lock, ticket);
798 if (ret == -EINTR)
799 return -ERESTARTSYS;
800 return ret;
801}
802
803/**
804 * ttm_bo_reserve:
805 *
806 * @bo: A pointer to a struct ttm_buffer_object.
807 * @interruptible: Sleep interruptible if waiting.
808 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
809 * @use_ticket: If @bo is already reserved, Only sleep waiting for
810 * it to become unreserved if @ticket->stamp is older.
811 *
812 * Locks a buffer object for validation. (Or prevents other processes from
813 * locking it for validation) and removes it from lru lists, while taking
814 * a number of measures to prevent deadlocks.
815 *
816 * Deadlocks may occur when two processes try to reserve multiple buffers in
817 * different order, either by will or as a result of a buffer being evicted
818 * to make room for a buffer already reserved. (Buffers are reserved before
819 * they are evicted). The following algorithm prevents such deadlocks from
820 * occurring:
821 * Processes attempting to reserve multiple buffers other than for eviction,
822 * (typically execbuf), should first obtain a unique 32-bit
823 * validation sequence number,
824 * and call this function with @use_ticket == 1 and @ticket->stamp == the unique
825 * sequence number. If upon call of this function, the buffer object is already
826 * reserved, the validation sequence is checked against the validation
827 * sequence of the process currently reserving the buffer,
828 * and if the current validation sequence is greater than that of the process
829 * holding the reservation, the function returns -EDEADLK. Otherwise it sleeps
830 * waiting for the buffer to become unreserved, after which it retries
831 * reserving.
832 * The caller should, when receiving an -EDEADLK error
833 * release all its buffer reservations, wait for @bo to become unreserved, and
834 * then rerun the validation with the same validation sequence. This procedure
835 * will always guarantee that the process with the lowest validation sequence
836 * will eventually succeed, preventing both deadlocks and starvation.
837 *
838 * Returns:
839 * -EDEADLK: The reservation may cause a deadlock.
840 * Release all buffer reservations, wait for @bo to become unreserved and
841 * try again. (only if use_sequence == 1).
842 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
843 * a signal. Release all buffer reservations and return to user-space.
844 * -EBUSY: The function needed to sleep, but @no_wait was true
845 * -EALREADY: Bo already reserved using @ticket. This error code will only
846 * be returned if @use_ticket is set to true.
847 */
848static inline int ttm_bo_reserve(struct ttm_buffer_object *bo,
849 bool interruptible,
850 bool no_wait, bool use_ticket,
851 struct ww_acquire_ctx *ticket)
852{
853 int ret;
854
855 WARN_ON(!atomic_read(&bo->kref.refcount));
856
857 ret = __ttm_bo_reserve(bo, interruptible, no_wait, use_ticket, ticket);
858 if (likely(ret == 0))
859 ttm_bo_del_sub_from_lru(bo);
860
861 return ret;
862}
863
864/**
865 * ttm_bo_reserve_slowpath:
866 * @bo: A pointer to a struct ttm_buffer_object.
867 * @interruptible: Sleep interruptible if waiting.
868 * @sequence: Set (@bo)->sequence to this value after lock
869 *
870 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
871 * from all our other reservations. Because there are no other reservations
872 * held by us, this function cannot deadlock any more.
873 */
874static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo,
875 bool interruptible,
876 struct ww_acquire_ctx *ticket)
877{
878 int ret = 0;
879
880 WARN_ON(!atomic_read(&bo->kref.refcount));
881
882 if (interruptible)
883 ret = ww_mutex_lock_slow_interruptible(&bo->resv->lock,
884 ticket);
885 else
886 ww_mutex_lock_slow(&bo->resv->lock, ticket);
887
888 if (likely(ret == 0))
889 ttm_bo_del_sub_from_lru(bo);
890 else if (ret == -EINTR)
891 ret = -ERESTARTSYS;
892
893 return ret;
894}
895
896/**
897 * __ttm_bo_unreserve
898 * @bo: A pointer to a struct ttm_buffer_object.
899 *
900 * Unreserve a previous reservation of @bo where the buffer object is
901 * already on lru lists.
902 */
903static inline void __ttm_bo_unreserve(struct ttm_buffer_object *bo)
904{
905 ww_mutex_unlock(&bo->resv->lock);
906}
907
908/**
909 * ttm_bo_unreserve
910 *
911 * @bo: A pointer to a struct ttm_buffer_object.
912 *
913 * Unreserve a previous reservation of @bo.
914 */
915static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo)
916{
917 if (!(bo->mem.placement & TTM_PL_FLAG_NO_EVICT)) {
918 spin_lock(&bo->glob->lru_lock);
919 ttm_bo_add_to_lru(bo);
920 spin_unlock(&bo->glob->lru_lock);
921 }
922 __ttm_bo_unreserve(bo);
923}
924
925/**
926 * ttm_bo_unreserve_ticket
927 * @bo: A pointer to a struct ttm_buffer_object.
928 * @ticket: ww_acquire_ctx used for reserving
929 *
930 * Unreserve a previous reservation of @bo made with @ticket.
931 */
932static inline void ttm_bo_unreserve_ticket(struct ttm_buffer_object *bo,
933 struct ww_acquire_ctx *t)
934{
935 ttm_bo_unreserve(bo);
936}
937
938/*
939 * ttm_bo_util.c
940 */
941
942int ttm_mem_io_reserve(struct ttm_bo_device *bdev,
943 struct ttm_mem_reg *mem);
944void ttm_mem_io_free(struct ttm_bo_device *bdev,
945 struct ttm_mem_reg *mem);
946/**
947 * ttm_bo_move_ttm
948 *
949 * @bo: A pointer to a struct ttm_buffer_object.
950 * @evict: 1: This is an eviction. Don't try to pipeline.
951 * @no_wait_gpu: Return immediately if the GPU is busy.
952 * @new_mem: struct ttm_mem_reg indicating where to move.
953 *
954 * Optimized move function for a buffer object with both old and
955 * new placement backed by a TTM. The function will, if successful,
956 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
957 * and update the (@bo)->mem placement flags. If unsuccessful, the old
958 * data remains untouched, and it's up to the caller to free the
959 * memory space indicated by @new_mem.
960 * Returns:
961 * !0: Failure.
962 */
963
964extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
965 bool evict, bool no_wait_gpu,
966 struct ttm_mem_reg *new_mem);
967
968/**
969 * ttm_bo_move_memcpy
970 *
971 * @bo: A pointer to a struct ttm_buffer_object.
972 * @evict: 1: This is an eviction. Don't try to pipeline.
973 * @no_wait_gpu: Return immediately if the GPU is busy.
974 * @new_mem: struct ttm_mem_reg indicating where to move.
975 *
976 * Fallback move function for a mappable buffer object in mappable memory.
977 * The function will, if successful,
978 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
979 * and update the (@bo)->mem placement flags. If unsuccessful, the old
980 * data remains untouched, and it's up to the caller to free the
981 * memory space indicated by @new_mem.
982 * Returns:
983 * !0: Failure.
984 */
985
986extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
987 bool evict, bool no_wait_gpu,
988 struct ttm_mem_reg *new_mem);
989
990/**
991 * ttm_bo_free_old_node
992 *
993 * @bo: A pointer to a struct ttm_buffer_object.
994 *
995 * Utility function to free an old placement after a successful move.
996 */
997extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
998
999/**
1000 * ttm_bo_move_accel_cleanup.
1001 *
1002 * @bo: A pointer to a struct ttm_buffer_object.
1003 * @fence: A fence object that signals when moving is complete.
1004 * @evict: This is an evict move. Don't return until the buffer is idle.
1005 * @no_wait_gpu: Return immediately if the GPU is busy.
1006 * @new_mem: struct ttm_mem_reg indicating where to move.
1007 *
1008 * Accelerated move function to be called when an accelerated move
1009 * has been scheduled. The function will create a new temporary buffer object
1010 * representing the old placement, and put the sync object on both buffer
1011 * objects. After that the newly created buffer object is unref'd to be
1012 * destroyed when the move is complete. This will help pipeline
1013 * buffer moves.
1014 */
1015
1016extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
1017 struct fence *fence,
1018 bool evict, bool no_wait_gpu,
1019 struct ttm_mem_reg *new_mem);
1020/**
1021 * ttm_io_prot
1022 *
1023 * @c_state: Caching state.
1024 * @tmp: Page protection flag for a normal, cached mapping.
1025 *
1026 * Utility function that returns the pgprot_t that should be used for
1027 * setting up a PTE with the caching model indicated by @c_state.
1028 */
1029extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
1030
1031extern const struct ttm_mem_type_manager_func ttm_bo_manager_func;
1032
1033#if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
1034#define TTM_HAS_AGP
1035#include <linux/agp_backend.h>
1036
1037/**
1038 * ttm_agp_tt_create
1039 *
1040 * @bdev: Pointer to a struct ttm_bo_device.
1041 * @bridge: The agp bridge this device is sitting on.
1042 * @size: Size of the data needed backing.
1043 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
1044 * @dummy_read_page: See struct ttm_bo_device.
1045 *
1046 *
1047 * Create a TTM backend that uses the indicated AGP bridge as an aperture
1048 * for TT memory. This function uses the linux agpgart interface to
1049 * bind and unbind memory backing a ttm_tt.
1050 */
1051extern struct ttm_tt *ttm_agp_tt_create(struct ttm_bo_device *bdev,
1052 struct agp_bridge_data *bridge,
1053 unsigned long size, uint32_t page_flags,
1054 struct page *dummy_read_page);
1055int ttm_agp_tt_populate(struct ttm_tt *ttm);
1056void ttm_agp_tt_unpopulate(struct ttm_tt *ttm);
1057#endif
1058
1059#endif