c35134904ad6c7629b6430adb3b77f0162e19faa
[pandora-kernel.git] / drivers / staging / 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 #define BRCMF_VERSION_STR               "4.218.248.5"
25
26 #define BRCMF_C_IOCTL_SMLEN     256     /* "small" ioctl buffer required */
27 #define BRCMF_C_IOCTL_MEDLEN    1536    /* "med" ioctl buffer required */
28 #define BRCMF_C_IOCTL_MAXLEN    8192
29
30 #define BRCMF_C_UP                              2
31 #define BRCMF_C_SET_PROMISC                     10
32 #define BRCMF_C_GET_RATE                        12
33 #define BRCMF_C_GET_INFRA                       19
34 #define BRCMF_C_SET_INFRA                       20
35 #define BRCMF_C_GET_AUTH                        21
36 #define BRCMF_C_SET_AUTH                        22
37 #define BRCMF_C_GET_BSSID                       23
38 #define BRCMF_C_GET_SSID                        25
39 #define BRCMF_C_SET_SSID                        26
40 #define BRCMF_C_GET_CHANNEL                     29
41 #define BRCMF_C_GET_SRL                         31
42 #define BRCMF_C_GET_LRL                         33
43 #define BRCMF_C_GET_RADIO                       37
44 #define BRCMF_C_SET_RADIO                       38
45 #define BRCMF_C_GET_PHYTYPE                     39
46 #define BRCMF_C_SET_KEY                         45
47 #define BRCMF_C_SET_PASSIVE_SCAN                49
48 #define BRCMF_C_SCAN                            50
49 #define BRCMF_C_SCAN_RESULTS                    51
50 #define BRCMF_C_DISASSOC                        52
51 #define BRCMF_C_REASSOC                         53
52 #define BRCMF_C_SET_ROAM_TRIGGER                55
53 #define BRCMF_C_SET_ROAM_DELTA                  57
54 #define BRCMF_C_GET_DTIMPRD                     77
55 #define BRCMF_C_SET_COUNTRY                     84
56 #define BRCMF_C_GET_PM                          85
57 #define BRCMF_C_SET_PM                          86
58 #define BRCMF_C_GET_AP                          117
59 #define BRCMF_C_SET_AP                          118
60 #define BRCMF_C_GET_RSSI                        127
61 #define BRCMF_C_GET_WSEC                        133
62 #define BRCMF_C_SET_WSEC                        134
63 #define BRCMF_C_GET_PHY_NOISE                   135
64 #define BRCMF_C_GET_BSS_INFO                    136
65 #define BRCMF_C_SET_SCAN_CHANNEL_TIME           185
66 #define BRCMF_C_SET_SCAN_UNASSOC_TIME           187
67 #define BRCMF_C_SCB_DEAUTHENTICATE_FOR_REASON   201
68 #define BRCMF_C_GET_VALID_CHANNELS              217
69 #define BRCMF_C_GET_KEY_PRIMARY                 235
70 #define BRCMF_C_SET_KEY_PRIMARY                 236
71 #define BRCMF_C_SET_SCAN_PASSIVE_TIME           258
72 #define BRCMF_C_GET_VAR                         262
73 #define BRCMF_C_SET_VAR                         263
74
75 /* phy types (returned by WLC_GET_PHYTPE) */
76 #define WLC_PHY_TYPE_A          0
77 #define WLC_PHY_TYPE_B          1
78 #define WLC_PHY_TYPE_G          2
79 #define WLC_PHY_TYPE_N          4
80 #define WLC_PHY_TYPE_LP         5
81 #define WLC_PHY_TYPE_SSN        6
82 #define WLC_PHY_TYPE_HT         7
83 #define WLC_PHY_TYPE_LCN        8
84 #define WLC_PHY_TYPE_NULL       0xf
85
86 #define BRCMF_EVENTING_MASK_LEN 16
87
88 #define TOE_TX_CSUM_OL          0x00000001
89 #define TOE_RX_CSUM_OL          0x00000002
90
91 #define BRCMF_BSS_INFO_VERSION  108 /* current ver of brcmf_bss_info struct */
92
93 /* size of brcmf_scan_params not including variable length array */
94 #define BRCMF_SCAN_PARAMS_FIXED_SIZE 64
95
96 /* masks for channel and ssid count */
97 #define BRCMF_SCAN_PARAMS_COUNT_MASK 0x0000ffff
98 #define BRCMF_SCAN_PARAMS_NSSID_SHIFT 16
99
100 #define BRCMF_SCAN_ACTION_START      1
101 #define BRCMF_SCAN_ACTION_CONTINUE   2
102 #define WL_SCAN_ACTION_ABORT      3
103
104 #define BRCMF_ISCAN_REQ_VERSION 1
105
106 /* brcmf_iscan_results status values */
107 #define BRCMF_SCAN_RESULTS_SUCCESS      0
108 #define BRCMF_SCAN_RESULTS_PARTIAL      1
109 #define BRCMF_SCAN_RESULTS_PENDING      2
110 #define BRCMF_SCAN_RESULTS_ABORTED      3
111 #define BRCMF_SCAN_RESULTS_NO_MEM       4
112
113 /* Indicates this key is using soft encrypt */
114 #define WL_SOFT_KEY     (1 << 0)
115 /* primary (ie tx) key */
116 #define BRCMF_PRIMARY_KEY       (1 << 1)
117 /* Reserved for backward compat */
118 #define WL_KF_RES_4     (1 << 4)
119 /* Reserved for backward compat */
120 #define WL_KF_RES_5     (1 << 5)
121 /* Indicates a group key for a IBSS PEER */
122 #define WL_IBSS_PEER_GROUP_KEY  (1 << 6)
123
124 /* For supporting multiple interfaces */
125 #define BRCMF_MAX_IFS   16
126 #define BRCMF_DEL_IF    -0xe
127 #define BRCMF_BAD_IF    -0xf
128
129 #define DOT11_BSSTYPE_ANY                       2
130 #define DOT11_MAX_DEFAULT_KEYS  4
131
132 #define BRCMF_EVENT_MSG_LINK            0x01
133 #define BRCMF_EVENT_MSG_FLUSHTXQ        0x02
134 #define BRCMF_EVENT_MSG_GROUP           0x04
135
136 struct brcmf_event_msg {
137         u16 version;
138         u16 flags;
139         u32 event_type;
140         u32 status;
141         u32 reason;
142         u32 auth_type;
143         u32 datalen;
144         u8 addr[ETH_ALEN];
145         char ifname[IFNAMSIZ];
146 } __packed;
147
148 struct brcm_ethhdr {
149         u16 subtype;
150         u16 length;
151         u8 version;
152         u8 oui[3];
153         u16 usr_subtype;
154 } __packed;
155
156 struct brcmf_event {
157         struct ethhdr eth;
158         struct brcm_ethhdr hdr;
159         struct brcmf_event_msg msg;
160 } __packed;
161
162 struct dngl_stats {
163         unsigned long rx_packets;       /* total packets received */
164         unsigned long tx_packets;       /* total packets transmitted */
165         unsigned long rx_bytes; /* total bytes received */
166         unsigned long tx_bytes; /* total bytes transmitted */
167         unsigned long rx_errors;        /* bad packets received */
168         unsigned long tx_errors;        /* packet transmit problems */
169         unsigned long rx_dropped;       /* packets dropped by dongle */
170         unsigned long tx_dropped;       /* packets dropped by dongle */
171         unsigned long multicast;        /* multicast packets received */
172 };
173
174 #define BRCMF_E_SET_SSID                        0
175 #define BRCMF_E_JOIN                            1
176 #define BRCMF_E_START                           2
177 #define BRCMF_E_AUTH                            3
178 #define BRCMF_E_AUTH_IND                        4
179 #define BRCMF_E_DEAUTH                          5
180 #define BRCMF_E_DEAUTH_IND                      6
181 #define BRCMF_E_ASSOC                           7
182 #define BRCMF_E_ASSOC_IND                       8
183 #define BRCMF_E_REASSOC                         9
184 #define BRCMF_E_REASSOC_IND                     10
185 #define BRCMF_E_DISASSOC                        11
186 #define BRCMF_E_DISASSOC_IND                    12
187 #define BRCMF_E_QUIET_START                     13
188 #define BRCMF_E_QUIET_END                       14
189 #define BRCMF_E_BEACON_RX                       15
190 #define BRCMF_E_LINK                            16
191 #define BRCMF_E_MIC_ERROR                       17
192 #define BRCMF_E_NDIS_LINK                       18
193 #define BRCMF_E_ROAM                            19
194 #define BRCMF_E_TXFAIL                          20
195 #define BRCMF_E_PMKID_CACHE                     21
196 #define BRCMF_E_RETROGRADE_TSF                  22
197 #define BRCMF_E_PRUNE                           23
198 #define BRCMF_E_AUTOAUTH                        24
199 #define BRCMF_E_EAPOL_MSG                       25
200 #define BRCMF_E_SCAN_COMPLETE                   26
201 #define BRCMF_E_ADDTS_IND                       27
202 #define BRCMF_E_DELTS_IND                       28
203 #define BRCMF_E_BCNSENT_IND                     29
204 #define BRCMF_E_BCNRX_MSG                       30
205 #define BRCMF_E_BCNLOST_MSG                     31
206 #define BRCMF_E_ROAM_PREP                       32
207 #define BRCMF_E_PFN_NET_FOUND                   33
208 #define BRCMF_E_PFN_NET_LOST                    34
209 #define BRCMF_E_RESET_COMPLETE                  35
210 #define BRCMF_E_JOIN_START                      36
211 #define BRCMF_E_ROAM_START                      37
212 #define BRCMF_E_ASSOC_START                     38
213 #define BRCMF_E_IBSS_ASSOC                      39
214 #define BRCMF_E_RADIO                           40
215 #define BRCMF_E_PSM_WATCHDOG                    41
216 #define BRCMF_E_PROBREQ_MSG                     44
217 #define BRCMF_E_SCAN_CONFIRM_IND                45
218 #define BRCMF_E_PSK_SUP                         46
219 #define BRCMF_E_COUNTRY_CODE_CHANGED            47
220 #define BRCMF_E_EXCEEDED_MEDIUM_TIME            48
221 #define BRCMF_E_ICV_ERROR                       49
222 #define BRCMF_E_UNICAST_DECODE_ERROR            50
223 #define BRCMF_E_MULTICAST_DECODE_ERROR          51
224 #define BRCMF_E_TRACE                           52
225 #define BRCMF_E_IF                              54
226 #define BRCMF_E_RSSI                            56
227 #define BRCMF_E_PFN_SCAN_COMPLETE               57
228 #define BRCMF_E_EXTLOG_MSG                      58
229 #define BRCMF_E_ACTION_FRAME                    59
230 #define BRCMF_E_ACTION_FRAME_COMPLETE           60
231 #define BRCMF_E_PRE_ASSOC_IND                   61
232 #define BRCMF_E_PRE_REASSOC_IND                 62
233 #define BRCMF_E_CHANNEL_ADOPTED                 63
234 #define BRCMF_E_AP_STARTED                      64
235 #define BRCMF_E_DFS_AP_STOP                     65
236 #define BRCMF_E_DFS_AP_RESUME                   66
237 #define BRCMF_E_RESERVED1                       67
238 #define BRCMF_E_RESERVED2                       68
239 #define BRCMF_E_ESCAN_RESULT                    69
240 #define BRCMF_E_ACTION_FRAME_OFF_CHAN_COMPLETE  70
241 #define BRCMF_E_DCS_REQUEST                     73
242
243 #define BRCMF_E_FIFO_CREDIT_MAP                 74
244
245 #define BRCMF_E_LAST                            75
246
247 #define BRCMF_E_STATUS_SUCCESS                  0
248 #define BRCMF_E_STATUS_FAIL                     1
249 #define BRCMF_E_STATUS_TIMEOUT                  2
250 #define BRCMF_E_STATUS_NO_NETWORKS              3
251 #define BRCMF_E_STATUS_ABORT                    4
252 #define BRCMF_E_STATUS_NO_ACK                   5
253 #define BRCMF_E_STATUS_UNSOLICITED              6
254 #define BRCMF_E_STATUS_ATTEMPT                  7
255 #define BRCMF_E_STATUS_PARTIAL                  8
256 #define BRCMF_E_STATUS_NEWSCAN                  9
257 #define BRCMF_E_STATUS_NEWASSOC                 10
258 #define BRCMF_E_STATUS_11HQUIET                 11
259 #define BRCMF_E_STATUS_SUPPRESS                 12
260 #define BRCMF_E_STATUS_NOCHANS                  13
261 #define BRCMF_E_STATUS_CS_ABORT                 15
262 #define BRCMF_E_STATUS_ERROR                    16
263
264 #define BRCMF_E_REASON_INITIAL_ASSOC            0
265 #define BRCMF_E_REASON_LOW_RSSI                 1
266 #define BRCMF_E_REASON_DEAUTH                   2
267 #define BRCMF_E_REASON_DISASSOC                 3
268 #define BRCMF_E_REASON_BCNS_LOST                4
269 #define BRCMF_E_REASON_MINTXRATE                9
270 #define BRCMF_E_REASON_TXFAIL                   10
271
272 #define BRCMF_E_REASON_FAST_ROAM_FAILED         5
273 #define BRCMF_E_REASON_DIRECTED_ROAM            6
274 #define BRCMF_E_REASON_TSPEC_REJECTED           7
275 #define BRCMF_E_REASON_BETTER_AP                8
276
277 #define BRCMF_E_PRUNE_ENCR_MISMATCH             1
278 #define BRCMF_E_PRUNE_BCAST_BSSID               2
279 #define BRCMF_E_PRUNE_MAC_DENY                  3
280 #define BRCMF_E_PRUNE_MAC_NA                    4
281 #define BRCMF_E_PRUNE_REG_PASSV                 5
282 #define BRCMF_E_PRUNE_SPCT_MGMT                 6
283 #define BRCMF_E_PRUNE_RADAR                     7
284 #define BRCMF_E_RSN_MISMATCH                    8
285 #define BRCMF_E_PRUNE_NO_COMMON_RATES           9
286 #define BRCMF_E_PRUNE_BASIC_RATES               10
287 #define BRCMF_E_PRUNE_CIPHER_NA                 12
288 #define BRCMF_E_PRUNE_KNOWN_STA                 13
289 #define BRCMF_E_PRUNE_WDS_PEER                  15
290 #define BRCMF_E_PRUNE_QBSS_LOAD                 16
291 #define BRCMF_E_PRUNE_HOME_AP                   17
292
293 #define BRCMF_E_SUP_OTHER                       0
294 #define BRCMF_E_SUP_DECRYPT_KEY_DATA            1
295 #define BRCMF_E_SUP_BAD_UCAST_WEP128            2
296 #define BRCMF_E_SUP_BAD_UCAST_WEP40             3
297 #define BRCMF_E_SUP_UNSUP_KEY_LEN               4
298 #define BRCMF_E_SUP_PW_KEY_CIPHER               5
299 #define BRCMF_E_SUP_MSG3_TOO_MANY_IE            6
300 #define BRCMF_E_SUP_MSG3_IE_MISMATCH            7
301 #define BRCMF_E_SUP_NO_INSTALL_FLAG             8
302 #define BRCMF_E_SUP_MSG3_NO_GTK                 9
303 #define BRCMF_E_SUP_GRP_KEY_CIPHER              10
304 #define BRCMF_E_SUP_GRP_MSG1_NO_GTK             11
305 #define BRCMF_E_SUP_GTK_DECRYPT_FAIL            12
306 #define BRCMF_E_SUP_SEND_FAIL                   13
307 #define BRCMF_E_SUP_DEAUTH                      14
308
309 #define BRCMF_E_IF_ADD                          1
310 #define BRCMF_E_IF_DEL                          2
311 #define BRCMF_E_IF_CHANGE                       3
312
313 #define BRCMF_E_IF_ROLE_STA                     0
314 #define BRCMF_E_IF_ROLE_AP                      1
315 #define BRCMF_E_IF_ROLE_WDS                     2
316
317 #define BRCMF_E_LINK_BCN_LOSS                   1
318 #define BRCMF_E_LINK_DISASSOC                   2
319 #define BRCMF_E_LINK_ASSOC_REC                  3
320 #define BRCMF_E_LINK_BSSCFG_DIS                 4
321
322 /* The level of bus communication with the dongle */
323 enum brcmf_bus_state {
324         BRCMF_BUS_DOWN,         /* Not ready for frame transfers */
325         BRCMF_BUS_LOAD,         /* Download access only (CPU reset) */
326         BRCMF_BUS_DATA          /* Ready for frame transfers */
327 };
328
329 /* Pattern matching filter. Specifies an offset within received packets to
330  * start matching, the pattern to match, the size of the pattern, and a bitmask
331  * that indicates which bits within the pattern should be matched.
332  */
333 struct brcmf_pkt_filter_pattern {
334         /*
335          * Offset within received packet to start pattern matching.
336          * Offset '0' is the first byte of the ethernet header.
337          */
338         u32 offset;
339         /* Size of the pattern.  Bitmask must be the same size.*/
340         u32 size_bytes;
341         /*
342          * Variable length mask and pattern data. mask starts at offset 0.
343          * Pattern immediately follows mask.
344          */
345         u8 mask_and_pattern[1];
346 };
347
348 /* IOVAR "pkt_filter_add" parameter. Used to install packet filters. */
349 struct brcmf_pkt_filter {
350         u32 id;         /* Unique filter id, specified by app. */
351         u32 type;               /* Filter type (WL_PKT_FILTER_TYPE_xxx). */
352         u32 negate_match;       /* Negate the result of filter matches */
353         union {                 /* Filter definitions */
354                 struct brcmf_pkt_filter_pattern pattern; /* Filter pattern */
355         } u;
356 };
357
358 /* IOVAR "pkt_filter_enable" parameter. */
359 struct brcmf_pkt_filter_enable {
360         u32 id;         /* Unique filter id */
361         u32 enable;             /* Enable/disable bool */
362 };
363
364 /* BSS info structure
365  * Applications MUST CHECK ie_offset field and length field to access IEs and
366  * next bss_info structure in a vector (in struct brcmf_scan_results)
367  */
368 struct brcmf_bss_info {
369         u32 version;            /* version field */
370         u32 length;             /* byte length of data in this record,
371                                  * starting at version and including IEs
372                                  */
373         u8 BSSID[ETH_ALEN];
374         u16 beacon_period;      /* units are Kusec */
375         u16 capability; /* Capability information */
376         u8 SSID_len;
377         u8 SSID[32];
378         struct {
379                 uint count;   /* # rates in this set */
380                 u8 rates[16]; /* rates in 500kbps units w/hi bit set if basic */
381         } rateset;              /* supported rates */
382         u16 chanspec;   /* chanspec for bss */
383         u16 atim_window;        /* units are Kusec */
384         u8 dtim_period; /* DTIM period */
385         s16 RSSI;               /* receive signal strength (in dBm) */
386         s8 phy_noise;           /* noise (in dBm) */
387
388         u8 n_cap;               /* BSS is 802.11N Capable */
389         u32 nbss_cap;   /* 802.11N BSS Capabilities (based on HT_CAP_*) */
390         u8 ctl_ch;              /* 802.11N BSS control channel number */
391         u32 reserved32[1];      /* Reserved for expansion of BSS properties */
392         u8 flags;               /* flags */
393         u8 reserved[3]; /* Reserved for expansion of BSS properties */
394         u8 basic_mcs[MCSSET_LEN];       /* 802.11N BSS required MCS set */
395
396         u16 ie_offset;  /* offset at which IEs start, from beginning */
397         u32 ie_length;  /* byte length of Information Elements */
398         s16 SNR;                /* average SNR of during frame reception */
399         /* Add new fields here */
400         /* variable length Information Elements */
401 };
402
403 struct brcmf_ssid {
404         u32 SSID_len;
405         unsigned char SSID[32];
406 };
407
408 struct brcmf_ssid_le {
409         __le32 SSID_len;
410         unsigned char SSID[32];
411 };
412
413 struct brcmf_scan_params {
414         struct brcmf_ssid ssid; /* default: {0, ""} */
415         u8 bssid[ETH_ALEN];     /* default: bcast */
416         s8 bss_type;            /* default: any,
417                                  * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
418                                  */
419         u8 scan_type;   /* flags, 0 use default */
420         s32 nprobes;      /* -1 use default, number of probes per channel */
421         s32 active_time;        /* -1 use default, dwell time per channel for
422                                  * active scanning
423                                  */
424         s32 passive_time;       /* -1 use default, dwell time per channel
425                                  * for passive scanning
426                                  */
427         s32 home_time;  /* -1 use default, dwell time for the home channel
428                                  * between channel scans
429                                  */
430         s32 channel_num;        /* count of channels and ssids that follow
431                                  *
432                                  * low half is count of channels in
433                                  * channel_list, 0 means default (use all
434                                  * available channels)
435                                  *
436                                  * high half is entries in struct brcmf_ssid
437                                  * array that follows channel_list, aligned for
438                                  * s32 (4 bytes) meaning an odd channel count
439                                  * implies a 2-byte pad between end of
440                                  * channel_list and first ssid
441                                  *
442                                  * if ssid count is zero, single ssid in the
443                                  * fixed parameter portion is assumed, otherwise
444                                  * ssid in the fixed portion is ignored
445                                  */
446         u16 channel_list[1];    /* list of chanspecs */
447 };
448
449 /* incremental scan struct */
450 struct brcmf_iscan_params {
451         u32 version;
452         u16 action;
453         u16 scan_duration;
454         struct brcmf_scan_params params;
455 };
456
457 /* 3 fields + size of brcmf_scan_params, not including variable length array */
458 #define BRCMF_ISCAN_PARAMS_FIXED_SIZE \
459         (offsetof(struct brcmf_iscan_params, params) + \
460          sizeof(struct brcmf_ssid))
461
462 struct brcmf_scan_results {
463         u32 buflen;
464         u32 version;
465         u32 count;
466         struct brcmf_bss_info bss_info[1];
467 };
468
469 /* used for association with a specific BSSID and chanspec list */
470 struct brcmf_assoc_params {
471         /* 00:00:00:00:00:00: broadcast scan */
472         u8 bssid[ETH_ALEN];
473         /* 0: all available channels, otherwise count of chanspecs in
474          * chanspec_list */
475         s32 chanspec_num;
476         /* list of chanspecs */
477         u16 chanspec_list[1];
478 };
479
480 /* used for join with or without a specific bssid and channel list */
481 struct brcmf_join_params {
482         struct brcmf_ssid ssid;
483         struct brcmf_assoc_params params;
484 };
485
486 /* size of brcmf_scan_results not including variable length array */
487 #define BRCMF_SCAN_RESULTS_FIXED_SIZE \
488         (sizeof(struct brcmf_scan_results) - sizeof(struct brcmf_bss_info))
489
490 /* incremental scan results struct */
491 struct brcmf_iscan_results {
492         u32 status;
493         struct brcmf_scan_results results;
494 };
495
496 /* size of brcmf_iscan_results not including variable length array */
497 #define BRCMF_ISCAN_RESULTS_FIXED_SIZE \
498         (BRCMF_SCAN_RESULTS_FIXED_SIZE + \
499          offsetof(struct brcmf_iscan_results, results))
500
501 struct brcmf_wsec_key {
502         u32 index;              /* key index */
503         u32 len;                /* key length */
504         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
505         u32 pad_1[18];
506         u32 algo;       /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
507         u32 flags;      /* misc flags */
508         u32 pad_2[3];
509         u32 iv_initialized;     /* has IV been initialized already? */
510         u32 pad_3;
511         /* Rx IV */
512         struct {
513                 u32 hi; /* upper 32 bits of IV */
514                 u16 lo; /* lower 16 bits of IV */
515         } rxiv;
516         u32 pad_4[2];
517         u8 ea[ETH_ALEN];        /* per station */
518 };
519
520 /*
521  * dongle requires same struct as above but with fields in little endian order
522  */
523 struct brcmf_wsec_key_le {
524         __le32 index;           /* key index */
525         __le32 len;             /* key length */
526         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
527         __le32 pad_1[18];
528         __le32 algo;    /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
529         __le32 flags;   /* misc flags */
530         __le32 pad_2[3];
531         __le32 iv_initialized;  /* has IV been initialized already? */
532         __le32 pad_3;
533         /* Rx IV */
534         struct {
535                 __le32 hi;      /* upper 32 bits of IV */
536                 __le16 lo;      /* lower 16 bits of IV */
537         } rxiv;
538         __le32 pad_4[2];
539         u8 ea[ETH_ALEN];        /* per station */
540 };
541
542 /* Used to get specific STA parameters */
543 struct brcmf_scb_val {
544         u32 val;
545         u8 ea[ETH_ALEN];
546 };
547
548 /* channel encoding */
549 struct brcmf_channel_info {
550         int hw_channel;
551         int target_channel;
552         int scan_channel;
553 };
554
555 /* Linux network driver ioctl encoding */
556 struct brcmf_ioctl {
557         uint cmd;               /* common ioctl definition */
558         void *buf;              /* pointer to user buffer */
559         uint len;               /* length of user buffer */
560         u8 set;         /* get or set request (optional) */
561         uint used;              /* bytes read or written (optional) */
562         uint needed;            /* bytes needed (optional) */
563 };
564
565 /* Forward decls for struct brcmf_pub (see below) */
566 struct brcmf_bus;               /* device bus info */
567 struct brcmf_proto;     /* device communication protocol info */
568 struct brcmf_info;      /* device driver info */
569 struct brcmf_cfg80211_dev; /* cfg80211 device info */
570
571 /* Common structure for module and instance linkage */
572 struct brcmf_pub {
573         /* Linkage ponters */
574         struct brcmf_bus *bus;
575         struct brcmf_proto *prot;
576         struct brcmf_info *info;
577         struct brcmf_cfg80211_dev *config;
578
579         /* Internal brcmf items */
580         bool up;                /* Driver up/down (to OS) */
581         bool txoff;             /* Transmit flow-controlled */
582         bool dongle_reset;      /* true = DEVRESET put dongle into reset */
583         enum brcmf_bus_state busstate;
584         uint hdrlen;            /* Total BRCMF header length (proto + bus) */
585         uint maxctl;            /* Max size rxctl request from proto to bus */
586         uint rxsz;              /* Rx buffer size bus module should use */
587         u8 wme_dp;              /* wme discard priority */
588
589         /* Dongle media info */
590         bool iswl;              /* Dongle-resident driver is wl */
591         unsigned long drv_version;      /* Version of dongle-resident driver */
592         u8 mac[ETH_ALEN];               /* MAC address obtained from dongle */
593         struct dngl_stats dstats;       /* Stats for dongle-based data */
594
595         /* Additional stats for the bus level */
596
597         /* Data packets sent to dongle */
598         unsigned long tx_packets;
599         /* Multicast data packets sent to dongle */
600         unsigned long tx_multicast;
601         /* Errors in sending data to dongle */
602         unsigned long tx_errors;
603         /* Control packets sent to dongle */
604         unsigned long tx_ctlpkts;
605         /* Errors sending control frames to dongle */
606         unsigned long tx_ctlerrs;
607         /* Packets sent up the network interface */
608         unsigned long rx_packets;
609         /* Multicast packets sent up the network interface */
610         unsigned long rx_multicast;
611         /* Errors processing rx data packets */
612         unsigned long rx_errors;
613         /* Control frames processed from dongle */
614         unsigned long rx_ctlpkts;
615
616         /* Errors in processing rx control frames */
617         unsigned long rx_ctlerrs;
618         /* Packets dropped locally (no memory) */
619         unsigned long rx_dropped;
620         /* Packets flushed due to unscheduled sendup thread */
621         unsigned long rx_flushed;
622         /* Number of times dpc scheduled by watchdog timer */
623         unsigned long wd_dpc_sched;
624
625         /* Number of packets where header read-ahead was used. */
626         unsigned long rx_readahead_cnt;
627         /* Number of tx packets we had to realloc for headroom */
628         unsigned long tx_realloc;
629         /* Number of flow control pkts recvd */
630         unsigned long fc_packets;
631
632         /* Last error return */
633         int bcmerror;
634         uint tickcnt;
635
636         /* Last error from dongle */
637         int dongle_error;
638
639         /* Suspend disable flag  flag */
640         int suspend_disable_flag;       /* "1" to disable all extra powersaving
641                                          during suspend */
642         int in_suspend;         /* flag set to 1 when early suspend called */
643         int dtim_skip;          /* dtim skip , default 0 means wake each dtim */
644
645         /* Pkt filter defination */
646         char *pktfilter[100];
647         int pktfilter_count;
648
649         u8 country_code[BRCM_CNTRY_BUF_SZ];
650         char eventmask[BRCMF_EVENTING_MASK_LEN];
651
652 };
653
654 struct brcmf_if_event {
655         u8 ifidx;
656         u8 action;
657         u8 flags;
658         u8 bssidx;
659 };
660
661 struct bcmevent_name {
662         uint event;
663         const char *name;
664 };
665
666 /*
667  * Insmod parameters for debug/test
668  */
669
670 /* ARP offload agent mode */
671 extern uint brcmf_arp_mode;
672
673 /* ARP offload enable */
674 extern uint brcmf_arp_enable;
675
676 /* Pkt filte enable control */
677 extern uint brcmf_pkt_filter_enable;
678
679 /*  Pkt filter init setup */
680 extern uint brcmf_pkt_filter_init;
681
682 /* Pkt filter mode control */
683 extern uint brcmf_master_mode;
684
685 /* Roaming mode control */
686 extern uint brcmf_roam;
687
688 /* Roaming mode control */
689 extern uint brcmf_radio_up;
690
691 /* Override to force tx queueing all the time */
692 extern uint brcmf_force_tx_queueing;
693
694 extern const struct bcmevent_name bcmevent_names[];
695 extern const int bcmevent_names_size;
696
697
698 static inline void MUTEX_LOCK_INIT(struct brcmf_pub *drvr)
699 {
700 }
701
702 static inline void MUTEX_LOCK(struct brcmf_pub *drvr)
703 {
704 }
705
706 static inline void MUTEX_UNLOCK(struct brcmf_pub *drvr)
707 {
708 }
709
710 static inline void MUTEX_LOCK_WL_SCAN_SET_INIT(void)
711 {
712 }
713
714 static inline void MUTEX_LOCK_WL_SCAN_SET(void)
715 {
716 }
717
718 static inline void MUTEX_UNLOCK_WL_SCAN_SET(void)
719 {
720 }
721
722 /* Indication from bus module regarding presence/insertion of dongle.
723  * Return struct brcmf_pub pointer, used as handle to OS module in later calls.
724  * Returned structure should have bus and prot pointers filled in.
725  * bus_hdrlen specifies required headroom for bus module header.
726  */
727 extern struct brcmf_pub *brcmf_attach(struct brcmf_bus *bus,
728                                       uint bus_hdrlen);
729 extern int brcmf_net_attach(struct brcmf_pub *drvr, int idx);
730 extern int brcmf_netdev_wait_pend8021x(struct net_device *dev);
731
732 extern int brcmf_netdev_ioctl_priv(struct net_device *net,
733                                    struct brcmf_ioctl *ioc);
734
735 /* Indication from bus module regarding removal/absence of dongle */
736 extern void brcmf_detach(struct brcmf_pub *drvr);
737
738 /* Indication from bus module to change flow-control state */
739 extern void brcmf_txflowcontrol(struct brcmf_pub *drvr, int ifidx, bool on);
740
741 extern bool brcmf_c_prec_enq(struct brcmf_pub *drvr, struct pktq *q,
742                          struct sk_buff *pkt, int prec);
743
744 /* Receive frame for delivery to OS.  Callee disposes of rxp. */
745 extern void brcmf_rx_frame(struct brcmf_pub *drvr, int ifidx,
746                          struct sk_buff *rxp, int numpkt);
747
748 /* Return pointer to interface name */
749 extern char *brcmf_ifname(struct brcmf_pub *drvr, int idx);
750
751 /* Notify tx completion */
752 extern void brcmf_txcomplete(struct brcmf_pub *drvr, struct sk_buff *txp,
753                              bool success);
754
755 /* Query ioctl */
756 extern int brcmf_proto_cdc_query_ioctl(struct brcmf_pub *drvr, int ifidx,
757                                        uint cmd, void *buf, uint len);
758
759 /* OS independent layer functions */
760 extern int brcmf_os_proto_block(struct brcmf_pub *drvr);
761 extern int brcmf_os_proto_unblock(struct brcmf_pub *drvr);
762 #ifdef BCMDBG
763 extern int brcmf_write_to_file(struct brcmf_pub *drvr, u8 *buf, int size);
764 #endif                          /* BCMDBG */
765
766 extern int brcmf_ifname2idx(struct brcmf_info *drvr_priv, char *name);
767 extern int brcmf_c_host_event(struct brcmf_info *drvr_priv, int *idx,
768                               void *pktdata, struct brcmf_event_msg *,
769                               void **data_ptr);
770
771 extern void brcmf_c_init(void);
772
773 extern int brcmf_add_if(struct brcmf_info *drvr_priv, int ifidx,
774                         struct net_device *net, char *name, u8 *mac_addr,
775                         u32 flags, u8 bssidx);
776 extern void brcmf_del_if(struct brcmf_info *drvr_priv, int ifidx);
777
778 /* Send packet to dongle via data channel */
779 extern int brcmf_sendpkt(struct brcmf_pub *drvr, int ifidx,\
780                          struct sk_buff *pkt);
781
782 extern int brcmf_bus_devreset(struct brcmf_pub *drvr, u8 flag);
783 extern int brcmf_bus_start(struct brcmf_pub *drvr);
784
785 extern void brcmf_c_pktfilter_offload_set(struct brcmf_pub *drvr, char *arg);
786 extern void brcmf_c_pktfilter_offload_enable(struct brcmf_pub *drvr, char *arg,
787                                              int enable, int master_mode);
788
789 /* per-driver magic numbers */
790 #define BRCMF_IOCTL_MAGIC               0x00444944
791
792 /* bump this number if you change the ioctl interface */
793 #define BRCMF_IOCTL_VERSION     1
794 #define BRCMF_IOCTL_MAXLEN      8192    /* max length ioctl buffer required */
795
796 /* common ioctl definitions */
797 #define BRCMF_GET_VERSION                               1
798 #define BRCMF_GET_VAR                           2
799 #define BRCMF_SET_VAR                           3
800
801 /* message levels */
802 #define BRCMF_ERROR_VAL 0x0001
803 #define BRCMF_TRACE_VAL 0x0002
804 #define BRCMF_INFO_VAL  0x0004
805 #define BRCMF_DATA_VAL  0x0008
806 #define BRCMF_CTL_VAL   0x0010
807 #define BRCMF_TIMER_VAL 0x0020
808 #define BRCMF_HDRS_VAL  0x0040
809 #define BRCMF_BYTES_VAL 0x0080
810 #define BRCMF_INTR_VAL  0x0100
811 #define BRCMF_GLOM_VAL  0x0400
812 #define BRCMF_EVENT_VAL 0x0800
813 #define BRCMF_BTA_VAL   0x1000
814 #define BRCMF_ISCAN_VAL 0x2000
815
816 /* Enter idle immediately (no timeout) */
817 #define BRCMF_IDLE_IMMEDIATE    (-1)
818 #define BRCMF_IDLE_ACTIVE       0       /* Do not request any SD clock change
819                                  when idle */
820
821 #endif                          /* _BRCMF_H_ */