xref: /linux/drivers/net/wireless/intel/iwlwifi/iwl-drv.c (revision c5fbdf0ba7c1a6ed52dc3650bee73ce00c86cf7f)
1 // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
2 /*
3  * Copyright (C) 2005-2014, 2018-2025 Intel Corporation
4  * Copyright (C) 2013-2015 Intel Mobile Communications GmbH
5  * Copyright (C) 2016-2017 Intel Deutschland GmbH
6  */
7 #include <linux/completion.h>
8 #include <linux/dma-mapping.h>
9 #include <linux/firmware.h>
10 #include <linux/module.h>
11 #include <linux/vmalloc.h>
12 
13 #include "iwl-drv.h"
14 #include "iwl-csr.h"
15 #include "iwl-debug.h"
16 #include "iwl-trans.h"
17 #include "iwl-op-mode.h"
18 #include "iwl-agn-hw.h"
19 #include "fw/img.h"
20 #include "iwl-dbg-tlv.h"
21 #include "iwl-config.h"
22 #include "iwl-modparams.h"
23 #include "fw/api/alive.h"
24 #include "fw/api/mac.h"
25 #include "fw/api/mac-cfg.h"
26 
27 /******************************************************************************
28  *
29  * module boiler plate
30  *
31  ******************************************************************************/
32 
33 #define DRV_DESCRIPTION	"Intel(R) Wireless WiFi driver for Linux"
34 MODULE_DESCRIPTION(DRV_DESCRIPTION);
35 MODULE_LICENSE("GPL");
36 
37 #ifdef CONFIG_IWLWIFI_DEBUGFS
38 static struct dentry *iwl_dbgfs_root;
39 #endif
40 
41 /**
42  * struct iwl_drv - drv common data
43  * @list: list of drv structures using this opmode
44  * @fw: the iwl_fw structure
45  * @op_mode: the running op_mode
46  * @trans: transport layer
47  * @dev: for debug prints only
48  * @fw_index: firmware revision to try loading
49  * @firmware_name: composite filename of ucode file to load
50  * @request_firmware_complete: the firmware has been obtained from user space
51  * @dbgfs_drv: debugfs root directory entry
52  * @dbgfs_trans: debugfs transport directory entry
53  * @dbgfs_op_mode: debugfs op_mode directory entry
54  */
55 struct iwl_drv {
56 	struct list_head list;
57 	struct iwl_fw fw;
58 
59 	struct iwl_op_mode *op_mode;
60 	struct iwl_trans *trans;
61 	struct device *dev;
62 
63 	int fw_index;                   /* firmware we're trying to load */
64 	char firmware_name[64];         /* name of firmware file to load */
65 
66 	struct completion request_firmware_complete;
67 
68 #ifdef CONFIG_IWLWIFI_DEBUGFS
69 	struct dentry *dbgfs_drv;
70 	struct dentry *dbgfs_trans;
71 	struct dentry *dbgfs_op_mode;
72 #endif
73 };
74 
75 enum {
76 	DVM_OP_MODE,
77 	MVM_OP_MODE,
78 #if IS_ENABLED(CONFIG_IWLMLD)
79 	MLD_OP_MODE,
80 #endif
81 };
82 
83 /* Protects the table contents, i.e. the ops pointer & drv list */
84 static DEFINE_MUTEX(iwlwifi_opmode_table_mtx);
85 static struct iwlwifi_opmode_table {
86 	const char *name;			/* name: iwldvm, iwlmvm, etc */
87 	const struct iwl_op_mode_ops *ops;	/* pointer to op_mode ops */
88 	struct list_head drv;		/* list of devices using this op_mode */
89 } iwlwifi_opmode_table[] = {		/* ops set when driver is initialized */
90 	[DVM_OP_MODE] = { .name = "iwldvm", .ops = NULL },
91 	[MVM_OP_MODE] = { .name = "iwlmvm", .ops = NULL },
92 #if IS_ENABLED(CONFIG_IWLMLD)
93 	[MLD_OP_MODE] = { .name = "iwlmld", .ops = NULL },
94 #endif
95 };
96 
97 #define IWL_DEFAULT_SCAN_CHANNELS 40
98 
99 /*
100  * struct fw_sec: Just for the image parsing process.
101  * For the fw storage we are using struct fw_desc.
102  */
103 struct fw_sec {
104 	const void *data;		/* the sec data */
105 	size_t size;			/* section size */
106 	u32 offset;			/* offset of writing in the device */
107 };
108 
109 static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
110 {
111 	vfree(desc->data);
112 	desc->data = NULL;
113 	desc->len = 0;
114 }
115 
116 static void iwl_free_fw_img(struct iwl_drv *drv, struct fw_img *img)
117 {
118 	int i;
119 	for (i = 0; i < img->num_sec; i++)
120 		iwl_free_fw_desc(drv, &img->sec[i]);
121 	kfree(img->sec);
122 }
123 
124 static void iwl_dealloc_ucode(struct iwl_drv *drv)
125 {
126 	int i;
127 
128 	kfree(drv->fw.dbg.dest_tlv);
129 	for (i = 0; i < ARRAY_SIZE(drv->fw.dbg.conf_tlv); i++)
130 		kfree(drv->fw.dbg.conf_tlv[i]);
131 	for (i = 0; i < ARRAY_SIZE(drv->fw.dbg.trigger_tlv); i++)
132 		kfree(drv->fw.dbg.trigger_tlv[i]);
133 	kfree(drv->fw.dbg.mem_tlv);
134 	kfree(drv->fw.iml);
135 	kfree(drv->fw.ucode_capa.cmd_versions);
136 	kfree(drv->fw.phy_integration_ver);
137 	kfree(drv->trans->dbg.pc_data);
138 	drv->trans->dbg.pc_data = NULL;
139 	kvfree(drv->fw.pnvm_data);
140 	drv->fw.pnvm_data = NULL;
141 	drv->fw.pnvm_size = 0;
142 
143 	for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
144 		iwl_free_fw_img(drv, drv->fw.img + i);
145 
146 	/* clear the data for the aborted load case */
147 	memset(&drv->fw, 0, sizeof(drv->fw));
148 }
149 
150 static int iwl_alloc_fw_desc(struct fw_desc *desc, struct fw_sec *sec)
151 {
152 	void *data;
153 
154 	desc->data = NULL;
155 
156 	if (!sec || !sec->size)
157 		return -EINVAL;
158 
159 	data = vmalloc(sec->size);
160 	if (!data)
161 		return -ENOMEM;
162 
163 	desc->len = sec->size;
164 	desc->offset = sec->offset;
165 	memcpy(data, sec->data, desc->len);
166 	desc->data = data;
167 
168 	return 0;
169 }
170 
171 static inline char iwl_drv_get_step(int step)
172 {
173 	if (step == SILICON_Z_STEP)
174 		return 'z';
175 	if (step == SILICON_TC_STEP)
176 		return 'a';
177 	return 'a' + step;
178 }
179 
180 static bool iwl_drv_is_wifi7_supported(struct iwl_trans *trans)
181 {
182 	return CSR_HW_RFID_TYPE(trans->info.hw_rf_id) >= IWL_CFG_RF_TYPE_FM;
183 }
184 
185 const char *iwl_drv_get_fwname_pre(struct iwl_trans *trans, char *buf)
186 {
187 	char mac_step, rf_step;
188 	const char *mac, *rf, *cdb;
189 
190 	if (trans->cfg->fw_name_pre)
191 		return trans->cfg->fw_name_pre;
192 
193 	mac_step = iwl_drv_get_step(trans->info.hw_rev_step);
194 
195 	switch (CSR_HW_REV_TYPE(trans->info.hw_rev)) {
196 	case IWL_CFG_MAC_TYPE_PU:
197 		mac = "9000-pu";
198 		mac_step = 'b';
199 		break;
200 	case IWL_CFG_MAC_TYPE_TH:
201 		mac = "9260-th";
202 		mac_step = 'b';
203 		break;
204 	case IWL_CFG_MAC_TYPE_QU:
205 		mac = "Qu";
206 		break;
207 	case IWL_CFG_MAC_TYPE_CC:
208 		/* special case - no RF since it's fixed (discrete) */
209 		scnprintf(buf, FW_NAME_PRE_BUFSIZE, "iwlwifi-cc-a0");
210 		return buf;
211 	case IWL_CFG_MAC_TYPE_QUZ:
212 		mac = "QuZ";
213 		/* all QuZ use A0 firmware */
214 		mac_step = 'a';
215 		break;
216 	case IWL_CFG_MAC_TYPE_SO:
217 	case IWL_CFG_MAC_TYPE_SOF:
218 		mac = "so";
219 		mac_step = 'a';
220 		break;
221 	case IWL_CFG_MAC_TYPE_TY:
222 		mac = "ty";
223 		mac_step = 'a';
224 		break;
225 	case IWL_CFG_MAC_TYPE_MA:
226 		mac = "ma";
227 		break;
228 	case IWL_CFG_MAC_TYPE_BZ:
229 	case IWL_CFG_MAC_TYPE_BZ_W:
230 		mac = "bz";
231 		break;
232 	case IWL_CFG_MAC_TYPE_GL:
233 		mac = "gl";
234 		break;
235 	case IWL_CFG_MAC_TYPE_SC:
236 		mac = "sc";
237 		break;
238 	case IWL_CFG_MAC_TYPE_SC2:
239 		mac = "sc2";
240 		break;
241 	case IWL_CFG_MAC_TYPE_SC2F:
242 		mac = "sc2f";
243 		break;
244 	case IWL_CFG_MAC_TYPE_BR:
245 		mac = "br";
246 		break;
247 	case IWL_CFG_MAC_TYPE_DR:
248 		mac = "dr";
249 		break;
250 	default:
251 		return "unknown-mac";
252 	}
253 
254 	rf_step = iwl_drv_get_step(CSR_HW_RFID_STEP(trans->info.hw_rf_id));
255 
256 	switch (CSR_HW_RFID_TYPE(trans->info.hw_rf_id)) {
257 	case IWL_CFG_RF_TYPE_JF1:
258 	case IWL_CFG_RF_TYPE_JF2:
259 		rf = "jf";
260 		rf_step = 'b';
261 		break;
262 	case IWL_CFG_RF_TYPE_HR1:
263 	case IWL_CFG_RF_TYPE_HR2:
264 		rf = "hr";
265 		rf_step = 'b';
266 		break;
267 	case IWL_CFG_RF_TYPE_GF:
268 		rf = "gf";
269 		rf_step = 'a';
270 		break;
271 	case IWL_CFG_RF_TYPE_FM:
272 		rf = "fm";
273 		break;
274 	case IWL_CFG_RF_TYPE_WH:
275 		rf = "wh";
276 		break;
277 	case IWL_CFG_RF_TYPE_PE:
278 		rf = "pe";
279 		break;
280 	default:
281 		return "unknown-rf";
282 	}
283 
284 	cdb = CSR_HW_RFID_IS_CDB(trans->info.hw_rf_id) ? "4" : "";
285 
286 	scnprintf(buf, FW_NAME_PRE_BUFSIZE,
287 		  "iwlwifi-%s-%c0-%s%s-%c0",
288 		  mac, mac_step, rf, cdb, rf_step);
289 
290 	return buf;
291 }
292 IWL_EXPORT_SYMBOL(iwl_drv_get_fwname_pre);
293 
294 static void iwl_req_fw_callback(const struct firmware *ucode_raw,
295 				void *context);
296 
297 static void iwl_get_ucode_api_versions(struct iwl_trans *trans,
298 				       unsigned int *api_min,
299 				       unsigned int *api_max)
300 {
301 	const struct iwl_family_base_params *base = trans->mac_cfg->base;
302 	const struct iwl_rf_cfg *cfg = trans->cfg;
303 
304 	if (!base->ucode_api_max) {
305 		*api_min = cfg->ucode_api_min;
306 		*api_max = cfg->ucode_api_max;
307 		return;
308 	}
309 
310 	if (!cfg->ucode_api_max) {
311 		*api_min = base->ucode_api_min;
312 		*api_max = base->ucode_api_max;
313 		return;
314 	}
315 
316 	*api_min = max(cfg->ucode_api_min, base->ucode_api_min);
317 	*api_max = min(cfg->ucode_api_max, base->ucode_api_max);
318 }
319 
320 static int iwl_request_firmware(struct iwl_drv *drv, bool first)
321 {
322 	char _fw_name_pre[FW_NAME_PRE_BUFSIZE];
323 	unsigned int ucode_api_max, ucode_api_min;
324 	const char *fw_name_pre;
325 
326 	iwl_get_ucode_api_versions(drv->trans, &ucode_api_min, &ucode_api_max);
327 
328 	if (drv->trans->mac_cfg->device_family == IWL_DEVICE_FAMILY_9000 &&
329 	    (drv->trans->info.hw_rev_step != SILICON_B_STEP &&
330 	     drv->trans->info.hw_rev_step != SILICON_C_STEP)) {
331 		IWL_ERR(drv,
332 			"Only HW steps B and C are currently supported (0x%0x)\n",
333 			drv->trans->info.hw_rev);
334 		return -EINVAL;
335 	}
336 
337 	fw_name_pre = iwl_drv_get_fwname_pre(drv->trans, _fw_name_pre);
338 
339 	if (first)
340 		drv->fw_index = ucode_api_max;
341 	else
342 		drv->fw_index--;
343 
344 	if (drv->fw_index < ucode_api_min) {
345 		IWL_ERR(drv, "no suitable firmware found!\n");
346 
347 		if (ucode_api_min == ucode_api_max) {
348 			IWL_ERR(drv, "%s-%d is required\n", fw_name_pre,
349 				ucode_api_max);
350 		} else {
351 			IWL_ERR(drv, "minimum version required: %s-%d\n",
352 				fw_name_pre, ucode_api_min);
353 			IWL_ERR(drv, "maximum version supported: %s-%d\n",
354 				fw_name_pre, ucode_api_max);
355 		}
356 
357 		IWL_ERR(drv,
358 			"check git://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git\n");
359 		return -ENOENT;
360 	}
361 
362 	snprintf(drv->firmware_name, sizeof(drv->firmware_name), "%s-%d.ucode",
363 		 fw_name_pre, drv->fw_index);
364 
365 	IWL_DEBUG_FW_INFO(drv, "attempting to load firmware '%s'\n",
366 			  drv->firmware_name);
367 
368 	return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
369 				       drv->trans->dev,
370 				       GFP_KERNEL, drv, iwl_req_fw_callback);
371 }
372 
373 struct fw_img_parsing {
374 	struct fw_sec *sec;
375 	int sec_counter;
376 };
377 
378 /*
379  * struct fw_sec_parsing: to extract fw section and it's offset from tlv
380  */
381 struct fw_sec_parsing {
382 	__le32 offset;
383 	const u8 data[];
384 } __packed;
385 
386 /**
387  * struct iwl_tlv_calib_data - parse the default calib data from TLV
388  *
389  * @ucode_type: the uCode to which the following default calib relates.
390  * @calib: default calibrations.
391  */
392 struct iwl_tlv_calib_data {
393 	__le32 ucode_type;
394 	struct iwl_tlv_calib_ctrl calib;
395 } __packed;
396 
397 struct iwl_firmware_pieces {
398 	struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
399 
400 	u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
401 	u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
402 
403 	/* FW debug data parsed for driver usage */
404 	bool dbg_dest_tlv_init;
405 	const u8 *dbg_dest_ver;
406 	union {
407 		const struct iwl_fw_dbg_dest_tlv *dbg_dest_tlv;
408 		const struct iwl_fw_dbg_dest_tlv_v1 *dbg_dest_tlv_v1;
409 	};
410 	const struct iwl_fw_dbg_conf_tlv *dbg_conf_tlv[FW_DBG_CONF_MAX];
411 	size_t dbg_conf_tlv_len[FW_DBG_CONF_MAX];
412 	const struct iwl_fw_dbg_trigger_tlv *dbg_trigger_tlv[FW_DBG_TRIGGER_MAX];
413 	size_t dbg_trigger_tlv_len[FW_DBG_TRIGGER_MAX];
414 	struct iwl_fw_dbg_mem_seg_tlv *dbg_mem_tlv;
415 	size_t n_mem_tlv;
416 	u32 major;
417 };
418 
419 static void alloc_sec_data(struct iwl_firmware_pieces *pieces,
420 			   enum iwl_ucode_type type,
421 			   int sec)
422 {
423 	struct fw_img_parsing *img = &pieces->img[type];
424 	struct fw_sec *sec_memory;
425 	int size = sec + 1;
426 	size_t alloc_size = sizeof(*img->sec) * size;
427 
428 	if (img->sec && img->sec_counter >= size)
429 		return;
430 
431 	sec_memory = krealloc(img->sec, alloc_size, GFP_KERNEL);
432 	if (!sec_memory)
433 		return;
434 
435 	img->sec = sec_memory;
436 	img->sec_counter = size;
437 }
438 
439 static void set_sec_data(struct iwl_firmware_pieces *pieces,
440 			 enum iwl_ucode_type type,
441 			 int sec,
442 			 const void *data)
443 {
444 	alloc_sec_data(pieces, type, sec);
445 
446 	pieces->img[type].sec[sec].data = data;
447 }
448 
449 static void set_sec_size(struct iwl_firmware_pieces *pieces,
450 			 enum iwl_ucode_type type,
451 			 int sec,
452 			 size_t size)
453 {
454 	alloc_sec_data(pieces, type, sec);
455 
456 	pieces->img[type].sec[sec].size = size;
457 }
458 
459 static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
460 			   enum iwl_ucode_type type,
461 			   int sec)
462 {
463 	return pieces->img[type].sec[sec].size;
464 }
465 
466 static void set_sec_offset(struct iwl_firmware_pieces *pieces,
467 			   enum iwl_ucode_type type,
468 			   int sec,
469 			   u32 offset)
470 {
471 	alloc_sec_data(pieces, type, sec);
472 
473 	pieces->img[type].sec[sec].offset = offset;
474 }
475 
476 /*
477  * Gets uCode section from tlv.
478  */
479 static int iwl_store_ucode_sec(struct fw_img_parsing *img,
480 			       const void *data, int size)
481 {
482 	struct fw_sec *sec;
483 	const struct fw_sec_parsing *sec_parse;
484 	size_t alloc_size;
485 
486 	if (WARN_ON(!img || !data))
487 		return -EINVAL;
488 
489 	sec_parse = (const struct fw_sec_parsing *)data;
490 
491 	alloc_size = sizeof(*img->sec) * (img->sec_counter + 1);
492 	sec = krealloc(img->sec, alloc_size, GFP_KERNEL);
493 	if (!sec)
494 		return -ENOMEM;
495 	img->sec = sec;
496 
497 	sec = &img->sec[img->sec_counter];
498 
499 	sec->offset = le32_to_cpu(sec_parse->offset);
500 	sec->data = sec_parse->data;
501 	sec->size = size - sizeof(sec_parse->offset);
502 
503 	++img->sec_counter;
504 
505 	return 0;
506 }
507 
508 static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
509 {
510 	const struct iwl_tlv_calib_data *def_calib =
511 					(const struct iwl_tlv_calib_data *)data;
512 	u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
513 	if (ucode_type >= IWL_UCODE_TYPE_MAX) {
514 		IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
515 			ucode_type);
516 		return -EINVAL;
517 	}
518 	drv->fw.default_calib[ucode_type].flow_trigger =
519 		def_calib->calib.flow_trigger;
520 	drv->fw.default_calib[ucode_type].event_trigger =
521 		def_calib->calib.event_trigger;
522 
523 	return 0;
524 }
525 
526 static void iwl_set_ucode_api_flags(struct iwl_drv *drv, const u8 *data,
527 				    struct iwl_ucode_capabilities *capa)
528 {
529 	const struct iwl_ucode_api *ucode_api = (const void *)data;
530 	u32 api_index = le32_to_cpu(ucode_api->api_index);
531 	u32 api_flags = le32_to_cpu(ucode_api->api_flags);
532 	int i;
533 
534 	if (api_index >= DIV_ROUND_UP(NUM_IWL_UCODE_TLV_API, 32)) {
535 		IWL_WARN(drv,
536 			 "api flags index %d larger than supported by driver\n",
537 			 api_index);
538 		return;
539 	}
540 
541 	for (i = 0; i < 32; i++) {
542 		if (api_flags & BIT(i))
543 			__set_bit(i + 32 * api_index, capa->_api);
544 	}
545 }
546 
547 static void iwl_set_ucode_capabilities(struct iwl_drv *drv, const u8 *data,
548 				       struct iwl_ucode_capabilities *capa)
549 {
550 	const struct iwl_ucode_capa *ucode_capa = (const void *)data;
551 	u32 api_index = le32_to_cpu(ucode_capa->api_index);
552 	u32 api_flags = le32_to_cpu(ucode_capa->api_capa);
553 	int i;
554 
555 	if (api_index >= DIV_ROUND_UP(NUM_IWL_UCODE_TLV_CAPA, 32)) {
556 		IWL_WARN(drv,
557 			 "capa flags index %d larger than supported by driver\n",
558 			 api_index);
559 		return;
560 	}
561 
562 	for (i = 0; i < 32; i++) {
563 		if (api_flags & BIT(i))
564 			__set_bit(i + 32 * api_index, capa->_capa);
565 	}
566 }
567 
568 static const char *iwl_reduced_fw_name(struct iwl_drv *drv)
569 {
570 	const char *name = drv->firmware_name;
571 
572 	if (strncmp(name, "iwlwifi-", 8) == 0)
573 		name += 8;
574 
575 	return name;
576 }
577 
578 static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
579 				    const struct firmware *ucode_raw,
580 				    struct iwl_firmware_pieces *pieces)
581 {
582 	const struct iwl_ucode_header *ucode = (const void *)ucode_raw->data;
583 	u32 api_ver, hdr_size, build;
584 	char buildstr[25];
585 	const u8 *src;
586 
587 	drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
588 	api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
589 
590 	switch (api_ver) {
591 	default:
592 		hdr_size = 28;
593 		if (ucode_raw->size < hdr_size) {
594 			IWL_ERR(drv, "File size too small!\n");
595 			return -EINVAL;
596 		}
597 		build = le32_to_cpu(ucode->u.v2.build);
598 		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
599 			     le32_to_cpu(ucode->u.v2.inst_size));
600 		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
601 			     le32_to_cpu(ucode->u.v2.data_size));
602 		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
603 			     le32_to_cpu(ucode->u.v2.init_size));
604 		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
605 			     le32_to_cpu(ucode->u.v2.init_data_size));
606 		src = ucode->u.v2.data;
607 		break;
608 	case 0:
609 	case 1:
610 	case 2:
611 		hdr_size = 24;
612 		if (ucode_raw->size < hdr_size) {
613 			IWL_ERR(drv, "File size too small!\n");
614 			return -EINVAL;
615 		}
616 		build = 0;
617 		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
618 			     le32_to_cpu(ucode->u.v1.inst_size));
619 		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
620 			     le32_to_cpu(ucode->u.v1.data_size));
621 		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
622 			     le32_to_cpu(ucode->u.v1.init_size));
623 		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
624 			     le32_to_cpu(ucode->u.v1.init_data_size));
625 		src = ucode->u.v1.data;
626 		break;
627 	}
628 
629 	if (build)
630 		sprintf(buildstr, " build %u", build);
631 	else
632 		buildstr[0] = '\0';
633 
634 	snprintf(drv->fw.fw_version,
635 		 sizeof(drv->fw.fw_version),
636 		 "%u.%u.%u.%u%s %s",
637 		 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
638 		 IWL_UCODE_MINOR(drv->fw.ucode_ver),
639 		 IWL_UCODE_API(drv->fw.ucode_ver),
640 		 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
641 		 buildstr, iwl_reduced_fw_name(drv));
642 
643 	/* Verify size of file vs. image size info in file's header */
644 
645 	if (ucode_raw->size != hdr_size +
646 	    get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
647 	    get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
648 	    get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
649 	    get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
650 
651 		IWL_ERR(drv,
652 			"uCode file size %d does not match expected size\n",
653 			(int)ucode_raw->size);
654 		return -EINVAL;
655 	}
656 
657 
658 	set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
659 	src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
660 	set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
661 		       IWLAGN_RTC_INST_LOWER_BOUND);
662 	set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
663 	src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
664 	set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
665 		       IWLAGN_RTC_DATA_LOWER_BOUND);
666 	set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
667 	src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
668 	set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
669 		       IWLAGN_RTC_INST_LOWER_BOUND);
670 	set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
671 	src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
672 	set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
673 		       IWLAGN_RTC_DATA_LOWER_BOUND);
674 	return 0;
675 }
676 
677 static void iwl_drv_set_dump_exclude(struct iwl_drv *drv,
678 				     enum iwl_ucode_tlv_type tlv_type,
679 				     const void *tlv_data, u32 tlv_len)
680 {
681 	const struct iwl_fw_dump_exclude *fw = tlv_data;
682 	struct iwl_dump_exclude *excl;
683 
684 	if (tlv_len < sizeof(*fw))
685 		return;
686 
687 	if (tlv_type == IWL_UCODE_TLV_SEC_TABLE_ADDR) {
688 		excl = &drv->fw.dump_excl[0];
689 
690 		/* second time we find this, it's for WoWLAN */
691 		if (excl->addr)
692 			excl = &drv->fw.dump_excl_wowlan[0];
693 	} else if (fw_has_capa(&drv->fw.ucode_capa,
694 			       IWL_UCODE_TLV_CAPA_CNSLDTD_D3_D0_IMG)) {
695 		/* IWL_UCODE_TLV_D3_KEK_KCK_ADDR is regular image */
696 		excl = &drv->fw.dump_excl[0];
697 	} else {
698 		/* IWL_UCODE_TLV_D3_KEK_KCK_ADDR is WoWLAN image */
699 		excl = &drv->fw.dump_excl_wowlan[0];
700 	}
701 
702 	if (excl->addr)
703 		excl++;
704 
705 	if (excl->addr) {
706 		IWL_DEBUG_FW_INFO(drv, "found too many excludes in fw file\n");
707 		return;
708 	}
709 
710 	excl->addr = le32_to_cpu(fw->addr) & ~FW_ADDR_CACHE_CONTROL;
711 	excl->size = le32_to_cpu(fw->size);
712 }
713 
714 static void iwl_parse_dbg_tlv_assert_tables(struct iwl_drv *drv,
715 					    const struct iwl_ucode_tlv *tlv)
716 {
717 	const struct iwl_fw_ini_region_tlv *region;
718 	u32 length = le32_to_cpu(tlv->length);
719 	u32 addr;
720 
721 	if (length < offsetof(typeof(*region), special_mem) +
722 		     sizeof(region->special_mem))
723 		return;
724 
725 	region = (const void *)tlv->data;
726 	addr = le32_to_cpu(region->special_mem.base_addr);
727 	addr += le32_to_cpu(region->special_mem.offset);
728 	addr &= ~FW_ADDR_CACHE_CONTROL;
729 
730 	if (region->type != IWL_FW_INI_REGION_SPECIAL_DEVICE_MEMORY)
731 		return;
732 
733 	switch (region->sub_type) {
734 	case IWL_FW_INI_REGION_DEVICE_MEMORY_SUBTYPE_UMAC_ERROR_TABLE:
735 		drv->trans->dbg.umac_error_event_table = addr;
736 		drv->trans->dbg.error_event_table_tlv_status |=
737 			IWL_ERROR_EVENT_TABLE_UMAC;
738 		break;
739 	case IWL_FW_INI_REGION_DEVICE_MEMORY_SUBTYPE_LMAC_1_ERROR_TABLE:
740 		drv->trans->dbg.lmac_error_event_table[0] = addr;
741 		drv->trans->dbg.error_event_table_tlv_status |=
742 			IWL_ERROR_EVENT_TABLE_LMAC1;
743 		break;
744 	case IWL_FW_INI_REGION_DEVICE_MEMORY_SUBTYPE_LMAC_2_ERROR_TABLE:
745 		drv->trans->dbg.lmac_error_event_table[1] = addr;
746 		drv->trans->dbg.error_event_table_tlv_status |=
747 			IWL_ERROR_EVENT_TABLE_LMAC2;
748 		break;
749 	case IWL_FW_INI_REGION_DEVICE_MEMORY_SUBTYPE_TCM_1_ERROR_TABLE:
750 		drv->trans->dbg.tcm_error_event_table[0] = addr;
751 		drv->trans->dbg.error_event_table_tlv_status |=
752 			IWL_ERROR_EVENT_TABLE_TCM1;
753 		break;
754 	case IWL_FW_INI_REGION_DEVICE_MEMORY_SUBTYPE_TCM_2_ERROR_TABLE:
755 		drv->trans->dbg.tcm_error_event_table[1] = addr;
756 		drv->trans->dbg.error_event_table_tlv_status |=
757 			IWL_ERROR_EVENT_TABLE_TCM2;
758 		break;
759 	case IWL_FW_INI_REGION_DEVICE_MEMORY_SUBTYPE_RCM_1_ERROR_TABLE:
760 		drv->trans->dbg.rcm_error_event_table[0] = addr;
761 		drv->trans->dbg.error_event_table_tlv_status |=
762 			IWL_ERROR_EVENT_TABLE_RCM1;
763 		break;
764 	case IWL_FW_INI_REGION_DEVICE_MEMORY_SUBTYPE_RCM_2_ERROR_TABLE:
765 		drv->trans->dbg.rcm_error_event_table[1] = addr;
766 		drv->trans->dbg.error_event_table_tlv_status |=
767 			IWL_ERROR_EVENT_TABLE_RCM2;
768 		break;
769 	default:
770 		break;
771 	}
772 }
773 
774 static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
775 				const struct firmware *ucode_raw,
776 				struct iwl_firmware_pieces *pieces,
777 				struct iwl_ucode_capabilities *capa,
778 				bool *usniffer_images)
779 {
780 	const struct iwl_tlv_ucode_header *ucode = (const void *)ucode_raw->data;
781 	const struct iwl_ucode_tlv *tlv;
782 	size_t len = ucode_raw->size;
783 	const u8 *data;
784 	u32 tlv_len;
785 	u32 usniffer_img;
786 	enum iwl_ucode_tlv_type tlv_type;
787 	const u8 *tlv_data;
788 	char buildstr[25];
789 	u32 build, paging_mem_size;
790 	int num_of_cpus;
791 	bool usniffer_req = false;
792 
793 	if (len < sizeof(*ucode)) {
794 		IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
795 		return -EINVAL;
796 	}
797 
798 	if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
799 		IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
800 			le32_to_cpu(ucode->magic));
801 		return -EINVAL;
802 	}
803 
804 	drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
805 	memcpy(drv->fw.human_readable, ucode->human_readable,
806 	       sizeof(drv->fw.human_readable));
807 	build = le32_to_cpu(ucode->build);
808 
809 	if (build)
810 		sprintf(buildstr, " build %u", build);
811 	else
812 		buildstr[0] = '\0';
813 
814 	snprintf(drv->fw.fw_version,
815 		 sizeof(drv->fw.fw_version),
816 		 "%u.%u.%u.%u%s %s",
817 		 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
818 		 IWL_UCODE_MINOR(drv->fw.ucode_ver),
819 		 IWL_UCODE_API(drv->fw.ucode_ver),
820 		 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
821 		 buildstr, iwl_reduced_fw_name(drv));
822 
823 	data = ucode->data;
824 
825 	len -= sizeof(*ucode);
826 
827 	while (len >= sizeof(*tlv)) {
828 		len -= sizeof(*tlv);
829 
830 		tlv = (const void *)data;
831 		tlv_len = le32_to_cpu(tlv->length);
832 		tlv_type = le32_to_cpu(tlv->type);
833 		tlv_data = tlv->data;
834 
835 		if (len < tlv_len) {
836 			IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
837 				len, tlv_len);
838 			return -EINVAL;
839 		}
840 		len -= ALIGN(tlv_len, 4);
841 		data += sizeof(*tlv) + ALIGN(tlv_len, 4);
842 
843 		switch (tlv_type) {
844 		case IWL_UCODE_TLV_INST:
845 			set_sec_data(pieces, IWL_UCODE_REGULAR,
846 				     IWL_UCODE_SECTION_INST, tlv_data);
847 			set_sec_size(pieces, IWL_UCODE_REGULAR,
848 				     IWL_UCODE_SECTION_INST, tlv_len);
849 			set_sec_offset(pieces, IWL_UCODE_REGULAR,
850 				       IWL_UCODE_SECTION_INST,
851 				       IWLAGN_RTC_INST_LOWER_BOUND);
852 			break;
853 		case IWL_UCODE_TLV_DATA:
854 			set_sec_data(pieces, IWL_UCODE_REGULAR,
855 				     IWL_UCODE_SECTION_DATA, tlv_data);
856 			set_sec_size(pieces, IWL_UCODE_REGULAR,
857 				     IWL_UCODE_SECTION_DATA, tlv_len);
858 			set_sec_offset(pieces, IWL_UCODE_REGULAR,
859 				       IWL_UCODE_SECTION_DATA,
860 				       IWLAGN_RTC_DATA_LOWER_BOUND);
861 			break;
862 		case IWL_UCODE_TLV_INIT:
863 			set_sec_data(pieces, IWL_UCODE_INIT,
864 				     IWL_UCODE_SECTION_INST, tlv_data);
865 			set_sec_size(pieces, IWL_UCODE_INIT,
866 				     IWL_UCODE_SECTION_INST, tlv_len);
867 			set_sec_offset(pieces, IWL_UCODE_INIT,
868 				       IWL_UCODE_SECTION_INST,
869 				       IWLAGN_RTC_INST_LOWER_BOUND);
870 			break;
871 		case IWL_UCODE_TLV_INIT_DATA:
872 			set_sec_data(pieces, IWL_UCODE_INIT,
873 				     IWL_UCODE_SECTION_DATA, tlv_data);
874 			set_sec_size(pieces, IWL_UCODE_INIT,
875 				     IWL_UCODE_SECTION_DATA, tlv_len);
876 			set_sec_offset(pieces, IWL_UCODE_INIT,
877 				       IWL_UCODE_SECTION_DATA,
878 				       IWLAGN_RTC_DATA_LOWER_BOUND);
879 			break;
880 		case IWL_UCODE_TLV_BOOT:
881 			IWL_ERR(drv, "Found unexpected BOOT ucode\n");
882 			break;
883 		case IWL_UCODE_TLV_PROBE_MAX_LEN:
884 			if (tlv_len != sizeof(u32))
885 				goto invalid_tlv_len;
886 			capa->max_probe_length =
887 					le32_to_cpup((const __le32 *)tlv_data);
888 			break;
889 		case IWL_UCODE_TLV_PAN:
890 			if (tlv_len)
891 				goto invalid_tlv_len;
892 			capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
893 			break;
894 		case IWL_UCODE_TLV_FLAGS:
895 			/* must be at least one u32 */
896 			if (tlv_len < sizeof(u32))
897 				goto invalid_tlv_len;
898 			/* and a proper number of u32s */
899 			if (tlv_len % sizeof(u32))
900 				goto invalid_tlv_len;
901 			/*
902 			 * This driver only reads the first u32 as
903 			 * right now no more features are defined,
904 			 * if that changes then either the driver
905 			 * will not work with the new firmware, or
906 			 * it'll not take advantage of new features.
907 			 */
908 			capa->flags = le32_to_cpup((const __le32 *)tlv_data);
909 			break;
910 		case IWL_UCODE_TLV_API_CHANGES_SET:
911 			if (tlv_len != sizeof(struct iwl_ucode_api))
912 				goto invalid_tlv_len;
913 			iwl_set_ucode_api_flags(drv, tlv_data, capa);
914 			break;
915 		case IWL_UCODE_TLV_ENABLED_CAPABILITIES:
916 			if (tlv_len != sizeof(struct iwl_ucode_capa))
917 				goto invalid_tlv_len;
918 			iwl_set_ucode_capabilities(drv, tlv_data, capa);
919 			break;
920 		case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
921 			if (tlv_len != sizeof(u32))
922 				goto invalid_tlv_len;
923 			pieces->init_evtlog_ptr =
924 					le32_to_cpup((const __le32 *)tlv_data);
925 			break;
926 		case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
927 			if (tlv_len != sizeof(u32))
928 				goto invalid_tlv_len;
929 			pieces->init_evtlog_size =
930 					le32_to_cpup((const __le32 *)tlv_data);
931 			break;
932 		case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
933 			if (tlv_len != sizeof(u32))
934 				goto invalid_tlv_len;
935 			pieces->init_errlog_ptr =
936 					le32_to_cpup((const __le32 *)tlv_data);
937 			break;
938 		case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
939 			if (tlv_len != sizeof(u32))
940 				goto invalid_tlv_len;
941 			pieces->inst_evtlog_ptr =
942 					le32_to_cpup((const __le32 *)tlv_data);
943 			break;
944 		case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
945 			if (tlv_len != sizeof(u32))
946 				goto invalid_tlv_len;
947 			pieces->inst_evtlog_size =
948 					le32_to_cpup((const __le32 *)tlv_data);
949 			break;
950 		case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
951 			if (tlv_len != sizeof(u32))
952 				goto invalid_tlv_len;
953 			pieces->inst_errlog_ptr =
954 					le32_to_cpup((const __le32 *)tlv_data);
955 			break;
956 		case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
957 			if (tlv_len)
958 				goto invalid_tlv_len;
959 			drv->fw.enhance_sensitivity_table = true;
960 			break;
961 		case IWL_UCODE_TLV_WOWLAN_INST:
962 			set_sec_data(pieces, IWL_UCODE_WOWLAN,
963 				     IWL_UCODE_SECTION_INST, tlv_data);
964 			set_sec_size(pieces, IWL_UCODE_WOWLAN,
965 				     IWL_UCODE_SECTION_INST, tlv_len);
966 			set_sec_offset(pieces, IWL_UCODE_WOWLAN,
967 				       IWL_UCODE_SECTION_INST,
968 				       IWLAGN_RTC_INST_LOWER_BOUND);
969 			break;
970 		case IWL_UCODE_TLV_WOWLAN_DATA:
971 			set_sec_data(pieces, IWL_UCODE_WOWLAN,
972 				     IWL_UCODE_SECTION_DATA, tlv_data);
973 			set_sec_size(pieces, IWL_UCODE_WOWLAN,
974 				     IWL_UCODE_SECTION_DATA, tlv_len);
975 			set_sec_offset(pieces, IWL_UCODE_WOWLAN,
976 				       IWL_UCODE_SECTION_DATA,
977 				       IWLAGN_RTC_DATA_LOWER_BOUND);
978 			break;
979 		case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
980 			if (tlv_len != sizeof(u32))
981 				goto invalid_tlv_len;
982 			capa->standard_phy_calibration_size =
983 					le32_to_cpup((const __le32 *)tlv_data);
984 			break;
985 		case IWL_UCODE_TLV_SEC_RT:
986 			iwl_store_ucode_sec(&pieces->img[IWL_UCODE_REGULAR],
987 					    tlv_data, tlv_len);
988 			drv->fw.type = IWL_FW_MVM;
989 			break;
990 		case IWL_UCODE_TLV_SEC_INIT:
991 			iwl_store_ucode_sec(&pieces->img[IWL_UCODE_INIT],
992 					    tlv_data, tlv_len);
993 			drv->fw.type = IWL_FW_MVM;
994 			break;
995 		case IWL_UCODE_TLV_SEC_WOWLAN:
996 			iwl_store_ucode_sec(&pieces->img[IWL_UCODE_WOWLAN],
997 					    tlv_data, tlv_len);
998 			drv->fw.type = IWL_FW_MVM;
999 			break;
1000 		case IWL_UCODE_TLV_DEF_CALIB:
1001 			if (tlv_len != sizeof(struct iwl_tlv_calib_data))
1002 				goto invalid_tlv_len;
1003 			if (iwl_set_default_calib(drv, tlv_data))
1004 				goto tlv_error;
1005 			break;
1006 		case IWL_UCODE_TLV_PHY_SKU:
1007 			if (tlv_len != sizeof(u32))
1008 				goto invalid_tlv_len;
1009 			drv->fw.phy_config = le32_to_cpup((const __le32 *)tlv_data);
1010 			drv->fw.valid_tx_ant = (drv->fw.phy_config &
1011 						FW_PHY_CFG_TX_CHAIN) >>
1012 						FW_PHY_CFG_TX_CHAIN_POS;
1013 			drv->fw.valid_rx_ant = (drv->fw.phy_config &
1014 						FW_PHY_CFG_RX_CHAIN) >>
1015 						FW_PHY_CFG_RX_CHAIN_POS;
1016 			break;
1017 		case IWL_UCODE_TLV_SECURE_SEC_RT:
1018 			iwl_store_ucode_sec(&pieces->img[IWL_UCODE_REGULAR],
1019 					    tlv_data, tlv_len);
1020 			drv->fw.type = IWL_FW_MVM;
1021 			break;
1022 		case IWL_UCODE_TLV_SECURE_SEC_INIT:
1023 			iwl_store_ucode_sec(&pieces->img[IWL_UCODE_INIT],
1024 					    tlv_data, tlv_len);
1025 			drv->fw.type = IWL_FW_MVM;
1026 			break;
1027 		case IWL_UCODE_TLV_SECURE_SEC_WOWLAN:
1028 			iwl_store_ucode_sec(&pieces->img[IWL_UCODE_WOWLAN],
1029 					    tlv_data, tlv_len);
1030 			drv->fw.type = IWL_FW_MVM;
1031 			break;
1032 		case IWL_UCODE_TLV_NUM_OF_CPU:
1033 			if (tlv_len != sizeof(u32))
1034 				goto invalid_tlv_len;
1035 			num_of_cpus =
1036 				le32_to_cpup((const __le32 *)tlv_data);
1037 
1038 			if (num_of_cpus == 2) {
1039 				drv->fw.img[IWL_UCODE_REGULAR].is_dual_cpus =
1040 					true;
1041 				drv->fw.img[IWL_UCODE_INIT].is_dual_cpus =
1042 					true;
1043 				drv->fw.img[IWL_UCODE_WOWLAN].is_dual_cpus =
1044 					true;
1045 			} else if ((num_of_cpus > 2) || (num_of_cpus < 1)) {
1046 				IWL_ERR(drv, "Driver support up to 2 CPUs\n");
1047 				return -EINVAL;
1048 			}
1049 			break;
1050 		case IWL_UCODE_TLV_N_SCAN_CHANNELS:
1051 			if (tlv_len != sizeof(u32))
1052 				goto invalid_tlv_len;
1053 			capa->n_scan_channels =
1054 				le32_to_cpup((const __le32 *)tlv_data);
1055 			break;
1056 		case IWL_UCODE_TLV_FW_VERSION: {
1057 			const __le32 *ptr = (const void *)tlv_data;
1058 			u32 minor;
1059 			u8 local_comp;
1060 
1061 			if (tlv_len != sizeof(u32) * 3)
1062 				goto invalid_tlv_len;
1063 
1064 			pieces->major = le32_to_cpup(ptr++);
1065 			minor = le32_to_cpup(ptr++);
1066 			local_comp = le32_to_cpup(ptr);
1067 
1068 			snprintf(drv->fw.fw_version,
1069 				 sizeof(drv->fw.fw_version),
1070 				 "%u.%08x.%u %s", pieces->major, minor,
1071 				 local_comp, iwl_reduced_fw_name(drv));
1072 			break;
1073 			}
1074 		case IWL_UCODE_TLV_FW_DBG_DEST: {
1075 			const struct iwl_fw_dbg_dest_tlv *dest = NULL;
1076 			const struct iwl_fw_dbg_dest_tlv_v1 *dest_v1 = NULL;
1077 			u8 mon_mode;
1078 
1079 			pieces->dbg_dest_ver = (const u8 *)tlv_data;
1080 			if (*pieces->dbg_dest_ver == 1) {
1081 				dest = (const void *)tlv_data;
1082 			} else if (*pieces->dbg_dest_ver == 0) {
1083 				dest_v1 = (const void *)tlv_data;
1084 			} else {
1085 				IWL_ERR(drv,
1086 					"The version is %d, and it is invalid\n",
1087 					*pieces->dbg_dest_ver);
1088 				break;
1089 			}
1090 
1091 			if (pieces->dbg_dest_tlv_init) {
1092 				IWL_ERR(drv,
1093 					"dbg destination ignored, already exists\n");
1094 				break;
1095 			}
1096 
1097 			pieces->dbg_dest_tlv_init = true;
1098 
1099 			if (dest_v1) {
1100 				pieces->dbg_dest_tlv_v1 = dest_v1;
1101 				mon_mode = dest_v1->monitor_mode;
1102 			} else {
1103 				pieces->dbg_dest_tlv = dest;
1104 				mon_mode = dest->monitor_mode;
1105 			}
1106 
1107 			IWL_INFO(drv, "Found debug destination: %s\n",
1108 				 get_fw_dbg_mode_string(mon_mode));
1109 
1110 			drv->fw.dbg.n_dest_reg = (dest_v1) ?
1111 				tlv_len -
1112 				offsetof(struct iwl_fw_dbg_dest_tlv_v1,
1113 					 reg_ops) :
1114 				tlv_len -
1115 				offsetof(struct iwl_fw_dbg_dest_tlv,
1116 					 reg_ops);
1117 
1118 			drv->fw.dbg.n_dest_reg /=
1119 				sizeof(drv->fw.dbg.dest_tlv->reg_ops[0]);
1120 
1121 			break;
1122 			}
1123 		case IWL_UCODE_TLV_FW_DBG_CONF: {
1124 			const struct iwl_fw_dbg_conf_tlv *conf =
1125 				(const void *)tlv_data;
1126 
1127 			if (!pieces->dbg_dest_tlv_init) {
1128 				IWL_ERR(drv,
1129 					"Ignore dbg config %d - no destination configured\n",
1130 					conf->id);
1131 				break;
1132 			}
1133 
1134 			if (conf->id >= ARRAY_SIZE(drv->fw.dbg.conf_tlv)) {
1135 				IWL_ERR(drv,
1136 					"Skip unknown configuration: %d\n",
1137 					conf->id);
1138 				break;
1139 			}
1140 
1141 			if (pieces->dbg_conf_tlv[conf->id]) {
1142 				IWL_ERR(drv,
1143 					"Ignore duplicate dbg config %d\n",
1144 					conf->id);
1145 				break;
1146 			}
1147 
1148 			if (conf->usniffer)
1149 				usniffer_req = true;
1150 
1151 			IWL_INFO(drv, "Found debug configuration: %d\n",
1152 				 conf->id);
1153 
1154 			pieces->dbg_conf_tlv[conf->id] = conf;
1155 			pieces->dbg_conf_tlv_len[conf->id] = tlv_len;
1156 			break;
1157 			}
1158 		case IWL_UCODE_TLV_FW_DBG_TRIGGER: {
1159 			const struct iwl_fw_dbg_trigger_tlv *trigger =
1160 				(const void *)tlv_data;
1161 			u32 trigger_id = le32_to_cpu(trigger->id);
1162 
1163 			if (trigger_id >= ARRAY_SIZE(drv->fw.dbg.trigger_tlv)) {
1164 				IWL_ERR(drv,
1165 					"Skip unknown trigger: %u\n",
1166 					trigger->id);
1167 				break;
1168 			}
1169 
1170 			if (pieces->dbg_trigger_tlv[trigger_id]) {
1171 				IWL_ERR(drv,
1172 					"Ignore duplicate dbg trigger %u\n",
1173 					trigger->id);
1174 				break;
1175 			}
1176 
1177 			IWL_INFO(drv, "Found debug trigger: %u\n", trigger->id);
1178 
1179 			pieces->dbg_trigger_tlv[trigger_id] = trigger;
1180 			pieces->dbg_trigger_tlv_len[trigger_id] = tlv_len;
1181 			break;
1182 			}
1183 		case IWL_UCODE_TLV_FW_DBG_DUMP_LST: {
1184 			if (tlv_len != sizeof(u32)) {
1185 				IWL_ERR(drv,
1186 					"dbg lst mask size incorrect, skip\n");
1187 				break;
1188 			}
1189 
1190 			drv->fw.dbg.dump_mask =
1191 				le32_to_cpup((const __le32 *)tlv_data);
1192 			break;
1193 			}
1194 		case IWL_UCODE_TLV_SEC_RT_USNIFFER:
1195 			*usniffer_images = true;
1196 			iwl_store_ucode_sec(&pieces->img[IWL_UCODE_REGULAR_USNIFFER],
1197 					    tlv_data, tlv_len);
1198 			break;
1199 		case IWL_UCODE_TLV_PAGING:
1200 			if (tlv_len != sizeof(u32))
1201 				goto invalid_tlv_len;
1202 			paging_mem_size = le32_to_cpup((const __le32 *)tlv_data);
1203 
1204 			IWL_DEBUG_FW(drv,
1205 				     "Paging: paging enabled (size = %u bytes)\n",
1206 				     paging_mem_size);
1207 
1208 			if (paging_mem_size > MAX_PAGING_IMAGE_SIZE) {
1209 				IWL_ERR(drv,
1210 					"Paging: driver supports up to %lu bytes for paging image\n",
1211 					MAX_PAGING_IMAGE_SIZE);
1212 				return -EINVAL;
1213 			}
1214 
1215 			if (paging_mem_size & (FW_PAGING_SIZE - 1)) {
1216 				IWL_ERR(drv,
1217 					"Paging: image isn't multiple %lu\n",
1218 					FW_PAGING_SIZE);
1219 				return -EINVAL;
1220 			}
1221 
1222 			drv->fw.img[IWL_UCODE_REGULAR].paging_mem_size =
1223 				paging_mem_size;
1224 			usniffer_img = IWL_UCODE_REGULAR_USNIFFER;
1225 			drv->fw.img[usniffer_img].paging_mem_size =
1226 				paging_mem_size;
1227 			break;
1228 		case IWL_UCODE_TLV_FW_GSCAN_CAPA:
1229 			/* ignored */
1230 			break;
1231 		case IWL_UCODE_TLV_FW_MEM_SEG: {
1232 			const struct iwl_fw_dbg_mem_seg_tlv *dbg_mem =
1233 				(const void *)tlv_data;
1234 			size_t size;
1235 			struct iwl_fw_dbg_mem_seg_tlv *n;
1236 
1237 			if (tlv_len != (sizeof(*dbg_mem)))
1238 				goto invalid_tlv_len;
1239 
1240 			IWL_DEBUG_INFO(drv, "Found debug memory segment: %u\n",
1241 				       dbg_mem->data_type);
1242 
1243 			size = sizeof(*pieces->dbg_mem_tlv) *
1244 			       (pieces->n_mem_tlv + 1);
1245 			n = krealloc(pieces->dbg_mem_tlv, size, GFP_KERNEL);
1246 			if (!n)
1247 				return -ENOMEM;
1248 			pieces->dbg_mem_tlv = n;
1249 			pieces->dbg_mem_tlv[pieces->n_mem_tlv] = *dbg_mem;
1250 			pieces->n_mem_tlv++;
1251 			break;
1252 			}
1253 		case IWL_UCODE_TLV_IML: {
1254 			drv->fw.iml_len = tlv_len;
1255 			drv->fw.iml = kmemdup(tlv_data, tlv_len, GFP_KERNEL);
1256 			if (!drv->fw.iml)
1257 				return -ENOMEM;
1258 			break;
1259 			}
1260 		case IWL_UCODE_TLV_FW_RECOVERY_INFO: {
1261 			const struct {
1262 				__le32 buf_addr;
1263 				__le32 buf_size;
1264 			} *recov_info = (const void *)tlv_data;
1265 
1266 			if (tlv_len != sizeof(*recov_info))
1267 				goto invalid_tlv_len;
1268 			capa->error_log_addr =
1269 				le32_to_cpu(recov_info->buf_addr);
1270 			capa->error_log_size =
1271 				le32_to_cpu(recov_info->buf_size);
1272 			}
1273 			break;
1274 		case IWL_UCODE_TLV_FW_FSEQ_VERSION: {
1275 			const struct {
1276 				u8 version[32];
1277 				u8 sha1[20];
1278 			} *fseq_ver = (const void *)tlv_data;
1279 
1280 			if (tlv_len != sizeof(*fseq_ver))
1281 				goto invalid_tlv_len;
1282 			IWL_DEBUG_INFO(drv, "TLV_FW_FSEQ_VERSION: %.32s\n",
1283 				       fseq_ver->version);
1284 			}
1285 			break;
1286 		case IWL_UCODE_TLV_FW_NUM_STATIONS:
1287 			if (tlv_len != sizeof(u32))
1288 				goto invalid_tlv_len;
1289 			if (le32_to_cpup((const __le32 *)tlv_data) >
1290 			    IWL_STATION_COUNT_MAX) {
1291 				IWL_ERR(drv,
1292 					"%d is an invalid number of station\n",
1293 					le32_to_cpup((const __le32 *)tlv_data));
1294 				goto tlv_error;
1295 			}
1296 			capa->num_stations =
1297 				le32_to_cpup((const __le32 *)tlv_data);
1298 			break;
1299 		case IWL_UCODE_TLV_FW_NUM_LINKS:
1300 			if (tlv_len != sizeof(u32))
1301 				goto invalid_tlv_len;
1302 			if (le32_to_cpup((const __le32 *)tlv_data) >
1303 			    IWL_FW_MAX_LINK_ID + 1) {
1304 				IWL_ERR(drv,
1305 					"%d is an invalid number of links\n",
1306 					le32_to_cpup((const __le32 *)tlv_data));
1307 				goto tlv_error;
1308 			}
1309 			capa->num_links =
1310 				le32_to_cpup((const __le32 *)tlv_data);
1311 			break;
1312 		case IWL_UCODE_TLV_FW_NUM_BEACONS:
1313 			if (tlv_len != sizeof(u32))
1314 				goto invalid_tlv_len;
1315 			capa->num_beacons =
1316 				le32_to_cpup((const __le32 *)tlv_data);
1317 			break;
1318 		case IWL_UCODE_TLV_UMAC_DEBUG_ADDRS: {
1319 			const struct iwl_umac_debug_addrs *dbg_ptrs =
1320 				(const void *)tlv_data;
1321 
1322 			if (tlv_len != sizeof(*dbg_ptrs))
1323 				goto invalid_tlv_len;
1324 			if (drv->trans->mac_cfg->device_family <
1325 			    IWL_DEVICE_FAMILY_22000)
1326 				break;
1327 			drv->trans->dbg.umac_error_event_table =
1328 				le32_to_cpu(dbg_ptrs->error_info_addr) &
1329 				~FW_ADDR_CACHE_CONTROL;
1330 			drv->trans->dbg.error_event_table_tlv_status |=
1331 				IWL_ERROR_EVENT_TABLE_UMAC;
1332 			break;
1333 			}
1334 		case IWL_UCODE_TLV_LMAC_DEBUG_ADDRS: {
1335 			const struct iwl_lmac_debug_addrs *dbg_ptrs =
1336 				(const void *)tlv_data;
1337 
1338 			if (tlv_len != sizeof(*dbg_ptrs))
1339 				goto invalid_tlv_len;
1340 			if (drv->trans->mac_cfg->device_family <
1341 			    IWL_DEVICE_FAMILY_22000)
1342 				break;
1343 			drv->trans->dbg.lmac_error_event_table[0] =
1344 				le32_to_cpu(dbg_ptrs->error_event_table_ptr) &
1345 				~FW_ADDR_CACHE_CONTROL;
1346 			drv->trans->dbg.error_event_table_tlv_status |=
1347 				IWL_ERROR_EVENT_TABLE_LMAC1;
1348 			break;
1349 			}
1350 		case IWL_UCODE_TLV_TYPE_REGIONS:
1351 			iwl_parse_dbg_tlv_assert_tables(drv, tlv);
1352 			fallthrough;
1353 		case IWL_UCODE_TLV_TYPE_DEBUG_INFO:
1354 		case IWL_UCODE_TLV_TYPE_BUFFER_ALLOCATION:
1355 		case IWL_UCODE_TLV_TYPE_HCMD:
1356 		case IWL_UCODE_TLV_TYPE_TRIGGERS:
1357 		case IWL_UCODE_TLV_TYPE_CONF_SET:
1358 			if (iwlwifi_mod_params.enable_ini)
1359 				iwl_dbg_tlv_alloc(drv->trans, tlv, false);
1360 			break;
1361 		case IWL_UCODE_TLV_CMD_VERSIONS:
1362 			if (tlv_len % sizeof(struct iwl_fw_cmd_version)) {
1363 				IWL_ERR(drv,
1364 					"Invalid length for command versions: %u\n",
1365 					tlv_len);
1366 				tlv_len /= sizeof(struct iwl_fw_cmd_version);
1367 				tlv_len *= sizeof(struct iwl_fw_cmd_version);
1368 			}
1369 			if (WARN_ON(capa->cmd_versions))
1370 				return -EINVAL;
1371 			capa->cmd_versions = kmemdup(tlv_data, tlv_len,
1372 						     GFP_KERNEL);
1373 			if (!capa->cmd_versions)
1374 				return -ENOMEM;
1375 			capa->n_cmd_versions =
1376 				tlv_len / sizeof(struct iwl_fw_cmd_version);
1377 			break;
1378 		case IWL_UCODE_TLV_PHY_INTEGRATION_VERSION:
1379 			if (drv->fw.phy_integration_ver) {
1380 				IWL_ERR(drv,
1381 					"phy integration str ignored, already exists\n");
1382 				break;
1383 			}
1384 
1385 			drv->fw.phy_integration_ver =
1386 				kmemdup(tlv_data, tlv_len, GFP_KERNEL);
1387 			if (!drv->fw.phy_integration_ver)
1388 				return -ENOMEM;
1389 			drv->fw.phy_integration_ver_len = tlv_len;
1390 			break;
1391 		case IWL_UCODE_TLV_SEC_TABLE_ADDR:
1392 		case IWL_UCODE_TLV_D3_KEK_KCK_ADDR:
1393 			iwl_drv_set_dump_exclude(drv, tlv_type,
1394 						 tlv_data, tlv_len);
1395 			break;
1396 		case IWL_UCODE_TLV_CURRENT_PC:
1397 			if (tlv_len < sizeof(struct iwl_pc_data))
1398 				goto invalid_tlv_len;
1399 			drv->trans->dbg.pc_data =
1400 				kmemdup(tlv_data, tlv_len, GFP_KERNEL);
1401 			if (!drv->trans->dbg.pc_data)
1402 				return -ENOMEM;
1403 			drv->trans->dbg.num_pc =
1404 				tlv_len / sizeof(struct iwl_pc_data);
1405 			break;
1406 		case IWL_UCODE_TLV_PNVM_DATA:
1407 			if (drv->fw.pnvm_data)
1408 				break;
1409 			drv->fw.pnvm_data =
1410 				kvmemdup(tlv_data, tlv_len, GFP_KERNEL);
1411 			if (!drv->fw.pnvm_data)
1412 				return -ENOMEM;
1413 			drv->fw.pnvm_size = tlv_len;
1414 			break;
1415 		default:
1416 			IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
1417 			break;
1418 		}
1419 	}
1420 
1421 	if (!fw_has_capa(capa, IWL_UCODE_TLV_CAPA_USNIFFER_UNIFIED) &&
1422 	    usniffer_req && !*usniffer_images) {
1423 		IWL_ERR(drv,
1424 			"user selected to work with usniffer but usniffer image isn't available in ucode package\n");
1425 		return -EINVAL;
1426 	}
1427 
1428 	if (len) {
1429 		IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
1430 		iwl_print_hex_dump(drv, IWL_DL_FW, data, len);
1431 		return -EINVAL;
1432 	}
1433 
1434 	return 0;
1435 
1436  invalid_tlv_len:
1437 	IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
1438  tlv_error:
1439 	iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
1440 
1441 	return -EINVAL;
1442 }
1443 
1444 static int iwl_alloc_ucode_mem(struct fw_img *out, struct fw_img_parsing *img)
1445 {
1446 	struct fw_desc *sec;
1447 
1448 	sec = kcalloc(img->sec_counter, sizeof(*sec), GFP_KERNEL);
1449 	if (!sec)
1450 		return -ENOMEM;
1451 
1452 	out->sec = sec;
1453 	out->num_sec = img->sec_counter;
1454 
1455 	for (int i = 0; i < out->num_sec; i++)
1456 		if (iwl_alloc_fw_desc(&sec[i], &img->sec[i]))
1457 			return -ENOMEM;
1458 
1459 	return 0;
1460 }
1461 
1462 static int iwl_alloc_ucode(struct iwl_drv *drv,
1463 			   struct iwl_firmware_pieces *pieces,
1464 			   enum iwl_ucode_type type)
1465 {
1466 	return iwl_alloc_ucode_mem(&drv->fw.img[type], &pieces->img[type]);
1467 }
1468 
1469 static int validate_sec_sizes(struct iwl_drv *drv,
1470 			      struct iwl_firmware_pieces *pieces,
1471 			      const struct iwl_rf_cfg *cfg)
1472 {
1473 	IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %zd\n",
1474 		get_sec_size(pieces, IWL_UCODE_REGULAR,
1475 			     IWL_UCODE_SECTION_INST));
1476 	IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %zd\n",
1477 		get_sec_size(pieces, IWL_UCODE_REGULAR,
1478 			     IWL_UCODE_SECTION_DATA));
1479 	IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %zd\n",
1480 		get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
1481 	IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %zd\n",
1482 		get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));
1483 
1484 	/* Verify that uCode images will fit in card's SRAM. */
1485 	if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
1486 	    cfg->max_inst_size) {
1487 		IWL_ERR(drv, "uCode instr len %zd too large to fit in\n",
1488 			get_sec_size(pieces, IWL_UCODE_REGULAR,
1489 				     IWL_UCODE_SECTION_INST));
1490 		return -1;
1491 	}
1492 
1493 	if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
1494 	    cfg->max_data_size) {
1495 		IWL_ERR(drv, "uCode data len %zd too large to fit in\n",
1496 			get_sec_size(pieces, IWL_UCODE_REGULAR,
1497 				     IWL_UCODE_SECTION_DATA));
1498 		return -1;
1499 	}
1500 
1501 	if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
1502 	     cfg->max_inst_size) {
1503 		IWL_ERR(drv, "uCode init instr len %zd too large to fit in\n",
1504 			get_sec_size(pieces, IWL_UCODE_INIT,
1505 				     IWL_UCODE_SECTION_INST));
1506 		return -1;
1507 	}
1508 
1509 	if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
1510 	    cfg->max_data_size) {
1511 		IWL_ERR(drv, "uCode init data len %zd too large to fit in\n",
1512 			get_sec_size(pieces, IWL_UCODE_REGULAR,
1513 				     IWL_UCODE_SECTION_DATA));
1514 		return -1;
1515 	}
1516 	return 0;
1517 }
1518 
1519 static struct iwl_op_mode *
1520 _iwl_op_mode_start(struct iwl_drv *drv, struct iwlwifi_opmode_table *op)
1521 {
1522 	const struct iwl_op_mode_ops *ops = op->ops;
1523 	struct dentry *dbgfs_dir = NULL;
1524 	struct iwl_op_mode *op_mode = NULL;
1525 	int retry, max_retry = !!iwlwifi_mod_params.fw_restart * IWL_MAX_INIT_RETRY;
1526 
1527 	/* also protects start/stop from racing against each other */
1528 	lockdep_assert_held(&iwlwifi_opmode_table_mtx);
1529 
1530 	for (retry = 0; retry <= max_retry; retry++) {
1531 
1532 #ifdef CONFIG_IWLWIFI_DEBUGFS
1533 		drv->dbgfs_op_mode = debugfs_create_dir(op->name,
1534 							drv->dbgfs_drv);
1535 		dbgfs_dir = drv->dbgfs_op_mode;
1536 #endif
1537 
1538 		op_mode = ops->start(drv->trans, drv->trans->cfg,
1539 				     &drv->fw, dbgfs_dir);
1540 
1541 		if (!IS_ERR(op_mode))
1542 			return op_mode;
1543 
1544 		if (test_bit(STATUS_TRANS_DEAD, &drv->trans->status))
1545 			break;
1546 
1547 #ifdef CONFIG_IWLWIFI_DEBUGFS
1548 		debugfs_remove_recursive(drv->dbgfs_op_mode);
1549 		drv->dbgfs_op_mode = NULL;
1550 #endif
1551 
1552 		if (PTR_ERR(op_mode) != -ETIMEDOUT)
1553 			break;
1554 
1555 		IWL_ERR(drv, "retry init count %d\n", retry);
1556 	}
1557 
1558 	return NULL;
1559 }
1560 
1561 static void _iwl_op_mode_stop(struct iwl_drv *drv)
1562 {
1563 	/* also protects start/stop from racing against each other */
1564 	lockdep_assert_held(&iwlwifi_opmode_table_mtx);
1565 
1566 	/* op_mode can be NULL if its start failed */
1567 	if (drv->op_mode) {
1568 		iwl_op_mode_stop(drv->op_mode);
1569 		drv->op_mode = NULL;
1570 
1571 #ifdef CONFIG_IWLWIFI_DEBUGFS
1572 		debugfs_remove_recursive(drv->dbgfs_op_mode);
1573 		drv->dbgfs_op_mode = NULL;
1574 #endif
1575 	}
1576 }
1577 
1578 #define IWL_MLD_SUPPORTED_FW_VERSION 97
1579 
1580 /*
1581  * iwl_req_fw_callback - callback when firmware was loaded
1582  *
1583  * If loaded successfully, copies the firmware into buffers
1584  * for the card to fetch (via DMA).
1585  */
1586 static void iwl_req_fw_callback(const struct firmware *ucode_raw, void *context)
1587 {
1588 	struct iwl_drv *drv = context;
1589 	struct iwl_fw *fw = &drv->fw;
1590 	const struct iwl_ucode_header *ucode;
1591 	struct iwlwifi_opmode_table *op;
1592 	int err;
1593 	struct iwl_firmware_pieces *pieces;
1594 	unsigned int api_min, api_max;
1595 	size_t trigger_tlv_sz[FW_DBG_TRIGGER_MAX];
1596 	u32 api_ver;
1597 	int i;
1598 	bool usniffer_images = false;
1599 	bool failure = true;
1600 
1601 	iwl_get_ucode_api_versions(drv->trans, &api_min, &api_max);
1602 
1603 	fw->ucode_capa.max_probe_length = IWL_DEFAULT_MAX_PROBE_LENGTH;
1604 	fw->ucode_capa.standard_phy_calibration_size =
1605 			IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1606 	fw->ucode_capa.n_scan_channels = IWL_DEFAULT_SCAN_CHANNELS;
1607 	fw->ucode_capa.num_stations = IWL_STATION_COUNT_MAX;
1608 	fw->ucode_capa.num_beacons = 1;
1609 	/* dump all fw memory areas by default */
1610 	fw->dbg.dump_mask = 0xffffffff;
1611 
1612 	pieces = kzalloc(sizeof(*pieces), GFP_KERNEL);
1613 	if (!pieces)
1614 		goto out_free_fw;
1615 
1616 	if (!ucode_raw)
1617 		goto try_again;
1618 
1619 	IWL_DEBUG_FW_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
1620 			  drv->firmware_name, ucode_raw->size);
1621 
1622 	/* Make sure that we got at least the API version number */
1623 	if (ucode_raw->size < 4) {
1624 		IWL_ERR(drv, "File size way too small!\n");
1625 		goto try_again;
1626 	}
1627 
1628 	/* Data from ucode file:  header followed by uCode images */
1629 	ucode = (const struct iwl_ucode_header *)ucode_raw->data;
1630 
1631 	if (ucode->ver)
1632 		err = iwl_parse_v1_v2_firmware(drv, ucode_raw, pieces);
1633 	else
1634 		err = iwl_parse_tlv_firmware(drv, ucode_raw, pieces,
1635 					     &fw->ucode_capa, &usniffer_images);
1636 
1637 	if (err)
1638 		goto try_again;
1639 
1640 	if (fw_has_api(&drv->fw.ucode_capa, IWL_UCODE_TLV_API_NEW_VERSION))
1641 		api_ver = drv->fw.ucode_ver;
1642 	else
1643 		api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
1644 
1645 	/*
1646 	 * api_ver should match the api version forming part of the
1647 	 * firmware filename ... but we don't check for that and only rely
1648 	 * on the API version read from firmware header from here on forward
1649 	 */
1650 	if (api_ver < api_min || api_ver > api_max) {
1651 		IWL_ERR(drv,
1652 			"Driver unable to support your firmware API. "
1653 			"Driver supports v%u, firmware is v%u.\n",
1654 			api_max, api_ver);
1655 		goto try_again;
1656 	}
1657 
1658 	/*
1659 	 * In mvm uCode there is no difference between data and instructions
1660 	 * sections.
1661 	 */
1662 	if (fw->type == IWL_FW_DVM && validate_sec_sizes(drv, pieces,
1663 							 drv->trans->cfg))
1664 		goto try_again;
1665 
1666 	/* Allocate ucode buffers for card's bus-master loading ... */
1667 
1668 	/* Runtime instructions and 2 copies of data:
1669 	 * 1) unmodified from disk
1670 	 * 2) backup cache for save/restore during power-downs
1671 	 */
1672 	for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
1673 		if (iwl_alloc_ucode(drv, pieces, i))
1674 			goto out_free_fw;
1675 
1676 	if (pieces->dbg_dest_tlv_init) {
1677 		size_t dbg_dest_size = sizeof(*drv->fw.dbg.dest_tlv) +
1678 			sizeof(drv->fw.dbg.dest_tlv->reg_ops[0]) *
1679 			drv->fw.dbg.n_dest_reg;
1680 
1681 		drv->fw.dbg.dest_tlv = kmalloc(dbg_dest_size, GFP_KERNEL);
1682 
1683 		if (!drv->fw.dbg.dest_tlv)
1684 			goto out_free_fw;
1685 
1686 		if (*pieces->dbg_dest_ver == 0) {
1687 			memcpy(drv->fw.dbg.dest_tlv, pieces->dbg_dest_tlv_v1,
1688 			       dbg_dest_size);
1689 		} else {
1690 			struct iwl_fw_dbg_dest_tlv_v1 *dest_tlv =
1691 				drv->fw.dbg.dest_tlv;
1692 
1693 			dest_tlv->version = pieces->dbg_dest_tlv->version;
1694 			dest_tlv->monitor_mode =
1695 				pieces->dbg_dest_tlv->monitor_mode;
1696 			dest_tlv->size_power =
1697 				pieces->dbg_dest_tlv->size_power;
1698 			dest_tlv->wrap_count =
1699 				pieces->dbg_dest_tlv->wrap_count;
1700 			dest_tlv->write_ptr_reg =
1701 				pieces->dbg_dest_tlv->write_ptr_reg;
1702 			dest_tlv->base_shift =
1703 				pieces->dbg_dest_tlv->base_shift;
1704 			memcpy(dest_tlv->reg_ops,
1705 			       pieces->dbg_dest_tlv->reg_ops,
1706 			       sizeof(drv->fw.dbg.dest_tlv->reg_ops[0]) *
1707 			       drv->fw.dbg.n_dest_reg);
1708 
1709 			/* In version 1 of the destination tlv, which is
1710 			 * relevant for internal buffer exclusively,
1711 			 * the base address is part of given with the length
1712 			 * of the buffer, and the size shift is give instead of
1713 			 * end shift. We now store these values in base_reg,
1714 			 * and end shift, and when dumping the data we'll
1715 			 * manipulate it for extracting both the length and
1716 			 * base address */
1717 			dest_tlv->base_reg = pieces->dbg_dest_tlv->cfg_reg;
1718 			dest_tlv->end_shift =
1719 				pieces->dbg_dest_tlv->size_shift;
1720 		}
1721 	}
1722 
1723 	for (i = 0; i < ARRAY_SIZE(drv->fw.dbg.conf_tlv); i++) {
1724 		if (pieces->dbg_conf_tlv[i]) {
1725 			drv->fw.dbg.conf_tlv[i] =
1726 				kmemdup(pieces->dbg_conf_tlv[i],
1727 					pieces->dbg_conf_tlv_len[i],
1728 					GFP_KERNEL);
1729 			if (!drv->fw.dbg.conf_tlv[i])
1730 				goto out_free_fw;
1731 		}
1732 	}
1733 
1734 	memset(&trigger_tlv_sz, 0xff, sizeof(trigger_tlv_sz));
1735 
1736 	trigger_tlv_sz[FW_DBG_TRIGGER_MISSED_BEACONS] =
1737 		sizeof(struct iwl_fw_dbg_trigger_missed_bcon);
1738 	trigger_tlv_sz[FW_DBG_TRIGGER_CHANNEL_SWITCH] = 0;
1739 	trigger_tlv_sz[FW_DBG_TRIGGER_FW_NOTIF] =
1740 		sizeof(struct iwl_fw_dbg_trigger_cmd);
1741 	trigger_tlv_sz[FW_DBG_TRIGGER_MLME] =
1742 		sizeof(struct iwl_fw_dbg_trigger_mlme);
1743 	trigger_tlv_sz[FW_DBG_TRIGGER_STATS] =
1744 		sizeof(struct iwl_fw_dbg_trigger_stats);
1745 	trigger_tlv_sz[FW_DBG_TRIGGER_RSSI] =
1746 		sizeof(struct iwl_fw_dbg_trigger_low_rssi);
1747 	trigger_tlv_sz[FW_DBG_TRIGGER_TXQ_TIMERS] =
1748 		sizeof(struct iwl_fw_dbg_trigger_txq_timer);
1749 	trigger_tlv_sz[FW_DBG_TRIGGER_TIME_EVENT] =
1750 		sizeof(struct iwl_fw_dbg_trigger_time_event);
1751 	trigger_tlv_sz[FW_DBG_TRIGGER_BA] =
1752 		sizeof(struct iwl_fw_dbg_trigger_ba);
1753 	trigger_tlv_sz[FW_DBG_TRIGGER_TDLS] =
1754 		sizeof(struct iwl_fw_dbg_trigger_tdls);
1755 
1756 	for (i = 0; i < ARRAY_SIZE(drv->fw.dbg.trigger_tlv); i++) {
1757 		if (pieces->dbg_trigger_tlv[i]) {
1758 			/*
1759 			 * If the trigger isn't long enough, WARN and exit.
1760 			 * Someone is trying to debug something and he won't
1761 			 * be able to catch the bug he is trying to chase.
1762 			 * We'd better be noisy to be sure he knows what's
1763 			 * going on.
1764 			 */
1765 			if (WARN_ON(pieces->dbg_trigger_tlv_len[i] <
1766 				    (trigger_tlv_sz[i] +
1767 				     sizeof(struct iwl_fw_dbg_trigger_tlv))))
1768 				goto out_free_fw;
1769 			drv->fw.dbg.trigger_tlv_len[i] =
1770 				pieces->dbg_trigger_tlv_len[i];
1771 			drv->fw.dbg.trigger_tlv[i] =
1772 				kmemdup(pieces->dbg_trigger_tlv[i],
1773 					drv->fw.dbg.trigger_tlv_len[i],
1774 					GFP_KERNEL);
1775 			if (!drv->fw.dbg.trigger_tlv[i])
1776 				goto out_free_fw;
1777 		}
1778 	}
1779 
1780 	/* Now that we can no longer fail, copy information */
1781 
1782 	drv->fw.dbg.mem_tlv = pieces->dbg_mem_tlv;
1783 	pieces->dbg_mem_tlv = NULL;
1784 	drv->fw.dbg.n_mem_tlv = pieces->n_mem_tlv;
1785 
1786 	/*
1787 	 * The (size - 16) / 12 formula is based on the information recorded
1788 	 * for each event, which is of mode 1 (including timestamp) for all
1789 	 * new microcodes that include this information.
1790 	 */
1791 	fw->init_evtlog_ptr = pieces->init_evtlog_ptr;
1792 	if (pieces->init_evtlog_size)
1793 		fw->init_evtlog_size = (pieces->init_evtlog_size - 16)/12;
1794 	else
1795 		fw->init_evtlog_size =
1796 			drv->trans->mac_cfg->base->max_event_log_size;
1797 	fw->init_errlog_ptr = pieces->init_errlog_ptr;
1798 	fw->inst_evtlog_ptr = pieces->inst_evtlog_ptr;
1799 	if (pieces->inst_evtlog_size)
1800 		fw->inst_evtlog_size = (pieces->inst_evtlog_size - 16)/12;
1801 	else
1802 		fw->inst_evtlog_size =
1803 			drv->trans->mac_cfg->base->max_event_log_size;
1804 	fw->inst_errlog_ptr = pieces->inst_errlog_ptr;
1805 
1806 	/*
1807 	 * figure out the offset of chain noise reset and gain commands
1808 	 * base on the size of standard phy calibration commands table size
1809 	 */
1810 	if (fw->ucode_capa.standard_phy_calibration_size >
1811 	    IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
1812 		fw->ucode_capa.standard_phy_calibration_size =
1813 			IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;
1814 
1815 	/* We have our copies now, allow OS release its copies */
1816 	release_firmware(ucode_raw);
1817 
1818 	iwl_dbg_tlv_load_bin(drv->trans->dev, drv->trans);
1819 
1820 	mutex_lock(&iwlwifi_opmode_table_mtx);
1821 	switch (fw->type) {
1822 	case IWL_FW_DVM:
1823 		op = &iwlwifi_opmode_table[DVM_OP_MODE];
1824 		break;
1825 	default:
1826 		WARN(1, "Invalid fw type %d\n", fw->type);
1827 		fallthrough;
1828 	case IWL_FW_MVM:
1829 		op = &iwlwifi_opmode_table[MVM_OP_MODE];
1830 		break;
1831 	}
1832 
1833 #if IS_ENABLED(CONFIG_IWLMLD)
1834 	if (pieces->major >= IWL_MLD_SUPPORTED_FW_VERSION &&
1835 	    iwl_drv_is_wifi7_supported(drv->trans))
1836 		op = &iwlwifi_opmode_table[MLD_OP_MODE];
1837 #else
1838 	if (pieces->major >= IWL_MLD_SUPPORTED_FW_VERSION &&
1839 	    iwl_drv_is_wifi7_supported(drv->trans)) {
1840 		IWL_ERR(drv,
1841 			"IWLMLD needs to be compiled to support this firmware\n");
1842 		mutex_unlock(&iwlwifi_opmode_table_mtx);
1843 		goto out_unbind;
1844 	}
1845 #endif
1846 
1847 	IWL_INFO(drv, "loaded firmware version %s op_mode %s\n",
1848 		 drv->fw.fw_version, op->name);
1849 
1850 	/* add this device to the list of devices using this op_mode */
1851 	list_add_tail(&drv->list, &op->drv);
1852 
1853 	if (op->ops) {
1854 		drv->op_mode = _iwl_op_mode_start(drv, op);
1855 
1856 		if (!drv->op_mode) {
1857 			mutex_unlock(&iwlwifi_opmode_table_mtx);
1858 			goto out_unbind;
1859 		}
1860 	} else {
1861 		request_module_nowait("%s", op->name);
1862 	}
1863 	mutex_unlock(&iwlwifi_opmode_table_mtx);
1864 
1865 	complete(&drv->request_firmware_complete);
1866 
1867 	failure = false;
1868 	goto free;
1869 
1870  try_again:
1871 	/* try next, if any */
1872 	release_firmware(ucode_raw);
1873 	if (iwl_request_firmware(drv, false))
1874 		goto out_unbind;
1875 	goto free;
1876 
1877  out_free_fw:
1878 	release_firmware(ucode_raw);
1879  out_unbind:
1880 	complete(&drv->request_firmware_complete);
1881 	device_release_driver(drv->trans->dev);
1882 	/* drv has just been freed by the release */
1883 	failure = false;
1884  free:
1885 	if (failure)
1886 		iwl_dealloc_ucode(drv);
1887 
1888 	if (pieces) {
1889 		for (i = 0; i < ARRAY_SIZE(pieces->img); i++)
1890 			kfree(pieces->img[i].sec);
1891 		kfree(pieces->dbg_mem_tlv);
1892 		kfree(pieces);
1893 	}
1894 }
1895 
1896 struct iwl_drv *iwl_drv_start(struct iwl_trans *trans)
1897 {
1898 	struct iwl_drv *drv;
1899 	int ret;
1900 
1901 	drv = kzalloc(sizeof(*drv), GFP_KERNEL);
1902 	if (!drv) {
1903 		ret = -ENOMEM;
1904 		goto err;
1905 	}
1906 
1907 	drv->trans = trans;
1908 	drv->dev = trans->dev;
1909 
1910 	init_completion(&drv->request_firmware_complete);
1911 	INIT_LIST_HEAD(&drv->list);
1912 
1913 #ifdef CONFIG_IWLWIFI_DEBUGFS
1914 	/* Create the device debugfs entries. */
1915 	drv->dbgfs_drv = debugfs_create_dir(dev_name(trans->dev),
1916 					    iwl_dbgfs_root);
1917 
1918 	/* Create transport layer debugfs dir */
1919 	drv->trans->dbgfs_dir = debugfs_create_dir("trans", drv->dbgfs_drv);
1920 #endif
1921 
1922 	drv->trans->dbg.domains_bitmap = IWL_TRANS_FW_DBG_DOMAIN(drv->trans);
1923 	if (iwlwifi_mod_params.enable_ini != ENABLE_INI) {
1924 		/* We have a non-default value in the module parameter,
1925 		 * take its value
1926 		 */
1927 		drv->trans->dbg.domains_bitmap &= 0xffff;
1928 		if (iwlwifi_mod_params.enable_ini != IWL_FW_INI_PRESET_DISABLE) {
1929 			if (iwlwifi_mod_params.enable_ini > ENABLE_INI) {
1930 				IWL_ERR(trans,
1931 					"invalid enable_ini module parameter value: max = %d, using 0 instead\n",
1932 					ENABLE_INI);
1933 				iwlwifi_mod_params.enable_ini = 0;
1934 			}
1935 			drv->trans->dbg.domains_bitmap =
1936 				BIT(IWL_FW_DBG_DOMAIN_POS + iwlwifi_mod_params.enable_ini);
1937 		}
1938 	}
1939 
1940 	ret = iwl_request_firmware(drv, true);
1941 	if (ret) {
1942 		IWL_ERR(trans, "Couldn't request the fw\n");
1943 		goto err_fw;
1944 	}
1945 
1946 	return drv;
1947 
1948 err_fw:
1949 #ifdef CONFIG_IWLWIFI_DEBUGFS
1950 	debugfs_remove_recursive(drv->dbgfs_drv);
1951 #endif
1952 	iwl_dbg_tlv_free(drv->trans);
1953 	kfree(drv);
1954 err:
1955 	return ERR_PTR(ret);
1956 }
1957 
1958 void iwl_drv_stop(struct iwl_drv *drv)
1959 {
1960 	wait_for_completion(&drv->request_firmware_complete);
1961 
1962 	mutex_lock(&iwlwifi_opmode_table_mtx);
1963 
1964 	_iwl_op_mode_stop(drv);
1965 
1966 	iwl_dealloc_ucode(drv);
1967 
1968 	/*
1969 	 * List is empty (this item wasn't added)
1970 	 * when firmware loading failed -- in that
1971 	 * case we can't remove it from any list.
1972 	 */
1973 	if (!list_empty(&drv->list))
1974 		list_del(&drv->list);
1975 	mutex_unlock(&iwlwifi_opmode_table_mtx);
1976 
1977 #ifdef CONFIG_IWLWIFI_DEBUGFS
1978 	iwl_trans_debugfs_cleanup(drv->trans);
1979 
1980 	debugfs_remove_recursive(drv->dbgfs_drv);
1981 #endif
1982 
1983 	iwl_dbg_tlv_free(drv->trans);
1984 
1985 	kfree(drv);
1986 }
1987 
1988 /* shared module parameters */
1989 struct iwl_mod_params iwlwifi_mod_params = {
1990 	.fw_restart = true,
1991 	.bt_coex_active = true,
1992 	.power_level = IWL_POWER_INDEX_1,
1993 	.uapsd_disable = IWL_DISABLE_UAPSD_BSS | IWL_DISABLE_UAPSD_P2P_CLIENT,
1994 	.enable_ini = ENABLE_INI,
1995 	/* the rest are 0 by default */
1996 };
1997 IWL_EXPORT_SYMBOL(iwlwifi_mod_params);
1998 
1999 int iwl_opmode_register(const char *name, const struct iwl_op_mode_ops *ops)
2000 {
2001 	int i;
2002 	struct iwl_drv *drv;
2003 	struct iwlwifi_opmode_table *op;
2004 
2005 	mutex_lock(&iwlwifi_opmode_table_mtx);
2006 	for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
2007 		op = &iwlwifi_opmode_table[i];
2008 		if (strcmp(op->name, name))
2009 			continue;
2010 		op->ops = ops;
2011 		/* TODO: need to handle exceptional case */
2012 		list_for_each_entry(drv, &op->drv, list)
2013 			drv->op_mode = _iwl_op_mode_start(drv, op);
2014 
2015 		mutex_unlock(&iwlwifi_opmode_table_mtx);
2016 		return 0;
2017 	}
2018 	mutex_unlock(&iwlwifi_opmode_table_mtx);
2019 	return -EIO;
2020 }
2021 IWL_EXPORT_SYMBOL(iwl_opmode_register);
2022 
2023 void iwl_opmode_deregister(const char *name)
2024 {
2025 	int i;
2026 	struct iwl_drv *drv;
2027 
2028 	mutex_lock(&iwlwifi_opmode_table_mtx);
2029 	for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++) {
2030 		if (strcmp(iwlwifi_opmode_table[i].name, name))
2031 			continue;
2032 		iwlwifi_opmode_table[i].ops = NULL;
2033 
2034 		/* call the stop routine for all devices */
2035 		list_for_each_entry(drv, &iwlwifi_opmode_table[i].drv, list)
2036 			_iwl_op_mode_stop(drv);
2037 
2038 		mutex_unlock(&iwlwifi_opmode_table_mtx);
2039 		return;
2040 	}
2041 	mutex_unlock(&iwlwifi_opmode_table_mtx);
2042 }
2043 IWL_EXPORT_SYMBOL(iwl_opmode_deregister);
2044 
2045 static int __init iwl_drv_init(void)
2046 {
2047 	int i, err;
2048 
2049 	for (i = 0; i < ARRAY_SIZE(iwlwifi_opmode_table); i++)
2050 		INIT_LIST_HEAD(&iwlwifi_opmode_table[i].drv);
2051 
2052 #ifdef CONFIG_IWLWIFI_DEBUGFS
2053 	/* Create the root of iwlwifi debugfs subsystem. */
2054 	iwl_dbgfs_root = debugfs_create_dir(DRV_NAME, NULL);
2055 #endif
2056 
2057 	err = iwl_pci_register_driver();
2058 	if (err)
2059 		goto cleanup_debugfs;
2060 
2061 	return 0;
2062 
2063 cleanup_debugfs:
2064 #ifdef CONFIG_IWLWIFI_DEBUGFS
2065 	debugfs_remove_recursive(iwl_dbgfs_root);
2066 #endif
2067 	return err;
2068 }
2069 module_init(iwl_drv_init);
2070 
2071 static void __exit iwl_drv_exit(void)
2072 {
2073 	iwl_pci_unregister_driver();
2074 	iwl_trans_free_restart_list();
2075 
2076 #ifdef CONFIG_IWLWIFI_DEBUGFS
2077 	debugfs_remove_recursive(iwl_dbgfs_root);
2078 #endif
2079 }
2080 module_exit(iwl_drv_exit);
2081 
2082 #ifdef CONFIG_IWLWIFI_DEBUG
2083 module_param_named(debug, iwlwifi_mod_params.debug_level, uint, 0644);
2084 MODULE_PARM_DESC(debug, "debug output mask");
2085 #endif
2086 
2087 module_param_named(swcrypto, iwlwifi_mod_params.swcrypto, int, 0444);
2088 MODULE_PARM_DESC(swcrypto, "using crypto in software (default 0 [hardware])");
2089 module_param_named(11n_disable, iwlwifi_mod_params.disable_11n, uint, 0444);
2090 MODULE_PARM_DESC(11n_disable,
2091 	"disable 11n functionality, bitmap: 1: full, 2: disable agg TX, 4: disable agg RX, 8 enable agg TX");
2092 module_param_named(amsdu_size, iwlwifi_mod_params.amsdu_size, int, 0444);
2093 MODULE_PARM_DESC(amsdu_size,
2094 		 "amsdu size 0: 12K for multi Rx queue devices, 2K for AX210 devices, "
2095 		 "4K for other devices 1:4K 2:8K 3:12K (16K buffers) 4: 2K (default 0)");
2096 module_param_named(fw_restart, iwlwifi_mod_params.fw_restart, bool, 0444);
2097 MODULE_PARM_DESC(fw_restart, "restart firmware in case of error (default true)");
2098 
2099 module_param_named(nvm_file, iwlwifi_mod_params.nvm_file, charp, 0444);
2100 MODULE_PARM_DESC(nvm_file, "NVM file name");
2101 
2102 module_param_named(uapsd_disable, iwlwifi_mod_params.uapsd_disable, uint, 0644);
2103 MODULE_PARM_DESC(uapsd_disable,
2104 		 "disable U-APSD functionality bitmap 1: BSS 2: P2P Client (default: 3)");
2105 
2106 module_param_named(enable_ini, iwlwifi_mod_params.enable_ini, uint, 0444);
2107 MODULE_PARM_DESC(enable_ini,
2108 		 "0:disable, 1-15:FW_DBG_PRESET Values, 16:enabled without preset value defined,"
2109 		 "Debug INI TLV FW debug infrastructure (default: 16)");
2110 
2111 /*
2112  * set bt_coex_active to true, uCode will do kill/defer
2113  * every time the priority line is asserted (BT is sending signals on the
2114  * priority line in the PCIx).
2115  * set bt_coex_active to false, uCode will ignore the BT activity and
2116  * perform the normal operation
2117  *
2118  * User might experience transmit issue on some platform due to WiFi/BT
2119  * co-exist problem. The possible behaviors are:
2120  *   Able to scan and finding all the available AP
2121  *   Not able to associate with any AP
2122  * On those platforms, WiFi communication can be restored by set
2123  * "bt_coex_active" module parameter to "false"
2124  *
2125  * default: bt_coex_active = true (BT_COEX_ENABLE)
2126  */
2127 module_param_named(bt_coex_active, iwlwifi_mod_params.bt_coex_active,
2128 		   bool, 0444);
2129 MODULE_PARM_DESC(bt_coex_active, "enable wifi/bt co-exist (default: enable)");
2130 
2131 module_param_named(led_mode, iwlwifi_mod_params.led_mode, int, 0444);
2132 MODULE_PARM_DESC(led_mode, "0=system default, "
2133 		"1=On(RF On)/Off(RF Off), 2=blinking, 3=Off (default: 0)");
2134 
2135 module_param_named(power_save, iwlwifi_mod_params.power_save, bool, 0444);
2136 MODULE_PARM_DESC(power_save,
2137 		 "enable WiFi power management (default: disable)");
2138 
2139 module_param_named(power_level, iwlwifi_mod_params.power_level, int, 0444);
2140 MODULE_PARM_DESC(power_level,
2141 		 "default power save level (range from 1 - 5, default: 1)");
2142 
2143 module_param_named(disable_11ac, iwlwifi_mod_params.disable_11ac, bool, 0444);
2144 MODULE_PARM_DESC(disable_11ac, "Disable VHT capabilities (default: false)");
2145 
2146 module_param_named(remove_when_gone,
2147 		   iwlwifi_mod_params.remove_when_gone, bool,
2148 		   0444);
2149 MODULE_PARM_DESC(remove_when_gone,
2150 		 "Remove dev from PCIe bus if it is deemed inaccessible (default: false)");
2151 
2152 module_param_named(disable_11ax, iwlwifi_mod_params.disable_11ax, bool,
2153 		   S_IRUGO);
2154 MODULE_PARM_DESC(disable_11ax, "Disable HE capabilities (default: false)");
2155 
2156 module_param_named(disable_11be, iwlwifi_mod_params.disable_11be, bool, 0444);
2157 MODULE_PARM_DESC(disable_11be, "Disable EHT capabilities (default: false)");
2158