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