drivers/net/wireless/brcm80211/brcmfmac/dhd.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 _BRCMF_H_
  22 #define _BRCMF_H_
  23
  24 #include "fweh.h"
  25
  26 #define TOE_TX_CSUM_OL          0x00000001
  27 #define TOE_RX_CSUM_OL          0x00000002
  28
  29 /* For supporting multiple interfaces */
  30 #define BRCMF_MAX_IFS   16
  31
  32 #define DOT11_MAX_DEFAULT_KEYS  4
  33
  34 /* Small, medium and maximum buffer size for dcmd
  35  */
  36 #define BRCMF_DCMD_SMLEN        256
  37 #define BRCMF_DCMD_MEDLEN       1536
  38 #define BRCMF_DCMD_MAXLEN       8192
  39
  40 /* IOCTL from host to device are limited in lenght. A device can only handle
  41  * ethernet frame size. This limitation is to be applied by protocol layer.
  42  */
  43 #define BRCMF_TX_IOCTL_MAX_MSG_SIZE     (ETH_FRAME_LEN+ETH_FCS_LEN)
  44
  45 #define BRCMF_AMPDU_RX_REORDER_MAXFLOWS         256
  46
  47 /* Length of firmware version string stored for
  48  * ethtool driver info which uses 32 bytes as well.
  49  */
  50 #define BRCMF_DRIVER_FIRMWARE_VERSION_LEN       32
  51
  52 /* Bus independent dongle command */
  53 struct brcmf_dcmd {
  54         uint cmd;               /* common dongle cmd definition */
  55         void *buf;              /* pointer to user buffer */
  56         uint len;               /* length of user buffer */
  57         u8 set;                 /* get or set request (optional) */
  58         uint used;              /* bytes read or written (optional) */
  59         uint needed;            /* bytes needed (optional) */
  60 };
  61
  62 /**
  63  * struct brcmf_ampdu_rx_reorder - AMPDU receive reorder info
  64  *
  65  * @pktslots: dynamic allocated array for ordering AMPDU packets.
  66  * @flow_id: AMPDU flow identifier.
  67  * @cur_idx: last AMPDU index from firmware.
  68  * @exp_idx: expected next AMPDU index.
  69  * @max_idx: maximum amount of packets per AMPDU.
  70  * @pend_pkts: number of packets currently in @pktslots.
  71  */
  72 struct brcmf_ampdu_rx_reorder {
  73         struct sk_buff **pktslots;
  74         u8 flow_id;
  75         u8 cur_idx;
  76         u8 exp_idx;
  77         u8 max_idx;
  78         u8 pend_pkts;
  79 };
  80
  81 /* Forward decls for struct brcmf_pub (see below) */
  82 struct brcmf_proto;     /* device communication protocol info */
  83 struct brcmf_cfg80211_dev; /* cfg80211 device info */
  84 struct brcmf_fws_info; /* firmware signalling info */
  85
  86 /* Common structure for module and instance linkage */
  87 struct brcmf_pub {
  88         /* Linkage ponters */
  89         struct brcmf_bus *bus_if;
  90         struct brcmf_proto *proto;
  91         struct brcmf_cfg80211_info *config;
  92
  93         /* Internal brcmf items */
  94         uint hdrlen;            /* Total BRCMF header length (proto + bus) */
  95         uint rxsz;              /* Rx buffer size bus module should use */
  96         u8 wme_dp;              /* wme discard priority */
  97
  98         /* Dongle media info */
  99         char fwver[BRCMF_DRIVER_FIRMWARE_VERSION_LEN];
 100         u8 mac[ETH_ALEN];               /* MAC address obtained from dongle */
 101
 102         /* Multicast data packets sent to dongle */
 103         unsigned long tx_multicast;
 104
 105         struct brcmf_if *iflist[BRCMF_MAX_IFS];
 106
 107         struct mutex proto_block;
 108         unsigned char proto_buf[BRCMF_DCMD_MAXLEN];
 109
 110         struct brcmf_fweh_info fweh;
 111
 112         struct brcmf_fws_info *fws;
 113
 114         struct brcmf_ampdu_rx_reorder
 115                 *reorder_flows[BRCMF_AMPDU_RX_REORDER_MAXFLOWS];
 116 #ifdef DEBUG
 117         struct dentry *dbgfs_dir;
 118 #endif
 119 };
 120
 121 /* forward declarations */
 122 struct brcmf_cfg80211_vif;
 123 struct brcmf_fws_mac_descriptor;
 124
 125 /**
 126  * enum brcmf_netif_stop_reason - reason for stopping netif queue.
 127  *
 128  * @BRCMF_NETIF_STOP_REASON_FWS_FC:
 129  *      netif stopped due to firmware signalling flow control.
 130  * @BRCMF_NETIF_STOP_REASON_BLOCK_BUS:
 131  *      netif stopped due to bus blocking.
 132  */
 133 enum brcmf_netif_stop_reason {
 134         BRCMF_NETIF_STOP_REASON_FWS_FC = 1,
 135         BRCMF_NETIF_STOP_REASON_BLOCK_BUS = 2
 136 };
 137
 138 /**
 139  * struct brcmf_if - interface control information.
 140  *
 141  * @drvr: points to device related information.
 142  * @vif: points to cfg80211 specific interface information.
 143  * @ndev: associated network device.
 144  * @stats: interface specific network statistics.
 145  * @setmacaddr_work: worker object for setting mac address.
 146  * @multicast_work: worker object for multicast provisioning.
 147  * @fws_desc: interface specific firmware-signalling descriptor.
 148  * @ifidx: interface index in device firmware.
 149  * @bssidx: index of bss associated with this interface.
 150  * @mac_addr: assigned mac address.
 151  * @netif_stop: bitmap indicates reason why netif queues are stopped.
 152  * @netif_stop_lock: spinlock for update netif_stop from multiple sources.
 153  * @pend_8021x_cnt: tracks outstanding number of 802.1x frames.
 154  * @pend_8021x_wait: used for signalling change in count.
 155  */
 156 struct brcmf_if {
 157         struct brcmf_pub *drvr;
 158         struct brcmf_cfg80211_vif *vif;
 159         struct net_device *ndev;
 160         struct net_device_stats stats;
 161         struct work_struct setmacaddr_work;
 162         struct work_struct multicast_work;
 163         struct brcmf_fws_mac_descriptor *fws_desc;
 164         int ifidx;
 165         s32 bssidx;
 166         u8 mac_addr[ETH_ALEN];
 167         u8 netif_stop;
 168         spinlock_t netif_stop_lock;
 169         atomic_t pend_8021x_cnt;
 170         wait_queue_head_t pend_8021x_wait;
 171 };
 172
 173 struct brcmf_skb_reorder_data {
 174         u8 *reorder;
 175 };
 176
 177 int brcmf_netdev_wait_pend8021x(struct net_device *ndev);
 178
 179 /* Return pointer to interface name */
 180 char *brcmf_ifname(struct brcmf_pub *drvr, int idx);
 181
 182 int brcmf_net_attach(struct brcmf_if *ifp, bool rtnl_locked);
 183 struct brcmf_if *brcmf_add_if(struct brcmf_pub *drvr, s32 bssidx, s32 ifidx,
 184                               char *name, u8 *mac_addr);
 185 void brcmf_del_if(struct brcmf_pub *drvr, s32 bssidx);
 186 void brcmf_txflowblock_if(struct brcmf_if *ifp,
 187                           enum brcmf_netif_stop_reason reason, bool state);
 188 u32 brcmf_get_chip_info(struct brcmf_if *ifp);
 189 void brcmf_txfinalize(struct brcmf_pub *drvr, struct sk_buff *txp,
 190                       bool success);
 191
 192 /* Sets dongle media info (drv_version, mac address). */
 193 int brcmf_c_preinit_dcmds(struct brcmf_if *ifp);
 194
 195 #endif                          /* _BRCMF_H_ */