[PATCH] libertas: remove incorrect vi modelines
[linux-2.6/x86.git] / drivers / net / wireless / libertas / scan.h
blob486bdc4f09357faced89a4640615bae690b6646e
1 /**
2 * Interface for the wlan network scan routines
4 * Driver interface functions and type declarations for the scan module
5 * implemented in wlan_scan.c.
6 */
7 #ifndef _WLAN_SCAN_H
8 #define _WLAN_SCAN_H
10 #include <net/ieee80211.h>
11 #include "hostcmd.h"
13 /**
14 * @brief Maximum number of channels that can be sent in a setuserscan ioctl
16 * @sa wlan_ioctl_user_scan_cfg
18 #define WLAN_IOCTL_USER_SCAN_CHAN_MAX 50
20 //! Infrastructure BSS scan type in wlan_scan_cmd_config
21 #define WLAN_SCAN_BSS_TYPE_BSS 1
23 //! Adhoc BSS scan type in wlan_scan_cmd_config
24 #define WLAN_SCAN_BSS_TYPE_IBSS 2
26 //! Adhoc or Infrastructure BSS scan type in wlan_scan_cmd_config, no filter
27 #define WLAN_SCAN_BSS_TYPE_ANY 3
29 /**
30 * @brief Structure used internally in the wlan driver to configure a scan.
32 * Sent to the command processing module to configure the firmware
33 * scan command prepared by libertas_cmd_80211_scan.
35 * @sa wlan_scan_networks
38 struct wlan_scan_cmd_config {
39 /**
40 * @brief BSS type to be sent in the firmware command
42 * Field can be used to restrict the types of networks returned in the
43 * scan. valid settings are:
45 * - WLAN_SCAN_BSS_TYPE_BSS (infrastructure)
46 * - WLAN_SCAN_BSS_TYPE_IBSS (adhoc)
47 * - WLAN_SCAN_BSS_TYPE_ANY (unrestricted, adhoc and infrastructure)
49 u8 bsstype;
51 /**
52 * @brief Specific BSSID used to filter scan results in the firmware
54 u8 specificBSSID[ETH_ALEN];
56 /**
57 * @brief length of TLVs sent in command starting at tlvBuffer
59 int tlvbufferlen;
61 /**
62 * @brief SSID TLV(s) and ChanList TLVs to be sent in the firmware command
64 * @sa TLV_TYPE_CHANLIST, mrvlietypes_chanlistparamset_t
65 * @sa TLV_TYPE_SSID, mrvlietypes_ssidparamset_t
67 u8 tlvbuffer[1]; //!< SSID TLV(s) and ChanList TLVs are stored here
70 /**
71 * @brief IOCTL channel sub-structure sent in wlan_ioctl_user_scan_cfg
73 * Multiple instances of this structure are included in the IOCTL command
74 * to configure a instance of a scan on the specific channel.
76 struct wlan_ioctl_user_scan_chan {
77 u8 channumber; //!< channel Number to scan
78 u8 radiotype; //!< Radio type: 'B/G' band = 0, 'A' band = 1
79 u8 scantype; //!< Scan type: Active = 0, Passive = 1
80 u16 scantime; //!< Scan duration in milliseconds; if 0 default used
83 /**
84 * @brief IOCTL input structure to configure an immediate scan cmd to firmware
86 * Used in the setuserscan (WLAN_SET_USER_SCAN) private ioctl. Specifies
87 * a number of parameters to be used in general for the scan as well
88 * as a channel list (wlan_ioctl_user_scan_chan) for each scan period
89 * desired.
91 * @sa libertas_set_user_scan_ioctl
93 struct wlan_ioctl_user_scan_cfg {
95 /**
96 * @brief Flag set to keep the previous scan table intact
98 * If set, the scan results will accumulate, replacing any previous
99 * matched entries for a BSS with the new scan data
101 u8 keeppreviousscan; //!< Do not erase the existing scan results
104 * @brief BSS type to be sent in the firmware command
106 * Field can be used to restrict the types of networks returned in the
107 * scan. valid settings are:
109 * - WLAN_SCAN_BSS_TYPE_BSS (infrastructure)
110 * - WLAN_SCAN_BSS_TYPE_IBSS (adhoc)
111 * - WLAN_SCAN_BSS_TYPE_ANY (unrestricted, adhoc and infrastructure)
113 u8 bsstype;
116 * @brief Configure the number of probe requests for active chan scans
118 u8 numprobes;
121 * @brief BSSID filter sent in the firmware command to limit the results
123 u8 specificBSSID[ETH_ALEN];
126 * @brief SSID filter sent in the firmware command to limit the results
128 char specificSSID[IW_ESSID_MAX_SIZE + 1];
131 * @brief Variable number (fixed maximum) of channels to scan up
133 struct wlan_ioctl_user_scan_chan chanlist[WLAN_IOCTL_USER_SCAN_CHAN_MAX];
137 * @brief Structure used to store information for each beacon/probe response
139 struct bss_descriptor {
140 u8 macaddress[ETH_ALEN];
142 struct WLAN_802_11_SSID ssid;
144 /* WEP encryption requirement */
145 u32 privacy;
147 /* receive signal strength in dBm */
148 long rssi;
150 u32 channel;
152 u16 beaconperiod;
154 u32 atimwindow;
156 enum WLAN_802_11_NETWORK_INFRASTRUCTURE inframode;
157 u8 libertas_supported_rates[WLAN_SUPPORTED_RATES];
159 int extra_ie;
161 u8 timestamp[8]; //!< TSF value included in the beacon/probe response
162 union ieeetypes_phyparamset phyparamset;
163 union IEEEtypes_ssparamset ssparamset;
164 struct ieeetypes_capinfo cap;
165 u8 datarates[WLAN_SUPPORTED_RATES];
167 __le64 networktsf; //!< TSF timestamp from the current firmware TSF
169 struct ieeetypes_countryinfofullset countryinfo;
171 u8 wpa_ie[MAX_WPA_IE_LEN];
172 size_t wpa_ie_len;
173 u8 rsn_ie[MAX_WPA_IE_LEN];
174 size_t rsn_ie_len;
177 extern int libertas_SSID_cmp(struct WLAN_802_11_SSID *ssid1,
178 struct WLAN_802_11_SSID *ssid2);
179 extern int libertas_find_SSID_in_list(wlan_adapter * adapter, struct WLAN_802_11_SSID *ssid,
180 u8 * bssid, int mode);
181 int libertas_find_best_SSID_in_list(wlan_adapter * adapter, enum WLAN_802_11_NETWORK_INFRASTRUCTURE mode);
182 extern int libertas_find_BSSID_in_list(wlan_adapter * adapter, u8 * bssid, int mode);
184 int libertas_find_best_network_SSID(wlan_private * priv,
185 struct WLAN_802_11_SSID *pSSID,
186 enum WLAN_802_11_NETWORK_INFRASTRUCTURE preferred_mode,
187 enum WLAN_802_11_NETWORK_INFRASTRUCTURE *out_mode);
189 extern int libertas_send_specific_SSID_scan(wlan_private * priv,
190 struct WLAN_802_11_SSID *prequestedssid,
191 u8 keeppreviousscan);
192 extern int libertas_send_specific_BSSID_scan(wlan_private * priv,
193 u8 * bssid, u8 keeppreviousscan);
195 extern int libertas_cmd_80211_scan(wlan_private * priv,
196 struct cmd_ds_command *cmd,
197 void *pdata_buf);
199 extern int libertas_ret_80211_scan(wlan_private * priv,
200 struct cmd_ds_command *resp);
202 int wlan_scan_networks(wlan_private * priv,
203 const struct wlan_ioctl_user_scan_cfg * puserscanin);
205 struct ifreq;
207 struct iw_point;
208 struct iw_param;
209 struct iw_request_info;
210 extern int libertas_get_scan(struct net_device *dev, struct iw_request_info *info,
211 struct iw_point *dwrq, char *extra);
212 extern int libertas_set_scan(struct net_device *dev, struct iw_request_info *info,
213 struct iw_param *vwrq, char *extra);
215 #endif /* _WLAN_SCAN_H */