1 // SPDX-License-Identifier: GPL-2.0
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4  * Copyright (C) 2019-2022 Linaro Ltd.
17 #include "ipa.h"
21  * DOC: IPA SMP2P communication with the modem
23  * SMP2P is a primitive communication mechanism available between the AP and
24  * the modem.  The IPA driver uses this for two purposes:  to enable the modem
25  * to state that the GSI hardware is ready to use; and to communicate the
26  * state of IPA power in the event of a crash.
28  * GSI needs to have early initialization completed before it can be used.
29  * This initialization is done either by Trust Zone or by the modem.  In the
30  * latter case, the modem uses an SMP2P interrupt to tell the AP IPA driver
31  * when the GSI is ready to use.
33  * The modem is also able to inquire about the current state of IPA
34  * power by trigging another SMP2P interrupt to the AP.  We communicate
35  * whether power is enabled using two SMP2P state bits--one to indicate
36  * the power state (on or off), and a second to indicate the power state
37  * bit is valid.  The modem will poll the valid bit until it is set, and
38  * at that time records whether the AP has IPA power enabled.
40  * Finally, if the AP kernel panics, we update the SMP2P state bits even if
41  * we never receive an interrupt from the modem requesting this.
45  * struct ipa_smp2p - IPA SMP2P information
46  * @ipa:		IPA pointer
48  * @enabled_state:	SMEM state to indicate power is enabled
49  * @valid_bit:		Valid bit in 32-bit SMEM state mask
50  * @enabled_bit:	Enabled bit in 32-bit SMEM state mask
51  * @enabled_bit:	Enabled bit in 32-bit SMEM state mask
52  * @clock_query_irq:	IPA interrupt triggered by modem for power query
53  * @setup_ready_irq:	IPA interrupt triggered by modem to signal GSI ready
54  * @power_on:		Whether IPA power is on
55  * @notified:		Whether modem has been notified of power state
57  * @mutex:		Mutex protecting ready-interrupt/shutdown interlock
61 	struct ipa *ipa;  member
76  * ipa_smp2p_notify() - use SMP2P to tell modem about IPA power state
79  * This is called either when the modem has requested it (by triggering
80  * the modem power query IPA interrupt) or whenever the AP is shutting down
81  * (via a panic notifier).  It sets the two SMP2P state bits--one saying
82  * whether the IPA power is on, and the other indicating the first bit
91 	if (smp2p->notified)  in ipa_smp2p_notify()
94 	dev = &smp2p->ipa->pdev->dev;  in ipa_smp2p_notify()
95 	smp2p->power_on = pm_runtime_get_if_active(dev, true) > 0;  in ipa_smp2p_notify()
97 	/* Signal whether the IPA power is enabled */  in ipa_smp2p_notify()
98 	mask = BIT(smp2p->enabled_bit);  in ipa_smp2p_notify()
99 	value = smp2p->power_on ? mask : 0;  in ipa_smp2p_notify()
100 	qcom_smem_state_update_bits(smp2p->enabled_state, mask, value);  in ipa_smp2p_notify()
103 	mask = BIT(smp2p->valid_bit);  in ipa_smp2p_notify()
105 	qcom_smem_state_update_bits(smp2p->valid_state, mask, value);  in ipa_smp2p_notify()
107 	smp2p->notified = true;  in ipa_smp2p_notify()
110 /* Threaded IRQ handler for modem "ipa-clock-query" SMP2P interrupt */
129 	if (smp2p->power_on)  in ipa_smp2p_panic_notifier()
130 		ipa_uc_panic_notifier(smp2p->ipa);  in ipa_smp2p_panic_notifier()
137 	/* IPA panic handler needs to run before modem shuts down */  in ipa_smp2p_panic_notifier_register()
138 	smp2p->panic_notifier.notifier_call = ipa_smp2p_panic_notifier;  in ipa_smp2p_panic_notifier_register()
139 	smp2p->panic_notifier.priority = INT_MAX;	/* Do it early */  in ipa_smp2p_panic_notifier_register()
142 					      &smp2p->panic_notifier);  in ipa_smp2p_panic_notifier_register()
148 					 &smp2p->panic_notifier);  in ipa_smp2p_panic_notifier_unregister()
151 /* Threaded IRQ handler for modem "ipa-setup-ready" SMP2P interrupt */
159 	if (smp2p->ipa->setup_complete)  in ipa_smp2p_modem_setup_ready_isr()
162 	/* Power needs to be active for setup */  in ipa_smp2p_modem_setup_ready_isr()
163 	dev = &smp2p->ipa->pdev->dev;  in ipa_smp2p_modem_setup_ready_isr()
171 	ret = ipa_setup(smp2p->ipa);  in ipa_smp2p_modem_setup_ready_isr()
185 	struct device *dev = &smp2p->ipa->pdev->dev;  in ipa_smp2p_irq_init()
189 	ret = platform_get_irq_byname(smp2p->ipa->pdev, name);  in ipa_smp2p_irq_init()
191 		return ret ? : -EINVAL;  in ipa_smp2p_irq_init()
209 static void ipa_smp2p_power_release(struct ipa *ipa)  in ipa_smp2p_power_release()  argument
211 	struct device *dev = &ipa->pdev->dev;  in ipa_smp2p_power_release()
213 	if (!ipa->smp2p->power_on)  in ipa_smp2p_power_release()
218 	ipa->smp2p->power_on = false;  in ipa_smp2p_power_release()
221 /* Initialize the IPA SMP2P subsystem */
222 int ipa_smp2p_init(struct ipa *ipa, bool modem_init)  in ipa_smp2p_init()  argument
225 	struct device *dev = &ipa->pdev->dev;  in ipa_smp2p_init()
232 	valid_state = qcom_smem_state_get(dev, "ipa-clock-enabled-valid",  in ipa_smp2p_init()
237 		return -EINVAL;  in ipa_smp2p_init()
239 	enabled_state = qcom_smem_state_get(dev, "ipa-clock-enabled",  in ipa_smp2p_init()
244 		return -EINVAL;  in ipa_smp2p_init()
248 		return -ENOMEM;  in ipa_smp2p_init()
250 	smp2p->ipa = ipa;  in ipa_smp2p_init()
255 	mutex_init(&smp2p->mutex);  in ipa_smp2p_init()
256 	smp2p->valid_state = valid_state;  in ipa_smp2p_init()
257 	smp2p->valid_bit = valid_bit;  in ipa_smp2p_init()
258 	smp2p->enabled_state = enabled_state;  in ipa_smp2p_init()
259 	smp2p->enabled_bit = enabled_bit;  in ipa_smp2p_init()
261 	/* We have enough information saved to handle notifications */  in ipa_smp2p_init()
262 	ipa->smp2p = smp2p;  in ipa_smp2p_init()
264 	ret = ipa_smp2p_irq_init(smp2p, "ipa-clock-query",  in ipa_smp2p_init()
268 	smp2p->clock_query_irq = ret;  in ipa_smp2p_init()
275 		/* Result will be non-zero (negative for error) */  in ipa_smp2p_init()
276 		ret = ipa_smp2p_irq_init(smp2p, "ipa-setup-ready",  in ipa_smp2p_init()
280 		smp2p->setup_ready_irq = ret;  in ipa_smp2p_init()
288 	ipa_smp2p_irq_exit(smp2p, smp2p->clock_query_irq);  in ipa_smp2p_init()
290 	ipa->smp2p = NULL;  in ipa_smp2p_init()
291 	mutex_destroy(&smp2p->mutex);  in ipa_smp2p_init()
297 void ipa_smp2p_exit(struct ipa *ipa)  in ipa_smp2p_exit()  argument
299 	struct ipa_smp2p *smp2p = ipa->smp2p;  in ipa_smp2p_exit()
301 	if (smp2p->setup_ready_irq)  in ipa_smp2p_exit()
302 		ipa_smp2p_irq_exit(smp2p, smp2p->setup_ready_irq);  in ipa_smp2p_exit()
304 	ipa_smp2p_irq_exit(smp2p, smp2p->clock_query_irq);  in ipa_smp2p_exit()
306 	ipa_smp2p_power_release(ipa);  in ipa_smp2p_exit()
307 	ipa->smp2p = NULL;  in ipa_smp2p_exit()
308 	mutex_destroy(&smp2p->mutex);  in ipa_smp2p_exit()
312 void ipa_smp2p_irq_disable_setup(struct ipa *ipa)  in ipa_smp2p_irq_disable_setup()  argument
314 	struct ipa_smp2p *smp2p = ipa->smp2p;  in ipa_smp2p_irq_disable_setup()
316 	if (!smp2p->setup_ready_irq)  in ipa_smp2p_irq_disable_setup()
319 	mutex_lock(&smp2p->mutex);  in ipa_smp2p_irq_disable_setup()
321 	if (!smp2p->setup_disabled) {  in ipa_smp2p_irq_disable_setup()
322 		disable_irq(smp2p->setup_ready_irq);  in ipa_smp2p_irq_disable_setup()
323 		smp2p->setup_disabled = true;  in ipa_smp2p_irq_disable_setup()
326 	mutex_unlock(&smp2p->mutex);  in ipa_smp2p_irq_disable_setup()
329 /* Reset state tracking whether we have notified the modem */
330 void ipa_smp2p_notify_reset(struct ipa *ipa)  in ipa_smp2p_notify_reset()  argument
332 	struct ipa_smp2p *smp2p = ipa->smp2p;  in ipa_smp2p_notify_reset()
335 	if (!smp2p->notified)  in ipa_smp2p_notify_reset()
338 	ipa_smp2p_power_release(ipa);  in ipa_smp2p_notify_reset()
341 	mask = BIT(smp2p->valid_bit);  in ipa_smp2p_notify_reset()
342 	qcom_smem_state_update_bits(smp2p->valid_state, mask, 0);  in ipa_smp2p_notify_reset()
345 	mask = BIT(smp2p->enabled_bit);  in ipa_smp2p_notify_reset()
346 	qcom_smem_state_update_bits(smp2p->enabled_state, mask, 0);  in ipa_smp2p_notify_reset()
348 	smp2p->notified = false;  in ipa_smp2p_notify_reset()