xref: /freebsd/sys/compat/linuxkpi/common/include/linux/pci.h (revision d3d381b2b194b4d24853e92eecef55f262688d1a)
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/pciio.h>
41 #include <sys/rman.h>
42 #include <dev/pci/pcivar.h>
43 #include <dev/pci/pcireg.h>
44 #include <dev/pci/pci_private.h>
45 
46 #include <machine/resource.h>
47 
48 #include <linux/list.h>
49 #include <linux/dmapool.h>
50 #include <linux/dma-mapping.h>
51 #include <linux/compiler.h>
52 #include <linux/errno.h>
53 #include <asm/atomic.h>
54 #include <linux/device.h>
55 
56 struct pci_device_id {
57 	uint32_t	vendor;
58 	uint32_t	device;
59 	uint32_t	subvendor;
60 	uint32_t	subdevice;
61 	uint32_t	class;
62 	uint32_t	class_mask;
63 	uintptr_t	driver_data;
64 };
65 
66 #define	MODULE_DEVICE_TABLE(bus, table)
67 
68 #define	PCI_BASE_CLASS_DISPLAY		0x03
69 #define	PCI_CLASS_DISPLAY_VGA		0x0300
70 #define	PCI_CLASS_DISPLAY_OTHER		0x0380
71 #define	PCI_BASE_CLASS_BRIDGE		0x06
72 #define	PCI_CLASS_BRIDGE_ISA		0x0601
73 
74 #define	PCI_ANY_ID		(-1)
75 #define	PCI_VENDOR_ID_APPLE		0x106b
76 #define	PCI_VENDOR_ID_ASUSTEK		0x1043
77 #define	PCI_VENDOR_ID_ATI		0x1002
78 #define	PCI_VENDOR_ID_DELL		0x1028
79 #define	PCI_VENDOR_ID_HP		0x103c
80 #define	PCI_VENDOR_ID_IBM		0x1014
81 #define	PCI_VENDOR_ID_INTEL		0x8086
82 #define	PCI_VENDOR_ID_MELLANOX			0x15b3
83 #define	PCI_VENDOR_ID_REDHAT_QUMRANET	0x1af4
84 #define	PCI_VENDOR_ID_SERVERWORKS	0x1166
85 #define	PCI_VENDOR_ID_SONY		0x104d
86 #define	PCI_VENDOR_ID_TOPSPIN			0x1867
87 #define	PCI_VENDOR_ID_VIA		0x1106
88 #define	PCI_SUBVENDOR_ID_REDHAT_QUMRANET	0x1af4
89 #define	PCI_DEVICE_ID_ATI_RADEON_QY	0x5159
90 #define	PCI_DEVICE_ID_MELLANOX_TAVOR		0x5a44
91 #define	PCI_DEVICE_ID_MELLANOX_TAVOR_BRIDGE	0x5a46
92 #define	PCI_DEVICE_ID_MELLANOX_ARBEL_COMPAT	0x6278
93 #define	PCI_DEVICE_ID_MELLANOX_ARBEL		0x6282
94 #define	PCI_DEVICE_ID_MELLANOX_SINAI_OLD	0x5e8c
95 #define	PCI_DEVICE_ID_MELLANOX_SINAI		0x6274
96 #define	PCI_SUBDEVICE_ID_QEMU		0x1100
97 
98 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
99 #define PCI_SLOT(devfn)		(((devfn) >> 3) & 0x1f)
100 #define PCI_FUNC(devfn)		((devfn) & 0x07)
101 #define	PCI_BUS_NUM(devfn)	(((devfn) >> 8) & 0xff)
102 
103 #define PCI_VDEVICE(_vendor, _device)					\
104 	    .vendor = PCI_VENDOR_ID_##_vendor, .device = (_device),	\
105 	    .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
106 #define	PCI_DEVICE(_vendor, _device)					\
107 	    .vendor = (_vendor), .device = (_device),			\
108 	    .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
109 
110 #define	to_pci_dev(n)	container_of(n, struct pci_dev, dev)
111 
112 #define	PCI_VENDOR_ID		PCIR_DEVVENDOR
113 #define	PCI_COMMAND		PCIR_COMMAND
114 #define	PCI_EXP_DEVCTL		PCIER_DEVICE_CTL		/* Device Control */
115 #define	PCI_EXP_LNKCTL		PCIER_LINK_CTL			/* Link Control */
116 #define	PCI_EXP_FLAGS_TYPE	PCIEM_FLAGS_TYPE		/* Device/Port type */
117 #define	PCI_EXP_DEVCAP		PCIER_DEVICE_CAP		/* Device capabilities */
118 #define	PCI_EXP_DEVSTA		PCIER_DEVICE_STA		/* Device Status */
119 #define	PCI_EXP_LNKCAP		PCIER_LINK_CAP			/* Link Capabilities */
120 #define	PCI_EXP_LNKSTA		PCIER_LINK_STA			/* Link Status */
121 #define	PCI_EXP_SLTCAP		PCIER_SLOT_CAP			/* Slot Capabilities */
122 #define	PCI_EXP_SLTCTL		PCIER_SLOT_CTL			/* Slot Control */
123 #define	PCI_EXP_SLTSTA		PCIER_SLOT_STA			/* Slot Status */
124 #define	PCI_EXP_RTCTL		PCIER_ROOT_CTL			/* Root Control */
125 #define	PCI_EXP_RTCAP		PCIER_ROOT_CAP			/* Root Capabilities */
126 #define	PCI_EXP_RTSTA		PCIER_ROOT_STA			/* Root Status */
127 #define	PCI_EXP_DEVCAP2		PCIER_DEVICE_CAP2		/* Device Capabilities 2 */
128 #define	PCI_EXP_DEVCTL2		PCIER_DEVICE_CTL2		/* Device Control 2 */
129 #define	PCI_EXP_LNKCAP2		PCIER_LINK_CAP2			/* Link Capabilities 2 */
130 #define	PCI_EXP_LNKCTL2		PCIER_LINK_CTL2			/* Link Control 2 */
131 #define	PCI_EXP_LNKSTA2		PCIER_LINK_STA2			/* Link Status 2 */
132 #define	PCI_EXP_FLAGS		PCIER_FLAGS			/* Capabilities register */
133 #define	PCI_EXP_FLAGS_VERS	PCIEM_FLAGS_VERSION		/* Capability version */
134 #define	PCI_EXP_TYPE_ROOT_PORT	PCIEM_TYPE_ROOT_PORT		/* Root Port */
135 #define	PCI_EXP_TYPE_ENDPOINT	PCIEM_TYPE_ENDPOINT		/* Express Endpoint */
136 #define	PCI_EXP_TYPE_LEG_END	PCIEM_TYPE_LEGACY_ENDPOINT	/* Legacy Endpoint */
137 #define	PCI_EXP_TYPE_DOWNSTREAM PCIEM_TYPE_DOWNSTREAM_PORT	/* Downstream Port */
138 #define	PCI_EXP_FLAGS_SLOT	PCIEM_FLAGS_SLOT		/* Slot implemented */
139 #define	PCI_EXP_TYPE_RC_EC	PCIEM_TYPE_ROOT_EC		/* Root Complex Event Collector */
140 #define	PCI_EXP_LNKCAP_SLS_2_5GB 0x01	/* Supported Link Speed 2.5GT/s */
141 #define	PCI_EXP_LNKCAP_SLS_5_0GB 0x02	/* Supported Link Speed 5.0GT/s */
142 #define	PCI_EXP_LNKCAP_MLW	0x03f0	/* Maximum Link Width */
143 #define	PCI_EXP_LNKCAP2_SLS_2_5GB 0x02	/* Supported Link Speed 2.5GT/s */
144 #define	PCI_EXP_LNKCAP2_SLS_5_0GB 0x04	/* Supported Link Speed 5.0GT/s */
145 #define	PCI_EXP_LNKCAP2_SLS_8_0GB 0x08	/* Supported Link Speed 8.0GT/s */
146 
147 #define PCI_EXP_LNKCTL_HAWD	PCIEM_LINK_CTL_HAWD
148 #define PCI_EXP_LNKCAP_CLKPM	0x00040000
149 #define PCI_EXP_DEVSTA_TRPND	0x0020
150 
151 #define	IORESOURCE_MEM	(1 << SYS_RES_MEMORY)
152 #define	IORESOURCE_IO	(1 << SYS_RES_IOPORT)
153 #define	IORESOURCE_IRQ	(1 << SYS_RES_IRQ)
154 
155 enum pci_bus_speed {
156 	PCI_SPEED_UNKNOWN = -1,
157 	PCIE_SPEED_2_5GT,
158 	PCIE_SPEED_5_0GT,
159 	PCIE_SPEED_8_0GT,
160 };
161 
162 enum pcie_link_width {
163 	PCIE_LNK_WIDTH_UNKNOWN = 0xFF,
164 };
165 
166 typedef int pci_power_t;
167 
168 #define PCI_D0	PCI_POWERSTATE_D0
169 #define PCI_D1	PCI_POWERSTATE_D1
170 #define PCI_D2	PCI_POWERSTATE_D2
171 #define PCI_D3hot	PCI_POWERSTATE_D3
172 #define PCI_D3cold	4
173 
174 #define PCI_POWER_ERROR	PCI_POWERSTATE_UNKNOWN
175 
176 struct pci_dev;
177 
178 struct pci_driver {
179 	struct list_head		links;
180 	char				*name;
181 	const struct pci_device_id		*id_table;
182 	int  (*probe)(struct pci_dev *dev, const struct pci_device_id *id);
183 	void (*remove)(struct pci_dev *dev);
184 	int  (*suspend) (struct pci_dev *dev, pm_message_t state);	/* Device suspended */
185 	int  (*resume) (struct pci_dev *dev);		/* Device woken up */
186 	void (*shutdown) (struct pci_dev *dev);		/* Device shutdown */
187 	driver_t			bsddriver;
188 	devclass_t			bsdclass;
189 	struct device_driver		driver;
190 	const struct pci_error_handlers       *err_handler;
191 	bool				isdrm;
192 };
193 
194 struct pci_bus {
195 	struct pci_dev	*self;
196 	int		number;
197 };
198 
199 extern struct list_head pci_drivers;
200 extern struct list_head pci_devices;
201 extern spinlock_t pci_lock;
202 
203 #define	__devexit_p(x)	x
204 
205 struct pci_dev {
206 	struct device		dev;
207 	struct list_head	links;
208 	struct pci_driver	*pdrv;
209 	struct pci_bus		*bus;
210 	uint64_t		dma_mask;
211 	uint16_t		device;
212 	uint16_t		vendor;
213 	uint16_t		subsystem_vendor;
214 	uint16_t		subsystem_device;
215 	unsigned int		irq;
216 	unsigned int		devfn;
217 	uint32_t		class;
218 	uint8_t			revision;
219 };
220 
221 static inline struct resource_list_entry *
222 linux_pci_get_rle(struct pci_dev *pdev, int type, int rid)
223 {
224 	struct pci_devinfo *dinfo;
225 	struct resource_list *rl;
226 
227 	dinfo = device_get_ivars(pdev->dev.bsddev);
228 	rl = &dinfo->resources;
229 	return resource_list_find(rl, type, rid);
230 }
231 
232 static inline struct resource_list_entry *
233 linux_pci_get_bar(struct pci_dev *pdev, int bar)
234 {
235 	struct resource_list_entry *rle;
236 
237 	bar = PCIR_BAR(bar);
238 	if ((rle = linux_pci_get_rle(pdev, SYS_RES_MEMORY, bar)) == NULL)
239 		rle = linux_pci_get_rle(pdev, SYS_RES_IOPORT, bar);
240 	return (rle);
241 }
242 
243 static inline struct device *
244 linux_pci_find_irq_dev(unsigned int irq)
245 {
246 	struct pci_dev *pdev;
247 	struct device *found;
248 
249 	found = NULL;
250 	spin_lock(&pci_lock);
251 	list_for_each_entry(pdev, &pci_devices, links) {
252 		if (irq == pdev->dev.irq ||
253 		    (irq >= pdev->dev.msix && irq < pdev->dev.msix_max)) {
254 			found = &pdev->dev;
255 			break;
256 		}
257 	}
258 	spin_unlock(&pci_lock);
259 	return (found);
260 }
261 
262 static inline unsigned long
263 pci_resource_start(struct pci_dev *pdev, int bar)
264 {
265 	struct resource_list_entry *rle;
266 
267 	if ((rle = linux_pci_get_bar(pdev, bar)) == NULL)
268 		return (0);
269 	return rle->start;
270 }
271 
272 static inline unsigned long
273 pci_resource_len(struct pci_dev *pdev, int bar)
274 {
275 	struct resource_list_entry *rle;
276 
277 	if ((rle = linux_pci_get_bar(pdev, bar)) == NULL)
278 		return (0);
279 	return rle->count;
280 }
281 
282 static inline int
283 pci_resource_type(struct pci_dev *pdev, int bar)
284 {
285 	struct pci_map *pm;
286 
287 	pm = pci_find_bar(pdev->dev.bsddev, PCIR_BAR(bar));
288 	if (!pm)
289 		return (-1);
290 
291 	if (PCI_BAR_IO(pm->pm_value))
292 		return (SYS_RES_IOPORT);
293 	else
294 		return (SYS_RES_MEMORY);
295 }
296 
297 /*
298  * All drivers just seem to want to inspect the type not flags.
299  */
300 static inline int
301 pci_resource_flags(struct pci_dev *pdev, int bar)
302 {
303 	int type;
304 
305 	type = pci_resource_type(pdev, bar);
306 	if (type < 0)
307 		return (0);
308 	return (1 << type);
309 }
310 
311 static inline const char *
312 pci_name(struct pci_dev *d)
313 {
314 
315 	return device_get_desc(d->dev.bsddev);
316 }
317 
318 static inline void *
319 pci_get_drvdata(struct pci_dev *pdev)
320 {
321 
322 	return dev_get_drvdata(&pdev->dev);
323 }
324 
325 static inline void
326 pci_set_drvdata(struct pci_dev *pdev, void *data)
327 {
328 
329 	dev_set_drvdata(&pdev->dev, data);
330 }
331 
332 static inline int
333 pci_enable_device(struct pci_dev *pdev)
334 {
335 
336 	pci_enable_io(pdev->dev.bsddev, SYS_RES_IOPORT);
337 	pci_enable_io(pdev->dev.bsddev, SYS_RES_MEMORY);
338 	return (0);
339 }
340 
341 static inline void
342 pci_disable_device(struct pci_dev *pdev)
343 {
344 
345 	pci_disable_io(pdev->dev.bsddev, SYS_RES_IOPORT);
346 	pci_disable_io(pdev->dev.bsddev, SYS_RES_MEMORY);
347 	pci_disable_busmaster(pdev->dev.bsddev);
348 }
349 
350 static inline int
351 pci_set_master(struct pci_dev *pdev)
352 {
353 
354 	pci_enable_busmaster(pdev->dev.bsddev);
355 	return (0);
356 }
357 
358 static inline int
359 pci_set_power_state(struct pci_dev *pdev, int state)
360 {
361 
362 	pci_set_powerstate(pdev->dev.bsddev, state);
363 	return (0);
364 }
365 
366 static inline int
367 pci_clear_master(struct pci_dev *pdev)
368 {
369 
370 	pci_disable_busmaster(pdev->dev.bsddev);
371 	return (0);
372 }
373 
374 static inline int
375 pci_request_region(struct pci_dev *pdev, int bar, const char *res_name)
376 {
377 	int rid;
378 	int type;
379 
380 	type = pci_resource_type(pdev, bar);
381 	if (type < 0)
382 		return (-ENODEV);
383 	rid = PCIR_BAR(bar);
384 	if (bus_alloc_resource_any(pdev->dev.bsddev, type, &rid,
385 	    RF_ACTIVE) == NULL)
386 		return (-EINVAL);
387 	return (0);
388 }
389 
390 static inline void
391 pci_release_region(struct pci_dev *pdev, int bar)
392 {
393 	struct resource_list_entry *rle;
394 
395 	if ((rle = linux_pci_get_bar(pdev, bar)) == NULL)
396 		return;
397 	bus_release_resource(pdev->dev.bsddev, rle->type, rle->rid, rle->res);
398 }
399 
400 static inline void
401 pci_release_regions(struct pci_dev *pdev)
402 {
403 	int i;
404 
405 	for (i = 0; i <= PCIR_MAX_BAR_0; i++)
406 		pci_release_region(pdev, i);
407 }
408 
409 static inline int
410 pci_request_regions(struct pci_dev *pdev, const char *res_name)
411 {
412 	int error;
413 	int i;
414 
415 	for (i = 0; i <= PCIR_MAX_BAR_0; i++) {
416 		error = pci_request_region(pdev, i, res_name);
417 		if (error && error != -ENODEV) {
418 			pci_release_regions(pdev);
419 			return (error);
420 		}
421 	}
422 	return (0);
423 }
424 
425 static inline void
426 pci_disable_msix(struct pci_dev *pdev)
427 {
428 
429 	pci_release_msi(pdev->dev.bsddev);
430 
431 	/*
432 	 * The MSIX IRQ numbers associated with this PCI device are no
433 	 * longer valid and might be re-assigned. Make sure
434 	 * linux_pci_find_irq_dev() does no longer see them by
435 	 * resetting their references to zero:
436 	 */
437 	pdev->dev.msix = 0;
438 	pdev->dev.msix_max = 0;
439 }
440 
441 static inline bus_addr_t
442 pci_bus_address(struct pci_dev *pdev, int bar)
443 {
444 
445 	return (pci_resource_start(pdev, bar));
446 }
447 
448 #define	PCI_CAP_ID_EXP	PCIY_EXPRESS
449 #define	PCI_CAP_ID_PCIX	PCIY_PCIX
450 #define PCI_CAP_ID_AGP  PCIY_AGP
451 #define PCI_CAP_ID_PM   PCIY_PMG
452 
453 #define PCI_EXP_DEVCTL		PCIER_DEVICE_CTL
454 #define PCI_EXP_DEVCTL_PAYLOAD	PCIEM_CTL_MAX_PAYLOAD
455 #define PCI_EXP_DEVCTL_READRQ	PCIEM_CTL_MAX_READ_REQUEST
456 #define PCI_EXP_LNKCTL		PCIER_LINK_CTL
457 #define PCI_EXP_LNKSTA		PCIER_LINK_STA
458 
459 static inline int
460 pci_find_capability(struct pci_dev *pdev, int capid)
461 {
462 	int reg;
463 
464 	if (pci_find_cap(pdev->dev.bsddev, capid, &reg))
465 		return (0);
466 	return (reg);
467 }
468 
469 static inline int pci_pcie_cap(struct pci_dev *dev)
470 {
471 	return pci_find_capability(dev, PCI_CAP_ID_EXP);
472 }
473 
474 
475 static inline int
476 pci_read_config_byte(struct pci_dev *pdev, int where, u8 *val)
477 {
478 
479 	*val = (u8)pci_read_config(pdev->dev.bsddev, where, 1);
480 	return (0);
481 }
482 
483 static inline int
484 pci_read_config_word(struct pci_dev *pdev, int where, u16 *val)
485 {
486 
487 	*val = (u16)pci_read_config(pdev->dev.bsddev, where, 2);
488 	return (0);
489 }
490 
491 static inline int
492 pci_read_config_dword(struct pci_dev *pdev, int where, u32 *val)
493 {
494 
495 	*val = (u32)pci_read_config(pdev->dev.bsddev, where, 4);
496 	return (0);
497 }
498 
499 static inline int
500 pci_write_config_byte(struct pci_dev *pdev, int where, u8 val)
501 {
502 
503 	pci_write_config(pdev->dev.bsddev, where, val, 1);
504 	return (0);
505 }
506 
507 static inline int
508 pci_write_config_word(struct pci_dev *pdev, int where, u16 val)
509 {
510 
511 	pci_write_config(pdev->dev.bsddev, where, val, 2);
512 	return (0);
513 }
514 
515 static inline int
516 pci_write_config_dword(struct pci_dev *pdev, int where, u32 val)
517 {
518 
519 	pci_write_config(pdev->dev.bsddev, where, val, 4);
520 	return (0);
521 }
522 
523 int	linux_pci_register_driver(struct pci_driver *pdrv);
524 int	linux_pci_register_drm_driver(struct pci_driver *pdrv);
525 void	linux_pci_unregister_driver(struct pci_driver *pdrv);
526 
527 #define	pci_register_driver(pdrv)	linux_pci_register_driver(pdrv)
528 #define	pci_unregister_driver(pdrv)	linux_pci_unregister_driver(pdrv)
529 
530 struct msix_entry {
531 	int entry;
532 	int vector;
533 };
534 
535 /*
536  * Enable msix, positive errors indicate actual number of available
537  * vectors.  Negative errors are failures.
538  *
539  * NB: define added to prevent this definition of pci_enable_msix from
540  * clashing with the native FreeBSD version.
541  */
542 #define	pci_enable_msix(...) \
543   linux_pci_enable_msix(__VA_ARGS__)
544 
545 static inline int
546 pci_enable_msix(struct pci_dev *pdev, struct msix_entry *entries, int nreq)
547 {
548 	struct resource_list_entry *rle;
549 	int error;
550 	int avail;
551 	int i;
552 
553 	avail = pci_msix_count(pdev->dev.bsddev);
554 	if (avail < nreq) {
555 		if (avail == 0)
556 			return -EINVAL;
557 		return avail;
558 	}
559 	avail = nreq;
560 	if ((error = -pci_alloc_msix(pdev->dev.bsddev, &avail)) != 0)
561 		return error;
562 	/*
563 	 * Handle case where "pci_alloc_msix()" may allocate less
564 	 * interrupts than available and return with no error:
565 	 */
566 	if (avail < nreq) {
567 		pci_release_msi(pdev->dev.bsddev);
568 		return avail;
569 	}
570 	rle = linux_pci_get_rle(pdev, SYS_RES_IRQ, 1);
571 	pdev->dev.msix = rle->start;
572 	pdev->dev.msix_max = rle->start + avail;
573 	for (i = 0; i < nreq; i++)
574 		entries[i].vector = pdev->dev.msix + i;
575 	return (0);
576 }
577 
578 #define	pci_enable_msix_range(...) \
579   linux_pci_enable_msix_range(__VA_ARGS__)
580 
581 static inline int
582 pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
583     int minvec, int maxvec)
584 {
585 	int nvec = maxvec;
586 	int rc;
587 
588 	if (maxvec < minvec)
589 		return (-ERANGE);
590 
591 	do {
592 		rc = pci_enable_msix(dev, entries, nvec);
593 		if (rc < 0) {
594 			return (rc);
595 		} else if (rc > 0) {
596 			if (rc < minvec)
597 				return (-ENOSPC);
598 			nvec = rc;
599 		}
600 	} while (rc);
601 	return (nvec);
602 }
603 
604 static inline int pci_channel_offline(struct pci_dev *pdev)
605 {
606 	return false;
607 }
608 
609 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
610 {
611 	return -ENODEV;
612 }
613 static inline void pci_disable_sriov(struct pci_dev *dev)
614 {
615 }
616 
617 #define DEFINE_PCI_DEVICE_TABLE(_table) \
618 	const struct pci_device_id _table[] __devinitdata
619 
620 
621 /* XXX This should not be necessary. */
622 #define	pcix_set_mmrbc(d, v)	0
623 #define	pcix_get_max_mmrbc(d)	0
624 #define	pcie_set_readrq(d, v)	0
625 
626 #define	PCI_DMA_BIDIRECTIONAL	0
627 #define	PCI_DMA_TODEVICE	1
628 #define	PCI_DMA_FROMDEVICE	2
629 #define	PCI_DMA_NONE		3
630 
631 #define	pci_pool		dma_pool
632 #define	pci_pool_destroy(...)	dma_pool_destroy(__VA_ARGS__)
633 #define	pci_pool_alloc(...)	dma_pool_alloc(__VA_ARGS__)
634 #define	pci_pool_free(...)	dma_pool_free(__VA_ARGS__)
635 #define	pci_pool_create(_name, _pdev, _size, _align, _alloc)		\
636 	    dma_pool_create(_name, &(_pdev)->dev, _size, _align, _alloc)
637 #define	pci_free_consistent(_hwdev, _size, _vaddr, _dma_handle)		\
638 	    dma_free_coherent((_hwdev) == NULL ? NULL : &(_hwdev)->dev,	\
639 		_size, _vaddr, _dma_handle)
640 #define	pci_map_sg(_hwdev, _sg, _nents, _dir)				\
641 	    dma_map_sg((_hwdev) == NULL ? NULL : &(_hwdev->dev),	\
642 		_sg, _nents, (enum dma_data_direction)_dir)
643 #define	pci_map_single(_hwdev, _ptr, _size, _dir)			\
644 	    dma_map_single((_hwdev) == NULL ? NULL : &(_hwdev->dev),	\
645 		(_ptr), (_size), (enum dma_data_direction)_dir)
646 #define	pci_unmap_single(_hwdev, _addr, _size, _dir)			\
647 	    dma_unmap_single((_hwdev) == NULL ? NULL : &(_hwdev)->dev,	\
648 		_addr, _size, (enum dma_data_direction)_dir)
649 #define	pci_unmap_sg(_hwdev, _sg, _nents, _dir)				\
650 	    dma_unmap_sg((_hwdev) == NULL ? NULL : &(_hwdev)->dev,	\
651 		_sg, _nents, (enum dma_data_direction)_dir)
652 #define	pci_map_page(_hwdev, _page, _offset, _size, _dir)		\
653 	    dma_map_page((_hwdev) == NULL ? NULL : &(_hwdev)->dev, _page,\
654 		_offset, _size, (enum dma_data_direction)_dir)
655 #define	pci_unmap_page(_hwdev, _dma_address, _size, _dir)		\
656 	    dma_unmap_page((_hwdev) == NULL ? NULL : &(_hwdev)->dev,	\
657 		_dma_address, _size, (enum dma_data_direction)_dir)
658 #define	pci_set_dma_mask(_pdev, mask)	dma_set_mask(&(_pdev)->dev, (mask))
659 #define	pci_dma_mapping_error(_pdev, _dma_addr)				\
660 	    dma_mapping_error(&(_pdev)->dev, _dma_addr)
661 #define	pci_set_consistent_dma_mask(_pdev, _mask)			\
662 	    dma_set_coherent_mask(&(_pdev)->dev, (_mask))
663 #define	DECLARE_PCI_UNMAP_ADDR(x)	DEFINE_DMA_UNMAP_ADDR(x);
664 #define	DECLARE_PCI_UNMAP_LEN(x)	DEFINE_DMA_UNMAP_LEN(x);
665 #define	pci_unmap_addr		dma_unmap_addr
666 #define	pci_unmap_addr_set	dma_unmap_addr_set
667 #define	pci_unmap_len		dma_unmap_len
668 #define	pci_unmap_len_set	dma_unmap_len_set
669 
670 typedef unsigned int __bitwise pci_channel_state_t;
671 typedef unsigned int __bitwise pci_ers_result_t;
672 
673 enum pci_channel_state {
674 	pci_channel_io_normal = 1,
675 	pci_channel_io_frozen = 2,
676 	pci_channel_io_perm_failure = 3,
677 };
678 
679 enum pci_ers_result {
680 	PCI_ERS_RESULT_NONE = 1,
681 	PCI_ERS_RESULT_CAN_RECOVER = 2,
682 	PCI_ERS_RESULT_NEED_RESET = 3,
683 	PCI_ERS_RESULT_DISCONNECT = 4,
684 	PCI_ERS_RESULT_RECOVERED = 5,
685 };
686 
687 
688 /* PCI bus error event callbacks */
689 struct pci_error_handlers {
690 	pci_ers_result_t (*error_detected)(struct pci_dev *dev,
691 	    enum pci_channel_state error);
692 	pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
693 	pci_ers_result_t (*link_reset)(struct pci_dev *dev);
694 	pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
695 	void (*resume)(struct pci_dev *dev);
696 };
697 
698 /* FreeBSD does not support SRIOV - yet */
699 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
700 {
701 	return dev;
702 }
703 
704 static inline bool pci_is_pcie(struct pci_dev *dev)
705 {
706 	return !!pci_pcie_cap(dev);
707 }
708 
709 static inline u16 pcie_flags_reg(struct pci_dev *dev)
710 {
711 	int pos;
712 	u16 reg16;
713 
714 	pos = pci_find_capability(dev, PCI_CAP_ID_EXP);
715 	if (!pos)
716 		return 0;
717 
718 	pci_read_config_word(dev, pos + PCI_EXP_FLAGS, &reg16);
719 
720 	return reg16;
721 }
722 
723 
724 static inline int pci_pcie_type(struct pci_dev *dev)
725 {
726 	return (pcie_flags_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4;
727 }
728 
729 static inline int pcie_cap_version(struct pci_dev *dev)
730 {
731 	return pcie_flags_reg(dev) & PCI_EXP_FLAGS_VERS;
732 }
733 
734 static inline bool pcie_cap_has_lnkctl(struct pci_dev *dev)
735 {
736 	int type = pci_pcie_type(dev);
737 
738 	return pcie_cap_version(dev) > 1 ||
739 	       type == PCI_EXP_TYPE_ROOT_PORT ||
740 	       type == PCI_EXP_TYPE_ENDPOINT ||
741 	       type == PCI_EXP_TYPE_LEG_END;
742 }
743 
744 static inline bool pcie_cap_has_devctl(const struct pci_dev *dev)
745 {
746 		return true;
747 }
748 
749 static inline bool pcie_cap_has_sltctl(struct pci_dev *dev)
750 {
751 	int type = pci_pcie_type(dev);
752 
753 	return pcie_cap_version(dev) > 1 || type == PCI_EXP_TYPE_ROOT_PORT ||
754 	    (type == PCI_EXP_TYPE_DOWNSTREAM &&
755 	    pcie_flags_reg(dev) & PCI_EXP_FLAGS_SLOT);
756 }
757 
758 static inline bool pcie_cap_has_rtctl(struct pci_dev *dev)
759 {
760 	int type = pci_pcie_type(dev);
761 
762 	return pcie_cap_version(dev) > 1 || type == PCI_EXP_TYPE_ROOT_PORT ||
763 	    type == PCI_EXP_TYPE_RC_EC;
764 }
765 
766 static bool pcie_capability_reg_implemented(struct pci_dev *dev, int pos)
767 {
768 	if (!pci_is_pcie(dev))
769 		return false;
770 
771 	switch (pos) {
772 	case PCI_EXP_FLAGS_TYPE:
773 		return true;
774 	case PCI_EXP_DEVCAP:
775 	case PCI_EXP_DEVCTL:
776 	case PCI_EXP_DEVSTA:
777 		return pcie_cap_has_devctl(dev);
778 	case PCI_EXP_LNKCAP:
779 	case PCI_EXP_LNKCTL:
780 	case PCI_EXP_LNKSTA:
781 		return pcie_cap_has_lnkctl(dev);
782 	case PCI_EXP_SLTCAP:
783 	case PCI_EXP_SLTCTL:
784 	case PCI_EXP_SLTSTA:
785 		return pcie_cap_has_sltctl(dev);
786 	case PCI_EXP_RTCTL:
787 	case PCI_EXP_RTCAP:
788 	case PCI_EXP_RTSTA:
789 		return pcie_cap_has_rtctl(dev);
790 	case PCI_EXP_DEVCAP2:
791 	case PCI_EXP_DEVCTL2:
792 	case PCI_EXP_LNKCAP2:
793 	case PCI_EXP_LNKCTL2:
794 	case PCI_EXP_LNKSTA2:
795 		return pcie_cap_version(dev) > 1;
796 	default:
797 		return false;
798 	}
799 }
800 
801 static inline int
802 pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *dst)
803 {
804 	if (pos & 3)
805 		return -EINVAL;
806 
807 	if (!pcie_capability_reg_implemented(dev, pos))
808 		return -EINVAL;
809 
810 	return pci_read_config_dword(dev, pci_pcie_cap(dev) + pos, dst);
811 }
812 
813 static inline int
814 pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *dst)
815 {
816 	if (pos & 3)
817 		return -EINVAL;
818 
819 	if (!pcie_capability_reg_implemented(dev, pos))
820 		return -EINVAL;
821 
822 	return pci_read_config_word(dev, pci_pcie_cap(dev) + pos, dst);
823 }
824 
825 static inline int
826 pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val)
827 {
828 	if (pos & 1)
829 		return -EINVAL;
830 
831 	if (!pcie_capability_reg_implemented(dev, pos))
832 		return 0;
833 
834 	return pci_write_config_word(dev, pci_pcie_cap(dev) + pos, val);
835 }
836 
837 static inline int pcie_get_minimum_link(struct pci_dev *dev,
838     enum pci_bus_speed *speed, enum pcie_link_width *width)
839 {
840 	*speed = PCI_SPEED_UNKNOWN;
841 	*width = PCIE_LNK_WIDTH_UNKNOWN;
842 	return (0);
843 }
844 
845 static inline int
846 pci_num_vf(struct pci_dev *dev)
847 {
848 	return (0);
849 }
850 
851 #endif	/* _LINUX_PCI_H_ */
852