1/*-
2 * Copyright (c) 2015 Landon Fuller <landon@landonf.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
35struct bwn_pci_devcfg;
36
37/** bwn_pci per-instance state. */
38struct 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 */
46enum {
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/* PCI device descriptor */
74struct bwn_pci_device {
75	uint16_t	vendor;
76	uint16_t	device;
77	const char	*desc;
78	uint32_t	quirks;
79};
80
81
82#define	BWN_BCM_DEV(_devid, _desc, _quirks)		\
83    { PCI_VENDOR_BROADCOM, PCI_DEVID_ ## _devid,	\
84        "Broadcom " _desc " Wireless", _quirks }
85
86/* Supported device table */
87struct bwn_pci_devcfg {
88	const struct bhndb_hwcfg	*bridge_hwcfg;
89	const struct bhndb_hw		*bridge_hwtable;
90	const struct bwn_pci_device	*devices;
91};
92
93#endif /* _IF_BWN_PCIVAR_H_ */