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