1 /* $OpenBSD: if_iwm.c,v 1.39 2015/03/23 00:35:19 jsg Exp $ */
2
3 /*
4 * Copyright (c) 2014 genua mbh <info@genua.de>
5 * Copyright (c) 2014 Fixup Software Ltd.
6 *
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 */
19
20 /*-
21 * Based on BSD-licensed source modules in the Linux iwlwifi driver,
22 * which were used as the reference documentation for this implementation.
23 *
24 * Driver version we are currently based off of is
25 * Linux 3.14.3 (tag id a2df521e42b1d9a23f620ac79dbfe8655a8391dd)
26 *
27 ***********************************************************************
28 *
29 * This file is provided under a dual BSD/GPLv2 license. When using or
30 * redistributing this file, you may do so under either license.
31 *
32 * GPL LICENSE SUMMARY
33 *
34 * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved.
35 *
36 * This program is free software; you can redistribute it and/or modify
37 * it under the terms of version 2 of the GNU General Public License as
38 * published by the Free Software Foundation.
39 *
40 * This program is distributed in the hope that it will be useful, but
41 * WITHOUT ANY WARRANTY; without even the implied warranty of
42 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
43 * General Public License for more details.
44 *
45 * You should have received a copy of the GNU General Public License
46 * along with this program; if not, write to the Free Software
47 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
48 * USA
49 *
50 * The full GNU General Public License is included in this distribution
51 * in the file called COPYING.
52 *
53 * Contact Information:
54 * Intel Linux Wireless <ilw@linux.intel.com>
55 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
56 *
57 *
58 * BSD LICENSE
59 *
60 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved.
61 * All rights reserved.
62 *
63 * Redistribution and use in source and binary forms, with or without
64 * modification, are permitted provided that the following conditions
65 * are met:
66 *
67 * * Redistributions of source code must retain the above copyright
68 * notice, this list of conditions and the following disclaimer.
69 * * Redistributions in binary form must reproduce the above copyright
70 * notice, this list of conditions and the following disclaimer in
71 * the documentation and/or other materials provided with the
72 * distribution.
73 * * Neither the name Intel Corporation nor the names of its
74 * contributors may be used to endorse or promote products derived
75 * from this software without specific prior written permission.
76 *
77 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
78 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
79 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
80 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
81 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
82 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
83 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
84 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
85 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
86 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
87 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
88 */
89
90 /*-
91 * Copyright (c) 2007-2010 Damien Bergamini <damien.bergamini@free.fr>
92 *
93 * Permission to use, copy, modify, and distribute this software for any
94 * purpose with or without fee is hereby granted, provided that the above
95 * copyright notice and this permission notice appear in all copies.
96 *
97 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
98 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
99 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
100 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
101 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
102 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
103 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
104 */
105 #include <sys/cdefs.h>
106 #include "opt_wlan.h"
107 #include "opt_iwm.h"
108
109 #include <sys/param.h>
110 #include <sys/bus.h>
111 #include <sys/conf.h>
112 #include <sys/endian.h>
113 #include <sys/firmware.h>
114 #include <sys/kernel.h>
115 #include <sys/malloc.h>
116 #include <sys/mbuf.h>
117 #include <sys/mutex.h>
118 #include <sys/module.h>
119 #include <sys/proc.h>
120 #include <sys/rman.h>
121 #include <sys/socket.h>
122 #include <sys/sockio.h>
123 #include <sys/sysctl.h>
124 #include <sys/linker.h>
125
126 #include <machine/bus.h>
127 #include <machine/endian.h>
128 #include <machine/resource.h>
129
130 #include <dev/pci/pcivar.h>
131 #include <dev/pci/pcireg.h>
132
133 #include <net/bpf.h>
134
135 #include <net/if.h>
136 #include <net/if_var.h>
137 #include <net/if_arp.h>
138 #include <net/if_dl.h>
139 #include <net/if_media.h>
140 #include <net/if_types.h>
141
142 #include <netinet/in.h>
143 #include <netinet/in_systm.h>
144 #include <netinet/if_ether.h>
145 #include <netinet/ip.h>
146
147 #include <net80211/ieee80211_var.h>
148 #include <net80211/ieee80211_regdomain.h>
149 #include <net80211/ieee80211_ratectl.h>
150 #include <net80211/ieee80211_radiotap.h>
151
152 #include <dev/iwm/if_iwmreg.h>
153 #include <dev/iwm/if_iwmvar.h>
154 #include <dev/iwm/if_iwm_debug.h>
155 #include <dev/iwm/if_iwm_util.h>
156 #include <dev/iwm/if_iwm_notif_wait.h>
157 #include <dev/iwm/if_iwm_pcie_trans.h>
158 #include <dev/iwm/if_iwm_time_event.h>
159
160 #define TU_TO_HZ(tu) (((uint64_t)(tu) * 1024 * hz) / 1000000)
161
162 static void
iwm_te_clear_data(struct iwm_softc * sc)163 iwm_te_clear_data(struct iwm_softc *sc)
164 {
165 sc->sc_time_event_uid = 0;
166 sc->sc_time_event_duration = 0;
167 sc->sc_time_event_end_ticks = 0;
168 sc->sc_flags &= ~IWM_FLAG_TE_ACTIVE;
169 }
170
171 /*
172 * Handles a FW notification for an event that is known to the driver.
173 *
174 * @mvm: the mvm component
175 * @te_data: the time event data
176 * @notif: the notification data corresponding the time event data.
177 */
178 static void
iwm_te_handle_notif(struct iwm_softc * sc,struct iwm_time_event_notif * notif)179 iwm_te_handle_notif(struct iwm_softc *sc,
180 struct iwm_time_event_notif *notif)
181 {
182 IWM_DPRINTF(sc, IWM_DEBUG_TE,
183 "Handle time event notif - UID = 0x%x action %d\n",
184 le32toh(notif->unique_id),
185 le32toh(notif->action));
186
187 if (!le32toh(notif->status)) {
188 const char *msg;
189
190 if (notif->action & htole32(IWM_TE_V2_NOTIF_HOST_EVENT_START))
191 msg = "Time Event start notification failure";
192 else
193 msg = "Time Event end notification failure";
194
195 IWM_DPRINTF(sc, IWM_DEBUG_TE, "%s\n", msg);
196 }
197
198 if (le32toh(notif->action) & IWM_TE_V2_NOTIF_HOST_EVENT_END) {
199 IWM_DPRINTF(sc, IWM_DEBUG_TE,
200 "TE ended - current time %d, estimated end %d\n",
201 ticks, sc->sc_time_event_end_ticks);
202
203 iwm_te_clear_data(sc);
204 } else if (le32toh(notif->action) & IWM_TE_V2_NOTIF_HOST_EVENT_START) {
205 sc->sc_time_event_end_ticks =
206 ticks + TU_TO_HZ(sc->sc_time_event_duration);
207 } else {
208 device_printf(sc->sc_dev, "Got TE with unknown action\n");
209 }
210 }
211
212 /*
213 * The Rx handler for time event notifications
214 */
215 void
iwm_rx_time_event_notif(struct iwm_softc * sc,struct iwm_rx_packet * pkt)216 iwm_rx_time_event_notif(struct iwm_softc *sc, struct iwm_rx_packet *pkt)
217 {
218 struct iwm_time_event_notif *notif = (void *)pkt->data;
219
220 IWM_DPRINTF(sc, IWM_DEBUG_TE,
221 "Time event notification - UID = 0x%x action %d\n",
222 le32toh(notif->unique_id),
223 le32toh(notif->action));
224
225 iwm_te_handle_notif(sc, notif);
226 }
227
228 static int
iwm_te_notif(struct iwm_softc * sc,struct iwm_rx_packet * pkt,void * data)229 iwm_te_notif(struct iwm_softc *sc, struct iwm_rx_packet *pkt,
230 void *data)
231 {
232 struct iwm_time_event_notif *resp;
233 int resp_len = iwm_rx_packet_payload_len(pkt);
234
235 if (pkt->hdr.code != IWM_TIME_EVENT_NOTIFICATION ||
236 resp_len != sizeof(*resp)) {
237 IWM_DPRINTF(sc, IWM_DEBUG_TE,
238 "Invalid TIME_EVENT_NOTIFICATION response\n");
239 return 1;
240 }
241
242 resp = (void *)pkt->data;
243
244 /* te_data->uid is already set in the TIME_EVENT_CMD response */
245 if (le32toh(resp->unique_id) != sc->sc_time_event_uid)
246 return false;
247
248 IWM_DPRINTF(sc, IWM_DEBUG_TE,
249 "TIME_EVENT_NOTIFICATION response - UID = 0x%x\n",
250 sc->sc_time_event_uid);
251 if (!resp->status) {
252 IWM_DPRINTF(sc, IWM_DEBUG_TE,
253 "TIME_EVENT_NOTIFICATION received but not executed\n");
254 }
255
256 return 1;
257 }
258
259 static int
iwm_time_event_response(struct iwm_softc * sc,struct iwm_rx_packet * pkt,void * data)260 iwm_time_event_response(struct iwm_softc *sc, struct iwm_rx_packet *pkt,
261 void *data)
262 {
263 struct iwm_time_event_resp *resp;
264 int resp_len = iwm_rx_packet_payload_len(pkt);
265
266 if (pkt->hdr.code != IWM_TIME_EVENT_CMD ||
267 resp_len != sizeof(*resp)) {
268 IWM_DPRINTF(sc, IWM_DEBUG_TE,
269 "Invalid TIME_EVENT_CMD response\n");
270 return 1;
271 }
272
273 resp = (void *)pkt->data;
274
275 /* we should never get a response to another TIME_EVENT_CMD here */
276 if (le32toh(resp->id) != IWM_TE_BSS_STA_AGGRESSIVE_ASSOC) {
277 IWM_DPRINTF(sc, IWM_DEBUG_TE,
278 "Got TIME_EVENT_CMD response with wrong id: %d\n",
279 le32toh(resp->id));
280 return 0;
281 }
282
283 sc->sc_time_event_uid = le32toh(resp->unique_id);
284 IWM_DPRINTF(sc, IWM_DEBUG_TE,
285 "TIME_EVENT_CMD response - UID = 0x%x\n", sc->sc_time_event_uid);
286 return 1;
287 }
288
289
290 /* XXX Use the te_data function argument properly, like in iwlwifi's code. */
291
292 static int
iwm_time_event_send_add(struct iwm_softc * sc,struct iwm_vap * ivp,void * te_data,struct iwm_time_event_cmd * te_cmd)293 iwm_time_event_send_add(struct iwm_softc *sc, struct iwm_vap *ivp,
294 void *te_data, struct iwm_time_event_cmd *te_cmd)
295 {
296 static const uint16_t time_event_response[] = { IWM_TIME_EVENT_CMD };
297 struct iwm_notification_wait wait_time_event;
298 int ret;
299
300 IWM_DPRINTF(sc, IWM_DEBUG_TE,
301 "Add new TE, duration %d TU\n", le32toh(te_cmd->duration));
302
303 sc->sc_time_event_duration = le32toh(te_cmd->duration);
304
305 /*
306 * Use a notification wait, which really just processes the
307 * command response and doesn't wait for anything, in order
308 * to be able to process the response and get the UID inside
309 * the RX path. Using CMD_WANT_SKB doesn't work because it
310 * stores the buffer and then wakes up this thread, by which
311 * time another notification (that the time event started)
312 * might already be processed unsuccessfully.
313 */
314 iwm_init_notification_wait(sc->sc_notif_wait, &wait_time_event,
315 time_event_response,
316 nitems(time_event_response),
317 iwm_time_event_response, /*te_data*/NULL);
318
319 ret = iwm_send_cmd_pdu(sc, IWM_TIME_EVENT_CMD, 0, sizeof(*te_cmd),
320 te_cmd);
321 if (ret) {
322 IWM_DPRINTF(sc, IWM_DEBUG_TE,
323 "%s: Couldn't send IWM_TIME_EVENT_CMD: %d\n",
324 __func__, ret);
325 iwm_remove_notification(sc->sc_notif_wait, &wait_time_event);
326 return ret;
327 }
328
329 /* No need to wait for anything, so just pass 1 (0 isn't valid) */
330 IWM_UNLOCK(sc);
331 ret = iwm_wait_notification(sc->sc_notif_wait, &wait_time_event, 1);
332 IWM_LOCK(sc);
333 /* should never fail */
334 if (ret) {
335 IWM_DPRINTF(sc, IWM_DEBUG_TE,
336 "%s: Failed to get response for IWM_TIME_EVENT_CMD: %d\n",
337 __func__, ret);
338 }
339
340 return ret;
341 }
342
343 void
iwm_protect_session(struct iwm_softc * sc,struct iwm_vap * ivp,uint32_t duration,uint32_t max_delay,boolean_t wait_for_notif)344 iwm_protect_session(struct iwm_softc *sc, struct iwm_vap *ivp,
345 uint32_t duration, uint32_t max_delay, boolean_t wait_for_notif)
346 {
347 const uint16_t te_notif_response[] = { IWM_TIME_EVENT_NOTIFICATION };
348 struct iwm_notification_wait wait_te_notif;
349 struct iwm_time_event_cmd time_cmd = {};
350
351 /* Do nothing if a time event is already scheduled. */
352 if (sc->sc_flags & IWM_FLAG_TE_ACTIVE)
353 return;
354
355 time_cmd.action = htole32(IWM_FW_CTXT_ACTION_ADD);
356 time_cmd.id_and_color =
357 htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color));
358 time_cmd.id = htole32(IWM_TE_BSS_STA_AGGRESSIVE_ASSOC);
359
360 time_cmd.apply_time = htole32(0);
361
362 time_cmd.max_frags = IWM_TE_V2_FRAG_NONE;
363 time_cmd.max_delay = htole32(max_delay);
364 /* TODO: why do we need to interval = bi if it is not periodic? */
365 time_cmd.interval = htole32(1);
366 time_cmd.duration = htole32(duration);
367 time_cmd.repeat = 1;
368 time_cmd.policy
369 = htole16(IWM_TE_V2_NOTIF_HOST_EVENT_START |
370 IWM_TE_V2_NOTIF_HOST_EVENT_END |
371 IWM_T2_V2_START_IMMEDIATELY);
372
373 if (!wait_for_notif) {
374 iwm_time_event_send_add(sc, ivp, /*te_data*/NULL, &time_cmd);
375 DELAY(100);
376 sc->sc_flags |= IWM_FLAG_TE_ACTIVE;
377 return;
378 }
379
380 /*
381 * Create notification_wait for the TIME_EVENT_NOTIFICATION to use
382 * right after we send the time event
383 */
384 iwm_init_notification_wait(sc->sc_notif_wait, &wait_te_notif,
385 te_notif_response, nitems(te_notif_response),
386 iwm_te_notif, /*te_data*/NULL);
387
388 /* If TE was sent OK - wait for the notification that started */
389 if (iwm_time_event_send_add(sc, ivp, /*te_data*/NULL, &time_cmd)) {
390 IWM_DPRINTF(sc, IWM_DEBUG_TE,
391 "%s: Failed to add TE to protect session\n", __func__);
392 iwm_remove_notification(sc->sc_notif_wait, &wait_te_notif);
393 } else {
394 sc->sc_flags |= IWM_FLAG_TE_ACTIVE;
395 IWM_UNLOCK(sc);
396 if (iwm_wait_notification(sc->sc_notif_wait, &wait_te_notif,
397 TU_TO_HZ(max_delay))) {
398 IWM_DPRINTF(sc, IWM_DEBUG_TE,
399 "%s: Failed to protect session until TE\n",
400 __func__);
401 }
402 IWM_LOCK(sc);
403 }
404 }
405
406 void
iwm_stop_session_protection(struct iwm_softc * sc,struct iwm_vap * ivp)407 iwm_stop_session_protection(struct iwm_softc *sc, struct iwm_vap *ivp)
408 {
409 struct iwm_time_event_cmd time_cmd = {};
410
411 /* Do nothing if the time event has already ended. */
412 if ((sc->sc_flags & IWM_FLAG_TE_ACTIVE) == 0)
413 return;
414
415 time_cmd.id = htole32(sc->sc_time_event_uid);
416 time_cmd.action = htole32(IWM_FW_CTXT_ACTION_REMOVE);
417 time_cmd.id_and_color =
418 htole32(IWM_FW_CMD_ID_AND_COLOR(ivp->id, ivp->color));
419
420 IWM_DPRINTF(sc, IWM_DEBUG_TE,
421 "%s: Removing TE 0x%x\n", __func__, le32toh(time_cmd.id));
422 if (iwm_send_cmd_pdu(sc, IWM_TIME_EVENT_CMD, 0, sizeof(time_cmd),
423 &time_cmd) == 0)
424 iwm_te_clear_data(sc);
425
426 DELAY(100);
427 }
428