sys/dev/bwn/if_bwn_pcivar.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   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  * $FreeBSD$
  29  */
  30
  31 #ifndef _IF_BWN_PCIVAR_H_
  32 #define _IF_BWN_PCIVAR_H_
  33
  34 struct bwn_pci_devcfg;
  35
  36 /** bwn_pci per-instance state. */
  37 struct bwn_pci_softc {
  38         device_t                         dev;           /**< device */
  39         device_t                         bhndb_dev;     /**< bhnd bridge device */
  40         const struct bwn_pci_devcfg     *devcfg;        /**< bwn device config */
  41         uint32_t                         quirks;        /**< quirk flags */
  42 };
  43
  44 /* bwn device quirks */
  45 enum {
  46         /** No quirks */
  47         BWN_QUIRK_NONE                  = 0,
  48
  49         /**
  50          * This model/revision has not been tested and may not work.
  51          */
  52         BWN_QUIRK_UNTESTED              = 1<<0,
  53
  54         /**
  55          * Early dual-band devices did not support accessing multiple PHYs
  56          * from a single WLAN core, and instead used separate 2GHz and 5GHz
  57          * WLAN cores.
  58          *
  59          * However, not all cards with two WLAN cores are fully populated;
  60          * we must whitelist the boards on which a second WLAN core is actually
  61          * usable.
  62          */
  63         BWN_QUIRK_WLAN_DUALCORE         = 1<<1,
  64
  65         /**
  66          * Some early devices shipped with unconnected ethernet cores; set
  67          * this quirk to treat these cores as unpopulated.
  68          */
  69         BWN_QUIRK_ENET_HW_UNPOPULATED   = 1<<2,
  70
  71         /**
  72          * Some PCI/PCIe "Intensi-fi" chipsets shipped with floating USB
  73          * host controller cores; set this quirk to treat these cores as
  74          * unpopulated.
  75          */
  76         BWN_QUIRK_USBH_UNPOPULATED      = 1<<3,
  77
  78         /**
  79          * Some early devices (including all BCM4306 chipsets) shipped with
  80          * floating analog softmodem codec cores; set this quirk to treat these
  81          * cores as unpopulated.
  82          */
  83         BWN_QUIRK_SOFTMODEM_UNPOPULATED = 1<<4,
  84 };
  85
  86 /* PCI device descriptor */
  87 struct bwn_pci_device {
  88         uint16_t        vendor;
  89         uint16_t        device;
  90         const char      *desc;
  91         uint32_t        quirks;
  92 };
  93
  94 #define BWN_BCM_DEV(_devid, _desc, _quirks)             \
  95     { PCI_VENDOR_BROADCOM, PCI_DEVID_ ## _devid,        \
  96         "Broadcom " _desc " Wireless", _quirks }
  97
  98 /* Supported device table */
  99 struct bwn_pci_devcfg {
 100         const struct bhndb_hwcfg        *bridge_hwcfg;
 101         const struct bhndb_hw           *bridge_hwtable;
 102         const struct bhndb_hw_priority  *bridge_hwprio;
 103         const struct bwn_pci_device     *devices;
 104 };
 105
 106 #endif /* _IF_BWN_PCIVAR_H_ */