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         bool usniffer_images = false;
 595         bool usniffer_req = false;
 596
 597         if (len < sizeof(*ucode)) {
 598                 IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
 599                 return -EINVAL;
 600         }
 601
 602         if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
 603                 IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
 604                         le32_to_cpu(ucode->magic));
 605                 return -EINVAL;
 606         }
 607
 608         drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
 609         memcpy(drv->fw.human_readable, ucode->human_readable,
 610                sizeof(drv->fw.human_readable));
 611         build = le32_to_cpu(ucode->build);
 612
 613         if (build)
 614                 sprintf(buildstr, " build %u%s", build,
 615                        (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
 616                                 ? " (EXP)" : "");
 617         else
 618                 buildstr[0] = '\0';
 619
 620         snprintf(drv->fw.fw_version,
 621                  sizeof(drv->fw.fw_version),
 622                  "%u.%u.%u.%u%s",
 623                  IWL_UCODE_MAJOR(drv->fw.ucode_ver),
 624                  IWL_UCODE_MINOR(drv->fw.ucode_ver),
 625                  IWL_UCODE_API(drv->fw.ucode_ver),
 626                  IWL_UCODE_SERIAL(drv->fw.ucode_ver),
 627                  buildstr);
 628
 629         data = ucode->data;
 630
 631         len -= sizeof(*ucode);
 632
 633         while (len >= sizeof(*tlv)) {
 634                 len -= sizeof(*tlv);
 635                 tlv = (void *)data;
 636
 637                 tlv_len = le32_to_cpu(tlv->length);
 638                 tlv_type = le32_to_cpu(tlv->type);
 639                 tlv_data = tlv->data;
 640
 641                 if (len < tlv_len) {
 642                         IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
 643                                 len, tlv_len);
 644                         return -EINVAL;
 645                 }
 646                 len -= ALIGN(tlv_len, 4);
 647                 data += sizeof(*tlv) + ALIGN(tlv_len, 4);
 648
 649                 switch (tlv_type) {
 650                 case IWL_UCODE_TLV_INST:
 651                         set_sec_data(pieces, IWL_UCODE_REGULAR,
 652                                      IWL_UCODE_SECTION_INST, tlv_data);
 653                         set_sec_size(pieces, IWL_UCODE_REGULAR,
 654                                      IWL_UCODE_SECTION_INST, tlv_len);
 655                         set_sec_offset(pieces, IWL_UCODE_REGULAR,
 656                                        IWL_UCODE_SECTION_INST,
 657                                        IWLAGN_RTC_INST_LOWER_BOUND);
 658                         break;
 659                 case IWL_UCODE_TLV_DATA:
 660                         set_sec_data(pieces, IWL_UCODE_REGULAR,
 661                                      IWL_UCODE_SECTION_DATA, tlv_data);
 662                         set_sec_size(pieces, IWL_UCODE_REGULAR,
 663                                      IWL_UCODE_SECTION_DATA, tlv_len);
 664                         set_sec_offset(pieces, IWL_UCODE_REGULAR,
 665                                        IWL_UCODE_SECTION_DATA,
 666                                        IWLAGN_RTC_DATA_LOWER_BOUND);
 667                         break;
 668                 case IWL_UCODE_TLV_INIT:
 669                         set_sec_data(pieces, IWL_UCODE_INIT,
 670                                      IWL_UCODE_SECTION_INST, tlv_data);
 671                         set_sec_size(pieces, IWL_UCODE_INIT,
 672                                      IWL_UCODE_SECTION_INST, tlv_len);
 673                         set_sec_offset(pieces, IWL_UCODE_INIT,
 674                                        IWL_UCODE_SECTION_INST,
 675                                        IWLAGN_RTC_INST_LOWER_BOUND);
 676                         break;
 677                 case IWL_UCODE_TLV_INIT_DATA:
 678                         set_sec_data(pieces, IWL_UCODE_INIT,
 679                                      IWL_UCODE_SECTION_DATA, tlv_data);
 680                         set_sec_size(pieces, IWL_UCODE_INIT,
 681                                      IWL_UCODE_SECTION_DATA, tlv_len);
 682                         set_sec_offset(pieces, IWL_UCODE_INIT,
 683                                        IWL_UCODE_SECTION_DATA,
 684                                        IWLAGN_RTC_DATA_LOWER_BOUND);
 685                         break;
 686                 case IWL_UCODE_TLV_BOOT:
 687                         IWL_ERR(drv, "Found unexpected BOOT ucode\n");
 688                         break;
 689                 case IWL_UCODE_TLV_PROBE_MAX_LEN:
 690                         if (tlv_len != sizeof(u32))
 691                                 goto invalid_tlv_len;
 692                         capa->max_probe_length =
 693                                         le32_to_cpup((__le32 *)tlv_data);
 694                         break;
 695                 case IWL_UCODE_TLV_PAN:
 696                         if (tlv_len)
 697                                 goto invalid_tlv_len;
 698                         capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
 699                         break;
 700                 case IWL_UCODE_TLV_FLAGS:
 701                         /* must be at least one u32 */
 702                         if (tlv_len < sizeof(u32))
 703                                 goto invalid_tlv_len;
 704                         /* and a proper number of u32s */
 705                         if (tlv_len % sizeof(u32))
 706                                 goto invalid_tlv_len;
 707                         /*
 708                          * This driver only reads the first u32 as
 709                          * right now no more features are defined,
 710                          * if that changes then either the driver
 711                          * will not work with the new firmware, or
 712                          * it'll not take advantage of new features.
 713                          */
 714                         capa->flags = le32_to_cpup((__le32 *)tlv_data);
 715                         break;
 716                 case IWL_UCODE_TLV_API_CHANGES_SET:
 717                         if (tlv_len != sizeof(struct iwl_ucode_api))
 718                                 goto invalid_tlv_len;
 719                         if (iwl_set_ucode_api_flags(drv, tlv_data, capa))
 720                                 goto tlv_error;
 721                         break;
 722                 case IWL_UCODE_TLV_ENABLED_CAPABILITIES:
 723                         if (tlv_len != sizeof(struct iwl_ucode_capa))
 724                                 goto invalid_tlv_len;
 725                         if (iwl_set_ucode_capabilities(drv, tlv_data, capa))
 726                                 goto tlv_error;
 727                         break;
 728                 case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
 729                         if (tlv_len != sizeof(u32))
 730                                 goto invalid_tlv_len;
 731                         pieces->init_evtlog_ptr =
 732                                         le32_to_cpup((__le32 *)tlv_data);
 733                         break;
 734                 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
 735                         if (tlv_len != sizeof(u32))
 736                                 goto invalid_tlv_len;
 737                         pieces->init_evtlog_size =
 738                                         le32_to_cpup((__le32 *)tlv_data);
 739                         break;
 740                 case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
 741                         if (tlv_len != sizeof(u32))
 742                                 goto invalid_tlv_len;
 743                         pieces->init_errlog_ptr =
 744                                         le32_to_cpup((__le32 *)tlv_data);
 745                         break;
 746                 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
 747                         if (tlv_len != sizeof(u32))
 748                                 goto invalid_tlv_len;
 749                         pieces->inst_evtlog_ptr =
 750                                         le32_to_cpup((__le32 *)tlv_data);
 751                         break;
 752                 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
 753                         if (tlv_len != sizeof(u32))
 754                                 goto invalid_tlv_len;
 755                         pieces->inst_evtlog_size =
 756                                         le32_to_cpup((__le32 *)tlv_data);
 757                         break;
 758                 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
 759                         if (tlv_len != sizeof(u32))
 760                                 goto invalid_tlv_len;
 761                         pieces->inst_errlog_ptr =
 762                                         le32_to_cpup((__le32 *)tlv_data);
 763                         break;
 764                 case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
 765                         if (tlv_len)
 766                                 goto invalid_tlv_len;
 767                         drv->fw.enhance_sensitivity_table = true;
 768                         break;
 769                 case IWL_UCODE_TLV_WOWLAN_INST:
 770                         set_sec_data(pieces, IWL_UCODE_WOWLAN,
 771                                      IWL_UCODE_SECTION_INST, tlv_data);
 772                         set_sec_size(pieces, IWL_UCODE_WOWLAN,
 773                                      IWL_UCODE_SECTION_INST, tlv_len);
 774                         set_sec_offset(pieces, IWL_UCODE_WOWLAN,
 775                                        IWL_UCODE_SECTION_INST,
 776                                        IWLAGN_RTC_INST_LOWER_BOUND);
 777                         break;
 778                 case IWL_UCODE_TLV_WOWLAN_DATA:
 779                         set_sec_data(pieces, IWL_UCODE_WOWLAN,
 780                                      IWL_UCODE_SECTION_DATA, tlv_data);
 781                         set_sec_size(pieces, IWL_UCODE_WOWLAN,
 782                                      IWL_UCODE_SECTION_DATA, tlv_len);
 783                         set_sec_offset(pieces, IWL_UCODE_WOWLAN,
 784                                        IWL_UCODE_SECTION_DATA,
 785                                        IWLAGN_RTC_DATA_LOWER_BOUND);
 786                         break;
 787                 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
 788                         if (tlv_len != sizeof(u32))
 789                                 goto invalid_tlv_len;
 790                         capa->standard_phy_calibration_size =
 791                                         le32_to_cpup((__le32 *)tlv_data);
 792                         break;
 793                  case IWL_UCODE_TLV_SEC_RT:
 794                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
 795                                             tlv_len);
 796                         drv->fw.mvm_fw = true;
 797                         break;
 798                 case IWL_UCODE_TLV_SEC_INIT:
 799                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
 800                                             tlv_len);
 801                         drv->fw.mvm_fw = true;
 802                         break;
 803                 case IWL_UCODE_TLV_SEC_WOWLAN:
 804                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
 805                                             tlv_len);
 806                         drv->fw.mvm_fw = true;
 807                         break;
 808                 case IWL_UCODE_TLV_DEF_CALIB:
 809                         if (tlv_len != sizeof(struct iwl_tlv_calib_data))
 810                                 goto invalid_tlv_len;
 811                         if (iwl_set_default_calib(drv, tlv_data))
 812                                 goto tlv_error;
 813                         break;
 814                 case IWL_UCODE_TLV_PHY_SKU:
 815                         if (tlv_len != sizeof(u32))
 816                                 goto invalid_tlv_len;
 817                         drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
 818                         drv->fw.valid_tx_ant = (drv->fw.phy_config &
 819                                                 FW_PHY_CFG_TX_CHAIN) >>
 820                                                 FW_PHY_CFG_TX_CHAIN_POS;
 821                         drv->fw.valid_rx_ant = (drv->fw.phy_config &
 822                                                 FW_PHY_CFG_RX_CHAIN) >>
 823                                                 FW_PHY_CFG_RX_CHAIN_POS;
 824                         break;
 825                  case IWL_UCODE_TLV_SECURE_SEC_RT:
 826                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
 827                                             tlv_len);
 828                         drv->fw.mvm_fw = true;
 829                         break;
 830                 case IWL_UCODE_TLV_SECURE_SEC_INIT:
 831                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
 832                                             tlv_len);
 833                         drv->fw.mvm_fw = true;
 834                         break;
 835                 case IWL_UCODE_TLV_SECURE_SEC_WOWLAN:
 836                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
 837                                             tlv_len);
 838                         drv->fw.mvm_fw = true;
 839                         break;
 840                 case IWL_UCODE_TLV_NUM_OF_CPU:
 841                         if (tlv_len != sizeof(u32))
 842                                 goto invalid_tlv_len;
 843                         num_of_cpus =
 844                                 le32_to_cpup((__le32 *)tlv_data);
 845
 846                         if (num_of_cpus == 2) {
 847                                 drv->fw.img[IWL_UCODE_REGULAR].is_dual_cpus =
 848                                         true;
 849                                 drv->fw.img[IWL_UCODE_INIT].is_dual_cpus =
 850                                         true;
 851                                 drv->fw.img[IWL_UCODE_WOWLAN].is_dual_cpus =
 852                                         true;
 853                         } else if ((num_of_cpus > 2) || (num_of_cpus < 1)) {
 854                                 IWL_ERR(drv, "Driver support upto 2 CPUs\n");
 855                                 return -EINVAL;
 856                         }
 857                         break;
 858                 case IWL_UCODE_TLV_CSCHEME:
 859                         if (iwl_store_cscheme(&drv->fw, tlv_data, tlv_len))
 860                                 goto invalid_tlv_len;
 861                         break;
 862                 case IWL_UCODE_TLV_N_SCAN_CHANNELS:
 863                         if (tlv_len != sizeof(u32))
 864                                 goto invalid_tlv_len;
 865                         capa->n_scan_channels =
 866                                 le32_to_cpup((__le32 *)tlv_data);
 867                         break;
 868                 case IWL_UCODE_TLV_FW_DBG_DEST: {
 869                         struct iwl_fw_dbg_dest_tlv *dest = (void *)tlv_data;
 870
 871                         if (pieces->dbg_dest_tlv) {
 872                                 IWL_ERR(drv,
 873                                         "dbg destination ignored, already exists\n");
 874                                 break;
 875                         }
 876
 877                         pieces->dbg_dest_tlv = dest;
 878                         IWL_INFO(drv, "Found debug destination: %s\n",
 879                                  get_fw_dbg_mode_string(dest->monitor_mode));
 880
 881                         drv->fw.dbg_dest_reg_num =
 882                                 tlv_len - offsetof(struct iwl_fw_dbg_dest_tlv,
 883                                                    reg_ops);
 884                         drv->fw.dbg_dest_reg_num /=
 885                                 sizeof(drv->fw.dbg_dest_tlv->reg_ops[0]);
 886
 887                         break;
 888                         }
 889                 case IWL_UCODE_TLV_FW_DBG_CONF: {
 890                         struct iwl_fw_dbg_conf_tlv *conf = (void *)tlv_data;
 891
 892                         if (!pieces->dbg_dest_tlv) {
 893                                 IWL_ERR(drv,
 894                                         "Ignore dbg config %d - no destination configured\n",
 895                                         conf->id);
 896                                 break;
 897                         }
 898
 899                         if (conf->id >= ARRAY_SIZE(drv->fw.dbg_conf_tlv)) {
 900                                 IWL_ERR(drv,
 901                                         "Skip unknown configuration: %d\n",
 902                                         conf->id);
 903                                 break;
 904                         }
 905
 906                         if (pieces->dbg_conf_tlv[conf->id]) {
 907                                 IWL_ERR(drv,
 908                                         "Ignore duplicate dbg config %d\n",
 909                                         conf->id);
 910                                 break;
 911                         }
 912
 913                         if (conf->usniffer)
 914                                 usniffer_req = true;
 915
 916                         IWL_INFO(drv, "Found debug configuration: %d\n",
 917                                  conf->id);
 918
 919                         pieces->dbg_conf_tlv[conf->id] = conf;
 920                         pieces->dbg_conf_tlv_len[conf->id] = tlv_len;
 921                         break;
 922                         }
 923                 case IWL_UCODE_TLV_SEC_RT_USNIFFER:
 924                         usniffer_images = true;
 925                         iwl_store_ucode_sec(pieces, tlv_data,
 926                                             IWL_UCODE_REGULAR_USNIFFER,
 927                                             tlv_len);
 928                         break;
 929                 default:
 930                         IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
 931                         break;
 932                 }
 933         }
 934
 935         if (usniffer_req && !usniffer_images) {
 936                 IWL_ERR(drv,
 937                         "user selected to work with usniffer but usniffer image isn't available in ucode package\n");
 938                 return -EINVAL;
 939         }
 940
 941         if (len) {
 942                 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
 943                 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
 944                 return -EINVAL;
 945         }
 946
 947         return 0;
 948
 949  invalid_tlv_len:
 950         IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
 951  tlv_error:
 952         iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
 953
 954         return -EINVAL;
 955 }
 956
 957 static int iwl_alloc_ucode(struct iwl_drv *drv,
 958                            struct iwl_firmware_pieces *pieces,
 959                            enum iwl_ucode_type type)
 960 {
 961         int i;
 962         for (i = 0;
 963              i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
 964              i++)
 965                 if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
 966                                       get_sec(pieces, type, i)))
 967                         return -ENOMEM;
 968         return 0;
 969 }
 970
 971 static int validate_sec_sizes(struct iwl_drv *drv,
 972                               struct iwl_firmware_pieces *pieces,
 973                               const struct iwl_cfg *cfg)
 974 {
 975         IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
 976                 get_sec_size(pieces, IWL_UCODE_REGULAR,
 977                              IWL_UCODE_SECTION_INST));
 978         IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
 979                 get_sec_size(pieces, IWL_UCODE_REGULAR,
 980                              IWL_UCODE_SECTION_DATA));
 981         IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
 982                 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
 983         IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
 984                 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
 985
 986         /* Verify that uCode images will fit in card's SRAM. */
 987         if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
 988                                                         cfg->max_inst_size) {
 989                 IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
 990                         get_sec_size(pieces, IWL_UCODE_REGULAR,
 991                                                 IWL_UCODE_SECTION_INST));
 992                 return -1;
 993         }
 994
 995         if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
 996                                                         cfg->max_data_size) {
 997                 IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
 998                         get_sec_size(pieces, IWL_UCODE_REGULAR,
 999                                                 IWL_UCODE_SECTION_DATA));
1000                 return -1;
1001         }
1002
1003          if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
1004                                                         cfg->max_inst_size) {
1005                 IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
1006                         get_sec_size(pieces, IWL_UCODE_INIT,
1007                                                 IWL_UCODE_SECTION_INST));
1008                 return -1;
1009         }
1010
1011         if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
1012                                                         cfg->max_data_size) {
1013                 IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
1014                         get_sec_size(pieces, IWL_UCODE_REGULAR,
1015                                                 IWL_UCODE_SECTION_DATA));
1016                 return -1;
1017         }
1018         return 0;
1019 }
1020
1021 static struct iwl_op_mode *
1022 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
1023 {
1024         const struct iwl_op_mode_ops *ops = op->ops;
1025         struct dentry *dbgfs_dir = NULL;
1026         struct iwl_op_mode *op_mode = NULL;
1027
1028 #ifdef CONFIG_IWLWIFI_DEBUGFS
1029         drv->dbgfs_op_mode = debugfs_create_dir(op->name,
1030                                                 drv->dbgfs_drv);
1031         if (!drv->dbgfs_op_mode) {
1032                 IWL_ERR(drv,
1033                         "failed to create opmode debugfs directory\n");
1034                 return op_mode;
1035         }
1036         dbgfs_dir = drv->dbgfs_op_mode;
1037 #endif
1038
1039         op_mode = ops->start(drv->trans, drv->cfg, &drv->fw, dbgfs_dir);
1040
1041 #ifdef CONFIG_IWLWIFI_DEBUGFS
1042         if (!op_mode) {
1043                 debugfs_remove_recursive(drv->dbgfs_op_mode);
1044                 drv->dbgfs_op_mode = NULL;
1045         }
1046 #endif
1047
1048         return op_mode;
1049 }
1050
1051 static void _iwl_op_mode_stop(struct iwl_drv *drv)
1052 {
1053         /* op_mode can be NULL if its start failed */
1054         if (drv->op_mode) {
1055                 iwl_op_mode_stop(drv->op_mode);
1056                 drv->op_mode = NULL;
1057
1058 #ifdef CONFIG_IWLWIFI_DEBUGFS
1059                 debugfs_remove_recursive(drv->dbgfs_op_mode);
1060                 drv->dbgfs_op_mode = NULL;
1061 #endif
1062         }
1063 }
1064
1065 /**
1066  * iwl_req_fw_callback - callback when firmware was loaded
1067  *
1068  * If loaded successfully, copies the firmware into buffers
1069  * for the card to fetch (via DMA).
1070  */
1071 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
1072 {
1073         struct iwl_drv *drv = context;
1074         struct iwl_fw *fw = &drv->fw;
1075         struct iwl_ucode_header *ucode;
1076         struct iwlwifi_opmode_table *op;
1077         int err;
1078         struct iwl_firmware_pieces *pieces;
1079         const unsigned int api_max = drv->cfg->ucode_api_max;
1080         unsigned int api_ok = drv->cfg->ucode_api_ok;
1081         const unsigned int api_min = drv->cfg->ucode_api_min;
1082         u32 api_ver;
1083         int i;
1084         bool load_module = false;
1085         u32 hw_rev = drv->trans->hw_rev;
1086
1087         fw->ucode_capa.max_probe_length = IWL_DEFAULT_MAX_PROBE_LENGTH;
1088         fw->ucode_capa.standard_phy_calibration_size =
1089                         IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1090         fw->ucode_capa.n_scan_channels = IWL_DEFAULT_SCAN_CHANNELS;
1091
1092         if (!api_ok)
1093                 api_ok = api_max;
1094
1095         pieces = kzalloc(sizeof(*pieces), GFP_KERNEL);
1096         if (!pieces)
1097                 return;
1098
1099         if (!ucode_raw) {
1100                 if (drv->fw_index <= api_ok)
1101                         IWL_ERR(drv,
1102                                 "request for firmware file '%s' failed.\n",
1103                                 drv->firmware_name);
1104                 goto try_again;
1105         }
1106
1107         IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
1108                        drv->firmware_name, ucode_raw->size);
1109
1110         /* Make sure that we got at least the API version number */
1111         if (ucode_raw->size < 4) {
1112                 IWL_ERR(drv, "File size way too small!\n");
1113                 goto try_again;
1114         }
1115
1116         /* Data from ucode file:  header followed by uCode images */
1117         ucode = (struct iwl_ucode_header *)ucode_raw->data;
1118
1119         if (ucode->ver)
1120                 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, pieces);
1121         else
1122                 err = iwl_parse_tlv_firmware(drv, ucode_raw, pieces,
1123                                              &fw->ucode_capa);
1124
1125         if (err)
1126                 goto try_again;
1127
1128         api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
1129
1130         /*
1131          * api_ver should match the api version forming part of the
1132          * firmware filename ... but we don't check for that and only rely
1133          * on the API version read from firmware header from here on forward
1134          */
1135         /* no api version check required for experimental uCode */
1136         if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
1137                 if (api_ver < api_min || api_ver > api_max) {
1138                         IWL_ERR(drv,
1139                                 "Driver unable to support your firmware API. "
1140                                 "Driver supports v%u, firmware is v%u.\n",
1141                                 api_max, api_ver);
1142                         goto try_again;
1143                 }
1144
1145                 if (api_ver < api_ok) {
1146                         if (api_ok != api_max)
1147                                 IWL_ERR(drv, "Firmware has old API version, "
1148                                         "expected v%u through v%u, got v%u.\n",
1149                                         api_ok, api_max, api_ver);
1150                         else
1151                                 IWL_ERR(drv, "Firmware has old API version, "
1152                                         "expected v%u, got v%u.\n",
1153                                         api_max, api_ver);
1154                         IWL_ERR(drv, "New firmware can be obtained from "
1155                                       "http://www.intellinuxwireless.org/.\n");
1156                 }
1157         }
1158
1159         /*
1160          * In mvm uCode there is no difference between data and instructions
1161          * sections.
1162          */
1163         if (!fw->mvm_fw && validate_sec_sizes(drv, pieces, drv->cfg))
1164                 goto try_again;
1165
1166         /* Allocate ucode buffers for card's bus-master loading ... */
1167
1168         /* Runtime instructions and 2 copies of data:
1169          * 1) unmodified from disk
1170          * 2) backup cache for save/restore during power-downs */
1171         for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
1172                 if (iwl_alloc_ucode(drv, pieces, i))
1173                         goto out_free_fw;
1174
1175         if (pieces->dbg_dest_tlv) {
1176                 drv->fw.dbg_dest_tlv =
1177                         kmemdup(pieces->dbg_dest_tlv,
1178                                 sizeof(*pieces->dbg_dest_tlv) +
1179                                 sizeof(pieces->dbg_dest_tlv->reg_ops[0]) *
1180                                 drv->fw.dbg_dest_reg_num, GFP_KERNEL);
1181
1182                 if (!drv->fw.dbg_dest_tlv)
1183                         goto out_free_fw;
1184         }
1185
1186         for (i = 0; i < ARRAY_SIZE(drv->fw.dbg_conf_tlv); i++) {
1187                 if (pieces->dbg_conf_tlv[i]) {
1188                         drv->fw.dbg_conf_tlv_len[i] =
1189                                 pieces->dbg_conf_tlv_len[i];
1190                         drv->fw.dbg_conf_tlv[i] =
1191                                 kmemdup(pieces->dbg_conf_tlv[i],
1192                                         drv->fw.dbg_conf_tlv_len[i],
1193                                         GFP_KERNEL);
1194                         if (!drv->fw.dbg_conf_tlv[i])
1195                                 goto out_free_fw;
1196                 }
1197         }
1198
1199         /* Now that we can no longer fail, copy information */
1200
1201         /*
1202          * The (size - 16) / 12 formula is based on the information recorded
1203          * for each event, which is of mode 1 (including timestamp) for all
1204          * new microcodes that include this information.
1205          */
1206         fw->init_evtlog_ptr = pieces->init_evtlog_ptr;
1207         if (pieces->init_evtlog_size)
1208                 fw->init_evtlog_size = (pieces->init_evtlog_size - 16)/12;
1209         else
1210                 fw->init_evtlog_size =
1211                         drv->cfg->base_params->max_event_log_size;
1212         fw->init_errlog_ptr = pieces->init_errlog_ptr;
1213         fw->inst_evtlog_ptr = pieces->inst_evtlog_ptr;
1214         if (pieces->inst_evtlog_size)
1215                 fw->inst_evtlog_size = (pieces->inst_evtlog_size - 16)/12;
1216         else
1217                 fw->inst_evtlog_size =
1218                         drv->cfg->base_params->max_event_log_size;
1219         fw->inst_errlog_ptr = pieces->inst_errlog_ptr;
1220
1221         /*
1222          * figure out the offset of chain noise reset and gain commands
1223          * base on the size of standard phy calibration commands table size
1224          */
1225         if (fw->ucode_capa.standard_phy_calibration_size >
1226             IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
1227                 fw->ucode_capa.standard_phy_calibration_size =
1228                         IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1229
1230         /* We have our copies now, allow OS release its copies */
1231         release_firmware(ucode_raw);
1232
1233         mutex_lock(&iwlwifi_opmode_table_mtx);
1234         if (fw->mvm_fw)
1235                 op = &iwlwifi_opmode_table[MVM_OP_MODE];
1236         else
1237                 op = &iwlwifi_opmode_table[DVM_OP_MODE];
1238
1239         IWL_INFO(drv, "loaded firmware version %s op_mode %s\n",
1240                  drv->fw.fw_version, op->name);
1241
1242         /* add this device to the list of devices using this op_mode */
1243         list_add_tail(&drv->list, &op->drv);
1244
1245         if (op->ops) {
1246                 drv->op_mode = _iwl_op_mode_start(drv, op);
1247
1248                 if (!drv->op_mode) {
1249                         mutex_unlock(&iwlwifi_opmode_table_mtx);
1250                         goto out_unbind;
1251                 }
1252         } else {
1253                 load_module = true;
1254         }
1255         mutex_unlock(&iwlwifi_opmode_table_mtx);
1256
1257         /*
1258          * Complete the firmware request last so that
1259          * a driver unbind (stop) doesn't run while we
1260          * are doing the start() above.
1261          */
1262         complete(&drv->request_firmware_complete);
1263
1264         /*
1265          * Load the module last so we don't block anything
1266          * else from proceeding if the module fails to load
1267          * or hangs loading.
1268          */
1269         if (load_module) {
1270                 err = request_module("%s", op->name);
1271 #ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
1272                 if (err)
1273                         IWL_ERR(drv,
1274                                 "failed to load module %s (error %d), is dynamic loading enabled?\n",
1275                                 op->name, err);
1276 #endif
1277         }
1278
1279         /*
1280          * We may have loaded the wrong FW file in 8000 HW family if it is an
1281          * A-step card, and if drv->trans->hw_rev wasn't properly read when
1282          * the FW file had been loaded. (This might happen in SDIO.) In such a
1283          * case - unload and reload the correct file.
1284          *
1285          * TODO:
1286          * Once there is only one supported step for 8000 family - delete this!
1287          */
1288         if (drv->trans->cfg->device_family == IWL_DEVICE_FAMILY_8000 &&
1289             CSR_HW_REV_STEP(drv->trans->hw_rev) == SILICON_A_STEP &&
1290             drv->trans->hw_rev != hw_rev) {
1291                 char firmware_name[32];
1292
1293                 /* Free previous FW resources */
1294                 if (drv->op_mode)
1295                         _iwl_op_mode_stop(drv);
1296                 iwl_dealloc_ucode(drv);
1297
1298                 /* Build name of correct-step FW */
1299                 snprintf(firmware_name, sizeof(firmware_name),
1300                          strrchr(drv->firmware_name, '-'));
1301                 snprintf(drv->firmware_name, sizeof(drv->firmware_name),
1302                          "%s%s", drv->cfg->fw_name_pre, firmware_name);
1303
1304                 /* Clear data before loading correct FW */
1305                 list_del(&drv->list);
1306
1307                 /* Request correct FW file this time */
1308                 IWL_DEBUG_INFO(drv, "attempting to load A-step FW %s\n",
1309                                drv->firmware_name);
1310                 err = request_firmware(&ucode_raw, drv->firmware_name,
1311                                        drv->trans->dev);
1312                 if (err) {
1313                         IWL_ERR(drv, "Failed swapping FW!\n");
1314                         goto out_unbind;
1315                 }
1316
1317                 /* Redo callback function - this time with right FW */
1318                 iwl_req_fw_callback(ucode_raw, context);
1319         }
1320
1321         kfree(pieces);
1322         return;
1323
1324  try_again:
1325         /* try next, if any */
1326         kfree(pieces);
1327         release_firmware(ucode_raw);
1328         if (iwl_request_firmware(drv, false))
1329                 goto out_unbind;
1330         return;
1331
1332  out_free_fw:
1333         IWL_ERR(drv, "failed to allocate pci memory\n");
1334         iwl_dealloc_ucode(drv);
1335         release_firmware(ucode_raw);
1336  out_unbind:
1337         kfree(pieces);
1338         complete(&drv->request_firmware_complete);
1339         device_release_driver(drv->trans->dev);
1340 }
1341
1342 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans,
1343                               const struct iwl_cfg *cfg)
1344 {
1345         struct iwl_drv *drv;
1346         int ret;
1347
1348         drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1349         if (!drv) {
1350                 ret = -ENOMEM;
1351                 goto err;
1352         }
1353
1354         drv->trans = trans;
1355         drv->dev = trans->dev;
1356         drv->cfg = cfg;
1357
1358         init_completion(&drv->request_firmware_complete);
1359         INIT_LIST_HEAD(&drv->list);
1360
1361 #ifdef CONFIG_IWLWIFI_DEBUGFS
1362         /* Create the device debugfs entries. */
1363         drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1364                                             iwl_dbgfs_root);
1365
1366         if (!drv->dbgfs_drv) {
1367                 IWL_ERR(drv, "failed to create debugfs directory\n");
1368                 ret = -ENOMEM;
1369                 goto err_free_drv;
1370         }
1371
1372         /* Create transport layer debugfs dir */
1373         drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1374
1375         if (!drv->trans->dbgfs_dir) {
1376                 IWL_ERR(drv, "failed to create transport debugfs directory\n");
1377                 ret = -ENOMEM;
1378                 goto err_free_dbgfs;
1379         }
1380 #endif
1381
1382         ret = iwl_request_firmware(drv, true);
1383         if (ret) {
1384                 IWL_ERR(trans, "Couldn't request the fw\n");
1385                 goto err_fw;
1386         }
1387
1388         return drv;
1389
1390 err_fw:
1391 #ifdef CONFIG_IWLWIFI_DEBUGFS
1392 err_free_dbgfs:
1393         debugfs_remove_recursive(drv->dbgfs_drv);
1394 err_free_drv:
1395 #endif
1396         kfree(drv);
1397 err:
1398         return ERR_PTR(ret);
1399 }
1400
1401 void iwl_drv_stop(struct iwl_drv *drv)
1402 {
1403         wait_for_completion(&drv->request_firmware_complete);
1404
1405         _iwl_op_mode_stop(drv);
1406
1407         iwl_dealloc_ucode(drv);
1408
1409         mutex_lock(&iwlwifi_opmode_table_mtx);
1410         /*
1411          * List is empty (this item wasn't added)
1412          * when firmware loading failed -- in that
1413          * case we can't remove it from any list.
1414          */
1415         if (!list_empty(&drv->list))
1416                 list_del(&drv->list);
1417         mutex_unlock(&iwlwifi_opmode_table_mtx);
1418
1419 #ifdef CONFIG_IWLWIFI_DEBUGFS
1420         debugfs_remove_recursive(drv->dbgfs_drv);
1421 #endif
1422
1423         kfree(drv);
1424 }
1425
1426
1427 /* shared module parameters */
1428 struct iwl_mod_params iwlwifi_mod_params = {
1429         .restart_fw = true,
1430         .bt_coex_active = true,
1431         .power_level = IWL_POWER_INDEX_1,
1432         .wd_disable = true,
1433 #ifndef CONFIG_IWLWIFI_UAPSD
1434         .uapsd_disable = true,
1435 #endif /* CONFIG_IWLWIFI_UAPSD */
1436         /* the rest are 0 by default */
1437 };
1438 IWL_EXPORT_SYMBOL(iwlwifi_mod_params);
1439
1440 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
1441 {
1442         int i;
1443         struct iwl_drv *drv;
1444         struct iwlwifi_opmode_table *op;
1445
1446         mutex_lock(&iwlwifi_opmode_table_mtx);
1447         for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1448                 op = &iwlwifi_opmode_table[i];
1449                 if (strcmp(op->name, name))
1450                         continue;
1451                 op->ops = ops;
1452                 /* TODO: need to handle exceptional case */
1453                 list_for_each_entry(drv, &op->drv, list)
1454                         drv->op_mode = _iwl_op_mode_start(drv, op);
1455
1456                 mutex_unlock(&iwlwifi_opmode_table_mtx);
1457                 return 0;
1458         }
1459         mutex_unlock(&iwlwifi_opmode_table_mtx);
1460         return -EIO;
1461 }
1462 IWL_EXPORT_SYMBOL(iwl_opmode_register);
1463
1464 void iwl_opmode_deregister(const char *name)
1465 {
1466         int i;
1467         struct iwl_drv *drv;
1468
1469         mutex_lock(&iwlwifi_opmode_table_mtx);
1470         for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1471                 if (strcmp(iwlwifi_opmode_table[i].name, name))
1472                         continue;
1473                 iwlwifi_opmode_table[i].ops = NULL;
1474
1475                 /* call the stop routine for all devices */
1476                 list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
1477                         _iwl_op_mode_stop(drv);
1478
1479                 mutex_unlock(&iwlwifi_opmode_table_mtx);
1480                 return;
1481         }
1482         mutex_unlock(&iwlwifi_opmode_table_mtx);
1483 }
1484 IWL_EXPORT_SYMBOL(iwl_opmode_deregister);
1485
1486 static int __init iwl_drv_init(void)
1487 {
1488         int i;
1489
1490         mutex_init(&iwlwifi_opmode_table_mtx);
1491
1492         for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
1493                 INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
1494
1495         pr_info(DRV_DESCRIPTION ", " DRV_VERSION "\n");
1496         pr_info(DRV_COPYRIGHT "\n");
1497
1498 #ifdef CONFIG_IWLWIFI_DEBUGFS
1499         /* Create the root of iwlwifi debugfs subsystem. */
1500         iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
1501
1502         if (!iwl_dbgfs_root)
1503                 return -EFAULT;
1504 #endif
1505
1506         return iwl_pci_register_driver();
1507 }
1508 module_init(iwl_drv_init);
1509
1510 static void __exit iwl_drv_exit(void)
1511 {
1512         iwl_pci_unregister_driver();
1513
1514 #ifdef CONFIG_IWLWIFI_DEBUGFS
1515         debugfs_remove_recursive(iwl_dbgfs_root);
1516 #endif
1517 }
1518 module_exit(iwl_drv_exit);
1519
1520 #ifdef CONFIG_IWLWIFI_DEBUG
1521 module_param_named(debug, iwlwifi_mod_params.debug_level, uint,
1522                    S_IRUGO | S_IWUSR);
1523 MODULE_PARM_DESC(debug, "debug output mask");
1524 #endif
1525
1526 module_param_named(swcrypto, iwlwifi_mod_params.sw_crypto, int, S_IRUGO);
1527 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
1528 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, S_IRUGO);
1529 MODULE_PARM_DESC(11n_disable,
1530         "disable 11n functionality, bitmap: 1: full, 2: disable agg TX, 4: disable agg RX, 8 enable agg TX");
1531 module_param_named(amsdu_size_8K, iwlwifi_mod_params.amsdu_size_8K,
1532                    int, S_IRUGO);
1533 MODULE_PARM_DESC(amsdu_size_8K, "enable 8K amsdu size (default 0)");
1534 module_param_named(fw_restart, iwlwifi_mod_params.restart_fw, bool, S_IRUGO);
1535 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error (default true)");
1536
1537 module_param_named(antenna_coupling, iwlwifi_mod_params.ant_coupling,
1538                    int, S_IRUGO);
1539 MODULE_PARM_DESC(antenna_coupling,
1540                  "specify antenna coupling in dB (default: 0 dB)");
1541
1542 module_param_named(wd_disable, iwlwifi_mod_params.wd_disable, int, S_IRUGO);
1543 MODULE_PARM_DESC(wd_disable,
1544                 "Disable stuck queue watchdog timer 0=system default, 1=disable (default: 1)");
1545
1546 module_param_named(nvm_file, iwlwifi_mod_params.nvm_file, charp, S_IRUGO);
1547 MODULE_PARM_DESC(nvm_file, "NVM file name");
1548
1549 module_param_named(uapsd_disable, iwlwifi_mod_params.uapsd_disable,
1550                    bool, S_IRUGO);
1551 #ifdef CONFIG_IWLWIFI_UAPSD
1552 MODULE_PARM_DESC(uapsd_disable, "disable U-APSD functionality (default: N)");
1553 #else
1554 MODULE_PARM_DESC(uapsd_disable, "disable U-APSD functionality (default: Y)");
1555 #endif
1556
1557 /*
1558  * set bt_coex_active to true, uCode will do kill/defer
1559  * every time the priority line is asserted (BT is sending signals on the
1560  * priority line in the PCIx).
1561  * set bt_coex_active to false, uCode will ignore the BT activity and
1562  * perform the normal operation
1563  *
1564  * User might experience transmit issue on some platform due to WiFi/BT
1565  * co-exist problem. The possible behaviors are:
1566  *   Able to scan and finding all the available AP
1567  *   Not able to associate with any AP
1568  * On those platforms, WiFi communication can be restored by set
1569  * "bt_coex_active" module parameter to "false"
1570  *
1571  * default: bt_coex_active = true (BT_COEX_ENABLE)
1572  */
1573 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1574                 bool, S_IRUGO);
1575 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1576
1577 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, S_IRUGO);
1578 MODULE_PARM_DESC(led_mode, "0=system default, "
1579                 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1580
1581 module_param_named(power_save, iwlwifi_mod_params.power_save,
1582                 bool, S_IRUGO);
1583 MODULE_PARM_DESC(power_save,
1584                  "enable WiFi power management (default: disable)");
1585
1586 module_param_named(power_level, iwlwifi_mod_params.power_level,
1587                 int, S_IRUGO);
1588 MODULE_PARM_DESC(power_level,
1589                  "default power save level (range from 1 - 5, default: 1)");
1590
1591 module_param_named(fw_monitor, iwlwifi_mod_params.fw_monitor, bool, S_IRUGO);
1592 MODULE_PARM_DESC(fw_monitor,
1593                  "firmware monitor - to debug FW (default: false - needs lots of memory)");