1 /*
2  * \file drm_agpsupport.c
3  * DRM support for AGP/GART backend
4  *
5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
6  * \author Gareth Hughes <gareth@valinux.com>
7  */
8 
9 /*
10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12  * All Rights Reserved.
13  *
14  * Permission is hereby granted, free of charge, to any person obtaining a
15  * copy of this software and associated documentation files (the "Software"),
16  * to deal in the Software without restriction, including without limitation
17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
18  * and/or sell copies of the Software, and to permit persons to whom the
19  * Software is furnished to do so, subject to the following conditions:
20  *
21  * The above copyright notice and this permission notice (including the next
22  * paragraph) shall be included in all copies or substantial portions of the
23  * Software.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
28  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
29  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
30  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
31  * OTHER DEALINGS IN THE SOFTWARE.
32  */
33 
34 #include <linux/module.h>
35 #include <linux/pci.h>
36 #include <linux/slab.h>
37 
38 #if IS_ENABLED(CONFIG_AGP)
39 #include <asm/agp.h>
40 #endif
41 
42 #include <drm/drm_device.h>
43 #include <drm/drm_drv.h>
44 #include <drm/drm_file.h>
45 #include <drm/drm_print.h>
46 
47 #include "drm_legacy.h"
48 
49 #if IS_ENABLED(CONFIG_AGP)
50 
51 /*
52  * Get AGP information.
53  *
54  * \return zero on success or a negative number on failure.
55  *
56  * Verifies the AGP device has been initialized and acquired and fills in the
57  * drm_agp_info structure with the information in drm_agp_head::agp_info.
58  */
drm_legacy_agp_info(struct drm_device * dev,struct drm_agp_info * info)59 int drm_legacy_agp_info(struct drm_device *dev, struct drm_agp_info *info)
60 {
61 	struct agp_kern_info *kern;
62 
63 	if (!dev->agp || !dev->agp->acquired)
64 		return -EINVAL;
65 
66 	kern = &dev->agp->agp_info;
67 	info->agp_version_major = kern->version.major;
68 	info->agp_version_minor = kern->version.minor;
69 	info->mode = kern->mode;
70 	info->aperture_base = kern->aper_base;
71 	info->aperture_size = kern->aper_size * 1024 * 1024;
72 	info->memory_allowed = kern->max_memory << PAGE_SHIFT;
73 	info->memory_used = kern->current_memory << PAGE_SHIFT;
74 	info->id_vendor = kern->device->vendor;
75 	info->id_device = kern->device->device;
76 
77 	return 0;
78 }
79 EXPORT_SYMBOL(drm_legacy_agp_info);
80 
drm_legacy_agp_info_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)81 int drm_legacy_agp_info_ioctl(struct drm_device *dev, void *data,
82 			      struct drm_file *file_priv)
83 {
84 	struct drm_agp_info *info = data;
85 	int err;
86 
87 	err = drm_legacy_agp_info(dev, info);
88 	if (err)
89 		return err;
90 
91 	return 0;
92 }
93 
94 /*
95  * Acquire the AGP device.
96  *
97  * \param dev DRM device that is to acquire AGP.
98  * \return zero on success or a negative number on failure.
99  *
100  * Verifies the AGP device hasn't been acquired before and calls
101  * \c agp_backend_acquire.
102  */
drm_legacy_agp_acquire(struct drm_device * dev)103 int drm_legacy_agp_acquire(struct drm_device *dev)
104 {
105 	struct pci_dev *pdev = to_pci_dev(dev->dev);
106 
107 	if (!dev->agp)
108 		return -ENODEV;
109 	if (dev->agp->acquired)
110 		return -EBUSY;
111 	dev->agp->bridge = agp_backend_acquire(pdev);
112 	if (!dev->agp->bridge)
113 		return -ENODEV;
114 	dev->agp->acquired = 1;
115 	return 0;
116 }
117 EXPORT_SYMBOL(drm_legacy_agp_acquire);
118 
119 /*
120  * Acquire the AGP device (ioctl).
121  *
122  * \return zero on success or a negative number on failure.
123  *
124  * Verifies the AGP device hasn't been acquired before and calls
125  * \c agp_backend_acquire.
126  */
drm_legacy_agp_acquire_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)127 int drm_legacy_agp_acquire_ioctl(struct drm_device *dev, void *data,
128 				 struct drm_file *file_priv)
129 {
130 	return drm_legacy_agp_acquire((struct drm_device *)file_priv->minor->dev);
131 }
132 
133 /*
134  * Release the AGP device.
135  *
136  * \param dev DRM device that is to release AGP.
137  * \return zero on success or a negative number on failure.
138  *
139  * Verifies the AGP device has been acquired and calls \c agp_backend_release.
140  */
drm_legacy_agp_release(struct drm_device * dev)141 int drm_legacy_agp_release(struct drm_device *dev)
142 {
143 	if (!dev->agp || !dev->agp->acquired)
144 		return -EINVAL;
145 	agp_backend_release(dev->agp->bridge);
146 	dev->agp->acquired = 0;
147 	return 0;
148 }
149 EXPORT_SYMBOL(drm_legacy_agp_release);
150 
drm_legacy_agp_release_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)151 int drm_legacy_agp_release_ioctl(struct drm_device *dev, void *data,
152 				 struct drm_file *file_priv)
153 {
154 	return drm_legacy_agp_release(dev);
155 }
156 
157 /*
158  * Enable the AGP bus.
159  *
160  * \param dev DRM device that has previously acquired AGP.
161  * \param mode Requested AGP mode.
162  * \return zero on success or a negative number on failure.
163  *
164  * Verifies the AGP device has been acquired but not enabled, and calls
165  * \c agp_enable.
166  */
drm_legacy_agp_enable(struct drm_device * dev,struct drm_agp_mode mode)167 int drm_legacy_agp_enable(struct drm_device *dev, struct drm_agp_mode mode)
168 {
169 	if (!dev->agp || !dev->agp->acquired)
170 		return -EINVAL;
171 
172 	dev->agp->mode = mode.mode;
173 	agp_enable(dev->agp->bridge, mode.mode);
174 	dev->agp->enabled = 1;
175 	return 0;
176 }
177 EXPORT_SYMBOL(drm_legacy_agp_enable);
178 
drm_legacy_agp_enable_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)179 int drm_legacy_agp_enable_ioctl(struct drm_device *dev, void *data,
180 				struct drm_file *file_priv)
181 {
182 	struct drm_agp_mode *mode = data;
183 
184 	return drm_legacy_agp_enable(dev, *mode);
185 }
186 
187 /*
188  * Allocate AGP memory.
189  *
190  * \return zero on success or a negative number on failure.
191  *
192  * Verifies the AGP device is present and has been acquired, allocates the
193  * memory via agp_allocate_memory() and creates a drm_agp_mem entry for it.
194  */
drm_legacy_agp_alloc(struct drm_device * dev,struct drm_agp_buffer * request)195 int drm_legacy_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request)
196 {
197 	struct drm_agp_mem *entry;
198 	struct agp_memory *memory;
199 	unsigned long pages;
200 	u32 type;
201 
202 	if (!dev->agp || !dev->agp->acquired)
203 		return -EINVAL;
204 	entry = kzalloc(sizeof(*entry), GFP_KERNEL);
205 	if (!entry)
206 		return -ENOMEM;
207 
208 	pages = DIV_ROUND_UP(request->size, PAGE_SIZE);
209 	type = (u32) request->type;
210 	memory = agp_allocate_memory(dev->agp->bridge, pages, type);
211 	if (!memory) {
212 		kfree(entry);
213 		return -ENOMEM;
214 	}
215 
216 	entry->handle = (unsigned long)memory->key + 1;
217 	entry->memory = memory;
218 	entry->bound = 0;
219 	entry->pages = pages;
220 	list_add(&entry->head, &dev->agp->memory);
221 
222 	request->handle = entry->handle;
223 	request->physical = memory->physical;
224 
225 	return 0;
226 }
227 EXPORT_SYMBOL(drm_legacy_agp_alloc);
228 
229 
drm_legacy_agp_alloc_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)230 int drm_legacy_agp_alloc_ioctl(struct drm_device *dev, void *data,
231 			struct drm_file *file_priv)
232 {
233 	struct drm_agp_buffer *request = data;
234 
235 	return drm_legacy_agp_alloc(dev, request);
236 }
237 
238 /*
239  * Search for the AGP memory entry associated with a handle.
240  *
241  * \param dev DRM device structure.
242  * \param handle AGP memory handle.
243  * \return pointer to the drm_agp_mem structure associated with \p handle.
244  *
245  * Walks through drm_agp_head::memory until finding a matching handle.
246  */
drm_legacy_agp_lookup_entry(struct drm_device * dev,unsigned long handle)247 static struct drm_agp_mem *drm_legacy_agp_lookup_entry(struct drm_device *dev,
248 						       unsigned long handle)
249 {
250 	struct drm_agp_mem *entry;
251 
252 	list_for_each_entry(entry, &dev->agp->memory, head) {
253 		if (entry->handle == handle)
254 			return entry;
255 	}
256 	return NULL;
257 }
258 
259 /*
260  * Unbind AGP memory from the GATT (ioctl).
261  *
262  * \return zero on success or a negative number on failure.
263  *
264  * Verifies the AGP device is present and acquired, looks-up the AGP memory
265  * entry and passes it to the unbind_agp() function.
266  */
drm_legacy_agp_unbind(struct drm_device * dev,struct drm_agp_binding * request)267 int drm_legacy_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request)
268 {
269 	struct drm_agp_mem *entry;
270 	int ret;
271 
272 	if (!dev->agp || !dev->agp->acquired)
273 		return -EINVAL;
274 	entry = drm_legacy_agp_lookup_entry(dev, request->handle);
275 	if (!entry || !entry->bound)
276 		return -EINVAL;
277 	ret = agp_unbind_memory(entry->memory);
278 	if (ret == 0)
279 		entry->bound = 0;
280 	return ret;
281 }
282 EXPORT_SYMBOL(drm_legacy_agp_unbind);
283 
284 
drm_legacy_agp_unbind_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)285 int drm_legacy_agp_unbind_ioctl(struct drm_device *dev, void *data,
286 				struct drm_file *file_priv)
287 {
288 	struct drm_agp_binding *request = data;
289 
290 	return drm_legacy_agp_unbind(dev, request);
291 }
292 
293 /*
294  * Bind AGP memory into the GATT (ioctl)
295  *
296  * \return zero on success or a negative number on failure.
297  *
298  * Verifies the AGP device is present and has been acquired and that no memory
299  * is currently bound into the GATT. Looks-up the AGP memory entry and passes
300  * it to bind_agp() function.
301  */
drm_legacy_agp_bind(struct drm_device * dev,struct drm_agp_binding * request)302 int drm_legacy_agp_bind(struct drm_device *dev, struct drm_agp_binding *request)
303 {
304 	struct drm_agp_mem *entry;
305 	int retcode;
306 	int page;
307 
308 	if (!dev->agp || !dev->agp->acquired)
309 		return -EINVAL;
310 	entry = drm_legacy_agp_lookup_entry(dev, request->handle);
311 	if (!entry || entry->bound)
312 		return -EINVAL;
313 	page = DIV_ROUND_UP(request->offset, PAGE_SIZE);
314 	retcode = agp_bind_memory(entry->memory, page);
315 	if (retcode)
316 		return retcode;
317 	entry->bound = dev->agp->base + (page << PAGE_SHIFT);
318 	DRM_DEBUG("base = 0x%lx entry->bound = 0x%lx\n",
319 		  dev->agp->base, entry->bound);
320 	return 0;
321 }
322 EXPORT_SYMBOL(drm_legacy_agp_bind);
323 
324 
drm_legacy_agp_bind_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)325 int drm_legacy_agp_bind_ioctl(struct drm_device *dev, void *data,
326 			      struct drm_file *file_priv)
327 {
328 	struct drm_agp_binding *request = data;
329 
330 	return drm_legacy_agp_bind(dev, request);
331 }
332 
333 /*
334  * Free AGP memory (ioctl).
335  *
336  * \return zero on success or a negative number on failure.
337  *
338  * Verifies the AGP device is present and has been acquired and looks up the
339  * AGP memory entry. If the memory is currently bound, unbind it via
340  * unbind_agp(). Frees it via free_agp() as well as the entry itself
341  * and unlinks from the doubly linked list it's inserted in.
342  */
drm_legacy_agp_free(struct drm_device * dev,struct drm_agp_buffer * request)343 int drm_legacy_agp_free(struct drm_device *dev, struct drm_agp_buffer *request)
344 {
345 	struct drm_agp_mem *entry;
346 
347 	if (!dev->agp || !dev->agp->acquired)
348 		return -EINVAL;
349 	entry = drm_legacy_agp_lookup_entry(dev, request->handle);
350 	if (!entry)
351 		return -EINVAL;
352 	if (entry->bound)
353 		agp_unbind_memory(entry->memory);
354 
355 	list_del(&entry->head);
356 
357 	agp_free_memory(entry->memory);
358 	kfree(entry);
359 	return 0;
360 }
361 EXPORT_SYMBOL(drm_legacy_agp_free);
362 
363 
drm_legacy_agp_free_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)364 int drm_legacy_agp_free_ioctl(struct drm_device *dev, void *data,
365 			      struct drm_file *file_priv)
366 {
367 	struct drm_agp_buffer *request = data;
368 
369 	return drm_legacy_agp_free(dev, request);
370 }
371 
372 /*
373  * Initialize the AGP resources.
374  *
375  * \return pointer to a drm_agp_head structure.
376  *
377  * Gets the drm_agp_t structure which is made available by the agpgart module
378  * via the inter_module_* functions. Creates and initializes a drm_agp_head
379  * structure.
380  *
381  * Note that final cleanup of the kmalloced structure is directly done in
382  * drm_pci_agp_destroy.
383  */
drm_legacy_agp_init(struct drm_device * dev)384 struct drm_agp_head *drm_legacy_agp_init(struct drm_device *dev)
385 {
386 	struct pci_dev *pdev = to_pci_dev(dev->dev);
387 	struct drm_agp_head *head = NULL;
388 
389 	head = kzalloc(sizeof(*head), GFP_KERNEL);
390 	if (!head)
391 		return NULL;
392 	head->bridge = agp_find_bridge(pdev);
393 	if (!head->bridge) {
394 		head->bridge = agp_backend_acquire(pdev);
395 		if (!head->bridge) {
396 			kfree(head);
397 			return NULL;
398 		}
399 		agp_copy_info(head->bridge, &head->agp_info);
400 		agp_backend_release(head->bridge);
401 	} else {
402 		agp_copy_info(head->bridge, &head->agp_info);
403 	}
404 	if (head->agp_info.chipset == NOT_SUPPORTED) {
405 		kfree(head);
406 		return NULL;
407 	}
408 	INIT_LIST_HEAD(&head->memory);
409 	head->cant_use_aperture = head->agp_info.cant_use_aperture;
410 	head->page_mask = head->agp_info.page_mask;
411 	head->base = head->agp_info.aper_base;
412 	return head;
413 }
414 /* Only exported for i810.ko */
415 EXPORT_SYMBOL(drm_legacy_agp_init);
416 
417 /**
418  * drm_legacy_agp_clear - Clear AGP resource list
419  * @dev: DRM device
420  *
421  * Iterate over all AGP resources and remove them. But keep the AGP head
422  * intact so it can still be used. It is safe to call this if AGP is disabled or
423  * was already removed.
424  *
425  * Cleanup is only done for drivers who have DRIVER_LEGACY set.
426  */
drm_legacy_agp_clear(struct drm_device * dev)427 void drm_legacy_agp_clear(struct drm_device *dev)
428 {
429 	struct drm_agp_mem *entry, *tempe;
430 
431 	if (!dev->agp)
432 		return;
433 	if (!drm_core_check_feature(dev, DRIVER_LEGACY))
434 		return;
435 
436 	list_for_each_entry_safe(entry, tempe, &dev->agp->memory, head) {
437 		if (entry->bound)
438 			agp_unbind_memory(entry->memory);
439 		agp_free_memory(entry->memory);
440 		kfree(entry);
441 	}
442 	INIT_LIST_HEAD(&dev->agp->memory);
443 
444 	if (dev->agp->acquired)
445 		drm_legacy_agp_release(dev);
446 
447 	dev->agp->acquired = 0;
448 	dev->agp->enabled = 0;
449 }
450 
451 #endif
452