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