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