1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (C) 2015 Regents of the University of California
4*4882a593Smuzhiyun * Copyright (c) 2020 Western Digital Corporation or its affiliates.
5*4882a593Smuzhiyun */
6*4882a593Smuzhiyun
7*4882a593Smuzhiyun #ifndef _ASM_RISCV_SBI_H
8*4882a593Smuzhiyun #define _ASM_RISCV_SBI_H
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <linux/types.h>
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun #ifdef CONFIG_RISCV_SBI
13*4882a593Smuzhiyun enum sbi_ext_id {
14*4882a593Smuzhiyun #ifdef CONFIG_RISCV_SBI_V01
15*4882a593Smuzhiyun SBI_EXT_0_1_SET_TIMER = 0x0,
16*4882a593Smuzhiyun SBI_EXT_0_1_CONSOLE_PUTCHAR = 0x1,
17*4882a593Smuzhiyun SBI_EXT_0_1_CONSOLE_GETCHAR = 0x2,
18*4882a593Smuzhiyun SBI_EXT_0_1_CLEAR_IPI = 0x3,
19*4882a593Smuzhiyun SBI_EXT_0_1_SEND_IPI = 0x4,
20*4882a593Smuzhiyun SBI_EXT_0_1_REMOTE_FENCE_I = 0x5,
21*4882a593Smuzhiyun SBI_EXT_0_1_REMOTE_SFENCE_VMA = 0x6,
22*4882a593Smuzhiyun SBI_EXT_0_1_REMOTE_SFENCE_VMA_ASID = 0x7,
23*4882a593Smuzhiyun SBI_EXT_0_1_SHUTDOWN = 0x8,
24*4882a593Smuzhiyun #endif
25*4882a593Smuzhiyun SBI_EXT_BASE = 0x10,
26*4882a593Smuzhiyun SBI_EXT_TIME = 0x54494D45,
27*4882a593Smuzhiyun SBI_EXT_IPI = 0x735049,
28*4882a593Smuzhiyun SBI_EXT_RFENCE = 0x52464E43,
29*4882a593Smuzhiyun SBI_EXT_HSM = 0x48534D,
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun enum sbi_ext_base_fid {
33*4882a593Smuzhiyun SBI_EXT_BASE_GET_SPEC_VERSION = 0,
34*4882a593Smuzhiyun SBI_EXT_BASE_GET_IMP_ID,
35*4882a593Smuzhiyun SBI_EXT_BASE_GET_IMP_VERSION,
36*4882a593Smuzhiyun SBI_EXT_BASE_PROBE_EXT,
37*4882a593Smuzhiyun SBI_EXT_BASE_GET_MVENDORID,
38*4882a593Smuzhiyun SBI_EXT_BASE_GET_MARCHID,
39*4882a593Smuzhiyun SBI_EXT_BASE_GET_MIMPID,
40*4882a593Smuzhiyun };
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun enum sbi_ext_time_fid {
43*4882a593Smuzhiyun SBI_EXT_TIME_SET_TIMER = 0,
44*4882a593Smuzhiyun };
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun enum sbi_ext_ipi_fid {
47*4882a593Smuzhiyun SBI_EXT_IPI_SEND_IPI = 0,
48*4882a593Smuzhiyun };
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun enum sbi_ext_rfence_fid {
51*4882a593Smuzhiyun SBI_EXT_RFENCE_REMOTE_FENCE_I = 0,
52*4882a593Smuzhiyun SBI_EXT_RFENCE_REMOTE_SFENCE_VMA,
53*4882a593Smuzhiyun SBI_EXT_RFENCE_REMOTE_SFENCE_VMA_ASID,
54*4882a593Smuzhiyun SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA_VMID,
55*4882a593Smuzhiyun SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA,
56*4882a593Smuzhiyun SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA_ASID,
57*4882a593Smuzhiyun SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA,
58*4882a593Smuzhiyun };
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun enum sbi_ext_hsm_fid {
61*4882a593Smuzhiyun SBI_EXT_HSM_HART_START = 0,
62*4882a593Smuzhiyun SBI_EXT_HSM_HART_STOP,
63*4882a593Smuzhiyun SBI_EXT_HSM_HART_STATUS,
64*4882a593Smuzhiyun };
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun enum sbi_hsm_hart_status {
67*4882a593Smuzhiyun SBI_HSM_HART_STATUS_STARTED = 0,
68*4882a593Smuzhiyun SBI_HSM_HART_STATUS_STOPPED,
69*4882a593Smuzhiyun SBI_HSM_HART_STATUS_START_PENDING,
70*4882a593Smuzhiyun SBI_HSM_HART_STATUS_STOP_PENDING,
71*4882a593Smuzhiyun };
72*4882a593Smuzhiyun
73*4882a593Smuzhiyun #define SBI_SPEC_VERSION_DEFAULT 0x1
74*4882a593Smuzhiyun #define SBI_SPEC_VERSION_MAJOR_SHIFT 24
75*4882a593Smuzhiyun #define SBI_SPEC_VERSION_MAJOR_MASK 0x7f
76*4882a593Smuzhiyun #define SBI_SPEC_VERSION_MINOR_MASK 0xffffff
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun /* SBI return error codes */
79*4882a593Smuzhiyun #define SBI_SUCCESS 0
80*4882a593Smuzhiyun #define SBI_ERR_FAILURE -1
81*4882a593Smuzhiyun #define SBI_ERR_NOT_SUPPORTED -2
82*4882a593Smuzhiyun #define SBI_ERR_INVALID_PARAM -3
83*4882a593Smuzhiyun #define SBI_ERR_DENIED -4
84*4882a593Smuzhiyun #define SBI_ERR_INVALID_ADDRESS -5
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun extern unsigned long sbi_spec_version;
87*4882a593Smuzhiyun struct sbiret {
88*4882a593Smuzhiyun long error;
89*4882a593Smuzhiyun long value;
90*4882a593Smuzhiyun };
91*4882a593Smuzhiyun
92*4882a593Smuzhiyun int sbi_init(void);
93*4882a593Smuzhiyun struct sbiret sbi_ecall(int ext, int fid, unsigned long arg0,
94*4882a593Smuzhiyun unsigned long arg1, unsigned long arg2,
95*4882a593Smuzhiyun unsigned long arg3, unsigned long arg4,
96*4882a593Smuzhiyun unsigned long arg5);
97*4882a593Smuzhiyun
98*4882a593Smuzhiyun void sbi_console_putchar(int ch);
99*4882a593Smuzhiyun int sbi_console_getchar(void);
100*4882a593Smuzhiyun void sbi_set_timer(uint64_t stime_value);
101*4882a593Smuzhiyun void sbi_shutdown(void);
102*4882a593Smuzhiyun void sbi_clear_ipi(void);
103*4882a593Smuzhiyun void sbi_send_ipi(const unsigned long *hart_mask);
104*4882a593Smuzhiyun void sbi_remote_fence_i(const unsigned long *hart_mask);
105*4882a593Smuzhiyun void sbi_remote_sfence_vma(const unsigned long *hart_mask,
106*4882a593Smuzhiyun unsigned long start,
107*4882a593Smuzhiyun unsigned long size);
108*4882a593Smuzhiyun
109*4882a593Smuzhiyun void sbi_remote_sfence_vma_asid(const unsigned long *hart_mask,
110*4882a593Smuzhiyun unsigned long start,
111*4882a593Smuzhiyun unsigned long size,
112*4882a593Smuzhiyun unsigned long asid);
113*4882a593Smuzhiyun int sbi_remote_hfence_gvma(const unsigned long *hart_mask,
114*4882a593Smuzhiyun unsigned long start,
115*4882a593Smuzhiyun unsigned long size);
116*4882a593Smuzhiyun int sbi_remote_hfence_gvma_vmid(const unsigned long *hart_mask,
117*4882a593Smuzhiyun unsigned long start,
118*4882a593Smuzhiyun unsigned long size,
119*4882a593Smuzhiyun unsigned long vmid);
120*4882a593Smuzhiyun int sbi_remote_hfence_vvma(const unsigned long *hart_mask,
121*4882a593Smuzhiyun unsigned long start,
122*4882a593Smuzhiyun unsigned long size);
123*4882a593Smuzhiyun int sbi_remote_hfence_vvma_asid(const unsigned long *hart_mask,
124*4882a593Smuzhiyun unsigned long start,
125*4882a593Smuzhiyun unsigned long size,
126*4882a593Smuzhiyun unsigned long asid);
127*4882a593Smuzhiyun int sbi_probe_extension(int ext);
128*4882a593Smuzhiyun
129*4882a593Smuzhiyun /* Check if current SBI specification version is 0.1 or not */
sbi_spec_is_0_1(void)130*4882a593Smuzhiyun static inline int sbi_spec_is_0_1(void)
131*4882a593Smuzhiyun {
132*4882a593Smuzhiyun return (sbi_spec_version == SBI_SPEC_VERSION_DEFAULT) ? 1 : 0;
133*4882a593Smuzhiyun }
134*4882a593Smuzhiyun
135*4882a593Smuzhiyun /* Get the major version of SBI */
sbi_major_version(void)136*4882a593Smuzhiyun static inline unsigned long sbi_major_version(void)
137*4882a593Smuzhiyun {
138*4882a593Smuzhiyun return (sbi_spec_version >> SBI_SPEC_VERSION_MAJOR_SHIFT) &
139*4882a593Smuzhiyun SBI_SPEC_VERSION_MAJOR_MASK;
140*4882a593Smuzhiyun }
141*4882a593Smuzhiyun
142*4882a593Smuzhiyun /* Get the minor version of SBI */
sbi_minor_version(void)143*4882a593Smuzhiyun static inline unsigned long sbi_minor_version(void)
144*4882a593Smuzhiyun {
145*4882a593Smuzhiyun return sbi_spec_version & SBI_SPEC_VERSION_MINOR_MASK;
146*4882a593Smuzhiyun }
147*4882a593Smuzhiyun
148*4882a593Smuzhiyun int sbi_err_map_linux_errno(int err);
149*4882a593Smuzhiyun #else /* CONFIG_RISCV_SBI */
150*4882a593Smuzhiyun /* stubs for code that is only reachable under IS_ENABLED(CONFIG_RISCV_SBI): */
151*4882a593Smuzhiyun void sbi_set_timer(uint64_t stime_value);
152*4882a593Smuzhiyun void sbi_clear_ipi(void);
153*4882a593Smuzhiyun void sbi_send_ipi(const unsigned long *hart_mask);
154*4882a593Smuzhiyun void sbi_remote_fence_i(const unsigned long *hart_mask);
155*4882a593Smuzhiyun void sbi_init(void);
156*4882a593Smuzhiyun #endif /* CONFIG_RISCV_SBI */
157*4882a593Smuzhiyun #endif /* _ASM_RISCV_SBI_H */
158