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