xref: /optee_os/core/include/kernel/interrupt.h (revision 1bb929836182ecb96d2d9d268daa807c67596396)
1 /* SPDX-License-Identifier: BSD-2-Clause */
2 /*
3  * Copyright (c) 2016, Linaro Limited
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26  * POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef __KERNEL_INTERRUPT_H
29 #define __KERNEL_INTERRUPT_H
30 
31 #include <types_ext.h>
32 #include <sys/queue.h>
33 
34 #define ITRF_TRIGGER_LEVEL	(1 << 0)
35 
36 struct itr_chip {
37 	const struct itr_ops *ops;
38 };
39 
40 struct itr_ops {
41 	void (*add)(struct itr_chip *chip, size_t it, uint32_t flags);
42 	void (*enable)(struct itr_chip *chip, size_t it);
43 	void (*disable)(struct itr_chip *chip, size_t it);
44 	void (*raise_pi)(struct itr_chip *chip, size_t it);
45 	void (*raise_sgi)(struct itr_chip *chip, size_t it,
46 		uint8_t cpu_mask);
47 	void (*set_affinity)(struct itr_chip *chip, size_t it,
48 		uint8_t cpu_mask);
49 };
50 
51 enum itr_return {
52 	ITRR_NONE,
53 	ITRR_HANDLED,
54 };
55 
56 struct itr_handler {
57 	size_t it;
58 	uint32_t flags;
59 	enum itr_return (*handler)(struct itr_handler *h);
60 	void *data;
61 	SLIST_ENTRY(itr_handler) link;
62 };
63 
64 void itr_init(struct itr_chip *data);
65 void itr_handle(size_t it);
66 
67 void itr_add(struct itr_handler *handler);
68 void itr_enable(size_t it);
69 void itr_disable(size_t it);
70 /* raise the Peripheral Interrupt corresponding to the interrupt ID */
71 void itr_raise_pi(size_t it);
72 /*
73  * raise the Software Generated Interrupt corresponding to the interrupt ID,
74  * the cpu_mask represents which cpu interface to forward.
75  */
76 void itr_raise_sgi(size_t it, uint8_t cpu_mask);
77 /*
78  * let corresponding interrupt forward to the cpu interface
79  * according to the cpu_mask.
80  */
81 void itr_set_affinity(size_t it, uint8_t cpu_mask);
82 
83 #endif /*__KERNEL_INTERRUPT_H*/
84