xref: /openbmc/linux/drivers/net/wireless/ti/wlcore/scan.h (revision 05bcf503)
1 /*
2  * This file is part of wl1271
3  *
4  * Copyright (C) 2009-2010 Nokia Corporation
5  *
6  * Contact: Luciano Coelho <luciano.coelho@nokia.com>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * version 2 as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20  * 02110-1301 USA
21  *
22  */
23 
24 #ifndef __SCAN_H__
25 #define __SCAN_H__
26 
27 #include "wlcore.h"
28 
29 int wl1271_scan(struct wl1271 *wl, struct ieee80211_vif *vif,
30 		const u8 *ssid, size_t ssid_len,
31 		struct cfg80211_scan_request *req);
32 int wl1271_scan_stop(struct wl1271 *wl);
33 int wl1271_scan_build_probe_req(struct wl1271 *wl,
34 				const u8 *ssid, size_t ssid_len,
35 				const u8 *ie, size_t ie_len, u8 band);
36 void wl1271_scan_stm(struct wl1271 *wl, struct ieee80211_vif *vif);
37 void wl1271_scan_complete_work(struct work_struct *work);
38 int wl1271_scan_sched_scan_config(struct wl1271 *wl,
39 				     struct wl12xx_vif *wlvif,
40 				     struct cfg80211_sched_scan_request *req,
41 				     struct ieee80211_sched_scan_ies *ies);
42 int wl1271_scan_sched_scan_start(struct wl1271 *wl, struct wl12xx_vif *wlvif);
43 void wl1271_scan_sched_scan_stop(struct wl1271 *wl,  struct wl12xx_vif *wlvif);
44 void wl1271_scan_sched_scan_results(struct wl1271 *wl);
45 
46 #define WL1271_SCAN_MAX_CHANNELS       24
47 #define WL1271_SCAN_DEFAULT_TAG        1
48 #define WL1271_SCAN_CURRENT_TX_PWR     0
49 #define WL1271_SCAN_OPT_ACTIVE         0
50 #define WL1271_SCAN_OPT_PASSIVE	       1
51 #define WL1271_SCAN_OPT_SPLIT_SCAN     2
52 #define WL1271_SCAN_OPT_PRIORITY_HIGH  4
53 /* scan even if we fail to enter psm */
54 #define WL1271_SCAN_OPT_FORCE          8
55 #define WL1271_SCAN_BAND_2_4_GHZ 0
56 #define WL1271_SCAN_BAND_5_GHZ 1
57 
58 #define WL1271_SCAN_TIMEOUT    30000 /* msec */
59 
60 enum {
61 	WL1271_SCAN_STATE_IDLE,
62 	WL1271_SCAN_STATE_2GHZ_ACTIVE,
63 	WL1271_SCAN_STATE_2GHZ_PASSIVE,
64 	WL1271_SCAN_STATE_5GHZ_ACTIVE,
65 	WL1271_SCAN_STATE_5GHZ_PASSIVE,
66 	WL1271_SCAN_STATE_DONE
67 };
68 
69 struct basic_scan_params {
70 	/* Scan option flags (WL1271_SCAN_OPT_*) */
71 	__le16 scan_options;
72 	u8 role_id;
73 	/* Number of scan channels in the list (maximum 30) */
74 	u8 n_ch;
75 	/* This field indicates the number of probe requests to send
76 	   per channel for an active scan */
77 	u8 n_probe_reqs;
78 	u8 tid_trigger;
79 	u8 ssid_len;
80 	u8 use_ssid_list;
81 
82 	/* Rate bit field for sending the probes */
83 	__le32 tx_rate;
84 
85 	u8 ssid[IEEE80211_MAX_SSID_LEN];
86 	/* Band to scan */
87 	u8 band;
88 
89 	u8 scan_tag;
90 	u8 padding2[2];
91 } __packed;
92 
93 struct basic_scan_channel_params {
94 	/* Duration in TU to wait for frames on a channel for active scan */
95 	__le32 min_duration;
96 	__le32 max_duration;
97 	__le32 bssid_lsb;
98 	__le16 bssid_msb;
99 	u8 early_termination;
100 	u8 tx_power_att;
101 	u8 channel;
102 	/* FW internal use only! */
103 	u8 dfs_candidate;
104 	u8 activity_detected;
105 	u8 pad;
106 } __packed;
107 
108 struct wl1271_cmd_scan {
109 	struct wl1271_cmd_header header;
110 
111 	struct basic_scan_params params;
112 	struct basic_scan_channel_params channels[WL1271_SCAN_MAX_CHANNELS];
113 
114 	/* src mac address */
115 	u8 addr[ETH_ALEN];
116 	u8 padding[2];
117 } __packed;
118 
119 struct wl1271_cmd_trigger_scan_to {
120 	struct wl1271_cmd_header header;
121 
122 	__le32 timeout;
123 } __packed;
124 
125 #define MAX_CHANNELS_2GHZ	14
126 #define MAX_CHANNELS_5GHZ	23
127 #define MAX_CHANNELS_4GHZ	4
128 
129 #define SCAN_MAX_CYCLE_INTERVALS 16
130 #define SCAN_MAX_BANDS 3
131 
132 enum {
133 	SCAN_SSID_FILTER_ANY      = 0,
134 	SCAN_SSID_FILTER_SPECIFIC = 1,
135 	SCAN_SSID_FILTER_LIST     = 2,
136 	SCAN_SSID_FILTER_DISABLED = 3
137 };
138 
139 enum {
140 	SCAN_BSS_TYPE_INDEPENDENT,
141 	SCAN_BSS_TYPE_INFRASTRUCTURE,
142 	SCAN_BSS_TYPE_ANY,
143 };
144 
145 #define SCAN_CHANNEL_FLAGS_DFS		BIT(0) /* channel is passive until an
146 						  activity is detected on it */
147 #define SCAN_CHANNEL_FLAGS_DFS_ENABLED	BIT(1)
148 
149 struct conn_scan_ch_params {
150 	__le16 min_duration;
151 	__le16 max_duration;
152 	__le16 passive_duration;
153 
154 	u8  channel;
155 	u8  tx_power_att;
156 
157 	/* bit 0: DFS channel; bit 1: DFS enabled */
158 	u8  flags;
159 
160 	u8  padding[3];
161 } __packed;
162 
163 struct wl1271_cmd_sched_scan_config {
164 	struct wl1271_cmd_header header;
165 
166 	__le32 intervals[SCAN_MAX_CYCLE_INTERVALS];
167 
168 	s8 rssi_threshold; /* for filtering (in dBm) */
169 	s8 snr_threshold;  /* for filtering (in dB) */
170 
171 	u8 cycles;       /* maximum number of scan cycles */
172 	u8 report_after; /* report when this number of results are received */
173 	u8 terminate;    /* stop scanning after reporting */
174 
175 	u8 tag;
176 	u8 bss_type; /* for filtering */
177 	u8 filter_type;
178 
179 	u8 ssid_len;     /* For SCAN_SSID_FILTER_SPECIFIC */
180 	u8 ssid[IEEE80211_MAX_SSID_LEN];
181 
182 	u8 n_probe_reqs; /* Number of probes requests per channel */
183 
184 	u8 passive[SCAN_MAX_BANDS];
185 	u8 active[SCAN_MAX_BANDS];
186 
187 	u8 dfs;
188 
189 	u8 n_pactive_ch; /* number of pactive (passive until fw detects energy)
190 			    channels in BG band */
191 	u8 role_id;
192 	u8 padding[1];
193 
194 	struct conn_scan_ch_params channels_2[MAX_CHANNELS_2GHZ];
195 	struct conn_scan_ch_params channels_5[MAX_CHANNELS_5GHZ];
196 	struct conn_scan_ch_params channels_4[MAX_CHANNELS_4GHZ];
197 } __packed;
198 
199 
200 #define SCHED_SCAN_MAX_SSIDS 16
201 
202 enum {
203 	SCAN_SSID_TYPE_PUBLIC = 0,
204 	SCAN_SSID_TYPE_HIDDEN = 1,
205 };
206 
207 struct wl1271_ssid {
208 	u8 type;
209 	u8 len;
210 	u8 ssid[IEEE80211_MAX_SSID_LEN];
211 	/* u8 padding[2]; */
212 } __packed;
213 
214 struct wl1271_cmd_sched_scan_ssid_list {
215 	struct wl1271_cmd_header header;
216 
217 	u8 n_ssids;
218 	struct wl1271_ssid ssids[SCHED_SCAN_MAX_SSIDS];
219 	u8 role_id;
220 	u8 padding[2];
221 } __packed;
222 
223 struct wl1271_cmd_sched_scan_start {
224 	struct wl1271_cmd_header header;
225 
226 	u8 tag;
227 	u8 role_id;
228 	u8 padding[2];
229 } __packed;
230 
231 struct wl1271_cmd_sched_scan_stop {
232 	struct wl1271_cmd_header header;
233 
234 	u8 tag;
235 	u8 role_id;
236 	u8 padding[2];
237 } __packed;
238 
239 
240 #endif /* __WL1271_SCAN_H__ */
241