drivers/net/wireless/iwlwifi/mvm/time-event.c

   1 /******************************************************************************
   2  *
   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.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
   9  *
  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.
  13  *
  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.
  18  *
  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,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called COPYING.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2012 - 2013 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  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
  45  *    distribution.
  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.
  49  *
  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.
  61  *
  62  *****************************************************************************/
  63
  64 #include <linux/jiffies.h>
  65 #include <net/mac80211.h>
  66
  67 #include "iwl-notif-wait.h"
  68 #include "iwl-trans.h"
  69 #include "fw-api.h"
  70 #include "time-event.h"
  71 #include "mvm.h"
  72 #include "iwl-io.h"
  73 #include "iwl-prph.h"
  74
  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)
  78
  79 /*
  80  * For the high priority TE use a time event type that has similar priority to
  81  * the FW's action scan priority.
  82  */
  83 #define IWL_MVM_ROC_TE_TYPE_NORMAL TE_P2P_DEVICE_DISCOVERABLE
  84 #define IWL_MVM_ROC_TE_TYPE_MGMT_TX TE_P2P_CLIENT_ASSOC
  85
  86 void iwl_mvm_te_clear_data(struct iwl_mvm *mvm,
  87                            struct iwl_mvm_time_event_data *te_data)
  88 {
  89         lockdep_assert_held(&mvm->time_event_lock);
  90
  91         if (te_data->id == TE_MAX)
  92                 return;
  93
  94         list_del(&te_data->list);
  95         te_data->running = false;
  96         te_data->uid = 0;
  97         te_data->id = TE_MAX;
  98         te_data->vif = NULL;
  99 }
 100
 101 void iwl_mvm_roc_done_wk(struct work_struct *wk)
 102 {
 103         struct iwl_mvm *mvm = container_of(wk, struct iwl_mvm, roc_done_wk);
 104
 105         synchronize_net();
 106
 107         /*
 108          * Flush the offchannel queue -- this is called when the time
 109          * event finishes or is cancelled, so that frames queued for it
 110          * won't get stuck on the queue and be transmitted in the next
 111          * time event.
 112          * We have to send the command asynchronously since this cannot
 113          * be under the mutex for locking reasons, but that's not an
 114          * issue as it will have to complete before the next command is
 115          * executed, and a new time event means a new command.
 116          */
 117         iwl_mvm_flush_tx_path(mvm, BIT(IWL_MVM_OFFCHANNEL_QUEUE), false);
 118 }
 119
 120 static void iwl_mvm_roc_finished(struct iwl_mvm *mvm)
 121 {
 122         /*
 123          * First, clear the ROC_RUNNING status bit. This will cause the TX
 124          * path to drop offchannel transmissions. That would also be done
 125          * by mac80211, but it is racy, in particular in the case that the
 126          * time event actually completed in the firmware (which is handled
 127          * in iwl_mvm_te_handle_notif).
 128          */
 129         clear_bit(IWL_MVM_STATUS_ROC_RUNNING, &mvm->status);
 130
 131         /*
 132          * Of course, our status bit is just as racy as mac80211, so in
 133          * addition, fire off the work struct which will drop all frames
 134          * from the hardware queues that made it through the race. First
 135          * it will of course synchronize the TX path to make sure that
 136          * any *new* TX will be rejected.
 137          */
 138         schedule_work(&mvm->roc_done_wk);
 139 }
 140
 141 /*
 142  * Handles a FW notification for an event that is known to the driver.
 143  *
 144  * @mvm: the mvm component
 145  * @te_data: the time event data
 146  * @notif: the notification data corresponding the time event data.
 147  */
 148 static void iwl_mvm_te_handle_notif(struct iwl_mvm *mvm,
 149                                     struct iwl_mvm_time_event_data *te_data,
 150                                     struct iwl_time_event_notif *notif)
 151 {
 152         lockdep_assert_held(&mvm->time_event_lock);
 153
 154         IWL_DEBUG_TE(mvm, "Handle time event notif - UID = 0x%x action %d\n",
 155                      le32_to_cpu(notif->unique_id),
 156                      le32_to_cpu(notif->action));
 157
 158         /*
 159          * The FW sends the start/end time event notifications even for events
 160          * that it fails to schedule. This is indicated in the status field of
 161          * the notification. This happens in cases that the scheduler cannot
 162          * find a schedule that can handle the event (for example requesting a
 163          * P2P Device discoveribility, while there are other higher priority
 164          * events in the system).
 165          */
 166         WARN_ONCE(!le32_to_cpu(notif->status),
 167                   "Failed to schedule time event\n");
 168
 169         if (le32_to_cpu(notif->action) & TE_NOTIF_HOST_EVENT_END) {
 170                 IWL_DEBUG_TE(mvm,
 171                              "TE ended - current time %lu, estimated end %lu\n",
 172                              jiffies, te_data->end_jiffies);
 173
 174                 if (te_data->vif->type == NL80211_IFTYPE_P2P_DEVICE) {
 175                         ieee80211_remain_on_channel_expired(mvm->hw);
 176                         iwl_mvm_roc_finished(mvm);
 177                 }
 178
 179                 /*
 180                  * By now, we should have finished association
 181                  * and know the dtim period.
 182                  */
 183                 if (te_data->vif->type == NL80211_IFTYPE_STATION &&
 184                     (!te_data->vif->bss_conf.assoc ||
 185                      !te_data->vif->bss_conf.dtim_period)) {
 186                         IWL_ERR(mvm,
 187                                 "No association and the time event is over already...\n");
 188                         ieee80211_connection_loss(te_data->vif);
 189                 }
 190
 191                 iwl_mvm_te_clear_data(mvm, te_data);
 192         } else if (le32_to_cpu(notif->action) & TE_NOTIF_HOST_EVENT_START) {
 193                 te_data->running = true;
 194                 te_data->end_jiffies = jiffies +
 195                         TU_TO_JIFFIES(te_data->duration);
 196
 197                 if (te_data->vif->type == NL80211_IFTYPE_P2P_DEVICE) {
 198                         set_bit(IWL_MVM_STATUS_ROC_RUNNING, &mvm->status);
 199                         ieee80211_ready_on_channel(mvm->hw);
 200                 }
 201         } else {
 202                 IWL_WARN(mvm, "Got TE with unknown action\n");
 203         }
 204 }
 205
 206 /*
 207  * The Rx handler for time event notifications
 208  */
 209 int iwl_mvm_rx_time_event_notif(struct iwl_mvm *mvm,
 210                                 struct iwl_rx_cmd_buffer *rxb,
 211                                 struct iwl_device_cmd *cmd)
 212 {
 213         struct iwl_rx_packet *pkt = rxb_addr(rxb);
 214         struct iwl_time_event_notif *notif = (void *)pkt->data;
 215         struct iwl_mvm_time_event_data *te_data, *tmp;
 216
 217         IWL_DEBUG_TE(mvm, "Time event notification - UID = 0x%x action %d\n",
 218                      le32_to_cpu(notif->unique_id),
 219                      le32_to_cpu(notif->action));
 220
 221         spin_lock_bh(&mvm->time_event_lock);
 222         list_for_each_entry_safe(te_data, tmp, &mvm->time_event_list, list) {
 223                 if (le32_to_cpu(notif->unique_id) == te_data->uid)
 224                         iwl_mvm_te_handle_notif(mvm, te_data, notif);
 225         }
 226         spin_unlock_bh(&mvm->time_event_lock);
 227
 228         return 0;
 229 }
 230
 231 static bool iwl_mvm_time_event_response(struct iwl_notif_wait_data *notif_wait,
 232                                         struct iwl_rx_packet *pkt, void *data)
 233 {
 234         struct iwl_mvm *mvm =
 235                 container_of(notif_wait, struct iwl_mvm, notif_wait);
 236         struct iwl_mvm_time_event_data *te_data = data;
 237         struct iwl_time_event_resp *resp;
 238         int resp_len = le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
 239
 240         if (WARN_ON(pkt->hdr.cmd != TIME_EVENT_CMD))
 241                 return true;
 242
 243         if (WARN_ON_ONCE(resp_len != sizeof(pkt->hdr) + sizeof(*resp))) {
 244                 IWL_ERR(mvm, "Invalid TIME_EVENT_CMD response\n");
 245                 return true;
 246         }
 247
 248         resp = (void *)pkt->data;
 249
 250         /* we should never get a response to another TIME_EVENT_CMD here */
 251         if (WARN_ON_ONCE(le32_to_cpu(resp->id) != te_data->id))
 252                 return false;
 253
 254         te_data->uid = le32_to_cpu(resp->unique_id);
 255         IWL_DEBUG_TE(mvm, "TIME_EVENT_CMD response - UID = 0x%x\n",
 256                      te_data->uid);
 257         return true;
 258 }
 259
 260 static int iwl_mvm_time_event_send_add(struct iwl_mvm *mvm,
 261                                        struct ieee80211_vif *vif,
 262                                        struct iwl_mvm_time_event_data *te_data,
 263                                        struct iwl_time_event_cmd *te_cmd)
 264 {
 265         static const u8 time_event_response[] = { TIME_EVENT_CMD };
 266         struct iwl_notification_wait wait_time_event;
 267         int ret;
 268
 269         lockdep_assert_held(&mvm->mutex);
 270
 271         IWL_DEBUG_TE(mvm, "Add new TE, duration %d TU\n",
 272                      le32_to_cpu(te_cmd->duration));
 273
 274         spin_lock_bh(&mvm->time_event_lock);
 275         if (WARN_ON(te_data->id != TE_MAX)) {
 276                 spin_unlock_bh(&mvm->time_event_lock);
 277                 return -EIO;
 278         }
 279         te_data->vif = vif;
 280         te_data->duration = le32_to_cpu(te_cmd->duration);
 281         te_data->id = le32_to_cpu(te_cmd->id);
 282         list_add_tail(&te_data->list, &mvm->time_event_list);
 283         spin_unlock_bh(&mvm->time_event_lock);
 284
 285         /*
 286          * Use a notification wait, which really just processes the
 287          * command response and doesn't wait for anything, in order
 288          * to be able to process the response and get the UID inside
 289          * the RX path. Using CMD_WANT_SKB doesn't work because it
 290          * stores the buffer and then wakes up this thread, by which
 291          * time another notification (that the time event started)
 292          * might already be processed unsuccessfully.
 293          */
 294         iwl_init_notification_wait(&mvm->notif_wait, &wait_time_event,
 295                                    time_event_response,
 296                                    ARRAY_SIZE(time_event_response),
 297                                    iwl_mvm_time_event_response, te_data);
 298
 299         ret = iwl_mvm_send_cmd_pdu(mvm, TIME_EVENT_CMD, CMD_SYNC,
 300                                    sizeof(*te_cmd), te_cmd);
 301         if (ret) {
 302                 IWL_ERR(mvm, "Couldn't send TIME_EVENT_CMD: %d\n", ret);
 303                 iwl_remove_notification(&mvm->notif_wait, &wait_time_event);
 304                 goto out_clear_te;
 305         }
 306
 307         /* No need to wait for anything, so just pass 1 (0 isn't valid) */
 308         ret = iwl_wait_notification(&mvm->notif_wait, &wait_time_event, 1);
 309         /* should never fail */
 310         WARN_ON_ONCE(ret);
 311
 312         if (ret) {
 313  out_clear_te:
 314                 spin_lock_bh(&mvm->time_event_lock);
 315                 iwl_mvm_te_clear_data(mvm, te_data);
 316                 spin_unlock_bh(&mvm->time_event_lock);
 317         }
 318         return ret;
 319 }
 320
 321 void iwl_mvm_protect_session(struct iwl_mvm *mvm,
 322                              struct ieee80211_vif *vif,
 323                              u32 duration, u32 min_duration)
 324 {
 325         struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
 326         struct iwl_mvm_time_event_data *te_data = &mvmvif->time_event_data;
 327         struct iwl_time_event_cmd time_cmd = {};
 328
 329         lockdep_assert_held(&mvm->mutex);
 330
 331         if (te_data->running &&
 332             time_after(te_data->end_jiffies,
 333                        jiffies + TU_TO_JIFFIES(min_duration))) {
 334                 IWL_DEBUG_TE(mvm, "We have enough time in the current TE: %u\n",
 335                              jiffies_to_msecs(te_data->end_jiffies - jiffies));
 336                 return;
 337         }
 338
 339         if (te_data->running) {
 340                 IWL_DEBUG_TE(mvm, "extend 0x%x: only %u ms left\n",
 341                              te_data->uid,
 342                              jiffies_to_msecs(te_data->end_jiffies - jiffies));
 343                 /*
 344                  * we don't have enough time
 345                  * cancel the current TE and issue a new one
 346                  * Of course it would be better to remove the old one only
 347                  * when the new one is added, but we don't care if we are off
 348                  * channel for a bit. All we need to do, is not to return
 349                  * before we actually begin to be on the channel.
 350                  */
 351                 iwl_mvm_stop_session_protection(mvm, vif);
 352         }
 353
 354         time_cmd.action = cpu_to_le32(FW_CTXT_ACTION_ADD);
 355         time_cmd.id_and_color =
 356                 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color));
 357         time_cmd.id = cpu_to_le32(TE_BSS_STA_AGGRESSIVE_ASSOC);
 358
 359         time_cmd.apply_time =
 360                 cpu_to_le32(iwl_read_prph(mvm->trans, DEVICE_SYSTEM_TIME_REG));
 361
 362         time_cmd.dep_policy = TE_INDEPENDENT;
 363         time_cmd.is_present = cpu_to_le32(1);
 364         time_cmd.max_frags = cpu_to_le32(TE_FRAG_NONE);
 365         time_cmd.max_delay = cpu_to_le32(500);
 366         /* TODO: why do we need to interval = bi if it is not periodic? */
 367         time_cmd.interval = cpu_to_le32(1);
 368         time_cmd.interval_reciprocal = cpu_to_le32(iwl_mvm_reciprocal(1));
 369         time_cmd.duration = cpu_to_le32(duration);
 370         time_cmd.repeat = cpu_to_le32(1);
 371         time_cmd.notify = cpu_to_le32(TE_NOTIF_HOST_EVENT_START |
 372                                       TE_NOTIF_HOST_EVENT_END);
 373
 374         iwl_mvm_time_event_send_add(mvm, vif, te_data, &time_cmd);
 375 }
 376
 377 /*
 378  * Explicit request to remove a time event. The removal of a time event needs to
 379  * be synchronized with the flow of a time event's end notification, which also
 380  * removes the time event from the op mode data structures.
 381  */
 382 void iwl_mvm_remove_time_event(struct iwl_mvm *mvm,
 383                                struct iwl_mvm_vif *mvmvif,
 384                                struct iwl_mvm_time_event_data *te_data)
 385 {
 386         struct iwl_time_event_cmd time_cmd = {};
 387         u32 id, uid;
 388         int ret;
 389
 390         /*
 391          * It is possible that by the time we got to this point the time
 392          * event was already removed.
 393          */
 394         spin_lock_bh(&mvm->time_event_lock);
 395
 396         /* Save time event uid before clearing its data */
 397         uid = te_data->uid;
 398         id = te_data->id;
 399
 400         /*
 401          * The clear_data function handles time events that were already removed
 402          */
 403         iwl_mvm_te_clear_data(mvm, te_data);
 404         spin_unlock_bh(&mvm->time_event_lock);
 405
 406         /*
 407          * It is possible that by the time we try to remove it, the time event
 408          * has already ended and removed. In such a case there is no need to
 409          * send a removal command.
 410          */
 411         if (id == TE_MAX) {
 412                 IWL_DEBUG_TE(mvm, "TE 0x%x has already ended\n", uid);
 413                 return;
 414         }
 415
 416         /* When we remove a TE, the UID is to be set in the id field */
 417         time_cmd.id = cpu_to_le32(uid);
 418         time_cmd.action = cpu_to_le32(FW_CTXT_ACTION_REMOVE);
 419         time_cmd.id_and_color =
 420                 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color));
 421
 422         IWL_DEBUG_TE(mvm, "Removing TE 0x%x\n", le32_to_cpu(time_cmd.id));
 423         ret = iwl_mvm_send_cmd_pdu(mvm, TIME_EVENT_CMD, CMD_SYNC,
 424                                    sizeof(time_cmd), &time_cmd);
 425         if (WARN_ON(ret))
 426                 return;
 427 }
 428
 429 void iwl_mvm_stop_session_protection(struct iwl_mvm *mvm,
 430                                      struct ieee80211_vif *vif)
 431 {
 432         struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
 433         struct iwl_mvm_time_event_data *te_data = &mvmvif->time_event_data;
 434
 435         lockdep_assert_held(&mvm->mutex);
 436         iwl_mvm_remove_time_event(mvm, mvmvif, te_data);
 437 }
 438
 439 int iwl_mvm_start_p2p_roc(struct iwl_mvm *mvm, struct ieee80211_vif *vif,
 440                           int duration, enum ieee80211_roc_type type)
 441 {
 442         struct iwl_mvm_vif *mvmvif = iwl_mvm_vif_from_mac80211(vif);
 443         struct iwl_mvm_time_event_data *te_data = &mvmvif->time_event_data;
 444         struct iwl_time_event_cmd time_cmd = {};
 445
 446         lockdep_assert_held(&mvm->mutex);
 447         if (te_data->running) {
 448                 IWL_WARN(mvm, "P2P_DEVICE remain on channel already running\n");
 449                 return -EBUSY;
 450         }
 451
 452         /*
 453          * Flush the done work, just in case it's still pending, so that
 454          * the work it does can complete and we can accept new frames.
 455          */
 456         flush_work(&mvm->roc_done_wk);
 457
 458         time_cmd.action = cpu_to_le32(FW_CTXT_ACTION_ADD);
 459         time_cmd.id_and_color =
 460                 cpu_to_le32(FW_CMD_ID_AND_COLOR(mvmvif->id, mvmvif->color));
 461
 462         switch (type) {
 463         case IEEE80211_ROC_TYPE_NORMAL:
 464                 time_cmd.id = cpu_to_le32(IWL_MVM_ROC_TE_TYPE_NORMAL);
 465                 break;
 466         case IEEE80211_ROC_TYPE_MGMT_TX:
 467                 time_cmd.id = cpu_to_le32(IWL_MVM_ROC_TE_TYPE_MGMT_TX);
 468                 break;
 469         default:
 470                 WARN_ONCE(1, "Got an invalid ROC type\n");
 471                 return -EINVAL;
 472         }
 473
 474         time_cmd.apply_time = cpu_to_le32(0);
 475         time_cmd.dep_policy = cpu_to_le32(TE_INDEPENDENT);
 476         time_cmd.is_present = cpu_to_le32(1);
 477         time_cmd.interval = cpu_to_le32(1);
 478
 479         /*
 480          * The P2P Device TEs can have lower priority than other events
 481          * that are being scheduled by the driver/fw, and thus it might not be
 482          * scheduled. To improve the chances of it being scheduled, allow them
 483          * to be fragmented, and in addition allow them to be delayed.
 484          */
 485         time_cmd.max_frags = cpu_to_le32(MSEC_TO_TU(duration)/20);
 486         time_cmd.max_delay = cpu_to_le32(MSEC_TO_TU(duration/2));
 487         time_cmd.duration = cpu_to_le32(MSEC_TO_TU(duration));
 488         time_cmd.repeat = cpu_to_le32(1);
 489         time_cmd.notify = cpu_to_le32(TE_NOTIF_HOST_EVENT_START |
 490                                       TE_NOTIF_HOST_EVENT_END);
 491
 492         return iwl_mvm_time_event_send_add(mvm, vif, te_data, &time_cmd);
 493 }
 494
 495 void iwl_mvm_stop_p2p_roc(struct iwl_mvm *mvm)
 496 {
 497         struct iwl_mvm_vif *mvmvif;
 498         struct iwl_mvm_time_event_data *te_data;
 499
 500         lockdep_assert_held(&mvm->mutex);
 501
 502         /*
 503          * Iterate over the list of time events and find the time event that is
 504          * associated with a P2P_DEVICE interface.
 505          * This assumes that a P2P_DEVICE interface can have only a single time
 506          * event at any given time and this time event coresponds to a ROC
 507          * request
 508          */
 509         mvmvif = NULL;
 510         spin_lock_bh(&mvm->time_event_lock);
 511         list_for_each_entry(te_data, &mvm->time_event_list, list) {
 512                 if (te_data->vif->type == NL80211_IFTYPE_P2P_DEVICE) {
 513                         mvmvif = iwl_mvm_vif_from_mac80211(te_data->vif);
 514                         break;
 515                 }
 516         }
 517         spin_unlock_bh(&mvm->time_event_lock);
 518
 519         if (!mvmvif) {
 520                 IWL_WARN(mvm, "P2P_DEVICE no remain on channel event\n");
 521                 return;
 522         }
 523
 524         iwl_mvm_remove_time_event(mvm, mvmvif, te_data);
 525
 526         iwl_mvm_roc_finished(mvm);
 527 }