xref: /openbmc/linux/drivers/gpu/drm/drm_pci.c (revision 4da722ca)
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_alloc_coherent(&dev->pdev->dev, size, &dmah->busaddr, GFP_KERNEL | __GFP_COMP);
65 
66 	if (dmah->vaddr == NULL) {
67 		kfree(dmah);
68 		return NULL;
69 	}
70 
71 	memset(dmah->vaddr, 0, size);
72 
73 	/* XXX - Is virt_to_page() legal for consistent mem? */
74 	/* Reserve */
75 	for (addr = (unsigned long)dmah->vaddr, sz = size;
76 	     sz > 0; addr += PAGE_SIZE, sz -= PAGE_SIZE) {
77 		SetPageReserved(virt_to_page((void *)addr));
78 	}
79 
80 	return dmah;
81 }
82 
83 EXPORT_SYMBOL(drm_pci_alloc);
84 
85 /*
86  * Free a PCI consistent memory block without freeing its descriptor.
87  *
88  * This function is for internal use in the Linux-specific DRM core code.
89  */
90 void __drm_legacy_pci_free(struct drm_device * dev, drm_dma_handle_t * dmah)
91 {
92 	unsigned long addr;
93 	size_t sz;
94 
95 	if (dmah->vaddr) {
96 		/* XXX - Is virt_to_page() legal for consistent mem? */
97 		/* Unreserve */
98 		for (addr = (unsigned long)dmah->vaddr, sz = dmah->size;
99 		     sz > 0; addr += PAGE_SIZE, sz -= PAGE_SIZE) {
100 			ClearPageReserved(virt_to_page((void *)addr));
101 		}
102 		dma_free_coherent(&dev->pdev->dev, dmah->size, dmah->vaddr,
103 				  dmah->busaddr);
104 	}
105 }
106 
107 /**
108  * drm_pci_free - Free a PCI consistent memory block
109  * @dev: DRM device
110  * @dmah: handle to memory block
111  *
112  * FIXME: This is a needless abstraction of the Linux dma-api and should be
113  * removed.
114  */
115 void drm_pci_free(struct drm_device * dev, drm_dma_handle_t * dmah)
116 {
117 	__drm_legacy_pci_free(dev, dmah);
118 	kfree(dmah);
119 }
120 
121 EXPORT_SYMBOL(drm_pci_free);
122 
123 #ifdef CONFIG_PCI
124 
125 static int drm_get_pci_domain(struct drm_device *dev)
126 {
127 #ifndef __alpha__
128 	/* For historical reasons, drm_get_pci_domain() is busticated
129 	 * on most archs and has to remain so for userspace interface
130 	 * < 1.4, except on alpha which was right from the beginning
131 	 */
132 	if (dev->if_version < 0x10004)
133 		return 0;
134 #endif /* __alpha__ */
135 
136 	return pci_domain_nr(dev->pdev->bus);
137 }
138 
139 int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master)
140 {
141 	master->unique = kasprintf(GFP_KERNEL, "pci:%04x:%02x:%02x.%d",
142 					drm_get_pci_domain(dev),
143 					dev->pdev->bus->number,
144 					PCI_SLOT(dev->pdev->devfn),
145 					PCI_FUNC(dev->pdev->devfn));
146 	if (!master->unique)
147 		return -ENOMEM;
148 
149 	master->unique_len = strlen(master->unique);
150 	return 0;
151 }
152 EXPORT_SYMBOL(drm_pci_set_busid);
153 
154 static int drm_pci_irq_by_busid(struct drm_device *dev, struct drm_irq_busid *p)
155 {
156 	if ((p->busnum >> 8) != drm_get_pci_domain(dev) ||
157 	    (p->busnum & 0xff) != dev->pdev->bus->number ||
158 	    p->devnum != PCI_SLOT(dev->pdev->devfn) || p->funcnum != PCI_FUNC(dev->pdev->devfn))
159 		return -EINVAL;
160 
161 	p->irq = dev->pdev->irq;
162 
163 	DRM_DEBUG("%d:%d:%d => IRQ %d\n", p->busnum, p->devnum, p->funcnum,
164 		  p->irq);
165 	return 0;
166 }
167 
168 /**
169  * drm_irq_by_busid - Get interrupt from bus ID
170  * @dev: DRM device
171  * @data: IOCTL parameter pointing to a drm_irq_busid structure
172  * @file_priv: DRM file private.
173  *
174  * Finds the PCI device with the specified bus id and gets its IRQ number.
175  * This IOCTL is deprecated, and will now return EINVAL for any busid not equal
176  * to that of the device that this DRM instance attached to.
177  *
178  * Return: 0 on success or a negative error code on failure.
179  */
180 int drm_irq_by_busid(struct drm_device *dev, void *data,
181 		     struct drm_file *file_priv)
182 {
183 	struct drm_irq_busid *p = data;
184 
185 	if (!drm_core_check_feature(dev, DRIVER_LEGACY))
186 		return -EINVAL;
187 
188 	/* UMS was only ever support on PCI devices. */
189 	if (WARN_ON(!dev->pdev))
190 		return -EINVAL;
191 
192 	if (!drm_core_check_feature(dev, DRIVER_HAVE_IRQ))
193 		return -EINVAL;
194 
195 	return drm_pci_irq_by_busid(dev, p);
196 }
197 
198 static void drm_pci_agp_init(struct drm_device *dev)
199 {
200 	if (drm_core_check_feature(dev, DRIVER_USE_AGP)) {
201 		if (pci_find_capability(dev->pdev, PCI_CAP_ID_AGP))
202 			dev->agp = drm_agp_init(dev);
203 		if (dev->agp) {
204 			dev->agp->agp_mtrr = arch_phys_wc_add(
205 				dev->agp->agp_info.aper_base,
206 				dev->agp->agp_info.aper_size *
207 				1024 * 1024);
208 		}
209 	}
210 }
211 
212 void drm_pci_agp_destroy(struct drm_device *dev)
213 {
214 	if (dev->agp) {
215 		arch_phys_wc_del(dev->agp->agp_mtrr);
216 		drm_legacy_agp_clear(dev);
217 		kfree(dev->agp);
218 		dev->agp = NULL;
219 	}
220 }
221 
222 /**
223  * drm_get_pci_dev - Register a PCI device with the DRM subsystem
224  * @pdev: PCI device
225  * @ent: entry from the PCI ID table that matches @pdev
226  * @driver: DRM device driver
227  *
228  * Attempt to gets inter module "drm" information. If we are first
229  * then register the character device and inter module information.
230  * Try and register, if we fail to register, backout previous work.
231  *
232  * NOTE: This function is deprecated, please use drm_dev_alloc() and
233  * drm_dev_register() instead and remove your &drm_driver.load callback.
234  *
235  * Return: 0 on success or a negative error code on failure.
236  */
237 int drm_get_pci_dev(struct pci_dev *pdev, const struct pci_device_id *ent,
238 		    struct drm_driver *driver)
239 {
240 	struct drm_device *dev;
241 	int ret;
242 
243 	DRM_DEBUG("\n");
244 
245 	dev = drm_dev_alloc(driver, &pdev->dev);
246 	if (IS_ERR(dev))
247 		return PTR_ERR(dev);
248 
249 	ret = pci_enable_device(pdev);
250 	if (ret)
251 		goto err_free;
252 
253 	dev->pdev = pdev;
254 #ifdef __alpha__
255 	dev->hose = pdev->sysdata;
256 #endif
257 
258 	if (drm_core_check_feature(dev, DRIVER_MODESET))
259 		pci_set_drvdata(pdev, dev);
260 
261 	drm_pci_agp_init(dev);
262 
263 	ret = drm_dev_register(dev, ent->driver_data);
264 	if (ret)
265 		goto err_agp;
266 
267 	/* No locking needed since shadow-attach is single-threaded since it may
268 	 * only be called from the per-driver module init hook. */
269 	if (drm_core_check_feature(dev, DRIVER_LEGACY))
270 		list_add_tail(&dev->legacy_dev_list, &driver->legacy_dev_list);
271 
272 	return 0;
273 
274 err_agp:
275 	drm_pci_agp_destroy(dev);
276 	pci_disable_device(pdev);
277 err_free:
278 	drm_dev_unref(dev);
279 	return ret;
280 }
281 EXPORT_SYMBOL(drm_get_pci_dev);
282 
283 /**
284  * drm_pci_init - Register matching PCI devices with the DRM subsystem
285  * @driver: DRM device driver
286  * @pdriver: PCI device driver
287  *
288  * Initializes a drm_device structures, registering the stubs and initializing
289  * the AGP device.
290  *
291  * NOTE: This function is deprecated. Modern modesetting drm drivers should use
292  * pci_register_driver() directly, this function only provides shadow-binding
293  * support for old legacy drivers on top of that core pci function.
294  *
295  * Return: 0 on success or a negative error code on failure.
296  */
297 int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver)
298 {
299 	struct pci_dev *pdev = NULL;
300 	const struct pci_device_id *pid;
301 	int i;
302 
303 	DRM_DEBUG("\n");
304 
305 	if (!(driver->driver_features & DRIVER_LEGACY))
306 		return pci_register_driver(pdriver);
307 
308 	/* If not using KMS, fall back to stealth mode manual scanning. */
309 	INIT_LIST_HEAD(&driver->legacy_dev_list);
310 	for (i = 0; pdriver->id_table[i].vendor != 0; i++) {
311 		pid = &pdriver->id_table[i];
312 
313 		/* Loop around setting up a DRM device for each PCI device
314 		 * matching our ID and device class.  If we had the internal
315 		 * function that pci_get_subsys and pci_get_class used, we'd
316 		 * be able to just pass pid in instead of doing a two-stage
317 		 * thing.
318 		 */
319 		pdev = NULL;
320 		while ((pdev =
321 			pci_get_subsys(pid->vendor, pid->device, pid->subvendor,
322 				       pid->subdevice, pdev)) != NULL) {
323 			if ((pdev->class & pid->class_mask) != pid->class)
324 				continue;
325 
326 			/* stealth mode requires a manual probe */
327 			pci_dev_get(pdev);
328 			drm_get_pci_dev(pdev, pid, driver);
329 		}
330 	}
331 	return 0;
332 }
333 
334 int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *mask)
335 {
336 	struct pci_dev *root;
337 	u32 lnkcap, lnkcap2;
338 
339 	*mask = 0;
340 	if (!dev->pdev)
341 		return -EINVAL;
342 
343 	root = dev->pdev->bus->self;
344 
345 	/* we've been informed via and serverworks don't make the cut */
346 	if (root->vendor == PCI_VENDOR_ID_VIA ||
347 	    root->vendor == PCI_VENDOR_ID_SERVERWORKS)
348 		return -EINVAL;
349 
350 	pcie_capability_read_dword(root, PCI_EXP_LNKCAP, &lnkcap);
351 	pcie_capability_read_dword(root, PCI_EXP_LNKCAP2, &lnkcap2);
352 
353 	if (lnkcap2) {	/* PCIe r3.0-compliant */
354 		if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_2_5GB)
355 			*mask |= DRM_PCIE_SPEED_25;
356 		if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_5_0GB)
357 			*mask |= DRM_PCIE_SPEED_50;
358 		if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_8_0GB)
359 			*mask |= DRM_PCIE_SPEED_80;
360 	} else {	/* pre-r3.0 */
361 		if (lnkcap & PCI_EXP_LNKCAP_SLS_2_5GB)
362 			*mask |= DRM_PCIE_SPEED_25;
363 		if (lnkcap & PCI_EXP_LNKCAP_SLS_5_0GB)
364 			*mask |= (DRM_PCIE_SPEED_25 | DRM_PCIE_SPEED_50);
365 	}
366 
367 	DRM_INFO("probing gen 2 caps for device %x:%x = %x/%x\n", root->vendor, root->device, lnkcap, lnkcap2);
368 	return 0;
369 }
370 EXPORT_SYMBOL(drm_pcie_get_speed_cap_mask);
371 
372 int drm_pcie_get_max_link_width(struct drm_device *dev, u32 *mlw)
373 {
374 	struct pci_dev *root;
375 	u32 lnkcap;
376 
377 	*mlw = 0;
378 	if (!dev->pdev)
379 		return -EINVAL;
380 
381 	root = dev->pdev->bus->self;
382 
383 	pcie_capability_read_dword(root, PCI_EXP_LNKCAP, &lnkcap);
384 
385 	*mlw = (lnkcap & PCI_EXP_LNKCAP_MLW) >> 4;
386 
387 	DRM_INFO("probing mlw for device %x:%x = %x\n", root->vendor, root->device, lnkcap);
388 	return 0;
389 }
390 EXPORT_SYMBOL(drm_pcie_get_max_link_width);
391 
392 #else
393 
394 int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver)
395 {
396 	return -1;
397 }
398 
399 void drm_pci_agp_destroy(struct drm_device *dev) {}
400 
401 int drm_irq_by_busid(struct drm_device *dev, void *data,
402 		     struct drm_file *file_priv)
403 {
404 	return -EINVAL;
405 }
406 #endif
407 
408 EXPORT_SYMBOL(drm_pci_init);
409 
410 /**
411  * drm_pci_exit - Unregister matching PCI devices from the DRM subsystem
412  * @driver: DRM device driver
413  * @pdriver: PCI device driver
414  *
415  * Unregisters one or more devices matched by a PCI driver from the DRM
416  * subsystem.
417  *
418  * NOTE: This function is deprecated. Modern modesetting drm drivers should use
419  * pci_unregister_driver() directly, this function only provides shadow-binding
420  * support for old legacy drivers on top of that core pci function.
421  */
422 void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver)
423 {
424 	struct drm_device *dev, *tmp;
425 	DRM_DEBUG("\n");
426 
427 	if (!(driver->driver_features & DRIVER_LEGACY)) {
428 		pci_unregister_driver(pdriver);
429 	} else {
430 		list_for_each_entry_safe(dev, tmp, &driver->legacy_dev_list,
431 					 legacy_dev_list) {
432 			list_del(&dev->legacy_dev_list);
433 			drm_put_dev(dev);
434 		}
435 	}
436 	DRM_INFO("Module unloaded\n");
437 }
438 EXPORT_SYMBOL(drm_pci_exit);
439