1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * Copyright (c) 2021, Linaro Limited
4 * Copyright (c) 2010-2020, The Linux Foundation. All rights reserved.
5 */
6
7#include <linux/delay.h>
8#include <linux/err.h>
9#include <linux/init.h>
10#include <linux/interrupt.h>
11#include <linux/io.h>
12#include <linux/irqchip.h>
13#include <linux/irqdomain.h>
14#include <linux/mailbox_client.h>
15#include <linux/module.h>
16#include <linux/of.h>
17#include <linux/of_address.h>
18#include <linux/of_platform.h>
19#include <linux/platform_device.h>
20#include <linux/pm_domain.h>
21#include <linux/slab.h>
22#include <linux/soc/qcom/irq.h>
23#include <linux/spinlock.h>
24
25/*
26 * This is the driver for Qualcomm MPM (MSM Power Manager) interrupt controller,
27 * which is commonly found on Qualcomm SoCs built on the RPM architecture.
28 * Sitting in always-on domain, MPM monitors the wakeup interrupts when SoC is
29 * asleep, and wakes up the AP when one of those interrupts occurs. This driver
30 * doesn't directly access physical MPM registers though. Instead, the access
31 * is bridged via a piece of internal memory (SRAM) that is accessible to both
32 * AP and RPM. This piece of memory is called 'vMPM' in the driver.
33 *
34 * When SoC is awake, the vMPM is owned by AP and the register setup by this
35 * driver all happens on vMPM. When AP is about to get power collapsed, the
36 * driver sends a mailbox notification to RPM, which will take over the vMPM
37 * ownership and dump vMPM into physical MPM registers. On wakeup, AP is woken
38 * up by a MPM pin/interrupt, and RPM will copy STATUS registers into vMPM.
39 * Then AP start owning vMPM again.
40 *
41 * vMPM register map:
42 *
43 * 31 0
44 * +--------------------------------+
45 * | TIMER0 | 0x00
46 * +--------------------------------+
47 * | TIMER1 | 0x04
48 * +--------------------------------+
49 * | ENABLE0 | 0x08
50 * +--------------------------------+
51 * | ... | ...
52 * +--------------------------------+
53 * | ENABLEn |
54 * +--------------------------------+
55 * | FALLING_EDGE0 |
56 * +--------------------------------+
57 * | ... |
58 * +--------------------------------+
59 * | STATUSn |
60 * +--------------------------------+
61 *
62 * n = DIV_ROUND_UP(pin_cnt, 32)
63 *
64 */
65
66#define MPM_REG_ENABLE 0
67#define MPM_REG_FALLING_EDGE 1
68#define MPM_REG_RISING_EDGE 2
69#define MPM_REG_POLARITY 3
70#define MPM_REG_STATUS 4
71
72/* MPM pin map to GIC hwirq */
73struct mpm_gic_map {
74 int pin;
75 irq_hw_number_t hwirq;
76};
77
78struct qcom_mpm_priv {
79 void __iomem *base;
80 raw_spinlock_t lock;
81 struct mbox_client mbox_client;
82 struct mbox_chan *mbox_chan;
83 struct mpm_gic_map *maps;
84 unsigned int map_cnt;
85 unsigned int reg_stride;
86 struct irq_domain *domain;
87 struct generic_pm_domain genpd;
88};
89
90static u32 qcom_mpm_read(struct qcom_mpm_priv *priv, unsigned int reg,
91 unsigned int index)
92{
93 unsigned int offset = (reg * priv->reg_stride + index + 2) * 4;
94
95 return readl_relaxed(priv->base + offset);
96}
97
98static void qcom_mpm_write(struct qcom_mpm_priv *priv, unsigned int reg,
99 unsigned int index, u32 val)
100{
101 unsigned int offset = (reg * priv->reg_stride + index + 2) * 4;
102
103 writel_relaxed(val, priv->base + offset);
104
105 /* Ensure the write is completed */
106 wmb();
107}
108
109static void qcom_mpm_enable_irq(struct irq_data *d, bool en)
110{
111 struct qcom_mpm_priv *priv = d->chip_data;
112 int pin = d->hwirq;
113 unsigned int index = pin / 32;
114 unsigned int shift = pin % 32;
115 unsigned long flags, val;
116
117 raw_spin_lock_irqsave(&priv->lock, flags);
118
119 val = qcom_mpm_read(priv, MPM_REG_ENABLE, index);
120 __assign_bit(shift, &val, en);
121 qcom_mpm_write(priv, MPM_REG_ENABLE, index, val);
122
123 raw_spin_unlock_irqrestore(&priv->lock, flags);
124}
125
126static void qcom_mpm_mask(struct irq_data *d)
127{
128 qcom_mpm_enable_irq(d, en: false);
129
130 if (d->parent_data)
131 irq_chip_mask_parent(data: d);
132}
133
134static void qcom_mpm_unmask(struct irq_data *d)
135{
136 qcom_mpm_enable_irq(d, en: true);
137
138 if (d->parent_data)
139 irq_chip_unmask_parent(data: d);
140}
141
142static void mpm_set_type(struct qcom_mpm_priv *priv, bool set, unsigned int reg,
143 unsigned int index, unsigned int shift)
144{
145 unsigned long flags, val;
146
147 raw_spin_lock_irqsave(&priv->lock, flags);
148
149 val = qcom_mpm_read(priv, reg, index);
150 __assign_bit(shift, &val, set);
151 qcom_mpm_write(priv, reg, index, val);
152
153 raw_spin_unlock_irqrestore(&priv->lock, flags);
154}
155
156static int qcom_mpm_set_type(struct irq_data *d, unsigned int type)
157{
158 struct qcom_mpm_priv *priv = d->chip_data;
159 int pin = d->hwirq;
160 unsigned int index = pin / 32;
161 unsigned int shift = pin % 32;
162
163 if (type & IRQ_TYPE_EDGE_RISING)
164 mpm_set_type(priv, set: true, MPM_REG_RISING_EDGE, index, shift);
165 else
166 mpm_set_type(priv, set: false, MPM_REG_RISING_EDGE, index, shift);
167
168 if (type & IRQ_TYPE_EDGE_FALLING)
169 mpm_set_type(priv, set: true, MPM_REG_FALLING_EDGE, index, shift);
170 else
171 mpm_set_type(priv, set: false, MPM_REG_FALLING_EDGE, index, shift);
172
173 if (type & IRQ_TYPE_LEVEL_HIGH)
174 mpm_set_type(priv, set: true, MPM_REG_POLARITY, index, shift);
175 else
176 mpm_set_type(priv, set: false, MPM_REG_POLARITY, index, shift);
177
178 if (!d->parent_data)
179 return 0;
180
181 if (type & IRQ_TYPE_EDGE_BOTH)
182 type = IRQ_TYPE_EDGE_RISING;
183
184 if (type & IRQ_TYPE_LEVEL_MASK)
185 type = IRQ_TYPE_LEVEL_HIGH;
186
187 return irq_chip_set_type_parent(data: d, type);
188}
189
190static struct irq_chip qcom_mpm_chip = {
191 .name = "mpm",
192 .irq_eoi = irq_chip_eoi_parent,
193 .irq_mask = qcom_mpm_mask,
194 .irq_unmask = qcom_mpm_unmask,
195 .irq_retrigger = irq_chip_retrigger_hierarchy,
196 .irq_set_type = qcom_mpm_set_type,
197 .irq_set_affinity = irq_chip_set_affinity_parent,
198 .flags = IRQCHIP_MASK_ON_SUSPEND |
199 IRQCHIP_SKIP_SET_WAKE,
200};
201
202static struct mpm_gic_map *get_mpm_gic_map(struct qcom_mpm_priv *priv, int pin)
203{
204 struct mpm_gic_map *maps = priv->maps;
205 int i;
206
207 for (i = 0; i < priv->map_cnt; i++) {
208 if (maps[i].pin == pin)
209 return &maps[i];
210 }
211
212 return NULL;
213}
214
215static int qcom_mpm_alloc(struct irq_domain *domain, unsigned int virq,
216 unsigned int nr_irqs, void *data)
217{
218 struct qcom_mpm_priv *priv = domain->host_data;
219 struct irq_fwspec *fwspec = data;
220 struct irq_fwspec parent_fwspec;
221 struct mpm_gic_map *map;
222 irq_hw_number_t pin;
223 unsigned int type;
224 int ret;
225
226 ret = irq_domain_translate_twocell(d: domain, fwspec, out_hwirq: &pin, out_type: &type);
227 if (ret)
228 return ret;
229
230 if (pin == GPIO_NO_WAKE_IRQ)
231 return irq_domain_disconnect_hierarchy(domain, virq);
232
233 ret = irq_domain_set_hwirq_and_chip(domain, virq, hwirq: pin,
234 chip: &qcom_mpm_chip, chip_data: priv);
235 if (ret)
236 return ret;
237
238 map = get_mpm_gic_map(priv, pin);
239 if (map == NULL)
240 return irq_domain_disconnect_hierarchy(domain: domain->parent, virq);
241
242 if (type & IRQ_TYPE_EDGE_BOTH)
243 type = IRQ_TYPE_EDGE_RISING;
244
245 if (type & IRQ_TYPE_LEVEL_MASK)
246 type = IRQ_TYPE_LEVEL_HIGH;
247
248 parent_fwspec.fwnode = domain->parent->fwnode;
249 parent_fwspec.param_count = 3;
250 parent_fwspec.param[0] = 0;
251 parent_fwspec.param[1] = map->hwirq;
252 parent_fwspec.param[2] = type;
253
254 return irq_domain_alloc_irqs_parent(domain, irq_base: virq, nr_irqs,
255 arg: &parent_fwspec);
256}
257
258static const struct irq_domain_ops qcom_mpm_ops = {
259 .alloc = qcom_mpm_alloc,
260 .free = irq_domain_free_irqs_common,
261 .translate = irq_domain_translate_twocell,
262};
263
264/* Triggered by RPM when system resumes from deep sleep */
265static irqreturn_t qcom_mpm_handler(int irq, void *dev_id)
266{
267 struct qcom_mpm_priv *priv = dev_id;
268 unsigned long enable, pending;
269 irqreturn_t ret = IRQ_NONE;
270 unsigned long flags;
271 int i, j;
272
273 for (i = 0; i < priv->reg_stride; i++) {
274 raw_spin_lock_irqsave(&priv->lock, flags);
275 enable = qcom_mpm_read(priv, MPM_REG_ENABLE, index: i);
276 pending = qcom_mpm_read(priv, MPM_REG_STATUS, index: i);
277 pending &= enable;
278 raw_spin_unlock_irqrestore(&priv->lock, flags);
279
280 for_each_set_bit(j, &pending, 32) {
281 unsigned int pin = 32 * i + j;
282 struct irq_desc *desc = irq_resolve_mapping(domain: priv->domain, hwirq: pin);
283 struct irq_data *d = &desc->irq_data;
284
285 if (!irqd_is_level_type(d))
286 irq_set_irqchip_state(irq: d->irq,
287 which: IRQCHIP_STATE_PENDING, state: true);
288 ret = IRQ_HANDLED;
289 }
290 }
291
292 return ret;
293}
294
295static int mpm_pd_power_off(struct generic_pm_domain *genpd)
296{
297 struct qcom_mpm_priv *priv = container_of(genpd, struct qcom_mpm_priv,
298 genpd);
299 int i, ret;
300
301 for (i = 0; i < priv->reg_stride; i++)
302 qcom_mpm_write(priv, MPM_REG_STATUS, index: i, val: 0);
303
304 /* Notify RPM to write vMPM into HW */
305 ret = mbox_send_message(chan: priv->mbox_chan, NULL);
306 if (ret < 0)
307 return ret;
308
309 return 0;
310}
311
312static bool gic_hwirq_is_mapped(struct mpm_gic_map *maps, int cnt, u32 hwirq)
313{
314 int i;
315
316 for (i = 0; i < cnt; i++)
317 if (maps[i].hwirq == hwirq)
318 return true;
319
320 return false;
321}
322
323static int qcom_mpm_probe(struct platform_device *pdev, struct device_node *parent)
324{
325 struct device_node *np = pdev->dev.of_node;
326 struct device *dev = &pdev->dev;
327 struct irq_domain *parent_domain;
328 struct generic_pm_domain *genpd;
329 struct device_node *msgram_np;
330 struct qcom_mpm_priv *priv;
331 unsigned int pin_cnt;
332 struct resource res;
333 int i, irq;
334 int ret;
335
336 priv = devm_kzalloc(dev, size: sizeof(*priv), GFP_KERNEL);
337 if (!priv)
338 return -ENOMEM;
339
340 ret = of_property_read_u32(np, propname: "qcom,mpm-pin-count", out_value: &pin_cnt);
341 if (ret) {
342 dev_err(dev, "failed to read qcom,mpm-pin-count: %d\n", ret);
343 return ret;
344 }
345
346 priv->reg_stride = DIV_ROUND_UP(pin_cnt, 32);
347
348 ret = of_property_count_u32_elems(np, propname: "qcom,mpm-pin-map");
349 if (ret < 0) {
350 dev_err(dev, "failed to read qcom,mpm-pin-map: %d\n", ret);
351 return ret;
352 }
353
354 if (ret % 2) {
355 dev_err(dev, "invalid qcom,mpm-pin-map\n");
356 return -EINVAL;
357 }
358
359 priv->map_cnt = ret / 2;
360 priv->maps = devm_kcalloc(dev, n: priv->map_cnt, size: sizeof(*priv->maps),
361 GFP_KERNEL);
362 if (!priv->maps)
363 return -ENOMEM;
364
365 for (i = 0; i < priv->map_cnt; i++) {
366 u32 pin, hwirq;
367
368 of_property_read_u32_index(np, propname: "qcom,mpm-pin-map", index: i * 2, out_value: &pin);
369 of_property_read_u32_index(np, propname: "qcom,mpm-pin-map", index: i * 2 + 1, out_value: &hwirq);
370
371 if (gic_hwirq_is_mapped(maps: priv->maps, cnt: i, hwirq)) {
372 dev_warn(dev, "failed to map pin %d as GIC hwirq %d is already mapped\n",
373 pin, hwirq);
374 continue;
375 }
376
377 priv->maps[i].pin = pin;
378 priv->maps[i].hwirq = hwirq;
379 }
380
381 raw_spin_lock_init(&priv->lock);
382
383 /* If we have a handle to an RPM message ram partition, use it. */
384 msgram_np = of_parse_phandle(np, phandle_name: "qcom,rpm-msg-ram", index: 0);
385 if (msgram_np) {
386 ret = of_address_to_resource(dev: msgram_np, index: 0, r: &res);
387 if (ret) {
388 of_node_put(node: msgram_np);
389 return ret;
390 }
391
392 /* Don't use devm_ioremap_resource, as we're accessing a shared region. */
393 priv->base = devm_ioremap(dev, offset: res.start, size: resource_size(res: &res));
394 of_node_put(node: msgram_np);
395 if (!priv->base)
396 return -ENOMEM;
397 } else {
398 /* Otherwise, fall back to simple MMIO. */
399 priv->base = devm_platform_ioremap_resource(pdev, index: 0);
400 if (IS_ERR(ptr: priv->base))
401 return PTR_ERR(ptr: priv->base);
402 }
403
404 for (i = 0; i < priv->reg_stride; i++) {
405 qcom_mpm_write(priv, MPM_REG_ENABLE, index: i, val: 0);
406 qcom_mpm_write(priv, MPM_REG_FALLING_EDGE, index: i, val: 0);
407 qcom_mpm_write(priv, MPM_REG_RISING_EDGE, index: i, val: 0);
408 qcom_mpm_write(priv, MPM_REG_POLARITY, index: i, val: 0);
409 qcom_mpm_write(priv, MPM_REG_STATUS, index: i, val: 0);
410 }
411
412 irq = platform_get_irq(pdev, 0);
413 if (irq < 0)
414 return irq;
415
416 genpd = &priv->genpd;
417 genpd->flags = GENPD_FLAG_IRQ_SAFE;
418 genpd->power_off = mpm_pd_power_off;
419
420 genpd->name = devm_kasprintf(dev, GFP_KERNEL, fmt: "%s", dev_name(dev));
421 if (!genpd->name)
422 return -ENOMEM;
423
424 ret = pm_genpd_init(genpd, NULL, is_off: false);
425 if (ret) {
426 dev_err(dev, "failed to init genpd: %d\n", ret);
427 return ret;
428 }
429
430 ret = of_genpd_add_provider_simple(np, genpd);
431 if (ret) {
432 dev_err(dev, "failed to add genpd provider: %d\n", ret);
433 goto remove_genpd;
434 }
435
436 priv->mbox_client.dev = dev;
437 priv->mbox_chan = mbox_request_channel(cl: &priv->mbox_client, index: 0);
438 if (IS_ERR(ptr: priv->mbox_chan)) {
439 ret = PTR_ERR(ptr: priv->mbox_chan);
440 dev_err(dev, "failed to acquire IPC channel: %d\n", ret);
441 return ret;
442 }
443
444 parent_domain = irq_find_host(node: parent);
445 if (!parent_domain) {
446 dev_err(dev, "failed to find MPM parent domain\n");
447 ret = -ENXIO;
448 goto free_mbox;
449 }
450
451 priv->domain = irq_domain_create_hierarchy(parent: parent_domain,
452 IRQ_DOMAIN_FLAG_QCOM_MPM_WAKEUP, size: pin_cnt,
453 of_fwnode_handle(np), ops: &qcom_mpm_ops, host_data: priv);
454 if (!priv->domain) {
455 dev_err(dev, "failed to create MPM domain\n");
456 ret = -ENOMEM;
457 goto free_mbox;
458 }
459
460 irq_domain_update_bus_token(domain: priv->domain, bus_token: DOMAIN_BUS_WAKEUP);
461
462 ret = devm_request_irq(dev, irq, handler: qcom_mpm_handler, IRQF_NO_SUSPEND,
463 devname: "qcom_mpm", dev_id: priv);
464 if (ret) {
465 dev_err(dev, "failed to request irq: %d\n", ret);
466 goto remove_domain;
467 }
468
469 return 0;
470
471remove_domain:
472 irq_domain_remove(domain: priv->domain);
473free_mbox:
474 mbox_free_channel(chan: priv->mbox_chan);
475remove_genpd:
476 pm_genpd_remove(genpd);
477 return ret;
478}
479
480IRQCHIP_PLATFORM_DRIVER_BEGIN(qcom_mpm)
481IRQCHIP_MATCH("qcom,mpm", qcom_mpm_probe)
482IRQCHIP_PLATFORM_DRIVER_END(qcom_mpm)
483MODULE_DESCRIPTION("Qualcomm Technologies, Inc. MSM Power Manager");
484MODULE_LICENSE("GPL v2");
485

source code of linux/drivers/irqchip/irq-qcom-mpm.c