drivers/net/wireless/brcm80211/brcmfmac/core.h

   1 /*
   2  * Copyright (c) 2010 Broadcom Corporation
   3  *
   4  * Permission to use, copy, modify, and/or distribute this software for any
   5  * purpose with or without fee is hereby granted, provided that the above
   6  * copyright notice and this permission notice appear in all copies.
   7  *
   8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
  11  * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  13  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  14  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15  */
  16
  17 /****************
  18  * Common types *
  19  */
  20
  21 #ifndef BRCMFMAC_CORE_H
  22 #define BRCMFMAC_CORE_H
  23
  24 #include <net/cfg80211.h>
  25 #include "fweh.h"
  26
  27 #define TOE_TX_CSUM_OL          0x00000001
  28 #define TOE_RX_CSUM_OL          0x00000002
  29
  30 /* For supporting multiple interfaces */
  31 #define BRCMF_MAX_IFS   16
  32
  33 /* Small, medium and maximum buffer size for dcmd
  34  */
  35 #define BRCMF_DCMD_SMLEN        256
  36 #define BRCMF_DCMD_MEDLEN       1536
  37 #define BRCMF_DCMD_MAXLEN       8192
  38
  39 /* IOCTL from host to device are limited in lenght. A device can only handle
  40  * ethernet frame size. This limitation is to be applied by protocol layer.
  41  */
  42 #define BRCMF_TX_IOCTL_MAX_MSG_SIZE     (ETH_FRAME_LEN+ETH_FCS_LEN)
  43
  44 #define BRCMF_AMPDU_RX_REORDER_MAXFLOWS         256
  45
  46 /* Length of firmware version string stored for
  47  * ethtool driver info which uses 32 bytes as well.
  48  */
  49 #define BRCMF_DRIVER_FIRMWARE_VERSION_LEN       32
  50
  51 /**
  52  * struct brcmf_ampdu_rx_reorder - AMPDU receive reorder info
  53  *
  54  * @pktslots: dynamic allocated array for ordering AMPDU packets.
  55  * @flow_id: AMPDU flow identifier.
  56  * @cur_idx: last AMPDU index from firmware.
  57  * @exp_idx: expected next AMPDU index.
  58  * @max_idx: maximum amount of packets per AMPDU.
  59  * @pend_pkts: number of packets currently in @pktslots.
  60  */
  61 struct brcmf_ampdu_rx_reorder {
  62         struct sk_buff **pktslots;
  63         u8 flow_id;
  64         u8 cur_idx;
  65         u8 exp_idx;
  66         u8 max_idx;
  67         u8 pend_pkts;
  68 };
  69
  70 /* Forward decls for struct brcmf_pub (see below) */
  71 struct brcmf_proto;     /* device communication protocol info */
  72 struct brcmf_cfg80211_dev; /* cfg80211 device info */
  73 struct brcmf_fws_info; /* firmware signalling info */
  74
  75 /*
  76  * struct brcmf_rev_info
  77  *
  78  * The result field stores the error code of the
  79  * revision info request from firmware. For the
  80  * other fields see struct brcmf_rev_info_le in
  81  * fwil_types.h
  82  */
  83 struct brcmf_rev_info {
  84         int result;
  85         u32 vendorid;
  86         u32 deviceid;
  87         u32 radiorev;
  88         u32 chiprev;
  89         u32 corerev;
  90         u32 boardid;
  91         u32 boardvendor;
  92         u32 boardrev;
  93         u32 driverrev;
  94         u32 ucoderev;
  95         u32 bus;
  96         u32 chipnum;
  97         u32 phytype;
  98         u32 phyrev;
  99         u32 anarev;
 100         u32 chippkg;
 101         u32 nvramrev;
 102 };
 103
 104 /* Common structure for module and instance linkage */
 105 struct brcmf_pub {
 106         /* Linkage ponters */
 107         struct brcmf_bus *bus_if;
 108         struct brcmf_proto *proto;
 109         struct brcmf_cfg80211_info *config;
 110
 111         /* Internal brcmf items */
 112         uint hdrlen;            /* Total BRCMF header length (proto + bus) */
 113         uint rxsz;              /* Rx buffer size bus module should use */
 114
 115         /* Dongle media info */
 116         char fwver[BRCMF_DRIVER_FIRMWARE_VERSION_LEN];
 117         u8 mac[ETH_ALEN];               /* MAC address obtained from dongle */
 118
 119         /* Multicast data packets sent to dongle */
 120         unsigned long tx_multicast;
 121
 122         struct mac_address addresses[BRCMF_MAX_IFS];
 123
 124         struct brcmf_if *iflist[BRCMF_MAX_IFS];
 125
 126         struct mutex proto_block;
 127         unsigned char proto_buf[BRCMF_DCMD_MAXLEN];
 128
 129         struct brcmf_fweh_info fweh;
 130
 131         struct brcmf_fws_info *fws;
 132
 133         struct brcmf_ampdu_rx_reorder
 134                 *reorder_flows[BRCMF_AMPDU_RX_REORDER_MAXFLOWS];
 135
 136         u32 feat_flags;
 137         u32 chip_quirks;
 138
 139         struct brcmf_rev_info revinfo;
 140 #ifdef DEBUG
 141         struct dentry *dbgfs_dir;
 142 #endif
 143 };
 144
 145 /* forward declarations */
 146 struct brcmf_cfg80211_vif;
 147 struct brcmf_fws_mac_descriptor;
 148
 149 /**
 150  * enum brcmf_netif_stop_reason - reason for stopping netif queue.
 151  *
 152  * @BRCMF_NETIF_STOP_REASON_FWS_FC:
 153  *      netif stopped due to firmware signalling flow control.
 154  * @BRCMF_NETIF_STOP_REASON_FLOW:
 155  *      netif stopped due to flowring full.
 156  */
 157 enum brcmf_netif_stop_reason {
 158         BRCMF_NETIF_STOP_REASON_FWS_FC = 1,
 159         BRCMF_NETIF_STOP_REASON_FLOW = 2
 160 };
 161
 162 /**
 163  * struct brcmf_if - interface control information.
 164  *
 165  * @drvr: points to device related information.
 166  * @vif: points to cfg80211 specific interface information.
 167  * @ndev: associated network device.
 168  * @stats: interface specific network statistics.
 169  * @setmacaddr_work: worker object for setting mac address.
 170  * @multicast_work: worker object for multicast provisioning.
 171  * @fws_desc: interface specific firmware-signalling descriptor.
 172  * @ifidx: interface index in device firmware.
 173  * @bssidx: index of bss associated with this interface.
 174  * @mac_addr: assigned mac address.
 175  * @netif_stop: bitmap indicates reason why netif queues are stopped.
 176  * @netif_stop_lock: spinlock for update netif_stop from multiple sources.
 177  * @pend_8021x_cnt: tracks outstanding number of 802.1x frames.
 178  * @pend_8021x_wait: used for signalling change in count.
 179  */
 180 struct brcmf_if {
 181         struct brcmf_pub *drvr;
 182         struct brcmf_cfg80211_vif *vif;
 183         struct net_device *ndev;
 184         struct net_device_stats stats;
 185         struct work_struct setmacaddr_work;
 186         struct work_struct multicast_work;
 187         struct brcmf_fws_mac_descriptor *fws_desc;
 188         int ifidx;
 189         s32 bssidx;
 190         u8 mac_addr[ETH_ALEN];
 191         u8 netif_stop;
 192         spinlock_t netif_stop_lock;
 193         atomic_t pend_8021x_cnt;
 194         wait_queue_head_t pend_8021x_wait;
 195 };
 196
 197 struct brcmf_skb_reorder_data {
 198         u8 *reorder;
 199 };
 200
 201 int brcmf_netdev_wait_pend8021x(struct brcmf_if *ifp);
 202
 203 /* Return pointer to interface name */
 204 char *brcmf_ifname(struct brcmf_pub *drvr, int idx);
 205
 206 int brcmf_net_attach(struct brcmf_if *ifp, bool rtnl_locked);
 207 struct brcmf_if *brcmf_add_if(struct brcmf_pub *drvr, s32 bssidx, s32 ifidx,
 208                               char *name, u8 *mac_addr);
 209 void brcmf_remove_interface(struct brcmf_pub *drvr, u32 bssidx);
 210 int brcmf_get_next_free_bsscfgidx(struct brcmf_pub *drvr);
 211 void brcmf_txflowblock_if(struct brcmf_if *ifp,
 212                           enum brcmf_netif_stop_reason reason, bool state);
 213 void brcmf_txfinalize(struct brcmf_pub *drvr, struct sk_buff *txp, u8 ifidx,
 214                       bool success);
 215 void brcmf_netif_rx(struct brcmf_if *ifp, struct sk_buff *skb);
 216
 217 /* Sets dongle media info (drv_version, mac address). */
 218 int brcmf_c_preinit_dcmds(struct brcmf_if *ifp);
 219
 220 #endif /* BRCMFMAC_CORE_H */