xref: /netbsd-src/sys/arch/arm/fdt/arm_fdtvar.h (revision 82d56013d7b633d116a93943de88e08335357a7c)
1 /* $NetBSD: arm_fdtvar.h,v 1.17 2020/06/21 17:25:03 jmcneill Exp $ */
2 
3 /*-
4  * Copyright (c) 2017 Jared D. McNeill <jmcneill@invisible.ca>
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
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _ARM_ARM_FDTVAR_H
30 #define _ARM_ARM_FDTVAR_H
31 
32 struct fdt_attach_args;
33 
34 /*
35  * Platform-specific data
36  */
37 
38 struct arm_platform {
39 	const struct pmap_devmap * (*ap_devmap)(void);
40 	void			(*ap_bootstrap)(void);
41 	int			(*ap_mpstart)(void);
42 	void			(*ap_startup)(void);
43 	void			(*ap_init_attach_args)(struct fdt_attach_args *);
44 	void			(*ap_device_register)(device_t, void *);
45 	void			(*ap_reset)(void);
46 	void			(*ap_delay)(u_int);
47 	u_int			(*ap_uart_freq)(void);
48 };
49 
50 struct arm_platform_info {
51 	const char *			api_compat;
52 	const struct arm_platform *	api_ops;
53 };
54 
55 #define ARM_PLATFORM_DEFAULT		""
56 
57 #define _ARM_PLATFORM_REGISTER(name)	\
58 	__link_set_add_rodata(arm_platforms, __CONCAT(name,_platinfo));
59 
60 #define ARM_PLATFORM(_name, _compat, _ops)				\
61 static const struct arm_platform_info __CONCAT(_name,_platinfo) = {	\
62 	.api_compat = (_compat),					\
63 	.api_ops = (_ops)						\
64 };									\
65 _ARM_PLATFORM_REGISTER(_name)
66 
67 const struct arm_platform *	arm_fdt_platform(void);
68 
69 /*
70  * CPU enable methods
71  */
72 
73 struct arm_cpu_method {
74 	const char *		acm_compat;
75 	int			(*acm_enable)(int);
76 };
77 
78 #define	_ARM_CPU_METHOD_REGISTER(_name)	\
79 	__link_set_add_rodata(arm_cpu_methods, __CONCAT(_name,_cpu_method));
80 
81 #define	ARM_CPU_METHOD(_name, _compat, _enable)				\
82 static const struct arm_cpu_method __CONCAT(_name,_cpu_method) = {	\
83 	.acm_compat = (_compat),					\
84 	.acm_enable = (_enable)						\
85 };									\
86 _ARM_CPU_METHOD_REGISTER(_name)
87 
88 void	arm_fdt_cpu_bootstrap(void);
89 int	arm_fdt_cpu_mpstart(void);
90 void    arm_fdt_cpu_hatch_register(void *, void (*)(void *, struct cpu_info *));
91 void    arm_fdt_cpu_hatch(struct cpu_info *);
92 
93 void	arm_fdt_timer_register(void (*)(void));
94 
95 void	arm_fdt_irq_set_handler(void (*)(void *));
96 void	arm_fdt_irq_handler(void *);
97 
98 void	arm_fdt_memory_dump(paddr_t);
99 
100 void	arm_fdt_module_init(void);
101 
102 #endif /* !_ARM_ARM_FDTVAR_H */
103