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