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         for (i = 0; i < ARRAY_SIZE(drv->fw.dbg_trigger_tlv); i++)
 179                 kfree(drv->fw.dbg_trigger_tlv[i]);
 180
 181         for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
 182                 iwl_free_fw_img(drv, drv->fw.img + i);
 183 }
 184
 185 static int iwl_alloc_fw_desc(struct iwl_drv *drv, struct fw_desc *desc,
 186                              struct fw_sec *sec)
 187 {
 188         void *data;
 189
 190         desc->data = NULL;
 191
 192         if (!sec || !sec->size)
 193                 return -EINVAL;
 194
 195         data = vmalloc(sec->size);
 196         if (!data)
 197                 return -ENOMEM;
 198
 199         desc->len = sec->size;
 200         desc->offset = sec->offset;
 201         memcpy(data, sec->data, desc->len);
 202         desc->data = data;
 203
 204         return 0;
 205 }
 206
 207 static void iwl_req_fw_callback(const struct firmware *ucode_raw,
 208                                 void *context);
 209
 210 #define UCODE_EXPERIMENTAL_INDEX        100
 211 #define UCODE_EXPERIMENTAL_TAG          "exp"
 212
 213 static int iwl_request_firmware(struct iwl_drv *drv, bool first)
 214 {
 215         const char *name_pre = drv->cfg->fw_name_pre;
 216         char tag[8];
 217
 218         if (first) {
 219 #ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
 220                 drv->fw_index = UCODE_EXPERIMENTAL_INDEX;
 221                 strcpy(tag, UCODE_EXPERIMENTAL_TAG);
 222         } else if (drv->fw_index == UCODE_EXPERIMENTAL_INDEX) {
 223 #endif
 224                 drv->fw_index = drv->cfg->ucode_api_max;
 225                 sprintf(tag, "%d", drv->fw_index);
 226         } else {
 227                 drv->fw_index--;
 228                 sprintf(tag, "%d", drv->fw_index);
 229         }
 230
 231         if (drv->fw_index < drv->cfg->ucode_api_min) {
 232                 IWL_ERR(drv, "no suitable firmware found!\n");
 233                 return -ENOENT;
 234         }
 235
 236         snprintf(drv->firmware_name, sizeof(drv->firmware_name), "%s%s.ucode",
 237                  name_pre, tag);
 238
 239         /*
 240          * Starting 8000B - FW name format has changed. This overwrites the
 241          * previous name and uses the new format.
 242          */
 243         if (drv->trans->cfg->device_family == IWL_DEVICE_FAMILY_8000) {
 244                 char rev_step[2] = {
 245                         'A' + CSR_HW_REV_STEP(drv->trans->hw_rev), 0
 246                 };
 247
 248                 /* A-step doesn't have an indication */
 249                 if (CSR_HW_REV_STEP(drv->trans->hw_rev) == SILICON_A_STEP)
 250                         rev_step[0] = 0;
 251
 252                 snprintf(drv->firmware_name, sizeof(drv->firmware_name),
 253                          "%s%s-%s.ucode", name_pre, rev_step, tag);
 254         }
 255
 256         IWL_DEBUG_INFO(drv, "attempting to load firmware %s'%s'\n",
 257                        (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
 258                                 ? "EXPERIMENTAL " : "",
 259                        drv->firmware_name);
 260
 261         return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
 262                                        drv->trans->dev,
 263                                        GFP_KERNEL, drv, iwl_req_fw_callback);
 264 }
 265
 266 struct fw_img_parsing {
 267         struct fw_sec sec[IWL_UCODE_SECTION_MAX];
 268         int sec_counter;
 269 };
 270
 271 /*
 272  * struct fw_sec_parsing: to extract fw section and it's offset from tlv
 273  */
 274 struct fw_sec_parsing {
 275         __le32 offset;
 276         const u8 data[];
 277 } __packed;
 278
 279 /**
 280  * struct iwl_tlv_calib_data - parse the default calib data from TLV
 281  *
 282  * @ucode_type: the uCode to which the following default calib relates.
 283  * @calib: default calibrations.
 284  */
 285 struct iwl_tlv_calib_data {
 286         __le32 ucode_type;
 287         struct iwl_tlv_calib_ctrl calib;
 288 } __packed;
 289
 290 struct iwl_firmware_pieces {
 291         struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
 292
 293         u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
 294         u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
 295
 296         /* FW debug data parsed for driver usage */
 297         struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
 298         struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
 299         size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX];
 300         struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX];
 301         size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX];
 302 };
 303
 304 /*
 305  * These functions are just to extract uCode section data from the pieces
 306  * structure.
 307  */
 308 static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
 309                               enum iwl_ucode_type type,
 310                               int  sec)
 311 {
 312         return &pieces->img[type].sec[sec];
 313 }
 314
 315 static void set_sec_data(struct iwl_firmware_pieces *pieces,
 316                          enum iwl_ucode_type type,
 317                          int sec,
 318                          const void *data)
 319 {
 320         pieces->img[type].sec[sec].data = data;
 321 }
 322
 323 static void set_sec_size(struct iwl_firmware_pieces *pieces,
 324                          enum iwl_ucode_type type,
 325                          int sec,
 326                          size_t size)
 327 {
 328         pieces->img[type].sec[sec].size = size;
 329 }
 330
 331 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
 332                            enum iwl_ucode_type type,
 333                            int sec)
 334 {
 335         return pieces->img[type].sec[sec].size;
 336 }
 337
 338 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
 339                            enum iwl_ucode_type type,
 340                            int sec,
 341                            u32 offset)
 342 {
 343         pieces->img[type].sec[sec].offset = offset;
 344 }
 345
 346 static int iwl_store_cscheme(struct iwl_fw *fw, const u8 *data, const u32 len)
 347 {
 348         int i, j;
 349         struct iwl_fw_cscheme_list *l = (struct iwl_fw_cscheme_list *)data;
 350         struct iwl_fw_cipher_scheme *fwcs;
 351         struct ieee80211_cipher_scheme *cs;
 352         u32 cipher;
 353
 354         if (len < sizeof(*l) ||
 355             len < sizeof(l->size) + l->size * sizeof(l->cs[0]))
 356                 return -EINVAL;
 357
 358         for (i = 0, j = 0; i < IWL_UCODE_MAX_CS && i < l->size; i++) {
 359                 fwcs = &l->cs[j];
 360                 cipher = le32_to_cpu(fwcs->cipher);
 361
 362                 /* we skip schemes with zero cipher suite selector */
 363                 if (!cipher)
 364                         continue;
 365
 366                 cs = &fw->cs[j++];
 367                 cs->cipher = cipher;
 368                 cs->iftype = BIT(NL80211_IFTYPE_STATION);
 369                 cs->hdr_len = fwcs->hdr_len;
 370                 cs->pn_len = fwcs->pn_len;
 371                 cs->pn_off = fwcs->pn_off;
 372                 cs->key_idx_off = fwcs->key_idx_off;
 373                 cs->key_idx_mask = fwcs->key_idx_mask;
 374                 cs->key_idx_shift = fwcs->key_idx_shift;
 375                 cs->mic_len = fwcs->mic_len;
 376         }
 377
 378         return 0;
 379 }
 380
 381 /*
 382  * Gets uCode section from tlv.
 383  */
 384 static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
 385                                const void *data, enum iwl_ucode_type type,
 386                                int size)
 387 {
 388         struct fw_img_parsing *img;
 389         struct fw_sec *sec;
 390         struct fw_sec_parsing *sec_parse;
 391
 392         if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
 393                 return -1;
 394
 395         sec_parse = (struct fw_sec_parsing *)data;
 396
 397         img = &pieces->img[type];
 398         sec = &img->sec[img->sec_counter];
 399
 400         sec->offset = le32_to_cpu(sec_parse->offset);
 401         sec->data = sec_parse->data;
 402         sec->size = size - sizeof(sec_parse->offset);
 403
 404         ++img->sec_counter;
 405
 406         return 0;
 407 }
 408
 409 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
 410 {
 411         struct iwl_tlv_calib_data *def_calib =
 412                                         (struct iwl_tlv_calib_data *)data;
 413         u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
 414         if (ucode_type >= IWL_UCODE_TYPE_MAX) {
 415                 IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
 416                         ucode_type);
 417                 return -EINVAL;
 418         }
 419         drv->fw.default_calib[ucode_type].flow_trigger =
 420                 def_calib->calib.flow_trigger;
 421         drv->fw.default_calib[ucode_type].event_trigger =
 422                 def_calib->calib.event_trigger;
 423
 424         return 0;
 425 }
 426
 427 static int iwl_set_ucode_api_flags(struct iwl_drv *drv, const u8 *data,
 428                                    struct iwl_ucode_capabilities *capa)
 429 {
 430         const struct iwl_ucode_api *ucode_api = (void *)data;
 431         u32 api_index = le32_to_cpu(ucode_api->api_index);
 432
 433         if (api_index >= IWL_API_ARRAY_SIZE) {
 434                 IWL_ERR(drv, "api_index larger than supported by driver\n");
 435                 return -EINVAL;
 436         }
 437
 438         capa->api[api_index] = le32_to_cpu(ucode_api->api_flags);
 439
 440         return 0;
 441 }
 442
 443 static int iwl_set_ucode_capabilities(struct iwl_drv *drv, const u8 *data,
 444                                       struct iwl_ucode_capabilities *capa)
 445 {
 446         const struct iwl_ucode_capa *ucode_capa = (void *)data;
 447         u32 api_index = le32_to_cpu(ucode_capa->api_index);
 448
 449         if (api_index >= IWL_CAPABILITIES_ARRAY_SIZE) {
 450                 IWL_ERR(drv, "api_index larger than supported by driver\n");
 451                 return -EINVAL;
 452         }
 453
 454         capa->capa[api_index] = le32_to_cpu(ucode_capa->api_capa);
 455
 456         return 0;
 457 }
 458
 459 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
 460                                     const struct firmware *ucode_raw,
 461                                     struct iwl_firmware_pieces *pieces)
 462 {
 463         struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
 464         u32 api_ver, hdr_size, build;
 465         char buildstr[25];
 466         const u8 *src;
 467
 468         drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
 469         api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
 470
 471         switch (api_ver) {
 472         default:
 473                 hdr_size = 28;
 474                 if (ucode_raw->size < hdr_size) {
 475                         IWL_ERR(drv, "File size too small!\n");
 476                         return -EINVAL;
 477                 }
 478                 build = le32_to_cpu(ucode->u.v2.build);
 479                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
 480                              le32_to_cpu(ucode->u.v2.inst_size));
 481                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
 482                              le32_to_cpu(ucode->u.v2.data_size));
 483                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
 484                              le32_to_cpu(ucode->u.v2.init_size));
 485                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
 486                              le32_to_cpu(ucode->u.v2.init_data_size));
 487                 src = ucode->u.v2.data;
 488                 break;
 489         case 0:
 490         case 1:
 491         case 2:
 492                 hdr_size = 24;
 493                 if (ucode_raw->size < hdr_size) {
 494                         IWL_ERR(drv, "File size too small!\n");
 495                         return -EINVAL;
 496                 }
 497                 build = 0;
 498                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
 499                              le32_to_cpu(ucode->u.v1.inst_size));
 500                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
 501                              le32_to_cpu(ucode->u.v1.data_size));
 502                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
 503                              le32_to_cpu(ucode->u.v1.init_size));
 504                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
 505                              le32_to_cpu(ucode->u.v1.init_data_size));
 506                 src = ucode->u.v1.data;
 507                 break;
 508         }
 509
 510         if (build)
 511                 sprintf(buildstr, " build %u%s", build,
 512                        (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
 513                                 ? " (EXP)" : "");
 514         else
 515                 buildstr[0] = '\0';
 516
 517         snprintf(drv->fw.fw_version,
 518                  sizeof(drv->fw.fw_version),
 519                  "%u.%u.%u.%u%s",
 520                  IWL_UCODE_MAJOR(drv->fw.ucode_ver),
 521                  IWL_UCODE_MINOR(drv->fw.ucode_ver),
 522                  IWL_UCODE_API(drv->fw.ucode_ver),
 523                  IWL_UCODE_SERIAL(drv->fw.ucode_ver),
 524                  buildstr);
 525
 526         /* Verify size of file vs. image size info in file's header */
 527
 528         if (ucode_raw->size != hdr_size +
 529             get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
 530             get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
 531             get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
 532             get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
 533
 534                 IWL_ERR(drv,
 535                         "uCode file size %d does not match expected size\n",
 536                         (int)ucode_raw->size);
 537                 return -EINVAL;
 538         }
 539
 540
 541         set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
 542         src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
 543         set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
 544                        IWLAGN_RTC_INST_LOWER_BOUND);
 545         set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
 546         src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
 547         set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
 548                        IWLAGN_RTC_DATA_LOWER_BOUND);
 549         set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
 550         src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
 551         set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
 552                        IWLAGN_RTC_INST_LOWER_BOUND);
 553         set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
 554         src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
 555         set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
 556                        IWLAGN_RTC_DATA_LOWER_BOUND);
 557         return 0;
 558 }
 559
 560 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
 561                                 const struct firmware *ucode_raw,
 562                                 struct iwl_firmware_pieces *pieces,
 563                                 struct iwl_ucode_capabilities *capa)
 564 {
 565         struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
 566         struct iwl_ucode_tlv *tlv;
 567         size_t len = ucode_raw->size;
 568         const u8 *data;
 569         u32 tlv_len;
 570         enum iwl_ucode_tlv_type tlv_type;
 571         const u8 *tlv_data;
 572         char buildstr[25];
 573         u32 build;
 574         int num_of_cpus;
 575         bool usniffer_images = false;
 576         bool usniffer_req = false;
 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                         break;
 811                 case IWL_UCODE_TLV_SECURE_SEC_INIT:
 812                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
 813                                             tlv_len);
 814                         drv->fw.mvm_fw = true;
 815                         break;
 816                 case IWL_UCODE_TLV_SECURE_SEC_WOWLAN:
 817                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
 818                                             tlv_len);
 819                         drv->fw.mvm_fw = true;
 820                         break;
 821                 case IWL_UCODE_TLV_NUM_OF_CPU:
 822                         if (tlv_len != sizeof(u32))
 823                                 goto invalid_tlv_len;
 824                         num_of_cpus =
 825                                 le32_to_cpup((__le32 *)tlv_data);
 826
 827                         if (num_of_cpus == 2) {
 828                                 drv->fw.img[IWL_UCODE_REGULAR].is_dual_cpus =
 829                                         true;
 830                                 drv->fw.img[IWL_UCODE_INIT].is_dual_cpus =
 831                                         true;
 832                                 drv->fw.img[IWL_UCODE_WOWLAN].is_dual_cpus =
 833                                         true;
 834                         } else if ((num_of_cpus > 2) || (num_of_cpus < 1)) {
 835                                 IWL_ERR(drv, "Driver support upto 2 CPUs\n");
 836                                 return -EINVAL;
 837                         }
 838                         break;
 839                 case IWL_UCODE_TLV_CSCHEME:
 840                         if (iwl_store_cscheme(&drv->fw, tlv_data, tlv_len))
 841                                 goto invalid_tlv_len;
 842                         break;
 843                 case IWL_UCODE_TLV_N_SCAN_CHANNELS:
 844                         if (tlv_len != sizeof(u32))
 845                                 goto invalid_tlv_len;
 846                         capa->n_scan_channels =
 847                                 le32_to_cpup((__le32 *)tlv_data);
 848                         break;
 849                 case IWL_UCODE_TLV_FW_VERSION: {
 850                         __le32 *ptr = (void *)tlv_data;
 851                         u32 major, minor;
 852                         u8 local_comp;
 853
 854                         if (tlv_len != sizeof(u32) * 3)
 855                                 goto invalid_tlv_len;
 856
 857                         major = le32_to_cpup(ptr++);
 858                         minor = le32_to_cpup(ptr++);
 859                         local_comp = le32_to_cpup(ptr);
 860
 861                         snprintf(drv->fw.fw_version,
 862                                  sizeof(drv->fw.fw_version), "%u.%u.%u",
 863                                  major, minor, local_comp);
 864                         break;
 865                         }
 866                 case IWL_UCODE_TLV_FW_DBG_DEST: {
 867                         struct iwl_fw_dbg_dest_tlv *dest = (void *)tlv_data;
 868
 869                         if (pieces->dbg_dest_tlv) {
 870                                 IWL_ERR(drv,
 871                                         "dbg destination ignored, already exists\n");
 872                                 break;
 873                         }
 874
 875                         pieces->dbg_dest_tlv = dest;
 876                         IWL_INFO(drv, "Found debug destination: %s\n",
 877                                  get_fw_dbg_mode_string(dest->monitor_mode));
 878
 879                         drv->fw.dbg_dest_reg_num =
 880                                 tlv_len - offsetof(struct iwl_fw_dbg_dest_tlv,
 881                                                    reg_ops);
 882                         drv->fw.dbg_dest_reg_num /=
 883                                 sizeof(drv->fw.dbg_dest_tlv->reg_ops[0]);
 884
 885                         break;
 886                         }
 887                 case IWL_UCODE_TLV_FW_DBG_CONF: {
 888                         struct iwl_fw_dbg_conf_tlv *conf = (void *)tlv_data;
 889
 890                         if (!pieces->dbg_dest_tlv) {
 891                                 IWL_ERR(drv,
 892                                         "Ignore dbg config %d - no destination configured\n",
 893                                         conf->id);
 894                                 break;
 895                         }
 896
 897                         if (conf->id >= ARRAY_SIZE(drv->fw.dbg_conf_tlv)) {
 898                                 IWL_ERR(drv,
 899                                         "Skip unknown configuration: %d\n",
 900                                         conf->id);
 901                                 break;
 902                         }
 903
 904                         if (pieces->dbg_conf_tlv[conf->id]) {
 905                                 IWL_ERR(drv,
 906                                         "Ignore duplicate dbg config %d\n",
 907                                         conf->id);
 908                                 break;
 909                         }
 910
 911                         if (conf->usniffer)
 912                                 usniffer_req = true;
 913
 914                         IWL_INFO(drv, "Found debug configuration: %d\n",
 915                                  conf->id);
 916
 917                         pieces->dbg_conf_tlv[conf->id] = conf;
 918                         pieces->dbg_conf_tlv_len[conf->id] = tlv_len;
 919                         break;
 920                         }
 921                 case IWL_UCODE_TLV_FW_DBG_TRIGGER: {
 922                         struct iwl_fw_dbg_trigger_tlv *trigger =
 923                                 (void *)tlv_data;
 924                         u32 trigger_id = le32_to_cpu(trigger->id);
 925
 926                         if (trigger_id >= ARRAY_SIZE(drv->fw.dbg_trigger_tlv)) {
 927                                 IWL_ERR(drv,
 928                                         "Skip unknown trigger: %u\n",
 929                                         trigger->id);
 930                                 break;
 931                         }
 932
 933                         if (pieces->dbg_trigger_tlv[trigger_id]) {
 934                                 IWL_ERR(drv,
 935                                         "Ignore duplicate dbg trigger %u\n",
 936                                         trigger->id);
 937                                 break;
 938                         }
 939
 940                         IWL_INFO(drv, "Found debug trigger: %u\n", trigger->id);
 941
 942                         pieces->dbg_trigger_tlv[trigger_id] = trigger;
 943                         pieces->dbg_trigger_tlv_len[trigger_id] = tlv_len;
 944                         break;
 945                         }
 946                 case IWL_UCODE_TLV_SEC_RT_USNIFFER:
 947                         usniffer_images = true;
 948                         iwl_store_ucode_sec(pieces, tlv_data,
 949                                             IWL_UCODE_REGULAR_USNIFFER,
 950                                             tlv_len);
 951                         break;
 952                 case IWL_UCODE_TLV_SDIO_ADMA_ADDR:
 953                         if (tlv_len != sizeof(u32))
 954                                 goto invalid_tlv_len;
 955                         drv->fw.sdio_adma_addr =
 956                                 le32_to_cpup((__le32 *)tlv_data);
 957                         break;
 958                 default:
 959                         IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
 960                         break;
 961                 }
 962         }
 963
 964         if (usniffer_req && !usniffer_images) {
 965                 IWL_ERR(drv,
 966                         "user selected to work with usniffer but usniffer image isn't available in ucode package\n");
 967                 return -EINVAL;
 968         }
 969
 970         if (len) {
 971                 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
 972                 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
 973                 return -EINVAL;
 974         }
 975
 976         return 0;
 977
 978  invalid_tlv_len:
 979         IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
 980  tlv_error:
 981         iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
 982
 983         return -EINVAL;
 984 }
 985
 986 static int iwl_alloc_ucode(struct iwl_drv *drv,
 987                            struct iwl_firmware_pieces *pieces,
 988                            enum iwl_ucode_type type)
 989 {
 990         int i;
 991         for (i = 0;
 992              i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
 993              i++)
 994                 if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
 995                                       get_sec(pieces, type, i)))
 996                         return -ENOMEM;
 997         return 0;
 998 }
 999
1000 static int validate_sec_sizes(struct iwl_drv *drv,
1001                               struct iwl_firmware_pieces *pieces,
1002                               const struct iwl_cfg *cfg)
1003 {
1004         IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
1005                 get_sec_size(pieces, IWL_UCODE_REGULAR,
1006                              IWL_UCODE_SECTION_INST));
1007         IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
1008                 get_sec_size(pieces, IWL_UCODE_REGULAR,
1009                              IWL_UCODE_SECTION_DATA));
1010         IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
1011                 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
1012         IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
1013                 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
1014
1015         /* Verify that uCode images will fit in card's SRAM. */
1016         if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
1017                                                         cfg->max_inst_size) {
1018                 IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
1019                         get_sec_size(pieces, IWL_UCODE_REGULAR,
1020                                                 IWL_UCODE_SECTION_INST));
1021                 return -1;
1022         }
1023
1024         if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
1025                                                         cfg->max_data_size) {
1026                 IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
1027                         get_sec_size(pieces, IWL_UCODE_REGULAR,
1028                                                 IWL_UCODE_SECTION_DATA));
1029                 return -1;
1030         }
1031
1032          if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
1033                                                         cfg->max_inst_size) {
1034                 IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
1035                         get_sec_size(pieces, IWL_UCODE_INIT,
1036                                                 IWL_UCODE_SECTION_INST));
1037                 return -1;
1038         }
1039
1040         if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
1041                                                         cfg->max_data_size) {
1042                 IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
1043                         get_sec_size(pieces, IWL_UCODE_REGULAR,
1044                                                 IWL_UCODE_SECTION_DATA));
1045                 return -1;
1046         }
1047         return 0;
1048 }
1049
1050 static struct iwl_op_mode *
1051 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
1052 {
1053         const struct iwl_op_mode_ops *ops = op->ops;
1054         struct dentry *dbgfs_dir = NULL;
1055         struct iwl_op_mode *op_mode = NULL;
1056
1057 #ifdef CONFIG_IWLWIFI_DEBUGFS
1058         drv->dbgfs_op_mode = debugfs_create_dir(op->name,
1059                                                 drv->dbgfs_drv);
1060         if (!drv->dbgfs_op_mode) {
1061                 IWL_ERR(drv,
1062                         "failed to create opmode debugfs directory\n");
1063                 return op_mode;
1064         }
1065         dbgfs_dir = drv->dbgfs_op_mode;
1066 #endif
1067
1068         op_mode = ops->start(drv->trans, drv->cfg, &drv->fw, dbgfs_dir);
1069
1070 #ifdef CONFIG_IWLWIFI_DEBUGFS
1071         if (!op_mode) {
1072                 debugfs_remove_recursive(drv->dbgfs_op_mode);
1073                 drv->dbgfs_op_mode = NULL;
1074         }
1075 #endif
1076
1077         return op_mode;
1078 }
1079
1080 static void _iwl_op_mode_stop(struct iwl_drv *drv)
1081 {
1082         /* op_mode can be NULL if its start failed */
1083         if (drv->op_mode) {
1084                 iwl_op_mode_stop(drv->op_mode);
1085                 drv->op_mode = NULL;
1086
1087 #ifdef CONFIG_IWLWIFI_DEBUGFS
1088                 debugfs_remove_recursive(drv->dbgfs_op_mode);
1089                 drv->dbgfs_op_mode = NULL;
1090 #endif
1091         }
1092 }
1093
1094 /**
1095  * iwl_req_fw_callback - callback when firmware was loaded
1096  *
1097  * If loaded successfully, copies the firmware into buffers
1098  * for the card to fetch (via DMA).
1099  */
1100 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
1101 {
1102         struct iwl_drv *drv = context;
1103         struct iwl_fw *fw = &drv->fw;
1104         struct iwl_ucode_header *ucode;
1105         struct iwlwifi_opmode_table *op;
1106         int err;
1107         struct iwl_firmware_pieces *pieces;
1108         const unsigned int api_max = drv->cfg->ucode_api_max;
1109         unsigned int api_ok = drv->cfg->ucode_api_ok;
1110         const unsigned int api_min = drv->cfg->ucode_api_min;
1111         u32 api_ver;
1112         int i;
1113         bool load_module = false;
1114
1115         fw->ucode_capa.max_probe_length = IWL_DEFAULT_MAX_PROBE_LENGTH;
1116         fw->ucode_capa.standard_phy_calibration_size =
1117                         IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1118         fw->ucode_capa.n_scan_channels = IWL_DEFAULT_SCAN_CHANNELS;
1119
1120         if (!api_ok)
1121                 api_ok = api_max;
1122
1123         pieces = kzalloc(sizeof(*pieces), GFP_KERNEL);
1124         if (!pieces)
1125                 return;
1126
1127         if (!ucode_raw) {
1128                 if (drv->fw_index <= api_ok)
1129                         IWL_ERR(drv,
1130                                 "request for firmware file '%s' failed.\n",
1131                                 drv->firmware_name);
1132                 goto try_again;
1133         }
1134
1135         IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
1136                        drv->firmware_name, ucode_raw->size);
1137
1138         /* Make sure that we got at least the API version number */
1139         if (ucode_raw->size < 4) {
1140                 IWL_ERR(drv, "File size way too small!\n");
1141                 goto try_again;
1142         }
1143
1144         /* Data from ucode file:  header followed by uCode images */
1145         ucode = (struct iwl_ucode_header *)ucode_raw->data;
1146
1147         if (ucode->ver)
1148                 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, pieces);
1149         else
1150                 err = iwl_parse_tlv_firmware(drv, ucode_raw, pieces,
1151                                              &fw->ucode_capa);
1152
1153         if (err)
1154                 goto try_again;
1155
1156         if (drv->fw.ucode_capa.api[0] & IWL_UCODE_TLV_API_NEW_VERSION)
1157                 api_ver = drv->fw.ucode_ver;
1158         else
1159                 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
1160
1161         /*
1162          * api_ver should match the api version forming part of the
1163          * firmware filename ... but we don't check for that and only rely
1164          * on the API version read from firmware header from here on forward
1165          */
1166         /* no api version check required for experimental uCode */
1167         if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
1168                 if (api_ver < api_min || api_ver > api_max) {
1169                         IWL_ERR(drv,
1170                                 "Driver unable to support your firmware API. "
1171                                 "Driver supports v%u, firmware is v%u.\n",
1172                                 api_max, api_ver);
1173                         goto try_again;
1174                 }
1175
1176                 if (api_ver < api_ok) {
1177                         if (api_ok != api_max)
1178                                 IWL_ERR(drv, "Firmware has old API version, "
1179                                         "expected v%u through v%u, got v%u.\n",
1180                                         api_ok, api_max, api_ver);
1181                         else
1182                                 IWL_ERR(drv, "Firmware has old API version, "
1183                                         "expected v%u, got v%u.\n",
1184                                         api_max, api_ver);
1185                         IWL_ERR(drv, "New firmware can be obtained from "
1186                                       "http://www.intellinuxwireless.org/.\n");
1187                 }
1188         }
1189
1190         /*
1191          * In mvm uCode there is no difference between data and instructions
1192          * sections.
1193          */
1194         if (!fw->mvm_fw && validate_sec_sizes(drv, pieces, drv->cfg))
1195                 goto try_again;
1196
1197         /* Allocate ucode buffers for card's bus-master loading ... */
1198
1199         /* Runtime instructions and 2 copies of data:
1200          * 1) unmodified from disk
1201          * 2) backup cache for save/restore during power-downs */
1202         for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
1203                 if (iwl_alloc_ucode(drv, pieces, i))
1204                         goto out_free_fw;
1205
1206         if (pieces->dbg_dest_tlv) {
1207                 drv->fw.dbg_dest_tlv =
1208                         kmemdup(pieces->dbg_dest_tlv,
1209                                 sizeof(*pieces->dbg_dest_tlv) +
1210                                 sizeof(pieces->dbg_dest_tlv->reg_ops[0]) *
1211                                 drv->fw.dbg_dest_reg_num, GFP_KERNEL);
1212
1213                 if (!drv->fw.dbg_dest_tlv)
1214                         goto out_free_fw;
1215         }
1216
1217         for (i = 0; i < ARRAY_SIZE(drv->fw.dbg_conf_tlv); i++) {
1218                 if (pieces->dbg_conf_tlv[i]) {
1219                         drv->fw.dbg_conf_tlv_len[i] =
1220                                 pieces->dbg_conf_tlv_len[i];
1221                         drv->fw.dbg_conf_tlv[i] =
1222                                 kmemdup(pieces->dbg_conf_tlv[i],
1223                                         drv->fw.dbg_conf_tlv_len[i],
1224                                         GFP_KERNEL);
1225                         if (!drv->fw.dbg_conf_tlv[i])
1226                                 goto out_free_fw;
1227                 }
1228         }
1229
1230         for (i = 0; i < ARRAY_SIZE(drv->fw.dbg_trigger_tlv); i++) {
1231                 if (pieces->dbg_trigger_tlv[i]) {
1232                         drv->fw.dbg_trigger_tlv_len[i] =
1233                                 pieces->dbg_trigger_tlv_len[i];
1234                         drv->fw.dbg_trigger_tlv[i] =
1235                                 kmemdup(pieces->dbg_trigger_tlv[i],
1236                                         drv->fw.dbg_trigger_tlv_len[i],
1237                                         GFP_KERNEL);
1238                         if (!drv->fw.dbg_trigger_tlv[i])
1239                                 goto out_free_fw;
1240                 }
1241         }
1242
1243         /* Now that we can no longer fail, copy information */
1244
1245         /*
1246          * The (size - 16) / 12 formula is based on the information recorded
1247          * for each event, which is of mode 1 (including timestamp) for all
1248          * new microcodes that include this information.
1249          */
1250         fw->init_evtlog_ptr = pieces->init_evtlog_ptr;
1251         if (pieces->init_evtlog_size)
1252                 fw->init_evtlog_size = (pieces->init_evtlog_size - 16)/12;
1253         else
1254                 fw->init_evtlog_size =
1255                         drv->cfg->base_params->max_event_log_size;
1256         fw->init_errlog_ptr = pieces->init_errlog_ptr;
1257         fw->inst_evtlog_ptr = pieces->inst_evtlog_ptr;
1258         if (pieces->inst_evtlog_size)
1259                 fw->inst_evtlog_size = (pieces->inst_evtlog_size - 16)/12;
1260         else
1261                 fw->inst_evtlog_size =
1262                         drv->cfg->base_params->max_event_log_size;
1263         fw->inst_errlog_ptr = pieces->inst_errlog_ptr;
1264
1265         /*
1266          * figure out the offset of chain noise reset and gain commands
1267          * base on the size of standard phy calibration commands table size
1268          */
1269         if (fw->ucode_capa.standard_phy_calibration_size >
1270             IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
1271                 fw->ucode_capa.standard_phy_calibration_size =
1272                         IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1273
1274         /* We have our copies now, allow OS release its copies */
1275         release_firmware(ucode_raw);
1276
1277         mutex_lock(&iwlwifi_opmode_table_mtx);
1278         if (fw->mvm_fw)
1279                 op = &iwlwifi_opmode_table[MVM_OP_MODE];
1280         else
1281                 op = &iwlwifi_opmode_table[DVM_OP_MODE];
1282
1283         IWL_INFO(drv, "loaded firmware version %s op_mode %s\n",
1284                  drv->fw.fw_version, op->name);
1285
1286         /* add this device to the list of devices using this op_mode */
1287         list_add_tail(&drv->list, &op->drv);
1288
1289         if (op->ops) {
1290                 drv->op_mode = _iwl_op_mode_start(drv, op);
1291
1292                 if (!drv->op_mode) {
1293                         mutex_unlock(&iwlwifi_opmode_table_mtx);
1294                         goto out_unbind;
1295                 }
1296         } else {
1297                 load_module = true;
1298         }
1299         mutex_unlock(&iwlwifi_opmode_table_mtx);
1300
1301         /*
1302          * Complete the firmware request last so that
1303          * a driver unbind (stop) doesn't run while we
1304          * are doing the start() above.
1305          */
1306         complete(&drv->request_firmware_complete);
1307
1308         /*
1309          * Load the module last so we don't block anything
1310          * else from proceeding if the module fails to load
1311          * or hangs loading.
1312          */
1313         if (load_module) {
1314                 err = request_module("%s", op->name);
1315 #ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
1316                 if (err)
1317                         IWL_ERR(drv,
1318                                 "failed to load module %s (error %d), is dynamic loading enabled?\n",
1319                                 op->name, err);
1320 #endif
1321         }
1322         return;
1323
1324  try_again:
1325         /* try next, if any */
1326         release_firmware(ucode_raw);
1327         if (iwl_request_firmware(drv, false))
1328                 goto out_unbind;
1329         kfree(pieces);
1330         return;
1331
1332  out_free_fw:
1333         IWL_ERR(drv, "failed to allocate pci memory\n");
1334         iwl_dealloc_ucode(drv);
1335         release_firmware(ucode_raw);
1336  out_unbind:
1337         kfree(pieces);
1338         complete(&drv->request_firmware_complete);
1339         device_release_driver(drv->trans->dev);
1340 }
1341
1342 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans,
1343                               const struct iwl_cfg *cfg)
1344 {
1345         struct iwl_drv *drv;
1346         int ret;
1347
1348         drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1349         if (!drv) {
1350                 ret = -ENOMEM;
1351                 goto err;
1352         }
1353
1354         drv->trans = trans;
1355         drv->dev = trans->dev;
1356         drv->cfg = cfg;
1357
1358         init_completion(&drv->request_firmware_complete);
1359         INIT_LIST_HEAD(&drv->list);
1360
1361 #ifdef CONFIG_IWLWIFI_DEBUGFS
1362         /* Create the device debugfs entries. */
1363         drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1364                                             iwl_dbgfs_root);
1365
1366         if (!drv->dbgfs_drv) {
1367                 IWL_ERR(drv, "failed to create debugfs directory\n");
1368                 ret = -ENOMEM;
1369                 goto err_free_drv;
1370         }
1371
1372         /* Create transport layer debugfs dir */
1373         drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1374
1375         if (!drv->trans->dbgfs_dir) {
1376                 IWL_ERR(drv, "failed to create transport debugfs directory\n");
1377                 ret = -ENOMEM;
1378                 goto err_free_dbgfs;
1379         }
1380 #endif
1381
1382         ret = iwl_request_firmware(drv, true);
1383         if (ret) {
1384                 IWL_ERR(trans, "Couldn't request the fw\n");
1385                 goto err_fw;
1386         }
1387
1388         return drv;
1389
1390 err_fw:
1391 #ifdef CONFIG_IWLWIFI_DEBUGFS
1392 err_free_dbgfs:
1393         debugfs_remove_recursive(drv->dbgfs_drv);
1394 err_free_drv:
1395 #endif
1396         kfree(drv);
1397 err:
1398         return ERR_PTR(ret);
1399 }
1400
1401 void iwl_drv_stop(struct iwl_drv *drv)
1402 {
1403         wait_for_completion(&drv->request_firmware_complete);
1404
1405         _iwl_op_mode_stop(drv);
1406
1407         iwl_dealloc_ucode(drv);
1408
1409         mutex_lock(&iwlwifi_opmode_table_mtx);
1410         /*
1411          * List is empty (this item wasn't added)
1412          * when firmware loading failed -- in that
1413          * case we can't remove it from any list.
1414          */
1415         if (!list_empty(&drv->list))
1416                 list_del(&drv->list);
1417         mutex_unlock(&iwlwifi_opmode_table_mtx);
1418
1419 #ifdef CONFIG_IWLWIFI_DEBUGFS
1420         debugfs_remove_recursive(drv->dbgfs_drv);
1421 #endif
1422
1423         kfree(drv);
1424 }
1425
1426
1427 /* shared module parameters */
1428 struct iwl_mod_params iwlwifi_mod_params = {
1429         .restart_fw = true,
1430         .bt_coex_active = true,
1431         .power_level = IWL_POWER_INDEX_1,
1432         .d0i3_disable = true,
1433 #ifndef CONFIG_IWLWIFI_UAPSD
1434         .uapsd_disable = true,
1435 #endif /* CONFIG_IWLWIFI_UAPSD */
1436         /* the rest are 0 by default */
1437 };
1438 IWL_EXPORT_SYMBOL(iwlwifi_mod_params);
1439
1440 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
1441 {
1442         int i;
1443         struct iwl_drv *drv;
1444         struct iwlwifi_opmode_table *op;
1445
1446         mutex_lock(&iwlwifi_opmode_table_mtx);
1447         for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1448                 op = &iwlwifi_opmode_table[i];
1449                 if (strcmp(op->name, name))
1450                         continue;
1451                 op->ops = ops;
1452                 /* TODO: need to handle exceptional case */
1453                 list_for_each_entry(drv, &op->drv, list)
1454                         drv->op_mode = _iwl_op_mode_start(drv, op);
1455
1456                 mutex_unlock(&iwlwifi_opmode_table_mtx);
1457                 return 0;
1458         }
1459         mutex_unlock(&iwlwifi_opmode_table_mtx);
1460         return -EIO;
1461 }
1462 IWL_EXPORT_SYMBOL(iwl_opmode_register);
1463
1464 void iwl_opmode_deregister(const char *name)
1465 {
1466         int i;
1467         struct iwl_drv *drv;
1468
1469         mutex_lock(&iwlwifi_opmode_table_mtx);
1470         for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1471                 if (strcmp(iwlwifi_opmode_table[i].name, name))
1472                         continue;
1473                 iwlwifi_opmode_table[i].ops = NULL;
1474
1475                 /* call the stop routine for all devices */
1476                 list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
1477                         _iwl_op_mode_stop(drv);
1478
1479                 mutex_unlock(&iwlwifi_opmode_table_mtx);
1480                 return;
1481         }
1482         mutex_unlock(&iwlwifi_opmode_table_mtx);
1483 }
1484 IWL_EXPORT_SYMBOL(iwl_opmode_deregister);
1485
1486 static int __init iwl_drv_init(void)
1487 {
1488         int i;
1489
1490         mutex_init(&iwlwifi_opmode_table_mtx);
1491
1492         for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
1493                 INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
1494
1495         pr_info(DRV_DESCRIPTION "\n");
1496         pr_info(DRV_COPYRIGHT "\n");
1497
1498 #ifdef CONFIG_IWLWIFI_DEBUGFS
1499         /* Create the root of iwlwifi debugfs subsystem. */
1500         iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
1501
1502         if (!iwl_dbgfs_root)
1503                 return -EFAULT;
1504 #endif
1505
1506         return iwl_pci_register_driver();
1507 }
1508 module_init(iwl_drv_init);
1509
1510 static void __exit iwl_drv_exit(void)
1511 {
1512         iwl_pci_unregister_driver();
1513
1514 #ifdef CONFIG_IWLWIFI_DEBUGFS
1515         debugfs_remove_recursive(iwl_dbgfs_root);
1516 #endif
1517 }
1518 module_exit(iwl_drv_exit);
1519
1520 #ifdef CONFIG_IWLWIFI_DEBUG
1521 module_param_named(debug, iwlwifi_mod_params.debug_level, uint,
1522                    S_IRUGO | S_IWUSR);
1523 MODULE_PARM_DESC(debug, "debug output mask");
1524 #endif
1525
1526 module_param_named(swcrypto, iwlwifi_mod_params.sw_crypto, int, S_IRUGO);
1527 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
1528 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, S_IRUGO);
1529 MODULE_PARM_DESC(11n_disable,
1530         "disable 11n functionality, bitmap: 1: full, 2: disable agg TX, 4: disable agg RX, 8 enable agg TX");
1531 module_param_named(amsdu_size_8K, iwlwifi_mod_params.amsdu_size_8K,
1532                    int, S_IRUGO);
1533 MODULE_PARM_DESC(amsdu_size_8K, "enable 8K amsdu size (default 0)");
1534 module_param_named(fw_restart, iwlwifi_mod_params.restart_fw, bool, S_IRUGO);
1535 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error (default true)");
1536
1537 module_param_named(antenna_coupling, iwlwifi_mod_params.ant_coupling,
1538                    int, S_IRUGO);
1539 MODULE_PARM_DESC(antenna_coupling,
1540                  "specify antenna coupling in dB (default: 0 dB)");
1541
1542 module_param_named(nvm_file, iwlwifi_mod_params.nvm_file, charp, S_IRUGO);
1543 MODULE_PARM_DESC(nvm_file, "NVM file name");
1544
1545 module_param_named(d0i3_disable, iwlwifi_mod_params.d0i3_disable,
1546                    bool, S_IRUGO);
1547 MODULE_PARM_DESC(d0i3_disable, "disable d0i3 functionality (default: Y)");
1548
1549 module_param_named(uapsd_disable, iwlwifi_mod_params.uapsd_disable,
1550                    bool, S_IRUGO | S_IWUSR);
1551 #ifdef CONFIG_IWLWIFI_UAPSD
1552 MODULE_PARM_DESC(uapsd_disable, "disable U-APSD functionality (default: N)");
1553 #else
1554 MODULE_PARM_DESC(uapsd_disable, "disable U-APSD functionality (default: Y)");
1555 #endif
1556
1557 /*
1558  * set bt_coex_active to true, uCode will do kill/defer
1559  * every time the priority line is asserted (BT is sending signals on the
1560  * priority line in the PCIx).
1561  * set bt_coex_active to false, uCode will ignore the BT activity and
1562  * perform the normal operation
1563  *
1564  * User might experience transmit issue on some platform due to WiFi/BT
1565  * co-exist problem. The possible behaviors are:
1566  *   Able to scan and finding all the available AP
1567  *   Not able to associate with any AP
1568  * On those platforms, WiFi communication can be restored by set
1569  * "bt_coex_active" module parameter to "false"
1570  *
1571  * default: bt_coex_active = true (BT_COEX_ENABLE)
1572  */
1573 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1574                 bool, S_IRUGO);
1575 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1576
1577 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, S_IRUGO);
1578 MODULE_PARM_DESC(led_mode, "0=system default, "
1579                 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1580
1581 module_param_named(power_save, iwlwifi_mod_params.power_save,
1582                 bool, S_IRUGO);
1583 MODULE_PARM_DESC(power_save,
1584                  "enable WiFi power management (default: disable)");
1585
1586 module_param_named(power_level, iwlwifi_mod_params.power_level,
1587                 int, S_IRUGO);
1588 MODULE_PARM_DESC(power_level,
1589                  "default power save level (range from 1 - 5, default: 1)");
1590
1591 module_param_named(fw_monitor, iwlwifi_mod_params.fw_monitor, bool, S_IRUGO);
1592 MODULE_PARM_DESC(fw_monitor,
1593                  "firmware monitor - to debug FW (default: false - needs lots of memory)");