1 /* SPDX-License-Identifier: GPL-2.0 */
3 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved.
4 * Copyright (C) 2018-2022 Linaro Ltd.
6 #ifndef _IPA_INTERRUPT_H_
7 #define _IPA_INTERRUPT_H_
9 #include <linux/types.h>
10 #include <linux/bits.h>
16 * typedef ipa_irq_handler_t - IPA interrupt handler function type
18 * @irq_id: interrupt type
20 * Callback function registered by ipa_interrupt_add() to handle a specific
23 typedef void (*ipa_irq_handler_t)(struct ipa *ipa, enum ipa_irq_id irq_id);
26 * ipa_interrupt_add() - Register a handler for an IPA interrupt type
27 * @interrupt: IPA interrupt structure
28 * @irq_id: IPA interrupt type
29 * @handler: Handler function for the interrupt
31 * Add a handler for an IPA interrupt and enable it. IPA interrupt
32 * handlers are run in threaded interrupt context, so are allowed to
35 void ipa_interrupt_add(struct ipa_interrupt *interrupt, enum ipa_irq_id irq_id,
36 ipa_irq_handler_t handler);
39 * ipa_interrupt_remove() - Remove the handler for an IPA interrupt type
40 * @interrupt: IPA interrupt structure
41 * @irq_id: IPA interrupt type
43 * Remove an IPA interrupt handler and disable it.
45 void ipa_interrupt_remove(struct ipa_interrupt *interrupt,
46 enum ipa_irq_id irq_id);
49 * ipa_interrupt_suspend_enable - Enable TX_SUSPEND for an endpoint
50 * @interrupt: IPA interrupt structure
51 * @endpoint_id: Endpoint whose interrupt should be enabled
53 * Note: The "TX" in the name is from the perspective of the IPA hardware.
54 * A TX_SUSPEND interrupt arrives on an AP RX enpoint when packet data can't
55 * be delivered to the endpoint because it is suspended (or its underlying
56 * channel is stopped).
58 void ipa_interrupt_suspend_enable(struct ipa_interrupt *interrupt,
62 * ipa_interrupt_suspend_disable - Disable TX_SUSPEND for an endpoint
63 * @interrupt: IPA interrupt structure
64 * @endpoint_id: Endpoint whose interrupt should be disabled
66 void ipa_interrupt_suspend_disable(struct ipa_interrupt *interrupt,
70 * ipa_interrupt_suspend_clear_all - clear all suspend interrupts
71 * @interrupt: IPA interrupt structure
73 * Clear the TX_SUSPEND interrupt for all endpoints that signaled it.
75 void ipa_interrupt_suspend_clear_all(struct ipa_interrupt *interrupt);
78 * ipa_interrupt_simulate_suspend() - Simulate TX_SUSPEND IPA interrupt
79 * @interrupt: IPA interrupt structure
81 * This calls the TX_SUSPEND interrupt handler, as if such an interrupt
82 * had been signaled. This is needed to work around a hardware quirk
83 * that occurs if aggregation is active on an endpoint when its underlying
84 * channel is suspended.
86 void ipa_interrupt_simulate_suspend(struct ipa_interrupt *interrupt);
89 * ipa_interrupt_config() - Configure the IPA interrupt framework
92 * Return: Pointer to IPA SMP2P info, or a pointer-coded error
94 struct ipa_interrupt *ipa_interrupt_config(struct ipa *ipa);
97 * ipa_interrupt_deconfig() - Inverse of ipa_interrupt_config()
98 * @interrupt: IPA interrupt structure
100 void ipa_interrupt_deconfig(struct ipa_interrupt *interrupt);
102 #endif /* _IPA_INTERRUPT_H_ */