xref: /freebsd/sys/dev/bwn/if_bwn_pcivar.h (revision 193d9e768ba63fcfb187cfd17f461f7d41345048)
1 /*-
2  * Copyright (c) 2015-2016 Landon Fuller <landonf@FreeBSD.org>
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, this list of conditions and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13  *    redistribution must be conditioned upon including a substantially
14  *    similar Disclaimer requirement for further binary redistribution.
15  *
16  * NO WARRANTY
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGES.
28  *
29  * $FreeBSD$
30  */
31 
32 #ifndef _IF_BWN_PCIVAR_H_
33 #define _IF_BWN_PCIVAR_H_
34 
35 struct bwn_pci_devcfg;
36 
37 /** bwn_pci per-instance state. */
38 struct bwn_pci_softc {
39 	device_t			 dev;		/**< device */
40 	device_t			 bhndb_dev;	/**< bhnd bridge device */
41 	const struct bwn_pci_devcfg	*devcfg;	/**< bwn device config */
42 	uint32_t			 quirks;	/**< quirk flags */
43 };
44 
45 /* bwn device quirks */
46 enum {
47 	/** No quirks */
48 	BWN_QUIRK_NONE			= 0,
49 
50 	/**
51 	 * This model/revision has not been tested and may not work.
52 	 */
53 	BWN_QUIRK_UNTESTED		= 1<<0,
54 
55 	/**
56 	 * Early dual-band devices did not support accessing multiple PHYs
57 	 * from a single WLAN core, and instead used separate 2GHz and 5GHz
58 	 * WLAN cores.
59 	 *
60 	 * However, not all cards with two WLAN cores are fully populated;
61 	 * we must whitelist the boards on which a second WLAN core is actually
62 	 * usable.
63 	 */
64 	BWN_QUIRK_WLAN_DUALCORE		= 1<<1,
65 
66 	/**
67 	 * Some early devices shipped with unconnected ethernet cores; set
68 	 * this quirk to treat these cores as unpopulated.
69 	 */
70 	BWN_QUIRK_ENET_HW_UNPOPULATED	= 1<<2,
71 
72 	/**
73 	 * Some PCI/PCIe "Intensi-fi" chipsets shipped with floating USB
74 	 * host controller cores; set this quirk to treat these cores as
75 	 * unpopulated.
76 	 */
77 	BWN_QUIRK_USBH_UNPOPULATED	= 1<<3,
78 };
79 
80 /* PCI device descriptor */
81 struct bwn_pci_device {
82 	uint16_t	vendor;
83 	uint16_t	device;
84 	const char	*desc;
85 	uint32_t	quirks;
86 };
87 
88 
89 #define	BWN_BCM_DEV(_devid, _desc, _quirks)		\
90     { PCI_VENDOR_BROADCOM, PCI_DEVID_ ## _devid,	\
91         "Broadcom " _desc " Wireless", _quirks }
92 
93 /* Supported device table */
94 struct bwn_pci_devcfg {
95 	const struct bhndb_hwcfg	*bridge_hwcfg;
96 	const struct bhndb_hw		*bridge_hwtable;
97 	const struct bhndb_hw_priority	*bridge_hwprio;
98 	const struct bwn_pci_device	*devices;
99 };
100 
101 #endif /* _IF_BWN_PCIVAR_H_ */
102