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