1 /**************************************************************************
3 * Copyright © 2012-2015 VMware, Inc., Palo Alto, CA., USA
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
28 #include "vmwgfx_drv.h"
31 * If we set up the screen target otable, screen objects stop working.
34 #define VMW_OTABLE_SETUP_SUB ((VMWGFX_ENABLE_SCREEN_TARGET_OTABLE ? 0 : 1))
37 #define VMW_PPN_SIZE 8
38 #define VMW_MOBFMT_PTDEPTH_0 SVGA3D_MOBFMT_PTDEPTH64_0
39 #define VMW_MOBFMT_PTDEPTH_1 SVGA3D_MOBFMT_PTDEPTH64_1
40 #define VMW_MOBFMT_PTDEPTH_2 SVGA3D_MOBFMT_PTDEPTH64_2
42 #define VMW_PPN_SIZE 4
43 #define VMW_MOBFMT_PTDEPTH_0 SVGA3D_MOBFMT_PTDEPTH_0
44 #define VMW_MOBFMT_PTDEPTH_1 SVGA3D_MOBFMT_PTDEPTH_1
45 #define VMW_MOBFMT_PTDEPTH_2 SVGA3D_MOBFMT_PTDEPTH_2
49 * struct vmw_mob - Structure containing page table and metadata for a
50 * Guest Memory OBject.
52 * @num_pages Number of pages that make up the page table.
53 * @pt_level The indirection level of the page table. 0-2.
54 * @pt_root_page DMA address of the level 0 page of the page table.
57 struct ttm_buffer_object
*pt_bo
;
58 unsigned long num_pages
;
60 dma_addr_t pt_root_page
;
65 * struct vmw_otable - Guest Memory OBject table metadata
67 * @size: Size of the table (page-aligned).
68 * @page_table: Pointer to a struct vmw_mob holding the page table.
70 static const struct vmw_otable pre_dx_tables
[] = {
71 {VMWGFX_NUM_MOB
* SVGA3D_OTABLE_MOB_ENTRY_SIZE
, NULL
, true},
72 {VMWGFX_NUM_GB_SURFACE
* SVGA3D_OTABLE_SURFACE_ENTRY_SIZE
, NULL
, true},
73 {VMWGFX_NUM_GB_CONTEXT
* SVGA3D_OTABLE_CONTEXT_ENTRY_SIZE
, NULL
, true},
74 {VMWGFX_NUM_GB_SHADER
* SVGA3D_OTABLE_SHADER_ENTRY_SIZE
, NULL
, true},
75 {VMWGFX_NUM_GB_SCREEN_TARGET
* SVGA3D_OTABLE_SCREEN_TARGET_ENTRY_SIZE
,
76 NULL
, VMWGFX_ENABLE_SCREEN_TARGET_OTABLE
}
79 static const struct vmw_otable dx_tables
[] = {
80 {VMWGFX_NUM_MOB
* SVGA3D_OTABLE_MOB_ENTRY_SIZE
, NULL
, true},
81 {VMWGFX_NUM_GB_SURFACE
* SVGA3D_OTABLE_SURFACE_ENTRY_SIZE
, NULL
, true},
82 {VMWGFX_NUM_GB_CONTEXT
* SVGA3D_OTABLE_CONTEXT_ENTRY_SIZE
, NULL
, true},
83 {VMWGFX_NUM_GB_SHADER
* SVGA3D_OTABLE_SHADER_ENTRY_SIZE
, NULL
, true},
84 {VMWGFX_NUM_GB_SCREEN_TARGET
* SVGA3D_OTABLE_SCREEN_TARGET_ENTRY_SIZE
,
85 NULL
, VMWGFX_ENABLE_SCREEN_TARGET_OTABLE
},
86 {VMWGFX_NUM_DXCONTEXT
* sizeof(SVGAOTableDXContextEntry
), NULL
, true},
89 static int vmw_mob_pt_populate(struct vmw_private
*dev_priv
,
91 static void vmw_mob_pt_setup(struct vmw_mob
*mob
,
92 struct vmw_piter data_iter
,
93 unsigned long num_data_pages
);
96 * vmw_setup_otable_base - Issue an object table base setup command to
99 * @dev_priv: Pointer to a device private structure
100 * @type: Type of object table base
101 * @offset Start of table offset into dev_priv::otable_bo
102 * @otable Pointer to otable metadata;
104 * This function returns -ENOMEM if it fails to reserve fifo space,
105 * and may block waiting for fifo space.
107 static int vmw_setup_otable_base(struct vmw_private
*dev_priv
,
109 struct ttm_buffer_object
*otable_bo
,
110 unsigned long offset
,
111 struct vmw_otable
*otable
)
114 SVGA3dCmdHeader header
;
115 SVGA3dCmdSetOTableBase64 body
;
118 const struct vmw_sg_table
*vsgt
;
119 struct vmw_piter iter
;
122 BUG_ON(otable
->page_table
!= NULL
);
124 vsgt
= vmw_bo_sg_table(otable_bo
);
125 vmw_piter_start(&iter
, vsgt
, offset
>> PAGE_SHIFT
);
126 WARN_ON(!vmw_piter_next(&iter
));
128 mob
= vmw_mob_create(otable
->size
>> PAGE_SHIFT
);
129 if (unlikely(mob
== NULL
)) {
130 DRM_ERROR("Failed creating OTable page table.\n");
134 if (otable
->size
<= PAGE_SIZE
) {
135 mob
->pt_level
= VMW_MOBFMT_PTDEPTH_0
;
136 mob
->pt_root_page
= vmw_piter_dma_addr(&iter
);
137 } else if (vsgt
->num_regions
== 1) {
138 mob
->pt_level
= SVGA3D_MOBFMT_RANGE
;
139 mob
->pt_root_page
= vmw_piter_dma_addr(&iter
);
141 ret
= vmw_mob_pt_populate(dev_priv
, mob
);
142 if (unlikely(ret
!= 0))
143 goto out_no_populate
;
145 vmw_mob_pt_setup(mob
, iter
, otable
->size
>> PAGE_SHIFT
);
146 mob
->pt_level
+= VMW_MOBFMT_PTDEPTH_1
- SVGA3D_MOBFMT_PTDEPTH_1
;
149 cmd
= vmw_fifo_reserve(dev_priv
, sizeof(*cmd
));
150 if (unlikely(cmd
== NULL
)) {
151 DRM_ERROR("Failed reserving FIFO space for OTable setup.\n");
156 memset(cmd
, 0, sizeof(*cmd
));
157 cmd
->header
.id
= SVGA_3D_CMD_SET_OTABLE_BASE64
;
158 cmd
->header
.size
= sizeof(cmd
->body
);
159 cmd
->body
.type
= type
;
160 cmd
->body
.baseAddress
= mob
->pt_root_page
>> PAGE_SHIFT
;
161 cmd
->body
.sizeInBytes
= otable
->size
;
162 cmd
->body
.validSizeInBytes
= 0;
163 cmd
->body
.ptDepth
= mob
->pt_level
;
166 * The device doesn't support this, But the otable size is
167 * determined at compile-time, so this BUG shouldn't trigger
170 BUG_ON(mob
->pt_level
== VMW_MOBFMT_PTDEPTH_2
);
172 vmw_fifo_commit(dev_priv
, sizeof(*cmd
));
173 otable
->page_table
= mob
;
179 vmw_mob_destroy(mob
);
184 * vmw_takedown_otable_base - Issue an object table base takedown command
187 * @dev_priv: Pointer to a device private structure
188 * @type: Type of object table base
191 static void vmw_takedown_otable_base(struct vmw_private
*dev_priv
,
193 struct vmw_otable
*otable
)
196 SVGA3dCmdHeader header
;
197 SVGA3dCmdSetOTableBase body
;
199 struct ttm_buffer_object
*bo
;
201 if (otable
->page_table
== NULL
)
204 bo
= otable
->page_table
->pt_bo
;
205 cmd
= vmw_fifo_reserve(dev_priv
, sizeof(*cmd
));
206 if (unlikely(cmd
== NULL
)) {
207 DRM_ERROR("Failed reserving FIFO space for OTable "
212 memset(cmd
, 0, sizeof(*cmd
));
213 cmd
->header
.id
= SVGA_3D_CMD_SET_OTABLE_BASE
;
214 cmd
->header
.size
= sizeof(cmd
->body
);
215 cmd
->body
.type
= type
;
216 cmd
->body
.baseAddress
= 0;
217 cmd
->body
.sizeInBytes
= 0;
218 cmd
->body
.validSizeInBytes
= 0;
219 cmd
->body
.ptDepth
= SVGA3D_MOBFMT_INVALID
;
220 vmw_fifo_commit(dev_priv
, sizeof(*cmd
));
225 ret
= ttm_bo_reserve(bo
, false, true, NULL
);
228 vmw_fence_single_bo(bo
, NULL
);
229 ttm_bo_unreserve(bo
);
232 vmw_mob_destroy(otable
->page_table
);
233 otable
->page_table
= NULL
;
237 static int vmw_otable_batch_setup(struct vmw_private
*dev_priv
,
238 struct vmw_otable_batch
*batch
)
240 unsigned long offset
;
241 unsigned long bo_size
;
242 struct vmw_otable
*otables
= batch
->otables
;
247 for (i
= 0; i
< batch
->num_otables
; ++i
) {
248 if (!otables
[i
].enabled
)
252 (otables
[i
].size
+ PAGE_SIZE
- 1) & PAGE_MASK
;
253 bo_size
+= otables
[i
].size
;
256 ret
= ttm_bo_create(&dev_priv
->bdev
, bo_size
,
258 &vmw_sys_ne_placement
,
262 if (unlikely(ret
!= 0))
265 ret
= ttm_bo_reserve(batch
->otable_bo
, false, true, NULL
);
267 ret
= vmw_bo_driver
.ttm_tt_populate(batch
->otable_bo
->ttm
);
268 if (unlikely(ret
!= 0))
270 ret
= vmw_bo_map_dma(batch
->otable_bo
);
271 if (unlikely(ret
!= 0))
274 ttm_bo_unreserve(batch
->otable_bo
);
277 for (i
= 0; i
< batch
->num_otables
; ++i
) {
278 if (!batch
->otables
[i
].enabled
)
281 ret
= vmw_setup_otable_base(dev_priv
, i
, batch
->otable_bo
,
284 if (unlikely(ret
!= 0))
286 offset
+= otables
[i
].size
;
292 ttm_bo_unreserve(batch
->otable_bo
);
294 for (i
= 0; i
< batch
->num_otables
; ++i
) {
295 if (batch
->otables
[i
].enabled
)
296 vmw_takedown_otable_base(dev_priv
, i
,
300 ttm_bo_unref(&batch
->otable_bo
);
306 * vmw_otables_setup - Set up guest backed memory object tables
308 * @dev_priv: Pointer to a device private structure
310 * Takes care of the device guest backed surface
311 * initialization, by setting up the guest backed memory object tables.
312 * Returns 0 on success and various error codes on failure. A successful return
313 * means the object tables can be taken down using the vmw_otables_takedown
316 int vmw_otables_setup(struct vmw_private
*dev_priv
)
318 struct vmw_otable
**otables
= &dev_priv
->otable_batch
.otables
;
321 if (dev_priv
->has_dx
) {
322 *otables
= kmemdup(dx_tables
, sizeof(dx_tables
), GFP_KERNEL
);
326 dev_priv
->otable_batch
.num_otables
= ARRAY_SIZE(dx_tables
);
328 *otables
= kmemdup(pre_dx_tables
, sizeof(pre_dx_tables
),
333 dev_priv
->otable_batch
.num_otables
= ARRAY_SIZE(pre_dx_tables
);
336 ret
= vmw_otable_batch_setup(dev_priv
, &dev_priv
->otable_batch
);
337 if (unlikely(ret
!= 0))
347 static void vmw_otable_batch_takedown(struct vmw_private
*dev_priv
,
348 struct vmw_otable_batch
*batch
)
351 struct ttm_buffer_object
*bo
= batch
->otable_bo
;
354 for (i
= 0; i
< batch
->num_otables
; ++i
)
355 if (batch
->otables
[i
].enabled
)
356 vmw_takedown_otable_base(dev_priv
, i
,
359 ret
= ttm_bo_reserve(bo
, false, true, NULL
);
362 vmw_fence_single_bo(bo
, NULL
);
363 ttm_bo_unreserve(bo
);
365 ttm_bo_unref(&batch
->otable_bo
);
369 * vmw_otables_takedown - Take down guest backed memory object tables
371 * @dev_priv: Pointer to a device private structure
373 * Take down the Guest Memory Object tables.
375 void vmw_otables_takedown(struct vmw_private
*dev_priv
)
377 vmw_otable_batch_takedown(dev_priv
, &dev_priv
->otable_batch
);
378 kfree(dev_priv
->otable_batch
.otables
);
382 * vmw_mob_calculate_pt_pages - Calculate the number of page table pages
383 * needed for a guest backed memory object.
385 * @data_pages: Number of data pages in the memory object buffer.
387 static unsigned long vmw_mob_calculate_pt_pages(unsigned long data_pages
)
389 unsigned long data_size
= data_pages
* PAGE_SIZE
;
390 unsigned long tot_size
= 0;
392 while (likely(data_size
> PAGE_SIZE
)) {
393 data_size
= DIV_ROUND_UP(data_size
, PAGE_SIZE
);
394 data_size
*= VMW_PPN_SIZE
;
395 tot_size
+= (data_size
+ PAGE_SIZE
- 1) & PAGE_MASK
;
398 return tot_size
>> PAGE_SHIFT
;
402 * vmw_mob_create - Create a mob, but don't populate it.
404 * @data_pages: Number of data pages of the underlying buffer object.
406 struct vmw_mob
*vmw_mob_create(unsigned long data_pages
)
408 struct vmw_mob
*mob
= kzalloc(sizeof(*mob
), GFP_KERNEL
);
413 mob
->num_pages
= vmw_mob_calculate_pt_pages(data_pages
);
419 * vmw_mob_pt_populate - Populate the mob pagetable
421 * @mob: Pointer to the mob the pagetable of which we want to
424 * This function allocates memory to be used for the pagetable, and
425 * adjusts TTM memory accounting accordingly. Returns ENOMEM if
426 * memory resources aren't sufficient and may cause TTM buffer objects
427 * to be swapped out by using the TTM memory accounting function.
429 static int vmw_mob_pt_populate(struct vmw_private
*dev_priv
,
433 BUG_ON(mob
->pt_bo
!= NULL
);
435 ret
= ttm_bo_create(&dev_priv
->bdev
, mob
->num_pages
* PAGE_SIZE
,
437 &vmw_sys_ne_placement
,
438 0, false, NULL
, &mob
->pt_bo
);
439 if (unlikely(ret
!= 0))
442 ret
= ttm_bo_reserve(mob
->pt_bo
, false, true, NULL
);
445 ret
= vmw_bo_driver
.ttm_tt_populate(mob
->pt_bo
->ttm
);
446 if (unlikely(ret
!= 0))
448 ret
= vmw_bo_map_dma(mob
->pt_bo
);
449 if (unlikely(ret
!= 0))
452 ttm_bo_unreserve(mob
->pt_bo
);
457 ttm_bo_unreserve(mob
->pt_bo
);
458 ttm_bo_unref(&mob
->pt_bo
);
464 * vmw_mob_assign_ppn - Assign a value to a page table entry
466 * @addr: Pointer to pointer to page table entry.
467 * @val: The page table entry
469 * Assigns a value to a page table entry pointed to by *@addr and increments
470 * *@addr according to the page table entry size.
472 #if (VMW_PPN_SIZE == 8)
473 static void vmw_mob_assign_ppn(u32
**addr
, dma_addr_t val
)
475 *((u64
*) *addr
) = val
>> PAGE_SHIFT
;
479 static void vmw_mob_assign_ppn(u32
**addr
, dma_addr_t val
)
481 *(*addr
)++ = val
>> PAGE_SHIFT
;
486 * vmw_mob_build_pt - Build a pagetable
488 * @data_addr: Array of DMA addresses to the underlying buffer
489 * object's data pages.
490 * @num_data_pages: Number of buffer object data pages.
491 * @pt_pages: Array of page pointers to the page table pages.
493 * Returns the number of page table pages actually used.
494 * Uses atomic kmaps of highmem pages to avoid TLB thrashing.
496 static unsigned long vmw_mob_build_pt(struct vmw_piter
*data_iter
,
497 unsigned long num_data_pages
,
498 struct vmw_piter
*pt_iter
)
500 unsigned long pt_size
= num_data_pages
* VMW_PPN_SIZE
;
501 unsigned long num_pt_pages
= DIV_ROUND_UP(pt_size
, PAGE_SIZE
);
502 unsigned long pt_page
;
503 u32
*addr
, *save_addr
;
507 for (pt_page
= 0; pt_page
< num_pt_pages
; ++pt_page
) {
508 page
= vmw_piter_page(pt_iter
);
510 save_addr
= addr
= kmap_atomic(page
);
512 for (i
= 0; i
< PAGE_SIZE
/ VMW_PPN_SIZE
; ++i
) {
513 vmw_mob_assign_ppn(&addr
,
514 vmw_piter_dma_addr(data_iter
));
515 if (unlikely(--num_data_pages
== 0))
517 WARN_ON(!vmw_piter_next(data_iter
));
519 kunmap_atomic(save_addr
);
520 vmw_piter_next(pt_iter
);
527 * vmw_mob_build_pt - Set up a multilevel mob pagetable
529 * @mob: Pointer to a mob whose page table needs setting up.
530 * @data_addr Array of DMA addresses to the buffer object's data
532 * @num_data_pages: Number of buffer object data pages.
534 * Uses tail recursion to set up a multilevel mob page table.
536 static void vmw_mob_pt_setup(struct vmw_mob
*mob
,
537 struct vmw_piter data_iter
,
538 unsigned long num_data_pages
)
540 unsigned long num_pt_pages
= 0;
541 struct ttm_buffer_object
*bo
= mob
->pt_bo
;
542 struct vmw_piter save_pt_iter
;
543 struct vmw_piter pt_iter
;
544 const struct vmw_sg_table
*vsgt
;
547 ret
= ttm_bo_reserve(bo
, false, true, NULL
);
550 vsgt
= vmw_bo_sg_table(bo
);
551 vmw_piter_start(&pt_iter
, vsgt
, 0);
552 BUG_ON(!vmw_piter_next(&pt_iter
));
554 while (likely(num_data_pages
> 1)) {
556 BUG_ON(mob
->pt_level
> 2);
557 save_pt_iter
= pt_iter
;
558 num_pt_pages
= vmw_mob_build_pt(&data_iter
, num_data_pages
,
560 data_iter
= save_pt_iter
;
561 num_data_pages
= num_pt_pages
;
564 mob
->pt_root_page
= vmw_piter_dma_addr(&save_pt_iter
);
565 ttm_bo_unreserve(bo
);
569 * vmw_mob_destroy - Destroy a mob, unpopulating first if necessary.
571 * @mob: Pointer to a mob to destroy.
573 void vmw_mob_destroy(struct vmw_mob
*mob
)
576 ttm_bo_unref(&mob
->pt_bo
);
581 * vmw_mob_unbind - Hide a mob from the device.
583 * @dev_priv: Pointer to a device private.
584 * @mob_id: Device id of the mob to unbind.
586 void vmw_mob_unbind(struct vmw_private
*dev_priv
,
590 SVGA3dCmdHeader header
;
591 SVGA3dCmdDestroyGBMob body
;
594 struct ttm_buffer_object
*bo
= mob
->pt_bo
;
597 ret
= ttm_bo_reserve(bo
, false, true, NULL
);
599 * Noone else should be using this buffer.
604 cmd
= vmw_fifo_reserve(dev_priv
, sizeof(*cmd
));
605 if (unlikely(cmd
== NULL
)) {
606 DRM_ERROR("Failed reserving FIFO space for Memory "
607 "Object unbinding.\n");
609 cmd
->header
.id
= SVGA_3D_CMD_DESTROY_GB_MOB
;
610 cmd
->header
.size
= sizeof(cmd
->body
);
611 cmd
->body
.mobid
= mob
->id
;
612 vmw_fifo_commit(dev_priv
, sizeof(*cmd
));
615 vmw_fence_single_bo(bo
, NULL
);
616 ttm_bo_unreserve(bo
);
618 vmw_fifo_resource_dec(dev_priv
);
622 * vmw_mob_bind - Make a mob visible to the device after first
623 * populating it if necessary.
625 * @dev_priv: Pointer to a device private.
626 * @mob: Pointer to the mob we're making visible.
627 * @data_addr: Array of DMA addresses to the data pages of the underlying
629 * @num_data_pages: Number of data pages of the underlying buffer
631 * @mob_id: Device id of the mob to bind
633 * This function is intended to be interfaced with the ttm_tt backend
636 int vmw_mob_bind(struct vmw_private
*dev_priv
,
638 const struct vmw_sg_table
*vsgt
,
639 unsigned long num_data_pages
,
643 bool pt_set_up
= false;
644 struct vmw_piter data_iter
;
646 SVGA3dCmdHeader header
;
647 SVGA3dCmdDefineGBMob64 body
;
651 vmw_piter_start(&data_iter
, vsgt
, 0);
652 if (unlikely(!vmw_piter_next(&data_iter
)))
655 if (likely(num_data_pages
== 1)) {
656 mob
->pt_level
= VMW_MOBFMT_PTDEPTH_0
;
657 mob
->pt_root_page
= vmw_piter_dma_addr(&data_iter
);
658 } else if (vsgt
->num_regions
== 1) {
659 mob
->pt_level
= SVGA3D_MOBFMT_RANGE
;
660 mob
->pt_root_page
= vmw_piter_dma_addr(&data_iter
);
661 } else if (unlikely(mob
->pt_bo
== NULL
)) {
662 ret
= vmw_mob_pt_populate(dev_priv
, mob
);
663 if (unlikely(ret
!= 0))
666 vmw_mob_pt_setup(mob
, data_iter
, num_data_pages
);
668 mob
->pt_level
+= VMW_MOBFMT_PTDEPTH_1
- SVGA3D_MOBFMT_PTDEPTH_1
;
671 vmw_fifo_resource_inc(dev_priv
);
673 cmd
= vmw_fifo_reserve(dev_priv
, sizeof(*cmd
));
674 if (unlikely(cmd
== NULL
)) {
675 DRM_ERROR("Failed reserving FIFO space for Memory "
676 "Object binding.\n");
677 goto out_no_cmd_space
;
680 cmd
->header
.id
= SVGA_3D_CMD_DEFINE_GB_MOB64
;
681 cmd
->header
.size
= sizeof(cmd
->body
);
682 cmd
->body
.mobid
= mob_id
;
683 cmd
->body
.ptDepth
= mob
->pt_level
;
684 cmd
->body
.base
= mob
->pt_root_page
>> PAGE_SHIFT
;
685 cmd
->body
.sizeInBytes
= num_data_pages
* PAGE_SIZE
;
687 vmw_fifo_commit(dev_priv
, sizeof(*cmd
));
692 vmw_fifo_resource_dec(dev_priv
);
694 ttm_bo_unref(&mob
->pt_bo
);