iwl-drv.c 26.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
/******************************************************************************
 *
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2007 - 2012 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110,
 * USA
 *
 * The full GNU General Public License is included in this distribution
 * in the file called LICENSE.GPL.
 *
 * Contact Information:
 *  Intel Linux Wireless <ilw@linux.intel.com>
 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 *
 * BSD LICENSE
 *
 * Copyright(c) 2005 - 2012 Intel Corporation. All rights reserved.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name Intel Corporation nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
#include <linux/completion.h>
64 65 66
#include <linux/dma-mapping.h>
#include <linux/firmware.h>
#include <linux/module.h>
67 68 69

#include "iwl-drv.h"
#include "iwl-trans.h"
70
#include "iwl-shared.h"
71
#include "iwl-op-mode.h"
72
#include "iwl-agn-hw.h"
73

74
/* private includes */
75
#include "iwl-fw-file.h"
76

J
Johannes Berg 已提交
77 78 79 80 81
/**
 * struct iwl_drv - drv common data
 * @fw: the iwl_fw structure
 * @shrd: pointer to common shared structure
 * @op_mode: the running op_mode
82 83
 * @trans: transport layer
 * @cfg: configuration struct
J
Johannes Berg 已提交
84 85 86 87 88 89 90 91 92
 * @fw_index: firmware revision to try loading
 * @firmware_name: composite filename of ucode file to load
 * @request_firmware_complete: the firmware has been obtained from user space
 */
struct iwl_drv {
	struct iwl_fw fw;

	struct iwl_shared *shrd;
	struct iwl_op_mode *op_mode;
93
	struct iwl_trans *trans;
94
	const struct iwl_cfg *cfg;
J
Johannes Berg 已提交
95 96 97 98 99 100 101 102 103

	int fw_index;                   /* firmware we're trying to load */
	char firmware_name[25];         /* name of firmware file to load */

	struct completion request_firmware_complete;
};



104 105 106 107 108 109 110 111 112 113
/*
 * struct fw_sec: Just for the image parsing proccess.
 * For the fw storage we are using struct fw_desc.
 */
struct fw_sec {
	const void *data;		/* the sec data */
	size_t size;			/* section size */
	u32 offset;			/* offset of writing in the device */
};

J
Johannes Berg 已提交
114
static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
115 116
{
	if (desc->v_addr)
117
		dma_free_coherent(drv->trans->dev, desc->len,
118 119 120 121 122
				  desc->v_addr, desc->p_addr);
	desc->v_addr = NULL;
	desc->len = 0;
}

J
Johannes Berg 已提交
123
static void iwl_free_fw_img(struct iwl_drv *drv, struct fw_img *img)
124
{
D
David Spinadel 已提交
125 126 127
	int i;
	for (i = 0; i < IWL_UCODE_SECTION_MAX; i++)
		iwl_free_fw_desc(drv, &img->sec[i]);
128 129
}

J
Johannes Berg 已提交
130
static void iwl_dealloc_ucode(struct iwl_drv *drv)
131
{
D
David Spinadel 已提交
132 133 134
	int i;
	for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
		iwl_free_fw_img(drv, drv->fw.img + i);
135 136
}

J
Johannes Berg 已提交
137
static int iwl_alloc_fw_desc(struct iwl_drv *drv, struct fw_desc *desc,
138
		      struct fw_sec *sec)
139
{
140
	if (!sec || !sec->size) {
141 142 143 144
		desc->v_addr = NULL;
		return -EINVAL;
	}

145
	desc->v_addr = dma_alloc_coherent(drv->trans->dev, sec->size,
146 147 148 149
					  &desc->p_addr, GFP_KERNEL);
	if (!desc->v_addr)
		return -ENOMEM;

150 151 152
	desc->len = sec->size;
	desc->offset = sec->offset;
	memcpy(desc->v_addr, sec->data, sec->size);
153 154 155 156 157 158 159 160
	return 0;
}

static void iwl_ucode_callback(const struct firmware *ucode_raw, void *context);

#define UCODE_EXPERIMENTAL_INDEX	100
#define UCODE_EXPERIMENTAL_TAG		"exp"

J
Johannes Berg 已提交
161
static int iwl_request_firmware(struct iwl_drv *drv, bool first)
162
{
163
	const char *name_pre = drv->cfg->fw_name_pre;
164 165 166 167
	char tag[8];

	if (first) {
#ifdef CONFIG_IWLWIFI_DEBUG_EXPERIMENTAL_UCODE
J
Johannes Berg 已提交
168
		drv->fw_index = UCODE_EXPERIMENTAL_INDEX;
169
		strcpy(tag, UCODE_EXPERIMENTAL_TAG);
J
Johannes Berg 已提交
170
	} else if (drv->fw_index == UCODE_EXPERIMENTAL_INDEX) {
171
#endif
172
		drv->fw_index = drv->cfg->ucode_api_max;
J
Johannes Berg 已提交
173
		sprintf(tag, "%d", drv->fw_index);
174
	} else {
J
Johannes Berg 已提交
175 176
		drv->fw_index--;
		sprintf(tag, "%d", drv->fw_index);
177 178
	}

179
	if (drv->fw_index < drv->cfg->ucode_api_min) {
J
Johannes Berg 已提交
180
		IWL_ERR(drv, "no suitable firmware found!\n");
181 182 183
		return -ENOENT;
	}

J
Johannes Berg 已提交
184
	sprintf(drv->firmware_name, "%s%s%s", name_pre, tag, ".ucode");
185

J
Johannes Berg 已提交
186 187
	IWL_DEBUG_INFO(drv, "attempting to load firmware %s'%s'\n",
		       (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
188
				? "EXPERIMENTAL " : "",
J
Johannes Berg 已提交
189
		       drv->firmware_name);
190

J
Johannes Berg 已提交
191
	return request_firmware_nowait(THIS_MODULE, 1, drv->firmware_name,
192
				       drv->trans->dev,
J
Johannes Berg 已提交
193
				       GFP_KERNEL, drv, iwl_ucode_callback);
194 195
}

196
struct fw_img_parsing {
D
David Spinadel 已提交
197
	struct fw_sec sec[IWL_UCODE_SECTION_MAX];
198 199 200
	int sec_counter;
};

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
/*
 * struct fw_sec_parsing: to extract fw section and it's offset from tlv
 */
struct fw_sec_parsing {
	__le32 offset;
	const u8 data[];
} __packed;

/**
 * struct iwl_tlv_calib_data - parse the default calib data from TLV
 *
 * @ucode_type: the uCode to which the following default calib relates.
 * @calib: default calibrations.
 */
struct iwl_tlv_calib_data {
	__le32 ucode_type;
	__le64 calib;
} __packed;

220 221
struct iwl_firmware_pieces {
	struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
222 223 224 225 226

	u32 init_evtlog_ptr, init_evtlog_size, init_errlog_ptr;
	u32 inst_evtlog_ptr, inst_evtlog_size, inst_errlog_ptr;
};

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
/*
 * These functions are just to extract uCode section data from the pieces
 * structure.
 */
static struct fw_sec *get_sec(struct iwl_firmware_pieces *pieces,
			      enum iwl_ucode_type type,
			      int  sec)
{
	return &pieces->img[type].sec[sec];
}

static void set_sec_data(struct iwl_firmware_pieces *pieces,
			 enum iwl_ucode_type type,
			 int sec,
			 const void *data)
{
	pieces->img[type].sec[sec].data = data;
}

static void set_sec_size(struct iwl_firmware_pieces *pieces,
			 enum iwl_ucode_type type,
			 int sec,
			 size_t size)
{
	pieces->img[type].sec[sec].size = size;
}

static size_t get_sec_size(struct iwl_firmware_pieces *pieces,
			   enum iwl_ucode_type type,
			   int sec)
{
	return pieces->img[type].sec[sec].size;
}

static void set_sec_offset(struct iwl_firmware_pieces *pieces,
			   enum iwl_ucode_type type,
			   int sec,
			   u32 offset)
{
	pieces->img[type].sec[sec].offset = offset;
}

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
/*
 * Gets uCode section from tlv.
 */
static int iwl_store_ucode_sec(struct iwl_firmware_pieces *pieces,
			       const void *data, enum iwl_ucode_type type,
			       int size)
{
	struct fw_img_parsing *img;
	struct fw_sec *sec;
	struct fw_sec_parsing *sec_parse;

	if (WARN_ON(!pieces || !data || type >= IWL_UCODE_TYPE_MAX))
		return -1;

	sec_parse = (struct fw_sec_parsing *)data;

	img = &pieces->img[type];
	sec = &img->sec[img->sec_counter];

	sec->offset = le32_to_cpu(sec_parse->offset);
	sec->data = sec_parse->data;
290
	sec->size = size - sizeof(sec_parse->offset);
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310

	++img->sec_counter;

	return 0;
}

static int iwl_set_default_calib(struct iwl_drv *drv, const u8 *data)
{
	struct iwl_tlv_calib_data *def_calib =
					(struct iwl_tlv_calib_data *)data;
	u32 ucode_type = le32_to_cpu(def_calib->ucode_type);
	if (ucode_type >= IWL_UCODE_TYPE_MAX) {
		IWL_ERR(drv, "Wrong ucode_type %u for default calibration.\n",
			ucode_type);
		return -EINVAL;
	}
	drv->fw.default_calib[ucode_type] = le64_to_cpu(def_calib->calib);
	return 0;
}

J
Johannes Berg 已提交
311
static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
312 313
				    const struct firmware *ucode_raw,
				    struct iwl_firmware_pieces *pieces)
314 315 316 317 318 319
{
	struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
	u32 api_ver, hdr_size, build;
	char buildstr[25];
	const u8 *src;

J
Johannes Berg 已提交
320 321
	drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
	api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
322 323 324 325 326

	switch (api_ver) {
	default:
		hdr_size = 28;
		if (ucode_raw->size < hdr_size) {
J
Johannes Berg 已提交
327
			IWL_ERR(drv, "File size too small!\n");
328 329 330
			return -EINVAL;
		}
		build = le32_to_cpu(ucode->u.v2.build);
331 332 333 334 335 336 337 338
		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
			     le32_to_cpu(ucode->u.v2.inst_size));
		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
			     le32_to_cpu(ucode->u.v2.data_size));
		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
			     le32_to_cpu(ucode->u.v2.init_size));
		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
			     le32_to_cpu(ucode->u.v2.init_data_size));
339 340 341 342 343 344 345
		src = ucode->u.v2.data;
		break;
	case 0:
	case 1:
	case 2:
		hdr_size = 24;
		if (ucode_raw->size < hdr_size) {
J
Johannes Berg 已提交
346
			IWL_ERR(drv, "File size too small!\n");
347 348 349
			return -EINVAL;
		}
		build = 0;
350 351 352 353 354 355 356 357
		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
			     le32_to_cpu(ucode->u.v1.inst_size));
		set_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
			     le32_to_cpu(ucode->u.v1.data_size));
		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
			     le32_to_cpu(ucode->u.v1.init_size));
		set_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
			     le32_to_cpu(ucode->u.v1.init_data_size));
358 359 360 361 362 363
		src = ucode->u.v1.data;
		break;
	}

	if (build)
		sprintf(buildstr, " build %u%s", build,
J
Johannes Berg 已提交
364
		       (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
365 366 367 368
				? " (EXP)" : "");
	else
		buildstr[0] = '\0';

J
Johannes Berg 已提交
369 370
	snprintf(drv->fw.fw_version,
		 sizeof(drv->fw.fw_version),
371
		 "%u.%u.%u.%u%s",
J
Johannes Berg 已提交
372 373 374 375
		 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
		 IWL_UCODE_MINOR(drv->fw.ucode_ver),
		 IWL_UCODE_API(drv->fw.ucode_ver),
		 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
376 377 378
		 buildstr);

	/* Verify size of file vs. image size info in file's header */
379 380 381 382 383 384

	if (ucode_raw->size != hdr_size +
	    get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) +
	    get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) +
	    get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) +
	    get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA)) {
385

J
Johannes Berg 已提交
386
		IWL_ERR(drv,
387 388 389 390 391 392
			"uCode file size %d does not match expected size\n",
			(int)ucode_raw->size);
		return -EINVAL;
	}


393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
	set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST, src);
	src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST);
	set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST,
		       IWLAGN_RTC_INST_LOWER_BOUND);
	set_sec_data(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA, src);
	src += get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA);
	set_sec_offset(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA,
		       IWLAGN_RTC_DATA_LOWER_BOUND);
	set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST, src);
	src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST);
	set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST,
		       IWLAGN_RTC_INST_LOWER_BOUND);
	set_sec_data(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA, src);
	src += get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA);
	set_sec_offset(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA,
		       IWLAGN_RTC_DATA_LOWER_BOUND);
409 410 411
	return 0;
}

J
Johannes Berg 已提交
412
static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
413
				const struct firmware *ucode_raw,
414
				struct iwl_firmware_pieces *pieces,
415 416 417 418 419 420 421 422 423 424 425 426 427
				struct iwl_ucode_capabilities *capa)
{
	struct iwl_tlv_ucode_header *ucode = (void *)ucode_raw->data;
	struct iwl_ucode_tlv *tlv;
	size_t len = ucode_raw->size;
	const u8 *data;
	u32 tlv_len;
	enum iwl_ucode_tlv_type tlv_type;
	const u8 *tlv_data;
	char buildstr[25];
	u32 build;

	if (len < sizeof(*ucode)) {
J
Johannes Berg 已提交
428
		IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
429 430 431 432
		return -EINVAL;
	}

	if (ucode->magic != cpu_to_le32(IWL_TLV_UCODE_MAGIC)) {
J
Johannes Berg 已提交
433
		IWL_ERR(drv, "invalid uCode magic: 0X%x\n",
434 435 436 437
			le32_to_cpu(ucode->magic));
		return -EINVAL;
	}

J
Johannes Berg 已提交
438
	drv->fw.ucode_ver = le32_to_cpu(ucode->ver);
439 440 441 442
	build = le32_to_cpu(ucode->build);

	if (build)
		sprintf(buildstr, " build %u%s", build,
J
Johannes Berg 已提交
443
		       (drv->fw_index == UCODE_EXPERIMENTAL_INDEX)
444 445 446 447
				? " (EXP)" : "");
	else
		buildstr[0] = '\0';

J
Johannes Berg 已提交
448 449
	snprintf(drv->fw.fw_version,
		 sizeof(drv->fw.fw_version),
450
		 "%u.%u.%u.%u%s",
J
Johannes Berg 已提交
451 452 453 454
		 IWL_UCODE_MAJOR(drv->fw.ucode_ver),
		 IWL_UCODE_MINOR(drv->fw.ucode_ver),
		 IWL_UCODE_API(drv->fw.ucode_ver),
		 IWL_UCODE_SERIAL(drv->fw.ucode_ver),
455 456 457 458 459 460 461 462 463 464 465
		 buildstr);

	data = ucode->data;

	len -= sizeof(*ucode);

	while (len >= sizeof(*tlv)) {
		len -= sizeof(*tlv);
		tlv = (void *)data;

		tlv_len = le32_to_cpu(tlv->length);
466
		tlv_type = le32_to_cpu(tlv->type);
467 468 469
		tlv_data = tlv->data;

		if (len < tlv_len) {
J
Johannes Berg 已提交
470
			IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
471 472 473 474 475 476 477 478
				len, tlv_len);
			return -EINVAL;
		}
		len -= ALIGN(tlv_len, 4);
		data += sizeof(*tlv) + ALIGN(tlv_len, 4);

		switch (tlv_type) {
		case IWL_UCODE_TLV_INST:
479 480 481 482 483 484 485
			set_sec_data(pieces, IWL_UCODE_REGULAR,
				     IWL_UCODE_SECTION_INST, tlv_data);
			set_sec_size(pieces, IWL_UCODE_REGULAR,
				     IWL_UCODE_SECTION_INST, tlv_len);
			set_sec_offset(pieces, IWL_UCODE_REGULAR,
				       IWL_UCODE_SECTION_INST,
				       IWLAGN_RTC_INST_LOWER_BOUND);
486 487
			break;
		case IWL_UCODE_TLV_DATA:
488 489 490 491 492 493 494
			set_sec_data(pieces, IWL_UCODE_REGULAR,
				     IWL_UCODE_SECTION_DATA, tlv_data);
			set_sec_size(pieces, IWL_UCODE_REGULAR,
				     IWL_UCODE_SECTION_DATA, tlv_len);
			set_sec_offset(pieces, IWL_UCODE_REGULAR,
				       IWL_UCODE_SECTION_DATA,
				       IWLAGN_RTC_DATA_LOWER_BOUND);
495 496
			break;
		case IWL_UCODE_TLV_INIT:
497 498 499 500 501 502 503
			set_sec_data(pieces, IWL_UCODE_INIT,
				     IWL_UCODE_SECTION_INST, tlv_data);
			set_sec_size(pieces, IWL_UCODE_INIT,
				     IWL_UCODE_SECTION_INST, tlv_len);
			set_sec_offset(pieces, IWL_UCODE_INIT,
				       IWL_UCODE_SECTION_INST,
				       IWLAGN_RTC_INST_LOWER_BOUND);
504 505
			break;
		case IWL_UCODE_TLV_INIT_DATA:
506 507 508 509 510 511 512
			set_sec_data(pieces, IWL_UCODE_INIT,
				     IWL_UCODE_SECTION_DATA, tlv_data);
			set_sec_size(pieces, IWL_UCODE_INIT,
				     IWL_UCODE_SECTION_DATA, tlv_len);
			set_sec_offset(pieces, IWL_UCODE_INIT,
				       IWL_UCODE_SECTION_DATA,
				       IWLAGN_RTC_DATA_LOWER_BOUND);
513 514
			break;
		case IWL_UCODE_TLV_BOOT:
J
Johannes Berg 已提交
515
			IWL_ERR(drv, "Found unexpected BOOT ucode\n");
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582
			break;
		case IWL_UCODE_TLV_PROBE_MAX_LEN:
			if (tlv_len != sizeof(u32))
				goto invalid_tlv_len;
			capa->max_probe_length =
					le32_to_cpup((__le32 *)tlv_data);
			break;
		case IWL_UCODE_TLV_PAN:
			if (tlv_len)
				goto invalid_tlv_len;
			capa->flags |= IWL_UCODE_TLV_FLAGS_PAN;
			break;
		case IWL_UCODE_TLV_FLAGS:
			/* must be at least one u32 */
			if (tlv_len < sizeof(u32))
				goto invalid_tlv_len;
			/* and a proper number of u32s */
			if (tlv_len % sizeof(u32))
				goto invalid_tlv_len;
			/*
			 * This driver only reads the first u32 as
			 * right now no more features are defined,
			 * if that changes then either the driver
			 * will not work with the new firmware, or
			 * it'll not take advantage of new features.
			 */
			capa->flags = le32_to_cpup((__le32 *)tlv_data);
			break;
		case IWL_UCODE_TLV_INIT_EVTLOG_PTR:
			if (tlv_len != sizeof(u32))
				goto invalid_tlv_len;
			pieces->init_evtlog_ptr =
					le32_to_cpup((__le32 *)tlv_data);
			break;
		case IWL_UCODE_TLV_INIT_EVTLOG_SIZE:
			if (tlv_len != sizeof(u32))
				goto invalid_tlv_len;
			pieces->init_evtlog_size =
					le32_to_cpup((__le32 *)tlv_data);
			break;
		case IWL_UCODE_TLV_INIT_ERRLOG_PTR:
			if (tlv_len != sizeof(u32))
				goto invalid_tlv_len;
			pieces->init_errlog_ptr =
					le32_to_cpup((__le32 *)tlv_data);
			break;
		case IWL_UCODE_TLV_RUNT_EVTLOG_PTR:
			if (tlv_len != sizeof(u32))
				goto invalid_tlv_len;
			pieces->inst_evtlog_ptr =
					le32_to_cpup((__le32 *)tlv_data);
			break;
		case IWL_UCODE_TLV_RUNT_EVTLOG_SIZE:
			if (tlv_len != sizeof(u32))
				goto invalid_tlv_len;
			pieces->inst_evtlog_size =
					le32_to_cpup((__le32 *)tlv_data);
			break;
		case IWL_UCODE_TLV_RUNT_ERRLOG_PTR:
			if (tlv_len != sizeof(u32))
				goto invalid_tlv_len;
			pieces->inst_errlog_ptr =
					le32_to_cpup((__le32 *)tlv_data);
			break;
		case IWL_UCODE_TLV_ENHANCE_SENS_TBL:
			if (tlv_len)
				goto invalid_tlv_len;
J
Johannes Berg 已提交
583
			drv->fw.enhance_sensitivity_table = true;
584 585
			break;
		case IWL_UCODE_TLV_WOWLAN_INST:
586 587 588 589 590 591 592
			set_sec_data(pieces, IWL_UCODE_WOWLAN,
				     IWL_UCODE_SECTION_INST, tlv_data);
			set_sec_size(pieces, IWL_UCODE_WOWLAN,
				     IWL_UCODE_SECTION_INST, tlv_len);
			set_sec_offset(pieces, IWL_UCODE_WOWLAN,
				       IWL_UCODE_SECTION_INST,
				       IWLAGN_RTC_INST_LOWER_BOUND);
593 594
			break;
		case IWL_UCODE_TLV_WOWLAN_DATA:
595 596 597 598 599 600 601
			set_sec_data(pieces, IWL_UCODE_WOWLAN,
				     IWL_UCODE_SECTION_DATA, tlv_data);
			set_sec_size(pieces, IWL_UCODE_WOWLAN,
				     IWL_UCODE_SECTION_DATA, tlv_len);
			set_sec_offset(pieces, IWL_UCODE_WOWLAN,
				       IWL_UCODE_SECTION_DATA,
				       IWLAGN_RTC_DATA_LOWER_BOUND);
602 603 604 605 606 607 608
			break;
		case IWL_UCODE_TLV_PHY_CALIBRATION_SIZE:
			if (tlv_len != sizeof(u32))
				goto invalid_tlv_len;
			capa->standard_phy_calibration_size =
					le32_to_cpup((__le32 *)tlv_data);
			break;
609 610 611
		 case IWL_UCODE_TLV_SEC_RT:
			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
					    tlv_len);
612
			drv->fw.mvm_fw = true;
613 614 615 616
			break;
		case IWL_UCODE_TLV_SEC_INIT:
			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
					    tlv_len);
617
			drv->fw.mvm_fw = true;
618 619 620 621
			break;
		case IWL_UCODE_TLV_SEC_WOWLAN:
			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
					    tlv_len);
622
			drv->fw.mvm_fw = true;
623 624 625 626 627 628 629 630 631 632 633 634
			break;
		case IWL_UCODE_TLV_DEF_CALIB:
			if (tlv_len != sizeof(struct iwl_tlv_calib_data))
				goto invalid_tlv_len;
			if (iwl_set_default_calib(drv, tlv_data))
				goto tlv_error;
			break;
		case IWL_UCODE_TLV_PHY_SKU:
			if (tlv_len != sizeof(u32))
				goto invalid_tlv_len;
			drv->fw.phy_config = le32_to_cpup((__le32 *)tlv_data);
			break;
635
		default:
J
Johannes Berg 已提交
636
			IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
637 638 639 640 641
			break;
		}
	}

	if (len) {
J
Johannes Berg 已提交
642 643
		IWL_ERR(drv, "invalid TLV after parsing: %zd\n", len);
		iwl_print_hex_dump(drv, IWL_DL_FW, (u8 *)data, len);
644 645 646 647 648 649
		return -EINVAL;
	}

	return 0;

 invalid_tlv_len:
J
Johannes Berg 已提交
650
	IWL_ERR(drv, "TLV %d has invalid size: %u\n", tlv_type, tlv_len);
651
 tlv_error:
J
Johannes Berg 已提交
652
	iwl_print_hex_dump(drv, IWL_DL_FW, tlv_data, tlv_len);
653 654 655 656

	return -EINVAL;
}

D
David Spinadel 已提交
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
static int alloc_pci_desc(struct iwl_drv *drv,
			  struct iwl_firmware_pieces *pieces,
			  enum iwl_ucode_type type)
{
	int i;
	for (i = 0;
	     i < IWL_UCODE_SECTION_MAX && get_sec_size(pieces, type, i);
	     i++)
		if (iwl_alloc_fw_desc(drv, &(drv->fw.img[type].sec[i]),
						get_sec(pieces, type, i)))
			return -1;
	return 0;
}

static int validate_sec_sizes(struct iwl_drv *drv,
			      struct iwl_firmware_pieces *pieces,
			      const struct iwl_cfg *cfg)
{
	IWL_DEBUG_INFO(drv, "f/w package hdr runtime inst size = %Zd\n",
		get_sec_size(pieces, IWL_UCODE_REGULAR,
			     IWL_UCODE_SECTION_INST));
	IWL_DEBUG_INFO(drv, "f/w package hdr runtime data size = %Zd\n",
		get_sec_size(pieces, IWL_UCODE_REGULAR,
			     IWL_UCODE_SECTION_DATA));
	IWL_DEBUG_INFO(drv, "f/w package hdr init inst size = %Zd\n",
		get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST));
	IWL_DEBUG_INFO(drv, "f/w package hdr init data size = %Zd\n",
		get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA));

	/* Verify that uCode images will fit in card's SRAM. */
	if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_INST) >
							cfg->max_inst_size) {
		IWL_ERR(drv, "uCode instr len %Zd too large to fit in\n",
			get_sec_size(pieces, IWL_UCODE_REGULAR,
						IWL_UCODE_SECTION_INST));
		return -1;
	}

	if (get_sec_size(pieces, IWL_UCODE_REGULAR, IWL_UCODE_SECTION_DATA) >
							cfg->max_data_size) {
		IWL_ERR(drv, "uCode data len %Zd too large to fit in\n",
			get_sec_size(pieces, IWL_UCODE_REGULAR,
						IWL_UCODE_SECTION_DATA));
		return -1;
	}

	 if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_INST) >
							cfg->max_inst_size) {
		IWL_ERR(drv, "uCode init instr len %Zd too large to fit in\n",
			get_sec_size(pieces, IWL_UCODE_INIT,
						IWL_UCODE_SECTION_INST));
		return -1;
	}

	if (get_sec_size(pieces, IWL_UCODE_INIT, IWL_UCODE_SECTION_DATA) >
							cfg->max_data_size) {
		IWL_ERR(drv, "uCode init data len %Zd too large to fit in\n",
			get_sec_size(pieces, IWL_UCODE_REGULAR,
						IWL_UCODE_SECTION_DATA));
		return -1;
	}
	return 0;
}


722 723 724 725 726 727 728 729
/**
 * iwl_ucode_callback - callback when firmware was loaded
 *
 * If loaded successfully, copies the firmware into buffers
 * for the card to fetch (via DMA).
 */
static void iwl_ucode_callback(const struct firmware *ucode_raw, void *context)
{
J
Johannes Berg 已提交
730 731
	struct iwl_drv *drv = context;
	struct iwl_fw *fw = &drv->fw;
732 733
	struct iwl_ucode_header *ucode;
	int err;
734
	struct iwl_firmware_pieces pieces;
735 736 737
	const unsigned int api_max = drv->cfg->ucode_api_max;
	unsigned int api_ok = drv->cfg->ucode_api_ok;
	const unsigned int api_min = drv->cfg->ucode_api_min;
738
	u32 api_ver;
D
David Spinadel 已提交
739
	int i;
740 741 742 743 744 745 746 747 748 749 750

	fw->ucode_capa.max_probe_length = 200;
	fw->ucode_capa.standard_phy_calibration_size =
			IWL_DEFAULT_STANDARD_PHY_CALIBRATE_TBL_SIZE;

	if (!api_ok)
		api_ok = api_max;

	memset(&pieces, 0, sizeof(pieces));

	if (!ucode_raw) {
J
Johannes Berg 已提交
751 752
		if (drv->fw_index <= api_ok)
			IWL_ERR(drv,
753
				"request for firmware file '%s' failed.\n",
J
Johannes Berg 已提交
754
				drv->firmware_name);
755 756 757
		goto try_again;
	}

J
Johannes Berg 已提交
758 759
	IWL_DEBUG_INFO(drv, "Loaded firmware file '%s' (%zd bytes).\n",
		       drv->firmware_name, ucode_raw->size);
760 761 762

	/* Make sure that we got at least the API version number */
	if (ucode_raw->size < 4) {
J
Johannes Berg 已提交
763
		IWL_ERR(drv, "File size way too small!\n");
764 765 766 767 768 769 770
		goto try_again;
	}

	/* Data from ucode file:  header followed by uCode images */
	ucode = (struct iwl_ucode_header *)ucode_raw->data;

	if (ucode->ver)
J
Johannes Berg 已提交
771
		err = iwl_parse_v1_v2_firmware(drv, ucode_raw, &pieces);
772
	else
J
Johannes Berg 已提交
773
		err = iwl_parse_tlv_firmware(drv, ucode_raw, &pieces,
774 775 776 777 778
					   &fw->ucode_capa);

	if (err)
		goto try_again;

J
Johannes Berg 已提交
779
	api_ver = IWL_UCODE_API(drv->fw.ucode_ver);
780 781 782 783 784 785 786

	/*
	 * api_ver should match the api version forming part of the
	 * firmware filename ... but we don't check for that and only rely
	 * on the API version read from firmware header from here on forward
	 */
	/* no api version check required for experimental uCode */
J
Johannes Berg 已提交
787
	if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
788
		if (api_ver < api_min || api_ver > api_max) {
J
Johannes Berg 已提交
789
			IWL_ERR(drv,
790 791 792 793 794 795 796 797
				"Driver unable to support your firmware API. "
				"Driver supports v%u, firmware is v%u.\n",
				api_max, api_ver);
			goto try_again;
		}

		if (api_ver < api_ok) {
			if (api_ok != api_max)
J
Johannes Berg 已提交
798
				IWL_ERR(drv, "Firmware has old API version, "
799 800 801
					"expected v%u through v%u, got v%u.\n",
					api_ok, api_max, api_ver);
			else
J
Johannes Berg 已提交
802
				IWL_ERR(drv, "Firmware has old API version, "
803 804
					"expected v%u, got v%u.\n",
					api_max, api_ver);
J
Johannes Berg 已提交
805
			IWL_ERR(drv, "New firmware can be obtained from "
806 807 808 809
				      "http://www.intellinuxwireless.org/.\n");
		}
	}

J
Johannes Berg 已提交
810
	IWL_INFO(drv, "loaded firmware version %s", drv->fw.fw_version);
811

812 813 814 815
	/*
	 * In mvm uCode there is no difference between data and instructions
	 * sections.
	 */
816
	if (!fw->mvm_fw && validate_sec_sizes(drv, &pieces, drv->cfg))
817 818 819 820 821 822 823
		goto try_again;

	/* Allocate ucode buffers for card's bus-master loading ... */

	/* Runtime instructions and 2 copies of data:
	 * 1) unmodified from disk
	 * 2) backup cache for save/restore during power-downs */
D
David Spinadel 已提交
824 825
	for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
		if (alloc_pci_desc(drv, &pieces, i))
826 827 828 829 830 831 832 833 834
			goto err_pci_alloc;

	/* Now that we can no longer fail, copy information */

	/*
	 * The (size - 16) / 12 formula is based on the information recorded
	 * for each event, which is of mode 1 (including timestamp) for all
	 * new microcodes that include this information.
	 */
835
	fw->init_evtlog_ptr = pieces.init_evtlog_ptr;
836
	if (pieces.init_evtlog_size)
837
		fw->init_evtlog_size = (pieces.init_evtlog_size - 16)/12;
838
	else
839
		fw->init_evtlog_size =
840
			drv->cfg->base_params->max_event_log_size;
841 842
	fw->init_errlog_ptr = pieces.init_errlog_ptr;
	fw->inst_evtlog_ptr = pieces.inst_evtlog_ptr;
843
	if (pieces.inst_evtlog_size)
844
		fw->inst_evtlog_size = (pieces.inst_evtlog_size - 16)/12;
845
	else
846
		fw->inst_evtlog_size =
847
			drv->cfg->base_params->max_event_log_size;
848
	fw->inst_errlog_ptr = pieces.inst_errlog_ptr;
849 850 851 852 853 854 855 856 857 858 859 860

	/*
	 * figure out the offset of chain noise reset and gain commands
	 * base on the size of standard phy calibration commands table size
	 */
	if (fw->ucode_capa.standard_phy_calibration_size >
	    IWL_MAX_PHY_CALIBRATE_TBL_SIZE)
		fw->ucode_capa.standard_phy_calibration_size =
			IWL_MAX_STANDARD_PHY_CALIBRATE_TBL_SIZE;

	/* We have our copies now, allow OS release its copies */
	release_firmware(ucode_raw);
J
Johannes Berg 已提交
861
	complete(&drv->request_firmware_complete);
862

863
	drv->op_mode = iwl_dvm_ops.start(drv->trans, drv->cfg, &drv->fw);
864

J
Johannes Berg 已提交
865
	if (!drv->op_mode)
866 867 868 869 870 871 872
		goto out_unbind;

	return;

 try_again:
	/* try next, if any */
	release_firmware(ucode_raw);
J
Johannes Berg 已提交
873
	if (iwl_request_firmware(drv, false))
874 875 876 877
		goto out_unbind;
	return;

 err_pci_alloc:
J
Johannes Berg 已提交
878 879
	IWL_ERR(drv, "failed to allocate pci memory\n");
	iwl_dealloc_ucode(drv);
880 881
	release_firmware(ucode_raw);
 out_unbind:
J
Johannes Berg 已提交
882
	complete(&drv->request_firmware_complete);
883
	device_release_driver(drv->trans->dev);
884 885
}

886 887 888
struct iwl_drv *iwl_drv_start(struct iwl_shared *shrd,
			      struct iwl_trans *trans,
			      const struct iwl_cfg *cfg)
889
{
J
Johannes Berg 已提交
890
	struct iwl_drv *drv;
891 892
	int ret;

J
Johannes Berg 已提交
893 894 895
	drv = kzalloc(sizeof(*drv), GFP_KERNEL);
	if (!drv) {
		dev_printk(KERN_ERR, trans->dev, "Couldn't allocate iwl_drv");
896
		return NULL;
897
	}
898
	/* For printing only - temporary until we change the logger */
J
Johannes Berg 已提交
899
	drv->shrd = shrd;
900
	drv->trans = trans;
901
	drv->cfg = cfg;
902

J
Johannes Berg 已提交
903
	init_completion(&drv->request_firmware_complete);
904

J
Johannes Berg 已提交
905
	ret = iwl_request_firmware(drv, true);
906 907 908

	if (ret) {
		dev_printk(KERN_ERR, trans->dev, "Couldn't request the fw");
J
Johannes Berg 已提交
909
		kfree(drv);
910
		drv = NULL;
911 912
	}

913
	return drv;
914 915
}

916
void iwl_drv_stop(struct iwl_drv *drv)
917
{
J
Johannes Berg 已提交
918
	wait_for_completion(&drv->request_firmware_complete);
919

920
	/* op_mode can be NULL if its start failed */
J
Johannes Berg 已提交
921 922
	if (drv->op_mode)
		iwl_op_mode_stop(drv->op_mode);
923

J
Johannes Berg 已提交
924
	iwl_dealloc_ucode(drv);
925

J
Johannes Berg 已提交
926
	kfree(drv);
927
}