kvm.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366
  1. /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
  2. /*
  3. * Copyright (C) 2019 Western Digital Corporation or its affiliates.
  4. *
  5. * Authors:
  6. * Anup Patel <anup.patel@wdc.com>
  7. */
  8. #ifndef __LINUX_KVM_RISCV_H
  9. #define __LINUX_KVM_RISCV_H
  10. #ifndef __ASSEMBLY__
  11. #include <linux/types.h>
  12. #include <asm/bitsperlong.h>
  13. #include <asm/ptrace.h>
  14. #define __KVM_HAVE_IRQ_LINE
  15. #define KVM_COALESCED_MMIO_PAGE_OFFSET 1
  16. #define KVM_INTERRUPT_SET -1U
  17. #define KVM_INTERRUPT_UNSET -2U
  18. /* for KVM_GET_REGS and KVM_SET_REGS */
  19. struct kvm_regs {
  20. };
  21. /* for KVM_GET_FPU and KVM_SET_FPU */
  22. struct kvm_fpu {
  23. };
  24. /* KVM Debug exit structure */
  25. struct kvm_debug_exit_arch {
  26. };
  27. /* for KVM_SET_GUEST_DEBUG */
  28. struct kvm_guest_debug_arch {
  29. };
  30. /* definition of registers in kvm_run */
  31. struct kvm_sync_regs {
  32. };
  33. /* for KVM_GET_SREGS and KVM_SET_SREGS */
  34. struct kvm_sregs {
  35. };
  36. /* CONFIG registers for KVM_GET_ONE_REG and KVM_SET_ONE_REG */
  37. struct kvm_riscv_config {
  38. unsigned long isa;
  39. unsigned long zicbom_block_size;
  40. unsigned long mvendorid;
  41. unsigned long marchid;
  42. unsigned long mimpid;
  43. unsigned long zicboz_block_size;
  44. unsigned long satp_mode;
  45. };
  46. /* CORE registers for KVM_GET_ONE_REG and KVM_SET_ONE_REG */
  47. struct kvm_riscv_core {
  48. struct user_regs_struct regs;
  49. unsigned long mode;
  50. };
  51. /* Possible privilege modes for kvm_riscv_core */
  52. #define KVM_RISCV_MODE_S 1
  53. #define KVM_RISCV_MODE_U 0
  54. /* General CSR registers for KVM_GET_ONE_REG and KVM_SET_ONE_REG */
  55. struct kvm_riscv_csr {
  56. unsigned long sstatus;
  57. unsigned long sie;
  58. unsigned long stvec;
  59. unsigned long sscratch;
  60. unsigned long sepc;
  61. unsigned long scause;
  62. unsigned long stval;
  63. unsigned long sip;
  64. unsigned long satp;
  65. unsigned long scounteren;
  66. unsigned long senvcfg;
  67. };
  68. /* AIA CSR registers for KVM_GET_ONE_REG and KVM_SET_ONE_REG */
  69. struct kvm_riscv_aia_csr {
  70. unsigned long siselect;
  71. unsigned long iprio1;
  72. unsigned long iprio2;
  73. unsigned long sieh;
  74. unsigned long siph;
  75. unsigned long iprio1h;
  76. unsigned long iprio2h;
  77. };
  78. /* Smstateen CSR for KVM_GET_ONE_REG and KVM_SET_ONE_REG */
  79. struct kvm_riscv_smstateen_csr {
  80. unsigned long sstateen0;
  81. };
  82. /* TIMER registers for KVM_GET_ONE_REG and KVM_SET_ONE_REG */
  83. struct kvm_riscv_timer {
  84. __u64 frequency;
  85. __u64 time;
  86. __u64 compare;
  87. __u64 state;
  88. };
  89. /*
  90. * ISA extension IDs specific to KVM. This is not the same as the host ISA
  91. * extension IDs as that is internal to the host and should not be exposed
  92. * to the guest. This should always be contiguous to keep the mapping simple
  93. * in KVM implementation.
  94. */
  95. enum KVM_RISCV_ISA_EXT_ID {
  96. KVM_RISCV_ISA_EXT_A = 0,
  97. KVM_RISCV_ISA_EXT_C,
  98. KVM_RISCV_ISA_EXT_D,
  99. KVM_RISCV_ISA_EXT_F,
  100. KVM_RISCV_ISA_EXT_H,
  101. KVM_RISCV_ISA_EXT_I,
  102. KVM_RISCV_ISA_EXT_M,
  103. KVM_RISCV_ISA_EXT_SVPBMT,
  104. KVM_RISCV_ISA_EXT_SSTC,
  105. KVM_RISCV_ISA_EXT_SVINVAL,
  106. KVM_RISCV_ISA_EXT_ZIHINTPAUSE,
  107. KVM_RISCV_ISA_EXT_ZICBOM,
  108. KVM_RISCV_ISA_EXT_ZICBOZ,
  109. KVM_RISCV_ISA_EXT_ZBB,
  110. KVM_RISCV_ISA_EXT_SSAIA,
  111. KVM_RISCV_ISA_EXT_V,
  112. KVM_RISCV_ISA_EXT_SVNAPOT,
  113. KVM_RISCV_ISA_EXT_ZBA,
  114. KVM_RISCV_ISA_EXT_ZBS,
  115. KVM_RISCV_ISA_EXT_ZICNTR,
  116. KVM_RISCV_ISA_EXT_ZICSR,
  117. KVM_RISCV_ISA_EXT_ZIFENCEI,
  118. KVM_RISCV_ISA_EXT_ZIHPM,
  119. KVM_RISCV_ISA_EXT_SMSTATEEN,
  120. KVM_RISCV_ISA_EXT_ZICOND,
  121. KVM_RISCV_ISA_EXT_ZBC,
  122. KVM_RISCV_ISA_EXT_ZBKB,
  123. KVM_RISCV_ISA_EXT_ZBKC,
  124. KVM_RISCV_ISA_EXT_ZBKX,
  125. KVM_RISCV_ISA_EXT_ZKND,
  126. KVM_RISCV_ISA_EXT_ZKNE,
  127. KVM_RISCV_ISA_EXT_ZKNH,
  128. KVM_RISCV_ISA_EXT_ZKR,
  129. KVM_RISCV_ISA_EXT_ZKSED,
  130. KVM_RISCV_ISA_EXT_ZKSH,
  131. KVM_RISCV_ISA_EXT_ZKT,
  132. KVM_RISCV_ISA_EXT_ZVBB,
  133. KVM_RISCV_ISA_EXT_ZVBC,
  134. KVM_RISCV_ISA_EXT_ZVKB,
  135. KVM_RISCV_ISA_EXT_ZVKG,
  136. KVM_RISCV_ISA_EXT_ZVKNED,
  137. KVM_RISCV_ISA_EXT_ZVKNHA,
  138. KVM_RISCV_ISA_EXT_ZVKNHB,
  139. KVM_RISCV_ISA_EXT_ZVKSED,
  140. KVM_RISCV_ISA_EXT_ZVKSH,
  141. KVM_RISCV_ISA_EXT_ZVKT,
  142. KVM_RISCV_ISA_EXT_ZFH,
  143. KVM_RISCV_ISA_EXT_ZFHMIN,
  144. KVM_RISCV_ISA_EXT_ZIHINTNTL,
  145. KVM_RISCV_ISA_EXT_ZVFH,
  146. KVM_RISCV_ISA_EXT_ZVFHMIN,
  147. KVM_RISCV_ISA_EXT_ZFA,
  148. KVM_RISCV_ISA_EXT_ZTSO,
  149. KVM_RISCV_ISA_EXT_ZACAS,
  150. KVM_RISCV_ISA_EXT_SSCOFPMF,
  151. KVM_RISCV_ISA_EXT_ZIMOP,
  152. KVM_RISCV_ISA_EXT_ZCA,
  153. KVM_RISCV_ISA_EXT_ZCB,
  154. KVM_RISCV_ISA_EXT_ZCD,
  155. KVM_RISCV_ISA_EXT_ZCF,
  156. KVM_RISCV_ISA_EXT_ZCMOP,
  157. KVM_RISCV_ISA_EXT_ZAWRS,
  158. KVM_RISCV_ISA_EXT_MAX,
  159. };
  160. /*
  161. * SBI extension IDs specific to KVM. This is not the same as the SBI
  162. * extension IDs defined by the RISC-V SBI specification.
  163. */
  164. enum KVM_RISCV_SBI_EXT_ID {
  165. KVM_RISCV_SBI_EXT_V01 = 0,
  166. KVM_RISCV_SBI_EXT_TIME,
  167. KVM_RISCV_SBI_EXT_IPI,
  168. KVM_RISCV_SBI_EXT_RFENCE,
  169. KVM_RISCV_SBI_EXT_SRST,
  170. KVM_RISCV_SBI_EXT_HSM,
  171. KVM_RISCV_SBI_EXT_PMU,
  172. KVM_RISCV_SBI_EXT_EXPERIMENTAL,
  173. KVM_RISCV_SBI_EXT_VENDOR,
  174. KVM_RISCV_SBI_EXT_DBCN,
  175. KVM_RISCV_SBI_EXT_STA,
  176. KVM_RISCV_SBI_EXT_MAX,
  177. };
  178. /* SBI STA extension registers for KVM_GET_ONE_REG and KVM_SET_ONE_REG */
  179. struct kvm_riscv_sbi_sta {
  180. unsigned long shmem_lo;
  181. unsigned long shmem_hi;
  182. };
  183. /* Possible states for kvm_riscv_timer */
  184. #define KVM_RISCV_TIMER_STATE_OFF 0
  185. #define KVM_RISCV_TIMER_STATE_ON 1
  186. #define KVM_REG_SIZE(id) \
  187. (1U << (((id) & KVM_REG_SIZE_MASK) >> KVM_REG_SIZE_SHIFT))
  188. /* If you need to interpret the index values, here is the key: */
  189. #define KVM_REG_RISCV_TYPE_MASK 0x00000000FF000000
  190. #define KVM_REG_RISCV_TYPE_SHIFT 24
  191. #define KVM_REG_RISCV_SUBTYPE_MASK 0x0000000000FF0000
  192. #define KVM_REG_RISCV_SUBTYPE_SHIFT 16
  193. /* Config registers are mapped as type 1 */
  194. #define KVM_REG_RISCV_CONFIG (0x01 << KVM_REG_RISCV_TYPE_SHIFT)
  195. #define KVM_REG_RISCV_CONFIG_REG(name) \
  196. (offsetof(struct kvm_riscv_config, name) / sizeof(unsigned long))
  197. /* Core registers are mapped as type 2 */
  198. #define KVM_REG_RISCV_CORE (0x02 << KVM_REG_RISCV_TYPE_SHIFT)
  199. #define KVM_REG_RISCV_CORE_REG(name) \
  200. (offsetof(struct kvm_riscv_core, name) / sizeof(unsigned long))
  201. /* Control and status registers are mapped as type 3 */
  202. #define KVM_REG_RISCV_CSR (0x03 << KVM_REG_RISCV_TYPE_SHIFT)
  203. #define KVM_REG_RISCV_CSR_GENERAL (0x0 << KVM_REG_RISCV_SUBTYPE_SHIFT)
  204. #define KVM_REG_RISCV_CSR_AIA (0x1 << KVM_REG_RISCV_SUBTYPE_SHIFT)
  205. #define KVM_REG_RISCV_CSR_SMSTATEEN (0x2 << KVM_REG_RISCV_SUBTYPE_SHIFT)
  206. #define KVM_REG_RISCV_CSR_REG(name) \
  207. (offsetof(struct kvm_riscv_csr, name) / sizeof(unsigned long))
  208. #define KVM_REG_RISCV_CSR_AIA_REG(name) \
  209. (offsetof(struct kvm_riscv_aia_csr, name) / sizeof(unsigned long))
  210. #define KVM_REG_RISCV_CSR_SMSTATEEN_REG(name) \
  211. (offsetof(struct kvm_riscv_smstateen_csr, name) / sizeof(unsigned long))
  212. /* Timer registers are mapped as type 4 */
  213. #define KVM_REG_RISCV_TIMER (0x04 << KVM_REG_RISCV_TYPE_SHIFT)
  214. #define KVM_REG_RISCV_TIMER_REG(name) \
  215. (offsetof(struct kvm_riscv_timer, name) / sizeof(__u64))
  216. /* F extension registers are mapped as type 5 */
  217. #define KVM_REG_RISCV_FP_F (0x05 << KVM_REG_RISCV_TYPE_SHIFT)
  218. #define KVM_REG_RISCV_FP_F_REG(name) \
  219. (offsetof(struct __riscv_f_ext_state, name) / sizeof(__u32))
  220. /* D extension registers are mapped as type 6 */
  221. #define KVM_REG_RISCV_FP_D (0x06 << KVM_REG_RISCV_TYPE_SHIFT)
  222. #define KVM_REG_RISCV_FP_D_REG(name) \
  223. (offsetof(struct __riscv_d_ext_state, name) / sizeof(__u64))
  224. /* ISA Extension registers are mapped as type 7 */
  225. #define KVM_REG_RISCV_ISA_EXT (0x07 << KVM_REG_RISCV_TYPE_SHIFT)
  226. #define KVM_REG_RISCV_ISA_SINGLE (0x0 << KVM_REG_RISCV_SUBTYPE_SHIFT)
  227. #define KVM_REG_RISCV_ISA_MULTI_EN (0x1 << KVM_REG_RISCV_SUBTYPE_SHIFT)
  228. #define KVM_REG_RISCV_ISA_MULTI_DIS (0x2 << KVM_REG_RISCV_SUBTYPE_SHIFT)
  229. #define KVM_REG_RISCV_ISA_MULTI_REG(__ext_id) \
  230. ((__ext_id) / __BITS_PER_LONG)
  231. #define KVM_REG_RISCV_ISA_MULTI_MASK(__ext_id) \
  232. (1UL << ((__ext_id) % __BITS_PER_LONG))
  233. #define KVM_REG_RISCV_ISA_MULTI_REG_LAST \
  234. KVM_REG_RISCV_ISA_MULTI_REG(KVM_RISCV_ISA_EXT_MAX - 1)
  235. /* SBI extension registers are mapped as type 8 */
  236. #define KVM_REG_RISCV_SBI_EXT (0x08 << KVM_REG_RISCV_TYPE_SHIFT)
  237. #define KVM_REG_RISCV_SBI_SINGLE (0x0 << KVM_REG_RISCV_SUBTYPE_SHIFT)
  238. #define KVM_REG_RISCV_SBI_MULTI_EN (0x1 << KVM_REG_RISCV_SUBTYPE_SHIFT)
  239. #define KVM_REG_RISCV_SBI_MULTI_DIS (0x2 << KVM_REG_RISCV_SUBTYPE_SHIFT)
  240. #define KVM_REG_RISCV_SBI_MULTI_REG(__ext_id) \
  241. ((__ext_id) / __BITS_PER_LONG)
  242. #define KVM_REG_RISCV_SBI_MULTI_MASK(__ext_id) \
  243. (1UL << ((__ext_id) % __BITS_PER_LONG))
  244. #define KVM_REG_RISCV_SBI_MULTI_REG_LAST \
  245. KVM_REG_RISCV_SBI_MULTI_REG(KVM_RISCV_SBI_EXT_MAX - 1)
  246. /* V extension registers are mapped as type 9 */
  247. #define KVM_REG_RISCV_VECTOR (0x09 << KVM_REG_RISCV_TYPE_SHIFT)
  248. #define KVM_REG_RISCV_VECTOR_CSR_REG(name) \
  249. (offsetof(struct __riscv_v_ext_state, name) / sizeof(unsigned long))
  250. #define KVM_REG_RISCV_VECTOR_REG(n) \
  251. ((n) + sizeof(struct __riscv_v_ext_state) / sizeof(unsigned long))
  252. /* Registers for specific SBI extensions are mapped as type 10 */
  253. #define KVM_REG_RISCV_SBI_STATE (0x0a << KVM_REG_RISCV_TYPE_SHIFT)
  254. #define KVM_REG_RISCV_SBI_STA (0x0 << KVM_REG_RISCV_SUBTYPE_SHIFT)
  255. #define KVM_REG_RISCV_SBI_STA_REG(name) \
  256. (offsetof(struct kvm_riscv_sbi_sta, name) / sizeof(unsigned long))
  257. /* Device Control API: RISC-V AIA */
  258. #define KVM_DEV_RISCV_APLIC_ALIGN 0x1000
  259. #define KVM_DEV_RISCV_APLIC_SIZE 0x4000
  260. #define KVM_DEV_RISCV_APLIC_MAX_HARTS 0x4000
  261. #define KVM_DEV_RISCV_IMSIC_ALIGN 0x1000
  262. #define KVM_DEV_RISCV_IMSIC_SIZE 0x1000
  263. #define KVM_DEV_RISCV_AIA_GRP_CONFIG 0
  264. #define KVM_DEV_RISCV_AIA_CONFIG_MODE 0
  265. #define KVM_DEV_RISCV_AIA_CONFIG_IDS 1
  266. #define KVM_DEV_RISCV_AIA_CONFIG_SRCS 2
  267. #define KVM_DEV_RISCV_AIA_CONFIG_GROUP_BITS 3
  268. #define KVM_DEV_RISCV_AIA_CONFIG_GROUP_SHIFT 4
  269. #define KVM_DEV_RISCV_AIA_CONFIG_HART_BITS 5
  270. #define KVM_DEV_RISCV_AIA_CONFIG_GUEST_BITS 6
  271. /*
  272. * Modes of RISC-V AIA device:
  273. * 1) EMUL (aka Emulation): Trap-n-emulate IMSIC
  274. * 2) HWACCEL (aka HW Acceleration): Virtualize IMSIC using IMSIC guest files
  275. * 3) AUTO (aka Automatic): Virtualize IMSIC using IMSIC guest files whenever
  276. * available otherwise fallback to trap-n-emulation
  277. */
  278. #define KVM_DEV_RISCV_AIA_MODE_EMUL 0
  279. #define KVM_DEV_RISCV_AIA_MODE_HWACCEL 1
  280. #define KVM_DEV_RISCV_AIA_MODE_AUTO 2
  281. #define KVM_DEV_RISCV_AIA_IDS_MIN 63
  282. #define KVM_DEV_RISCV_AIA_IDS_MAX 2048
  283. #define KVM_DEV_RISCV_AIA_SRCS_MAX 1024
  284. #define KVM_DEV_RISCV_AIA_GROUP_BITS_MAX 8
  285. #define KVM_DEV_RISCV_AIA_GROUP_SHIFT_MIN 24
  286. #define KVM_DEV_RISCV_AIA_GROUP_SHIFT_MAX 56
  287. #define KVM_DEV_RISCV_AIA_HART_BITS_MAX 16
  288. #define KVM_DEV_RISCV_AIA_GUEST_BITS_MAX 8
  289. #define KVM_DEV_RISCV_AIA_GRP_ADDR 1
  290. #define KVM_DEV_RISCV_AIA_ADDR_APLIC 0
  291. #define KVM_DEV_RISCV_AIA_ADDR_IMSIC(__vcpu) (1 + (__vcpu))
  292. #define KVM_DEV_RISCV_AIA_ADDR_MAX \
  293. (1 + KVM_DEV_RISCV_APLIC_MAX_HARTS)
  294. #define KVM_DEV_RISCV_AIA_GRP_CTRL 2
  295. #define KVM_DEV_RISCV_AIA_CTRL_INIT 0
  296. /*
  297. * The device attribute type contains the memory mapped offset of the
  298. * APLIC register (range 0x0000-0x3FFF) and it must be 4-byte aligned.
  299. */
  300. #define KVM_DEV_RISCV_AIA_GRP_APLIC 3
  301. /*
  302. * The lower 12-bits of the device attribute type contains the iselect
  303. * value of the IMSIC register (range 0x70-0xFF) whereas the higher order
  304. * bits contains the VCPU id.
  305. */
  306. #define KVM_DEV_RISCV_AIA_GRP_IMSIC 4
  307. #define KVM_DEV_RISCV_AIA_IMSIC_ISEL_BITS 12
  308. #define KVM_DEV_RISCV_AIA_IMSIC_ISEL_MASK \
  309. ((1U << KVM_DEV_RISCV_AIA_IMSIC_ISEL_BITS) - 1)
  310. #define KVM_DEV_RISCV_AIA_IMSIC_MKATTR(__vcpu, __isel) \
  311. (((__vcpu) << KVM_DEV_RISCV_AIA_IMSIC_ISEL_BITS) | \
  312. ((__isel) & KVM_DEV_RISCV_AIA_IMSIC_ISEL_MASK))
  313. #define KVM_DEV_RISCV_AIA_IMSIC_GET_ISEL(__attr) \
  314. ((__attr) & KVM_DEV_RISCV_AIA_IMSIC_ISEL_MASK)
  315. #define KVM_DEV_RISCV_AIA_IMSIC_GET_VCPU(__attr) \
  316. ((__attr) >> KVM_DEV_RISCV_AIA_IMSIC_ISEL_BITS)
  317. /* One single KVM irqchip, ie. the AIA */
  318. #define KVM_NR_IRQCHIPS 1
  319. #endif
  320. #endif /* __LINUX_KVM_RISCV_H */