]> git.karo-electronics.de Git - mv-sheeva.git/blob - drivers/staging/brcm80211/brcmfmac/dhd.h
b2db6b91061868c1b76211e52a525672d97dde2b
[mv-sheeva.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 _dhd_h_
22 #define _dhd_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 WL_PKT_FILTER_FIXED_LEN           offsetof(wl_pkt_filter_t, u)
87 #define WL_PKT_FILTER_PATTERN_FIXED_LEN   offsetof(wl_pkt_filter_pattern_t, mask_and_pattern)
88
89 #define WL_EVENTING_MASK_LEN    16
90
91 #define TOE_TX_CSUM_OL          0x00000001
92 #define TOE_RX_CSUM_OL          0x00000002
93
94 /* maximum channels returned by the get valid channels iovar */
95 #define WL_NUMCHANNELS          64
96
97 #define WL_BSS_INFO_VERSION     108     /* current ver of wl_bss_info struct */
98
99 /* size of wl_scan_params not including variable length array */
100 #define WL_SCAN_PARAMS_FIXED_SIZE 64
101
102 /* masks for channel and ssid count */
103 #define WL_SCAN_PARAMS_COUNT_MASK 0x0000ffff
104 #define WL_SCAN_PARAMS_NSSID_SHIFT 16
105
106 #define WL_SCAN_ACTION_START      1
107 #define WL_SCAN_ACTION_CONTINUE   2
108 #define WL_SCAN_ACTION_ABORT      3
109
110 #define ISCAN_REQ_VERSION 1
111
112 /* wl_iscan_results status values */
113 #define WL_SCAN_RESULTS_SUCCESS 0
114 #define WL_SCAN_RESULTS_PARTIAL 1
115 #define WL_SCAN_RESULTS_PENDING 2
116 #define WL_SCAN_RESULTS_ABORTED 3
117 #define WL_SCAN_RESULTS_NO_MEM  4
118
119 #define WL_SOFT_KEY     (1 << 0)        /* Indicates this key is using soft encrypt */
120 #define WL_PRIMARY_KEY  (1 << 1)        /* Indicates this key is the primary (ie tx) key */
121 #define WL_KF_RES_4     (1 << 4)        /* Reserved for backward compat */
122 #define WL_KF_RES_5     (1 << 5)        /* Reserved for backward compat */
123 #define WL_IBSS_PEER_GROUP_KEY  (1 << 6)        /* Indicates a group key for a IBSS PEER */
124
125 /* For supporting multiple interfaces */
126 #define DHD_MAX_IFS     16
127 #define DHD_DEL_IF      -0xe
128 #define DHD_BAD_IF      -0xf
129
130 #define DOT11_BSSTYPE_ANY                       2
131 #define DOT11_MAX_DEFAULT_KEYS  4
132
133 #define BRCMF_EVENT_MSG_LINK            0x01
134 #define BRCMF_EVENT_MSG_FLUSHTXQ        0x02
135 #define BRCMF_EVENT_MSG_GROUP           0x04
136
137 typedef struct brcmf_event_msg {
138         u16 version;
139         u16 flags;
140         u32 event_type;
141         u32 status;
142         u32 reason;
143         u32 auth_type;
144         u32 datalen;
145         u8 addr[ETH_ALEN];
146         char ifname[IFNAMSIZ];
147 } __packed brcmf_event_msg_t;
148
149 struct brcm_ethhdr {
150         u16 subtype;
151         u16 length;
152         u8 version;
153         u8 oui[3];
154         u16 usr_subtype;
155 } __packed;
156
157 typedef struct brcmf_event {
158         struct ethhdr eth;
159         struct brcm_ethhdr hdr;
160         struct brcmf_event_msg msg;
161 } __packed brcmf_event_t;
162
163 #define BRCMF_E_SET_SSID                        0
164 #define BRCMF_E_JOIN                            1
165 #define BRCMF_E_START                           2
166 #define BRCMF_E_AUTH                            3
167 #define BRCMF_E_AUTH_IND                        4
168 #define BRCMF_E_DEAUTH                          5
169 #define BRCMF_E_DEAUTH_IND                      6
170 #define BRCMF_E_ASSOC                           7
171 #define BRCMF_E_ASSOC_IND                       8
172 #define BRCMF_E_REASSOC                         9
173 #define BRCMF_E_REASSOC_IND                     10
174 #define BRCMF_E_DISASSOC                        11
175 #define BRCMF_E_DISASSOC_IND                    12
176 #define BRCMF_E_QUIET_START                     13
177 #define BRCMF_E_QUIET_END                       14
178 #define BRCMF_E_BEACON_RX                       15
179 #define BRCMF_E_LINK                            16
180 #define BRCMF_E_MIC_ERROR                       17
181 #define BRCMF_E_NDIS_LINK                       18
182 #define BRCMF_E_ROAM                            19
183 #define BRCMF_E_TXFAIL                          20
184 #define BRCMF_E_PMKID_CACHE                     21
185 #define BRCMF_E_RETROGRADE_TSF                  22
186 #define BRCMF_E_PRUNE                           23
187 #define BRCMF_E_AUTOAUTH                        24
188 #define BRCMF_E_EAPOL_MSG                       25
189 #define BRCMF_E_SCAN_COMPLETE                   26
190 #define BRCMF_E_ADDTS_IND                       27
191 #define BRCMF_E_DELTS_IND                       28
192 #define BRCMF_E_BCNSENT_IND                     29
193 #define BRCMF_E_BCNRX_MSG                       30
194 #define BRCMF_E_BCNLOST_MSG                     31
195 #define BRCMF_E_ROAM_PREP                       32
196 #define BRCMF_E_PFN_NET_FOUND                   33
197 #define BRCMF_E_PFN_NET_LOST                    34
198 #define BRCMF_E_RESET_COMPLETE                  35
199 #define BRCMF_E_JOIN_START                      36
200 #define BRCMF_E_ROAM_START                      37
201 #define BRCMF_E_ASSOC_START                     38
202 #define BRCMF_E_IBSS_ASSOC                      39
203 #define BRCMF_E_RADIO                           40
204 #define BRCMF_E_PSM_WATCHDOG                    41
205 #define BRCMF_E_PROBREQ_MSG                     44
206 #define BRCMF_E_SCAN_CONFIRM_IND                45
207 #define BRCMF_E_PSK_SUP                         46
208 #define BRCMF_E_COUNTRY_CODE_CHANGED            47
209 #define BRCMF_E_EXCEEDED_MEDIUM_TIME            48
210 #define BRCMF_E_ICV_ERROR                       49
211 #define BRCMF_E_UNICAST_DECODE_ERROR            50
212 #define BRCMF_E_MULTICAST_DECODE_ERROR          51
213 #define BRCMF_E_TRACE                           52
214 #define BRCMF_E_IF                              54
215 #define BRCMF_E_RSSI                            56
216 #define BRCMF_E_PFN_SCAN_COMPLETE               57
217 #define BRCMF_E_EXTLOG_MSG                      58
218 #define BRCMF_E_ACTION_FRAME                    59
219 #define BRCMF_E_ACTION_FRAME_COMPLETE           60
220 #define BRCMF_E_PRE_ASSOC_IND                   61
221 #define BRCMF_E_PRE_REASSOC_IND                 62
222 #define BRCMF_E_CHANNEL_ADOPTED                 63
223 #define BRCMF_E_AP_STARTED                      64
224 #define BRCMF_E_DFS_AP_STOP                     65
225 #define BRCMF_E_DFS_AP_RESUME                   66
226 #define BRCMF_E_RESERVED1                       67
227 #define BRCMF_E_RESERVED2                       68
228 #define BRCMF_E_ESCAN_RESULT                    69
229 #define BRCMF_E_ACTION_FRAME_OFF_CHAN_COMPLETE  70
230 #define BRCMF_E_DCS_REQUEST                     73
231
232 #define BRCMF_E_FIFO_CREDIT_MAP                 74
233
234 #define BRCMF_E_LAST                            75
235
236 #define BRCMF_E_STATUS_SUCCESS                  0
237 #define BRCMF_E_STATUS_FAIL                     1
238 #define BRCMF_E_STATUS_TIMEOUT                  2
239 #define BRCMF_E_STATUS_NO_NETWORKS              3
240 #define BRCMF_E_STATUS_ABORT                    4
241 #define BRCMF_E_STATUS_NO_ACK                   5
242 #define BRCMF_E_STATUS_UNSOLICITED              6
243 #define BRCMF_E_STATUS_ATTEMPT                  7
244 #define BRCMF_E_STATUS_PARTIAL                  8
245 #define BRCMF_E_STATUS_NEWSCAN                  9
246 #define BRCMF_E_STATUS_NEWASSOC                 10
247 #define BRCMF_E_STATUS_11HQUIET                 11
248 #define BRCMF_E_STATUS_SUPPRESS                 12
249 #define BRCMF_E_STATUS_NOCHANS                  13
250 #define BRCMF_E_STATUS_CS_ABORT                 15
251 #define BRCMF_E_STATUS_ERROR                    16
252
253 #define BRCMF_E_REASON_INITIAL_ASSOC            0
254 #define BRCMF_E_REASON_LOW_RSSI                 1
255 #define BRCMF_E_REASON_DEAUTH                   2
256 #define BRCMF_E_REASON_DISASSOC                 3
257 #define BRCMF_E_REASON_BCNS_LOST                4
258 #define BRCMF_E_REASON_MINTXRATE                9
259 #define BRCMF_E_REASON_TXFAIL                   10
260
261 #define BRCMF_E_REASON_FAST_ROAM_FAILED         5
262 #define BRCMF_E_REASON_DIRECTED_ROAM            6
263 #define BRCMF_E_REASON_TSPEC_REJECTED           7
264 #define BRCMF_E_REASON_BETTER_AP                8
265
266 #define BRCMF_E_PRUNE_ENCR_MISMATCH             1
267 #define BRCMF_E_PRUNE_BCAST_BSSID               2
268 #define BRCMF_E_PRUNE_MAC_DENY                  3
269 #define BRCMF_E_PRUNE_MAC_NA                    4
270 #define BRCMF_E_PRUNE_REG_PASSV                 5
271 #define BRCMF_E_PRUNE_SPCT_MGMT                 6
272 #define BRCMF_E_PRUNE_RADAR                     7
273 #define BRCMF_E_RSN_MISMATCH                    8
274 #define BRCMF_E_PRUNE_NO_COMMON_RATES           9
275 #define BRCMF_E_PRUNE_BASIC_RATES               10
276 #define BRCMF_E_PRUNE_CIPHER_NA                 12
277 #define BRCMF_E_PRUNE_KNOWN_STA                 13
278 #define BRCMF_E_PRUNE_WDS_PEER                  15
279 #define BRCMF_E_PRUNE_QBSS_LOAD                 16
280 #define BRCMF_E_PRUNE_HOME_AP                   17
281
282 #define BRCMF_E_SUP_OTHER                       0
283 #define BRCMF_E_SUP_DECRYPT_KEY_DATA            1
284 #define BRCMF_E_SUP_BAD_UCAST_WEP128            2
285 #define BRCMF_E_SUP_BAD_UCAST_WEP40             3
286 #define BRCMF_E_SUP_UNSUP_KEY_LEN               4
287 #define BRCMF_E_SUP_PW_KEY_CIPHER               5
288 #define BRCMF_E_SUP_MSG3_TOO_MANY_IE            6
289 #define BRCMF_E_SUP_MSG3_IE_MISMATCH            7
290 #define BRCMF_E_SUP_NO_INSTALL_FLAG             8
291 #define BRCMF_E_SUP_MSG3_NO_GTK                 9
292 #define BRCMF_E_SUP_GRP_KEY_CIPHER              10
293 #define BRCMF_E_SUP_GRP_MSG1_NO_GTK             11
294 #define BRCMF_E_SUP_GTK_DECRYPT_FAIL            12
295 #define BRCMF_E_SUP_SEND_FAIL                   13
296 #define BRCMF_E_SUP_DEAUTH                      14
297
298 #define BRCMF_E_IF_ADD                          1
299 #define BRCMF_E_IF_DEL                          2
300 #define BRCMF_E_IF_CHANGE                       3
301
302 #define BRCMF_E_IF_ROLE_STA                     0
303 #define BRCMF_E_IF_ROLE_AP                      1
304 #define BRCMF_E_IF_ROLE_WDS                     2
305
306 #define BRCMF_E_LINK_BCN_LOSS                   1
307 #define BRCMF_E_LINK_DISASSOC                   2
308 #define BRCMF_E_LINK_ASSOC_REC                  3
309 #define BRCMF_E_LINK_BSSCFG_DIS                 4
310
311 enum cust_gpio_modes {
312         WLAN_RESET_ON,
313         WLAN_RESET_OFF,
314         WLAN_POWER_ON,
315         WLAN_POWER_OFF
316 };
317
318 /* The level of bus communication with the dongle */
319 enum dhd_bus_state {
320         DHD_BUS_DOWN,           /* Not ready for frame transfers */
321         DHD_BUS_LOAD,           /* Download access only (CPU reset) */
322         DHD_BUS_DATA            /* Ready for frame transfers */
323 };
324
325 /* Pattern matching filter. Specifies an offset within received packets to
326  * start matching, the pattern to match, the size of the pattern, and a bitmask
327  * that indicates which bits within the pattern should be matched.
328  */
329 typedef struct wl_pkt_filter_pattern {
330         u32 offset;             /* Offset within received packet to start pattern matching.
331                                  * Offset '0' is the first byte of the ethernet header.
332                                  */
333         u32 size_bytes; /* Size of the pattern.  Bitmask must be the same size. */
334         u8 mask_and_pattern[1]; /* Variable length mask and pattern data.  mask starts
335                                          * at offset 0.  Pattern immediately follows mask.
336                                          */
337 } wl_pkt_filter_pattern_t;
338
339 /* IOVAR "pkt_filter_add" parameter. Used to install packet filters. */
340 typedef struct wl_pkt_filter {
341         u32 id;         /* Unique filter id, specified by app. */
342         u32 type;               /* Filter type (WL_PKT_FILTER_TYPE_xxx). */
343         u32 negate_match;       /* Negate the result of filter matches */
344         union {                 /* Filter definitions */
345                 wl_pkt_filter_pattern_t pattern;        /* Pattern matching filter */
346         } u;
347 } wl_pkt_filter_t;
348
349 /* IOVAR "pkt_filter_enable" parameter. */
350 typedef struct wl_pkt_filter_enable {
351         u32 id;         /* Unique filter id */
352         u32 enable;             /* Enable/disable bool */
353 } wl_pkt_filter_enable_t;
354
355 /* BSS info structure
356  * Applications MUST CHECK ie_offset field and length field to access IEs and
357  * next bss_info structure in a vector (in wl_scan_results_t)
358  */
359 typedef struct wl_bss_info {
360         u32 version;            /* version field */
361         u32 length;             /* byte length of data in this record,
362                                  * starting at version and including IEs
363                                  */
364         u8 BSSID[ETH_ALEN];
365         u16 beacon_period;      /* units are Kusec */
366         u16 capability; /* Capability information */
367         u8 SSID_len;
368         u8 SSID[32];
369         struct {
370                 uint count;     /* # rates in this set */
371                 u8 rates[16];   /* rates in 500kbps units w/hi bit set if basic */
372         } rateset;              /* supported rates */
373         chanspec_t chanspec;    /* chanspec for bss */
374         u16 atim_window;        /* units are Kusec */
375         u8 dtim_period; /* DTIM period */
376         s16 RSSI;               /* receive signal strength (in dBm) */
377         s8 phy_noise;           /* noise (in dBm) */
378
379         u8 n_cap;               /* BSS is 802.11N Capable */
380         u32 nbss_cap;   /* 802.11N BSS Capabilities (based on HT_CAP_*) */
381         u8 ctl_ch;              /* 802.11N BSS control channel number */
382         u32 reserved32[1];      /* Reserved for expansion of BSS properties */
383         u8 flags;               /* flags */
384         u8 reserved[3]; /* Reserved for expansion of BSS properties */
385         u8 basic_mcs[MCSSET_LEN];       /* 802.11N BSS required MCS set */
386
387         u16 ie_offset;  /* offset at which IEs start, from beginning */
388         u32 ie_length;  /* byte length of Information Elements */
389         s16 SNR;                /* average SNR of during frame reception */
390         /* Add new fields here */
391         /* variable length Information Elements */
392 } wl_bss_info_t;
393
394 typedef struct wlc_ssid {
395         u32 SSID_len;
396         unsigned char SSID[32];
397 } wlc_ssid_t;
398
399 typedef struct wl_scan_params {
400         wlc_ssid_t ssid;        /* default: {0, ""} */
401         u8 bssid[ETH_ALEN];     /* default: bcast */
402         s8 bss_type;            /* default: any,
403                                  * DOT11_BSSTYPE_ANY/INFRASTRUCTURE/INDEPENDENT
404                                  */
405         u8 scan_type;   /* flags, 0 use default */
406         s32 nprobes;            /* -1 use default, number of probes per channel */
407         s32 active_time;        /* -1 use default, dwell time per channel for
408                                  * active scanning
409                                  */
410         s32 passive_time;       /* -1 use default, dwell time per channel
411                                  * for passive scanning
412                                  */
413         s32 home_time;  /* -1 use default, dwell time for the home channel
414                                  * between channel scans
415                                  */
416         s32 channel_num;        /* count of channels and ssids that follow
417                                  *
418                                  * low half is count of channels in channel_list, 0
419                                  * means default (use all available channels)
420                                  *
421                                  * high half is entries in wlc_ssid_t array that
422                                  * follows channel_list, aligned for s32 (4 bytes)
423                                  * meaning an odd channel count implies a 2-byte pad
424                                  * between end of channel_list and first ssid
425                                  *
426                                  * if ssid count is zero, single ssid in the fixed
427                                  * parameter portion is assumed, otherwise ssid in
428                                  * the fixed portion is ignored
429                                  */
430         u16 channel_list[1];    /* list of chanspecs */
431 } wl_scan_params_t;
432
433 /* incremental scan struct */
434 typedef struct wl_iscan_params {
435         u32 version;
436         u16 action;
437         u16 scan_duration;
438         wl_scan_params_t params;
439 } wl_iscan_params_t;
440
441 /* 3 fields + size of wl_scan_params, not including variable length array */
442 #define WL_ISCAN_PARAMS_FIXED_SIZE (offsetof(wl_iscan_params_t, params) + sizeof(wlc_ssid_t))
443
444 typedef struct wl_scan_results {
445         u32 buflen;
446         u32 version;
447         u32 count;
448         wl_bss_info_t bss_info[1];
449 } wl_scan_results_t;
450
451 typedef struct wl_rateset_args {
452         u32 count;              /* # rates in this set */
453         u8 rates[WL_NUMRATES];  /* rates in 500kbps units w/hi bit set if basic */
454         u8 mcs[MCSSET_LEN];     /* supported mcs index bit map */
455 } wl_rateset_args_t;
456
457 /* u32 list */
458 typedef struct wl_u32_list {
459         /* in - # of elements, out - # of entries */
460         u32 count;
461         /* variable length u32 list */
462         u32 element[1];
463 } wl_u32_list_t;
464
465 /* used for association with a specific BSSID and chanspec list */
466 typedef struct wl_assoc_params {
467         u8 bssid[ETH_ALEN];     /* 00:00:00:00:00:00: broadcast scan */
468         s32 chanspec_num;       /* 0: all available channels,
469                                  * otherwise count of chanspecs in chanspec_list
470                                  */
471         chanspec_t chanspec_list[1];    /* list of chanspecs */
472 } wl_assoc_params_t;
473 #define WL_ASSOC_PARAMS_FIXED_SIZE      (sizeof(wl_assoc_params_t) - sizeof(chanspec_t))
474
475 /* used for reassociation/roam to a specific BSSID and channel */
476 typedef wl_assoc_params_t wl_reassoc_params_t;
477
478 /* used for join with or without a specific bssid and channel list */
479 typedef struct wl_join_params {
480         wlc_ssid_t ssid;
481         wl_assoc_params_t params;       /* optional field, but it must include the fixed portion
482                                          * of the wl_assoc_params_t struct when it does present.
483                                          */
484 } wl_join_params_t;
485
486 /* size of wl_scan_results not including variable length array */
487 #define WL_SCAN_RESULTS_FIXED_SIZE (sizeof(wl_scan_results_t) - sizeof(wl_bss_info_t))
488
489 /* incremental scan results struct */
490 typedef struct wl_iscan_results {
491         u32 status;
492         wl_scan_results_t results;
493 } wl_iscan_results_t;
494
495 /* size of wl_iscan_results not including variable length array */
496 #define WL_ISCAN_RESULTS_FIXED_SIZE \
497         (WL_SCAN_RESULTS_FIXED_SIZE + offsetof(wl_iscan_results_t, results))
498
499 typedef struct {
500         u32 duration;   /* millisecs spent sampling this channel */
501         u32 congest_ibss;       /* millisecs in our bss (presumably this traffic will */
502         /*  move if cur bss moves channels) */
503         u32 congest_obss;       /* traffic not in our bss */
504         u32 interference;       /* millisecs detecting a non 802.11 interferer. */
505         u32 timestamp;  /* second timestamp */
506 } cca_congest_t;
507
508 typedef struct {
509         chanspec_t chanspec;    /* Which channel? */
510         u8 num_secs;            /* How many secs worth of data */
511         cca_congest_t secs[1];  /* Data */
512 } cca_congest_channel_req_t;
513
514 typedef struct wl_country {
515         char country_abbrev[WLC_CNTRY_BUF_SZ];  /* nul-terminated country code used in
516                                                  * the Country IE
517                                                  */
518         s32 rev;                /* revision specifier for ccode
519                                  * on set, -1 indicates unspecified.
520                                  * on get, rev >= 0
521                                  */
522         char ccode[WLC_CNTRY_BUF_SZ];   /* nul-terminated built-in country code.
523                                          * variable length, but fixed size in
524                                          * struct allows simple allocation for
525                                          * expected country strings <= 3 chars.
526                                          */
527 } wl_country_t;
528
529 typedef struct wl_channels_in_country {
530         u32 buflen;
531         u32 band;
532         char country_abbrev[WLC_CNTRY_BUF_SZ];
533         u32 count;
534         u32 channel[1];
535 } wl_channels_in_country_t;
536
537 typedef struct wl_country_list {
538         u32 buflen;
539         u32 band_set;
540         u32 band;
541         u32 count;
542         char country_abbrev[1];
543 } wl_country_list_t;
544
545 typedef struct wl_rm_req_elt {
546         s8 type;
547         s8 flags;
548         chanspec_t chanspec;
549         u32 token;              /* token for this measurement */
550         u32 tsf_h;              /* TSF high 32-bits of Measurement start time */
551         u32 tsf_l;              /* TSF low 32-bits */
552         u32 dur;                /* TUs */
553 } wl_rm_req_elt_t;
554
555 typedef struct wl_rm_req {
556         u32 token;              /* overall measurement set token */
557         u32 count;              /* number of measurement requests */
558         void *cb;               /* completion callback function: may be NULL */
559         void *cb_arg;           /* arg to completion callback function */
560         wl_rm_req_elt_t req[1]; /* variable length block of requests */
561 } wl_rm_req_t;
562
563 typedef struct wl_rm_rep_elt {
564         s8 type;
565         s8 flags;
566         chanspec_t chanspec;
567         u32 token;              /* token for this measurement */
568         u32 tsf_h;              /* TSF high 32-bits of Measurement start time */
569         u32 tsf_l;              /* TSF low 32-bits */
570         u32 dur;                /* TUs */
571         u32 len;                /* byte length of data block */
572         u8 data[1];             /* variable length data block */
573 } wl_rm_rep_elt_t;
574
575 #define WL_RPI_REP_BIN_NUM 8
576 typedef struct wl_rm_rpi_rep {
577         u8 rpi[WL_RPI_REP_BIN_NUM];
578         s8 rpi_max[WL_RPI_REP_BIN_NUM];
579 } wl_rm_rpi_rep_t;
580
581 typedef struct wl_rm_rep {
582         u32 token;              /* overall measurement set token */
583         u32 len;                /* length of measurement report block */
584         wl_rm_rep_elt_t rep[1]; /* variable length block of reports */
585 } wl_rm_rep_t;
586
587 typedef struct wl_wsec_key {
588         u32 index;              /* key index */
589         u32 len;                /* key length */
590         u8 data[WLAN_MAX_KEY_LEN];      /* key data */
591         u32 pad_1[18];
592         u32 algo;               /* CRYPTO_ALGO_AES_CCM, CRYPTO_ALGO_WEP128, etc */
593         u32 flags;              /* misc flags */
594         u32 pad_2[2];
595         int pad_3;
596         int iv_initialized;     /* has IV been initialized already? */
597         int pad_4;
598         /* Rx IV */
599         struct {
600                 u32 hi; /* upper 32 bits of IV */
601                 u16 lo; /* lower 16 bits of IV */
602         } rxiv;
603         u32 pad_5[2];
604         u8 ea[ETH_ALEN];        /* per station */
605 } wl_wsec_key_t;
606
607 /* Used to get specific STA parameters */
608 typedef struct {
609         u32 val;
610         u8 ea[ETH_ALEN];
611 } scb_val_t;
612
613 /* channel encoding */
614 typedef struct channel_info {
615         int hw_channel;
616         int target_channel;
617         int scan_channel;
618 } channel_info_t;
619
620 /* Linux network driver ioctl encoding */
621 typedef struct wl_ioctl {
622         uint cmd;               /* common ioctl definition */
623         void *buf;              /* pointer to user buffer */
624         uint len;               /* length of user buffer */
625         u8 set;         /* get or set request (optional) */
626         uint used;              /* bytes read or written (optional) */
627         uint needed;            /* bytes needed (optional) */
628 } wl_ioctl_t;
629
630 /* Forward decls for struct dhd_pub (see below) */
631 struct dhd_bus;         /* device bus info */
632 struct brcmf_proto;     /* device communication protocol info */
633 struct dhd_info;        /* device driver info */
634
635 /* Common structure for module and instance linkage */
636 typedef struct dhd_pub {
637         /* Linkage ponters */
638         struct dhd_bus *bus;
639         struct brcmf_proto *prot;
640         struct dhd_info *info;
641
642         /* Internal dhd items */
643         bool up;                /* Driver up/down (to OS) */
644         bool txoff;             /* Transmit flow-controlled */
645         bool dongle_reset;      /* true = DEVRESET put dongle into reset */
646         enum dhd_bus_state busstate;
647         uint hdrlen;            /* Total DHD header length (proto + bus) */
648         uint maxctl;            /* Max size rxctl request from proto to bus */
649         uint rxsz;              /* Rx buffer size bus module should use */
650         u8 wme_dp;              /* wme discard priority */
651
652         /* Dongle media info */
653         bool iswl;              /* Dongle-resident driver is wl */
654         unsigned long drv_version;      /* Version of dongle-resident driver */
655         u8 mac[ETH_ALEN];                       /* MAC address obtained from dongle */
656         dngl_stats_t dstats;            /* Stats for dongle-based data */
657
658         /* Additional stats for the bus level */
659         unsigned long tx_packets;       /* Data packets sent to dongle */
660         unsigned long tx_multicast;     /* Multicast data packets sent to dongle */
661         unsigned long tx_errors;        /* Errors in sending data to dongle */
662         unsigned long tx_ctlpkts;       /* Control packets sent to dongle */
663         unsigned long tx_ctlerrs;       /* Errors sending control frames to dongle */
664         unsigned long rx_packets;       /* Packets sent up the network interface */
665         unsigned long rx_multicast;     /* Multicast packets sent up the network
666                                          interface */
667         unsigned long rx_errors;        /* Errors processing rx data packets */
668         unsigned long rx_ctlpkts;       /* Control frames processed from dongle */
669         unsigned long rx_ctlerrs;       /* Errors in processing rx control frames */
670         unsigned long rx_dropped;       /* Packets dropped locally (no memory) */
671         unsigned long rx_flushed;       /* Packets flushed due to
672                                 unscheduled sendup thread */
673         unsigned long wd_dpc_sched;     /* Number of times dhd dpc scheduled by
674                                          watchdog timer */
675
676         unsigned long rx_readahead_cnt; /* Number of packets where header read-ahead
677                                          was used. */
678         unsigned long tx_realloc;       /* Number of tx packets we had to realloc for
679                                          headroom */
680         unsigned long fc_packets;       /* Number of flow control pkts recvd */
681
682         /* Last error return */
683         int bcmerror;
684         uint tickcnt;
685
686         /* Last error from dongle */
687         int dongle_error;
688
689         /* Suspend disable flag  flag */
690         int suspend_disable_flag;       /* "1" to disable all extra powersaving
691                                          during suspend */
692         int in_suspend;         /* flag set to 1 when early suspend called */
693         int dtim_skip;          /* dtim skip , default 0 means wake each dtim */
694
695         /* Pkt filter defination */
696         char *pktfilter[100];
697         int pktfilter_count;
698
699         u8 country_code[WLC_CNTRY_BUF_SZ];
700         char eventmask[WL_EVENTING_MASK_LEN];
701
702 } dhd_pub_t;
703
704 typedef struct dhd_if_event {
705         u8 ifidx;
706         u8 action;
707         u8 flags;
708         u8 bssidx;
709 } dhd_if_event_t;
710
711 typedef struct {
712         u32 limit;              /* Expiration time (usec) */
713         u32 increment;  /* Current expiration increment (usec) */
714         u32 elapsed;            /* Current elapsed time (usec) */
715         u32 tick;               /* O/S tick time (usec) */
716 } dhd_timeout_t;
717
718 typedef struct {
719         uint event;
720         const char *name;
721 } bcmevent_name_t;
722
723 #if defined(CONFIG_PM_SLEEP)
724 extern atomic_t brcmf_mmc_suspend;
725 #define DHD_PM_RESUME_WAIT_INIT(a) DECLARE_WAIT_QUEUE_HEAD(a);
726 #define _DHD_PM_RESUME_WAIT(a, b) do { \
727                 int retry = 0; \
728                 while (atomic_read(&brcmf_mmc_suspend) && retry++ != b) { \
729                         wait_event_timeout(a, false, HZ/100); \
730                 } \
731         }       while (0)
732 #define DHD_PM_RESUME_WAIT(a)   _DHD_PM_RESUME_WAIT(a, 30)
733 #define DHD_PM_RESUME_WAIT_FOREVER(a)   _DHD_PM_RESUME_WAIT(a, ~0)
734 #define DHD_PM_RESUME_RETURN_ERROR(a)   \
735         do { if (atomic_read(&brcmf_mmc_suspend)) return a; } while (0)
736 #define DHD_PM_RESUME_RETURN    do { \
737         if (atomic_read(&brcmf_mmc_suspend)) \
738                 return; \
739         } while (0)
740
741 #define DHD_SPINWAIT_SLEEP_INIT(a) DECLARE_WAIT_QUEUE_HEAD(a);
742 #define SPINWAIT_SLEEP(a, exp, us) do { \
743                 uint countdown = (us) + 9999; \
744                 while ((exp) && (countdown >= 10000)) { \
745                         wait_event_timeout(a, false, HZ/100); \
746                         countdown -= 10000; \
747                 } \
748         } while (0)
749
750 #else
751
752 #define DHD_PM_RESUME_WAIT_INIT(a)
753 #define DHD_PM_RESUME_WAIT(a)
754 #define DHD_PM_RESUME_WAIT_FOREVER(a)
755 #define DHD_PM_RESUME_RETURN_ERROR(a)
756 #define DHD_PM_RESUME_RETURN
757
758 #define DHD_SPINWAIT_SLEEP_INIT(a)
759 #define SPINWAIT_SLEEP(a, exp, us)  do { \
760                 uint countdown = (us) + 9; \
761                 while ((exp) && (countdown >= 10)) { \
762                         udelay(10);  \
763                         countdown -= 10;  \
764                 } \
765         } while (0)
766
767 #endif  /* defined(CONFIG_PM_SLEEP) */
768
769 /*
770  * Insmod parameters for debug/test
771  */
772
773 /* Use interrupts */
774 extern uint brcmf_intr;
775
776 /* Use polling */
777 extern uint brcmf_poll;
778
779 /* ARP offload agent mode */
780 extern uint brcmf_arp_mode;
781
782 /* ARP offload enable */
783 extern uint brcmf_arp_enable;
784
785 /* Pkt filte enable control */
786 extern uint brcmf_pkt_filter_enable;
787
788 /*  Pkt filter init setup */
789 extern uint brcmf_pkt_filter_init;
790
791 /* Pkt filter mode control */
792 extern uint brcmf_master_mode;
793
794 /* Roaming mode control */
795 extern uint brcmf_roam;
796
797 /* Roaming mode control */
798 extern uint brcmf_radio_up;
799
800 /* Initial idletime ticks (may be -1 for immediate idle, 0 for no idle) */
801 extern int brcmf_idletime;
802 #define BRCMF_IDLETIME_TICKS 1
803
804 /* SDIO Drive Strength */
805 extern uint brcmf_sdiod_drive_strength;
806
807 /* Override to force tx queueing all the time */
808 extern uint brcmf_force_tx_queueing;
809
810 #ifdef SDTEST
811 /* Echo packet generator (SDIO), pkts/s */
812 extern uint brcmf_pktgen;
813
814 /* Echo packet len (0 => sawtooth, max 1800) */
815 extern uint brcmf_pktgen_len;
816 #define BRCMF_MAX_PKTGEN_LEN 1800
817 #endif
818
819 extern u32 g_assert_type;
820 extern const bcmevent_name_t bcmevent_names[];
821 extern const int bcmevent_names_size;
822
823
824 static inline void MUTEX_LOCK_INIT(dhd_pub_t *dhdp)
825 {
826 }
827
828 static inline void MUTEX_LOCK(dhd_pub_t *dhdp)
829 {
830 }
831
832 static inline void MUTEX_UNLOCK(dhd_pub_t *dhdp)
833 {
834 }
835
836 static inline void MUTEX_LOCK_SOFTAP_SET_INIT(dhd_pub_t *dhdp)
837 {
838 }
839
840 static inline void MUTEX_LOCK_SOFTAP_SET(dhd_pub_t *dhdp)
841 {
842 }
843
844 static inline void MUTEX_UNLOCK_SOFTAP_SET(dhd_pub_t *dhdp)
845 {
846 }
847
848 static inline void MUTEX_LOCK_WL_SCAN_SET_INIT(void)
849 {
850 }
851
852 static inline void MUTEX_LOCK_WL_SCAN_SET(void)
853 {
854 }
855
856 static inline void MUTEX_UNLOCK_WL_SCAN_SET(void)
857 {
858 }
859
860 /*
861  * Exported from dhd OS modules (dhd_linux/dhd_ndis)
862  */
863
864 /* Indication from bus module regarding presence/insertion of dongle.
865  * Return dhd_pub_t pointer, used as handle to OS module in later calls.
866  * Returned structure should have bus and prot pointers filled in.
867  * bus_hdrlen specifies required headroom for bus module header.
868  */
869 extern dhd_pub_t *brcmf_attach(struct dhd_bus *bus,
870                                 uint bus_hdrlen);
871 extern int brcmf_net_attach(dhd_pub_t *dhdp, int idx);
872 extern int brcmf_netdev_wait_pend8021x(struct net_device *dev);
873
874 /* Indication from bus module regarding removal/absence of dongle */
875 extern void brcmf_detach(dhd_pub_t *dhdp);
876
877 /* Indication from bus module to change flow-control state */
878 extern void brcmf_txflowcontrol(dhd_pub_t *dhdp, int ifidx, bool on);
879
880 extern bool brcmf_c_prec_enq(dhd_pub_t *dhdp, struct pktq *q,
881                          struct sk_buff *pkt, int prec);
882
883 /* Receive frame for delivery to OS.  Callee disposes of rxp. */
884 extern void brcmf_rx_frame(dhd_pub_t *dhdp, int ifidx,
885                          struct sk_buff *rxp, int numpkt);
886
887 /* Return pointer to interface name */
888 extern char *brcmf_ifname(dhd_pub_t *dhdp, int idx);
889
890 /* Request scheduling of the bus dpc */
891 extern void brcmf_sched_dpc(dhd_pub_t *dhdp);
892
893 /* Notify tx completion */
894 extern void brcmf_txcomplete(dhd_pub_t *dhdp, struct sk_buff *txp,
895                              bool success);
896
897 /* Query ioctl */
898 extern int brcmf_proto_cdc_query_ioctl(dhd_pub_t *dhd, int ifidx, uint cmd,
899                                        void *buf, uint len);
900
901 /* OS independent layer functions */
902 extern int brcmf_os_proto_block(dhd_pub_t *pub);
903 extern int brcmf_os_proto_unblock(dhd_pub_t *pub);
904 extern int brcmf_os_ioctl_resp_wait(dhd_pub_t *pub, uint *condition,
905                                   bool *pending);
906 extern int brcmf_os_ioctl_resp_wake(dhd_pub_t *pub);
907 extern unsigned int brcmf_os_get_ioctl_resp_timeout(void);
908 extern void brcmf_os_set_ioctl_resp_timeout(unsigned int timeout_msec);
909 extern void brcmf_os_sdlock_sndup_rxq(dhd_pub_t *pub);
910 extern void brcmf_customer_gpio_wlan_ctrl(int onoff);
911 extern int brcmf_custom_get_mac_address(unsigned char *buf);
912 extern void brcmf_os_sdunlock_sndup_rxq(dhd_pub_t *pub);
913 extern void brcmf_os_sdlock_eventq(dhd_pub_t *pub);
914 extern void brcmf_os_sdunlock_eventq(dhd_pub_t *pub);
915 #ifdef BCMDBG
916 extern int brcmf_write_to_file(dhd_pub_t *dhd, u8 *buf, int size);
917 #endif                          /* BCMDBG */
918
919 extern void brcmf_timeout_start(dhd_timeout_t *tmo, uint usec);
920 extern int brcmf_timeout_expired(dhd_timeout_t *tmo);
921
922 extern int brcmf_ifname2idx(struct dhd_info *dhd, char *name);
923 extern int brcmf_c_host_event(struct dhd_info *dhd, int *idx, void *pktdata,
924                          brcmf_event_msg_t *, void **data_ptr);
925
926 extern void brcmf_c_init(void);
927
928 extern int brcmf_add_if(struct dhd_info *dhd, int ifidx, void *handle,
929                       char *name, u8 *mac_addr, u32 flags, u8 bssidx);
930 extern void brcmf_del_if(struct dhd_info *dhd, int ifidx);
931
932 extern void brcmf_vif_add(struct dhd_info *dhd, int ifidx, char *name);
933 extern void brcmf_vif_del(struct dhd_info *dhd, int ifidx);
934
935 extern void brcmf_event(struct dhd_info *dhd, char *evpkt, int evlen,
936                         int ifidx);
937 extern void brcmf_vif_sendup(struct dhd_info *dhd, int ifidx,
938                              unsigned char *cp, int len);
939
940 /* Send packet to dongle via data channel */
941 extern int brcmf_sendpkt(dhd_pub_t *dhdp, int ifidx, struct sk_buff *pkt);
942
943 extern int brcmf_bus_devreset(dhd_pub_t *dhdp, u8 flag);
944 extern int brcmf_bus_start(dhd_pub_t *dhdp);
945
946 extern void brcmf_c_pktfilter_offload_set(dhd_pub_t *dhd, char *arg);
947 extern void brcmf_c_pktfilter_offload_enable(dhd_pub_t *dhd, char *arg,
948                                              int enable, int master_mode);
949
950 #ifdef BCMDBG
951 #define ASSERT(exp) \
952           do { if (!(exp)) osl_assert(#exp, __FILE__, __LINE__); } while (0)
953 extern void osl_assert(char *exp, char *file, int line);
954 #else
955 #define ASSERT(exp)     do {} while (0)
956 #endif  /* defined(BCMDBG) */
957
958 /* Linux network driver ioctl encoding */
959 typedef struct dhd_ioctl {
960         uint cmd;               /* common ioctl definition */
961         void *buf;              /* pointer to user buffer */
962         uint len;               /* length of user buffer */
963         bool set;               /* get or set request (optional) */
964         uint used;              /* bytes read or written (optional) */
965         uint needed;            /* bytes needed (optional) */
966         uint driver;            /* to identify target driver */
967 } dhd_ioctl_t;
968
969 /* per-driver magic numbers */
970 #define DHD_IOCTL_MAGIC         0x00444944
971
972 /* bump this number if you change the ioctl interface */
973 #define DHD_IOCTL_VERSION       1
974
975 #define DHD_IOCTL_MAXLEN        8192    /* max length ioctl buffer required */
976 #define DHD_IOCTL_SMLEN 256     /* "small" length ioctl buffer required */
977
978 /* common ioctl definitions */
979 #define DHD_GET_MAGIC                           0
980 #define DHD_GET_VERSION                         1
981 #define DHD_GET_VAR                             2
982 #define DHD_SET_VAR                             3
983
984 /* message levels */
985 #define DHD_ERROR_VAL   0x0001
986 #define DHD_TRACE_VAL   0x0002
987 #define DHD_INFO_VAL    0x0004
988 #define DHD_DATA_VAL    0x0008
989 #define DHD_CTL_VAL     0x0010
990 #define DHD_TIMER_VAL   0x0020
991 #define DHD_HDRS_VAL    0x0040
992 #define DHD_BYTES_VAL   0x0080
993 #define DHD_INTR_VAL    0x0100
994 #define DHD_LOG_VAL     0x0200
995 #define DHD_GLOM_VAL    0x0400
996 #define DHD_EVENT_VAL   0x0800
997 #define DHD_BTA_VAL     0x1000
998 #define DHD_ISCAN_VAL 0x2000
999
1000 #ifdef SDTEST
1001 /* For pktgen iovar */
1002 typedef struct brcmf_pktgen {
1003         uint version;           /* To allow structure change tracking */
1004         uint freq;              /* Max ticks between tx/rx attempts */
1005         uint count;             /* Test packets to send/rcv each attempt */
1006         uint print;             /* Print counts every <print> attempts */
1007         uint total;             /* Total packets (or bursts) */
1008         uint minlen;            /* Minimum length of packets to send */
1009         uint maxlen;            /* Maximum length of packets to send */
1010         uint numsent;           /* Count of test packets sent */
1011         uint numrcvd;           /* Count of test packets received */
1012         uint numfail;           /* Count of test send failures */
1013         uint mode;              /* Test mode (type of test packets) */
1014         uint stop;              /* Stop after this many tx failures */
1015 } brcmf_pktgen_t;
1016
1017 /* Version in case structure changes */
1018 #define DHD_PKTGEN_VERSION 2
1019
1020 /* Type of test packets to use */
1021 #define DHD_PKTGEN_ECHO         1       /* Send echo requests */
1022 #define DHD_PKTGEN_SEND         2       /* Send discard packets */
1023 #define DHD_PKTGEN_RXBURST      3       /* Request dongle send N packets */
1024 #define DHD_PKTGEN_RECV         4       /* Continuous rx from continuous
1025                                          tx dongle */
1026 #endif                          /* SDTEST */
1027
1028 /* Enter idle immediately (no timeout) */
1029 #define DHD_IDLE_IMMEDIATE      (-1)
1030
1031 /* Values for idleclock iovar: other values are the sd_divisor to use
1032          when idle */
1033 #define DHD_IDLE_ACTIVE 0       /* Do not request any SD clock change
1034                                  when idle */
1035 #define DHD_IDLE_STOP   (-1)    /* Request SD clock be stopped
1036                                  (and use SD1 mode) */
1037
1038 #endif                          /* _dhd_h_ */