1 /**************************************************************************
3 * Copyright © 2012 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.
72 struct vmw_mob *page_table;
75 static int vmw_mob_pt_populate(struct vmw_private *dev_priv,
77 static void vmw_mob_pt_setup(struct vmw_mob *mob,
78 struct vmw_piter data_iter,
79 unsigned long num_data_pages);
82 * vmw_setup_otable_base - Issue an object table base setup command to
85 * @dev_priv: Pointer to a device private structure
86 * @type: Type of object table base
87 * @offset Start of table offset into dev_priv::otable_bo
88 * @otable Pointer to otable metadata;
90 * This function returns -ENOMEM if it fails to reserve fifo space,
91 * and may block waiting for fifo space.
93 static int vmw_setup_otable_base(struct vmw_private *dev_priv,
96 struct vmw_otable *otable)
99 SVGA3dCmdHeader header;
100 SVGA3dCmdSetOTableBase64 body;
103 const struct vmw_sg_table *vsgt;
104 struct vmw_piter iter;
107 BUG_ON(otable->page_table != NULL);
109 vsgt = vmw_bo_sg_table(dev_priv->otable_bo);
110 vmw_piter_start(&iter, vsgt, offset >> PAGE_SHIFT);
111 WARN_ON(!vmw_piter_next(&iter));
113 mob = vmw_mob_create(otable->size >> PAGE_SHIFT);
114 if (unlikely(mob == NULL)) {
115 DRM_ERROR("Failed creating OTable page table.\n");
119 if (otable->size <= PAGE_SIZE) {
120 mob->pt_level = VMW_MOBFMT_PTDEPTH_0;
121 mob->pt_root_page = vmw_piter_dma_addr(&iter);
122 } else if (vsgt->num_regions == 1) {
123 mob->pt_level = SVGA3D_MOBFMT_RANGE;
124 mob->pt_root_page = vmw_piter_dma_addr(&iter);
126 ret = vmw_mob_pt_populate(dev_priv, mob);
127 if (unlikely(ret != 0))
128 goto out_no_populate;
130 vmw_mob_pt_setup(mob, iter, otable->size >> PAGE_SHIFT);
131 mob->pt_level += VMW_MOBFMT_PTDEPTH_1 - SVGA3D_MOBFMT_PTDEPTH_1;
134 cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
135 if (unlikely(cmd == NULL)) {
136 DRM_ERROR("Failed reserving FIFO space for OTable setup.\n");
140 memset(cmd, 0, sizeof(*cmd));
141 cmd->header.id = SVGA_3D_CMD_SET_OTABLE_BASE64;
142 cmd->header.size = sizeof(cmd->body);
143 cmd->body.type = type;
144 cmd->body.baseAddress = cpu_to_le64(mob->pt_root_page >> PAGE_SHIFT);
145 cmd->body.sizeInBytes = otable->size;
146 cmd->body.validSizeInBytes = 0;
147 cmd->body.ptDepth = mob->pt_level;
150 * The device doesn't support this, But the otable size is
151 * determined at compile-time, so this BUG shouldn't trigger
154 BUG_ON(mob->pt_level == VMW_MOBFMT_PTDEPTH_2);
156 vmw_fifo_commit(dev_priv, sizeof(*cmd));
157 otable->page_table = mob;
163 vmw_mob_destroy(mob);
168 * vmw_takedown_otable_base - Issue an object table base takedown command
171 * @dev_priv: Pointer to a device private structure
172 * @type: Type of object table base
175 static void vmw_takedown_otable_base(struct vmw_private *dev_priv,
177 struct vmw_otable *otable)
180 SVGA3dCmdHeader header;
181 SVGA3dCmdSetOTableBase body;
183 struct ttm_buffer_object *bo;
185 if (otable->page_table == NULL)
188 bo = otable->page_table->pt_bo;
189 cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
190 if (unlikely(cmd == NULL))
191 DRM_ERROR("Failed reserving FIFO space for OTable setup.\n");
193 memset(cmd, 0, sizeof(*cmd));
194 cmd->header.id = SVGA_3D_CMD_SET_OTABLE_BASE;
195 cmd->header.size = sizeof(cmd->body);
196 cmd->body.type = type;
197 cmd->body.baseAddress = 0;
198 cmd->body.sizeInBytes = 0;
199 cmd->body.validSizeInBytes = 0;
200 cmd->body.ptDepth = SVGA3D_MOBFMT_INVALID;
201 vmw_fifo_commit(dev_priv, sizeof(*cmd));
206 ret = ttm_bo_reserve(bo, false, true, false, NULL);
209 vmw_fence_single_bo(bo, NULL);
210 ttm_bo_unreserve(bo);
213 vmw_mob_destroy(otable->page_table);
214 otable->page_table = NULL;
218 * vmw_otables_setup - Set up guest backed memory object tables
220 * @dev_priv: Pointer to a device private structure
222 * Takes care of the device guest backed surface
223 * initialization, by setting up the guest backed memory object tables.
224 * Returns 0 on success and various error codes on failure. A succesful return
225 * means the object tables can be taken down using the vmw_otables_takedown
228 int vmw_otables_setup(struct vmw_private *dev_priv)
230 unsigned long offset;
231 unsigned long bo_size;
232 struct vmw_otable *otables;
236 otables = kzalloc(SVGA_OTABLE_DX9_MAX * sizeof(*otables),
238 if (unlikely(otables == NULL)) {
239 DRM_ERROR("Failed to allocate space for otable "
244 otables[SVGA_OTABLE_MOB].size =
245 VMWGFX_NUM_MOB * SVGA3D_OTABLE_MOB_ENTRY_SIZE;
246 otables[SVGA_OTABLE_SURFACE].size =
247 VMWGFX_NUM_GB_SURFACE * SVGA3D_OTABLE_SURFACE_ENTRY_SIZE;
248 otables[SVGA_OTABLE_CONTEXT].size =
249 VMWGFX_NUM_GB_CONTEXT * SVGA3D_OTABLE_CONTEXT_ENTRY_SIZE;
250 otables[SVGA_OTABLE_SHADER].size =
251 VMWGFX_NUM_GB_SHADER * SVGA3D_OTABLE_SHADER_ENTRY_SIZE;
252 otables[SVGA_OTABLE_SCREEN_TARGET].size =
253 VMWGFX_NUM_GB_SCREEN_TARGET *
254 SVGA3D_OTABLE_SCREEN_TARGET_ENTRY_SIZE;
257 for (i = 0; i < SVGA_OTABLE_DX9_MAX; ++i) {
259 (otables[i].size + PAGE_SIZE - 1) & PAGE_MASK;
260 bo_size += otables[i].size;
263 ret = ttm_bo_create(&dev_priv->bdev, bo_size,
265 &vmw_sys_ne_placement,
267 &dev_priv->otable_bo);
269 if (unlikely(ret != 0))
272 ret = ttm_bo_reserve(dev_priv->otable_bo, false, true, false, NULL);
274 ret = vmw_bo_driver.ttm_tt_populate(dev_priv->otable_bo->ttm);
275 if (unlikely(ret != 0))
277 ret = vmw_bo_map_dma(dev_priv->otable_bo);
278 if (unlikely(ret != 0))
281 ttm_bo_unreserve(dev_priv->otable_bo);
284 for (i = 0; i < SVGA_OTABLE_DX9_MAX - VMW_OTABLE_SETUP_SUB; ++i) {
285 ret = vmw_setup_otable_base(dev_priv, i, offset,
287 if (unlikely(ret != 0))
289 offset += otables[i].size;
292 dev_priv->otables = otables;
296 ttm_bo_unreserve(dev_priv->otable_bo);
298 for (i = 0; i < SVGA_OTABLE_DX9_MAX - VMW_OTABLE_SETUP_SUB; ++i)
299 vmw_takedown_otable_base(dev_priv, i, &otables[i]);
301 ttm_bo_unref(&dev_priv->otable_bo);
309 * vmw_otables_takedown - Take down guest backed memory object tables
311 * @dev_priv: Pointer to a device private structure
313 * Take down the Guest Memory Object tables.
315 void vmw_otables_takedown(struct vmw_private *dev_priv)
318 struct ttm_buffer_object *bo = dev_priv->otable_bo;
321 for (i = 0; i < SVGA_OTABLE_DX9_MAX - VMW_OTABLE_SETUP_SUB; ++i)
322 vmw_takedown_otable_base(dev_priv, i,
323 &dev_priv->otables[i]);
325 ret = ttm_bo_reserve(bo, false, true, false, NULL);
328 vmw_fence_single_bo(bo, NULL);
329 ttm_bo_unreserve(bo);
331 ttm_bo_unref(&dev_priv->otable_bo);
332 kfree(dev_priv->otables);
333 dev_priv->otables = NULL;
338 * vmw_mob_calculate_pt_pages - Calculate the number of page table pages
339 * needed for a guest backed memory object.
341 * @data_pages: Number of data pages in the memory object buffer.
343 static unsigned long vmw_mob_calculate_pt_pages(unsigned long data_pages)
345 unsigned long data_size = data_pages * PAGE_SIZE;
346 unsigned long tot_size = 0;
348 while (likely(data_size > PAGE_SIZE)) {
349 data_size = DIV_ROUND_UP(data_size, PAGE_SIZE);
350 data_size *= VMW_PPN_SIZE;
351 tot_size += (data_size + PAGE_SIZE - 1) & PAGE_MASK;
354 return tot_size >> PAGE_SHIFT;
358 * vmw_mob_create - Create a mob, but don't populate it.
360 * @data_pages: Number of data pages of the underlying buffer object.
362 struct vmw_mob *vmw_mob_create(unsigned long data_pages)
364 struct vmw_mob *mob = kzalloc(sizeof(*mob), GFP_KERNEL);
366 if (unlikely(mob == NULL))
369 mob->num_pages = vmw_mob_calculate_pt_pages(data_pages);
375 * vmw_mob_pt_populate - Populate the mob pagetable
377 * @mob: Pointer to the mob the pagetable of which we want to
380 * This function allocates memory to be used for the pagetable, and
381 * adjusts TTM memory accounting accordingly. Returns ENOMEM if
382 * memory resources aren't sufficient and may cause TTM buffer objects
383 * to be swapped out by using the TTM memory accounting function.
385 static int vmw_mob_pt_populate(struct vmw_private *dev_priv,
389 BUG_ON(mob->pt_bo != NULL);
391 ret = ttm_bo_create(&dev_priv->bdev, mob->num_pages * PAGE_SIZE,
393 &vmw_sys_ne_placement,
394 0, false, NULL, &mob->pt_bo);
395 if (unlikely(ret != 0))
398 ret = ttm_bo_reserve(mob->pt_bo, false, true, false, NULL);
401 ret = vmw_bo_driver.ttm_tt_populate(mob->pt_bo->ttm);
402 if (unlikely(ret != 0))
404 ret = vmw_bo_map_dma(mob->pt_bo);
405 if (unlikely(ret != 0))
408 ttm_bo_unreserve(mob->pt_bo);
413 ttm_bo_unreserve(mob->pt_bo);
414 ttm_bo_unref(&mob->pt_bo);
420 * vmw_mob_assign_ppn - Assign a value to a page table entry
422 * @addr: Pointer to pointer to page table entry.
423 * @val: The page table entry
425 * Assigns a value to a page table entry pointed to by *@addr and increments
426 * *@addr according to the page table entry size.
428 #if (VMW_PPN_SIZE == 8)
429 static void vmw_mob_assign_ppn(__le32 **addr, dma_addr_t val)
431 *((__le64 *) *addr) = cpu_to_le64(val >> PAGE_SHIFT);
435 static void vmw_mob_assign_ppn(__le32 **addr, dma_addr_t val)
437 *(*addr)++ = cpu_to_le32(val >> PAGE_SHIFT);
442 * vmw_mob_build_pt - Build a pagetable
444 * @data_addr: Array of DMA addresses to the underlying buffer
445 * object's data pages.
446 * @num_data_pages: Number of buffer object data pages.
447 * @pt_pages: Array of page pointers to the page table pages.
449 * Returns the number of page table pages actually used.
450 * Uses atomic kmaps of highmem pages to avoid TLB thrashing.
452 static unsigned long vmw_mob_build_pt(struct vmw_piter *data_iter,
453 unsigned long num_data_pages,
454 struct vmw_piter *pt_iter)
456 unsigned long pt_size = num_data_pages * VMW_PPN_SIZE;
457 unsigned long num_pt_pages = DIV_ROUND_UP(pt_size, PAGE_SIZE);
458 unsigned long pt_page;
459 __le32 *addr, *save_addr;
463 for (pt_page = 0; pt_page < num_pt_pages; ++pt_page) {
464 page = vmw_piter_page(pt_iter);
466 save_addr = addr = kmap_atomic(page);
468 for (i = 0; i < PAGE_SIZE / VMW_PPN_SIZE; ++i) {
469 vmw_mob_assign_ppn(&addr,
470 vmw_piter_dma_addr(data_iter));
471 if (unlikely(--num_data_pages == 0))
473 WARN_ON(!vmw_piter_next(data_iter));
475 kunmap_atomic(save_addr);
476 vmw_piter_next(pt_iter);
483 * vmw_mob_build_pt - Set up a multilevel mob pagetable
485 * @mob: Pointer to a mob whose page table needs setting up.
486 * @data_addr Array of DMA addresses to the buffer object's data
488 * @num_data_pages: Number of buffer object data pages.
490 * Uses tail recursion to set up a multilevel mob page table.
492 static void vmw_mob_pt_setup(struct vmw_mob *mob,
493 struct vmw_piter data_iter,
494 unsigned long num_data_pages)
496 unsigned long num_pt_pages = 0;
497 struct ttm_buffer_object *bo = mob->pt_bo;
498 struct vmw_piter save_pt_iter;
499 struct vmw_piter pt_iter;
500 const struct vmw_sg_table *vsgt;
503 ret = ttm_bo_reserve(bo, false, true, false, NULL);
506 vsgt = vmw_bo_sg_table(bo);
507 vmw_piter_start(&pt_iter, vsgt, 0);
508 BUG_ON(!vmw_piter_next(&pt_iter));
510 while (likely(num_data_pages > 1)) {
512 BUG_ON(mob->pt_level > 2);
513 save_pt_iter = pt_iter;
514 num_pt_pages = vmw_mob_build_pt(&data_iter, num_data_pages,
516 data_iter = save_pt_iter;
517 num_data_pages = num_pt_pages;
520 mob->pt_root_page = vmw_piter_dma_addr(&save_pt_iter);
521 ttm_bo_unreserve(bo);
525 * vmw_mob_destroy - Destroy a mob, unpopulating first if necessary.
527 * @mob: Pointer to a mob to destroy.
529 void vmw_mob_destroy(struct vmw_mob *mob)
532 ttm_bo_unref(&mob->pt_bo);
537 * vmw_mob_unbind - Hide a mob from the device.
539 * @dev_priv: Pointer to a device private.
540 * @mob_id: Device id of the mob to unbind.
542 void vmw_mob_unbind(struct vmw_private *dev_priv,
546 SVGA3dCmdHeader header;
547 SVGA3dCmdDestroyGBMob body;
550 struct ttm_buffer_object *bo = mob->pt_bo;
553 ret = ttm_bo_reserve(bo, false, true, false, NULL);
555 * Noone else should be using this buffer.
560 cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
561 if (unlikely(cmd == NULL)) {
562 DRM_ERROR("Failed reserving FIFO space for Memory "
563 "Object unbinding.\n");
565 cmd->header.id = SVGA_3D_CMD_DESTROY_GB_MOB;
566 cmd->header.size = sizeof(cmd->body);
567 cmd->body.mobid = mob->id;
568 vmw_fifo_commit(dev_priv, sizeof(*cmd));
570 vmw_fence_single_bo(bo, NULL);
571 ttm_bo_unreserve(bo);
573 vmw_3d_resource_dec(dev_priv, false);
577 * vmw_mob_bind - Make a mob visible to the device after first
578 * populating it if necessary.
580 * @dev_priv: Pointer to a device private.
581 * @mob: Pointer to the mob we're making visible.
582 * @data_addr: Array of DMA addresses to the data pages of the underlying
584 * @num_data_pages: Number of data pages of the underlying buffer
586 * @mob_id: Device id of the mob to bind
588 * This function is intended to be interfaced with the ttm_tt backend
591 int vmw_mob_bind(struct vmw_private *dev_priv,
593 const struct vmw_sg_table *vsgt,
594 unsigned long num_data_pages,
598 bool pt_set_up = false;
599 struct vmw_piter data_iter;
601 SVGA3dCmdHeader header;
602 SVGA3dCmdDefineGBMob64 body;
606 vmw_piter_start(&data_iter, vsgt, 0);
607 if (unlikely(!vmw_piter_next(&data_iter)))
610 if (likely(num_data_pages == 1)) {
611 mob->pt_level = VMW_MOBFMT_PTDEPTH_0;
612 mob->pt_root_page = vmw_piter_dma_addr(&data_iter);
613 } else if (vsgt->num_regions == 1) {
614 mob->pt_level = SVGA3D_MOBFMT_RANGE;
615 mob->pt_root_page = vmw_piter_dma_addr(&data_iter);
616 } else if (unlikely(mob->pt_bo == NULL)) {
617 ret = vmw_mob_pt_populate(dev_priv, mob);
618 if (unlikely(ret != 0))
621 vmw_mob_pt_setup(mob, data_iter, num_data_pages);
623 mob->pt_level += VMW_MOBFMT_PTDEPTH_1 - SVGA3D_MOBFMT_PTDEPTH_1;
626 (void) vmw_3d_resource_inc(dev_priv, false);
628 cmd = vmw_fifo_reserve(dev_priv, sizeof(*cmd));
629 if (unlikely(cmd == NULL)) {
630 DRM_ERROR("Failed reserving FIFO space for Memory "
631 "Object binding.\n");
632 goto out_no_cmd_space;
635 cmd->header.id = SVGA_3D_CMD_DEFINE_GB_MOB64;
636 cmd->header.size = sizeof(cmd->body);
637 cmd->body.mobid = mob_id;
638 cmd->body.ptDepth = mob->pt_level;
639 cmd->body.base = cpu_to_le64(mob->pt_root_page >> PAGE_SHIFT);
640 cmd->body.sizeInBytes = num_data_pages * PAGE_SIZE;
642 vmw_fifo_commit(dev_priv, sizeof(*cmd));
647 vmw_3d_resource_dec(dev_priv, false);
649 ttm_bo_unref(&mob->pt_bo);