xref: /openbmc/linux/drivers/gpu/drm/drm_scatter.c (revision fa5386459f06dc3b9181d4c954f980b127d1a32f)
1c0e09200SDave Airlie /**
2c0e09200SDave Airlie  * \file drm_scatter.c
3c0e09200SDave Airlie  * IOCTLs to manage scatter/gather memory
4c0e09200SDave Airlie  *
5c0e09200SDave Airlie  * \author Gareth Hughes <gareth@valinux.com>
6c0e09200SDave Airlie  */
7c0e09200SDave Airlie 
8c0e09200SDave Airlie /*
9c0e09200SDave Airlie  * Created: Mon Dec 18 23:20:54 2000 by gareth@valinux.com
10c0e09200SDave Airlie  *
11c0e09200SDave Airlie  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12c0e09200SDave Airlie  * All Rights Reserved.
13c0e09200SDave Airlie  *
14c0e09200SDave Airlie  * Permission is hereby granted, free of charge, to any person obtaining a
15c0e09200SDave Airlie  * copy of this software and associated documentation files (the "Software"),
16c0e09200SDave Airlie  * to deal in the Software without restriction, including without limitation
17c0e09200SDave Airlie  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
18c0e09200SDave Airlie  * and/or sell copies of the Software, and to permit persons to whom the
19c0e09200SDave Airlie  * Software is furnished to do so, subject to the following conditions:
20c0e09200SDave Airlie  *
21c0e09200SDave Airlie  * The above copyright notice and this permission notice (including the next
22c0e09200SDave Airlie  * paragraph) shall be included in all copies or substantial portions of the
23c0e09200SDave Airlie  * Software.
24c0e09200SDave Airlie  *
25c0e09200SDave Airlie  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26c0e09200SDave Airlie  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27c0e09200SDave Airlie  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
28c0e09200SDave Airlie  * PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
29c0e09200SDave Airlie  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
30c0e09200SDave Airlie  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
31c0e09200SDave Airlie  * DEALINGS IN THE SOFTWARE.
32c0e09200SDave Airlie  */
33c0e09200SDave Airlie 
34c0e09200SDave Airlie #include <linux/vmalloc.h>
355a0e3ad6STejun Heo #include <linux/slab.h>
36760285e7SDavid Howells #include <drm/drmP.h>
379ec4e2ffSDaniel Vetter #include "drm_legacy.h"
38c0e09200SDave Airlie 
39c0e09200SDave Airlie #define DEBUG_SCATTER 0
40c0e09200SDave Airlie 
41c0e09200SDave Airlie static inline void *drm_vmalloc_dma(unsigned long size)
42c0e09200SDave Airlie {
43c0e09200SDave Airlie #if defined(__powerpc__) && defined(CONFIG_NOT_COHERENT_CACHE)
4437035e74SBenjamin Herrenschmidt 	return __vmalloc(size, GFP_KERNEL, pgprot_noncached_wc(PAGE_KERNEL));
45c0e09200SDave Airlie #else
46c0e09200SDave Airlie 	return vmalloc_32(size);
47c0e09200SDave Airlie #endif
48c0e09200SDave Airlie }
49c0e09200SDave Airlie 
503d914e83SDaniel Vetter static void drm_sg_cleanup(struct drm_sg_mem * entry)
51c0e09200SDave Airlie {
52c0e09200SDave Airlie 	struct page *page;
53c0e09200SDave Airlie 	int i;
54c0e09200SDave Airlie 
55c0e09200SDave Airlie 	for (i = 0; i < entry->pages; i++) {
56c0e09200SDave Airlie 		page = entry->pagelist[i];
57c0e09200SDave Airlie 		if (page)
58c0e09200SDave Airlie 			ClearPageReserved(page);
59c0e09200SDave Airlie 	}
60c0e09200SDave Airlie 
61c0e09200SDave Airlie 	vfree(entry->virtual);
62c0e09200SDave Airlie 
639a298b2aSEric Anholt 	kfree(entry->busaddr);
649a298b2aSEric Anholt 	kfree(entry->pagelist);
659a298b2aSEric Anholt 	kfree(entry);
66c0e09200SDave Airlie }
67c0e09200SDave Airlie 
683d914e83SDaniel Vetter void drm_legacy_sg_cleanup(struct drm_device *dev)
693d914e83SDaniel Vetter {
703d914e83SDaniel Vetter 	if (drm_core_check_feature(dev, DRIVER_SG) && dev->sg &&
71*fa538645SDaniel Vetter 	    drm_core_check_feature(dev, DRIVER_LEGACY)) {
723d914e83SDaniel Vetter 		drm_sg_cleanup(dev->sg);
733d914e83SDaniel Vetter 		dev->sg = NULL;
743d914e83SDaniel Vetter 	}
753d914e83SDaniel Vetter }
76c0e09200SDave Airlie #ifdef _LP64
77c0e09200SDave Airlie # define ScatterHandle(x) (unsigned int)((x >> 32) + (x & ((1L << 32) - 1)))
78c0e09200SDave Airlie #else
79c0e09200SDave Airlie # define ScatterHandle(x) (unsigned int)(x)
80c0e09200SDave Airlie #endif
81c0e09200SDave Airlie 
829ec4e2ffSDaniel Vetter int drm_legacy_sg_alloc(struct drm_device *dev, void *data,
831d8d29cfSDaniel Vetter 			struct drm_file *file_priv)
84c0e09200SDave Airlie {
851d8d29cfSDaniel Vetter 	struct drm_scatter_gather *request = data;
86c0e09200SDave Airlie 	struct drm_sg_mem *entry;
87c0e09200SDave Airlie 	unsigned long pages, i, j;
88c0e09200SDave Airlie 
89c0e09200SDave Airlie 	DRM_DEBUG("\n");
90c0e09200SDave Airlie 
91*fa538645SDaniel Vetter 	if (!drm_core_check_feature(dev, DRIVER_LEGACY))
928e194bbfSDaniel Vetter 		return -EINVAL;
938e194bbfSDaniel Vetter 
94c0e09200SDave Airlie 	if (!drm_core_check_feature(dev, DRIVER_SG))
95c0e09200SDave Airlie 		return -EINVAL;
96c0e09200SDave Airlie 
97c0e09200SDave Airlie 	if (dev->sg)
98c0e09200SDave Airlie 		return -EINVAL;
99c0e09200SDave Airlie 
100f35119d6SRakib Mullick 	entry = kzalloc(sizeof(*entry), GFP_KERNEL);
101c0e09200SDave Airlie 	if (!entry)
102c0e09200SDave Airlie 		return -ENOMEM;
103c0e09200SDave Airlie 
104c0e09200SDave Airlie 	pages = (request->size + PAGE_SIZE - 1) / PAGE_SIZE;
105c0e09200SDave Airlie 	DRM_DEBUG("size=%ld pages=%ld\n", request->size, pages);
106c0e09200SDave Airlie 
107c0e09200SDave Airlie 	entry->pages = pages;
108f35119d6SRakib Mullick 	entry->pagelist = kcalloc(pages, sizeof(*entry->pagelist), GFP_KERNEL);
109c0e09200SDave Airlie 	if (!entry->pagelist) {
1109a298b2aSEric Anholt 		kfree(entry);
111c0e09200SDave Airlie 		return -ENOMEM;
112c0e09200SDave Airlie 	}
113c0e09200SDave Airlie 
114f35119d6SRakib Mullick 	entry->busaddr = kcalloc(pages, sizeof(*entry->busaddr), GFP_KERNEL);
115c0e09200SDave Airlie 	if (!entry->busaddr) {
1169a298b2aSEric Anholt 		kfree(entry->pagelist);
1179a298b2aSEric Anholt 		kfree(entry);
118c0e09200SDave Airlie 		return -ENOMEM;
119c0e09200SDave Airlie 	}
120c0e09200SDave Airlie 
121c0e09200SDave Airlie 	entry->virtual = drm_vmalloc_dma(pages << PAGE_SHIFT);
122c0e09200SDave Airlie 	if (!entry->virtual) {
1239a298b2aSEric Anholt 		kfree(entry->busaddr);
1249a298b2aSEric Anholt 		kfree(entry->pagelist);
1259a298b2aSEric Anholt 		kfree(entry);
126c0e09200SDave Airlie 		return -ENOMEM;
127c0e09200SDave Airlie 	}
128c0e09200SDave Airlie 
129c0e09200SDave Airlie 	/* This also forces the mapping of COW pages, so our page list
130c0e09200SDave Airlie 	 * will be valid.  Please don't remove it...
131c0e09200SDave Airlie 	 */
132c0e09200SDave Airlie 	memset(entry->virtual, 0, pages << PAGE_SHIFT);
133c0e09200SDave Airlie 
134c0e09200SDave Airlie 	entry->handle = ScatterHandle((unsigned long)entry->virtual);
135c0e09200SDave Airlie 
136c0e09200SDave Airlie 	DRM_DEBUG("handle  = %08lx\n", entry->handle);
137c0e09200SDave Airlie 	DRM_DEBUG("virtual = %p\n", entry->virtual);
138c0e09200SDave Airlie 
139c0e09200SDave Airlie 	for (i = (unsigned long)entry->virtual, j = 0; j < pages;
140c0e09200SDave Airlie 	     i += PAGE_SIZE, j++) {
141c0e09200SDave Airlie 		entry->pagelist[j] = vmalloc_to_page((void *)i);
142c0e09200SDave Airlie 		if (!entry->pagelist[j])
143c0e09200SDave Airlie 			goto failed;
144c0e09200SDave Airlie 		SetPageReserved(entry->pagelist[j]);
145c0e09200SDave Airlie 	}
146c0e09200SDave Airlie 
147c0e09200SDave Airlie 	request->handle = entry->handle;
148c0e09200SDave Airlie 
149c0e09200SDave Airlie 	dev->sg = entry;
150c0e09200SDave Airlie 
151c0e09200SDave Airlie #if DEBUG_SCATTER
152c0e09200SDave Airlie 	/* Verify that each page points to its virtual address, and vice
153c0e09200SDave Airlie 	 * versa.
154c0e09200SDave Airlie 	 */
155c0e09200SDave Airlie 	{
156c0e09200SDave Airlie 		int error = 0;
157c0e09200SDave Airlie 
158c0e09200SDave Airlie 		for (i = 0; i < pages; i++) {
159c0e09200SDave Airlie 			unsigned long *tmp;
160c0e09200SDave Airlie 
161c0e09200SDave Airlie 			tmp = page_address(entry->pagelist[i]);
162c0e09200SDave Airlie 			for (j = 0;
163c0e09200SDave Airlie 			     j < PAGE_SIZE / sizeof(unsigned long);
164c0e09200SDave Airlie 			     j++, tmp++) {
165c0e09200SDave Airlie 				*tmp = 0xcafebabe;
166c0e09200SDave Airlie 			}
167c0e09200SDave Airlie 			tmp = (unsigned long *)((u8 *) entry->virtual +
168c0e09200SDave Airlie 						(PAGE_SIZE * i));
169c0e09200SDave Airlie 			for (j = 0;
170c0e09200SDave Airlie 			     j < PAGE_SIZE / sizeof(unsigned long);
171c0e09200SDave Airlie 			     j++, tmp++) {
172c0e09200SDave Airlie 				if (*tmp != 0xcafebabe && error == 0) {
173c0e09200SDave Airlie 					error = 1;
174c0e09200SDave Airlie 					DRM_ERROR("Scatter allocation error, "
175c0e09200SDave Airlie 						  "pagelist does not match "
176c0e09200SDave Airlie 						  "virtual mapping\n");
177c0e09200SDave Airlie 				}
178c0e09200SDave Airlie 			}
179c0e09200SDave Airlie 			tmp = page_address(entry->pagelist[i]);
180c0e09200SDave Airlie 			for (j = 0;
181c0e09200SDave Airlie 			     j < PAGE_SIZE / sizeof(unsigned long);
182c0e09200SDave Airlie 			     j++, tmp++) {
183c0e09200SDave Airlie 				*tmp = 0;
184c0e09200SDave Airlie 			}
185c0e09200SDave Airlie 		}
186c0e09200SDave Airlie 		if (error == 0)
187c0e09200SDave Airlie 			DRM_ERROR("Scatter allocation matches pagelist\n");
188c0e09200SDave Airlie 	}
189c0e09200SDave Airlie #endif
190c0e09200SDave Airlie 
191c0e09200SDave Airlie 	return 0;
192c0e09200SDave Airlie 
193c0e09200SDave Airlie       failed:
194c0e09200SDave Airlie 	drm_sg_cleanup(entry);
195c0e09200SDave Airlie 	return -ENOMEM;
196c0e09200SDave Airlie }
197c0e09200SDave Airlie 
1989ec4e2ffSDaniel Vetter int drm_legacy_sg_free(struct drm_device *dev, void *data,
199c0e09200SDave Airlie 		       struct drm_file *file_priv)
200c0e09200SDave Airlie {
201c0e09200SDave Airlie 	struct drm_scatter_gather *request = data;
202c0e09200SDave Airlie 	struct drm_sg_mem *entry;
203c0e09200SDave Airlie 
204*fa538645SDaniel Vetter 	if (!drm_core_check_feature(dev, DRIVER_LEGACY))
2058e194bbfSDaniel Vetter 		return -EINVAL;
2068e194bbfSDaniel Vetter 
207c0e09200SDave Airlie 	if (!drm_core_check_feature(dev, DRIVER_SG))
208c0e09200SDave Airlie 		return -EINVAL;
209c0e09200SDave Airlie 
210c0e09200SDave Airlie 	entry = dev->sg;
211c0e09200SDave Airlie 	dev->sg = NULL;
212c0e09200SDave Airlie 
213c0e09200SDave Airlie 	if (!entry || entry->handle != request->handle)
214c0e09200SDave Airlie 		return -EINVAL;
215c0e09200SDave Airlie 
216c0e09200SDave Airlie 	DRM_DEBUG("virtual  = %p\n", entry->virtual);
217c0e09200SDave Airlie 
218c0e09200SDave Airlie 	drm_sg_cleanup(entry);
219c0e09200SDave Airlie 
220c0e09200SDave Airlie 	return 0;
221c0e09200SDave Airlie }
222