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