1 /*******************************************************************************
3 * Wireless device driver for Linux (wlags49).
5 * Copyright (c) 1998-2003 Agere Systems Inc.
9 * Initially developed by TriplePoint, Inc.
10 * http://www.triplepoint.com
12 *------------------------------------------------------------------------------
14 * Header for defintions and macros internal to the drvier.
16 *------------------------------------------------------------------------------
20 * This software is provided subject to the following terms and conditions,
21 * which you should read carefully before using the software. Using this
22 * software indicates your acceptance of these terms and conditions. If you do
23 * not agree with these terms and conditions, do not use the software.
25 * Copyright © 2003 Agere Systems Inc.
26 * All rights reserved.
28 * Redistribution and use in source or binary forms, with or without
29 * modifications, are permitted provided that the following conditions are met:
31 * . Redistributions of source code must retain the above copyright notice, this
32 * list of conditions and the following Disclaimer as comments in the code as
33 * well as in the documentation and/or other materials provided with the
36 * . Redistributions in binary form must reproduce the above copyright notice,
37 * this list of conditions and the following Disclaimer in the documentation
38 * and/or other materials provided with the distribution.
40 * . Neither the name of Agere Systems Inc. nor the names of the contributors
41 * may be used to endorse or promote products derived from this software
42 * without specific prior written permission.
46 * THIS SOFTWARE IS PROVIDED
\93AS IS
\94 AND ANY EXPRESS OR IMPLIED WARRANTIES,
47 * INCLUDING, BUT NOT LIMITED TO, INFRINGEMENT AND THE IMPLIED WARRANTIES OF
48 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. ANY
49 * USE, MODIFICATION OR DISTRIBUTION OF THIS SOFTWARE IS SOLELY AT THE USERS OWN
50 * RISK. IN NO EVENT SHALL AGERE SYSTEMS INC. OR CONTRIBUTORS BE LIABLE FOR ANY
51 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
52 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
53 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
54 * ON ANY THEORY OF LIABILITY, INCLUDING, BUT NOT LIMITED TO, CONTRACT, STRICT
55 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
56 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
59 ******************************************************************************/
61 #ifndef __WAVELAN2_H__
62 #define __WAVELAN2_H__
67 /*******************************************************************************
69 ******************************************************************************/
70 #include <linux/version.h>
72 #if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,27)
73 #include <pcmcia/version.h>
75 #include <pcmcia/cs_types.h>
76 #include <pcmcia/cs.h>
77 #include <pcmcia/cistpl.h>
78 #include <pcmcia/cisreg.h>
79 #include <pcmcia/ciscode.h>
80 #include <pcmcia/ds.h>
83 #ifdef HAS_WIRELESS_EXTENSIONS
84 #include <linux/wireless.h>
86 #include <net/iw_handler.h>
87 #endif // WIRELESS_EXT > 13
89 #define RETURN_CURRENT_NETWORKNAME
91 #endif // HAS_WIRELESS_EXTENSIONS/
93 #include <linux/list.h>
95 #include <linux/interrupt.h>
100 /*******************************************************************************
101 * constant definitions
102 ******************************************************************************/
111 #define MAX_KEY_LEN (2 + (13 * 2)) // 0x plus 13 hex digit pairs
113 #define MAX_ENC_LEN 104
115 #define MAX_SCAN_TIME_SEC 8
118 #define CFG_MB_INFO 0x0820 //Mail Box Info Block
120 #define NUM_WDS_PORTS 6
122 #define WVLAN_MAX_LOOKAHEAD (HCF_MAX_MSG+46) /* as per s0005MIC_4.doc */
125 /* Min/Max/Default Parameter Values */
126 #if 0 //;? (HCF_TYPE) & HCF_TYPE_AP
127 //;? why this difference depending on compile option, seems to me it should depend on runtime if anything
128 #define PARM_DEFAULT_SSID "LinuxAP"
130 #define PARM_DEFAULT_SSID "ANY"
131 #endif // HCF_TYPE_AP
133 #define PARM_MIN_NAME_LEN 1
134 #define PARM_MAX_NAME_LEN 32
137 /* The following definitions pertain to module and profile parameters */
138 // #define PARM_AP_MODE APMode
139 // #define PARM_NAME_AP_MODE TEXT("APMode")
140 // #define PARM_DEFAULT_AP_MODE FALSE
142 #define PARM_AUTHENTICATION Authentication
143 #define PARM_NAME_AUTHENTICATION TEXT("Authentication")
144 #define PARM_MIN_AUTHENTICATION 1
145 #define PARM_MAX_AUTHENTICATION 2
146 #define PARM_DEFAULT_AUTHENTICATION 1
148 #define PARM_AUTH_KEY_MGMT_SUITE AuthKeyMgmtSuite
149 #define PARM_NAME_AUTH_KEY_MGMT_SUITE TEXT("AuthKeyMgmtSuite")
150 #define PARM_MIN_AUTH_KEY_MGMT_SUITE 0
151 #define PARM_MAX_AUTH_KEY_MGMT_SUITE 4
152 #define PARM_DEFAULT_AUTH_KEY_MGMT_SUITE 0
154 #define PARM_BRSC_2GHZ BRSC2GHz
155 #define PARM_NAME_BRSC_2GHZ TEXT("BRSC2GHz")
156 #define PARM_MIN_BRSC 0x0000
157 #define PARM_MAX_BRSC 0x0FFF
158 #define PARM_DEFAULT_BRSC_2GHZ 0x000F
160 #define PARM_BRSC_5GHZ BRSC5GHz
161 #define PARM_NAME_BRSC_5GHZ TEXT("BRSC5GHz")
162 #define PARM_DEFAULT_BRSC_5GHZ 0x0150
164 #define PARM_COEXISTENCE Coexistence
165 #define PARM_NAME_COEXISTENCE TEXT("Coexistence")
166 #define PARM_MIN_COEXISTENCE 0x0000
167 #define PARM_MAX_COEXISTENCE 0x0007
168 #define PARM_DEFAULT_COEXISTENCE 0x0000
170 #define PARM_CONFIGURED Configured
171 #define PARM_NAME_CONFIGURED TEXT("Configured")
173 #define PARM_CONNECTION_CONTROL ConnectionControl
174 #define PARM_NAME_CONNECTION_CONTROL TEXT("ConnectionControl")
175 #define PARM_MIN_CONNECTION_CONTROL 0
176 #define PARM_MAX_CONNECTION_CONTROL 3
177 #define PARM_DEFAULT_CONNECTION_CONTROL 2
179 #define PARM_CREATE_IBSS CreateIBSS
180 #define PARM_NAME_CREATE_IBSS TEXT("CreateIBSS")
181 #define PARM_DEFAULT_CREATE_IBSS FALSE
182 #define PARM_DEFAULT_CREATE_IBSS_STR "N"
184 #define PARM_DEBUG_FLAG DebugFlag
185 #define PARM_NAME_DEBUG_FLAG TEXT("DebugFlag")
186 #define PARM_MIN_DEBUG_FLAG 0
187 #define PARM_MAX_DEBUG_FLAG 0xFFFF
188 #define PARM_DEFAULT_DEBUG_FLAG 0xFFFF
190 #define PARM_DESIRED_SSID DesiredSSID
191 #define PARM_NAME_DESIRED_SSID TEXT("DesiredSSID")
193 #define PARM_DOWNLOAD_FIRMWARE DownloadFirmware
194 #define PARM_NAME_DOWNLOAD_FIRMWARE TEXT("DownloadFirmware")
196 #define PARM_DRIVER_ENABLE DriverEnable
197 #define PARM_NAME_DRIVER_ENABLE TEXT("DriverEnable")
198 #define PARM_DEFAULT_DRIVER_ENABLE TRUE
200 #define PARM_ENABLE_ENCRYPTION EnableEncryption
201 #define PARM_NAME_ENABLE_ENCRYPTION TEXT("EnableEncryption")
202 #define PARM_MIN_ENABLE_ENCRYPTION 0
203 #define PARM_MAX_ENABLE_ENCRYPTION 7
204 #define PARM_DEFAULT_ENABLE_ENCRYPTION 0
206 #define PARM_ENCRYPTION Encryption
207 #define PARM_NAME_ENCRYPTION TEXT("Encryption")
209 #define PARM_EXCLUDE_UNENCRYPTED ExcludeUnencrypted
210 #define PARM_NAME_EXCLUDE_UNENCRYPTED TEXT("ExcludeUnencrypted")
211 #define PARM_DEFAULT_EXCLUDE_UNENCRYPTED TRUE
212 #define PARM_DEFAULT_EXCLUDE_UNENCRYPTED_STR "N"
214 #define PARM_INTRA_BSS_RELAY IntraBSSRelay
215 #define PARM_NAME_INTRA_BSS_RELAY TEXT("IntraBSSRelay")
216 #define PARM_DEFAULT_INTRA_BSS_RELAY TRUE
217 #define PARM_DEFAULT_INTRA_BSS_RELAY_STR "Y"
219 #define PARM_KEY1 Key1
220 #define PARM_NAME_KEY1 TEXT("Key1")
221 #define PARM_KEY2 Key2
222 #define PARM_NAME_KEY2 TEXT("Key2")
223 #define PARM_KEY3 Key3
224 #define PARM_NAME_KEY3 TEXT("Key3")
225 #define PARM_KEY4 Key4
226 #define PARM_NAME_KEY4 TEXT("Key4")
228 //;? #define PARM_KEY_FORMAT AsciiHex
229 //;? #define PARM_NAME_KEY_FORMAT TEXT("AsciiHex")
231 #define PARM_LOAD_BALANCING LoadBalancing
232 #define PARM_NAME_LOAD_BALANCING TEXT("LoadBalancing")
233 #define PARM_DEFAULT_LOAD_BALANCING TRUE
234 #define PARM_DEFAULT_LOAD_BALANCING_STR "Y"
236 #define PARM_MAX_DATA_LENGTH MaxDataLength
237 #define PARM_NAME_MAX_DATA_LENGTH TEXT("MaxDataLength")
239 #define PARM_MAX_SLEEP MaxSleepDuration
240 #define PARM_NAME_MAX_SLEEP TEXT("MaxSleepDuration")
241 #define PARM_MIN_MAX_PM_SLEEP 1 //;?names nearly right?
242 #define PARM_MAX_MAX_PM_SLEEP 65535
243 #define PARM_DEFAULT_MAX_PM_SLEEP 100
245 #define PARM_MEDIUM_DISTRIBUTION MediumDistribution
246 #define PARM_NAME_MEDIUM_DISTRIBUTION TEXT("MediumDistribution")
247 #define PARM_DEFAULT_MEDIUM_DISTRIBUTION TRUE
248 #define PARM_DEFAULT_MEDIUM_DISTRIBUTION_STR "Y"
250 #define PARM_MICROWAVE_ROBUSTNESS MicroWaveRobustness
251 #define PARM_NAME_MICROWAVE_ROBUSTNESS TEXT("MicroWaveRobustness")
252 #define PARM_DEFAULT_MICROWAVE_ROBUSTNESS FALSE
253 #define PARM_DEFAULT_MICROWAVE_ROBUSTNESS_STR "N"
255 #define PARM_MULTICAST_PM_BUFFERING MulticastPMBuffering
256 #define PARM_NAME_MULTICAST_PM_BUFFERING TEXT("MulticastPMBuffering")
257 #define PARM_DEFAULT_MULTICAST_PM_BUFFERING TRUE
258 #define PARM_DEFAULT_MULTICAST_PM_BUFFERING_STR "Y"
260 #define PARM_MULTICAST_RATE MulticastRate
261 #define PARM_NAME_MULTICAST_RATE TEXT("MulticastRate")
263 #define PARM_MIN_MULTICAST_RATE 0x0001
264 #define PARM_MAX_MULTICAST_RATE 0x0fff
265 #define PARM_DEFAULT_MULTICAST_RATE_2GHZ 0x0004
266 #define PARM_DEFAULT_MULTICAST_RATE_5GHZ 0x0010
268 #define PARM_MIN_MULTICAST_RATE 0x0001
269 #define PARM_MAX_MULTICAST_RATE 0x0004
270 #define PARM_DEFAULT_MULTICAST_RATE_2GHZ 0x0002
271 #define PARM_DEFAULT_MULTICAST_RATE_5GHZ 0x0000
274 #define PARM_MULTICAST_RX MulticastReceive
275 #define PARM_NAME_MULTICAST_RX TEXT("MulticastReceive")
276 #define PARM_DEFAULT_MULTICAST_RX TRUE
277 #define PARM_DEFAULT_MULTICAST_RX_STR "Y"
279 #define PARM_NETWORK_ADDR NetworkAddress
280 #define PARM_NAME_NETWORK_ADDR TEXT("NetworkAddress")
281 #define PARM_DEFAULT_NETWORK_ADDR { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }
283 #define PARM_NETWORK_TYPE NetworkType
284 #define PARM_NAME_NETWORK_TYPE TEXT("NetworkType")
285 #define PARM_DEFAULT_NETWORK_TYPE 0
287 #define PARM_OWN_ATIM_WINDOW OwnATIMWindow
288 #define PARM_NAME_OWN_ATIM_WINDOW TEXT("OwnATIMWindow")
289 #define PARM_MIN_OWN_ATIM_WINDOW 0
290 #define PARM_MAX_OWN_ATIM_WINDOW 100
291 #define PARM_DEFAULT_OWN_ATIM_WINDOW 0
293 #define PARM_OWN_BEACON_INTERVAL OwnBeaconInterval
294 #define PARM_NAME_OWN_BEACON_INTERVAL TEXT("OwnBeaconInterval")
295 #define PARM_MIN_OWN_BEACON_INTERVAL 20
296 #define PARM_MAX_OWN_BEACON_INTERVAL 200
297 #define PARM_DEFAULT_OWN_BEACON_INTERVAL 100
299 #define PARM_OWN_CHANNEL OwnChannel
300 #define PARM_NAME_OWN_CHANNEL TEXT("OwnChannel")
301 #define PARM_MIN_OWN_CHANNEL 1
302 #define PARM_MAX_OWN_CHANNEL 161
303 #define PARM_DEFAULT_OWN_CHANNEL 10
305 #define PARM_OWN_DTIM_PERIOD OwnDTIMPeriod
306 #define PARM_NAME_OWN_DTIM_PERIOD TEXT("OwnDTIMPeriod")
307 #define PARM_MIN_OWN_DTIM_PERIOD 1
308 #define PARM_MAX_OWN_DTIM_PERIOD 65535
309 #define PARM_DEFAULT_OWN_DTIM_PERIOD 1
311 #define PARM_OWN_NAME OwnName
312 #define PARM_NAME_OWN_NAME TEXT("OwnName")
313 #define PARM_DEFAULT_OWN_NAME "Linux"
315 #define PARM_OWN_SSID OwnSSID
316 #define PARM_NAME_OWN_SSID TEXT("OwnSSID")
318 #define PARM_PM_ENABLED PMEnabled
319 #define PARM_NAME_PM_ENABLED TEXT("PMEnabled")
320 #define PARM_MAX_PM_ENABLED 3
322 #define PARM_PMEPS PMEPS
323 #define PARM_NAME_PMEPS TEXT("PMEPS")
325 #define PARM_PM_HOLDOVER_DURATION PMHoldoverDuration
326 #define PARM_NAME_PM_HOLDOVER_DURATION TEXT("PMHoldoverDuration")
327 #define PARM_MIN_PM_HOLDOVER_DURATION 1
328 #define PARM_MAX_PM_HOLDOVER_DURATION 1000
329 #define PARM_DEFAULT_PM_HOLDOVER_DURATION 100
331 #define PARM_PM_MODE PowerMode
332 #define PARM_NAME_PM_MODE TEXT("PowerMode")
334 #define PARM_PORT_TYPE PortType
335 #define PARM_NAME_PORT_TYPE TEXT("PortType")
336 #define PARM_MIN_PORT_TYPE 1
337 #define PARM_MAX_PORT_TYPE 3
338 #define PARM_DEFAULT_PORT_TYPE 1
340 #define PARM_PROMISCUOUS_MODE PromiscuousMode
341 #define PARM_NAME_PROMISCUOUS_MODE TEXT("PromiscuousMode")
342 #define PARM_DEFAULT_PROMISCUOUS_MODE FALSE
343 #define PARM_DEFAULT_PROMISCUOUS_MODE_STR "N"
345 #define PARM_REJECT_ANY RejectANY
346 #define PARM_NAME_REJECT_ANY TEXT("RejectANY")
347 #define PARM_DEFAULT_REJECT_ANY FALSE
348 #define PARM_DEFAULT_REJECT_ANY_STR "N"
350 #define PARM_RTS_THRESHOLD RTSThreshold
351 #define PARM_NAME_RTS_THRESHOLD TEXT("RTSThreshold")
352 #define PARM_MIN_RTS_THRESHOLD 0
353 #define PARM_MAX_RTS_THRESHOLD 2347
354 #define PARM_DEFAULT_RTS_THRESHOLD 2347
356 #define PARM_RTS_THRESHOLD1 RTSThreshold1
357 #define PARM_NAME_RTS_THRESHOLD1 TEXT("RTSThreshold1")
358 #define PARM_RTS_THRESHOLD2 RTSThreshold2
359 #define PARM_NAME_RTS_THRESHOLD2 TEXT("RTSThreshold2")
360 #define PARM_RTS_THRESHOLD3 RTSThreshold3
361 #define PARM_NAME_RTS_THRESHOLD3 TEXT("RTSThreshold3")
362 #define PARM_RTS_THRESHOLD4 RTSThreshold4
363 #define PARM_NAME_RTS_THRESHOLD4 TEXT("RTSThreshold4")
364 #define PARM_RTS_THRESHOLD5 RTSThreshold5
365 #define PARM_NAME_RTS_THRESHOLD5 TEXT("RTSThreshold5")
366 #define PARM_RTS_THRESHOLD6 RTSThreshold6
367 #define PARM_NAME_RTS_THRESHOLD6 TEXT("RTSThreshold6")
369 #define PARM_SRSC_2GHZ SRSC2GHz
370 #define PARM_NAME_SRSC_2GHZ TEXT("SRSC2GHz")
371 #define PARM_MIN_SRSC 0x0000
372 #define PARM_MAX_SRSC 0x0FFF
373 #define PARM_DEFAULT_SRSC_2GHZ 0x0FFF
375 #define PARM_SRSC_5GHZ SRSC5GHz
376 #define PARM_NAME_SRSC_5GHZ TEXT("SRSC5GHz")
377 #define PARM_DEFAULT_SRSC_5GHZ 0x0FF0
379 #define PARM_SYSTEM_SCALE SystemScale
380 #define PARM_NAME_SYSTEM_SCALE TEXT("SystemScale")
381 #define PARM_MIN_SYSTEM_SCALE 1
382 #define PARM_MAX_SYSTEM_SCALE 5
383 #define PARM_DEFAULT_SYSTEM_SCALE 1
385 #define PARM_TX_KEY TxKey
386 #define PARM_NAME_TX_KEY TEXT("TxKey")
387 #define PARM_MIN_TX_KEY 1
388 #define PARM_MAX_TX_KEY 4
389 #define PARM_DEFAULT_TX_KEY 1
391 #define PARM_TX_POW_LEVEL TxPowLevel
392 #define PARM_NAME_TX_POW_LEVEL TEXT("TxPowLevel")
393 #define PARM_MIN_TX_POW_LEVEL 1 // 20 dBm
394 #define PARM_MAX_TX_POW_LEVEL 6 // 8 dBm
395 #define PARM_DEFAULT_TX_POW_LEVEL 3 // 15 dBm
397 #define PARM_TX_RATE TxRateControl
398 #define PARM_NAME_TX_RATE TEXT("TxRateControl")
399 #define PARM_MIN_TX_RATE 0x0001
401 #define PARM_MAX_TX_RATE 0x0FFF
402 #define PARM_DEFAULT_TX_RATE_2GHZ 0x0FFF
403 #define PARM_DEFAULT_TX_RATE_5GHZ 0x0FF0
405 #define PARM_MAX_TX_RATE 0x0007
406 #define PARM_DEFAULT_TX_RATE_2GHZ 0x0003
407 #define PARM_DEFAULT_TX_RATE_5GHZ 0x0000
410 #define PARM_TX_RATE1 TxRateControl1
411 #define PARM_NAME_TX_RATE1 TEXT("TxRateControl1")
412 #define PARM_TX_RATE2 TxRateControl2
413 #define PARM_NAME_TX_RATE2 TEXT("TxRateControl2")
414 #define PARM_TX_RATE3 TxRateControl3
415 #define PARM_NAME_TX_RATE3 TEXT("TxRateControl3")
416 #define PARM_TX_RATE4 TxRateControl4
417 #define PARM_NAME_TX_RATE4 TEXT("TxRateControl4")
418 #define PARM_TX_RATE5 TxRateControl5
419 #define PARM_NAME_TX_RATE5 TEXT("TxRateControl5")
420 #define PARM_TX_RATE6 TxRateControl6
421 #define PARM_NAME_TX_RATE6 TEXT("TxRateControl6")
423 #define PARM_VENDORDESCRIPTION VendorDescription
424 #define PARM_NAME_VENDORDESCRIPTION TEXT("VendorDescription")
426 #define PARM_WDS_ADDRESS WDSAddress
427 #define PARM_NAME_WDS_ADDRESS TEXT("WDSAddress")
429 #define PARM_WDS_ADDRESS1 WDSAddress1
430 #define PARM_NAME_WDS_ADDRESS1 TEXT("WDSAddress1")
431 #define PARM_WDS_ADDRESS2 WDSAddress2
432 #define PARM_NAME_WDS_ADDRESS2 TEXT("WDSAddress2")
433 #define PARM_WDS_ADDRESS3 WDSAddress3
434 #define PARM_NAME_WDS_ADDRESS3 TEXT("WDSAddress3")
435 #define PARM_WDS_ADDRESS4 WDSAddress4
436 #define PARM_NAME_WDS_ADDRESS4 TEXT("WDSAddress4")
437 #define PARM_WDS_ADDRESS5 WDSAddress5
438 #define PARM_NAME_WDS_ADDRESS5 TEXT("WDSAddress5")
439 #define PARM_WDS_ADDRESS6 WDSAddress6
440 #define PARM_NAME_WDS_ADDRESS6 TEXT("WDSAddress6")
443 #define PARM_LONG_RETRY_LIMIT LongRetryLimit
444 #define PARM_NAME_LONG_RETRY_LIMIT TEXT("LongRetryLimit")
445 #define PARM_MIN_LONG_RETRY_LIMIT 1
446 #define PARM_MAX_LONG_RETRY_LIMIT 15
447 #define PARM_DEFAULT_LONG_RETRY_LIMIT 3
450 #define PARM_PROBE_DATA_RATES ProbeDataRates
451 #define PARM_NAME_PROBE_DATA_RATES TEXT("ProbeDataRates")
452 #define PARM_MIN_PROBE_DATA_RATES 0x0000
453 #define PARM_MAX_PROBE_DATA_RATES 0x0FFF
454 #define PARM_DEFAULT_PROBE_DATA_RATES_2GHZ 0x0002
455 #define PARM_DEFAULT_PROBE_DATA_RATES_5GHZ 0x0010
457 #define PARM_SHORT_RETRY_LIMIT ShortRetryLimit
458 #define PARM_NAME_SHORT_RETRY_LIMIT TEXT("ShortRetryLimit")
459 #define PARM_MIN_SHORT_RETRY_LIMIT 1
460 #define PARM_MAX_SHORT_RETRY_LIMIT 15
461 #define PARM_DEFAULT_SHORT_RETRY_LIMIT 7
466 /*******************************************************************************
468 ******************************************************************************/
469 /* The following constants are used to track state the device */
470 #define WL_FRIMWARE_PRESENT 1 // Download if needed
471 #define WL_FRIMWARE_NOT_PRESENT 0 // Skip over download, assume its already there
472 #define WL_HANDLING_INT 1 // Actually call the HCF to switch interrupts on/off
473 #define WL_NOT_HANDLING_INT 0 // Not yet handling interrupts, do not switch on/off
475 /*******************************************************************************
477 ******************************************************************************/
478 /* The following macro ensures that no symbols are exported, minimizing the
479 chance of a symbol collision in the kernel */
480 // EXPORT_NO_SYMBOLS;
482 #define NELEM(arr) (sizeof(arr) / sizeof(arr[0]))
484 #define WVLAN_VALID_MAC_ADDRESS( x ) \
485 ((x[0]!=0xFF) && (x[1]!=0xFF) && (x[2]!=0xFF) && (x[3]!=0xFF) && (x[4]!=0xFF) && (x[5]!=0xFF))
490 /*******************************************************************************
492 ******************************************************************************/
504 typedef struct _ScanResult
510 SCAN_RS_STRCT APTable [MAX_NAPS];
515 typedef struct _LINK_STATUS_STRCT
519 hcf_16 linkStatus; /* 1..5 */
524 typedef struct _ASSOC_STATUS_STRCT
528 hcf_16 assocStatus; /* 1..3 */
529 hcf_8 staAddr[ETH_ALEN];
530 hcf_8 oldApAddr[ETH_ALEN];
535 typedef struct _SECURITY_STATUS_STRCT
539 hcf_16 securityStatus; /* 1..3 */
540 hcf_8 staAddr[ETH_ALEN];
543 SECURITY_STATUS_STRCT;
545 #define WVLAN_WMP_PDU_TYPE_LT_REQ 0x00
546 #define WVLAN_WMP_PDU_TYPE_LT_RSP 0x01
547 #define WVLAN_WMP_PDU_TYPE_APL_REQ 0x02
548 #define WVLAN_WMP_PDU_TYPE_APL_RSP 0x03
550 typedef struct wvlan_eth_hdr
552 unsigned char dst[ETH_ALEN]; /* Destination address. */
553 unsigned char src[ETH_ALEN]; /* Source address. */
554 unsigned short len; /* Length of the PDU. */
556 WVLAN_ETH_HDR, *PWVLAN_ETH_HDR;
558 typedef struct wvlan_llc_snap
560 unsigned char dsap; /* DSAP (0xAA) */
561 unsigned char ssap; /* SSAP (0xAA) */
562 unsigned char ctrl; /* Control (0x03) */
563 unsigned char oui[3]; /* Organization Unique ID (00-60-1d). */
564 unsigned char specid[2]; /* Specific ID code (00-01). */
566 WVLAN_LLC_SNAP, *PWVLAN_LLC_SNAP;
569 typedef struct wvlan_lt_hdr
571 unsigned char version; /* Version (0x00) */
572 unsigned char type; /* PDU type: 0-req/1-resp. */
573 unsigned short id; /* Identifier to associate resp to req. */
575 WVLAN_LT_HDR, *PWVLAN_LT_HDR;
578 typedef struct wvlan_wmp_hdr
580 unsigned char version; /* Version */
581 unsigned char type; /* PDU type */
583 WVLAN_WMP_HDR, *PWVLAN_WMP_HDR;
586 #define FILLER_SIZE 1554
587 #define TEST_PATTERN_SIZE 54
590 typedef struct wvlan_lt_req
592 unsigned char Filler[TEST_PATTERN_SIZE]; /* minimal length of 54 bytes */
594 WVLAN_LT_REQ, *PWVLAN_LT_REQ;
597 typedef struct wvlan_lt_rsp
601 unsigned char signal;
603 unsigned char rxFlow;
604 unsigned char dataRate;
605 unsigned short protocol;
607 unsigned char station;
608 unsigned char dataRateCap;
609 unsigned char powerMgmt[4];
610 unsigned char robustness[4];
611 unsigned char scaling;
612 unsigned char reserved[5];
614 WVLAN_LT_RSP, *PWVLAN_LT_RSP;
617 typedef struct wvlan_rx_wmp_hdr
619 unsigned short status;
620 unsigned short reserved1[2];
621 unsigned char silence;
622 unsigned char signal;
624 unsigned char rxFlow;
625 unsigned short reserved2[2];
626 unsigned short frameControl;
627 unsigned short duration;
628 unsigned short address1[3];
629 unsigned short address2[3];
630 unsigned short address3[3];
631 unsigned short sequenceControl;
632 unsigned short address4[3];
633 #ifndef HERMES25 //;?just to be on the safe side of inherited but not comprehended code #ifdef HERMES2
634 unsigned short seems_to_be_unused_reserved3[5]; //;?
635 unsigned short seems_to_be_unused_reserved4; //;?
637 unsigned short HeaderDataLen;
639 WVLAN_RX_WMP_HDR, *PWVLAN_RX_WMP_HDR;
642 typedef struct wvlan_linktest_req_pdu
644 WVLAN_ETH_HDR ethHdr;
645 WVLAN_LLC_SNAP llcSnap;
649 WVLAN_LINKTEST_REQ_PDU, *PWVLAN_LINKTEST_REQ_PDU;
652 typedef struct wvlan_linktest_rsp_pdu
654 WVLAN_RX_WMP_HDR wmpRxHdr;
655 WVLAN_ETH_HDR ethHdr;
656 WVLAN_LLC_SNAP llcSnap;
660 WVLAN_LINKTEST_RSP_PDU, *PWVLAN_LINKTEST_RSP_PDU;
663 typedef struct _LINKTEST_RSP_STRCT
667 WVLAN_LINKTEST_RSP_PDU ltRsp;
672 typedef struct wvlan_wmp_rsp_pdu
674 WVLAN_RX_WMP_HDR wmpRxHdr;
675 WVLAN_ETH_HDR ethHdr;
676 WVLAN_LLC_SNAP llcSnap;
677 WVLAN_WMP_HDR wmpHdr;
679 WVLAN_WMP_RSP_PDU, *PWVLAN_WMP_RSP_PDU;
682 typedef struct _WMP_RSP_STRCT
686 WVLAN_WMP_RSP_PDU wmpRsp;
691 typedef struct _PROBE_RESP
693 // first part: 802.11
699 hcf_8 signal; // Moved signal here as signal/noise values were flipped
709 hcf_8 BSSID[6]; //! this is correct, right ?
718 // the information in the next 3 fields (DA/SA/LenType) is actually not filled in.
730 hcf_16 beaconInterval;
732 hcf_8 rawData[200]; //! <<< think about this number !
735 PROBE_RESP, *PPROBE_RESP;
738 typedef struct _ProbeResult
742 PROBE_RESP ProbeTable[MAX_NAPS];
746 /* Definitions used to parse capabilities out of the probe responses */
747 #define CAPABILITY_ESS 0x0001
748 #define CAPABILITY_IBSS 0x0002
749 #define CAPABILITY_PRIVACY 0x0010
751 /* Definitions used to parse the Information Elements out of probe responses */
752 #define DS_INFO_ELEM 0x03
753 #define GENERIC_INFO_ELEM 0xdd
754 #define WPA_MAX_IE_LEN 40
755 #define WPA_SELECTOR_LEN 4
756 #define WPA_OUI_TYPE { 0x00, 0x50, 0xf2, 1 }
757 #define WPA_VERSION 1
758 #define WPA_AUTH_KEY_MGMT_UNSPEC_802_1X { 0x00, 0x50, 0xf2, 1 }
759 #define WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X { 0x00, 0x50, 0xf2, 2 }
760 #define WPA_CIPHER_SUITE_NONE { 0x00, 0x50, 0xf2, 0 }
761 #define WPA_CIPHER_SUITE_WEP40 { 0x00, 0x50, 0xf2, 1 }
762 #define WPA_CIPHER_SUITE_TKIP { 0x00, 0x50, 0xf2, 2 }
763 #define WPA_CIPHER_SUITE_WRAP { 0x00, 0x50, 0xf2, 3 }
764 #define WPA_CIPHER_SUITE_CCMP { 0x00, 0x50, 0xf2, 4 }
765 #define WPA_CIPHER_SUITE_WEP104 { 0x00, 0x50, 0xf2, 5 }
767 typedef enum wvlan_drv_mode
769 WVLAN_DRV_MODE_NO_DOWNLOAD, /* this is the same as STA for Hermes 1 */
770 /* it is also only applicable for Hermes 1 */
775 WVLAN_DRV_MODE, *PWVLAN_DRV_MODE;
778 typedef enum wvlan_port_state
780 WVLAN_PORT_STATE_ENABLED,
781 WVLAN_PORT_STATE_DISABLED,
782 WVLAN_PORT_STATE_CONNECTED
784 WVLAN_PORT_STATE, *PWVLAN_PORT_STATE;
787 typedef enum wvlan_connect_state
789 WVLAN_CONNECT_STATE_CONNECTED,
790 WVLAN_CONNECT_STATE_DISCONNECTED
792 WVLAN_CONNECT_STATE, *PWVLAN_CONNECT_STATE;
795 typedef enum wvlan_pm_state
797 WVLAN_PM_STATE_DISABLED,
798 WVLAN_PM_STATE_ENHANCED,
799 WVLAN_PM_STATE_STANDARD
801 WVLAN_PM_STATE, *PWVLAN_PM_STATE;
804 typedef struct wvlan_frame
806 struct sk_buff *skb; /* sk_buff for frame. */
807 hcf_16 port; /* MAC port for the frame. */
808 hcf_16 len; /* Length of the frame. */
810 WVLAN_FRAME, *PWVLAN_FRAME;
813 typedef struct wvlan_lframe
815 struct list_head node; /* Node in the list */
816 WVLAN_FRAME frame; /* Frame. */
818 WVLAN_LFRAME, *PWVLAN_LFRAME;
822 #define DEFAULT_NUM_TX_FRAMES 48
823 #define TX_Q_LOW_WATER_MARK (DEFAULT_NUM_TX_FRAMES/3)
825 #define WVLAN_MAX_TX_QUEUES 1
830 typedef struct wvlan_wds_if
832 struct net_device *dev;
835 struct net_device_stats stats;
838 hcf_8 wdsAddress[ETH_ALEN];
839 } WVLAN_WDS_IF, *PWVLAN_WDS_IF;
845 #define NUM_RX_DESC 5
846 #define NUM_TX_DESC 5
848 typedef struct dma_strct
850 DESC_STRCT *tx_packet[NUM_TX_DESC];
851 DESC_STRCT *rx_packet[NUM_RX_DESC];
852 DESC_STRCT *rx_reclaim_desc, *tx_reclaim_desc; // Descriptors for host-reclaim purposes (see HCF)
853 int tx_rsc_ind; // DMA Tx resource indicator is maintained in the MSF, not in the HCF
854 int rx_rsc_ind; // Also added rx rsource indicator so that cleanup can be performed if alloc fails
859 /* Macros used in DMA support */
860 /* get bus address of {rx,tx}dma structure member, in little-endian byte order */
861 #define WL_DMA_BUS_ADDR_LE(str, i, mem) \
862 cpu_to_le32(str##_dma_addr[(i)] + ((hcf_8 *)&str[(i)]->mem - (hcf_8 *)str[(i)]))
870 struct pcmcia_device *link;
874 struct net_device *dev;
875 // struct net_device *dev_next;
877 struct tasklet_struct task;
878 struct net_device_stats stats;
882 struct iw_statistics wstats;
884 // u_char spy_address[IW_MAX_SPY][ETH_ALEN];
885 // struct iw_quality spy_stat[IW_MAX_SPY];
886 struct iw_spy_data spy_data;
887 struct iw_public_data wireless_data;
888 #endif // WIRELESS_EXT
892 //;? struct timer_list timer_oor;
893 //;? hcf_16 timer_oor_cnt;
894 u_long wlags49_type; //controls output in /proc/wlags49
899 int firmware_present;
901 CFG_DRV_INFO_STRCT driverInfo;
902 CFG_IDENTITY_STRCT driverIdentity;
903 CFG_FW_IDENTITY_STRCT StationIdentity;
904 CFG_PRI_IDENTITY_STRCT PrimaryIdentity;
905 CFG_PRI_IDENTITY_STRCT NICIdentity;
909 hcf_16 maxPort; /* 0 for STA, 6 for AP */
911 /* Elements used for async notification from hardware */
912 RID_LOG_STRCT RidList[10];
914 PROBE_RESP ProbeResp;
915 ASSOC_STATUS_STRCT assoc_stat;
916 SECURITY_STATUS_STRCT sec_stat;
918 u_char lookAheadBuf[WVLAN_MAX_LOOKAHEAD];
920 hcf_8 PortType; // 1 - 3 (1 [Normal] | 3 [AdHoc])
921 hcf_16 Channel; // 0 - 14 (0)
922 hcf_16 TxRateControl[2];
923 hcf_8 DistanceBetweenAPs; // 1 - 3 (1)
924 hcf_16 RTSThreshold; // 0 - 2347 (2347)
925 hcf_16 PMEnabled; // 0 - 2, 8001 - 8002 (0)
926 hcf_8 MicrowaveRobustness;// 0 - 1 (0)
927 hcf_8 CreateIBSS; // 0 - 1 (0)
928 hcf_8 MulticastReceive; // 0 - 1 (1)
929 hcf_16 MaxSleepDuration; // 0 - 65535 (100)
930 hcf_8 MACAddress[ETH_ALEN];
931 char NetworkName[HCF_MAX_NAME_LEN+1];
932 char StationName[HCF_MAX_NAME_LEN+1];
933 hcf_8 EnableEncryption; // 0 - 1 (0)
934 char Key1[MAX_KEY_LEN+1];
935 char Key2[MAX_KEY_LEN+1];
936 char Key3[MAX_KEY_LEN+1];
937 char Key4[MAX_KEY_LEN+1];
938 hcf_8 TransmitKeyID; // 1 - 4 (1)
939 CFG_DEFAULT_KEYS_STRCT DefaultKeys;
940 u_char mailbox[MB_SIZE];
941 char szEncryption[MAX_ENC_LEN];
946 hcf_16 holdoverDuration;
947 hcf_16 MulticastRate[2];
949 hcf_16 authentication; // is this AP specific?
950 hcf_16 promiscuousMode;
951 WVLAN_DRV_MODE DownloadFirmware; // 0 - 2 (0 [None] | 1 [STA] | 2 [AP])
953 char fw_image_filename[MAX_LINE_SIZE+1];
955 hcf_16 AuthKeyMgmtSuite;
957 hcf_16 loadBalancing;
958 hcf_16 mediumDistribution;
960 //hcf_16 shortRetryLimit;
961 //hcf_16 longRetryLimit;
964 hcf_16 connectionControl;
965 //hcf_16 probeDataRates[2];
966 hcf_16 ownBeaconInterval;
970 WVLAN_LFRAME txList[DEFAULT_NUM_TX_FRAMES];
971 struct list_head txFree;
972 struct list_head txQ[WVLAN_MAX_TX_QUEUES];
978 WVLAN_PORT_STATE portState;
980 ScanResult scan_results;
981 ProbeResult probe_results;
989 hcf_8 DTIMPeriod; // 1 - 255 (1)
990 hcf_16 multicastPMBuffering;
991 hcf_8 RejectAny; // 0 - 1 (0)
992 hcf_8 ExcludeUnencrypted; // 0 - 1 (1)
993 hcf_16 intraBSSRelay;
995 WVLAN_WDS_IF wds_port[NUM_WDS_PORTS];
999 #ifdef HAVE_NETDEV_PRIV
1000 #define wl_priv(dev) ((struct wl_private *) netdev_priv(dev))
1002 extern inline struct wl_private *wl_priv(struct net_device *dev)
1008 /********************************************************************/
1009 /* Locking and synchronization functions */
1010 /********************************************************************/
1012 /* These functions *must* be inline or they will break horribly on
1013 * SPARC, due to its weird semantics for save/restore flags. extern
1014 * inline should prevent the kernel from linking or module from
1015 * loading if they are not inlined. */
1016 extern inline void wl_lock(struct wl_private *lp,
1017 unsigned long *flags)
1019 spin_lock_irqsave(&lp->slock, *flags);
1022 extern inline void wl_unlock(struct wl_private *lp,
1023 unsigned long *flags)
1025 spin_unlock_irqrestore(&lp->slock, *flags);
1028 /********************************************************************/
1029 /* Interrupt enable disable functions */
1030 /********************************************************************/
1032 extern inline void wl_act_int_on(struct wl_private *lp)
1035 * Only do something when the driver is handling
1036 * interrupts. Handling starts at wl_open and
1037 * ends at wl_close when not in RTS mode
1039 if(lp->is_handling_int == WL_HANDLING_INT) {
1040 hcf_action( &lp->hcfCtx, HCF_ACT_INT_ON );
1044 extern inline void wl_act_int_off(struct wl_private *lp)
1047 * Only do something when the driver is handling
1048 * interrupts. Handling starts at wl_open and
1049 * ends at wl_close when not in RTS mode
1051 if(lp->is_handling_int == WL_HANDLING_INT) {
1052 hcf_action( &lp->hcfCtx, HCF_ACT_INT_OFF );
1056 #endif // __WAVELAN2_H__