| /* SPDX-License-Identifier: GPL-2.0-only */ |
| /* |
| * Copyright © 2022-2023 Rivos Inc. |
| * Copyright © 2023 FORTH-ICS/CARV |
| * Copyright © 2023 RISC-V IOMMU Task Group |
| * |
| * RISC-V IOMMU - Register Layout and Data Structures. |
| * |
| * Based on the IOMMU spec version 1.0, 3/2023 |
| * https://github.com/riscv-non-isa/riscv-iommu |
| */ |
| |
| #ifndef HW_RISCV_IOMMU_BITS_H |
| #define HW_RISCV_IOMMU_BITS_H |
| |
| #define RISCV_IOMMU_SPEC_DOT_VER 0x010 |
| |
| #ifndef GENMASK_ULL |
| #define GENMASK_ULL(h, l) (((~0ULL) >> (63 - (h) + (l))) << (l)) |
| #endif |
| |
| /* |
| * struct riscv_iommu_fq_record - Fault/Event Queue Record |
| * See section 3.2 for more info. |
| */ |
| struct riscv_iommu_fq_record { |
| uint64_t hdr; |
| uint64_t _reserved; |
| uint64_t iotval; |
| uint64_t iotval2; |
| }; |
| /* Header fields */ |
| #define RISCV_IOMMU_FQ_HDR_CAUSE GENMASK_ULL(11, 0) |
| #define RISCV_IOMMU_FQ_HDR_PID GENMASK_ULL(31, 12) |
| #define RISCV_IOMMU_FQ_HDR_PV BIT_ULL(32) |
| #define RISCV_IOMMU_FQ_HDR_TTYPE GENMASK_ULL(39, 34) |
| #define RISCV_IOMMU_FQ_HDR_DID GENMASK_ULL(63, 40) |
| |
| /* |
| * struct riscv_iommu_pq_record - PCIe Page Request record |
| * For more infos on the PCIe Page Request queue see chapter 3.3. |
| */ |
| struct riscv_iommu_pq_record { |
| uint64_t hdr; |
| uint64_t payload; |
| }; |
| /* Header fields */ |
| #define RISCV_IOMMU_PREQ_HDR_PID GENMASK_ULL(31, 12) |
| #define RISCV_IOMMU_PREQ_HDR_PV BIT_ULL(32) |
| #define RISCV_IOMMU_PREQ_HDR_PRIV BIT_ULL(33) |
| #define RISCV_IOMMU_PREQ_HDR_EXEC BIT_ULL(34) |
| #define RISCV_IOMMU_PREQ_HDR_DID GENMASK_ULL(63, 40) |
| /* Payload fields */ |
| #define RISCV_IOMMU_PREQ_PAYLOAD_M GENMASK_ULL(2, 0) |
| |
| /* Common field positions */ |
| #define RISCV_IOMMU_PPN_FIELD GENMASK_ULL(53, 10) |
| #define RISCV_IOMMU_QUEUE_LOGSZ_FIELD GENMASK_ULL(4, 0) |
| #define RISCV_IOMMU_QUEUE_INDEX_FIELD GENMASK_ULL(31, 0) |
| #define RISCV_IOMMU_QUEUE_ENABLE BIT(0) |
| #define RISCV_IOMMU_QUEUE_INTR_ENABLE BIT(1) |
| #define RISCV_IOMMU_QUEUE_MEM_FAULT BIT(8) |
| #define RISCV_IOMMU_QUEUE_OVERFLOW BIT(9) |
| #define RISCV_IOMMU_QUEUE_ACTIVE BIT(16) |
| #define RISCV_IOMMU_QUEUE_BUSY BIT(17) |
| #define RISCV_IOMMU_ATP_PPN_FIELD GENMASK_ULL(43, 0) |
| #define RISCV_IOMMU_ATP_MODE_FIELD GENMASK_ULL(63, 60) |
| |
| /* 5.3 IOMMU Capabilities (64bits) */ |
| #define RISCV_IOMMU_REG_CAP 0x0000 |
| #define RISCV_IOMMU_CAP_VERSION GENMASK_ULL(7, 0) |
| #define RISCV_IOMMU_CAP_SV32 BIT_ULL(8) |
| #define RISCV_IOMMU_CAP_SV39 BIT_ULL(9) |
| #define RISCV_IOMMU_CAP_SV48 BIT_ULL(10) |
| #define RISCV_IOMMU_CAP_SV57 BIT_ULL(11) |
| #define RISCV_IOMMU_CAP_SV32X4 BIT_ULL(16) |
| #define RISCV_IOMMU_CAP_SV39X4 BIT_ULL(17) |
| #define RISCV_IOMMU_CAP_SV48X4 BIT_ULL(18) |
| #define RISCV_IOMMU_CAP_SV57X4 BIT_ULL(19) |
| #define RISCV_IOMMU_CAP_MSI_FLAT BIT_ULL(22) |
| #define RISCV_IOMMU_CAP_MSI_MRIF BIT_ULL(23) |
| #define RISCV_IOMMU_CAP_T2GPA BIT_ULL(26) |
| #define RISCV_IOMMU_CAP_IGS GENMASK_ULL(29, 28) |
| #define RISCV_IOMMU_CAP_PAS GENMASK_ULL(37, 32) |
| #define RISCV_IOMMU_CAP_PD8 BIT_ULL(38) |
| #define RISCV_IOMMU_CAP_PD17 BIT_ULL(39) |
| #define RISCV_IOMMU_CAP_PD20 BIT_ULL(40) |
| |
| /* 5.4 Features control register (32bits) */ |
| #define RISCV_IOMMU_REG_FCTL 0x0008 |
| #define RISCV_IOMMU_FCTL_BE BIT(0) |
| #define RISCV_IOMMU_FCTL_WSI BIT(1) |
| #define RISCV_IOMMU_FCTL_GXL BIT(2) |
| |
| /* 5.5 Device-directory-table pointer (64bits) */ |
| #define RISCV_IOMMU_REG_DDTP 0x0010 |
| #define RISCV_IOMMU_DDTP_MODE GENMASK_ULL(3, 0) |
| #define RISCV_IOMMU_DDTP_BUSY BIT_ULL(4) |
| #define RISCV_IOMMU_DDTP_PPN RISCV_IOMMU_PPN_FIELD |
| |
| enum riscv_iommu_ddtp_modes { |
| RISCV_IOMMU_DDTP_MODE_OFF = 0, |
| RISCV_IOMMU_DDTP_MODE_BARE = 1, |
| RISCV_IOMMU_DDTP_MODE_1LVL = 2, |
| RISCV_IOMMU_DDTP_MODE_2LVL = 3, |
| RISCV_IOMMU_DDTP_MODE_3LVL = 4, |
| RISCV_IOMMU_DDTP_MODE_MAX = 4 |
| }; |
| |
| /* 5.6 Command Queue Base (64bits) */ |
| #define RISCV_IOMMU_REG_CQB 0x0018 |
| #define RISCV_IOMMU_CQB_LOG2SZ RISCV_IOMMU_QUEUE_LOGSZ_FIELD |
| #define RISCV_IOMMU_CQB_PPN RISCV_IOMMU_PPN_FIELD |
| |
| /* 5.7 Command Queue head (32bits) */ |
| #define RISCV_IOMMU_REG_CQH 0x0020 |
| |
| /* 5.8 Command Queue tail (32bits) */ |
| #define RISCV_IOMMU_REG_CQT 0x0024 |
| |
| /* 5.9 Fault Queue Base (64bits) */ |
| #define RISCV_IOMMU_REG_FQB 0x0028 |
| #define RISCV_IOMMU_FQB_LOG2SZ RISCV_IOMMU_QUEUE_LOGSZ_FIELD |
| #define RISCV_IOMMU_FQB_PPN RISCV_IOMMU_PPN_FIELD |
| |
| /* 5.10 Fault Queue Head (32bits) */ |
| #define RISCV_IOMMU_REG_FQH 0x0030 |
| |
| /* 5.11 Fault Queue tail (32bits) */ |
| #define RISCV_IOMMU_REG_FQT 0x0034 |
| |
| /* 5.12 Page Request Queue base (64bits) */ |
| #define RISCV_IOMMU_REG_PQB 0x0038 |
| #define RISCV_IOMMU_PQB_LOG2SZ RISCV_IOMMU_QUEUE_LOGSZ_FIELD |
| #define RISCV_IOMMU_PQB_PPN RISCV_IOMMU_PPN_FIELD |
| |
| /* 5.13 Page Request Queue head (32bits) */ |
| #define RISCV_IOMMU_REG_PQH 0x0040 |
| |
| /* 5.14 Page Request Queue tail (32bits) */ |
| #define RISCV_IOMMU_REG_PQT 0x0044 |
| |
| /* 5.15 Command Queue CSR (32bits) */ |
| #define RISCV_IOMMU_REG_CQCSR 0x0048 |
| #define RISCV_IOMMU_CQCSR_CQEN RISCV_IOMMU_QUEUE_ENABLE |
| #define RISCV_IOMMU_CQCSR_CIE RISCV_IOMMU_QUEUE_INTR_ENABLE |
| #define RISCV_IOMMU_CQCSR_CQMF RISCV_IOMMU_QUEUE_MEM_FAULT |
| #define RISCV_IOMMU_CQCSR_CMD_TO BIT(9) |
| #define RISCV_IOMMU_CQCSR_CMD_ILL BIT(10) |
| #define RISCV_IOMMU_CQCSR_FENCE_W_IP BIT(11) |
| #define RISCV_IOMMU_CQCSR_CQON RISCV_IOMMU_QUEUE_ACTIVE |
| #define RISCV_IOMMU_CQCSR_BUSY RISCV_IOMMU_QUEUE_BUSY |
| |
| /* 5.16 Fault Queue CSR (32bits) */ |
| #define RISCV_IOMMU_REG_FQCSR 0x004C |
| #define RISCV_IOMMU_FQCSR_FQEN RISCV_IOMMU_QUEUE_ENABLE |
| #define RISCV_IOMMU_FQCSR_FIE RISCV_IOMMU_QUEUE_INTR_ENABLE |
| #define RISCV_IOMMU_FQCSR_FQMF RISCV_IOMMU_QUEUE_MEM_FAULT |
| #define RISCV_IOMMU_FQCSR_FQOF RISCV_IOMMU_QUEUE_OVERFLOW |
| #define RISCV_IOMMU_FQCSR_FQON RISCV_IOMMU_QUEUE_ACTIVE |
| #define RISCV_IOMMU_FQCSR_BUSY RISCV_IOMMU_QUEUE_BUSY |
| |
| /* 5.17 Page Request Queue CSR (32bits) */ |
| #define RISCV_IOMMU_REG_PQCSR 0x0050 |
| #define RISCV_IOMMU_PQCSR_PQEN RISCV_IOMMU_QUEUE_ENABLE |
| #define RISCV_IOMMU_PQCSR_PIE RISCV_IOMMU_QUEUE_INTR_ENABLE |
| #define RISCV_IOMMU_PQCSR_PQMF RISCV_IOMMU_QUEUE_MEM_FAULT |
| #define RISCV_IOMMU_PQCSR_PQOF RISCV_IOMMU_QUEUE_OVERFLOW |
| #define RISCV_IOMMU_PQCSR_PQON RISCV_IOMMU_QUEUE_ACTIVE |
| #define RISCV_IOMMU_PQCSR_BUSY RISCV_IOMMU_QUEUE_BUSY |
| |
| /* 5.18 Interrupt Pending Status (32bits) */ |
| #define RISCV_IOMMU_REG_IPSR 0x0054 |
| #define RISCV_IOMMU_IPSR_CIP BIT(0) |
| #define RISCV_IOMMU_IPSR_FIP BIT(1) |
| #define RISCV_IOMMU_IPSR_PIP BIT(3) |
| |
| enum { |
| RISCV_IOMMU_INTR_CQ, |
| RISCV_IOMMU_INTR_FQ, |
| RISCV_IOMMU_INTR_PM, |
| RISCV_IOMMU_INTR_PQ, |
| RISCV_IOMMU_INTR_COUNT |
| }; |
| |
| /* 5.27 Interrupt cause to vector (64bits) */ |
| #define RISCV_IOMMU_REG_ICVEC 0x02F8 |
| #define RISCV_IOMMU_ICVEC_CIV GENMASK_ULL(3, 0) |
| #define RISCV_IOMMU_ICVEC_FIV GENMASK_ULL(7, 4) |
| #define RISCV_IOMMU_ICVEC_PMIV GENMASK_ULL(11, 8) |
| #define RISCV_IOMMU_ICVEC_PIV GENMASK_ULL(15, 12) |
| |
| /* 5.28 MSI Configuration table (32 * 64bits) */ |
| #define RISCV_IOMMU_REG_MSI_CONFIG 0x0300 |
| |
| #define RISCV_IOMMU_REG_SIZE 0x1000 |
| |
| #define RISCV_IOMMU_DDTE_VALID BIT_ULL(0) |
| #define RISCV_IOMMU_DDTE_PPN RISCV_IOMMU_PPN_FIELD |
| |
| /* Struct riscv_iommu_dc - Device Context - section 2.1 */ |
| struct riscv_iommu_dc { |
| uint64_t tc; |
| uint64_t iohgatp; |
| uint64_t ta; |
| uint64_t fsc; |
| uint64_t msiptp; |
| uint64_t msi_addr_mask; |
| uint64_t msi_addr_pattern; |
| uint64_t _reserved; |
| }; |
| |
| /* Translation control fields */ |
| #define RISCV_IOMMU_DC_TC_V BIT_ULL(0) |
| #define RISCV_IOMMU_DC_TC_EN_PRI BIT_ULL(2) |
| #define RISCV_IOMMU_DC_TC_T2GPA BIT_ULL(3) |
| #define RISCV_IOMMU_DC_TC_DTF BIT_ULL(4) |
| #define RISCV_IOMMU_DC_TC_PDTV BIT_ULL(5) |
| #define RISCV_IOMMU_DC_TC_PRPR BIT_ULL(6) |
| #define RISCV_IOMMU_DC_TC_GADE BIT_ULL(7) |
| #define RISCV_IOMMU_DC_TC_SADE BIT_ULL(8) |
| #define RISCV_IOMMU_DC_TC_DPE BIT_ULL(9) |
| #define RISCV_IOMMU_DC_TC_SBE BIT_ULL(10) |
| #define RISCV_IOMMU_DC_TC_SXL BIT_ULL(11) |
| |
| /* Second-stage (aka G-stage) context fields */ |
| #define RISCV_IOMMU_DC_IOHGATP_PPN RISCV_IOMMU_ATP_PPN_FIELD |
| #define RISCV_IOMMU_DC_IOHGATP_GSCID GENMASK_ULL(59, 44) |
| #define RISCV_IOMMU_DC_IOHGATP_MODE RISCV_IOMMU_ATP_MODE_FIELD |
| |
| enum riscv_iommu_dc_iohgatp_modes { |
| RISCV_IOMMU_DC_IOHGATP_MODE_BARE = 0, |
| RISCV_IOMMU_DC_IOHGATP_MODE_SV32X4 = 8, |
| RISCV_IOMMU_DC_IOHGATP_MODE_SV39X4 = 8, |
| RISCV_IOMMU_DC_IOHGATP_MODE_SV48X4 = 9, |
| RISCV_IOMMU_DC_IOHGATP_MODE_SV57X4 = 10 |
| }; |
| |
| /* Translation attributes fields */ |
| #define RISCV_IOMMU_DC_TA_PSCID GENMASK_ULL(31, 12) |
| |
| /* First-stage context fields */ |
| #define RISCV_IOMMU_DC_FSC_PPN RISCV_IOMMU_ATP_PPN_FIELD |
| #define RISCV_IOMMU_DC_FSC_MODE RISCV_IOMMU_ATP_MODE_FIELD |
| |
| /* Generic I/O MMU command structure - check section 3.1 */ |
| struct riscv_iommu_command { |
| uint64_t dword0; |
| uint64_t dword1; |
| }; |
| |
| #define RISCV_IOMMU_CMD_OPCODE GENMASK_ULL(6, 0) |
| #define RISCV_IOMMU_CMD_FUNC GENMASK_ULL(9, 7) |
| |
| #define RISCV_IOMMU_CMD_IOTINVAL_OPCODE 1 |
| #define RISCV_IOMMU_CMD_IOTINVAL_FUNC_VMA 0 |
| #define RISCV_IOMMU_CMD_IOTINVAL_FUNC_GVMA 1 |
| #define RISCV_IOMMU_CMD_IOTINVAL_AV BIT_ULL(10) |
| #define RISCV_IOMMU_CMD_IOTINVAL_PSCID GENMASK_ULL(31, 12) |
| #define RISCV_IOMMU_CMD_IOTINVAL_PSCV BIT_ULL(32) |
| #define RISCV_IOMMU_CMD_IOTINVAL_GV BIT_ULL(33) |
| #define RISCV_IOMMU_CMD_IOTINVAL_GSCID GENMASK_ULL(59, 44) |
| |
| #define RISCV_IOMMU_CMD_IOFENCE_OPCODE 2 |
| #define RISCV_IOMMU_CMD_IOFENCE_FUNC_C 0 |
| #define RISCV_IOMMU_CMD_IOFENCE_AV BIT_ULL(10) |
| #define RISCV_IOMMU_CMD_IOFENCE_DATA GENMASK_ULL(63, 32) |
| |
| #define RISCV_IOMMU_CMD_IODIR_OPCODE 3 |
| #define RISCV_IOMMU_CMD_IODIR_FUNC_INVAL_DDT 0 |
| #define RISCV_IOMMU_CMD_IODIR_FUNC_INVAL_PDT 1 |
| #define RISCV_IOMMU_CMD_IODIR_PID GENMASK_ULL(31, 12) |
| #define RISCV_IOMMU_CMD_IODIR_DV BIT_ULL(33) |
| #define RISCV_IOMMU_CMD_IODIR_DID GENMASK_ULL(63, 40) |
| |
| enum riscv_iommu_dc_fsc_atp_modes { |
| RISCV_IOMMU_DC_FSC_MODE_BARE = 0, |
| RISCV_IOMMU_DC_FSC_IOSATP_MODE_SV32 = 8, |
| RISCV_IOMMU_DC_FSC_IOSATP_MODE_SV39 = 8, |
| RISCV_IOMMU_DC_FSC_IOSATP_MODE_SV48 = 9, |
| RISCV_IOMMU_DC_FSC_IOSATP_MODE_SV57 = 10, |
| RISCV_IOMMU_DC_FSC_PDTP_MODE_PD8 = 1, |
| RISCV_IOMMU_DC_FSC_PDTP_MODE_PD17 = 2, |
| RISCV_IOMMU_DC_FSC_PDTP_MODE_PD20 = 3 |
| }; |
| |
| enum riscv_iommu_fq_causes { |
| RISCV_IOMMU_FQ_CAUSE_INST_FAULT = 1, |
| RISCV_IOMMU_FQ_CAUSE_RD_ADDR_MISALIGNED = 4, |
| RISCV_IOMMU_FQ_CAUSE_RD_FAULT = 5, |
| RISCV_IOMMU_FQ_CAUSE_WR_ADDR_MISALIGNED = 6, |
| RISCV_IOMMU_FQ_CAUSE_WR_FAULT = 7, |
| RISCV_IOMMU_FQ_CAUSE_INST_FAULT_S = 12, |
| RISCV_IOMMU_FQ_CAUSE_RD_FAULT_S = 13, |
| RISCV_IOMMU_FQ_CAUSE_WR_FAULT_S = 15, |
| RISCV_IOMMU_FQ_CAUSE_INST_FAULT_VS = 20, |
| RISCV_IOMMU_FQ_CAUSE_RD_FAULT_VS = 21, |
| RISCV_IOMMU_FQ_CAUSE_WR_FAULT_VS = 23, |
| RISCV_IOMMU_FQ_CAUSE_DMA_DISABLED = 256, |
| RISCV_IOMMU_FQ_CAUSE_DDT_LOAD_FAULT = 257, |
| RISCV_IOMMU_FQ_CAUSE_DDT_INVALID = 258, |
| RISCV_IOMMU_FQ_CAUSE_DDT_MISCONFIGURED = 259, |
| RISCV_IOMMU_FQ_CAUSE_TTYPE_BLOCKED = 260, |
| RISCV_IOMMU_FQ_CAUSE_MSI_LOAD_FAULT = 261, |
| RISCV_IOMMU_FQ_CAUSE_MSI_INVALID = 262, |
| RISCV_IOMMU_FQ_CAUSE_MSI_MISCONFIGURED = 263, |
| RISCV_IOMMU_FQ_CAUSE_MRIF_FAULT = 264, |
| RISCV_IOMMU_FQ_CAUSE_PDT_LOAD_FAULT = 265, |
| RISCV_IOMMU_FQ_CAUSE_PDT_INVALID = 266, |
| RISCV_IOMMU_FQ_CAUSE_PDT_MISCONFIGURED = 267, |
| RISCV_IOMMU_FQ_CAUSE_DDT_CORRUPTED = 268, |
| RISCV_IOMMU_FQ_CAUSE_PDT_CORRUPTED = 269, |
| RISCV_IOMMU_FQ_CAUSE_MSI_PT_CORRUPTED = 270, |
| RISCV_IOMMU_FQ_CAUSE_MRIF_CORRUIPTED = 271, |
| RISCV_IOMMU_FQ_CAUSE_INTERNAL_DP_ERROR = 272, |
| RISCV_IOMMU_FQ_CAUSE_MSI_WR_FAULT = 273, |
| RISCV_IOMMU_FQ_CAUSE_PT_CORRUPTED = 274 |
| }; |
| |
| /* MSI page table pointer */ |
| #define RISCV_IOMMU_DC_MSIPTP_PPN RISCV_IOMMU_ATP_PPN_FIELD |
| #define RISCV_IOMMU_DC_MSIPTP_MODE RISCV_IOMMU_ATP_MODE_FIELD |
| #define RISCV_IOMMU_DC_MSIPTP_MODE_OFF 0 |
| #define RISCV_IOMMU_DC_MSIPTP_MODE_FLAT 1 |
| |
| /* Translation attributes fields */ |
| #define RISCV_IOMMU_PC_TA_V BIT_ULL(0) |
| #define RISCV_IOMMU_PC_TA_RESERVED GENMASK_ULL(63, 32) |
| |
| /* First stage context fields */ |
| #define RISCV_IOMMU_PC_FSC_PPN GENMASK_ULL(43, 0) |
| #define RISCV_IOMMU_PC_FSC_RESERVED GENMASK_ULL(59, 44) |
| |
| enum riscv_iommu_fq_ttypes { |
| RISCV_IOMMU_FQ_TTYPE_NONE = 0, |
| RISCV_IOMMU_FQ_TTYPE_UADDR_INST_FETCH = 1, |
| RISCV_IOMMU_FQ_TTYPE_UADDR_RD = 2, |
| RISCV_IOMMU_FQ_TTYPE_UADDR_WR = 3, |
| RISCV_IOMMU_FQ_TTYPE_TADDR_INST_FETCH = 5, |
| RISCV_IOMMU_FQ_TTYPE_TADDR_RD = 6, |
| RISCV_IOMMU_FQ_TTYPE_TADDR_WR = 7, |
| RISCV_IOMMU_FW_TTYPE_PCIE_MSG_REQ = 8, |
| }; |
| |
| /* Fields on pte */ |
| #define RISCV_IOMMU_MSI_PTE_V BIT_ULL(0) |
| #define RISCV_IOMMU_MSI_PTE_M GENMASK_ULL(2, 1) |
| |
| #define RISCV_IOMMU_MSI_PTE_M_MRIF 1 |
| #define RISCV_IOMMU_MSI_PTE_M_BASIC 3 |
| |
| /* When M == 1 (MRIF mode) */ |
| #define RISCV_IOMMU_MSI_PTE_MRIF_ADDR GENMASK_ULL(53, 7) |
| /* When M == 3 (basic mode) */ |
| #define RISCV_IOMMU_MSI_PTE_PPN RISCV_IOMMU_PPN_FIELD |
| #define RISCV_IOMMU_MSI_PTE_C BIT_ULL(63) |
| |
| /* Fields on mrif_info */ |
| #define RISCV_IOMMU_MSI_MRIF_NID GENMASK_ULL(9, 0) |
| #define RISCV_IOMMU_MSI_MRIF_NPPN RISCV_IOMMU_PPN_FIELD |
| #define RISCV_IOMMU_MSI_MRIF_NID_MSB BIT_ULL(60) |
| |
| #endif /* _RISCV_IOMMU_BITS_H_ */ |
