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