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 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
11 * Copyright(c) 2018 - 2019 Intel Corporation
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of version 2 of the GNU General Public License as
15 * published by the Free Software Foundation.
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
22 * The full GNU General Public License is included in this distribution
23 * in the file called COPYING.
25 * Contact Information:
26 * Intel Linux Wireless <linuxwifi@intel.com>
27 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
31 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
32 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
33 * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
34 * Copyright(c) 2018 - 2019 Intel Corporation
35 * All rights reserved.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
41 * * Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * * Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in
45 * the documentation and/or other materials provided with the
47 * * Neither the name Intel Corporation nor the names of its
48 * contributors may be used to endorse or promote products derived
49 * from this software without specific prior written permission.
51 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
63 *****************************************************************************/
64 #include <linux/completion.h>
65 #include <linux/dma-mapping.h>
66 #include <linux/firmware.h>
67 #include <linux/module.h>
68 #include <linux/vmalloc.h>
72 #include "iwl-debug.h"
73 #include "iwl-trans.h"
74 #include "iwl-op-mode.h"
75 #include "iwl-agn-hw.h"
77 #include "iwl-dbg-tlv.h"
78 #include "iwl-config.h"
79 #include "iwl-modparams.h"
80 #include "fw/api/alive.h"
82 /******************************************************************************
86 ******************************************************************************/
88 #define DRV_DESCRIPTION "Intel(R) Wireless WiFi driver for Linux"
89 MODULE_DESCRIPTION(DRV_DESCRIPTION);
90 MODULE_AUTHOR(DRV_COPYRIGHT " " DRV_AUTHOR);
91 MODULE_LICENSE("GPL");
93 #ifdef CONFIG_IWLWIFI_DEBUGFS
94 static struct dentry *iwl_dbgfs_root;
98 * struct iwl_drv - drv common data
99 * @list: list of drv structures using this opmode
100 * @fw: the iwl_fw structure
101 * @op_mode: the running op_mode
102 * @trans: transport layer
103 * @dev: for debug prints only
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
109 struct list_head list;
112 struct iwl_op_mode *op_mode;
113 struct iwl_trans *trans;
116 int fw_index; /* firmware we're trying to load */
117 char firmware_name[64]; /* name of firmware file to load */
119 struct completion request_firmware_complete;
121 #ifdef CONFIG_IWLWIFI_DEBUGFS
122 struct dentry *dbgfs_drv;
123 struct dentry *dbgfs_trans;
124 struct dentry *dbgfs_op_mode;
133 /* Protects the table contents, i.e. the ops pointer & drv list */
134 static struct mutex iwlwifi_opmode_table_mtx;
135 static struct iwlwifi_opmode_table {
136 const char *name; /* name: iwldvm, iwlmvm, etc */
137 const struct iwl_op_mode_ops *ops; /* pointer to op_mode ops */
138 struct list_head drv; /* list of devices using this op_mode */
139 } iwlwifi_opmode_table[] = { /* ops set when driver is initialized */
140 [DVM_OP_MODE] = { .name = "iwldvm", .ops = NULL },
141 [MVM_OP_MODE] = { .name = "iwlmvm", .ops = NULL },
144 #define IWL_DEFAULT_SCAN_CHANNELS 40
147 * struct fw_sec: Just for the image parsing process.
148 * For the fw storage we are using struct fw_desc.
151 const void *data; /* the sec data */
152 size_t size; /* section size */
153 u32 offset; /* offset of writing in the device */
156 static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
163 static void iwl_free_fw_img(struct iwl_drv *drv, struct fw_img *img)
166 for (i = 0; i < img->num_sec; i++)
167 iwl_free_fw_desc(drv, &img->sec[i]);
171 static void iwl_dealloc_ucode(struct iwl_drv *drv)
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 kfree(drv->fw.dbg.mem_tlv);
182 kfree(drv->fw.ucode_capa.cmd_versions);
184 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
185 iwl_free_fw_img(drv, drv->fw.img + i);
188 static int iwl_alloc_fw_desc(struct iwl_drv *drv, struct fw_desc *desc,
195 if (!sec || !sec->size)
198 data = vmalloc(sec->size);
202 desc->len = sec->size;
203 desc->offset = sec->offset;
204 memcpy(data, sec->data, desc->len);
210 static void iwl_req_fw_callback(const struct firmware *ucode_raw,
213 static int iwl_request_firmware(struct iwl_drv *drv, bool first)
215 const struct iwl_cfg *cfg = drv->trans->cfg;
218 if (drv->trans->trans_cfg->device_family == IWL_DEVICE_FAMILY_9000 &&
219 (CSR_HW_REV_STEP(drv->trans->hw_rev) != SILICON_B_STEP &&
220 CSR_HW_REV_STEP(drv->trans->hw_rev) != SILICON_C_STEP)) {
222 "Only HW steps B and C are currently supported (0x%0x)\n",
228 drv->fw_index = cfg->ucode_api_max;
229 sprintf(tag, "%d", drv->fw_index);
232 sprintf(tag, "%d", drv->fw_index);
235 if (drv->fw_index < cfg->ucode_api_min) {
236 IWL_ERR(drv, "no suitable firmware found!\n");
238 if (cfg->ucode_api_min == cfg->ucode_api_max) {
239 IWL_ERR(drv, "%s%d is required\n", cfg->fw_name_pre,
242 IWL_ERR(drv, "minimum version required: %s%d\n",
243 cfg->fw_name_pre, cfg->ucode_api_min);
244 IWL_ERR(drv, "maximum version supported: %s%d\n",
245 cfg->fw_name_pre, cfg->ucode_api_max);
249 "check /*(DEBLOBBED)*/\n");
253 snprintf(drv->firmware_name, sizeof(drv->firmware_name), "/*(DEBLOBBED)*/",
254 cfg->fw_name_pre, tag);
256 IWL_DEBUG_FW_INFO(drv, "attempting to load firmware '%s'\n",
259 return reject_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
261 GFP_KERNEL, drv, iwl_req_fw_callback);
264 struct fw_img_parsing {
270 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
272 struct fw_sec_parsing {
278 * struct iwl_tlv_calib_data - parse the default calib data from TLV
280 * @ucode_type: the uCode to which the following default calib relates.
281 * @calib: default calibrations.
283 struct iwl_tlv_calib_data {
285 struct iwl_tlv_calib_ctrl calib;
288 struct iwl_firmware_pieces {
289 struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
291 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
292 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
294 /* FW debug data parsed for driver usage */
295 bool dbg_dest_tlv_init;
298 struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
299 struct iwl_fw_dbg_dest_tlv_v1 *dbg_dest_tlv_v1;
301 struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
302 size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX];
303 struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX];
304 size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX];
305 struct iwl_fw_dbg_mem_seg_tlv *dbg_mem_tlv;
310 * These functions are just to extract uCode section data from the pieces
313 static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
314 enum iwl_ucode_type type,
317 return &pieces->img[type].sec[sec];
320 static void alloc_sec_data(struct iwl_firmware_pieces *pieces,
321 enum iwl_ucode_type type,
324 struct fw_img_parsing *img = &pieces->img[type];
325 struct fw_sec *sec_memory;
327 size_t alloc_size = sizeof(*img->sec) * size;
329 if (img->sec && img->sec_counter >= size)
332 sec_memory = krealloc(img->sec, alloc_size, GFP_KERNEL);
336 img->sec = sec_memory;
337 img->sec_counter = size;
340 static void set_sec_data(struct iwl_firmware_pieces *pieces,
341 enum iwl_ucode_type type,
345 alloc_sec_data(pieces, type, sec);
347 pieces->img[type].sec[sec].data = data;
350 static void set_sec_size(struct iwl_firmware_pieces *pieces,
351 enum iwl_ucode_type type,
355 alloc_sec_data(pieces, type, sec);
357 pieces->img[type].sec[sec].size = size;
360 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
361 enum iwl_ucode_type type,
364 return pieces->img[type].sec[sec].size;
367 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
368 enum iwl_ucode_type type,
372 alloc_sec_data(pieces, type, sec);
374 pieces->img[type].sec[sec].offset = offset;
377 static int iwl_store_cscheme(struct iwl_fw *fw, const u8 *data, const u32 len)
380 struct iwl_fw_cscheme_list *l = (struct iwl_fw_cscheme_list *)data;
381 struct iwl_fw_cipher_scheme *fwcs;
383 if (len < sizeof(*l) ||
384 len < sizeof(l->size) + l->size * sizeof(l->cs[0]))
387 for (i = 0, j = 0; i < IWL_UCODE_MAX_CS && i < l->size; i++) {
390 /* we skip schemes with zero cipher suite selector */
401 * Gets uCode section from tlv.
403 static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
404 const void *data, enum iwl_ucode_type type,
407 struct fw_img_parsing *img;
409 struct fw_sec_parsing *sec_parse;
412 if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
415 sec_parse = (struct fw_sec_parsing *)data;
417 img = &pieces->img[type];
419 alloc_size = sizeof(*img->sec) * (img->sec_counter + 1);
420 sec = krealloc(img->sec, alloc_size, GFP_KERNEL);
425 sec = &img->sec[img->sec_counter];
427 sec->offset = le32_to_cpu(sec_parse->offset);
428 sec->data = sec_parse->data;
429 sec->size = size - sizeof(sec_parse->offset);
436 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
438 struct iwl_tlv_calib_data *def_calib =
439 (struct iwl_tlv_calib_data *)data;
440 u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
441 if (ucode_type >= IWL_UCODE_TYPE_MAX) {
442 IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
446 drv->fw.default_calib[ucode_type].flow_trigger =
447 def_calib->calib.flow_trigger;
448 drv->fw.default_calib[ucode_type].event_trigger =
449 def_calib->calib.event_trigger;
454 static void iwl_set_ucode_api_flags(struct iwl_drv *drv, const u8 *data,
455 struct iwl_ucode_capabilities *capa)
457 const struct iwl_ucode_api *ucode_api = (void *)data;
458 u32 api_index = le32_to_cpu(ucode_api->api_index);
459 u32 api_flags = le32_to_cpu(ucode_api->api_flags);
462 if (api_index >= DIV_ROUND_UP(NUM_IWL_UCODE_TLV_API, 32)) {
464 "api flags index %d larger than supported by driver\n",
469 for (i = 0; i < 32; i++) {
470 if (api_flags & BIT(i))
471 __set_bit(i + 32 * api_index, capa->_api);
475 static void iwl_set_ucode_capabilities(struct iwl_drv *drv, const u8 *data,
476 struct iwl_ucode_capabilities *capa)
478 const struct iwl_ucode_capa *ucode_capa = (void *)data;
479 u32 api_index = le32_to_cpu(ucode_capa->api_index);
480 u32 api_flags = le32_to_cpu(ucode_capa->api_capa);
483 if (api_index >= DIV_ROUND_UP(NUM_IWL_UCODE_TLV_CAPA, 32)) {
485 "capa flags index %d larger than supported by driver\n",
490 for (i = 0; i < 32; i++) {
491 if (api_flags & BIT(i))
492 __set_bit(i + 32 * api_index, capa->_capa);
496 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
497 const struct firmware *ucode_raw,
498 struct iwl_firmware_pieces *pieces)
500 struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
501 u32 api_ver, hdr_size, build;
505 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
506 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
511 if (ucode_raw->size < hdr_size) {
512 IWL_ERR(drv, "File size too small!\n");
515 build = le32_to_cpu(ucode->u.v2.build);
516 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
517 le32_to_cpu(ucode->u.v2.inst_size));
518 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
519 le32_to_cpu(ucode->u.v2.data_size));
520 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
521 le32_to_cpu(ucode->u.v2.init_size));
522 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
523 le32_to_cpu(ucode->u.v2.init_data_size));
524 src = ucode->u.v2.data;
530 if (ucode_raw->size < hdr_size) {
531 IWL_ERR(drv, "File size too small!\n");
535 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
536 le32_to_cpu(ucode->u.v1.inst_size));
537 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
538 le32_to_cpu(ucode->u.v1.data_size));
539 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
540 le32_to_cpu(ucode->u.v1.init_size));
541 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
542 le32_to_cpu(ucode->u.v1.init_data_size));
543 src = ucode->u.v1.data;
548 sprintf(buildstr, " build %u", build);
552 snprintf(drv->fw.fw_version,
553 sizeof(drv->fw.fw_version),
555 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
556 IWL_UCODE_MINOR(drv->fw.ucode_ver),
557 IWL_UCODE_API(drv->fw.ucode_ver),
558 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
561 /* Verify size of file vs. image size info in file's header */
563 if (ucode_raw->size != hdr_size +
564 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
565 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
566 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
567 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
570 "uCode file size %d does not match expected size\n",
571 (int)ucode_raw->size);
576 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
577 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
578 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
579 IWLAGN_RTC_INST_LOWER_BOUND);
580 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
581 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
582 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
583 IWLAGN_RTC_DATA_LOWER_BOUND);
584 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
585 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
586 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
587 IWLAGN_RTC_INST_LOWER_BOUND);
588 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
589 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
590 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
591 IWLAGN_RTC_DATA_LOWER_BOUND);
595 #define FW_ADDR_CACHE_CONTROL 0xC0000000
597 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
598 const struct firmware *ucode_raw,
599 struct iwl_firmware_pieces *pieces,
600 struct iwl_ucode_capabilities *capa,
601 bool *usniffer_images)
603 struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
604 struct iwl_ucode_tlv *tlv;
605 size_t len = ucode_raw->size;
609 enum iwl_ucode_tlv_type tlv_type;
612 u32 build, paging_mem_size;
614 bool usniffer_req = false;
616 if (len < sizeof(*ucode)) {
617 IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
621 if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
622 IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
623 le32_to_cpu(ucode->magic));
627 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
628 memcpy(drv->fw.human_readable, ucode->human_readable,
629 sizeof(drv->fw.human_readable));
630 build = le32_to_cpu(ucode->build);
633 sprintf(buildstr, " build %u", build);
637 snprintf(drv->fw.fw_version,
638 sizeof(drv->fw.fw_version),
640 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
641 IWL_UCODE_MINOR(drv->fw.ucode_ver),
642 IWL_UCODE_API(drv->fw.ucode_ver),
643 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
648 len -= sizeof(*ucode);
650 while (len >= sizeof(*tlv)) {
654 tlv_len = le32_to_cpu(tlv->length);
655 tlv_type = le32_to_cpu(tlv->type);
656 tlv_data = tlv->data;
659 IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
663 len -= ALIGN(tlv_len, 4);
664 data += sizeof(*tlv) + ALIGN(tlv_len, 4);
667 case IWL_UCODE_TLV_INST:
668 set_sec_data(pieces, IWL_UCODE_REGULAR,
669 IWL_UCODE_SECTION_INST, tlv_data);
670 set_sec_size(pieces, IWL_UCODE_REGULAR,
671 IWL_UCODE_SECTION_INST, tlv_len);
672 set_sec_offset(pieces, IWL_UCODE_REGULAR,
673 IWL_UCODE_SECTION_INST,
674 IWLAGN_RTC_INST_LOWER_BOUND);
676 case IWL_UCODE_TLV_DATA:
677 set_sec_data(pieces, IWL_UCODE_REGULAR,
678 IWL_UCODE_SECTION_DATA, tlv_data);
679 set_sec_size(pieces, IWL_UCODE_REGULAR,
680 IWL_UCODE_SECTION_DATA, tlv_len);
681 set_sec_offset(pieces, IWL_UCODE_REGULAR,
682 IWL_UCODE_SECTION_DATA,
683 IWLAGN_RTC_DATA_LOWER_BOUND);
685 case IWL_UCODE_TLV_INIT:
686 set_sec_data(pieces, IWL_UCODE_INIT,
687 IWL_UCODE_SECTION_INST, tlv_data);
688 set_sec_size(pieces, IWL_UCODE_INIT,
689 IWL_UCODE_SECTION_INST, tlv_len);
690 set_sec_offset(pieces, IWL_UCODE_INIT,
691 IWL_UCODE_SECTION_INST,
692 IWLAGN_RTC_INST_LOWER_BOUND);
694 case IWL_UCODE_TLV_INIT_DATA:
695 set_sec_data(pieces, IWL_UCODE_INIT,
696 IWL_UCODE_SECTION_DATA, tlv_data);
697 set_sec_size(pieces, IWL_UCODE_INIT,
698 IWL_UCODE_SECTION_DATA, tlv_len);
699 set_sec_offset(pieces, IWL_UCODE_INIT,
700 IWL_UCODE_SECTION_DATA,
701 IWLAGN_RTC_DATA_LOWER_BOUND);
703 case IWL_UCODE_TLV_BOOT:
704 IWL_ERR(drv, "Found unexpected BOOT ucode\n");
706 case IWL_UCODE_TLV_PROBE_MAX_LEN:
707 if (tlv_len != sizeof(u32))
708 goto invalid_tlv_len;
709 capa->max_probe_length =
710 le32_to_cpup((__le32 *)tlv_data);
712 case IWL_UCODE_TLV_PAN:
714 goto invalid_tlv_len;
715 capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
717 case IWL_UCODE_TLV_FLAGS:
718 /* must be at least one u32 */
719 if (tlv_len < sizeof(u32))
720 goto invalid_tlv_len;
721 /* and a proper number of u32s */
722 if (tlv_len % sizeof(u32))
723 goto invalid_tlv_len;
725 * This driver only reads the first u32 as
726 * right now no more features are defined,
727 * if that changes then either the driver
728 * will not work with the new firmware, or
729 * it'll not take advantage of new features.
731 capa->flags = le32_to_cpup((__le32 *)tlv_data);
733 case IWL_UCODE_TLV_API_CHANGES_SET:
734 if (tlv_len != sizeof(struct iwl_ucode_api))
735 goto invalid_tlv_len;
736 iwl_set_ucode_api_flags(drv, tlv_data, capa);
738 case IWL_UCODE_TLV_ENABLED_CAPABILITIES:
739 if (tlv_len != sizeof(struct iwl_ucode_capa))
740 goto invalid_tlv_len;
741 iwl_set_ucode_capabilities(drv, tlv_data, capa);
743 case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
744 if (tlv_len != sizeof(u32))
745 goto invalid_tlv_len;
746 pieces->init_evtlog_ptr =
747 le32_to_cpup((__le32 *)tlv_data);
749 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
750 if (tlv_len != sizeof(u32))
751 goto invalid_tlv_len;
752 pieces->init_evtlog_size =
753 le32_to_cpup((__le32 *)tlv_data);
755 case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
756 if (tlv_len != sizeof(u32))
757 goto invalid_tlv_len;
758 pieces->init_errlog_ptr =
759 le32_to_cpup((__le32 *)tlv_data);
761 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
762 if (tlv_len != sizeof(u32))
763 goto invalid_tlv_len;
764 pieces->inst_evtlog_ptr =
765 le32_to_cpup((__le32 *)tlv_data);
767 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
768 if (tlv_len != sizeof(u32))
769 goto invalid_tlv_len;
770 pieces->inst_evtlog_size =
771 le32_to_cpup((__le32 *)tlv_data);
773 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
774 if (tlv_len != sizeof(u32))
775 goto invalid_tlv_len;
776 pieces->inst_errlog_ptr =
777 le32_to_cpup((__le32 *)tlv_data);
779 case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
781 goto invalid_tlv_len;
782 drv->fw.enhance_sensitivity_table = true;
784 case IWL_UCODE_TLV_WOWLAN_INST:
785 set_sec_data(pieces, IWL_UCODE_WOWLAN,
786 IWL_UCODE_SECTION_INST, tlv_data);
787 set_sec_size(pieces, IWL_UCODE_WOWLAN,
788 IWL_UCODE_SECTION_INST, tlv_len);
789 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
790 IWL_UCODE_SECTION_INST,
791 IWLAGN_RTC_INST_LOWER_BOUND);
793 case IWL_UCODE_TLV_WOWLAN_DATA:
794 set_sec_data(pieces, IWL_UCODE_WOWLAN,
795 IWL_UCODE_SECTION_DATA, tlv_data);
796 set_sec_size(pieces, IWL_UCODE_WOWLAN,
797 IWL_UCODE_SECTION_DATA, tlv_len);
798 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
799 IWL_UCODE_SECTION_DATA,
800 IWLAGN_RTC_DATA_LOWER_BOUND);
802 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
803 if (tlv_len != sizeof(u32))
804 goto invalid_tlv_len;
805 capa->standard_phy_calibration_size =
806 le32_to_cpup((__le32 *)tlv_data);
808 case IWL_UCODE_TLV_SEC_RT:
809 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
811 drv->fw.type = IWL_FW_MVM;
813 case IWL_UCODE_TLV_SEC_INIT:
814 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
816 drv->fw.type = IWL_FW_MVM;
818 case IWL_UCODE_TLV_SEC_WOWLAN:
819 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
821 drv->fw.type = IWL_FW_MVM;
823 case IWL_UCODE_TLV_DEF_CALIB:
824 if (tlv_len != sizeof(struct iwl_tlv_calib_data))
825 goto invalid_tlv_len;
826 if (iwl_set_default_calib(drv, tlv_data))
829 case IWL_UCODE_TLV_PHY_SKU:
830 if (tlv_len != sizeof(u32))
831 goto invalid_tlv_len;
832 drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
833 drv->fw.valid_tx_ant = (drv->fw.phy_config &
834 FW_PHY_CFG_TX_CHAIN) >>
835 FW_PHY_CFG_TX_CHAIN_POS;
836 drv->fw.valid_rx_ant = (drv->fw.phy_config &
837 FW_PHY_CFG_RX_CHAIN) >>
838 FW_PHY_CFG_RX_CHAIN_POS;
840 case IWL_UCODE_TLV_SECURE_SEC_RT:
841 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
843 drv->fw.type = IWL_FW_MVM;
845 case IWL_UCODE_TLV_SECURE_SEC_INIT:
846 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
848 drv->fw.type = IWL_FW_MVM;
850 case IWL_UCODE_TLV_SECURE_SEC_WOWLAN:
851 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
853 drv->fw.type = IWL_FW_MVM;
855 case IWL_UCODE_TLV_NUM_OF_CPU:
856 if (tlv_len != sizeof(u32))
857 goto invalid_tlv_len;
859 le32_to_cpup((__le32 *)tlv_data);
861 if (num_of_cpus == 2) {
862 drv->fw.img[IWL_UCODE_REGULAR].is_dual_cpus =
864 drv->fw.img[IWL_UCODE_INIT].is_dual_cpus =
866 drv->fw.img[IWL_UCODE_WOWLAN].is_dual_cpus =
868 } else if ((num_of_cpus > 2) || (num_of_cpus < 1)) {
869 IWL_ERR(drv, "Driver support upto 2 CPUs\n");
873 case IWL_UCODE_TLV_CSCHEME:
874 if (iwl_store_cscheme(&drv->fw, tlv_data, tlv_len))
875 goto invalid_tlv_len;
877 case IWL_UCODE_TLV_N_SCAN_CHANNELS:
878 if (tlv_len != sizeof(u32))
879 goto invalid_tlv_len;
880 capa->n_scan_channels =
881 le32_to_cpup((__le32 *)tlv_data);
883 case IWL_UCODE_TLV_FW_VERSION: {
884 __le32 *ptr = (void *)tlv_data;
888 if (tlv_len != sizeof(u32) * 3)
889 goto invalid_tlv_len;
891 major = le32_to_cpup(ptr++);
892 minor = le32_to_cpup(ptr++);
893 local_comp = le32_to_cpup(ptr);
896 snprintf(drv->fw.fw_version,
897 sizeof(drv->fw.fw_version),
898 "%u.%08x.%u", major, minor, local_comp);
900 snprintf(drv->fw.fw_version,
901 sizeof(drv->fw.fw_version),
902 "%u.%u.%u", major, minor, local_comp);
905 case IWL_UCODE_TLV_FW_DBG_DEST: {
906 struct iwl_fw_dbg_dest_tlv *dest = NULL;
907 struct iwl_fw_dbg_dest_tlv_v1 *dest_v1 = NULL;
910 pieces->dbg_dest_ver = (u8 *)tlv_data;
911 if (*pieces->dbg_dest_ver == 1) {
912 dest = (void *)tlv_data;
913 } else if (*pieces->dbg_dest_ver == 0) {
914 dest_v1 = (void *)tlv_data;
917 "The version is %d, and it is invalid\n",
918 *pieces->dbg_dest_ver);
922 if (pieces->dbg_dest_tlv_init) {
924 "dbg destination ignored, already exists\n");
928 pieces->dbg_dest_tlv_init = true;
931 pieces->dbg_dest_tlv_v1 = dest_v1;
932 mon_mode = dest_v1->monitor_mode;
934 pieces->dbg_dest_tlv = dest;
935 mon_mode = dest->monitor_mode;
938 IWL_INFO(drv, "Found debug destination: %s\n",
939 get_fw_dbg_mode_string(mon_mode));
941 drv->fw.dbg.n_dest_reg = (dest_v1) ?
943 offsetof(struct iwl_fw_dbg_dest_tlv_v1,
946 offsetof(struct iwl_fw_dbg_dest_tlv,
949 drv->fw.dbg.n_dest_reg /=
950 sizeof(drv->fw.dbg.dest_tlv->reg_ops[0]);
954 case IWL_UCODE_TLV_FW_DBG_CONF: {
955 struct iwl_fw_dbg_conf_tlv *conf = (void *)tlv_data;
957 if (!pieces->dbg_dest_tlv_init) {
959 "Ignore dbg config %d - no destination configured\n",
964 if (conf->id >= ARRAY_SIZE(drv->fw.dbg.conf_tlv)) {
966 "Skip unknown configuration: %d\n",
971 if (pieces->dbg_conf_tlv[conf->id]) {
973 "Ignore duplicate dbg config %d\n",
981 IWL_INFO(drv, "Found debug configuration: %d\n",
984 pieces->dbg_conf_tlv[conf->id] = conf;
985 pieces->dbg_conf_tlv_len[conf->id] = tlv_len;
988 case IWL_UCODE_TLV_FW_DBG_TRIGGER: {
989 struct iwl_fw_dbg_trigger_tlv *trigger =
991 u32 trigger_id = le32_to_cpu(trigger->id);
993 if (trigger_id >= ARRAY_SIZE(drv->fw.dbg.trigger_tlv)) {
995 "Skip unknown trigger: %u\n",
1000 if (pieces->dbg_trigger_tlv[trigger_id]) {
1002 "Ignore duplicate dbg trigger %u\n",
1007 IWL_INFO(drv, "Found debug trigger: %u\n", trigger->id);
1009 pieces->dbg_trigger_tlv[trigger_id] = trigger;
1010 pieces->dbg_trigger_tlv_len[trigger_id] = tlv_len;
1013 case IWL_UCODE_TLV_FW_DBG_DUMP_LST: {
1014 if (tlv_len != sizeof(u32)) {
1016 "dbg lst mask size incorrect, skip\n");
1020 drv->fw.dbg.dump_mask =
1021 le32_to_cpup((__le32 *)tlv_data);
1024 case IWL_UCODE_TLV_SEC_RT_USNIFFER:
1025 *usniffer_images = true;
1026 iwl_store_ucode_sec(pieces, tlv_data,
1027 IWL_UCODE_REGULAR_USNIFFER,
1030 case IWL_UCODE_TLV_PAGING:
1031 if (tlv_len != sizeof(u32))
1032 goto invalid_tlv_len;
1033 paging_mem_size = le32_to_cpup((__le32 *)tlv_data);
1036 "Paging: paging enabled (size = %u bytes)\n",
1039 if (paging_mem_size > MAX_PAGING_IMAGE_SIZE) {
1041 "Paging: driver supports up to %lu bytes for paging image\n",
1042 MAX_PAGING_IMAGE_SIZE);
1046 if (paging_mem_size & (FW_PAGING_SIZE - 1)) {
1048 "Paging: image isn't multiple %lu\n",
1053 drv->fw.img[IWL_UCODE_REGULAR].paging_mem_size =
1055 usniffer_img = IWL_UCODE_REGULAR_USNIFFER;
1056 drv->fw.img[usniffer_img].paging_mem_size =
1059 case IWL_UCODE_TLV_FW_GSCAN_CAPA:
1062 case IWL_UCODE_TLV_FW_MEM_SEG: {
1063 struct iwl_fw_dbg_mem_seg_tlv *dbg_mem =
1066 struct iwl_fw_dbg_mem_seg_tlv *n;
1068 if (tlv_len != (sizeof(*dbg_mem)))
1069 goto invalid_tlv_len;
1071 IWL_DEBUG_INFO(drv, "Found debug memory segment: %u\n",
1072 dbg_mem->data_type);
1074 size = sizeof(*pieces->dbg_mem_tlv) *
1075 (pieces->n_mem_tlv + 1);
1076 n = krealloc(pieces->dbg_mem_tlv, size, GFP_KERNEL);
1079 pieces->dbg_mem_tlv = n;
1080 pieces->dbg_mem_tlv[pieces->n_mem_tlv] = *dbg_mem;
1081 pieces->n_mem_tlv++;
1084 case IWL_UCODE_TLV_IML: {
1085 drv->fw.iml_len = tlv_len;
1086 drv->fw.iml = kmemdup(tlv_data, tlv_len, GFP_KERNEL);
1091 case IWL_UCODE_TLV_FW_RECOVERY_INFO: {
1095 } *recov_info = (void *)tlv_data;
1097 if (tlv_len != sizeof(*recov_info))
1098 goto invalid_tlv_len;
1099 capa->error_log_addr =
1100 le32_to_cpu(recov_info->buf_addr);
1101 capa->error_log_size =
1102 le32_to_cpu(recov_info->buf_size);
1105 case IWL_UCODE_TLV_FW_FSEQ_VERSION: {
1109 } *fseq_ver = (void *)tlv_data;
1111 if (tlv_len != sizeof(*fseq_ver))
1112 goto invalid_tlv_len;
1113 IWL_INFO(drv, "TLV_FW_FSEQ_VERSION: %s\n",
1117 case IWL_UCODE_TLV_UMAC_DEBUG_ADDRS: {
1118 struct iwl_umac_debug_addrs *dbg_ptrs =
1121 if (tlv_len != sizeof(*dbg_ptrs))
1122 goto invalid_tlv_len;
1123 if (drv->trans->trans_cfg->device_family <
1124 IWL_DEVICE_FAMILY_22000)
1126 drv->trans->dbg.umac_error_event_table =
1127 le32_to_cpu(dbg_ptrs->error_info_addr) &
1128 ~FW_ADDR_CACHE_CONTROL;
1129 drv->trans->dbg.error_event_table_tlv_status |=
1130 IWL_ERROR_EVENT_TABLE_UMAC;
1133 case IWL_UCODE_TLV_LMAC_DEBUG_ADDRS: {
1134 struct iwl_lmac_debug_addrs *dbg_ptrs =
1137 if (tlv_len != sizeof(*dbg_ptrs))
1138 goto invalid_tlv_len;
1139 if (drv->trans->trans_cfg->device_family <
1140 IWL_DEVICE_FAMILY_22000)
1142 drv->trans->dbg.lmac_error_event_table[0] =
1143 le32_to_cpu(dbg_ptrs->error_event_table_ptr) &
1144 ~FW_ADDR_CACHE_CONTROL;
1145 drv->trans->dbg.error_event_table_tlv_status |=
1146 IWL_ERROR_EVENT_TABLE_LMAC1;
1149 case IWL_UCODE_TLV_TYPE_DEBUG_INFO:
1150 case IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION:
1151 case IWL_UCODE_TLV_TYPE_HCMD:
1152 case IWL_UCODE_TLV_TYPE_REGIONS:
1153 case IWL_UCODE_TLV_TYPE_TRIGGERS:
1154 if (iwlwifi_mod_params.enable_ini)
1155 iwl_dbg_tlv_alloc(drv->trans, tlv, false);
1157 case IWL_UCODE_TLV_CMD_VERSIONS:
1158 if (tlv_len % sizeof(struct iwl_fw_cmd_version)) {
1160 "Invalid length for command versions: %u\n",
1162 tlv_len /= sizeof(struct iwl_fw_cmd_version);
1163 tlv_len *= sizeof(struct iwl_fw_cmd_version);
1165 if (WARN_ON(capa->cmd_versions))
1167 capa->cmd_versions = kmemdup(tlv_data, tlv_len,
1169 if (!capa->cmd_versions)
1171 capa->n_cmd_versions =
1172 tlv_len / sizeof(struct iwl_fw_cmd_version);
1175 IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
1180 if (!fw_has_capa(capa, IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED) &&
1181 usniffer_req && !*usniffer_images) {
1183 "user selected to work with usniffer but usniffer image isn't available in ucode package\n");
1188 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
1189 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
1196 IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
1198 iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
1203 static int iwl_alloc_ucode(struct iwl_drv *drv,
1204 struct iwl_firmware_pieces *pieces,
1205 enum iwl_ucode_type type)
1208 struct fw_desc *sec;
1210 sec = kcalloc(pieces->img[type].sec_counter, sizeof(*sec), GFP_KERNEL);
1213 drv->fw.img[type].sec = sec;
1214 drv->fw.img[type].num_sec = pieces->img[type].sec_counter;
1216 for (i = 0; i < pieces->img[type].sec_counter; i++)
1217 if (iwl_alloc_fw_desc(drv, &sec[i], get_sec(pieces, type, i)))
1223 static int validate_sec_sizes(struct iwl_drv *drv,
1224 struct iwl_firmware_pieces *pieces,
1225 const struct iwl_cfg *cfg)
1227 IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %zd\n",
1228 get_sec_size(pieces, IWL_UCODE_REGULAR,
1229 IWL_UCODE_SECTION_INST));
1230 IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %zd\n",
1231 get_sec_size(pieces, IWL_UCODE_REGULAR,
1232 IWL_UCODE_SECTION_DATA));
1233 IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %zd\n",
1234 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
1235 IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %zd\n",
1236 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
1238 /* Verify that uCode images will fit in card's SRAM. */
1239 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
1240 cfg->max_inst_size) {
1241 IWL_ERR(drv, "uCode instr len %zd too large to fit in\n",
1242 get_sec_size(pieces, IWL_UCODE_REGULAR,
1243 IWL_UCODE_SECTION_INST));
1247 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
1248 cfg->max_data_size) {
1249 IWL_ERR(drv, "uCode data len %zd too large to fit in\n",
1250 get_sec_size(pieces, IWL_UCODE_REGULAR,
1251 IWL_UCODE_SECTION_DATA));
1255 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
1256 cfg->max_inst_size) {
1257 IWL_ERR(drv, "uCode init instr len %zd too large to fit in\n",
1258 get_sec_size(pieces, IWL_UCODE_INIT,
1259 IWL_UCODE_SECTION_INST));
1263 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
1264 cfg->max_data_size) {
1265 IWL_ERR(drv, "uCode init data len %zd too large to fit in\n",
1266 get_sec_size(pieces, IWL_UCODE_REGULAR,
1267 IWL_UCODE_SECTION_DATA));
1273 static struct iwl_op_mode *
1274 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
1276 const struct iwl_op_mode_ops *ops = op->ops;
1277 struct dentry *dbgfs_dir = NULL;
1278 struct iwl_op_mode *op_mode = NULL;
1280 #ifdef CONFIG_IWLWIFI_DEBUGFS
1281 drv->dbgfs_op_mode = debugfs_create_dir(op->name,
1283 dbgfs_dir = drv->dbgfs_op_mode;
1286 op_mode = ops->start(drv->trans, drv->trans->cfg, &drv->fw, dbgfs_dir);
1288 #ifdef CONFIG_IWLWIFI_DEBUGFS
1290 debugfs_remove_recursive(drv->dbgfs_op_mode);
1291 drv->dbgfs_op_mode = NULL;
1298 static void _iwl_op_mode_stop(struct iwl_drv *drv)
1300 /* op_mode can be NULL if its start failed */
1302 iwl_op_mode_stop(drv->op_mode);
1303 drv->op_mode = NULL;
1305 #ifdef CONFIG_IWLWIFI_DEBUGFS
1306 debugfs_remove_recursive(drv->dbgfs_op_mode);
1307 drv->dbgfs_op_mode = NULL;
1313 * iwl_req_fw_callback - callback when firmware was loaded
1315 * If loaded successfully, copies the firmware into buffers
1316 * for the card to fetch (via DMA).
1318 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
1320 struct iwl_drv *drv = context;
1321 struct iwl_fw *fw = &drv->fw;
1322 struct iwl_ucode_header *ucode;
1323 struct iwlwifi_opmode_table *op;
1325 struct iwl_firmware_pieces *pieces;
1326 const unsigned int api_max = drv->trans->cfg->ucode_api_max;
1327 const unsigned int api_min = drv->trans->cfg->ucode_api_min;
1328 size_t trigger_tlv_sz[FW_DBG_TRIGGER_MAX];
1331 bool load_module = false;
1332 bool usniffer_images = false;
1334 fw->ucode_capa.max_probe_length = IWL_DEFAULT_MAX_PROBE_LENGTH;
1335 fw->ucode_capa.standard_phy_calibration_size =
1336 IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1337 fw->ucode_capa.n_scan_channels = IWL_DEFAULT_SCAN_CHANNELS;
1338 /* dump all fw memory areas by default */
1339 fw->dbg.dump_mask = 0xffffffff;
1341 pieces = kzalloc(sizeof(*pieces), GFP_KERNEL);
1348 IWL_DEBUG_FW_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
1349 drv->firmware_name, ucode_raw->size);
1351 /* Make sure that we got at least the API version number */
1352 if (ucode_raw->size < 4) {
1353 IWL_ERR(drv, "File size way too small!\n");
1357 /* Data from ucode file: header followed by uCode images */
1358 ucode = (struct iwl_ucode_header *)ucode_raw->data;
1361 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, pieces);
1363 err = iwl_parse_tlv_firmware(drv, ucode_raw, pieces,
1364 &fw->ucode_capa, &usniffer_images);
1369 if (fw_has_api(&drv->fw.ucode_capa, IWL_UCODE_TLV_API_NEW_VERSION))
1370 api_ver = drv->fw.ucode_ver;
1372 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
1375 * api_ver should match the api version forming part of the
1376 * firmware filename ... but we don't check for that and only rely
1377 * on the API version read from firmware header from here on forward
1379 if (api_ver < api_min || api_ver > api_max) {
1381 "Driver unable to support your firmware API. "
1382 "Driver supports v%u, firmware is v%u.\n",
1388 * In mvm uCode there is no difference between data and instructions
1391 if (fw->type == IWL_FW_DVM && validate_sec_sizes(drv, pieces,
1395 /* Allocate ucode buffers for card's bus-master loading ... */
1397 /* Runtime instructions and 2 copies of data:
1398 * 1) unmodified from disk
1399 * 2) backup cache for save/restore during power-downs
1401 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
1402 if (iwl_alloc_ucode(drv, pieces, i))
1405 if (pieces->dbg_dest_tlv_init) {
1406 size_t dbg_dest_size = sizeof(*drv->fw.dbg.dest_tlv) +
1407 sizeof(drv->fw.dbg.dest_tlv->reg_ops[0]) *
1408 drv->fw.dbg.n_dest_reg;
1410 drv->fw.dbg.dest_tlv = kmalloc(dbg_dest_size, GFP_KERNEL);
1412 if (!drv->fw.dbg.dest_tlv)
1415 if (*pieces->dbg_dest_ver == 0) {
1416 memcpy(drv->fw.dbg.dest_tlv, pieces->dbg_dest_tlv_v1,
1419 struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv =
1420 drv->fw.dbg.dest_tlv;
1422 dest_tlv->version = pieces->dbg_dest_tlv->version;
1423 dest_tlv->monitor_mode =
1424 pieces->dbg_dest_tlv->monitor_mode;
1425 dest_tlv->size_power =
1426 pieces->dbg_dest_tlv->size_power;
1427 dest_tlv->wrap_count =
1428 pieces->dbg_dest_tlv->wrap_count;
1429 dest_tlv->write_ptr_reg =
1430 pieces->dbg_dest_tlv->write_ptr_reg;
1431 dest_tlv->base_shift =
1432 pieces->dbg_dest_tlv->base_shift;
1433 memcpy(dest_tlv->reg_ops,
1434 pieces->dbg_dest_tlv->reg_ops,
1435 sizeof(drv->fw.dbg.dest_tlv->reg_ops[0]) *
1436 drv->fw.dbg.n_dest_reg);
1438 /* In version 1 of the destination tlv, which is
1439 * relevant for internal buffer exclusively,
1440 * the base address is part of given with the length
1441 * of the buffer, and the size shift is give instead of
1442 * end shift. We now store these values in base_reg,
1443 * and end shift, and when dumping the data we'll
1444 * manipulate it for extracting both the length and
1446 dest_tlv->base_reg = pieces->dbg_dest_tlv->cfg_reg;
1447 dest_tlv->end_shift =
1448 pieces->dbg_dest_tlv->size_shift;
1452 for (i = 0; i < ARRAY_SIZE(drv->fw.dbg.conf_tlv); i++) {
1453 if (pieces->dbg_conf_tlv[i]) {
1454 drv->fw.dbg.conf_tlv[i] =
1455 kmemdup(pieces->dbg_conf_tlv[i],
1456 pieces->dbg_conf_tlv_len[i],
1458 if (!pieces->dbg_conf_tlv_len[i])
1463 memset(&trigger_tlv_sz, 0xff, sizeof(trigger_tlv_sz));
1465 trigger_tlv_sz[FW_DBG_TRIGGER_MISSED_BEACONS] =
1466 sizeof(struct iwl_fw_dbg_trigger_missed_bcon);
1467 trigger_tlv_sz[FW_DBG_TRIGGER_CHANNEL_SWITCH] = 0;
1468 trigger_tlv_sz[FW_DBG_TRIGGER_FW_NOTIF] =
1469 sizeof(struct iwl_fw_dbg_trigger_cmd);
1470 trigger_tlv_sz[FW_DBG_TRIGGER_MLME] =
1471 sizeof(struct iwl_fw_dbg_trigger_mlme);
1472 trigger_tlv_sz[FW_DBG_TRIGGER_STATS] =
1473 sizeof(struct iwl_fw_dbg_trigger_stats);
1474 trigger_tlv_sz[FW_DBG_TRIGGER_RSSI] =
1475 sizeof(struct iwl_fw_dbg_trigger_low_rssi);
1476 trigger_tlv_sz[FW_DBG_TRIGGER_TXQ_TIMERS] =
1477 sizeof(struct iwl_fw_dbg_trigger_txq_timer);
1478 trigger_tlv_sz[FW_DBG_TRIGGER_TIME_EVENT] =
1479 sizeof(struct iwl_fw_dbg_trigger_time_event);
1480 trigger_tlv_sz[FW_DBG_TRIGGER_BA] =
1481 sizeof(struct iwl_fw_dbg_trigger_ba);
1482 trigger_tlv_sz[FW_DBG_TRIGGER_TDLS] =
1483 sizeof(struct iwl_fw_dbg_trigger_tdls);
1485 for (i = 0; i < ARRAY_SIZE(drv->fw.dbg.trigger_tlv); i++) {
1486 if (pieces->dbg_trigger_tlv[i]) {
1488 * If the trigger isn't long enough, WARN and exit.
1489 * Someone is trying to debug something and he won't
1490 * be able to catch the bug he is trying to chase.
1491 * We'd better be noisy to be sure he knows what's
1494 if (WARN_ON(pieces->dbg_trigger_tlv_len[i] <
1495 (trigger_tlv_sz[i] +
1496 sizeof(struct iwl_fw_dbg_trigger_tlv))))
1498 drv->fw.dbg.trigger_tlv_len[i] =
1499 pieces->dbg_trigger_tlv_len[i];
1500 drv->fw.dbg.trigger_tlv[i] =
1501 kmemdup(pieces->dbg_trigger_tlv[i],
1502 drv->fw.dbg.trigger_tlv_len[i],
1504 if (!drv->fw.dbg.trigger_tlv[i])
1509 /* Now that we can no longer fail, copy information */
1511 drv->fw.dbg.mem_tlv = pieces->dbg_mem_tlv;
1512 pieces->dbg_mem_tlv = NULL;
1513 drv->fw.dbg.n_mem_tlv = pieces->n_mem_tlv;
1516 * The (size - 16) / 12 formula is based on the information recorded
1517 * for each event, which is of mode 1 (including timestamp) for all
1518 * new microcodes that include this information.
1520 fw->init_evtlog_ptr = pieces->init_evtlog_ptr;
1521 if (pieces->init_evtlog_size)
1522 fw->init_evtlog_size = (pieces->init_evtlog_size - 16)/12;
1524 fw->init_evtlog_size =
1525 drv->trans->trans_cfg->base_params->max_event_log_size;
1526 fw->init_errlog_ptr = pieces->init_errlog_ptr;
1527 fw->inst_evtlog_ptr = pieces->inst_evtlog_ptr;
1528 if (pieces->inst_evtlog_size)
1529 fw->inst_evtlog_size = (pieces->inst_evtlog_size - 16)/12;
1531 fw->inst_evtlog_size =
1532 drv->trans->trans_cfg->base_params->max_event_log_size;
1533 fw->inst_errlog_ptr = pieces->inst_errlog_ptr;
1536 * figure out the offset of chain noise reset and gain commands
1537 * base on the size of standard phy calibration commands table size
1539 if (fw->ucode_capa.standard_phy_calibration_size >
1540 IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
1541 fw->ucode_capa.standard_phy_calibration_size =
1542 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1544 /* We have our copies now, allow OS release its copies */
1545 release_firmware(ucode_raw);
1547 mutex_lock(&iwlwifi_opmode_table_mtx);
1550 op = &iwlwifi_opmode_table[DVM_OP_MODE];
1553 WARN(1, "Invalid fw type %d\n", fw->type);
1556 op = &iwlwifi_opmode_table[MVM_OP_MODE];
1560 IWL_INFO(drv, "loaded firmware version %s op_mode %s\n",
1561 drv->fw.fw_version, op->name);
1563 /* add this device to the list of devices using this op_mode */
1564 list_add_tail(&drv->list, &op->drv);
1567 drv->op_mode = _iwl_op_mode_start(drv, op);
1569 if (!drv->op_mode) {
1570 mutex_unlock(&iwlwifi_opmode_table_mtx);
1576 mutex_unlock(&iwlwifi_opmode_table_mtx);
1579 * Complete the firmware request last so that
1580 * a driver unbind (stop) doesn't run while we
1581 * are doing the start() above.
1583 complete(&drv->request_firmware_complete);
1586 * Load the module last so we don't block anything
1587 * else from proceeding if the module fails to load
1591 request_module("%s", op->name);
1592 #ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
1595 "failed to load module %s (error %d), is dynamic loading enabled?\n",
1602 /* try next, if any */
1603 release_firmware(ucode_raw);
1604 if (iwl_request_firmware(drv, false))
1609 release_firmware(ucode_raw);
1611 complete(&drv->request_firmware_complete);
1612 device_release_driver(drv->trans->dev);
1615 for (i = 0; i < ARRAY_SIZE(pieces->img); i++)
1616 kfree(pieces->img[i].sec);
1617 kfree(pieces->dbg_mem_tlv);
1622 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans)
1624 struct iwl_drv *drv;
1627 drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1634 drv->dev = trans->dev;
1636 init_completion(&drv->request_firmware_complete);
1637 INIT_LIST_HEAD(&drv->list);
1639 iwl_dbg_tlv_load_bin(drv->trans->dev, drv->trans);
1641 #ifdef CONFIG_IWLWIFI_DEBUGFS
1642 /* Create the device debugfs entries. */
1643 drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1646 /* Create transport layer debugfs dir */
1647 drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1650 ret = iwl_request_firmware(drv, true);
1652 IWL_ERR(trans, "Couldn't request the fw\n");
1659 #ifdef CONFIG_IWLWIFI_DEBUGFS
1660 debugfs_remove_recursive(drv->dbgfs_drv);
1661 iwl_dbg_tlv_free(drv->trans);
1665 return ERR_PTR(ret);
1668 void iwl_drv_stop(struct iwl_drv *drv)
1670 wait_for_completion(&drv->request_firmware_complete);
1672 _iwl_op_mode_stop(drv);
1674 iwl_dealloc_ucode(drv);
1676 mutex_lock(&iwlwifi_opmode_table_mtx);
1678 * List is empty (this item wasn't added)
1679 * when firmware loading failed -- in that
1680 * case we can't remove it from any list.
1682 if (!list_empty(&drv->list))
1683 list_del(&drv->list);
1684 mutex_unlock(&iwlwifi_opmode_table_mtx);
1686 #ifdef CONFIG_IWLWIFI_DEBUGFS
1687 drv->trans->ops->debugfs_cleanup(drv->trans);
1689 debugfs_remove_recursive(drv->dbgfs_drv);
1692 iwl_dbg_tlv_free(drv->trans);
1698 /* shared module parameters */
1699 struct iwl_mod_params iwlwifi_mod_params = {
1701 .bt_coex_active = true,
1702 .power_level = IWL_POWER_INDEX_1,
1703 .uapsd_disable = IWL_DISABLE_UAPSD_BSS | IWL_DISABLE_UAPSD_P2P_CLIENT,
1704 /* the rest are 0 by default */
1706 IWL_EXPORT_SYMBOL(iwlwifi_mod_params);
1708 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
1711 struct iwl_drv *drv;
1712 struct iwlwifi_opmode_table *op;
1714 mutex_lock(&iwlwifi_opmode_table_mtx);
1715 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1716 op = &iwlwifi_opmode_table[i];
1717 if (strcmp(op->name, name))
1720 /* TODO: need to handle exceptional case */
1721 list_for_each_entry(drv, &op->drv, list)
1722 drv->op_mode = _iwl_op_mode_start(drv, op);
1724 mutex_unlock(&iwlwifi_opmode_table_mtx);
1727 mutex_unlock(&iwlwifi_opmode_table_mtx);
1730 IWL_EXPORT_SYMBOL(iwl_opmode_register);
1732 void iwl_opmode_deregister(const char *name)
1735 struct iwl_drv *drv;
1737 mutex_lock(&iwlwifi_opmode_table_mtx);
1738 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1739 if (strcmp(iwlwifi_opmode_table[i].name, name))
1741 iwlwifi_opmode_table[i].ops = NULL;
1743 /* call the stop routine for all devices */
1744 list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
1745 _iwl_op_mode_stop(drv);
1747 mutex_unlock(&iwlwifi_opmode_table_mtx);
1750 mutex_unlock(&iwlwifi_opmode_table_mtx);
1752 IWL_EXPORT_SYMBOL(iwl_opmode_deregister);
1754 static int __init iwl_drv_init(void)
1758 mutex_init(&iwlwifi_opmode_table_mtx);
1760 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
1761 INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
1763 pr_info(DRV_DESCRIPTION "\n");
1764 pr_info(DRV_COPYRIGHT "\n");
1766 #ifdef CONFIG_IWLWIFI_DEBUGFS
1767 /* Create the root of iwlwifi debugfs subsystem. */
1768 iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
1771 err = iwl_pci_register_driver();
1773 goto cleanup_debugfs;
1778 #ifdef CONFIG_IWLWIFI_DEBUGFS
1779 debugfs_remove_recursive(iwl_dbgfs_root);
1783 module_init(iwl_drv_init);
1785 static void __exit iwl_drv_exit(void)
1787 iwl_pci_unregister_driver();
1789 #ifdef CONFIG_IWLWIFI_DEBUGFS
1790 debugfs_remove_recursive(iwl_dbgfs_root);
1793 module_exit(iwl_drv_exit);
1795 #ifdef CONFIG_IWLWIFI_DEBUG
1796 module_param_named(debug, iwlwifi_mod_params.debug_level, uint, 0644);
1797 MODULE_PARM_DESC(debug, "debug output mask");
1800 module_param_named(swcrypto, iwlwifi_mod_params.swcrypto, int, 0444);
1801 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
1802 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, 0444);
1803 MODULE_PARM_DESC(11n_disable,
1804 "disable 11n functionality, bitmap: 1: full, 2: disable agg TX, 4: disable agg RX, 8 enable agg TX");
1805 module_param_named(amsdu_size, iwlwifi_mod_params.amsdu_size, int, 0444);
1806 MODULE_PARM_DESC(amsdu_size,
1807 "amsdu size 0: 12K for multi Rx queue devices, 2K for 22560 devices, "
1808 "4K for other devices 1:4K 2:8K 3:12K 4: 2K (default 0)");
1809 module_param_named(fw_restart, iwlwifi_mod_params.fw_restart, bool, 0444);
1810 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error (default true)");
1812 module_param_named(antenna_coupling, iwlwifi_mod_params.antenna_coupling,
1814 MODULE_PARM_DESC(antenna_coupling,
1815 "specify antenna coupling in dB (default: 0 dB)");
1817 module_param_named(nvm_file, iwlwifi_mod_params.nvm_file, charp, 0444);
1818 MODULE_PARM_DESC(nvm_file, "NVM file name");
1820 module_param_named(lar_disable, iwlwifi_mod_params.lar_disable, bool, 0444);
1821 MODULE_PARM_DESC(lar_disable, "disable LAR functionality (default: N)");
1823 module_param_named(uapsd_disable, iwlwifi_mod_params.uapsd_disable, uint, 0644);
1824 MODULE_PARM_DESC(uapsd_disable,
1825 "disable U-APSD functionality bitmap 1: BSS 2: P2P Client (default: 3)");
1826 module_param_named(enable_ini, iwlwifi_mod_params.enable_ini,
1827 bool, S_IRUGO | S_IWUSR);
1828 MODULE_PARM_DESC(enable_ini,
1829 "Enable debug INI TLV FW debug infrastructure (default: 0");
1832 * set bt_coex_active to true, uCode will do kill/defer
1833 * every time the priority line is asserted (BT is sending signals on the
1834 * priority line in the PCIx).
1835 * set bt_coex_active to false, uCode will ignore the BT activity and
1836 * perform the normal operation
1838 * User might experience transmit issue on some platform due to WiFi/BT
1839 * co-exist problem. The possible behaviors are:
1840 * Able to scan and finding all the available AP
1841 * Not able to associate with any AP
1842 * On those platforms, WiFi communication can be restored by set
1843 * "bt_coex_active" module parameter to "false"
1845 * default: bt_coex_active = true (BT_COEX_ENABLE)
1847 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1849 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1851 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, 0444);
1852 MODULE_PARM_DESC(led_mode, "0=system default, "
1853 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1855 module_param_named(power_save, iwlwifi_mod_params.power_save, bool, 0444);
1856 MODULE_PARM_DESC(power_save,
1857 "enable WiFi power management (default: disable)");
1859 module_param_named(power_level, iwlwifi_mod_params.power_level, int, 0444);
1860 MODULE_PARM_DESC(power_level,
1861 "default power save level (range from 1 - 5, default: 1)");
1863 module_param_named(fw_monitor, iwlwifi_mod_params.fw_monitor, bool, 0444);
1864 MODULE_PARM_DESC(fw_monitor,
1865 "firmware monitor - to debug FW (default: false - needs lots of memory)");
1867 module_param_named(disable_11ac, iwlwifi_mod_params.disable_11ac, bool, 0444);
1868 MODULE_PARM_DESC(disable_11ac, "Disable VHT capabilities (default: false)");
1870 module_param_named(remove_when_gone,
1871 iwlwifi_mod_params.remove_when_gone, bool,
1873 MODULE_PARM_DESC(remove_when_gone,
1874 "Remove dev from PCIe bus if it is deemed inaccessible (default: false)");
1876 module_param_named(disable_11ax, iwlwifi_mod_params.disable_11ax, bool,
1878 MODULE_PARM_DESC(disable_11ax, "Disable HE capabilities (default: false)");