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 - 2012 Intel Corporation. All rights reserved.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of version 2 of the GNU General Public License as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
  22  * USA
  23  *
  24  * The full GNU General Public License is included in this distribution
  25  * in the file called LICENSE.GPL.
  26  *
  27  * Contact Information:
  28  *  Intel Linux Wireless <ilw@linux.intel.com>
  29  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  30  *
  31  * BSD LICENSE
  32  *
  33  * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
  34  * All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  *
  40  *  * Redistributions of source code must retain the above copyright
  41  *    notice, this list of conditions and the following disclaimer.
  42  *  * Redistributions in binary form must reproduce the above copyright
  43  *    notice, this list of conditions and the following disclaimer in
  44  *    the documentation and/or other materials provided with the
  45  *    distribution.
  46  *  * Neither the name Intel Corporation nor the names of its
  47  *    contributors may be used to endorse or promote products derived
  48  *    from this software without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  51  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  52  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  53  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  54  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  55  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  56  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  57  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  58  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  59  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  60  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  61  *
  62  *****************************************************************************/
  63 #include <linux/completion.h>
  64 #include <linux/dma-mapping.h>
  65 #include <linux/firmware.h>
  66 #include <linux/module.h>
  67
  68 #include "iwl-drv.h"
  69 #include "iwl-debug.h"
  70 #include "iwl-trans.h"
  71 #include "iwl-op-mode.h"
  72 #include "iwl-agn-hw.h"
  73 #include "iwl-fw.h"
  74 #include "iwl-config.h"
  75 #include "iwl-modparams.h"
  76
  77 /* private includes */
  78 #include "iwl-fw-file.h"
  79
  80 /**
  81  * struct iwl_drv - drv common data
  82  * @fw: the iwl_fw structure
  83  * @op_mode: the running op_mode
  84  * @trans: transport layer
  85  * @dev: for debug prints only
  86  * @cfg: configuration struct
  87  * @fw_index: firmware revision to try loading
  88  * @firmware_name: composite filename of ucode file to load
  89  * @request_firmware_complete: the firmware has been obtained from user space
  90  */
  91 struct iwl_drv {
  92         struct iwl_fw fw;
  93
  94         struct iwl_op_mode *op_mode;
  95         struct iwl_trans *trans;
  96         struct device *dev;
  97         const struct iwl_cfg *cfg;
  98
  99         int fw_index;                   /* firmware we're trying to load */
 100         char firmware_name[25];         /* name of firmware file to load */
 101
 102         struct completion request_firmware_complete;
 103 };
 104
 105
 106
 107 /*
 108  * struct fw_sec: Just for the image parsing proccess.
 109  * For the fw storage we are using struct fw_desc.
 110  */
 111 struct fw_sec {
 112         const void *data;               /* the sec data */
 113         size_t size;                    /* section size */
 114         u32 offset;                     /* offset of writing in the device */
 115 };
 116
 117 static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
 118 {
 119         if (desc->v_addr)
 120                 dma_free_coherent(drv->trans->dev, desc->len,
 121                                   desc->v_addr, desc->p_addr);
 122         desc->v_addr = NULL;
 123         desc->len = 0;
 124 }
 125
 126 static void iwl_free_fw_img(struct iwl_drv *drv, struct fw_img *img)
 127 {
 128         int i;
 129         for (i = 0; i < IWL_UCODE_SECTION_MAX; i++)
 130                 iwl_free_fw_desc(drv, &img->sec[i]);
 131 }
 132
 133 static void iwl_dealloc_ucode(struct iwl_drv *drv)
 134 {
 135         int i;
 136         for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
 137                 iwl_free_fw_img(drv, drv->fw.img + i);
 138 }
 139
 140 static int iwl_alloc_fw_desc(struct iwl_drv *drv, struct fw_desc *desc,
 141                       struct fw_sec *sec)
 142 {
 143         if (!sec || !sec->size) {
 144                 desc->v_addr = NULL;
 145                 return -EINVAL;
 146         }
 147
 148         desc->v_addr = dma_alloc_coherent(drv->trans->dev, sec->size,
 149                                           &desc->p_addr, GFP_KERNEL);
 150         if (!desc->v_addr)
 151                 return -ENOMEM;
 152
 153         desc->len = sec->size;
 154         desc->offset = sec->offset;
 155         memcpy(desc->v_addr, sec->data, sec->size);
 156         return 0;
 157 }
 158
 159 static void iwl_ucode_callback(const struct firmware *ucode_raw, void *context);
 160
 161 #define UCODE_EXPERIMENTAL_INDEX        100
 162 #define UCODE_EXPERIMENTAL_TAG          "exp"
 163
 164 static int iwl_request_firmware(struct iwl_drv *drv, bool first)
 165 {
 166         const char *name_pre = drv->cfg->fw_name_pre;
 167         char tag[8];
 168
 169         if (first) {
 170 #ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
 171                 drv->fw_index = UCODE_EXPERIMENTAL_INDEX;
 172                 strcpy(tag, UCODE_EXPERIMENTAL_TAG);
 173         } else if (drv->fw_index == UCODE_EXPERIMENTAL_INDEX) {
 174 #endif
 175                 drv->fw_index = drv->cfg->ucode_api_max;
 176                 sprintf(tag, "%d", drv->fw_index);
 177         } else {
 178                 drv->fw_index--;
 179                 sprintf(tag, "%d", drv->fw_index);
 180         }
 181
 182         if (drv->fw_index < drv->cfg->ucode_api_min) {
 183                 IWL_ERR(drv, "no suitable firmware found!\n");
 184                 return -ENOENT;
 185         }
 186
 187         sprintf(drv->firmware_name, "%s%s%s", name_pre, tag, ".ucode");
 188
 189         IWL_DEBUG_INFO(drv, "attempting to load firmware %s'%s'\n",
 190                        (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
 191                                 ? "EXPERIMENTAL " : "",
 192                        drv->firmware_name);
 193
 194         return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
 195                                        drv->trans->dev,
 196                                        GFP_KERNEL, drv, iwl_ucode_callback);
 197 }
 198
 199 struct fw_img_parsing {
 200         struct fw_sec sec[IWL_UCODE_SECTION_MAX];
 201         int sec_counter;
 202 };
 203
 204 /*
 205  * struct fw_sec_parsing: to extract fw section and it's offset from tlv
 206  */
 207 struct fw_sec_parsing {
 208         __le32 offset;
 209         const u8 data[];
 210 } __packed;
 211
 212 /**
 213  * struct iwl_tlv_calib_data - parse the default calib data from TLV
 214  *
 215  * @ucode_type: the uCode to which the following default calib relates.
 216  * @calib: default calibrations.
 217  */
 218 struct iwl_tlv_calib_data {
 219         __le32 ucode_type;
 220         __le64 calib;
 221 } __packed;
 222
 223 struct iwl_firmware_pieces {
 224         struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
 225
 226         u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
 227         u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
 228 };
 229
 230 /*
 231  * These functions are just to extract uCode section data from the pieces
 232  * structure.
 233  */
 234 static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
 235                               enum iwl_ucode_type type,
 236                               int  sec)
 237 {
 238         return &pieces->img[type].sec[sec];
 239 }
 240
 241 static void set_sec_data(struct iwl_firmware_pieces *pieces,
 242                          enum iwl_ucode_type type,
 243                          int sec,
 244                          const void *data)
 245 {
 246         pieces->img[type].sec[sec].data = data;
 247 }
 248
 249 static void set_sec_size(struct iwl_firmware_pieces *pieces,
 250                          enum iwl_ucode_type type,
 251                          int sec,
 252                          size_t size)
 253 {
 254         pieces->img[type].sec[sec].size = size;
 255 }
 256
 257 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
 258                            enum iwl_ucode_type type,
 259                            int sec)
 260 {
 261         return pieces->img[type].sec[sec].size;
 262 }
 263
 264 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
 265                            enum iwl_ucode_type type,
 266                            int sec,
 267                            u32 offset)
 268 {
 269         pieces->img[type].sec[sec].offset = offset;
 270 }
 271
 272 /*
 273  * Gets uCode section from tlv.
 274  */
 275 static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
 276                                const void *data, enum iwl_ucode_type type,
 277                                int size)
 278 {
 279         struct fw_img_parsing *img;
 280         struct fw_sec *sec;
 281         struct fw_sec_parsing *sec_parse;
 282
 283         if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
 284                 return -1;
 285
 286         sec_parse = (struct fw_sec_parsing *)data;
 287
 288         img = &pieces->img[type];
 289         sec = &img->sec[img->sec_counter];
 290
 291         sec->offset = le32_to_cpu(sec_parse->offset);
 292         sec->data = sec_parse->data;
 293         sec->size = size - sizeof(sec_parse->offset);
 294
 295         ++img->sec_counter;
 296
 297         return 0;
 298 }
 299
 300 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
 301 {
 302         struct iwl_tlv_calib_data *def_calib =
 303                                         (struct iwl_tlv_calib_data *)data;
 304         u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
 305         if (ucode_type >= IWL_UCODE_TYPE_MAX) {
 306                 IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
 307                         ucode_type);
 308                 return -EINVAL;
 309         }
 310         drv->fw.default_calib[ucode_type] = le64_to_cpu(def_calib->calib);
 311         return 0;
 312 }
 313
 314 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
 315                                     const struct firmware *ucode_raw,
 316                                     struct iwl_firmware_pieces *pieces)
 317 {
 318         struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
 319         u32 api_ver, hdr_size, build;
 320         char buildstr[25];
 321         const u8 *src;
 322
 323         drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
 324         api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
 325
 326         switch (api_ver) {
 327         default:
 328                 hdr_size = 28;
 329                 if (ucode_raw->size < hdr_size) {
 330                         IWL_ERR(drv, "File size too small!\n");
 331                         return -EINVAL;
 332                 }
 333                 build = le32_to_cpu(ucode->u.v2.build);
 334                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
 335                              le32_to_cpu(ucode->u.v2.inst_size));
 336                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
 337                              le32_to_cpu(ucode->u.v2.data_size));
 338                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
 339                              le32_to_cpu(ucode->u.v2.init_size));
 340                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
 341                              le32_to_cpu(ucode->u.v2.init_data_size));
 342                 src = ucode->u.v2.data;
 343                 break;
 344         case 0:
 345         case 1:
 346         case 2:
 347                 hdr_size = 24;
 348                 if (ucode_raw->size < hdr_size) {
 349                         IWL_ERR(drv, "File size too small!\n");
 350                         return -EINVAL;
 351                 }
 352                 build = 0;
 353                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
 354                              le32_to_cpu(ucode->u.v1.inst_size));
 355                 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
 356                              le32_to_cpu(ucode->u.v1.data_size));
 357                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
 358                              le32_to_cpu(ucode->u.v1.init_size));
 359                 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
 360                              le32_to_cpu(ucode->u.v1.init_data_size));
 361                 src = ucode->u.v1.data;
 362                 break;
 363         }
 364
 365         if (build)
 366                 sprintf(buildstr, " build %u%s", build,
 367                        (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
 368                                 ? " (EXP)" : "");
 369         else
 370                 buildstr[0] = '\0';
 371
 372         snprintf(drv->fw.fw_version,
 373                  sizeof(drv->fw.fw_version),
 374                  "%u.%u.%u.%u%s",
 375                  IWL_UCODE_MAJOR(drv->fw.ucode_ver),
 376                  IWL_UCODE_MINOR(drv->fw.ucode_ver),
 377                  IWL_UCODE_API(drv->fw.ucode_ver),
 378                  IWL_UCODE_SERIAL(drv->fw.ucode_ver),
 379                  buildstr);
 380
 381         /* Verify size of file vs. image size info in file's header */
 382
 383         if (ucode_raw->size != hdr_size +
 384             get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
 385             get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
 386             get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
 387             get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
 388
 389                 IWL_ERR(drv,
 390                         "uCode file size %d does not match expected size\n",
 391                         (int)ucode_raw->size);
 392                 return -EINVAL;
 393         }
 394
 395
 396         set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
 397         src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
 398         set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
 399                        IWLAGN_RTC_INST_LOWER_BOUND);
 400         set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
 401         src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
 402         set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
 403                        IWLAGN_RTC_DATA_LOWER_BOUND);
 404         set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
 405         src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
 406         set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
 407                        IWLAGN_RTC_INST_LOWER_BOUND);
 408         set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
 409         src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
 410         set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
 411                        IWLAGN_RTC_DATA_LOWER_BOUND);
 412         return 0;
 413 }
 414
 415 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
 416                                 const struct firmware *ucode_raw,
 417                                 struct iwl_firmware_pieces *pieces,
 418                                 struct iwl_ucode_capabilities *capa)
 419 {
 420         struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
 421         struct iwl_ucode_tlv *tlv;
 422         size_t len = ucode_raw->size;
 423         const u8 *data;
 424         u32 tlv_len;
 425         enum iwl_ucode_tlv_type tlv_type;
 426         const u8 *tlv_data;
 427         char buildstr[25];
 428         u32 build;
 429
 430         if (len < sizeof(*ucode)) {
 431                 IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
 432                 return -EINVAL;
 433         }
 434
 435         if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
 436                 IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
 437                         le32_to_cpu(ucode->magic));
 438                 return -EINVAL;
 439         }
 440
 441         drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
 442         build = le32_to_cpu(ucode->build);
 443
 444         if (build)
 445                 sprintf(buildstr, " build %u%s", build,
 446                        (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
 447                                 ? " (EXP)" : "");
 448         else
 449                 buildstr[0] = '\0';
 450
 451         snprintf(drv->fw.fw_version,
 452                  sizeof(drv->fw.fw_version),
 453                  "%u.%u.%u.%u%s",
 454                  IWL_UCODE_MAJOR(drv->fw.ucode_ver),
 455                  IWL_UCODE_MINOR(drv->fw.ucode_ver),
 456                  IWL_UCODE_API(drv->fw.ucode_ver),
 457                  IWL_UCODE_SERIAL(drv->fw.ucode_ver),
 458                  buildstr);
 459
 460         data = ucode->data;
 461
 462         len -= sizeof(*ucode);
 463
 464         while (len >= sizeof(*tlv)) {
 465                 len -= sizeof(*tlv);
 466                 tlv = (void *)data;
 467
 468                 tlv_len = le32_to_cpu(tlv->length);
 469                 tlv_type = le32_to_cpu(tlv->type);
 470                 tlv_data = tlv->data;
 471
 472                 if (len < tlv_len) {
 473                         IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
 474                                 len, tlv_len);
 475                         return -EINVAL;
 476                 }
 477                 len -= ALIGN(tlv_len, 4);
 478                 data += sizeof(*tlv) + ALIGN(tlv_len, 4);
 479
 480                 switch (tlv_type) {
 481                 case IWL_UCODE_TLV_INST:
 482                         set_sec_data(pieces, IWL_UCODE_REGULAR,
 483                                      IWL_UCODE_SECTION_INST, tlv_data);
 484                         set_sec_size(pieces, IWL_UCODE_REGULAR,
 485                                      IWL_UCODE_SECTION_INST, tlv_len);
 486                         set_sec_offset(pieces, IWL_UCODE_REGULAR,
 487                                        IWL_UCODE_SECTION_INST,
 488                                        IWLAGN_RTC_INST_LOWER_BOUND);
 489                         break;
 490                 case IWL_UCODE_TLV_DATA:
 491                         set_sec_data(pieces, IWL_UCODE_REGULAR,
 492                                      IWL_UCODE_SECTION_DATA, tlv_data);
 493                         set_sec_size(pieces, IWL_UCODE_REGULAR,
 494                                      IWL_UCODE_SECTION_DATA, tlv_len);
 495                         set_sec_offset(pieces, IWL_UCODE_REGULAR,
 496                                        IWL_UCODE_SECTION_DATA,
 497                                        IWLAGN_RTC_DATA_LOWER_BOUND);
 498                         break;
 499                 case IWL_UCODE_TLV_INIT:
 500                         set_sec_data(pieces, IWL_UCODE_INIT,
 501                                      IWL_UCODE_SECTION_INST, tlv_data);
 502                         set_sec_size(pieces, IWL_UCODE_INIT,
 503                                      IWL_UCODE_SECTION_INST, tlv_len);
 504                         set_sec_offset(pieces, IWL_UCODE_INIT,
 505                                        IWL_UCODE_SECTION_INST,
 506                                        IWLAGN_RTC_INST_LOWER_BOUND);
 507                         break;
 508                 case IWL_UCODE_TLV_INIT_DATA:
 509                         set_sec_data(pieces, IWL_UCODE_INIT,
 510                                      IWL_UCODE_SECTION_DATA, tlv_data);
 511                         set_sec_size(pieces, IWL_UCODE_INIT,
 512                                      IWL_UCODE_SECTION_DATA, tlv_len);
 513                         set_sec_offset(pieces, IWL_UCODE_INIT,
 514                                        IWL_UCODE_SECTION_DATA,
 515                                        IWLAGN_RTC_DATA_LOWER_BOUND);
 516                         break;
 517                 case IWL_UCODE_TLV_BOOT:
 518                         IWL_ERR(drv, "Found unexpected BOOT ucode\n");
 519                         break;
 520                 case IWL_UCODE_TLV_PROBE_MAX_LEN:
 521                         if (tlv_len != sizeof(u32))
 522                                 goto invalid_tlv_len;
 523                         capa->max_probe_length =
 524                                         le32_to_cpup((__le32 *)tlv_data);
 525                         break;
 526                 case IWL_UCODE_TLV_PAN:
 527                         if (tlv_len)
 528                                 goto invalid_tlv_len;
 529                         capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
 530                         break;
 531                 case IWL_UCODE_TLV_FLAGS:
 532                         /* must be at least one u32 */
 533                         if (tlv_len < sizeof(u32))
 534                                 goto invalid_tlv_len;
 535                         /* and a proper number of u32s */
 536                         if (tlv_len % sizeof(u32))
 537                                 goto invalid_tlv_len;
 538                         /*
 539                          * This driver only reads the first u32 as
 540                          * right now no more features are defined,
 541                          * if that changes then either the driver
 542                          * will not work with the new firmware, or
 543                          * it'll not take advantage of new features.
 544                          */
 545                         capa->flags = le32_to_cpup((__le32 *)tlv_data);
 546                         break;
 547                 case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
 548                         if (tlv_len != sizeof(u32))
 549                                 goto invalid_tlv_len;
 550                         pieces->init_evtlog_ptr =
 551                                         le32_to_cpup((__le32 *)tlv_data);
 552                         break;
 553                 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
 554                         if (tlv_len != sizeof(u32))
 555                                 goto invalid_tlv_len;
 556                         pieces->init_evtlog_size =
 557                                         le32_to_cpup((__le32 *)tlv_data);
 558                         break;
 559                 case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
 560                         if (tlv_len != sizeof(u32))
 561                                 goto invalid_tlv_len;
 562                         pieces->init_errlog_ptr =
 563                                         le32_to_cpup((__le32 *)tlv_data);
 564                         break;
 565                 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
 566                         if (tlv_len != sizeof(u32))
 567                                 goto invalid_tlv_len;
 568                         pieces->inst_evtlog_ptr =
 569                                         le32_to_cpup((__le32 *)tlv_data);
 570                         break;
 571                 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
 572                         if (tlv_len != sizeof(u32))
 573                                 goto invalid_tlv_len;
 574                         pieces->inst_evtlog_size =
 575                                         le32_to_cpup((__le32 *)tlv_data);
 576                         break;
 577                 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
 578                         if (tlv_len != sizeof(u32))
 579                                 goto invalid_tlv_len;
 580                         pieces->inst_errlog_ptr =
 581                                         le32_to_cpup((__le32 *)tlv_data);
 582                         break;
 583                 case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
 584                         if (tlv_len)
 585                                 goto invalid_tlv_len;
 586                         drv->fw.enhance_sensitivity_table = true;
 587                         break;
 588                 case IWL_UCODE_TLV_WOWLAN_INST:
 589                         set_sec_data(pieces, IWL_UCODE_WOWLAN,
 590                                      IWL_UCODE_SECTION_INST, tlv_data);
 591                         set_sec_size(pieces, IWL_UCODE_WOWLAN,
 592                                      IWL_UCODE_SECTION_INST, tlv_len);
 593                         set_sec_offset(pieces, IWL_UCODE_WOWLAN,
 594                                        IWL_UCODE_SECTION_INST,
 595                                        IWLAGN_RTC_INST_LOWER_BOUND);
 596                         break;
 597                 case IWL_UCODE_TLV_WOWLAN_DATA:
 598                         set_sec_data(pieces, IWL_UCODE_WOWLAN,
 599                                      IWL_UCODE_SECTION_DATA, tlv_data);
 600                         set_sec_size(pieces, IWL_UCODE_WOWLAN,
 601                                      IWL_UCODE_SECTION_DATA, tlv_len);
 602                         set_sec_offset(pieces, IWL_UCODE_WOWLAN,
 603                                        IWL_UCODE_SECTION_DATA,
 604                                        IWLAGN_RTC_DATA_LOWER_BOUND);
 605                         break;
 606                 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
 607                         if (tlv_len != sizeof(u32))
 608                                 goto invalid_tlv_len;
 609                         capa->standard_phy_calibration_size =
 610                                         le32_to_cpup((__le32 *)tlv_data);
 611                         break;
 612                  case IWL_UCODE_TLV_SEC_RT:
 613                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
 614                                             tlv_len);
 615                         drv->fw.mvm_fw = true;
 616                         break;
 617                 case IWL_UCODE_TLV_SEC_INIT:
 618                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
 619                                             tlv_len);
 620                         drv->fw.mvm_fw = true;
 621                         break;
 622                 case IWL_UCODE_TLV_SEC_WOWLAN:
 623                         iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
 624                                             tlv_len);
 625                         drv->fw.mvm_fw = true;
 626                         break;
 627                 case IWL_UCODE_TLV_DEF_CALIB:
 628                         if (tlv_len != sizeof(struct iwl_tlv_calib_data))
 629                                 goto invalid_tlv_len;
 630                         if (iwl_set_default_calib(drv, tlv_data))
 631                                 goto tlv_error;
 632                         break;
 633                 case IWL_UCODE_TLV_PHY_SKU:
 634                         if (tlv_len != sizeof(u32))
 635                                 goto invalid_tlv_len;
 636                         drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
 637                         break;
 638                 default:
 639                         IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
 640                         break;
 641                 }
 642         }
 643
 644         if (len) {
 645                 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
 646                 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
 647                 return -EINVAL;
 648         }
 649
 650         return 0;
 651
 652  invalid_tlv_len:
 653         IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
 654  tlv_error:
 655         iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
 656
 657         return -EINVAL;
 658 }
 659
 660 static int alloc_pci_desc(struct iwl_drv *drv,
 661                           struct iwl_firmware_pieces *pieces,
 662                           enum iwl_ucode_type type)
 663 {
 664         int i;
 665         for (i = 0;
 666              i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
 667              i++)
 668                 if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
 669                                                 get_sec(pieces, type, i)))
 670                         return -1;
 671         return 0;
 672 }
 673
 674 static int validate_sec_sizes(struct iwl_drv *drv,
 675                               struct iwl_firmware_pieces *pieces,
 676                               const struct iwl_cfg *cfg)
 677 {
 678         IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
 679                 get_sec_size(pieces, IWL_UCODE_REGULAR,
 680                              IWL_UCODE_SECTION_INST));
 681         IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
 682                 get_sec_size(pieces, IWL_UCODE_REGULAR,
 683                              IWL_UCODE_SECTION_DATA));
 684         IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
 685                 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
 686         IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
 687                 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
 688
 689         /* Verify that uCode images will fit in card's SRAM. */
 690         if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
 691                                                         cfg->max_inst_size) {
 692                 IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
 693                         get_sec_size(pieces, IWL_UCODE_REGULAR,
 694                                                 IWL_UCODE_SECTION_INST));
 695                 return -1;
 696         }
 697
 698         if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
 699                                                         cfg->max_data_size) {
 700                 IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
 701                         get_sec_size(pieces, IWL_UCODE_REGULAR,
 702                                                 IWL_UCODE_SECTION_DATA));
 703                 return -1;
 704         }
 705
 706          if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
 707                                                         cfg->max_inst_size) {
 708                 IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
 709                         get_sec_size(pieces, IWL_UCODE_INIT,
 710                                                 IWL_UCODE_SECTION_INST));
 711                 return -1;
 712         }
 713
 714         if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
 715                                                         cfg->max_data_size) {
 716                 IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
 717                         get_sec_size(pieces, IWL_UCODE_REGULAR,
 718                                                 IWL_UCODE_SECTION_DATA));
 719                 return -1;
 720         }
 721         return 0;
 722 }
 723
 724
 725 /**
 726  * iwl_ucode_callback - callback when firmware was loaded
 727  *
 728  * If loaded successfully, copies the firmware into buffers
 729  * for the card to fetch (via DMA).
 730  */
 731 static void iwl_ucode_callback(const struct firmware *ucode_raw, void *context)
 732 {
 733         struct iwl_drv *drv = context;
 734         struct iwl_fw *fw = &drv->fw;
 735         struct iwl_ucode_header *ucode;
 736         int err;
 737         struct iwl_firmware_pieces pieces;
 738         const unsigned int api_max = drv->cfg->ucode_api_max;
 739         unsigned int api_ok = drv->cfg->ucode_api_ok;
 740         const unsigned int api_min = drv->cfg->ucode_api_min;
 741         u32 api_ver;
 742         int i;
 743
 744         fw->ucode_capa.max_probe_length = 200;
 745         fw->ucode_capa.standard_phy_calibration_size =
 746                         IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
 747
 748         if (!api_ok)
 749                 api_ok = api_max;
 750
 751         memset(&pieces, 0, sizeof(pieces));
 752
 753         if (!ucode_raw) {
 754                 if (drv->fw_index <= api_ok)
 755                         IWL_ERR(drv,
 756                                 "request for firmware file '%s' failed.\n",
 757                                 drv->firmware_name);
 758                 goto try_again;
 759         }
 760
 761         IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
 762                        drv->firmware_name, ucode_raw->size);
 763
 764         /* Make sure that we got at least the API version number */
 765         if (ucode_raw->size < 4) {
 766                 IWL_ERR(drv, "File size way too small!\n");
 767                 goto try_again;
 768         }
 769
 770         /* Data from ucode file:  header followed by uCode images */
 771         ucode = (struct iwl_ucode_header *)ucode_raw->data;
 772
 773         if (ucode->ver)
 774                 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, &pieces);
 775         else
 776                 err = iwl_parse_tlv_firmware(drv, ucode_raw, &pieces,
 777                                            &fw->ucode_capa);
 778
 779         if (err)
 780                 goto try_again;
 781
 782         api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
 783
 784         /*
 785          * api_ver should match the api version forming part of the
 786          * firmware filename ... but we don't check for that and only rely
 787          * on the API version read from firmware header from here on forward
 788          */
 789         /* no api version check required for experimental uCode */
 790         if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
 791                 if (api_ver < api_min || api_ver > api_max) {
 792                         IWL_ERR(drv,
 793                                 "Driver unable to support your firmware API. "
 794                                 "Driver supports v%u, firmware is v%u.\n",
 795                                 api_max, api_ver);
 796                         goto try_again;
 797                 }
 798
 799                 if (api_ver < api_ok) {
 800                         if (api_ok != api_max)
 801                                 IWL_ERR(drv, "Firmware has old API version, "
 802                                         "expected v%u through v%u, got v%u.\n",
 803                                         api_ok, api_max, api_ver);
 804                         else
 805                                 IWL_ERR(drv, "Firmware has old API version, "
 806                                         "expected v%u, got v%u.\n",
 807                                         api_max, api_ver);
 808                         IWL_ERR(drv, "New firmware can be obtained from "
 809                                       "http://www.intellinuxwireless.org/.\n");
 810                 }
 811         }
 812
 813         IWL_INFO(drv, "loaded firmware version %s", drv->fw.fw_version);
 814
 815         /*
 816          * In mvm uCode there is no difference between data and instructions
 817          * sections.
 818          */
 819         if (!fw->mvm_fw && validate_sec_sizes(drv, &pieces, drv->cfg))
 820                 goto try_again;
 821
 822         /* Allocate ucode buffers for card's bus-master loading ... */
 823
 824         /* Runtime instructions and 2 copies of data:
 825          * 1) unmodified from disk
 826          * 2) backup cache for save/restore during power-downs */
 827         for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
 828                 if (alloc_pci_desc(drv, &pieces, i))
 829                         goto err_pci_alloc;
 830
 831         /* Now that we can no longer fail, copy information */
 832
 833         /*
 834          * The (size - 16) / 12 formula is based on the information recorded
 835          * for each event, which is of mode 1 (including timestamp) for all
 836          * new microcodes that include this information.
 837          */
 838         fw->init_evtlog_ptr = pieces.init_evtlog_ptr;
 839         if (pieces.init_evtlog_size)
 840                 fw->init_evtlog_size = (pieces.init_evtlog_size - 16)/12;
 841         else
 842                 fw->init_evtlog_size =
 843                         drv->cfg->base_params->max_event_log_size;
 844         fw->init_errlog_ptr = pieces.init_errlog_ptr;
 845         fw->inst_evtlog_ptr = pieces.inst_evtlog_ptr;
 846         if (pieces.inst_evtlog_size)
 847                 fw->inst_evtlog_size = (pieces.inst_evtlog_size - 16)/12;
 848         else
 849                 fw->inst_evtlog_size =
 850                         drv->cfg->base_params->max_event_log_size;
 851         fw->inst_errlog_ptr = pieces.inst_errlog_ptr;
 852
 853         /*
 854          * figure out the offset of chain noise reset and gain commands
 855          * base on the size of standard phy calibration commands table size
 856          */
 857         if (fw->ucode_capa.standard_phy_calibration_size >
 858             IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
 859                 fw->ucode_capa.standard_phy_calibration_size =
 860                         IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
 861
 862         /* We have our copies now, allow OS release its copies */
 863         release_firmware(ucode_raw);
 864         complete(&drv->request_firmware_complete);
 865
 866         drv->op_mode = iwl_dvm_ops.start(drv->trans, drv->cfg, &drv->fw);
 867
 868         if (!drv->op_mode)
 869                 goto out_unbind;
 870
 871         return;
 872
 873  try_again:
 874         /* try next, if any */
 875         release_firmware(ucode_raw);
 876         if (iwl_request_firmware(drv, false))
 877                 goto out_unbind;
 878         return;
 879
 880  err_pci_alloc:
 881         IWL_ERR(drv, "failed to allocate pci memory\n");
 882         iwl_dealloc_ucode(drv);
 883         release_firmware(ucode_raw);
 884  out_unbind:
 885         complete(&drv->request_firmware_complete);
 886         device_release_driver(drv->trans->dev);
 887 }
 888
 889 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans,
 890                               const struct iwl_cfg *cfg)
 891 {
 892         struct iwl_drv *drv;
 893         int ret;
 894
 895         drv = kzalloc(sizeof(*drv), GFP_KERNEL);
 896         if (!drv)
 897                 return NULL;
 898
 899         drv->trans = trans;
 900         drv->dev = trans->dev;
 901         drv->cfg = cfg;
 902
 903         init_completion(&drv->request_firmware_complete);
 904
 905         ret = iwl_request_firmware(drv, true);
 906
 907         if (ret) {
 908                 IWL_ERR(trans, "Couldn't request the fw\n");
 909                 kfree(drv);
 910                 drv = NULL;
 911         }
 912
 913         return drv;
 914 }
 915
 916 void iwl_drv_stop(struct iwl_drv *drv)
 917 {
 918         wait_for_completion(&drv->request_firmware_complete);
 919
 920         /* op_mode can be NULL if its start failed */
 921         if (drv->op_mode)
 922                 iwl_op_mode_stop(drv->op_mode);
 923
 924         iwl_dealloc_ucode(drv);
 925
 926         kfree(drv);
 927 }
 928
 929
 930 /* shared module parameters */
 931 struct iwl_mod_params iwlwifi_mod_params = {
 932         .amsdu_size_8K = 1,
 933         .restart_fw = 1,
 934         .plcp_check = true,
 935         .bt_coex_active = true,
 936         .power_level = IWL_POWER_INDEX_1,
 937         .bt_ch_announce = true,
 938         .auto_agg = true,
 939         /* the rest are 0 by default */
 940 };
 941
 942 #ifdef CONFIG_IWLWIFI_DEBUG
 943 module_param_named(debug, iwlwifi_mod_params.debug_level, uint,
 944                    S_IRUGO | S_IWUSR);
 945 MODULE_PARM_DESC(debug, "debug output mask");
 946 #endif
 947
 948 module_param_named(swcrypto, iwlwifi_mod_params.sw_crypto, int, S_IRUGO);
 949 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
 950 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, S_IRUGO);
 951 MODULE_PARM_DESC(11n_disable,
 952         "disable 11n functionality, bitmap: 1: full, 2: agg TX, 4: agg RX");
 953 module_param_named(amsdu_size_8K, iwlwifi_mod_params.amsdu_size_8K,
 954                    int, S_IRUGO);
 955 MODULE_PARM_DESC(amsdu_size_8K, "enable 8K amsdu size");
 956 module_param_named(fw_restart, iwlwifi_mod_params.restart_fw, int, S_IRUGO);
 957 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error");
 958
 959 module_param_named(antenna_coupling, iwlwifi_mod_params.ant_coupling,
 960                    int, S_IRUGO);
 961 MODULE_PARM_DESC(antenna_coupling,
 962                  "specify antenna coupling in dB (defualt: 0 dB)");
 963
 964 module_param_named(bt_ch_inhibition, iwlwifi_mod_params.bt_ch_announce,
 965                    bool, S_IRUGO);
 966 MODULE_PARM_DESC(bt_ch_inhibition,
 967                  "Enable BT channel inhibition (default: enable)");
 968
 969 module_param_named(plcp_check, iwlwifi_mod_params.plcp_check, bool, S_IRUGO);
 970 MODULE_PARM_DESC(plcp_check, "Check plcp health (default: 1 [enabled])");
 971
 972 module_param_named(wd_disable, iwlwifi_mod_params.wd_disable, int, S_IRUGO);
 973 MODULE_PARM_DESC(wd_disable,
 974                 "Disable stuck queue watchdog timer 0=system default, "
 975                 "1=disable, 2=enable (default: 0)");
 976
 977 /*
 978  * set bt_coex_active to true, uCode will do kill/defer
 979  * every time the priority line is asserted (BT is sending signals on the
 980  * priority line in the PCIx).
 981  * set bt_coex_active to false, uCode will ignore the BT activity and
 982  * perform the normal operation
 983  *
 984  * User might experience transmit issue on some platform due to WiFi/BT
 985  * co-exist problem. The possible behaviors are:
 986  *   Able to scan and finding all the available AP
 987  *   Not able to associate with any AP
 988  * On those platforms, WiFi communication can be restored by set
 989  * "bt_coex_active" module parameter to "false"
 990  *
 991  * default: bt_coex_active = true (BT_COEX_ENABLE)
 992  */
 993 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
 994                 bool, S_IRUGO);
 995 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
 996
 997 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, S_IRUGO);
 998 MODULE_PARM_DESC(led_mode, "0=system default, "
 999                 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1000
1001 module_param_named(power_save, iwlwifi_mod_params.power_save,
1002                 bool, S_IRUGO);
1003 MODULE_PARM_DESC(power_save,
1004                  "enable WiFi power management (default: disable)");
1005
1006 module_param_named(power_level, iwlwifi_mod_params.power_level,
1007                 int, S_IRUGO);
1008 MODULE_PARM_DESC(power_level,
1009                  "default power save level (range from 1 - 5, default: 1)");
1010
1011 module_param_named(auto_agg, iwlwifi_mod_params.auto_agg,
1012                 bool, S_IRUGO);
1013 MODULE_PARM_DESC(auto_agg,
1014                  "enable agg w/o check traffic load (default: enable)");
1015
1016 module_param_named(5ghz_disable, iwlwifi_mod_params.disable_5ghz,
1017                 bool, S_IRUGO);
1018 MODULE_PARM_DESC(5ghz_disable, "disable 5GHz band (default: 0 [enabled])");