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