1 /* SPDX-License-Identifier: GPL-2.0-only WITH Linux-syscall-note */ 2 /* 3 * Userspace interface for AMD Secure Encrypted Virtualization (SEV) 4 * platform management commands. 5 * 6 * Copyright (C) 2016-2017 Advanced Micro Devices, Inc. 7 * 8 * Author: Brijesh Singh <brijesh.singh@amd.com> 9 * 10 * SEV API specification is available at: https://developer.amd.com/sev/ 11 */ 12 13 #ifndef __PSP_SEV_USER_H__ 14 #define __PSP_SEV_USER_H__ 15 16 #include <linux/types.h> 17 18 /** 19 * SEV platform commands 20 */ 21 enum { 22 SEV_FACTORY_RESET = 0, 23 SEV_PLATFORM_STATUS, 24 SEV_PEK_GEN, 25 SEV_PEK_CSR, 26 SEV_PDH_GEN, 27 SEV_PDH_CERT_EXPORT, 28 SEV_PEK_CERT_IMPORT, 29 SEV_GET_ID, /* This command is deprecated, use SEV_GET_ID2 */ 30 SEV_GET_ID2, 31 SNP_PLATFORM_STATUS, 32 SNP_COMMIT, 33 34 SEV_MAX, 35 }; 36 37 /** 38 * SEV Firmware status code 39 */ 40 typedef enum { 41 /* 42 * This error code is not in the SEV spec. Its purpose is to convey that 43 * there was an error that prevented the SEV firmware from being called. 44 * The SEV API error codes are 16 bits, so the -1 value will not overlap 45 * with possible values from the specification. 46 */ 47 SEV_RET_NO_FW_CALL = -1, 48 SEV_RET_SUCCESS = 0, 49 SEV_RET_INVALID_PLATFORM_STATE, 50 SEV_RET_INVALID_GUEST_STATE, 51 SEV_RET_INAVLID_CONFIG, 52 SEV_RET_INVALID_LEN, 53 SEV_RET_ALREADY_OWNED, 54 SEV_RET_INVALID_CERTIFICATE, 55 SEV_RET_POLICY_FAILURE, 56 SEV_RET_INACTIVE, 57 SEV_RET_INVALID_ADDRESS, 58 SEV_RET_BAD_SIGNATURE, 59 SEV_RET_BAD_MEASUREMENT, 60 SEV_RET_ASID_OWNED, 61 SEV_RET_INVALID_ASID, 62 SEV_RET_WBINVD_REQUIRED, 63 SEV_RET_DFFLUSH_REQUIRED, 64 SEV_RET_INVALID_GUEST, 65 SEV_RET_INVALID_COMMAND, 66 SEV_RET_ACTIVE, 67 SEV_RET_HWSEV_RET_PLATFORM, 68 SEV_RET_HWSEV_RET_UNSAFE, 69 SEV_RET_UNSUPPORTED, 70 SEV_RET_INVALID_PARAM, 71 SEV_RET_RESOURCE_LIMIT, 72 SEV_RET_SECURE_DATA_INVALID, 73 SEV_RET_INVALID_KEY = 0x27, 74 SEV_RET_INVALID_PAGE_SIZE, 75 SEV_RET_INVALID_PAGE_STATE, 76 SEV_RET_INVALID_MDATA_ENTRY, 77 SEV_RET_INVALID_PAGE_OWNER, 78 SEV_RET_INVALID_PAGE_AEAD_OFLOW, 79 SEV_RET_RMP_INIT_REQUIRED, 80 SEV_RET_MAX, 81 } sev_ret_code; 82 83 /** 84 * struct sev_user_data_status - PLATFORM_STATUS command parameters 85 * 86 * @major: major API version 87 * @minor: minor API version 88 * @state: platform state 89 * @flags: platform config flags 90 * @build: firmware build id for API version 91 * @guest_count: number of active guests 92 */ 93 struct sev_user_data_status { 94 __u8 api_major; /* Out */ 95 __u8 api_minor; /* Out */ 96 __u8 state; /* Out */ 97 __u32 flags; /* Out */ 98 __u8 build; /* Out */ 99 __u32 guest_count; /* Out */ 100 } __packed; 101 102 #define SEV_STATUS_FLAGS_CONFIG_ES 0x0100 103 104 /** 105 * struct sev_user_data_pek_csr - PEK_CSR command parameters 106 * 107 * @address: PEK certificate chain 108 * @length: length of certificate 109 */ 110 struct sev_user_data_pek_csr { 111 __u64 address; /* In */ 112 __u32 length; /* In/Out */ 113 } __packed; 114 115 /** 116 * struct sev_user_data_cert_import - PEK_CERT_IMPORT command parameters 117 * 118 * @pek_address: PEK certificate chain 119 * @pek_len: length of PEK certificate 120 * @oca_address: OCA certificate chain 121 * @oca_len: length of OCA certificate 122 */ 123 struct sev_user_data_pek_cert_import { 124 __u64 pek_cert_address; /* In */ 125 __u32 pek_cert_len; /* In */ 126 __u64 oca_cert_address; /* In */ 127 __u32 oca_cert_len; /* In */ 128 } __packed; 129 130 /** 131 * struct sev_user_data_pdh_cert_export - PDH_CERT_EXPORT command parameters 132 * 133 * @pdh_address: PDH certificate address 134 * @pdh_len: length of PDH certificate 135 * @cert_chain_address: PDH certificate chain 136 * @cert_chain_len: length of PDH certificate chain 137 */ 138 struct sev_user_data_pdh_cert_export { 139 __u64 pdh_cert_address; /* In */ 140 __u32 pdh_cert_len; /* In/Out */ 141 __u64 cert_chain_address; /* In */ 142 __u32 cert_chain_len; /* In/Out */ 143 } __packed; 144 145 /** 146 * struct sev_user_data_get_id - GET_ID command parameters (deprecated) 147 * 148 * @socket1: Buffer to pass unique ID of first socket 149 * @socket2: Buffer to pass unique ID of second socket 150 */ 151 struct sev_user_data_get_id { 152 __u8 socket1[64]; /* Out */ 153 __u8 socket2[64]; /* Out */ 154 } __packed; 155 156 /** 157 * struct sev_user_data_get_id2 - GET_ID command parameters 158 * @address: Buffer to store unique ID 159 * @length: length of the unique ID 160 */ 161 struct sev_user_data_get_id2 { 162 __u64 address; /* In */ 163 __u32 length; /* In/Out */ 164 } __packed; 165 166 /** 167 * struct sev_user_data_snp_status - SNP status 168 * 169 * @api_major: API major version 170 * @api_minor: API minor version 171 * @state: current platform state 172 * @is_rmp_initialized: whether RMP is initialized or not 173 * @rsvd: reserved 174 * @build_id: firmware build id for the API version 175 * @mask_chip_id: whether chip id is present in attestation reports or not 176 * @mask_chip_key: whether attestation reports are signed or not 177 * @vlek_en: VLEK (Version Loaded Endorsement Key) hashstick is loaded 178 * @rsvd1: reserved 179 * @guest_count: the number of guest currently managed by the firmware 180 * @current_tcb_version: current TCB version 181 * @reported_tcb_version: reported TCB version 182 */ 183 struct sev_user_data_snp_status { 184 __u8 api_major; /* Out */ 185 __u8 api_minor; /* Out */ 186 __u8 state; /* Out */ 187 __u8 is_rmp_initialized:1; /* Out */ 188 __u8 rsvd:7; 189 __u32 build_id; /* Out */ 190 __u32 mask_chip_id:1; /* Out */ 191 __u32 mask_chip_key:1; /* Out */ 192 __u32 vlek_en:1; /* Out */ 193 __u32 rsvd1:29; 194 __u32 guest_count; /* Out */ 195 __u64 current_tcb_version; /* Out */ 196 __u64 reported_tcb_version; /* Out */ 197 } __packed; 198 199 /** 200 * struct sev_user_data_snp_config - system wide configuration value for SNP. 201 * 202 * @reported_tcb: the TCB version to report in the guest attestation report. 203 * @mask_chip_id: whether chip id is present in attestation reports or not 204 * @mask_chip_key: whether attestation reports are signed or not 205 * @rsvd: reserved 206 * @rsvd1: reserved 207 */ 208 struct sev_user_data_snp_config { 209 __u64 reported_tcb ; /* In */ 210 __u32 mask_chip_id:1; /* In */ 211 __u32 mask_chip_key:1; /* In */ 212 __u32 rsvd:30; /* In */ 213 __u8 rsvd1[52]; 214 } __packed; 215 216 /** 217 * struct sev_issue_cmd - SEV ioctl parameters 218 * 219 * @cmd: SEV commands to execute 220 * @opaque: pointer to the command structure 221 * @error: SEV FW return code on failure 222 */ 223 struct sev_issue_cmd { 224 __u32 cmd; /* In */ 225 __u64 data; /* In */ 226 __u32 error; /* Out */ 227 } __packed; 228 229 #define SEV_IOC_TYPE 'S' 230 #define SEV_ISSUE_CMD _IOWR(SEV_IOC_TYPE, 0x0, struct sev_issue_cmd) 231 232 #endif /* __PSP_USER_SEV_H */ 233