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