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