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 COPYING.
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;
488 if (len < sizeof(*ucode)) {
489 IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
493 if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
494 IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
495 le32_to_cpu(ucode->magic));
499 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
500 build = le32_to_cpu(ucode->build);
503 sprintf(buildstr, " build %u%s", build,
504 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
509 snprintf(drv->fw.fw_version,
510 sizeof(drv->fw.fw_version),
512 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
513 IWL_UCODE_MINOR(drv->fw.ucode_ver),
514 IWL_UCODE_API(drv->fw.ucode_ver),
515 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
520 len -= sizeof(*ucode);
522 while (len >= sizeof(*tlv)) {
526 tlv_len = le32_to_cpu(tlv->length);
527 tlv_type = le32_to_cpu(tlv->type);
528 tlv_data = tlv->data;
531 IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
535 len -= ALIGN(tlv_len, 4);
536 data += sizeof(*tlv) + ALIGN(tlv_len, 4);
539 case IWL_UCODE_TLV_INST:
540 set_sec_data(pieces, IWL_UCODE_REGULAR,
541 IWL_UCODE_SECTION_INST, tlv_data);
542 set_sec_size(pieces, IWL_UCODE_REGULAR,
543 IWL_UCODE_SECTION_INST, tlv_len);
544 set_sec_offset(pieces, IWL_UCODE_REGULAR,
545 IWL_UCODE_SECTION_INST,
546 IWLAGN_RTC_INST_LOWER_BOUND);
548 case IWL_UCODE_TLV_DATA:
549 set_sec_data(pieces, IWL_UCODE_REGULAR,
550 IWL_UCODE_SECTION_DATA, tlv_data);
551 set_sec_size(pieces, IWL_UCODE_REGULAR,
552 IWL_UCODE_SECTION_DATA, tlv_len);
553 set_sec_offset(pieces, IWL_UCODE_REGULAR,
554 IWL_UCODE_SECTION_DATA,
555 IWLAGN_RTC_DATA_LOWER_BOUND);
557 case IWL_UCODE_TLV_INIT:
558 set_sec_data(pieces, IWL_UCODE_INIT,
559 IWL_UCODE_SECTION_INST, tlv_data);
560 set_sec_size(pieces, IWL_UCODE_INIT,
561 IWL_UCODE_SECTION_INST, tlv_len);
562 set_sec_offset(pieces, IWL_UCODE_INIT,
563 IWL_UCODE_SECTION_INST,
564 IWLAGN_RTC_INST_LOWER_BOUND);
566 case IWL_UCODE_TLV_INIT_DATA:
567 set_sec_data(pieces, IWL_UCODE_INIT,
568 IWL_UCODE_SECTION_DATA, tlv_data);
569 set_sec_size(pieces, IWL_UCODE_INIT,
570 IWL_UCODE_SECTION_DATA, tlv_len);
571 set_sec_offset(pieces, IWL_UCODE_INIT,
572 IWL_UCODE_SECTION_DATA,
573 IWLAGN_RTC_DATA_LOWER_BOUND);
575 case IWL_UCODE_TLV_BOOT:
576 IWL_ERR(drv, "Found unexpected BOOT ucode\n");
578 case IWL_UCODE_TLV_PROBE_MAX_LEN:
579 if (tlv_len != sizeof(u32))
580 goto invalid_tlv_len;
581 capa->max_probe_length =
582 le32_to_cpup((__le32 *)tlv_data);
584 case IWL_UCODE_TLV_PAN:
586 goto invalid_tlv_len;
587 capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
589 case IWL_UCODE_TLV_FLAGS:
590 /* must be at least one u32 */
591 if (tlv_len < sizeof(u32))
592 goto invalid_tlv_len;
593 /* and a proper number of u32s */
594 if (tlv_len % sizeof(u32))
595 goto invalid_tlv_len;
597 * This driver only reads the first u32 as
598 * right now no more features are defined,
599 * if that changes then either the driver
600 * will not work with the new firmware, or
601 * it'll not take advantage of new features.
603 capa->flags = le32_to_cpup((__le32 *)tlv_data);
605 case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
606 if (tlv_len != sizeof(u32))
607 goto invalid_tlv_len;
608 pieces->init_evtlog_ptr =
609 le32_to_cpup((__le32 *)tlv_data);
611 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
612 if (tlv_len != sizeof(u32))
613 goto invalid_tlv_len;
614 pieces->init_evtlog_size =
615 le32_to_cpup((__le32 *)tlv_data);
617 case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
618 if (tlv_len != sizeof(u32))
619 goto invalid_tlv_len;
620 pieces->init_errlog_ptr =
621 le32_to_cpup((__le32 *)tlv_data);
623 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
624 if (tlv_len != sizeof(u32))
625 goto invalid_tlv_len;
626 pieces->inst_evtlog_ptr =
627 le32_to_cpup((__le32 *)tlv_data);
629 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
630 if (tlv_len != sizeof(u32))
631 goto invalid_tlv_len;
632 pieces->inst_evtlog_size =
633 le32_to_cpup((__le32 *)tlv_data);
635 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
636 if (tlv_len != sizeof(u32))
637 goto invalid_tlv_len;
638 pieces->inst_errlog_ptr =
639 le32_to_cpup((__le32 *)tlv_data);
641 case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
643 goto invalid_tlv_len;
644 drv->fw.enhance_sensitivity_table = true;
646 case IWL_UCODE_TLV_WOWLAN_INST:
647 set_sec_data(pieces, IWL_UCODE_WOWLAN,
648 IWL_UCODE_SECTION_INST, tlv_data);
649 set_sec_size(pieces, IWL_UCODE_WOWLAN,
650 IWL_UCODE_SECTION_INST, tlv_len);
651 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
652 IWL_UCODE_SECTION_INST,
653 IWLAGN_RTC_INST_LOWER_BOUND);
655 case IWL_UCODE_TLV_WOWLAN_DATA:
656 set_sec_data(pieces, IWL_UCODE_WOWLAN,
657 IWL_UCODE_SECTION_DATA, tlv_data);
658 set_sec_size(pieces, IWL_UCODE_WOWLAN,
659 IWL_UCODE_SECTION_DATA, tlv_len);
660 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
661 IWL_UCODE_SECTION_DATA,
662 IWLAGN_RTC_DATA_LOWER_BOUND);
664 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
665 if (tlv_len != sizeof(u32))
666 goto invalid_tlv_len;
667 capa->standard_phy_calibration_size =
668 le32_to_cpup((__le32 *)tlv_data);
670 case IWL_UCODE_TLV_SEC_RT:
671 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
673 drv->fw.mvm_fw = true;
675 case IWL_UCODE_TLV_SEC_INIT:
676 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
678 drv->fw.mvm_fw = true;
680 case IWL_UCODE_TLV_SEC_WOWLAN:
681 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
683 drv->fw.mvm_fw = true;
685 case IWL_UCODE_TLV_DEF_CALIB:
686 if (tlv_len != sizeof(struct iwl_tlv_calib_data))
687 goto invalid_tlv_len;
688 if (iwl_set_default_calib(drv, tlv_data))
691 case IWL_UCODE_TLV_PHY_SKU:
692 if (tlv_len != sizeof(u32))
693 goto invalid_tlv_len;
694 drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
696 case IWL_UCODE_TLV_SECURE_SEC_RT:
697 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
699 drv->fw.mvm_fw = true;
700 drv->fw.img[IWL_UCODE_REGULAR].is_secure = true;
702 case IWL_UCODE_TLV_SECURE_SEC_INIT:
703 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
705 drv->fw.mvm_fw = true;
706 drv->fw.img[IWL_UCODE_INIT].is_secure = true;
708 case IWL_UCODE_TLV_SECURE_SEC_WOWLAN:
709 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
711 drv->fw.mvm_fw = true;
712 drv->fw.img[IWL_UCODE_WOWLAN].is_secure = true;
714 case IWL_UCODE_TLV_NUM_OF_CPU:
715 if (tlv_len != sizeof(u32))
716 goto invalid_tlv_len;
718 le32_to_cpup((__le32 *)tlv_data);
720 if (num_of_cpus == 2) {
721 drv->fw.img[IWL_UCODE_REGULAR].is_dual_cpus =
723 drv->fw.img[IWL_UCODE_INIT].is_dual_cpus =
725 drv->fw.img[IWL_UCODE_WOWLAN].is_dual_cpus =
727 } else if ((num_of_cpus > 2) || (num_of_cpus < 1)) {
728 IWL_ERR(drv, "Driver support upto 2 CPUs\n");
733 IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
739 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
740 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
747 IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
749 iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
754 static int iwl_alloc_ucode(struct iwl_drv *drv,
755 struct iwl_firmware_pieces *pieces,
756 enum iwl_ucode_type type)
760 i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
762 if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
763 get_sec(pieces, type, i)))
768 static int validate_sec_sizes(struct iwl_drv *drv,
769 struct iwl_firmware_pieces *pieces,
770 const struct iwl_cfg *cfg)
772 IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
773 get_sec_size(pieces, IWL_UCODE_REGULAR,
774 IWL_UCODE_SECTION_INST));
775 IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
776 get_sec_size(pieces, IWL_UCODE_REGULAR,
777 IWL_UCODE_SECTION_DATA));
778 IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
779 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
780 IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
781 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
783 /* Verify that uCode images will fit in card's SRAM. */
784 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
785 cfg->max_inst_size) {
786 IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
787 get_sec_size(pieces, IWL_UCODE_REGULAR,
788 IWL_UCODE_SECTION_INST));
792 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
793 cfg->max_data_size) {
794 IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
795 get_sec_size(pieces, IWL_UCODE_REGULAR,
796 IWL_UCODE_SECTION_DATA));
800 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
801 cfg->max_inst_size) {
802 IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
803 get_sec_size(pieces, IWL_UCODE_INIT,
804 IWL_UCODE_SECTION_INST));
808 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
809 cfg->max_data_size) {
810 IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
811 get_sec_size(pieces, IWL_UCODE_REGULAR,
812 IWL_UCODE_SECTION_DATA));
818 static struct iwl_op_mode *
819 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
821 const struct iwl_op_mode_ops *ops = op->ops;
822 struct dentry *dbgfs_dir = NULL;
823 struct iwl_op_mode *op_mode = NULL;
825 #ifdef CONFIG_IWLWIFI_DEBUGFS
826 drv->dbgfs_op_mode = debugfs_create_dir(op->name,
828 if (!drv->dbgfs_op_mode) {
830 "failed to create opmode debugfs directory\n");
833 dbgfs_dir = drv->dbgfs_op_mode;
836 op_mode = ops->start(drv->trans, drv->cfg, &drv->fw, dbgfs_dir);
838 #ifdef CONFIG_IWLWIFI_DEBUGFS
840 debugfs_remove_recursive(drv->dbgfs_op_mode);
841 drv->dbgfs_op_mode = NULL;
848 static void _iwl_op_mode_stop(struct iwl_drv *drv)
850 /* op_mode can be NULL if its start failed */
852 iwl_op_mode_stop(drv->op_mode);
855 #ifdef CONFIG_IWLWIFI_DEBUGFS
856 debugfs_remove_recursive(drv->dbgfs_op_mode);
857 drv->dbgfs_op_mode = NULL;
863 * iwl_req_fw_callback - callback when firmware was loaded
865 * If loaded successfully, copies the firmware into buffers
866 * for the card to fetch (via DMA).
868 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
870 struct iwl_drv *drv = context;
871 struct iwl_fw *fw = &drv->fw;
872 struct iwl_ucode_header *ucode;
873 struct iwlwifi_opmode_table *op;
875 struct iwl_firmware_pieces pieces;
876 const unsigned int api_max = drv->cfg->ucode_api_max;
877 unsigned int api_ok = drv->cfg->ucode_api_ok;
878 const unsigned int api_min = drv->cfg->ucode_api_min;
881 bool load_module = false;
883 fw->ucode_capa.max_probe_length = IWL_DEFAULT_MAX_PROBE_LENGTH;
884 fw->ucode_capa.standard_phy_calibration_size =
885 IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
890 memset(&pieces, 0, sizeof(pieces));
893 if (drv->fw_index <= api_ok)
895 "request for firmware file '%s' failed.\n",
900 IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
901 drv->firmware_name, ucode_raw->size);
903 /* Make sure that we got at least the API version number */
904 if (ucode_raw->size < 4) {
905 IWL_ERR(drv, "File size way too small!\n");
909 /* Data from ucode file: header followed by uCode images */
910 ucode = (struct iwl_ucode_header *)ucode_raw->data;
913 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, &pieces);
915 err = iwl_parse_tlv_firmware(drv, ucode_raw, &pieces,
921 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
924 * api_ver should match the api version forming part of the
925 * firmware filename ... but we don't check for that and only rely
926 * on the API version read from firmware header from here on forward
928 /* no api version check required for experimental uCode */
929 if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
930 if (api_ver < api_min || api_ver > api_max) {
932 "Driver unable to support your firmware API. "
933 "Driver supports v%u, firmware is v%u.\n",
938 if (api_ver < api_ok) {
939 if (api_ok != api_max)
940 IWL_ERR(drv, "Firmware has old API version, "
941 "expected v%u through v%u, got v%u.\n",
942 api_ok, api_max, api_ver);
944 IWL_ERR(drv, "Firmware has old API version, "
945 "expected v%u, got v%u.\n",
947 IWL_ERR(drv, "New firmware can be obtained from "
948 "http://www.intellinuxwireless.org/.\n");
953 * In mvm uCode there is no difference between data and instructions
956 if (!fw->mvm_fw && validate_sec_sizes(drv, &pieces, drv->cfg))
959 /* Allocate ucode buffers for card's bus-master loading ... */
961 /* Runtime instructions and 2 copies of data:
962 * 1) unmodified from disk
963 * 2) backup cache for save/restore during power-downs */
964 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
965 if (iwl_alloc_ucode(drv, &pieces, i))
968 /* Now that we can no longer fail, copy information */
971 * The (size - 16) / 12 formula is based on the information recorded
972 * for each event, which is of mode 1 (including timestamp) for all
973 * new microcodes that include this information.
975 fw->init_evtlog_ptr = pieces.init_evtlog_ptr;
976 if (pieces.init_evtlog_size)
977 fw->init_evtlog_size = (pieces.init_evtlog_size - 16)/12;
979 fw->init_evtlog_size =
980 drv->cfg->base_params->max_event_log_size;
981 fw->init_errlog_ptr = pieces.init_errlog_ptr;
982 fw->inst_evtlog_ptr = pieces.inst_evtlog_ptr;
983 if (pieces.inst_evtlog_size)
984 fw->inst_evtlog_size = (pieces.inst_evtlog_size - 16)/12;
986 fw->inst_evtlog_size =
987 drv->cfg->base_params->max_event_log_size;
988 fw->inst_errlog_ptr = pieces.inst_errlog_ptr;
991 * figure out the offset of chain noise reset and gain commands
992 * base on the size of standard phy calibration commands table size
994 if (fw->ucode_capa.standard_phy_calibration_size >
995 IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
996 fw->ucode_capa.standard_phy_calibration_size =
997 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
999 /* We have our copies now, allow OS release its copies */
1000 release_firmware(ucode_raw);
1002 mutex_lock(&iwlwifi_opmode_table_mtx);
1004 op = &iwlwifi_opmode_table[MVM_OP_MODE];
1006 op = &iwlwifi_opmode_table[DVM_OP_MODE];
1008 IWL_INFO(drv, "loaded firmware version %s op_mode %s\n",
1009 drv->fw.fw_version, op->name);
1011 /* add this device to the list of devices using this op_mode */
1012 list_add_tail(&drv->list, &op->drv);
1015 drv->op_mode = _iwl_op_mode_start(drv, op);
1017 if (!drv->op_mode) {
1018 mutex_unlock(&iwlwifi_opmode_table_mtx);
1024 mutex_unlock(&iwlwifi_opmode_table_mtx);
1027 * Complete the firmware request last so that
1028 * a driver unbind (stop) doesn't run while we
1029 * are doing the start() above.
1031 complete(&drv->request_firmware_complete);
1034 * Load the module last so we don't block anything
1035 * else from proceeding if the module fails to load
1039 err = request_module("%s", op->name);
1040 #ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
1043 "failed to load module %s (error %d), is dynamic loading enabled?\n",
1050 /* try next, if any */
1051 release_firmware(ucode_raw);
1052 if (iwl_request_firmware(drv, false))
1057 IWL_ERR(drv, "failed to allocate pci memory\n");
1058 iwl_dealloc_ucode(drv);
1059 release_firmware(ucode_raw);
1061 complete(&drv->request_firmware_complete);
1062 device_release_driver(drv->trans->dev);
1065 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans,
1066 const struct iwl_cfg *cfg)
1068 struct iwl_drv *drv;
1071 drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1078 drv->dev = trans->dev;
1081 init_completion(&drv->request_firmware_complete);
1082 INIT_LIST_HEAD(&drv->list);
1084 #ifdef CONFIG_IWLWIFI_DEBUGFS
1085 /* Create the device debugfs entries. */
1086 drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1089 if (!drv->dbgfs_drv) {
1090 IWL_ERR(drv, "failed to create debugfs directory\n");
1095 /* Create transport layer debugfs dir */
1096 drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1098 if (!drv->trans->dbgfs_dir) {
1099 IWL_ERR(drv, "failed to create transport debugfs directory\n");
1101 goto err_free_dbgfs;
1105 ret = iwl_request_firmware(drv, true);
1107 IWL_ERR(trans, "Couldn't request the fw\n");
1114 #ifdef CONFIG_IWLWIFI_DEBUGFS
1116 debugfs_remove_recursive(drv->dbgfs_drv);
1121 return ERR_PTR(ret);
1124 void iwl_drv_stop(struct iwl_drv *drv)
1126 wait_for_completion(&drv->request_firmware_complete);
1128 _iwl_op_mode_stop(drv);
1130 iwl_dealloc_ucode(drv);
1132 mutex_lock(&iwlwifi_opmode_table_mtx);
1134 * List is empty (this item wasn't added)
1135 * when firmware loading failed -- in that
1136 * case we can't remove it from any list.
1138 if (!list_empty(&drv->list))
1139 list_del(&drv->list);
1140 mutex_unlock(&iwlwifi_opmode_table_mtx);
1142 #ifdef CONFIG_IWLWIFI_DEBUGFS
1143 debugfs_remove_recursive(drv->dbgfs_drv);
1150 /* shared module parameters */
1151 struct iwl_mod_params iwlwifi_mod_params = {
1153 .bt_coex_active = true,
1154 .power_level = IWL_POWER_INDEX_1,
1156 /* the rest are 0 by default */
1158 IWL_EXPORT_SYMBOL(iwlwifi_mod_params);
1160 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
1163 struct iwl_drv *drv;
1164 struct iwlwifi_opmode_table *op;
1166 mutex_lock(&iwlwifi_opmode_table_mtx);
1167 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1168 op = &iwlwifi_opmode_table[i];
1169 if (strcmp(op->name, name))
1172 /* TODO: need to handle exceptional case */
1173 list_for_each_entry(drv, &op->drv, list)
1174 drv->op_mode = _iwl_op_mode_start(drv, op);
1176 mutex_unlock(&iwlwifi_opmode_table_mtx);
1179 mutex_unlock(&iwlwifi_opmode_table_mtx);
1182 IWL_EXPORT_SYMBOL(iwl_opmode_register);
1184 void iwl_opmode_deregister(const char *name)
1187 struct iwl_drv *drv;
1189 mutex_lock(&iwlwifi_opmode_table_mtx);
1190 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1191 if (strcmp(iwlwifi_opmode_table[i].name, name))
1193 iwlwifi_opmode_table[i].ops = NULL;
1195 /* call the stop routine for all devices */
1196 list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
1197 _iwl_op_mode_stop(drv);
1199 mutex_unlock(&iwlwifi_opmode_table_mtx);
1202 mutex_unlock(&iwlwifi_opmode_table_mtx);
1204 IWL_EXPORT_SYMBOL(iwl_opmode_deregister);
1206 static int __init iwl_drv_init(void)
1210 mutex_init(&iwlwifi_opmode_table_mtx);
1212 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
1213 INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
1215 pr_info(DRV_DESCRIPTION ", " DRV_VERSION "\n");
1216 pr_info(DRV_COPYRIGHT "\n");
1218 #ifdef CONFIG_IWLWIFI_DEBUGFS
1219 /* Create the root of iwlwifi debugfs subsystem. */
1220 iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
1222 if (!iwl_dbgfs_root)
1226 return iwl_pci_register_driver();
1228 module_init(iwl_drv_init);
1230 static void __exit iwl_drv_exit(void)
1232 iwl_pci_unregister_driver();
1234 #ifdef CONFIG_IWLWIFI_DEBUGFS
1235 debugfs_remove_recursive(iwl_dbgfs_root);
1238 module_exit(iwl_drv_exit);
1240 #ifdef CONFIG_IWLWIFI_DEBUG
1241 module_param_named(debug, iwlwifi_mod_params.debug_level, uint,
1243 MODULE_PARM_DESC(debug, "debug output mask");
1246 module_param_named(swcrypto, iwlwifi_mod_params.sw_crypto, int, S_IRUGO);
1247 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
1248 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, S_IRUGO);
1249 MODULE_PARM_DESC(11n_disable,
1250 "disable 11n functionality, bitmap: 1: full, 2: agg TX, 4: agg RX");
1251 module_param_named(amsdu_size_8K, iwlwifi_mod_params.amsdu_size_8K,
1253 MODULE_PARM_DESC(amsdu_size_8K, "enable 8K amsdu size (default 0)");
1254 module_param_named(fw_restart, iwlwifi_mod_params.restart_fw, bool, S_IRUGO);
1255 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error (default true)");
1257 module_param_named(antenna_coupling, iwlwifi_mod_params.ant_coupling,
1259 MODULE_PARM_DESC(antenna_coupling,
1260 "specify antenna coupling in dB (defualt: 0 dB)");
1262 module_param_named(wd_disable, iwlwifi_mod_params.wd_disable, int, S_IRUGO);
1263 MODULE_PARM_DESC(wd_disable,
1264 "Disable stuck queue watchdog timer 0=system default, "
1265 "1=disable, 2=enable (default: 0)");
1267 module_param_named(nvm_file, iwlwifi_mod_params.nvm_file, charp, S_IRUGO);
1268 MODULE_PARM_DESC(nvm_file, "NVM file name");
1271 * set bt_coex_active to true, uCode will do kill/defer
1272 * every time the priority line is asserted (BT is sending signals on the
1273 * priority line in the PCIx).
1274 * set bt_coex_active to false, uCode will ignore the BT activity and
1275 * perform the normal operation
1277 * User might experience transmit issue on some platform due to WiFi/BT
1278 * co-exist problem. The possible behaviors are:
1279 * Able to scan and finding all the available AP
1280 * Not able to associate with any AP
1281 * On those platforms, WiFi communication can be restored by set
1282 * "bt_coex_active" module parameter to "false"
1284 * default: bt_coex_active = true (BT_COEX_ENABLE)
1286 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1288 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1290 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, S_IRUGO);
1291 MODULE_PARM_DESC(led_mode, "0=system default, "
1292 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1294 module_param_named(power_save, iwlwifi_mod_params.power_save,
1296 MODULE_PARM_DESC(power_save,
1297 "enable WiFi power management (default: disable)");
1299 module_param_named(power_level, iwlwifi_mod_params.power_level,
1301 MODULE_PARM_DESC(power_level,
1302 "default power save level (range from 1 - 5, default: 1)");