Linux Audio

Check our new training course

Loading...
v6.8
  1// SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
  2/*
  3 * Copyright (C) 2017 Intel Deutschland GmbH
  4 * Copyright (C) 2018-2023 Intel Corporation
  5 */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  6#include "iwl-trans.h"
  7#include "iwl-prph.h"
  8#include "iwl-context-info.h"
  9#include "iwl-context-info-gen3.h"
 10#include "internal.h"
 11#include "fw/dbg.h"
 12
 13#define FW_RESET_TIMEOUT (HZ / 5)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 14
 15/*
 16 * Start up NIC's basic functionality after it has been reset
 17 * (e.g. after platform boot, or shutdown via iwl_pcie_apm_stop())
 18 * NOTE:  This does not load uCode nor start the embedded processor
 19 */
 20int iwl_pcie_gen2_apm_init(struct iwl_trans *trans)
 21{
 22	int ret = 0;
 23
 24	IWL_DEBUG_INFO(trans, "Init card's basic functions\n");
 25
 26	/*
 27	 * Use "set_bit" below rather than "write", to preserve any hardware
 28	 * bits already set by default after reset.
 29	 */
 30
 31	/*
 32	 * Disable L0s without affecting L1;
 33	 * don't wait for ICH L0s (ICH bug W/A)
 34	 */
 35	iwl_set_bit(trans, CSR_GIO_CHICKEN_BITS,
 36		    CSR_GIO_CHICKEN_BITS_REG_BIT_L1A_NO_L0S_RX);
 37
 38	/* Set FH wait threshold to maximum (HW error during stress W/A) */
 39	iwl_set_bit(trans, CSR_DBG_HPET_MEM_REG, CSR_DBG_HPET_MEM_REG_VAL);
 40
 41	/*
 42	 * Enable HAP INTA (interrupt from management bus) to
 43	 * wake device's PCI Express link L1a -> L0s
 44	 */
 45	iwl_set_bit(trans, CSR_HW_IF_CONFIG_REG,
 46		    CSR_HW_IF_CONFIG_REG_BIT_HAP_WAKE_L1A);
 47
 48	iwl_pcie_apm_config(trans);
 49
 50	ret = iwl_finish_nic_init(trans);
 
 
 
 
 
 
 
 51	if (ret)
 52		return ret;
 53
 54	set_bit(STATUS_DEVICE_ENABLED, &trans->status);
 55
 56	return 0;
 57}
 58
 59static void iwl_pcie_gen2_apm_stop(struct iwl_trans *trans, bool op_mode_leave)
 60{
 61	IWL_DEBUG_INFO(trans, "Stop card, put in low power state\n");
 62
 63	if (op_mode_leave) {
 64		if (!test_bit(STATUS_DEVICE_ENABLED, &trans->status))
 65			iwl_pcie_gen2_apm_init(trans);
 66
 67		/* inform ME that we are leaving */
 68		iwl_set_bit(trans, CSR_DBG_LINK_PWR_MGMT_REG,
 69			    CSR_RESET_LINK_PWR_MGMT_DISABLED);
 70		iwl_set_bit(trans, CSR_HW_IF_CONFIG_REG,
 71			    CSR_HW_IF_CONFIG_REG_PREPARE |
 72			    CSR_HW_IF_CONFIG_REG_ENABLE_PME);
 73		mdelay(1);
 74		iwl_clear_bit(trans, CSR_DBG_LINK_PWR_MGMT_REG,
 75			      CSR_RESET_LINK_PWR_MGMT_DISABLED);
 76		mdelay(5);
 77	}
 78
 79	clear_bit(STATUS_DEVICE_ENABLED, &trans->status);
 80
 81	/* Stop device's DMA activity */
 82	iwl_pcie_apm_stop_master(trans);
 83
 84	iwl_trans_sw_reset(trans, false);
 85
 86	/*
 87	 * Clear "initialization complete" bit to move adapter from
 88	 * D0A* (powered-up Active) --> D0U* (Uninitialized) state.
 89	 */
 90	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_BZ)
 91		iwl_clear_bit(trans, CSR_GP_CNTRL,
 92			      CSR_GP_CNTRL_REG_FLAG_MAC_INIT);
 93	else
 94		iwl_clear_bit(trans, CSR_GP_CNTRL,
 95			      CSR_GP_CNTRL_REG_FLAG_INIT_DONE);
 96}
 97
 98static void iwl_trans_pcie_fw_reset_handshake(struct iwl_trans *trans)
 99{
100	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
101	int ret;
102
103	trans_pcie->fw_reset_state = FW_RESET_REQUESTED;
104
105	if (trans->trans_cfg->device_family < IWL_DEVICE_FAMILY_AX210)
106		iwl_write_umac_prph(trans, UREG_NIC_SET_NMI_DRIVER,
107				    UREG_NIC_SET_NMI_DRIVER_RESET_HANDSHAKE);
108	else if (trans->trans_cfg->device_family == IWL_DEVICE_FAMILY_AX210)
109		iwl_write_umac_prph(trans, UREG_DOORBELL_TO_ISR6,
110				    UREG_DOORBELL_TO_ISR6_RESET_HANDSHAKE);
111	else
112		iwl_write32(trans, CSR_DOORBELL_VECTOR,
113			    UREG_DOORBELL_TO_ISR6_RESET_HANDSHAKE);
114
115	/* wait 200ms */
116	ret = wait_event_timeout(trans_pcie->fw_reset_waitq,
117				 trans_pcie->fw_reset_state != FW_RESET_REQUESTED,
118				 FW_RESET_TIMEOUT);
119	if (!ret || trans_pcie->fw_reset_state == FW_RESET_ERROR) {
120		u32 inta_hw = iwl_read32(trans, CSR_MSIX_HW_INT_CAUSES_AD);
121
122		IWL_ERR(trans,
123			"timeout waiting for FW reset ACK (inta_hw=0x%x)\n",
124			inta_hw);
125
126		if (!(inta_hw & MSIX_HW_INT_CAUSES_REG_RESET_DONE))
127			iwl_trans_fw_error(trans, true);
128	}
129
130	trans_pcie->fw_reset_state = FW_RESET_IDLE;
131}
132
133void _iwl_trans_pcie_gen2_stop_device(struct iwl_trans *trans)
134{
135	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
136
137	lockdep_assert_held(&trans_pcie->mutex);
138
139	if (trans_pcie->is_down)
140		return;
141
142	if (trans->state >= IWL_TRANS_FW_STARTED)
143		if (trans_pcie->fw_reset_handshake)
144			iwl_trans_pcie_fw_reset_handshake(trans);
145
146	trans_pcie->is_down = true;
147
148	/* tell the device to stop sending interrupts */
149	iwl_disable_interrupts(trans);
150
151	/* device going down, Stop using ICT table */
152	iwl_pcie_disable_ict(trans);
153
154	/*
155	 * If a HW restart happens during firmware loading,
156	 * then the firmware loading might call this function
157	 * and later it might be called again due to the
158	 * restart. So don't process again if the device is
159	 * already dead.
160	 */
161	if (test_and_clear_bit(STATUS_DEVICE_ENABLED, &trans->status)) {
162		IWL_DEBUG_INFO(trans,
163			       "DEVICE_ENABLED bit was set and is now cleared\n");
164		iwl_pcie_synchronize_irqs(trans);
165		iwl_pcie_rx_napi_sync(trans);
166		iwl_txq_gen2_tx_free(trans);
167		iwl_pcie_rx_stop(trans);
168	}
169
170	iwl_pcie_ctxt_info_free_paging(trans);
171	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_AX210)
172		iwl_pcie_ctxt_info_gen3_free(trans, false);
173	else
174		iwl_pcie_ctxt_info_free(trans);
175
 
 
 
 
176	/* Stop the device, and put it in low power state */
177	iwl_pcie_gen2_apm_stop(trans, false);
178
179	/* re-take ownership to prevent other users from stealing the device */
180	iwl_trans_sw_reset(trans, true);
181
182	/*
183	 * Upon stop, the IVAR table gets erased, so msi-x won't
184	 * work. This causes a bug in RF-KILL flows, since the interrupt
185	 * that enables radio won't fire on the correct irq, and the
186	 * driver won't be able to handle the interrupt.
187	 * Configure the IVAR table again after reset.
188	 */
189	iwl_pcie_conf_msix_hw(trans_pcie);
190
191	/*
192	 * Upon stop, the APM issues an interrupt if HW RF kill is set.
193	 * This is a bug in certain verions of the hardware.
194	 * Certain devices also keep sending HW RF kill interrupt all
195	 * the time, unless the interrupt is ACKed even if the interrupt
196	 * should be masked. Re-ACK all the interrupts here.
197	 */
198	iwl_disable_interrupts(trans);
199
200	/* clear all status bits */
201	clear_bit(STATUS_SYNC_HCMD_ACTIVE, &trans->status);
202	clear_bit(STATUS_INT_ENABLED, &trans->status);
203	clear_bit(STATUS_TPOWER_PMI, &trans->status);
204
205	/*
206	 * Even if we stop the HW, we still want the RF kill
207	 * interrupt
208	 */
209	iwl_enable_rfkill_int(trans);
 
 
 
210}
211
212void iwl_trans_pcie_gen2_stop_device(struct iwl_trans *trans)
213{
214	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
215	bool was_in_rfkill;
216
217	iwl_op_mode_time_point(trans->op_mode,
218			       IWL_FW_INI_TIME_POINT_HOST_DEVICE_DISABLE,
219			       NULL);
220
221	mutex_lock(&trans_pcie->mutex);
222	trans_pcie->opmode_down = true;
223	was_in_rfkill = test_bit(STATUS_RFKILL_OPMODE, &trans->status);
224	_iwl_trans_pcie_gen2_stop_device(trans);
225	iwl_trans_pcie_handle_stop_rfkill(trans, was_in_rfkill);
226	mutex_unlock(&trans_pcie->mutex);
227}
228
229static int iwl_pcie_gen2_nic_init(struct iwl_trans *trans)
230{
231	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
232	int queue_size = max_t(u32, IWL_CMD_QUEUE_SIZE,
233			       trans->cfg->min_txq_size);
234	int ret;
235
236	/* TODO: most of the logic can be removed in A0 - but not in Z0 */
237	spin_lock_bh(&trans_pcie->irq_lock);
238	ret = iwl_pcie_gen2_apm_init(trans);
239	spin_unlock_bh(&trans_pcie->irq_lock);
240	if (ret)
241		return ret;
242
243	iwl_op_mode_nic_config(trans->op_mode);
244
245	/* Allocate the RX queue, or reset if it is already allocated */
246	if (iwl_pcie_gen2_rx_init(trans))
247		return -ENOMEM;
248
249	/* Allocate or reset and init all Tx and Command queues */
250	if (iwl_txq_gen2_init(trans, trans->txqs.cmd.q_id, queue_size))
251		return -ENOMEM;
252
253	/* enable shadow regs in HW */
254	iwl_set_bit(trans, CSR_MAC_SHADOW_REG_CTRL, 0x800FFFFF);
255	IWL_DEBUG_INFO(trans, "Enabling shadow registers in device\n");
256
257	return 0;
258}
259
260static void iwl_pcie_get_rf_name(struct iwl_trans *trans)
261{
262	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
263	char *buf = trans_pcie->rf_name;
264	size_t buflen = sizeof(trans_pcie->rf_name);
265	size_t pos;
266	u32 version;
267
268	if (buf[0])
269		return;
270
271	switch (CSR_HW_RFID_TYPE(trans->hw_rf_id)) {
272	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_JF):
273		pos = scnprintf(buf, buflen, "JF");
274		break;
275	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_GF):
276		pos = scnprintf(buf, buflen, "GF");
277		break;
278	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_GF4):
279		pos = scnprintf(buf, buflen, "GF4");
280		break;
281	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HR):
282		pos = scnprintf(buf, buflen, "HR");
283		break;
284	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HR1):
285		pos = scnprintf(buf, buflen, "HR1");
286		break;
287	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HRCDB):
288		pos = scnprintf(buf, buflen, "HRCDB");
289		break;
290	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_MS):
291		pos = scnprintf(buf, buflen, "MS");
292		break;
293	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_FM):
294		pos = scnprintf(buf, buflen, "FM");
295		break;
296	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_WP):
297		if (SILICON_Z_STEP ==
298		    CSR_HW_RFID_STEP(trans->hw_rf_id))
299			pos = scnprintf(buf, buflen, "WHTC");
300		else
301			pos = scnprintf(buf, buflen, "WH");
302		break;
303	default:
304		return;
305	}
306
307	switch (CSR_HW_RFID_TYPE(trans->hw_rf_id)) {
308	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HR):
309	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HR1):
310	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HRCDB):
311		version = iwl_read_prph(trans, CNVI_MBOX_C);
312		switch (version) {
313		case 0x20000:
314			pos += scnprintf(buf + pos, buflen - pos, " B3");
315			break;
316		case 0x120000:
317			pos += scnprintf(buf + pos, buflen - pos, " B5");
318			break;
319		default:
320			pos += scnprintf(buf + pos, buflen - pos,
321					 " (0x%x)", version);
322			break;
323		}
324		break;
325	default:
326		break;
327	}
328
329	pos += scnprintf(buf + pos, buflen - pos, ", rfid=0x%x",
330			 trans->hw_rf_id);
331
332	IWL_INFO(trans, "Detected RF %s\n", buf);
333
334	/*
335	 * also add a \n for debugfs - need to do it after printing
336	 * since our IWL_INFO machinery wants to see a static \n at
337	 * the end of the string
338	 */
339	pos += scnprintf(buf + pos, buflen - pos, "\n");
340}
341
342void iwl_trans_pcie_gen2_fw_alive(struct iwl_trans *trans, u32 scd_addr)
343{
344	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
345
346	iwl_pcie_reset_ict(trans);
347
348	/* make sure all queue are not stopped/used */
349	memset(trans->txqs.queue_stopped, 0,
350	       sizeof(trans->txqs.queue_stopped));
351	memset(trans->txqs.queue_used, 0, sizeof(trans->txqs.queue_used));
352
353	/* now that we got alive we can free the fw image & the context info.
354	 * paging memory cannot be freed included since FW will still use it
355	 */
356	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_AX210)
357		iwl_pcie_ctxt_info_gen3_free(trans, true);
358	else
359		iwl_pcie_ctxt_info_free(trans);
360
361	/*
362	 * Re-enable all the interrupts, including the RF-Kill one, now that
363	 * the firmware is alive.
364	 */
365	iwl_enable_interrupts(trans);
366	mutex_lock(&trans_pcie->mutex);
367	iwl_pcie_check_hw_rf_kill(trans);
368
369	iwl_pcie_get_rf_name(trans);
370	mutex_unlock(&trans_pcie->mutex);
371}
372
373static bool iwl_pcie_set_ltr(struct iwl_trans *trans)
374{
375	u32 ltr_val = CSR_LTR_LONG_VAL_AD_NO_SNOOP_REQ |
376		      u32_encode_bits(CSR_LTR_LONG_VAL_AD_SCALE_USEC,
377				      CSR_LTR_LONG_VAL_AD_NO_SNOOP_SCALE) |
378		      u32_encode_bits(250,
379				      CSR_LTR_LONG_VAL_AD_NO_SNOOP_VAL) |
380		      CSR_LTR_LONG_VAL_AD_SNOOP_REQ |
381		      u32_encode_bits(CSR_LTR_LONG_VAL_AD_SCALE_USEC,
382				      CSR_LTR_LONG_VAL_AD_SNOOP_SCALE) |
383		      u32_encode_bits(250, CSR_LTR_LONG_VAL_AD_SNOOP_VAL);
384
385	/*
386	 * To workaround hardware latency issues during the boot process,
387	 * initialize the LTR to ~250 usec (see ltr_val above).
388	 * The firmware initializes this again later (to a smaller value).
389	 */
390	if ((trans->trans_cfg->device_family == IWL_DEVICE_FAMILY_AX210 ||
391	     trans->trans_cfg->device_family == IWL_DEVICE_FAMILY_22000) &&
392	    !trans->trans_cfg->integrated) {
393		iwl_write32(trans, CSR_LTR_LONG_VAL_AD, ltr_val);
394		return true;
395	}
396
397	if (trans->trans_cfg->integrated &&
398	    trans->trans_cfg->device_family == IWL_DEVICE_FAMILY_22000) {
399		iwl_write_prph(trans, HPM_MAC_LTR_CSR, HPM_MAC_LRT_ENABLE_ALL);
400		iwl_write_prph(trans, HPM_UMAC_LTR, ltr_val);
401		return true;
402	}
403
404	if (trans->trans_cfg->device_family == IWL_DEVICE_FAMILY_AX210) {
405		/* First clear the interrupt, just in case */
406		iwl_write32(trans, CSR_MSIX_HW_INT_CAUSES_AD,
407			    MSIX_HW_INT_CAUSES_REG_IML);
408		/* In this case, unfortunately the same ROM bug exists in the
409		 * device (not setting LTR correctly), but we don't have control
410		 * over the settings from the host due to some hardware security
411		 * features. The only workaround we've been able to come up with
412		 * so far is to try to keep the CPU and device busy by polling
413		 * it and the IML (image loader) completed interrupt.
414		 */
415		return false;
416	}
417
418	/* nothing needs to be done on other devices */
419	return true;
420}
421
422static void iwl_pcie_spin_for_iml(struct iwl_trans *trans)
423{
424/* in practice, this seems to complete in around 20-30ms at most, wait 100 */
425#define IML_WAIT_TIMEOUT	(HZ / 10)
426	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
427	unsigned long end_time = jiffies + IML_WAIT_TIMEOUT;
428	u32 value, loops = 0;
429	bool irq = false;
430
431	if (WARN_ON(!trans_pcie->iml))
432		return;
433
434	value = iwl_read32(trans, CSR_LTR_LAST_MSG);
435	IWL_DEBUG_INFO(trans, "Polling for IML load - CSR_LTR_LAST_MSG=0x%x\n",
436		       value);
437
438	while (time_before(jiffies, end_time)) {
439		if (iwl_read32(trans, CSR_MSIX_HW_INT_CAUSES_AD) &
440				MSIX_HW_INT_CAUSES_REG_IML) {
441			irq = true;
442			break;
443		}
444		/* Keep the CPU and device busy. */
445		value = iwl_read32(trans, CSR_LTR_LAST_MSG);
446		loops++;
447	}
448
449	IWL_DEBUG_INFO(trans,
450		       "Polled for IML load: irq=%d, loops=%d, CSR_LTR_LAST_MSG=0x%x\n",
451		       irq, loops, value);
452
453	/* We don't fail here even if we timed out - maybe we get lucky and the
454	 * interrupt comes in later (and we get alive from firmware) and then
455	 * we're all happy - but if not we'll fail on alive timeout or get some
456	 * other error out.
457	 */
458}
459
460int iwl_trans_pcie_gen2_start_fw(struct iwl_trans *trans,
461				 const struct fw_img *fw, bool run_in_rfkill)
462{
463	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
464	bool hw_rfkill, keep_ram_busy;
465	int ret;
466
467	/* This may fail if AMT took ownership of the device */
468	if (iwl_pcie_prepare_card_hw(trans)) {
469		IWL_WARN(trans, "Exit HW not ready\n");
470		return -EIO;
 
471	}
472
473	iwl_enable_rfkill_int(trans);
474
475	iwl_write32(trans, CSR_INT, 0xFFFFFFFF);
476
477	/*
478	 * We enabled the RF-Kill interrupt and the handler may very
479	 * well be running. Disable the interrupts to make sure no other
480	 * interrupt can be fired.
481	 */
482	iwl_disable_interrupts(trans);
483
484	/* Make sure it finished running */
485	iwl_pcie_synchronize_irqs(trans);
486
487	mutex_lock(&trans_pcie->mutex);
488
489	/* If platform's RF_KILL switch is NOT set to KILL */
490	hw_rfkill = iwl_pcie_check_hw_rf_kill(trans);
491	if (hw_rfkill && !run_in_rfkill) {
492		ret = -ERFKILL;
493		goto out;
494	}
495
496	/* Someone called stop_device, don't try to start_fw */
497	if (trans_pcie->is_down) {
498		IWL_WARN(trans,
499			 "Can't start_fw since the HW hasn't been started\n");
500		ret = -EIO;
501		goto out;
502	}
503
504	/* make sure rfkill handshake bits are cleared */
505	iwl_write32(trans, CSR_UCODE_DRV_GP1_CLR, CSR_UCODE_SW_BIT_RFKILL);
506	iwl_write32(trans, CSR_UCODE_DRV_GP1_CLR,
507		    CSR_UCODE_DRV_GP1_BIT_CMD_BLOCKED);
508
509	/* clear (again), then enable host interrupts */
510	iwl_write32(trans, CSR_INT, 0xFFFFFFFF);
511
512	ret = iwl_pcie_gen2_nic_init(trans);
513	if (ret) {
514		IWL_ERR(trans, "Unable to init nic\n");
515		goto out;
516	}
517
518	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_AX210)
519		ret = iwl_pcie_ctxt_info_gen3_init(trans, fw);
520	else
521		ret = iwl_pcie_ctxt_info_init(trans, fw);
522	if (ret)
523		goto out;
524
525	keep_ram_busy = !iwl_pcie_set_ltr(trans);
526
527	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_BZ) {
528		iwl_write32(trans, CSR_FUNC_SCRATCH, CSR_FUNC_SCRATCH_INIT_VALUE);
529		iwl_set_bit(trans, CSR_GP_CNTRL,
530			    CSR_GP_CNTRL_REG_FLAG_ROM_START);
531	} else if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_AX210) {
532		iwl_write_umac_prph(trans, UREG_CPU_INIT_RUN, 1);
533	} else {
534		iwl_write_prph(trans, UREG_CPU_INIT_RUN, 1);
535	}
536
537	if (keep_ram_busy)
538		iwl_pcie_spin_for_iml(trans);
539
540	/* re-check RF-Kill state since we may have missed the interrupt */
541	hw_rfkill = iwl_pcie_check_hw_rf_kill(trans);
542	if (hw_rfkill && !run_in_rfkill)
543		ret = -ERFKILL;
544
545out:
546	mutex_unlock(&trans_pcie->mutex);
547	return ret;
548}
v5.4
  1/******************************************************************************
  2 *
  3 * This file is provided under a dual BSD/GPLv2 license.  When using or
  4 * redistributing this file, you may do so under either license.
  5 *
  6 * GPL LICENSE SUMMARY
  7 *
  8 * Copyright(c) 2017 Intel Deutschland GmbH
  9 * Copyright(c) 2018 - 2019 Intel Corporation
 10 *
 11 * This program is free software; you can redistribute it and/or modify
 12 * it under the terms of version 2 of the GNU General Public License as
 13 * published by the Free Software Foundation.
 14 *
 15 * This program is distributed in the hope that it will be useful, but
 16 * WITHOUT ANY WARRANTY; without even the implied warranty of
 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 18 * General Public License for more details.
 19 *
 20 * BSD LICENSE
 21 *
 22 * Copyright(c) 2017 Intel Deutschland GmbH
 23 * Copyright(c) 2018 - 2019 Intel Corporation
 24 * All rights reserved.
 25 *
 26 * Redistribution and use in source and binary forms, with or without
 27 * modification, are permitted provided that the following conditions
 28 * are met:
 29 *
 30 *  * Redistributions of source code must retain the above copyright
 31 *    notice, this list of conditions and the following disclaimer.
 32 *  * Redistributions in binary form must reproduce the above copyright
 33 *    notice, this list of conditions and the following disclaimer in
 34 *    the documentation and/or other materials provided with the
 35 *    distribution.
 36 *  * Neither the name Intel Corporation nor the names of its
 37 *    contributors may be used to endorse or promote products derived
 38 *    from this software without specific prior written permission.
 39 *
 40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 51 *
 52 *****************************************************************************/
 53#include "iwl-trans.h"
 54#include "iwl-prph.h"
 55#include "iwl-context-info.h"
 56#include "iwl-context-info-gen3.h"
 57#include "internal.h"
 58#include "fw/dbg.h"
 59
 60static int iwl_pcie_gen2_force_power_gating(struct iwl_trans *trans)
 61{
 62	iwl_set_bits_prph(trans, HPM_HIPM_GEN_CFG,
 63			  HPM_HIPM_GEN_CFG_CR_FORCE_ACTIVE);
 64	udelay(20);
 65	iwl_set_bits_prph(trans, HPM_HIPM_GEN_CFG,
 66			  HPM_HIPM_GEN_CFG_CR_PG_EN |
 67			  HPM_HIPM_GEN_CFG_CR_SLP_EN);
 68	udelay(20);
 69	iwl_clear_bits_prph(trans, HPM_HIPM_GEN_CFG,
 70			    HPM_HIPM_GEN_CFG_CR_FORCE_ACTIVE);
 71
 72	iwl_trans_sw_reset(trans);
 73	iwl_clear_bit(trans, CSR_GP_CNTRL, CSR_GP_CNTRL_REG_FLAG_INIT_DONE);
 74
 75	return 0;
 76}
 77
 78/*
 79 * Start up NIC's basic functionality after it has been reset
 80 * (e.g. after platform boot, or shutdown via iwl_pcie_apm_stop())
 81 * NOTE:  This does not load uCode nor start the embedded processor
 82 */
 83int iwl_pcie_gen2_apm_init(struct iwl_trans *trans)
 84{
 85	int ret = 0;
 86
 87	IWL_DEBUG_INFO(trans, "Init card's basic functions\n");
 88
 89	/*
 90	 * Use "set_bit" below rather than "write", to preserve any hardware
 91	 * bits already set by default after reset.
 92	 */
 93
 94	/*
 95	 * Disable L0s without affecting L1;
 96	 * don't wait for ICH L0s (ICH bug W/A)
 97	 */
 98	iwl_set_bit(trans, CSR_GIO_CHICKEN_BITS,
 99		    CSR_GIO_CHICKEN_BITS_REG_BIT_L1A_NO_L0S_RX);
100
101	/* Set FH wait threshold to maximum (HW error during stress W/A) */
102	iwl_set_bit(trans, CSR_DBG_HPET_MEM_REG, CSR_DBG_HPET_MEM_REG_VAL);
103
104	/*
105	 * Enable HAP INTA (interrupt from management bus) to
106	 * wake device's PCI Express link L1a -> L0s
107	 */
108	iwl_set_bit(trans, CSR_HW_IF_CONFIG_REG,
109		    CSR_HW_IF_CONFIG_REG_BIT_HAP_WAKE_L1A);
110
111	iwl_pcie_apm_config(trans);
112
113	if (trans->trans_cfg->device_family == IWL_DEVICE_FAMILY_22000 &&
114	    trans->cfg->integrated) {
115		ret = iwl_pcie_gen2_force_power_gating(trans);
116		if (ret)
117			return ret;
118	}
119
120	ret = iwl_finish_nic_init(trans, trans->trans_cfg);
121	if (ret)
122		return ret;
123
124	set_bit(STATUS_DEVICE_ENABLED, &trans->status);
125
126	return 0;
127}
128
129static void iwl_pcie_gen2_apm_stop(struct iwl_trans *trans, bool op_mode_leave)
130{
131	IWL_DEBUG_INFO(trans, "Stop card, put in low power state\n");
132
133	if (op_mode_leave) {
134		if (!test_bit(STATUS_DEVICE_ENABLED, &trans->status))
135			iwl_pcie_gen2_apm_init(trans);
136
137		/* inform ME that we are leaving */
138		iwl_set_bit(trans, CSR_DBG_LINK_PWR_MGMT_REG,
139			    CSR_RESET_LINK_PWR_MGMT_DISABLED);
140		iwl_set_bit(trans, CSR_HW_IF_CONFIG_REG,
141			    CSR_HW_IF_CONFIG_REG_PREPARE |
142			    CSR_HW_IF_CONFIG_REG_ENABLE_PME);
143		mdelay(1);
144		iwl_clear_bit(trans, CSR_DBG_LINK_PWR_MGMT_REG,
145			      CSR_RESET_LINK_PWR_MGMT_DISABLED);
146		mdelay(5);
147	}
148
149	clear_bit(STATUS_DEVICE_ENABLED, &trans->status);
150
151	/* Stop device's DMA activity */
152	iwl_pcie_apm_stop_master(trans);
153
154	iwl_trans_sw_reset(trans);
155
156	/*
157	 * Clear "initialization complete" bit to move adapter from
158	 * D0A* (powered-up Active) --> D0U* (Uninitialized) state.
159	 */
160	iwl_clear_bit(trans, CSR_GP_CNTRL,
161		      BIT(trans->trans_cfg->csr->flag_init_done));
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
162}
163
164void _iwl_trans_pcie_gen2_stop_device(struct iwl_trans *trans)
165{
166	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
167
168	lockdep_assert_held(&trans_pcie->mutex);
169
170	if (trans_pcie->is_down)
171		return;
172
 
 
 
 
173	trans_pcie->is_down = true;
174
175	/* tell the device to stop sending interrupts */
176	iwl_disable_interrupts(trans);
177
178	/* device going down, Stop using ICT table */
179	iwl_pcie_disable_ict(trans);
180
181	/*
182	 * If a HW restart happens during firmware loading,
183	 * then the firmware loading might call this function
184	 * and later it might be called again due to the
185	 * restart. So don't process again if the device is
186	 * already dead.
187	 */
188	if (test_and_clear_bit(STATUS_DEVICE_ENABLED, &trans->status)) {
189		IWL_DEBUG_INFO(trans,
190			       "DEVICE_ENABLED bit was set and is now cleared\n");
191		iwl_pcie_gen2_tx_stop(trans);
 
 
192		iwl_pcie_rx_stop(trans);
193	}
194
195	iwl_pcie_ctxt_info_free_paging(trans);
196	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_22560)
197		iwl_pcie_ctxt_info_gen3_free(trans);
198	else
199		iwl_pcie_ctxt_info_free(trans);
200
201	/* Make sure (redundant) we've released our request to stay awake */
202	iwl_clear_bit(trans, CSR_GP_CNTRL,
203		      BIT(trans->trans_cfg->csr->flag_mac_access_req));
204
205	/* Stop the device, and put it in low power state */
206	iwl_pcie_gen2_apm_stop(trans, false);
207
208	iwl_trans_sw_reset(trans);
 
209
210	/*
211	 * Upon stop, the IVAR table gets erased, so msi-x won't
212	 * work. This causes a bug in RF-KILL flows, since the interrupt
213	 * that enables radio won't fire on the correct irq, and the
214	 * driver won't be able to handle the interrupt.
215	 * Configure the IVAR table again after reset.
216	 */
217	iwl_pcie_conf_msix_hw(trans_pcie);
218
219	/*
220	 * Upon stop, the APM issues an interrupt if HW RF kill is set.
221	 * This is a bug in certain verions of the hardware.
222	 * Certain devices also keep sending HW RF kill interrupt all
223	 * the time, unless the interrupt is ACKed even if the interrupt
224	 * should be masked. Re-ACK all the interrupts here.
225	 */
226	iwl_disable_interrupts(trans);
227
228	/* clear all status bits */
229	clear_bit(STATUS_SYNC_HCMD_ACTIVE, &trans->status);
230	clear_bit(STATUS_INT_ENABLED, &trans->status);
231	clear_bit(STATUS_TPOWER_PMI, &trans->status);
232
233	/*
234	 * Even if we stop the HW, we still want the RF kill
235	 * interrupt
236	 */
237	iwl_enable_rfkill_int(trans);
238
239	/* re-take ownership to prevent other users from stealing the device */
240	iwl_pcie_prepare_card_hw(trans);
241}
242
243void iwl_trans_pcie_gen2_stop_device(struct iwl_trans *trans)
244{
245	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
246	bool was_in_rfkill;
247
 
 
 
 
248	mutex_lock(&trans_pcie->mutex);
249	trans_pcie->opmode_down = true;
250	was_in_rfkill = test_bit(STATUS_RFKILL_OPMODE, &trans->status);
251	_iwl_trans_pcie_gen2_stop_device(trans);
252	iwl_trans_pcie_handle_stop_rfkill(trans, was_in_rfkill);
253	mutex_unlock(&trans_pcie->mutex);
254}
255
256static int iwl_pcie_gen2_nic_init(struct iwl_trans *trans)
257{
258	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
259	int queue_size = max_t(u32, IWL_CMD_QUEUE_SIZE,
260			       trans->cfg->min_txq_size);
 
261
262	/* TODO: most of the logic can be removed in A0 - but not in Z0 */
263	spin_lock(&trans_pcie->irq_lock);
264	iwl_pcie_gen2_apm_init(trans);
265	spin_unlock(&trans_pcie->irq_lock);
 
 
266
267	iwl_op_mode_nic_config(trans->op_mode);
268
269	/* Allocate the RX queue, or reset if it is already allocated */
270	if (iwl_pcie_gen2_rx_init(trans))
271		return -ENOMEM;
272
273	/* Allocate or reset and init all Tx and Command queues */
274	if (iwl_pcie_gen2_tx_init(trans, trans_pcie->cmd_queue, queue_size))
275		return -ENOMEM;
276
277	/* enable shadow regs in HW */
278	iwl_set_bit(trans, CSR_MAC_SHADOW_REG_CTRL, 0x800FFFFF);
279	IWL_DEBUG_INFO(trans, "Enabling shadow registers in device\n");
280
281	return 0;
282}
283
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
284void iwl_trans_pcie_gen2_fw_alive(struct iwl_trans *trans, u32 scd_addr)
285{
286	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
287
288	iwl_pcie_reset_ict(trans);
289
290	/* make sure all queue are not stopped/used */
291	memset(trans_pcie->queue_stopped, 0, sizeof(trans_pcie->queue_stopped));
292	memset(trans_pcie->queue_used, 0, sizeof(trans_pcie->queue_used));
 
293
294	/* now that we got alive we can free the fw image & the context info.
295	 * paging memory cannot be freed included since FW will still use it
296	 */
297	iwl_pcie_ctxt_info_free(trans);
 
 
 
298
299	/*
300	 * Re-enable all the interrupts, including the RF-Kill one, now that
301	 * the firmware is alive.
302	 */
303	iwl_enable_interrupts(trans);
304	mutex_lock(&trans_pcie->mutex);
305	iwl_pcie_check_hw_rf_kill(trans);
 
 
306	mutex_unlock(&trans_pcie->mutex);
307}
308
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
309int iwl_trans_pcie_gen2_start_fw(struct iwl_trans *trans,
310				 const struct fw_img *fw, bool run_in_rfkill)
311{
312	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
313	bool hw_rfkill;
314	int ret;
315
316	/* This may fail if AMT took ownership of the device */
317	if (iwl_pcie_prepare_card_hw(trans)) {
318		IWL_WARN(trans, "Exit HW not ready\n");
319		ret = -EIO;
320		goto out;
321	}
322
323	iwl_enable_rfkill_int(trans);
324
325	iwl_write32(trans, CSR_INT, 0xFFFFFFFF);
326
327	/*
328	 * We enabled the RF-Kill interrupt and the handler may very
329	 * well be running. Disable the interrupts to make sure no other
330	 * interrupt can be fired.
331	 */
332	iwl_disable_interrupts(trans);
333
334	/* Make sure it finished running */
335	iwl_pcie_synchronize_irqs(trans);
336
337	mutex_lock(&trans_pcie->mutex);
338
339	/* If platform's RF_KILL switch is NOT set to KILL */
340	hw_rfkill = iwl_pcie_check_hw_rf_kill(trans);
341	if (hw_rfkill && !run_in_rfkill) {
342		ret = -ERFKILL;
343		goto out;
344	}
345
346	/* Someone called stop_device, don't try to start_fw */
347	if (trans_pcie->is_down) {
348		IWL_WARN(trans,
349			 "Can't start_fw since the HW hasn't been started\n");
350		ret = -EIO;
351		goto out;
352	}
353
354	/* make sure rfkill handshake bits are cleared */
355	iwl_write32(trans, CSR_UCODE_DRV_GP1_CLR, CSR_UCODE_SW_BIT_RFKILL);
356	iwl_write32(trans, CSR_UCODE_DRV_GP1_CLR,
357		    CSR_UCODE_DRV_GP1_BIT_CMD_BLOCKED);
358
359	/* clear (again), then enable host interrupts */
360	iwl_write32(trans, CSR_INT, 0xFFFFFFFF);
361
362	ret = iwl_pcie_gen2_nic_init(trans);
363	if (ret) {
364		IWL_ERR(trans, "Unable to init nic\n");
365		goto out;
366	}
367
368	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_22560)
369		ret = iwl_pcie_ctxt_info_gen3_init(trans, fw);
370	else
371		ret = iwl_pcie_ctxt_info_init(trans, fw);
372	if (ret)
373		goto out;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
374
375	/* re-check RF-Kill state since we may have missed the interrupt */
376	hw_rfkill = iwl_pcie_check_hw_rf_kill(trans);
377	if (hw_rfkill && !run_in_rfkill)
378		ret = -ERFKILL;
379
380out:
381	mutex_unlock(&trans_pcie->mutex);
382	return ret;
383}