blob: da957bf3fe449e0b8f4cfbed64f1652840c8bb37 [file] [log] [blame]
Thomas Hellstromba4e7d92009-06-10 15:20:19 +02001/**************************************************************************
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
31#ifndef _TTM_BO_API_H_
32#define _TTM_BO_API_H_
33
34#include "drm_hashtab.h"
35#include <linux/kref.h>
36#include <linux/list.h>
37#include <linux/wait.h>
38#include <linux/mutex.h>
39#include <linux/mm.h>
40#include <linux/rbtree.h>
41#include <linux/bitmap.h>
42
43struct ttm_bo_device;
44
45struct drm_mm_node;
46
Marek Olšákdfadbbd2011-08-13 20:32:11 +000047enum ttm_buffer_usage {
48 TTM_USAGE_READ = 1,
49 TTM_USAGE_WRITE = 2,
50 TTM_USAGE_READWRITE = TTM_USAGE_READ | TTM_USAGE_WRITE
51};
Jerome Glisseca262a9992009-12-08 15:33:32 +010052
53/**
54 * struct ttm_placement
55 *
56 * @fpfn: first valid page frame number to put the object
57 * @lpfn: last valid page frame number to put the object
Lucas De Marchi25985ed2011-03-30 22:57:33 -030058 * @num_placement: number of preferred placements
59 * @placement: preferred placements
60 * @num_busy_placement: number of preferred placements when need to evict buffer
61 * @busy_placement: preferred placements when need to evict buffer
Jerome Glisseca262a9992009-12-08 15:33:32 +010062 *
63 * Structure indicating the placement you request for an object.
64 */
65struct ttm_placement {
66 unsigned fpfn;
67 unsigned lpfn;
68 unsigned num_placement;
69 const uint32_t *placement;
70 unsigned num_busy_placement;
71 const uint32_t *busy_placement;
72};
73
Jerome Glisse82c5da62010-04-09 14:39:23 +020074/**
75 * struct ttm_bus_placement
76 *
77 * @addr: mapped virtual address
78 * @base: bus base address
79 * @is_iomem: is this io memory ?
80 * @size: size in byte
81 * @offset: offset from the base address
Thomas Hellstromeba67092010-11-11 09:41:57 +010082 * @io_reserved_vm: The VM system has a refcount in @io_reserved_count
83 * @io_reserved_count: Refcounting the numbers of callers to ttm_mem_io_reserve
Jerome Glisse82c5da62010-04-09 14:39:23 +020084 *
85 * Structure indicating the bus placement of an object.
86 */
87struct ttm_bus_placement {
88 void *addr;
89 unsigned long base;
90 unsigned long size;
91 unsigned long offset;
92 bool is_iomem;
Thomas Hellstromeba67092010-11-11 09:41:57 +010093 bool io_reserved_vm;
94 uint64_t io_reserved_count;
Jerome Glisse82c5da62010-04-09 14:39:23 +020095};
96
Jerome Glisseca262a9992009-12-08 15:33:32 +010097
Thomas Hellstromba4e7d92009-06-10 15:20:19 +020098/**
99 * struct ttm_mem_reg
100 *
101 * @mm_node: Memory manager node.
102 * @size: Requested size of memory region.
103 * @num_pages: Actual size of memory region in pages.
104 * @page_alignment: Page alignment.
105 * @placement: Placement flags.
Jerome Glisse82c5da62010-04-09 14:39:23 +0200106 * @bus: Placement on io bus accessible to the CPU
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200107 *
108 * Structure indicating the placement and space resources used by a
109 * buffer object.
110 */
111
112struct ttm_mem_reg {
Ben Skeggsd961db72010-08-05 10:48:18 +1000113 void *mm_node;
114 unsigned long start;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200115 unsigned long size;
116 unsigned long num_pages;
117 uint32_t page_alignment;
118 uint32_t mem_type;
119 uint32_t placement;
Jerome Glisse82c5da62010-04-09 14:39:23 +0200120 struct ttm_bus_placement bus;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200121};
122
123/**
124 * enum ttm_bo_type
125 *
126 * @ttm_bo_type_device: These are 'normal' buffers that can
127 * be mmapped by user space. Each of these bos occupy a slot in the
128 * device address space, that can be used for normal vm operations.
129 *
130 * @ttm_bo_type_user: These are user-space memory areas that are made
131 * available to the GPU by mapping the buffer pages into the GPU aperture
132 * space. These buffers cannot be mmaped from the device address space.
133 *
134 * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers,
135 * but they cannot be accessed from user-space. For kernel-only use.
136 */
137
138enum ttm_bo_type {
139 ttm_bo_type_device,
140 ttm_bo_type_user,
141 ttm_bo_type_kernel
142};
143
144struct ttm_tt;
145
146/**
147 * struct ttm_buffer_object
148 *
149 * @bdev: Pointer to the buffer object device structure.
150 * @buffer_start: The virtual user-space start address of ttm_bo_type_user
151 * buffers.
152 * @type: The bo type.
153 * @destroy: Destruction function. If NULL, kfree is used.
154 * @num_pages: Actual number of pages.
155 * @addr_space_offset: Address space offset.
156 * @acc_size: Accounted size for this object.
157 * @kref: Reference count of this buffer object. When this refcount reaches
158 * zero, the object is put on the delayed delete list.
159 * @list_kref: List reference count of this buffer object. This member is
160 * used to avoid destruction while the buffer object is still on a list.
161 * Lru lists may keep one refcount, the delayed delete list, and kref != 0
162 * keeps one refcount. When this refcount reaches zero,
163 * the object is destroyed.
164 * @event_queue: Queue for processes waiting on buffer object status change.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200165 * @mem: structure describing current placement.
Jan Engelhardt5df23972011-04-04 01:25:18 +0200166 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200167 * pinned in physical memory. If this behaviour is not desired, this member
Jan Engelhardt5df23972011-04-04 01:25:18 +0200168 * holds a pointer to a persistent shmem object.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200169 * @ttm: TTM structure holding system pages.
170 * @evicted: Whether the object was evicted without user-space knowing.
171 * @cpu_writes: For synchronization. Number of cpu writers.
172 * @lru: List head for the lru list.
173 * @ddestroy: List head for the delayed destroy list.
174 * @swap: List head for swap LRU list.
175 * @val_seq: Sequence of the validation holding the @reserved lock.
176 * Used to avoid starvation when many processes compete to validate the
177 * buffer. This member is protected by the bo_device::lru_lock.
178 * @seq_valid: The value of @val_seq is valid. This value is protected by
179 * the bo_device::lru_lock.
180 * @reserved: Deadlock-free lock used for synchronization state transitions.
181 * @sync_obj_arg: Opaque argument to synchronization object function.
Marek Olšákdfadbbd2011-08-13 20:32:11 +0000182 * @sync_obj: Pointer to a synchronization object of a last read or write,
183 * whichever is later.
184 * @sync_obj_read: Pointer to a synchronization object of a last read.
185 * @sync_obj_write: Pointer to a synchronization object of a last write.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200186 * @priv_flags: Flags describing buffer object internal state.
187 * @vm_rb: Rb node for the vm rb tree.
188 * @vm_node: Address space manager node.
189 * @offset: The current GPU offset, which can have different meanings
190 * depending on the memory type. For SYSTEM type memory, it should be 0.
191 * @cur_placement: Hint of current placement.
192 *
193 * Base class for TTM buffer object, that deals with data placement and CPU
194 * mappings. GPU mappings are really up to the driver, but for simpler GPUs
195 * the driver can usually use the placement offset @offset directly as the
196 * GPU virtual address. For drivers implementing multiple
197 * GPU memory manager contexts, the driver should manage the address space
198 * in these contexts separately and use these objects to get the correct
199 * placement and caching for these GPU maps. This makes it possible to use
200 * these objects for even quite elaborate memory management schemes.
201 * The destroy member, the API visibility of this object makes it possible
202 * to derive driver specific types.
203 */
204
205struct ttm_buffer_object {
206 /**
207 * Members constant at init.
208 */
209
Thomas Hellstroma987fca2009-08-18 16:51:56 +0200210 struct ttm_bo_global *glob;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200211 struct ttm_bo_device *bdev;
212 unsigned long buffer_start;
213 enum ttm_bo_type type;
214 void (*destroy) (struct ttm_buffer_object *);
215 unsigned long num_pages;
216 uint64_t addr_space_offset;
217 size_t acc_size;
218
219 /**
220 * Members not needing protection.
221 */
222
223 struct kref kref;
224 struct kref list_kref;
225 wait_queue_head_t event_queue;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200226
227 /**
228 * Members protected by the bo::reserved lock.
229 */
230
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200231 struct ttm_mem_reg mem;
Jan Engelhardt5df23972011-04-04 01:25:18 +0200232 struct file *persistent_swap_storage;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200233 struct ttm_tt *ttm;
234 bool evicted;
235
236 /**
237 * Members protected by the bo::reserved lock only when written to.
238 */
239
240 atomic_t cpu_writers;
241
242 /**
243 * Members protected by the bdev::lru_lock.
244 */
245
246 struct list_head lru;
247 struct list_head ddestroy;
248 struct list_head swap;
Thomas Hellstromeba67092010-11-11 09:41:57 +0100249 struct list_head io_reserve_lru;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200250 uint32_t val_seq;
251 bool seq_valid;
252
253 /**
254 * Members protected by the bdev::lru_lock
255 * only when written to.
256 */
257
258 atomic_t reserved;
259
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200260 /**
Thomas Hellstrom702adba2010-11-17 12:28:29 +0000261 * Members protected by struct buffer_object_device::fence_lock
Thomas Hellstrom1df6a2e2010-09-30 12:36:45 +0200262 * In addition, setting sync_obj to anything else
263 * than NULL requires bo::reserved to be held. This allows for
Thomas Hellstrom702adba2010-11-17 12:28:29 +0000264 * checking NULL while reserved but not holding the mentioned lock.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200265 */
266
267 void *sync_obj_arg;
268 void *sync_obj;
Marek Olšákdfadbbd2011-08-13 20:32:11 +0000269 void *sync_obj_read;
270 void *sync_obj_write;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200271 unsigned long priv_flags;
272
273 /**
274 * Members protected by the bdev::vm_lock
275 */
276
277 struct rb_node vm_rb;
278 struct drm_mm_node *vm_node;
279
280
281 /**
282 * Special members that are protected by the reserve lock
283 * and the bo::lock when written to. Can be read with
284 * either of these locks held.
285 */
286
287 unsigned long offset;
288 uint32_t cur_placement;
289};
290
291/**
292 * struct ttm_bo_kmap_obj
293 *
294 * @virtual: The current kernel virtual address.
295 * @page: The page when kmap'ing a single page.
296 * @bo_kmap_type: Type of bo_kmap.
297 *
298 * Object describing a kernel mapping. Since a TTM bo may be located
299 * in various memory types with various caching policies, the
300 * mapping can either be an ioremap, a vmap, a kmap or part of a
301 * premapped region.
302 */
303
Pekka Paalanena0724fc2009-08-17 01:18:38 +0300304#define TTM_BO_MAP_IOMEM_MASK 0x80
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200305struct ttm_bo_kmap_obj {
306 void *virtual;
307 struct page *page;
308 enum {
Pekka Paalanena0724fc2009-08-17 01:18:38 +0300309 ttm_bo_map_iomap = 1 | TTM_BO_MAP_IOMEM_MASK,
310 ttm_bo_map_vmap = 2,
311 ttm_bo_map_kmap = 3,
312 ttm_bo_map_premapped = 4 | TTM_BO_MAP_IOMEM_MASK,
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200313 } bo_kmap_type;
Jerome Glisse82c5da62010-04-09 14:39:23 +0200314 struct ttm_buffer_object *bo;
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200315};
316
317/**
318 * ttm_bo_reference - reference a struct ttm_buffer_object
319 *
320 * @bo: The buffer object.
321 *
322 * Returns a refcounted pointer to a buffer object.
323 */
324
325static inline struct ttm_buffer_object *
326ttm_bo_reference(struct ttm_buffer_object *bo)
327{
328 kref_get(&bo->kref);
329 return bo;
330}
331
332/**
333 * ttm_bo_wait - wait for buffer idle.
334 *
335 * @bo: The buffer object.
336 * @interruptible: Use interruptible wait.
337 * @no_wait: Return immediately if buffer is busy.
Marek Olšákdfadbbd2011-08-13 20:32:11 +0000338 * @usage: Whether to wait for the last read and/or the last write.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200339 *
340 * This function must be called with the bo::mutex held, and makes
341 * sure any previous rendering to the buffer is completed.
342 * Note: It might be necessary to block validations before the
343 * wait by reserving the buffer.
344 * Returns -EBUSY if no_wait is true and the buffer is busy.
Thomas Hellstrom98ffc4152009-12-07 18:36:18 +0100345 * Returns -ERESTARTSYS if interrupted by a signal.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200346 */
347extern int ttm_bo_wait(struct ttm_buffer_object *bo, bool lazy,
Marek Olšákdfadbbd2011-08-13 20:32:11 +0000348 bool interruptible, bool no_wait,
349 enum ttm_buffer_usage usage);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200350/**
Jerome Glisse09855ac2009-12-10 17:16:27 +0100351 * ttm_bo_validate
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200352 *
353 * @bo: The buffer object.
Jerome Glisseca262a9992009-12-08 15:33:32 +0100354 * @placement: Proposed placement for the buffer object.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200355 * @interruptible: Sleep interruptible if sleeping.
Jerome Glisse9d87fa22010-04-07 10:21:19 +0000356 * @no_wait_reserve: Return immediately if other buffers are busy.
357 * @no_wait_gpu: Return immediately if the GPU is busy.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200358 *
359 * Changes placement and caching policy of the buffer object
Jerome Glisseca262a9992009-12-08 15:33:32 +0100360 * according proposed placement.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200361 * Returns
Jerome Glisseca262a9992009-12-08 15:33:32 +0100362 * -EINVAL on invalid proposed placement.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200363 * -ENOMEM on out-of-memory condition.
364 * -EBUSY if no_wait is true and buffer busy.
Thomas Hellstrom98ffc4152009-12-07 18:36:18 +0100365 * -ERESTARTSYS if interrupted by a signal.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200366 */
Jerome Glisse09855ac2009-12-10 17:16:27 +0100367extern int ttm_bo_validate(struct ttm_buffer_object *bo,
368 struct ttm_placement *placement,
Jerome Glisse9d87fa22010-04-07 10:21:19 +0000369 bool interruptible, bool no_wait_reserve,
370 bool no_wait_gpu);
Jerome Glisseca262a9992009-12-08 15:33:32 +0100371
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200372/**
373 * ttm_bo_unref
374 *
375 * @bo: The buffer object.
376 *
377 * Unreference and clear a pointer to a buffer object.
378 */
379extern void ttm_bo_unref(struct ttm_buffer_object **bo);
380
Dave Airlied6ea8882010-11-22 13:24:40 +1000381
382/**
383 * ttm_bo_list_ref_sub
384 *
385 * @bo: The buffer object.
386 * @count: The number of references with which to decrease @bo::list_kref;
387 * @never_free: The refcount should not reach zero with this operation.
388 *
389 * Release @count lru list references to this buffer object.
390 */
391extern void ttm_bo_list_ref_sub(struct ttm_buffer_object *bo, int count,
392 bool never_free);
393
394/**
395 * ttm_bo_add_to_lru
396 *
397 * @bo: The buffer object.
398 *
399 * Add this bo to the relevant mem type lru and, if it's backed by
400 * system pages (ttms) to the swap list.
401 * This function must be called with struct ttm_bo_global::lru_lock held, and
402 * is typically called immediately prior to unreserving a bo.
403 */
404extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo);
405
406/**
407 * ttm_bo_del_from_lru
408 *
409 * @bo: The buffer object.
410 *
411 * Remove this bo from all lru lists used to lookup and reserve an object.
412 * This function must be called with struct ttm_bo_global::lru_lock held,
413 * and is usually called just immediately after the bo has been reserved to
414 * avoid recursive reservation from lru lists.
415 */
416extern int ttm_bo_del_from_lru(struct ttm_buffer_object *bo);
417
418
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200419/**
Matthew Garrett7c5ee532010-04-26 16:00:09 -0400420 * ttm_bo_lock_delayed_workqueue
421 *
422 * Prevent the delayed workqueue from running.
423 * Returns
424 * True if the workqueue was queued at the time
425 */
426extern int ttm_bo_lock_delayed_workqueue(struct ttm_bo_device *bdev);
427
428/**
429 * ttm_bo_unlock_delayed_workqueue
430 *
431 * Allows the delayed workqueue to run.
432 */
433extern void ttm_bo_unlock_delayed_workqueue(struct ttm_bo_device *bdev,
434 int resched);
435
436/**
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200437 * ttm_bo_synccpu_write_grab
438 *
439 * @bo: The buffer object:
440 * @no_wait: Return immediately if buffer is busy.
441 *
442 * Synchronizes a buffer object for CPU RW access. This means
443 * blocking command submission that affects the buffer and
444 * waiting for buffer idle. This lock is recursive.
445 * Returns
446 * -EBUSY if the buffer is busy and no_wait is true.
Thomas Hellstrom98ffc4152009-12-07 18:36:18 +0100447 * -ERESTARTSYS if interrupted by a signal.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200448 */
449
450extern int
451ttm_bo_synccpu_write_grab(struct ttm_buffer_object *bo, bool no_wait);
452/**
453 * ttm_bo_synccpu_write_release:
454 *
455 * @bo : The buffer object.
456 *
457 * Releases a synccpu lock.
458 */
459extern void ttm_bo_synccpu_write_release(struct ttm_buffer_object *bo);
460
461/**
Jerome Glisse09855ac2009-12-10 17:16:27 +0100462 * ttm_bo_init
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200463 *
464 * @bdev: Pointer to a ttm_bo_device struct.
465 * @bo: Pointer to a ttm_buffer_object to be initialized.
466 * @size: Requested size of buffer object.
467 * @type: Requested type of buffer object.
468 * @flags: Initial placement flags.
469 * @page_alignment: Data alignment in pages.
470 * @buffer_start: Virtual address of user space data backing a
471 * user buffer object.
472 * @interruptible: If needing to sleep to wait for GPU resources,
473 * sleep interruptible.
Jan Engelhardt5df23972011-04-04 01:25:18 +0200474 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200475 * pinned in physical memory. If this behaviour is not desired, this member
Jan Engelhardt5df23972011-04-04 01:25:18 +0200476 * holds a pointer to a persistent shmem object. Typically, this would
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200477 * point to the shmem object backing a GEM object if TTM is used to back a
478 * GEM user interface.
479 * @acc_size: Accounted size for this object.
480 * @destroy: Destroy function. Use NULL for kfree().
481 *
482 * This function initializes a pre-allocated struct ttm_buffer_object.
483 * As this object may be part of a larger structure, this function,
484 * together with the @destroy function,
485 * enables driver-specific objects derived from a ttm_buffer_object.
486 * On successful return, the object kref and list_kref are set to 1.
Thomas Hellstrom7dfbbdc2010-11-09 21:31:44 +0100487 * If a failure occurs, the function will call the @destroy function, or
488 * kfree() if @destroy is NULL. Thus, after a failure, dereferencing @bo is
489 * illegal and will likely cause memory corruption.
490 *
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200491 * Returns
492 * -ENOMEM: Out of memory.
493 * -EINVAL: Invalid placement flags.
Thomas Hellstrom98ffc4152009-12-07 18:36:18 +0100494 * -ERESTARTSYS: Interrupted by signal while sleeping waiting for resources.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200495 */
496
Jerome Glisse09855ac2009-12-10 17:16:27 +0100497extern int ttm_bo_init(struct ttm_bo_device *bdev,
498 struct ttm_buffer_object *bo,
499 unsigned long size,
500 enum ttm_bo_type type,
501 struct ttm_placement *placement,
502 uint32_t page_alignment,
503 unsigned long buffer_start,
504 bool interrubtible,
Jan Engelhardt5df23972011-04-04 01:25:18 +0200505 struct file *persistent_swap_storage,
Jerome Glisse09855ac2009-12-10 17:16:27 +0100506 size_t acc_size,
507 void (*destroy) (struct ttm_buffer_object *));
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200508/**
509 * ttm_bo_synccpu_object_init
510 *
511 * @bdev: Pointer to a ttm_bo_device struct.
512 * @bo: Pointer to a ttm_buffer_object to be initialized.
513 * @size: Requested size of buffer object.
514 * @type: Requested type of buffer object.
515 * @flags: Initial placement flags.
516 * @page_alignment: Data alignment in pages.
517 * @buffer_start: Virtual address of user space data backing a
518 * user buffer object.
519 * @interruptible: If needing to sleep while waiting for GPU resources,
520 * sleep interruptible.
Jan Engelhardt5df23972011-04-04 01:25:18 +0200521 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200522 * pinned in physical memory. If this behaviour is not desired, this member
Jan Engelhardt5df23972011-04-04 01:25:18 +0200523 * holds a pointer to a persistent shmem object. Typically, this would
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200524 * point to the shmem object backing a GEM object if TTM is used to back a
525 * GEM user interface.
526 * @p_bo: On successful completion *p_bo points to the created object.
527 *
Jerome Glisse09855ac2009-12-10 17:16:27 +0100528 * This function allocates a ttm_buffer_object, and then calls ttm_bo_init
529 * on that object. The destroy function is set to kfree().
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200530 * Returns
531 * -ENOMEM: Out of memory.
532 * -EINVAL: Invalid placement flags.
Thomas Hellstrom98ffc4152009-12-07 18:36:18 +0100533 * -ERESTARTSYS: Interrupted by signal while waiting for resources.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200534 */
535
Jerome Glisse09855ac2009-12-10 17:16:27 +0100536extern int ttm_bo_create(struct ttm_bo_device *bdev,
537 unsigned long size,
538 enum ttm_bo_type type,
539 struct ttm_placement *placement,
540 uint32_t page_alignment,
541 unsigned long buffer_start,
542 bool interruptible,
Jan Engelhardt5df23972011-04-04 01:25:18 +0200543 struct file *persistent_swap_storage,
Jerome Glisse09855ac2009-12-10 17:16:27 +0100544 struct ttm_buffer_object **p_bo);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200545
546/**
547 * ttm_bo_check_placement
548 *
Jerome Glisse09855ac2009-12-10 17:16:27 +0100549 * @bo: the buffer object.
550 * @placement: placements
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200551 *
552 * Performs minimal validity checking on an intended change of
553 * placement flags.
554 * Returns
555 * -EINVAL: Intended change is invalid or not allowed.
556 */
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200557extern int ttm_bo_check_placement(struct ttm_buffer_object *bo,
Jerome Glisse09855ac2009-12-10 17:16:27 +0100558 struct ttm_placement *placement);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200559
560/**
561 * ttm_bo_init_mm
562 *
563 * @bdev: Pointer to a ttm_bo_device struct.
564 * @mem_type: The memory type.
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200565 * @p_size: size managed area in pages.
566 *
567 * Initialize a manager for a given memory type.
568 * Note: if part of driver firstopen, it must be protected from a
569 * potentially racing lastclose.
570 * Returns:
571 * -EINVAL: invalid size or memory type.
572 * -ENOMEM: Not enough memory.
573 * May also return driver-specified errors.
574 */
575
576extern int ttm_bo_init_mm(struct ttm_bo_device *bdev, unsigned type,
Jerome Glisseca262a9992009-12-08 15:33:32 +0100577 unsigned long p_size);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200578/**
579 * ttm_bo_clean_mm
580 *
581 * @bdev: Pointer to a ttm_bo_device struct.
582 * @mem_type: The memory type.
583 *
584 * Take down a manager for a given memory type after first walking
585 * the LRU list to evict any buffers left alive.
586 *
587 * Normally, this function is part of lastclose() or unload(), and at that
588 * point there shouldn't be any buffers left created by user-space, since
589 * there should've been removed by the file descriptor release() method.
590 * However, before this function is run, make sure to signal all sync objects,
591 * and verify that the delayed delete queue is empty. The driver must also
592 * make sure that there are no NO_EVICT buffers present in this memory type
593 * when the call is made.
594 *
595 * If this function is part of a VT switch, the caller must make sure that
596 * there are no appications currently validating buffers before this
597 * function is called. The caller can do that by first taking the
598 * struct ttm_bo_device::ttm_lock in write mode.
599 *
600 * Returns:
601 * -EINVAL: invalid or uninitialized memory type.
602 * -EBUSY: There are still buffers left in this memory type.
603 */
604
605extern int ttm_bo_clean_mm(struct ttm_bo_device *bdev, unsigned mem_type);
606
607/**
608 * ttm_bo_evict_mm
609 *
610 * @bdev: Pointer to a ttm_bo_device struct.
611 * @mem_type: The memory type.
612 *
613 * Evicts all buffers on the lru list of the memory type.
614 * This is normally part of a VT switch or an
615 * out-of-memory-space-due-to-fragmentation handler.
616 * The caller must make sure that there are no other processes
617 * currently validating buffers, and can do that by taking the
618 * struct ttm_bo_device::ttm_lock in write mode.
619 *
620 * Returns:
621 * -EINVAL: Invalid or uninitialized memory type.
Thomas Hellstrom98ffc4152009-12-07 18:36:18 +0100622 * -ERESTARTSYS: The call was interrupted by a signal while waiting to
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200623 * evict a buffer.
624 */
625
626extern int ttm_bo_evict_mm(struct ttm_bo_device *bdev, unsigned mem_type);
627
628/**
629 * ttm_kmap_obj_virtual
630 *
631 * @map: A struct ttm_bo_kmap_obj returned from ttm_bo_kmap.
632 * @is_iomem: Pointer to an integer that on return indicates 1 if the
633 * virtual map is io memory, 0 if normal memory.
634 *
635 * Returns the virtual address of a buffer object area mapped by ttm_bo_kmap.
636 * If *is_iomem is 1 on return, the virtual address points to an io memory area,
637 * that should strictly be accessed by the iowriteXX() and similar functions.
638 */
639
640static inline void *ttm_kmap_obj_virtual(struct ttm_bo_kmap_obj *map,
641 bool *is_iomem)
642{
Pekka Paalanena0724fc2009-08-17 01:18:38 +0300643 *is_iomem = !!(map->bo_kmap_type & TTM_BO_MAP_IOMEM_MASK);
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200644 return map->virtual;
645}
646
647/**
648 * ttm_bo_kmap
649 *
650 * @bo: The buffer object.
651 * @start_page: The first page to map.
652 * @num_pages: Number of pages to map.
653 * @map: pointer to a struct ttm_bo_kmap_obj representing the map.
654 *
655 * Sets up a kernel virtual mapping, using ioremap, vmap or kmap to the
656 * data in the buffer object. The ttm_kmap_obj_virtual function can then be
657 * used to obtain a virtual address to the data.
658 *
659 * Returns
660 * -ENOMEM: Out of memory.
661 * -EINVAL: Invalid range.
662 */
663
664extern int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page,
665 unsigned long num_pages, struct ttm_bo_kmap_obj *map);
666
667/**
668 * ttm_bo_kunmap
669 *
670 * @map: Object describing the map to unmap.
671 *
672 * Unmaps a kernel map set up by ttm_bo_kmap.
673 */
674
675extern void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map);
676
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200677/**
678 * ttm_fbdev_mmap - mmap fbdev memory backed by a ttm buffer object.
679 *
680 * @vma: vma as input from the fbdev mmap method.
681 * @bo: The bo backing the address space. The address space will
682 * have the same size as the bo, and start at offset 0.
683 *
684 * This function is intended to be called by the fbdev mmap method
685 * if the fbdev address space is to be backed by a bo.
686 */
687
688extern int ttm_fbdev_mmap(struct vm_area_struct *vma,
689 struct ttm_buffer_object *bo);
690
691/**
692 * ttm_bo_mmap - mmap out of the ttm device address space.
693 *
694 * @filp: filp as input from the mmap method.
695 * @vma: vma as input from the mmap method.
696 * @bdev: Pointer to the ttm_bo_device with the address space manager.
697 *
698 * This function is intended to be called by the device mmap method.
699 * if the device address space is to be backed by the bo manager.
700 */
701
702extern int ttm_bo_mmap(struct file *filp, struct vm_area_struct *vma,
703 struct ttm_bo_device *bdev);
704
705/**
706 * ttm_bo_io
707 *
708 * @bdev: Pointer to the struct ttm_bo_device.
709 * @filp: Pointer to the struct file attempting to read / write.
710 * @wbuf: User-space pointer to address of buffer to write. NULL on read.
711 * @rbuf: User-space pointer to address of buffer to read into.
712 * Null on write.
713 * @count: Number of bytes to read / write.
714 * @f_pos: Pointer to current file position.
715 * @write: 1 for read, 0 for write.
716 *
717 * This function implements read / write into ttm buffer objects, and is
718 * intended to
719 * be called from the fops::read and fops::write method.
720 * Returns:
721 * See man (2) write, man(2) read. In particular,
Thomas Hellstrom98ffc4152009-12-07 18:36:18 +0100722 * the function may return -ERESTARTSYS if
Thomas Hellstromba4e7d92009-06-10 15:20:19 +0200723 * interrupted by a signal.
724 */
725
726extern ssize_t ttm_bo_io(struct ttm_bo_device *bdev, struct file *filp,
727 const char __user *wbuf, char __user *rbuf,
728 size_t count, loff_t *f_pos, bool write);
729
730extern void ttm_bo_swapout_all(struct ttm_bo_device *bdev);
731
732#endif