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"
80 /******************************************************************************
84 ******************************************************************************/
87 * module name, copyright, version, etc.
89 #define DRV_DESCRIPTION "Intel(R) Wireless WiFi driver for Linux"
91 #ifdef CONFIG_IWLWIFI_DEBUG
97 #define DRV_VERSION IWLWIFI_VERSION VD
99 MODULE_DESCRIPTION(DRV_DESCRIPTION
);
100 MODULE_VERSION(DRV_VERSION
);
101 MODULE_AUTHOR(DRV_COPYRIGHT
" " DRV_AUTHOR
);
102 MODULE_LICENSE("GPL");
105 * struct iwl_drv - drv common data
106 * @list: list of drv structures using this opmode
107 * @fw: the iwl_fw structure
108 * @op_mode: the running op_mode
109 * @trans: transport layer
110 * @dev: for debug prints only
111 * @cfg: configuration struct
112 * @fw_index: firmware revision to try loading
113 * @firmware_name: composite filename of ucode file to load
114 * @request_firmware_complete: the firmware has been obtained from user space
117 struct list_head list
;
120 struct iwl_op_mode
*op_mode
;
121 struct iwl_trans
*trans
;
123 const struct iwl_cfg
*cfg
;
125 int fw_index
; /* firmware we're trying to load */
126 char firmware_name
[25]; /* name of firmware file to load */
128 struct completion request_firmware_complete
;
131 #define DVM_OP_MODE 0
132 #define MVM_OP_MODE 1
134 /* Protects the table contents, i.e. the ops pointer & drv list */
135 static struct mutex iwlwifi_opmode_table_mtx
;
136 static struct iwlwifi_opmode_table
{
137 const char *name
; /* name: iwldvm, iwlmvm, etc */
138 const struct iwl_op_mode_ops
*ops
; /* pointer to op_mode ops */
139 struct list_head drv
; /* list of devices using this op_mode */
140 } iwlwifi_opmode_table
[] = { /* ops set when driver is initialized */
141 { .name
= "iwldvm", .ops
= NULL
},
142 { .name
= "iwlmvm", .ops
= NULL
},
146 * struct fw_sec: Just for the image parsing proccess.
147 * For the fw storage we are using struct fw_desc.
150 const void *data
; /* the sec data */
151 size_t size
; /* section size */
152 u32 offset
; /* offset of writing in the device */
155 static void iwl_free_fw_desc(struct iwl_drv
*drv
, struct fw_desc
*desc
)
158 dma_free_coherent(drv
->trans
->dev
, desc
->len
,
159 desc
->v_addr
, desc
->p_addr
);
164 static void iwl_free_fw_img(struct iwl_drv
*drv
, struct fw_img
*img
)
167 for (i
= 0; i
< IWL_UCODE_SECTION_MAX
; i
++)
168 iwl_free_fw_desc(drv
, &img
->sec
[i
]);
171 static void iwl_dealloc_ucode(struct iwl_drv
*drv
)
174 for (i
= 0; i
< IWL_UCODE_TYPE_MAX
; i
++)
175 iwl_free_fw_img(drv
, drv
->fw
.img
+ i
);
178 static int iwl_alloc_fw_desc(struct iwl_drv
*drv
, struct fw_desc
*desc
,
181 if (!sec
|| !sec
->size
) {
186 desc
->v_addr
= dma_alloc_coherent(drv
->trans
->dev
, sec
->size
,
187 &desc
->p_addr
, GFP_KERNEL
);
191 desc
->len
= sec
->size
;
192 desc
->offset
= sec
->offset
;
193 memcpy(desc
->v_addr
, sec
->data
, sec
->size
);
197 static void iwl_ucode_callback(const struct firmware
*ucode_raw
, void *context
);
199 #define UCODE_EXPERIMENTAL_INDEX 100
200 #define UCODE_EXPERIMENTAL_TAG "exp"
202 static int iwl_request_firmware(struct iwl_drv
*drv
, bool first
)
204 const char *name_pre
= drv
->cfg
->fw_name_pre
;
208 #ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
209 drv
->fw_index
= UCODE_EXPERIMENTAL_INDEX
;
210 strcpy(tag
, UCODE_EXPERIMENTAL_TAG
);
211 } else if (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
) {
213 drv
->fw_index
= drv
->cfg
->ucode_api_max
;
214 sprintf(tag
, "%d", drv
->fw_index
);
217 sprintf(tag
, "%d", drv
->fw_index
);
220 if (drv
->fw_index
< drv
->cfg
->ucode_api_min
) {
221 IWL_ERR(drv
, "no suitable firmware found!\n");
225 sprintf(drv
->firmware_name
, "%s%s%s", name_pre
, tag
, ".ucode");
227 IWL_DEBUG_INFO(drv
, "attempting to load firmware %s'%s'\n",
228 (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
)
229 ? "EXPERIMENTAL " : "",
232 return request_firmware_nowait(THIS_MODULE
, 1, drv
->firmware_name
,
234 GFP_KERNEL
, drv
, iwl_ucode_callback
);
237 struct fw_img_parsing
{
238 struct fw_sec sec
[IWL_UCODE_SECTION_MAX
];
243 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
245 struct fw_sec_parsing
{
251 * struct iwl_tlv_calib_data - parse the default calib data from TLV
253 * @ucode_type: the uCode to which the following default calib relates.
254 * @calib: default calibrations.
256 struct iwl_tlv_calib_data
{
261 struct iwl_firmware_pieces
{
262 struct fw_img_parsing img
[IWL_UCODE_TYPE_MAX
];
264 u32 init_evtlog_ptr
, init_evtlog_size
, init_errlog_ptr
;
265 u32 inst_evtlog_ptr
, inst_evtlog_size
, inst_errlog_ptr
;
269 * These functions are just to extract uCode section data from the pieces
272 static struct fw_sec
*get_sec(struct iwl_firmware_pieces
*pieces
,
273 enum iwl_ucode_type type
,
276 return &pieces
->img
[type
].sec
[sec
];
279 static void set_sec_data(struct iwl_firmware_pieces
*pieces
,
280 enum iwl_ucode_type type
,
284 pieces
->img
[type
].sec
[sec
].data
= data
;
287 static void set_sec_size(struct iwl_firmware_pieces
*pieces
,
288 enum iwl_ucode_type type
,
292 pieces
->img
[type
].sec
[sec
].size
= size
;
295 static size_t get_sec_size(struct iwl_firmware_pieces
*pieces
,
296 enum iwl_ucode_type type
,
299 return pieces
->img
[type
].sec
[sec
].size
;
302 static void set_sec_offset(struct iwl_firmware_pieces
*pieces
,
303 enum iwl_ucode_type type
,
307 pieces
->img
[type
].sec
[sec
].offset
= offset
;
311 * Gets uCode section from tlv.
313 static int iwl_store_ucode_sec(struct iwl_firmware_pieces
*pieces
,
314 const void *data
, enum iwl_ucode_type type
,
317 struct fw_img_parsing
*img
;
319 struct fw_sec_parsing
*sec_parse
;
321 if (WARN_ON(!pieces
|| !data
|| type
>= IWL_UCODE_TYPE_MAX
))
324 sec_parse
= (struct fw_sec_parsing
*)data
;
326 img
= &pieces
->img
[type
];
327 sec
= &img
->sec
[img
->sec_counter
];
329 sec
->offset
= le32_to_cpu(sec_parse
->offset
);
330 sec
->data
= sec_parse
->data
;
331 sec
->size
= size
- sizeof(sec_parse
->offset
);
338 static int iwl_set_default_calib(struct iwl_drv
*drv
, const u8
*data
)
340 struct iwl_tlv_calib_data
*def_calib
=
341 (struct iwl_tlv_calib_data
*)data
;
342 u32 ucode_type
= le32_to_cpu(def_calib
->ucode_type
);
343 if (ucode_type
>= IWL_UCODE_TYPE_MAX
) {
344 IWL_ERR(drv
, "Wrong ucode_type %u for default calibration.\n",
348 drv
->fw
.default_calib
[ucode_type
] = le64_to_cpu(def_calib
->calib
);
352 static int iwl_parse_v1_v2_firmware(struct iwl_drv
*drv
,
353 const struct firmware
*ucode_raw
,
354 struct iwl_firmware_pieces
*pieces
)
356 struct iwl_ucode_header
*ucode
= (void *)ucode_raw
->data
;
357 u32 api_ver
, hdr_size
, build
;
361 drv
->fw
.ucode_ver
= le32_to_cpu(ucode
->ver
);
362 api_ver
= IWL_UCODE_API(drv
->fw
.ucode_ver
);
367 if (ucode_raw
->size
< hdr_size
) {
368 IWL_ERR(drv
, "File size too small!\n");
371 build
= le32_to_cpu(ucode
->u
.v2
.build
);
372 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
,
373 le32_to_cpu(ucode
->u
.v2
.inst_size
));
374 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
,
375 le32_to_cpu(ucode
->u
.v2
.data_size
));
376 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
,
377 le32_to_cpu(ucode
->u
.v2
.init_size
));
378 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
,
379 le32_to_cpu(ucode
->u
.v2
.init_data_size
));
380 src
= ucode
->u
.v2
.data
;
386 if (ucode_raw
->size
< hdr_size
) {
387 IWL_ERR(drv
, "File size too small!\n");
391 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
,
392 le32_to_cpu(ucode
->u
.v1
.inst_size
));
393 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
,
394 le32_to_cpu(ucode
->u
.v1
.data_size
));
395 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
,
396 le32_to_cpu(ucode
->u
.v1
.init_size
));
397 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
,
398 le32_to_cpu(ucode
->u
.v1
.init_data_size
));
399 src
= ucode
->u
.v1
.data
;
404 sprintf(buildstr
, " build %u%s", build
,
405 (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
)
410 snprintf(drv
->fw
.fw_version
,
411 sizeof(drv
->fw
.fw_version
),
413 IWL_UCODE_MAJOR(drv
->fw
.ucode_ver
),
414 IWL_UCODE_MINOR(drv
->fw
.ucode_ver
),
415 IWL_UCODE_API(drv
->fw
.ucode_ver
),
416 IWL_UCODE_SERIAL(drv
->fw
.ucode_ver
),
419 /* Verify size of file vs. image size info in file's header */
421 if (ucode_raw
->size
!= hdr_size
+
422 get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
) +
423 get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
) +
424 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
) +
425 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
)) {
428 "uCode file size %d does not match expected size\n",
429 (int)ucode_raw
->size
);
434 set_sec_data(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
, src
);
435 src
+= get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
);
436 set_sec_offset(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
,
437 IWLAGN_RTC_INST_LOWER_BOUND
);
438 set_sec_data(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
, src
);
439 src
+= get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
);
440 set_sec_offset(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
,
441 IWLAGN_RTC_DATA_LOWER_BOUND
);
442 set_sec_data(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
, src
);
443 src
+= get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
);
444 set_sec_offset(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
,
445 IWLAGN_RTC_INST_LOWER_BOUND
);
446 set_sec_data(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
, src
);
447 src
+= get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
);
448 set_sec_offset(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
,
449 IWLAGN_RTC_DATA_LOWER_BOUND
);
453 static int iwl_parse_tlv_firmware(struct iwl_drv
*drv
,
454 const struct firmware
*ucode_raw
,
455 struct iwl_firmware_pieces
*pieces
,
456 struct iwl_ucode_capabilities
*capa
)
458 struct iwl_tlv_ucode_header
*ucode
= (void *)ucode_raw
->data
;
459 struct iwl_ucode_tlv
*tlv
;
460 size_t len
= ucode_raw
->size
;
463 enum iwl_ucode_tlv_type tlv_type
;
468 if (len
< sizeof(*ucode
)) {
469 IWL_ERR(drv
, "uCode has invalid length: %zd\n", len
);
473 if (ucode
->magic
!= cpu_to_le32(IWL_TLV_UCODE_MAGIC
)) {
474 IWL_ERR(drv
, "invalid uCode magic: 0X%x\n",
475 le32_to_cpu(ucode
->magic
));
479 drv
->fw
.ucode_ver
= le32_to_cpu(ucode
->ver
);
480 build
= le32_to_cpu(ucode
->build
);
483 sprintf(buildstr
, " build %u%s", build
,
484 (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
)
489 snprintf(drv
->fw
.fw_version
,
490 sizeof(drv
->fw
.fw_version
),
492 IWL_UCODE_MAJOR(drv
->fw
.ucode_ver
),
493 IWL_UCODE_MINOR(drv
->fw
.ucode_ver
),
494 IWL_UCODE_API(drv
->fw
.ucode_ver
),
495 IWL_UCODE_SERIAL(drv
->fw
.ucode_ver
),
500 len
-= sizeof(*ucode
);
502 while (len
>= sizeof(*tlv
)) {
506 tlv_len
= le32_to_cpu(tlv
->length
);
507 tlv_type
= le32_to_cpu(tlv
->type
);
508 tlv_data
= tlv
->data
;
511 IWL_ERR(drv
, "invalid TLV len: %zd/%u\n",
515 len
-= ALIGN(tlv_len
, 4);
516 data
+= sizeof(*tlv
) + ALIGN(tlv_len
, 4);
519 case IWL_UCODE_TLV_INST
:
520 set_sec_data(pieces
, IWL_UCODE_REGULAR
,
521 IWL_UCODE_SECTION_INST
, tlv_data
);
522 set_sec_size(pieces
, IWL_UCODE_REGULAR
,
523 IWL_UCODE_SECTION_INST
, tlv_len
);
524 set_sec_offset(pieces
, IWL_UCODE_REGULAR
,
525 IWL_UCODE_SECTION_INST
,
526 IWLAGN_RTC_INST_LOWER_BOUND
);
528 case IWL_UCODE_TLV_DATA
:
529 set_sec_data(pieces
, IWL_UCODE_REGULAR
,
530 IWL_UCODE_SECTION_DATA
, tlv_data
);
531 set_sec_size(pieces
, IWL_UCODE_REGULAR
,
532 IWL_UCODE_SECTION_DATA
, tlv_len
);
533 set_sec_offset(pieces
, IWL_UCODE_REGULAR
,
534 IWL_UCODE_SECTION_DATA
,
535 IWLAGN_RTC_DATA_LOWER_BOUND
);
537 case IWL_UCODE_TLV_INIT
:
538 set_sec_data(pieces
, IWL_UCODE_INIT
,
539 IWL_UCODE_SECTION_INST
, tlv_data
);
540 set_sec_size(pieces
, IWL_UCODE_INIT
,
541 IWL_UCODE_SECTION_INST
, tlv_len
);
542 set_sec_offset(pieces
, IWL_UCODE_INIT
,
543 IWL_UCODE_SECTION_INST
,
544 IWLAGN_RTC_INST_LOWER_BOUND
);
546 case IWL_UCODE_TLV_INIT_DATA
:
547 set_sec_data(pieces
, IWL_UCODE_INIT
,
548 IWL_UCODE_SECTION_DATA
, tlv_data
);
549 set_sec_size(pieces
, IWL_UCODE_INIT
,
550 IWL_UCODE_SECTION_DATA
, tlv_len
);
551 set_sec_offset(pieces
, IWL_UCODE_INIT
,
552 IWL_UCODE_SECTION_DATA
,
553 IWLAGN_RTC_DATA_LOWER_BOUND
);
555 case IWL_UCODE_TLV_BOOT
:
556 IWL_ERR(drv
, "Found unexpected BOOT ucode\n");
558 case IWL_UCODE_TLV_PROBE_MAX_LEN
:
559 if (tlv_len
!= sizeof(u32
))
560 goto invalid_tlv_len
;
561 capa
->max_probe_length
=
562 le32_to_cpup((__le32
*)tlv_data
);
564 case IWL_UCODE_TLV_PAN
:
566 goto invalid_tlv_len
;
567 capa
->flags
|= IWL_UCODE_TLV_FLAGS_PAN
;
569 case IWL_UCODE_TLV_FLAGS
:
570 /* must be at least one u32 */
571 if (tlv_len
< sizeof(u32
))
572 goto invalid_tlv_len
;
573 /* and a proper number of u32s */
574 if (tlv_len
% sizeof(u32
))
575 goto invalid_tlv_len
;
577 * This driver only reads the first u32 as
578 * right now no more features are defined,
579 * if that changes then either the driver
580 * will not work with the new firmware, or
581 * it'll not take advantage of new features.
583 capa
->flags
= le32_to_cpup((__le32
*)tlv_data
);
585 case IWL_UCODE_TLV_INIT_EVTLOG_PTR
:
586 if (tlv_len
!= sizeof(u32
))
587 goto invalid_tlv_len
;
588 pieces
->init_evtlog_ptr
=
589 le32_to_cpup((__le32
*)tlv_data
);
591 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE
:
592 if (tlv_len
!= sizeof(u32
))
593 goto invalid_tlv_len
;
594 pieces
->init_evtlog_size
=
595 le32_to_cpup((__le32
*)tlv_data
);
597 case IWL_UCODE_TLV_INIT_ERRLOG_PTR
:
598 if (tlv_len
!= sizeof(u32
))
599 goto invalid_tlv_len
;
600 pieces
->init_errlog_ptr
=
601 le32_to_cpup((__le32
*)tlv_data
);
603 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR
:
604 if (tlv_len
!= sizeof(u32
))
605 goto invalid_tlv_len
;
606 pieces
->inst_evtlog_ptr
=
607 le32_to_cpup((__le32
*)tlv_data
);
609 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE
:
610 if (tlv_len
!= sizeof(u32
))
611 goto invalid_tlv_len
;
612 pieces
->inst_evtlog_size
=
613 le32_to_cpup((__le32
*)tlv_data
);
615 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR
:
616 if (tlv_len
!= sizeof(u32
))
617 goto invalid_tlv_len
;
618 pieces
->inst_errlog_ptr
=
619 le32_to_cpup((__le32
*)tlv_data
);
621 case IWL_UCODE_TLV_ENHANCE_SENS_TBL
:
623 goto invalid_tlv_len
;
624 drv
->fw
.enhance_sensitivity_table
= true;
626 case IWL_UCODE_TLV_WOWLAN_INST
:
627 set_sec_data(pieces
, IWL_UCODE_WOWLAN
,
628 IWL_UCODE_SECTION_INST
, tlv_data
);
629 set_sec_size(pieces
, IWL_UCODE_WOWLAN
,
630 IWL_UCODE_SECTION_INST
, tlv_len
);
631 set_sec_offset(pieces
, IWL_UCODE_WOWLAN
,
632 IWL_UCODE_SECTION_INST
,
633 IWLAGN_RTC_INST_LOWER_BOUND
);
635 case IWL_UCODE_TLV_WOWLAN_DATA
:
636 set_sec_data(pieces
, IWL_UCODE_WOWLAN
,
637 IWL_UCODE_SECTION_DATA
, tlv_data
);
638 set_sec_size(pieces
, IWL_UCODE_WOWLAN
,
639 IWL_UCODE_SECTION_DATA
, tlv_len
);
640 set_sec_offset(pieces
, IWL_UCODE_WOWLAN
,
641 IWL_UCODE_SECTION_DATA
,
642 IWLAGN_RTC_DATA_LOWER_BOUND
);
644 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE
:
645 if (tlv_len
!= sizeof(u32
))
646 goto invalid_tlv_len
;
647 capa
->standard_phy_calibration_size
=
648 le32_to_cpup((__le32
*)tlv_data
);
650 case IWL_UCODE_TLV_SEC_RT
:
651 iwl_store_ucode_sec(pieces
, tlv_data
, IWL_UCODE_REGULAR
,
653 drv
->fw
.mvm_fw
= true;
655 case IWL_UCODE_TLV_SEC_INIT
:
656 iwl_store_ucode_sec(pieces
, tlv_data
, IWL_UCODE_INIT
,
658 drv
->fw
.mvm_fw
= true;
660 case IWL_UCODE_TLV_SEC_WOWLAN
:
661 iwl_store_ucode_sec(pieces
, tlv_data
, IWL_UCODE_WOWLAN
,
663 drv
->fw
.mvm_fw
= true;
665 case IWL_UCODE_TLV_DEF_CALIB
:
666 if (tlv_len
!= sizeof(struct iwl_tlv_calib_data
))
667 goto invalid_tlv_len
;
668 if (iwl_set_default_calib(drv
, tlv_data
))
671 case IWL_UCODE_TLV_PHY_SKU
:
672 if (tlv_len
!= sizeof(u32
))
673 goto invalid_tlv_len
;
674 drv
->fw
.phy_config
= le32_to_cpup((__le32
*)tlv_data
);
677 IWL_DEBUG_INFO(drv
, "unknown TLV: %d\n", tlv_type
);
683 IWL_ERR(drv
, "invalid TLV after parsing: %zd\n", len
);
684 iwl_print_hex_dump(drv
, IWL_DL_FW
, (u8
*)data
, len
);
691 IWL_ERR(drv
, "TLV %d has invalid size: %u\n", tlv_type
, tlv_len
);
693 iwl_print_hex_dump(drv
, IWL_DL_FW
, tlv_data
, tlv_len
);
698 static int iwl_alloc_ucode(struct iwl_drv
*drv
,
699 struct iwl_firmware_pieces
*pieces
,
700 enum iwl_ucode_type type
)
704 i
< IWL_UCODE_SECTION_MAX
&& get_sec_size(pieces
, type
, i
);
706 if (iwl_alloc_fw_desc(drv
, &(drv
->fw
.img
[type
].sec
[i
]),
707 get_sec(pieces
, type
, i
)))
712 static int validate_sec_sizes(struct iwl_drv
*drv
,
713 struct iwl_firmware_pieces
*pieces
,
714 const struct iwl_cfg
*cfg
)
716 IWL_DEBUG_INFO(drv
, "f/w package hdr runtime inst size = %Zd\n",
717 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
718 IWL_UCODE_SECTION_INST
));
719 IWL_DEBUG_INFO(drv
, "f/w package hdr runtime data size = %Zd\n",
720 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
721 IWL_UCODE_SECTION_DATA
));
722 IWL_DEBUG_INFO(drv
, "f/w package hdr init inst size = %Zd\n",
723 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
));
724 IWL_DEBUG_INFO(drv
, "f/w package hdr init data size = %Zd\n",
725 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
));
727 /* Verify that uCode images will fit in card's SRAM. */
728 if (get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
) >
729 cfg
->max_inst_size
) {
730 IWL_ERR(drv
, "uCode instr len %Zd too large to fit in\n",
731 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
732 IWL_UCODE_SECTION_INST
));
736 if (get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
) >
737 cfg
->max_data_size
) {
738 IWL_ERR(drv
, "uCode data len %Zd too large to fit in\n",
739 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
740 IWL_UCODE_SECTION_DATA
));
744 if (get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
) >
745 cfg
->max_inst_size
) {
746 IWL_ERR(drv
, "uCode init instr len %Zd too large to fit in\n",
747 get_sec_size(pieces
, IWL_UCODE_INIT
,
748 IWL_UCODE_SECTION_INST
));
752 if (get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
) >
753 cfg
->max_data_size
) {
754 IWL_ERR(drv
, "uCode init data len %Zd too large to fit in\n",
755 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
756 IWL_UCODE_SECTION_DATA
));
763 * iwl_ucode_callback - callback when firmware was loaded
765 * If loaded successfully, copies the firmware into buffers
766 * for the card to fetch (via DMA).
768 static void iwl_ucode_callback(const struct firmware
*ucode_raw
, void *context
)
770 struct iwl_drv
*drv
= context
;
771 struct iwl_fw
*fw
= &drv
->fw
;
772 struct iwl_ucode_header
*ucode
;
773 struct iwlwifi_opmode_table
*op
;
775 struct iwl_firmware_pieces pieces
;
776 const unsigned int api_max
= drv
->cfg
->ucode_api_max
;
777 unsigned int api_ok
= drv
->cfg
->ucode_api_ok
;
778 const unsigned int api_min
= drv
->cfg
->ucode_api_min
;
781 bool load_module
= false;
783 fw
->ucode_capa
.max_probe_length
= 200;
784 fw
->ucode_capa
.standard_phy_calibration_size
=
785 IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE
;
790 memset(&pieces
, 0, sizeof(pieces
));
793 if (drv
->fw_index
<= api_ok
)
795 "request for firmware file '%s' failed.\n",
800 IWL_DEBUG_INFO(drv
, "Loaded firmware file '%s' (%zd bytes).\n",
801 drv
->firmware_name
, ucode_raw
->size
);
803 /* Make sure that we got at least the API version number */
804 if (ucode_raw
->size
< 4) {
805 IWL_ERR(drv
, "File size way too small!\n");
809 /* Data from ucode file: header followed by uCode images */
810 ucode
= (struct iwl_ucode_header
*)ucode_raw
->data
;
813 err
= iwl_parse_v1_v2_firmware(drv
, ucode_raw
, &pieces
);
815 err
= iwl_parse_tlv_firmware(drv
, ucode_raw
, &pieces
,
821 api_ver
= IWL_UCODE_API(drv
->fw
.ucode_ver
);
824 * api_ver should match the api version forming part of the
825 * firmware filename ... but we don't check for that and only rely
826 * on the API version read from firmware header from here on forward
828 /* no api version check required for experimental uCode */
829 if (drv
->fw_index
!= UCODE_EXPERIMENTAL_INDEX
) {
830 if (api_ver
< api_min
|| api_ver
> api_max
) {
832 "Driver unable to support your firmware API. "
833 "Driver supports v%u, firmware is v%u.\n",
838 if (api_ver
< api_ok
) {
839 if (api_ok
!= api_max
)
840 IWL_ERR(drv
, "Firmware has old API version, "
841 "expected v%u through v%u, got v%u.\n",
842 api_ok
, api_max
, api_ver
);
844 IWL_ERR(drv
, "Firmware has old API version, "
845 "expected v%u, got v%u.\n",
847 IWL_ERR(drv
, "New firmware can be obtained from "
848 "http://www.intellinuxwireless.org/.\n");
852 IWL_INFO(drv
, "loaded firmware version %s", drv
->fw
.fw_version
);
855 * In mvm uCode there is no difference between data and instructions
858 if (!fw
->mvm_fw
&& validate_sec_sizes(drv
, &pieces
, drv
->cfg
))
861 /* Allocate ucode buffers for card's bus-master loading ... */
863 /* Runtime instructions and 2 copies of data:
864 * 1) unmodified from disk
865 * 2) backup cache for save/restore during power-downs */
866 for (i
= 0; i
< IWL_UCODE_TYPE_MAX
; i
++)
867 if (iwl_alloc_ucode(drv
, &pieces
, i
))
870 /* Now that we can no longer fail, copy information */
873 * The (size - 16) / 12 formula is based on the information recorded
874 * for each event, which is of mode 1 (including timestamp) for all
875 * new microcodes that include this information.
877 fw
->init_evtlog_ptr
= pieces
.init_evtlog_ptr
;
878 if (pieces
.init_evtlog_size
)
879 fw
->init_evtlog_size
= (pieces
.init_evtlog_size
- 16)/12;
881 fw
->init_evtlog_size
=
882 drv
->cfg
->base_params
->max_event_log_size
;
883 fw
->init_errlog_ptr
= pieces
.init_errlog_ptr
;
884 fw
->inst_evtlog_ptr
= pieces
.inst_evtlog_ptr
;
885 if (pieces
.inst_evtlog_size
)
886 fw
->inst_evtlog_size
= (pieces
.inst_evtlog_size
- 16)/12;
888 fw
->inst_evtlog_size
=
889 drv
->cfg
->base_params
->max_event_log_size
;
890 fw
->inst_errlog_ptr
= pieces
.inst_errlog_ptr
;
893 * figure out the offset of chain noise reset and gain commands
894 * base on the size of standard phy calibration commands table size
896 if (fw
->ucode_capa
.standard_phy_calibration_size
>
897 IWL_MAX_PHY_CALIBRATE_TBL_SIZE
)
898 fw
->ucode_capa
.standard_phy_calibration_size
=
899 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE
;
901 /* We have our copies now, allow OS release its copies */
902 release_firmware(ucode_raw
);
904 mutex_lock(&iwlwifi_opmode_table_mtx
);
905 op
= &iwlwifi_opmode_table
[DVM_OP_MODE
];
907 /* add this device to the list of devices using this op_mode */
908 list_add_tail(&drv
->list
, &op
->drv
);
911 const struct iwl_op_mode_ops
*ops
= op
->ops
;
912 drv
->op_mode
= ops
->start(drv
->trans
, drv
->cfg
, &drv
->fw
);
915 mutex_unlock(&iwlwifi_opmode_table_mtx
);
921 mutex_unlock(&iwlwifi_opmode_table_mtx
);
924 * Complete the firmware request last so that
925 * a driver unbind (stop) doesn't run while we
926 * are doing the start() above.
928 complete(&drv
->request_firmware_complete
);
931 * Load the module last so we don't block anything
932 * else from proceeding if the module fails to load
936 request_module("%s", op
->name
);
940 /* try next, if any */
941 release_firmware(ucode_raw
);
942 if (iwl_request_firmware(drv
, false))
947 IWL_ERR(drv
, "failed to allocate pci memory\n");
948 iwl_dealloc_ucode(drv
);
949 release_firmware(ucode_raw
);
951 complete(&drv
->request_firmware_complete
);
952 device_release_driver(drv
->trans
->dev
);
955 struct iwl_drv
*iwl_drv_start(struct iwl_trans
*trans
,
956 const struct iwl_cfg
*cfg
)
961 drv
= kzalloc(sizeof(*drv
), GFP_KERNEL
);
966 drv
->dev
= trans
->dev
;
969 init_completion(&drv
->request_firmware_complete
);
970 INIT_LIST_HEAD(&drv
->list
);
972 ret
= iwl_request_firmware(drv
, true);
975 IWL_ERR(trans
, "Couldn't request the fw\n");
983 void iwl_drv_stop(struct iwl_drv
*drv
)
985 wait_for_completion(&drv
->request_firmware_complete
);
987 /* op_mode can be NULL if its start failed */
989 iwl_op_mode_stop(drv
->op_mode
);
991 iwl_dealloc_ucode(drv
);
993 mutex_lock(&iwlwifi_opmode_table_mtx
);
995 * List is empty (this item wasn't added)
996 * when firmware loading failed -- in that
997 * case we can't remove it from any list.
999 if (!list_empty(&drv
->list
))
1000 list_del(&drv
->list
);
1001 mutex_unlock(&iwlwifi_opmode_table_mtx
);
1007 /* shared module parameters */
1008 struct iwl_mod_params iwlwifi_mod_params
= {
1012 .bt_coex_active
= true,
1013 .power_level
= IWL_POWER_INDEX_1
,
1014 .bt_ch_announce
= true,
1017 /* the rest are 0 by default */
1019 EXPORT_SYMBOL_GPL(iwlwifi_mod_params
);
1021 int iwl_opmode_register(const char *name
, const struct iwl_op_mode_ops
*ops
)
1024 struct iwl_drv
*drv
;
1026 mutex_lock(&iwlwifi_opmode_table_mtx
);
1027 for (i
= 0; i
< ARRAY_SIZE(iwlwifi_opmode_table
); i
++) {
1028 if (strcmp(iwlwifi_opmode_table
[i
].name
, name
))
1030 iwlwifi_opmode_table
[i
].ops
= ops
;
1031 list_for_each_entry(drv
, &iwlwifi_opmode_table
[i
].drv
, list
)
1032 drv
->op_mode
= ops
->start(drv
->trans
, drv
->cfg
,
1034 mutex_unlock(&iwlwifi_opmode_table_mtx
);
1037 mutex_unlock(&iwlwifi_opmode_table_mtx
);
1040 EXPORT_SYMBOL_GPL(iwl_opmode_register
);
1042 void iwl_opmode_deregister(const char *name
)
1045 struct iwl_drv
*drv
;
1047 mutex_lock(&iwlwifi_opmode_table_mtx
);
1048 for (i
= 0; i
< ARRAY_SIZE(iwlwifi_opmode_table
); i
++) {
1049 if (strcmp(iwlwifi_opmode_table
[i
].name
, name
))
1051 iwlwifi_opmode_table
[i
].ops
= NULL
;
1053 /* call the stop routine for all devices */
1054 list_for_each_entry(drv
, &iwlwifi_opmode_table
[i
].drv
, list
) {
1056 iwl_op_mode_stop(drv
->op_mode
);
1057 drv
->op_mode
= NULL
;
1060 mutex_unlock(&iwlwifi_opmode_table_mtx
);
1063 mutex_unlock(&iwlwifi_opmode_table_mtx
);
1065 EXPORT_SYMBOL_GPL(iwl_opmode_deregister
);
1067 static int __init
iwl_drv_init(void)
1071 mutex_init(&iwlwifi_opmode_table_mtx
);
1073 for (i
= 0; i
< ARRAY_SIZE(iwlwifi_opmode_table
); i
++)
1074 INIT_LIST_HEAD(&iwlwifi_opmode_table
[i
].drv
);
1076 pr_info(DRV_DESCRIPTION
", " DRV_VERSION
"\n");
1077 pr_info(DRV_COPYRIGHT
"\n");
1079 return iwl_pci_register_driver();
1081 module_init(iwl_drv_init
);
1083 static void __exit
iwl_drv_exit(void)
1085 iwl_pci_unregister_driver();
1087 module_exit(iwl_drv_exit
);
1089 #ifdef CONFIG_IWLWIFI_DEBUG
1090 module_param_named(debug
, iwlwifi_mod_params
.debug_level
, uint
,
1092 MODULE_PARM_DESC(debug
, "debug output mask");
1095 module_param_named(swcrypto
, iwlwifi_mod_params
.sw_crypto
, int, S_IRUGO
);
1096 MODULE_PARM_DESC(swcrypto
, "using crypto in software (default 0 [hardware])");
1097 module_param_named(11n_disable
, iwlwifi_mod_params
.disable_11n
, uint
, S_IRUGO
);
1098 MODULE_PARM_DESC(11n_disable
,
1099 "disable 11n functionality, bitmap: 1: full, 2: agg TX, 4: agg RX");
1100 module_param_named(amsdu_size_8K
, iwlwifi_mod_params
.amsdu_size_8K
,
1102 MODULE_PARM_DESC(amsdu_size_8K
, "enable 8K amsdu size");
1103 module_param_named(fw_restart
, iwlwifi_mod_params
.restart_fw
, int, S_IRUGO
);
1104 MODULE_PARM_DESC(fw_restart
, "restart firmware in case of error");
1106 module_param_named(antenna_coupling
, iwlwifi_mod_params
.ant_coupling
,
1108 MODULE_PARM_DESC(antenna_coupling
,
1109 "specify antenna coupling in dB (defualt: 0 dB)");
1111 module_param_named(bt_ch_inhibition
, iwlwifi_mod_params
.bt_ch_announce
,
1113 MODULE_PARM_DESC(bt_ch_inhibition
,
1114 "Enable BT channel inhibition (default: enable)");
1116 module_param_named(plcp_check
, iwlwifi_mod_params
.plcp_check
, bool, S_IRUGO
);
1117 MODULE_PARM_DESC(plcp_check
, "Check plcp health (default: 1 [enabled])");
1119 module_param_named(wd_disable
, iwlwifi_mod_params
.wd_disable
, int, S_IRUGO
);
1120 MODULE_PARM_DESC(wd_disable
,
1121 "Disable stuck queue watchdog timer 0=system default, "
1122 "1=disable, 2=enable (default: 0)");
1125 * set bt_coex_active to true, uCode will do kill/defer
1126 * every time the priority line is asserted (BT is sending signals on the
1127 * priority line in the PCIx).
1128 * set bt_coex_active to false, uCode will ignore the BT activity and
1129 * perform the normal operation
1131 * User might experience transmit issue on some platform due to WiFi/BT
1132 * co-exist problem. The possible behaviors are:
1133 * Able to scan and finding all the available AP
1134 * Not able to associate with any AP
1135 * On those platforms, WiFi communication can be restored by set
1136 * "bt_coex_active" module parameter to "false"
1138 * default: bt_coex_active = true (BT_COEX_ENABLE)
1140 module_param_named(bt_coex_active
, iwlwifi_mod_params
.bt_coex_active
,
1142 MODULE_PARM_DESC(bt_coex_active
, "enable wifi/bt co-exist (default: enable)");
1144 module_param_named(led_mode
, iwlwifi_mod_params
.led_mode
, int, S_IRUGO
);
1145 MODULE_PARM_DESC(led_mode
, "0=system default, "
1146 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1148 module_param_named(power_save
, iwlwifi_mod_params
.power_save
,
1150 MODULE_PARM_DESC(power_save
,
1151 "enable WiFi power management (default: disable)");
1153 module_param_named(power_level
, iwlwifi_mod_params
.power_level
,
1155 MODULE_PARM_DESC(power_level
,
1156 "default power save level (range from 1 - 5, default: 1)");
1158 module_param_named(auto_agg
, iwlwifi_mod_params
.auto_agg
,
1160 MODULE_PARM_DESC(auto_agg
,
1161 "enable agg w/o check traffic load (default: enable)");
1163 module_param_named(5ghz_disable
, iwlwifi_mod_params
.disable_5ghz
,
1165 MODULE_PARM_DESC(5ghz_disable
, "disable 5GHz band (default: 0 [enabled])");