2 * Copyright (c) 2010 Broadcom Corporation
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.
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.
24 #define BRCMF_VERSION_STR "4.218.248.5"
28 /*******************************************************************************
29 * IO codes that are interpreted by dongle firmware
30 ******************************************************************************/
32 #define BRCMF_C_DOWN 3
33 #define BRCMF_C_SET_PROMISC 10
34 #define BRCMF_C_GET_RATE 12
35 #define BRCMF_C_GET_INFRA 19
36 #define BRCMF_C_SET_INFRA 20
37 #define BRCMF_C_GET_AUTH 21
38 #define BRCMF_C_SET_AUTH 22
39 #define BRCMF_C_GET_BSSID 23
40 #define BRCMF_C_GET_SSID 25
41 #define BRCMF_C_SET_SSID 26
42 #define BRCMF_C_GET_CHANNEL 29
43 #define BRCMF_C_GET_SRL 31
44 #define BRCMF_C_GET_LRL 33
45 #define BRCMF_C_GET_RADIO 37
46 #define BRCMF_C_SET_RADIO 38
47 #define BRCMF_C_GET_PHYTYPE 39
48 #define BRCMF_C_SET_KEY 45
49 #define BRCMF_C_SET_PASSIVE_SCAN 49
50 #define BRCMF_C_SCAN 50
51 #define BRCMF_C_SCAN_RESULTS 51
52 #define BRCMF_C_DISASSOC 52
53 #define BRCMF_C_REASSOC 53
54 #define BRCMF_C_SET_ROAM_TRIGGER 55
55 #define BRCMF_C_SET_ROAM_DELTA 57
56 #define BRCMF_C_GET_BCNPRD 75
57 #define BRCMF_C_SET_BCNPRD 76
58 #define BRCMF_C_GET_DTIMPRD 77
59 #define BRCMF_C_SET_DTIMPRD 78
60 #define BRCMF_C_SET_COUNTRY 84
61 #define BRCMF_C_GET_PM 85
62 #define BRCMF_C_SET_PM 86
63 #define BRCMF_C_GET_AP 117
64 #define BRCMF_C_SET_AP 118
65 #define BRCMF_C_GET_RSSI 127
66 #define BRCMF_C_GET_WSEC 133
67 #define BRCMF_C_SET_WSEC 134
68 #define BRCMF_C_GET_PHY_NOISE 135
69 #define BRCMF_C_GET_BSS_INFO 136
70 #define BRCMF_C_SET_SCAN_CHANNEL_TIME 185
71 #define BRCMF_C_SET_SCAN_UNASSOC_TIME 187
72 #define BRCMF_C_SCB_DEAUTHENTICATE_FOR_REASON 201
73 #define BRCMF_C_GET_VALID_CHANNELS 217
74 #define BRCMF_C_GET_KEY_PRIMARY 235
75 #define BRCMF_C_SET_KEY_PRIMARY 236
76 #define BRCMF_C_SET_SCAN_PASSIVE_TIME 258
77 #define BRCMF_C_GET_VAR 262
78 #define BRCMF_C_SET_VAR 263
80 /* phy types (returned by WLC_GET_PHYTPE) */
81 #define WLC_PHY_TYPE_A 0
82 #define WLC_PHY_TYPE_B 1
83 #define WLC_PHY_TYPE_G 2
84 #define WLC_PHY_TYPE_N 4
85 #define WLC_PHY_TYPE_LP 5
86 #define WLC_PHY_TYPE_SSN 6
87 #define WLC_PHY_TYPE_HT 7
88 #define WLC_PHY_TYPE_LCN 8
89 #define WLC_PHY_TYPE_NULL 0xf
91 #define BRCMF_EVENTING_MASK_LEN 16
93 #define TOE_TX_CSUM_OL 0x00000001
94 #define TOE_RX_CSUM_OL 0x00000002
96 #define BRCMF_BSS_INFO_VERSION 109 /* curr ver of brcmf_bss_info_le struct */
98 /* size of brcmf_scan_params not including variable length array */
99 #define BRCMF_SCAN_PARAMS_FIXED_SIZE 64
101 /* masks for channel and ssid count */
102 #define BRCMF_SCAN_PARAMS_COUNT_MASK 0x0000ffff
103 #define BRCMF_SCAN_PARAMS_NSSID_SHIFT 16
105 /* Indicates this key is using soft encrypt */
106 #define WL_SOFT_KEY (1 << 0)
107 /* primary (ie tx) key */
108 #define BRCMF_PRIMARY_KEY (1 << 1)
109 /* Reserved for backward compat */
110 #define WL_KF_RES_4 (1 << 4)
111 /* Reserved for backward compat */
112 #define WL_KF_RES_5 (1 << 5)
113 /* Indicates a group key for a IBSS PEER */
114 #define WL_IBSS_PEER_GROUP_KEY (1 << 6)
116 /* For supporting multiple interfaces */
117 #define BRCMF_MAX_IFS 16
119 #define DOT11_BSSTYPE_ANY 2
120 #define DOT11_MAX_DEFAULT_KEYS 4
122 #define BRCMF_ESCAN_REQ_VERSION 1
124 #define WLC_BSS_RSSI_ON_CHANNEL 0x0002
126 #define BRCMF_MAXRATES_IN_SET 16 /* max # of rates in rateset */
127 #define BRCMF_STA_ASSOC 0x10 /* Associated */
129 #define BRCMF_E_STATUS_SUCCESS 0
130 #define BRCMF_E_STATUS_FAIL 1
131 #define BRCMF_E_STATUS_TIMEOUT 2
132 #define BRCMF_E_STATUS_NO_NETWORKS 3
133 #define BRCMF_E_STATUS_ABORT 4
134 #define BRCMF_E_STATUS_NO_ACK 5
135 #define BRCMF_E_STATUS_UNSOLICITED 6
136 #define BRCMF_E_STATUS_ATTEMPT 7
137 #define BRCMF_E_STATUS_PARTIAL 8
138 #define BRCMF_E_STATUS_NEWSCAN 9
139 #define BRCMF_E_STATUS_NEWASSOC 10
140 #define BRCMF_E_STATUS_11HQUIET 11
141 #define BRCMF_E_STATUS_SUPPRESS 12
142 #define BRCMF_E_STATUS_NOCHANS 13
143 #define BRCMF_E_STATUS_CS_ABORT 15
144 #define BRCMF_E_STATUS_ERROR 16
146 #define BRCMF_E_REASON_INITIAL_ASSOC 0
147 #define BRCMF_E_REASON_LOW_RSSI 1
148 #define BRCMF_E_REASON_DEAUTH 2
149 #define BRCMF_E_REASON_DISASSOC 3
150 #define BRCMF_E_REASON_BCNS_LOST 4
151 #define BRCMF_E_REASON_MINTXRATE 9
152 #define BRCMF_E_REASON_TXFAIL 10
154 #define BRCMF_E_REASON_FAST_ROAM_FAILED 5
155 #define BRCMF_E_REASON_DIRECTED_ROAM 6
156 #define BRCMF_E_REASON_TSPEC_REJECTED 7
157 #define BRCMF_E_REASON_BETTER_AP 8
159 #define BRCMF_E_PRUNE_ENCR_MISMATCH 1
160 #define BRCMF_E_PRUNE_BCAST_BSSID 2
161 #define BRCMF_E_PRUNE_MAC_DENY 3
162 #define BRCMF_E_PRUNE_MAC_NA 4
163 #define BRCMF_E_PRUNE_REG_PASSV 5
164 #define BRCMF_E_PRUNE_SPCT_MGMT 6
165 #define BRCMF_E_PRUNE_RADAR 7
166 #define BRCMF_E_RSN_MISMATCH 8
167 #define BRCMF_E_PRUNE_NO_COMMON_RATES 9
168 #define BRCMF_E_PRUNE_BASIC_RATES 10
169 #define BRCMF_E_PRUNE_CIPHER_NA 12
170 #define BRCMF_E_PRUNE_KNOWN_STA 13
171 #define BRCMF_E_PRUNE_WDS_PEER 15
172 #define BRCMF_E_PRUNE_QBSS_LOAD 16
173 #define BRCMF_E_PRUNE_HOME_AP 17
175 #define BRCMF_E_SUP_OTHER 0
176 #define BRCMF_E_SUP_DECRYPT_KEY_DATA 1
177 #define BRCMF_E_SUP_BAD_UCAST_WEP128 2
178 #define BRCMF_E_SUP_BAD_UCAST_WEP40 3
179 #define BRCMF_E_SUP_UNSUP_KEY_LEN 4
180 #define BRCMF_E_SUP_PW_KEY_CIPHER 5
181 #define BRCMF_E_SUP_MSG3_TOO_MANY_IE 6
182 #define BRCMF_E_SUP_MSG3_IE_MISMATCH 7
183 #define BRCMF_E_SUP_NO_INSTALL_FLAG 8
184 #define BRCMF_E_SUP_MSG3_NO_GTK 9
185 #define BRCMF_E_SUP_GRP_KEY_CIPHER 10
186 #define BRCMF_E_SUP_GRP_MSG1_NO_GTK 11
187 #define BRCMF_E_SUP_GTK_DECRYPT_FAIL 12
188 #define BRCMF_E_SUP_SEND_FAIL 13
189 #define BRCMF_E_SUP_DEAUTH 14
191 #define BRCMF_E_IF_ADD 1
192 #define BRCMF_E_IF_DEL 2
193 #define BRCMF_E_IF_CHANGE 3
195 #define BRCMF_E_IF_ROLE_STA 0
196 #define BRCMF_E_IF_ROLE_AP 1
197 #define BRCMF_E_IF_ROLE_WDS 2
199 #define BRCMF_E_LINK_BCN_LOSS 1
200 #define BRCMF_E_LINK_DISASSOC 2
201 #define BRCMF_E_LINK_ASSOC_REC 3
202 #define BRCMF_E_LINK_BSSCFG_DIS 4
204 /* Small, medium and maximum buffer size for dcmd
206 #define BRCMF_DCMD_SMLEN 256
207 #define BRCMF_DCMD_MEDLEN 1536
208 #define BRCMF_DCMD_MAXLEN 8192
210 /* Pattern matching filter. Specifies an offset within received packets to
211 * start matching, the pattern to match, the size of the pattern, and a bitmask
212 * that indicates which bits within the pattern should be matched.
214 struct brcmf_pkt_filter_pattern_le {
216 * Offset within received packet to start pattern matching.
217 * Offset '0' is the first byte of the ethernet header.
220 /* Size of the pattern. Bitmask must be the same size.*/
223 * Variable length mask and pattern data. mask starts at offset 0.
224 * Pattern immediately follows mask.
226 u8 mask_and_pattern[1];
229 /* IOVAR "pkt_filter_add" parameter. Used to install packet filters. */
230 struct brcmf_pkt_filter_le {
231 __le32 id; /* Unique filter id, specified by app. */
232 __le32 type; /* Filter type (WL_PKT_FILTER_TYPE_xxx). */
233 __le32 negate_match; /* Negate the result of filter matches */
234 union { /* Filter definitions */
235 struct brcmf_pkt_filter_pattern_le pattern; /* Filter pattern */
239 /* IOVAR "pkt_filter_enable" parameter. */
240 struct brcmf_pkt_filter_enable_le {
241 __le32 id; /* Unique filter id */
242 __le32 enable; /* Enable/disable bool */
245 /* BSS info structure
246 * Applications MUST CHECK ie_offset field and length field to access IEs and
247 * next bss_info structure in a vector (in struct brcmf_scan_results)
249 struct brcmf_bss_info_le {
250 __le32 version; /* version field */
251 __le32 length; /* byte length of data in this record,
252 * starting at version and including IEs
255 __le16 beacon_period; /* units are Kusec */
256 __le16 capability; /* Capability information */
260 __le32 count; /* # rates in this set */
261 u8 rates[16]; /* rates in 500kbps units w/hi bit set if basic */
262 } rateset; /* supported rates */
263 __le16 chanspec; /* chanspec for bss */
264 __le16 atim_window; /* units are Kusec */
265 u8 dtim_period; /* DTIM period */
266 __le16 RSSI; /* receive signal strength (in dBm) */
267 s8 phy_noise; /* noise (in dBm) */
269 u8 n_cap; /* BSS is 802.11N Capable */
270 /* 802.11N BSS Capabilities (based on HT_CAP_*): */
272 u8 ctl_ch; /* 802.11N BSS control channel number */
273 __le32 reserved32[1]; /* Reserved for expansion of BSS properties */
274 u8 flags; /* flags */
275 u8 reserved[3]; /* Reserved for expansion of BSS properties */
276 u8 basic_mcs[MCSSET_LEN]; /* 802.11N BSS required MCS set */
278 __le16 ie_offset; /* offset at which IEs start, from beginning */
279 __le32 ie_length; /* byte length of Information Elements */
280 __le16 SNR; /* average SNR of during frame reception */
281 /* Add new fields here */
282 /* variable length Information Elements */
285 struct brcm_rateset_le {
286 /* # rates in this set */
288 /* rates in 500kbps units w/hi bit set if basic */
289 u8 rates[WL_NUMRATES];
294 unsigned char SSID[32];
297 struct brcmf_ssid_le {
299 unsigned char SSID[32];
302 struct brcmf_scan_params_le {
303 struct brcmf_ssid_le ssid_le; /* default: {0, ""} */
304 u8 bssid[ETH_ALEN]; /* default: bcast */
305 s8 bss_type; /* default: any,
306 * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
308 u8 scan_type; /* flags, 0 use default */
309 __le32 nprobes; /* -1 use default, number of probes per channel */
310 __le32 active_time; /* -1 use default, dwell time per channel for
313 __le32 passive_time; /* -1 use default, dwell time per channel
314 * for passive scanning
316 __le32 home_time; /* -1 use default, dwell time for the
317 * home channel between channel scans
319 __le32 channel_num; /* count of channels and ssids that follow
321 * low half is count of channels in
322 * channel_list, 0 means default (use all
323 * available channels)
325 * high half is entries in struct brcmf_ssid
326 * array that follows channel_list, aligned for
327 * s32 (4 bytes) meaning an odd channel count
328 * implies a 2-byte pad between end of
329 * channel_list and first ssid
331 * if ssid count is zero, single ssid in the
332 * fixed parameter portion is assumed, otherwise
333 * ssid in the fixed portion is ignored
335 __le16 channel_list[1]; /* list of chanspecs */
338 struct brcmf_scan_results {
342 struct brcmf_bss_info_le bss_info_le[];
345 struct brcmf_escan_params_le {
349 struct brcmf_scan_params_le params_le;
352 struct brcmf_escan_result_le {
357 struct brcmf_bss_info_le bss_info_le;
360 #define WL_ESCAN_RESULTS_FIXED_SIZE (sizeof(struct brcmf_escan_result_le) - \
361 sizeof(struct brcmf_bss_info_le))
363 /* used for association with a specific BSSID and chanspec list */
364 struct brcmf_assoc_params_le {
365 /* 00:00:00:00:00:00: broadcast scan */
367 /* 0: all available channels, otherwise count of chanspecs in
370 /* list of chanspecs */
371 __le16 chanspec_list[1];
374 /* used for join with or without a specific bssid and channel list */
375 struct brcmf_join_params {
376 struct brcmf_ssid_le ssid_le;
377 struct brcmf_assoc_params_le params_le;
380 struct brcmf_wsec_key {
381 u32 index; /* key index */
382 u32 len; /* key length */
383 u8 data[WLAN_MAX_KEY_LEN]; /* key data */
385 u32 algo; /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
386 u32 flags; /* misc flags */
388 u32 iv_initialized; /* has IV been initialized already? */
392 u32 hi; /* upper 32 bits of IV */
393 u16 lo; /* lower 16 bits of IV */
396 u8 ea[ETH_ALEN]; /* per station */
400 * dongle requires same struct as above but with fields in little endian order
402 struct brcmf_wsec_key_le {
403 __le32 index; /* key index */
404 __le32 len; /* key length */
405 u8 data[WLAN_MAX_KEY_LEN]; /* key data */
407 __le32 algo; /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
408 __le32 flags; /* misc flags */
410 __le32 iv_initialized; /* has IV been initialized already? */
414 __le32 hi; /* upper 32 bits of IV */
415 __le16 lo; /* lower 16 bits of IV */
418 u8 ea[ETH_ALEN]; /* per station */
421 /* Used to get specific STA parameters */
422 struct brcmf_scb_val_le {
427 /* channel encoding */
428 struct brcmf_channel_info_le {
430 __le32 target_channel;
434 struct brcmf_sta_info_le {
435 __le16 ver; /* version of this struct */
436 __le16 len; /* length in bytes of this structure */
437 __le16 cap; /* sta's advertised capabilities */
438 __le32 flags; /* flags defined below */
439 __le32 idle; /* time since data pkt rx'd from sta */
440 u8 ea[ETH_ALEN]; /* Station address */
441 __le32 count; /* # rates in this set */
442 u8 rates[BRCMF_MAXRATES_IN_SET]; /* rates in 500kbps units */
443 /* w/hi bit set if basic */
444 __le32 in; /* seconds elapsed since associated */
445 __le32 listen_interval_inms; /* Min Listen interval in ms for STA */
446 __le32 tx_pkts; /* # of packets transmitted */
447 __le32 tx_failures; /* # of packets failed */
448 __le32 rx_ucast_pkts; /* # of unicast packets received */
449 __le32 rx_mcast_pkts; /* # of multicast packets received */
450 __le32 tx_rate; /* Rate of last successful tx frame */
451 __le32 rx_rate; /* Rate of last successful rx frame */
452 __le32 rx_decrypt_succeeds; /* # of packet decrypted successfully */
453 __le32 rx_decrypt_failures; /* # of packet decrypted failed */
456 /* Bus independent dongle command */
458 uint cmd; /* common dongle cmd definition */
459 void *buf; /* pointer to user buffer */
460 uint len; /* length of user buffer */
461 u8 set; /* get or set request (optional) */
462 uint used; /* bytes read or written (optional) */
463 uint needed; /* bytes needed (optional) */
466 /* Forward decls for struct brcmf_pub (see below) */
467 struct brcmf_proto; /* device communication protocol info */
468 struct brcmf_cfg80211_dev; /* cfg80211 device info */
470 /* Common structure for module and instance linkage */
472 /* Linkage ponters */
473 struct brcmf_bus *bus_if;
474 struct brcmf_proto *prot;
475 struct brcmf_cfg80211_info *config;
476 struct device *dev; /* fullmac dongle device pointer */
478 /* Internal brcmf items */
479 uint hdrlen; /* Total BRCMF header length (proto + bus) */
480 uint rxsz; /* Rx buffer size bus module should use */
481 u8 wme_dp; /* wme discard priority */
483 /* Dongle media info */
484 unsigned long drv_version; /* Version of dongle-resident driver */
485 u8 mac[ETH_ALEN]; /* MAC address obtained from dongle */
487 /* Additional stats for the bus level */
489 /* Multicast data packets sent to dongle */
490 unsigned long tx_multicast;
491 /* Packets flushed due to unscheduled sendup thread */
492 unsigned long rx_flushed;
493 /* Number of times dpc scheduled by watchdog timer */
494 unsigned long wd_dpc_sched;
496 /* Number of flow control pkts recvd */
497 unsigned long fc_packets;
499 /* Last error return */
502 /* Last error from dongle */
505 /* Suspend disable flag flag */
506 int suspend_disable_flag; /* "1" to disable all extra powersaving
508 int in_suspend; /* flag set to 1 when early suspend called */
509 int dtim_skip; /* dtim skip , default 0 means wake each dtim */
511 struct brcmf_if *iflist[BRCMF_MAX_IFS];
513 struct mutex proto_block;
514 unsigned char proto_buf[BRCMF_DCMD_MAXLEN];
516 struct work_struct setmacaddr_work;
517 struct work_struct multicast_work;
518 u8 macvalue[ETH_ALEN];
519 atomic_t pend_8021x_cnt;
520 wait_queue_head_t pend_8021x_wait;
522 struct brcmf_fweh_info fweh;
524 struct dentry *dbgfs_dir;
528 struct bcmevent_name {
533 struct brcmf_if_event {
540 /* forward declaration */
541 struct brcmf_cfg80211_vif;
544 * struct brcmf_if - interface control information.
546 * @drvr: points to device related information.
547 * @vif: points to cfg80211 specific interface information.
548 * @ndev: associated network device.
549 * @stats: interface specific network statistics.
550 * @idx: interface index in device firmware.
551 * @bssidx: index of bss associated with this interface.
552 * @mac_addr: assigned mac address.
555 struct brcmf_pub *drvr;
556 struct brcmf_cfg80211_vif *vif;
557 struct net_device *ndev;
558 struct net_device_stats stats;
561 u8 mac_addr[ETH_ALEN];
564 static inline s32 brcmf_ndev_bssidx(struct net_device *ndev)
566 struct brcmf_if *ifp = netdev_priv(ndev);
570 extern const struct bcmevent_name bcmevent_names[];
572 extern int brcmf_netdev_wait_pend8021x(struct net_device *ndev);
574 /* Return pointer to interface name */
575 extern char *brcmf_ifname(struct brcmf_pub *drvr, int idx);
578 extern int brcmf_proto_cdc_query_dcmd(struct brcmf_pub *drvr, int ifidx,
579 uint cmd, void *buf, uint len);
580 extern int brcmf_proto_cdc_set_dcmd(struct brcmf_pub *drvr, int ifidx, uint cmd,
581 void *buf, uint len);
583 extern int brcmf_ifname2idx(struct brcmf_pub *drvr, char *name);
584 extern int brcmf_c_host_event(struct brcmf_pub *drvr, int *idx,
585 void *pktdata, struct brcmf_event_msg *,
588 extern int brcmf_net_attach(struct brcmf_if *ifp);
589 extern struct brcmf_if *brcmf_add_if(struct brcmf_pub *drvr, int ifidx,
590 s32 bssidx, char *name, u8 *mac_addr);
591 extern void brcmf_del_if(struct brcmf_pub *drvr, int ifidx);
593 #endif /* _BRCMF_H_ */