gpu: nvgpu: update doxygen for clock unit

Patch adds doxygen for get_maxrate

Jira NVGPU-6258

Change-Id: I7697134ca693bc14562c53b88e9aa2d44e871c9f
Signed-off-by: prsethi <prsethi@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2480512
(cherry picked from commit 610d52755f69cf74f74c1cb8e04985184f7f842c)
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2483391
Reviewed-by: Alex Waterman <alexw@nvidia.com>
Reviewed-by: Ankur Kishore <ankkishore@nvidia.com>
Reviewed-by: mobile promotions <svcmobile_promotions@nvidia.com>
Tested-by: mobile promotions <svcmobile_promotions@nvidia.com>
GVS: Gerrit_Virtual_Submit
This commit is contained in:
prsethi
2021-02-04 16:48:24 +00:00
committed by mobile promotions
parent 8d55f14fc9
commit ed739cdba1

View File

@@ -59,7 +59,18 @@ struct gops_clk {
int (*predict_mv_at_hz_cur_tfloor)(struct clk_gk20a *clk,
unsigned long rate);
/** @endcond */
/** Get max rate of gpu clock. */
/**
* @brief Get max rate of gpu clock.
*
* @param g [in] gpu device struct pointer
* @param api_domain [in] clock domains type
* - CTRL_CLK_DOMAIN_GPCCLK
*
* This routine helps to get max supported rate for given clock domain.
* Currently API only supports Graphics clock domain.
*
* @return 0 in case of failure and > 0 in case of success
*/
unsigned long (*get_maxrate)(struct gk20a *g, u32 api_domain);
/** @cond DOXYGEN_SHOULD_SKIP_THIS */
int (*prepare_enable)(struct clk_gk20a *clk);