drivers/net/wireless/iwlwifi/mvm/fw.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 LICENSE.GPL.
  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 #include <net/mac80211.h>
  64
  65 #include "iwl-trans.h"
  66 #include "iwl-op-mode.h"
  67 #include "iwl-fw.h"
  68 #include "iwl-debug.h"
  69 #include "iwl-csr.h" /* for iwl_mvm_rx_card_state_notif */
  70 #include "iwl-io.h" /* for iwl_mvm_rx_card_state_notif */
  71 #include "iwl-eeprom-parse.h"
  72
  73 #include "mvm.h"
  74 #include "iwl-phy-db.h"
  75
  76 #define MVM_UCODE_ALIVE_TIMEOUT HZ
  77 #define MVM_UCODE_CALIB_TIMEOUT (2*HZ)
  78
  79 #define UCODE_VALID_OK  cpu_to_le32(0x1)
  80
  81 /* Default calibration values for WkP - set to INIT image w/o running */
  82 static const u8 wkp_calib_values_rx_iq_skew[] = { 0x00, 0x00, 0x01, 0x00 };
  83 static const u8 wkp_calib_values_tx_iq_skew[] = { 0x01, 0x00, 0x00, 0x00 };
  84
  85 struct iwl_calib_default_data {
  86         u16 size;
  87         void *data;
  88 };
  89
  90 #define CALIB_SIZE_N_DATA(_buf) {.size = sizeof(_buf), .data = &_buf}
  91
  92 static const struct iwl_calib_default_data wkp_calib_default_data[12] = {
  93         [9] = CALIB_SIZE_N_DATA(wkp_calib_values_tx_iq_skew),
  94         [11] = CALIB_SIZE_N_DATA(wkp_calib_values_rx_iq_skew),
  95 };
  96
  97 struct iwl_mvm_alive_data {
  98         bool valid;
  99         u32 scd_base_addr;
 100 };
 101
 102 static inline const struct fw_img *
 103 iwl_get_ucode_image(struct iwl_mvm *mvm, enum iwl_ucode_type ucode_type)
 104 {
 105         if (ucode_type >= IWL_UCODE_TYPE_MAX)
 106                 return NULL;
 107
 108         return &mvm->fw->img[ucode_type];
 109 }
 110
 111 static int iwl_send_tx_ant_cfg(struct iwl_mvm *mvm, u8 valid_tx_ant)
 112 {
 113         struct iwl_tx_ant_cfg_cmd tx_ant_cmd = {
 114                 .valid = cpu_to_le32(valid_tx_ant),
 115         };
 116
 117         IWL_DEBUG_HC(mvm, "select valid tx ant: %u\n", valid_tx_ant);
 118         return iwl_mvm_send_cmd_pdu(mvm, TX_ANT_CONFIGURATION_CMD, CMD_SYNC,
 119                                     sizeof(tx_ant_cmd), &tx_ant_cmd);
 120 }
 121
 122 static bool iwl_alive_fn(struct iwl_notif_wait_data *notif_wait,
 123                          struct iwl_rx_packet *pkt, void *data)
 124 {
 125         struct iwl_mvm *mvm =
 126                 container_of(notif_wait, struct iwl_mvm, notif_wait);
 127         struct iwl_mvm_alive_data *alive_data = data;
 128         struct mvm_alive_resp *palive;
 129
 130         palive = (void *)pkt->data;
 131
 132         mvm->error_event_table = le32_to_cpu(palive->error_event_table_ptr);
 133         mvm->log_event_table = le32_to_cpu(palive->log_event_table_ptr);
 134         alive_data->scd_base_addr = le32_to_cpu(palive->scd_base_ptr);
 135
 136         alive_data->valid = le16_to_cpu(palive->status) == IWL_ALIVE_STATUS_OK;
 137         IWL_DEBUG_FW(mvm, "Alive ucode status 0x%04x revision 0x%01X 0x%01X\n",
 138                      le16_to_cpu(palive->status), palive->ver_type,
 139                      palive->ver_subtype);
 140
 141         return true;
 142 }
 143
 144 static bool iwl_wait_phy_db_entry(struct iwl_notif_wait_data *notif_wait,
 145                                   struct iwl_rx_packet *pkt, void *data)
 146 {
 147         struct iwl_phy_db *phy_db = data;
 148
 149         if (pkt->hdr.cmd != CALIB_RES_NOTIF_PHY_DB) {
 150                 WARN_ON(pkt->hdr.cmd != INIT_COMPLETE_NOTIF);
 151                 return true;
 152         }
 153
 154         WARN_ON(iwl_phy_db_set_section(phy_db, pkt, GFP_ATOMIC));
 155
 156         return false;
 157 }
 158
 159 static int iwl_mvm_load_ucode_wait_alive(struct iwl_mvm *mvm,
 160                                          enum iwl_ucode_type ucode_type)
 161 {
 162         struct iwl_notification_wait alive_wait;
 163         struct iwl_mvm_alive_data alive_data;
 164         const struct fw_img *fw;
 165         int ret, i;
 166         enum iwl_ucode_type old_type = mvm->cur_ucode;
 167         static const u8 alive_cmd[] = { MVM_ALIVE };
 168
 169         mvm->cur_ucode = ucode_type;
 170         fw = iwl_get_ucode_image(mvm, ucode_type);
 171
 172         mvm->ucode_loaded = false;
 173
 174         if (!fw)
 175                 return -EINVAL;
 176
 177         iwl_init_notification_wait(&mvm->notif_wait, &alive_wait,
 178                                    alive_cmd, ARRAY_SIZE(alive_cmd),
 179                                    iwl_alive_fn, &alive_data);
 180
 181         ret = iwl_trans_start_fw(mvm->trans, fw, ucode_type == IWL_UCODE_INIT);
 182         if (ret) {
 183                 mvm->cur_ucode = old_type;
 184                 iwl_remove_notification(&mvm->notif_wait, &alive_wait);
 185                 return ret;
 186         }
 187
 188         /*
 189          * Some things may run in the background now, but we
 190          * just wait for the ALIVE notification here.
 191          */
 192         ret = iwl_wait_notification(&mvm->notif_wait, &alive_wait,
 193                                     MVM_UCODE_ALIVE_TIMEOUT);
 194         if (ret) {
 195                 mvm->cur_ucode = old_type;
 196                 return ret;
 197         }
 198
 199         if (!alive_data.valid) {
 200                 IWL_ERR(mvm, "Loaded ucode is not valid!\n");
 201                 mvm->cur_ucode = old_type;
 202                 return -EIO;
 203         }
 204
 205         iwl_trans_fw_alive(mvm->trans, alive_data.scd_base_addr);
 206
 207         /*
 208          * Note: all the queues are enabled as part of the interface
 209          * initialization, but in firmware restart scenarios they
 210          * could be stopped, so wake them up. In firmware restart,
 211          * mac80211 will have the queues stopped as well until the
 212          * reconfiguration completes. During normal startup, they
 213          * will be empty.
 214          */
 215
 216         for (i = 0; i < IWL_MAX_HW_QUEUES; i++) {
 217                 if (i < IWL_MVM_FIRST_AGG_QUEUE && i != IWL_MVM_CMD_QUEUE)
 218                         mvm->queue_to_mac80211[i] = i;
 219                 else
 220                         mvm->queue_to_mac80211[i] = IWL_INVALID_MAC80211_QUEUE;
 221                 atomic_set(&mvm->queue_stop_count[i], 0);
 222         }
 223
 224         mvm->transport_queue_stop = 0;
 225
 226         mvm->ucode_loaded = true;
 227
 228         return 0;
 229 }
 230
 231 static int iwl_send_phy_cfg_cmd(struct iwl_mvm *mvm)
 232 {
 233         struct iwl_phy_cfg_cmd phy_cfg_cmd;
 234         enum iwl_ucode_type ucode_type = mvm->cur_ucode;
 235
 236         /* Set parameters */
 237         phy_cfg_cmd.phy_cfg = cpu_to_le32(mvm->fw->phy_config);
 238         phy_cfg_cmd.calib_control.event_trigger =
 239                 mvm->fw->default_calib[ucode_type].event_trigger;
 240         phy_cfg_cmd.calib_control.flow_trigger =
 241                 mvm->fw->default_calib[ucode_type].flow_trigger;
 242
 243         IWL_DEBUG_INFO(mvm, "Sending Phy CFG command: 0x%x\n",
 244                        phy_cfg_cmd.phy_cfg);
 245
 246         return iwl_mvm_send_cmd_pdu(mvm, PHY_CONFIGURATION_CMD, CMD_SYNC,
 247                                     sizeof(phy_cfg_cmd), &phy_cfg_cmd);
 248 }
 249
 250 static int iwl_set_default_calibrations(struct iwl_mvm *mvm)
 251 {
 252         u8 cmd_raw[16]; /* holds the variable size commands */
 253         struct iwl_set_calib_default_cmd *cmd =
 254                 (struct iwl_set_calib_default_cmd *)cmd_raw;
 255         int ret, i;
 256
 257         /* Setting default values for calibrations we don't run */
 258         for (i = 0; i < ARRAY_SIZE(wkp_calib_default_data); i++) {
 259                 u16 cmd_len;
 260
 261                 if (wkp_calib_default_data[i].size == 0)
 262                         continue;
 263
 264                 memset(cmd_raw, 0, sizeof(cmd_raw));
 265                 cmd_len = wkp_calib_default_data[i].size + sizeof(cmd);
 266                 cmd->calib_index = cpu_to_le16(i);
 267                 cmd->length = cpu_to_le16(wkp_calib_default_data[i].size);
 268                 if (WARN_ONCE(cmd_len > sizeof(cmd_raw),
 269                               "Need to enlarge cmd_raw to %d\n", cmd_len))
 270                         break;
 271                 memcpy(cmd->data, wkp_calib_default_data[i].data,
 272                        wkp_calib_default_data[i].size);
 273                 ret = iwl_mvm_send_cmd_pdu(mvm, SET_CALIB_DEFAULT_CMD, 0,
 274                                            sizeof(*cmd) +
 275                                            wkp_calib_default_data[i].size,
 276                                            cmd);
 277                 if (ret)
 278                         return ret;
 279         }
 280
 281         return 0;
 282 }
 283
 284 int iwl_run_init_mvm_ucode(struct iwl_mvm *mvm, bool read_nvm)
 285 {
 286         struct iwl_notification_wait calib_wait;
 287         static const u8 init_complete[] = {
 288                 INIT_COMPLETE_NOTIF,
 289                 CALIB_RES_NOTIF_PHY_DB
 290         };
 291         int ret;
 292
 293         lockdep_assert_held(&mvm->mutex);
 294
 295         if (mvm->init_ucode_run)
 296                 return 0;
 297
 298         iwl_init_notification_wait(&mvm->notif_wait,
 299                                    &calib_wait,
 300                                    init_complete,
 301                                    ARRAY_SIZE(init_complete),
 302                                    iwl_wait_phy_db_entry,
 303                                    mvm->phy_db);
 304
 305         /* Will also start the device */
 306         ret = iwl_mvm_load_ucode_wait_alive(mvm, IWL_UCODE_INIT);
 307         if (ret) {
 308                 IWL_ERR(mvm, "Failed to start INIT ucode: %d\n", ret);
 309                 goto error;
 310         }
 311
 312         if (read_nvm) {
 313                 /* Read nvm */
 314                 ret = iwl_nvm_init(mvm);
 315                 if (ret) {
 316                         IWL_ERR(mvm, "Failed to read NVM: %d\n", ret);
 317                         goto error;
 318                 }
 319         }
 320
 321         ret = iwl_nvm_check_version(mvm->nvm_data, mvm->trans);
 322         WARN_ON(ret);
 323
 324         /* Send TX valid antennas before triggering calibrations */
 325         ret = iwl_send_tx_ant_cfg(mvm, mvm->nvm_data->valid_tx_ant);
 326         if (ret)
 327                 goto error;
 328
 329         /* WkP doesn't have all calibrations, need to set default values */
 330         if (mvm->cfg->device_family == IWL_DEVICE_FAMILY_7000) {
 331                 ret = iwl_set_default_calibrations(mvm);
 332                 if (ret)
 333                         goto error;
 334         }
 335
 336         /*
 337          * Send phy configurations command to init uCode
 338          * to start the 16.0 uCode init image internal calibrations.
 339          */
 340         ret = iwl_send_phy_cfg_cmd(mvm);
 341         if (ret) {
 342                 IWL_ERR(mvm, "Failed to run INIT calibrations: %d\n",
 343                         ret);
 344                 goto error;
 345         }
 346
 347         /*
 348          * Some things may run in the background now, but we
 349          * just wait for the calibration complete notification.
 350          */
 351         ret = iwl_wait_notification(&mvm->notif_wait, &calib_wait,
 352                         MVM_UCODE_CALIB_TIMEOUT);
 353         if (!ret)
 354                 mvm->init_ucode_run = true;
 355         goto out;
 356
 357 error:
 358         iwl_remove_notification(&mvm->notif_wait, &calib_wait);
 359 out:
 360         if (!iwlmvm_mod_params.init_dbg) {
 361                 iwl_trans_stop_device(mvm->trans);
 362         } else if (!mvm->nvm_data) {
 363                 /* we want to debug INIT and we have no NVM - fake */
 364                 mvm->nvm_data = kzalloc(sizeof(struct iwl_nvm_data) +
 365                                         sizeof(struct ieee80211_channel) +
 366                                         sizeof(struct ieee80211_rate),
 367                                         GFP_KERNEL);
 368                 if (!mvm->nvm_data)
 369                         return -ENOMEM;
 370                 mvm->nvm_data->valid_rx_ant = 1;
 371                 mvm->nvm_data->valid_tx_ant = 1;
 372                 mvm->nvm_data->bands[0].channels = mvm->nvm_data->channels;
 373                 mvm->nvm_data->bands[0].n_channels = 1;
 374                 mvm->nvm_data->bands[0].n_bitrates = 1;
 375                 mvm->nvm_data->bands[0].bitrates =
 376                         (void *)mvm->nvm_data->channels + 1;
 377                 mvm->nvm_data->bands[0].bitrates->hw_value = 10;
 378         }
 379
 380         return ret;
 381 }
 382
 383 #define UCODE_CALIB_TIMEOUT     (2*HZ)
 384
 385 int iwl_mvm_up(struct iwl_mvm *mvm)
 386 {
 387         int ret, i;
 388
 389         lockdep_assert_held(&mvm->mutex);
 390
 391         ret = iwl_trans_start_hw(mvm->trans);
 392         if (ret)
 393                 return ret;
 394
 395         /* If we were in RFKILL during module loading, load init ucode now */
 396         if (!mvm->init_ucode_run) {
 397                 ret = iwl_run_init_mvm_ucode(mvm, false);
 398                 if (ret && !iwlmvm_mod_params.init_dbg) {
 399                         IWL_ERR(mvm, "Failed to run INIT ucode: %d\n", ret);
 400                         goto error;
 401                 }
 402         }
 403
 404         if (iwlmvm_mod_params.init_dbg)
 405                 return 0;
 406
 407         ret = iwl_mvm_load_ucode_wait_alive(mvm, IWL_UCODE_REGULAR);
 408         if (ret) {
 409                 IWL_ERR(mvm, "Failed to start RT ucode: %d\n", ret);
 410                 goto error;
 411         }
 412
 413         ret = iwl_send_tx_ant_cfg(mvm, mvm->nvm_data->valid_tx_ant);
 414         if (ret)
 415                 goto error;
 416
 417         /* Send phy db control command and then phy db calibration*/
 418         ret = iwl_send_phy_db_data(mvm->phy_db);
 419         if (ret)
 420                 goto error;
 421
 422         ret = iwl_send_phy_cfg_cmd(mvm);
 423         if (ret)
 424                 goto error;
 425
 426         /* init the fw <-> mac80211 STA mapping */
 427         for (i = 0; i < IWL_MVM_STATION_COUNT; i++)
 428                 RCU_INIT_POINTER(mvm->fw_id_to_mac_id[i], NULL);
 429
 430         /* Add auxiliary station for scanning */
 431         ret = iwl_mvm_add_aux_sta(mvm);
 432         if (ret)
 433                 goto error;
 434
 435         IWL_DEBUG_INFO(mvm, "RT uCode started.\n");
 436
 437         return 0;
 438  error:
 439         iwl_trans_stop_device(mvm->trans);
 440         return ret;
 441 }
 442
 443 int iwl_mvm_load_d3_fw(struct iwl_mvm *mvm)
 444 {
 445         int ret, i;
 446
 447         lockdep_assert_held(&mvm->mutex);
 448
 449         ret = iwl_trans_start_hw(mvm->trans);
 450         if (ret)
 451                 return ret;
 452
 453         ret = iwl_mvm_load_ucode_wait_alive(mvm, IWL_UCODE_WOWLAN);
 454         if (ret) {
 455                 IWL_ERR(mvm, "Failed to start WoWLAN firmware: %d\n", ret);
 456                 goto error;
 457         }
 458
 459         ret = iwl_send_tx_ant_cfg(mvm, mvm->nvm_data->valid_tx_ant);
 460         if (ret)
 461                 goto error;
 462
 463         /* Send phy db control command and then phy db calibration*/
 464         ret = iwl_send_phy_db_data(mvm->phy_db);
 465         if (ret)
 466                 goto error;
 467
 468         ret = iwl_send_phy_cfg_cmd(mvm);
 469         if (ret)
 470                 goto error;
 471
 472         /* init the fw <-> mac80211 STA mapping */
 473         for (i = 0; i < IWL_MVM_STATION_COUNT; i++)
 474                 RCU_INIT_POINTER(mvm->fw_id_to_mac_id[i], NULL);
 475
 476         /* Add auxiliary station for scanning */
 477         ret = iwl_mvm_add_aux_sta(mvm);
 478         if (ret)
 479                 goto error;
 480
 481         return 0;
 482  error:
 483         iwl_trans_stop_device(mvm->trans);
 484         return ret;
 485 }
 486
 487 int iwl_mvm_rx_card_state_notif(struct iwl_mvm *mvm,
 488                                     struct iwl_rx_cmd_buffer *rxb,
 489                                     struct iwl_device_cmd *cmd)
 490 {
 491         struct iwl_rx_packet *pkt = rxb_addr(rxb);
 492         struct iwl_card_state_notif *card_state_notif = (void *)pkt->data;
 493         u32 flags = le32_to_cpu(card_state_notif->flags);
 494
 495         IWL_DEBUG_RF_KILL(mvm, "Card state received: HW:%s SW:%s CT:%s\n",
 496                           (flags & HW_CARD_DISABLED) ? "Kill" : "On",
 497                           (flags & SW_CARD_DISABLED) ? "Kill" : "On",
 498                           (flags & CT_KILL_CARD_DISABLED) ?
 499                           "Reached" : "Not reached");
 500
 501         return 0;
 502 }
 503
 504 int iwl_mvm_rx_radio_ver(struct iwl_mvm *mvm, struct iwl_rx_cmd_buffer *rxb,
 505                          struct iwl_device_cmd *cmd)
 506 {
 507         struct iwl_rx_packet *pkt = rxb_addr(rxb);
 508         struct iwl_radio_version_notif *radio_version = (void *)pkt->data;
 509
 510         /* TODO: what to do with that? */
 511         IWL_DEBUG_INFO(mvm,
 512                        "Radio version: flavor: 0x%08x, step 0x%08x, dash 0x%08x\n",
 513                        le32_to_cpu(radio_version->radio_flavor),
 514                        le32_to_cpu(radio_version->radio_step),
 515                        le32_to_cpu(radio_version->radio_dash));
 516         return 0;
 517 }