gpu: nvgpu: therm: update doxygen for BVEC checks

Update doxygen to have boundary value check info for
init_elcg_mode HAL.

Jira NVGPU-6183

Change-Id: Id0ebb8076a8a65319e40129308ded6ef6466c647
Signed-off-by: Seshendra Gadagottu <sgadagottu@nvidia.com>
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2481046
(cherry picked from commit 89564f5d7f5371c35734c0eec5ad70edd71e3c17)
Reviewed-on: https://git-master.nvidia.com/r/c/linux-nvgpu/+/2483098
Reviewed-by: Automatic_Commit_Validation_User
Reviewed-by: Alex Waterman <alexw@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:
Seshendra Gadagottu
2021-02-04 14:33:37 -08:00
committed by mobile promotions
parent edf03baedd
commit f5b6c012cb

View File

@@ -75,7 +75,10 @@ struct gops_therm {
*
* @param g [in] The GPU driver struct.
* @param mode [in] ELCG mode.
* Valid ELCG modes are: ELCG_RUN, ELCG_STOP
* and ELCG_AUTO.
* @param engine [in] Engine index for control reg.
* Valid engine range: 0 to NV_HOST_NUM_ENGINES - 1
*
* This HAL controls engine level clock gating (ELCG) of an engine with
* following steps: