1 /**************************************************************************
3 * Copyright (c) 2006-2009 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 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
31 * Copyright (c) 2013 The FreeBSD Foundation
32 * All rights reserved.
34 * Portions of this software were developed by Konstantin Belousov
35 * <kib@FreeBSD.org> under sponsorship from the FreeBSD Foundation.
37 * $FreeBSD: head/sys/dev/drm2/ttm/ttm_tt.c 251452 2013-06-06 06:17:20Z alc $
42 #include <linux/export.h>
43 #include <drm/ttm/ttm_module.h>
44 #include <drm/ttm/ttm_bo_driver.h>
45 #include <drm/ttm/ttm_placement.h>
46 #include <drm/ttm/ttm_page_alloc.h>
48 MALLOC_DEFINE(M_TTM_PD, "ttm_pd", "TTM Page Directories");
51 * Allocates storage for pointers to the pages that back the ttm.
53 static void ttm_tt_alloc_page_directory(struct ttm_tt *ttm)
55 ttm->pages = kmalloc(ttm->num_pages * sizeof(void *),
56 M_TTM_PD, M_WAITOK | M_ZERO);
59 static void ttm_dma_tt_alloc_page_directory(struct ttm_dma_tt *ttm)
61 ttm->ttm.pages = kmalloc(ttm->ttm.num_pages * sizeof(void *),
62 M_TTM_PD, M_WAITOK | M_ZERO);
63 ttm->dma_address = kmalloc(ttm->ttm.num_pages *
64 sizeof(*ttm->dma_address), M_TTM_PD, M_WAITOK);
67 static inline int ttm_tt_set_page_caching(vm_page_t p,
68 enum ttm_caching_state c_old,
69 enum ttm_caching_state c_new)
72 /* XXXKIB our VM does not need this. */
74 if (c_old != tt_cached) {
75 /* p isn't in the default caching state, set it to
76 * writeback first to free its current memtype. */
77 pmap_page_set_memattr(p, VM_MEMATTR_WRITE_BACK);
82 pmap_page_set_memattr(p, VM_MEMATTR_WRITE_COMBINING);
83 else if (c_new == tt_uncached)
84 pmap_page_set_memattr(p, VM_MEMATTR_UNCACHEABLE);
90 * Change caching policy for the linear kernel map
91 * for range of pages in a ttm.
94 static int ttm_tt_set_caching(struct ttm_tt *ttm,
95 enum ttm_caching_state c_state)
101 if (ttm->caching_state == c_state)
104 if (ttm->state == tt_unpopulated) {
105 /* Change caching but don't populate */
106 ttm->caching_state = c_state;
110 if (ttm->caching_state == tt_cached)
111 drm_clflush_pages(ttm->pages, ttm->num_pages);
113 for (i = 0; i < ttm->num_pages; ++i) {
114 cur_page = ttm->pages[i];
115 if (likely(cur_page != NULL)) {
116 ret = ttm_tt_set_page_caching(cur_page,
119 if (unlikely(ret != 0))
124 ttm->caching_state = c_state;
129 for (j = 0; j < i; ++j) {
130 cur_page = ttm->pages[j];
131 if (likely(cur_page != NULL)) {
132 (void)ttm_tt_set_page_caching(cur_page, c_state,
140 int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement)
142 enum ttm_caching_state state;
144 if (placement & TTM_PL_FLAG_WC)
146 else if (placement & TTM_PL_FLAG_UNCACHED)
151 return ttm_tt_set_caching(ttm, state);
153 EXPORT_SYMBOL(ttm_tt_set_placement_caching);
155 void ttm_tt_destroy(struct ttm_tt *ttm)
157 if (unlikely(ttm == NULL))
160 if (ttm->state == tt_bound) {
164 if (likely(ttm->pages != NULL)) {
165 ttm->bdev->driver->ttm_tt_unpopulate(ttm);
168 if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP) &&
170 vm_object_deallocate(ttm->swap_storage);
172 ttm->swap_storage = NULL;
173 ttm->func->destroy(ttm);
176 int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev,
177 unsigned long size, uint32_t page_flags,
178 vm_page_t dummy_read_page)
181 ttm->glob = bdev->glob;
182 ttm->num_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
183 ttm->caching_state = tt_cached;
184 ttm->page_flags = page_flags;
185 ttm->dummy_read_page = dummy_read_page;
186 ttm->state = tt_unpopulated;
187 ttm->swap_storage = NULL;
189 ttm_tt_alloc_page_directory(ttm);
192 kprintf("Failed allocating page table\n");
197 EXPORT_SYMBOL(ttm_tt_init);
199 void ttm_tt_fini(struct ttm_tt *ttm)
201 drm_free(ttm->pages, M_TTM_PD);
204 EXPORT_SYMBOL(ttm_tt_fini);
206 int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev,
207 unsigned long size, uint32_t page_flags,
208 vm_page_t dummy_read_page)
210 struct ttm_tt *ttm = &ttm_dma->ttm;
213 ttm->glob = bdev->glob;
214 ttm->num_pages = (size + PAGE_SIZE - 1) >> PAGE_SHIFT;
215 ttm->caching_state = tt_cached;
216 ttm->page_flags = page_flags;
217 ttm->dummy_read_page = dummy_read_page;
218 ttm->state = tt_unpopulated;
219 ttm->swap_storage = NULL;
221 INIT_LIST_HEAD(&ttm_dma->pages_list);
222 ttm_dma_tt_alloc_page_directory(ttm_dma);
223 if (!ttm->pages || !ttm_dma->dma_address) {
225 kprintf("Failed allocating page table\n");
230 EXPORT_SYMBOL(ttm_dma_tt_init);
232 void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma)
234 struct ttm_tt *ttm = &ttm_dma->ttm;
236 drm_free(ttm->pages, M_TTM_PD);
238 drm_free(ttm_dma->dma_address, M_TTM_PD);
239 ttm_dma->dma_address = NULL;
241 EXPORT_SYMBOL(ttm_dma_tt_fini);
243 void ttm_tt_unbind(struct ttm_tt *ttm)
247 if (ttm->state == tt_bound) {
248 ret = ttm->func->unbind(ttm);
250 ttm->state = tt_unbound;
254 int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem)
261 if (ttm->state == tt_bound)
264 ret = ttm->bdev->driver->ttm_tt_populate(ttm);
268 ret = ttm->func->bind(ttm, bo_mem);
269 if (unlikely(ret != 0))
272 ttm->state = tt_bound;
276 EXPORT_SYMBOL(ttm_tt_bind);
278 int ttm_tt_swapin(struct ttm_tt *ttm)
281 vm_page_t from_page, to_page;
284 obj = ttm->swap_storage;
286 VM_OBJECT_WLOCK(obj);
287 vm_object_pip_add(obj, 1);
288 for (i = 0; i < ttm->num_pages; ++i) {
289 from_page = vm_page_grab(obj, i, VM_ALLOC_NORMAL |
291 if (from_page->valid != VM_PAGE_BITS_ALL) {
292 if (vm_pager_has_page(obj, i)) {
293 rv = vm_pager_get_page(obj, &from_page, 1);
294 if (rv != VM_PAGER_OK) {
295 vm_page_free(from_page);
300 vm_page_zero_invalid(from_page, TRUE);
303 to_page = ttm->pages[i];
304 if (unlikely(to_page == NULL)) {
306 vm_page_wakeup(from_page);
309 pmap_copy_page(VM_PAGE_TO_PHYS(from_page),
310 VM_PAGE_TO_PHYS(to_page));
311 vm_page_wakeup(from_page);
313 vm_object_pip_wakeup(obj);
314 VM_OBJECT_WUNLOCK(obj);
316 if (!(ttm->page_flags & TTM_PAGE_FLAG_PERSISTENT_SWAP))
317 vm_object_deallocate(obj);
318 ttm->swap_storage = NULL;
319 ttm->page_flags &= ~TTM_PAGE_FLAG_SWAPPED;
323 vm_object_pip_wakeup(obj);
324 VM_OBJECT_WUNLOCK(obj);
328 int ttm_tt_swapout(struct ttm_tt *ttm, vm_object_t persistent_swap_storage)
331 vm_page_t from_page, to_page;
334 BUG_ON(ttm->state != tt_unbound && ttm->state != tt_unpopulated);
335 BUG_ON(ttm->caching_state != tt_cached);
337 if (!persistent_swap_storage) {
338 obj = swap_pager_alloc(NULL,
339 IDX_TO_OFF(ttm->num_pages), VM_PROT_DEFAULT, 0);
341 kprintf("[TTM] Failed allocating swap storage\n");
345 obj = persistent_swap_storage;
347 VM_OBJECT_WLOCK(obj);
348 vm_object_pip_add(obj, 1);
349 for (i = 0; i < ttm->num_pages; ++i) {
350 from_page = ttm->pages[i];
351 if (unlikely(from_page == NULL))
353 to_page = vm_page_grab(obj, i, VM_ALLOC_NORMAL |
355 pmap_copy_page(VM_PAGE_TO_PHYS(from_page),
356 VM_PAGE_TO_PHYS(to_page));
357 to_page->valid = VM_PAGE_BITS_ALL;
358 vm_page_dirty(to_page);
359 vm_page_wakeup(to_page);
361 vm_object_pip_wakeup(obj);
362 VM_OBJECT_WUNLOCK(obj);
364 ttm->bdev->driver->ttm_tt_unpopulate(ttm);
365 ttm->swap_storage = obj;
366 ttm->page_flags |= TTM_PAGE_FLAG_SWAPPED;
367 if (persistent_swap_storage)
368 ttm->page_flags |= TTM_PAGE_FLAG_PERSISTENT_SWAP;