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