drm/ttm: wire up the new pool as default one v2
[linux-2.6-microblaze.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 <drm/drm_mm.h>
34 #include <drm/drm_vma_manager.h>
35 #include <linux/workqueue.h>
36 #include <linux/fs.h>
37 #include <linux/spinlock.h>
38 #include <linux/dma-resv.h>
39
40 #include "ttm_bo_api.h"
41 #include "ttm_memory.h"
42 #include "ttm_module.h"
43 #include "ttm_placement.h"
44 #include "ttm_tt.h"
45 #include "ttm_pool.h"
46
47 /**
48  * struct ttm_bo_driver
49  *
50  * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
51  * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
52  * @move: Callback for a driver to hook in accelerated functions to
53  * move a buffer.
54  * If set to NULL, a potentially slow memcpy() move is used.
55  */
56
57 struct ttm_bo_driver {
58         /**
59          * ttm_tt_create
60          *
61          * @bo: The buffer object to create the ttm for.
62          * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
63          *
64          * Create a struct ttm_tt to back data with system memory pages.
65          * No pages are actually allocated.
66          * Returns:
67          * NULL: Out of memory.
68          */
69         struct ttm_tt *(*ttm_tt_create)(struct ttm_buffer_object *bo,
70                                         uint32_t page_flags);
71
72         /**
73          * ttm_tt_populate
74          *
75          * @ttm: The struct ttm_tt to contain the backing pages.
76          *
77          * Allocate all backing pages
78          * Returns:
79          * -ENOMEM: Out of memory.
80          */
81         int (*ttm_tt_populate)(struct ttm_bo_device *bdev,
82                                struct ttm_tt *ttm,
83                                struct ttm_operation_ctx *ctx);
84
85         /**
86          * ttm_tt_unpopulate
87          *
88          * @ttm: The struct ttm_tt to contain the backing pages.
89          *
90          * Free all backing page
91          */
92         void (*ttm_tt_unpopulate)(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
93
94         /**
95          * ttm_tt_destroy
96          *
97          * @bdev: Pointer to a ttm device
98          * @ttm: Pointer to a struct ttm_tt.
99          *
100          * Destroy the backend. This will be call back from ttm_tt_destroy so
101          * don't call ttm_tt_destroy from the callback or infinite loop.
102          */
103         void (*ttm_tt_destroy)(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
104
105         /**
106          * struct ttm_bo_driver member eviction_valuable
107          *
108          * @bo: the buffer object to be evicted
109          * @place: placement we need room for
110          *
111          * Check with the driver if it is valuable to evict a BO to make room
112          * for a certain placement.
113          */
114         bool (*eviction_valuable)(struct ttm_buffer_object *bo,
115                                   const struct ttm_place *place);
116         /**
117          * struct ttm_bo_driver member evict_flags:
118          *
119          * @bo: the buffer object to be evicted
120          *
121          * Return the bo flags for a buffer which is not mapped to the hardware.
122          * These will be placed in proposed_flags so that when the move is
123          * finished, they'll end up in bo->mem.flags
124          */
125
126         void (*evict_flags)(struct ttm_buffer_object *bo,
127                             struct ttm_placement *placement);
128
129         /**
130          * struct ttm_bo_driver member move:
131          *
132          * @bo: the buffer to move
133          * @evict: whether this motion is evicting the buffer from
134          * the graphics address space
135          * @ctx: context for this move with parameters
136          * @new_mem: the new memory region receiving the buffer
137          *
138          * Move a buffer between two memory regions.
139          */
140         int (*move)(struct ttm_buffer_object *bo, bool evict,
141                     struct ttm_operation_ctx *ctx,
142                     struct ttm_resource *new_mem);
143
144         /**
145          * struct ttm_bo_driver_member verify_access
146          *
147          * @bo: Pointer to a buffer object.
148          * @filp: Pointer to a struct file trying to access the object.
149          *
150          * Called from the map / write / read methods to verify that the
151          * caller is permitted to access the buffer object.
152          * This member may be set to NULL, which will refuse this kind of
153          * access for all buffer objects.
154          * This function should return 0 if access is granted, -EPERM otherwise.
155          */
156         int (*verify_access)(struct ttm_buffer_object *bo,
157                              struct file *filp);
158
159         /**
160          * Hook to notify driver about a resource delete.
161          */
162         void (*delete_mem_notify)(struct ttm_buffer_object *bo);
163
164         /**
165          * notify the driver that we're about to swap out this bo
166          */
167         void (*swap_notify)(struct ttm_buffer_object *bo);
168
169         /**
170          * Driver callback on when mapping io memory (for bo_move_memcpy
171          * for instance). TTM will take care to call io_mem_free whenever
172          * the mapping is not use anymore. io_mem_reserve & io_mem_free
173          * are balanced.
174          */
175         int (*io_mem_reserve)(struct ttm_bo_device *bdev,
176                               struct ttm_resource *mem);
177         void (*io_mem_free)(struct ttm_bo_device *bdev,
178                             struct ttm_resource *mem);
179
180         /**
181          * Return the pfn for a given page_offset inside the BO.
182          *
183          * @bo: the BO to look up the pfn for
184          * @page_offset: the offset to look up
185          */
186         unsigned long (*io_mem_pfn)(struct ttm_buffer_object *bo,
187                                     unsigned long page_offset);
188
189         /**
190          * Read/write memory buffers for ptrace access
191          *
192          * @bo: the BO to access
193          * @offset: the offset from the start of the BO
194          * @buf: pointer to source/destination buffer
195          * @len: number of bytes to copy
196          * @write: whether to read (0) from or write (non-0) to BO
197          *
198          * If successful, this function should return the number of
199          * bytes copied, -EIO otherwise. If the number of bytes
200          * returned is < len, the function may be called again with
201          * the remainder of the buffer to copy.
202          */
203         int (*access_memory)(struct ttm_buffer_object *bo, unsigned long offset,
204                              void *buf, int len, int write);
205
206         /**
207          * struct ttm_bo_driver member del_from_lru_notify
208          *
209          * @bo: the buffer object deleted from lru
210          *
211          * notify driver that a BO was deleted from LRU.
212          */
213         void (*del_from_lru_notify)(struct ttm_buffer_object *bo);
214
215         /**
216          * Notify the driver that we're about to release a BO
217          *
218          * @bo: BO that is about to be released
219          *
220          * Gives the driver a chance to do any cleanup, including
221          * adding fences that may force a delayed delete
222          */
223         void (*release_notify)(struct ttm_buffer_object *bo);
224 };
225
226 /**
227  * struct ttm_bo_global - Buffer object driver global data.
228  *
229  * @dummy_read_page: Pointer to a dummy page used for mapping requests
230  * of unpopulated pages.
231  * @shrink: A shrink callback object used for buffer object swap.
232  * @device_list_mutex: Mutex protecting the device list.
233  * This mutex is held while traversing the device list for pm options.
234  * @lru_lock: Spinlock protecting the bo subsystem lru lists.
235  * @device_list: List of buffer object devices.
236  * @swap_lru: Lru list of buffer objects used for swapping.
237  */
238
239 extern struct ttm_bo_global {
240
241         /**
242          * Constant after init.
243          */
244
245         struct kobject kobj;
246         struct page *dummy_read_page;
247         spinlock_t lru_lock;
248
249         /**
250          * Protected by ttm_global_mutex.
251          */
252         struct list_head device_list;
253
254         /**
255          * Protected by the lru_lock.
256          */
257         struct list_head swap_lru[TTM_MAX_BO_PRIORITY];
258
259         /**
260          * Internal protection.
261          */
262         atomic_t bo_count;
263 } ttm_bo_glob;
264
265
266 #define TTM_NUM_MEM_TYPES 8
267
268 /**
269  * struct ttm_bo_device - Buffer object driver device-specific data.
270  *
271  * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
272  * @man: An array of resource_managers.
273  * @vma_manager: Address space manager (pointer)
274  * lru_lock: Spinlock that protects the buffer+device lru lists and
275  * ddestroy lists.
276  * @dev_mapping: A pointer to the struct address_space representing the
277  * device address space.
278  * @wq: Work queue structure for the delayed delete workqueue.
279  * @no_retry: Don't retry allocation if it fails
280  *
281  */
282
283 struct ttm_bo_device {
284
285         /*
286          * Constant after bo device init / atomic.
287          */
288         struct list_head device_list;
289         struct ttm_bo_driver *driver;
290         /*
291          * access via ttm_manager_type.
292          */
293         struct ttm_resource_manager sysman;
294         struct ttm_resource_manager *man_drv[TTM_NUM_MEM_TYPES];
295         /*
296          * Protected by internal locks.
297          */
298         struct drm_vma_offset_manager *vma_manager;
299         struct ttm_pool pool;
300
301         /*
302          * Protected by the global:lru lock.
303          */
304         struct list_head ddestroy;
305
306         /*
307          * Protected by load / firstopen / lastclose /unload sync.
308          */
309
310         struct address_space *dev_mapping;
311
312         /*
313          * Internal protection.
314          */
315
316         struct delayed_work wq;
317
318         bool need_dma32;
319
320         bool no_retry;
321 };
322
323 static inline struct ttm_resource_manager *ttm_manager_type(struct ttm_bo_device *bdev,
324                                                             int mem_type)
325 {
326         return bdev->man_drv[mem_type];
327 }
328
329 static inline void ttm_set_driver_manager(struct ttm_bo_device *bdev,
330                                           int type,
331                                           struct ttm_resource_manager *manager)
332 {
333         bdev->man_drv[type] = manager;
334 }
335
336 /**
337  * struct ttm_lru_bulk_move_pos
338  *
339  * @first: first BO in the bulk move range
340  * @last: last BO in the bulk move range
341  *
342  * Positions for a lru bulk move.
343  */
344 struct ttm_lru_bulk_move_pos {
345         struct ttm_buffer_object *first;
346         struct ttm_buffer_object *last;
347 };
348
349 /**
350  * struct ttm_lru_bulk_move
351  *
352  * @tt: first/last lru entry for BOs in the TT domain
353  * @vram: first/last lru entry for BOs in the VRAM domain
354  * @swap: first/last lru entry for BOs on the swap list
355  *
356  * Helper structure for bulk moves on the LRU list.
357  */
358 struct ttm_lru_bulk_move {
359         struct ttm_lru_bulk_move_pos tt[TTM_MAX_BO_PRIORITY];
360         struct ttm_lru_bulk_move_pos vram[TTM_MAX_BO_PRIORITY];
361         struct ttm_lru_bulk_move_pos swap[TTM_MAX_BO_PRIORITY];
362 };
363
364 /*
365  * ttm_bo.c
366  */
367
368 /**
369  * ttm_bo_mem_space
370  *
371  * @bo: Pointer to a struct ttm_buffer_object. the data of which
372  * we want to allocate space for.
373  * @proposed_placement: Proposed new placement for the buffer object.
374  * @mem: A struct ttm_resource.
375  * @interruptible: Sleep interruptible when sliping.
376  * @no_wait_gpu: Return immediately if the GPU is busy.
377  *
378  * Allocate memory space for the buffer object pointed to by @bo, using
379  * the placement flags in @mem, potentially evicting other idle buffer objects.
380  * This function may sleep while waiting for space to become available.
381  * Returns:
382  * -EBUSY: No space available (only if no_wait == 1).
383  * -ENOMEM: Could not allocate memory for the buffer object, either due to
384  * fragmentation or concurrent allocators.
385  * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
386  */
387 int ttm_bo_mem_space(struct ttm_buffer_object *bo,
388                      struct ttm_placement *placement,
389                      struct ttm_resource *mem,
390                      struct ttm_operation_ctx *ctx);
391
392 int ttm_bo_device_release(struct ttm_bo_device *bdev);
393
394 /**
395  * ttm_bo_device_init
396  *
397  * @bdev: A pointer to a struct ttm_bo_device to initialize.
398  * @glob: A pointer to an initialized struct ttm_bo_global.
399  * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
400  * @dev: The core kernel device pointer for DMA mappings and allocations.
401  * @mapping: The address space to use for this bo.
402  * @vma_manager: A pointer to a vma manager.
403  * @use_dma_alloc: If coherent DMA allocation API should be used.
404  * @use_dma32: If we should use GFP_DMA32 for device memory allocations.
405  *
406  * Initializes a struct ttm_bo_device:
407  * Returns:
408  * !0: Failure.
409  */
410 int ttm_bo_device_init(struct ttm_bo_device *bdev,
411                        struct ttm_bo_driver *driver,
412                        struct device *dev,
413                        struct address_space *mapping,
414                        struct drm_vma_offset_manager *vma_manager,
415                        bool use_dma_alloc, bool use_dma32);
416
417 /**
418  * ttm_bo_unmap_virtual
419  *
420  * @bo: tear down the virtual mappings for this BO
421  */
422 void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
423
424 /**
425  * ttm_bo_reserve:
426  *
427  * @bo: A pointer to a struct ttm_buffer_object.
428  * @interruptible: Sleep interruptible if waiting.
429  * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
430  * @ticket: ticket used to acquire the ww_mutex.
431  *
432  * Locks a buffer object for validation. (Or prevents other processes from
433  * locking it for validation), while taking a number of measures to prevent
434  * deadlocks.
435  *
436  * Returns:
437  * -EDEADLK: The reservation may cause a deadlock.
438  * Release all buffer reservations, wait for @bo to become unreserved and
439  * try again.
440  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
441  * a signal. Release all buffer reservations and return to user-space.
442  * -EBUSY: The function needed to sleep, but @no_wait was true
443  * -EALREADY: Bo already reserved using @ticket. This error code will only
444  * be returned if @use_ticket is set to true.
445  */
446 static inline int ttm_bo_reserve(struct ttm_buffer_object *bo,
447                                  bool interruptible, bool no_wait,
448                                  struct ww_acquire_ctx *ticket)
449 {
450         int ret = 0;
451
452         if (no_wait) {
453                 bool success;
454                 if (WARN_ON(ticket))
455                         return -EBUSY;
456
457                 success = dma_resv_trylock(bo->base.resv);
458                 return success ? 0 : -EBUSY;
459         }
460
461         if (interruptible)
462                 ret = dma_resv_lock_interruptible(bo->base.resv, ticket);
463         else
464                 ret = dma_resv_lock(bo->base.resv, ticket);
465         if (ret == -EINTR)
466                 return -ERESTARTSYS;
467         return ret;
468 }
469
470 /**
471  * ttm_bo_reserve_slowpath:
472  * @bo: A pointer to a struct ttm_buffer_object.
473  * @interruptible: Sleep interruptible if waiting.
474  * @sequence: Set (@bo)->sequence to this value after lock
475  *
476  * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
477  * from all our other reservations. Because there are no other reservations
478  * held by us, this function cannot deadlock any more.
479  */
480 static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo,
481                                           bool interruptible,
482                                           struct ww_acquire_ctx *ticket)
483 {
484         if (interruptible) {
485                 int ret = dma_resv_lock_slow_interruptible(bo->base.resv,
486                                                            ticket);
487                 if (ret == -EINTR)
488                         ret = -ERESTARTSYS;
489                 return ret;
490         }
491         dma_resv_lock_slow(bo->base.resv, ticket);
492         return 0;
493 }
494
495 static inline void ttm_bo_move_to_lru_tail_unlocked(struct ttm_buffer_object *bo)
496 {
497         spin_lock(&ttm_bo_glob.lru_lock);
498         ttm_bo_move_to_lru_tail(bo, NULL);
499         spin_unlock(&ttm_bo_glob.lru_lock);
500 }
501
502 static inline void ttm_bo_assign_mem(struct ttm_buffer_object *bo,
503                                      struct ttm_resource *new_mem)
504 {
505         bo->mem = *new_mem;
506         new_mem->mm_node = NULL;
507 }
508
509 /**
510  * ttm_bo_move_null = assign memory for a buffer object.
511  * @bo: The bo to assign the memory to
512  * @new_mem: The memory to be assigned.
513  *
514  * Assign the memory from new_mem to the memory of the buffer object bo.
515  */
516 static inline void ttm_bo_move_null(struct ttm_buffer_object *bo,
517                                     struct ttm_resource *new_mem)
518 {
519         struct ttm_resource *old_mem = &bo->mem;
520
521         WARN_ON(old_mem->mm_node != NULL);
522         ttm_bo_assign_mem(bo, new_mem);
523 }
524
525 /**
526  * ttm_bo_unreserve
527  *
528  * @bo: A pointer to a struct ttm_buffer_object.
529  *
530  * Unreserve a previous reservation of @bo.
531  */
532 static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo)
533 {
534         ttm_bo_move_to_lru_tail_unlocked(bo);
535         dma_resv_unlock(bo->base.resv);
536 }
537
538 /*
539  * ttm_bo_util.c
540  */
541 int ttm_mem_io_reserve(struct ttm_bo_device *bdev,
542                        struct ttm_resource *mem);
543 void ttm_mem_io_free(struct ttm_bo_device *bdev,
544                      struct ttm_resource *mem);
545
546 /**
547  * ttm_bo_move_memcpy
548  *
549  * @bo: A pointer to a struct ttm_buffer_object.
550  * @interruptible: Sleep interruptible if waiting.
551  * @no_wait_gpu: Return immediately if the GPU is busy.
552  * @new_mem: struct ttm_resource indicating where to move.
553  *
554  * Fallback move function for a mappable buffer object in mappable memory.
555  * The function will, if successful,
556  * free any old aperture space, and set (@new_mem)->mm_node to NULL,
557  * and update the (@bo)->mem placement flags. If unsuccessful, the old
558  * data remains untouched, and it's up to the caller to free the
559  * memory space indicated by @new_mem.
560  * Returns:
561  * !0: Failure.
562  */
563
564 int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
565                        struct ttm_operation_ctx *ctx,
566                        struct ttm_resource *new_mem);
567
568 /**
569  * ttm_bo_move_accel_cleanup.
570  *
571  * @bo: A pointer to a struct ttm_buffer_object.
572  * @fence: A fence object that signals when moving is complete.
573  * @evict: This is an evict move. Don't return until the buffer is idle.
574  * @pipeline: evictions are to be pipelined.
575  * @new_mem: struct ttm_resource indicating where to move.
576  *
577  * Accelerated move function to be called when an accelerated move
578  * has been scheduled. The function will create a new temporary buffer object
579  * representing the old placement, and put the sync object on both buffer
580  * objects. After that the newly created buffer object is unref'd to be
581  * destroyed when the move is complete. This will help pipeline
582  * buffer moves.
583  */
584 int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
585                               struct dma_fence *fence, bool evict,
586                               bool pipeline,
587                               struct ttm_resource *new_mem);
588
589 /**
590  * ttm_bo_pipeline_gutting.
591  *
592  * @bo: A pointer to a struct ttm_buffer_object.
593  *
594  * Pipelined gutting a BO of its backing store.
595  */
596 int ttm_bo_pipeline_gutting(struct ttm_buffer_object *bo);
597
598 /**
599  * ttm_io_prot
600  *
601  * bo: ttm buffer object
602  * res: ttm resource object
603  * @tmp: Page protection flag for a normal, cached mapping.
604  *
605  * Utility function that returns the pgprot_t that should be used for
606  * setting up a PTE with the caching model indicated by @c_state.
607  */
608 pgprot_t ttm_io_prot(struct ttm_buffer_object *bo, struct ttm_resource *res,
609                      pgprot_t tmp);
610
611 /**
612  * ttm_bo_tt_bind
613  *
614  * Bind the object tt to a memory resource.
615  */
616 int ttm_bo_tt_bind(struct ttm_buffer_object *bo, struct ttm_resource *mem);
617
618 /**
619  * ttm_bo_tt_destroy.
620  */
621 void ttm_bo_tt_destroy(struct ttm_buffer_object *bo);
622
623 /**
624  * ttm_range_man_init
625  *
626  * @bdev: ttm device
627  * @type: memory manager type
628  * @use_tt: if the memory manager uses tt
629  * @p_size: size of area to be managed in pages.
630  *
631  * Initialise a generic range manager for the selected memory type.
632  * The range manager is installed for this device in the type slot.
633  */
634 int ttm_range_man_init(struct ttm_bo_device *bdev,
635                        unsigned type, bool use_tt,
636                        unsigned long p_size);
637
638 /**
639  * ttm_range_man_fini
640  *
641  * @bdev: ttm device
642  * @type: memory manager type
643  *
644  * Remove the generic range manager from a slot and tear it down.
645  */
646 int ttm_range_man_fini(struct ttm_bo_device *bdev,
647                        unsigned type);
648
649 #endif