xref: /openbmc/linux/drivers/gpu/drm/drm_agpsupport.c (revision f7c35abe)
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 <drm/drmP.h>
35 #include <linux/module.h>
36 #include <linux/slab.h>
37 #include "drm_legacy.h"
38 
39 #include <asm/agp.h>
40 
41 /**
42  * Get AGP information.
43  *
44  * \param inode device inode.
45  * \param file_priv DRM file private.
46  * \param cmd command.
47  * \param arg pointer to a (output) drm_agp_info structure.
48  * \return zero on success or a negative number on failure.
49  *
50  * Verifies the AGP device has been initialized and acquired and fills in the
51  * drm_agp_info structure with the information in drm_agp_head::agp_info.
52  */
53 int drm_agp_info(struct drm_device *dev, struct drm_agp_info *info)
54 {
55 	struct agp_kern_info *kern;
56 
57 	if (!dev->agp || !dev->agp->acquired)
58 		return -EINVAL;
59 
60 	kern = &dev->agp->agp_info;
61 	info->agp_version_major = kern->version.major;
62 	info->agp_version_minor = kern->version.minor;
63 	info->mode = kern->mode;
64 	info->aperture_base = kern->aper_base;
65 	info->aperture_size = kern->aper_size * 1024 * 1024;
66 	info->memory_allowed = kern->max_memory << PAGE_SHIFT;
67 	info->memory_used = kern->current_memory << PAGE_SHIFT;
68 	info->id_vendor = kern->device->vendor;
69 	info->id_device = kern->device->device;
70 
71 	return 0;
72 }
73 
74 EXPORT_SYMBOL(drm_agp_info);
75 
76 int drm_agp_info_ioctl(struct drm_device *dev, void *data,
77 		       struct drm_file *file_priv)
78 {
79 	struct drm_agp_info *info = data;
80 	int err;
81 
82 	err = drm_agp_info(dev, info);
83 	if (err)
84 		return err;
85 
86 	return 0;
87 }
88 
89 /**
90  * Acquire the AGP device.
91  *
92  * \param dev DRM device that is to acquire AGP.
93  * \return zero on success or a negative number on failure.
94  *
95  * Verifies the AGP device hasn't been acquired before and calls
96  * \c agp_backend_acquire.
97  */
98 int drm_agp_acquire(struct drm_device * dev)
99 {
100 	if (!dev->agp)
101 		return -ENODEV;
102 	if (dev->agp->acquired)
103 		return -EBUSY;
104 	if (!(dev->agp->bridge = agp_backend_acquire(dev->pdev)))
105 		return -ENODEV;
106 	dev->agp->acquired = 1;
107 	return 0;
108 }
109 
110 EXPORT_SYMBOL(drm_agp_acquire);
111 
112 /**
113  * Acquire the AGP device (ioctl).
114  *
115  * \param inode device inode.
116  * \param file_priv DRM file private.
117  * \param cmd command.
118  * \param arg user argument.
119  * \return zero on success or a negative number on failure.
120  *
121  * Verifies the AGP device hasn't been acquired before and calls
122  * \c agp_backend_acquire.
123  */
124 int drm_agp_acquire_ioctl(struct drm_device *dev, void *data,
125 			  struct drm_file *file_priv)
126 {
127 	return drm_agp_acquire((struct drm_device *) file_priv->minor->dev);
128 }
129 
130 /**
131  * Release the AGP device.
132  *
133  * \param dev DRM device that is to release AGP.
134  * \return zero on success or a negative number on failure.
135  *
136  * Verifies the AGP device has been acquired and calls \c agp_backend_release.
137  */
138 int drm_agp_release(struct drm_device * dev)
139 {
140 	if (!dev->agp || !dev->agp->acquired)
141 		return -EINVAL;
142 	agp_backend_release(dev->agp->bridge);
143 	dev->agp->acquired = 0;
144 	return 0;
145 }
146 EXPORT_SYMBOL(drm_agp_release);
147 
148 int drm_agp_release_ioctl(struct drm_device *dev, void *data,
149 			  struct drm_file *file_priv)
150 {
151 	return drm_agp_release(dev);
152 }
153 
154 /**
155  * Enable the AGP bus.
156  *
157  * \param dev DRM device that has previously acquired AGP.
158  * \param mode Requested AGP mode.
159  * \return zero on success or a negative number on failure.
160  *
161  * Verifies the AGP device has been acquired but not enabled, and calls
162  * \c agp_enable.
163  */
164 int drm_agp_enable(struct drm_device * dev, struct drm_agp_mode mode)
165 {
166 	if (!dev->agp || !dev->agp->acquired)
167 		return -EINVAL;
168 
169 	dev->agp->mode = mode.mode;
170 	agp_enable(dev->agp->bridge, mode.mode);
171 	dev->agp->enabled = 1;
172 	return 0;
173 }
174 
175 EXPORT_SYMBOL(drm_agp_enable);
176 
177 int drm_agp_enable_ioctl(struct drm_device *dev, void *data,
178 			 struct drm_file *file_priv)
179 {
180 	struct drm_agp_mode *mode = data;
181 
182 	return drm_agp_enable(dev, *mode);
183 }
184 
185 /**
186  * Allocate AGP memory.
187  *
188  * \param inode device inode.
189  * \param file_priv file private pointer.
190  * \param cmd command.
191  * \param arg pointer to a drm_agp_buffer structure.
192  * \return zero on success or a negative number on failure.
193  *
194  * Verifies the AGP device is present and has been acquired, allocates the
195  * memory via agp_allocate_memory() and creates a drm_agp_mem entry for it.
196  */
197 int drm_agp_alloc(struct drm_device *dev, struct drm_agp_buffer *request)
198 {
199 	struct drm_agp_mem *entry;
200 	struct agp_memory *memory;
201 	unsigned long pages;
202 	u32 type;
203 
204 	if (!dev->agp || !dev->agp->acquired)
205 		return -EINVAL;
206 	if (!(entry = kzalloc(sizeof(*entry), GFP_KERNEL)))
207 		return -ENOMEM;
208 
209 	pages = (request->size + PAGE_SIZE - 1) / PAGE_SIZE;
210 	type = (u32) request->type;
211 	if (!(memory = agp_allocate_memory(dev->agp->bridge, pages, type))) {
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_agp_alloc);
228 
229 
230 int drm_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_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  */
247 static struct drm_agp_mem *drm_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  * \param inode device inode.
263  * \param file_priv DRM file private.
264  * \param cmd command.
265  * \param arg pointer to a drm_agp_binding structure.
266  * \return zero on success or a negative number on failure.
267  *
268  * Verifies the AGP device is present and acquired, looks-up the AGP memory
269  * entry and passes it to the unbind_agp() function.
270  */
271 int drm_agp_unbind(struct drm_device *dev, struct drm_agp_binding *request)
272 {
273 	struct drm_agp_mem *entry;
274 	int ret;
275 
276 	if (!dev->agp || !dev->agp->acquired)
277 		return -EINVAL;
278 	if (!(entry = drm_agp_lookup_entry(dev, request->handle)))
279 		return -EINVAL;
280 	if (!entry->bound)
281 		return -EINVAL;
282 	ret = drm_unbind_agp(entry->memory);
283 	if (ret == 0)
284 		entry->bound = 0;
285 	return ret;
286 }
287 EXPORT_SYMBOL(drm_agp_unbind);
288 
289 
290 int drm_agp_unbind_ioctl(struct drm_device *dev, void *data,
291 			 struct drm_file *file_priv)
292 {
293 	struct drm_agp_binding *request = data;
294 
295 	return drm_agp_unbind(dev, request);
296 }
297 
298 /**
299  * Bind AGP memory into the GATT (ioctl)
300  *
301  * \param inode device inode.
302  * \param file_priv DRM file private.
303  * \param cmd command.
304  * \param arg pointer to a drm_agp_binding structure.
305  * \return zero on success or a negative number on failure.
306  *
307  * Verifies the AGP device is present and has been acquired and that no memory
308  * is currently bound into the GATT. Looks-up the AGP memory entry and passes
309  * it to bind_agp() function.
310  */
311 int drm_agp_bind(struct drm_device *dev, struct drm_agp_binding *request)
312 {
313 	struct drm_agp_mem *entry;
314 	int retcode;
315 	int page;
316 
317 	if (!dev->agp || !dev->agp->acquired)
318 		return -EINVAL;
319 	if (!(entry = drm_agp_lookup_entry(dev, request->handle)))
320 		return -EINVAL;
321 	if (entry->bound)
322 		return -EINVAL;
323 	page = (request->offset + PAGE_SIZE - 1) / PAGE_SIZE;
324 	if ((retcode = drm_bind_agp(entry->memory, page)))
325 		return retcode;
326 	entry->bound = dev->agp->base + (page << PAGE_SHIFT);
327 	DRM_DEBUG("base = 0x%lx entry->bound = 0x%lx\n",
328 		  dev->agp->base, entry->bound);
329 	return 0;
330 }
331 EXPORT_SYMBOL(drm_agp_bind);
332 
333 
334 int drm_agp_bind_ioctl(struct drm_device *dev, void *data,
335 		       struct drm_file *file_priv)
336 {
337 	struct drm_agp_binding *request = data;
338 
339 	return drm_agp_bind(dev, request);
340 }
341 
342 /**
343  * Free AGP memory (ioctl).
344  *
345  * \param inode device inode.
346  * \param file_priv DRM file private.
347  * \param cmd command.
348  * \param arg pointer to a drm_agp_buffer structure.
349  * \return zero on success or a negative number on failure.
350  *
351  * Verifies the AGP device is present and has been acquired and looks up the
352  * AGP memory entry. If the memory it's currently bound, unbind it via
353  * unbind_agp(). Frees it via free_agp() as well as the entry itself
354  * and unlinks from the doubly linked list it's inserted in.
355  */
356 int drm_agp_free(struct drm_device *dev, struct drm_agp_buffer *request)
357 {
358 	struct drm_agp_mem *entry;
359 
360 	if (!dev->agp || !dev->agp->acquired)
361 		return -EINVAL;
362 	if (!(entry = drm_agp_lookup_entry(dev, request->handle)))
363 		return -EINVAL;
364 	if (entry->bound)
365 		drm_unbind_agp(entry->memory);
366 
367 	list_del(&entry->head);
368 
369 	drm_free_agp(entry->memory, entry->pages);
370 	kfree(entry);
371 	return 0;
372 }
373 EXPORT_SYMBOL(drm_agp_free);
374 
375 
376 
377 int drm_agp_free_ioctl(struct drm_device *dev, void *data,
378 		       struct drm_file *file_priv)
379 {
380 	struct drm_agp_buffer *request = data;
381 
382 	return drm_agp_free(dev, request);
383 }
384 
385 /**
386  * Initialize the AGP resources.
387  *
388  * \return pointer to a drm_agp_head structure.
389  *
390  * Gets the drm_agp_t structure which is made available by the agpgart module
391  * via the inter_module_* functions. Creates and initializes a drm_agp_head
392  * structure.
393  *
394  * Note that final cleanup of the kmalloced structure is directly done in
395  * drm_pci_agp_destroy.
396  */
397 struct drm_agp_head *drm_agp_init(struct drm_device *dev)
398 {
399 	struct drm_agp_head *head = NULL;
400 
401 	if (!(head = kzalloc(sizeof(*head), GFP_KERNEL)))
402 		return NULL;
403 	head->bridge = agp_find_bridge(dev->pdev);
404 	if (!head->bridge) {
405 		if (!(head->bridge = agp_backend_acquire(dev->pdev))) {
406 			kfree(head);
407 			return NULL;
408 		}
409 		agp_copy_info(head->bridge, &head->agp_info);
410 		agp_backend_release(head->bridge);
411 	} else {
412 		agp_copy_info(head->bridge, &head->agp_info);
413 	}
414 	if (head->agp_info.chipset == NOT_SUPPORTED) {
415 		kfree(head);
416 		return NULL;
417 	}
418 	INIT_LIST_HEAD(&head->memory);
419 	head->cant_use_aperture = head->agp_info.cant_use_aperture;
420 	head->page_mask = head->agp_info.page_mask;
421 	head->base = head->agp_info.aper_base;
422 	return head;
423 }
424 /* Only exported for i810.ko */
425 EXPORT_SYMBOL(drm_agp_init);
426 
427 /**
428  * drm_legacy_agp_clear - Clear AGP resource list
429  * @dev: DRM device
430  *
431  * Iterate over all AGP resources and remove them. But keep the AGP head
432  * intact so it can still be used. It is safe to call this if AGP is disabled or
433  * was already removed.
434  *
435  * Cleanup is only done for drivers who have DRIVER_LEGACY set.
436  */
437 void drm_legacy_agp_clear(struct drm_device *dev)
438 {
439 	struct drm_agp_mem *entry, *tempe;
440 
441 	if (!dev->agp)
442 		return;
443 	if (!drm_core_check_feature(dev, DRIVER_LEGACY))
444 		return;
445 
446 	list_for_each_entry_safe(entry, tempe, &dev->agp->memory, head) {
447 		if (entry->bound)
448 			drm_unbind_agp(entry->memory);
449 		drm_free_agp(entry->memory, entry->pages);
450 		kfree(entry);
451 	}
452 	INIT_LIST_HEAD(&dev->agp->memory);
453 
454 	if (dev->agp->acquired)
455 		drm_agp_release(dev);
456 
457 	dev->agp->acquired = 0;
458 	dev->agp->enabled = 0;
459 }
460 
461 /**
462  * Binds a collection of pages into AGP memory at the given offset, returning
463  * the AGP memory structure containing them.
464  *
465  * No reference is held on the pages during this time -- it is up to the
466  * caller to handle that.
467  */
468 struct agp_memory *
469 drm_agp_bind_pages(struct drm_device *dev,
470 		   struct page **pages,
471 		   unsigned long num_pages,
472 		   uint32_t gtt_offset,
473 		   u32 type)
474 {
475 	struct agp_memory *mem;
476 	int ret, i;
477 
478 	DRM_DEBUG("\n");
479 
480 	mem = agp_allocate_memory(dev->agp->bridge, num_pages,
481 				      type);
482 	if (mem == NULL) {
483 		DRM_ERROR("Failed to allocate memory for %ld pages\n",
484 			  num_pages);
485 		return NULL;
486 	}
487 
488 	for (i = 0; i < num_pages; i++)
489 		mem->pages[i] = pages[i];
490 	mem->page_count = num_pages;
491 
492 	mem->is_flushed = true;
493 	ret = agp_bind_memory(mem, gtt_offset / PAGE_SIZE);
494 	if (ret != 0) {
495 		DRM_ERROR("Failed to bind AGP memory: %d\n", ret);
496 		agp_free_memory(mem);
497 		return NULL;
498 	}
499 
500 	return mem;
501 }
502 EXPORT_SYMBOL(drm_agp_bind_pages);
503