From ffa5aadd2fc1df51966ae61448356f8def7eb597 Mon Sep 17 00:00:00 2001 From: "Chan, Roy" Date: Wed, 30 Apr 2025 19:19:39 -0400 Subject: [PATCH] amd/vpelib: fix doxgen warnings What does the change do after sanization if any. Delete this section if not applicable. Acked-by: ChuanYu Tseng Signed-off-by: Roy Chan Part-of: --- src/amd/vpelib/inc/vpe_types.h | 6 ++++++ src/amd/vpelib/inc/vpelib.h | 4 ++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/amd/vpelib/inc/vpe_types.h b/src/amd/vpelib/inc/vpe_types.h index 738cf361069..2285de405bc 100644 --- a/src/amd/vpelib/inc/vpe_types.h +++ b/src/amd/vpelib/inc/vpe_types.h @@ -841,12 +841,18 @@ struct vpe_stream { } flags; /**< Data flags */ }; +/** @enum predication_polarity + * @brief Predication polarity + */ enum predication_polarity { PREDICATION_OP_EQUAL_ZERO = 0, /**< Enables predication if all 64-bits are zero. */ PREDICATION_OP_NOT_EQUAL_ZERO = 1, /**< Enables predication if at least one of the 64-bits are not zero.*/ }; +/** @struct vpe_predication_info + * @brief Predication info + */ struct vpe_predication_info { bool enable; /**< Enable predication */ uint64_t gpu_va; /**< GPU start address of the buffer */ diff --git a/src/amd/vpelib/inc/vpelib.h b/src/amd/vpelib/inc/vpelib.h index bcbd1a83163..cdcd5065c86 100644 --- a/src/amd/vpelib/inc/vpelib.h +++ b/src/amd/vpelib/inc/vpelib.h @@ -141,7 +141,7 @@ void vpe_get_optimal_num_of_taps(struct vpe *vpe, struct vpe_scaling_info *scali * Build the command descriptor for timestamp operation * gets global gpu timestamp and writes it to the given gpu address * - * @param[in,out] bufs [in] memory allocated for the command buffer. + * @param[in,out] buf [in] memory allocated for the command buffer. * If size is 0, it reports the required size for this checked * operation. [out] the next write address and the filled sizes. * @param[in] dst_address address where the data is written to @@ -154,7 +154,7 @@ enum vpe_status vpe_build_timestamp(struct vpe_buf *buf, uint64_t dst_address); * Build the command descriptor for resolve operation * copies the data from the read address to the write address to the number of dwords specified. * - * @param[in,out] bufs [in] memory allocated for the command buffer. + * @param[in,out] buf [in] memory allocated for the command buffer. * If size is 0, it reports the required size for this checked * operation. [out] the next write address and the filled sizes. * @param[in] read_addr GPU virtual address where the data is read from