xref: /optee_os/core/include/drivers/gic.h (revision b1469ba0bfd0371eb52bd50f5c52eeda7a8f5f1e)
1 /*
2  * Copyright (c) 2016, Linaro Limited
3  * Copyright (c) 2014, STMicroelectronics International N.V.
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 
29 #ifndef __DRIVERS_GIC_H
30 #define __DRIVERS_GIC_H
31 #include <types_ext.h>
32 #include <kernel/interrupt.h>
33 
34 #define GIC_DIST_REG_SIZE	0x10000
35 #define GIC_CPU_REG_SIZE	0x10000
36 
37 struct gic_data {
38 	vaddr_t gicc_base;
39 	vaddr_t gicd_base;
40 	size_t max_it;
41 	struct itr_chip chip;
42 };
43 
44 /*
45  * The two gic_init_* functions initializes the struct gic_data which is
46  * then used by the other functions.
47  */
48 
49 void gic_init(struct gic_data *gd, vaddr_t gicc_base, vaddr_t gicd_base);
50 /* initial base address only */
51 void gic_init_base_addr(struct gic_data *gd, vaddr_t gicc_base,
52 			vaddr_t gicd_base);
53 /* initial cpu if only, mainly use for secondary cpu setup cpu interface */
54 void gic_cpu_init(struct gic_data *gd);
55 
56 void gic_it_handle(struct gic_data *gd);
57 
58 void gic_dump_state(struct gic_data *gd);
59 #endif /*__DRIVERS_GIC_H*/
60