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