1 /******************************************************************************
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
8 * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of version 2 of the GNU General Public License as
12 * published by the Free Software Foundation.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
40 * * Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * * Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in
44 * the documentation and/or other materials provided with the
46 * * Neither the name Intel Corporation nor the names of its
47 * contributors may be used to endorse or promote products derived
48 * from this software without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
51 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
52 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
53 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
54 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
55 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
56 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
57 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
58 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
59 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
60 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62 *****************************************************************************/
64 #include <linux/jiffies.h>
65 #include <net/mac80211.h>
67 #include "iwl-notif-wait.h"
68 #include "iwl-trans.h"
70 #include "time-event.h"
75 /* A TimeUnit is 1024 microsecond */
76 #define TU_TO_JIFFIES(_tu) (usecs_to_jiffies((_tu) * 1024))
77 #define MSEC_TO_TU(_msec) (_msec*1000/1024)
79 /* For ROC use a TE type which has priority high enough to be scheduled when
80 * there is a concurrent BSS or GO/AP. Currently, use a TE type that has
81 * priority similar to the TE priority used for action scans by the FW.
82 * TODO: This needs to be changed, based on the reason for the ROC, i.e., use
83 * TE_P2P_DEVICE_DISCOVERABLE for remain on channel without mgmt skb, and use
84 * TE_P2P_DEVICE_ACTION_SCAN
86 #define IWL_MVM_ROC_TE_TYPE TE_P2P_DEVICE_ACTION_SCAN
88 void iwl_mvm_te_clear_data(struct iwl_mvm *mvm,
89 struct iwl_mvm_time_event_data *te_data)
91 lockdep_assert_held(&mvm->time_event_lock);
93 if (te_data->id == TE_MAX)
96 list_del(&te_data->list);
97 te_data->running = false;
103 void iwl_mvm_roc_done_wk(struct work_struct *wk)
105 struct iwl_mvm *mvm = container_of(wk, struct iwl_mvm, roc_done_wk);
110 * Flush the offchannel queue -- this is called when the time
111 * event finishes or is cancelled, so that frames queued for it
112 * won't get stuck on the queue and be transmitted in the next
114 * We have to send the command asynchronously since this cannot
115 * be under the mutex for locking reasons, but that's not an
116 * issue as it will have to complete before the next command is
117 * executed, and a new time event means a new command.
119 iwl_mvm_flush_tx_path(mvm, BIT(IWL_OFFCHANNEL_QUEUE), false);
122 static void iwl_mvm_roc_finished(struct iwl_mvm *mvm)
125 * First, clear the ROC_RUNNING status bit. This will cause the TX
126 * path to drop offchannel transmissions. That would also be done
127 * by mac80211, but it is racy, in particular in the case that the
128 * time event actually completed in the firmware (which is handled
129 * in iwl_mvm_te_handle_notif).
131 clear_bit(IWL_MVM_STATUS_ROC_RUNNING, &mvm->status);
134 * Of course, our status bit is just as racy as mac80211, so in
135 * addition, fire off the work struct which will drop all frames
136 * from the hardware queues that made it through the race. First
137 * it will of course synchronize the TX path to make sure that
138 * any *new* TX will be rejected.
140 schedule_work(&mvm->roc_done_wk);
144 * Handles a FW notification for an event that is known to the driver.
146 * @mvm: the mvm component
147 * @te_data: the time event data
148 * @notif: the notification data corresponding the time event data.
150 static void iwl_mvm_te_handle_notif(struct iwl_mvm *mvm,
151 struct iwl_mvm_time_event_data *te_data,
152 struct iwl_time_event_notif *notif)
154 lockdep_assert_held(&mvm->time_event_lock);
156 IWL_DEBUG_TE(mvm, "Handle time event notif - UID = 0x%x action %d\n",
157 le32_to_cpu(notif->unique_id),
158 le32_to_cpu(notif->action));
161 * The FW sends the start/end time event notifications even for events
162 * that it fails to schedule. This is indicated in the status field of
163 * the notification. This happens in cases that the scheduler cannot
164 * find a schedule that can handle the event (for example requesting a
165 * P2P Device discoveribility, while there are other higher priority
166 * events in the system).
168 WARN_ONCE(!le32_to_cpu(notif->status),
169 "Failed to schedule time event\n");
171 if (le32_to_cpu(notif->action) == TE_NOTIF_HOST_END) {
173 "TE ended - current time %lu, estimated end %lu\n",
174 jiffies, te_data->end_jiffies);
176 if (te_data->vif->type == NL80211_IFTYPE_P2P_DEVICE) {
177 ieee80211_remain_on_channel_expired(mvm->hw);
178 iwl_mvm_roc_finished(mvm);
182 * By now, we should have finished association
183 * and know the dtim period.
185 if (te_data->vif->type == NL80211_IFTYPE_STATION &&
186 (!te_data->vif->bss_conf.assoc ||
187 !te_data->vif->bss_conf.dtim_period)) {
189 "No assocation and the time event is over already...\n");
190 ieee80211_connection_loss(te_data->vif);
193 iwl_mvm_te_clear_data(mvm, te_data);
194 } else if (le32_to_cpu(notif->action) == TE_NOTIF_HOST_START) {
195 te_data->running = true;
196 te_data->end_jiffies = jiffies +
197 TU_TO_JIFFIES(te_data->duration);
199 if (te_data->vif->type == NL80211_IFTYPE_P2P_DEVICE) {
200 set_bit(IWL_MVM_STATUS_ROC_RUNNING, &mvm->status);
201 ieee80211_ready_on_channel(mvm->hw);
204 IWL_WARN(mvm, "Got TE with unknown action\n");
209 * The Rx handler for time event notifications
211 int iwl_mvm_rx_time_event_notif(struct iwl_mvm *mvm,
212 struct iwl_rx_cmd_buffer *rxb,
213 struct iwl_device_cmd *cmd)
215 struct iwl_rx_packet *pkt = rxb_addr(rxb);
216 struct iwl_time_event_notif *notif = (void *)pkt->data;
217 struct iwl_mvm_time_event_data *te_data, *tmp;
219 IWL_DEBUG_TE(mvm, "Time event notification - UID = 0x%x action %d\n",
220 le32_to_cpu(notif->unique_id),
221 le32_to_cpu(notif->action));
223 spin_lock_bh(&mvm->time_event_lock);
224 list_for_each_entry_safe(te_data, tmp, &mvm->time_event_list, list) {
225 if (le32_to_cpu(notif->unique_id) == te_data->uid)
226 iwl_mvm_te_handle_notif(mvm, te_data, notif);
228 spin_unlock_bh(&mvm->time_event_lock);
233 static bool iwl_mvm_time_event_notif(struct iwl_notif_wait_data *notif_wait,
234 struct iwl_rx_packet *pkt, void *data)
236 struct iwl_mvm *mvm =
237 container_of(notif_wait, struct iwl_mvm, notif_wait);
238 struct iwl_mvm_time_event_data *te_data = data;
239 struct ieee80211_vif *vif = te_data->vif;
240 struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
241 struct iwl_time_event_notif *notif;
242 struct iwl_time_event_resp *resp;
244 u32 mac_id_n_color = FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color);
246 /* until we do something else */
247 WARN_ON(te_data->id != TE_BSS_STA_AGGRESSIVE_ASSOC);
249 switch (pkt->hdr.cmd) {
251 resp = (void *)pkt->data;
252 /* TODO: I can't check that since the fw is buggy - it doesn't
253 * put the right values when we remove a TE. We can be here
254 * when we remove a TE because the remove TE command is sent in
256 * WARN_ON(mac_id_n_color != le32_to_cpu(resp->id_and_color));
258 te_data->uid = le32_to_cpu(resp->unique_id);
259 IWL_DEBUG_TE(mvm, "Got response - UID = 0x%x\n", te_data->uid);
262 case TIME_EVENT_NOTIFICATION:
263 notif = (void *)pkt->data;
264 WARN_ON(le32_to_cpu(notif->status) != 1);
265 WARN_ON(mac_id_n_color != le32_to_cpu(notif->id_and_color));
266 /* check if this is our Time Event that is starting */
267 if (le32_to_cpu(notif->unique_id) != te_data->uid)
269 IWL_DEBUG_TE(mvm, "Event %d is starting - time is %d\n",
270 te_data->uid, le32_to_cpu(notif->timestamp));
272 WARN_ONCE(!le32_to_cpu(notif->status),
273 "Failed to schedule protected session TE\n");
275 te_data->running = true;
276 te_data->end_jiffies = jiffies +
277 TU_TO_JIFFIES(te_data->duration);
286 void iwl_mvm_protect_session(struct iwl_mvm *mvm,
287 struct ieee80211_vif *vif,
288 u32 duration, u32 min_duration)
290 struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
291 struct iwl_mvm_time_event_data *te_data = &mvmvif->time_event_data;
292 static const u8 time_event_notif[] = { TIME_EVENT_CMD,
293 TIME_EVENT_NOTIFICATION };
294 struct iwl_notification_wait wait_time_event;
295 struct iwl_time_event_cmd time_cmd = {};
298 lockdep_assert_held(&mvm->mutex);
300 if (te_data->running &&
301 time_after(te_data->end_jiffies,
302 jiffies + TU_TO_JIFFIES(min_duration))) {
303 IWL_DEBUG_TE(mvm, "We have enough time in the current TE: %u\n",
304 jiffies_to_msecs(te_data->end_jiffies - jiffies));
308 if (te_data->running) {
309 IWL_DEBUG_TE(mvm, "extend 0x%x: only %u ms left\n",
311 jiffies_to_msecs(te_data->end_jiffies - jiffies));
313 * we don't have enough time
314 * cancel the current TE and issue a new one
315 * Of course it would be better to remove the old one only
316 * when the new one is added, but we don't care if we are off
317 * channel for a bit. All we need to do, is not to return
318 * before we actually begin to be on the channel.
320 iwl_mvm_stop_session_protection(mvm, vif);
323 iwl_init_notification_wait(&mvm->notif_wait, &wait_time_event,
325 ARRAY_SIZE(time_event_notif),
326 iwl_mvm_time_event_notif,
327 &mvmvif->time_event_data);
329 time_cmd.action = cpu_to_le32(FW_CTXT_ACTION_ADD);
330 time_cmd.id_and_color =
331 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color));
332 time_cmd.id = cpu_to_le32(TE_BSS_STA_AGGRESSIVE_ASSOC);
334 time_cmd.apply_time =
335 cpu_to_le32(iwl_read_prph(mvm->trans, DEVICE_SYSTEM_TIME_REG));
336 time_cmd.dep_policy = TE_INDEPENDENT;
337 time_cmd.is_present = cpu_to_le32(1);
338 time_cmd.max_frags = cpu_to_le32(TE_FRAG_NONE);
339 time_cmd.max_delay = cpu_to_le32(500);
340 /* TODO: why do we need to interval = bi if it is not periodic? */
341 time_cmd.interval = cpu_to_le32(1);
342 time_cmd.interval_reciprocal = cpu_to_le32(iwl_mvm_reciprocal(1));
343 time_cmd.duration = cpu_to_le32(duration);
344 time_cmd.repeat = cpu_to_le32(1);
345 time_cmd.notify = cpu_to_le32(TE_NOTIF_HOST_START | TE_NOTIF_HOST_END);
348 te_data->duration = duration;
350 spin_lock_bh(&mvm->time_event_lock);
351 te_data->id = le32_to_cpu(time_cmd.id);
352 list_add_tail(&te_data->list, &mvm->time_event_list);
353 spin_unlock_bh(&mvm->time_event_lock);
355 ret = iwl_mvm_send_cmd_pdu(mvm, TIME_EVENT_CMD, CMD_SYNC,
356 sizeof(time_cmd), &time_cmd);
358 IWL_ERR(mvm, "Couldn't send TIME_EVENT_CMD: %d\n", ret);
359 goto out_remove_notif;
362 ret = iwl_wait_notification(&mvm->notif_wait, &wait_time_event, 1 * HZ);
364 IWL_ERR(mvm, "%s - failed on timeout\n", __func__);
365 spin_lock_bh(&mvm->time_event_lock);
366 iwl_mvm_te_clear_data(mvm, te_data);
367 spin_unlock_bh(&mvm->time_event_lock);
373 iwl_remove_notification(&mvm->notif_wait, &wait_time_event);
377 * Explicit request to remove a time event. The removal of a time event needs to
378 * be synchronized with the flow of a time event's end notification, which also
379 * removes the time event from the op mode data structures.
381 void iwl_mvm_remove_time_event(struct iwl_mvm *mvm,
382 struct iwl_mvm_vif *mvmvif,
383 struct iwl_mvm_time_event_data *te_data)
385 struct iwl_time_event_cmd time_cmd = {};
390 * It is possible that by the time we got to this point the time
391 * event was already removed.
393 spin_lock_bh(&mvm->time_event_lock);
395 /* Save time event uid before clearing its data */
400 * The clear_data function handles time events that were already removed
402 iwl_mvm_te_clear_data(mvm, te_data);
403 spin_unlock_bh(&mvm->time_event_lock);
406 * It is possible that by the time we try to remove it, the time event
407 * has already ended and removed. In such a case there is no need to
408 * send a removal command.
411 IWL_DEBUG_TE(mvm, "TE 0x%x has already ended\n", uid);
415 /* When we remove a TE, the UID is to be set in the id field */
416 time_cmd.id = cpu_to_le32(uid);
417 time_cmd.action = cpu_to_le32(FW_CTXT_ACTION_REMOVE);
418 time_cmd.id_and_color =
419 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color));
421 IWL_DEBUG_TE(mvm, "Removing TE 0x%x\n", le32_to_cpu(time_cmd.id));
422 ret = iwl_mvm_send_cmd_pdu(mvm, TIME_EVENT_CMD, CMD_ASYNC,
423 sizeof(time_cmd), &time_cmd);
428 void iwl_mvm_stop_session_protection(struct iwl_mvm *mvm,
429 struct ieee80211_vif *vif)
431 struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
432 struct iwl_mvm_time_event_data *te_data = &mvmvif->time_event_data;
434 lockdep_assert_held(&mvm->mutex);
435 iwl_mvm_remove_time_event(mvm, mvmvif, te_data);
438 static bool iwl_mvm_roc_te_notif(struct iwl_notif_wait_data *notif_wait,
439 struct iwl_rx_packet *pkt, void *data)
441 struct iwl_mvm *mvm =
442 container_of(notif_wait, struct iwl_mvm, notif_wait);
443 struct iwl_mvm_time_event_data *te_data = data;
444 struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(te_data->vif);
445 struct iwl_time_event_resp *resp;
447 u32 mac_id_n_color = FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color);
449 /* until we do something else */
450 WARN_ON(te_data->id != IWL_MVM_ROC_TE_TYPE);
452 switch (pkt->hdr.cmd) {
454 resp = (void *)pkt->data;
455 WARN_ON(mac_id_n_color != le32_to_cpu(resp->id_and_color));
456 te_data->uid = le32_to_cpu(resp->unique_id);
457 IWL_DEBUG_TE(mvm, "Got response - UID = 0x%x\n", te_data->uid);
466 int iwl_mvm_start_p2p_roc(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
469 struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
470 struct iwl_mvm_time_event_data *te_data = &mvmvif->time_event_data;
471 static const u8 roc_te_notif[] = { TIME_EVENT_CMD };
472 struct iwl_notification_wait wait_time_event;
473 struct iwl_time_event_cmd time_cmd = {};
476 lockdep_assert_held(&mvm->mutex);
477 if (te_data->running) {
478 IWL_WARN(mvm, "P2P_DEVICE remain on channel already running\n");
483 * Flush the done work, just in case it's still pending, so that
484 * the work it does can complete and we can accept new frames.
486 flush_work(&mvm->roc_done_wk);
488 iwl_init_notification_wait(&mvm->notif_wait, &wait_time_event,
490 ARRAY_SIZE(roc_te_notif),
491 iwl_mvm_roc_te_notif,
492 &mvmvif->time_event_data);
494 time_cmd.action = cpu_to_le32(FW_CTXT_ACTION_ADD);
495 time_cmd.id_and_color =
496 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color));
497 time_cmd.id = cpu_to_le32(IWL_MVM_ROC_TE_TYPE);
499 time_cmd.apply_time = cpu_to_le32(0);
500 time_cmd.dep_policy = cpu_to_le32(TE_INDEPENDENT);
501 time_cmd.is_present = cpu_to_le32(1);
503 time_cmd.interval = cpu_to_le32(1);
506 * IWL_MVM_ROC_TE_TYPE can have lower priority than other events
507 * that are being scheduled by the driver/fw, and thus it might not be
508 * scheduled. To improve the chances of it being scheduled, allow it to
510 * In addition, for the same reasons, allow to delay the scheduling of
513 time_cmd.max_frags = cpu_to_le32(MSEC_TO_TU(duration)/20);
514 time_cmd.max_delay = cpu_to_le32(MSEC_TO_TU(duration/2));
515 time_cmd.duration = cpu_to_le32(MSEC_TO_TU(duration));
516 time_cmd.repeat = cpu_to_le32(1);
517 time_cmd.notify = cpu_to_le32(TE_NOTIF_HOST_START | TE_NOTIF_HOST_END);
519 /* Push the te data to the tracked te list */
521 te_data->duration = MSEC_TO_TU(duration);
523 spin_lock_bh(&mvm->time_event_lock);
524 te_data->id = le32_to_cpu(time_cmd.id);
525 list_add_tail(&te_data->list, &mvm->time_event_list);
526 spin_unlock_bh(&mvm->time_event_lock);
528 ret = iwl_mvm_send_cmd_pdu(mvm, TIME_EVENT_CMD, CMD_SYNC,
529 sizeof(time_cmd), &time_cmd);
531 IWL_ERR(mvm, "Couldn't send TIME_EVENT_CMD: %d\n", ret);
532 goto out_remove_notif;
535 ret = iwl_wait_notification(&mvm->notif_wait, &wait_time_event, 1 * HZ);
537 IWL_ERR(mvm, "%s - failed on timeout\n", __func__);
538 iwl_mvm_te_clear_data(mvm, te_data);
544 iwl_remove_notification(&mvm->notif_wait, &wait_time_event);
548 void iwl_mvm_stop_p2p_roc(struct iwl_mvm *mvm)
550 struct iwl_mvm_vif *mvmvif;
551 struct iwl_mvm_time_event_data *te_data;
553 lockdep_assert_held(&mvm->mutex);
556 * Iterate over the list of time events and find the time event that is
557 * associated with a P2P_DEVICE interface.
558 * This assumes that a P2P_DEVICE interface can have only a single time
559 * event at any given time and this time event coresponds to a ROC
563 spin_lock_bh(&mvm->time_event_lock);
564 list_for_each_entry(te_data, &mvm->time_event_list, list) {
565 if (te_data->vif->type == NL80211_IFTYPE_P2P_DEVICE) {
566 mvmvif = iwl_mvm_vif_from_mac80211(te_data->vif);
570 spin_unlock_bh(&mvm->time_event_lock);
573 IWL_WARN(mvm, "P2P_DEVICE no remain on channel event\n");
577 iwl_mvm_remove_time_event(mvm, mvmvif, te_data);
579 iwl_mvm_roc_finished(mvm);