xref: /linux-6.15/include/linux/vexpress.h (revision f5e4e7fd)
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License version 2 as
4  * published by the Free Software Foundation.
5  *
6  * This program is distributed in the hope that it will be useful,
7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
9  * GNU General Public License for more details.
10  *
11  * Copyright (C) 2012 ARM Limited
12  */
13 
14 #ifndef _LINUX_VEXPRESS_H
15 #define _LINUX_VEXPRESS_H
16 
17 #include <linux/device.h>
18 #include <linux/reboot.h>
19 
20 #define VEXPRESS_SITE_MB		0
21 #define VEXPRESS_SITE_DB1		1
22 #define VEXPRESS_SITE_DB2		2
23 #define VEXPRESS_SITE_MASTER		0xf
24 
25 #define VEXPRESS_CONFIG_STATUS_DONE	0
26 #define VEXPRESS_CONFIG_STATUS_WAIT	1
27 
28 #define VEXPRESS_GPIO_MMC_CARDIN	0
29 #define VEXPRESS_GPIO_MMC_WPROT		1
30 #define VEXPRESS_GPIO_FLASH_WPn		2
31 #define VEXPRESS_GPIO_LED0		3
32 #define VEXPRESS_GPIO_LED1		4
33 #define VEXPRESS_GPIO_LED2		5
34 #define VEXPRESS_GPIO_LED3		6
35 #define VEXPRESS_GPIO_LED4		7
36 #define VEXPRESS_GPIO_LED5		8
37 #define VEXPRESS_GPIO_LED6		9
38 #define VEXPRESS_GPIO_LED7		10
39 
40 #define VEXPRESS_RES_FUNC(_site, _func)	\
41 {					\
42 	.start = (_site),		\
43 	.end = (_func),			\
44 	.flags = IORESOURCE_BUS,	\
45 }
46 
47 /* Config bridge API */
48 
49 /**
50  * struct vexpress_config_bridge_info - description of the platform
51  * configuration infrastructure bridge.
52  *
53  * @name:	Bridge name
54  *
55  * @func_get:	Obtains pointer to a configuration function for a given
56  *		device or a Device Tree node, to be used with @func_put
57  *		and @func_exec. The node pointer should take precedence
58  *		over device pointer when both are passed.
59  *
60  * @func_put:	Tells the bridge that the function will not be used any
61  *		more, so all allocated resources can be released.
62  *
63  * @func_exec:	Executes a configuration function read or write operation.
64  *		The offset selects a 32 bit word of the value accessed.
65  *		Must return VEXPRESS_CONFIG_STATUS_DONE when operation
66  *		is finished immediately, VEXPRESS_CONFIG_STATUS_WAIT when
67  *		will be completed in some time or negative value in case
68  *		of error.
69  */
70 struct vexpress_config_bridge_info {
71 	const char *name;
72 	void *(*func_get)(struct device *dev, struct device_node *node);
73 	void (*func_put)(void *func);
74 	int (*func_exec)(void *func, int offset, bool write, u32 *data);
75 };
76 
77 struct vexpress_config_bridge;
78 
79 struct vexpress_config_bridge *vexpress_config_bridge_register(
80 		struct device_node *node,
81 		struct vexpress_config_bridge_info *info);
82 void vexpress_config_bridge_unregister(struct vexpress_config_bridge *bridge);
83 
84 void vexpress_config_complete(struct vexpress_config_bridge *bridge,
85 		int status);
86 
87 /* Config function API */
88 
89 struct vexpress_config_func;
90 
91 struct vexpress_config_func *__vexpress_config_func_get(struct device *dev,
92 		struct device_node *node);
93 #define vexpress_config_func_get_by_dev(dev) \
94 		__vexpress_config_func_get(dev, NULL)
95 #define vexpress_config_func_get_by_node(node) \
96 		__vexpress_config_func_get(NULL, node)
97 void vexpress_config_func_put(struct vexpress_config_func *func);
98 
99 /* Both may sleep! */
100 int vexpress_config_read(struct vexpress_config_func *func, int offset,
101 		u32 *data);
102 int vexpress_config_write(struct vexpress_config_func *func, int offset,
103 		u32 data);
104 
105 /* Platform control */
106 
107 u32 vexpress_get_procid(int site);
108 u32 vexpress_get_hbi(int site);
109 void *vexpress_get_24mhz_clock_base(void);
110 void vexpress_flags_set(u32 data);
111 
112 #define vexpress_get_site_by_node(node) __vexpress_get_site(NULL, node)
113 #define vexpress_get_site_by_dev(dev) __vexpress_get_site(dev, NULL)
114 unsigned __vexpress_get_site(struct device *dev, struct device_node *node);
115 
116 void vexpress_sysreg_early_init(void __iomem *base);
117 void vexpress_sysreg_of_early_init(void);
118 
119 /* Clocks */
120 
121 struct clk *vexpress_osc_setup(struct device *dev);
122 void vexpress_osc_of_setup(struct device_node *node);
123 
124 void vexpress_clk_init(void __iomem *sp810_base);
125 void vexpress_clk_of_init(void);
126 
127 #endif
128