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_req_fw_callback(const struct firmware
*ucode_raw
,
200 #define UCODE_EXPERIMENTAL_INDEX 100
201 #define UCODE_EXPERIMENTAL_TAG "exp"
203 static int iwl_request_firmware(struct iwl_drv
*drv
, bool first
)
205 const char *name_pre
= drv
->cfg
->fw_name_pre
;
209 #ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
210 drv
->fw_index
= UCODE_EXPERIMENTAL_INDEX
;
211 strcpy(tag
, UCODE_EXPERIMENTAL_TAG
);
212 } else if (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
) {
214 drv
->fw_index
= drv
->cfg
->ucode_api_max
;
215 sprintf(tag
, "%d", drv
->fw_index
);
218 sprintf(tag
, "%d", drv
->fw_index
);
221 if (drv
->fw_index
< drv
->cfg
->ucode_api_min
) {
222 IWL_ERR(drv
, "no suitable firmware found!\n");
226 sprintf(drv
->firmware_name
, "%s%s%s", name_pre
, tag
, ".ucode");
228 IWL_DEBUG_INFO(drv
, "attempting to load firmware %s'%s'\n",
229 (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
)
230 ? "EXPERIMENTAL " : "",
233 return request_firmware_nowait(THIS_MODULE
, 1, drv
->firmware_name
,
235 GFP_KERNEL
, drv
, iwl_req_fw_callback
);
238 struct fw_img_parsing
{
239 struct fw_sec sec
[IWL_UCODE_SECTION_MAX
];
244 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
246 struct fw_sec_parsing
{
252 * struct iwl_tlv_calib_data - parse the default calib data from TLV
254 * @ucode_type: the uCode to which the following default calib relates.
255 * @calib: default calibrations.
257 struct iwl_tlv_calib_data
{
262 struct iwl_firmware_pieces
{
263 struct fw_img_parsing img
[IWL_UCODE_TYPE_MAX
];
265 u32 init_evtlog_ptr
, init_evtlog_size
, init_errlog_ptr
;
266 u32 inst_evtlog_ptr
, inst_evtlog_size
, inst_errlog_ptr
;
270 * These functions are just to extract uCode section data from the pieces
273 static struct fw_sec
*get_sec(struct iwl_firmware_pieces
*pieces
,
274 enum iwl_ucode_type type
,
277 return &pieces
->img
[type
].sec
[sec
];
280 static void set_sec_data(struct iwl_firmware_pieces
*pieces
,
281 enum iwl_ucode_type type
,
285 pieces
->img
[type
].sec
[sec
].data
= data
;
288 static void set_sec_size(struct iwl_firmware_pieces
*pieces
,
289 enum iwl_ucode_type type
,
293 pieces
->img
[type
].sec
[sec
].size
= size
;
296 static size_t get_sec_size(struct iwl_firmware_pieces
*pieces
,
297 enum iwl_ucode_type type
,
300 return pieces
->img
[type
].sec
[sec
].size
;
303 static void set_sec_offset(struct iwl_firmware_pieces
*pieces
,
304 enum iwl_ucode_type type
,
308 pieces
->img
[type
].sec
[sec
].offset
= offset
;
312 * Gets uCode section from tlv.
314 static int iwl_store_ucode_sec(struct iwl_firmware_pieces
*pieces
,
315 const void *data
, enum iwl_ucode_type type
,
318 struct fw_img_parsing
*img
;
320 struct fw_sec_parsing
*sec_parse
;
322 if (WARN_ON(!pieces
|| !data
|| type
>= IWL_UCODE_TYPE_MAX
))
325 sec_parse
= (struct fw_sec_parsing
*)data
;
327 img
= &pieces
->img
[type
];
328 sec
= &img
->sec
[img
->sec_counter
];
330 sec
->offset
= le32_to_cpu(sec_parse
->offset
);
331 sec
->data
= sec_parse
->data
;
332 sec
->size
= size
- sizeof(sec_parse
->offset
);
339 static int iwl_set_default_calib(struct iwl_drv
*drv
, const u8
*data
)
341 struct iwl_tlv_calib_data
*def_calib
=
342 (struct iwl_tlv_calib_data
*)data
;
343 u32 ucode_type
= le32_to_cpu(def_calib
->ucode_type
);
344 if (ucode_type
>= IWL_UCODE_TYPE_MAX
) {
345 IWL_ERR(drv
, "Wrong ucode_type %u for default calibration.\n",
349 drv
->fw
.default_calib
[ucode_type
] = le64_to_cpu(def_calib
->calib
);
353 static int iwl_parse_v1_v2_firmware(struct iwl_drv
*drv
,
354 const struct firmware
*ucode_raw
,
355 struct iwl_firmware_pieces
*pieces
)
357 struct iwl_ucode_header
*ucode
= (void *)ucode_raw
->data
;
358 u32 api_ver
, hdr_size
, build
;
362 drv
->fw
.ucode_ver
= le32_to_cpu(ucode
->ver
);
363 api_ver
= IWL_UCODE_API(drv
->fw
.ucode_ver
);
368 if (ucode_raw
->size
< hdr_size
) {
369 IWL_ERR(drv
, "File size too small!\n");
372 build
= le32_to_cpu(ucode
->u
.v2
.build
);
373 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
,
374 le32_to_cpu(ucode
->u
.v2
.inst_size
));
375 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
,
376 le32_to_cpu(ucode
->u
.v2
.data_size
));
377 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
,
378 le32_to_cpu(ucode
->u
.v2
.init_size
));
379 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
,
380 le32_to_cpu(ucode
->u
.v2
.init_data_size
));
381 src
= ucode
->u
.v2
.data
;
387 if (ucode_raw
->size
< hdr_size
) {
388 IWL_ERR(drv
, "File size too small!\n");
392 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
,
393 le32_to_cpu(ucode
->u
.v1
.inst_size
));
394 set_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
,
395 le32_to_cpu(ucode
->u
.v1
.data_size
));
396 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
,
397 le32_to_cpu(ucode
->u
.v1
.init_size
));
398 set_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
,
399 le32_to_cpu(ucode
->u
.v1
.init_data_size
));
400 src
= ucode
->u
.v1
.data
;
405 sprintf(buildstr
, " build %u%s", build
,
406 (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
)
411 snprintf(drv
->fw
.fw_version
,
412 sizeof(drv
->fw
.fw_version
),
414 IWL_UCODE_MAJOR(drv
->fw
.ucode_ver
),
415 IWL_UCODE_MINOR(drv
->fw
.ucode_ver
),
416 IWL_UCODE_API(drv
->fw
.ucode_ver
),
417 IWL_UCODE_SERIAL(drv
->fw
.ucode_ver
),
420 /* Verify size of file vs. image size info in file's header */
422 if (ucode_raw
->size
!= hdr_size
+
423 get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
) +
424 get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
) +
425 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
) +
426 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
)) {
429 "uCode file size %d does not match expected size\n",
430 (int)ucode_raw
->size
);
435 set_sec_data(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
, src
);
436 src
+= get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
);
437 set_sec_offset(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
,
438 IWLAGN_RTC_INST_LOWER_BOUND
);
439 set_sec_data(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
, src
);
440 src
+= get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
);
441 set_sec_offset(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
,
442 IWLAGN_RTC_DATA_LOWER_BOUND
);
443 set_sec_data(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
, src
);
444 src
+= get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
);
445 set_sec_offset(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
,
446 IWLAGN_RTC_INST_LOWER_BOUND
);
447 set_sec_data(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
, src
);
448 src
+= get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
);
449 set_sec_offset(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
,
450 IWLAGN_RTC_DATA_LOWER_BOUND
);
454 static int iwl_parse_tlv_firmware(struct iwl_drv
*drv
,
455 const struct firmware
*ucode_raw
,
456 struct iwl_firmware_pieces
*pieces
,
457 struct iwl_ucode_capabilities
*capa
)
459 struct iwl_tlv_ucode_header
*ucode
= (void *)ucode_raw
->data
;
460 struct iwl_ucode_tlv
*tlv
;
461 size_t len
= ucode_raw
->size
;
464 enum iwl_ucode_tlv_type tlv_type
;
469 if (len
< sizeof(*ucode
)) {
470 IWL_ERR(drv
, "uCode has invalid length: %zd\n", len
);
474 if (ucode
->magic
!= cpu_to_le32(IWL_TLV_UCODE_MAGIC
)) {
475 IWL_ERR(drv
, "invalid uCode magic: 0X%x\n",
476 le32_to_cpu(ucode
->magic
));
480 drv
->fw
.ucode_ver
= le32_to_cpu(ucode
->ver
);
481 build
= le32_to_cpu(ucode
->build
);
484 sprintf(buildstr
, " build %u%s", build
,
485 (drv
->fw_index
== UCODE_EXPERIMENTAL_INDEX
)
490 snprintf(drv
->fw
.fw_version
,
491 sizeof(drv
->fw
.fw_version
),
493 IWL_UCODE_MAJOR(drv
->fw
.ucode_ver
),
494 IWL_UCODE_MINOR(drv
->fw
.ucode_ver
),
495 IWL_UCODE_API(drv
->fw
.ucode_ver
),
496 IWL_UCODE_SERIAL(drv
->fw
.ucode_ver
),
501 len
-= sizeof(*ucode
);
503 while (len
>= sizeof(*tlv
)) {
507 tlv_len
= le32_to_cpu(tlv
->length
);
508 tlv_type
= le32_to_cpu(tlv
->type
);
509 tlv_data
= tlv
->data
;
512 IWL_ERR(drv
, "invalid TLV len: %zd/%u\n",
516 len
-= ALIGN(tlv_len
, 4);
517 data
+= sizeof(*tlv
) + ALIGN(tlv_len
, 4);
520 case IWL_UCODE_TLV_INST
:
521 set_sec_data(pieces
, IWL_UCODE_REGULAR
,
522 IWL_UCODE_SECTION_INST
, tlv_data
);
523 set_sec_size(pieces
, IWL_UCODE_REGULAR
,
524 IWL_UCODE_SECTION_INST
, tlv_len
);
525 set_sec_offset(pieces
, IWL_UCODE_REGULAR
,
526 IWL_UCODE_SECTION_INST
,
527 IWLAGN_RTC_INST_LOWER_BOUND
);
529 case IWL_UCODE_TLV_DATA
:
530 set_sec_data(pieces
, IWL_UCODE_REGULAR
,
531 IWL_UCODE_SECTION_DATA
, tlv_data
);
532 set_sec_size(pieces
, IWL_UCODE_REGULAR
,
533 IWL_UCODE_SECTION_DATA
, tlv_len
);
534 set_sec_offset(pieces
, IWL_UCODE_REGULAR
,
535 IWL_UCODE_SECTION_DATA
,
536 IWLAGN_RTC_DATA_LOWER_BOUND
);
538 case IWL_UCODE_TLV_INIT
:
539 set_sec_data(pieces
, IWL_UCODE_INIT
,
540 IWL_UCODE_SECTION_INST
, tlv_data
);
541 set_sec_size(pieces
, IWL_UCODE_INIT
,
542 IWL_UCODE_SECTION_INST
, tlv_len
);
543 set_sec_offset(pieces
, IWL_UCODE_INIT
,
544 IWL_UCODE_SECTION_INST
,
545 IWLAGN_RTC_INST_LOWER_BOUND
);
547 case IWL_UCODE_TLV_INIT_DATA
:
548 set_sec_data(pieces
, IWL_UCODE_INIT
,
549 IWL_UCODE_SECTION_DATA
, tlv_data
);
550 set_sec_size(pieces
, IWL_UCODE_INIT
,
551 IWL_UCODE_SECTION_DATA
, tlv_len
);
552 set_sec_offset(pieces
, IWL_UCODE_INIT
,
553 IWL_UCODE_SECTION_DATA
,
554 IWLAGN_RTC_DATA_LOWER_BOUND
);
556 case IWL_UCODE_TLV_BOOT
:
557 IWL_ERR(drv
, "Found unexpected BOOT ucode\n");
559 case IWL_UCODE_TLV_PROBE_MAX_LEN
:
560 if (tlv_len
!= sizeof(u32
))
561 goto invalid_tlv_len
;
562 capa
->max_probe_length
=
563 le32_to_cpup((__le32
*)tlv_data
);
565 case IWL_UCODE_TLV_PAN
:
567 goto invalid_tlv_len
;
568 capa
->flags
|= IWL_UCODE_TLV_FLAGS_PAN
;
570 case IWL_UCODE_TLV_FLAGS
:
571 /* must be at least one u32 */
572 if (tlv_len
< sizeof(u32
))
573 goto invalid_tlv_len
;
574 /* and a proper number of u32s */
575 if (tlv_len
% sizeof(u32
))
576 goto invalid_tlv_len
;
578 * This driver only reads the first u32 as
579 * right now no more features are defined,
580 * if that changes then either the driver
581 * will not work with the new firmware, or
582 * it'll not take advantage of new features.
584 capa
->flags
= le32_to_cpup((__le32
*)tlv_data
);
586 case IWL_UCODE_TLV_INIT_EVTLOG_PTR
:
587 if (tlv_len
!= sizeof(u32
))
588 goto invalid_tlv_len
;
589 pieces
->init_evtlog_ptr
=
590 le32_to_cpup((__le32
*)tlv_data
);
592 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE
:
593 if (tlv_len
!= sizeof(u32
))
594 goto invalid_tlv_len
;
595 pieces
->init_evtlog_size
=
596 le32_to_cpup((__le32
*)tlv_data
);
598 case IWL_UCODE_TLV_INIT_ERRLOG_PTR
:
599 if (tlv_len
!= sizeof(u32
))
600 goto invalid_tlv_len
;
601 pieces
->init_errlog_ptr
=
602 le32_to_cpup((__le32
*)tlv_data
);
604 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR
:
605 if (tlv_len
!= sizeof(u32
))
606 goto invalid_tlv_len
;
607 pieces
->inst_evtlog_ptr
=
608 le32_to_cpup((__le32
*)tlv_data
);
610 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE
:
611 if (tlv_len
!= sizeof(u32
))
612 goto invalid_tlv_len
;
613 pieces
->inst_evtlog_size
=
614 le32_to_cpup((__le32
*)tlv_data
);
616 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR
:
617 if (tlv_len
!= sizeof(u32
))
618 goto invalid_tlv_len
;
619 pieces
->inst_errlog_ptr
=
620 le32_to_cpup((__le32
*)tlv_data
);
622 case IWL_UCODE_TLV_ENHANCE_SENS_TBL
:
624 goto invalid_tlv_len
;
625 drv
->fw
.enhance_sensitivity_table
= true;
627 case IWL_UCODE_TLV_WOWLAN_INST
:
628 set_sec_data(pieces
, IWL_UCODE_WOWLAN
,
629 IWL_UCODE_SECTION_INST
, tlv_data
);
630 set_sec_size(pieces
, IWL_UCODE_WOWLAN
,
631 IWL_UCODE_SECTION_INST
, tlv_len
);
632 set_sec_offset(pieces
, IWL_UCODE_WOWLAN
,
633 IWL_UCODE_SECTION_INST
,
634 IWLAGN_RTC_INST_LOWER_BOUND
);
636 case IWL_UCODE_TLV_WOWLAN_DATA
:
637 set_sec_data(pieces
, IWL_UCODE_WOWLAN
,
638 IWL_UCODE_SECTION_DATA
, tlv_data
);
639 set_sec_size(pieces
, IWL_UCODE_WOWLAN
,
640 IWL_UCODE_SECTION_DATA
, tlv_len
);
641 set_sec_offset(pieces
, IWL_UCODE_WOWLAN
,
642 IWL_UCODE_SECTION_DATA
,
643 IWLAGN_RTC_DATA_LOWER_BOUND
);
645 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE
:
646 if (tlv_len
!= sizeof(u32
))
647 goto invalid_tlv_len
;
648 capa
->standard_phy_calibration_size
=
649 le32_to_cpup((__le32
*)tlv_data
);
651 case IWL_UCODE_TLV_SEC_RT
:
652 iwl_store_ucode_sec(pieces
, tlv_data
, IWL_UCODE_REGULAR
,
654 drv
->fw
.mvm_fw
= true;
656 case IWL_UCODE_TLV_SEC_INIT
:
657 iwl_store_ucode_sec(pieces
, tlv_data
, IWL_UCODE_INIT
,
659 drv
->fw
.mvm_fw
= true;
661 case IWL_UCODE_TLV_SEC_WOWLAN
:
662 iwl_store_ucode_sec(pieces
, tlv_data
, IWL_UCODE_WOWLAN
,
664 drv
->fw
.mvm_fw
= true;
666 case IWL_UCODE_TLV_DEF_CALIB
:
667 if (tlv_len
!= sizeof(struct iwl_tlv_calib_data
))
668 goto invalid_tlv_len
;
669 if (iwl_set_default_calib(drv
, tlv_data
))
672 case IWL_UCODE_TLV_PHY_SKU
:
673 if (tlv_len
!= sizeof(u32
))
674 goto invalid_tlv_len
;
675 drv
->fw
.phy_config
= le32_to_cpup((__le32
*)tlv_data
);
678 IWL_DEBUG_INFO(drv
, "unknown TLV: %d\n", tlv_type
);
684 IWL_ERR(drv
, "invalid TLV after parsing: %zd\n", len
);
685 iwl_print_hex_dump(drv
, IWL_DL_FW
, (u8
*)data
, len
);
692 IWL_ERR(drv
, "TLV %d has invalid size: %u\n", tlv_type
, tlv_len
);
694 iwl_print_hex_dump(drv
, IWL_DL_FW
, tlv_data
, tlv_len
);
699 static int iwl_alloc_ucode(struct iwl_drv
*drv
,
700 struct iwl_firmware_pieces
*pieces
,
701 enum iwl_ucode_type type
)
705 i
< IWL_UCODE_SECTION_MAX
&& get_sec_size(pieces
, type
, i
);
707 if (iwl_alloc_fw_desc(drv
, &(drv
->fw
.img
[type
].sec
[i
]),
708 get_sec(pieces
, type
, i
)))
713 static int validate_sec_sizes(struct iwl_drv
*drv
,
714 struct iwl_firmware_pieces
*pieces
,
715 const struct iwl_cfg
*cfg
)
717 IWL_DEBUG_INFO(drv
, "f/w package hdr runtime inst size = %Zd\n",
718 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
719 IWL_UCODE_SECTION_INST
));
720 IWL_DEBUG_INFO(drv
, "f/w package hdr runtime data size = %Zd\n",
721 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
722 IWL_UCODE_SECTION_DATA
));
723 IWL_DEBUG_INFO(drv
, "f/w package hdr init inst size = %Zd\n",
724 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
));
725 IWL_DEBUG_INFO(drv
, "f/w package hdr init data size = %Zd\n",
726 get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
));
728 /* Verify that uCode images will fit in card's SRAM. */
729 if (get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_INST
) >
730 cfg
->max_inst_size
) {
731 IWL_ERR(drv
, "uCode instr len %Zd too large to fit in\n",
732 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
733 IWL_UCODE_SECTION_INST
));
737 if (get_sec_size(pieces
, IWL_UCODE_REGULAR
, IWL_UCODE_SECTION_DATA
) >
738 cfg
->max_data_size
) {
739 IWL_ERR(drv
, "uCode data len %Zd too large to fit in\n",
740 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
741 IWL_UCODE_SECTION_DATA
));
745 if (get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_INST
) >
746 cfg
->max_inst_size
) {
747 IWL_ERR(drv
, "uCode init instr len %Zd too large to fit in\n",
748 get_sec_size(pieces
, IWL_UCODE_INIT
,
749 IWL_UCODE_SECTION_INST
));
753 if (get_sec_size(pieces
, IWL_UCODE_INIT
, IWL_UCODE_SECTION_DATA
) >
754 cfg
->max_data_size
) {
755 IWL_ERR(drv
, "uCode init data len %Zd too large to fit in\n",
756 get_sec_size(pieces
, IWL_UCODE_REGULAR
,
757 IWL_UCODE_SECTION_DATA
));
764 * iwl_req_fw_callback - callback when firmware was loaded
766 * If loaded successfully, copies the firmware into buffers
767 * for the card to fetch (via DMA).
769 static void iwl_req_fw_callback(const struct firmware
*ucode_raw
, void *context
)
771 struct iwl_drv
*drv
= context
;
772 struct iwl_fw
*fw
= &drv
->fw
;
773 struct iwl_ucode_header
*ucode
;
774 struct iwlwifi_opmode_table
*op
;
776 struct iwl_firmware_pieces pieces
;
777 const unsigned int api_max
= drv
->cfg
->ucode_api_max
;
778 unsigned int api_ok
= drv
->cfg
->ucode_api_ok
;
779 const unsigned int api_min
= drv
->cfg
->ucode_api_min
;
782 bool load_module
= false;
784 fw
->ucode_capa
.max_probe_length
= 200;
785 fw
->ucode_capa
.standard_phy_calibration_size
=
786 IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE
;
791 memset(&pieces
, 0, sizeof(pieces
));
794 if (drv
->fw_index
<= api_ok
)
796 "request for firmware file '%s' failed.\n",
801 IWL_DEBUG_INFO(drv
, "Loaded firmware file '%s' (%zd bytes).\n",
802 drv
->firmware_name
, ucode_raw
->size
);
804 /* Make sure that we got at least the API version number */
805 if (ucode_raw
->size
< 4) {
806 IWL_ERR(drv
, "File size way too small!\n");
810 /* Data from ucode file: header followed by uCode images */
811 ucode
= (struct iwl_ucode_header
*)ucode_raw
->data
;
814 err
= iwl_parse_v1_v2_firmware(drv
, ucode_raw
, &pieces
);
816 err
= iwl_parse_tlv_firmware(drv
, ucode_raw
, &pieces
,
822 api_ver
= IWL_UCODE_API(drv
->fw
.ucode_ver
);
825 * api_ver should match the api version forming part of the
826 * firmware filename ... but we don't check for that and only rely
827 * on the API version read from firmware header from here on forward
829 /* no api version check required for experimental uCode */
830 if (drv
->fw_index
!= UCODE_EXPERIMENTAL_INDEX
) {
831 if (api_ver
< api_min
|| api_ver
> api_max
) {
833 "Driver unable to support your firmware API. "
834 "Driver supports v%u, firmware is v%u.\n",
839 if (api_ver
< api_ok
) {
840 if (api_ok
!= api_max
)
841 IWL_ERR(drv
, "Firmware has old API version, "
842 "expected v%u through v%u, got v%u.\n",
843 api_ok
, api_max
, api_ver
);
845 IWL_ERR(drv
, "Firmware has old API version, "
846 "expected v%u, got v%u.\n",
848 IWL_ERR(drv
, "New firmware can be obtained from "
849 "http://www.intellinuxwireless.org/.\n");
853 IWL_INFO(drv
, "loaded firmware version %s", drv
->fw
.fw_version
);
856 * In mvm uCode there is no difference between data and instructions
859 if (!fw
->mvm_fw
&& validate_sec_sizes(drv
, &pieces
, drv
->cfg
))
862 /* Allocate ucode buffers for card's bus-master loading ... */
864 /* Runtime instructions and 2 copies of data:
865 * 1) unmodified from disk
866 * 2) backup cache for save/restore during power-downs */
867 for (i
= 0; i
< IWL_UCODE_TYPE_MAX
; i
++)
868 if (iwl_alloc_ucode(drv
, &pieces
, i
))
871 /* Now that we can no longer fail, copy information */
874 * The (size - 16) / 12 formula is based on the information recorded
875 * for each event, which is of mode 1 (including timestamp) for all
876 * new microcodes that include this information.
878 fw
->init_evtlog_ptr
= pieces
.init_evtlog_ptr
;
879 if (pieces
.init_evtlog_size
)
880 fw
->init_evtlog_size
= (pieces
.init_evtlog_size
- 16)/12;
882 fw
->init_evtlog_size
=
883 drv
->cfg
->base_params
->max_event_log_size
;
884 fw
->init_errlog_ptr
= pieces
.init_errlog_ptr
;
885 fw
->inst_evtlog_ptr
= pieces
.inst_evtlog_ptr
;
886 if (pieces
.inst_evtlog_size
)
887 fw
->inst_evtlog_size
= (pieces
.inst_evtlog_size
- 16)/12;
889 fw
->inst_evtlog_size
=
890 drv
->cfg
->base_params
->max_event_log_size
;
891 fw
->inst_errlog_ptr
= pieces
.inst_errlog_ptr
;
894 * figure out the offset of chain noise reset and gain commands
895 * base on the size of standard phy calibration commands table size
897 if (fw
->ucode_capa
.standard_phy_calibration_size
>
898 IWL_MAX_PHY_CALIBRATE_TBL_SIZE
)
899 fw
->ucode_capa
.standard_phy_calibration_size
=
900 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE
;
902 /* We have our copies now, allow OS release its copies */
903 release_firmware(ucode_raw
);
905 mutex_lock(&iwlwifi_opmode_table_mtx
);
906 op
= &iwlwifi_opmode_table
[DVM_OP_MODE
];
908 /* add this device to the list of devices using this op_mode */
909 list_add_tail(&drv
->list
, &op
->drv
);
912 const struct iwl_op_mode_ops
*ops
= op
->ops
;
913 drv
->op_mode
= ops
->start(drv
->trans
, drv
->cfg
, &drv
->fw
);
916 mutex_unlock(&iwlwifi_opmode_table_mtx
);
922 mutex_unlock(&iwlwifi_opmode_table_mtx
);
925 * Complete the firmware request last so that
926 * a driver unbind (stop) doesn't run while we
927 * are doing the start() above.
929 complete(&drv
->request_firmware_complete
);
932 * Load the module last so we don't block anything
933 * else from proceeding if the module fails to load
937 request_module("%s", op
->name
);
941 /* try next, if any */
942 release_firmware(ucode_raw
);
943 if (iwl_request_firmware(drv
, false))
948 IWL_ERR(drv
, "failed to allocate pci memory\n");
949 iwl_dealloc_ucode(drv
);
950 release_firmware(ucode_raw
);
952 complete(&drv
->request_firmware_complete
);
953 device_release_driver(drv
->trans
->dev
);
956 struct iwl_drv
*iwl_drv_start(struct iwl_trans
*trans
,
957 const struct iwl_cfg
*cfg
)
962 drv
= kzalloc(sizeof(*drv
), GFP_KERNEL
);
967 drv
->dev
= trans
->dev
;
970 init_completion(&drv
->request_firmware_complete
);
971 INIT_LIST_HEAD(&drv
->list
);
973 ret
= iwl_request_firmware(drv
, true);
976 IWL_ERR(trans
, "Couldn't request the fw\n");
984 void iwl_drv_stop(struct iwl_drv
*drv
)
986 wait_for_completion(&drv
->request_firmware_complete
);
988 /* op_mode can be NULL if its start failed */
990 iwl_op_mode_stop(drv
->op_mode
);
992 iwl_dealloc_ucode(drv
);
994 mutex_lock(&iwlwifi_opmode_table_mtx
);
996 * List is empty (this item wasn't added)
997 * when firmware loading failed -- in that
998 * case we can't remove it from any list.
1000 if (!list_empty(&drv
->list
))
1001 list_del(&drv
->list
);
1002 mutex_unlock(&iwlwifi_opmode_table_mtx
);
1008 /* shared module parameters */
1009 struct iwl_mod_params iwlwifi_mod_params
= {
1013 .bt_coex_active
= true,
1014 .power_level
= IWL_POWER_INDEX_1
,
1015 .bt_ch_announce
= true,
1018 /* the rest are 0 by default */
1020 EXPORT_SYMBOL_GPL(iwlwifi_mod_params
);
1022 int iwl_opmode_register(const char *name
, const struct iwl_op_mode_ops
*ops
)
1025 struct iwl_drv
*drv
;
1027 mutex_lock(&iwlwifi_opmode_table_mtx
);
1028 for (i
= 0; i
< ARRAY_SIZE(iwlwifi_opmode_table
); i
++) {
1029 if (strcmp(iwlwifi_opmode_table
[i
].name
, name
))
1031 iwlwifi_opmode_table
[i
].ops
= ops
;
1032 list_for_each_entry(drv
, &iwlwifi_opmode_table
[i
].drv
, list
)
1033 drv
->op_mode
= ops
->start(drv
->trans
, drv
->cfg
,
1035 mutex_unlock(&iwlwifi_opmode_table_mtx
);
1038 mutex_unlock(&iwlwifi_opmode_table_mtx
);
1041 EXPORT_SYMBOL_GPL(iwl_opmode_register
);
1043 void iwl_opmode_deregister(const char *name
)
1046 struct iwl_drv
*drv
;
1048 mutex_lock(&iwlwifi_opmode_table_mtx
);
1049 for (i
= 0; i
< ARRAY_SIZE(iwlwifi_opmode_table
); i
++) {
1050 if (strcmp(iwlwifi_opmode_table
[i
].name
, name
))
1052 iwlwifi_opmode_table
[i
].ops
= NULL
;
1054 /* call the stop routine for all devices */
1055 list_for_each_entry(drv
, &iwlwifi_opmode_table
[i
].drv
, list
) {
1057 iwl_op_mode_stop(drv
->op_mode
);
1058 drv
->op_mode
= NULL
;
1061 mutex_unlock(&iwlwifi_opmode_table_mtx
);
1064 mutex_unlock(&iwlwifi_opmode_table_mtx
);
1066 EXPORT_SYMBOL_GPL(iwl_opmode_deregister
);
1068 static int __init
iwl_drv_init(void)
1072 mutex_init(&iwlwifi_opmode_table_mtx
);
1074 for (i
= 0; i
< ARRAY_SIZE(iwlwifi_opmode_table
); i
++)
1075 INIT_LIST_HEAD(&iwlwifi_opmode_table
[i
].drv
);
1077 pr_info(DRV_DESCRIPTION
", " DRV_VERSION
"\n");
1078 pr_info(DRV_COPYRIGHT
"\n");
1080 return iwl_pci_register_driver();
1082 module_init(iwl_drv_init
);
1084 static void __exit
iwl_drv_exit(void)
1086 iwl_pci_unregister_driver();
1088 module_exit(iwl_drv_exit
);
1090 #ifdef CONFIG_IWLWIFI_DEBUG
1091 module_param_named(debug
, iwlwifi_mod_params
.debug_level
, uint
,
1093 MODULE_PARM_DESC(debug
, "debug output mask");
1096 module_param_named(swcrypto
, iwlwifi_mod_params
.sw_crypto
, int, S_IRUGO
);
1097 MODULE_PARM_DESC(swcrypto
, "using crypto in software (default 0 [hardware])");
1098 module_param_named(11n_disable
, iwlwifi_mod_params
.disable_11n
, uint
, S_IRUGO
);
1099 MODULE_PARM_DESC(11n_disable
,
1100 "disable 11n functionality, bitmap: 1: full, 2: agg TX, 4: agg RX");
1101 module_param_named(amsdu_size_8K
, iwlwifi_mod_params
.amsdu_size_8K
,
1103 MODULE_PARM_DESC(amsdu_size_8K
, "enable 8K amsdu size");
1104 module_param_named(fw_restart
, iwlwifi_mod_params
.restart_fw
, int, S_IRUGO
);
1105 MODULE_PARM_DESC(fw_restart
, "restart firmware in case of error");
1107 module_param_named(antenna_coupling
, iwlwifi_mod_params
.ant_coupling
,
1109 MODULE_PARM_DESC(antenna_coupling
,
1110 "specify antenna coupling in dB (defualt: 0 dB)");
1112 module_param_named(bt_ch_inhibition
, iwlwifi_mod_params
.bt_ch_announce
,
1114 MODULE_PARM_DESC(bt_ch_inhibition
,
1115 "Enable BT channel inhibition (default: enable)");
1117 module_param_named(plcp_check
, iwlwifi_mod_params
.plcp_check
, bool, S_IRUGO
);
1118 MODULE_PARM_DESC(plcp_check
, "Check plcp health (default: 1 [enabled])");
1120 module_param_named(wd_disable
, iwlwifi_mod_params
.wd_disable
, int, S_IRUGO
);
1121 MODULE_PARM_DESC(wd_disable
,
1122 "Disable stuck queue watchdog timer 0=system default, "
1123 "1=disable, 2=enable (default: 0)");
1126 * set bt_coex_active to true, uCode will do kill/defer
1127 * every time the priority line is asserted (BT is sending signals on the
1128 * priority line in the PCIx).
1129 * set bt_coex_active to false, uCode will ignore the BT activity and
1130 * perform the normal operation
1132 * User might experience transmit issue on some platform due to WiFi/BT
1133 * co-exist problem. The possible behaviors are:
1134 * Able to scan and finding all the available AP
1135 * Not able to associate with any AP
1136 * On those platforms, WiFi communication can be restored by set
1137 * "bt_coex_active" module parameter to "false"
1139 * default: bt_coex_active = true (BT_COEX_ENABLE)
1141 module_param_named(bt_coex_active
, iwlwifi_mod_params
.bt_coex_active
,
1143 MODULE_PARM_DESC(bt_coex_active
, "enable wifi/bt co-exist (default: enable)");
1145 module_param_named(led_mode
, iwlwifi_mod_params
.led_mode
, int, S_IRUGO
);
1146 MODULE_PARM_DESC(led_mode
, "0=system default, "
1147 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1149 module_param_named(power_save
, iwlwifi_mod_params
.power_save
,
1151 MODULE_PARM_DESC(power_save
,
1152 "enable WiFi power management (default: disable)");
1154 module_param_named(power_level
, iwlwifi_mod_params
.power_level
,
1156 MODULE_PARM_DESC(power_level
,
1157 "default power save level (range from 1 - 5, default: 1)");
1159 module_param_named(auto_agg
, iwlwifi_mod_params
.auto_agg
,
1161 MODULE_PARM_DESC(auto_agg
,
1162 "enable agg w/o check traffic load (default: enable)");
1164 module_param_named(5ghz_disable
, iwlwifi_mod_params
.disable_5ghz
,
1166 MODULE_PARM_DESC(5ghz_disable
, "disable 5GHz band (default: 0 [enabled])");