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