2 * Copyright (c) 2012-2014 Qualcomm Atheros, Inc.
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 #include <linux/interrupt.h>
23 * Theory of operation:
25 * There is ISR pseudo-cause register,
26 * dma_rgf->DMA_RGF.PSEUDO_CAUSE.PSEUDO_CAUSE
27 * Its bits represents OR'ed bits from 3 real ISR registers:
30 * Registers may be configured to either "write 1 to clear" or
31 * "clear on read" mode
33 * When handling interrupt, one have to mask/unmask interrupts for the
34 * real ISR registers, or hardware may malfunction.
38 #define WIL6210_IRQ_DISABLE (0xFFFFFFFFUL)
39 #define WIL6210_IMC_RX BIT_DMA_EP_RX_ICR_RX_DONE
40 #define WIL6210_IMC_TX (BIT_DMA_EP_TX_ICR_TX_DONE | \
41 BIT_DMA_EP_TX_ICR_TX_DONE_N(0))
42 #define WIL6210_IMC_MISC (ISR_MISC_FW_READY | \
46 #define WIL6210_IRQ_PSEUDO_MASK (u32)(~(BIT_DMA_PSEUDO_CAUSE_RX | \
47 BIT_DMA_PSEUDO_CAUSE_TX | \
48 BIT_DMA_PSEUDO_CAUSE_MISC))
50 #if defined(CONFIG_WIL6210_ISR_COR)
51 /* configure to Clear-On-Read mode */
52 #define WIL_ICR_ICC_VALUE (0xFFFFFFFFUL)
54 static inline void wil_icr_clear(u32 x, void __iomem *addr)
57 #else /* defined(CONFIG_WIL6210_ISR_COR) */
58 /* configure to Write-1-to-Clear mode */
59 #define WIL_ICR_ICC_VALUE (0UL)
61 static inline void wil_icr_clear(u32 x, void __iomem *addr)
65 #endif /* defined(CONFIG_WIL6210_ISR_COR) */
67 static inline u32 wil_ioread32_and_clear(void __iomem *addr)
69 u32 x = ioread32(addr);
71 wil_icr_clear(x, addr);
76 static void wil6210_mask_irq_tx(struct wil6210_priv *wil)
78 iowrite32(WIL6210_IRQ_DISABLE, wil->csr +
79 HOSTADDR(RGF_DMA_EP_TX_ICR) +
80 offsetof(struct RGF_ICR, IMS));
83 static void wil6210_mask_irq_rx(struct wil6210_priv *wil)
85 iowrite32(WIL6210_IRQ_DISABLE, wil->csr +
86 HOSTADDR(RGF_DMA_EP_RX_ICR) +
87 offsetof(struct RGF_ICR, IMS));
90 static void wil6210_mask_irq_misc(struct wil6210_priv *wil)
92 iowrite32(WIL6210_IRQ_DISABLE, wil->csr +
93 HOSTADDR(RGF_DMA_EP_MISC_ICR) +
94 offsetof(struct RGF_ICR, IMS));
97 static void wil6210_mask_irq_pseudo(struct wil6210_priv *wil)
99 wil_dbg_irq(wil, "%s()\n", __func__);
101 iowrite32(WIL6210_IRQ_DISABLE, wil->csr +
102 HOSTADDR(RGF_DMA_PSEUDO_CAUSE_MASK_SW));
104 clear_bit(wil_status_irqen, &wil->status);
107 void wil6210_unmask_irq_tx(struct wil6210_priv *wil)
109 iowrite32(WIL6210_IMC_TX, wil->csr +
110 HOSTADDR(RGF_DMA_EP_TX_ICR) +
111 offsetof(struct RGF_ICR, IMC));
114 void wil6210_unmask_irq_rx(struct wil6210_priv *wil)
116 iowrite32(WIL6210_IMC_RX, wil->csr +
117 HOSTADDR(RGF_DMA_EP_RX_ICR) +
118 offsetof(struct RGF_ICR, IMC));
121 static void wil6210_unmask_irq_misc(struct wil6210_priv *wil)
123 iowrite32(WIL6210_IMC_MISC, wil->csr +
124 HOSTADDR(RGF_DMA_EP_MISC_ICR) +
125 offsetof(struct RGF_ICR, IMC));
128 static void wil6210_unmask_irq_pseudo(struct wil6210_priv *wil)
130 wil_dbg_irq(wil, "%s()\n", __func__);
132 set_bit(wil_status_irqen, &wil->status);
134 iowrite32(WIL6210_IRQ_PSEUDO_MASK, wil->csr +
135 HOSTADDR(RGF_DMA_PSEUDO_CAUSE_MASK_SW));
138 void wil_mask_irq(struct wil6210_priv *wil)
140 wil_dbg_irq(wil, "%s()\n", __func__);
142 wil6210_mask_irq_tx(wil);
143 wil6210_mask_irq_rx(wil);
144 wil6210_mask_irq_misc(wil);
145 wil6210_mask_irq_pseudo(wil);
148 void wil_unmask_irq(struct wil6210_priv *wil)
150 wil_dbg_irq(wil, "%s()\n", __func__);
152 iowrite32(WIL_ICR_ICC_VALUE, wil->csr + HOSTADDR(RGF_DMA_EP_RX_ICR) +
153 offsetof(struct RGF_ICR, ICC));
154 iowrite32(WIL_ICR_ICC_VALUE, wil->csr + HOSTADDR(RGF_DMA_EP_TX_ICR) +
155 offsetof(struct RGF_ICR, ICC));
156 iowrite32(WIL_ICR_ICC_VALUE, wil->csr + HOSTADDR(RGF_DMA_EP_MISC_ICR) +
157 offsetof(struct RGF_ICR, ICC));
159 /* interrupt moderation parameters */
160 wil_set_itr_trsh(wil);
162 wil6210_unmask_irq_pseudo(wil);
163 wil6210_unmask_irq_tx(wil);
164 wil6210_unmask_irq_rx(wil);
165 wil6210_unmask_irq_misc(wil);
168 static irqreturn_t wil6210_irq_rx(int irq, void *cookie)
170 struct wil6210_priv *wil = cookie;
171 u32 isr = wil_ioread32_and_clear(wil->csr +
172 HOSTADDR(RGF_DMA_EP_RX_ICR) +
173 offsetof(struct RGF_ICR, ICR));
175 trace_wil6210_irq_rx(isr);
176 wil_dbg_irq(wil, "ISR RX 0x%08x\n", isr);
179 wil_err(wil, "spurious IRQ: RX\n");
183 wil6210_mask_irq_rx(wil);
185 if (isr & BIT_DMA_EP_RX_ICR_RX_DONE) {
186 wil_dbg_irq(wil, "RX done\n");
187 isr &= ~BIT_DMA_EP_RX_ICR_RX_DONE;
188 if (test_bit(wil_status_reset_done, &wil->status)) {
189 if (test_bit(wil_status_napi_en, &wil->status)) {
190 wil_dbg_txrx(wil, "NAPI(Rx) schedule\n");
191 napi_schedule(&wil->napi_rx);
193 wil_err(wil, "Got Rx interrupt while "
194 "stopping interface\n");
197 wil_err(wil, "Got Rx interrupt while in reset\n");
202 wil_err(wil, "un-handled RX ISR bits 0x%08x\n", isr);
204 /* Rx IRQ will be enabled when NAPI processing finished */
206 atomic_inc(&wil->isr_count_rx);
210 static irqreturn_t wil6210_irq_tx(int irq, void *cookie)
212 struct wil6210_priv *wil = cookie;
213 u32 isr = wil_ioread32_and_clear(wil->csr +
214 HOSTADDR(RGF_DMA_EP_TX_ICR) +
215 offsetof(struct RGF_ICR, ICR));
217 trace_wil6210_irq_tx(isr);
218 wil_dbg_irq(wil, "ISR TX 0x%08x\n", isr);
221 wil_err(wil, "spurious IRQ: TX\n");
225 wil6210_mask_irq_tx(wil);
227 if (isr & BIT_DMA_EP_TX_ICR_TX_DONE) {
228 wil_dbg_irq(wil, "TX done\n");
229 isr &= ~BIT_DMA_EP_TX_ICR_TX_DONE;
230 /* clear also all VRING interrupts */
231 isr &= ~(BIT(25) - 1UL);
232 if (test_bit(wil_status_reset_done, &wil->status)) {
233 wil_dbg_txrx(wil, "NAPI(Tx) schedule\n");
234 napi_schedule(&wil->napi_tx);
236 wil_err(wil, "Got Tx interrupt while in reset\n");
241 wil_err(wil, "un-handled TX ISR bits 0x%08x\n", isr);
243 /* Tx IRQ will be enabled when NAPI processing finished */
245 atomic_inc(&wil->isr_count_tx);
249 static void wil_notify_fw_error(struct wil6210_priv *wil)
251 struct device *dev = &wil_to_ndev(wil)->dev;
253 [0] = "SOURCE=wil6210",
254 [1] = "EVENT=FW_ERROR",
257 wil_err(wil, "Notify about firmware error\n");
258 kobject_uevent_env(&dev->kobj, KOBJ_CHANGE, envp);
261 static void wil_cache_mbox_regs(struct wil6210_priv *wil)
263 /* make shadow copy of registers that should not change on run time */
264 wil_memcpy_fromio_32(&wil->mbox_ctl, wil->csr + HOST_MBOX,
265 sizeof(struct wil6210_mbox_ctl));
266 wil_mbox_ring_le2cpus(&wil->mbox_ctl.rx);
267 wil_mbox_ring_le2cpus(&wil->mbox_ctl.tx);
270 static irqreturn_t wil6210_irq_misc(int irq, void *cookie)
272 struct wil6210_priv *wil = cookie;
273 u32 isr = wil_ioread32_and_clear(wil->csr +
274 HOSTADDR(RGF_DMA_EP_MISC_ICR) +
275 offsetof(struct RGF_ICR, ICR));
277 trace_wil6210_irq_misc(isr);
278 wil_dbg_irq(wil, "ISR MISC 0x%08x\n", isr);
281 wil_err(wil, "spurious IRQ: MISC\n");
285 wil6210_mask_irq_misc(wil);
287 if (isr & ISR_MISC_FW_ERROR) {
288 wil_err(wil, "Firmware error detected\n");
289 clear_bit(wil_status_fwready, &wil->status);
291 * do not clear @isr here - we do 2-nd part in thread
292 * there, user space get notified, and it should be done
293 * in non-atomic context
297 if (isr & ISR_MISC_FW_READY) {
298 wil_dbg_irq(wil, "IRQ: FW ready\n");
299 wil_cache_mbox_regs(wil);
300 set_bit(wil_status_reset_done, &wil->status);
302 * Actual FW ready indicated by the
303 * WMI_FW_READY_EVENTID
305 isr &= ~ISR_MISC_FW_READY;
311 return IRQ_WAKE_THREAD;
313 wil6210_unmask_irq_misc(wil);
318 static irqreturn_t wil6210_irq_misc_thread(int irq, void *cookie)
320 struct wil6210_priv *wil = cookie;
321 u32 isr = wil->isr_misc;
323 trace_wil6210_irq_misc_thread(isr);
324 wil_dbg_irq(wil, "Thread ISR MISC 0x%08x\n", isr);
326 if (isr & ISR_MISC_FW_ERROR) {
327 wil_notify_fw_error(wil);
328 isr &= ~ISR_MISC_FW_ERROR;
329 wil_fw_error_recovery(wil);
332 if (isr & ISR_MISC_MBOX_EVT) {
333 wil_dbg_irq(wil, "MBOX event\n");
335 isr &= ~ISR_MISC_MBOX_EVT;
339 wil_dbg_irq(wil, "un-handled MISC ISR bits 0x%08x\n", isr);
343 wil6210_unmask_irq_misc(wil);
351 static irqreturn_t wil6210_thread_irq(int irq, void *cookie)
353 struct wil6210_priv *wil = cookie;
355 wil_dbg_irq(wil, "Thread IRQ\n");
356 /* Discover real IRQ cause */
358 wil6210_irq_misc_thread(irq, cookie);
360 wil6210_unmask_irq_pseudo(wil);
366 * There is subtle bug in hardware that causes IRQ to raise when it should be
367 * masked. It is quite rare and hard to debug.
369 * Catch irq issue if it happens and print all I can.
371 static int wil6210_debug_irq_mask(struct wil6210_priv *wil, u32 pseudo_cause)
373 if (!test_bit(wil_status_irqen, &wil->status)) {
374 u32 icm_rx = wil_ioread32_and_clear(wil->csr +
375 HOSTADDR(RGF_DMA_EP_RX_ICR) +
376 offsetof(struct RGF_ICR, ICM));
377 u32 icr_rx = wil_ioread32_and_clear(wil->csr +
378 HOSTADDR(RGF_DMA_EP_RX_ICR) +
379 offsetof(struct RGF_ICR, ICR));
380 u32 imv_rx = ioread32(wil->csr +
381 HOSTADDR(RGF_DMA_EP_RX_ICR) +
382 offsetof(struct RGF_ICR, IMV));
383 u32 icm_tx = wil_ioread32_and_clear(wil->csr +
384 HOSTADDR(RGF_DMA_EP_TX_ICR) +
385 offsetof(struct RGF_ICR, ICM));
386 u32 icr_tx = wil_ioread32_and_clear(wil->csr +
387 HOSTADDR(RGF_DMA_EP_TX_ICR) +
388 offsetof(struct RGF_ICR, ICR));
389 u32 imv_tx = ioread32(wil->csr +
390 HOSTADDR(RGF_DMA_EP_TX_ICR) +
391 offsetof(struct RGF_ICR, IMV));
392 u32 icm_misc = wil_ioread32_and_clear(wil->csr +
393 HOSTADDR(RGF_DMA_EP_MISC_ICR) +
394 offsetof(struct RGF_ICR, ICM));
395 u32 icr_misc = wil_ioread32_and_clear(wil->csr +
396 HOSTADDR(RGF_DMA_EP_MISC_ICR) +
397 offsetof(struct RGF_ICR, ICR));
398 u32 imv_misc = ioread32(wil->csr +
399 HOSTADDR(RGF_DMA_EP_MISC_ICR) +
400 offsetof(struct RGF_ICR, IMV));
401 wil_err(wil, "IRQ when it should be masked: pseudo 0x%08x\n"
402 "Rx icm:icr:imv 0x%08x 0x%08x 0x%08x\n"
403 "Tx icm:icr:imv 0x%08x 0x%08x 0x%08x\n"
404 "Misc icm:icr:imv 0x%08x 0x%08x 0x%08x\n",
406 icm_rx, icr_rx, imv_rx,
407 icm_tx, icr_tx, imv_tx,
408 icm_misc, icr_misc, imv_misc);
416 static irqreturn_t wil6210_hardirq(int irq, void *cookie)
418 irqreturn_t rc = IRQ_HANDLED;
419 struct wil6210_priv *wil = cookie;
420 u32 pseudo_cause = ioread32(wil->csr + HOSTADDR(RGF_DMA_PSEUDO_CAUSE));
423 * pseudo_cause is Clear-On-Read, no need to ACK
425 if ((pseudo_cause == 0) || ((pseudo_cause & 0xff) == 0xff))
428 /* FIXME: IRQ mask debug */
429 if (wil6210_debug_irq_mask(wil, pseudo_cause))
432 trace_wil6210_irq_pseudo(pseudo_cause);
433 wil_dbg_irq(wil, "Pseudo IRQ 0x%08x\n", pseudo_cause);
435 wil6210_mask_irq_pseudo(wil);
437 /* Discover real IRQ cause
438 * There are 2 possible phases for every IRQ:
439 * - hard IRQ handler called right here
440 * - threaded handler called later
442 * Hard IRQ handler reads and clears ISR.
444 * If threaded handler requested, hard IRQ handler
445 * returns IRQ_WAKE_THREAD and saves ISR register value
446 * for the threaded handler use.
448 * voting for wake thread - need at least 1 vote
450 if ((pseudo_cause & BIT_DMA_PSEUDO_CAUSE_RX) &&
451 (wil6210_irq_rx(irq, cookie) == IRQ_WAKE_THREAD))
452 rc = IRQ_WAKE_THREAD;
454 if ((pseudo_cause & BIT_DMA_PSEUDO_CAUSE_TX) &&
455 (wil6210_irq_tx(irq, cookie) == IRQ_WAKE_THREAD))
456 rc = IRQ_WAKE_THREAD;
458 if ((pseudo_cause & BIT_DMA_PSEUDO_CAUSE_MISC) &&
459 (wil6210_irq_misc(irq, cookie) == IRQ_WAKE_THREAD))
460 rc = IRQ_WAKE_THREAD;
462 /* if thread is requested, it will unmask IRQ */
463 if (rc != IRQ_WAKE_THREAD)
464 wil6210_unmask_irq_pseudo(wil);
469 static int wil6210_request_3msi(struct wil6210_priv *wil, int irq)
473 * IRQ's are in the following order:
479 rc = request_irq(irq, wil6210_irq_tx, IRQF_SHARED,
484 rc = request_irq(irq + 1, wil6210_irq_rx, IRQF_SHARED,
489 rc = request_threaded_irq(irq + 2, wil6210_irq_misc,
490 wil6210_irq_misc_thread,
491 IRQF_SHARED, WIL_NAME"_misc", wil);
498 free_irq(irq + 1, wil);
505 /* can't use wil_ioread32_and_clear because ICC value is not set yet */
506 static inline void wil_clear32(void __iomem *addr)
508 u32 x = ioread32(addr);
513 void wil6210_clear_irq(struct wil6210_priv *wil)
515 wil_clear32(wil->csr + HOSTADDR(RGF_DMA_EP_RX_ICR) +
516 offsetof(struct RGF_ICR, ICR));
517 wil_clear32(wil->csr + HOSTADDR(RGF_DMA_EP_TX_ICR) +
518 offsetof(struct RGF_ICR, ICR));
519 wil_clear32(wil->csr + HOSTADDR(RGF_DMA_EP_MISC_ICR) +
520 offsetof(struct RGF_ICR, ICR));
521 wmb(); /* make sure write completed */
524 int wil6210_init_irq(struct wil6210_priv *wil, int irq)
528 wil_dbg_misc(wil, "%s() n_msi=%d\n", __func__, wil->n_msi);
531 rc = wil6210_request_3msi(wil, irq);
533 rc = request_threaded_irq(irq, wil6210_hardirq,
535 wil->n_msi ? 0 : IRQF_SHARED,
540 void wil6210_fini_irq(struct wil6210_priv *wil, int irq)
542 wil_dbg_misc(wil, "%s()\n", __func__);
546 if (wil->n_msi == 3) {
547 free_irq(irq + 1, wil);
548 free_irq(irq + 2, wil);