LXR linux/drivers/net/wireless/broadcom/brcm80211/brcmfmac/core.h

   1// SPDX-License-Identifier: ISC
   2/*
   3 * Copyright (c) 2010 Broadcom Corporation
   4 */
   5
   6/****************
   7 * Common types *
   8 */
   9
  10#ifndef BRCMFMAC_CORE_H
  11#define BRCMFMAC_CORE_H
  12
  13#include <net/cfg80211.h>
  14#include "fweh.h"
  15
  16#define TOE_TX_CSUM_OL          0x00000001
  17#define TOE_RX_CSUM_OL          0x00000002
  18
  19/* For supporting multiple interfaces */
  20#define BRCMF_MAX_IFS   16
  21
  22/* Small, medium and maximum buffer size for dcmd
  23 */
  24#define BRCMF_DCMD_SMLEN        256
  25#define BRCMF_DCMD_MEDLEN       1536
  26#define BRCMF_DCMD_MAXLEN       8192
  27
  28/* IOCTL from host to device are limited in length. A device can only handle
  29 * ethernet frame size. This limitation is to be applied by protocol layer.
  30 */
  31#define BRCMF_TX_IOCTL_MAX_MSG_SIZE     (ETH_FRAME_LEN+ETH_FCS_LEN)
  32
  33#define BRCMF_AMPDU_RX_REORDER_MAXFLOWS         256
  34
  35/* Length of firmware version string stored for
  36 * ethtool driver info which uses 32 bytes as well.
  37 */
  38#define BRCMF_DRIVER_FIRMWARE_VERSION_LEN       32
  39
  40#define NDOL_MAX_ENTRIES        8
  41
  42/**
  43 * struct brcmf_ampdu_rx_reorder - AMPDU receive reorder info
  44 *
  45 * @pktslots: dynamic allocated array for ordering AMPDU packets.
  46 * @flow_id: AMPDU flow identifier.
  47 * @cur_idx: last AMPDU index from firmware.
  48 * @exp_idx: expected next AMPDU index.
  49 * @max_idx: maximum amount of packets per AMPDU.
  50 * @pend_pkts: number of packets currently in @pktslots.
  51 */
  52struct brcmf_ampdu_rx_reorder {
  53        struct sk_buff **pktslots;
  54        u8 flow_id;
  55        u8 cur_idx;
  56        u8 exp_idx;
  57        u8 max_idx;
  58        u8 pend_pkts;
  59};
  60
  61/* Forward decls for struct brcmf_pub (see below) */
  62struct brcmf_proto;     /* device communication protocol info */
  63struct brcmf_fws_info;  /* firmware signalling info */
  64struct brcmf_mp_device; /* module paramateres, device specific */
  65
  66/*
  67 * struct brcmf_rev_info
  68 *
  69 * The result field stores the error code of the
  70 * revision info request from firmware. For the
  71 * other fields see struct brcmf_rev_info_le in
  72 * fwil_types.h
  73 */
  74struct brcmf_rev_info {
  75        int result;
  76        u32 vendorid;
  77        u32 deviceid;
  78        u32 radiorev;
  79        u32 corerev;
  80        u32 boardid;
  81        u32 boardvendor;
  82        u32 boardrev;
  83        u32 driverrev;
  84        u32 ucoderev;
  85        u32 bus;
  86        char chipname[12];
  87        u32 phytype;
  88        u32 phyrev;
  89        u32 anarev;
  90        u32 chippkg;
  91        u32 nvramrev;
  92};
  93
  94/* Common structure for module and instance linkage */
  95struct brcmf_pub {
  96        /* Linkage ponters */
  97        struct brcmf_bus *bus_if;
  98        struct brcmf_proto *proto;
  99        struct wiphy *wiphy;
 100        struct brcmf_cfg80211_info *config;
 101
 102        /* Internal brcmf items */
 103        uint hdrlen;            /* Total BRCMF header length (proto + bus) */
 104
 105        /* Dongle media info */
 106        char fwver[BRCMF_DRIVER_FIRMWARE_VERSION_LEN];
 107        u8 mac[ETH_ALEN];               /* MAC address obtained from dongle */
 108
 109        struct mac_address addresses[BRCMF_MAX_IFS];
 110
 111        struct brcmf_if *iflist[BRCMF_MAX_IFS];
 112        s32 if2bss[BRCMF_MAX_IFS];
 113        struct brcmf_if *mon_if;
 114
 115        struct mutex proto_block;
 116        unsigned char proto_buf[BRCMF_DCMD_MAXLEN];
 117
 118        struct brcmf_fweh_info fweh;
 119
 120        struct brcmf_ampdu_rx_reorder
 121                *reorder_flows[BRCMF_AMPDU_RX_REORDER_MAXFLOWS];
 122
 123        u32 feat_flags;
 124        u32 chip_quirks;
 125
 126        struct brcmf_rev_info revinfo;
 127#ifdef DEBUG
 128        struct dentry *dbgfs_dir;
 129#endif
 130
 131        struct notifier_block inetaddr_notifier;
 132        struct notifier_block inet6addr_notifier;
 133        struct brcmf_mp_device *settings;
 134
 135        struct work_struct bus_reset;
 136
 137        u8 clmver[BRCMF_DCMD_SMLEN];
 138};
 139
 140/* forward declarations */
 141struct brcmf_cfg80211_vif;
 142struct brcmf_fws_mac_descriptor;
 143
 144/**
 145 * enum brcmf_netif_stop_reason - reason for stopping netif queue.
 146 *
 147 * @BRCMF_NETIF_STOP_REASON_FWS_FC:
 148 *      netif stopped due to firmware signalling flow control.
 149 * @BRCMF_NETIF_STOP_REASON_FLOW:
 150 *      netif stopped due to flowring full.
 151 * @BRCMF_NETIF_STOP_REASON_DISCONNECTED:
 152 *      netif stopped due to not being connected (STA mode).
 153 */
 154enum brcmf_netif_stop_reason {
 155        BRCMF_NETIF_STOP_REASON_FWS_FC = BIT(0),
 156        BRCMF_NETIF_STOP_REASON_FLOW = BIT(1),
 157        BRCMF_NETIF_STOP_REASON_DISCONNECTED = BIT(2)
 158};
 159
 160/**
 161 * struct brcmf_if - interface control information.
 162 *
 163 * @drvr: points to device related information.
 164 * @vif: points to cfg80211 specific interface information.
 165 * @ndev: associated network device.
 166 * @multicast_work: worker object for multicast provisioning.
 167 * @ndoffload_work: worker object for neighbor discovery offload configuration.
 168 * @fws_desc: interface specific firmware-signalling descriptor.
 169 * @ifidx: interface index in device firmware.
 170 * @bsscfgidx: index of bss associated with this interface.
 171 * @mac_addr: assigned mac address.
 172 * @netif_stop: bitmap indicates reason why netif queues are stopped.
 173 * @netif_stop_lock: spinlock for update netif_stop from multiple sources.
 174 * @pend_8021x_cnt: tracks outstanding number of 802.1x frames.
 175 * @pend_8021x_wait: used for signalling change in count.
 176 * @fwil_fwerr: flag indicating fwil layer should return firmware error codes.
 177 */
 178struct brcmf_if {
 179        struct brcmf_pub *drvr;
 180        struct brcmf_cfg80211_vif *vif;
 181        struct net_device *ndev;
 182        struct work_struct multicast_work;
 183        struct work_struct ndoffload_work;
 184        struct brcmf_fws_mac_descriptor *fws_desc;
 185        int ifidx;
 186        s32 bsscfgidx;
 187        u8 mac_addr[ETH_ALEN];
 188        u8 netif_stop;
 189        spinlock_t netif_stop_lock;
 190        atomic_t pend_8021x_cnt;
 191        wait_queue_head_t pend_8021x_wait;
 192        struct in6_addr ipv6_addr_tbl[NDOL_MAX_ENTRIES];
 193        u8 ipv6addr_idx;
 194        bool fwil_fwerr;
 195};
 196
 197int brcmf_netdev_wait_pend8021x(struct brcmf_if *ifp);
 198
 199/* Return pointer to interface name */
 200char *brcmf_ifname(struct brcmf_if *ifp);
 201struct brcmf_if *brcmf_get_ifp(struct brcmf_pub *drvr, int ifidx);
 202void brcmf_configure_arp_nd_offload(struct brcmf_if *ifp, bool enable);
 203int brcmf_net_attach(struct brcmf_if *ifp, bool rtnl_locked);
 204struct brcmf_if *brcmf_add_if(struct brcmf_pub *drvr, s32 bsscfgidx, s32 ifidx,
 205                              bool is_p2pdev, const char *name, u8 *mac_addr);
 206void brcmf_remove_interface(struct brcmf_if *ifp, bool rtnl_locked);
 207void brcmf_txflowblock_if(struct brcmf_if *ifp,
 208                          enum brcmf_netif_stop_reason reason, bool state);
 209void brcmf_txfinalize(struct brcmf_if *ifp, struct sk_buff *txp, bool success);
 210void brcmf_netif_rx(struct brcmf_if *ifp, struct sk_buff *skb);
 211void brcmf_netif_mon_rx(struct brcmf_if *ifp, struct sk_buff *skb);
 212void brcmf_net_setcarrier(struct brcmf_if *ifp, bool on);
 213int __init brcmf_core_init(void);
 214void __exit brcmf_core_exit(void);
 215
 216#endif /* BRCMFMAC_CORE_H */
 217