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 SNP_SET_CONFIG, 34 SNP_VLEK_LOAD, 35 36 SEV_MAX, 37 }; 38 39 /** 40 * SEV Firmware status code 41 */ 42 typedef enum { 43 /* 44 * This error code is not in the SEV spec. Its purpose is to convey that 45 * there was an error that prevented the SEV firmware from being called. 46 * The SEV API error codes are 16 bits, so the -1 value will not overlap 47 * with possible values from the specification. 48 */ 49 SEV_RET_NO_FW_CALL = -1, 50 SEV_RET_SUCCESS = 0, 51 SEV_RET_INVALID_PLATFORM_STATE, 52 SEV_RET_INVALID_GUEST_STATE, 53 SEV_RET_INAVLID_CONFIG, 54 SEV_RET_INVALID_LEN, 55 SEV_RET_ALREADY_OWNED, 56 SEV_RET_INVALID_CERTIFICATE, 57 SEV_RET_POLICY_FAILURE, 58 SEV_RET_INACTIVE, 59 SEV_RET_INVALID_ADDRESS, 60 SEV_RET_BAD_SIGNATURE, 61 SEV_RET_BAD_MEASUREMENT, 62 SEV_RET_ASID_OWNED, 63 SEV_RET_INVALID_ASID, 64 SEV_RET_WBINVD_REQUIRED, 65 SEV_RET_DFFLUSH_REQUIRED, 66 SEV_RET_INVALID_GUEST, 67 SEV_RET_INVALID_COMMAND, 68 SEV_RET_ACTIVE, 69 SEV_RET_HWSEV_RET_PLATFORM, 70 SEV_RET_HWSEV_RET_UNSAFE, 71 SEV_RET_UNSUPPORTED, 72 SEV_RET_INVALID_PARAM, 73 SEV_RET_RESOURCE_LIMIT, 74 SEV_RET_SECURE_DATA_INVALID, 75 SEV_RET_INVALID_KEY = 0x27, 76 SEV_RET_INVALID_PAGE_SIZE, 77 SEV_RET_INVALID_PAGE_STATE, 78 SEV_RET_INVALID_MDATA_ENTRY, 79 SEV_RET_INVALID_PAGE_OWNER, 80 SEV_RET_INVALID_PAGE_AEAD_OFLOW, 81 SEV_RET_RMP_INIT_REQUIRED, 82 SEV_RET_MAX, 83 } sev_ret_code; 84 85 /** 86 * struct sev_user_data_status - PLATFORM_STATUS command parameters 87 * 88 * @major: major API version 89 * @minor: minor API version 90 * @state: platform state 91 * @flags: platform config flags 92 * @build: firmware build id for API version 93 * @guest_count: number of active guests 94 */ 95 struct sev_user_data_status { 96 __u8 api_major; /* Out */ 97 __u8 api_minor; /* Out */ 98 __u8 state; /* Out */ 99 __u32 flags; /* Out */ 100 __u8 build; /* Out */ 101 __u32 guest_count; /* Out */ 102 } __packed; 103 104 #define SEV_STATUS_FLAGS_CONFIG_ES 0x0100 105 106 /** 107 * struct sev_user_data_pek_csr - PEK_CSR command parameters 108 * 109 * @address: PEK certificate chain 110 * @length: length of certificate 111 */ 112 struct sev_user_data_pek_csr { 113 __u64 address; /* In */ 114 __u32 length; /* In/Out */ 115 } __packed; 116 117 /** 118 * struct sev_user_data_cert_import - PEK_CERT_IMPORT command parameters 119 * 120 * @pek_address: PEK certificate chain 121 * @pek_len: length of PEK certificate 122 * @oca_address: OCA certificate chain 123 * @oca_len: length of OCA certificate 124 */ 125 struct sev_user_data_pek_cert_import { 126 __u64 pek_cert_address; /* In */ 127 __u32 pek_cert_len; /* In */ 128 __u64 oca_cert_address; /* In */ 129 __u32 oca_cert_len; /* In */ 130 } __packed; 131 132 /** 133 * struct sev_user_data_pdh_cert_export - PDH_CERT_EXPORT command parameters 134 * 135 * @pdh_address: PDH certificate address 136 * @pdh_len: length of PDH certificate 137 * @cert_chain_address: PDH certificate chain 138 * @cert_chain_len: length of PDH certificate chain 139 */ 140 struct sev_user_data_pdh_cert_export { 141 __u64 pdh_cert_address; /* In */ 142 __u32 pdh_cert_len; /* In/Out */ 143 __u64 cert_chain_address; /* In */ 144 __u32 cert_chain_len; /* In/Out */ 145 } __packed; 146 147 /** 148 * struct sev_user_data_get_id - GET_ID command parameters (deprecated) 149 * 150 * @socket1: Buffer to pass unique ID of first socket 151 * @socket2: Buffer to pass unique ID of second socket 152 */ 153 struct sev_user_data_get_id { 154 __u8 socket1[64]; /* Out */ 155 __u8 socket2[64]; /* Out */ 156 } __packed; 157 158 /** 159 * struct sev_user_data_get_id2 - GET_ID command parameters 160 * @address: Buffer to store unique ID 161 * @length: length of the unique ID 162 */ 163 struct sev_user_data_get_id2 { 164 __u64 address; /* In */ 165 __u32 length; /* In/Out */ 166 } __packed; 167 168 /** 169 * struct sev_user_data_snp_status - SNP status 170 * 171 * @api_major: API major version 172 * @api_minor: API minor version 173 * @state: current platform state 174 * @is_rmp_initialized: whether RMP is initialized or not 175 * @rsvd: reserved 176 * @build_id: firmware build id for the API version 177 * @mask_chip_id: whether chip id is present in attestation reports or not 178 * @mask_chip_key: whether attestation reports are signed or not 179 * @vlek_en: VLEK (Version Loaded Endorsement Key) hashstick is loaded 180 * @rsvd1: reserved 181 * @guest_count: the number of guest currently managed by the firmware 182 * @current_tcb_version: current TCB version 183 * @reported_tcb_version: reported TCB version 184 */ 185 struct sev_user_data_snp_status { 186 __u8 api_major; /* Out */ 187 __u8 api_minor; /* Out */ 188 __u8 state; /* Out */ 189 __u8 is_rmp_initialized:1; /* Out */ 190 __u8 rsvd:7; 191 __u32 build_id; /* Out */ 192 __u32 mask_chip_id:1; /* Out */ 193 __u32 mask_chip_key:1; /* Out */ 194 __u32 vlek_en:1; /* Out */ 195 __u32 rsvd1:29; 196 __u32 guest_count; /* Out */ 197 __u64 current_tcb_version; /* Out */ 198 __u64 reported_tcb_version; /* Out */ 199 } __packed; 200 201 /** 202 * struct sev_user_data_snp_config - system wide configuration value for SNP. 203 * 204 * @reported_tcb: the TCB version to report in the guest attestation report. 205 * @mask_chip_id: whether chip id is present in attestation reports or not 206 * @mask_chip_key: whether attestation reports are signed or not 207 * @rsvd: reserved 208 * @rsvd1: reserved 209 */ 210 struct sev_user_data_snp_config { 211 __u64 reported_tcb ; /* In */ 212 __u32 mask_chip_id:1; /* In */ 213 __u32 mask_chip_key:1; /* In */ 214 __u32 rsvd:30; /* In */ 215 __u8 rsvd1[52]; 216 } __packed; 217 218 /** 219 * struct sev_data_snp_vlek_load - SNP_VLEK_LOAD structure 220 * 221 * @len: length of the command buffer read by the PSP 222 * @vlek_wrapped_version: version of wrapped VLEK hashstick (Must be 0h) 223 * @rsvd: reserved 224 * @vlek_wrapped_address: address of a wrapped VLEK hashstick 225 * (struct sev_user_data_snp_wrapped_vlek_hashstick) 226 */ 227 struct sev_user_data_snp_vlek_load { 228 __u32 len; /* In */ 229 __u8 vlek_wrapped_version; /* In */ 230 __u8 rsvd[3]; /* In */ 231 __u64 vlek_wrapped_address; /* In */ 232 } __packed; 233 234 /** 235 * struct sev_user_data_snp_vlek_wrapped_vlek_hashstick - Wrapped VLEK data 236 * 237 * @data: Opaque data provided by AMD KDS (as described in SEV-SNP Firmware ABI 238 * 1.54, SNP_VLEK_LOAD) 239 */ 240 struct sev_user_data_snp_wrapped_vlek_hashstick { 241 __u8 data[432]; /* In */ 242 } __packed; 243 244 /** 245 * struct sev_issue_cmd - SEV ioctl parameters 246 * 247 * @cmd: SEV commands to execute 248 * @opaque: pointer to the command structure 249 * @error: SEV FW return code on failure 250 */ 251 struct sev_issue_cmd { 252 __u32 cmd; /* In */ 253 __u64 data; /* In */ 254 __u32 error; /* Out */ 255 } __packed; 256 257 #define SEV_IOC_TYPE 'S' 258 #define SEV_ISSUE_CMD _IOWR(SEV_IOC_TYPE, 0x0, struct sev_issue_cmd) 259 260 #endif /* __PSP_USER_SEV_H */ 261