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
);
140 static bool iwl_mvm_te_check_disconnect(struct iwl_mvm
*mvm
,
141 struct ieee80211_vif
*vif
,
144 if (vif
->type
!= NL80211_IFTYPE_STATION
)
146 if (vif
->bss_conf
.assoc
&& vif
->bss_conf
.dtim_period
)
149 IWL_ERR(mvm
, "%s\n", errmsg
);
150 ieee80211_connection_loss(vif
);
155 * Handles a FW notification for an event that is known to the driver.
157 * @mvm: the mvm component
158 * @te_data: the time event data
159 * @notif: the notification data corresponding the time event data.
161 static void iwl_mvm_te_handle_notif(struct iwl_mvm
*mvm
,
162 struct iwl_mvm_time_event_data
*te_data
,
163 struct iwl_time_event_notif
*notif
)
165 lockdep_assert_held(&mvm
->time_event_lock
);
167 IWL_DEBUG_TE(mvm
, "Handle time event notif - UID = 0x%x action %d\n",
168 le32_to_cpu(notif
->unique_id
),
169 le32_to_cpu(notif
->action
));
172 * The FW sends the start/end time event notifications even for events
173 * that it fails to schedule. This is indicated in the status field of
174 * the notification. This happens in cases that the scheduler cannot
175 * find a schedule that can handle the event (for example requesting a
176 * P2P Device discoveribility, while there are other higher priority
177 * events in the system).
179 if (WARN_ONCE(!le32_to_cpu(notif
->status
),
180 "Failed to schedule time event\n")) {
181 if (iwl_mvm_te_check_disconnect(mvm
, te_data
->vif
, NULL
)) {
182 iwl_mvm_te_clear_data(mvm
, te_data
);
187 if (le32_to_cpu(notif
->action
) & TE_V2_NOTIF_HOST_EVENT_END
) {
189 "TE ended - current time %lu, estimated end %lu\n",
190 jiffies
, te_data
->end_jiffies
);
192 if (te_data
->vif
->type
== NL80211_IFTYPE_P2P_DEVICE
) {
193 ieee80211_remain_on_channel_expired(mvm
->hw
);
194 iwl_mvm_roc_finished(mvm
);
198 * By now, we should have finished association
199 * and know the dtim period.
201 iwl_mvm_te_check_disconnect(mvm
, te_data
->vif
,
202 "No association and the time event is over already...");
203 iwl_mvm_te_clear_data(mvm
, te_data
);
204 } else if (le32_to_cpu(notif
->action
) & TE_V2_NOTIF_HOST_EVENT_START
) {
205 te_data
->running
= true;
206 te_data
->end_jiffies
= TU_TO_EXP_TIME(te_data
->duration
);
208 if (te_data
->vif
->type
== NL80211_IFTYPE_P2P_DEVICE
) {
209 set_bit(IWL_MVM_STATUS_ROC_RUNNING
, &mvm
->status
);
210 ieee80211_ready_on_channel(mvm
->hw
);
213 IWL_WARN(mvm
, "Got TE with unknown action\n");
218 * The Rx handler for time event notifications
220 int iwl_mvm_rx_time_event_notif(struct iwl_mvm
*mvm
,
221 struct iwl_rx_cmd_buffer
*rxb
,
222 struct iwl_device_cmd
*cmd
)
224 struct iwl_rx_packet
*pkt
= rxb_addr(rxb
);
225 struct iwl_time_event_notif
*notif
= (void *)pkt
->data
;
226 struct iwl_mvm_time_event_data
*te_data
, *tmp
;
228 IWL_DEBUG_TE(mvm
, "Time event notification - UID = 0x%x action %d\n",
229 le32_to_cpu(notif
->unique_id
),
230 le32_to_cpu(notif
->action
));
232 spin_lock_bh(&mvm
->time_event_lock
);
233 list_for_each_entry_safe(te_data
, tmp
, &mvm
->time_event_list
, list
) {
234 if (le32_to_cpu(notif
->unique_id
) == te_data
->uid
)
235 iwl_mvm_te_handle_notif(mvm
, te_data
, notif
);
237 spin_unlock_bh(&mvm
->time_event_lock
);
242 static bool iwl_mvm_time_event_response(struct iwl_notif_wait_data
*notif_wait
,
243 struct iwl_rx_packet
*pkt
, void *data
)
245 struct iwl_mvm
*mvm
=
246 container_of(notif_wait
, struct iwl_mvm
, notif_wait
);
247 struct iwl_mvm_time_event_data
*te_data
= data
;
248 struct iwl_time_event_resp
*resp
;
249 int resp_len
= le32_to_cpu(pkt
->len_n_flags
) & FH_RSCSR_FRAME_SIZE_MSK
;
251 if (WARN_ON(pkt
->hdr
.cmd
!= TIME_EVENT_CMD
))
254 if (WARN_ON_ONCE(resp_len
!= sizeof(pkt
->hdr
) + sizeof(*resp
))) {
255 IWL_ERR(mvm
, "Invalid TIME_EVENT_CMD response\n");
259 resp
= (void *)pkt
->data
;
261 /* we should never get a response to another TIME_EVENT_CMD here */
262 if (WARN_ON_ONCE(le32_to_cpu(resp
->id
) != te_data
->id
))
265 te_data
->uid
= le32_to_cpu(resp
->unique_id
);
266 IWL_DEBUG_TE(mvm
, "TIME_EVENT_CMD response - UID = 0x%x\n",
271 /* used to convert from time event API v2 to v1 */
272 #define TE_V2_DEP_POLICY_MSK (TE_V2_DEP_OTHER | TE_V2_DEP_TSF |\
273 TE_V2_EVENT_SOCIOPATHIC)
274 static inline u16
te_v2_get_notify(__le16 policy
)
276 return le16_to_cpu(policy
) & TE_V2_NOTIF_MSK
;
279 static inline u16
te_v2_get_dep_policy(__le16 policy
)
281 return (le16_to_cpu(policy
) & TE_V2_DEP_POLICY_MSK
) >>
285 static inline u16
te_v2_get_absence(__le16 policy
)
287 return (le16_to_cpu(policy
) & TE_V2_ABSENCE
) >> TE_V2_ABSENCE_POS
;
290 static void iwl_mvm_te_v2_to_v1(const struct iwl_time_event_cmd_v2
*cmd_v2
,
291 struct iwl_time_event_cmd_v1
*cmd_v1
)
293 cmd_v1
->id_and_color
= cmd_v2
->id_and_color
;
294 cmd_v1
->action
= cmd_v2
->action
;
295 cmd_v1
->id
= cmd_v2
->id
;
296 cmd_v1
->apply_time
= cmd_v2
->apply_time
;
297 cmd_v1
->max_delay
= cmd_v2
->max_delay
;
298 cmd_v1
->depends_on
= cmd_v2
->depends_on
;
299 cmd_v1
->interval
= cmd_v2
->interval
;
300 cmd_v1
->duration
= cmd_v2
->duration
;
301 if (cmd_v2
->repeat
== TE_V2_REPEAT_ENDLESS
)
302 cmd_v1
->repeat
= cpu_to_le32(TE_V1_REPEAT_ENDLESS
);
304 cmd_v1
->repeat
= cpu_to_le32(cmd_v2
->repeat
);
305 cmd_v1
->max_frags
= cpu_to_le32(cmd_v2
->max_frags
);
306 cmd_v1
->interval_reciprocal
= 0; /* unused */
308 cmd_v1
->dep_policy
= cpu_to_le32(te_v2_get_dep_policy(cmd_v2
->policy
));
309 cmd_v1
->is_present
= cpu_to_le32(!te_v2_get_absence(cmd_v2
->policy
));
310 cmd_v1
->notify
= cpu_to_le32(te_v2_get_notify(cmd_v2
->policy
));
313 static int iwl_mvm_send_time_event_cmd(struct iwl_mvm
*mvm
,
314 const struct iwl_time_event_cmd_v2
*cmd
)
316 struct iwl_time_event_cmd_v1 cmd_v1
;
318 if (mvm
->fw
->ucode_capa
.flags
& IWL_UCODE_TLV_FLAGS_TIME_EVENT_API_V2
)
319 return iwl_mvm_send_cmd_pdu(mvm
, TIME_EVENT_CMD
, CMD_SYNC
,
322 iwl_mvm_te_v2_to_v1(cmd
, &cmd_v1
);
323 return iwl_mvm_send_cmd_pdu(mvm
, TIME_EVENT_CMD
, CMD_SYNC
,
324 sizeof(cmd_v1
), &cmd_v1
);
328 static int iwl_mvm_time_event_send_add(struct iwl_mvm
*mvm
,
329 struct ieee80211_vif
*vif
,
330 struct iwl_mvm_time_event_data
*te_data
,
331 struct iwl_time_event_cmd_v2
*te_cmd
)
333 static const u8 time_event_response
[] = { TIME_EVENT_CMD
};
334 struct iwl_notification_wait wait_time_event
;
337 lockdep_assert_held(&mvm
->mutex
);
339 IWL_DEBUG_TE(mvm
, "Add new TE, duration %d TU\n",
340 le32_to_cpu(te_cmd
->duration
));
342 spin_lock_bh(&mvm
->time_event_lock
);
343 if (WARN_ON(te_data
->id
!= TE_MAX
)) {
344 spin_unlock_bh(&mvm
->time_event_lock
);
348 te_data
->duration
= le32_to_cpu(te_cmd
->duration
);
349 te_data
->id
= le32_to_cpu(te_cmd
->id
);
350 list_add_tail(&te_data
->list
, &mvm
->time_event_list
);
351 spin_unlock_bh(&mvm
->time_event_lock
);
354 * Use a notification wait, which really just processes the
355 * command response and doesn't wait for anything, in order
356 * to be able to process the response and get the UID inside
357 * the RX path. Using CMD_WANT_SKB doesn't work because it
358 * stores the buffer and then wakes up this thread, by which
359 * time another notification (that the time event started)
360 * might already be processed unsuccessfully.
362 iwl_init_notification_wait(&mvm
->notif_wait
, &wait_time_event
,
364 ARRAY_SIZE(time_event_response
),
365 iwl_mvm_time_event_response
, te_data
);
367 ret
= iwl_mvm_send_time_event_cmd(mvm
, te_cmd
);
369 IWL_ERR(mvm
, "Couldn't send TIME_EVENT_CMD: %d\n", ret
);
370 iwl_remove_notification(&mvm
->notif_wait
, &wait_time_event
);
374 /* No need to wait for anything, so just pass 1 (0 isn't valid) */
375 ret
= iwl_wait_notification(&mvm
->notif_wait
, &wait_time_event
, 1);
376 /* should never fail */
381 spin_lock_bh(&mvm
->time_event_lock
);
382 iwl_mvm_te_clear_data(mvm
, te_data
);
383 spin_unlock_bh(&mvm
->time_event_lock
);
388 void iwl_mvm_protect_session(struct iwl_mvm
*mvm
,
389 struct ieee80211_vif
*vif
,
390 u32 duration
, u32 min_duration
)
392 struct iwl_mvm_vif
*mvmvif
= iwl_mvm_vif_from_mac80211(vif
);
393 struct iwl_mvm_time_event_data
*te_data
= &mvmvif
->time_event_data
;
394 struct iwl_time_event_cmd_v2 time_cmd
= {};
396 lockdep_assert_held(&mvm
->mutex
);
398 if (te_data
->running
&&
399 time_after(te_data
->end_jiffies
, TU_TO_EXP_TIME(min_duration
))) {
400 IWL_DEBUG_TE(mvm
, "We have enough time in the current TE: %u\n",
401 jiffies_to_msecs(te_data
->end_jiffies
- jiffies
));
405 if (te_data
->running
) {
406 IWL_DEBUG_TE(mvm
, "extend 0x%x: only %u ms left\n",
408 jiffies_to_msecs(te_data
->end_jiffies
- jiffies
));
410 * we don't have enough time
411 * cancel the current TE and issue a new one
412 * Of course it would be better to remove the old one only
413 * when the new one is added, but we don't care if we are off
414 * channel for a bit. All we need to do, is not to return
415 * before we actually begin to be on the channel.
417 iwl_mvm_stop_session_protection(mvm
, vif
);
420 time_cmd
.action
= cpu_to_le32(FW_CTXT_ACTION_ADD
);
421 time_cmd
.id_and_color
=
422 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif
->id
, mvmvif
->color
));
423 time_cmd
.id
= cpu_to_le32(TE_BSS_STA_AGGRESSIVE_ASSOC
);
425 time_cmd
.apply_time
=
426 cpu_to_le32(iwl_read_prph(mvm
->trans
, DEVICE_SYSTEM_TIME_REG
));
428 time_cmd
.max_frags
= TE_V2_FRAG_NONE
;
429 time_cmd
.max_delay
= cpu_to_le32(500);
430 /* TODO: why do we need to interval = bi if it is not periodic? */
431 time_cmd
.interval
= cpu_to_le32(1);
432 time_cmd
.duration
= cpu_to_le32(duration
);
434 time_cmd
.policy
= cpu_to_le16(TE_V2_NOTIF_HOST_EVENT_START
|
435 TE_V2_NOTIF_HOST_EVENT_END
);
437 iwl_mvm_time_event_send_add(mvm
, vif
, te_data
, &time_cmd
);
441 * Explicit request to remove a time event. The removal of a time event needs to
442 * be synchronized with the flow of a time event's end notification, which also
443 * removes the time event from the op mode data structures.
445 void iwl_mvm_remove_time_event(struct iwl_mvm
*mvm
,
446 struct iwl_mvm_vif
*mvmvif
,
447 struct iwl_mvm_time_event_data
*te_data
)
449 struct iwl_time_event_cmd_v2 time_cmd
= {};
454 * It is possible that by the time we got to this point the time
455 * event was already removed.
457 spin_lock_bh(&mvm
->time_event_lock
);
459 /* Save time event uid before clearing its data */
464 * The clear_data function handles time events that were already removed
466 iwl_mvm_te_clear_data(mvm
, te_data
);
467 spin_unlock_bh(&mvm
->time_event_lock
);
470 * It is possible that by the time we try to remove it, the time event
471 * has already ended and removed. In such a case there is no need to
472 * send a removal command.
475 IWL_DEBUG_TE(mvm
, "TE 0x%x has already ended\n", uid
);
479 /* When we remove a TE, the UID is to be set in the id field */
480 time_cmd
.id
= cpu_to_le32(uid
);
481 time_cmd
.action
= cpu_to_le32(FW_CTXT_ACTION_REMOVE
);
482 time_cmd
.id_and_color
=
483 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif
->id
, mvmvif
->color
));
485 IWL_DEBUG_TE(mvm
, "Removing TE 0x%x\n", le32_to_cpu(time_cmd
.id
));
486 ret
= iwl_mvm_send_time_event_cmd(mvm
, &time_cmd
);
491 void iwl_mvm_stop_session_protection(struct iwl_mvm
*mvm
,
492 struct ieee80211_vif
*vif
)
494 struct iwl_mvm_vif
*mvmvif
= iwl_mvm_vif_from_mac80211(vif
);
495 struct iwl_mvm_time_event_data
*te_data
= &mvmvif
->time_event_data
;
497 lockdep_assert_held(&mvm
->mutex
);
498 iwl_mvm_remove_time_event(mvm
, mvmvif
, te_data
);
501 int iwl_mvm_start_p2p_roc(struct iwl_mvm
*mvm
, struct ieee80211_vif
*vif
,
502 int duration
, enum ieee80211_roc_type type
)
504 struct iwl_mvm_vif
*mvmvif
= iwl_mvm_vif_from_mac80211(vif
);
505 struct iwl_mvm_time_event_data
*te_data
= &mvmvif
->time_event_data
;
506 struct iwl_time_event_cmd_v2 time_cmd
= {};
508 lockdep_assert_held(&mvm
->mutex
);
509 if (te_data
->running
) {
510 IWL_WARN(mvm
, "P2P_DEVICE remain on channel already running\n");
515 * Flush the done work, just in case it's still pending, so that
516 * the work it does can complete and we can accept new frames.
518 flush_work(&mvm
->roc_done_wk
);
520 time_cmd
.action
= cpu_to_le32(FW_CTXT_ACTION_ADD
);
521 time_cmd
.id_and_color
=
522 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif
->id
, mvmvif
->color
));
525 case IEEE80211_ROC_TYPE_NORMAL
:
526 time_cmd
.id
= cpu_to_le32(IWL_MVM_ROC_TE_TYPE_NORMAL
);
528 case IEEE80211_ROC_TYPE_MGMT_TX
:
529 time_cmd
.id
= cpu_to_le32(IWL_MVM_ROC_TE_TYPE_MGMT_TX
);
532 WARN_ONCE(1, "Got an invalid ROC type\n");
536 time_cmd
.apply_time
= cpu_to_le32(0);
537 time_cmd
.interval
= cpu_to_le32(1);
540 * The P2P Device TEs can have lower priority than other events
541 * that are being scheduled by the driver/fw, and thus it might not be
542 * scheduled. To improve the chances of it being scheduled, allow them
543 * to be fragmented, and in addition allow them to be delayed.
545 time_cmd
.max_frags
= min(MSEC_TO_TU(duration
)/50, TE_V2_FRAG_ENDLESS
);
546 time_cmd
.max_delay
= cpu_to_le32(MSEC_TO_TU(duration
/2));
547 time_cmd
.duration
= cpu_to_le32(MSEC_TO_TU(duration
));
549 time_cmd
.policy
= cpu_to_le16(TE_V2_NOTIF_HOST_EVENT_START
|
550 TE_V2_NOTIF_HOST_EVENT_END
);
552 return iwl_mvm_time_event_send_add(mvm
, vif
, te_data
, &time_cmd
);
555 void iwl_mvm_stop_p2p_roc(struct iwl_mvm
*mvm
)
557 struct iwl_mvm_vif
*mvmvif
;
558 struct iwl_mvm_time_event_data
*te_data
;
560 lockdep_assert_held(&mvm
->mutex
);
563 * Iterate over the list of time events and find the time event that is
564 * associated with a P2P_DEVICE interface.
565 * This assumes that a P2P_DEVICE interface can have only a single time
566 * event at any given time and this time event coresponds to a ROC
570 spin_lock_bh(&mvm
->time_event_lock
);
571 list_for_each_entry(te_data
, &mvm
->time_event_list
, list
) {
572 if (te_data
->vif
->type
== NL80211_IFTYPE_P2P_DEVICE
) {
573 mvmvif
= iwl_mvm_vif_from_mac80211(te_data
->vif
);
577 spin_unlock_bh(&mvm
->time_event_lock
);
580 IWL_WARN(mvm
, "P2P_DEVICE no remain on channel event\n");
584 iwl_mvm_remove_time_event(mvm
, mvmvif
, te_data
);
586 iwl_mvm_roc_finished(mvm
);