Rev 1408 | Rev 2003 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
1408 | serge | 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 |
||
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 "drm_mm.h" |
||
37 | #include "linux/spinlock.h" |
||
38 | |||
39 | struct ttm_backend; |
||
40 | |||
41 | struct ttm_backend_func { |
||
42 | /** |
||
43 | * struct ttm_backend_func member populate |
||
44 | * |
||
45 | * @backend: Pointer to a struct ttm_backend. |
||
46 | * @num_pages: Number of pages to populate. |
||
47 | * @pages: Array of pointers to ttm pages. |
||
48 | * @dummy_read_page: Page to be used instead of NULL pages in the |
||
49 | * array @pages. |
||
50 | * |
||
51 | * Populate the backend with ttm pages. Depending on the backend, |
||
52 | * it may or may not copy the @pages array. |
||
53 | */ |
||
54 | int (*populate) (struct ttm_backend *backend, |
||
55 | unsigned long num_pages, struct page **pages, |
||
56 | struct page *dummy_read_page); |
||
57 | /** |
||
58 | * struct ttm_backend_func member clear |
||
59 | * |
||
60 | * @backend: Pointer to a struct ttm_backend. |
||
61 | * |
||
62 | * This is an "unpopulate" function. Release all resources |
||
63 | * allocated with populate. |
||
64 | */ |
||
65 | void (*clear) (struct ttm_backend *backend); |
||
66 | |||
67 | /** |
||
68 | * struct ttm_backend_func member bind |
||
69 | * |
||
70 | * @backend: Pointer to a struct ttm_backend. |
||
71 | * @bo_mem: Pointer to a struct ttm_mem_reg describing the |
||
72 | * memory type and location for binding. |
||
73 | * |
||
74 | * Bind the backend pages into the aperture in the location |
||
75 | * indicated by @bo_mem. This function should be able to handle |
||
76 | * differences between aperture- and system page sizes. |
||
77 | */ |
||
78 | int (*bind) (struct ttm_backend *backend, struct ttm_mem_reg *bo_mem); |
||
79 | |||
80 | /** |
||
81 | * struct ttm_backend_func member unbind |
||
82 | * |
||
83 | * @backend: Pointer to a struct ttm_backend. |
||
84 | * |
||
85 | * Unbind previously bound backend pages. This function should be |
||
86 | * able to handle differences between aperture- and system page sizes. |
||
87 | */ |
||
88 | int (*unbind) (struct ttm_backend *backend); |
||
89 | |||
90 | /** |
||
91 | * struct ttm_backend_func member destroy |
||
92 | * |
||
93 | * @backend: Pointer to a struct ttm_backend. |
||
94 | * |
||
95 | * Destroy the backend. |
||
96 | */ |
||
97 | void (*destroy) (struct ttm_backend *backend); |
||
98 | }; |
||
99 | |||
100 | /** |
||
101 | * struct ttm_backend |
||
102 | * |
||
103 | * @bdev: Pointer to a struct ttm_bo_device. |
||
104 | * @flags: For driver use. |
||
105 | * @func: Pointer to a struct ttm_backend_func that describes |
||
106 | * the backend methods. |
||
107 | * |
||
108 | */ |
||
109 | |||
110 | struct ttm_backend { |
||
111 | struct ttm_bo_device *bdev; |
||
112 | uint32_t flags; |
||
113 | struct ttm_backend_func *func; |
||
114 | }; |
||
115 | |||
116 | #define TTM_PAGE_FLAG_VMALLOC (1 << 0) |
||
117 | #define TTM_PAGE_FLAG_USER (1 << 1) |
||
118 | #define TTM_PAGE_FLAG_USER_DIRTY (1 << 2) |
||
119 | #define TTM_PAGE_FLAG_WRITE (1 << 3) |
||
120 | #define TTM_PAGE_FLAG_SWAPPED (1 << 4) |
||
121 | #define TTM_PAGE_FLAG_PERSISTANT_SWAP (1 << 5) |
||
122 | #define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6) |
||
123 | #define TTM_PAGE_FLAG_DMA32 (1 << 7) |
||
124 | |||
125 | enum ttm_caching_state { |
||
126 | tt_uncached, |
||
127 | tt_wc, |
||
128 | tt_cached |
||
129 | }; |
||
130 | |||
131 | /** |
||
132 | * struct ttm_tt |
||
133 | * |
||
134 | * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL |
||
135 | * pointer. |
||
136 | * @pages: Array of pages backing the data. |
||
137 | * @first_himem_page: Himem pages are put last in the page array, which |
||
138 | * enables us to run caching attribute changes on only the first part |
||
139 | * of the page array containing lomem pages. This is the index of the |
||
140 | * first himem page. |
||
141 | * @last_lomem_page: Index of the last lomem page in the page array. |
||
142 | * @num_pages: Number of pages in the page array. |
||
143 | * @bdev: Pointer to the current struct ttm_bo_device. |
||
144 | * @be: Pointer to the ttm backend. |
||
145 | * @tsk: The task for user ttm. |
||
146 | * @start: virtual address for user ttm. |
||
147 | * @swap_storage: Pointer to shmem struct file for swap storage. |
||
148 | * @caching_state: The current caching state of the pages. |
||
149 | * @state: The current binding state of the pages. |
||
150 | * |
||
151 | * This is a structure holding the pages, caching- and aperture binding |
||
152 | * status for a buffer object that isn't backed by fixed (VRAM / AGP) |
||
153 | * memory. |
||
154 | */ |
||
155 | |||
156 | struct ttm_tt { |
||
157 | struct page *dummy_read_page; |
||
158 | struct page **pages; |
||
159 | long first_himem_page; |
||
160 | long last_lomem_page; |
||
161 | uint32_t page_flags; |
||
162 | unsigned long num_pages; |
||
163 | struct ttm_bo_global *glob; |
||
164 | struct ttm_backend *be; |
||
165 | struct task_struct *tsk; |
||
166 | unsigned long start; |
||
167 | struct file *swap_storage; |
||
168 | enum ttm_caching_state caching_state; |
||
169 | enum { |
||
170 | tt_bound, |
||
171 | tt_unbound, |
||
172 | tt_unpopulated, |
||
173 | } state; |
||
174 | }; |
||
175 | |||
176 | #define TTM_MEMTYPE_FLAG_FIXED (1 << 0) /* Fixed (on-card) PCI memory */ |
||
177 | #define TTM_MEMTYPE_FLAG_MAPPABLE (1 << 1) /* Memory mappable */ |
||
178 | #define TTM_MEMTYPE_FLAG_NEEDS_IOREMAP (1 << 2) /* Fixed memory needs ioremap |
||
179 | before kernel access. */ |
||
180 | #define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */ |
||
181 | |||
182 | /** |
||
183 | * struct ttm_mem_type_manager |
||
184 | * |
||
185 | * @has_type: The memory type has been initialized. |
||
186 | * @use_type: The memory type is enabled. |
||
187 | * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory |
||
188 | * managed by this memory type. |
||
189 | * @gpu_offset: If used, the GPU offset of the first managed page of |
||
190 | * fixed memory or the first managed location in an aperture. |
||
191 | * @io_offset: The io_offset of the first managed page of IO memory or |
||
192 | * the first managed location in an aperture. For TTM_MEMTYPE_FLAG_CMA |
||
193 | * memory, this should be set to NULL. |
||
194 | * @io_size: The size of a managed IO region (fixed memory or aperture). |
||
195 | * @io_addr: Virtual kernel address if the io region is pre-mapped. For |
||
196 | * TTM_MEMTYPE_FLAG_NEEDS_IOREMAP there is no pre-mapped io map and |
||
197 | * @io_addr should be set to NULL. |
||
198 | * @size: Size of the managed region. |
||
199 | * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX, |
||
200 | * as defined in ttm_placement_common.h |
||
201 | * @default_caching: The default caching policy used for a buffer object |
||
202 | * placed in this memory type if the user doesn't provide one. |
||
203 | * @manager: The range manager used for this memory type. FIXME: If the aperture |
||
204 | * has a page size different from the underlying system, the granularity |
||
205 | * of this manager should take care of this. But the range allocating code |
||
206 | * in ttm_bo.c needs to be modified for this. |
||
207 | * @lru: The lru list for this memory type. |
||
208 | * |
||
209 | * This structure is used to identify and manage memory types for a device. |
||
210 | * It's set up by the ttm_bo_driver::init_mem_type method. |
||
211 | */ |
||
212 | |||
213 | struct ttm_mem_type_manager { |
||
214 | |||
215 | /* |
||
216 | * No protection. Constant from start. |
||
217 | */ |
||
218 | |||
219 | bool has_type; |
||
220 | bool use_type; |
||
221 | uint32_t flags; |
||
222 | unsigned long gpu_offset; |
||
223 | unsigned long io_offset; |
||
224 | unsigned long io_size; |
||
225 | void *io_addr; |
||
226 | uint64_t size; |
||
227 | uint32_t available_caching; |
||
228 | uint32_t default_caching; |
||
229 | |||
230 | /* |
||
231 | * Protected by the bdev->lru_lock. |
||
232 | * TODO: Consider one lru_lock per ttm_mem_type_manager. |
||
233 | * Plays ill with list removal, though. |
||
234 | */ |
||
235 | |||
236 | struct drm_mm manager; |
||
237 | struct list_head lru; |
||
238 | }; |
||
239 | |||
240 | /** |
||
241 | * struct ttm_bo_driver |
||
242 | * |
||
243 | * @create_ttm_backend_entry: Callback to create a struct ttm_backend. |
||
244 | * @invalidate_caches: Callback to invalidate read caches when a buffer object |
||
245 | * has been evicted. |
||
246 | * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager |
||
247 | * structure. |
||
248 | * @evict_flags: Callback to obtain placement flags when a buffer is evicted. |
||
249 | * @move: Callback for a driver to hook in accelerated functions to |
||
250 | * move a buffer. |
||
251 | * If set to NULL, a potentially slow memcpy() move is used. |
||
252 | * @sync_obj_signaled: See ttm_fence_api.h |
||
253 | * @sync_obj_wait: See ttm_fence_api.h |
||
254 | * @sync_obj_flush: See ttm_fence_api.h |
||
255 | * @sync_obj_unref: See ttm_fence_api.h |
||
256 | * @sync_obj_ref: See ttm_fence_api.h |
||
257 | */ |
||
258 | |||
259 | struct ttm_bo_driver { |
||
260 | /** |
||
261 | * struct ttm_bo_driver member create_ttm_backend_entry |
||
262 | * |
||
263 | * @bdev: The buffer object device. |
||
264 | * |
||
265 | * Create a driver specific struct ttm_backend. |
||
266 | */ |
||
267 | |||
268 | struct ttm_backend *(*create_ttm_backend_entry) |
||
269 | (struct ttm_bo_device *bdev); |
||
270 | |||
271 | /** |
||
272 | * struct ttm_bo_driver member invalidate_caches |
||
273 | * |
||
274 | * @bdev: the buffer object device. |
||
275 | * @flags: new placement of the rebound buffer object. |
||
276 | * |
||
277 | * A previosly evicted buffer has been rebound in a |
||
278 | * potentially new location. Tell the driver that it might |
||
279 | * consider invalidating read (texture) caches on the next command |
||
280 | * submission as a consequence. |
||
281 | */ |
||
282 | |||
283 | int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags); |
||
284 | int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type, |
||
285 | struct ttm_mem_type_manager *man); |
||
286 | /** |
||
287 | * struct ttm_bo_driver member evict_flags: |
||
288 | * |
||
289 | * @bo: the buffer object to be evicted |
||
290 | * |
||
291 | * Return the bo flags for a buffer which is not mapped to the hardware. |
||
292 | * These will be placed in proposed_flags so that when the move is |
||
293 | * finished, they'll end up in bo->mem.flags |
||
294 | */ |
||
295 | |||
296 | void(*evict_flags) (struct ttm_buffer_object *bo, |
||
297 | struct ttm_placement *placement); |
||
298 | /** |
||
299 | * struct ttm_bo_driver member move: |
||
300 | * |
||
301 | * @bo: the buffer to move |
||
302 | * @evict: whether this motion is evicting the buffer from |
||
303 | * the graphics address space |
||
304 | * @interruptible: Use interruptible sleeps if possible when sleeping. |
||
305 | * @no_wait: whether this should give up and return -EBUSY |
||
306 | * if this move would require sleeping |
||
307 | * @new_mem: the new memory region receiving the buffer |
||
308 | * |
||
309 | * Move a buffer between two memory regions. |
||
310 | */ |
||
311 | int (*move) (struct ttm_buffer_object *bo, |
||
312 | bool evict, bool interruptible, |
||
313 | bool no_wait, struct ttm_mem_reg *new_mem); |
||
314 | |||
315 | /** |
||
316 | * struct ttm_bo_driver_member verify_access |
||
317 | * |
||
318 | * @bo: Pointer to a buffer object. |
||
319 | * @filp: Pointer to a struct file trying to access the object. |
||
320 | * |
||
321 | * Called from the map / write / read methods to verify that the |
||
322 | * caller is permitted to access the buffer object. |
||
323 | * This member may be set to NULL, which will refuse this kind of |
||
324 | * access for all buffer objects. |
||
325 | * This function should return 0 if access is granted, -EPERM otherwise. |
||
326 | */ |
||
327 | int (*verify_access) (struct ttm_buffer_object *bo, |
||
328 | struct file *filp); |
||
329 | |||
330 | /** |
||
331 | * In case a driver writer dislikes the TTM fence objects, |
||
332 | * the driver writer can replace those with sync objects of |
||
333 | * his / her own. If it turns out that no driver writer is |
||
334 | * using these. I suggest we remove these hooks and plug in |
||
335 | * fences directly. The bo driver needs the following functionality: |
||
336 | * See the corresponding functions in the fence object API |
||
337 | * documentation. |
||
338 | */ |
||
339 | |||
340 | bool (*sync_obj_signaled) (void *sync_obj, void *sync_arg); |
||
341 | int (*sync_obj_wait) (void *sync_obj, void *sync_arg, |
||
342 | bool lazy, bool interruptible); |
||
343 | int (*sync_obj_flush) (void *sync_obj, void *sync_arg); |
||
344 | void (*sync_obj_unref) (void **sync_obj); |
||
345 | void *(*sync_obj_ref) (void *sync_obj); |
||
346 | |||
347 | /* hook to notify driver about a driver move so it |
||
348 | * can do tiling things */ |
||
349 | void (*move_notify)(struct ttm_buffer_object *bo, |
||
350 | struct ttm_mem_reg *new_mem); |
||
351 | /* notify the driver we are taking a fault on this BO |
||
352 | * and have reserved it */ |
||
353 | void (*fault_reserve_notify)(struct ttm_buffer_object *bo); |
||
354 | }; |
||
355 | |||
356 | /** |
||
357 | * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global. |
||
358 | */ |
||
359 | |||
360 | struct ttm_bo_global_ref { |
||
361 | struct ttm_global_reference ref; |
||
362 | struct ttm_mem_global *mem_glob; |
||
363 | }; |
||
364 | |||
365 | /** |
||
366 | * struct ttm_bo_global - Buffer object driver global data. |
||
367 | * |
||
368 | * @mem_glob: Pointer to a struct ttm_mem_global object for accounting. |
||
369 | * @dummy_read_page: Pointer to a dummy page used for mapping requests |
||
370 | * of unpopulated pages. |
||
371 | * @shrink: A shrink callback object used for buffer object swap. |
||
372 | * @ttm_bo_extra_size: Extra size (sizeof(struct ttm_buffer_object) excluded) |
||
373 | * used by a buffer object. This is excluding page arrays and backing pages. |
||
374 | * @ttm_bo_size: This is @ttm_bo_extra_size + sizeof(struct ttm_buffer_object). |
||
375 | * @device_list_mutex: Mutex protecting the device list. |
||
376 | * This mutex is held while traversing the device list for pm options. |
||
377 | * @lru_lock: Spinlock protecting the bo subsystem lru lists. |
||
378 | * @device_list: List of buffer object devices. |
||
379 | * @swap_lru: Lru list of buffer objects used for swapping. |
||
380 | */ |
||
381 | |||
382 | struct ttm_bo_global { |
||
383 | |||
384 | /** |
||
385 | * Constant after init. |
||
386 | */ |
||
387 | |||
388 | // struct kobject kobj; |
||
389 | struct ttm_mem_global *mem_glob; |
||
390 | struct page *dummy_read_page; |
||
391 | struct ttm_mem_shrink shrink; |
||
392 | size_t ttm_bo_extra_size; |
||
393 | size_t ttm_bo_size; |
||
1630 | serge | 394 | struct mutex device_list_mutex; |
1408 | serge | 395 | spinlock_t lru_lock; |
396 | |||
397 | /** |
||
398 | * Protected by device_list_mutex. |
||
399 | */ |
||
400 | struct list_head device_list; |
||
401 | |||
402 | /** |
||
403 | * Protected by the lru_lock. |
||
404 | */ |
||
405 | struct list_head swap_lru; |
||
406 | |||
407 | /** |
||
408 | * Internal protection. |
||
409 | */ |
||
410 | atomic_t bo_count; |
||
411 | }; |
||
412 | |||
413 | |||
414 | #define TTM_NUM_MEM_TYPES 8 |
||
415 | |||
416 | #define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs |
||
417 | idling before CPU mapping */ |
||
418 | #define TTM_BO_PRIV_FLAG_MAX 1 |
||
419 | /** |
||
420 | * struct ttm_bo_device - Buffer object driver device-specific data. |
||
421 | * |
||
422 | * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver. |
||
423 | * @man: An array of mem_type_managers. |
||
424 | * @addr_space_mm: Range manager for the device address space. |
||
425 | * lru_lock: Spinlock that protects the buffer+device lru lists and |
||
426 | * ddestroy lists. |
||
427 | * @nice_mode: Try nicely to wait for buffer idle when cleaning a manager. |
||
428 | * If a GPU lockup has been detected, this is forced to 0. |
||
429 | * @dev_mapping: A pointer to the struct address_space representing the |
||
430 | * device address space. |
||
431 | * @wq: Work queue structure for the delayed delete workqueue. |
||
432 | * |
||
433 | */ |
||
434 | |||
435 | struct ttm_bo_device { |
||
436 | |||
437 | /* |
||
438 | * Constant after bo device init / atomic. |
||
439 | */ |
||
440 | struct list_head device_list; |
||
441 | struct ttm_bo_global *glob; |
||
442 | struct ttm_bo_driver *driver; |
||
443 | rwlock_t vm_lock; |
||
444 | struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES]; |
||
445 | /* |
||
446 | * Protected by the vm lock. |
||
447 | */ |
||
448 | // struct rb_root addr_space_rb; |
||
449 | struct drm_mm addr_space_mm; |
||
450 | |||
451 | /* |
||
452 | * Protected by the global:lru lock. |
||
453 | */ |
||
454 | struct list_head ddestroy; |
||
455 | |||
456 | /* |
||
457 | * Protected by load / firstopen / lastclose /unload sync. |
||
458 | */ |
||
459 | |||
460 | bool nice_mode; |
||
461 | struct address_space *dev_mapping; |
||
462 | |||
463 | /* |
||
464 | * Internal protection. |
||
465 | */ |
||
466 | |||
467 | // struct delayed_work wq; |
||
468 | |||
469 | bool need_dma32; |
||
470 | }; |
||
471 | |||
472 | /** |
||
473 | * ttm_flag_masked |
||
474 | * |
||
475 | * @old: Pointer to the result and original value. |
||
476 | * @new: New value of bits. |
||
477 | * @mask: Mask of bits to change. |
||
478 | * |
||
479 | * Convenience function to change a number of bits identified by a mask. |
||
480 | */ |
||
481 | |||
482 | static inline uint32_t |
||
483 | ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask) |
||
484 | { |
||
485 | *old ^= (*old ^ new) & mask; |
||
486 | return *old; |
||
487 | } |
||
488 | |||
489 | /** |
||
490 | * ttm_tt_create |
||
491 | * |
||
492 | * @bdev: pointer to a struct ttm_bo_device: |
||
493 | * @size: Size of the data needed backing. |
||
494 | * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags. |
||
495 | * @dummy_read_page: See struct ttm_bo_device. |
||
496 | * |
||
497 | * Create a struct ttm_tt to back data with system memory pages. |
||
498 | * No pages are actually allocated. |
||
499 | * Returns: |
||
500 | * NULL: Out of memory. |
||
501 | */ |
||
502 | extern struct ttm_tt *ttm_tt_create(struct ttm_bo_device *bdev, |
||
503 | unsigned long size, |
||
504 | uint32_t page_flags, |
||
505 | struct page *dummy_read_page); |
||
506 | |||
507 | /** |
||
508 | * ttm_tt_set_user: |
||
509 | * |
||
510 | * @ttm: The struct ttm_tt to populate. |
||
511 | * @tsk: A struct task_struct for which @start is a valid user-space address. |
||
512 | * @start: A valid user-space address. |
||
513 | * @num_pages: Size in pages of the user memory area. |
||
514 | * |
||
515 | * Populate a struct ttm_tt with a user-space memory area after first pinning |
||
516 | * the pages backing it. |
||
517 | * Returns: |
||
518 | * !0: Error. |
||
519 | */ |
||
520 | |||
521 | extern int ttm_tt_set_user(struct ttm_tt *ttm, |
||
522 | struct task_struct *tsk, |
||
523 | unsigned long start, unsigned long num_pages); |
||
524 | |||
525 | /** |
||
526 | * ttm_ttm_bind: |
||
527 | * |
||
528 | * @ttm: The struct ttm_tt containing backing pages. |
||
529 | * @bo_mem: The struct ttm_mem_reg identifying the binding location. |
||
530 | * |
||
531 | * Bind the pages of @ttm to an aperture location identified by @bo_mem |
||
532 | */ |
||
533 | extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem); |
||
534 | |||
535 | /** |
||
536 | * ttm_tt_populate: |
||
537 | * |
||
538 | * @ttm: The struct ttm_tt to contain the backing pages. |
||
539 | * |
||
540 | * Add backing pages to all of @ttm |
||
541 | */ |
||
542 | extern int ttm_tt_populate(struct ttm_tt *ttm); |
||
543 | |||
544 | /** |
||
545 | * ttm_ttm_destroy: |
||
546 | * |
||
547 | * @ttm: The struct ttm_tt. |
||
548 | * |
||
549 | * Unbind, unpopulate and destroy a struct ttm_tt. |
||
550 | */ |
||
551 | extern void ttm_tt_destroy(struct ttm_tt *ttm); |
||
552 | |||
553 | /** |
||
554 | * ttm_ttm_unbind: |
||
555 | * |
||
556 | * @ttm: The struct ttm_tt. |
||
557 | * |
||
558 | * Unbind a struct ttm_tt. |
||
559 | */ |
||
560 | extern void ttm_tt_unbind(struct ttm_tt *ttm); |
||
561 | |||
562 | /** |
||
563 | * ttm_ttm_destroy: |
||
564 | * |
||
565 | * @ttm: The struct ttm_tt. |
||
566 | * @index: Index of the desired page. |
||
567 | * |
||
568 | * Return a pointer to the struct page backing @ttm at page |
||
569 | * index @index. If the page is unpopulated, one will be allocated to |
||
570 | * populate that index. |
||
571 | * |
||
572 | * Returns: |
||
573 | * NULL on OOM. |
||
574 | */ |
||
575 | extern struct page *ttm_tt_get_page(struct ttm_tt *ttm, int index); |
||
576 | |||
577 | /** |
||
578 | * ttm_tt_cache_flush: |
||
579 | * |
||
580 | * @pages: An array of pointers to struct page:s to flush. |
||
581 | * @num_pages: Number of pages to flush. |
||
582 | * |
||
583 | * Flush the data of the indicated pages from the cpu caches. |
||
584 | * This is used when changing caching attributes of the pages from |
||
585 | * cache-coherent. |
||
586 | */ |
||
587 | extern void ttm_tt_cache_flush(struct page *pages[], unsigned long num_pages); |
||
588 | |||
589 | /** |
||
590 | * ttm_tt_set_placement_caching: |
||
591 | * |
||
592 | * @ttm A struct ttm_tt the backing pages of which will change caching policy. |
||
593 | * @placement: Flag indicating the desired caching policy. |
||
594 | * |
||
595 | * This function will change caching policy of any default kernel mappings of |
||
596 | * the pages backing @ttm. If changing from cached to uncached or |
||
597 | * write-combined, |
||
598 | * all CPU caches will first be flushed to make sure the data of the pages |
||
599 | * hit RAM. This function may be very costly as it involves global TLB |
||
600 | * and cache flushes and potential page splitting / combining. |
||
601 | */ |
||
602 | extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement); |
||
603 | extern int ttm_tt_swapout(struct ttm_tt *ttm, |
||
604 | struct file *persistant_swap_storage); |
||
605 | |||
606 | /* |
||
607 | * ttm_bo.c |
||
608 | */ |
||
609 | |||
610 | /** |
||
611 | * ttm_mem_reg_is_pci |
||
612 | * |
||
613 | * @bdev: Pointer to a struct ttm_bo_device. |
||
614 | * @mem: A valid struct ttm_mem_reg. |
||
615 | * |
||
616 | * Returns true if the memory described by @mem is PCI memory, |
||
617 | * false otherwise. |
||
618 | */ |
||
619 | extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev, |
||
620 | struct ttm_mem_reg *mem); |
||
621 | |||
622 | /** |
||
623 | * ttm_bo_mem_space |
||
624 | * |
||
625 | * @bo: Pointer to a struct ttm_buffer_object. the data of which |
||
626 | * we want to allocate space for. |
||
627 | * @proposed_placement: Proposed new placement for the buffer object. |
||
628 | * @mem: A struct ttm_mem_reg. |
||
629 | * @interruptible: Sleep interruptible when sliping. |
||
630 | * @no_wait: Don't sleep waiting for space to become available. |
||
631 | * |
||
632 | * Allocate memory space for the buffer object pointed to by @bo, using |
||
633 | * the placement flags in @mem, potentially evicting other idle buffer objects. |
||
634 | * This function may sleep while waiting for space to become available. |
||
635 | * Returns: |
||
636 | * -EBUSY: No space available (only if no_wait == 1). |
||
637 | * -ENOMEM: Could not allocate memory for the buffer object, either due to |
||
638 | * fragmentation or concurrent allocators. |
||
639 | * -ERESTARTSYS: An interruptible sleep was interrupted by a signal. |
||
640 | */ |
||
641 | extern int ttm_bo_mem_space(struct ttm_buffer_object *bo, |
||
642 | struct ttm_placement *placement, |
||
643 | struct ttm_mem_reg *mem, |
||
644 | bool interruptible, bool no_wait); |
||
645 | /** |
||
646 | * ttm_bo_wait_for_cpu |
||
647 | * |
||
648 | * @bo: Pointer to a struct ttm_buffer_object. |
||
649 | * @no_wait: Don't sleep while waiting. |
||
650 | * |
||
651 | * Wait until a buffer object is no longer sync'ed for CPU access. |
||
652 | * Returns: |
||
653 | * -EBUSY: Buffer object was sync'ed for CPU access. (only if no_wait == 1). |
||
654 | * -ERESTARTSYS: An interruptible sleep was interrupted by a signal. |
||
655 | */ |
||
656 | |||
657 | extern int ttm_bo_wait_cpu(struct ttm_buffer_object *bo, bool no_wait); |
||
658 | |||
659 | /** |
||
660 | * ttm_bo_pci_offset - Get the PCI offset for the buffer object memory. |
||
661 | * |
||
662 | * @bo Pointer to a struct ttm_buffer_object. |
||
663 | * @bus_base On return the base of the PCI region |
||
664 | * @bus_offset On return the byte offset into the PCI region |
||
665 | * @bus_size On return the byte size of the buffer object or zero if |
||
666 | * the buffer object memory is not accessible through a PCI region. |
||
667 | * |
||
668 | * Returns: |
||
669 | * -EINVAL if the buffer object is currently not mappable. |
||
670 | * 0 otherwise. |
||
671 | */ |
||
672 | |||
673 | extern int ttm_bo_pci_offset(struct ttm_bo_device *bdev, |
||
674 | struct ttm_mem_reg *mem, |
||
675 | unsigned long *bus_base, |
||
676 | unsigned long *bus_offset, |
||
677 | unsigned long *bus_size); |
||
678 | |||
679 | extern void ttm_bo_global_release(struct ttm_global_reference *ref); |
||
680 | extern int ttm_bo_global_init(struct ttm_global_reference *ref); |
||
681 | |||
682 | extern int ttm_bo_device_release(struct ttm_bo_device *bdev); |
||
683 | |||
684 | /** |
||
685 | * ttm_bo_device_init |
||
686 | * |
||
687 | * @bdev: A pointer to a struct ttm_bo_device to initialize. |
||
688 | * @mem_global: A pointer to an initialized struct ttm_mem_global. |
||
689 | * @driver: A pointer to a struct ttm_bo_driver set up by the caller. |
||
690 | * @file_page_offset: Offset into the device address space that is available |
||
691 | * for buffer data. This ensures compatibility with other users of the |
||
692 | * address space. |
||
693 | * |
||
694 | * Initializes a struct ttm_bo_device: |
||
695 | * Returns: |
||
696 | * !0: Failure. |
||
697 | */ |
||
698 | extern int ttm_bo_device_init(struct ttm_bo_device *bdev, |
||
699 | struct ttm_bo_global *glob, |
||
700 | struct ttm_bo_driver *driver, |
||
701 | uint64_t file_page_offset, bool need_dma32); |
||
702 | |||
703 | /** |
||
704 | * ttm_bo_unmap_virtual |
||
705 | * |
||
706 | * @bo: tear down the virtual mappings for this BO |
||
707 | */ |
||
708 | extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo); |
||
709 | |||
710 | /** |
||
711 | * ttm_bo_reserve: |
||
712 | * |
||
713 | * @bo: A pointer to a struct ttm_buffer_object. |
||
714 | * @interruptible: Sleep interruptible if waiting. |
||
715 | * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY. |
||
716 | * @use_sequence: If @bo is already reserved, Only sleep waiting for |
||
717 | * it to become unreserved if @sequence < (@bo)->sequence. |
||
718 | * |
||
719 | * Locks a buffer object for validation. (Or prevents other processes from |
||
720 | * locking it for validation) and removes it from lru lists, while taking |
||
721 | * a number of measures to prevent deadlocks. |
||
722 | * |
||
723 | * Deadlocks may occur when two processes try to reserve multiple buffers in |
||
724 | * different order, either by will or as a result of a buffer being evicted |
||
725 | * to make room for a buffer already reserved. (Buffers are reserved before |
||
726 | * they are evicted). The following algorithm prevents such deadlocks from |
||
727 | * occuring: |
||
728 | * 1) Buffers are reserved with the lru spinlock held. Upon successful |
||
729 | * reservation they are removed from the lru list. This stops a reserved buffer |
||
730 | * from being evicted. However the lru spinlock is released between the time |
||
731 | * a buffer is selected for eviction and the time it is reserved. |
||
732 | * Therefore a check is made when a buffer is reserved for eviction, that it |
||
733 | * is still the first buffer in the lru list, before it is removed from the |
||
734 | * list. @check_lru == 1 forces this check. If it fails, the function returns |
||
735 | * -EINVAL, and the caller should then choose a new buffer to evict and repeat |
||
736 | * the procedure. |
||
737 | * 2) Processes attempting to reserve multiple buffers other than for eviction, |
||
738 | * (typically execbuf), should first obtain a unique 32-bit |
||
739 | * validation sequence number, |
||
740 | * and call this function with @use_sequence == 1 and @sequence == the unique |
||
741 | * sequence number. If upon call of this function, the buffer object is already |
||
742 | * reserved, the validation sequence is checked against the validation |
||
743 | * sequence of the process currently reserving the buffer, |
||
744 | * and if the current validation sequence is greater than that of the process |
||
745 | * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps |
||
746 | * waiting for the buffer to become unreserved, after which it retries |
||
747 | * reserving. |
||
748 | * The caller should, when receiving an -EAGAIN error |
||
749 | * release all its buffer reservations, wait for @bo to become unreserved, and |
||
750 | * then rerun the validation with the same validation sequence. This procedure |
||
751 | * will always guarantee that the process with the lowest validation sequence |
||
752 | * will eventually succeed, preventing both deadlocks and starvation. |
||
753 | * |
||
754 | * Returns: |
||
755 | * -EAGAIN: The reservation may cause a deadlock. |
||
756 | * Release all buffer reservations, wait for @bo to become unreserved and |
||
757 | * try again. (only if use_sequence == 1). |
||
758 | * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by |
||
759 | * a signal. Release all buffer reservations and return to user-space. |
||
760 | */ |
||
761 | extern int ttm_bo_reserve(struct ttm_buffer_object *bo, |
||
762 | bool interruptible, |
||
763 | bool no_wait, bool use_sequence, uint32_t sequence); |
||
764 | |||
765 | /** |
||
766 | * ttm_bo_unreserve |
||
767 | * |
||
768 | * @bo: A pointer to a struct ttm_buffer_object. |
||
769 | * |
||
770 | * Unreserve a previous reservation of @bo. |
||
771 | */ |
||
772 | extern void ttm_bo_unreserve(struct ttm_buffer_object *bo); |
||
773 | |||
774 | /** |
||
775 | * ttm_bo_wait_unreserved |
||
776 | * |
||
777 | * @bo: A pointer to a struct ttm_buffer_object. |
||
778 | * |
||
779 | * Wait for a struct ttm_buffer_object to become unreserved. |
||
780 | * This is typically used in the execbuf code to relax cpu-usage when |
||
781 | * a potential deadlock condition backoff. |
||
782 | */ |
||
783 | extern int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo, |
||
784 | bool interruptible); |
||
785 | |||
786 | /** |
||
787 | * ttm_bo_block_reservation |
||
788 | * |
||
789 | * @bo: A pointer to a struct ttm_buffer_object. |
||
790 | * @interruptible: Use interruptible sleep when waiting. |
||
791 | * @no_wait: Don't sleep, but rather return -EBUSY. |
||
792 | * |
||
793 | * Block reservation for validation by simply reserving the buffer. |
||
794 | * This is intended for single buffer use only without eviction, |
||
795 | * and thus needs no deadlock protection. |
||
796 | * |
||
797 | * Returns: |
||
798 | * -EBUSY: If no_wait == 1 and the buffer is already reserved. |
||
799 | * -ERESTARTSYS: If interruptible == 1 and the process received a signal |
||
800 | * while sleeping. |
||
801 | */ |
||
802 | extern int ttm_bo_block_reservation(struct ttm_buffer_object *bo, |
||
803 | bool interruptible, bool no_wait); |
||
804 | |||
805 | /** |
||
806 | * ttm_bo_unblock_reservation |
||
807 | * |
||
808 | * @bo: A pointer to a struct ttm_buffer_object. |
||
809 | * |
||
810 | * Unblocks reservation leaving lru lists untouched. |
||
811 | */ |
||
812 | extern void ttm_bo_unblock_reservation(struct ttm_buffer_object *bo); |
||
813 | |||
814 | /* |
||
815 | * ttm_bo_util.c |
||
816 | */ |
||
817 | |||
818 | /** |
||
819 | * ttm_bo_move_ttm |
||
820 | * |
||
821 | * @bo: A pointer to a struct ttm_buffer_object. |
||
822 | * @evict: 1: This is an eviction. Don't try to pipeline. |
||
823 | * @no_wait: Never sleep, but rather return with -EBUSY. |
||
824 | * @new_mem: struct ttm_mem_reg indicating where to move. |
||
825 | * |
||
826 | * Optimized move function for a buffer object with both old and |
||
827 | * new placement backed by a TTM. The function will, if successful, |
||
828 | * free any old aperture space, and set (@new_mem)->mm_node to NULL, |
||
829 | * and update the (@bo)->mem placement flags. If unsuccessful, the old |
||
830 | * data remains untouched, and it's up to the caller to free the |
||
831 | * memory space indicated by @new_mem. |
||
832 | * Returns: |
||
833 | * !0: Failure. |
||
834 | */ |
||
835 | |||
836 | extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo, |
||
837 | bool evict, bool no_wait, |
||
838 | struct ttm_mem_reg *new_mem); |
||
839 | |||
840 | /** |
||
841 | * ttm_bo_move_memcpy |
||
842 | * |
||
843 | * @bo: A pointer to a struct ttm_buffer_object. |
||
844 | * @evict: 1: This is an eviction. Don't try to pipeline. |
||
845 | * @no_wait: Never sleep, but rather return with -EBUSY. |
||
846 | * @new_mem: struct ttm_mem_reg indicating where to move. |
||
847 | * |
||
848 | * Fallback move function for a mappable buffer object in mappable memory. |
||
849 | * The function will, if successful, |
||
850 | * free any old aperture space, and set (@new_mem)->mm_node to NULL, |
||
851 | * and update the (@bo)->mem placement flags. If unsuccessful, the old |
||
852 | * data remains untouched, and it's up to the caller to free the |
||
853 | * memory space indicated by @new_mem. |
||
854 | * Returns: |
||
855 | * !0: Failure. |
||
856 | */ |
||
857 | |||
858 | extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo, |
||
859 | bool evict, |
||
860 | bool no_wait, struct ttm_mem_reg *new_mem); |
||
861 | |||
862 | /** |
||
863 | * ttm_bo_free_old_node |
||
864 | * |
||
865 | * @bo: A pointer to a struct ttm_buffer_object. |
||
866 | * |
||
867 | * Utility function to free an old placement after a successful move. |
||
868 | */ |
||
869 | extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo); |
||
870 | |||
871 | /** |
||
872 | * ttm_bo_move_accel_cleanup. |
||
873 | * |
||
874 | * @bo: A pointer to a struct ttm_buffer_object. |
||
875 | * @sync_obj: A sync object that signals when moving is complete. |
||
876 | * @sync_obj_arg: An argument to pass to the sync object idle / wait |
||
877 | * functions. |
||
878 | * @evict: This is an evict move. Don't return until the buffer is idle. |
||
879 | * @no_wait: Never sleep, but rather return with -EBUSY. |
||
880 | * @new_mem: struct ttm_mem_reg indicating where to move. |
||
881 | * |
||
882 | * Accelerated move function to be called when an accelerated move |
||
883 | * has been scheduled. The function will create a new temporary buffer object |
||
884 | * representing the old placement, and put the sync object on both buffer |
||
885 | * objects. After that the newly created buffer object is unref'd to be |
||
886 | * destroyed when the move is complete. This will help pipeline |
||
887 | * buffer moves. |
||
888 | */ |
||
889 | |||
890 | extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo, |
||
891 | void *sync_obj, |
||
892 | void *sync_obj_arg, |
||
893 | bool evict, bool no_wait, |
||
894 | struct ttm_mem_reg *new_mem); |
||
895 | /** |
||
896 | * ttm_io_prot |
||
897 | * |
||
898 | * @c_state: Caching state. |
||
899 | * @tmp: Page protection flag for a normal, cached mapping. |
||
900 | * |
||
901 | * Utility function that returns the pgprot_t that should be used for |
||
902 | * setting up a PTE with the caching model indicated by @c_state. |
||
903 | */ |
||
904 | extern pgprot_t ttm_io_prot(enum ttm_caching_state c_state, pgprot_t tmp); |
||
905 | |||
906 | #if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE))) |
||
907 | #define TTM_HAS_AGP |
||
908 | #include |
||
909 | |||
910 | /** |
||
911 | * ttm_agp_backend_init |
||
912 | * |
||
913 | * @bdev: Pointer to a struct ttm_bo_device. |
||
914 | * @bridge: The agp bridge this device is sitting on. |
||
915 | * |
||
916 | * Create a TTM backend that uses the indicated AGP bridge as an aperture |
||
917 | * for TT memory. This function uses the linux agpgart interface to |
||
918 | * bind and unbind memory backing a ttm_tt. |
||
919 | */ |
||
920 | extern struct ttm_backend *ttm_agp_backend_init(struct ttm_bo_device *bdev, |
||
921 | struct agp_bridge_data *bridge); |
||
922 | #endif |
||
923 | |||
924 | #endif>><>><>><>><>><>><>><>><>><>><>><>><> |