iwl-drv.c 26.6 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 82 83 84 85 86 87 88 89 90
/**
 * struct iwl_drv - drv common data
 * @fw: the iwl_fw structure
 * @shrd: pointer to common shared structure
 * @op_mode: the running op_mode
 * @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;
91
	struct iwl_trans *trans;
J
Johannes Berg 已提交
92 93 94 95 96 97 98 99 100

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

	struct completion request_firmware_complete;
};



101 102 103 104 105 106 107 108 109 110
/*
 * 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 已提交
111
static void iwl_free_fw_desc(struct iwl_drv *drv, struct fw_desc *desc)
112 113
{
	if (desc->v_addr)
J
Johannes Berg 已提交
114
		dma_free_coherent(trans(drv)->dev, desc->len,
115 116 117 118 119
				  desc->v_addr, desc->p_addr);
	desc->v_addr = NULL;
	desc->len = 0;
}

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

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

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

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

147 148 149
	desc->len = sec->size;
	desc->offset = sec->offset;
	memcpy(desc->v_addr, sec->data, sec->size);
150 151 152 153 154 155 156 157
	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 已提交
158
static int iwl_request_firmware(struct iwl_drv *drv, bool first)
159
{
J
Johannes Berg 已提交
160
	const struct iwl_cfg *cfg = cfg(drv);
161 162 163 164 165
	const char *name_pre = cfg->fw_name_pre;
	char tag[8];

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

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

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

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

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

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

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
/*
 * 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;

218 219
struct iwl_firmware_pieces {
	struct fw_img_parsing img[IWL_UCODE_TYPE_MAX];
220 221 222 223 224

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

225 226 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
/*
 * 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;
}

267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
/*
 * 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;
288
	sec->size = size - sizeof(sec_parse->offset);
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308

	++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 已提交
309
static int iwl_parse_v1_v2_firmware(struct iwl_drv *drv,
310 311
				    const struct firmware *ucode_raw,
				    struct iwl_firmware_pieces *pieces)
312 313 314 315 316 317
{
	struct iwl_ucode_header *ucode = (void *)ucode_raw->data;
	u32 api_ver, hdr_size, build;
	char buildstr[25];
	const u8 *src;

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

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

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

J
Johannes Berg 已提交
367 368
	snprintf(drv->fw.fw_version,
		 sizeof(drv->fw.fw_version),
369
		 "%u.%u.%u.%u%s",
J
Johannes Berg 已提交
370 371 372 373
		 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),
374 375 376
		 buildstr);

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

	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)) {
383

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


391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406
	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);
407 408 409
	return 0;
}

J
Johannes Berg 已提交
410
static int iwl_parse_tlv_firmware(struct iwl_drv *drv,
411
				const struct firmware *ucode_raw,
412
				struct iwl_firmware_pieces *pieces,
413 414 415 416 417 418 419 420 421 422 423 424 425
				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 已提交
426
		IWL_ERR(drv, "uCode has invalid length: %zd\n", len);
427 428 429 430
		return -EINVAL;
	}

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

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

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

J
Johannes Berg 已提交
446 447
	snprintf(drv->fw.fw_version,
		 sizeof(drv->fw.fw_version),
448
		 "%u.%u.%u.%u%s",
J
Johannes Berg 已提交
449 450 451 452
		 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),
453 454 455 456 457 458 459 460 461 462 463
		 buildstr);

	data = ucode->data;

	len -= sizeof(*ucode);

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

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

		if (len < tlv_len) {
J
Johannes Berg 已提交
468
			IWL_ERR(drv, "invalid TLV len: %zd/%u\n",
469 470 471 472 473 474 475 476
				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:
477 478 479 480 481 482 483
			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);
484 485
			break;
		case IWL_UCODE_TLV_DATA:
486 487 488 489 490 491 492
			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);
493 494
			break;
		case IWL_UCODE_TLV_INIT:
495 496 497 498 499 500 501
			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);
502 503
			break;
		case IWL_UCODE_TLV_INIT_DATA:
504 505 506 507 508 509 510
			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);
511 512
			break;
		case IWL_UCODE_TLV_BOOT:
J
Johannes Berg 已提交
513
			IWL_ERR(drv, "Found unexpected BOOT ucode\n");
514 515 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
			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 已提交
581
			drv->fw.enhance_sensitivity_table = true;
582 583
			break;
		case IWL_UCODE_TLV_WOWLAN_INST:
584 585 586 587 588 589 590
			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);
591 592
			break;
		case IWL_UCODE_TLV_WOWLAN_DATA:
593 594 595 596 597 598 599
			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);
600 601 602 603 604 605 606
			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;
607 608 609
		 case IWL_UCODE_TLV_SEC_RT:
			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_REGULAR,
					    tlv_len);
610
			drv->fw.mvm_fw = true;
611 612 613 614
			break;
		case IWL_UCODE_TLV_SEC_INIT:
			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_INIT,
					    tlv_len);
615
			drv->fw.mvm_fw = true;
616 617 618 619
			break;
		case IWL_UCODE_TLV_SEC_WOWLAN:
			iwl_store_ucode_sec(pieces, tlv_data, IWL_UCODE_WOWLAN,
					    tlv_len);
620
			drv->fw.mvm_fw = true;
621 622 623 624 625 626 627 628 629 630 631 632
			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;
633
		default:
J
Johannes Berg 已提交
634
			IWL_DEBUG_INFO(drv, "unknown TLV: %d\n", tlv_type);
635 636 637 638 639
			break;
		}
	}

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

	return 0;

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

	return -EINVAL;
}

D
David Spinadel 已提交
655 656 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
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;
}


720 721 722 723 724 725 726 727
/**
 * 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 已提交
728 729 730
	struct iwl_drv *drv = context;
	const struct iwl_cfg *cfg = cfg(drv);
	struct iwl_fw *fw = &drv->fw;
731 732
	struct iwl_ucode_header *ucode;
	int err;
733
	struct iwl_firmware_pieces pieces;
734 735 736 737
	const unsigned int api_max = cfg->ucode_api_max;
	unsigned int api_ok = cfg->ucode_api_ok;
	const unsigned int api_min = cfg->ucode_api_min;
	u32 api_ver;
D
David Spinadel 已提交
738
	int i;
739 740 741 742 743 744 745 746 747 748 749

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

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

	/* Make sure that we got at least the API version number */
	if (ucode_raw->size < 4) {
J
Johannes Berg 已提交
762
		IWL_ERR(drv, "File size way too small!\n");
763 764 765 766 767 768 769
		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 已提交
770
		err = iwl_parse_v1_v2_firmware(drv, ucode_raw, &pieces);
771
	else
J
Johannes Berg 已提交
772
		err = iwl_parse_tlv_firmware(drv, ucode_raw, &pieces,
773 774 775 776 777
					   &fw->ucode_capa);

	if (err)
		goto try_again;

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

	/*
	 * 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 已提交
786
	if (drv->fw_index != UCODE_EXPERIMENTAL_INDEX) {
787
		if (api_ver < api_min || api_ver > api_max) {
J
Johannes Berg 已提交
788
			IWL_ERR(drv,
789 790 791 792 793 794 795 796
				"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 已提交
797
				IWL_ERR(drv, "Firmware has old API version, "
798 799 800
					"expected v%u through v%u, got v%u.\n",
					api_ok, api_max, api_ver);
			else
J
Johannes Berg 已提交
801
				IWL_ERR(drv, "Firmware has old API version, "
802 803
					"expected v%u, got v%u.\n",
					api_max, api_ver);
J
Johannes Berg 已提交
804
			IWL_ERR(drv, "New firmware can be obtained from "
805 806 807 808
				      "http://www.intellinuxwireless.org/.\n");
		}
	}

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

811 812 813 814 815
	/*
	 * In mvm uCode there is no difference between data and instructions
	 * sections.
	 */
	if (!fw->mvm_fw && validate_sec_sizes(drv, &pieces, cfg))
816 817 818 819 820 821 822
		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 已提交
823 824
	for (i = 0; i < IWL_UCODE_TYPE_MAX; i++)
		if (alloc_pci_desc(drv, &pieces, i))
825 826 827 828 829 830 831 832 833
			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.
	 */
834
	fw->init_evtlog_ptr = pieces.init_evtlog_ptr;
835
	if (pieces.init_evtlog_size)
836
		fw->init_evtlog_size = (pieces.init_evtlog_size - 16)/12;
837
	else
838
		fw->init_evtlog_size =
839
			cfg->base_params->max_event_log_size;
840 841
	fw->init_errlog_ptr = pieces.init_errlog_ptr;
	fw->inst_evtlog_ptr = pieces.inst_evtlog_ptr;
842
	if (pieces.inst_evtlog_size)
843
		fw->inst_evtlog_size = (pieces.inst_evtlog_size - 16)/12;
844
	else
845
		fw->inst_evtlog_size =
846
			cfg->base_params->max_event_log_size;
847
	fw->inst_errlog_ptr = pieces.inst_errlog_ptr;
848 849 850 851 852 853 854 855 856 857 858 859

	/*
	 * 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 已提交
860
	complete(&drv->request_firmware_complete);
861

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

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

	return;

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

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

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

	shrd->cfg = cfg;

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