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-trans.h"
70 #include "iwl-op-mode.h"
71 #include "iwl-agn-hw.h"
73 #include "iwl-config.h"
74 #include "iwl-modparams.h"
76 /* private includes */
77 #include "iwl-fw-file.h"
80 * struct iwl_drv - drv common data
81 * @fw: the iwl_fw structure
82 * @op_mode: the running op_mode
83 * @trans: transport layer
84 * @dev: for debug prints only
85 * @cfg: configuration struct
86 * @fw_index: firmware revision to try loading
87 * @firmware_name: composite filename of ucode file to load
88 * @request_firmware_complete: the firmware has been obtained from user space
93 struct iwl_op_mode
*op_mode
;
94 struct iwl_trans
*trans
;
96 const struct iwl_cfg
*cfg
;
98 int fw_index
; /* firmware we're trying to load */
99 char firmware_name
[25]; /* name of firmware file to load */
101 struct completion request_firmware_complete
;
107 * struct fw_sec: Just for the image parsing proccess.
108 * For the fw storage we are using struct fw_desc.
111 const void *data
; /* the sec data */
112 size_t size
; /* section size */
113 u32 offset
; /* offset of writing in the device */
116 static void iwl_free_fw_desc(struct iwl_drv
*drv
, struct fw_desc
*desc
)
119 dma_free_coherent(drv
->trans
->dev
, desc
->len
,
120 desc
->v_addr
, desc
->p_addr
);
125 static void iwl_free_fw_img(struct iwl_drv
*drv
, struct fw_img
*img
)
128 for (i
= 0; i
< IWL_UCODE_SECTION_MAX
; i
++)
129 iwl_free_fw_desc(drv
, &img
->sec
[i
]);
132 static void iwl_dealloc_ucode(struct iwl_drv
*drv
)
135 for (i
= 0; i
< IWL_UCODE_TYPE_MAX
; i
++)
136 iwl_free_fw_img(drv
, drv
->fw
.img
+ i
);
139 static int iwl_alloc_fw_desc(struct iwl_drv
*drv
, struct fw_desc
*desc
,
142 if (!sec
|| !sec
->size
) {
147 desc
->v_addr
= dma_alloc_coherent(drv
->trans
->dev
, sec
->size
,
148 &desc
->p_addr
, GFP_KERNEL
);
152 desc
->len
= sec
->size
;
153 desc
->offset
= sec
->offset
;
154 memcpy(desc
->v_addr
, sec
->data
, sec
->size
);
158 static void iwl_ucode_callback(const struct firmware
*ucode_raw
, void *context
);
160 #define UCODE_EXPERIMENTAL_INDEX 100
161 #define UCODE_EXPERIMENTAL_TAG "exp"
163 static int iwl_request_firmware(struct iwl_drv
*drv
, bool first
)
165 const char *name_pre
= drv
->cfg
->fw_name_pre
;
169 #ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
170 drv
->fw_index
= UCODE_EXPERIMENTAL_INDEX
;
171 strcpy(tag
, UCODE_EXPERIMENTAL_TAG
);
172 } else if (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
) {
174 drv
->fw_index
= drv
->cfg
->ucode_api_max
;
175 sprintf(tag
, "%d", drv
->fw_index
);
178 sprintf(tag
, "%d", drv
->fw_index
);
181 if (drv
->fw_index
< drv
->cfg
->ucode_api_min
) {
182 IWL_ERR(drv
, "no suitable firmware found!\n");
186 sprintf(drv
->firmware_name
, "%s%s%s", name_pre
, tag
, ".ucode");
188 IWL_DEBUG_INFO(drv
, "attempting to load firmware %s'%s'\n",
189 (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
)
190 ? "EXPERIMENTAL " : "",
193 return request_firmware_nowait(THIS_MODULE
, 1, drv
->firmware_name
,
195 GFP_KERNEL
, drv
, iwl_ucode_callback
);
198 struct fw_img_parsing
{
199 struct fw_sec sec
[IWL_UCODE_SECTION_MAX
];
204 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
206 struct fw_sec_parsing
{
212 * struct iwl_tlv_calib_data - parse the default calib data from TLV
214 * @ucode_type: the uCode to which the following default calib relates.
215 * @calib: default calibrations.
217 struct iwl_tlv_calib_data
{
222 struct iwl_firmware_pieces
{
223 struct fw_img_parsing img
[IWL_UCODE_TYPE_MAX
];
225 u32 init_evtlog_ptr
, init_evtlog_size
, init_errlog_ptr
;
226 u32 inst_evtlog_ptr
, inst_evtlog_size
, inst_errlog_ptr
;
230 * These functions are just to extract uCode section data from the pieces
233 static struct fw_sec
*get_sec(struct iwl_firmware_pieces
*pieces
,
234 enum iwl_ucode_type type
,
237 return &pieces
->img
[type
].sec
[sec
];
240 static void set_sec_data(struct iwl_firmware_pieces
*pieces
,
241 enum iwl_ucode_type type
,
245 pieces
->img
[type
].sec
[sec
].data
= data
;
248 static void set_sec_size(struct iwl_firmware_pieces
*pieces
,
249 enum iwl_ucode_type type
,
253 pieces
->img
[type
].sec
[sec
].size
= size
;
256 static size_t get_sec_size(struct iwl_firmware_pieces
*pieces
,
257 enum iwl_ucode_type type
,
260 return pieces
->img
[type
].sec
[sec
].size
;
263 static void set_sec_offset(struct iwl_firmware_pieces
*pieces
,
264 enum iwl_ucode_type type
,
268 pieces
->img
[type
].sec
[sec
].offset
= offset
;
272 * Gets uCode section from tlv.
274 static int iwl_store_ucode_sec(struct iwl_firmware_pieces
*pieces
,
275 const void *data
, enum iwl_ucode_type type
,
278 struct fw_img_parsing
*img
;
280 struct fw_sec_parsing
*sec_parse
;
282 if (WARN_ON(!pieces
|| !data
|| type
>= IWL_UCODE_TYPE_MAX
))
285 sec_parse
= (struct fw_sec_parsing
*)data
;
287 img
= &pieces
->img
[type
];
288 sec
= &img
->sec
[img
->sec_counter
];
290 sec
->offset
= le32_to_cpu(sec_parse
->offset
);
291 sec
->data
= sec_parse
->data
;
292 sec
->size
= size
- sizeof(sec_parse
->offset
);
299 static int iwl_set_default_calib(struct iwl_drv
*drv
, const u8
*data
)
301 struct iwl_tlv_calib_data
*def_calib
=
302 (struct iwl_tlv_calib_data
*)data
;
303 u32 ucode_type
= le32_to_cpu(def_calib
->ucode_type
);
304 if (ucode_type
>= IWL_UCODE_TYPE_MAX
) {
305 IWL_ERR(drv
, "Wrong ucode_type %u for default calibration.\n",
309 drv
->fw
.default_calib
[ucode_type
] = le64_to_cpu(def_calib
->calib
);
313 static int iwl_parse_v1_v2_firmware(struct iwl_drv
*drv
,
314 const struct firmware
*ucode_raw
,
315 struct iwl_firmware_pieces
*pieces
)
317 struct iwl_ucode_header
*ucode
= (void *)ucode_raw
->data
;
318 u32 api_ver
, hdr_size
, build
;
322 drv
->fw
.ucode_ver
= le32_to_cpu(ucode
->ver
);
323 api_ver
= IWL_UCODE_API(drv
->fw
.ucode_ver
);
328 if (ucode_raw
->size
< hdr_size
) {
329 IWL_ERR(drv
, "File size too small!\n");
332 build
= le32_to_cpu(ucode
->u
.v2
.build
);
333 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
,
334 le32_to_cpu(ucode
->u
.v2
.inst_size
));
335 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
,
336 le32_to_cpu(ucode
->u
.v2
.data_size
));
337 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
,
338 le32_to_cpu(ucode
->u
.v2
.init_size
));
339 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
,
340 le32_to_cpu(ucode
->u
.v2
.init_data_size
));
341 src
= ucode
->u
.v2
.data
;
347 if (ucode_raw
->size
< hdr_size
) {
348 IWL_ERR(drv
, "File size too small!\n");
352 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
,
353 le32_to_cpu(ucode
->u
.v1
.inst_size
));
354 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
,
355 le32_to_cpu(ucode
->u
.v1
.data_size
));
356 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
,
357 le32_to_cpu(ucode
->u
.v1
.init_size
));
358 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
,
359 le32_to_cpu(ucode
->u
.v1
.init_data_size
));
360 src
= ucode
->u
.v1
.data
;
365 sprintf(buildstr
, " build %u%s", build
,
366 (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
)
371 snprintf(drv
->fw
.fw_version
,
372 sizeof(drv
->fw
.fw_version
),
374 IWL_UCODE_MAJOR(drv
->fw
.ucode_ver
),
375 IWL_UCODE_MINOR(drv
->fw
.ucode_ver
),
376 IWL_UCODE_API(drv
->fw
.ucode_ver
),
377 IWL_UCODE_SERIAL(drv
->fw
.ucode_ver
),
380 /* Verify size of file vs. image size info in file's header */
382 if (ucode_raw
->size
!= hdr_size
+
383 get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
) +
384 get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
) +
385 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
) +
386 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
)) {
389 "uCode file size %d does not match expected size\n",
390 (int)ucode_raw
->size
);
395 set_sec_data(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
, src
);
396 src
+= get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
);
397 set_sec_offset(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
,
398 IWLAGN_RTC_INST_LOWER_BOUND
);
399 set_sec_data(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
, src
);
400 src
+= get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
);
401 set_sec_offset(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
,
402 IWLAGN_RTC_DATA_LOWER_BOUND
);
403 set_sec_data(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
, src
);
404 src
+= get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
);
405 set_sec_offset(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
,
406 IWLAGN_RTC_INST_LOWER_BOUND
);
407 set_sec_data(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
, src
);
408 src
+= get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
);
409 set_sec_offset(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
,
410 IWLAGN_RTC_DATA_LOWER_BOUND
);
414 static int iwl_parse_tlv_firmware(struct iwl_drv
*drv
,
415 const struct firmware
*ucode_raw
,
416 struct iwl_firmware_pieces
*pieces
,
417 struct iwl_ucode_capabilities
*capa
)
419 struct iwl_tlv_ucode_header
*ucode
= (void *)ucode_raw
->data
;
420 struct iwl_ucode_tlv
*tlv
;
421 size_t len
= ucode_raw
->size
;
424 enum iwl_ucode_tlv_type tlv_type
;
429 if (len
< sizeof(*ucode
)) {
430 IWL_ERR(drv
, "uCode has invalid length: %zd\n", len
);
434 if (ucode
->magic
!= cpu_to_le32(IWL_TLV_UCODE_MAGIC
)) {
435 IWL_ERR(drv
, "invalid uCode magic: 0X%x\n",
436 le32_to_cpu(ucode
->magic
));
440 drv
->fw
.ucode_ver
= le32_to_cpu(ucode
->ver
);
441 build
= le32_to_cpu(ucode
->build
);
444 sprintf(buildstr
, " build %u%s", build
,
445 (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
)
450 snprintf(drv
->fw
.fw_version
,
451 sizeof(drv
->fw
.fw_version
),
453 IWL_UCODE_MAJOR(drv
->fw
.ucode_ver
),
454 IWL_UCODE_MINOR(drv
->fw
.ucode_ver
),
455 IWL_UCODE_API(drv
->fw
.ucode_ver
),
456 IWL_UCODE_SERIAL(drv
->fw
.ucode_ver
),
461 len
-= sizeof(*ucode
);
463 while (len
>= sizeof(*tlv
)) {
467 tlv_len
= le32_to_cpu(tlv
->length
);
468 tlv_type
= le32_to_cpu(tlv
->type
);
469 tlv_data
= tlv
->data
;
472 IWL_ERR(drv
, "invalid TLV len: %zd/%u\n",
476 len
-= ALIGN(tlv_len
, 4);
477 data
+= sizeof(*tlv
) + ALIGN(tlv_len
, 4);
480 case IWL_UCODE_TLV_INST
:
481 set_sec_data(pieces
, IWL_UCODE_REGULAR
,
482 IWL_UCODE_SECTION_INST
, tlv_data
);
483 set_sec_size(pieces
, IWL_UCODE_REGULAR
,
484 IWL_UCODE_SECTION_INST
, tlv_len
);
485 set_sec_offset(pieces
, IWL_UCODE_REGULAR
,
486 IWL_UCODE_SECTION_INST
,
487 IWLAGN_RTC_INST_LOWER_BOUND
);
489 case IWL_UCODE_TLV_DATA
:
490 set_sec_data(pieces
, IWL_UCODE_REGULAR
,
491 IWL_UCODE_SECTION_DATA
, tlv_data
);
492 set_sec_size(pieces
, IWL_UCODE_REGULAR
,
493 IWL_UCODE_SECTION_DATA
, tlv_len
);
494 set_sec_offset(pieces
, IWL_UCODE_REGULAR
,
495 IWL_UCODE_SECTION_DATA
,
496 IWLAGN_RTC_DATA_LOWER_BOUND
);
498 case IWL_UCODE_TLV_INIT
:
499 set_sec_data(pieces
, IWL_UCODE_INIT
,
500 IWL_UCODE_SECTION_INST
, tlv_data
);
501 set_sec_size(pieces
, IWL_UCODE_INIT
,
502 IWL_UCODE_SECTION_INST
, tlv_len
);
503 set_sec_offset(pieces
, IWL_UCODE_INIT
,
504 IWL_UCODE_SECTION_INST
,
505 IWLAGN_RTC_INST_LOWER_BOUND
);
507 case IWL_UCODE_TLV_INIT_DATA
:
508 set_sec_data(pieces
, IWL_UCODE_INIT
,
509 IWL_UCODE_SECTION_DATA
, tlv_data
);
510 set_sec_size(pieces
, IWL_UCODE_INIT
,
511 IWL_UCODE_SECTION_DATA
, tlv_len
);
512 set_sec_offset(pieces
, IWL_UCODE_INIT
,
513 IWL_UCODE_SECTION_DATA
,
514 IWLAGN_RTC_DATA_LOWER_BOUND
);
516 case IWL_UCODE_TLV_BOOT
:
517 IWL_ERR(drv
, "Found unexpected BOOT ucode\n");
519 case IWL_UCODE_TLV_PROBE_MAX_LEN
:
520 if (tlv_len
!= sizeof(u32
))
521 goto invalid_tlv_len
;
522 capa
->max_probe_length
=
523 le32_to_cpup((__le32
*)tlv_data
);
525 case IWL_UCODE_TLV_PAN
:
527 goto invalid_tlv_len
;
528 capa
->flags
|= IWL_UCODE_TLV_FLAGS_PAN
;
530 case IWL_UCODE_TLV_FLAGS
:
531 /* must be at least one u32 */
532 if (tlv_len
< sizeof(u32
))
533 goto invalid_tlv_len
;
534 /* and a proper number of u32s */
535 if (tlv_len
% sizeof(u32
))
536 goto invalid_tlv_len
;
538 * This driver only reads the first u32 as
539 * right now no more features are defined,
540 * if that changes then either the driver
541 * will not work with the new firmware, or
542 * it'll not take advantage of new features.
544 capa
->flags
= le32_to_cpup((__le32
*)tlv_data
);
546 case IWL_UCODE_TLV_INIT_EVTLOG_PTR
:
547 if (tlv_len
!= sizeof(u32
))
548 goto invalid_tlv_len
;
549 pieces
->init_evtlog_ptr
=
550 le32_to_cpup((__le32
*)tlv_data
);
552 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE
:
553 if (tlv_len
!= sizeof(u32
))
554 goto invalid_tlv_len
;
555 pieces
->init_evtlog_size
=
556 le32_to_cpup((__le32
*)tlv_data
);
558 case IWL_UCODE_TLV_INIT_ERRLOG_PTR
:
559 if (tlv_len
!= sizeof(u32
))
560 goto invalid_tlv_len
;
561 pieces
->init_errlog_ptr
=
562 le32_to_cpup((__le32
*)tlv_data
);
564 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR
:
565 if (tlv_len
!= sizeof(u32
))
566 goto invalid_tlv_len
;
567 pieces
->inst_evtlog_ptr
=
568 le32_to_cpup((__le32
*)tlv_data
);
570 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE
:
571 if (tlv_len
!= sizeof(u32
))
572 goto invalid_tlv_len
;
573 pieces
->inst_evtlog_size
=
574 le32_to_cpup((__le32
*)tlv_data
);
576 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR
:
577 if (tlv_len
!= sizeof(u32
))
578 goto invalid_tlv_len
;
579 pieces
->inst_errlog_ptr
=
580 le32_to_cpup((__le32
*)tlv_data
);
582 case IWL_UCODE_TLV_ENHANCE_SENS_TBL
:
584 goto invalid_tlv_len
;
585 drv
->fw
.enhance_sensitivity_table
= true;
587 case IWL_UCODE_TLV_WOWLAN_INST
:
588 set_sec_data(pieces
, IWL_UCODE_WOWLAN
,
589 IWL_UCODE_SECTION_INST
, tlv_data
);
590 set_sec_size(pieces
, IWL_UCODE_WOWLAN
,
591 IWL_UCODE_SECTION_INST
, tlv_len
);
592 set_sec_offset(pieces
, IWL_UCODE_WOWLAN
,
593 IWL_UCODE_SECTION_INST
,
594 IWLAGN_RTC_INST_LOWER_BOUND
);
596 case IWL_UCODE_TLV_WOWLAN_DATA
:
597 set_sec_data(pieces
, IWL_UCODE_WOWLAN
,
598 IWL_UCODE_SECTION_DATA
, tlv_data
);
599 set_sec_size(pieces
, IWL_UCODE_WOWLAN
,
600 IWL_UCODE_SECTION_DATA
, tlv_len
);
601 set_sec_offset(pieces
, IWL_UCODE_WOWLAN
,
602 IWL_UCODE_SECTION_DATA
,
603 IWLAGN_RTC_DATA_LOWER_BOUND
);
605 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE
:
606 if (tlv_len
!= sizeof(u32
))
607 goto invalid_tlv_len
;
608 capa
->standard_phy_calibration_size
=
609 le32_to_cpup((__le32
*)tlv_data
);
611 case IWL_UCODE_TLV_SEC_RT
:
612 iwl_store_ucode_sec(pieces
, tlv_data
, IWL_UCODE_REGULAR
,
614 drv
->fw
.mvm_fw
= true;
616 case IWL_UCODE_TLV_SEC_INIT
:
617 iwl_store_ucode_sec(pieces
, tlv_data
, IWL_UCODE_INIT
,
619 drv
->fw
.mvm_fw
= true;
621 case IWL_UCODE_TLV_SEC_WOWLAN
:
622 iwl_store_ucode_sec(pieces
, tlv_data
, IWL_UCODE_WOWLAN
,
624 drv
->fw
.mvm_fw
= true;
626 case IWL_UCODE_TLV_DEF_CALIB
:
627 if (tlv_len
!= sizeof(struct iwl_tlv_calib_data
))
628 goto invalid_tlv_len
;
629 if (iwl_set_default_calib(drv
, tlv_data
))
632 case IWL_UCODE_TLV_PHY_SKU
:
633 if (tlv_len
!= sizeof(u32
))
634 goto invalid_tlv_len
;
635 drv
->fw
.phy_config
= le32_to_cpup((__le32
*)tlv_data
);
638 IWL_DEBUG_INFO(drv
, "unknown TLV: %d\n", tlv_type
);
644 IWL_ERR(drv
, "invalid TLV after parsing: %zd\n", len
);
645 iwl_print_hex_dump(drv
, IWL_DL_FW
, (u8
*)data
, len
);
652 IWL_ERR(drv
, "TLV %d has invalid size: %u\n", tlv_type
, tlv_len
);
654 iwl_print_hex_dump(drv
, IWL_DL_FW
, tlv_data
, tlv_len
);
659 static int alloc_pci_desc(struct iwl_drv
*drv
,
660 struct iwl_firmware_pieces
*pieces
,
661 enum iwl_ucode_type type
)
665 i
< IWL_UCODE_SECTION_MAX
&& get_sec_size(pieces
, type
, i
);
667 if (iwl_alloc_fw_desc(drv
, &(drv
->fw
.img
[type
].sec
[i
]),
668 get_sec(pieces
, type
, i
)))
673 static int validate_sec_sizes(struct iwl_drv
*drv
,
674 struct iwl_firmware_pieces
*pieces
,
675 const struct iwl_cfg
*cfg
)
677 IWL_DEBUG_INFO(drv
, "f/w package hdr runtime inst size = %Zd\n",
678 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
679 IWL_UCODE_SECTION_INST
));
680 IWL_DEBUG_INFO(drv
, "f/w package hdr runtime data size = %Zd\n",
681 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
682 IWL_UCODE_SECTION_DATA
));
683 IWL_DEBUG_INFO(drv
, "f/w package hdr init inst size = %Zd\n",
684 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
));
685 IWL_DEBUG_INFO(drv
, "f/w package hdr init data size = %Zd\n",
686 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
));
688 /* Verify that uCode images will fit in card's SRAM. */
689 if (get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
) >
690 cfg
->max_inst_size
) {
691 IWL_ERR(drv
, "uCode instr len %Zd too large to fit in\n",
692 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
693 IWL_UCODE_SECTION_INST
));
697 if (get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
) >
698 cfg
->max_data_size
) {
699 IWL_ERR(drv
, "uCode data len %Zd too large to fit in\n",
700 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
701 IWL_UCODE_SECTION_DATA
));
705 if (get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
) >
706 cfg
->max_inst_size
) {
707 IWL_ERR(drv
, "uCode init instr len %Zd too large to fit in\n",
708 get_sec_size(pieces
, IWL_UCODE_INIT
,
709 IWL_UCODE_SECTION_INST
));
713 if (get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
) >
714 cfg
->max_data_size
) {
715 IWL_ERR(drv
, "uCode init data len %Zd too large to fit in\n",
716 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
717 IWL_UCODE_SECTION_DATA
));
725 * iwl_ucode_callback - callback when firmware was loaded
727 * If loaded successfully, copies the firmware into buffers
728 * for the card to fetch (via DMA).
730 static void iwl_ucode_callback(const struct firmware
*ucode_raw
, void *context
)
732 struct iwl_drv
*drv
= context
;
733 struct iwl_fw
*fw
= &drv
->fw
;
734 struct iwl_ucode_header
*ucode
;
736 struct iwl_firmware_pieces pieces
;
737 const unsigned int api_max
= drv
->cfg
->ucode_api_max
;
738 unsigned int api_ok
= drv
->cfg
->ucode_api_ok
;
739 const unsigned int api_min
= drv
->cfg
->ucode_api_min
;
743 fw
->ucode_capa
.max_probe_length
= 200;
744 fw
->ucode_capa
.standard_phy_calibration_size
=
745 IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE
;
750 memset(&pieces
, 0, sizeof(pieces
));
753 if (drv
->fw_index
<= api_ok
)
755 "request for firmware file '%s' failed.\n",
760 IWL_DEBUG_INFO(drv
, "Loaded firmware file '%s' (%zd bytes).\n",
761 drv
->firmware_name
, ucode_raw
->size
);
763 /* Make sure that we got at least the API version number */
764 if (ucode_raw
->size
< 4) {
765 IWL_ERR(drv
, "File size way too small!\n");
769 /* Data from ucode file: header followed by uCode images */
770 ucode
= (struct iwl_ucode_header
*)ucode_raw
->data
;
773 err
= iwl_parse_v1_v2_firmware(drv
, ucode_raw
, &pieces
);
775 err
= iwl_parse_tlv_firmware(drv
, ucode_raw
, &pieces
,
781 api_ver
= IWL_UCODE_API(drv
->fw
.ucode_ver
);
784 * api_ver should match the api version forming part of the
785 * firmware filename ... but we don't check for that and only rely
786 * on the API version read from firmware header from here on forward
788 /* no api version check required for experimental uCode */
789 if (drv
->fw_index
!= UCODE_EXPERIMENTAL_INDEX
) {
790 if (api_ver
< api_min
|| api_ver
> api_max
) {
792 "Driver unable to support your firmware API. "
793 "Driver supports v%u, firmware is v%u.\n",
798 if (api_ver
< api_ok
) {
799 if (api_ok
!= api_max
)
800 IWL_ERR(drv
, "Firmware has old API version, "
801 "expected v%u through v%u, got v%u.\n",
802 api_ok
, api_max
, api_ver
);
804 IWL_ERR(drv
, "Firmware has old API version, "
805 "expected v%u, got v%u.\n",
807 IWL_ERR(drv
, "New firmware can be obtained from "
808 "http://www.intellinuxwireless.org/.\n");
812 IWL_INFO(drv
, "loaded firmware version %s", drv
->fw
.fw_version
);
815 * In mvm uCode there is no difference between data and instructions
818 if (!fw
->mvm_fw
&& validate_sec_sizes(drv
, &pieces
, drv
->cfg
))
821 /* Allocate ucode buffers for card's bus-master loading ... */
823 /* Runtime instructions and 2 copies of data:
824 * 1) unmodified from disk
825 * 2) backup cache for save/restore during power-downs */
826 for (i
= 0; i
< IWL_UCODE_TYPE_MAX
; i
++)
827 if (alloc_pci_desc(drv
, &pieces
, i
))
830 /* Now that we can no longer fail, copy information */
833 * The (size - 16) / 12 formula is based on the information recorded
834 * for each event, which is of mode 1 (including timestamp) for all
835 * new microcodes that include this information.
837 fw
->init_evtlog_ptr
= pieces
.init_evtlog_ptr
;
838 if (pieces
.init_evtlog_size
)
839 fw
->init_evtlog_size
= (pieces
.init_evtlog_size
- 16)/12;
841 fw
->init_evtlog_size
=
842 drv
->cfg
->base_params
->max_event_log_size
;
843 fw
->init_errlog_ptr
= pieces
.init_errlog_ptr
;
844 fw
->inst_evtlog_ptr
= pieces
.inst_evtlog_ptr
;
845 if (pieces
.inst_evtlog_size
)
846 fw
->inst_evtlog_size
= (pieces
.inst_evtlog_size
- 16)/12;
848 fw
->inst_evtlog_size
=
849 drv
->cfg
->base_params
->max_event_log_size
;
850 fw
->inst_errlog_ptr
= pieces
.inst_errlog_ptr
;
853 * figure out the offset of chain noise reset and gain commands
854 * base on the size of standard phy calibration commands table size
856 if (fw
->ucode_capa
.standard_phy_calibration_size
>
857 IWL_MAX_PHY_CALIBRATE_TBL_SIZE
)
858 fw
->ucode_capa
.standard_phy_calibration_size
=
859 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE
;
861 /* We have our copies now, allow OS release its copies */
862 release_firmware(ucode_raw
);
863 complete(&drv
->request_firmware_complete
);
865 drv
->op_mode
= iwl_dvm_ops
.start(drv
->trans
, drv
->cfg
, &drv
->fw
);
873 /* try next, if any */
874 release_firmware(ucode_raw
);
875 if (iwl_request_firmware(drv
, false))
880 IWL_ERR(drv
, "failed to allocate pci memory\n");
881 iwl_dealloc_ucode(drv
);
882 release_firmware(ucode_raw
);
884 complete(&drv
->request_firmware_complete
);
885 device_release_driver(drv
->trans
->dev
);
888 struct iwl_drv
*iwl_drv_start(struct iwl_trans
*trans
,
889 const struct iwl_cfg
*cfg
)
894 drv
= kzalloc(sizeof(*drv
), GFP_KERNEL
);
896 dev_printk(KERN_ERR
, trans
->dev
, "Couldn't allocate iwl_drv");
900 drv
->dev
= trans
->dev
;
903 init_completion(&drv
->request_firmware_complete
);
905 ret
= iwl_request_firmware(drv
, true);
908 dev_printk(KERN_ERR
, trans
->dev
, "Couldn't request the fw");
916 void iwl_drv_stop(struct iwl_drv
*drv
)
918 wait_for_completion(&drv
->request_firmware_complete
);
920 /* op_mode can be NULL if its start failed */
922 iwl_op_mode_stop(drv
->op_mode
);
924 iwl_dealloc_ucode(drv
);
930 /* shared module parameters */
931 struct iwl_mod_params iwlwifi_mod_params
= {
935 .bt_coex_active
= true,
936 .power_level
= IWL_POWER_INDEX_1
,
937 .bt_ch_announce
= true,
939 /* the rest are 0 by default */
942 #ifdef CONFIG_IWLWIFI_DEBUG
943 module_param_named(debug
, iwlwifi_mod_params
.debug_level
, uint
,
945 MODULE_PARM_DESC(debug
, "debug output mask");
948 module_param_named(swcrypto
, iwlwifi_mod_params
.sw_crypto
, int, S_IRUGO
);
949 MODULE_PARM_DESC(swcrypto
, "using crypto in software (default 0 [hardware])");
950 module_param_named(11n_disable
, iwlwifi_mod_params
.disable_11n
, uint
, S_IRUGO
);
951 MODULE_PARM_DESC(11n_disable
,
952 "disable 11n functionality, bitmap: 1: full, 2: agg TX, 4: agg RX");
953 module_param_named(amsdu_size_8K
, iwlwifi_mod_params
.amsdu_size_8K
,
955 MODULE_PARM_DESC(amsdu_size_8K
, "enable 8K amsdu size");
956 module_param_named(fw_restart
, iwlwifi_mod_params
.restart_fw
, int, S_IRUGO
);
957 MODULE_PARM_DESC(fw_restart
, "restart firmware in case of error");
959 module_param_named(antenna_coupling
, iwlwifi_mod_params
.ant_coupling
,
961 MODULE_PARM_DESC(antenna_coupling
,
962 "specify antenna coupling in dB (defualt: 0 dB)");
964 module_param_named(bt_ch_inhibition
, iwlwifi_mod_params
.bt_ch_announce
,
966 MODULE_PARM_DESC(bt_ch_inhibition
,
967 "Enable BT channel inhibition (default: enable)");
969 module_param_named(plcp_check
, iwlwifi_mod_params
.plcp_check
, bool, S_IRUGO
);
970 MODULE_PARM_DESC(plcp_check
, "Check plcp health (default: 1 [enabled])");
972 module_param_named(wd_disable
, iwlwifi_mod_params
.wd_disable
, int, S_IRUGO
);
973 MODULE_PARM_DESC(wd_disable
,
974 "Disable stuck queue watchdog timer 0=system default, "
975 "1=disable, 2=enable (default: 0)");
978 * set bt_coex_active to true, uCode will do kill/defer
979 * every time the priority line is asserted (BT is sending signals on the
980 * priority line in the PCIx).
981 * set bt_coex_active to false, uCode will ignore the BT activity and
982 * perform the normal operation
984 * User might experience transmit issue on some platform due to WiFi/BT
985 * co-exist problem. The possible behaviors are:
986 * Able to scan and finding all the available AP
987 * Not able to associate with any AP
988 * On those platforms, WiFi communication can be restored by set
989 * "bt_coex_active" module parameter to "false"
991 * default: bt_coex_active = true (BT_COEX_ENABLE)
993 module_param_named(bt_coex_active
, iwlwifi_mod_params
.bt_coex_active
,
995 MODULE_PARM_DESC(bt_coex_active
, "enable wifi/bt co-exist (default: enable)");
997 module_param_named(led_mode
, iwlwifi_mod_params
.led_mode
, int, S_IRUGO
);
998 MODULE_PARM_DESC(led_mode
, "0=system default, "
999 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1001 module_param_named(power_save
, iwlwifi_mod_params
.power_save
,
1003 MODULE_PARM_DESC(power_save
,
1004 "enable WiFi power management (default: disable)");
1006 module_param_named(power_level
, iwlwifi_mod_params
.power_level
,
1008 MODULE_PARM_DESC(power_level
,
1009 "default power save level (range from 1 - 5, default: 1)");
1011 module_param_named(auto_agg
, iwlwifi_mod_params
.auto_agg
,
1013 MODULE_PARM_DESC(auto_agg
,
1014 "enable agg w/o check traffic load (default: enable)");