Linux 4.4.145
[linux/fpc-iii.git] / drivers / net / wireless / iwlwifi / iwl-drv.c
blob463cadfbfccb245612524f32d5e09db30be4a1ab
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.
6 * GPL LICENSE SUMMARY
8 * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved.
9 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of version 2 of the GNU General Public License as
13 * published by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
23 * USA
25 * The full GNU General Public License is included in this distribution
26 * in the file called COPYING.
28 * Contact Information:
29 * Intel Linux Wireless <ilw@linux.intel.com>
30 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
32 * BSD LICENSE
34 * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
35 * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
36 * All rights reserved.
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
42 * * Redistributions of source code must retain the above copyright
43 * notice, this list of conditions and the following disclaimer.
44 * * Redistributions in binary form must reproduce the above copyright
45 * notice, this list of conditions and the following disclaimer in
46 * the documentation and/or other materials provided with the
47 * distribution.
48 * * Neither the name Intel Corporation nor the names of its
49 * contributors may be used to endorse or promote products derived
50 * from this software without specific prior written permission.
52 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
53 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
54 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
55 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
56 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
57 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
58 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
59 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
60 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
61 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
62 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
64 *****************************************************************************/
65 #include <linux/completion.h>
66 #include <linux/dma-mapping.h>
67 #include <linux/firmware.h>
68 #include <linux/module.h>
69 #include <linux/vmalloc.h>
71 #include "iwl-drv.h"
72 #include "iwl-csr.h"
73 #include "iwl-debug.h"
74 #include "iwl-trans.h"
75 #include "iwl-op-mode.h"
76 #include "iwl-agn-hw.h"
77 #include "iwl-fw.h"
78 #include "iwl-config.h"
79 #include "iwl-modparams.h"
81 /******************************************************************************
83 * module boiler plate
85 ******************************************************************************/
87 #define DRV_DESCRIPTION "Intel(R) Wireless WiFi driver for Linux"
88 MODULE_DESCRIPTION(DRV_DESCRIPTION);
89 MODULE_AUTHOR(DRV_COPYRIGHT " " DRV_AUTHOR);
90 MODULE_LICENSE("GPL");
92 #ifdef CONFIG_IWLWIFI_DEBUGFS
93 static struct dentry *iwl_dbgfs_root;
94 #endif
96 /**
97 * struct iwl_drv - drv common data
98 * @list: list of drv structures using this opmode
99 * @fw: the iwl_fw structure
100 * @op_mode: the running op_mode
101 * @trans: transport layer
102 * @dev: for debug prints only
103 * @cfg: configuration struct
104 * @fw_index: firmware revision to try loading
105 * @firmware_name: composite filename of ucode file to load
106 * @request_firmware_complete: the firmware has been obtained from user space
108 struct iwl_drv {
109 struct list_head list;
110 struct iwl_fw fw;
112 struct iwl_op_mode *op_mode;
113 struct iwl_trans *trans;
114 struct device *dev;
115 const struct iwl_cfg *cfg;
117 int fw_index; /* firmware we're trying to load */
118 char firmware_name[32]; /* name of firmware file to load */
120 struct completion request_firmware_complete;
122 #ifdef CONFIG_IWLWIFI_DEBUGFS
123 struct dentry *dbgfs_drv;
124 struct dentry *dbgfs_trans;
125 struct dentry *dbgfs_op_mode;
126 #endif
129 enum {
130 DVM_OP_MODE = 0,
131 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 [DVM_OP_MODE] = { .name = "iwldvm", .ops = NULL },
142 [MVM_OP_MODE] = { .name = "iwlmvm", .ops = NULL },
145 #define IWL_DEFAULT_SCAN_CHANNELS 40
148 * struct fw_sec: Just for the image parsing process.
149 * For the fw storage we are using struct fw_desc.
151 struct fw_sec {
152 const void *data; /* the sec data */
153 size_t size; /* section size */
154 u32 offset; /* offset of writing in the device */
157 static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
159 vfree(desc->data);
160 desc->data = NULL;
161 desc->len = 0;
164 static void iwl_free_fw_img(struct iwl_drv *drv, struct fw_img *img)
166 int i;
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)
173 int i;
175 kfree(drv->fw.dbg_dest_tlv);
176 for (i = 0; i < ARRAY_SIZE(drv->fw.dbg_conf_tlv); i++)
177 kfree(drv->fw.dbg_conf_tlv[i]);
178 for (i = 0; i < ARRAY_SIZE(drv->fw.dbg_trigger_tlv); i++)
179 kfree(drv->fw.dbg_trigger_tlv[i]);
181 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
182 iwl_free_fw_img(drv, drv->fw.img + i);
185 static int iwl_alloc_fw_desc(struct iwl_drv *drv, struct fw_desc *desc,
186 struct fw_sec *sec)
188 void *data;
190 desc->data = NULL;
192 if (!sec || !sec->size)
193 return -EINVAL;
195 data = vmalloc(sec->size);
196 if (!data)
197 return -ENOMEM;
199 desc->len = sec->size;
200 desc->offset = sec->offset;
201 memcpy(data, sec->data, desc->len);
202 desc->data = data;
204 return 0;
207 static void iwl_req_fw_callback(const struct firmware *ucode_raw,
208 void *context);
210 #define UCODE_EXPERIMENTAL_INDEX 100
211 #define UCODE_EXPERIMENTAL_TAG "exp"
213 static int iwl_request_firmware(struct iwl_drv *drv, bool first)
215 const char *name_pre = drv->cfg->fw_name_pre;
216 char tag[8];
218 if (first) {
219 #ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
220 drv->fw_index = UCODE_EXPERIMENTAL_INDEX;
221 strcpy(tag, UCODE_EXPERIMENTAL_TAG);
222 } else if (drv->fw_index == UCODE_EXPERIMENTAL_INDEX) {
223 #endif
224 drv->fw_index = drv->cfg->ucode_api_max;
225 sprintf(tag, "%d", drv->fw_index);
226 } else {
227 drv->fw_index--;
228 sprintf(tag, "%d", drv->fw_index);
231 if (drv->fw_index < drv->cfg->ucode_api_min) {
232 IWL_ERR(drv, "no suitable firmware found!\n");
233 return -ENOENT;
236 snprintf(drv->firmware_name, sizeof(drv->firmware_name), "%s%s.ucode",
237 name_pre, tag);
240 * Starting 8000B - FW name format has changed. This overwrites the
241 * previous name and uses the new format.
243 if (drv->trans->cfg->device_family == IWL_DEVICE_FAMILY_8000) {
244 char rev_step = 'A' + CSR_HW_REV_STEP(drv->trans->hw_rev);
246 snprintf(drv->firmware_name, sizeof(drv->firmware_name),
247 "%s%c-%s.ucode", name_pre, rev_step, tag);
250 IWL_DEBUG_INFO(drv, "attempting to load firmware %s'%s'\n",
251 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
252 ? "EXPERIMENTAL " : "",
253 drv->firmware_name);
255 return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
256 drv->trans->dev,
257 GFP_KERNEL, drv, iwl_req_fw_callback);
260 struct fw_img_parsing {
261 struct fw_sec sec[IWL_UCODE_SECTION_MAX];
262 int sec_counter;
266 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
268 struct fw_sec_parsing {
269 __le32 offset;
270 const u8 data[];
271 } __packed;
274 * struct iwl_tlv_calib_data - parse the default calib data from TLV
276 * @ucode_type: the uCode to which the following default calib relates.
277 * @calib: default calibrations.
279 struct iwl_tlv_calib_data {
280 __le32 ucode_type;
281 struct iwl_tlv_calib_ctrl calib;
282 } __packed;
284 struct iwl_firmware_pieces {
285 struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
287 u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
288 u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
290 /* FW debug data parsed for driver usage */
291 struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
292 struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
293 size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX];
294 struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX];
295 size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX];
299 * These functions are just to extract uCode section data from the pieces
300 * structure.
302 static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
303 enum iwl_ucode_type type,
304 int sec)
306 return &pieces->img[type].sec[sec];
309 static void set_sec_data(struct iwl_firmware_pieces *pieces,
310 enum iwl_ucode_type type,
311 int sec,
312 const void *data)
314 pieces->img[type].sec[sec].data = data;
317 static void set_sec_size(struct iwl_firmware_pieces *pieces,
318 enum iwl_ucode_type type,
319 int sec,
320 size_t size)
322 pieces->img[type].sec[sec].size = size;
325 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
326 enum iwl_ucode_type type,
327 int sec)
329 return pieces->img[type].sec[sec].size;
332 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
333 enum iwl_ucode_type type,
334 int sec,
335 u32 offset)
337 pieces->img[type].sec[sec].offset = offset;
340 static int iwl_store_cscheme(struct iwl_fw *fw, const u8 *data, const u32 len)
342 int i, j;
343 struct iwl_fw_cscheme_list *l = (struct iwl_fw_cscheme_list *)data;
344 struct iwl_fw_cipher_scheme *fwcs;
345 struct ieee80211_cipher_scheme *cs;
346 u32 cipher;
348 if (len < sizeof(*l) ||
349 len < sizeof(l->size) + l->size * sizeof(l->cs[0]))
350 return -EINVAL;
352 for (i = 0, j = 0; i < IWL_UCODE_MAX_CS && i < l->size; i++) {
353 fwcs = &l->cs[j];
354 cipher = le32_to_cpu(fwcs->cipher);
356 /* we skip schemes with zero cipher suite selector */
357 if (!cipher)
358 continue;
360 cs = &fw->cs[j++];
361 cs->cipher = cipher;
362 cs->iftype = BIT(NL80211_IFTYPE_STATION);
363 cs->hdr_len = fwcs->hdr_len;
364 cs->pn_len = fwcs->pn_len;
365 cs->pn_off = fwcs->pn_off;
366 cs->key_idx_off = fwcs->key_idx_off;
367 cs->key_idx_mask = fwcs->key_idx_mask;
368 cs->key_idx_shift = fwcs->key_idx_shift;
369 cs->mic_len = fwcs->mic_len;
372 return 0;
375 static int iwl_store_gscan_capa(struct iwl_fw *fw, const u8 *data,
376 const u32 len)
378 struct iwl_fw_gscan_capabilities *fw_capa = (void *)data;
379 struct iwl_gscan_capabilities *capa = &fw->gscan_capa;
381 if (len < sizeof(*fw_capa))
382 return -EINVAL;
384 capa->max_scan_cache_size = le32_to_cpu(fw_capa->max_scan_cache_size);
385 capa->max_scan_buckets = le32_to_cpu(fw_capa->max_scan_buckets);
386 capa->max_ap_cache_per_scan =
387 le32_to_cpu(fw_capa->max_ap_cache_per_scan);
388 capa->max_rssi_sample_size = le32_to_cpu(fw_capa->max_rssi_sample_size);
389 capa->max_scan_reporting_threshold =
390 le32_to_cpu(fw_capa->max_scan_reporting_threshold);
391 capa->max_hotlist_aps = le32_to_cpu(fw_capa->max_hotlist_aps);
392 capa->max_significant_change_aps =
393 le32_to_cpu(fw_capa->max_significant_change_aps);
394 capa->max_bssid_history_entries =
395 le32_to_cpu(fw_capa->max_bssid_history_entries);
396 return 0;
400 * Gets uCode section from tlv.
402 static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
403 const void *data, enum iwl_ucode_type type,
404 int size)
406 struct fw_img_parsing *img;
407 struct fw_sec *sec;
408 struct fw_sec_parsing *sec_parse;
410 if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
411 return -1;
413 sec_parse = (struct fw_sec_parsing *)data;
415 img = &pieces->img[type];
416 sec = &img->sec[img->sec_counter];
418 sec->offset = le32_to_cpu(sec_parse->offset);
419 sec->data = sec_parse->data;
420 sec->size = size - sizeof(sec_parse->offset);
422 ++img->sec_counter;
424 return 0;
427 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
429 struct iwl_tlv_calib_data *def_calib =
430 (struct iwl_tlv_calib_data *)data;
431 u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
432 if (ucode_type >= IWL_UCODE_TYPE_MAX) {
433 IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
434 ucode_type);
435 return -EINVAL;
437 drv->fw.default_calib[ucode_type].flow_trigger =
438 def_calib->calib.flow_trigger;
439 drv->fw.default_calib[ucode_type].event_trigger =
440 def_calib->calib.event_trigger;
442 return 0;
445 static int iwl_set_ucode_api_flags(struct iwl_drv *drv, const u8 *data,
446 struct iwl_ucode_capabilities *capa)
448 const struct iwl_ucode_api *ucode_api = (void *)data;
449 u32 api_index = le32_to_cpu(ucode_api->api_index);
450 u32 api_flags = le32_to_cpu(ucode_api->api_flags);
451 int i;
453 if (api_index >= DIV_ROUND_UP(NUM_IWL_UCODE_TLV_API, 32)) {
454 IWL_ERR(drv, "api_index larger than supported by driver\n");
455 /* don't return an error so we can load FW that has more bits */
456 return 0;
459 for (i = 0; i < 32; i++) {
460 if (api_flags & BIT(i))
461 __set_bit(i + 32 * api_index, capa->_api);
464 return 0;
467 static int iwl_set_ucode_capabilities(struct iwl_drv *drv, const u8 *data,
468 struct iwl_ucode_capabilities *capa)
470 const struct iwl_ucode_capa *ucode_capa = (void *)data;
471 u32 api_index = le32_to_cpu(ucode_capa->api_index);
472 u32 api_flags = le32_to_cpu(ucode_capa->api_capa);
473 int i;
475 if (api_index >= DIV_ROUND_UP(NUM_IWL_UCODE_TLV_CAPA, 32)) {
476 IWL_ERR(drv, "api_index larger than supported by driver\n");
477 /* don't return an error so we can load FW that has more bits */
478 return 0;
481 for (i = 0; i < 32; i++) {
482 if (api_flags & BIT(i))
483 __set_bit(i + 32 * api_index, capa->_capa);
486 return 0;
489 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
490 const struct firmware *ucode_raw,
491 struct iwl_firmware_pieces *pieces)
493 struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
494 u32 api_ver, hdr_size, build;
495 char buildstr[25];
496 const u8 *src;
498 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
499 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
501 switch (api_ver) {
502 default:
503 hdr_size = 28;
504 if (ucode_raw->size < hdr_size) {
505 IWL_ERR(drv, "File size too small!\n");
506 return -EINVAL;
508 build = le32_to_cpu(ucode->u.v2.build);
509 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
510 le32_to_cpu(ucode->u.v2.inst_size));
511 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
512 le32_to_cpu(ucode->u.v2.data_size));
513 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
514 le32_to_cpu(ucode->u.v2.init_size));
515 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
516 le32_to_cpu(ucode->u.v2.init_data_size));
517 src = ucode->u.v2.data;
518 break;
519 case 0:
520 case 1:
521 case 2:
522 hdr_size = 24;
523 if (ucode_raw->size < hdr_size) {
524 IWL_ERR(drv, "File size too small!\n");
525 return -EINVAL;
527 build = 0;
528 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
529 le32_to_cpu(ucode->u.v1.inst_size));
530 set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
531 le32_to_cpu(ucode->u.v1.data_size));
532 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
533 le32_to_cpu(ucode->u.v1.init_size));
534 set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
535 le32_to_cpu(ucode->u.v1.init_data_size));
536 src = ucode->u.v1.data;
537 break;
540 if (build)
541 sprintf(buildstr, " build %u%s", build,
542 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
543 ? " (EXP)" : "");
544 else
545 buildstr[0] = '\0';
547 snprintf(drv->fw.fw_version,
548 sizeof(drv->fw.fw_version),
549 "%u.%u.%u.%u%s",
550 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
551 IWL_UCODE_MINOR(drv->fw.ucode_ver),
552 IWL_UCODE_API(drv->fw.ucode_ver),
553 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
554 buildstr);
556 /* Verify size of file vs. image size info in file's header */
558 if (ucode_raw->size != hdr_size +
559 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
560 get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
561 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
562 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
564 IWL_ERR(drv,
565 "uCode file size %d does not match expected size\n",
566 (int)ucode_raw->size);
567 return -EINVAL;
571 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
572 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
573 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
574 IWLAGN_RTC_INST_LOWER_BOUND);
575 set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
576 src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
577 set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
578 IWLAGN_RTC_DATA_LOWER_BOUND);
579 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
580 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
581 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
582 IWLAGN_RTC_INST_LOWER_BOUND);
583 set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
584 src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
585 set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
586 IWLAGN_RTC_DATA_LOWER_BOUND);
587 return 0;
590 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
591 const struct firmware *ucode_raw,
592 struct iwl_firmware_pieces *pieces,
593 struct iwl_ucode_capabilities *capa)
595 struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
596 struct iwl_ucode_tlv *tlv;
597 size_t len = ucode_raw->size;
598 const u8 *data;
599 u32 tlv_len;
600 u32 usniffer_img;
601 enum iwl_ucode_tlv_type tlv_type;
602 const u8 *tlv_data;
603 char buildstr[25];
604 u32 build, paging_mem_size;
605 int num_of_cpus;
606 bool usniffer_images = false;
607 bool usniffer_req = false;
608 bool gscan_capa = false;
610 if (len < sizeof(*ucode)) {
611 IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
612 return -EINVAL;
615 if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
616 IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
617 le32_to_cpu(ucode->magic));
618 return -EINVAL;
621 drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
622 memcpy(drv->fw.human_readable, ucode->human_readable,
623 sizeof(drv->fw.human_readable));
624 build = le32_to_cpu(ucode->build);
626 if (build)
627 sprintf(buildstr, " build %u%s", build,
628 (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
629 ? " (EXP)" : "");
630 else
631 buildstr[0] = '\0';
633 snprintf(drv->fw.fw_version,
634 sizeof(drv->fw.fw_version),
635 "%u.%u.%u.%u%s",
636 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
637 IWL_UCODE_MINOR(drv->fw.ucode_ver),
638 IWL_UCODE_API(drv->fw.ucode_ver),
639 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
640 buildstr);
642 data = ucode->data;
644 len -= sizeof(*ucode);
646 while (len >= sizeof(*tlv)) {
647 len -= sizeof(*tlv);
648 tlv = (void *)data;
650 tlv_len = le32_to_cpu(tlv->length);
651 tlv_type = le32_to_cpu(tlv->type);
652 tlv_data = tlv->data;
654 if (len < tlv_len) {
655 IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
656 len, tlv_len);
657 return -EINVAL;
659 len -= ALIGN(tlv_len, 4);
660 data += sizeof(*tlv) + ALIGN(tlv_len, 4);
662 switch (tlv_type) {
663 case IWL_UCODE_TLV_INST:
664 set_sec_data(pieces, IWL_UCODE_REGULAR,
665 IWL_UCODE_SECTION_INST, tlv_data);
666 set_sec_size(pieces, IWL_UCODE_REGULAR,
667 IWL_UCODE_SECTION_INST, tlv_len);
668 set_sec_offset(pieces, IWL_UCODE_REGULAR,
669 IWL_UCODE_SECTION_INST,
670 IWLAGN_RTC_INST_LOWER_BOUND);
671 break;
672 case IWL_UCODE_TLV_DATA:
673 set_sec_data(pieces, IWL_UCODE_REGULAR,
674 IWL_UCODE_SECTION_DATA, tlv_data);
675 set_sec_size(pieces, IWL_UCODE_REGULAR,
676 IWL_UCODE_SECTION_DATA, tlv_len);
677 set_sec_offset(pieces, IWL_UCODE_REGULAR,
678 IWL_UCODE_SECTION_DATA,
679 IWLAGN_RTC_DATA_LOWER_BOUND);
680 break;
681 case IWL_UCODE_TLV_INIT:
682 set_sec_data(pieces, IWL_UCODE_INIT,
683 IWL_UCODE_SECTION_INST, tlv_data);
684 set_sec_size(pieces, IWL_UCODE_INIT,
685 IWL_UCODE_SECTION_INST, tlv_len);
686 set_sec_offset(pieces, IWL_UCODE_INIT,
687 IWL_UCODE_SECTION_INST,
688 IWLAGN_RTC_INST_LOWER_BOUND);
689 break;
690 case IWL_UCODE_TLV_INIT_DATA:
691 set_sec_data(pieces, IWL_UCODE_INIT,
692 IWL_UCODE_SECTION_DATA, tlv_data);
693 set_sec_size(pieces, IWL_UCODE_INIT,
694 IWL_UCODE_SECTION_DATA, tlv_len);
695 set_sec_offset(pieces, IWL_UCODE_INIT,
696 IWL_UCODE_SECTION_DATA,
697 IWLAGN_RTC_DATA_LOWER_BOUND);
698 break;
699 case IWL_UCODE_TLV_BOOT:
700 IWL_ERR(drv, "Found unexpected BOOT ucode\n");
701 break;
702 case IWL_UCODE_TLV_PROBE_MAX_LEN:
703 if (tlv_len != sizeof(u32))
704 goto invalid_tlv_len;
705 capa->max_probe_length =
706 le32_to_cpup((__le32 *)tlv_data);
707 break;
708 case IWL_UCODE_TLV_PAN:
709 if (tlv_len)
710 goto invalid_tlv_len;
711 capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
712 break;
713 case IWL_UCODE_TLV_FLAGS:
714 /* must be at least one u32 */
715 if (tlv_len < sizeof(u32))
716 goto invalid_tlv_len;
717 /* and a proper number of u32s */
718 if (tlv_len % sizeof(u32))
719 goto invalid_tlv_len;
721 * This driver only reads the first u32 as
722 * right now no more features are defined,
723 * if that changes then either the driver
724 * will not work with the new firmware, or
725 * it'll not take advantage of new features.
727 capa->flags = le32_to_cpup((__le32 *)tlv_data);
728 break;
729 case IWL_UCODE_TLV_API_CHANGES_SET:
730 if (tlv_len != sizeof(struct iwl_ucode_api))
731 goto invalid_tlv_len;
732 if (iwl_set_ucode_api_flags(drv, tlv_data, capa))
733 goto tlv_error;
734 break;
735 case IWL_UCODE_TLV_ENABLED_CAPABILITIES:
736 if (tlv_len != sizeof(struct iwl_ucode_capa))
737 goto invalid_tlv_len;
738 if (iwl_set_ucode_capabilities(drv, tlv_data, capa))
739 goto tlv_error;
740 break;
741 case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
742 if (tlv_len != sizeof(u32))
743 goto invalid_tlv_len;
744 pieces->init_evtlog_ptr =
745 le32_to_cpup((__le32 *)tlv_data);
746 break;
747 case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
748 if (tlv_len != sizeof(u32))
749 goto invalid_tlv_len;
750 pieces->init_evtlog_size =
751 le32_to_cpup((__le32 *)tlv_data);
752 break;
753 case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
754 if (tlv_len != sizeof(u32))
755 goto invalid_tlv_len;
756 pieces->init_errlog_ptr =
757 le32_to_cpup((__le32 *)tlv_data);
758 break;
759 case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
760 if (tlv_len != sizeof(u32))
761 goto invalid_tlv_len;
762 pieces->inst_evtlog_ptr =
763 le32_to_cpup((__le32 *)tlv_data);
764 break;
765 case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
766 if (tlv_len != sizeof(u32))
767 goto invalid_tlv_len;
768 pieces->inst_evtlog_size =
769 le32_to_cpup((__le32 *)tlv_data);
770 break;
771 case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
772 if (tlv_len != sizeof(u32))
773 goto invalid_tlv_len;
774 pieces->inst_errlog_ptr =
775 le32_to_cpup((__le32 *)tlv_data);
776 break;
777 case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
778 if (tlv_len)
779 goto invalid_tlv_len;
780 drv->fw.enhance_sensitivity_table = true;
781 break;
782 case IWL_UCODE_TLV_WOWLAN_INST:
783 set_sec_data(pieces, IWL_UCODE_WOWLAN,
784 IWL_UCODE_SECTION_INST, tlv_data);
785 set_sec_size(pieces, IWL_UCODE_WOWLAN,
786 IWL_UCODE_SECTION_INST, tlv_len);
787 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
788 IWL_UCODE_SECTION_INST,
789 IWLAGN_RTC_INST_LOWER_BOUND);
790 break;
791 case IWL_UCODE_TLV_WOWLAN_DATA:
792 set_sec_data(pieces, IWL_UCODE_WOWLAN,
793 IWL_UCODE_SECTION_DATA, tlv_data);
794 set_sec_size(pieces, IWL_UCODE_WOWLAN,
795 IWL_UCODE_SECTION_DATA, tlv_len);
796 set_sec_offset(pieces, IWL_UCODE_WOWLAN,
797 IWL_UCODE_SECTION_DATA,
798 IWLAGN_RTC_DATA_LOWER_BOUND);
799 break;
800 case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
801 if (tlv_len != sizeof(u32))
802 goto invalid_tlv_len;
803 capa->standard_phy_calibration_size =
804 le32_to_cpup((__le32 *)tlv_data);
805 break;
806 case IWL_UCODE_TLV_SEC_RT:
807 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
808 tlv_len);
809 drv->fw.mvm_fw = true;
810 break;
811 case IWL_UCODE_TLV_SEC_INIT:
812 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
813 tlv_len);
814 drv->fw.mvm_fw = true;
815 break;
816 case IWL_UCODE_TLV_SEC_WOWLAN:
817 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
818 tlv_len);
819 drv->fw.mvm_fw = true;
820 break;
821 case IWL_UCODE_TLV_DEF_CALIB:
822 if (tlv_len != sizeof(struct iwl_tlv_calib_data))
823 goto invalid_tlv_len;
824 if (iwl_set_default_calib(drv, tlv_data))
825 goto tlv_error;
826 break;
827 case IWL_UCODE_TLV_PHY_SKU:
828 if (tlv_len != sizeof(u32))
829 goto invalid_tlv_len;
830 drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
831 drv->fw.valid_tx_ant = (drv->fw.phy_config &
832 FW_PHY_CFG_TX_CHAIN) >>
833 FW_PHY_CFG_TX_CHAIN_POS;
834 drv->fw.valid_rx_ant = (drv->fw.phy_config &
835 FW_PHY_CFG_RX_CHAIN) >>
836 FW_PHY_CFG_RX_CHAIN_POS;
837 break;
838 case IWL_UCODE_TLV_SECURE_SEC_RT:
839 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
840 tlv_len);
841 drv->fw.mvm_fw = true;
842 break;
843 case IWL_UCODE_TLV_SECURE_SEC_INIT:
844 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
845 tlv_len);
846 drv->fw.mvm_fw = true;
847 break;
848 case IWL_UCODE_TLV_SECURE_SEC_WOWLAN:
849 iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
850 tlv_len);
851 drv->fw.mvm_fw = true;
852 break;
853 case IWL_UCODE_TLV_NUM_OF_CPU:
854 if (tlv_len != sizeof(u32))
855 goto invalid_tlv_len;
856 num_of_cpus =
857 le32_to_cpup((__le32 *)tlv_data);
859 if (num_of_cpus == 2) {
860 drv->fw.img[IWL_UCODE_REGULAR].is_dual_cpus =
861 true;
862 drv->fw.img[IWL_UCODE_INIT].is_dual_cpus =
863 true;
864 drv->fw.img[IWL_UCODE_WOWLAN].is_dual_cpus =
865 true;
866 } else if ((num_of_cpus > 2) || (num_of_cpus < 1)) {
867 IWL_ERR(drv, "Driver support upto 2 CPUs\n");
868 return -EINVAL;
870 break;
871 case IWL_UCODE_TLV_CSCHEME:
872 if (iwl_store_cscheme(&drv->fw, tlv_data, tlv_len))
873 goto invalid_tlv_len;
874 break;
875 case IWL_UCODE_TLV_N_SCAN_CHANNELS:
876 if (tlv_len != sizeof(u32))
877 goto invalid_tlv_len;
878 capa->n_scan_channels =
879 le32_to_cpup((__le32 *)tlv_data);
880 break;
881 case IWL_UCODE_TLV_FW_VERSION: {
882 __le32 *ptr = (void *)tlv_data;
883 u32 major, minor;
884 u8 local_comp;
886 if (tlv_len != sizeof(u32) * 3)
887 goto invalid_tlv_len;
889 major = le32_to_cpup(ptr++);
890 minor = le32_to_cpup(ptr++);
891 local_comp = le32_to_cpup(ptr);
893 snprintf(drv->fw.fw_version,
894 sizeof(drv->fw.fw_version), "%u.%u.%u",
895 major, minor, local_comp);
896 break;
898 case IWL_UCODE_TLV_FW_DBG_DEST: {
899 struct iwl_fw_dbg_dest_tlv *dest = (void *)tlv_data;
901 if (pieces->dbg_dest_tlv) {
902 IWL_ERR(drv,
903 "dbg destination ignored, already exists\n");
904 break;
907 pieces->dbg_dest_tlv = dest;
908 IWL_INFO(drv, "Found debug destination: %s\n",
909 get_fw_dbg_mode_string(dest->monitor_mode));
911 drv->fw.dbg_dest_reg_num =
912 tlv_len - offsetof(struct iwl_fw_dbg_dest_tlv,
913 reg_ops);
914 drv->fw.dbg_dest_reg_num /=
915 sizeof(drv->fw.dbg_dest_tlv->reg_ops[0]);
917 break;
919 case IWL_UCODE_TLV_FW_DBG_CONF: {
920 struct iwl_fw_dbg_conf_tlv *conf = (void *)tlv_data;
922 if (!pieces->dbg_dest_tlv) {
923 IWL_ERR(drv,
924 "Ignore dbg config %d - no destination configured\n",
925 conf->id);
926 break;
929 if (conf->id >= ARRAY_SIZE(drv->fw.dbg_conf_tlv)) {
930 IWL_ERR(drv,
931 "Skip unknown configuration: %d\n",
932 conf->id);
933 break;
936 if (pieces->dbg_conf_tlv[conf->id]) {
937 IWL_ERR(drv,
938 "Ignore duplicate dbg config %d\n",
939 conf->id);
940 break;
943 if (conf->usniffer)
944 usniffer_req = true;
946 IWL_INFO(drv, "Found debug configuration: %d\n",
947 conf->id);
949 pieces->dbg_conf_tlv[conf->id] = conf;
950 pieces->dbg_conf_tlv_len[conf->id] = tlv_len;
951 break;
953 case IWL_UCODE_TLV_FW_DBG_TRIGGER: {
954 struct iwl_fw_dbg_trigger_tlv *trigger =
955 (void *)tlv_data;
956 u32 trigger_id = le32_to_cpu(trigger->id);
958 if (trigger_id >= ARRAY_SIZE(drv->fw.dbg_trigger_tlv)) {
959 IWL_ERR(drv,
960 "Skip unknown trigger: %u\n",
961 trigger->id);
962 break;
965 if (pieces->dbg_trigger_tlv[trigger_id]) {
966 IWL_ERR(drv,
967 "Ignore duplicate dbg trigger %u\n",
968 trigger->id);
969 break;
972 IWL_INFO(drv, "Found debug trigger: %u\n", trigger->id);
974 pieces->dbg_trigger_tlv[trigger_id] = trigger;
975 pieces->dbg_trigger_tlv_len[trigger_id] = tlv_len;
976 break;
978 case IWL_UCODE_TLV_SEC_RT_USNIFFER:
979 usniffer_images = true;
980 iwl_store_ucode_sec(pieces, tlv_data,
981 IWL_UCODE_REGULAR_USNIFFER,
982 tlv_len);
983 break;
984 case IWL_UCODE_TLV_PAGING:
985 if (tlv_len != sizeof(u32))
986 goto invalid_tlv_len;
987 paging_mem_size = le32_to_cpup((__le32 *)tlv_data);
989 IWL_DEBUG_FW(drv,
990 "Paging: paging enabled (size = %u bytes)\n",
991 paging_mem_size);
993 if (paging_mem_size > MAX_PAGING_IMAGE_SIZE) {
994 IWL_ERR(drv,
995 "Paging: driver supports up to %lu bytes for paging image\n",
996 MAX_PAGING_IMAGE_SIZE);
997 return -EINVAL;
1000 if (paging_mem_size & (FW_PAGING_SIZE - 1)) {
1001 IWL_ERR(drv,
1002 "Paging: image isn't multiple %lu\n",
1003 FW_PAGING_SIZE);
1004 return -EINVAL;
1007 drv->fw.img[IWL_UCODE_REGULAR].paging_mem_size =
1008 paging_mem_size;
1009 usniffer_img = IWL_UCODE_REGULAR_USNIFFER;
1010 drv->fw.img[usniffer_img].paging_mem_size =
1011 paging_mem_size;
1012 break;
1013 case IWL_UCODE_TLV_SDIO_ADMA_ADDR:
1014 if (tlv_len != sizeof(u32))
1015 goto invalid_tlv_len;
1016 drv->fw.sdio_adma_addr =
1017 le32_to_cpup((__le32 *)tlv_data);
1018 break;
1019 case IWL_UCODE_TLV_FW_GSCAN_CAPA:
1020 if (iwl_store_gscan_capa(&drv->fw, tlv_data, tlv_len))
1021 goto invalid_tlv_len;
1022 gscan_capa = true;
1023 break;
1024 default:
1025 IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
1026 break;
1030 if (usniffer_req && !usniffer_images) {
1031 IWL_ERR(drv,
1032 "user selected to work with usniffer but usniffer image isn't available in ucode package\n");
1033 return -EINVAL;
1036 if (len) {
1037 IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
1038 iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
1039 return -EINVAL;
1043 * If ucode advertises that it supports GSCAN but GSCAN
1044 * capabilities TLV is not present, warn and continue without GSCAN.
1046 if (fw_has_capa(capa, IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT) &&
1047 WARN(!gscan_capa,
1048 "GSCAN is supported but capabilities TLV is unavailable\n"))
1049 __clear_bit((__force long)IWL_UCODE_TLV_CAPA_GSCAN_SUPPORT,
1050 capa->_capa);
1052 return 0;
1054 invalid_tlv_len:
1055 IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
1056 tlv_error:
1057 iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
1059 return -EINVAL;
1062 static int iwl_alloc_ucode(struct iwl_drv *drv,
1063 struct iwl_firmware_pieces *pieces,
1064 enum iwl_ucode_type type)
1066 int i;
1067 for (i = 0;
1068 i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
1069 i++)
1070 if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
1071 get_sec(pieces, type, i)))
1072 return -ENOMEM;
1073 return 0;
1076 static int validate_sec_sizes(struct iwl_drv *drv,
1077 struct iwl_firmware_pieces *pieces,
1078 const struct iwl_cfg *cfg)
1080 IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
1081 get_sec_size(pieces, IWL_UCODE_REGULAR,
1082 IWL_UCODE_SECTION_INST));
1083 IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
1084 get_sec_size(pieces, IWL_UCODE_REGULAR,
1085 IWL_UCODE_SECTION_DATA));
1086 IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
1087 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
1088 IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
1089 get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
1091 /* Verify that uCode images will fit in card's SRAM. */
1092 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
1093 cfg->max_inst_size) {
1094 IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
1095 get_sec_size(pieces, IWL_UCODE_REGULAR,
1096 IWL_UCODE_SECTION_INST));
1097 return -1;
1100 if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
1101 cfg->max_data_size) {
1102 IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
1103 get_sec_size(pieces, IWL_UCODE_REGULAR,
1104 IWL_UCODE_SECTION_DATA));
1105 return -1;
1108 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
1109 cfg->max_inst_size) {
1110 IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
1111 get_sec_size(pieces, IWL_UCODE_INIT,
1112 IWL_UCODE_SECTION_INST));
1113 return -1;
1116 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
1117 cfg->max_data_size) {
1118 IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
1119 get_sec_size(pieces, IWL_UCODE_REGULAR,
1120 IWL_UCODE_SECTION_DATA));
1121 return -1;
1123 return 0;
1126 static struct iwl_op_mode *
1127 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
1129 const struct iwl_op_mode_ops *ops = op->ops;
1130 struct dentry *dbgfs_dir = NULL;
1131 struct iwl_op_mode *op_mode = NULL;
1133 #ifdef CONFIG_IWLWIFI_DEBUGFS
1134 drv->dbgfs_op_mode = debugfs_create_dir(op->name,
1135 drv->dbgfs_drv);
1136 if (!drv->dbgfs_op_mode) {
1137 IWL_ERR(drv,
1138 "failed to create opmode debugfs directory\n");
1139 return op_mode;
1141 dbgfs_dir = drv->dbgfs_op_mode;
1142 #endif
1144 op_mode = ops->start(drv->trans, drv->cfg, &drv->fw, dbgfs_dir);
1146 #ifdef CONFIG_IWLWIFI_DEBUGFS
1147 if (!op_mode) {
1148 debugfs_remove_recursive(drv->dbgfs_op_mode);
1149 drv->dbgfs_op_mode = NULL;
1151 #endif
1153 return op_mode;
1156 static void _iwl_op_mode_stop(struct iwl_drv *drv)
1158 /* op_mode can be NULL if its start failed */
1159 if (drv->op_mode) {
1160 iwl_op_mode_stop(drv->op_mode);
1161 drv->op_mode = NULL;
1163 #ifdef CONFIG_IWLWIFI_DEBUGFS
1164 debugfs_remove_recursive(drv->dbgfs_op_mode);
1165 drv->dbgfs_op_mode = NULL;
1166 #endif
1171 * iwl_req_fw_callback - callback when firmware was loaded
1173 * If loaded successfully, copies the firmware into buffers
1174 * for the card to fetch (via DMA).
1176 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
1178 struct iwl_drv *drv = context;
1179 struct iwl_fw *fw = &drv->fw;
1180 struct iwl_ucode_header *ucode;
1181 struct iwlwifi_opmode_table *op;
1182 int err;
1183 struct iwl_firmware_pieces *pieces;
1184 const unsigned int api_max = drv->cfg->ucode_api_max;
1185 unsigned int api_ok = drv->cfg->ucode_api_ok;
1186 const unsigned int api_min = drv->cfg->ucode_api_min;
1187 size_t trigger_tlv_sz[FW_DBG_TRIGGER_MAX];
1188 u32 api_ver;
1189 int i;
1190 bool load_module = false;
1192 fw->ucode_capa.max_probe_length = IWL_DEFAULT_MAX_PROBE_LENGTH;
1193 fw->ucode_capa.standard_phy_calibration_size =
1194 IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1195 fw->ucode_capa.n_scan_channels = IWL_DEFAULT_SCAN_CHANNELS;
1197 if (!api_ok)
1198 api_ok = api_max;
1200 pieces = kzalloc(sizeof(*pieces), GFP_KERNEL);
1201 if (!pieces)
1202 return;
1204 if (!ucode_raw) {
1205 if (drv->fw_index <= api_ok)
1206 IWL_ERR(drv,
1207 "request for firmware file '%s' failed.\n",
1208 drv->firmware_name);
1209 goto try_again;
1212 IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
1213 drv->firmware_name, ucode_raw->size);
1215 /* Make sure that we got at least the API version number */
1216 if (ucode_raw->size < 4) {
1217 IWL_ERR(drv, "File size way too small!\n");
1218 goto try_again;
1221 /* Data from ucode file: header followed by uCode images */
1222 ucode = (struct iwl_ucode_header *)ucode_raw->data;
1224 if (ucode->ver)
1225 err = iwl_parse_v1_v2_firmware(drv, ucode_raw, pieces);
1226 else
1227 err = iwl_parse_tlv_firmware(drv, ucode_raw, pieces,
1228 &fw->ucode_capa);
1230 if (err)
1231 goto try_again;
1233 if (fw_has_api(&drv->fw.ucode_capa, IWL_UCODE_TLV_API_NEW_VERSION))
1234 api_ver = drv->fw.ucode_ver;
1235 else
1236 api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
1239 * api_ver should match the api version forming part of the
1240 * firmware filename ... but we don't check for that and only rely
1241 * on the API version read from firmware header from here on forward
1243 /* no api version check required for experimental uCode */
1244 if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
1245 if (api_ver < api_min || api_ver > api_max) {
1246 IWL_ERR(drv,
1247 "Driver unable to support your firmware API. "
1248 "Driver supports v%u, firmware is v%u.\n",
1249 api_max, api_ver);
1250 goto try_again;
1253 if (api_ver < api_ok) {
1254 if (api_ok != api_max)
1255 IWL_ERR(drv, "Firmware has old API version, "
1256 "expected v%u through v%u, got v%u.\n",
1257 api_ok, api_max, api_ver);
1258 else
1259 IWL_ERR(drv, "Firmware has old API version, "
1260 "expected v%u, got v%u.\n",
1261 api_max, api_ver);
1262 IWL_ERR(drv, "New firmware can be obtained from "
1263 "http://www.intellinuxwireless.org/.\n");
1268 * In mvm uCode there is no difference between data and instructions
1269 * sections.
1271 if (!fw->mvm_fw && validate_sec_sizes(drv, pieces, drv->cfg))
1272 goto try_again;
1274 /* Allocate ucode buffers for card's bus-master loading ... */
1276 /* Runtime instructions and 2 copies of data:
1277 * 1) unmodified from disk
1278 * 2) backup cache for save/restore during power-downs */
1279 for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
1280 if (iwl_alloc_ucode(drv, pieces, i))
1281 goto out_free_fw;
1283 if (pieces->dbg_dest_tlv) {
1284 drv->fw.dbg_dest_tlv =
1285 kmemdup(pieces->dbg_dest_tlv,
1286 sizeof(*pieces->dbg_dest_tlv) +
1287 sizeof(pieces->dbg_dest_tlv->reg_ops[0]) *
1288 drv->fw.dbg_dest_reg_num, GFP_KERNEL);
1290 if (!drv->fw.dbg_dest_tlv)
1291 goto out_free_fw;
1294 for (i = 0; i < ARRAY_SIZE(drv->fw.dbg_conf_tlv); i++) {
1295 if (pieces->dbg_conf_tlv[i]) {
1296 drv->fw.dbg_conf_tlv_len[i] =
1297 pieces->dbg_conf_tlv_len[i];
1298 drv->fw.dbg_conf_tlv[i] =
1299 kmemdup(pieces->dbg_conf_tlv[i],
1300 drv->fw.dbg_conf_tlv_len[i],
1301 GFP_KERNEL);
1302 if (!drv->fw.dbg_conf_tlv[i])
1303 goto out_free_fw;
1307 memset(&trigger_tlv_sz, 0xff, sizeof(trigger_tlv_sz));
1309 trigger_tlv_sz[FW_DBG_TRIGGER_MISSED_BEACONS] =
1310 sizeof(struct iwl_fw_dbg_trigger_missed_bcon);
1311 trigger_tlv_sz[FW_DBG_TRIGGER_CHANNEL_SWITCH] = 0;
1312 trigger_tlv_sz[FW_DBG_TRIGGER_FW_NOTIF] =
1313 sizeof(struct iwl_fw_dbg_trigger_cmd);
1314 trigger_tlv_sz[FW_DBG_TRIGGER_MLME] =
1315 sizeof(struct iwl_fw_dbg_trigger_mlme);
1316 trigger_tlv_sz[FW_DBG_TRIGGER_STATS] =
1317 sizeof(struct iwl_fw_dbg_trigger_stats);
1318 trigger_tlv_sz[FW_DBG_TRIGGER_RSSI] =
1319 sizeof(struct iwl_fw_dbg_trigger_low_rssi);
1320 trigger_tlv_sz[FW_DBG_TRIGGER_TXQ_TIMERS] =
1321 sizeof(struct iwl_fw_dbg_trigger_txq_timer);
1322 trigger_tlv_sz[FW_DBG_TRIGGER_TIME_EVENT] =
1323 sizeof(struct iwl_fw_dbg_trigger_time_event);
1324 trigger_tlv_sz[FW_DBG_TRIGGER_BA] =
1325 sizeof(struct iwl_fw_dbg_trigger_ba);
1327 for (i = 0; i < ARRAY_SIZE(drv->fw.dbg_trigger_tlv); i++) {
1328 if (pieces->dbg_trigger_tlv[i]) {
1330 * If the trigger isn't long enough, WARN and exit.
1331 * Someone is trying to debug something and he won't
1332 * be able to catch the bug he is trying to chase.
1333 * We'd better be noisy to be sure he knows what's
1334 * going on.
1336 if (WARN_ON(pieces->dbg_trigger_tlv_len[i] <
1337 (trigger_tlv_sz[i] +
1338 sizeof(struct iwl_fw_dbg_trigger_tlv))))
1339 goto out_free_fw;
1340 drv->fw.dbg_trigger_tlv_len[i] =
1341 pieces->dbg_trigger_tlv_len[i];
1342 drv->fw.dbg_trigger_tlv[i] =
1343 kmemdup(pieces->dbg_trigger_tlv[i],
1344 drv->fw.dbg_trigger_tlv_len[i],
1345 GFP_KERNEL);
1346 if (!drv->fw.dbg_trigger_tlv[i])
1347 goto out_free_fw;
1351 /* Now that we can no longer fail, copy information */
1354 * The (size - 16) / 12 formula is based on the information recorded
1355 * for each event, which is of mode 1 (including timestamp) for all
1356 * new microcodes that include this information.
1358 fw->init_evtlog_ptr = pieces->init_evtlog_ptr;
1359 if (pieces->init_evtlog_size)
1360 fw->init_evtlog_size = (pieces->init_evtlog_size - 16)/12;
1361 else
1362 fw->init_evtlog_size =
1363 drv->cfg->base_params->max_event_log_size;
1364 fw->init_errlog_ptr = pieces->init_errlog_ptr;
1365 fw->inst_evtlog_ptr = pieces->inst_evtlog_ptr;
1366 if (pieces->inst_evtlog_size)
1367 fw->inst_evtlog_size = (pieces->inst_evtlog_size - 16)/12;
1368 else
1369 fw->inst_evtlog_size =
1370 drv->cfg->base_params->max_event_log_size;
1371 fw->inst_errlog_ptr = pieces->inst_errlog_ptr;
1374 * figure out the offset of chain noise reset and gain commands
1375 * base on the size of standard phy calibration commands table size
1377 if (fw->ucode_capa.standard_phy_calibration_size >
1378 IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
1379 fw->ucode_capa.standard_phy_calibration_size =
1380 IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1382 /* We have our copies now, allow OS release its copies */
1383 release_firmware(ucode_raw);
1385 mutex_lock(&iwlwifi_opmode_table_mtx);
1386 if (fw->mvm_fw)
1387 op = &iwlwifi_opmode_table[MVM_OP_MODE];
1388 else
1389 op = &iwlwifi_opmode_table[DVM_OP_MODE];
1391 IWL_INFO(drv, "loaded firmware version %s op_mode %s\n",
1392 drv->fw.fw_version, op->name);
1394 /* add this device to the list of devices using this op_mode */
1395 list_add_tail(&drv->list, &op->drv);
1397 if (op->ops) {
1398 drv->op_mode = _iwl_op_mode_start(drv, op);
1400 if (!drv->op_mode) {
1401 mutex_unlock(&iwlwifi_opmode_table_mtx);
1402 goto out_unbind;
1404 } else {
1405 load_module = true;
1407 mutex_unlock(&iwlwifi_opmode_table_mtx);
1410 * Complete the firmware request last so that
1411 * a driver unbind (stop) doesn't run while we
1412 * are doing the start() above.
1414 complete(&drv->request_firmware_complete);
1417 * Load the module last so we don't block anything
1418 * else from proceeding if the module fails to load
1419 * or hangs loading.
1421 if (load_module) {
1422 err = request_module("%s", op->name);
1423 #ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
1424 if (err)
1425 IWL_ERR(drv,
1426 "failed to load module %s (error %d), is dynamic loading enabled?\n",
1427 op->name, err);
1428 #endif
1430 kfree(pieces);
1431 return;
1433 try_again:
1434 /* try next, if any */
1435 release_firmware(ucode_raw);
1436 if (iwl_request_firmware(drv, false))
1437 goto out_unbind;
1438 kfree(pieces);
1439 return;
1441 out_free_fw:
1442 IWL_ERR(drv, "failed to allocate pci memory\n");
1443 iwl_dealloc_ucode(drv);
1444 release_firmware(ucode_raw);
1445 out_unbind:
1446 kfree(pieces);
1447 complete(&drv->request_firmware_complete);
1448 device_release_driver(drv->trans->dev);
1451 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans,
1452 const struct iwl_cfg *cfg)
1454 struct iwl_drv *drv;
1455 int ret;
1457 drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1458 if (!drv) {
1459 ret = -ENOMEM;
1460 goto err;
1463 drv->trans = trans;
1464 drv->dev = trans->dev;
1465 drv->cfg = cfg;
1467 init_completion(&drv->request_firmware_complete);
1468 INIT_LIST_HEAD(&drv->list);
1470 #ifdef CONFIG_IWLWIFI_DEBUGFS
1471 /* Create the device debugfs entries. */
1472 drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1473 iwl_dbgfs_root);
1475 if (!drv->dbgfs_drv) {
1476 IWL_ERR(drv, "failed to create debugfs directory\n");
1477 ret = -ENOMEM;
1478 goto err_free_drv;
1481 /* Create transport layer debugfs dir */
1482 drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1484 if (!drv->trans->dbgfs_dir) {
1485 IWL_ERR(drv, "failed to create transport debugfs directory\n");
1486 ret = -ENOMEM;
1487 goto err_free_dbgfs;
1489 #endif
1491 ret = iwl_request_firmware(drv, true);
1492 if (ret) {
1493 IWL_ERR(trans, "Couldn't request the fw\n");
1494 goto err_fw;
1497 return drv;
1499 err_fw:
1500 #ifdef CONFIG_IWLWIFI_DEBUGFS
1501 err_free_dbgfs:
1502 debugfs_remove_recursive(drv->dbgfs_drv);
1503 err_free_drv:
1504 #endif
1505 kfree(drv);
1506 err:
1507 return ERR_PTR(ret);
1510 void iwl_drv_stop(struct iwl_drv *drv)
1512 wait_for_completion(&drv->request_firmware_complete);
1514 _iwl_op_mode_stop(drv);
1516 iwl_dealloc_ucode(drv);
1518 mutex_lock(&iwlwifi_opmode_table_mtx);
1520 * List is empty (this item wasn't added)
1521 * when firmware loading failed -- in that
1522 * case we can't remove it from any list.
1524 if (!list_empty(&drv->list))
1525 list_del(&drv->list);
1526 mutex_unlock(&iwlwifi_opmode_table_mtx);
1528 #ifdef CONFIG_IWLWIFI_DEBUGFS
1529 debugfs_remove_recursive(drv->dbgfs_drv);
1530 #endif
1532 kfree(drv);
1536 /* shared module parameters */
1537 struct iwl_mod_params iwlwifi_mod_params = {
1538 .restart_fw = true,
1539 .bt_coex_active = true,
1540 .power_level = IWL_POWER_INDEX_1,
1541 .d0i3_disable = true,
1542 #ifndef CONFIG_IWLWIFI_UAPSD
1543 .uapsd_disable = true,
1544 #endif /* CONFIG_IWLWIFI_UAPSD */
1545 /* the rest are 0 by default */
1547 IWL_EXPORT_SYMBOL(iwlwifi_mod_params);
1549 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
1551 int i;
1552 struct iwl_drv *drv;
1553 struct iwlwifi_opmode_table *op;
1555 mutex_lock(&iwlwifi_opmode_table_mtx);
1556 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1557 op = &iwlwifi_opmode_table[i];
1558 if (strcmp(op->name, name))
1559 continue;
1560 op->ops = ops;
1561 /* TODO: need to handle exceptional case */
1562 list_for_each_entry(drv, &op->drv, list)
1563 drv->op_mode = _iwl_op_mode_start(drv, op);
1565 mutex_unlock(&iwlwifi_opmode_table_mtx);
1566 return 0;
1568 mutex_unlock(&iwlwifi_opmode_table_mtx);
1569 return -EIO;
1571 IWL_EXPORT_SYMBOL(iwl_opmode_register);
1573 void iwl_opmode_deregister(const char *name)
1575 int i;
1576 struct iwl_drv *drv;
1578 mutex_lock(&iwlwifi_opmode_table_mtx);
1579 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1580 if (strcmp(iwlwifi_opmode_table[i].name, name))
1581 continue;
1582 iwlwifi_opmode_table[i].ops = NULL;
1584 /* call the stop routine for all devices */
1585 list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
1586 _iwl_op_mode_stop(drv);
1588 mutex_unlock(&iwlwifi_opmode_table_mtx);
1589 return;
1591 mutex_unlock(&iwlwifi_opmode_table_mtx);
1593 IWL_EXPORT_SYMBOL(iwl_opmode_deregister);
1595 static int __init iwl_drv_init(void)
1597 int i;
1599 mutex_init(&iwlwifi_opmode_table_mtx);
1601 for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
1602 INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
1604 pr_info(DRV_DESCRIPTION "\n");
1605 pr_info(DRV_COPYRIGHT "\n");
1607 #ifdef CONFIG_IWLWIFI_DEBUGFS
1608 /* Create the root of iwlwifi debugfs subsystem. */
1609 iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
1611 if (!iwl_dbgfs_root)
1612 return -EFAULT;
1613 #endif
1615 return iwl_pci_register_driver();
1617 module_init(iwl_drv_init);
1619 static void __exit iwl_drv_exit(void)
1621 iwl_pci_unregister_driver();
1623 #ifdef CONFIG_IWLWIFI_DEBUGFS
1624 debugfs_remove_recursive(iwl_dbgfs_root);
1625 #endif
1627 module_exit(iwl_drv_exit);
1629 #ifdef CONFIG_IWLWIFI_DEBUG
1630 module_param_named(debug, iwlwifi_mod_params.debug_level, uint,
1631 S_IRUGO | S_IWUSR);
1632 MODULE_PARM_DESC(debug, "debug output mask");
1633 #endif
1635 module_param_named(swcrypto, iwlwifi_mod_params.sw_crypto, int, S_IRUGO);
1636 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
1637 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, S_IRUGO);
1638 MODULE_PARM_DESC(11n_disable,
1639 "disable 11n functionality, bitmap: 1: full, 2: disable agg TX, 4: disable agg RX, 8 enable agg TX");
1640 module_param_named(amsdu_size_8K, iwlwifi_mod_params.amsdu_size_8K,
1641 int, S_IRUGO);
1642 MODULE_PARM_DESC(amsdu_size_8K, "enable 8K amsdu size (default 0)");
1643 module_param_named(fw_restart, iwlwifi_mod_params.restart_fw, bool, S_IRUGO);
1644 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error (default true)");
1646 module_param_named(antenna_coupling, iwlwifi_mod_params.ant_coupling,
1647 int, S_IRUGO);
1648 MODULE_PARM_DESC(antenna_coupling,
1649 "specify antenna coupling in dB (default: 0 dB)");
1651 module_param_named(nvm_file, iwlwifi_mod_params.nvm_file, charp, S_IRUGO);
1652 MODULE_PARM_DESC(nvm_file, "NVM file name");
1654 module_param_named(d0i3_disable, iwlwifi_mod_params.d0i3_disable,
1655 bool, S_IRUGO);
1656 MODULE_PARM_DESC(d0i3_disable, "disable d0i3 functionality (default: Y)");
1658 module_param_named(lar_disable, iwlwifi_mod_params.lar_disable,
1659 bool, S_IRUGO);
1660 MODULE_PARM_DESC(lar_disable, "disable LAR functionality (default: N)");
1662 module_param_named(uapsd_disable, iwlwifi_mod_params.uapsd_disable,
1663 bool, S_IRUGO | S_IWUSR);
1664 #ifdef CONFIG_IWLWIFI_UAPSD
1665 MODULE_PARM_DESC(uapsd_disable, "disable U-APSD functionality (default: N)");
1666 #else
1667 MODULE_PARM_DESC(uapsd_disable, "disable U-APSD functionality (default: Y)");
1668 #endif
1671 * set bt_coex_active to true, uCode will do kill/defer
1672 * every time the priority line is asserted (BT is sending signals on the
1673 * priority line in the PCIx).
1674 * set bt_coex_active to false, uCode will ignore the BT activity and
1675 * perform the normal operation
1677 * User might experience transmit issue on some platform due to WiFi/BT
1678 * co-exist problem. The possible behaviors are:
1679 * Able to scan and finding all the available AP
1680 * Not able to associate with any AP
1681 * On those platforms, WiFi communication can be restored by set
1682 * "bt_coex_active" module parameter to "false"
1684 * default: bt_coex_active = true (BT_COEX_ENABLE)
1686 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1687 bool, S_IRUGO);
1688 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1690 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, S_IRUGO);
1691 MODULE_PARM_DESC(led_mode, "0=system default, "
1692 "1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1694 module_param_named(power_save, iwlwifi_mod_params.power_save,
1695 bool, S_IRUGO);
1696 MODULE_PARM_DESC(power_save,
1697 "enable WiFi power management (default: disable)");
1699 module_param_named(power_level, iwlwifi_mod_params.power_level,
1700 int, S_IRUGO);
1701 MODULE_PARM_DESC(power_level,
1702 "default power save level (range from 1 - 5, default: 1)");
1704 module_param_named(fw_monitor, iwlwifi_mod_params.fw_monitor, bool, S_IRUGO);
1705 MODULE_PARM_DESC(fw_monitor,
1706 "firmware monitor - to debug FW (default: false - needs lots of memory)");