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.
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 - 2014 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[32]; /* 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 snprintf(drv->firmware_name, sizeof(drv->firmware_name), "%s%s.ucode",
243 IWL_DEBUG_INFO(drv, "attempting to load firmware %s'%s'\n",
244 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
245 ? "EXPERIMENTAL " : "",
248 return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
250 GFP_KERNEL, drv, iwl_req_fw_callback);
253 struct fw_img_parsing {
254 struct fw_sec sec[IWL_UCODE_SECTION_MAX];
259 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
261 struct fw_sec_parsing {
267 * struct iwl_tlv_calib_data - parse the default calib data from TLV
269 * @ucode_type: the uCode to which the following default calib relates.
270 * @calib: default calibrations.
272 struct iwl_tlv_calib_data {
274 struct iwl_tlv_calib_ctrl calib;
277 struct iwl_firmware_pieces {
278 struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
280 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
281 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
285 * These functions are just to extract uCode section data from the pieces
288 static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
289 enum iwl_ucode_type type,
292 return &pieces->img[type].sec[sec];
295 static void set_sec_data(struct iwl_firmware_pieces *pieces,
296 enum iwl_ucode_type type,
300 pieces->img[type].sec[sec].data = data;
303 static void set_sec_size(struct iwl_firmware_pieces *pieces,
304 enum iwl_ucode_type type,
308 pieces->img[type].sec[sec].size = size;
311 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
312 enum iwl_ucode_type type,
315 return pieces->img[type].sec[sec].size;
318 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
319 enum iwl_ucode_type type,
323 pieces->img[type].sec[sec].offset = offset;
326 static int iwl_store_cscheme(struct iwl_fw *fw, const u8 *data, const u32 len)
329 struct iwl_fw_cscheme_list *l = (struct iwl_fw_cscheme_list *)data;
330 struct iwl_fw_cipher_scheme *fwcs;
331 struct ieee80211_cipher_scheme *cs;
334 if (len < sizeof(*l) ||
335 len < sizeof(l->size) + l->size * sizeof(l->cs[0]))
338 for (i = 0, j = 0; i < IWL_UCODE_MAX_CS && i < l->size; i++) {
340 cipher = le32_to_cpu(fwcs->cipher);
342 /* we skip schemes with zero cipher suite selector */
348 cs->iftype = BIT(NL80211_IFTYPE_STATION);
349 cs->hdr_len = fwcs->hdr_len;
350 cs->pn_len = fwcs->pn_len;
351 cs->pn_off = fwcs->pn_off;
352 cs->key_idx_off = fwcs->key_idx_off;
353 cs->key_idx_mask = fwcs->key_idx_mask;
354 cs->key_idx_shift = fwcs->key_idx_shift;
355 cs->mic_len = fwcs->mic_len;
362 * Gets uCode section from tlv.
364 static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
365 const void *data, enum iwl_ucode_type type,
368 struct fw_img_parsing *img;
370 struct fw_sec_parsing *sec_parse;
372 if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
375 sec_parse = (struct fw_sec_parsing *)data;
377 img = &pieces->img[type];
378 sec = &img->sec[img->sec_counter];
380 sec->offset = le32_to_cpu(sec_parse->offset);
381 sec->data = sec_parse->data;
382 sec->size = size - sizeof(sec_parse->offset);
389 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
391 struct iwl_tlv_calib_data *def_calib =
392 (struct iwl_tlv_calib_data *)data;
393 u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
394 if (ucode_type >= IWL_UCODE_TYPE_MAX) {
395 IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
399 drv->fw.default_calib[ucode_type].flow_trigger =
400 def_calib->calib.flow_trigger;
401 drv->fw.default_calib[ucode_type].event_trigger =
402 def_calib->calib.event_trigger;
407 static int iwl_set_ucode_api_flags(struct iwl_drv *drv, const u8 *data,
408 struct iwl_ucode_capabilities *capa)
410 const struct iwl_ucode_api *ucode_api = (void *)data;
411 u32 api_index = le32_to_cpu(ucode_api->api_index);
413 if (api_index >= IWL_API_ARRAY_SIZE) {
414 IWL_ERR(drv, "api_index larger than supported by driver\n");
418 capa->api[api_index] = le32_to_cpu(ucode_api->api_flags);
423 static int iwl_set_ucode_capabilities(struct iwl_drv *drv, const u8 *data,
424 struct iwl_ucode_capabilities *capa)
426 const struct iwl_ucode_capa *ucode_capa = (void *)data;
427 u32 api_index = le32_to_cpu(ucode_capa->api_index);
429 if (api_index >= IWL_CAPABILITIES_ARRAY_SIZE) {
430 IWL_ERR(drv, "api_index larger than supported by driver\n");
434 capa->capa[api_index] = le32_to_cpu(ucode_capa->api_capa);
439 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
440 const struct firmware *ucode_raw,
441 struct iwl_firmware_pieces *pieces)
443 struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
444 u32 api_ver, hdr_size, build;
448 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
449 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
454 if (ucode_raw->size < hdr_size) {
455 IWL_ERR(drv, "File size too small!\n");
458 build = le32_to_cpu(ucode->u.v2.build);
459 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
460 le32_to_cpu(ucode->u.v2.inst_size));
461 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
462 le32_to_cpu(ucode->u.v2.data_size));
463 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
464 le32_to_cpu(ucode->u.v2.init_size));
465 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
466 le32_to_cpu(ucode->u.v2.init_data_size));
467 src = ucode->u.v2.data;
473 if (ucode_raw->size < hdr_size) {
474 IWL_ERR(drv, "File size too small!\n");
478 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
479 le32_to_cpu(ucode->u.v1.inst_size));
480 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
481 le32_to_cpu(ucode->u.v1.data_size));
482 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
483 le32_to_cpu(ucode->u.v1.init_size));
484 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
485 le32_to_cpu(ucode->u.v1.init_data_size));
486 src = ucode->u.v1.data;
491 sprintf(buildstr, " build %u%s", build,
492 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
497 snprintf(drv->fw.fw_version,
498 sizeof(drv->fw.fw_version),
500 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
501 IWL_UCODE_MINOR(drv->fw.ucode_ver),
502 IWL_UCODE_API(drv->fw.ucode_ver),
503 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
506 /* Verify size of file vs. image size info in file's header */
508 if (ucode_raw->size != hdr_size +
509 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
510 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
511 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
512 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
515 "uCode file size %d does not match expected size\n",
516 (int)ucode_raw->size);
521 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
522 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
523 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
524 IWLAGN_RTC_INST_LOWER_BOUND);
525 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
526 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
527 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
528 IWLAGN_RTC_DATA_LOWER_BOUND);
529 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
530 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
531 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
532 IWLAGN_RTC_INST_LOWER_BOUND);
533 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
534 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
535 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
536 IWLAGN_RTC_DATA_LOWER_BOUND);
540 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
541 const struct firmware *ucode_raw,
542 struct iwl_firmware_pieces *pieces,
543 struct iwl_ucode_capabilities *capa)
545 struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
546 struct iwl_ucode_tlv *tlv;
547 size_t len = ucode_raw->size;
550 enum iwl_ucode_tlv_type tlv_type;
556 if (len < sizeof(*ucode)) {
557 IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
561 if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
562 IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
563 le32_to_cpu(ucode->magic));
567 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
568 build = le32_to_cpu(ucode->build);
571 sprintf(buildstr, " build %u%s", build,
572 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
577 snprintf(drv->fw.fw_version,
578 sizeof(drv->fw.fw_version),
580 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
581 IWL_UCODE_MINOR(drv->fw.ucode_ver),
582 IWL_UCODE_API(drv->fw.ucode_ver),
583 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
588 len -= sizeof(*ucode);
590 while (len >= sizeof(*tlv)) {
594 tlv_len = le32_to_cpu(tlv->length);
595 tlv_type = le32_to_cpu(tlv->type);
596 tlv_data = tlv->data;
599 IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
603 len -= ALIGN(tlv_len, 4);
604 data += sizeof(*tlv) + ALIGN(tlv_len, 4);
607 case IWL_UCODE_TLV_INST:
608 set_sec_data(pieces, IWL_UCODE_REGULAR,
609 IWL_UCODE_SECTION_INST, tlv_data);
610 set_sec_size(pieces, IWL_UCODE_REGULAR,
611 IWL_UCODE_SECTION_INST, tlv_len);
612 set_sec_offset(pieces, IWL_UCODE_REGULAR,
613 IWL_UCODE_SECTION_INST,
614 IWLAGN_RTC_INST_LOWER_BOUND);
616 case IWL_UCODE_TLV_DATA:
617 set_sec_data(pieces, IWL_UCODE_REGULAR,
618 IWL_UCODE_SECTION_DATA, tlv_data);
619 set_sec_size(pieces, IWL_UCODE_REGULAR,
620 IWL_UCODE_SECTION_DATA, tlv_len);
621 set_sec_offset(pieces, IWL_UCODE_REGULAR,
622 IWL_UCODE_SECTION_DATA,
623 IWLAGN_RTC_DATA_LOWER_BOUND);
625 case IWL_UCODE_TLV_INIT:
626 set_sec_data(pieces, IWL_UCODE_INIT,
627 IWL_UCODE_SECTION_INST, tlv_data);
628 set_sec_size(pieces, IWL_UCODE_INIT,
629 IWL_UCODE_SECTION_INST, tlv_len);
630 set_sec_offset(pieces, IWL_UCODE_INIT,
631 IWL_UCODE_SECTION_INST,
632 IWLAGN_RTC_INST_LOWER_BOUND);
634 case IWL_UCODE_TLV_INIT_DATA:
635 set_sec_data(pieces, IWL_UCODE_INIT,
636 IWL_UCODE_SECTION_DATA, tlv_data);
637 set_sec_size(pieces, IWL_UCODE_INIT,
638 IWL_UCODE_SECTION_DATA, tlv_len);
639 set_sec_offset(pieces, IWL_UCODE_INIT,
640 IWL_UCODE_SECTION_DATA,
641 IWLAGN_RTC_DATA_LOWER_BOUND);
643 case IWL_UCODE_TLV_BOOT:
644 IWL_ERR(drv, "Found unexpected BOOT ucode\n");
646 case IWL_UCODE_TLV_PROBE_MAX_LEN:
647 if (tlv_len != sizeof(u32))
648 goto invalid_tlv_len;
649 capa->max_probe_length =
650 le32_to_cpup((__le32 *)tlv_data);
652 case IWL_UCODE_TLV_PAN:
654 goto invalid_tlv_len;
655 capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
657 case IWL_UCODE_TLV_FLAGS:
658 /* must be at least one u32 */
659 if (tlv_len < sizeof(u32))
660 goto invalid_tlv_len;
661 /* and a proper number of u32s */
662 if (tlv_len % sizeof(u32))
663 goto invalid_tlv_len;
665 * This driver only reads the first u32 as
666 * right now no more features are defined,
667 * if that changes then either the driver
668 * will not work with the new firmware, or
669 * it'll not take advantage of new features.
671 capa->flags = le32_to_cpup((__le32 *)tlv_data);
673 case IWL_UCODE_TLV_API_CHANGES_SET:
674 if (tlv_len != sizeof(struct iwl_ucode_api))
675 goto invalid_tlv_len;
676 if (iwl_set_ucode_api_flags(drv, tlv_data, capa))
679 case IWL_UCODE_TLV_ENABLED_CAPABILITIES:
680 if (tlv_len != sizeof(struct iwl_ucode_capa))
681 goto invalid_tlv_len;
682 if (iwl_set_ucode_capabilities(drv, tlv_data, capa))
685 case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
686 if (tlv_len != sizeof(u32))
687 goto invalid_tlv_len;
688 pieces->init_evtlog_ptr =
689 le32_to_cpup((__le32 *)tlv_data);
691 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
692 if (tlv_len != sizeof(u32))
693 goto invalid_tlv_len;
694 pieces->init_evtlog_size =
695 le32_to_cpup((__le32 *)tlv_data);
697 case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
698 if (tlv_len != sizeof(u32))
699 goto invalid_tlv_len;
700 pieces->init_errlog_ptr =
701 le32_to_cpup((__le32 *)tlv_data);
703 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
704 if (tlv_len != sizeof(u32))
705 goto invalid_tlv_len;
706 pieces->inst_evtlog_ptr =
707 le32_to_cpup((__le32 *)tlv_data);
709 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
710 if (tlv_len != sizeof(u32))
711 goto invalid_tlv_len;
712 pieces->inst_evtlog_size =
713 le32_to_cpup((__le32 *)tlv_data);
715 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
716 if (tlv_len != sizeof(u32))
717 goto invalid_tlv_len;
718 pieces->inst_errlog_ptr =
719 le32_to_cpup((__le32 *)tlv_data);
721 case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
723 goto invalid_tlv_len;
724 drv->fw.enhance_sensitivity_table = true;
726 case IWL_UCODE_TLV_WOWLAN_INST:
727 set_sec_data(pieces, IWL_UCODE_WOWLAN,
728 IWL_UCODE_SECTION_INST, tlv_data);
729 set_sec_size(pieces, IWL_UCODE_WOWLAN,
730 IWL_UCODE_SECTION_INST, tlv_len);
731 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
732 IWL_UCODE_SECTION_INST,
733 IWLAGN_RTC_INST_LOWER_BOUND);
735 case IWL_UCODE_TLV_WOWLAN_DATA:
736 set_sec_data(pieces, IWL_UCODE_WOWLAN,
737 IWL_UCODE_SECTION_DATA, tlv_data);
738 set_sec_size(pieces, IWL_UCODE_WOWLAN,
739 IWL_UCODE_SECTION_DATA, tlv_len);
740 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
741 IWL_UCODE_SECTION_DATA,
742 IWLAGN_RTC_DATA_LOWER_BOUND);
744 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
745 if (tlv_len != sizeof(u32))
746 goto invalid_tlv_len;
747 capa->standard_phy_calibration_size =
748 le32_to_cpup((__le32 *)tlv_data);
750 case IWL_UCODE_TLV_SEC_RT:
751 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
753 drv->fw.mvm_fw = true;
755 case IWL_UCODE_TLV_SEC_INIT:
756 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
758 drv->fw.mvm_fw = true;
760 case IWL_UCODE_TLV_SEC_WOWLAN:
761 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
763 drv->fw.mvm_fw = true;
765 case IWL_UCODE_TLV_DEF_CALIB:
766 if (tlv_len != sizeof(struct iwl_tlv_calib_data))
767 goto invalid_tlv_len;
768 if (iwl_set_default_calib(drv, tlv_data))
771 case IWL_UCODE_TLV_PHY_SKU:
772 if (tlv_len != sizeof(u32))
773 goto invalid_tlv_len;
774 drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
775 drv->fw.valid_tx_ant = (drv->fw.phy_config &
776 FW_PHY_CFG_TX_CHAIN) >>
777 FW_PHY_CFG_TX_CHAIN_POS;
778 drv->fw.valid_rx_ant = (drv->fw.phy_config &
779 FW_PHY_CFG_RX_CHAIN) >>
780 FW_PHY_CFG_RX_CHAIN_POS;
782 case IWL_UCODE_TLV_SECURE_SEC_RT:
783 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
785 drv->fw.mvm_fw = true;
786 drv->fw.img[IWL_UCODE_REGULAR].is_secure = true;
788 case IWL_UCODE_TLV_SECURE_SEC_INIT:
789 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
791 drv->fw.mvm_fw = true;
792 drv->fw.img[IWL_UCODE_INIT].is_secure = true;
794 case IWL_UCODE_TLV_SECURE_SEC_WOWLAN:
795 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
797 drv->fw.mvm_fw = true;
798 drv->fw.img[IWL_UCODE_WOWLAN].is_secure = true;
800 case IWL_UCODE_TLV_NUM_OF_CPU:
801 if (tlv_len != sizeof(u32))
802 goto invalid_tlv_len;
804 le32_to_cpup((__le32 *)tlv_data);
806 if (num_of_cpus == 2) {
807 drv->fw.img[IWL_UCODE_REGULAR].is_dual_cpus =
809 drv->fw.img[IWL_UCODE_INIT].is_dual_cpus =
811 drv->fw.img[IWL_UCODE_WOWLAN].is_dual_cpus =
813 } else if ((num_of_cpus > 2) || (num_of_cpus < 1)) {
814 IWL_ERR(drv, "Driver support upto 2 CPUs\n");
818 case IWL_UCODE_TLV_CSCHEME:
819 if (iwl_store_cscheme(&drv->fw, tlv_data, tlv_len))
820 goto invalid_tlv_len;
823 IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
829 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
830 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
837 IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
839 iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
844 static int iwl_alloc_ucode(struct iwl_drv *drv,
845 struct iwl_firmware_pieces *pieces,
846 enum iwl_ucode_type type)
850 i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
852 if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
853 get_sec(pieces, type, i)))
858 static int validate_sec_sizes(struct iwl_drv *drv,
859 struct iwl_firmware_pieces *pieces,
860 const struct iwl_cfg *cfg)
862 IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
863 get_sec_size(pieces, IWL_UCODE_REGULAR,
864 IWL_UCODE_SECTION_INST));
865 IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
866 get_sec_size(pieces, IWL_UCODE_REGULAR,
867 IWL_UCODE_SECTION_DATA));
868 IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
869 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
870 IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
871 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
873 /* Verify that uCode images will fit in card's SRAM. */
874 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
875 cfg->max_inst_size) {
876 IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
877 get_sec_size(pieces, IWL_UCODE_REGULAR,
878 IWL_UCODE_SECTION_INST));
882 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
883 cfg->max_data_size) {
884 IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
885 get_sec_size(pieces, IWL_UCODE_REGULAR,
886 IWL_UCODE_SECTION_DATA));
890 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
891 cfg->max_inst_size) {
892 IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
893 get_sec_size(pieces, IWL_UCODE_INIT,
894 IWL_UCODE_SECTION_INST));
898 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
899 cfg->max_data_size) {
900 IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
901 get_sec_size(pieces, IWL_UCODE_REGULAR,
902 IWL_UCODE_SECTION_DATA));
908 static struct iwl_op_mode *
909 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
911 const struct iwl_op_mode_ops *ops = op->ops;
912 struct dentry *dbgfs_dir = NULL;
913 struct iwl_op_mode *op_mode = NULL;
915 #ifdef CONFIG_IWLWIFI_DEBUGFS
916 drv->dbgfs_op_mode = debugfs_create_dir(op->name,
918 if (!drv->dbgfs_op_mode) {
920 "failed to create opmode debugfs directory\n");
923 dbgfs_dir = drv->dbgfs_op_mode;
926 op_mode = ops->start(drv->trans, drv->cfg, &drv->fw, dbgfs_dir);
928 #ifdef CONFIG_IWLWIFI_DEBUGFS
930 debugfs_remove_recursive(drv->dbgfs_op_mode);
931 drv->dbgfs_op_mode = NULL;
938 static void _iwl_op_mode_stop(struct iwl_drv *drv)
940 /* op_mode can be NULL if its start failed */
942 iwl_op_mode_stop(drv->op_mode);
945 #ifdef CONFIG_IWLWIFI_DEBUGFS
946 debugfs_remove_recursive(drv->dbgfs_op_mode);
947 drv->dbgfs_op_mode = NULL;
953 * iwl_req_fw_callback - callback when firmware was loaded
955 * If loaded successfully, copies the firmware into buffers
956 * for the card to fetch (via DMA).
958 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
960 struct iwl_drv *drv = context;
961 struct iwl_fw *fw = &drv->fw;
962 struct iwl_ucode_header *ucode;
963 struct iwlwifi_opmode_table *op;
965 struct iwl_firmware_pieces pieces;
966 const unsigned int api_max = drv->cfg->ucode_api_max;
967 unsigned int api_ok = drv->cfg->ucode_api_ok;
968 const unsigned int api_min = drv->cfg->ucode_api_min;
971 bool load_module = false;
973 fw->ucode_capa.max_probe_length = IWL_DEFAULT_MAX_PROBE_LENGTH;
974 fw->ucode_capa.standard_phy_calibration_size =
975 IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
980 memset(&pieces, 0, sizeof(pieces));
983 if (drv->fw_index <= api_ok)
985 "request for firmware file '%s' failed.\n",
990 IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
991 drv->firmware_name, ucode_raw->size);
993 /* Make sure that we got at least the API version number */
994 if (ucode_raw->size < 4) {
995 IWL_ERR(drv, "File size way too small!\n");
999 /* Data from ucode file: header followed by uCode images */
1000 ucode = (struct iwl_ucode_header *)ucode_raw->data;
1003 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, &pieces);
1005 err = iwl_parse_tlv_firmware(drv, ucode_raw, &pieces,
1011 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
1014 * api_ver should match the api version forming part of the
1015 * firmware filename ... but we don't check for that and only rely
1016 * on the API version read from firmware header from here on forward
1018 /* no api version check required for experimental uCode */
1019 if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
1020 if (api_ver < api_min || api_ver > api_max) {
1022 "Driver unable to support your firmware API. "
1023 "Driver supports v%u, firmware is v%u.\n",
1028 if (api_ver < api_ok) {
1029 if (api_ok != api_max)
1030 IWL_ERR(drv, "Firmware has old API version, "
1031 "expected v%u through v%u, got v%u.\n",
1032 api_ok, api_max, api_ver);
1034 IWL_ERR(drv, "Firmware has old API version, "
1035 "expected v%u, got v%u.\n",
1037 IWL_ERR(drv, "New firmware can be obtained from "
1038 "http://www.intellinuxwireless.org/.\n");
1043 * In mvm uCode there is no difference between data and instructions
1046 if (!fw->mvm_fw && validate_sec_sizes(drv, &pieces, drv->cfg))
1049 /* Allocate ucode buffers for card's bus-master loading ... */
1051 /* Runtime instructions and 2 copies of data:
1052 * 1) unmodified from disk
1053 * 2) backup cache for save/restore during power-downs */
1054 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
1055 if (iwl_alloc_ucode(drv, &pieces, i))
1058 /* Now that we can no longer fail, copy information */
1061 * The (size - 16) / 12 formula is based on the information recorded
1062 * for each event, which is of mode 1 (including timestamp) for all
1063 * new microcodes that include this information.
1065 fw->init_evtlog_ptr = pieces.init_evtlog_ptr;
1066 if (pieces.init_evtlog_size)
1067 fw->init_evtlog_size = (pieces.init_evtlog_size - 16)/12;
1069 fw->init_evtlog_size =
1070 drv->cfg->base_params->max_event_log_size;
1071 fw->init_errlog_ptr = pieces.init_errlog_ptr;
1072 fw->inst_evtlog_ptr = pieces.inst_evtlog_ptr;
1073 if (pieces.inst_evtlog_size)
1074 fw->inst_evtlog_size = (pieces.inst_evtlog_size - 16)/12;
1076 fw->inst_evtlog_size =
1077 drv->cfg->base_params->max_event_log_size;
1078 fw->inst_errlog_ptr = pieces.inst_errlog_ptr;
1081 * figure out the offset of chain noise reset and gain commands
1082 * base on the size of standard phy calibration commands table size
1084 if (fw->ucode_capa.standard_phy_calibration_size >
1085 IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
1086 fw->ucode_capa.standard_phy_calibration_size =
1087 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1089 /* We have our copies now, allow OS release its copies */
1090 release_firmware(ucode_raw);
1092 mutex_lock(&iwlwifi_opmode_table_mtx);
1094 op = &iwlwifi_opmode_table[MVM_OP_MODE];
1096 op = &iwlwifi_opmode_table[DVM_OP_MODE];
1098 IWL_INFO(drv, "loaded firmware version %s op_mode %s\n",
1099 drv->fw.fw_version, op->name);
1101 /* add this device to the list of devices using this op_mode */
1102 list_add_tail(&drv->list, &op->drv);
1105 drv->op_mode = _iwl_op_mode_start(drv, op);
1107 if (!drv->op_mode) {
1108 mutex_unlock(&iwlwifi_opmode_table_mtx);
1114 mutex_unlock(&iwlwifi_opmode_table_mtx);
1117 * Complete the firmware request last so that
1118 * a driver unbind (stop) doesn't run while we
1119 * are doing the start() above.
1121 complete(&drv->request_firmware_complete);
1124 * Load the module last so we don't block anything
1125 * else from proceeding if the module fails to load
1129 err = request_module("%s", op->name);
1130 #ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
1133 "failed to load module %s (error %d), is dynamic loading enabled?\n",
1140 /* try next, if any */
1141 release_firmware(ucode_raw);
1142 if (iwl_request_firmware(drv, false))
1147 IWL_ERR(drv, "failed to allocate pci memory\n");
1148 iwl_dealloc_ucode(drv);
1149 release_firmware(ucode_raw);
1151 complete(&drv->request_firmware_complete);
1152 device_release_driver(drv->trans->dev);
1155 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans,
1156 const struct iwl_cfg *cfg)
1158 struct iwl_drv *drv;
1161 drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1168 drv->dev = trans->dev;
1171 init_completion(&drv->request_firmware_complete);
1172 INIT_LIST_HEAD(&drv->list);
1174 #ifdef CONFIG_IWLWIFI_DEBUGFS
1175 /* Create the device debugfs entries. */
1176 drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1179 if (!drv->dbgfs_drv) {
1180 IWL_ERR(drv, "failed to create debugfs directory\n");
1185 /* Create transport layer debugfs dir */
1186 drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1188 if (!drv->trans->dbgfs_dir) {
1189 IWL_ERR(drv, "failed to create transport debugfs directory\n");
1191 goto err_free_dbgfs;
1195 ret = iwl_request_firmware(drv, true);
1197 IWL_ERR(trans, "Couldn't request the fw\n");
1204 #ifdef CONFIG_IWLWIFI_DEBUGFS
1206 debugfs_remove_recursive(drv->dbgfs_drv);
1211 return ERR_PTR(ret);
1214 void iwl_drv_stop(struct iwl_drv *drv)
1216 wait_for_completion(&drv->request_firmware_complete);
1218 _iwl_op_mode_stop(drv);
1220 iwl_dealloc_ucode(drv);
1222 mutex_lock(&iwlwifi_opmode_table_mtx);
1224 * List is empty (this item wasn't added)
1225 * when firmware loading failed -- in that
1226 * case we can't remove it from any list.
1228 if (!list_empty(&drv->list))
1229 list_del(&drv->list);
1230 mutex_unlock(&iwlwifi_opmode_table_mtx);
1232 #ifdef CONFIG_IWLWIFI_DEBUGFS
1233 debugfs_remove_recursive(drv->dbgfs_drv);
1240 /* shared module parameters */
1241 struct iwl_mod_params iwlwifi_mod_params = {
1243 .bt_coex_active = true,
1244 .power_level = IWL_POWER_INDEX_1,
1246 /* the rest are 0 by default */
1248 IWL_EXPORT_SYMBOL(iwlwifi_mod_params);
1250 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
1253 struct iwl_drv *drv;
1254 struct iwlwifi_opmode_table *op;
1256 mutex_lock(&iwlwifi_opmode_table_mtx);
1257 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1258 op = &iwlwifi_opmode_table[i];
1259 if (strcmp(op->name, name))
1262 /* TODO: need to handle exceptional case */
1263 list_for_each_entry(drv, &op->drv, list)
1264 drv->op_mode = _iwl_op_mode_start(drv, op);
1266 mutex_unlock(&iwlwifi_opmode_table_mtx);
1269 mutex_unlock(&iwlwifi_opmode_table_mtx);
1272 IWL_EXPORT_SYMBOL(iwl_opmode_register);
1274 void iwl_opmode_deregister(const char *name)
1277 struct iwl_drv *drv;
1279 mutex_lock(&iwlwifi_opmode_table_mtx);
1280 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1281 if (strcmp(iwlwifi_opmode_table[i].name, name))
1283 iwlwifi_opmode_table[i].ops = NULL;
1285 /* call the stop routine for all devices */
1286 list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
1287 _iwl_op_mode_stop(drv);
1289 mutex_unlock(&iwlwifi_opmode_table_mtx);
1292 mutex_unlock(&iwlwifi_opmode_table_mtx);
1294 IWL_EXPORT_SYMBOL(iwl_opmode_deregister);
1296 static int __init iwl_drv_init(void)
1300 mutex_init(&iwlwifi_opmode_table_mtx);
1302 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
1303 INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
1305 pr_info(DRV_DESCRIPTION ", " DRV_VERSION "\n");
1306 pr_info(DRV_COPYRIGHT "\n");
1308 #ifdef CONFIG_IWLWIFI_DEBUGFS
1309 /* Create the root of iwlwifi debugfs subsystem. */
1310 iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
1312 if (!iwl_dbgfs_root)
1316 return iwl_pci_register_driver();
1318 module_init(iwl_drv_init);
1320 static void __exit iwl_drv_exit(void)
1322 iwl_pci_unregister_driver();
1324 #ifdef CONFIG_IWLWIFI_DEBUGFS
1325 debugfs_remove_recursive(iwl_dbgfs_root);
1328 module_exit(iwl_drv_exit);
1330 #ifdef CONFIG_IWLWIFI_DEBUG
1331 module_param_named(debug, iwlwifi_mod_params.debug_level, uint,
1333 MODULE_PARM_DESC(debug, "debug output mask");
1336 module_param_named(swcrypto, iwlwifi_mod_params.sw_crypto, int, S_IRUGO);
1337 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
1338 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, S_IRUGO);
1339 MODULE_PARM_DESC(11n_disable,
1340 "disable 11n functionality, bitmap: 1: full, 2: disable agg TX, 4: disable agg RX, 8 enable agg TX");
1341 module_param_named(amsdu_size_8K, iwlwifi_mod_params.amsdu_size_8K,
1343 MODULE_PARM_DESC(amsdu_size_8K, "enable 8K amsdu size (default 0)");
1344 module_param_named(fw_restart, iwlwifi_mod_params.restart_fw, bool, S_IRUGO);
1345 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error (default true)");
1347 module_param_named(antenna_coupling, iwlwifi_mod_params.ant_coupling,
1349 MODULE_PARM_DESC(antenna_coupling,
1350 "specify antenna coupling in dB (defualt: 0 dB)");
1352 module_param_named(wd_disable, iwlwifi_mod_params.wd_disable, int, S_IRUGO);
1353 MODULE_PARM_DESC(wd_disable,
1354 "Disable stuck queue watchdog timer 0=system default, 1=disable (default: 1)");
1356 module_param_named(nvm_file, iwlwifi_mod_params.nvm_file, charp, S_IRUGO);
1357 MODULE_PARM_DESC(nvm_file, "NVM file name");
1360 * set bt_coex_active to true, uCode will do kill/defer
1361 * every time the priority line is asserted (BT is sending signals on the
1362 * priority line in the PCIx).
1363 * set bt_coex_active to false, uCode will ignore the BT activity and
1364 * perform the normal operation
1366 * User might experience transmit issue on some platform due to WiFi/BT
1367 * co-exist problem. The possible behaviors are:
1368 * Able to scan and finding all the available AP
1369 * Not able to associate with any AP
1370 * On those platforms, WiFi communication can be restored by set
1371 * "bt_coex_active" module parameter to "false"
1373 * default: bt_coex_active = true (BT_COEX_ENABLE)
1375 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1377 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1379 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, S_IRUGO);
1380 MODULE_PARM_DESC(led_mode, "0=system default, "
1381 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1383 module_param_named(power_save, iwlwifi_mod_params.power_save,
1385 MODULE_PARM_DESC(power_save,
1386 "enable WiFi power management (default: disable)");
1388 module_param_named(power_level, iwlwifi_mod_params.power_level,
1390 MODULE_PARM_DESC(power_level,
1391 "default power save level (range from 1 - 5, default: 1)");