core.c 29.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
/*
 * Copyright (c) 2005-2011 Atheros Communications Inc.
 * Copyright (c) 2011-2013 Qualcomm Atheros, Inc.
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include <linux/module.h>
#include <linux/firmware.h>

#include "core.h"
#include "mac.h"
#include "htc.h"
#include "hif.h"
#include "wmi.h"
#include "bmi.h"
#include "debug.h"
#include "htt.h"
K
Kalle Valo 已提交
29
#include "testmode.h"
30 31 32 33

unsigned int ath10k_debug_mask;
static bool uart_print;
static unsigned int ath10k_p2p;
34 35
static bool skip_otp;

36 37 38
module_param_named(debug_mask, ath10k_debug_mask, uint, 0644);
module_param(uart_print, bool, 0644);
module_param_named(p2p, ath10k_p2p, uint, 0644);
39 40
module_param(skip_otp, bool, 0644);

41 42 43
MODULE_PARM_DESC(debug_mask, "Debugging mask");
MODULE_PARM_DESC(uart_print, "Uart target debugging");
MODULE_PARM_DESC(p2p, "Enable ath10k P2P support");
44
MODULE_PARM_DESC(skip_otp, "Skip otp failure for calibration in testmode");
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

static const struct ath10k_hw_params ath10k_hw_params_list[] = {
	{
		.id = QCA988X_HW_2_0_VERSION,
		.name = "qca988x hw2.0",
		.patch_load_addr = QCA988X_HW_2_0_PATCH_LOAD_ADDR,
		.fw = {
			.dir = QCA988X_HW_2_0_FW_DIR,
			.fw = QCA988X_HW_2_0_FW_FILE,
			.otp = QCA988X_HW_2_0_OTP_FILE,
			.board = QCA988X_HW_2_0_BOARD_DATA_FILE,
		},
	},
};

static void ath10k_send_suspend_complete(struct ath10k *ar)
{
62
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot suspend complete\n");
63

64
	complete(&ar->target_suspend);
65 66 67 68 69 70 71 72 73 74 75
}

static int ath10k_init_configure_target(struct ath10k *ar)
{
	u32 param_host;
	int ret;

	/* tell target which HTC version it is used*/
	ret = ath10k_bmi_write32(ar, hi_app_host_interest,
				 HTC_PROTOCOL_VERSION);
	if (ret) {
76
		ath10k_err(ar, "settings HTC version failed\n");
77 78 79 80 81 82
		return ret;
	}

	/* set the firmware mode to STA/IBSS/AP */
	ret = ath10k_bmi_read32(ar, hi_option_flag, &param_host);
	if (ret) {
83
		ath10k_err(ar, "setting firmware mode (1/2) failed\n");
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
		return ret;
	}

	/* TODO following parameters need to be re-visited. */
	/* num_device */
	param_host |= (1 << HI_OPTION_NUM_DEV_SHIFT);
	/* Firmware mode */
	/* FIXME: Why FW_MODE_AP ??.*/
	param_host |= (HI_OPTION_FW_MODE_AP << HI_OPTION_FW_MODE_SHIFT);
	/* mac_addr_method */
	param_host |= (1 << HI_OPTION_MAC_ADDR_METHOD_SHIFT);
	/* firmware_bridge */
	param_host |= (0 << HI_OPTION_FW_BRIDGE_SHIFT);
	/* fwsubmode */
	param_host |= (0 << HI_OPTION_FW_SUBMODE_SHIFT);

	ret = ath10k_bmi_write32(ar, hi_option_flag, param_host);
	if (ret) {
102
		ath10k_err(ar, "setting firmware mode (2/2) failed\n");
103 104 105 106 107 108
		return ret;
	}

	/* We do all byte-swapping on the host */
	ret = ath10k_bmi_write32(ar, hi_be, 0);
	if (ret) {
109
		ath10k_err(ar, "setting host CPU BE mode failed\n");
110 111 112 113 114 115 116
		return ret;
	}

	/* FW descriptor/Data swap flags */
	ret = ath10k_bmi_write32(ar, hi_fw_swap, 0);

	if (ret) {
117
		ath10k_err(ar, "setting FW data/desc swap flags failed\n");
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
		return ret;
	}

	return 0;
}

static const struct firmware *ath10k_fetch_fw_file(struct ath10k *ar,
						   const char *dir,
						   const char *file)
{
	char filename[100];
	const struct firmware *fw;
	int ret;

	if (file == NULL)
		return ERR_PTR(-ENOENT);

	if (dir == NULL)
		dir = ".";

	snprintf(filename, sizeof(filename), "%s/%s", dir, file);
	ret = request_firmware(&fw, filename, ar->dev);
	if (ret)
		return ERR_PTR(ret);

	return fw;
}

146 147
static int ath10k_push_board_ext_data(struct ath10k *ar, const void *data,
				      size_t data_len)
148 149 150 151 152 153 154 155
{
	u32 board_data_size = QCA988X_BOARD_DATA_SZ;
	u32 board_ext_data_size = QCA988X_BOARD_EXT_DATA_SZ;
	u32 board_ext_data_addr;
	int ret;

	ret = ath10k_bmi_read32(ar, hi_board_ext_data, &board_ext_data_addr);
	if (ret) {
156 157
		ath10k_err(ar, "could not read board ext data addr (%d)\n",
			   ret);
158 159 160
		return ret;
	}

161
	ath10k_dbg(ar, ATH10K_DBG_BOOT,
162
		   "boot push board extended data addr 0x%x\n",
163 164 165 166 167
		   board_ext_data_addr);

	if (board_ext_data_addr == 0)
		return 0;

168
	if (data_len != (board_data_size + board_ext_data_size)) {
169
		ath10k_err(ar, "invalid board (ext) data sizes %zu != %d+%d\n",
170
			   data_len, board_data_size, board_ext_data_size);
171 172 173 174
		return -EINVAL;
	}

	ret = ath10k_bmi_write_memory(ar, board_ext_data_addr,
175
				      data + board_data_size,
176 177
				      board_ext_data_size);
	if (ret) {
178
		ath10k_err(ar, "could not write board ext data (%d)\n", ret);
179 180 181 182 183 184
		return ret;
	}

	ret = ath10k_bmi_write32(ar, hi_board_ext_data_config,
				 (board_ext_data_size << 16) | 1);
	if (ret) {
185 186
		ath10k_err(ar, "could not write board ext data bit (%d)\n",
			   ret);
187 188 189 190 191 192
		return ret;
	}

	return 0;
}

193 194
static int ath10k_download_board_data(struct ath10k *ar, const void *data,
				      size_t data_len)
195 196 197 198 199
{
	u32 board_data_size = QCA988X_BOARD_DATA_SZ;
	u32 address;
	int ret;

200
	ret = ath10k_push_board_ext_data(ar, data, data_len);
201
	if (ret) {
202
		ath10k_err(ar, "could not push board ext data (%d)\n", ret);
203 204 205 206 207
		goto exit;
	}

	ret = ath10k_bmi_read32(ar, hi_board_data, &address);
	if (ret) {
208
		ath10k_err(ar, "could not read board data addr (%d)\n", ret);
209 210 211
		goto exit;
	}

212
	ret = ath10k_bmi_write_memory(ar, address, data,
213
				      min_t(u32, board_data_size,
214
					    data_len));
215
	if (ret) {
216
		ath10k_err(ar, "could not write board data (%d)\n", ret);
217 218 219 220 221
		goto exit;
	}

	ret = ath10k_bmi_write32(ar, hi_board_data_initialized, 1);
	if (ret) {
222
		ath10k_err(ar, "could not write board data bit (%d)\n", ret);
223 224 225 226 227 228 229
		goto exit;
	}

exit:
	return ret;
}

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
static int ath10k_download_cal_file(struct ath10k *ar)
{
	int ret;

	if (!ar->cal_file)
		return -ENOENT;

	if (IS_ERR(ar->cal_file))
		return PTR_ERR(ar->cal_file);

	ret = ath10k_download_board_data(ar, ar->cal_file->data,
					 ar->cal_file->size);
	if (ret) {
		ath10k_err(ar, "failed to download cal_file data: %d\n", ret);
		return ret;
	}

	ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot cal file downloaded\n");

	return 0;
}

252 253
static int ath10k_download_and_run_otp(struct ath10k *ar)
{
254
	u32 result, address = ar->hw_params.patch_load_addr;
255 256
	int ret;

257
	ret = ath10k_download_board_data(ar, ar->board_data, ar->board_len);
258 259 260 261 262
	if (ret) {
		ath10k_err(ar, "failed to download board data: %d\n", ret);
		return ret;
	}

263 264
	/* OTP is optional */

K
Kalle Valo 已提交
265
	if (!ar->otp_data || !ar->otp_len) {
266
		ath10k_warn(ar, "Not running otp, calibration will be incorrect (otp-data %p otp_len %zd)!\n",
267
			    ar->otp_data, ar->otp_len);
268
		return 0;
K
Kalle Valo 已提交
269 270
	}

271
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot upload otp to 0x%x len %zd\n",
K
Kalle Valo 已提交
272
		   address, ar->otp_len);
273

274
	ret = ath10k_bmi_fast_download(ar, address, ar->otp_data, ar->otp_len);
275
	if (ret) {
276
		ath10k_err(ar, "could not write otp (%d)\n", ret);
K
Kalle Valo 已提交
277
		return ret;
278 279
	}

280
	ret = ath10k_bmi_execute(ar, address, 0, &result);
281
	if (ret) {
282
		ath10k_err(ar, "could not execute otp (%d)\n", ret);
K
Kalle Valo 已提交
283
		return ret;
284 285
	}

286
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot otp execute result %d\n", result);
K
Kalle Valo 已提交
287

288
	if (!skip_otp && result != 0) {
289
		ath10k_err(ar, "otp calibration failed: %d", result);
K
Kalle Valo 已提交
290 291 292 293
		return -EINVAL;
	}

	return 0;
294 295
}

K
Kalle Valo 已提交
296
static int ath10k_download_fw(struct ath10k *ar, enum ath10k_firmware_mode mode)
297
{
K
Kalle Valo 已提交
298 299 300
	u32 address, data_len;
	const char *mode_name;
	const void *data;
301 302 303 304
	int ret;

	address = ar->hw_params.patch_load_addr;

K
Kalle Valo 已提交
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
	switch (mode) {
	case ATH10K_FIRMWARE_MODE_NORMAL:
		data = ar->firmware_data;
		data_len = ar->firmware_len;
		mode_name = "normal";
		break;
	case ATH10K_FIRMWARE_MODE_UTF:
		data = ar->testmode.utf->data;
		data_len = ar->testmode.utf->size;
		mode_name = "utf";
		break;
	default:
		ath10k_err(ar, "unknown firmware mode: %d\n", mode);
		return -EINVAL;
	}

	ath10k_dbg(ar, ATH10K_DBG_BOOT,
		   "boot uploading firmware image %p len %d mode %s\n",
		   data, data_len, mode_name);

	ret = ath10k_bmi_fast_download(ar, address, data, data_len);
326
	if (ret) {
K
Kalle Valo 已提交
327 328 329
		ath10k_err(ar, "failed to download %s firmware: %d\n",
			   mode_name, ret);
		return ret;
330 331
	}

332 333 334 335 336
	return ret;
}

static void ath10k_core_free_firmware_files(struct ath10k *ar)
{
337 338
	if (ar->board && !IS_ERR(ar->board))
		release_firmware(ar->board);
339 340 341 342 343 344 345

	if (ar->otp && !IS_ERR(ar->otp))
		release_firmware(ar->otp);

	if (ar->firmware && !IS_ERR(ar->firmware))
		release_firmware(ar->firmware);

346 347 348
	if (ar->cal_file && !IS_ERR(ar->cal_file))
		release_firmware(ar->cal_file);

349
	ar->board = NULL;
350 351 352
	ar->board_data = NULL;
	ar->board_len = 0;

353
	ar->otp = NULL;
354 355 356
	ar->otp_data = NULL;
	ar->otp_len = 0;

357
	ar->firmware = NULL;
358 359
	ar->firmware_data = NULL;
	ar->firmware_len = 0;
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380

	ar->cal_file = NULL;
}

static int ath10k_fetch_cal_file(struct ath10k *ar)
{
	char filename[100];

	/* cal-<bus>-<id>.bin */
	scnprintf(filename, sizeof(filename), "cal-%s-%s.bin",
		  ath10k_bus_str(ar->hif.bus), dev_name(ar->dev));

	ar->cal_file = ath10k_fetch_fw_file(ar, ATH10K_FW_DIR, filename);
	if (IS_ERR(ar->cal_file))
		/* calibration file is optional, don't print any warnings */
		return PTR_ERR(ar->cal_file);

	ath10k_dbg(ar, ATH10K_DBG_BOOT, "found calibration file %s/%s\n",
		   ATH10K_FW_DIR, filename);

	return 0;
381 382
}

383
static int ath10k_core_fetch_firmware_api_1(struct ath10k *ar)
384 385 386 387
{
	int ret = 0;

	if (ar->hw_params.fw.fw == NULL) {
388
		ath10k_err(ar, "firmware file not defined\n");
389 390 391 392
		return -EINVAL;
	}

	if (ar->hw_params.fw.board == NULL) {
393
		ath10k_err(ar, "board data file not defined");
394 395 396
		return -EINVAL;
	}

397 398 399 400 401
	ar->board = ath10k_fetch_fw_file(ar,
					 ar->hw_params.fw.dir,
					 ar->hw_params.fw.board);
	if (IS_ERR(ar->board)) {
		ret = PTR_ERR(ar->board);
402
		ath10k_err(ar, "could not fetch board data (%d)\n", ret);
403 404 405
		goto err;
	}

406 407 408
	ar->board_data = ar->board->data;
	ar->board_len = ar->board->size;

409 410 411 412 413
	ar->firmware = ath10k_fetch_fw_file(ar,
					    ar->hw_params.fw.dir,
					    ar->hw_params.fw.fw);
	if (IS_ERR(ar->firmware)) {
		ret = PTR_ERR(ar->firmware);
414
		ath10k_err(ar, "could not fetch firmware (%d)\n", ret);
415 416 417
		goto err;
	}

418 419 420
	ar->firmware_data = ar->firmware->data;
	ar->firmware_len = ar->firmware->size;

421 422 423 424 425 426 427 428 429
	/* OTP may be undefined. If so, don't fetch it at all */
	if (ar->hw_params.fw.otp == NULL)
		return 0;

	ar->otp = ath10k_fetch_fw_file(ar,
				       ar->hw_params.fw.dir,
				       ar->hw_params.fw.otp);
	if (IS_ERR(ar->otp)) {
		ret = PTR_ERR(ar->otp);
430
		ath10k_err(ar, "could not fetch otp (%d)\n", ret);
431 432 433
		goto err;
	}

434 435 436
	ar->otp_data = ar->otp->data;
	ar->otp_len = ar->otp->size;

437 438 439 440
	return 0;

err:
	ath10k_core_free_firmware_files(ar);
441 442 443
	return ret;
}

444 445 446 447 448 449 450 451 452 453 454
static int ath10k_core_fetch_firmware_api_n(struct ath10k *ar, const char *name)
{
	size_t magic_len, len, ie_len;
	int ie_id, i, index, bit, ret;
	struct ath10k_fw_ie *hdr;
	const u8 *data;
	__le32 *timestamp;

	/* first fetch the firmware file (firmware-*.bin) */
	ar->firmware = ath10k_fetch_fw_file(ar, ar->hw_params.fw.dir, name);
	if (IS_ERR(ar->firmware)) {
455
		ath10k_err(ar, "could not fetch firmware file '%s/%s': %ld\n",
456
			   ar->hw_params.fw.dir, name, PTR_ERR(ar->firmware));
457 458 459 460 461 462 463 464 465 466
		return PTR_ERR(ar->firmware);
	}

	data = ar->firmware->data;
	len = ar->firmware->size;

	/* magic also includes the null byte, check that as well */
	magic_len = strlen(ATH10K_FIRMWARE_MAGIC) + 1;

	if (len < magic_len) {
467
		ath10k_err(ar, "firmware file '%s/%s' too small to contain magic: %zu\n",
468
			   ar->hw_params.fw.dir, name, len);
469 470
		ret = -EINVAL;
		goto err;
471 472 473
	}

	if (memcmp(data, ATH10K_FIRMWARE_MAGIC, magic_len) != 0) {
474
		ath10k_err(ar, "invalid firmware magic\n");
475 476
		ret = -EINVAL;
		goto err;
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
	}

	/* jump over the padding */
	magic_len = ALIGN(magic_len, 4);

	len -= magic_len;
	data += magic_len;

	/* loop elements */
	while (len > sizeof(struct ath10k_fw_ie)) {
		hdr = (struct ath10k_fw_ie *)data;

		ie_id = le32_to_cpu(hdr->id);
		ie_len = le32_to_cpu(hdr->len);

		len -= sizeof(*hdr);
		data += sizeof(*hdr);

		if (len < ie_len) {
496
			ath10k_err(ar, "invalid length for FW IE %d (%zu < %zu)\n",
497
				   ie_id, len, ie_len);
498 499
			ret = -EINVAL;
			goto err;
500 501 502 503 504 505 506 507 508 509
		}

		switch (ie_id) {
		case ATH10K_FW_IE_FW_VERSION:
			if (ie_len > sizeof(ar->hw->wiphy->fw_version) - 1)
				break;

			memcpy(ar->hw->wiphy->fw_version, data, ie_len);
			ar->hw->wiphy->fw_version[ie_len] = '\0';

510
			ath10k_dbg(ar, ATH10K_DBG_BOOT,
511 512 513 514 515 516 517 518 519
				   "found fw version %s\n",
				    ar->hw->wiphy->fw_version);
			break;
		case ATH10K_FW_IE_TIMESTAMP:
			if (ie_len != sizeof(u32))
				break;

			timestamp = (__le32 *)data;

520
			ath10k_dbg(ar, ATH10K_DBG_BOOT, "found fw timestamp %d\n",
521 522 523
				   le32_to_cpup(timestamp));
			break;
		case ATH10K_FW_IE_FEATURES:
524
			ath10k_dbg(ar, ATH10K_DBG_BOOT,
525 526 527 528 529 530 531 532 533 534
				   "found firmware features ie (%zd B)\n",
				   ie_len);

			for (i = 0; i < ATH10K_FW_FEATURE_COUNT; i++) {
				index = i / 8;
				bit = i % 8;

				if (index == ie_len)
					break;

535
				if (data[index] & (1 << bit)) {
536
					ath10k_dbg(ar, ATH10K_DBG_BOOT,
537 538
						   "Enabling feature bit: %i\n",
						   i);
539
					__set_bit(i, ar->fw_features);
540
				}
541 542
			}

543
			ath10k_dbg_dump(ar, ATH10K_DBG_BOOT, "features", "",
544 545 546 547
					ar->fw_features,
					sizeof(ar->fw_features));
			break;
		case ATH10K_FW_IE_FW_IMAGE:
548
			ath10k_dbg(ar, ATH10K_DBG_BOOT,
549 550 551 552 553 554 555 556
				   "found fw image ie (%zd B)\n",
				   ie_len);

			ar->firmware_data = data;
			ar->firmware_len = ie_len;

			break;
		case ATH10K_FW_IE_OTP_IMAGE:
557
			ath10k_dbg(ar, ATH10K_DBG_BOOT,
558 559 560 561 562 563 564 565
				   "found otp image ie (%zd B)\n",
				   ie_len);

			ar->otp_data = data;
			ar->otp_len = ie_len;

			break;
		default:
566
			ath10k_warn(ar, "Unknown FW IE: %u\n",
567 568 569 570 571 572 573 574 575
				    le32_to_cpu(hdr->id));
			break;
		}

		/* jump over the padding */
		ie_len = ALIGN(ie_len, 4);

		len -= ie_len;
		data += ie_len;
576
	}
577 578

	if (!ar->firmware_data || !ar->firmware_len) {
579
		ath10k_warn(ar, "No ATH10K_FW_IE_FW_IMAGE found from '%s/%s', skipping\n",
580
			    ar->hw_params.fw.dir, name);
581 582 583 584
		ret = -ENOMEDIUM;
		goto err;
	}

585 586
	if (test_bit(ATH10K_FW_FEATURE_WMI_10_2, ar->fw_features) &&
	    !test_bit(ATH10K_FW_FEATURE_WMI_10X, ar->fw_features)) {
587
		ath10k_err(ar, "feature bits corrupted: 10.2 feature requires 10.x feature to be set as well");
588 589 590 591
		ret = -EINVAL;
		goto err;
	}

592 593
	/* now fetch the board file */
	if (ar->hw_params.fw.board == NULL) {
594
		ath10k_err(ar, "board data file not defined");
595 596 597 598 599 600 601 602 603
		ret = -EINVAL;
		goto err;
	}

	ar->board = ath10k_fetch_fw_file(ar,
					 ar->hw_params.fw.dir,
					 ar->hw_params.fw.board);
	if (IS_ERR(ar->board)) {
		ret = PTR_ERR(ar->board);
604
		ath10k_err(ar, "could not fetch board data '%s/%s' (%d)\n",
605 606
			   ar->hw_params.fw.dir, ar->hw_params.fw.board,
			   ret);
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
		goto err;
	}

	ar->board_data = ar->board->data;
	ar->board_len = ar->board->size;

	return 0;

err:
	ath10k_core_free_firmware_files(ar);
	return ret;
}

static int ath10k_core_fetch_firmware_files(struct ath10k *ar)
{
	int ret;

624 625 626
	/* calibration file is optional, don't check for any errors */
	ath10k_fetch_cal_file(ar);

627
	ar->fw_api = 3;
628
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
629 630 631 632 633

	ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API3_FILE);
	if (ret == 0)
		goto success;

634
	ar->fw_api = 2;
635
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
636

637
	ret = ath10k_core_fetch_firmware_api_n(ar, ATH10K_FW_API2_FILE);
638 639 640 641
	if (ret == 0)
		goto success;

	ar->fw_api = 1;
642
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "trying fw api %d\n", ar->fw_api);
643 644 645 646 647

	ret = ath10k_core_fetch_firmware_api_1(ar);
	if (ret)
		return ret;

648
success:
649
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "using fw api %d\n", ar->fw_api);
650 651 652 653

	return 0;
}

654
static int ath10k_download_cal_data(struct ath10k *ar)
655 656 657
{
	int ret;

658 659 660 661 662 663 664 665 666 667
	ret = ath10k_download_cal_file(ar);
	if (ret == 0) {
		ar->cal_mode = ATH10K_CAL_MODE_FILE;
		goto done;
	}

	ath10k_dbg(ar, ATH10K_DBG_BOOT,
		   "boot did not find a calibration file, try OTP next: %d\n",
		   ret);

668
	ret = ath10k_download_and_run_otp(ar);
669
	if (ret) {
670
		ath10k_err(ar, "failed to run otp: %d\n", ret);
671
		return ret;
672
	}
673

674 675 676 677 678 679
	ar->cal_mode = ATH10K_CAL_MODE_OTP;

done:
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot using calibration mode %s\n",
		   ath10k_cal_mode_str(ar->cal_mode));
	return 0;
680 681 682 683 684 685 686 687 688 689 690 691
}

static int ath10k_init_uart(struct ath10k *ar)
{
	int ret;

	/*
	 * Explicitly setting UART prints to zero as target turns it on
	 * based on scratch registers.
	 */
	ret = ath10k_bmi_write32(ar, hi_serial_enable, 0);
	if (ret) {
692
		ath10k_warn(ar, "could not disable UART prints (%d)\n", ret);
693 694 695
		return ret;
	}

696
	if (!uart_print)
697 698 699 700
		return 0;

	ret = ath10k_bmi_write32(ar, hi_dbg_uart_txpin, 7);
	if (ret) {
701
		ath10k_warn(ar, "could not enable UART prints (%d)\n", ret);
702 703 704 705 706
		return ret;
	}

	ret = ath10k_bmi_write32(ar, hi_serial_enable, 1);
	if (ret) {
707
		ath10k_warn(ar, "could not enable UART prints (%d)\n", ret);
708 709 710
		return ret;
	}

711 712 713
	/* Set the UART baud rate to 19200. */
	ret = ath10k_bmi_write32(ar, hi_desired_baud_rate, 19200);
	if (ret) {
714
		ath10k_warn(ar, "could not set the baud rate (%d)\n", ret);
715 716 717
		return ret;
	}

718
	ath10k_info(ar, "UART prints enabled\n");
719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
	return 0;
}

static int ath10k_init_hw_params(struct ath10k *ar)
{
	const struct ath10k_hw_params *uninitialized_var(hw_params);
	int i;

	for (i = 0; i < ARRAY_SIZE(ath10k_hw_params_list); i++) {
		hw_params = &ath10k_hw_params_list[i];

		if (hw_params->id == ar->target_version)
			break;
	}

	if (i == ARRAY_SIZE(ath10k_hw_params_list)) {
735
		ath10k_err(ar, "Unsupported hardware version: 0x%x\n",
736 737 738 739 740 741
			   ar->target_version);
		return -EINVAL;
	}

	ar->hw_params = *hw_params;

742
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "Hardware name %s version 0x%x\n",
743
		   ar->hw_params.name, ar->target_version);
744 745 746 747

	return 0;
}

748 749 750 751
static void ath10k_core_restart(struct work_struct *work)
{
	struct ath10k *ar = container_of(work, struct ath10k, restart_work);

M
Michal Kazior 已提交
752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
	set_bit(ATH10K_FLAG_CRASH_FLUSH, &ar->dev_flags);

	/* Place a barrier to make sure the compiler doesn't reorder
	 * CRASH_FLUSH and calling other functions.
	 */
	barrier();

	ieee80211_stop_queues(ar->hw);
	ath10k_drain_tx(ar);
	complete_all(&ar->scan.started);
	complete_all(&ar->scan.completed);
	complete_all(&ar->scan.on_channel);
	complete_all(&ar->offchan_tx_completed);
	complete_all(&ar->install_key_done);
	complete_all(&ar->vdev_setup_done);
	wake_up(&ar->htt.empty_tx_wq);
	wake_up(&ar->wmi.tx_credits_wq);
	wake_up(&ar->peer_mapping_wq);

771 772 773 774 775
	mutex_lock(&ar->conf_mutex);

	switch (ar->state) {
	case ATH10K_STATE_ON:
		ar->state = ATH10K_STATE_RESTARTING;
776
		ath10k_hif_stop(ar);
777
		ath10k_scan_finish(ar);
778 779 780
		ieee80211_restart_hw(ar->hw);
		break;
	case ATH10K_STATE_OFF:
781 782
		/* this can happen if driver is being unloaded
		 * or if the crash happens during FW probing */
783
		ath10k_warn(ar, "cannot restart a device that hasn't been started\n");
784 785
		break;
	case ATH10K_STATE_RESTARTING:
786 787
		/* hw restart might be requested from multiple places */
		break;
788 789 790 791
	case ATH10K_STATE_RESTARTED:
		ar->state = ATH10K_STATE_WEDGED;
		/* fall through */
	case ATH10K_STATE_WEDGED:
792
		ath10k_warn(ar, "device is wedged, will not restart\n");
793
		break;
K
Kalle Valo 已提交
794 795 796
	case ATH10K_STATE_UTF:
		ath10k_warn(ar, "firmware restart in UTF mode not supported\n");
		break;
797 798 799 800 801
	}

	mutex_unlock(&ar->conf_mutex);
}

802 803 804 805 806 807 808 809 810 811 812
static void ath10k_core_init_max_sta_count(struct ath10k *ar)
{
	if (test_bit(ATH10K_FW_FEATURE_WMI_10X, ar->fw_features)) {
		ar->max_num_peers = TARGET_10X_NUM_PEERS;
		ar->max_num_stations = TARGET_10X_NUM_STATIONS;
	} else {
		ar->max_num_peers = TARGET_NUM_PEERS;
		ar->max_num_stations = TARGET_NUM_STATIONS;
	}
}

K
Kalle Valo 已提交
813
int ath10k_core_start(struct ath10k *ar, enum ath10k_firmware_mode mode)
814 815 816
{
	int status;

817 818
	lockdep_assert_held(&ar->conf_mutex);

M
Michal Kazior 已提交
819 820
	clear_bit(ATH10K_FLAG_CRASH_FLUSH, &ar->dev_flags);

821 822
	ath10k_bmi_start(ar);

823 824 825 826 827
	if (ath10k_init_configure_target(ar)) {
		status = -EINVAL;
		goto err;
	}

828 829 830 831 832
	status = ath10k_download_cal_data(ar);
	if (status)
		goto err;

	status = ath10k_download_fw(ar, mode);
833 834 835 836 837 838 839
	if (status)
		goto err;

	status = ath10k_init_uart(ar);
	if (status)
		goto err;

840 841
	ar->htc.htc_ops.target_send_suspend_complete =
		ath10k_send_suspend_complete;
842

843 844
	status = ath10k_htc_init(ar);
	if (status) {
845
		ath10k_err(ar, "could not init HTC (%d)\n", status);
846 847 848 849 850
		goto err;
	}

	status = ath10k_bmi_done(ar);
	if (status)
851
		goto err;
852 853 854

	status = ath10k_wmi_attach(ar);
	if (status) {
855
		ath10k_err(ar, "WMI attach failed: %d\n", status);
856
		goto err;
857 858
	}

M
Michal Kazior 已提交
859 860
	status = ath10k_htt_init(ar);
	if (status) {
861
		ath10k_err(ar, "failed to init htt: %d\n", status);
M
Michal Kazior 已提交
862 863 864 865 866
		goto err_wmi_detach;
	}

	status = ath10k_htt_tx_alloc(&ar->htt);
	if (status) {
867
		ath10k_err(ar, "failed to alloc htt tx: %d\n", status);
M
Michal Kazior 已提交
868 869 870 871 872
		goto err_wmi_detach;
	}

	status = ath10k_htt_rx_alloc(&ar->htt);
	if (status) {
873
		ath10k_err(ar, "failed to alloc htt rx: %d\n", status);
M
Michal Kazior 已提交
874 875 876
		goto err_htt_tx_detach;
	}

M
Michal Kazior 已提交
877 878
	status = ath10k_hif_start(ar);
	if (status) {
879
		ath10k_err(ar, "could not start HIF: %d\n", status);
M
Michal Kazior 已提交
880
		goto err_htt_rx_detach;
M
Michal Kazior 已提交
881 882 883 884
	}

	status = ath10k_htc_wait_target(&ar->htc);
	if (status) {
885
		ath10k_err(ar, "failed to connect to HTC: %d\n", status);
M
Michal Kazior 已提交
886 887
		goto err_hif_stop;
	}
888

K
Kalle Valo 已提交
889 890 891 892 893 894
	if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
		status = ath10k_htt_connect(&ar->htt);
		if (status) {
			ath10k_err(ar, "failed to connect htt (%d)\n", status);
			goto err_hif_stop;
		}
895 896
	}

M
Michal Kazior 已提交
897 898
	status = ath10k_wmi_connect(ar);
	if (status) {
899
		ath10k_err(ar, "could not connect wmi: %d\n", status);
M
Michal Kazior 已提交
900 901 902 903 904
		goto err_hif_stop;
	}

	status = ath10k_htc_start(&ar->htc);
	if (status) {
905
		ath10k_err(ar, "failed to start htc: %d\n", status);
M
Michal Kazior 已提交
906 907 908
		goto err_hif_stop;
	}

K
Kalle Valo 已提交
909 910 911 912 913 914 915
	if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
		status = ath10k_wmi_wait_for_service_ready(ar);
		if (status <= 0) {
			ath10k_warn(ar, "wmi service ready event not received");
			status = -ETIMEDOUT;
			goto err_hif_stop;
		}
M
Michal Kazior 已提交
916
	}
917

918
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "firmware %s booted\n",
919
		   ar->hw->wiphy->fw_version);
920 921 922

	status = ath10k_wmi_cmd_init(ar);
	if (status) {
923 924
		ath10k_err(ar, "could not send WMI init command (%d)\n",
			   status);
M
Michal Kazior 已提交
925
		goto err_hif_stop;
926 927 928 929
	}

	status = ath10k_wmi_wait_for_unified_ready(ar);
	if (status <= 0) {
930
		ath10k_err(ar, "wmi unified ready event not received\n");
931
		status = -ETIMEDOUT;
M
Michal Kazior 已提交
932
		goto err_hif_stop;
933 934
	}

K
Kalle Valo 已提交
935 936 937 938 939 940 941
	/* we don't care about HTT in UTF mode */
	if (mode == ATH10K_FIRMWARE_MODE_NORMAL) {
		status = ath10k_htt_setup(&ar->htt);
		if (status) {
			ath10k_err(ar, "failed to setup htt: %d\n", status);
			goto err_hif_stop;
		}
M
Michal Kazior 已提交
942
	}
943

944 945
	status = ath10k_debug_start(ar);
	if (status)
M
Michal Kazior 已提交
946
		goto err_hif_stop;
947

948
	if (test_bit(ATH10K_FW_FEATURE_WMI_10X, ar->fw_features))
B
Ben Greear 已提交
949
		ar->free_vdev_map = (1LL << TARGET_10X_NUM_VDEVS) - 1;
950
	else
B
Ben Greear 已提交
951
		ar->free_vdev_map = (1LL << TARGET_NUM_VDEVS) - 1;
952

M
Michal Kazior 已提交
953
	INIT_LIST_HEAD(&ar->arvifs);
954

955 956
	return 0;

M
Michal Kazior 已提交
957 958
err_hif_stop:
	ath10k_hif_stop(ar);
M
Michal Kazior 已提交
959 960 961 962
err_htt_rx_detach:
	ath10k_htt_rx_free(&ar->htt);
err_htt_tx_detach:
	ath10k_htt_tx_free(&ar->htt);
963 964 965 966 967
err_wmi_detach:
	ath10k_wmi_detach(ar);
err:
	return status;
}
968
EXPORT_SYMBOL(ath10k_core_start);
969

970 971 972 973 974 975 976 977
int ath10k_wait_for_suspend(struct ath10k *ar, u32 suspend_opt)
{
	int ret;

	reinit_completion(&ar->target_suspend);

	ret = ath10k_wmi_pdev_suspend_target(ar, suspend_opt);
	if (ret) {
978
		ath10k_warn(ar, "could not suspend target (%d)\n", ret);
979 980 981 982 983 984
		return ret;
	}

	ret = wait_for_completion_timeout(&ar->target_suspend, 1 * HZ);

	if (ret == 0) {
985
		ath10k_warn(ar, "suspend timed out - target pause event never came\n");
986 987 988 989 990 991
		return -ETIMEDOUT;
	}

	return 0;
}

992 993
void ath10k_core_stop(struct ath10k *ar)
{
994 995
	lockdep_assert_held(&ar->conf_mutex);

996
	/* try to suspend target */
K
Kalle Valo 已提交
997 998
	if (ar->state != ATH10K_STATE_RESTARTING &&
	    ar->state != ATH10K_STATE_UTF)
999 1000
		ath10k_wait_for_suspend(ar, WMI_PDEV_SUSPEND_AND_DISABLE_INTR);

1001
	ath10k_debug_stop(ar);
M
Michal Kazior 已提交
1002 1003 1004
	ath10k_hif_stop(ar);
	ath10k_htt_tx_free(&ar->htt);
	ath10k_htt_rx_free(&ar->htt);
1005 1006
	ath10k_wmi_detach(ar);
}
1007 1008 1009 1010 1011 1012 1013 1014
EXPORT_SYMBOL(ath10k_core_stop);

/* mac80211 manages fw/hw initialization through start/stop hooks. However in
 * order to know what hw capabilities should be advertised to mac80211 it is
 * necessary to load the firmware (and tear it down immediately since start
 * hook will try to init it again) before registering */
static int ath10k_core_probe_fw(struct ath10k *ar)
{
1015 1016
	struct bmi_target_info target_info;
	int ret = 0;
1017 1018 1019

	ret = ath10k_hif_power_up(ar);
	if (ret) {
1020
		ath10k_err(ar, "could not start pci hif (%d)\n", ret);
1021 1022 1023
		return ret;
	}

1024 1025 1026
	memset(&target_info, 0, sizeof(target_info));
	ret = ath10k_bmi_get_target_info(ar, &target_info);
	if (ret) {
1027
		ath10k_err(ar, "could not get target info (%d)\n", ret);
1028 1029 1030 1031 1032 1033 1034 1035 1036
		ath10k_hif_power_down(ar);
		return ret;
	}

	ar->target_version = target_info.version;
	ar->hw->wiphy->hw_version = target_info.version;

	ret = ath10k_init_hw_params(ar);
	if (ret) {
1037
		ath10k_err(ar, "could not get hw params (%d)\n", ret);
1038 1039 1040 1041 1042 1043
		ath10k_hif_power_down(ar);
		return ret;
	}

	ret = ath10k_core_fetch_firmware_files(ar);
	if (ret) {
1044
		ath10k_err(ar, "could not fetch firmware files (%d)\n", ret);
1045 1046 1047 1048
		ath10k_hif_power_down(ar);
		return ret;
	}

1049 1050
	ath10k_core_init_max_sta_count(ar);

1051 1052
	mutex_lock(&ar->conf_mutex);

K
Kalle Valo 已提交
1053
	ret = ath10k_core_start(ar, ATH10K_FIRMWARE_MODE_NORMAL);
1054
	if (ret) {
1055
		ath10k_err(ar, "could not init core (%d)\n", ret);
1056
		ath10k_core_free_firmware_files(ar);
1057
		ath10k_hif_power_down(ar);
1058
		mutex_unlock(&ar->conf_mutex);
1059 1060 1061
		return ret;
	}

M
Michal Kazior 已提交
1062
	ath10k_print_driver_info(ar);
1063
	ath10k_core_stop(ar);
1064 1065 1066

	mutex_unlock(&ar->conf_mutex);

1067 1068 1069
	ath10k_hif_power_down(ar);
	return 0;
}
1070

1071 1072 1073 1074
static int ath10k_core_check_chip_id(struct ath10k *ar)
{
	u32 hw_revision = MS(ar->chip_id, SOC_CHIP_ID_REV);

1075
	ath10k_dbg(ar, ATH10K_DBG_BOOT, "boot chip_id 0x%08x hw_revision 0x%x\n",
1076 1077
		   ar->chip_id, hw_revision);

1078 1079 1080 1081 1082
	/* Check that we are not using hw1.0 (some of them have same pci id
	 * as hw2.0) before doing anything else as ath10k crashes horribly
	 * due to missing hw1.0 workarounds. */
	switch (hw_revision) {
	case QCA988X_HW_1_0_CHIP_ID_REV:
1083
		ath10k_err(ar, "ERROR: qca988x hw1.0 is not supported\n");
1084 1085 1086 1087 1088 1089 1090
		return -EOPNOTSUPP;

	case QCA988X_HW_2_0_CHIP_ID_REV:
		/* known hardware revision, continue normally */
		return 0;

	default:
1091
		ath10k_warn(ar, "Warning: hardware revision unknown (0x%x), expect problems\n",
1092 1093 1094 1095 1096 1097 1098
			    ar->chip_id);
		return 0;
	}

	return 0;
}

1099
static void ath10k_core_register_work(struct work_struct *work)
1100
{
1101
	struct ath10k *ar = container_of(work, struct ath10k, register_work);
1102 1103
	int status;

1104 1105
	status = ath10k_core_probe_fw(ar);
	if (status) {
1106
		ath10k_err(ar, "could not probe fw (%d)\n", status);
1107
		goto err;
1108
	}
1109

1110
	status = ath10k_mac_register(ar);
1111
	if (status) {
1112
		ath10k_err(ar, "could not register to mac80211 (%d)\n", status);
1113
		goto err_release_fw;
1114
	}
1115

1116
	status = ath10k_debug_register(ar);
1117
	if (status) {
1118
		ath10k_err(ar, "unable to initialize debugfs\n");
1119 1120 1121
		goto err_unregister_mac;
	}

1122 1123
	status = ath10k_spectral_create(ar);
	if (status) {
1124
		ath10k_err(ar, "failed to initialize spectral\n");
1125 1126 1127
		goto err_debug_destroy;
	}

1128 1129
	set_bit(ATH10K_FLAG_CORE_REGISTERED, &ar->dev_flags);
	return;
1130

1131 1132
err_debug_destroy:
	ath10k_debug_destroy(ar);
1133 1134
err_unregister_mac:
	ath10k_mac_unregister(ar);
1135 1136
err_release_fw:
	ath10k_core_free_firmware_files(ar);
1137
err:
1138 1139 1140
	/* TODO: It's probably a good idea to release device from the driver
	 * but calling device_release_driver() here will cause a deadlock.
	 */
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
	return;
}

int ath10k_core_register(struct ath10k *ar, u32 chip_id)
{
	int status;

	ar->chip_id = chip_id;

	status = ath10k_core_check_chip_id(ar);
	if (status) {
1152
		ath10k_err(ar, "Unsupported chip id 0x%08x\n", ar->chip_id);
1153 1154 1155 1156 1157 1158
		return status;
	}

	queue_work(ar->workqueue, &ar->register_work);

	return 0;
1159 1160 1161 1162 1163
}
EXPORT_SYMBOL(ath10k_core_register);

void ath10k_core_unregister(struct ath10k *ar)
{
1164 1165 1166 1167 1168
	cancel_work_sync(&ar->register_work);

	if (!test_bit(ATH10K_FLAG_CORE_REGISTERED, &ar->dev_flags))
		return;

1169 1170 1171 1172 1173 1174
	/* Stop spectral before unregistering from mac80211 to remove the
	 * relayfs debugfs file cleanly. Otherwise the parent debugfs tree
	 * would be already be free'd recursively, leading to a double free.
	 */
	ath10k_spectral_destroy(ar);

1175 1176 1177 1178
	/* We must unregister from mac80211 before we stop HTC and HIF.
	 * Otherwise we will fail to submit commands to FW and mac80211 will be
	 * unhappy about callback failures. */
	ath10k_mac_unregister(ar);
1179

K
Kalle Valo 已提交
1180 1181
	ath10k_testmode_destroy(ar);

1182
	ath10k_core_free_firmware_files(ar);
1183

1184
	ath10k_debug_unregister(ar);
1185 1186 1187
}
EXPORT_SYMBOL(ath10k_core_unregister);

M
Michal Kazior 已提交
1188
struct ath10k *ath10k_core_create(size_t priv_size, struct device *dev,
K
Kalle Valo 已提交
1189
				  enum ath10k_bus bus,
1190 1191 1192
				  const struct ath10k_hif_ops *hif_ops)
{
	struct ath10k *ar;
1193
	int ret;
1194

M
Michal Kazior 已提交
1195
	ar = ath10k_mac_create(priv_size);
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
	if (!ar)
		return NULL;

	ar->ath_common.priv = ar;
	ar->ath_common.hw = ar->hw;

	ar->p2p = !!ath10k_p2p;
	ar->dev = dev;

	ar->hif.ops = hif_ops;
K
Kalle Valo 已提交
1206
	ar->hif.bus = bus;
1207 1208 1209 1210 1211 1212 1213 1214 1215

	init_completion(&ar->scan.started);
	init_completion(&ar->scan.completed);
	init_completion(&ar->scan.on_channel);
	init_completion(&ar->target_suspend);

	init_completion(&ar->install_key_done);
	init_completion(&ar->vdev_setup_done);

1216
	INIT_DELAYED_WORK(&ar->scan.timeout, ath10k_scan_timeout_work);
1217 1218 1219

	ar->workqueue = create_singlethread_workqueue("ath10k_wq");
	if (!ar->workqueue)
1220
		goto err_free_mac;
1221 1222 1223 1224 1225 1226

	mutex_init(&ar->conf_mutex);
	spin_lock_init(&ar->data_lock);

	INIT_LIST_HEAD(&ar->peers);
	init_waitqueue_head(&ar->peer_mapping_wq);
M
Michal Kazior 已提交
1227 1228
	init_waitqueue_head(&ar->htt.empty_tx_wq);
	init_waitqueue_head(&ar->wmi.tx_credits_wq);
1229 1230 1231 1232 1233 1234 1235 1236

	init_completion(&ar->offchan_tx_completed);
	INIT_WORK(&ar->offchan_tx_work, ath10k_offchan_tx_work);
	skb_queue_head_init(&ar->offchan_tx_queue);

	INIT_WORK(&ar->wmi_mgmt_tx_work, ath10k_mgmt_over_wmi_tx_work);
	skb_queue_head_init(&ar->wmi_mgmt_tx_queue);

1237
	INIT_WORK(&ar->register_work, ath10k_core_register_work);
1238 1239
	INIT_WORK(&ar->restart_work, ath10k_core_restart);

1240 1241 1242 1243
	ret = ath10k_debug_create(ar);
	if (ret)
		goto err_free_wq;

1244 1245
	return ar;

1246 1247 1248 1249
err_free_wq:
	destroy_workqueue(ar->workqueue);

err_free_mac:
1250
	ath10k_mac_destroy(ar);
1251

1252 1253 1254 1255 1256 1257 1258 1259 1260
	return NULL;
}
EXPORT_SYMBOL(ath10k_core_create);

void ath10k_core_destroy(struct ath10k *ar)
{
	flush_workqueue(ar->workqueue);
	destroy_workqueue(ar->workqueue);

1261
	ath10k_debug_destroy(ar);
1262 1263 1264 1265
	ath10k_mac_destroy(ar);
}
EXPORT_SYMBOL(ath10k_core_destroy);

1266 1267 1268
MODULE_AUTHOR("Qualcomm Atheros");
MODULE_DESCRIPTION("Core module for QCA988X PCIe devices.");
MODULE_LICENSE("Dual BSD/GPL");