github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-11-07 06:17:02 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

crypto: ccp - Clean up kernel-doc warnings in psp-sev.h

Browse Source 
Clean up kernel-doc comments to prevent warnings in both
<linux/psp-sev.h> and <uapi/linux/psp-sev.h>.

include/linux/psp-sev.h: (62 lines; edited for brevity)
Warning: include/linux/psp-sev.h:52 This comment starts with '/**', but isn't a kernel-doc comment.
 * SEV platform state
Warning: include/linux/psp-sev.h:63 This comment starts with '/**', but isn't a kernel-doc comment.
 * SEV platform and guest management commands
Warning: include/linux/psp-sev.h:167 struct member 'reserved' not described in 'sev_data_init'
Warning: include/linux/psp-sev.h:187 struct member 'reserved' not described in 'sev_data_init_ex'
Warning: include/linux/psp-sev.h:216 expecting prototype for struct sev_data_cert_import. Prototype was for struct sev_data_pek_cert_import instead
Warning: include/linux/psp-sev.h:253 struct member 'pdh_cert_address' not described in 'sev_data_pdh_cert_export'
Warning: include/linux/psp-sev.h:253 struct member 'pdh_cert_len' not described in 'sev_data_pdh_cert_export'
Warning: include/linux/psp-sev.h:253 struct member 'reserved' not described in 'sev_data_pdh_cert_export'
Warning: include/linux/psp-sev.h:253 Excess struct member 'pdh_address' description in 'sev_data_pdh_cert_export' (did you mean one of: 'pdh_cert_address', 'cert_chain_address')
Warning: include/linux/psp-sev.h:253 Excess struct member 'pdh_len' description in 'sev_data_pdh_cert_export' (did you mean one of: 'pdh_cert_len')
Warning: include/linux/psp-sev.h:446 expecting prototype for struct sev_data_send_update. Prototype was for struct sev_data_send_update_data instead
Warning: include/linux/psp-sev.h:469 expecting prototype for struct sev_data_send_update. Prototype was for struct sev_data_send_update_vmsa instead
Warning: include/linux/psp-sev.h:506 struct member 'policy' not described in 'sev_data_receive_start'
Warning: include/linux/psp-sev.h:799 struct member 'rapl_dis' not described in 'sev_data_snp_init_ex'
Warning: include/linux/psp-sev.h:799 struct member 'ciphertext_hiding_en' not described in 'sev_data_snp_init_ex'
Warning: include/linux/psp-sev.h:799 struct member 'tio_en' not described in 'sev_data_snp_init_ex'
Warning: include/linux/psp-sev.h:799 struct member 'max_snp_asid' not described in 'sev_data_snp_init_ex'
Warning: include/linux/psp-sev.h:843 missing initial short description on line:
 * struct sev_platform_init_args
Warning: include/linux/psp-sev.h:893 expecting prototype for struct feature_info. Prototype was for struct snp_feature_info instead
Warning: include/linux/psp-sev.h:956 missing initial short description on line:
 * struct sev_snp_tcb_version_genoa_milan
Warning: include/linux/psp-sev.h:973 missing initial short description on line:
 * struct sev_snp_tcb_version_turin
Warning: include/linux/psp-sev.h:1053 function parameter 'filep' not described in 'sev_issue_cmd_external_user'
Warning: include/linux/psp-sev.h:1053 function parameter 'id' not described in 'sev_issue_cmd_external_user'
Warning: include/linux/psp-sev.h:1112 function parameter 'data' not described in 'sev_guest_decommission'
Warning: include/linux/psp-sev.h:1112 function parameter 'error' not described in 'sev_guest_decommission'
Warning: include/linux/psp-sev.h:1112 Excess function parameter 'decommission' description in 'sev_guest_decommission'
Warning: include/linux/psp-sev.h:1112 Excess function parameter 'sev_ret' description in 'sev_guest_decommission'

include/uapi/linux/psp-sev.h:
Warning: include/uapi/linux/psp-sev.h:18 This comment starts with '/**', but isn't a kernel-doc comment.
 * SEV platform commands
Warning: include/uapi/linux/psp-sev.h:39 This comment starts with '/**', but isn't a kernel-doc comment.
 * SEV Firmware status code
Warning: include/uapi/linux/psp-sev.h:125 struct member 'api_major' not described in 'sev_user_data_status'
Warning: include/uapi/linux/psp-sev.h:125 struct member 'api_minor' not described in 'sev_user_data_status'
Warning: include/uapi/linux/psp-sev.h:125 Excess struct member 'major' description in 'sev_user_data_status' (did you mean one of: 'api_major')
Warning: include/uapi/linux/psp-sev.h:125 Excess struct member 'minor' description in 'sev_user_data_status' (did you mean one of: 'api_minor')
Warning: include/uapi/linux/psp-sev.h:153 expecting prototype for struct sev_user_data_cert_import. Prototype was for struct sev_user_data_pek_cert_import instead
Warning: include/uapi/linux/psp-sev.h:168 struct member 'pdh_cert_address' not described in 'sev_user_data_pdh_cert_export'
Warning: include/uapi/linux/psp-sev.h:168 struct member 'pdh_cert_len' not described in 'sev_user_data_pdh_cert_export'
Warning: include/uapi/linux/psp-sev.h:168 Excess struct member 'pdh_address' description in 'sev_user_data_pdh_cert_export' (did you mean one of: 'pdh_cert_address', 'cert_chain_address')
Warning: include/uapi/linux/psp-sev.h:168 Excess struct member 'pdh_len' description in 'sev_user_data_pdh_cert_export' (did you mean one of: 'pdh_cert_len')
Warning: include/uapi/linux/psp-sev.h:263 expecting prototype for struct sev_data_snp_vlek_load. Prototype was for struct sev_user_data_snp_vlek_load instead
Warning: include/uapi/linux/psp-sev.h:273 expecting prototype for struct sev_user_data_snp_vlek_wrapped_vlek_hashstick. Prototype was for struct sev_user_data_snp_wrapped_vlek_hashstick instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Tom Lendacky <thomas.lendacky@amd.com>
Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
This commit is contained in:
Randy Dunlap 2026-09-18 16:27:36 -07:00 committed by Herbert Xu
parent a76c75cd6f
commit 360094ceb2
2 changed files with 73 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
include/linux/psp-sev.h
View File

@ -49,7 +49,7 @@
#define SEV_FW_BLOB_MAX_SIZE 0x4000 /* 16KB */
/**
/*
* SEV platform state
*/
enum sev_state {
@ -60,7 +60,7 @@ enum sev_state {
SEV_STATE_MAX
};
/**
/*
* SEV platform and guest management commands
*/
enum sev_cmd {
@ -157,6 +157,7 @@ enum sev_cmd {
* struct sev_data_init - INIT command parameters
*
* @flags: processing flags
* @reserved: reserved
* @tmr_address: system physical address used for SEV-ES
* @tmr_len: len of tmr_address
*/
@ -174,6 +175,7 @@ struct sev_data_init {
* @flags: processing flags
* @tmr_address: system physical address used for SEV-ES
* @tmr_len: len of tmr_address
* @reserved: reserved
* @nv_address: system physical address used for PSP NV storage
* @nv_len: len of nv_address
*/
@ -201,12 +203,13 @@ struct sev_data_pek_csr {
} __packed;
/**
* struct sev_data_cert_import - PEK_CERT_IMPORT command parameters
* struct sev_data_pek_cert_import - PEK_CERT_IMPORT command parameters
*
* @pek_address: PEK certificate chain
* @pek_len: len of PEK certificate
* @oca_address: OCA certificate chain
* @oca_len: len of OCA certificate
* @pek_cert_address: PEK certificate chain
* @pek_cert_len: len of PEK certificate
* @reserved: reserved
* @oca_cert_address: OCA certificate chain
* @oca_cert_len: len of OCA certificate
*/
struct sev_data_pek_cert_import {
u64 pek_cert_address; /* In */
@ -240,8 +243,9 @@ struct sev_data_get_id {
/**
* struct sev_data_pdh_cert_export - PDH_CERT_EXPORT command parameters
*
* @pdh_address: PDH certificate address
* @pdh_len: len of PDH certificate
* @pdh_cert_address: PDH certificate address
* @pdh_cert_len: len of PDH certificate
* @reserved: reserved
* @cert_chain_address: PDH certificate chain
* @cert_chain_len: len of PDH certificate chain
*/
@ -304,6 +308,7 @@ struct sev_data_guest_status {
* @policy: guest launch policy
* @dh_cert_address: physical address of DH certificate blob
* @dh_cert_len: len of DH certificate blob
* @reserved: reserved
* @session_address: physical address of session parameters
* @session_len: len of session parameters
*/
@ -321,6 +326,7 @@ struct sev_data_launch_start {
* struct sev_data_launch_update_data - LAUNCH_UPDATE_DATA command parameter
*
* @handle: handle of the VM to update
* @reserved: reserved
* @len: len of memory to be encrypted
* @address: physical address of memory region to encrypt
*/
@ -335,6 +341,7 @@ struct sev_data_launch_update_data {
* struct sev_data_launch_update_vmsa - LAUNCH_UPDATE_VMSA command
*
* @handle: handle of the VM
* @reserved: reserved
* @address: physical address of memory region to encrypt
* @len: len of memory region to encrypt
*/
@ -349,6 +356,7 @@ struct sev_data_launch_update_vmsa {
* struct sev_data_launch_measure - LAUNCH_MEASURE command parameters
*
* @handle: handle of the VM to process
* @reserved: reserved
* @address: physical address containing the measurement blob
* @len: len of measurement blob
*/
@ -363,10 +371,13 @@ struct sev_data_launch_measure {
* struct sev_data_launch_secret - LAUNCH_SECRET command parameters
*
* @handle: handle of the VM to process
* @reserved1: reserved
* @hdr_address: physical address containing the packet header
* @hdr_len: len of packet header
* @reserved2: reserved
* @guest_address: system physical address of guest memory region
* @guest_len: len of guest_paddr
* @reserved3: reserved
* @trans_address: physical address of transport memory buffer
* @trans_len: len of transport memory buffer
*/
@ -399,10 +410,13 @@ struct sev_data_launch_finish {
* @policy: policy information for the VM
* @pdh_cert_address: physical address containing PDH certificate
* @pdh_cert_len: len of PDH certificate
* @reserved1: reserved
* @plat_certs_address: physical address containing platform certificate
* @plat_certs_len: len of platform certificate
* @reserved2: reserved
* @amd_certs_address: physical address containing AMD certificate
* @amd_certs_len: len of AMD certificate
* @reserved3: reserved
* @session_address: physical address containing Session data
* @session_len: len of session data
*/
@ -423,13 +437,16 @@ struct sev_data_send_start {
} __packed;
/**
* struct sev_data_send_update - SEND_UPDATE_DATA command
* struct sev_data_send_update_data - SEND_UPDATE_DATA command
*
* @handle: handle of the VM to process
* @reserved1: reserved
* @hdr_address: physical address containing packet header
* @hdr_len: len of packet header
* @reserved2: reserved
* @guest_address: physical address of guest memory region to send
* @guest_len: len of guest memory region to send
* @reserved3: reserved
* @trans_address: physical address of host memory region
* @trans_len: len of host memory region
*/
@ -447,13 +464,15 @@ struct sev_data_send_update_data {
} __packed;
/**
* struct sev_data_send_update - SEND_UPDATE_VMSA command
* struct sev_data_send_update_vmsa - SEND_UPDATE_VMSA command
*
* @handle: handle of the VM to process
* @hdr_address: physical address containing packet header
* @hdr_len: len of packet header
* @reserved2: reserved
* @guest_address: physical address of guest memory region to send
* @guest_len: len of guest memory region to send
* @reserved3: reserved
* @trans_address: physical address of host memory region
* @trans_len: len of host memory region
*/
@ -491,8 +510,10 @@ struct sev_data_send_cancel {
* struct sev_data_receive_start - RECEIVE_START command parameters
*
* @handle: handle of the VM to perform receive operation
* @policy: policy information for the VM
* @pdh_cert_address: system physical address containing PDH certificate blob
* @pdh_cert_len: len of PDH certificate blob
* @reserved1: reserved
* @session_address: system physical address containing session blob
* @session_len: len of session blob
*/
@ -510,10 +531,13 @@ struct sev_data_receive_start {
* struct sev_data_receive_update_data - RECEIVE_UPDATE_DATA command parameters
*
* @handle: handle of the VM to update
* @reserved1: reserved
* @hdr_address: physical address containing packet header blob
* @hdr_len: len of packet header
* @reserved2: reserved
* @guest_address: system physical address of guest memory region
* @guest_len: len of guest memory region
* @reserved3: reserved
* @trans_address: system physical address of transport buffer
* @trans_len: len of transport buffer
*/
@ -534,10 +558,13 @@ struct sev_data_receive_update_data {
* struct sev_data_receive_update_vmsa - RECEIVE_UPDATE_VMSA command parameters
*
* @handle: handle of the VM to update
* @reserved1: reserved
* @hdr_address: physical address containing packet header blob
* @hdr_len: len of packet header
* @reserved2: reserved
* @guest_address: system physical address of guest memory region
* @guest_len: len of guest memory region
* @reserved3: reserved
* @trans_address: system physical address of transport buffer
* @trans_len: len of transport buffer
*/
@ -567,6 +594,7 @@ struct sev_data_receive_finish {
* struct sev_data_dbg - DBG_ENCRYPT/DBG_DECRYPT command parameters
*
* @handle: handle of the VM to perform debug operation
* @reserved: reserved
* @src_addr: source address of data to operate on
* @dst_addr: destination address of data to operate on
* @len: len of data to operate on
@ -583,6 +611,7 @@ struct sev_data_dbg {
* struct sev_data_attestation_report - SEV_ATTESTATION_REPORT command parameters
*
* @handle: handle of the VM
* @reserved: reserved
* @mnonce: a random nonce that will be included in the report.
* @address: physical address where the report will be copied.
* @len: length of the physical buffer.
@ -781,9 +810,14 @@ struct sev_data_snp_guest_request {
*
* @init_rmp: indicate that the RMP should be initialized.
* @list_paddr_en: indicate that list_paddr is valid
* @rapl_dis: whether RAPL is disabled
* @ciphertext_hiding_en: whether ciphertext hiding is enabled
* @tio_en: Indicates that SNP_INIT_EX initialized the RMP for SEV-TIO
* @rsvd: reserved
* @rsvd1: reserved
* @list_paddr: system physical address of range list
* @max_snp_asid: When non-zero, enable ciphertext hiding and specify the
* maximum ASID that can be used for an SEV-SNP guest.
* @rsvd2: reserved
*/
struct sev_data_snp_init_ex {
@ -841,7 +875,7 @@ struct sev_data_snp_shutdown_ex {
} __packed;
/**
* struct sev_platform_init_args
* struct sev_platform_init_args - parameters for sev_platform_init()
*
* @error: SEV firmware error code
* @probe: True if this is being called as part of CCP module probe, which
@ -879,12 +913,12 @@ struct sev_data_snp_feature_info {
} __packed;
/**
* struct feature_info - FEATURE_INFO structure
* struct snp_feature_info - FEATURE_INFO structure
*
* @eax: output of SNP_FEATURE_INFO command
* @ebx: output of SNP_FEATURE_INFO command
* @ecx: output of SNP_FEATURE_INFO command
* #edx: output of SNP_FEATURE_INFO command
* @edx: output of SNP_FEATURE_INFO command
*/
struct snp_feature_info {
u32 eax;
@ -954,7 +988,7 @@ struct sev_data_snp_verify_mitigation_dst {
} __packed;
/**
* struct sev_snp_tcb_version_genoa_milan
* struct sev_snp_tcb_version_genoa_milan - v1 SVN payload
*
* @boot_loader: SVN of PSP bootloader
* @tee: SVN of PSP operating system
@ -971,7 +1005,7 @@ struct sev_snp_tcb_version_genoa_milan {
};
/**
* struct sev_snp_tcb_version_turin
* struct sev_snp_tcb_version_turin - v2 SVN payload
*
* @fmc: SVN of FMC firmware
* @boot_loader: SVN of PSP bootloader
@ -1037,9 +1071,9 @@ int sev_platform_status(struct sev_user_data_status *status, int *error);
* behalf of userspace. The caller must pass a valid SEV file descriptor
* so that we know that it has access to SEV device.
*
* @filep - SEV device file pointer
* @cmd - command to issue
* @data - command buffer
* @filep: SEV device file pointer
* @id: command to issue
* @data: command buffer
* @error: SEV command return code
*
* Returns:
@ -1056,8 +1090,8 @@ int sev_issue_cmd_external_user(struct file *filep, unsigned int id,
/**
* sev_guest_deactivate - perform SEV DEACTIVATE command
*
* @deactivate: sev_data_deactivate structure to be processed
* @sev_ret: sev command return code
* @data: sev_data_deactivate structure to be processed
* @error: sev command return code
*
* Returns:
* 0 if the sev successfully processed the command
@ -1071,8 +1105,8 @@ int sev_guest_deactivate(struct sev_data_deactivate *data, int *error);
/**
* sev_guest_activate - perform SEV ACTIVATE command
*
* @activate: sev_data_activate structure to be processed
* @sev_ret: sev command return code
* @data: sev_data_activate structure to be processed
* @error: sev command return code
*
* Returns:
* 0 if the sev successfully processed the command
@ -1086,7 +1120,7 @@ int sev_guest_activate(struct sev_data_activate *data, int *error);
/**
* sev_guest_df_flush - perform SEV DF_FLUSH command
*
* @sev_ret: sev command return code
* @error: sev command return code
*
* Returns:
* 0 if the sev successfully processed the command
@ -1100,8 +1134,8 @@ int sev_guest_df_flush(int *error);
/**
* sev_guest_decommission - perform SEV DECOMMISSION command
*
* @decommission: sev_data_decommission structure to be processed
* @sev_ret: sev command return code
* @data: sev_data_decommission structure to be processed
* @error: sev command return code
*
* Returns:
* 0 if the sev successfully processed the command

26
include/uapi/linux/psp-sev.h
View File

@ -15,7 +15,7 @@
#include <linux/types.h>
/**
/*
* SEV platform commands
*/
enum {
@ -36,7 +36,7 @@ enum {
SEV_MAX,
};
/**
/*
* SEV Firmware status code
*/
typedef enum {
@ -109,8 +109,8 @@ typedef enum {
/**
* struct sev_user_data_status - PLATFORM_STATUS command parameters
*
* @major: major API version
* @minor: minor API version
* @api_major: major API version
* @api_minor: minor API version
* @state: platform state
* @flags: platform config flags
* @build: firmware build id for API version
@ -139,12 +139,12 @@ struct sev_user_data_pek_csr {
} __packed;
/**
* struct sev_user_data_cert_import - PEK_CERT_IMPORT command parameters
* struct sev_user_data_pek_cert_import - PEK_CERT_IMPORT command parameters
*
* @pek_address: PEK certificate chain
* @pek_len: length of PEK certificate
* @oca_address: OCA certificate chain
* @oca_len: length of OCA certificate
* @pek_cert_address: PEK certificate chain
* @pek_cert_len: length of PEK certificate
* @oca_cert_address: OCA certificate chain
* @oca_cert_len: length of OCA certificate
*/
struct sev_user_data_pek_cert_import {
__u64 pek_cert_address; /* In */
@ -156,8 +156,8 @@ struct sev_user_data_pek_cert_import {
/**
* struct sev_user_data_pdh_cert_export - PDH_CERT_EXPORT command parameters
*
* @pdh_address: PDH certificate address
* @pdh_len: length of PDH certificate
* @pdh_cert_address: PDH certificate address
* @pdh_cert_len: length of PDH certificate
* @cert_chain_address: PDH certificate chain
* @cert_chain_len: length of PDH certificate chain
*/
@ -248,7 +248,7 @@ struct sev_user_data_snp_config {
} __packed;
/**
* struct sev_data_snp_vlek_load - SNP_VLEK_LOAD structure
* struct sev_user_data_snp_vlek_load - SNP_VLEK_LOAD structure
*
* @len: length of the command buffer read by the PSP
* @vlek_wrapped_version: version of wrapped VLEK hashstick (Must be 0h)
@ -264,7 +264,7 @@ struct sev_user_data_snp_vlek_load {
} __packed;
/**
* struct sev_user_data_snp_vlek_wrapped_vlek_hashstick - Wrapped VLEK data
* struct sev_user_data_snp_wrapped_vlek_hashstick - Wrapped VLEK data
*
* @data: Opaque data provided by AMD KDS (as described in SEV-SNP Firmware ABI
* 1.54, SNP_VLEK_LOAD)