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>
69 #include "iwl-debug.h"
70 #include "iwl-trans.h"
71 #include "iwl-op-mode.h"
72 #include "iwl-agn-hw.h"
74 #include "iwl-config.h"
75 #include "iwl-modparams.h"
77 /* private includes */
78 #include "iwl-fw-file.h"
81 * struct iwl_drv - drv common data
82 * @fw: the iwl_fw structure
83 * @op_mode: the running op_mode
84 * @trans: transport layer
85 * @dev: for debug prints only
86 * @cfg: configuration struct
87 * @fw_index: firmware revision to try loading
88 * @firmware_name: composite filename of ucode file to load
89 * @request_firmware_complete: the firmware has been obtained from user space
94 struct iwl_op_mode *op_mode;
95 struct iwl_trans *trans;
97 const struct iwl_cfg *cfg;
99 int fw_index; /* firmware we're trying to load */
100 char firmware_name[25]; /* name of firmware file to load */
102 struct completion request_firmware_complete;
108 * struct fw_sec: Just for the image parsing proccess.
109 * For the fw storage we are using struct fw_desc.
112 const void *data; /* the sec data */
113 size_t size; /* section size */
114 u32 offset; /* offset of writing in the device */
117 static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
120 dma_free_coherent(drv->trans->dev, desc->len,
121 desc->v_addr, desc->p_addr);
126 static void iwl_free_fw_img(struct iwl_drv *drv, struct fw_img *img)
129 for (i = 0; i < IWL_UCODE_SECTION_MAX; i++)
130 iwl_free_fw_desc(drv, &img->sec[i]);
133 static void iwl_dealloc_ucode(struct iwl_drv *drv)
136 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
137 iwl_free_fw_img(drv, drv->fw.img + i);
140 static int iwl_alloc_fw_desc(struct iwl_drv *drv, struct fw_desc *desc,
143 if (!sec || !sec->size) {
148 desc->v_addr = dma_alloc_coherent(drv->trans->dev, sec->size,
149 &desc->p_addr, GFP_KERNEL);
153 desc->len = sec->size;
154 desc->offset = sec->offset;
155 memcpy(desc->v_addr, sec->data, sec->size);
159 static void iwl_ucode_callback(const struct firmware *ucode_raw, void *context);
161 #define UCODE_EXPERIMENTAL_INDEX 100
162 #define UCODE_EXPERIMENTAL_TAG "exp"
164 static int iwl_request_firmware(struct iwl_drv *drv, bool first)
166 const char *name_pre = drv->cfg->fw_name_pre;
170 #ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
171 drv->fw_index = UCODE_EXPERIMENTAL_INDEX;
172 strcpy(tag, UCODE_EXPERIMENTAL_TAG);
173 } else if (drv->fw_index == UCODE_EXPERIMENTAL_INDEX) {
175 drv->fw_index = drv->cfg->ucode_api_max;
176 sprintf(tag, "%d", drv->fw_index);
179 sprintf(tag, "%d", drv->fw_index);
182 if (drv->fw_index < drv->cfg->ucode_api_min) {
183 IWL_ERR(drv, "no suitable firmware found!\n");
187 sprintf(drv->firmware_name, "%s%s%s", name_pre, tag, ".ucode");
189 IWL_DEBUG_INFO(drv, "attempting to load firmware %s'%s'\n",
190 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
191 ? "EXPERIMENTAL " : "",
194 return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
196 GFP_KERNEL, drv, iwl_ucode_callback);
199 struct fw_img_parsing {
200 struct fw_sec sec[IWL_UCODE_SECTION_MAX];
205 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
207 struct fw_sec_parsing {
213 * struct iwl_tlv_calib_data - parse the default calib data from TLV
215 * @ucode_type: the uCode to which the following default calib relates.
216 * @calib: default calibrations.
218 struct iwl_tlv_calib_data {
223 struct iwl_firmware_pieces {
224 struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
226 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
227 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
231 * These functions are just to extract uCode section data from the pieces
234 static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
235 enum iwl_ucode_type type,
238 return &pieces->img[type].sec[sec];
241 static void set_sec_data(struct iwl_firmware_pieces *pieces,
242 enum iwl_ucode_type type,
246 pieces->img[type].sec[sec].data = data;
249 static void set_sec_size(struct iwl_firmware_pieces *pieces,
250 enum iwl_ucode_type type,
254 pieces->img[type].sec[sec].size = size;
257 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
258 enum iwl_ucode_type type,
261 return pieces->img[type].sec[sec].size;
264 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
265 enum iwl_ucode_type type,
269 pieces->img[type].sec[sec].offset = offset;
273 * Gets uCode section from tlv.
275 static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
276 const void *data, enum iwl_ucode_type type,
279 struct fw_img_parsing *img;
281 struct fw_sec_parsing *sec_parse;
283 if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
286 sec_parse = (struct fw_sec_parsing *)data;
288 img = &pieces->img[type];
289 sec = &img->sec[img->sec_counter];
291 sec->offset = le32_to_cpu(sec_parse->offset);
292 sec->data = sec_parse->data;
293 sec->size = size - sizeof(sec_parse->offset);
300 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
302 struct iwl_tlv_calib_data *def_calib =
303 (struct iwl_tlv_calib_data *)data;
304 u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
305 if (ucode_type >= IWL_UCODE_TYPE_MAX) {
306 IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
310 drv->fw.default_calib[ucode_type] = le64_to_cpu(def_calib->calib);
314 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
315 const struct firmware *ucode_raw,
316 struct iwl_firmware_pieces *pieces)
318 struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
319 u32 api_ver, hdr_size, build;
323 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
324 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
329 if (ucode_raw->size < hdr_size) {
330 IWL_ERR(drv, "File size too small!\n");
333 build = le32_to_cpu(ucode->u.v2.build);
334 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
335 le32_to_cpu(ucode->u.v2.inst_size));
336 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
337 le32_to_cpu(ucode->u.v2.data_size));
338 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
339 le32_to_cpu(ucode->u.v2.init_size));
340 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
341 le32_to_cpu(ucode->u.v2.init_data_size));
342 src = ucode->u.v2.data;
348 if (ucode_raw->size < hdr_size) {
349 IWL_ERR(drv, "File size too small!\n");
353 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
354 le32_to_cpu(ucode->u.v1.inst_size));
355 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
356 le32_to_cpu(ucode->u.v1.data_size));
357 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
358 le32_to_cpu(ucode->u.v1.init_size));
359 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
360 le32_to_cpu(ucode->u.v1.init_data_size));
361 src = ucode->u.v1.data;
366 sprintf(buildstr, " build %u%s", build,
367 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
372 snprintf(drv->fw.fw_version,
373 sizeof(drv->fw.fw_version),
375 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
376 IWL_UCODE_MINOR(drv->fw.ucode_ver),
377 IWL_UCODE_API(drv->fw.ucode_ver),
378 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
381 /* Verify size of file vs. image size info in file's header */
383 if (ucode_raw->size != hdr_size +
384 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
385 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
386 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
387 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
390 "uCode file size %d does not match expected size\n",
391 (int)ucode_raw->size);
396 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
397 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
398 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
399 IWLAGN_RTC_INST_LOWER_BOUND);
400 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
401 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
402 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
403 IWLAGN_RTC_DATA_LOWER_BOUND);
404 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
405 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
406 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
407 IWLAGN_RTC_INST_LOWER_BOUND);
408 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
409 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
410 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
411 IWLAGN_RTC_DATA_LOWER_BOUND);
415 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
416 const struct firmware *ucode_raw,
417 struct iwl_firmware_pieces *pieces,
418 struct iwl_ucode_capabilities *capa)
420 struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
421 struct iwl_ucode_tlv *tlv;
422 size_t len = ucode_raw->size;
425 enum iwl_ucode_tlv_type tlv_type;
430 if (len < sizeof(*ucode)) {
431 IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
435 if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
436 IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
437 le32_to_cpu(ucode->magic));
441 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
442 build = le32_to_cpu(ucode->build);
445 sprintf(buildstr, " build %u%s", build,
446 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
451 snprintf(drv->fw.fw_version,
452 sizeof(drv->fw.fw_version),
454 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
455 IWL_UCODE_MINOR(drv->fw.ucode_ver),
456 IWL_UCODE_API(drv->fw.ucode_ver),
457 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
462 len -= sizeof(*ucode);
464 while (len >= sizeof(*tlv)) {
468 tlv_len = le32_to_cpu(tlv->length);
469 tlv_type = le32_to_cpu(tlv->type);
470 tlv_data = tlv->data;
473 IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
477 len -= ALIGN(tlv_len, 4);
478 data += sizeof(*tlv) + ALIGN(tlv_len, 4);
481 case IWL_UCODE_TLV_INST:
482 set_sec_data(pieces, IWL_UCODE_REGULAR,
483 IWL_UCODE_SECTION_INST, tlv_data);
484 set_sec_size(pieces, IWL_UCODE_REGULAR,
485 IWL_UCODE_SECTION_INST, tlv_len);
486 set_sec_offset(pieces, IWL_UCODE_REGULAR,
487 IWL_UCODE_SECTION_INST,
488 IWLAGN_RTC_INST_LOWER_BOUND);
490 case IWL_UCODE_TLV_DATA:
491 set_sec_data(pieces, IWL_UCODE_REGULAR,
492 IWL_UCODE_SECTION_DATA, tlv_data);
493 set_sec_size(pieces, IWL_UCODE_REGULAR,
494 IWL_UCODE_SECTION_DATA, tlv_len);
495 set_sec_offset(pieces, IWL_UCODE_REGULAR,
496 IWL_UCODE_SECTION_DATA,
497 IWLAGN_RTC_DATA_LOWER_BOUND);
499 case IWL_UCODE_TLV_INIT:
500 set_sec_data(pieces, IWL_UCODE_INIT,
501 IWL_UCODE_SECTION_INST, tlv_data);
502 set_sec_size(pieces, IWL_UCODE_INIT,
503 IWL_UCODE_SECTION_INST, tlv_len);
504 set_sec_offset(pieces, IWL_UCODE_INIT,
505 IWL_UCODE_SECTION_INST,
506 IWLAGN_RTC_INST_LOWER_BOUND);
508 case IWL_UCODE_TLV_INIT_DATA:
509 set_sec_data(pieces, IWL_UCODE_INIT,
510 IWL_UCODE_SECTION_DATA, tlv_data);
511 set_sec_size(pieces, IWL_UCODE_INIT,
512 IWL_UCODE_SECTION_DATA, tlv_len);
513 set_sec_offset(pieces, IWL_UCODE_INIT,
514 IWL_UCODE_SECTION_DATA,
515 IWLAGN_RTC_DATA_LOWER_BOUND);
517 case IWL_UCODE_TLV_BOOT:
518 IWL_ERR(drv, "Found unexpected BOOT ucode\n");
520 case IWL_UCODE_TLV_PROBE_MAX_LEN:
521 if (tlv_len != sizeof(u32))
522 goto invalid_tlv_len;
523 capa->max_probe_length =
524 le32_to_cpup((__le32 *)tlv_data);
526 case IWL_UCODE_TLV_PAN:
528 goto invalid_tlv_len;
529 capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
531 case IWL_UCODE_TLV_FLAGS:
532 /* must be at least one u32 */
533 if (tlv_len < sizeof(u32))
534 goto invalid_tlv_len;
535 /* and a proper number of u32s */
536 if (tlv_len % sizeof(u32))
537 goto invalid_tlv_len;
539 * This driver only reads the first u32 as
540 * right now no more features are defined,
541 * if that changes then either the driver
542 * will not work with the new firmware, or
543 * it'll not take advantage of new features.
545 capa->flags = le32_to_cpup((__le32 *)tlv_data);
547 case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
548 if (tlv_len != sizeof(u32))
549 goto invalid_tlv_len;
550 pieces->init_evtlog_ptr =
551 le32_to_cpup((__le32 *)tlv_data);
553 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
554 if (tlv_len != sizeof(u32))
555 goto invalid_tlv_len;
556 pieces->init_evtlog_size =
557 le32_to_cpup((__le32 *)tlv_data);
559 case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
560 if (tlv_len != sizeof(u32))
561 goto invalid_tlv_len;
562 pieces->init_errlog_ptr =
563 le32_to_cpup((__le32 *)tlv_data);
565 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
566 if (tlv_len != sizeof(u32))
567 goto invalid_tlv_len;
568 pieces->inst_evtlog_ptr =
569 le32_to_cpup((__le32 *)tlv_data);
571 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
572 if (tlv_len != sizeof(u32))
573 goto invalid_tlv_len;
574 pieces->inst_evtlog_size =
575 le32_to_cpup((__le32 *)tlv_data);
577 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
578 if (tlv_len != sizeof(u32))
579 goto invalid_tlv_len;
580 pieces->inst_errlog_ptr =
581 le32_to_cpup((__le32 *)tlv_data);
583 case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
585 goto invalid_tlv_len;
586 drv->fw.enhance_sensitivity_table = true;
588 case IWL_UCODE_TLV_WOWLAN_INST:
589 set_sec_data(pieces, IWL_UCODE_WOWLAN,
590 IWL_UCODE_SECTION_INST, tlv_data);
591 set_sec_size(pieces, IWL_UCODE_WOWLAN,
592 IWL_UCODE_SECTION_INST, tlv_len);
593 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
594 IWL_UCODE_SECTION_INST,
595 IWLAGN_RTC_INST_LOWER_BOUND);
597 case IWL_UCODE_TLV_WOWLAN_DATA:
598 set_sec_data(pieces, IWL_UCODE_WOWLAN,
599 IWL_UCODE_SECTION_DATA, tlv_data);
600 set_sec_size(pieces, IWL_UCODE_WOWLAN,
601 IWL_UCODE_SECTION_DATA, tlv_len);
602 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
603 IWL_UCODE_SECTION_DATA,
604 IWLAGN_RTC_DATA_LOWER_BOUND);
606 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
607 if (tlv_len != sizeof(u32))
608 goto invalid_tlv_len;
609 capa->standard_phy_calibration_size =
610 le32_to_cpup((__le32 *)tlv_data);
612 case IWL_UCODE_TLV_SEC_RT:
613 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
615 drv->fw.mvm_fw = true;
617 case IWL_UCODE_TLV_SEC_INIT:
618 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
620 drv->fw.mvm_fw = true;
622 case IWL_UCODE_TLV_SEC_WOWLAN:
623 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
625 drv->fw.mvm_fw = true;
627 case IWL_UCODE_TLV_DEF_CALIB:
628 if (tlv_len != sizeof(struct iwl_tlv_calib_data))
629 goto invalid_tlv_len;
630 if (iwl_set_default_calib(drv, tlv_data))
633 case IWL_UCODE_TLV_PHY_SKU:
634 if (tlv_len != sizeof(u32))
635 goto invalid_tlv_len;
636 drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
639 IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
645 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
646 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
653 IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
655 iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
660 static int iwl_alloc_ucode(struct iwl_drv *drv,
661 struct iwl_firmware_pieces *pieces,
662 enum iwl_ucode_type type)
666 i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
668 if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
669 get_sec(pieces, type, i)))
674 static int validate_sec_sizes(struct iwl_drv *drv,
675 struct iwl_firmware_pieces *pieces,
676 const struct iwl_cfg *cfg)
678 IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
679 get_sec_size(pieces, IWL_UCODE_REGULAR,
680 IWL_UCODE_SECTION_INST));
681 IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
682 get_sec_size(pieces, IWL_UCODE_REGULAR,
683 IWL_UCODE_SECTION_DATA));
684 IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
685 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
686 IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
687 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
689 /* Verify that uCode images will fit in card's SRAM. */
690 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
691 cfg->max_inst_size) {
692 IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
693 get_sec_size(pieces, IWL_UCODE_REGULAR,
694 IWL_UCODE_SECTION_INST));
698 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
699 cfg->max_data_size) {
700 IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
701 get_sec_size(pieces, IWL_UCODE_REGULAR,
702 IWL_UCODE_SECTION_DATA));
706 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
707 cfg->max_inst_size) {
708 IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
709 get_sec_size(pieces, IWL_UCODE_INIT,
710 IWL_UCODE_SECTION_INST));
714 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
715 cfg->max_data_size) {
716 IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
717 get_sec_size(pieces, IWL_UCODE_REGULAR,
718 IWL_UCODE_SECTION_DATA));
726 * iwl_ucode_callback - callback when firmware was loaded
728 * If loaded successfully, copies the firmware into buffers
729 * for the card to fetch (via DMA).
731 static void iwl_ucode_callback(const struct firmware *ucode_raw, void *context)
733 struct iwl_drv *drv = context;
734 struct iwl_fw *fw = &drv->fw;
735 struct iwl_ucode_header *ucode;
737 struct iwl_firmware_pieces pieces;
738 const unsigned int api_max = drv->cfg->ucode_api_max;
739 unsigned int api_ok = drv->cfg->ucode_api_ok;
740 const unsigned int api_min = drv->cfg->ucode_api_min;
744 fw->ucode_capa.max_probe_length = 200;
745 fw->ucode_capa.standard_phy_calibration_size =
746 IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
751 memset(&pieces, 0, sizeof(pieces));
754 if (drv->fw_index <= api_ok)
756 "request for firmware file '%s' failed.\n",
761 IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
762 drv->firmware_name, ucode_raw->size);
764 /* Make sure that we got at least the API version number */
765 if (ucode_raw->size < 4) {
766 IWL_ERR(drv, "File size way too small!\n");
770 /* Data from ucode file: header followed by uCode images */
771 ucode = (struct iwl_ucode_header *)ucode_raw->data;
774 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, &pieces);
776 err = iwl_parse_tlv_firmware(drv, ucode_raw, &pieces,
782 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
785 * api_ver should match the api version forming part of the
786 * firmware filename ... but we don't check for that and only rely
787 * on the API version read from firmware header from here on forward
789 /* no api version check required for experimental uCode */
790 if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
791 if (api_ver < api_min || api_ver > api_max) {
793 "Driver unable to support your firmware API. "
794 "Driver supports v%u, firmware is v%u.\n",
799 if (api_ver < api_ok) {
800 if (api_ok != api_max)
801 IWL_ERR(drv, "Firmware has old API version, "
802 "expected v%u through v%u, got v%u.\n",
803 api_ok, api_max, api_ver);
805 IWL_ERR(drv, "Firmware has old API version, "
806 "expected v%u, got v%u.\n",
808 IWL_ERR(drv, "New firmware can be obtained from "
809 "http://www.intellinuxwireless.org/.\n");
813 IWL_INFO(drv, "loaded firmware version %s", drv->fw.fw_version);
816 * In mvm uCode there is no difference between data and instructions
819 if (!fw->mvm_fw && validate_sec_sizes(drv, &pieces, drv->cfg))
822 /* Allocate ucode buffers for card's bus-master loading ... */
824 /* Runtime instructions and 2 copies of data:
825 * 1) unmodified from disk
826 * 2) backup cache for save/restore during power-downs */
827 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
828 if (iwl_alloc_ucode(drv, &pieces, i))
831 /* Now that we can no longer fail, copy information */
834 * The (size - 16) / 12 formula is based on the information recorded
835 * for each event, which is of mode 1 (including timestamp) for all
836 * new microcodes that include this information.
838 fw->init_evtlog_ptr = pieces.init_evtlog_ptr;
839 if (pieces.init_evtlog_size)
840 fw->init_evtlog_size = (pieces.init_evtlog_size - 16)/12;
842 fw->init_evtlog_size =
843 drv->cfg->base_params->max_event_log_size;
844 fw->init_errlog_ptr = pieces.init_errlog_ptr;
845 fw->inst_evtlog_ptr = pieces.inst_evtlog_ptr;
846 if (pieces.inst_evtlog_size)
847 fw->inst_evtlog_size = (pieces.inst_evtlog_size - 16)/12;
849 fw->inst_evtlog_size =
850 drv->cfg->base_params->max_event_log_size;
851 fw->inst_errlog_ptr = pieces.inst_errlog_ptr;
854 * figure out the offset of chain noise reset and gain commands
855 * base on the size of standard phy calibration commands table size
857 if (fw->ucode_capa.standard_phy_calibration_size >
858 IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
859 fw->ucode_capa.standard_phy_calibration_size =
860 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
862 /* We have our copies now, allow OS release its copies */
863 release_firmware(ucode_raw);
865 drv->op_mode = iwl_dvm_ops.start(drv->trans, drv->cfg, &drv->fw);
871 * Complete the firmware request last so that
872 * a driver unbind (stop) doesn't run while we
873 * are doing the start() above.
875 complete(&drv->request_firmware_complete);
879 /* try next, if any */
880 release_firmware(ucode_raw);
881 if (iwl_request_firmware(drv, false))
886 IWL_ERR(drv, "failed to allocate pci memory\n");
887 iwl_dealloc_ucode(drv);
888 release_firmware(ucode_raw);
890 complete(&drv->request_firmware_complete);
891 device_release_driver(drv->trans->dev);
894 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans,
895 const struct iwl_cfg *cfg)
900 drv = kzalloc(sizeof(*drv), GFP_KERNEL);
905 drv->dev = trans->dev;
908 init_completion(&drv->request_firmware_complete);
910 ret = iwl_request_firmware(drv, true);
913 IWL_ERR(trans, "Couldn't request the fw\n");
921 void iwl_drv_stop(struct iwl_drv *drv)
923 wait_for_completion(&drv->request_firmware_complete);
925 /* op_mode can be NULL if its start failed */
927 iwl_op_mode_stop(drv->op_mode);
929 iwl_dealloc_ucode(drv);
935 /* shared module parameters */
936 struct iwl_mod_params iwlwifi_mod_params = {
940 .bt_coex_active = true,
941 .power_level = IWL_POWER_INDEX_1,
942 .bt_ch_announce = true,
944 /* the rest are 0 by default */
947 #ifdef CONFIG_IWLWIFI_DEBUG
948 module_param_named(debug, iwlwifi_mod_params.debug_level, uint,
950 MODULE_PARM_DESC(debug, "debug output mask");
953 module_param_named(swcrypto, iwlwifi_mod_params.sw_crypto, int, S_IRUGO);
954 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
955 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, S_IRUGO);
956 MODULE_PARM_DESC(11n_disable,
957 "disable 11n functionality, bitmap: 1: full, 2: agg TX, 4: agg RX");
958 module_param_named(amsdu_size_8K, iwlwifi_mod_params.amsdu_size_8K,
960 MODULE_PARM_DESC(amsdu_size_8K, "enable 8K amsdu size");
961 module_param_named(fw_restart, iwlwifi_mod_params.restart_fw, int, S_IRUGO);
962 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error");
964 module_param_named(antenna_coupling, iwlwifi_mod_params.ant_coupling,
966 MODULE_PARM_DESC(antenna_coupling,
967 "specify antenna coupling in dB (defualt: 0 dB)");
969 module_param_named(bt_ch_inhibition, iwlwifi_mod_params.bt_ch_announce,
971 MODULE_PARM_DESC(bt_ch_inhibition,
972 "Enable BT channel inhibition (default: enable)");
974 module_param_named(plcp_check, iwlwifi_mod_params.plcp_check, bool, S_IRUGO);
975 MODULE_PARM_DESC(plcp_check, "Check plcp health (default: 1 [enabled])");
977 module_param_named(wd_disable, iwlwifi_mod_params.wd_disable, int, S_IRUGO);
978 MODULE_PARM_DESC(wd_disable,
979 "Disable stuck queue watchdog timer 0=system default, "
980 "1=disable, 2=enable (default: 0)");
983 * set bt_coex_active to true, uCode will do kill/defer
984 * every time the priority line is asserted (BT is sending signals on the
985 * priority line in the PCIx).
986 * set bt_coex_active to false, uCode will ignore the BT activity and
987 * perform the normal operation
989 * User might experience transmit issue on some platform due to WiFi/BT
990 * co-exist problem. The possible behaviors are:
991 * Able to scan and finding all the available AP
992 * Not able to associate with any AP
993 * On those platforms, WiFi communication can be restored by set
994 * "bt_coex_active" module parameter to "false"
996 * default: bt_coex_active = true (BT_COEX_ENABLE)
998 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1000 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1002 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, S_IRUGO);
1003 MODULE_PARM_DESC(led_mode, "0=system default, "
1004 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1006 module_param_named(power_save, iwlwifi_mod_params.power_save,
1008 MODULE_PARM_DESC(power_save,
1009 "enable WiFi power management (default: disable)");
1011 module_param_named(power_level, iwlwifi_mod_params.power_level,
1013 MODULE_PARM_DESC(power_level,
1014 "default power save level (range from 1 - 5, default: 1)");
1016 module_param_named(auto_agg, iwlwifi_mod_params.auto_agg,
1018 MODULE_PARM_DESC(auto_agg,
1019 "enable agg w/o check traffic load (default: enable)");
1021 module_param_named(5ghz_disable, iwlwifi_mod_params.disable_5ghz,
1023 MODULE_PARM_DESC(5ghz_disable, "disable 5GHz band (default: 0 [enabled])");