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 /** 53 * struct brcmf_ampdu_rx_reorder - AMPDU receive reorder info 54 * 55 * @pktslots: dynamic allocated array for ordering AMPDU packets. 56 * @flow_id: AMPDU flow identifier. 57 * @cur_idx: last AMPDU index from firmware. 58 * @exp_idx: expected next AMPDU index. 59 * @max_idx: maximum amount of packets per AMPDU. 60 * @pend_pkts: number of packets currently in @pktslots. 61 */ 62 struct brcmf_ampdu_rx_reorder { 63 struct sk_buff **pktslots; 64 u8 flow_id; 65 u8 cur_idx; 66 u8 exp_idx; 67 u8 max_idx; 68 u8 pend_pkts; 69 }; 70 71 /* Forward decls for struct brcmf_pub (see below) */ 72 struct brcmf_proto; /* device communication protocol info */ 73 struct brcmf_cfg80211_dev; /* cfg80211 device info */ 74 struct brcmf_fws_info; /* firmware signalling info */ 75 76 /* Common structure for module and instance linkage */ 77 struct brcmf_pub { 78 /* Linkage ponters */ 79 struct brcmf_bus *bus_if; 80 struct brcmf_proto *proto; 81 struct brcmf_cfg80211_info *config; 82 83 /* Internal brcmf items */ 84 uint hdrlen; /* Total BRCMF header length (proto + bus) */ 85 uint rxsz; /* Rx buffer size bus module should use */ 86 u8 wme_dp; /* wme discard priority */ 87 88 /* Dongle media info */ 89 char fwver[BRCMF_DRIVER_FIRMWARE_VERSION_LEN]; 90 u8 mac[ETH_ALEN]; /* MAC address obtained from dongle */ 91 92 /* Multicast data packets sent to dongle */ 93 unsigned long tx_multicast; 94 95 struct brcmf_if *iflist[BRCMF_MAX_IFS]; 96 97 struct mutex proto_block; 98 unsigned char proto_buf[BRCMF_DCMD_MAXLEN]; 99 100 struct brcmf_fweh_info fweh; 101 102 struct brcmf_fws_info *fws; 103 104 struct brcmf_ampdu_rx_reorder 105 *reorder_flows[BRCMF_AMPDU_RX_REORDER_MAXFLOWS]; 106 107 u32 feat_flags; 108 u32 chip_quirks; 109 110 #ifdef DEBUG 111 struct dentry *dbgfs_dir; 112 #endif 113 }; 114 115 /* forward declarations */ 116 struct brcmf_cfg80211_vif; 117 struct brcmf_fws_mac_descriptor; 118 119 /** 120 * enum brcmf_netif_stop_reason - reason for stopping netif queue. 121 * 122 * @BRCMF_NETIF_STOP_REASON_FWS_FC: 123 * netif stopped due to firmware signalling flow control. 124 * @BRCMF_NETIF_STOP_REASON_FLOW: 125 * netif stopped due to flowring full. 126 */ 127 enum brcmf_netif_stop_reason { 128 BRCMF_NETIF_STOP_REASON_FWS_FC = 1, 129 BRCMF_NETIF_STOP_REASON_FLOW = 2 130 }; 131 132 /** 133 * struct brcmf_if - interface control information. 134 * 135 * @drvr: points to device related information. 136 * @vif: points to cfg80211 specific interface information. 137 * @ndev: associated network device. 138 * @stats: interface specific network statistics. 139 * @setmacaddr_work: worker object for setting mac address. 140 * @multicast_work: worker object for multicast provisioning. 141 * @fws_desc: interface specific firmware-signalling descriptor. 142 * @ifidx: interface index in device firmware. 143 * @bssidx: index of bss associated with this interface. 144 * @mac_addr: assigned mac address. 145 * @netif_stop: bitmap indicates reason why netif queues are stopped. 146 * @netif_stop_lock: spinlock for update netif_stop from multiple sources. 147 * @pend_8021x_cnt: tracks outstanding number of 802.1x frames. 148 * @pend_8021x_wait: used for signalling change in count. 149 */ 150 struct brcmf_if { 151 struct brcmf_pub *drvr; 152 struct brcmf_cfg80211_vif *vif; 153 struct net_device *ndev; 154 struct net_device_stats stats; 155 struct work_struct setmacaddr_work; 156 struct work_struct multicast_work; 157 struct brcmf_fws_mac_descriptor *fws_desc; 158 int ifidx; 159 s32 bssidx; 160 u8 mac_addr[ETH_ALEN]; 161 u8 netif_stop; 162 spinlock_t netif_stop_lock; 163 atomic_t pend_8021x_cnt; 164 wait_queue_head_t pend_8021x_wait; 165 }; 166 167 struct brcmf_skb_reorder_data { 168 u8 *reorder; 169 }; 170 171 int brcmf_netdev_wait_pend8021x(struct net_device *ndev); 172 173 /* Return pointer to interface name */ 174 char *brcmf_ifname(struct brcmf_pub *drvr, int idx); 175 176 int brcmf_net_attach(struct brcmf_if *ifp, bool rtnl_locked); 177 struct brcmf_if *brcmf_add_if(struct brcmf_pub *drvr, s32 bssidx, s32 ifidx, 178 char *name, u8 *mac_addr); 179 void brcmf_del_if(struct brcmf_pub *drvr, s32 bssidx); 180 void brcmf_txflowblock_if(struct brcmf_if *ifp, 181 enum brcmf_netif_stop_reason reason, bool state); 182 void brcmf_txfinalize(struct brcmf_pub *drvr, struct sk_buff *txp, u8 ifidx, 183 bool success); 184 void brcmf_netif_rx(struct brcmf_if *ifp, struct sk_buff *skb); 185 186 /* Sets dongle media info (drv_version, mac address). */ 187 int brcmf_c_preinit_dcmds(struct brcmf_if *ifp); 188 189 #endif /* _BRCMF_H_ */ 190