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_TERMINATED 28
43 #define BRCMF_C_GET_CHANNEL 29
44 #define BRCMF_C_SET_CHANNEL 30
45 #define BRCMF_C_GET_SRL 31
46 #define BRCMF_C_SET_SRL 32
47 #define BRCMF_C_GET_LRL 33
48 #define BRCMF_C_SET_LRL 34
49 #define BRCMF_C_GET_RADIO 37
50 #define BRCMF_C_SET_RADIO 38
51 #define BRCMF_C_GET_PHYTYPE 39
52 #define BRCMF_C_SET_KEY 45
53 #define BRCMF_C_SET_PASSIVE_SCAN 49
54 #define BRCMF_C_SCAN 50
55 #define BRCMF_C_SCAN_RESULTS 51
56 #define BRCMF_C_DISASSOC 52
57 #define BRCMF_C_REASSOC 53
58 #define BRCMF_C_SET_ROAM_TRIGGER 55
59 #define BRCMF_C_SET_ROAM_DELTA 57
60 #define BRCMF_C_GET_BCNPRD 75
61 #define BRCMF_C_SET_BCNPRD 76
62 #define BRCMF_C_GET_DTIMPRD 77
63 #define BRCMF_C_SET_DTIMPRD 78
64 #define BRCMF_C_SET_COUNTRY 84
65 #define BRCMF_C_GET_PM 85
66 #define BRCMF_C_SET_PM 86
67 #define BRCMF_C_GET_CURR_RATESET 114
68 #define BRCMF_C_GET_AP 117
69 #define BRCMF_C_SET_AP 118
70 #define BRCMF_C_GET_RSSI 127
71 #define BRCMF_C_GET_WSEC 133
72 #define BRCMF_C_SET_WSEC 134
73 #define BRCMF_C_GET_PHY_NOISE 135
74 #define BRCMF_C_GET_BSS_INFO 136
75 #define BRCMF_C_GET_PHYLIST 180
76 #define BRCMF_C_SET_SCAN_CHANNEL_TIME 185
77 #define BRCMF_C_SET_SCAN_UNASSOC_TIME 187
78 #define BRCMF_C_SCB_DEAUTHENTICATE_FOR_REASON 201
79 #define BRCMF_C_GET_VALID_CHANNELS 217
80 #define BRCMF_C_GET_KEY_PRIMARY 235
81 #define BRCMF_C_SET_KEY_PRIMARY 236
82 #define BRCMF_C_SET_SCAN_PASSIVE_TIME 258
83 #define BRCMF_C_GET_VAR 262
84 #define BRCMF_C_SET_VAR 263
86 /* phy types (returned by WLC_GET_PHYTPE) */
87 #define WLC_PHY_TYPE_A 0
88 #define WLC_PHY_TYPE_B 1
89 #define WLC_PHY_TYPE_G 2
90 #define WLC_PHY_TYPE_N 4
91 #define WLC_PHY_TYPE_LP 5
92 #define WLC_PHY_TYPE_SSN 6
93 #define WLC_PHY_TYPE_HT 7
94 #define WLC_PHY_TYPE_LCN 8
95 #define WLC_PHY_TYPE_NULL 0xf
97 #define BRCMF_EVENTING_MASK_LEN 16
99 #define TOE_TX_CSUM_OL 0x00000001
100 #define TOE_RX_CSUM_OL 0x00000002
102 #define BRCMF_BSS_INFO_VERSION 109 /* curr ver of brcmf_bss_info_le struct */
104 /* size of brcmf_scan_params not including variable length array */
105 #define BRCMF_SCAN_PARAMS_FIXED_SIZE 64
107 /* masks for channel and ssid count */
108 #define BRCMF_SCAN_PARAMS_COUNT_MASK 0x0000ffff
109 #define BRCMF_SCAN_PARAMS_NSSID_SHIFT 16
111 /* primary (ie tx) key */
112 #define BRCMF_PRIMARY_KEY (1 << 1)
114 /* For supporting multiple interfaces */
115 #define BRCMF_MAX_IFS 16
117 #define DOT11_BSSTYPE_ANY 2
118 #define DOT11_MAX_DEFAULT_KEYS 4
120 #define BRCMF_ESCAN_REQ_VERSION 1
122 #define WLC_BSS_RSSI_ON_CHANNEL 0x0002
124 #define BRCMF_MAXRATES_IN_SET 16 /* max # of rates in rateset */
125 #define BRCMF_STA_ASSOC 0x10 /* Associated */
127 #define BRCMF_E_STATUS_SUCCESS 0
128 #define BRCMF_E_STATUS_FAIL 1
129 #define BRCMF_E_STATUS_TIMEOUT 2
130 #define BRCMF_E_STATUS_NO_NETWORKS 3
131 #define BRCMF_E_STATUS_ABORT 4
132 #define BRCMF_E_STATUS_NO_ACK 5
133 #define BRCMF_E_STATUS_UNSOLICITED 6
134 #define BRCMF_E_STATUS_ATTEMPT 7
135 #define BRCMF_E_STATUS_PARTIAL 8
136 #define BRCMF_E_STATUS_NEWSCAN 9
137 #define BRCMF_E_STATUS_NEWASSOC 10
138 #define BRCMF_E_STATUS_11HQUIET 11
139 #define BRCMF_E_STATUS_SUPPRESS 12
140 #define BRCMF_E_STATUS_NOCHANS 13
141 #define BRCMF_E_STATUS_CS_ABORT 15
142 #define BRCMF_E_STATUS_ERROR 16
144 #define BRCMF_E_REASON_INITIAL_ASSOC 0
145 #define BRCMF_E_REASON_LOW_RSSI 1
146 #define BRCMF_E_REASON_DEAUTH 2
147 #define BRCMF_E_REASON_DISASSOC 3
148 #define BRCMF_E_REASON_BCNS_LOST 4
149 #define BRCMF_E_REASON_MINTXRATE 9
150 #define BRCMF_E_REASON_TXFAIL 10
152 #define BRCMF_E_REASON_FAST_ROAM_FAILED 5
153 #define BRCMF_E_REASON_DIRECTED_ROAM 6
154 #define BRCMF_E_REASON_TSPEC_REJECTED 7
155 #define BRCMF_E_REASON_BETTER_AP 8
157 #define BRCMF_E_PRUNE_ENCR_MISMATCH 1
158 #define BRCMF_E_PRUNE_BCAST_BSSID 2
159 #define BRCMF_E_PRUNE_MAC_DENY 3
160 #define BRCMF_E_PRUNE_MAC_NA 4
161 #define BRCMF_E_PRUNE_REG_PASSV 5
162 #define BRCMF_E_PRUNE_SPCT_MGMT 6
163 #define BRCMF_E_PRUNE_RADAR 7
164 #define BRCMF_E_RSN_MISMATCH 8
165 #define BRCMF_E_PRUNE_NO_COMMON_RATES 9
166 #define BRCMF_E_PRUNE_BASIC_RATES 10
167 #define BRCMF_E_PRUNE_CIPHER_NA 12
168 #define BRCMF_E_PRUNE_KNOWN_STA 13
169 #define BRCMF_E_PRUNE_WDS_PEER 15
170 #define BRCMF_E_PRUNE_QBSS_LOAD 16
171 #define BRCMF_E_PRUNE_HOME_AP 17
173 #define BRCMF_E_SUP_OTHER 0
174 #define BRCMF_E_SUP_DECRYPT_KEY_DATA 1
175 #define BRCMF_E_SUP_BAD_UCAST_WEP128 2
176 #define BRCMF_E_SUP_BAD_UCAST_WEP40 3
177 #define BRCMF_E_SUP_UNSUP_KEY_LEN 4
178 #define BRCMF_E_SUP_PW_KEY_CIPHER 5
179 #define BRCMF_E_SUP_MSG3_TOO_MANY_IE 6
180 #define BRCMF_E_SUP_MSG3_IE_MISMATCH 7
181 #define BRCMF_E_SUP_NO_INSTALL_FLAG 8
182 #define BRCMF_E_SUP_MSG3_NO_GTK 9
183 #define BRCMF_E_SUP_GRP_KEY_CIPHER 10
184 #define BRCMF_E_SUP_GRP_MSG1_NO_GTK 11
185 #define BRCMF_E_SUP_GTK_DECRYPT_FAIL 12
186 #define BRCMF_E_SUP_SEND_FAIL 13
187 #define BRCMF_E_SUP_DEAUTH 14
189 #define BRCMF_E_IF_ADD 1
190 #define BRCMF_E_IF_DEL 2
191 #define BRCMF_E_IF_CHANGE 3
193 #define BRCMF_E_IF_ROLE_STA 0
194 #define BRCMF_E_IF_ROLE_AP 1
195 #define BRCMF_E_IF_ROLE_WDS 2
197 #define BRCMF_E_LINK_BCN_LOSS 1
198 #define BRCMF_E_LINK_DISASSOC 2
199 #define BRCMF_E_LINK_ASSOC_REC 3
200 #define BRCMF_E_LINK_BSSCFG_DIS 4
202 /* Small, medium and maximum buffer size for dcmd
204 #define BRCMF_DCMD_SMLEN 256
205 #define BRCMF_DCMD_MEDLEN 1536
206 #define BRCMF_DCMD_MAXLEN 8192
208 /* Pattern matching filter. Specifies an offset within received packets to
209 * start matching, the pattern to match, the size of the pattern, and a bitmask
210 * that indicates which bits within the pattern should be matched.
212 struct brcmf_pkt_filter_pattern_le
{
214 * Offset within received packet to start pattern matching.
215 * Offset '0' is the first byte of the ethernet header.
218 /* Size of the pattern. Bitmask must be the same size.*/
221 * Variable length mask and pattern data. mask starts at offset 0.
222 * Pattern immediately follows mask.
224 u8 mask_and_pattern
[1];
227 /* IOVAR "pkt_filter_add" parameter. Used to install packet filters. */
228 struct brcmf_pkt_filter_le
{
229 __le32 id
; /* Unique filter id, specified by app. */
230 __le32 type
; /* Filter type (WL_PKT_FILTER_TYPE_xxx). */
231 __le32 negate_match
; /* Negate the result of filter matches */
232 union { /* Filter definitions */
233 struct brcmf_pkt_filter_pattern_le pattern
; /* Filter pattern */
237 /* IOVAR "pkt_filter_enable" parameter. */
238 struct brcmf_pkt_filter_enable_le
{
239 __le32 id
; /* Unique filter id */
240 __le32 enable
; /* Enable/disable bool */
243 /* BSS info structure
244 * Applications MUST CHECK ie_offset field and length field to access IEs and
245 * next bss_info structure in a vector (in struct brcmf_scan_results)
247 struct brcmf_bss_info_le
{
248 __le32 version
; /* version field */
249 __le32 length
; /* byte length of data in this record,
250 * starting at version and including IEs
253 __le16 beacon_period
; /* units are Kusec */
254 __le16 capability
; /* Capability information */
258 __le32 count
; /* # rates in this set */
259 u8 rates
[16]; /* rates in 500kbps units w/hi bit set if basic */
260 } rateset
; /* supported rates */
261 __le16 chanspec
; /* chanspec for bss */
262 __le16 atim_window
; /* units are Kusec */
263 u8 dtim_period
; /* DTIM period */
264 __le16 RSSI
; /* receive signal strength (in dBm) */
265 s8 phy_noise
; /* noise (in dBm) */
267 u8 n_cap
; /* BSS is 802.11N Capable */
268 /* 802.11N BSS Capabilities (based on HT_CAP_*): */
270 u8 ctl_ch
; /* 802.11N BSS control channel number */
271 __le32 reserved32
[1]; /* Reserved for expansion of BSS properties */
272 u8 flags
; /* flags */
273 u8 reserved
[3]; /* Reserved for expansion of BSS properties */
274 u8 basic_mcs
[MCSSET_LEN
]; /* 802.11N BSS required MCS set */
276 __le16 ie_offset
; /* offset at which IEs start, from beginning */
277 __le32 ie_length
; /* byte length of Information Elements */
278 __le16 SNR
; /* average SNR of during frame reception */
279 /* Add new fields here */
280 /* variable length Information Elements */
283 struct brcm_rateset_le
{
284 /* # rates in this set */
286 /* rates in 500kbps units w/hi bit set if basic */
287 u8 rates
[BRCMF_MAXRATES_IN_SET
];
292 unsigned char SSID
[32];
295 struct brcmf_ssid_le
{
297 unsigned char SSID
[32];
300 struct brcmf_scan_params_le
{
301 struct brcmf_ssid_le ssid_le
; /* default: {0, ""} */
302 u8 bssid
[ETH_ALEN
]; /* default: bcast */
303 s8 bss_type
; /* default: any,
304 * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
306 u8 scan_type
; /* flags, 0 use default */
307 __le32 nprobes
; /* -1 use default, number of probes per channel */
308 __le32 active_time
; /* -1 use default, dwell time per channel for
311 __le32 passive_time
; /* -1 use default, dwell time per channel
312 * for passive scanning
314 __le32 home_time
; /* -1 use default, dwell time for the
315 * home channel between channel scans
317 __le32 channel_num
; /* count of channels and ssids that follow
319 * low half is count of channels in
320 * channel_list, 0 means default (use all
321 * available channels)
323 * high half is entries in struct brcmf_ssid
324 * array that follows channel_list, aligned for
325 * s32 (4 bytes) meaning an odd channel count
326 * implies a 2-byte pad between end of
327 * channel_list and first ssid
329 * if ssid count is zero, single ssid in the
330 * fixed parameter portion is assumed, otherwise
331 * ssid in the fixed portion is ignored
333 __le16 channel_list
[1]; /* list of chanspecs */
336 struct brcmf_scan_results
{
340 struct brcmf_bss_info_le bss_info_le
[];
343 struct brcmf_escan_params_le
{
347 struct brcmf_scan_params_le params_le
;
350 struct brcmf_escan_result_le
{
355 struct brcmf_bss_info_le bss_info_le
;
358 #define WL_ESCAN_RESULTS_FIXED_SIZE (sizeof(struct brcmf_escan_result_le) - \
359 sizeof(struct brcmf_bss_info_le))
361 /* used for association with a specific BSSID and chanspec list */
362 struct brcmf_assoc_params_le
{
363 /* 00:00:00:00:00:00: broadcast scan */
365 /* 0: all available channels, otherwise count of chanspecs in
368 /* list of chanspecs */
369 __le16 chanspec_list
[1];
372 /* used for join with or without a specific bssid and channel list */
373 struct brcmf_join_params
{
374 struct brcmf_ssid_le ssid_le
;
375 struct brcmf_assoc_params_le params_le
;
378 struct brcmf_wsec_key
{
379 u32 index
; /* key index */
380 u32 len
; /* key length */
381 u8 data
[WLAN_MAX_KEY_LEN
]; /* key data */
383 u32 algo
; /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
384 u32 flags
; /* misc flags */
386 u32 iv_initialized
; /* has IV been initialized already? */
390 u32 hi
; /* upper 32 bits of IV */
391 u16 lo
; /* lower 16 bits of IV */
394 u8 ea
[ETH_ALEN
]; /* per station */
398 * dongle requires same struct as above but with fields in little endian order
400 struct brcmf_wsec_key_le
{
401 __le32 index
; /* key index */
402 __le32 len
; /* key length */
403 u8 data
[WLAN_MAX_KEY_LEN
]; /* key data */
405 __le32 algo
; /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
406 __le32 flags
; /* misc flags */
408 __le32 iv_initialized
; /* has IV been initialized already? */
412 __le32 hi
; /* upper 32 bits of IV */
413 __le16 lo
; /* lower 16 bits of IV */
416 u8 ea
[ETH_ALEN
]; /* per station */
419 /* Used to get specific STA parameters */
420 struct brcmf_scb_val_le
{
425 /* channel encoding */
426 struct brcmf_channel_info_le
{
428 __le32 target_channel
;
432 struct brcmf_sta_info_le
{
433 __le16 ver
; /* version of this struct */
434 __le16 len
; /* length in bytes of this structure */
435 __le16 cap
; /* sta's advertised capabilities */
436 __le32 flags
; /* flags defined below */
437 __le32 idle
; /* time since data pkt rx'd from sta */
438 u8 ea
[ETH_ALEN
]; /* Station address */
439 __le32 count
; /* # rates in this set */
440 u8 rates
[BRCMF_MAXRATES_IN_SET
]; /* rates in 500kbps units */
441 /* w/hi bit set if basic */
442 __le32 in
; /* seconds elapsed since associated */
443 __le32 listen_interval_inms
; /* Min Listen interval in ms for STA */
444 __le32 tx_pkts
; /* # of packets transmitted */
445 __le32 tx_failures
; /* # of packets failed */
446 __le32 rx_ucast_pkts
; /* # of unicast packets received */
447 __le32 rx_mcast_pkts
; /* # of multicast packets received */
448 __le32 tx_rate
; /* Rate of last successful tx frame */
449 __le32 rx_rate
; /* Rate of last successful rx frame */
450 __le32 rx_decrypt_succeeds
; /* # of packet decrypted successfully */
451 __le32 rx_decrypt_failures
; /* # of packet decrypted failed */
454 /* Bus independent dongle command */
456 uint cmd
; /* common dongle cmd definition */
457 void *buf
; /* pointer to user buffer */
458 uint len
; /* length of user buffer */
459 u8 set
; /* get or set request (optional) */
460 uint used
; /* bytes read or written (optional) */
461 uint needed
; /* bytes needed (optional) */
464 /* Forward decls for struct brcmf_pub (see below) */
465 struct brcmf_proto
; /* device communication protocol info */
466 struct brcmf_cfg80211_dev
; /* cfg80211 device info */
468 /* Common structure for module and instance linkage */
470 /* Linkage ponters */
471 struct brcmf_bus
*bus_if
;
472 struct brcmf_proto
*prot
;
473 struct brcmf_cfg80211_info
*config
;
475 /* Internal brcmf items */
476 uint hdrlen
; /* Total BRCMF header length (proto + bus) */
477 uint rxsz
; /* Rx buffer size bus module should use */
478 u8 wme_dp
; /* wme discard priority */
480 /* Dongle media info */
481 unsigned long drv_version
; /* Version of dongle-resident driver */
482 u8 mac
[ETH_ALEN
]; /* MAC address obtained from dongle */
484 /* Multicast data packets sent to dongle */
485 unsigned long tx_multicast
;
487 struct brcmf_if
*iflist
[BRCMF_MAX_IFS
];
489 struct mutex proto_block
;
490 unsigned char proto_buf
[BRCMF_DCMD_MAXLEN
];
492 atomic_t pend_8021x_cnt
;
493 wait_queue_head_t pend_8021x_wait
;
495 struct brcmf_fweh_info fweh
;
497 struct dentry
*dbgfs_dir
;
501 struct brcmf_if_event
{
508 /* forward declaration */
509 struct brcmf_cfg80211_vif
;
512 * struct brcmf_if - interface control information.
514 * @drvr: points to device related information.
515 * @vif: points to cfg80211 specific interface information.
516 * @ndev: associated network device.
517 * @stats: interface specific network statistics.
518 * @idx: interface index in device firmware.
519 * @bssidx: index of bss associated with this interface.
520 * @mac_addr: assigned mac address.
523 struct brcmf_pub
*drvr
;
524 struct brcmf_cfg80211_vif
*vif
;
525 struct net_device
*ndev
;
526 struct net_device_stats stats
;
527 struct work_struct setmacaddr_work
;
528 struct work_struct multicast_work
;
531 u8 mac_addr
[ETH_ALEN
];
535 extern int brcmf_netdev_wait_pend8021x(struct net_device
*ndev
);
537 /* Return pointer to interface name */
538 extern char *brcmf_ifname(struct brcmf_pub
*drvr
, int idx
);
541 extern int brcmf_proto_cdc_query_dcmd(struct brcmf_pub
*drvr
, int ifidx
,
542 uint cmd
, void *buf
, uint len
);
543 extern int brcmf_proto_cdc_set_dcmd(struct brcmf_pub
*drvr
, int ifidx
, uint cmd
,
544 void *buf
, uint len
);
546 /* Remove any protocol-specific data header. */
547 extern int brcmf_proto_hdrpull(struct brcmf_pub
*drvr
, u8
*ifidx
,
548 struct sk_buff
*rxp
);
550 extern int brcmf_net_attach(struct brcmf_if
*ifp
);
551 extern struct brcmf_if
*brcmf_add_if(struct brcmf_pub
*drvr
, int ifidx
,
552 s32 bssidx
, char *name
, u8
*mac_addr
);
553 extern void brcmf_del_if(struct brcmf_pub
*drvr
, int ifidx
);
555 #endif /* _BRCMF_H_ */