xref: /freebsd/sys/contrib/dev/iwlwifi/pcie/trans-gen2.c (revision e9e8876a4d6afc1ad5315faaa191b25121a813d7)
1 // SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause
2 /*
3  * Copyright (C) 2017 Intel Deutschland GmbH
4  * Copyright (C) 2018-2021 Intel Corporation
5  */
6 #if defined(__FreeBSD__)
7 #include <linux/delay.h>
8 #endif
9 #include "iwl-trans.h"
10 #include "iwl-prph.h"
11 #include "iwl-context-info.h"
12 #include "iwl-context-info-gen3.h"
13 #include "internal.h"
14 #include "fw/dbg.h"
15 
16 #define FW_RESET_TIMEOUT (HZ / 5)
17 
18 /*
19  * Start up NIC's basic functionality after it has been reset
20  * (e.g. after platform boot, or shutdown via iwl_pcie_apm_stop())
21  * NOTE:  This does not load uCode nor start the embedded processor
22  */
23 int iwl_pcie_gen2_apm_init(struct iwl_trans *trans)
24 {
25 	int ret = 0;
26 
27 	IWL_DEBUG_INFO(trans, "Init card's basic functions\n");
28 
29 	/*
30 	 * Use "set_bit" below rather than "write", to preserve any hardware
31 	 * bits already set by default after reset.
32 	 */
33 
34 	/*
35 	 * Disable L0s without affecting L1;
36 	 * don't wait for ICH L0s (ICH bug W/A)
37 	 */
38 	iwl_set_bit(trans, CSR_GIO_CHICKEN_BITS,
39 		    CSR_GIO_CHICKEN_BITS_REG_BIT_L1A_NO_L0S_RX);
40 
41 	/* Set FH wait threshold to maximum (HW error during stress W/A) */
42 	iwl_set_bit(trans, CSR_DBG_HPET_MEM_REG, CSR_DBG_HPET_MEM_REG_VAL);
43 
44 	/*
45 	 * Enable HAP INTA (interrupt from management bus) to
46 	 * wake device's PCI Express link L1a -> L0s
47 	 */
48 	iwl_set_bit(trans, CSR_HW_IF_CONFIG_REG,
49 		    CSR_HW_IF_CONFIG_REG_BIT_HAP_WAKE_L1A);
50 
51 	iwl_pcie_apm_config(trans);
52 
53 	ret = iwl_finish_nic_init(trans);
54 	if (ret)
55 		return ret;
56 
57 	set_bit(STATUS_DEVICE_ENABLED, &trans->status);
58 
59 	return 0;
60 }
61 
62 static void iwl_pcie_gen2_apm_stop(struct iwl_trans *trans, bool op_mode_leave)
63 {
64 	IWL_DEBUG_INFO(trans, "Stop card, put in low power state\n");
65 
66 	if (op_mode_leave) {
67 		if (!test_bit(STATUS_DEVICE_ENABLED, &trans->status))
68 			iwl_pcie_gen2_apm_init(trans);
69 
70 		/* inform ME that we are leaving */
71 		iwl_set_bit(trans, CSR_DBG_LINK_PWR_MGMT_REG,
72 			    CSR_RESET_LINK_PWR_MGMT_DISABLED);
73 		iwl_set_bit(trans, CSR_HW_IF_CONFIG_REG,
74 			    CSR_HW_IF_CONFIG_REG_PREPARE |
75 			    CSR_HW_IF_CONFIG_REG_ENABLE_PME);
76 		mdelay(1);
77 		iwl_clear_bit(trans, CSR_DBG_LINK_PWR_MGMT_REG,
78 			      CSR_RESET_LINK_PWR_MGMT_DISABLED);
79 		mdelay(5);
80 	}
81 
82 	clear_bit(STATUS_DEVICE_ENABLED, &trans->status);
83 
84 	/* Stop device's DMA activity */
85 	iwl_pcie_apm_stop_master(trans);
86 
87 	iwl_trans_sw_reset(trans);
88 
89 	/*
90 	 * Clear "initialization complete" bit to move adapter from
91 	 * D0A* (powered-up Active) --> D0U* (Uninitialized) state.
92 	 */
93 	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_BZ)
94 		iwl_clear_bit(trans, CSR_GP_CNTRL,
95 			      CSR_GP_CNTRL_REG_FLAG_MAC_INIT);
96 	else
97 		iwl_clear_bit(trans, CSR_GP_CNTRL,
98 			      CSR_GP_CNTRL_REG_FLAG_INIT_DONE);
99 }
100 
101 static void iwl_trans_pcie_fw_reset_handshake(struct iwl_trans *trans)
102 {
103 	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
104 	int ret;
105 
106 	trans_pcie->fw_reset_state = FW_RESET_REQUESTED;
107 
108 	if (trans->trans_cfg->device_family < IWL_DEVICE_FAMILY_AX210)
109 		iwl_write_umac_prph(trans, UREG_NIC_SET_NMI_DRIVER,
110 				    UREG_NIC_SET_NMI_DRIVER_RESET_HANDSHAKE);
111 	else
112 		iwl_write_umac_prph(trans, UREG_DOORBELL_TO_ISR6,
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 		IWL_INFO(trans,
121 			 "firmware didn't ACK the reset - continue anyway\n");
122 		iwl_trans_fw_error(trans, true);
123 	}
124 
125 	trans_pcie->fw_reset_state = FW_RESET_IDLE;
126 }
127 
128 void _iwl_trans_pcie_gen2_stop_device(struct iwl_trans *trans)
129 {
130 	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
131 
132 	lockdep_assert_held(&trans_pcie->mutex);
133 
134 	if (trans_pcie->is_down)
135 		return;
136 
137 	if (trans->state >= IWL_TRANS_FW_STARTED)
138 		if (trans_pcie->fw_reset_handshake)
139 			iwl_trans_pcie_fw_reset_handshake(trans);
140 
141 	trans_pcie->is_down = true;
142 
143 	/* tell the device to stop sending interrupts */
144 	iwl_disable_interrupts(trans);
145 
146 	/* device going down, Stop using ICT table */
147 	iwl_pcie_disable_ict(trans);
148 
149 	/*
150 	 * If a HW restart happens during firmware loading,
151 	 * then the firmware loading might call this function
152 	 * and later it might be called again due to the
153 	 * restart. So don't process again if the device is
154 	 * already dead.
155 	 */
156 	if (test_and_clear_bit(STATUS_DEVICE_ENABLED, &trans->status)) {
157 		IWL_DEBUG_INFO(trans,
158 			       "DEVICE_ENABLED bit was set and is now cleared\n");
159 		iwl_txq_gen2_tx_free(trans);
160 		iwl_pcie_rx_stop(trans);
161 	}
162 
163 	iwl_pcie_ctxt_info_free_paging(trans);
164 	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_AX210)
165 		iwl_pcie_ctxt_info_gen3_free(trans, false);
166 	else
167 		iwl_pcie_ctxt_info_free(trans);
168 
169 	/* Stop the device, and put it in low power state */
170 	iwl_pcie_gen2_apm_stop(trans, false);
171 
172 	iwl_trans_sw_reset(trans);
173 
174 	/*
175 	 * Upon stop, the IVAR table gets erased, so msi-x won't
176 	 * work. This causes a bug in RF-KILL flows, since the interrupt
177 	 * that enables radio won't fire on the correct irq, and the
178 	 * driver won't be able to handle the interrupt.
179 	 * Configure the IVAR table again after reset.
180 	 */
181 	iwl_pcie_conf_msix_hw(trans_pcie);
182 
183 	/*
184 	 * Upon stop, the APM issues an interrupt if HW RF kill is set.
185 	 * This is a bug in certain verions of the hardware.
186 	 * Certain devices also keep sending HW RF kill interrupt all
187 	 * the time, unless the interrupt is ACKed even if the interrupt
188 	 * should be masked. Re-ACK all the interrupts here.
189 	 */
190 	iwl_disable_interrupts(trans);
191 
192 	/* clear all status bits */
193 	clear_bit(STATUS_SYNC_HCMD_ACTIVE, &trans->status);
194 	clear_bit(STATUS_INT_ENABLED, &trans->status);
195 	clear_bit(STATUS_TPOWER_PMI, &trans->status);
196 
197 	/*
198 	 * Even if we stop the HW, we still want the RF kill
199 	 * interrupt
200 	 */
201 	iwl_enable_rfkill_int(trans);
202 
203 	/* re-take ownership to prevent other users from stealing the device */
204 	iwl_pcie_prepare_card_hw(trans);
205 }
206 
207 void iwl_trans_pcie_gen2_stop_device(struct iwl_trans *trans)
208 {
209 	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
210 	bool was_in_rfkill;
211 
212 	iwl_op_mode_time_point(trans->op_mode,
213 			       IWL_FW_INI_TIME_POINT_HOST_DEVICE_DISABLE,
214 			       NULL);
215 
216 	mutex_lock(&trans_pcie->mutex);
217 	trans_pcie->opmode_down = true;
218 	was_in_rfkill = test_bit(STATUS_RFKILL_OPMODE, &trans->status);
219 	_iwl_trans_pcie_gen2_stop_device(trans);
220 	iwl_trans_pcie_handle_stop_rfkill(trans, was_in_rfkill);
221 	mutex_unlock(&trans_pcie->mutex);
222 }
223 
224 static int iwl_pcie_gen2_nic_init(struct iwl_trans *trans)
225 {
226 	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
227 	int queue_size = max_t(u32, IWL_CMD_QUEUE_SIZE,
228 			       trans->cfg->min_txq_size);
229 
230 	/* TODO: most of the logic can be removed in A0 - but not in Z0 */
231 	spin_lock_bh(&trans_pcie->irq_lock);
232 	iwl_pcie_gen2_apm_init(trans);
233 	spin_unlock_bh(&trans_pcie->irq_lock);
234 
235 	iwl_op_mode_nic_config(trans->op_mode);
236 
237 	/* Allocate the RX queue, or reset if it is already allocated */
238 	if (iwl_pcie_gen2_rx_init(trans))
239 		return -ENOMEM;
240 
241 	/* Allocate or reset and init all Tx and Command queues */
242 	if (iwl_txq_gen2_init(trans, trans->txqs.cmd.q_id, queue_size))
243 		return -ENOMEM;
244 
245 	/* enable shadow regs in HW */
246 	iwl_set_bit(trans, CSR_MAC_SHADOW_REG_CTRL, 0x800FFFFF);
247 	IWL_DEBUG_INFO(trans, "Enabling shadow registers in device\n");
248 
249 	return 0;
250 }
251 
252 static void iwl_pcie_get_rf_name(struct iwl_trans *trans)
253 {
254 	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
255 	char *buf = trans_pcie->rf_name;
256 	size_t buflen = sizeof(trans_pcie->rf_name);
257 	size_t pos;
258 	u32 version;
259 
260 	if (buf[0])
261 		return;
262 
263 	switch (CSR_HW_RFID_TYPE(trans->hw_rf_id)) {
264 	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_JF):
265 		pos = scnprintf(buf, buflen, "JF");
266 		break;
267 	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_GF):
268 		pos = scnprintf(buf, buflen, "GF");
269 		break;
270 	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_GF4):
271 		pos = scnprintf(buf, buflen, "GF4");
272 		break;
273 	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HR):
274 		pos = scnprintf(buf, buflen, "HR");
275 		break;
276 	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HR1):
277 		pos = scnprintf(buf, buflen, "HR1");
278 		break;
279 	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HRCDB):
280 		pos = scnprintf(buf, buflen, "HRCDB");
281 		break;
282 	default:
283 		return;
284 	}
285 
286 	switch (CSR_HW_RFID_TYPE(trans->hw_rf_id)) {
287 	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HR):
288 	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HR1):
289 	case CSR_HW_RFID_TYPE(CSR_HW_RF_ID_TYPE_HRCDB):
290 		version = iwl_read_prph(trans, CNVI_MBOX_C);
291 		switch (version) {
292 		case 0x20000:
293 			pos += scnprintf(buf + pos, buflen - pos, " B3");
294 			break;
295 		case 0x120000:
296 			pos += scnprintf(buf + pos, buflen - pos, " B5");
297 			break;
298 		default:
299 			pos += scnprintf(buf + pos, buflen - pos,
300 					 " (0x%x)", version);
301 			break;
302 		}
303 		break;
304 	default:
305 		break;
306 	}
307 
308 	pos += scnprintf(buf + pos, buflen - pos, ", rfid=0x%x",
309 			 trans->hw_rf_id);
310 
311 	IWL_INFO(trans, "Detected RF %s\n", buf);
312 
313 	/*
314 	 * also add a \n for debugfs - need to do it after printing
315 	 * since our IWL_INFO machinery wants to see a static \n at
316 	 * the end of the string
317 	 */
318 	pos += scnprintf(buf + pos, buflen - pos, "\n");
319 }
320 
321 void iwl_trans_pcie_gen2_fw_alive(struct iwl_trans *trans, u32 scd_addr)
322 {
323 	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
324 
325 	iwl_pcie_reset_ict(trans);
326 
327 	/* make sure all queue are not stopped/used */
328 	memset(trans->txqs.queue_stopped, 0,
329 	       sizeof(trans->txqs.queue_stopped));
330 	memset(trans->txqs.queue_used, 0, sizeof(trans->txqs.queue_used));
331 
332 	/* now that we got alive we can free the fw image & the context info.
333 	 * paging memory cannot be freed included since FW will still use it
334 	 */
335 	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_AX210)
336 		iwl_pcie_ctxt_info_gen3_free(trans, true);
337 	else
338 		iwl_pcie_ctxt_info_free(trans);
339 
340 	/*
341 	 * Re-enable all the interrupts, including the RF-Kill one, now that
342 	 * the firmware is alive.
343 	 */
344 	iwl_enable_interrupts(trans);
345 	mutex_lock(&trans_pcie->mutex);
346 	iwl_pcie_check_hw_rf_kill(trans);
347 
348 	iwl_pcie_get_rf_name(trans);
349 	mutex_unlock(&trans_pcie->mutex);
350 }
351 
352 static void iwl_pcie_set_ltr(struct iwl_trans *trans)
353 {
354 	u32 ltr_val = CSR_LTR_LONG_VAL_AD_NO_SNOOP_REQ |
355 		      u32_encode_bits(CSR_LTR_LONG_VAL_AD_SCALE_USEC,
356 				      CSR_LTR_LONG_VAL_AD_NO_SNOOP_SCALE) |
357 		      u32_encode_bits(250,
358 				      CSR_LTR_LONG_VAL_AD_NO_SNOOP_VAL) |
359 		      CSR_LTR_LONG_VAL_AD_SNOOP_REQ |
360 		      u32_encode_bits(CSR_LTR_LONG_VAL_AD_SCALE_USEC,
361 				      CSR_LTR_LONG_VAL_AD_SNOOP_SCALE) |
362 		      u32_encode_bits(250, CSR_LTR_LONG_VAL_AD_SNOOP_VAL);
363 
364 	/*
365 	 * To workaround hardware latency issues during the boot process,
366 	 * initialize the LTR to ~250 usec (see ltr_val above).
367 	 * The firmware initializes this again later (to a smaller value).
368 	 */
369 	if ((trans->trans_cfg->device_family == IWL_DEVICE_FAMILY_AX210 ||
370 	     trans->trans_cfg->device_family == IWL_DEVICE_FAMILY_22000) &&
371 	    !trans->trans_cfg->integrated) {
372 		iwl_write32(trans, CSR_LTR_LONG_VAL_AD, ltr_val);
373 	} else if (trans->trans_cfg->integrated &&
374 		   trans->trans_cfg->device_family == IWL_DEVICE_FAMILY_22000) {
375 		iwl_write_prph(trans, HPM_MAC_LTR_CSR, HPM_MAC_LRT_ENABLE_ALL);
376 		iwl_write_prph(trans, HPM_UMAC_LTR, ltr_val);
377 	}
378 }
379 
380 int iwl_trans_pcie_gen2_start_fw(struct iwl_trans *trans,
381 				 const struct fw_img *fw, bool run_in_rfkill)
382 {
383 	struct iwl_trans_pcie *trans_pcie = IWL_TRANS_GET_PCIE_TRANS(trans);
384 	bool hw_rfkill;
385 	int ret;
386 
387 	/* This may fail if AMT took ownership of the device */
388 	if (iwl_pcie_prepare_card_hw(trans)) {
389 		IWL_WARN(trans, "Exit HW not ready\n");
390 		ret = -EIO;
391 		goto out;
392 	}
393 
394 	iwl_enable_rfkill_int(trans);
395 
396 	iwl_write32(trans, CSR_INT, 0xFFFFFFFF);
397 
398 	/*
399 	 * We enabled the RF-Kill interrupt and the handler may very
400 	 * well be running. Disable the interrupts to make sure no other
401 	 * interrupt can be fired.
402 	 */
403 	iwl_disable_interrupts(trans);
404 
405 	/* Make sure it finished running */
406 	iwl_pcie_synchronize_irqs(trans);
407 
408 	mutex_lock(&trans_pcie->mutex);
409 
410 	/* If platform's RF_KILL switch is NOT set to KILL */
411 	hw_rfkill = iwl_pcie_check_hw_rf_kill(trans);
412 	if (hw_rfkill && !run_in_rfkill) {
413 		ret = -ERFKILL;
414 		goto out;
415 	}
416 
417 	/* Someone called stop_device, don't try to start_fw */
418 	if (trans_pcie->is_down) {
419 		IWL_WARN(trans,
420 			 "Can't start_fw since the HW hasn't been started\n");
421 		ret = -EIO;
422 		goto out;
423 	}
424 
425 	/* make sure rfkill handshake bits are cleared */
426 	iwl_write32(trans, CSR_UCODE_DRV_GP1_CLR, CSR_UCODE_SW_BIT_RFKILL);
427 	iwl_write32(trans, CSR_UCODE_DRV_GP1_CLR,
428 		    CSR_UCODE_DRV_GP1_BIT_CMD_BLOCKED);
429 
430 	/* clear (again), then enable host interrupts */
431 	iwl_write32(trans, CSR_INT, 0xFFFFFFFF);
432 
433 	ret = iwl_pcie_gen2_nic_init(trans);
434 	if (ret) {
435 		IWL_ERR(trans, "Unable to init nic\n");
436 		goto out;
437 	}
438 
439 	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_AX210)
440 		ret = iwl_pcie_ctxt_info_gen3_init(trans, fw);
441 	else
442 		ret = iwl_pcie_ctxt_info_init(trans, fw);
443 	if (ret)
444 		goto out;
445 
446 	iwl_pcie_set_ltr(trans);
447 
448 	if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_BZ) {
449 		iwl_write32(trans, CSR_FUNC_SCRATCH, CSR_FUNC_SCRATCH_INIT_VALUE);
450 		iwl_set_bit(trans, CSR_GP_CNTRL,
451 			    CSR_GP_CNTRL_REG_FLAG_ROM_START);
452 	} else if (trans->trans_cfg->device_family >= IWL_DEVICE_FAMILY_AX210) {
453 		iwl_write_umac_prph(trans, UREG_CPU_INIT_RUN, 1);
454 	} else {
455 		iwl_write_prph(trans, UREG_CPU_INIT_RUN, 1);
456 	}
457 
458 	/* re-check RF-Kill state since we may have missed the interrupt */
459 	hw_rfkill = iwl_pcie_check_hw_rf_kill(trans);
460 	if (hw_rfkill && !run_in_rfkill)
461 		ret = -ERFKILL;
462 
463 out:
464 	mutex_unlock(&trans_pcie->mutex);
465 	return ret;
466 }
467