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