da39865d67d82d6cb6749fcaa84a1e80fc7d8ac4
[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 "ttm/ttm_module.h"
36 #include "drm_mm.h"
37 #include "linux/workqueue.h"
38 #include "linux/fs.h"
39 #include "linux/spinlock.h"
40
41 struct ttm_backend;
42
43 struct 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
112 struct 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_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_global *glob;
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  * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
245  * @invalidate_caches: Callback to invalidate read caches when a buffer object
246  * has been evicted.
247  * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager
248  * structure.
249  * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
250  * @move: Callback for a driver to hook in accelerated functions to
251  * move a buffer.
252  * If set to NULL, a potentially slow memcpy() move is used.
253  * @sync_obj_signaled: See ttm_fence_api.h
254  * @sync_obj_wait: See ttm_fence_api.h
255  * @sync_obj_flush: See ttm_fence_api.h
256  * @sync_obj_unref: See ttm_fence_api.h
257  * @sync_obj_ref: See ttm_fence_api.h
258  */
259
260 struct ttm_bo_driver {
261         /**
262          * struct ttm_bo_driver member create_ttm_backend_entry
263          *
264          * @bdev: The buffer object device.
265          *
266          * Create a driver specific struct ttm_backend.
267          */
268
269         struct ttm_backend *(*create_ttm_backend_entry)
270          (struct ttm_bo_device *bdev);
271
272         /**
273          * struct ttm_bo_driver member invalidate_caches
274          *
275          * @bdev: the buffer object device.
276          * @flags: new placement of the rebound buffer object.
277          *
278          * A previosly evicted buffer has been rebound in a
279          * potentially new location. Tell the driver that it might
280          * consider invalidating read (texture) caches on the next command
281          * submission as a consequence.
282          */
283
284         int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags);
285         int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type,
286                               struct ttm_mem_type_manager *man);
287         /**
288          * struct ttm_bo_driver member evict_flags:
289          *
290          * @bo: the buffer object to be evicted
291          *
292          * Return the bo flags for a buffer which is not mapped to the hardware.
293          * These will be placed in proposed_flags so that when the move is
294          * finished, they'll end up in bo->mem.flags
295          */
296
297          void(*evict_flags) (struct ttm_buffer_object *bo,
298                                 struct ttm_placement *placement);
299         /**
300          * struct ttm_bo_driver member move:
301          *
302          * @bo: the buffer to move
303          * @evict: whether this motion is evicting the buffer from
304          * the graphics address space
305          * @interruptible: Use interruptible sleeps if possible when sleeping.
306          * @no_wait: whether this should give up and return -EBUSY
307          * if this move would require sleeping
308          * @new_mem: the new memory region receiving the buffer
309          *
310          * Move a buffer between two memory regions.
311          */
312         int (*move) (struct ttm_buffer_object *bo,
313                      bool evict, bool interruptible,
314                      bool no_wait_reserve, bool no_wait_gpu,
315                      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);
348
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         int (*fault_reserve_notify)(struct ttm_buffer_object *bo);
356
357         /**
358          * notify the driver that we're about to swap out this bo
359          */
360         void (*swap_notify) (struct ttm_buffer_object *bo);
361
362         /**
363          * Driver callback on when mapping io memory (for bo_move_memcpy
364          * for instance). TTM will take care to call io_mem_free whenever
365          * the mapping is not use anymore. io_mem_reserve & io_mem_free
366          * are balanced.
367          */
368         int (*io_mem_reserve)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
369         void (*io_mem_free)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
370 };
371
372 /**
373  * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
374  */
375
376 struct ttm_bo_global_ref {
377         struct ttm_global_reference ref;
378         struct ttm_mem_global *mem_glob;
379 };
380
381 /**
382  * struct ttm_bo_global - Buffer object driver global data.
383  *
384  * @mem_glob: Pointer to a struct ttm_mem_global object for accounting.
385  * @dummy_read_page: Pointer to a dummy page used for mapping requests
386  * of unpopulated pages.
387  * @shrink: A shrink callback object used for buffer object swap.
388  * @ttm_bo_extra_size: Extra size (sizeof(struct ttm_buffer_object) excluded)
389  * used by a buffer object. This is excluding page arrays and backing pages.
390  * @ttm_bo_size: This is @ttm_bo_extra_size + sizeof(struct ttm_buffer_object).
391  * @device_list_mutex: Mutex protecting the device list.
392  * This mutex is held while traversing the device list for pm options.
393  * @lru_lock: Spinlock protecting the bo subsystem lru lists.
394  * @device_list: List of buffer object devices.
395  * @swap_lru: Lru list of buffer objects used for swapping.
396  */
397
398 struct ttm_bo_global {
399
400         /**
401          * Constant after init.
402          */
403
404         struct kobject kobj;
405         struct ttm_mem_global *mem_glob;
406         struct page *dummy_read_page;
407         struct ttm_mem_shrink shrink;
408         size_t ttm_bo_extra_size;
409         size_t ttm_bo_size;
410         struct mutex device_list_mutex;
411         spinlock_t lru_lock;
412
413         /**
414          * Protected by device_list_mutex.
415          */
416         struct list_head device_list;
417
418         /**
419          * Protected by the lru_lock.
420          */
421         struct list_head swap_lru;
422
423         /**
424          * Internal protection.
425          */
426         atomic_t bo_count;
427 };
428
429
430 #define TTM_NUM_MEM_TYPES 8
431
432 #define TTM_BO_PRIV_FLAG_MOVING  0      /* Buffer object is moving and needs
433                                            idling before CPU mapping */
434 #define TTM_BO_PRIV_FLAG_MAX 1
435 /**
436  * struct ttm_bo_device - Buffer object driver device-specific data.
437  *
438  * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
439  * @man: An array of mem_type_managers.
440  * @addr_space_mm: Range manager for the device address space.
441  * lru_lock: Spinlock that protects the buffer+device lru lists and
442  * ddestroy lists.
443  * @nice_mode: Try nicely to wait for buffer idle when cleaning a manager.
444  * If a GPU lockup has been detected, this is forced to 0.
445  * @dev_mapping: A pointer to the struct address_space representing the
446  * device address space.
447  * @wq: Work queue structure for the delayed delete workqueue.
448  *
449  */
450
451 struct ttm_bo_device {
452
453         /*
454          * Constant after bo device init / atomic.
455          */
456         struct list_head device_list;
457         struct ttm_bo_global *glob;
458         struct ttm_bo_driver *driver;
459         rwlock_t vm_lock;
460         struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES];
461         /*
462          * Protected by the vm lock.
463          */
464         struct rb_root addr_space_rb;
465         struct drm_mm addr_space_mm;
466
467         /*
468          * Protected by the global:lru lock.
469          */
470         struct list_head ddestroy;
471
472         /*
473          * Protected by load / firstopen / lastclose /unload sync.
474          */
475
476         bool nice_mode;
477         struct address_space *dev_mapping;
478
479         /*
480          * Internal protection.
481          */
482
483         struct delayed_work wq;
484
485         bool need_dma32;
486 };
487
488 /**
489  * ttm_flag_masked
490  *
491  * @old: Pointer to the result and original value.
492  * @new: New value of bits.
493  * @mask: Mask of bits to change.
494  *
495  * Convenience function to change a number of bits identified by a mask.
496  */
497
498 static inline uint32_t
499 ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask)
500 {
501         *old ^= (*old ^ new) & mask;
502         return *old;
503 }
504
505 /**
506  * ttm_tt_create
507  *
508  * @bdev: pointer to a struct ttm_bo_device:
509  * @size: Size of the data needed backing.
510  * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
511  * @dummy_read_page: See struct ttm_bo_device.
512  *
513  * Create a struct ttm_tt to back data with system memory pages.
514  * No pages are actually allocated.
515  * Returns:
516  * NULL: Out of memory.
517  */
518 extern struct ttm_tt *ttm_tt_create(struct ttm_bo_device *bdev,
519                                     unsigned long size,
520                                     uint32_t page_flags,
521                                     struct page *dummy_read_page);
522
523 /**
524  * ttm_tt_set_user:
525  *
526  * @ttm: The struct ttm_tt to populate.
527  * @tsk: A struct task_struct for which @start is a valid user-space address.
528  * @start: A valid user-space address.
529  * @num_pages: Size in pages of the user memory area.
530  *
531  * Populate a struct ttm_tt with a user-space memory area after first pinning
532  * the pages backing it.
533  * Returns:
534  * !0: Error.
535  */
536
537 extern int ttm_tt_set_user(struct ttm_tt *ttm,
538                            struct task_struct *tsk,
539                            unsigned long start, unsigned long num_pages);
540
541 /**
542  * ttm_ttm_bind:
543  *
544  * @ttm: The struct ttm_tt containing backing pages.
545  * @bo_mem: The struct ttm_mem_reg identifying the binding location.
546  *
547  * Bind the pages of @ttm to an aperture location identified by @bo_mem
548  */
549 extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
550
551 /**
552  * ttm_tt_populate:
553  *
554  * @ttm: The struct ttm_tt to contain the backing pages.
555  *
556  * Add backing pages to all of @ttm
557  */
558 extern int ttm_tt_populate(struct ttm_tt *ttm);
559
560 /**
561  * ttm_ttm_destroy:
562  *
563  * @ttm: The struct ttm_tt.
564  *
565  * Unbind, unpopulate and destroy a struct ttm_tt.
566  */
567 extern void ttm_tt_destroy(struct ttm_tt *ttm);
568
569 /**
570  * ttm_ttm_unbind:
571  *
572  * @ttm: The struct ttm_tt.
573  *
574  * Unbind a struct ttm_tt.
575  */
576 extern void ttm_tt_unbind(struct ttm_tt *ttm);
577
578 /**
579  * ttm_ttm_destroy:
580  *
581  * @ttm: The struct ttm_tt.
582  * @index: Index of the desired page.
583  *
584  * Return a pointer to the struct page backing @ttm at page
585  * index @index. If the page is unpopulated, one will be allocated to
586  * populate that index.
587  *
588  * Returns:
589  * NULL on OOM.
590  */
591 extern struct page *ttm_tt_get_page(struct ttm_tt *ttm, int index);
592
593 /**
594  * ttm_tt_cache_flush:
595  *
596  * @pages: An array of pointers to struct page:s to flush.
597  * @num_pages: Number of pages to flush.
598  *
599  * Flush the data of the indicated pages from the cpu caches.
600  * This is used when changing caching attributes of the pages from
601  * cache-coherent.
602  */
603 extern void ttm_tt_cache_flush(struct page *pages[], unsigned long num_pages);
604
605 /**
606  * ttm_tt_set_placement_caching:
607  *
608  * @ttm A struct ttm_tt the backing pages of which will change caching policy.
609  * @placement: Flag indicating the desired caching policy.
610  *
611  * This function will change caching policy of any default kernel mappings of
612  * the pages backing @ttm. If changing from cached to uncached or
613  * write-combined,
614  * all CPU caches will first be flushed to make sure the data of the pages
615  * hit RAM. This function may be very costly as it involves global TLB
616  * and cache flushes and potential page splitting / combining.
617  */
618 extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement);
619 extern int ttm_tt_swapout(struct ttm_tt *ttm,
620                           struct file *persistant_swap_storage);
621
622 /*
623  * ttm_bo.c
624  */
625
626 /**
627  * ttm_mem_reg_is_pci
628  *
629  * @bdev: Pointer to a struct ttm_bo_device.
630  * @mem: A valid struct ttm_mem_reg.
631  *
632  * Returns true if the memory described by @mem is PCI memory,
633  * false otherwise.
634  */
635 extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev,
636                                    struct ttm_mem_reg *mem);
637
638 /**
639  * ttm_bo_mem_space
640  *
641  * @bo: Pointer to a struct ttm_buffer_object. the data of which
642  * we want to allocate space for.
643  * @proposed_placement: Proposed new placement for the buffer object.
644  * @mem: A struct ttm_mem_reg.
645  * @interruptible: Sleep interruptible when sliping.
646  * @no_wait_reserve: Return immediately if other buffers are busy.
647  * @no_wait_gpu: Return immediately if the GPU is busy.
648  *
649  * Allocate memory space for the buffer object pointed to by @bo, using
650  * the placement flags in @mem, potentially evicting other idle buffer objects.
651  * This function may sleep while waiting for space to become available.
652  * Returns:
653  * -EBUSY: No space available (only if no_wait == 1).
654  * -ENOMEM: Could not allocate memory for the buffer object, either due to
655  * fragmentation or concurrent allocators.
656  * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
657  */
658 extern int ttm_bo_mem_space(struct ttm_buffer_object *bo,
659                                 struct ttm_placement *placement,
660                                 struct ttm_mem_reg *mem,
661                                 bool interruptible,
662                                 bool no_wait_reserve, bool no_wait_gpu);
663 /**
664  * ttm_bo_wait_for_cpu
665  *
666  * @bo: Pointer to a struct ttm_buffer_object.
667  * @no_wait: Don't sleep while waiting.
668  *
669  * Wait until a buffer object is no longer sync'ed for CPU access.
670  * Returns:
671  * -EBUSY: Buffer object was sync'ed for CPU access. (only if no_wait == 1).
672  * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
673  */
674
675 extern int ttm_bo_wait_cpu(struct ttm_buffer_object *bo, bool no_wait);
676
677 /**
678  * ttm_bo_pci_offset - Get the PCI offset for the buffer object memory.
679  *
680  * @bo Pointer to a struct ttm_buffer_object.
681  * @bus_base On return the base of the PCI region
682  * @bus_offset On return the byte offset into the PCI region
683  * @bus_size On return the byte size of the buffer object or zero if
684  * the buffer object memory is not accessible through a PCI region.
685  *
686  * Returns:
687  * -EINVAL if the buffer object is currently not mappable.
688  * 0 otherwise.
689  */
690
691 extern int ttm_bo_pci_offset(struct ttm_bo_device *bdev,
692                              struct ttm_mem_reg *mem,
693                              unsigned long *bus_base,
694                              unsigned long *bus_offset,
695                              unsigned long *bus_size);
696
697 extern int ttm_mem_io_reserve(struct ttm_bo_device *bdev,
698                                 struct ttm_mem_reg *mem);
699 extern void ttm_mem_io_free(struct ttm_bo_device *bdev,
700                                 struct ttm_mem_reg *mem);
701
702 extern void ttm_bo_global_release(struct ttm_global_reference *ref);
703 extern int ttm_bo_global_init(struct ttm_global_reference *ref);
704
705 extern int ttm_bo_device_release(struct ttm_bo_device *bdev);
706
707 /**
708  * ttm_bo_device_init
709  *
710  * @bdev: A pointer to a struct ttm_bo_device to initialize.
711  * @mem_global: A pointer to an initialized struct ttm_mem_global.
712  * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
713  * @file_page_offset: Offset into the device address space that is available
714  * for buffer data. This ensures compatibility with other users of the
715  * address space.
716  *
717  * Initializes a struct ttm_bo_device:
718  * Returns:
719  * !0: Failure.
720  */
721 extern int ttm_bo_device_init(struct ttm_bo_device *bdev,
722                               struct ttm_bo_global *glob,
723                               struct ttm_bo_driver *driver,
724                               uint64_t file_page_offset, bool need_dma32);
725
726 /**
727  * ttm_bo_unmap_virtual
728  *
729  * @bo: tear down the virtual mappings for this BO
730  */
731 extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
732
733 /**
734  * ttm_bo_reserve:
735  *
736  * @bo: A pointer to a struct ttm_buffer_object.
737  * @interruptible: Sleep interruptible if waiting.
738  * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
739  * @use_sequence: If @bo is already reserved, Only sleep waiting for
740  * it to become unreserved if @sequence < (@bo)->sequence.
741  *
742  * Locks a buffer object for validation. (Or prevents other processes from
743  * locking it for validation) and removes it from lru lists, while taking
744  * a number of measures to prevent deadlocks.
745  *
746  * Deadlocks may occur when two processes try to reserve multiple buffers in
747  * different order, either by will or as a result of a buffer being evicted
748  * to make room for a buffer already reserved. (Buffers are reserved before
749  * they are evicted). The following algorithm prevents such deadlocks from
750  * occuring:
751  * 1) Buffers are reserved with the lru spinlock held. Upon successful
752  * reservation they are removed from the lru list. This stops a reserved buffer
753  * from being evicted. However the lru spinlock is released between the time
754  * a buffer is selected for eviction and the time it is reserved.
755  * Therefore a check is made when a buffer is reserved for eviction, that it
756  * is still the first buffer in the lru list, before it is removed from the
757  * list. @check_lru == 1 forces this check. If it fails, the function returns
758  * -EINVAL, and the caller should then choose a new buffer to evict and repeat
759  * the procedure.
760  * 2) Processes attempting to reserve multiple buffers other than for eviction,
761  * (typically execbuf), should first obtain a unique 32-bit
762  * validation sequence number,
763  * and call this function with @use_sequence == 1 and @sequence == the unique
764  * sequence number. If upon call of this function, the buffer object is already
765  * reserved, the validation sequence is checked against the validation
766  * sequence of the process currently reserving the buffer,
767  * and if the current validation sequence is greater than that of the process
768  * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps
769  * waiting for the buffer to become unreserved, after which it retries
770  * reserving.
771  * The caller should, when receiving an -EAGAIN error
772  * release all its buffer reservations, wait for @bo to become unreserved, and
773  * then rerun the validation with the same validation sequence. This procedure
774  * will always guarantee that the process with the lowest validation sequence
775  * will eventually succeed, preventing both deadlocks and starvation.
776  *
777  * Returns:
778  * -EAGAIN: The reservation may cause a deadlock.
779  * Release all buffer reservations, wait for @bo to become unreserved and
780  * try again. (only if use_sequence == 1).
781  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
782  * a signal. Release all buffer reservations and return to user-space.
783  */
784 extern int ttm_bo_reserve(struct ttm_buffer_object *bo,
785                           bool interruptible,
786                           bool no_wait, bool use_sequence, uint32_t sequence);
787
788 /**
789  * ttm_bo_unreserve
790  *
791  * @bo: A pointer to a struct ttm_buffer_object.
792  *
793  * Unreserve a previous reservation of @bo.
794  */
795 extern void ttm_bo_unreserve(struct ttm_buffer_object *bo);
796
797 /**
798  * ttm_bo_wait_unreserved
799  *
800  * @bo: A pointer to a struct ttm_buffer_object.
801  *
802  * Wait for a struct ttm_buffer_object to become unreserved.
803  * This is typically used in the execbuf code to relax cpu-usage when
804  * a potential deadlock condition backoff.
805  */
806 extern int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo,
807                                   bool interruptible);
808
809 /**
810  * ttm_bo_block_reservation
811  *
812  * @bo: A pointer to a struct ttm_buffer_object.
813  * @interruptible: Use interruptible sleep when waiting.
814  * @no_wait: Don't sleep, but rather return -EBUSY.
815  *
816  * Block reservation for validation by simply reserving the buffer.
817  * This is intended for single buffer use only without eviction,
818  * and thus needs no deadlock protection.
819  *
820  * Returns:
821  * -EBUSY: If no_wait == 1 and the buffer is already reserved.
822  * -ERESTARTSYS: If interruptible == 1 and the process received a signal
823  * while sleeping.
824  */
825 extern int ttm_bo_block_reservation(struct ttm_buffer_object *bo,
826                                     bool interruptible, bool no_wait);
827
828 /**
829  * ttm_bo_unblock_reservation
830  *
831  * @bo: A pointer to a struct ttm_buffer_object.
832  *
833  * Unblocks reservation leaving lru lists untouched.
834  */
835 extern void ttm_bo_unblock_reservation(struct ttm_buffer_object *bo);
836
837 /*
838  * ttm_bo_util.c
839  */
840
841 /**
842  * ttm_bo_move_ttm
843  *
844  * @bo: A pointer to a struct ttm_buffer_object.
845  * @evict: 1: This is an eviction. Don't try to pipeline.
846  * @no_wait_reserve: Return immediately if other buffers are busy.
847  * @no_wait_gpu: Return immediately if the GPU is busy.
848  * @new_mem: struct ttm_mem_reg indicating where to move.
849  *
850  * Optimized move function for a buffer object with both old and
851  * new placement backed by a TTM. The function will, if successful,
852  * free any old aperture space, and set (@new_mem)->mm_node to NULL,
853  * and update the (@bo)->mem placement flags. If unsuccessful, the old
854  * data remains untouched, and it's up to the caller to free the
855  * memory space indicated by @new_mem.
856  * Returns:
857  * !0: Failure.
858  */
859
860 extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
861                            bool evict, bool no_wait_reserve,
862                            bool no_wait_gpu, struct ttm_mem_reg *new_mem);
863
864 /**
865  * ttm_bo_move_memcpy
866  *
867  * @bo: A pointer to a struct ttm_buffer_object.
868  * @evict: 1: This is an eviction. Don't try to pipeline.
869  * @no_wait_reserve: Return immediately if other buffers are busy.
870  * @no_wait_gpu: Return immediately if the GPU is busy.
871  * @new_mem: struct ttm_mem_reg indicating where to move.
872  *
873  * Fallback move function for a mappable buffer object in mappable memory.
874  * The function will, if successful,
875  * free any old aperture space, and set (@new_mem)->mm_node to NULL,
876  * and update the (@bo)->mem placement flags. If unsuccessful, the old
877  * data remains untouched, and it's up to the caller to free the
878  * memory space indicated by @new_mem.
879  * Returns:
880  * !0: Failure.
881  */
882
883 extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
884                               bool evict, bool no_wait_reserve,
885                               bool no_wait_gpu, struct ttm_mem_reg *new_mem);
886
887 /**
888  * ttm_bo_free_old_node
889  *
890  * @bo: A pointer to a struct ttm_buffer_object.
891  *
892  * Utility function to free an old placement after a successful move.
893  */
894 extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
895
896 /**
897  * ttm_bo_move_accel_cleanup.
898  *
899  * @bo: A pointer to a struct ttm_buffer_object.
900  * @sync_obj: A sync object that signals when moving is complete.
901  * @sync_obj_arg: An argument to pass to the sync object idle / wait
902  * functions.
903  * @evict: This is an evict move. Don't return until the buffer is idle.
904  * @no_wait_reserve: Return immediately if other buffers are busy.
905  * @no_wait_gpu: Return immediately if the GPU is busy.
906  * @new_mem: struct ttm_mem_reg indicating where to move.
907  *
908  * Accelerated move function to be called when an accelerated move
909  * has been scheduled. The function will create a new temporary buffer object
910  * representing the old placement, and put the sync object on both buffer
911  * objects. After that the newly created buffer object is unref'd to be
912  * destroyed when the move is complete. This will help pipeline
913  * buffer moves.
914  */
915
916 extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
917                                      void *sync_obj,
918                                      void *sync_obj_arg,
919                                      bool evict, bool no_wait_reserve,
920                                      bool no_wait_gpu,
921                                      struct ttm_mem_reg *new_mem);
922 /**
923  * ttm_io_prot
924  *
925  * @c_state: Caching state.
926  * @tmp: Page protection flag for a normal, cached mapping.
927  *
928  * Utility function that returns the pgprot_t that should be used for
929  * setting up a PTE with the caching model indicated by @c_state.
930  */
931 extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
932
933 #if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
934 #define TTM_HAS_AGP
935 #include <linux/agp_backend.h>
936
937 /**
938  * ttm_agp_backend_init
939  *
940  * @bdev: Pointer to a struct ttm_bo_device.
941  * @bridge: The agp bridge this device is sitting on.
942  *
943  * Create a TTM backend that uses the indicated AGP bridge as an aperture
944  * for TT memory. This function uses the linux agpgart interface to
945  * bind and unbind memory backing a ttm_tt.
946  */
947 extern struct ttm_backend *ttm_agp_backend_init(struct ttm_bo_device *bdev,
948                                                 struct agp_bridge_data *bridge);
949 #endif
950
951 #endif