summaryrefslogtreecommitdiff
path: root/include/sbi/sbi_platform.h
blob: 6de52f63a6fb1ea06dcd16a2682949456024986b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
/*
 * Copyright (c) 2018 Western Digital Corporation or its affiliates.
 *
 * Authors:
 *   Anup Patel <anup.patel@wdc.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#ifndef __SBI_PLATFORM_H__
#define __SBI_PLATFORM_H__

#include <sbi/sbi_scratch.h>

enum sbi_platform_features {
	SBI_PLATFORM_HAS_MMIO_TIMER_VALUE	= (1 << 0),
	SBI_PLATFORM_HAS_HART_HOTPLUG		= (1 << 1),
	SBI_PLATFORM_HAS_PMP			= (1 << 2),
	SBI_PLATFORM_HAS_SCOUNTEREN		= (1 << 3),
	SBI_PLATFORM_HAS_MCOUNTEREN		= (1 << 4),
	SBI_PLATFORM_HAS_MFAULTS_DELEGATION	= (1 << 5),
};

#define SBI_PLATFORM_DEFAULT_FEATURES	\
	(SBI_PLATFORM_HAS_MMIO_TIMER_VALUE | \
	 SBI_PLATFORM_HAS_PMP | \
	 SBI_PLATFORM_HAS_SCOUNTEREN | \
	 SBI_PLATFORM_HAS_MCOUNTEREN | \
	 SBI_PLATFORM_HAS_MFAULTS_DELEGATION)

struct sbi_platform {
	char name[64];
	u64 features;
	u32 hart_count;
	u32 hart_stack_size;
	int (*cold_early_init)(void);
	int (*cold_final_init)(void);
	int (*warm_early_init)(u32 target_hart);
	int (*warm_final_init)(u32 target_hart);
	u32 (*pmp_region_count)(u32 target_hart);
	int (*pmp_region_info)(u32 target_hart, u32 index,
			       ulong *prot, ulong *addr, ulong *log2size);
	void (*console_putc)(char ch);
	char (*console_getc)(void);
	int (*console_init)(void);
	int (*cold_irqchip_init)(void);
	int (*warm_irqchip_init)(u32 target_hart);
	void (*ipi_inject)(u32 target_hart, u32 source_hart);
	void (*ipi_sync)(u32 target_hart, u32 source_hart);
	void (*ipi_clear)(u32 target_hart);
	int (*cold_ipi_init)(void);
	int (*warm_ipi_init)(u32 target_hart);
	u64 (*timer_value)(void);
	void (*timer_event_stop)(u32 target_hart);
	void (*timer_event_start)(u32 target_hart, u64 next_event);
	int (*cold_timer_init)(void);
	int (*warm_timer_init)(u32 target_hart);
	int (*system_reboot)(u32 type);
	int (*system_shutdown)(u32 type);
} __attribute__((packed));

#define sbi_platform_ptr(__s)	\
	((struct sbi_platform *)((__s)->platform_addr))
#define sbi_platform_thishart_ptr()	\
	((struct sbi_platform *)(sbi_scratch_thishart_ptr()->platform_addr))
#define sbi_platform_has_mmio_timer_value(__p)	\
	((__p)->features & SBI_PLATFORM_HAS_MMIO_TIMER_VALUE)
#define sbi_platform_has_hart_hotplug(__p)	\
	((__p)->features & SBI_PLATFORM_HAS_HART_HOTPLUG)
#define sbi_platform_has_pmp(__p)	\
	((__p)->features & SBI_PLATFORM_HAS_PMP)
#define sbi_platform_has_scounteren(__p)	\
	((__p)->features & SBI_PLATFORM_HAS_SCOUNTEREN)
#define sbi_platform_has_mcounteren(__p)	\
	((__p)->features & SBI_PLATFORM_HAS_MCOUNTEREN)
#define sbi_platform_has_mfaults_delegation(__p)	\
	((__p)->features & SBI_PLATFORM_HAS_MFAULTS_DELEGATION)

static inline const char *sbi_platform_name(struct sbi_platform *plat)
{
	if (plat)
		return plat->name;
	return NULL;
}

static inline u32 sbi_platform_hart_count(struct sbi_platform *plat)
{
	if (plat)
		return plat->hart_count;
	return 0;
}

static inline u32 sbi_platform_hart_stack_size(struct sbi_platform *plat)
{
	if (plat)
		return plat->hart_stack_size;
	return 0;
}

static inline int sbi_platform_cold_early_init(struct sbi_platform *plat)
{
	if (plat && plat->cold_early_init)
		return plat->cold_early_init();
	return 0;
}

static inline int sbi_platform_cold_final_init(struct sbi_platform *plat)
{
	if (plat && plat->cold_final_init)
		return plat->cold_final_init();
	return 0;
}

static inline int sbi_platform_warm_early_init(struct sbi_platform *plat,
					       u32 target_hart)
{
	if (plat && plat->warm_early_init)
		return plat->warm_early_init(target_hart);
	return 0;
}

static inline int sbi_platform_warm_final_init(struct sbi_platform *plat,
					       u32 target_hart)
{
	if (plat && plat->warm_final_init)
		return plat->warm_final_init(target_hart);
	return 0;
}

static inline u32 sbi_platform_pmp_region_count(struct sbi_platform *plat,
						u32 target_hart)
{
	if (plat && plat->pmp_region_count)
		return plat->pmp_region_count(target_hart);
	return 0;
}

static inline int sbi_platform_pmp_region_info(struct sbi_platform *plat,
					       u32 target_hart, u32 index,
					       ulong *prot, ulong *addr,
					       ulong *log2size)
{
	if (plat && plat->pmp_region_info)
		return plat->pmp_region_info(target_hart, index,
					      prot, addr, log2size);
	return 0;
}

static inline void sbi_platform_console_putc(struct sbi_platform *plat,
					     char ch)
{
	if (plat && plat->console_putc)
		plat->console_putc(ch);
}

static inline char sbi_platform_console_getc(struct sbi_platform *plat)
{
	if (plat && plat->console_getc)
		return plat->console_getc();
	return 0;
}

static inline int sbi_platform_console_init(struct sbi_platform *plat)
{
	if (plat && plat->console_init)
		return plat->console_init();
	return 0;
}

static inline int sbi_platform_warm_irqchip_init(struct sbi_platform *plat,
						 u32 target_hart)
{
	if (plat && plat->warm_irqchip_init)
		return plat->warm_irqchip_init(target_hart);
	return 0;
}

static inline int sbi_platform_cold_irqchip_init(struct sbi_platform *plat)
{
	if (plat && plat->cold_irqchip_init)
		return plat->cold_irqchip_init();
	return 0;
}

static inline void sbi_platform_ipi_inject(struct sbi_platform *plat,
					   u32 target_hart, u32 source_hart)
{
	if (plat && plat->ipi_inject)
		plat->ipi_inject(target_hart, source_hart);
}

static inline void sbi_platform_ipi_sync(struct sbi_platform *plat,
					 u32 target_hart, u32 source_hart)
{
	if (plat && plat->ipi_sync)
		plat->ipi_sync(target_hart, source_hart);
}

static inline void sbi_platform_ipi_clear(struct sbi_platform *plat,
					  u32 target_hart)
{
	if (plat && plat->ipi_clear)
		plat->ipi_clear(target_hart);
}

static inline int sbi_platform_warm_ipi_init(struct sbi_platform *plat,
					     u32 target_hart)
{
	if (plat && plat->warm_ipi_init)
		return plat->warm_ipi_init(target_hart);
	return 0;
}

static inline int sbi_platform_cold_ipi_init(struct sbi_platform *plat)
{
	if (plat && plat->cold_ipi_init)
		return plat->cold_ipi_init();
	return 0;
}

static inline u64 sbi_platform_timer_value(struct sbi_platform *plat)
{
	if (plat && plat->timer_value)
		return plat->timer_value();
	return 0;
}

static inline void sbi_platform_timer_event_stop(struct sbi_platform *plat,
						 u32 target_hart)
{
	if (plat && plat->timer_event_stop)
		plat->timer_event_stop(target_hart);
}

static inline void sbi_platform_timer_event_start(struct sbi_platform *plat,
						  u32 target_hart,
						  u64 next_event)
{
	if (plat && plat->timer_event_start)
		plat->timer_event_start(target_hart, next_event);
}

static inline int sbi_platform_warm_timer_init(struct sbi_platform *plat,
					       u32 target_hart)
{
	if (plat && plat->warm_timer_init)
		return plat->warm_timer_init(target_hart);
	return 0;
}

static inline int sbi_platform_cold_timer_init(struct sbi_platform *plat)
{
	if (plat && plat->cold_timer_init)
		return plat->cold_timer_init();
	return 0;
}

static inline int sbi_platform_system_reboot(struct sbi_platform *plat,
					     u32 type)
{
	if (plat && plat->system_reboot)
		return plat->system_reboot(type);
	return 0;
}

static inline int sbi_platform_system_shutdown(struct sbi_platform *plat,
					       u32 type)
{
	if (plat && plat->system_shutdown)
		return plat->system_shutdown(type);
	return 0;
}

#endif