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 };
  35
  36 enum sbi_ext_base_fid {
  37         SBI_EXT_BASE_GET_SPEC_VERSION = 0,
  38         SBI_EXT_BASE_GET_IMP_ID,
  39         SBI_EXT_BASE_GET_IMP_VERSION,
  40         SBI_EXT_BASE_PROBE_EXT,
  41         SBI_EXT_BASE_GET_MVENDORID,
  42         SBI_EXT_BASE_GET_MARCHID,
  43         SBI_EXT_BASE_GET_MIMPID,
  44 };
  45
  46 enum sbi_ext_time_fid {
  47         SBI_EXT_TIME_SET_TIMER = 0,
  48 };
  49
  50 enum sbi_ext_ipi_fid {
  51         SBI_EXT_IPI_SEND_IPI = 0,
  52 };
  53
  54 enum sbi_ext_rfence_fid {
  55         SBI_EXT_RFENCE_REMOTE_FENCE_I = 0,
  56         SBI_EXT_RFENCE_REMOTE_SFENCE_VMA,
  57         SBI_EXT_RFENCE_REMOTE_SFENCE_VMA_ASID,
  58         SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA_VMID,
  59         SBI_EXT_RFENCE_REMOTE_HFENCE_GVMA,
  60         SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA_ASID,
  61         SBI_EXT_RFENCE_REMOTE_HFENCE_VVMA,
  62 };
  63
  64 enum sbi_ext_hsm_fid {
  65         SBI_EXT_HSM_HART_START = 0,
  66         SBI_EXT_HSM_HART_STOP,
  67         SBI_EXT_HSM_HART_STATUS,
  68         SBI_EXT_HSM_HART_SUSPEND,
  69 };
  70
  71 enum sbi_hsm_hart_status {
  72         SBI_HSM_HART_STATUS_STARTED = 0,
  73         SBI_HSM_HART_STATUS_STOPPED,
  74         SBI_HSM_HART_STATUS_START_PENDING,
  75         SBI_HSM_HART_STATUS_STOP_PENDING,
  76         SBI_HSM_HART_STATUS_SUSPEND_PENDING,
  77         SBI_HSM_HART_STATUS_RESUME_PENDING,
  78 };
  79
  80 enum sbi_ext_srst_fid {
  81         SBI_EXT_SRST_RESET = 0,
  82 };
  83
  84 enum sbi_srst_reset_type {
  85         SBI_SRST_RESET_TYPE_SHUTDOWN = 0,
  86         SBI_SRST_RESET_TYPE_COLD_REBOOT,
  87         SBI_SRST_RESET_TYPE_WARM_REBOOT,
  88 };
  89
  90 enum sbi_srst_reset_reason {
  91         SBI_SRST_RESET_REASON_NONE = 0,
  92         SBI_SRST_RESET_REASON_SYS_FAILURE,
  93 };
  94
  95 enum sbi_ext_dbcn_fid {
  96         SBI_EXT_DBCN_CONSOLE_WRITE = 0,
  97         SBI_EXT_DBCN_CONSOLE_READ,
  98         SBI_EXT_DBCN_CONSOLE_WRITE_BYTE,
  99 };
 100
 101 #ifdef CONFIG_SBI_V01
 102 #define SBI_EXT_SET_TIMER               SBI_EXT_0_1_SET_TIMER
 103 #define SBI_FID_SET_TIMER               0
 104 #define SBI_EXT_SEND_IPI                SBI_EXT_0_1_SEND_IPI
 105 #define SBI_FID_SEND_IPI                0
 106 #define SBI_EXT_REMOTE_FENCE_I          SBI_EXT_0_1_REMOTE_FENCE_I
 107 #define SBI_FID_REMOTE_FENCE_I          0
 108 #define SBI_EXT_REMOTE_SFENCE_VMA       SBI_EXT_0_1_REMOTE_SFENCE_VMA
 109 #define SBI_FID_REMOTE_SFENCE_VMA       0
 110 #define SBI_EXT_REMOTE_SFENCE_VMA_ASID  SBI_EXT_0_1_REMOTE_SFENCE_VMA_ASID
 111 #define SBI_FID_REMOTE_SFENCE_VMA_ASID  0
 112 #else
 113 #define SBI_EXT_SET_TIMER               SBI_EXT_TIME
 114 #define SBI_FID_SET_TIMER               SBI_EXT_TIME_SET_TIMER
 115 #define SBI_EXT_SEND_IPI                SBI_EXT_IPI
 116 #define SBI_FID_SEND_IPI                SBI_EXT_IPI_SEND_IPI
 117 #define SBI_EXT_REMOTE_FENCE_I          SBI_EXT_RFENCE
 118 #define SBI_FID_REMOTE_FENCE_I          SBI_EXT_RFENCE_REMOTE_FENCE_I
 119 #define SBI_EXT_REMOTE_SFENCE_VMA       SBI_EXT_RFENCE
 120 #define SBI_FID_REMOTE_SFENCE_VMA       SBI_EXT_RFENCE_REMOTE_SFENCE_VMA
 121 #define SBI_EXT_REMOTE_SFENCE_VMA_ASID  SBI_EXT_RFENCE
 122 #define SBI_FID_REMOTE_SFENCE_VMA_ASID  SBI_EXT_RFENCE_REMOTE_SFENCE_VMA_ASID
 123 #endif
 124
 125 #define SBI_SPEC_VERSION_MAJOR_SHIFT    24
 126 #define SBI_SPEC_VERSION_MAJOR_MASK     0x7f
 127 #define SBI_SPEC_VERSION_MINOR_MASK     0xffffff
 128
 129 /* SBI return error codes */
 130 #define SBI_SUCCESS                     0
 131 #define SBI_ERR_FAILURE                 -1
 132 #define SBI_ERR_NOT_SUPPORTED           -2
 133 #define SBI_ERR_INVALID_PARAM           -3
 134 #define SBI_ERR_DENIED                  -4
 135 #define SBI_ERR_INVALID_ADDRESS         -5
 136
 137 struct sbiret {
 138         long error;
 139         long value;
 140 };
 141
 142 struct sbiret sbi_ecall(int ext, int fid, unsigned long arg0,
 143                         unsigned long arg1, unsigned long arg2,
 144                         unsigned long arg3, unsigned long arg4,
 145                         unsigned long arg5);
 146
 147 #ifdef CONFIG_SBI_V01
 148 void sbi_console_putchar(int ch);
 149 int sbi_console_getchar(void);
 150 void sbi_clear_ipi(void);
 151 void sbi_shutdown(void);
 152 void sbi_send_ipi(const unsigned long *hart_mask);
 153 void sbi_remote_fence_i(const unsigned long *hart_mask);
 154 void sbi_remote_sfence_vma(const unsigned long *hart_mask,
 155                            unsigned long start,
 156                            unsigned long size);
 157 void sbi_remote_sfence_vma_asid(const unsigned long *hart_mask,
 158                                 unsigned long start,
 159                                 unsigned long size,
 160                                 unsigned long asid);
 161 #endif
 162 void sbi_set_timer(uint64_t stime_value);
 163 long sbi_get_spec_version(void);
 164 int sbi_get_impl_id(void);
 165 int sbi_get_impl_version(long *version);
 166 int sbi_probe_extension(int ext);
 167 int sbi_get_mvendorid(long *mvendorid);
 168 int sbi_get_marchid(long *marchid);
 169 int sbi_get_mimpid(long *mimpid);
 170 void sbi_srst_reset(unsigned long type, unsigned long reason);
 171
 172 #endif