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