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 "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/* Small, medium and maximum buffer size for dcmd 33 */ 34#define BRCMF_DCMD_SMLEN 256 35#define BRCMF_DCMD_MEDLEN 1536 36#define BRCMF_DCMD_MAXLEN 8192 37 38/* IOCTL from host to device are limited in lenght. A device can only handle 39 * ethernet frame size. This limitation is to be applied by protocol layer. 40 */ 41#define BRCMF_TX_IOCTL_MAX_MSG_SIZE (ETH_FRAME_LEN+ETH_FCS_LEN) 42 43#define BRCMF_AMPDU_RX_REORDER_MAXFLOWS 256 44 45/* Length of firmware version string stored for 46 * ethtool driver info which uses 32 bytes as well. 47 */ 48#define BRCMF_DRIVER_FIRMWARE_VERSION_LEN 32 49 50/** 51 * struct brcmf_ampdu_rx_reorder - AMPDU receive reorder info 52 * 53 * @pktslots: dynamic allocated array for ordering AMPDU packets. 54 * @flow_id: AMPDU flow identifier. 55 * @cur_idx: last AMPDU index from firmware. 56 * @exp_idx: expected next AMPDU index. 57 * @max_idx: maximum amount of packets per AMPDU. 58 * @pend_pkts: number of packets currently in @pktslots. 59 */ 60struct brcmf_ampdu_rx_reorder { 61 struct sk_buff **pktslots; 62 u8 flow_id; 63 u8 cur_idx; 64 u8 exp_idx; 65 u8 max_idx; 66 u8 pend_pkts; 67}; 68 69/* Forward decls for struct brcmf_pub (see below) */ 70struct brcmf_proto; /* device communication protocol info */ 71struct brcmf_cfg80211_dev; /* cfg80211 device info */ 72struct brcmf_fws_info; /* firmware signalling info */ 73 74/* 75 * struct brcmf_rev_info 76 * 77 * The result field stores the error code of the 78 * revision info request from firmware. For the 79 * other fields see struct brcmf_rev_info_le in 80 * fwil_types.h 81 */ 82struct brcmf_rev_info { 83 int result; 84 u32 vendorid; 85 u32 deviceid; 86 u32 radiorev; 87 u32 chiprev; 88 u32 corerev; 89 u32 boardid; 90 u32 boardvendor; 91 u32 boardrev; 92 u32 driverrev; 93 u32 ucoderev; 94 u32 bus; 95 u32 chipnum; 96 u32 phytype; 97 u32 phyrev; 98 u32 anarev; 99 u32 chippkg; 100 u32 nvramrev; 101}; 102 103/* Common structure for module and instance linkage */ 104struct brcmf_pub { 105 /* Linkage ponters */ 106 struct brcmf_bus *bus_if; 107 struct brcmf_proto *proto; 108 struct brcmf_cfg80211_info *config; 109 110 /* Internal brcmf items */ 111 uint hdrlen; /* Total BRCMF header length (proto + bus) */ 112 uint rxsz; /* Rx buffer size bus module should use */ 113 114 /* Dongle media info */ 115 char fwver[BRCMF_DRIVER_FIRMWARE_VERSION_LEN]; 116 u8 mac[ETH_ALEN]; /* MAC address obtained from dongle */ 117 118 /* Multicast data packets sent to dongle */ 119 unsigned long tx_multicast; 120 121 struct brcmf_if *iflist[BRCMF_MAX_IFS]; 122 123 struct mutex proto_block; 124 unsigned char proto_buf[BRCMF_DCMD_MAXLEN]; 125 126 struct brcmf_fweh_info fweh; 127 128 struct brcmf_fws_info *fws; 129 130 struct brcmf_ampdu_rx_reorder 131 *reorder_flows[BRCMF_AMPDU_RX_REORDER_MAXFLOWS]; 132 133 u32 feat_flags; 134 u32 chip_quirks; 135 136 struct brcmf_rev_info revinfo; 137#ifdef DEBUG 138 struct dentry *dbgfs_dir; 139#endif 140}; 141 142/* forward declarations */ 143struct brcmf_cfg80211_vif; 144struct brcmf_fws_mac_descriptor; 145 146/** 147 * enum brcmf_netif_stop_reason - reason for stopping netif queue. 148 * 149 * @BRCMF_NETIF_STOP_REASON_FWS_FC: 150 * netif stopped due to firmware signalling flow control. 151 * @BRCMF_NETIF_STOP_REASON_FLOW: 152 * netif stopped due to flowring full. 153 */ 154enum brcmf_netif_stop_reason { 155 BRCMF_NETIF_STOP_REASON_FWS_FC = 1, 156 BRCMF_NETIF_STOP_REASON_FLOW = 2 157}; 158 159/** 160 * struct brcmf_if - interface control information. 161 * 162 * @drvr: points to device related information. 163 * @vif: points to cfg80211 specific interface information. 164 * @ndev: associated network device. 165 * @stats: interface specific network statistics. 166 * @setmacaddr_work: worker object for setting mac address. 167 * @multicast_work: worker object for multicast provisioning. 168 * @fws_desc: interface specific firmware-signalling descriptor. 169 * @ifidx: interface index in device firmware. 170 * @bssidx: 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 */ 177struct brcmf_if { 178 struct brcmf_pub *drvr; 179 struct brcmf_cfg80211_vif *vif; 180 struct net_device *ndev; 181 struct net_device_stats stats; 182 struct work_struct setmacaddr_work; 183 struct work_struct multicast_work; 184 struct brcmf_fws_mac_descriptor *fws_desc; 185 int ifidx; 186 s32 bssidx; 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}; 193 194struct brcmf_skb_reorder_data { 195 u8 *reorder; 196}; 197 198int brcmf_netdev_wait_pend8021x(struct brcmf_if *ifp); 199 200/* Return pointer to interface name */ 201char *brcmf_ifname(struct brcmf_pub *drvr, int idx); 202 203int brcmf_net_attach(struct brcmf_if *ifp, bool rtnl_locked); 204struct brcmf_if *brcmf_add_if(struct brcmf_pub *drvr, s32 bssidx, s32 ifidx, 205 char *name, u8 *mac_addr); 206void brcmf_remove_interface(struct brcmf_pub *drvr, u32 bssidx); 207int brcmf_get_next_free_bsscfgidx(struct brcmf_pub *drvr); 208void brcmf_txflowblock_if(struct brcmf_if *ifp, 209 enum brcmf_netif_stop_reason reason, bool state); 210void brcmf_txfinalize(struct brcmf_pub *drvr, struct sk_buff *txp, u8 ifidx, 211 bool success); 212void brcmf_netif_rx(struct brcmf_if *ifp, struct sk_buff *skb); 213 214/* Sets dongle media info (drv_version, mac address). */ 215int brcmf_c_preinit_dcmds(struct brcmf_if *ifp); 216 217#endif /* BRCMFMAC_CORE_H */ 218