drivers/net/wireless/iwlwifi/dvm/ucode.c

   1 /******************************************************************************
   2  *
   3  * GPL LICENSE SUMMARY
   4  *
   5  * Copyright(c) 2008 - 2012 Intel Corporation. All rights reserved.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of version 2 of the GNU General Public License as
   9  * published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  19  * USA
  20  *
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called LICENSE.GPL.
  23  *
  24  * Contact Information:
  25  *  Intel Linux Wireless <ilw@linux.intel.com>
  26  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  27  *
  28  *****************************************************************************/
  29
  30 #include <linux/kernel.h>
  31 #include <linux/init.h>
  32
  33 #include "iwl-io.h"
  34 #include "iwl-agn-hw.h"
  35 #include "iwl-trans.h"
  36 #include "iwl-fh.h"
  37 #include "iwl-op-mode.h"
  38
  39 #include "dev.h"
  40 #include "agn.h"
  41 #include "calib.h"
  42
  43 /******************************************************************************
  44  *
  45  * uCode download functions
  46  *
  47  ******************************************************************************/
  48
  49 static inline const struct fw_img *
  50 iwl_get_ucode_image(struct iwl_priv *priv, enum iwl_ucode_type ucode_type)
  51 {
  52         if (ucode_type >= IWL_UCODE_TYPE_MAX)
  53                 return NULL;
  54
  55         return &priv->fw->img[ucode_type];
  56 }
  57
  58 /*
  59  *  Calibration
  60  */
  61 static int iwl_set_Xtal_calib(struct iwl_priv *priv)
  62 {
  63         struct iwl_calib_xtal_freq_cmd cmd;
  64         __le16 *xtal_calib = priv->eeprom_data->xtal_calib;
  65
  66         iwl_set_calib_hdr(&cmd.hdr, IWL_PHY_CALIBRATE_CRYSTAL_FRQ_CMD);
  67         cmd.cap_pin1 = le16_to_cpu(xtal_calib[0]);
  68         cmd.cap_pin2 = le16_to_cpu(xtal_calib[1]);
  69         return iwl_calib_set(priv, (void *)&cmd, sizeof(cmd));
  70 }
  71
  72 static int iwl_set_temperature_offset_calib(struct iwl_priv *priv)
  73 {
  74         struct iwl_calib_temperature_offset_cmd cmd;
  75
  76         memset(&cmd, 0, sizeof(cmd));
  77         iwl_set_calib_hdr(&cmd.hdr, IWL_PHY_CALIBRATE_TEMP_OFFSET_CMD);
  78         cmd.radio_sensor_offset = priv->eeprom_data->raw_temperature;
  79         if (!(cmd.radio_sensor_offset))
  80                 cmd.radio_sensor_offset = DEFAULT_RADIO_SENSOR_OFFSET;
  81
  82         IWL_DEBUG_CALIB(priv, "Radio sensor offset: %d\n",
  83                         le16_to_cpu(cmd.radio_sensor_offset));
  84         return iwl_calib_set(priv, (void *)&cmd, sizeof(cmd));
  85 }
  86
  87 static int iwl_set_temperature_offset_calib_v2(struct iwl_priv *priv)
  88 {
  89         struct iwl_calib_temperature_offset_v2_cmd cmd;
  90
  91         memset(&cmd, 0, sizeof(cmd));
  92         iwl_set_calib_hdr(&cmd.hdr, IWL_PHY_CALIBRATE_TEMP_OFFSET_CMD);
  93         cmd.radio_sensor_offset_high = priv->eeprom_data->kelvin_temperature;
  94         cmd.radio_sensor_offset_low = priv->eeprom_data->raw_temperature;
  95         if (!cmd.radio_sensor_offset_low) {
  96                 IWL_DEBUG_CALIB(priv, "no info in EEPROM, use default\n");
  97                 cmd.radio_sensor_offset_low = DEFAULT_RADIO_SENSOR_OFFSET;
  98                 cmd.radio_sensor_offset_high = DEFAULT_RADIO_SENSOR_OFFSET;
  99         }
 100         cmd.burntVoltageRef = priv->eeprom_data->calib_voltage;
 101
 102         IWL_DEBUG_CALIB(priv, "Radio sensor offset high: %d\n",
 103                         le16_to_cpu(cmd.radio_sensor_offset_high));
 104         IWL_DEBUG_CALIB(priv, "Radio sensor offset low: %d\n",
 105                         le16_to_cpu(cmd.radio_sensor_offset_low));
 106         IWL_DEBUG_CALIB(priv, "Voltage Ref: %d\n",
 107                         le16_to_cpu(cmd.burntVoltageRef));
 108
 109         return iwl_calib_set(priv, (void *)&cmd, sizeof(cmd));
 110 }
 111
 112 static int iwl_send_calib_cfg(struct iwl_priv *priv)
 113 {
 114         struct iwl_calib_cfg_cmd calib_cfg_cmd;
 115         struct iwl_host_cmd cmd = {
 116                 .id = CALIBRATION_CFG_CMD,
 117                 .len = { sizeof(struct iwl_calib_cfg_cmd), },
 118                 .data = { &calib_cfg_cmd, },
 119         };
 120
 121         memset(&calib_cfg_cmd, 0, sizeof(calib_cfg_cmd));
 122         calib_cfg_cmd.ucd_calib_cfg.once.is_enable = IWL_CALIB_INIT_CFG_ALL;
 123         calib_cfg_cmd.ucd_calib_cfg.once.start = IWL_CALIB_INIT_CFG_ALL;
 124         calib_cfg_cmd.ucd_calib_cfg.once.send_res = IWL_CALIB_INIT_CFG_ALL;
 125         calib_cfg_cmd.ucd_calib_cfg.flags =
 126                 IWL_CALIB_CFG_FLAG_SEND_COMPLETE_NTFY_MSK;
 127
 128         return iwl_dvm_send_cmd(priv, &cmd);
 129 }
 130
 131 int iwl_init_alive_start(struct iwl_priv *priv)
 132 {
 133         int ret;
 134
 135         if (priv->cfg->bt_params &&
 136             priv->cfg->bt_params->advanced_bt_coexist) {
 137                 /*
 138                  * Tell uCode we are ready to perform calibration
 139                  * need to perform this before any calibration
 140                  * no need to close the envlope since we are going
 141                  * to load the runtime uCode later.
 142                  */
 143                 ret = iwl_send_bt_env(priv, IWL_BT_COEX_ENV_OPEN,
 144                         BT_COEX_PRIO_TBL_EVT_INIT_CALIB2);
 145                 if (ret)
 146                         return ret;
 147
 148         }
 149
 150         ret = iwl_send_calib_cfg(priv);
 151         if (ret)
 152                 return ret;
 153
 154         /**
 155          * temperature offset calibration is only needed for runtime ucode,
 156          * so prepare the value now.
 157          */
 158         if (priv->cfg->need_temp_offset_calib) {
 159                 if (priv->cfg->temp_offset_v2)
 160                         return iwl_set_temperature_offset_calib_v2(priv);
 161                 else
 162                         return iwl_set_temperature_offset_calib(priv);
 163         }
 164
 165         return 0;
 166 }
 167
 168 static int iwl_send_wimax_coex(struct iwl_priv *priv)
 169 {
 170         struct iwl_wimax_coex_cmd coex_cmd;
 171
 172         /* coexistence is disabled */
 173         memset(&coex_cmd, 0, sizeof(coex_cmd));
 174
 175         return iwl_dvm_send_cmd_pdu(priv,
 176                                 COEX_PRIORITY_TABLE_CMD, CMD_SYNC,
 177                                 sizeof(coex_cmd), &coex_cmd);
 178 }
 179
 180 static const u8 iwl_bt_prio_tbl[BT_COEX_PRIO_TBL_EVT_MAX] = {
 181         ((BT_COEX_PRIO_TBL_PRIO_BYPASS << IWL_BT_COEX_PRIO_TBL_PRIO_POS) |
 182                 (0 << IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS)),
 183         ((BT_COEX_PRIO_TBL_PRIO_BYPASS << IWL_BT_COEX_PRIO_TBL_PRIO_POS) |
 184                 (1 << IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS)),
 185         ((BT_COEX_PRIO_TBL_PRIO_LOW << IWL_BT_COEX_PRIO_TBL_PRIO_POS) |
 186                 (0 << IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS)),
 187         ((BT_COEX_PRIO_TBL_PRIO_LOW << IWL_BT_COEX_PRIO_TBL_PRIO_POS) |
 188                 (1 << IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS)),
 189         ((BT_COEX_PRIO_TBL_PRIO_HIGH << IWL_BT_COEX_PRIO_TBL_PRIO_POS) |
 190                 (0 << IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS)),
 191         ((BT_COEX_PRIO_TBL_PRIO_HIGH << IWL_BT_COEX_PRIO_TBL_PRIO_POS) |
 192                 (1 << IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS)),
 193         ((BT_COEX_PRIO_TBL_PRIO_BYPASS << IWL_BT_COEX_PRIO_TBL_PRIO_POS) |
 194                 (0 << IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS)),
 195         ((BT_COEX_PRIO_TBL_PRIO_COEX_OFF << IWL_BT_COEX_PRIO_TBL_PRIO_POS) |
 196                 (0 << IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS)),
 197         ((BT_COEX_PRIO_TBL_PRIO_COEX_ON << IWL_BT_COEX_PRIO_TBL_PRIO_POS) |
 198                 (0 << IWL_BT_COEX_PRIO_TBL_SHARED_ANTENNA_POS)),
 199         0, 0, 0, 0, 0, 0, 0
 200 };
 201
 202 void iwl_send_prio_tbl(struct iwl_priv *priv)
 203 {
 204         struct iwl_bt_coex_prio_table_cmd prio_tbl_cmd;
 205
 206         memcpy(prio_tbl_cmd.prio_tbl, iwl_bt_prio_tbl,
 207                 sizeof(iwl_bt_prio_tbl));
 208         if (iwl_dvm_send_cmd_pdu(priv,
 209                                 REPLY_BT_COEX_PRIO_TABLE, CMD_SYNC,
 210                                 sizeof(prio_tbl_cmd), &prio_tbl_cmd))
 211                 IWL_ERR(priv, "failed to send BT prio tbl command\n");
 212 }
 213
 214 int iwl_send_bt_env(struct iwl_priv *priv, u8 action, u8 type)
 215 {
 216         struct iwl_bt_coex_prot_env_cmd env_cmd;
 217         int ret;
 218
 219         env_cmd.action = action;
 220         env_cmd.type = type;
 221         ret = iwl_dvm_send_cmd_pdu(priv,
 222                                REPLY_BT_COEX_PROT_ENV, CMD_SYNC,
 223                                sizeof(env_cmd), &env_cmd);
 224         if (ret)
 225                 IWL_ERR(priv, "failed to send BT env command\n");
 226         return ret;
 227 }
 228
 229 static const u8 iwlagn_default_queue_to_tx_fifo[] = {
 230         IWL_TX_FIFO_VO,
 231         IWL_TX_FIFO_VI,
 232         IWL_TX_FIFO_BE,
 233         IWL_TX_FIFO_BK,
 234 };
 235
 236 static const u8 iwlagn_ipan_queue_to_tx_fifo[] = {
 237         IWL_TX_FIFO_VO,
 238         IWL_TX_FIFO_VI,
 239         IWL_TX_FIFO_BE,
 240         IWL_TX_FIFO_BK,
 241         IWL_TX_FIFO_BK_IPAN,
 242         IWL_TX_FIFO_BE_IPAN,
 243         IWL_TX_FIFO_VI_IPAN,
 244         IWL_TX_FIFO_VO_IPAN,
 245         IWL_TX_FIFO_BE_IPAN,
 246         IWL_TX_FIFO_UNUSED,
 247         IWL_TX_FIFO_AUX,
 248 };
 249
 250 static int iwl_alive_notify(struct iwl_priv *priv)
 251 {
 252         const u8 *queue_to_txf;
 253         u8 n_queues;
 254         int ret;
 255         int i;
 256
 257         iwl_trans_fw_alive(priv->trans);
 258
 259         if (priv->fw->ucode_capa.flags & IWL_UCODE_TLV_FLAGS_PAN &&
 260             priv->eeprom_data->sku & EEPROM_SKU_CAP_IPAN_ENABLE) {
 261                 n_queues = ARRAY_SIZE(iwlagn_ipan_queue_to_tx_fifo);
 262                 queue_to_txf = iwlagn_ipan_queue_to_tx_fifo;
 263         } else {
 264                 n_queues = ARRAY_SIZE(iwlagn_default_queue_to_tx_fifo);
 265                 queue_to_txf = iwlagn_default_queue_to_tx_fifo;
 266         }
 267
 268         for (i = 0; i < n_queues; i++)
 269                 if (queue_to_txf[i] != IWL_TX_FIFO_UNUSED)
 270                         iwl_trans_ac_txq_enable(priv->trans, i,
 271                                                 queue_to_txf[i]);
 272
 273         priv->passive_no_rx = false;
 274         priv->transport_queue_stop = 0;
 275
 276         ret = iwl_send_wimax_coex(priv);
 277         if (ret)
 278                 return ret;
 279
 280         if (!priv->cfg->no_xtal_calib) {
 281                 ret = iwl_set_Xtal_calib(priv);
 282                 if (ret)
 283                         return ret;
 284         }
 285
 286         return iwl_send_calib_results(priv);
 287 }
 288
 289
 290 /**
 291  * iwl_verify_inst_sparse - verify runtime uCode image in card vs. host,
 292  *   using sample data 100 bytes apart.  If these sample points are good,
 293  *   it's a pretty good bet that everything between them is good, too.
 294  */
 295 static int iwl_verify_sec_sparse(struct iwl_priv *priv,
 296                                   const struct fw_desc *fw_desc)
 297 {
 298         __le32 *image = (__le32 *)fw_desc->data;
 299         u32 len = fw_desc->len;
 300         u32 val;
 301         u32 i;
 302
 303         IWL_DEBUG_FW(priv, "ucode inst image size is %u\n", len);
 304
 305         for (i = 0; i < len; i += 100, image += 100/sizeof(u32)) {
 306                 /* read data comes through single port, auto-incr addr */
 307                 /* NOTE: Use the debugless read so we don't flood kernel log
 308                  * if IWL_DL_IO is set */
 309                 iwl_write_direct32(priv->trans, HBUS_TARG_MEM_RADDR,
 310                         i + fw_desc->offset);
 311                 val = iwl_read32(priv->trans, HBUS_TARG_MEM_RDAT);
 312                 if (val != le32_to_cpu(*image))
 313                         return -EIO;
 314         }
 315
 316         return 0;
 317 }
 318
 319 static void iwl_print_mismatch_sec(struct iwl_priv *priv,
 320                                     const struct fw_desc *fw_desc)
 321 {
 322         __le32 *image = (__le32 *)fw_desc->data;
 323         u32 len = fw_desc->len;
 324         u32 val;
 325         u32 offs;
 326         int errors = 0;
 327
 328         IWL_DEBUG_FW(priv, "ucode inst image size is %u\n", len);
 329
 330         iwl_write_direct32(priv->trans, HBUS_TARG_MEM_RADDR,
 331                                 fw_desc->offset);
 332
 333         for (offs = 0;
 334              offs < len && errors < 20;
 335              offs += sizeof(u32), image++) {
 336                 /* read data comes through single port, auto-incr addr */
 337                 val = iwl_read32(priv->trans, HBUS_TARG_MEM_RDAT);
 338                 if (val != le32_to_cpu(*image)) {
 339                         IWL_ERR(priv, "uCode INST section at "
 340                                 "offset 0x%x, is 0x%x, s/b 0x%x\n",
 341                                 offs, val, le32_to_cpu(*image));
 342                         errors++;
 343                 }
 344         }
 345 }
 346
 347 /**
 348  * iwl_verify_ucode - determine which instruction image is in SRAM,
 349  *    and verify its contents
 350  */
 351 static int iwl_verify_ucode(struct iwl_priv *priv,
 352                             enum iwl_ucode_type ucode_type)
 353 {
 354         const struct fw_img *img = iwl_get_ucode_image(priv, ucode_type);
 355
 356         if (!img) {
 357                 IWL_ERR(priv, "Invalid ucode requested (%d)\n", ucode_type);
 358                 return -EINVAL;
 359         }
 360
 361         if (!iwl_verify_sec_sparse(priv, &img->sec[IWL_UCODE_SECTION_INST])) {
 362                 IWL_DEBUG_FW(priv, "uCode is good in inst SRAM\n");
 363                 return 0;
 364         }
 365
 366         IWL_ERR(priv, "UCODE IMAGE IN INSTRUCTION SRAM NOT VALID!!\n");
 367
 368         iwl_print_mismatch_sec(priv, &img->sec[IWL_UCODE_SECTION_INST]);
 369         return -EIO;
 370 }
 371
 372 struct iwl_alive_data {
 373         bool valid;
 374         u8 subtype;
 375 };
 376
 377 static bool iwl_alive_fn(struct iwl_notif_wait_data *notif_wait,
 378                          struct iwl_rx_packet *pkt, void *data)
 379 {
 380         struct iwl_priv *priv =
 381                 container_of(notif_wait, struct iwl_priv, notif_wait);
 382         struct iwl_alive_data *alive_data = data;
 383         struct iwl_alive_resp *palive;
 384
 385         palive = (void *)pkt->data;
 386
 387         IWL_DEBUG_FW(priv, "Alive ucode status 0x%08X revision "
 388                        "0x%01X 0x%01X\n",
 389                        palive->is_valid, palive->ver_type,
 390                        palive->ver_subtype);
 391
 392         priv->device_pointers.error_event_table =
 393                 le32_to_cpu(palive->error_event_table_ptr);
 394         priv->device_pointers.log_event_table =
 395                 le32_to_cpu(palive->log_event_table_ptr);
 396
 397         alive_data->subtype = palive->ver_subtype;
 398         alive_data->valid = palive->is_valid == UCODE_VALID_OK;
 399
 400         return true;
 401 }
 402
 403 #define UCODE_ALIVE_TIMEOUT     HZ
 404 #define UCODE_CALIB_TIMEOUT     (2*HZ)
 405
 406 int iwl_load_ucode_wait_alive(struct iwl_priv *priv,
 407                                  enum iwl_ucode_type ucode_type)
 408 {
 409         struct iwl_notification_wait alive_wait;
 410         struct iwl_alive_data alive_data;
 411         const struct fw_img *fw;
 412         int ret;
 413         enum iwl_ucode_type old_type;
 414         static const u8 alive_cmd[] = { REPLY_ALIVE };
 415
 416         old_type = priv->cur_ucode;
 417         priv->cur_ucode = ucode_type;
 418         fw = iwl_get_ucode_image(priv, ucode_type);
 419
 420         priv->ucode_loaded = false;
 421
 422         if (!fw)
 423                 return -EINVAL;
 424
 425         iwl_init_notification_wait(&priv->notif_wait, &alive_wait,
 426                                    alive_cmd, ARRAY_SIZE(alive_cmd),
 427                                    iwl_alive_fn, &alive_data);
 428
 429         ret = iwl_trans_start_fw(priv->trans, fw);
 430         if (ret) {
 431                 priv->cur_ucode = old_type;
 432                 iwl_remove_notification(&priv->notif_wait, &alive_wait);
 433                 return ret;
 434         }
 435
 436         /*
 437          * Some things may run in the background now, but we
 438          * just wait for the ALIVE notification here.
 439          */
 440         ret = iwl_wait_notification(&priv->notif_wait, &alive_wait,
 441                                         UCODE_ALIVE_TIMEOUT);
 442         if (ret) {
 443                 priv->cur_ucode = old_type;
 444                 return ret;
 445         }
 446
 447         if (!alive_data.valid) {
 448                 IWL_ERR(priv, "Loaded ucode is not valid!\n");
 449                 priv->cur_ucode = old_type;
 450                 return -EIO;
 451         }
 452
 453         /*
 454          * This step takes a long time (60-80ms!!) and
 455          * WoWLAN image should be loaded quickly, so
 456          * skip it for WoWLAN.
 457          */
 458         if (ucode_type != IWL_UCODE_WOWLAN) {
 459                 ret = iwl_verify_ucode(priv, ucode_type);
 460                 if (ret) {
 461                         priv->cur_ucode = old_type;
 462                         return ret;
 463                 }
 464
 465                 /* delay a bit to give rfkill time to run */
 466                 msleep(5);
 467         }
 468
 469         ret = iwl_alive_notify(priv);
 470         if (ret) {
 471                 IWL_WARN(priv,
 472                         "Could not complete ALIVE transition: %d\n", ret);
 473                 priv->cur_ucode = old_type;
 474                 return ret;
 475         }
 476
 477         priv->ucode_loaded = true;
 478
 479         return 0;
 480 }
 481
 482 static bool iwlagn_wait_calib(struct iwl_notif_wait_data *notif_wait,
 483                               struct iwl_rx_packet *pkt, void *data)
 484 {
 485         struct iwl_priv *priv = data;
 486         struct iwl_calib_hdr *hdr;
 487         int len;
 488
 489         if (pkt->hdr.cmd != CALIBRATION_RES_NOTIFICATION) {
 490                 WARN_ON(pkt->hdr.cmd != CALIBRATION_COMPLETE_NOTIFICATION);
 491                 return true;
 492         }
 493
 494         hdr = (struct iwl_calib_hdr *)pkt->data;
 495         len = le32_to_cpu(pkt->len_n_flags) & FH_RSCSR_FRAME_SIZE_MSK;
 496
 497         /* reduce the size by the length field itself */
 498         len -= sizeof(__le32);
 499
 500         if (iwl_calib_set(priv, hdr, len))
 501                 IWL_ERR(priv, "Failed to record calibration data %d\n",
 502                         hdr->op_code);
 503
 504         return false;
 505 }
 506
 507 int iwl_run_init_ucode(struct iwl_priv *priv)
 508 {
 509         struct iwl_notification_wait calib_wait;
 510         static const u8 calib_complete[] = {
 511                 CALIBRATION_RES_NOTIFICATION,
 512                 CALIBRATION_COMPLETE_NOTIFICATION
 513         };
 514         int ret;
 515
 516         lockdep_assert_held(&priv->mutex);
 517
 518         /* No init ucode required? Curious, but maybe ok */
 519         if (!priv->fw->img[IWL_UCODE_INIT].sec[0].len)
 520                 return 0;
 521
 522         if (priv->init_ucode_run)
 523                 return 0;
 524
 525         iwl_init_notification_wait(&priv->notif_wait, &calib_wait,
 526                                    calib_complete, ARRAY_SIZE(calib_complete),
 527                                    iwlagn_wait_calib, priv);
 528
 529         /* Will also start the device */
 530         ret = iwl_load_ucode_wait_alive(priv, IWL_UCODE_INIT);
 531         if (ret)
 532                 goto error;
 533
 534         ret = iwl_init_alive_start(priv);
 535         if (ret)
 536                 goto error;
 537
 538         /*
 539          * Some things may run in the background now, but we
 540          * just wait for the calibration complete notification.
 541          */
 542         ret = iwl_wait_notification(&priv->notif_wait, &calib_wait,
 543                                         UCODE_CALIB_TIMEOUT);
 544         if (!ret)
 545                 priv->init_ucode_run = true;
 546
 547         goto out;
 548
 549  error:
 550         iwl_remove_notification(&priv->notif_wait, &calib_wait);
 551  out:
 552         /* Whatever happened, stop the device */
 553         iwl_trans_stop_device(priv->trans);
 554         priv->ucode_loaded = false;
 555
 556         return ret;
 557 }