xref: /optee_os/core/include/drivers/gic.h (revision 7315b7b47303ec73b8f5a994c37bb6bed0d00e37)
1b0104773SPascal Brand /*
2*7315b7b4SJens Wiklander  * Copyright (c) 2016, Linaro Limited
3b0104773SPascal Brand  * Copyright (c) 2014, STMicroelectronics International N.V.
4b0104773SPascal Brand  * All rights reserved.
5b0104773SPascal Brand  *
6b0104773SPascal Brand  * Redistribution and use in source and binary forms, with or without
7b0104773SPascal Brand  * modification, are permitted provided that the following conditions are met:
8b0104773SPascal Brand  *
9b0104773SPascal Brand  * 1. Redistributions of source code must retain the above copyright notice,
10b0104773SPascal Brand  * this list of conditions and the following disclaimer.
11b0104773SPascal Brand  *
12b0104773SPascal Brand  * 2. Redistributions in binary form must reproduce the above copyright notice,
13b0104773SPascal Brand  * this list of conditions and the following disclaimer in the documentation
14b0104773SPascal Brand  * and/or other materials provided with the distribution.
15b0104773SPascal Brand  *
16b0104773SPascal Brand  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17b0104773SPascal Brand  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18b0104773SPascal Brand  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19b0104773SPascal Brand  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20b0104773SPascal Brand  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21b0104773SPascal Brand  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22b0104773SPascal Brand  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23b0104773SPascal Brand  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24b0104773SPascal Brand  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25b0104773SPascal Brand  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26b0104773SPascal Brand  * POSSIBILITY OF SUCH DAMAGE.
27b0104773SPascal Brand  */
28b0104773SPascal Brand 
29*7315b7b4SJens Wiklander #ifndef __DRIVERS_GIC_H
30*7315b7b4SJens Wiklander #define __DRIVERS_GIC_H
31ec219598SPascal Brand #include <types_ext.h>
32*7315b7b4SJens Wiklander #include <kernel/interrupt.h>
33b0104773SPascal Brand 
34*7315b7b4SJens Wiklander struct gic_data {
35*7315b7b4SJens Wiklander 	vaddr_t gicc_base;
36*7315b7b4SJens Wiklander 	vaddr_t gicd_base;
37*7315b7b4SJens Wiklander 	size_t max_it;
38*7315b7b4SJens Wiklander 	struct itr_chip chip;
39*7315b7b4SJens Wiklander };
40*7315b7b4SJens Wiklander 
41*7315b7b4SJens Wiklander /*
42*7315b7b4SJens Wiklander  * The two gic_init_* functions initializes the struct gic_data which is
43*7315b7b4SJens Wiklander  * then used by the other functions.
44*7315b7b4SJens Wiklander  */
45*7315b7b4SJens Wiklander 
46*7315b7b4SJens Wiklander void gic_init(struct gic_data *gd, paddr_t gicc_base, paddr_t gicd_base);
4753bd332aSSY Chiu /* initial base address only */
48*7315b7b4SJens Wiklander void gic_init_base_addr(struct gic_data *gd, vaddr_t gicc_base,
49*7315b7b4SJens Wiklander 			vaddr_t gicd_base);
50bedc2b9fSsunny /* initial cpu if only, mainly use for secondary cpu setup cpu interface */
51*7315b7b4SJens Wiklander void gic_cpu_init(struct gic_data *gd);
52b0104773SPascal Brand 
53*7315b7b4SJens Wiklander void gic_it_handle(struct gic_data *gd);
54b0104773SPascal Brand 
55*7315b7b4SJens Wiklander void gic_dump_state(struct gic_data *gd);
56*7315b7b4SJens Wiklander #endif /*__DRIVERS_GIC_H*/
57