xref: /freebsd/sys/compat/linuxkpi/common/src/linux_pci.c (revision 396c556d77189a5c474d35cec6f44a762e310b7d)
1 /*-
2  * Copyright (c) 2015-2016 Mellanox Technologies, Ltd.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 #include <sys/systm.h>
32 #include <sys/malloc.h>
33 #include <sys/kernel.h>
34 #include <sys/sysctl.h>
35 #include <sys/lock.h>
36 #include <sys/mutex.h>
37 #include <sys/bus.h>
38 #include <sys/fcntl.h>
39 #include <sys/file.h>
40 #include <sys/filio.h>
41 #include <sys/rwlock.h>
42 
43 #include <vm/vm.h>
44 #include <vm/pmap.h>
45 
46 #include <machine/stdarg.h>
47 
48 #include <linux/kobject.h>
49 #include <linux/device.h>
50 #include <linux/slab.h>
51 #include <linux/module.h>
52 #include <linux/cdev.h>
53 #include <linux/file.h>
54 #include <linux/sysfs.h>
55 #include <linux/mm.h>
56 #include <linux/io.h>
57 #include <linux/vmalloc.h>
58 #include <linux/pci.h>
59 #include <linux/compat.h>
60 
61 static device_probe_t linux_pci_probe;
62 static device_attach_t linux_pci_attach;
63 static device_detach_t linux_pci_detach;
64 static device_suspend_t linux_pci_suspend;
65 static device_resume_t linux_pci_resume;
66 static device_shutdown_t linux_pci_shutdown;
67 
68 static device_method_t pci_methods[] = {
69 	DEVMETHOD(device_probe, linux_pci_probe),
70 	DEVMETHOD(device_attach, linux_pci_attach),
71 	DEVMETHOD(device_detach, linux_pci_detach),
72 	DEVMETHOD(device_suspend, linux_pci_suspend),
73 	DEVMETHOD(device_resume, linux_pci_resume),
74 	DEVMETHOD(device_shutdown, linux_pci_shutdown),
75 	DEVMETHOD_END
76 };
77 
78 static struct pci_driver *
79 linux_pci_find(device_t dev, const struct pci_device_id **idp)
80 {
81 	const struct pci_device_id *id;
82 	struct pci_driver *pdrv;
83 	uint16_t vendor;
84 	uint16_t device;
85 
86 	vendor = pci_get_vendor(dev);
87 	device = pci_get_device(dev);
88 
89 	spin_lock(&pci_lock);
90 	list_for_each_entry(pdrv, &pci_drivers, links) {
91 		for (id = pdrv->id_table; id->vendor != 0; id++) {
92 			if (vendor == id->vendor && device == id->device) {
93 				*idp = id;
94 				spin_unlock(&pci_lock);
95 				return (pdrv);
96 			}
97 		}
98 	}
99 	spin_unlock(&pci_lock);
100 	return (NULL);
101 }
102 
103 static int
104 linux_pci_probe(device_t dev)
105 {
106 	const struct pci_device_id *id;
107 	struct pci_driver *pdrv;
108 
109 	if ((pdrv = linux_pci_find(dev, &id)) == NULL)
110 		return (ENXIO);
111 	if (device_get_driver(dev) != &pdrv->bsddriver)
112 		return (ENXIO);
113 	device_set_desc(dev, pdrv->name);
114 	return (0);
115 }
116 
117 static int
118 linux_pci_attach(device_t dev)
119 {
120 	struct resource_list_entry *rle;
121 	struct pci_bus *pbus;
122 	struct pci_dev *pdev;
123 	struct pci_devinfo *dinfo;
124 	struct pci_driver *pdrv;
125 	const struct pci_device_id *id;
126 	device_t parent;
127 	devclass_t devclass;
128 	int error;
129 
130 	linux_set_current(curthread);
131 
132 	pdrv = linux_pci_find(dev, &id);
133 	pdev = device_get_softc(dev);
134 
135 	parent = device_get_parent(dev);
136 	devclass = device_get_devclass(parent);
137 	if (pdrv->isdrm) {
138 		dinfo = device_get_ivars(parent);
139 		device_set_ivars(dev, dinfo);
140 	} else {
141 		dinfo = device_get_ivars(dev);
142 	}
143 
144 	pdev->dev.parent = &linux_root_device;
145 	pdev->dev.bsddev = dev;
146 	INIT_LIST_HEAD(&pdev->dev.irqents);
147 	pdev->devfn = PCI_DEVFN(pci_get_slot(dev), pci_get_function(dev));
148 	pdev->device = id->device;
149 	pdev->vendor = id->vendor;
150 	pdev->subsystem_vendor = dinfo->cfg.subvendor;
151 	pdev->subsystem_device = dinfo->cfg.subdevice;
152 	pdev->class = pci_get_class(dev);
153 	pdev->revision = pci_get_revid(dev);
154 	pdev->dev.dma_mask = &pdev->dma_mask;
155 	pdev->pdrv = pdrv;
156 	kobject_init(&pdev->dev.kobj, &linux_dev_ktype);
157 	kobject_set_name(&pdev->dev.kobj, device_get_nameunit(dev));
158 	kobject_add(&pdev->dev.kobj, &linux_root_device.kobj,
159 	    kobject_name(&pdev->dev.kobj));
160 	rle = linux_pci_get_rle(pdev, SYS_RES_IRQ, 0);
161 	if (rle != NULL)
162 		pdev->dev.irq = rle->start;
163 	else
164 		pdev->dev.irq = LINUX_IRQ_INVALID;
165 	pdev->irq = pdev->dev.irq;
166 
167 	if (pdev->bus == NULL) {
168 		pbus = malloc(sizeof(*pbus), M_DEVBUF, M_WAITOK | M_ZERO);
169 		pbus->self = pdev;
170 		pbus->number = pci_get_bus(dev);
171 		pdev->bus = pbus;
172 	}
173 
174 	DROP_GIANT();
175 	spin_lock(&pci_lock);
176 	list_add(&pdev->links, &pci_devices);
177 	spin_unlock(&pci_lock);
178 	error = pdrv->probe(pdev, id);
179 	PICKUP_GIANT();
180 	if (error) {
181 		spin_lock(&pci_lock);
182 		list_del(&pdev->links);
183 		spin_unlock(&pci_lock);
184 		put_device(&pdev->dev);
185 		error = -error;
186 	}
187 	return (error);
188 }
189 
190 static int
191 linux_pci_detach(device_t dev)
192 {
193 	struct pci_dev *pdev;
194 
195 	linux_set_current(curthread);
196 	pdev = device_get_softc(dev);
197 	DROP_GIANT();
198 	pdev->pdrv->remove(pdev);
199 	PICKUP_GIANT();
200 	spin_lock(&pci_lock);
201 	list_del(&pdev->links);
202 	spin_unlock(&pci_lock);
203 	put_device(&pdev->dev);
204 
205 	return (0);
206 }
207 
208 static int
209 linux_pci_suspend(device_t dev)
210 {
211 	const struct dev_pm_ops *pmops;
212 	struct pm_message pm = { };
213 	struct pci_dev *pdev;
214 	int error;
215 
216 	error = 0;
217 	linux_set_current(curthread);
218 	pdev = device_get_softc(dev);
219 	pmops = pdev->pdrv->driver.pm;
220 
221 	if (pdev->pdrv->suspend != NULL)
222 		error = -pdev->pdrv->suspend(pdev, pm);
223 	else if (pmops != NULL && pmops->suspend != NULL) {
224 		error = -pmops->suspend(&pdev->dev);
225 		if (error == 0 && pmops->suspend_late != NULL)
226 			error = -pmops->suspend_late(&pdev->dev);
227 	}
228 	return (error);
229 }
230 
231 static int
232 linux_pci_resume(device_t dev)
233 {
234 	const struct dev_pm_ops *pmops;
235 	struct pci_dev *pdev;
236 	int error;
237 
238 	error = 0;
239 	linux_set_current(curthread);
240 	pdev = device_get_softc(dev);
241 	pmops = pdev->pdrv->driver.pm;
242 
243 	if (pdev->pdrv->resume != NULL)
244 		error = -pdev->pdrv->resume(pdev);
245 	else if (pmops != NULL && pmops->resume != NULL) {
246 		if (pmops->resume_early != NULL)
247 			error = -pmops->resume_early(&pdev->dev);
248 		if (error == 0 && pmops->resume != NULL)
249 			error = -pmops->resume(&pdev->dev);
250 	}
251 	return (error);
252 }
253 
254 static int
255 linux_pci_shutdown(device_t dev)
256 {
257 	struct pci_dev *pdev;
258 
259 	linux_set_current(curthread);
260 	pdev = device_get_softc(dev);
261 	if (pdev->pdrv->shutdown != NULL) {
262 		DROP_GIANT();
263 		pdev->pdrv->shutdown(pdev);
264 		PICKUP_GIANT();
265 	}
266 	return (0);
267 }
268 
269 static int
270 _linux_pci_register_driver(struct pci_driver *pdrv, devclass_t dc)
271 {
272 	int error;
273 
274 	linux_set_current(curthread);
275 	spin_lock(&pci_lock);
276 	list_add(&pdrv->links, &pci_drivers);
277 	spin_unlock(&pci_lock);
278 	pdrv->bsddriver.name = pdrv->name;
279 	pdrv->bsddriver.methods = pci_methods;
280 	pdrv->bsddriver.size = sizeof(struct pci_dev);
281 
282 	mtx_lock(&Giant);
283 	error = devclass_add_driver(dc, &pdrv->bsddriver,
284 	    BUS_PASS_DEFAULT, &pdrv->bsdclass);
285 	mtx_unlock(&Giant);
286 	return (-error);
287 }
288 
289 int
290 linux_pci_register_driver(struct pci_driver *pdrv)
291 {
292 	devclass_t dc;
293 
294 	dc = devclass_find("pci");
295 	if (dc == NULL)
296 		return (-ENXIO);
297 	pdrv->isdrm = false;
298 	return (_linux_pci_register_driver(pdrv, dc));
299 }
300 
301 int
302 linux_pci_register_drm_driver(struct pci_driver *pdrv)
303 {
304 	devclass_t dc;
305 
306 	dc = devclass_create("vgapci");
307 	if (dc == NULL)
308 		return (-ENXIO);
309 	pdrv->isdrm = true;
310 	pdrv->name = "drmn";
311 	return (_linux_pci_register_driver(pdrv, dc));
312 }
313 
314 void
315 linux_pci_unregister_driver(struct pci_driver *pdrv)
316 {
317 	devclass_t bus;
318 
319 	bus = devclass_find("pci");
320 
321 	spin_lock(&pci_lock);
322 	list_del(&pdrv->links);
323 	spin_unlock(&pci_lock);
324 	mtx_lock(&Giant);
325 	if (bus != NULL)
326 		devclass_delete_driver(bus, &pdrv->bsddriver);
327 	mtx_unlock(&Giant);
328 }
329