sys/riscv/include/sbi.h

   1 /*-
   2  * Copyright (c) 2016-2017 Ruslan Bukin <br@bsdpad.com>
   3  * All rights reserved.
   4  * Copyright (c) 2019 Mitchell Horne <mhorne@FreeBSD.org>
   5  *
   6  * Portions of this software were developed by SRI International and the
   7  * University of Cambridge Computer Laboratory under DARPA/AFRL contract
   8  * FA8750-10-C-0237 ("CTSRD"), as part of the DARPA CRASH research programme.
   9  *
  10  * Portions of this software were developed by the University of Cambridge
  11  * Computer Laboratory as part of the CTSRD Project, with support from the
  12  * UK Higher Education Innovation Fund (HEIF).
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions
  16  * are met:
  17  * 1. Redistributions of source code must retain the above copyright
  18  *    notice, this list of conditions and the following disclaimer.
  19  * 2. Redistributions in binary form must reproduce the above copyright
  20  *    notice, this list of conditions and the following disclaimer in the
  21  *    documentation and/or other materials provided with the distribution.
  22  *
  23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33  * SUCH DAMAGE.
  34  *
  35  * $FreeBSD$
  36  */
  37
  38 #ifndef _MACHINE_SBI_H_
  39 #define _MACHINE_SBI_H_
  40
  41 /* SBI Specification Version */
  42 #define SBI_SPEC_VERS_MAJOR_OFFSET      24
  43 #define SBI_SPEC_VERS_MAJOR_MASK        (0x7F << SBI_SPEC_VERS_MAJOR_OFFSET)
  44 #define SBI_SPEC_VERS_MINOR_OFFSET      0
  45 #define SBI_SPEC_VERS_MINOR_MASK        (0xFFFFFF << SBI_SPEC_VERS_MINOR_OFFSET)
  46
  47 /* SBI Implementation IDs */
  48 #define SBI_IMPL_ID_BBL                 0
  49 #define SBI_IMPL_ID_OPENSBI             1
  50
  51 /* SBI Error Codes */
  52 #define SBI_SUCCESS                     0
  53 #define SBI_ERR_FAILURE                 -1
  54 #define SBI_ERR_NOT_SUPPORTED           -2
  55 #define SBI_ERR_INVALID_PARAM           -3
  56 #define SBI_ERR_DENIED                  -4
  57 #define SBI_ERR_INVALID_ADDRESS         -5
  58
  59 /* SBI Base Extension */
  60 #define SBI_EXT_ID_BASE                 0x10
  61 #define SBI_BASE_GET_SPEC_VERSION       0
  62 #define SBI_BASE_GET_IMPL_ID            1
  63 #define SBI_BASE_GET_IMPL_VERSION       2
  64 #define SBI_BASE_PROBE_EXTENSION        3
  65 #define SBI_BASE_GET_MVENDORID          4
  66 #define SBI_BASE_GET_MARCHID            5
  67 #define SBI_BASE_GET_MIMPID             6
  68
  69 /* Legacy Extensions */
  70 #define SBI_SET_TIMER                   0
  71 #define SBI_CONSOLE_PUTCHAR             1
  72 #define SBI_CONSOLE_GETCHAR             2
  73 #define SBI_CLEAR_IPI                   3
  74 #define SBI_SEND_IPI                    4
  75 #define SBI_REMOTE_FENCE_I              5
  76 #define SBI_REMOTE_SFENCE_VMA           6
  77 #define SBI_REMOTE_SFENCE_VMA_ASID      7
  78 #define SBI_SHUTDOWN                    8
  79
  80 #define SBI_CALL0(e, f)                 SBI_CALL4(e, f, 0, 0, 0, 0)
  81 #define SBI_CALL1(e, f, p1)             SBI_CALL4(e, f, p1, 0, 0, 0)
  82 #define SBI_CALL2(e, f, p1, p2)         SBI_CALL4(e, f, p1, p2, 0, 0)
  83 #define SBI_CALL3(e, f, p1, p2, p3)     SBI_CALL4(e, f, p1, p2, p3, 0)
  84 #define SBI_CALL4(e, f, p1, p2, p3, p4) sbi_call(e, f, p1, p2, p3, p4)
  85
  86 /*
  87  * Documentation available at
  88  * https://github.com/riscv/riscv-sbi-doc/blob/master/riscv-sbi.adoc
  89  */
  90
  91 struct sbi_ret {
  92         long error;
  93         long value;
  94 };
  95
  96 static __inline struct sbi_ret
  97 sbi_call(uint64_t arg7, uint64_t arg6, uint64_t arg0, uint64_t arg1,
  98     uint64_t arg2, uint64_t arg3)
  99 {
 100         struct sbi_ret ret;
 101
 102         register uintptr_t a0 __asm ("a0") = (uintptr_t)(arg0);
 103         register uintptr_t a1 __asm ("a1") = (uintptr_t)(arg1);
 104         register uintptr_t a2 __asm ("a2") = (uintptr_t)(arg2);
 105         register uintptr_t a3 __asm ("a3") = (uintptr_t)(arg3);
 106         register uintptr_t a6 __asm ("a6") = (uintptr_t)(arg6);
 107         register uintptr_t a7 __asm ("a7") = (uintptr_t)(arg7);
 108
 109         __asm __volatile(                       \
 110                 "ecall"                         \
 111                 :"+r"(a0), "+r"(a1)             \
 112                 :"r"(a2), "r"(a3), "r"(a6), "r"(a7)     \
 113                 :"memory");
 114
 115         ret.error = a0;
 116         ret.value = a1;
 117         return (ret);
 118 }
 119
 120 /* Base extension functions and variables. */
 121 extern u_long sbi_spec_version;
 122 extern u_long sbi_impl_id;
 123 extern u_long sbi_impl_version;
 124
 125 static __inline long
 126 sbi_probe_extension(long id)
 127 {
 128         return (SBI_CALL1(SBI_EXT_ID_BASE, SBI_BASE_PROBE_EXTENSION, id).value);
 129 }
 130
 131 /* Legacy extension functions. */
 132 static __inline void
 133 sbi_console_putchar(int ch)
 134 {
 135
 136         (void)SBI_CALL1(SBI_CONSOLE_PUTCHAR, 0, ch);
 137 }
 138
 139 static __inline int
 140 sbi_console_getchar(void)
 141 {
 142
 143         /*
 144          * XXX: The "error" is returned here because legacy SBI functions
 145          * continue to return their value in a0.
 146          */
 147         return (SBI_CALL0(SBI_CONSOLE_GETCHAR, 0).error);
 148 }
 149
 150 static __inline void
 151 sbi_set_timer(uint64_t val)
 152 {
 153
 154         (void)SBI_CALL1(SBI_SET_TIMER, 0, val);
 155 }
 156
 157 static __inline void
 158 sbi_shutdown(void)
 159 {
 160
 161         (void)SBI_CALL0(SBI_SHUTDOWN, 0);
 162 }
 163
 164 static __inline void
 165 sbi_clear_ipi(void)
 166 {
 167
 168         (void)SBI_CALL0(SBI_CLEAR_IPI, 0);
 169 }
 170
 171 static __inline void
 172 sbi_send_ipi(const unsigned long *hart_mask)
 173 {
 174
 175         (void)SBI_CALL1(SBI_SEND_IPI, 0, (uint64_t)hart_mask);
 176 }
 177
 178 static __inline void
 179 sbi_remote_fence_i(const unsigned long *hart_mask)
 180 {
 181
 182         (void)SBI_CALL1(SBI_REMOTE_FENCE_I, 0, (uint64_t)hart_mask);
 183 }
 184
 185 static __inline void
 186 sbi_remote_sfence_vma(const unsigned long *hart_mask,
 187     unsigned long start, unsigned long size)
 188 {
 189
 190         (void)SBI_CALL3(SBI_REMOTE_SFENCE_VMA, 0, (uint64_t)hart_mask, start,
 191             size);
 192 }
 193
 194 static __inline void
 195 sbi_remote_sfence_vma_asid(const unsigned long *hart_mask,
 196     unsigned long start, unsigned long size,
 197     unsigned long asid)
 198 {
 199
 200         (void)SBI_CALL4(SBI_REMOTE_SFENCE_VMA_ASID, 0, (uint64_t)hart_mask,
 201             start, size, asid);
 202 }
 203
 204 void sbi_print_version(void);
 205 void sbi_init(void);
 206
 207 #endif /* !_MACHINE_SBI_H_ */