drivers/net/wireless/iwlwifi/iwl-drv.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) 2007 - 2014 Intel Corporation. All rights reserved.
   9  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of version 2 of the GNU General Public License as
  13  * published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful, but
  16  * WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  23  * USA
  24  *
  25  * The full GNU General Public License is included in this distribution
  26  * in the file called COPYING.
  27  *
  28  * Contact Information:
  29  *  Intel Linux Wireless <ilw@linux.intel.com>
  30  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  31  *
  32  * BSD LICENSE
  33  *
  34  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
  35  * Copyright(c) 2013 - 2014 Intel Mobile Communications GmbH
  36  * All rights reserved.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  *
  42  *  * Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  *  * Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in
  46  *    the documentation and/or other materials provided with the
  47  *    distribution.
  48  *  * Neither the name Intel Corporation nor the names of its
  49  *    contributors may be used to endorse or promote products derived
  50  *    from this software without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  53  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  54  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  55  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  56  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  57  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  58  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  59  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  60  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  61  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  62  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  63  *
  64  *****************************************************************************/
  65 #include <linux/completion.h>
  66 #include <linux/dma-mapping.h>
  67 #include <linux/firmware.h>
  68 #include <linux/module.h>
  69 #include <linux/vmalloc.h>
  70
  71 #include "iwl-drv.h"
  72 #include "iwl-csr.h"
  73 #include "iwl-debug.h"
  74 #include "iwl-trans.h"
  75 #include "iwl-op-mode.h"
  76 #include "iwl-agn-hw.h"
  77 #include "iwl-fw.h"
  78 #include "iwl-config.h"
  79 #include "iwl-modparams.h"
  80
  81 /******************************************************************************
  82  *
  83  * module boiler plate
  84  *
  85  ******************************************************************************/
  86
  87 /*
  88  * module name, copyright, version, etc.
  89  */
  90 #define DRV_DESCRIPTION "Intel(R) Wireless WiFi driver for Linux"
  91
  92 #ifdef CONFIG_IWLWIFI_DEBUG
  93 #define VD "d"
  94 #else
  95 #define VD
  96 #endif
  97
  98 #define DRV_VERSION     IWLWIFI_VERSION VD
  99
 100 MODULE_DESCRIPTION(DRV_DESCRIPTION);
 101 MODULE_VERSION(DRV_VERSION);
 102 MODULE_AUTHOR(DRV_COPYRIGHT " " DRV_AUTHOR);
 103 MODULE_LICENSE("GPL");
 104
 105 #ifdef CONFIG_IWLWIFI_DEBUGFS
 106 static struct dentry *iwl_dbgfs_root;
 107 #endif
 108
 109 /**
 110  * struct iwl_drv - drv common data
 111  * @list: list of drv structures using this opmode
 112  * @fw: the iwl_fw structure
 113  * @op_mode: the running op_mode
 114  * @trans: transport layer
 115  * @dev: for debug prints only
 116  * @cfg: configuration struct
 117  * @fw_index: firmware revision to try loading
 118  * @firmware_name: composite filename of ucode file to load
 119  * @request_firmware_complete: the firmware has been obtained from user space
 120  */
 121 struct iwl_drv {
 122         struct list_head list;
 123         struct iwl_fw fw;
 124
 125         struct iwl_op_mode *op_mode;
 126         struct iwl_trans *trans;
 127         struct device *dev;
 128         const struct iwl_cfg *cfg;
 129
 130         int fw_index;                   /* firmware we're trying to load */
 131         char firmware_name[32];         /* name of firmware file to load */
 132
 133         struct completion request_firmware_complete;
 134
 135 #ifdef CONFIG_IWLWIFI_DEBUGFS
 136         struct dentry *dbgfs_drv;
 137         struct dentry *dbgfs_trans;
 138         struct dentry *dbgfs_op_mode;
 139 #endif
 140 };
 141
 142 enum {
 143         DVM_OP_MODE =   0,
 144         MVM_OP_MODE =   1,
 145 };
 146
 147 /* Protects the table contents, i.e. the ops pointer & drv list */
 148 static struct mutex iwlwifi_opmode_table_mtx;
 149 static struct iwlwifi_opmode_table {
 150         const char *name;                       /* name: iwldvm, iwlmvm, etc */
 151         const struct iwl_op_mode_ops *ops;      /* pointer to op_mode ops */
 152         struct list_head drv;           /* list of devices using this op_mode */
 153 } iwlwifi_opmode_table[] = {            /* ops set when driver is initialized */
 154         [DVM_OP_MODE] = { .name = "iwldvm", .ops = NULL },
 155         [MVM_OP_MODE] = { .name = "iwlmvm", .ops = NULL },
 156 };
 157
 158 #define IWL_DEFAULT_SCAN_CHANNELS 40
 159
 160 /*
 161  * struct fw_sec: Just for the image parsing proccess.
 162  * For the fw storage we are using struct fw_desc.
 163  */
 164 struct fw_sec {
 165         const void *data;               /* the sec data */
 166         size_t size;                    /* section size */
 167         u32 offset;                     /* offset of writing in the device */
 168 };
 169
 170 static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
 171 {
 172         vfree(desc->data);
 173         desc->data = NULL;
 174         desc->len = 0;
 175 }
 176
 177 static void iwl_free_fw_img(struct iwl_drv *drv, struct fw_img *img)
 178 {
 179         int i;
 180         for (i = 0; i < IWL_UCODE_SECTION_MAX; i++)
 181                 iwl_free_fw_desc(drv, &img->sec[i]);
 182 }
 183
 184 static void iwl_dealloc_ucode(struct iwl_drv *drv)
 185 {
 186         int i;
 187
 188         kfree(drv->fw.dbg_dest_tlv);
 189         for (i = 0; i < ARRAY_SIZE(drv->fw.dbg_conf_tlv); i++)
 190                 kfree(drv->fw.dbg_conf_tlv[i]);
 191
 192         for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
 193                 iwl_free_fw_img(drv, drv->fw.img + i);
 194 }
 195
 196 static int iwl_alloc_fw_desc(struct iwl_drv *drv, struct fw_desc *desc,
 197                              struct fw_sec *sec)
 198 {
 199         void *data;
 200
 201         desc->data = NULL;
 202
 203         if (!sec || !sec->size)
 204                 return -EINVAL;
 205
 206         data = vmalloc(sec->size);
 207         if (!data)
 208                 return -ENOMEM;
 209
 210         desc->len = sec->size;
 211         desc->offset = sec->offset;
 212         memcpy(data, sec->data, desc->len);
 213         desc->data = data;
 214
 215         return 0;
 216 }
 217
 218 static void iwl_req_fw_callback(const struct firmware *ucode_raw,
 219                                 void *context);
 220
 221 #define UCODE_EXPERIMENTAL_INDEX        100
 222 #define UCODE_EXPERIMENTAL_TAG          "exp"
 223
 224 static int iwl_request_firmware(struct iwl_drv *drv, bool first)
 225 {
 226         const char *name_pre = drv->cfg->fw_name_pre;
 227         char tag[8];
 228
 229         if (first) {
 230 #ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
 231                 drv->fw_index = UCODE_EXPERIMENTAL_INDEX;
 232                 strcpy(tag, UCODE_EXPERIMENTAL_TAG);
 233         } else if (drv->fw_index == UCODE_EXPERIMENTAL_INDEX) {
 234 #endif
 235                 drv->fw_index = drv->cfg->ucode_api_max;
 236                 sprintf(tag, "%d", drv->fw_index);
 237         } else {
 238                 drv->fw_index--;
 239                 sprintf(tag, "%d", drv->fw_index);
 240         }
 241
 242         if (drv->fw_index < drv->cfg->ucode_api_min) {
 243                 IWL_ERR(drv, "no suitable firmware found!\n");
 244                 return -ENOENT;
 245         }
 246
 247         snprintf(drv->firmware_name, sizeof(drv->firmware_name), "%s%s.ucode",
 248                  name_pre, tag);
 249
 250         /*
 251          * Starting 8000B - FW name format has changed. This overwrites the
 252          * previous name and uses the new format.
 253          *
 254          * TODO:
 255          * Once there is only one supported step for 8000 family - delete this!
 256          */
 257         if (drv->trans->cfg->device_family == IWL_DEVICE_FAMILY_8000) {
 258                 char rev_step[2] = {
 259                         'A' + CSR_HW_REV_STEP(drv->trans->hw_rev), 0
 260                 };
 261
 262                 /* A-step doesn't have an indication */
 263                 if (CSR_HW_REV_STEP(drv->trans->hw_rev) == SILICON_A_STEP)
 264                         rev_step[0] = 0;
 265
 266                 /*
 267                  * If hw_rev wasn't set yet - default as B-step. If it IS A-step
 268                  * we'll reload that FW later instead.
 269                  */
 270                 if (drv->trans->hw_rev == 0)
 271                         rev_step[0] = 'B';
 272
 273                 snprintf(drv->firmware_name, sizeof(drv->firmware_name),
 274                          "%s%s-%s.ucode", name_pre, rev_step, tag);
 275         }
 276
 277         IWL_DEBUG_INFO(drv, "attempting to load firmware %s'%s'\n",
 278                        (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
 279                                 ? "EXPERIMENTAL " : "",
 280                        drv->firmware_name);
 281
 282         return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
 283                                        drv->trans->dev,
 284                                        GFP_KERNEL, drv, iwl_req_fw_callback);
 285 }
 286
 287 struct fw_img_parsing {
 288         struct fw_sec sec[IWL_UCODE_SECTION_MAX];
 289         int sec_counter;
 290 };
 291
 292 /*
 293  * struct fw_sec_parsing: to extract fw section and it's offset from tlv
 294  */
 295 struct fw_sec_parsing {
 296         __le32 offset;
 297         const u8 data[];
 298 } __packed;
 299
 300 /**
 301  * struct iwl_tlv_calib_data - parse the default calib data from TLV
 302  *
 303  * @ucode_type: the uCode to which the following default calib relates.
 304  * @calib: default calibrations.
 305  */
 306 struct iwl_tlv_calib_data {
 307         __le32 ucode_type;
 308         struct iwl_tlv_calib_ctrl calib;
 309 } __packed;
 310
 311 struct iwl_firmware_pieces {
 312         struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
 313
 314         u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
 315         u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
 316
 317         /* FW debug data parsed for driver usage */
 318         struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
 319         struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_MAX];
 320         size_t dbg_conf_tlv_len[FW_DBG_MAX];
 321 };
 322
 323 /*
 324  * These functions are just to extract uCode section data from the pieces
 325  * structure.
 326  */
 327 static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
 328                               enum iwl_ucode_type type,
 329                               int  sec)
 330 {
 331         return &pieces->img[type].sec[sec];
 332 }
 333
 334 static void set_sec_data(struct iwl_firmware_pieces *pieces,
 335                          enum iwl_ucode_type type,
 336                          int sec,
 337                          const void *data)
 338 {
 339         pieces->img[type].sec[sec].data = data;
 340 }
 341
 342 static void set_sec_size(struct iwl_firmware_pieces *pieces,
 343                          enum iwl_ucode_type type,
 344                          int sec,
 345                          size_t size)
 346 {
 347         pieces->img[type].sec[sec].size = size;
 348 }
 349
 350 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
 351                            enum iwl_ucode_type type,
 352                            int sec)
 353 {
 354         return pieces->img[type].sec[sec].size;
 355 }
 356
 357 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
 358                            enum iwl_ucode_type type,
 359                            int sec,
 360                            u32 offset)
 361 {
 362         pieces->img[type].sec[sec].offset = offset;
 363 }
 364
 365 static int iwl_store_cscheme(struct iwl_fw *fw, const u8 *data, const u32 len)
 366 {
 367         int i, j;
 368         struct iwl_fw_cscheme_list *l = (struct iwl_fw_cscheme_list *)data;
 369         struct iwl_fw_cipher_scheme *fwcs;
 370         struct ieee80211_cipher_scheme *cs;
 371         u32 cipher;
 372
 373         if (len < sizeof(*l) ||
 374             len < sizeof(l->size) + l->size * sizeof(l->cs[0]))
 375                 return -EINVAL;
 376
 377         for (i = 0, j = 0; i < IWL_UCODE_MAX_CS && i < l->size; i++) {
 378                 fwcs = &l->cs[j];
 379                 cipher = le32_to_cpu(fwcs->cipher);
 380
 381                 /* we skip schemes with zero cipher suite selector */
 382                 if (!cipher)
 383                         continue;
 384
 385                 cs = &fw->cs[j++];
 386                 cs->cipher = cipher;
 387                 cs->iftype = BIT(NL80211_IFTYPE_STATION);
 388                 cs->hdr_len = fwcs->hdr_len;
 389                 cs->pn_len = fwcs->pn_len;
 390                 cs->pn_off = fwcs->pn_off;
 391                 cs->key_idx_off = fwcs->key_idx_off;
 392                 cs->key_idx_mask = fwcs->key_idx_mask;
 393                 cs->key_idx_shift = fwcs->key_idx_shift;
 394                 cs->mic_len = fwcs->mic_len;
 395         }
 396
 397         return 0;
 398 }
 399
 400 /*
 401  * Gets uCode section from tlv.
 402  */
 403 static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
 404                                const void *data, enum iwl_ucode_type type,
 405                                int size)
 406 {
 407         struct fw_img_parsing *img;
 408         struct fw_sec *sec;
 409         struct fw_sec_parsing *sec_parse;
 410
 411         if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
 412                 return -1;
 413
 414         sec_parse = (struct fw_sec_parsing *)data;
 415
 416         img = &pieces->img[type];
 417         sec = &img->sec[img->sec_counter];
 418
 419         sec->offset = le32_to_cpu(sec_parse->offset);
 420         sec->data = sec_parse->data;
 421         sec->size = size - sizeof(sec_parse->offset);
 422
 423         ++img->sec_counter;
 424
 425         return 0;
 426 }
 427
 428 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
 429 {
 430         struct iwl_tlv_calib_data *def_calib =
 431                                         (struct iwl_tlv_calib_data *)data;
 432         u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
 433         if (ucode_type >= IWL_UCODE_TYPE_MAX) {
 434                 IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
 435                         ucode_type);
 436                 return -EINVAL;
 437         }
 438         drv->fw.default_calib[ucode_type].flow_trigger =
 439                 def_calib->calib.flow_trigger;
 440         drv->fw.default_calib[ucode_type].event_trigger =
 441                 def_calib->calib.event_trigger;
 442
 443         return 0;
 444 }
 445
 446 static int iwl_set_ucode_api_flags(struct iwl_drv *drv, const u8 *data,
 447                                    struct iwl_ucode_capabilities *capa)
 448 {
 449         const struct iwl_ucode_api *ucode_api = (void *)data;
 450         u32 api_index = le32_to_cpu(ucode_api->api_index);
 451
 452         if (api_index >= IWL_API_ARRAY_SIZE) {
 453                 IWL_ERR(drv, "api_index larger than supported by driver\n");
 454                 return -EINVAL;
 455         }
 456
 457         capa->api[api_index] = le32_to_cpu(ucode_api->api_flags);
 458
 459         return 0;
 460 }
 461
 462 static int iwl_set_ucode_capabilities(struct iwl_drv *drv, const u8 *data,
 463                                       struct iwl_ucode_capabilities *capa)
 464 {
 465         const struct iwl_ucode_capa *ucode_capa = (void *)data;
 466         u32 api_index = le32_to_cpu(ucode_capa->api_index);
 467
 468         if (api_index >= IWL_CAPABILITIES_ARRAY_SIZE) {
 469                 IWL_ERR(drv, "api_index larger than supported by driver\n");
 470                 return -EINVAL;
 471         }
 472
 473         capa->capa[api_index] = le32_to_cpu(ucode_capa->api_capa);
 474
 475         return 0;
 476 }
 477
 478 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
 479                                     const struct firmware *ucode_raw,
 480                                     struct iwl_firmware_pieces *pieces)
 481 {
 482         struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
 483         u32 api_ver, hdr_size, build;
 484         char buildstr[25];
 485         const u8 *src;
 486
 487         drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
 488         api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
 489
 490         switch (api_ver) {
 491         default:
 492                 hdr_size = 28;
 493                 if (ucode_raw->size < hdr_size) {
 494                         IWL_ERR(drv, "File size too small!\n");
 495                         return -EINVAL;
 496                 }
 497                 build = le32_to_cpu(ucode->u.v2.build);
 498                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
 499                              le32_to_cpu(ucode->u.v2.inst_size));
 500                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
 501                              le32_to_cpu(ucode->u.v2.data_size));
 502                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
 503                              le32_to_cpu(ucode->u.v2.init_size));
 504                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
 505                              le32_to_cpu(ucode->u.v2.init_data_size));
 506                 src = ucode->u.v2.data;
 507                 break;
 508         case 0:
 509         case 1:
 510         case 2:
 511                 hdr_size = 24;
 512                 if (ucode_raw->size < hdr_size) {
 513                         IWL_ERR(drv, "File size too small!\n");
 514                         return -EINVAL;
 515                 }
 516                 build = 0;
 517                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
 518                              le32_to_cpu(ucode->u.v1.inst_size));
 519                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
 520                              le32_to_cpu(ucode->u.v1.data_size));
 521                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
 522                              le32_to_cpu(ucode->u.v1.init_size));
 523                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
 524                              le32_to_cpu(ucode->u.v1.init_data_size));
 525                 src = ucode->u.v1.data;
 526                 break;
 527         }
 528
 529         if (build)
 530                 sprintf(buildstr, " build %u%s", build,
 531                        (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
 532                                 ? " (EXP)" : "");
 533         else
 534                 buildstr[0] = '\0';
 535
 536         snprintf(drv->fw.fw_version,
 537                  sizeof(drv->fw.fw_version),
 538                  "%u.%u.%u.%u%s",
 539                  IWL_UCODE_MAJOR(drv->fw.ucode_ver),
 540                  IWL_UCODE_MINOR(drv->fw.ucode_ver),
 541                  IWL_UCODE_API(drv->fw.ucode_ver),
 542                  IWL_UCODE_SERIAL(drv->fw.ucode_ver),
 543                  buildstr);
 544
 545         /* Verify size of file vs. image size info in file's header */
 546
 547         if (ucode_raw->size != hdr_size +
 548             get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
 549             get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
 550             get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
 551             get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
 552
 553                 IWL_ERR(drv,
 554                         "uCode file size %d does not match expected size\n",
 555                         (int)ucode_raw->size);
 556                 return -EINVAL;
 557         }
 558
 559
 560         set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
 561         src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
 562         set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
 563                        IWLAGN_RTC_INST_LOWER_BOUND);
 564         set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
 565         src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
 566         set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
 567                        IWLAGN_RTC_DATA_LOWER_BOUND);
 568         set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
 569         src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
 570         set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
 571                        IWLAGN_RTC_INST_LOWER_BOUND);
 572         set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
 573         src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
 574         set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
 575                        IWLAGN_RTC_DATA_LOWER_BOUND);
 576         return 0;
 577 }
 578
 579 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
 580                                 const struct firmware *ucode_raw,
 581                                 struct iwl_firmware_pieces *pieces,
 582                                 struct iwl_ucode_capabilities *capa)
 583 {
 584         struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
 585         struct iwl_ucode_tlv *tlv;
 586         size_t len = ucode_raw->size;
 587         const u8 *data;
 588         u32 tlv_len;
 589         enum iwl_ucode_tlv_type tlv_type;
 590         const u8 *tlv_data;
 591         char buildstr[25];
 592         u32 build;
 593         int num_of_cpus;
 594
 595         if (len < sizeof(*ucode)) {
 596                 IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
 597                 return -EINVAL;
 598         }
 599
 600         if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
 601                 IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
 602                         le32_to_cpu(ucode->magic));
 603                 return -EINVAL;
 604         }
 605
 606         drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
 607         memcpy(drv->fw.human_readable, ucode->human_readable,
 608                sizeof(drv->fw.human_readable));
 609         build = le32_to_cpu(ucode->build);
 610
 611         if (build)
 612                 sprintf(buildstr, " build %u%s", build,
 613                        (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
 614                                 ? " (EXP)" : "");
 615         else
 616                 buildstr[0] = '\0';
 617
 618         snprintf(drv->fw.fw_version,
 619                  sizeof(drv->fw.fw_version),
 620                  "%u.%u.%u.%u%s",
 621                  IWL_UCODE_MAJOR(drv->fw.ucode_ver),
 622                  IWL_UCODE_MINOR(drv->fw.ucode_ver),
 623                  IWL_UCODE_API(drv->fw.ucode_ver),
 624                  IWL_UCODE_SERIAL(drv->fw.ucode_ver),
 625                  buildstr);
 626
 627         data = ucode->data;
 628
 629         len -= sizeof(*ucode);
 630
 631         while (len >= sizeof(*tlv)) {
 632                 len -= sizeof(*tlv);
 633                 tlv = (void *)data;
 634
 635                 tlv_len = le32_to_cpu(tlv->length);
 636                 tlv_type = le32_to_cpu(tlv->type);
 637                 tlv_data = tlv->data;
 638
 639                 if (len < tlv_len) {
 640                         IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
 641                                 len, tlv_len);
 642                         return -EINVAL;
 643                 }
 644                 len -= ALIGN(tlv_len, 4);
 645                 data += sizeof(*tlv) + ALIGN(tlv_len, 4);
 646
 647                 switch (tlv_type) {
 648                 case IWL_UCODE_TLV_INST:
 649                         set_sec_data(pieces, IWL_UCODE_REGULAR,
 650                                      IWL_UCODE_SECTION_INST, tlv_data);
 651                         set_sec_size(pieces, IWL_UCODE_REGULAR,
 652                                      IWL_UCODE_SECTION_INST, tlv_len);
 653                         set_sec_offset(pieces, IWL_UCODE_REGULAR,
 654                                        IWL_UCODE_SECTION_INST,
 655                                        IWLAGN_RTC_INST_LOWER_BOUND);
 656                         break;
 657                 case IWL_UCODE_TLV_DATA:
 658                         set_sec_data(pieces, IWL_UCODE_REGULAR,
 659                                      IWL_UCODE_SECTION_DATA, tlv_data);
 660                         set_sec_size(pieces, IWL_UCODE_REGULAR,
 661                                      IWL_UCODE_SECTION_DATA, tlv_len);
 662                         set_sec_offset(pieces, IWL_UCODE_REGULAR,
 663                                        IWL_UCODE_SECTION_DATA,
 664                                        IWLAGN_RTC_DATA_LOWER_BOUND);
 665                         break;
 666                 case IWL_UCODE_TLV_INIT:
 667                         set_sec_data(pieces, IWL_UCODE_INIT,
 668                                      IWL_UCODE_SECTION_INST, tlv_data);
 669                         set_sec_size(pieces, IWL_UCODE_INIT,
 670                                      IWL_UCODE_SECTION_INST, tlv_len);
 671                         set_sec_offset(pieces, IWL_UCODE_INIT,
 672                                        IWL_UCODE_SECTION_INST,
 673                                        IWLAGN_RTC_INST_LOWER_BOUND);
 674                         break;
 675                 case IWL_UCODE_TLV_INIT_DATA:
 676                         set_sec_data(pieces, IWL_UCODE_INIT,
 677                                      IWL_UCODE_SECTION_DATA, tlv_data);
 678                         set_sec_size(pieces, IWL_UCODE_INIT,
 679                                      IWL_UCODE_SECTION_DATA, tlv_len);
 680                         set_sec_offset(pieces, IWL_UCODE_INIT,
 681                                        IWL_UCODE_SECTION_DATA,
 682                                        IWLAGN_RTC_DATA_LOWER_BOUND);
 683                         break;
 684                 case IWL_UCODE_TLV_BOOT:
 685                         IWL_ERR(drv, "Found unexpected BOOT ucode\n");
 686                         break;
 687                 case IWL_UCODE_TLV_PROBE_MAX_LEN:
 688                         if (tlv_len != sizeof(u32))
 689                                 goto invalid_tlv_len;
 690                         capa->max_probe_length =
 691                                         le32_to_cpup((__le32 *)tlv_data);
 692                         break;
 693                 case IWL_UCODE_TLV_PAN:
 694                         if (tlv_len)
 695                                 goto invalid_tlv_len;
 696                         capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
 697                         break;
 698                 case IWL_UCODE_TLV_FLAGS:
 699                         /* must be at least one u32 */
 700                         if (tlv_len < sizeof(u32))
 701                                 goto invalid_tlv_len;
 702                         /* and a proper number of u32s */
 703                         if (tlv_len % sizeof(u32))
 704                                 goto invalid_tlv_len;
 705                         /*
 706                          * This driver only reads the first u32 as
 707                          * right now no more features are defined,
 708                          * if that changes then either the driver
 709                          * will not work with the new firmware, or
 710                          * it'll not take advantage of new features.
 711                          */
 712                         capa->flags = le32_to_cpup((__le32 *)tlv_data);
 713                         break;
 714                 case IWL_UCODE_TLV_API_CHANGES_SET:
 715                         if (tlv_len != sizeof(struct iwl_ucode_api))
 716                                 goto invalid_tlv_len;
 717                         if (iwl_set_ucode_api_flags(drv, tlv_data, capa))
 718                                 goto tlv_error;
 719                         break;
 720                 case IWL_UCODE_TLV_ENABLED_CAPABILITIES:
 721                         if (tlv_len != sizeof(struct iwl_ucode_capa))
 722                                 goto invalid_tlv_len;
 723                         if (iwl_set_ucode_capabilities(drv, tlv_data, capa))
 724                                 goto tlv_error;
 725                         break;
 726                 case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
 727                         if (tlv_len != sizeof(u32))
 728                                 goto invalid_tlv_len;
 729                         pieces->init_evtlog_ptr =
 730                                         le32_to_cpup((__le32 *)tlv_data);
 731                         break;
 732                 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
 733                         if (tlv_len != sizeof(u32))
 734                                 goto invalid_tlv_len;
 735                         pieces->init_evtlog_size =
 736                                         le32_to_cpup((__le32 *)tlv_data);
 737                         break;
 738                 case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
 739                         if (tlv_len != sizeof(u32))
 740                                 goto invalid_tlv_len;
 741                         pieces->init_errlog_ptr =
 742                                         le32_to_cpup((__le32 *)tlv_data);
 743                         break;
 744                 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
 745                         if (tlv_len != sizeof(u32))
 746                                 goto invalid_tlv_len;
 747                         pieces->inst_evtlog_ptr =
 748                                         le32_to_cpup((__le32 *)tlv_data);
 749                         break;
 750                 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
 751                         if (tlv_len != sizeof(u32))
 752                                 goto invalid_tlv_len;
 753                         pieces->inst_evtlog_size =
 754                                         le32_to_cpup((__le32 *)tlv_data);
 755                         break;
 756                 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
 757                         if (tlv_len != sizeof(u32))
 758                                 goto invalid_tlv_len;
 759                         pieces->inst_errlog_ptr =
 760                                         le32_to_cpup((__le32 *)tlv_data);
 761                         break;
 762                 case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
 763                         if (tlv_len)
 764                                 goto invalid_tlv_len;
 765                         drv->fw.enhance_sensitivity_table = true;
 766                         break;
 767                 case IWL_UCODE_TLV_WOWLAN_INST:
 768                         set_sec_data(pieces, IWL_UCODE_WOWLAN,
 769                                      IWL_UCODE_SECTION_INST, tlv_data);
 770                         set_sec_size(pieces, IWL_UCODE_WOWLAN,
 771                                      IWL_UCODE_SECTION_INST, tlv_len);
 772                         set_sec_offset(pieces, IWL_UCODE_WOWLAN,
 773                                        IWL_UCODE_SECTION_INST,
 774                                        IWLAGN_RTC_INST_LOWER_BOUND);
 775                         break;
 776                 case IWL_UCODE_TLV_WOWLAN_DATA:
 777                         set_sec_data(pieces, IWL_UCODE_WOWLAN,
 778                                      IWL_UCODE_SECTION_DATA, tlv_data);
 779                         set_sec_size(pieces, IWL_UCODE_WOWLAN,
 780                                      IWL_UCODE_SECTION_DATA, tlv_len);
 781                         set_sec_offset(pieces, IWL_UCODE_WOWLAN,
 782                                        IWL_UCODE_SECTION_DATA,
 783                                        IWLAGN_RTC_DATA_LOWER_BOUND);
 784                         break;
 785                 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
 786                         if (tlv_len != sizeof(u32))
 787                                 goto invalid_tlv_len;
 788                         capa->standard_phy_calibration_size =
 789                                         le32_to_cpup((__le32 *)tlv_data);
 790                         break;
 791                  case IWL_UCODE_TLV_SEC_RT:
 792                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
 793                                             tlv_len);
 794                         drv->fw.mvm_fw = true;
 795                         break;
 796                 case IWL_UCODE_TLV_SEC_INIT:
 797                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
 798                                             tlv_len);
 799                         drv->fw.mvm_fw = true;
 800                         break;
 801                 case IWL_UCODE_TLV_SEC_WOWLAN:
 802                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
 803                                             tlv_len);
 804                         drv->fw.mvm_fw = true;
 805                         break;
 806                 case IWL_UCODE_TLV_DEF_CALIB:
 807                         if (tlv_len != sizeof(struct iwl_tlv_calib_data))
 808                                 goto invalid_tlv_len;
 809                         if (iwl_set_default_calib(drv, tlv_data))
 810                                 goto tlv_error;
 811                         break;
 812                 case IWL_UCODE_TLV_PHY_SKU:
 813                         if (tlv_len != sizeof(u32))
 814                                 goto invalid_tlv_len;
 815                         drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
 816                         drv->fw.valid_tx_ant = (drv->fw.phy_config &
 817                                                 FW_PHY_CFG_TX_CHAIN) >>
 818                                                 FW_PHY_CFG_TX_CHAIN_POS;
 819                         drv->fw.valid_rx_ant = (drv->fw.phy_config &
 820                                                 FW_PHY_CFG_RX_CHAIN) >>
 821                                                 FW_PHY_CFG_RX_CHAIN_POS;
 822                         break;
 823                  case IWL_UCODE_TLV_SECURE_SEC_RT:
 824                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
 825                                             tlv_len);
 826                         drv->fw.mvm_fw = true;
 827                         break;
 828                 case IWL_UCODE_TLV_SECURE_SEC_INIT:
 829                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
 830                                             tlv_len);
 831                         drv->fw.mvm_fw = true;
 832                         break;
 833                 case IWL_UCODE_TLV_SECURE_SEC_WOWLAN:
 834                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
 835                                             tlv_len);
 836                         drv->fw.mvm_fw = true;
 837                         break;
 838                 case IWL_UCODE_TLV_NUM_OF_CPU:
 839                         if (tlv_len != sizeof(u32))
 840                                 goto invalid_tlv_len;
 841                         num_of_cpus =
 842                                 le32_to_cpup((__le32 *)tlv_data);
 843
 844                         if (num_of_cpus == 2) {
 845                                 drv->fw.img[IWL_UCODE_REGULAR].is_dual_cpus =
 846                                         true;
 847                                 drv->fw.img[IWL_UCODE_INIT].is_dual_cpus =
 848                                         true;
 849                                 drv->fw.img[IWL_UCODE_WOWLAN].is_dual_cpus =
 850                                         true;
 851                         } else if ((num_of_cpus > 2) || (num_of_cpus < 1)) {
 852                                 IWL_ERR(drv, "Driver support upto 2 CPUs\n");
 853                                 return -EINVAL;
 854                         }
 855                         break;
 856                 case IWL_UCODE_TLV_CSCHEME:
 857                         if (iwl_store_cscheme(&drv->fw, tlv_data, tlv_len))
 858                                 goto invalid_tlv_len;
 859                         break;
 860                 case IWL_UCODE_TLV_N_SCAN_CHANNELS:
 861                         if (tlv_len != sizeof(u32))
 862                                 goto invalid_tlv_len;
 863                         capa->n_scan_channels =
 864                                 le32_to_cpup((__le32 *)tlv_data);
 865                         break;
 866                 case IWL_UCODE_TLV_FW_DBG_DEST: {
 867                         struct iwl_fw_dbg_dest_tlv *dest = (void *)tlv_data;
 868
 869                         if (pieces->dbg_dest_tlv) {
 870                                 IWL_ERR(drv,
 871                                         "dbg destination ignored, already exists\n");
 872                                 break;
 873                         }
 874
 875                         pieces->dbg_dest_tlv = dest;
 876                         IWL_INFO(drv, "Found debug destination: %s\n",
 877                                  get_fw_dbg_mode_string(dest->monitor_mode));
 878
 879                         drv->fw.dbg_dest_reg_num =
 880                                 tlv_len - offsetof(struct iwl_fw_dbg_dest_tlv,
 881                                                    reg_ops);
 882                         drv->fw.dbg_dest_reg_num /=
 883                                 sizeof(drv->fw.dbg_dest_tlv->reg_ops[0]);
 884
 885                         break;
 886                         }
 887                 case IWL_UCODE_TLV_FW_DBG_CONF: {
 888                         struct iwl_fw_dbg_conf_tlv *conf = (void *)tlv_data;
 889
 890                         if (!pieces->dbg_dest_tlv) {
 891                                 IWL_ERR(drv,
 892                                         "Ignore dbg config %d - no destination configured\n",
 893                                         conf->id);
 894                                 break;
 895                         }
 896
 897                         if (conf->id >= ARRAY_SIZE(drv->fw.dbg_conf_tlv)) {
 898                                 IWL_ERR(drv,
 899                                         "Skip unknown configuration: %d\n",
 900                                         conf->id);
 901                                 break;
 902                         }
 903
 904                         if (pieces->dbg_conf_tlv[conf->id]) {
 905                                 IWL_ERR(drv,
 906                                         "Ignore duplicate dbg config %d\n",
 907                                         conf->id);
 908                                 break;
 909                         }
 910
 911                         IWL_INFO(drv, "Found debug configuration: %d\n",
 912                                  conf->id);
 913
 914                         pieces->dbg_conf_tlv[conf->id] = conf;
 915                         pieces->dbg_conf_tlv_len[conf->id] = tlv_len;
 916                         break;
 917                         }
 918                 default:
 919                         IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
 920                         break;
 921                 }
 922         }
 923
 924         if (len) {
 925                 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
 926                 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
 927                 return -EINVAL;
 928         }
 929
 930         return 0;
 931
 932  invalid_tlv_len:
 933         IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
 934  tlv_error:
 935         iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
 936
 937         return -EINVAL;
 938 }
 939
 940 static int iwl_alloc_ucode(struct iwl_drv *drv,
 941                            struct iwl_firmware_pieces *pieces,
 942                            enum iwl_ucode_type type)
 943 {
 944         int i;
 945         for (i = 0;
 946              i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
 947              i++)
 948                 if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
 949                                       get_sec(pieces, type, i)))
 950                         return -ENOMEM;
 951         return 0;
 952 }
 953
 954 static int validate_sec_sizes(struct iwl_drv *drv,
 955                               struct iwl_firmware_pieces *pieces,
 956                               const struct iwl_cfg *cfg)
 957 {
 958         IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
 959                 get_sec_size(pieces, IWL_UCODE_REGULAR,
 960                              IWL_UCODE_SECTION_INST));
 961         IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
 962                 get_sec_size(pieces, IWL_UCODE_REGULAR,
 963                              IWL_UCODE_SECTION_DATA));
 964         IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
 965                 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
 966         IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
 967                 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
 968
 969         /* Verify that uCode images will fit in card's SRAM. */
 970         if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
 971                                                         cfg->max_inst_size) {
 972                 IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
 973                         get_sec_size(pieces, IWL_UCODE_REGULAR,
 974                                                 IWL_UCODE_SECTION_INST));
 975                 return -1;
 976         }
 977
 978         if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
 979                                                         cfg->max_data_size) {
 980                 IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
 981                         get_sec_size(pieces, IWL_UCODE_REGULAR,
 982                                                 IWL_UCODE_SECTION_DATA));
 983                 return -1;
 984         }
 985
 986          if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
 987                                                         cfg->max_inst_size) {
 988                 IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
 989                         get_sec_size(pieces, IWL_UCODE_INIT,
 990                                                 IWL_UCODE_SECTION_INST));
 991                 return -1;
 992         }
 993
 994         if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
 995                                                         cfg->max_data_size) {
 996                 IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
 997                         get_sec_size(pieces, IWL_UCODE_REGULAR,
 998                                                 IWL_UCODE_SECTION_DATA));
 999                 return -1;
1000         }
1001         return 0;
1002 }
1003
1004 static struct iwl_op_mode *
1005 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
1006 {
1007         const struct iwl_op_mode_ops *ops = op->ops;
1008         struct dentry *dbgfs_dir = NULL;
1009         struct iwl_op_mode *op_mode = NULL;
1010
1011 #ifdef CONFIG_IWLWIFI_DEBUGFS
1012         drv->dbgfs_op_mode = debugfs_create_dir(op->name,
1013                                                 drv->dbgfs_drv);
1014         if (!drv->dbgfs_op_mode) {
1015                 IWL_ERR(drv,
1016                         "failed to create opmode debugfs directory\n");
1017                 return op_mode;
1018         }
1019         dbgfs_dir = drv->dbgfs_op_mode;
1020 #endif
1021
1022         op_mode = ops->start(drv->trans, drv->cfg, &drv->fw, dbgfs_dir);
1023
1024 #ifdef CONFIG_IWLWIFI_DEBUGFS
1025         if (!op_mode) {
1026                 debugfs_remove_recursive(drv->dbgfs_op_mode);
1027                 drv->dbgfs_op_mode = NULL;
1028         }
1029 #endif
1030
1031         return op_mode;
1032 }
1033
1034 static void _iwl_op_mode_stop(struct iwl_drv *drv)
1035 {
1036         /* op_mode can be NULL if its start failed */
1037         if (drv->op_mode) {
1038                 iwl_op_mode_stop(drv->op_mode);
1039                 drv->op_mode = NULL;
1040
1041 #ifdef CONFIG_IWLWIFI_DEBUGFS
1042                 debugfs_remove_recursive(drv->dbgfs_op_mode);
1043                 drv->dbgfs_op_mode = NULL;
1044 #endif
1045         }
1046 }
1047
1048 /**
1049  * iwl_req_fw_callback - callback when firmware was loaded
1050  *
1051  * If loaded successfully, copies the firmware into buffers
1052  * for the card to fetch (via DMA).
1053  */
1054 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
1055 {
1056         struct iwl_drv *drv = context;
1057         struct iwl_fw *fw = &drv->fw;
1058         struct iwl_ucode_header *ucode;
1059         struct iwlwifi_opmode_table *op;
1060         int err;
1061         struct iwl_firmware_pieces *pieces;
1062         const unsigned int api_max = drv->cfg->ucode_api_max;
1063         unsigned int api_ok = drv->cfg->ucode_api_ok;
1064         const unsigned int api_min = drv->cfg->ucode_api_min;
1065         u32 api_ver;
1066         int i;
1067         bool load_module = false;
1068         u32 hw_rev = drv->trans->hw_rev;
1069
1070         fw->ucode_capa.max_probe_length = IWL_DEFAULT_MAX_PROBE_LENGTH;
1071         fw->ucode_capa.standard_phy_calibration_size =
1072                         IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1073         fw->ucode_capa.n_scan_channels = IWL_DEFAULT_SCAN_CHANNELS;
1074
1075         if (!api_ok)
1076                 api_ok = api_max;
1077
1078         pieces = kzalloc(sizeof(*pieces), GFP_KERNEL);
1079         if (!pieces)
1080                 return;
1081
1082         if (!ucode_raw) {
1083                 if (drv->fw_index <= api_ok)
1084                         IWL_ERR(drv,
1085                                 "request for firmware file '%s' failed.\n",
1086                                 drv->firmware_name);
1087                 goto try_again;
1088         }
1089
1090         IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
1091                        drv->firmware_name, ucode_raw->size);
1092
1093         /* Make sure that we got at least the API version number */
1094         if (ucode_raw->size < 4) {
1095                 IWL_ERR(drv, "File size way too small!\n");
1096                 goto try_again;
1097         }
1098
1099         /* Data from ucode file:  header followed by uCode images */
1100         ucode = (struct iwl_ucode_header *)ucode_raw->data;
1101
1102         if (ucode->ver)
1103                 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, pieces);
1104         else
1105                 err = iwl_parse_tlv_firmware(drv, ucode_raw, pieces,
1106                                              &fw->ucode_capa);
1107
1108         if (err)
1109                 goto try_again;
1110
1111         api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
1112
1113         /*
1114          * api_ver should match the api version forming part of the
1115          * firmware filename ... but we don't check for that and only rely
1116          * on the API version read from firmware header from here on forward
1117          */
1118         /* no api version check required for experimental uCode */
1119         if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
1120                 if (api_ver < api_min || api_ver > api_max) {
1121                         IWL_ERR(drv,
1122                                 "Driver unable to support your firmware API. "
1123                                 "Driver supports v%u, firmware is v%u.\n",
1124                                 api_max, api_ver);
1125                         goto try_again;
1126                 }
1127
1128                 if (api_ver < api_ok) {
1129                         if (api_ok != api_max)
1130                                 IWL_ERR(drv, "Firmware has old API version, "
1131                                         "expected v%u through v%u, got v%u.\n",
1132                                         api_ok, api_max, api_ver);
1133                         else
1134                                 IWL_ERR(drv, "Firmware has old API version, "
1135                                         "expected v%u, got v%u.\n",
1136                                         api_max, api_ver);
1137                         IWL_ERR(drv, "New firmware can be obtained from "
1138                                       "http://www.intellinuxwireless.org/.\n");
1139                 }
1140         }
1141
1142         /*
1143          * In mvm uCode there is no difference between data and instructions
1144          * sections.
1145          */
1146         if (!fw->mvm_fw && validate_sec_sizes(drv, pieces, drv->cfg))
1147                 goto try_again;
1148
1149         /* Allocate ucode buffers for card's bus-master loading ... */
1150
1151         /* Runtime instructions and 2 copies of data:
1152          * 1) unmodified from disk
1153          * 2) backup cache for save/restore during power-downs */
1154         for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
1155                 if (iwl_alloc_ucode(drv, pieces, i))
1156                         goto out_free_fw;
1157
1158         if (pieces->dbg_dest_tlv) {
1159                 drv->fw.dbg_dest_tlv =
1160                         kmemdup(pieces->dbg_dest_tlv,
1161                                 sizeof(*pieces->dbg_dest_tlv) +
1162                                 sizeof(pieces->dbg_dest_tlv->reg_ops[0]) *
1163                                 drv->fw.dbg_dest_reg_num, GFP_KERNEL);
1164
1165                 if (!drv->fw.dbg_dest_tlv)
1166                         goto out_free_fw;
1167         }
1168
1169         for (i = 0; i < ARRAY_SIZE(drv->fw.dbg_conf_tlv); i++) {
1170                 if (pieces->dbg_conf_tlv[i]) {
1171                         drv->fw.dbg_conf_tlv_len[i] =
1172                                 pieces->dbg_conf_tlv_len[i];
1173                         drv->fw.dbg_conf_tlv[i] =
1174                                 kmemdup(pieces->dbg_conf_tlv[i],
1175                                         drv->fw.dbg_conf_tlv_len[i],
1176                                         GFP_KERNEL);
1177                         if (!drv->fw.dbg_conf_tlv[i])
1178                                 goto out_free_fw;
1179                 }
1180         }
1181
1182         /* Now that we can no longer fail, copy information */
1183
1184         /*
1185          * The (size - 16) / 12 formula is based on the information recorded
1186          * for each event, which is of mode 1 (including timestamp) for all
1187          * new microcodes that include this information.
1188          */
1189         fw->init_evtlog_ptr = pieces->init_evtlog_ptr;
1190         if (pieces->init_evtlog_size)
1191                 fw->init_evtlog_size = (pieces->init_evtlog_size - 16)/12;
1192         else
1193                 fw->init_evtlog_size =
1194                         drv->cfg->base_params->max_event_log_size;
1195         fw->init_errlog_ptr = pieces->init_errlog_ptr;
1196         fw->inst_evtlog_ptr = pieces->inst_evtlog_ptr;
1197         if (pieces->inst_evtlog_size)
1198                 fw->inst_evtlog_size = (pieces->inst_evtlog_size - 16)/12;
1199         else
1200                 fw->inst_evtlog_size =
1201                         drv->cfg->base_params->max_event_log_size;
1202         fw->inst_errlog_ptr = pieces->inst_errlog_ptr;
1203
1204         /*
1205          * figure out the offset of chain noise reset and gain commands
1206          * base on the size of standard phy calibration commands table size
1207          */
1208         if (fw->ucode_capa.standard_phy_calibration_size >
1209             IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
1210                 fw->ucode_capa.standard_phy_calibration_size =
1211                         IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1212
1213         /* We have our copies now, allow OS release its copies */
1214         release_firmware(ucode_raw);
1215
1216         mutex_lock(&iwlwifi_opmode_table_mtx);
1217         if (fw->mvm_fw)
1218                 op = &iwlwifi_opmode_table[MVM_OP_MODE];
1219         else
1220                 op = &iwlwifi_opmode_table[DVM_OP_MODE];
1221
1222         IWL_INFO(drv, "loaded firmware version %s op_mode %s\n",
1223                  drv->fw.fw_version, op->name);
1224
1225         /* add this device to the list of devices using this op_mode */
1226         list_add_tail(&drv->list, &op->drv);
1227
1228         if (op->ops) {
1229                 drv->op_mode = _iwl_op_mode_start(drv, op);
1230
1231                 if (!drv->op_mode) {
1232                         mutex_unlock(&iwlwifi_opmode_table_mtx);
1233                         goto out_unbind;
1234                 }
1235         } else {
1236                 load_module = true;
1237         }
1238         mutex_unlock(&iwlwifi_opmode_table_mtx);
1239
1240         /*
1241          * Complete the firmware request last so that
1242          * a driver unbind (stop) doesn't run while we
1243          * are doing the start() above.
1244          */
1245         complete(&drv->request_firmware_complete);
1246
1247         /*
1248          * Load the module last so we don't block anything
1249          * else from proceeding if the module fails to load
1250          * or hangs loading.
1251          */
1252         if (load_module) {
1253                 err = request_module("%s", op->name);
1254 #ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
1255                 if (err)
1256                         IWL_ERR(drv,
1257                                 "failed to load module %s (error %d), is dynamic loading enabled?\n",
1258                                 op->name, err);
1259 #endif
1260         }
1261
1262         /*
1263          * We may have loaded the wrong FW file in 8000 HW family if it is an
1264          * A-step card, and if drv->trans->hw_rev wasn't properly read when
1265          * the FW file had been loaded. (This might happen in SDIO.) In such a
1266          * case - unload and reload the correct file.
1267          *
1268          * TODO:
1269          * Once there is only one supported step for 8000 family - delete this!
1270          */
1271         if (drv->trans->cfg->device_family == IWL_DEVICE_FAMILY_8000 &&
1272             CSR_HW_REV_STEP(drv->trans->hw_rev) == SILICON_A_STEP &&
1273             drv->trans->hw_rev != hw_rev) {
1274                 char firmware_name[32];
1275
1276                 /* Free previous FW resources */
1277                 if (drv->op_mode)
1278                         _iwl_op_mode_stop(drv);
1279                 iwl_dealloc_ucode(drv);
1280
1281                 /* Build name of correct-step FW */
1282                 snprintf(firmware_name, sizeof(firmware_name),
1283                          strrchr(drv->firmware_name, '-'));
1284                 snprintf(drv->firmware_name, sizeof(drv->firmware_name),
1285                          "%s%s", drv->cfg->fw_name_pre, firmware_name);
1286
1287                 /* Clear data before loading correct FW */
1288                 list_del(&drv->list);
1289
1290                 /* Request correct FW file this time */
1291                 IWL_DEBUG_INFO(drv, "attempting to load A-step FW %s\n",
1292                                drv->firmware_name);
1293                 err = request_firmware(&ucode_raw, drv->firmware_name,
1294                                        drv->trans->dev);
1295                 if (err) {
1296                         IWL_ERR(drv, "Failed swapping FW!\n");
1297                         goto out_unbind;
1298                 }
1299
1300                 /* Redo callback function - this time with right FW */
1301                 iwl_req_fw_callback(ucode_raw, context);
1302         }
1303
1304         kfree(pieces);
1305         return;
1306
1307  try_again:
1308         /* try next, if any */
1309         kfree(pieces);
1310         release_firmware(ucode_raw);
1311         if (iwl_request_firmware(drv, false))
1312                 goto out_unbind;
1313         return;
1314
1315  out_free_fw:
1316         IWL_ERR(drv, "failed to allocate pci memory\n");
1317         iwl_dealloc_ucode(drv);
1318         release_firmware(ucode_raw);
1319  out_unbind:
1320         kfree(pieces);
1321         complete(&drv->request_firmware_complete);
1322         device_release_driver(drv->trans->dev);
1323 }
1324
1325 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans,
1326                               const struct iwl_cfg *cfg)
1327 {
1328         struct iwl_drv *drv;
1329         int ret;
1330
1331         drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1332         if (!drv) {
1333                 ret = -ENOMEM;
1334                 goto err;
1335         }
1336
1337         drv->trans = trans;
1338         drv->dev = trans->dev;
1339         drv->cfg = cfg;
1340
1341         init_completion(&drv->request_firmware_complete);
1342         INIT_LIST_HEAD(&drv->list);
1343
1344 #ifdef CONFIG_IWLWIFI_DEBUGFS
1345         /* Create the device debugfs entries. */
1346         drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1347                                             iwl_dbgfs_root);
1348
1349         if (!drv->dbgfs_drv) {
1350                 IWL_ERR(drv, "failed to create debugfs directory\n");
1351                 ret = -ENOMEM;
1352                 goto err_free_drv;
1353         }
1354
1355         /* Create transport layer debugfs dir */
1356         drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1357
1358         if (!drv->trans->dbgfs_dir) {
1359                 IWL_ERR(drv, "failed to create transport debugfs directory\n");
1360                 ret = -ENOMEM;
1361                 goto err_free_dbgfs;
1362         }
1363 #endif
1364
1365         ret = iwl_request_firmware(drv, true);
1366         if (ret) {
1367                 IWL_ERR(trans, "Couldn't request the fw\n");
1368                 goto err_fw;
1369         }
1370
1371         return drv;
1372
1373 err_fw:
1374 #ifdef CONFIG_IWLWIFI_DEBUGFS
1375 err_free_dbgfs:
1376         debugfs_remove_recursive(drv->dbgfs_drv);
1377 err_free_drv:
1378 #endif
1379         kfree(drv);
1380 err:
1381         return ERR_PTR(ret);
1382 }
1383
1384 void iwl_drv_stop(struct iwl_drv *drv)
1385 {
1386         wait_for_completion(&drv->request_firmware_complete);
1387
1388         _iwl_op_mode_stop(drv);
1389
1390         iwl_dealloc_ucode(drv);
1391
1392         mutex_lock(&iwlwifi_opmode_table_mtx);
1393         /*
1394          * List is empty (this item wasn't added)
1395          * when firmware loading failed -- in that
1396          * case we can't remove it from any list.
1397          */
1398         if (!list_empty(&drv->list))
1399                 list_del(&drv->list);
1400         mutex_unlock(&iwlwifi_opmode_table_mtx);
1401
1402 #ifdef CONFIG_IWLWIFI_DEBUGFS
1403         debugfs_remove_recursive(drv->dbgfs_drv);
1404 #endif
1405
1406         kfree(drv);
1407 }
1408
1409
1410 /* shared module parameters */
1411 struct iwl_mod_params iwlwifi_mod_params = {
1412         .restart_fw = true,
1413         .bt_coex_active = true,
1414         .power_level = IWL_POWER_INDEX_1,
1415         .wd_disable = true,
1416 #ifndef CONFIG_IWLWIFI_UAPSD
1417         .uapsd_disable = true,
1418 #endif /* CONFIG_IWLWIFI_UAPSD */
1419         /* the rest are 0 by default */
1420 };
1421 IWL_EXPORT_SYMBOL(iwlwifi_mod_params);
1422
1423 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
1424 {
1425         int i;
1426         struct iwl_drv *drv;
1427         struct iwlwifi_opmode_table *op;
1428
1429         mutex_lock(&iwlwifi_opmode_table_mtx);
1430         for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1431                 op = &iwlwifi_opmode_table[i];
1432                 if (strcmp(op->name, name))
1433                         continue;
1434                 op->ops = ops;
1435                 /* TODO: need to handle exceptional case */
1436                 list_for_each_entry(drv, &op->drv, list)
1437                         drv->op_mode = _iwl_op_mode_start(drv, op);
1438
1439                 mutex_unlock(&iwlwifi_opmode_table_mtx);
1440                 return 0;
1441         }
1442         mutex_unlock(&iwlwifi_opmode_table_mtx);
1443         return -EIO;
1444 }
1445 IWL_EXPORT_SYMBOL(iwl_opmode_register);
1446
1447 void iwl_opmode_deregister(const char *name)
1448 {
1449         int i;
1450         struct iwl_drv *drv;
1451
1452         mutex_lock(&iwlwifi_opmode_table_mtx);
1453         for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1454                 if (strcmp(iwlwifi_opmode_table[i].name, name))
1455                         continue;
1456                 iwlwifi_opmode_table[i].ops = NULL;
1457
1458                 /* call the stop routine for all devices */
1459                 list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
1460                         _iwl_op_mode_stop(drv);
1461
1462                 mutex_unlock(&iwlwifi_opmode_table_mtx);
1463                 return;
1464         }
1465         mutex_unlock(&iwlwifi_opmode_table_mtx);
1466 }
1467 IWL_EXPORT_SYMBOL(iwl_opmode_deregister);
1468
1469 static int __init iwl_drv_init(void)
1470 {
1471         int i;
1472
1473         mutex_init(&iwlwifi_opmode_table_mtx);
1474
1475         for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
1476                 INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
1477
1478         pr_info(DRV_DESCRIPTION ", " DRV_VERSION "\n");
1479         pr_info(DRV_COPYRIGHT "\n");
1480
1481 #ifdef CONFIG_IWLWIFI_DEBUGFS
1482         /* Create the root of iwlwifi debugfs subsystem. */
1483         iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
1484
1485         if (!iwl_dbgfs_root)
1486                 return -EFAULT;
1487 #endif
1488
1489         return iwl_pci_register_driver();
1490 }
1491 module_init(iwl_drv_init);
1492
1493 static void __exit iwl_drv_exit(void)
1494 {
1495         iwl_pci_unregister_driver();
1496
1497 #ifdef CONFIG_IWLWIFI_DEBUGFS
1498         debugfs_remove_recursive(iwl_dbgfs_root);
1499 #endif
1500 }
1501 module_exit(iwl_drv_exit);
1502
1503 #ifdef CONFIG_IWLWIFI_DEBUG
1504 module_param_named(debug, iwlwifi_mod_params.debug_level, uint,
1505                    S_IRUGO | S_IWUSR);
1506 MODULE_PARM_DESC(debug, "debug output mask");
1507 #endif
1508
1509 module_param_named(swcrypto, iwlwifi_mod_params.sw_crypto, int, S_IRUGO);
1510 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
1511 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, S_IRUGO);
1512 MODULE_PARM_DESC(11n_disable,
1513         "disable 11n functionality, bitmap: 1: full, 2: disable agg TX, 4: disable agg RX, 8 enable agg TX");
1514 module_param_named(amsdu_size_8K, iwlwifi_mod_params.amsdu_size_8K,
1515                    int, S_IRUGO);
1516 MODULE_PARM_DESC(amsdu_size_8K, "enable 8K amsdu size (default 0)");
1517 module_param_named(fw_restart, iwlwifi_mod_params.restart_fw, bool, S_IRUGO);
1518 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error (default true)");
1519
1520 module_param_named(antenna_coupling, iwlwifi_mod_params.ant_coupling,
1521                    int, S_IRUGO);
1522 MODULE_PARM_DESC(antenna_coupling,
1523                  "specify antenna coupling in dB (default: 0 dB)");
1524
1525 module_param_named(wd_disable, iwlwifi_mod_params.wd_disable, int, S_IRUGO);
1526 MODULE_PARM_DESC(wd_disable,
1527                 "Disable stuck queue watchdog timer 0=system default, 1=disable (default: 1)");
1528
1529 module_param_named(nvm_file, iwlwifi_mod_params.nvm_file, charp, S_IRUGO);
1530 MODULE_PARM_DESC(nvm_file, "NVM file name");
1531
1532 module_param_named(uapsd_disable, iwlwifi_mod_params.uapsd_disable,
1533                    bool, S_IRUGO);
1534 #ifdef CONFIG_IWLWIFI_UAPSD
1535 MODULE_PARM_DESC(uapsd_disable, "disable U-APSD functionality (default: N)");
1536 #else
1537 MODULE_PARM_DESC(uapsd_disable, "disable U-APSD functionality (default: Y)");
1538 #endif
1539
1540 /*
1541  * set bt_coex_active to true, uCode will do kill/defer
1542  * every time the priority line is asserted (BT is sending signals on the
1543  * priority line in the PCIx).
1544  * set bt_coex_active to false, uCode will ignore the BT activity and
1545  * perform the normal operation
1546  *
1547  * User might experience transmit issue on some platform due to WiFi/BT
1548  * co-exist problem. The possible behaviors are:
1549  *   Able to scan and finding all the available AP
1550  *   Not able to associate with any AP
1551  * On those platforms, WiFi communication can be restored by set
1552  * "bt_coex_active" module parameter to "false"
1553  *
1554  * default: bt_coex_active = true (BT_COEX_ENABLE)
1555  */
1556 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1557                 bool, S_IRUGO);
1558 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1559
1560 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, S_IRUGO);
1561 MODULE_PARM_DESC(led_mode, "0=system default, "
1562                 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1563
1564 module_param_named(power_save, iwlwifi_mod_params.power_save,
1565                 bool, S_IRUGO);
1566 MODULE_PARM_DESC(power_save,
1567                  "enable WiFi power management (default: disable)");
1568
1569 module_param_named(power_level, iwlwifi_mod_params.power_level,
1570                 int, S_IRUGO);
1571 MODULE_PARM_DESC(power_level,
1572                  "default power save level (range from 1 - 5, default: 1)");
1573
1574 module_param_named(fw_monitor, iwlwifi_mod_params.fw_monitor, bool, S_IRUGO);
1575 MODULE_PARM_DESC(fw_monitor,
1576                  "firmware monitor - to debug FW (default: false - needs lots of memory)");