root/drivers/irqchip/irq-renesas-rzt2h.c
// SPDX-License-Identifier: GPL-2.0

#include <linux/bitfield.h>
#include <linux/err.h>
#include <linux/io.h>
#include <linux/irqchip.h>
#include <linux/irqchip/irq-renesas-rzt2h.h>
#include <linux/irqdomain.h>
#include <linux/of_platform.h>
#include <linux/pm_runtime.h>
#include <linux/reset.h>
#include <linux/spinlock.h>

#define RZT2H_ICU_INTCPU_NS_START               0
#define RZT2H_ICU_INTCPU_NS_COUNT               14

#define RZT2H_ICU_INTCPU_S_START                (RZT2H_ICU_INTCPU_NS_START +    \
                                                 RZT2H_ICU_INTCPU_NS_COUNT)
#define RZT2H_ICU_INTCPU_S_COUNT                2

#define RZT2H_ICU_IRQ_NS_START                  (RZT2H_ICU_INTCPU_S_START +     \
                                                 RZT2H_ICU_INTCPU_S_COUNT)
#define RZT2H_ICU_IRQ_NS_COUNT                  14

#define RZT2H_ICU_IRQ_S_START                   (RZT2H_ICU_IRQ_NS_START +       \
                                                 RZT2H_ICU_IRQ_NS_COUNT)
#define RZT2H_ICU_IRQ_S_COUNT                   2

#define RZT2H_ICU_SEI_START                     (RZT2H_ICU_IRQ_S_START +        \
                                                 RZT2H_ICU_IRQ_S_COUNT)
#define RZT2H_ICU_SEI_COUNT                     1

#define RZT2H_ICU_NUM_IRQ                       (RZT2H_ICU_INTCPU_NS_COUNT +    \
                                                 RZT2H_ICU_INTCPU_S_COUNT +     \
                                                 RZT2H_ICU_IRQ_NS_COUNT +       \
                                                 RZT2H_ICU_IRQ_S_COUNT +        \
                                                 RZT2H_ICU_SEI_COUNT)

#define RZT2H_ICU_IRQ_IN_RANGE(n, type)                                         \
        ((n) >= RZT2H_ICU_##type##_START &&                                     \
         (n) <  RZT2H_ICU_##type##_START + RZT2H_ICU_##type##_COUNT)

#define RZT2H_ICU_PORTNF_MD                     0xc
#define RZT2H_ICU_PORTNF_MDi_MASK(i)            (GENMASK(1, 0) << ((i) * 2))
#define RZT2H_ICU_PORTNF_MDi_PREP(i, val)       (FIELD_PREP(GENMASK(1, 0), val) << ((i) * 2))

#define RZT2H_ICU_MD_LOW_LEVEL                  0b00
#define RZT2H_ICU_MD_FALLING_EDGE               0b01
#define RZT2H_ICU_MD_RISING_EDGE                0b10
#define RZT2H_ICU_MD_BOTH_EDGES                 0b11

#define RZT2H_ICU_DMACn_RSSELi(n, i)            (0x7d0 + 0x18 * (n) + 0x4 * (i))
#define RZT2H_ICU_DMAC_REQ_SELx_MASK(x)         (GENMASK(9, 0) << ((x) * 10))
#define RZT2H_ICU_DMAC_REQ_SELx_PREP(x, val)    (FIELD_PREP(GENMASK(9, 0), val) << ((x) * 10))

struct rzt2h_icu_priv {
        void __iomem            *base_ns;
        void __iomem            *base_s;
        struct irq_fwspec       fwspec[RZT2H_ICU_NUM_IRQ];
        raw_spinlock_t          lock;
};

void rzt2h_icu_register_dma_req(struct platform_device *icu_dev, u8 dmac_index, u8 dmac_channel,
                                u16 req_no)
{
        struct rzt2h_icu_priv *priv = platform_get_drvdata(icu_dev);
        u8 y, upper;
        u32 val;

        y = dmac_channel / 3;
        upper = dmac_channel % 3;

        guard(raw_spinlock_irqsave)(&priv->lock);
        val = readl(priv->base_ns + RZT2H_ICU_DMACn_RSSELi(dmac_index, y));
        val &= ~RZT2H_ICU_DMAC_REQ_SELx_MASK(upper);
        val |= RZT2H_ICU_DMAC_REQ_SELx_PREP(upper, req_no);
        writel(val, priv->base_ns + RZT2H_ICU_DMACn_RSSELi(dmac_index, y));
}
EXPORT_SYMBOL_GPL(rzt2h_icu_register_dma_req);

static inline struct rzt2h_icu_priv *irq_data_to_priv(struct irq_data *data)
{
        return data->domain->host_data;
}

static inline int rzt2h_icu_irq_to_offset(struct irq_data *d, void __iomem **base,
                                          unsigned int *offset)
{
        struct rzt2h_icu_priv *priv = irq_data_to_priv(d);
        unsigned int hwirq = irqd_to_hwirq(d);

        /*
         * Safety IRQs and SEI use a separate register space from the non-safety IRQs.
         * SEI interrupt number follows immediately after the safety IRQs.
         */
        if (RZT2H_ICU_IRQ_IN_RANGE(hwirq, IRQ_NS)) {
                *offset = hwirq - RZT2H_ICU_IRQ_NS_START;
                *base = priv->base_ns;
        } else if (RZT2H_ICU_IRQ_IN_RANGE(hwirq, IRQ_S) || RZT2H_ICU_IRQ_IN_RANGE(hwirq, SEI)) {
                *offset = hwirq - RZT2H_ICU_IRQ_S_START;
                *base = priv->base_s;
        } else {
                return -EINVAL;
        }
        return 0;
}

static int rzt2h_icu_irq_set_type(struct irq_data *d, unsigned int type)
{
        struct rzt2h_icu_priv *priv = irq_data_to_priv(d);
        unsigned int offset, parent_type;
        void __iomem *base;
        u32 val, md;
        int ret;

        ret = rzt2h_icu_irq_to_offset(d, &base, &offset);
        if (ret)
                return ret;

        switch (type & IRQ_TYPE_SENSE_MASK) {
        case IRQ_TYPE_LEVEL_LOW:
                md = RZT2H_ICU_MD_LOW_LEVEL;
                parent_type = IRQ_TYPE_LEVEL_HIGH;
                break;
        case IRQ_TYPE_EDGE_FALLING:
                md = RZT2H_ICU_MD_FALLING_EDGE;
                parent_type = IRQ_TYPE_EDGE_RISING;
                break;
        case IRQ_TYPE_EDGE_RISING:
                md = RZT2H_ICU_MD_RISING_EDGE;
                parent_type = IRQ_TYPE_EDGE_RISING;
                break;
        case IRQ_TYPE_EDGE_BOTH:
                md = RZT2H_ICU_MD_BOTH_EDGES;
                parent_type = IRQ_TYPE_EDGE_RISING;
                break;
        default:
                return -EINVAL;
        }

        scoped_guard(raw_spinlock, &priv->lock) {
                val = readl_relaxed(base + RZT2H_ICU_PORTNF_MD);
                val &= ~RZT2H_ICU_PORTNF_MDi_MASK(offset);
                val |= RZT2H_ICU_PORTNF_MDi_PREP(offset, md);
                writel_relaxed(val, base + RZT2H_ICU_PORTNF_MD);
        }

        return irq_chip_set_type_parent(d, parent_type);
}

static int rzt2h_icu_set_type(struct irq_data *d, unsigned int type)
{
        unsigned int hw_irq = irqd_to_hwirq(d);

        /* IRQn and SEI are selectable, others are edge-only. */
        if (RZT2H_ICU_IRQ_IN_RANGE(hw_irq, IRQ_NS) ||
            RZT2H_ICU_IRQ_IN_RANGE(hw_irq, IRQ_S) ||
            RZT2H_ICU_IRQ_IN_RANGE(hw_irq, SEI))
                return rzt2h_icu_irq_set_type(d, type);

        if ((type & IRQ_TYPE_SENSE_MASK) != IRQ_TYPE_EDGE_RISING)
                return -EINVAL;

        return irq_chip_set_type_parent(d, IRQ_TYPE_EDGE_RISING);
}

static const struct irq_chip rzt2h_icu_chip = {
        .name                   = "rzt2h-icu",
        .irq_mask               = irq_chip_mask_parent,
        .irq_unmask             = irq_chip_unmask_parent,
        .irq_eoi                = irq_chip_eoi_parent,
        .irq_set_type           = rzt2h_icu_set_type,
        .irq_set_wake           = irq_chip_set_wake_parent,
        .irq_set_affinity       = irq_chip_set_affinity_parent,
        .irq_retrigger          = irq_chip_retrigger_hierarchy,
        .irq_get_irqchip_state  = irq_chip_get_parent_state,
        .irq_set_irqchip_state  = irq_chip_set_parent_state,
        .flags                  = IRQCHIP_MASK_ON_SUSPEND |
                                  IRQCHIP_SET_TYPE_MASKED |
                                  IRQCHIP_SKIP_SET_WAKE,
};

static int rzt2h_icu_alloc(struct irq_domain *domain, unsigned int virq, unsigned int nr_irqs,
                           void *arg)
{
        struct rzt2h_icu_priv *priv = domain->host_data;
        irq_hw_number_t hwirq;
        unsigned int type;
        int ret;

        ret = irq_domain_translate_twocell(domain, arg, &hwirq, &type);
        if (ret)
                return ret;

        ret = irq_domain_set_hwirq_and_chip(domain, virq, hwirq, &rzt2h_icu_chip, NULL);
        if (ret)
                return ret;

        return irq_domain_alloc_irqs_parent(domain, virq, nr_irqs, &priv->fwspec[hwirq]);
}

static const struct irq_domain_ops rzt2h_icu_domain_ops = {
        .alloc          = rzt2h_icu_alloc,
        .free           = irq_domain_free_irqs_common,
        .translate      = irq_domain_translate_twocell,
};

static int rzt2h_icu_parse_interrupts(struct rzt2h_icu_priv *priv, struct device_node *np)
{
        struct of_phandle_args map;
        unsigned int i;
        int ret;

        for (i = 0; i < RZT2H_ICU_NUM_IRQ; i++) {
                ret = of_irq_parse_one(np, i, &map);
                if (ret)
                        return ret;

                of_phandle_args_to_fwspec(np, map.args, map.args_count, &priv->fwspec[i]);
        }

        return 0;
}

static int rzt2h_icu_init(struct platform_device *pdev, struct device_node *parent)
{
        struct irq_domain *irq_domain, *parent_domain;
        struct device_node *node = pdev->dev.of_node;
        struct device *dev = &pdev->dev;
        struct rzt2h_icu_priv *priv;
        int ret;

        parent_domain = irq_find_host(parent);
        if (!parent_domain)
                return dev_err_probe(dev, -ENODEV, "cannot find parent domain\n");

        priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
        if (!priv)
                return -ENOMEM;

        raw_spin_lock_init(&priv->lock);

        platform_set_drvdata(pdev, priv);

        priv->base_ns = devm_of_iomap(dev, dev->of_node, 0, NULL);
        if (IS_ERR(priv->base_ns))
                return PTR_ERR(priv->base_ns);

        priv->base_s = devm_of_iomap(dev, dev->of_node, 1, NULL);
        if (IS_ERR(priv->base_s))
                return PTR_ERR(priv->base_s);

        ret = rzt2h_icu_parse_interrupts(priv, node);
        if (ret)
                return dev_err_probe(dev, ret, "cannot parse interrupts: %d\n", ret);

        ret = devm_pm_runtime_enable(dev);
        if (ret)
                return dev_err_probe(dev, ret, "devm_pm_runtime_enable failed: %d\n", ret);

        ret = pm_runtime_resume_and_get(dev);
        if (ret)
                return dev_err_probe(dev, ret, "pm_runtime_resume_and_get failed: %d\n", ret);

        irq_domain = irq_domain_create_hierarchy(parent_domain, 0, RZT2H_ICU_NUM_IRQ,
                                                 dev_fwnode(dev), &rzt2h_icu_domain_ops, priv);
        if (!irq_domain) {
                pm_runtime_put(dev);
                return -ENOMEM;
        }

        return 0;
}

IRQCHIP_PLATFORM_DRIVER_BEGIN(rzt2h_icu)
IRQCHIP_MATCH("renesas,r9a09g077-icu", rzt2h_icu_init)
IRQCHIP_PLATFORM_DRIVER_END(rzt2h_icu)
MODULE_AUTHOR("Cosmin Tanislav <cosmin-gabriel.tanislav.xa@renesas.com>");
MODULE_DESCRIPTION("Renesas RZ/T2H ICU Driver");
MODULE_LICENSE("GPL");