1 /******************************************************************************
2  *
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.
5  *
6  * GPL LICENSE SUMMARY
7  *
8  * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved.
9  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
10  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
11  * Copyright(c) 2018 - 2019 Intel Corporation
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of version 2 of the GNU General Public License as
15  * published by the Free Software Foundation.
16  *
17  * This program is distributed in the hope that it will be useful, but
18  * WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
20  * General Public License for more details.
21  *
22  * The full GNU General Public License is included in this distribution
23  * in the file called COPYING.
24  *
25  * Contact Information:
26  *  Intel Linux Wireless <linuxwifi@intel.com>
27  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
28  *
29  * BSD LICENSE
30  *
31  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
32  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
33  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
34  * Copyright(c) 2018 - 2019 Intel Corporation
35  * All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  *
41  *  * Redistributions of source code must retain the above copyright
42  *    notice, this list of conditions and the following disclaimer.
43  *  * Redistributions in binary form must reproduce the above copyright
44  *    notice, this list of conditions and the following disclaimer in
45  *    the documentation and/or other materials provided with the
46  *    distribution.
47  *  * Neither the name Intel Corporation nor the names of its
48  *    contributors may be used to endorse or promote products derived
49  *    from this software without specific prior written permission.
50  *
51  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
52  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
53  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
54  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
55  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
56  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
57  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
58  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
59  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
60  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
61  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
62  *
63  *****************************************************************************/
64 #include <linux/completion.h>
65 #include <linux/dma-mapping.h>
66 #include <linux/firmware.h>
67 #include <linux/module.h>
68 #include <linux/vmalloc.h>
69 
70 #include "iwl-drv.h"
71 #include "iwl-csr.h"
72 #include "iwl-debug.h"
73 #include "iwl-trans.h"
74 #include "iwl-op-mode.h"
75 #include "iwl-agn-hw.h"
76 #include "fw/img.h"
77 #include "iwl-dbg-tlv.h"
78 #include "iwl-config.h"
79 #include "iwl-modparams.h"
80 #include "fw/api/alive.h"
81 
82 /******************************************************************************
83  *
84  * module boiler plate
85  *
86  ******************************************************************************/
87 
88 #define DRV_DESCRIPTION	"Intel(R) Wireless WiFi driver for Linux"
89 MODULE_DESCRIPTION(DRV_DESCRIPTION);
90 MODULE_AUTHOR(DRV_COPYRIGHT " " DRV_AUTHOR);
91 MODULE_LICENSE("GPL");
92 
93 #ifdef CONFIG_IWLWIFI_DEBUGFS
94 static struct dentry *iwl_dbgfs_root;
95 #endif
96 
97 /**
98  * struct iwl_drv - drv common data
99  * @list: list of drv structures using this opmode
100  * @fw: the iwl_fw structure
101  * @op_mode: the running op_mode
102  * @trans: transport layer
103  * @dev: for debug prints only
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
107  */
108 struct iwl_drv {
109 	struct list_head list;
110 	struct iwl_fw fw;
111 
112 	struct iwl_op_mode *op_mode;
113 	struct iwl_trans *trans;
114 	struct device *dev;
115 
116 	int fw_index;                   /* firmware we're trying to load */
117 	char firmware_name[64];         /* name of firmware file to load */
118 
119 	struct completion request_firmware_complete;
120 
121 #ifdef CONFIG_IWLWIFI_DEBUGFS
122 	struct dentry *dbgfs_drv;
123 	struct dentry *dbgfs_trans;
124 	struct dentry *dbgfs_op_mode;
125 #endif
126 };
127 
128 enum {
129 	DVM_OP_MODE,
130 	MVM_OP_MODE,
131 };
132 
133 /* Protects the table contents, i.e. the ops pointer & drv list */
134 static struct mutex iwlwifi_opmode_table_mtx;
135 static struct iwlwifi_opmode_table {
136 	const char *name;			/* name: iwldvm, iwlmvm, etc */
137 	const struct iwl_op_mode_ops *ops;	/* pointer to op_mode ops */
138 	struct list_head drv;		/* list of devices using this op_mode */
139 } iwlwifi_opmode_table[] = {		/* ops set when driver is initialized */
140 	[DVM_OP_MODE] = { .name = "iwldvm", .ops = NULL },
141 	[MVM_OP_MODE] = { .name = "iwlmvm", .ops = NULL },
142 };
143 
144 #define IWL_DEFAULT_SCAN_CHANNELS 40
145 
146 /*
147  * struct fw_sec: Just for the image parsing process.
148  * For the fw storage we are using struct fw_desc.
149  */
150 struct fw_sec {
151 	const void *data;		/* the sec data */
152 	size_t size;			/* section size */
153 	u32 offset;			/* offset of writing in the device */
154 };
155 
156 static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
157 {
158 	vfree(desc->data);
159 	desc->data = NULL;
160 	desc->len = 0;
161 }
162 
163 static void iwl_free_fw_img(struct iwl_drv *drv, struct fw_img *img)
164 {
165 	int i;
166 	for (i = 0; i < img->num_sec; i++)
167 		iwl_free_fw_desc(drv, &img->sec[i]);
168 	kfree(img->sec);
169 }
170 
171 static void iwl_dealloc_ucode(struct iwl_drv *drv)
172 {
173 	int i;
174 
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]);
180 	kfree(drv->fw.dbg.mem_tlv);
181 	kfree(drv->fw.iml);
182 	kfree(drv->fw.ucode_capa.cmd_versions);
183 
184 	for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
185 		iwl_free_fw_img(drv, drv->fw.img + i);
186 }
187 
188 static int iwl_alloc_fw_desc(struct iwl_drv *drv, struct fw_desc *desc,
189 			     struct fw_sec *sec)
190 {
191 	void *data;
192 
193 	desc->data = NULL;
194 
195 	if (!sec || !sec->size)
196 		return -EINVAL;
197 
198 	data = vmalloc(sec->size);
199 	if (!data)
200 		return -ENOMEM;
201 
202 	desc->len = sec->size;
203 	desc->offset = sec->offset;
204 	memcpy(data, sec->data, desc->len);
205 	desc->data = data;
206 
207 	return 0;
208 }
209 
210 static void iwl_req_fw_callback(const struct firmware *ucode_raw,
211 				void *context);
212 
213 static int iwl_request_firmware(struct iwl_drv *drv, bool first)
214 {
215 	const struct iwl_cfg *cfg = drv->trans->cfg;
216 	char tag[8];
217 
218 	if (drv->trans->cfg->device_family == IWL_DEVICE_FAMILY_9000 &&
219 	    (CSR_HW_REV_STEP(drv->trans->hw_rev) != SILICON_B_STEP &&
220 	     CSR_HW_REV_STEP(drv->trans->hw_rev) != SILICON_C_STEP)) {
221 		IWL_ERR(drv,
222 			"Only HW steps B and C are currently supported (0x%0x)\n",
223 			drv->trans->hw_rev);
224 		return -EINVAL;
225 	}
226 
227 	if (first) {
228 		drv->fw_index = cfg->ucode_api_max;
229 		sprintf(tag, "%d", drv->fw_index);
230 	} else {
231 		drv->fw_index--;
232 		sprintf(tag, "%d", drv->fw_index);
233 	}
234 
235 	if (drv->fw_index < cfg->ucode_api_min) {
236 		IWL_ERR(drv, "no suitable firmware found!\n");
237 
238 		if (cfg->ucode_api_min == cfg->ucode_api_max) {
239 			IWL_ERR(drv, "%s%d is required\n", cfg->fw_name_pre,
240 				cfg->ucode_api_max);
241 		} else {
242 			IWL_ERR(drv, "minimum version required: %s%d\n",
243 				cfg->fw_name_pre, cfg->ucode_api_min);
244 			IWL_ERR(drv, "maximum version supported: %s%d\n",
245 				cfg->fw_name_pre, cfg->ucode_api_max);
246 		}
247 
248 		IWL_ERR(drv,
249 			"check git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git\n");
250 		return -ENOENT;
251 	}
252 
253 	snprintf(drv->firmware_name, sizeof(drv->firmware_name), "%s%s.ucode",
254 		 cfg->fw_name_pre, tag);
255 
256 	IWL_DEBUG_FW_INFO(drv, "attempting to load firmware '%s'\n",
257 			  drv->firmware_name);
258 
259 	return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
260 				       drv->trans->dev,
261 				       GFP_KERNEL, drv, iwl_req_fw_callback);
262 }
263 
264 struct fw_img_parsing {
265 	struct fw_sec *sec;
266 	int sec_counter;
267 };
268 
269 /*
270  * struct fw_sec_parsing: to extract fw section and it's offset from tlv
271  */
272 struct fw_sec_parsing {
273 	__le32 offset;
274 	const u8 data[];
275 } __packed;
276 
277 /**
278  * struct iwl_tlv_calib_data - parse the default calib data from TLV
279  *
280  * @ucode_type: the uCode to which the following default calib relates.
281  * @calib: default calibrations.
282  */
283 struct iwl_tlv_calib_data {
284 	__le32 ucode_type;
285 	struct iwl_tlv_calib_ctrl calib;
286 } __packed;
287 
288 struct iwl_firmware_pieces {
289 	struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
290 
291 	u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
292 	u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
293 
294 	/* FW debug data parsed for driver usage */
295 	bool dbg_dest_tlv_init;
296 	u8 *dbg_dest_ver;
297 	union {
298 		struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
299 		struct iwl_fw_dbg_dest_tlv_v1 *dbg_dest_tlv_v1;
300 	};
301 	struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
302 	size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX];
303 	struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX];
304 	size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX];
305 	struct iwl_fw_dbg_mem_seg_tlv *dbg_mem_tlv;
306 	size_t n_mem_tlv;
307 };
308 
309 /*
310  * These functions are just to extract uCode section data from the pieces
311  * structure.
312  */
313 static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
314 			      enum iwl_ucode_type type,
315 			      int  sec)
316 {
317 	return &pieces->img[type].sec[sec];
318 }
319 
320 static void alloc_sec_data(struct iwl_firmware_pieces *pieces,
321 			   enum iwl_ucode_type type,
322 			   int sec)
323 {
324 	struct fw_img_parsing *img = &pieces->img[type];
325 	struct fw_sec *sec_memory;
326 	int size = sec + 1;
327 	size_t alloc_size = sizeof(*img->sec) * size;
328 
329 	if (img->sec && img->sec_counter >= size)
330 		return;
331 
332 	sec_memory = krealloc(img->sec, alloc_size, GFP_KERNEL);
333 	if (!sec_memory)
334 		return;
335 
336 	img->sec = sec_memory;
337 	img->sec_counter = size;
338 }
339 
340 static void set_sec_data(struct iwl_firmware_pieces *pieces,
341 			 enum iwl_ucode_type type,
342 			 int sec,
343 			 const void *data)
344 {
345 	alloc_sec_data(pieces, type, sec);
346 
347 	pieces->img[type].sec[sec].data = data;
348 }
349 
350 static void set_sec_size(struct iwl_firmware_pieces *pieces,
351 			 enum iwl_ucode_type type,
352 			 int sec,
353 			 size_t size)
354 {
355 	alloc_sec_data(pieces, type, sec);
356 
357 	pieces->img[type].sec[sec].size = size;
358 }
359 
360 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
361 			   enum iwl_ucode_type type,
362 			   int sec)
363 {
364 	return pieces->img[type].sec[sec].size;
365 }
366 
367 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
368 			   enum iwl_ucode_type type,
369 			   int sec,
370 			   u32 offset)
371 {
372 	alloc_sec_data(pieces, type, sec);
373 
374 	pieces->img[type].sec[sec].offset = offset;
375 }
376 
377 static int iwl_store_cscheme(struct iwl_fw *fw, const u8 *data, const u32 len)
378 {
379 	int i, j;
380 	struct iwl_fw_cscheme_list *l = (struct iwl_fw_cscheme_list *)data;
381 	struct iwl_fw_cipher_scheme *fwcs;
382 
383 	if (len < sizeof(*l) ||
384 	    len < sizeof(l->size) + l->size * sizeof(l->cs[0]))
385 		return -EINVAL;
386 
387 	for (i = 0, j = 0; i < IWL_UCODE_MAX_CS && i < l->size; i++) {
388 		fwcs = &l->cs[j];
389 
390 		/* we skip schemes with zero cipher suite selector */
391 		if (!fwcs->cipher)
392 			continue;
393 
394 		fw->cs[j++] = *fwcs;
395 	}
396 
397 	return 0;
398 }
399 
400 /*
401  * Gets uCode section from tlv.
402  */
403 static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
404 			       const void *data, enum iwl_ucode_type type,
405 			       int size)
406 {
407 	struct fw_img_parsing *img;
408 	struct fw_sec *sec;
409 	struct fw_sec_parsing *sec_parse;
410 	size_t alloc_size;
411 
412 	if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
413 		return -1;
414 
415 	sec_parse = (struct fw_sec_parsing *)data;
416 
417 	img = &pieces->img[type];
418 
419 	alloc_size = sizeof(*img->sec) * (img->sec_counter + 1);
420 	sec = krealloc(img->sec, alloc_size, GFP_KERNEL);
421 	if (!sec)
422 		return -ENOMEM;
423 	img->sec = sec;
424 
425 	sec = &img->sec[img->sec_counter];
426 
427 	sec->offset = le32_to_cpu(sec_parse->offset);
428 	sec->data = sec_parse->data;
429 	sec->size = size - sizeof(sec_parse->offset);
430 
431 	++img->sec_counter;
432 
433 	return 0;
434 }
435 
436 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
437 {
438 	struct iwl_tlv_calib_data *def_calib =
439 					(struct iwl_tlv_calib_data *)data;
440 	u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
441 	if (ucode_type >= IWL_UCODE_TYPE_MAX) {
442 		IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
443 			ucode_type);
444 		return -EINVAL;
445 	}
446 	drv->fw.default_calib[ucode_type].flow_trigger =
447 		def_calib->calib.flow_trigger;
448 	drv->fw.default_calib[ucode_type].event_trigger =
449 		def_calib->calib.event_trigger;
450 
451 	return 0;
452 }
453 
454 static void iwl_set_ucode_api_flags(struct iwl_drv *drv, const u8 *data,
455 				    struct iwl_ucode_capabilities *capa)
456 {
457 	const struct iwl_ucode_api *ucode_api = (void *)data;
458 	u32 api_index = le32_to_cpu(ucode_api->api_index);
459 	u32 api_flags = le32_to_cpu(ucode_api->api_flags);
460 	int i;
461 
462 	if (api_index >= DIV_ROUND_UP(NUM_IWL_UCODE_TLV_API, 32)) {
463 		IWL_WARN(drv,
464 			 "api flags index %d larger than supported by driver\n",
465 			 api_index);
466 		return;
467 	}
468 
469 	for (i = 0; i < 32; i++) {
470 		if (api_flags & BIT(i))
471 			__set_bit(i + 32 * api_index, capa->_api);
472 	}
473 }
474 
475 static void iwl_set_ucode_capabilities(struct iwl_drv *drv, const u8 *data,
476 				       struct iwl_ucode_capabilities *capa)
477 {
478 	const struct iwl_ucode_capa *ucode_capa = (void *)data;
479 	u32 api_index = le32_to_cpu(ucode_capa->api_index);
480 	u32 api_flags = le32_to_cpu(ucode_capa->api_capa);
481 	int i;
482 
483 	if (api_index >= DIV_ROUND_UP(NUM_IWL_UCODE_TLV_CAPA, 32)) {
484 		IWL_WARN(drv,
485 			 "capa flags index %d larger than supported by driver\n",
486 			 api_index);
487 		return;
488 	}
489 
490 	for (i = 0; i < 32; i++) {
491 		if (api_flags & BIT(i))
492 			__set_bit(i + 32 * api_index, capa->_capa);
493 	}
494 }
495 
496 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
497 				    const struct firmware *ucode_raw,
498 				    struct iwl_firmware_pieces *pieces)
499 {
500 	struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
501 	u32 api_ver, hdr_size, build;
502 	char buildstr[25];
503 	const u8 *src;
504 
505 	drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
506 	api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
507 
508 	switch (api_ver) {
509 	default:
510 		hdr_size = 28;
511 		if (ucode_raw->size < hdr_size) {
512 			IWL_ERR(drv, "File size too small!\n");
513 			return -EINVAL;
514 		}
515 		build = le32_to_cpu(ucode->u.v2.build);
516 		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
517 			     le32_to_cpu(ucode->u.v2.inst_size));
518 		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
519 			     le32_to_cpu(ucode->u.v2.data_size));
520 		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
521 			     le32_to_cpu(ucode->u.v2.init_size));
522 		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
523 			     le32_to_cpu(ucode->u.v2.init_data_size));
524 		src = ucode->u.v2.data;
525 		break;
526 	case 0:
527 	case 1:
528 	case 2:
529 		hdr_size = 24;
530 		if (ucode_raw->size < hdr_size) {
531 			IWL_ERR(drv, "File size too small!\n");
532 			return -EINVAL;
533 		}
534 		build = 0;
535 		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
536 			     le32_to_cpu(ucode->u.v1.inst_size));
537 		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
538 			     le32_to_cpu(ucode->u.v1.data_size));
539 		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
540 			     le32_to_cpu(ucode->u.v1.init_size));
541 		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
542 			     le32_to_cpu(ucode->u.v1.init_data_size));
543 		src = ucode->u.v1.data;
544 		break;
545 	}
546 
547 	if (build)
548 		sprintf(buildstr, " build %u", build);
549 	else
550 		buildstr[0] = '\0';
551 
552 	snprintf(drv->fw.fw_version,
553 		 sizeof(drv->fw.fw_version),
554 		 "%u.%u.%u.%u%s",
555 		 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
556 		 IWL_UCODE_MINOR(drv->fw.ucode_ver),
557 		 IWL_UCODE_API(drv->fw.ucode_ver),
558 		 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
559 		 buildstr);
560 
561 	/* Verify size of file vs. image size info in file's header */
562 
563 	if (ucode_raw->size != hdr_size +
564 	    get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
565 	    get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
566 	    get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
567 	    get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
568 
569 		IWL_ERR(drv,
570 			"uCode file size %d does not match expected size\n",
571 			(int)ucode_raw->size);
572 		return -EINVAL;
573 	}
574 
575 
576 	set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
577 	src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
578 	set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
579 		       IWLAGN_RTC_INST_LOWER_BOUND);
580 	set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
581 	src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
582 	set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
583 		       IWLAGN_RTC_DATA_LOWER_BOUND);
584 	set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
585 	src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
586 	set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
587 		       IWLAGN_RTC_INST_LOWER_BOUND);
588 	set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
589 	src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
590 	set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
591 		       IWLAGN_RTC_DATA_LOWER_BOUND);
592 	return 0;
593 }
594 
595 #define FW_ADDR_CACHE_CONTROL 0xC0000000
596 
597 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
598 				const struct firmware *ucode_raw,
599 				struct iwl_firmware_pieces *pieces,
600 				struct iwl_ucode_capabilities *capa,
601 				bool *usniffer_images)
602 {
603 	struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
604 	struct iwl_ucode_tlv *tlv;
605 	size_t len = ucode_raw->size;
606 	const u8 *data;
607 	u32 tlv_len;
608 	u32 usniffer_img;
609 	enum iwl_ucode_tlv_type tlv_type;
610 	const u8 *tlv_data;
611 	char buildstr[25];
612 	u32 build, paging_mem_size;
613 	int num_of_cpus;
614 	bool usniffer_req = false;
615 
616 	if (len < sizeof(*ucode)) {
617 		IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
618 		return -EINVAL;
619 	}
620 
621 	if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
622 		IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
623 			le32_to_cpu(ucode->magic));
624 		return -EINVAL;
625 	}
626 
627 	drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
628 	memcpy(drv->fw.human_readable, ucode->human_readable,
629 	       sizeof(drv->fw.human_readable));
630 	build = le32_to_cpu(ucode->build);
631 
632 	if (build)
633 		sprintf(buildstr, " build %u", build);
634 	else
635 		buildstr[0] = '\0';
636 
637 	snprintf(drv->fw.fw_version,
638 		 sizeof(drv->fw.fw_version),
639 		 "%u.%u.%u.%u%s",
640 		 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
641 		 IWL_UCODE_MINOR(drv->fw.ucode_ver),
642 		 IWL_UCODE_API(drv->fw.ucode_ver),
643 		 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
644 		 buildstr);
645 
646 	data = ucode->data;
647 
648 	len -= sizeof(*ucode);
649 
650 	if (iwlwifi_mod_params.enable_ini)
651 		iwl_alloc_dbg_tlv(drv->trans, len, data, false);
652 
653 	while (len >= sizeof(*tlv)) {
654 		len -= sizeof(*tlv);
655 		tlv = (void *)data;
656 
657 		tlv_len = le32_to_cpu(tlv->length);
658 		tlv_type = le32_to_cpu(tlv->type);
659 		tlv_data = tlv->data;
660 
661 		if (len < tlv_len) {
662 			IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
663 				len, tlv_len);
664 			return -EINVAL;
665 		}
666 		len -= ALIGN(tlv_len, 4);
667 		data += sizeof(*tlv) + ALIGN(tlv_len, 4);
668 
669 		switch (tlv_type) {
670 		case IWL_UCODE_TLV_INST:
671 			set_sec_data(pieces, IWL_UCODE_REGULAR,
672 				     IWL_UCODE_SECTION_INST, tlv_data);
673 			set_sec_size(pieces, IWL_UCODE_REGULAR,
674 				     IWL_UCODE_SECTION_INST, tlv_len);
675 			set_sec_offset(pieces, IWL_UCODE_REGULAR,
676 				       IWL_UCODE_SECTION_INST,
677 				       IWLAGN_RTC_INST_LOWER_BOUND);
678 			break;
679 		case IWL_UCODE_TLV_DATA:
680 			set_sec_data(pieces, IWL_UCODE_REGULAR,
681 				     IWL_UCODE_SECTION_DATA, tlv_data);
682 			set_sec_size(pieces, IWL_UCODE_REGULAR,
683 				     IWL_UCODE_SECTION_DATA, tlv_len);
684 			set_sec_offset(pieces, IWL_UCODE_REGULAR,
685 				       IWL_UCODE_SECTION_DATA,
686 				       IWLAGN_RTC_DATA_LOWER_BOUND);
687 			break;
688 		case IWL_UCODE_TLV_INIT:
689 			set_sec_data(pieces, IWL_UCODE_INIT,
690 				     IWL_UCODE_SECTION_INST, tlv_data);
691 			set_sec_size(pieces, IWL_UCODE_INIT,
692 				     IWL_UCODE_SECTION_INST, tlv_len);
693 			set_sec_offset(pieces, IWL_UCODE_INIT,
694 				       IWL_UCODE_SECTION_INST,
695 				       IWLAGN_RTC_INST_LOWER_BOUND);
696 			break;
697 		case IWL_UCODE_TLV_INIT_DATA:
698 			set_sec_data(pieces, IWL_UCODE_INIT,
699 				     IWL_UCODE_SECTION_DATA, tlv_data);
700 			set_sec_size(pieces, IWL_UCODE_INIT,
701 				     IWL_UCODE_SECTION_DATA, tlv_len);
702 			set_sec_offset(pieces, IWL_UCODE_INIT,
703 				       IWL_UCODE_SECTION_DATA,
704 				       IWLAGN_RTC_DATA_LOWER_BOUND);
705 			break;
706 		case IWL_UCODE_TLV_BOOT:
707 			IWL_ERR(drv, "Found unexpected BOOT ucode\n");
708 			break;
709 		case IWL_UCODE_TLV_PROBE_MAX_LEN:
710 			if (tlv_len != sizeof(u32))
711 				goto invalid_tlv_len;
712 			capa->max_probe_length =
713 					le32_to_cpup((__le32 *)tlv_data);
714 			break;
715 		case IWL_UCODE_TLV_PAN:
716 			if (tlv_len)
717 				goto invalid_tlv_len;
718 			capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
719 			break;
720 		case IWL_UCODE_TLV_FLAGS:
721 			/* must be at least one u32 */
722 			if (tlv_len < sizeof(u32))
723 				goto invalid_tlv_len;
724 			/* and a proper number of u32s */
725 			if (tlv_len % sizeof(u32))
726 				goto invalid_tlv_len;
727 			/*
728 			 * This driver only reads the first u32 as
729 			 * right now no more features are defined,
730 			 * if that changes then either the driver
731 			 * will not work with the new firmware, or
732 			 * it'll not take advantage of new features.
733 			 */
734 			capa->flags = le32_to_cpup((__le32 *)tlv_data);
735 			break;
736 		case IWL_UCODE_TLV_API_CHANGES_SET:
737 			if (tlv_len != sizeof(struct iwl_ucode_api))
738 				goto invalid_tlv_len;
739 			iwl_set_ucode_api_flags(drv, tlv_data, capa);
740 			break;
741 		case IWL_UCODE_TLV_ENABLED_CAPABILITIES:
742 			if (tlv_len != sizeof(struct iwl_ucode_capa))
743 				goto invalid_tlv_len;
744 			iwl_set_ucode_capabilities(drv, tlv_data, capa);
745 			break;
746 		case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
747 			if (tlv_len != sizeof(u32))
748 				goto invalid_tlv_len;
749 			pieces->init_evtlog_ptr =
750 					le32_to_cpup((__le32 *)tlv_data);
751 			break;
752 		case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
753 			if (tlv_len != sizeof(u32))
754 				goto invalid_tlv_len;
755 			pieces->init_evtlog_size =
756 					le32_to_cpup((__le32 *)tlv_data);
757 			break;
758 		case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
759 			if (tlv_len != sizeof(u32))
760 				goto invalid_tlv_len;
761 			pieces->init_errlog_ptr =
762 					le32_to_cpup((__le32 *)tlv_data);
763 			break;
764 		case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
765 			if (tlv_len != sizeof(u32))
766 				goto invalid_tlv_len;
767 			pieces->inst_evtlog_ptr =
768 					le32_to_cpup((__le32 *)tlv_data);
769 			break;
770 		case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
771 			if (tlv_len != sizeof(u32))
772 				goto invalid_tlv_len;
773 			pieces->inst_evtlog_size =
774 					le32_to_cpup((__le32 *)tlv_data);
775 			break;
776 		case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
777 			if (tlv_len != sizeof(u32))
778 				goto invalid_tlv_len;
779 			pieces->inst_errlog_ptr =
780 					le32_to_cpup((__le32 *)tlv_data);
781 			break;
782 		case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
783 			if (tlv_len)
784 				goto invalid_tlv_len;
785 			drv->fw.enhance_sensitivity_table = true;
786 			break;
787 		case IWL_UCODE_TLV_WOWLAN_INST:
788 			set_sec_data(pieces, IWL_UCODE_WOWLAN,
789 				     IWL_UCODE_SECTION_INST, tlv_data);
790 			set_sec_size(pieces, IWL_UCODE_WOWLAN,
791 				     IWL_UCODE_SECTION_INST, tlv_len);
792 			set_sec_offset(pieces, IWL_UCODE_WOWLAN,
793 				       IWL_UCODE_SECTION_INST,
794 				       IWLAGN_RTC_INST_LOWER_BOUND);
795 			break;
796 		case IWL_UCODE_TLV_WOWLAN_DATA:
797 			set_sec_data(pieces, IWL_UCODE_WOWLAN,
798 				     IWL_UCODE_SECTION_DATA, tlv_data);
799 			set_sec_size(pieces, IWL_UCODE_WOWLAN,
800 				     IWL_UCODE_SECTION_DATA, tlv_len);
801 			set_sec_offset(pieces, IWL_UCODE_WOWLAN,
802 				       IWL_UCODE_SECTION_DATA,
803 				       IWLAGN_RTC_DATA_LOWER_BOUND);
804 			break;
805 		case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
806 			if (tlv_len != sizeof(u32))
807 				goto invalid_tlv_len;
808 			capa->standard_phy_calibration_size =
809 					le32_to_cpup((__le32 *)tlv_data);
810 			break;
811 		case IWL_UCODE_TLV_SEC_RT:
812 			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
813 					    tlv_len);
814 			drv->fw.type = IWL_FW_MVM;
815 			break;
816 		case IWL_UCODE_TLV_SEC_INIT:
817 			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
818 					    tlv_len);
819 			drv->fw.type = IWL_FW_MVM;
820 			break;
821 		case IWL_UCODE_TLV_SEC_WOWLAN:
822 			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
823 					    tlv_len);
824 			drv->fw.type = IWL_FW_MVM;
825 			break;
826 		case IWL_UCODE_TLV_DEF_CALIB:
827 			if (tlv_len != sizeof(struct iwl_tlv_calib_data))
828 				goto invalid_tlv_len;
829 			if (iwl_set_default_calib(drv, tlv_data))
830 				goto tlv_error;
831 			break;
832 		case IWL_UCODE_TLV_PHY_SKU:
833 			if (tlv_len != sizeof(u32))
834 				goto invalid_tlv_len;
835 			drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
836 			drv->fw.valid_tx_ant = (drv->fw.phy_config &
837 						FW_PHY_CFG_TX_CHAIN) >>
838 						FW_PHY_CFG_TX_CHAIN_POS;
839 			drv->fw.valid_rx_ant = (drv->fw.phy_config &
840 						FW_PHY_CFG_RX_CHAIN) >>
841 						FW_PHY_CFG_RX_CHAIN_POS;
842 			break;
843 		case IWL_UCODE_TLV_SECURE_SEC_RT:
844 			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
845 					    tlv_len);
846 			drv->fw.type = IWL_FW_MVM;
847 			break;
848 		case IWL_UCODE_TLV_SECURE_SEC_INIT:
849 			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
850 					    tlv_len);
851 			drv->fw.type = IWL_FW_MVM;
852 			break;
853 		case IWL_UCODE_TLV_SECURE_SEC_WOWLAN:
854 			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
855 					    tlv_len);
856 			drv->fw.type = IWL_FW_MVM;
857 			break;
858 		case IWL_UCODE_TLV_NUM_OF_CPU:
859 			if (tlv_len != sizeof(u32))
860 				goto invalid_tlv_len;
861 			num_of_cpus =
862 				le32_to_cpup((__le32 *)tlv_data);
863 
864 			if (num_of_cpus == 2) {
865 				drv->fw.img[IWL_UCODE_REGULAR].is_dual_cpus =
866 					true;
867 				drv->fw.img[IWL_UCODE_INIT].is_dual_cpus =
868 					true;
869 				drv->fw.img[IWL_UCODE_WOWLAN].is_dual_cpus =
870 					true;
871 			} else if ((num_of_cpus > 2) || (num_of_cpus < 1)) {
872 				IWL_ERR(drv, "Driver support upto 2 CPUs\n");
873 				return -EINVAL;
874 			}
875 			break;
876 		case IWL_UCODE_TLV_CSCHEME:
877 			if (iwl_store_cscheme(&drv->fw, tlv_data, tlv_len))
878 				goto invalid_tlv_len;
879 			break;
880 		case IWL_UCODE_TLV_N_SCAN_CHANNELS:
881 			if (tlv_len != sizeof(u32))
882 				goto invalid_tlv_len;
883 			capa->n_scan_channels =
884 				le32_to_cpup((__le32 *)tlv_data);
885 			break;
886 		case IWL_UCODE_TLV_FW_VERSION: {
887 			__le32 *ptr = (void *)tlv_data;
888 			u32 major, minor;
889 			u8 local_comp;
890 
891 			if (tlv_len != sizeof(u32) * 3)
892 				goto invalid_tlv_len;
893 
894 			major = le32_to_cpup(ptr++);
895 			minor = le32_to_cpup(ptr++);
896 			local_comp = le32_to_cpup(ptr);
897 
898 			if (major >= 35)
899 				snprintf(drv->fw.fw_version,
900 					 sizeof(drv->fw.fw_version),
901 					"%u.%08x.%u", major, minor, local_comp);
902 			else
903 				snprintf(drv->fw.fw_version,
904 					 sizeof(drv->fw.fw_version),
905 					"%u.%u.%u", major, minor, local_comp);
906 			break;
907 			}
908 		case IWL_UCODE_TLV_FW_DBG_DEST: {
909 			struct iwl_fw_dbg_dest_tlv *dest = NULL;
910 			struct iwl_fw_dbg_dest_tlv_v1 *dest_v1 = NULL;
911 			u8 mon_mode;
912 
913 			pieces->dbg_dest_ver = (u8 *)tlv_data;
914 			if (*pieces->dbg_dest_ver == 1) {
915 				dest = (void *)tlv_data;
916 			} else if (*pieces->dbg_dest_ver == 0) {
917 				dest_v1 = (void *)tlv_data;
918 			} else {
919 				IWL_ERR(drv,
920 					"The version is %d, and it is invalid\n",
921 					*pieces->dbg_dest_ver);
922 				break;
923 			}
924 
925 			if (pieces->dbg_dest_tlv_init) {
926 				IWL_ERR(drv,
927 					"dbg destination ignored, already exists\n");
928 				break;
929 			}
930 
931 			pieces->dbg_dest_tlv_init = true;
932 
933 			if (dest_v1) {
934 				pieces->dbg_dest_tlv_v1 = dest_v1;
935 				mon_mode = dest_v1->monitor_mode;
936 			} else {
937 				pieces->dbg_dest_tlv = dest;
938 				mon_mode = dest->monitor_mode;
939 			}
940 
941 			IWL_INFO(drv, "Found debug destination: %s\n",
942 				 get_fw_dbg_mode_string(mon_mode));
943 
944 			drv->fw.dbg.n_dest_reg = (dest_v1) ?
945 				tlv_len -
946 				offsetof(struct iwl_fw_dbg_dest_tlv_v1,
947 					 reg_ops) :
948 				tlv_len -
949 				offsetof(struct iwl_fw_dbg_dest_tlv,
950 					 reg_ops);
951 
952 			drv->fw.dbg.n_dest_reg /=
953 				sizeof(drv->fw.dbg.dest_tlv->reg_ops[0]);
954 
955 			break;
956 			}
957 		case IWL_UCODE_TLV_FW_DBG_CONF: {
958 			struct iwl_fw_dbg_conf_tlv *conf = (void *)tlv_data;
959 
960 			if (!pieces->dbg_dest_tlv_init) {
961 				IWL_ERR(drv,
962 					"Ignore dbg config %d - no destination configured\n",
963 					conf->id);
964 				break;
965 			}
966 
967 			if (conf->id >= ARRAY_SIZE(drv->fw.dbg.conf_tlv)) {
968 				IWL_ERR(drv,
969 					"Skip unknown configuration: %d\n",
970 					conf->id);
971 				break;
972 			}
973 
974 			if (pieces->dbg_conf_tlv[conf->id]) {
975 				IWL_ERR(drv,
976 					"Ignore duplicate dbg config %d\n",
977 					conf->id);
978 				break;
979 			}
980 
981 			if (conf->usniffer)
982 				usniffer_req = true;
983 
984 			IWL_INFO(drv, "Found debug configuration: %d\n",
985 				 conf->id);
986 
987 			pieces->dbg_conf_tlv[conf->id] = conf;
988 			pieces->dbg_conf_tlv_len[conf->id] = tlv_len;
989 			break;
990 			}
991 		case IWL_UCODE_TLV_FW_DBG_TRIGGER: {
992 			struct iwl_fw_dbg_trigger_tlv *trigger =
993 				(void *)tlv_data;
994 			u32 trigger_id = le32_to_cpu(trigger->id);
995 
996 			if (trigger_id >= ARRAY_SIZE(drv->fw.dbg.trigger_tlv)) {
997 				IWL_ERR(drv,
998 					"Skip unknown trigger: %u\n",
999 					trigger->id);
1000 				break;
1001 			}
1002 
1003 			if (pieces->dbg_trigger_tlv[trigger_id]) {
1004 				IWL_ERR(drv,
1005 					"Ignore duplicate dbg trigger %u\n",
1006 					trigger->id);
1007 				break;
1008 			}
1009 
1010 			IWL_INFO(drv, "Found debug trigger: %u\n", trigger->id);
1011 
1012 			pieces->dbg_trigger_tlv[trigger_id] = trigger;
1013 			pieces->dbg_trigger_tlv_len[trigger_id] = tlv_len;
1014 			break;
1015 			}
1016 		case IWL_UCODE_TLV_FW_DBG_DUMP_LST: {
1017 			if (tlv_len != sizeof(u32)) {
1018 				IWL_ERR(drv,
1019 					"dbg lst mask size incorrect, skip\n");
1020 				break;
1021 			}
1022 
1023 			drv->fw.dbg.dump_mask =
1024 				le32_to_cpup((__le32 *)tlv_data);
1025 			break;
1026 			}
1027 		case IWL_UCODE_TLV_SEC_RT_USNIFFER:
1028 			*usniffer_images = true;
1029 			iwl_store_ucode_sec(pieces, tlv_data,
1030 					    IWL_UCODE_REGULAR_USNIFFER,
1031 					    tlv_len);
1032 			break;
1033 		case IWL_UCODE_TLV_PAGING:
1034 			if (tlv_len != sizeof(u32))
1035 				goto invalid_tlv_len;
1036 			paging_mem_size = le32_to_cpup((__le32 *)tlv_data);
1037 
1038 			IWL_DEBUG_FW(drv,
1039 				     "Paging: paging enabled (size = %u bytes)\n",
1040 				     paging_mem_size);
1041 
1042 			if (paging_mem_size > MAX_PAGING_IMAGE_SIZE) {
1043 				IWL_ERR(drv,
1044 					"Paging: driver supports up to %lu bytes for paging image\n",
1045 					MAX_PAGING_IMAGE_SIZE);
1046 				return -EINVAL;
1047 			}
1048 
1049 			if (paging_mem_size & (FW_PAGING_SIZE - 1)) {
1050 				IWL_ERR(drv,
1051 					"Paging: image isn't multiple %lu\n",
1052 					FW_PAGING_SIZE);
1053 				return -EINVAL;
1054 			}
1055 
1056 			drv->fw.img[IWL_UCODE_REGULAR].paging_mem_size =
1057 				paging_mem_size;
1058 			usniffer_img = IWL_UCODE_REGULAR_USNIFFER;
1059 			drv->fw.img[usniffer_img].paging_mem_size =
1060 				paging_mem_size;
1061 			break;
1062 		case IWL_UCODE_TLV_FW_GSCAN_CAPA:
1063 			/* ignored */
1064 			break;
1065 		case IWL_UCODE_TLV_FW_MEM_SEG: {
1066 			struct iwl_fw_dbg_mem_seg_tlv *dbg_mem =
1067 				(void *)tlv_data;
1068 			size_t size;
1069 			struct iwl_fw_dbg_mem_seg_tlv *n;
1070 
1071 			if (tlv_len != (sizeof(*dbg_mem)))
1072 				goto invalid_tlv_len;
1073 
1074 			IWL_DEBUG_INFO(drv, "Found debug memory segment: %u\n",
1075 				       dbg_mem->data_type);
1076 
1077 			size = sizeof(*pieces->dbg_mem_tlv) *
1078 			       (pieces->n_mem_tlv + 1);
1079 			n = krealloc(pieces->dbg_mem_tlv, size, GFP_KERNEL);
1080 			if (!n)
1081 				return -ENOMEM;
1082 			pieces->dbg_mem_tlv = n;
1083 			pieces->dbg_mem_tlv[pieces->n_mem_tlv] = *dbg_mem;
1084 			pieces->n_mem_tlv++;
1085 			break;
1086 			}
1087 		case IWL_UCODE_TLV_IML: {
1088 			drv->fw.iml_len = tlv_len;
1089 			drv->fw.iml = kmemdup(tlv_data, tlv_len, GFP_KERNEL);
1090 			if (!drv->fw.iml)
1091 				return -ENOMEM;
1092 			break;
1093 			}
1094 		case IWL_UCODE_TLV_FW_RECOVERY_INFO: {
1095 			struct {
1096 				__le32 buf_addr;
1097 				__le32 buf_size;
1098 			} *recov_info = (void *)tlv_data;
1099 
1100 			if (tlv_len != sizeof(*recov_info))
1101 				goto invalid_tlv_len;
1102 			capa->error_log_addr =
1103 				le32_to_cpu(recov_info->buf_addr);
1104 			capa->error_log_size =
1105 				le32_to_cpu(recov_info->buf_size);
1106 			}
1107 			break;
1108 		case IWL_UCODE_TLV_UMAC_DEBUG_ADDRS: {
1109 			struct iwl_umac_debug_addrs *dbg_ptrs =
1110 				(void *)tlv_data;
1111 
1112 			if (tlv_len != sizeof(*dbg_ptrs))
1113 				goto invalid_tlv_len;
1114 			if (drv->trans->cfg->device_family <
1115 			    IWL_DEVICE_FAMILY_22000)
1116 				break;
1117 			drv->trans->umac_error_event_table =
1118 				le32_to_cpu(dbg_ptrs->error_info_addr) &
1119 				~FW_ADDR_CACHE_CONTROL;
1120 			drv->trans->error_event_table_tlv_status |=
1121 				IWL_ERROR_EVENT_TABLE_UMAC;
1122 			break;
1123 			}
1124 		case IWL_UCODE_TLV_LMAC_DEBUG_ADDRS: {
1125 			struct iwl_lmac_debug_addrs *dbg_ptrs =
1126 				(void *)tlv_data;
1127 
1128 			if (tlv_len != sizeof(*dbg_ptrs))
1129 				goto invalid_tlv_len;
1130 			if (drv->trans->cfg->device_family <
1131 			    IWL_DEVICE_FAMILY_22000)
1132 				break;
1133 			drv->trans->lmac_error_event_table[0] =
1134 				le32_to_cpu(dbg_ptrs->error_event_table_ptr) &
1135 				~FW_ADDR_CACHE_CONTROL;
1136 			drv->trans->error_event_table_tlv_status |=
1137 				IWL_ERROR_EVENT_TABLE_LMAC1;
1138 			break;
1139 			}
1140 		case IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION:
1141 		case IWL_UCODE_TLV_TYPE_HCMD:
1142 		case IWL_UCODE_TLV_TYPE_REGIONS:
1143 		case IWL_UCODE_TLV_TYPE_TRIGGERS:
1144 		case IWL_UCODE_TLV_TYPE_DEBUG_FLOW:
1145 			if (iwlwifi_mod_params.enable_ini)
1146 				iwl_fw_dbg_copy_tlv(drv->trans, tlv, false);
1147 			break;
1148 		case IWL_UCODE_TLV_CMD_VERSIONS:
1149 			if (tlv_len % sizeof(struct iwl_fw_cmd_version)) {
1150 				IWL_ERR(drv,
1151 					"Invalid length for command versions: %u\n",
1152 					tlv_len);
1153 				tlv_len /= sizeof(struct iwl_fw_cmd_version);
1154 				tlv_len *= sizeof(struct iwl_fw_cmd_version);
1155 			}
1156 			if (WARN_ON(capa->cmd_versions))
1157 				return -EINVAL;
1158 			capa->cmd_versions = kmemdup(tlv_data, tlv_len,
1159 						     GFP_KERNEL);
1160 			if (!capa->cmd_versions)
1161 				return -ENOMEM;
1162 			capa->n_cmd_versions =
1163 				tlv_len / sizeof(struct iwl_fw_cmd_version);
1164 			break;
1165 		default:
1166 			IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
1167 			break;
1168 		}
1169 	}
1170 
1171 	if (!fw_has_capa(capa, IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED) &&
1172 	    usniffer_req && !*usniffer_images) {
1173 		IWL_ERR(drv,
1174 			"user selected to work with usniffer but usniffer image isn't available in ucode package\n");
1175 		return -EINVAL;
1176 	}
1177 
1178 	if (len) {
1179 		IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
1180 		iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
1181 		return -EINVAL;
1182 	}
1183 
1184 	return 0;
1185 
1186  invalid_tlv_len:
1187 	IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
1188  tlv_error:
1189 	iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
1190 
1191 	return -EINVAL;
1192 }
1193 
1194 static int iwl_alloc_ucode(struct iwl_drv *drv,
1195 			   struct iwl_firmware_pieces *pieces,
1196 			   enum iwl_ucode_type type)
1197 {
1198 	int i;
1199 	struct fw_desc *sec;
1200 
1201 	sec = kcalloc(pieces->img[type].sec_counter, sizeof(*sec), GFP_KERNEL);
1202 	if (!sec)
1203 		return -ENOMEM;
1204 	drv->fw.img[type].sec = sec;
1205 	drv->fw.img[type].num_sec = pieces->img[type].sec_counter;
1206 
1207 	for (i = 0; i < pieces->img[type].sec_counter; i++)
1208 		if (iwl_alloc_fw_desc(drv, &sec[i], get_sec(pieces, type, i)))
1209 			return -ENOMEM;
1210 
1211 	return 0;
1212 }
1213 
1214 static int validate_sec_sizes(struct iwl_drv *drv,
1215 			      struct iwl_firmware_pieces *pieces,
1216 			      const struct iwl_cfg *cfg)
1217 {
1218 	IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %zd\n",
1219 		get_sec_size(pieces, IWL_UCODE_REGULAR,
1220 			     IWL_UCODE_SECTION_INST));
1221 	IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %zd\n",
1222 		get_sec_size(pieces, IWL_UCODE_REGULAR,
1223 			     IWL_UCODE_SECTION_DATA));
1224 	IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %zd\n",
1225 		get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
1226 	IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %zd\n",
1227 		get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
1228 
1229 	/* Verify that uCode images will fit in card's SRAM. */
1230 	if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
1231 	    cfg->max_inst_size) {
1232 		IWL_ERR(drv, "uCode instr len %zd too large to fit in\n",
1233 			get_sec_size(pieces, IWL_UCODE_REGULAR,
1234 				     IWL_UCODE_SECTION_INST));
1235 		return -1;
1236 	}
1237 
1238 	if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
1239 	    cfg->max_data_size) {
1240 		IWL_ERR(drv, "uCode data len %zd too large to fit in\n",
1241 			get_sec_size(pieces, IWL_UCODE_REGULAR,
1242 				     IWL_UCODE_SECTION_DATA));
1243 		return -1;
1244 	}
1245 
1246 	if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
1247 	     cfg->max_inst_size) {
1248 		IWL_ERR(drv, "uCode init instr len %zd too large to fit in\n",
1249 			get_sec_size(pieces, IWL_UCODE_INIT,
1250 				     IWL_UCODE_SECTION_INST));
1251 		return -1;
1252 	}
1253 
1254 	if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
1255 	    cfg->max_data_size) {
1256 		IWL_ERR(drv, "uCode init data len %zd too large to fit in\n",
1257 			get_sec_size(pieces, IWL_UCODE_REGULAR,
1258 				     IWL_UCODE_SECTION_DATA));
1259 		return -1;
1260 	}
1261 	return 0;
1262 }
1263 
1264 static struct iwl_op_mode *
1265 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
1266 {
1267 	const struct iwl_op_mode_ops *ops = op->ops;
1268 	struct dentry *dbgfs_dir = NULL;
1269 	struct iwl_op_mode *op_mode = NULL;
1270 
1271 #ifdef CONFIG_IWLWIFI_DEBUGFS
1272 	drv->dbgfs_op_mode = debugfs_create_dir(op->name,
1273 						drv->dbgfs_drv);
1274 	dbgfs_dir = drv->dbgfs_op_mode;
1275 #endif
1276 
1277 	op_mode = ops->start(drv->trans, drv->trans->cfg, &drv->fw, dbgfs_dir);
1278 
1279 #ifdef CONFIG_IWLWIFI_DEBUGFS
1280 	if (!op_mode) {
1281 		debugfs_remove_recursive(drv->dbgfs_op_mode);
1282 		drv->dbgfs_op_mode = NULL;
1283 	}
1284 #endif
1285 
1286 	return op_mode;
1287 }
1288 
1289 static void _iwl_op_mode_stop(struct iwl_drv *drv)
1290 {
1291 	/* op_mode can be NULL if its start failed */
1292 	if (drv->op_mode) {
1293 		iwl_op_mode_stop(drv->op_mode);
1294 		drv->op_mode = NULL;
1295 
1296 #ifdef CONFIG_IWLWIFI_DEBUGFS
1297 		debugfs_remove_recursive(drv->dbgfs_op_mode);
1298 		drv->dbgfs_op_mode = NULL;
1299 #endif
1300 	}
1301 }
1302 
1303 /**
1304  * iwl_req_fw_callback - callback when firmware was loaded
1305  *
1306  * If loaded successfully, copies the firmware into buffers
1307  * for the card to fetch (via DMA).
1308  */
1309 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
1310 {
1311 	struct iwl_drv *drv = context;
1312 	struct iwl_fw *fw = &drv->fw;
1313 	struct iwl_ucode_header *ucode;
1314 	struct iwlwifi_opmode_table *op;
1315 	int err;
1316 	struct iwl_firmware_pieces *pieces;
1317 	const unsigned int api_max = drv->trans->cfg->ucode_api_max;
1318 	const unsigned int api_min = drv->trans->cfg->ucode_api_min;
1319 	size_t trigger_tlv_sz[FW_DBG_TRIGGER_MAX];
1320 	u32 api_ver;
1321 	int i;
1322 	bool load_module = false;
1323 	bool usniffer_images = false;
1324 
1325 	fw->ucode_capa.max_probe_length = IWL_DEFAULT_MAX_PROBE_LENGTH;
1326 	fw->ucode_capa.standard_phy_calibration_size =
1327 			IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1328 	fw->ucode_capa.n_scan_channels = IWL_DEFAULT_SCAN_CHANNELS;
1329 	/* dump all fw memory areas by default */
1330 	fw->dbg.dump_mask = 0xffffffff;
1331 
1332 	pieces = kzalloc(sizeof(*pieces), GFP_KERNEL);
1333 	if (!pieces)
1334 		goto out_free_fw;
1335 
1336 	if (!ucode_raw)
1337 		goto try_again;
1338 
1339 	IWL_DEBUG_FW_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
1340 			  drv->firmware_name, ucode_raw->size);
1341 
1342 	/* Make sure that we got at least the API version number */
1343 	if (ucode_raw->size < 4) {
1344 		IWL_ERR(drv, "File size way too small!\n");
1345 		goto try_again;
1346 	}
1347 
1348 	/* Data from ucode file:  header followed by uCode images */
1349 	ucode = (struct iwl_ucode_header *)ucode_raw->data;
1350 
1351 	if (ucode->ver)
1352 		err = iwl_parse_v1_v2_firmware(drv, ucode_raw, pieces);
1353 	else
1354 		err = iwl_parse_tlv_firmware(drv, ucode_raw, pieces,
1355 					     &fw->ucode_capa, &usniffer_images);
1356 
1357 	if (err)
1358 		goto try_again;
1359 
1360 	if (fw_has_api(&drv->fw.ucode_capa, IWL_UCODE_TLV_API_NEW_VERSION))
1361 		api_ver = drv->fw.ucode_ver;
1362 	else
1363 		api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
1364 
1365 	/*
1366 	 * api_ver should match the api version forming part of the
1367 	 * firmware filename ... but we don't check for that and only rely
1368 	 * on the API version read from firmware header from here on forward
1369 	 */
1370 	if (api_ver < api_min || api_ver > api_max) {
1371 		IWL_ERR(drv,
1372 			"Driver unable to support your firmware API. "
1373 			"Driver supports v%u, firmware is v%u.\n",
1374 			api_max, api_ver);
1375 		goto try_again;
1376 	}
1377 
1378 	/*
1379 	 * In mvm uCode there is no difference between data and instructions
1380 	 * sections.
1381 	 */
1382 	if (fw->type == IWL_FW_DVM && validate_sec_sizes(drv, pieces,
1383 							 drv->trans->cfg))
1384 		goto try_again;
1385 
1386 	/* Allocate ucode buffers for card's bus-master loading ... */
1387 
1388 	/* Runtime instructions and 2 copies of data:
1389 	 * 1) unmodified from disk
1390 	 * 2) backup cache for save/restore during power-downs
1391 	 */
1392 	for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
1393 		if (iwl_alloc_ucode(drv, pieces, i))
1394 			goto out_free_fw;
1395 
1396 	if (pieces->dbg_dest_tlv_init) {
1397 		size_t dbg_dest_size = sizeof(*drv->fw.dbg.dest_tlv) +
1398 			sizeof(drv->fw.dbg.dest_tlv->reg_ops[0]) *
1399 			drv->fw.dbg.n_dest_reg;
1400 
1401 		drv->fw.dbg.dest_tlv = kmalloc(dbg_dest_size, GFP_KERNEL);
1402 
1403 		if (!drv->fw.dbg.dest_tlv)
1404 			goto out_free_fw;
1405 
1406 		if (*pieces->dbg_dest_ver == 0) {
1407 			memcpy(drv->fw.dbg.dest_tlv, pieces->dbg_dest_tlv_v1,
1408 			       dbg_dest_size);
1409 		} else {
1410 			struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv =
1411 				drv->fw.dbg.dest_tlv;
1412 
1413 			dest_tlv->version = pieces->dbg_dest_tlv->version;
1414 			dest_tlv->monitor_mode =
1415 				pieces->dbg_dest_tlv->monitor_mode;
1416 			dest_tlv->size_power =
1417 				pieces->dbg_dest_tlv->size_power;
1418 			dest_tlv->wrap_count =
1419 				pieces->dbg_dest_tlv->wrap_count;
1420 			dest_tlv->write_ptr_reg =
1421 				pieces->dbg_dest_tlv->write_ptr_reg;
1422 			dest_tlv->base_shift =
1423 				pieces->dbg_dest_tlv->base_shift;
1424 			memcpy(dest_tlv->reg_ops,
1425 			       pieces->dbg_dest_tlv->reg_ops,
1426 			       sizeof(drv->fw.dbg.dest_tlv->reg_ops[0]) *
1427 			       drv->fw.dbg.n_dest_reg);
1428 
1429 			/* In version 1 of the destination tlv, which is
1430 			 * relevant for internal buffer exclusively,
1431 			 * the base address is part of given with the length
1432 			 * of the buffer, and the size shift is give instead of
1433 			 * end shift. We now store these values in base_reg,
1434 			 * and end shift, and when dumping the data we'll
1435 			 * manipulate it for extracting both the length and
1436 			 * base address */
1437 			dest_tlv->base_reg = pieces->dbg_dest_tlv->cfg_reg;
1438 			dest_tlv->end_shift =
1439 				pieces->dbg_dest_tlv->size_shift;
1440 		}
1441 	}
1442 
1443 	for (i = 0; i < ARRAY_SIZE(drv->fw.dbg.conf_tlv); i++) {
1444 		if (pieces->dbg_conf_tlv[i]) {
1445 			drv->fw.dbg.conf_tlv[i] =
1446 				kmemdup(pieces->dbg_conf_tlv[i],
1447 					pieces->dbg_conf_tlv_len[i],
1448 					GFP_KERNEL);
1449 			if (!pieces->dbg_conf_tlv_len[i])
1450 				goto out_free_fw;
1451 		}
1452 	}
1453 
1454 	memset(&trigger_tlv_sz, 0xff, sizeof(trigger_tlv_sz));
1455 
1456 	trigger_tlv_sz[FW_DBG_TRIGGER_MISSED_BEACONS] =
1457 		sizeof(struct iwl_fw_dbg_trigger_missed_bcon);
1458 	trigger_tlv_sz[FW_DBG_TRIGGER_CHANNEL_SWITCH] = 0;
1459 	trigger_tlv_sz[FW_DBG_TRIGGER_FW_NOTIF] =
1460 		sizeof(struct iwl_fw_dbg_trigger_cmd);
1461 	trigger_tlv_sz[FW_DBG_TRIGGER_MLME] =
1462 		sizeof(struct iwl_fw_dbg_trigger_mlme);
1463 	trigger_tlv_sz[FW_DBG_TRIGGER_STATS] =
1464 		sizeof(struct iwl_fw_dbg_trigger_stats);
1465 	trigger_tlv_sz[FW_DBG_TRIGGER_RSSI] =
1466 		sizeof(struct iwl_fw_dbg_trigger_low_rssi);
1467 	trigger_tlv_sz[FW_DBG_TRIGGER_TXQ_TIMERS] =
1468 		sizeof(struct iwl_fw_dbg_trigger_txq_timer);
1469 	trigger_tlv_sz[FW_DBG_TRIGGER_TIME_EVENT] =
1470 		sizeof(struct iwl_fw_dbg_trigger_time_event);
1471 	trigger_tlv_sz[FW_DBG_TRIGGER_BA] =
1472 		sizeof(struct iwl_fw_dbg_trigger_ba);
1473 	trigger_tlv_sz[FW_DBG_TRIGGER_TDLS] =
1474 		sizeof(struct iwl_fw_dbg_trigger_tdls);
1475 
1476 	for (i = 0; i < ARRAY_SIZE(drv->fw.dbg.trigger_tlv); i++) {
1477 		if (pieces->dbg_trigger_tlv[i]) {
1478 			/*
1479 			 * If the trigger isn't long enough, WARN and exit.
1480 			 * Someone is trying to debug something and he won't
1481 			 * be able to catch the bug he is trying to chase.
1482 			 * We'd better be noisy to be sure he knows what's
1483 			 * going on.
1484 			 */
1485 			if (WARN_ON(pieces->dbg_trigger_tlv_len[i] <
1486 				    (trigger_tlv_sz[i] +
1487 				     sizeof(struct iwl_fw_dbg_trigger_tlv))))
1488 				goto out_free_fw;
1489 			drv->fw.dbg.trigger_tlv_len[i] =
1490 				pieces->dbg_trigger_tlv_len[i];
1491 			drv->fw.dbg.trigger_tlv[i] =
1492 				kmemdup(pieces->dbg_trigger_tlv[i],
1493 					drv->fw.dbg.trigger_tlv_len[i],
1494 					GFP_KERNEL);
1495 			if (!drv->fw.dbg.trigger_tlv[i])
1496 				goto out_free_fw;
1497 		}
1498 	}
1499 
1500 	/* Now that we can no longer fail, copy information */
1501 
1502 	drv->fw.dbg.mem_tlv = pieces->dbg_mem_tlv;
1503 	pieces->dbg_mem_tlv = NULL;
1504 	drv->fw.dbg.n_mem_tlv = pieces->n_mem_tlv;
1505 
1506 	/*
1507 	 * The (size - 16) / 12 formula is based on the information recorded
1508 	 * for each event, which is of mode 1 (including timestamp) for all
1509 	 * new microcodes that include this information.
1510 	 */
1511 	fw->init_evtlog_ptr = pieces->init_evtlog_ptr;
1512 	if (pieces->init_evtlog_size)
1513 		fw->init_evtlog_size = (pieces->init_evtlog_size - 16)/12;
1514 	else
1515 		fw->init_evtlog_size =
1516 			drv->trans->cfg->base_params->max_event_log_size;
1517 	fw->init_errlog_ptr = pieces->init_errlog_ptr;
1518 	fw->inst_evtlog_ptr = pieces->inst_evtlog_ptr;
1519 	if (pieces->inst_evtlog_size)
1520 		fw->inst_evtlog_size = (pieces->inst_evtlog_size - 16)/12;
1521 	else
1522 		fw->inst_evtlog_size =
1523 			drv->trans->cfg->base_params->max_event_log_size;
1524 	fw->inst_errlog_ptr = pieces->inst_errlog_ptr;
1525 
1526 	/*
1527 	 * figure out the offset of chain noise reset and gain commands
1528 	 * base on the size of standard phy calibration commands table size
1529 	 */
1530 	if (fw->ucode_capa.standard_phy_calibration_size >
1531 	    IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
1532 		fw->ucode_capa.standard_phy_calibration_size =
1533 			IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1534 
1535 	/* We have our copies now, allow OS release its copies */
1536 	release_firmware(ucode_raw);
1537 
1538 	mutex_lock(&iwlwifi_opmode_table_mtx);
1539 	switch (fw->type) {
1540 	case IWL_FW_DVM:
1541 		op = &iwlwifi_opmode_table[DVM_OP_MODE];
1542 		break;
1543 	default:
1544 		WARN(1, "Invalid fw type %d\n", fw->type);
1545 		/* fall through */
1546 	case IWL_FW_MVM:
1547 		op = &iwlwifi_opmode_table[MVM_OP_MODE];
1548 		break;
1549 	}
1550 
1551 	IWL_INFO(drv, "loaded firmware version %s op_mode %s\n",
1552 		 drv->fw.fw_version, op->name);
1553 
1554 	/* add this device to the list of devices using this op_mode */
1555 	list_add_tail(&drv->list, &op->drv);
1556 
1557 	if (op->ops) {
1558 		drv->op_mode = _iwl_op_mode_start(drv, op);
1559 
1560 		if (!drv->op_mode) {
1561 			mutex_unlock(&iwlwifi_opmode_table_mtx);
1562 			goto out_unbind;
1563 		}
1564 	} else {
1565 		load_module = true;
1566 	}
1567 	mutex_unlock(&iwlwifi_opmode_table_mtx);
1568 
1569 	/*
1570 	 * Complete the firmware request last so that
1571 	 * a driver unbind (stop) doesn't run while we
1572 	 * are doing the start() above.
1573 	 */
1574 	complete(&drv->request_firmware_complete);
1575 
1576 	/*
1577 	 * Load the module last so we don't block anything
1578 	 * else from proceeding if the module fails to load
1579 	 * or hangs loading.
1580 	 */
1581 	if (load_module) {
1582 		request_module("%s", op->name);
1583 #ifdef CONFIG_IWLWIFI_OPMODE_MODULAR
1584 		if (err)
1585 			IWL_ERR(drv,
1586 				"failed to load module %s (error %d), is dynamic loading enabled?\n",
1587 				op->name, err);
1588 #endif
1589 	}
1590 	goto free;
1591 
1592  try_again:
1593 	/* try next, if any */
1594 	release_firmware(ucode_raw);
1595 	if (iwl_request_firmware(drv, false))
1596 		goto out_unbind;
1597 	goto free;
1598 
1599  out_free_fw:
1600 	release_firmware(ucode_raw);
1601  out_unbind:
1602 	complete(&drv->request_firmware_complete);
1603 	device_release_driver(drv->trans->dev);
1604  free:
1605 	if (pieces) {
1606 		for (i = 0; i < ARRAY_SIZE(pieces->img); i++)
1607 			kfree(pieces->img[i].sec);
1608 		kfree(pieces->dbg_mem_tlv);
1609 		kfree(pieces);
1610 	}
1611 }
1612 
1613 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans)
1614 {
1615 	struct iwl_drv *drv;
1616 	int ret;
1617 
1618 	drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1619 	if (!drv) {
1620 		ret = -ENOMEM;
1621 		goto err;
1622 	}
1623 
1624 	drv->trans = trans;
1625 	drv->dev = trans->dev;
1626 
1627 	init_completion(&drv->request_firmware_complete);
1628 	INIT_LIST_HEAD(&drv->list);
1629 
1630 #ifdef CONFIG_IWLWIFI_DEBUGFS
1631 	/* Create the device debugfs entries. */
1632 	drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1633 					    iwl_dbgfs_root);
1634 
1635 	/* Create transport layer debugfs dir */
1636 	drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1637 #endif
1638 
1639 	ret = iwl_request_firmware(drv, true);
1640 	if (ret) {
1641 		IWL_ERR(trans, "Couldn't request the fw\n");
1642 		goto err_fw;
1643 	}
1644 
1645 	return drv;
1646 
1647 err_fw:
1648 #ifdef CONFIG_IWLWIFI_DEBUGFS
1649 	debugfs_remove_recursive(drv->dbgfs_drv);
1650 	iwl_fw_dbg_free(drv->trans);
1651 #endif
1652 	kfree(drv);
1653 err:
1654 	return ERR_PTR(ret);
1655 }
1656 
1657 void iwl_drv_stop(struct iwl_drv *drv)
1658 {
1659 	wait_for_completion(&drv->request_firmware_complete);
1660 
1661 	_iwl_op_mode_stop(drv);
1662 
1663 	iwl_dealloc_ucode(drv);
1664 
1665 	mutex_lock(&iwlwifi_opmode_table_mtx);
1666 	/*
1667 	 * List is empty (this item wasn't added)
1668 	 * when firmware loading failed -- in that
1669 	 * case we can't remove it from any list.
1670 	 */
1671 	if (!list_empty(&drv->list))
1672 		list_del(&drv->list);
1673 	mutex_unlock(&iwlwifi_opmode_table_mtx);
1674 
1675 #ifdef CONFIG_IWLWIFI_DEBUGFS
1676 	drv->trans->ops->debugfs_cleanup(drv->trans);
1677 
1678 	debugfs_remove_recursive(drv->dbgfs_drv);
1679 #endif
1680 
1681 	iwl_fw_dbg_free(drv->trans);
1682 
1683 	kfree(drv);
1684 }
1685 
1686 
1687 /* shared module parameters */
1688 struct iwl_mod_params iwlwifi_mod_params = {
1689 	.fw_restart = true,
1690 	.bt_coex_active = true,
1691 	.power_level = IWL_POWER_INDEX_1,
1692 	.d0i3_disable = true,
1693 	.d0i3_timeout = 1000,
1694 	.uapsd_disable = IWL_DISABLE_UAPSD_BSS | IWL_DISABLE_UAPSD_P2P_CLIENT,
1695 	/* the rest are 0 by default */
1696 };
1697 IWL_EXPORT_SYMBOL(iwlwifi_mod_params);
1698 
1699 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
1700 {
1701 	int i;
1702 	struct iwl_drv *drv;
1703 	struct iwlwifi_opmode_table *op;
1704 
1705 	mutex_lock(&iwlwifi_opmode_table_mtx);
1706 	for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1707 		op = &iwlwifi_opmode_table[i];
1708 		if (strcmp(op->name, name))
1709 			continue;
1710 		op->ops = ops;
1711 		/* TODO: need to handle exceptional case */
1712 		list_for_each_entry(drv, &op->drv, list)
1713 			drv->op_mode = _iwl_op_mode_start(drv, op);
1714 
1715 		mutex_unlock(&iwlwifi_opmode_table_mtx);
1716 		return 0;
1717 	}
1718 	mutex_unlock(&iwlwifi_opmode_table_mtx);
1719 	return -EIO;
1720 }
1721 IWL_EXPORT_SYMBOL(iwl_opmode_register);
1722 
1723 void iwl_opmode_deregister(const char *name)
1724 {
1725 	int i;
1726 	struct iwl_drv *drv;
1727 
1728 	mutex_lock(&iwlwifi_opmode_table_mtx);
1729 	for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
1730 		if (strcmp(iwlwifi_opmode_table[i].name, name))
1731 			continue;
1732 		iwlwifi_opmode_table[i].ops = NULL;
1733 
1734 		/* call the stop routine for all devices */
1735 		list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
1736 			_iwl_op_mode_stop(drv);
1737 
1738 		mutex_unlock(&iwlwifi_opmode_table_mtx);
1739 		return;
1740 	}
1741 	mutex_unlock(&iwlwifi_opmode_table_mtx);
1742 }
1743 IWL_EXPORT_SYMBOL(iwl_opmode_deregister);
1744 
1745 static int __init iwl_drv_init(void)
1746 {
1747 	int i;
1748 
1749 	mutex_init(&iwlwifi_opmode_table_mtx);
1750 
1751 	for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
1752 		INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
1753 
1754 	pr_info(DRV_DESCRIPTION "\n");
1755 	pr_info(DRV_COPYRIGHT "\n");
1756 
1757 #ifdef CONFIG_IWLWIFI_DEBUGFS
1758 	/* Create the root of iwlwifi debugfs subsystem. */
1759 	iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
1760 #endif
1761 
1762 	return iwl_pci_register_driver();
1763 }
1764 module_init(iwl_drv_init);
1765 
1766 static void __exit iwl_drv_exit(void)
1767 {
1768 	iwl_pci_unregister_driver();
1769 
1770 #ifdef CONFIG_IWLWIFI_DEBUGFS
1771 	debugfs_remove_recursive(iwl_dbgfs_root);
1772 #endif
1773 }
1774 module_exit(iwl_drv_exit);
1775 
1776 #ifdef CONFIG_IWLWIFI_DEBUG
1777 module_param_named(debug, iwlwifi_mod_params.debug_level, uint, 0644);
1778 MODULE_PARM_DESC(debug, "debug output mask");
1779 #endif
1780 
1781 module_param_named(swcrypto, iwlwifi_mod_params.swcrypto, int, 0444);
1782 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
1783 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, 0444);
1784 MODULE_PARM_DESC(11n_disable,
1785 	"disable 11n functionality, bitmap: 1: full, 2: disable agg TX, 4: disable agg RX, 8 enable agg TX");
1786 module_param_named(amsdu_size, iwlwifi_mod_params.amsdu_size, int, 0444);
1787 MODULE_PARM_DESC(amsdu_size,
1788 		 "amsdu size 0: 12K for multi Rx queue devices, 2K for 22560 devices, "
1789 		 "4K for other devices 1:4K 2:8K 3:12K 4: 2K (default 0)");
1790 module_param_named(fw_restart, iwlwifi_mod_params.fw_restart, bool, 0444);
1791 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error (default true)");
1792 
1793 module_param_named(antenna_coupling, iwlwifi_mod_params.antenna_coupling,
1794 		   int, 0444);
1795 MODULE_PARM_DESC(antenna_coupling,
1796 		 "specify antenna coupling in dB (default: 0 dB)");
1797 
1798 module_param_named(nvm_file, iwlwifi_mod_params.nvm_file, charp, 0444);
1799 MODULE_PARM_DESC(nvm_file, "NVM file name");
1800 
1801 module_param_named(d0i3_disable, iwlwifi_mod_params.d0i3_disable, bool, 0444);
1802 MODULE_PARM_DESC(d0i3_disable, "disable d0i3 functionality (default: Y)");
1803 
1804 module_param_named(lar_disable, iwlwifi_mod_params.lar_disable, bool, 0444);
1805 MODULE_PARM_DESC(lar_disable, "disable LAR functionality (default: N)");
1806 
1807 module_param_named(uapsd_disable, iwlwifi_mod_params.uapsd_disable, uint, 0644);
1808 MODULE_PARM_DESC(uapsd_disable,
1809 		 "disable U-APSD functionality bitmap 1: BSS 2: P2P Client (default: 3)");
1810 module_param_named(enable_ini, iwlwifi_mod_params.enable_ini,
1811 		   bool, S_IRUGO | S_IWUSR);
1812 MODULE_PARM_DESC(enable_ini,
1813 		 "Enable debug INI TLV FW debug infrastructure (default: 0");
1814 
1815 /*
1816  * set bt_coex_active to true, uCode will do kill/defer
1817  * every time the priority line is asserted (BT is sending signals on the
1818  * priority line in the PCIx).
1819  * set bt_coex_active to false, uCode will ignore the BT activity and
1820  * perform the normal operation
1821  *
1822  * User might experience transmit issue on some platform due to WiFi/BT
1823  * co-exist problem. The possible behaviors are:
1824  *   Able to scan and finding all the available AP
1825  *   Not able to associate with any AP
1826  * On those platforms, WiFi communication can be restored by set
1827  * "bt_coex_active" module parameter to "false"
1828  *
1829  * default: bt_coex_active = true (BT_COEX_ENABLE)
1830  */
1831 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
1832 		   bool, 0444);
1833 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
1834 
1835 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, 0444);
1836 MODULE_PARM_DESC(led_mode, "0=system default, "
1837 		"1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
1838 
1839 module_param_named(power_save, iwlwifi_mod_params.power_save, bool, 0444);
1840 MODULE_PARM_DESC(power_save,
1841 		 "enable WiFi power management (default: disable)");
1842 
1843 module_param_named(power_level, iwlwifi_mod_params.power_level, int, 0444);
1844 MODULE_PARM_DESC(power_level,
1845 		 "default power save level (range from 1 - 5, default: 1)");
1846 
1847 module_param_named(fw_monitor, iwlwifi_mod_params.fw_monitor, bool, 0444);
1848 MODULE_PARM_DESC(fw_monitor,
1849 		 "firmware monitor - to debug FW (default: false - needs lots of memory)");
1850 
1851 module_param_named(d0i3_timeout, iwlwifi_mod_params.d0i3_timeout, uint, 0444);
1852 MODULE_PARM_DESC(d0i3_timeout, "Timeout to D0i3 entry when idle (ms)");
1853 
1854 module_param_named(disable_11ac, iwlwifi_mod_params.disable_11ac, bool, 0444);
1855 MODULE_PARM_DESC(disable_11ac, "Disable VHT capabilities (default: false)");
1856 
1857 module_param_named(remove_when_gone,
1858 		   iwlwifi_mod_params.remove_when_gone, bool,
1859 		   0444);
1860 MODULE_PARM_DESC(remove_when_gone,
1861 		 "Remove dev from PCIe bus if it is deemed inaccessible (default: false)");
1862 
1863 module_param_named(disable_11ax, iwlwifi_mod_params.disable_11ax, bool,
1864 		   S_IRUGO);
1865 MODULE_PARM_DESC(disable_11ax, "Disable HE capabilities (default: false)");
1866