1 // SPDX-License-Identifier: GPL-2.0 OR MIT
2 /**************************************************************************
4 * 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 <linux/highmem.h>
30 #include "vmwgfx_drv.h"
33 * If we set up the screen target otable, screen objects stop working.
36 #define VMW_OTABLE_SETUP_SUB ((VMWGFX_ENABLE_SCREEN_TARGET_OTABLE ? 0 : 1))
39 #define VMW_PPN_SIZE 8
40 #define VMW_MOBFMT_PTDEPTH_0 SVGA3D_MOBFMT_PTDEPTH64_0
41 #define VMW_MOBFMT_PTDEPTH_1 SVGA3D_MOBFMT_PTDEPTH64_1
42 #define VMW_MOBFMT_PTDEPTH_2 SVGA3D_MOBFMT_PTDEPTH64_2
44 #define VMW_PPN_SIZE 4
45 #define VMW_MOBFMT_PTDEPTH_0 SVGA3D_MOBFMT_PTDEPTH_0
46 #define VMW_MOBFMT_PTDEPTH_1 SVGA3D_MOBFMT_PTDEPTH_1
47 #define VMW_MOBFMT_PTDEPTH_2 SVGA3D_MOBFMT_PTDEPTH_2
51 * struct vmw_mob - Structure containing page table and metadata for a
52 * Guest Memory OBject.
54 * @num_pages Number of pages that make up the page table.
55 * @pt_level The indirection level of the page table. 0-2.
56 * @pt_root_page DMA address of the level 0 page of the page table.
59 struct ttm_buffer_object
*pt_bo
;
60 unsigned long num_pages
;
62 dma_addr_t pt_root_page
;
67 * struct vmw_otable - Guest Memory OBject table metadata
69 * @size: Size of the table (page-aligned).
70 * @page_table: Pointer to a struct vmw_mob holding the page table.
72 static const struct vmw_otable pre_dx_tables
[] = {
73 {VMWGFX_NUM_MOB
* SVGA3D_OTABLE_MOB_ENTRY_SIZE
, NULL
, true},
74 {VMWGFX_NUM_GB_SURFACE
* SVGA3D_OTABLE_SURFACE_ENTRY_SIZE
, NULL
, true},
75 {VMWGFX_NUM_GB_CONTEXT
* SVGA3D_OTABLE_CONTEXT_ENTRY_SIZE
, NULL
, true},
76 {VMWGFX_NUM_GB_SHADER
* SVGA3D_OTABLE_SHADER_ENTRY_SIZE
, NULL
, true},
77 {VMWGFX_NUM_GB_SCREEN_TARGET
* SVGA3D_OTABLE_SCREEN_TARGET_ENTRY_SIZE
,
78 NULL
, VMWGFX_ENABLE_SCREEN_TARGET_OTABLE
}
81 static const struct vmw_otable dx_tables
[] = {
82 {VMWGFX_NUM_MOB
* SVGA3D_OTABLE_MOB_ENTRY_SIZE
, NULL
, true},
83 {VMWGFX_NUM_GB_SURFACE
* SVGA3D_OTABLE_SURFACE_ENTRY_SIZE
, NULL
, true},
84 {VMWGFX_NUM_GB_CONTEXT
* SVGA3D_OTABLE_CONTEXT_ENTRY_SIZE
, NULL
, true},
85 {VMWGFX_NUM_GB_SHADER
* SVGA3D_OTABLE_SHADER_ENTRY_SIZE
, NULL
, true},
86 {VMWGFX_NUM_GB_SCREEN_TARGET
* SVGA3D_OTABLE_SCREEN_TARGET_ENTRY_SIZE
,
87 NULL
, VMWGFX_ENABLE_SCREEN_TARGET_OTABLE
},
88 {VMWGFX_NUM_DXCONTEXT
* sizeof(SVGAOTableDXContextEntry
), NULL
, true},
91 static int vmw_mob_pt_populate(struct vmw_private
*dev_priv
,
93 static void vmw_mob_pt_setup(struct vmw_mob
*mob
,
94 struct vmw_piter data_iter
,
95 unsigned long num_data_pages
);
98 * vmw_setup_otable_base - Issue an object table base setup command to
101 * @dev_priv: Pointer to a device private structure
102 * @type: Type of object table base
103 * @offset Start of table offset into dev_priv::otable_bo
104 * @otable Pointer to otable metadata;
106 * This function returns -ENOMEM if it fails to reserve fifo space,
107 * and may block waiting for fifo space.
109 static int vmw_setup_otable_base(struct vmw_private
*dev_priv
,
111 struct ttm_buffer_object
*otable_bo
,
112 unsigned long offset
,
113 struct vmw_otable
*otable
)
116 SVGA3dCmdHeader header
;
117 SVGA3dCmdSetOTableBase64 body
;
120 const struct vmw_sg_table
*vsgt
;
121 struct vmw_piter iter
;
124 BUG_ON(otable
->page_table
!= NULL
);
126 vsgt
= vmw_bo_sg_table(otable_bo
);
127 vmw_piter_start(&iter
, vsgt
, offset
>> PAGE_SHIFT
);
128 WARN_ON(!vmw_piter_next(&iter
));
130 mob
= vmw_mob_create(otable
->size
>> PAGE_SHIFT
);
131 if (unlikely(mob
== NULL
)) {
132 DRM_ERROR("Failed creating OTable page table.\n");
136 if (otable
->size
<= PAGE_SIZE
) {
137 mob
->pt_level
= VMW_MOBFMT_PTDEPTH_0
;
138 mob
->pt_root_page
= vmw_piter_dma_addr(&iter
);
139 } else if (vsgt
->num_regions
== 1) {
140 mob
->pt_level
= SVGA3D_MOBFMT_RANGE
;
141 mob
->pt_root_page
= vmw_piter_dma_addr(&iter
);
143 ret
= vmw_mob_pt_populate(dev_priv
, mob
);
144 if (unlikely(ret
!= 0))
145 goto out_no_populate
;
147 vmw_mob_pt_setup(mob
, iter
, otable
->size
>> PAGE_SHIFT
);
148 mob
->pt_level
+= VMW_MOBFMT_PTDEPTH_1
- SVGA3D_MOBFMT_PTDEPTH_1
;
151 cmd
= VMW_FIFO_RESERVE(dev_priv
, sizeof(*cmd
));
152 if (unlikely(cmd
== NULL
)) {
157 memset(cmd
, 0, sizeof(*cmd
));
158 cmd
->header
.id
= SVGA_3D_CMD_SET_OTABLE_BASE64
;
159 cmd
->header
.size
= sizeof(cmd
->body
);
160 cmd
->body
.type
= type
;
161 cmd
->body
.baseAddress
= mob
->pt_root_page
>> PAGE_SHIFT
;
162 cmd
->body
.sizeInBytes
= otable
->size
;
163 cmd
->body
.validSizeInBytes
= 0;
164 cmd
->body
.ptDepth
= mob
->pt_level
;
167 * The device doesn't support this, But the otable size is
168 * determined at compile-time, so this BUG shouldn't trigger
171 BUG_ON(mob
->pt_level
== VMW_MOBFMT_PTDEPTH_2
);
173 vmw_fifo_commit(dev_priv
, sizeof(*cmd
));
174 otable
->page_table
= mob
;
180 vmw_mob_destroy(mob
);
185 * vmw_takedown_otable_base - Issue an object table base takedown command
188 * @dev_priv: Pointer to a device private structure
189 * @type: Type of object table base
192 static void vmw_takedown_otable_base(struct vmw_private
*dev_priv
,
194 struct vmw_otable
*otable
)
197 SVGA3dCmdHeader header
;
198 SVGA3dCmdSetOTableBase body
;
200 struct ttm_buffer_object
*bo
;
202 if (otable
->page_table
== NULL
)
205 bo
= otable
->page_table
->pt_bo
;
206 cmd
= VMW_FIFO_RESERVE(dev_priv
, sizeof(*cmd
));
207 if (unlikely(cmd
== NULL
))
210 memset(cmd
, 0, sizeof(*cmd
));
211 cmd
->header
.id
= SVGA_3D_CMD_SET_OTABLE_BASE
;
212 cmd
->header
.size
= sizeof(cmd
->body
);
213 cmd
->body
.type
= type
;
214 cmd
->body
.baseAddress
= 0;
215 cmd
->body
.sizeInBytes
= 0;
216 cmd
->body
.validSizeInBytes
= 0;
217 cmd
->body
.ptDepth
= SVGA3D_MOBFMT_INVALID
;
218 vmw_fifo_commit(dev_priv
, sizeof(*cmd
));
223 ret
= ttm_bo_reserve(bo
, false, true, NULL
);
226 vmw_bo_fence_single(bo
, NULL
);
227 ttm_bo_unreserve(bo
);
230 vmw_mob_destroy(otable
->page_table
);
231 otable
->page_table
= NULL
;
235 static int vmw_otable_batch_setup(struct vmw_private
*dev_priv
,
236 struct vmw_otable_batch
*batch
)
238 unsigned long offset
;
239 unsigned long bo_size
;
240 struct vmw_otable
*otables
= batch
->otables
;
241 struct ttm_operation_ctx ctx
= {
242 .interruptible
= false,
249 for (i
= 0; i
< batch
->num_otables
; ++i
) {
250 if (!otables
[i
].enabled
)
254 (otables
[i
].size
+ PAGE_SIZE
- 1) & PAGE_MASK
;
255 bo_size
+= otables
[i
].size
;
258 ret
= ttm_bo_create(&dev_priv
->bdev
, bo_size
,
260 &vmw_sys_ne_placement
,
261 0, false, &batch
->otable_bo
);
263 if (unlikely(ret
!= 0))
266 ret
= ttm_bo_reserve(batch
->otable_bo
, false, true, NULL
);
268 ret
= vmw_bo_driver
.ttm_tt_populate(batch
->otable_bo
->ttm
, &ctx
);
269 if (unlikely(ret
!= 0))
271 ret
= vmw_bo_map_dma(batch
->otable_bo
);
272 if (unlikely(ret
!= 0))
275 ttm_bo_unreserve(batch
->otable_bo
);
278 for (i
= 0; i
< batch
->num_otables
; ++i
) {
279 if (!batch
->otables
[i
].enabled
)
282 ret
= vmw_setup_otable_base(dev_priv
, i
, batch
->otable_bo
,
285 if (unlikely(ret
!= 0))
287 offset
+= otables
[i
].size
;
293 ttm_bo_unreserve(batch
->otable_bo
);
295 for (i
= 0; i
< batch
->num_otables
; ++i
) {
296 if (batch
->otables
[i
].enabled
)
297 vmw_takedown_otable_base(dev_priv
, i
,
301 ttm_bo_put(batch
->otable_bo
);
302 batch
->otable_bo
= NULL
;
308 * vmw_otables_setup - Set up guest backed memory object tables
310 * @dev_priv: Pointer to a device private structure
312 * Takes care of the device guest backed surface
313 * initialization, by setting up the guest backed memory object tables.
314 * Returns 0 on success and various error codes on failure. A successful return
315 * means the object tables can be taken down using the vmw_otables_takedown
318 int vmw_otables_setup(struct vmw_private
*dev_priv
)
320 struct vmw_otable
**otables
= &dev_priv
->otable_batch
.otables
;
323 if (dev_priv
->has_dx
) {
324 *otables
= kmemdup(dx_tables
, sizeof(dx_tables
), GFP_KERNEL
);
328 dev_priv
->otable_batch
.num_otables
= ARRAY_SIZE(dx_tables
);
330 *otables
= kmemdup(pre_dx_tables
, sizeof(pre_dx_tables
),
335 dev_priv
->otable_batch
.num_otables
= ARRAY_SIZE(pre_dx_tables
);
338 ret
= vmw_otable_batch_setup(dev_priv
, &dev_priv
->otable_batch
);
339 if (unlikely(ret
!= 0))
349 static void vmw_otable_batch_takedown(struct vmw_private
*dev_priv
,
350 struct vmw_otable_batch
*batch
)
353 struct ttm_buffer_object
*bo
= batch
->otable_bo
;
356 for (i
= 0; i
< batch
->num_otables
; ++i
)
357 if (batch
->otables
[i
].enabled
)
358 vmw_takedown_otable_base(dev_priv
, i
,
361 ret
= ttm_bo_reserve(bo
, false, true, NULL
);
364 vmw_bo_fence_single(bo
, NULL
);
365 ttm_bo_unreserve(bo
);
367 ttm_bo_put(batch
->otable_bo
);
368 batch
->otable_bo
= NULL
;
372 * vmw_otables_takedown - Take down guest backed memory object tables
374 * @dev_priv: Pointer to a device private structure
376 * Take down the Guest Memory Object tables.
378 void vmw_otables_takedown(struct vmw_private
*dev_priv
)
380 vmw_otable_batch_takedown(dev_priv
, &dev_priv
->otable_batch
);
381 kfree(dev_priv
->otable_batch
.otables
);
385 * vmw_mob_calculate_pt_pages - Calculate the number of page table pages
386 * needed for a guest backed memory object.
388 * @data_pages: Number of data pages in the memory object buffer.
390 static unsigned long vmw_mob_calculate_pt_pages(unsigned long data_pages
)
392 unsigned long data_size
= data_pages
* PAGE_SIZE
;
393 unsigned long tot_size
= 0;
395 while (likely(data_size
> PAGE_SIZE
)) {
396 data_size
= DIV_ROUND_UP(data_size
, PAGE_SIZE
);
397 data_size
*= VMW_PPN_SIZE
;
398 tot_size
+= (data_size
+ PAGE_SIZE
- 1) & PAGE_MASK
;
401 return tot_size
>> PAGE_SHIFT
;
405 * vmw_mob_create - Create a mob, but don't populate it.
407 * @data_pages: Number of data pages of the underlying buffer object.
409 struct vmw_mob
*vmw_mob_create(unsigned long data_pages
)
411 struct vmw_mob
*mob
= kzalloc(sizeof(*mob
), GFP_KERNEL
);
416 mob
->num_pages
= vmw_mob_calculate_pt_pages(data_pages
);
422 * vmw_mob_pt_populate - Populate the mob pagetable
424 * @mob: Pointer to the mob the pagetable of which we want to
427 * This function allocates memory to be used for the pagetable, and
428 * adjusts TTM memory accounting accordingly. Returns ENOMEM if
429 * memory resources aren't sufficient and may cause TTM buffer objects
430 * to be swapped out by using the TTM memory accounting function.
432 static int vmw_mob_pt_populate(struct vmw_private
*dev_priv
,
436 struct ttm_operation_ctx ctx
= {
437 .interruptible
= false,
441 BUG_ON(mob
->pt_bo
!= NULL
);
443 ret
= ttm_bo_create(&dev_priv
->bdev
, mob
->num_pages
* PAGE_SIZE
,
445 &vmw_sys_ne_placement
,
446 0, false, &mob
->pt_bo
);
447 if (unlikely(ret
!= 0))
450 ret
= ttm_bo_reserve(mob
->pt_bo
, false, true, NULL
);
453 ret
= vmw_bo_driver
.ttm_tt_populate(mob
->pt_bo
->ttm
, &ctx
);
454 if (unlikely(ret
!= 0))
456 ret
= vmw_bo_map_dma(mob
->pt_bo
);
457 if (unlikely(ret
!= 0))
460 ttm_bo_unreserve(mob
->pt_bo
);
465 ttm_bo_unreserve(mob
->pt_bo
);
466 ttm_bo_put(mob
->pt_bo
);
473 * vmw_mob_assign_ppn - Assign a value to a page table entry
475 * @addr: Pointer to pointer to page table entry.
476 * @val: The page table entry
478 * Assigns a value to a page table entry pointed to by *@addr and increments
479 * *@addr according to the page table entry size.
481 #if (VMW_PPN_SIZE == 8)
482 static void vmw_mob_assign_ppn(u32
**addr
, dma_addr_t val
)
484 *((u64
*) *addr
) = val
>> PAGE_SHIFT
;
488 static void vmw_mob_assign_ppn(u32
**addr
, dma_addr_t val
)
490 *(*addr
)++ = val
>> PAGE_SHIFT
;
495 * vmw_mob_build_pt - Build a pagetable
497 * @data_addr: Array of DMA addresses to the underlying buffer
498 * object's data pages.
499 * @num_data_pages: Number of buffer object data pages.
500 * @pt_pages: Array of page pointers to the page table pages.
502 * Returns the number of page table pages actually used.
503 * Uses atomic kmaps of highmem pages to avoid TLB thrashing.
505 static unsigned long vmw_mob_build_pt(struct vmw_piter
*data_iter
,
506 unsigned long num_data_pages
,
507 struct vmw_piter
*pt_iter
)
509 unsigned long pt_size
= num_data_pages
* VMW_PPN_SIZE
;
510 unsigned long num_pt_pages
= DIV_ROUND_UP(pt_size
, PAGE_SIZE
);
511 unsigned long pt_page
;
512 u32
*addr
, *save_addr
;
516 for (pt_page
= 0; pt_page
< num_pt_pages
; ++pt_page
) {
517 page
= vmw_piter_page(pt_iter
);
519 save_addr
= addr
= kmap_atomic(page
);
521 for (i
= 0; i
< PAGE_SIZE
/ VMW_PPN_SIZE
; ++i
) {
522 vmw_mob_assign_ppn(&addr
,
523 vmw_piter_dma_addr(data_iter
));
524 if (unlikely(--num_data_pages
== 0))
526 WARN_ON(!vmw_piter_next(data_iter
));
528 kunmap_atomic(save_addr
);
529 vmw_piter_next(pt_iter
);
536 * vmw_mob_build_pt - Set up a multilevel mob pagetable
538 * @mob: Pointer to a mob whose page table needs setting up.
539 * @data_addr Array of DMA addresses to the buffer object's data
541 * @num_data_pages: Number of buffer object data pages.
543 * Uses tail recursion to set up a multilevel mob page table.
545 static void vmw_mob_pt_setup(struct vmw_mob
*mob
,
546 struct vmw_piter data_iter
,
547 unsigned long num_data_pages
)
549 unsigned long num_pt_pages
= 0;
550 struct ttm_buffer_object
*bo
= mob
->pt_bo
;
551 struct vmw_piter save_pt_iter
;
552 struct vmw_piter pt_iter
;
553 const struct vmw_sg_table
*vsgt
;
556 ret
= ttm_bo_reserve(bo
, false, true, NULL
);
559 vsgt
= vmw_bo_sg_table(bo
);
560 vmw_piter_start(&pt_iter
, vsgt
, 0);
561 BUG_ON(!vmw_piter_next(&pt_iter
));
563 while (likely(num_data_pages
> 1)) {
565 BUG_ON(mob
->pt_level
> 2);
566 save_pt_iter
= pt_iter
;
567 num_pt_pages
= vmw_mob_build_pt(&data_iter
, num_data_pages
,
569 data_iter
= save_pt_iter
;
570 num_data_pages
= num_pt_pages
;
573 mob
->pt_root_page
= vmw_piter_dma_addr(&save_pt_iter
);
574 ttm_bo_unreserve(bo
);
578 * vmw_mob_destroy - Destroy a mob, unpopulating first if necessary.
580 * @mob: Pointer to a mob to destroy.
582 void vmw_mob_destroy(struct vmw_mob
*mob
)
585 ttm_bo_put(mob
->pt_bo
);
592 * vmw_mob_unbind - Hide a mob from the device.
594 * @dev_priv: Pointer to a device private.
595 * @mob_id: Device id of the mob to unbind.
597 void vmw_mob_unbind(struct vmw_private
*dev_priv
,
601 SVGA3dCmdHeader header
;
602 SVGA3dCmdDestroyGBMob body
;
605 struct ttm_buffer_object
*bo
= mob
->pt_bo
;
608 ret
= ttm_bo_reserve(bo
, false, true, NULL
);
610 * Noone else should be using this buffer.
615 cmd
= VMW_FIFO_RESERVE(dev_priv
, sizeof(*cmd
));
617 cmd
->header
.id
= SVGA_3D_CMD_DESTROY_GB_MOB
;
618 cmd
->header
.size
= sizeof(cmd
->body
);
619 cmd
->body
.mobid
= mob
->id
;
620 vmw_fifo_commit(dev_priv
, sizeof(*cmd
));
624 vmw_bo_fence_single(bo
, NULL
);
625 ttm_bo_unreserve(bo
);
627 vmw_fifo_resource_dec(dev_priv
);
631 * vmw_mob_bind - Make a mob visible to the device after first
632 * populating it if necessary.
634 * @dev_priv: Pointer to a device private.
635 * @mob: Pointer to the mob we're making visible.
636 * @data_addr: Array of DMA addresses to the data pages of the underlying
638 * @num_data_pages: Number of data pages of the underlying buffer
640 * @mob_id: Device id of the mob to bind
642 * This function is intended to be interfaced with the ttm_tt backend
645 int vmw_mob_bind(struct vmw_private
*dev_priv
,
647 const struct vmw_sg_table
*vsgt
,
648 unsigned long num_data_pages
,
652 bool pt_set_up
= false;
653 struct vmw_piter data_iter
;
655 SVGA3dCmdHeader header
;
656 SVGA3dCmdDefineGBMob64 body
;
660 vmw_piter_start(&data_iter
, vsgt
, 0);
661 if (unlikely(!vmw_piter_next(&data_iter
)))
664 if (likely(num_data_pages
== 1)) {
665 mob
->pt_level
= VMW_MOBFMT_PTDEPTH_0
;
666 mob
->pt_root_page
= vmw_piter_dma_addr(&data_iter
);
667 } else if (vsgt
->num_regions
== 1) {
668 mob
->pt_level
= SVGA3D_MOBFMT_RANGE
;
669 mob
->pt_root_page
= vmw_piter_dma_addr(&data_iter
);
670 } else if (unlikely(mob
->pt_bo
== NULL
)) {
671 ret
= vmw_mob_pt_populate(dev_priv
, mob
);
672 if (unlikely(ret
!= 0))
675 vmw_mob_pt_setup(mob
, data_iter
, num_data_pages
);
677 mob
->pt_level
+= VMW_MOBFMT_PTDEPTH_1
- SVGA3D_MOBFMT_PTDEPTH_1
;
680 vmw_fifo_resource_inc(dev_priv
);
682 cmd
= VMW_FIFO_RESERVE(dev_priv
, sizeof(*cmd
));
683 if (unlikely(cmd
== NULL
))
684 goto out_no_cmd_space
;
686 cmd
->header
.id
= SVGA_3D_CMD_DEFINE_GB_MOB64
;
687 cmd
->header
.size
= sizeof(cmd
->body
);
688 cmd
->body
.mobid
= mob_id
;
689 cmd
->body
.ptDepth
= mob
->pt_level
;
690 cmd
->body
.base
= mob
->pt_root_page
>> PAGE_SHIFT
;
691 cmd
->body
.sizeInBytes
= num_data_pages
* PAGE_SIZE
;
693 vmw_fifo_commit(dev_priv
, sizeof(*cmd
));
698 vmw_fifo_resource_dec(dev_priv
);
700 ttm_bo_put(mob
->pt_bo
);