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