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 COPYING.
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 MSEC_TO_TU(_msec) (_msec*1000/1024)
79 * For the high priority TE use a time event type that has similar priority to
80 * the FW's action scan priority.
82 #define IWL_MVM_ROC_TE_TYPE_NORMAL TE_P2P_DEVICE_DISCOVERABLE
83 #define IWL_MVM_ROC_TE_TYPE_MGMT_TX TE_P2P_CLIENT_ASSOC
85 void iwl_mvm_te_clear_data(struct iwl_mvm *mvm,
86 struct iwl_mvm_time_event_data *te_data)
88 lockdep_assert_held(&mvm->time_event_lock);
90 if (te_data->id == TE_MAX)
93 list_del(&te_data->list);
94 te_data->running = false;
100 void iwl_mvm_roc_done_wk(struct work_struct *wk)
102 struct iwl_mvm *mvm = container_of(wk, struct iwl_mvm, roc_done_wk);
107 * Flush the offchannel queue -- this is called when the time
108 * event finishes or is cancelled, so that frames queued for it
109 * won't get stuck on the queue and be transmitted in the next
111 * We have to send the command asynchronously since this cannot
112 * be under the mutex for locking reasons, but that's not an
113 * issue as it will have to complete before the next command is
114 * executed, and a new time event means a new command.
116 iwl_mvm_flush_tx_path(mvm, BIT(IWL_MVM_OFFCHANNEL_QUEUE), false);
119 static void iwl_mvm_roc_finished(struct iwl_mvm *mvm)
122 * First, clear the ROC_RUNNING status bit. This will cause the TX
123 * path to drop offchannel transmissions. That would also be done
124 * by mac80211, but it is racy, in particular in the case that the
125 * time event actually completed in the firmware (which is handled
126 * in iwl_mvm_te_handle_notif).
128 clear_bit(IWL_MVM_STATUS_ROC_RUNNING, &mvm->status);
131 * Of course, our status bit is just as racy as mac80211, so in
132 * addition, fire off the work struct which will drop all frames
133 * from the hardware queues that made it through the race. First
134 * it will of course synchronize the TX path to make sure that
135 * any *new* TX will be rejected.
137 schedule_work(&mvm->roc_done_wk);
141 * Handles a FW notification for an event that is known to the driver.
143 * @mvm: the mvm component
144 * @te_data: the time event data
145 * @notif: the notification data corresponding the time event data.
147 static void iwl_mvm_te_handle_notif(struct iwl_mvm *mvm,
148 struct iwl_mvm_time_event_data *te_data,
149 struct iwl_time_event_notif *notif)
151 lockdep_assert_held(&mvm->time_event_lock);
153 IWL_DEBUG_TE(mvm, "Handle time event notif - UID = 0x%x action %d\n",
154 le32_to_cpu(notif->unique_id),
155 le32_to_cpu(notif->action));
158 * The FW sends the start/end time event notifications even for events
159 * that it fails to schedule. This is indicated in the status field of
160 * the notification. This happens in cases that the scheduler cannot
161 * find a schedule that can handle the event (for example requesting a
162 * P2P Device discoveribility, while there are other higher priority
163 * events in the system).
165 WARN_ONCE(!le32_to_cpu(notif->status),
166 "Failed to schedule time event\n");
168 if (le32_to_cpu(notif->action) & TE_V2_NOTIF_HOST_EVENT_END) {
170 "TE ended - current time %lu, estimated end %lu\n",
171 jiffies, te_data->end_jiffies);
173 if (te_data->vif->type == NL80211_IFTYPE_P2P_DEVICE) {
174 ieee80211_remain_on_channel_expired(mvm->hw);
175 iwl_mvm_roc_finished(mvm);
179 * By now, we should have finished association
180 * and know the dtim period.
182 if (te_data->vif->type == NL80211_IFTYPE_STATION &&
183 (!te_data->vif->bss_conf.assoc ||
184 !te_data->vif->bss_conf.dtim_period)) {
186 "No assocation and the time event is over already...\n");
187 ieee80211_connection_loss(te_data->vif);
190 iwl_mvm_te_clear_data(mvm, te_data);
191 } else if (le32_to_cpu(notif->action) & TE_V2_NOTIF_HOST_EVENT_START) {
192 te_data->running = true;
193 te_data->end_jiffies = TU_TO_EXP_TIME(te_data->duration);
195 if (te_data->vif->type == NL80211_IFTYPE_P2P_DEVICE) {
196 set_bit(IWL_MVM_STATUS_ROC_RUNNING, &mvm->status);
197 ieee80211_ready_on_channel(mvm->hw);
200 IWL_WARN(mvm, "Got TE with unknown action\n");
205 * The Rx handler for time event notifications
207 int iwl_mvm_rx_time_event_notif(struct iwl_mvm *mvm,
208 struct iwl_rx_cmd_buffer *rxb,
209 struct iwl_device_cmd *cmd)
211 struct iwl_rx_packet *pkt = rxb_addr(rxb);
212 struct iwl_time_event_notif *notif = (void *)pkt->data;
213 struct iwl_mvm_time_event_data *te_data, *tmp;
215 IWL_DEBUG_TE(mvm, "Time event notification - UID = 0x%x action %d\n",
216 le32_to_cpu(notif->unique_id),
217 le32_to_cpu(notif->action));
219 spin_lock_bh(&mvm->time_event_lock);
220 list_for_each_entry_safe(te_data, tmp, &mvm->time_event_list, list) {
221 if (le32_to_cpu(notif->unique_id) == te_data->uid)
222 iwl_mvm_te_handle_notif(mvm, te_data, notif);
224 spin_unlock_bh(&mvm->time_event_lock);
229 static bool iwl_mvm_time_event_response(struct iwl_notif_wait_data *notif_wait,
230 struct iwl_rx_packet *pkt, void *data)
232 struct iwl_mvm *mvm =
233 container_of(notif_wait, struct iwl_mvm, notif_wait);
234 struct iwl_mvm_time_event_data *te_data = data;
235 struct iwl_time_event_resp *resp;
236 int resp_len = le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
238 if (WARN_ON(pkt->hdr.cmd != TIME_EVENT_CMD))
241 if (WARN_ON_ONCE(resp_len != sizeof(pkt->hdr) + sizeof(*resp))) {
242 IWL_ERR(mvm, "Invalid TIME_EVENT_CMD response\n");
246 resp = (void *)pkt->data;
248 /* we should never get a response to another TIME_EVENT_CMD here */
249 if (WARN_ON_ONCE(le32_to_cpu(resp->id) != te_data->id))
252 te_data->uid = le32_to_cpu(resp->unique_id);
253 IWL_DEBUG_TE(mvm, "TIME_EVENT_CMD response - UID = 0x%x\n",
258 /* used to convert from time event API v2 to v1 */
259 #define TE_V2_DEP_POLICY_MSK (TE_V2_DEP_OTHER | TE_V2_DEP_TSF |\
260 TE_V2_EVENT_SOCIOPATHIC)
261 static inline u16 te_v2_get_notify(__le16 policy)
263 return le16_to_cpu(policy) & TE_V2_NOTIF_MSK;
266 static inline u16 te_v2_get_dep_policy(__le16 policy)
268 return (le16_to_cpu(policy) & TE_V2_DEP_POLICY_MSK) >>
272 static inline u16 te_v2_get_absence(__le16 policy)
274 return (le16_to_cpu(policy) & TE_V2_ABSENCE) >> TE_V2_ABSENCE_POS;
277 static void iwl_mvm_te_v2_to_v1(const struct iwl_time_event_cmd_v2 *cmd_v2,
278 struct iwl_time_event_cmd_v1 *cmd_v1)
280 cmd_v1->id_and_color = cmd_v2->id_and_color;
281 cmd_v1->action = cmd_v2->action;
282 cmd_v1->id = cmd_v2->id;
283 cmd_v1->apply_time = cmd_v2->apply_time;
284 cmd_v1->max_delay = cmd_v2->max_delay;
285 cmd_v1->depends_on = cmd_v2->depends_on;
286 cmd_v1->interval = cmd_v2->interval;
287 cmd_v1->duration = cmd_v2->duration;
288 if (cmd_v2->repeat == TE_V2_REPEAT_ENDLESS)
289 cmd_v1->repeat = cpu_to_le32(TE_V1_REPEAT_ENDLESS);
291 cmd_v1->repeat = cpu_to_le32(cmd_v2->repeat);
292 cmd_v1->max_frags = cpu_to_le32(cmd_v2->max_frags);
293 cmd_v1->interval_reciprocal = 0; /* unused */
295 cmd_v1->dep_policy = cpu_to_le32(te_v2_get_dep_policy(cmd_v2->policy));
296 cmd_v1->is_present = cpu_to_le32(!te_v2_get_absence(cmd_v2->policy));
297 cmd_v1->notify = cpu_to_le32(te_v2_get_notify(cmd_v2->policy));
300 static int iwl_mvm_send_time_event_cmd(struct iwl_mvm *mvm,
301 const struct iwl_time_event_cmd_v2 *cmd)
303 struct iwl_time_event_cmd_v1 cmd_v1;
305 if (mvm->fw->ucode_capa.flags & IWL_UCODE_TLV_FLAGS_TIME_EVENT_API_V2)
306 return iwl_mvm_send_cmd_pdu(mvm, TIME_EVENT_CMD, CMD_SYNC,
309 iwl_mvm_te_v2_to_v1(cmd, &cmd_v1);
310 return iwl_mvm_send_cmd_pdu(mvm, TIME_EVENT_CMD, CMD_SYNC,
311 sizeof(cmd_v1), &cmd_v1);
315 static int iwl_mvm_time_event_send_add(struct iwl_mvm *mvm,
316 struct ieee80211_vif *vif,
317 struct iwl_mvm_time_event_data *te_data,
318 struct iwl_time_event_cmd_v2 *te_cmd)
320 static const u8 time_event_response[] = { TIME_EVENT_CMD };
321 struct iwl_notification_wait wait_time_event;
324 lockdep_assert_held(&mvm->mutex);
326 IWL_DEBUG_TE(mvm, "Add new TE, duration %d TU\n",
327 le32_to_cpu(te_cmd->duration));
329 spin_lock_bh(&mvm->time_event_lock);
330 if (WARN_ON(te_data->id != TE_MAX)) {
331 spin_unlock_bh(&mvm->time_event_lock);
335 te_data->duration = le32_to_cpu(te_cmd->duration);
336 te_data->id = le32_to_cpu(te_cmd->id);
337 list_add_tail(&te_data->list, &mvm->time_event_list);
338 spin_unlock_bh(&mvm->time_event_lock);
341 * Use a notification wait, which really just processes the
342 * command response and doesn't wait for anything, in order
343 * to be able to process the response and get the UID inside
344 * the RX path. Using CMD_WANT_SKB doesn't work because it
345 * stores the buffer and then wakes up this thread, by which
346 * time another notification (that the time event started)
347 * might already be processed unsuccessfully.
349 iwl_init_notification_wait(&mvm->notif_wait, &wait_time_event,
351 ARRAY_SIZE(time_event_response),
352 iwl_mvm_time_event_response, te_data);
354 ret = iwl_mvm_send_time_event_cmd(mvm, te_cmd);
356 IWL_ERR(mvm, "Couldn't send TIME_EVENT_CMD: %d\n", ret);
357 iwl_remove_notification(&mvm->notif_wait, &wait_time_event);
361 /* No need to wait for anything, so just pass 1 (0 isn't valid) */
362 ret = iwl_wait_notification(&mvm->notif_wait, &wait_time_event, 1);
363 /* should never fail */
368 spin_lock_bh(&mvm->time_event_lock);
369 iwl_mvm_te_clear_data(mvm, te_data);
370 spin_unlock_bh(&mvm->time_event_lock);
375 void iwl_mvm_protect_session(struct iwl_mvm *mvm,
376 struct ieee80211_vif *vif,
377 u32 duration, u32 min_duration)
379 struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
380 struct iwl_mvm_time_event_data *te_data = &mvmvif->time_event_data;
381 struct iwl_time_event_cmd_v2 time_cmd = {};
383 lockdep_assert_held(&mvm->mutex);
385 if (te_data->running &&
386 time_after(te_data->end_jiffies, TU_TO_EXP_TIME(min_duration))) {
387 IWL_DEBUG_TE(mvm, "We have enough time in the current TE: %u\n",
388 jiffies_to_msecs(te_data->end_jiffies - jiffies));
392 if (te_data->running) {
393 IWL_DEBUG_TE(mvm, "extend 0x%x: only %u ms left\n",
395 jiffies_to_msecs(te_data->end_jiffies - jiffies));
397 * we don't have enough time
398 * cancel the current TE and issue a new one
399 * Of course it would be better to remove the old one only
400 * when the new one is added, but we don't care if we are off
401 * channel for a bit. All we need to do, is not to return
402 * before we actually begin to be on the channel.
404 iwl_mvm_stop_session_protection(mvm, vif);
407 time_cmd.action = cpu_to_le32(FW_CTXT_ACTION_ADD);
408 time_cmd.id_and_color =
409 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color));
410 time_cmd.id = cpu_to_le32(TE_BSS_STA_AGGRESSIVE_ASSOC);
412 time_cmd.apply_time =
413 cpu_to_le32(iwl_read_prph(mvm->trans, DEVICE_SYSTEM_TIME_REG));
415 time_cmd.max_frags = TE_V2_FRAG_NONE;
416 time_cmd.max_delay = cpu_to_le32(500);
417 /* TODO: why do we need to interval = bi if it is not periodic? */
418 time_cmd.interval = cpu_to_le32(1);
419 time_cmd.duration = cpu_to_le32(duration);
421 time_cmd.policy = cpu_to_le16(TE_V2_NOTIF_HOST_EVENT_START |
422 TE_V2_NOTIF_HOST_EVENT_END);
424 iwl_mvm_time_event_send_add(mvm, vif, te_data, &time_cmd);
428 * Explicit request to remove a time event. The removal of a time event needs to
429 * be synchronized with the flow of a time event's end notification, which also
430 * removes the time event from the op mode data structures.
432 void iwl_mvm_remove_time_event(struct iwl_mvm *mvm,
433 struct iwl_mvm_vif *mvmvif,
434 struct iwl_mvm_time_event_data *te_data)
436 struct iwl_time_event_cmd_v2 time_cmd = {};
441 * It is possible that by the time we got to this point the time
442 * event was already removed.
444 spin_lock_bh(&mvm->time_event_lock);
446 /* Save time event uid before clearing its data */
451 * The clear_data function handles time events that were already removed
453 iwl_mvm_te_clear_data(mvm, te_data);
454 spin_unlock_bh(&mvm->time_event_lock);
457 * It is possible that by the time we try to remove it, the time event
458 * has already ended and removed. In such a case there is no need to
459 * send a removal command.
462 IWL_DEBUG_TE(mvm, "TE 0x%x has already ended\n", uid);
466 /* When we remove a TE, the UID is to be set in the id field */
467 time_cmd.id = cpu_to_le32(uid);
468 time_cmd.action = cpu_to_le32(FW_CTXT_ACTION_REMOVE);
469 time_cmd.id_and_color =
470 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color));
472 IWL_DEBUG_TE(mvm, "Removing TE 0x%x\n", le32_to_cpu(time_cmd.id));
473 ret = iwl_mvm_send_time_event_cmd(mvm, &time_cmd);
478 void iwl_mvm_stop_session_protection(struct iwl_mvm *mvm,
479 struct ieee80211_vif *vif)
481 struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
482 struct iwl_mvm_time_event_data *te_data = &mvmvif->time_event_data;
484 lockdep_assert_held(&mvm->mutex);
485 iwl_mvm_remove_time_event(mvm, mvmvif, te_data);
488 int iwl_mvm_start_p2p_roc(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
489 int duration, enum ieee80211_roc_type type)
491 struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
492 struct iwl_mvm_time_event_data *te_data = &mvmvif->time_event_data;
493 struct iwl_time_event_cmd_v2 time_cmd = {};
495 lockdep_assert_held(&mvm->mutex);
496 if (te_data->running) {
497 IWL_WARN(mvm, "P2P_DEVICE remain on channel already running\n");
502 * Flush the done work, just in case it's still pending, so that
503 * the work it does can complete and we can accept new frames.
505 flush_work(&mvm->roc_done_wk);
507 time_cmd.action = cpu_to_le32(FW_CTXT_ACTION_ADD);
508 time_cmd.id_and_color =
509 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color));
512 case IEEE80211_ROC_TYPE_NORMAL:
513 time_cmd.id = cpu_to_le32(IWL_MVM_ROC_TE_TYPE_NORMAL);
515 case IEEE80211_ROC_TYPE_MGMT_TX:
516 time_cmd.id = cpu_to_le32(IWL_MVM_ROC_TE_TYPE_MGMT_TX);
519 WARN_ONCE(1, "Got an invalid ROC type\n");
523 time_cmd.apply_time = cpu_to_le32(0);
524 time_cmd.interval = cpu_to_le32(1);
527 * The P2P Device TEs can have lower priority than other events
528 * that are being scheduled by the driver/fw, and thus it might not be
529 * scheduled. To improve the chances of it being scheduled, allow them
530 * to be fragmented, and in addition allow them to be delayed.
532 time_cmd.max_frags = min(MSEC_TO_TU(duration)/50, TE_V2_FRAG_ENDLESS);
533 time_cmd.max_delay = cpu_to_le32(MSEC_TO_TU(duration/2));
534 time_cmd.duration = cpu_to_le32(MSEC_TO_TU(duration));
536 time_cmd.policy = cpu_to_le16(TE_V2_NOTIF_HOST_EVENT_START |
537 TE_V2_NOTIF_HOST_EVENT_END);
539 return iwl_mvm_time_event_send_add(mvm, vif, te_data, &time_cmd);
542 void iwl_mvm_stop_p2p_roc(struct iwl_mvm *mvm)
544 struct iwl_mvm_vif *mvmvif;
545 struct iwl_mvm_time_event_data *te_data;
547 lockdep_assert_held(&mvm->mutex);
550 * Iterate over the list of time events and find the time event that is
551 * associated with a P2P_DEVICE interface.
552 * This assumes that a P2P_DEVICE interface can have only a single time
553 * event at any given time and this time event coresponds to a ROC
557 spin_lock_bh(&mvm->time_event_lock);
558 list_for_each_entry(te_data, &mvm->time_event_list, list) {
559 if (te_data->vif->type == NL80211_IFTYPE_P2P_DEVICE) {
560 mvmvif = iwl_mvm_vif_from_mac80211(te_data->vif);
564 spin_unlock_bh(&mvm->time_event_lock);
567 IWL_WARN(mvm, "P2P_DEVICE no remain on channel event\n");
571 iwl_mvm_remove_time_event(mvm, mvmvif, te_data);
573 iwl_mvm_roc_finished(mvm);