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