xref: /openbmc/linux/drivers/gpu/drm/drm_pci.c (revision 4bb1e4e7)
1 /*
2  * Copyright 2003 José Fonseca.
3  * Copyright 2003 Leif Delgass.
4  * All Rights Reserved.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a
7  * copy of this software and associated documentation files (the "Software"),
8  * to deal in the Software without restriction, including without limitation
9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  * and/or sell copies of the Software, and to permit persons to whom the
11  * Software is furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice (including the next
14  * paragraph) shall be included in all copies or substantial portions of the
15  * Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
20  * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
25 #include <linux/dma-mapping.h>
26 #include <linux/export.h>
27 #include <linux/pci.h>
28 #include <linux/slab.h>
29 
30 #include <drm/drm.h>
31 #include <drm/drm_agpsupport.h>
32 #include <drm/drm_drv.h>
33 #include <drm/drm_pci.h>
34 #include <drm/drm_print.h>
35 
36 #include "drm_internal.h"
37 #include "drm_legacy.h"
38 
39 /**
40  * drm_pci_alloc - Allocate a PCI consistent memory block, for DMA.
41  * @dev: DRM device
42  * @size: size of block to allocate
43  * @align: alignment of block
44  *
45  * FIXME: This is a needless abstraction of the Linux dma-api and should be
46  * removed.
47  *
48  * Return: A handle to the allocated memory block on success or NULL on
49  * failure.
50  */
51 drm_dma_handle_t *drm_pci_alloc(struct drm_device * dev, size_t size, size_t align)
52 {
53 	drm_dma_handle_t *dmah;
54 	unsigned long addr;
55 	size_t sz;
56 
57 	/* pci_alloc_consistent only guarantees alignment to the smallest
58 	 * PAGE_SIZE order which is greater than or equal to the requested size.
59 	 * Return NULL here for now to make sure nobody tries for larger alignment
60 	 */
61 	if (align > size)
62 		return NULL;
63 
64 	dmah = kmalloc(sizeof(drm_dma_handle_t), GFP_KERNEL);
65 	if (!dmah)
66 		return NULL;
67 
68 	dmah->size = size;
69 	dmah->vaddr = dma_alloc_coherent(&dev->pdev->dev, size,
70 					 &dmah->busaddr,
71 					 GFP_KERNEL | __GFP_COMP);
72 
73 	if (dmah->vaddr == NULL) {
74 		kfree(dmah);
75 		return NULL;
76 	}
77 
78 	/* XXX - Is virt_to_page() legal for consistent mem? */
79 	/* Reserve */
80 	for (addr = (unsigned long)dmah->vaddr, sz = size;
81 	     sz > 0; addr += PAGE_SIZE, sz -= PAGE_SIZE) {
82 		SetPageReserved(virt_to_page((void *)addr));
83 	}
84 
85 	return dmah;
86 }
87 
88 EXPORT_SYMBOL(drm_pci_alloc);
89 
90 /*
91  * Free a PCI consistent memory block without freeing its descriptor.
92  *
93  * This function is for internal use in the Linux-specific DRM core code.
94  */
95 void __drm_legacy_pci_free(struct drm_device * dev, drm_dma_handle_t * dmah)
96 {
97 	unsigned long addr;
98 	size_t sz;
99 
100 	if (dmah->vaddr) {
101 		/* XXX - Is virt_to_page() legal for consistent mem? */
102 		/* Unreserve */
103 		for (addr = (unsigned long)dmah->vaddr, sz = dmah->size;
104 		     sz > 0; addr += PAGE_SIZE, sz -= PAGE_SIZE) {
105 			ClearPageReserved(virt_to_page((void *)addr));
106 		}
107 		dma_free_coherent(&dev->pdev->dev, dmah->size, dmah->vaddr,
108 				  dmah->busaddr);
109 	}
110 }
111 
112 /**
113  * drm_pci_free - Free a PCI consistent memory block
114  * @dev: DRM device
115  * @dmah: handle to memory block
116  *
117  * FIXME: This is a needless abstraction of the Linux dma-api and should be
118  * removed.
119  */
120 void drm_pci_free(struct drm_device * dev, drm_dma_handle_t * dmah)
121 {
122 	__drm_legacy_pci_free(dev, dmah);
123 	kfree(dmah);
124 }
125 
126 EXPORT_SYMBOL(drm_pci_free);
127 
128 #ifdef CONFIG_PCI
129 
130 static int drm_get_pci_domain(struct drm_device *dev)
131 {
132 #ifndef __alpha__
133 	/* For historical reasons, drm_get_pci_domain() is busticated
134 	 * on most archs and has to remain so for userspace interface
135 	 * < 1.4, except on alpha which was right from the beginning
136 	 */
137 	if (dev->if_version < 0x10004)
138 		return 0;
139 #endif /* __alpha__ */
140 
141 	return pci_domain_nr(dev->pdev->bus);
142 }
143 
144 int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master)
145 {
146 	master->unique = kasprintf(GFP_KERNEL, "pci:%04x:%02x:%02x.%d",
147 					drm_get_pci_domain(dev),
148 					dev->pdev->bus->number,
149 					PCI_SLOT(dev->pdev->devfn),
150 					PCI_FUNC(dev->pdev->devfn));
151 	if (!master->unique)
152 		return -ENOMEM;
153 
154 	master->unique_len = strlen(master->unique);
155 	return 0;
156 }
157 
158 static int drm_pci_irq_by_busid(struct drm_device *dev, struct drm_irq_busid *p)
159 {
160 	if ((p->busnum >> 8) != drm_get_pci_domain(dev) ||
161 	    (p->busnum & 0xff) != dev->pdev->bus->number ||
162 	    p->devnum != PCI_SLOT(dev->pdev->devfn) || p->funcnum != PCI_FUNC(dev->pdev->devfn))
163 		return -EINVAL;
164 
165 	p->irq = dev->pdev->irq;
166 
167 	DRM_DEBUG("%d:%d:%d => IRQ %d\n", p->busnum, p->devnum, p->funcnum,
168 		  p->irq);
169 	return 0;
170 }
171 
172 /**
173  * drm_irq_by_busid - Get interrupt from bus ID
174  * @dev: DRM device
175  * @data: IOCTL parameter pointing to a drm_irq_busid structure
176  * @file_priv: DRM file private.
177  *
178  * Finds the PCI device with the specified bus id and gets its IRQ number.
179  * This IOCTL is deprecated, and will now return EINVAL for any busid not equal
180  * to that of the device that this DRM instance attached to.
181  *
182  * Return: 0 on success or a negative error code on failure.
183  */
184 int drm_irq_by_busid(struct drm_device *dev, void *data,
185 		     struct drm_file *file_priv)
186 {
187 	struct drm_irq_busid *p = data;
188 
189 	if (!drm_core_check_feature(dev, DRIVER_LEGACY))
190 		return -EOPNOTSUPP;
191 
192 	/* UMS was only ever support on PCI devices. */
193 	if (WARN_ON(!dev->pdev))
194 		return -EINVAL;
195 
196 	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
197 		return -EOPNOTSUPP;
198 
199 	return drm_pci_irq_by_busid(dev, p);
200 }
201 
202 static void drm_pci_agp_init(struct drm_device *dev)
203 {
204 	if (drm_core_check_feature(dev, DRIVER_USE_AGP)) {
205 		if (pci_find_capability(dev->pdev, PCI_CAP_ID_AGP))
206 			dev->agp = drm_agp_init(dev);
207 		if (dev->agp) {
208 			dev->agp->agp_mtrr = arch_phys_wc_add(
209 				dev->agp->agp_info.aper_base,
210 				dev->agp->agp_info.aper_size *
211 				1024 * 1024);
212 		}
213 	}
214 }
215 
216 void drm_pci_agp_destroy(struct drm_device *dev)
217 {
218 	if (dev->agp) {
219 		arch_phys_wc_del(dev->agp->agp_mtrr);
220 		drm_legacy_agp_clear(dev);
221 		kfree(dev->agp);
222 		dev->agp = NULL;
223 	}
224 }
225 
226 /**
227  * drm_get_pci_dev - Register a PCI device with the DRM subsystem
228  * @pdev: PCI device
229  * @ent: entry from the PCI ID table that matches @pdev
230  * @driver: DRM device driver
231  *
232  * Attempt to gets inter module "drm" information. If we are first
233  * then register the character device and inter module information.
234  * Try and register, if we fail to register, backout previous work.
235  *
236  * NOTE: This function is deprecated, please use drm_dev_alloc() and
237  * drm_dev_register() instead and remove your &drm_driver.load callback.
238  *
239  * Return: 0 on success or a negative error code on failure.
240  */
241 int drm_get_pci_dev(struct pci_dev *pdev, const struct pci_device_id *ent,
242 		    struct drm_driver *driver)
243 {
244 	struct drm_device *dev;
245 	int ret;
246 
247 	DRM_DEBUG("\n");
248 
249 	dev = drm_dev_alloc(driver, &pdev->dev);
250 	if (IS_ERR(dev))
251 		return PTR_ERR(dev);
252 
253 	ret = pci_enable_device(pdev);
254 	if (ret)
255 		goto err_free;
256 
257 	dev->pdev = pdev;
258 #ifdef __alpha__
259 	dev->hose = pdev->sysdata;
260 #endif
261 
262 	if (drm_core_check_feature(dev, DRIVER_MODESET))
263 		pci_set_drvdata(pdev, dev);
264 
265 	drm_pci_agp_init(dev);
266 
267 	ret = drm_dev_register(dev, ent->driver_data);
268 	if (ret)
269 		goto err_agp;
270 
271 	/* No locking needed since shadow-attach is single-threaded since it may
272 	 * only be called from the per-driver module init hook. */
273 	if (drm_core_check_feature(dev, DRIVER_LEGACY))
274 		list_add_tail(&dev->legacy_dev_list, &driver->legacy_dev_list);
275 
276 	return 0;
277 
278 err_agp:
279 	drm_pci_agp_destroy(dev);
280 	pci_disable_device(pdev);
281 err_free:
282 	drm_dev_put(dev);
283 	return ret;
284 }
285 EXPORT_SYMBOL(drm_get_pci_dev);
286 
287 /**
288  * drm_legacy_pci_init - shadow-attach a legacy DRM PCI driver
289  * @driver: DRM device driver
290  * @pdriver: PCI device driver
291  *
292  * This is only used by legacy dri1 drivers and deprecated.
293  *
294  * Return: 0 on success or a negative error code on failure.
295  */
296 int drm_legacy_pci_init(struct drm_driver *driver, struct pci_driver *pdriver)
297 {
298 	struct pci_dev *pdev = NULL;
299 	const struct pci_device_id *pid;
300 	int i;
301 
302 	DRM_DEBUG("\n");
303 
304 	if (WARN_ON(!(driver->driver_features & DRIVER_LEGACY)))
305 		return -EINVAL;
306 
307 	/* If not using KMS, fall back to stealth mode manual scanning. */
308 	INIT_LIST_HEAD(&driver->legacy_dev_list);
309 	for (i = 0; pdriver->id_table[i].vendor != 0; i++) {
310 		pid = &pdriver->id_table[i];
311 
312 		/* Loop around setting up a DRM device for each PCI device
313 		 * matching our ID and device class.  If we had the internal
314 		 * function that pci_get_subsys and pci_get_class used, we'd
315 		 * be able to just pass pid in instead of doing a two-stage
316 		 * thing.
317 		 */
318 		pdev = NULL;
319 		while ((pdev =
320 			pci_get_subsys(pid->vendor, pid->device, pid->subvendor,
321 				       pid->subdevice, pdev)) != NULL) {
322 			if ((pdev->class & pid->class_mask) != pid->class)
323 				continue;
324 
325 			/* stealth mode requires a manual probe */
326 			pci_dev_get(pdev);
327 			drm_get_pci_dev(pdev, pid, driver);
328 		}
329 	}
330 	return 0;
331 }
332 EXPORT_SYMBOL(drm_legacy_pci_init);
333 
334 #else
335 
336 void drm_pci_agp_destroy(struct drm_device *dev) {}
337 
338 int drm_irq_by_busid(struct drm_device *dev, void *data,
339 		     struct drm_file *file_priv)
340 {
341 	return -EINVAL;
342 }
343 #endif
344 
345 /**
346  * drm_legacy_pci_exit - unregister shadow-attach legacy DRM driver
347  * @driver: DRM device driver
348  * @pdriver: PCI device driver
349  *
350  * Unregister a DRM driver shadow-attached through drm_legacy_pci_init(). This
351  * is deprecated and only used by dri1 drivers.
352  */
353 void drm_legacy_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver)
354 {
355 	struct drm_device *dev, *tmp;
356 	DRM_DEBUG("\n");
357 
358 	if (!(driver->driver_features & DRIVER_LEGACY)) {
359 		WARN_ON(1);
360 	} else {
361 		list_for_each_entry_safe(dev, tmp, &driver->legacy_dev_list,
362 					 legacy_dev_list) {
363 			list_del(&dev->legacy_dev_list);
364 			drm_put_dev(dev);
365 		}
366 	}
367 	DRM_INFO("Module unloaded\n");
368 }
369 EXPORT_SYMBOL(drm_legacy_pci_exit);
370