x86/sgx: Document structs and enums with '@', not '%'

Use '@' to document structure members and enum values in kernel-doc markup,
as per Documentation/doc-guide/kernel-doc.rst and flagged by make htmldocs.

  WARNING: arch/x86/include/uapi/asm/sgx.h:17 Enum value 'SGX_PAGE_MEASURE'
           not described in enum 'sgx_page_flags'

Opportunistically add a missing ':' for SGX_CHILD_PRESENT.

Closes: https://lore.kernel.org/all/20251106145506.145fc620@canb.auug.org.au
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Sean Christopherson <seanjc@google.com>
Signed-off-by: Dave Hansen <dave.hansen@linux.intel.com>
Reviewed-by: Kai Huang <kai.huang@intel.com>
Link: https://patch.msgid.link/20251112160708.1343355-4-seanjc%40google.com

diff --git a/arch/x86/include/asm/sgx.h b/arch/x86/include/asm/sgx.h
index c2c4c0d22ca46d939b22a4bd11426065d6159197..a88c4ab95edd0ad68dc1a36869720ab7bd76c83f 100644 (file)
--- a/arch/x86/include/asm/sgx.h
+++ b/arch/x86/include/asm/sgx.h
@@ -66,19 +66,19 @@ enum sgx_encls_function {
 
 /**
  * enum sgx_return_code - The return code type for ENCLS, ENCLU and ENCLV
- * %SGX_EPC_PAGE_CONFLICT:     Page is being written by other ENCLS function.
- * %SGX_NOT_TRACKED:           Previous ETRACK's shootdown sequence has not
+ * @SGX_EPC_PAGE_CONFLICT:     Page is being written by other ENCLS function.
+ * @SGX_NOT_TRACKED:           Previous ETRACK's shootdown sequence has not
  *                             been completed yet.
- * %SGX_CHILD_PRESENT          SECS has child pages present in the EPC.
- * %SGX_INVALID_EINITTOKEN:    EINITTOKEN is invalid and enclave signer's
+ * @SGX_CHILD_PRESENT:         SECS has child pages present in the EPC.
+ * @SGX_INVALID_EINITTOKEN:    EINITTOKEN is invalid and enclave signer's
  *                             public key does not match IA32_SGXLEPUBKEYHASH.
- * %SGX_PAGE_NOT_MODIFIABLE:   The EPC page cannot be modified because it
+ * @SGX_PAGE_NOT_MODIFIABLE:   The EPC page cannot be modified because it
  *                             is in the PENDING or MODIFIED state.
- * %SGX_INSUFFICIENT_ENTROPY:  Insufficient entropy in RNG.
- * %SGX_NO_UPDATE:             EUPDATESVN could not update the CPUSVN because the
+ * @SGX_INSUFFICIENT_ENTROPY:  Insufficient entropy in RNG.
+ * @SGX_NO_UPDATE:             EUPDATESVN could not update the CPUSVN because the
  *                             current SVN was not newer than CPUSVN. This is the most
  *                             common error code returned by EUPDATESVN.
- * %SGX_UNMASKED_EVENT:                An unmasked event, e.g. INTR, was received
+ * @SGX_UNMASKED_EVENT:                An unmasked event, e.g. INTR, was received
  */
 enum sgx_return_code {
        SGX_EPC_PAGE_CONFLICT           = 7,
@@ -96,7 +96,7 @@ enum sgx_return_code {
 
 /**
  * enum sgx_miscselect - additional information to an SSA frame
- * %SGX_MISC_EXINFO:   Report #PF or #GP to the SSA frame.
+ * @SGX_MISC_EXINFO:   Report #PF or #GP to the SSA frame.
  *
  * Save State Area (SSA) is a stack inside the enclave used to store processor
  * state when an exception or interrupt occurs. This enum defines additional
@@ -113,16 +113,16 @@ enum sgx_miscselect {
 
 /**
  * enum sgx_attributes - the attributes field in &struct sgx_secs
- * %SGX_ATTR_INIT:             Enclave can be entered (is initialized).
- * %SGX_ATTR_DEBUG:            Allow ENCLS(EDBGRD) and ENCLS(EDBGWR).
- * %SGX_ATTR_MODE64BIT:                Tell that this a 64-bit enclave.
- * %SGX_ATTR_PROVISIONKEY:      Allow to use provisioning keys for remote
+ * @SGX_ATTR_INIT:             Enclave can be entered (is initialized).
+ * @SGX_ATTR_DEBUG:            Allow ENCLS(EDBGRD) and ENCLS(EDBGWR).
+ * @SGX_ATTR_MODE64BIT:                Tell that this a 64-bit enclave.
+ * @SGX_ATTR_PROVISIONKEY:      Allow to use provisioning keys for remote
  *                             attestation.
- * %SGX_ATTR_KSS:              Allow to use key separation and sharing (KSS).
- * %SGX_ATTR_EINITTOKENKEY:    Allow to use token signing key that is used to
+ * @SGX_ATTR_KSS:              Allow to use key separation and sharing (KSS).
+ * @SGX_ATTR_EINITTOKENKEY:    Allow to use token signing key that is used to
  *                             sign cryptographic tokens that can be passed to
  *                             EINIT as an authorization to run an enclave.
- * %SGX_ATTR_ASYNC_EXIT_NOTIFY:        Allow enclaves to be notified after an
+ * @SGX_ATTR_ASYNC_EXIT_NOTIFY:        Allow enclaves to be notified after an
  *                             asynchronous exit has occurred.
  */
 enum sgx_attribute {
@@ -195,7 +195,7 @@ struct sgx_secs {
 
 /**
  * enum sgx_tcs_flags - execution flags for TCS
- * %SGX_TCS_DBGOPTIN:  If enabled allows single-stepping and breakpoints
+ * @SGX_TCS_DBGOPTIN:  If enabled allows single-stepping and breakpoints
  *                     inside an enclave. It is cleared by EADD but can
  *                     be set later with EDBGWR.
  */
@@ -260,11 +260,11 @@ struct sgx_pageinfo {
 
 /**
  * enum sgx_page_type - bits in the SECINFO flags defining the page type
- * %SGX_PAGE_TYPE_SECS:        a SECS page
- * %SGX_PAGE_TYPE_TCS: a TCS page
- * %SGX_PAGE_TYPE_REG: a regular page
- * %SGX_PAGE_TYPE_VA:  a VA page
- * %SGX_PAGE_TYPE_TRIM:        a page in trimmed state
+ * @SGX_PAGE_TYPE_SECS:        a SECS page
+ * @SGX_PAGE_TYPE_TCS: a TCS page
+ * @SGX_PAGE_TYPE_REG: a regular page
+ * @SGX_PAGE_TYPE_VA:  a VA page
+ * @SGX_PAGE_TYPE_TRIM:        a page in trimmed state
  *
  * Make sure when making changes to this enum that its values can still fit
  * in the bitfield within &struct sgx_encl_page
@@ -282,14 +282,14 @@ enum sgx_page_type {
 
 /**
  * enum sgx_secinfo_flags - the flags field in &struct sgx_secinfo
- * %SGX_SECINFO_R:     allow read
- * %SGX_SECINFO_W:     allow write
- * %SGX_SECINFO_X:     allow execution
- * %SGX_SECINFO_SECS:  a SECS page
- * %SGX_SECINFO_TCS:   a TCS page
- * %SGX_SECINFO_REG:   a regular page
- * %SGX_SECINFO_VA:    a VA page
- * %SGX_SECINFO_TRIM:  a page in trimmed state
+ * @SGX_SECINFO_R:     allow read
+ * @SGX_SECINFO_W:     allow write
+ * @SGX_SECINFO_X:     allow execution
+ * @SGX_SECINFO_SECS:  a SECS page
+ * @SGX_SECINFO_TCS:   a TCS page
+ * @SGX_SECINFO_REG:   a regular page
+ * @SGX_SECINFO_VA:    a VA page
+ * @SGX_SECINFO_TRIM:  a page in trimmed state
  */
 enum sgx_secinfo_flags {
        SGX_SECINFO_R                   = BIT(0),

diff --git a/arch/x86/include/uapi/asm/sgx.h b/arch/x86/include/uapi/asm/sgx.h
index 0d408f001ac6af565e5e805ac4325082d32e75cd..3c4d520721890431c5e552363a4ca53ec8f17897 100644 (file)
--- a/arch/x86/include/uapi/asm/sgx.h
+++ b/arch/x86/include/uapi/asm/sgx.h
@@ -10,7 +10,7 @@
 
 /**
  * enum sgx_page_flags - page control flags
- * %SGX_PAGE_MEASURE:  Measure the page contents with a sequence of
+ * @SGX_PAGE_MEASURE:  Measure the page contents with a sequence of
  *                     ENCLS[EEXTEND] operations.
  */
 enum sgx_page_flags {