Commit | Line | Data |
---|---|---|
ba4e7d97 TH |
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 | ||
31 | #ifndef _TTM_BO_API_H_ | |
32 | #define _TTM_BO_API_H_ | |
33 | ||
a1ce3928 | 34 | #include <drm/drm_hashtab.h> |
ba4e7d97 TH |
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 | ||
43 | struct ttm_bo_device; | |
44 | ||
45 | struct drm_mm_node; | |
46 | ||
ca262a99 JG |
47 | |
48 | /** | |
49 | * struct ttm_placement | |
50 | * | |
51 | * @fpfn: first valid page frame number to put the object | |
52 | * @lpfn: last valid page frame number to put the object | |
25985edc LDM |
53 | * @num_placement: number of preferred placements |
54 | * @placement: preferred placements | |
55 | * @num_busy_placement: number of preferred placements when need to evict buffer | |
56 | * @busy_placement: preferred placements when need to evict buffer | |
ca262a99 JG |
57 | * |
58 | * Structure indicating the placement you request for an object. | |
59 | */ | |
60 | struct ttm_placement { | |
61 | unsigned fpfn; | |
62 | unsigned lpfn; | |
63 | unsigned num_placement; | |
64 | const uint32_t *placement; | |
65 | unsigned num_busy_placement; | |
66 | const uint32_t *busy_placement; | |
67 | }; | |
68 | ||
82c5da6b JG |
69 | /** |
70 | * struct ttm_bus_placement | |
71 | * | |
72 | * @addr: mapped virtual address | |
73 | * @base: bus base address | |
74 | * @is_iomem: is this io memory ? | |
75 | * @size: size in byte | |
76 | * @offset: offset from the base address | |
eba67093 TH |
77 | * @io_reserved_vm: The VM system has a refcount in @io_reserved_count |
78 | * @io_reserved_count: Refcounting the numbers of callers to ttm_mem_io_reserve | |
82c5da6b JG |
79 | * |
80 | * Structure indicating the bus placement of an object. | |
81 | */ | |
82 | struct ttm_bus_placement { | |
83 | void *addr; | |
84 | unsigned long base; | |
85 | unsigned long size; | |
86 | unsigned long offset; | |
87 | bool is_iomem; | |
eba67093 TH |
88 | bool io_reserved_vm; |
89 | uint64_t io_reserved_count; | |
82c5da6b JG |
90 | }; |
91 | ||
ca262a99 | 92 | |
ba4e7d97 TH |
93 | /** |
94 | * struct ttm_mem_reg | |
95 | * | |
96 | * @mm_node: Memory manager node. | |
97 | * @size: Requested size of memory region. | |
98 | * @num_pages: Actual size of memory region in pages. | |
99 | * @page_alignment: Page alignment. | |
100 | * @placement: Placement flags. | |
82c5da6b | 101 | * @bus: Placement on io bus accessible to the CPU |
ba4e7d97 TH |
102 | * |
103 | * Structure indicating the placement and space resources used by a | |
104 | * buffer object. | |
105 | */ | |
106 | ||
107 | struct ttm_mem_reg { | |
d961db75 BS |
108 | void *mm_node; |
109 | unsigned long start; | |
ba4e7d97 TH |
110 | unsigned long size; |
111 | unsigned long num_pages; | |
112 | uint32_t page_alignment; | |
113 | uint32_t mem_type; | |
114 | uint32_t placement; | |
82c5da6b | 115 | struct ttm_bus_placement bus; |
ba4e7d97 TH |
116 | }; |
117 | ||
118 | /** | |
119 | * enum ttm_bo_type | |
120 | * | |
121 | * @ttm_bo_type_device: These are 'normal' buffers that can | |
122 | * be mmapped by user space. Each of these bos occupy a slot in the | |
123 | * device address space, that can be used for normal vm operations. | |
124 | * | |
ba4e7d97 TH |
125 | * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers, |
126 | * but they cannot be accessed from user-space. For kernel-only use. | |
129b78bf DA |
127 | * |
128 | * @ttm_bo_type_sg: Buffer made from dmabuf sg table shared with another | |
129 | * driver. | |
ba4e7d97 TH |
130 | */ |
131 | ||
132 | enum ttm_bo_type { | |
133 | ttm_bo_type_device, | |
129b78bf DA |
134 | ttm_bo_type_kernel, |
135 | ttm_bo_type_sg | |
ba4e7d97 TH |
136 | }; |
137 | ||
138 | struct ttm_tt; | |
139 | ||
140 | /** | |
141 | * struct ttm_buffer_object | |
142 | * | |
143 | * @bdev: Pointer to the buffer object device structure. | |
ba4e7d97 TH |
144 | * @type: The bo type. |
145 | * @destroy: Destruction function. If NULL, kfree is used. | |
146 | * @num_pages: Actual number of pages. | |
147 | * @addr_space_offset: Address space offset. | |
148 | * @acc_size: Accounted size for this object. | |
149 | * @kref: Reference count of this buffer object. When this refcount reaches | |
150 | * zero, the object is put on the delayed delete list. | |
151 | * @list_kref: List reference count of this buffer object. This member is | |
152 | * used to avoid destruction while the buffer object is still on a list. | |
153 | * Lru lists may keep one refcount, the delayed delete list, and kref != 0 | |
154 | * keeps one refcount. When this refcount reaches zero, | |
155 | * the object is destroyed. | |
156 | * @event_queue: Queue for processes waiting on buffer object status change. | |
ba4e7d97 | 157 | * @mem: structure describing current placement. |
5df23979 | 158 | * @persistent_swap_storage: Usually the swap storage is deleted for buffers |
ba4e7d97 | 159 | * pinned in physical memory. If this behaviour is not desired, this member |
5df23979 | 160 | * holds a pointer to a persistent shmem object. |
ba4e7d97 TH |
161 | * @ttm: TTM structure holding system pages. |
162 | * @evicted: Whether the object was evicted without user-space knowing. | |
163 | * @cpu_writes: For synchronization. Number of cpu writers. | |
164 | * @lru: List head for the lru list. | |
165 | * @ddestroy: List head for the delayed destroy list. | |
166 | * @swap: List head for swap LRU list. | |
167 | * @val_seq: Sequence of the validation holding the @reserved lock. | |
168 | * Used to avoid starvation when many processes compete to validate the | |
169 | * buffer. This member is protected by the bo_device::lru_lock. | |
170 | * @seq_valid: The value of @val_seq is valid. This value is protected by | |
171 | * the bo_device::lru_lock. | |
172 | * @reserved: Deadlock-free lock used for synchronization state transitions. | |
ba4e7d97 TH |
173 | * @sync_obj: Pointer to a synchronization object. |
174 | * @priv_flags: Flags describing buffer object internal state. | |
175 | * @vm_rb: Rb node for the vm rb tree. | |
176 | * @vm_node: Address space manager node. | |
177 | * @offset: The current GPU offset, which can have different meanings | |
178 | * depending on the memory type. For SYSTEM type memory, it should be 0. | |
179 | * @cur_placement: Hint of current placement. | |
180 | * | |
181 | * Base class for TTM buffer object, that deals with data placement and CPU | |
182 | * mappings. GPU mappings are really up to the driver, but for simpler GPUs | |
183 | * the driver can usually use the placement offset @offset directly as the | |
184 | * GPU virtual address. For drivers implementing multiple | |
185 | * GPU memory manager contexts, the driver should manage the address space | |
186 | * in these contexts separately and use these objects to get the correct | |
187 | * placement and caching for these GPU maps. This makes it possible to use | |
188 | * these objects for even quite elaborate memory management schemes. | |
189 | * The destroy member, the API visibility of this object makes it possible | |
190 | * to derive driver specific types. | |
191 | */ | |
192 | ||
193 | struct ttm_buffer_object { | |
194 | /** | |
195 | * Members constant at init. | |
196 | */ | |
197 | ||
a987fcaa | 198 | struct ttm_bo_global *glob; |
ba4e7d97 | 199 | struct ttm_bo_device *bdev; |
ba4e7d97 TH |
200 | enum ttm_bo_type type; |
201 | void (*destroy) (struct ttm_buffer_object *); | |
202 | unsigned long num_pages; | |
203 | uint64_t addr_space_offset; | |
204 | size_t acc_size; | |
205 | ||
206 | /** | |
207 | * Members not needing protection. | |
208 | */ | |
209 | ||
210 | struct kref kref; | |
211 | struct kref list_kref; | |
212 | wait_queue_head_t event_queue; | |
ba4e7d97 TH |
213 | |
214 | /** | |
215 | * Members protected by the bo::reserved lock. | |
216 | */ | |
217 | ||
ba4e7d97 | 218 | struct ttm_mem_reg mem; |
5df23979 | 219 | struct file *persistent_swap_storage; |
ba4e7d97 TH |
220 | struct ttm_tt *ttm; |
221 | bool evicted; | |
222 | ||
223 | /** | |
224 | * Members protected by the bo::reserved lock only when written to. | |
225 | */ | |
226 | ||
227 | atomic_t cpu_writers; | |
228 | ||
229 | /** | |
230 | * Members protected by the bdev::lru_lock. | |
231 | */ | |
232 | ||
233 | struct list_head lru; | |
234 | struct list_head ddestroy; | |
235 | struct list_head swap; | |
eba67093 | 236 | struct list_head io_reserve_lru; |
ba4e7d97 TH |
237 | uint32_t val_seq; |
238 | bool seq_valid; | |
239 | ||
240 | /** | |
241 | * Members protected by the bdev::lru_lock | |
242 | * only when written to. | |
243 | */ | |
244 | ||
245 | atomic_t reserved; | |
246 | ||
ba4e7d97 | 247 | /** |
702adba2 | 248 | * Members protected by struct buffer_object_device::fence_lock |
1df6a2eb TH |
249 | * In addition, setting sync_obj to anything else |
250 | * than NULL requires bo::reserved to be held. This allows for | |
702adba2 | 251 | * checking NULL while reserved but not holding the mentioned lock. |
ba4e7d97 TH |
252 | */ |
253 | ||
ba4e7d97 TH |
254 | void *sync_obj; |
255 | unsigned long priv_flags; | |
256 | ||
257 | /** | |
258 | * Members protected by the bdev::vm_lock | |
259 | */ | |
260 | ||
261 | struct rb_node vm_rb; | |
262 | struct drm_mm_node *vm_node; | |
263 | ||
264 | ||
265 | /** | |
266 | * Special members that are protected by the reserve lock | |
267 | * and the bo::lock when written to. Can be read with | |
268 | * either of these locks held. | |
269 | */ | |
270 | ||
271 | unsigned long offset; | |
272 | uint32_t cur_placement; | |
129b78bf DA |
273 | |
274 | struct sg_table *sg; | |
ba4e7d97 TH |
275 | }; |
276 | ||
277 | /** | |
278 | * struct ttm_bo_kmap_obj | |
279 | * | |
280 | * @virtual: The current kernel virtual address. | |
281 | * @page: The page when kmap'ing a single page. | |
282 | * @bo_kmap_type: Type of bo_kmap. | |
283 | * | |
284 | * Object describing a kernel mapping. Since a TTM bo may be located | |
285 | * in various memory types with various caching policies, the | |
286 | * mapping can either be an ioremap, a vmap, a kmap or part of a | |
287 | * premapped region. | |
288 | */ | |
289 | ||
a0724fcf | 290 | #define TTM_BO_MAP_IOMEM_MASK 0x80 |
ba4e7d97 TH |
291 | struct ttm_bo_kmap_obj { |
292 | void *virtual; | |
293 | struct page *page; | |
294 | enum { | |
a0724fcf PP |
295 | ttm_bo_map_iomap = 1 | TTM_BO_MAP_IOMEM_MASK, |
296 | ttm_bo_map_vmap = 2, | |
297 | ttm_bo_map_kmap = 3, | |
298 | ttm_bo_map_premapped = 4 | TTM_BO_MAP_IOMEM_MASK, | |
ba4e7d97 | 299 | } bo_kmap_type; |
82c5da6b | 300 | struct ttm_buffer_object *bo; |
ba4e7d97 TH |
301 | }; |
302 | ||
303 | /** | |
304 | * ttm_bo_reference - reference a struct ttm_buffer_object | |
305 | * | |
306 | * @bo: The buffer object. | |
307 | * | |
308 | * Returns a refcounted pointer to a buffer object. | |
309 | */ | |
310 | ||
311 | static inline struct ttm_buffer_object * | |
312 | ttm_bo_reference(struct ttm_buffer_object *bo) | |
313 | { | |
314 | kref_get(&bo->kref); | |
315 | return bo; | |
316 | } | |
317 | ||
318 | /** | |
319 | * ttm_bo_wait - wait for buffer idle. | |
320 | * | |
321 | * @bo: The buffer object. | |
322 | * @interruptible: Use interruptible wait. | |
323 | * @no_wait: Return immediately if buffer is busy. | |
324 | * | |
325 | * This function must be called with the bo::mutex held, and makes | |
326 | * sure any previous rendering to the buffer is completed. | |
327 | * Note: It might be necessary to block validations before the | |
328 | * wait by reserving the buffer. | |
329 | * Returns -EBUSY if no_wait is true and the buffer is busy. | |
98ffc415 | 330 | * Returns -ERESTARTSYS if interrupted by a signal. |
ba4e7d97 TH |
331 | */ |
332 | extern int ttm_bo_wait(struct ttm_buffer_object *bo, bool lazy, | |
333 | bool interruptible, bool no_wait); | |
334 | /** | |
09855acb | 335 | * ttm_bo_validate |
ba4e7d97 TH |
336 | * |
337 | * @bo: The buffer object. | |
ca262a99 | 338 | * @placement: Proposed placement for the buffer object. |
ba4e7d97 | 339 | * @interruptible: Sleep interruptible if sleeping. |
9d87fa21 | 340 | * @no_wait_gpu: Return immediately if the GPU is busy. |
ba4e7d97 TH |
341 | * |
342 | * Changes placement and caching policy of the buffer object | |
ca262a99 | 343 | * according proposed placement. |
ba4e7d97 | 344 | * Returns |
ca262a99 | 345 | * -EINVAL on invalid proposed placement. |
ba4e7d97 TH |
346 | * -ENOMEM on out-of-memory condition. |
347 | * -EBUSY if no_wait is true and buffer busy. | |
98ffc415 | 348 | * -ERESTARTSYS if interrupted by a signal. |
ba4e7d97 | 349 | */ |
09855acb JG |
350 | extern int ttm_bo_validate(struct ttm_buffer_object *bo, |
351 | struct ttm_placement *placement, | |
97a875cb | 352 | bool interruptible, |
9d87fa21 | 353 | bool no_wait_gpu); |
ca262a99 | 354 | |
ba4e7d97 TH |
355 | /** |
356 | * ttm_bo_unref | |
357 | * | |
358 | * @bo: The buffer object. | |
359 | * | |
360 | * Unreference and clear a pointer to a buffer object. | |
361 | */ | |
362 | extern void ttm_bo_unref(struct ttm_buffer_object **bo); | |
363 | ||
d6ea8886 DA |
364 | |
365 | /** | |
366 | * ttm_bo_list_ref_sub | |
367 | * | |
368 | * @bo: The buffer object. | |
369 | * @count: The number of references with which to decrease @bo::list_kref; | |
370 | * @never_free: The refcount should not reach zero with this operation. | |
371 | * | |
372 | * Release @count lru list references to this buffer object. | |
373 | */ | |
374 | extern void ttm_bo_list_ref_sub(struct ttm_buffer_object *bo, int count, | |
375 | bool never_free); | |
376 | ||
377 | /** | |
378 | * ttm_bo_add_to_lru | |
379 | * | |
380 | * @bo: The buffer object. | |
381 | * | |
382 | * Add this bo to the relevant mem type lru and, if it's backed by | |
383 | * system pages (ttms) to the swap list. | |
384 | * This function must be called with struct ttm_bo_global::lru_lock held, and | |
385 | * is typically called immediately prior to unreserving a bo. | |
386 | */ | |
387 | extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo); | |
388 | ||
389 | /** | |
390 | * ttm_bo_del_from_lru | |
391 | * | |
392 | * @bo: The buffer object. | |
393 | * | |
394 | * Remove this bo from all lru lists used to lookup and reserve an object. | |
395 | * This function must be called with struct ttm_bo_global::lru_lock held, | |
396 | * and is usually called just immediately after the bo has been reserved to | |
397 | * avoid recursive reservation from lru lists. | |
398 | */ | |
399 | extern int ttm_bo_del_from_lru(struct ttm_buffer_object *bo); | |
400 | ||
401 | ||
7c5ee536 MG |
402 | /** |
403 | * ttm_bo_lock_delayed_workqueue | |
404 | * | |
405 | * Prevent the delayed workqueue from running. | |
406 | * Returns | |
407 | * True if the workqueue was queued at the time | |
408 | */ | |
409 | extern int ttm_bo_lock_delayed_workqueue(struct ttm_bo_device *bdev); | |
410 | ||
411 | /** | |
412 | * ttm_bo_unlock_delayed_workqueue | |
413 | * | |
414 | * Allows the delayed workqueue to run. | |
415 | */ | |
416 | extern void ttm_bo_unlock_delayed_workqueue(struct ttm_bo_device *bdev, | |
417 | int resched); | |
418 | ||
ba4e7d97 TH |
419 | /** |
420 | * ttm_bo_synccpu_write_grab | |
421 | * | |
422 | * @bo: The buffer object: | |
423 | * @no_wait: Return immediately if buffer is busy. | |
424 | * | |
425 | * Synchronizes a buffer object for CPU RW access. This means | |
654aa792 ML |
426 | * command submission that affects the buffer will return -EBUSY |
427 | * until ttm_bo_synccpu_write_release is called. | |
428 | * | |
ba4e7d97 TH |
429 | * Returns |
430 | * -EBUSY if the buffer is busy and no_wait is true. | |
98ffc415 | 431 | * -ERESTARTSYS if interrupted by a signal. |
ba4e7d97 | 432 | */ |
ba4e7d97 TH |
433 | extern int |
434 | ttm_bo_synccpu_write_grab(struct ttm_buffer_object *bo, bool no_wait); | |
57de4ba9 | 435 | |
ba4e7d97 TH |
436 | /** |
437 | * ttm_bo_synccpu_write_release: | |
438 | * | |
439 | * @bo : The buffer object. | |
440 | * | |
441 | * Releases a synccpu lock. | |
442 | */ | |
443 | extern void ttm_bo_synccpu_write_release(struct ttm_buffer_object *bo); | |
444 | ||
57de4ba9 JG |
445 | /** |
446 | * ttm_bo_acc_size | |
447 | * | |
448 | * @bdev: Pointer to a ttm_bo_device struct. | |
449 | * @bo_size: size of the buffer object in byte. | |
450 | * @struct_size: size of the structure holding buffer object datas | |
451 | * | |
452 | * Returns size to account for a buffer object | |
453 | */ | |
454 | size_t ttm_bo_acc_size(struct ttm_bo_device *bdev, | |
455 | unsigned long bo_size, | |
456 | unsigned struct_size); | |
457 | size_t ttm_bo_dma_acc_size(struct ttm_bo_device *bdev, | |
458 | unsigned long bo_size, | |
459 | unsigned struct_size); | |
460 | ||
ba4e7d97 | 461 | /** |
09855acb | 462 | * ttm_bo_init |
ba4e7d97 TH |
463 | * |
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. | |
ba4e7d97 TH |
470 | * @interruptible: If needing to sleep to wait for GPU resources, |
471 | * sleep interruptible. | |
5df23979 | 472 | * @persistent_swap_storage: Usually the swap storage is deleted for buffers |
ba4e7d97 | 473 | * pinned in physical memory. If this behaviour is not desired, this member |
5df23979 | 474 | * holds a pointer to a persistent shmem object. Typically, this would |
ba4e7d97 TH |
475 | * point to the shmem object backing a GEM object if TTM is used to back a |
476 | * GEM user interface. | |
477 | * @acc_size: Accounted size for this object. | |
478 | * @destroy: Destroy function. Use NULL for kfree(). | |
479 | * | |
480 | * This function initializes a pre-allocated struct ttm_buffer_object. | |
481 | * As this object may be part of a larger structure, this function, | |
482 | * together with the @destroy function, | |
483 | * enables driver-specific objects derived from a ttm_buffer_object. | |
484 | * On successful return, the object kref and list_kref are set to 1. | |
7dfbbdcf TH |
485 | * If a failure occurs, the function will call the @destroy function, or |
486 | * kfree() if @destroy is NULL. Thus, after a failure, dereferencing @bo is | |
487 | * illegal and will likely cause memory corruption. | |
488 | * | |
ba4e7d97 TH |
489 | * Returns |
490 | * -ENOMEM: Out of memory. | |
491 | * -EINVAL: Invalid placement flags. | |
98ffc415 | 492 | * -ERESTARTSYS: Interrupted by signal while sleeping waiting for resources. |
ba4e7d97 TH |
493 | */ |
494 | ||
09855acb JG |
495 | extern int ttm_bo_init(struct ttm_bo_device *bdev, |
496 | struct ttm_buffer_object *bo, | |
497 | unsigned long size, | |
498 | enum ttm_bo_type type, | |
499 | struct ttm_placement *placement, | |
500 | uint32_t page_alignment, | |
09855acb | 501 | bool interrubtible, |
5df23979 | 502 | struct file *persistent_swap_storage, |
09855acb | 503 | size_t acc_size, |
129b78bf | 504 | struct sg_table *sg, |
09855acb | 505 | void (*destroy) (struct ttm_buffer_object *)); |
57de4ba9 | 506 | |
ba4e7d97 TH |
507 | /** |
508 | * ttm_bo_synccpu_object_init | |
509 | * | |
510 | * @bdev: Pointer to a ttm_bo_device struct. | |
511 | * @bo: Pointer to a ttm_buffer_object to be initialized. | |
512 | * @size: Requested size of buffer object. | |
513 | * @type: Requested type of buffer object. | |
514 | * @flags: Initial placement flags. | |
515 | * @page_alignment: Data alignment in pages. | |
ba4e7d97 TH |
516 | * @interruptible: If needing to sleep while waiting for GPU resources, |
517 | * sleep interruptible. | |
5df23979 | 518 | * @persistent_swap_storage: Usually the swap storage is deleted for buffers |
ba4e7d97 | 519 | * pinned in physical memory. If this behaviour is not desired, this member |
5df23979 | 520 | * holds a pointer to a persistent shmem object. Typically, this would |
ba4e7d97 TH |
521 | * point to the shmem object backing a GEM object if TTM is used to back a |
522 | * GEM user interface. | |
523 | * @p_bo: On successful completion *p_bo points to the created object. | |
524 | * | |
09855acb JG |
525 | * This function allocates a ttm_buffer_object, and then calls ttm_bo_init |
526 | * on that object. The destroy function is set to kfree(). | |
ba4e7d97 TH |
527 | * Returns |
528 | * -ENOMEM: Out of memory. | |
529 | * -EINVAL: Invalid placement flags. | |
98ffc415 | 530 | * -ERESTARTSYS: Interrupted by signal while waiting for resources. |
ba4e7d97 TH |
531 | */ |
532 | ||
09855acb JG |
533 | extern int ttm_bo_create(struct ttm_bo_device *bdev, |
534 | unsigned long size, | |
535 | enum ttm_bo_type type, | |
536 | struct ttm_placement *placement, | |
537 | uint32_t page_alignment, | |
09855acb | 538 | bool interruptible, |
5df23979 | 539 | struct file *persistent_swap_storage, |
09855acb | 540 | struct ttm_buffer_object **p_bo); |
ba4e7d97 TH |
541 | |
542 | /** | |
543 | * ttm_bo_check_placement | |
544 | * | |
09855acb JG |
545 | * @bo: the buffer object. |
546 | * @placement: placements | |
ba4e7d97 TH |
547 | * |
548 | * Performs minimal validity checking on an intended change of | |
549 | * placement flags. | |
550 | * Returns | |
551 | * -EINVAL: Intended change is invalid or not allowed. | |
552 | */ | |
ba4e7d97 | 553 | extern int ttm_bo_check_placement(struct ttm_buffer_object *bo, |
09855acb | 554 | struct ttm_placement *placement); |
ba4e7d97 TH |
555 | |
556 | /** | |
557 | * ttm_bo_init_mm | |
558 | * | |
559 | * @bdev: Pointer to a ttm_bo_device struct. | |
560 | * @mem_type: The memory type. | |
ba4e7d97 TH |
561 | * @p_size: size managed area in pages. |
562 | * | |
563 | * Initialize a manager for a given memory type. | |
564 | * Note: if part of driver firstopen, it must be protected from a | |
565 | * potentially racing lastclose. | |
566 | * Returns: | |
567 | * -EINVAL: invalid size or memory type. | |
568 | * -ENOMEM: Not enough memory. | |
569 | * May also return driver-specified errors. | |
570 | */ | |
571 | ||
572 | extern int ttm_bo_init_mm(struct ttm_bo_device *bdev, unsigned type, | |
ca262a99 | 573 | unsigned long p_size); |
ba4e7d97 TH |
574 | /** |
575 | * ttm_bo_clean_mm | |
576 | * | |
577 | * @bdev: Pointer to a ttm_bo_device struct. | |
578 | * @mem_type: The memory type. | |
579 | * | |
580 | * Take down a manager for a given memory type after first walking | |
581 | * the LRU list to evict any buffers left alive. | |
582 | * | |
583 | * Normally, this function is part of lastclose() or unload(), and at that | |
584 | * point there shouldn't be any buffers left created by user-space, since | |
585 | * there should've been removed by the file descriptor release() method. | |
586 | * However, before this function is run, make sure to signal all sync objects, | |
587 | * and verify that the delayed delete queue is empty. The driver must also | |
588 | * make sure that there are no NO_EVICT buffers present in this memory type | |
589 | * when the call is made. | |
590 | * | |
591 | * If this function is part of a VT switch, the caller must make sure that | |
592 | * there are no appications currently validating buffers before this | |
593 | * function is called. The caller can do that by first taking the | |
594 | * struct ttm_bo_device::ttm_lock in write mode. | |
595 | * | |
596 | * Returns: | |
597 | * -EINVAL: invalid or uninitialized memory type. | |
598 | * -EBUSY: There are still buffers left in this memory type. | |
599 | */ | |
600 | ||
601 | extern int ttm_bo_clean_mm(struct ttm_bo_device *bdev, unsigned mem_type); | |
602 | ||
603 | /** | |
604 | * ttm_bo_evict_mm | |
605 | * | |
606 | * @bdev: Pointer to a ttm_bo_device struct. | |
607 | * @mem_type: The memory type. | |
608 | * | |
609 | * Evicts all buffers on the lru list of the memory type. | |
610 | * This is normally part of a VT switch or an | |
611 | * out-of-memory-space-due-to-fragmentation handler. | |
612 | * The caller must make sure that there are no other processes | |
613 | * currently validating buffers, and can do that by taking the | |
614 | * struct ttm_bo_device::ttm_lock in write mode. | |
615 | * | |
616 | * Returns: | |
617 | * -EINVAL: Invalid or uninitialized memory type. | |
98ffc415 | 618 | * -ERESTARTSYS: The call was interrupted by a signal while waiting to |
ba4e7d97 TH |
619 | * evict a buffer. |
620 | */ | |
621 | ||
622 | extern int ttm_bo_evict_mm(struct ttm_bo_device *bdev, unsigned mem_type); | |
623 | ||
624 | /** | |
625 | * ttm_kmap_obj_virtual | |
626 | * | |
627 | * @map: A struct ttm_bo_kmap_obj returned from ttm_bo_kmap. | |
628 | * @is_iomem: Pointer to an integer that on return indicates 1 if the | |
629 | * virtual map is io memory, 0 if normal memory. | |
630 | * | |
631 | * Returns the virtual address of a buffer object area mapped by ttm_bo_kmap. | |
632 | * If *is_iomem is 1 on return, the virtual address points to an io memory area, | |
633 | * that should strictly be accessed by the iowriteXX() and similar functions. | |
634 | */ | |
635 | ||
636 | static inline void *ttm_kmap_obj_virtual(struct ttm_bo_kmap_obj *map, | |
637 | bool *is_iomem) | |
638 | { | |
a0724fcf | 639 | *is_iomem = !!(map->bo_kmap_type & TTM_BO_MAP_IOMEM_MASK); |
ba4e7d97 TH |
640 | return map->virtual; |
641 | } | |
642 | ||
643 | /** | |
644 | * ttm_bo_kmap | |
645 | * | |
646 | * @bo: The buffer object. | |
647 | * @start_page: The first page to map. | |
648 | * @num_pages: Number of pages to map. | |
649 | * @map: pointer to a struct ttm_bo_kmap_obj representing the map. | |
650 | * | |
651 | * Sets up a kernel virtual mapping, using ioremap, vmap or kmap to the | |
652 | * data in the buffer object. The ttm_kmap_obj_virtual function can then be | |
653 | * used to obtain a virtual address to the data. | |
654 | * | |
655 | * Returns | |
656 | * -ENOMEM: Out of memory. | |
657 | * -EINVAL: Invalid range. | |
658 | */ | |
659 | ||
660 | extern int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page, | |
661 | unsigned long num_pages, struct ttm_bo_kmap_obj *map); | |
662 | ||
663 | /** | |
664 | * ttm_bo_kunmap | |
665 | * | |
666 | * @map: Object describing the map to unmap. | |
667 | * | |
668 | * Unmaps a kernel map set up by ttm_bo_kmap. | |
669 | */ | |
670 | ||
671 | extern void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map); | |
672 | ||
ba4e7d97 TH |
673 | /** |
674 | * ttm_fbdev_mmap - mmap fbdev memory backed by a ttm buffer object. | |
675 | * | |
676 | * @vma: vma as input from the fbdev mmap method. | |
677 | * @bo: The bo backing the address space. The address space will | |
678 | * have the same size as the bo, and start at offset 0. | |
679 | * | |
680 | * This function is intended to be called by the fbdev mmap method | |
681 | * if the fbdev address space is to be backed by a bo. | |
682 | */ | |
683 | ||
684 | extern int ttm_fbdev_mmap(struct vm_area_struct *vma, | |
685 | struct ttm_buffer_object *bo); | |
686 | ||
687 | /** | |
688 | * ttm_bo_mmap - mmap out of the ttm device address space. | |
689 | * | |
690 | * @filp: filp as input from the mmap method. | |
691 | * @vma: vma as input from the mmap method. | |
692 | * @bdev: Pointer to the ttm_bo_device with the address space manager. | |
693 | * | |
694 | * This function is intended to be called by the device mmap method. | |
695 | * if the device address space is to be backed by the bo manager. | |
696 | */ | |
697 | ||
698 | extern int ttm_bo_mmap(struct file *filp, struct vm_area_struct *vma, | |
699 | struct ttm_bo_device *bdev); | |
700 | ||
701 | /** | |
702 | * ttm_bo_io | |
703 | * | |
704 | * @bdev: Pointer to the struct ttm_bo_device. | |
705 | * @filp: Pointer to the struct file attempting to read / write. | |
706 | * @wbuf: User-space pointer to address of buffer to write. NULL on read. | |
707 | * @rbuf: User-space pointer to address of buffer to read into. | |
708 | * Null on write. | |
709 | * @count: Number of bytes to read / write. | |
710 | * @f_pos: Pointer to current file position. | |
711 | * @write: 1 for read, 0 for write. | |
712 | * | |
713 | * This function implements read / write into ttm buffer objects, and is | |
714 | * intended to | |
715 | * be called from the fops::read and fops::write method. | |
716 | * Returns: | |
717 | * See man (2) write, man(2) read. In particular, | |
98ffc415 | 718 | * the function may return -ERESTARTSYS if |
ba4e7d97 TH |
719 | * interrupted by a signal. |
720 | */ | |
721 | ||
722 | extern ssize_t ttm_bo_io(struct ttm_bo_device *bdev, struct file *filp, | |
723 | const char __user *wbuf, char __user *rbuf, | |
724 | size_t count, loff_t *f_pos, bool write); | |
725 | ||
726 | extern void ttm_bo_swapout_all(struct ttm_bo_device *bdev); | |
727 | ||
a9dbfff1 ML |
728 | /** |
729 | * ttm_bo_is_reserved - return an indication if a ttm buffer object is reserved | |
730 | * | |
731 | * @bo: The buffer object to check. | |
732 | * | |
733 | * This function returns an indication if a bo is reserved or not, and should | |
734 | * only be used to print an error when it is not from incorrect api usage, since | |
735 | * there's no guarantee that it is the caller that is holding the reservation. | |
736 | */ | |
737 | static inline bool ttm_bo_is_reserved(struct ttm_buffer_object *bo) | |
738 | { | |
739 | return atomic_read(&bo->reserved); | |
740 | } | |
741 | ||
ba4e7d97 | 742 | #endif |