1ba764c4dSAlex Elder // SPDX-License-Identifier: GPL-2.0 2ba764c4dSAlex Elder 3ba764c4dSAlex Elder /* Copyright (c) 2014-2018, The Linux Foundation. All rights reserved. 4*a4388da5SAlex Elder * Copyright (C) 2018-2022 Linaro Ltd. 5ba764c4dSAlex Elder */ 6ba764c4dSAlex Elder 7ba764c4dSAlex Elder /* DOC: IPA Interrupts 8ba764c4dSAlex Elder * 9ba764c4dSAlex Elder * The IPA has an interrupt line distinct from the interrupt used by the GSI 10ba764c4dSAlex Elder * code. Whereas GSI interrupts are generally related to channel events (like 11ba764c4dSAlex Elder * transfer completions), IPA interrupts are related to other events related 12ba764c4dSAlex Elder * to the IPA. Some of the IPA interrupts come from a microcontroller 13ba764c4dSAlex Elder * embedded in the IPA. Each IPA interrupt type can be both masked and 14ba764c4dSAlex Elder * acknowledged independent of the others. 15ba764c4dSAlex Elder * 16ba764c4dSAlex Elder * Two of the IPA interrupts are initiated by the microcontroller. A third 17ba764c4dSAlex Elder * can be generated to signal the need for a wakeup/resume when an IPA 18ba764c4dSAlex Elder * endpoint has been suspended. There are other IPA events, but at this 19ba764c4dSAlex Elder * time only these three are supported. 20ba764c4dSAlex Elder */ 21ba764c4dSAlex Elder 22ba764c4dSAlex Elder #include <linux/types.h> 23ba764c4dSAlex Elder #include <linux/interrupt.h> 24c3f115aaSAlex Elder #include <linux/pm_runtime.h> 25ba764c4dSAlex Elder 26ba764c4dSAlex Elder #include "ipa.h" 27ba764c4dSAlex Elder #include "ipa_reg.h" 28ba764c4dSAlex Elder #include "ipa_endpoint.h" 29ba764c4dSAlex Elder #include "ipa_interrupt.h" 30ba764c4dSAlex Elder 31ba764c4dSAlex Elder /** 32ba764c4dSAlex Elder * struct ipa_interrupt - IPA interrupt information 33ba764c4dSAlex Elder * @ipa: IPA pointer 34ba764c4dSAlex Elder * @irq: Linux IRQ number used for IPA interrupts 35ba764c4dSAlex Elder * @enabled: Mask indicating which interrupts are enabled 36ba764c4dSAlex Elder * @handler: Array of handlers indexed by IPA interrupt ID 37ba764c4dSAlex Elder */ 38ba764c4dSAlex Elder struct ipa_interrupt { 39ba764c4dSAlex Elder struct ipa *ipa; 40ba764c4dSAlex Elder u32 irq; 41ba764c4dSAlex Elder u32 enabled; 42ba764c4dSAlex Elder ipa_irq_handler_t handler[IPA_IRQ_COUNT]; 43ba764c4dSAlex Elder }; 44ba764c4dSAlex Elder 45ba764c4dSAlex Elder /* Returns true if the interrupt type is associated with the microcontroller */ 46ba764c4dSAlex Elder static bool ipa_interrupt_uc(struct ipa_interrupt *interrupt, u32 irq_id) 47ba764c4dSAlex Elder { 48ba764c4dSAlex Elder return irq_id == IPA_IRQ_UC_0 || irq_id == IPA_IRQ_UC_1; 49ba764c4dSAlex Elder } 50ba764c4dSAlex Elder 51ba764c4dSAlex Elder /* Process a particular interrupt type that has been received */ 52ba764c4dSAlex Elder static void ipa_interrupt_process(struct ipa_interrupt *interrupt, u32 irq_id) 53ba764c4dSAlex Elder { 54ba764c4dSAlex Elder bool uc_irq = ipa_interrupt_uc(interrupt, irq_id); 55ba764c4dSAlex Elder struct ipa *ipa = interrupt->ipa; 566a244b75SAlex Elder const struct ipa_reg *reg; 57ba764c4dSAlex Elder u32 mask = BIT(irq_id); 58e666aa97SAlex Elder u32 offset; 59ba764c4dSAlex Elder 60ba764c4dSAlex Elder /* For microcontroller interrupts, clear the interrupt right away, 61ba764c4dSAlex Elder * "to avoid clearing unhandled interrupts." 62ba764c4dSAlex Elder */ 636a244b75SAlex Elder reg = ipa_reg(ipa, IPA_IRQ_CLR); 646a244b75SAlex Elder offset = ipa_reg_offset(reg); 65ba764c4dSAlex Elder if (uc_irq) 66e666aa97SAlex Elder iowrite32(mask, ipa->reg_virt + offset); 67ba764c4dSAlex Elder 68ba764c4dSAlex Elder if (irq_id < IPA_IRQ_COUNT && interrupt->handler[irq_id]) 69ba764c4dSAlex Elder interrupt->handler[irq_id](interrupt->ipa, irq_id); 70ba764c4dSAlex Elder 71ba764c4dSAlex Elder /* Clearing the SUSPEND_TX interrupt also clears the register 72ba764c4dSAlex Elder * that tells us which suspended endpoint(s) caused the interrupt, 73ba764c4dSAlex Elder * so defer clearing until after the handler has been called. 74ba764c4dSAlex Elder */ 75ba764c4dSAlex Elder if (!uc_irq) 76e666aa97SAlex Elder iowrite32(mask, ipa->reg_virt + offset); 77ba764c4dSAlex Elder } 78ba764c4dSAlex Elder 79176086d8SAlex Elder /* IPA IRQ handler is threaded */ 80176086d8SAlex Elder static irqreturn_t ipa_isr_thread(int irq, void *dev_id) 81ba764c4dSAlex Elder { 82176086d8SAlex Elder struct ipa_interrupt *interrupt = dev_id; 83ba764c4dSAlex Elder struct ipa *ipa = interrupt->ipa; 84ba764c4dSAlex Elder u32 enabled = interrupt->enabled; 856a244b75SAlex Elder const struct ipa_reg *reg; 86c3f115aaSAlex Elder struct device *dev; 87e70e410fSAlex Elder u32 pending; 88e666aa97SAlex Elder u32 offset; 89ba764c4dSAlex Elder u32 mask; 907ebd168cSAlex Elder int ret; 91ba764c4dSAlex Elder 92c3f115aaSAlex Elder dev = &ipa->pdev->dev; 93c3f115aaSAlex Elder ret = pm_runtime_get_sync(dev); 947ebd168cSAlex Elder if (WARN_ON(ret < 0)) 95c3f115aaSAlex Elder goto out_power_put; 96176086d8SAlex Elder 97ba764c4dSAlex Elder /* The status register indicates which conditions are present, 98ba764c4dSAlex Elder * including conditions whose interrupt is not enabled. Handle 99ba764c4dSAlex Elder * only the enabled ones. 100ba764c4dSAlex Elder */ 1016a244b75SAlex Elder reg = ipa_reg(ipa, IPA_IRQ_STTS); 1026a244b75SAlex Elder offset = ipa_reg_offset(reg); 103e70e410fSAlex Elder pending = ioread32(ipa->reg_virt + offset); 104e70e410fSAlex Elder while ((mask = pending & enabled)) { 105ba764c4dSAlex Elder do { 106ba764c4dSAlex Elder u32 irq_id = __ffs(mask); 107ba764c4dSAlex Elder 108ba764c4dSAlex Elder mask ^= BIT(irq_id); 109ba764c4dSAlex Elder 110ba764c4dSAlex Elder ipa_interrupt_process(interrupt, irq_id); 111ba764c4dSAlex Elder } while (mask); 112e70e410fSAlex Elder pending = ioread32(ipa->reg_virt + offset); 113e70e410fSAlex Elder } 114e70e410fSAlex Elder 115e70e410fSAlex Elder /* If any disabled interrupts are pending, clear them */ 116e70e410fSAlex Elder if (pending) { 117e70e410fSAlex Elder dev_dbg(dev, "clearing disabled IPA interrupts 0x%08x\n", 118e70e410fSAlex Elder pending); 1196a244b75SAlex Elder reg = ipa_reg(ipa, IPA_IRQ_CLR); 1206a244b75SAlex Elder offset = ipa_reg_offset(reg); 121e70e410fSAlex Elder iowrite32(pending, ipa->reg_virt + offset); 122ba764c4dSAlex Elder } 123c3f115aaSAlex Elder out_power_put: 1241aac309dSAlex Elder pm_runtime_mark_last_busy(dev); 1251aac309dSAlex Elder (void)pm_runtime_put_autosuspend(dev); 126937a0da4SAlex Elder 127ba764c4dSAlex Elder return IRQ_HANDLED; 128ba764c4dSAlex Elder } 129ba764c4dSAlex Elder 130ba764c4dSAlex Elder /* Common function used to enable/disable TX_SUSPEND for an endpoint */ 131ba764c4dSAlex Elder static void ipa_interrupt_suspend_control(struct ipa_interrupt *interrupt, 132ba764c4dSAlex Elder u32 endpoint_id, bool enable) 133ba764c4dSAlex Elder { 134ba764c4dSAlex Elder struct ipa *ipa = interrupt->ipa; 135ba764c4dSAlex Elder u32 mask = BIT(endpoint_id); 1366a244b75SAlex Elder const struct ipa_reg *reg; 137e666aa97SAlex Elder u32 offset; 138ba764c4dSAlex Elder u32 val; 139ba764c4dSAlex Elder 1405bc55884SAlex Elder WARN_ON(!(mask & ipa->available)); 141e666aa97SAlex Elder 142e666aa97SAlex Elder /* IPA version 3.0 does not support TX_SUSPEND interrupt control */ 143e666aa97SAlex Elder if (ipa->version == IPA_VERSION_3_0) 144e666aa97SAlex Elder return; 145e666aa97SAlex Elder 1466a244b75SAlex Elder reg = ipa_reg(ipa, IRQ_SUSPEND_EN); 1476a244b75SAlex Elder offset = ipa_reg_offset(reg); 148e666aa97SAlex Elder val = ioread32(ipa->reg_virt + offset); 149ba764c4dSAlex Elder if (enable) 150ba764c4dSAlex Elder val |= mask; 151ba764c4dSAlex Elder else 152ba764c4dSAlex Elder val &= ~mask; 153e666aa97SAlex Elder iowrite32(val, ipa->reg_virt + offset); 154ba764c4dSAlex Elder } 155ba764c4dSAlex Elder 156ba764c4dSAlex Elder /* Enable TX_SUSPEND for an endpoint */ 157ba764c4dSAlex Elder void 158ba764c4dSAlex Elder ipa_interrupt_suspend_enable(struct ipa_interrupt *interrupt, u32 endpoint_id) 159ba764c4dSAlex Elder { 160ba764c4dSAlex Elder ipa_interrupt_suspend_control(interrupt, endpoint_id, true); 161ba764c4dSAlex Elder } 162ba764c4dSAlex Elder 163ba764c4dSAlex Elder /* Disable TX_SUSPEND for an endpoint */ 164ba764c4dSAlex Elder void 165ba764c4dSAlex Elder ipa_interrupt_suspend_disable(struct ipa_interrupt *interrupt, u32 endpoint_id) 166ba764c4dSAlex Elder { 167ba764c4dSAlex Elder ipa_interrupt_suspend_control(interrupt, endpoint_id, false); 168ba764c4dSAlex Elder } 169ba764c4dSAlex Elder 170ba764c4dSAlex Elder /* Clear the suspend interrupt for all endpoints that signaled it */ 171ba764c4dSAlex Elder void ipa_interrupt_suspend_clear_all(struct ipa_interrupt *interrupt) 172ba764c4dSAlex Elder { 173ba764c4dSAlex Elder struct ipa *ipa = interrupt->ipa; 1746a244b75SAlex Elder const struct ipa_reg *reg; 175ba764c4dSAlex Elder u32 val; 176ba764c4dSAlex Elder 1776a244b75SAlex Elder reg = ipa_reg(ipa, IRQ_SUSPEND_INFO); 1786a244b75SAlex Elder val = ioread32(ipa->reg_virt + ipa_reg_offset(reg)); 179e666aa97SAlex Elder 180e666aa97SAlex Elder /* SUSPEND interrupt status isn't cleared on IPA version 3.0 */ 181e666aa97SAlex Elder if (ipa->version == IPA_VERSION_3_0) 182e666aa97SAlex Elder return; 183e666aa97SAlex Elder 1846a244b75SAlex Elder reg = ipa_reg(ipa, IRQ_SUSPEND_CLR); 1856a244b75SAlex Elder iowrite32(val, ipa->reg_virt + ipa_reg_offset(reg)); 186ba764c4dSAlex Elder } 187ba764c4dSAlex Elder 188ba764c4dSAlex Elder /* Simulate arrival of an IPA TX_SUSPEND interrupt */ 189ba764c4dSAlex Elder void ipa_interrupt_simulate_suspend(struct ipa_interrupt *interrupt) 190ba764c4dSAlex Elder { 191ba764c4dSAlex Elder ipa_interrupt_process(interrupt, IPA_IRQ_TX_SUSPEND); 192ba764c4dSAlex Elder } 193ba764c4dSAlex Elder 194ba764c4dSAlex Elder /* Add a handler for an IPA interrupt */ 195ba764c4dSAlex Elder void ipa_interrupt_add(struct ipa_interrupt *interrupt, 196ba764c4dSAlex Elder enum ipa_irq_id ipa_irq, ipa_irq_handler_t handler) 197ba764c4dSAlex Elder { 198ba764c4dSAlex Elder struct ipa *ipa = interrupt->ipa; 1996a244b75SAlex Elder const struct ipa_reg *reg; 200ba764c4dSAlex Elder 2011172aa6eSJakub Kicinski if (WARN_ON(ipa_irq >= IPA_IRQ_COUNT)) 2021172aa6eSJakub Kicinski return; 2035bc55884SAlex Elder 204ba764c4dSAlex Elder interrupt->handler[ipa_irq] = handler; 205ba764c4dSAlex Elder 206ba764c4dSAlex Elder /* Update the IPA interrupt mask to enable it */ 207ba764c4dSAlex Elder interrupt->enabled |= BIT(ipa_irq); 2086a244b75SAlex Elder 2096a244b75SAlex Elder reg = ipa_reg(ipa, IPA_IRQ_EN); 2106a244b75SAlex Elder iowrite32(interrupt->enabled, ipa->reg_virt + ipa_reg_offset(reg)); 211ba764c4dSAlex Elder } 212ba764c4dSAlex Elder 213ba764c4dSAlex Elder /* Remove the handler for an IPA interrupt type */ 214ba764c4dSAlex Elder void 215ba764c4dSAlex Elder ipa_interrupt_remove(struct ipa_interrupt *interrupt, enum ipa_irq_id ipa_irq) 216ba764c4dSAlex Elder { 217ba764c4dSAlex Elder struct ipa *ipa = interrupt->ipa; 2186a244b75SAlex Elder const struct ipa_reg *reg; 219ba764c4dSAlex Elder 2201172aa6eSJakub Kicinski if (WARN_ON(ipa_irq >= IPA_IRQ_COUNT)) 2211172aa6eSJakub Kicinski return; 2225bc55884SAlex Elder 223ba764c4dSAlex Elder /* Update the IPA interrupt mask to disable it */ 224ba764c4dSAlex Elder interrupt->enabled &= ~BIT(ipa_irq); 2256a244b75SAlex Elder 2266a244b75SAlex Elder reg = ipa_reg(ipa, IPA_IRQ_EN); 2276a244b75SAlex Elder iowrite32(interrupt->enabled, ipa->reg_virt + ipa_reg_offset(reg)); 228ba764c4dSAlex Elder 229ba764c4dSAlex Elder interrupt->handler[ipa_irq] = NULL; 230ba764c4dSAlex Elder } 231ba764c4dSAlex Elder 2321118a147SAlex Elder /* Configure the IPA interrupt framework */ 2331118a147SAlex Elder struct ipa_interrupt *ipa_interrupt_config(struct ipa *ipa) 234ba764c4dSAlex Elder { 235ba764c4dSAlex Elder struct device *dev = &ipa->pdev->dev; 236ba764c4dSAlex Elder struct ipa_interrupt *interrupt; 2376a244b75SAlex Elder const struct ipa_reg *reg; 238ba764c4dSAlex Elder unsigned int irq; 239ba764c4dSAlex Elder int ret; 240ba764c4dSAlex Elder 241ba764c4dSAlex Elder ret = platform_get_irq_byname(ipa->pdev, "ipa"); 242ba764c4dSAlex Elder if (ret <= 0) { 243ba764c4dSAlex Elder dev_err(dev, "DT error %d getting \"ipa\" IRQ property\n", 244ba764c4dSAlex Elder ret); 245ba764c4dSAlex Elder return ERR_PTR(ret ? : -EINVAL); 246ba764c4dSAlex Elder } 247ba764c4dSAlex Elder irq = ret; 248ba764c4dSAlex Elder 249ba764c4dSAlex Elder interrupt = kzalloc(sizeof(*interrupt), GFP_KERNEL); 250ba764c4dSAlex Elder if (!interrupt) 251ba764c4dSAlex Elder return ERR_PTR(-ENOMEM); 252ba764c4dSAlex Elder interrupt->ipa = ipa; 253ba764c4dSAlex Elder interrupt->irq = irq; 254ba764c4dSAlex Elder 255ba764c4dSAlex Elder /* Start with all IPA interrupts disabled */ 2566a244b75SAlex Elder reg = ipa_reg(ipa, IPA_IRQ_EN); 2576a244b75SAlex Elder iowrite32(0, ipa->reg_virt + ipa_reg_offset(reg)); 258ba764c4dSAlex Elder 259937a0da4SAlex Elder ret = request_threaded_irq(irq, NULL, ipa_isr_thread, IRQF_ONESHOT, 260ba764c4dSAlex Elder "ipa", interrupt); 261ba764c4dSAlex Elder if (ret) { 262ba764c4dSAlex Elder dev_err(dev, "error %d requesting \"ipa\" IRQ\n", ret); 263ba764c4dSAlex Elder goto err_kfree; 264ba764c4dSAlex Elder } 265ba764c4dSAlex Elder 266d1b5126aSAlex Elder ret = enable_irq_wake(irq); 267d1b5126aSAlex Elder if (ret) { 268d1b5126aSAlex Elder dev_err(dev, "error %d enabling wakeup for \"ipa\" IRQ\n", ret); 269d1b5126aSAlex Elder goto err_free_irq; 270d1b5126aSAlex Elder } 271d1b5126aSAlex Elder 272ba764c4dSAlex Elder return interrupt; 273ba764c4dSAlex Elder 274d1b5126aSAlex Elder err_free_irq: 275d1b5126aSAlex Elder free_irq(interrupt->irq, interrupt); 276ba764c4dSAlex Elder err_kfree: 277ba764c4dSAlex Elder kfree(interrupt); 278ba764c4dSAlex Elder 279ba764c4dSAlex Elder return ERR_PTR(ret); 280ba764c4dSAlex Elder } 281ba764c4dSAlex Elder 2821118a147SAlex Elder /* Inverse of ipa_interrupt_config() */ 2831118a147SAlex Elder void ipa_interrupt_deconfig(struct ipa_interrupt *interrupt) 284ba764c4dSAlex Elder { 285d1b5126aSAlex Elder struct device *dev = &interrupt->ipa->pdev->dev; 286d1b5126aSAlex Elder int ret; 287d1b5126aSAlex Elder 288d1b5126aSAlex Elder ret = disable_irq_wake(interrupt->irq); 289d1b5126aSAlex Elder if (ret) 290d1b5126aSAlex Elder dev_err(dev, "error %d disabling \"ipa\" IRQ wakeup\n", ret); 291ba764c4dSAlex Elder free_irq(interrupt->irq, interrupt); 292ba764c4dSAlex Elder kfree(interrupt); 293ba764c4dSAlex Elder } 294