From 05e3482106971d2ea88832b937ce86d28fdf9806 Mon Sep 17 00:00:00 2001 From: tkudav Date: Mon, 7 Dec 2020 15:29:36 +0530 Subject: [PATCH] gpu: nvgpu: Enhance doxygen for common.ptimer APIs Add details about the purpose served by the common.ptimer APIs. JIRA NVGPU-6235 Change-Id: I4e4716135649aa611646e63c1b4e9b37eacde60b Signed-off-by: Tejal Kudav Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2456005 (cherry picked from commit 7b8907a0e8445d7b97fd0fdd2ca763e039b5893c) Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2457621 Tested-by: mobile promotions Reviewed-by: Alex Waterman Reviewed-by: mobile promotions GVS: Gerrit_Virtual_Submit --- drivers/gpu/nvgpu/include/nvgpu/ptimer.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/drivers/gpu/nvgpu/include/nvgpu/ptimer.h b/drivers/gpu/nvgpu/include/nvgpu/ptimer.h index 6e7655df3..f1da779ca 100644 --- a/drivers/gpu/nvgpu/include/nvgpu/ptimer.h +++ b/drivers/gpu/nvgpu/include/nvgpu/ptimer.h @@ -44,7 +44,9 @@ struct nvgpu_cpu_time_correlation_sample { #define PTIMER_REF_FREQ_HZ 31250000U /** - * @brief Computes the ptimer scaling factor + * @brief Computes the ptimer scaling factor. This API allows setting the ptimer + * appropriately before using it to enforce different timeouts or + * scheduling timeslices. * * @param ptimer_src_freq [in] source frequency to ptimer * @@ -84,7 +86,9 @@ static inline u32 ptimer_scalingfactor10x(u32 ptimer_src_freq) } /** - * @brief Scales back the ptimer based timeout value as per the scale factor + * @brief Scales back the ptimer based timeout value as per the scale factor. + * Units like common.fifo use this API to scale the timeouts and + * scheduling timeslices enforced by it using the GPU ptimer. * * @param timeout [in] Time value captured using ptimer reference clock * @param scale10x [in] The scale factor multiplied by 10 to be used for