arch/riscv/include/asm/sbi.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright (C) 2015 Regents of the University of California
   4  * Copyright (c) 2020 Western Digital Corporation or its affiliates.
   5  *
   6  * Taken from Linux arch/riscv/include/asm/sbi.h
   7  */
   8
   9 #ifndef _ASM_RISCV_SBI_H
  10 #define _ASM_RISCV_SBI_H
  11
  12 #include <linux/types.h>
  13
  14 enum sbi_ext_id {
  15         SBI_EXT_0_1_SET_TIMER = 0x0,
  16         SBI_EXT_0_1_CONSOLE_PUTCHAR = 0x1,
  17         SBI_EXT_0_1_CONSOLE_GETCHAR = 0x2,
  18         SBI_EXT_0_1_CLEAR_IPI = 0x3,
  19         SBI_EXT_0_1_SEND_IPI = 0x4,
  20         SBI_EXT_0_1_REMOTE_FENCE_I = 0x5,
  21         SBI_EXT_0_1_REMOTE_SFENCE_VMA = 0x6,
  22         SBI_EXT_0_1_REMOTE_SFENCE_VMA_ASID = 0x7,
  23         SBI_EXT_0_1_SHUTDOWN = 0x8,
  24         SBI_EXT_BASE = 0x10,
  25         SBI_EXT_TIME = 0x54494D45,
  26         SBI_EXT_IPI = 0x735049,
  27         SBI_EXT_RFENCE = 0x52464E43,
  28         SBI_EXT_HSM = 0x48534D,
  29         SBI_EXT_SRST = 0x53525354,
  30         SBI_EXT_PMU = 0x504D55,
  31         SBI_EXT_DBCN = 0x4442434E,
  32         SBI_EXT_SUSP = 0x53555350,
  33         SBI_EXT_CPPC = 0x43505043,
  34         SBI_EXT_NACL = 0x4E41434C,
  35         SBI_EXT_STA = 0x535441,
  36 };
  37
  38 enum sbi_ext_base_fid {
  39         SBI_EXT_BASE_GET_SPEC_VERSION = 0,
  40         SBI_EXT_BASE_GET_IMP_ID,
  41         SBI_EXT_BASE_GET_IMP_VERSION,
  42         SBI_EXT_BASE_PROBE_EXT,
  43         SBI_EXT_BASE_GET_MVENDORID,
  44         SBI_EXT_BASE_GET_MARCHID,
  45         SBI_EXT_BASE_GET_MIMPID,
  46 };
  47
  48 enum sbi_ext_time_fid {
  49         SBI_EXT_TIME_SET_TIMER = 0,
  50 };
  51
  52 enum sbi_ext_ipi_fid {
  53         SBI_EXT_IPI_SEND_IPI = 0,
  54 };
  55
  56 enum sbi_ext_rfence_fid {
  57         SBI_EXT_RFENCE_REMOTE_FENCE_I = 0,
  58         SBI_EXT_RFENCE_REMOTE_SFENCE_VMA,
  59         SBI_EXT_RFENCE_REMOTE_SFENCE_VMA_ASID,
  60         SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA_VMID,
  61         SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA,
  62         SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA_ASID,
  63         SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA,
  64 };
  65
  66 enum sbi_ext_hsm_fid {
  67         SBI_EXT_HSM_HART_START = 0,
  68         SBI_EXT_HSM_HART_STOP,
  69         SBI_EXT_HSM_HART_STATUS,
  70         SBI_EXT_HSM_HART_SUSPEND,
  71 };
  72
  73 enum sbi_hsm_hart_status {
  74         SBI_HSM_HART_STATUS_STARTED = 0,
  75         SBI_HSM_HART_STATUS_STOPPED,
  76         SBI_HSM_HART_STATUS_START_PENDING,
  77         SBI_HSM_HART_STATUS_STOP_PENDING,
  78         SBI_HSM_HART_STATUS_SUSPEND_PENDING,
  79         SBI_HSM_HART_STATUS_RESUME_PENDING,
  80 };
  81
  82 enum sbi_ext_srst_fid {
  83         SBI_EXT_SRST_RESET = 0,
  84 };
  85
  86 enum sbi_srst_reset_type {
  87         SBI_SRST_RESET_TYPE_SHUTDOWN = 0,
  88         SBI_SRST_RESET_TYPE_COLD_REBOOT,
  89         SBI_SRST_RESET_TYPE_WARM_REBOOT,
  90 };
  91
  92 enum sbi_srst_reset_reason {
  93         SBI_SRST_RESET_REASON_NONE = 0,
  94         SBI_SRST_RESET_REASON_SYS_FAILURE,
  95 };
  96
  97 enum sbi_ext_dbcn_fid {
  98         SBI_EXT_DBCN_CONSOLE_WRITE = 0,
  99         SBI_EXT_DBCN_CONSOLE_READ,
 100         SBI_EXT_DBCN_CONSOLE_WRITE_BYTE,
 101 };
 102
 103 #ifdef CONFIG_SBI_V01
 104 #define SBI_EXT_SET_TIMER               SBI_EXT_0_1_SET_TIMER
 105 #define SBI_FID_SET_TIMER               0
 106 #define SBI_EXT_SEND_IPI                SBI_EXT_0_1_SEND_IPI
 107 #define SBI_FID_SEND_IPI                0
 108 #define SBI_EXT_REMOTE_FENCE_I          SBI_EXT_0_1_REMOTE_FENCE_I
 109 #define SBI_FID_REMOTE_FENCE_I          0
 110 #define SBI_EXT_REMOTE_SFENCE_VMA       SBI_EXT_0_1_REMOTE_SFENCE_VMA
 111 #define SBI_FID_REMOTE_SFENCE_VMA       0
 112 #define SBI_EXT_REMOTE_SFENCE_VMA_ASID  SBI_EXT_0_1_REMOTE_SFENCE_VMA_ASID
 113 #define SBI_FID_REMOTE_SFENCE_VMA_ASID  0
 114 #else
 115 #define SBI_EXT_SET_TIMER               SBI_EXT_TIME
 116 #define SBI_FID_SET_TIMER               SBI_EXT_TIME_SET_TIMER
 117 #define SBI_EXT_SEND_IPI                SBI_EXT_IPI
 118 #define SBI_FID_SEND_IPI                SBI_EXT_IPI_SEND_IPI
 119 #define SBI_EXT_REMOTE_FENCE_I          SBI_EXT_RFENCE
 120 #define SBI_FID_REMOTE_FENCE_I          SBI_EXT_RFENCE_REMOTE_FENCE_I
 121 #define SBI_EXT_REMOTE_SFENCE_VMA       SBI_EXT_RFENCE
 122 #define SBI_FID_REMOTE_SFENCE_VMA       SBI_EXT_RFENCE_REMOTE_SFENCE_VMA
 123 #define SBI_EXT_REMOTE_SFENCE_VMA_ASID  SBI_EXT_RFENCE
 124 #define SBI_FID_REMOTE_SFENCE_VMA_ASID  SBI_EXT_RFENCE_REMOTE_SFENCE_VMA_ASID
 125 #endif
 126
 127 #define SBI_SPEC_VERSION_MAJOR_SHIFT    24
 128 #define SBI_SPEC_VERSION_MAJOR_MASK     0x7f
 129 #define SBI_SPEC_VERSION_MINOR_MASK     0xffffff
 130
 131 /* SBI return error codes */
 132 #define SBI_SUCCESS                     0
 133 #define SBI_ERR_FAILURE                 -1
 134 #define SBI_ERR_NOT_SUPPORTED           -2
 135 #define SBI_ERR_INVALID_PARAM           -3
 136 #define SBI_ERR_DENIED                  -4
 137 #define SBI_ERR_INVALID_ADDRESS         -5
 138
 139 struct sbiret {
 140         long error;
 141         long value;
 142 };
 143
 144 struct sbiret sbi_ecall(int ext, int fid, unsigned long arg0,
 145                         unsigned long arg1, unsigned long arg2,
 146                         unsigned long arg3, unsigned long arg4,
 147                         unsigned long arg5);
 148
 149 #ifdef CONFIG_SBI_V01
 150 void sbi_console_putchar(int ch);
 151 int sbi_console_getchar(void);
 152 void sbi_clear_ipi(void);
 153 void sbi_shutdown(void);
 154 void sbi_send_ipi(const unsigned long *hart_mask);
 155 void sbi_remote_fence_i(const unsigned long *hart_mask);
 156 void sbi_remote_sfence_vma(const unsigned long *hart_mask,
 157                            unsigned long start,
 158                            unsigned long size);
 159 void sbi_remote_sfence_vma_asid(const unsigned long *hart_mask,
 160                                 unsigned long start,
 161                                 unsigned long size,
 162                                 unsigned long asid);
 163 #endif
 164 void sbi_set_timer(uint64_t stime_value);
 165 long sbi_get_spec_version(void);
 166 int sbi_get_impl_id(void);
 167 int sbi_get_impl_version(long *version);
 168 int sbi_probe_extension(int ext);
 169 int sbi_get_mvendorid(long *mvendorid);
 170 int sbi_get_marchid(long *marchid);
 171 int sbi_get_mimpid(long *mimpid);
 172 void sbi_srst_reset(unsigned long type, unsigned long reason);
 173
 174 #endif