nv-tegra-mirror/linux-nvgpu
1
0
Fork 0
mirror of git://nv-tegra.nvidia.com/linux-nvgpu.git synced 2025-12-24 10:34:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

gpu: nvgpu: Enhance doxygen for common.ptimer APIs

Browse Source 
Add details about the purpose served by the common.ptimer APIs.

JIRA NVGPU-6235

Change-Id: I4e4716135649aa611646e63c1b4e9b37eacde60b
Signed-off-by: Tejal Kudav <tkudav@nvidia.com>
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 <svcmobile_promotions@nvidia.com>
Reviewed-by: Alex Waterman <alexw@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
GVS: Gerrit_Virtual_Submit
This commit is contained in:
tkudav
2020-12-07 15:29:36 +05:30
committed by Alex Waterman
parent 2ee6a0f554
commit 05e3482106
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
drivers/gpu/nvgpu/include/nvgpu/ptimer.h
View File

@@ -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