1 /******************************************************************************
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.
8 * Copyright(c) 2007 - 2013 Intel Corporation. All rights reserved.
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.
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.
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,
24 * The full GNU General Public License is included in this distribution
25 * in the file called LICENSE.GPL.
27 * Contact Information:
28 * Intel Linux Wireless <ilw@linux.intel.com>
29 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
33 * Copyright(c) 2005 - 2013 Intel Corporation. All rights reserved.
34 * All rights reserved.
36 * Redistribution and use in source and binary forms, with or without
37 * modification, are permitted provided that the following conditions
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
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.
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.
62 *****************************************************************************/
63 #include <linux/completion.h>
64 #include <linux/dma-mapping.h>
65 #include <linux/firmware.h>
66 #include <linux/module.h>
67 #include <linux/vmalloc.h>
70 #include "iwl-debug.h"
71 #include "iwl-trans.h"
72 #include "iwl-op-mode.h"
73 #include "iwl-agn-hw.h"
75 #include "iwl-config.h"
76 #include "iwl-modparams.h"
78 /* private includes */
79 #include "iwl-fw-file.h"
81 /******************************************************************************
85 ******************************************************************************/
88 * module name, copyright, version, etc.
90 #define DRV_DESCRIPTION "Intel(R) Wireless WiFi driver for Linux"
92 #ifdef CONFIG_IWLWIFI_DEBUG
98 #define DRV_VERSION IWLWIFI_VERSION VD
100 MODULE_DESCRIPTION(DRV_DESCRIPTION);
101 MODULE_VERSION(DRV_VERSION);
102 MODULE_AUTHOR(DRV_COPYRIGHT " " DRV_AUTHOR);
103 MODULE_LICENSE("GPL");
105 #ifdef CONFIG_IWLWIFI_DEBUGFS
106 static struct dentry *iwl_dbgfs_root;
110 * struct iwl_drv - drv common data
111 * @list: list of drv structures using this opmode
112 * @fw: the iwl_fw structure
113 * @op_mode: the running op_mode
114 * @trans: transport layer
115 * @dev: for debug prints only
116 * @cfg: configuration struct
117 * @fw_index: firmware revision to try loading
118 * @firmware_name: composite filename of ucode file to load
119 * @request_firmware_complete: the firmware has been obtained from user space
122 struct list_head list;
125 struct iwl_op_mode *op_mode;
126 struct iwl_trans *trans;
128 const struct iwl_cfg *cfg;
130 int fw_index; /* firmware we're trying to load */
131 char firmware_name[25]; /* name of firmware file to load */
133 struct completion request_firmware_complete;
135 #ifdef CONFIG_IWLWIFI_DEBUGFS
136 struct dentry *dbgfs_drv;
137 struct dentry *dbgfs_trans;
138 struct dentry *dbgfs_op_mode;
147 /* Protects the table contents, i.e. the ops pointer & drv list */
148 static struct mutex iwlwifi_opmode_table_mtx;
149 static struct iwlwifi_opmode_table {
150 const char *name; /* name: iwldvm, iwlmvm, etc */
151 const struct iwl_op_mode_ops *ops; /* pointer to op_mode ops */
152 struct list_head drv; /* list of devices using this op_mode */
153 } iwlwifi_opmode_table[] = { /* ops set when driver is initialized */
154 [DVM_OP_MODE] = { .name = "iwldvm", .ops = NULL },
155 [MVM_OP_MODE] = { .name = "iwlmvm", .ops = NULL },
159 * struct fw_sec: Just for the image parsing proccess.
160 * For the fw storage we are using struct fw_desc.
163 const void *data; /* the sec data */
164 size_t size; /* section size */
165 u32 offset; /* offset of writing in the device */
168 static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
175 static void iwl_free_fw_img(struct iwl_drv *drv, struct fw_img *img)
178 for (i = 0; i < IWL_UCODE_SECTION_MAX; i++)
179 iwl_free_fw_desc(drv, &img->sec[i]);
182 static void iwl_dealloc_ucode(struct iwl_drv *drv)
185 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
186 iwl_free_fw_img(drv, drv->fw.img + i);
189 static int iwl_alloc_fw_desc(struct iwl_drv *drv, struct fw_desc *desc,
196 if (!sec || !sec->size)
199 data = vmalloc(sec->size);
203 desc->len = sec->size;
204 desc->offset = sec->offset;
205 memcpy(data, sec->data, desc->len);
211 static void iwl_req_fw_callback(const struct firmware *ucode_raw,
214 #define UCODE_EXPERIMENTAL_INDEX 100
215 #define UCODE_EXPERIMENTAL_TAG "exp"
217 static int iwl_request_firmware(struct iwl_drv *drv, bool first)
219 const char *name_pre = drv->cfg->fw_name_pre;
223 #ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
224 drv->fw_index = UCODE_EXPERIMENTAL_INDEX;
225 strcpy(tag, UCODE_EXPERIMENTAL_TAG);
226 } else if (drv->fw_index == UCODE_EXPERIMENTAL_INDEX) {
228 drv->fw_index = drv->cfg->ucode_api_max;
229 sprintf(tag, "%d", drv->fw_index);
232 sprintf(tag, "%d", drv->fw_index);
235 if (drv->fw_index < drv->cfg->ucode_api_min) {
236 IWL_ERR(drv, "no suitable firmware found!\n");
240 sprintf(drv->firmware_name, "%s%s%s", name_pre, tag, ".ucode");
242 IWL_DEBUG_INFO(drv, "attempting to load firmware %s'%s'\n",
243 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
244 ? "EXPERIMENTAL " : "",
247 return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
249 GFP_KERNEL, drv, iwl_req_fw_callback);
252 struct fw_img_parsing {
253 struct fw_sec sec[IWL_UCODE_SECTION_MAX];
258 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
260 struct fw_sec_parsing {
266 * struct iwl_tlv_calib_data - parse the default calib data from TLV
268 * @ucode_type: the uCode to which the following default calib relates.
269 * @calib: default calibrations.
271 struct iwl_tlv_calib_data {
273 struct iwl_tlv_calib_ctrl calib;
276 struct iwl_firmware_pieces {
277 struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
279 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
280 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
284 * These functions are just to extract uCode section data from the pieces
287 static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
288 enum iwl_ucode_type type,
291 return &pieces->img[type].sec[sec];
294 static void set_sec_data(struct iwl_firmware_pieces *pieces,
295 enum iwl_ucode_type type,
299 pieces->img[type].sec[sec].data = data;
302 static void set_sec_size(struct iwl_firmware_pieces *pieces,
303 enum iwl_ucode_type type,
307 pieces->img[type].sec[sec].size = size;
310 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
311 enum iwl_ucode_type type,
314 return pieces->img[type].sec[sec].size;
317 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
318 enum iwl_ucode_type type,
322 pieces->img[type].sec[sec].offset = offset;
326 * Gets uCode section from tlv.
328 static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
329 const void *data, enum iwl_ucode_type type,
332 struct fw_img_parsing *img;
334 struct fw_sec_parsing *sec_parse;
336 if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
339 sec_parse = (struct fw_sec_parsing *)data;
341 img = &pieces->img[type];
342 sec = &img->sec[img->sec_counter];
344 sec->offset = le32_to_cpu(sec_parse->offset);
345 sec->data = sec_parse->data;
346 sec->size = size - sizeof(sec_parse->offset);
353 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
355 struct iwl_tlv_calib_data *def_calib =
356 (struct iwl_tlv_calib_data *)data;
357 u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
358 if (ucode_type >= IWL_UCODE_TYPE_MAX) {
359 IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
363 drv->fw.default_calib[ucode_type].flow_trigger =
364 def_calib->calib.flow_trigger;
365 drv->fw.default_calib[ucode_type].event_trigger =
366 def_calib->calib.event_trigger;
371 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
372 const struct firmware *ucode_raw,
373 struct iwl_firmware_pieces *pieces)
375 struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
376 u32 api_ver, hdr_size, build;
380 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
381 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
386 if (ucode_raw->size < hdr_size) {
387 IWL_ERR(drv, "File size too small!\n");
390 build = le32_to_cpu(ucode->u.v2.build);
391 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
392 le32_to_cpu(ucode->u.v2.inst_size));
393 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
394 le32_to_cpu(ucode->u.v2.data_size));
395 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
396 le32_to_cpu(ucode->u.v2.init_size));
397 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
398 le32_to_cpu(ucode->u.v2.init_data_size));
399 src = ucode->u.v2.data;
405 if (ucode_raw->size < hdr_size) {
406 IWL_ERR(drv, "File size too small!\n");
410 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
411 le32_to_cpu(ucode->u.v1.inst_size));
412 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
413 le32_to_cpu(ucode->u.v1.data_size));
414 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
415 le32_to_cpu(ucode->u.v1.init_size));
416 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
417 le32_to_cpu(ucode->u.v1.init_data_size));
418 src = ucode->u.v1.data;
423 sprintf(buildstr, " build %u%s", build,
424 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
429 snprintf(drv->fw.fw_version,
430 sizeof(drv->fw.fw_version),
432 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
433 IWL_UCODE_MINOR(drv->fw.ucode_ver),
434 IWL_UCODE_API(drv->fw.ucode_ver),
435 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
438 /* Verify size of file vs. image size info in file's header */
440 if (ucode_raw->size != hdr_size +
441 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
442 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
443 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
444 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
447 "uCode file size %d does not match expected size\n",
448 (int)ucode_raw->size);
453 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
454 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
455 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
456 IWLAGN_RTC_INST_LOWER_BOUND);
457 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
458 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
459 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
460 IWLAGN_RTC_DATA_LOWER_BOUND);
461 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
462 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
463 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
464 IWLAGN_RTC_INST_LOWER_BOUND);
465 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
466 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
467 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
468 IWLAGN_RTC_DATA_LOWER_BOUND);
472 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
473 const struct firmware *ucode_raw,
474 struct iwl_firmware_pieces *pieces,
475 struct iwl_ucode_capabilities *capa)
477 struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
478 struct iwl_ucode_tlv *tlv;
479 size_t len = ucode_raw->size;
482 enum iwl_ucode_tlv_type tlv_type;
487 if (len < sizeof(*ucode)) {
488 IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
492 if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
493 IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
494 le32_to_cpu(ucode->magic));
498 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
499 build = le32_to_cpu(ucode->build);
502 sprintf(buildstr, " build %u%s", build,
503 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
508 snprintf(drv->fw.fw_version,
509 sizeof(drv->fw.fw_version),
511 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
512 IWL_UCODE_MINOR(drv->fw.ucode_ver),
513 IWL_UCODE_API(drv->fw.ucode_ver),
514 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
519 len -= sizeof(*ucode);
521 while (len >= sizeof(*tlv)) {
525 tlv_len = le32_to_cpu(tlv->length);
526 tlv_type = le32_to_cpu(tlv->type);
527 tlv_data = tlv->data;
530 IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
534 len -= ALIGN(tlv_len, 4);
535 data += sizeof(*tlv) + ALIGN(tlv_len, 4);
538 case IWL_UCODE_TLV_INST:
539 set_sec_data(pieces, IWL_UCODE_REGULAR,
540 IWL_UCODE_SECTION_INST, tlv_data);
541 set_sec_size(pieces, IWL_UCODE_REGULAR,
542 IWL_UCODE_SECTION_INST, tlv_len);
543 set_sec_offset(pieces, IWL_UCODE_REGULAR,
544 IWL_UCODE_SECTION_INST,
545 IWLAGN_RTC_INST_LOWER_BOUND);
547 case IWL_UCODE_TLV_DATA:
548 set_sec_data(pieces, IWL_UCODE_REGULAR,
549 IWL_UCODE_SECTION_DATA, tlv_data);
550 set_sec_size(pieces, IWL_UCODE_REGULAR,
551 IWL_UCODE_SECTION_DATA, tlv_len);
552 set_sec_offset(pieces, IWL_UCODE_REGULAR,
553 IWL_UCODE_SECTION_DATA,
554 IWLAGN_RTC_DATA_LOWER_BOUND);
556 case IWL_UCODE_TLV_INIT:
557 set_sec_data(pieces, IWL_UCODE_INIT,
558 IWL_UCODE_SECTION_INST, tlv_data);
559 set_sec_size(pieces, IWL_UCODE_INIT,
560 IWL_UCODE_SECTION_INST, tlv_len);
561 set_sec_offset(pieces, IWL_UCODE_INIT,
562 IWL_UCODE_SECTION_INST,
563 IWLAGN_RTC_INST_LOWER_BOUND);
565 case IWL_UCODE_TLV_INIT_DATA:
566 set_sec_data(pieces, IWL_UCODE_INIT,
567 IWL_UCODE_SECTION_DATA, tlv_data);
568 set_sec_size(pieces, IWL_UCODE_INIT,
569 IWL_UCODE_SECTION_DATA, tlv_len);
570 set_sec_offset(pieces, IWL_UCODE_INIT,
571 IWL_UCODE_SECTION_DATA,
572 IWLAGN_RTC_DATA_LOWER_BOUND);
574 case IWL_UCODE_TLV_BOOT:
575 IWL_ERR(drv, "Found unexpected BOOT ucode\n");
577 case IWL_UCODE_TLV_PROBE_MAX_LEN:
578 if (tlv_len != sizeof(u32))
579 goto invalid_tlv_len;
580 capa->max_probe_length =
581 le32_to_cpup((__le32 *)tlv_data);
583 case IWL_UCODE_TLV_PAN:
585 goto invalid_tlv_len;
586 capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
588 case IWL_UCODE_TLV_FLAGS:
589 /* must be at least one u32 */
590 if (tlv_len < sizeof(u32))
591 goto invalid_tlv_len;
592 /* and a proper number of u32s */
593 if (tlv_len % sizeof(u32))
594 goto invalid_tlv_len;
596 * This driver only reads the first u32 as
597 * right now no more features are defined,
598 * if that changes then either the driver
599 * will not work with the new firmware, or
600 * it'll not take advantage of new features.
602 capa->flags = le32_to_cpup((__le32 *)tlv_data);
604 case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
605 if (tlv_len != sizeof(u32))
606 goto invalid_tlv_len;
607 pieces->init_evtlog_ptr =
608 le32_to_cpup((__le32 *)tlv_data);
610 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
611 if (tlv_len != sizeof(u32))
612 goto invalid_tlv_len;
613 pieces->init_evtlog_size =
614 le32_to_cpup((__le32 *)tlv_data);
616 case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
617 if (tlv_len != sizeof(u32))
618 goto invalid_tlv_len;
619 pieces->init_errlog_ptr =
620 le32_to_cpup((__le32 *)tlv_data);
622 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
623 if (tlv_len != sizeof(u32))
624 goto invalid_tlv_len;
625 pieces->inst_evtlog_ptr =
626 le32_to_cpup((__le32 *)tlv_data);
628 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
629 if (tlv_len != sizeof(u32))
630 goto invalid_tlv_len;
631 pieces->inst_evtlog_size =
632 le32_to_cpup((__le32 *)tlv_data);
634 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
635 if (tlv_len != sizeof(u32))
636 goto invalid_tlv_len;
637 pieces->inst_errlog_ptr =
638 le32_to_cpup((__le32 *)tlv_data);
640 case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
642 goto invalid_tlv_len;
643 drv->fw.enhance_sensitivity_table = true;
645 case IWL_UCODE_TLV_WOWLAN_INST:
646 set_sec_data(pieces, IWL_UCODE_WOWLAN,
647 IWL_UCODE_SECTION_INST, tlv_data);
648 set_sec_size(pieces, IWL_UCODE_WOWLAN,
649 IWL_UCODE_SECTION_INST, tlv_len);
650 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
651 IWL_UCODE_SECTION_INST,
652 IWLAGN_RTC_INST_LOWER_BOUND);
654 case IWL_UCODE_TLV_WOWLAN_DATA:
655 set_sec_data(pieces, IWL_UCODE_WOWLAN,
656 IWL_UCODE_SECTION_DATA, tlv_data);
657 set_sec_size(pieces, IWL_UCODE_WOWLAN,
658 IWL_UCODE_SECTION_DATA, tlv_len);
659 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
660 IWL_UCODE_SECTION_DATA,
661 IWLAGN_RTC_DATA_LOWER_BOUND);
663 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
664 if (tlv_len != sizeof(u32))
665 goto invalid_tlv_len;
666 capa->standard_phy_calibration_size =
667 le32_to_cpup((__le32 *)tlv_data);
669 case IWL_UCODE_TLV_SEC_RT:
670 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
672 drv->fw.mvm_fw = true;
674 case IWL_UCODE_TLV_SEC_INIT:
675 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
677 drv->fw.mvm_fw = true;
679 case IWL_UCODE_TLV_SEC_WOWLAN:
680 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
682 drv->fw.mvm_fw = true;
684 case IWL_UCODE_TLV_DEF_CALIB:
685 if (tlv_len != sizeof(struct iwl_tlv_calib_data))
686 goto invalid_tlv_len;
687 if (iwl_set_default_calib(drv, tlv_data))
690 case IWL_UCODE_TLV_PHY_SKU:
691 if (tlv_len != sizeof(u32))
692 goto invalid_tlv_len;
693 drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
696 IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
702 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
703 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
710 IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
712 iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
717 static int iwl_alloc_ucode(struct iwl_drv *drv,
718 struct iwl_firmware_pieces *pieces,
719 enum iwl_ucode_type type)
723 i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
725 if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
726 get_sec(pieces, type, i)))
731 static int validate_sec_sizes(struct iwl_drv *drv,
732 struct iwl_firmware_pieces *pieces,
733 const struct iwl_cfg *cfg)
735 IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
736 get_sec_size(pieces, IWL_UCODE_REGULAR,
737 IWL_UCODE_SECTION_INST));
738 IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
739 get_sec_size(pieces, IWL_UCODE_REGULAR,
740 IWL_UCODE_SECTION_DATA));
741 IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
742 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
743 IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
744 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
746 /* Verify that uCode images will fit in card's SRAM. */
747 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
748 cfg->max_inst_size) {
749 IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
750 get_sec_size(pieces, IWL_UCODE_REGULAR,
751 IWL_UCODE_SECTION_INST));
755 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
756 cfg->max_data_size) {
757 IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
758 get_sec_size(pieces, IWL_UCODE_REGULAR,
759 IWL_UCODE_SECTION_DATA));
763 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
764 cfg->max_inst_size) {
765 IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
766 get_sec_size(pieces, IWL_UCODE_INIT,
767 IWL_UCODE_SECTION_INST));
771 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
772 cfg->max_data_size) {
773 IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
774 get_sec_size(pieces, IWL_UCODE_REGULAR,
775 IWL_UCODE_SECTION_DATA));
781 static struct iwl_op_mode *
782 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
784 const struct iwl_op_mode_ops *ops = op->ops;
785 struct dentry *dbgfs_dir = NULL;
786 struct iwl_op_mode *op_mode = NULL;
788 #ifdef CONFIG_IWLWIFI_DEBUGFS
789 drv->dbgfs_op_mode = debugfs_create_dir(op->name,
791 if (!drv->dbgfs_op_mode) {
793 "failed to create opmode debugfs directory\n");
796 dbgfs_dir = drv->dbgfs_op_mode;
799 op_mode = ops->start(drv->trans, drv->cfg, &drv->fw, dbgfs_dir);
801 #ifdef CONFIG_IWLWIFI_DEBUGFS
803 debugfs_remove_recursive(drv->dbgfs_op_mode);
804 drv->dbgfs_op_mode = NULL;
811 static void _iwl_op_mode_stop(struct iwl_drv *drv)
813 /* op_mode can be NULL if its start failed */
815 iwl_op_mode_stop(drv->op_mode);
818 #ifdef CONFIG_IWLWIFI_DEBUGFS
819 debugfs_remove_recursive(drv->dbgfs_op_mode);
820 drv->dbgfs_op_mode = NULL;
826 * iwl_req_fw_callback - callback when firmware was loaded
828 * If loaded successfully, copies the firmware into buffers
829 * for the card to fetch (via DMA).
831 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
833 struct iwl_drv *drv = context;
834 struct iwl_fw *fw = &drv->fw;
835 struct iwl_ucode_header *ucode;
836 struct iwlwifi_opmode_table *op;
838 struct iwl_firmware_pieces pieces;
839 const unsigned int api_max = drv->cfg->ucode_api_max;
840 unsigned int api_ok = drv->cfg->ucode_api_ok;
841 const unsigned int api_min = drv->cfg->ucode_api_min;
844 bool load_module = false;
846 fw->ucode_capa.max_probe_length = 200;
847 fw->ucode_capa.standard_phy_calibration_size =
848 IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
853 memset(&pieces, 0, sizeof(pieces));
856 if (drv->fw_index <= api_ok)
858 "request for firmware file '%s' failed.\n",
863 IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
864 drv->firmware_name, ucode_raw->size);
866 /* Make sure that we got at least the API version number */
867 if (ucode_raw->size < 4) {
868 IWL_ERR(drv, "File size way too small!\n");
872 /* Data from ucode file: header followed by uCode images */
873 ucode = (struct iwl_ucode_header *)ucode_raw->data;
876 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, &pieces);
878 err = iwl_parse_tlv_firmware(drv, ucode_raw, &pieces,
884 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
887 * api_ver should match the api version forming part of the
888 * firmware filename ... but we don't check for that and only rely
889 * on the API version read from firmware header from here on forward
891 /* no api version check required for experimental uCode */
892 if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
893 if (api_ver < api_min || api_ver > api_max) {
895 "Driver unable to support your firmware API. "
896 "Driver supports v%u, firmware is v%u.\n",
901 if (api_ver < api_ok) {
902 if (api_ok != api_max)
903 IWL_ERR(drv, "Firmware has old API version, "
904 "expected v%u through v%u, got v%u.\n",
905 api_ok, api_max, api_ver);
907 IWL_ERR(drv, "Firmware has old API version, "
908 "expected v%u, got v%u.\n",
910 IWL_ERR(drv, "New firmware can be obtained from "
911 "http://www.intellinuxwireless.org/.\n");
915 IWL_INFO(drv, "loaded firmware version %s", drv->fw.fw_version);
918 * In mvm uCode there is no difference between data and instructions
921 if (!fw->mvm_fw && validate_sec_sizes(drv, &pieces, drv->cfg))
924 /* Allocate ucode buffers for card's bus-master loading ... */
926 /* Runtime instructions and 2 copies of data:
927 * 1) unmodified from disk
928 * 2) backup cache for save/restore during power-downs */
929 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
930 if (iwl_alloc_ucode(drv, &pieces, i))
933 /* Now that we can no longer fail, copy information */
936 * The (size - 16) / 12 formula is based on the information recorded
937 * for each event, which is of mode 1 (including timestamp) for all
938 * new microcodes that include this information.
940 fw->init_evtlog_ptr = pieces.init_evtlog_ptr;
941 if (pieces.init_evtlog_size)
942 fw->init_evtlog_size = (pieces.init_evtlog_size - 16)/12;
944 fw->init_evtlog_size =
945 drv->cfg->base_params->max_event_log_size;
946 fw->init_errlog_ptr = pieces.init_errlog_ptr;
947 fw->inst_evtlog_ptr = pieces.inst_evtlog_ptr;
948 if (pieces.inst_evtlog_size)
949 fw->inst_evtlog_size = (pieces.inst_evtlog_size - 16)/12;
951 fw->inst_evtlog_size =
952 drv->cfg->base_params->max_event_log_size;
953 fw->inst_errlog_ptr = pieces.inst_errlog_ptr;
956 * figure out the offset of chain noise reset and gain commands
957 * base on the size of standard phy calibration commands table size
959 if (fw->ucode_capa.standard_phy_calibration_size >
960 IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
961 fw->ucode_capa.standard_phy_calibration_size =
962 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
964 /* We have our copies now, allow OS release its copies */
965 release_firmware(ucode_raw);
967 mutex_lock(&iwlwifi_opmode_table_mtx);
969 op = &iwlwifi_opmode_table[MVM_OP_MODE];
971 op = &iwlwifi_opmode_table[DVM_OP_MODE];
973 /* add this device to the list of devices using this op_mode */
974 list_add_tail(&drv->list, &op->drv);
977 drv->op_mode = _iwl_op_mode_start(drv, op);
980 mutex_unlock(&iwlwifi_opmode_table_mtx);
986 mutex_unlock(&iwlwifi_opmode_table_mtx);
989 * Complete the firmware request last so that
990 * a driver unbind (stop) doesn't run while we
991 * are doing the start() above.
993 complete(&drv->request_firmware_complete);
996 * Load the module last so we don't block anything
997 * else from proceeding if the module fails to load
1001 request_module("%s", op->name);
1005 /* try next, if any */
1006 release_firmware(ucode_raw);
1007 if (iwl_request_firmware(drv, false))
1012 IWL_ERR(drv, "failed to allocate pci memory\n");
1013 iwl_dealloc_ucode(drv);
1014 release_firmware(ucode_raw);
1016 complete(&drv->request_firmware_complete);
1017 device_release_driver(drv->trans->dev);
1020 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans,
1021 const struct iwl_cfg *cfg)
1023 struct iwl_drv *drv;
1026 drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1031 drv->dev = trans->dev;
1034 init_completion(&drv->request_firmware_complete);
1035 INIT_LIST_HEAD(&drv->list);
1037 #ifdef CONFIG_IWLWIFI_DEBUGFS
1038 /* Create the device debugfs entries. */
1039 drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1042 if (!drv->dbgfs_drv) {
1043 IWL_ERR(drv, "failed to create debugfs directory\n");
1048 /* Create transport layer debugfs dir */
1049 drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1051 if (!drv->trans->dbgfs_dir) {
1052 IWL_ERR(drv, "failed to create transport debugfs directory\n");
1054 goto err_free_dbgfs;
1058 ret = iwl_request_firmware(drv, true);
1060 IWL_ERR(trans, "Couldn't request the fw\n");
1067 #ifdef CONFIG_IWLWIFI_DEBUGFS
1069 debugfs_remove_recursive(drv->dbgfs_drv);
1074 return ERR_PTR(ret);
1077 void iwl_drv_stop(struct iwl_drv *drv)
1079 wait_for_completion(&drv->request_firmware_complete);
1081 _iwl_op_mode_stop(drv);
1083 iwl_dealloc_ucode(drv);
1085 mutex_lock(&iwlwifi_opmode_table_mtx);
1087 * List is empty (this item wasn't added)
1088 * when firmware loading failed -- in that
1089 * case we can't remove it from any list.
1091 if (!list_empty(&drv->list))
1092 list_del(&drv->list);
1093 mutex_unlock(&iwlwifi_opmode_table_mtx);
1095 #ifdef CONFIG_IWLWIFI_DEBUGFS
1096 debugfs_remove_recursive(drv->dbgfs_drv);
1103 /* shared module parameters */
1104 struct iwl_mod_params iwlwifi_mod_params = {
1108 .bt_coex_active = true,
1109 .power_level = IWL_POWER_INDEX_1,
1110 .bt_ch_announce = true,
1113 /* the rest are 0 by default */
1115 EXPORT_SYMBOL_GPL(iwlwifi_mod_params);
1117 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
1120 struct iwl_drv *drv;
1121 struct iwlwifi_opmode_table *op;
1123 mutex_lock(&iwlwifi_opmode_table_mtx);
1124 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1125 op = &iwlwifi_opmode_table[i];
1126 if (strcmp(op->name, name))
1129 /* TODO: need to handle exceptional case */
1130 list_for_each_entry(drv, &op->drv, list)
1131 drv->op_mode = _iwl_op_mode_start(drv, op);
1133 mutex_unlock(&iwlwifi_opmode_table_mtx);
1136 mutex_unlock(&iwlwifi_opmode_table_mtx);
1139 EXPORT_SYMBOL_GPL(iwl_opmode_register);
1141 void iwl_opmode_deregister(const char *name)
1144 struct iwl_drv *drv;
1146 mutex_lock(&iwlwifi_opmode_table_mtx);
1147 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1148 if (strcmp(iwlwifi_opmode_table[i].name, name))
1150 iwlwifi_opmode_table[i].ops = NULL;
1152 /* call the stop routine for all devices */
1153 list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
1154 _iwl_op_mode_stop(drv);
1156 mutex_unlock(&iwlwifi_opmode_table_mtx);
1159 mutex_unlock(&iwlwifi_opmode_table_mtx);
1161 EXPORT_SYMBOL_GPL(iwl_opmode_deregister);
1163 static int __init iwl_drv_init(void)
1167 mutex_init(&iwlwifi_opmode_table_mtx);
1169 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
1170 INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
1172 pr_info(DRV_DESCRIPTION ", " DRV_VERSION "\n");
1173 pr_info(DRV_COPYRIGHT "\n");
1175 #ifdef CONFIG_IWLWIFI_DEBUGFS
1176 /* Create the root of iwlwifi debugfs subsystem. */
1177 iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
1179 if (!iwl_dbgfs_root)
1183 return iwl_pci_register_driver();
1185 module_init(iwl_drv_init);
1187 static void __exit iwl_drv_exit(void)
1189 iwl_pci_unregister_driver();
1191 #ifdef CONFIG_IWLWIFI_DEBUGFS
1192 debugfs_remove_recursive(iwl_dbgfs_root);
1195 module_exit(iwl_drv_exit);
1197 #ifdef CONFIG_IWLWIFI_DEBUG
1198 module_param_named(debug, iwlwifi_mod_params.debug_level, uint,
1200 MODULE_PARM_DESC(debug, "debug output mask");
1203 module_param_named(swcrypto, iwlwifi_mod_params.sw_crypto, int, S_IRUGO);
1204 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
1205 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, S_IRUGO);
1206 MODULE_PARM_DESC(11n_disable,
1207 "disable 11n functionality, bitmap: 1: full, 2: agg TX, 4: agg RX");
1208 module_param_named(amsdu_size_8K, iwlwifi_mod_params.amsdu_size_8K,
1210 MODULE_PARM_DESC(amsdu_size_8K, "enable 8K amsdu size");
1211 module_param_named(fw_restart, iwlwifi_mod_params.restart_fw, int, S_IRUGO);
1212 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error");
1214 module_param_named(antenna_coupling, iwlwifi_mod_params.ant_coupling,
1216 MODULE_PARM_DESC(antenna_coupling,
1217 "specify antenna coupling in dB (defualt: 0 dB)");
1219 module_param_named(bt_ch_inhibition, iwlwifi_mod_params.bt_ch_announce,
1221 MODULE_PARM_DESC(bt_ch_inhibition,
1222 "Enable BT channel inhibition (default: enable)");
1224 module_param_named(plcp_check, iwlwifi_mod_params.plcp_check, bool, S_IRUGO);
1225 MODULE_PARM_DESC(plcp_check, "Check plcp health (default: 1 [enabled])");
1227 module_param_named(wd_disable, iwlwifi_mod_params.wd_disable, int, S_IRUGO);
1228 MODULE_PARM_DESC(wd_disable,
1229 "Disable stuck queue watchdog timer 0=system default, "
1230 "1=disable, 2=enable (default: 0)");
1233 * set bt_coex_active to true, uCode will do kill/defer
1234 * every time the priority line is asserted (BT is sending signals on the
1235 * priority line in the PCIx).
1236 * set bt_coex_active to false, uCode will ignore the BT activity and
1237 * perform the normal operation
1239 * User might experience transmit issue on some platform due to WiFi/BT
1240 * co-exist problem. The possible behaviors are:
1241 * Able to scan and finding all the available AP
1242 * Not able to associate with any AP
1243 * On those platforms, WiFi communication can be restored by set
1244 * "bt_coex_active" module parameter to "false"
1246 * default: bt_coex_active = true (BT_COEX_ENABLE)
1248 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1250 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1252 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, S_IRUGO);
1253 MODULE_PARM_DESC(led_mode, "0=system default, "
1254 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1256 module_param_named(power_save, iwlwifi_mod_params.power_save,
1258 MODULE_PARM_DESC(power_save,
1259 "enable WiFi power management (default: disable)");
1261 module_param_named(power_level, iwlwifi_mod_params.power_level,
1263 MODULE_PARM_DESC(power_level,
1264 "default power save level (range from 1 - 5, default: 1)");
1266 module_param_named(auto_agg, iwlwifi_mod_params.auto_agg,
1268 MODULE_PARM_DESC(auto_agg,
1269 "enable agg w/o check traffic load (default: enable)");
1271 module_param_named(5ghz_disable, iwlwifi_mod_params.disable_5ghz,
1273 MODULE_PARM_DESC(5ghz_disable, "disable 5GHz band (default: 0 [enabled])");