Merge branch 'dbg-early-merge' of git://git.kernel.org/pub/scm/linux/kernel/git/jwess...
[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, struct ttm_mem_reg *new_mem);
315
316         /**
317          * struct ttm_bo_driver_member verify_access
318          *
319          * @bo: Pointer to a buffer object.
320          * @filp: Pointer to a struct file trying to access the object.
321          *
322          * Called from the map / write / read methods to verify that the
323          * caller is permitted to access the buffer object.
324          * This member may be set to NULL, which will refuse this kind of
325          * access for all buffer objects.
326          * This function should return 0 if access is granted, -EPERM otherwise.
327          */
328         int (*verify_access) (struct ttm_buffer_object *bo,
329                               struct file *filp);
330
331         /**
332          * In case a driver writer dislikes the TTM fence objects,
333          * the driver writer can replace those with sync objects of
334          * his / her own. If it turns out that no driver writer is
335          * using these. I suggest we remove these hooks and plug in
336          * fences directly. The bo driver needs the following functionality:
337          * See the corresponding functions in the fence object API
338          * documentation.
339          */
340
341         bool (*sync_obj_signaled) (void *sync_obj, void *sync_arg);
342         int (*sync_obj_wait) (void *sync_obj, void *sync_arg,
343                               bool lazy, bool interruptible);
344         int (*sync_obj_flush) (void *sync_obj, void *sync_arg);
345         void (*sync_obj_unref) (void **sync_obj);
346         void *(*sync_obj_ref) (void *sync_obj);
347
348         /* hook to notify driver about a driver move so it
349          * can do tiling things */
350         void (*move_notify)(struct ttm_buffer_object *bo,
351                             struct ttm_mem_reg *new_mem);
352         /* notify the driver we are taking a fault on this BO
353          * and have reserved it */
354         void (*fault_reserve_notify)(struct ttm_buffer_object *bo);
355
356         /**
357          * notify the driver that we're about to swap out this bo
358          */
359         void (*swap_notify) (struct ttm_buffer_object *bo);
360 };
361
362 /**
363  * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
364  */
365
366 struct ttm_bo_global_ref {
367         struct ttm_global_reference ref;
368         struct ttm_mem_global *mem_glob;
369 };
370
371 /**
372  * struct ttm_bo_global - Buffer object driver global data.
373  *
374  * @mem_glob: Pointer to a struct ttm_mem_global object for accounting.
375  * @dummy_read_page: Pointer to a dummy page used for mapping requests
376  * of unpopulated pages.
377  * @shrink: A shrink callback object used for buffer object swap.
378  * @ttm_bo_extra_size: Extra size (sizeof(struct ttm_buffer_object) excluded)
379  * used by a buffer object. This is excluding page arrays and backing pages.
380  * @ttm_bo_size: This is @ttm_bo_extra_size + sizeof(struct ttm_buffer_object).
381  * @device_list_mutex: Mutex protecting the device list.
382  * This mutex is held while traversing the device list for pm options.
383  * @lru_lock: Spinlock protecting the bo subsystem lru lists.
384  * @device_list: List of buffer object devices.
385  * @swap_lru: Lru list of buffer objects used for swapping.
386  */
387
388 struct ttm_bo_global {
389
390         /**
391          * Constant after init.
392          */
393
394         struct kobject kobj;
395         struct ttm_mem_global *mem_glob;
396         struct page *dummy_read_page;
397         struct ttm_mem_shrink shrink;
398         size_t ttm_bo_extra_size;
399         size_t ttm_bo_size;
400         struct mutex device_list_mutex;
401         spinlock_t lru_lock;
402
403         /**
404          * Protected by device_list_mutex.
405          */
406         struct list_head device_list;
407
408         /**
409          * Protected by the lru_lock.
410          */
411         struct list_head swap_lru;
412
413         /**
414          * Internal protection.
415          */
416         atomic_t bo_count;
417 };
418
419
420 #define TTM_NUM_MEM_TYPES 8
421
422 #define TTM_BO_PRIV_FLAG_MOVING  0      /* Buffer object is moving and needs
423                                            idling before CPU mapping */
424 #define TTM_BO_PRIV_FLAG_MAX 1
425 /**
426  * struct ttm_bo_device - Buffer object driver device-specific data.
427  *
428  * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
429  * @man: An array of mem_type_managers.
430  * @addr_space_mm: Range manager for the device address space.
431  * lru_lock: Spinlock that protects the buffer+device lru lists and
432  * ddestroy lists.
433  * @nice_mode: Try nicely to wait for buffer idle when cleaning a manager.
434  * If a GPU lockup has been detected, this is forced to 0.
435  * @dev_mapping: A pointer to the struct address_space representing the
436  * device address space.
437  * @wq: Work queue structure for the delayed delete workqueue.
438  *
439  */
440
441 struct ttm_bo_device {
442
443         /*
444          * Constant after bo device init / atomic.
445          */
446         struct list_head device_list;
447         struct ttm_bo_global *glob;
448         struct ttm_bo_driver *driver;
449         rwlock_t vm_lock;
450         struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES];
451         /*
452          * Protected by the vm lock.
453          */
454         struct rb_root addr_space_rb;
455         struct drm_mm addr_space_mm;
456
457         /*
458          * Protected by the global:lru lock.
459          */
460         struct list_head ddestroy;
461
462         /*
463          * Protected by load / firstopen / lastclose /unload sync.
464          */
465
466         bool nice_mode;
467         struct address_space *dev_mapping;
468
469         /*
470          * Internal protection.
471          */
472
473         struct delayed_work wq;
474
475         bool need_dma32;
476 };
477
478 /**
479  * ttm_flag_masked
480  *
481  * @old: Pointer to the result and original value.
482  * @new: New value of bits.
483  * @mask: Mask of bits to change.
484  *
485  * Convenience function to change a number of bits identified by a mask.
486  */
487
488 static inline uint32_t
489 ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask)
490 {
491         *old ^= (*old ^ new) & mask;
492         return *old;
493 }
494
495 /**
496  * ttm_tt_create
497  *
498  * @bdev: pointer to a struct ttm_bo_device:
499  * @size: Size of the data needed backing.
500  * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
501  * @dummy_read_page: See struct ttm_bo_device.
502  *
503  * Create a struct ttm_tt to back data with system memory pages.
504  * No pages are actually allocated.
505  * Returns:
506  * NULL: Out of memory.
507  */
508 extern struct ttm_tt *ttm_tt_create(struct ttm_bo_device *bdev,
509                                     unsigned long size,
510                                     uint32_t page_flags,
511                                     struct page *dummy_read_page);
512
513 /**
514  * ttm_tt_set_user:
515  *
516  * @ttm: The struct ttm_tt to populate.
517  * @tsk: A struct task_struct for which @start is a valid user-space address.
518  * @start: A valid user-space address.
519  * @num_pages: Size in pages of the user memory area.
520  *
521  * Populate a struct ttm_tt with a user-space memory area after first pinning
522  * the pages backing it.
523  * Returns:
524  * !0: Error.
525  */
526
527 extern int ttm_tt_set_user(struct ttm_tt *ttm,
528                            struct task_struct *tsk,
529                            unsigned long start, unsigned long num_pages);
530
531 /**
532  * ttm_ttm_bind:
533  *
534  * @ttm: The struct ttm_tt containing backing pages.
535  * @bo_mem: The struct ttm_mem_reg identifying the binding location.
536  *
537  * Bind the pages of @ttm to an aperture location identified by @bo_mem
538  */
539 extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
540
541 /**
542  * ttm_tt_populate:
543  *
544  * @ttm: The struct ttm_tt to contain the backing pages.
545  *
546  * Add backing pages to all of @ttm
547  */
548 extern int ttm_tt_populate(struct ttm_tt *ttm);
549
550 /**
551  * ttm_ttm_destroy:
552  *
553  * @ttm: The struct ttm_tt.
554  *
555  * Unbind, unpopulate and destroy a struct ttm_tt.
556  */
557 extern void ttm_tt_destroy(struct ttm_tt *ttm);
558
559 /**
560  * ttm_ttm_unbind:
561  *
562  * @ttm: The struct ttm_tt.
563  *
564  * Unbind a struct ttm_tt.
565  */
566 extern void ttm_tt_unbind(struct ttm_tt *ttm);
567
568 /**
569  * ttm_ttm_destroy:
570  *
571  * @ttm: The struct ttm_tt.
572  * @index: Index of the desired page.
573  *
574  * Return a pointer to the struct page backing @ttm at page
575  * index @index. If the page is unpopulated, one will be allocated to
576  * populate that index.
577  *
578  * Returns:
579  * NULL on OOM.
580  */
581 extern struct page *ttm_tt_get_page(struct ttm_tt *ttm, int index);
582
583 /**
584  * ttm_tt_cache_flush:
585  *
586  * @pages: An array of pointers to struct page:s to flush.
587  * @num_pages: Number of pages to flush.
588  *
589  * Flush the data of the indicated pages from the cpu caches.
590  * This is used when changing caching attributes of the pages from
591  * cache-coherent.
592  */
593 extern void ttm_tt_cache_flush(struct page *pages[], unsigned long num_pages);
594
595 /**
596  * ttm_tt_set_placement_caching:
597  *
598  * @ttm A struct ttm_tt the backing pages of which will change caching policy.
599  * @placement: Flag indicating the desired caching policy.
600  *
601  * This function will change caching policy of any default kernel mappings of
602  * the pages backing @ttm. If changing from cached to uncached or
603  * write-combined,
604  * all CPU caches will first be flushed to make sure the data of the pages
605  * hit RAM. This function may be very costly as it involves global TLB
606  * and cache flushes and potential page splitting / combining.
607  */
608 extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement);
609 extern int ttm_tt_swapout(struct ttm_tt *ttm,
610                           struct file *persistant_swap_storage);
611
612 /*
613  * ttm_bo.c
614  */
615
616 /**
617  * ttm_mem_reg_is_pci
618  *
619  * @bdev: Pointer to a struct ttm_bo_device.
620  * @mem: A valid struct ttm_mem_reg.
621  *
622  * Returns true if the memory described by @mem is PCI memory,
623  * false otherwise.
624  */
625 extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev,
626                                    struct ttm_mem_reg *mem);
627
628 /**
629  * ttm_bo_mem_space
630  *
631  * @bo: Pointer to a struct ttm_buffer_object. the data of which
632  * we want to allocate space for.
633  * @proposed_placement: Proposed new placement for the buffer object.
634  * @mem: A struct ttm_mem_reg.
635  * @interruptible: Sleep interruptible when sliping.
636  * @no_wait: Don't sleep waiting for space to become available.
637  *
638  * Allocate memory space for the buffer object pointed to by @bo, using
639  * the placement flags in @mem, potentially evicting other idle buffer objects.
640  * This function may sleep while waiting for space to become available.
641  * Returns:
642  * -EBUSY: No space available (only if no_wait == 1).
643  * -ENOMEM: Could not allocate memory for the buffer object, either due to
644  * fragmentation or concurrent allocators.
645  * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
646  */
647 extern int ttm_bo_mem_space(struct ttm_buffer_object *bo,
648                                 struct ttm_placement *placement,
649                                 struct ttm_mem_reg *mem,
650                                 bool interruptible, bool no_wait);
651 /**
652  * ttm_bo_wait_for_cpu
653  *
654  * @bo: Pointer to a struct ttm_buffer_object.
655  * @no_wait: Don't sleep while waiting.
656  *
657  * Wait until a buffer object is no longer sync'ed for CPU access.
658  * Returns:
659  * -EBUSY: Buffer object was sync'ed for CPU access. (only if no_wait == 1).
660  * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
661  */
662
663 extern int ttm_bo_wait_cpu(struct ttm_buffer_object *bo, bool no_wait);
664
665 /**
666  * ttm_bo_pci_offset - Get the PCI offset for the buffer object memory.
667  *
668  * @bo Pointer to a struct ttm_buffer_object.
669  * @bus_base On return the base of the PCI region
670  * @bus_offset On return the byte offset into the PCI region
671  * @bus_size On return the byte size of the buffer object or zero if
672  * the buffer object memory is not accessible through a PCI region.
673  *
674  * Returns:
675  * -EINVAL if the buffer object is currently not mappable.
676  * 0 otherwise.
677  */
678
679 extern int ttm_bo_pci_offset(struct ttm_bo_device *bdev,
680                              struct ttm_mem_reg *mem,
681                              unsigned long *bus_base,
682                              unsigned long *bus_offset,
683                              unsigned long *bus_size);
684
685 extern void ttm_bo_global_release(struct ttm_global_reference *ref);
686 extern int ttm_bo_global_init(struct ttm_global_reference *ref);
687
688 extern int ttm_bo_device_release(struct ttm_bo_device *bdev);
689
690 /**
691  * ttm_bo_device_init
692  *
693  * @bdev: A pointer to a struct ttm_bo_device to initialize.
694  * @mem_global: A pointer to an initialized struct ttm_mem_global.
695  * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
696  * @file_page_offset: Offset into the device address space that is available
697  * for buffer data. This ensures compatibility with other users of the
698  * address space.
699  *
700  * Initializes a struct ttm_bo_device:
701  * Returns:
702  * !0: Failure.
703  */
704 extern int ttm_bo_device_init(struct ttm_bo_device *bdev,
705                               struct ttm_bo_global *glob,
706                               struct ttm_bo_driver *driver,
707                               uint64_t file_page_offset, bool need_dma32);
708
709 /**
710  * ttm_bo_unmap_virtual
711  *
712  * @bo: tear down the virtual mappings for this BO
713  */
714 extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
715
716 /**
717  * ttm_bo_reserve:
718  *
719  * @bo: A pointer to a struct ttm_buffer_object.
720  * @interruptible: Sleep interruptible if waiting.
721  * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
722  * @use_sequence: If @bo is already reserved, Only sleep waiting for
723  * it to become unreserved if @sequence < (@bo)->sequence.
724  *
725  * Locks a buffer object for validation. (Or prevents other processes from
726  * locking it for validation) and removes it from lru lists, while taking
727  * a number of measures to prevent deadlocks.
728  *
729  * Deadlocks may occur when two processes try to reserve multiple buffers in
730  * different order, either by will or as a result of a buffer being evicted
731  * to make room for a buffer already reserved. (Buffers are reserved before
732  * they are evicted). The following algorithm prevents such deadlocks from
733  * occuring:
734  * 1) Buffers are reserved with the lru spinlock held. Upon successful
735  * reservation they are removed from the lru list. This stops a reserved buffer
736  * from being evicted. However the lru spinlock is released between the time
737  * a buffer is selected for eviction and the time it is reserved.
738  * Therefore a check is made when a buffer is reserved for eviction, that it
739  * is still the first buffer in the lru list, before it is removed from the
740  * list. @check_lru == 1 forces this check. If it fails, the function returns
741  * -EINVAL, and the caller should then choose a new buffer to evict and repeat
742  * the procedure.
743  * 2) Processes attempting to reserve multiple buffers other than for eviction,
744  * (typically execbuf), should first obtain a unique 32-bit
745  * validation sequence number,
746  * and call this function with @use_sequence == 1 and @sequence == the unique
747  * sequence number. If upon call of this function, the buffer object is already
748  * reserved, the validation sequence is checked against the validation
749  * sequence of the process currently reserving the buffer,
750  * and if the current validation sequence is greater than that of the process
751  * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps
752  * waiting for the buffer to become unreserved, after which it retries
753  * reserving.
754  * The caller should, when receiving an -EAGAIN error
755  * release all its buffer reservations, wait for @bo to become unreserved, and
756  * then rerun the validation with the same validation sequence. This procedure
757  * will always guarantee that the process with the lowest validation sequence
758  * will eventually succeed, preventing both deadlocks and starvation.
759  *
760  * Returns:
761  * -EAGAIN: The reservation may cause a deadlock.
762  * Release all buffer reservations, wait for @bo to become unreserved and
763  * try again. (only if use_sequence == 1).
764  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
765  * a signal. Release all buffer reservations and return to user-space.
766  */
767 extern int ttm_bo_reserve(struct ttm_buffer_object *bo,
768                           bool interruptible,
769                           bool no_wait, bool use_sequence, uint32_t sequence);
770
771 /**
772  * ttm_bo_unreserve
773  *
774  * @bo: A pointer to a struct ttm_buffer_object.
775  *
776  * Unreserve a previous reservation of @bo.
777  */
778 extern void ttm_bo_unreserve(struct ttm_buffer_object *bo);
779
780 /**
781  * ttm_bo_wait_unreserved
782  *
783  * @bo: A pointer to a struct ttm_buffer_object.
784  *
785  * Wait for a struct ttm_buffer_object to become unreserved.
786  * This is typically used in the execbuf code to relax cpu-usage when
787  * a potential deadlock condition backoff.
788  */
789 extern int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo,
790                                   bool interruptible);
791
792 /*
793  * ttm_bo_util.c
794  */
795
796 /**
797  * ttm_bo_move_ttm
798  *
799  * @bo: A pointer to a struct ttm_buffer_object.
800  * @evict: 1: This is an eviction. Don't try to pipeline.
801  * @no_wait: Never sleep, but rather return with -EBUSY.
802  * @new_mem: struct ttm_mem_reg indicating where to move.
803  *
804  * Optimized move function for a buffer object with both old and
805  * new placement backed by a TTM. The function will, if successful,
806  * free any old aperture space, and set (@new_mem)->mm_node to NULL,
807  * and update the (@bo)->mem placement flags. If unsuccessful, the old
808  * data remains untouched, and it's up to the caller to free the
809  * memory space indicated by @new_mem.
810  * Returns:
811  * !0: Failure.
812  */
813
814 extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
815                            bool evict, bool no_wait,
816                            struct ttm_mem_reg *new_mem);
817
818 /**
819  * ttm_bo_move_memcpy
820  *
821  * @bo: A pointer to a struct ttm_buffer_object.
822  * @evict: 1: This is an eviction. Don't try to pipeline.
823  * @no_wait: Never sleep, but rather return with -EBUSY.
824  * @new_mem: struct ttm_mem_reg indicating where to move.
825  *
826  * Fallback move function for a mappable buffer object in mappable memory.
827  * The function will, if successful,
828  * free any old aperture space, and set (@new_mem)->mm_node to NULL,
829  * and update the (@bo)->mem placement flags. If unsuccessful, the old
830  * data remains untouched, and it's up to the caller to free the
831  * memory space indicated by @new_mem.
832  * Returns:
833  * !0: Failure.
834  */
835
836 extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
837                               bool evict,
838                               bool no_wait, struct ttm_mem_reg *new_mem);
839
840 /**
841  * ttm_bo_free_old_node
842  *
843  * @bo: A pointer to a struct ttm_buffer_object.
844  *
845  * Utility function to free an old placement after a successful move.
846  */
847 extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
848
849 /**
850  * ttm_bo_move_accel_cleanup.
851  *
852  * @bo: A pointer to a struct ttm_buffer_object.
853  * @sync_obj: A sync object that signals when moving is complete.
854  * @sync_obj_arg: An argument to pass to the sync object idle / wait
855  * functions.
856  * @evict: This is an evict move. Don't return until the buffer is idle.
857  * @no_wait: Never sleep, but rather return with -EBUSY.
858  * @new_mem: struct ttm_mem_reg indicating where to move.
859  *
860  * Accelerated move function to be called when an accelerated move
861  * has been scheduled. The function will create a new temporary buffer object
862  * representing the old placement, and put the sync object on both buffer
863  * objects. After that the newly created buffer object is unref'd to be
864  * destroyed when the move is complete. This will help pipeline
865  * buffer moves.
866  */
867
868 extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
869                                      void *sync_obj,
870                                      void *sync_obj_arg,
871                                      bool evict, bool no_wait,
872                                      struct ttm_mem_reg *new_mem);
873 /**
874  * ttm_io_prot
875  *
876  * @c_state: Caching state.
877  * @tmp: Page protection flag for a normal, cached mapping.
878  *
879  * Utility function that returns the pgprot_t that should be used for
880  * setting up a PTE with the caching model indicated by @c_state.
881  */
882 extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
883
884 #if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
885 #define TTM_HAS_AGP
886 #include <linux/agp_backend.h>
887
888 /**
889  * ttm_agp_backend_init
890  *
891  * @bdev: Pointer to a struct ttm_bo_device.
892  * @bridge: The agp bridge this device is sitting on.
893  *
894  * Create a TTM backend that uses the indicated AGP bridge as an aperture
895  * for TT memory. This function uses the linux agpgart interface to
896  * bind and unbind memory backing a ttm_tt.
897  */
898 extern struct ttm_backend *ttm_agp_backend_init(struct ttm_bo_device *bdev,
899                                                 struct agp_bridge_data *bridge);
900 #endif
901
902 #endif