From 7c82359afbe4bdd816fb0bc181452fdbf39a8595 Mon Sep 17 00:00:00 2001 From: Thomas Fleury Date: Mon, 11 Nov 2019 13:09:19 -0500 Subject: [PATCH] gpu: nvgpu: fix doxygen for fifo setup/cleanup sw Fixed formatting issues for: - nvgpu_fifo_setup_sw_common - nvgpu_fifo_cleanup_sw Jira NVGPU-4291 Change-Id: I4d828d231497b47621e057e11b3687fd40a9df6a Signed-off-by: Thomas Fleury Reviewed-on: https://git-master.nvidia.com/r/2236763 Reviewed-by: Philip Elcan Reviewed-by: Automatic_Commit_Validation_User Reviewed-by: Seema Khowala Reviewed-by: Deepak Nibade GVS: Gerrit_Virtual_Submit Reviewed-by: mobile promotions Tested-by: mobile promotions --- drivers/gpu/nvgpu/include/nvgpu/fifo.h | 32 ++++++++++++++------------ 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/drivers/gpu/nvgpu/include/nvgpu/fifo.h b/drivers/gpu/nvgpu/include/nvgpu/fifo.h index 27d9ba3a2..285d63b8e 100644 --- a/drivers/gpu/nvgpu/include/nvgpu/fifo.h +++ b/drivers/gpu/nvgpu/include/nvgpu/fifo.h @@ -440,14 +440,15 @@ int nvgpu_fifo_setup_sw(struct gk20a *g); * * @param g [in] The GPU driver struct. * - * Init mutexes needed by FIFO module. Refer #nvgpu_fifo struct. - * Do #nvgpu_channel_setup_sw. - * Do #nvgpu_tsg_setup_sw. - * Do pbdma.setup_sw. - * Do #nvgpu_engine_setup_sw. - * Do #nvgpu_runlist_setup_sw. - * Do userd.setup_sw. - * Init #nvgpu_fifo.remove_support function pointer. + * Initialize FIFO software context: + * - Init mutexes needed by FIFO module. Refer #nvgpu_fifo struct. + * - Do #nvgpu_channel_setup_sw. + * - Do #nvgpu_tsg_setup_sw. + * - Do pbdma.setup_sw. + * - Do #nvgpu_engine_setup_sw. + * - Do #nvgpu_runlist_setup_sw. + * - Do userd.setup_sw. + * - Init #nvgpu_fifo.remove_support function pointer. * * @return 0 in case of success, < 0 in case of failure. * @note In case of failure, cleanup_sw for the blocks that are already @@ -470,13 +471,14 @@ void nvgpu_fifo_cleanup_sw(struct gk20a *g); * * @param g [in] The GPU driver struct. * - * Do userd.cleanup_sw. - * Do #nvgpu_channel_cleanup_sw. - * Do #nvgpu_tsg_cleanup_sw. - * Do #nvgpu_runlist_cleanup_sw. - * Do #nvgpu_engine_cleanup_sw. - * Do pbdma.setup_sw. - * Destroy mutexes used by FIFO module. Refer #nvgpu_fifo struct. + * Clean up FIFO software context and related resources: + * - Do userd.cleanup_sw. + * - Do #nvgpu_channel_cleanup_sw. + * - Do #nvgpu_tsg_cleanup_sw. + * - Do #nvgpu_runlist_cleanup_sw. + * - Do #nvgpu_engine_cleanup_sw. + * - Do pbdma.setup_sw. + * - Destroy mutexes used by FIFO module. Refer #nvgpu_fifo struct. */ void nvgpu_fifo_cleanup_sw_common(struct gk20a *g);