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 - 2012 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 - 2012 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;
142 #define DVM_OP_MODE 0
143 #define MVM_OP_MODE 1
145 /* Protects the table contents, i.e. the ops pointer & drv list */
146 static struct mutex iwlwifi_opmode_table_mtx;
147 static struct iwlwifi_opmode_table {
148 const char *name; /* name: iwldvm, iwlmvm, etc */
149 const struct iwl_op_mode_ops *ops; /* pointer to op_mode ops */
150 struct list_head drv; /* list of devices using this op_mode */
151 } iwlwifi_opmode_table[] = { /* ops set when driver is initialized */
152 { .name = "iwldvm", .ops = NULL },
153 { .name = "iwlmvm", .ops = NULL },
157 * struct fw_sec: Just for the image parsing proccess.
158 * For the fw storage we are using struct fw_desc.
161 const void *data; /* the sec data */
162 size_t size; /* section size */
163 u32 offset; /* offset of writing in the device */
166 static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
173 static void iwl_free_fw_img(struct iwl_drv *drv, struct fw_img *img)
176 for (i = 0; i < IWL_UCODE_SECTION_MAX; i++)
177 iwl_free_fw_desc(drv, &img->sec[i]);
180 static void iwl_dealloc_ucode(struct iwl_drv *drv)
183 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
184 iwl_free_fw_img(drv, drv->fw.img + i);
187 static int iwl_alloc_fw_desc(struct iwl_drv *drv, struct fw_desc *desc,
194 if (!sec || !sec->size)
197 data = vmalloc(sec->size);
201 desc->len = sec->size;
202 desc->offset = sec->offset;
203 memcpy(data, sec->data, desc->len);
209 static void iwl_req_fw_callback(const struct firmware *ucode_raw,
212 #define UCODE_EXPERIMENTAL_INDEX 100
213 #define UCODE_EXPERIMENTAL_TAG "exp"
215 static int iwl_request_firmware(struct iwl_drv *drv, bool first)
217 const char *name_pre = drv->cfg->fw_name_pre;
221 #ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
222 drv->fw_index = UCODE_EXPERIMENTAL_INDEX;
223 strcpy(tag, UCODE_EXPERIMENTAL_TAG);
224 } else if (drv->fw_index == UCODE_EXPERIMENTAL_INDEX) {
226 drv->fw_index = drv->cfg->ucode_api_max;
227 sprintf(tag, "%d", drv->fw_index);
230 sprintf(tag, "%d", drv->fw_index);
233 if (drv->fw_index < drv->cfg->ucode_api_min) {
234 IWL_ERR(drv, "no suitable firmware found!\n");
238 sprintf(drv->firmware_name, "%s%s%s", name_pre, tag, ".ucode");
240 IWL_DEBUG_INFO(drv, "attempting to load firmware %s'%s'\n",
241 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
242 ? "EXPERIMENTAL " : "",
245 return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
247 GFP_KERNEL, drv, iwl_req_fw_callback);
250 struct fw_img_parsing {
251 struct fw_sec sec[IWL_UCODE_SECTION_MAX];
256 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
258 struct fw_sec_parsing {
264 * struct iwl_tlv_calib_data - parse the default calib data from TLV
266 * @ucode_type: the uCode to which the following default calib relates.
267 * @calib: default calibrations.
269 struct iwl_tlv_calib_data {
274 struct iwl_firmware_pieces {
275 struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
277 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
278 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
282 * These functions are just to extract uCode section data from the pieces
285 static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
286 enum iwl_ucode_type type,
289 return &pieces->img[type].sec[sec];
292 static void set_sec_data(struct iwl_firmware_pieces *pieces,
293 enum iwl_ucode_type type,
297 pieces->img[type].sec[sec].data = data;
300 static void set_sec_size(struct iwl_firmware_pieces *pieces,
301 enum iwl_ucode_type type,
305 pieces->img[type].sec[sec].size = size;
308 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
309 enum iwl_ucode_type type,
312 return pieces->img[type].sec[sec].size;
315 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
316 enum iwl_ucode_type type,
320 pieces->img[type].sec[sec].offset = offset;
324 * Gets uCode section from tlv.
326 static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
327 const void *data, enum iwl_ucode_type type,
330 struct fw_img_parsing *img;
332 struct fw_sec_parsing *sec_parse;
334 if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
337 sec_parse = (struct fw_sec_parsing *)data;
339 img = &pieces->img[type];
340 sec = &img->sec[img->sec_counter];
342 sec->offset = le32_to_cpu(sec_parse->offset);
343 sec->data = sec_parse->data;
344 sec->size = size - sizeof(sec_parse->offset);
351 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
353 struct iwl_tlv_calib_data *def_calib =
354 (struct iwl_tlv_calib_data *)data;
355 u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
356 if (ucode_type >= IWL_UCODE_TYPE_MAX) {
357 IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
361 drv->fw.default_calib[ucode_type] = le64_to_cpu(def_calib->calib);
365 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
366 const struct firmware *ucode_raw,
367 struct iwl_firmware_pieces *pieces)
369 struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
370 u32 api_ver, hdr_size, build;
374 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
375 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
380 if (ucode_raw->size < hdr_size) {
381 IWL_ERR(drv, "File size too small!\n");
384 build = le32_to_cpu(ucode->u.v2.build);
385 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
386 le32_to_cpu(ucode->u.v2.inst_size));
387 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
388 le32_to_cpu(ucode->u.v2.data_size));
389 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
390 le32_to_cpu(ucode->u.v2.init_size));
391 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
392 le32_to_cpu(ucode->u.v2.init_data_size));
393 src = ucode->u.v2.data;
399 if (ucode_raw->size < hdr_size) {
400 IWL_ERR(drv, "File size too small!\n");
404 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
405 le32_to_cpu(ucode->u.v1.inst_size));
406 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
407 le32_to_cpu(ucode->u.v1.data_size));
408 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
409 le32_to_cpu(ucode->u.v1.init_size));
410 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
411 le32_to_cpu(ucode->u.v1.init_data_size));
412 src = ucode->u.v1.data;
417 sprintf(buildstr, " build %u%s", build,
418 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
423 snprintf(drv->fw.fw_version,
424 sizeof(drv->fw.fw_version),
426 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
427 IWL_UCODE_MINOR(drv->fw.ucode_ver),
428 IWL_UCODE_API(drv->fw.ucode_ver),
429 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
432 /* Verify size of file vs. image size info in file's header */
434 if (ucode_raw->size != hdr_size +
435 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
436 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
437 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
438 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
441 "uCode file size %d does not match expected size\n",
442 (int)ucode_raw->size);
447 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
448 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
449 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
450 IWLAGN_RTC_INST_LOWER_BOUND);
451 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
452 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
453 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
454 IWLAGN_RTC_DATA_LOWER_BOUND);
455 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
456 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
457 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
458 IWLAGN_RTC_INST_LOWER_BOUND);
459 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
460 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
461 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
462 IWLAGN_RTC_DATA_LOWER_BOUND);
466 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
467 const struct firmware *ucode_raw,
468 struct iwl_firmware_pieces *pieces,
469 struct iwl_ucode_capabilities *capa)
471 struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
472 struct iwl_ucode_tlv *tlv;
473 size_t len = ucode_raw->size;
476 enum iwl_ucode_tlv_type tlv_type;
481 if (len < sizeof(*ucode)) {
482 IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
486 if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
487 IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
488 le32_to_cpu(ucode->magic));
492 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
493 build = le32_to_cpu(ucode->build);
496 sprintf(buildstr, " build %u%s", build,
497 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
502 snprintf(drv->fw.fw_version,
503 sizeof(drv->fw.fw_version),
505 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
506 IWL_UCODE_MINOR(drv->fw.ucode_ver),
507 IWL_UCODE_API(drv->fw.ucode_ver),
508 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
513 len -= sizeof(*ucode);
515 while (len >= sizeof(*tlv)) {
519 tlv_len = le32_to_cpu(tlv->length);
520 tlv_type = le32_to_cpu(tlv->type);
521 tlv_data = tlv->data;
524 IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
528 len -= ALIGN(tlv_len, 4);
529 data += sizeof(*tlv) + ALIGN(tlv_len, 4);
532 case IWL_UCODE_TLV_INST:
533 set_sec_data(pieces, IWL_UCODE_REGULAR,
534 IWL_UCODE_SECTION_INST, tlv_data);
535 set_sec_size(pieces, IWL_UCODE_REGULAR,
536 IWL_UCODE_SECTION_INST, tlv_len);
537 set_sec_offset(pieces, IWL_UCODE_REGULAR,
538 IWL_UCODE_SECTION_INST,
539 IWLAGN_RTC_INST_LOWER_BOUND);
541 case IWL_UCODE_TLV_DATA:
542 set_sec_data(pieces, IWL_UCODE_REGULAR,
543 IWL_UCODE_SECTION_DATA, tlv_data);
544 set_sec_size(pieces, IWL_UCODE_REGULAR,
545 IWL_UCODE_SECTION_DATA, tlv_len);
546 set_sec_offset(pieces, IWL_UCODE_REGULAR,
547 IWL_UCODE_SECTION_DATA,
548 IWLAGN_RTC_DATA_LOWER_BOUND);
550 case IWL_UCODE_TLV_INIT:
551 set_sec_data(pieces, IWL_UCODE_INIT,
552 IWL_UCODE_SECTION_INST, tlv_data);
553 set_sec_size(pieces, IWL_UCODE_INIT,
554 IWL_UCODE_SECTION_INST, tlv_len);
555 set_sec_offset(pieces, IWL_UCODE_INIT,
556 IWL_UCODE_SECTION_INST,
557 IWLAGN_RTC_INST_LOWER_BOUND);
559 case IWL_UCODE_TLV_INIT_DATA:
560 set_sec_data(pieces, IWL_UCODE_INIT,
561 IWL_UCODE_SECTION_DATA, tlv_data);
562 set_sec_size(pieces, IWL_UCODE_INIT,
563 IWL_UCODE_SECTION_DATA, tlv_len);
564 set_sec_offset(pieces, IWL_UCODE_INIT,
565 IWL_UCODE_SECTION_DATA,
566 IWLAGN_RTC_DATA_LOWER_BOUND);
568 case IWL_UCODE_TLV_BOOT:
569 IWL_ERR(drv, "Found unexpected BOOT ucode\n");
571 case IWL_UCODE_TLV_PROBE_MAX_LEN:
572 if (tlv_len != sizeof(u32))
573 goto invalid_tlv_len;
574 capa->max_probe_length =
575 le32_to_cpup((__le32 *)tlv_data);
577 case IWL_UCODE_TLV_PAN:
579 goto invalid_tlv_len;
580 capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
582 case IWL_UCODE_TLV_FLAGS:
583 /* must be at least one u32 */
584 if (tlv_len < sizeof(u32))
585 goto invalid_tlv_len;
586 /* and a proper number of u32s */
587 if (tlv_len % sizeof(u32))
588 goto invalid_tlv_len;
590 * This driver only reads the first u32 as
591 * right now no more features are defined,
592 * if that changes then either the driver
593 * will not work with the new firmware, or
594 * it'll not take advantage of new features.
596 capa->flags = le32_to_cpup((__le32 *)tlv_data);
598 case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
599 if (tlv_len != sizeof(u32))
600 goto invalid_tlv_len;
601 pieces->init_evtlog_ptr =
602 le32_to_cpup((__le32 *)tlv_data);
604 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
605 if (tlv_len != sizeof(u32))
606 goto invalid_tlv_len;
607 pieces->init_evtlog_size =
608 le32_to_cpup((__le32 *)tlv_data);
610 case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
611 if (tlv_len != sizeof(u32))
612 goto invalid_tlv_len;
613 pieces->init_errlog_ptr =
614 le32_to_cpup((__le32 *)tlv_data);
616 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
617 if (tlv_len != sizeof(u32))
618 goto invalid_tlv_len;
619 pieces->inst_evtlog_ptr =
620 le32_to_cpup((__le32 *)tlv_data);
622 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
623 if (tlv_len != sizeof(u32))
624 goto invalid_tlv_len;
625 pieces->inst_evtlog_size =
626 le32_to_cpup((__le32 *)tlv_data);
628 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
629 if (tlv_len != sizeof(u32))
630 goto invalid_tlv_len;
631 pieces->inst_errlog_ptr =
632 le32_to_cpup((__le32 *)tlv_data);
634 case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
636 goto invalid_tlv_len;
637 drv->fw.enhance_sensitivity_table = true;
639 case IWL_UCODE_TLV_WOWLAN_INST:
640 set_sec_data(pieces, IWL_UCODE_WOWLAN,
641 IWL_UCODE_SECTION_INST, tlv_data);
642 set_sec_size(pieces, IWL_UCODE_WOWLAN,
643 IWL_UCODE_SECTION_INST, tlv_len);
644 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
645 IWL_UCODE_SECTION_INST,
646 IWLAGN_RTC_INST_LOWER_BOUND);
648 case IWL_UCODE_TLV_WOWLAN_DATA:
649 set_sec_data(pieces, IWL_UCODE_WOWLAN,
650 IWL_UCODE_SECTION_DATA, tlv_data);
651 set_sec_size(pieces, IWL_UCODE_WOWLAN,
652 IWL_UCODE_SECTION_DATA, tlv_len);
653 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
654 IWL_UCODE_SECTION_DATA,
655 IWLAGN_RTC_DATA_LOWER_BOUND);
657 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
658 if (tlv_len != sizeof(u32))
659 goto invalid_tlv_len;
660 capa->standard_phy_calibration_size =
661 le32_to_cpup((__le32 *)tlv_data);
663 case IWL_UCODE_TLV_SEC_RT:
664 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
666 drv->fw.mvm_fw = true;
668 case IWL_UCODE_TLV_SEC_INIT:
669 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
671 drv->fw.mvm_fw = true;
673 case IWL_UCODE_TLV_SEC_WOWLAN:
674 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
676 drv->fw.mvm_fw = true;
678 case IWL_UCODE_TLV_DEF_CALIB:
679 if (tlv_len != sizeof(struct iwl_tlv_calib_data))
680 goto invalid_tlv_len;
681 if (iwl_set_default_calib(drv, tlv_data))
684 case IWL_UCODE_TLV_PHY_SKU:
685 if (tlv_len != sizeof(u32))
686 goto invalid_tlv_len;
687 drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
690 IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
696 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
697 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
704 IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
706 iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
711 static int iwl_alloc_ucode(struct iwl_drv *drv,
712 struct iwl_firmware_pieces *pieces,
713 enum iwl_ucode_type type)
717 i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
719 if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
720 get_sec(pieces, type, i)))
725 static int validate_sec_sizes(struct iwl_drv *drv,
726 struct iwl_firmware_pieces *pieces,
727 const struct iwl_cfg *cfg)
729 IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
730 get_sec_size(pieces, IWL_UCODE_REGULAR,
731 IWL_UCODE_SECTION_INST));
732 IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
733 get_sec_size(pieces, IWL_UCODE_REGULAR,
734 IWL_UCODE_SECTION_DATA));
735 IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
736 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
737 IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
738 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
740 /* Verify that uCode images will fit in card's SRAM. */
741 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
742 cfg->max_inst_size) {
743 IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
744 get_sec_size(pieces, IWL_UCODE_REGULAR,
745 IWL_UCODE_SECTION_INST));
749 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
750 cfg->max_data_size) {
751 IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
752 get_sec_size(pieces, IWL_UCODE_REGULAR,
753 IWL_UCODE_SECTION_DATA));
757 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
758 cfg->max_inst_size) {
759 IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
760 get_sec_size(pieces, IWL_UCODE_INIT,
761 IWL_UCODE_SECTION_INST));
765 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
766 cfg->max_data_size) {
767 IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
768 get_sec_size(pieces, IWL_UCODE_REGULAR,
769 IWL_UCODE_SECTION_DATA));
775 static struct iwl_op_mode *
776 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
778 const struct iwl_op_mode_ops *ops = op->ops;
779 struct dentry *dbgfs_dir = NULL;
780 struct iwl_op_mode *op_mode = NULL;
782 #ifdef CONFIG_IWLWIFI_DEBUGFS
783 drv->dbgfs_op_mode = debugfs_create_dir(op->name,
785 if (!drv->dbgfs_op_mode) {
787 "failed to create opmode debugfs directory\n");
790 dbgfs_dir = drv->dbgfs_op_mode;
793 op_mode = ops->start(drv->trans, drv->cfg, &drv->fw, dbgfs_dir);
795 #ifdef CONFIG_IWLWIFI_DEBUGFS
797 debugfs_remove_recursive(drv->dbgfs_op_mode);
798 drv->dbgfs_op_mode = NULL;
805 static void _iwl_op_mode_stop(struct iwl_drv *drv)
807 /* op_mode can be NULL if its start failed */
809 iwl_op_mode_stop(drv->op_mode);
812 #ifdef CONFIG_IWLWIFI_DEBUGFS
813 debugfs_remove_recursive(drv->dbgfs_op_mode);
814 drv->dbgfs_op_mode = NULL;
820 * iwl_req_fw_callback - callback when firmware was loaded
822 * If loaded successfully, copies the firmware into buffers
823 * for the card to fetch (via DMA).
825 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
827 struct iwl_drv *drv = context;
828 struct iwl_fw *fw = &drv->fw;
829 struct iwl_ucode_header *ucode;
830 struct iwlwifi_opmode_table *op;
832 struct iwl_firmware_pieces pieces;
833 const unsigned int api_max = drv->cfg->ucode_api_max;
834 unsigned int api_ok = drv->cfg->ucode_api_ok;
835 const unsigned int api_min = drv->cfg->ucode_api_min;
838 bool load_module = false;
840 fw->ucode_capa.max_probe_length = 200;
841 fw->ucode_capa.standard_phy_calibration_size =
842 IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
847 memset(&pieces, 0, sizeof(pieces));
850 if (drv->fw_index <= api_ok)
852 "request for firmware file '%s' failed.\n",
857 IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
858 drv->firmware_name, ucode_raw->size);
860 /* Make sure that we got at least the API version number */
861 if (ucode_raw->size < 4) {
862 IWL_ERR(drv, "File size way too small!\n");
866 /* Data from ucode file: header followed by uCode images */
867 ucode = (struct iwl_ucode_header *)ucode_raw->data;
870 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, &pieces);
872 err = iwl_parse_tlv_firmware(drv, ucode_raw, &pieces,
878 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
881 * api_ver should match the api version forming part of the
882 * firmware filename ... but we don't check for that and only rely
883 * on the API version read from firmware header from here on forward
885 /* no api version check required for experimental uCode */
886 if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
887 if (api_ver < api_min || api_ver > api_max) {
889 "Driver unable to support your firmware API. "
890 "Driver supports v%u, firmware is v%u.\n",
895 if (api_ver < api_ok) {
896 if (api_ok != api_max)
897 IWL_ERR(drv, "Firmware has old API version, "
898 "expected v%u through v%u, got v%u.\n",
899 api_ok, api_max, api_ver);
901 IWL_ERR(drv, "Firmware has old API version, "
902 "expected v%u, got v%u.\n",
904 IWL_ERR(drv, "New firmware can be obtained from "
905 "http://www.intellinuxwireless.org/.\n");
909 IWL_INFO(drv, "loaded firmware version %s", drv->fw.fw_version);
912 * In mvm uCode there is no difference between data and instructions
915 if (!fw->mvm_fw && validate_sec_sizes(drv, &pieces, drv->cfg))
918 /* Allocate ucode buffers for card's bus-master loading ... */
920 /* Runtime instructions and 2 copies of data:
921 * 1) unmodified from disk
922 * 2) backup cache for save/restore during power-downs */
923 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
924 if (iwl_alloc_ucode(drv, &pieces, i))
927 /* Now that we can no longer fail, copy information */
930 * The (size - 16) / 12 formula is based on the information recorded
931 * for each event, which is of mode 1 (including timestamp) for all
932 * new microcodes that include this information.
934 fw->init_evtlog_ptr = pieces.init_evtlog_ptr;
935 if (pieces.init_evtlog_size)
936 fw->init_evtlog_size = (pieces.init_evtlog_size - 16)/12;
938 fw->init_evtlog_size =
939 drv->cfg->base_params->max_event_log_size;
940 fw->init_errlog_ptr = pieces.init_errlog_ptr;
941 fw->inst_evtlog_ptr = pieces.inst_evtlog_ptr;
942 if (pieces.inst_evtlog_size)
943 fw->inst_evtlog_size = (pieces.inst_evtlog_size - 16)/12;
945 fw->inst_evtlog_size =
946 drv->cfg->base_params->max_event_log_size;
947 fw->inst_errlog_ptr = pieces.inst_errlog_ptr;
950 * figure out the offset of chain noise reset and gain commands
951 * base on the size of standard phy calibration commands table size
953 if (fw->ucode_capa.standard_phy_calibration_size >
954 IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
955 fw->ucode_capa.standard_phy_calibration_size =
956 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
958 /* We have our copies now, allow OS release its copies */
959 release_firmware(ucode_raw);
961 mutex_lock(&iwlwifi_opmode_table_mtx);
962 op = &iwlwifi_opmode_table[DVM_OP_MODE];
964 /* add this device to the list of devices using this op_mode */
965 list_add_tail(&drv->list, &op->drv);
968 drv->op_mode = _iwl_op_mode_start(drv, op);
971 mutex_unlock(&iwlwifi_opmode_table_mtx);
977 mutex_unlock(&iwlwifi_opmode_table_mtx);
980 * Complete the firmware request last so that
981 * a driver unbind (stop) doesn't run while we
982 * are doing the start() above.
984 complete(&drv->request_firmware_complete);
987 * Load the module last so we don't block anything
988 * else from proceeding if the module fails to load
992 request_module("%s", op->name);
996 /* try next, if any */
997 release_firmware(ucode_raw);
998 if (iwl_request_firmware(drv, false))
1003 IWL_ERR(drv, "failed to allocate pci memory\n");
1004 iwl_dealloc_ucode(drv);
1005 release_firmware(ucode_raw);
1007 complete(&drv->request_firmware_complete);
1008 device_release_driver(drv->trans->dev);
1011 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans,
1012 const struct iwl_cfg *cfg)
1014 struct iwl_drv *drv;
1017 drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1022 drv->dev = trans->dev;
1025 init_completion(&drv->request_firmware_complete);
1026 INIT_LIST_HEAD(&drv->list);
1028 #ifdef CONFIG_IWLWIFI_DEBUGFS
1029 /* Create the device debugfs entries. */
1030 drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1033 if (!drv->dbgfs_drv) {
1034 IWL_ERR(drv, "failed to create debugfs directory\n");
1038 /* Create transport layer debugfs dir */
1039 drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1041 if (!drv->trans->dbgfs_dir) {
1042 IWL_ERR(drv, "failed to create transport debugfs directory\n");
1043 goto err_free_dbgfs;
1047 ret = iwl_request_firmware(drv, true);
1050 IWL_ERR(trans, "Couldn't request the fw\n");
1057 #ifdef CONFIG_IWLWIFI_DEBUGFS
1059 debugfs_remove_recursive(drv->dbgfs_drv);
1068 void iwl_drv_stop(struct iwl_drv *drv)
1070 wait_for_completion(&drv->request_firmware_complete);
1072 _iwl_op_mode_stop(drv);
1074 iwl_dealloc_ucode(drv);
1076 mutex_lock(&iwlwifi_opmode_table_mtx);
1078 * List is empty (this item wasn't added)
1079 * when firmware loading failed -- in that
1080 * case we can't remove it from any list.
1082 if (!list_empty(&drv->list))
1083 list_del(&drv->list);
1084 mutex_unlock(&iwlwifi_opmode_table_mtx);
1086 #ifdef CONFIG_IWLWIFI_DEBUGFS
1087 debugfs_remove_recursive(drv->dbgfs_drv);
1094 /* shared module parameters */
1095 struct iwl_mod_params iwlwifi_mod_params = {
1099 .bt_coex_active = true,
1100 .power_level = IWL_POWER_INDEX_1,
1101 .bt_ch_announce = true,
1104 /* the rest are 0 by default */
1106 EXPORT_SYMBOL_GPL(iwlwifi_mod_params);
1108 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
1111 struct iwl_drv *drv;
1112 struct iwlwifi_opmode_table *op;
1114 mutex_lock(&iwlwifi_opmode_table_mtx);
1115 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1116 op = &iwlwifi_opmode_table[i];
1117 if (strcmp(op->name, name))
1120 /* TODO: need to handle exceptional case */
1121 list_for_each_entry(drv, &op->drv, list)
1122 drv->op_mode = _iwl_op_mode_start(drv, op);
1124 mutex_unlock(&iwlwifi_opmode_table_mtx);
1127 mutex_unlock(&iwlwifi_opmode_table_mtx);
1130 EXPORT_SYMBOL_GPL(iwl_opmode_register);
1132 void iwl_opmode_deregister(const char *name)
1135 struct iwl_drv *drv;
1137 mutex_lock(&iwlwifi_opmode_table_mtx);
1138 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1139 if (strcmp(iwlwifi_opmode_table[i].name, name))
1141 iwlwifi_opmode_table[i].ops = NULL;
1143 /* call the stop routine for all devices */
1144 list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
1145 _iwl_op_mode_stop(drv);
1147 mutex_unlock(&iwlwifi_opmode_table_mtx);
1150 mutex_unlock(&iwlwifi_opmode_table_mtx);
1152 EXPORT_SYMBOL_GPL(iwl_opmode_deregister);
1154 static int __init iwl_drv_init(void)
1158 mutex_init(&iwlwifi_opmode_table_mtx);
1160 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
1161 INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
1163 pr_info(DRV_DESCRIPTION ", " DRV_VERSION "\n");
1164 pr_info(DRV_COPYRIGHT "\n");
1166 #ifdef CONFIG_IWLWIFI_DEBUGFS
1167 /* Create the root of iwlwifi debugfs subsystem. */
1168 iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
1170 if (!iwl_dbgfs_root)
1174 return iwl_pci_register_driver();
1176 module_init(iwl_drv_init);
1178 static void __exit iwl_drv_exit(void)
1180 iwl_pci_unregister_driver();
1182 #ifdef CONFIG_IWLWIFI_DEBUGFS
1183 debugfs_remove_recursive(iwl_dbgfs_root);
1186 module_exit(iwl_drv_exit);
1188 #ifdef CONFIG_IWLWIFI_DEBUG
1189 module_param_named(debug, iwlwifi_mod_params.debug_level, uint,
1191 MODULE_PARM_DESC(debug, "debug output mask");
1194 module_param_named(swcrypto, iwlwifi_mod_params.sw_crypto, int, S_IRUGO);
1195 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
1196 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, S_IRUGO);
1197 MODULE_PARM_DESC(11n_disable,
1198 "disable 11n functionality, bitmap: 1: full, 2: agg TX, 4: agg RX");
1199 module_param_named(amsdu_size_8K, iwlwifi_mod_params.amsdu_size_8K,
1201 MODULE_PARM_DESC(amsdu_size_8K, "enable 8K amsdu size");
1202 module_param_named(fw_restart, iwlwifi_mod_params.restart_fw, int, S_IRUGO);
1203 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error");
1205 module_param_named(antenna_coupling, iwlwifi_mod_params.ant_coupling,
1207 MODULE_PARM_DESC(antenna_coupling,
1208 "specify antenna coupling in dB (defualt: 0 dB)");
1210 module_param_named(bt_ch_inhibition, iwlwifi_mod_params.bt_ch_announce,
1212 MODULE_PARM_DESC(bt_ch_inhibition,
1213 "Enable BT channel inhibition (default: enable)");
1215 module_param_named(plcp_check, iwlwifi_mod_params.plcp_check, bool, S_IRUGO);
1216 MODULE_PARM_DESC(plcp_check, "Check plcp health (default: 1 [enabled])");
1218 module_param_named(wd_disable, iwlwifi_mod_params.wd_disable, int, S_IRUGO);
1219 MODULE_PARM_DESC(wd_disable,
1220 "Disable stuck queue watchdog timer 0=system default, "
1221 "1=disable, 2=enable (default: 0)");
1224 * set bt_coex_active to true, uCode will do kill/defer
1225 * every time the priority line is asserted (BT is sending signals on the
1226 * priority line in the PCIx).
1227 * set bt_coex_active to false, uCode will ignore the BT activity and
1228 * perform the normal operation
1230 * User might experience transmit issue on some platform due to WiFi/BT
1231 * co-exist problem. The possible behaviors are:
1232 * Able to scan and finding all the available AP
1233 * Not able to associate with any AP
1234 * On those platforms, WiFi communication can be restored by set
1235 * "bt_coex_active" module parameter to "false"
1237 * default: bt_coex_active = true (BT_COEX_ENABLE)
1239 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1241 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1243 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, S_IRUGO);
1244 MODULE_PARM_DESC(led_mode, "0=system default, "
1245 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1247 module_param_named(power_save, iwlwifi_mod_params.power_save,
1249 MODULE_PARM_DESC(power_save,
1250 "enable WiFi power management (default: disable)");
1252 module_param_named(power_level, iwlwifi_mod_params.power_level,
1254 MODULE_PARM_DESC(power_level,
1255 "default power save level (range from 1 - 5, default: 1)");
1257 module_param_named(auto_agg, iwlwifi_mod_params.auto_agg,
1259 MODULE_PARM_DESC(auto_agg,
1260 "enable agg w/o check traffic load (default: enable)");
1262 module_param_named(5ghz_disable, iwlwifi_mod_params.disable_5ghz,
1264 MODULE_PARM_DESC(5ghz_disable, "disable 5GHz band (default: 0 [enabled])");