xref: /freebsd/sys/compat/linuxkpi/common/include/linux/pci.h (revision cfd6422a5217410fbd66f7a7a8a64d9d85e61229)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013-2016 Mellanox Technologies, Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  *
29  * $FreeBSD$
30  */
31 #ifndef	_LINUX_PCI_H_
32 #define	_LINUX_PCI_H_
33 
34 #define	CONFIG_PCI_MSI
35 
36 #include <linux/types.h>
37 
38 #include <sys/param.h>
39 #include <sys/bus.h>
40 #include <sys/nv.h>
41 #include <sys/pciio.h>
42 #include <sys/rman.h>
43 #include <sys/bus.h>
44 #include <dev/pci/pcivar.h>
45 #include <dev/pci/pcireg.h>
46 #include <dev/pci/pci_private.h>
47 
48 #include <machine/resource.h>
49 
50 #include <linux/list.h>
51 #include <linux/dmapool.h>
52 #include <linux/dma-mapping.h>
53 #include <linux/compiler.h>
54 #include <linux/errno.h>
55 #include <asm/atomic.h>
56 #include <linux/device.h>
57 
58 struct pci_device_id {
59 	uint32_t	vendor;
60 	uint32_t	device;
61 	uint32_t	subvendor;
62 	uint32_t	subdevice;
63 	uint32_t	class;
64 	uint32_t	class_mask;
65 	uintptr_t	driver_data;
66 };
67 
68 #define	MODULE_DEVICE_TABLE(bus, table)
69 
70 #define	PCI_BASE_CLASS_DISPLAY		0x03
71 #define	PCI_CLASS_DISPLAY_VGA		0x0300
72 #define	PCI_CLASS_DISPLAY_OTHER		0x0380
73 #define	PCI_BASE_CLASS_BRIDGE		0x06
74 #define	PCI_CLASS_BRIDGE_ISA		0x0601
75 
76 #define	PCI_ANY_ID			-1U
77 #define	PCI_VENDOR_ID_APPLE		0x106b
78 #define	PCI_VENDOR_ID_ASUSTEK		0x1043
79 #define	PCI_VENDOR_ID_ATI		0x1002
80 #define	PCI_VENDOR_ID_DELL		0x1028
81 #define	PCI_VENDOR_ID_HP		0x103c
82 #define	PCI_VENDOR_ID_IBM		0x1014
83 #define	PCI_VENDOR_ID_INTEL		0x8086
84 #define	PCI_VENDOR_ID_MELLANOX			0x15b3
85 #define	PCI_VENDOR_ID_REDHAT_QUMRANET	0x1af4
86 #define	PCI_VENDOR_ID_SERVERWORKS	0x1166
87 #define	PCI_VENDOR_ID_SONY		0x104d
88 #define	PCI_VENDOR_ID_TOPSPIN			0x1867
89 #define	PCI_VENDOR_ID_VIA		0x1106
90 #define	PCI_SUBVENDOR_ID_REDHAT_QUMRANET	0x1af4
91 #define	PCI_DEVICE_ID_ATI_RADEON_QY	0x5159
92 #define	PCI_DEVICE_ID_MELLANOX_TAVOR		0x5a44
93 #define	PCI_DEVICE_ID_MELLANOX_TAVOR_BRIDGE	0x5a46
94 #define	PCI_DEVICE_ID_MELLANOX_ARBEL_COMPAT	0x6278
95 #define	PCI_DEVICE_ID_MELLANOX_ARBEL		0x6282
96 #define	PCI_DEVICE_ID_MELLANOX_SINAI_OLD	0x5e8c
97 #define	PCI_DEVICE_ID_MELLANOX_SINAI		0x6274
98 #define	PCI_SUBDEVICE_ID_QEMU		0x1100
99 
100 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
101 #define PCI_SLOT(devfn)		(((devfn) >> 3) & 0x1f)
102 #define PCI_FUNC(devfn)		((devfn) & 0x07)
103 #define	PCI_BUS_NUM(devfn)	(((devfn) >> 8) & 0xff)
104 
105 #define PCI_VDEVICE(_vendor, _device)					\
106 	    .vendor = PCI_VENDOR_ID_##_vendor, .device = (_device),	\
107 	    .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
108 #define	PCI_DEVICE(_vendor, _device)					\
109 	    .vendor = (_vendor), .device = (_device),			\
110 	    .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
111 
112 #define	to_pci_dev(n)	container_of(n, struct pci_dev, dev)
113 
114 #define	PCI_VENDOR_ID		PCIR_DEVVENDOR
115 #define	PCI_COMMAND		PCIR_COMMAND
116 #define	PCI_EXP_DEVCTL		PCIER_DEVICE_CTL		/* Device Control */
117 #define	PCI_EXP_LNKCTL		PCIER_LINK_CTL			/* Link Control */
118 #define	PCI_EXP_FLAGS_TYPE	PCIEM_FLAGS_TYPE		/* Device/Port type */
119 #define	PCI_EXP_DEVCAP		PCIER_DEVICE_CAP		/* Device capabilities */
120 #define	PCI_EXP_DEVSTA		PCIER_DEVICE_STA		/* Device Status */
121 #define	PCI_EXP_LNKCAP		PCIER_LINK_CAP			/* Link Capabilities */
122 #define	PCI_EXP_LNKSTA		PCIER_LINK_STA			/* Link Status */
123 #define	PCI_EXP_SLTCAP		PCIER_SLOT_CAP			/* Slot Capabilities */
124 #define	PCI_EXP_SLTCTL		PCIER_SLOT_CTL			/* Slot Control */
125 #define	PCI_EXP_SLTSTA		PCIER_SLOT_STA			/* Slot Status */
126 #define	PCI_EXP_RTCTL		PCIER_ROOT_CTL			/* Root Control */
127 #define	PCI_EXP_RTCAP		PCIER_ROOT_CAP			/* Root Capabilities */
128 #define	PCI_EXP_RTSTA		PCIER_ROOT_STA			/* Root Status */
129 #define	PCI_EXP_DEVCAP2		PCIER_DEVICE_CAP2		/* Device Capabilities 2 */
130 #define	PCI_EXP_DEVCTL2		PCIER_DEVICE_CTL2		/* Device Control 2 */
131 #define	PCI_EXP_LNKCAP2		PCIER_LINK_CAP2			/* Link Capabilities 2 */
132 #define	PCI_EXP_LNKCTL2		PCIER_LINK_CTL2			/* Link Control 2 */
133 #define	PCI_EXP_LNKSTA2		PCIER_LINK_STA2			/* Link Status 2 */
134 #define	PCI_EXP_FLAGS		PCIER_FLAGS			/* Capabilities register */
135 #define	PCI_EXP_FLAGS_VERS	PCIEM_FLAGS_VERSION		/* Capability version */
136 #define	PCI_EXP_TYPE_ROOT_PORT	PCIEM_TYPE_ROOT_PORT		/* Root Port */
137 #define	PCI_EXP_TYPE_ENDPOINT	PCIEM_TYPE_ENDPOINT		/* Express Endpoint */
138 #define	PCI_EXP_TYPE_LEG_END	PCIEM_TYPE_LEGACY_ENDPOINT	/* Legacy Endpoint */
139 #define	PCI_EXP_TYPE_DOWNSTREAM PCIEM_TYPE_DOWNSTREAM_PORT	/* Downstream Port */
140 #define	PCI_EXP_FLAGS_SLOT	PCIEM_FLAGS_SLOT		/* Slot implemented */
141 #define	PCI_EXP_TYPE_RC_EC	PCIEM_TYPE_ROOT_EC		/* Root Complex Event Collector */
142 #define	PCI_EXP_LNKCAP_SLS_2_5GB 0x01	/* Supported Link Speed 2.5GT/s */
143 #define	PCI_EXP_LNKCAP_SLS_5_0GB 0x02	/* Supported Link Speed 5.0GT/s */
144 #define	PCI_EXP_LNKCAP_SLS_8_0GB 0x04	/* Supported Link Speed 8.0GT/s */
145 #define	PCI_EXP_LNKCAP_SLS_16_0GB 0x08	/* Supported Link Speed 16.0GT/s */
146 #define	PCI_EXP_LNKCAP_MLW	0x03f0	/* Maximum Link Width */
147 #define	PCI_EXP_LNKCAP2_SLS_2_5GB 0x02	/* Supported Link Speed 2.5GT/s */
148 #define	PCI_EXP_LNKCAP2_SLS_5_0GB 0x04	/* Supported Link Speed 5.0GT/s */
149 #define	PCI_EXP_LNKCAP2_SLS_8_0GB 0x08	/* Supported Link Speed 8.0GT/s */
150 #define	PCI_EXP_LNKCAP2_SLS_16_0GB 0x10	/* Supported Link Speed 16.0GT/s */
151 
152 #define PCI_EXP_LNKCTL_HAWD	PCIEM_LINK_CTL_HAWD
153 #define PCI_EXP_LNKCAP_CLKPM	0x00040000
154 #define PCI_EXP_DEVSTA_TRPND	0x0020
155 
156 #define	IORESOURCE_MEM	(1 << SYS_RES_MEMORY)
157 #define	IORESOURCE_IO	(1 << SYS_RES_IOPORT)
158 #define	IORESOURCE_IRQ	(1 << SYS_RES_IRQ)
159 
160 enum pci_bus_speed {
161 	PCI_SPEED_UNKNOWN = -1,
162 	PCIE_SPEED_2_5GT,
163 	PCIE_SPEED_5_0GT,
164 	PCIE_SPEED_8_0GT,
165 	PCIE_SPEED_16_0GT,
166 };
167 
168 enum pcie_link_width {
169 	PCIE_LNK_WIDTH_RESRV	= 0x00,
170 	PCIE_LNK_X1		= 0x01,
171 	PCIE_LNK_X2		= 0x02,
172 	PCIE_LNK_X4		= 0x04,
173 	PCIE_LNK_X8		= 0x08,
174 	PCIE_LNK_X12		= 0x0c,
175 	PCIE_LNK_X16		= 0x10,
176 	PCIE_LNK_X32		= 0x20,
177 	PCIE_LNK_WIDTH_UNKNOWN	= 0xff,
178 };
179 
180 typedef int pci_power_t;
181 
182 #define PCI_D0	PCI_POWERSTATE_D0
183 #define PCI_D1	PCI_POWERSTATE_D1
184 #define PCI_D2	PCI_POWERSTATE_D2
185 #define PCI_D3hot	PCI_POWERSTATE_D3
186 #define PCI_D3cold	4
187 
188 #define PCI_POWER_ERROR	PCI_POWERSTATE_UNKNOWN
189 
190 struct pci_dev;
191 
192 struct pci_driver {
193 	struct list_head		links;
194 	char				*name;
195 	const struct pci_device_id		*id_table;
196 	int  (*probe)(struct pci_dev *dev, const struct pci_device_id *id);
197 	void (*remove)(struct pci_dev *dev);
198 	int  (*suspend) (struct pci_dev *dev, pm_message_t state);	/* Device suspended */
199 	int  (*resume) (struct pci_dev *dev);		/* Device woken up */
200 	void (*shutdown) (struct pci_dev *dev);		/* Device shutdown */
201 	driver_t			bsddriver;
202 	devclass_t			bsdclass;
203 	struct device_driver		driver;
204 	const struct pci_error_handlers       *err_handler;
205 	bool				isdrm;
206 	int  (*bsd_iov_init)(device_t dev, uint16_t num_vfs,
207 	    const nvlist_t *pf_config);
208 	void  (*bsd_iov_uninit)(device_t dev);
209 	int  (*bsd_iov_add_vf)(device_t dev, uint16_t vfnum,
210 	    const nvlist_t *vf_config);
211 };
212 
213 struct pci_bus {
214 	struct pci_dev	*self;
215 	int		domain;
216 	int		number;
217 };
218 
219 extern struct list_head pci_drivers;
220 extern struct list_head pci_devices;
221 extern spinlock_t pci_lock;
222 
223 #define	__devexit_p(x)	x
224 
225 struct pci_mmio_region {
226 	TAILQ_ENTRY(pci_mmio_region)	next;
227 	struct resource			*res;
228 	int				rid;
229 	int				type;
230 };
231 
232 struct pci_dev {
233 	struct device		dev;
234 	struct list_head	links;
235 	struct pci_driver	*pdrv;
236 	struct pci_bus		*bus;
237 	uint16_t		device;
238 	uint16_t		vendor;
239 	uint16_t		subsystem_vendor;
240 	uint16_t		subsystem_device;
241 	unsigned int		irq;
242 	unsigned int		devfn;
243 	uint32_t		class;
244 	uint8_t			revision;
245 	bool			msi_enabled;
246 
247 	TAILQ_HEAD(, pci_mmio_region)	mmio;
248 };
249 
250 static inline struct resource_list_entry *
251 linux_pci_get_rle(struct pci_dev *pdev, int type, int rid)
252 {
253 	struct pci_devinfo *dinfo;
254 	struct resource_list *rl;
255 
256 	dinfo = device_get_ivars(pdev->dev.bsddev);
257 	rl = &dinfo->resources;
258 	return resource_list_find(rl, type, rid);
259 }
260 
261 static inline struct resource_list_entry *
262 linux_pci_get_bar(struct pci_dev *pdev, int bar)
263 {
264 	struct resource_list_entry *rle;
265 
266 	bar = PCIR_BAR(bar);
267 	if ((rle = linux_pci_get_rle(pdev, SYS_RES_MEMORY, bar)) == NULL)
268 		rle = linux_pci_get_rle(pdev, SYS_RES_IOPORT, bar);
269 	return (rle);
270 }
271 
272 static inline struct device *
273 linux_pci_find_irq_dev(unsigned int irq)
274 {
275 	struct pci_dev *pdev;
276 	struct device *found;
277 
278 	found = NULL;
279 	spin_lock(&pci_lock);
280 	list_for_each_entry(pdev, &pci_devices, links) {
281 		if (irq == pdev->dev.irq ||
282 		    (irq >= pdev->dev.irq_start && irq < pdev->dev.irq_end)) {
283 			found = &pdev->dev;
284 			break;
285 		}
286 	}
287 	spin_unlock(&pci_lock);
288 	return (found);
289 }
290 
291 static inline int
292 pci_resource_type(struct pci_dev *pdev, int bar)
293 {
294 	struct pci_map *pm;
295 
296 	pm = pci_find_bar(pdev->dev.bsddev, PCIR_BAR(bar));
297 	if (!pm)
298 		return (-1);
299 
300 	if (PCI_BAR_IO(pm->pm_value))
301 		return (SYS_RES_IOPORT);
302 	else
303 		return (SYS_RES_MEMORY);
304 }
305 
306 /*
307  * All drivers just seem to want to inspect the type not flags.
308  */
309 static inline int
310 pci_resource_flags(struct pci_dev *pdev, int bar)
311 {
312 	int type;
313 
314 	type = pci_resource_type(pdev, bar);
315 	if (type < 0)
316 		return (0);
317 	return (1 << type);
318 }
319 
320 static inline const char *
321 pci_name(struct pci_dev *d)
322 {
323 
324 	return device_get_desc(d->dev.bsddev);
325 }
326 
327 static inline void *
328 pci_get_drvdata(struct pci_dev *pdev)
329 {
330 
331 	return dev_get_drvdata(&pdev->dev);
332 }
333 
334 static inline void
335 pci_set_drvdata(struct pci_dev *pdev, void *data)
336 {
337 
338 	dev_set_drvdata(&pdev->dev, data);
339 }
340 
341 static inline int
342 pci_enable_device(struct pci_dev *pdev)
343 {
344 
345 	pci_enable_io(pdev->dev.bsddev, SYS_RES_IOPORT);
346 	pci_enable_io(pdev->dev.bsddev, SYS_RES_MEMORY);
347 	return (0);
348 }
349 
350 static inline void
351 pci_disable_device(struct pci_dev *pdev)
352 {
353 
354 	pci_disable_busmaster(pdev->dev.bsddev);
355 }
356 
357 static inline int
358 pci_set_master(struct pci_dev *pdev)
359 {
360 
361 	pci_enable_busmaster(pdev->dev.bsddev);
362 	return (0);
363 }
364 
365 static inline int
366 pci_set_power_state(struct pci_dev *pdev, int state)
367 {
368 
369 	pci_set_powerstate(pdev->dev.bsddev, state);
370 	return (0);
371 }
372 
373 static inline int
374 pci_clear_master(struct pci_dev *pdev)
375 {
376 
377 	pci_disable_busmaster(pdev->dev.bsddev);
378 	return (0);
379 }
380 
381 static inline int
382 pci_request_region(struct pci_dev *pdev, int bar, const char *res_name)
383 {
384 	int rid;
385 	int type;
386 
387 	type = pci_resource_type(pdev, bar);
388 	if (type < 0)
389 		return (-ENODEV);
390 	rid = PCIR_BAR(bar);
391 	if (bus_alloc_resource_any(pdev->dev.bsddev, type, &rid,
392 	    RF_ACTIVE) == NULL)
393 		return (-EINVAL);
394 	return (0);
395 }
396 
397 static inline void
398 pci_release_region(struct pci_dev *pdev, int bar)
399 {
400 	struct resource_list_entry *rle;
401 
402 	if ((rle = linux_pci_get_bar(pdev, bar)) == NULL)
403 		return;
404 	bus_release_resource(pdev->dev.bsddev, rle->type, rle->rid, rle->res);
405 }
406 
407 static inline void
408 pci_release_regions(struct pci_dev *pdev)
409 {
410 	int i;
411 
412 	for (i = 0; i <= PCIR_MAX_BAR_0; i++)
413 		pci_release_region(pdev, i);
414 }
415 
416 static inline int
417 pci_request_regions(struct pci_dev *pdev, const char *res_name)
418 {
419 	int error;
420 	int i;
421 
422 	for (i = 0; i <= PCIR_MAX_BAR_0; i++) {
423 		error = pci_request_region(pdev, i, res_name);
424 		if (error && error != -ENODEV) {
425 			pci_release_regions(pdev);
426 			return (error);
427 		}
428 	}
429 	return (0);
430 }
431 
432 static inline void
433 pci_disable_msix(struct pci_dev *pdev)
434 {
435 
436 	pci_release_msi(pdev->dev.bsddev);
437 
438 	/*
439 	 * The MSIX IRQ numbers associated with this PCI device are no
440 	 * longer valid and might be re-assigned. Make sure
441 	 * linux_pci_find_irq_dev() does no longer see them by
442 	 * resetting their references to zero:
443 	 */
444 	pdev->dev.irq_start = 0;
445 	pdev->dev.irq_end = 0;
446 }
447 
448 #define	pci_disable_msi(pdev) \
449   linux_pci_disable_msi(pdev)
450 
451 static inline void
452 linux_pci_disable_msi(struct pci_dev *pdev)
453 {
454 
455 	pci_release_msi(pdev->dev.bsddev);
456 
457 	pdev->dev.irq_start = 0;
458 	pdev->dev.irq_end = 0;
459 	pdev->irq = pdev->dev.irq;
460 	pdev->msi_enabled = false;
461 }
462 
463 #define	pci_free_irq_vectors(pdev) \
464 	linux_pci_disable_msi(pdev)
465 
466 unsigned long	pci_resource_start(struct pci_dev *pdev, int bar);
467 unsigned long	pci_resource_len(struct pci_dev *pdev, int bar);
468 
469 static inline bus_addr_t
470 pci_bus_address(struct pci_dev *pdev, int bar)
471 {
472 
473 	return (pci_resource_start(pdev, bar));
474 }
475 
476 #define	PCI_CAP_ID_EXP	PCIY_EXPRESS
477 #define	PCI_CAP_ID_PCIX	PCIY_PCIX
478 #define PCI_CAP_ID_AGP  PCIY_AGP
479 #define PCI_CAP_ID_PM   PCIY_PMG
480 
481 #define PCI_EXP_DEVCTL		PCIER_DEVICE_CTL
482 #define PCI_EXP_DEVCTL_PAYLOAD	PCIEM_CTL_MAX_PAYLOAD
483 #define PCI_EXP_DEVCTL_READRQ	PCIEM_CTL_MAX_READ_REQUEST
484 #define PCI_EXP_LNKCTL		PCIER_LINK_CTL
485 #define PCI_EXP_LNKSTA		PCIER_LINK_STA
486 
487 static inline int
488 pci_find_capability(struct pci_dev *pdev, int capid)
489 {
490 	int reg;
491 
492 	if (pci_find_cap(pdev->dev.bsddev, capid, &reg))
493 		return (0);
494 	return (reg);
495 }
496 
497 static inline int pci_pcie_cap(struct pci_dev *dev)
498 {
499 	return pci_find_capability(dev, PCI_CAP_ID_EXP);
500 }
501 
502 static inline int
503 pci_read_config_byte(struct pci_dev *pdev, int where, u8 *val)
504 {
505 
506 	*val = (u8)pci_read_config(pdev->dev.bsddev, where, 1);
507 	return (0);
508 }
509 
510 static inline int
511 pci_read_config_word(struct pci_dev *pdev, int where, u16 *val)
512 {
513 
514 	*val = (u16)pci_read_config(pdev->dev.bsddev, where, 2);
515 	return (0);
516 }
517 
518 static inline int
519 pci_read_config_dword(struct pci_dev *pdev, int where, u32 *val)
520 {
521 
522 	*val = (u32)pci_read_config(pdev->dev.bsddev, where, 4);
523 	return (0);
524 }
525 
526 static inline int
527 pci_write_config_byte(struct pci_dev *pdev, int where, u8 val)
528 {
529 
530 	pci_write_config(pdev->dev.bsddev, where, val, 1);
531 	return (0);
532 }
533 
534 static inline int
535 pci_write_config_word(struct pci_dev *pdev, int where, u16 val)
536 {
537 
538 	pci_write_config(pdev->dev.bsddev, where, val, 2);
539 	return (0);
540 }
541 
542 static inline int
543 pci_write_config_dword(struct pci_dev *pdev, int where, u32 val)
544 {
545 
546 	pci_write_config(pdev->dev.bsddev, where, val, 4);
547 	return (0);
548 }
549 
550 int	linux_pci_register_driver(struct pci_driver *pdrv);
551 int	linux_pci_register_drm_driver(struct pci_driver *pdrv);
552 void	linux_pci_unregister_driver(struct pci_driver *pdrv);
553 void	linux_pci_unregister_drm_driver(struct pci_driver *pdrv);
554 
555 #define	pci_register_driver(pdrv)	linux_pci_register_driver(pdrv)
556 #define	pci_unregister_driver(pdrv)	linux_pci_unregister_driver(pdrv)
557 
558 struct msix_entry {
559 	int entry;
560 	int vector;
561 };
562 
563 /*
564  * Enable msix, positive errors indicate actual number of available
565  * vectors.  Negative errors are failures.
566  *
567  * NB: define added to prevent this definition of pci_enable_msix from
568  * clashing with the native FreeBSD version.
569  */
570 #define	pci_enable_msix(...) \
571   linux_pci_enable_msix(__VA_ARGS__)
572 
573 static inline int
574 pci_enable_msix(struct pci_dev *pdev, struct msix_entry *entries, int nreq)
575 {
576 	struct resource_list_entry *rle;
577 	int error;
578 	int avail;
579 	int i;
580 
581 	avail = pci_msix_count(pdev->dev.bsddev);
582 	if (avail < nreq) {
583 		if (avail == 0)
584 			return -EINVAL;
585 		return avail;
586 	}
587 	avail = nreq;
588 	if ((error = -pci_alloc_msix(pdev->dev.bsddev, &avail)) != 0)
589 		return error;
590 	/*
591 	 * Handle case where "pci_alloc_msix()" may allocate less
592 	 * interrupts than available and return with no error:
593 	 */
594 	if (avail < nreq) {
595 		pci_release_msi(pdev->dev.bsddev);
596 		return avail;
597 	}
598 	rle = linux_pci_get_rle(pdev, SYS_RES_IRQ, 1);
599 	pdev->dev.irq_start = rle->start;
600 	pdev->dev.irq_end = rle->start + avail;
601 	for (i = 0; i < nreq; i++)
602 		entries[i].vector = pdev->dev.irq_start + i;
603 	return (0);
604 }
605 
606 #define	pci_enable_msix_range(...) \
607   linux_pci_enable_msix_range(__VA_ARGS__)
608 
609 static inline int
610 pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
611     int minvec, int maxvec)
612 {
613 	int nvec = maxvec;
614 	int rc;
615 
616 	if (maxvec < minvec)
617 		return (-ERANGE);
618 
619 	do {
620 		rc = pci_enable_msix(dev, entries, nvec);
621 		if (rc < 0) {
622 			return (rc);
623 		} else if (rc > 0) {
624 			if (rc < minvec)
625 				return (-ENOSPC);
626 			nvec = rc;
627 		}
628 	} while (rc);
629 	return (nvec);
630 }
631 
632 #define	pci_enable_msi(pdev) \
633   linux_pci_enable_msi(pdev)
634 
635 static inline int
636 pci_enable_msi(struct pci_dev *pdev)
637 {
638 	struct resource_list_entry *rle;
639 	int error;
640 	int avail;
641 
642 	avail = pci_msi_count(pdev->dev.bsddev);
643 	if (avail < 1)
644 		return -EINVAL;
645 
646 	avail = 1;	/* this function only enable one MSI IRQ */
647 	if ((error = -pci_alloc_msi(pdev->dev.bsddev, &avail)) != 0)
648 		return error;
649 
650 	rle = linux_pci_get_rle(pdev, SYS_RES_IRQ, 1);
651 	pdev->dev.irq_start = rle->start;
652 	pdev->dev.irq_end = rle->start + avail;
653 	pdev->irq = rle->start;
654 	pdev->msi_enabled = true;
655 	return (0);
656 }
657 
658 static inline int
659 pci_channel_offline(struct pci_dev *pdev)
660 {
661 
662 	return (pci_read_config(pdev->dev.bsddev, PCIR_VENDOR, 2) == PCIV_INVALID);
663 }
664 
665 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
666 {
667 	return -ENODEV;
668 }
669 static inline void pci_disable_sriov(struct pci_dev *dev)
670 {
671 }
672 
673 static inline void *
674 pci_iomap(struct pci_dev *dev, int mmio_bar, int mmio_size __unused)
675 {
676 	struct pci_mmio_region *mmio;
677 
678 	mmio = malloc(sizeof(*mmio), M_DEVBUF, M_WAITOK | M_ZERO);
679 	mmio->rid = PCIR_BAR(mmio_bar);
680 	mmio->type = pci_resource_type(dev, mmio_bar);
681 	mmio->res = bus_alloc_resource_any(dev->dev.bsddev, mmio->type,
682 	    &mmio->rid, RF_ACTIVE);
683 	if (mmio->res == NULL) {
684 		free(mmio, M_DEVBUF);
685 		return (NULL);
686 	}
687 	TAILQ_INSERT_TAIL(&dev->mmio, mmio, next);
688 
689 	return ((void *)rman_get_bushandle(mmio->res));
690 }
691 
692 static inline void
693 pci_iounmap(struct pci_dev *dev, void *res)
694 {
695 	struct pci_mmio_region *mmio, *p;
696 
697 	TAILQ_FOREACH_SAFE(mmio, &dev->mmio, next, p) {
698 		if (res != (void *)rman_get_bushandle(mmio->res))
699 			continue;
700 		bus_release_resource(dev->dev.bsddev,
701 		    mmio->type, mmio->rid, mmio->res);
702 		TAILQ_REMOVE(&dev->mmio, mmio, next);
703 		free(mmio, M_DEVBUF);
704 		return;
705 	}
706 }
707 
708 static inline void
709 lkpi_pci_save_state(struct pci_dev *pdev)
710 {
711 
712 	pci_save_state(pdev->dev.bsddev);
713 }
714 
715 static inline void
716 lkpi_pci_restore_state(struct pci_dev *pdev)
717 {
718 
719 	pci_restore_state(pdev->dev.bsddev);
720 }
721 
722 #define pci_save_state(dev)	lkpi_pci_save_state(dev)
723 #define pci_restore_state(dev)	lkpi_pci_restore_state(dev)
724 
725 #define DEFINE_PCI_DEVICE_TABLE(_table) \
726 	const struct pci_device_id _table[] __devinitdata
727 
728 /* XXX This should not be necessary. */
729 #define	pcix_set_mmrbc(d, v)	0
730 #define	pcix_get_max_mmrbc(d)	0
731 #define	pcie_set_readrq(d, v)	pci_set_max_read_req(&(d)->dev, (v))
732 
733 #define	PCI_DMA_BIDIRECTIONAL	0
734 #define	PCI_DMA_TODEVICE	1
735 #define	PCI_DMA_FROMDEVICE	2
736 #define	PCI_DMA_NONE		3
737 
738 #define	pci_pool		dma_pool
739 #define	pci_pool_destroy(...)	dma_pool_destroy(__VA_ARGS__)
740 #define	pci_pool_alloc(...)	dma_pool_alloc(__VA_ARGS__)
741 #define	pci_pool_free(...)	dma_pool_free(__VA_ARGS__)
742 #define	pci_pool_create(_name, _pdev, _size, _align, _alloc)		\
743 	    dma_pool_create(_name, &(_pdev)->dev, _size, _align, _alloc)
744 #define	pci_free_consistent(_hwdev, _size, _vaddr, _dma_handle)		\
745 	    dma_free_coherent((_hwdev) == NULL ? NULL : &(_hwdev)->dev,	\
746 		_size, _vaddr, _dma_handle)
747 #define	pci_map_sg(_hwdev, _sg, _nents, _dir)				\
748 	    dma_map_sg((_hwdev) == NULL ? NULL : &(_hwdev->dev),	\
749 		_sg, _nents, (enum dma_data_direction)_dir)
750 #define	pci_map_single(_hwdev, _ptr, _size, _dir)			\
751 	    dma_map_single((_hwdev) == NULL ? NULL : &(_hwdev->dev),	\
752 		(_ptr), (_size), (enum dma_data_direction)_dir)
753 #define	pci_unmap_single(_hwdev, _addr, _size, _dir)			\
754 	    dma_unmap_single((_hwdev) == NULL ? NULL : &(_hwdev)->dev,	\
755 		_addr, _size, (enum dma_data_direction)_dir)
756 #define	pci_unmap_sg(_hwdev, _sg, _nents, _dir)				\
757 	    dma_unmap_sg((_hwdev) == NULL ? NULL : &(_hwdev)->dev,	\
758 		_sg, _nents, (enum dma_data_direction)_dir)
759 #define	pci_map_page(_hwdev, _page, _offset, _size, _dir)		\
760 	    dma_map_page((_hwdev) == NULL ? NULL : &(_hwdev)->dev, _page,\
761 		_offset, _size, (enum dma_data_direction)_dir)
762 #define	pci_unmap_page(_hwdev, _dma_address, _size, _dir)		\
763 	    dma_unmap_page((_hwdev) == NULL ? NULL : &(_hwdev)->dev,	\
764 		_dma_address, _size, (enum dma_data_direction)_dir)
765 #define	pci_set_dma_mask(_pdev, mask)	dma_set_mask(&(_pdev)->dev, (mask))
766 #define	pci_dma_mapping_error(_pdev, _dma_addr)				\
767 	    dma_mapping_error(&(_pdev)->dev, _dma_addr)
768 #define	pci_set_consistent_dma_mask(_pdev, _mask)			\
769 	    dma_set_coherent_mask(&(_pdev)->dev, (_mask))
770 #define	DECLARE_PCI_UNMAP_ADDR(x)	DEFINE_DMA_UNMAP_ADDR(x);
771 #define	DECLARE_PCI_UNMAP_LEN(x)	DEFINE_DMA_UNMAP_LEN(x);
772 #define	pci_unmap_addr		dma_unmap_addr
773 #define	pci_unmap_addr_set	dma_unmap_addr_set
774 #define	pci_unmap_len		dma_unmap_len
775 #define	pci_unmap_len_set	dma_unmap_len_set
776 
777 typedef unsigned int __bitwise pci_channel_state_t;
778 typedef unsigned int __bitwise pci_ers_result_t;
779 
780 enum pci_channel_state {
781 	pci_channel_io_normal = 1,
782 	pci_channel_io_frozen = 2,
783 	pci_channel_io_perm_failure = 3,
784 };
785 
786 enum pci_ers_result {
787 	PCI_ERS_RESULT_NONE = 1,
788 	PCI_ERS_RESULT_CAN_RECOVER = 2,
789 	PCI_ERS_RESULT_NEED_RESET = 3,
790 	PCI_ERS_RESULT_DISCONNECT = 4,
791 	PCI_ERS_RESULT_RECOVERED = 5,
792 };
793 
794 /* PCI bus error event callbacks */
795 struct pci_error_handlers {
796 	pci_ers_result_t (*error_detected)(struct pci_dev *dev,
797 	    enum pci_channel_state error);
798 	pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
799 	pci_ers_result_t (*link_reset)(struct pci_dev *dev);
800 	pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
801 	void (*resume)(struct pci_dev *dev);
802 };
803 
804 /* FreeBSD does not support SRIOV - yet */
805 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
806 {
807 	return dev;
808 }
809 
810 static inline bool pci_is_pcie(struct pci_dev *dev)
811 {
812 	return !!pci_pcie_cap(dev);
813 }
814 
815 static inline u16 pcie_flags_reg(struct pci_dev *dev)
816 {
817 	int pos;
818 	u16 reg16;
819 
820 	pos = pci_find_capability(dev, PCI_CAP_ID_EXP);
821 	if (!pos)
822 		return 0;
823 
824 	pci_read_config_word(dev, pos + PCI_EXP_FLAGS, &reg16);
825 
826 	return reg16;
827 }
828 
829 static inline int pci_pcie_type(struct pci_dev *dev)
830 {
831 	return (pcie_flags_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4;
832 }
833 
834 static inline int pcie_cap_version(struct pci_dev *dev)
835 {
836 	return pcie_flags_reg(dev) & PCI_EXP_FLAGS_VERS;
837 }
838 
839 static inline bool pcie_cap_has_lnkctl(struct pci_dev *dev)
840 {
841 	int type = pci_pcie_type(dev);
842 
843 	return pcie_cap_version(dev) > 1 ||
844 	       type == PCI_EXP_TYPE_ROOT_PORT ||
845 	       type == PCI_EXP_TYPE_ENDPOINT ||
846 	       type == PCI_EXP_TYPE_LEG_END;
847 }
848 
849 static inline bool pcie_cap_has_devctl(const struct pci_dev *dev)
850 {
851 		return true;
852 }
853 
854 static inline bool pcie_cap_has_sltctl(struct pci_dev *dev)
855 {
856 	int type = pci_pcie_type(dev);
857 
858 	return pcie_cap_version(dev) > 1 || type == PCI_EXP_TYPE_ROOT_PORT ||
859 	    (type == PCI_EXP_TYPE_DOWNSTREAM &&
860 	    pcie_flags_reg(dev) & PCI_EXP_FLAGS_SLOT);
861 }
862 
863 static inline bool pcie_cap_has_rtctl(struct pci_dev *dev)
864 {
865 	int type = pci_pcie_type(dev);
866 
867 	return pcie_cap_version(dev) > 1 || type == PCI_EXP_TYPE_ROOT_PORT ||
868 	    type == PCI_EXP_TYPE_RC_EC;
869 }
870 
871 static bool pcie_capability_reg_implemented(struct pci_dev *dev, int pos)
872 {
873 	if (!pci_is_pcie(dev))
874 		return false;
875 
876 	switch (pos) {
877 	case PCI_EXP_FLAGS_TYPE:
878 		return true;
879 	case PCI_EXP_DEVCAP:
880 	case PCI_EXP_DEVCTL:
881 	case PCI_EXP_DEVSTA:
882 		return pcie_cap_has_devctl(dev);
883 	case PCI_EXP_LNKCAP:
884 	case PCI_EXP_LNKCTL:
885 	case PCI_EXP_LNKSTA:
886 		return pcie_cap_has_lnkctl(dev);
887 	case PCI_EXP_SLTCAP:
888 	case PCI_EXP_SLTCTL:
889 	case PCI_EXP_SLTSTA:
890 		return pcie_cap_has_sltctl(dev);
891 	case PCI_EXP_RTCTL:
892 	case PCI_EXP_RTCAP:
893 	case PCI_EXP_RTSTA:
894 		return pcie_cap_has_rtctl(dev);
895 	case PCI_EXP_DEVCAP2:
896 	case PCI_EXP_DEVCTL2:
897 	case PCI_EXP_LNKCAP2:
898 	case PCI_EXP_LNKCTL2:
899 	case PCI_EXP_LNKSTA2:
900 		return pcie_cap_version(dev) > 1;
901 	default:
902 		return false;
903 	}
904 }
905 
906 static inline int
907 pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *dst)
908 {
909 	if (pos & 3)
910 		return -EINVAL;
911 
912 	if (!pcie_capability_reg_implemented(dev, pos))
913 		return -EINVAL;
914 
915 	return pci_read_config_dword(dev, pci_pcie_cap(dev) + pos, dst);
916 }
917 
918 static inline int
919 pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *dst)
920 {
921 	if (pos & 3)
922 		return -EINVAL;
923 
924 	if (!pcie_capability_reg_implemented(dev, pos))
925 		return -EINVAL;
926 
927 	return pci_read_config_word(dev, pci_pcie_cap(dev) + pos, dst);
928 }
929 
930 static inline int
931 pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val)
932 {
933 	if (pos & 1)
934 		return -EINVAL;
935 
936 	if (!pcie_capability_reg_implemented(dev, pos))
937 		return 0;
938 
939 	return pci_write_config_word(dev, pci_pcie_cap(dev) + pos, val);
940 }
941 
942 static inline int pcie_get_minimum_link(struct pci_dev *dev,
943     enum pci_bus_speed *speed, enum pcie_link_width *width)
944 {
945 	*speed = PCI_SPEED_UNKNOWN;
946 	*width = PCIE_LNK_WIDTH_UNKNOWN;
947 	return (0);
948 }
949 
950 static inline int
951 pci_num_vf(struct pci_dev *dev)
952 {
953 	return (0);
954 }
955 
956 static inline enum pci_bus_speed
957 pcie_get_speed_cap(struct pci_dev *dev)
958 {
959 	device_t root;
960 	uint32_t lnkcap, lnkcap2;
961 	int error, pos;
962 
963 	root = device_get_parent(dev->dev.bsddev);
964 	if (root == NULL)
965 		return (PCI_SPEED_UNKNOWN);
966 	root = device_get_parent(root);
967 	if (root == NULL)
968 		return (PCI_SPEED_UNKNOWN);
969 	root = device_get_parent(root);
970 	if (root == NULL)
971 		return (PCI_SPEED_UNKNOWN);
972 
973 	if (pci_get_vendor(root) == PCI_VENDOR_ID_VIA ||
974 	    pci_get_vendor(root) == PCI_VENDOR_ID_SERVERWORKS)
975 		return (PCI_SPEED_UNKNOWN);
976 
977 	if ((error = pci_find_cap(root, PCIY_EXPRESS, &pos)) != 0)
978 		return (PCI_SPEED_UNKNOWN);
979 
980 	lnkcap2 = pci_read_config(root, pos + PCIER_LINK_CAP2, 4);
981 
982 	if (lnkcap2) {	/* PCIe r3.0-compliant */
983 		if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_2_5GB)
984 			return (PCIE_SPEED_2_5GT);
985 		if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_5_0GB)
986 			return (PCIE_SPEED_5_0GT);
987 		if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_8_0GB)
988 			return (PCIE_SPEED_8_0GT);
989 		if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_16_0GB)
990 			return (PCIE_SPEED_16_0GT);
991 	} else {	/* pre-r3.0 */
992 		lnkcap = pci_read_config(root, pos + PCIER_LINK_CAP, 4);
993 		if (lnkcap & PCI_EXP_LNKCAP_SLS_2_5GB)
994 			return (PCIE_SPEED_2_5GT);
995 		if (lnkcap & PCI_EXP_LNKCAP_SLS_5_0GB)
996 			return (PCIE_SPEED_5_0GT);
997 		if (lnkcap & PCI_EXP_LNKCAP_SLS_8_0GB)
998 			return (PCIE_SPEED_8_0GT);
999 		if (lnkcap & PCI_EXP_LNKCAP_SLS_16_0GB)
1000 			return (PCIE_SPEED_16_0GT);
1001 	}
1002 	return (PCI_SPEED_UNKNOWN);
1003 }
1004 
1005 static inline enum pcie_link_width
1006 pcie_get_width_cap(struct pci_dev *dev)
1007 {
1008 	uint32_t lnkcap;
1009 
1010 	pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap);
1011 	if (lnkcap)
1012 		return ((lnkcap & PCI_EXP_LNKCAP_MLW) >> 4);
1013 
1014 	return (PCIE_LNK_WIDTH_UNKNOWN);
1015 }
1016 
1017 static inline int
1018 pcie_get_mps(struct pci_dev *dev)
1019 {
1020 	return (pci_get_max_payload(dev->dev.bsddev));
1021 }
1022 
1023 static inline uint32_t
1024 PCIE_SPEED2MBS_ENC(enum pci_bus_speed spd)
1025 {
1026 
1027 	switch(spd) {
1028 	case PCIE_SPEED_16_0GT:
1029 		return (16000 * 128 / 130);
1030 	case PCIE_SPEED_8_0GT:
1031 		return (8000 * 128 / 130);
1032 	case PCIE_SPEED_5_0GT:
1033 		return (5000 * 8 / 10);
1034 	case PCIE_SPEED_2_5GT:
1035 		return (2500 * 8 / 10);
1036 	default:
1037 		return (0);
1038 	}
1039 }
1040 
1041 static inline uint32_t
1042 pcie_bandwidth_available(struct pci_dev *pdev,
1043     struct pci_dev **limiting,
1044     enum pci_bus_speed *speed,
1045     enum pcie_link_width *width)
1046 {
1047 	enum pci_bus_speed nspeed = pcie_get_speed_cap(pdev);
1048 	enum pcie_link_width nwidth = pcie_get_width_cap(pdev);
1049 
1050 	if (speed)
1051 		*speed = nspeed;
1052 	if (width)
1053 		*width = nwidth;
1054 
1055 	return (nwidth * PCIE_SPEED2MBS_ENC(nspeed));
1056 }
1057 
1058 /*
1059  * The following functions can be used to attach/detach the LinuxKPI's
1060  * PCI device runtime. The pci_driver and pci_device_id pointer is
1061  * allowed to be NULL. Other pointers must be all valid.
1062  * The pci_dev structure should be zero-initialized before passed
1063  * to the linux_pci_attach_device function.
1064  */
1065 extern int linux_pci_attach_device(device_t, struct pci_driver *,
1066     const struct pci_device_id *, struct pci_dev *);
1067 extern int linux_pci_detach_device(struct pci_dev *);
1068 
1069 static inline int
1070 pci_dev_present(const struct pci_device_id *cur)
1071 {
1072 	while (cur != NULL && (cur->vendor || cur->device)) {
1073 		if (pci_find_device(cur->vendor, cur->device) != NULL) {
1074 			return (1);
1075 		}
1076 		cur++;
1077 	}
1078 	return (0);
1079 }
1080 
1081 static inline bool
1082 pci_is_root_bus(struct pci_bus *pbus)
1083 {
1084 
1085 	return (pbus->self == NULL);
1086 }
1087 
1088 struct pci_dev *lkpi_pci_get_domain_bus_and_slot(int domain,
1089     unsigned int bus, unsigned int devfn);
1090 #define	pci_get_domain_bus_and_slot(domain, bus, devfn)	\
1091 	lkpi_pci_get_domain_bus_and_slot(domain, bus, devfn)
1092 
1093 static inline int
1094 pci_domain_nr(struct pci_bus *pbus)
1095 {
1096 
1097 	return (pci_get_domain(pbus->self->dev.bsddev));
1098 }
1099 
1100 static inline int
1101 pci_bus_read_config(struct pci_bus *bus, unsigned int devfn,
1102                     int pos, uint32_t *val, int len)
1103 {
1104 
1105 	*val = pci_read_config(bus->self->dev.bsddev, pos, len);
1106 	return (0);
1107 }
1108 
1109 static inline int
1110 pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn, int pos, u16 *val)
1111 {
1112 	uint32_t tmp;
1113 	int ret;
1114 
1115 	ret = pci_bus_read_config(bus, devfn, pos, &tmp, 2);
1116 	*val = (u16)tmp;
1117 	return (ret);
1118 }
1119 
1120 static inline int
1121 pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn, int pos, u8 *val)
1122 {
1123 	uint32_t tmp;
1124 	int ret;
1125 
1126 	ret = pci_bus_read_config(bus, devfn, pos, &tmp, 1);
1127 	*val = (u8)tmp;
1128 	return (ret);
1129 }
1130 
1131 static inline int
1132 pci_bus_write_config(struct pci_bus *bus, unsigned int devfn, int pos,
1133     uint32_t val, int size)
1134 {
1135 
1136 	pci_write_config(bus->self->dev.bsddev, pos, val, size);
1137 	return (0);
1138 }
1139 
1140 static inline int
1141 pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn, int pos,
1142     uint8_t val)
1143 {
1144 	return (pci_bus_write_config(bus, devfn, pos, val, 1));
1145 }
1146 
1147 static inline int
1148 pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn, int pos,
1149     uint16_t val)
1150 {
1151 	return (pci_bus_write_config(bus, devfn, pos, val, 2));
1152 }
1153 
1154 struct pci_dev *lkpi_pci_get_class(unsigned int class, struct pci_dev *from);
1155 #define	pci_get_class(class, from)	lkpi_pci_get_class(class, from)
1156 
1157 #endif	/* _LINUX_PCI_H_ */
1158