xref: /openbmc/linux/drivers/gpu/drm/drm_pci.c (revision 1c2f87c2)
1 /* drm_pci.h -- PCI DMA memory management wrappers for DRM -*- linux-c -*- */
2 /**
3  * \file drm_pci.c
4  * \brief Functions and ioctls to manage PCI memory
5  *
6  * \warning These interfaces aren't stable yet.
7  *
8  * \todo Implement the remaining ioctl's for the PCI pools.
9  * \todo The wrappers here are so thin that they would be better off inlined..
10  *
11  * \author José Fonseca <jrfonseca@tungstengraphics.com>
12  * \author Leif Delgass <ldelgass@retinalburn.net>
13  */
14 
15 /*
16  * Copyright 2003 José Fonseca.
17  * Copyright 2003 Leif Delgass.
18  * All Rights Reserved.
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining a
21  * copy of this software and associated documentation files (the "Software"),
22  * to deal in the Software without restriction, including without limitation
23  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
24  * and/or sell copies of the Software, and to permit persons to whom the
25  * Software is furnished to do so, subject to the following conditions:
26  *
27  * The above copyright notice and this permission notice (including the next
28  * paragraph) shall be included in all copies or substantial portions of the
29  * Software.
30  *
31  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
32  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
33  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
34  * AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
35  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
36  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
37  */
38 
39 #include <linux/pci.h>
40 #include <linux/slab.h>
41 #include <linux/dma-mapping.h>
42 #include <linux/export.h>
43 #include <drm/drmP.h>
44 
45 /**********************************************************************/
46 /** \name PCI memory */
47 /*@{*/
48 
49 /**
50  * \brief Allocate a PCI consistent memory block, for DMA.
51  */
52 drm_dma_handle_t *drm_pci_alloc(struct drm_device * dev, size_t size, size_t align)
53 {
54 	drm_dma_handle_t *dmah;
55 	unsigned long addr;
56 	size_t sz;
57 
58 	/* pci_alloc_consistent only guarantees alignment to the smallest
59 	 * PAGE_SIZE order which is greater than or equal to the requested size.
60 	 * Return NULL here for now to make sure nobody tries for larger alignment
61 	 */
62 	if (align > size)
63 		return NULL;
64 
65 	dmah = kmalloc(sizeof(drm_dma_handle_t), GFP_KERNEL);
66 	if (!dmah)
67 		return NULL;
68 
69 	dmah->size = size;
70 	dmah->vaddr = dma_alloc_coherent(&dev->pdev->dev, size, &dmah->busaddr, GFP_KERNEL | __GFP_COMP);
71 
72 	if (dmah->vaddr == NULL) {
73 		kfree(dmah);
74 		return NULL;
75 	}
76 
77 	memset(dmah->vaddr, 0, size);
78 
79 	/* XXX - Is virt_to_page() legal for consistent mem? */
80 	/* Reserve */
81 	for (addr = (unsigned long)dmah->vaddr, sz = size;
82 	     sz > 0; addr += PAGE_SIZE, sz -= PAGE_SIZE) {
83 		SetPageReserved(virt_to_page((void *)addr));
84 	}
85 
86 	return dmah;
87 }
88 
89 EXPORT_SYMBOL(drm_pci_alloc);
90 
91 /**
92  * \brief Free a PCI consistent memory block without freeing its descriptor.
93  *
94  * This function is for internal use in the Linux-specific DRM core code.
95  */
96 void __drm_pci_free(struct drm_device * dev, drm_dma_handle_t * dmah)
97 {
98 	unsigned long addr;
99 	size_t sz;
100 
101 	if (dmah->vaddr) {
102 		/* XXX - Is virt_to_page() legal for consistent mem? */
103 		/* Unreserve */
104 		for (addr = (unsigned long)dmah->vaddr, sz = dmah->size;
105 		     sz > 0; addr += PAGE_SIZE, sz -= PAGE_SIZE) {
106 			ClearPageReserved(virt_to_page((void *)addr));
107 		}
108 		dma_free_coherent(&dev->pdev->dev, dmah->size, dmah->vaddr,
109 				  dmah->busaddr);
110 	}
111 }
112 
113 /**
114  * \brief Free a PCI consistent memory block
115  */
116 void drm_pci_free(struct drm_device * dev, drm_dma_handle_t * dmah)
117 {
118 	__drm_pci_free(dev, dmah);
119 	kfree(dmah);
120 }
121 
122 EXPORT_SYMBOL(drm_pci_free);
123 
124 #ifdef CONFIG_PCI
125 
126 static int drm_get_pci_domain(struct drm_device *dev)
127 {
128 #ifndef __alpha__
129 	/* For historical reasons, drm_get_pci_domain() is busticated
130 	 * on most archs and has to remain so for userspace interface
131 	 * < 1.4, except on alpha which was right from the beginning
132 	 */
133 	if (dev->if_version < 0x10004)
134 		return 0;
135 #endif /* __alpha__ */
136 
137 	return pci_domain_nr(dev->pdev->bus);
138 }
139 
140 static int drm_pci_get_irq(struct drm_device *dev)
141 {
142 	return dev->pdev->irq;
143 }
144 
145 static const char *drm_pci_get_name(struct drm_device *dev)
146 {
147 	struct pci_driver *pdriver = dev->driver->kdriver.pci;
148 	return pdriver->name;
149 }
150 
151 static int drm_pci_set_busid(struct drm_device *dev, struct drm_master *master)
152 {
153 	int len, ret;
154 	struct pci_driver *pdriver = dev->driver->kdriver.pci;
155 	master->unique_len = 40;
156 	master->unique_size = master->unique_len;
157 	master->unique = kmalloc(master->unique_size, GFP_KERNEL);
158 	if (master->unique == NULL)
159 		return -ENOMEM;
160 
161 
162 	len = snprintf(master->unique, master->unique_len,
163 		       "pci:%04x:%02x:%02x.%d",
164 		       drm_get_pci_domain(dev),
165 		       dev->pdev->bus->number,
166 		       PCI_SLOT(dev->pdev->devfn),
167 		       PCI_FUNC(dev->pdev->devfn));
168 
169 	if (len >= master->unique_len) {
170 		DRM_ERROR("buffer overflow");
171 		ret = -EINVAL;
172 		goto err;
173 	} else
174 		master->unique_len = len;
175 
176 	dev->devname =
177 		kmalloc(strlen(pdriver->name) +
178 			master->unique_len + 2, GFP_KERNEL);
179 
180 	if (dev->devname == NULL) {
181 		ret = -ENOMEM;
182 		goto err;
183 	}
184 
185 	sprintf(dev->devname, "%s@%s", pdriver->name,
186 		master->unique);
187 
188 	return 0;
189 err:
190 	return ret;
191 }
192 
193 static int drm_pci_set_unique(struct drm_device *dev,
194 			      struct drm_master *master,
195 			      struct drm_unique *u)
196 {
197 	int domain, bus, slot, func, ret;
198 	const char *bus_name;
199 
200 	master->unique_len = u->unique_len;
201 	master->unique_size = u->unique_len + 1;
202 	master->unique = kmalloc(master->unique_size, GFP_KERNEL);
203 	if (!master->unique) {
204 		ret = -ENOMEM;
205 		goto err;
206 	}
207 
208 	if (copy_from_user(master->unique, u->unique, master->unique_len)) {
209 		ret = -EFAULT;
210 		goto err;
211 	}
212 
213 	master->unique[master->unique_len] = '\0';
214 
215 	bus_name = dev->driver->bus->get_name(dev);
216 	dev->devname = kmalloc(strlen(bus_name) +
217 			       strlen(master->unique) + 2, GFP_KERNEL);
218 	if (!dev->devname) {
219 		ret = -ENOMEM;
220 		goto err;
221 	}
222 
223 	sprintf(dev->devname, "%s@%s", bus_name,
224 		master->unique);
225 
226 	/* Return error if the busid submitted doesn't match the device's actual
227 	 * busid.
228 	 */
229 	ret = sscanf(master->unique, "PCI:%d:%d:%d", &bus, &slot, &func);
230 	if (ret != 3) {
231 		ret = -EINVAL;
232 		goto err;
233 	}
234 
235 	domain = bus >> 8;
236 	bus &= 0xff;
237 
238 	if ((domain != drm_get_pci_domain(dev)) ||
239 	    (bus != dev->pdev->bus->number) ||
240 	    (slot != PCI_SLOT(dev->pdev->devfn)) ||
241 	    (func != PCI_FUNC(dev->pdev->devfn))) {
242 		ret = -EINVAL;
243 		goto err;
244 	}
245 	return 0;
246 err:
247 	return ret;
248 }
249 
250 
251 static int drm_pci_irq_by_busid(struct drm_device *dev, struct drm_irq_busid *p)
252 {
253 	if ((p->busnum >> 8) != drm_get_pci_domain(dev) ||
254 	    (p->busnum & 0xff) != dev->pdev->bus->number ||
255 	    p->devnum != PCI_SLOT(dev->pdev->devfn) || p->funcnum != PCI_FUNC(dev->pdev->devfn))
256 		return -EINVAL;
257 
258 	p->irq = dev->pdev->irq;
259 
260 	DRM_DEBUG("%d:%d:%d => IRQ %d\n", p->busnum, p->devnum, p->funcnum,
261 		  p->irq);
262 	return 0;
263 }
264 
265 static void drm_pci_agp_init(struct drm_device *dev)
266 {
267 	if (drm_core_check_feature(dev, DRIVER_USE_AGP)) {
268 		if (drm_pci_device_is_agp(dev))
269 			dev->agp = drm_agp_init(dev);
270 		if (dev->agp) {
271 			dev->agp->agp_mtrr = arch_phys_wc_add(
272 				dev->agp->agp_info.aper_base,
273 				dev->agp->agp_info.aper_size *
274 				1024 * 1024);
275 		}
276 	}
277 }
278 
279 void drm_pci_agp_destroy(struct drm_device *dev)
280 {
281 	if (dev->agp) {
282 		arch_phys_wc_del(dev->agp->agp_mtrr);
283 		drm_agp_clear(dev);
284 		kfree(dev->agp);
285 		dev->agp = NULL;
286 	}
287 }
288 
289 static struct drm_bus drm_pci_bus = {
290 	.bus_type = DRIVER_BUS_PCI,
291 	.get_irq = drm_pci_get_irq,
292 	.get_name = drm_pci_get_name,
293 	.set_busid = drm_pci_set_busid,
294 	.set_unique = drm_pci_set_unique,
295 	.irq_by_busid = drm_pci_irq_by_busid,
296 };
297 
298 /**
299  * Register.
300  *
301  * \param pdev - PCI device structure
302  * \param ent entry from the PCI ID table with device type flags
303  * \return zero on success or a negative number on failure.
304  *
305  * Attempt to gets inter module "drm" information. If we are first
306  * then register the character device and inter module information.
307  * Try and register, if we fail to register, backout previous work.
308  */
309 int drm_get_pci_dev(struct pci_dev *pdev, const struct pci_device_id *ent,
310 		    struct drm_driver *driver)
311 {
312 	struct drm_device *dev;
313 	int ret;
314 
315 	DRM_DEBUG("\n");
316 
317 	dev = drm_dev_alloc(driver, &pdev->dev);
318 	if (!dev)
319 		return -ENOMEM;
320 
321 	ret = pci_enable_device(pdev);
322 	if (ret)
323 		goto err_free;
324 
325 	dev->pdev = pdev;
326 #ifdef __alpha__
327 	dev->hose = pdev->sysdata;
328 #endif
329 
330 	if (drm_core_check_feature(dev, DRIVER_MODESET))
331 		pci_set_drvdata(pdev, dev);
332 
333 	drm_pci_agp_init(dev);
334 
335 	ret = drm_dev_register(dev, ent->driver_data);
336 	if (ret)
337 		goto err_agp;
338 
339 	DRM_INFO("Initialized %s %d.%d.%d %s for %s on minor %d\n",
340 		 driver->name, driver->major, driver->minor, driver->patchlevel,
341 		 driver->date, pci_name(pdev), dev->primary->index);
342 
343 	/* No locking needed since shadow-attach is single-threaded since it may
344 	 * only be called from the per-driver module init hook. */
345 	if (!drm_core_check_feature(dev, DRIVER_MODESET))
346 		list_add_tail(&dev->legacy_dev_list, &driver->legacy_dev_list);
347 
348 	return 0;
349 
350 err_agp:
351 	drm_pci_agp_destroy(dev);
352 	pci_disable_device(pdev);
353 err_free:
354 	drm_dev_unref(dev);
355 	return ret;
356 }
357 EXPORT_SYMBOL(drm_get_pci_dev);
358 
359 /**
360  * PCI device initialization. Called direct from modules at load time.
361  *
362  * \return zero on success or a negative number on failure.
363  *
364  * Initializes a drm_device structures,registering the
365  * stubs and initializing the AGP device.
366  *
367  * Expands the \c DRIVER_PREINIT and \c DRIVER_POST_INIT macros before and
368  * after the initialization for driver customization.
369  */
370 int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver)
371 {
372 	struct pci_dev *pdev = NULL;
373 	const struct pci_device_id *pid;
374 	int i;
375 
376 	DRM_DEBUG("\n");
377 
378 	driver->kdriver.pci = pdriver;
379 	driver->bus = &drm_pci_bus;
380 
381 	if (driver->driver_features & DRIVER_MODESET)
382 		return pci_register_driver(pdriver);
383 
384 	/* If not using KMS, fall back to stealth mode manual scanning. */
385 	INIT_LIST_HEAD(&driver->legacy_dev_list);
386 	for (i = 0; pdriver->id_table[i].vendor != 0; i++) {
387 		pid = &pdriver->id_table[i];
388 
389 		/* Loop around setting up a DRM device for each PCI device
390 		 * matching our ID and device class.  If we had the internal
391 		 * function that pci_get_subsys and pci_get_class used, we'd
392 		 * be able to just pass pid in instead of doing a two-stage
393 		 * thing.
394 		 */
395 		pdev = NULL;
396 		while ((pdev =
397 			pci_get_subsys(pid->vendor, pid->device, pid->subvendor,
398 				       pid->subdevice, pdev)) != NULL) {
399 			if ((pdev->class & pid->class_mask) != pid->class)
400 				continue;
401 
402 			/* stealth mode requires a manual probe */
403 			pci_dev_get(pdev);
404 			drm_get_pci_dev(pdev, pid, driver);
405 		}
406 	}
407 	return 0;
408 }
409 
410 int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *mask)
411 {
412 	struct pci_dev *root;
413 	u32 lnkcap, lnkcap2;
414 
415 	*mask = 0;
416 	if (!dev->pdev)
417 		return -EINVAL;
418 
419 	root = dev->pdev->bus->self;
420 
421 	/* we've been informed via and serverworks don't make the cut */
422 	if (root->vendor == PCI_VENDOR_ID_VIA ||
423 	    root->vendor == PCI_VENDOR_ID_SERVERWORKS)
424 		return -EINVAL;
425 
426 	pcie_capability_read_dword(root, PCI_EXP_LNKCAP, &lnkcap);
427 	pcie_capability_read_dword(root, PCI_EXP_LNKCAP2, &lnkcap2);
428 
429 	if (lnkcap2) {	/* PCIe r3.0-compliant */
430 		if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_2_5GB)
431 			*mask |= DRM_PCIE_SPEED_25;
432 		if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_5_0GB)
433 			*mask |= DRM_PCIE_SPEED_50;
434 		if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_8_0GB)
435 			*mask |= DRM_PCIE_SPEED_80;
436 	} else {	/* pre-r3.0 */
437 		if (lnkcap & PCI_EXP_LNKCAP_SLS_2_5GB)
438 			*mask |= DRM_PCIE_SPEED_25;
439 		if (lnkcap & PCI_EXP_LNKCAP_SLS_5_0GB)
440 			*mask |= (DRM_PCIE_SPEED_25 | DRM_PCIE_SPEED_50);
441 	}
442 
443 	DRM_INFO("probing gen 2 caps for device %x:%x = %x/%x\n", root->vendor, root->device, lnkcap, lnkcap2);
444 	return 0;
445 }
446 EXPORT_SYMBOL(drm_pcie_get_speed_cap_mask);
447 
448 #else
449 
450 int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver)
451 {
452 	return -1;
453 }
454 
455 void drm_pci_agp_destroy(struct drm_device *dev) {}
456 #endif
457 
458 EXPORT_SYMBOL(drm_pci_init);
459 
460 /*@}*/
461 void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver)
462 {
463 	struct drm_device *dev, *tmp;
464 	DRM_DEBUG("\n");
465 
466 	if (driver->driver_features & DRIVER_MODESET) {
467 		pci_unregister_driver(pdriver);
468 	} else {
469 		list_for_each_entry_safe(dev, tmp, &driver->legacy_dev_list,
470 					 legacy_dev_list) {
471 			list_del(&dev->legacy_dev_list);
472 			drm_put_dev(dev);
473 		}
474 	}
475 	DRM_INFO("Module unloaded\n");
476 }
477 EXPORT_SYMBOL(drm_pci_exit);
478