From 6d760dd075d17e8013190cbeadeefc25fbf8856d Mon Sep 17 00:00:00 2001 From: Thomas Fleury Date: Wed, 19 Jun 2019 14:51:59 -0400 Subject: [PATCH] gpu: nvgpu: Update doxygen format for pbdma.h Added @brief, @return and @retval where applicable. Added [in/out] for function parameters. Jira NVGPU-3591 Change-Id: Ibc555c631817a8acd28bf5d4343acbb3d6d0d669 Signed-off-by: Thomas Fleury Reviewed-on: https://git-master.nvidia.com/r/2139607 Reviewed-by: Automatic_Commit_Validation_User GVS: Gerrit_Virtual_Submit Reviewed-by: Seema Khowala Reviewed-by: Alex Waterman Reviewed-by: mobile promotions Tested-by: mobile promotions --- drivers/gpu/nvgpu/include/nvgpu/pbdma.h | 31 ++++++++++++++++--------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/drivers/gpu/nvgpu/include/nvgpu/pbdma.h b/drivers/gpu/nvgpu/include/nvgpu/pbdma.h index 5d3c316bf..a47a72bbb 100644 --- a/drivers/gpu/nvgpu/include/nvgpu/pbdma.h +++ b/drivers/gpu/nvgpu/include/nvgpu/pbdma.h @@ -35,34 +35,43 @@ struct gk20a; /** - * nvgpu_pbdma_setup_sw - initialize PBDMA software context + * @brief Initialize PBDMA software context * - * @param g Current GPU + * @param g[in] The GPU driver struct for which to initialize + * PBDMA software context. * * Gets number of PBDMAs and builds a map of runlists that will be serviced - * by those PBDMAs. Returns non-zero value in case of failure. + * by those PBDMAs. + * + * @return 0 in case of success, < 0 in case of failure. + * @retval -ENOMEM in case there is not enough memory available. */ int nvgpu_pbdma_setup_sw(struct gk20a *g); /** - * nvgpu_pbdma_cleanup_sw - clean up PBDMA software context + * @brief Clean up PBDMA software context * - * @param g Current GPU + * @param g[in] The GPU driver struct using PBDMA software + * context. * * Cleans up PBDMA software context and related resources. */ void nvgpu_pbdma_cleanup_sw(struct gk20a *g); /** - * nvgpu_pbdma_find_for_runlist - find PBDMA servicing the runlist + * @brief Find PBDMA servicing the runlist * - * @param g Current GPU - * @param runlist_id Runlist identifier - * @param pbdma_id Pointer to PBDMA identifier + * @param g[in] The GPU driver struct owning the runlist. + * @param runlist_id[in] Runlist identifier. + * @param pbdma_id[out] Pointer to PBDMA identifier. * * Finds the PBDMA which is servicing #runlist_id. - * Sets #pbdma_id to valid value and returns true in case PBDMA could be found. - * Sets #pbdma_id to U32_MAX and returns false in case PBDMA could not be found. + * + * @return true if PBDMA was found, false otherwise. + * @retval Sets #pbdma_id to valid value and returns true in case PBDMA + * could be found. + * @retval Sets #pbdma_id to U32_MAX and returns false in case PBDMA could + * not be found. */ bool nvgpu_pbdma_find_for_runlist(struct gk20a *g, u32 runlist_id, u32 *pbdma_id);